HART® Field Device Specification Part Number: 3-9000-761, rev. 3 Release: 31 January 2014 DanielTM 3410 Series Gas Ultrasonic Meters 3414 Gas Ultrasonic Flow Meter 3412 and 3411 Gas Ultrasonic Flow Meters HART is a registered Trademark of the HART Communication Foundation Daniel customer service Location Telephone number Fax number North America/Latin America +1.713.467.6000 +1.713.827.4805 Daniel Customer Service +1.713.827.6413 +1.713.827.6312 USA (toll free) +1.888.356.9001 +1.713.827.3380 Asia Pacific (Republic of Singapore) +65.6777.8211 +65.6777.0947.0743 Europe (Stirling Scotland, UK) +44 (0)1786.433400 +44 (0)1786.433401 Middle East Africa (Dubai, UAE) +971 4 8118100 +971 4 8865465 E-mail • Customer Service: [email protected] • Customer Support: [email protected] • Asia-Pacific: [email protected] • Europe: [email protected] Return Material Authorization (RMA) A Return Material Authorization (RMA) number must be obtained prior to returning any equipment for any reason. Download the RMA form from the Support Services web page by selecting the link below. www2.emersonprocess.com/EN-US/BRANDS/DANIEL/SUPPORT-SERVICES/Pages/Support-Services.aspx? Signal words and symbols Pay special attention to the following signal words, safety alert symbols and statements: Safety alert symbol This is a safety alert symbol. It is used to alert you to potential physical injury hazards. Obey all safety messages that follow this symbol to avoid possible injury or death. Danger indicates a hazardous situation which, if not avoided, will result in death or serious injury. Warning indicates a hazardous situation which, if not avoided, could result in death or serious injury. Caution indicates a hazardous situation which, if not avoided, could result in minor or moderate injury. Notice is used to address safety messages or practices not related to personal injury. Important Important is a statement the user needs to know and consider. Tip Tip provides information or suggestions for improved efficiency or best results. Note Note is a “general by-the-way” content not essential to the main flow of information. Important safety instructions Daniel Measurement and Control, Inc. (Daniel) designs, manufactures and tests products to function within specific conditions. Because these products are sophisticated technical instruments, it is important that the owner and operation personnel strictly adhere both to the information printed on the product and to all instructions provided in this manual prior to installation, operation, and maintenance. Daniel also urges you to integrate this manual into your training and safety program. BE SURE ALL PERSONNEL READ AND FOLLOW THE INSTRUCTIONS IN THIS MANUAL AND ALL NOTICES AND PRODUCT WARNINGS. Installing, operating or maintaining a Daniel product improperly could lead to serious injury or death from explosion or exposure to dangerous substances. To reduce this risk: • Comply with all information on the product, in this manual, and in any local and national codes that apply to the product. • Do not allow untrained personnel to work with this product. • Use Daniel parts and work procedures specified in this manual. Product owners (Purchasers): • Use the correct product for the environment and pressures present. See technical data or product specifications for limitations. If you are unsure, discuss your needs with your Daniel representative. • Inform and train all personnel in the proper installation, operation, and maintenance of this product. • To ensure safe and proper performance, only informed and trained personnel should install, operate, repair and maintain this product. • Verify that this is the correct instruction manual for your Daniel product. If this is not the correct documentation, contact Daniel at 1-713-827-6314. You may also download the correct manual from: http://www.daniel.com • Save this instruction manual for future reference. • If you resell or transfer this product, it is your responsibility to forward this instruction manual along with the product to the new owner or transferee. • ALWAYS READ AND FOLLOW THE INSTALLATION, OPERATIONS, MAINTENANCE AND TROUBLESHOOTING MANUALS AND ALL PRODUCT WARNINGS AND INSTRUCTIONS. • Do not use this equipment for any purpose other than its intended service. This may result in property damage and/or serious personal injury or death. Product Operation Personnel: • To prevent personal injury, personnel must follow all instructions of this manual prior to and during operation of the product. • Follow all warnings, cautions, and notices marked on, and supplied with, this product. • Verify that this is the correct instruction manual for your Daniel product. If this is not the correct documentation, contact Daniel at 1-713-827-6314. You may also download the correct manual from: http://www.daniel.com • Read and understand all instructions and operating procedures for this product. • If you do not understand an instruction, or do not feel comfortable following the instructions, contact your Daniel representative for clarification or assistance. • Install this product as specified in the INSTALLATION section of this manual per applicable local and national codes. • Follow all instructions during the installation, operation, and maintenance of this product. • Connect the product to the appropriate pressure and electrical sources when and where applicable. • Ensure that all connections to pressure and electrical sources are secure prior to and during equipment operation. • Use only replacement parts specified by Daniel. Unauthorized parts and procedures can affect this product's performance, safety, and invalidate the warranty. “Look-a-like” substitutions may result in deadly fire, explosion, release of toxic substances or improper operation. • Save this instruction manual for future reference. Notice THE CONTENTS OF THIS PUBLICATION ARE PRESENTED FOR INFORMATIONAL PURPOSES ONLY, AND WHILE EVERY EFFORT HAS BEEN MADE TO ENSURE THEIR ACCURACY, THEY ARE NOT TO BE CONSTRUED AS WARRANTIES OR GUARANTEES, EXPRESSED OR IMPLIED, REGARDING THE PRODUCTS OR SERVICES DESCRIBED HEREIN OR THEIR USE OR APPLICABILITY. ALL SALES ARE GOVERNED BY DANIEL'S TERMS AND CONDITIONS, WHICH ARE AVAILABLE UPON REQUEST. WE RESERVE THE RIGHT TO MODIFY OR IMPROVE THE DESIGNS OR SPECIFICATIONS OF SUCH PRODUCTS AT ANY TIME. DANIEL DOES NOT ASSUME RESPONSIBILITY FOR THE SELECTION, USE OR MAINTENANCE OF ANY PRODUCT. RESPONSIBILITY FOR PROPER SELECTION, USE AND MAINTENANCE OF ANY DANIEL PRODUCT REMAINS SOLELY WITH THE PURCHASER AND END-USER. TO THE BEST OF DANIEL'S KNOWLEDGE THE INFORMATION HEREIN IS COMPLETE AND ACCURATE. DANIEL MAKES NO WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE WITH RESPECT TO THIS MANUAL AND, IN NO EVENT, SHALL DANIEL BE LIABLE FOR ANY INCIDENTAL, PUNITIVE, SPECIAL OR CONSEQUENTIAL DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF PRODUCTION, LOSS OF PROFITS, LOSS OF REVENUE OR USE AND COSTS INCURRED INCLUDING WITHOUT LIMITATION FOR CAPITAL, FUEL AND POWER, AND CLAIMS OF THIRD PARTIES. PRODUCT NAMES USED HEREIN ARE FOR MANUFACTURER OR SUPPLIER IDENTIFICATION ONLY AND MAY BE TRADEMARKS/REGISTERED TRADEMARKS OF THESE COMPANIES Warranty and Limitations 1. LIMITED WARRANTY: Subject to the limitations contained in Section 2 herein, Daniel Measurement & Control, Inc. (“Daniel”) warrants that the licensed firmware embodied in the Goods will execute the programming instructions provided by Daniel, and that the Goods manufactured by Daniel will be free from defects in materials or workmanship under normal use and care and Services will be performed by trained personnel using proper equipment and instrumentation for the particular Service provided. The foregoing warranties will apply until the expiration of the applicable warranty period. Goods are warranted for twelve (12) months from the date of initial installation or eighteen (18) months from the date of shipment by Daniel, whichever period expires first. Consumables and Services are warranted for a period of 90 days from the date of shipment or completion of the Services. Products purchased by Daniel from a third party for resale to Buyer ("Resale Products”) shall carry only the warranty extended by the original manufacturer. Buyer agrees that Daniel has no liability for Resale Products beyond making a reasonable commercial effort to arrange for procurement and shipping of the Resale Products. If Buyer discovers any warranty defects and notifies Daniel thereof in writing during the applicable warranty period, Daniel shall, at its option, correct any errors that are found by Daniel in the firmware or Services or repair or replace F.O.B. point of manufacture that portion of the Goods or firmware found by Daniel to be defective, or refund the purchase price of the defective portion of the Goods/Services. All replacements or repairs necessitated by inadequate maintenance, normal wear and usage, unsuitable power sources or environmental conditions, accident, misuse, improper installation, modification, repair, use of unauthorized replacement parts, storage or handling, or any other cause not the fault of Daniel are not covered by this limited warranty, and shall be at Buyer's expense. Daniel shall not be obligated to pay any costs or charges incurred by Buyer or any other party except as may be agreed upon in writing in advance by Daniel. All costs of dismantling, reinstallation and freight and the time and expenses of Daniel's personnel and representatives for site travel and diagnosis under this warranty clause shall be borne by Buyer unless accepted in writing by Daniel. Goods repaired and parts replaced by Daniel during the warranty period shall be in warranty for the remainder of the original warranty period or ninety (90) days, whichever is longer. This limited warranty is the only warranty made by Daniel and can be amended only in a writing signed by Daniel. THE WARRANTIES AND REMEDIES SET FORTH ABOVE ARE EXCLUSIVE. THERE ARE NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO MERCHANTABILITY, FITNESS FOR PARTICULAR PURPOSE OR ANY OTHER MATTER WITH RESPECT TO ANY OF THE GOODS OR SERVICES. Buyer acknowledges and agrees that corrosion or erosion of materials is not covered by this warranty. 2. LIMITATION OF REMEDY AND LIABILITY: DANIEL SHALL NOT BE LIABLE FOR DAMAGES CAUSED BY DELAY IN PERFORMANCE. THE REMEDIES OF BUYER SET FORTH IN THIS AGREEMENT ARE EXCLUSIVE. IN NO EVENT, REGARDLESS OF THE FORM OF THE CLAIM OR CAUSE OF ACTION (WHETHER BASED IN CONTRACT, INFRINGEMENT, NEGLIGENCE, STRICT LIABILITY, OTHER TORT OR OTHERWISE), SHALL DANIEL'S LIABILITY TO BUYER AND/OR ITS CUSTOMERS EXCEED THE PRICE TO BUYER OF THE SPECIFIC GOODS MANUFACTURED OR SERVICES PROVIDED BY DANIEL GIVING RISE TO THE CLAIM OR CAUSE OF ACTION. BUYER AGREES THAT IN NO EVENT SHALL DANIEL'S LIABILITY TO BUYER AND/OR ITS CUSTOMERS EXTEND TO INCLUDE INCIDENTAL, CONSEQUENTIAL OR PUNITIVE DAMAGES. THE TERM “CONSEQUENTIAL DAMAGES” SHALL INCLUDE, BUT NOT BE LIMITED TO, LOSS OF ANTICIPATED PROFITS, REVENUE OR USE AND COSTS INCURRED INCLUDING WITHOUT LIMITATION FOR CAPITAL, FUEL AND POWER, AND CLAIMS OF BUYER'S CUSTOMERS. HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 Table of Contents January 2014 Contents Daniel customer service Signal words and symbols Important safety instructions Notice Warranty and Limitations 1. Introduction 1.1 Scope ............................................................................................................ 1 1.2 Purpose ......................................................................................................... 1 1.3 Who should use this document? ...................................................................... 1 1.4 Definitions, acronyms, abbreviations and references ......................................... 1 1.4.1 Definitions .............................................................................................................. 2 1.4.2 Acronyms................................................................................................................ 2 1.4.3 Abbreviations.......................................................................................................... 2 1.4.4 References .............................................................................................................. 3 2. Device Identification 2.1 Daniel 3410 Series Ultrasonic Flow Meter identification ..................................... 5 2.2 Physical description ........................................................................................ 6 3. Product overview 3.1 Device function, purpose and features ............................................................. 7 3.2 Process connections ....................................................................................... 7 3.3 External interfaces (electrical and non-electrical) .............................................. 7 3.4 Other required equipment ............................................................................... 7 4. Product interfaces 4.1 Process interface ............................................................................................ 9 4.1.1 Sensor input channels ............................................................................................. 9 4.1.2 Sensor analog output channels ............................................................................. 10 4.1.3 Time Stamp........................................................................................................... 12 4.1.4 Configuration change counter .............................................................................. 13 Table of Contents i Table of Contents HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 5. 3-9000-761 Rev 3 Device variables 5.1 Device variable 0 - uncorrected flow rate ........................................................ 15 5.2 Device variable 1 - corrected flow rate ............................................................ 15 5.3 Device variable 2 - average flow velocity ......................................................... 16 5.3.1 Wet calibration ......................................................................................................16 5.3.2 Piece-wise linearization .........................................................................................16 5.3.3 Third-order polynomial..........................................................................................16 5.3.4 No wet calibration .................................................................................................16 5.4 Device variable 3 - average sound velocity ...................................................... 17 5.5 Device variable 4 - energy rate ....................................................................... 17 5.6 Device variable 5 - mass rate .......................................................................... 18 5.7 Device variable 6 - pressure ........................................................................... 18 5.8 Device variable 7 - temperature ..................................................................... 19 6. Dynamic variables 6.1 Fixed dynamic variables ................................................................................. 21 6.2 Dynamic variables with configurable mapping ................................................. 21 7. Status information 7.1 Device status ................................................................................................ 24 7.2 Additional device status (Command 48) .......................................................... 26 8. Universal commands 8.1 Slave universal commands ............................................................................. 31 9. Common-practice commands 9.1 Supported commands ................................................................................... 33 9.2 Burst mode .................................................................................................. 34 9.3 Catch device variable .................................................................................... 34 10. Device-specific commands 10.1 Public, device-specific commands ................................................................ 35 10.1.1 Command 128 Write analog output configuration ..............................................36 10.1.2 Command 129 Read analog output configuration ...............................................38 10.1.3 Command 130 Write Frequency/Digital Output configuration ............................39 10.1.4 Command 131 Read Frequency/Digital Output configuration .............................42 10.1.5 Command 132 Write flow pressure configuration ...............................................43 10.1.6 Command 133 Read flow pressure configuration ................................................45 10.1.7 Command 134 Write flow temperature configuration.........................................46 10.1.8 Command 135 Read flow temperature configuration..........................................48 ii Table of Contents HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 Table of Contents January 2014 10.1.9 Command 136 Write device units ....................................................................... 48 10.1.10 Command 137 Read device units ...................................................................... 50 10.1.11 Command 138 Write device variable range....................................................... 50 10.1.12 Command 139 Read device variable range........................................................ 52 10.1.13 Command 140 Read detailed status.................................................................. 53 10.1.14 Command 141 Acknowledge alarm .................................................................. 56 10.1.15 Command 142 Write digital input configuration ............................................... 58 10.1.16 Command 143 Read digital input configuration................................................ 59 10.1.17 Command 146 Read Miscellaneous Non-Write Protected Parameters............... 59 10.1.18 Command 147 Read miscellaneous write protected parameters....................... 60 10.1.19 Command 148 Write blockage configuration.................................................... 61 10.1.20 Command 149 Read blockage configuration .................................................... 62 10.1.21 Command 150 Write liquid detection configuration ......................................... 62 10.1.22 Command 151 Read liquid detection configuration .......................................... 63 10.1.23 Command 152 Read continuous flow analysis active features ........................... 64 10.1.24 Command 153 Read running averages.............................................................. 65 10.1.25 Command 154 Read baselines .......................................................................... 66 10.1.26 Command 155 Write baselines ......................................................................... 67 10.1.27 Command 156 Read keys.................................................................................. 69 10.1.28 Command 157 Write keys................................................................................. 69 10.1.29 Command 158 Read key validities..................................................................... 70 10.1.30 Command 159 Read meter chord data.............................................................. 70 10.1.31 Command 160 Read meter flow data ................................................................ 71 10.1.32 Command 161 Read path signal amplitude data ............................................... 73 10.1.33 Command 162 Read noise amplitudes .............................................................. 74 10.1.34 Command 163 Read path SNR data................................................................... 75 10.1.35 Command 164 Read path percent good............................................................ 76 10.1.36 Command 165 Read path gains ........................................................................ 77 10.1.37 Command 166 Read flow analysis configuration ............................................... 78 10.1.38 Command 167 Write flow analysis configuration .............................................. 79 10.1.39 Command 168 Read general meter information ............................................... 80 10.1.40 Command 169 Read flow totals ........................................................................ 81 10.1.41 Command 170 Read flow analysis related configuration ................................... 82 10.1.42 Command 171 Write flow analysis related configuration .................................. 83 10.1.43 Command 172 Write Ethernet configuration .................................................... 84 10.1.44 Command 173 Read Ethernet Configuration..................................................... 86 10.1.45 Command 174 Write serial port configuration .................................................. 87 10.1.46 Command 175 Read serial port configuration ................................................... 89 10.1.47 Command 176 Write transducer chord configuration ....................................... 90 10.1.48 Command 177 Read transducer chord configuration ........................................ 91 10.1.49 Command 178 Write polynomial calibration configuration ............................... 92 10.1.50 Command 179 Read polynomial calibration configuration................................ 93 10.1.51 Command 182 Write archive log configuration................................................. 94 Table of Contents iii Table of Contents January 2014 HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 10.1.52 Command 183 Read Archive Log configuration .................................................95 10.1.53 Command 184 Write acquisition configuration .................................................96 10.1.54 Command 185 Read acquisition configuration ..................................................98 10.1.55 Command 186 Write meter limits .....................................................................99 10.1.56 Command 187 Read meter limits ....................................................................101 10.1.57 Command 188 Write meter body configuration ..............................................102 10.1.58 Command 189 Read meter body configuration...............................................104 10.1.59 Command 190 Write signal parameters ..........................................................105 10.1.60 Command 191Read signal parameters ............................................................107 10.1.61 Command 192 Write target parameters..........................................................108 10.1.62 Command 193 Read target parameters...........................................................110 10.1.63 Command 194 Reset chord proportions to defaults ........................................111 10.1.64 Command 195 Enter/exit fixed frequency output mode ..................................112 10.1.65 Command 196 Enter/exit fixed digital output mode........................................113 10.1.66 Command 197 Set transducer type .................................................................114 10.1.67 Command 198 Write Frequency/Digital Output sources .................................115 10.1.68 Command 199 Read Frequency/Digital Output sources ..................................116 10.1.69 Command 200 Write miscellaneous write protected parameters ....................117 10.1.70 Command 201 Write analog input calibration .................................................118 10.1.71 Command 202 Read analog input calibration ..................................................119 10.1.72 Command 203 Write piecewise linearization flow rates...................................120 10.1.73 Command 204 Read piecewise linearization flow rates....................................122 10.1.74 Command 205 Write piecewise linearization meter factors .............................123 10.1.75 Command 206 Read piecewise linearization meter factors..............................124 10.1.76 Command 207 Write meter text......................................................................125 10.1.77 Command 208 Read meter text.......................................................................126 10.1.78 Command 209 Write gas chromatograph configuration .................................127 10.1.79 Command 210 Read gas chromatograph configuration ..................................129 10.1.80 Command 211 Write AGA8 method configuration ..........................................130 10.1.81 Command 212 Read AGA8 method configuration...........................................132 10.1.82 Command 213 Write detailed gas composition...............................................133 10.1.83 Command 214 Read detailed gas composition................................................135 10.1.84 Command 215 Write Gross Method 1 and 2 gas composition configuration....136 10.1.85 Command 216 Read Gross Method 1 and 2 gas composition configuration ....137 10.1.86 Command 217 Write baseline times and comments .......................................137 10.1.87 Command 218 Read baseline times and comments ........................................139 10.1.88 Command 219 Reset tracking targets to defaults ............................................140 10.1.89 Command 220 Write local display configuration .............................................141 10.1.90 Command 221 Read local display configuration ..............................................144 10.1.91 Command 222 Enable local display test mode.................................................145 10.1.92 Command 223 Write general meter information.............................................146 10.1.93 Command 224 Write miscellaneous non-write protected parameters.............147 10.2 Device-specific command error (response code 6) ....................................... 148 iv Table of Contents HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 11. Table of Contents January 2014 Tables 11.1 Volume units ........................................................................................... 151 11.2 Energy units ............................................................................................. 151 11.3 Mass units ................................................................................................ 151 11.4 Time units (flow rate) ................................................................................ 151 11.6 Pressure units ........................................................................................... 152 11.7 Temperature unit ...................................................................................... 152 11.8 Velocity units ........................................................................................... 152 11.9 M ass flow rate units .................................................................................. 153 11.10 Energy flow rate units .............................................................................. 153 11.11 Decibel units ........................................................................................... 153 11.12 Voltage units .......................................................................................... 153 11.13 Current units .......................................................................................... 153 11.14 Percent units .......................................................................................... 154 11.15 Length units ........................................................................................... 154 11.16 Thermal expansion units .......................................................................... 154 11.17 Viscosity units ........................................................................................ 155 11.18 Volumetric heating value units ................................................................. 155 11.19 Density units .......................................................................................... 155 11.20 Unit conversion factors ............................................................................ 156 11.21 Pressure and temperature tables .............................................................. 157 11.21.1 Live Pressure ................................................................................................... 158 11.21.2 Live Temperature ........................................................................................... 159 12. Performance 12.1 Sampling rates .......................................................................................... 161 12.2 Power-up .................................................................................................. 161 12.3 Device reset ............................................................................................. 161 12.4 Command response delay .......................................................................... 162 12.4.1 Long messages.................................................................................................. 162 12.4.2 Non-volatile memory ........................................................................................ 162 12.4.3 Operating modes .............................................................................................. 162 12.4.4 Write protection ............................................................................................... 162 12.4.5 Damping value.................................................................................................. 163 Table of Contents v Table of Contents HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 Annex A. 3-9000-761 Rev 3 Device capability checklist A.1 Device capability ............................................................................. 165 Annex B. Default device configuration B.1 Default factory settings...................................................................................... 167 Annex C. Device variable calculations C.1 Uncorrected flow rate ........................................................................................ 169 C.2 Corrected flow rate ............................................................................................ 170 C.3 Average flow velocity ......................................................................................... 171 C.3.1 Dry-calibration ..................................................................................... 171 C.3.2 Wet-calibration ....................................................................................171 C.3.3 Piece-wise linearization ........................................................................ 172 C.3.4 Third-order polynomial......................................................................... 172 C.3.5 No wet calibration ................................................................................ 172 C.4 Average sound velocity ...................................................................................... 173 C.4.1 Optional AGA10 sound velocity calculation and comparison ................ 173 C.5 Mass rate ........................................................................................................... 174 C.6 Energy rate ........................................................................................................ 174 C.7 Pressure ............................................................................................................. 175 C.8 Temperature...................................................................................................... 175 Annex D. Supported field device operations D.1 AMS Device Manager ......................................................................................... 177 D.2 375/475 field communicator menu tree ............................................................ 178 Annex E. Revision history E.1 Document release .............................................................................................. 179 E.2 Changes Revision 2............................................................................................. 179 E.3 Changes Revision 3............................................................................................. 181 vi Table of Contents HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 List of Figures January 2014 List of Figures Figure 2-1 3410 Series Gas Ultrasonic Flow Meter electronics - CPU Module ................................. 6 Figure D-1 AMS Device Manager Menu Tree .............................................................................. 177 List of Figures vii List of Figures January 2014 viii HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 List of Figures HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 List of Tables January 2014 List of Tables Table 1-1 Definitions.......................................................................................................................... 2 Table 1-2 Acronyms........................................................................................................................... 2 Table 1-3 Abbreviations ..................................................................................................................... 2 Table 1-4 Reference documentation.................................................................................................. 3 Table 2-1 3410 Series Gas Ultrasonic Flow Meter device identification............................................... 5 Table 4-1 Analog output configuration parameters ......................................................................... 11 Table 4-2 Device variables time stamp............................................................................................. 12 Table 4-3 Time stamp calculations for additional device variables.................................................... 13 Table 4-4 Configuration change counter.......................................................................................... 13 Table 5-1 Device variable 2 - average flow velocity........................................................................... 16 Table 5-2 Device variable 3 - average sound velocity........................................................................ 17 Table 5-3 Device variable 4 - energy rate.......................................................................................... 17 Table 5-4 Device variable 5 - mass rate ............................................................................................ 18 Table 5-5 Device variable 6 - pressure .............................................................................................. 18 Table 5-6 Device variable 7 - temperature........................................................................................ 19 Table 6-1 Dynamic variables configurable mapping......................................................................... 21 Table 7-1 Device status byte database point mapping ..................................................................... 24 Table 7-2 Additional device status (Command 48)........................................................................... 26 Table 8-1 Universal commands for slave implementation ................................................................ 31 Table 9-1 Common-practice commands.......................................................................................... 33 Table 11-1 Volume units.................................................................................................................. 151 Table 11-2 Energy rate..................................................................................................................... 151 Table 11-3 Mass units ...................................................................................................................... 151 Table 11-4 Time units (flow rate) ..................................................................................................... 151 Table 11-5 Volumetric flow rate units .............................................................................................. 152 Table 11-6 Pressure units................................................................................................................. 152 Table 11-7 Temperature units.......................................................................................................... 152 Table 11-8 Velocity units ................................................................................................................. 152 Table 11-9 Mass flow rate units........................................................................................................ 153 Table 11-10 Mass low rate units ......................................................................................................... 153 Table 11-11 Decibel units .................................................................................................................. 153 Table 11-12 Voltage units.................................................................................................................. 153 Table 11-13 Current units .................................................................................................................. 153 List of Tables ix List of Tables January 2014 x HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 Table 11-14 Percent units ..................................................................................................................154 Table 11-15 Length units.................................................................................................................... 154 Table 11-16 Thermal Expansion units ................................................................................................. 154 Table 11-17 Viscosity units................................................................................................................. 155 Table 11-18 Volumetric heating value units ....................................................................................... 155 Table 11-19 Density units................................................................................................................... 155 Table 11-20 Conversion factors per unit of measurement .................................................................. 156 Table 11-21 Pressure and temperature tables ....................................................................................157 Table 11-22 Data points for pressure inputs ....................................................................................... 158 Table 11-23 Data points for temperature inputs ................................................................................ 159 Table 12-1 Sampling Rates............................................................................................................... 161 Table 12-2 Command 42 device reset .............................................................................................. 161 Table 12-3 Command response delay .............................................................................................. 162 Table A-1 Capability checklist ......................................................................................................... 165 Table B-1 Device factory settings configuration ............................................................................. 167 List of Tables HART Field Device Specification 3410 Series Ultrasonic Meter 1. Introduction 3-9000-761 Rev 3 January 2014 1. Introduction 1.1 Scope 11 The scope of this document is to define the HART revision 7 functional requirements, device specific commands and all Universal and the supported Common Practice commands supported by the HART interface for the Daniel 3410 Series Gas Ultrasonic Flow Meters. 1.2 Purpose The purpose of this document is to list the functional requirements for developing the 3410 Series Gas Ultrasonic Flow Meters HART rev 7 firmware. This document complies with HART Protocol Revision 7 and Field Device Specification HCF_LIT-18, Revision 11.0 in preparation and development of engineering regression tests of functionality not covered by the HCF-Kit-192. 1.3 Who should use this document? This 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. 1.4 Definitions, acronyms, abbreviations and references The following is a list of commonly used definitions used throughout this document. Scope 1 1. Introduction HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 1.4.1 Definitions Table 1-1 Definitions 1.4.2 Name Definition Emerson Field Communicator 375 or 475 field communicator - handheld device Acronyms Table 1-2 Acronyms 1.4.3 Acronym Definition ADC Analog to Digital Converter API Application Program Interface ATEX Atmospheres Explosives (French) CPU Central Processing Unit D/A Digital-to-Analog DAC Digital to Analog Converter DD Device Description (HART) EDDL Electronic Device Description Language (HART) FPGA Field-Programmable Gate Array HART Highway Addressable Remote Transducer I/O Input(s)/Output(s) LED Light-Emitting Diode Abbreviations Table 1-3 Abbreviations 2 Abbreviation Definition oC Degrees Celsius (alternatively, degrees Centigrade) A/D Analog-to-Digital D/A Digital-to-Analog Enum Enumerated Hz Hertz mA Milliamperes (also referred to as milliamps) RX Receive TX Transmit Definitions HART Field Device Specification 3410 Series Ultrasonic Meter 1. Introduction 3-9000-761 Rev 3 January 2014 1.4.4 References The documents referenced within the text of this document are listed in the table below: Table 1-4 Reference documentation Title Document number, revision, date American Petroleum Institute (API) Manual of Petroleum Measurement Standards (MPMS) Chapter 21 - Flow Measurement Using Electronic Metering Systems Section 1 - Electronic Gas Measurement First Edition, 01-Sep-1993 HART SMART Communications Protocol Specification (also includes HCF_SPEC 13, Rev. 7.5 (29 May, 2013) the specifications listed below) FSK Physical Layer Specification HCF_SPEC - 54, Rev. 8.1 (24 August, 1999) Data Link Layer Specification HCF_SPEC - 81, Rev. 9.0 (12 May 2012) Command Summary Specification HCF_SPEC - 99, Rev. 9.0 (23 July, 2007) Universal Command Specification HCF_SPEC - 127, Rev. 7.1 (10 May, 2008) Common Practice Command Specification HCF_SPEC-151, Rev. 10.0 (22 June 2012) Common Tables HCF_SPEC - 183, Rev. 23.0 (29 May, 2013) Command Specific Response Code Definitions HCF_SPEC - 307, Rev. 6.0 (5 September, 2007) References 3 1. Introduction January 2014 4 HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 References HART Field Device Specification 3410 Series Ultrasonic Meter 2. Device Identification 3-9000-761 Rev 3 2. 2 January 2014 Device Identification This section details the Daniel 3410 Series Ultrasonic Flow Meter identification and physical description. 2.1 Daniel 3410 Series Ultrasonic Flow Meter identification The Daniel 3410 Series Ultrasonic Flow Meter Field Device Identification summary is shown in Table 2-1 below. Table 2-1 3410 Series Gas Ultrasonic Flow Meter device identification Manufacturer name: Daniel Measurement and Control, Inc. Model name(s): Daniel 3410 Series Ultrasonic Flow Meter Manufacturer ID Code: 13 (D Hex) Device Type Code: 21 (15 Hex) HART Protocol Revision: 7 Device Revision: 3 Number of Device Variables: 8 Physical Layers Supported: Bell 202 FSK Note: HART Hardware Revision: 1 Physical Device Category: Daniel 3410 Series Ultrasonic Flow Meter HART Software Revision: 15 Daniel 3410 Series Ultrasonic Flow Meter identification 5 2. Device Identification HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 2.2 3-9000-761 Rev 3 Physical description The Daniel 3410 Series Ultrasonic Flow Meter electronics enables the meter to easily communicate with other field devices, and ultimately, communicate key diagnostic information through PlantWebTM architecture. Any programmable device, such as the FPGA, is programmed via the CPU Module. The CPU Module part number is P/N 1-360-03-001). Figure 2-1 3410 Series Gas Ultrasonic Flow Meter electronics - CPU Module 6 Physical description HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 3. 3 3. Product overview January 2014 Product overview This section specifies the purpose and application of the Daniel 3410 Series Ultrasonic Flow Meter for HART communication. 3.1 Device function, purpose and features The Daniel 3410 Series Ultrasonic Flow Meter communicates with other field devices, and ultimately, communicates key diagnostic information through the PlantWeb® architecture. All analog inputs and outputs are isolated from each other and isolated from the system with a minimum isolation of 500 V. 3.2 Process connections The Daniel 3410 Series Ultrasonic Flow Meter’s updated electronics includes the firmware, CPU Module and the Acquisition module allows communications with other field devices. 3.3 External interfaces (electrical and non-electrical) Any pressure and/or temperature input read via the Daniel 3410 Series Ultrasonic Flow Meter is configurable using a hand-held communicator (e.g., Emerson's 375/475 Field Communicator) and not via the meter such as for device address, device tag, limits, and units. The Daniel 3410 Series Ultrasonic Flow Meter is compliant with Asset Management Solutions, AMSTM Device Manager, software applications that provides operator interface between the HART enabled field device and a remote PC. 3.4 Other required equipment A RS-232C/RS-485 (half duplex) serial communication port for Modbus communication is provided as Port A. Any programmable device aboard the Daniel 3410 Series Ultrasonic Flow Meter (such as an FPGA) is programmed via the CPU Module. Device function, purpose and features 7 3. Product overview January 2014 8 HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 Other required equipment HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 4. 4. Product interfaces January 2014 Product interfaces This section discusses the Daniel 3410 Series Ultrasonic Flow Meter for HART communications, electrical interface, and input and output requirements. 4.1 Process interface The Daniel 3410 Series Ultrasonic Flow Meter is capable of communicating with a flow computer or other interface devices (e.g. (AMSTM Device Manager or an Emerson Field Communicator, etc.) via HART and enables PlantWeb connectivity. The Daniel 3410 Series Ultrasonic Flow Meter provides an RS-232C/RS-485 half-duplex serial communications port (Port A) connected via the CPU Module. Two independent analog input circuits and 16-bit, 4-20mA analog output circuits are supported. LED status indicators show 24V power, 24V current limit, TX and RX serial communication ports, and HART slave communication via Analog Output 1. 4.1.1 Sensor input channels Daniel 3410 Series Ultrasonic Flow Meters supports analog and discrete inputs as shown below. Name Functional description Analog Input 1 4 mA- 20 mA Input for temperature device Analog Input 2 4 mA- 20 mA Input for pressure device Note: AI-1 and AI-2 are electronically isolated and operate in sink mode. The input contains a series resistance so HART Communicators can be connected to configure sensors. A 24 Volt DC power supply is available to provide power to the sensors. Digital Input(s) (Selectable) Ethernet Port (1) Single polarity (for flow calibration gating - contact closure) • Single input for starting and stopping • Four pulse configurations available One Ethernet Port (TCP/IP) Up to 100 Mbps Modbus TCP • • Process interface 9 4. Product interfaces HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Name Frequency/Digital Output(s) Functional description Maximum frequency for the frequency outputs 1000Hz 5000Hz Mode options: • Open Collector (requires external excitation supply voltage and pull-up resistor) TTL (internally powered by the meter 0-5 VDC signal) • • Serial Port One serial RS-232/RS-485 port (115 kbps baud rate) (Modbus RTU/ASCII) Transducers • • • • • T-11 T-12 T-21 T-22 T-32 Note: The process temperature must not exceed the operating temperature range of the transducers. 4.1.2 Sensor analog output channels The firmware supports two independently-configurable analog output channels (AO1 and AO2). For conventional operation, the analog output channels provide identical but separate configuration parameters including, but not limited to, the currently available AO1 configuration parameters (for content and scaling configuration). These configuration parameters follow the same naming convention as the AO1related configuration parameters (which retain their current names). The Boolean data point, IsAO1Avail indicates the presence of Analog Output 1 (AO1). NOTE: HART communication is available over AO1 only. 10 Sensor analog output channels HART Field Device Specification 3410 Series Ultrasonic Meter 4. Product interfaces 3-9000-761 Rev 3 January 2014 Table 4-1 Analog output configuration parameters Values (percent of range) Values (e.g., in mA) Down greater than -3.125% 3.5 mA Up less than +106.25% 21 mA Maximum current +106.25% 21 mA Multi-drop current draw 4 mA (Available in sink mode only) Lift-off voltage 7V Direction Linear over-range @ full scale Choose the HART selectable output Primary or Secondary Variable (via any serial, Ethernet, or HART slave port) from among the following choices: • uncorrected volumetric flow rate • corrected volumetric flow rate • average flow velocity • average sound velocity • mass rate • energy rate The Daniel 3410 Series Ultrasonic Flow Meter output Third and Fourth Variables (via any serial, Ethernet, or HART slave port) from among the choices available for the Primary Variable and additionally the following choices (if applicable): • live pressure value • live temperature value Configuration via the HART slave port, requires device-specific commands. • for each frequency output: maximum frequency, content, relationship to flow direction, B channel action upon error, A and B channel phase relationship, and output scaling • for each digital output: content, and polarity • for each analog output (conventional 4-20 mA operation): content, relationship to flow direction, and output scaling Trim the analog outputs via HART, serial or Ethernet interfaces. • The HART slave output supports configurable preamble length. • The HART slave supports the HART rev. 7 commands listed in Section 8 through Section 12. • The HART slave does not support transfer functions. Sensor analog output channels 11 4. Product interfaces HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Each analog output has individually configurable alarm selections. The selections include: • Very Low (3.5 mA) • Low (4.0 mA), High (20 mA) • Very High (20.5 mA) • Hold Last Value • None Trim the analog outputs via, serial or Ethernet interfaces. The AOXActionUponInvalidContent data point specifies the action for Analog Output 1 current when the content is invalid. No special action is taken when set to none. Each analog output is considered saturated if the "pre-trimmed" value is (strictly) outside the range (3.5, 20.5) mA. Note that a value less than 4 mA should only occur if the output is invalid and the invalid content is selected to be represented by a fixed 3.5 mA output. The database point AOXIsSaturated shall be used to indicate the saturation status. For each analog output, after the saturation determination is made, then the DAC -limits of (3.5, 21) mA is applied to the pre-trimmed value. The resulting value is written to the appropriate AOXOutput database point (so that the point's meaning is consistent with the pre-HART firmware). The analog output trim zero and gain values (stored in database points AOXCurrentTrimZero and AOXCurrentTrimGain, respectively) are always applied to the analog output's pre-trimmed, DAC -limited value (i.e., the value stored in the database point AOXOutput) as shown in Equation 1 (all values in milliamps except the dimensionless gain). The DAC - limits (3.5, 21 mA) is applied to the resultant trim value (AOXTRIM) and DAC -limited result shall be stored in the database point AOXOutputTrimmed and output to the DAC. Equation 4-1 AO(X)Output Trim AOXTRIM = ( AOXCurrentTrimGain × ( AOXOutput – 4 ) ) + 4 + AOXCurrentTrimZero 4.1.3 Time Stamp A time stamp shall be calculated for each of the HART device variables when the device variable is updated and the status is good. The time stamps shall be associated with the corresponding data points shown inTable 4-2. Table 4-2 Device variables time stamp Device variable Associated time stamp data point name Uncorrected flow rate (QFlow) HARTQFlowUpdateTime Corrected flow rate (QBase) HARTQBaseUpdateTime Average flow velocity HARTAvgFlowUpdateTime Average sound velocity HARTAvgSndVelUpdateTime Energy rate HARTEnergyRateUpdateTime Mass rate HARTMassRateUpdateTime Pressure (FlowPressure) HARTPressureUpdateTime Temperature (FlowTemperature) HARTTemperatureUpdateTime 12 Time Stamp HART Field Device Specification 3410 Series Ultrasonic Meter 4. Product interfaces 3-9000-761 Rev 3 January 2014 Time stamps shall be calculated for additional device variables that indicate percent of range and loop current. Table 4-3 Time stamp calculations for additional device variables Device variable Associated time stamp data point name Percent range HARTPercentRangeUpdateTime Analog output 1 HARTAO1OutputUpdateTime Time stamps shall: Time Stamp • be unsigned 32 bit integer with least significant bit of time value representing 1/32 of milliseconds. • indicate time since midnight and shall rollover after 24 hours • have units of milliseconds 13 4. Product interfaces January 2014 14 HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 Time Stamp HART Field Device Specification 3410 Series Ultrasonic Meter 5. Device variables 3-9000-761 Rev 3 5. 5 January 2014 Device variables The Daniel 3410 Series Ultrasonic Flow Meter does not use Device Family commands. 5.1 Device variable 0 - uncorrected flow rate The flow-condition volumetric flow rate is the result of applying expansion correction and flowprofile correction to the raw volumetric flow rate derived as shown in Equation C -1 subject to the low-flow cut-off (see Annex C). If the resulting value is below the low-flow cut-off value, it is set to zero. The low-flow cut-off volumetric flow rate (QCutOff) is the specified low-flow velocity threshold (ZeroCut) converted to a volumetric flow rate. Device variable Number: 0 Name Classification: 66 Volumetric Flow Unit Codes 5.2 Uncorrected Flow Rate (see Table 11-5) Device variable 1 - corrected flow rate The base-condition volumetric flow rate (QBase) is the result converting the flow-condition volumetric flow rate to the base pressure-temperature condition. This conversion requires (1) AGA8 calculations to be either performed internally (i.e., by the meter) or externally (with the resulting compressibilities specified to the meter via the SpecZFlow and SpecZBase data points), and (2) the flow-condition temperature and pressure to be live or fixed. If AGA8 calculations are not performed (i.e., neither internally nor externally) or the flow-condition temperature and/or pressure are/is not enabled, then the base-condition volumetric flow rate is set to zero. The base-condition volumetric flow rate is calculated as shown in Equation C -2 (see Annex C). Device Variable Number: 1 Name Corrected Flow Rate Classification: 66 Volumetric Flow Unit Codes (Table 11-5) Device variable 0 - uncorrected flow rate 15 5. Device variables HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 5.3 3-9000-761 Rev 3 Device variable 2 - average flow velocity The meter uses two calibration steps: “dry” calibration and “wet” calibration. The dry-calibration gas flow velocity is the result of applying a third-order polynomial equation to the average weighted gas flow velocity as shown in Equation C -3 (see Annex C). Note that the meter provides two sets of dry calibration coefficients - one set for each flow direction. Table 5-1 Device variable 2 - average flow velocity Device variable Number: 2 Name Classification: 67 Velocity Unit Codes 5.3.1 Average Flow Velocity (Table 11-8) Wet calibration The Daniel Ultrasonic meter offers three selections for wet calibration: 12-point piece-wise linearization, a third-order polynomial, or none. The wet calibration method to use is selected via the CalMethod data point with “None” being the default value. The wet calibration gas flow velocity is calculated from the dry calibration gas flow velocity as shown in Equation C -4 (see Annex C). 5.3.2 Piece-wise linearization If the 12-point piece-wise linearization (PWL) wet calibration method is selected, then the drycalibration gas flow velocity is calculated as shown in Equation C -5 (see Annex C). The inputs to the 12-point piece-wise linearization are the (up to) 12 pairs of volumetric flow rate and meter factor for each flow direction ([FwdFlwRt1, FwdMtrFctr1], ..., [FwdFlwRt12, FwdMtrFctr12] for forward flow; [RevFlwRt1, RevMtrFctr1], ..., [RevFlwRt12, RevMtrFctr12] for reverse flow). The linear meter factor is determined by the PWL inputs, the flow direction, and the drycalibration gas flow velocity. 5.3.3 Third-order polynomial If the third-order polynomial wet calibration method is selected, then the wet-calibration gas flow velocity is calculated as shown in Equation C -3 (see Annex C). Note that the meter provides two sets of wet calibration polynomial coefficients - one set for each flow direction. 5.3.4 No wet calibration If no wet calibration is selected, then the wet calibration gas flow velocity is equal to the dry calibration gas flow velocity (see Annex C). 16 Device variable 2 - average flow velocity HART Field Device Specification 3410 Series Ultrasonic Meter 5. Device variables 3-9000-761 Rev 3 5.4 January 2014 Device variable 3 - average sound velocity The average (weighted) sound velocity is calculated as the weighted average of the active chord sound velocity measurements as shown in Equation C -7 (see Annex C). Table 5-2 Device variable 3 - average sound velocity Device variable 3 Number: 67 Velocity Classification: 5.5 Average Sound Velocity Name (Table 11-8) Unit Codes Device variable 4 - energy rate When the frequency output pair represents the energy rate (selected via the FreqXContent data point), then the full-scale energy rate is specified via the AO1FullScaleEnergyRate data point (if primary variable) or AO2FullScaleEnergyRate (if secondary variable). This is the energy rate that corresponds to the selected maximum frequency and determines the frequency output pair’s “energy K-Factor” value (readable via the FreqXEnergyKFactor data point). The minimum frequency output (0 Hz) corresponds to zero energy rate. When the analog output represents the energy rate selected via the AO1Content data point (if primary variable) or AO2Content data point (if secondary variable), then the full-scale energy rate is specified via the AO1FullScaleEnergyRate data point or AO2FullScaleEnergyRate data point (if secondary variable). This is the energy rate that corresponds to the maximum output (20 mA). The minimum output (4 mA) corresponds to zero energy rate. The analog output is forced to 3.5 mA when the energy rate is invalid. Table 5-3 Device variable 4 - energy rate Device variable Number: 4 Name Classification: 79 Power Unit Codes Device variable 3 - average sound velocity Energy Rate (Table 11-2) 17 5. Device variables HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 5.6 3-9000-761 Rev 3 Device variable 5 - mass rate The meter calculates the mass rate and mass totals (forward and reverse). These calculations requires that the flow-condition pressure and temperature are available (either fixed or optional analog inputs, the gas composition is available (either fixed or optionally read from a GC), and the AGA8 calculations are performed (internally by the meter or externally with the results written to the meter). The mass rate is calculated as shown in Equation C -8 (see Annex C). The sign of the mass rate indicates the flow direction: a positive value indicates flow in the forward direction, a negative value indicates flow in the reverse direction. When the analog output represents the mass rate (selected via the AO1Content data point), then the full-scale mass rate is specified via the AO1FullScaleMassRate data point or AO2FullScaleMassRate data point (if secondary variable). This is the mass rate that corresponds to the maximum output (20 mA). The minimum output (4 mA) corresponds to zero energy rate. The analog output is forced to 3.5 mA when the energy rate is invalid. Table 5-4 Device variable 5 - mass rate Device variable Number: 5 Name Classification: 72 Mass Flow Unit Codes 5.7 Mass Rate (Table 11-3) Device variable 6 - pressure The Daniel Liquid Ultrasonic Flow Meter samples the input analog signal(s) and updates the corresponding data point (LiveFlowPressure) once per second regardless of the input selection (disabled, live, or fixed). Every five seconds, the meter updates the “in-use” flow-condition pressure and temperature values (FlowPressure and AbsFlowPressure) depending upon the input selection, validity of the input data, and the selected data source upon alarm in Equation C -10 (see Annex C). The flow-condition pressure is configurable (via the EnablePressureInput data point) to be: • disabled (0) • live (1) (4-20 mA input signal) or • fixed (2) Table 5-5 Device variable 6 - pressure Device variable Number: 6 Name Classification: 65 Pressure Unit Codes Pressure (Table 11-6) If an input is live, then the values corresponding to the minimum and maximum input (4 and 20 mA, respectively) are specified via data points MinInputPressure and MaxInputPressure. To configure the live pressure, plus associated alarms, configure the data points in Section 11.21. 18 Device variable 5 - mass rate HART Field Device Specification 3410 Series Ultrasonic Meter 5. Device variables 3-9000-761 Rev 3 5.8 January 2014 Device variable 7 - temperature The Daniel Liquid Ultrasonic Flow Meter samples the input analog signal(s) and updates the corresponding data point (LiveFlowTemperature) once per second regardless of the input selection (disabled, live, or fixed). Every five seconds, the meter updates the “in-use” flow-condition pressure and temperature values (FlowTemperature) depending upon the input selection, validity of the input data, and the selected data source upon alarm according to Section 11.21. The flow-condition temperature is configurable (via the EnableTemperatureInput data point) to be: • disabled (0) • live (1) (4-20 mA input signal, requires a CPU Module) • fixed (2) Table 5-6 Device variable 7 - temperature Device variable Number: 7 Name Temperature Classification: 64 Unit Codes (Table 11-7) If an input is live, then the values corresponding to the minimum and maximum input (4 and 20 mA, respectively) are specified via data points MinInputTemperature and MaxInputTemperature. To configure the live temperature, plus associated alarms, configure the data points in Section 11.21. Device variable 7 - temperature 19 5. Device variables January 2014 20 HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 Device variable 7 - temperature HART Field Device Specification 3410 Series Ultrasonic Meter 6. Dynamic variables 3-9000-761 Rev 3 6. January 2014 Dynamic variables This section documents the HART primary, secondary, tertiary, and quaternary variables. 6.1 Fixed dynamic variables There are no fixed Dynamic Variables for this device. 6.2 Dynamic variables with configurable mapping The Daniel 3410 Series Ultrasonic Flow Meter allows the following user-configurable dynamic variables mapped to the device variables: Table 6-1 Dynamic variables configurable mapping Dynamic variable Device variable number Name PV (Primary variable) 0-5 • • • • • • 0 - Uncorrected flow rate 1 - Corrected Flow Rate 2 - Average Flow Velocity 3 - Average Sound Velocity 4 - Energy Flow Rate 5 - Mass Flow Rate SV (Secondary variable) 0-5 • 0-5 TV (Third variable) 0-7 • 0-5, 6, 7: PV + Pressure, Temperature QV (Fourth variable) 0-7 • 0-5, 6, 7: PV + Pressure, Temperature The default primary Dynamic Variable is Uncorrected Flow Rate for all meters. Fixed dynamic variables 21 6. Dynamic variables January 2014 22 HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 Dynamic variables with configurable mapping HART Field Device Specification 3410 Series Ultrasonic Meter 7. Status information 3-9000-761 Rev 3 7. 7.1 January 2014 Status information This section documents the HART primary, secondary, third, and fourth variables for the Daniel Ultrasonic Gas Flow Meter. The meter status information is derived from Boolean database points. For host display purposes, the status information is divided into three categories: • Failed - indications that the meter is not working properly and has lost measurement • Maintenance - indications that the meter requires operator intervention • Advisory - indications that the meter has information but is still measuring flow and does not require operator intervention The meter uses the following mechanisms for communicating the status information to the host system: • the Device Status Byte sent with every slave response, • the Read Additional Device Status Universal Command 48 (see Section 7.2) • the device-specific command for reading detailed status information Command 140 (see Section 10.1.13). Device-Specific Command 141 (see Section 10.1.14) is used to acknowledge status Boolean database points that require acknowledgement. The database point mapping for the Device Status Byte is shown in Table 7-1. Command 48 database point mapping is shown in Table 7-2. Note that for Command 48, only the first 16 bytes (numbered 0 through 15) shall be sent by the HART Slave. Additional Device Status information shall be communicated via Device-Specific Command 140 (illustrated in the command definition in Section 10.1.13). 23 7. Status information HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 7.1 3-9000-761 Rev 3 Device status Table 7-1 Device status byte database point mapping Device status bit 7 (msb) 6 5 Definition Device Malfunction - The device detected a serious error or failure that compromises device operation. Explanation This will be the logical OR’ing of the related database points. Configuration Changed - An operation was performed that changed the device's configuration. Configuration Changed flag of corresponding master. If the request is made by primary master then primary master config changed flag will be communicated else secondary master config changed flag. A separate Cold Start bit in the Device Status byte must be provided for each master (i.e. one for Primary master and another for the Secondary Master). Cold start status of corresponding master will be communicated. This bit shall be set whenever a Command 48 bit is active. Refer to Table 7-2 for the Command 48 bit map. This bit shall be set whenever the AO1current output is fixed (whether via HART Command 40 or via enabling the test mode). Thus, it shall be the logical OR’ing of the related database points. Cold Start - A power failure or Device Reset has occurred. 4 More Status Available - More status information is available via Command 48, Read Additional Status Information. 3 Loop Current Fixed - The Loop Current is being held at a fixed value and is not responding to process variations. 2 Loop Current Saturated - The loop Current has reached its upper (or lower) endpoint limit and cannot increase (or decrease) any further. 24 Related database point(s) • • • • • • • • IsAcqModuleError IsCorePresent WatchDogReset IsElecVoltOutOfRange IsAcqModuleIncompatible HARTDidPrimaryConfigChange Or HARTDidSecondaryConfigChange • HARTDidPowerFailPrimary Or HARTDidPowerFailSecondary • N/A • • IsAO1EnableTest AO1IsFixed • AO1IsSaturated Device status HART Field Device Specification 3410 Series Ultrasonic Meter 7. Status information 3-9000-761 Rev 3 January 2014 Table 7-1 Device status byte database point mapping Device status bit 1 0 (lsb) Device status Definition Non-Primary Variable Out of Limits - A Device Variable not mapped to the PV is beyond its operating limits. Primary Variable Out of Limits The Primary Variable is beyond its operating limit. Explanation This bit shall be set whenever any Device Variable not mapped to the PV is out-of-limits. It shall be the logical OR’ing of the related out-of-limits database points. It shall use the AO1Content database point to determine which Device Variable is mapped to the PV. This bit shall be set whenever the Device Variable mapped to the PV is out-of-limits. It shall use the AO1Content database point to determine which Device Variable is mapped to the PV. Note that some Device Variables do not have limits and thus do not have associated outof-limits database points. Related database point(s) • • • • IsMeterVelAboveMaxLmt AvgSndVelOutOfLimits FlowPressureIsOutOfLimits FlowTemperatureIsOutOfLimits • AO1Content 25 7. Status information HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 7.2 Additional device status (Command 48) Command 48 returns the first 16 data bytes (numbered 0 through 15) by the HART Slave. Additional Device Status information is communicated via Device-Specific Command 140. Request Data Bytes Table 7-2 Additional device status (Command 48) Byte 0 Format Bits Description Failed Status Byte 0 Bit 7 (msb) Description Acquisition Mode Indicator 6 Meter cold-start indicator. 5 Acquisition Mode Latched indicator 4 Number of operating chords below specified minimum latched indicator Number of operating chords below specified minimum Acquisition board communications error latched indicator 3 2 Related database point(s) • • • • IsAcqMode • IsTooFewOperChords • IsAcqModuleErrorLatched DidColdStart IsAcqModeLatched IsTooFewOperChordsLatched 1 0 (lsb) 1 Bits Maintenance Status Byte 0 Bit 7 (msb) Description Chord A is hard failed 6 Chord B is hard failed 5 Chord C is hard failed 4 Chord D is hard failed 3 Possible blockage of flow conditioner 2 Possible blockage of flow conditioner latched indicator. Related database point(s) • • • • • • IsHardFailedA IsHardFailedB IsHardFailedC IsHardFailedD IsBlockageDetected IsBlockageDetectedLatched 1 0 (lsb) 26 Additional device status (Command 48) HART Field Device Specification 3410 Series Ultrasonic Meter 7. Status information 3-9000-761 Rev 3 January 2014 Table 7-2 Additional device status (Command 48) Byte 2 Format Bits Description Maintenance Status Byte 1 Bit 7 (msb) Description Flow-condition pressure invalid indicator 6 Flow-condition temperature invalid indicator GC Alarm - logical OR'ing of the related database points 5 Related database point(s) • • PressureInvalid • • • IsGCAlarmPresent IsGCDataErr IsGCCommErr • PressureInvalidLatched 4 3 2 Live digital pressure latched indicator 1 Live digital temperature latched indicator • TemperatureInvalid TemperatureInvalidLatched 0(lsb) 3 Bits Maintenance Status Byte 2 Bit 7 (msb) 6 5 4 Description Indicator that the meter should be warmstarted Related database point(s) • Reserved • IsWarmStartReq 3 2 1 0 (lsb) Additional device status (Command 48) 27 7. Status information HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Table 7-2 Additional device status (Command 48) Byte 4 Format Bits Description Advisory Status Byte 0 Bit 7 (msb) Description Invalid measurement indicator - logical OR'ing of the related database points Related database point(s) 6 DO1PairTestEnable 4 Enables test mode for Digital Output 1 pair Enables test mode for Digital Output 2 pair Power failure indicator 3 Latched alarm indicator 5 • • • • • • • • • • • • • • • • • QFlowValidity (inverted) QBaseValidity(inverted) AGA8BaseCalcValidity (inverted) AGA8FlowCalcValidity (inverted) EnergyRateValidity (inverted) MassRateValidity (inverted) Freq1DataValidity (inverted) Freq2DataValidity (inverted) AO1DataValidity (inverted) AO2DataValidity (inverted) HARTTVValidity (inverted) HARTQVValidity (inverted) HARTSlot0Validity (inverted) HARTSlot1Validity (inverted) HARTSlot2Validity (inverted) HARTSlot3Validity (inverted) • DO2PairTestEnable • • DidPowerFail IsMeterVelAboveMaxLmtLatched 2 1 28 Additional device status (Command 48) HART Field Device Specification 3410 Series Ultrasonic Meter 7. Status information 3-9000-761 Rev 3 Byte 5 Format Bits January 2014 Description Advisory Status Byte 1 Bit 7 (msb) Description One or more logs full indicator logical OR'ing of the related database points 6 Frequency Output 1 pair test enable Frequency Output 2 pair test enable 5 6 7 Enum-8 Enum-8 8 Bits 4 3 2 Forward baseline not set 1 Reverse baseline not set Code 0x08 Description Watchdog reset executed 0x10 Voltage condition out of range Environmental Conditions Out of Range Remaining Bits shall be set to 0. Bits Bits 11 12 13 Bits Bits Bits • • • • • • IsHourlyLogFull IsDailyLogFull IsAuditLogFull IsAlarmLogFull IsSystemLogFull • IsFreq2EnableTest • • IsFwdBaselineNotSet IsFreq1EnableTest IsRevBaselineNotSet Extended device status (See Table 17 of HCF-SPEC-183) Device operating mode shall be set 0 since it is reserved by HCF (See Table 14 of HCF-SPEC183) Standardized Status 0 0x20 9 10 Related database point(s) Related database point(s) • • • WatchdogReset IsElecVoltOutOfRange IsElecTempOutOfRange Standardized status 1 shall be set 0 since it is reserved by HCF (See Table 30 of HCF-SPEC-183) Analog Output Saturated, Respectively LSB to MSB: AO2IsSaturated, (bit mapped). Only bit for AO2 will be used. Standardized status 2, shall be set to 0. Standardized status 3, shall be set to 0. Analog Output Fixed, Respectively LSB to MSB: AO2 (bit mapped) where each bit is the OR'ing of the related database points of IsAO<n>EnableTest and AO<n>IsFixed. Only the bit for AO2 is used. Additional device status (Command 48) 29 7. Status information HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 Byte 14 3-9000-761 Rev 3 Format Bits Description Advisory - Advanced Diagnostic Alarms Bit 7 (msb) Description Liquids possibly present in gas 6 Abnormal flow profile detected 5 Possible bore buildup detected 4 Sound velocity comparison of AGA10 to meter error. Reverse flow detected 3 15 Bits Related database point(s) • • • • IsLiquidDetected • IsReverseFlowDetected IsAbnormalProfileDetected IsBoreBuildupDetected IsSndVelCompErr 2 1 0 (lsb) Advisory - Advanced Diagnostic Alarms Latched Bit 7 (msb) 6 5 4 3 Description Liquids possibly present in gas, latched until acknowledged. Abnormal profile detected, latched until acknowledged Possible bore buildup detected, latched until acknowledged Sound velocity comparison of AGA10 to meter error, latched until acknowledged Reverse flow detected, latched until acknowledged Related Database Point(s) • IsLiquidDetectedLatched • IsAbnormalProfileDetectedLatched • IsBoreBuildupDetectedLatched • IsSndVelCompErrLatched • IsReverseFlowDetectedLatched 2 1 0 (lsb) 16-24 30 Bits, Unsigned-24 or Enum Not used at this time and thus not sent. Additional device status (Command 48) HART Field Device Specification 3410 Series Ultrasonic Meter 8. Universal commands 3-9000-761 Rev 3 8. 8 January 2014 Universal commands This section documents the HART Slave universal commands. 8.1 Slave universal commands The HART Slave implements the HART universal commands available with the Daniel 3410 Series Ultrasonic Flow Meter as shown in the following table. Table 8-1 Universal commands for slave implementation Command Function Description 0 Read Unique Identifier Returns identity information about the meter including: the Device Type, revision levels, and Device ID. 1 Read Primary Variable Returns the Primary Variable value along with its Unit Code. 2 Read Loop Current and Percent Of Range Reads the Loop Current and its associated Percent of Range. 3 Read Dynamic Variables and Loop Current Reads the Loop Current and up to four predefined Dynamic Variables. The Dynamic Variables and associated units are defined via Commands 51 and 53. 6 Write Polling Address Used to set the meter's polling address and loop current mode. 7 Read Loop Configuration Read the polling address and the loop current mode. 8 Read Dynamic Variable Classifications Reads the classification associated with the Dynamic variables. 9 Read Device Variables with Status This command allows a master to request the value and status of up to eight device or dynamic variables. 11 Read Unique Identifier Associated With Tag If the specified tag matches that of the meter, it responds with the Command 0 response. 12 Read Message Reads the Message contained within the meter. 13 Read Tag, Descriptor, Date Reads the Tag, Descriptor, and Date contained within the meter. 14 Read Primary Variable Transducer Information Reads the Transducer (meter) Serial Number, Limits/Minimum Span Units Code, Upper Transducer Limit, Lower Transducer Limit, and Minimum Span for the Primary Variable transducer. 15 Read Device Information Reads the alarm selection code, transfer function code, range values units code - upper range value, Primary Variable lower range value, damping value, write protect code, and private label distributor code. 16 Read Final Assembly Number Reads the Final Assembly Number associated with the meter. 17 Write Message Write the Message into the meter. 18 Write Tag, Descriptor, Date Write the Tag, Descriptor, and Date Code into the meter. Slave universal commands 31 8. Universal commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Table 8-1 Universal commands for slave implementation Command Function Description 19 Write Final Assembly Number Write the Final Assembly Number into the meter. 20 Read Long Tag Reads the 32-byte long tag. 21 Read Unique Identifier Associated with Long Tag If the specified long tag matches that of the meter, it responds with the command 0 response. 22 Write Long Tag Writes the long tag into meter. 38 Reset Configuration Changed Flag If the received configuration changed counter matches with device configuration changed counter, then resets the configuration changed flag (Device Status Byte bit 6) of the requesting master(i.e. Primary/Secondary). 48 Read Additional Device Status Returns meter status information not included in the Response Code or Device Status Byte. 32 Slave universal commands HART Field Device Specification 3410 Series Ultrasonic Meter 9. Common-practice commands 3-9000-761 Rev 3 91 January 2014 9. Common-practice commands This section documents the HART additional device status optional Common-Practice Commands. Note: Common Commands follow the convention of numbering the first analog channel as zero which in this document is referred to as AO1. 9.1 Supported commands The device features, functionality, and restrictions of Common-Practice Commands are listed in the table below. Table 9-1 Common-practice commands Command 33 40 42 44 45 46 50 51 53 54 59 66 67 68 72 89 90 95 Function Description Read Device Variables Enter/Exit Fixed Current Mode Perform Device Reset Allows a Master to request the value of up to four Device Variables. Forces the Loop Current for Primary Variable to the requested value. Forces the meter to perform a warm start (equivalent to cycling the power off and then back on to the meter). Write Primary Variable Units Selects the units in which the Primary Variable and its range will be returned. Trim Loop Current Zero Trims the zero or lower endpoint value of the Loop Current exactly to its minimum. This trim is typically performed by adjusting the Loop Current to 4.00 mA and sending the measured value to the meter. Trim Loop Current Gain Trims the gain or upper endpoint value of the Loop Current exactly to its maximum. This trim is typically performed by adjusting the Loop Current to 20.0 mA and sending the measured value to the meter. Read Dynamic Variable Assign- Reads the Device Variables assigned to the Primary, Secondary, Tertiary, ments and Quaternary Variables. Write Dynamic Variable Assign- Allows the user to assign Device Variables to the Primary, Secondary, ments Tertiary, and Quaternary Variables Write Device Variable Units Selects the units in which the selected Device Variable will be returned. Read Device Variable Informa- Responds with the transducer serial number, the Limits, Damping Value tion (not applicable), and Minimum Span of the Device Variable along with the corresponding engineering units. Write Number Of Response Sets the number of asynchronous preamble bytes to be sent by the meter Preambles before the start of a response message. Enter/Exit Fixed Analog Output Similar to command 40 but allows selection of any analog port not just the Mode Primary Variable. Trim Analog Output Zero Analog Output current calibration zero (offset). Trim Analog Output Gain Analog Output current calibration gain. Squawk Causes the addressed device to visually indicate the reception of this command. Set Real-Time Clock If the Time-set code is 0, responds with the internal time at which the request was received. If the Time-set code is 1, sets Real-Time Clock of meter to have value same as received value. Read Real-Time Clock Reads the Real-Time Clock including the current time as estimated by the meter and the last time the clock was set. Read Device Communication Responds with counts of STX messages received, ACK messages sent and Statistics BACK messages sent. Supported commands 33 9. Common-practice commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 9.2 3-9000-761 Rev 3 Burst mode This device does not support Burst mode. 9.3 Catch device variable This device does not support the Catch Device Variable. 34 Burst mode HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10. 101 January 2014 Device-specific commands This section documents the Device-Specific Commands implemented for the Daniel 3410 Series Ultrasonic Flow Meter. 10.1 Public, device-specific commands The Daniel 3410 Series Ultrasonic Flow Meter device-specific commands in each of the following subsections as defined by: • command number and command name • functional description • command’s operation (i.e., read/write/command) • request data (Byte stream position, data format and descriptions) • response data (Byte stream position, data format and descriptions) • Command-specific response codes Public, device-specific commands 35 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.1 Command 128 Write analog output configuration This command is used to configure the meter's specified analog output. The meter provides two analog outputs: Analog Output 1 (AO1) and Analog Output 2 (AO2). Analog Output 1 supports both conventional 4-20 mA output and HART output, whereas Analog Output 2 supports only conventional 4-20 mA output. This command is primarily provided to allow configuration of Analog Output 2. It can be used to configure Analog Output 1 but the preferred method is to configure the output via the supported HART Universal and Common commands. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Analog output selector Used to select which analog output to be configured. • 0 = Analog Output 1 • 1 = Analog Output 2 This is an informational index variable; when written, it is not updated in the device. 1 Unsigned-8 Device variable assigned to the specified analog output • Used to set AOXContent. When this assignment is a configuration change, the remaining data bytes are ignored. However, for the response, the remaining data bytes should reflect the data for the newly assigned device variable. 2 Enum-8 Upper and Lower Range Values Units Code (Section 11) • Specifies the units for the requested Upper and Lower Range Values. This units code is only pertinent for interpreting this command’s data values and for the units of the response’s data values. It does not update any units-related data points. This is an informational variable; when written, it is not updated in the device. Used to set: • AOXFullScaleVolFlowRate • AOXMaxVel • AOXFullScaleMassRate • AOXFullScaleEnergyRate 3-6 Float Upper Range Value 7-10 Float Lower Range Value • Used to set AOXMinVel. Write shall be rejected if any flow rate (volumetric, mass, or energy) is selected as the device variable and the Lower Range Value is non-zero. 11 Enum-8 Flow direction to be represented by specified analog output • • • 0=Reverse 1=Forward 2=Absolute (indicates flow regardless of flow direction 12 Enum-8 Alarm Selection Code (Section 11) • • • • • • 0=High (20mA) 1=Low (4mA) 239=Hold Last Value 240=Very Low (3.5mA) 241=Very High (20.5mA) 251=None. Used to set AOXActionUponInvalidContent (direct mapping). 36 Command 128 Write analog output configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • Units code, flow direction or alarm code selection invalid. • Lower Range Value was above the Upper Transducer Limit or some other physical device limitation is exceeded. Error 3-4 5 6 7 8 9 Error Error Error Error Error Undefined Too Few Data Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Lower Range Value Too High 10 Error Lower Range Value Too Low • Lower Range Value was below the Lower Transducer Limit or some other physical device limitation is exceeded. 11 Error Upper Range Value Too High • Upper Range Value was above Upper Transducer Limit. 12 Error Upper Range Value Too Low • Upper Range Value was below Lower Transducer Limit. Undefined 15 Error Invalid Analog Channel Code Number • • 16-27 28 Error Undefined Invalid Device Variable Index • 13-14 29-31 32 33-127 Error The analog channel does not exist in this field device. (This shall be returned if the analog output number is neither 0 nor 1.) The requested Device Variable does not exist in this field device or is not supported by the requested command or operation. (This shall be returned if an invalid Device Variable selection is requested.) Undefined Busy Undefined Command 128 Write analog output configuration 37 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.2 Command 129 Read analog output configuration This command is used to read the meter's specified analog output configuration. The meter provides two analog outputs: Analog Output 1 (AO1) and Analog Output 2 (AO2). Analog Output 2 supports only conventional 4 - 20 mA output whereas Analog Output 1 supports both conventional 4 20 mA output and HART output. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Analog output selector Used to select which analog output to be configured. • 0=Analog Output 1 • 1=Analog Output 2 Response data bytes Same as Command 128 Write Analog Output Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-14 15 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Invalid Analog Channel Code Number 16-31 32 33-127 38 Error Error Error Explanation The analog channel does not exist in this field device. (This shall be returned if the analog output number is neither 0 nor 1.) Undefined Busy Undefined Command 129 Read analog output configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.3 January 2014 Command 130 Write Frequency/Digital Output configuration This command is used to configure the meter's specified frequency output pair and its associated digital output pair. The meter provides two frequency output pairs: Frequency Output Pair 1 (Freq1A and Freq1B) and Frequency Output Pair 2 (Freq2A and Freq2B). Associated with each frequency output pair is a digital output pair: Digital Output Pair 1 (DO1A and DO1B) is associated with Frequency Output Pair 1, Digital Output Pair 2 (DO2A and DO2B) is associated with Frequency Output Pair 2. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Frequency/Digital Output Pair selector Used to select which Frequency/Digital Output pair to be configured. • 0= Pair 1 • 1=Pair 2 1 Unsigned-8 2 Enum-8 This is an informational index variable; when written, it is not updated in the device. Device variable assigned to the specified Used to set FreqXContent. When this assignment is a Frequency Output Pair configuration change, the remaining data bytes are ignored. However, for the response, the remaining data bytes should reflect the data for the newly assigned device variable. • 0=Uncorrected flow rate • 1=Corrected flow rate • 2=Average flow velocity • 3=Average sound velocity • 4= Energy rate • 5=Mass rate Upper and Lower Range Values Units Specifies the units for the requested device variable Code (see Section 11) and Upper and Lower Range Values. This units code is only pertinent for interpreting this command’s data values and for the units of the response’s data values. 3-6 Float Upper Range Value 7-10 Float Lower Range Value 11-12 Enum-16 Maximum Frequency (Hertz) Command 130 Write Frequency/Digital Output configuration This is an informational variable; when written, it is not updated in the device. Used to set: • FreqXFullScaleVolFlowRate • FreqXMaxVel • FreqXFullScaleMassRate • FreqXFullScaleEnergyRate This value corresponds to the maximum frequency (set by FreqXMaxFrequency). Used to set FreqXMinVel. Write shall be rejected if any flow rate selected as the device variable and the Lower Range Value is non-zero. This value corresponds to zero frequency. Allowed values are 1000 and 5000 Hz. Used to set FreqXMaxFrequency. 39 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Byte Format Description 13 Enum-8 Flow direction to be represented by Frequency Output Pair 14 Enum-8 15 Enum-8 16 Unsigned-8 17 Enum-8 18 Enum-8 19 Enum-8 20 Enum-8 Explanation Used to set FreqXDir. 0=Reverse 1=Forward 2=Absolute (indicates flow regardless of flow direction) • 3=Bidirectional (Phase A indicates forward direction flow, Phase B indicates reverse direction flow). Frequency B Phase zero-on-error config- Used to set IsFreqXBZeroedOnErr. uration • 0=don’t zero on error • 1=zero on error\ Frequency B Phase relative to Frequency Used to set FreqXBPhase. A Phase configuration • 0=Lag when forward flow, lead when reverse flow • 1=Lead when forward flow, lag when reverse flow This configuration is ignored when Bidirectional flow direction is requested (see FreqXDir above). Frequency feedback correction percent- Used to set FreqXFeedbackCorrectionPcnt. age • Values within (0, 100] percent. Selected Digital Output A inverted Used to set DOXAIsInvPolarity polarity configuration • 0=Normal polarity • 1=Inverted polarity Selected Digital Output A content Used to set DOXAContent data point but it is NOT a selector direct mapping. • 0=Corresponding Frequency Output Pair Validity • 1=Flow Direction Selected Digital Output B inverted Used to set DOXBIsInvPolarity polarity configuration selector • 0=Normal polarity • 1=Inverted polarity Selected Digital Output B content Used to DOXBContent data point but it is NOT a selector direct mapping. • 0=Corresponding Frequency Output Pair Validity • 1=Flow Direction • • • Response data bytes Same as Request data bytes. 40 Command 130 Write Frequency/Digital Output configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • Requested maximum frequency, feedback percentage invalid Frequency Phase B, Digital Output inverted polarity or Digital Output content invalid. Error Undefined Too Few Data Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Lower Range Value Too High • Lower Range Value was above the Upper Transducer Limit or some other physical device limitation is exceeded. 10 Error Lower Range Value Too Low • Lower Range Value was below the Lower Transducer Limit or some other physical device limitation is exceeded. 11 Error Upper Range Value Too High • Upper Range Value was above Upper Transducer Limit. 12 Error Upper Range Value Too Low • Upper Range Value was below Lower Transducer Limit. 13-14 15 Error Undefined Invalid Frequency/Digital Output Pair Number • The Frequency/Digital Output pair requested does not exist in this field device. (This shall be returned if the number is neither 0 nor 1.) 16-27 28 Error • The requested Device Variable does not exist in this field device or is not supported by the requested command or operation. (This shall be returned if an invalid Device Variable selection is requested.) 3-4 5 6 7 8 9 29-31 32 33-127 Error Error Error Error Error Undefined Invalid Device Variable Index Undefined Busy Undefined Command 130 Write Frequency/Digital Output configuration 41 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.4 Command 131 Read Frequency/Digital Output configuration This command is used to read the meter's specified frequency output pair and its associated digital output pair configuration. The meter provides two frequency output pairs: Frequency Output Pair 1 (Freq1A and Freq1B) and Frequency Output Pair 2 (Freq2A and Freq2B). Associated with each frequency output pair is a digital output pair: Digital Output Pair 1 (DO1A and DO1B) is associated with Frequency Output Pair 1, Digital Output Pair 2 (DO2A and DO2B) is associated with Frequency Output Pair 2. The parameters are returned using the units code selection for the device variable represented by the specified frequency output pair. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Frequency/Digital Output Pair selector Used to select which Frequency/Digital Output pair to be configured. • 0= Pair 1 • 1= Pair 2 Response data bytes Same as Command 130 Write Frequency and Digital Output Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-14 15 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Invalid Frequency/Digital Output Pair selector 16-31 32 33-127 42 Error Error Error Explanation • The frequency/digital output pair does not exist in this field device. (This shall be returned if the number is not 0 or 1.) Undefined Busy Undefined Command 131 Read Frequency/Digital Output configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.5 January 2014 Command 132 Write flow pressure configuration This command is used to configure the meter's flow-condition pressure. The input can be disabled, a conventional 4-20 mA input or fixed at a specified value. For conventional 4-20 mA, Analog Input 2 (AI2) is used for pressure. Request data bytes Byte Format Description Explanation 0 Enum-8 Input Selector Code Used to set EnablePressureInput. • 0=None • 1=Live 4-20 mA • 2=Fixed (specified) 1 Enum-8 Units Code (see Section 11) • Specifies the units for related values (such as alarm values, range values, fixed (specified) value). This units code is only pertinent for interpreting this command's data values and for the units of the response's data values. This is an informational variable; when written, it is not updated in the device. 2-5 Float Conventional Analog or Fixed Upper Alarm Value • Used to set HighPressureAlarm. This value is only applicable if the Input Selector Code is 1 (live conventional 4-20 mA analog) or 2 (fixed/specified). It is ignored for all other Input Selector Code values. 6-9 Float Conventional Analog or Fixed Lower Alarm Value • Used to set LowPressureAlarm. This value is only applicable if the Input Selector Code is 1 (live conventional 4-20 mA analog) or 2 (fixed/specified). It is ignored for all other Input Selector Code values. 10-13 Float Conventional Analog Upper • Range Value Used to set MaxInputPressure. This value is only applicable if the Input Selector Code is 1 (live conventional 4-20 mA analog). It is ignored for all other Input Selector Code values. 14-17 Float Conventional Analog Lower • Range Value Used to set MinInputPressure. This value is only applicable if the Input Selector Code is 1 (live conventional 4-20 mA analog). It is ignored for all other Input Selector Code values. 18-21 Float Fixed Value • Used to set SpecFlowPressure. This value is only applicable if the Input Selector Code is 2 (fixed/specified). It is ignored for all other Input Selector Code values. 22 Enum-8 Pressure and Temperature Alarm Selection Code(see Section 11) • 23 Enum-8 Absolute pressure input type indicator 24-27 Float Atmospheric Pressure Value • Required when the input pressure is gage. Used to set AtmosphericPress. 28 Enum-8 Enable pressure-effect expansion correction • Writes EnableExpCorrPress Command 132 Write flow pressure configuration This selects the input action upon alarm and is applicable to both pressure and temperature inputs. Used to set FlowPOrTSrcUponAlarm although it is not a direct mapping: • 239 Hold Last Output Value set FlowPOrTSrcUponAlarm to 0; • 242 Used Fixed Value set FlowPOrTSrcUponAlarm to 1 (Fixed value). Used to set InputPressureUnit. • 0=gage • 1=absolute 43 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection • Input selector code or alarm code selection invalid. 3 Error Passed Parameter Too High • Upper alarm value, lower alarm value, fixed value, and/or atmospheric pressure value too high. 4 Error Passed Parameter Too Low • Upper alarm value, lower alarm value, fixed value, and/or atmospheric pressure value too low. 5 6 Error Error Too Few Data Bytes Received Device-Specific Command Error • Either (a) Lower Alarm Value > Upper Alarm Value or (b) Lower Range Value > Upper Range Value. Also indicates EnablePressureInput is selected as None when HCH_Method is Gross Method 1, Gross Method 2 or Detailed Method. Also indicates EnableExpCorrPress is set as True when EnablePressureInput is None. • • 7 8 9 Error Error In Write Protect Mode Undefined Lower Range Value Too High • Lower Range Value was above the Upper Transducer Limit or some other physical device limitation is exceeded. 10 Error Lower Range Value Too Low • Lower Range Value was below the Lower Transducer Limit or some other physical device limitation is exceeded. 11 Error Upper Range Value Too High • Upper Range Value was above Upper Transducer Limit. 12 Error Upper Range Value Too High • Upper Range Value was above Upper Transducer Limit. 13-31 32 33-127 Error Undefined Busy Undefined 44 Command 132 Write flow pressure configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 10.1.6 Command 133 Read flow pressure configuration This command is used to read the meter's flow-condition pressure input configuration. The parameters are returned using the Pressure device variable configured units code. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 132 Write Flow Pressure Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 133 Read flow pressure configuration Explanation 45 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.7 Command 134 Write flow temperature configuration This command is used to configure the meter's flow-condition temperature. The input can be disabled, a conventional 4-20 mA input, a HART input, or fixed at a specified value. For conventional 4-20 mA and HART inputs, Analog Input 1 (AI1) is used for temperature. Request data bytes Byte Format Description Explanation 0 Enum-8 Input Selector Code Used to set EnableTemperatureInput. • 0=None • 1=Live 4-20 mA • 2=Fixed (specified) 1 Enum-8 Units Code (see Section 11) • • • 3=Live HART1 Specifies the units for related values (such as alarm values, range values, fixed (specified) value). This units code is only pertinent for interpreting this command's data values and for the units of the response's data values. This is an informational variable; when written, it is not updated in the device. 2-5 Float Conventional Analog or Fixed Upper Alarm Value • Used to set HighTemperatureAlarm. This value is only applicable if the Input Selector Code is 1 (live conventional 4-20 mA analog) or 2 (fixed/specified). It is ignored for all other Input Selector Code values. 6-9 Float Conventional Analog or Fixed Lower Alarm Value • Used to set LowTemperatureAlarm. This value is only applicable if the Input Selector Code is 1 (live conventional 4-20 mA analog) or 2 (fixed/specified). It is ignored for all other Input Selector Code values. 10-13 Float Conventional Analog Upper Range Value • Used to set MaxInputTemperature. This value is only applicable if the Input Selector Code is 1 (live conventional 4-20 mA analog). It is ignored for all other Input Selector Code values. 14-17 Float Conventional Analog Lower Range Value • Used to set MinInputTemperature. This value is only applicable if the Input Selector Code is 1 (live conventional 4-20 mA analog). It is ignored for all other Input Selector Code values. 18-21 Float Fixed Value • Used to set SpecFlowTemperature. This value is only applicable if the Input Selector Code is 2 (fixed/specified). It is ignored for all other Input Selector Code values. 22 Enum-8 Pressure and Temperature Alarm Selection Code (see Section 11) • This selects the input action upon alarm and is applicable to both pressure and temperature inputs. Used to set FlowPOrTSrcUponAlarm although it is not a direct mapping: 239 Hold Last Output Value set FlowPOrTSrcUponAlarm to 0. 242 Used Fixed Value set FlowPOrTSrcUponAlarm to 1 (Fixed value). • • 23 Enum-8 Enable temperature-effect expansion • correction Writes EnableExpCorrTemp 1. The Live HART input selector is not supported by v1.60 and later firmware. 46 Command 134 Write flow temperature configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection Error Passed Parameter Too High • • Input selector code or alarm code selection invalid. 3 4 Error Passed Parameter Too Low • Upper alarm value, lower alarm value, or fixed value too high. 5 6 Error Error Too Few Data Bytes Received Device-Specific Command Error 7 8 9 Error Error In Write Protect Mode Undefined Lower Range Value Too High • Lower Range Value was above the Upper Transducer Limit or some other physical device limitation is exceeded. 10 Error Lower Range Value Too Low • Lower Range Value was below the Lower Transducer Limit or some other physical device limitation is exceeded 11 Error Upper Range Value Too High • Upper Range Value was above Upper Transducer Limit. 12 Error Upper Range Value Too Low • Upper Range Value was below the Lower Transducer Limit. 13-31 32 33-127 Error Undefined Busy Undefined Upper alarm value, lower alarm value, or fixed value too high. This is used1 to indicate an error when either: • lower alarm value > upper alarm value • lower range value > upper range value or a requested value is outside its sanity limits. • Also indicates EnableTemperatureInput is selected as None when HCH_Method is Gross Method 1, Gross Method 2 or Detailed Method. • Also indicates EnableExpCorrTemp is set as True when EnableTemperatureInput is None. 1. Also used for unsupported selector code, e.g. Live HART is not supported v1.60 and later firmware. Command 134 Write flow temperature configuration 47 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.8 Command 135 Read flow temperature configuration This command is used to read the meter's flow-condition temperature input configuration. The parameters are returned using the Temperature Device Variable configured units code. Request data bytes Byte Format Description Explanation None Response Data Bytes Same as Command 134 Write Flow Pressure-Specific Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined 10.1.9 Error Error Explanation Command 136 Write device units This command is used to write the device's units. Note that the meter shall utilize the Flow Rate Time Units Code to derive all flow rate units. For example, the Volumetric Flow Rate Units Code (used for the uncorrected volumetric flow rate device variable) shall be derived from the Volume Units Code and the Flow Rate Time Units Code: if the Volume Units Code is cubic meters and the Flow Rate Time Units Code is hourly, then the derived Volumetric Flow Rate Units Code shall be cubic meters per hour. The supported HART Units Codes are listed in Section 11. Request data bytes Byte Format Description 0 1 2 Enum-8 Enum-8 Enum-8 Volume Units Code (see Table 11-1) (43= Cubic meters, 112= Cubic feet.) Flow Rate Time Units Code (see Table 11-5) (51=Second, 52=Hour, 53=Day.) Pressure Units Code (see Table 11-6) (6= Pounds per square inch, 11= Pascals, 12= Kilopascals, 237= Megapascals.) 3 Enum-8 4 5 6 7 8 9 10 Enum-8 Enum-8 Enum-8 Enum-8 Enum-8 Enum-8 Enum-8 11 Enum-8 12 Enum-8 Temperature Units Code (see Table 11-7) ) (32= Degrees Celsius, 33= Degrees Fahrenheit, 35= Kelvin.) Velocity Units Code (see Table 11-8) (20= Feet per second, 21= Meters per second.) Mass Units Code (see Table 11-3) (61= Kilograms, 63= Pounds.) Energy Units Code (see Table 11-2) (164= Megajoules, 240= Million BTU.) Length Units Code (Table 11-15) (45= Meters, 47= Inches.) Micro Length Units Code (Table 11-15) (170 = Micrometer, 171 = Microinch.) Viscosity Units Code (Table 11-17) (55= Centipoise, 170 =Pascal second.) Young’s Modulus Units Code (Table 11-6) (12= Kilopascals, 237= Megapascals, 180 =1E6 Pounds per square inch.) Volumetric Heating Value Units Code(Table 11-18) (170= Kilojoules per cubic decimeter, 171= British thermal unit per cubic feet.) Density Units Code (Table 11-19) (92= Kilogram per cubic meter, 94= Pound per cubic feet.) 48 Command 135 Read flow temperature configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • 3-4 5 6 7 8-31 32 33-127 Error Error Error Error Error Command 136 Write device units One or more of the units code selection(s) is/ are invalid. Undefined Too Few Data Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined 49 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.10 Command 137 Read device units This command is used to read the device's units. Request data bytes Byte Format Description Explanation None Response data bytes Same as for Command 136 Write Device Units. Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error 10.1.11 Explanation Command 138 Write device variable range This command is used to write a specified device variable's upper and lower range values. This command is used to scale graphs, charts, etc. for displaying device variable values on the host system (AMS Device Manager). Request data bytes Byte Format Description Explanation 0 Unsigned-8 Device variable Selector • Specifies the device variable for which the range values are to be set. 1 Enum-8 Units Code (see Section 11) • Specifies the units for the specified range values. This units code is only pertinent for interpreting this command's data values and for the units of the response's data values. This is an informational variable; when written, it is not updated in the device • 2-5 6-9 Float Float Upper Range Value Lower Range Value Response data bytes Same as Request data bytes. 50 Command 137 Read device units HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • Units code selection invalid • Lower Range Value was above the Upper Transducer Limit or some other physical device limitation is exceeded. Error 3-4 5 6-8 9 Error Undefined Too Few Data Bytes Received Undefined Lower Range Value Too High 10 Error Lower Range Value Too Low • Lower Range Value was below the Lower Transducer Limit or some other physical device limitation is exceeded. 11 Error Upper Range Value Too High • Upper Range Value was above Upper Transducer Limit. 12 Error Upper Range Value Too Low • Upper Range Value was below the Lower Transducer Limit. 13-27 28 Error Undefined Invalid Device Variable Index • The requested Device Variable does not exist in this field device or is not supported by the requested command or operation. (This shall be returned if an invalid Device Variable selection is requested.) 29-31 32 33-127 Error Error Undefined Busy Undefined Command 138 Write device variable range 51 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.12 Command 139 Read device variable range This command is used to read a specified device variable's upper and lower range values. This command is expected to be used to scale graphs, charts, etc. for displaying device variable values on host system (AMS) screens. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Device variable Selector • Specifies the device variable for which the range values are to be read. Response data bytes Same as for Command 138 Write device variable range. Command-specific response codes Code Class Description Explanation 0 1-4 5 6-27 28 Success No Command-Specific Errors Undefined Too Few Data Bytes Received Undefined Invalid device variable index • 29-31 32 33-127 52 Error Error Error The requested device variable does not exist in this field device or is not supported by the requested command or operation. (This shall be returned if an invalid device variable selection is requested.) Undefined Busy Undefined Command 139 Read device variable range HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.13 January 2014 Command 140 Read detailed status This command is used to read detailed status information (i.e., status information that provides detail beyond that of the response status byte and Common Command 48 (Read Additional Device Status see Table 7-1). The purpose of having a separate device-specific command is to limit what is seen and logged by the AMSTM Device Manager Alert Monitor. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description 0 Bits Failed Detail Status Byte 0 Bit Description Related database point(s) 7 (msb) Indicates a diagnostic core file was generated. Indicates communication error with Acquisition module Indicates electronics voltage out-of-range. • • IsCorePresent 6 • IsElecVoltOutOfRange • WatchDogReset • IsAcqModuleIncompatible 5 4 3 2 Indicates the watchdog performed a meter warm-start. Indicates unknown Acquisitionmodule revision firmware upgrade is required. IsAcqModuleError 1 0 (lsb) 1 Bits Maintenance Detail Status Byte 0 Bit Description Related database point(s) 7 (msb) Indicates that a GC alarm condition is present. • IsGCAlarmPresent 6 5 Indicates invalid data read from the GC Indicates a communication error with the GC. • • IsGCDataErr 4 IsGCCommErr 3 2 1 0 (lsb) Command 140 Read detailed status 53 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Byte Format Description 2 Bits Advisory Detail Status Byte 0 Bit Description Related database point(s) 7 (msb) Flow-condition volumetric flow rate validity • • • • • • 6 Base-condition volumetric flow rate validity 5 AGA8 base-condition calculation validity 4 AGA8 flow-condition calculation validity 3 Energy rate validity 2 Mass rate validity QFlowValidity (inverted) QBaseValidity (inverted) AGA8BaseCalcValidity (inverted) AGA8FlowCalcValidity (inverted) EnergyRateValidity (inverted) MassRateValidity (inverted) 1 0 (lsb) 3 Bits Advisory Detail Status Byte 1 Bit Description Related database point(s) • • • • • • • IsAO2EnableTest • AO1IsFixed 7 (msb) Analog Output 2 test enable 6 Analog Output 1 test enable 5 Frequency Output 2 data is invalid 4 Frequency Output 1 data is invalid 3 Analog output 2 validity 2 Analog output 1 validity 1 Analog Output 2 (HART SV) current is in test mode and fixed. Analog Output 1 (HART PV) current is in test mode and fixed. 0 (lsb) 4 54 Bits IsAO1EnableTest Freq2DataValidity (inverted) Freq1DataValidity (inverted) AO2DataValidity (inverted) AO1DataValidity (inverted) AO2IsFixed Advisory Detail Status Byte 2 Bit Description Related database point(s) 7 (msb) Hourly log full indicator IsHourlyLogFull 6 Daily log full indicator 5 Audit log full indicator 4 Alarm log full indicator 3 System log full indicator • • • • • 2 1 HART third variable validity HART fourth variable validity • • HARTTVValidity 0 (lsb) IsDailyLogFull IsAuditLogFull IsAlarmLogFull IsSystemLogFull HARTQVValidity Command 140 Read detailed status HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Byte Format Description 5 Bits Advisory Detail Status Byte 3 Bit Description 7 (msb) 4 • Average sound velocity out-of-limits • Flow-condition pressure out-of-limits indicator • Flow-condition temperature out-of-limits • 3 • HARTSlot0Validity (inverted) • HARTSlot1Validity (inverted) • HARTSlot2Validity (inverted) • HARTSlot3Validity (inverted) 6 5 2 1 0 (lsb) Related database point(s) Flow data quality indicator indicator The HART Slot 0 value as defined by the HART device variable selection The HART Slot 1 value as defined by the HART device variable selection The HART Slot 2 value as defined by the HART device variable selection The HART Slot 3 value as defined by the HART device variable selection IsMeterVelAboveMaxLmt AvgSndVelIsOutOfLimits FlowPressureIsOutOfLimits FlowTemperatureIsOutOfLimits Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error Command 140 Read detailed status Explanation 55 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.14 Command 141 Acknowledge alarm This command is used to acknowledge (clear/reset) an acknowledgeable alarm. The request shall include an enumeration to specify which alarm to acknowledge where the enumeration shall be as listed in the table below: Enumeration Alarm 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 IsCorePresent WatchDogReset DidColdStart DidPowerFail IsAnyKeyAboutToExpire (not used) IsAnyKeyExpired (not used) IsBoreBuildupDetectedLatched IsBlockageDetectedLatched IsAbnormalProfileDetectedLatched IsLiquidDetectedLatched IsReverseFlowDetectedLatched IsSndVelCompErrLatched IsAcqModuleErrorLatched IsMeterVelAboveMaxLmtLatched TemperatureInvalidLatched PressureInvalidLatched IsAcqModeLatched IsTooFewOperChordsLatched IsFwdBaselineNotSet IsRevBaselineNotSet The acknowledgeable alarm DidCnfgChksumChg can also be acknowledged via Common Command 38. The DidPowerFail acknowledgeable alarm is automatically reset according to the HART Device Status requirements. The meter shall also reset any DidColdStart alarm when the DidPowerFail alarm is automatically reset. However, this “automatic reset” only applies to HART (for the Field Device Status byte) and does not clear the database point(s). Acknowledging DidColdStart or DidPowerFail via this command clears the specified database point. Request data bytes Byte Format Description Explanation 0 Enum-8 Alarm identifier Selects the alarm to be acknowledged. Response data bytes Same as Request data bytes. 56 Command 141 Acknowledge alarm HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • 3-4 5 6 7-31 32 33-127 Error Error Error Error Command 141 Acknowledge alarm The selected alarm to acknowledge does not exist. Undefined Too Few Data Bytes Received Device-specific command error Undefined Busy Undefined 57 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.15 Command 142 Write digital input configuration This command is used to configure the meter's specified digital input configuration. The meter provides a single digital input that can be used to gate a calibration pass (such as for synchronizing the meter's calibration with prover switches). Request data bytes Byte Format Description Explanation 0 Enum-8 General purpose polarity • • 1 Enum-8 Calibration input polarity • • 2 Enum-8 Calibrating gating type • • 0=normal 1=inverted Applicable when the digital input is used as a general purpose input. Specifies the digital input polarity for interpreting the input value. Used to set DI1IsInvPolarity. 0=active high 1=active low Applicable when the digital input is used for calibration. Specifies the digital input polarity for starting/stopping calibration. Used to set IsDI1ForCalActiveLow. 0=edge gated 1=state gated Applicable when the digital input is used for calibration. Specifies the digital input polarity for starting/stopping calibration. Used to set IsDI1ForCalStateGated. Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • 3-4 5 6 7 8-31 32 33-127 58 Error Error Error Error Input usage selector, general purpose polarity, calibration input polarity or gating type selection invalid. Undefined Too Few Data Bytes Received Undefined In Write Protect Mode Undefined Busy Undefined Command 142 Write digital input configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.16 January 2014 Command 143 Read digital input configuration This command is used to read the meter's specified digital input configuration. The meter provides a single digital input that can be used to gate a calibration pass (such as for synchronizing the meter's calibration with prover switches). Request data bytes Byte Format Description Explanation None Response data bytes Same as for Command 142 Write Digital Input Configuration. Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error 10.1.17 Explanation Command 146 Read Miscellaneous Non-Write Protected Parameters This command is used to read miscellaneous non-write protected parameters. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 224 Write Miscellaneous Non-Write Protected Parameters. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 143 Read digital input configuration Explanation 59 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.18 Command 147 Read miscellaneous write protected parameters This command is used to read miscellaneous write protected parameters. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Byte 0 Unsigned-8 Polling Address Reads HARTPollingAddress (the leastsignificant 4 bits of the short frame address) 1 Unsigned-8 Number of Slave response preamble bytes Reads HARTNumPreambleBytesFromSlave 2 Unsigned-8 Number of Master command preamble bytes Reads HARTMinNumPreambles 3 Unsigned-8 Non-normal operation timeout Reads NonNormalModeTimeout used for frequency testing in units of minute 4 Unsigned-8 Hour of day to log daily record in military time Reads ContractHour 5 Enum-8 Modbus access units system Reads UnitsSystem 6 Enum-8 Flow rate time unit for Modbus communications Reads VolFlowRateTimeUnit 7 Enum-8 U.S. Customary volume unit for Modbus communications Reads VolUnitUS 8 Enum-8 Metric volume unit for Modbus communications Reads VolUnitMetric Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined 60 Error Error Explanation Command 147 Read miscellaneous write protected parameters HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.19 January 2014 Command 148 Write blockage configuration This command is used to write blockage alarm configuration values. Turbulence, symmetry, and cross flow are in Percentages. All units are fixed. Request data bytes Byte Format Description Explanation • • • • • • • 0-3 Float Blockage Turbulence A Limit 4-7 Float Blockage Turbulence B Limit 8-11 Float Blockage Turbulence C Limit 12-15 Float Blockage Turbulence D Limit 16-19 Float Blockage Cross-Flow Limit 20-23 Float Blockage Symmetry Limit 24 Enum-8 Blockage Detection Enabled Writes the datapoint BlockageTurbulenceLmtA Writes the datapoint BlockageTurbulenceLmtB Writes the datapoint BlockageTurbulenceLmtC Writes the datapoint BlockageTurbulenceLmtD Writes the datapoint BlockageCrossFlowLmt Writes the datapoint BlockageSymmetryLmt Writes the datapoint IsBlockageDetectionEnabled – 0 = Disabled – 1 = Enabled Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection • Blockage Detection Enabled is not equal to 0 or 1 3 Error Passed Parameter Too High Alarm limit too high 4 Error Passed Parameter Too Low • • 5 6 7 8-31 32 33-127 Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Error Error Command 148 Write blockage configuration Alarm limit too low (or negative) 61 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.20 Command 149 Read blockage configuration This command reads the configuration for the blockage alarm. Turbulence, symmetry, and cross flow are in percentages. All units are fixed. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 148 Write Blockage Configuration. Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error 10.1.21 Command 150 Write liquid detection configuration Request data bytes Byte Format Description Explanation 0-3 Float Liquid Detection Standard Deviation Profile • Factor Limit 4-7 Float Liquid Detection Standard Deviation Cross Flow Limit • Writes the datapoint LiquidDetectionSDevCrossFlowLmt 8-11 Float Liquid Detection Standard Deviation Symmetry Limit • Writes the datapoint LiquidDetectionSDevSymmetryLmt 12 Enum-8 Enable Liquid Detection • Writes the datapoint IsLiquidDetectionEnabled. Writes the datapoint LiquidDetectionSDevProfileFactorLmt Note: Liquid Detection is only active if IsLiquidDetectionFeatureActive is TRUE(1) which depends on this datapoint and the option keys being valid. Allowed values are 0 or 1. 62 Command 149 Read blockage configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description 0 1 2 3 4 5 6 7 8-31 32 33-127 Success No Command-Specific Errors Undefined Invalid Selection Passed Parameter Too High Passed Parameter Too Low Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Error Error Error Error Error Error Error 10.1.22 Explanation Enable Liquid Detection is not a 0 or 1 Alarm limit too high Alarm limit too low (or negative) Command 151 Read liquid detection configuration This command reads the configuration for the liquid detection alarm. Request data bytes Byte Format Description Explanation None Response data byte Same as Command 150 Write liquid detection configuration. Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error Command 151 Read liquid detection configuration Explanation 63 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.23 Command 152 Read continuous flow analysis active features This command is to read the Continuous Flow Analysis Active Features. Indicates that a feature is enabled and active. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Related datapoints 0 Enum-8 • IsBoreBuildupDetectionFeatureActive 1 Enum-8 • IsBlockageDetectionFeatureActive 2 Enum-8 • IsLiquidDetectionFeatureActive 3 Enum-8 • IsAbnormalProfileDetectionFeatureActive 4 Enum-8 Reads the datapoint Bore Buildup Detection Active Reads the datapoint Blockage Detection Active Reads the datapoint Liquid Detection Active Reads the datapoint Abnormal Profile Active Reads the datapoint Sound Velocity Comparison Active • IsSndVelCompFeatureActive Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined 64 Error Explanation Command 152 Read continuous flow analysis active features HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.24 January 2014 Command 153 Read running averages This command reads the running average data. The running average reported is a snapshot capture from the latest register point update in the HART slave. Units for turbulence, Cross Flow, Symmetry, and Profile values are percentages. Swirl Angle is always in degrees. The unit codes for other values in the message are only the units allowed for that type of variable. See Section 11 for the unit code tables used by the meter. *Note: Chords C and D are not available for 3412 Dual path meters and 3411 single path meters. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Related database points 0-3 Float • RunningAvgFlowTemperature 4-7 Float • RunningAvgFlowPressure 8-11 Float • RunningAvgTurbulenceA 12-15 Float Reads the datapoint Running Average Flow Temperature. Used for forward and reverse baseline temperature. Reads the datapoint Average Flow Pressure. Used for forward and reverse baseline pressure. Reads the datapoint Average Turbulence A. Used for forward and reverse baseline turbulence. Reads the datapoint Average Turbulence B. Used for forward and reverse baseline turbulence. • RunningAvgTurbulenceB 16-19 Float Reads the datapoint Average Turbulence C*. Used for forward and reverse baseline turbulence. • RunningAvgTurbulenceC* 20-23 Float • RunningAvgTurbulenceD* 24-27 Float • RunningAvgAvgFlow 28-31 Float • RunningAvgCrossFlow 32-35 Float • RunningAvgProfileFactor 36-39 Float • RunningAvgSwirlAngle 40-43 Float • RunningAvgSymmetry 44-47 Float • RunningAvgSDevCrossFlow 48-51 Float • RunningAvgSDevProfileFactor 52-55 Float • RunningAvgSDevSymmetry 56 Enum-8 Reads the datapoint Average Turbulence D*. Used for forward and reverse baseline turbulence. Reads the datapoint Running Average Average Flow. Used for forward and reverse baseline average flow. Reads the datapoint Average Cross-Flow. Used for forward and reverse baseline cross flow. Reads the datapoint Average Profile Factor. Used for forward and reverse baseline profile factors. Reads the datapoint Average Swirl Angle. Used for forward and reverse baseline swirl angle. Reads the datapoint Average Symmetry. Used for forward and reverse baseline symmetry. Reads the datapoint Average Standard Deviation of Cross Flow. Reads the datapoint Average Standard Deviation of Profile Factor. Reads the datapoint Average Standard Deviation of Symmetry. Reads the datapoint Running average validity. IsRunningAvgValid 57 Enum-8 Sets the forward or reverse flow direction. • • 58 Enum-8 Units Code for Temperature values (see Table 11-7) Units for Average Flow Temperature 59 Enum-8 Units Code for Pressure values (see Table 11-6) 60 Enum-8 Units Code for flow velocity see Table 11-8 • • • Command 153 Read running averages FlowDirection – 0= Reverse – 1= Forward Units for Average Flow Pressure Units code for Average Flow 65 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error 10.1.25 Command 154 Read baselines This command reads the forward or reverse baseline values depending upon the parameter passed in the command request. Percentages are the units for turbulence, profile factor, symmetry, and cross flow. Swirl Angle is always in degrees. If IsAnyBaselineAvail is FALSE, then this command responds with “command not implemented” error. *Note: Chords C and D are not available for 3412 Dual path meters and 3411 single path meters. Request data bytes Byte Format Description Explanation 0 Enum-8 Forward / Reverse Selection • • 0 = Reverse 1 = Forward Response data bytes Byte Format Description Related database points • • • 0 = Reverse 1 = Forward Reads the datapoint Flow Pressure (direction depends on request byte 0) • FwdBaselineFlowPressure or RevBaselineFlowPressure Float Reads the datapoint Turbulence A (direction depends on request byte 0) • FwdBaselineTurbulenceA or RevBaselineTurbulenceA 13-16 Float Reads the datapoint Turbulence B (direction depends on request byte 0) • FwdBaselineTurbulenceB or RevBaselineTurbulenceB 17-20 Float Reads the datapoint Turbulence C (direction depends on request byte 0) • FwdBaselineTurbulenceC* or RevBaselineTurbulenceC 21-24 Float Reads the datapoint Turbulence D (direction depends on request byte 0) • FwdBaselineTurbulenceD* or RevBaselineTurbulenceD 25-28 Float • FwdBaselineAvgFlow or RevBaselineAvgFlow 29-32 Float Reads the datapoint Average Flow (direction depends on request byte 0) Reads the datapoint Cross Flow (direction depends on request byte 0) • FwdBaselineCrossFlow or RevBaselineCrossFlow 33-36 Float Reads the datapoint forward or reverse Swirl Angle (direction depends on request byte 0) • FwdBaselineSwirlAngle or RevBaselineSwirlAngle 37-40 Float • FwdBaselineSymmetry or RevBaselineSymmetry 41-44 Float Reads the datapoint forward or reverse Symmetry (direction depends on request byte 0) Reads the datapoint forward or reverse Temperature (direction depends on request byte 0) • FwdBaselineFlowTemperature or RevBaselineFlowTemperature 0 Enum-8 Forward/Reverse selection 1-4 Float Reads the datapoint Profile Factor (direction depends on request byte 0) 5-8 Float 9-12 66 FwdBaselineProfileFactor or RevBaselineProfileFactor Command 154 Read baselines HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 Byte Format January 2014 Description 45 Unsigned-8 Reads the datapoint Baseline Not Set Boolean 46 Enum-8 47 Enum-8 48 Enum-8 Units Code for Flow Temperature (see Table 11-7) Units Code for Flow Pressure (see Table 11-6) Units Code for flow velocity (see Table 11-8) Related database points • • IsFwdBaselineNotSet or IsRevBaselineNotSet • Units for Flow Pressure • Units for Average Flow. Units for Flow Temperature Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • 3-5 6 7-31 32 33-127 Error Error Error Error Command 154 Read baselines Invalid value for Forward / Reverse Selection Undefined Device-Specific Command Error Undefined Undefined 67 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.26 Command 155 Write baselines Writes forward or reverse baseline values depending upon the first byte in command. Note: The date is set by meter if baseline set is successful and the baseline comment will be set to "Set by HART". The IsFwdBaselineNotSet and IsRevBaselineNotSet Booleans will be cleared if the baseline set was successful. This is to be done by writing the Booleans for individual points, with the logic handling setting the global baseline not set Boolean. When the firmware is updated, and more datapoints are added, the baseline(s) will be handled correctly. The units for turbulence, profile factor, symmetry, and cross flow units are percentages. Swirl Angle is always in degrees. Turbulences must be between 0 and 100%. Profile factor and average flow must be greater than or equal to 0. If IsAnyBaselineAvail is FALSE, then this command responds with “command not implemented” error. *Note: Chords C and D are not available for 3412 Dual path meters and 3411 single path meters. Request data bytes Byte Format Description Explanation 0 Enum Forward / Reverse Selection • • 0 = Reverse 1 = Forward This is an informational index variable; when written, it is not updated in the device. Note: Contrary to device-specific commands guideline 'Indices format should be Unsigned<#bits>', format Enum-8 is used for backward compatibility Writes the datapoint FwdBaselineProfileFactor or RevBaselineProfileFactor (depends on request byte 0) Writes the datapoint FwdBaselineFlowPressure or RevBaselineFlowPressure • FwdBaselineProfileFactor or RevBaselineProfileFactor • FwdBaselineFlowPressure or RevBaselineFlowPressure Float Writes the datapoint FwdBaselineTurbulenceA or RevBaselineTurbulenceA • FwdBaselineTurbulenceA or RevBaselineTurbulenceA 13-16 Float Writes the datapoint FwdBaselineTurbulenceB or RevBaselineTurbulenceB • FwdBaselineTurbulenceB or RevBaselineTurbulenceB 17-20 Float Writes the datapoint FwdBaselineTurbulenceC* • or RevBaselineTurbulenceC FwdBaselineTurbulenceC* or RevBaselineTurbulenceC 21-24 Float Writes the datapoint FwdBaselineTurbulenceD* or RevBaselineTurbulenceD • FwdBaselineTurbulenceD* or RevBaselineTurbulenceD 25-28 Float Writes the datapoint FwdBaselineAvgFlow or RevBaselineAvgFlow • FwdBaselineAvgFlow or RevBaselineAvgFlow 29-32 Float Writes the datapoint FwdBaselineCrossFlow or RevBaselineCrossFlow • FwdBaselineCrossFlow or RevBaselineCrossFlow 33-36 Float Writes the datapoint FwdBaselineSwirlAngle or RevBaselineSwirlAngle • FwdBaselineSwirlAngle or RevBaselineSwirlAngle 37-40 Float Writes the datapoint FwdBaselineSymmetry or RevBaselineSymmetry • FwdBaselineSymmetry or RevBaselineSymmetry 1-4 Float 5-8 Float 9-12 68 Command 155 Write baselines HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Byte Format Description Explanation 41-44 Float Writes the datapoint FwdBaselineFlowTemperature or RevBaselineFlowTemperature • 45 Enum-8 46 Enum-8 Units Code for Flow Temperature (see Table 11- • 7) Units Code for Flow Pressure (see Table 11-6) • 47 Enum-8 Units Code for flow velocity (see Table 11-8) • FwdBaselineFlowTemperature or RevBaselineFlowTemperature Units for Flow Temperature Units for Flow Pressure Units for Average Flow Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection 3 Error Passed Parameter Too High 4 Error 5 6 7 8-17 18 Error 19-31 32 33-127 Error Error Error Explanation Invalid value for Forward / Reverse Selection Passed Parameter Too Low • • • Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Invalid Units Code • One or more of the units codes are invalid A baseline value was too high A baseline value was too low Undefined Busy Undefined Command 155 Write baselines 69 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.27 Command 156 Read keys This command reads the optional feature keys. Note that the Ethernet and Log Access keys are always enabled in firmware v1.70 and above. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 157 Write Keys. Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error 10.1.28 Command 157 Write keys This command writes the optional feature keys. The keys must be in HEX format with capital letters for A-F. Packed ASCII is defined by the HART specifications. Note: Keys are not part of write protected configuration. Request data bytes Byte Format Description Explanation 0-11 Packed ASCII Packed ASCII Writes the AGA10Key. Must be HEX format (09,A-F) Writes the database point AGA10Key Writes the GCKey must be HEX format (0-9,A-F) Writes the database point GCKey. • AGA10Key • GCKey Packed ASCII Writes the Continuous Flow Analysi Key. Must be HEX format (0-9,A-F). • ContinuousFlowAnalysisKey 12-23 24-35 Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1-4 5 6 7-11 12 Success No Command-Specific Errors Undefined Too Few Bytes Received Device-Specific Command Error Undefined Invalid Format • 13-31 32 33-127 70 Error Error Error Error A key was either not in the correct format (HEX only) or the key was invalid Undefined Busy Undefined Command 156 Read keys HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.29 January 2014 Command 158 Read key validities This command reads the validity Booleans for keys. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Related database points 0 Enum-8 AGA10 key validity 1 Enum-8 GC key validity 2 Enum-8 Continuous Flow Analysis key validity • • • IsOptoinalAGA10CalcEnabled IsOptionalGCInterfaceEnabled IsOptional ContinuousFlowAnalysisEnabled Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined 10.1.30 Error Command 159 Read meter chord data This command will read meter flow related data (flow velocities, sound velocities and turbulence). The units code values for velocity are specified in Section 11.8. Turbulence units are always percentage. *Note: Chords C and D are not available for 3412 Dual path meters and 3411 single path meters. Request data bytes Byte Format Description Explanation None Command 158 Read key validities 71 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Response data bytes Byte Format Description Related database points 0-3 Float Flow Velocity Chord A • • • • • • • • • • • • • 4-7 Float Flow Velocity Chord B 8-11 Float Flow Velocity Chord C* 12-15 Float 16-19 Float Flow Velocity Chord D* Sound Velocity Chord A 20-23 Float Sound Velocity Chord B 24-27 Float Sound Velocity Chord C* 28-31 Float 32-35 Float Sound Velocity Chord D* Turbulence Chord A 36-39 Float Turbulence Chord B 40-43 Float Turbulence Chord C* 44-47 Float 48 Enum-8 Turbulence Chord D* Units Code for velocity (see Table 11-8) FlowVelA FlowVelB FlowVelC* FlowVelD* SndVelA SndVelB SndVelC* SndVelD* TurbulenceA TurbulenceB TurbulenceC* TurbulenceD* Units code that applies to all velocity values in this message. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined 10.1.31 Error Error Command 160 Read meter flow data This command reads flow related data (symmetry, cross flow, flow direction, profile factor, and swirl angle) along with SOS Comparison difference, AGA 10 calculated sound velocity and the volume related to the reverse flow alarm. The units code for velocity and volume are defined in Section 11.1 and Section 11.8. Symmetry, Cross-Flow, and Profile Factor are ratios and do not have units. Swirl Angle is always in degrees. SOS Comparison difference unit is always in percentage. These measurements are applicable for meters with four or more chords. Request data bytes Byte Format Description Explanation None 72 Command 160 Read meter flow data HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Response data bytes Byte Format Description Related database points 0-3 Float Symmetry 4-7 Float Cross-Flow 8-11 Float Profile Factor 12-15 Float Swirl Angle 16-19 Float Average Flow Velocity 20-23 Float Average Sound Velocity 24-27 Float Reverse Flow Volume 28-31 Float AGA10 Sound Velocity 32-35 Float 36 Enum-8 SOS Comparison Difference. SOSComparePctDiff is the difference between AGA10 Sound velocity and meter measured sound velocity. Implied unit is percentage Sets the flow direction • • • • • • • • • 37 Enum-8 Units code for velocity • • • 38 Enum-8 Units code for volume • Symmetry CrossFlow Profile Factor SwirlAngle AvgFlow AvgSndVel ReverseFlowVol AGA10SndVel SOSComparePctDiff Flow Direction: 0= Reverse 1= Forward Units code that applies to all velocity values in this message (see Table 11-8). Units code for volume values (see Table 11-1). Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 160 Read meter flow data 73 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.32 Command 161 Read path signal amplitude data This command reads the path Signal Amplitude data. Voltage units codes in Table 11-12. *Note: Chords C and D are not available for Model 3412 two-path or Model 3411single-path ultrasonic meters. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Related database points SignalAmplitudeA1 0-3 Float Signal Amplitude A upstream 4-7 Float Signal Amplitude A downstream 8-11 Float Signal Amplitude B upstream 12-15 Float Signal Amplitude B downstream • • • • 16-19 Float Signal Amplitude C* upstream • SignalAmplitudeC1* 20-23 Float Signal Amplitude C* downstream • SignalAmplitudeC2* 24-27 Float Signal Amplitude D* upstream • SignalAmplitudeD1* 28-31 Float Signal Amplitude D* downstream SignalAmplitudeD2* 32 Enum-8 Units for amplitude points • • SignalAmplitudeA2 SignalAmplitudeB1 SignalAmplitudeB2 A HART Units enum indicating the units for all the amplitude values in this message. This must be Millivolts units (see Table 11-12). Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined 74 Error Command 161 Read path signal amplitude data HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.33 January 2014 Command 162 Read noise amplitudes This command reads the path noise amplitudes. Units codes for voltage are specified in Table 11-12. * Table Note: Chords C and D are not available for Model 3412 two-path or Model 3411singlepath ultrasonic meters. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Related database points 0-3 4-7 Float Noise Amplitude A upstream Noise Amplitude A downstream 8-11 Float Noise Amplitude B upstream 12-15 Float Noise Amplitude B downstream • • • • NoiseAmplitudeA1 Float 16-19 Float Noise Amplitude C* upstream • NoiseAmplitudeC1* 20-23 Float Noise Amplitude C*downstream • NoiseAmplitudeC2* 24-27 Float Noise Amplitude D* upstream • NoiseAmplitudeD1* 28-31 Float Noise Amplitude D*downstream NoiseAmplitudeD2* 32 Enum-8 Units for amplitudes. • • NoiseAmplitudeA2 NoiseAmplitudeB1 NoiseAmplitudeB2 A HART Units enum value indicating the units of all points read in this command. This must be Millivolts units codes (see Table 11.12). Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error Command 162 Read noise amplitudes 75 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.34 Command 163 Read path SNR data This command reads the SNR (signal-to-noise ratio) values for each path. SNR values are in decibels. Unit codes for decibels are specified in Table 11-11. *Note: Chords C and D are not available for Model 3412 two-path or Model 3411single-path ultrasonic meters. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Related database points SNRA1 0-3 Float Signal Noise Ratio A upstream 4-7 Float Signal Noise Ratio A downstream 8-11 Float Signal Noise Ratio B upstream 12-15 Float Signal Noise Ratio B downstream • • • • 16-19 Float Signal Noise Ratio C* upstream • SNRC1* 20-23 Float Signal Noise Ratio C* downstream • SNRC2* 24-27 Float Signal Noise Ratio D* upstream • SNRD1* 28-31 Float Signal Noise Ratio D* downstream Enum-8 Units decibel codes • • SNRD2* 32 SNRA2 SNRB1 SNRB2 HART Unit code for SNR ratio. Must be decibel units (see Table 11-11). Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined 76 Error Command 163 Read path SNR data HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.35 January 2014 Command 164 Read path percent good This command reads the percentage of “good” batch firings for all paths for upstream and downstream flow directions. Units are fixed to percentage. *Note: Chords C and D are not available for Model 3412 two-path or Model 3411 single-path ultrasonic meters. Request data bytes Byte Format Description Explanation None Response Data Bytes Byte Format Description Related database points 0-3 Float Percent Good Path A upstream PctGoodA1 4-7 Float Percent Good Path A downstream 8-11 Float Percent Good Path B upstream 12-15 Float Percent Good Path B downstream • • • • 16-19 Float Percent Good Path C* upstream • PctGoodC1* 20-23 Float Percent Good Path C* downstream • PctGoodC2* 24-27 Float Percent Good Path D* upstream • PctGoodD1* 28-31 Float Percent Good Path D* downstream • PctGoodD2* PctGoodA2 PctGoodB1 PctGoodB2 Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error Command 164 Read path percent good 77 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.36 Command 165 Read path gains This command reads all path gain values. The decibel units code is a device specific units code see Table 11-11. Note: If the gains in the meter are currently in some other unit than decibels (such as hardware or software gain), the HART slave must convert the values to decibels. *Note: Chords C and D are not available for Model 3412 two-path or Model 3411single-path ultrasonic meters. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Related Database Points 0-3 Float • GainA1 4-7 Float • GainA2 8-11 Float • GainB1 12-15 Float Gain when transducer A1 (upstream) is receiving a signal Gain when transducer A2 (downstream stream) is receiving a signal Gain when transducer B1 (upstream) is receiving a signal Gain when transducer B2 (downstream stream) is receiving a signal • GainB2 16-19 Float Gain when transducer C1* (upstream) is receiving a signal • GainC1* 20-23 Float Gain when transducer C2* (downstream stream) is receiving a signal • GainC2* 24-27 Float Gain when transducer D1* (upstream) is receiving a signal • GainD1* 28-31 Float • GainD2* 32 Enum-8 Gain when transducer D2* (downstream stream) is receiving a signal Units decibel codes • HART Units enum for all gain points read. Must be dB units (see Table 11-11). Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined 78 Error Command 165 Read path gains HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.37 January 2014 Command 166 Read flow analysis configuration This command reads flow analysis configuration data. See Table 11-8 for flow velocity units and Table 11-1 for volume units. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Related database points 0-3 Float • FlowAnalysisLowFlowLmt 4-7 Float • FlowAnalysisHighFlowLmt 8-11 Float • ReverseFlowVolLmt 12-15 Float • ReverseFlowDetectionZeroCut 16 Enum-8 Reads the database point Flow Analysis Low Flow Limit Reads the database point Flow Analysis High Flow Limit Reads the database point Reverse Flow Volume Limit Reads the database point Reverse Flow Detection Zero Cut. This value is a flow velocity and has the same units as the other flow velocity values in this message. Reads the Units code enum for flow velocity • Units code for all flow velocity values in this message. See Table 11-8. 17 Enum-8 Reads the Units code for volume values • Units code for ReverseFlowVolLmt. See Table 11-1 18 Enum-8 19 Enum-8 Enables reverse flow detection. Reads the • database point Reverse Flow Detection Enabled Are Baselines Available. If this database point is • FALSE, the baselines are not available to be set in the meter (does not apply to this meter type). The DD can use this variable to disable the baseline menus. IsReverseFlowDetectionEnabled IsAnyBaselineAvail Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 166 Read flow analysis configuration 79 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.38 Command 167 Write flow analysis configuration This command writes flow analysis related data. See Table 11-1 for flow volume units code and Table 11-8 velocity units codes. Request data bytes Byte Format Description 0-3 Float 4-7 Float 8-11 Float Writes the database point Flow Analysis Low • Flow Limit Writes the database point Flow Analysis High • Flow Limit Writes the database point Reverse Flow Volume • Limit 12-15 Float 16 Enum-8 17 Enum-8 18 Enum-8 Explanation FlowAnalysisLowFlowLmt FlowAnalysisHighFlowLmt ReverseFlowVolLmt Writes the database point Reverse Flow Detection Zero Cut Units code for reverse flow velocity values. This unit applies to all flow values including Reverse Flow Limit. This must be a units code that is valid for velocity. See Table 11-8. • ReverseFlowDetectionZeroCut • ReverseFlowVolLmt velocity units code Units code for Reverse Flow volume values(see Table 11-1) Enable for reverse flow detection. Writes the point Reverse Flow Detection Enabled • ReverseFlowVolLmt • IsReverseFlowDetectionEnabled. This is an informational variable; when written, it is not updated in the device. Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection 3 Error Passed Parameter Too High 4 Error 5 6 7 8-17 18 Error Error Error 19-31 32 33-127 80 Error Error Explanation Boolean neither 0 or 1 Passed Parameter Too Low • • • Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Invalid Units Code • The units code for velocity or volume is not valid Alarm limit too high Alarm limit too low (or negative) Undefined Busy Undefined Command 167 Write flow analysis configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.39 January 2014 Command 168 Read general meter information Reads the General meter information for use in the device information screen. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Related database point 0-1 Unsigned Integer Packed ASCII Reads the database point Device Number • 2-7 8-19 Packed ASCII Reads a PACKED ASCII string, the major and the • minor version number, followed by spaces padded out to 8 characters. This string is not stored in nvram but is created from the CPUBdSwIntVer by the HART Slave. The string will be in the format%d.%d (major.minor), numbers only Reads the database point MeterSerialNumber • converted to a PACKED ASCII 16 character string. If serial number is shorter than 16 characters, the number will be padded with spaces, if it is longer than 16 characters, the number will be truncated to 16 characters. DeviceNumber FirmwareVersion MeterSerialNumber Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error Command 168 Read general meter information 81 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.40 Command 169 Read flow totals This command reads the flow totals. The flow totals will be sent as 4 byte integers rolling over at 999,999,999 so that same mechanism used in Modbus for flow totals can be used. See Table 111, Table 11-2, and Table 11-3 for volume, energy flow rate, and mass flow rate units code values. Request data bytes Byte Format Description Explanation None Response data bytes Byte Format 0-3 • PosVolFlow • NegVolFlow • PosVolBase • NegVolBase • PosEnergy • NegEnergy • PosMass • NegMass 32 Unsigned-32 Reads the database point PosVolFlow with a maximum limit of 999,999,999 Unsigned-32 Reads the database point NegVolFlow with a maximum limit of 999,999,999. Unsigned-32 Reads the database point PosVolBase with a maximum limit of 999,999,999. Unsigned-32 Reads the database point NegVolBase with a maximum limit of 999,999,999 Unsigned-32 Reads the database point PosEnergy with a maximum limit of 999,999,999 Unsigned-32 Reads the database point NegEnergy with a maximum limit of 999,999,999 Unsigned-32 Reads the database point PosMass with a maximum limit of 999,999,999 Unsigned-32 Reads the database point NegMass with a maximum limit of 999,999,999 Enum-8 Units code for volume • Units code for all volume related values in this message. This must be a valid units code for volume values.See Table 11-1. 33 Enum-8 Units code for mass values • Units code for all mass related values in this message. This must be a valid units code for mass values. Table 11-3. 34 Enum-8 Units code for energy values • Units code for all energy values in this message. This must be a valid units code for energy values. Table 11-2. 4-7 8-11 12-15 16-19 20 - 23 24-27 28-31 Description Related database points Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined 82 Error Error Command 169 Read flow totals HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.41 January 2014 Command 170 Read flow analysis related configuration This command reads alarm limits and Booleans related to some features enabled with the Flow Analysis key. The alarm limits in this message are always in Percentages. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 171 Write flow analysis related configuration. Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined Error Command 170 Read flow analysis related configuration 83 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.42 Command 171 Write flow analysis related configuration This command writes alarm limits and Booleans related to some features activated with the Flow Analysis key. The alarm limits for this message are always in Percentages. Request data bytes Byte Format Description Explanation 0-3 Float Sound Velocity Compare Error Limit • Alarm limit on the error between the optional AGA10-calculated sound velocity and the meter-calculated sound velocity. 4-7 Float Abnormal Profile Detection Limit • Alarm limit when the flow profile of the meter is abnormal and is configured as part of the Continuous Flow Analysis Alerts setup. 8 Enum-8 Abnormal Profile Detection Enabled • The abnormal profile detection alarm is enabled when the optional continuous flow analysis key is enabled and the meter device number is 3400 or 3422. 9 Enum-8 Sound Velocity Compare Enabled • Sound Velocity Comparison is enabled when the optional continuous flow analysis key is enabled and the GC HCH method (AGA-8)is set to detailed method. 10 Enum-8 Bore Buildup Enabled • Bore Buildup detection is enabled when the optional continuous flow analysis key is enabled and there may be a possible buildup of material in meter bore. Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection 3 Error Passed Parameter Too High 4 Error Passed Parameter Too Low 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined 84 Error Explanation • • • Boolean neither 0 or 1 Alarm limit too high Alarm limit too low (or negative) Command 171 Write flow analysis related configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.43 January 2014 Command 172 Write Ethernet configuration This command writes configuration parameters for the Ethernet port(s). Request data bytes Byte Format Description Explanation 0 Unsigned-8 Ethernet port selector 1-15 Latin-1 Ethernet port IP address • Writes Ethernet Port Number IP Address. This must be in the format X.X.X.X where each X is 0 to 255. Meter must validate that this is a valid IP address. If it is shorter than 15 characters, it will be padded with zeros (0x00). 16-30 Latin-1 Ethernet port subnet mask • Writes Ethernet Port Number Subnet Mask. This must be in the format X.X.X.X where each X is 0 to 255. Meter must validate that this is a valid subnet mask. If it is shorter than 15 characters, it will be padded with zeros (0x00). 31-45 Latin-1 Ethernet default gateway address • Writes Ethernet Port Number Default Gateway Address. This must be in the format X.X.X.X where each X is 0 to 255. Meter must validate that this is a valid IP address. If it is shorter than 15 characters, it will be padded with zeros (0x00). 46-49 Unsigned-32 Alternate TCP port used for Modbus TCP • Writes Ethernet Port Number Alternate Modbus Port. 50 Unsigned-8 Ethernet port Modbus ID • Writes Ethernet Port Number Modbus ID Select which Ethernet Port Number to configure. 0=Eth1 This is an informational variable; when written, it is not updated in the device. • Response data bytes Same as Request data bytes. Command 172 Write Ethernet configuration 85 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Command-specific response codes Code Class Description Explanation 0 1 2 Success Error No Command-Specific errors Undefined Invalid selection • Indicates the Ethernet port selector was invalid. 3 Error Passed parameter too large • The value written for Ethernet Port Number Alternate Modbus Port is above a maximum limit. 4 Error Passed parameter too small • The value written for Ethernet Port Number Alternate Modbus Port is below a minimum limit. 5 6 7-28 29 Error Error Error Error Too few bytes received Device-Specific command error Undefined Invalid IP format • Either Ethernet port IP address, Ethernet port subnet mask or Ethernet default gateway address format is invalid or value written for Ethernet Port Number Alternate Modbus Port is reserved. 30-31 32 33-127 Error Undefined Busy Undefined 86 Command 172 Write Ethernet configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.44 January 2014 Command 173 Read Ethernet Configuration This command reads the configuration parameters for the Ethernet port(s). Request data bytes Byte Format Description 0 Unsigned-8 Ethernet port selector Explanation Selects which Ethernet port to read. 0=Eth1 • Response data bytes Same as Command 172 Write Ethernet configuration. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific errors Undefined Invalid selection • 3-4 5 6 7-31 32 33-127 Error Error Error Error The Ethernet port selector requested does not exist in this field device. (This shall be returned if the index is not 0). Undefined Too few bytes received Device-Specific command error Undefined Busy Undefined Command 173 Read Ethernet Configuration 87 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.45 Command 174 Write serial port configuration This command writes configuration parameters for the Serial ports. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Serial port selector 1 Enum-8 Communication port availability 2 Enum-8 Communication port baud rate 3 4 Unsigned-8 Enum-8 Communication port Modbus ID Hardware protocol on Communication port 5 Unsigned-8 Communication port response delay Selects which serial port to read. • 0=Port A • 1=Port B This is an informational Index variable; when written, it is not updated in the device. Is Port X Available • 0=Not available • 1=Available This is an informational Index variable; when written, it is not updated in the device. Writes to Baud Port X • 0=1200 • 1=2400 • 2=9600 • 3=19200 • 4=38400 • 5=57600 • 6=115200) Constant units of bits per second. Writes to Modbus ID Port X. Writes Driver Selection Port X for Port A only. For all other ports this must be written 0. Writes CommRspDlyPort X. Constant units of millisecond. 6 7-8 Unsigned-8 Unsigned-16 Communication port timeout value Communication port handshaking RTS off delay time. 9-10 Unsigned-16 Communication port handshaking RTS on delay time 11 Unsigned-8 Inactivity timeout for PPP connections Writes CommTCPTimeoutPort X. Constant units of second. 12 Enum-8 Enable communication port hardware flow control Writes IsHWFlowControlEnabledPort X for Port A only. For all other ports this must be written 0. 13-14 Unsigned-16 Maximum Datagram Size Writes CommTCPMaxDatagramSizePort X Writes RTSOffDelayPort X for Port A only. For all other ports this must be written 0. Constant units of millisecond. Writes RTSOnDelayPort X for Port A. For all other ports this must be written 0. Constant units of millisecond. Response data bytes Same as request data bytes. 88 Command 174 Write serial port configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Command-specific response codes Code 0 Class Description Success No Command-Specific Errors 1 Explanation Undefined 2 Error Invalid Selection The serial port requested does not exist in this field device. Also indicates BaudPort X or IsHWFlowControlEnabledPort X is invalid. 3 Error Passed Parameter too Large Indicates ModbusIDPort X, DriverSelectionPort X, CommRspDlyPort<PortNumber>, RTSOffDelayPort X, RTSOnDelayPort X, CommTCPTimeoutPort X or CommTCPMaxDatagramSizePort X is above a maximum limit. 4 Error Passed Parameter too Small Indicates ModbusIDPort X, DriverSelectionPort X, CommRspDlyPort X, RTSOffDelayPort X, RTSOnDelayPort X, CommTCPTimeoutPort X or CommTCPMaxDatagramSizePort X is below a minimum limit. 5 Error Too Few Bytes Received 6 Error Device-Specific Command Error 7-31 32 33-127 Undefined Error Busy Undefined Command 174 Write serial port configuration 89 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.46 Command 175 Read serial port configuration This command reads configuration parameters for the Serial ports. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Serial port selector 0=Port A, 1=Port B. Used to select which serial port to read. Response data bytes Same as Command 174 Write serial port configuration. Command-specific response codes Code 0 Class Description Success No Command-Specific Errors Error Invalid Selection 1 2 Undefined 3-4 Error Too Few Bytes Received 6 Error Device-Specific Command Error 7-31 32 90 The serial port requested does not exist in this field device. Undefined 5 33-127 Explanation Undefined Error Busy Undefined Command 175 Read serial port configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.47 January 2014 Command 176 Write transducer chord configuration This command writes configuration parameters for each transducer chord. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Transducer chord selector Used to select which transducer chord to configure. • 0=Chord A • 1=Chord B • 2=Chord C • 3=Chord D. 1 2-5 6-9 10-13 Enum-8 Float Float Float Chord inactive control Chord “X” dimension Chord “L” dimension Chord average delay time 14-17 Float Chord delta delay time 18 Enum-8 Unit code for all lengths (Table 11-15) This is an information index variable; when written, it is not updated in the device. Writes to ChordInactv<Chord> Writes to X<Chord> Write to L<Chord> Writes AvgDly<Chord>. Constant units of microsecond. Writes DltDly<Chord>.Constant units of microsecond. Unit code of length. This must be a valid units code for length values (HARTLengthUnit). This is an information index variable, it is not updated in the device. Response data bytes Same as request data bytes. Command-specific response codes Code Class Description 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection 3 Error Passed Parameter too Large 4 Error Passed Parameter too Small 5 6 7 8-17 19-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Undefined Busy Undefined Error Command 176 Write transducer chord configuration Explanation Indicates transducer chord selector or ChordInactv<Chord> is invalid. (This shall be returned if the selector is not 0, 1, 2 or 3; or if ChordInactv<Chord> is not 0 or 1.) Indicates X<Chord>, L<Chord>, AvgDly<Chord> or DltDly<Chord> is above a maximum limit. Indicates X<Chord>, L<Chord>, AvgDly<Chord> or DltDly<Chord> is below a minimum limit. 91 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.48 Command 177 Read transducer chord configuration This command reads configuration parameters for each transducer chord. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Transducer chord selector Used to select which transducer chord to read. • 0=Chord A • 1=Chord B • 2=Chord C • 3=Chord D Response data bytes Same as Command 176 Write transducer chord configuration. Command-specific response codes Code Class Description 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection 3-4 5 6 7-31 32 33-127 92 Error Error Error Error Explanation The transducer chord selector requested does not exist in this field device. (This shall be returned if the selector is not 0, 1, 2 or 3.) Undefined Too Few Bytes Received Device-Specific Command Error Undefined Busy Undefined Command 177 Read transducer chord configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.49 January 2014 Command 178 Write polynomial calibration configuration This command writes calibration configuration parameters for a particular direction. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Direction selector 1-4 Float Factory calibration A0 coefficient 5-8 9-12 Float Float Factory calibration A1 coefficient Factory calibration A2 coefficient 13-16 Float Factory calibration A3 coefficient 17-20 Float Factory calibration C0 coefficient 21-24 25-28 Float Float Factory calibration C1 coefficient Factory calibration C2 coefficient 29-32 Float Factory calibration C3 coefficient Used to select which direction to configure. • 0=Reverse <Rev> • 1=Forward <Fwd>. This is an informational index variable; when written, it is not updated in the device. Writes to <Dir>A0. Constant units of meters per second. Writes to <Dir>A1 Writes to <Dir>A2. Constant units of seconds per meter. Writes to <Dir>A3. Constant units of seconds squared per meter squared. Writes to <Dir>C0. Constant units of meters per second. Writes to <Dir>C1 Writes to <Dir>C2. Constant units of seconds per meter. Writes to <Dir>C3. Constant units of seconds squared per meter squared. Response data bytes Same as request data bytes. Command-specific response codes Code Class Description 0 1 2 3 Success Error Error No Command-Specific Errors Undefined Invalid Selection Passed Parameter too Large 4 Error Passed Parameter too Small 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Error Command 178 Write polynomial calibration configuration Explanation Indicates the direction selector is invalid. Indicates <Dir>A0, <Dir>A1, <Dir>A2, <Dir>A3, <Dir>C0, <Dir>C1, <Dir>C2 or <Dir>C3 is above a maximum limit. Indicates <Dir>A0, <Dir>A1, <Dir>A2, <Dir>A3, <Dir>C0, <Dir>C1, <Dir>C2 or <Dir>C3 is below a minimum limit. 93 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.50 Command 179 Read polynomial calibration configuration This command reads calibration configuration parameters for a particular direction. Request data bytes Byte Format Description 0 Unsigned-8 Direction selector Explanation Used to select which direction to read. 0=Reverse <Rev> 1=Forward <Fwd> • • Response data bytes Same as command 178 Write polynomial calibration coefficients. Command-specific response codes Code Class Description 0 1 2 3-4 5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Invalid Selection Undefined Too Few Bytes Received Device-Specific Command Error Undefined Busy Undefined 94 Error Error Error Error Explanation Indicates the direction selector is invalid. Command 179 Read polynomial calibration configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.51 January 2014 Command 182 Write archive log configuration This command writes configuration parameters for the archive logs. Request data bytes Byte Format Description Explanation 0-1 Unsigned-16 Writes AlarmTurnOffHysterisisCount 2-3 Unsigned-16 Alarm log hysteresis filter number of occurrences Alarm log hysteresis filter time span 4 Enum-8 5 Enum-8 6 Enum-8 7 Enum-8 8 Enum-8 Writes AlarmTurnOffHysterisisTimeSpan. Constant units of second. Old unread alarm log records can be overwrit- Writes DoOverwriteUnreadAlarmLog ten Old unread audit log records can be overwrit- Writes DoOverwriteUnreadAuditLog ten Old unread hourly log records can be overWrites DoOverwriteUnreadHourlyLog written Old unread daily log records can be overwrit- Writes DoOverwriteUnreadDailyLog ten Writes DoOverwriteUnreadSystemLog Old unread system log records can be overwritten Response data bytes Same as request data bytes. Command-specific response codes Code Class Description 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection 3 Error Passed Parameter too Large 4 Error Passed Parameter too Small 5 6 7-31 32 33-127 Error Error Too Few Bytes Received Device-Specific Command Error Undefined Busy Undefined Error Command 182 Write archive log configuration Explanation Indicates DoOverwriteUnreadAlarmLog, DoOverwriteUnreadAuditLog, DoOverwriteUnreadHourlyLog, DoOverwriteUnreadDailyLog or DoOverwriteUnreadSystemLog is invalid. Indicates AlarmTurnOffHysterisisCount or AlarmTurnOffHysterisisTimeSpan is above a maximum limit. Indicates AlarmTurnOffHysterisisCount or AlarmTurnOffHysterisisTimeSpan is below a minimum limit. 95 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.52 Command 183 Read Archive Log configuration This command reads configuration parameters for the archive logs. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 182 Write Archive Log Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined 96 Error Error Explanation Command 183 Read Archive Log configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.53 January 2014 Command 184 Write acquisition configuration This command writes configuration parameters that control how the meter acquires data. *Note: Chords C and D are unavailable for Model 3412 and Model 3411 meters. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Writes VelHold 1 Unsigned-8 2-3 Enum-16 4-7 Float Number of batches to hold velocity constant when re-acquiring. Maximum number of consecutive batches without new data Specified batch update period (may be overridden if stacking is selected) Desired transducer firing (emission) rate 8-11 Float 12 Enum-8 13 Unsigned-8 14-15 Unsigned-16 16 Enum-8 17 Enum-8 18 Enum-8 19-20 Unsigned-16 21-22 23 Unsigned-16 Unsigned-8 24 Unsigned-8 25 Enum-8 26 Enum-8 Desired stacking transducer firing (emission) rate Transducer firing sequence selector Minimum number of operating chords for valid measurement Number of consecutive batches that a chord must fail before declared "hard failed" Meter installed backwards control Writes MaxNoDataBatches Writes SpecBatchUpdtPeriod. Constant Units of millisecond. Writes EmRateDesired. Constant units of millisecond. Writes StackEmRateDesired. Constant units of millisecond. Writes FireSeq • 0=B1,B2,C1,C2,A1,A2,D1,D2* • 1=A1,A2,B1,B2,C1,C2,D1,D2* • 2=A1,B1,C1,D1,A2,B2,C2,D2* Writes MinChord Writes AlarmDef Writes FlowDir 0=Meter in normal direction 1=Meter in reverse direction Enables dithering (progressive jitter after each Writes DitherEnable transducer firing) • 0=Disable • 1=Enable) Customer-calibration method selector Writes CalMethod • 0=None • 1=Polynomial • 2=Piece-wise linear Writes PropUpdtBatches Number of consecutive batches without chord failures required for updating chord proportions. Chord proportions update factor Writes NumVals Minimum percentage of good measurements Writes MinPctGood. Constant units of percent. for working chord Number of sequences between gain/hold Writes BatchSize time/tracking updates Co-located meter mode Writes ColocMeterMode • 0=Disable • 1=Primary • 2=Secondary Applicable for Four Chord meters, for others will always be Disable (0). Transducer firing synchronization Writes XdcrFiringSync • 0=Disable • 1=Enable Applicable only if ColocMeterMode is not disabled (0), else will always be Disable (0). Command 184 Write acquisition configuration • • 97 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Response data bytes Same as Request Data Bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • Error • • Indicates SpecBatchUpdtPeriod, FlowDir, CalMethod or XdcrFiringSync is invalid. Also indicates ColocMeterMode or XdcrFiringSync cannot be written because of inter-dependency. Also indicates SpecBatchUpdtPeriod cannot be written because of dependency with StackSize or Filter. 3 Error Passed Parameter too Large • Indicates VelHold, SpecBatchUpdtPeriod, MaxNoDataBatches, EmRateDesired, StackEmRateDesired, FireSeq, MinChord, AlarmDef, CalMethod, DitherEnable, PropUpdtBatches, NumVals, MinPctGood, BatchSize or ColocMeterMode is above a maximum limit. 4 Error Passed Parameter too Small • Indicates VelHold, SpecBatchUpdtPeriod, MaxNoDataBatches, EmRateDesired, StackEmRateDesired, FireSeq, MinChord, AlarmDef, CalMethod, DitherEnable, PropUpdtBatches, NumVals, MinPctGood, BatchSize or ColocMeterMode is below a minimum limit. 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined 98 Error Command 184 Write acquisition configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.54 January 2014 Command 185 Read acquisition configuration This command reads configuration parameters that control how the meter acquires data. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 184 Write Acquisition Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 185 Read acquisition configuration Explanation 99 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.55 Command 186 Write meter limits This command writes meter flow and SOS limit parameters. Request data bytes Byte Format Description Explanation 0-3 Float Writes CRange. Constant units of percent. 4-7 Float 8-11 12-15 16-19 20-23 24-27 28-31 32-35 36 Float Float Float Float Float Float Float Unsigned-8 37 Enum-8 Maximum percentage chord sound speed deviation Velocity threshold below which the flow velocity is considered zero Maximum meter velocity Minimum sound speed Maximum sound speed Sound velocity lo-alarm limit Sound velocity hi-alarm limit Minimum flow velocity for CRange test Maximum flow velocity for CRange test Minimum velocity for updating chord proportions Unit code of velocity Writes ZeroCut Writes MeterMaxVel Writes SSMin Writes SSMax Writes AvgSoundVelLoLmt Writes AvgSoundVelHiLmt Writes SndSpdChkMinVel Writes SndSpdChkMaxVel Writes LowFlowLmt Unit code of velocity (Table 11-8). This is an informational variable; when written, it is not updated in the device. Response data bytes Same as Request data bytes. 100 Command 186 Write meter limits HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • Error • • Indicates ZeroCut is above FlowAnalysisLowFlowLmt. Also indicates SSMin is above SSMax. Also indicates SndSpdChkMinVel is above SndSpdChkMaxVel. 3 Error Passed Parameter too Large • Indicates CRange, ZeroCut, MeterMaxVel, SSMin, SSMax, AvgSoundVelLoLmt, AvgSoundVelHiLmt, SndSpdChkMinVel, SndSpdChkMaxVel or LowFlowLmt is above a maximum limit. 4 Error Passed Parameter too Small • Indicates CRange, ZeroCut, MeterMaxVel, SSMin, SSMax, AvgSoundVelLoLmt, AvgSoundVelHiLmt, SndSpdChkMinVel, SndSpdChkMaxVel or LowFlowLmt is below a minimum limit. 5 6 7 8-17 18 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Invalid Units Code • Indicates that an invalid units code was written 19-31 32 33-127 Error Error Undefined Busy Undefined Command 186 Write meter limits 101 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.56 Command 187 Read meter limits This command reads meter flow and SOS limit parameters. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 186 Write meter limits. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined 102 Error Error Explanation Command 187 Read meter limits HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.57 January 2014 Command 188 Write meter body configuration This command writes meter body configuration parameters. Request data bytes Byte Format Description Explanation 0-3 4-7 8-11 Float Float Float Writes PipeDiam Writes PipeOutsideDiameter Writes YoungsModulus 12-15 Float 16-19 20-23 24-27 28-31 32 Float Float Float Float Enum-8 Pipe inside diameter Pipe outside diameter Young’s Modulus value (tensile stress to tensile strain ratio) Poisson's Ratio value (absolute ratio of lateral strain to axial strain) Linear expansion coefficient Reference temperature for linear expansion Pressure-effect expansion coefficient Pipe wall roughness Unit code of length for Pipe Diameter, PipeOutside Diameter 33 34 35 36 37 38 39 40 Enum-8 Enum-8 Enum-8 Enum-8 Enum-8 Enum-8 Enum-8 Enum-8 Variable classification code for Wall Roughness Unit code of length for Wall Roughness Variable classification code for Young’s Modulus Unit code of Pressure for Young’s Modulus Variable classification code for Linear Expansion Coefficient Unit code of thermal expansion for Linear Expansion Coefficient Unit code of temperature for Reference Temperature Linear Expansion Coefficient Unit code of pressure for Reference Pressure Expansion Coefficient Command 188 Write meter body configuration Writes PoissonsRatio Writes LinearExpansionCoef Writes RefTempLinearExpCoef Writes RefPressExpCoef Writes WallRoughness Unit code of length (Table 11-15). This is an informational variable; when written, it is not updated in the device. Must be 69. This is an informational variable; when written, it is not updated in the device. Unit code of length (Table 11-15). This is an informational variable; when written, it is not updated in the device. Must be 65. This is an informational variable; when written, it is not updated in the device. This must be a valid units code for pressure values (Table 11-6). This is an informational variable; when written, it is not updated in the device. Must be 107. This is an informational variable; when written, it is not updated in the device. Unit code of thermal expansion (Table 11-16). Note: Unit code 170 (Inverse degrees Celsius) is used when HARTTemperatureUnit is either Degrees Celsius or Kelvin. This is an informational variable; when written, it is not updated in the device. Unit code of temperature (Table 11-7). This is an informational variable; when written, it is not updated in the device. Unit code of pressure (Table 11-6). This is an informational variable; when written, it is not updated in the device. 103 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Response data bytes Same as request data bytes. Command-specific response codes Code Class Description 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection 3 Error Passed Parameter too Large 4 Error Passed Parameter too Small 5 6 7 8-17 18 19-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Invalid Units Code Undefined Busy Undefined 104 Error Error Explanation Indicates PipeDiam is above PipeOutsideDiameter. Indicates PipeDiam, PipeOutsideDiameter, YoungsModulus, PoissonsRatio, LinearExpansionCoef, RefTempLinearExpCoef, RefPressExpCoef, or WallRoughness is above a maximum limit. Indicates PipeDiam, PipeOutsideDiameter, YoungsModulus, PoissonsRatio, LinearExpansionCoef, RefTempLinearExpCoef, RefPressExpCoef or WallRoughness is below a minimum limit. Indicates that an invalid units code was written Command 188 Write meter body configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.58 January 2014 Command 189 Read meter body configuration This command reads meter body configuration parameters. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 188 Write meter body configuration. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 189 Read meter body configuration Explanation 105 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.59 Command 190 Write signal parameters This command writes parameters used to configure transducer firing and sampling and detection limits. Request data bytes Byte Format Description Explanation 0 1 2 3-6 7 8-11 12 13-16 Unsigned-8 Unsigned-8 Unsigned-8 Unsigned-32 Unsigned-8 Float Unsigned-8 Float 17 18-21 Enum-8 Float First peak amplitude threshold Parameter used to locate the signal start Minimum signal-to-noise threshold Maximum noise energy threshold Minimum acceptable signal quality Transducer frequency Number of cycles for transducer Sampling (rate) interval. Changing this value requires re-booting the meter. Samples per cycle Minimum sampling hold time 22-25 Float Maximum sampling hold time 26-29 30-33 34-37 38-41 Float Float Float Float 42-45 46-49 Float Float Measurement Quality check deviation factor Minimum negative pulse width Minimum positive pulse width Transit time standard deviation threshold for measurement quality check Maximum selected peak pulse width Delta time check parameter Writes Pk1Thrsh Writes Pk1Pct. Constant unit of (%). Writes SNRatio Writes MaxNoise Writes MinSigQlty Writes XdcrFreq. Constant units of kHz. Writes XdcrNumDriveCycles Writes SampInterval. Constant units of nanosecond. Writes SampPerCycle Writes MinHoldTime. Constant units of microsecond. Writes MaxHoldTm. Constant units of microsecond. Writes TmDevFctr1 Writes NegSpan. Constant units of microsecond. Writes PosSpan. Constant units of microsecond. Writes TmDevLow1. Constant units of microsecond. Writes Pk1Wdth. Constant units of microsecond. Writes DltChk. Constant units of microsecond. Response data bytes Same as request data bytes. 106 Command 190 Write signal parameters HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • Error • Indicates Pk1Pct, XdcrFreq, SampInterval, SampPerCycle is invalid. Also indicates MinHoldTime is above MaxHoldTm. 3 Error Passed Parameter too Large • Indicates Pk1Thrsh, Pk1Pct, SNRatio, MaxNoise, MinSigQlty, XdcrFreq, XdcrNumDriveCycles, SampInterval, MinHoldTime, MaxHoldTm, TmDevFctr1, NegSpan, PosSpan, TmDevLow1, Pk1Wdth, SampPerCycle or DltChk is above a maximum limit. 4 Error Passed Parameter too Small • Indicates Pk1Thrsh, Pk1Pct, SNRatio, MaxNoise, MinSigQlty, XdcrFreq, XdcrNumDriveCycles, SampInterval, MinHoldTime, MaxHoldTm, TmDevFctr1, NegSpan, PosSpan, TmDevLow1, Pk1Wdth, SampPerCycle or DltChk is below a minimum limit. 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Error Command 190 Write signal parameters 107 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.60 Command 191Read signal parameters This command reads parameters for transducer firing and sampling and detection limits. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 190 Write Signal Parameters. Command-specific response codes Code Class Description 0 1-31 32 33-127 Success No Command-Specific Errors Undefined Busy Undefined 108 Error Explanation Command 191Read signal parameters HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.61 January 2014 Command 192 Write target parameters This command writes target parameters used for signal detection. Request data bytes Byte Format Description 0 1 2 3 Unsigned-8 Unsigned-8 Unsigned-8 Unsigned-8 Default tracking target Pf distance Tracking target Pf distance low limit Tracking target Pf distance high limit Tracking target Pf sensitivity 4 5 6 7 Signed-8 Signed-8 Signed-8 Unsigned-8 8-9 Unsigned-16 10 11 Signed-8 Unsigned-8 12 Unsigned-8 13 Unsigned-8 14-17 18-21 22-25 Float Float Float 26 Unsigned-8 Explanation Writes Tspf. Constant units of sample intervals. Writes TspfLo. Constant units of sample intervals. Writes TspfHi. Constant units of sample intervals. Writes TspfSen. Constant units of sample intervals. Default tracking target Pe distance Writes Tspe. Constant units of sample intervals. Tracking target Pe distance low limit Writes TspeLo. Constant units of sample intervals. Tracking target Pe distance high limit Writes TspeHi. Constant units of sample intervals. Tracking target Pe sensitivity Writes TspeSen. Constant units of sample intervals. Tracking target abs (Pe-Pf) limit Writes TspeLmt. Constant units of sample intervals. Default tracking target normalized amplitude Writes Tamp. Constant units of percent. Tracking target normalized amplitude low Writes TampLo. Constant units of percent. limit Tracking target normalized amplitude high Writes TampHi. Constant units of percent . limit Tracking target normalized amplitude sensiWrites TampSen. Constant units of percent. tivity Tracking target Pf weighting factor Writes TspfWt Tracking target Pe weighting factor Writes TspeWt Tracking target normalized amplitude Writes TampWt weighting factor Track parameter auto reset threshold: Writes TspfMatch. Constant unit of percent. 0=always reset, 100=disable auto reset Response data bytes Same as request data bytes. Command 192 Write target parameters 109 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • Error • • Indicates TspfLo is above TspfHi or Tspf is below TspfLo or Tspf is above TspfHi. Indicates TspeLo is above TspeHi or Tspe is below TspeLo or Tspe is above TspeHi. Indicates TampLo is above TampHi or Tamp is below TampLo or Tamp is above TampHi. 3 Error Passed Parameter too Large • Indicates Tspf, TspfLo, TspfHi, TspfSen, Tspe, TspeLo, TspeHi, TspeSen, TspeLmt, Tamp, TampLo, TampHi, TampSen, TspfWt, TspeWt, TampWt or TspfMatch is above a maximum limit. 4 Error Passed Parameter too Small • Indicates Tspf, TspfLo, TspfHi, TspfSen, Tspe, TspeLo, TspeHi, TspeSen, TspeLmt, Tamp, TampLo, TampHi, TampSen, TspfWt, TspeWt, TampWt or TspfMatch is below a minimum limit. 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined 110 Error Command 192 Write target parameters HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.62 January 2014 Command 193 Read target parameters This command read target parameters used for signal detection. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 192 Write Target Parameters. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 193 Read target parameters Explanation 111 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.63 Command 194 Reset chord proportions to defaults This command executes operation to reset chord proportions to default values (writes to data point ResetProp internally). Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description None Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined 112 Error Error Explanation Command 194 Reset chord proportions to defaults HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.64 January 2014 Command 195 Enter/exit fixed frequency output mode This command puts the selected frequency output in or out of test mode. Note: The effect of this Command command is not retained through a device reset or removal of power from the field device. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Frequency output selector • • 1 2 Enum-8 Unsigned-8 Enables/Disables test mode. Percentage of scale to output on frequency output. (Valid range from 0 to 150). 0=Pair 1 1=Pair 2. This is an informational index variable; when written, it is not updated in the device. Writes IsFreq<FrequencyNumber>EnableTest Writes Freq<FrequencyNumber>TestModeOutputPercent. Constant unit of percent. Response data bytes Byte Format Description Explanation 0 Unsigned-8 Percentage of scale to output on frequency output. (Valid range from 0 to 150). Freq<FrequencyNumber>TestModeOutputPercent. Constant unit of percent. This is an integer value in the database. Command-specific response codes Code Class Description 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection 3 Error Passed Parameter too Large 4 Error Passed Parameter too Small 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Error Command 195 Enter/exit fixed frequency output mode Explanation Indicates frequency output selector is invalid. Also indicates IsFreq<FrequencyNumber>EnableTest is invalid. Indicates Freq<FrequencyNumber>TestModeOutputPercent is above a maximum limit. Indicates Freq<FrequencyNumber>TestModeOutputPercent is below a minimum limit. 113 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.65 Command 196 Enter/exit fixed digital output mode This command puts the selected digital output in or out of test mode. Note: The effect of this Command command is not retained through a device reset or removal of power from the field device. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Digital output selector 0=Pair 1, 1=Pair 2. Enables/Disables test mode Digital output phase A test mode value Digital output phase B test mode value This is an INFO INDEX variable; when written, it is not updated in the device. Writes DO<DigitalNumber>PairTestEnable Writes DO<DigitalNumber>ATestVal. Writes DO<DigitalNumber>BTestVal. 1 2 3 Enum-8 Enum-8 Enum-8 Response data bytes Byte Format Description None Command-specific response codes Code Class Description 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection 3-4 5 6 7 8-31 32 33-127 114 Error Error Error Error Error Explanation Indicates digital output selector is invalid. Also indicates: • DO< DigitalNumber >PairTestEnable • DO<DigitalNumber>ATestVal or • DO<DigitalNumber>BTestVal is invalid Undefined Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Command 196 Enter/exit fixed digital output mode HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.66 January 2014 Command 197 Set transducer type This command sets the transducer type and returns the values of the affected configuration parameters. Request data bytes Byte Format Description Explanation 1 Unsigned-8 Sets up tracking parameters to default values for a particular model of transducer • Writes SetXdcrType. Response data bytes Byte Format Description Explanation 0-3 Float Transducer frequency 4 Unsigned-8 Number of cycles for transducer 5-8 Float 9 Enum-8 Sampling (rate) interval. Changing this value requires re-booting the meter. Samples per cycle • • • 10 Unsigned-8 Default tracking target Pf distance 11 Unsigned-8 12 Unsigned-8 13 Signed-8 14 Signed-8 15-18 Float 19-22 Float 23-26 Float 27-30 Float measurement quality check Maximum peak pulse width 31-34 Float Delta time check parameter • • Tracking target Pf distance low limit • Tracking target Pf distance high limit • Default tracking target Pe distance • Default tracking target normalized amplitude • Minimum negative pulse width • Minimum positive pulse width • Transit time standard deviation threshold for • • • XdcrFreq. Constant units of sample kHz. XdcrNumDriveCycles SampInterval. Constant units of nanosecond. SampPerCycle Tspf. Constant units of sample intervals. TspfLo. Constant units of sample intervals. TspfHi. Constant units of sample intervals. Tspe. Constant units of sample intervals. Tamp. Constant units of percent. NegSpan. Constant units of microsecond. PosSpan. Constant units of microsecond. TmDevLow1. Constant units of microsecond. Pk1Wdth. Constant units of microsecond. DltChk. Constant units of microsecond. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • 3-4 5 6 7 8-31 32 33-127 Error Error Error Error Error Indicates SetXdcrType is invalid Undefined Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Command 197 Set transducer type 115 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.67 Command 198 Write Frequency/Digital Output sources This command writes the sources for Command 198 Write Frequency/Digital Output sources. Request data bytes Byte Format Description Explanation 0 Enum-8 Frequency/Digital Output 1 availability • 1 Enum-8 Source assigned to Frequency/Digital Output 1 2 Enum-8 Frequency/Digital Output 1 Mode 3 Enum-8 Frequency/Digital Output 2 availability 4 Enum-8 5 Enum-8 6 Enum-8 7 Enum-8 8 Enum-8 116 Indicates the presence of the first Frequency Output /Digital Output 1 port. This is an informational variable; when written, it is not updated in the device Writes Frequency/Digital Output 1Source • 0 = Frequency Output 1A • 1 = Frequency Output 1B • 4 = Digital Output 1A • 5 = Digital Output 1B Frequency/Digital Output 1Mode • 0 = TTL • 1 = open collector • Indicates the presence of the second Frequency Output /Digital Output port (Frequency/Digital Output 2). This is an informational variable; when written, it is not updated in the device. Source assigned to Frequency/Digital Output 2 Writes Frequency/Digital Output 2Source • 0 = FrequeNcy Output 1A • 1 = FrequencY Output 1B • 2 = FrequencY Output 2A • 3 = Frequency Output 2B • 4 = DigiTal Output 1A • 5 = DigiTal Output 1B • 6 = DigitaL Output 2A • 6 = DigitaL Output 2A • 7 = Digital Output 2B Frequency/Digital Output 2 Mode Frequency/Digital Output 1Mode • 0 = TTL • 1 = open collector Frequency/Digital Output 3 availability • Indicates the presence of the third Frequency Output / Digital Output port (Frequency/ Digital Output 3).This is an informational variable; when written, it is not updated in the device Source assigned to Frequency/Digital Output 3 Writes Frequency/Digital Output 3Source • 0 = FrequeNcy Output 1A • 1 = FrequenCy Output 1B • 2 = FrequenCy Output 2A • 3 = FrequenCy Output 2B • 4 = DigItal Output 1A • 5 = DigitAl Output 1B • 6 = DigitAl Output 2A • 7 = DigiTal Output 2B Frequency/Digital Output 3 Mode Frequency/Digital Output 1Mode • 0 = TTL • 1 = open collector Command 198 Write Frequency/Digital Output sources HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection 3-4 5 6 7 8-31 32 33-127 Error Indicates FODO1Source, FODO1Mode, FODO2Source, FODO2Mode, FODO3Source or FODO3Mode is invalid. Undefined Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Error Error Error Error 10.1.68 Explanation Command 199 Read Frequency/Digital Output sources This command reads the Frequency/Digital Output source settings. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 198 Write Frequency/Digital Output Sources Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 199 Read Frequency/Digital Output sources Explanation 117 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.69 Command 200 Write miscellaneous write protected parameters This command is used to write miscellaneous write protected parameters. Request data bytes Byte Format Description Explanation 0 1 Unsigned-8 Unsigned-8 Number of Master command preamble bytes Non-normal operation timeout 2 3 Unsigned-8 Enum-8 4 Enum-8 Writes HARTMinNumPreambles Writes NonNormalModeTimeout. Constant units of minute. Hour of day to log daily record in military time Writes ContractHour Modbus access units system Writes UnitsSystem • 0=U.S. Customary • 1=Metric Flow rate time unit for Modbus communicaWrites VolFlowRateTimeUnit tions • 0=Second • 1=Hour • 2=Day Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1-2 3 Success Error No Command-Specific Errors Undefined Passed Parameter too Large • Indicates HARTMinNumPreambles, NonNormalModeTimeout, UnitsSystem or VolFlowRateTimeUnit is above a maximum limit. 4 Error Passed Parameter too Small • Indicates HARTMinNumPreambles, NonNormalModeTimeout, UnitsSystem or VolFlowRateTimeUnit is below a minimum limit. 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined 118 Error Command 200 Write miscellaneous write protected parameters HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.70 January 2014 Command 201 Write analog input calibration This command writes configuration parameters analog input calibration. Request data bytes Byte Format Description 0 Unsigned-8 Analog input selector Explanation Used to select which analog input to configure. 0= Temperature 1=Pressure • • This is an informational index variable; when written, it is not updated in the device. 1-4 Float Live flow condition calibration offset value • 5-8 Float Live flow condition calibration gain value • 9 Enum-8 Unit code for live flow condition calibration offset value Writes to LiveFlow<PressureTemperature>Offset. Writes to LiveFlow<Pressure/Temperature>Gain. Unit code for only the live flow condition calibration offset value. This must be a valid units code for Pressure (HARTPressureUnit) (when Analog input selector is 1 i.e., Pressure) or a valid units code for Temperature (HARTTemperatureUnit) (when Analog input selector is 0 i.e Temperature). This is an informational variable; when written, it is not updated in the device. Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection • Indicates that analog input requested does not exist in this field device (This shall be returned if the index is not 0 or 1). 3 Error Passed Parameter too Large • Indicates LiveFlow<Pressure/Temperature>Offset or LiveFlow<Pressure/ Temperature>Gain is above a maximum limit. • 4 Error Passed Parameter too Small • Indicates LiveFlow<Pressure/ Temperature>Offset or LiveFlow<Pressure/ Temperature>Gain is below a minimum limit. 5 6 7 8-17 18 Error Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Invalid Units Code • Indicates that an invalid units code was written Error Busy 19-31 32 Command 201 Write analog input calibration 119 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 Code 33-127 120 3-9000-761 Rev 3 Class Description Explanation Undefined Command 201 Write analog input calibration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.71 January 2014 Command 202 Read analog input calibration This command reads configuration parameters analog input calibration. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Analog input selector Selects which analog input to read. • 0=Temperature • 1=Pressure Response data bytes Same as Command 201 Write analog input calibration. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • 3-4 5 6 7-31 32 33-127 Error Error Error Error The analog input requested does not exist in this field device (This shall be returned if the index is not 0 or 1). Undefined Too Few Bytes Received Device-Specific Command Error Undefined Busy Undefined Command 202 Read analog input calibration 121 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.72 Command 203 Write piecewise linearization flow rates This command writes piecewise linearization flow rates configuration. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Direction selector Used to select which direction to configure. • 0=Reverse <Rev> • 1=Forward <Fwd> This is an informational index variable; when written, it is not updated in the device. 1-4 Float 5-8 Float 9-12 Float Piecewise linearization volumetric flow rate 1 Piecewise linearization volumetric flow rate 2 Piecewise linearization volumetric flow rate 3 13-16 Float Piecewise linearization volumetric flow rate 4 17-20 Float Piecewise linearization volumetric flow rate 5 21-24 Float Piecewise linearization volumetric flow rate 6 25-28 Float Piecewise linearization volumetric flow rate 7 29-32 Float Piecewise linearization volumetric flow rate 8 33-36 Float Piecewise linearization volumetric flow rate 9 37-40 Float 41-44 Float 45-48 Float 49 Enum-8 Piecewise linearization volumetric flow rate 10 Piecewise linearization volumetric flow rate 11 Piecewise linearization volumetric flow rate 12 Unit code for volumetric flow rate • Writes to <Dir>FlwRt1 • Writes to <Dir>FlwRt2 • • • • • • • • Writes to <Dir>FlwRt3 • Writes to <Dir>FlwRt11 • Writes to <Dir>FlwRt12 Writes to <Dir>FlwRt4 Writes to <Dir>FlwRt5 Writes to <Dir>FlwRt6 Writes to <Dir>FlwRt7 Writes to <Dir>FlwRt8 Writes to <Dir>FlwRt9 Writes to <Dir>FlwRt10 Unit code for piecewise linearization volumetric flow rate values. This must be a valid units code for volumetric flow rate (refer to Table 11-5 derived as per selection of HARTVolUnit and HARTRateTimeUnit). This is an informational index variable; when written, it is not updated in the device. Response data bytes Same as Request data bytes. 122 Command 203 Write piecewise linearization flow rates HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Command-specific response codes Code Class Description Explanation 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection • Indicates that flow direction requested does not exist in this field device (This shall be returned if the index is not 0 or 1). 3 Error Passed Parameter too Large • Indicates <Dir>FlwRt1, <Dir>FlwRt2, <Dir>FlwRt3, <Dir>FlwRt4, <Dir>FlwRt5, <Dir>FlwRt6, <Dir>FlwRt7, <Dir>FlwRt8, <Dir>FlwRt9, <Dir>FlwRt10, <Dir>FlwRt11 or <Dir>FlwRt12 is above a maximum limit. 4 Error Passed Parameter too Small • Indicates <Dir>FlwRt1, <Dir>FlwRt2, <Dir>FlwRt3, <Dir>FlwRt4, <Dir>FlwRt5, <Dir>FlwRt6, <Dir>FlwRt7, <Dir>FlwRt8, <Dir>FlwRt9, <Dir>FlwRt10, <Dir>FlwRt11 or <Dir>FlwRt12 is below a minimum limit. 5 6 7 8-17 18 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Invalid Units Code • Indicates that an invalid units code was written. 19-31 32 33-127 Error Error Undefined Busy Undefined Command 203 Write piecewise linearization flow rates 123 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.73 Command 204 Read piecewise linearization flow rates This command reads piecewise linearization flow rates configuration. Request data bytes Byte Format Description 0 Unsigned-8 Direction selector Explanation Used to select which direction to read. 0=Reverse <Rev> 1=Forward <Fwd> • • Response data bytes Same as command 203 Write Piecewise Linearization Flow Rates. Command-specific response codes Code Class Description 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection 3-4 5 6 7-31 32 33-127 124 Error Error Error Error Explanation The flow direction requested does not exist in this field device (This shall be returned if the index is not 0 or 1). Undefined Too Few Bytes Received Device-Specific Command Error Undefined Busy Undefined Command 204 Read piecewise linearization flow rates HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.74 January 2014 Command 205 Write piecewise linearization meter factors This command writes piecewise linearization meter factors configuration. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Direction selector Used to select which direction to configure. • 0=Reverse <Rev> • 1=Forward <Fwd> This is an informational index variable; when written, it is not updated in the device. 1-4 Float Piecewise linearization meter factor 1 5-8 Float Piecewise linearization meter factor 2 9-12 Float Piecewise linearization meter factor 3 13-16 Float Piecewise linearization meter factor 4 17-20 Float Piecewise linearization meter factor 5 21-24 Float Piecewise linearization meter factor 6 25-28 Float Piecewise linearization meter factor 7 29-32 Float Piecewise linearization meter factor 8 33-36 Float Piecewise linearization meter factor 9 37-40 Float Piecewise linearization meter factor 10 41-44 Float Piecewise linearization meter factor 11 45-48 Float Piecewise linearization meter factor 12 • • • • • • • • • • • • Writes to <Dir>MtrFctr1 Writes to <Dir>MtrFctr2 Writes to <Dir>MtrFctr3 Writes to <Dir>MtrFctr4 Writes to <Dir>MtrFctr5 Writes to <Dir>MtrFctr6 Writes to <Dir>MtrFctr7 Writes to <Dir>MtrFctr8 Writes to <Dir>MtrFctr9 Writes to <Dir>MtrFctr10 Writes to <Dir>MtrFctr11 Writes to <Dir>MtrFctr12 Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection • Indicates that flow direction requested does not exist in this field device (This shall be returned if the index is not 0 or 1). 3 Error Passed Parameter too Large • Indicates <Dir>MtrFctr1, <Dir>MtrFctr2, <Dir>MtrFctr3, <Dir>MtrFctr4, <Dir>MtrFctr5, <Dir>MtrFctr6, <Dir>MtrFctr7, <Dir>MtrFctr8, <Dir>MtrFctr9, <Dir>MtrFctr10, <Dir>MtrFctr11 or <Dir>MtrFctr12 is above a maximum limit. Command 205 Write piecewise linearization meter factors 125 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Code Class Description Explanation 4 Error Passed Parameter too Small • 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Error 10.1.75 Indicates <Dir>MtrFctr1, <Dir>MtrFctr2, <Dir>MtrFctr3, <Dir>MtrFctr4, <Dir>MtrFctr5, <Dir>MtrFctr6, <Dir>MtrFctr7, <Dir>MtrFctr8, <Dir>MtrFctr9, <Dir>MtrFctr10, <Dir>MtrFctr11 or <Dir>MtrFctr12 is below a minimum limit. Command 206 Read piecewise linearization meter factors This command reads piecewise linearization meter factors configuration. Request data bytes Byte Format Description 0 Unsigned-8 Direction selector Explanation Used to select which direction to read. 0=Reverse <Rev> 1=Forward <Fwd> • • Response data bytes Same as command 205 Write Piecewise Linearization Meter Factors. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • 3-4 5 6 7-31 32 33-127 126 Error Error Error Error The flow direction requested does not exist in this field device (This shall be returned if the index is not 0 or 1). Undefined Too Few Bytes Received Device-Specific Command Error Undefined Busy Undefined Command 206 Read piecewise linearization meter factors HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.76 January 2014 Command 207 Write meter text This command writes meter information related texts. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Text selector Used to select which meter text to configure. • 0=MeterName • 1=StationName • 2=Address • 3=City • 4=StateAndCountry • 5=UserScratch1 • 6=UserScratch2 1-64 Latin-1 Meter Text This is an informational index variable; when written, it is not updated in the device. Writes to MeterName, StationName, Address, City, StateAndCountry, UserScratch1 or UserScratch2 depending upon Text selector index selection. If text is shorter than 64 characters, it will be padded with zeros (0x00). Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection 3-4 5 6 7 8-29 30 31 32 33-127 Error Error Error Error Warning Error Undefined Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Command Response Truncated Explanation Indicates that meter text requested does not exist in this field device (This shall be returned if the index is not 0, 1, 2, 3, 4, 5 or 6). Indicates meter text was longer than can be displayed over the HART interface and was replaced by shorter text. Undefined Busy Undefined Command 207 Write meter text 127 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.77 Command 208 Read meter text This command reads meter information related texts. Request data bytes Byte Format Description Explanation 0 Unsigned-8 Text selector Used to select which meter text to read. • 0=MeterName • 1=StationName • 2=Address • 3=City • 4=StateAndCountry • 5=UserScratch • 6=UserScratch2 Response data bytes Same as command 207 Write meter text. Command-specific response codes Code Class Description 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection 3-4 5 6-31 32 33-127 128 Error Error Error Explanation Indicates that meter text requested does not exist in this field device (This shall be returned if the index is not 0, 1, 2, 3, 4, 5 or 6). Undefined Too Few Bytes Received Undefined Busy Undefined Command 208 Read meter text HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.78 January 2014 Command 209 Write gas chromatograph configuration This command writes gas chromatograph configuration parameters. Request data bytes Byte Format Description Explanation 0 Enum-8 Serial port to use for GC communication 1 2 Enum-8 Enum-8 GC communication protocol GC communication baud rate 3 Unsigned-8 GC communication timeout value 4 5 6 Unsigned-8 Unsigned-8 Unsigned-8 7 Enum-8 8 Enum-8 9 Enum-8 10 Enum-8 GC Modbus address Stream for the data read from the GC GC communication desired stream timeout value GC communication heating value type selector. Unit for reading the heating value from the GC Selects gas composition source for AGA8 and AGA10 calculations Selects the gas property data source to use when the GC is in alarm condition Used to select which serial port to configure for GC communication. • 0=Disabled • 1=Port A • 2=Port B • 3=Port C Writes GCSerialPort. Writes GCProtocol (0=ASCII, 1=RTU) Writes GCBaud • 0=1200 • 1=2400 • 2=9600 • 3=19200 • 4=38400 • 5=57600 • 6=115200 Constant units of bits per second. Writes GCCommTimeout. Constant units of second. Writes GCModbusID Writes GCStreamNumber Writes GCDesiredStreamTimeout. Constant units of minute. Writes GCHeatingValueType Writes GCHeatingValueUnit Writes GasPropertiesSrcSel Writes GasPropertiesSrcSelGCAlarm Response data bytes Same as Request data bytes. Command 209 Write gas chromatograph configuration 129 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Command-specific response codes Code Class Description 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection Error Explanation • • • GCBaud selection is invalid. Also indicates GCSerialPort selected is not available. Also indicates GasPropertiesSrcSel selected as Live when GCSerialPort is disabled or vice versa. 3 Error Passed Parameter too Large • Indicates GCSerialPort, GCProtocol, GCCommTimeout, GCModbusID, GCStreamNumber, GCDesiredStreamTimeout, GCHeatingValueType, GCHeatingValueUnit, GasPropertiesSrcSel or GasPropertiesSrcSelGCAlarm is above a maximum limit. 4 Error Passed Parameter too Small • Indicates GCSerialPort, GCProtocol, GCCommTimeout, GCModbusID, GCStreamNumber, GCDesiredStreamTimeout, GCHeatingValueType, GCHeatingValueUnit, GasPropertiesSrcSel or GasPropertiesSrcSelGCAlarm is below a minimum limit. 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined 130 Error Command 209 Write gas chromatograph configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.79 January 2014 Command 210 Read gas chromatograph configuration This command reads gas chromatograph configuration parameters. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 209 Write Gas Chromatograph Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 210 Read gas chromatograph configuration Explanation 131 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.80 Command 211 Write AGA8 method configuration This command writes AGA8 method configuration parameters. Request data bytes Byte Format Description 0 Enum-8 AGA8 method selector 1-4 Float Base condition temperature 5-8 Float Base condition pressure 9-12 Float 13-16 Float Reference temperature for specific gravity (relative density) Reference (absolute) pressure for specific gravity (relative density) Reference temperature for molar density 17-20 Float 21-24 Float 25-28 Float 29-32 Float 33-36 Float 37 Enum-8 Reference (absolute) pressure for molar density Volumetric gross heating value Volumetric gross heating value reference temperature Gas specific gravity (relative density) Unit code for TBase, RefTemperatureGr, RefTemperatureMolarDensity, RefTemperatureHV values Explanation Writes HCH_Method 0=External 1=Gross Method 1 2=Gross Method 2 3=Detailed Method 4=None • • • • • • • • Writes TBase Writes PBase Writes RefTemperatureGr • Writes RefPressureGr • • Writes RefTemperatureMolarDensity • • Writes MeasVolGrossHeatingVal • • Writes SpecificGravity Writes RefPressureMolarDensity Writes RefTemperatureHV Unit code of temperature for TBase, RefTemperatureGr, RefTemperatureMolarDensity, RefTemperatureHV values. This must be a valid units code for temperature values (HARTTemperatureUnit). This is an informational variable; when written, it is not updated in the device. 38 Enum-8 Unit code for PBase, RefPressureGr, RefPressureMolarDensity values • Unit code of pressure for PBase, RefPressureGr, RefPressureMolarDensity values. This must be a valid units code for pressure values (HARTPressureUnit). This is an informational variable when written, it is not updated in the device. 39 132 Enum-8 Variable classification code for MeasVolGross- • Must be 108. HeatingVal This is an informational variable; when written, it is not updated in the device. Command 211 Write AGA8 method configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Byte Format Description Explanation 40 Enum-8 Unit code for MeasVolGrossHeatingVal value • Unit code of volumetric heating value for MeasVolGrossHeatingVal value. This must be a valid units code for volumetric heating value values (HARTHeatingValueUnit). This is an informational variable; when written, it is not updated in the device. Response data bytes Same as Request Data Bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection • Indicates HCH_Method selected is Gross Method 1, Gross Method 2 or Detailed Method when EnablePressureInput and EnableTemperatureInput are None. 3 Error Passed Parameter too Large • Indicates HCH_Method, TBase, PBase, RefTemperatureGr, RefPressureGr, RefTemperatureMolarDensity, RefPressureMolarDensity, MeasVolGrossHeatingVal, RefTemperatureHV or SpecificGravity is above a maximum limit. 4 Error Passed Parameter too Small • Indicates HCH_Method, TBase, PBase, RefTemperatureGr, RefPressureGr, RefTemperatureMolarDensity, RefPressureMolarDensity, MeasVolGrossHeatingVal, RefTemperatureHV or SpecificGravity is below a minimum limit. 5 6 7 8-17 18 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Invalid Units Code • Indicates that an invalid units code was written 19-31 32 33-127 Error Error Undefined Busy Undefined Command 211 Write AGA8 method configuration 133 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.81 Command 212 Read AGA8 method configuration This command reads AGA8 method configuration parameters. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 211 Write AGA8 Method Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined 134 Error Error Explanation Command 212 Read AGA8 method configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.82 January 2014 Command 213 Write detailed gas composition This command writes detailed gas composition configuration parameters. Request data bytes Byte Format Description Explanation • • • • • • • • • • • • • • • • • • 0-3 Float Methane gas component 4-7 Float Ethane gas component 8-11 Float Propane gas component 12-15 Float Water gas component 16-19 Float Hydrogen sulfide gas component 20-23 Float Oxygen gas component 24-27 Float Isobutane gas component 28-31 Float N-Butane gas component 32-35 Float Isopentane gas component 36-39 Float N-Pentane gas component 40-43 Float N-Hexane gas component 44-47 Float N-Heptane gas component 48-51 Float N-Octane gas component 52-55 Float N-Nonane gas component 56-59 Float N-Decane gas component 60-63 Float Helium gas component 64-67 Float Argon gas component 68 Enum-8 Unit code for gas component values Writes MoleFractionMethane Writes MoleFractionEthane Writes MoleFractionPropane Writes MoleFractionWater Writes MoleFractionH2S Writes MoleFractionOxygen Writes MoleFractionIsoButane Writes MoleFractionNButane Writes MoleFractionIsoPentane Writes MoleFractionNPentane Writes MoleFractionNHexane Writes MoleFractionNHeptane Writes MoleFractionNOctane Writes MoleFractionNNonane Writes MoleFractionNDecane Writes MoleFractionHelium Writes MoleFractionArgon Unit code of percent for gas component values (refer to Table 11-14). This is an informational variable; when written, it is not updated in the device. Response data bytes Same as Request bytes. Command 213 Write detailed gas composition 135 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Command-specific response codes Code Class Description Explanation 0 1-2 3 Success Error No Command-Specific Errors Undefined Passed Parameter too Large • Indicates MoleFractionMethane, MoleFractionEthane, MoleFractionPropane, MoleFractionWater, MoleFractionH2S, MoleFractionOxygen, MoleFractionIsoButane, MoleFractionNButane, MoleFractionIsoPentane, MoleFractionNPentane, MoleFractionNHexane, MoleFractionNHeptane, MoleFractionNOctane, MoleFractionNNonane, MoleFractionNDecane, MoleFractionHelium OR MoleFractionArgon is above a maximum limit. 4 Error Passed Parameter too Small • Indicates MoleFractionMethane, MoleFractionEthane, MoleFractionPropane, MoleFractionWater, MoleFractionH2S, MoleFractionOxygen, MoleFractionIsoButane, MoleFractionNButane, MoleFractionIsoPentane, MoleFractionNPentane, MoleFractionNHexane, MoleFractionNHeptane, MoleFractionNOctane, MoleFractionNNonane, MoleFractionNDecane, MoleFractionHelium OR MoleFractionArgon is below a minimum limit. 5 6 7-17 18 Error Error Too Few Bytes Received Device-Specific Command Error Undefined Invalid Units Code • Indicates that an invalid units code was written 19-31 32 33-127 136 Error Error Undefined Busy Undefined Command 213 Write detailed gas composition HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.83 January 2014 Command 214 Read detailed gas composition This command reads detailed gas composition configuration parameters. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 213 Write Detailed Gas Composition Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error Command 214 Read detailed gas composition Explanation 137 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.84 Command 215 Write Gross Method 1 and 2 gas composition configuration This command writes gross method 1 and 2 gas composition configuration parameters. Request data bytes Byte Format Description Explanation 0-3 Float Carbon dioxide gas component • Writes MoleFractionCO2 4-7 Float Hydrogen gas component • Writes MoleFractionH2 8-11 Float Carbon monoxide gas component Float Nitrogen gas component • • Writes MoleFractionCO 12-15 16 Enum-8 Unit code for gas component values Writes MoleFractionN2Method2 Unit code of percent for gas component values (refer to Table 11-14). This is an informational variable; when written, it is not updated in the device. Response data bytes Same as Request Data Bytes. Command-specific response codes Code Class Description Explanation 0 1-2 3 Success Error No Command-Specific Errors Undefined Passed Parameter too Large • Indicates MoleFractionCO2, MoleFractionH2, MoleFractionCO or MoleFractionN2Method2 is above a maximum limit. 4 Error Passed Parameter too Small • Indicates MoleFractionCO2, MoleFractionH2, MoleFractionCO or MoleFractionN2Method2 is below a minimum limit. 5 6 7-17 18 Error Error Too Few Bytes Received Device-Specific Command Error Undefined Invalid Units Code • Indicates that an invalid unit code was written 19-31 32 33-127 138 Error Error Undefined Busy Undefined Command 215 Write Gross Method 1 and 2 gas composition configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.85 January 2014 Command 216 Read Gross Method 1 and 2 gas composition configuration This command reads gross method 1 and 2 gas composition configuration parameters. Request data bytes Byte Format Description Explanation None Response data bytes Same as Command 215 Write Gross Method 1 and 2 Gas Composition Configuration. Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined Error Error 10.1.86 Explanation Command 217 Write baseline times and comments Writes forward or reverse baseline date, time and comments depending upon first byte in the Command command request. If IsAnyBaselineAvail is FALSE, then this command will respond with success and existing baseline parameters are not updated in the meter. New baseline parameters are not written in the meter. Request data bytes Byte Format Description Explanation 0 Enum-8 Direction selector Used to select which direction to configure. • 0=Reverse <Rev> • 1=Forward <Fwd> This is an informational index variable; when written, it is not updated in the device. Note: Contrary to device-specific commands guideline 'Indices format should be Unsigned-<#bits>', format Enum-8 is used for uniformity with command 155 Write Baselines. 1-3 Date Date of Flow Baseline • Writes the Date part of database point XBaselineTime 4-7 Time Time of Flow Baseline • Writes the Time part of database point XBaselineTime 8-71 Latin-1 Comment to Flow Baseline • Writes the string database point XbaselineComment. If comment is shorter than 64 characters, it will be padded with zeros (0x00). Command 216 Read Gross Method 1 and 2 gas composition configuration 139 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection 3 Error Passed Parameter Too Large 4 5 6 7 8 9 Error Error Error Error Error Undefined Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Invalid Date Code Detected Warning Undefined Command Response is Truncated 10-29 30 31 32 33-127 140 Error Error Explanation • • Invalid value for Forward / Reverse Selection • • Invalid value for Date of Flow Baseline. Also indicates Xbaseline date and time is out of range Jan 1, 1970 00:00:00 UTC to Jan 19, 2038 03:14:07 UTC. • Indicates Xbaseline comment was longer than can be displayed over the HART interface and was replaced by shorter comment. Invalid value for Time of Flow Baseline Undefined Busy Undefined Command 217 Write baseline times and comments HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.87 January 2014 Command 218 Read baseline times and comments This command reads the forward or reverse baseline date, time and comments depending upon the parameter passed in the command request. Request data bytes Byte Format Description Explanation 0 Enum-8 Direction selector Used to select which direction to read. • 0=Reverse <Rev> • 1=Forward <Fwd> Response data bytes Same as command 217 Write baseline times and comments. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • 3-4 5 6-31 32 33-127 Error Error Error Invalid value for Forward / Reverse Selection Undefined Too Few Bytes Received Undefined Busy No Command-Specific Errors Command 218 Read baseline times and comments 141 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.88 Command 219 Reset tracking targets to defaults This command executes operation to reset tracking targets to default values (writes to data point ResetTrkParam internally). Request data bytes Byte Format Description Explanation None Response data bytes Byte Format Description Explanation None Command-specific response codes Code Class Description 0 1-5 6 7-31 32 33-127 Success No Command-Specific Errors Undefined Device-Specific Command Error Undefined Busy Undefined 142 Error Error Explanation Command 219 Reset tracking targets to defaults HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.89 January 2014 Command 220 Write local display configuration This command writes local display configuration parameters. Request data bytes Byte Format Description Explanation 0 Enum-8 Local display availability Indicates the presence of a local display (IsLocalDisplayAvail). 1 Enum-8 Local display item 1 Command 220 Write local display configuration This is an informational variable; when written, it is not updated in the device. Writes LocalDisplayItem1 • 0=None • 1=QFLOW - Uncorrected volume flow rate • 2=TDYVL - Current day's forward uncorrected volume • 3=TDYVL - Current day's reverse uncorrected volume • 4=YSTVL - Previous day's forward uncorrected volume • 5=YSTVL - Previous day's reverse uncorrected volume • 6=TOTVL - Forward uncorrected volume • 7=TOTVL - Reverse uncorrected volume • 26=QBASE - Corrected volume flow rate • 27=TDYVL - Current day's forward corrected volume • 28=TDYVL - Current day's reverse corrected volume • 29=YSTVL - Previous day's forward corrected volume • 30=YSTVL - Previous day's reverse corrected volume • 31=TOTVL - Forward corrected volume • 32=TOTVL - Reverse corrected volume • 8=VEL - Average flow velocity • 9=SOS - Average sound velocity • 10=TEMP - Flow-condition temperature • 11=PRESS - Flow-condition pressure • 12=FRQ1A - Frequency channel 1A • 13=FRQ1B - Frequency channel 1B • 14=KFCT1 - Frequency 1 K-factor • 15=FRQ2A - Frequency channel 2A • 16=FRQ2B - Frequency channel 2B • 17=KFCT2 - Frequency 2 K-factor • 24=AO1 - Analog Output 1 Current • 25=AO2 - Analog Output 2 Current 143 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Byte Format Description Explanation 2 Enum-8 Local display item 2 • Writes LocalDisplayItem2 (options same as mentioned for LocalDisplayItem1) 3 Enum-8 Local display item 3 • Writes LocalDisplayItem3 (options same as mentioned for LocalDisplayItem1) 4 Enum-8 Local display item 4 • Writes LocalDisplayItem4 (options same as mentioned for LocalDisplayItem1) 5 Enum-8 Local display item 5 • Writes LocalDisplayItem5 (options same as mentioned for LocalDisplayItem1) 6 Enum-8 Local display item 6 • Writes LocalDisplayItem6 (options same as mentioned for LocalDisplayItem1) 2 Enum-8 Local display item 2 • Writes LocalDisplayItem2 (options same as mentioned for LocalDisplayItem1) 3 Enum-8 Local display item 3 • Writes LocalDisplayItem3 (options same as mentioned for LocalDisplayItem1) 4 Enum-8 Local display item 4 • Writes LocalDisplayItem4 (options same as mentioned for LocalDisplayItem1) 5 Enum-8 Local display item 5 • Writes LocalDisplayItem5 (options same as mentioned for LocalDisplayItem1) 6 Enum-8 Local display item 6 • Writes LocalDisplayItem6 (options same as mentioned for LocalDisplayItem1) 7 Enum-8 Local display item 7 • Writes LocalDisplayItem7 (options same as mentioned for LocalDisplayItem1) 8 Enum-8 Local display item 8 • Writes LocalDisplayItem8 (options same as mentioned for LocalDisplayItem1) 9 Enum-8 Local display item 9 • Writes LocalDisplayItem9 (options same as mentioned for LocalDisplayItem1) 10 Enum-8 Local display item 10 • Writes LocalDisplayItem10 (options same as mentioned for LocalDisplayItem1) 11 Unsigned-8 Local display scroll delay • • 12 Enum-8 Volumetric flow rate time unit for the local display 13 Enum-8 U.S. Customary volume unit for the local display 14 Enum-8 Metric volume unit for the local display Writes LocalDisplayScrollDelay. Constant units of second. Writes LocalDisplayFlowRateTimeUnit • 0=Second • 1=Hour • 2=Day Writes LocalDisplayVolUnitUS • 0= Cubic feet • 3=Thousand cubic feet Writes LocalDisplayVolUnitMetric • 0= Cubic meters • 2=Thousand cubic meters Response data bytes Same as Request data bytes. 144 Command 220 Write local display configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 January 2014 Command-specific response codes Code Class Description Explanation 0 1 2 Success Error No Command-Specific Errors Undefined Invalid Selection • LocalDisplayItem1, LocalDisplayItem2, LocalDisplayItem3, LocalDisplayItem4, LocalDisplayItem5, LocalDisplayItem6, LocalDisplayItem7, LocalDisplayItem8, LocalDisplayItem9, LocalDisplayItem10, LocalDisplayFlowRateTimeUnit, LocalDisplayVolUnitUS or LocalDisplayVolUnitMetric invalid. 3 Error Passed Parameter too Large • Indicates LocalDisplayItem1, LocalDisplayItem2, LocalDisplayItem3, LocalDisplayItem4, LocalDisplayItem5, LocalDisplayItem6, LocalDisplayItem7, LocalDisplayItem8, LocalDisplayItem9, LocalDisplayItem10, LocalDisplayScrollDelay, LocalDisplayFlowRateTimeUnit, LocalDisplayVolUnitUS or LocalDisplayVolUnitMetric is above a maximum limit. 4 Error Passed Parameter too Small • Indicates LocalDisplayItem1, LocalDisplayItem2, LocalDisplayItem3, LocalDisplayItem4, LocalDisplayItem5, LocalDisplayItem6, LocalDisplayItem7, LocalDisplayItem8, LocalDisplayItem9, LocalDisplayItem10, LocalDisplayScrollDelay, LocalDisplayFlowRateTimeUnit, LocalDisplayVolUnitUS or LocalDisplayVolUnitMetric is below a minimum limit. 5 6 7 8-31 32 33-127 Error Error Error Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Error Command 220 Write local display configuration 145 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.90 Command 221 Read local display configuration This command reads local display configuration parameters. Request data bytes Byte Format Description Explanation None Response data bytes Same as command 220 Write local display configuration. Command-specific response codes Code 0 Class Description Success No Command-Specific Errors 1-5 6 Undefined Error Device-Specific Command Error Error Busy 7-31 32 33-127 146 Explanation Undefined Undefined Command 221 Read local display configuration HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.91 January 2014 Command 222 Enable local display test mode This command enables the local display test mode. Note: The effect of this Command command is not retained through a device reset or removal of power from the field device. Request data bytes Byte Format Description 1 Enum-8 Enables local display test mode Explanation Writes IsLocalDisplayEnableTest 0=Disable 1=Enable • • Response data bytes Byte Format Description Explanation None Command-specific response codes Code Class Description 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection 3-4 5 6 7-31 32 33-127 Error Error Error Error Explanation • • Indicates IsLocalDisplayEnableTest is invalid. Also indicates local display test mode cannot be enabled because local display is in Squawk mode. Undefined Too Few Bytes Received Device-Specific Command Error Undefined Busy Undefined Command 222 Enable local display test mode 147 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 10.1.92 Command 223 Write general meter information Writes general meter information for use in the device information screen. Request data bytes Byte Format Description Explanation 0-1 Unsigned-16 Device Number 2-13 Packed ASCII Meter Serial Number • • Writes DeviceNumber Writes MeterSerialNumber converted to a PACKED ASCII 16 character string. If serial number is shorter than 16 characters, the number will be padded with spaces. Response data bytes Same as Request data bytes. Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • 3-4 5 6 7 8-31 32 33-127 148 Error Error Error Error Error Indicates that Device Number requested does not exist in this field device. Undefined Too Few Bytes Received Device-Specific Command Error In Write Protect Mode Undefined Busy Undefined Command 223 Write general meter information HART Field Device Specification 3410 Series Ultrasonic Meter 10. Device-specific commands 3-9000-761 Rev 3 10.1.93 January 2014 Command 224 Write miscellaneous non-write protected parameters This command is used to write miscellaneous non-write protected parameters. Request data bytes Byte Format Description Explanation 0 Enum-8 Batch smoothing factor: specifies percentage total data to be taken from previous data Writes BatchPercentSmoothing. Constant Units of percent. 1 Enum-8 Stack size 2 Enum-8 Bandpass filter switch • • • • 3-6 Float • Writes SpecRhoMixFlow 7-10 Float • Writes SpecZFlow 11-14 Float • Writes SpecZBase 15-18 Float • Writes SpecCorrectionFactor 19-22 Float Specified (fixed) flow-condition gas mass density Specified (fixed) flow-condition gas compressibility Specified (fixed) base-condition gas compressibility Specified (fixed) profile-effect correction factor Natural gas mixture dynamic viscosity Enum-8 Unit code for SpecRhoMixFlow value • • Writes Viscosity 23 Writes StackSize Writes Filter – 0=Filter off – 1=Filter on) Unit code of density for SpecRhoMixFlow value. This must be a valid units code for density values (HARTDensityUnit). See Table 11-19. This is an informational variable; when written, it is not updated in the device. 24 Enum-8 Variable classification code for Viscosity • Must be 74. This is an informational variable; when written, it is not updated in the device. 25 Enum-8 Unit code for Viscosity • Unit code of Viscosity (HARTViscosityUnit). See Table 11-17. This is an informational variable; when written, it is not updated in the device. Response data bytes Same as Request data bytes. Command 224 Write miscellaneous non-write protected parameters 149 10. Device-specific commands HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 Command-specific response codes Code Class Description Explanation 0 1 2 Success No Command-Specific Errors Undefined Invalid Selection • Error • Indicates BatchPercentSmoothing, StackSize or Filter is invalid. Also indicates StackSize or Filter cannot be written because of dependency with SpecBatchUpdtPeriod. 3 Error Passed Parameter too Large • Indicates BatchPercentSmoothing, StackSize, SpecRhoMixFlow, SpecZFlow, SpecZBase, SpecCorrectionFactor or Viscosity is above a maximum limit. 4 Error Passed Parameter too Small • Indicates BatchPercentSmoothing, StackSize, SpecRhoMixFlow, SpecZFlow, SpecZBase, SpecCorrectionFactor or Viscosity is below a minimum limit. 5 6 7-17 18 Error Error Too Few Bytes Received Device-Specific Command Error Undefined Invalid Units Code • Indicates that an invalid units code was written. 19-31 32 33-127 Error Error 10.2 Undefined Busy Undefined Device-specific command error (response code 6) Following Universal and Common-practice commands support device-specific command error (Response code 6): Command Function Explanation 6 45 46 67 68 Write Polling Address Trim Loop Current Zero Trim Loop Current Gain Trim Analog Channel Zero Trim Analog Channel Gain Analog output test mode is enabled and loop current mode is disabled Loop current is not set to lower end value Loop current is not set to upper end value Loop current of selected analog channel is not set to lower end value Loop current of selected analog channel is not set to upper end value 150 Device-specific command error (response code 6) HART Field Device Specification 3410 Series Ultrasonic Meter 11. Tables 3-9000-761 Rev 3 January 2014 11. 11 Tables Units tables and conversion factors in this section are used for ultrasonic measurement. 11.1 Volume units Table 11-1 Volume units Unit Code Description 43 Cubic Meters 112 Cubic feet 11.2 Energy units Table 11-2 Energy rate Unit Code Description 164 Megajoules 240 Million BTU 11.3 Mass units Table 11-3 Mass units Unit Code Description 61 Kilograms 63 Pounds 11.4 Time units (flow rate) Table 11-4 Time units (flow rate) Unit Code Description 51 Second 52 Hour 53 Day Volume units 151 11. Tables HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 11.5 Volumetric flow rate units Table 11-5 Volumetric flow rate units Unit Code Description 19 Cubic meters per hour 26 Cubic feet per second 27 Cubic feet per day 28 Cubic meters per second 29 Cubic meters per day 130 Cubic feet per hour 11.6 Pressure units Table 11-6 Pressure units Unit Code Description 6 Pounds per square inch 11 Pascals 12 Kilopascals 237 Megapascals 180 IE6 Pounds per square inch 11.7 Temperature unit Table 11-7 Temperature units Unit Code Description 32 Degrees Celsius 33 Degrees Fahrenheit 35 Kelvin 11.8 Velocity units Table 11-8 Velocity units Unit Code Description 20 Feet per second 21 Meters per second 152 Pressure units HART Field Device Specification 3410 Series Ultrasonic Meter 11. Tables 3-9000-761 Rev 3 January 2014 11.9 Mass flow rate units Table 11-9 Mass flow rate units Unit Code Description 73 Kilograms per second 75 Kilograms per hour 76 Kilograms per day 80 Pounds per second 82 Pounds per hour 83 Pounds per day 11.10 Energy flow rate units Table 11-10 Mass low rate units Unit Code Description 241 Megajoules per second 141 Megajoules per hour 242 Megajoules per day 243 Million BTU per second 244 Million BTU per hour 245 Million BTU per day 11.11 Decibel units Table 11-11 Decibel units Unit Code Description 247 Decibels (dB) 11.12 Voltage units Table 11-12 Voltage units Unit Code Description 36 Millivolts 58 Volts 11.13 Current units Table 11-13 Current units Unit Code Description 39 Milliamps M ass flow rate units 153 11. Tables HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 11.14 Percent units Table 11-14 Percent units Unit Code Description 57 Percent 11.15 Length units Note This table refers to unit code expansion table for Length (variable classification code 69) values. Table 11-15 Length units Unit Code Description 45 Meters 47 Inches 170 Micrometer 171 Microinch 11.16 Thermal expansion units Note This table refers to unit code expansion table for Thermal Expansion (variable classification code 107 values. Table 11-16 Thermal Expansion units Unit Code Description 170 Inverse degrees Celsius 171 Inverse degrees Fahrenheit 154 Percent units HART Field Device Specification 3410 Series Ultrasonic Meter 11. Tables 3-9000-761 Rev 3 January 2014 11.17 Viscosity units Note This table refers to unit code expansion table for Viscosity (variable classification code 74) values. Table 11-17 Viscosity units Unit Code Description 55 Centipoise 170 Pascal second 11.18 Volumetric heating value units Table 11-18 Volumetric heating value units Unit Code Description 171 British thermal unit per cubic feet 170 Kilojoules per cubic decimeter 11.19 Density units Table 11-19 Density units Unit Code Description 92 Kilogram per cubic meter 94 Pound per cubic feet Viscosity units 155 11. Tables HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 11.20 Unit conversion factors Table 11-20 Conversion factors per unit of measurement Conversion Factors Unit of Measurement (°F-32)x(5/9)—>°C (°C+273.15)—>K 1 K/°C 5/9 °C/°F 10-6 MPa/Pa 0.006894757 MPa/psi 0.1 MPa/bar 0.101325 MPa/atm 0.000133322 MPa/mmHg 0.3048 m/ft 0.0254 m/in 103 dm3/m3 10-6 m3/cc (=m3/cm3) (0.3048)3 m3/ft3 (0.0254)3 m3/in3 3600 s/h 86400 s/day 103 g/kg 0.45359237 kg/lbm 4.1868 kJ/kcal 1.05505585262 kJ/ BtuIT 10-3 Pa•s/cPoise 1.488 Pa•s/(lb/(ft•s)) 156 Unit conversion factors HART Field Device Specification 3410 Series Ultrasonic Meter 11. Tables 3-9000-761 Rev 3 January 2014 11.21 Pressure and temperature tables Table 11-21 Pressure and temperature tables Input type Data validity (EnablePressureInput or (PressureValidity or EnableTemperatureInput) TemperatureValidity) Disabled Live Fixed 1. Data source upon alarm “In-use” data source (FlowPOrTSrcUponAlarm) (FlowPressure or FlowTemperature) N/A N/A “In-Use” value unchanged Valid1 N/A Average of live values (LiveFlowPressure or LiveFlowTemperature) Invalid Last good value “In-Use” value unchanged Fixed Fixed data point (SpecFlowPressure or SpecFlowTemperature) Valid1 N/A Fixed data point (SpecFlowPressure or SpecFlowTemperature) Invalid Last good value “In-Use” value unchanged Fixed Fixed data point (SpecFlowPressure or SpecFlowTemperature) Live input can be invalid due to (a) one or more live values is/are at or outside the alarm limits, or (b) the input is being calibrated. Pressure and temperature tables 157 11. Tables HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 11.21.1 Live Pressure Table 11-22 Data points for pressure inputs Daniel CUI display name Is pressure gage or absolute? Database points, options and guidelines Data points affected: • InputPressureUnit Options: • • Atmospheric pressure Gage (FALSE) Absolute (TRUE) Data points affected: • AtmosphericPress Options: • Enter a value (KPaa or psia) within the range [30.0, 108.40 KPaa] Guidelines: • Live pressure, Min input Data points affected: • • Enter the pressure (KPag or psig if gage, KPaa or psia if absolute) that corresponds to a 20 mA input signal. The pressure must be within the range [0, 280e3 KPag or KPaa]. Data points affected: • LowPressureAlarm Options: Enter a value (KPag or psig if gage, KPaa or psia if absolute) within the range [0, 280e3 KPag or KPaa]. An alarm is generated when the pressure is at or below this limit value. Data points affected: • HighPressureAlarm Options: • 158 MaxInputPressure Options: • Pressure alarm, High limit Enter the pressure (KPag or psig if gage, KPaa or psia if absolute) that corresponds to a 4 mA input signal. The pressure must be within the range [0, 280e3 KPag or KPaa]. Data points affected: • Pressure alarm, Low limit MinInputPressure Options: • Live pressure, Max input This data point is only applicable when the input pressure unit is specified as gage. Enter a value (KPag or psig if gage, KPaa or psia if absolute) within the range [0, 280e3 KPag or KPaa]. An alarm is generated when the pressure is at or above this limit value. Live Pressure HART Field Device Specification 3410 Series Ultrasonic Meter 11. Tables 3-9000-761 Rev 3 January 2014 11.21.2 Live Temperature Table 11-23 Data points for temperature inputs Daniel CUI display name Database points, options and guidelines Live temperature, Min input Data points affected: • • Live temperature, Max input Enter the temperature (°C or °F) that corresponds to a 4 mA input signal. The temperature must be within the range (-273.15 °C, 200 °C). Data points affected: • MaxInputTemperature Options: • Temperature alarm, Low limit MinInputTemperature Options: Enter the temperature (°C or °F) that corresponds to a 20 mA input signal. The temperature must be within the range (-273.15 °C, 200 °C). Data points affected: • LowTemperatureAlarm Options: • Temperature alarm, High limit Enter a value (°C or °F) within the range [-130 °C, 200 °C]. An alarm is generated when the temperature is at or below this limit value. Data points affected: • HighTemperatureAlarm Options: • Live Temperature Enter a value (°C or °F) within the range (-130 °C, 200 °C). An alarm is generated when the temperature is at or above this limit value. 159 11. Tables HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 3-9000-761 Rev 3 160 Live Temperature HART Field Device Specification 3410 Series Ultrasonic Meter 12. Performance 3-9000-761 Rev 3 12. 12 January 2014 Performance This section discusses the Daniel 3410 Series Ultrasonic Flow Meter performance capabilities. 12.1 Sampling rates The typical update rate of each HART® device and dynamic variable is once per second. Stack size and Filters are two operational conditions which cause variance in the update rate. Table 12-1 Sampling Rates Sensor Rate Primary temperature sensor Live values = 1/sec Calc. = on average of 5 sec Internal (cold-junction) sensor sample 1 per second PV digital value calculation SV digital value calculations Depends on Configuration Typical 1 per second Can be as long as 1 per 5 seconds Analog output update Depends on configuration 250ms Can be as long as 1 second 12.2 Power-up On power-up, when functioning correctly, the CPU Module green LED indicators show 3.3 volt and +24 volt power. A red LED for +24V current limit reached indicator. A pair of TX active and RX active green LED indicators are provided for each serial communication port. A pair of TX active and RX active green LED indicators are provided for the HART slave communication via Analog Output 1. All LED indicators are located on the card edge that is visible when the meter electronics enclosure end cap is removed. 12.3 Device reset This section describes the effect of Device Reset (Command 42) and any other reset methods. The device must respond to Command 42 before executing the Device reset. Command 42 forces the meter to perform a warm start (equivalent to cycling the power to the meter off and then back on). Table 12-2 Command 42 device reset Typical time to reset Maximum delay Mode(s) affected 120 seconds 180 seconds All modes are affected Sampling rates 161 12. Performance HART Field Device Specification 3410 Series Ultrasonic Meter January 2014 12.4 3-9000-761 Rev 3 Command response delay Table 12-3 shows the minimum, typical, and maximum delays before the device responds to a HART command (Timed from end of the stop bit of the Check Byte of the master request (STX), to the beginning of the start bit of the first preamble character of the response (ACK)). The response delay is not command specific, however, the write configuration commands generally require more time. Table 12-3 Command response delay Response Delay time Minimum 42ms Typical 60 ms Maximum 200 ms 12.4.1 Long messages Largest size of data field used for Commands 217 and 218 is 72 response bytes (including the two status bytes). 12.4.2 Non-volatile memory Daniel Liquid Ultrasonic Flow Meters use Flash and NVRAM technology for non-volatile memory. All configuration parameters are held in non-volatile memory until a “write command” is executed. Flash memory (the operating system kernel, the file system, and the firmware) is upgraded via Daniel MeterLink. Refer to the Daniel Ultrasonic Gas Flow Meter Reference, Installation, and Operations Manual (P/N 3-9000-743) or the Daniel 3410 Series Gas Ultrasonic Flow Meter Installation Manual (P/N 3-9000-759) Section 6.8, Upgrading the Meter Program for detailed instructions. http://www2.emersonprocess.com/en-US/brands/daniel/Flow/ultrasonics/Pages/Ultrasonic.aspx 12.4.3 Operating modes No alternative operating modes are available for this device. 12.4.4 Write protection Daniel Liquid Ultrasonic Flow Meters have a write protection hardware switch located on the CPU Module (labeled WRITE PROT. (see Figure 2-1 this manual). Refer to the Daniel Ultrasonic Gas Flow Meter Reference, Installation, and Operations Manual (P/N 3-9000-743), the Daniel 3410 Series Gas Ultrasonic Flow Meter Installation Manual (P/N 3-9000-759) or to the Daniel 3410 Series Gas Ultrasonic Flow Meter Operations Manual (P/N 3-9000-777). http://www2.emersonprocess.com/en-US/brands/daniel/Flow/ultrasonics/Pages/Ultrasonic.aspx HART Device-Specific Commands are rejected in write-protect mode (see Section 10.1 for a detailed list of applicable commands). 162 Command response delay HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 12.4.5 12. Performance January 2014 Damping value Damping value is defined as the output response to a step input reaches 63% of final steadystate value after this time has elapsed. The Damping Value is read via Universal Command 15 Damping time for Daniel 3410 Series Ultrasonic Meters is approximately 1.63 seconds affecting only the PV and the loop current signal and is calculated as a function of the batch period according to the equation below. The 0.015 seconds is the average time to perform the batch calculations and update the output. Equation 12-1 Damping calculation ( DampingValue(sec) = ( 2 – 0.37Batches )x ( sec perbatch ) ) + 0.015 sec The equation states that the worst case time for reaching 63% of the final steady-state value is 1.63 batch times after the step input. This case occurs when the step input occurs at 0.37 batch periods after the start of a batch. The 0.015 seconds is the average time to perform the batch calculations and update the output. Damping value 163 12. Performance January 2014 164 HART Field Device Specification 3410 Series Ultrasonic Meter 3-9000-761 Rev 3 Damping value HART Field Device Specification 3410 Series Gas Ultrasonic Meter Device capability checklist 3-9000-761 Rev 3 January 2014 Annex A. Device capability checklist A A.1 Device capability An overall checklist of the device capabilities is shown below. Table A-1 Capability checklist Manufacturer, model, and revision Daniel Measurement and Control, Inc. Daniel 3410 Series Ultrasonic Flow Meter Rev. 3 Device type Sensor HART protocol revision Rev. 7.0 Number and type of process connections 2 - Pressure and Temperature Number and type of host connections 2 - AMS™ Device Manager and Emerson 375/475 Field Communicator Number of Device Variables 8 Number of Dynamic Variables 4 Mappable Dynamic Variables? Yes Device description available Yes Number of Common-practice commands 18 Number of Device-specific commands 95 Bits of additional device status 46 (Command 48) Alternative operating modes? N/A (HART® Rev 7) Burst-Mode? No Capture Device Variable? No Write-protection? Yes Device capability 165 Device capability checklist January 2014 166 HART Field Device Specification 3410 Series Gas Ultrasonic Meter 3-9000-762 Rev 3 Device capability HART Field Device Specification 3410 Series Gas Ultrasonic Meter Default device configuration 3-9000-761 Rev 3 January 2014 Annex B. B B.1 Default device configuration Default factory settings Table B-1 shows a list of the default device configuration (parameter values, variable mapping, switch positions) which are factory set, unless user-specified when the device is ordered. Table B-1 Device factory settings configuration Parameter Default value AO1 Zero Scale Volume Flow Rate Lower Range Value • 0 (Cubic meters/hour) AO1 Full Scale Volume Flow Rat Upper Range Value • 200,000 (Cubic meters/hour) AO1 Content PV Unit(s) • Uncorrected Flow Rate (Cubic meters/hour) Sensor Type • Pressure/Temperature Number of Wires • 2 Damping Time Constant • ~1.64 Fault-indication • LED Status Indicators Write Protection switch • CPU Module (WRITE PROT. OFF) DHCP switch • CPU Module (DHCP ON) Number of Response Preambles • • 5 minimum 20 maximum Default factory settings 167 Default device configuration January 2014 168 HART Field Device Specification 3410 Series Gas Ultrasonic Meter 3-9000-761 Rev 3 Default factory settings HART Field Device Specification 3410 Series Gas Ultrasonic Meter Device variable calculations 3-9000-761 Rev 3 January 2014 Annex C. Device variable calculations C This section consists of the calculations used by Daniel3410 Series Ultrasonic Flow meters for the device variables summarized in Section 5. C.1 Uncorrected flow rate Equation C -1 Flow-condition volumetric flow rate Q Flow = ( Q Raw ) ( ExpCorr P ) ( ExpCorr T ) ( CorrFctr ) where Uncorrected flow rate Q Flow = flow-condition volumetric flow rate (m3/h) (QFlow) Q Raw = “raw” volumetric flow rate (m3/h) (QMeter) ExpCorr P = expansion correction factor due to pressure (dimensionless) (ExpCorrPressure) ExpCorr T = expansion correction factor due to temperature (dimensionless) (ExpCorrTemperature) CorrFctr = profile-effect correction factor (CorrectionFactor) 169 Device variable calculations HART Field Device Specification 3410 Series Gas Ultrasonic Meter January 2014 3-9000-761 Rev 3 C.2 Corrected flow rate Equation C -2 Base-condition volumetric flow rate Q Base = Q Flow P abs, f ------------------- P abs, b Tb ------ Tf Zb ------ Zf where 170 Q Base = “raw” volumetric flow rate (m3/h) (QMeter) Q Flow = flow-condition volumetric flow rate (m3/h) (QFlow) P abs, b = base-condition absolute pressure (MPaa) (PBase) P abs, f = flow-condition absolute pressure (MPaa) (AbsFlowPressure) Tb = base-condition temperature (K) (TBase) Tf = flow-condition temperature (K) (FlowTemperature) Zb = base-condition compressibility factor (ZBase) Zf = flow-condition compressibility factor (ZFlow) Corrected flow rate HART Field Device Specification 3410 Series Gas Ultrasonic Meter Device variable calculations 3-9000-761 Rev 3 January 2014 C.3 Average flow velocity C.3.1 Dry-calibration Equation C -3 Dry-calibration gas flow velocity 2 3 V DryCal = A 0 + A 1 V + A 2 V AvgWtd + A 3 V AvgWtd AvgWtd where V DryCal = dry-calibration gas flow velocity (m/s) (DryCalVel) V AvgWtd = average weighted gas flow velocity (m/s) (AvgWtdFlowVel) A0 = dry-calibration 0th order coefficient (m/s) (FwdA0 or RevA0) A1 = dry-calibration 1st order coefficient (dimensionless) (FwdA1 or RevA1) A2 = dry-calibration 2nd order coefficient (s/m) (FwdA2 or RevA2) A3 = dry-calibration 3rd order coefficient (s2/m2) (FwdA3 or RevA3) C.3.2 Wet-calibration Equation C -4 Wet-calibration gas flow velocity V WetCal = WetCalFunction(V DryCal) where V WetCal = wet-calibration gas flow velocity (m/s) (AvgFlow) V DryCal = dry-calibration gas flow velocity (m/s) (DryCalVel) WetCalFunction ( x ) = selected wet calibration function Average flow velocity 171 Device variable calculations HART Field Device Specification 3410 Series Gas Ultrasonic Meter January 2014 3-9000-761 Rev 3 C.3.3 Piece-wise linearization Equation C -5 Wet Calibration - 12-Point piece-wise linearization V WetCal = V DryCal ¥ LinearMeterFctr where V WetCal = wet-calibration gas flow velocity (m/s) (AvgFlow) V DryCal = dry-calibration gas flow velocity (m/s) (DryCalVel) LinearMeterFctr = linear meter factor (dimensionless) (LinearMeterFctr) C.3.4 Third-order polynomial Equation C -6 Wet Calibration - third-order polynomial 2 3 V WetCal = C 0 + C 1 V + C 2 V DryCal + C 3 V DryCal DryCal where C.3.5 V WetCal = wet-calibration gas flow velocity (m/s) (AvgFlow) V DryCal = dry-calibration gas flow velocity (m/s) (DryCalVel) C0 = wet-calibration 0th order coefficient (m/s) (FwdC0 or RevC0) C1 = wet-calibration 1st order coefficient (dimensionless) (FwdC1 or RevC1) C2 = wet-calibration 2nd order coefficient (s/m) (FwdC2 or RevC2) C3 = wet-calibration 3rd order coefficient (s2/m2) (FwdC3 or RevC3) No wet calibration See Equation C -3. 172 Piece-wise linearization HART Field Device Specification 3410 Series Gas Ultrasonic Meter Device variable calculations 3-9000-761 Rev 3 January 2014 C.4 Average sound velocity Equation C -7 Average weighted sound velocity C Avg = Wt chord Þ C chord ActiveChords --------------------------------------------------------------------------------------------NumActiveChords where C Avg = average weighted sound velocity (m/s) (AvgSndVel) Wt chord = chord weight (dimensionless) (WtA ... WtD) C chord = chord average sound velocity (m/s) (SndVelA ... SndVelD) NumActiveChords = number of active chords C.4.1 Optional AGA10 sound velocity calculation and comparison AGA10SndVelStatusvalue Description 0 Calculation OK (no errors). 1 Calculation not performed as the feature is not enabled. AGA10SndVel is set to zero. 2 Calculation not performed as the selected AGA8 method is not the Detailed method (HCH_Method not set to Detailed Method(3)). AGA10SndVel is set to zero. 3 Calculation not performed due to invalid AGA8 calculation results. AGA10SndVel is set to zero. 4 Calculation error due to division by zero. AGA10SndVel is set to zero. Average sound velocity 173 Device variable calculations HART Field Device Specification 3410 Series Gas Ultrasonic Meter January 2014 3-9000-761 Rev 3 C.5 Mass rate Equation C -8 Mass rate MassRate = Q Flow ¥ ρ Flow where MassRate = mass rate (kg/h) (MassRate) Q Flow = flow-condition volumetric flow rate (m3/h) (QFlow) ρ Flow = “in-use” flow-condition gas mass density (kg/m3) (RhoMixFlow) C.6 Energy rate Equation C -9 Energy rate 3 1MJ 1000dm Q E = Q Base ¥ HV ¥ ------------------- ¥ --------------------------1000kJ 3 1m where 174 QE = energy rate (MJ/h) (EnergyRate) Q Base = base-condition volumetric flow rate (m3/h) (QBase) HV = “in-use” heating value (kJ/dm3) (HeatingValueInUse) Mass rate HART Field Device Specification 3410 Series Gas Ultrasonic Meter Device variable calculations 3-9000-761 Rev 3 January 2014 C.7 Pressure The flow-condition absolute flow pressure is calculated as shown in Equation C -10. Equation C -10 Flow-condition absolute pressure P abs, f = P f + P Atmosphere P abs, f = P f InputPressureUnit = FALSE ( Gage ) InputPressureUnit = TRUE ( Absolute ) where C.8 P abs, f = flow-condition absolute pressure (MPaa) (AbsFlowPressure) Pf = flow-condition pressure (MPa if InputPressureUnit=FALSE, MPaa if InputPressureUnit=TRUE) (FlowPressure) P Atmosphere = (specified) atmospheric pressure (MPaa) (AtmosphericPress) Temperature The meter is capable of correcting the raw volumetric flow rate for the effect of pipe expansion due to temperature changes. Note that for the temperature-effect expansion correction factor to be calculated, the correction must be enabled (via the EnableExpCorrTemp data point) and the flow-condition temperature must be available (i.e., the EnableTemperatureInput data point must be set to ‘Live’(1) or ‘Fixed’(2), see Section 4.1). The temperature-effect calculation is shown in Equation C - 11. If the temperature-effect expansion correction factor is not calculated, it is set to 1.0. Equation C - 11 Temperature-Effect Expansion Correction ExpCorr T = 1 + [ 3 ¥ α ¥ ( T f – T ref ) ] where Pressure ExpCorr T = α = Tf = T ref = expansion correction factor due to temperature (dimensionless) (ExpCorrTemperature) pipe linear expansion coefficient due to temperature (K-1) (LinearExpansionCoef) flow-condition temperature (K) (FlowTemperature) reference temperature for the pipe linear expansion coefficient (K) (RefTempLinearExpCoef) 175 Device variable calculations January 2014 176 HART Field Device Specification 3410 Series Gas Ultrasonic Meter 3-9000-761 Rev 3 Temperature HART Field Device Specification 3410 Series Gas Ultrasonic Meter 3-9000-761 Rev 3 Supported field device operations January 2014 Annex D. Supported field device operations D For detailed information, refer to the AMS Device Manager Books Online (PN: 10P5824A501). http://www2.emersonprocess.com/en-US/brands/amssuite/amsdevicemanager/Pages/AMSDeviceManager.aspx D.1 AMS Device Manager This section consists of the AMS Device Manager configurations and settings used by Daniel 3410 Series Ultrasonic Flow Meters and assumes the device is connected, power is applied and the device is functioning correctly. AMS Device view selections include Overview, Configure and Service Tools. Figure D-1 AMS Device Manager Menu Tree AMS Device Manager 177 Supported field device operations HART Field Device Specification 3410 Series Gas Ultrasonic Meter January 2014 D.2 3-9000-761 Rev 3 375/475 field communicator menu tree The 375/475 Field Communicator provides real-time HART communications with Daniel 3410 Series Ultrasonic Flow Meters. The following figures show details of the 375/475 Handheld Communicator Menu Tree. 178 • Diagram Page 1 - 3410 Series Root Menu; HART Application, Online menu, Utility menu, HART diagnostics • Diagram Page 2 - 9 Configure>Manual Setup • Diagram Page 10 - Configure Alerts Setup • Diagram Page 11 - 12 Service Tools>Alerts and Variables 375/475 field communicator menu tree 3410 Series Gas Ultrasonic Flow Meters HART Application 1. Offline 2. Online 3. Utility 4. HART Diagnostics Online Menu 1. Overview 2. Configure 3. Service Tools 1. Device Status: Good, Failed, Maintenance, or Advisory 2. Comm Status: Polled 3. Uncorr Volume Rate Value UOM 4. Display K-Factors 5. Device Information Device Status Menu 1. Refresh Alerts 2. No Active Alerts* 3. List F: <Alert Label>** 4. List A: <Alert Label>*** 5. List M: <Alert Label>**** Note * Displayed when No Active Alert is present ** Displayed when Active Alert with category ‘Failed’ is present *** Displayed when Active Alert with category ‘Maintenance’ is present ****Displayed when Active Alert with category ‘Advisory’ is present Device Identification 3. Service Tools See Page 11 Device Information Utility Menu 1. Configure HART Application 2. Available Device Descriptions 3. Simulation HART Diagnostics 1. DC Voltage Measurement Configure HART Application 1. Polling Options 2. Polling Addresses 3. Ignore Status 4. HART Tag 5. Storage Cleanup Value Value Value Value Available Device Descriptions Daniel Industries · 3410 Series Gas USM - Dev v1, DD v1 · - Dev v3, DD v1 · 3810 Series Liquid USM - Dev v1, DD v1 - Dev v3, DD v1 · Gas USM - Dev v1, DD v1 - Dev v2, DD v2 · Liquid USM - Dev v1, DD v1 - Dev v2, DD v2 1. Identification 2. Revisions 3. Alarm Type and Security 4. Licenses 1. Tag 2. Long Tag 3. Model Number 4. Meter Serial Number 5. CPU Serial Number 6. Date 7. Descriptor 8. Message 9. Device Image Value Value Value Value Value Value Value Value Revisions Polling Options Poll By Address Poll Using Tag Poll Using Long Tag Poll Using Unique ID Polling Addresses 0 0-15 0-63 63 Custom Range HART Tag Show Long Tag Show Short Tag Storage Cleanup 1. Internal Flash 2. System Card 3. Hotkey Menu 1. Universal 2. Field Device 3. Hardware 4. Software 5. Firmware 6. DD 7. DD Build Value Value Value Value Value Value Value Alarm Type and Security 1. AO1 Alarm Action 2. AO2 Alarm Action 3. Write Protect Status Value Value Value Cont Flow Analysis Licenses 1. CPU Serial Number 2. Cont Flow Analysis 3. AGA10 Calculation 4. GC Communications 5. Enter License Keys Value 1. CFA Key 2. Enabled Value Value AGA10 Calculation 1. AGA10 Key 2. Enabled Value Value GC Communications 1.GC Key 2. Enabled Value Value Page 1 of 12 HART 375/475 Rev 3 3410 Series Gas Ultrasonic Flow Meters Configure Menu Configure 1. Manual Setup 2. Alert Setup Manual Setup 1. HART 2. Outputs 3. Inputs 4. Communication 5. Metrology 6. Local Display 7. Meter Information 2. Alert Setup See Page 10 HART Device Variables Mapping 1. Device Variables Mapping 2. Units 3. HART Parameters 1. Primary Variable 2. Secondary Variable 3. Third Variable 4. Fourth Variable Outputs Units 1. Analog Output 1 2. Analog Output 2 3. Freq/Dig Outputs 4. Freq & Dig Output 1 5. Freq & Dig Output 2 6. Test Mode Timeout 3. Inputs 4. Communications 5. Metrology 6. Local Display 7. Meter Information See Page 3 See Page 4 See Page 5-8 See Page 9 See Page 9 1. Volume Units 2. Mass Units 3. Energy Units 4. Flow Rate Time Units 5. Velocity Units 6. Pressure Units 7. Temperature Units 8. Length Units 9. Micro Length Units Viscosity Units Young’s Modulus Vol Heating Units Density Units Value UOM Value Value Value UOM Value UOM Value Value Analog Output 2 1. AO2 Content (SV) 2. AO2 Direction 3. AO2 Lower Range 4. AO2 Upper Range 5. AO2 Alarm Action Value Value Value Value Value Value Value Value Value Value Value Value Value HART Parameters Analog Output 1 1. AO1 Content (PV) 2. AO1 Direction 3. AO1 Lower Range 4. AO1 Upper Range 5. AO1 Alarm Action 6. Loop Current Mode Value Value Value Value 1. Tag 2. Long Tag 3. Date 4. Descriptor 5. Message 6. Final Assembly Num 7. Poll Address 8. Response Preambles 9. Request Preambles Value Value Value Value Value Value Value Value Value Value Value Value UOM Value UOM Value Frequency/Digital Output 1 Freq/Dig Outputs 1. Frequency/Digital Output 1 2. Frequency/Digital Output 2 3. Frequency/Digital Output 3 Freq & Dig Output 1 1. Frequency Output 1 2. Digital Output 1 1. FODO1 Source 2. FODO1 Mode Value Value Frequency/Digital Output 2 1. FODO2 Source 2. FODO2 Mode Value Value Frequency/Digital Output 3 1. FODO3 Source 2. FODO3 Mode Value Value Freq & Dig Output 2 Frequency Output 1 or Frequency Output 2 1. Frequency Output 2 2. Digital Output 2 1. FO1 Content 2. FO1 Direction 3. FO1 B Ph Zeroed 4. FO1 B Phase 5. FO1 Max Frequency 6. FO1 Lower Range 7. FO1 Upper Range 8. FO1 Vol Feedback 9. Display K-Factors Value Value Value Value Value Hz Value UOM Value UOM Value UOM Digital Output 1 or Digital Output 2 1. DO1 Chan A Content 2. DO1 Chan A Polarity 3. DO1 Chan B Content 4. DO1 Chan B Content Value Value Value Value Page 2 of 12 HART 375/475 Rev 3 3410 Series Configure Menu (continued) 1. Overview 2. Configure 3. Service Tools Configure Menu 1. Manual Setup 2. Alert Setup Analog Input 1 (Temperature) Manual Setup 1. HART 2. Outputs 3. Inputs 4. Communications 5. Metrology 6. Local Display 7. Meter Information 4. Communications 5. Metrology 6. Local Display 7. Meter Information Inputs 1. Analog Input 1 (Temperature) 2. Analog Input 2 (Pressure) 3. Digital Input 1. Temperature Source 2. Fixed Temperature 3. Live Temperature 4. Temperature Alarm 5. Temperature Exp Correction 6. AI1 Cal Offset 7. AI1 Cal Gain Value Value UOM Value Value UOM Value Live Temperature 1. AI1 Lower Range 2. AI1 Upper Range Value UOM Value UOM Temperature Alarm 1. AI1 Low Limit 2. AI1 High Limit 3. AI Alarm Selection Value UOM Value UOM Value Analog Input 2 (Pressure) See Page 4 See Page 5-8 See Page 9 See Page 9 1. Pressure Source 2. Fixed Pressure 3. Live Pressure 4. Pressure Alarm 5. Gage or Absolute 6. Atmospheric Press 7. Press Exp Correction 8. AI2 Cal Offset 9. AI2 Cal Gain Value Value UOM Value Value UOM Value Value UOM Value Digital Input 1. DI Gen Polarity 2. DI Cal Polarity 3. DI Cal Gating Value Value Value Live Pressure 1. AI2 Lower Range 2. AI2 Upper Range Value UOM Value UOM Pressure Alarm 1. AI2 Low Limit 2. AI2 High Limit 3. AI Alarm Selection Value UOM Value UOM Value Alert Setup 1. Flow Analysis Alerts 2. Baseline Parameters 1. See Page 10 2. See Page 10 Page 3 of 12 HART 375/475 Rev 3 3410 Series Gas USM Configure Menu (continued) Ethernet Manual Setup (continued) Communications 1. HART 2. Outputs 3. Inputs 4. Communications 5. Metrology 6. Local Display 7. Meter Information 1. Ethernet 2. Serial 3. Modbus Units 4. Gas Chromatograph 1. Meter IP Address 2. Meter Subnet Mask 3. Meter Gateway 4. Meter TCP Unit ID 5. Modbus TCP Alt Port Value Value Value Value Value Serial 1. Port A 2. Port B Modbus Units 5. Metrology 6. Local Display 7. Meter Information See Page 5-8 See Page 9 See Page 9 1. Modbus Units System 2. Modbus Time Unit 3. Modbus US Cust Unit 4. Modbus Metric Unit Value Value Value Value Gas Chromatograph 1. GC Serial Port 2. GC Protocol 3. GC Baud Rate 4. GC Modbus Address 5. GC Comm Timeout 6. GC Stream Number 7. GC Stream Timeout 8. GC Heating Val Type 9. GC Heating Val Unit Value Value Value UOM Value Value UOM Value Value UOM Value Value UOM Port A 1. Port A Baud Rate 2. Port A Address 3. Port A Resp Delay 4. Port A Timeout 5. Port A PPP Timeout 6. Port A HW Protocol 7. Port A HW Flow 8. Port A RTS Off Delay 9. Port A RTS On Delay Port A Max Datagram Value UOM Value Value UOM Value UOM Value UOM Value Value Value UOM Value UOM Value UOM Port B 1. Port B Baud Rate 2. Port B Address 3. Port B Resp Delay 4. Port B Timeout 5. Port B PPP Timeout 6. Port B Max Datagram Value UOM Value Value UOM Value UOM Value UOM Value UOM Page 4 of 12 HART 375/475 Rev 3 3410 Series Gas USM Configure Menu (continued) Meter Body 1. Flow Direction 2. Pipe Inside Diameter 3. Temp Exp Corr 4. Pressure Exp Corr Manual Setup (continued) 1. HART 2. Outputs 3. Inputs 4. Communications 5. Metrology 6. Local Display 7. Meter Information Metrology 1. Meter Body 2. Meter Factors 3. Transducer Chord(s) 4. Batch Parameters 5. Signal Parameters 6. Signal Target Parameters 7. Measurement Limits 8. AGA8 4. Batch Parameters 5. Signal Parameters 6. Signal Target Parameters 7. Measurement Limits 8. AGA8 See Page 6 See Page 6 See Page 7 See Page 7 See Page 8 Value Value UOM Temp Exp Corr 1. Linear Exp Coeff 2. Ref Temperature Value UOM Value UOM Pressure Exp Corr Meter Factors 1. Zero Flow Cal Coeff 2. Flow Cal Method Value 1. Pipe Outside Diam... 2. Ref Pressure 3. Young’s Modulus 4. Poisson’s Ratio Value UOM Value UOM Value UOM Value Forward Zero Flow Cal Coeff Transducer Chord(s) 1. Chord A 2. Chord B 3. Chord C 4. Chord D 1. Forward A0 2. Forward A1 3. Forward A2 4. Forward A3 1. Forward 2. Reverse Chord A 1. Chord A 2. Chord A X Dim 3. Chord A L Dim 4. Chord A Avg Delay 5. Chord A Delta Delay Value UOM Value Value UOM Value UOM Reverse Value Value UOM Value UOM Value UOM Value UOM 1. Reverse A0 2. Reverse A1 3. Reverse A2 4. Reverse A3 Value UOM Value Value UOM Value UOM Chord B 1. Chord B 2. Chord B X Dim 3. Chord B L Dim 4. Chord B Avg Delay 5. Chord B Delta Delay Value Value UOM Value UOM Value UOM Value UOM Chord C 1. Chord C 2. Chord C X Dim 3. Chord C L Dim 4. Chord C Avg Delay 5. Chord C Delta Delay Value Value UOM Value UOM Value UOM Value UOM Chord D 1. Chord D 2. Chord D X Dim 3. Chord D L Dim 4. Chord D Avg Delay 5. Chord D Delta Delay Value Value UOM Value UOM Value UOM Value UOM Page 5 of 12 HART 375/475 Rev 3 3410 Series Gas USM Configure Menu (continued) Manual Setup (continued) 1. HART 2. Outputs 3. Inputs 4. Communications 5. Metrology 6. Local Display 7. Meter Information Batch Parameters Metrology 1. Meter Body 2. Meter Factors 3. Transducer Chord(s) 4. Batch Parameters 5. Signal Parameters 6. Signal Target Parameters 7. Measurement Limits 8. AGA8 6. Signal Target Parameters 7. Measurement Units 8. AGA8 1. Signal 2. Transducer Firing 3. Batch 4. Alarm Conditions Signal 1. Update Rate 2. Stack Size 3. Filter 4. Smoothing Value UOM Value Value Value UOM Transducer Firing 1. Sequence 2. Dithering 3. Desired Firing 4. Desired Stacking 5. Co-loc Meter Mode 6. Synchronization Page 7 Page 7 Page 8 Value Value Value UOM Value UOM Value Value Batch 1. Batch Size 2. Max No Data Batches 3. Chord Prop Batches 4. Chord Prop Factor Value Value Value Value Alarm Conditions 1. Min Op Chords 2. Chord Fail Batches 3. Min Good Msmt 4. Re-acq Vel Batches Signal Parameters 1. Transducer 2. Amplitude 3. Signal to Noise 4. Pulse Width 5. Transit Time 6. Sampling Value Value Value UOM Value Transducer 1. XdcrFreq 2. XdcrNumDriveCycles Value UOM Value Amplitude 1. Pk1Thrsh 2. Pk1Pct Value Value UOM Signal to Noise 1. SNRatio 2. MinSigQlty 3. MaxNoise Value Value Value Pulse Width 1. NegSpan 2. PosSpan 3. Pk1PlsWdthSl Value UOM Value UOM Value UOM Transit Time 1. TmDevFctr1 2. DltChkSl 3. TmDevLow1Sl Value Value UOM Value UOM Sampling 1. SampInterval 2. SampPerCycle 3. MinHoldTime 4. MaxHoldTm Value UOM Value Value UOM Value UOM Page 6 of 12 HART 375/475 Rev 3 3410 Series Gas USM Configure Menu (continued) Manual Setup (continued) 1. HART 2. Outputs 3. Inputs 4. Communications 5. Metrology 6. Local Display 7. Meter Information Metrology 1. Meter Body 2. Meter Factors 3. Transducer Chord(s) 4. Batch Parameters 5. Signal Parameters 6. Signal Target Parameters 7. Measurement Limits 8. AGA8 8. AGA8 Signal Target Parameters 1. TspfMatch 2. Pf Distance 3. Pe Distance 4. Norm Amplitude 5. TspeLmt Value UOM Value Value Value Value UOM Pf Distance 1. Tspf 2. TspfLo 3. TspfHi 4. TspfSen 5. TspfWt Value UOM Value UOM Value UOM Value UOM Value Pe Distance See Page 8 1. Tspe 2. TspeLo 3. TspeHi 4. TspeSen 5. TspeWt Value UOM Value UOM Value UOM Value UOM Value Norm Amplitude Measurement Limits 1. Speed of Sound 2. Flow Velocity 1. Tamp 2. TampLo 3. TampHi 4. TampSen 5. TampWt Value UOM Value UOM Value UOM Value UOM Value Speed of Sound 1. Snd Vel Low Alarm 2. Snd Vel High Alarm 3. Min Sound Speed 4. Max Sound Speed 5. CRange Value UOM Value UOM Value UOM Value UOM Value UOM Flow Velocity 1. Max Meter Velocity 2. Velocity Threshold 3. Chord Prop Min Vel 4. CRange Min Vel 5. CRange Max Vel Value UOM Value UOM Value UOM Value UOM Value UOM Page 7 of 12 HART 375/475 Rev 3 3410 Series Gas USM Configure Menu (continued) Manual Setup (continued) 1. HART 2. Outputs 3. Inputs 4. Communications 5. Metrology 6. Local Display 7. Meter Information Metrology 8. AGA8 AGA8 1. AGA8 Method Value 2. Base 3. Specific Gravity 4. Vol Heating Value 5. Molar Density 6. Compressibility 7. Gas Composition AGA8 External External Gross Method 1 Gross Method 2 Detailed Method None 1. AGA8 Method 2. Base 3. Compressibility Base Value 1. Base Temperature 2. Base Pressure Value UOM Value UOM Compressibility 1. Flow Mass Density 2. Flow Compressibility 3. Base Compressibility Value UOM Value Value Gross Method 1 6. Local Display 7. Meter Information See Page 9 See Page 9 1. AGA8 Method Value 2. Base 3. Specific Gravity 4. Vol Heating Value 5. Molar Density 6. Gas Composition Base 1. Base Temperature 2. Base Pressure Value UOM Value UOM Specific Gravity 1. Specific Gravity 2. Gravity Ref Temp 3. Gravity Ref Pressure Value Value UOM Value UOM Vol Heating Value 1. Heating Value 2. Heat Val Ref Temp Value UOM Value UOM Molar Density 1. Density Ref Temp 2. Density Ref Pressure Value UOM Value UOM Gas Composition 1. Gas Source 2. GC Alarm Con Data Src 3. Fixed Gas Comp Value Value Gross Method 2 1. AGA8 Method Value 2. Base 3. Specific Gravity 4. Gas Composition Base 1. Base Temperature 2. Base Pressure Value UOM Value UOM Specific Gravity 1. Specific Gravity 2. Gravity Ref Temp 3. Gravity Ref Pressure Value UOM Value UOM Value UOM Value Value 1. AGA8 Method Value UOM Value UOM Gas Composition None None 1. Gas Source 2. GC Alarm Con Data Src 3. Fixed Gas Comp Gas Source GC Alm Con Data Src Fixed Gas Comp Base 1. Base Temperature 2. Base Pressure Value UOM Value UOM Value UOM Last Good Value Fixed Value Detailed Method 1. AGA8 Method Value 2. Base 3. Gas Composition 1. CO2 2. Hydrogen 3. CO Fixed Live GC Gas Composition 1. Gas Source 2. GC Alarm Con Data Src 3. Fixed Gas Comp Fixed Gas Comp Value Value 1. CO2 2. Hydrogen 3. CO 4. Hydrogen Gas Source Fixed Live GC Value UOM Value UOM Value UOM Value UOM Fixed Gas Comp 1. CO2 2. Hydrogen 3. CO 4. Nitrogen 5. Methane 6. Ethane 7. Propane 8. H2O 9. H2S Oxygen i-Butane n-Butane i-Pentane n-Pentane n-Hexane n-Heptane n-Octane n-Nonane n-Decane Helium Argon Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM GC Alm Con Data Src Last Good Value Fixed Value Page 8 of 12 HART 375/475 Rev 3 3410 Series Gas USM Configure Menu (continued) Manual Setup (continued) 1. HART 2. Outputs 3. Inputs 4. Communications 5. Metrology 6. Local Display 7. Meter Information Display Items Local Display 1. Display Scroll Delay 2. Display Time Unit 3. Display US Cust Unit 4. Display Metric Unit 5. Display Items 6. Local Display Test Value UOM Value Value Value 1. Display Item 1 2. Display Item 2 3. Display Item 3 4. Display Item 4 5. Display Item 5 6. Display Item 6 7. Display Item 7 8. Display Item 8 9. Display Item 9 Display Item 10 Value Value Value Value Value Value Value Value Value Value General Information Meter Information 1. Model Number 2. Meter Serial Number 3. General Information 4. Archive Logs 5. License Keys Value Value 1. Menu Name 2. Station Name 3. Address 4. City 5. State and Country 6. User Scratch 1 7. User Scratch 2 Value Value Value Value Value Value Value Archive Logs 1. Contract Hour 2. Daily Log 3. Hourly Log 4. Event Log Daily Log Value 1. Daily Log Old Rec Value Hourly Log 1. Hourly Log Old Rec Event Log Value Audit Log 1. Audit Log 2. Alarm Log 3. System Log 1. Audit Log Old Rec Value Alarm Log Cont Flow Analysis License Keys 1.Cont Flow Analysis 2. AGA10 Calculation 3. GC Communications 1. CFA Key 2. Enabled Value Value 1. Alarm Log Old Rec 2. Hyster Filter Count 3. Hyster Filter Time Value Value Value UOM AGA10 Calculation 1. AGA10 Key 2. Enabled Value Value System Log 1. System Log Old Rec Value GC Communications 1.GC Key 2. Enabled Value Value Page 9 of 12 HART 375/475 Rev 3 3410 Series Configure Menu – Alert Setup (continued) Configure 1. Manual Setup 2. Alert Setup Configure Detect Blockage Detect Blockage 1. Detection 2. Enable 3. Configure Alert Setup 1. Flow Analysis Alerts 2. Baseline Parameters Flow Analysis Alerts 1. Detect Blockage 2. Detect Liquid 3. Detect Bore Buildup 4. Detect Abnormal Profile 5. Sound Velocity Comparison 6. Detect Reverse Flow 7. Set Flow Range Limits Value Detect Liquid 1. Detection 2. Enable 3. Configure Value Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Configure Detect Liquid 1. Liq Profile Factor Lmt 2. Liq Cross-Flow Lmt 3. Liq Symmetry Lmt Detect Bore Buildup 1. Detection 2. Enable 1. Blkg Symmetry Limit 2. Blkg Cross-Flow Limit 3. Blkg Turb A Limit 4. Blkg Turb B Limit Configure 5. Blkg Turb CBlockage Limit 6. Blkg Turb D Limit Value Value Value Value Configure Abnormal Profile Detect Abnormal Profile 1. Detection 2. Enable 3. Configure 1. Snd Vel Error Lmt Value UOM Value Configure Reverse Flow Detect Reverse Flow 1. Detection 2. Enable 3. Configure Value UOM Configure Sound Vel Comparison Sound Velocity Comparison 1. Detection 2. Enable 3. Configure 1. Abnorm Pro Fac Limit Value Value 1. Rev Flow Zero Cutoff 2. Rev Flow Vol Limit Value UOM Value UOM Set Flow Range Limits 1. Lower Velocity Limit 2. Upper Velocity Limit Baseline Parameters 1. Setup Baseline 2. Forward Baseline Parameters 3. Reverse Baseline Parameters Value UOM Value UOM Fwd/Rev Baseline Parameters 1. Current Baseline Information 2. Velocity Diagnostics 3. Flow Current Baseline Information 1. Fwd/Rev Baseline Com… 2. Fwd/Rev Baseline Date 3. Fwd/Rev Baseline Time Value Value Value Velocity Diagnostics 1. Fwd/Rev Base Prof Fact 2. Fwd/Rev Base Swirl An… 3. Fwd/Rev Base Symmetry 4. Fwd/Rev Base Cross-Flow 5. Fwd/Rev Baseline Turb A 6. Fwd/Rev Baseline Turb B Value Value Value Value Value UOM Value UOM 7. Fwd/Rev Baseline Turb C* Value UOM 8. Fwd/Rev Baseline Turb D* Value UOM Flow 1. Fwd/Rev Baseline Vel 2. Fwd/Rev Baseline Temp 3. Fwd/Rev Baseline Press Value UOM Value UOM Value UOM Note * Only Chords A & B are displayed for Device number 3412 and Chord A for 3411. All chord parameters are always displayed for Device number 3414. Page 10 of 12 HART 375/475 Rev 3 3410 Series Gas USM Online Menu Alerts 1. Refresh Alerts 2. No Active Alerts* 3. List F: <Alert Label>** 4. List A: <Alert Label>*** 5. List M: <Alert Label>**** Service Tools 1. Alerts 2. Variables 3. Trends 4. Maintenance 3. Trends 4. Maintenance Note * Displayed when No Active Alert is present ** Displayed when Active Alert with category ‘Failed’ is present *** Displayed when Active Alert with category ‘Maintenance’ is present ****Displayed when Active Alert with category ‘Advisory’ is present See Sheet 12 See Sheet 12 Flow Velocity Value UOM Value UOM Value UOM 4. Chord D* Value UOM Variables Flow Data Sound Velocity 1. Flow Data 2. Path Information 3. Flow Totals 1. Flow Velocity 2. Sound Velocity 3. Flow Values 4. Flow Analysis 1. Chord A 2. Chord B 3. Chord C* Value UOM Value UOM Value UOM 4. Chord D* Value UOM 4. All Variables 4. All Variables 1. Chord A 2. Chord B 3. Chord C* See Sheet 12 Flow Values Path Information 1. Performance 2. Gain 3. SNR 4. Signal 5. Noise Flow Totals 1. Volume Totals 2. Energy Totals 3. Mass Totals 1. Flow Direction 2. Avg Flow Velocity 3. Avg Sound Velocity 4. AGA10 Snd Velocity 5. Sound Vel Comp Diff Value Value UOM Value UOM Value UOM Value UOM Flow Analysis 1. Profile Factor 2. Swirl Angle 3. Symmetry 4. Cross-Flow 5. Turbulence A 6. Turbulence B 7. Turbulence C* 8. Turbulence D* Value Value UOM Value Value Value UOM Value UOM Value UOM Value UOM Volume Totals 1. Fwd Uncorrected Vol 2. Rev Uncorrected Vol 3. Fwd Base Cond Vol 4. Rev Base Cond Vol Value UOM Value UOM Value UOM Value UOM Energy Totals 1. Fwd Accum Energy 2. Rev Accum Energy Value UOM Value UOM Mass Totals 1. Fwd Accum Mass 2. Rev Accum Mass Value UOM Value UOM Note * Only Chords A & B are displayed for Device number 3412 and Chord A for 3411. All chord parameters are always displayed for Device number 3414. Performance 1. Performance A1 2. Performance A2 3. Performance B1 4. Performance B2 5. Performance C1* 6. Performance C2* 7. Performance D1* 8. Performance D2* Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Gain 1. Gain A1 2. Gain A2 3. Gain B1 4. Gain B2 5. Gain C1* 6. Gain C2* 7. Gain D1* 8. Gain D2* Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM SNR 1. SNR A1 2. SNR A2 3. SNR B1 4. SNR B2 5. SNR C1* 6. SNR C2* 7. SNR D1* 8. SNR D2* Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Signal 1. Signal A1 2. Signal A2 3. Signal B1 4. Signal B2 5. Signal C1* 6. Signal C2* 7. Signal D1* 8. Signal D2* Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Noise 1. Noise A1 2. Noise A2 3. Noise B1 4. Noise B2 5. Noise C1* 6. Noise C2* 7. Noise D1* 8. Noise D2* Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Value UOM Page 11 of 12 HART 375/475 Rev 3 3410 Series Service Tools>Variables (continued) 3410 Series Service Tools>Trends and 3410 Series Service Tools>Maintenance Primary Variable* All Variables 1. Alerts 2. Variables 3. Trends 4. Maintenance Variables 1. Flow Data 2. Path Information 3. Flow Totals 4. All Variables 1. Variable Summary 2. Primary Variable 3. Secondary Variable 4. Third Variable 5. Fourth Variable See Sheet 10 * Note The factory default value for all variables is Uncorr Flow Rate. Other variable selections for Daniel Gas Ultrasonic Meters are: Value UOM Secondary Variable 1. Corr Volume Rate 2. Corr Volume Rate 3. Status: Good · · · · · · · Value UOM Third Variable Trends 1. Alerts 1. Uncorr Volume Rate 2. Uncorr Volume Rate 3. Status: Good 1. Primary Variable 2. Secondary Variable 3. Third Variable 4. Fourth Variable 1. Pressure 2. Pressure 3. Status: Good Value UOM Corr Volume Rate Avg Flow Velocity Avg Sound Velocity Mass Flow Rate Energy Flow Rate Pressure Temperature Fourth Variable 1. Temperature 2. Temperature 3. Status: Good Value UOM Primary Variable 1. Uncorr Volume Rate 2. Uncorr Volume Rate 3. Status: Good 4. AO1 Upper Range 5. AO1 Lower Range Value UOM Value UOM Value UOM Secondary Variable 1. Corr Volume Rate 2. Corr Volume Rate 3. Status: Good 4. AO2 Upper Range 5. AO2 Lower Range Value UOM Value UOM Value UOM Third Variable 1. Avg Flow Velocity 2. Avg Flow Velocity 3. Status: Good 4. Upper Range 5. Lower Range Value UOM Value UOM Value UOM Fourth Variable 1. Avg Sound Velocity 2. Avg Sound Velocity 3. Status: Good 4. Upper Range 5. Lower Range Value UOM Value UOM Value UOM ** Warning: · Maintenance 1. Routine Maintenance 2. Reset/Restore Take the device out of process control loop. Routine Maintenance 1. Analog Output 1 Trim** 2. Analog Output 2 Trim** 3. Frequency Output Test** 4. Digital Output Test** 5. Set Transducer Type*** 6. Locate Device**** 7. Set/View Clock *** Warning: · Setting transducer type is necessary only after a swap-out of all transducers. Select transducer type carefully as incorrect selection may cause incorrect measurement. **** Message: This method will help identify the device in the field by displaying the pattern (0-0-0) on the device display. Reset/Restore 1. Reset Device 2. Reset Chord Proportions Page 12 of 12 HART 375/475 Rev 3 HART Field Device Specification 3410 Series Gas Ultrasonic Meter 3-9000-761 Rev 3 Revision history January 2014 Annex E. Revision history ERevision history E.1 Document release This is this initial release of the Daniel 3410 Series Ultrasonic Flow Meter HART Field Device Specification Guide. E.2 Changes Revision 2 Page/section Description of change Title Page • • • Changed manual title - removed “Guide” Revision level from 1 to 2 Date from March 2011 to 17 September 2012 Preface • Changed title Important instructions to Important Safety Instructions. Changed copyright from 2011 to 2012 (Also on back page) Table of Contents List Of Figures List of Tables • • • Changed title from Contents to Table of Contents Updated TOC to add changes to section numbering and pagination Date from 01 November 2011 to September 2012 Document release 179 Revision history HART Field Device Specification 3410 Series Gas Ultrasonic Meter January 2014 Sections 3-9000-761 Rev 3 • • • • • • • • • • • • • • • • • Annexes • • • • Global changes • • • • • 180 Changed all section header dates to January and manual revision from 1 to 2 Section 1.1 Changed HART rev 5 to HART rev 7. Section 2, Table 2-1 changed HART rev 5 to HART rev 3. Changed document type in Header from Device Specification Guide 3410 Series Gas Ultrasonic Meter to HART Field Device Specification 3410 Series Ultrasonic Meter Section 3-4, Deleted firmware version level backward compatibility. Section 4.1.2, Changed HART rev 5 to HART rev 7. Section 5.5 and 5.6 Swapped sections 5.5 is Energy rate and 5.6 is Mass rate per database AO1Content. Section 5.78 Changed Table 5-6 device variable name from pressure to temperature Section 5.9, New section: HART slave device variables good status indicators. Changed document type in Header from Device Specification Guide 3410 Series Ultrasonic Meter to HART Field Device Specification 3410 Series Ultrasonic Meter. Changed Energy rate classification from 0 to 79. Section 6, Changed section numbers and header dates and revision from 1 to 2. Section 7, Changed Table 7-1 changed Device Status Bit 5 (Cold Start) and 6 (Configuration Changed) and changed database point name from DidPrimaryConfigChange OR DidSecondaryConfigChange toHARTDidPrimaryConfigChange OR HARTDidSecondaryConfigChange. Table 7-2 Byte 10: Update 'Analog Output Saturated, Respectively LSB to MSB: AO2IsSaturated, … AO25IsSaturated (bit mapped) changed to LSB to MSB: AO1IsSaturated, AO2IsSaturated… (bit mapped). Only bit for AO1 is used.'; Byte 11: update 'Standardized status' as 'Standardized status 2, shall be set to 0'; Byte 12: update 'Standardized status 2, shall be set to 0.' as 'Standardized status 3, shall be set to 0.'; Byte 13: update 'Analog Output Fixed, Respectively LSB to MSB: AO2 … AO25 (bit mapped) where each bit is the OR'ing of the related database points of IsAO<n>EnableTest and AO<n>IsFixed. Only the bit for AO2 is used' as 'Analog Output Fixed, Respectively LSB to MSB: AO1, AO2… (bit mapped) where each bit is the OR'ing of the related database points of IsAO<n>EnableTest and AO<n>IsFixed. Only the bit for AO1 is used. related database points of IsAO<n>EnableTest and AO<n>IsFixed. Only the bit for AO1 is used'. Backed out AO1 saturated to AO2 per BZ 6198. Section 8, Table 8-1 added commands 33 Moved commands 38 and 48 to this table from Table 9-1. Section 9, Table 9-1 Moved commands 38 and 48 to this table from Table 8-1 Section 10, Changed section numbers and header dates and revision from 1 to 2. Changed Units syntax to match FRS revision 3.38 and later. Section 11, Changed title from Units Tables to Tables, section numbers and header dates and revision from 1 to 2 Section 12.3, Table 12.-2 Command 42 device reset changed minimum and maximum startup delay times from 67 seconds and 78 seconds to 242 seconds and 250 seconds. Corrected typo - from effected to affected. Section 12.5.1, Removed Busy and Delay Response since it not supported. Annex A, Table A-1 Changed HART rev 5 to HART rev 7, number of Common practice commands from 16 to 14 (moved commands 38 and 48 to Universal commands), changed section A.1 title from Introduction to Device capability. Annex B, changed section B.1 title from Introduction to Default factory settings, changed header revision and date and corrected Table B-1 formatting Annex C, Annex E Updated Revision history added Section E-2, header dates and revision from 1 to 2. Annex D, Removed word Introduction and renumbered following sections Annex E, Updated revision history page Removed HART registered mark from manual sections. Kept on Title page Changed document type in Header from Device Specification Guide 3410 Series Ultrasonic Meter to HART Field Device Specification 3410 Series Ultrasonic Meter Removed word Section from section headings Removed Introduction from sections Changed all header dates from August to September. Changes Revision 2 HART Field Device Specification 3410 Series Gas Ultrasonic Meter Revision history 3-9000-761 Rev 3 E.3 January 2014 Changes Revision 3 Page/section Description of change Global changes • • Revision 2 to Revision 3 Date from September 2012 to January 2014 (section headers) Title Page • • Revision level from 2 to 3 Date from 17 September 2012 to 31 January 2014 Table of Contents List Of Figures List of Tables • Updated TOC to add changes to section numbering and pagination All Sections • • Changed Header date from March 2012 to January 2014 Changed revision from 2 to 3 Section Section 1 • Section 1.1 Deleted note • Section 1.4.3, Table 1-3 changed HZ to Hz • Section 1.4.4, Table 1-4 updated references Section 4 • Section 4.1 Reworded paragraph. • Section 4.1.1 Section 4.1.1 Added T-32 transducer type and deleted operating temperatures per clarification of Lit-18 requirements. • New section 4.1.3 Time stamp Section 5 • Added 5.9 HART slave device variables good status indicators Section 7 • Section 7.1 Device status Edit device status bit 5: Cold Start, removed reference to Liquid Ultrasonic Meter and reworded to be consistent with the FRS. • Section 7. 7.2 Command 48 Advisory Status Byte 0, Bit 7 —removed HARTAO2SVValidity (inverted). Section 8 • Section 8.1 Universal commands - Table 8-1 added Commands — 18, 20, 21, 22, • Moved Common Practice commands38, and 48 to Universal commands. Section 9 • Common -practice commands Table 9-1: added Commands 72, 89, 90 and 95. Changes Revision 3 181 Revision history HART Field Device Specification 3410 Series Gas Ultrasonic Meter January 2014 Sections 3-9000-761 Rev 3 Section 10 • Removed redundant mention of response data bytes for all commands per FRS v3.1.10. • Command 128 — Byte 0 — added sentence: This is an informational index variable; when written, it is not updated in the device. • Command 129 — edit Command-specific response codes table, Code 1-5, 6, and 7-14. • Command 130 — deleted Response data bytes table. Inserted sentence: Same as Request data bytes. • Command 131 — edit Command-specific response codes. • Command 132 — added Code 28 Device-specific command error (Response code 6). • Command 147 — Changed command title and edited Response Data Bytes table. Edited Command-specific response codes. • Command 148 — Edit Command-specific response code 6. • Command 150 - deleted Response data bytes table. Inserted sentence: Same as Request data bytes. • Command 154 — Edit Command-specific response code 6. • Command 155 — edited Request data bytes table. Deleted Response data bytes table. Inserted sentence: Same as Request data bytes. • Command 156 - Deleted Response data bytes table. Inserted sentence: Same as Command 157. • Command 167 - deleted Response data bytes table. Inserted sentence: Same as Request data bytes. • Command 170 - deleted Response data bytes table. Inserted sentence: Same as Command 171 Write flow analysis related configuration. Added commands: • Command 171— 179, 182 — 197, 200 — 224. • Added Section 10.2 Device-specific command error (response code 6). • Added Section 10.2 Device-specific command error (response code 6). Section 11 • Added Thermal Expansion units, Table 11-16. Annexes 182 Annex A, • Updated HART® protocol revision as Rev. 7.0. • Updated Bits of additional device status from 45 to 40. • Updated number of Common-Practice Commands from 14 to 18. • Number of Device-specific commands from 44 - 95. Annex D • Changed heading level from D1.1 to D.1. Annex E • Updated revision history page with all changes for revision 3, HART 7 protocol. Changes Revision 3 P/N 3-9000-761 Rev 3 2013 Daniel Measurement and Control, Inc. 11100 Brittmoore Park Drive Houston, TX 77041 USA T+1 713-467-6000 F+1 713-827-4805 USA Toll Free 1 888-356-9001 Daniel Measurement Services, Inc. T +1 713-827-6413 www.Daniel.com Europe: Stirling, Scotland, UK T + 44-1786-433400 Middle East: Africa: Dubai, UAE T +971-4-811-8100 Asia Pacific: Singapore T +65-677-8211 This product is a core component of the PlantWeb digital plant architecture. © 2013 Daniel Measurement and Control, Inc., All rights reserved The Emerson logo is a trademark and service mark of Emerson Electric Co. Daniel Measurement and Control, Inc. (Daniel) are Emerson Process Management business units. The Daniel name and logo are trademarks of Daniel Industries, Inc. The Senior, Junior, Simplex, MeterLink SeniorSonic, JuniorSonic, and DanPac are trademarks of Daniel Industries, Inc. All other trademarks are property of their respective owners.
© Copyright 2026 Paperzz