Remote Automation Solutions ROC Plus Protocol Specification Manual Manuals & Guides

Remote Automation Solutions
Part D301180X012
March 2021
ROC Plus Protocol Specifications Manual
ii Revised March-2021
System Training
A well-trained workforce is critical to the success of your operation. Knowing how to correctly install, configure, program, calibrate, and trouble-shoot your Emerson equipment provides your engineers and technicians with the skills and confidence to optimize your investment. Remote Automation Solutions offers a variety of ways for your personnel to acquire essential system expertise. Our full-time professional instructors can conduct classroom training at several of our corporate offices, at your site, or even at your regional Emerson office. You can also receive the same quality training via our live, interactive Emerson Virtual Classroom and save on travel costs. For our complete schedule and further information, contact the Remote Automation Solutions Training Department at 800-338-8158 or email us at education@emerson.com.
ROC Plus Protocol Specifications Manual
Revised March-2021 Contents iii
Contents
ROC Plus Protocol Specifications Manual i
Chapter 1 – Introduction 1-1
1.1 Manual Organization 1-1
1.2 General Protocol Message Format 1-2
1.3 Broadcast 1-3
1.4 Calculating Data Offsets 1-4
Chapter 2 – Opcodes 2-1
2.1 Opcode Overview ...........................................................................................................................2-1
2.2 Opcode 6, System Configuration ...................................................................................................2-2
2.3 Opcode 7, Read Real-time Clock ................................................................................................ 2-11
2.4 Opcode 8, Set Real-time Clock ................................................................................................... 2-11
2.5 Opcode 10, Read Configurable Opcode Point Data ................................................................... 2-12
2.6 Opcode 11, Write Configurable Opcode Point Data ................................................................... 2-12
2.7 Opcode 17, Login Request ......................................................................................................... 2-13
2.8 Opcode 24, Store and Forward ................................................................................................... 2-14
2.9 Opcode 50, Request I/O Point Position ...................................................................................... 2-14
2.11 Opcode 105, Request Today’s and Yesterday’s Min/Max Values .............................................. 2-20
2.12 Opcode 108, Request History Tag and Periodic Index ............................................................... 2-22
2.13 Opcode 118, Request Alarm Data .............................................................................................. 2-22
2.14 Opcode 119, Request Event Data .............................................................................................. 2-25
2.15 Opcode 135, Request Single History Point Data ........................................................................ 2-29
2.16 Opcode 136, Request Mutiple History Point Data ...................................................................... 2-30
2.17 Opcode 137, Request History Index for a Day ........................................................................... 2-32
2.18 Opcode 138, Request Daily and Periodic History for a Day ....................................................... 2-32
2.19 Opcode 139, History Information Data ........................................................................................ 2-33
2.20 Opcode 166, Set Single Point Parameters ................................................................................. 2-35
2.21 Opcode 167, Request Single Point Parameters ......................................................................... 2-35
2.22 Opcode 180, Request Parameters.............................................................................................. 2-36
2.23 Opcode 181, Write Parameters ................................................................................................... 2-36
2.24 Opcode 203, General File Transfer ............................................................................................. 2-37
2.25 Opcode 205, Peer-to-Peer Network Messages .......................................................................... 2-39
2.26 Opcode 206, Read Transaction History Data ............................................................................. 2-40
2.27 Opcode 224, SRBX Signal .......................................................................................................... 2-41
2.28 Opcode 225, Acknowledge SRBX .............................................................................................. 2-42
2.29 Opcode 255, Error Indicator ........................................................................................................ 2-42
Chapter 3 – Parameter Lists for Point Types 3-1
3.1 Type, Location/Logical, and Parameter (TLPs) 3-1
3.2 Logical/Location Details 3-1
3.3 Binary Field (BIN) Example 3-2
3.4 Point Type Table Fields 3-3
3.4.1 Point Type 82: Virtual Discrete Outputs ...........................................................................3-4
3.4.2 Point Type 84: HART Extended Point Type ....................................................................3-8
3.4.3 Point Type 85: HART Point Type .................................................................................. 3-16
3.4.4 Point Type 91: System Variables: ................................................................................. 3-34
3.4.5 Point Type 92: Logon Parameters ................................................................................ 3-39
3.4.6 Point Type 95: Communication Ports ........................................................................... 3-42
iv Contents Revised March-2021
3.4.7 Point Type 96: FST Parameters .....................................................................................3-47
3.4.8 Point Type 97: FST Register Tags .................................................................................3-50
3.4.9 Point Type 98: Soft Point Parameters ............................................................................3-51
3.4.10 Point Type 99: Configurable Opcode Table ...................................................................3-54
3.4.11 Point Type 100: Power Control Parameters ...................................................................3-56
3.4.12 Point Type 101: Discrete Inputs ......................................................................................3-59
3.4.13 Point Type 102: Discrete Outputs ...................................................................................3-61
3.4.14 Point Type 103: Analog Inputs ........................................................................................3-64
3.4.15 Point Type 104: Analog Outputs .....................................................................................3-68
3.4.16 Point Type 105: Pulse Inputs ..........................................................................................3-70
3.4.17 Point Type 106: RTD ......................................................................................................3-73
3.4.18 Point Type 107: Thermocouple .......................................................................................3-77
3.4.19 Point Type 108: Multi-Variable Sensor ...........................................................................3-80
3.4.20 Point Type 109: System Analog Inputs...........................................................................3-88
3.4.21 Point Type 110: PID Control Parameters .......................................................................3-93
3.4.22 Point Type 111: Sampler/Odorizer Parameters ............................................................3-100
3.4.23 Point Type 112: Station Parameters .............................................................................3-101
3.4.24 Point Type 113: Orifice Meter Run Configuration .........................................................3-108
3.4.25 Point Type 114: Orifice Meter Run Values ...................................................................3-115
3.4.26 Point Type 115: Turbine Meter Run Configuration .......................................................3-119
3.4.27 Point Type 116: Turbine Meter Run Values .................................................................3-126
3.4.28 Point Type 117: Modbus Configuration Parameters .....................................................3-130
3.4.29 Point Type 118: Modbus Register to TLP Mapping ......................................................3-133
3.4.30 Point Type 119: Modbus Event, Alarm, and History Table ...........................................3-147
3.4.31 Point Type 120: Modbus Master Modem Configuration ...............................................3-156
3.4.32 Point Type 121: Modbus Master Table .........................................................................3-158
3.4.33 Point Type 122: DS800 Configuration ..........................................................................3-169
3.4.34 Point Type 123: Security – Group Configuration ..........................................................3-172
3.4.35 Point Type 124: History Segment Configuration ..........................................................3-174
3.4.36 Point Type 125: History Segment 0 Point Configuration ..............................................3-176
3.4.37 Point Type 126: History Segment 1 Point Configuration ..............................................3-178
3.4.38 Point Type 127: History Segment 2 Point Configuration ..............................................3-180
3.4.39 Point Type 128: History Segment 3 Point Configuration ..............................................3-182
3.4.40 Point Type 129: History Segment 4 Point Configuration ..............................................3-184
3.4.41 Point Type 130: History Segment 5 Point Configuration ..............................................3-186
3.4.42 Point Type 131: History Segment 6 Point Configuration ..............................................3-188
3.4.43 Point Type 132: History Segment 7 Point Configuration ..............................................3-190
3.4.44 Point Type 133: History Segment 8 Point Configuration ..............................................3-192
3.4.45 Point Type 134: History Segment 9 Point Configuration ..............................................3-194
3.4.46 Point Type 135: History Segment 10 Point Configuration ............................................3-196
3.4.47 Point Type 136: ROC Clock ..........................................................................................3-198
3.4.48 Point Type 137: Internet Configuration Parameters .....................................................3-200
3.4.49 Point Type 138: User C++ Host Parameters ................................................................3-207
3.4.50 Point Type 139: Smart I/O Module Information ............................................................3-208
3.4.51 Point Type 140: Alternating Current Input / Output ......................................................3-214
3.4.52 Point Type 141: Advance Pulse Module .......................................................................3-223
3.4.53 Point Type 142: History Segment 11 Point Configuration ............................................3-236
3.4.54 Point Type 143: History Segment 12 Point Configuration ............................................3-238
3.4.55 Point Type 144: Transactional History Configuration Point Type .................................3-240
3.4.56 Point Type 145: Transactional History Point Configuration Point Type ........................3-241
3.4.57 Point Type 172: RTU Network Discovery List Point Type ............................................3-242
3.4.58 Point Type 173: Network Commissioned List Point Type .............................................3-243
3.4.59 Point Type 174: Network Export Data Point Type ........................................................3-245
3.4.60 Point Type 175: Network Import Data Point Type ........................................................3-246
3.4.61 Point Type 176: IEC62591 Live List Point Type ...........................................................3-247
3.4.62 Point Type 177: IEC62591 Commissioned List Point Type ..........................................3-248
Chapter 4 – CRC-16 Code 4-1
ROC Plus Protocol Specifications Manual
Revised March-2021 Contents v
Chapter 5 IEEE Floating Point Format 5-1
Chapter 6 – Spontaneous Report-By-Exception 6-1
Chapter 7 – Device-To-Device Communications 7-1
vi Contents Revised March-2021
[This page is intentionally left blank.]
ROC Plus Protocol Specifications Manual
Revised March-2021 Introduction 1-1
Chapter 1 – Introduction
This manual provides information required to understand the ROC Plus protocol and its implementation within the ROC800-Series (“ROC800”) controller. It is written for personnel needing to implement a ROC Plus Protocol driver or as a reference to understanding the ROC800 controller. This manual is intended for users experienced in the development of communication drivers. The protocol provides access to database configuration, real-time clock, event and alarm logs, and historically archived data.
The ROC Plus database is broken into individual parameters. Each database parameter is uniquely associated by parameter number and point type. See Chapter 3, Parameter Lists for Point Types, for detailed information.
1.1 Manual Organization
This manual is organized into the following chapters:
Chapter
Description
Chapter 1 Introduction
Describes this manual and provides a summary of the general protocol message format, summary of each opcode, and how to calculate data offsets.
Chapter 2 Opcodes
Lists each opcode the ROC Plus protocol uses.
Chapter 3 Parameter Lists for Point Types
Describes ROC Plus protocol point types and data types.
Chapter 4 CRC-16 Code
Provides information concerning the cyclical redundancy check the ROC protocol uses.
Chapter 5 IEEE Floating Point Format
Provides information about the binary representation of floating-point numbers.
Chapter 6 Spontaneous Report­by-Exception
Provides information on the ROC800’s Spontaneous Report-by-Exception (RBX or RBX) function.
Chapter 7 ROC to ROC Communications
Provides information detailing store and forward options in the ROC800.
Index
Provides an alphabetic listing of items and topics contained in this manual.
1-2 Introduction Revised March-2021
1.2 General Protocol Message Format
Figure 1-1 shows the various ROC and host protocol message formats. The ROC Plus protocol is a request/response protocol, in which you use an opcode to make a request to which the device responds.
General Message Format - Station A”’ Polling Station “B for Data/Action:
Destination (B)
Source (A)
Opcode
Data
Length
m Data Bytes
CRC
unit
group
unit
group
# of
bytes
d1
d2
d3 – – – –
dm
LSB
MSB
General Message Format - Station B Responding to Station A:
Destination (A)
Source (B)
Opcode
Data
Length
n Data Bytes
CRC
unit
group
unit
group
# of
bytes
d1
d2
d3 – – – –
dn
LSB
MSB
Figure 1-1. General Message Format
A message generally contains the following fields, in order from left to right:
Field
Description
Destination
Specifies the address for the destination device. Destination has two components:
Unit
One-byte unit code for the station address. The unit code for a ROC address is user-configurable. For a host, this must be a unique number. 0
represents “broadcast within group” and
240 is the “direct connect address.”
Group
Indicates the group code for the station address. This is user-configurable and usually set to 2.
Source
Specifies the address for the source device. Source has two components:
Unit
One-byte unit code for the station address. The unit code for a ROC address is user-configurable. For a host, this must be a unique number. 0
represents “broadcast within group” and
240 is the “direct connect address.”
Group
Indicates the group code for the station address. This is user-configurable and usually set to 2.
Opcode
Defines the operation code (opcode) action to perform.
# of bytes
Indicates the number of bytes in the data byte field, consisting of the path, desired opcode, number of data bytes for the desired message, and the desired message itself.
ROC Plus Protocol Specifications Manual
Revised March-2021 Introduction 1-3
Field
Description
Data Bytes
Contains messages of varying lengths, consisting of the path, desired opcode, number of data bytes for the desired message, and the message itself.
CRC
Confirms validity of message transmission.
LSB
Least significant byte.
MSB
Most significant byte.
Messages are of variable length. The first six data bytes provide the header information including: destination, source, opcode, and data length (number of bytes). Data bytes and a 2-byte CRC follow the header. The CRC is calculated using the header information and the data bytes. The total length of a message equals the number of data bytes transmitted plus eight overhead bytes (6-byte header information and 2­byte CRC).
Figure 1-2 provides examples of the messages exchanged if the host requests the current time and date from ROC13 of Group 5.
Host Request to ROC800:
ROC Address
Host Address
Opcode
Data
Length
CRC
unit
group
unit
group
# of
bytes
LSB
MSB
13 5 1 0 7 0 1
M
ROC800 Response to Host:
Host Address
ROC Address
Opcode
Data
Length
8 Data Bytes
CRC
unit
group
unit
group
# of
bytes
d1
d2
d3 – – – –-
dn
LSB
MSB
1 0 13 5 7
8
sec
min
hr
day
mo
yr
lyr
dwk
X1
X2
X1 and X2 depend on the date and time value.
Figure 1-2. Request/Response Example
Note: Addresses 240,240 and 0,x are reserved and should not be used.
Certain opcodes only send or set data and do not receive data back from the ROC800-Series. For example, Opcode 8 requests the ROC to set the time and date. The host transmits data bytes defining the new time and date. The ROC resets the time and date and sends back an acknowledgment in which the opcode is repeated, but no data bytes are transmitted back. All acknowledgments are 8-byte messages that repeat the opcode received but do not transmit any data bytes.
1.3 Broadcast
ROC800 firmware version 1.10 and higher supports message broadcasting. A broadcast message is an opcode that is sent to a unit of
0. In this case, all ROC800s with the group matching the request accept
1-4 Introduction Revised March-2021
the opcode and process it (regardless of the unit designation that each ROC800 may have). The ROC800 does not respond to the request.
For example, you may need to synchronize several ROC800s to the same date and time. If the ROC800s were connected to the same radio link and configured for the same group, a host could send an opcode 8 (Set Real-Time Clock) request to Unit 0 that would then set all of the ROC800s configured in this group to the same date and time.
1.4 Calculating Data Offsets
A data byte offset is the offset (zero-based) from the beginning of a transmit or receive buffer for the data items that comprise the opcode data. The offset of the first data item is always 6 to allow for the header information (bytes 0-5).
Certain data offset values are determined based on the ROC800’s configuration, such as for Opcode 0. The data byte offset for each item may be calculated. To calculate the next data offset value, add the previous offset value to the length of the previous data item:
Offset = Previous Offset + Length of Previous Data Item
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-1
Chapter 2 – Opcodes
This chapter details each ROC Plus protocol opcode.
2.1 Opcode Overview
Table 2-1 summarizes and briefly describes each opcode. The tables in this section provide detailed descriptions of the various opcodes and their uses. In some cases, the number of data bytes returned for an opcode varies.
Note: In the following opcode tables, a period (“.”) in either the Data
columns or the Description of Data field indicates a repetitionof the preceeding item for the necessary number of times.
Table 2-1. Summary of Opcodes
Opcode
Description
6
Sends ROC800 configuration.
7
Sends current time and date.
8
Sets new time and date.
10
Sends data from configurable opcode tables.
11
Sets data in configurable opcode tables.
17
Sets operator identification.
24
Stores and forwards.
50
Requests IO point position array.
100
Reads user-defined point information (Command 11)
105
Sends history point definition, min/max data, and current values for specified history point.
108
Sends tag and current history period for specified history points.
118
Sends specified number of alarms starting at specified alarm index.
119
Sends specified number of events starting at specified event index.
135
Requests history point data.
136
Requests history index data. .
137
Requests history index for a day.
138
Requests daily and periodic history for a day.
139
Requests various types of information from history
166
Sets specified contiguous block of parameters.
167
Sends specified contiguous block of parameters.
180
Sends specified parameters.
181
Sets specified parameters.
203
File transfer to and from ROC800.
205
Sends a passthru message to a device on the RTU Network
206
Reads transaction history data
224
Sends Report-by-Exception (SRBX) message to host.
225
Acknowledges Report-by-Exception message from ROC800.
255
Transmits ROC800 error messages in response to a request with invalid parameters or format.
ROC Plus Protocol Specifications Manual
2-2 Opcodes Revised March-2021
2.2 Opcode 6, System Configuration
Opcode 6 obtains the current configuration of the ROC800. This opcode follows a similar but slightly different format compared to previous products.
Version
Description
1.00
Introduced
1.20
Updated: added offset 103, point type 138
2.00
Updated: defined offset 10, Logical Compatibility Mode
2.02
Updated: added point types, offsets 104-220; defined offset 11, Opcode 6 revision
3.00
Updated: defined offset 12, ROC Sub-type
Table 2-2: Opcode 6, System Configuration
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 6: System Configura­tion
6 No data bytes
6
1
The system mode the unit is currently operating in. 0 = Firmware Update Mode – Extremely limited functionality is available. 1 = Run Mode
7
2
Comm Port or Port Number that this request arrived on. This is not defined if the above value (offset 6) is 0.
9 1 Security Access Mode for the port
the request was received on.
10
1
Logical Compatibility Status – Version 2.00 See [Point Type 91,Logical 0,Parameter 50]: 0 = 16 points per slot (160 bytes total) – Compatibility Mode is 0 & 9 module slots max 1 = 16 points per slot (240 bytes total) – Compatibility Mode is 0 & 14 module slots max. NOTE: The 15th module slot cannot be used. 2 = 8 points per slot (224 bytes total) – Compatibility Mode is 1 & 27 module slots max. See Opcode 50, Request I/O Point Position and Table 11, Compability Mode, for more information.
11
1
Opcode 6 Revision (Version 2.02)
0 = Original 1 = Extended for Additional Point
Types (offset 104 -220)
12 1 ROC Subtype
1 – Series 1 0 = Series 2
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-3
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
13
11
Reserved for future use [Zeroes returned]
24 1 Type of ROC:
1 = ROCPAC ROC300-Series 2 = FloBoss 407 3 = FlashPAC ROC300-Series 4 = FloBoss 503 5 = FloBoss 504 6 = ROC800 (809/827) 11 = DL8000 X = FB100-Series
25 1 Contains the number of logical for
point type 60
26 1 Contains the number of logical for
point type 61
27
1
Contains the number of logical for point type 62
28
1
Contains the number of logical for point type 63
29 1 Contains the number of logical for
point type 64
30 1 Contains the number of logical for
point type 65
31
1
Contains the number of logical for point type 66
32 1 Contains the number of logical for
point type 67
33 1 Contains the number of logical for
point type 68
34
1
Contains the number of logical for point type 69
35 1 Contains the number of logical for
point type 70
36 1 Contains the number of logical for
point type 71
37
1
Contains the number of logical for point type 72
38
1
Contains the number of logical for point type 73
39 1 Contains the number of logical for
point type 74
40 1 Contains the number of logical for
point type 75
41
1
Contains the number of logical for point type 76
42 1 Contains the number of logical for
point type 77
43 1 Contains the number of logical for
point type 78
44
1
Contains the number of logical for point type 79
45 1 Contains the number of logical for
point type 80
ROC Plus Protocol Specifications Manual
2-4 Opcodes Revised March-2021
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
46
1
Contains the number of logical for point type 81
47 1 Contains the number of logical for
point type 82
48 1 Contains the number of logical for
point type 83
49
1
Contains the number of logical for point type 84
50 1 Contains the number of logical for
point type 85
51 1 Contains the number of logical for
point type 86
52
1
Contains the number of logical for point type 87
53 1 Contains the number of logical for
point type 88
54 1 Contains the number of logical for
point type 89
55 1 Contains the number of logical for
point type 90
56
1
Contains the number of logical for point type 91
57 1 Contains the number of logical for
point type 92
58 1 Contains the number of logical for
point type 93
59
1
Contains the number of logical for point type 94
60 1 Contains the number of logical for
point type 95
61 1 Contains the number of logical for
point type 96
62
1
Contains the number of logical for point type 97
63 1 Contains the number of logical for
point type 98
64 1 Contains the number of logical for
point type 99
65 1 Contains the number of logical for
point type 100
66
1
Contains the number of logical for point type 101
67 1 Contains the number of logical for
point type 102
68 1 Contains the number of logical for
point type 103
69
1
Contains the number of logical for point type 104
70 1 Contains the number of logical for
point type 105
71 1 Contains the number of logical for
point type 106
72
1
Contains the number of logical for point type 107
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-5
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
73
1
Contains the number of logical for point type 108
74 1 Contains the number of logical for
point type 109
75 1 Contains the number of logical for
point type 110
76
1
Contains the number of logical for point type 111
77 1 Contains the number of logical for
point type 112
78 1 Contains the number of logical for
point type 113
79
1
Contains the number of logical for point type 114
80 1 Contains the number of logical for
point type 115
81 1 Contains the number of logical for
point type 116
82 1 Contains the number of logical for
point type 117
83
1
Contains the number of logical for point type 118
84 1 Contains the number of logical for
point type 119
85 1 Contains the number of logical for
point type 120
86
1
Contains the number of logical for point type 121
87 1 Contains the number of logical for
point type 122
88 1 Contains the number of logical for
point type 123
89
1
Contains the number of logical for point type 124
90 1 Contains the number of logical for
point type 125
91 1 Contains the number of logical for
point type 126
92 1 Contains the number of logical for
point type 127
93
1
Contains the number of logical for point type 128
94 1 Contains the number of logical for
point type 129
95 1 Contains the number of logical for
point type 130
96
1
Contains the number of logical for point type 131
97 1 Contains the number of logical for
point type 132
98 1 Contains the number of logical for
point type 133
99
1
Contains the number of logical for point type 134
ROC Plus Protocol Specifications Manual
2-6 Opcodes Revised March-2021
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
100
1
Contains the number of logical for point type 135
101 1 Contains the number of logical for
point type 136
102 1 Contains the number of logical for
point type 137
103
1
Contains the number of logical for point type 138
Included if Opcode 6 Revision (offset 11) >= 1
Version 2.02
104 1 Contains the number of logical for
point type 139
105
1
Contains the number of logical for point type 140
106 1 Contains the number of logical for
point type 141
107 1 Contains the number of logical for
point type 142
108
1
Contains the number of logical for point type 143
109
1
Contains the number of logical for point type 144
110 1 Contains the number of logical for
point type 145
111 1 Contains the number of logical for
point type 146
112
1
Contains the number of logical for point type 147
113 1 Contains the number of logical for
point type 148
114 1 Contains the number of logical for
point type 149
115
1
Contains the number of logical for point type 150
116 1 Contains the number of logical for
point type 151
117 1 Contains the number of logical for
point type 152
118
1
Contains the number of logical for point type 153
119
1
Contains the number of logical for point type 154
120 1 Contains the number of logical for
point type 155
121 1 Contains the number of logical for
point type 156
122
1
Contains the number of logical for point type 157
123 1 Contains the number of logical for
point type 158
124 1 Contains the number of logical for
point type 159
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-7
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
125
1
Contains the number of logical for point type 160
126 1 Contains the number of logical for
point type 161
127 1 Contains the number of logical for
point type 162
128
1
Contains the number of logical for point type 163
129 1 Contains the number of logical for
point type 164
130 1 Contains the number of logical for
point type 165
131
1
Contains the number of logical for point type 166
132 1 Contains the number of logical for
point type 167
133 1 Contains the number of logical for
point type 168
134 1 Contains the number of logical for
point type 169
135
1
Contains the number of logical for point type 170
136 1 Contains the number of logical for
point type 171
137 1 Contains the number of logical for
point type 172
138
1
Contains the number of logical for point type 173
139 1 Contains the number of logical for
point type 174
140 1 Contains the number of logical for
point type 175
141
1
Contains the number of logical for point type 176
142 1 Contains the number of logical for
point type 177
143 1 Contains the number of logical for
point type 178
144 1 Contains the number of logical for
point type 179
145
1
Contains the number of logical for point type 180
146 1 Contains the number of logical for
point type 181
147 1 Contains the number of logical for
point type 182
148
1
Contains the number of logical for point type 183
149 1 Contains the number of logical for
point type 184
ROC Plus Protocol Specifications Manual
2-8 Opcodes Revised March-2021
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
150
1
Contains the number of logical for point type 185
151 1 Contains the number of logical for
point type 186
152 1 Contains the number of logical for
point type 187
153
1
Contains the number of logical for point type 188
154 1 Contains the number of logical for
point type 189
155 1 Contains the number of logical for
point type 190
156
1
Contains the number of logical for point type 191
157 1 Contains the number of logical for
point type 192
158 1 Contains the number of logical for
point type 193
159 1 Contains the number of logical for
point type 194
160
1
Contains the number of logical for point type 195
161 1 Contains the number of logical for
point type 196
162 1 Contains the number of logical for
point type 197
163
1
Contains the number of logical for point type 198
164 1 Contains the number of logical for
point type 199
165 1 Contains the number of logical for
point type 200
166
1
Contains the number of logical for point type 201
167 1 Contains the number of logical for
point type 202
168 1 Contains the number of logical for
point type 203
169 1 Contains the number of logical for
point type 204
170
1
Contains the number of logical for point type 205
171 1 Contains the number of logical for
point type 206
172 1 Contains the number of logical for
point type 207
173
1
Contains the number of logical for point type 208
174 1 Contains the number of logical for
point type 209
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-9
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
175
1
Contains the number of logical for point type 210
176 1 Contains the number of logical for
point type 211
177 1 Contains the number of logical for
point type 212
178
1
Contains the number of logical for point type 213
179 1 Contains the number of logical for
point type 214
180 1 Contains the number of logical for
point type 215
181
1
Contains the number of logical for point type 216
182 1 Contains the number of logical for
point type 217
183 1 Contains the number of logical for
point type 218
184 1 Contains the number of logical for
point type 219
185
1
Contains the number of logical for point type 220
186 1 Contains the number of logical for
point type 221
187 1 Contains the number of logical for
point type 222
188
1
Contains the number of logical for point type 223
189 1 Contains the number of logical for
point type 224
190 1 Contains the number of logical for
point type 225
191
1
Contains the number of logical for point type 226
192 1 Contains the number of logical for
point type 227
193 1 Contains the number of logical for
point type 228
194 1 Contains the number of logical for
point type 229
195
1
Contains the number of logical for point type 230
196 1 Contains the number of logical for
point type 231
197 1 Contains the number of logical for
point type 232
198
1
Contains the number of logical for point type 233
199 1 Contains the number of logical for
point type 234
ROC Plus Protocol Specifications Manual
2-10 Opcodes Revised March-2021
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
200
1
Contains the number of logical for point type 235
201 1 Contains the number of logical for
point type 236
202 1 Contains the number of logical for
point type 237
203
1
Contains the number of logical for point type 238
204 1 Contains the number of logical for
point type 239
205 1 Contains the number of logical for
point type 240
206
1
Contains the number of logical for point type 241
207 1 Contains the number of logical for
point type 242
208 1 Contains the number of logical for
point type 243
209 1 Contains the number of logical for
point type 244
210
1
Contains the number of logical for point type 245
211 1 Contains the number of logical for
point type 246
212 1 Contains the number of logical for
point type 247
213
1
Contains the number of logical for point type 248
214 1 Contains the number of logical for
point type 249
215 1 Contains the number of logical for
point type 250
216
1
Contains the number of logical for point type 251
217 1 Contains the number of logical for
point type 252
218 1 Contains the number of logical for
point type 253
219 1 Contains the number of logical for
point type 254
220
1
Contains the number of logical for point type 255
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-11
2.3 Opcode 7, Read Real-time Clock
Opcode 7 returns the current time, date, and the day of week.
Version
Description
1.00
Introduced
Note: You can also read the time/date by specifying Point Type 136
(ROC Clock) or Opcode 167 (Request Single Point Parameters).
Table 2–3. Opcode 7, Read Real-time Clock
Opcode 7
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offse
t
Length
Description of Data
Offset
Length
Description of Data
Opcode 7: Send current
time and date
No data bytes.
6 1 Current second [UINT8]
7 1
Current minute [UINT8]
8 1
Current hour [UINT8]
9 1
Current day [UINT8]
10
1
Current month [UINT8]
11
2
Current year [UINT16]
13
1
Current day of week [UINT8] 1=Sunday 7=Saturday
2.4 Opcode 8, Set Real-time Clock
Opcode 8 is the only way to set the real-time clock. The ROC800 calculates the current day of the week. When you set the clock, the microseconds in the ROC800 zero out.
Version
Description
1.00
Introduced
Table 2–4. Opcode 8, Set Real-time Clock
Opcode 8
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 8: Set current time and date
6 1 Current seconds [UINT8]
No data bytes.
7 1 Current minutes [UINT8]
Time and date are set and
acknowledgment sent back.
8 1 Current hour [UINT8]
9 1
Current day [UINT8]
10
1
Current month [UINT8]
11
2
Current year [UINT16]
ROC Plus Protocol Specifications Manual
2-12 Opcodes Revised March-2021
2.5 Opcode 10, Read Configurable Opcode Point Data
Opcode 10 reads data defined by Point Type 99 (Configurable Opcode). The value of the starting table location plus the number of table locations must be less than or equal to 44.
Version
Description
1.00
Introduced
Table 2–5. Opcode 10, Read Configurable Opcode Point Data
Opcode 10
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offse
t
Length
Description of Data
Offset
Length
Description of Data
Opcode 10: Send data from configurable opcode tables
6 1 Table Number (0-15)
6 1 Table Number (0-15)
7 1 Starting Table Location (0-
43)
7 1 Starting Table Location (0-43)
8 1 Number of Table Locations
(1-44)
8 1 Number of Table Locations (1-44)
9 4
Table Version Number [float]
13
x
Data
2.6 Opcode 11, Write Configurable Opcode Point Data
Opcode 11 writes data defined by Point Type 99 (Configurable Opcode). The value of the starting table location plus the number of table locations must be less than or equal to 44.
Version
Description
1.00
Introduced
Table 2–6. Opcode 11, Write Configurable Opcode Point Data
Opcode 11
Communi-
cation
Opcode
Host Request to ROC800
ROC800 Response to Host
Data
Description of Data
Data
Description of Data
Offset
Length
Offset
Length
Opcode 11: Set data in configurable opcode tables
6 1 Table Number (0-15)
No data bytes.
7 1 Starting Table Location (0-
43)
Acknowledgment sent back.
8 1 Number of Table Locations
(1-44)
9 x Data
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-13
2.7 Opcode 17, Login Request
Opcode 17 sets an operator identification code for the communications port through which communications are occurring. The operator identification is logged with an event, indicating the operator responsible for creating the event. The ROC800 provides a default operator identification for each communications port.
Version
Description
1.00
Introduced
Once you set the operator identification, it remains set until changed by:
Subsequent Opcode 17 requests; Initialization of the ROC800 by a warm start or cold start; Firmware upgrade; or Timeout.
Table 2–7. Opcode 17, Login Request
Opcode 17
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Description of Data
Data
Description of Data
Opcode
Offse
t
Length
Offset
Length
Opcode 17: Set operator ID
Note: Access Level only sent if Security Mode (95, x,
44) is set to 2 where x = the logical of the port the request is being made on.
6 3 Operator ID [AC3]
Acknowledgment sent back without
data.
9 2 Password [UINT16]
11
1
Access Level [UINT8]
Opcode 17: Logout request
Note: Logout string is the ASCII string
“LOGOUT” in
all capital letters.
6 3 Operator ID [AC3]
Acknowledgment sent back without
data
9 2 Password [UINT16]
11
6
Logout String [AC6]
ROC Plus Protocol Specifications Manual
2-14 Opcodes Revised March-2021
2.8 Opcode 24, Store and Forward
Opcode 24 defines the requested store and forward action through up to three intermediate ROC800s to the final destination ROC800. Refer to Chapter 7, ROC-to-ROC Communications, for details on how this opcode works.
Version
Description
1.00
Introduced
Table 2–10. Opcode 24, Store and Forward
Opcode 24
Communi-
cation
Opcode
Host Request to ROC800
ROC800 Response to Host
Data
Description of Data
Data
Description of Data
Offset
Length
Offset
Length
Opcode 24: Store and Forward
6
1
Host Address
No acknowledgment sent back
7
1
Host Group
8 1
1st Destination Address
9
1
1st Destination Group
10
1
2nd Destination Address
11
1
2nd Destination Group
12
1
3rd Destination Address
13
1
3rd Destination Group
14
1
4th Destination Address
15
1
4th Destination Group
16
1
Desired opcode
17
1
Number of data bytes for the desired opcode
18
x
Opcode data
2.9 Opcode 50, Request I/O Point Position
Opcode 50 requests either the type or the logical number of all the I/O points in the ROC800, returned in the order of their physical location in the ROC800. The system (diagnostic) inputs are also included.
Version
Description
1.00
Introduced
2.00
Update
In version 2.0, with the addition of the 827 and expanded backplanes, the 255 byte limit was been reached and requests for higher modules slots would not be valid. As a result, the number of points per module changed from 16 to 8. In order to provide a mechanism to retain 16­points-per-module addressing, a backwards compatibility mode was developed and set by default (see Point Type 91, Parameter 50). In backwards compatibility mode, an 809 (or an 827 with one expanded backplane) will be returned the same as version 1.XX (16 points per module). If it is an 827 with 2 expanded backplanes, then it still can be returned with 16 points/module, but the byte length is expanded to allow for all of the information to be returned with one request/response pair.
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-15
If it is set to 8 points/module, regardless of the backplane style or number of expanded backplanes, all the information for 27 slots is
returned (even if there aren’t modules in these slots and even if the
expanded backplanes don’t exist).
The following table summarizes the behavior of Opcode 50 based on Point Type 91, Parameter 50 (logical 0) and the backplanes used. Use this table in conjunction with Opcode 6 to determine the byte length for the response of any Opcode 50 request.
Table 2-11. Compatibility Mode
Compatibility Mode:
Point Type 91; Logical 0;
Parameter 50; Value = 1
Enhanced Mode: Point Type 91; Logical 0; Parameter 50; Value = 1
Logical Compability Status:
(Opcode 6, Offest 10 Response)
Logical Compatibility Status:
(Opcode 6 Offset 10 Response)
ROC809 Backplane 0 2
ROC827 with 0 expanded backplanes
0
2
ROC827 with 1 expanded backplanes
0
2
ROC827 with 2 expanded backplanes
1
2
ROC827 with 3 expanded backplanes
1
2
ROC827 with 4 expanded backplanes
1
2
Enumeration
The “type” indicates the type of I/O point:
Description
Type Number
Undefined
0
HART-2
84
HART
85
Discrete Input
101
Discrete Output
102
Analog Input
103
Analog Output
104
Pulse Input
105
RTD
106
Thermocouple
107
MVS
108
System Analog Input
109
ACIO
140
APM
141
The “logical number” indicates the logical offset of this point within
points of the same type. The first I/O point of a given type has a logical number of 0; the second has a logical number of 1, etc.
ROC Plus Protocol Specifications Manual
2-16 Opcodes Revised March-2021
Note: This logical number is not used as the “Logical/Location”
component of the TLP (type, logical/location, parameter) reference. I/O points use the physical location.
The CPU module (module 0) is the only module that cannot be removed. The CPU module currently has 5 points associated with it (Point Type 109: System Analog Inputs). The other modules can contain anywhere from 0 to 8 points.
The I/O point type and logical numbers can only be requested using Opcode 50 (Request I/O Point Position).You must perform two requests to retrieve both the point types and logical numbers.
The ROC800’s layout consists of a power supply and CPU module in the left-most column. Depending on configuration, up to 9 columns of modules can be added. Refer to the following figure.
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-17
There are three possible responses to Opcode 50 based on how many expanded backplanes are connected and the logical compatibility mode [Point Type 91, Logical 0, Parameter 50]. These correspond to the Logical Compatibility Status reported in offset 10 of Opcode 6. See the description of Opcode 6 (System Configuration) for more information.
Logical Compatibility Status = 0: Compatibility Mode with 809
or 827 with 0 – 1 expanded backplane [Point Type 91, Logical 0,
Power Supply
CPU Module (Module 0)
Module 1
Module 2
Module 3
Module 4
Module 5
Module 6
Module 7
Module 8
Module 9
Module 10
Module 11
Module 12
Module 13
Module 14
Module 15
Module 16
Module 17
Module 18
Module 19
Module 20
Module 21
Module 22
Module 23
Module 24
Module 25
Module 26
Module 27
ROC827
3 Slots
ROC809
9 Slots
ROC827 W/ 1
9 Slots
ROC827 W/ 2
15 Slots
ROC827 W/ 3
21 Slots
ROC827 W/ 4
27 Slots
ROC Plus Protocol Specifications Manual
2-18 Opcodes Revised March-2021
Parameter 50] = 0 and connected to either an ROC809 or ROC827 with 0 or 1 expanded backplane.
Each module has 16 points allocated to it and the response is the same for versions 1.XX and 2.00. Since there are 10 modules (0 [CPU Module] 9 [Slot 9]) and 16 points per module, the ROC800 provides up to 160 addressable physical position points.
I/O Point
Physical Location
0 1 2 3 4 5 6 7 8 9 10
11
12
13
14
15
16 … 159
Module - Point
0-1
0-2
0-3
0-4
0-5
0-6
0-7
0-8
0-9
0-10
0-11
0-12
0-13
0-14
0-15
0-16
1-1 … 9-16
Point Type
109
109
109
109
109 0 0 0 0 0 0 0 0 0 0 0 X16 … X
159
Logical Number
0 1 2 3 4 0 0 0 0 0 0 0 0 0 0 0 Y16 … Y
159
Notes:
Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved
Where: Physical location = (module number X 16) + point number on module -1 X = I/O point types 101 109; 0 represents module not present Y = 0 to maxium number of logicals for the given I/O point type
Logical Compatibility Status = 1: Compatibility Mode with 827
and 2 to 4 expanded backplanes [Point Type 91, Logical 0,
Parameter 50] = 0 and ROC827 with 2 to 4 expanded to either an ROC809 or ROC827 with 0 or 1 expanded backplane.
Each module has 16 points allocated to it and the response is the same for versions 1.XX and 2.00. Since there are 10 modules (0 [CPU Module] 9 [Slot 9]) and 16 points per module, the ROC800 provides up to 160 addressable physical position points.
I/O Point
Physical Location
0 1 2 3 4 5 6 7 8 9 10
11
12
13
14
15
16 … 239
Module - Point
0-1
0-2
0-3
0-4
0-5
0-6
0-7
0-8
0-9
0-10
0-11
0-12
0-13
0-14
0-15
0-16
1-1 … 14-
16
Point Type
109
109
109
109
109 0 0 0 0 0 0 0 0 0 0 0 X16 … X
239
Logical Number
0 1 2 3 4 0 0 0 0 0 0 0 0 0 0 0 Y16 … Y
239
Notes:
Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved
Where: Physical location = (module number X 16) + point number on module -1 X = I/O point types 101 109; 0 represents module not present Y = 0 to maxium number of logicals for the given I/O point type
Logical Compatibility Status = 2: Compatibility Mode is set to
2.00 with any ROC800-Series based product (809/827 and any number of expanded backplanes) [Point Type 91, Logical 0,
Parameter 50] = 1 and connect to a ROC809 or ROC827 with 0 to 1expanded backplanes.
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-19
In this configuration, each module has 8 points allocated to it. All 28 shots (0 in the CPU module up to 27 in slot 27) are returned using 8 points per modle. As a result, there are 224 physical position points addressable in this configuration.
I/O Point
Physical Location
0 1 2 3 4 5 6 7 8 9 10
11
12
13
14
15
16 … 223
Module - Point
0-1
0-2
0-3
0-4
0-5
0-6
0-7
0-8
0-9
0-10
0-11
0-12
0-13
0-14
0-15
0-16
1-1 … 27-
16
Point Type
109
109
109
109
109 0 0 0 0 0 0 0 0 0 0 0 X16 … X
223
Logical Number
0 1 2 3 4 0 0 0 0 0 0 0 0 0 0 0 Y16 … Y
223
Notes:
Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved Reserved
Where: Physical location = (module number X 8) + point number on module -1 X = I/O point types 101 109; 0 represents module not present Y = 0 to maxium number of logicals for the given I/O point type
Table 2-12. Opcode 50, Request I/O Point Position
Opcode 50
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 50: Send I/O point type or logical number associated with the point type.
6 1 Which I/O data to send (0 = I/O Point Type, 1 = I/O Logical Number)
6
160 240 224
I/O Point Types or Logical Numbers
See Opcode 6 (offset 10) for length of response
ROC Plus Protocol Specifications Manual
2-20 Opcodes Revised March-2021
2.10 Opcode 100, Access User-defined Information
Opcode 100 readsuser-defined point type information.
Version
Description
1.20
Introduced (Command 11)
Table 2-13. Opcode 100, Access User-defined Information
Opcode 100
Communi-
cation
Opcode
Host Request to ROC800
ROC800 Response to Host
Data
Data
Offset
Length
Description of Data
Offset
Length
Description of Data
Get point type information
Retrieve information about point types.
6 1 Command (11)
6 1 Command (11)
7 1 Start Point # (0 – 255)
7 1 Start Point # (0 – 255)
8 1 # Points (0 – 245)
8 1 # Points (0 – 245)
9 1
Type of Point Type
0 – 7 = User Program
253 = User Defined
254 = ROC Point Type
255 = No Point Type
(Repeat above as necessary)
2.11 Opcode 105, Request Today’s and Yesterday’s Min/Max Values
Opcode 105 retrieves the occurrence of today’s and yesterday’s
minimum and maximum values. The history point is specified by segment and point number.
Version
Description
1.00
Introduced
Enumeration
Historical archive method.
128
Archived every hour (Average)
129
Archived every hour (Accumulated)
130
Archived every hour (Current)
134
Archived every hour (Totalize)
67
Timestamp logged with FST-controlled timestamp. Timestamp is a TIME [UINT32] representing the number of seconds elapsed since 12:00AM Jan 1, 1970. Use FST command WTM (Write Current Time to History)
65
Database value logged when directed by FST command WDB (Write Results Register Value to History)
0
Not defined.
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-21
Table 2–14. Opcode 105, Request Today’s and Yesterday’s Min/Max Values
Opcode 105
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 105: Send history
point defini­tion, min and max Data, and current value for specified history point
6 1 History Segment (0 – 10)
6
1
History Segment (0 – 10)
7 1 History point number
7
1
Historical point number
8 1
Historical Archival Method Type
9 1
Point type
10
1
Point/Logic number
11
1
Parameter number
12
4
Current value [float]
16
4
Minimum value since contract hour [float]
20
4
Maximum value since contract hour [float]
24
5
Time of minimum value occurrence Note: This is a UINT32 (4 bytes)
and contains the number of seconds since 12:00AM Jan 1,
1970.
Seconds, minutes, hour, day, and month
29
5
Time of maximum value occurrence.
Note: This is a UINT32 (4 bytes) and contains the number of seconds since 12:00AM Jan 1,
1970.
Seconds, minutes, hour, day, and month 34
4
Minimum value yesterday [float]
38
4
Maximum value yesterday [float]
42
5
Time of yesterday’s min value
occurrence. Note: This is a UINT32 (4 bytes)
and contains the number of seconds since 12:00AM Jan 1,
1970.
Seconds, minutes, hour, day and month
47
5
Time of yesterday’s max value
occurrence. Note: This is a UINT32 (4 bytes)
and contains the number of seconds since 12:00AM Jan 1,
1970.
Seconds, minutes, hour, day, and month
52
4
Value during last completed period [float]
ROC Plus Protocol Specifications Manual
2-22 Opcodes Revised March-2021
2.12 Opcode 108, Request History Tag and Periodic Index
Opcode 108 sends the tag and history period for specified history points, up to a maximum of 20 history points. All points must be within a single segment.
Version
Description
1.00
Introduced
Table 2–15. Opcode 108, Request History Tag and Periodic Index
Opcode 108
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Description of Data
Data
Description of Data
Opcode
Offset
Length
Offset
Length
Opcode 108: Send tag
and current history period for specified history point(s)
6 1 History Segment (0 – 10)
6
1
History Segment (0 – 10)
7 1 # of historical points
specified
7
1
# of historical points specified
8 1 Historical point (0 – 199)
8
2
Periodic Index (common among all history points in segment)
. (repeat above as
necessary 20 maximum)
(repeat as
necessary)
1
History point
10
Tag [AC10]
2.13 Opcode 118, Request Alarm Data
Opcode 118 requests alarm data from the ROC800’s Alarm Log.
Version
Description
1.00
Introduced
Table 2–16. Opcode 118, Request Alarm Data
Opcode 118
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offse
t
Length
Description of Data
Offset
Length
Description of Data
Opcode 118: Send
specified number of slarms starting With specified alarm index.
6 1 # of alarms requested (max
10) *SEE NOTE BELOW
6
1
Number of alarms being sent
7 2 Starting Alarm Log index
7
2
Starting Alarm Log index
9 2
Current Alarm Log index
11
23
Alarm Data
.
(repeat above as necessary)
Note If no alarms are requested, the ROC800 does not return alarm
data.
Alarm Data
The alarm log stores the last 450 alarm entries. Each alarm consists of 23 bytes and has the following general format:
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-23
Description
Type
Time
Alarm-specific Data
Byte:
0 1 2 3 4 5 6 7 8 9 10
11
12
13
14
15
16
17
18
19
20
21
22
Alarm Type
The alarm type (byte 0) is a packed one-byte field that also includes information identifying if the alarm indicates a set or clear condition, and if the alarm is an SRBX alarm.
Alarm Type
Byte Breakdown
The alarm type (byte 0) is a packed one-byte field that also includes information identifying if the alarm indicates a set or clear condition, and if the alarm is an SRBX alarm. It has the following format:
Description
SRBX
Condition
Type
Bit: 7 6 5 4 3 2 1 0
SRBX (most significant bit): Indicates whether the alarm was an
SRBX alarm. An SRBX allows the ROC800 to notify a host about certain alarm conditions. The host may be notified when an alarm is either set or cleared. Refer to Chapter 6. Valid values are:
0 - No SRBX 1 - SRBX issued
Condition (bit 6): Indicates if the alarm is being set or cleared.
Valid values are:
0 - Cleared 1 – Set
Type (bits 5-0): Identifies what type of alarm is stored. See Alarm-
specific Data for byte usage (5-22) of each type. Valid values are:
0 - No Alarm 1 - Parameter Alarm 2 - FST Alarm 3 - User Text Alarm 4 - User Value Alarm
Time
Bytes 1 to 4 provide the timestamp for the alarm, which is the time the alarm was logged. The timestamp is a TIME [UINT32] which represents the number of seconds that have elapsed since 12:00 a.m. Jan. 1, 1970.
Alarm-specific
Data
For each alarm type, bytes 5 to 22 provide an alarm description and value as appropriate:
Parameter Alarm
This type of alarm is typically generated as a parameter reaches a particular value. The data for this particular alarm has the following format:
ROC Plus Protocol Specifications Manual
2-24 Opcodes Revised March-2021
Description:
Code
TLP
Alarm Description
Value
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
22
Code: Reason why the alarm was logged. Some codes only hav
meaning for certain TLPs. Valid values are:
0 - Low Alarm 1 - Low Low Alarm 2 - High Alarm 3 - High High Alarm 4 - Rate Alarm 5 - Status Change 6 - Point Fail 7 - Scanning Disabled 8 - Scanning Manual 9 - Redundant Total Counts 10 - Redundant Flow Register 11 - No Flow Alarm 12 - Input Freeze Mode 13 - Sensor Communication Failure 14 - 485 Communication Failure 15 - Off Scan Mode 16 - Manual Flow Inputs. 17 - Meter Temperature Failure Alarm 18 - Compressibility Calculation Alarm 19 - Sequence Out of Order 20 - Phase Discrepancy 21 - Pulse Synchronization Failure 22 - Frequency Discrepancy 23 - Pulse Input One Failure 24 - Pulse Input Two Failure 25 - Pulse Output Buffer Overrun 26 - Pulse Output Buffer Warning 27 - Relay Fault 28 - Relay Failure 29 - Static Pressure Low Limited 30 - Temperature Low Limited 31 - Analog Output Readback Error 32 - Bad Level A Pulse Stream 33 - Market Pulse Alarm
TLP: Parameter that caused the alarm. In some situations only the
Type and Logical of the TLP have meaning.
Alarm Description: Short textual description of the alarm. Value: Value of the specified TLP when alarm was logged. Data is a
floating-point value regardless of the type associated with the parameter for specified TLP.
FST Alarm
Alarm that was logged from an FST. The data for this particular alarm has the following format:
Description:
FST #
Alarm Description
Value
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
22
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-25
FST #: Indicates which running FST logged the alarm. Alarm Description: Short textual description of the alarm Value: Floating point value associated with alarm.
User Text
Alarm
Alarm that was logged by a User C++ program. The data for this particular alarm has the following format:
Description:
Alarm Description
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
22
Alarm Description: Short textual description of the alarm
User Value
Alarm
Alarm that was logged by a User C++ program. The data for this particular alarm has the following format:
Description:
Alarm Description
Value
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
22
Alarm Description: Short textual description of the alarm. Value: Floating point value associated with alarm.
2.14 Opcode 119, Request Event Data
Opcode 119 requests event data from ROC800’s Event Log. The Event Log consists of a maximum of 450 events. Each event consists of 22 bytes, organized according to one of the five formats described below.
Version
Description
1.00
Introduced
Table 2–17. Opcode 119, Request Event Data
Opcode 119
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 119: Send
specified number of events starting with the specified event Index
6 1 # of events requested (max
10) *SEE NOTE BELOW
6 1 Number of events being sent 7 2 Starting Event Log index
7 2 Starting Event Log index
9 2
Current Event Log index
11
22
Event Data
.
(repeat above as necessary)
Note: If no events are requested, the ROC800 does not return event
data.
ROC Plus Protocol Specifications Manual
2-26 Opcodes Revised March-2021
Event Data
The event log stores the last 450 event entries. Each event consists of 22 bytes and has the following general format:
Description:
Type
Time
Event Specific Data
Byte:
0 1 2 3 4 5 6 7 8 9 10
11
12
13
14
15
16
17
18
19
20
21
Event Type
The event type identifies what type of event is stored in the event specific data. Valid values are:
0 - No Event 1 - Parameter Change Event 2 - System Event 3 - FST Event 4 - User Event 5 - Power Lost Event 6 - Clock Set Event 7 - Calibrate Verify Event
Parameter Change
Event
A Parameter Change event is logged any time a user makes a change to any TLP. The data for the event has the following format::
Description:
Operator ID
TLP
Data Type
New Value
Old Value
Spare
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
Operator ID: Identifies who made the change. TLP: Identifies what parameter was changed. Data Type: Identifies the type of data stored in the new value and
old value fields. Valid values are:
0 - BIN 1 - INT8 2 - INT16 3 - INT32 4 - UINT8 5 - UINT16 6 - UINT32 7 - FL 8 - TLP 9 - AC (3 bytes) 10 - AC (7 bytes) 11 - AC (10 bytes) 12 - AC (12 bytes) 13 - AC (20 bytes) 14 - AC (30 bytes) 15 - AC (40 bytes) 16 - DOUBLE 17 - TIME
New Value: New value of the changed parameter. New value will
extend beyond its four byte field and into the old value and spare fields if the data size is larger than 4 bytes.
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-27
Old Value: Old value of the changed parameter. The old value
always starts at byte offset 16. If the data type is too large to store both old value and new value, only the new value will be stored.
System Event
A System event logs internally in the ROC800. The data for the event has the following format:
Description:
Code
Description
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
Code: More specifically defines the type of event that occurred.
Valid values are:
144 - Initialization Sequence 145 - All Power Removed 146 - Initialize from defaults. 147 - ROM CRC Error 148 - Database Initialization 150 - Program Flash 151 - Reserved for ROC800 only 152 - Reserved for ROC800 only 153 - Reserved for ROC800 only 154 - Smart Module Inserted 155 - Smart Module Removed 200 - Clock Set 248 - Text Message 249 - Download Configuration 250 - Upload Configuration 251 - Calibration Timeout 252 - Calibration Cancel 253 - Calibration Success 254 - MVS Reset to Factory Defaults
Description: Textual description of the alarm.
FST Event
An FST event is logged by an FST. The data for the event has the following format:
Description:
FST #
Value
Description
Spare
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
FST #: Identifies which FST logged the event. Value: Floating point value associated with event. Description: Textual description of the event.
User Event
A User event is logged by the action of a logged in user. The data for the event has the following format:
Description:
Operator Id
Code
Description
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
ROC Plus Protocol Specifications Manual
2-28 Opcodes Revised March-2021
Operator ID: Identifies who made the change. Code: More specifically defines the type of event that occurred.
Valid values are:
144 - Initialization Sequence 145 - All Power Removed 146 - Initialize from defaults. 147 - ROM CRC Error 148 - Database Initialization 150 - Program Flash 151 - Reserved for ROC800 only 152 - Reserved for ROC800 only 153 - Reserved for ROC800 only 154 - Smart Module Inserted 155 - Smart Module Removed 200 - Clock Set 248 - Text Message 249 - Download Configuration 250 - Upload Configuration 251 - Calibration Timeout 252 - Calibration Cancel 253 - Calibration Success 254 - MVS Reset to Factory Defaults
Description: Textual description of the alarm.
Power Lost
Event
A Power Lost event is logged when power to the ROC800 has been lost. The data for the event has the following format:
Description:
Time
Not Used
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
Time: Time that power to the unit was lost.
Clock Set
Event
A Clock Set event is logged when the time is set on the ROC800. The data for the event has the following format
Description:
Time
Not Used
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
Time: Identifies the time on the ROC800 was set to.
Calibrate Verify
Event
A Calibrate Verify event is logged any time a user tests the calibration of an I/O point.
Description:
Operator ID
TLP
Raw Value
Calibrated Value
Spare
Byte:
5 6 7 8 9
10
11
12
13
14
15
16
17
18
19
20
21
Operator ID: Identifies who tested the calibration. TLP: Identifies what parameter was tested.
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-29
Raw Value: Value of input before calibration was applied. Data
type is float.
Calibrated Value: Value of input after calibration was applied.
Data type is float.
Timestamp
The timestamp for the alarm represents the time the alarm was logged. The timestamp is a TIME [UINT32] which represents the number of seconds that have elapsed since 12:00 a.m. Jan. 1, 1970.
2.15 Opcode 135, Request Single History Point Data
Opcode 135 requests a specified number of history data values for a single history point, starting at a specified history index.
Version
Description
1.00
Introduced
The history segment indicates where data is requested, according to the following format:
0 = General History #0 1 = General History #1 2 = General History #2 . . . 9 = General History #9 10 = General History #10
The history point can be referenced by point number only as zero (0) – x, where x is the number of history points defined for a History Segment. For each history segment, you can retrieve three types of possible history: Minute (0), Periodic (1), and Daily (2).
You can also retrieve the Periodic (3) and Daily (4) timestamps. The starting history index specifies the record from which the history
values start:
Minute History: 0 – 60. Periodic History: 0 – (#periodic entries in history point – 1) (24
hours per day repeated for a maximum of 35 days).
Daily History: 0 – (#daily entries in history point 1).
Opcode 135 returns the history values for the requested history point from the starting history index and continues until it completes the requested number of indexes. To read timestamps, specify the value in “Type of History.
The timestamp is a TIME [UINT32] representing the number of seconds elapsed since 12:00 a.m. Jan. 1, 1970. This can be thought of as column addressing.
ROC Plus Protocol Specifications Manual
2-30 Opcodes Revised March-2021
Table 2–18. Opcode 135, Request Single History Point Data
Opcode 135
Communi-
Host Request to ROC800
ROC800 Response to Host
Cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 135: Send specified # of history data for specified history point starting at specified history index
6 1 History Segment (0-10)
6 1 History Segment (0-10)
7 1 Point number (0-(# of history
points for history segment –
1))
7 1 Point number (0-(# of history points
for history segment – 1))
8 1 Type of History (Minute – 0, Periodic – 1, or Daily – 2, Periodic Time Stamps – 3; Daily Time Stamps – 4)
8 2 Current history segment index
9 2 Starting history segment index {Minute 0 – 59, Periodic 0 - (#periodic entries in history point – 1), or Daily 0 - (#daily entries in history point – 1)}
10
1
# of values being sent
11
1
# of values requested (max
60) *SEE NOTE BELOW
11
4
1st history value
. (repeat above as necessary)
Note: If no events are requested, the ROC800 does not return history
values.
2.16 Opcode 136, Request Mutiple History Point Data
Opcode 136 requests a specified number of history data values for a specified starting history index for a specified number of time periods, starting at a specified history point for a specified number of history points.
Version
Description
1.00
Introduced
The history segment indicates where data is requested. Following are the history segments:
0 = General History #0 1 = General History #1 2 = General History #2 . . . 9 = General History #9 10 = General History #10
The history index specifies the record to be used:
Minute History: 0 – 60. Periodic History: 0 – (#periodic entries in history point – 1) (24
hours per day repeated for a maximum of 35 days).
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-31
Daily History: 0 – (#daily entries in history point 1).
There are three types of history possible to be retrieved from each history segment: Minute (0), Periodic (1), or Daily (2).
The starting history point can be referenced by point number only as 0 – x, where x is the number of history points defined for a History Segment.
Opcode 136 returns the history values for the requested history index from the starting history point and continuing until the requested number of history points is completed. The time stamp for the history index will always be returned.
The timestamp is a TIME [UINT32] representing the number of seconds elapsed since 12:00 a.m. Jan. 1, 1970. This can be thought of as row addressing. An error is returned if the day was not found.
Table 2–19. Opcode 136, Request Multiple History Point Data
Opcode 136
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 136: Send specified # of history data for specified history index starting at specified history point
6 1 History Segment (0-10)
6 1 History Segment (0-10)
7 2 History Segment Index {Minute 0 - 59, Periodic 0 ­(#periodic entries in history point – 1), or Daily 0 ­(#daily entries in history point – 1)}
7 2 History Segment Index {Minute 0 -
59, Periodic 0 - (#periodic entries in history point – 1), or Daily 0 ­(#daily entries in history point – 1)}
9 1 Type of History (Minute – 0, Periodic – 1, or Daily – 2)
9 2 Current history segment index
10
1
Starting history point (0-(# of history points for history segment – 1))
11
1
# of data elements being sent ((# history points + 1) * # time
periods) Value is 0 if the request is invalid.
11
1
# of history points
12
4
Time stamp for 1st time period
12
1
# of time periods *SEE NOTE BELOW
16
4
1st history point value
((# history points + 1) * # time periods) must not be greater than 60
.
(repeat for number of history points)
(above repeated for number of time periods)
Note: If no time periods are requested, the ROC800 does not return
history values.
ROC Plus Protocol Specifications Manual
2-32 Opcodes Revised March-2021
2.17 Opcode 137, Request History Index for a Day
Opcode 137 requests the Periodic and Daily Index for a specific day of a specified history point. If a day is not found, an opcode error is returned.
Version
Description
1.00
Introduced
Table 2–20. Opcode 137, Request History Index for a Day
Opcode 137
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 137: Send history
index for specified history point for specified day and month
6 1 History Segment (0 – 10)
6 1 History Segment (0 – 10)
7 1 Day requested
7 2 Starting Periodic Index for day and
month request.
8 1 Month requested
9 2 # periodic entries for day
11
2
Daily Index for day and month requested. Not valid if the number of daily entries for requested day is
0.
13
2
# daily entries per contract day
2.18 Opcode 138, Request Daily and Periodic History for a Day
Opcode 138 requests the periodic and daily history for a given day. If a day is not found, the ROC800 returns an opcode error. An opcode error can also occur if there are more periodic and daily entries than can fit in a reply. Request history point 255 to retrieve timestamps for the specified day.
Version
Description
1.00
Introduced
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-33
Table 2–21. Opcode 138, Request Daily and Periodic History for a Day
Opcode 138
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 138: Send
periodic and daily index for specified history point for specified day and month
6 1 History Segment (0 – 10)
6 1 History Segment (0 – 10)
7 1 History point (0 – (# of history points for history segment – 1))
7 1 History point (0 – (# of history
points for history segment – 1))
8 1 Day requested
8 1 Day requested
9 1 Month requested
9 1 Month requested
10
2
# periodic entries
12
2
# daily entries
14
4
periodic value
(repeat above for each periodic value) 4 daily value
(repeat above for each daily value)
2.19 Opcode 139, History Information Data
Opcode 139 requests various types of information from history. Depending on the command, you can retrieve the configured points, the data, or the timestamps.
Version
Description
1.00
Introduced
ROC Plus Protocol Specifications Manual
2-34 Opcodes Revised March-2021
Table 2–22. Opcode 139, History Information Data
Opcode 139
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 139: History
6 1 Command
6 1 Command
Command = 0
Request configured points.
7 1 History Segment
7 1 History Segment
8 1 Number of configured points
9 1 First configured point.
. (repeat above as necessary)
Command = 1
Request specified point data
7 1 History Segment
7 1 History Segment
If Request Timestamps is 0, Number of points * Number of Time Periods must not be greater than
60. If Request
Timestamps is 1, (Number of points + 1)* Number of Time Periods must not be greater than
60.
8 2 History Segment Index {Minute 0 - 59, Periodic 0 ­(#periodic entries in history point – 1), or Daily 0 ­(#daily entries in history point – 1)}
8 2 Current Index
10
1
Type of History (Minute – 0, Periodic – 1, or Daily – 2)
10
1
Number of time periods
11
1
Number of time periods
11
1
Request Timestamps
12
1
Request Timestamps
12
1
Number of points
13
4
Timestamp for first index (not returned if Request Timestamps parameter is 0)
13
1
Number of points
17
4
1st history point value
14
1
Requested history point
21
. (repeat for number of history
points .
(repeat above as necessary)
(Repeat above for number of time periods)
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-35
2.20 Opcode 166, Set Single Point Parameters
Opcode 166 either configures a single point or configures a contiguous block of parameters for a single point. This opcode is more efficient than Opcode 181 when writing to the entire point, or even a contiguous portion of the point, is required.
Version
Description
1.00
Introduced
Table 2–23. Opcode 166, Set Single Point Parameters
Opcode 166
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 166: Set specified
contiguous block of parameters
6 1 Point type
No data bytes.
7 1 Point/Logic Number
Acknowledgment sent back.
8 1 Number of Parameters
9 1
Starting parameter Number
10
1230
Data (a contiguous block)
2.21 Opcode 167, Request Single Point Parameters
Opcode 167 either reads the configuration of a single point or reads a contiguous block of parameters for a single point. Opcode 167 can be more efficient than reading the entire point, or even a contiguous portion of the point, using opcode 180.
Version
Description
1.00
Introduced
Table 2–24. Opcode 167, Request Single Point Parameters
Opcode 167
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 167: Send
specified contiguous block of parameters
6
1
Point type
6 1 Point type
7
1
Point/Logic Number
7 1 Point/Logic Number
8
1
Number of Parameters
8 1 Number of Parameters
9
1
Starting parameter Number
9 1 Starting parameter Number
10
1230
Data (a contiguous block)
ROC Plus Protocol Specifications Manual
2-36 Opcodes Revised March-2021
2.22 Opcode 180, Request Parameters
Opcode 180 reads several parameters in a single request. The parameters can be from different points and of different point types. The opcode is intended to read any combination of parameters listed in this document.
Version
Description
1.00
Introduced
Errors
The opcode responds with an error response if:
The response is longer than 240 bytes If the request is for an invalid parameter, possibly due to a point that
is not configured.
Table 2–25. Opcode 180, Request Parameters
Opcode 180
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 180: Send
specified parameters
6 1 Number of parameters requested
6 1 Number of parameters requested
7
1
Point type
7
1
Point type
1
Point/Logic number
1
Point/Logic number
1
Parameter number
1
Parameter number
. (repeat above as
necessary)
x
Data comprising the parameter
.
(repeat above as necessary)
2.23 Opcode 181, Write Parameters
Opcode 180 writes several parameters with a single request. The parameters can be from different points and of different point types. The opcode is intended to write any combination of parameters listed in this document.
Version
Description
1.00
Introduced
Errors
The opcode responds with an error response if:
The response is longer than 240 bytes. The request is for an invalid parameter. A parameter’s data is out of range. A parameter is read-only.
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-37
Table 2–26. Opcode 181, Write Parameters
Opcode 181
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 181: Set specified
parameters
6 1 Number of parameters requested
No data bytes.
7
1
Point type
Acknowledgment sent back.
1
Point/Logic number
1
Parameter number
x
Data comprising the parameter
. (repeat above as
necessary)
2.24 Opcode 203, General File Transfer
Opcode 203 transfers files to and from the flash file system.
Version
Description
2.02
Introduced Commands 1 - 5
Paths
/flash/userData (recommended for user C applications)
Opcode 255 Error Codes
Invalid file FILE_DOES_NOT_EXIST 67 Flash file system full FLASH_FILE_SYSTEM_FULL 69 Invalid path INVALID_PATH 72 Invalid offset INVALID_OFFSET 73 Invalid option INVALID_OPTION 74 More than 10 files open TOO_MANY_FILES_OPEN 75
Other Limitations/Special Cases
Maximum of 10 open files. Can create only one directory per open command. That is, if
/flash/etc does not exist, you cannot open a file in /flash/etc/bin
You would be able to open a file in /flash/etc, which would create
the etc directory.
You can delete both directories and files with the delete command.
ROC Plus Protocol Specifications Manual
2-38 Opcodes Revised March-2021
Table 2–27. Opcode 203, General File Transfer
Opcode 203
Host Request to ROC800
ROC800 Response to Host
Data
Data
Command
Offset
Length
Description of Data
Offset
Length
Description of Data
Open
(An open must be performed first before reading or writing to any file) When creating a new file the path must start with /flash/.
6 1 Command (1)
6 1 Command (1)
7 1 Options 0 = Open file for reading 1 = Open file for writing 2 = Create new file for
writing (if doesn’t exist) 3 = Open file for update
(reading and writing) 4 = Truncate to zero
length or create file for writing
7 4 File Descriptor
8
100
Path
108
25
File Name (25-byte filename must include null character)
Read
(Must use File Descriptor returned by the Open command)
6 1 Command (2)
6 1 Command (2)
7 4 File Descriptor
7 4 File Descriptor
11
4
Offset
11
4
File Size
15
4
Offset 19
1
Number of bytes
20
Num-
ber of
bytes
Data (maximum 230 bytes) (repeat above as necessary)
Write
(Must use File Descriptor returned by the Open command)
6 1 Command (3)
6 1 Command (3)
7
4
File Descriptor
7
4
File Descriptor
11
4
File Size
11
4
Offset
15
4
Offset 19
1
Number of bytes
20
Numbe
r of
bytes
Data (maximum 230 bytes)
(above repeated as
necessary)
Close
(Closes opened file and removes descriptor)
6 1 Command (4)
6 1 Command (4)
7 4 File Descriptor
Delete 6 1
Command (5)
6 1 Command (5)
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-39
Opcode 203
Host Request to ROC800
ROC800 Response to Host
Data
Data
Command
Offset
Length
Description of Data
Offset
Length
Description of Data
(Does not require file descriptor) Can delete file or directory within “/flash”
7
100
Path
107
25
File Name
Read Directory Contents (Version
3.05 or prior) Returns all
filenames in the
“./flash/data”
directory including subdirectories
6 1 Command (6)
6 1 Command (6)
7
100
Path 7 1
Additional filenames to read:
0 = No 1 = Yes
107
1
Total Num File Names Sent
8 1 Total number of file names sent
9 Num-
ber of
bytes
File Names (each file or directory name is separated with a null character and the entire data section ends with a null character)
Read Directory Contents (Version
3.10 or greater) Returns all
filenames in the
“./flash/data”
directory including subdirectories
6 1 Command (6)
6 1 Command (64)
7
100
Path 7 1
Additional filenames to read:
0 = No 1 = Yes
107
2 8 1 Total number of file
names sent
9 Num-
ber of
bytes
File Names (each file or directory name is separated with a null character and the entire data section ends with a null character)
2.25 Opcode 205, Peer-to-Peer Network Messages
Opcode 205 tunnels messages on the peer-to-peer network. the message that is sent to the host to signal an SRBX. Refer to Chapter 6 for an example of spontaneous report-by-exception.
Version
Description
3.50
Introduced
Errors
The opcode responds with an error response if:
No Network module is installed (Error 3) If a tunnel request is pending (Error 76)
ROC Plus Protocol Specifications Manual
2-40 Opcodes Revised March-2021
If the installed Network Radio module is not communicating, is in
boot mode, or is an access point (Error 78)
Indicates an SPI timeout from the Network Radio module (Error 71)
Table 2–28. Opcode 205, Peer-to-Peer Network Messages
Opcode 205
Host Request to ROC800
ROC800 Response to Host
Data
Data
Command
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 205
6 1 Network ID (1-255)
6 1 Network ID (1-255)
7 1 Commissioned Index One based
7 4 Commissioned Index One baseed
8 1 Embedded ROC opcode
8 1 Embedded ROC opcode
9 1 Embedded Request Length
9 1 Embedded Response Length
10
Variable
Embedded Request Data
10
Variable
Embedded Request Data
Note: The embedded Request and Response do not have trailing CRC bytes.
2.26 Opcode 206, Read Transaction History Data
Opcode 206 requests from a transactional history segment (Command 1) a list of transaction numbers and the date those numbers were created and retrieves data from a particular transaction (Command 2).
Version
Description
3.50
Introduced
Table 2–29. Opcode 206, Read Transaction History Data
Opcode 206
Host Request to ROC800
ROC800 Response to Host
Data
Data
Command
Offset
Length
Description of Data
Offset
Length
Description of Data
List Transaction
Lists transactions currently stored in system.
6 1 Command (1)
6 1 Command (1)
7 1 Segment
7 1 Number of transactions in data
8 2 Transaction offset (starts at the first transaction stored in the segment, which is index 0. After rollover, this is not necessarily the oldest transaction.
8 1 More transactions than those returned in this request (0=No, 1=Yes)
9 10
Description
19
2
Payload Size (size of the data portion of these segment transactions). This is the size of all data type
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-41
Opcode 206
Host Request to ROC800
ROC800 Response to Host
Data
Data
Command
Offset
Length
Description of Data
Offset
Length
Description of Data
and value pairs returned in Command
2.
21
2
Transaction number
23
4
Date created
(Above 6 bytes repeated for num transactions)
Read Transaction
Reads data for specified transaction
6 1 Command (2)
6 1 Command (2)
7 1
Segment
7 1 Message Data Size (size of data below this byte)
8 2
Transaction Number
8 1 More data than included in this response (0=No, 1=Yes)
10
2
Offset into data (this is a byte index into the data type value pairs
9 1 Data Type (see Note 1 below)
10
Data
size
Value
(Above TLP, Data Type, Value repeated for num bytes.
Note: The valid data types and corresponding values returned are:
U8 = 1
STRING7 = 10
S8 = 2
STRING10 = 11
U16 = 3
STRING20 = 12
S16 = 4
STRING30 = 14
U32 = 5
T_STRING40 = 15
S32 = 6
BINARY (1 byte) = 17
FLOAT = 7
TLP (3 bytes) = 18
DOUBLE = 8
TIME (4 bytes) = 20
STRING3 = 9
2.27 Opcode 224, SRBX Signal
Opcode 224 represents the message that is sent to the host to signal an SRBX. Refer to Chapter 6 for an example of spontaneous report-by­exception.
Version
Description
1.00
Introduced
ROC Plus Protocol Specifications Manual
2-42 Opcodes Revised March-2021
Table 2–30. Opcode 224, SRBX Signal
Opcodes 224
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 224: Signal Report- by­Exception
Host could possibly use a variety of different ways to retrieve the alarm index.
No data bytes.
2.28 Opcode 225, Acknowledge SRBX
Opcode 225 acknowledges receipt of an SRBX alarm message. Refer to Chapter 6 for an example of spontaneous report-by-exception. This opcode was introduced in version 1.00.
Table 2–31. Opcode 225, Acknowledge SRBX
Opcode 225
Communi-
Host Request to ROC800
ROC800 Response to Host
cation
Data
Data
Opcode
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 225: Acknowledge
Report-by­Exception
6
2
Current Alarm Log index
No data bytes. Acknowledgment
sent back. ROC800 clears SRBX status if the
ROC800’s alarm index equals data received from the host.
2.29 Opcode 255, Error Indicator
Opcode 255 is an error message indicator. If an opcode request is invalid, a request contains invalid data, or a value parmeter is out of range, the response is opcode 255. An error can also be triggered if the
value of the parameter is out of range. This special opcode’s data
consists of an error code byte and an offset byte (see Table 2-38 for a list of error codes). The offset is the byte offset into the message in which an error was detected. Multiple parameters may cause an error, so there may be multiple error codes in the Opcode 255 response. This enables separation of good data from the bad. A multiple set could have some errors returned as well as some data being set. Refer to Table 2-40 for all of the error codes and the opcodes that may cause them. .
Version
Description
1.09
Introduced
This special opcode’s data consists of an error code byte and an offset
byte, as shown below:
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-43
Table 2–32. Opcode 255 Error Codes
Error Code
Description
Byte that caused error
1
Invalid Opcode request.
Opcode
2
Invalid parameter number.
Parameter number
3
Invalid logical number.
Logical number
4
Invalid point type.
Point type
5
Received too many data bytes.
Length
6
Received too few data bytes.
Length
12
Obsolete (Reserved, but not used)
13
Outside valid address range.
Address
14
Invalid history request.
History point number
15
Invalid FST request
FST command number
16
Invalid event entry.
Event code
17
Requested too many alarms.
Number of alarms requested
18
Requested too many events.
Number of events requested
19
Write to read only parameter. Exception for Opcode 166 which can have multiple parameters. Some of these may be RO, and some may not.
Parameter number
20
Security error.
Opcode
21
Invalid security logon.
Login ID or Password
22
Invalid store and forward path.
Any address or group
24
History configuration in progress.
Opcode
25
Invalid parameter range
Parameter
29
Invalid 1 day history index request.
History Segment, point, day or month
30
Invalid history point.
History Point
31
Invalid Min/Max request.
History segment or point number
32
Invalid TLP.
Point type, parameter, or logical number
33
Invalid time.
Seconds, minutes, hours, days, months, or years
34
Illegal Modbus range
Point/Logical number
50
General Error
Any
51
Invalid State for Write
Point type
52
Invalid Configurable Opcode Request
Starting Table Location
61
HART Passthrough Comm Scanner or passthrough disabled on this channel
See Opcode 200
62
HART passthrough not licensed
See Opcode 200
63
Requested Access Level Too High
Access Level
77
Invalid logoff string
Ignored
ROC Plus Protocol Specifications Manual
2-44 Opcodes Revised March-2021
Table 2–33. Opcode 255, Request Multiple History Point Data
Opcode 255
Communi-
Cation
Opcode
Host Request to ROC800
ROC800 Response to Host
Data
Data
Offset
Length
Description of Data
Offset
Length
Description of Data
Opcode 255: Invalid
parameters in request received by ROC800
Reserved for ROC800 use.
6
1
Error code (see Opcode 200)
7
1
Offset of the byte that caused the error.
.
(repeat above as necessary). With the exceptions shown in the Note below:
Note: The following are special cases for the value returned in offset 7:
For opcodes 166 and 167:
Returns the requested point type’s Actual parameter. For
example, if you request parameters 5 through 10 and 6 fails, the value of parameter 6 (not 2) is returned in offset 7.
For opcodes 180 and 181:
Returns the TLP-Tuple offset. For example, if you request ten TLPs and the 9th TLP has an error, 9 values are returned.
ROC Plus Protocol Specifications Manual
Revised March-2021 Opcodes 2-45
Table 2–34. Valid Error Code for a Given Opcode
This chart shows the ROC
Plus Protocol relationship
between opcodes and the
point types that they
reference.
Request current ROC800
Read data and time
Set real time clock
Read configurable opcode point
Write configurable opcode point
Set operator id code
Set store and forward action Request I/O Point Position Request today and yesterday min
and max values
Request history tag and periodic
index
Request alarm data
Request event data
Request history point data
Request history index data Request history index for a day
Set single point parameters Request single point parameters Request parameters
Write parameters
RBX send to host
RBX Ack from host
Error indicator
Description
# 6 7 8 10
11
17
24
50
105
108
118
119
135
136
137
166
167
180
181
224
225
255
Error Codes
Invalid opcode request
1
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
Invalid parameter number
2 NA NA
Invalid logical number
3 x x x x NA NA
Invalid point type
4 NA NA
Received too many data bytes
5 x x x x x x x x x x x x x x x x x x x NA NA
Received too few data bytes
6 x x x x x x x x x x x x x x x x NA x NA
Outside valid address range
13 NA NA
Invalid history request
14 x x NA NA
Invalid FST request
15 NA NA
Invalid event entry
16 NA NA
Requested too many alarms
17 x NA NA
Requested too many events
18 x NA NA
Write to read only parameter
19 x* x NA NA
Security error
20 x NA NA
Invalid security logon
21 x NA NA
Invalid store and forward path
22 x NA NA
Flash programming error
23 NA NA
History configuration in progress
24 x x x x x NA NA
Invalid parameter range
25 x x x x NA NA
ROC Plus Protocol Specifications Manual
2-46 Opcodes Revised March-2021
This chart shows the ROC
Plus Protocol relationship
between opcodes and the
point types that they
reference.
Request current ROC800
Read data and time
Set real time clock
Read configurable opcode point
Write configurable opcode point
Set operator id code
Set store and forward action Request I/O Point Position Request today and yesterday min
and max values
Request history tag and periodic
index
Request alarm data
Request event data
Request history point data
Request history index data Request history index for a day
Set single point parameters Request single point parameters Request parameters
Write parameters
RBX send to host
RBX Ack from host
Error indicator
Description
# 6 7 8 10
11
17
24
50
105
108
118
119
135
136
137
166
167
180
181
224
225
255
Invalid User C++ program number
26 NA NA
No room for User C++ program
27 NA NA
Out of sequence User C++ packet
number
28 NA NA
Invalid 1 day history index request
29 x NA NA
Invalid history point
30 x NA NA
Invalid Min/Max request
31 x NA NA
Invalid TLP
32 x x x x NA NA
Invalid time.
33 x NA NA
Illegal Modbus range
34 x x NA NA
General Error
50 x NA NA
Invalid State for Write
51 x* x NA NA
Invalid Configurable Opcode
Request
52 x x NA NA
* = Exception for opcode 166 which can have multiple parameters. Some of these may be RO or Invalid State, and some may not.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-1
Chapter 3 – Parameter Lists for Point Types
Configuring the ROC800 requires you to be familiar with the structure of the database. The database is broken into individual parameters and each database parameter is uniquely associated by parameter number and point type.
This section details ROC point types, Data Types, and User Defined Point (UDP) Types.
3.1 Type, Location/Logical, and Parameter (TLPs)
You reference data in the ROC800 by type, location or logical, and parameter (TLP). Type refers to the number of the point type. The location or logical number is a value based on physical input or output. A parameter is a numeric value assigned to each piece of data contained in a given point type. The tables in this section list the parameters numbers and descriptions for each of the point types.
3.2 Logical/Location Details
Within a point type, you reference individual points by either a location or a logical number (the “L” in the TLP referencing scheme). The ROC Plus protocol uses location (which is based on a physical input or output [I/O] “module and point” location) for point types 101 through 109. All other point types use a logical number and are simply numbered in sequence.
Location (Physical Point Numbers 1 – 240): For point types 101 through 109, the “L” in “TLP” represents
a number identifying the physical location of the field I/O and the diagnostic inputs. The original release of the ROC809 firmware fixed the number of points per module at 16. ROC800 firmware versions 2.00 and later allow you to select either 8 or 16 points per module (Logical Compatibility Mode, TLP 91,0,50). Depending on the selection of points per module, the location numbers are assigned accordingly:
If you select 8 points per module, the ROC800 reserves Location Numbers 0 to 7 for system I/O. If you
select 16 points per module, the ROC800 reserves Location Numbers 0 to 15 for system I/O. In either case, the five diagnostic points in a ROC800 are locations 0 through 4.
If you select 8 points per module, the ROC800 assigns Location Numbers 8 to 223 to field I/O. For
example, an I/O module in slot 1 with 4 points is assigned points 8 through 11. If you select 16 points per module, the ROC800 assigns Location Numbers 16 to 240 to field I/O. An I/O module in slot 1 with 4 points is assigned points 16 through 19.
ROC Plus Protocol Specifications Manual
3-2 Parameter Lists for Point Types Revised March-2021
Note: If you select 16 points per module for a ROC800 with more than one expansion ring, you cannot
address any I/O modules past slot 14. See the description of Opcode 50 (Request I/O Point Position) in Chapter 2, Opcodes.
Logical (Point Numbers 0 – 127): For all other point types (other than 101 through 109), the logical number
is 0 to x, where x is one less than the total number of points that exist for that point type. For example, the 16 PIDs would be logical numbers 0 through 15.
Table 3-1 details data types.
Table 3–1. Data Type
Data Type
Definition
# of Bytes
Default Range
BIN
Binary
1
0 1 For each Bit
AC
ASCII character groups
1 per character
0x20 0x7E for each character
INT8
Signed Integer – 8 bits
1
-128 127
INT16
Signed Integer – 16 bits
2
-32,768 32,767
INT32
Signed Integer – 32 bits
4
-2,147,483,648 2,147,483,647
UINT8
Unsigned Integer – 8 bits
1
0 255
UINT16
Unsigned Integer – 16 bits
2
0 65,535
UINT32
Unsigned Integer – 32 bits
4
0 4,294,967,296
FL or FLOAT
Single Precision Floating Point – IEEE Format
4
Any valid IEEE double precision float (see Chapter 5)
DBL
Double Precision Floating Point – IEEE Format
8
Any valid IEEE double precision float (see Chapter 5)
TLP
Type, Point or Logical Number, Parameter Number
3
{0 255, 0 255, 0 2 55}
TIME
Arithmetic Time: Number of seconds since Jan 1 1970 @ 00:00:00. This is a UINT32.
4
0 0 4,294,967,296
Jan 1, 1970 00:00:00 Feb. 7, 2106 06:28:15
3.3 Binary Field (BIN) Example
This section provides an example alarm code from an analog input point type to demonstrate how a binary parameter is returned. A 1 in any bit indicates that bit is active or enabled.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-3
Scanning Disabled Alarm
Point Fail Alarm
Not Used
Rate Alarm
High High Alarm High Alarm
Low Low Alarm Low Alarm
Bit
7 6 5 4 3 2 1
0
Response Code
1 0 0 0 0 0 0
0
3.4 Point Type Table Fields
Each point type table is prefaced by a short description, a statement of the number of logical points (or iterations) of the point type, and the storage location for point type information. Point type tables contain the following information:
Field
Description
Param#
Defines the specific parameter number associated with that point type.
Name
Provides the name of the parameter.
Access
Indicates if the parameter can be read from and written to (R/W) or if the parameter is read-only (R/O).
System or User Update
Identifies who has write access to the data.
Data Type
Identifies the type of data being stored. Data types are defined in Chapter 2.
Length
Indicates the number of bytes the parameter uses.
Range
Identifies the range of accepted values for the parameter.
Default
Indicates the initial value of the parameter.
Ver
Identifies the version of program in which the parameter was first introduced.
Description
Provides a brief description of the parameter.
ROC Plus Protocol Specifications Manual
3-4 Parameter Lists for Point Types Revised March-2021
3.4.1 Point Type 82: Virtual Discrete Outputs
Description:
Point type 82 provides the Virtual Discrete Outputs parameters for setting up discrete outputs.
Number of Logical Points:
24 logical points for Virtual Discrete Outputs may exist.
Storage Location:
Point type 82 is saved to internal configuration memory.
Table 3-2: Point Type 82, Virtual Discrete Outputs
Point Type 82, Virtual Discrete Outputs
Param #
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
0
Point Tag ID
R/W
User
AC
10
0x20 0x7E for each
ASCII character
“DO
Default”
3.02
Identification name for specific DO. Values must be printable ASCII characters.
1
Units Tag
R/W
User
AC
10
0x20 0x7E for each
ASCII character
“Percent “
3.02
Describes the units used by the DO. Values must be printable ASCII characters.
2
Scanning Mode
R/W
User
UINT8
1
0 → 2
1
3.02
Indicates the scanning mode. Valid values are:
0 = Disabled (no changes to output occur) 1 = Automatic (anything changes DO values) 2 = Manual (only user can change DO values)
3
Alarming
R/W
User
UINT8
1
0 → 1
0
3.02
If enabled, alarms may be generated and sent to the Alarm Log. Valid values are 0 (Disabled) and 1 (Enabled).
4
SRBX on Clear
R/W
User
UINT8
1
0 → 1
0
3.02
Indicates a SRBX alarm is desired if an alarm condition clears. Valid values are 0 (SRBX on Clear Disabled) and 1 (SRBX on Clear Enabled).
5
SRBX on Set
R/W
User
UINT8
1
0 → 1
0
3.02
Indicates a SRBX alarm is desired if an alarm condition occurs. Valid values are 0 (SRBX on Set Disabled) and 1 (SRBX on Set Enabled).
6
Alarm Code
R/O
System
BIN
1
0x00 0xFF
0x00
3.02
6.0
Not Used
Bit 0
0
Not Used
6.1
Not Used
Bit 1
0
Not Used
6.2
Not Used
Bit 2
0
Not Used
6.3
Not Used
Bit 3
0
Not Used
6.4
Not Used
Bit 4
0
Not Used
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-5
Point Type 82, Virtual Discrete Outputs
Param #
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
6.5
Scanning Manual Alarm
Bit 5
0
3.02
If set, the Scanning (parameter #2) has been set to Manual. If clear, the Scanning (parameter #2) has been set to either Disable or Automatic
6.6
Not Used
Bit 6
0
Not Used
6.7
Scanning Disabled Alarm
Bit 7
0
3.02
If set, the Scanning (parameter #2) has been disabled. If clear, the Scanning (parameter #2) has been set to either Automatic or Manual.
7
Failsafe on Reset
R/W
User
UINT8
1
0 → 1
0
3.02
If enabled, the Status (parameter #8) is set to
the status indicated in ‘Failsafe Status Value’
(Parameter #22) on a restart of any kind. If disabled, the last Status before the restart will be used. Valid values are 0 (Output Last Status on Reset) and 1 (Use Failsafe value on Reset).
8
Auto Output
R/W
Both
UINT8
1
0 → 1
0
3.02
Controls the state of the DO when Scanning (parameter #2) is in auto mode. In other words, the physical output gets this status when the mode (parameter # 2) is set to Automatic.
9
Accumulated Value
R/W
Both
UINT32
4
0 → 4,294,967,295
0
3.02
Number of times the Status (parameter #8) goes from OFF to ON.
10
Momentary Mode
R/W
User
UINT8
1
0 → 1
0
3.02
If enabled, the Status (parameter #8) is turned ON for the entered Time On (parameter #14) and then be turned OFF. Valid valules are 0 (Momentary Disabled) and 1 (Momentary Enabled).
11
Momentary Active
R/O
System
UINT8
1
0 → 1
0
3.02
Indicates that the DO currently has the Momentary ability active. Valid values are 0 (Momentary Not Active) and 1 (Momentary Active).
12
Toggle Mode
R/W
User
UINT8
1
0 → 1
0
3.02
If enabled, the Status (parameter #8) is ON for the entered Time On (parameter #14) and then turned OFF for the same Time On. The Status continues to cycle between the ON and OFF states. Vallid values are 0 (Toggle Disabled) and 1 (Toggle Enabled).
ROC Plus Protocol Specifications Manual
3-6 Parameter Lists for Point Types Revised March-2021
Point Type 82, Virtual Discrete Outputs
Param #
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
13
Timed Discrete Output (TDO) Mode
R/W
User
UINT8
1
0 → 1
0
3.02
If enabled, the Status (parameter #8) is turned ON for a calculated Time On (parameter #14) based upon the entered EU Value (parameter #20). After the Time On has expired, the Status is turned OFF and remains that way until a new EU Value is entered. Valid values are 0 (TDO Disabled) and 1 (TDO Enabled).
14
Time On
R/W
Both
FL
4
DO: 0.002 43,200.0
DOR: 0.05 43,200.0
1.0
3.02
Number of seconds the Status (parameter #8) is turned on for if in TDO, Toggle, or Momentary Mode.
15
Cycle Time
R/W
User
FLOAT
4
>0.0 43,200.0
15.0
3.02
Number of seconds for when TDO Mode (parameter #13) and Toggle Mode (parameter #12) are selected. The Status (parameter #8) is ON for the calculated Time On (parameter #14) based upon the entered EU Value (parameter #20). The Status is then turned OFF based upon the Cycle Time minus the Time On.
16
Low Reading Time
R/W
User
FLOAT
4
0.0 → 43,200.0
3.0
3.02
Minimum number of seconds the calculated Time On (parameter #14) is when the entered EU Value (parameter #20) is less than or equal to the entered Low Reading EU (parameter #18).
17
High Reading Time
R/W
User
FLOAT
4
0.0 → 43,200.0
12.0
3.02
Maximum number of seconds the calculated Time On (parameter #14) will be when the entered EU Value (parameter #20) is greater than or equal to the entered High Reading EU (parameter #19).
18
Low Reading EU
R/W
User
FLOAT
4
Any valid IEEE 754 float
0.0
3.02
Minimum EU Value (parameter #20) possible.
19
High Reading EU
R/W
User
FLOAT
4
Any valid IEEE 754 float
100.0
3.02
Maximum EU Value (parameter #20) possible.
20
EU Value
R/W
Both
FLOAT
4
Any valid IEEE 754 float
0.0
3.02
Value in Engineering Units.
21
Manual Output
R/W
Both
UINT8
1
0 → 1
0
3.02
Controls the state of the DO when Scanning (parameter #2) is in manual mode. In other words, the physical output gets this status when the mode (parameter # 2) is set to Automatic.
22
Failsafe Output
R/W
User
UINT8
1
0 → 1
1
3.02
The state the output is placed in when the unit is started and the Failsafe on Reset Parameter (Parameter 7) is set to 1, Use Failsafe value on reset.
23
Max Scan Period
R/O
System
FLOAT
4
0.0→Any positive valid IEEE 754 float
2
3.02
How often (in seconds) the DOs are rewritten.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-7
Point Type 82, Virtual Discrete Outputs
Param #
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
24
Physical Output
R/O
System
UINT8
1
0 → 1
0
3.02
Indicates the current state of the DO. Valid values are 1 (ON) and 0 (OFF).
25
DO Type
R/O
System
UINT8 1 2
0
3.02
Indicates the DO type. Only current valid vauis is 2 (Virtual DO).
26
Invert Output Mode
R/W
User
UINT8
1
0 → 1
0
1.00
Inverts the output of the DO channel, allowing you to use TDO mode tp keep a channel OFF for a set amount of time and then bringi the channel back ON. Valid values are 0 (Normal) and 1 (Inverted). Note: This always inverts the output, including the Failsafe Output.
ROC Plus Protocol Specifications Manual
3-8 Parameter Lists for Point Types Revised March-2021
3.4.2 Point Type 84: HART Extended Point Type
Description:
Point type 84 provides the HART parameters associated with the HART 2 module.
Number of Logical Points:
4 logicals per installed module imay exist.
Storage Location:
Any parameter noted as “persistent” is saved to internal configuration memory.
Table 3-3: Point Type 84, HART Extended Point Type
Point Type 84, HART Extended
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
0
Channel Alarming
R/W
User
UINT8 1 0-1
0
3.10
If enabled, generates channel alarms and sends them to the Alarm Log. Valid values are 0 (Disabled) and 1 (Enabled). Note: This parameter is persistent.
1
Channel Alarm Code
R/O
System
BIN
1
0x00 0xFF
0
3.10
Alarm value for the HART channel. Note: This parameter is persistent.
1.0
AI Low Alarm
Bit 0
0
If set, the HART AI EU value is less than or equal to the AI Low Alarm EU (parameter #2). If clear, the HART EU value is greater than the AI Low Alarm EU (parameter #2). Only applies when the channel is configured as an AI.
1.2
AI High Alarm
Bit 2
0
If set, the HART AI EU value is greater than or equal to the AI High Alarm EU (parameter #3). If clear, the HART EU value is less than the AI High Alarm EU (parameter #3). Only applies when the channel is configured as an AI.
1.5
AO Readback Alarm
Bit 5
0
If set, the HART module is not detecting a device on the output line. If clear, the analog output is functioning correctly. Only applies when the channel is configured as an AO.
1.6
Point Fail Alarm
Bit 6
0
If set, communicating with the HART module
has failed. If clear, the HART’s hardware is
operating properly.
2
AI Low Alarm EU
R/W
User
FLOAT
4
Any valid IEEE 754
float
-10.0
3.10
Alarm value for HART AI Low Alarm. Note: This parameter is persistent.
3
AI High Alarm EU
R/W
User
FLOAT
4
Any valid IEEE 754
float
110.0
3.10
Alarm value for HART AI High Alarm. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-9
Point Type 84, HART Extended
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
4
Alarm Deadband
R/W
User
FLOAT
4
Any valid IEEE 754
float
2.0
3.10
Provides a range () that the HART AI EU Value may move between without causing another alarm. Note: This parameter is persistent.
5
Device 1 Alarming
R/W
User
UINT8 1 0-1
0
3.10
If enabled, generates device alarms and sends them to the Alarm Log. Valid values are 0 (Disabled) and 1 (Enabled). Note: This parameter is persistent.
6
Device 1 Alarm Code
R/O
System
BIN
1
0x00 0xFF
0
3.10
Alarm code for the device on the HART channel. Note: This parameter is persistent.
6.0
Device 1 PV Low Alarm
Bit 0
0
If set, the Device PV value is less than or equal to the Device PV Low Alarm Value. If clear, the Device PV value is greater than the Device PV Low Alarm Value.
6.2
Device 1 PV High Alarm
Bit 2
0
If set, the Device PV value is greater than or equal to the Device PV High Alarm Value. If clear, the Device PV value is less than the Device PV High Alarm Value.
6.6
Device 1 Point Fail Alarm
Bit 6
0
If set, communicating with the HART Device has failed. If clear, the HART Device is operating correctly.
7
Device 1 PV Low Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
-10
3.10
Alarm value for Device PV Low Alarm. Note: This parameter is persistent.
8
Device 1 PV High Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
1,000,000
3.10
Alarm value for Device PV High Alarm. Note: This parameter is persistent.
9
Device 1 Alarm Deadband
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
3.10
Provides a range () that the Device PV Value may move between without causing another alarm. Note: This parameter is persistent.
10
Device 1 Download PV
R/W
USER
FLOAT
4
Any valid IEEE 754
float
0
3.10
When the device Poll Mode is set to Download PV (4), the PV value of the device is set to the Device Download PV value. Note: This parameter is persistent.
11
Device 1 Live PV Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
3.10
The current value of the PV returned from the card or last live value if scan mode is set to Skip this Device or Slot modes. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
3-10 Parameter Lists for Point Types Revised March-2021
Point Type 84, HART Extended
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
12
Device 1 In Use Mode
R/W_
LOG
User
UINT8 1 0-2
0
3.10
Determines what value is used to populate the PV parameter. Valid values are: 0 = live or last live 1 = failsafe value 2 = download value. Overrides failsafe mode except when in live mode. Note: This parameter is persistent.
13
Device 1 In Use Status
R/O
System
UINT8 1 0-6
0
3.10
Status of what value is being used to populate the PV. Valid values are: 0 = live or last live value without failure 1 = last live/scanning disabled 2 = failed to last live value 3 = failed to download value 4 = failed to failsafe value, 5 = set to download value, 6 = set to failsafe value Note: This parameter is persistent.
14
Device 2 Alarming
R/W
User
UINT8 1 0-1
0
3.10
If enabled, device alarms may be generated and sent to the Alarm Log. Valid values are 0 (Disabled) and 1 (Enabled). Note: This parameter is persistent.
15
Device 2 Alarm Code
R/O
System
BIN
1
0x00 0xFF
0
3.10
Alarm code for the device on the HART channel. Note: This parameter is persistent.
15.0
Device 2 PV Low Alarm
Bit 0
0
If set, the Device PV value is less than or equal to the Device PV Low Alarm Value. If clear, the Device PV value is greater than the Device PV Low Alarm Value.
15.2
Device 2 PV High Alarm
Bit 2
0
If set, the Device PV value is greater than or equal to the Device PV High Alarm Value. If clear, the Device PV value is less than the Device PV High Alarm Value.
15.6
Device 2 Point Fail Alarm
Bit 6
0
If set, communicating with the HART Device has failed. If clear, the HART Device is operating correctly.
16
Device 2 PV Low Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
-10
3.10
Alarm value for Device PV Low Alarm. Note: This parameter is persistent.
17
Device 2 PV High Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
1,000,000
3.10
Alarm value for Device PV High Alarm. Note: This parameter is persistent.
18
Device 2 Alarm Deadband
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
3.10
Provides a range () within which the Device PV Value may move between without causing another alarm. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-11
Point Type 84, HART Extended
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
19
Device 2 Download PV
R/W
USER
FLOAT
4
Any valid IEEE 754
float
0
3.10
When the device Poll Mode is set to Download PV (4), the PV value of the device is set to the Device Download PV value. Note: This parameter is persistent.
20
Device 2 Live PV Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
3.10
The current value of the PV returned from the card or last live value if scan mode is set to Skip this Device or Slot modes. Note: This parameter is persistent.
21
Device 2 In Use Mode
R/W
User
UINT8 1 0-2
0
3.10
Determines what value populates the PV parameter. Valid values are: 0 = live or last live 1 = failsafe value 2 = download value. Overrides failsafe mode except when in live mode. Note: This parameter is persistent.
22
Device 2 In Use Status
R/O
System
UINT8 1 0-6
0
3.10
Status of what value is being used to populate the PV. Valid values are: 0 = live or last live value without failure 1 = last live/scanning disabled 2 = failed to last live value 3 = failed to download value, 4 = failed to failsafe value 5 = set to download value 6 = set to failsafe value Note: This parameter is persistent.
23
Device 3 Alarming
R/W
User
UINT8 1 0-1
0
3.10
If enabled, device alarms may be generated and sent to the Alarm Log. Valid values are 0 (Disabled) and 1 (Enabled). Note: This parameter is persistent.
24
Device 3 Alarm Code
R/O
System
BIN
1
0x00 0xFF
0
3.10
Alarm code for the device on the HART channel. Note: This parameter is persistent.
24.0
Device 3 PV Low Alarm
Bit 0
0
If set, the Device PV value is less than or equal to the Device PV Low Alarm Value. If clear, the Device PV value is greater than the Device PV Low Alarm Value.
24.2
Device 3 PV High Alarm
Bit 2
0
If set, the Device PV value is greater than or equal to the Device PV High Alarm Value. If clear, the Device PV value is less than the Device PV High Alarm Value.
24.6
Device 3 Point Fail Alarm
Bit 6
0
If set, communicating with the HART Device has failed. If clear, the HART Device is operating correctly.
ROC Plus Protocol Specifications Manual
3-12 Parameter Lists for Point Types Revised March-2021
Point Type 84, HART Extended
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
25
Device 3 PV Low Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
-10
3.10
Alarm value for Device PV Low Alarm. Note: This parameter is persistent.
26
Device 3 PV High Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
1,000,000
3.10
Alarm value for Device PV High Alarm. Note: This parameter is persistent.
27
Device 3 Alarm Deadband
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
3.10
Provides a range () that the Device PV Value may move between without causing another alarm. Note: This parameter is persistent.
28
Device 3 Download PV
R/W
USER
FLOAT
4
Any valid IEEE 754
float
0
3.10
When the device Poll mode is set to Download PV (4), the PV value of the device is set to the Device Download PV value. Note: This parameter is persistent.
29
Device 3 Live PV Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
3.10
The current value of the PV returned from the card or last live value if Scan mode is set to Skip this Device or Slot modes. Note: This parameter is persistent.
30
Device 3 In Use Mode
R/W
User
UINT8 1 0-2
0
3.10
Determines what value populates the PV parameter. Valid values are: 0 = live or last live 1 = failsafe value 2 = download value. Overrides failsafe mode except when in live mode. Note: This parameter is persistent.
31
Device 3 In Use Status
R/O
System
UINT8 1 0-6
0
3.10
Status of what value is being used to populate the PV. Valid values are: 0 = live or last live value without failure 1 = last live/scanning disabled 2 = failed to last live value 3 = failed to download value 4 = failed to failsafe value 5 = set to download value 6 = set to failsafe value. Note: This parameter is persistent.
32
Device 4 Alarming
R/W
User
UINT8 1 0-1
0
3.10
If enabled, device alarms may be generated and sent to the Alarm Log. Valid values are 0 (Disabled) and 1 (Enabled). Note: This parameter is persistent.
33
Device 4 Alarm Code
R/O
System
BIN
1
0x00 0xFF
0
3.10
Alarm code for the device on the HARTchannel. Note: This parameter is persistent.
33.0
Device 4 PV Low Alarm
Bit 0
0
If set, the Device PV value is less than or equal to the Device PV Low Alarm Value. If clear, the Device PV value is greater than the Device PV Low Alarm Value.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-13
Point Type 84, HART Extended
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
33.2
Device 4 PV High Alarm
Bit 2
0
If set, the Device PV value is greater than or equal to the Device PV High Alarm Value. If clear, the Device PV value is less than the Device PV High Alarm Value.
33.6
Device 4 Point Fail Alarm
Bit 6
0
If set, communicating with the HART Device has failed. If clear, the HART Device is operating correctly.
34
Device 4 PV Low Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
-10
3.10
Alarm value for Device PV Low Alarm. Note: This parameter is persistent.
35
Device 4 PV High Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
1,000,000
3.10
Alarm value for Device PV High Alarm. Note: This parameter is persistent.
36
Device 4 Alarm Deadband
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
3.10
Provides a range () that the Device PV Value may move between without causing another alarm. Note: This parameter is persistent.
37
Device 4 Download PV
R/W
USER
FLOAT
4
Any valid IEEE 754
float
0
3.10
When the device Poll Mode is set to Download PV (4), the PV value of the device is set to the Device Download PV value. Note: This parameter is persistent.
38
Device 4 Live PV Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
3.10
The current value of the PV returned from the card or last live value if scan mode is set to Skip this Device or Slot modes. Note: This parameter is persistent.
39
Device 4 In Use Mode
R/W
User
UINT8 1 0-2
0
3.10
Determines what value populates the PV parameter. Valid values are: 0 = live or last live 1 = failsafe value 2 = download value. Overrides failsafe mode except when in live mode. Note: This parameter is persistent.
40
Device 4 In Use Status
R/O
System
UINT8 1 0-6
0
3.10
Status of what value is being used to populate the PV. Valid values are: 0 = live or last live value without failure 1 = last live/scanning disabled 2 = failed to last live value 3 = failed to download value 4 = failed to failsafe value 5 = set to download value 6 = set to failsafe value Note: This parameter is persistent.
41
Device 5 Alarming
R/W
User
UINT8 1 0-1
0
3.10
If enabled, device alarms may be generated and sent to the Alarm Log. Valid values are 0 (Disabled) and 1 (Enabled). Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
3-14 Parameter Lists for Point Types Revised March-2021
Point Type 84, HART Extended
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
42
Device 5 Alarm Code
R/O
System
BIN
1
0x00 0xFF
0
3.10
Alarm code for the device on the HART channel. Note: This parameter is persistent.
42.0
Device 5 PV Low Alarm
Bit 0
0
If set, the Device PV value is less than or equal to the Device PV Low Alarm Value. If clear, the Device PV value is greater than the Device PV Low Alarm Value.
42.2
Device 5 PV High Alarm
Bit 2
0
If set, the Device PV value is greater than or equal to the Device PV High Alarm Value. If clear, the Device PV value is less than the Device PV High Alarm Value.
42.6
Device 5 Point Fail Alarm
Bit 6
0
If set, communicating with the HART device has failed. If clear, the HART device is operating correctly.
43
Device 5 PV Low Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
-10
3.10
Alarm value for Device PV Low Alarm. Note: This parameter is persistent.
44
Device 5 PV High Alarm Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
1,000,000
3.10
Alarm value for Device PV High Alarm. Note: This parameter is persistent.
45
Device 5 Alarm Deadband
R/W
User
FLOAT
4
Any valid IEEE 754
float
2.0
3.10
Provides a range () in which the Device PV Value may move between without causing another alarm. Note: This parameter is persistent.
46
Device 5 Download PV
R/W
USER
FLOAT
4
Any valid IEEE 754
float
0
3.10
When the device Poll Mode is set to Download PV (4), the PV value of the device is set to the Device Download PV value. Note: This parameter is persistent.
47
Device 5 Live PV Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
3.10
The current value of the PV returned from the card or last live value if scan mode is set to Skip this Device or Slot modes. Note: This parameter is persistent.
48
Device 5 In Use Mode
R/W
User
UINT8 1 0-2
0
3.10
Determines what value is used to populate the PV parameter. Valid values are: 0 = live or last live 1 = failsafe value 2 = download value. Overrides failsafe mode except when in live mode. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-15
Point Type 84, HART Extended
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
49
Device 5 In Use Status
R/O
System
UINT8 1 0-6
0
3.10
Status of what value is being used to populate the PV. Valid values are: 0 = live or last live value without failure 1 = last live/scanning disabled 2 = failed to last live value 3 = failed to download value 4 = failed to failsafe value 5 = set to download value 6 = set to failsafe value Note: This parameter is persistent.
50
Units Tag
R/W
User
AC
10
0x20 0x7E for each
ASCII character
“ “
3.40
Describes the units the HART AI uses. Values must be primarily ASCII characters. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
3-16 Parameter Lists for Point Types Revised March-2021
3.4.3 Point Type 85: HART Point Type
Description:
Point type 85 is a User Defined Point Type to allow storage for user defined data.
Number of Logical Points:
4 logicals per installed module may exist.
Storage Location:
Any parameter noted as “persistent” is saved to internal configuration memory.
Table 3-4: Point Type 85, HART Point Type
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
0
(HART 1)
Channel Version
R/O
System
AC
10
0x20 - 0x5F for each
byte
" "
1.40
Version number for the firmware in the channel.
0
(HART 2)
RESERVED
R/O
System
AC
10
0x20 - 0x5F for each
byte
" "
3.10
Version number for the firmware in the channel.
1
(HART 1)
Channel I/O
R/O
System
UINT8 1 0 – 1
0
1.40
Indicates if a channel is an analog input or output. Valid values are 0 (Input) and 1 (Output). Note: This parameter is persistent.
1
(HART 2)
Channel II/O
R/W
User
UINT8 1 0 – 1
0
3.10
Indicates if a channel is an analog input or output. Valid values are 0 (Input) and 1 (Output). Note: This parameter is persistent.
2
(HART 1)
HART Communication Mode
R/W
User
UINT8 1 0 – 2
1
1.40
If disabled, all HART communication stops and no changes occur unless manually entered. Valid values are: 0 = Disabled 1 = Point to Point, 2 = Multidrop Note: This parameter is persistent.
2
(HART 2)
HART Communication Mode
R/W
User
UINT8
1
Bits 0-6: 0 – 2
Bit7: 0 – 1
1
1.00
If disabled, all HART communication stops and no changes occur unless manually entered. Bits 0-6: 0 = Disabled 1 = Point to Point, 2 = Multidrop
Bit 7: 0 = Primary Master 1 = Secondary Master Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-17
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
3
Number of Devices Connected
R/W
User
UINT8 1 1 – 5
1
1.40
Indicates the number of devices connected in multidrop mode. Note: This parameter is persistent.
4
(HART 1)
HART COM Status
R/O
System
UINT8 1 0 – 3
1
1.40
0 = Not Scanning 1 = Scanning Normal 2 = Dual Master Detected 3 = Pass thru
4
(HART 2)
HART COM Status
R/O
System
UINT8 1 0 – 4
1
3.10
0 = Not Scanning 1 = Scanning Normal 2 = Dual Master Detected 3 = Pass thru 4 = Device in Burst Mode Detected .
5
Analog Mode
R/W
User
UINT8 1 0– 4
1
1.40
Analog Input: 0 = Disabled 1 = Enabled 3 = Calibration – EU Value not longer updates and freezes at this value. 4 = Cancel Calibration (restore previous calibration)
Analog Output: 0 = Disabled 1 = Enabled (Auto) 2 = Manua Note: This parameter is persistent.
6
ROC Protocol Pass Thru Enable
R/W
User
UINT8 1 0 – 2
1
1.40
Enables ROC protocol pass thru communication. 0 = Disabled, 1 = Enabled 0 = Disable 1 = Strip all bytes, including preambles, before message 2 = Don’t alter the message, return all bytes.
This parameter is only R/W (to other than
0) if the license is available for this feature. Note: This parameter is persistent.
7
(HART 1)
ROC Protocol Pass Thru Timeout
R/W
User
UINT32
4
0 - 4,294,967,295
5000
1.40
Timeout in milliseconds to resume polling of HART device after receiving ROC protocol pass thru communication. Note: This parameter is persistent.
7
(HART 2)
Internal Resistor Control
R/W
User
UINT32
4
0 - 4,294,967,295
5000
3.10
Enables or disables internal resistor. Bits 0-30 are unused. Valid values for Bit 31 are 0 (Enabled) and 1 (Disabled). Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
3-18 Parameter Lists for Point Types Revised March-2021
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
8
EU Value
R/O
Both
FLOAT
4
Any valid IEEE 754
float
0
1.40
EU value of analog input or output. Note: This parameter is persistent.
9
Failsafe on Reset
R/W
User
UINT8 1 0 – 1
0
1.40
0 = Use last EU Value on reset 1 = Use Failsafe value on Reset If enabled (1), the raw D/A Output will be set to the Failsafe value on a restart of any kind. If disabled, the last EU Value or the last saved EU Value will be used to determine the Raw D/A Output after a restart. Note: This parameter is persistent.
10
Failsafe Value
R/W
Both
FLOAT
4
Any valid IEEE 754
float
0.0
1.40
The value outputted when the unit is started and the Failsafe on Reset Parameter is set to 1, Use Failsafe value on reset. Note: This parameter is persistent.
11
Manual Value
R/W
Both
FLOAT
4
Any valid IEEE 754
float
0.0
1.40
Indicates the EU value used as an output when Scanning is in manual mode. Note: This parameter is persistent.
12
Auto Value
R/W
Both
FLOAT
4
Any valid IEEE 754
float
0.0
1.40
Indicates the EU value used as an output when Scanning is in auto mode. Note: This parameter is persistent.
13
Physical Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0.0
1.40
Indicates the current value of the output in Engineering Units. Note: This parameter is persistent.
14
Physical Raw D/A Output
R/O
System
UINT16
2
0 → 65,535
AI: 0
AO: 5,257
1.40
Calculated Digital-to-Analog value based upon the EU value currently being outputted EU Value.
15
Cabribration Live Value
R/O
Both
FLOAT
4
Any valid IEEE 754
float
0.0
1.40
Live value when calibrating an AI. Note: This parameter is persistent.
16
EU Calibration Value Zero
R/W
User
FLOAT
4
Any valid IEEE 754
float
0.0
1.40
Indicates the zero EU calibration value. Note: This parameter is persistent.
17
EU Calibration Value Span
R/W
User
FLOAT
4
Any valid IEEE 754
float
100.0
1.40
Indicates the span EU calibration value. Note: This parameter is persistent.
18
EU Raw Value
R/O
System
UINT16 2 0 - 65535
0
1.40
Indicates the raw EU value of analog input or output. Note: This parameter is persistent.
19
EU Raw Calibration Zero
R/W
System
UINT16 2 0 - 65535
AI: 621
AO: 5,257
1.40
Indicates the zero raw EU calibration value. Note: This parameter is persistent.
20
EU Raw Calibration Span
R/W
System
UINT16 2 0 - 65535
AI:3,103
AO: 26,287
1.40
Indicates the span raw EU calibration value. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-19
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
21
(HART 1)
Device 1 Poll Mode
R/W
User
UINT8 1 0-5
0
1.40
Indicates the polling mode for device. Valid values are: 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables 4 = Full Update Note: This parameter is persistent.
21
(HART 2)
Device 1 Poll Mode
R/W
User
UINT8
1
Bit 7: 0 – 1
Bits 0-6: 0 –3
0
1.40
Bit 7: Update State: 1=update, 0=no update
Bits 0-6: 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables Note: This parameter is persistent.
22
Device 1 Polling Address
R/O
Both
UINT8 1 0-15
0
1.40
Polling address for device 1.
23
Device 1 Status
R/O
System
UINT8 1 0-1
0
1.40
0 = No Device Found 1 = Communicating 2 = Comm Error
24
Device 1 Actual Scan Period
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Period at which device 1 is being updated.
25
Device 1 Tag
R/W
Both
AC
10
0x20 - 0x5F for each
byte
"."
1.40
Tag that resides in device 1. Note: This parameter is persistent.
26
Device 1 Response Code/Status
R/O
System
UINT16 2 0 - 65535
0
1.40
Response code and status received from device 1.
27
Device 1 Active Alarms
R/O
System
UINT8 1 0 - 255
0
1.40
Active alarms reported by device 1.
28
Device 1 Current (mA)
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Current in milliamps reported by device 1.
29
Device 1 Percent of Range
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Percent of range reported by device 1.
30
(HART 1)
Device 1 Fail Safe Enable
R/W
User
UINT8 1 0 - 1
0
1.40
Enables the use of fail safe values for the dynamic variables when the unit resets for device 1: Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
3-20 Parameter Lists for Point Types Revised March-2021
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
30
(HART 2)
Device 1 Fail Safe Enable
R/W
User
UINT8 1 0 - 1
0
3.10
Enables the use of fail safe or download values for the dynamic variables when the unit detects an error for device 1. Valid values are: 0 = live or last live 1 = failsafe values 2 = download value for PV, failsafe values for other dynamic variables. Note: This parameter is persistent.
31
Device 1 PV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for primary variable reported by device 1.
32
Device 1 PV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of primary variable of device 1. Note: This parameter is persistent.
33
Device 1 PV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Primary fail safe value for device 1. Note: This parameter is persistent.
34
Device 1 SV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for secondary variable reported by device 1.
35
Device 1 SV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of secondary variable of device 1. Note: This parameter is persistent.
36
Device 1 SV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Secondary fail safe value for device 1. Note: This parameter is persistent.
37
Device 1 TV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for tertiary variable reported by device 1.
38
Device 1 TV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of tertiary variable of device 1. Note: This parameter is persistent.
39
Device 1 TV Fail Safe on Reset Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Tertiary fail safe value for device 1. Note: This parameter is persistent.
40
Device 1 FV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for fourth variable reported by device 1.
41
Device 1 FV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of fourth variable of device 1. Note: This parameter is persistent.
42
Device 1 FV Fail Safe on Reset Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Fourth fail safe value of device 1. Note: This parameter is persistent.
43
Device 1 Slot 0 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 0 variable to request from device 1. Note: This parameter is persistent.
44
Device 1 Slot 0 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 0 variable requested from device 1.
45
Device 1 Slot 0 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 0 variable requested from device 1.
46
Device 1 Slot 1 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 1 variable to request from device 1. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-21
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
47
Device 1 Slot 1 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 1 variable requested from device 1.
48
Device 1 Slot 1 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 1 variable requested from device 1.
49
Device 1 Slot 2 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 2 variable to request from device 1. Note: This parameter is persistent.
50
Device 1 Slot 2 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 2 variable requested from device 1.
51
Device 1 Slot 2 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 2 variable requested from device 1.
52
Device 1 Slot 3 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 3 variable to request from device 1. Note: This parameter is persistent.
53
Device 1 Slot 3 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 3 variable requested from device 1.
54
Device 1 Slot 3 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 3 variable requested from device 1.
55
Device 1 Message
R/W
Both
AC
40
0x20 - 0x5F for each
byte
" "
1.40
Device 1 message.
56
Device 1 Descriptor
R/W
Both
AC
20
0x20 - 0x5F for each
byte
" "
1.40
Device 1 descriptor.
57
Device 1 Manufacture's ID and Device ID
R/O
System
UINT16 2 0 - 65535
0
1.40
Device 1 manufacture's ID and device's ID
58
Device 1 Serial Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 1 serial number.
59
Device 1 ID Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 1 ID number.
60
Device 1 Sensor Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 1 sensor units.
61
Device 1 Upper Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 1 upper sensor limit.
62
Device 1 Lower Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 1 lower sensor limit.
63
Device 1 Minimum Span
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 1 minimum sensor span.
64
Device 1 Output Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 1 Output Units
65
Device 1 Upper Output Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 1 upper output limit.
66
Device 1 Lower Output Limit
R/O
System
FLOAT FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 1 lower output limit.
67
Device 1 Damping Value
R/O
System
FL
4
Any valid IEEE 754
float
0
1.40
Device 1 damping value.
ROC Plus Protocol Specifications Manual
3-22 Parameter Lists for Point Types Revised March-2021
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
68
(HART 1)
Device 2 Poll Mode
R/W
User
UINT8 1 0-255
0
1.40
Polling mode for device 2. Valid values are: 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables 4 = Full Update Note: This parameter is persistent.
68
(HART 2)
Device 2 Poll Mode
R/W
User
UINT8
1
Bit 7: 0 – 1
Bits 0-6: 0 –3
0
3.10
Polling mode for device 2. Bit 7: Update State: 1=update, 0=no update Bits 0-6: 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables Note: This parameter is persistent.
69
Device 2 Polling Address
R/O
Both
UINT8 1 0-15
0
1.40
Polling address for device 2.
70
Device 2 Status
R/O
System
UINT8 1 0-1
0
1.40
0 = No Device Found 1 = Communicating 2 = Comm Error (HART 2)
71
Device 2 Actual Scan Period
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Period at which device 2 is being updated.
72
Device 2 Tag
R/W
Both
AC
10
0x20 - 0x5F for each
byte
" "
1.40
Tag that resides in device 2. Note: This parameter is persistent.
73
Device 2 Response Code/Status
R/O
System
UINT16 2 0 - 65535
0
1.40
Response code and status received from device 2.
74
Device 2 Active Alarms
R/O
System
UINT8 1 0 - 255
0
1.40
Active alarms reported by device 2.
75
Device 2 Current (mA)
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Current in milliamps reported by device 2.
76
Device 2 Percent of Range
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Percent of range reported by device 2.
77
(HART `1)
Device 2 Fail Safe on Reset Enable
R/W
User
UINT8 1 0 - 1
0
1.40
Enables the use of fail values for the dynamic variables when the unit is reset for device 2: Note: This parameter is persistent.
77
(HART 2)
Device 2 Fail Safe Enable
R/W
User
UINT8 1 0 - 1
0
3.10
Enables the use of fail safe or download values for the dynamic variables when the unit detects an error for device 2. Valid values are: 0 = live or last live 1 = failsafe values 2 = download value for PV, failsafe values for other dynamic variables. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-23
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
78
Device 2 PV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for primary variable reported by device 2.
79
Device 2 PV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of primary variable of device 2. Note: This parameter is persistent.
80
Device 2 PV Fail Safe on Reset Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Primary fail safe value for device 2. Note: This parameter is persistent.
81
Device 2 SV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for secondary variable reported by device 2.
82
Device 2 SV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of secondary variable of device 2. Note: This parameter is persistent.
83
Device 2 SV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Secondary fail safe value for device 2. Note: This parameter is persistent.
84
Device 2 TV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for tertiary variable reported by device 2.
85
Device 2 TV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of tertiary variable of device 2. Note: This parameter is persistent.
86
Device 2 TV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Tertiary fail safe value for device 2. Note: This parameter is persistent.
87
Device 2 FV Units
R/O
System
UINT8 1 0 - 255
0
1.00
Units code for fourth variable reported by device 2.
88
Device 2 FV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of fourth variable of device 2. Note: This parameter is persistent.
89
Device 2 FV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Fourth fail safe value of device 2. Note: This parameter is persistent.
90
Device 2 Slot 0 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 0 variable to request from device 2. Note: This parameter is persistent.
91
Device 2 Slot 0 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 0 variable requested from device 2.
92
Device 2 Slot 0 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 0 variable requested from device 2.
93
Device 2 Slot 1 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 1 variable to request from device 2. Note: This parameter is persistent.
94
Device 2 Slot 1 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 1 variable requested from device 2.
95
Device 2 Slot 1 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 1 variable requested from device 2.
96
Device 2 Slot 2 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 2 variable to request from device 2. Note: This parameter is persistent.
97
Device 2 Slot 2 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 2 variable requested from device 2.
ROC Plus Protocol Specifications Manual
3-24 Parameter Lists for Point Types Revised March-2021
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
98
Device 2 Slot 2 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 2 variable requested from device 2.
99
Device 2 Slot 3 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 3 variable to request from device 2. Note: This parameter is persistent.
100
Device 2 Slot 3 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 3 variable requested from device 2.
101
Device 2 Slot 3 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 3 variable requested from device 2.
102
Device 2 Message
R/W
Both
AC
40
0x20 - 0x5F for each
byte
" "
1.40
Device 2 message.
103
Device 2 Descriptor
R/W
Both
AC
20
0x20 - 0x5F for each
byte
" "
1.40
Device 2 descriptor.
104
Device 2 Manufacture's ID and Device ID
R/O
System
UINT16 2 0 - 65535
0
1.40
Device 2 manufacture's ID and device's ID
105
Device 2 Serial Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 2 serial number.
106
Device 2 ID Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 2 ID number.
107
Device 2 Sensor Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 2 sensor units.
108
Device 2 Upper Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 2 upper sensor limit.
109
Device 2 Lower Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 2 lower sensor limit.
110
Device 2 Minimum Span
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 2 minimum sensor span.
111
Device 2 Output Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 2 Output Units
112
Device 2 Upper Output Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 2 upper output limit.
113
Device 2 Lower Output Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 2 lower output limit.
114
Device 2 Damping Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 2 damping value.
115
(HART 1)
Device 3 Poll Mode
R/W
User
UINT8 1 0-255
0
1.40
Polling mode for device 3: Valid values are: 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables 4 = Full Update Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-25
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
115
(HART 2)
Device 3 Poll Mode
R/W
User
UINT8 1 Bit 7: 0-1
Bits 0-6: 0-3
0
3.10
Bit 7: Update State: 1=update, 0=no update
Bits 0-6 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables Note: This parameter is persistent.
116
Device 3 Polling Address
R/O
Both
UINT8 1 0-15
0
1.40
Polling address for device 3.
117
Device 3 Status
R/O
System
UINT8 1 0-1
0
1.40
0: No Device Found 1: Communicating 2: Comm Error
118
Device 3 Actual Scan Period
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Period at which device 3 is being updated.
119
Device 3 Tag
R/W
Both
AC
10
0x20 - 0x5F for each
byte
" "
1.40
Tag that resides in device 3. Note: This parameter is persistent.
120
Device 3 Response Code/Status
R/O
System
UINT16 2 0 - 65535
0
1.40
Response code and status received from device 3.
121
Device 3 Active Alarms
R/O
System
UINT8 1 0 - 255
0
1.40
Active alarms reported by device 3.
122
Device 3 Current (mA)
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Current in milliamps reported by device 3.
123
Device 3 Percent of Range
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Percent of range reported by device 3.
124
(HART 1)
Device 3 Fail Safe on Reset Enable
R/W
User
UINT8 1 0 - 1
0
1.40
Enable the use of fail safe values for the dynamic variables when the unit is reset for device 3. Note: This parameter is persistent.
124
(HART 2)
Device 3 Fail Safe Enable
R/W
User
UINT8 1 0 - 1
0
3.10
Enable the use of fail safe or download values for the dynamic variables when the unit detects an error for device 3. Valid values are: 0 = live or last live 1 = failsafe values 2 = download value for PV, failsafe values for other dynamic variables. Note: This parameter is persistent.
125
Device 3 PV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for primary variable reported by device 3.
126
Device 3 PV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of primary variable of device 3. Note: This parameter is persistent.
127
Device 3 PV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Primary fail safe value for device 3. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
3-26 Parameter Lists for Point Types Revised March-2021
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
128
Device 3 SV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for secondary variable reported by device 3.
129
Device 3 SV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of secondary variable of device 3. Note: This parameter is persistent.
130
Device 3 SV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Secondary fail safe value for device 3. Note: This parameter is persistent.
131
Device 3 TV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for tertiary variable reported by device 3.
132
Device 3 TV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of tertiary variable of device 3. Note: This parameter is persistent.
133
Device 3 TV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Tertiary fail safe value for device 3. Note: This parameter is persistent.
134
Device 3 FV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for fourth variable reported by device 3.
135
Device 3 FV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of fourth variable of device 3. Note: This parameter is persistent.
136
Device 3 FV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Fourth fail safe value of device 3. Note: This parameter is persistent.
137
Device 3 Slot 0 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 0 variable to request from device 3. Note: This parameter is persistent. .
138
Device 3 Slot 0 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 0 variable requested from device 3.
139
Device 3 Slot 0 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 0 variable requested from device 3.
140
Device 3 Slot 1 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 1 variable to request from device 3. Note: This parameter is persistent.
141
Device 3 Slot 1 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 1 variable requested from device 3.
142
Device 3 Slot 1 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 1 variable requested from device 3.
143
Device 3 Slot 2 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 2 variable to request from device 3. Note: This parameter is persistent.
144
Device 3 Slot 2 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 2 variable requested from device 3.
145
Device 3 Slot 2 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 2 variable requested from device 3.
146
Device 3 Slot 3 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 3 variable to request from device 3. Note: This parameter is persistent.
147
Device 3 Slot 3 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 3 variable requested from device 3.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-27
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
148
Device 3 Slot 3 Variable
R/O
System
FL
4
Any valid IEEE 754
float
0
1.40
Value of slot 3 variable requested from device 3.
149
Device 3 Message
R/W
Both
AC
40
0x20 - 0x5F for each
byte
" "
1.40
Device 3 message.
150
Device 3 Descriptor
R/W
Both
AC
20
0x20 - 0x5F for each
byte
" "
1.40
Device 3 descriptor.
151
Device 3 Manufacture's ID and Device ID
R/O
System
UINT16 2 0 - 65535
0
1.40
Device 3 manufacture's ID and device's ID
152
Device 3 Serial Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 3 serial number.
153
Device 3 ID Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 3 ID number.
154
Device 3 Sensor Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 3 sensor units.
155
Device 3 Upper Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 3 upper sensor limit.
156
Device 3 Lower Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 3 lower sensor limit.
157
Device 3 Minimum Span
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 3 minimum sensor span.
158
Device 3 Output Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 3 Output Units
159
Device 3 Upper Output Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 3 upper output limit.
160
Device 3 Lower Output Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 3 lower output limit.
161
Device 3 Damping Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 3 damping value.
162
(HART 1)
Device 4 Poll Mode
R/W
User
UINT8 1 0-255
0
1.40
Polling mode for device 4. Valid values are: 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables 4 = Full Update Note: This parameter is persistent.
162
(HART 2)
Device 4 Poll Mode
R/W
User
UINT8 1 Bit 7: 0-1
Bits 0-6: 0-3
0
3.10
Bit 7: Update State: 1=update, 0=no update
Bits 0-6 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
3-28 Parameter Lists for Point Types Revised March-2021
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
163
Device 4 Polling Address
R/O
Both
UINT8 1 0-15
0
1.40
Polling address for device 4.
164
Device 4 Status
R/O
System
UINT8 1 0-1
0
1.40
0: No Device Found 1: Communicating 2: Comm Error
165
Device 4 Actual Scan Period
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Period at which device 4 is being updated.
166
Device 4 Tag
R/W
Both
AC
10
0x20 - 0x5F for each
byte
" "
1.40
Tag that resides in device 4. Note: This parameter is persistent.
167
Device 4 Response Code/Status
R/O
System
UINT16 2 0 - 65535
0
1.00
Response code and status received from device 4.
168
Device 4 Active Alarms
R/O
System
UINT8 1 0 - 255
0
1.40
Active alarms reported by device 4.
169
Device 4 Current (mA)
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Current in milliamps reported by device 4.
170
Device 4 Percent of Range
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Percent of range reported by device 4.
171
(HART 1)
Device 4 Fail Safe on Reset Enable
R/W
User
UINT8 1 0 - 1
0
1.40
Enable the use of fail safe values for the dynamic variables when the unit is reset for device 4. Note: This parameter is persistent.
171
(HART 2)
Device 4 Fail Safe Enable
R/W
User
UINT8 1 0 - 1
0
3.10
Enable the use of fail safe or download values for the dynamic variables when the unit detects an error for device 4: Valid values are: 0 = live or last live 1 = failsafe values 2 = download value for PV, failsafe values for other dynamic variables. Note: This parameter is persistent.
172
Device 4 PV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for primary variable reported by device 4.
173
Device 4 PV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of primary variable of device 4. Note: This parameter is persistent.
174
Device 4 PV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Primary fail safe value for device 4. Note: This parameter is persistent.
175
Device 4 SV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for secondary variable reported by device 4.
176
Device 4 SV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of secondary variable of device 4. Note: This parameter is persistent.
177
Device 4 SV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Secondary fail safe value for device 4. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-29
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
178
Device 4 TV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for tertiary variable reported by device 4.
179
Device 4 TV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of tertiary variable of device 4. Note: This parameter is persistent.
180
Device 4 TV Fail Safe on Reset Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Tertiary fail safe value for device 4. Note: This parameter is persistent.
181
Device 4 FV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for fourth variable reported by device 4.
182
Device 4 FV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of fourth variable of device 4. Note: This parameter is persistent.
183
Device 4 FV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Fourth fail safe value of device 4. Note: This parameter is persistent.
184
Device 4 Slot 0 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 0 variable to request from device 4. Note: This parameter is persistent.
185
Device 4 Slot 0 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 0 variable requested from device 4.
186
Device 4 Slot 0 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 0 variable requested from device 4.
187
Device 4 Slot 1 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 1 variable to request from device 4. Note: This parameter is persistent.
188
Device 4 Slot 1 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 1 variable requested from device 4.
189
Device 4 Slot 1 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 1 variable requested from device 4.
190
Device 4 Slot 2 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 2 variable to request from device 4. Note: This parameter is persistent.
191
Device 4 Slot 2 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 2 variable requested from device 4.
192
Device 4 Slot 2 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 2 variable requested from device 4.
193
Device 4 Slot 3 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 3 variable to request from device 4. Note: This parameter is persistent.
194
Device 4 Slot 3 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 3 variable requested from device 4.
195
Device 4 Slot 3 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 3 variable requested from device 4.
196
Device 4 Message
R/W
Both
AC
40
0x20 - 0x5F for each
byte
"."
1.40
Device 4 message.
197
Device 4 Descriptor
R/W
Both
AC
20
0x20 - 0x5F for each
byte
".
1.40
Device 4 descriptor.
ROC Plus Protocol Specifications Manual
3-30 Parameter Lists for Point Types Revised March-2021
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
198
Device 4 Manufacture's ID and Device ID
R/O
System
UINT16 2 0 - 65535
0
1.40
Device 4 manufacture's ID and device's ID
199
Device 4 Serial Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 4 serial number.
200
Device 4 ID Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 4 ID number.
201
Device 4 Sensor Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 4 sensor units.
202
Device 4 Upper Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 4 upper sensor limit.
203
Device 4 Lower Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 4 lower sensor limit.
204
Device 4 Minimum Span
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 4 minimum sensor span.
205
Device 4 Output Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 4 Output Units
206
Device 4 Upper Output Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 4 upper output limit.
207
Device 4 Lower Output Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 4 lower output limit.
208
Device 4 Damping Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 4 damping value.
209
(HART 1)
Device 5 Poll Mode
R/W
User
UINT8 1 0-255
0
1.40
Polling mode for device 5. Valid values are: 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables 4 = Full Update Note: This parameter is persistent.
209
(HART 2)
Device 5 Poll Mode
R/W
User
UINT8
1
Bit 7: 0 – 1
Bits 0-6: 0-3
0
3.10
Bit 7: Update State: 1=update, 0=no update
Bits 0-6 0 = Skip This Device 1 = Primary Variable Only 2 = All Dynamic Variables 3 = All Slot Variables Note: This parameter is persistent.
210
Device 5 Polling Address
R/O
Both
UINT8 1 0-15
0
1.40
Polling address for device 5.
211
Device 5 Status
R/O
System
UINT8 1 0-1
0
1.40
Valid values are: 0 = No Device Found
1 = Communicating 2 = Comm Error
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-31
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
212
Device 5 Actual Scan Period
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Period at which device 5 is being updated.
213
Device 5 Tag
R/W
Both
AC
10
0x20 - 0x5F for each
byte
""
1.40
Tag that resides in device 5. Note: This parameter is persistent.
214
Device 5 Response Code/Status
R/O
System
UINT16 2 0 - 65535
0
1.40
Response code and status received from device 5.
215
Device 5 Active Alarms
R/O
System
UINT8 1 0 - 255
0
1.40
Active alarms reported by device 5.
216
Device 5 Current (mA)
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Current in milliamps reported by device 5.
217
Device 5 Percent of Range
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Percent of range reported by device 5.
218
(HART 1)
Device 5 Fail Safe on Reset Enable
R/W
User
UINT8 1 0 - 1
0
1.40
Enable the use of fail safe values for the dynamic variables when the unit is reset for device 5. Note: This parameter is persistent.
218
(HART 2)
Device 5 Fail Safe Enable
R/W
User
UINT8 1 0 - 1
0
3.10
Enable the use of fail safe or download values for the dynamic variables when the unit detects an error for device 5. Valid values are: 0 = live or last live 1 = failsafe values 2 = download value for PV, failsafe values for other dynamic variables. Note: This parameter is persistent.
219
Device 5 PV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for primary variable reported by device 5.
220
Device 5 PV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of primary variable of device 5. Note: This parameter is persistent.
221
Device 5 PV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Primary fail safe value for device 5. Note: This parameter is persistent.
222
Device 5 SV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for secondary variable reported by device 5.
223
Device 5 SV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of secondary variable of device 5. Note: This parameter is persistent.
224
Device 5 SV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Secondary fail safe value for device 5. Note: This parameter is persistent.
225
Device 5 TV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for tertiary variable reported by device 5.
226
Device 5 TV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of tertiary variable of device 5. Note: This parameter is persistent.
ROC Plus Protocol Specifications Manual
3-32 Parameter Lists for Point Types Revised March-2021
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
227
Device 5 TV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Tertiary fail safe value for device 5. Note: This parameter is persistent.
228
Device 5 FV Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units code for fourth variable reported by device 5.
229
Device 5 FV
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of fourth variable of device 5. Note: This parameter is persistent.
230
Device 5 FV Fail Safe Value
R/W
User
FLOAT
4
Any valid IEEE 754
float
0
1.40
Fourth fail safe value of device 5.
231
Device 5 Slot 0 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 0 variable to request from device 5. Note: This parameter is persistent.
232
Device 5 Slot 0 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 0 variable requested from device 5.
233
Device 5 Slot 0 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 0 variable requested from device 5.
234
Device 5 Slot 1 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 1 variable to request from device 5. Note: This parameter is persistent.
235
Device 5 Slot 1 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 1 variable requested from device 5.
236
Device 5 Slot 1 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 1 variable requested from device 5.
237
Device 5 Slot 2 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 2 variable to request from device 5. Note: This parameter is persistent.
238
Device 5 Slot 2 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 2 variable requested from device 5.
239
Device 5 Slot 2 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 2 variable requested from device 5.
240
Device 5 Slot 3 Assignment
R/W
User
UINT8 1 0 - 255
0
1.40
Slot 3 variable to request from device 5. Note: This parameter is persistent.
241
Device 5 Slot 3 Units
R/O
System
UINT8 1 0 - 255
0
1.40
Units of slot 3 variable requested from device 5.
242
Device 5 Slot 3 Variable
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Value of slot 3 variable requested from device 5.
243
Device 5 Message
R/W
Both
AC
40
0x20 - 0x5F for each
byte
" "
1.40
Device 5 message.
244
Device 5 Descriptor
R/W
Both
AC
20
0x20 - 0x5F for each
byte
" "
1.40
Device 5 descriptor.
245
Device 5 Manufacture's ID and Device ID
R/O
System
UINT16 2 0 - 65535
0
1.40
Device 5 manufacture's ID and device's ID
246
Device 5 Serial Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 5 serial number.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-33
Point Type 85, HART
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
247
Device 5 ID Number
R/O
System
UINT32
4
0 - 4,294,967,295
0
1.40
Device 5 ID number.
248
Device 5 Sensor Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 5 sensor units.
249
Device 5 Upper Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 5 upper sensor limit.
250
Device 5 Lower Sensor Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 5 lower sensor limit.
251
Device 5 Minimum Span
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 5 minimum sensor span.
252
Device 5 Output Units
R/O
System
UINT8 1 0 - 255
0
1.40
Device 5 Output Units
253
Device 5 Upper Output Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 5 upper output limit.
254
Device 5 Lower Output Limit
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 5 lower output limit.
255
Device 5 Damping Value
R/O
System
FLOAT
4
Any valid IEEE 754
float
0
1.40
Device 5 damping value.
ROC Plus Protocol Specifications Manual
3-34 Parameter Lists for Point Types Revised March-2021
3.4.4 Point Type 91: System Variables:
Description:
Point type 91 provides the System Variables parameters for the system configuration.
Number of Logical Points:
1 logic point for System Variables may exist.
Storage Location:
Point type 91 is saved to internal configuration memory.
Table 3-5: Point Type 91, System Variables
Point Type 91, System Variables
Param #
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
0
ROC Address
R/W
User
UINT8 1 0 255
1
1.00
One-byte unit code of the station address. You can configure the unit code for a ROC address.
Note: 0 is used for broadcast and should not be used by the ROC.
1
ROC Group
R/W
User
UINT8 1 0 255
2
1.00
Group code of the station address.
2
Station Name
R/W
User
AC
20
0x200x7E for each
byte
‘Remote
Oprtns
Cntrlr’
1.00
A 20-character ASCII field for the station name.
3
Part Number and Version
R/O
System
AC
20
0x20 0x7E for each
byte
‘W68xxx
Ver y.yy’
1.00
The software part number and version number string.
4
Time Created
R/O
System
AC
20
0x20 0x7E for each
byte
‘mmm dd,
yyyy
HH:MM’
1.00
The time and date stamp the firmware was created.
5
Manufacturer ID
R/O
System
AC
20
0x20 0x7E for each
byte
‘Emerson
Process
Mgmt’
1.00
The manufacturing identification string.
6
Product Description
R/O
System
AC
20
0x20 0x7E for each
byte
‘ROC809
1.00
The manufacturing description of product.
7
RESERVED
- - - - -
-
-
Reserved for future use
8
Maximum Events
R/O
System
UINT16 2 450
450
1.00
The maximum number of events that the Event Log may store.
9
Maximum Alarms
R/O
System
UINT16 2 450
450
1.00
The maximum number of alarms that the Alarm Log may store.
10
Maximum PIDs
R/O
System
UINT8 1 0 16
16
1.00
The maximum number of PID loops that may run on the system
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-35
Point Type 91, System Variables
Param #
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
11
Maximum Meter Runs
R/O
System
UINT8 1 2 –12
0
1.00
The maximum number of gas meter runs that may run on the system. Note: Maximum number depends on licensing.
12
Maximum FSTs
R/O
System
UINT8 1 6
6
1.00
The maximum number of FSTs that may run on the system
13
Event Index
R/O
System
UINT16
2
0 449
0
1.00
The current event index for the Event Log.
14
Alarm Index
R/O
System
UINT16
2
0 449
0
1.00
The current alarm index in the Alarm Log.
15
Active PIDs
R/W
System
UINT8 1 0 16
16
1.00
Number of active PIDs
16
Active Stations
R/W
User
UINT8
1
0 → Maximum # of
Meter Runs
1
1.00
Number of active stations
17
Active Orifice Meter Runs
R/W
User
UINT8
1
0 12
1
1.00
Number of active orifice meter runs
18
Active Turbine Meter Runs
R/W
User
UINT8
1
0 12
1
1.00
Number of active turbine meter runs
19
FST Clear
R/W
User
UINT8 1 0 → 1
0
1.00
Clears all FST code from Flash ROM. Valid values are 0 (Do nothing) and 1 (Clear FST code).
20
Clear configuration memory
R/W
User
UINT8 1 0 → 1
0
1.00
Clears the internal configuration memory stored in flash ROM. Valid values are 0 (Do nothing) and 1 (Enable clearing of Configuration Memory).
21
Write to Configuration Memory
R/W
User
UINT8 1 0 → 1
0
1.00
Commands the ROC to store certain point types (indicated throughout this document) to flash configuration memory. Valid values are 0 (Do nothing) and 1 (Perform Write to Configuration Memory).
22
Configuration Memory Write Complete
R/O
System
UINT8 1 0 → 1
1
1.00
Indicates if the system is in the process of writing the configuration to flash ROM. Valid values are 0 (Currently Performing the Write) and 1 (Completed the Write).
23
MPU Loading
R/O
System
FL 4 0.0 →100.0
0.0
1.00
The current percentage of time the CPU is being loaded, updated every 5 seconds.
24
RESERVED
- - - - -
-
-
Reserved for future use
25
I/O Scanning
R/W
User
UINT8 1 0 → 1
1
1.50
Turns the LCD on or off. Valid values are 0 (Off, screens cleared, no menus) and 1 (On, screens on, menus visable.) Note: Turning off does not shut off power.
26
Warm Start
R/W
User
UINT8 1 0 → 1
0
1.00
Used to re-start the system. A warm start is a reboot of the system without performing all the power-on-self tests. Valid values are 0 (Do nothing) and 1 (Perform Warm Start).
ROC Plus Protocol Specifications Manual
3-36 Parameter Lists for Point Types Revised March-2021
Point Type 91, System Variables
Param #
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
27
Cold start
R/W
User
UINT8 1 0 → 7
0
1.00
Used to re-start the system. A cold start always includes starting from the boot sector and performing power-on-self tests, plus the following options. Valid values are: 0 = Do nothing 1 = Restore Configuration from Flash 2 = Clear Alarms 3 = Clear Events 4 = Clear FSTs 5 = Clear History Data 6 = Restore Configuration from Flash, Clear Alarms/Events/FSTs/History Data 7 = Restore Configuration from Defaults
28
RESERVED
- - - - -
-
-
Reserved for future use
29
RESERVED
- - - - -
-
-
Reserved for future use
30
RESERVED
- - - - -
-
-
Reserved for future use
31
Baud Rate Generator #0 Rate
R/W
User
UINT32
4
300, 600, 1200, 2400,
4800, 9600, 19200,
38400, 57600, 115200
19200
3.10
The baud rate that baud rate generator #0 is to be set to.
32
Baud Rate Generator #1 Rate
R/W
User
UINT32
4
300, 600, 1200, 2400,
4800, 9600, 19200,
38400, 57600, 115200
9600
3.10
The baud rate that baud rate generator #1 is to be set to.
33
Baud Rate Generator #2 Rate
R/W
User
UINT32
4
300, 600, 1200, 2400,
4800, 9600, 19200,
38400, 57600, 115200
38400
3.10
The baud rate that baud rate generator #2 is to be set to.
34
Baud Rate Generator #3 Rate
R/W
User
UINT32
4
300, 600, 1200, 2400,
4800, 9600, 19200,
38400, 57600, 115200
57600
3.10
The baud rate that baud rate generator #3 is to be set to.
35
CRC Check
R/W
User
UINT8 1 0 → 1
1
1.00
Provides the CRC check flag. If this flag is enabled, a CRC is appended to all messages and a CRC is expected on all received messages. Valid values are 0 (Disabled) and 1 (Enabled). Note: Ethernet communications ignore the CRC since TCP/IP protocol already does error checking. The CRC must still be sent over Ethernet communications.
36
LED Enable
R/W
User
UINT8 1 0 60
5
1.00
Indicates the number of minutes the LEDs are on before automatically turning themselves off. (The LED button activea the LEDs for the configured time). Valid values are 0 (LEDs always on) and 1 - 60 (Specifying the number of minutes LEDs are on).
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-37
Point Type 91, System Variables
Param #
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
37
Boot Part Number and Version
R/O
System
AC
20
0x20 0x7E for each
byte
‘W68xxx
Ver y.yy’
1.00
Contains the boot software part number and version number string.
38
Boot Firmware Time Created
R/O
System
AC
20
0x20 0x7E for each
byte
1
1.00
Contains the time and date stamp the foot firmware was created.
39
Active Odorizer(s)
R/W
User
UINT8 1 0 12
0
1.00
Indicates the number of active odorizers. Note: Maximum number depends on licensing.
40
Clear History
R/W
User
UINT8 1 0 → 1
0
1.00
Clears history database and resets configuration back to factory defaults without power cycling the ROC. Valid values are 0 (Don't clear) and 1 (Clear).
41
Flash Disk Space Used
R/O
System
UINT32
4
0 → 0xFFFFFFFF
varies
1.20
The amount of disk space that has been consumed.
42
Flash Disk Space Free
R/O
System
UINT32
4
0 → 0xFFFFFFFF
varies
1.20
The amount of disk space that is available.
43
Number of System Initializations
R/W
Both
UINT16 2 0 → 65535
0
1.20
The number of system initializations. Note: This parameter is not reset to defaults due to a cold start; however, it is reset on a firmware upgrade.
44
Number of Warm Starts
R/W
Both
UINT16 2 0 → 65535
0
1.20
The number of warm starts. Note: This parameter is not reset to defaults due to a cold start; however, it is
reset on a firmware upgrade.
45
Number of Cold Starts
R/W
Both
UINT16 2 0 → 65535
0
1.20
The number of cold starts. Note: This parameter is not reset to defaults due to a cold start; however, it is reset on a firmware upgrade.
46
Number of Power Cycles
R/W
Both
UINT16 2 0 → 65535
0
1.20
The number of power cycles. Note This parameter is not reset to defaults due to a cold start; however, it is reset on a firmware upgrade.
47
Last Power-Down Time
R/O
System
TIME 4 N/A
0
1.30
Contains the last power-down time in the number of seconds elapsed since 12:00 a.m. Jan. 1, 1970.
48
Last Power-Up Time
R/O
System
TIME 4 N/A
0
1.30
Contains the last power-up time in the number of seconds elapsed since 12:00 a.m. Jan. 1, 1970.
49
RESERVED
- - - - -
-
-
Reserved for future use
ROC Plus Protocol Specifications Manual
3-38 Parameter Lists for Point Types Revised March-2021
Point Type 91, System Variables
Param #
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
50
(Series
1)
Logical Compatibility Mode
R/W
User
UINT8 1 0 → 1
0
2.00
Indicates the logical compatibility mode. Valid values are:
0 = 16 points per slot [Opcode 50 information and logical indexing for I/O is used in the same way as with version 1.XX of firmware].
1 = 8 points per slot [Opcode 50 information and logical indexing for I/O is based on 8 points per module and allows for up to 27 modules to be accessed.] See Opcode 50 for more information.
50
(Series
2)
Logical Compatibility Mode
R/W
User
UINT8 1 0 → 1
1
3.00
Indicates the logical compatibility mode. Valid values are:
0 = 16 points per slot [Opcode 50 information and logical indexing for I/O is used in the same way as with version 1.XX of firmware].
1 = 8 points per slot [Opcode 50 information and logical indexing for I/O is based on 8 points per module and allows for up to 27 modules to be accessed.] See Opcode 50 for more information.
51
ROC Series
R/O
System
AC20
20
0x20 0x7E for each
byte
Series 2
3.00
Indicates hardware revision.
52
Num Active Virtual DO
R/W
User
UINT8 1 0 24
0
3.02
Indicates the number of active virtual Discrete Outputs.
53
System Rollover for Double Precision Parameters
R/W
User
DBL
8
Any valid IEEE double precsion float 2,996
* 10
306
1,000,000
3.10
Indicates the value at which the double precision accumlators roll over.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-39
3.4.5 Point Type 92: Logon Parameters
Description:
Point type 92 provides the parameters for logging onto the ROC800L.
Number of Logical Points:
32 logical points for Logon Parameters may exist.
Storage Location:
Point type 92 is saved to internal configuration memory.
Table 3-6: Point Type 92, Logon Parameters
Point Type 92, Logon Parameters
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
0
Operator Identifier
R/W
User
AC
3
0x20 0x7E for each
byte.
1.00
A three character ASCII operator identifier (such as LOI).
1
Unused #1
R/O
User
UINT8 1 0
0
1.00 2
Unused #2
R/O
User
UINT8 1 0
0
1.00 3
Unused #3
R/O
User
UINT8 1 0
0
1.00
4
Password
R/W
User
UINT16
2
0000 9999
(see note)
1.00
A numerical value that is used as a password for the Operator Identifier (such as 1000). Modified in version 1.20 to Write­Only; reading the value now always returns
0. Note: The first point (logical 0) defaults to
the familiar operator ID (LOI) and password (1000). The remaining 15 points default to operator ID “ “ and password of 0000.
5
Access Level
R/W
User
UINT8 1 0 255
0
1.21
A value that is used to limit access to parameters when parameter (95, x, 44) is set to 2 (Security by User Access Level) where x = to the logical of the port that the request is being made on.
6
Group #1
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
7
Group #2
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
8
Group #3
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
ROC Plus Protocol Specifications Manual
3-40 Parameter Lists for Point Types Revised March-2021
Point Type 92, Logon Parameters
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
9
Group #4
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
10
Group #5
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
11
Group #6
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
12
Group #7
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
13
Group #8
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
14
Group #9
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
15
Group #10
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
16
Group #11
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
17
Group #12
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
18
Group #13
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
19
Group #14
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
20
Group #15
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
21
Group #16
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
22
Group #17
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-41
Point Type 92, Logon Parameters
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
23
Group #18
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
24
Group #19
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
25
Group #20
R/W
User
UINT8 1 019,255
255
1.50
States the first group the user is a member. The Group is then mapped to PT123 Logical 1, Parameters 019.
ROC Plus Protocol Specifications Manual
3-42 Parameter Lists for Point Types Revised March-2021
3.4.6 Point Type 95: Communication Ports
Description:
Point type 95 defines the communication ports for configuring a communication port. Only the following parameters are valid for logical 1 (Ethernet port):
ROC Plus Protocol Valid Receive Counter ROC Plus Protocol successful message time Transmit counter ROC Plus Protocol Security Status
All other parameters for logical 1 cannot be modified.
Number of Logical Points:
6 logical points for Communication Ports may exist.
Storage Location:
Point type 95 is saved to internal configuration memory.
Table 3-7: Point Type 95, Communication Ports
Point Type 95, Communication Ports
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
0
Tag Identification
R/W
User
AC
10
0x20 0x7E for each
byte
“Local
Port”, “Ethernet” “COMM2”
“COMM5”
1.00
The customizable name for this communications port.
1
Baud Rate Generator Used
R/W
User
UINT16 2 0 3
0
1.00
The baud rate generator used by this com port. Each port may use a different generator, however, only 4 generators exist. See Point
Type 91, System Variables, Parameters 31-
34. 2 Stop Bits
R/W
User
UINT8 1 1,2
1
1.00
The number of stop bits in a character.
3
Data Bits
R/W
User
UINT8 1 7, 8
8
1.00
The number of data bits in a character.
4
Parity
R/W
User
UINT8 1 0 →2
0
1.00
For parity error checking, the host adds a 1 or 0 bit to the character to make it even or odd. The receiver then decodes this. An error occurs if the sum of the bits is not correct. Valid values are: 0 = None 1 = Odd 2 = Even
ROC Plus Protocol Specifications Manual
Revised March-2021 Parameter Lists for Point Types 3-43
Point Type 95, Communication Ports
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
5
Comm Type
R/O
System
UINT8 1 0, 9→13, 15
LOI: 10 COMM1: 15 COMM2: 10 COMM3: 0 COMM4: 0 COMM5: 0
1.00
Indicates the communication module installed. The system updates this parameter wheneer a module is installed or removed. Valid values are : 0 = No Comm Module Installed 9 = MVS 10 = RS-232 11 = RS-485 12 = Modem 13 = HART 15 = Ethernet (Versions prior to 2.00) 19 = Ethernet (Versions 2.00 and later)
6
Store and forward port
R/W
User
UINT8 1 0 → 1
COMM1: 1 All others: 0
1.00
If this is enabled, all store and forward messages are sent out this port. If it is disabled, none are sent. Valid values are 0 (Do not store and forward for this port) and 1 (Store and forward for this port).
7
Key On Delay
R/W
User
FL
4
0.0→Any positive valid IEEE 754 float
LOI: 0.0
Others:
0.01
1.00
The period to wait after turning the RTS signal on before a message can be sent. This value is in seconds.
8
Key Off Delay
R/W
User
FL
4
0.0→Any positive valid IEEE 754 float
LOI: 0.0
Others:
0.01
1.00
The period, in seconds, to delay turning the RTS signal off after a message has been sent.
9
Modem Status
R/O
System
UINT8 1 0 255
0
1.00
This is the numeric response from the modem. A non-Hayes compatible modem does not provide this information.
0 = OK.
10
Modem Type
R/W
Both
UINT8 1 0 →2
0
1.00
Indicates the type of modem. The ROC detects and can changesthe internal modem. Valid values are:
0 = None 1 = External 2 = Internal Note: The user cannot write 2.
11
Connect Time
R/W
User
FL 4 0.0 → Max positive
IEEE 754 float
60.0
1.00
The amount of time in seconds the ROC800­Series waits after initiating a call to receive a connect message before terminating a call. Enter 0 to disable.
12
Configuration Command
R/W
User
AC
40
0x20 0x7E for each
byte
“AT&F0E0H
0V0X0&K3
S0=1S7=25
5S24=60”
1.00
The commands needed to initialize a modem.
13
Connect Command
R/W
User
AC
40
0x20 0x7E for each
byte
“ATDT
(number)”
1.00
The Hayes compatible modem command needed to dial out for SRBX communications.
ROC Plus Protocol Specifications Manual
3-44 Parameter Lists for Point Types Revised March-2021
Point Type 95, Communication Ports
Param#
Name
Access
System or
User Update
Data Type
Length
Range
Default
Ver
Description of functionality and meaning of values
14
Disconnect Time
R/W
User
FL
4
0.0→Any positive valid IEEE 754 float
60.0
1.00
Time in seconds that the ROC800-Series waits before disconnecting if there is no activity. Enter 0 to disable.
15
Inactivity Time
R/W
User
FL
4
0.0→Any positive valid IEEE 754 float
900.0
1.00
Time in seconds that the ROC800-Series waits, without receiving a signal, before it resets the modem. The inactivity timer looks at the valid receive counter to determine if the signal has been received. Enter 0 to disable.
16
Modem disconnect command
R/W
User
AC
40
0x20 0x7E for each
byte
“ATH0”
1.00
The user can use a different disconnect string for a modem.
17
SRBX Status
R/O
System
UINT8 1 0 → 1
0
1.00
Valid values are 0 (SRBX is currently inactive) and 1 (SRBX is currently active for this port).
18
Enable SRBX
R/W
User
UINT8 1 0 → 1
0
1.00
If this is enabled all SRBX messages will be sent out this port. If is disabled, none will be sent. Valid values are 0 (Disable SRBX for this port) and 1 (Enable SRBX for this port).
19
SRBX Alarm Index
R/O
System
UINT16
2
0 → [PT 91, parameter
10]
0
1.00
The index into the alarm table that corresponds to the alarm that caused an SRBX.
20
SRBX Time Base #1
R/W
User
FL
4
0.0→Any positive valid IEEE 754 float
20.0
1.00
Time in seconds that the ROC800-Series uses as the first SRBX delay.
21
SRBX Attempts #1
R/W
User
UINT8 1 0 255
1
1.00
The number of attempts for the first SRBX to use. Valid values are 0 (Disable) and 255 (Continuous).
22
SRBX Time Base #2
R/W
User
FL
4
0.0→Any positive valid IEEE 754 float
30.0
1.00
Time in seconds that the ROC800-Series uses as the second SRBX delay.
23
SRBX Attempts #2
R/W
User
UINT8 1 0 255
2
1.00
The number of attempts for the second SRBX to use. Valid values are 0 (Disable) and 255 (Continuous).
24
SRBX Time Base #3
R/W
User
FL
4
0.0→Any positive valid IEEE 754 float
45.0
1.00
Time in seconds that the ROC800-Series uses as the third SRBX delay.
25
SRBX Attempts #3
R/W
User
UINT8 1 0 255
3
1.00
The number of attempts for the third SRBX to use. Valid values are 0 (Disable) and 255 (Continuous).
26
SRBX Host Address
R/W
User
UINT8 1 0 255
1
1.00
Used to identify the SRBX host – Address portion.
27
SRBX Host Group
R/W
User
UINT8 1 0 → 255
0
1.00
Used to identify the SRBX host – Group portion.
28
Store & Forward Address #1
R/W
User
UINT8 1 0 255
0
1.00
Address of the first destination for the store and forward path. SRBX must be enabled for this to function.
Loading...