ATG854 Protocol Manual
ATG854 Protocol Manual
ATG854 Protocol Manual
May 2009
Part no.: 4416.505
Revision 1
Enraf B.V.
P.O. Box 812
2600 AV Delft
Netherlands
Table of contents
Preface ........................................................................................................................................................3
1 Introduction ..................................................................................................................................................4
3 Type of records............................................................................................................................................7
3.1 Request record ..................................................................................................................................7
3.2 Data request messages .....................................................................................................................7
3.3 Operational messages .......................................................................................................................8
3.4 Identification message .......................................................................................................................8
3.5 Item messages to and from 854 level gauge .....................................................................................8
6 Related documents....................................................................................................................................18
Preface
This manual has been written for the technicians involved in the communication with the Enraf series 854
level gauges via the 858 Communications Interface Unit (CIU) or via the optional RS-232C / RS-485
communication channel on the XPU-2 board.
For commissioning and installation, of the 854 level gauges please refer to the related Instruction manuals
and Installation guides. This manual describes the communication by means of records via the 858 CIU or
via the optional RS-232C / RS-485 communication channel.
For an overview, refer to the list of related documents in chapter 6.
The instruction manual series 858 CIU gives detailed information about the communication structure. For
communication with the 854 level gauges, refer to chapter 3 and further of this manual.
Communication via the optional RS-232C / RS-485 channel of the XPU-2 board
When RS-232C or RS-485 communication is required, the 854 gauge must be equipped with an XPU-2
board. With this type of communication it is possible to delete the CIU address byte in the records. It
depends on the setting of item BC (address byte CIU emulation) in the 854 gauge, if the CIU address is
deleted or not (refer to the Instruction manual XPU-2 option RS-232C / RS-485).
When item BC is set to “ - ”, then there is no CIU address emulation and byte “ N ” in all described records in
this manual must be ignored.
In chapter 2 an overview is given on the communication protocol, inclusive an example for BCC (Block
Check Character) calculation.
Legal aspects
The information in this manual is copyright property of Enraf B.V., The Netherlands. Enraf B.V. accepts no
responsibility for any errors that may appear in this manual.
Additional information
Please do not hesitate to contact Enraf or its representative if you require additional information.
1 Introduction
The following type of records can be transmitted to the 854 level gauge:
Data request messages will ask for alarm status, level status, level value and other optional measured
values, such as temperature, density , etc.
An operational message will perform an action, such as test gauge or store (freeze) the measured data.
With the identification message is asked for the device number (854 or 894) and the XPU software version.
The observed density and vapour pressure are requested by means of item messages.
Standard, the 854 level gauge measures level and water interface (dip mode). Temperature, observed
density (servo density or HIMS density) vapour pressure and continuously water level can be measured with
optional sensors and with the appropriate optional board.
The table below lists the possible options with the optional board.
A communication protocol is used, based on a request-reply schedule. The protocol consists of request
message records and answer records.
A record consists of a data field packed in an envelope. The envelope allows the receiver to detect the
incoming record and to verify its proper reception.
Addresses for CIU (depends on setting of item BC) and level gauge
• TOI (type of instrument) character
• TOR (type of record) character
• Data bytes (always in case of an answer record; optional in other cases, depends on type of
records)
The BCC is calculated by taking the binary sum without carrying over the seven individual data bits
(exclusive or) of all transmitted bytes. STX is excluded; ETX is included. The BCC is also called the “horizon-
tal parity check”.
Below follows an example for the BCC calculation with the level request record (B-record) for gauge address
21 connected at (emulated) CIU address 0.
Note:
With the RS-232C and RS-485 communication seven data bits are used and the parity is odd.
3 Type of records
3.1 Request record
The TOI (type of instrument) must correspond with item GT (gauge type) from the 854 level gauge. In this
manual only gauge type B (compatible to 811 servo gauge) is discussed as other possible settings for item
GT are not relevant for communication with the 854 level gauge.
Upon the receipt of a data request message, the 854 level gauge will respond with the requested data.
There are eight types of data request messages (TOR: type of record), which can be requested:
TOR Description
Note:
The temperature data in records C, D and F, is always product temperature. Vapour temperature can
only be requested by means of an item message.
After receipt of an operational command message the 854 will always respond with an A answer record
(send alarm status).
TOR Description
After receipt of a data request message the 854 will respond with the identification data.
TOR Description
With this type of record (TOR) it is possible to send item messages to the 854 level gauge, or request or set
the item status in the 854 level gauge.
TOR Description
The “ - - ” represents the two characters of the item which is transmitted in this record.
The Z-record is described in detail in chapter 5.
Note:
It is generally not advised to use this record.
In case remote indicators (model 877 FDI or 878 CPI) are connected to the 854 level gauge, separate
level and temperature records (B- and C-records or L- and C-records) on a regular time base are
required for the level and temperature reading on the indicator. Refer to the instruction manual of the
indicator.
Same as the B-record, except for the data, as this is the data from the time the store command (operational
message S) was given.
Same as the D-record, except for the data, as this is the data from the time the store command (operational
message S) was given.
Only available in XPU software version A4.0 or higher or with XPU-2 board.
4.1.8 M-record (water alarm status, water level status and water level record)
This is the water level from a water interface probe and can only be measured when an XPU-2 board is
installed.
Water level, measured by a water interface probe (i.e. WaterScout), is always available in the M-record.
Therefore, it is not necessary to issue the operational message W (water command) before reading the
M-record.
This 6 byte ASCII characters level value is transmitted in the B, D, E and F - records.
The relation between the displayed level and the level value, transmitted via the B, C, E and F records, is as
follows:
Level dimension Displayed level level value in
(item LD) llllll - field
M (metres) s l1 l2 l3 * l4 l5 l6 l7 l1 l2 l3 l4 l5 l6
F (feet) s l1 l2 l3 l4 * l5 l6 l7 l2 l3 l4 l5 l6 l7
I (inches) s l1 l2 l3 l4 l5 * l6 l7 l2 l3 l4 l5 l6 l7
P (fractions) s l1 l2 ‘ l3 l4 “ l5 l6 l1 l2 l3 l4 l5 l6
If there is no level data available, or if the level data is invalid, then the llllll - field is filled with “ FFFFFF ”.
In case of negative levels, which are not supported in the 811 protocol, the llllll - field is filled with “ 999999 ”.
This 7 byte ASCII characters level value is transmitted in the L and M - records.
The relation between the displayed level and the level value, transmitted via the L and M records, is as
follows:
Level dimension Displayed level level value in
(item LD) lllllll - field
M (metres) s l1 l2 l3 * l4 l5 l6 l7 l1 l2 l3 l4 l5 l6 l7
F (feet) s l1 l2 l3 l4 * l5 l6 l7 l1 l2 l3 l4 l5 l6 l7
I (inches) s l1 l2 l3 l4 l5 * l6 l7 l1 l2 l3 l4 l5 l6 l7
P (fractions) s l1 l2 ‘ l3 l4 “ l5 l6 0 l1 l2 l3 l4 l5 l6
s - sign: + or - * - decimal separator; either . or ,
When the level dimension is set to P (fractions), the most significant digit in the level value field is fixed at “0”.
If there is no level data available, or if the level data is invalid, then the lllllll - field is filled with “ FFFFFF ”.
The level sign contains in decreasing priority one of the following ASCII characters:
These two (or three) ASCII characters represent the software version installed on the XPU board.
The XPU board has three characters in the software version field; the XPU-2 has two characters in the
software version field.
For example: 4.1 XPU software version 4.1
10 XPU-2 software version 1.0
*) Item TU contains an ASCII character. The temperature status will hold this character in a reduced
accuracy situation. Default value is 'T'; it may be set to another character.
Temperature data (five ASCII characters) is represented in 0.01 °C or 0.01 °F, depending on item TD
(temperature dimension).
If there is no temperature data available, or the temperature data is invalid, the transmitted temperature field
contains “ FFFFF ”.
The water alarm status is generated by a water interface probe connected to the 854 level gauge, which is
equipped with an XPU-2 board.
The water alarm status byte can be (in decreasing priority):
The water level status is generated by a water interface probe connected to the 854 level gauge, which is
equipped with an XPU-2 board.
The water level status byte can be (in decreasing priority):
The water level sign is generated by a water interface probe connected to the 854 level gauge, which is
equipped with an XPU-2 board.
The water level sign byte can be (in decreasing priority):
5 The Z-record
The Z-record allows access to nearly all ITEMS used within the devices belonging to the 854 series level
gauges. To be able to use these devices to their full extend this record has been introduced. The ITEMS
shown in appendix A are available for use in the Z-protocol and are considered to be frozen. This implies that
the shape and contents of these ITEMS will not be changed without notification to registered users.
CIU address
The CIU address consists of one ASCII digit (0-9).
Type of instrument
The type of instrument identifies the type of device. Different types of devices may share the same
transmission address.
Type of record
If the Z-record is used the type of record is always Z.
Data field
The data field commences always with an ITEM, identified with its two characters abbreviation. This ITEM
can either be a command, request or a setting.
In case of a setting the ITEM will be followed by data. The assign character (=) will be used as a separator
between the ITEM and the setting (data).
ITEM
│
├──── command: ii
│
├──── request: ii
│
└──── setting: ii=data
Although the instruments use only upper case characters internally lower case characters are automatically
converted to upper case characters when the data field is decoded.
Communication examples:
STX N nn TOI TOR Data field ETX BCC STX N nn TOI TOR Data field ETX BCC
6 Related documents