Torque Tool Ethernet Driver

© 2020 PTC Inc. All Rights Reserved.

Torque Tool Ethernet Driver 2

Table of Contents
Torque Tool Ethernet Driver 1

Table of Contents 2

Torque Tool Ethernet Driver 4

Overview 4

Setup 4
Channel Properties — General 5
Channel Properties — Ethernet Communications 6
Channel Properties — Write Optimizations 6
Channel Properties — Advanced 7
Device Properties — General 8
Operating Mode 9
Device Properties — Scan Mode 9
Device Properties — Timing 10
Device Properties — Communications Parameters 11
Device Properties — Settings 12
Device Properties — Redundancy 13

Optimizing Communications 14

Data Types Description 15

Address Descriptions 15

Message IDs 16

Command Set: Alarm 18

Command Set: Auto-Disable Settings 19

Command Set: Communication 20

Command Set: Flash 21

Command Set: Identifiers 21

Command Set: IO Interface 22

Command Set: Job Info 23

Command Set: Job Data 24

Command Set: Job Number Data 26

Command Set: Last Tightening Results 26

Command Set: Multi-Spindle Results 31

Command Set: Old Tightening Results 32

Command Set: Operation Result 36

Command Set: Parameter Set Data 37

Command Set: Parameter Set Numbers 38

www. ptc.com
3 Torq u e Tool Eth ern et Driver

Command Set: Parameter Set Selected 38

Command Set: Program Messages 39

Command Set: Selector Messages 40

Command Set: Time 41

Command Set: Tool Data 41

Command Set: VIN 43

Event Log M essages 44

Error Descriptions 44
Address <address> is out of range for the specified device or register. 45
Array size is out of range for address <address>. 45
Array support is not available for the specified address: <address>. 45
Data type <type> is not valid for device address <address>. 45
Device address <address> contains a syntax error. 45
Device address <address> is read only. 46
Unable to bind to adapter: <adapter name>. Connect failed. 46
Winsock initialization failed (OS error = <error>). 46
Winsock shut down failed (OS error = <error>). 46
Winsock V1.1 or higher must be installed to use the driver. 47
Device <device name> failed to connect. 47
Device <device name> is not responding. 47
Unable to read tag <tag name>: Device <device name> encountered a parsing error. 48
Unable to read tag <tag name>: Device <device name> received an error response (Error <error
code>). 48
Unable to read unsolicited packed data group: Device <device name> received an error response
(Error <error code>). 48
Unable to write tag <tag name>: Device <device name> encountered a parsing error. 49
Unable to write tag <tag name>: Device <device name> received an error response (Error <error
code>). 49
Unable to write tag <tag name>: Device <device name> received invalid data for write. 49
Unable to write to <address> on device <device name>. 50
Error Codes 50

Appendix — Tightening Program Read/ Write 52

Index 54

www. ptc.com
4 Torq u e Tool Eth ern et Driver

Torque Tool Et hernet Driver

Help version 1.067

CONTENTS

Overview
What is the Torque Tool 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 driver?

Dat a Types Descript ion

What data types does the Torque Tool Ethernet Driver support?

Address Descript ions

How do I reference a data location in a Torque Tool Ethernet device?

Error Descript ions

What error messages does the Torque Tool Ethernet Driver produce?

Overview
The Torque Tool Ethernet Driver provides a reliable way to connect Torque Tool Ethernet devices to OPC Cli-
ent applications; including HMI, SCADA, Historian, MES, ERP, and countless custom applications. It is inten-
ded to work with all devices supporting the Torque Tool Open Protocol.

Set up
Supported Devices
The Torque Tool Ethernet Driver is designed to work with any device that supports the Torque Tool Open Pro-
tocol. The driver has been tested with the Stanley QA Alpha Controller and the Atlas Copco Power Focus.

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 1024 per channel.

www. ptc.com
Torque Tool Ethernet Driver 5

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. With this in mind, changes to the properties
should not be made once a large client application has been developed. Utilize proper user role and priv-
ilege 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.

www. ptc.com
6 Torq u e Tool Eth ern et Driver

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

As with any server, writing data to the device may be the application's most important aspect. The server
intends to ensure that the data written from the client application gets to the device on time. Given this goal,
the server provides optimization properties that can be used to meet specific needs or improve application
responsiveness.

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
the operation of HMI data without causing problems with Boolean operations, such as a momentary
push button.

www. ptc.com
Torque Tool Ethernet Driver 7

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 not available 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
8 Torq u e Tool Eth ern et Driver

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
depends 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
Torque Tool Ethernet Driver 9

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.

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.

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

www. ptc.com
10 Torq u e Tool Eth ern et Driver

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 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.
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

www. ptc.com
Torque Tool Ethernet Driver 11

typically 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 — Com m unicat ions Param et ers

Ethernet Parameters

Port N um ber: Specify the port number that the driver will use when connecting to the device. The valid
range is 0 to 65535. For Open Protocol, the default setting is 4545. For FEP, the default setting is 9001.

Set Error State for All DN Rs: When enabled, the driver will set the error state if the device does not
respond (DNR) to writes or subscription requests. The driver will always set the error state if the device does
not respond to reads. The default setting is disabled.

Keep-Alive Parameters

Poll Tim e: Specify the amount of time of inactivity before the driver will send a Keep Alive message to the
device. The valid range is 1 to 15 seconds. The default setting is 10 seconds.
Caution: If the Keep Alive interval is set to a value greater than 10 seconds, the driver may post "Device
Not Responding" messages to the Event Log. This is because the device closes the connection.

Reply Tim eout: Specify the amount of time that the driver will wait for a response from a Keep Alive mes-
sage. The valid range is 100 to 30000 milliseconds. The default setting is 1000 milliseconds (1 second).

Fail After: Specify the number of times that the driver will attempt to send a Keep Alive message before con-
sidering it to have failed. The valid range is 1 to 10. The default setting is 3.

www. ptc.com
12 Torq u e Tool Eth ern et Driver

Device Propert ies — Set t ings

The Settings properties are used to request different revisions of messages from the device. To request a
specific message revision, enter the message revision number for that message. If the device does not sup-
port revisions, enter 0.

N ote: The FEP model does not support message revisions, and will disable these options.

M essage Revisions

Alarm : Specify the revision number for alarm messages. Supported values are 0 to 3, with 0 as the default.
This affects MIDs 0070 through 0078.

Com m unication: Specify the revision number for communication messages. Supported values are 0 to 6,
with 0 as the default. This affects MIDs 0001 and 0002.

Job Data: Specify the revision number for job data messages. Supported values are 0 to 3, with 0 as the
default. This affects MIDs 0032 and 0033.

Job Info: Specify the revision number for job info messages. Supported values are 0 to 4, with 0 as the
default. This affects MIDs 0034 through 0037.

Job State: Specify the revision number for job ID upload, job select, and job restart messages. Supported val-
ues are 0 to 2, with 0 as the default. This affects MIDs 0030, 0031, 0038, and 0039.

Last Tightening: Specify the revision number for the last tightening results messages. Supported values
are 0 to 5 and 999 (for low-bandwidth version), with 0 as the default. This affects MIDs 0060 through 0063.

Old Tightening: Specify the revision number for the old tightening results messages. Supported values are
0 to 7, with 0 as the default. This affects MIDs 0064 and 0065.

Selector Lights: Specify the revision number for the selector control light messages. Supported values are 0
to 2, with 0 as the default. This affects MIDs 0254 and 0255.

Tool Data: Specify the revision number for the tool data results messages. Supported values are 0 to 5, with
0 as the default. This affects MIDs 0040 and 0041.

www. ptc.com
Torque Tool Ethernet Driver 13

VIN : Specify the revision number for the vehicle identification number (VIN) messages. Supported values are
0 to 2, with 0 as the default. This affects MIDs 0051 through 0054.

Options

Disable Tool On LTR: When enabled, the driver will disable the tool whenever a last tightening results (LTR)
message is received. This ensures that no LTR data is overwritten before the system has had time to pro-
cess it. The default setting is disabled.

Revision Form at: Specify how the driver should format the revision number for commands that use the
default revision (revision 0). By default, when the driver sends a revision 0 message it leaves the revision
number blank. Some devices do not support this and require the revision number to be explicitly set. Setting
this to Zero or One forces the driver to use 0 or 1 for the revision number in the message.

Use Generic Subscribe: Newer devices may only support subscribing using the Generic Subscribe MID 8.
Enabling this property changes the driver to use MID 8 when subscribing data updates.

Use Unsolicited Data Packing: Specify if the driver should update all tags for a given command set at once
or update those tags individually at their specified scan rate.

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
14 Torq u e Tool Eth ern et Driver

Opt im izing Com m unicat ions

The Torque Tool 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 Torque Tool 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 Torque Tool controller from which data will be collected. While this approach to defining the applic-
ation will provide a high level of performance, it won't take full advantage of the Torque Tool 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 Torque Tool Ethernet Driver could only define one single channel, the example shown above would be
the only option available; however, the driver can define up to 256 channels. Using multiple channels dis-
tributes 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 performance
is shown below.

Each device has now been 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 256 or fewer devices, it can be optimized exactly how
it is shown here.
The performance will improve even if the application has more devices. While
fewer devices may be ideal, the application will still benefit from additional chan-
nels. Although by spreading the device load across all channels will cause the
server to move from device to device again, it can now do so with far less devices
to process on a single channel.

N ote: Some devices support only one Ethernet connection. For these devices, only one channel and device
should be configured.

www. ptc.com
Torque Tool Ethernet Driver 15

Dat a Types Descript ion

The Torque Tool Ethernet Driver supports the following data types.

Dat a Type Descript ion

Boolean Single bit
Word Unsigned 16-bit integer
Short* Signed 16-bit integer
DWord Unsigned 32-bit integer
Long* Signed 32-bit integer
String ASCII text string
Float 32-bit floating point value
Date* 64 bit date and time value
Double* 64-bit floating point value

* These types are not used natively, but are supported through conversion.

N ote: All non-variable tags used in the driver have a fixed data type. Therefore, it is recommended that
users allow the driver to use the default data type for the point.

Address Descript ions

The Torque Tool Ethernet Driver specifies addresses by the name of the item that will be addressed. It may
be optionally followed by a bit or index number. The syntax is ITEMNAME<.BIT/INDEX>, where:

l ITEMN AME: The name of the item that will be addressed.

l BIT/ IN DEX: The bit number for items using bit fields, or index for arrayed items. The bit/index is only
used for certain address items.

Im portant: Bits are 0-based, with 0 being the LSB. Array indices are 1-based, with 1 being the first item.

Unsolicited Data
Some of the command sets are sent unsolicited by the device. These command sets will not have data avail-
able until the device sends the data to the driver. All unsolicited command sets have a NEWDATA item,
which will be set to 1 when new data arrives. Users may then clear this flag back to 0 by writing any value to
it.

M essage Revisions
Some commands have multiple message revisions which hardware may support. Some items are only avail-
able for certain message revisions. These items have been marked as being available in a certain message
revision. For example, an item marked with (Rev 2) is only available in message revision 2 or later. Some
messages also have a low-bandwidth version available and will be marked appropriately.

Variable Data
Instead of adding revisions to allow for more information to be sent, the Open Protocol specification sup-
ports Variable Data fields. These are dynamic results where any number of values are returned. Each Vari-
able Data field contains the information needed to describe that piece of data and can be uniquely identified
by specifying the Message ID (MID), the Parameter ID (PID), and the Step number. To allow access to these
values, the format of the tag addresses needs to be “MID”.”PID”.”Step”.Unit; where Step and Unit are
optional. If Unit is specified, the Unit value is returned as a numeric value that corresponds to different unit

www. ptc.com
16 Torq u e Tool Eth ern et Driver

types (as defined in the Open Protocol specification). For example, to get the Final Torque on a MT Focus
6000, the tag address might be ‘1202.30237’. To get the units of that value, use this tag address:
‘1202.30237.Unit’. There are common PID values and there are PID values that are specific to the device.
Refer to the Open Protocol specification and the device specific specification for more information.

Protocols
The Torque Tool Ethernet Driver supports the Open Protocol model and the Ford Ethernet Protocol (FEP)
model. Each protocol supports a set of commands that have one or more items available for addressing. Not
all command sets are supported for each model. For more information, select a link from the list below.

Alarm
Aut o-Disable Set t ings
Flash
Ident ifiers
Job Info
Job N umber Dat a
Job Dat a
Last Tight ening Result s
M ult i Spindle Result s
Old Tight ening Result s
Operat ion Result
Paramet er Set Dat a
Paramet er Set N umbers
Paramet er Set Select ed
Select or M essages
Time
Tool Dat a
VIN

M essage IDs
For more information on the Message IDs (MIDs) supported by each device model, refer to the table below.

M essage ID Descript ion Support ed M odels

0001 Start communication Open, FEP
0002 Start communication acknowledge Open, FEP
0003 Stop communication Open, FEP
0004 Command error Open, FEP
0005 Command accepted Open, FEP
0008 Generic Subscription Open
0010 Pset number upload request Open, FEP
0011 Pset number upload reply Open, FEP
0012 Pset data upload request Open, FEP
0013 Pset data upload reply Open, FEP
0014 Pset selected subscribe Open, FEP

www. ptc.com
Torque Tool Ethernet Driver 17

M essage ID Descript ion Support ed M odels

0015 Pset selected telegram Open, FEP
0016 Pset selected telegram acknowledge Open, FEP
0017 Pset selected unsubscribe Open, FEP
0018 Selected Pset Open, FEP
0019 Set Pset batch size Open, FEP
0020 Reset Pset batch size Open, FEP
0030 Job numbers upload request Open, FEP
0031 Job numbers upload reply Open, FEP
0032 Job data upload request Open
0033 Job data upload response Open
0034 Job selected/info subscribe Open, FEP
0035 Job selected/info Open, FEP
0036 Job selected/info acknowledge Open, FEP
0037 Job selected/info unsubscribe Open, FEP
0038 Job selected in PF3000 Open, FEP
0039 Job restart Open, FEP
0040 Tool data upload request Open, FEP
0041 Tool data upload reply Open, FEP
0042 Disable tool Open, FEP
0043 Enable tool Open, FEP
0050 VIN download request Open, FEP
0051 VIN upload subscribe Open, FEP
0052 VIN number upload Open, FEP*
0053 VIN upload acknowledge Open, FEP
0054 VIN upload subscribe Open, FEP
0060 Last Tightening Result (LTR) subscribe Open, FEP
0061 LTR upload Open, FEP*
0062 LTR upload acknowledge Open, FEP
0063 LTR unsubscribe Open, FEP
0064 Old Tightening Results (OTR) upload request Open, FEP
0065 OTR upload reply Open, FEP*
0070 Alarm subscribe Open, FEP
0071 Alarm upload reply Open, FEP
0072 Alarm upload acknowledge Open, FEP
0073 Alarm unsubscribe Open, FEP
0074 Alarm acknowledge on Torque controller Open, FEP
0075 Alarm acknowledge on Torque controller acknowledge Open, FEP
0076 Alarm status Open, FEP
0077 Alarm status acknowledge Open, FEP

www. ptc.com
18 Torq u e Tool Eth ern et Driver

M essage ID Descript ion Support ed M odels

0080 Time upload request Open, FEP
0081 Time upload Open, FEP
0082 Set time in torque controller Open, FEP
0100 Multi-spindle result subscribe Open, FEP
0101 Multi-spindle result upload Open, FEP* *
0102 Multi-spindle result upload acknowledge Open, FEP
0103 Multi-spindle result unsubscribe Open, FEP
0113 Flash green light tool Open, FEP
0127 Job Cancel Open, FEP
0128 Batch increment Open
0200 Set external controlled relays Open
0210 Status externally monitored inputs subscribe Open
0211 Status externally monitored inputs upload Open
0212 Status externally monitored inputs upload acknowledge. Open
0213 Status externally monitored inputs unsubscribe Open
0216 Relay function subscribe Open
0217 Relay function data Open
0218 Relay function acknowledge Open
0219 Relay function unsubscribe Open
0224 Set digital input function Open
0225 Reset digital input function Open
0254 Selector control green lights Open
0255 Selector control red lights Open
0400 Auto/man mode subscribe FEP
0401 Auto/man mode upload FEP
0402 Auto/man mode acknowledge FEP
0403 Auto/man mode unsubscribe FEP
0410 Auto disable setting request FEP
0411 Auto disable setting reply FEP
1201 Operation result overall data Open
1202 Operation result object data Open
2500 Tightening program message download Open
2501 Tightening program message upload Open
0999 Keep alive Open, FEP

* Only supports MID Revision 1 as indicated in Revision 4.62 of the FEP specification.
* * Unlike Open protocol, FEP does not use batch size, batch counter, and batch status parameters.

Com m and Set : Alarm

The Alarm command set is used to receive alarm data. All items belonging to this command set use MID 70
(Alarm subscribe) for the subscription request. The device sends the data through MID 71 and MID 76, which

www. ptc.com
Torque Tool Ethernet Driver 19

are acknowledged with MID 72 and MID 77, respectively.

It em Dat a Access Descript ion Dat a

Type Range
0 if no alarm is active, 1 if an alarm is cur-
ALARM_STATUS Boolean Read Only 0-1
rently active*
ALARM_ERROR String Read Only Error code 4 characters,
5 characters
(Rev 2)
ALARM_C_READY Boolean Read Only Controller ready status: 0-1
1 = OK
0 = NOK
ALARM_T_READY Boolean Read Only Tool ready status: 0-1
1 = OK
0 = NOK
ALARM_TIME String Read Only Timestamp 19 char-
acters
ALARM_NEWDATA Boolean Read/Write New data flag. Set to 1 when new data 0-1
arrives. Write a 0 to this flag to clear it.
ALARM_T_HEALTH Word, Read Only (Rev 3) Reports the tool status: 0-2
Short 0 = Not Applicable
1 = OK
2 = NOK
ALARM_TEXT String Read Only (Rev 3) The text assigned to the alarm. 50 char-
acters

* The ALARM_STATUS flag is valid on an initial connection to the device. Any subsequent alarm messages
after the initial update set the quality of the tag to "Bad" because the status is no longer provided by the
device.

Com m and Set : Aut o-Disable Set t ings

The Auto-Disable Settings command set is only supported by the FEP model.

It em Dat a Access Descript ion Dat a

Type Range
Auto-Disable setting. AD_SETTING and AD_BATCH data is
AD_ Word, retrieved using MID 410 (AutoDisable settings request) for
Read Only 0-99
SETTING Short the request, which is replied to with MID 411 (AutoDisable
settings reply)
AD_ Word, Read Only Current batch 0-99
BATCH Short
AM_ Boolean Read Only Automatic/Manual mode. AM_MODE uses MID 400 (Auto- 2-10
MODE matic/Manual mode subscribe) for the subscription request.
The device sends the data through MID 401(Auto-
matic/Manual mode), which is replied to by MID 402 (Auto-
matic/Manual mode acknowledge).

www. ptc.com
20 Torq u e Tool Eth ern et Driver

It em Dat a Access Descript ion Dat a

Type Range

0 = Automatic Mode
1 = Manual Mode
AM_ Boolean Read/Write New data flag. Set to 1 when new data arrives. Write a 0 to 0-1
NEWDATA this flag to clear it.

Com m and Set : Com m unicat ion

The Communication command set is used to get information about the controller.

It em Dat a Type Access Descript ion Dat a

Range
COMM_CELL_ID Word, Short Read The cell ID of the controller 0-9999
Only
COMM_ Word, Short Read The channel ID of the controller 0-20
CHANNEL_ID Only
COMM_CLIENT_ Word, Short Read (Rev 2) The client ID 0-9
ID Only
COMM_ String Read The name of the controller 25 char-
CONTROL_NAME Only acters
COMM_ String Read (Rev 4) The serial number of the controller 10 char-
CONTROL_SER_ Only acters
NUM
COMM_ String Read (Rev 3) The controller software version 19 char-
CONTROL_SOFT_ Only acters
VER
COMM_LINK_ Word, Short Read (Rev 6) Specifies that linking handling is 1
SUPPORT Only supported if 1
COMM_ String Read (Rev 3) The Open Protocol version sup- 19 char-
PROTOCOL_ Only ported by the controller's current firm- acters
VERSION ware
COMM_RBU_ String Read (Rev 4) The rapid backup unit (RBU) type 24 char-
TYPE Only acters
COMM_SEO_ Word, Short Read (Rev 6) Specifies that sequence number 1
NUM_SUPPORT Only handling is supported if 1
COMM_ DWord, Long Read (Rev 6) The station ID or cell ID of the con- 0-
STATION_ID Only troller 4294967295
COMM_ String Read (Rev 6) The station name of cell name of 25 char-
STATION_NAME Only the controller acters
COMM_ String Read (Rev 2) The 3-character supplier code for 3 characters
SUPPLIER_CODE Only the controller
COMM_SYS_ Word, Short Read (Rev 5) The system subtype of the con- 0-2
SUBTYPE Only troller

www. ptc.com
Torque Tool Ethernet Driver 21

It em Dat a Type Access Descript ion Dat a

Range
COMM_SYS_ Word, Short Read (Rev 5) The system type of the controller: 0-999
TYPE Only 0 = System type not set
1 = Power Focus 4000
2 = Power MACS 4000
3 = Power Focus 6000
COMM_TOOL_ String Read (Rev 3) The tool software version 19 char-
SOFT_VER Only acters

Com m and Set : Flash

The Flash command set is used to cause the tool's green light to flash.

It em Dat a Access Descript ion Dat a

Type Range
FLASH Boolean Write Write any value to this item to cause the green light on the tool to N/A
Only flash until an operator pushes the tool trigger. FLASH uses MID 113
(Flash green light on tool).

Com m and Set : Ident ifiers

The Identifiers command set is used to manage the multiple identifiers in the controller. It is only supported
by the Open Protocol model. All tags prefixed by MID_ are subscription based and use MID 151 (Multiple
identifiers work order subscribe) for the subscription request. The device sends the item data to the server
through MID 152 (Multiple Identifiers work order), which the server responds to with MID 153 (Multiple Iden-
tifiers work order acknowledge).

It em Dat a Access Descript ion Dat a

Type Range
ID_ String Write Only Write the identifiers to this item to send the identifiers to 100 char-
DOWNLOAD the controller. ID_DOWNLOAD uses MID 150 (Identifier acters
download request) to send the identifier that was written
to the item to the controller.
ID_BYPASS Boolean Write Only Write any value to this item to bypass the next identifier N/A
expected in the work order. ID_BYPASS uses MID 155
(Bypass Identifier) to bypass the next identifier expected
in the work order.
ID_RESET Boolean Write Only Write any value to this item to reset the latest identifier or N/A
bypassed identifier in the work order. ID_RESET uses MID
156 (Reset latest Identifier) to reset the latest identifier or
bypassed identifier in the work order.
ID_ Boolean Write Only Write any value to this item to reset all identifiers in the N/A
RESETALL work order. ID_RESETALL uses MID 157 (Reset all Iden-
tifiers) to reset all identifiers in the current work order.
MID_TYPE Word, Read Only Identifier type number* 1-4
Short

www. ptc.com
22 Torq u e Tool Eth ern et Driver

It em Dat a Access Descript ion Dat a

Type Range
MID_IN_ Boolean Read Only Included in work order* 0-1
ORDER
0 = No
1 = Yes
MID_ Word, Read Only Status in work order* 0-3
STATUS Short
0 = Not accepted
1 = Accepted
2 = Bypassed
3 = Reset
MID_ID String Read Only Identifier* 25 char-
acters
MID_ Boolean Read/Write New data flag. Set to 1 when new data arrives. Write a 0 N/A
NEWDATA to this flag to clear it.

* These items require an array index (1..4).

Com m and Set : IO Int erface

The IO Interface command set is used to control external IO devices connected to the Torque Tool device.

It em Dat a Access Descript ion Dat a

Type Range
RESET_ Word, Write Resets the digital input function with the entered digital input 0-999
DIGITAL_ Short Only value using MID 225. These values are device specific. Refer
INPUT to the device documentation for more information.
RELAY_ Word, Read Allows the user to get relay information for the first 500 (0- 0, 1
FUNCTION.# Short Only 499) functions defined on the controller. Refer to the con-
troller documentation to determine which relay number cor-
responds to what relay function. Values received will be:
0 = Not Active
1 = Active
N ote: The server only supports relays that are Tracking
Events; events where the value changes based on a con-
dition.
SET_ Word, Write Sets the digital input function with the entered digital input 0-999
DIGITAL_ Short Only value using MID 224. These values are device specific. Refer
INPUT to the device documentation for more information.
STATUS_ Word, Write Set "external controlled" relays 0-3
RELAY_# Short Only Write to this item to set the status of the corresponding
external relay number. All other relays will be sent a '3'.
0 = Off
1 = On (fast)
2 = Flashing
3 = Keep the same results
STATUS_RELAY_# tags use MID 200 (Set externally controlled

www. ptc.com
Torque Tool Ethernet Driver 23

It em Dat a Access Descript ion Dat a

Type Range
relays) to set individual relay statuses.
STATUS_ Boolean Read Get "external controlled" digital input statuses 0, 1
DIGIN_# Only This item uses an unsolicited command set to get the current
status of all digital inputs whenever one of them change. The
valid DigIn range is 1-8.
0 = Off
1 = On
STATUS_DIGIN_# tags use MID 210 (Status externally mon-
itored inputs subscribe) to subscribe to individual digital input
statuses, the data is sent from the device to the server using
MID 211 (Status externally monitored inputs).

Com m and Set : Job Info

The Job Info command set is used to receive data on the selected job, to allow the user to select a different
job, and to control job execution.

JOB_JOBNUM uses MID 38 (Select Job) to set the current job, JOB_RESTART uses MID 39 (Job restart) to
restart a job, JOB_ABORT uses MID 127 (Abort job) to abort the current job. All other tags use MID 34 (Job
info subscribe) to subscribe to job info. The device sends job info to the server using MID 35 (Job info), which
is responded to with MID 36 (Job info acknowledge). If the device supports 4-digit Job IDs, revision 2 or higher
must be used.

N ote: Some command set items also have alias names. In the table below, the alias name will be listed
beneath the item where applicable.

It em Dat a Access Descript ion Dat a

Type Range
JOB_JOBNUM Word, Read/Write The selected job number. To select a different 0-99 (Rev 1)
LINK_LINKNUM Short job, write a job number to this item. 0-9999 (Rev
2+)
JOB_STATUS* Word, Read Only Job batch status 0-2
LINK_STATUS* Short 0 = Job batch not completed
1 = Job batch OK
2 = Job batch NOK
JOB_BMODE* Word, Read Only Job batch mode 0-1
LINK_BMODE* Short 0 = Only the OK bolts are counted
1 = Both the OK and the NOK bolts are counted
JOB_BSIZE* Word, Read Only Job batch size 0-9999
LINK_BSIZE* Short
JOB_BCOUNT* Word, Read Only Job batch counter 0-9999
LINK_BCOUNT* Short
JOB_TIME* String Read Only Timestamp for the job info 19 char-
LINK_TIME* acters
JOB_STEP* Word, Read Only The current step the job is on. 0-999 (Rev 3

www. ptc.com
24 Torq u e Tool Eth ern et Driver

It em Dat a Access Descript ion Dat a

Type Range
Short and 4* * )
JOB_SCOUNT* Word, Read Only The number of steps in the job. 0-999 (Rev 3
Short and 4* * )
JOB_STYPE* Word, Read Only The step type 0-99 (Rev 3
Short 1 = Batch Step and 4* * )
2-6 = Reserved
JOB_TSTATUS* Word, Read Only The status of the job tightening: 0-10 (Rev 4)
Short 0 = JobTight OFF
1 = JobTight OK
2 = JobTight NOK
3 = JobTight Aborted
4 = JobTight Incremented
5 = JobTight Decremented
6 = JobTight Bypassed
7 = JobTight Reset Batch
8 = JobTight Loosening
9 = JobTight Free Batch
10 = JobTight Job Aborted
JOB_NEWDATA Boolean Read/Write New data flag. Set to 1 when new data arrives. 0-1
LINK_NEWDATA Write a 0 to this flag to clear it.
JOB_RESTART Word, Write Only Write a job number to this item to restart that job 0-99 (Rev 1)
LINK_RESTART Short 0-9999 (Rev
2)
JOB_ABORT Boolean Write Only Write any value to this item to abort the current N/A
LINK_ABORT job
JOB_BATCH_ Boolean Write Only Write any value to this item to increment the N/A
INCREMENT* batch number
* This item is only supported by the Open Protocol model.
* * This tag may not be valid for some devices when using revision 4.
Consult device documentation for supported MIDs and data fields.

Com m and Set : Job Dat a

The Job Data command set is used to request the configuration of a specific job. To request a job, write the
Job ID to JOBDATA_JOBID. All items belonging to this comment set use MID 32 (Job Data Upload Request) to
request the data, which is replied to with MID 33 (Job Data Upload Reply). If the device supports 4 digits Job
IDs, revision 2 or higher must be used.

It em Dat a Access Descript ion Dat a

Type Range
JOBDATA_JOBID Word, Read/Write Write a Job ID to this item to request 0-9999
Short the job’s configuration
JOBDATA_NAME String Read Only The name of job 25 char-
acters
JOBDATA_FORCED_ORDER Word, Read Only Forced Order 0-2

www. ptc.com
Torque Tool Ethernet Driver 25

It em Dat a Access Descript ion Dat a

Type Range
Short 0 = Free Order
1 = Forced Order
2 = Free and Forced
JOBDATA_MAX_FIRST_ Word, Read Only Maximum time for first tightening 0-9999
TIGHTENING_TIME Short
JOBDATA_MAX_ DWord, Read Only Maximum time to complete the job 0-99999
COMPLETION_TIME Long
JOBDATA_BATCH_MODE Word, Read Only Job batch mode/batch count type 0-1
Short 0 = Only the OK tightenings are coun-
ted
1 = Both OK and NOK tightenings are
counted
JOBDATA_LOCK_ON_DONE Boolean Read Only Lock at Job done True/False
True = Yes
False = No
JOBDATA_LINE_CONTROL Boolean Read Only Use line control True/False
True = Yes
False = No
JOBDATA_REPEAT_JOB Boolean Read Only Repeat Job True/False
True = Yes
False = No
JOBDATA_TOOL_ Word, Read Only Tool loosening 0-2
LOOSENING Short 0 = Enable
1 = Disable
2 = Enable only on NOK tightening
JOBDATA_TOOL_RESERVED Word, Read Only Reserved for Job repair 0-1
Short
JOBDATA_PARAMETER_ Word, Read Only The parameter’s Channel ID 0-99
CHANNEL_ID Short*
JOBDATA_PARAMETER_ Word, Read Only The parameter’s Type ID 0-999
TYPE_ID Short*
JOBDATA_PARAMETER_ Boolean* Read Only The parameter’s Auto Value True/False
AUTO_VALUE
JOBDATA_PARAMETER_ Word, Read Only The parameter’s batch size 0-99
BATCH_SIZE Short*
JOBDATA_PARAMETER_ Word, Read Only The number of parameters in the job 0-99 (Rev 3)
COUNT Short
JOBDATA_PARAMETER_ Word, Read Only The parameter’s socket number 0-99 (Rev 3)
SOCKET Short*
JOBDATA_PARAMETER_ String* Read Only The parameter’s step name 25 char-
STEP_NAME acters (Rev
3)
JOBDATA_PARAMETER_ Word, Read Only The parameter’s step type 0-99 (Rev 3)
STEP_TYPE Short*

www. ptc.com
26 Torq u e Tool Eth ern et Driver

* This item requires an array index or bit index. The valid array / bit index range is 1 to 99.

Com m and Set : Job Num ber Dat a

The Job Number Data command set is used to request generic job data on the controller. Some command
set items also have alias names. In the table below, the alias name will be listed beneath the item where
applicable. All items belonging to this command set use MID 30 (Job ID upload request) for requesting the
item data, which is replied to with MID 31 (Job ID upload reply). If the device supports 4-digit Job IDs, revision
2 or higher must be used.

It em Dat a Access Descript ion Dat a

Type Range
JOBN_ Word, Read Count of the number of valid jobs 0-99 (Rev
COUNT Short Only 1)
LINKN_ 0-9999
COUNT (Rev 2)
JOBN_ID Word, Read Valid job numbers (the number available is specified by 0-99 (Rev
LINKN_ID Short* Only JOBN_COUNT) 1)
0-9999
(Rev 2)

* This item requires an array index or bit index. The valid array / bit index range is 1 to 9999.

Com m and Set : Last Tight ening Result s

The Last Tightening Results command set is used to receive data for the last tightening. All items belonging
to this command set use MID 60 (Last tightening result data subscribe) for the subscription request. The
device sends the data through MID 61 (Last tightening result data), which is replied to by MID 62 (Multi-
spindle result acknowledge).

It em Dat a Access Descript ion Dat a Range

Type
LTR_CELL_ID Word, Read Only Cell ID 0-9999
Short
LTR_CHAN_ID Word, Read Only Channel ID 0-99
Short
LTR_TC_ String Read Only Torque controller name 25 characters
NAME
LTR_VIN String Read Only Vehicle ID number* 25 characters
LTR_JOB Word, Read Only Job number* 0-99 (Rev 1)
Short 0-9999
(Rev 2+)
LTR_PSET Word, Read Only PSet number* 0-999
Short
LTR_BATCH_ Word, Read Only Batch size* 0-9999
SIZE Short
LTR_BATCH_ Word, Read Only Batch counter* 0-9999
COUNTER Short

www. ptc.com
Torque Tool Ethernet Driver 27

It em Dat a Access Descript ion Dat a Range

Type
LTR_TIGHT_ Word, Read Only Tightening status* 0-1
STATUS Short 0 = NOK
1 = OK
LTR_TORQUE_ Word, Read Only Torque status* 0-2
STATUS Short 0 = Low
1 = OK
2 = High
LTR_ANGLE_ Word, Read Only Angle status* 0-2
STATUS Short 0 = Low
1 = OK
2 = High
LTR_TORQUE_ Float Read Only Torque minimum limit 0-9999.99
MIN
LTR_TORQUE_ Float Read Only Torque maximum limit 0-9999.99
MAX
LTR_TORQUE_ Float Read Only Torque final target 0-9999.99
TARGET
LTR_TORQUE_ Float Read Only Torque value* 0-9999.99
VALUE
LTR_ANGLE_ DWord Read Only Angle minimum value, in degrees 0-99999
MIN
LTR_ANGLE_ DWord Read Only Angle maximum value, in degrees 0-99999
MAX
LTR_ANGLE_ DWord, Read Only Target angle value, in degrees 0-99999
TARGET Long
LTR_ANGLE_ DWord, Read Only Turning angle value, in degrees* 0-99999
VALUE Long
LTR_ String Read Only Timestamp* 19 characters
TIMESTAMP
LTR_ String Read Only Last change in PSet settings* 19 characters
CHANGETIME
LTR_BATCH_ Word, Read Only Batch status* 0-2
STATUS Short 0 = NOK
1 = OK
2 = Batch not used
LTR_ID DWord, Read/Write* * Tightening ID* 0-
Long 4294967295
LTR_ Word, Read Only (Rev 2) Strategy 0-99
STRATEGY Short 1 = Torque control
2 = Torque control / angle monitoring
3 = Torque control / angle control AND
4 = Angle control / torque monitoring
5 = DS control

www. ptc.com
28 Torq u e Tool Eth ern et Driver

It em Dat a Access Descript ion Dat a Range

Type
6 = DS control torque monitoring
7 = Reverse angle
8 = Reverse torque
9 = Click wrench
10 = Rotate spindle forward
11 = Torque control angle control OR
12 = Rotate spindle reverse
99 = No strategy
LTR_STRAT_ Boolean Read Only (Rev 2) Strategy options 0-1
OPT
This item requires a bit number (0-15)
Bit 0 = Torque
Bit 1 = Angle
Bit 2 = Batch
Bit 3 = PVT monitoring
Bit 4 = PVT compensate
Bit 5 = Selftap
Bit 6 = Rundown
Bit 7 = CM
Bit 8 = DS control
Bit 9 = Click wrench
Bit 10 = RBW monitoring
LTR_RDA_ Word, Read Only (Rev 2) Rundown angle status 0-2
STATUS Short 0 = NOK
1 = OK
2 = High
LTR_CMON_ Word, Read Only (Rev 2) Current monitoring status 0-2
STATUS Short 0 = NOK
1 = OK
2 = High
LTR_ST_ Word, Read Only (Rev 2) Selftap status 0-2
STATUS Short 0 = NOK
1 = OK
2 = High
LTR_PTM_ Word, Read Only (Rev 2) Prevail torque monitoring status 0-2
STATUS Short 0 = NOK
1 = OK
2 = High
LTR_PTC_ Word, Read Only (Rev 2) Prevail torque compensate status 0-2
STATUS Short 0 = NOK
1 = OK
2 = High
LTR_PVT Float Read Only (Rev 6) PVT compensation value 0-99999.99
LTR_TERR_ Boolean Read Only (Rev 2) Tightening error status 0-1
STATUS

www. ptc.com
Torque Tool Ethernet Driver 29

It em Dat a Access Descript ion Dat a Range

Type
This item requires a bit number (0-31)
Bit 0 = Rundown angle max shut off
Bit 1 = Rundown angle min shut off
Bit 2 = Torque max shut off
Bit 3 = Angle max shut off
Bit 4 = Selftap torque max. shut off
Bit 5 = Selftap torque min. shut off
Bit 6 = Prevail torque max. shut off
Bit 7 = Prevail torque min. shut off
Bit 8 = Prevail torque compensate overflow
Bit 9 = Current monitoring max shut off
Bit 10 = Post view torque min. torque shut off
Bit 11 = Post view torque max. torque shut off
Bit 12 = Post view torque angle too small
Bit 13 = Trigger lost
Bit 14 = Torque less than target
Bit 15 = Tool hot
Bit 16 = Multistage cancel
Bit 17 = Rehit
Bit 18 = DS measure failed
Bit 19 = Current limit reached
Bit 20 = End time out shutoff
Bit 21 = Remove fastener limit exceeded
Bit 22 = Disable drive
LTR_TERR_ DWord, Read Only (Rev 2) All tightening error status bits are com- 0 to
STATUS_ Long bined in one value. Refer to LTR_TERR_STATUSto 4294967295
COMBINED review the match of each bit and the value. (DWord)
-
2,147,483,648
to
2,147,483,647
(Long)
LTR_TERR_ Boolean Read Only (Rev 6) Tightening error status 2 0-1
STATUS2
This item requires a bit number (0-31)
Bit 0 = Drive deactivated
Bit 1 = Tool stall
Bit 2 = Drive hot
Bit 3 = Gradient monitoring high
Bit 4 = Gradient monitoring low
Bit 5 = Reaction bar failed
Bit 6 - 31 = Reserved
LTR_TERR_ DWord, Read Only (Rev 6) All tightening error status 2 bits are com- 0 to
STATUS2_ Long bined in one value. Refer to LTR_TERR_STATUS2 4294967295
COMBINED to review the match of each bit and the value. (DWord)
-
2,147,483,648

www. ptc.com
30 Torq u e Tool Eth ern et Driver

It em Dat a Access Descript ion Dat a Range

Type
to
2,147,483,647
(Long)
LTR_RDA_MIN DWord, Read Only (Rev 2) Rundown angle minimum value, in 0-99999
Long degrees
LTR_RDA_ DWord, Read Only (Rev 2) Rundown angle maximum value, in 0-99999
MAX Long degrees
LTR_RDA_ DWord, Read Only (Rev 2) Rundown angle value reached, in 0-99999
VALUE Long degrees
LTR_CM_MIN Word, Read Only (Rev 2) Current monitoring minimum limit 0-999
Short
LTR_CM_MAX Word, Read Only (Rev 2) Current monitoring maximum limit 0-999
Short
LTR_CM_ Word, Read Only (Rev 2) Current monitoring value in percent 0-999
VALUE Short
LTR_ST_MIN Float Read Only (Rev 2) Selftap minimum limit 0-9999.99
LTR_ST_MAX Float Read Only (Rev 2) Selftap maximum limit 0-9999.99
LTR_ST_ Float Read Only (Rev 2) Selftap torque. 0-9999.99
TORQUE
LTR_PTM_MIN Float Read Only (Rev 2) Prevail torque monitoring minimum limit 0-9999.99
LTR_PTM_ Float Read Only (Rev 2) Prevail torque monitoring maximum 0-9999.99
MAX limit
LTR_PT Float Read Only (Rev 2) Prevail torque value 0-9999.99
LTR_JOB_SEQ_ Word, Read Only (Rev 2) Job sequence number 0-65535
NUM Short
LTR_STID Word, Read Only (Rev 2) Synch tightening ID 0-65535
Short
LTR_SERIAL_ String Read Only (Rev 2) Tool serial number 14 characters
NUM
LTR_PSET_ String Read Only (Rev 3) Parameter set name 25 characters
NAME
LTR_UNITS Word, Read Only (Rev 3) Torque value units 1-4
Short 1 = Nm
2 = Lbf.ft
3 = Lbf.In
4 = Kpm
LTR_RESULT_ Word, Read Only (Rev 3) Result type 1-7
TYPE Short 1 = Tightening
2 = Loosening
3 = Batch Increment
4 = Batch decrement
5 = Bypass Pset result
6 = Cancel job result

www. ptc.com
Torque Tool Ethernet Driver 31

It em Dat a Access Descript ion Dat a Range

Type
7 = Sync tightening
LTR_IDR2 String Read Only (Rev 4) Identifier result part 2 25 characters
LTR_IDR3 String Read Only (Rev 4) Identifier result part 3 25 characters
LTR_IDR4 String Read Only (Rev 4) Identifier result part 4 25 characters
LTR_ String Read Only (Rev 5) Customer tightening error code 4 characters
CUSTOM_ERR
LTR_ Boolean Read/Write New data flag. Set to 1 when new data arrives. 0-1
NEWDATA Write a 0 to this flag to clear.

* These items are available in the low-bandwidth (revision 999) message.

* * Writing any value to the Tightening ID will set the value in the driver to 0. This will not have any effect on
the hardware.

N ote: Any commands that require special revisions (such as 2, 3, and so forth) are not supported by the
FEP Protocol model.

Com m and Set : M ult i-Spindle Result s

The Multiple Spindle Results command set can be used to receive data that includes tightening results for
tools that have multiple spindles. All items belonging to this command set use MID 100 (Multi-spindle result
subscribe) for the subscription request. The device sends the data through MID 101 (Multi-spindle result),
which is replied to by MID 102 (Last tightening result data acknowledge).

It em Dat a Access Descript ion Dat a

Type Range
Word,
MS_NUMBER Read Only Number of running spindles 2-10
Short
MS_VIN String Read Only Vehicle ID number 25 char-
acters
MS_JOBNUM Word, Read Only Job number (Link Group) 0-99
Short
MS_PSET Word, Read Only Parameter set (App) 0-999
Short
MS_BSIZE* Word, Read Only Batch size 0-9999
Short
MS_ Word, Read Only Batch counter 0-9999
BCOUNT* Short
Batch status
MS_ Word, 0 = NOK
Read Only
BSTATUS* Short 1 = OK
2 = Batch not used
MS_TMIN Float Read Only Torque minimum limit 0-9999.99
MS_TMAX Float Read Only Torque maximum limit 0-9999.99
MS_TTARG Float Read Only Torque final target 0-9999.99

www. ptc.com
32 Torq u e Tool Eth ern et Driver

It em Dat a Access Descript ion Dat a

Type Range
DWord,
MS_AMIN Read Only Angle minimum limit 0-99999
Long
DWord,
MS_AMAX Read Only Angle maximum limit 0-99999
Long
DWord,
MS_ATARG Read Only Angle final target 0-99999
Long
MS_ 19 char-
String Read Only Last change in setting
CHANGETIME acters
19 char-
MS_TIME String Read Only Time stamp
acters
DWord,
MS_SYNCID Read Only Sync tightening ID 0-99999
Long
Overall tightening status
MS_ Word,
Read Only 0 = NOK 0-1
SYNCSTAT Short
1 = OK
Word,
SPD_NUM* * Read Only Spindle number 1-10
Short
Word,
SPD_CHAN* * Read Only Channel ID 1-20
Short
Overall spindle status
SPD_ Word,
Read Only 0 = NOK 0-1
STATUS* * Short
1 = OK
Individual torque status
SPD_ Word,
Read Only 0 = NOK 0-1
TSTATUS* * Short
1 = OK
SPD_
Float Read Only Individual torque 0-9999.99
TORQUE* *
Individual angle status
SPD_ Word,
Read Only 0 = NOK 0-1
ASTATUS* * Short
1 = OK
SPD_ DWord,
Read Only Individual angle 0-99999
ANGLE* * Long
MS_ New data flag. Set to 1 when new data arrives. Write
Boolean Read/Write 0-1
NEWDATA a 0 to this flag to clear it.

* Although this was not supported by the Open protocol, the Torque Tool Ethernet Driver supports this fea-
ture. This feature is supported by prefixing the Address Item with the Spindle number delimited by a ':' (e.g.
01:VIN_VIN). For the Open protocol, the spindle data is ignored.
* * This item requires an array index. The maximum array index is given by MS_Number.

Com m and Set : Old Tight ening Result s

The Old Tightening Results command set is used to retrieve data for an old tightening result. To retrieve the
data for a tightening result, write the Tightening ID to the OTR_ID field. All items belonging to this command

www. ptc.com
Torque Tool Ethernet Driver 33

set use MID 64 (Old tightening result upload request) for requesting the item data, which is replied to with
MID 65 (Old tightening result upload reply).

It em Dat a Type Access Descript ion Dat a Range

OTR_ID DWord, Read/Write Tightening ID. Write the Tightening ID to this 0-
Long item to retrieve data for that tightening. Writ- 4294967295
ing 0 will retrieve the
last tightening results.
OTR_VIN String Read Only Vehicle ID number 25 characters
OTR_PSET Word, Short Read Only PSet number 0-999
OTR_ Word, Short Read Only Batch counter 0-9999
BCOUNT
OTR_ Word, Short Read Only Tightening status 0-1
TIGHTSTAT 0 = NOK
1 = OK
OTR_ Word, Short Read Only Torque Status 0-2
TORQSTAT 0 = Low
1 = OK
2 = High
OTR_ Word, Short Read Only Angle Status 0-2
ANGSTAT 0 = Low
1 = OK
2 = High
OTR_ Float Read Only Torque value 0-9999.99
TORQUE
OTR_ANGLE DWord, Read Only Turning angle value in degrees 0-99999
Long
OTR_TIME String Read Only Timestamp 19 characters
OTR_ Word, Short Read Only Batch status 0-2
BATSTAT 0 = NOK
1 = OK
2 = Batch not used
OTR_ Word, Short Read Only (Rev 2) Job number 0-9999
JOBNUM
OTR_ Word, Short Read Only (Rev 2) Strategy -99
STRATEGY 1 = Torque control
2 = Torque control / angle monitoring
3 = Torque control / angle control AND
4 = Angle control / torque monitoring
5 = DS control
6 = DS control torque monitoring
7 = Reverse angle
8 = Reverse torque
9 = Click wrench
10 = Rotate spindle forward
11 = Torque control angle control OR

www. ptc.com
34 Torq u e Tool Eth ern et Driver

It em Dat a Type Access Descript ion Dat a Range

12 = Rotate spindle reverse
99 = No strategy
OTR_STROPT Boolean Read Only (Rev 2) Strategy options -1

This item requires a bit number (0-15)

Bit 0 = Torque
Bit 1 = Angle
Bit 2 = Batch
Bit 3 = PVT Monitoring
Bit 4 = PVT Compensate
Bit 5 = Selftap
Bit 6 = Rundown
Bit 7 = CM
Bit 8 = DS Control
Bit 9 = Click Wrench
Bit 10 = RBW Monitoring
OTR_BSIZE Word, Short Read Only (Rev 2) Batch size 0-9999
OTR_RASTAT Word, Short Read Only (Rev 2) Rundown angle status 0-2
0 = NOK
1 = OK
2 = High
OTR_ Word, Short Read Only (Rev 2) Current monitoring status -2
CMSTAT 0 = NOK
1 = OK
2 = High
OTR_STSTAT Word, Short Read Only (Rev 2) Selftap status 0-2
0 = NOK
1 = OK
2 = High
OTR_ Word, Short Read Only (Rev 2) Prevail torque monitoring status 0-2
PTMSTAT 0 = NOK
1 = OK
2 = High
OTR_ Word, Short Read Only (Rev 2) Prevail torque compensate status 0-2
PTCSTAT 0 = NOK
1 = OK
2 = High
OTR_ Boolean Read Only (Rev 2) Tightening error status -1
TERRSTAT
This item requires a bit number (0-31):
Bit 0 = Rundown angle max shut off
Bit 1 = Rundown angle min shut off
Bit 2 = Torque max shut off
Bit 3 = Angle max shut off
Bit 4 = Selftap torque max shut off

www. ptc.com
Torque Tool Ethernet Driver 35

It em Dat a Type Access Descript ion Dat a Range

Bit 5 = Selftap torque min shut off
Bit 6 = Prevail torque max shut off
Bit 7 = Prevail torque min shut off
Bit 8 = Prevail torque compensate overflow
Bit 9 = Current monitoring max shut off
Bit 10 = Post view torque min torque shut off
Bit 11 = Post view torque max torque shut off
Bit 12 = Post view torque Angle too small
Bit 13 = Trigger Lost
Bit 14 = Torque Less Than Target
Bit 15 = Tool Hot
Bit 16 = Multistage Cancel
Bit 17 = Rehit
Bit 18 = DS Measure Failed
Bit 19 = Current Limit Reached
Bit 20 = EndTime out Shutoff
Bit 21 = Remove fastener limit exceeded
Bit 22 = Disable drive
OTR_ DWord, Read Only (Rev 2) All tightening error status bits are com- 0 to
TERRSTAT_ Long bined in one value. Refer to OTR_TERRSTAT to 4294967295
COMBINED review the match of each bit and the value. (DWord)
-
2,147,483,648
to
2,147,483,647
(Long)
OTR_ DWord, Read Only (Rev 2) Rundown angle value reached, in 0-99999
RANGLE Long degrees
OTR_ Word, Short Read Only (Rev 2) Current monitoring value in percent 0-999
CMVALUE
OTR_ Float Read Only (Rev 2) Selftap torque 0-9999.99
STORQUE
OTR_ Float Read Only (Rev 2) Prevail torque value 0-9999.99
PTORQUE
OTR_JOBSEQ Word, Short Read Only (Rev 2) Job sequence number 0-65535
OTR_STID Word, Short Read Only (Rev 2) Synch Tightening ID 0-65535
OTR_SERIAL String Read Only (Rev 2) Tool serial number 14 characters
OTR_TVUNIT Word, Short Read Only (Rev 3) Torque value units 1-4

1 = Nm
2 = Lbf.ft
3 = Lbf.In
4 = Kpm
OTR_RTYPE Word, Short Read Only (Rev 3) Result type 1-7
1 = Tightening
2 = Loosening

www. ptc.com
36 Torq u e Tool Eth ern et Driver

It em Dat a Type Access Descript ion Dat a Range

3 = Batch Increment
4 = Batch decrement
5 = Bypass pset result
6 = Cancel job result
7 = Sync tightening
OTR_ID2 String Read Only (Rev 4) Identifier result part 2 25 characters
OTR_ID3 String Read Only (Rev 4) Identifier result part 3 25 characters
OTR_ID4 String Read Only (Rev 4) Identifier result part 4 25 characters
OTR_ String Read Only (Rev 5) Customer tightening error code 4 characters
CUSTOM_
ERR
OTR_PVT Float Read Only (Rev 6) PVT compensation value 0-9999.99
OTR_TERR_ Boolean Read Only (Rev 6) Tightening error status 0-1
STATUS2 This item requires a bit number (0-31):
Bit 0 = Drive deactivated
Bit 1 = Tool stall
Bit 2 = Drive hot
Bit 3 = Gradient monitoring high
Bit 4 = Gradient monitoring low
Bit 5 = Reaction bar failed
Bit 6-31 = Reserved
OTR_TERR_ DWord, Read Only (Rev 6) All tightening error status bits are com- 0-
STATUS2_ Long bined in one value. 4294967295
COMBINED Refer to OTR_TERR_STATUS2 to review the match
of each bit and the value.
OTR_ DWord,Long Read Only (Rev 7) The station ID 0-
STATION_ID 4294967295
OTR_ String Read Only (Rev 7) The station name 25 characters
STATION_
NAM

N ote: Any commands that require special revisions (such as 2, 3, and so forth) are not supported by the
FEP Protocol model.

Com m and Set : Operat ion Result

The Operation Result command set is used to receive data about tightening results using PIDs. Most of the
results are dynamic and use Parameter ID numbers (PIDs) for the values returned. However, there are spe-
cific values that are not dynamic that are used to give general information about the Operation Results.
Their values can be retrieved using the tags below.

It em Dat a Access Descript ion Dat a Range

Type
The operation type. Values are:
Read
1201.OPERATION_TYPE Word 0 = Non-synchronized tightening 0-4
Only
1 = Synchronized tightening

www. ptc.com
Torque Tool Ethernet Driver 37

It em Dat a Access Descript ion Dat a Range

Type
2 = Pressing
3 = Drilling
4 = Pulse
Read 0-
1201.RESULT_DATA_ID DWord The unique ID for the operation result
Only 4294967295
The status of the operation. Values
Read are:
1201.RESULT_STATUS Boolean 0-1
Only 0 = Not OK
1 = OK
Read
1201.TIME String The cycle start time 19 characters
Only
Read 0-
1202.RESULT_DATA_ID DWord The unique ID for the operation result
Only 4294967295
Read
1202.OBJECT_ID Word The user defined Object ID 0-9999
Only

For more information, request the model-specific document(s) for the open protocol implementations from the
Atlas Copco website (https://www.atlascopco.com).

Com m and Set : Param et er Set Dat a

The Parameter Set Data command set is used to retrieve data for a specific parameter set on demand. To
retrieve data for a parameter set, write the parameter set number to the PSD_ID item. All items belonging to
this command set use MID 12 (Parameter set data upload request) for requesting the item data, which is
replied to with MID 13 (Parameter set data upload reply).

N ote: Some command set items also have alias names. In the table below, the alias name will be listed
beneath the item where applicable.

It em Dat a Type Access Descript ion Dat a

Range
PSD_ID Word, Short Read/Write The parameter set ID. Write the ID of 0-999
APPD_ID the desired parameter set to this item to
retrieve the data for that parameter set.
PSD_NAME String Read Only The name of the parameter set 25 char-
APPD_NAME acters
PSD_DIR Word, Short Read Only Rotation direction 1-2
APPD_DIR 1 = Clockwise
2 = Counterclockwise
PSD_BSIZE Word, Short Read Only Batch size 0-99
APPD_BSIZE
PSD_TMIN Float Read Only Torque minimum limit 0-9999.99
APPD_TMIN
PSD_TMAX Float Read Only Torque maximum limit 0-9999.99
APPD_TMAX

www. ptc.com
38 Torq u e Tool Eth ern et Driver

It em Dat a Type Access Descript ion Dat a

Range
PSD_TTARG Float Read Only Torque final target value 0-9999.99
APPD_TTARG
PSD_AMIN Word, Short Read Only Angle minimum value in degrees 0-99999
APPD_AMIN
PSD_AMAX Word, Short Read Only Angle maximum value in degrees 0-99999
APPD_AMAX
PSD_ATARG Word, Short Read Only Target angle in degrees 0-99999
APPD_ATARG

Com m and Set : Param et er Set Num bers

The Parameter Set Numbers command set is used to retrieve the list of parameter set numbers from the
device.

N ote: Some command set items also have alias names. In the table below, the alias name will be listed
beneath the item where applicable.

It em Dat a Access Descript ion Dat a

Type Range
PSN_ Word, Read The number of parameter sets in the list. This command set use 0-999
COUNT Short Only MID 10 (Parameter set ID upload request) for requesting the item
APPN_ data, which is replied to with MID 11 (Parameter set ID upload
COUNT reply).
PSN_ID Word, Read The parameter set ID. The array size is defined by the PSN_COUNT. 0-999
APPN_ Short* Only This command set use MID 10 (Parameter set ID upload request) for
ID requesting the item data, which is replied to with MID 11 (Parameter
set ID upload reply).

This item requires an array index (1-999).

* This item requires an array index or bit index.

Com m and Set : Param et er Set Select ed

The Parameter Set Selected command set is used to select a particular parameter set, to notify the user
when a new parameter set has been selected, and to control certain batch properties. All items belonging to
this parameter set use MID 14 (Parameter set selected subscribe) for the subscription request. The device
sends item data to the server through MID 15 (Parameter set selected), which the server responds to with
MID 16 (Parameter set selected acknowledge).

N ote: Some command set items also have alias names. In the table below, the alias name will be listed
beneath the item where applicable.

Dat a Dat a
It em Access Descript ion
Type Range
PSET_ Word, Read/Write ID number of the last parameter set selected. Users 0-999

www. ptc.com
Torque Tool Ethernet Driver 39

Dat a Dat a
It em Access Descript ion
Type Range
may also write a parameter set number to this item
APP_NUMBER Short
to select a parameter set.
PSET_
LASTCHANGE 19 char-
String Read Only Time of last change in PSet setting
APP_ acters
LASTCHANGE
PSET_
NEWDATA New data flag. Set to 1 when new data arrives. Write
Boolean Read/Write 0-1
APP_ a 0 to this flag to clear it.
NEWDATA
Use this item to set the batch size for a particular
parameter set. The format of the string is:

PSETNUM = BATCHSIZE PSet: 0-

999
PSET_BSIZE
String Write Only Where PSETNUM is the parameter set number, and
APP_BSIZE
BATCHSIZE is the desired batch size. For example, to Batch
set the batch size to 20 for parameter set 3, users Size: 0-99
would write the following to this tag.

3 = 20
PSET_
Word, Writing a parameter set number to this item will reset
RESETBC Write Only 0-999
Short the batch counter for that parameter set
APP_RESETBC

Com m and Set : Program M essages

The Program Messages command set can be used to read multi-step tightening programs from the device
or write multi-step tightening programs to the device using MIDs 2500 and 2501, respectively. The imple-
mentation of this MID in the server is built as a pass-through; it is up to the client application to write a valid
string that matches what the device expects.

N ote: The Program Messages command set is currently only supported on the Power Focas 6000.

See Also:
Refer to the Open Protocol Specification for exact details on what the device accepts
See Appendix for examples

It em Dat a Access Descript ion

Type
PSET_ String Write Only* Passes the message to the device with the string written as a pay-
PROGRAM_ load. If successful, the device is updated with the program spe-
WRITE cified in the string.
PSET_ String Write Only* Passes the message to the device with the string written as a pay-
PROGRAM_ load. If successful, the response tags are populated with the pro-
READ gram specified by the PSET ID* * in the payload.

www. ptc.com
40 Torq u e Tool Eth ern et Driver

It em Dat a Access Descript ion

Type
PSET_ String Read Only If the PSET_PROGRAM_READ message was successful, this tag will
PROGRAM_ contain the entire response message from the device.
RESPONSE_
ALL
PSET_ String Read Only If the PSET_PROGRAM_READ message is successful, this tag con-
PROGRAM_ tains the header of the response message from the device. This
RESPONSE_ normally contains any PIDs sent in the response and includes the
HEADER string length of the multi-step program definition.
PSET_ String Read Only If the PSET_PROGRAM_READ message is successful, this tag con-
PROGRAM_ tains the multi-step program definition (in JSON format) from
RESPONSE_ within the response message.
BODY
* While the tags are only meant to be written to, they will contain that last string that was written to them
whether that string was valid or not.

* * Depending on the Controller setup, PSET ID can be interpreted as an Identifier or an Index. Please refer to
the Open Protocol Specification for exact details on how the device behaves in these scenarios.

Com m and Set : Select or M essages

The Selector command set is used to send and receive data for the socket selector accessory. MID 250 is
used to subscribe to selector socket information and that information is sent back using MID 251. MID 254
and MID 255 can be used to set the lights on the selector socket.

Dat a Dat a
It em Access Descript ion
Type Range
SELECTOR_ Word, Read
The ID of the selector device. 0-99
DEVICE_ID Short Only
SELECTOR_
Word, Read
NUM_ The number of sockets on the selector device. 0-99
Short Only
SOCKETS
SELECTOR_ The status of the socket:
Read
SOCKET_ Boolean* 0 = socket not lifted 0-1
Only
STATUS 1 = socket lifted

SELECTOR_ String Write Use this item to set the lights on the selector socket 102 char-
GREEN_ Only device. The format of the string is: acters
LIGHTS DEVICEID = LIGHTDATA
SELECTOR_ Device ID:
RED_ 0-99
LIGHTS Where DEVICEID is the device ID of the selector socket
and LIGHTDATA is a list of values for each socket in Light Data:
order. Those values can be:
0 = Off (Rev 0,1) 8
1 = Steady characters
2 = Flashing

www. ptc.com
Torque Tool Ethernet Driver 41

Dat a Dat a
It em Access Descript ion
Type Range
(Rev 2) 1-
For example, to turn off the first two socket lights and set 99 char-
the last two sockets to flashing on a selector with a device acters
ID of 2 the value would be:
2=00220000 (Rev 0,1)
2=0022 (Rev 2)

With Rev 0 or 1; eight sockets values must be given. With

Rev 2 any amount of values can be given from 1-99.

* This item requires an array index or bit index. The valid array / bit index range is 1 to 99.

Com m and Set : Tim e

The Time command set is used to read the controller's time and to synchronize it with the PC.

It em Dat a Access Descript ion Dat a

Type Range
TIME String Read Current time in the controller. TIME uses MID 80 (Read time 19 char-
Only upload request) for requesting time data, which is replied to with acters
MID 81 (Read time upload reply).
TIME_ Boolean Write Write any value to this item to set the controller's time to the cur- N/A
SYNC Only rent PC time. TIME_SYNC uses MID 82 (Set Time) for setting the
controller's time to the current PC time.

Com m and Set : Tool Dat a

The Tool Data command set is used to receive data for the connected tool and to enable/disable the tool.
The TOOLDATA items use MID 40 (Tool data upload request) for requesting tool data, which is replied to
with MID 41 (Tool data upload reply). The TOOL_ENABLE item uses MID 42 (Disable tool) when a 0 is written
and MID 43 (Enable tool) when a 1 is written.

It em Dat a Access Descript ion Dat a

Type Range
TOOLDATA_ Float Read (Rev 2) The tool calibration value 0-9999.99
CALIBRATION_VAL Only
TOOLDATA_CONT_ String Read (Rev 2) The controller software version 19 char-
SOFT_VER Only acters
TOOLDATA_CSERIAL String Read Controller serial number 10 char-
Only acters
TOOLDATA_GEAR_ Float Read (Rev 3) The gear ratio; last calibration date 0-9999.99
RATIO Only
TOOLDATA_LAST_ String Read (Rev 2) The date of the last service 19 char-
SERV_DATE Only acters
TOOLDATA_LCD String Read Last calibration date 19 char-
Only acters

www. ptc.com
42 Torq u e Tool Eth ern et Driver

It em Dat a Access Descript ion Dat a

Type Range
TOOLDATA_ Word, Read (Rev 2) The seize of the motor 0-99
MOTOR_SIZE Short Only
TOOLDATA_NT DWord, Read Tool number of tightening 0-
Short Only 4294967295
TOOLDATA_OPEN_ Word, Read (Rev 2) The open end data. The first digit rep- 0-111
END_DATA Short Only resents the "use open end":
1 = true
0 = false
The second digit indicates the tightening dir-
ection:
0 = CW
1 = CCW
The third digit indicates motor rotation:
0 = normal
1 = inverted
TOOLDATA_ Word, Read (Rev 4) Specifies the primary tool: 0-99
PRIMARY_TOOL Short Only 01 = Cable (invalid for IRC-controller)
02 = IRC-B
03 = IRC-W
TOOLDATA_TFULL_ Float Read (Rev 3) The tool full speed 0-9999.99
SPEED Only
TOOLDATA_TIGHT_ DWord, Read (Rev 2) The number of tightening since the last 0-
SINCE_SERV Long Only service 4294967295
TOOLDATA_TMAX_ Float Read (Rev 3) The tool maximum torque value 0-9999.99
TORQUE Only
TOOLDATA_ String Read (Rev 5) The tool model 12 char-
TMODEL Only acters
TOOLDATA_TSERIAL String Read Tool serial number 14 char-
Only acters
TOOLDATA_TTYPE Word, Read (Rev 2) The tool type: 0-99
Short Only 0 = No Tool
1 = S-tool
2 = DS-tool
3 = Ref. transducer
4 = ST-tool
5 = EP=tool
6 = ETX-tool
7 = SL-tool
8 = DL-tool
9 = IRC Offline
10 = STB-tool
11 = OST-tool
12 = STT-tool
13 = STwrench
14 = ES-tool

www. ptc.com
Torque Tool Ethernet Driver 43

It em Dat a Access Descript ion Dat a

Type Range
TOOL_ENABLE Boolean Write Write a 0 to disable the tool or a 1 to enable the 0-1
Only tool
TOOLDATA_FWV1* String Read The controller firmware version 10 char-
Only acters
TOOLDATA_FWV2* String Read Auxiliary firmware version in the case there is a 10 char-
Only second firmware required acters

* This item is only supported by the FEP Protocol model.

Com m and Set : VIN

The VIN command set is used to receive data about the VIN (Vehicle ID Number). Writing to VIN_VIN sends a
MID 50 (Vehicle ID Number download request) message to the controller. The device subscribes to all VIN
data through MID 51 (Vehicle ID Number subscribe), the controller sends item data to the server through
MID 52 (Vehicle ID Number), which the server responds to with a MID 53 (Vehicle ID Number Acknowledge).

It em Dat a Access Descript ion Dat a

Type Range
VIN_VIN String Read/Write Vehicle ID Number. To send it to the controller, write a 25 char-
VIN to this field. acters
VIN_VIN2 String Read Only (Rev 2) Identifier result part 2 25 char-
acters
VIN_VIN3 String Read Only (Rev 2) Identifier result part 3 25 char-
acters
VIN_VIN4 String Read Only (Rev 2) Identifier result part 4 25 char-
acters
VIN_ Boolean Read/Write New data flag. Set to 1 when new data arrives. Write a 0 0-1
NEWDATA to this flag to clear it.

N ote: Any commands that require special revisions (such as 2, 3, and so forth) are not supported by the
FEP Protocol model.

www. ptc.com
44 Torq u e Tool 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 server help on filtering and sorting the Event Log detail view. Server help contains many common
messages, so should also be searched. Generally, the type of message (informational, warning) and
troubleshooting information is provided whenever possible.

Error Descript ions

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

Address Validation Errors

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.

Ethernet Errors
Unable t o bind t o adapt er: <adapt er name>. Connect failed.
Winsock init ializat ion failed (OS Error = <error code>).
Winsock shut down failed (OS Error = <error code>).
Winsock V1.1 or higher must be inst alled t o use t he driver.

Runtime Errors
Device <device name> failed t o connect .
Device <device name> is not responding.
Unable t o read t ag <t ag name>: Device <device name> encount ered a parsing error.
Unable t o read t ag <t ag name>: Device <device name> received an error response (Error
<error code>).
Unable t o read unsolicit ed packed dat a group: Device <device name> received an error
response (Error <error code>).
Unable t o writ e t ag <t ag name>: Device <device name> encount ered a parsing error.
Unable t o writ e t ag <t ag name>: Device <device name> received an error response (Error
<error code>).
Unable t o writ e t ag <t ag name>: Device <device name> received invalid dat a for writ e.
Unable t o writ e t o <address> on device <device name>.

Error Codes
Error Codes

www. ptc.com
Torque Tool Ethernet Driver 45

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

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 t ype <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:

www. ptc.com
46 Torq u e Tool Eth ern et Driver

Warning

Possible Cause:
An invalid tag address has been specified in a dynamic request.

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.

Unable t o bind t o adapt er: <adapt er nam e>. Connect failed.

Error Type:
Fatal

Possible Cause:
The specified adapter is not working properly or is not installed correctly.

Solution:
Make sure that the correct Ethernet adapter is chosen, and verify that it is functioning properly.

Winsock init ializat ion failed (OS error = <error>).

Error Type:
Fatal

OS
Indicat ion Possible Solut ion
Error
10091 Indicates that the underlying network subsystem is Wait a few seconds and restart the driver.
not ready for network communication.
10067 Limit on the number of tasks supported by the Win- Close one or more applications that may
dows Sockets implementation has been reached. be using Winsock and restart the driver.

Winsock shut down failed (OS error = <error>).

Error Type:
Informational

Possible Cause:
Indicates that Winsock encountered a problem when shutting down.

www. ptc.com
Torque Tool Ethernet Driver 47

Winsock V1.1 or higher m ust be inst alled t o use t he driver.

Error Type:
Fatal

Possible Cause:
The version number of the Winsock DLL found on the system is less than 1.1.

Solution:
Upgrade Winsock to version 1.1 or higher.

Device <device nam e> failed t o connect .

Error Type:
Serious

Possible Cause:
1. The device is offline.

2. The IP address entered for the device is incorrect.

Solution:
1. Verify that the device is online.

2. Verify that the IP address entered for the device is correct.

Device <device nam e> is not responding.

Error Type:
Serious

Possible Cause:
1. The device does not support the specified command set.

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

3. The connection to the device failed.

4. The device is offline.

5. The device cannot answer the request within the allotted time.

Solution:
1. Verify that the device is online.

2. Increase the Request Timeout property so that the entire response can be handled.

www. ptc.com
48 Torq u e Tool Eth ern et Driver

3. Verify that the connection to the device is still valid.

4. Increase the timeout value to allow the device more time to respond.

Unable t o read t ag <t ag nam e>: Device <device nam e> encount ered a pars-
ing error.
Error Type:
Warning

Possible Cause:
1. The device supports a different command set version than standard.

2. Line noise has corrupted the packet.

Solution:
Use channel diagnostics to verify that the received packet is in the correct format.

Unable t o read t ag <t ag nam e>: Device <device nam e> received an error
response (Error <error code>).
Error Type:
Warning

Possible Cause:
1. The device does not support the specified command set.

2. One or more parameters sent to the device are out of range.

3. The device is not in the proper state to execute the command.

Solution:
Look up the error code.

See Also:
Error Codes

Unable t o read unsolicit ed packed dat a group: Device <device nam e>
received an error response (Error <error code>).
Error Type:
Warning

Possible Cause:
An unsolicited message hasn’t been received for the requested data group.

Solution:
After receiving an unsolicited message for the requested data group, the reads will no longer fail.

www. ptc.com
Torque Tool Ethernet Driver 49

See Also:
Error Codes

Unable t o writ e t ag <t ag nam e>: Device <device nam e> encount ered a
parsing error.
Error Type:
Warning

Possible Cause:
1. The device supports a different command set version than standard.

2. Line noise has corrupted the packet.

Solution:
Use channel diagnostics to verify that the received packet is in the correct format.

Unable t o writ e t ag <t ag nam e>: Device <device nam e> received an error
response (Error <error code>).
Error Type:
Warning

Possible Cause:
1. The device does not support the specified command set.

2. One or more parameters sent to the device are out of range.

3. The device is not in the proper state to execute the command.

Solution:
Look up the error code.

See Also:
Error Codes

Unable t o writ e t ag <t ag nam e>: Device <device nam e> received invalid
dat a for writ e.
Error Type:
Warning

Possible Cause:
The data that was written to a tag was not in the proper format.

Solution:
View the information for the named tag to learn the proper format for data writes.

www. ptc.com
50 Torq u e Tool Eth ern et Driver

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

Error Type:
Serious

Possible Cause:
1. The named device may not be connected to the network.

2. The named device may have been assigned an incorrect Network ID.

3. The named device is not responding to write requests.

4. The device does not support the requested command set.

Solution:
1. Check the hardware network connections.

2. Verify that the Network ID given to the named device matches that of the actual device.

Error Codes

Error Code Descript ion

01 Invalid data.
02 Pset number not present.
03 Pset can not be set.
04 Pset not running.
06 VIN upload subscription already exists.
07 VIN upload subscription does not exists.
08 VIN input source not granted.
09 Last tightening result subscription already exists.
10 Last tightening result subscription does not exist.
11 Alarm subscription already exists.
12 Alarm subscription does not exist.
13 Parameter set selection subscription already exists.
14 Parameter set selection subscription does not exist.
15 Tightening ID requested not found.
16 Connection rejected protocol busy.
17 Job number not present.
18 Job info subscription already exists.
19 Job info subscription does not exist.
20 Job can not be set.
21 Job not running.
22 Spindle exceeds limits.

www. ptc.com
Torque Tool Ethernet Driver 51

Error Code Descript ion

23 Spindle off line.
30 Controller is not a sync Master.
31 Multi spindle status subscription already exists.
32 Multi spindle status subscription does not exist.
33 Multi spindle result subscription already exists.
34 Multi spindle result subscription does not exist.
40 Job line control info subscription already exists.
41 Job line control info subscription does not exist.
42 Identifier input source not granted.
43 Multiple identifiers work order subscription already exists.
44 Multiple identifiers work order subscription does not exist.
50 Status "external monitored inputs" subscription already exists.
51 Status "external monitored inputs" subscription does not exist.
52 IO device not connected.
53 Faulty IO device number.
58 No alarm present.
59 Tool currently in use.
60 No histogram available.
80 Reserved.
81 Reserved.
82 Automatic/manual mode subscribe already exists.
83 Automatic/manual mode subscribe does not exist.
95 Reject request, PowerMACS is in manual mode.
96 Client already connected.
97 MID revision unsupported.
98 Controller internal request timeout.
99 Unknown MID.

www. ptc.com
52 Torq u e Tool Eth ern et Driver

Appendix — Tightening Program Read/Write

Reading and writing multi-step programs back and forth from the device using the Program Messages com-
mand set tags can be difficult and should be done with caution. Depending on the model of the device; the
payloads can be significantly different, and it can be complicated to create the message payload correctly.
Below are some examples of the payloads that could be used for a Power Focas 6000 device using firmware
version 3.0 or above.

Reading a Program from the Device

The payload for the PSET_PROGRAM_READ tag can look something like this; where YYYY is replaced with the
4-digit PSET ID of the program to read:

00360006001000000000250100207YYYY201

where:
YYYY = PSET ID

For example, to read the program with PSET ID 3, write the following string to the PSET_PROGRAM_READ tag:

003600060010000000002501002070003201

Writing a Program to the Device

To write a program to the device, the header information must be constructed and sent along with the pro-
gram. Again, this header depends on the model of the device being used but for a PF 6000 this can be used:

AAAA250000200000000020100101000004010000000YYYY00XXXX{JSON Program Definition}

where:
AAAA = Total length
YYYY = PSET ID
XXXX = Length of the program

The program must then be added to the header for a complete payload. For example, the following will write
a simple program to PSET ID 12:

16542500002000000000201001010000040100000000012001601{"changeState":2,"re-
vision":43,"id":{"value":
[207,5,207,152,224,99,74,44,136,52,224,208,238,183,216,17]},"versionId":{"value":
{"value":[135,165,107,190,250,248,69,229,136,225,236,201,21,253,42,64]}},"user-
":"ExternalwebHMI","timestamp":{"value":1557216299},"-
name":"Program","descr":"","indexId":
{"value":5},"threadDirection":1,"tighteningType":2,"operationMode":1,"looseningId":
{"value":[67,154,12,156,38,192,77,122,190,129,177,188,221,140,194,196]},"steps":
[{"internalNumber":1,"stepNumber":0,"nextInternalNumber":2,"stepPath":1,"type":10},
{"intern-
alNum-
ber-
":2,"stepNum-
ber":1,"nextInternalNumber":10,"stepPath":1,"type":13,"stepTightenToAngle":
{"motorControlSpeedRamp":
{"speedTar-
get":60,"ac-
celeration":500,"speedRampType":1},"brake":true,"angleTarget":80,"speedRampChanges":

www. ptc.com
Torque Tool Ethernet Driver 53

[],"brakeConfig":{"brakeType":1,"configErgoStop":{"isBrakeRamp-
timeAdaptive":true,"rampTime":200}}}},{"intern-
alNum-
ber":10,"stepNumber":9,"nextInternalNumber":10,"stepPath":1,"type":11}],"syncPoints":
[],"programRestrictions":[{"internalNumber":7,"type":2,"timeHigh":
{"timeLimitHigh":30}},{"internalNumber":8,"type":1,"torqueHigh":{"torqueLim-
itHigh":10}}],"stepMonitors":[{"intern-
alNumber":3,"startInternalStepNumber":2,"type":2,"peakTorque":{}},
{"internalNumber":4,"startInternalStepNumber":2,"type":6,"angle":{"stopCondi-
tion":2}}],"stepRestrictions":[{"intern-
alNumber":5,"startInternalStepNumber":2,"type":3,"timeHigh":{"timeLimitHigh":5}},
{"internalNumber":6,"startInternalStepNumber":2,"type":1,"torqueHigh":{"torqueLim-
itHigh":10}}],"programMonitors":[{"internalNumber":9,"type":1,"angle":{"enabled":-
false,"stopCondition":2}}]}

Troubleshooting
l The maximum program size that can be handled with these calls is 9967 bytes since the maximum
protocol message size has to be specified by a 4-digit number. This is a limitation imposed by the
Open Protocol. If a program has a length longer than 9967 bytes then the device does not respond to
the program read requests.
l Subscribing to MID 2501 updates are not supported through the server. The header for PSET_
PROGRAM_READ must specify MID 6 or MID 2501 depending on the model and firmware of the
device. MID 8 (Generic Subscribe) is not supported for this message.
l When writing to either PSET_PROGRAM_READ or PSET_PROGRAM_WRITE and an error occurs with
response “Error 1” this usually means the payload is not correct. Verify the lengths are correct and
check with the device appendix documentation to verify the payload is in the correct format.
l When writing to the PSET_PROGRAM_WRITE tag and an error occurs with response “Error 79” this usu-
ally means that the JSON Program Definition within the message payload was invalid.

www. ptc.com
54 Torq u e Tool Eth ern et Driver

Index

1201.OPERATION_TYPE 36
1201.RESULT_DATA_ID 37
1201.RESULT_STATUS 37
1201.TIME 37
1202.OBJECT_ID 37
1202.RESULT_DATA_ID 37

AD_BATCH 19
AD_SETTING 19
Address <address> is out of range for the specified device or register. 45
Address Descriptions 15
ALARM_C_READY 19
ALARM_ERROR 19
ALARM_NEWDATA 19
ALARM_STATUS 19
ALARM_T_HEALTH 19
ALARM_T_READY 19
ALARM_TEXT 19
ALARM_TIME 19
AM_MODE 19
AM_NEWDATA 20
APP_BSIZE 39
APP_LASTCHANGE 39
APP_NEWDATA 39
APP_NUMBER 39
APP_RESETBC 39
APPD_AMAX 38
APPD_AMIN 38
APPD_ATARG 38
APPD_BSIZE 37
APPD_DIR 37
APPD_ID 37

www. ptc.com
Torque Tool Ethernet Driver 55

APPD_NAME 37
APPD_TMAX 37
APPD_TMIN 37
APPD_TTARG 38
APPN_COUNT 38
APPN_ID 38
Array size is out of range for address <address>. 45
Array support is not available for the specified address: <address>. 45
Attempts Before Timeout 11

Channel Assignment 8
COMM_CELL_ID 20
COMM_CHANNEL_ID 20
COMM_CLIENT_ID 20
COMM_CONTROL_NAME 20
COMM_CONTROL_SER_NUM 20
COMM_CONTROL_SOFT_VER 20
COMM_LINK_SUPPORT 20
COMM_PROTOCOL_VERSION 20
COMM_RBU_TYPE 20
COMM_SEO_NUM_SUPPORT 20
COMM_STATION_ID 20
COMM_STATION_NAME 20
COMM_SUPPLIER_CODE 20
COMM_SYS_SUBTYPE 20
COMM_SYS_TYPE 21
COMM_TOOL_SOFT_VER 21
Command Set: Alarm 18, 36
Command Set: Auto-Disable Settings 19
Command Set: Communication 20
Command Set: Flash 21
Command Set: Identifiers 21
Command Set: IO Interface 22
Command Set: Job Data 24
Command Set: Job Info 23
Command Set: Job Number Data 26
Command Set: Last Tightening Results 26

www. ptc.com
56 Torq u e Tool Eth ern et Driver

Command Set: Multi Spindle Results 31

Command Set: Old Tightening Results 32
Command Set: Parameter Set Data 37
Command Set: Parameter Set Numbers 38
Command Set: Parameter Set Selected 38
Command Set: Program Messages 39
Command Set: Selector Messages 40
Command Set: Time 41
Command Set: Tool Data 41
Command Set: VIN 43
Communications Parameters 11
Communications Timeouts 10-11
Connect Timeout 10

Data Collection 9
Data type <type> is not valid for device address <address>. 45
Data Types Description 15
Device <device name> failed to connect. 47
Device <device name> is not responding. 47
Device address <address> contains a syntax error. 45
Device address <address> is read only. 46
Do Not Scan, Demand Poll Only 10
Driver 8

Error Codes 50
Error Descriptions 44
Event Log Messages 44

FLASH 21

www. ptc.com
Torque Tool Ethernet Driver 57

General 8

Help Contents 4

ID 8
ID_BYPASS 21
ID_DOWNLOAD 21
ID_RESET 21
ID_RESETALL 21
Identification 8
Initial Updates from Cache 10
Inter-Request Delay 11

JOB_ABORT 24
JOB_BATCH_INCREMENT 24
JOB_BCOUNT 23
JOB_BMODE 23
JOB_BSIZE 23
JOB_JOBNUMLINK_LINKNUM 23
JOB_NEWDATA 24
JOB_RESTART 24
JOB_SCOUNT 24
JOB_STATUS 23
JOB_STEP 23
JOB_STYPE 24
JOB_TIME 23
JOB_TSTATUS 24
JOBDATA_BATCH_MODE 25
JOBDATA_FORCED_ORDER 24
JOBDATA_JOBID 24

www. ptc.com
58 Torq u e Tool Eth ern et Driver

JOBDATA_LINE_CONTROL 25
JOBDATA_LOCK_ON_DONE 25
JOBDATA_MAX_COMPLETION_TIME 25
JOBDATA_MAX_FIRST_TIGHTENING_TIME 25
JOBDATA_NAME 24
JOBDATA_PARAMETER_AUTO_VALUE 25
JOBDATA_PARAMETER_BATCH_SIZE 25
JOBDATA_PARAMETER_CHANNEL_ID 25
JOBDATA_PARAMETER_COUNT 25
JOBDATA_PARAMETER_SOCKET 25
JOBDATA_PARAMETER_STEP_NAME 25
JOBDATA_PARAMETER_STEP_TYPE 25
JOBDATA_PARAMETER_TYPE_ID 25
JOBDATA_REPEAT_JOB 25
JOBDATA_TOOL_LOOSENING 25
JOBDATA_TOOL_RESERVED 25
JOBN_COUNT 26
JOBN_ID 26

LINK_ABORT 24
LINK_BCOUNT 23
LINK_BMODE 23
LINK_BSIZE 23
LINK_NEWDATA 24
LINK_RESTART 24
LINK_STATUS 23
LINK_TIME 23
LINKN_COUNT 26
LINKN_ID 26
LTR_ANGLE_MAX 27
LTR_ANGLE_MIN 27
LTR_ANGLE_STATUS 27
LTR_ANGLE_TARGET 27
LTR_ANGLE_VALUE 27
LTR_BATCH_COUNTER 26
LTR_BATCH_SIZE 26
LTR_BATCH_STATUS 27

www. ptc.com
Torque Tool Ethernet Driver 59

LTR_CELL_ID 26
LTR_CHAN_ID 26
LTR_CHANGETIME 27
LTR_CM_MAX 30
LTR_CM_MIN 30
LTR_CM_VALUE 30
LTR_CMON_STATUS 28
LTR_CUSTOM_ERR 31
LTR_ID 27
LTR_IDR2 31
LTR_IDR3 31
LTR_IDR4 31
LTR_JOB 26
LTR_JOB_SEQ_NUM 30
LTR_NEWDATA 31
LTR_PSET 26
LTR_PSET_NAME 30
LTR_PT 30
LTR_PTC_STATUS 28
LTR_PTM_MAX 30
LTR_PTM_MIN 30
LTR_PTM_STATUS 28
LTR_PVT 28
LTR_RDA_MAX 30
LTR_RDA_MIN 30
LTR_RDA_STATUS 28
LTR_RDA_VALUE 30
LTR_RESULT_TYPE 30
LTR_SERIAL_NUM 30
LTR_ST_MAX 30
LTR_ST_MIN 30
LTR_ST_STATUS 28
LTR_ST_TORQUE 30
LTR_STID 30
LTR_STRAT_OPT 28
LTR_STRATEGY 27
LTR_TC_NAME 26
LTR_TERR_STATUS 28
LTR_TERR_STATUS_COMBINED 29

www. ptc.com
60 Torq u e Tool Eth ern et Driver

LTR_TERR_STATUS2 29
LTR_TERR_STATUS2_COMBINED 29
LTR_TIGHT_STATUS 27
LTR_TIMESTAMP 27
LTR_TORQUE_MAX 27
LTR_TORQUE_MIN 27
LTR_TORQUE_STATUS 27
LTR_TORQUE_TARGET 27
LTR_TORQUE_VALUE 27
LTR_UNITS 30
LTR_VIN 26

Message IDs 16
MID 2501 53
MID_ID 22
MID_IN_ORDER 22
MID_NEWDATA 22
MID_STATUS 22
MID_TYPE 21
Model 8
MS_AMAX 32
MS_AMIN 32
MS_ATARG 32
MS_BCOUNT 31
MS_BSIZE 31
MS_BSTATUS 31
MS_CHANGETIME 32
MS_JOBNUM 31
MS_NEWDATA 32
MS_NUMBER 31
MS_PSET 31
MS_SYNCID 32
MS_SYNCSTAT 32
MS_TIME 32
MS_TMAX 31
MS_TMIN 31
MS_TTARG 31

www. ptc.com
Torque Tool Ethernet Driver 61

MS_VIN 31

Name 8

Operating Mode 9
Optimizing Communications 14
OTR_ANGLE 33
OTR_ANGSTAT 33
OTR_BATSTAT 33
OTR_BCOUNT 33
OTR_BSIZE 34
OTR_CMSTAT 34
OTR_CMVALUE 35
OTR_CUSTOM_ERR 36
OTR_ID 33
OTR_ID2 36
OTR_ID3 36
OTR_ID4 36
OTR_JOBNUM 33
OTR_JOBSEQ 35
OTR_PSET 33
OTR_PTCSTAT 34
OTR_PTMSTAT 34
OTR_PTORQUE 35
OTR_PVT 36
OTR_RANGLE 35
OTR_RASTAT 34
OTR_RTYPE 35
OTR_SERIAL 35
OTR_STATION_ID 36
OTR_STATION_NAM 36
OTR_STID 35
OTR_STORQUE 35
OTR_STRATEGY 33

www. ptc.com
62 Torq u e Tool Eth ern et Driver

OTR_STROPT 34
OTR_STSTAT 34
OTR_TERR_STATUS2 36
OTR_TERR_STATUS2_COMBINED 36
OTR_TERRSTAT 34
OTR_TERRSTAT_COMBINED 35
OTR_TIGHTSTAT 33
OTR_TIME 33
OTR_TORQSTAT 33
OTR_TORQUE 33
OTR_TVUNIT 35
OTR_VIN 33
Overview 4

Program Messages 52
PSD_AMAX 38
PSD_ATARG 38
PSD_BSIZE 37
PSD_DIR 37
PSD_ID 37
PSD_NAME 37
PSD_TMAX 37
PSD_TMIN 37
PSD_TTARG 38
PSET_BSIZE 39
PSET_LASTCHANGE 39
PSET_NEWDATA 39
PSET_NUMBER 38
PSET_PROGRAM_READ 39, 52
PSET_PROGRAM_RESPONSE_ALL 40
PSET_PROGRAM_RESPONSE_BODY 40
PSET_PROGRAM_RESPONSE_HEADER 40
PSET_PROGRAM_WRITE 39
PSET_RESETBC 39
PSN_COUNT 38
PSN_ID 38

www. ptc.com
Torque Tool Ethernet Driver 63

Redundancy 13
RELAY_FUNCTION.# 22
Request Timeout 10
RESET_DIGITAL_INPUT 22
Respect Tag-Specified Scan Rate 10

Scan Mode 9
SELECTOR_DEVICE_ID 40
SELECTOR_GREEN_LIGHTS 40
SELECTOR_NUM_SOCKETS 40
SELECTOR_RED_LIGHTS 40
SELECTOR_SOCKET_STATUS 40
SET_DIGITAL_INPUT 22
Settings 12
Setup 4
Simulated 9
SPD_ANGLE 32
SPD_ASTATUS 32
SPD_CHAN 32
SPD_NUM 32
SPD_STATUS 32
SPD_TORQUE 32
SPD_TSTATUS 32
STATUS_DIGIN_# 23
STATUS_RELAY_# 22

Tightening Program Read/Write 52

TIME 41
TIME_SYNC 41
TOOL_ENABLE 43
TOOLDATA_CALIBRATION_VAL 41
TOOLDATA_CONT_SOFT_VER 41

www. ptc.com
64 Torq u e Tool Eth ern et Driver

TOOLDATA_CSERIAL 41
TOOLDATA_FWV1 43
TOOLDATA_FWV2 43
TOOLDATA_GEAR_RATIO 41
TOOLDATA_LAST_SERV_DATE 41
TOOLDATA_LCD 41
TOOLDATA_MOTOR_SIZE 42
TOOLDATA_NT 42
TOOLDATA_OPEN_END_DATA 42
TOOLDATA_PRIMARY_TOOL 42
TOOLDATA_TFULL_SPEED 42
TOOLDATA_TIGHT_SINCE_SERV 42
TOOLDATA_TMAX_TORQUE 42
TOOLDATA_TMODEL 42
TOOLDATA_TSERIAL 42
TOOLDATA_TTYPE 42

Unable to bind to adapter: <adapter name>. Connect failed. 46

Unable to read tag <tag name>: Device <device name> encountered a parsing error. 48
Unable to read tag <tag name>: Device <device name> received an error response (Error <error
code>). 48
Unable to read unsolicited packed data group
Device '<d evice>' received an error resp on se (Error <error n u m >). 48
Unable to write tag <tag name>: Device <device name> encountered a parsing error. 49
Unable to write tag <tag name>: Device <device name> received an error response (Error <error
code>). 49
Unable to write tag <tag name>: Device <device name> received invalid data for write. 49
Unable to write to <address> on device <device name>. 50

VIN_NEWDATA 43
VIN_VIN 43
VIN_VIN2 43
VIN_VIN3 43
VIN_VIN4 43

www. ptc.com
Torque Tool Ethernet Driver 65

Winsock initialization failed (OS error = <error>). 46

Winsock shut down failed (OS Error = <error>). 46
Winsock V1.1 or higher must be installed to use the driver. 47

www. ptc.com