Dissolved Oxygen (DO) Transmitter SMARTPro HART Command Specification

Transcription

1 Dissolved Oxygen (DO) Transmitter SMARTPro 8968 HART Command Specification Using the HART 7.0 Communications Protocol Initial Release: 17 August 2009 Part Number: FM HRN 003, Rev 1.0 HART is a registered trademark of the HART Communication Foundation of Austin, Texas, USA. DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 1

2 CONTENTS 1. INTRODUCTION 3 2. TRANSMITTER SOFTWARE VERSION 5 3. DOCUMENTS FOR REFERENCE 6 4. EXPANDED DEVICE TYPE CODE 7 5. PHYSICAL LAYER INFORMATION 8 6. CONFORMANCE & COMMAND CLASS SUMMARY 9 7. ADDITIONAL RESPONSE CODE INFORMATION GENERAL TRANSMITTER INFORMATION ADDITIONAL UNIVERSAL COMMAND SPECIFICATION TRANSMITTER-SPECIFIC COMMANDS TRANSMITTER-SPECIFIC TABLES RELEASE NOTES 15 DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 2

3 1. INTRODUCTION The HART (Highway Addressable Remote Transducer) Protocol is a universal standard for sending and receiving digital information across analog wires between Smart devices such as Field Transmitters and the Control or Monitoring system such as a Distributed Control System or a Hand Held Communicator. Most automation networks in operation today are based, on the traditional 4-20mA analog signal, HART technology serves an important role as the digital information can be simultaneously communicated over and alongwith the 4-20mA signal. The HART Protocol can be used in various modes such as single-point or multidrop for communicating information to/from smart field instruments and central control or monitoring systems. The HART Protocol provides two simultaneous communication channels: the 4-20mA analog signal and a digital signal. The analog signal communicates the primary measured value using the 4-20mA current loop. Additional device information is communicated using a digital signal that is superimposed on the analog signal. The digital signal contains information from the device including device status, diagnostics, additional measured or calculated values, etc. The HART Protocol provides for up to two masters (primary and secondary). This allows secondary masters such as handheld communicators to be used without interfering with communications to/from the primary master, i.e. control/monitoring system. DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 3

4 The HART Protocol permits all digital communication with field devices in either single-point or multidrop network configurations: Single-Point Configuration Multidrop Configuration DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 4

5 2. TRANSMITTER SOFTWARE VERSION SMARTPro 8968 Transmitters with software revision and upwards are HART 7.0 compliant. DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 5

6 3. DOCUMENTS FOR REFERENCE Document Title Revision Document Number HART - FSK Physical Layer Specification 8.1 HCF_SPEC-54 HART - Data Link Layer Specification 8.2 HCF_SPEC-81 HART - Command Summary Specification 9.0 HCF_SPEC-99 HART - Universal Command Specification 7.0 HCF_SPEC-127 HART - Common Practice Command Specification 9.0 HCF_SPEC-151 HART - Common Tables 19.0 HCF_SPEC-183 Appendix 1 - Command Specific Response Code Definitions 6.0 HCF_SPEC-307 Application Layer Guideline on HART Status Information 1.0 HCF_LIT-5 DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 6

7 4. EXPANDED DEVICE TYPE CODE Manufacturer Identification Code Forbes Marshall Manufacturer s Device Type Code SMARTPro DO DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 7

8 5. PHYSICAL LAYER INFORMATION Field Device Category Transmitter Type A (Sink direct current & receive operating power from the network) Cable Specification Use Physical Layer spec HCF_SPEC-54 DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 8

9 6. CONFORMANCE & COMMAND CLASS SUMMARY CONFORMANCE CLASS #1 UNIVERSAL 0 Read Unique Identifier 1 Read Primary Variable 2 Read loop current and percent of range 3 Read all dynamic variables and Loop current 9 Read Device variable with status 33 Read device variable CONFORMANCE CLASS #2 UNIVERSAL 7 Read Loop configuration 8 Read dynamic variable families 11 Read Unique Identifier Associated with Tag 12 Read Message 13 Read Tag, Descriptor, Date 14 Read Primary Variable Sensor Information 15 Read Primary Variable Output Information 16 Read Final Assembly Number 20 Read Long tag 48 Read Additional Transmitter status COMMON PRACTICE 50 Read Dynamic Variable Assignment 54 Read Device variable Information CONFORMANCE CLASS #3 UNIVERSAL 6 Write Polling Address 17 Write Message 18 Write Tag, Descriptor, Date 19 Write Final Assembly number 22 Write Long Tag 38 Reset Configuration changed counter COMMON PRACTICE 34 Write Primary Variable Damping Value 35 Write Primary Variable Range Value 40 Enter/ExitFixed Primary Variable Current Mode 41 Perform Self Test 42 Perform Device Reset 44 Write Primary Variables Units 59 Write Number of Response Preamble CONFORMANCE CLASS #4 COMMON PRACTICE 45 Trim Loop Current Zero 46 Trim Loop Current Gain DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 9

10 7. ADDITIONAL RESPONSE CODE INFORMATION FIRST BYTE 7.1 BUSY Response Code #32 The Busy Response Code is implemented for Commands #6 and #42 and while writing data in EEPROM of Field Device. A confirming response is made before execution begins. The Busy Response Code is returned when a command is received during the execution. 7.2 FIELD DEVICE MALFUNCTION Bit #7 Not used 7.3 CONFIGURATION CHANGED Bit #6 When the Parameter Setting Data is changed, this Bit is set. The Command #38 resets the bit. 7.4 MORE STATUS AVAILABLE Bit #4 This Bit is set if more status information is read using Command # PRIMARY VARIABLE ANALOG OUTPUT FIXED Bit #3 This bit is set if output current 1 has been frozen by corresponding operation at the transmitter, or if the output has been fixed via HART with the Command #40, or in the case of reset or power failure during start-up. 7.6 PRIMARY VARIABLE ANALOG OUTPUT SATURATED Bit #2 This flag is set whenever the Primary Variable Analog Output saturates below 3.8 ma and above 20.5 ma. DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 10

11 8. GENERAL TRANSMITTER INFORMATION 8.1 DAMPING IMPLEMENTATION The DO Transmitter has a damping value which can be change by user. 8.2 NON VOLATILE MEMORY DATA STORAGE All data sent to the transmitter will be saved automatically in the nonvolatile memory. 8.3 MULTIDROP OPERATION This revision of the DO Transmitter supports Single or Multidrop Operation. In case of a single transmitter, the master-assignable Polling Address is 0. In case of multidrop, upto 15 devices can be connected to the Master (Host PC or a HHC). The Polling Addresses can then range from 1 to BURST MODE This revision of the DO Transmitter does not support Burst Mode. 8.5 UNIT CONVERSIONS Conversion of all primary variable units is possible. For DO: %, ppm, ppb, Special DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 11

12 9. ADDITIONAL UNIVERSAL COMMAND SPECIFICATION The DO(Tx 8968) implements a subset of the Universal Commands specified in the Universal Command Specification document. This section contains information pertaining to those commands that require clarification. 9.1 COMMAND #38 RESET CONFIGURATION CHANGE COUNTER This command resets the bit associated with the device issuing this command. Any configuration changed in field device cause change in configuration flag. User can reset this flag by command # COMMAND #48 READ ADDITIONAL TRANSMITTER STATUS The Transmitter Self Test (Device Diagnostics) starts immediately after execution of command #41 of Common Practice Command. The transmitter display shows the test progress. No measurement happens during the execution of self test. A Display test, EEPROM test (parameter memory, transmitter calibration data), DO sensor short, amp fail, temperature sensor open or short, calibration time over, adc fail and i2c fail are performed. The test takes about 30 seconds to complete. The results can be retrieved with Command #48, Read Additional Transmitter Status. This Command returns the Global Device Status, the Function Mode, Alarms and Errors, the results of a Transmitter Self Test and other transmitter information. Byte #0 Byte #1 Byte #2 to #24 Error Status Bit DO sensor short Err 01 Bit Amplifier fail Err 02 Bit Temperature sensor Err 03 open Bit Temperature sensor Err 04 short Bit Calibration time over Err 05 Bit Display Off Err 06 Bit Undefined Bit Undefined Error Status Bit Calibration data error Err 07 Bit ADC fail Err 08 Bit I2C fail Err 09 Bit Undefined Bit Undefined Bit Undefined Bit Undefined Bit Undefined Undefined DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 12

13 10. TRANSMITTER-SPECIFIC COMMANDS Not applicable to this Transmitter DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 13

14 11. TRANSMITTER-SPECIFIC TABLES Refer to the Common Tables Document for all references in this section to Subset of Table USED COMMON UNIT CODES Subset of Table II, Unit Codes 5 mmhg 6 Psi 7 bar 12 Kpa 32 C 33 F 35 K 39 ma 57 % 139 ppm 169 ppb 253 Special 11.2 TRANSMITTER VARIABLE CODES Var.No. Description Unit Access Lower Limit Upper Limit Note 0 DO value % / read, write 0% / 500% / ppm / 0 ppm / 50 ppm / ppb 40 ppb(at 1bar) 1000 ppb 4 ppb (at 5bar) 1 Temperature value C F K read only -20 C 200 C Using PT100, PT1000 or Manual mode 2 Pressure value Read only 0.0 bar abs 5 bar abs Manual mode DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 14

15 12. RELEASE NOTES 12.1 Initial Release 12.2 Implementation of Universal Commands Command 0 Read unique ID Command 6 write polling Address Command 7 read loop configuration Command 8 read dynamic variable classifications Command 9 read dynamic variable with status Command 14 read primary variable transducer information Command 15 read device information Command 20 read long tag Command 21 read unique identifier associated with long tag Command 22 write long tag Command 38 reset configuration changed flag Command 48 read additional device status 12.3 Implementation of Common Practice Commands Command 33 read device variables. Command 34 write primary variable Damping value. Command 40 Enter/Exit Fixed current mode. Command 41 perform self-test. Command 42 perform device reset. Command 44 write primary variable units. Command 50 read dynamic variable assignments. Command 51 write dynamic variable assignments. Command 54 read device variable information Universal Commands PV SV TV UR LR <.> [ ] Primary variable Secondary variable Tertiary variable Upper range Lower range Actual data Additional info for the reader DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 15

16 Cmd Number Universal Command Description (command initiated by master) DO Read from device - Manufacturer ID Code Manufacturer Device Type Number of Preamble Universal Command Revision Transmitter Specific Revision Software Revision Hardware Revision Flag Assignment definition Device ID Max number of Device Variables Configuration Change Information Standard Device Status Device Profile Read from device - PV value Unit Read from device - current(ma) value of PV % value of define maximum range of PV 0x6017 E0AA[DO] <host assigned non-zero integer value> 2 <current value> 00 1 <PV value> % sat / ppb / ppm / Special <PV ma value> <PV value as % of range> Read from device - PV related current(ma) PV unit PV value SV unit SV value TV unit TV value Writing polling address. Using this command any one can change polling address of the device Read loop-current configuration and polling address. When Device is not in Multidrop mode (polling address is zero) only then HHC shows changes in loop current. For multidrop mode Loop current mode is always Disabled. Read Dynamic Variable Class Code - PV SV <PV ma> <Units as in cmd_1> <PV value> C/ F/ K/Special <SV value> bar abs / kpa abs / psi abs / mm Hg abs <TV value> Host writes to device - <polling address> <loop current mode> <polling address> DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 16

17 9 Read from device - Ext Device Status PV or SV or TV code Classification code for PV or SV or TV Units for PV or SV or TV PV or SV or TV value Device variable status for PV or SV or TV Time stamp or or 64 <Units as is cmd_1> or <units as per cmd_3> <PV or SV or TV value> 0xC0 [good] <arbitrary time value> 11 Read from device - Unique ID associated with relevant Tag 12 Read from device - Message <Unique ID as per command_0> <Tag as set by Host> <message as set by Host> 13 Read from device - Tag Descriptor Date <Tag and Descriptor as set by Host> <Date> 14 Read from device - PV Sensor Information PV Sensor Serial Number <fixed sensor data> incl. unit, limits, min span <serial no.> 15 Read from device - Complete PV output Information 250 [Alarm select n/a] 00[Linear] <PV unit> <Units as per cmd1> <PV UR value> <PV LR value> <time constant> <write protect status> 250 [private distributor code n/a] 0x00 [channel flag n/a] 16 Read from device - Assembly number 17 Write to device - Message 18 Write to device - Tag Descriptor Date 19 Write to device - Assembly number 20 Read from device - Long Tag 21 Read from device - Unique ID associated with Long tag 22 Write to device - Long Tag <assy number as set by Host> Host writes to device - <message string> Host writes to device - <tag descriptor> <date> Host writes to device - <assembly number> <long tag as set by Host> <unique ID for long tag as set by Host> Host writes to device - <long tag> DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 17

18 38 Reset - Configuration Changed Flag Host will reset - Configuration-changed Flag for Device, which may have been set by the Host 48 Read from device - Additional Device Status <DO sensor short, amplifier fail, temp sensor open, temp sensor short, calibration time over, display off> [Group1 Byte0] <Calibration data error, adc fail, i2c fail> [Group1 Byte1] [Group1 Byte 2,3,4,5 not implemented] Group 2,3,4,5 not implemented DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 18

19 12.5 Common Practice Commands Cmd Number Common Practice Command Description (command initiated by master) DO 33 Read from device - All Device variables 34 Write to device - PV damping value 35 Write to device - PV range Values <device code of PV & SV & TV> <unit of PV & SV & TV> <units as per cmd1> <value of PV & SV & TV> Host writes to device - <PV damping factor value> Host writes to device - <PV LR & UR value> 40 Enter or Exit - Fixed Current Mode Enter or Exit Fixed Current mode in non-multidrop operations 41 Perform - Self Test Device will test & return - internal i2c communication status internal ADC status PV sensor status SV sensor status 42 Perform - Device Reset Host will - Reset the Device 44 Write to device - PV units Host writes to device - <PV units> <Units as per cmd1> 45 Trim - PV current DAC Zero (current Calibration) 46 Trim - PV current DAC Gain(current Calibration.) Host will - Perform Zero & Gain current calibration of Device Host will - Perform Gain current calibration of Device 50 Read from device - Dynamic Variable code assignment. 0 [for PV] & 1 [for SV] 54 Read from device - Device Variable information. <PV & SV variable code> <PV & SV sensor Sr.No.> <PV & SV unit> <Units as per cmd1> <PV & SV sensor UR> <PV & SV sensor LR> <PV & SV min span> <PV & SV classified code> <PV & SV family code> 59 Write to device - Number of Response Preambles Host writes to device - <number of preambles in a packet> [set to 5 for Smartpro] DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 19

20 12.6 Transmitter-Specific Commands Not applicable to this Transmitter DO Transmitter SMARTPro 8968 HART Command Specification Rev 1.0 Page 20