Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Type

Description

I1one-byte character
UI1unsigned one-byte value sent to the client as an I2
I2signed two-byte integer
UI2unsigned two-byte integer
I4signed four-byte integer
UI4unsigned four-byte integer
R4single precision IEEE floating point
BOOLBoolean (on/off) value
STRINGString
TLPA special type, String (T, L, P) denotes the ROC items that do not contain data, but instead contain the definition of another item. See TLP Data Type notes below. 

...

Example: Use USER_OPCODE.DATA_01<TFLP>{10:3}<TAC><C1><I2>

Linear Item Scaling

Linear scaling of items from a device is available using a linear transformation:


EU = GAIN * ItemValue +OFFSET


The optional gain/offset specification item format: Itemname{GAIN:OFFSET}


For example, to linear scale an item called Itemname with a gain of 10 and offset of 3 the item name would be Itemname{10:3}. This option can be combined with other options like the <Data Type>, <AC>, <PRIMARY> or <SECONDARY> and <I#> options. The <Data Type> option, the {GAIN:OFFSET} option and the <AC> option can be written in any order but must precede the <PRIMARY>, <SECONDARY> and <I#> options. All options are case insensitive.


Examples: Itemname<TFLP>{10:3}<AC><PRIMARY><I1>Itemname<ac>{10:3}<TFLP><i1><primary>

Alarm Code Quality Flag

I/O points have an alarm code that can be read by the (PointType.ALARM_CODE) parameter. This alarm code can also be read simultaneously with the value of the point using the optional item format: Itemname<AC>. When the <AC> option is used, the Alarm Code for that point will be returned in the quality flag of the item. If the Alarm Code is zero and communication is good, the quality of the item will be Good. If the Alarm Code is non-zero and communication is good, then the quality will be Uncertain. If the communication is not good, then the quality will be Not Connected or Communications Failure. This option can be combined with other options like the <Data Type>, {GAIN:OFFSET}, <PRIMARY> or <SECONDARY> and <I#> options. The <Data Type> option, the {GAIN:OFFSET} option and the <AC> option can be written in any order but must precede the <PRIMARY>, <SECONDARY> and <I#> options. All options are case insensitive.

Examples:

Itemname<TFLP>{10:3}<AC><PRIMARY><I1>
Itemname<ac>{10:3}<TFLP><i1><primary>

Primary and Secondary Connections

Each item name can be followed by the optional <Primary> or <Secondary> specification. When one of these is included in the item name, the data will be retrieved using the primary or secondary connection (as specified) instead of the current connection. This option can be combined with other options like the <I#>, <AC>, and {GAIN:OFFSET} options. The <Primary> or <Secondary> option and the <I#> option can be written in any order but must follow the <Data Type>, <AC> and {GAIN:OFFSET} options. All options are case insensitive.

Examples:

Itemname<TFLP>{10:3}<AC><PRIMARY><I1>
Itemname<ac>{10:3}<TFLP><i1><primary>

Assigning Items to a Polling Interval

Each item name can be followed by the optional <I#> specification where # specifies the polling interval from 1 to 15 for this item. When this is included in the item name, the data will be polled at the specified polling interval. The default polling interval is 1. This option can be combined with other options like the <Primary> or <Secondary>, <AC> and {GAIN:OFFSET} options. The <Primary> or <Secondary> option and the <I#> option can be written in any order but must follow the <Data Type>, <AC> and {GAIN:OFFSET} options. All options are case insensitive.

Examples:

Itemname<TFLP>{10:3}<AC><PRIMARY><I1>
Itemname<ac>{10:3}<TFLP><i1><primary>