HART® Field Device Specification Baumer CombiLyz AFI4/AFI5 Revision 1 Document 81178189, rev. 1 th Initial release: 8 of September 2015 th Current release: 8 of September 2015 Author: Bo Wellejus Simmons Baumer A/S Runetoften 19 DK-8210 DENMARK ® HART is a registered trademark of the HART Communication Foundation Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 1 of 36 1 Table of Contents 1 Table of Contents ........................................................................................................................ 2 2 2.1 2.2 2.3 2.4 2.5 Introduction ................................................................................................................................. 4 Scope ............................................................................................................................................ 4 Purpose ......................................................................................................................................... 4 Who should use this document?................................................................................................... 4 Abbreviations and definitions ........................................................................................................ 4 References.................................................................................................................................... 4 3 Device Identification ................................................................................................................... 4 4 Product Overview ....................................................................................................................... 5 5 5.1 5.1.1 5.2 5.2.1 5.2.2 5.3 5.3.1 Product Interfaces ...................................................................................................................... 6 Process Interface .......................................................................................................................... 6 Sensor Input Channels ................................................................................................................. 6 Host interface ................................................................................................................................ 6 Analog Output 1: Process Conductivity / Concentration .............................................................. 6 Analog Output 2: Process Temperature........................................................................................ 6 Local Interfaces............................................................................................................................. 6 Local Controls and Displays ......................................................................................................... 6 6 Device Variables ......................................................................................................................... 6 7 Dynamic Variables ...................................................................................................................... 7 8 8.1 8.2 8.3 Status Information ...................................................................................................................... 8 Device Status ................................................................................................................................ 8 Extended Device Status ............................................................................................................... 8 Additional Device Status (Command #48) .................................................................................... 9 9 9.1 Universal Commands ............................................................................................................... 11 Supported Universal Commands ................................................................................................ 11 10 Special notes on Universal Commands ................................................................................. 11 11 11.1 11.2 Common-Practice Commands ................................................................................................ 12 Supported Common Practice Commands .................................................................................. 12 Special notes on Common Practice Commands ........................................................................ 12 12 12.1 12.1.1 12.1.2 12.1.3 12.1.4 12.2 12.3 12.4 12.5 12.6 12.7 12.8 12.9 12.10 12.11 12.12 12.13 12.14 12.15 12.16 Conductivity Family Commands ............................................................................................. 13 Supported Conductivity Family Commands ............................................................................... 13 General Conductivity Device Family Commands (Read) ........................................................... 13 Programmable Range Conductivity Device Family Commands (Read) ..................................... 13 General Conductivity Device Family Commands (Write) ........................................................... 13 Programmable Range Conductivity Device Family Commands (Write) ..................................... 13 Command #2304 – Read Conductivity Status ............................................................................ 14 Command #2305 – Read Capabilities ........................................................................................ 14 Command #2306 – Read Supported Status Mask ..................................................................... 14 Command #2307 – Read Conductivity Sensor Information ....................................................... 15 Command #2308 – Read Device Variable Range and Label Capabilities ................................. 15 Command #2309 – Read Conductivity Device Variables ........................................................... 16 Command #2336 – Read Range Hardware Range ................................................................... 16 Command #2337 – Read Range Output Zoom .......................................................................... 17 Command #2338 – Read Range Temperature Compensation .................................................. 17 Command #2339 – Read Range Conductivity Medium Label ................................................... 18 Command #2340 – Read Range Concentration Table Points .................................................... 19 Command #2341 – Read Range Concentration Medium Label................................................. 20 Command #2342 – Read Range Forced Status ........................................................................ 20 Command #2435 – Write Conductivity Sensor Information........................................................ 21 Command #2464 – Write Range Hardware Range .................................................................... 21 Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 2 of 36 12.17 12.18 12.19 12.20 12.21 12.22 Command #2465 – Write Range Output Zoom .......................................................................... 22 Command #2466 – Write Range Temperature Compensation ................................................... 23 Command #2467 – Write Range Conductivity Medium Label .................................................... 23 Command #2468 – Write Range Concentration Table Points .................................................... 25 Command #2469 – Write Range Concentration Medium Label ................................................. 26 Command #2470 – Write Range Forced Status ......................................................................... 26 13 13.1 13.2 13.3 13.4 13.5 13.6 13.7 13.8 Device-Specific Commands..................................................................................................... 27 Command #130 – Read Device Variable State .......................................................................... 27 Command #131 – Write Device Variable State .......................................................................... 27 Command #132 – Read Device Variable Output Channel Setup ............................................... 28 Command #133 – Write Device Variable Output Channel Setup ............................................... 28 Command #134 – Reset Configuration to Factory Settings ....................................................... 29 Command #135 – Trim Device Variable Zero ............................................................................. 29 Command #136 – Trim Device Variable Gain ............................................................................ 29 Command #137 – Reset Device Variable Trim ........................................................................... 29 14 14.1 14.2 14.3 14.4 Conductivity Family Device Specific Tables .......................................................................... 30 Cond. Family Device Spec. Table 1 – Conductivity Device Family Device Variable Status ....... 30 Conductivity Family Device Specific Table 2 – Conductivity Status 0 ........................................ 30 Conductivity Family Device Specific Table 3 – Conductivity Family Capabilities 0 .................... 30 Conductivity Family Device Specific Table 4 - Conductivity Family Capabilities 1 ..................... 31 15 15.1 15.2 15.3 Device Specific Tables ............................................................................................................. 31 Sensor Type Codes .................................................................................................................... 31 Unit Codes .................................................................................................................................. 31 Internal Unit Conversion ............................................................................................................. 31 16 16.1 16.2 16.3 16.4 16.5 16.6 16.7 16.8 16.9 16.10 16.11 16.12 16.13 Performance .............................................................................................................................. 31 Sampling Rates........................................................................................................................... 31 Power-Up .................................................................................................................................... 32 Reset ........................................................................................................................................... 32 Self-Test ...................................................................................................................................... 32 Command Response Times ....................................................................................................... 32 Busy and Delayed-Response ..................................................................................................... 32 Long Messages........................................................................................................................... 32 Non-Volatile Memory .................................................................................................................. 32 Modes ......................................................................................................................................... 32 Burst Mode.................................................................................................................................. 32 Write Protection .......................................................................................................................... 32 Catch Device Variable................................................................................................................. 32 Damping...................................................................................................................................... 33 Annex A. Capability Checklist .................................................................................................................. 34 Annex B. Default Configuration ............................................................................................................... 35 Annex C. Revision History ....................................................................................................................... 36 Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 3 of 36 2 Introduction 2.1 Scope Baumer CombiLyz AFI4/AFI5 HART conductivity transmitter has built-in support for the HART 7.4 protocol. Since the HART version of the transmitter operates identically with the non-HART version of the transmitter, this document focuses solely on the HART functionalities of the transmitter. For all other operational aspects of the transmitter, please consult the data sheet and the user guide. This document contains the necessary data for an operator, familiar with the HART protocol, to access all functions of the transmitter from a master system. 2.2 Purpose This specification is designed to complement other documentation (e.g., the AFI4/AFI5 User Guide) by providing a complete, unambiguous description of this Field Device from a HART Communication perspective 2.3 Who should use this document? The specification is designed to be a technical reference for HART capable Host Application Developers, System Integrators and knowledgeable End Users. It also provides functional specifications (e.g., commands, enumerations and performance requirements) used during Field Device development, maintenance and testing. This document assumes the reader is familiar with HART Protocol requirements and terminology. 2.4 CT DT uint-8 uint-16 float ASCII packed PV SV TV QV 2.5 Abbreviations and definitions Common Table Device Specific Table 8-bit unsigned integer, representing value 0 .. 255, can also be used for single bit flags 16-bit unsigned integer, representing value 0 .. 65535 32-bit IEEE-754 (IEC 559) compatible single floating point variable ISO Latin-1 (ISO 8859) string text HART specific Packed ASCII format Primary Variable Secondary Variable Tertiary Variable Quaternary Variable References HART Smart Communications Protocol Specification. HCF_SPEC-12. Available from the HCF. CombiLyz AFI4/AFI5, Operating Instruction, Document 11126179 05. Available from www.baumer.com. 3 Device Identification Manufacturer Name: Baumer Model Name(s): AFI4/AFI5 CombiLyz Manufacture ID Code: 96 Device Type Code: 236 HART Protocol Revision 7.4 Device Revision: 1 Number of Device Variables 8 Physical Layers Supported FSK Physical Device Category Current Output (60 Hex) Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 (EC Hex) HART FDS Page 4 of 36 4 Product Overview The CombiLyz AFI4/AFI5 is an externally powered 4-20mA current output conductivity transmitter, with an extra current output channel for temperature. The HART access to transmitter is via the conductivity current output channel. The conductivity current output can be configured to output a concentration value for up to 4 different configurable media, internally calculated from the measured conductivity value. Temperature compensation is fully configurable, and the temperature used for this is either the internally measured sensor tip temperature, fixed or provided by the HART master. A 2-pin discrete input channel allows selecting 1 of 4 programmable ranges, which allows runtime switching between e.g. different zoom ranges or different concentration media. Selecting range with a HART command is also possible, overriding discrete input on these pins. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 5 of 36 5 Product Interfaces 5.1 Process Interface 5.1.1 Sensor Input Channels The main conductivity sensor is mounted around the physical hole in the sensor. A temperature sensor is located in the very tip of the sensor, providing an accurate temperature reading of the media temperature, which can be used for temperature compensation, as well as being output on the temperature current output channel. 5.2 Host interface The transmitter has two 4-20mA current output channels. Each of these can be independently configured with linear over-range from 3.5 to 23 mA. The Conductivity current output channel supports HART Communication. The error output current, to be used in case of transmitter error, is fully configurable in the range 3.5 to 23 mA, as well as which channel (or both) the error current is to be output on. The error current value is common for both channels, and cannot overlap the operating output current ranges of the selected error output channels. Linear over-range Device malfunction indication Maximum current Multi-Drop current draw Lift-off voltage Direction Down Up Fixed value Values (% of range) -3.13% to -0.01% 100.01% to 118.75% -3.13% to 118.75% 118.75% Values (mA or V) 3.50 to 3.99 mA 20.01 to 23.00 mA 3.50 to 23.00 mA 23.0 mA 4.0 mA 15.0 V 5.2.1 Analog Output 1: Process Conductivity / Concentration The two-wire 4-20mA conductivity loop current output is connected on two terminals marked “4-20mA/Cond/Conc” (+/-). Refer to the Operating Instruction for connection details. This output corresponds to Device Variable 4, which is the device variable for combined Conductivity and Concentration, depending on which operating mode is selected. HART Communication is supported on this current loop output. 5.2.2 Analog Output 2: Process Temperature The two-wire 4-20mA temperature loop current output is connected on two terminals marked “4-20mA/Temp” (+/-). Refer to the Operating Instruction for connection details. This output corresponds to Device Variable 1, which is the device variable for the process temperature. HART Communication is NOT supported on this current loop output. 5.3 Local Interfaces 5.3.1 Local Controls and Displays This device can be attached to a DFON display, providing local in-situ measurement readout and configuration possibilities. A DFON display is connected with the provided flat ribbon cable provided with the display unit. FlexProgram configuration is also possible on the two Com. terminals. A PC and a Baumer FlexProgrammer 9701 must be used for this. Standalone configuration with the FlexProgrammer is not possible on the AFI4/AFI5. A 2-pin discrete input channel exists for selecting configurable ranges. Please refer to the Operating Instruction manual for more information. 6 Device Variables This Field Device does not expose any Device Variables. DV No. Name Description 0, 246 Conductivity Conductivity measurement with Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 Unit codes 66 mS/cm Classification code 87 Conductance HART FDS Page 6 of 36 PV temperature compensation 67 µS/cm Current Output capability on current output channels: 2 (indirectly via Dev. Var. 4) 1, 247 Temperature Sensor tip temperature 64 Temperature 32 ⁰C SV measurement 33 ⁰F Current Output capability on current output channels: 1 2, 248 Concentration Concentration value calculated 57 % 90 Concentration TV from the Conductivity measurement Current Output capability on current output channels: 2 (indirectly via Dev. Var. 4) 3, 249 Raw Conductivity Conductivity measurement 66 mS/cm 87 Conductance QV without temperature compensation 4 Concentration / Mode dependent. Value, unit and 66 mS/cm 87 Conductance Conductivity classification fetched directly from 67 µS/cm 90 Concentration either Device Variable 0 or Device 57 % Variable 2. Current Output capability on current output channels: 2 6, 244 Percent of Range Output in % of full scale 57 % 0 Not Class’d 7, 245 Loop Current Loop Current associated with 39 mA 84 Current Device Variable 4, representing either Conductivity or Concentration 8 Loop Current Loop Current associated with 39 mA 84 Current (Secondary) Device Variable 1, representing sensor temperature Only Conductivity (PV) and Temperature (SV) allow changing of unit codes. Device Variable 4 automatically adapts the used Conductivity unit code. 7 Dynamic Variables Two Dynamic Variables are implemented. Dyn var. Meaning PV Conductivity SV Temperature TV Concentration QV Raw Conductivity Units µS/cm, mS/cm ⁰C, ⁰F % mS Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 7 of 36 8 Status Information 8.1 Device Status The Field Device Status byte is contained in the second data byte in messages from the device. The following table defines the meaning of the different status bits. Bit 7 Definition Device Malfunction Configuration Changed 6 Cold Start 5 4 More Status Available Loop Current Fixed 3 2 1 0 8.2 Loop Current Saturated Non-Primary Variable Out of Limits Primary Variable Out of Limits Description Is set if an electronic defect or memory defect is detected. Is set if a HART command results in writing new data to a configuration register. Writing a new value identical to the currently stored value, does not result in this bit being set. Is set upon restart. It is reset for each master after responding to the first command from that specific master. Is set if any of the Additional Device Status bits change status. This bit is set if device is running in Fixed Current Mode (Command 40) or if Loop Current Signaling mode is turned off (e.g. in Multidrop Mode). Is set if the output current associated to PV/TV/DV4 is capped by either the upper or lower current limits. Is set if either SV, TV or QV is high or low limited. Is set if PV is high or low limited. Extended Device Status Extended Device Status is returned along with Additional Device Status by HART Command 48. Two bits are supported in this device. Bit Definition Description Critical Power Failure Is set if the device detects that the power supply is 2 not performing as expected. Device Variable Alert This bit is set if any Device Variable is simulated/fixed, or the environmental conditions are 1 out of range. It will also be se if an electronic defect or memory defect is detected. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 8 of 36 8.3 Additional Device Status (Command #48) Command #48 returns 14 bytes of data, with the following status information: Byte Bit Definition Description Device Specific Error Status Flags 0 7-1 NOT USED 0 General Transmitter Error Is set if wire break is detected Device Specific 0 1 7-0 NOT USED Device Specific 1 2 7-0 NOT USED Device Specific 2 3 7-0 NOT USED Device Specific 3 4 7-0 NOT USED Device Specific 4 5 7-0 NOT USED Extended Device Status 7-3 NOT USED 6 2 Critical Power Failure See Extended Device Status 1 Device Variable Alert See Extended Device Status 0 NOT USED NOT USED 7 7-0 NOT USED Standardized Status 0 7 NOT USED 6 Electronic Defect Is set in case of wire break 5 Environment Conditions out of This bit is set if either media or ambient temperatures Range out of range. 4 Power Supply Conditions out of Is set if the device detects that the power supply is Range not performing as expected. 8 3 Watchdog Reset Executed This bit is set in case of the watchdog resetting the device, in case of firmware running into a software dead-lock. 2 Non-volatile Memory Defect This bit is set if a problem with the system memory is detected. 1 Device Variable Simulation Active Is set if any device variable is being simulated, e.g. by in-factory system test. 0 NOT USED Standardized Status 1 7-3 NOT USED 2 Event Notification Overflow This bit is set if the internal processor becomes overworked, not able to execute all tasks given within 9 the allowed time. 1 Discrete Variable Simulation Is set if any device variable is being simulated, e.g. by in-factory system test. 0 Simulation Active Is set if any device variable is being simulated, e.g. by in-factory system test. Table continues on next page .. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 9 of 36 .. table continued from previous page. Analog Channel Saturated 7-3 NOT USED 2 Analog Channel 2 10 1 Analog Channel 1 11 12 13 0 NOT USED Standardized Status 2 7-0 NOT USED Standardized Status 3 7-0 NOT USED Analog Channel Fixed 7-3 NOT USED 2 Analog Channel 2 1 Analog Channel 1 0 NOT USED Is set if Analog Channel 2 is capped by either the upper or lower current limit. Is set if Analog Channel 1 is capped by either the upper or lower current limit. Is set if Analog Channel 2 is fixed by in-factory system test. Is set if Analog Channel 1 is fixed by either Fixed Current Mode (Command 40) or if Loop Current Signaling mode is turned off (e.g. in Multidrop Mode). It can be caused by a running in-factory system test. NOT USED bits are always set to 0. These status bits are updated several times each second. They are set by any failure detected by the periodic status update routine. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 10 of 36 9 Universal Commands 9.1 Supported Universal Commands All Universal Commands are mandatory and are supported by the device. Following Universal Commands are implemented: 0 Read Unique Identifier 1 Read Primary Variable 2 Read Loop Current And Percent Of Range 3 Read Dynamic Variables And Loop Current 6 Write Polling Address 7 Read Loop Configuration 8 Read Dynamic Variable Classifications 9 Read Device Variables with Status 11 Read Unique Identifier Associated With Tag 12 Read Message 13 Read Tag, Descriptor, Date 14 Read Primary Variable Transducer Information 15 Read Device Information 16 Read Final Assembly Number 17 Write Message 18 Write Tag, Descriptor, Date 19 Write Final Assembly Number 20 Read Long Tag 21 Read Unique Identifier Associated With Long Tag 22 Write Long Tag 38 Reset Configuration Changed Flag 48 Read Additional Device Status 10 Special notes on Universal Commands Command #3: Returns PV, SV, TV and QV. This totals in 24 data bytes. Command #9: This command supports up to 4 device variables. This totals in up to 37 data bytes, including the time stamp. If more than 4 device variables are requested, only the first 4 are returned, along with a warning. Command #14: Transducer serial number is not supported. The units code for limits and minimum span is equal to that of the Primary Variable. Since the physical transducer can be switched between different physical ranges, the returned transducer limits reflect those of the currently selected range’s limits. Command #15: Write protect is not implemented, and Write Protect Code is therefore always returned as “251” (None). The unit code for Primary Variable range values is the same as is used for the Primary Variable. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 11 of 36 11 Common-Practice Commands 11.1 Supported Common Practice Commands The following common-practice commands are implemented: 34 35 36 37 38 40 42 43 44 45 46 48 50 53 11.2 Write Primary Variable Damping Value Write Primary Variable Range Values Set Primary Variable Upper Range Value Set Primary Variable Lower Range Value Reset "Configuration Changed" Flag Enter/Exit Fixed Current Mode Perform Device Reset Set Primary Variable Zero Write Primary Variable Units Trim Loop Current Zero Trim Loop Current Gain Read Additional Device Status Read Dynamic Variable Assignment Write Device Variable Units Special notes on Common Practice Commands Command #35: Please see Common note 1. Command #36: Please see Common note 1. Command #37: Please see Common note 1. Command #45: Prior to issuing this command, the loop current must be fixed at exactly 4.000mA (set with command 40). Command #46: Prior to issuing this command, the loop current must be fixed at exactly 20.000mA (set with command 40). Command #48: Returns 14 bytes of data. Common note 1: Since this transmitter has several different physical measurement ranges, these commands only allows execution when the first range (Range 1) is selected either by discrete input pins R1 and R2 or by the designated Conductivity Family HART command (Command 2470). If any other range is being used, this command will respond with error code 15 – “Non-Active Range Attempted Changed”. Additionally, this device does not support reverse operation. This means that PV Upper Range Value must be bigger than PV Lower Range Value. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 12 of 36 12 Conductivity Family Commands The following conductivity family commands are taken from the new preliminary Conductivity Family Specification from the active Conductivity Working Group, since the original preliminary Conductivity Family Specification contains flawed command numbers. Additionally the original preliminary lacked vital features regarding ranges, used by many conductivity transmitter types. Command description for all these new commands is added here, to minimize confusion of command specification is which. The upper byte of all the 16-bit command codes is set to 0x09 for Conductivity Family Commands, and in theory there are command codes enough for 256 commands in the family. For the sake of simplicity, all read commands are located in the range 0x0900 to 0x097F, while write commands are located from 0x0980 to 0x9FF. Additionally, the commands are divided the following 2 groups: General Conductivity Device Family Commands (Read and Write) These commands are much like commands for other device families, reading device information and status, as well as giving the master an overview of the capabilities of the device. Programmable Range Conductivity Device Family Commands (Read and Write) Many conductivity devices allow selecting different ranges at runtime, either by a discrete input, or via HART commands. These ranges most often can be programmed differently, ex. to perform special hardware zoom in certain situations, or ex. to select between concentration media setup. This section contains commands to read and write the setup of variables specifically concerning these ranges. 12.1 Supported Conductivity Family Commands Implemented conductivity family commands are as follows: 12.1.1 General Conductivity Device Family Commands (Read) 2304 Read Conductivity Status 2305 Read Capabilities 2306 Read Supported Status Mask 2307 Read Conductivity Sensor Information 2308 Read Device Variable Range and Label Capabilities 2309 Read Conductivity Device Variables 12.1.2 Programmable Range Conductivity Device Family Commands (Read) 2336 2337 2338 2339 2340 2341 2342 Read Range Hardware Range Read Range Output Zoom Read Range Temperature Compensation Read Range Conductivity Medium Label Read Range Concentration Table Points Read Range Concentration Medium Label Read Range Forced Status 12.1.3 General Conductivity Device Family Commands (Write) 2435 Write Conductivity Sensor Information 12.1.4 Programmable Range Conductivity Device Family Commands (Write) 2464 Write Range Hardware Range 2465 Write Range Output Zoom 2466 Write Range Temperature Compensation 2467 Write Range Conductivity Medium Label 2468 Write Range Concentration Table Points 2469 Write Range Concentration Medium Label 2470 Write Range Forced Status Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 13 of 36 12.2 Command #2304 – Read Conductivity Status This command reads out status for the specified Pressure Device Variable Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Conductivity Family Device Variable Status (FT 1) 2 uint-8 Conductivity Family Status 0 (FT 2) Command specific response codes for command 2304 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command 12.3 Command #2305 – Read Capabilities This command reads the capabilities of the Conductivity Device Family Variable. Some functions are optional and this command shows which ones are implemented. Each bit in the capability registers describes a feature. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Family Definition Revision 2 uint-8 Conductivity Family Capabilities 0 (FT 3) 3 uint-8 Conductivity Family Capabilities 1 (FT 4) Command specific response codes for command 2305 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command 12.4 Command #2306 – Read Supported Status Mask This command reads out a bit mask, used to identify which corresponding status flags (read using Command #2304 – Read Conductivity Status) are supported by the device. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Supported Device Family Variable Status Bit Mask (FT 1) 2 uint-8 Supported Conductivity Status 0 Bit Mask (FT 2) Command specific return codes for command 2306 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 14 of 36 12.5 Command #2307 – Read Conductivity Sensor Information This command reads out the sensor information of the physical transducer used to get data for use with the specified device variable. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Sensor Type 2..5 float Cell Constant Command specific response codes for command 2307 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command Cell constant is not the accurate cell constant, but the typical cell constant of this cell type. The cell constant is -1 given in the unit (cm ). 12.6 Command #2308 – Read Device Variable Range and Label Capabilities This command reads the Range capabilities for the specified device variable – which give an impression of how to configure ranges and labels. Number of ranges specify how many ranges this device can switch between. Number of labels specify how many labels are available in total for this device variable. Number of labels for each range specify how many label are unique for each range for this device variable. Range flags define some more special details for the device variables. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Number of ranges 2 uint-8 Number of labels associated with this device variable 3 uint-8 Number of labels associated with each Range for this Device Variable 4 uint-8 Range flags (DT 10) Command specific response codes for command 2308 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 15 of 36 12.7 Command #2309 – Read Conductivity Device Variables This command reads the all the standard conductivity device variables Conductivity Device Family Variable. This standard conductivity device command for some reason uses a device variable code to output standard values. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1..4 float Conductivity 5..8 float Temperature 9..12 float Concentration 13..16 float Raw Conductivity Command specific response codes for command 2309 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command CombiLyz AFI4/AFI5 specific: Only Device Variable Code 0 (and Primary Variable Code 245) is allowed in this device! The function therefore always returns Device Variable 0, 1, 2 and 3, which are Conductivity, Temperature, Concentration and Raw Conductivity. 12.8 Command #2336 – Read Range Hardware Range This command reads the hardware range of the specified range. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Range unit (CT 2) 3..6 float Lower hardware range input (DT 3) 7..10 float Upper hardware range input (DT 4) Command specific response codes for command 2336 Code Type Description 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command Range unit defines the unit in which the values are returned. CombiLyz AFI4/AFI5 specific: Only usable on the Conductivity Family Device Variables. All device variables share the same ranges. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 16 of 36 12.9 Command #2337 – Read Range Output Zoom This command reads the zoom of the selected range. The output is adjusted according to the following scaling: Lower range zoom value correspond to the Lower range loop output current value, and Upper range zoom value corresponding to the Upper range loop current value. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Range unit (CT 2) 3..6 float Lower range zoom 7..10 float Upper range zoom 11..14 float Lower range loop output current [mA] 15..18 float Upper range loop output current [mA] Command specific response codes for command 2337 Code Type Description 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command Range unit specifies the unit in which the values are returned. 12.10 Command #2338 – Read Range Temperature Compensation This command reads the temperature compensation variables for the selected range. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Temperature unit (CT 2) 3 uint-8 Temperature source (DT 7) 4..7 float Compensation temperature 8..11 float Linear compensation [%/K] 12..15 float Exponential compensation 2 [%/K ] 16..19 float Reference temperature Command specific response codes for command 2338 Code Type Description 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command Compensation temperature returned is the temperature used, from the specified source. The Temperature unit is not necessarily the temperature unit used in the device, but the unit for the temperature values returned with this command. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 17 of 36 12.11 Command #2339 – Read Range Conductivity Medium Label Many devices are able to assume the presence of a specific medium, if the conductivity is within a certain range. This command reads the label string which is configured for the specified conductivity range. Use conductivity label no. 0 (zero) to read the label used when outside of the other ranges. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Conductivity label no. (DT 5) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Conductivity label no. (DT 5) 3 uint-8 Conductivity unit (CT 2) 4..7 float Lower limit for conductivity media label range 8..11 float Upper limit for conductivity media label range 12..27 ASCII Conductivity media label Command specific response codes for command 2339 Code Type Description 13 Error Invalid Label Number 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command NOTE: This command can only be used on Device Variables with Conductivity Classification. CombiLyz AFI4/AFI5 specific: This command can only be used on the Primary Device Variable. All Ranges share the same media labels. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 18 of 36 12.12 Command #2340 – Read Range Concentration Table Points This command reads the specified Conductivity/Concentration table points. It also returns the number of table points to use in total for this range. It is possible to read up to 8 table points with each issue of the command. Point number specifies the first point to be read with this command, while Number of table points in message defines how many points are to be read with the command. It is optional for a device to support more than one point for each command. It must be clearly stated in the device HART documentation how many points are supported for command 2340, or if a very specific number of points are to be used. Note: Command 2340 and Command 2468 must support the same amount of points per message. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Point number (point x) 3 uint-8 Number of table points in msg. Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Point number (point x) 3 uint-8 Number of table points in msg. 4 uint-8 Number of table points to use 5 uint-8 Conductivity unit 6 uint-8 Concentration unit 7..10 float Point x Conductivity value 11..14 float Point x Concentration value 15..18 float Point x+1 Conductivity value 19..22 float Point x+1 Concentration value 23..26 float Point x+2 Conductivity value 27..30 float Point x+2 Concentration value 31..34 float Point x+3 Conductivity value 35..38 float Point x+3 Concentration value 39..42 float Point x+4 Conductivity value 43..46 float Point x+4 Concentration value 47..50 float Point x+5 Conductivity value 51..54 float Point x+5 Concentration value 55..58 float Point x+6 Conductivity value 59..62 float Point x+6 Concentration value 63..66 float Point x+7 Conductivity value 67..70 float Point x+7 Concentration value Command specific response codes for command 2340 Code Type Description 2 Error Invalid Selection 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command 29 Error Invalid Table Point Selection NOTE: The parameters with the grey background fill are only returned if at least one table point is read. This command can only be used on Device Variables with Concentration Classification. CombiLyz AFI4/AFI5 specific: Points are denoted 1 .. 30. Limited to 4 points in each message. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 19 of 36 12.13 Command #2341 – Read Range Concentration Medium Label This command reads the concentration setup. It reads concentration mode status for the specified Concentration Device Variable, and reads the label string for the specified Range number. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2..17 ASCII Concentration range label Command specific response codes for command 2341 Code Type Description 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command This command can only be used on Device Variables with Concentration Classification. 12.14 Command #2342 – Read Range Forced Status The active range is often selectable using a combination of + and - on digital input pins. This command reads the status of the forced range used. NOT_USED is returned if it not forced. This setting is volatile, and will be set to NOT_USED on reset! Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) Command specific response codes for command 2342 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command CombiLyz AFI4/AFI5 specific: This command reads the forced range for all Device Variables, no matter which Device Variable is targeted. Only one range is selectable at a time for all Device Variables. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 20 of 36 12.15 Command #2435 – Write Conductivity Sensor Information This command writes sensor type and cell constant. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Sensor Type 2..5 float Cell Constant Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Sensor Type 2..5 float Cell Constant Command specific response codes for command 2435 Code Type Description 2 Error Invalid Selection (Sensor Type) (Not relevant) 3 Error Passed Parameter Too Large (Cell Constant) (Not relevant) 4 Error Passed Parameter Too Small (Cell Constant) (Not relevant) 16 Error Access Restricted 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command CombiLyz AFI4/AFI5 specific: Changing sensor type and cell constant is not allowed on this device. Consequently, all correct commands always return return-code ACCESS_RESTRICTED! Cell constant is not the accurate cell constant, but the typical cell constant of this cell type. The cell constant is -1 given in the unit (cm ). 12.16 Command #2464 – Write Range Hardware Range This command writes the hardware range of the selected conductivity range. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Range unit (CT 2) 3..6 float Lower hardware range input (DT 3) 7..10 float Upper hardware range input (DT 4) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Range unit (CT 2) 3..6 float Lower hardware range input (DT 3) 7..10 float Upper hardware range input (DT 4) Command specific response codes for command 2464 Code Type Description 8 Warning Set To Nearest Value 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 18 Error Invalid Units Code 19 Error Device Variable Index Not Allowed For This Command Range unit defines the unit in which the values are sent and returned. It does not setup the unit for the device variable. To make it easier to find a valid hardware range, then the device should automatically set the range to the closest valid values, preferably with a bigger span, not truncating the requested hardware range. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 21 of 36 CombiLyz AFI4/AFI5 specific: Modifying Lower conductivity range input and Upper range input for the Conductivity variable zoom range will be limited by the hardware range selected with this command. Modifying the hardware range will also set the Output Zoom range to this specific value. This can be manually set afterwards using command Command #2465 – Write Range Output Zoom. If invalid value for either Lower Hardware Range Input or Lower Hardware Range Input is invalid, it will be set to nearest value, see Device Specific Table 3 and 4. 12.17 Command #2465 – Write Range Output Zoom This command writes the output zoom of the selected range for the specified device variable. The output is adjusted according to the following scaling: Lower range zoom value correspond to the Lower range loop output current value, and Upper range zoom value corresponding to the Upper range loop current value. The units allowed depend on the device variable number (and type). Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Range unit (CT 2) 3..6 float Lower range zoom 7..10 float Upper range zoom 11..14 float Lower range loop output current [mA] 15..18 float Upper range loop output current [mA] Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Range unit (CT 2) 3..6 float Lower range zoom 7..10 float Upper range zoom 11..14 float Lower range loop output current [mA] 15..18 float Upper range loop output current [mA] Command specific response codes for command 2465 Code Type Description 9 Error Lower Range Value Too High 10 Error Lower Range Value Too Low 11 Error Upper Range Value Too High 12 Error Upper Range Value Too Low 13 Error Invalid Current Value 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 18 Error Invalid Units Code 19 Error Device Variable Index Not Allowed For This Command 29 Error Invalid Span If there are no different ranges available (one single large range) for the specified Device Variable, then Range number 0 must be used. Range unit specifies the unit in which the values are sent. It does not setup the unit for the device variable. CombiLyz AFI4/AFI5 specific: Lower range input and Upper range input for the Conductivity range will be limited by the selected hardware range. Lower range loop output current must always be 4 mA. Upper range loop output current must always be 20 mA. If using Command #2340 – Read Range Concentration Table Points then the zoom of the specified Concentration device variable may be set according to the table. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 22 of 36 12.18 Command #2466 – Write Range Temperature Compensation This command writes the temperature compensation variables for the selected range. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Temperature unit (CT 2) 3 uint-8 Temperature source (DT 7) 4..7 float Compensation temperature 8..11 float Linear compensation [%/K] 12..15 float Exponential compensation 2 [%/K ] 16..19 float Reference temperature Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Temperature unit (CT 2) 3 uint-8 Temperature source (DT 7) 4..7 float Compensation temperature 8..11 float Linear compensation [%/K] 12..15 float Exponential compensation 2 [%/K ] 16..19 float Reference temperature Command specific response codes for command 2466 Code Type Description 2 Error Invalid Selection 3 Error Passed Parameter Too Large 4 Error Passed Parameter Too Small 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 18 Error Invalid Units Code 19 Error Device Variable Index Not Allowed For This Command 29 Error Invalid Coefficient If Exponential compensation is not used, it should be set to zero. If Reference temperature is not used, it should be set to 25°C, which is standard reference temperature. The Compensation temperature sent to transmitter is ignored if it is set to use internal or HART temperature source. However, if it runs in Fixed temperature mode, the this is used to set the Fixed temperature. Compensation temperature returned is the temperature used, from the specified source. The Temperature unit is not the temperature unit to be used in the device, but the unit for the temperature values sent with this command. CombiLyz AFI4/AFI5 specific: The only temperature unit allowed for this command is ºC There is no limit for either the temperature and compensation values that can be used for this command, error code Invalid Coefficient is therefore not used on AFIx Using this function sets the Advanced compensation variable to enabled! 12.19 Command #2467 – Write Range Conductivity Medium Label Many devices are able to assume the presence of a specific medium, if the conductivity is within a certain range. This command writes the label string for the specified conductivity range. Use conductivity label no. 0 (zero) to write the label used when outside of the other ranges. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Conductivity label no. (DT 5) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Conductivity label no. (DT 5) Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 23 of 36 3 4..7 uint-8 float 8..11 float 12..27 ASCII Conductivity unit (CT 2) Lower limit for conductivity media label range Upper limit for conductivity media label range Conductivity media label 3 4..7 uint-8 float 8..11 float 12..27 ASCII Conductivity unit (CT 2) Lower limit for conductivity media label range Upper limit for conductivity media label range Conductivity media label Command specific response codes for command 2467 Code Type Description 9 Error Lower Range Value Too High 10 Error Lower Range Value Too Low 11 Error Upper Range Value Too High 12 Error Upper Range Value Too Low 13 Error Invalid Label Number 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 18 Error Invalid Units Code 19 Error Device Variable Index Not Allowed For This Command NOTE: This command can only be used on Device Variables with Conductivity Classification. CombiLyz AFI4/AFI5 specific: This command can only be used on the Primary Device Variable. This command does the same to all “Ranges”, no matter which range is selected. This command will report failure if writing a label in a range that overlaps another label range. Reduce the size of the range that is in the way to set the new label range. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 24 of 36 12.20 Command #2468 – Write Range Concentration Table Points This command sets up the specified Conductivity/Concentration table points. It also specifies the number of table points to use in total for this range. It is possible to setup up to 8 table points with each issue of the command. Point number specifies the first point to be changed with this command, while Number of table points in message defines how many points are included in the command message. It is optional for a device to support more than one point for each command. If command is issued with 0 points in the message, it is not necessary to send units. Note: Command 2340 and Command 2468 must support the same amount of points per message. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Point number (point x) 3 uint-8 Number of table points in msg. 4 uint-8 Number of table points to use 5 uint-8 Conductivity unit 6 uint-8 Concentration unit 7..10 float Point x Conductivity value 11..14 float Point x Concentration value 15..18 float Point x+1 Conductivity value 19..22 float Point x+1 Concentration value 23..26 float Point x+2 Conductivity value 27..30 float Point x+2 Concentration value 31..34 float Point x+3 Conductivity value 35..38 float Point x+3 Concentration value 39..42 float Point x+4 Conductivity value 43..46 float Point x+4 Concentration value 47..50 float Point x+5 Conductivity value 51..54 float Point x+5 Concentration value 55..58 float Point x+6 Conductivity value 59..62 float Point x+6 Concentration value 63..66 float Point x+7 Conductivity value 67..70 float Point x+7 Concentration value Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2 uint-8 Point number (point x) 3 uint-8 Number of table points in msg. 4 uint-8 Number of table points to use 5 uint-8 Conductivity unit 6 uint-8 Concentration unit 7..10 float Point x Conductivity value 11..14 float Point x Concentration value 15..18 float Point x+1 Conductivity value 19..22 float Point x+1 Concentration value 23..26 float Point x+2 Conductivity value 27..30 float Point x+2 Concentration value 31..34 float Point x+3 Conductivity value 35..38 float Point x+3 Concentration value 39..42 float Point x+4 Conductivity value 43..46 float Point x+4 Concentration value 47..50 float Point x+5 Conductivity value 51..54 float Point x+5 Concentration value 55..58 float Point x+6 Conductivity value 59..62 float Point x+6 Concentration value 63..66 float Point x+7 Conductivity value 67..70 float Point x+7 Concentration value Command specific response codes for command 2468 Code Type Description 2 Error Invalid Selection 3 Error Passed Parameter Too Large (Not implemented) 4 Error Passed Parameter Too Small (Not implemented) 9 Error Lower Range Value Too High (Not implemented) 10 Error Lower Range Value Too Low (Not implemented) 11 Error Upper Range Value Too High (Not implemented) 12 Error Upper Range Value Too Low (Not implemented) 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 18 Error Invalid Units Code 19 Error Device Variable Index Not Allowed For This Command 28 Error Command Data Overflow 29 Error Invalid Table Point Selection This command can only be used on Device Variables with Concentration Classification. NOTE: The parameters with the blue background fill are only returned, if at least one table point is written. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 25 of 36 CombiLyz AFI4/AFI5 specific: Points are denoted 1 .. 30. Limited to 4 points in each message. If setting Concentration mode Enable for Device Variable 2, Device Variable 4 will output Concentration instead of Conductivity, and the Loop Current output will output the Conductivity output current. There is no check on the conductivity and concentration values! It can cause erratic behavior if variables are not properly setup. Irrelevant response codes are therefore have a strike-through in the response code list. 12.21 Command #2469 – Write Range Concentration Medium Label This command writes the label string for the specified Range number. Please note that this command can be issued with a one byte predefined media label number instead of a full media label string of 16 bytes. In either way, the response always returns the full written data string. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2..17 ASCII Concentration range label Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Range number (DT 2) 2..17 ASCII Concentration range label Command specific response codes for command 2469 Code Type Description 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command This command can only be used on Device Variables with Concentration Classification. CombiLyz AFI4/AFI5 specific: No check of invalid characters is performed on the label. 12.22 Command #2470 – Write Range Forced Status The active range is often selectable using a combination on external pins. This command sets up the active range to be forced to a certain range. Forced status is lost at restart. Use NOT_USED to turn off forced mode. This setting is volatile, and will be set to NOT_USED on reset! Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Forced range number (DT 2) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Forced range number (DT 2) Command specific response codes for command 2470 Code Type Description 15 Error Invalid Programmable Range Number 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command CombiLyz AFI4/AFI5 specific: This command forces all Device Variables to the specified range, no matter which Device Variable is targeted. Only on range is selectable at a time for all Device Variables. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 26 of 36 13 Device-Specific Commands The following device-specific commands are implemented: Command 130 – Read Device Variable State Command 131 – Write Device Variable State Command 132 – Read Device Variable Output Channel Setup Command 133 – Write Device Variable Output Channel Setup Command 134 – Reset Configuration to Factory Settings Command 135 – Trim Device Variable Zero Command 137 – Reset Device Variable Trim 13.1 Command #130 – Read Device Variable State This command reads out the state whether the Device Variable is enabled or disabled. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Device Variable State (DT 6) Command specific response codes for command 130 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command CombiLyz AFI4/AFI5 specific: This command can only be used on Device Variables with Concentration Classification. 13.2 Command #131 – Write Device Variable State This command writes the state whether the Device Variable is enabled or disabled. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Device Variable State (DT 6) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Device Variable State (DT 6) Command specific response codes for command 131 Code Type Description 2 Error Invalid Selection 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command CombiLyz AFI4/AFI5 specific: This command is specifically used to enable and disable AFI4/AFI5’s concentration mode. This command can only be used on Device Variables with Concentration Classification. Concentration enable is shared for Device Variable 2 and 4. If setting Concentration mode Enable for Device Variable 2, it will start outputting data (Outputs NOT_A_NUMBER when disabled), and Device Variable 4 will output Concentration instead of Conductivity. This command cannot be used on Device Variable 4, since it is a multi-classification variable, and not Concentration classification. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 27 of 36 13.3 Command #132 – Read Device Variable Output Channel Setup This command reads the setup of the output for the specified device variable. This includes the current limits and the current to use in case of error, and which errors that may use this output as error channel. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Output channel number (DT 8) 2..5 float Lower channel output limit [mA] 6..9 float Upper channel output limit [mA] 10 uint-8 Error output enable flags (DT 9) 11..14 float Error current [mA] Command specific response codes for command 132 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command For device variables that cannot be assigned an output channel: Output Channel Number is set to NOT_USED, and floats are set to NOT_A_NUMBER. Error output flags are returned as zero. 13.4 Command #133 – Write Device Variable Output Channel Setup This command sets up the Analog output channel source for the specified device variable and sets the limits which the output will not exceed in normal operation. It also sets up which errors are allowed to use this output channel, and what current an active error forces the output to. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Output channel number (DT 8) 2..5 float Lower channel output limit [mA] 6..9 float Upper channel output limit [mA] 10 uint-8 Error output enable flags (DT 9) 11..14 float Error current [mA] Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Output channel number (DT 8) 2..5 float Lower channel output limit [mA] 6..9 float Upper channel output limit [mA] 10 uint-8 Error output enable flags (DT 9) 11..14 float Error current [mA] Command specific response codes for command 133 Code Type Description 10 Error Lower Limit Current Too Low 11 Error Upper Limit Current Too High 15 Error Invalid Error Current Value 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command 29 Error Invalid Span CombiLyz AFI4/AFI5 specific: The only allowed channel assignment is: Device variable 1 – Temperature .. Channel 2 Device variable 4 – Combined Conductivity / Concentration .. Channel 1 No other device variables are allowed to have an assigned output channel. Setting error current for either device variable 1 or 4, will set it for the other channel as well. WARNING!: Error current is only checked for not overlapping the actual channel’s limits – it may very well overlap another channel’s limits. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 28 of 36 13.5 Command #134 – Reset Configuration to Factory Settings This command resets all configuration in the device to the state it was when shipped from the factory. Request data frame Byte Format Description No request bytes 13.6 Response data frame Byte Format Description No response bytes Command #135 – Trim Device Variable Zero This command uses the provided parameter value and the actual measured device variable value and adjusts the internal zero compensation, so that the device variable output value matches the one sent with the command. It is possible to adjust the device variable zero with ±5% of the full range. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Device Variable Unit (CT 2) 2..5 float Externally measured value Response data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) 1 uint-8 Device Variable Unit (CT 2) 2..5 float Actual output Dev. Var. value Command specific response codes for command 135 Code Type Description 3 Error Passed Parameter Too Large 4 Error Passed Parameter Too Small 17 Error Invalid Device Variable Index 18 Error Invalid Units Code 19 Error Device Variable Index Not Allowed For This Command 29 Error Invalid Span CombiLyz AFI4/AFI5 specific: This command is specifically designed for Device Variables 0 and 1. 13.7 Command #136 – Trim Device Variable Gain This command is not implemented for CombiLyz AFI4/AFI5. 13.8 Command #137 – Reset Device Variable Trim This command resets any user trim of the Device Variable to factory settings. Request data frame Byte Format Description 0 uint-8 Device Variable Code (DT 1) Response data frame Byte Format Description Device Variable Code (DT 1) 0 uint-8 Command specific response codes for command 137 Code Type Description 17 Error Invalid Device Variable Index 19 Error Device Variable Index Not Allowed For This Command CombiLyz AFI4/AFI5 specific: This command is specifically designed for Device Variables 0 and 1. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 29 of 36 14 Conductivity Family Device Specific Tables 14.1 Cond. Family Device Spec. Table 1 – Conductivity Device Family Device Variable Status Code 0x01 0x02 0x04 0x08 0x30 0xC0 14.2 Code 0x01 0x02 0x04 0x08 0x10 0x20 0x40 0x80 14.3 Code 0x01 0x02 0x04 0x08 0x10 0x20 0x40 0x80 Description Sensor Diagnostics Failure Sensor Break (AFI4/AFI5specific) Variable Not Generated (AFI4/AFI5 specific) More Device Variable Status Available Limit Status: 11 Constant (i.e. value cannot be changed by the process) 01 Low Limited (eg. A/D Converter has reached its lower limit) 10 High Limited (eg. A/D Converter has reached its upper limit) 00 Not Limited Process Data Quality Status: 11 Good 01 Poor accuracy (eg. value is beyond rated conductivity or hardware zoom, temperature out of range) 10 Manual / Fixed (eg. value is simulated or forced) Conductivity Family Device Specific Table 2 – Conductivity Status 0 Description Conductivity Sensor Break Process Temperature Sensor Break Internal Temperature Sensor Break Calibration Required Conductivity Operating Range Exceeded Process Temperature Operating Range Exceeded Internal Temperature Operating Range Exceeded Reserved Conductivity Family Device Specific Table 3 – Conductivity Family Capabilities 0 Description Command 2307 – Read Conductivity Sensor Information Command 2308 – Read Device Variable Range and Label Capabilities Command 2309 – Read Conductivity Device Variables Command 2435 – Write Conductivity Sensor Information Reserved Reserved Reserved Reserved Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 30 of 36 14.4 Code 0x01 0x02 0x04 0x08 0x10 0x20 0x40 0x80 Conductivity Family Device Specific Table 4 - Conductivity Family Capabilities 1 Description Command 2336/2464 – Read/Write Range Hardware Range Command 2337/2465 – Read/Write Range Output Zoom Command 2338/2466 – Read/Write Range Temperature Compensation Command 2339/2467 – Read/Write Range Conductivity Medium Label Command 2340/2468 – Read/Write Range Concentration Table Points Command 2341/2469 – Read/Write Range Concentration Medium Label Command 2342/2470 – Read/Write Range Forced Status Reserved 15 Device Specific Tables 15.1 Sensor Type Codes Sensor Type codes Code Description 0 Contacting 1 Inductive 2 Electrode 15.2 Unit Codes (subset of HART Common Table 2, Unit Codes) Unit Codes Code Description 32 ⁰C 33 ⁰F 39 mA 57 % 66 mS/cm 67 µS/cm 15.3 Internal Unit Conversion Conductivity Unit Conversion κ[µS/cm] = κ[mS/cm] 1000 κ[mS/cm] = κ[µS/cm] / 1000 Temperature Unit Conversion t[⁰C] = (t[⁰F] - 32) / 1.8 t[⁰F] = t[⁰C] 1.8 + 32 16 Performance 16.1 Sampling Rates Typical sampling rates are shown in the following table. Sensor Sampling rate Conductivity Approx. 3 times per second Temperature Approx. 1 time per second Note: both temperature calculations use an equally-weighted running mean of the last 3 input values. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 31 of 36 16.2 Power-Up On power up, the transmitter runs through a startup initialization procedure, which takes approximately 5 seconds. During this period, the device will notbe able to respond to HART commands, and the analog output is set at 3.5mA. The first stable measurements are ready in less than 15 seconds, allowing valid Device Variable readouts. Fixed-current mode is cancelled upon startup / reset. 16.3 Reset Command 42 - Perform Device Reset causes the device to reset its microprocessor. The resulting restart is identical to the normal power up sequence. 16.4 Self-Test The CombiLyz AFI4/AFI5 does not support command 41 – Self Test. Self-testing is performed periodically during normal operation. 16.5 Command Response Times HART command response time depends on the command number issued and the internal state of the device. If write commands result in writing in non-volatile memory, the response is sent upon completion of the write, causing a small delay of up to 140ms. Generalization Minimum Typical Maximum 16.6 Response times 5ms 15ms 140ms Busy and Delayed-Response Delayed-response is not used. 16.7 Long Messages The largest data field used is in the response to Command 2468, where 39 bytes (not including the two status bytes) are returned. Total length of data field is then 41 bytes. 16.8 Non-Volatile Memory Built-in flash memory of the micro controller is used to hold user configuration. New data is written to this memory immediately on execution of a write command, before the response is sent. If the new data to be written is identical to the data already stored, the write is not performed. 16.9 Modes Fixed current mode is implemented, using Command 40. This mode is cleared at startup or reset. 16.10 Burst Mode This Field Device does not support Burst Mode. 16.11 Write Protection This Field Device does not support Write Protect. 16.12 Catch Device Variable This Field Device does not support Catch Device Variable. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 32 of 36 16.13 Damping Damping is implemented for the PV and the other device variables depending on the PV value. This includes the conductivity/concentration output channel current, and if a concentration value is calculated (which always is done with respect to the PV value). Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 33 of 36 ANNEX A. CAPABILITY CHECKLIST Manufacturer, model and revision Device type HART revision Device Description available Number and type of sensors Number and type of actuators Number and type of host side signals Number of Device Variables Number of Dynamic Variables Mapable Dynamic Variables? Number of common-practice commands Number of device-specific commands Bytes of additional device status Alternative operating modes? Burst mode? Write-protection? Baumer CombiLyz AFI4/AFI5 HART Conductivity Current Output Transmitter 7.4 Yes One internal conductivity sensor One internal temperature sensor None One 4 - 20mA analog output w/ HART One 4 - 20mA analog output 8 4 No 14 7 14 No No No Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 34 of 36 ANNEX B. DEFAULT CONFIGURATION Parameter Poll Address Loop Current Signaling Mode Conductivity / Concentration Mode Conductivity Current at 4 mA Conductivity Current at 20 mA Default value 0 Enabled Conductivity Mode Range 1..4: 0 µS/cm Range 1: 200 mS/cm Range 2: 20 mS/cm Range 3: 2 mS/cm Range 4: 500 µS/cm Temperature Current at 4 mA -20 ⁰C Temperature Current at 20 mA 150 ⁰C Temperature compensation Range 1..4: 2 % / K Error Channel Both Error Current 3.5 mA Damping 0 sec NOTE: By default, all strings are cleared (all space characters) Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 35 of 36 ANNEX C. A1. REVISION HISTORY 2015-09-02 First Revision 1.0 Document created. Baumer Document No. 81178189 01 Document Title: CombiLyz AFI4/AFI5 HART Field Device Specification - Revision 1.0 Release Date: 8th of September, 2015 HART FDS Page 36 of 36