EtherNetIP and ModBus TCP Object Models (FLIR Systems Object Model Version 1.21)
EtherNetIP and ModBus TCP Object Models (FLIR Systems Object Model Version 1.21)
21
FLIR Systems
EtherNet/IP and Modbus TCP
Object Models
Object Model revision: 1.21
09/15/2009
Page 1 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Chapter 1
Introduction to EtherNet/IP
Ethernet/IP (EIP) is a high-level industrial application layer protocol for industrial automation applications. Built on the standard TCP/IP
protocol suite, EIP uses all the traditional Ethernet hardware and software to define an application layer protocol that structures the task of
configuring, accessing and controlling industrial automation devices. Ethernet/IP classifies Ethernet nodes as predefined device types with
specific behaviors. The set of device types and the EIP application layer protocol is based on the Control and Information Protocol (CIP) layer
used in both Devicenet and Controlnet. Building on these widely used protocol suites, Ethernet/IP for the first time provides a seamless
integrated system from the sensor-actuator network to the controller and enterprise networks. EIP provides a wide-ranging, comprehensive,
certifiable standard suitable to a wide variety of automation devices.
09/15/2009
Page 2 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
REQUIRED OBJECTS
Required objects are required by the specification to be included in every CIP device. These objects include the Identity object, a Message
Router object and a Network object.
The identity object contains related identity data values called attributes. Attributes for the identity object include the vendor ID, date of
manufacturer, device serial number, and other identity data.
The Message Router object is an object which routes explicit request messages from object to object in a device.
A Network object contains the physical connection data for the object. For a CIP device on DeviceNet, the network object contains the
MacID and other data describing the interface to the CAN network. For EIP devices, the network object contains the IP address and other data
describing the interface to the Ethernet port on the device.
APPLICATION OBJECTS
Application objects are the objects that define the data encapsulated by the device. These objects are specific to the device type and function.
For example, a Motor object on a Drive System has attributes describing the frequency, current rating and motor size. An Analog Input object
on an I/O device has attributes that define the type, resolution and current value for the analog input.
These application layer objects are predefined for a large number of common device types. All CIP devices with the same device type (Drive
Systems, Motion Control, Valve Transduceretc) must contain the identical series of application objects. The series of application objects
for a particular device type is known as the device profile. A large number of profiles for many device types have been defined. Supporting a
device profile allows a user to easily understand and switch from a vendor of one device type to another vendor with that same device type.
A device vendor can also group Application Layer Objects into assembly objects. These super objects contain attributes of one or more
Application Layer Objects. Assembly objects form a convenient package for transporting data between devices. For example, a vendor of a
Real Time Automation, Inc.
09/15/2009
Page 3 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
ADVANTAGES TO EIP
The advantages of the CIP protocol layer over EtherNet/IP are numerous. The consistent device access means that a single configuration tool
can configure CIP devices on different networks from a single access point without using vendor specific software. The classification of all
devices as objects decreases the training and startup required when new devices are brought online. EIP provides improved response time and
greater data throughput than DeviceNet and ControlNet. EIP links devices from the sensor bus level to the control level to the enterprise level
with a consistent application layer interface.
09/15/2009
Page 4 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
File Section Administers the EDS file. Sometimes the URL keyword provides a link to a website where the latest version of the EDS
can be found.
Device Section Provides keying information that matches the EDS to a particular revision of a device. The first three attributes of
the Identity Object (Object #1) are used by network tools to verify that this EDS file (Vendor, Model,etc) plus the device revision
matches the information found in the device. The network tool will not connect to a device unless all four Identity Object Parameters
match. Some people mistakenly believe that the Minor Revision number is included in this match but that is not true.
Device Classification Section Classifies the EDS for an EtherNet/IP network. The Device Classification Section is required for all
EtherNet/IP devices.
Connection Manager Section Identifies the CIP connections that are available in the device. This section indicates to the EtherNet/IP
Scanner the Triggers and Transports available in the device. If a device supports multiple connections then every connection must be
detailed in this section. Only connections that are specified in this section can be used in an EDS-based configuration tool.
Assembly, Params and ParamClass section These sections are filled in as needed. For values that are limited to a limited to a defined
set of values, Enumeration can be used to specify those values. Value ranges can be specified here also for Configurable parameters.
Capacity Section This section indicates the number of connections available in the device and the connection speeds
Port Section This section describes the Ethernet port. It is only applicable to devices that perform CIP routing. It is unnecessary for
devices containing a single CIP port.
09/15/2009
Page 5 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 6 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Data types
Data Type
Description
USINT
UINT
UDINT
DINT
INT
STRING
SHORT STRINGnn
BYTE
WORD
DWORD
REAL
The following sections list each objects required attributes and services, if any.
IMPORTANT NOTES:
All Double Precision Floating Point Values in the camera will be converted to Single Precision Floating Point Values over EtherNet/IP.
We are assuming that every call to the camera is a blocking call. Verify that the I/O RPI is large enough so no connections are dropped.
EtherNet/IP is a Little-Endian protocol, meaning that the data order is least significant byte to most significant byte.
09/15/2009
Page 7 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 8 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Table 2-2
Instance
Attribute
ID
Class (Instance 0)
Instance 1
Name
Data value
Access
rule
Revision
UINT
Get
Vendor number
UINT
1161
Get
Device type
UINT
43
Get
UINT
320
Get
USINT
USINT
02
38
Get
Status
WORD
Always 0
Get
Serial number
UDINT
Get
.version.product.serial
Product name
Table 2-3
Service
Real Time Automation, Inc.
Data Type
SHORT
STRING32
Implemented for
09/15/2009
Service name
Page 9 of 74
Get
Class level
Instance level
05Hex
No
Yes
Reset1
0EHex
Yes
Yes
Get_Attribute_Single
Table 2-4
Instance
Class
(Instance
0)
Output
0x70
Attribute
ID
Name
Data Type
Data Value
Access
Rule
Revision
UINT
Get
2
3
Max instance
Output Data
UINT
0x81
Get
Get/Set
Byte
0
Reserved
Force Image
One Shot
Save Image
Reserved
Atmospheric
Temp. Graphic
Reserved
Reflected
Temp. Graphic
Image Live
Distance
Graphic
Bit 4
One Time
Image Auto
Adjust
Image Freeze
Emissivity
Graphic
Reserved
Reserved
Reserved
Reserved
2
3
Bit 7
Bit 6
Bit 5
Bit 3
Bit 2
Bit 1
Bit 0
Auto Focus
Fast
Auto Focus
Full
Force
NUC
Auto
NUC
Reserved
Date/Time
Graphic
Reserved
DO 2
Camera Label
Graphic
DO 1
Enable Overlay
Graphics
Relative Humidity
Graphic
Reserved
Scale Graphic
Measurement
Mark Graphic
Lens Graphic
If the Reset Service Code is sent with just a Class ID of 0x01 and Instance ID of 0x01, then a Normal Reset will occur.
If the Reset Service Code is send with a Class ID of 0x01, Instance ID of 0x01, and an additional value of 1, then the camera will resume with Factory Default settings.
09/15/2009
Page 10 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Instance
Output
0x71
Attribute
ID
3
Name
Data Type
Data Value
Output Data
Byte
Bit 7
Get/Set
Bit 6
Bit 5
Reserved
Force Image
One Shot
Save Image
Reserved
Atmospheric
Temp. Graphic
Reserved
Reflected
Temp. Graphic
Image Live
Distance
Graphic
Reserved
Reserved
Reserved
4
5
6
7
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Access
Rule
Bit 4
One Time
Image Auto
Adjust
Image Freeze
Emissivity
Graphic
Bit 3
Bit 2
Bit 0
Auto Focus
Fast
Auto Focus
Full
Force
NUC
Auto
NUC
Reserved
Date/Time
Graphic
Reserved
DO 2
Camera Label
Graphic
Reserved
DO 1
Enable Overlay
Graphics
Relative Humidity
Graphic
Reserved
Reserved
Reserved
Reserved
Reserved
Scale Graphic
Measurement
Mark Graphic
Reserved
Reserved
Reserved
Reserved
Set Configuration Preset (RESERVED FOR FUTURE USE)
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Bit 1
Reserved
09/15/2009
Page 11 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Lens Graphic
3 Input Data
Byte
Get
Bit 7
Bit 6
Bit 5
Reserved
Force Image
One Shot
Save
Image
Disable Alarms1
Reserved
Atmospheric
Temp. Graphic
Reflected
Temp. Graphic
Image
Live
Distance
Graphic
Reserved
Reserved
Reserved
4
5
6
7
8-11
12-15
16-19
20-23
24-27
28-31
32-35
36-39
40-43
44-47
48-51
52
53
54
55
56-59
60-63
64-67
68-71
72
73
74
75
76-79
80-83
84-87
88-91
Alarm 8
Alarm 7
Reserved
Reserved
Reserved
Reserved
Bit 4
Bit 3
Bit 2
Bit 1
Auto Focus
Fast
Auto Focus
Full
Force
NUC
Auto
NUC
Image Freeze
DI 2
DI 1
DO 2
DO 1
Emissivity
Graphic
Date/Time
Graphic
Scale Graphic
Camera Label
Graphic
Alarm 2
Enable Overlay
Graphics
Relative Humidity
Graphic
Alarm 1
Reserved
Reserved
Reserved
Reserved
Measurement
Mark Graphic
Alarm 6
Alarm 5
Alarm 4
Alarm 3
Set Configuration Preset (RESERVED FOR FUTURE USE)
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Delta Temperature 1
Delta Temperature 2
Delta Temperature 3
Delta Temperature 4
Delta Temperature 5
Delta Temperature 6
Internal Camera Temperature
Spot 1 Temperature
Box 1 Min Temperature
Box 1 Max Temperature
Box 1 Average Temperature
Spot 1 Temperature Valid State
Box 1 Min Temperature Valid State
Box 1 Max Temperature Valid State
Box 1 Avg Temperature Valid State
Spot 2 Temperature
Box 2 Min Temperature
Box 2 Max Temperature
Box 2 Average Temperature
Spot 2 Temperature Valid State
Box 2 Min Temperature Valid State
Box 2 Max Temperature Valid State
Box 2 Avg Temperature Valid State
Spot 3 Temperature
Box 3 Min Temperature
Box 3 Max Temperature
Box 3 Average Temperature
Reserved
Reserved
This alarm is the BATCH alarm. It has the ability to enable or disable all the other 8 alarms.
09/15/2009
Page 12 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Lens Graphic
Bit 0
Input
0x65
92
93
94
95
96-99
100-103
104-107
108-111
112
113
114
115
3 Input Data
Byte
Get
Reserved
Disable Alarm1
Atmospheric
Temp. Graphic
Bit 6
Force Image
One Shot
Reserved
Reflected
Temp. Graphic
Reserved
Reserved
4
5
6
7
8-11
12-15
16-19
20-23
24-27
28-31
32-35
36-39
40-43
44-47
48-51
52
53
54
Alarm 8
Alarm 7
Reserved
Reserved
Reserved
Reserved
Get
Bit 7
Bit 5
Save Image
Image Live
Distance
Graphic
Bit 4
One Time Image
Auto Adjust
Image Freeze
Emissivity
Graphic
Bit 3
Auto Focus
Fast
DI 2
Date/Time
Graphic
Bit 2
Auto Focus
Full
DI 1
Scale Graphic
Measurement
Mark Graphic
Alarm 6
Alarm 5
Alarm 4
Alarm 3
Set Configuration Preset (RESERVED FOR FUTURE USE)
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Delta Temperature 1
Delta Temperature 2
Delta Temperature 3
Delta Temperature 4
Delta Temperature 5
Delta Temperature 6
Internal Camera Temperature
Spot 1 Temperature
Box 1 Min Temperature
Box 1 Max Temperature
Box 1 Average Temperature
Spot 1 Temperature Valid State
Box 1 Min Temperature Valid State
Box 1 Max Temperature Valid State
Reserved
Reserved
Reserved
This alarm is the BATCH alarm. It has the ability to enable or disable all the other 8 alarms.
09/15/2009
Page 13 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Bit 1
Force
NUC
DO 2
Camera Label
Graphic
Bit 0
Alarm 2
Auto
NUC
DO 1
Enable Overlay
Graphics
Relative Humidity
Graphic
Alarm 1
Reserved
Reserved
Reserved
Reserved
Lens Graphic
55
56-59
60-63
64-67
68-71
72
73
74
75
76-79
80-83
84-87
88-91
92
93
94
95
96-99
100-103
104-107
108-111
112
113
114
115
116-135
136-155
156-175
176-195
196-215
216-235
236-255
256-275
276-295
296-315
316-335
336-355
356-375
376-395
396-415
09/15/2009
Page 14 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Get
Input
3 Input Data
0x66
416-435
Byte
0-3
4-7
Bit 7
Get
Bit 6
8-11
12-15
16-19
20-23
24-27
28-31
32-35
36-39
40-43
44
45
46
47
48-51
52-55
56-59
60-63
64
65
66
67
68-71
72-75
76-79
80-83
84
85
86
87
88-91
92-95
96-99
100-103
Get
Bit 5
Bit 4
Bit 3
Bit 2
Delta Temperature 1
Delta Temperature 2
Delta Temperature 3
Delta Temperature 4
Delta Temperature 5
Delta Temperature 6
Internal Camera Temperature
Spot 1 Temperature
Box 1 Min Temperature
Box 1 Max Temperature
Box 1 Average Temperature
Spot 1 Temperature Valid State
Box 1 Min Temperature Valid State
Box 1 Max Temperature Valid State
Box 1 Avg Temperature Valid State
Spot 2 Temperature
Box 2 Min Temperature
Box 2 Max Temperature
Box 2 Average Temperature
Spot 2 Temperature Valid State
Box 2 Min Temperature Valid State
Box 2 Max Temperature Valid State
Box 2 Avg Temperature Valid State
Spot 3 Temperature
Box 3 Min Temperature
Box 3 Max Temperature
Box 3 Average Temperature
Spot 3 Temperature Valid State
Box 3 Min Temperature Valid State
Box 3 Max Temperature Valid State
Box 3 Avg Temperature Valid State
Spot 4 Temperature
Box 4 Min Temperature
Box 4 Max Temperature
Box 4 Average Temperature
09/15/2009
Page 15 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Bit 1
Bit 0
0x66 (cont.)
Input
0x67
104
105
106
107
Get
Input Data
Byte
0-3
4-7
Bit 7
Get
Bit 6
Bit 4
Bit 3
Delta Temperature 1
Delta Temperature 2
Bit 2
Delta Temperature 3
Delta Temperature 4
Delta Temperature 5
Delta Temperature 6
Internal Camera Temperature
Spot 1 Temperature
Box 1 Min Temperature
Box 1 Max Temperature
Box 1 Average Temperature
Spot 1 Temperature Valid State
Box 1 Min Temperature Valid State
Box 1 Max Temperature Valid State
Box 1 Avg Temperature Valid State
Spot 2 Temperature
Box 2 Min Temperature
Box 2 Max Temperature
Box 2 Average Temperature
Spot 2 Temperature Valid State
Box 2 Min Temperature Valid State
Box 2 Max Temperature Valid State
Box 2 Avg Temperature Valid State
Spot 3 Temperature
Box 3 Min Temperature
Box 3 Max Temperature
Box 3 Average Temperature
Spot 3 Temperature Valid State
Box 3 Min Temperature Valid State
Box 3 Max Temperature Valid State
Box 3 Avg Temperature Valid State
Spot 4 Temperature
8-11
12-15
16-19
20-23
24-27
28-31
32-35
36-39
40-43
44
45
46
47
48-51
52-55
56-59
60-63
64
65
66
67
68-71
72-75
76-79
80-83
84
85
86
87
88-91
Bit 5
09/15/2009
Page 16 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Bit 1
Bit 0
0x67 (cont.)
Input
0x68
92-95
96-99
100-103
104
105
106
107
108-127
128-147
148-167
168-187
188-207
208-227
228-247
248-267
268-287
288-307
308-327
328-347
348-367
368-387
388-407
408-427
Get
Input Data
Byte
Bit 7
Get
Bit 6
Bit 5
Bit 4
Save Image
Bit 3
Auto Focus
Fast
Bit 2
Auto Focus
Full
Bit 1
Force
NUC
Bit 0
Auto
NUC
Reserved
Force Image
One Shot
Disable Alarm1
Reserved
Image Live
Image Freeze
DI 2
DI 1
DO 2
DO 1
Atmospheric
Temp. Graphic
Reflected
Temp. Graphic
Distance
Graphic
Emissivity
Graphic
Date/Time
Graphic
Scale Graphic
Camera Label
Graphic
Reserved
Reserved
Reserved
4
5
6
Alarm 8
Alarm 7
Alarm 2
Reserved
Reserved
Measurement
Mark Graphic
Alarm 6
Alarm 5
Alarm 4
Alarm 3
Set Configuration Preset (RESERVED FOR FUTURE USE)
Reserved
Reserved
Reserved
Reserved
Enable Overlay
Graphics
Relative Humidity
Graphic
Alarm 1
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
This alarm is the BATCH alarm. It has the ability to enable or disable all the other 8 alarms.
09/15/2009
Page 17 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Lens Graphic
Table 2-5
Implemented for
Service
code
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
Service name
09/15/2009
Page 18 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Implemented for
Service
code
Class level
Instance level
4BHex*
No
Yes
Service name
EtherNet/IP devices use the Execute PCCC Request service code (4BHex) to communicate with older controllers like the PLC5E and the SLC 5/05.
Table 1-7
PCCC
Register
Data
Bit 7
N10:0
Reserved
Bit 15
Reserved
Bit 7
N10:1
Atmospheric
Temp. Graphic
Bit 15
Reserved
Bit 6
Bit 5
Bit 13
Reserved
Bit 6
Reflected Temp.
Graphic
Bit 14
Reserved
Save Image
Bit 4
Bit 3
Image Live
Image Freeze
Bit 5
Bit 4
Distance
Graphic
Bit 13
Reserved
Emissivity
Graphic
Bit 12
Reserved
Auto Focus
Fast
Bit 11
Reserved
Bit 3
Date/Time
Graphic
Bit 11
Reserved
Description
Bit 2
Bit 1
Auto Focus
Full
Bit 10
Force
NUC
Bit 9
Reserved
Bit 2
Scale Graphic
Bit 10
Measurement
Mark Graphic
Bit 0
Auto
NUC
Bit 8
DO 2
Bit 1
Camera Label
Graphic
Bit 9
Lens Graphic
DO 1
Bit 0
Enable Overlay
Graphics
Bit 8
Relative Humidity
Graphic
Bit 7
Reserved
Bit 15
Bit 6
Reserved
Bit 14
Bit 5
Bit 4
Bit 3
Bit 2
Reserved
Reserved
Reserved
Reserved
Bit 13
Bit 12
Bit 11
Bit 10
Set Configuration Preset (RESERVED FOR FUTURE USE)
Bit 1
Reserved
Bit 9
Bit 0
N10:2
Bit 7
Reserved
Bit 15
Reserved
Bit 6
Reserved
Bit 14
Reserved
Bit 5
Reserved
Bit 13
Reserved
Bit 1
Reserved
Bit 9
Reserved
Bit 0
N10:3
Bit 4
Reserved
Bit 12
Reserved
Bit 3
Reserved
Bit 11
Reserved
09/15/2009
Bit 2
Reserved
Bit 10
Reserved
Page 19 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Reserved
Bit 8
Reserved
Bit 8
Reserved
Output
Integers
(Read/Write)
Table 1-8
PCCC
Register
Data
Bit 7
Reserved
N11:0
Bit 15
Bit 6
Force Image One
Shot
Bit 14
Disable Alarm1
Bit 7
N11:1
Atmospheric
Temp. Graphic
Bit 15
Reserved
Bit 7
N11:2
N11:3
Alarm 8
Bit 5
Save Image
Bit 13
Image Live
Reserved
Bit 6
Bit 5
Reflected Temp.
Graphic
Bit 14
Reserved
Bit 6
Distance
Graphic
Bit 13
Reserved
Bit 5
Alarm 7
Bit 15
Bit 14
Bit 7
Reserved
Bit 15
Reserved
Bit 6
Reserved
Bit 14
Reserved
Alarm 6
Bit 3
Auto Focus
Fast
Bit 11
Image Freeze
Bit 4
Bit 2
Emissivity
Graphic
Bit 12
Date/Time
Graphic
Bit 11
Reserved
Bit 4
Reserved
Bit 3
Alarm 5
Auto Focus
Full
Bit 10
DI 2
Bit 3
Alarm 4
Bit 1
Bit 9
Bit 2
Scale Graphic
Bit 10
Measurement
Mark Graphic
Bit 2
Alarm 3
Bit 12
Bit 11
Bit 10
Set Configuration Preset (RESERVED FOR FUTURE USE)
Bit 5
Bit 4
Bit 3
Bit 2
Reserved
Reserved
Reserved
Reserved
Bit 13
Bit 12
Bit 11
Bit 10
Reserved
Reserved
Reserved
Reserved
Delta Temperature 1
Delta Temperature 2
Delta Temperature 3
Delta Temperature 4
Delta Temperature 5
Delta Temperature 6
Internal Camera Temperature
Spot 1 Temperature
Box 1 Min Temperature
Box 1 Max Temperature
Box 1 Average Temperature
This alarm is the BATCH alarm. It has the ability to enable or disable all the other 8 alarms.
09/15/2009
Page 20 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Bit 0
Force
NUC
DI 1
Bit 13
N11:4-5
N11:6-7
N11:8-9
N11:10-11
N11:12-13
N11:14-15
N11:16-17
N11:18-19
N11:20-21
N11:22-23
N11:24-25
1
Bit 4
One Time
Image Auto
Adjust
Bit 12
Description
Auto
NUC
Bit 8
DO 2
Bit 1
Camera Label
Graphic
Bit 9
Lens Graphic
Bit 1
DO 1
Bit 0
Enable Overlay
Graphics
Bit 8
Relative Humidity
Graphic
Bit 0
Alarm 2
Alarm 1
Bit 9
Bit 8
Bit 1
Reserved
Bit 9
Reserved
Bit 0
Input
Integers
Little-Endian
Reserved
Bit 8
Reserved
(READ
ONLY)
Data
N11:26
N11:27
N11:28
N11:29
N11:30-31
N11:32-33
N11:34-35
N11:36-37
N11:38
N11:39
N11:40
N11:41
N11:42-43
N11:44-45
N11:46-47
N11:48-49
N11:50
N11:51
N11:52
N11:53
N11:54-55
N11:56-57
N11:58-59
N11:60-61
N11:62
N11:63
N11:64
N11:65
N11:66-77
Description
Input
Integers
Spot 3 Temperature
Box 3 Min Temperature
Box 3 Max Temperature
Little-Endian
(continued)
09/15/2009
Page 21 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Data
N11:78-89
N11:90-101
N11:102-113
N11:114-125
N11:126-137
N11:138-149
N11:150-161
N11:162-173
N11:174-185
N11:186-197
N11:198-209
N11:210-221
N11:222-233
N11:234-245
N11:246-257
Input
Integers
(continued)
PCCC
Register
Data
Bit 7
Reserved
Bit 15
Disable Alarm1
Little-Endian
Table 1-9
N12:0
Description
Bit 6
Bit 5
Save Image
Bit 13
Image Live
Bit 4
One Time
Image Auto
Adjust
Bit 12
Image Freeze
Description
Bit 3
Bit 2
Auto Focus
Fast
Bit 11
DI 2
Bit 1
Auto Focus
Full
Bit 10
Bit 9
DI 1
This alarm is the BATCH alarm. It has the ability to enable or disable all the other 8 alarms.
09/15/2009
Page 22 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Bit 0
Force
NUC
Auto
NUC
Bit 8
DO 2
Input
Integers
Big-Endian
DO 1
Data
Bit 7
N12:1
Atmospheric
Temp. Graphic
Bit 15
Reserved
Bit 6
Bit 5
Reflected Temp.
Graphic
Bit 14
Reserved
Bit 6
N12:2
Bit 7
Alarm 8
Bit 15
N12:3
Bit 7
Reserved
Bit 15
Reserved
Bit 6
Reserved
Bit 14
Reserved
Alarm 7
Bit 14
Distance
Graphic
Bit 13
Bit 3
Emissivity
Graphic
Bit 12
Bit 2
Date/Time
Graphic
Scale Graphic
Bit 10
Measurement
Mark Graphic
Bit 5
Bit 4
Bit 3
Bit 2
Alarm 6
Alarm 5
Alarm 4
Alarm 3
Bit 13
Bit 12
Bit 11
Bit 10
Set Configuration Preset (RESERVED FOR FUTURE USE)
Bit 5
Bit 4
Bit 3
Bit 2
Reserved
Reserved
Reserved
Reserved
Bit 13
Bit 12
Bit 11
Bit 10
Reserved
Reserved
Reserved
Reserved
Reserved
N12:4-5
N12:6-7
N12:8-9
N12:10-11
N12:12-13
N12:14-15
N12:16-17
N12:18-19
N12:20-21
N12:22-23
N12:24-25
N12:26
N12:27
N12:28
N12:29
N12:30-31
N12:32-33
N12:34-35
N12:36-37
Real Time Automation, Inc.
Bit 4
Description
Bit 11
Reserved
Reserved
Bit 1
Camera Label
Graphic
Bit 9
Lens Graphic
Bit 1
Alarm 2
Bit 9
Bit 1
Reserved
Bit 9
Reserved
Bit 0
Enable Overlay
Graphics
Bit 8
Relative Humidity
Graphic
Bit 0
Alarm 1
Bit 8
Bit 0
Reserved
Bit 8
Reserved
Delta Temperature 1
Delta Temperature 2
Input
Integers
Delta Temperature 3
Delta Temperature 4
Delta Temperature 5
Big-Endian
Delta Temperature 6
(continued)
09/15/2009
Page 23 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Data
N12:38
N12:39
N12:40
N12:41
N12:42-43
N12:44-45
N12:46-47
N12:48-49
N12:50
N12:51
N12:52
N12:53
N12:54-55
N12:56-57
N12:58-59
N12:60-61
N12:62
N12:63
N12:64
N12:65
N12:66-77
N12:78-89
N12:90-101
N12:102-113
N12:114-125
N12:126-137
N12:138-149
N12:150-161
N12:162-173
Description
Input
Integers
Big-Endian
(continued)
Spot 4 Temperature
09/15/2009
Page 24 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Data
N12:174-185
N12:186-197
N12:198-209
N12:210-221
N12:222-233
N12:234-245
N12:246-257
Input
Integers
Big-Endian
(continued)
Table 1-10
PCCC
Register
Data
F13:0
F13:1
F13:2
F13:3
F13:4
F13:5
F13:6
F13:7
F13:8
F13:9
F13:10
F13:11
F13:12
F13:13
F13:14
F13:15
F13:16
Description
Description
Delta Temperature 1
Delta Temperature 2
Delta Temperature 3
Delta Temperature 4
Delta Temperature 5
Delta Temperature 6
Internal Camera Temperature
Input Floats
Spot 1 Temperature
Box 1 Min Temperature
(READ
ONLY)
09/15/2009
Page 25 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Data
F13:17
F13:18
F13:19
F13:20
F13:21
F13:22
F13:23-26
F13:27-30
F13:31-34
F13:35-38
F13:39-42
F13:43-46
F13:47-50
F13:51-54
F13:55-58
F13:59-62
F13:63-66
F13:67-70
F13:71-74
F13:75-78
F13:79-82
F13:83-86
Description
Input Floats
(continued)
09/15/2009
Page 26 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Instance
Attribute
ID
Name
Data
Value
Data Type
Access
Rule
Class
(Instance 0)
Revision
UINT
Get
Instance 1
1
2
3
4
Status*
Configuration capability*
Configuration control*
Physical Link Object *
Structure of
Path Size
Path
DWORD
DWORD
DWORD
1
0
0
Get
Get
Get
Get
UINT
Array of Word
2
0x20F6
0x2401
Interface configuration*
Structure of
IP Address
Network Mask
Gateway Address
Name Server
Name Server 2
Domain Name Size
Domain Name
Host name*
Structure of
Host Name Size
Host Name
Get
UDINT
UDINT
UDINT
UDINT
UDINT
UINT
STRING
0
0
0
0
0
0
0
Get
UINT
STRING
0
0
For more details on these attributes, see Volume 2: EtherNet/IP Adaptation of CIP, Section 5-3.2 from ODVA.
09/15/2009
Page 27 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Table 2-12
Implemented for
Service
code
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
Service name
Instance
Attribute
ID
Data Type
Name
Data Value
Access
Rule
Class
(Instance 0)
Revision
UINT
Get
Instance 1
1
2
3
Interface speed*
Interface flags*
Physical address
UDINT
DWORD
USINT Array (6)
100
3
0
Get
Get
Get
For more details on these attributes, see Volume 2: EtherNet/IP Adaptation of CIP, Section 5-4.2 from ODVA.
Table 2-14
Implemented for
Service
code
Class level
Instance level
0EHex
Yes
Yes
09/15/2009
Service name
Get_Attribute_Single
Page 28 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Attribute
ID
Name
Data Value
Data Type
Access
Rule
Revision
UINT
Get
feet,
meter
C: Celsius
F: Fahrenheit
Get/Set
2
3
SHORT
STRING32
SHORT
STRING32
USINT
Comment
Instance 1
1.8.2
Get/Set
Get/Set
Implemented for
Service name
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
1.8.3
Description of Instance Attributes
1.8.3-1 Camera Distance Units
This attribute sets the display units for measuring distance within IR Monitor ONLY. Acceptable unit values are Feet and Meter.
1.8.3-2 Camera Temperature Units
This attribute sets the display units for measuring temperature within IR Monitor ONLY. Acceptable unit values are C for Celsius
and F for Fahrenheit.
1.8.3-3 Current Preset Profile
The attribute is reserved for future expansion and has no effect on the camera.
09/15/2009
Page 29 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Attribute
ID
Name
Data Type
Data Value
Access
Rule
Revision
UINT
Get
Auto NUC
BOOL
Get/Set
Force NUC *
BOOL
BOOL
BOOL
USINT
0: Disable
1: Enable
0: Do Nothing
1: Execute
0: Do Nothing
1: Full Auto Focus
0: Do Nothing
1: Fast Auto Focus
0-100
Focus Control
USINT
7
8
9
Focus Position
DINT
Digital Zoom
REAL
Enable Overlay Graphics BOOL
10
0: Do Nothing
1: Near (-)
2: Far (+)
0-max
1.0-8.0
0: Disable
1: Enable
0: Off
1: On
0: Off
1: On
Comment
Instance 1
11
BOOL
BOOL
09/15/2009
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Page 30 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Instance
Attribute
ID
12
13
14
15
16
17
18
19
1.9.2
Name
Data Type
Overlay Graphic
Date/Time
Overlay Graphic
Emissivity
Overlay Graphic
Distance
Overlay Graphic
Reflected Temp.
Overlay Graphic
Atmospheric Temp.
Overlay Graphic
Relative Humidity
Overlay Graphic Lens
Data Value
0: Off
Get/Set
1: On
BOOL
0: Off
Get/Set
1: On
BOOL
0: Off
Get/Set
1: On
BOOL
0: Off
Get/Set
1: On
BOOL
0: Off
Get/Set
1: On
BOOL
0: Off
Get/Set
1: On
BOOL
0: Off
Get/Set
1: On
Overlay Graphic
BOOL
0: Off
Get/Set
Measurement Mask
1: On
*Momentary Toggle- Read will always return 0
BOOL
Implemented for
Comment
Access
Rule
Service name
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
09/15/2009
Page 31 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 32 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 33 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
1.10
1.10.1
Class and Instance Attributes
The following tables contain the attribute and common services information for the Temperature Control Object.
Instance
Class
(Instance 0)
Attribute
ID
1
Name
Data
Type
Revision
UINT
2
100
Max Instance
Lens name
101
102
105
Write ds to
.image.ccase.query.ds
Write ap to
.image.ccase.query.ap
Write fi to
.image.ccase.query.fi
Case Query
106
107
UINT
SHORT
STRING32
SHORT
STRING32
SHORT
STRING32
SHORT
STRING32
SHORT
STRING32
SHORT
STRING32
SHORT
STRING32
BOOL
1
2
3
REAL
REAL
BOOL
103
104
Data Value
1
Access
Rule
Get
Get
Get
Get/Set
Get/Set
Get/Set
Get/Set
Get
Get/Set
0:Do Nothing
1:Execute
Get/Set
Instance 1-n
Kelvin
Get
Kelvin
Get
0: No
Get
1: Yes
*Momentary Toggle- Read will always return 0
09/15/2009
Page 34 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Commant
1.10.3
Implemented for
Service name
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
Yes
No
Set_Attribute_Single
09/15/2009
Page 35 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 36 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
1.11
1.11.1
Class and Instance Attributes
The following tables contain the attribute and common services information for Image Control Commands
Instance
Class
(Instance 0)
Attribute
ID
Data
Type
Name
Data Value
Access
Rule
Revision
UINT
Get
Palette
SHORT
STRING32
Get/Set
Palette Invert
BOOL
Quality
USINT
SHORT
STRING32
REAL
REAL
REAL
REAL
BOOL
11
Image Automatic
Adjust
Scale Min
Scale Max
Span
Level
One Time Image
Auto Adjust *
Image Adjust
Method
Image Freeze
12
Image Live
BOOL
bw.pal
iron.pal
rainbox.pal
0: Normal
1: Reverse
0: High (7)
1: Normal (20)
2: Low (31)
Auto,
Manual
Kelvin
Kelvin
Kelvin
Kelvin
0: Do Nothing
1:Execute
Linear,
Histogram
0: Off
1: On
0: Off
1: On
Instance 1
5
6
7
8
9
10
SHORT
STRING32
BOOL
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
Get/Set
09/15/2009
Page 37 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Comment
Instance
Attribute
ID
Data
Type
Name
13
Image State
14
Image Measure
Mode
15
Image
Measurement
One Shot *
Data Value
SHORT
STRING32
BOOL
BOOL
LIVE,
FREEZE
0:Normal
1:High Prio
One Shot
0: Do Nothing
1:Execute
Access
Rule
Comment
Get
Get/Set
Get/Set
1.11.3
Implemented for
Service name
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
09/15/2009
Page 38 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 39 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Attribute
ID
Data
Type
Name
Revision
UINT
Max Instance
UINT
Isotherm Enable
BOOL
Isotherm Type
3
4
Isotherm Level
Isotherm Color
SHORT
STRING32
REAL
SHORT
STRING32
Data
Value
1
Access
Rule
Get
Get
Instance 1
1.12.2
0: Off
1: On
Above
Below
Kelvin
palette1
palette2
red
green
blue
yellow
cyan
magenta
gray
Get/Set
Get/Set
Get/Set
Get/Set
09/15/2009
Page 40 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Comment
Implemented for
Service
code
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
Service name
1.12.3
Description of Class Attributes
Currently the camera is only enabled for one isotherm. In the future, there may be future instances for additional isotherms.
1.12.3-1 Max Instance
This attribute indicates how many isotherms are enabled in the camera and can be used.
1.12.4
Description of Instance Attributes
Currently the camera is only enabled for one isotherm. In the future, there may be future instances for additional isotherms.
1.12.4.1 Isotherm Enable
This attribute enables the isotherm control.
1.12.4.2 Isotherm Type
This attribute sets the type of the isotherm control. As of now, the acceptable values are Below and Above.
1.12.4.3 Isotherm Level
This attribute sets the value of the isotherm low temperature limit in Kelvin.
1.12.4.4 Isotherm Color
This attribute sets the color of the isotherm. Acceptable values are palette1, palette2, red, green, blue, yellow,
cyan, magenta, and gray.
09/15/2009
Page 41 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
1.13
1.13.1
Class and Instance Attributes
The following tables contain the attribute and common services information for Image File Storage.
Instance
Class
(Instance 0)
Attribute
ID
Name
Data Type
Revision
UINT
Store Image to
Camera Memory *
BOOL
Data Value
1
Access
Rule
Comment
Get
Instance 1
1.13.2
1.13.3
Implemented for
Service name
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
09/15/2009
Page 42 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
1.14
1.14.1
Class and Instance Attributes
The following tables contain the attribute and common services information for Alarm Settings
Instance
Attribute ID
Class
(Instance 0)
Data
Type
Name
Data
Value
1
Access
Rule
Revision
UINT
Max Instance
UINT
Alarm Status
BOOL
0: Off
1: On
Get
Alarm Status
BOOL
0: Off
1: On
Get
Comment
Get
Get
Instance 1 - 8
Instance 9
1.14.2
Implemented for
Class level
Instance level
Yes
Yes
0EHex
Service name
Get_Attribute_Single
1.14.3
Description of Class Attributes
Currently the camera is enabled for nine alarms. In the future, there may be more.
1.14.3-1 Max Instance
This attribute indicates how many alarms are enabled in the camera and can be used.
1.14.4
09/15/2009
Page 43 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 44 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
1.15
1.15.1
Class and Instance Attributes
The following tables contain the attribute and common services information for Object Parameters.
Instance
Class
(Instance 0)
Attribute
ID
Name
Data
Value
Data Type
Comment
Access
Rule
Revision
UINT
Get
Atmosphere
Temperature
Emissivity
Distance
Reflected
Temp
Relative
Humidity
Window
Transmission
Rate
Window
Temperature
REAL
Kelvin
Get/Set
REAL
REAL
REAL
0.001-1.0
Meters
Kelvin
Get/Set
Get/Set
Get/Set
REAL
0.0-1.0
Get/Set
REAL
0.001-1.0
Get/Set
REAL
Kelvin
Get/Set
Instance 1
2
3
4
5
6
1.15.2
Implemented for
Service name
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
09/15/2009
Page 45 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 46 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
1.16
1.16.1
Class and Instance Attributes
The following tables contain the attribute and common services information for Spot Meter.
Instance
Class
(Instance 0)
Attribute
ID
Name
Data
Type
Revision
UINT
Enable Local
Object
Parameter
Values
Reflected
Temp.
Emissivity
Distance
Enable
Spotmeter
Spotmeter
Pixel XPosition
Spotmeter
Pixel YPosition
Spotmeter
Temp.
Data Value
1
Access
Rule
Get
Get
Instance
1 - 20
2
3
4
5
6
BOOL
0: Disabled
1: Enabled
Get/Set
REAL
Kelvin
Get/Set
REAL
REAL
BOOL
0.001-1.0
Meters
0:Disable
1:Enable
Get/Set
Get/Set
Get/Set
DINT
Get/Set
DINT
Get/Set
REAL
Kelvin
Get
09/15/2009
Page 47 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Comment
Instance
Attribute
ID
9
1.16.2
Data
Type
Name
Spotmeter
Temp. State
USINT
Data Value
0: Undefined(U)
1: Valid (=)
2: Less Than(>)
3: More Than(<)
4: Outside(O)
5: Outside calib.(*)
6: Unstable(~)
7: Compenstated
with delta
correction(d)
Access
Rule
Comment
Get
Service
code
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
Service name
1.16.3
Description of Class Attributes
Currently the camera is enabled for 10 spotmeters (A310) or 5 spotmeters (Ax8).
1.16.3-1
Max Instance
This attribute indicates how many spotmeter objects are enabled in the camera and can be used.
1.16.4
09/15/2009
Page 48 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Meaning
Undefined
In the acceptable range
Less than the acceptable range
More than the acceptable range
Outside the acceptable range
Outside calibration
Unstable temperature
Temperature is compensated with delta correction
09/15/2009
Page 49 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
1.17
1.17.1
Class and Instance Attributes
The following tables contain the attribute and common services information for Box.
Instance
Class
(Instance 0)
Attribute
ID
Data
Type
Name
Data Value
1
Access
Rule
Revision
UINT
Get
Max Instance
UINT
BOOL
0: Disabled
1: Enabled
Get/Set
REAL
Kelvin
Get/Set
3
4
5
Enable Local
Object
Parameter
Values
Reflected
Temp.
Emissivity
Distance
Enable Box
REAL
REAL
BOOL
Get/Set
Get/Set
Get/Set
REAL
0.001-1.0
Meters
0:Disable
1:Enable
Kelvin
Get
Instance
1 - 20
Get
09/15/2009
Page 50 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Comment
Instance
Attribute
ID
Data
Type
Name
8
9
10
Box Avg.
Temp.
USINT
REAL
Data Value
0: Undefined(U)
1: Valid (=)
2: Less Than(>)
3: More Than(<)
4: Outside(O)
5: Outside calib.(*)
6: Unstable(~)
7: Compenstated
with delta
correction(d)
Kelvin
0: Undefined(U)
1: Valid (=)
2: Less Than(>)
3: More Than(<)
4: Outside(O)
5: Outside calib.(*)
6: Unstable(~)
7: Compenstated
with delta
correction(d)
Kelvin
Access
Rule
Get
Get
Get
Get
09/15/2009
Page 51 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Comment
Instance
Attribute
ID
Data
Type
Name
Data Value
Access
Rule
Get
11
Box Avg.
Temp. State
USINT
12
13
14
Box Position X
Box Position Y
Box Min Temp.
Position X
Box Min Temp.
Position Y
Box Max Temp.
Position X
Box Max Temp.
Position Y
Box Width
Box Height
Temp. Display
Options
DINT
DINT
DINT
Get/Set
Get/Set
Get
DINT
Get
DINT
Get
DINT
Get
DINT
DINT
USINT
Get/Set
Get/Set
Get/Set
15
16
17
18
19
20
0: Undefined(U)
1: Valid (=)
2: Less Than(>)
3: More Than(<)
4: Outside(O)
5: Outside calib.(*)
6: Unstable(~)
7: Compenstated
with delta
correction(d)
09/15/2009
Page 52 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Comment
Implemented for
Service name
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
1.17.3
Description of Class Attributes
Currently the camera is enabled for 10 boxes. In the future, there may be more.
1.17.3-1
Max Instance
This attribute indicates how many box objects are enabled in the camera and can be used.
1.17.4
09/15/2009
Page 53 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Meaning
Undefined
In the acceptable range
Less than the acceptable range
More than the acceptable range
Outside the acceptable range
Outside calibration
Unstable temperature
Temperature is compensated with delta correction
09/15/2009
Page 54 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Meaning
Undefined
In the acceptable range
Less than the acceptable range
More than the acceptable range
Outside the acceptable range
Outside calibration
Unstable temperature
Temperature is compensated with delta correction
09/15/2009
Page 55 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
1.18
1.18.1
Class and Instance Attributes
The following tables contain the attribute and common services information for Temperature Difference.
Instance
Class
(Instance 0)
Attribute
ID
1
Data
Type
Name
Revision
UINT
2
100
Max Instance
Internal Camera
Temp.
UINT
REAL
Enable Temp.
Difference
Value of Temp.
Difference
Difference
Temp. Valid
State
BOOL
Data Value
1
Access
Rule
Get
Get
Get
Instance 1-6
2
3
1.18.2
REAL
USINT
0:Disable
1: Enable
Kelvin
Get/Set
0: Undefined(U)
1: Valid (=)
2: Less Than(>)
3: More Than(<)
4: Outside(O)
5: Outside calib.(*)
6: Unstable(~)
7: Compenstated w/
delta correction(d)
Get
Get
09/15/2009
Page 56 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Comment
Service
code
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
Service name
1.18.3
Description of Class Attributes
Currently the camera is enabled for six boxes. In the future, there may be more.
1.18.3-1
Max Instance
This attribute indicates how many box objects are enabled in the camera and can be used.
1.18.3-2
Internal Camera Temperature
This attribute indicates the internal temperature of the camera in Kelvin.
1.18.4
Meaning
Undefined
In the acceptable range
Less than the acceptable range
More than the acceptable range
Outside the acceptable range
Outside calibration
Unstable temperature
Temperature is compensated with delta correction
09/15/2009
Page 57 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
1.19
1.19.1
Class and Instance Attributes
The following tables contain the attribute and common services information for Temperature Difference.
Instance
Class
(Instance 0)
Attribute
ID
Name
Data Value
Data Type
Access
Rule
Revision
UINT
Get
DI 1
BOOL
Get
DI 2
BOOL
101
DO 1
BOOL
102
DO 2
BOOL
0:Off
1:On
0:Off
1:On
0:Low
1:High
0:Low
1:High
Comment
Instance 1
1.19.2
1.19.3
Get
Get/Set
Get/Set
Implemented for
Service name
Class level
Instance level
0EHex
Yes
Yes
Get_Attribute_Single
10Hex
No
Yes
Set_Attribute_Single
09/15/2009
Page 58 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 59 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Attribute
ID
1
Name
Revision
Data Value
Data Type
1
UINT
Access
Rule
Comment
Get
Implemented for
Service name
Class level
Instance level
32Hex
No
Yes
Read_BOOL
33Hex
No
Yes
Write_BOOL
34Hex
No
Yes
Read_INT32
35Hex
No
Yes
Write_INT32
36Hex
No
Yes
Read_DOUBLE
37Hex
No
Yes
Write_DOUBLE
38Hex
No
Yes
Read_ASCII
39Hex
No
Yes
Write_ASCII
Class
Instance
0x32
0x70
0x01
Attribute
Data
14 2E 70 6F 77 65 72 2E 73 74 61 74 65 73 2E 64 69 67 69 6E 31
09/15/2009
Page 60 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Class
Instance
0x33
0x70
0x01
Attribute
Data
1A 2E 69 6D 61 67 65 2E 73 65 72 76 69 63 65 73 2E 6E 75 63 2E 63 6F 6D 6D 69 74 01
Class
Instance
0x34
0x70
0x01
Attribute
Data
16 2E 73 79 73 74 65 6D 2E 66 6F 63 75 73 2E 70 6F 73 69 74 69 6F 6E
Class
Instance
0x35
0x70
0x01
Attribute
Data
16 2E 73 79 73 74 65 6D 2E 66 6F 63 75 73 2E 70 6F 73 69 74 69 6F 6E 7D 00 00 00
09/15/2009
Page 61 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Class
Instance
0x36
0x70
0x01
Attribute
Data
16 2E 69 6D 61 67 65 2E 7A 6F 6F 6D 2E 7A 6F 6F 6D 46 61 63 74 6F 72
Class
Instance
0x37
0x70
0x01
Attribute
Data
16 2E 69 6D 61 67 65 2E 7A 6F 6F 6D 2E 7A 6F 6F 6D 46 61 63 74 6F 72 00 00 00 41
Class
Instance
0x38
0x70
0x01
Attribute
Data
16 2E 69 6D 61 67 65 2E 63 6F 6E 74 61 64 6A 2E 61 64 6A 4D 6F 64 65
Class
Instance
0x39
0x70
0x01
Attribute
Data
16 2E 69 6D 61 67 65 2E 63 6F 6E 74 61 64 6A 2E 61 64 6A 4D 6F 64 65 04 41 75 74 6F
09/15/2009
Page 62 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 63 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 64 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Reserved
Bit 15
Bit 6
Force Image One
Shot
Bit 14
Reserved
Bit 7
Atmospheric
Temp. Graphic
Bit 15
Image Mode
Bit 6
Reflected Temp.
Graphic
Bit 14
Reserved
Bit 7
Reserved
Bit 6
Reserved
Reserved
Bit 5
Save Image
Bit 13
Image Live
Bit 5
Image Freeze
Bit 4
Distance
Graphic
Bit 13
Reserved
Bit 5
Emissivity
Graphic
Bit 14
Bit 13
Bit 7
Reserved
Bit 15
Reserved
Bit 6
Reserved
Bit 14
Reserved
Bit 5
Reserved
Bit 13
Reserved
Auto Focus
Fast
Bit 11
Reserved
Date/Time
Graphic
Bit 11
Reserved
Bit 4
Reserved
Bit 3
Bit 3
Bit 12
Bit 15
Bit 4
One Time
Image Auto
Adjust
Bit 12
Reserved
Bit 3
Reserved
Data Access
Bit 2
Bit 1
Auto Focus
Full
Bit 10
Reserved
Bit 2
Scale Graphic
DO 2
Bit 1
Camera Label
Graphic
Bit 9
Bit 2
Bit 1
Reserved
Bit 2
Reserved
Bit 10
Reserved
09/15/2009
Lens Graphic
Read/Write
DO 1
Bit 0
Enable Overlay
Graphics
Read/Write
Bit 8
Relative Humidity
Graphic
Bit 0
Reserved
Reserved
Bit 9
Bit 8
Bit 1
Reserved
Bit 9
Reserved
Bit 0
Page 65 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Auto
NUC
Bit 8
Bit 10
Measurement
Mark Graphic
Reserved
Bit 3
Reserved
Bit 11
Reserved
Force
NUC
Bit 9
Bit 12
Bit 11
Bit 10
Set Configuration Preset (RESERVED FOR FUTURE USE)
Bit 4
Reserved
Bit 12
Reserved
Bit 0
Reserved
Bit 8
Reserved
Read/Write
Read/Write
0x2000
Register 401020:
0x4397
Register
40XXXX
Bit 7
1001
Reserved
Bit 15
Disable Alarm
Bit 7
1002
Atmospheric
Temp. Graphic
Bit 15
Reserved
Bit 7
1003
1004
Data
Access
Data
Alarm 8
Bit 6
Bit 5
Save Image
Bit 13
Image Mode
Image Live
Bit 6
Bit 5
Reflected Temp.
Graphic
Bit 14
Reserved
Bit 6
Distance
Graphic
Bit 13
Reserved
Emissivity
Graphic
Bit 14
Bit 13
Bit 7
Reserved
Bit 15
Reserved
Bit 6
Reserved
Bit 14
Reserved
Bit 5
Reserved
Bit 13
Reserved
Bit 2
Auto Focus
Fast
Bit 11
DI 2
Date/Time
Graphic
Bit 11
Reserved
Bit 4
Alarm 6
Bit 3
Bit 3
Bit 12
Bit 15
Reserved
Bit 3
Alarm 5
Alarm 4
Bit 1
Auto Focus
Full
Bit 10
Bit 4
Reserved
Bit 12
Reserved
Bit 3
Reserved
Bit 11
Reserved
DI 1
Bit 2
Scale Graphic
Bit 1
Camera Label
Graphic
Bit 1
Bit 2
Reserved
Bit 10
Reserved
Read Only
Lens Graphic
DO 1
Bit 0
Enable Overlay
Graphics
Read Only
Bit 8
Relative Humidity
Graphic
Bit 0
Alarm 2
Alarm 1
Bit 9
Bit 8
Bit 1
Reserved
Bit 9
Reserved
Bit 0
Reserved
Bit 8
Read Only
Read Only
Reserved
Read Only
Read Only
Read Only
Delta Temperature 3
Page 66 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
DO 2
Bit 2
Alarm 3
Auto
NUC
Bit 8
Bit 9
Delta Temperature 2
09/15/2009
Force
NUC
Bit 10
Measurement
Mark Graphic
Delta Temperature 1
1007-1008
1009-1010
Bit 0
Bit 9
Bit 12
Bit 11
Bit 10
Set Configuration Preset (RESERVED FOR FUTURE USE)
1005-1006
Image Freeze
Bit 4
Bit 5
Alarm 7
Bit 4
One Time
Image Auto
Adjust
Bit 12
Data
1011-1012
Delta Temperature 4
1013-1014
1015-1016
1017-1018
1019-1020
1021-1022
1023-1024
1025-1026
1027
1028
1029
1030
1031-1032
1033-1034
1035-1036
1037-1038
1039
1040
1041
1042
1043-1044
1045-1046
1047-1048
1049-1050
1051
1052
1053
1054
Data
Access
Delta Temperature 5
Delta Temperature 6
Internal Camera Temperature
Spot 1 Temperature
Box 1 Min Temperature
Box 1 Max Temperature
Box 1 Average Temperature
Spot 1 Temperature Valid State
Box 1 Min Temperature Valid State
Box 1 Max Temperature Valid State
Box 1 Avg Temperature Valid State
Spot 2 Temperature
Box 2 Min Temperature
Box 2 Max Temperature
Box 2 Average Temperature
Spot 2 Temperature Valid State
Box 2 Min Temperature Valid State
Box 2 Max Temperature Valid State
Box 2 Avg Temperature Valid State
Spot 3 Temperature
Box 3 Min Temperature
Box 3 Max Temperature
Box 3 Average Temperature
Spot 3 Temperature Valid State
Box 3 Min Temperature Valid State
Box 3 Max Temperature Valid State
Box 3 Avg Temperature Valid State
09/15/2009
Page 67 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Data
Data
Access
1055-1056
Spot 4 Temperature
Read Only
1057-1058
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
1059-1060
1061-1062
1063
1064
1065
1066
1067-1078
1079-1090
1091-1102
1103-1114
1115-1126
1127-1138
1139-1150
1151-1162
1163-1174
1175-1186
1187-1198
1199-1210
1211-1222
1223-1234
1235-1246
1247-1258
09/15/2009
Page 68 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
0x4397
Register 402020:
0x2000
Register
40XXXX
Data
Bit 7
2001
Reserved
Bit 15
Disable Alarm
Bit 7
2002
Atmospheric
Temp. Graphic
Bit 15
Reserved
Bit 7
2003
2004
Alarm 8
Bit 6
Bit 5
Save Image
Bit 13
Image Live
Bit 5
Reflected Temp.
Graphic
Bit 14
Reserved
Bit 6
Distance
Graphic
Bit 13
Reserved
Emissivity
Graphic
Bit 14
Bit 13
Bit 7
Reserved
Bit 15
Reserved
Bit 6
Reserved
Bit 14
Reserved
Bit 5
Reserved
Bit 13
Reserved
Bit 2
Auto Focus
Fast
Bit 11
Reserved
Bit 3
Alarm 5
Bit 10
Bit 9
Bit 2
2005-2006
Bit 3
Reserved
Bit 11
Reserved
Bit 1
Camera Label
Graphic
Bit 9
Bit 2
Bit 1
Lens Graphic
Alarm 3
Bit 2
Reserved
Bit 10
Reserved
Enable Overlay
Graphics
Read Only
Bit 8
Relative Humidity
Graphic
Bit 0
Alarm 1
Bit 8
Bit 1
Reserved
Bit 9
Reserved
Bit 0
Reserved
Bit 8
Read Only
Read Only
Reserved
Read Only
Read Only
Read Only
Delta Temperature 3
Page 69 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Bit 0
Bit 9
Delta Temperature 2
09/15/2009
DO 1
Alarm 2
Delta Temperature 1
2007-2008
2009-2010
Read Only
Bit 8
Bit 10
Measurement
Mark Graphic
Alarm 4
Auto
NUC
DO 2
Scale Graphic
Bit 12
Bit 11
Bit 10
Set Configuration Preset (RESERVED FOR FUTURE USE)
Bit 4
Reserved
Bit 12
Reserved
Bit 0
Force
NUC
DI 1
Date/Time
Graphic
Reserved
Bit 1
Auto Focus
Full
DI 2
Bit 11
Bit 4
Alarm 6
Bit 3
Bit 3
Bit 12
Bit 15
Image Freeze
Bit 4
Bit 5
Alarm 7
Bit 4
One Time
Image Auto
Adjust
Bit 12
Data Access
Data
Data Access
2011-2012
Delta Temperature 4
Read Only
2013-2014
Delta Temperature 5
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
2015-2016
2017-2018
2019-2020
2021-2022
2023-2024
2025-2026
2027
2028
2029
2030
2031-2032
2033-2034
2035-2036
2037-2038
2039
2040
2041
2042
2043-2044
2045-2046
2047-2048
2049-2050
2051
2052
2053
2054
Delta Temperature 6
Internal Camera Temperature
Spot 1 Temperature
Box 1 Min Temperature
Box 1 Max Temperature
Box 1 Average Temperature
Spot 1 Temperature Valid State
Box 1 Min Temperature Valid State
Box 1 Max Temperature Valid State
Box 1 Avg Temperature Valid State
Spot 2 Temperature
Box 2 Min Temperature
Box 2 Max Temperature
Box 2 Average Temperature
Spot 2 Temperature Valid State
Box 2 Min Temperature Valid State
Box 2 Max Temperature Valid State
Box 2 Avg Temperature Valid State
Spot 3 Temperature
Box 3 Min Temperature
Box 3 Max Temperature
Box 3 Average Temperature
Spot 3 Temperature Valid State
Box 3 Min Temperature Valid State
Box 3 Max Temperature Valid State
Box 3 Avg Temperature Valid State
09/15/2009
Page 70 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
Data
Data Access
2055-2056
Spot 4 Temperature
Read Only
2057-2058
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
Read Only
2059-2060
2061-2062
2063
2064
2065
2066
2067-2078
2079-2090
2091-2102
2103-2114
2115-2126
2127-2138
2139-2150
2151-2162
2163-2174
2175-2186
2187-2198
2199-2210
2211-2222
2223-2234
2235-2246
2247-2258
09/15/2009
Page 71 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 72 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
If you write every register but the first in the group, then there is no need to send the size in the request. You can just write
the new values:
09/15/2009
Page 73 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21
09/15/2009
Page 74 of 74
2014, FLIR Systems Publ. No.: T559874, rev. 1.21