Protocol manual for SmartRadar Version: 1.0 January 2001 Part no.: 4416.634

Enraf B.V. P.O. Box 812 2600 AV Delft Netherlands Tel.: 015-2698600 Fax: 015-2619574 E-mail: [email protected] http://www.enraf.com

Protocol manual for SmartRadar

Page 1

Copyright 2001 Enraf B.V. All rights reserved. Reproduction in any form without the prior consent of Enraf B.V. is not allowed. This manual is for information only. The contents, descriptions and specifications are subject to change without notice. Enraf B.V. accepts no responsibility for any errors that may appear in this manual. The warranty terms and conditions applicable in the country of purchase in respect to Enraf B.V. products are available from your supplier. Please retain them with your proof of purchase.

Page 2

Preface

Preface This manual has been written for the technicians involved in the communication with the Enraf series 873 SmartRadar or 973 SmartRadar LT gauges via the 858 CIU, via the 880 CIU Prime, via the optional ® RS-232C / RS-485 communication channel or via the HART channel (973 SmartRadar LT only). For commissioning and installation of the SmartRadar please refer to the applicable Instruction manual and Installation guides. This manual describes the communication by means of records via the 858 CIU, via the ® 880 CIU Prime, via the optional RS-232C / RS-485 communication channel or via the HART channel. For an overview, refer to the list of related documents in Appendix B. Communication via the 858 CIU The Instruction manual series 858 CIU gives detailed information about the communication structure. For communication with the SmartRadar, refer to chapter 3 and further of this manual. Communication via the 880 CIU Prime HostPort 2 of the 880 CIU Prime can be configured to work in CIU 858 emulation mode. SmartRadars, directly connected to the 880 CIU Prime, can be reached via the records described in this manual. As CIU address must be specified the last decade of the decimal representation of the RTU address for HostPort 2. SmartRadars, connected via an 858 CIU to the 880 CIU Prime, can be reached via the records described in this manual. As CIU address must then be specified the 858 CIU address. Please note that the 858 CIU address and the last decade of the decimal representation of the RTU address for HostPort 2 must be different. For more information, refer to the Instruction manual CIU Prime type 880 (CIU858 emulation). Communication via the optional RS-232C / RS-485 channel When the RS-232C or RS-485 communication is used, 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 SmartRadar, if the CIU address is deleted or not (refer to the Instruction manual XPU-2 option RS-232C / RS-485 for 873 SmartRadar, or to the Instruction manual 973 SmartRadar LT RS-232/485 output communication). When item BC is set to “ - ”, then there is no CIU address emulation and the byte “ N ” in all described records in this manual must be deleted. 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 the copyright property of Enraf B.V., Netherlands. Enraf B.V. disclaims any responsibility for damage to equipment caused by: • •

Deviation from any of the prescribed procedures; Execution of activities that are not prescribed.

Additional information Please do not hesitate to contact Enraf or its representative if you require any additional information.

Protocol manual for SmartRadar

Page 3

Table of contents

Table of contents Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2

Transmission protocol and BCC calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1 Transmission protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.2 Example of BCC calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3

Type of records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.1 Request record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.2 Data request messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.3 Operational messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.4 Identification message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3.5 Item messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

4

Answer records and data description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1 Answer records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.1 A-record (alarm status [contact status] record) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.2 B-record (alarm status, [contact status] and level record) . . . . . . . . . . . . . . . . . . . . . . . . . 4.1.3 C-record (alarm status, [contact status] and temperature record) . . . . . . . . . . . . . . . . . . . 4.1.4 D-record (alarm status, [contact status], level and temperature record) . . . . . . . . . . . . . . 4.1.5 E-record (stored alarm status, [contact status] and level record) . . . . . . . . . . . . . . . . . . . 4.1.6 F-record (stored alarm status, [contact status], level and temperature record) . . . . . . . . . 4.1.7 L-record (alarm status, [contact status] and signed level record) . . . . . . . . . . . . . . . . . . . 4.1.8 M-record (water alarm status, [contact status], water level status and water level record) 4.1.9 X-record (identification record ) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2 Data in answer records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.1 as - alarm status (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.2 cs - contact status (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.3 dn - device number (3 bytes) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.4 dt - device type (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.5 llllll - level value (6 bytes) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.6 lllllll - level value (7 bytes) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.7 ls - level status (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.8 lsgn - level sign (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.9 p - space (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.10 s - temperature sign (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.11 sv - software version (2 bytes) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.12 ts - temperature status (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.13 ttttt - temperature value (5 bytes) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.14 was - water alarm status (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.15 ws - water level status (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4.2.16 wsgn - water level sign (1 byte) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5

The Z-record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 5.1 Z-record description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 5.2 data field description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Appendix A Appendix B

Page 4

8 8 8 9 9 9

10 10 10 10 11 11 12 12 12 13 13 14 14 14 14 15 15 15 16 16 16 17 17 17 18 18 19 19

ASCII table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Related documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Introduction

1

Introduction

The following type of records can be transmitted to the 873 SmartRadar and 973 SmartRadar LT: • • • •

Data request messages Operational messages Identification message Item messages

Data request messages will ask for alarm status, level status and level value, optional temperature status and temperature value, and optional water alarm status and water level value. An operational message will perform an action, as store (freeze) the measured data or switch over to the water level record. With the identification message is asked for the device number (873 or 973) and the XPU software version. The observed density and vapour pressure are requested by means of item messages. Standard, the SmartRadar measures level. Temperature, water bottom, observed density and vapour pressure can be measured with optional sensors and with the appropriate optional board. The table below lists the possible options with the optional board in the 873 SmartRadar. The 973 SmartRadar LT has only one optional input board ICU_HPI for al these functions, except for the pressure transmitters with Honeywell DE protocol; that is not supported anymore. Optional measurement

Sensor

Optional board in 873 SmartRadar

Product temperature

Spot RTD

TPU-2 / HSU

or HCU

Average MRT or MTT

MPU / HPU / OPU

or HCU*)

Vapour temperature

Average MRT or MTT

MPU / HPU / OPU

or HCU*)

Observed density and/or Vapour pressure

Pressure transmitter(s) (HART protocol)

HPU / HSU

or HCU

Pressure transmitter(s) (Honeywell DE protocol)

OPU

Water interface probe (HART protocol)

HPU / HSU

Water bottom

**) or HCU

*) The HCU board and Model 762 (supplied from mid 2001) do not support MRT measurement. **) On the HCU board (supplied from mid 2001) the Honeywell DE protocol is not supported anymore. To get the appropriate information, we advise to use the following records: • • • • • •

B or L - record C - record M - record Z - record (with item AG) Z - record (with item QQ) Z - record (with item P3)

for level request for temperature request for water level request for average gas temperature request for observed density request for vapour pressure request

Protocol manual for SmartRadar

Page 5

Transmission protocol and BCC calculation

2

Transmission protocol and BCC calculation

2.1 Transmission protocol 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. The envelope consists of: • • •

An STX (start of transmission) character in front of the data field An ETX (end of transmission) character behind the field A BCC (block check character) behind the ETX. The BCC is calculated by taking the binary sum without carrying over the seven individual data bits (exclusive or) of all transmitted bytes, according to ANSI standard X3.28 - 1976. STX is excluded; ETX is included.

The data field consists of: • • • •

Addresses for CIU (depends on setting of item BC) and SmartRadar 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 record)

The general form of a record is as follows: STX

Address(es)

TOI

TOR

(Data)

ETX

BCC

2.2 Example of BCC calculation The BCC is calculated by taking the binary sum without carrying over of the seven individual data bits (exclusive or) of all transmitted bytes. STX is excluded; ETX is included. The BCC is also called the “horizontal 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: STX

Page 6

0

2

1

B

B

ETX

BCC

Transmission protocol and BCC calculation Spelled out in bits: Char.

Parity

b6

b5

b4

b3

b2

b1

b0

Remarks

STX

0

0

0

0

0

0

1

0

0 2 1 B B ETX

1 0 0 1 1 1

0 0 0 1 1 0

1 1 1 0 0 0

1 1 1 0 0 0

0 0 0 0 0 0

0 0 0 0 0 0

0 1 0 1 1 1

0 0 1 0 0 1

start of transmission (excluded from the BCC calculation) (emulated) CIU address = 0 gauge address (tenths) = 2 gauge address (units) = 1 TOI = B (compatible with 811) TOR = B (level record) end of transmission

BCC

1

0

1

1

0

0

0

0

(BCC calculated over 7 bits) block check character

Note:

With the RS-232C and RS-485 communication seven data bits are used and the parity is odd. ® With HART communication, used by ICU_HPO board in the 973 SmartRadar LT, there are 8 data bits, odd parity, and a preamble (8 times logical ‘1’) in front of the message.

Protocol manual for SmartRadar

Page 7

Type of records

3

Type of records

3.1 Request record The request record is constructed as follows: STX Pos 1 : Pos 2 : Pos 3,4 Pos 5 : Pos 6 : Pos 7 : Pos 8 :

N

nn

TOI

TOR

ETX

BCC

STX start of transmission N CIU address : nn gauge address (item TA from SmartRadar) TOI type of instrument TOR type of record (see following sections) ETX end of transmission BCC block check character

The TOI (type of instrument) must correspond with item GT (gauge type) from the SmartRadar and can be set to: • • •

B C E

records compatible to 811 servo gauge records compatible to 813 MGT records compatible to 811 servo gauge with external alarm inputs

An extra byte (contact status) is incorporated in the data request response for the gauge types C and E.

Note to programmers:

Enraf suggests only to implement the B-type of instruments. This type supports all features and functions. The C- and E- types are only shown to indicate the compatibility with older gauges.

3.2 Data request messages Upon the receipt of a data request message, the SmartRadar will respond with the requested data. There are eight types of data requests (TOR: type of record), which can be requested: TOR

Description

A

Send level alarm status

B

Send level alarm status and level

C

Send level alarm status and temperature

D

Send level alarm status, level and temperature

E

Send stored level alarm status and level

F

Send stored level alarm status, level and temperature

L

Send level alarm status and signed level (0.1 mm resolution)

M

Send water alarm status and water level (0.1 mm resolution)

Note:

Temperature in the records C, D and F, is always product temperature. Vapour temperature can only be requested by means of an item message.

Page 8

Type of records 3.3 Operational messages Note:

Although the SmartRadar supports the Q- and W- operational messages (compatible to 811 Servo gauge and 854 servo gauges), it is advised to use the M-record for the water level.

After the receipt of an operational message, the SmartRadar will always respond with an A answer record (level alarm status), and of course, perform the required operation. The available operational messages are: TOR

Description

Q

Quit water level and return to product level

S

Store level alarm, level and temperature

U

Unlock (quit water level)

W

Switch over to water level in B, D and L - record

The stored level and temperature values can be requested by the E- and F-records.

3.4 Identification message After receipt of the identification message, the SmartRadar will respond with the identification data (device number 873 or 973 and XPU software version). TOR X

Description Send identification record

3.5 Item messages With this type of record it is possible to send item messages to the SmartRadar to set or request items. TOR

Description

Z--

Send or request items to or from the SmartRadar

The “ - - ” represents the two characters of the item which is transmitted in this record. The Z-record is described in detail in chapter 5.

Protocol manual for SmartRadar

Page 9

Answer records and data description

4

Answer records and data description

4.1 Answer records 4.1.1 A-record (alarm status [contact status] record) STX

N

Pos 1 : Pos 2 : Pos 3,4 Pos 5 :

nn

TOI

A

as

[cs]

ETX

BCC

STX start of transmission N CIU address : nn gauge address (TA from SmartRadar) TOI type of instrument (GT from SmartRadar), which can be: • B compatible with 811 servo gauge • C compatible with 813 MGT • E compatible with 811 servo gauge with external alarm inputs A type of record is A as alarm status [cs] contact status (only with TOI is C or E) ETX end of transmission : BCC block check character

Pos 6 : Pos 7 : Pos 8 : Pos 9 : Pos 10

4.1.2 B-record (alarm status, [contact status] and level record) STX Pos 1 : Pos 2 : Pos 3,4 Pos 5 :

N

nn

TOI

B

as

[cs]

ls

llllll

ETX

BCC

STX start of transmission N CIU address : nn gauge address (TA from SmartRadar) TOI type of instrument (GT from SmartRadar), which can be: • B compatible with 811 servo gauge • C compatible with 813 MGT • E compatible with 811 servo gauge with external alarm inputs Pos 6 : B type of record is B Pos 7 : as alarm status Pos 8 : [cs] contact status (only with TOI is C or E) Pos 9 : ls level status Pos 10÷15 : llllll level value (6 bytes) Pos 16 : ETX end of transmission Pos 17 : BCC block check character

Page 10

Answer records and data description 4.1.3 C-record (alarm status, [contact status] and temperature record) STX

N

nn

TOI

C

as

[cs]

ts

s

ttttt

ETX

BCC

Pos 1 : Pos 2 : Pos 3,4 Pos 5 :

STX start of transmission N CIU address : nn gauge address (TA from SmartRadar) TOI type of instrument (GT from SmartRadar), which can be: • B compatible with 811 servo gauge • C compatible with 813 MGT • E compatible with 811 servo gauge with external alarm inputs Pos 6 : C type of record is C Pos 7 : as alarm status Pos 8 : [cs] contact status (only with TOI is C or E) Pos 9 : ts temperature status Pos 10 : s temperature sign Pos 11÷15 : ttttt temperature value (5 bytes) Pos 16 : ETX end of transmission Pos 17 : BCC block check character

4.1.4 D-record (alarm status, [contact status], level and temperature record) STX

N

nn

TOI

D

as

[cs]

ls

llllll

ts

s

ttttt

ETX

BCC

Pos 1 : Pos 2 : Pos 3,4 Pos 5 :

STX start of transmission N CIU address : nn gauge address (TA from SmartRadar) TOI type of instrument (GT from SmartRadar), which can be: • B compatible with 811 servo gauge • C compatible with 813 MGT • E compatible with 811 servo gauge with external alarm inputs Pos 6 : D type of record is D Pos 7 : as alarm status Pos 8 : [cs] contact status (only with TOI is C or E) Pos 9 : ls level status Pos 10÷15 : llllll level value (6 bytes) Pos 16 : ts temperature status Pos 17 : s temperature sign Pos 18÷22 : ttttt temperature value (5 bytes) Pos 23 : ETX end of transmission Pos 24 : BCC block check character

Note:

It is generally advised not to use this record. In case remote indicators (model 877 FDI or 878 CPI) are connected to the SmartRadar, 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.

Protocol manual for SmartRadar

Page 11

Answer records and data description 4.1.5 E-record (stored alarm status, [contact status] and level record) 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.

4.1.6 F-record (stored alarm status, [contact status], level and temperature record) 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.

4.1.7 L-record (alarm status, [contact status] and signed level record) STX Pos 1 : Pos 2 : Pos 3,4 Pos 5 :

N

nn

TOI

L

as

[cs]

ls

lsgn

lllllll

STX start of transmission N CIU address : nn gauge address (TA from SmartRadar) TOI type of instrument (GT from SmartRadar), which can be: • B compatible with 811 servo gauge • C compatible with 813 MGT • E compatible with 811 servo gauge with external alarm inputs Pos 6 : L type of record is L Pos 7 : as alarm status Pos 8 : [cs] contact status (only with TOI is C or E) Pos 9 : ls level status Pos 10 : lsgn level sign Pos 11÷17 : lllllll level value (7 bytes) Pos 18 : ETX end of transmission Pos 19 : BCC block check character

Page 12

ETX

BCC

Answer records and data description 4.1.8 M-record (water alarm status, [contact status], water level status and water level record) STX

N

nn

TOI

M

was

[cs]

ws

wsgn

lllllll

ETX

BCC

Pos 1 : Pos 2 : Pos 3,4 Pos 5 :

STX start of transmission N CIU address : nn gauge address (TA from SmartRadar) TOI type of instrument (GT from SmartRadar), which can be: • B compatible with 811 servo gauge • C compatible with 813 MGT • E compatible with 811 servo gauge with external alarm inputs Pos 6 : M type of record is M Pos 7 : was water alarm status Pos 8 : [cs] contact status (only with TOI is C or E) Pos 9 : ws water level status Pos 10 : wsgn water level sign Pos 11÷17 : lllllll water level value (7 bytes) Pos 18 : ETX end of transmission Pos 19 : BCC block check character Water level, measured by a water interface probe (i.e. WaterScout or WAT probe), is always available in the M-record. Therefore, it is not necessary to issue the operational message W (water command) and read the water level in the B - record.

4.1.9 X-record (identification record ) STX Pos 1 : Pos 2 : Pos 3,4 Pos 5 :

Pos 6 : Pos 7÷9 Pos 10 Pos 11 Pos 12,13 Pos 14 Pos 15

N

nn

TOI

X

dn

p

dt

sv

ETX

BCC

STX start of transmission N CIU address : nn gauge address (TA from SmartRadar) TOI type of instrument (GT from SmartRadar), which can be: • B compatible with 811 servo gauge • C compatible with 813 MGT • E compatible with 811 servo gauge with external alarm inputs X type of record is X : dn device number (873 or 973) : p space : dt device type : sv software version : ETX end of transmission : BCC block check character

Protocol manual for SmartRadar

Page 13

Answer records and data description 4.2 Data in answer records 4.2.1 as - alarm status (1 byte) For the SmartRadar with type of instrument (TOI) = B is the alarm status one of the following ASCII characters (in decreasing priority): F

-

C *)

-

B *)

-

H L -

-

invalid alarm data • no previous store command (only in E and F-records) • level fail • initial status 4th character of item LU • out of measuring range 3rd character of item LU • measurement blocked high level alarm low level alarm no alarm

*) The characters given here are the default settings in item LU (level status conversion); it may be set to different characters. With the type of instrument (TOI) = C or E, the alarm status is one ASCII byte, bit coded: bit 0 bit 1 bit 2

-

bit 3 bit 4 bit 5 bit 6 bit 7

-

high level alarm low level alarm illegal alarm status • no previous store command (only in E and F-records) • level fail • initial status 0 measurement blocked out of measuring range 1 0

When the bit is set to ‘ 1 ’, the corresponding condition is true.

4.2.2 cs - contact status (1 byte) This byte is only in the answer records when the type of instrument (TOI) = C or E and is one ASCII byte, bit coded. The contact status byte is set with a default value, because the SmartRadar is not provided with external alarm inputs. The default value is ‘ @ ’ and can be ignored. The meaning is: -

contact no. 1 is closed contact no. 2 is closed legal contact status contact status is valid

4.2.3 dn - device number (3 bytes) The device number consists of three ASCII digits and is: “ 873 ” or “ 973 ”.

Page 14

Answer records and data description 4.2.4 dt - device type (1 byte) The device type consists of one ASCII character and is for the 873 SmartRadar with XPU-2 board: “ F ” and for the 973 SmartRadar LT with ICU board: “ K ”.

4.2.5 llllll - level value (6 bytes) 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 (item LD)

Displayed level

level value in 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

s *

-

sign: + or decimal separator: either . or ,

If there is no level data available, or if the level data is invalid, then the llllll - field is filled with “ FFFFFF ”. Negative levels are not supported in the 811 and 813 protocols. In case of negative levels, the llllll - field is filled with “ 999999 ”. In water measuring mode (after issuing the operational message W), the llllll - field contains the water level. The water measuring mode is left after issuing the operational message Q or U, or after a time-out of 15 minutes.

4.2.6 lllllll - level value (7 bytes) 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:

s *

Level dimension (item LD)

Displayed level

level value in 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

-

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 to “ 0 “. If there is no level data available, or if the level data is invalid, then the lllllll - field is filled with “ FFFFFFF ”.

Protocol manual for SmartRadar

Page 15

Answer records and data description 4.2.7 ls - level status (1 byte) The level status can contain one of the following ASCII character (in decreasing priority): F

-

C *)

-

B *)

-

M *)

-

? *)

-

-

-

invalid level data • no previous store command (only in E and F-records) • level fail • initial status 4th character of item LU • out of measuring range 3rd character of item LU • measurement blocked 2nd character of item LU • warning • general APU/ICU fail 1st character of item LU • reduced accuracy valid level data

*) The characters given here are the default settings in item LU (level status conversion); it may be set to different characters. In water measuring mode (after issuing the operational message W), the level status contains the water level status. The water measuring mode is left after issuing the operational message Q or U, or after a time-out of 15 minutes. The water level status is (in decreasing priority): F

-

C

-

W

-

invalid water level data • general probe fail water level out of range • water below probe warning water found • valid water level • water above probe warning

4.2.8 lsgn - level sign (1 byte) The level sign contains in decreasing priority one of the following ASCII characters: F

-

+

-

invalid level data • level fail • initial status negative level positive level

4.2.9 p - space (1 byte) Is used as separation character in the X-record; the value is 20H.

Page 16

Answer records and data description 4.2.10

s - temperature sign (1 byte)

For the optional spot temperature measurement, the temperature sign contains in decreasing priority one of the following ASCII characters: F

-

+

-

invalid temperature data • optional board absent • general TPU-2/HSU or ICU_HPI fail • temperature out of range negative temperature positive temperature

For the optional average temperature measurement, the temperature sign contains in decreasing priority one of the following ASCII characters: F

-

+

4.2.11

invalid temperature data • optional board absent • multiple temperature general fail • fail in average product temperature reading - negative temperature - positive temperature

sv - software version (2 bytes)

These two ASCII digits represents the software version of the installed XPU software For instance: 10 - XPU s/w version 1.0

4.2.12

ts - temperature status (1 byte)

For the optional spot temperature measurement, the temperature status contains in decreasing priority one of the following ASCII characters: F

-

T *)

-

-

-

invalid temperature data • optional board absent • general TPU-2/HSU or ICU_HPI fail • no previous store command (only in F-record) • temperature out of range character of item TU (temperature status conversion) • level time-out • current level below RTD position • invalid level reading valid temperature

*) The character “ T ” is the default value of item TU; it may be set to a different character.

Protocol manual for SmartRadar

Page 17

Answer records and data description For the optional average temperature measurement, the temperature sign contains in decreasing priority one of the following ASCII characters: F

-

T *)

-

-

-

invalid temperature data • optional board absent • no previous store command (only in F-record) • multiple temperature general fail • fail in average product temperature reading character of item TU (temperature status conversion) • out of specified temperature range • exceeding differential temperature range (MTT only) • device not calibrated (MTT only) • last valid level used • manual level used • level below lowest temperature element • alternative temperature element selected (MRT only) valid temperature

*) The character “ T ” is the default value of item TU; it may be set to a different character.

4.2.13

ttttt - temperature value (5 bytes)

The temperature data (five ASCII characters) is represented in 0.01 °C or 0.01 °F, depending on item TD (temperature dimension). The ttttt - field is filled with FFFFF if one of the following conditions is true: -

4.2.14

optional board absent temperature out of range multiple temperature general fail fail in average temperature reading

was - water alarm status (1 byte)

For the SmartRadar with type of instrument (TOI) = B, the water alarm status is one of the following ASCII characters (in decreasing priority): F

-

A Z H L -

-

Page 18

invalid water alarm data • general probe fail water above probe warning water below probe warning high water level alarm low water level alarm no water level alarm

Answer records and data description With the type of instrument (TOI) = C or E, the water alarm status is one ASCII byte, bit coded: bit 0 - high water level alarm bit 1 - low water level alarm bit 2 - invalid water alarm data • general probe fail bit 3 - water above probe warning bit 4 - water below probe warning bit 5 - 0 bit 6 - 1 bit 7 - 0 When the bit is set to ‘ 1 ’, the corresponding condition is true.

4.2.15

ws - water level status (1 byte)

The water level status contains in decreasing priority one of the following ASCII characters: F

-

A Z -

-

4.2.16

invalid water alarm data • general probe fail water above probe warning water below probe warning water found (valid water level)

wsgn - water level sign (1 byte)

The water level sign contains in decreasing priority one of the following ASCII characters: F

-

+

-

invalid water data • HPU/HSU or ICU_HPI board absent • water probe absent • general probe fail negative water level positive water level

Protocol manual for SmartRadar

Page 19

The Z-record

5

The Z-record

5.1 Z-record description The Z-record allows accesses to nearly all items within the SmartRadar. This record has been introduced to be able to use the SmartRadar to its full extend. For instance, to request for measured data which are not ® incorporated in the standard records as described in chapter 4.1, or with the HART communication of the 973 SmartRadar LT. Of course, other items can be requested, or settings and commands can be given. The Z-record has the following structure: STX Pos 1 : Pos 2 : Pos 3,4 Pos 5 :

Pos 6 : Pos 7 ÷ n Pos n + 1 Pos n + 2

N

nn

TOI

Z

data field

ETX

BCC

STX start of transmission N CIU address : nn gauge address (TA from SmartRadar) TOI type of instrument (GT from SmartRadar), which can be: • B compatible with 811 servo gauge • C compatible with 813 MGT • E compatible with 811 servo gauge with external alarm inputs Z type of record is Z : data field item request, command or setting : ETX end of transmission : BCC block check character

As will be described in the next section, the data field has different lengths depending on the item.

5.2 data field description The data field always commences with an item, identified by its two character abbreviation. This item can be either a command, a request or a setting (refer to the item description of the SmartRadar and its option boards). Command item In the request record for a command item, the data field contains the two character item. In the answer record from a command item, the item is repeated in the data field and the character ‘ & ’ is added to indicate, the command is accepted. Item with setting In the request record for an item with a setting, the data field contains the two character item followed by the “ = ” sign and the required setting. This also includes indexed items. In the answer record from an item with a setting, the item and setting string is repeated in the data field with the character ‘ & ’ at the end to indicate that the setting is accepted. (Data) request item In the request record for a request item, the data field contains the two character item. This also includes indexed items. In the answer record from a request item, the item is repeated in the data field, followed by the requested data.

Page 20

The Z-record If an error is detected in by the SmartRadar, the (wrong) item is repeated in the data field of the answer record, followed by an exclamation mark “ ! ”, and an error code. Although the SmartRadar uses only upper case characters, internally lower case characters are converted to upper case characters when the data field is decoded. The following table summarizes the request and answer Z-records: Z request record

Z answer record

STX N nn TOI TOR data field ETX BCC

STX N nn TOI TOR data field

ETX BCC

STX 0 03

B

Z

rs

ETX BCC

STX 0 03

B

Z

RS&

ETX BCC

STX 0 03

B

Z

DF=A

ETX BCC

STX 0 03

B

Z

DF=A&

ETX BCC

STX 0 03

B

Z

HA

ETX BCC

STX 0 03

B

Z

HA+012.3456 ETX BCC

STX 0 03

B

Z

HB

ETX BCC

STX 0 03

B

Z

HB!051

ETX BCC

In the table, N is assumed to be “ 0 ” and nn is taken as “ 03 ”. The “ ! ” means error; command not accepted. Error code “ 051 ”: unknown item (refer to XPU error code; item EP). Items from which the data cannot be requested by the standard records, are: • AG average gas temperature • P3 vapour pressure • QQ observed HIMS density For the construction of these data items, refer to the appropriate option manuals (see Appendix B).

Protocol manual for SmartRadar

Page 21

Appendix

Appendix A ASCII table

Page 22

Appendix

Appendix B Related documents Title

Part No.

Instruction manual 858 Communications Interface Unit Instruction manual CIU Prime type 880 (CIU858 emulation)

4416.500 4416.529

Instruction manual XPU-2 option RS-232C / RS-485 ® Instruction manual 973 SmartRadar LT HART output communication Instruction manual 973 SmartRadar LT RS-232/485 output communication

4416.237 4416.646 4416.647

Instruction manual 873 SmartRadar Installation guide 873 SmartRadar Control Unit & Antenna Unit Instruction manual 973 SmartRadar LT Installation guide 973 SmartRadar LT

4416.571 4416.569 4416.731 4416.632 4416.641

Instruction manual TPU-2 and HSU option board Instruction manual 862 MIR Instruction manual 862 MIT Instruction manual Water bottom measurement by capacitive probe Instruction manual HIMS

4416.253 4416.230 4416.231 4416.595 4416.241

Instruction manual Temperature, Water bottom and Analog output options Instruction manual HIMS / HTG and vapour pressure (P3) measurement

4416.644 4416.645

Instruction manual 877 FDI Field Display & Interface Instruction manual 878 panel indicator

4416.257 4416.263

Item documentation Enraf series 854, 873, 877 & 973 gauges

4416.277

Protocol manual for SmartRadar

Page 23

Notes

Page 24