0% found this document useful (0 votes)
120 views79 pages

Fanuc Focas Ethernet Manual

Uploaded by

Hoangvinh Duong
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
120 views79 pages

Fanuc Focas Ethernet Manual

Uploaded by

Hoangvinh Duong
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 79

Fanuc Focas Ethernet Driver

© 2021 PTC Inc. All Rights Reserved.


Fanuc Focas Ethernet Driver 2

Table of Contents
Fanuc Focas Ethernet Driver 1

Table of Contents 2

Fanuc Focas Ethernet Driver 5

Overview 5

External Dependencies 5

Install a Focas Library 6

Additional Software Requirements 6

Setup 8
Channel Properties — General 9
Tag Counts 9
Channel Properties — Ethernet Communications 10
Channel Properties — Write Optimizations 10
Channel Properties — Advanced 11
Device Properties — General 12
Operating Mode 13
Tag Counts 13
Device Properties — Scan Mode 13
Device Properties — Timing 14
Device Properties — Auto-Demotion 15
Device Properties — Communications Parameters 16
Device Properties — Unsolicited Transfer Control 16
Device Properties — Unsolicited Data Areas 17
Device Properties — Redundancy 18
Unsolicited Messaging 19

Optimizing Communications 22

Data Types Description 23

Address Descriptions 24

Series 15i 24

Series 16i 26

Series 18i 29

Series 21i 31

Power Mate i 34

Open 36
System Info Tags 39
Status Info Tags 39

www. ptc.com
3 Fan u c Focas Eth ern et Driver

Tool Offset 43
Workpiece Zero Offset 45
Parameter Read Values 46
Alarm Values 46
Diagnostic Values 47
Path Values 47
Read Axis Data Values 48
Program Values 50
Program Name 50
Read Dynamic2 Data Values 51
Read Alarm Messages 52
Read Timer Data Values 52

Event Log M essages 53

Address Validation 53
Address <address> is out of range for the specified device or register. 53
Array size is out of range for address <address>. 53
Array support is not available for the specified address: <address>. 53
Data Type <type> is not valid for device address <address>. 54
Device address <address> contains a syntax error. 54
Device address <address> is read only. 54
Missing address. 54

Device Status Messages 55


Device <device name> is not responding. 55
Unable to write to <address> on device <device name>. 55

General Driver Messages 55


Could not acquire library handle for device <channel.device>. FWLIB error: <code>. 56
Could not read one or more vacant macros in range starting at <address> on device <device>. 56
Could not set request timeout for device <channel.device>. FWLIB error: <code>. 57
Invalid XML document. Reason: Error loading Unsolicited Data Areas for device <device-name>.
End address can not be less than start address for area <area-number>. 57
Invalid XML document. Reason: Error loading Unsolicited Data Areas for device <device-name>.
Invalid area order or duplicate area number. 57
Invalid XML document. Reason: Error loading Unsolicited Data Areas for device <device-name>.
Maximum size of area <area-number> is <size> bytes. 58
Read error occurred for address starting at <address> on device <channel.device>. FWLIB error:
<code>. 58
Unable to start the Fanuc Focas Data Window Library services. 58
Write error occurred for address <address> on device <channel.device>. FWLIB error: <code>. 59

Fanuc Focas Server Device Driver Messages 59

www. ptc.com
Fanuc Focas Ethernet Driver 4

Attempt to launch unsolicited message server failed. 60


Could not access necessary system resources for Fanuc Focas server device: <channel.device>. 61
Failed to connect Fanuc Focas server device <channel.device>. Could not acquire library handle.
FWLIB error: <code>. 61
Failed to connect Fanuc Focas server device <channel.device>. Could not determine host IP
address. 61
Failed to connect Fanuc Focas server device <channel.device>. Could not set data area size. 62
Failed to connect Fanuc Focas server device <channel.device>. Could not set data area start
address. 62
Failed to connect Fanuc Focas server device <channel.device>. Could not set data area type. 63
Failed to connect Fanuc Focas server device <channel.device>. Could not set host IP. 63
Failed to connect Fanuc Focas server device <channel.device>. Could not set host port. 63
Failed to connect Fanuc Focas server device <channel.device>. Could not set message alive time. 64
Failed to connect Fanuc Focas server device <channel.device>. Could not set message retries. 64
Failed to connect Fanuc Focas server device <channel.device>. Could not set message timeout. 65
Failed to connect Fanuc Focas server device <channel.device>. Could not set messaging prop-
erties. FWLIB data error <code>. 65
Failed to connect Fanuc Focas server device <channel.device>. Could not set messaging prop-
erties. FWLIB error: <code>. 66
Failed to connect Fanuc Focas server device <channel.device>. Could not set number of data
areas. 66
Failed to connect Fanuc Focas server device <channel.device>. Could not set request timeout.
FWLIB error: <code>. 67
Failed to connect Fanuc Focas server device <channel.device>. Could not set transmission control
PMC type. 67
Failed to connect Fanuc Focas server device <channel.device>. Could not set transmission control
start address. 67
Failed to connect Fanuc Focas server device <channel.device>. Could not start messaging session.
FWLIB error: <code>. 68
Installed version of Focas Data Window Library does not support unsolicited communication.
Device <device> deactivated. 68
Received CNC power down notification from unsolicited message server. Reconnecting Fanuc
Focas server devices. 69
Received CNC power up notification from unsolicited message server. 69
Received socket error notification from unsolicited message server. 69
Received unsolicited message server shutdown notification. 70
Unsolicited message server does not seem to be running. Attempting to launch. 70

Focas 1 Data Window Library Error Codes 71

API Calls 73

Index 74

www. ptc.com
5 Fan u c Focas Eth ern et Driver

Fanuc Focas Et hernet Driver


Help version 1.073

CONTENTS

Overview
What is the Fanuc Focas Ethernet Driver?

Set up
How do I configure a device for use with this driver?

Opt imizing Communicat ions


How do I get the best performance from the Fanuc Focas Ethernet Driver?

Dat a Types Descript ion


What data types does this driver support?

Address Descript ions


How do I address a data location on a Fanuc Focas device?

Error Descript ions


What error messages does the Fanuc Focas Ethernet Driver produce?

Overview
The Fanuc Focas Ethernet Driver provides a reliable way to connect Fanuc Focas Ethernet controllers to OPC
Client applications, including HMI, SCADA, Historian, MES, ERP, and countless custom applications. This
driver is intended for use with Fanuc Focas Computer Numerical Control (CNC) system.

For more information on the additional software that is required for use with this driver, refer to Additional
Software Requirements.

Ext ernal Dependencies


This driver has external dependencies. For this driver to communicate with the hardware, the Fanuc CNC
Focas 1 / Ethernet Library (part number A02B-0207-K732) or Fanuc Focas 2 Library (part number A02B-
0207-K737) must be installed on the system. For more information, refer to Additional Software Require-
m ents.

N ote: The Focas 2 Library combines both Ethernet and HSSB capabilities and can be obtained from the
FANUC distributor or by calling 1-888-326-8287. Choose CNC, PARTS, place the order, and request the part
number.

www. ptc.com
Fanuc Focas Ethernet Driver 6

Inst all a Focas Library


This driver requires a Focas library to communicate with the hardware, either FANUC CNC Focas 1 / Eth-
ernet Library (part number A02B-0207-K732) or FANUC Focas 2 Library (part number A02B-0207-K737).
Only 32-bit DLL files are compatible with Fanuc Focas Ethernet Driver. Follow these steps to install a library:

1. Obtain a library from the distributor (typically Fwlib* .zip).

2. Move or paste the Fwlib* .zip file to the appropriate Windows system folder:

On a 64-bit Windows OS, the destination folder is C:\Windows\SysWOW64

On a 32-bit Windows OS, the destination folder is C:\Windows\System32

3. Once the zip file is in the appropriate destination folder, unzip / extract the contents of the Fwlib* .zip.

4. Verify the 32-bit DLL files are located in the folder; in particular FWLIB32.DLL and FWLIBE1.DLL, which
are used by the Fanuc Focas Ethernet Driver.

5. Restart the computer.

See Also: External Dependencies

Addit ional Soft ware Requirem ent s


Winsock
The host computer must have Winsock version 1.1 or later installed. This is normally done by default when
Windows is installed.

Focas 1 / HSSB or Focas 2 Library


This driver requires that either the FANUC CNC Focas 1 / Ethernet Library (part number A02B-0207-K732) or
FANUC Focas 2 Library (part number A02B-0207-K737) is installed on the system. Although the library does
not need to be installed to create a server project, the project will not run without it. This software may be
obtained from the FANUC distributor or by calling 1-888-326-8287.

N ote: The Focas 2 Library combines both Ethernet and HSSB capabilities.

Unsolicited M essage Server


This driver requires that the unsolicited message server application "UMsgServ.exe" (version 1.0.0.1 or
later) is installed to use unsolicited messaging. This application is available from the distributor. For more
information, refer to the instructions below.

1. To start the installation, copy the executable file to the System folder.

2. Access the command prompt to type "UMsgServ.exe –Install." This causes the message server to
automatically launch every time the computer is started.

3. Once the message server is running, its icon is visible in the System Tray.

4. Next, configure the TCP port number on which the message server listens (in addition to the mes-
sage timeout and the maximum number of CNCs). To do so, right-click the icon and then select Set-
ting. The default settings are as follows:

www. ptc.com
7 Fan u c Focas Eth ern et Driver

l TCP Port N um ber: 8196

l Message Tim eout: 30 seconds

l Maxim um N um ber of CN Cs: 32

5. To uninstall the message server, use the command prompt to type "UMsgServ.exe –Remove" and
then delete the executable file.

CNC Control Softw are


The table below displays the software that must be installed on the controller to use its unsolicited mes-
saging capabilities.
Refer to Fanuc CNC documentation for other model compatibility.

M odel Soft ware


B0F4/K1(M) or later
16i
B0H1/P5(M) or later
DDF4/K1(M) or later
18i
BDH1/P5(M) or later
BDF4/K1(M) or later
21i
DDH1/P5(M) or later

N ote: Set the CNC parameter 904, bit 4 to 1 for unsolicited messaging by using the controller’s pro-
gramming software.

Fast Ethernet Firmw are


Firmware 6567/E2 or later (registered onto F-ROM of CNC) must be installed on the controller to use its unso-
licited messaging capabilities.

Ladder
A ladder program must be created that constructs and controls the transmission of unsolicited messages to
use the controllers unsolicited messaging capabilities. For more information, refer to Unsolicited Mes-
saging.

www. ptc.com
Fanuc Focas Ethernet Driver 8

Set up
Supported Devices
The Fanuc Focas Ethernet Driver can communicate to controllers that are compatible with the Focas 1 or
Focas 2 CNC / PMC data window control libraries. This includes, but is not limited to, the following:

Series 0i
Series 15
Series 15i
Series 16
Series 16i
Series 18
Series 18i
Series 21
Series 21i
Series 30i
Series 31i
Series 32i
Power Mate i
Open Addressing

Channel and Device Limits


The maximum number of channels supported by this driver is 256. The maximum number of devices sup-
ported by this driver is 20 per channel. Each device on the channel must be uniquely identified by its own IP
address.

Connect Timeout
Specify the amount of time that the driver waits for a connection to be made with a device. The connection
time depends on the network load and may vary with each connection attempt. The valid range is 1 to 60
seconds. The default setting is 3 seconds.

Request Timeout
Specify the amount of time that the driver waits on a response from the device before giving up and going
on to the next request. Longer timeouts only affect performance when a device is not responding. The valid
range is 100 to 9999 milliseconds. The default setting is 1000 milliseconds.

Retry Attempts
Specify the number of times that the driver retries a message before giving up and going on to the next mes-
sage. The valid range is 1 to 10. The default setting is 3.

www. ptc.com
9 Fan u c Focas Eth ern et Driver

Channel Propert ies — General


This server supports the use of multiple simultaneous communications drivers. Each protocol or driver used
in a server project is called a channel. A server project may consist of many channels with the same com-
munications driver or with unique communications drivers. A channel acts as the basic building block of an
OPC link. This group is used to specify general channel properties, such as the identification attributes and
operating mode.

Identification

N am e: Specify the user-defined identity of this channel. In each server project, each channel name must be
unique. Although names can be up to 256 characters, some client applications have a limited display window
when browsing the OPC server's tag space. The channel name is part of the OPC browser information. The
property is required for creating a channel.
For information on reserved characters, refer to "How To... Properly Name a Channel, Device, Tag, and Tag
Group" in the server help.

Description: Specify user-defined information about this channel.


Many of these properties, including Description, have an associated system tag.

Driver: Specify the protocol / driver for this channel. This property specifies the device driver that was selec-
ted during channel creation. It is a disabled setting in the channel properties. The property is required for cre-
ating a channel.
N ote: With the server's online full-time operation, these properties can be changed at any time. This
includes changing the channel name to prevent clients from registering data with the server. If a client has
already acquired an item from the server before the channel name is changed, the items are unaffected. If,
after the channel name has been changed, the client application releases the item and attempts to re-
acquire using the old channel name, the item is not accepted. Changes to the properties should not be made
once a large client application has been developed. Utilize proper user role and privilege management to
prevent operators from changing properties or accessing server features.

Diagnostics

Diagnostics Capture: When enabled, this option makes the channel's diagnostic information available to
OPC applications. Because the server's diagnostic features require a minimal amount of overhead pro-
cessing, it is recommended that they be utilized when needed and disabled when not. The default is dis-
abled.
N ote: This property is not available if the driver does not support diagnostics.
For more information, refer to "Communication Diagnostics" and "Statistics Tags" in the server help.

Tag Counts

www. ptc.com
Fanuc Focas Ethernet Driver 10

Static Tags: Provides the total number of defined static tags at this level (device or channel). This inform-
ation can be helpful in troubleshooting and load balancing.

Channel Propert ies — Et hernet Com m unicat ions


Ethernet Communication can be used to communicate with devices.

Ethernet Settings

N etwork Adapter: Specify the network adapter to bind. When left blank or Default is selected, the oper-
ating system selects the default adapter.

Channel Propert ies — Writ e Opt im izat ions


The server must ensure that the data written from the client application gets to the device on time. Given
this goal, the server provides optimization properties to meet specific needs or improve application respons-
iveness.

Write Optimizations

Optim ization Method: Controls how write data is passed to the underlying communications driver. The
options are:

l Write All Values for All Tags: This option forces the server to attempt to write every value to the
controller. In this mode, the server continues to gather write requests and add them to the server's
internal write queue. The server processes the write queue and attempts to empty it by writing data
to the device as quickly as possible. This mode ensures that everything written from the client applic-
ations is sent to the target device. This mode should be selected if the write operation order or the
write item's content must uniquely be seen at the target device.
l Write Only Latest Value for N on-Boolean Tags: Many consecutive writes to the same value can
accumulate in the write queue due to the time required to actually send the data to the device. If the
server updates a write value that has already been placed in the write queue, far fewer writes are
needed to reach the same final output value. In this way, no extra writes accumulate in the server's
queue. When the user stops moving the slide switch, the value in the device is at the correct value at
virtually the same time. As the mode states, any value that is not a Boolean value is updated in the
server's internal write queue and sent to the device at the next possible opportunity. This can greatly
improve the application performance.
N ote: This option does not attempt to optimize writes to Boolean values. It allows users to optimize

www. ptc.com
11 Fan u c Focas Eth ern et Driver

the operation of HMI data without causing problems with Boolean operations, such as a momentary
push button.
l Write Only Latest Value for All Tags: This option takes the theory behind the second optimization
mode and applies it to all tags. It is especially useful if the application only needs to send the latest
value to the device. This mode optimizes all writes by updating the tags currently in the write queue
before they are sent. This is the default mode.

Duty Cycle: is used to control the ratio of write to read operations. The ratio is always based on one read for
every one to ten writes. The duty cycle is set to ten by default, meaning that ten writes occur for each read
operation. Although the application is performing a large number of continuous writes, it must be ensured
that read data is still given time to process. A setting of one results in one read operation for every write
operation. If there are no write operations to perform, reads are processed continuously. This allows optim-
ization for applications with continuous writes versus a more balanced back and forth data flow.
N ote: It is recommended that the application be characterized for compatibility with the write optimization
enhancements before being used in a production environment.

Channel Propert ies — Advanced


This group is used to specify advanced channel properties. Not all drivers support all properties; so the
Advanced group does not appear for those devices.

N on-N orm alized Float Handling: A non-normalized value is defined as Infinity, Not-a-Number (NaN), or as
a Denormalized Number. The default is Replace with Zero. Drivers that have native float handling may
default to Unmodified. Non-normalized float handling allows users to specify how a driver handles non-nor-
malized IEEE-754 floating point data. Descriptions of the options are as follows:

l Replace with Zero: This option allows a driver to replace non-normalized IEEE-754 floating point val-
ues with zero before being transferred to clients.
l Unm odified: This option allows a driver to transfer IEEE-754 denormalized, normalized, non-num-
ber, and infinity values to clients without any conversion or changes.

N ote: This property is disabled if the driver does not support floating-point values or if it only supports the
option that is displayed. According to the channel's float normalization setting, only real-time driver tags
(such as values and arrays) are subject to float normalization. For example, EFM data is not affected by this
setting.

For more information on the floating-point values, refer to "How To ... Work with Non-Normalized Floating-
Point Values" in the server help.

Inter-Device Delay: Specify the amount of time the communications channel waits to send new requests to
the next device after data is received from the current device on the same channel. Zero (0) disables the
delay.

N ote: This property is not available for all drivers, models, and dependent settings.

www. ptc.com
Fanuc Focas Ethernet Driver 12

Device Propert ies — General


A device represents a single target on a communications channel. If the driver supports multiple controllers,
users must enter a device ID for each controller.

Identification

N am e: Specify the name of the device. It is a logical user-defined name that can be up to 256 characters
long and may be used on multiple channels.

N ote: Although descriptive names are generally a good idea, some OPC client applications may have a
limited display window when browsing the OPC server's tag space. The device name and channel name
become part of the browse tree information as well. Within an OPC client, the combination of channel name
and device name would appear as "ChannelName.DeviceName".
For more information, refer to "How To... Properly Name a Channel, Device, Tag, and Tag Group" in server
help.

Description: Specify the user-defined information about this device.


Many of these properties, including Description, have an associated system tag.

Channel Assignm ent: Specify the user-defined name of the channel to which this device currently belongs.

Driver: Selected protocol driver for this device.

Model: Specify the type of device that is associated with this ID. The contents of the drop-down menu
depend on the type of communications driver being used. Models that are not supported by a driver are dis-
abled. If the communications driver supports multiple device models, the model selection can only be
changed when there are no client applications connected to the device.
N ote: If the communication driver supports multiple models, users should try to match the model selec-
tion to the physical device. If the device is not represented in the drop-down menu, select a model that con-
forms closest to the target device. Some drivers support a model selection called "Open," which allows users
to communicate without knowing the specific details of the target device. For more information, refer to the
driver help documentation.

ID: Specify the device's driver-specific station or node. The type of ID entered depends on the com-
munications driver being used. For many communication drivers, the ID is a numeric value. Drivers that sup-
port a Numeric ID provide users with the option to enter a numeric value whose format can be changed to
suit the needs of the application or the characteristics of the selected communications driver. The format is
set by the driver by default. Options include Decimal, Octal, and Hexadecimal.
N ote: If the driver is Ethernet-based or supports an unconventional station or node name, the device's
TCP/IP address may be used as the device ID. TCP/IP addresses consist of four values that are separated by
periods, with each value in the range of 0 to 255. Some device IDs are string based. There may be additional

www. ptc.com
13 Fan u c Focas Eth ern et Driver

properties to configure within the ID field, depending on the driver. For more information, refer to the driver's
help documentation.

Operating M ode

Data Collection: This property controls the device's active state. Although device communications are
enabled by default, this property can be used to disable a physical device. Communications are not attemp-
ted when a device is disabled. From a client standpoint, the data is marked as invalid and write operations
are not accepted. This property can be changed at any time through this property or the device system tags.

Sim ulated: Place the device into or out of Simulation Mode. In this mode, the driver does not attempt to
communicate with the physical device, but the server continues to return valid OPC data. Simulated stops
physical communications with the device, but allows OPC data to be returned to the OPC client as valid data.
While in Simulation Mode, the server treats all device data as reflective: whatever is written to the simulated
device is read back and each OPC item is treated individually. The item's memory map is based on the group
Update Rate. The data is not saved if the server removes the item (such as when the server is reinitialized).
The default is No.
N otes:

1. This System tag (_Simulated) is read only and cannot be written to for runtime protection. The System
tag allows this property to be monitored from the client.

2. In Simulation mode, the item's memory map is based on client update rate(s) (Group Update Rate for
OPC clients or Scan Rate for native and DDE interfaces). This means that two clients that reference
the same item with different update rates return different data.

Simulation Mode is for test and simulation purposes only. It should never be used in a production envir-
onment.

Tag Counts

Static Tags: Provides the total number of defined static tags at this level (device or channel). This inform-
ation can be helpful in troubleshooting and load balancing.

Device Propert ies — Scan M ode


The Scan Mode specifies the subscribed-client requested scan rate for tags that require device com-
munications. Synchronous and asynchronous device reads and writes are processed as soon as possible;
unaffected by the Scan Mode properties.

www. ptc.com
Fanuc Focas Ethernet Driver 14

Scan Mode: Specify how tags in the device are scanned for updates sent to subscribing clients. Descriptions
of the options are:

l Respect Client-Specified Scan Rate: This mode uses the scan rate requested by the client.
l Request Data N o Faster than Scan Rate: This mode specifies the value set as the maximum scan
rate. The valid range is 10 to 99999990 milliseconds. The default is 1000 milliseconds.
N ote: When the server has an active client and items for the device and the scan rate value is
increased, the changes take effect immediately. When the scan rate value is decreased, the changes
do not take effect until all client applications have been disconnected.
l Request All Data at Scan Rate: This mode forces tags to be scanned at the specified rate for sub-
scribed clients. The valid range is 10 to 99999990 milliseconds. The default is 1000 milliseconds.
l Do N ot Scan, Dem and Poll Only: This mode does not periodically poll tags that belong to the
device nor perform a read to get an item's initial value once it becomes active. It is the OPC client's
responsibility to poll for updates, either by writing to the _DemandPoll tag or by issuing explicit device
reads for individual items. For more information, refer to "Device Demand Poll" in server help.
l Respect Tag-Specified Scan Rate: This mode forces static tags to be scanned at the rate specified
in their static configuration tag properties. Dynamic tags are scanned at the client-specified scan
rate.

Initial Updates from Cache: When enabled, this option allows the server to provide the first updates for
newly activated tag references from stored (cached) data. Cache updates can only be provided when the
new item reference shares the same address, scan rate, data type, client access, and scaling properties. A
device read is used for the initial update for the first client reference only. The default is disabled; any time a
client activates a tag reference the server attempts to read the initial value from the device.

Device Propert ies — Tim ing


The device Timing properties allow the driver's response to error conditions to be tailored to fit the applic-
ation's needs. In many cases, the environment requires changes to these properties for optimum per-
formance. Factors such as electrically generated noise, modem delays, and poor physical connections can
influence how many errors or timeouts a communications driver encounters. Timing properties are specific
to each configured device.

Communications Timeouts
Connect Tim eout: This property (which is used primarily by Ethernet based drivers) controls the amount of
time required to establish a socket connection to a remote device. The device's connection time often takes
longer than normal communications requests to that same device. The valid range is 1 to 30 seconds. The
default is typically 3 seconds, but can vary depending on the driver's specific nature. If this setting is not sup-
ported by the driver, it is disabled.

www. ptc.com
15 Fan u c Focas Eth ern et Driver

N ote: Due to the nature of UDP connections, the connection timeout setting is not applicable when com-
municating via UDP.

Request Tim eout: Specify an interval used by all drivers to determine how long the driver waits for a
response from the target device to complete. The valid range is 50 to 9,999,999 milliseconds (167.6667
minutes). The default is usually 1000 milliseconds, but can vary depending on the driver. The default timeout
for most serial drivers is based on a baud rate of 9600 baud or better. When using a driver at lower baud
rates, increase the timeout to compensate for the increased time required to acquire data.

Attem pts Before Tim eout: Specify how many times the driver issues a communications request before con-
sidering the request to have failed and the device to be in error. The valid range is 1 to 10. The default is typ-
ically 3, but can vary depending on the driver's specific nature. The number of attempts configured for an
application depends largely on the communications environment. This property applies to both connection
attempts and request attempts.

Timing
Inter-Request Delay: Specify how long the driver waits before sending the next request to the target
device. It overrides the normal polling frequency of tags associated with the device, as well as one-time
reads and writes. This delay can be useful when dealing with devices with slow turnaround times and in
cases where network load is a concern. Configuring a delay for a device affects communications with all
other devices on the channel. It is recommended that users separate any device that requires an inter-
request delay to a separate channel if possible. Other communications properties (such as communication
serialization) can extend this delay. The valid range is 0 to 300,000 milliseconds; however, some drivers may
limit the maximum value due to a function of their particular design. The default is 0, which indicates no
delay between requests with the target device.
N ote: Not all drivers support Inter-Request Delay. This setting does not appear if it is not available.

Device Propert ies — Aut o-Dem ot ion


The Auto-Demotion properties can temporarily place a device off-scan in the event that a device is not
responding. By placing a non-responsive device offline for a specific time period, the driver can continue to
optimize its communications with other devices on the same channel. After the time period has been
reached, the driver re-attempts to communicate with the non-responsive device. If the device is responsive,
the device is placed on-scan; otherwise, it restarts its off-scan time period.

Dem ote on Failure: When enabled, the device is automatically taken off-scan until it is responding again.
Tip: Determine when a device is off-scan by monitoring its demoted state using the _AutoDemoted sys-
tem tag.

www. ptc.com
Fanuc Focas Ethernet Driver 16

Tim eouts to Dem ote: Specify how many successive cycles of request timeouts and retries occur before the
device is placed off-scan. The valid range is 1 to 30 successive failures. The default is 3.

Dem otion Period: Indicate how long the device should be placed off-scan when the timeouts value is
reached. During this period, no read requests are sent to the device and all data associated with the read
requests are set to bad quality. When this period expires, the driver places the device on-scan and allows for
another attempt at communications. The valid range is 100 to 3600000 milliseconds. The default is 10000
milliseconds.

Discard Requests when Dem oted: Select whether or not write requests should be attempted during the
off-scan period. Disable to always send write requests regardless of the demotion period. Enable to discard
writes; the server automatically fails any write request received from a client and does not post a message
to the Event Log.

Device Propert ies — Com m unicat ions Param et ers

TCP/ IP Port: Specify the TCP/IP port number that the remote device is configured to use. The default setting
is 8193.

Maxim um Request Size: Specify the number of bytes that may be requested from a device at one time. To
refine the driver's performance, configure the request size to one of the following settings: 8, 16, 32, 64, 128,
256, or 512 bytes. The default setting is 256 bytes.

Device Propert ies — Unsolicit ed Transfer Cont rol

Fanuc Focas Server Device: This option should be enabled if the device receives unsolicited data from the
CNC. All tags belonging to a Fanuc Focus Server device read data cached in the driver, not directly from the
CNC. The Fanuc Focus Server device's tags displays a value of zero until it receives its first unsolicited data
update. When disabled, all tags belonging to the device read and write directly to the CNC. The default set-
ting is disabled.

www. ptc.com
17 Fan u c Focas Eth ern et Driver

Unsolicited Message Server Port: Specify the port that the unsolicited message server application has
been configured to use. The default setting is 8196.

Transfer Control Mem ory Type: Specify the registers' PMC memory type for unsolicited message transfer
control. Options include R (internal relay) and E (extended relay). The default setting is R.

Transfer Control Start Address: Specify the start address of the registers used for unsolicited message
transfer control. The valid range is 0 to 7999, although the actual range of valid addresses depends on the
hardware. The default setting is 0.

Message Retries: Specify the number of times that the CNC should retry sending unsolicited messages. The
valid range is 0 to 10. The default setting is 3.

Message Tim eout: Specify the unsolicited message timeout, which is the amount of time that the CNC waits
for the driver to respond to an unsolicited message. The valid range is 0 to 30. The default setting is 10
seconds.

Message Alive Tim e: Specify the unsolicited message alive time, which is the amount of time that the CNC
retains an unsolicited message for the driver to read. This setting must be less than the message timeout.
The valid range is 0 to 30. The default setting is 5 seconds.

See Also: Unsolicited Messaging

Device Propert ies — Unsolicit ed Dat a Areas


Users can configure up to three areas in PMC memory for unsolicited messaging. These areas' data content
is sent to the driver in each unsolicited message. As such, these areas should be made as small as possible.

Data Area n

N ote: All tags that are created for a Fanuc Focus server device are validated according to the configured
data areas. For example, if a Fanuc Focus Server device is configured with a single area with D1000 to
D1100, then a tag with address D1000 would be valid, but tags with addresses D1101 or C0001 would be
invalid. All tags belonging to a Fanuc Focus Server device are Read Only.

www. ptc.com
Fanuc Focas Ethernet Driver 18

l Data Area n: When enabled, this data area is in use.


l PMC Address Type: Specify the area's PMC address type. The default setting is D. Supported types
include the following:

l G: Signal to PMC->CNC
l F: Signal to CNC->PMC
l Y: Signal to PMC->machine
l X: Signal to machine->PMC
l A: Message demand
l R: Internal relay
l T: Changeable timer
l K: Keep relay
l C: Counter
l D: Data table
l Start Address: Specify an area's start address. The valid range is 0 and 7999, although the actual
range of valid addresses depends on the hardware. The default setting is 0.
l End Address: Specify an area's end address. The valid range is 0 and 7999, although the actual
range of valid addresses depends on the hardware. The total number of bytes must not exceed 1430,
1414, or 1398 for areas 1, 2, or 3 respectively. The default value is 0.

See Also: Unsolicited Messaging

Device Propert ies — Redundancy

Redundancy is available with the Media-Level Redundancy Plug-In.


Consult the website, a sales representative, or the user manual for more information.

www. ptc.com
19 Fan u c Focas Eth ern et Driver

Unsolicit ed M essaging
Before configuring a system for unsolicited messaging, it is important that users understand how the vari-
ous hardware and software components work together to transfer data. These components include one or
more CNC controllers equipped with Fast Ethernet communications boards, firmware that supports unso-
licited messaging, and a ladder program. To receive unsolicited data, a host computer must be equipped
with the OPC server, its Fanuc Focas Ethernet Driver, the Focas 1 Data Window Library software, and the
Unsolicited Message Server. Data can be read from the OPC server with OPC or DDE client applications run-
ning on the host or remote computer. For more information, refer to Additional Software Requirem ents.

During an unsolicited messaging session, the controller is only in direct communication with the Unsolicited
Message Server. The message server notifies the driver when the controller makes a request to send unso-
licited data. The Focas 1 Data Window Library allows the driver to receive the unsolicited data via the mes-
sage server, and also enables direct communications with the controllers for starting and ending unsolicited
messaging sessions.

N ote: If unsolicited messaging is not used, the driver uses the library to issue read and write requests dir-
ectly to the controller. It is possible to simultaneously use both types of communication with a controller by
creating a Fanuc Focus Server and a non-server device in the OPC server project.

Unsolicited Data Transmission


Ladder programs coordinate the transfer of unsolicited data from their respective controllers and must be
tailored to each application. For more information on unsolicited data transmission, refer to the instructions
below.

1. To start, the ladder program places the message contents in a designated area of the PMC memory.
Once the message is prepared, the ladder controls the data transmission by setting and monitoring
bits in the Unsolicited Transfer Control area of PMC memory.

2. To trigger the unsolicited message transmission, the ladder sets the "REQ" (request to send) transfer
control bit. The controller sends an "Unsolicited data ready" notification to the message server imme-
diately after.

3. The message server relays the notification to the driver, which then responds by issuing a "Read
unsolicited message" command to the message server.

4. The driver receives the unsolicited message data in response to this command, and then replies to
the data ready notification with a response code indicating success or failure. The message server
then passes this response code to the controller.

5. When the controller receives the response code, it copies it to the "RES_CODE" memory area. The
controller sets the "RES" (response ready) bit to indicate that the transaction completed immediately
after.

N ote: The ladder program must be designed to detect when the RES bit has been set. Once it
detects that the RES bit has been set, it can read the response code and react as needed. If the data
fails to reach the driver, the controller will place its own response code that describes the problem in
RES_CODE and set the RES bit.

6. Once the ladder has read the response code, it must clear the REQ bit to ready the system for the
next message.

PM C M emory

www. ptc.com
Fanuc Focas Ethernet Driver 20

The PMC memory area included in unsolicited messages is defined with the Fanuc Focas Ethernet Driver.
The driver transfers these area properties to the controller at the start of an unsolicited messaging session.
Data from the range of all areas is included each time an unsolicited message is sent. As such, these areas
should be made as small as possible. The ladder program must be written to use the exact address ranges
specified in the driver configuration.

Unsolicited data transmission is coordinated between the ladder program and communications board via 2
bytes of PMC R or E memory. This transfer control area is defined with the Fanuc Focas Ethernet Driver . The
transfer control area properties are then sent to the controller along with the data area properties when an
unsolicited messaging session starts. The ladder program must be written to use the specific addresses spe-
cified in the driver configuration. The various bits in the transfer control area, with starting address xxxx,
have the following locations and meanings:

REQ
Rxxxx.7 (or Exxxx.7)
After the ladder program constructs a message, it must set this bit to 1. This signals the communications
board to issue a notification that a new message is ready to be read.

COM
Rxxxx+1.6 (or Exxxx+1.6)
The communications board sets this bit to 1 when message transmission begins. The communications board
sets this bit back to 0 immediately before it sets RES to 1, and places the response code in RES_CODE.

RES
Rxxxx+1.7 (or Exxxx+1.7)
The communications board sets this bit to 1 immediately after message transmission completes. When the
ladder program detects that this bit is set to 1, it can read the response code from RES_CODE. The ladder
then acts depending on the value of RES_CODE. Once this is done, the ladder must set REQ back to 0. This
causes the communications board to clear RES_CODE and set the bit back to 0. Then the communications
board is ready to perform the next unsolicited transaction.

RES_CODE
Rxxxx+1.0 to Rxxxx+1.5 (or Exxxx+1.0 to Exxxx+1.5)
The result of the unsolicited transaction is placed here. It can be a code passed down from the driver, or a
code set by the communications board if there was a communications failure. The possible values are dis-
played in the table below.

RES_CODE M eaning
Success. The communications board did not detect any failures in communication, and
0x00
the driver reported that it processed the received data successfully.
The transmission control properties are invalid or the unsolicited messaging session
0x01
was not started.
0x02 The unsolicited message server is not running.

www. ptc.com
21 Fan u c Focas Eth ern et Driver

RES_CODE M eaning
0x03 The CNC failed to transmit message.
0x04 The CNC failed to receive response.
0x05 The transmission retry count was exceeded.
0x06 The CNC failed to construct the message data.
0x07 The CNC received an invalid packet.
0x08 The CNC accepted termination of unsolicited messaging session.
0x10 The driver experienced a Focas 1 Library error while reading message.
The driver found the message data to be invalid or experienced other problems while
0x11
processing message data.
The PC application to receive the message does not exist, though the message was
0x21
received by the PC. Either the OPC server or this driver is not running.
The PC application to receive the message was not recognized by the unsolicited mes-
sage server, though the message was received by the PC. The unsolicited message
0x22
server may need be restarted, or there may have been a problem when the driver was
starting the unsolicited messaging session.
0x23 The CNC failed in writing the received message to the PC.
0x24 The timeout period and retry count have expired.
0x25 Illegal data was included in the received message.

The Fanuc Focas Ethernet Driver stores unsolicited data in a memory cache. The OPC server makes this
data visible to client applications via tags, whose addresses must be the same as the controller's data
source. For example, if an unsolicited data area is configured to include the byte at D1000, then a tag with an
address of D1000 must be used to view the data. These tags show the last values sent to the driver, which
may not necessarily be the current values in the controller. To poll current values directly from the con-
troller, users would need additional tags belonging to a non-server device. Fanuc Focus Server device tags
display a value of zero until the driver receives its first unsolicited data update from the controller.

N otes:

1. In addition to data ready notifications, the Unsolicited Message Server also apprises the driver of
other important events. These include CNC power up, CNC power down, Unsolicited Message Server
shutdown, and communications error notifications. The driver responds to each of these events in
such a way that communication with the hardware is maintained, if possible.

2. The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session, or
restarts the session after detecting a communications problem. Tags that belong to a Fanuc Focus
Server device in an error state will continue to display the last value received from the device or the
initial value of zero.

www. ptc.com
Fanuc Focas Ethernet Driver 22

Opt im izing Com m unicat ions


The Fanuc Focas Ethernet Driver has been designed to provide the best performance with the least amount
of impact on the system's overall performance. While the driver is fast, there are a couple of guidelines that
can be used to control and optimize the application and gain maximum performance.

This server refers to communications protocols like Fanuc Focas Ethernet as a channel. Each channel
defined in the application represents a separate path of execution in the server. Once a channel has been
defined, a series of devices must then be defined under that channel. Each of these devices represents a
single Fanuc Focas controller from which data is collected. While this approach to defining the application
provides a high level of performance, it won't take full advantage of the Fanuc Focas Ethernet Driver or the
network. An example of how the application may appear when configured using a single channel is shown
below.

Each device appears under a single channel. In this configuration, the driver must
move from one device to the next as quickly as possible to gather information at an
effective rate. As more devices are added or more information is requested from a
single device, the overall update rate begins to suffer.

If the Fanuc Focas Ethernet Driver could only define one single channel, then the example shown above
would be the only option available; however, the driver can define up to 256 channels. Using multiple chan-
nels distributes the data collection workload by simultaneously issuing multiple requests to the network. An
example of how the same application may appear when configured using multiple channels to improve per-
formance is shown below.

Each device can be defined under its own channel. In this configuration, a single
path of execution is dedicated to the task of gathering data from each device. If the
application has fewer devices, it can be optimized exactly how it is shown here.
There is performance improvement even if the application has more devices.
While fewer devices may be ideal, the application still benefits from additional chan-
nels. Although spreading the device load across all channels causes the server to
move from device to device again, it can now do so with far less devices to process
on a single channel.

Request Size can also affect the Fanuc Focas Ethernet Driver performance. The request size refers to the
number of bytes that may be requested from a device at one time and is available on every defined device.
To refine the driver's performance, configure the request size to one of the following settings: 8, 16, 32, 64,
128, 256, or 512 bytes. Depending on the model of the device being used, the setting chosen for request size
can dramatically affect the application. The default value of 256 bytes is recommended. If the application
consists of large requests for consecutively ordered data, try increasing the request size setting for the
device. For more information, refer to Setup.

www. ptc.com
23 Fan u c Focas Eth ern et Driver

Dat a Types Descript ion

Dat a Type Descript ion


Boolean Single bit
Unsigned 8-bit value
Byte
bit 0 is the low bit
bit 7 is the high bit
Unsigned 16-bit value

Word
bit 0 is the low bit
bit 15 is the high bit
Signed 16-bit value

Short bit 0 is the low bit


bit 14 is the high bit
bit 15 is the sign bit
Unsigned 32-bit value

DWord
bit 0 is the low bit
bit 31 is the high bit
Signed 32-bit value

Long bit 0 is the low bit


bit 30 is the high bit
bit 31 is the sign bit
Float 32-bit floating point value
String Null terminated ASCII string

www. ptc.com
Fanuc Focas Ethernet Driver 24

Address Descript ions


Address specifications may vary depending on the model in use. Select a link from the following list to obtain
specific address information for the model of interest.

N ote: If the model of interest is listed as supported but is not selectable, use the Open model.

Series 15i
Series 16i
Series 18i
Series 21i
Power M at e i
Open

Series 15i
The following addresses are supported for this model. Not all address ranges may be valid for the particular
device being used. For more information, refer to the specific device's documentation. To jump to a specific
section, select a link from the list below.

CN C Dat a
Arrays
St rings

PM C Data
The default data types for dynamically defined DDE tags are shown in bold.

Address Type Range Dat a Type Access


A00000-A00124 Byte, Char
A00000-A00123 Word, Short
A (Message demand) Read/Write
A00000-A00121 DWord, Long, Float
Axxxxx.0-Axxxxx.7 Boolean
C00000-C00199 Byte, Char
C00000-C00198 Word, Short
C (Counter) Read/Write
C00000-C00196 DWord, Long, Float
Cxxxxx.0-Cxxxxx.7 Boolean
D00000-D09999 Byte, Char
D00000-D09998 Word, Short
D (Data table) Read/Write
D00000-D09996 DWord, Long, Float
Dxxxxx.0-Dxxxxx.7 Boolean
F00000-F00511 Byte, Char
F00000-F00510 Word, Short
F (Signal to CNC->PMC) Read Only
F00000-F00508 DWord, Long, Float
Fxxxxx.0-Fxxxxx.7 Boolean
G00000-G00511 Byte, Char
G00000-G00510 Word, Short
G (Signal to PMC->CNC) Read/Write
G00000-G00508 DWord, Long, Float
Gxxxxx.0-Gxxxxx.7 Boolean

www. ptc.com
25 Fan u c Focas Eth ern et Driver

Address Type Range Dat a Type Access


K00000-K00909 Byte, Char
K00000-K00908 Word, Short
K (Keep relay) Read/Write
K00000-K00906 DWord, Long, Float
Kxxxxx.0-Kxxxxx.7 Boolean
R00000-R09199 Byte, Char
R00000-R09198 Word, Short
R (Internal relay) Read/Write
R00000-R09196 DWord, Long, Float
Rxxxxx.0-Rxxxxx.7 Boolean
T00000-T00299 Byte, Char
T00000-T00298 Word, Short
T (Changeable timer) Read/Write
T00000-T00296 DWord, Long, Float
Txxxxx.0-Txxxxx.7 Boolean
X00000-X00127 Byte, Char
X00000-X00126 Word, Short
X (Signal to machine->PMC) Read Only
X00000-X00124 DWord, Long, Float
Xxxxxx.0-Xxxxxx.7 Boolean
Y00000-Y00127 Byte, Char
Y00000-Y00126 Word, Short
Y (Signal to PMC->machine) Read/Write
Y00000-Y00124 DWord, Long, Float
Yxxxxx.0-Yxxxxx.7 Boolean
Custom Macro Value (common range) # 0100-# 0999 Float, Double Read/Write
Custom Macro Value (local range) # 0001-# 0033 Float, Double Read Only
Custom Macro Value (system range) # 1000-# 9999 Float, Double Read/Write

CNC Data
St at us Info Tags
Tool Offset
Workpiece Zero Offset
Paramet er Read Values
Alarms Values
Diagnost ic Values
Pat h Value
Read Axis Dat a Values
Program Value
Program N ame
Read Dynamic2 Dat a Values
Read Timer Dat a Values
Read Alarm M essages

Arrays
Arrays are supported for all PMC addresses, except for Custom Macros in the system range and where
Boolean or string data types are used. Tool Offset data cannot be addressed as an array. The syntax for
declaring an array is as follows:

Mxxxx[cols] with assumed row count of 1.

www. ptc.com
Fanuc Focas Ethernet Driver 26

Mxxxxx[rows][cols] where M is the address type and xxxxx is the byte offset of the first element in the array.

N ote: For all arrays, the total number of bytes being requested cannot exceed the specified request size.

Strings
All address types can be read and written to as ASCII strings. Each byte of memory contains one ASCII char-
acter. The length of strings can range from 1 to 120 and is entered in place of the bit number. An additional
character "M" is appended to the address to distinguish string addresses from bit addresses.

Exam ple
To address a string of length 100 characters, starting at D00200, enter: D00200.100 M.

N ote: Use caution when modifying Word, Short, DWord, Long, and Float types. Since all addresses start at
a byte offset within the device, it is possible for the memory associated with tags to overlap. For example,
word tags D00000 and D00001 overlap at byte 1. Writing to D00000 also modifies the value held in D00001.
It is recommended that these memory types be used such that each value to be read and written to by the
driver occupy a unique range of memory in the device. For example, map 3 Word values to bytes D00000-
D00001, D00002-D00003, and D00004-D00005. Tags to access these values would then have addresses
D00000, D00002, and D00004 respectively, and a data type of Word.

Series 16i
The following addresses are supported for this model. Not all address ranges may be valid for the particular
device being used. For more information, refer to the specific device's documentation. To jump to a specific
section, select a link from the list below.

CN C Dat a
Arrays
St rings
Unsolicit ed Dat a

PM C Data
The default data types for dynamically defined DDE tags are shown in bold.

Address Type Range Dat a Type Access


A00000-A00124 Byte, Char
A00000-A00123 Word, Short
A (Message demand) Read/Write
A00000-A00121 DWord, Long, Float
Axxxxx.0-Axxxxx.7 Boolean
C00000-C00199 Byte, Char
C00000-C00198 Word, Short
C (Counter) Read/Write
C00000-C00196 DWord, Long, Float
Cxxxxx.0-Cxxxxx.7 Boolean
D00000-D09999 Byte, Char
D00000-D09998 Word, Short
D (Data table) Read/Write
D00000-D09996 DWord, Long, Float
Dxxxxx.0-Dxxxxx.7 Boolean
E00000-E07999 Byte, Char
E (Extended relay) Read/Write
E00000-E07998 Word, Short

www. ptc.com
27 Fan u c Focas Eth ern et Driver

Address Type Range Dat a Type Access


E00000-E07996 DWord, Long, Float
Exxxxx.0-Exxxxx.7 Boolean
F00000-F02511 Byte, Char
F00000-F02510 Word, Short
F (Signal to CNC->PMC) Read Only
F00000-F02508 DWord, Long, Float
Fxxxxx.0-Fxxxxx.7 Boolean
G00000-G02511 Byte, Char
G00000-G02510 Word, Short
G (Signal to PMC->CNC) Read/Write
G00000-G02508 DWord, Long, Float
Gxxxxx.0-Gxxxxx.7 Boolean
K00000-K00909 Byte, Char
K00000-K00908 Word, Short
K (Keep relay) Read/Write
K00000-K00906 DWord, Long, Float
Kxxxxx.0-Kxxxxx.7 Boolean
M00000-M00511 Byte, Char
M00000-M00510 Word, Short
M (Input signal from other devices) Read Only
M00000-M00508 DWord, Long, Float
Mxxxxx.0-Mxxxxx.7 Boolean
N00000-N00511 Byte, Char
N00000-N00510 Word, Short
N (Output signal from other devices) Read/Write
N00000-N00508 DWord, Long, Float
Nxxxxx.0-Nxxxxx.7 Boolean
R00000-R09119 Byte, Char
R00000-R09118 Word, Short
R (Internal relay) Read/Write
R00000-R09116 DWord, Long, Float
Rxxxxx.0-Rxxxxx.7 Boolean
T00000-T00299 Byte, Char
T00000-T00298 Word, Short
T (Changeable timer) Read/Write
T00000-T00296 DWord, Long, Float
Txxxxx.0-Txxxxx.7 Boolean
X00000-X00127 Byte, Char
X00000-X00126 Word, Short
X (Signal to machine->PMC) Read Only
X00000-X00124 DWord, Long, Float
Xxxxxx.0-Xxxxxx.7 Boolean
Y00000-Y00127 Byte, Char
Y00000-Y00126 Word, Short
Y (Signal to PMC->machine) Read/Write
Y00000-Y00124 DWord, Long, Float
Yxxxxx.0-Yxxxxx.7 Boolean
Custom Macro Value (common range) # 0100-# 0999 Float, Double Read/Write
Custom Macro Value (local range) # 0001-# 0033 Float, Double Read Only
Custom Macro Value (system range) # 1000-# 9999 Float, Double Read/Write

CNC Data
St at us Info Tags
Tool Offset
Workpiece Zero Offset

www. ptc.com
Fanuc Focas Ethernet Driver 28

Paramet er Read Values


Alarms Values
Diagnost ic Values
Pat h Value
Read Axis Dat a Values
Program Value
Program N ame
Read Dynamic2 Dat a Values
Read Timer Dat a Values
Read Alarm M essages

Arrays
Arrays are supported for all PMC addresses, except for Custom Macros in the system range and where
Boolean or string data types are used. Tool Offset data cannot be addressed as an array. The syntax for
declaring an array is as follows:

Mxxxxx[cols] with assumed row count of 1.


Mxxxxx[rows][cols] where M is the address type and xxxxx is the byte offset of the first element in the array.

N ote: For all arrays, the total number of bytes being requested cannot exceed the specified request size.

Strings
All address types can be read and written to as ASCII strings. Each byte of memory contains one ASCII char-
acter. The length of strings can range from 1 to 120 and is entered in place of the bit number. An additional
character "M" is appended to the address to distinguish string addresses from bit addresses.

Exam ple
To address a string of length 100 characters, starting at D00200, enter D00200.100 M.

Unsolicited Data
If tags belong to a Fanuc Focus Server device, then their address types and ranges are validated according
to the data areas configured for that device) For example, if the Fanuc Focus Server device is configured with
a single area with D01000 to D01100, then a tag with address D01000 would be valid, but tags with
addresses D01101 or C00001 would be invalid. All tags belonging to a Fanuc Focus Server device are Read
Only.

See Also: Unsolicited Data Areas

N ote: Use caution when modifying Word, Short, DWord, Long, and Float types. Since all addresses start at
a byte offset within the device, it is possible for the memory associated with tags to overlap. For example,
word tags D00000 and D00001 overlap at byte 1. Writing to D00000 also modifies the value held in D00001.
It is recommended that these memory types be used such that each value to be read and written to by the
driver occupy a unique range of memory in the device. For example, map 3 Word values to bytes D00000-
D00001, D00002-D00003, and D00004-D00005. Tags to access these values would then have addresses
D00000, D00002, and D00004 respectively, and a data type of Word.

www. ptc.com
29 Fan u c Focas Eth ern et Driver

Series 18i
The following addresses are supported for this model. Not all address ranges may be valid for the particular
device being used. For more information, refer to the specific device's documentation. To jump to a specific
section, select a link from the list below.

CN C Dat a
Arrays
St rings
Unsolicit ed Dat a

PM C Data
The default data types for dynamically defined DDE tags are shown in bold.

Address Type Range Dat a Type Access


A00000-A00124 Byte, Char
A00000-A00123 Word, Short
A (Message demand) Read/Write
A00000-A00121 DWord, Long, Float
Axxxxx.0-Axxxxx.7 Boolean
C00000-C00199 Byte, Char
C00000-C00198 Word, Short
C (Counter) Read/Write
C00000-C00196 DWord, Long, Float
Cxxxxx.0-Cxxxxx.7 Boolean
D00000-D09999 Byte, Char
D00000-D09998 Word, Short
D (Data table) Read/Write
D00000-D09996 DWord, Long, Float
Dxxxxx.0-Dxxxxx.7 Boolean
E00000-E07999 Byte, Char
E00000-E07998 Word, Short
E (Extended relay) Read/Write
E00000-E07996 DWord, Long, Float
Exxxxx.0-Exxxxx.7 Boolean
F00000-F02511 Byte, Char
F00000-F02510 Word, Short
F (Signal to CNC->PMC) Read Only
F00000-F02508 DWord, Long, Float
Fxxxxx.0-Fxxxxx.7 Boolean
G00000-G02511 Byte, Char
G00000-G02510 Word, Short
G (Signal to PMC->CNC) Read/Write
G00000-G02508 DWord, Long, Float
Gxxxxx.0-Gxxxxx.7 Boolean
K00000-K00909 Byte, Char
K00000-K00908 Word, Short
K (Keep relay) Read/Write
K00000-K00906 DWord, Long, Float
Kxxxxx.0-Kxxxxx.7 Boolean
M00000-M00511 Byte, Char
M00000-M00510 Word, Short
M (Input signal from other devices) Read Only
M00000-M00508 DWord, Long, Float
Mxxxxx.0-Mxxxxx.7 Boolean
N (Output signal from other devices) N00000-N00511 Byte, Char Read/Write

www. ptc.com
Fanuc Focas Ethernet Driver 30

Address Type Range Dat a Type Access


N00000-N00510 Word, Short
N00000-N00508 DWord, Long, Float
Nxxxxx.0-Nxxxxx.7 Boolean
R00000-R09119 Byte, Char
R00000-R09118 Word, Short
R (Internal relay) Read/Write
R00000-R09116 DWord, Long, Float
Rxxxxx.0-Rxxxxx.7 Boolean
T00000-T00299 Byte, Char
T00000-T00298 Word, Short
T (Changeable timer) Read/Write
T00000-T00296 DWord, Long, Float
Txxxxx.0-Txxxxx.7 Boolean
X00000-X00127 Byte, Char
X00000-X00126 Word, Short
X (Signal to machine->PMC) Read Only
X00000-X00124 DWord, Long, Float
Xxxxxx.0-Xxxxxx.7 Boolean
Y00000-Y00127 Byte, Char
Y00000-Y00126 Word, Short
Y (Signal to PMC->machine) Read/Write
Y00000-Y00124 DWord, Long, Float
Yxxxxx.0-Yxxxxx.7 Boolean
Custom Macro Value (common range) # 0100-# 0999 Float, Double Read/Write
Custom Macro Value (local range) # 0001-# 0033 Float, Double Read Only
Custom Macro Value (system range) # 1000-# 9999 Float, Double Read/Write

CNC Data
St at us Info Tags
Tool Offset
Workpiece Zero Offset
Paramet er Read Values
Alarms Values
Diagnost ic Values
Pat h Value
Read Axis Dat a Values
Program Value
Program N ame
Read Dynamic2 Dat a Values
Read Timer Dat a Values
Read Alarm M essages

Arrays
Arrays are supported for all PMC addresses, except for Custom Macros in the system range and where
Boolean or string data types are used. Tool Offset data cannot be addressed as an array. The syntax for
declaring an array is as follows:

Mxxxxx[cols] with assumed row count of 1.


Mxxxxx[rows][cols] where M is the address type and xxxxx is the byte offset of the first element in the array.

www. ptc.com
31 Fan u c Focas Eth ern et Driver

N ote: For all arrays, the total number of bytes being requested cannot exceed the specified request size.

Strings
All address types can be read and written to as ASCII strings. Each byte of memory contains one ASCII char-
acter. The length of strings can range from 1 to 120 and is entered in place of the bit number. An additional
character "M" is appended to the address to distinguish string addresses from bit addresses.

Exam ple
To address a string of length 100 characters, starting at D00200, enter D00200.100 M.

Unsolicited Data
If tags belong to a Fanuc Focas server device, then their address types and ranges are validated according
to the data areas configured for that device. For example, if the Fanuc Focas server device is configured with
a single area with D01000 to D01100, then a tag with address D01000 would be valid, but tags with
addresses D01101 or C00001 would be invalid. All tags belonging to a Fanuc Focas server device are Read
Only.

See Also: Unsolicited Data Areas

N ote: Use caution when modifying Word, Short, DWord, Long, and Float types. Since all addresses start at
a byte offset within the device, it is possible for the memory associated with tags to overlap. For example,
word tags D00000 and D00001 overlap at byte 1. Writing to D00000 also modifies the value held in D00001.
It is recommended that these memory types be used such that each value to be read and written to by the
driver occupy a unique range of memory in the device. For example, map 3 Word values to bytes D00000-
D00001, D00002-D00003, and D00004-D00005. Tags to access these values would then have addresses
D00000, D00002, and D00004 respectively, and a data type of Word.

Series 21i
The following addresses are supported for this model. Not all address ranges may be valid for the particular
device being used. For more information, refer to the specific device's documentation. To jump to a specific
section, select a link from the list below.

CN C Dat a
Arrays
St rings
Unsolicit ed Dat a

PM C Data
The default data types for dynamically defined DDE tags are shown in bold.

Address Type Range Dat a Type Access


A00000-A00124 Byte, Char
A00000-A00123 Word, Short
A (Message demand) Read/Write
A00000-A00121 DWord, Long, Float
Axxxxx.0-Axxxxx.7 Boolean
C00000-C00199 Byte, Char
C (Counter) C00000-C00198 Word, Short Read/Write
C00000-C00196 DWord, Long, Float

www. ptc.com
Fanuc Focas Ethernet Driver 32

Address Type Range Dat a Type Access


Cxxxxx.0-Cxxxxx.7 Boolean
D00000-D09999 Byte, Char
D00000-D09998 Word, Short
D (Data table) Read/Write
D00000-D09996 DWord, Long, Float
Dxxxxx.0-Dxxxxx.7 Boolean
E00000-E07999 Byte, Char
E00000-E07998 Word, Short
E (Extended relay) Read/Write
E00000-E07996 DWord, Long, Float
Exxxxx.0-Exxxxx.7 Boolean
F00000-F02511 Byte, Char
F00000-F02510 Word, Short
F (Signal to CNC->PMC) Read Only
F00000-F02508 DWord, Long, Float
Fxxxxx.0-Fxxxxx.7 Boolean
G00000-G02511 Byte, Char
G00000-G02510 Word, Short
G (Signal to PMC->CNC) Read/Write
G00000-G02508 DWord, Long, Float
Gxxxxx.0-Gxxxxx.7 Boolean
K00000-K00909 Byte, Char
K00000-K00908 Word, Short
K (Keep relay) Read/Write
K00000-K00906 DWord, Long, Float
Kxxxxx.0-Kxxxxx.7 Boolean
M00000-M00511 Byte, Char
M00000-M00510 Word, Short
M (Input signal from other devices) Read Only
M00000-M00508 DWord, Long, Float
Mxxxxx.0-Mxxxxx.7 Boolean
N00000-N00511 Byte, Char
N00000-N00510 Word, Short
N (Output signal from other devices) Read/Write
N00000-N00508 DWord, Long, Float
Nxxxxx.0-Nxxxxx.7 Boolean
R00000-R09119 Byte, Char
R00000-R09118 Word, Short
R (Internal relay) Read/Write
R00000-R09116 DWord, Long, Float
Rxxxxx.0-Rxxxxx.7 Boolean
T00000-T00299 Byte, Char
T00000-T00298 Word, Short
T (Changeable timer) Read/Write
T00000-T00296 DWord, Long, Float
Txxxxx.0-Txxxxx.7 Boolean
X00000-X00127 Byte, Char
X00000-X00126 Word, Short
X (Signal to machine->PMC) Read Only
X00000-X00124 DWord, Long, Float
Xxxxxx.0-Xxxxxx.7 Boolean
Y00000-Y00127 Byte, Char
Y00000-Y00126 Word, Short
Y (Signal to PMC->machine) Read/Write
Y00000-Y00124 DWord, Long, Float
Yxxxxx.0-Yxxxxx.7 Boolean
Custom Macro Value (common range) # 0100-# 0999 Float, Double Read/Write

www. ptc.com
33 Fan u c Focas Eth ern et Driver

Address Type Range Dat a Type Access


Custom Macro Value (local range) # 0001-# 0033 Float, Double Read Only
Custom Macro Value (system range) # 1000-# 9999 Float, Double Read/Write

CNC Data
St at us Info Tags
Tool Offset
Workpiece Zero Offset
Paramet er Read Values
Alarms Values
Diagnost ic Values
Pat h Value
Read Axis Dat a Values
Program Value
Program N ame
Read Dynamic2 Dat a Values
Read Timer Dat a Values
Read Alarm M essages

Arrays
Arrays are supported for all PMC addresses, except for Custom Macros in the system range and where
Boolean or string data types are used. Tool Offset data cannot be addressed as an array. The syntax for
declaring an array is as follows:

Mxxxxx[cols] with assumed row count of 1.


Mxxxxx[rows][cols] where M is the address type and xxxxx is the byte offset of the first element in the array.

N ote: For all arrays, the total number of bytes being requested cannot exceed the specified request size.

Strings
All address types can be read and written to as ASCII strings. Each byte of memory contains one ASCII char-
acter. The length of strings can range from 1 to 120 and is entered in place of the bit number. An additional
character "M" is appended to the address to distinguish string addresses from bit addresses.

Exam ple
To address a string of length 100 characters, starting at D00200, enter D00200.100 M.

Unsolicited Data
If tags belong to a Fanuc Focas server device, then their address types and ranges are validated according
to the data areas configured for that device. For example, if the Fanuc Focas server device is configured with
a single area with D01000 to D01100, then a tag with address D01000 would be valid, but tags with
addresses D01101 or C00001 would be invalid. All tags belonging to a Fanuc Focas server device are Read
Only.

See Also: Unsolicited Data Areas

www. ptc.com
Fanuc Focas Ethernet Driver 34

N ote: Use caution when modifying Word, Short, DWord, Long, and Float types. Since all addresses start at
a byte offset within the device, it is possible for the memory associated with tags to overlap. For example,
word tags D00000 and D00001 overlap at byte 1. Writing to D00000 also modifies the value held in D00001.
It is recommended that these memory types be used such that each value to be read and written to by the
driver occupy a unique range of memory in the device. For example, map 3 Word values to bytes D00000-
D00001, D00002-D00003, and D00004-D00005. Tags to access these values would then have addresses
D00000, D00002, and D00004 respectively, and a data type of Word.

Power M at e i
The following addresses are supported for this model. Not all address ranges may be valid for the particular
device being used. For more information, refer to the specific device's documentation. To jump to a specific sec-
tion, select a link from the list below.

CN C Dat a
Arrays
St rings

PM C Data
The default data types for dynamically defined DDE tags are shown in bold.

Address Type Range Dat a Type Access


A00000-A00124 Byte, Char
A00000-A00123 Word, Short
A (Message demand) Read/Write
A00000-A00121 DWord, Long, Float
Axxxxx.0-Axxxxx.7 Boolean
C00000-C00199 Byte, Char
C00000-C00198 Word, Short
C (Counter) Read/Write
C00000-C00196 DWord, Long, Float
Cxxxxx.0-Cxxxxx.7 Boolean
D00000-D09999 Byte, Char
D00000-D09998 Word, Short
D (Data table) Read/Write
D00000-D09996 DWord, Long, Float
Dxxxxx.0-Dxxxxx.7 Boolean
E00000-E07999 Byte, Char
E00000-E07998 Word, Short
E (Extended relay) Read/Write
E00000-E07996 DWord, Long, Float
Exxxxx.0-Exxxxx.7 Boolean
F00000-F02511 Byte, Char
F00000-F02510 Word, Short
F (Signal to CNC->PMC) Read Only
F00000-F02508 DWord, Long, Float
Fxxxxx.0-Fxxxxx.7 Boolean
G00000-G02511 Byte, Char
G00000-G02510 Word, Short
G (Signal to PMC->CNC) Read/Write
G00000-G02508 DWord, Long, Float
Gxxxxx.0-Gxxxxx.7 Boolean
K00000-K00909 Byte, Char
K (Keep relay) K00000-K00908 Word, Short Read/Write
K00000-K00906 DWord, Long, Float

www. ptc.com
35 Fan u c Focas Eth ern et Driver

Address Type Range Dat a Type Access


Kxxxxx.0-Kxxxxx.7 Boolean
M00000-M00511 Byte, Char
M00000-M00510 Word, Short
M (Input signal from other devices) Read Only
M00000-M00508 DWord, Long, Float
Mxxxxx.0-Mxxxxx.7 Boolean
N00000-N00511 Byte, Char
N00000-N00510 Word, Short
N (Output signal from other devices) Read/Write
N00000-N00508 DWord, Long, Float
Nxxxxx.0-Nxxxxx.7 Boolean
R00000-R09119 Byte, Char
R00000-R09118 Word, Short
R (Internal relay) Read/Write
R00000-R09116 DWord, Long, Float
Rxxxxx.0-Rxxxxx.7 Boolean
T00000-T00299 Byte, Char
T00000-T00298 Word, Short
T (Changeable timer) Read/Write
T00000-T00296 DWord, Long, Float
Txxxxx.0-Txxxxx.7 Boolean
X00000-X00127 Byte, Char
X00000-X00126 Word, Short
X (Signal to machine->PMC) Read Only
X00000-X00124 DWord, Long, Float
Xxxxxx.0-Xxxxxx.7 Boolean
Y00000-Y00127 Byte, Char
Y00000-Y00126 Word, Short
Y (Signal to PMC->machine) Read/Write
Y00000-Y00124 DWord, Long, Float
Yxxxxx.0-Yxxxxx.7 Boolean
Custom Macro Value (common range) # 0100-# 0999 Float, Double Read/Write
Custom Macro Value (local range) # 0001-# 0033 Float, Double Read Only
Custom Macro Value (system range) # 1000-# 9999 Float, Double Read/Write

CNC Data
St at us Info Tags
Tool Offset
Workpiece Zero Offset
Paramet er Read Values
Alarms Values
Diagnost ic Values
Pat h Value
Read Axis Dat a Values
Program Value
Program N ame
Read Dynamic2 Dat a Values
Read Timer Dat a Values
Read Alarm M essages

www. ptc.com
Fanuc Focas Ethernet Driver 36

Arrays
Arrays are supported for all PMC addresses, except for Custom Macros in the system range and where
Boolean or string data types are used. Tool Offset data cannot be addressed as an array. The syntax for
declaring an array is as follows:

Mxxxx[cols] with assumed row count of 1.


Mxxxxx[rows][cols] where M is the address type and xxxxx is the byte offset of the first element in the array.

N ote: For all arrays, the total number of bytes being requested cannot exceed the specified request size.

Strings
All address types can be read and written to as ASCII strings. Each byte of memory contains one ASCII char-
acter. The length of strings can range from 1 to 120 and is entered in place of the bit number. An additional
character "M" is appended to the address to distinguish string addresses from bit addresses.

Exam ple
To address a string of length 100 characters, starting at D00200, enter D00200.100 M.

N ote: Use caution when modifying Word, Short, DWord, Long, and Float types. Since all addresses start at
a byte offset within the device, it is possible for the memory associated with tags to overlap. For example,
word tags D00000 and D00001 overlap at byte 1. Writing to D00000 also modifies the value held in D00001.
It is recommended that these memory types be used such that each value to be read and written to by the
driver occupy a unique range of memory in the device. For example, map 3 Word values to bytes D00000-
D00001, D00002-D00003, and D00004-D00005. Tags to access these values would then have addresses
D00000, D00002, and D00004 respectively, and a data type of Word.

Open
The following addresses are supported for this model. Not all address ranges may be valid for the particular
device being used. For more information, refer to the specific device's documentation. To jump to a specific
section, select a link from the list below.

CN C Dat a
Arrays
St rings
Unsolicit ed Dat a

PM C Data
The default data types for dynamically defined DDE tags are shown in bold.

Address Type Range Dat a Type Access


A00000-A32767 Byte, Char
A00000-A32766 Word, Short
A (Message demand) Read/Write
00000-A32764 DWord, Long, Float
Axxxxx.0-Axxxxx.7 Boolean
C00000-C32767 Byte, Char
C00000-C32766 Word, Short
C (Counter) Read/Write
C00000-C32764 DWord, Long, Float
Cxxxxx.0-Cxxxxx.7 Boolean

www. ptc.com
37 Fan u c Focas Eth ern et Driver

Address Type Range Dat a Type Access


D00000-D32767 Byte, Char
D00000-D32766 Word, Short
D (Data table) Read/Write
D00000-D32764 DWord, Long, Float
Dxxxxx.0-Dxxxxx.7 Boolean
E00000-E32767 Byte, Char
E00000-E32766 Word, Short
E (Extended relay) Read/Write
E00000-E32764 DWord, Long, Float
Exxxxx.0-Exxxxx.7 Boolean
F00000-F32767 Byte, Char
F00000-F32766 Word, Short
F (Signal to CNC->PMC) Read Only
F00000-F32764 DWord, Long, Float
Fxxxxx.0-Fxxxxx.7 Boolean
G00000-G32767 Byte, Char
G00000-G32766 Word, Short
G (Signal to PMC->CNC) Read/Write
G00000-G32764 DWord, Long, Float
Gxxxxx.0-Gxxxxx.7 Boolean
K00000-K32767 Byte, Char
K00000-K32766 Word, Short
K (Keep relay) Read/Write
K00000-K32764 DWord, Long, Float
Kxxxxx.0-Kxxxxx.7 Boolean
M00000-M32767 Byte, Char
M00000-M32766 Word, Short
M (Input signal from other devices) Read Only
M00000-M32764 DWord, Long, Float
Mxxxxx.0-Mxxxxx.7 Boolean
N00000-N32767 Byte, Char
N00000-N32766 Word, Short
N (Output signal from other devices) Read/Write
N00000-N32764 DWord, Long, Float
Nxxxxx.0-Nxxxxx.7 Boolean
R00000-R32767 Byte, Char
R00000-R32766 Word, Short
R (Internal relay) Read/Write
R00000-R32764 DWord, Long, Float
Rxxxxx.0-Rxxxxx.7 Boolean
T00000-T32767 Byte, Char
T00000-T32766 Word, Short
T (Changeable timer) Read/Write
T00000-T32764 DWord, Long, Float
Txxxxx.0-Txxxxx.7 Boolean
X00000-X32767 Byte, Char
X00000-X32766 Word, Short
X (Signal to machine->PMC) Read Only
X00000-X32764 DWord, Long, Float
Xxxxxx.0-Xxxxxx.7 Boolean
Y00000-Y32767 Byte, Char
Y00000-Y32766 Word, Short
Y (Signal to PMC->machine) Read/Write
Y00000-Y32764 DWord, Long, Float
Yxxxxx.0-Yxxxxx.7 Boolean
Custom Macro Value (common range) # 0100-# 0999 Float, Double Read/Write
Custom Macro Value (local range) # 0001-# 0033 Float, Double Read Only

www. ptc.com
Fanuc Focas Ethernet Driver 38

Address Type Range Dat a Type Access


Custom Macro Value (system range) # 1000-# 9999 Float, Double Read/Write

CNC Data
St at us Info Tags
Tool Offset
Workpiece Zero Offset
Paramet er Read Values
Alarms Values
Diagnost ic Values
Pat h Value
Read Axis Dat a Values
Program Value
Program N ame
Read Dynamic2 Dat a Values
Read Timer Dat a Values
Read Alarm M essages

Arrays
Arrays are supported for all PMC addresses, except for Custom Macros in the system range and where
Boolean or string data types are used. Tool Offset data cannot be addressed as an array. The syntax for
declaring an array is as follows:

Mxxxxx[cols] with assumed row count of 1.


Mxxxxx[rows][cols] where M is the address type and xxxxx is the byte offset of the first element in the array.

N ote: For all arrays, the total number of bytes being requested cannot exceed the specified request size.

Strings
All address types can be read and written to as ASCII strings. Each byte of memory contains one ASCII char-
acter. The length of strings can range from 1 to 120 and is entered in place of the bit number. An additional
character "M" is appended to the address to distinguish string addresses from bit addresses.

Exam ple
To address a string of length 100 characters starting at D00200, enter D00200.100 M.

Unsolicited Data
If tags belong to a Fanuc Focas server device, then their address types and ranges are validated according
to the data areas configured for that device. For example, if the Fanuc Focas server device is configured with
a single area with D01000 to D01100, then a tag with address D01000 would be valid, but tags with
addresses D01101 or C00001 would be invalid. All tags belonging to a Fanuc Focas server device are Read
Only.

See Also: Unsolicited Data Areas

N ote: Use caution when modifying Word, Short, DWord, Long, and Float types. Since all addresses start at
a byte offset within the device, it is possible for the memory associated with tags to overlap. For example,

www. ptc.com
39 Fan u c Focas Eth ern et Driver

word tags D00000 and D00001 overlap at byte 1. Writing to D00000 also modifies the value held in D00001.
It is recommended that these memory types be used such that each value to be read and written to by the
driver occupy a unique range of memory in the device. For example, map 3 Word values to bytes D00000-
D00001, D00002-D00003, and D00004-D00005. Tags to access these values would then have addresses
D00000, D00002, and D00004 respectively, and a data type of Word.

Syst em Info Tags


The values in a CNC machine's system information are read using the cnc_sysinfo Focas API call.

Tag N ame Dat a Type Access Descript ion


cnc_sysinfo_AddInfo Short Read Only Bit-packet-integer for additional System Information
cnc_sysinfo_MaxAxis Short Read Only Maximum Number of Controlled Axes
cnc_sysinfo_CncType String Read Only Kind of CNC
cnc_sysinfo_MTType String Read Only Kind of MT/T/TT
cnc_sysinfo_Series String Read Only Series Number
cnc_sysinfo_Version String Read Only Version Number
cnc_sysinfo_NumAxis String Read Only Current Number of Controlled Axes

St at us Info Tags
The values in a CNC machine's status information are read using the cnc_statinfo Focas API call.

Series 15i
Tag N ame Dat a Type Access Descript ion
statinfo_alarm Short Read Only Status of alarm
statinfo_aut Short Read Only Automatic mode selection
statinfo_battery Short Read Only Status of battery
statinfo_dummy1 Short Read Only Reserved for future use
statinfo_dummy2 Short Read Only Reserved for future use
statinfo_edit Short Read Only Status of program editing
statinfo_emergency Short Read Only Status of emergency
statinfo_labelskip Short Read Only Status of label skip
statinfo_manual Short Read Only Manual mode selection
statinfo_motion Short Read Only Status of axis movement, dwell
statinfo_mstb Short Read Only Status of M,S,T,B function
statinfo_run Short Read Only Status of automatic operation
statinfo_warning Short Read Only Status of warning
statinfo_write Short Read Only Status of writing backed up memory

Returned Status Codes


Tag N ame St at us Code
0 : No alarm
statinfo_alarm
1 : Alarm

www. ptc.com
Fanuc Focas Ethernet Driver 40

Tag N ame St at us Code


0 : No selection
1 : MDI
2 : DNC
statinfo_aut
3 : Memory
4 : Edit
5 : Teach In
0 : Normal
statinfo_battery 1 : Battery low (backed up memory)
2 : Battery low (absolute position detector)
statinfo_dummy1 Not used
statinfo_dummy2 Not used
0 : Not editing
1 : Edit
2 : Search
statinfo_edit 3 : Verify
4 : Condense
5 : Read
6 : Punch
0 : Not emergency
statinfo_emergency
1 : Emergency
0 : Label skip
statinfo_labelskip
1 : Not label skip
0: No selection
1 : Reference
2 : INC feed
3 : Handle
statinfo_manual
4 : Jog
5 : Angular Jog
6 : Inc+Handl
7 : Jog+Handl
1 : Motion
statinfo_motion 2 : Dwell
3 : Wait (Waiting: only TT)
statinfo_mstb 1 : FIN
0 : Stop
1 : Hold
2 : Start
3 : MSTR (Jog MDI)
4 : Restart (Not blinking)*
statinfo_run
5 : PRSR (Program restart)
6 : NSRC (Sequence number search)
7 : Restart (Blinking)* *
8 : Reset
13 : HPCC (During RISC operation)
0 : No warning
statinfo_warning
1 : Warning

www. ptc.com
41 Fan u c Focas Eth ern et Driver

Tag N ame St at us Code


0 : Not writing
statinfo_write
1 : @Writing

* Except under manual mode and under cutter radius compensation outside corner.
* * Under manual mode or under cutter radius compensation outside corner.

Series 16i/ 18i/ 21i/ Pow er M ate i/ Open


Tag N ame Dat a Type Access Descript ion
statinfo_alarm Short Read Only Status of alarm
statinfo_aut Short Read Only Automatic / Manual mode selection
statinfo_edit Short Read Only Status of program editing
statinfo_emergency Short Read Only Status of emergency
statinfo_hdck Short Read Only Status of manual handle re-trace
statinfo_motion Short Read Only Status of axis movement, dwell
statinfo_mstb Short Read Only Status of M,S,T,B function
statinfo_run Short Read Only Status of automatic operation
statinfo_tmmode Short Read Only T/M mode selection

Returned Status Codes


Tag N ame St at us Code
0 : Others
1 : Alarm
statinfo_alarm
2 : Battery low
3 : Fan alarm
0 : MDI
1 : Memory
3 : Edit
4 : Handle
5 : Jog
statinfo_aut 6 : Teach in Jog
7 : Teach in Handle
8 : INC feed
9 : Reference
10 : Remote
11 : TEST(test operation mode)
M Series
0 : Not editing
1 : Edit
2 : Search
3 : Output
statinfo_edit
4 : Input
5 : Compare

www. ptc.com
Fanuc Focas Ethernet Driver 42

Tag N ame St at us Code


6 : Label Skip (Label skip status)
7 : Restart (During program restart)
8 : HPCC (During RISC operation)
9 : PTRR (During tool retraction and recovery mode)
10 : RVRS (During retracing)
11 : RTRY (During reprogressing)
12 : RVED (End of retracing)
13 : Handle (During handle overlapping)
14 : Offset (During tool length measurement mode)
15 : Work Offset (During work zero point measurement mode)
16 : AICC (During AI contour control)
17 : Memory-Check (Checking tape memory)
18 : Customer's Board (During customer's board control)
19 : Save (Saving fine torque sensing data)
20 : AI NANO (During AI nano contour control)
21 : AI APC (During AI advanced preview control)
22 : MBL APC (During multi blocks advanced preview control)
23 : NANO HP (Running of AI High-precision Contour Control.
24 : AI HPCC (Running of AI Nano High-precision Contour Control)
25 : 5-AXIS (Running of 5-axes machining)
26 : LEN (Change the manual active offset value: length offset change mode)
27 : RAD (Change the manual active offset value: radius offset change mode)
28 : WZR (Change the manual active offset value: workpiece origin offset change mode)
39 : TCP (During tool center point control of 5-axes machining)
40 : TWP (During tilted working plane command)
41 : TCP+TWP (During tool center point control of 5-axes machining and tilted working
plane command)
42 : APC (Advanced Preview Control)

T Series
0 : Not editing
1 : Edit
2 : Search
3 : Output
4 : Input
5 : Compare
6 : Label Skip (Label skip status)
7 : Offset (During writing mode of tool length compensation amount)
8 : Work Shift (During writing mode of work shift amount)
9 : Restart (During program restart)
14 : PTRR (During tool retraction and recovery mode)
17 : Memory-Check (Checking tape memory)
19 : Save (Saving fine torque sensing data)
23 : NANO HP (Running of AI High-precision Contour Control)
24 : AI HPCC (Running of AI Nano High-precision Contour Control)
26 : OFSX (Change the manual active offset value: X-axis offset change mode)
27 : OFSZ (Change the manual active offset value: Z-axis offset change mode)
28 : WZR (change the manual active offset value: workpiece origin offset change mode)
29 : OFSY (Change the manual active offset value: Y-axis offset change mode)

www. ptc.com
43 Fan u c Focas Eth ern et Driver

Tag N ame St at us Code


31 : TOFS (Change the manual active offset value: Tool offset change mode)
39 : TCP (During tool center point control of 5-axes machining)
40 : TWP (During tilted working plane command)
41 : TCP+TWP (During tool center point control of 5-axes machining and tilted working
plane command)
42 : APC (Advanced Preview Control)
0 : Not emergency
statinfo_emer-
1 : Emergency
gency
2 : Reset
statinfo_hdck N/A
1 : Motion
statinfo_motion
2 : Dwell
0 : Others
statinfo_mstb
1 : FIN
0 : Reset
1 : Stop
statinfo_run 2 : Hold
3 : Start
4 : MSTR*
statinfo_ 0 : T Mode
tmmode 1 : M Mode

* During operation of Jog MDI, and retraction and re-positioning of tool retraction and recovery.

Tool Offset
The values in a CNC machine's tool offset information are read using the cnc_rdtofs and written using the
cnc_wrtofs Focas API calls.
N ote: Not all addresses are valid for all device models.

CNC Data
Address Type Range Dat a Type Access
TOFS:nnnn:ooo

Tool Offset Long, DWord Read / Write


nnnn = Tool Number (1-9999)
ooo = Offset Type (0-999)

Tool Offset Types


The meaning of the tool offset type depends upon the hardware. The following tables summarize the various
offset types.

M achining Center Series (M Series, Pow er M ate i)


Cut t er Radius Tool Lengt h
Wear 0 2
Geometry 1 3

www. ptc.com
Fanuc Focas Ethernet Driver 44

M achining Center Series (M Series, Series 30i)


Cut t er Radius Tool Lengt h Imaginary Tool N ose Corner R
Wear 0 2 6 10
Geometry 1 3 7 11

Lathe Series (T Series)


X Z N ose Imaginary Tool Y 4t h 5t h
Axis Axis R N ose Axis Axis Axis
Wear 0 2 4 6 8 30 32
Geometry 1 3 5 7 9 31 33
2nd Coord Ware (Series
15 17 19 21 23 -- --
30i)
2nd Coord Geometry 16 18 20 22 24 -- --

Lathe Series (T Series, Second Geometry Offset, Series 30i)


X Axis Z Axis Y Axis
Geometry 100 101 102
2nd Coord Geometry 110 111 112

Tool Offset Values (Series 15, 15i)


Linear axis mm Linear axis inch Rot at ion
6007# 0 6004# 0 6002# 1 6002# 0
input [mm] input [inch] axis [deg]
0 0 0 1 0.01 0.001 0.01
0 0 0 0 0.001 0.0001 0.001
0 0 1 0 0.0001 0.00001 0.0001
0 1 0 0 0.00001 0.000001 0.00001
1 0 0 0 0.000001 0.0000001 0.000001

Tool Offset Values (Series 16i / 18i / 21i, 0i, Pow er M ate i, Open)
Linear axis mm input Linear axis inch input Rot at ion axis
1004# 1 1004# 0
[mm] [inch] [deg]
IS-
0 1 0.01 0.001 0.01
A*
IS-B 0 0 0.001 0.0001 0.001
IS-
1 0 0.0001 0.00001 0.0001
C* *

* IS-A is effective for Power Mate i-H.


* * IS-C is effective for Power Mate i-D.

Tool Offset Values (Series 30i)

www. ptc.com
45 Fan u c Focas Eth ern et Driver

Linear axis mm Linear axis inch Rot at ion


5042# 3 5042# 2 5042# 1 5042# 0
input [mm] input [inch] axis [deg]
0 0 0 1 0.01 0.001 0.01
0 0 0 0 0.001 0.0001 0.001
0 0 1 0 0.0001 0.00001 0.0001
0 1 0 0 0.00001 0.000001 0.00001
1 0 0 0 0.000001 0.0000001 0.000001

Workpiece Zero Offset


The values in a CNC machine's workpiece zero offset information are read using the cnc_rdzofs and written
using the cnc_wrzofs Focas API calls.
N ote: Not all addresses are valid for all device models.

CNC Data
Address Type Range Dat a Type Access
ZOFS:aa:ooo

Workpiece Zero Offset Long, DWord Read / Write


aa = axis (01-32)
ooo = offset (000-306)

Workpiece Zero Offset Values


Series 15
Linear axis
Linear axis inch Rot at ion
1009# 1 1004# 5 1004# 1 1004# 0 mm input
input [inch] axis [deg]
[mm]
IS-A 0 0 0 1 0.01 0.001 0.01
IS-B 0 0 0 0 0.001 0.0001 0.001
IS-C 0 0 1 0 0.0001 0.00001 0.0001
IS-D 0 1 0 0 0.00001 0.000001 0.00001
IS-E 1 0 0 0 0.000001 0.0000001 0.000001

Series 15, 15i


Linear axis
Linear axis inch Rot at ion
1012# 3 1012# 2 1012# 1 1012# 0 mm input
input [inch] axis [deg]
[mm]
IS-A 0 0 0 1 0.01 0.001 0.01
IS-B 0 0 0 0 0.001 0.0001 0.001
IS-C 0 0 1 0 0.0001 0.00001 0.0001
IS-D 0 1 0 0 0.00001 0.000001 0.00001
IS-E 1 0 0 0 0.000001 0.0000001 0.000001

Series 16 / 18 / 21, 16i / 18i / 21i, 0i, Pow er M ate, Open

www. ptc.com
Fanuc Focas Ethernet Driver 46

Linear axis mm input Linear axis inch input Rot at ion axis
1004# 1 1004# 0
[mm] [inch] [deg]
IS-A 0 1 0.01 0.001 0.01
IS-B 0 0 0.001 0.0001 0.001
IS-C 1 0 0.0001 0.00001 0.0001

Series 30i
Linear axis
Linear axis inch Rot at ion
1013# 3 1013# 2 1013# 1 1013# 0 mm input
input [inch] axis [deg]
[mm]
IS-A 0 0 0 1 0.01 0.001 0.01
IS-B 0 0 0 0 0.001 0.0001 0.001
IS-C 0 0 1 0 0.0001 0.00001 0.0001
IS-D 0 1 0 0 0.00001 0.000001 0.00001
IS-E 1 0 0 0 0.000001 0.0000001 0.000001

Param et er Read Values


The values in a CNC machine's parameters can be read using the cnc_rdparam tags and the cnc_rdparam
Focas API call.
Refer to the machine manual for specific parameters and which data type to assign to each.

For axis access, append .A to the parameter number, followed by the axis number. The first axis in the para-
meter is axis 1, the second axis 2, and so on. The highest axis to access is 8. If no axis is added to the
address, the first axis is read.

For bit in parameter access, append a dot (.) to the parameter number, followed by the bit number. The first
bit is bit 0. The maximum accessible bit is the 32nd bit. Bit access is allowed on axis access. Bit access is not
allowed on parameters with default data types of float or double.

Address Type Range Dat a Type Access


cnc_rdparam.0 - cnc_rdparam.37267 Default*
cnc_rdparam.0.A1 – cnc_rdparam.32767.A8 Byte, Char, Word, Read
CNC Parameter
cnc_rdparam.0.0* * – cnc_rdparam.32767.31* * Short, DWord, Long, Only
cnc_rdparam.0.A1.0* * -cnc_rdparam.32767.A8.31* * Float, Double
* The correct data type for each parameter is dependent on which machine is being accessed. When cre-
ating a CNC Parameter tag, the data type must be manually assigned. Otherwise, the Default data type is
assigned. If Default is the assigned data type, then the data type of the tag is determined and set at runtime.

* * Bit in parameter tags can only be assigned the Boolean data type.

Alarm Values
Specific alarm information can be read using the cnc_alarm2 tag and using the cnc_alarm2 Focas API call.
Refer to the machine manual for which bits correspond with which alarms. When a bit is set to true, there is
one or more alarms of that type present in the machine.

www. ptc.com
47 Fan u c Focas Eth ern et Driver

For bit access, append a dot (.) to the cnc_alarm2 tag. The range is 32-bits starting at bit 0 (0-31). All bit tags
can only be assigned the Boolean data type.

Address Type Range Dat a Type Access


cnc_alarm2
cnc_alarm2.0
Alarm Reporting DWord, Long, Boolean Read Only
through
cnc_alarm2.31

Diagnost ic Values
The diagnostic values of the machine can be read with cnc_diagnoss tags and uses the cnc_diagnoss Focas API
call. The user must provide a diagnosis number and the desired axis. For values that do not have an axis, 0
must be used. An axis value of -1 (ALL_AXES) is not supported.

The format for these tag addresses are in the form cnc_diagnoss: A:B.C where A is the diagnosis number, B
is the axis, and C is optional bit access. Tag address examples include:

l cnc_diagnoss:301:1
l cnc_diagnoss:301:2
l cnc_diagnoss:301:3
l cnc_diagnoss:1140:0 (as a Byte)
l cnc_diagnoss:1140:0.0 (as a Boolean)

For bit access, append a dot (.) to the cnc_diagnoss tag. The range is 8-bits starting at bit 0 (0-7). All bit tags
can only be assigned the Boolean data type.

Address
Range Dat a Type Access
Type
cnc_diagnoss:1:0
through
cnc_diagnoss:A:B Boolean, Byte,
where A is the maximum diagnosis number and B is the Char, Word,
maximum axis defined. Short, DWord,
Diagnostic Read
These maximums are machine dependent. Long,
Reporting Only
Float, Double
For bit access to values:
cnc_diagnoss:1:0.0 Boolean
through
cnc_diagnoss:A:B.7

Pat h Values
The target_path tag can be used to get and set the current path for the controller. Writing a value to the tar-
get_path tag produces a cnc_setpath Focas API call to the machine. A read produces a cnc_getpath Focas API
call.

www. ptc.com
Fanuc Focas Ethernet Driver 48

Tag
Dat a Type Access Descript ion
N ame
target_ Byte, Char, Word, Short, DWord, Read / Used to get or set the current path for the con-
path Long Write troller.

Read Axis Dat a Values


The axis data values of the machine can be read with cnc_rdaxisdata tags and uses the cnc_rdaxisdata Focas
API call. The user must provide a class, type, axis, and whether they want the data or flag value.
Refer to the documentation of cnc_rdaxisdata for the specific class and type combinations that retrieve the tar-
get information.

N ote: The cnc_rdaxisdata call is only supported for the 0i and the 30i and higher Fanuc Focas controller
models.
Refer to the Fanuc Focas API documentation for sub-model support information for this call.

The format for these tag addresses are in the form cnc_rdaxisdata: A:B:C:data or cnc_rdaxisdata: A:B:C:flags.D
where A is the class, B is the type, C is the axis, and D is optional bit access on the flags value.

Data is organized by classes with the type of data dependent on the class selected.
Below are the definitions of each class, the types available, and the flags available (as documented by the
Fanuc Focas API):

Class Types Available Flags Available


1: Pos- 0: Absolute position Bit 0: Display state
ition 1: Machine position 1 = Displayed on CNC screen : 0 = Not displayed on
Value 2: Relative position CNC screen
3: Distance to go Bit 1: Axis detaching state
4: Handle interruption (input unit) 1 = enabled : 0 = disabled
5: Handle interruption (output unit) Bit 2: Interlock state
6: Start point of program restart 1 = enabled : 0 = disabled
7: Distance to go of program restart Bit 3: Machine lock state
8: Start point of block restart 1 = enabled : 0 = disabled
9: Distance to go of block restart Bit 4 : Servo off state
1 = enabled : 0 = disabled
Bit 5: In-position check
1 = Not in-position : 0 = In-position
Bit 6: Mirror image state
1 = enabled : 0 = disabled
Bit 7: Diameter and radius setting switching function
1 = switching : 0 = not switching
Bit 8: High speed program check mode(only machine
coordinate)
1 = enabled : 0 = disabled
Bit 9: Optional one axis approach by program restart
1 = executing : 0 = not executing
Bit 10: Restart coordinates display on the program
restart screen(except machine coordinate)
1 = possible : 0 = impossible (display "* * * * * * * * * * * ")
Bit 11: Release state of axis (Flexible path axis assign-

www. ptc.com
49 Fan u c Focas Eth ern et Driver

Class Types Available Flags Available


ment function)
1 = enabled : 0 = disabled
Bit 12-15 : not used
2: Servo 0: Servo load meter None
1: Load current (% unit)
2: Load current (Ampere unit)
3: Spindle 0: Spindle load meter For Types 5-7 Only:
1: Spindle motor speed Bit 0: Data judgment result
2: Spindle speed (according to para- 1 = It has judged : 0 = Unjudgment
meter 3799# 2) Bit 1: Presence of data
3: Spindle speed (got from Spindle 1 = Exist : 0 = None
motor speed) Bit 2-15 : not used
4: Spindle load meter (average of
each 250ms)
5: Spindle load meter (maximum
value)
6: Spindle load meter (maximum
value) (average of each 250ms)
7: Time that spindle can continue pro-
cessing
4: Selec- 0: Spindle load meter For Types 5-7 Only:
ted 1: Spindle motor speed Bit 0: Data judgment result
Spindle 2: Spindle speed (according to para- 1 = It has judged : 0 = Unjudgment
meter 3799# 2) Bit 1: Presence of data
3: Spindle speed (got from Spindle 1 = Exist : 0 = None
motor speed) Bit 2-15 : not used
4: Spindle load meter (average of
each 250ms)
5: Spindle load meter (maximum
value)
6: Spindle load meter (maximum
value) (average of each 250ms)
7: Time that spindle can continue pro-
cessing
5: Speed 0: Feed rate (F) (Feed per minute) Bit 0: Spindle speed
1: Spindle speed (S) 1 = spindle exists : 0 = spindle not exist
2: Jog speed / Dry run speed Bit 1: Jog speed / Dry run speed
3: Tool tip speed 1 = Dry run speed : 0 = Jog speed
4: Rotation speed of servo motor Bit 2-15 : not used
5: Feed rate (F/S)

Address examples include:

l cnc_rdaxisdata:1:1:1:data (Machine position of the x axis)


l cnc_rdaxisdata:1:1:2:data (Machine position of the y axis)
l cnc_rdaxisdata:1:1:3:data (Machine position of the z axis)

www. ptc.com
Fanuc Focas Ethernet Driver 50

l cnc_rdaxisdata:1:1:1:flags.0 (Whether the machine position of the x axis is displayed on the screen or
not)
l cnc_rdaxisdata:2:1:2:data (Load current as a percentage of the y axis)

For data that is not specific to an axis use an axis value of 1.

Address Type Range Dat a Type Access


Axis Data Reporting cnc_rdaxisdata:1:0:1:data Boolean, Byte, Char, Read Only
through Word,
cnc_rdaxisdata:5:9:32:data Short, DWord, Long,
Float, Double
cnc_rdaxisdata:1:0:1:flags
through
cnc_rdaxisdata:5:9:32:flags
Boolean

These maximums are device dependent. For


ease of use, a maximum of 32 axes can be
defined; note that the device may not allow
that many.

For bit access to flags value:


cnc_rdaxisdata:1:0:1:flags.0
through
cnc_rdaxisdata:5:9:32:flags.15

Program Values
The currently running program number along with the main program number can be read. These values can
be the same or reflect different programs or sub-programs running. These values are read through the cnc_
rdprgnum Focas API call.

Tag N ame Dat a Type Access Descript ion


cnc_rdprgnum_ Word, Short, Read
The main program set on the machine.
Main DWord, Long Only
cnc_rdprgnum_ Word, Short, Read The currently running program on the machine. This
Running DWord, Long Only can be a sub-program.

Program Nam e
The name of the program being executed can be read. These values are read through the cnc_exeprgname
Focas API call.

N ote: The cnc_exeprgname call is only supported for the Fanuc Focas controller models 0i and 30i and
above. Refer to the Fanuc Focas API documentation for sub-model support information for this call.

Tag N ame Dat a Type Access Descript ion


cnc_exeprg- Read
String The name of the program being executed.
name_Name Only
cnc_exeprg- Word, Short, Read The O number of the program being executed. It will be 0

www. ptc.com
51 Fan u c Focas Eth ern et Driver

Tag N ame Dat a Type Access Descript ion


name_Number DWord, Long Only if there is not an O number.

Read Dynam ic2 Dat a Values


The read dynamic2 data represents many different values in a single call. There is positional data for each
axis and data for the device itself. Positional data units can depend on the device. These values are read
through the cnc_rddynamic2 Focas API call.

Dat a
Tag N ame Access Descript ion
Type
DWord,
cnc_rddynamic2_ActF Read Only The actual feed rate.
Long
DWord,
cnc_rddynamic2_ActS Read Only The actual spindle speed.
Long
The alarm status. The bits represent dif-
cnc_rddynamic2_Alarm ferent alarms based on the model.
DWord, Refer to the device documentation for
cnc_rddynamic2_Alarm.0 Long Read Only the specific meaning of each bit.
through Boolean
cnc_rddynamic2_Alarm.31 Used for bit access to the different
alarms.
DWord,
cnc_rddynamic2_PrgMNum Read Only The main program number.
Long
DWord,
cnc_rddynamic2_PrgNum Read Only The current program number.
Long
DWord,
cnc_rddynamic2_SeqNum Read Only The current sequence number.
Long
The absolute position for the axis spe-
cnc_rddynamic2:1:Abs cified. The axis number can go up to 32
DWord,
through Read Only axes. The number of axes that have
Long
cnc_rddynamic2:32:Abs data depends on the number of axes
defined on the controller.
The distance to go for the axis spe-
cnc_rddynamic2:1:Dis cified. The axis number can go up to 32
DWord,
through Read Only axes. The number of axes that have
Long
cnc_rddynamic2:32:Dis data depends on the number of axes
defined on the controller.
The machine position for the axis spe-
cnc_rddynamic2:1:Mac cified. The axis number can go up to 32
DWord,
through Read Only axes. The number of axes that have
Long
cnc_rddynamic2:32:Mac data depends on the number of axes
defined on the controller.
The relative position for the axis spe-
cnc_rddynamic2:1:Rel
DWord, cified. The axis number can go up to 32
through Read Only
Long axes. The number of axes that have
cnc_rddynamic2:32:Rel
data depends on the number of axes

www. ptc.com
Fanuc Focas Ethernet Driver 52

Dat a
Tag N ame Access Descript ion
Type
defined on the controller.

Read Alarm M essages


Reads the current alarm messages. A maximum of 50 concurrent alarm messages can be read. These val-
ues are read through the cnc_rdalmmsg Focas API call.

Refer to the machine manual for the definitions of the alarm type values that are returned.

Address Type Range Dat a Type Access


cnc_rdalmmsg:1:Axis
Alarm Axis through DWord, Long, Short, Word Read Only
cnc_rdalmmsg:50:Axis

cnc_rdalmmsg:1:Msg
Alarm Message through String Read Only
cnc_rdalmmsg:50:Msg

cnc_rdalmmsg:1:Num
Alarm Number through DWord, Long Read Only
cnc_rdalmmsg:50:Num

cnc_rdalmmsg:1:Type
Alarm Type through DWord, Long, Short, Word Read Only
cnc_rdalmmsg:50:Type

Read Tim er Dat a Values


Reads the cutting time, cycle time, and other timer data from the device. These values are read through the
cnc_rdtimer Focas API call.

The machine data represented in the following tags is created by combining the results into a single value of
<seconds>.<milliseconds> expressed as a double floating-point integer.

Address Type Range Dat a Type Access


Cutting Time cnc_rdtimer_Cutting Double Read Only
Cycle Time cnc_rdtimer_Cycle Double Read Only
Free Purpose Time cnc_rdtimer_FreePupose Double Read Only
Operating Time cnc_rdtimer_Operating Double Read Only
Power On Time cnc_rdtimer_PowerOn Double Read Only

www. ptc.com
53 Fan u c Focas Eth ern et Driver

Event Log Messages


The following information concerns messages posted to the Event Log pane in the main user interface. Con-
sult the OPC server help on filtering and sorting the Event Log detail view. Server help contains many com-
mon messages, so should also be searched. Generally, the type of message (informational, warning) and
troubleshooting information is provided whenever possible.

Address Validat ion


The following messages may be generated. Click the link for a description of the message.

Address <address> is out of range for t he specified device or regist er.


Array size is out of range for address <address>.
Array support is not available for t he specified address: <address>.
Dat a t ype <t ype> is not valid for device address <address>.
Device address <address> cont ains a synt ax error.
Device address <address> is read only.
M issing address.

Address <address> is out of range for t he specified device or regist er.


Error Type:
Warning

Possible Cause:
A tag address that has been specified statically references a location that is beyond the range of supported
locations for the device.

Solution:
Verify that the address is correct; if it is not, re-enter it in the client application.

Array size is out of range for address <address>.


Error Type:
Warning

Possible Cause:
A tag address that has been specified statically is requesting an array size that is too large for the address
type or block size of the driver.

Solution:
Re-enter the address in the client application to specify a smaller value for the array or a different starting
point.

Array support is not available for t he specified address: <address>.


Error Type:
Warning

www. ptc.com
Fanuc Focas Ethernet Driver 54

Possible Cause:
A tag address that has been specified statically contains an array reference for an address type that doesn't
support arrays.

Solution:
Re-enter the address in the client application to remove the array reference or correct the address type.

Dat a Type <t ype> is not valid for device address <address>.
Error Type:
Warning

Possible Cause:
A tag address that has been specified statically has been assigned an invalid data type.

Solution:
Modify the requested data type in the client application.

Device address <address> cont ains a synt ax error.


Error Type:
Warning

Possible Cause:
A tag address that has been specified statically contains one or more invalid characters.

Solution:
Re-enter the address in the client application.

Device address <address> is read only.


Error Type:
Warning

Possible Cause:
A tag address that has been specified statically has a requested access mode that is not compatible with
what the device supports for that address.

Solution:
Change the access mode in the client application.

M issing address.
Error Type:
Warning

Possible Cause:
A tag address that has been specified statically has no length.

Solution:

www. ptc.com
55 Fan u c Focas Eth ern et Driver

Re-enter the address in the client application.

Device St at us M essages
The following messages may be generated. Click the link for a description of the message.

Device <device name> is not responding.


Unable t o writ e t o <address> on device <device name>.

Device <device nam e> is not responding.


Error Type:
Serious

Possible Cause:
1. The connection between the device and the host PC is broken.

2. The IP address assigned to the device is incorrect.

3. The response from the device took longer to receive than the amount of time specified in the
"Request Timeout" device setting.

Solution:
1. Verify the cabling between the PC and the PLC device.

2. Verify that the IP address given to the named device matches that of the actual device.

3. Increase the Request Timeout setting so that the entire response can be handled.

Unable t o writ e t o <address> on device <device nam e>.


Error Type:
Serious

Possible Cause:
1. The connection between the device and the host PC is broken.

2. The named device may have been assigned an incorrect IP address.

Solution:
1. Verify the cabling between the PC and the PLC device.

2. Verify that the IP address given to the named device matches that of the actual device.

General Driver M essages


The following messages may be generated. Click the link for a description of the message.

Could not acquire library handle for device <channel.device>. FWLIB error: <code>.
Could not read one or more vacant macros in range st art ing at <address> on device
<device>.

www. ptc.com
Fanuc Focas Ethernet Driver 56

Could not set request t imeout for device <channel.device>. FWLIB error: <code>.
Invalid XM L document . Reason: Error loading Unsolicit ed Dat a Areas for device <device
name>. End address can not be less t han st art address for area area-number.
Invalid XM L document . Reason: Error loading Unsolicit ed Dat a Areas for device device-
name. Invalid area order or duplicat e area number.
Invalid XM L document . Reason: Error loading Unsolicit ed Dat a Areas for device device-
name. M aximum size of area area-number is size byt es.
Read error occurred for address st art ing at <address> on device <channel.device>. FWLIB
error: <code>.
Unable t o st art t he Fanuc Focas Dat a Window Library services.
Writ e error occurred for address <address> on device <channel.device>. FWLIB error:
<code>.

Could not acquire library handle for device <channel.device>. FWLIB error:
<code>.
Error Type:
Warning

Possible Cause:
1. Call to Focas 1 Data Window Library to connect to device failed.

2. Invalid device IP or port number.

3. The device may not be running.

4. The device may be busy processing other requests.

5. There may be a cabling problem.

Solution:
The error code provided by the library should help diagnose the problem. If the problem is transient, the
driver should be able to connect on a subsequent retry.

See Also:
Focas 1 Dat a Window Library Error Codes

Could not read one or m ore vacant m acros in range st art ing at <address>
on device <device>.
Error Type:
Warning

Possible Cause:
The macro number is not configured in the device.

Solution:
Check the tag address and device configuration.

www. ptc.com
57 Fan u c Focas Eth ern et Driver

Could not set request t im eout for device <channel.device>. FWLIB error:
<code>.
Error Type:
Warning

Possible Cause:
1. Call to Focas 1 Data Window Library to set request timeout failed.

2. Invalid timeout.

3. The device may be busy processing other requests.

4. There may be a cabling problem.

Solution:
The error code provided by the library should help diagnose the problem. If the problem is transient, the
driver should be able to set the timeout on a subsequent retry.

See Also:
Focas 1 Dat a Window Library Error Codes

Invalid XM L docum ent . Reason: Error loading Unsolicit ed Dat a Areas for
device <device-nam e>. End address can not be less t han st art address for
area <area-num ber>.
Error Type:
Fatal

Possible Cause:
The end address for the given unsolicited data area is greater than the start address.

Solution:
Make the end address greater than or equal to the start address.

Invalid XM L docum ent . Reason: Error loading Unsolicit ed Dat a Areas for
device <device-nam e>. Invalid area order or duplicat e area num ber.
Error Type:
Fatal

Possible Cause:
1. The unsolicited data areas are not listed in the correct order.

2. There are duplicate area numbers.

Solution:
1. Correct the ordering of the unsolicited data areas to be in the increasing order starting at 1.

2. Renumber the duplicate area number.

www. ptc.com
Fanuc Focas Ethernet Driver 58

See Also:
Unsolicited Data Areas

Invalid XM L docum ent . Reason: Error loading Unsolicit ed Dat a Areas for
device <device-nam e>. M axim um size of area <area-num ber> is <size>
byt es.
Error Type:
Fatal

Possible Cause:
The maximum number of bytes for areas 1, 2, or 3 are 1430, 1414, or 1398 respectively. The range that has
been defined for these areas is outside this limit.

Solution:
Correct the unsolicited data area size based on the limits above.

See Also:
Unsolicit ed Dat a Areas

Read error occurred for address st art ing at <address> on device <chan-
nel.device>. FWLIB error: <code>.
Error Type:
Warning

Possible Cause:
1. Call to Focas 1 Data Window Library to read data failed.

2. Invalid PMC type.

3. Invalid address.

4. Invalid request size.

5. The device may be busy processing other requests.

6. There may be a cabling problem.

Solution:
The error code provided by the library should help diagnose the problem. If the problem is transient, the
driver should be able to read the data on a subsequent retry.

See Also:
Focas 1 Dat a Window Library Error Codes

Unable t o st art t he Fanuc Focas Dat a Window Library services.


Error Type:
Fatal

www. ptc.com
59 Fan u c Focas Eth ern et Driver

Possible Cause:
The driver was unable to load the Fanuc Focas Data Window Library.

Solution:
Make sure that the library is installed on the computer. Contact this software's distributor.

Writ e error occurred for address <address> on device <channel.device>.


FWLIB error: <code>.
Error Type:
Warning

Possible Cause:
1. Call to Focas 1 Data Window Library to write data failed.

2. Invalid PMC type.

3. Invalid address.

4. Invalid request size.

5. The device may be busy processing other requests.

6. There may be a cabling problem.

Solution:
The error code provided by the library should help diagnose the problem. If the problem is transient, the
driver should be able to write the data on a subsequent retry.

See Also:
Focas 1 Dat a Window Library Error Codes

Fanuc Focas Server Device Driver M essages


The following messages may be generated. Click the link for a description of the message.

At t empt t o launch unsolicit ed message server failed.


Could not access necessary syst em resources for Fanuc Focas server device: <chan-
nel.device>.
Failed t o connect Fanuc Focas server device <channel.device>. Could not acquire library
handle. FWLIB error: <code>.
Failed t o connect Fanuc Focas server device <channel.device>. Could not det ermine host
IP address.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set dat a area
size.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set dat a area
st art address.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set dat a area
t ype.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set host IP.

www. ptc.com
Fanuc Focas Ethernet Driver 60

Failed t o connect Fanuc Focas server device <channel.device>. Could not set host port .
Failed t o connect Fanuc Focas server device <channel.device>. Could not set message
alive t ime.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set message
ret ries.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set message
t imeout .
Failed t o connect Fanuc Focas server device <channel.device>. Could not set messaging
propert ies. FWLIB dat a error <code>.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set messaging
propert ies. FWLIB error: <code>.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set number of
dat a areas.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set request
t imeout . FWLIB error: <code>.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set t rans-
mission cont rol PM C t ype.
Failed t o connect Fanuc Focas server device <channel.device>. Could not set t rans-
mission cont rol st art address.
Failed t o connect Fanuc Focas server device <channel.device>. Could not st art messaging
session. FWLIB error: <code>.
Inst alled version of Focas 1 Library does not support unsolicit ed communicat ion. Device
<channel.device> deact ivat ed.
Received CN C power down not ificat ion from unsolicit ed message server. Reconnect ing
Fanuc Focas server devices.
Received CN C power up not ificat ion from unsolicit ed message server.
Received socket error not ificat ion from unsolicit ed message server.
Received unsolicit ed message server shut down not ificat ion.
Unsolicit ed message server does not seem t o be running. At t empt ing t o launch.

At t em pt t o launch unsolicit ed m essage server failed.


Error Type:
Warning

Possible Cause:
The driver was not able to start the Unsolicited Message Server.

Solution:
For the restart to succeed, the message server executable file "UMsgServ.ext" must be located in the host
computer’s system folder.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session, or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

www. ptc.com
61 Fan u c Focas Eth ern et Driver

See Also:
Unsolicit ed M essaging

Could not access necessary syst em resources for Fanuc Focas server
device: <channel.device>.
Error Type:
Serious

Possible Cause:
The driver could not create data objects needed for unsolicited communications.

Solution:
Close down all unnecessary applications running on the host computer.

Failed t o connect Fanuc Focas server device <channel.device>. Could not


acquire library handle. FWLIB error: <code>.
Error Type:
Warning

Possible Cause:
1. Call to Focas 1 Data Window Library to connect to device failed.

2. Invalid device IP or port number.

3. The device may not be running.

4. The device may be busy processing other requests.

5. There may be a cabling problem.

Solution:
The error code provided by the library should help diagnose the problem. If the problem is transient, the
driver should be able to connect on a subsequent retry.

N ote: The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session, or
restart the session after detection of a communications problem. Tags belonging to a Fanuc Focas server
device in an error state continue to show the last value received from the device or their initial value of zero.

See Also: Focas 1 Data Window Library Error Codes

Failed t o connect Fanuc Focas server device <channel.device>. Could not


det erm ine host IP address.
Error Type:
Warning

Possible Cause:
Part of starting an unsolicited messaging session with a device includes informing the device of the IP of the
host computer. This message will be posted if the driver fails to determine the default IP of the host com-
puter.

www. ptc.com
Fanuc Focas Ethernet Driver 62

Solution:
Make sure that an IP address is configured for the computer.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session, or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set dat a area size.
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set unsolicited message data area size failed.

Solution:
Ensure that the specified range of addresses is valid.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Dat a Areas

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set dat a area st art address.
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set unsolicited message data area start address failed.

Solution:
Ensure that the specified start address is valid.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Dat a Areas

www. ptc.com
63 Fan u c Focas Eth ern et Driver

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set dat a area t ype.
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set unsolicited message data area type failed.

Solution:
Ensure that the specified type is valid.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Dat a Areas

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set host IP.
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set host IP of Unsolicited Message Server failed.

Solution:
Check the IP of the host computer.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set host port .
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set host port of Unsolicited Message Server failed.

Solution:
Ensure that the specified port number is valid.

www. ptc.com
Fanuc Focas Ethernet Driver 64

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Transfer Cont rol

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set m essage alive t im e.
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set unsolicited message alive time failed.

Solution:
Ensure that the specified alive time value is valid.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Transfer Cont rol

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set m essage ret ries.
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set transmission control message retries failed.

Solution:
Ensure that the specified retries value is valid.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Transfer Cont rol

www. ptc.com
65 Fan u c Focas Eth ern et Driver

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set m essage t im eout .
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set unsolicited message timeout failed.

Solution:
Ensure that the specified timeout value is valid.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Transfer Cont rol

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set m essaging propert ies. FWLIB dat a error <code>.
Error Type:
Warning

Possible Cause:
1. Call to Focas 1 Data Window Library to set unsolicited messaging properties failed due to a data
related error.

2. Invalid transfer control parameters.

3. The device may not be running.

4. The device may be busy processing other requests.

5. There may be a cabling problem.

Solution:
The error code provided by the library should help diagnose the problem. If the problem is transient, the
driver should be able to connect on a subsequent retry.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Focas 1 Dat a Window Library Error Codes
Unsolicit ed Transfer Cont rol

www. ptc.com
Fanuc Focas Ethernet Driver 66

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set m essaging propert ies. FWLIB error: <code>.
Error Type:
Warning

Possible Cause:
1. Call to Focas 1 Data Window Library to set unsolicited messaging properties failed due to a non-data
related error.

2. Invalid transfer control properties.

3. The device may not be running.

4. The device may be busy processing other requests.

5. There may be a cabling problem.

Solution:
The error code provided by the library should help diagnose the problem. If the problem is transient, the
driver should be able to connect on a subsequent retry.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Focas 1 Dat a Window Library Error Codes
Unsolicit ed Transfer Cont rol

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set num ber of dat a areas.
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set number of unsolicited message data areas failed.

Solution:
Ensure that the device supports the number of data areas configured.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session, or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Dat a Areas

www. ptc.com
67 Fan u c Focas Eth ern et Driver

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set request t im eout . FWLIB error: <code>.
Error Type:
Warning

Possible Cause:
1. Call to Focas 1 Data Window Library to set request timeout failed.

2. Invalid timeout.

3. The device may be busy processing other requests.

4. There may be a cabling problem.

Solution:
The error code provided by the library should help diagnose the problem. If the problem is transient, the
driver should be able to set the timeout on a subsequent retry.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session, or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Focas 1 Dat a Window Library Error Codes

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set t ransm ission cont rol PM C t ype.
Error Type:
Warning

Possible Cause:
Call to Focas 1 Data Window Library to set transmission control PMC type failed.

Solution:
Ensure that the specified PMC type is valid.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Transfer Cont rol

Failed t o connect Fanuc Focas server device <channel.device>. Could not


set t ransm ission cont rol st art address.
Error Type:

www. ptc.com
Fanuc Focas Ethernet Driver 68

Warning

Possible Cause:
Call to Focas 1 Data Window Library to set transmission control start address failed.

Solution:
Ensure that the specified start address is valid.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed Transfer Cont rol

Failed t o connect Fanuc Focas server device <channel.device>. Could not


st art m essaging session. FWLIB error: <code>.
Error Type:
Warning

Possible Cause:
1. Call to Focas 1 Data Window Library to start unsolicited messaging session failed.

2. Invalid transfer control parameters.

3. The device may not be running.

4. The device may be busy processing other requests.

5. There may be a cabling problem.

Solution:
The error code provided by the library should help diagnose the problem. If the problem is transient, the
driver should be able to connect on a subsequent retry.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Focas 1 Dat a Window Library Error Codes
Unsolicit ed Transfer Cont rol

Inst alled version of Focas Dat a Window Library does not support unso-
licit ed com m unicat ion. Device <device> deact ivat ed.
Error Type:

www. ptc.com
69 Fan u c Focas Eth ern et Driver

Serious

Possible Cause:
The server project includes Fanuc Focas server devices, but the version of the Focas 1 Data Window Library
software installed on the system does not support unsolicited communication.

Solution:
Contact the distributor for library update. The device's firmware may also need to be upgraded.

See Also:
Additional Software Requirem ents

Received CNC power down not ificat ion from unsolicit ed m essage server.
Reconnect ing Fanuc Focas server devices.
Error Type:
Warning

Possible Cause:
The Unsolicited Message Server has notified the driver that with one of the devices it has started an unso-
licited messaging session with no longer appears to be running. The likely reason is that the CNC was
powered down. Network problems could also be responsible.

Solution:
Restart the CNC and check for networking problems such as cable breaks. The driver should automatically
resume communication with the device.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

Received CNC power up not ificat ion from unsolicit ed m essage server.
Error Type:
Warning

Possible Cause:
The Unsolicited Message Server has notified the driver that one of the devices it has started an unsolicited
messaging session with has been powered up. This message likely follows a "Received CN C power down
notification" message.

Solution:
This is for information only. The driver should automatically resume communication with the device.

Received socket error not ificat ion from unsolicit ed m essage server.
Error Type:
Warning

www. ptc.com
Fanuc Focas Ethernet Driver 70

Possible Cause:
The Unsolicited Message Server experienced a socket error for one or more of the connections to a device
on the network.

Solution:
If the problem is transient, the driver should recover from this error by restarting all unsolicited messaging
sessions. If not, investigate cabling, CNC power supply, and I/F board.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session, or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

Received unsolicit ed m essage server shut down not ificat ion.


Error Type:
Warning

Possible Cause:
The Unsolicited Message Server was shutdown while the driver was using it.

Solution:
This is for information only. The driver automatically restarts the message server. For the restart to succeed,
the message server executable file "UMsgServ.exe" must be located in the host computer’s system dir-
ectory.

Note:
The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session, or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed M essaging

Unsolicit ed m essage server does not seem t o be running. At t em pt ing t o


launch.
Error Type:
Warning

Possible Cause:
The Unsolicited Message Server has stopped running, and was not shutdown normally.

Solution:
This is for information only. The driver automatically restarts the message server. For the restart to succeed,
the message server executable file "UMsgServ.exe" must be located in the host computer’s system folder.

Note:

www. ptc.com
71 Fan u c Focas Eth ern et Driver

The device's _System._Error Tag is set if the driver fails to start an unsolicited messaging session, or restart
the session after detection of a communications problem. Tags belonging to a Fanuc Focas server device in
an error state continue to show the last value received from the device or their initial value of zero.

See Also:
Unsolicit ed M essaging

Focas 1 Dat a Window Library Error Codes


The Fanuc Focas Ethernet Driver uses the Fanuc Focas 1 Data Window Library software to communicate with
devices on the network. When the library cannot complete a request made by this driver, it returns an error
code describing the reason. These error codes are included in the relevant driver error messages. This table
is provided to aid in diagnosing the hardware or software configuration problem causing these errors. For
more information, refer to Additional Software Requirem ents.

Error Error M eaning


Code Type
-17 Protocol Data from Ethernet board is incorrect.
-16 Socket Investigate CNC power supply, Ethernet cable, and I/F board.
-15 DLL There is no DLL file for CNC series.
-8 Handle Invalid connection handle.
The CNC / PMC version does not match that of the library. Replace the library or
-7 Version
the CNC / PMC control software.
-6 Unexpected An unanticipated error occurred.
-2 Reset The RESET or STOP button was pressed.
The CNC was busy processing another request. This commonly occurs during
-1 Busy Fanuc Focas server device connect attempts. The driver retries until a connection
is made.
0 Normal Function was completed without error.
Function was not executed or is not available. This can occur if the Unsolicited Mes-
1
Function sage Server goes down while the driver is using it. The driver then attempts to
(CNC)
restart the message server.
1
No PMC The PMC does not exist.
(PMC)
2 Length Invalid data block length.
3
Number Invalid data number.
(CNC)
3
Range Invalid address range.
(PMC)
4 Invalid data attribute. This could result from a bad address type or range for data
Attribute
(CNC) Read/Write.
4
Type Invalid address type.
(PMC)
5 Data Invalid data.
6 No Option Invalid CNC option.

www. ptc.com
Fanuc Focas Ethernet Driver 72

Error Error M eaning


Code Type
7 Protection Write operation is prohibited.
8 Overflow CNC tape memory is overflowed.
9 Parameter CNC parameter is set incorrectly.
The buffer is empty or full. This can occur if there are more devices than the Unso-
10 Buffer
licited Message Server is configured to handle.
11 Path Invalid path number.
12 Mode Invalid CNC mode.
CNC rejected request. This can occur if an attempt is made to start multiple unso-
13 Reject
licited messaging sessions with the same device.
14 Data Server Data server error occurred.
15 Alarm Function cannot be executed due to an alarm in CNC.
16 Stop CNC status is stop or emergency.
17 Password Data is protected by the CNC data protection function.

www. ptc.com
73 Fan u c Focas Eth ern et Driver

API Calls
The following list of API calls includes links to the tags associated with each call.

API Call Relat ed Tags


cnc_alarm2 Alarm Values
cnc_diagnoss Diagnostic Values
cnc_exeprg-
Program N am e
name
cnc_getpath Path Values
cnc_rdalmmsg Read Alarm Messages
cnc_rdaxisdata Read Axis Data Values
cnc_rddynamic2 Read Dynam ic2 Data Values
cnc_rdmacro Used to read Custom Macro Values. These are model specific. Address Descriptions
cnc_rdmacror Used to read Custom Macro Values. These are model specific. Address Descriptions
cnc_rdparam Param eter Read Values
cnc_rdprgnum Program Values
cnc_rdtimer Read Tim er Data Values
cnc_rdtofs Tool Offset
cnc_rdzofs Workpiece Zero Offset
cnc_setpath Path Values
cnc_statinfo Status Info Tags
cnc_sysinfo System Info Tags
cnc_wrmacro Used to write Custom Macro Values. These are model specific. Address Descriptions
cnc_wrmacror Used to write Custom Macro Values. These are model specific. Address Descriptions
cnc_wrtofs Tool Offset
cnc_wrzofs Workpiece Zero Offset
pmc_rdpmcrng Used to read PMC Data. These are model specific. Address Descriptions
pmc_wrpmcrng Used to write PMC Data. These are model specific. Address Descriptions

www. ptc.com
Fanuc Focas Ethernet Driver 74

Index

Additional Software Requirements 6


Address <address> is out of range for the specified device or register. 53
Address Descriptions 24
Address Validation 53
Alarm Values 46
API Calls 73
Array size is out of range for address <address>. 53
Array support is not available for the specified address:<address>. 53
Attempt to launch unsolicited message server failed. 60
Attempts Before Timeout 15
Auto-Demotion 15

Boolean 23

Channel Assignment 12
Channel Properties — Advanced 11
Channel Properties — Ethernet Communications 10
Channel Properties — General 9
Channel Properties — Write Optimizations 10
cnc_alarm2 73
cnc_diagnoss 73
cnc_exeprgname 73
cnc_getpath 73
cnc_rdalmmsg 73
cnc_rdaxisdata 73
cnc_rddynamic2 73
cnc_rdmacro 73
cnc_rdmacror 73
cnc_rdparam 73
cnc_rdprgnum 73

www. ptc.com
75 Fan u c Focas Eth ern et Driver

cnc_rdtimer 73
cnc_rdtofs 73
cnc_rdzofs 73
cnc_setpath 73
cnc_statinfo 73
cnc_wrmacro 73
cnc_wrmacror 73
cnc_wrtofs 73
cnc_wrzofs 73
COM 20
Communications Parameters 16
Communications Timeouts 14-15
Connect Timeout 14
Could not access necessary system resources for Fanuc Focas server device: <channel.device>. 61
Could not acquire library handle for device <channel.device>. FWLIB error <code>. 56
Could not read one or more vacant macros in range starting at <address> on device <device>. 56
Could not set request timeout for device <channel.device>. FWLIB error <code>. 57

Data Collection 13
Data Type <type> is not valid for device address <address>. 54
Data Types Description 23
Demote on Failure 15
Demotion Period 16
Device <device name> is not responding. 55
Device address <address> contains a syntax error. 54
Device address <address> is read only. 54
Device ID 8
Device Properties — Auto-Demotion 15
Device Properties — General 12
Device Properties — Redundancy 18
Device Properties — Timing 14
Device Status Messages 55
Diagnostic Values 47
Diagnostics 9
Discard Requests when Demoted 16
Do Not Scan, Demand Poll Only 14
Driver 12

www. ptc.com
Fanuc Focas Ethernet Driver 76

Driver Error Messages 55


Duty Cycle 11
DWord 23

Ethernet Settings 10
Event Log Messages 53
External Dependencies 5

Failed to connect Fanuc Focas server device <channel.device>. Could not acquire library handle. FWLIB
error <code>. 61
Failed to connect Fanuc Focas server device <channel.device>. Could not determine host IP address. 61
Failed to connect Fanuc Focas server device <channel.device>. Could not set data area size. 62
Failed to connect Fanuc Focas server device <channel.device>. Could not set data area start address. 62
Failed to connect Fanuc Focas server device <channel.device>. Could not set data area type. 63
Failed to connect Fanuc Focas server device <channel.device>. Could not set host IP. 63
Failed to connect Fanuc Focas server device <channel.device>. Could not set host port. 63
Failed to connect Fanuc Focas server device <channel.device>. Could not set message alive time. 64
Failed to connect Fanuc Focas server device <channel.device>. Could not set message retries. 64
Failed to connect Fanuc Focas server device <channel.device>. Could not set message timeout. 65
Failed to connect Fanuc Focas server device <channel.device>. Could not set messaging parameters.
FWLIB data error <code>. 65
Failed to connect Fanuc Focas server device <channel.device>. Could not set messaging parameters.
FWLIB error: <code>. 66
Failed to connect Fanuc Focas server device <channel.device>. Could not set number of data areas. 66
Failed to connect Fanuc Focas server device <channel.device>. Could not set request timeout. FWLIB
error <code>. 67
Failed to connect Fanuc Focas server device <channel.device>. Could not set transmission control PMC
type. 67
Failed to connect Fanuc Focas server device <channel.device>. Could not set transmission control start
address. 67
Failed to connect Fanuc Focas server device <channel.device>. Could not start messaging session. FWLIB
error <code>. 68
Fanuc Focas Server Device Driver Error Messages 59
Float 23
Focas1 Data Window Library Error Codes 71

www. ptc.com
77 Fan u c Focas Eth ern et Driver

General 12

ID 12
Identification 9, 12
Initial Updates from Cache 14
Install a Focas Library 6
Installed version of Focas Data Window Library does not support unsolicited communication. Device
<device> deactivated. 68
Inter-Device Delay 11
Inter-Request Delay 15
Invalid XML document. Reason: Error loading Unsolicited Data Areas for device <device-name>. End
address can not be less than start address for area <area-number>. 57
Invalid XML document. Reason: Error loading Unsolicited Data Areas for device <device-name>. Invalid
area order or duplicate area number. 57
Invalid XML document. Reason: Error loading Unsolicited Data Areas for device <device-name>. Max-
imum size of area <area-number> is <size bytes>. 58

Long 23

Missing address. 54
Model 12

Name 12
Network 8
Network Adapter 10
Non-Normalized Float Handling 11

www. ptc.com
Fanuc Focas Ethernet Driver 78

Open 36
Operating Mode 13
Optimization Method 10
Optimizing Fanuc Focas Ethernet Communications 22
Overview 5

Parameter Read Values 46


Path Values 47
PMC Memory 19
pmc_rdpmcrng 73
pmc_wrpmcrng 73
Power Mate i 34
Program Name 50
Program Values 50

Read Alarm Messages 52


Read Axis Data Values 48
Read Dynamic2 Data Values 51
Read error occurred for address starting at <address> on device <channel.device>. FWLIB error:
<code>. 58
Read Timer Data Values 52
Received CNC power down notification from unsolicited message server. Reconnecting Fanuc Focas
server devices. 69
Received CNC power up notification from unsolicited message server. 69
Received socket error notification from unsolicited message server. 69
Received unsolicited message server shutdown notification. 70
Redundancy 18
Replace with Zero 11
REQ 20
Request Timeout 15
RES 20
RES_CODE 20
Respect Tag-Specified Scan Rate 14

www. ptc.com
79 Fan u c Focas Eth ern et Driver

Scan Mode 14
Series 15i 24
Series 16i 26
Series 18i 29
Series 21i 31
Setup 8
Short 23
Simulated 13
Status Info Tags 39
System Info Tags 39

Tag Counts 9, 13
Timeouts to Demote 16
Timing 14
Tool Offset Tags 43

Unable to start the Fanuc Focas Ethernet Data Window Library services. 58
Unable to write tag <address> on device <device name>. 55
Unmodified 11
Unsolicited Data Areas 17
Unsolicited message server does not seem to be running. Attempting to launch. 70
Unsolicited Messaging 19
Unsolicited Transfer Control 16

Word 23
Workpiece Zero Offset Tags 45
Write All Values for All Tags 10
Write error occurred for address <address> on device <channel.device>. FWLIB error <code>. 59
Write Only Latest Value for All Tags 11
Write Only Latest Value for Non-Boolean Tags 10

www. ptc.com

You might also like