Items available for the Object topic

The following table lists the items available for the object topic in alphabetical order.

Item Value Parameter
Alarm Returns the collection of values from the requests "Alarm state", "Alarm value", "Alarm start s", "Alarm start ms", "Alarm ack s", "Alarm ack ms", "Alarm end s", "Alarm end ms", "Alarm prio" in the named order for the first alarm found in the alarm list for the specified object. If no alarm is found, the transaction fails. In the CF_TEXT format data are a text string containing all the value delimited by commas. In the XlTable format, a 9-entry Microsoft Excel array is returned. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm ack Alarm number: acknowledges the first alarm in the alarm list that belongs to the object and have the specified alarm number. Only available for POKE operations. None
Alarm ack ms Millisecond extension to "Alarm ack s". The value must be divided by 1000 and added to "Alarm ack s" to give the time in millisecond resolution. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm ack s The acknowledge time for the first alarm found in the alarm list on the specified object. If no alarm is found for the specified object the transaction fails. If the alarm is not yet acknowledged, zero is returned. The time is returned as the number of days since December 30, 1899. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm clear Alarm number: ends the first alarm in the alarm list that belongs to the object and have the specified alarm number. Only available for POKE operations. None
Alarm end ms Millisecond extension to "Alarm end s". The value must be divided by 1000 and added to "Alarm end s" to give the time in millisecond resolution. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm end s The end time for the first alarm found in the alarm list on the specified object. If no alarm is found for the specified object, the transaction fails. If the alarm is not yet ended, zero is returned. The time is returned as the number of days since December 30, 1899. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm list Like "Alarm" but all alarms for the object are returned. In the CF_TEXT format, the individual lines in the alarm list are delimited by semicolons. In the XlTable format, results are returned in a two-dimensional Microsoft Excel array. In case there are more than 640 alarms on an object, the XlTable result will only include the 640 first entries in the list. You could then use Topic=$Sys_info Item="Alarm list" as a way to get the complete list. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm number The alarm number of the first alarm found in the alarm list for the specified object. If no alarm is found on the object the transaction fails. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm prio The priority for the first alarm in the alarm list on the specified object. If no alarm is found for the object the transaction fails. The value returned is a number between 1 and 255 (where 255 is the highest priority). Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm set Alarm number: starts an alarm on the object. The alarm will get the number specified as parameter. Only available for POKE operations. None
Alarm start ms Millisecond extension to "Alarm start s". The value must be divided by 1000 and added to "Alarm start s" to give the time in millisecond resolution. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm start s The start time for the first alarm found in the alarm list on the specified object. If no alarm is found for the specified object, the transaction fails. The time is returned as the number of days since December 30, 1899. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm state The state of the first alarm in the alarm list found on the object. If no alarm is found, the transaction fails. The possible return values are: 1: System acknowledged 2: Operator acknowledged 3: Not yet acknowledged. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
Alarm value The value for the object in alarm. The value is returned as an integer that will have to have the decimal pointed placed according to the number of decimals for the object. Only available for REQUEST operations. Alarm number: This will make it possible to request the state on a specific alarm on the object. If no alarm is matching, the transaction fails.
All atoms Value, time and quality (OPC) of all atoms. On table objects, a "valid" flag will indicate whether each table item is used or not. Only available for REQUEST operations. None
Any atom name The current value of the atom. If the atom has not got a value yet or is not enabled for the specified object, the transaction is rejected. Time stamping: When updating atoms, the update can be time stamped, so it is possible to change values back in time. This will work the same way as the event protocol for data coming from the PLC and will be under the same restrictions. That is the update must come contiguous in time and the accepted time interval is restricted by the Delta and Direct settings in System Configuration. When using the CF_TEXT format (plain text string), type the following: <value>,<time>,<quality> Note: Use period (.) as decimal separator. You can specify either the first element, the two first elements or all three. Click here for examples. the time must be given as a decimal number where the whole number is the number of days since 1900 and the decimals express the time of the day. For example, 33365.125 where the three decimals mean 3:00. When using the XlTable format (Excel cells), the value, time stamp and quality are specified in three separate cells which are sent together as one array. The cell closest to the top left of the sheet will be taken as the value, the next one as the time stamp and the third one as quality. You can specify the value only, value and time stamp or all three elements. In both cases the time stamp is given as number of days since December 30, 1899. IOMODE: returns the I/O mode of the atom instead of the value. Possible values are: 0 : Local 1: In 2: Out 3: In/Out This parameter can only be used when reading atom values.
Base class Base class for the object as a number from 1 to 5, where 1 means no reduction. Only available for REQUEST operations. NONE
Change time The time of the latest change of any atom on the object. The time is returned as number of days since December 30, 1899. Only available for REQUEST operations. NONE
Decimals Number of decimals on object values. For float tables, -1 is returned. Only available for REQUEST operations. NONE
Description The textual description for the object. Only available for REQUEST operations. NONE
High range Highest acceptable value for an object. Only available for REQUEST operations. NONE
Low range Lowest acceptable value for an object Only available for REQUEST operations. NONE
Red ivl Reduction interval for the object, according to the base class. Zero is returned if no reduction is specified. Value is in seconds. Only available for REQUEST operations. NONE
Scan class Scan class for the object as a number from 1 to 5, where 1 means no scan. Only available for REQUEST operations. NONE
Scan ivl Scan interval in milliseconds. If 0 is returned, no scan is selected. Only available for REQUEST operations. NONE
Table len Number of entries in table object. This attribute is only applicable to table objects. For other objects, 0 is returned. Only available for REQUEST operations. NONE
Type Object type. Possible values are: 256: Digital 512: Analog 1024: Counter 2048: Table 4096: String Only available for REQUEST operations. NONE
Unit Measurement unit for object. This attribute is only applicable to some object types. For all other object types an empty string is returned. Only available for REQUEST operations. NONE