BSAP OPC Items
Standard Items
Protocol Items
Analog Signal Names
| Item | Data Type | Description |
|---|---|---|
| BASE.. BASE.EXT. BASE..ATT BASE.EXT.ATT | R4 | These items are templates. Fill in the fields with those of the actual ACCOL BSAP item that you want to poll. Analog signal names can have four forms. Base name, Base name and Extension, Base name and Attribute or Base name, Extension and Attribute. The Base name, Extension, and Attribute are separated by periods. If fewer than two periods are found in a signal name, the protocol module will reject it and log an error message. Note Only signals that are defined in the device (ACCOL load) can be polled or written to. This naming convention is only used when the RTU Type is set to Network 3000 (as opposed to ControlWave). |
Logical Signal Names
| Item | Data Type | Description |
|---|---|---|
| BASE..&L BASE.EXT.&L BASE..ATT&L BASE.EXT.ATT&L | BOOL | These items are templates. Fill in the fields with those of the actual ACCOL BSAP item that you want to poll. Logical signal names can have four forms. Base name, Base name and Extension, Base name and Attribute or Base name, Extension and Attribute. The Base name, Extension, and Attribute are separated by periods. If less than two periods is found in a signal name, the protocol module will reject it and log an error message. The &L tells the BSAP protocol module that the value that will be sent or received will be a logical 0 or logical 1. If the - is left off, the value received by the client will be an R4 value. When the item name does not match the items actual data type, the values are converted from the one type to the other. See the section titled Item Conversion. Note Only signals that are defined in the device (ACCOL load) can be polled or written to. This naming convention is only used when the RTU Type is set to Network 3000 (as opposed to ControlWave). |
String Signal Names
| Item | Data Type | Description |
|---|---|---|
| BASE..&S BASE.EXT.&S BASE..ATT&S BASE.EXT.ATT&S | STRING | These items are templates. Fill in the fields with those of the actual ACCOL BSAP item that you want to poll. String signal names can have four forms: Base name, Base name and Extension, Base name and Attribute or Base name, Extension and Attribute. The Base name, Extension, and Attribute are separated by a periods. If less than two periods is found in a signal name, the protocol module will reject it and log an error message. The &S tells the BSAP protocol module that the value that will be sent or received will be a string. If the &S is left off, the value received by the client will be an R4 value. When the item name does not match the items actual data type, the values are converted from the one type to the other. See the section titled Item Conversion. Note Only signals that are defined in the device (ACCOL load) can be polled or written to. This naming convention is only used when the RTU Type is set to Network 3000 (as opposed to ControlWave). |
Signal Name Type & Inhibits Items
| Item | Data Type | Description |
|---|---|---|
| BASE..&T{0-7, y, Y} BASE.EXT.&T{0-7, y, Y} BASE..ATT&T{0-7, y, Y} BASE.EXT.ATT&T{0-7, y, Y} | BOOL I2 | These items are templates. Fill in the fields with those of the actual ACCOL BSAP item that you want to poll. Signal name type & inhibits items are set to values determined by the bits of the Type & Inhibits byte when the signal name is polled. &T is an integer containing the value of the whole byte (0 - 256). &T# (where # is a digit from 0 - 7) is a boolean set to true if the value of the bit is 1 and false if the value of the bit is 0. &Ty or &TY is an integer containing the value of bits 0 and 1, which indicates the signal's type (0 = logical, 2 = analog, 3 = string). The Type & Inhibits byte encodes the following information: |
Analog Array Names
| Item | Data Type | Description |
|---|---|---|
| #A- An.x.y | R4 | Analog arrays can be polled or written to using this item name where n is the array number (1-255); x is the row number (1-65535); and y is the column number (1-65535). Note Only arrays that are defined in the device (ACCOL load) can be polled or written to. |
Analog Array Row Names
| Item | Data Type | Description |
|---|---|---|
| #A-An.x | Array of R4s | Entire analog array rows can be polled or written to using this item name where n is the array number (1-255); x is the row number (1-65535). The entire row is sent to and from the client as one item. Note Only arrays that are defined in the device (ACCOL load) can be polled or written to. |
Logical Array Names
| Item | Data Type | Description |
|---|---|---|
| #L-An.x.y | BOOL | Logical arrays can be polled or written to using this item name where n is the array number (1-255); x is the row number (1-65535); and y is the column number (1-65535). Note Only arrays that are defined in the device (ACCOL load) can be polled or written to. |
Logical Array Row Names
| Item | Data Type | Description |
|---|---|---|
| #L-An.x | Array of BOOLs | Entire logical array rows can be polled or written to using this item name where n is the array number (1-255); x is the row number (1-65535). The entire row is sent to and from the client as one item. Note Only arrays that are defined in the device (ACCOL load) can be polled or written to. |
List Names
| Item | Data Type | Description |
|---|---|---|
| #Listn.x #Listn.x&L #Listn.x&S #Listn.x&T | R4 BOOL STRING I2 or BOOL | Lists can be polled or written to using this item name where n is the list number (1-255); x is the item number in the list (1-65535). The first item in a list is item 1; the second item is 2, and so on. The &L tells the BSAP protocol module that the value that will be sent or received will be a logical 0 or logical 1. The &S tells the BSAP protocol module that the value that will be sent or received will be a string. If the &L or &S is left off, the value received by the client will be an R4 value. When the item name does not match the items actual data type, the values are converted from the one type to the other. See the section titled Item Conversion. The &T indicates a Type & Inhibits item; see the section Signal Name Type & Inhibits Items for a full explanation of these. Note Only lists that are defined in the device (ACCOL load) can be polled or written to. |
ControlWave Signal Names
| Item | Data Type | Description |
|---|---|---|
| CTRLWAVE_ITEM CTRLWAVE_ITEM&L CTRLWAVE_ITEM&S CTRLWAVE_ITEM&T | R4 BOOL STRING I2 or BOOL | These items are templates. Fill in the name with that of the actual ControlWave BSAP item that you want to poll. Signals that follow ControlWave naming conventions may be polled using these items. The &L tells the BSAP protocol module that the value that will be sent or received will be a logical 0 or logical 1. The &S tells the BSAP protocol module that the value that will be sent or received will be a string. If the &L or &S is left off, the value received by the client will be an R4 value. When the item name does not match the item's actual data type, the values are converted from the one type to the other. See the section titled Item Conversion. The &T indicates a Type & Inhibits item; see the section Signal Name Type & Inhibits Items for a full explanation of these. Note Only signals that are defined in the ControlWave device can be polled or written to. ControlWave signal names are only valid when the RTU Type is set to ControlWave (as opposed to Network3000). |
Extended Items
The BSAP protocol implementation supports the following item names for use by client applications:
| Item | Data Type | Description |
|---|---|---|
| #ACCOL_VERSION | I4 | Poll the ACCOL load version number |
| #LOG_EFM_ITEMS | I4 | Writes status information to the logger for all EFM items. |
| #LOG_ITEM_LIST | I4 | Writes status information to the logger for all items that have been advised to the device. |
| #LOG_READ_QUEUE | I4 | Writes status information to the logger for all poll messages in the device read queue. |
| #LOG_WRITE_QUEUE | I4 | Writes status information to the logger for all poll messages in the device write queue. |
| #READ_BY_NAME | BOOL | Forces all items currently being read by address to be read by name (one time). |
| #REQUEST_NRT | BOOL | Forces a TS/NRT message to be sent at the start of the next poll cycle. |
| #TEST_VERSION | I4 | Sets the stored MSD version number to a different value. This will force the MSD version to be reread from the device. |
| #TIME_HOUR #TIME_MIN #TIME_SEC #TIME_DAY #TIME_MON #TIME_YEAR #TIME_JULIAN_DAY #TIME_JULIAN_4SEC #TIME_JULIAN_20MSEC | R4 | Poll the system date and time using the RDB extension read date/time message. Note that: a) These items are read-only and cannot be used to set the time. b) Not all BSAP RTUs support this RDB extension message type. |
| LastArchive1Record/n | DATE | Timestamp of the latest User1 Upload record collected from Meter n. |
| LastArchive2Record/n | DATE | Timestamp of the latest User2 Upload record collected from Meter n. |
| LastArchive3Record/n | DATE | Timestamp of the latest User3 Upload record collected from Meter n. |
| LastArchive4Record/n | DATE | Timestamp of the latest User4 Upload record collected from Meter n. |
| LastArchive5Record/n | DATE | Timestamp of the latest User5 Upload record collected from Meter n. |
| LastArchive6Record/n | DATE | Timestamp of the latest User6 Upload record collected from Meter n. |
| LastArchive7Record/n | DATE | Timestamp of the latest User7 Upload record collected from Meter n. |
| LastArchive8Record/n | DATE | Timestamp of the latest User8 Upload record collected from Meter n. |
| LastArchive9Record/n | DATE | Timestamp of the latest User9 Upload record collected from Meter n. |
| LastArchive10Record/n | DATE | Timestamp of the latest User10 Upload record collected from Meter n. |
| LastArchive11Record/n | DATE | Timestamp of the latest User11 Upload record collected from Meter n. |
| LastArchive12Record/n | DATE | Timestamp of the latest User12 Upload record collected from Meter n. |
| LastArchive13Record/n | DATE | Timestamp of the latest User13 Upload record collected from Meter n. |
| LastArchive14Record/n | DATE | Timestamp of the latest User14 Upload record collected from Meter n. |
| LastArchive15Record/n | DATE | Timestamp of the latest User15 Upload record collected from Meter n. |
| LastArchive16Record/n | DATE | Timestamp of the latest User16 Upload record collected from Meter n. |
| LastAuditRecord | DATE | Timestamp of the latest Audit Upload record collected from the device. |
| LastDailyRecord/n | DATE | Timestamp of the latest Daily Upload record collected from Meter n. |
| LastHourlyRecord/n | DATE | Timestamp of the latest Hourly Upload record collected from Meter n. |
| LastMinuteRecord/n | DATE | Timestamp of the latest Minute Upload record collected from Meter n. |
| LastRtuConfigRead/n | DATE | Timestamp of the most recent read of the Meter Configuration for Meter n. |
| LastTimeSync | DATE | Timestamp of the last time synch. |
| LastTimeSyncResult | I4 | Result code for the last time synch: 0 for no error or alarm. Error and alarm result code values are set in the TimeSync object. |
| MoveArchive1/n | I2 | Move User1 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive2/n | I2 | Move User2 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive3/n | I2 | Move User3 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive4/n | I2 | Move User4 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive5/n | I2 | Move User5 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive6/n | I2 | Move User6 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive7/n | I2 | Move User7 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive8/n | I2 | Move User8 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive9/n | I2 | Move User9 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive10/n | I2 | Move User10 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive11/n | I2 | Move User11 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive12/n | I2 | Move User12 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive13/n | I2 | Move User13 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive14/n | I2 | Move User14 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive15/n | I2 | Move User15 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveArchive16/n | I2 | Move User16 Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveAudit | I2 | Move Audit Upload position pointer: positive value moves backward. |
| MoveDaily/n | I2 | Move Daily Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveHourly/n | I2 | Move Hourly Upload position pointer for Meter n: positive value moves backward, negative forward. |
| MoveMinute/n | I2 | Move Minute Upload position pointer for Meter n: positive value moves backward, negative forward. |
| ResetArchive1/n | BOOL | Reset User1 Upload position pointer for Meter n. |
| ResetArchive2/n | BOOL | Reset User2 Upload position pointer for Meter n. |
| ResetArchive3/n | BOOL | Reset User3 Upload position pointer for Meter n. |
| ResetArchive4/n | BOOL | Reset User4 Upload position pointer for Meter n. |
| ResetArchive5/n | BOOL | Reset User5 Upload position pointer for Meter n. |
| ResetArchive6/n | BOOL | Reset User6 Upload position pointer for Meter n. |
| ResetArchive7/n | BOOL | Reset User7 Upload position pointer for Meter n. |
| ResetArchive8/n | BOOL | Reset User8 Upload position pointer for Meter n. |
| ResetArchive9/n | BOOL | Reset User9 Upload position pointer for Meter n. |
| ResetArchive10/n | BOOL | Reset User10 Upload position pointer for Meter n. |
| ResetArchive11/n | BOOL | Reset User11 Upload position pointer for Meter n. |
| ResetArchive12/n | BOOL | Reset User12 Upload position pointer for Meter n. |
| ResetArchive13/n | BOOL | Reset User13 Upload position pointer for Meter n. |
| ResetArchive14/n | BOOL | Reset User14 Upload position pointer for Meter n. |
| ResetArchive15/n | BOOL | Reset User15 Upload position pointer for Meter n. |
| ResetArchive16/n | BOOL | Reset User16 Upload position pointer for Meter n. |
| ResetAudit | BOOL | Reset Audit Upload position pointer. |
| ResetDaily/n | BOOL | Reset Daily Upload position pointer for Meter n. |
| ResetHourly/n | BOOL | Reset Hourly Upload position pointer for Meter n. |
| ResetMinute/n | BOOL | Reset Minute Upload position pointer for Meter n. |
| RetrieveHistory | BOOL | Retrieve History |
| TimeSync | I2 | Triggers a Time Sync to occur. |
Item Conversions
The BSAP protocol module supports item conversion from logical to analog and from analog to logical, from logical to string and from string to logical, or from analog to string and string to analog. The default signal type is analog (R4).
To tell the protocol module that a signal is a logical value (bool), append an &L to the end of the signal name. To tell the protocol module that a signal is a string value (BSTR), append an &S to the end of the signal name.
If the &L is left off from a logical signal name, the value received from the device will be converted from a logical 0 to an R4 value of 0.0, or a logical 1 will be converted to an analog value of 1.0 before sending to the client. If the &S is left off from a string signal name, the ASCII string ( -999.9, - 9.999e-011 ) received from the device will be converted to an analog value before sending to the client. The analog value received from the client will be converted to its ASCII string equivalent ( -999.9, -9.999e-011) before sending to the device.
The &S is not normally appended to a logical signal name, but if an &S is appended to a logical signal name, the value received from the device will be converted from a logical
1 to an ASCII string value of On, or an ASCII string value of On (case insensitive) to a logical value of 1 before sending to the client. Also, a logical 0 will be converted to an ASCII string value of Off, or an ASCII string value of Off (case insensitive) will be converted to a logical value of 0 before sending to the client.
The &L and &S are not normally appended to an analog signal name, but if either is, the same conversion described above will occur. It is not necessary to append the &L to a logical array name. It is not valid to append the &S to a logical array name. It is not valid to append the &L or &S to an analog array name. All conversions that apply to signal values also apply to the same type of signal in a list.
For assistance, please submit a ticket via our Support Portal, email autosol.support@autosoln.com or call 281.286.6017 to speak to a support team member.