Rosemount 3410 Series Gas Ultrasonic Flow Meters HART Field Device Specification Quick Start Guide

Page 1
3414 Gas Ultrasonic Flow Meter 3411 and 3412 Gas Ultrasonic Flow Meters
HART® Field Device Specification
00825-0400-3240, Rev AA
April 2022
Rosemount™ 3410 Series Gas
Ultrasonic
Meters
Page 2
Safety and approval information
This Rosemount product complies with all applicable European directives when properly installed in accordance with the instructions in this manual. Refer to the EU declaration of conformity for directives that apply to this product. The EU declaration of conformity, with all applicable European directives, and the complete ATEX Installation Drawings and Instructions are available on the internet at www.emerson.com or through your local Emerson support center.
Information affixed to equipment that complies with the Pressure Equipment Directive, can be found on the internet at http://
www.emerson.com.
For hazardous installations in Europe, refer to standard EN 60079-14 if national standards do not apply.
Other information
Full product specifications can be found in the product data sheet. Troubleshooting information can be found in the user manual. Product data sheets and manuals are available from the Emerson website at http://www.emerson.com.
Return policy
Follow Emerson procedures when returning equipment. These procedures ensure legal compliance with government transportation agencies and help provide a safe working environment for Emerson employees. Emerson will not accept your returned equipment if you fail to follow Emerson procedures. Return procedures and forms are available on our web support site at www.emerson.com, or by phoning the Emerson Customer Service department.
Emerson Flow customer service
Email:
Worldwide: http://flow.support@emerson.com
Asia-Pacific: http://APflow.support@emerson.com
Telephone:
North and South America Europe and Middle East Asia Pacific
United States 800 522 6277 U.K. 0870 240 1978 Australia 800 158 727
Canada +1 303 527 5200 The Netherlands +31 (0) 704 136 666 New Zealand 099 128 804
Mexico +41 (0) 41 7686 111 France 0800 917 901 India 800 440 1468
Argentina +54 11 4837 7000 Germany 0800 182 5347 Pakistan 888 550 2682
Brazil +55 15 3413 8000 Italy 8008 77334 China +86 21 2892 9000
Central & Eastern +41 (0) 41 7686 111 Japan +81 3 5769 6803
Russia/CIS +7 495 981 9811 South Korea +82 2 3438 4600
Egypt 0800 000 0015 Singapore +65 6 777 8211
Oman 800 70101 Thailand 001 800 441 6426
Qatar 431 0044 Malaysia 800 814 008
Kuwait 663 299 01
South Africa 800 991 390
Saudi Arabia 800 844 9564
UAE 800 0444 0684
Page 3
Page 4
00825-0400-3240
Contents
1. Introduction
Scope .......................................................................................................... 1
1.1
Purpose ....................................................................................................... 1
1.2
Table of ContentsHART Field Device Specification 3410 Series Ultrasonic Meter
April 2022
Who should use this document? ......
1.3
Definitions, acronyms, abbreviations and references .......................................1
1.4
1.4.1 Definitions ........................................................................................................... 2
1.4.2 Acronyms............................................................................................................ 2
1.4.3 Abbreviations ...................
1.4.4 References........................................................................................................... 3
2. Device Identification
2.1 Rosemount 3410 Series Ultrasonic Flow Meter identification ........................... 5
Physical description ..................................................................................... 6
2.2
3. Product overview
Device function, purpose and features ........................................................... 7
3.1
Process connections ..................................................................................... 7
3.2
External interfaces (electrical and non-electrical) ............................................ 7
3.3
Other required equipment ............................................................................ 7
3.4
4. Product interfaces
Process interface .......................................................................................... 9
4.1
4.1.1 Sensor input channels .......................................................................................... 9
4.1.2 Sensor analog output channels ............................................................................ 10
4.1.3 Time Stamp.......................................................................................................... 12
.............................................................. 1
................................................................................... 2
5. Device variables
Table of Contents i
Page 5
HART Field Device Specification 3410 Series Ultrasonic MeterTable of Contents
April 2022 00825-0400-3240
5.1 Device variable 0 - uncorrected flow rate ..................................................... 15
5.2 Device variable 1 - corrected flow rate ..........................
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 ......................
5.3.4 No wet calibration..............................................................................................16
Device variable 3 - average sound velocity .................................................. .. 17
5.4
Device variable 4 - energy rate ..................................................................... 17
5.5
Device variable 5 - mass rate ........................................................................ 18
5.6
Device variable 6 - pressure ......................................................................... 18
5.7
Device variable 7 - temperature ................................................................... 19
5.8
6. Dynamic variables
Fixed dynamic variables ............................................................................... 21
6.1
Dynamic variables with configurable mapping .....
6.2
7. Status information
Device status .............................................................................................. 24
7.1
.............................. 15
................................................................16
........................................... 21
Additional device status (Command 48) ........................................................ 26
7.2
8. Universal commands
Slave universal commands ........................................................................... 31
8.1
9. Common-practice commands
Supported commands .................................................................................. 33
9.1
Burst mode ................................................................................................ 34
9.2
Catch device variable .................................................................................. 34
9.3
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..........................41
10.1.5 Command 132 Write flow pressure configuration ............................................42
10.1.6 Command 133 Read flow pressure configuration .......
10.1.7 Command 134 Write flow temperature configuration..................................... 45
10.1.8 Command 135 Read flow temperature configuration....................................... 47
10.1.9 Command 136 Write device units .....................................................................48
10.1.10 Command 137 Read device units ...............................
......................................44
.....................................49
ii
Table of Contents
Page 6
Table of ContentsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240
April 2022
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........... 60
10.1.18 Command 147 Read miscellaneous write protected parameters ................... 61
10.1.19 Command 148 Write blockage configuration ................................................. 62
10.1.20 Command 149 Read blockage configuration.................................................. 63
10.1.21 Command 150 Write liquid detection configuration .......................................64
10.1.22 Command 151 Read liquid detection configuration ........................................65
10.1.23 Command 152 Read continuous flow analysis active features......................... 66
10.1.24 Command 153 Read running averages ............................................................67
10.1.25 Command 154 Read baselines.........................................................................69
10.1.26 Command 155 Write baselines........................................................................71
10.1.27 Command 156 Read keys ................................................................................73
10.1.28 Command 157 Write keys............................................................................... 74
10.1.29 Command 158 Read key validities .................................................................. 75
10.1.30 Command 159 Read meter chord data............................................................76
10.1.31 Command 160 Read meter flow data ..............................................................77
10.1.32 Command 161 Read path signal amplitude data.............................................78
10.1.33 Command 162 Read noise amplitudes............................................................79
10.1.34 Command 163 Read path SNR data .............
................................................... 80
10.1.35 Command 164 Read path percent good..........................................................81
10.1.36 Command 165 Read path gains ...................................................................... 82
10.1.37 Command 166 Read flow analysis configuration............................................. 83
10.1.38 Command 167 Write flow analysis configuration .......................................
..... 84
10.1.39 Command 168 Read general meter information............................................. 85
10.1.40 Command 169 Read flow totals.......................................................................86
10.1.41 Command 170 Read flow analysis related configuration..................................87
10.1.42 Command 171 Write flow analysis related configuration ......
...........................88
10.1.43 Command 172 Write Ethernet configuration...................................................89
10.1.44 Command 173 Read Ethernet Configuration................................................... 91
10.1.45 Command 174 Write serial port configuration................................................. 92
10.1.46 Command 175 Read serial port configuration ................................................. 94
10.1.47 Command 176 Write transducer chord configuration ..................................... 95
10.1.48 Command 177 Read transducer chord configuration ...................................... 96
10.1.49 Command 178 Write polynomial calibration configuration............................. 97
10.1.50 Command 179 Read polynomial calibration configuration.............................. 98
10.1.51 Command 182 Write archive log configuration ............................................... 99
10.1.52 Command 183 Read Archive Log configuration .............................................. 100
10.1.53 Command 184 Write acquisition configuration .............................................. 101
Table of Contents iii
Page 7
April 2022
HART Field Device Specification 3410 Series Ultrasonic MeterTable of Contents
00825-0400-3240
10.1.54 Command 185 Read acquisition configuration.................................................103
10.1.55 Command 186 Write meter limits....................................................................104
10.1.56 Command 187 Read meter limits.....................................................................106
10.1.57 Command 188 Write meter body configuration...............................................107
10.1.58 Command 189 Read meter body configuration................................................ 109
10.1.59 Command 190 Write signal parameters........................................................... 110
10.1.60 Command 191Read signal parameters........
..................................................... 112
10.1.61 Command 192 Write target parameters...........................................................113
10.1.62 Command 193 Read target parameters............................................................115
10.1.63 Command 194 Reset chord proportions to defaults......................................... 116
10.1.64 Command 195 Enter/exit fixed frequency output mode ...................................117
10.1.65 Command 196 Enter/exit fixed digital output mode......................................... 118
10.1.66 Command 197 Set transducer type...................................................................119
10.1.67 Command 198 Write Frequency/Digital Output sources.................................. 120
10.1.68 Command 199 Read Frequency/Digital Output sources................................... 122
10.1.69 Command 200 Write miscellaneous write protected parameters.................... 123
10.1.70 Command 201 Write analog input calibration .................................................. 124
10.1.71 Command 202 Read analog input calibration ................................................... 125
10.1.72 Command 203 Write piecewise linearization flow rates.................................... 126
10.1.73 Command 204 Read piecewise linearization flow rates.....................................128
10.1.74 Command 205 Write piecewise linearization meter factors ..............................129
10.1.75 Command 206 Read piecewise linearization meter factors ...............................130
10.1.76 Command 207 Write meter text .......................................................................131
10.1.77 Command 208 Read meter text ........................................................................132
10.1.78 Command 209 Write gas chromatograph configuration...................................133
10.1.79 Command 210 Read gas chromatograph configuration....................................135
10.1.80 Command 211 Write AGA8 method configuration ...........................................136
10.1.81 Command 212 Read AGA8 method configuration............
................................138
10.1.82 Command 213 Write detailed gas composition................................................139
10.1.83 Command 214 Read detailed gas composition.................................................141
10.1.84 Command 215 Write Gross Method 1 and 2 gas composition configuration...142
10.1.85 Command 216 Read Gross Method 1 and 2 gas composition configuration......143
10.1.86 Command 217 Write baseline times and comments........................................144
10.1.87 Command 218 Read baseline times and comments......................................... 146
10.1.88 Command 219 Reset tracking targets to defaults .............................................147
10.1.89 Command 220 Write local display configuration ..............................................148
10.1.90 Command 221 Read local display configuration...............................................150
10.1.91 Command 222 Enable local display test mode ..................................................151
10.1.92 Command 223 Write general meter information ..............................................152
10.1.93 Command 224 Write miscellaneous non-write protected
parameters ....................................................................................................... 153
10.1.94 Command 229 Write Gas Chromatograph Component Configuration.............155
10.1.95 Command 230 Read Gas Chromatograph Component Configuration..............158
iv Table of Contents
Page 8
00825-0400-3240
11. Tables
Table of ContentsHART Field Device Specification 3410 Series Ultrasonic Meter
10.1.96 Command 231 Enter/Exit Fixed Analog Output Mode ...................................... 159
Device-specific command error (response code 6) ......................................... 160
10.2
Volume units ............................................................................................ 161
11.1
Energy units .............................................................................................. 161
11.2
Mass units ............................................................................................... 161
11.3
Time units (flow rate) ................................................................................ 161
11.4
Pressure units .......................................................................................... 162
11.6
Temperature unit ...................................................................................... 162
11.7
Velocity units ............................................................................................ 162
11.8
Mass flow rate units ................................................................................. 163
11.9
April 2022
Energy flow rate units ............................................................................. 163
11.10
Decibel units .......................................................................................... 163
11.11
Voltage units .......................................................................................... 163
11.12
Current units .......................................................................................... 163
11.13
11.14
11.15
11.16
11.17
11.18
11.19
11.20
11.21
Percent units ......................................................................................... 164
Length units .......................................................................................... 164
Thermal expansion units ......................................................................... 164
Viscosity units ....................................................................................... 165
Volumetric heating value units ................................................................. 165
Density units ..................................
Unit conversion factors .......................................................................... 166
Pressure and temperature tables .............................................................. 167
11.21.1 Live Pressure................................................................................................. 168
11.21.2 Live Temperature .......................................................................................... 169
12. Performance
........................................................ 165
Sampling rates ....................................................................................... 171
12.1
Power-up ................................................................................................ 171
12.2
Device reset ..
12.3
Command response delay .......................................................................... 172
12.4
........................................................................................ 171
12.4.1 Long messages................................................................................................ 172
12.4.2 Non-volatile memory ..................................................................................... 172
12.4.3 Operating modes ........................................................................................... 172
Table of Contents v
Page 9
April 2022
HART Field Device Specification 3410 Series Ultrasonic MeterTable of Contents
12.4.4 Write protection ..................................................................................................172
12.4.5 Damping value ....................................................................................................173
Annex A. Device capability checklist
A1
. Device capability ............................................................................................... 175
Annex B. Default device configuration
B.1 Default factory settings...................................................................................... 177
Annex C. Device variable calculations
C.1 Uncorrected flow rate ........................................................................................ 179
00825-0400-3240
C.2 Corrected flow rate .....
C.3 Average flow velocity ......................................................................................... 181
C.3.1 Dry-calibration ..................................................................................... 181
C.3.2 Wet-calibration ....................................................................................181
C.3.3 Piece-wise linearization ....
C.3.4 Third-order polynomial......................................................................... 182
C.3.5 No wet calibration ................................................................................ 182
C.4 Average sound v
C.4.1 Optional AGA10 sound velocity calculation and comparison ................ 183
C.5 Mass rate ........................................................................................................... 184
C.6 Energy rate ........................................................................................................ 184
C.7 Pressure ............................................................................................................. 185
C.8 Temperature...................................................................................................... 185
....................................................................................... 180
elocity ...................................................................................... 183
Annex D. Supported field device operations
D.1 AMS Device Manager ......................................................................................... 187
.................................................................... 182
D.2 375/475 field communicator menu tree ............................................................ 188
Annex E. Revision history
E.1 Document release .............................................................................................. 189
E.2 Changes Revision 2............................................................................................. 189
vi Table of Contents
Page 10
Table of ContentsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
E. 3 Changes Revision 3 ............................................................................................ 191
E. 4 Changes Revision 4 ............................................................................................ 193
E. 5 Changes Revision 5 ............................................................................................ 194
Table of Contents vii
Page 11
HART Field Device Specification 3410 Series Ultrasonic MeterTable of Contents
April 2022 00825-0400-3240
viii Table of Contents
Page 12
List of FiguresHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
List of Figures
Figure 2-1 3410 Series Gas Ultrasonic Flow Meter electronics - CPU Module ................................. 6
Figure D-1 AMS Device Manager Menu Tree .............................................................................. 187
List of Figures ix
Page 13
List of Figures HART Field Device Specification 3410 Series Ultrasonic Meter
April 2022 00825-0400-3240
x List of Figures
Page 14
List of TablesHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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 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.................................................................................................................. 161
Table 11-2 Energy rate..................................................................................................................... 161
Table 11-3 Mass units ...................................................................................................................... 161
Table 11-4 Time units (flow rate) ..................................................................................................... 161
Table 11-5 Volumetric flow rate units .............................................................................................. 162
Table 11-6 Pressure units................................................................................................................. 162
Table 11-7 Temperature units.......................................................................................................... 162
Table 11-8 Velocity units ................................................................................................................. 162
Table 11-9 Mass flow rate units........................................................................................................ 163
Table 11-10 Mass low rate units......................................................................................................... 163
Table 11-11 Decibel units .................................................................................................................. 163
Table 11-12 Voltage units..................................................................................................................163
Table 11-13 Current units .................................................................................................................. 163
Table 11-14 Percent units .................................................................................................................. 164
List of Tables xi
Page 15
List of Tables HART Field Device Specification 3410 Series Ultrasonic Meter
April 2022 00825-0400-3240
Table 11-15 Length units....................................................................................................................164
Table 11-16 Thermal Expansion units.................................................................................................164
Table 11-17 Viscosity units.................................................................................................................165
Table 11-18 Volumetric heating value units .......................................................................................165
Table 11-19 Density units...................................................................................................................165
Table 11-20 Conversion factors per unit of measurement ..................................................................166
Table 11-21 Pressure and temperature tables ....................................................................................167
Table 11-22 Data points for pressure inputs.......................................................................................168
Table 11-23 Data points for temperature inputs ................................................................................169
Table 12-1 Sampling Rates...............................................................................................................171
Table 12-2 Command 42 device reset ..............................................................................................171
Table 12-3 Command response delay ..............................................................................................172
Table A-1 Capability checklist.........................................................................................................175
Table B-1 Device factory settings configuration .............................................................................177
xii List of Tables
Page 16
HART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240
11
1. Introduction
1. Introduction
April 2022
1.1
1.2
1.3
1.4
Scope
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 Rosemount 3410 Series Gas Ultrasonic Flow Meters.
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.
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.
Definitions, acronyms, abbreviations and references
The following is a list of commonly used definitions used throughout this document.
Scope 1
Page 17
1. Introduction HART Field Device Specification 3410 Series Ultrasonic Meter
April 2022 00825-0400-3240
1.4.1 Definitions
Table 1-1 Definiti o n s
Name Definition
Emerson Field Communicator 375 or 475 field communicator - handheld device
1.4.2 Acronyms
Table 1-2 Acronyms
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
1.4.3 Abbreviations
Table 1-3 Abbreviations
Abbreviation
o
C
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
Definition
Degrees Celsius (alternatively, degrees Centigrade)
2 Definitions
Page 18
HART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240
1.4.4 References
The documents referenced within the text of this document are listed in the table below:
Table 1-4 Reference document a t ion
Title Document number, revision, date
1. Introduction
April 2022
American Petroleum Institute (API) Manual of Petroleum Measure­ment Standards (MPMS) Chapter 21 - Flow Measurement Using Electronic Metering Systems Section 1 - Electronic Gas Measurement
HART SMART Communications Protocol Specification (also includes 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)
First Edition, 01-Sep-1993
HCF_SPEC 13, Rev. 7.5 (29 May, 2013)
References 3
Page 19
1. Introduction HART Field Device Specification 3410 Series Ultrasonic Meter
April 2022 00825-0400-3240
4 References
Page 20
2. Device IdentificationHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
2
2. Device Identification
This section details the Rosemount 3410 Series Ultrasonic Flow Meter identification and physical description.
2.1
Rosemount 3410 Series Ultrasonic Flow Meter
identification
The Rosemount 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
Rosemount 3410 Series Ultrasonic
Manufacturer name:
Manufacturer ID Code: 13 (D Hex) Device Type Code: 21 (15 Hex)
HART Protocol Revision: 7 Device Revision: 6
Number of Device Variables: 8
Physical Layers Supported: Bell 202 FSK
Physical Device Category:
Emerson
Rosemount 3410 Series Ultrasonic Fl
ow Meter
Model name(s):
Note:
HART Hardware Revision: 4
HART Software Revision: 27
Flow Meter
Rosemount 3410 Series Ultrasonic Flow Meter identification
5
Page 21
HART Field Device Specification 3410 Series Ultrasonic Meter2. Device Identification
April 2022 00825-0400-3240
2.2 Physical description
The Rosemount 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
Page 22
3. Product overviewHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
3
3. Product overview
This section specifies the purpose and application of the Rosemount 3410 Series Ultrasonic Flow Meter for HART communication.
3.1
3.2
3.3
3.4
Device function, purpose and features
The Rosemount 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.
Process connections
The Rosemount 3410 Series Ultrasonic Flow Meter’s updated electronics includes the firmware, CPU Module and the Acquisition module allows communications with other field devices.
External interfaces (electrical and non-electrical)
Any pressure and/or temperature input read via the Rosemount 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 Rosemount 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.
Other required equipment
A RS-232C/RS-485 (half duplex) serial communication port for Modbus communication is provided as Port A, Port B and Port C.
Any programmable device aboard the Rosemount 3410 Series Ultrasonic Flow Meter (such as an FPGA) is programmed via the CPU Module.
Device function, purpose and features 7
Page 23
HART Field Device Specification 3410 Series Ultrasonic Meter3. Product overview
April 2022 00825-0400-3240
8 Other required equipment
Page 24
4. Product interfacesHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
4. Product interfaces
This section discusses the Rosemount 3410 Series Ultrasonic Flow Meter for HART communications, electrical interface, and input and output requirements.
4.1
4.1.1
Process interface
The Rosemount 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 Rosemount 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.
Sensor input channels
Rosemount 3410 Series Ultrasonic Flow Meters supports analog and discrete inputs as shown
below.
Name
Analog Input 1 4 mA- 20 mA Input for temperature device
Analog Input 2 4 mA- 20 mA Input for pressure device
Functional description
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 One Ethernet Port (TCP/IP)
Process interface 9
(1) Single polarity (for flow calibration gating - contact closure)
Single input for starting and stopping
Four pulse configurations available
Up to 100 Mbps
Modbus TCP
Page 25
HART Field Device Specification 3410 Series Ultrasonic Meter4. Product interfaces
April 2022 00825-0400-3240
Name
Frequency/Digital Output(s) Maximum frequency for the frequency outputs
Functional description
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)
Tr an sd u ce rs
T-11
T-12
T-21
22
T-
T-32
T-41
Note: The process temperature must not exceed the operating tem-
perature 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, Analog Output 1 (AO1). NOTE: HART communication is available over AO1 only.
IsAO1Avail indicates the presence of
10 Sensor analog output channels
Page 26
4. Product interfacesHART Field Device Specification 3410 Series Ultrasonic Meter
Configuration via the HART slave port, requires device-specific commands.
00825-0400-3240 April 2022
Table 4-1 Analog output configuration parameters
Valu es
Direction
Down greater than -3.125% 3.5 mA
Linear over-range
Maximum current +106.25% 21 mA
Multi-drop current draw
Lift-off voltage 7 V @ full scale
Up less than +106.25% 21 mA
(percent of range)
4 mA (Available in sink mode only)
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
Valu es (e.g., in mA)
mass rate
energy rate
The Rosemount 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
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
Page 27
HART Field Device Specification 3410 Series Ultrasonic Meter4. Product interfaces
April 2022 00825-0400-3240
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
4.1.3
AOX
Time Stamp
= AOXCurrentTrimGain
TRIM
× AOXOut()put – 4()4++AOXCurrentTrimZero
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 poi
nts shown in Table 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
Page 28
4. Product interfacesHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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:
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
Time Stamp 13
Page 29
HART Field Device Specification 3410 Series Ultrasonic Meter4. Product interfaces
April 2022 00825-0400-3240
14 Time Stamp
Page 30
5. Device variablesHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
5
5. Device variables
The Rosemount 3410 Series Ultrasonic Flow Meter does not use Device Family commands.
5.1
Device variable
Number:
Classification:
Device variable 0 - uncorrected flow rate
The flow-condition volumetric flow rate is the result of applying expansion correction and flow­profile 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.
0
66 Volumetric Flow
Name
Unit Codes
Uncorrected Flow Rate
(see Table 11-5)
5.2 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
Device variable 0 - uncorrected flow rate 15
Unit Codes
(
Table 11-5)
Page 31
HART Field Device Specification 3410 Series Ultrasonic Meter5. Device variables
April 2022 00825-0400-3240
5.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:
Classification:
2
67 Vel oci ty
5.3.1 Wet calibration
Name
Unit Codes
Average Flow Velocity
(Table 11- 8)
The Rosemount 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 dry­calibration 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 dry­calibration 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
Page 32
5. Device variablesHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
5.4 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
Number:
Classification:
3
67
Vel oci ty
Name
Unit Codes
Average Sound Velocity
(Table 1 1-8 )
5.5 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:
Classification:
4
79 Power
Name
Unit Codes
Energy Rate
(Table 1 1-2 )
Device variable 3 - average sound velocity 17
Page 33
HART Field Device Specification 3410 Series Ultrasonic Meter5. Device variables
April 2022 00825-0400-3240
5.6 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 AO2FullScaleMass- Rate 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:
Classification:
5
72 Mass Flow
Name
Unit Codes
5.7 Device variable 6 - pressure
The Rosemount 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:
Classification:
6
65 Pressure
Name
Unit Codes
Mass Rate
(Table 11-3)
Pressure
(Table 1 1-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
Page 34
5. Device variablesHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
5.8 Device variable 7 - temperature
The Rosemount 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:
Classification:
7
64
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 MaxInputTempera- ture.
To configure the live temperature, plus associated alarms, configure the data points in
Section 11.21.
Name
Unit Codes
Tem p er at u re
(Table 1 1-7 )
Device variable 7 - temperature 19
Page 35
HART Field Device Specification 3410 Series Ultrasonic Meter5. Device variables
April 2022 00825-0400-3240
20 Device variable 7 - temperature
Page 36
6. Dynamic variablesHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
6. Dynamic variables
This section documents the HART primary, secondary, tertiary, and quaternary variables.
6.1
6.2
Table 6-1 Dynamic variables configurable mapping
Dynamic variable Device variable number Name
PV (Primary variable) 0-5
SV (Secondary variable) 0-5
TV (Third variable) 0-7
QV (Fourth variable) 0-7
Fixed dynamic variables
There are no fixed Dynamic Variables for this device.
Dynamic variables with configurable mapping
The Rosemount 3410 Series Ultrasonic Flow Meter allows the following user-configurable dynamic variables mapped to the device variables:
0 - Uncorrected flow rate
1 - Corrected Flow Rate
2 - Average Flow Velocity
3 - Average Sound Velocity
4 - Energy Flow Rate
5 - Mass Flow Rate
0-5
0-5, 6, 7: PV + Pressure, Temperature
0-5, 6, 7: PV + Pressure, Temperature
The default primary Dynamic Variable is Uncorrected Flow Rate for all meters.
Fixed dynamic variables 21
Page 37
HART Field Device Specification 3410 Series Ultrasonic Meter6. Dynamic variables
April 2022 00825-0400-3240
22 Dynamic variables with configurable mapping
Page 38
7. Status informationHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
7.1
7. Status information
This section documents the HART primary, secondary, third, and fourth variables for the Rosemount 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 acknowledgment.
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
Page 39
HART Field Device Specification 3410 Series Ultrasonic Meter7. Status information
April 2022 00825-0400-3240
7.1 Device status
Table 7-1 Device status byte database point mapping
Device status bit Definition Explanation Related database point(s)
7 (msb) Device Malfunction - The
device detected a serious error or failure that compromises device operation.
6 Configuration Changed - An
operation was performed that changed the device's configura­tion.
5 Cold Start - A power failure or
Device Reset has occurred.
4 More Status Available - More
status information is available via Command 48, Read Addi­tional 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.
This will be the logical OR’ing of the related database points.
Configuration Changed flag of corre­sponding 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 corre­sponding master will be communi­cated.
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.
IsAcqModuleError
IsCorePresent
WatchDogReset
IsElecVoltOutOfRange
IsAcqModuleIncompatible
HARTDidPrimaryConfigChange
Or
HARTDidSecondaryConfigChange
HARTDidPowerFailPrimary
Or
HARTDidPowerFailSecondary
N/A
IsAO1EnableTest
AO1IsFixed
AO1IsSaturated
24 Device status
Page 40
7. Status informationHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
Table 7-1 Device status byte database point mapping
Device status bit Definition Explanation Related database point(s)
1 Non-Primary Variable Out of
Limits - A Device Variable not mapped to the PV is beyond its operating limits.
0 (lsb) Primary Variable Out of Limits -
The Primary Variable is beyond its operating limit.
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 AO1­Content 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 AO1Con­tent 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 out-of-limits database points.
IsMeterVelAboveMaxLmt
AvgSndVelOutOfLimits
FlowPressureIsOutOfLimits
FlowTemperatureIsOutOfLimits
AO1Content
Device status 25
Page 41
HART Field Device Specification 3410 Series Ultrasonic Meter7. Status information
Bit Description Related database point(s)
7 (msb) Acquisition Mode Indicator
IsAcqMode
6Meter cold-start indicator.
DidColdStart
5 Acquisition Mode Latched indicator
IsAcqModeLatched
4 Number of operating chords below
specified minimum latched indicator
IsTooFewOperChordsLatched
3 Number of operating chords below
specified minimum
IsTooFewOperChords
2 Acquisition board communications
error latched indicator
IsAcqModuleErrorLatched
1 Acquisition module error latched
indicator
IsAcqModuleIncompatible
0 (lsb)
Reser ved
Bit Description Related database point(s)
7 (msb) Chord A is hard failed
IsHardFailedA
6 Chord B is hard failed
IsHardFailedB
5 Chord C is hard failed
IsHardFailedC
4 Chord D is hard failed
IsHardFailedD
3 Possible blockage of flow conditioner
IsBlockageDetected
2 Possible blockage of flow conditioner
latched indicator.
IsBlockageDetectedLatched
1 Batch data received failed
IsBatchDataRcvFailed
0 (lsb)
April 2022 00825-0400-3240
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 Format Description
0 Bits Failed Status Byte 0
1 Bits Maintenance Status Byte 0
26 Additional device status (Command 48)
Page 42
7. Status informationHART Field Device Specification 3410 Series Ultrasonic Meter
Bit Description Related database point(s)
7 (msb) Flow-condition pressure invalid indicator
PressureInvalid
6 Flow-condition temperature invalid
indicator
Tem pe ra tu re In val id
5 GC Alarm - logical OR'ing of the related
database points
IsGCAlarmPresent
IsGCDataErr
IsGCCommErr
4 3 2 Live digital pressure latched indicator
PressureInvalidLatched
1 Live digital temperature latched indicator
Tem pe ra tu re In val id La tc he d
0(lsb) Invalid gas composition and heating value
AreGasPropertiesInvalidInUse
Bit Description Related database point(s)
7 (msb)
Reserved
6 5 4 Indicator that the meter should be warm-
started
IsWarmStartReq
3 Chord A failed for current batch
IsFailedForBatchA
2 Chord B failed for current batch
IsFailedForBatchB
1 Chord C failed for current batch
IsFailedForBatchC
0 (lsb) Chord D failed for current batch
IsFailedForBatchD
00825-0400-3240 April 2022
Table 7-2 Additional device status (Command 48)
Byte Format Description
2 Bits Maintenance Status Byte 1
3 Bits Maintenance Status Byte 2
Additional device status (Command 48) 27
Page 43
HART Field Device Specification 3410 Series Ultrasonic Meter7. Status information
Bit Description Related database point(s)
7 (msb) Invalid measurement indicator - logical
OR'ing of the related database points
QFlowValidity (inverted)
QBaseValidity (inverted)
AGA8BaseCalc Validit y (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)
6 Enables test mode for Digital Output 1
pair
DO1PairTestEnable
5 Enables test mode for Digital Output 2
pair
DO2PairTestEnable
4Power failure indicator
DidPowerFail
3Latched alarm indicator
IsMeterVelAboveMaxLmtLatched
2 Configuration checksum changed
DidCnfgChksumChg
1 Average sound velocity range error
IsAvgSoundVelRangeErr
0 (lsb) Latched alarm indicator
April 2022 00825-0400-3240
Table 7-2 Additional device status (Command 48)
Byte Format Description
4 Bits Advisory Status Byte 0
28 Additional device status (Command 48)
IsAvgSoundVelRangeErrLatched
Page 44
7. Status informationHART Field Device Specification 3410 Series Ultrasonic Meter
Bit Description Related database point(s)
7 (msb) One or more logs full indicator -
logical OR'ing of the related database points
IsHourlyLogFull
IsDailyLogFull
IsAuditLogFull
IsAlarmLogFull
IsSystemLogFull
6 Frequency Output 1 pair test
enable
IsFreq1EnableTest
5 Frequency Output 2 pair test
enable
IsFreq2EnableTest
4 Flow-condition pressure out-of-
limits
FlowPressureIsOutOfLimits
3 Flow-condition temperature out-
of-limits
FlowTemperatureIOutOfLimits
2 Forward baseline not set
IsFwdBaselineNotSet
Code Description Related database point(s)
0x08 Watchdog reset executed
WatchdogReset
0x10 Voltage condition out of range
IsElecVoltOutOfRange
0x20 Environmental Conditions Out of
Range
IsElecTempOutOfRange
Remaining Bits shall be set to 0.
00825-0400-3240 April 2022
Byte Fo rmat Description
5 Bits Advisory Status Byte 1
6 Enum-8 Extended device status (See Table 17 of HCF-SPEC-183) 7 Enum-8 Device operating mode shall be set 0 since it is reserved by HCF (See Table 14 of HCF-SPEC-
183)
8 Bits Standardized Status 0
9 Bits Standardized status 1 shall be set 0 since it is reserved by HCF (See Table 30 of HCF-SPEC-183) 10 Bits Analog Output Saturated, Respectively LSB to MSB: AO2IsSaturated, (bit mapped). Only bit for
AO2 will be used. 11 Bits Standardized status 2, shall be set to 0. 12 Bits Standardized status 3, shall be set to 0.
Additional device status (Command 48) 29
Page 45
HART Field Device Specification 3410 Series Ultrasonic Meter7. Status information
Bit Description Related database point(s)
7 (msb) Liquids possibly present in gas
IsLiquidDetected
6 Abnormal flow profile detected
IsAbnormalProfileDetected
5 Possible bore buildup detected
IsBoreBuildupDetected
4 Sound velocity comparison of
AGA10 to meter error.
IsSndVelCompErr
3Reverse flow detected
IsReverseFlowDetected
2 Speed of sound comparison of
diagnostic chord to meter error
IsDiagnosticSndSpdRangeErr
1 0 (lsb) Average speed of sound out of
limits (HART-specific)
AvgSndVelIsOutOfLimits
Bit Description Related Database Point(s)
7 (msb) Liquids possibly present in gas,
latched until acknowledged.
IsLiquidDetectedLatched
6 Abnormal profile detected,
latched until acknowledged
IsAbnormalProfileDetectedLatched
5 Possible bore buildup detected,
latched until acknowledged
IsBoreBuildupDetectedLatched
4 Sound velocity comparison of
AGA10 to meter error, latched until acknowledged
IsSndVelCompErrLatched
3 Reverse flow detected, latched
until acknowledged
IsReverseFlowDetectedLatched
2 Speed of sound comparison of
diagnostic chord to meter error latched indicator
IsDiagnosticSndSpdRangeErrLatched
1 0 (lsb) Transducer firing synchronization
error
IsXdcrFiringSyncError
April 2022 00825-0400-3240
13 Bits 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. 14 Bits Advisory - Advanced Diagnostic Alarms
15 Bits Advisory - Advanced Diagnostic Alarms Latched
16-24 Bits, Unsigned-24
30 Additional device status (Command 48)
or Enum
Not used at this time and thus not sent.
Page 46
8. Universal commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
8
8. 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 Rosemount 3410 Series Ultrasonic Flow Meter as shown in the following table.
Table 8-1 Universal commands for slave implementation
Command Function Description
Returns identity information about the meter including: the Device Type,
0 Read Unique Identifier
1 Read Primary Variable Returns the Primary Variable value along with its Unit Code.
Read Loop Current and Percent
2
3
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
9
11
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
15 Read Device Information
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.
Of Range Reads the Loop Current and its associated Percent of Range.
Read Dynamic Variables and Loop Current
Read Dynamic Variable Classifi­cations Reads the classification associated with the Dynamic variables.
Read Device Variables with Status
Read Unique Identifier Associ­ated With Tag
Read Primary Variable Trans­ducer Information
revision levels, and Device ID.
Reads the Loop Current and up to four predefined Dynamic Variables. The Dynamic Variables and associated units are defined via Commands 51 and 53.
This command allows a master to request the value and status of up to eight device or dynamic variables.
If the specified tag matches that of the meter, it responds with the Command 0 response.
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.
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.
Slave universal commands 31
Page 47
HART Field Device Specification 3410 Series Ultrasonic Meter8. Universal commands
April 2022 00825-0400-3240
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.
Read Unique Identifier Associ-
21
22 Write Long Tag Writes the long tag into meter.
38 Reset Configuration Changed
48 Read Additional Device Status Returns meter status information not included in the Response Code or
ated with Long Tag
Flag
If the specified long tag matches that of the meter, it responds with the command 0 response.
If the received configuration changed counter matches with device config­uration changed counter, then resets the configuration changed flag (Device Status Byte bit 6) of the requesting master(i.e. Primary/Second­ary).
Device Status Byte.
32 Slave universal commands
Page 48
9. Common-practice commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
91
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 Function Description
33 Read Device Variables Allows a Master to request the value of up to four Device Variables. 35 Write Primary Variable Range
Values 40 Enter/Exit Fixed Current Mode Forces the Loop Current for Primary Variable to the requested value. 42 Perform Device Reset Forces the meter to perform a warm start (equivalent to cycling the power
44 Write Primary Variable Units Selects the units in which the Primary Variable and its range will be
45 Trim Loop Current Zero Trims the zero or lower endpoint value of the Loop Current exactly to its
46 Trim Loop Current Gain Trims the gain or upper endpoint value of the Loop Current exactly to its
50 Read Dynamic Variable Assign-
ments 51 Write Dynamic Variable Assign-
ments 53 Write Device Variable Units Selects the units in which the selected Device Variable will be returned. 54 Read Device Variable Informa-
tion
59 Write Number Of Response
Preambles 66 Enter/Exit Fixed Analog Output
Mode 67 Trim Analog Output Zero Analog Output current calibration zero (offset). 68 Trim Analog Output Gain Analog Output current calibration gain. 72 Squawk Causes the addressed device to visually indicate the reception of this
89 Set Real-Time Clock If the Time-set code is 0, responds with the internal time at which the
90 Read Real-Time Clock Reads the Real-Time Clock including the current time as estimated by the
Writes Primary Variable Upper Range Value and Lower Range Value and returns actual values used by device in given units.
off and then back on to the meter).
returned.
minimum. This trim is typically performed by adjusting the Loop Current to 4.00 mA and sending the measured value to the meter.
maximum. This trim is typically performed by adjusting the Loop Current to 20.0 mA and sending the measured value to the meter.
Reads the Device Variables assigned to the Primary, Secondary, Tertiary, and Quaternary Variables.
Allows the user to assign Device Variables to the Primary, Secondary, Tertiary, and Quaternary Variables
Responds with the transducer serial number, the Limits, Damping Value (not applicable), and Minimum Span of the Device Variable along with the corresponding engineering units.
Sets the number of asynchronous preamble bytes to be sent by the meter before the start of a response message.
Similar to command 40 but allows selection of any analog port not just the Primary Variable.
command.
request was received. If the Time-set code is 1, sets Real-Time Clock of meter to have value same as received value.
meter and the last time the clock was set.
Supported commands 33
Page 49
HART Field Device Specification 3410 Series Ultrasonic Meter9. Common-practice commands
April 2022 00825-0400-3240
Table 9-1 Common-practice commands
95 Read Device Communication
Statistics
Responds with counts of STX messages received, ACK messages sent and BACK messages sent.
9.2 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
Page 50
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
1011 102F
10. Device-specific commands
This section documents the Device-Specific Commands implemented for the Rosemount 3410 Series Ultrasonic Flow Meter.
10.1
Public, device-specific commands
The Rosemount 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
Page 51
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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 config-
1 Unsigned-8 Device variable assigned to the specified
analog output
2 Enum-8 Upper and Lower Range Values Units
Code (Section 11)
ured.
0 = Analog Output 1
1 = Analog Output 2
This is an informational index variable; when written, it is not updated in the device.
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.
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.
3-6 Float Upper Range Value Used to set:
AOXFullScaleVolFlowRate
AOXMaxVel
AOXFullScaleMassRate
AOXFullScaleEnergyRate
7-10 Float Lower Range Value
11 Enum-8 Flow direction to be represented by
specified analog output
12 Enum-8 Alarm Selection Code (Section 11)Writes
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.
Writes
AOXDir.
AOXActionUponInvalidContent.
Response data bytes
Same as Request data bytes.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors
36 Command 128 Write analog output configuration
Page 52
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
Code Class Description Explanation
1Undefined 2 Error Invalid Selection
3-4 Error Undefined 5 Error Too Few Data Bytes Received 6 Error Device-Specific Command Error 7 Error In Write Protect Mode 8Undefined 9 Error Lower Range Value Too High
10 Error Lower Range Value Too Low
11 Error Upper Range Value Too High
12 Error Upper Range Value Too Low
13-14 Undefined
15 Error Invalid Analog Channel Code Number
16-27 Undefined 28 Error Invalid Device Variable Index
29-31 Undefined 32 Error Busy 33-127 Undefined
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.
Lower Range Value was below the Lower
Transducer Limit or some other physical device limitation is exceeded.
Upper Range Value was above Upper Trans-
ducer Limit.
Upper Range Value was below Lower Trans-
ducer Limit.
The analog channel does not exist in this
field device.
The requested Device Variable does not
exist in this field device or is not supported by the requested command or operation.
Command 128 Write analog output configuration 37
Page 53
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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
Response data bytes
Byte Format Description Explanation
0 Unsigned-8
1 Unsigned-8
2 Enum-8
3-6 Float
7-10 Float
11 Enum-8
12 Enum-8
13 Enum-8
Analog output selector
Device Variable assigned to the specified analog output
Upper and Lower Range Values Units Code
Upper Range Value Reads AOXFullScaleVolFlowRate, AOX-
Lower Range Value Reads AOXMinVel.
Flow direction to be represented by specified analog output
Alarm Selection Code Reads AOXActionUponInvalidContent.
Analog output availability Reads IsAOXAvail.
configured.
Used to select which analog output to be read.
Reads AOXContent.
Specifies the units for the Upper and Lower Range Values.
MaxVel, AOXFullScaleMassRate, AOX­FullScaleEnergyRate.
Reads AOXDir.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-5 Undefined 6 Error Device-Specific Command Error 7-14 Undefined 15 Error Invalid Analog Channel Code Number The analog channel does not exist in this field
device. 16-31 Undefined 32 Error Busy 33-127 Undefined
38 Command 129 Read analog output configuration
Page 54
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.3 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.
This is an informational index variable; when written, it is not updated in the device.
1 Unsigned-8 Frequency Output Content selector Writes FreqXContent. When this assignment is a con-
figuration change, the remaining data bytes are ignored. However, for the response, the remaining data bytes should reflect the data for the newly assigned frequency output content.
2 Enum-8 Upper and Lower Range Values Units
Code (see Section 11)
Specifies the units for the requested Frequency Output Content 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
This is an informational variable; when written, it is not updated in the device.
3-6 Float Upper Range Value Writes:
FreqXFullScaleVolFlowRate
Freq XMaxVel
FreqXFullScaleMassRate
FreqXFullScaleEnergyRate
This value corresponds to the maximum frequency (see below).
7-10 Float Lower Range Value Writes:
FreqXMi nVel
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-12 Enum-16 Maximum Frequency (Hertz) Writes:
Freq XMaxFrequ ency.
13 Enum-8 Flow direction to be represented by
Frequency Output Pair
14 Enum-8 Frequency B Phase zero-on-error config-
uration
15 Enum-8 Frequency B Phase relative to Frequency
A Phase configuration
16 Unsigned-8 Frequency feedback correction percent-
age
17 Enum-8 Selected Digital Output A inverted
polarity configuration
18 Enum-8 Selected Digital Output A content
selector
Writes Fre qXDir.
Writes IsFreqXBZeroedOnErr.
Writes FreqXBPhase.
Writes FreqXFeedbackCorrectionPcnt.
Writes DOXAIsInvPolarity
Writes DOXAContent data point but it is NOT a direct mapping.
Command 130 Write Frequency/Digital Output configuration 39
Page 55
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
19 Enum-8 Selected Digital Output B inverted
polarity configuration selector
20 Enum-8 Selected Digital Output B content
selector
Writes DOXBIsInvPolarity
Writes DOXBContent but it is NOT a direct mapping.
Response data bytes
Same as Request data bytes.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3-4 Undefined 5 Error Too Few Data Bytes Received 6 Error Device-Specific Command Error 7 Error In Write Protect Mode 8Undefined 9 Error Lower Range Value Too High
10 Error Lower Range Value Too Low
11 Error Upper Range Value Too High
12 Error Upper Range Value Too Low
13-14 Undefined 15 Error Invalid Frequency/Digital Output Pair
Number
16-27 Undefined 28 Error Invalid Device Variable Index
29-31 Undefined 32 Error Busy 33-127 Undefined
Requested maximum frequency, feedback per-
centage invalid Frequency Phase B, Digital Output inverted polarity or Digital Output content invalid.
Lower Range Value was above the Upper Trans-
ducer Limit or some other physical device limita­tion is exceeded.
Lower Range Value was below the Lower Trans-
ducer Limit or some other physical device limita­tion is exceeded.
Upper Range Value was above Upper Transducer
Limit.
Upper Range Value was below Lower Transducer
Limit.
The Frequency/Digital Output pair requested
does not exist in this field device.
The requested Frequency Output Content does
not exist in this field device or is not supported by the requested command or operation.
40 Command 130 Write Frequency/Digital Output configuration
Page 56
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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
Request data bytes
Byte Format Description Explanation
0 Unsigned-8 Frequency/Digital Output Pair selector Used to select which Frequency/Digital Output
device variable represented by the specified frequency output pair.
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 Explanation
0 Success No Command-Specific Errors 1-4 Undefined 5 Error Too Few Data Bytes Received 6 Error Device-Specific Command Error 7-14 Undefined 15 Error Invalid Frequency/Digital Output Pair
selector
16-31 Undefined 32 Error Busy 33-127 Undefined
The frequency/digital output pair does not
exist in this field device.
Command 131 Read Frequency/Digital Output configuration 41
Page 57
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
10.1.5 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 1 Enum-8 Units Code (see Section 11)
2-5 Float Conventional Analog or
Fixed Upper Alarm Value
6-9 Float Conventional Analog or
Fixed Lower Alarm Value
10-13 Float Conventional Analog Upper
Range Value
14-17 Float Conventional Analog Lower
Range Value
18-21 Float Fixed Value
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
28 Enum-8 Enable pressure-effect
expansion correction
Writes EnablePressureInput.
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.
Writes 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.
Writes 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.
Writes 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.
Writes 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.
Writes 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.
This selects the input action upon alarm and is applicable to
both pressure and temperature inputs. Writes FlowPOrTSrcU- ponAlarm 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).
Wri
tes InputPressureUnit.
Required when the input pressure is gage. Writes Atmospher-
icPress.
Writes EnableExpCorrPress
Response data bytes
Same as Request data bytes.
42 Command 132 Write flow pressure configuration
Page 58
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3 Error Passed Parameter Too High
4 Error Passed Parameter Too Low
5 Error Too Few Data Bytes Received 6 Error Device-Specific Command Error
7 Error In Write Protect Mode 8Undefined 9 Error Lower Range Value Too High
10 Error Lower Range Value Too Low
11 Error Upper Range Value Too High
12 Error Upper Range Value Too High
13-31 Undefined 32 Error Busy 33-127 Undefined
Input selector code or alarm code
selection invalid.
Upper alarm value, lower alarm value,
fixed value, and/or atmospheric pressure value too high.
Upper alarm value, lower alarm value,
fixed value, and/or atmospheric pressure value too low.
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.
Lower Range Value was above the Upper
Transducer Limit or some other physical device limitation is exceeded.
Lower Range Value was below the Lower
Transducer Limit or some other physical device limitation is exceeded.
Upper Range Value was above Upper
Transducer Limit.
Upper Range Value was above Upper
Transducer Limit.
Command 132 Write flow pressure configuration 43
Page 59
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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
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 Explanation
0 Success No Command-Specific Errors 1-5 Undefined 6 Error Device-Specific Command Error 7-31 Undefined 32 Error Busy 33-127 Undefined
device variable configured units code.
44 Command 133 Read flow pressure configuration
Page 60
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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
1 Enum-8 Units Code (see Section 11)
2-5 Float Conventional Analog or Fixed Upper
Alarm Value
6-9 Float Conventional Analog or Fixed Lower
Alarm Value
10-13 Float Conventional Analog Upper Range
Value
14-17 Float Conventional Analog Lower Range
Value
18-21 Float Fixed Value
22 Enum-8 Pressure and Temperature Alarm
Selection Code (see Section 11)
23 Enum-8 Enable temperature-effect expansion
correction
Writes EnableTemperatureInput.
Specifies the units for related values (such as
alarm values, range values, fixed (specified) value). This units code is only pertinent for inter­preting 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.
Writes HighTemperatureAlarm. This value is only
applicable if the Input Selector Code is 1 (live con­ventional 4-20 mA analog) or 2 (fixed/specified). It is ignored for all other Input Selector Code values.
Writes LowTemperatureAlarm. This value is only
applicable if the Input Selector Code is 1 (live con­ventional 4-20 mA analog) or 2 (fixed/specified). It is ignored for all other Input Selector Code values.
Writes MaxInputTemperature. This value is only
applicable if the Input Selector Code is 1 (live con­ventional 4-20 mA analog). It is ignored for all other Input Selector Code values.
Writes MinInputTemperature. This value is only
applicable if the Input Selector Code is 1 (live con­ventional 4-20 mA analog). It is ignored for all other Input Selector Code values.
Writes 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.
This selects the input action upon alarm and is
applicable to both pressure and temperature inputs. Writes FlowPOrTSrcUponAlarm although it is not a direct mapping:
239 Hold Last Output Value set Flow-
POrTSrcUponAlarm to 0.
242 Used Fixed Value set
FlowPOrTSrcUponAlarm to 1 (Fixed value).
Writes EnableExpCorrTemp
Command 134 Write flow temperature configuration 45
Page 61
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
Response data bytes
Same as Request data bytes.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3 Error Passed Parameter Too High
4 Error Passed Parameter Too Low
5 Error Too Few Data Bytes Received 6 Error Device-Specific Command Error
7 Error In Write Protect Mode 8Undefined 9 Error Lower Range Value Too High
10 Error Lower Range Value Too Low
11 Error Upper Range Value Too High
12 Error Upper Range Value Too Low
13-31 Undefined 32 Error Busy 33-127 Undefined
Input selector code or alarm code selection invalid.
Upper alarm value, lower alarm value, or fixed
value too high.
Upper alarm value, lower alarm value, or fixed
value too high.
1
This is used
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.
Lower Range Value was above the Upper Trans-
ducer Limit or some other physical device limita­tion is exceeded.
Lower Range Value was below the Lower Trans-
ducer Limit or some other physical device limita­tion is exceeded
Upper Range Value was above Upper Transducer
Limit.
Upper Range Value was below the Lower Trans-
ducer Limit.
1.
46 Command 134 Write flow temperature configuration
Page 62
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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
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 Explanation
0 Success No Command-Specific Errors 1-5 Undefined 6 Error Device-Specific Command Error 7-31 Undefined 32 Error Busy 33-127 Undefined
Device Variable configured units code.
Command 135 Read flow temperature configuration 47
Page 63
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
10.1.9 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 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
Request data bytes
Byte Format Description
0 Enum-8
1 Enum-8
2 Enum-8
3 Enum-8
4 Enum-8
5 Enum-8
6 Enum-8
7 Enum-8
8 Enum-8
9 Enum-8
10 Enum-8
11 Enum-8
12 Enum-8
Volume Units Code (HARTVolUnit) (see Table 11-1)
Flow Rate Time Units Code (HARTRateTimeUnit) (see Table 11-5)
Pressure Units Code (HARTPressureUnit) (see Table 11-6)
Temperature Units Code (HARTTemperatureUnit) (see Table 11-7)
Velocity Units Code (HARTVelUnit) (see Table 11-8)
Mass Units Code (HARTMassUnit) (see Table 11-3)
Energy Units Code (HARTEnergyUnit) (see Table 11-2)
Length Units Code (HARTLengthUnit) (Table 11-15)
Micro Length Units Code (HARTMicroLengthUnit) (Table 11-15)
Viscosity Units Code (HARTViscosityUnit) (Table 11-17)
Young’s Modulus Units Code (Table 11-6)
Young’s Modulus Units Code (HARTYoungsModulusPressureUnit) (Table 11-18)
Density Units Code (HARTDensityUnit) (Table 11-19)
device variable) shall be derived from the Volume
Section 11.
Response data bytes
Same as Request data bytes.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3-4 Undefined 5 Error Too Few Data Bytes Received 6 Error Device-Specific Command Error 7ErrorIn Write Protect Mode 8-31 Undefined 32 Error Busy 33-127 Undefined
One or more of the units code selection(s) is/
are invalid.
48 Command 136 Write device units
Page 64
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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 Explanation
0 Success No Command-Specific Errors 1-5 Undefined 6 Error Device-Specific Command Error 7-31 32 Error Busy 33-127 Undefined
Command 137 Read device units 49
Page 65
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
10.1.11 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
1 Enum-8 Units Code (see Section 11)
2-5 Float Upper Range Value 6-9 Float Lower Range Value
Specifies the device variable for which the range values
are to be set.
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
Response data bytes
Same as Request data bytes.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3-4 Undefined 5 Error Too Few Data Bytes Received 6 Error Device-Specific Command error
7-8 Undefined 9 Error Lower Range Value Too High
10 Error Lower Range Value Too Low
11 Error Upper Range Value Too High
12 Error Upper Range Value Too Low
13-27 Undefined
Units code selection invalid
Error Lower Range Value is greater than Upper
Range Value.
Lower Range Value was above the Upper
Transducer Limit or some other physical device limitation is exceeded.
Lower Range Value was below the Lower
Transducer Limit or some other physical device limitation is exceeded.
Upper Range Value was above Upper Trans-
ducer Limit.
Upper Range Value was below the Lower Trans-
ducer Limit.
50 Command 138 Write device variable range
Page 66
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
Code Class Description Explanation
28 Error Invalid Device Variable Index
29-31 Undefined 32 Error Busy 33-127 Undefined
The requested Device Variable does not exist in
this field device or is not supported by the requested command or operation.
Command 138 Write device variable range 51
Page 67
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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
Response data bytes
Same as for Command 138 Write device variable range.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-4 Undefined 5 Error Too Few Data Bytes Received 6 Error Device-Specific Command error 7-27 Undefined 28 Error Invalid device variable index
29-31 Undefined 32 Error Busy 33-127 Undefined
Specifies the device variable for which the
range values are to be read.
The requested device variable does not exist
in this field device or is not supported by the
requested command or operation.
52 Command 139 Read device variable range
Page 68
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
Bit Description Related database point(s)
7 (msb) Indicates a diagnostic core file was generated.
IsCorePresent
6 Indicates communication error with Acquisition
module
IsAcqModuleError
5 Indicates electronics voltage out-of-range.
IsElecVoltOutOfRange
4 3 Indicates the watchdog performed a meter
warm-start.
WatchDogReset
2 Indicates unknown Acquisition module revision -
firmware upgrade is required.
IsAcqModuleIncompatible
1 0 (lsb)
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
IsGCDataErr
4 Indicates a communication error with the GC.
IsGCCommErr
3 2 1 0 (lsb)
00825-0400-3240 April 2022
10.1.13 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
limit what is seen and logged by the AMS
Request data bytes
Byte Format Description Explanation
None
Response data bytes
Byte Format Description
0 Bits Failed Detail Status Byte 0
see Table 7-1). The purpose of having a separate device-specific command is to
TM
Device Manager Alert Monitor.
1 Bits Maintenance Detail Status Byte 0
Command 140 Read detailed status 53
Page 69
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
Bit Description Related database point(s)
7 (msb) Flow-condition volumetric flow rate validity
QFlowValidity (inverted)
6 Base-condition volumetric flow rate validity
QBaseValidity (inverted)
5 AGA8 base-condition calculation validity
AGA8BaseCalcValidity (inverted)
4 AGA8 flow-condition calculation validity
AGA8FlowCalcValidity (inverted)
3 Energy rate validity
EnergyRateValidity (inverted)
2Mass rate validity
MassRateValidity (inverted)
1 0 (lsb)
Bit Description Related database point(s)
7 (msb) Analog Output 2 test enable
IsAO2EnableTest
6 Analog Output 1 test enable
IsAO1EnableTest
5 Frequency Output 2 data is invalid
Freq2DataValidity (inverted)
4 Frequency Output 1 data is invalid
Freq1DataValidity (inverted)
3 Analog output 2 validity
AO2DataValidity (inverted)
2 Analog output 1 validity
AO1DataValidity (inverted)
1 Analog Output 2 (HART SV) current is in test
mode and fixed.
AO2IsFixed
0 (lsb) Analog Output 1 (HART PV) current is in test
mode and fixed.
AO1IsFixed
Bit Description Related database point(s)
7 (msb) Hourly log full indicator
IsHourlyLogFull
6 Daily log full indicator
IsDailyLogFull
5 Audit log full indicator
IsAuditLogFull
4 Alarm log full indicator
IsAlarmLogFull
3 System log full indicator
IsSystemLogFull
2 1 HART third variable validity
HARTTVValidity (inverted)
0 (lsb) HART fourth variable validity
HARTQVValidity (inverted)
April 2022 00825-0400-3240
Byte Format Description
2 Bits Advisory Detail Status Byte 0
3 Bits Advisory Detail Status Byte 1
4 Bits Advisory Detail Status Byte 2
54 Command 140 Read detailed status
Page 70
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
Bit Description Related database point(s)
7 (msb) Flow data quality indicator
IsMeterVelAboveMaxLmt
6 Average sound velocity out-of-limits
AvgSndVelIsOutOfLimits
5 Flow-condition pressure out-of-limits indicator
FlowPressureIsOutOfLimits
4 Flow-condition temperature out-of-limits
indicator
FlowTemperatureIsOutOfLimits
3 The HART Slot 0 value as defined by the HART
device variable selection
HARTSlot0Validity (inverted)
2 The HART Slot 1 value as defined by the HART
device variable selection
HARTSlot1Validity (inverted)
1 The HART Slot 2 value as defined by the HART
device variable selection
HARTSlot2Validity (inverted)
0 (lsb) The HART Slot 3 value as defined by the HART
device variable selection
HARTSlot3Validity (inverted)
00825-0400-3240 April 2022
Byte Format Description
5 Bits Advisory Detail Status Byte 3
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
Command 140 Read detailed status 55
Page 71
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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 IsCorePresent 1 IsAvgSoundVelRangeErrLatched 2 WatchDogReset 3 DidCnfgChksumChg 4 DidColdStart 5 DidPowerFail 6 IsAnyKeyAboutToExpire (not used) 7 IsAnyKeyExpired (not used) 8 IsBoreBuildupDetectedLatched 9 IsBlockageDetectedLatched 10 IsAbnormalProfileDetectedLatched 11 IsLiquidDetectedLatched 12 IsReverseFlowDetectedLatched 13 IsSndVelCompErrLatched 14 IsAcqModuleErrorLatched 15 IsMeterVelAboveMaxLmtLatched 16 Temp er at ur eI nva l idL at ch ed 17 PressureInvalidLatched 18 IsAcqModeLatched 19 IsTooFewOperChordsLatched 20 IsFwdBaselineNotSet 21 IsRevBaselineNotSet 22 IsDiagnosticSndSpdRangeErrLatched
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
Page 72
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3-4 Undefined 5 Error Too Few Data Bytes Received 6 Error Device-specific command error 7-31 Undefined 32 Error Busy 33-127 Undefined
The selected alarm to acknowledge
does not exist.
Command 141 Acknowledge alarm 57
Page 73
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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 Applicable when the digital input is used as a general purpose
1 Enum-8 Calibration input polarity Applicable when the digital input is used for calibration. Specifies
2 Enum-8 Calibrating gating type Applicable when the digital input is used for calibration. Specifies
3 Enum-8 Digital Input 1 mode
input. Specifies the digital input polarity for interpreting the input value. Used to set DI1IsInvPolarity.
the digital input polarity for starting/stopping calibration. Used to set IsDI1ForCalActiveLow.
the digital input polarity for starting/stopping calibration. Used to set IsDI1ForCalStateGated.
Writes DI1Mode
Response data bytes
Same as Request data bytes.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3-4 Undefined 5 Error Too Few Data Bytes Received 6Undefined 7 Error In Write Protect Mode 8-31 Undefined 32 Error Busy 33-127 Undefined
Dl1IsInvPolarity, IsDl1ForCalActiveLow,
IsDl1ForCalStateGated or Dl1Mode selection invalid.
58 Command 142 Write digital input configuration
Page 74
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.16 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 Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
Command 143 Read digital input configuration 59
Page 75
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
10.1.17 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 Explanation
0 Success No Command-Specific Errors 1-5 Undefined 6 Error Device-Specific Command Error 7-31 Undefined 32 Error Busy 33-127 Undefined
60 Command 146 Read Miscellaneous Non-Write Protected Parameters
Page 76
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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 least-
significant 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
7 Enum-8 U.S. Customary volume unit for Modbus
communications
8 Enum-8 Metric volume unit for Modbus
communications
Reads VolFlowRateTimeUnit
Reads VolUnitUS
Reads VolUnitMetric
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-5 Undefined 6 Error Device-Specific Command Error 7-31 Undefined 32 Error Busy 33-127 Undefined
Command 147 Read miscellaneous write protected parameters 61
Page 77
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
10.1.19 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
Response data bytes
Same as Request data bytes.
Writes BlockageTurbulenceLmtA
Writes BlockageTurbulenceLmtB
Writes BlockageTurbulenceLmtC
Writes BlockageTurbulenceLmtD
Writes BlockageCrossFlowLmt
Writes BlockageSymmetryLmt
Writes IsBlockageDetectionEnabled
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3 Error Passed Parameter Too High
4 Error Passed Parameter Too Low
5 Error Too Few Bytes Received 6 Device-Specific Command Error 7 Error In Write Protect Mode 8-31 Undefined 32 Error Busy 33-127 Undefined
Blockage Detection Enabled is not equal
to 0 or 1
Alarm limit too high
Alarm limit too low (or negative)
62 Command 148 Write blockage configuration
Page 78
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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 Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
Command 149 Read blockage configuration 63
Page 79
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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
8-11 Float Liquid Detection Standard Deviation
Symmetry Limit
12 Enum-8 Enable Liquid Detection
Response data bytes
Writes LiquidDetectionSDevProfileFactorLmt
Writes LiquidDetectionSDevCrossFlowLmt
Writes LiquidDetectionSDevSymmetryLmt
Writes IsLiquidDetectionEnabled.
Note: Liquid Detection is only active if IsLiquidDe- tectionFeatureActive is TRUE(1) which depends on this datapoint and the option keys being valid. Allowed values are 0 or 1.
Same as Request data bytes.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection Enable Liquid Detection is not a 0 or 1 3 Error Passed Parameter Too High Alarm limit too high 4 Error Passed Parameter Too Low Alarm limit too low (or negative) 5 Error Too Few Bytes Received 6 Error Device-Specific Command Error 7 Error In Write Protect Mode 8-31 Undefined 32 Error Busy 33-127 Undefined
64 Command 150 Write liquid detection configuration
Page 80
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.22 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 Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
Command 151 Read liquid detection configuration 65
Page 81
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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 Explanation
0 Enum-8 Reads the datapoint Bore Buildup
Detection Active
1 Enum-8 Reads the datapoint Blockage Detection
Active
2 Enum-8 Reads the datapoint Liquid Detection
Active
3 Enum-8 Reads the datapoint Abnormal Profile
Active
4 Enum-8 Reads the datapoint Sound Velocity Com-
parison Active
5 Enum-8 Diagnostic speed of sound check active
Reads IsBoreBuildupDetectionFeatureActive
Reads IsBlockageDetectionFeatureActive
Reads IsLiquidDetectionFeatureActive
Reads IsAbnormalProfileDetectionFeatureActive
Reads IsSndVelCompFeatureActive
Reads IsDiagnosticSndSpdDetectionFeatureActive
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
66 Command 152 Read continuous flow analysis active features
Page 82
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.24 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. 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 Explanation
0-3 Float
4-7 Float
8-11 Float
12-15 Float
16-19 Float
20-23 Float
24-27 Float
28-31 Float
32-35 Float
36-39 Float
40-43 Float
44-47 Float
48-51 Float
52-55 Float
56 Enum-8
57 Enum-8
58 Enum-8
59 Enum-8
60 Enum-8
Average Flow Temperature
Average Flow Pressure
Average Turbulence A
Average Turbulence B
Average Turbulence C
Average Turbulence D
Average Flow
Average Cross Flow
Average Profile Factor
Average Swirl Angle
Average Symmetry
Average Standard Deviation of Cross Flow
Average Standard Deviation of Profile Factor
Average Standard Deviation of Symmetry
Running average validity
Flow Direction
Units Code for Temperature values (see Table 11-7)
Units Code for Pressure values (see Table 11-6)
Units Code for flow velocity (see Table 11-8)
Reads RunningAvgFlowTemperature
Reads RunningAvgFlowPressure
Reads RunningAvgTurbulenceA
Reads RunningAvgTurbulenceB
Reads RunningAvgTurbulenceC*
Reads RunningAvgTurbulenceD*
Reads RunningAvgAvgFlow
Reads RunningAvgCrossFlow
Reads RunningAvgProfileFactor
Reads RunningAvgSwirlAngle
Reads RunningAvgSymmetry
Reads RunningAvgSDevCrossFlow
Reads RunningAvgSDevProfileFactor
Reads RunningAvgSDevSymmetry
Reads IsRunningAvgValid
Reads FlowDirection
Units for Average Flow Temperature.
Can only be valid units for tempera­ture (HARTTemperatureUnit).
Units for Average Flow Pressure. Can
only be valid units for pressure (HART- PressureUnit).
Units code for Average Flow. Can
only be valid units for flow velocity (HART-VelUnit).
See Section 11
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-5 Undefined
Command 153 Read running averages 67
Page 83
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
Code Class Description Explanation
6 Error Device-Specific Command Error 7-31 Undefined 32 Error Busy 33-127 Undefined
68 Command 153 Read running averages
Page 84
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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
Response data bytes
Byte Format Description Explanation
0 Enum-8 Forward/Reverse selection
1-4 Float Reads the datapoint Profile Factor (direction
depends on request byte 0)
5-8 Float Reads the datapoint Flow Pressure (direction
depends on request byte 0)
9-12 Float Reads the datapoint Turbulence A (direction
depends on request byte 0)
13-16 Float Reads the datapoint Turbulence B (direction
depends on request byte 0)
17-20 Float Reads the datapoint Turbulence C (direction
depends on request byte 0)
21-24 Float Reads the datapoint Turbulence D (direction
depends on request byte 0)
25-28 Float Reads the datapoint Average Flow (direction
depends on request byte 0)
29-32 Float Reads the datapoint forward or reverse Base-
lineCrossFlow (direction depends on request byte 0)
33-36 Float Reads the datapoint forward or reverse
BaselineSwirlAngle (direction depends on request byte 0)
37-40 Float Reads the datapoint forward or reverse
BaselineSymmetry (direction depends on request byte 0)
41-44 Float Reads the datapoint forward or reverse
BaselineFlowTemperature (direction depends on request byte 0)
45 Unsigned-8 Reads the datapoint Baseline Not Set Boolean
46 Enum-8 Units Code for Flow Temperature
(see Table 11-7)
0 = Reverse
1 = Forward
0 = Reverse
1 = Forward
FwdBaselineProfileFactor or RevBaselineProfile-
Factor
FwdBaselineFlowPressure or RevBaselineFlow-
Pressure
FwdBaselineTurbulenceA or RevBaselineTurbu-
lenceA
Constant units of percentage
FwdBaselineTurbulenceB or RevBaselineTurbu-
lenceB
Constant units of percentage
FwdBaselineTurbulenceC* or RevBaselineTurbu-
lenceC
Constant units of percentage
FwdBaselineTurbulenceD* or RevBaselineTur-
bulenceD
Constant units of percentage
FwdBaselineAvgFlow or RevBaselineAvgFlow
FwdBaselineCrossFlow or RevBaselineCrossFlow
FwdBaselineSwirlAngle or RevBaselineSwirlAn-
gle
FwdBaselineSymmetry or RevBaselineSymmetry
FwdBaselineFlowTemperature or
RevBaselineFlowTemperature
IsFwdBaselineNotSet or IsRevBaselineNotSet
Units for Flow Temperature
This can only be a units code allowed for tem-
perature values (HARTTemperatureUnit).
Command 154 Read baselines 69
Page 85
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
Byte Format Description Explanation
47 Enum-8 Units Code for Flow Pressure
(see Table 11-6)
48 Enum-8 Units Code for flow velocity
(see Table 11-8)
Units for Flow Pressure
This can only be a units code allowed for
pressure values (HARTPressureUnit).
Units for Average Flow
This can only be a units code allowed for flow
velocity values (HARTVelUnit).
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3-4 Undefined 5 Error Too few Data Bytes Received 6 Error Device-Specific Command Error 7-31 Error Undefined 32 Error Busy 33-127 Undefined
Invalid value for Forward / Reverse Selection
70 Command 154 Read baselines
Page 86
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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 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 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
IsFwdBaselineNotSet and IsRevBaselineNotSet Booleans will be cleared if the baseline set
IsAnyBaselineAvail is FALSE, then this command responds with “command not
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. 1-4 Float Profile Factor Writes XBaselineProfileFactor. 5-8 Float Flow Pressure Writes XBaselineFlowPressure. 9-12 Float Turbulence A Constant units of percentage.
Writes XBaselineTurbulenceA. 13-16 Float Turbulence B Constant units of percentage.
17-20 Float Turbulence C Constant units of percentage.
21-24 Float Turbulence D Constant units of percentage.
25-28 Float Average Flow Writes XBaselineAvgFlow. 29-32 Float Cross Flow Writes XBaselineCrossFlow. 33-36 Float Swirl Angle Writes XBaselineSwirlAngle. Constant units of
37-40 Float Symmetry Writes XBaselineSymmetry. 41-44 Float Flow Temperature Writes XBaselineFlowTemperature. 45 Enum-8
Units Code for Flow Temperature (see Table
11-7)
Writes XBaselineTurbulenceB.
Writes XBaselineTurbulenceC.
Writes XBaselineTurbulenceD.
degrees.
Units for Flow Temperature. This can only be a
units code allowed for temperature values (HART-
Tem pe ra tu re Un it ).
This is an INFO variable; when written, it is not
updated in the device
Command 155 Write baselines 71
Page 87
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
Byte Format Description Explanation
46 Enum-8
47 Enum-8
Units Code for Flow Pressure (see Table 11-6)
Units Code for flow velocity (see Table 11-8)
Units for Flow Pressure. This can only be a units
code allowed for pressure values (HARTPressure-
Unit).
This is an INFO variable; when written, it is not
updated in the device.
Units for Average Flow. This can only be a units
code allowed for flow velocity values (HARTVel-
Unit).
This is an INFO 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 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3 Error Passed Parameter Too High
4 Error Passed Parameter Too Low
5 Error Too Few Bytes Received 6 Device-Specific Command Error 7 Error In Write Protect Mode 8-17 Undefined 18 Error Invalid Units Code
19-31 Undefined 32 Error Busy 33-127 Undefined
Invalid value for Forward / Reverse Selection
A baseline value was too high
A baseline value was too low
One or more of the units codes are invalid
72 Command 155 Write baselines
Page 88
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
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 Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
Command 156 Read keys 73
Page 89
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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
12-23 Packed
ASCII
24-35 Packed
ASCII
Response data bytes
AGA10 Key
GC Key
Flow Analysis Key
Same as Request data bytes.
Writes AGA10Key.
Writes the GCKey.
Writes ContinuousFlowAnalysisKey.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-4 Undefined 5 Error Too Few Bytes Received 6 Error Device-Specific Command Error 7-11 Undefined 12 Error Invalid Format
13-31 Undefined 32 Error Busy 33-127 Undefined
A key was either not in the correct format
(HEX only) or the key was invalid
74 Command 157 Write keys
Page 90
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.29 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 Explanation
0Enum-8AGA10 key validity
1 Enum-8 GC key validity
2 Enum-8 Continuous Flow Analysis key validity
Command-specific response codes
Reads IsOptionalAGA10CalcEnabled
Reads IsOptionalGCInterfaceEnabled
Reads IsOptional ContinuousFlowAnalysisEn-
abled
Code Class Description Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
Command 158 Read key validities 75
Page 91
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
10.1.30 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 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
Response data bytes
Byte Format Description Explanation
0-3 Float Flow Velocity Chord A
4-7 Float Flow Velocity Chord B
8-11 Float
12-15 Float
16-19 Float Sound Velocity Chord A
20-23 Float Sound Velocity Chord B
24-27 Float
28-31 Float
32-35 Float Turbulence Chord A
36-39 Float Turbulence Chord B
40-43 Float
44-47 Float
48 Enum-8 Units Code for velocity
Flow Velocity Chord C
Flow Velocity Chord D
Sound Velocity Chord C*•Reads SndVelC*
Sound Velocity Chord D
Tur bule nce Chord C
Tur bule nce Chord D
(see Table 11-8)
*•Reads Tu rb ul en ceC *
*•Reads Tu rb ul en ceD *
* Reads FlowVelC*
* Reads FlowVelD*
*•Reads SndVelD*
Reads FlowVelA
Reads FlowVelB
Reads SndVelA
Reads SndVelB
Reads Tu rb ul en ceA
Reads Tu rb ul en ceB
Units code that applies to all velocity values in
this message.
Section 11.8. Turbulence units are
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-5 Undefined 6 Error Device-Specific Command Error 7-31 Undefined 32 Error Busy 33-127 Undefined
76 Command 159 Read meter chord data
Page 92
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.31 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
Response data bytes
Byte Format Description Explanation
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 SOS Comparison Difference.
SOSComparePctDiff is the difference between AGA10 Sound velocity and meter measured sound velocity. Implied unit is percentage
36 Enum-8 Sets the flow direction Flow Direction:
37 Enum-8 Units code for velocity
38 Enum-8 Units code for volume
Reads Symmetry
Reads CrossFlow
Reads Profile Factor
Reads SwirlAngle
Reads AvgFlow
Reads AvgSndVel
Reads Reverse FlowVol
Reads AGA10SndVel
Reads SOSComparePctDiff
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 Explanation
0 Success No Command-Specific Errors 1-5 Undefined 6 Error Device-Specific Command Error 7-31 Undefined 32 Error Busy 33-127 Undefined
Command 160 Read meter flow data 77
Page 93
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
10.1.32 Command 161 Read path signal amplitude data
This command reads the path Signal Amplitude data. Voltage units codes in Table 11-1 2.
*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 Explanation
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
20-23 Float
24-27 Float
28-31 Float
32 Enum-8 Units for amplitude points
Signal Amplitude C
Signal Amplitude C
Signal Amplitude D
Signal Amplitude D
* upstream
* downstream
* upstream
* downstream
Reads SignalAmplitudeA1
Reads SignalAmplitudeA2
Reads SignalAmplitudeB1
Reads SignalAmplitudeB2
Reads SignalAmplitudeC1*
Reads SignalAmplitudeC2*
Reads SignalAmplitudeD1*
Reads SignalAmplitudeD2*
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 Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
78 Command 161 Read path signal amplitude data
Page 94
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.33 Command 162 Read noise amplitudes
This command reads the path noise amplitudes. Units codes for voltage are specified in
Table 11-1 2.
* Ta bl e 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 Explanation
0-3 Float Noise Amplitude A upstream
4-7 Float Noise Amplitude A downstream
8-11 Float Noise Amplitude B upstream
12-15 Float Noise Amplitude B downstream
16-19 Float
20-23 Float
24-27 Float
28-31 Float
32 Enum-8 Units for amplitudes.
Noise Amplitude C* upstream
Noise Amplitude C
Noise Amplitude D
Noise Amplitude D
* downstream
* upstream
* downstream
Reads NoiseAmplitudeA1
Reads NoiseAmplitudeA2
Reads NoiseAmplitudeB1
Reads NoiseAmplitudeB2
Reads NoiseAmplitudeC1*
Reads NoiseAmplitudeC2*
Reads NoiseAmplitudeD1*
Reads NoiseAmplitudeD2*
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 Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
Command 162 Read noise amplitudes 79
Page 95
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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 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 Explanation
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
20-23 Float
24-27 Float
28-31 Float
32 Enum-8 Units decibel codes
Signal Noise Ratio C
Signal Noise Ratio C
Signal Noise Ratio D
Signal Noise Ratio D
* upstream
* downstream
* upstream
* downstream
Table 11-1 1. *Note: Chords C and D are not
Reads SNRA1
Reads SNRA2
Reads SNRB1
Reads SNRB2
Reads SNRC1*
Reads SNRC2*
Reads SNRD1*
Reads SNRD2*
HART Unit code for SNR ratio. Must be decibel
units (see Table 11-11).
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
80 Command 163 Read path SNR data
Page 96
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.35 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. 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 Explanation
0-3 Float Percent Good Path A upstream
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
20-23 Float
24-27 Float
28-31 Float
Percent Good Path C* upstream
Percent Good Path C
Percent Good Path D
Percent Good Path D
* downstream
* upstream
* downstream
Reads PctGoodA1
Reads PctGoodA2
Reads PctGoodB1
Reads PctGoodB2
Reads PctGoodC1*
Reads PctGoodC2*
Reads PctGoodD1*
Reads PctGoodD2*
*Note: Chords C and D are not
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
Command 164 Read path percent good 81
Page 97
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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. 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 Explanation
0-3 Float Gain when transducer A1 (upstream) is
receiving a signal
4-7 Float Gain when transducer A2 (downstream stream)
is receiving a signal
8-11 Float Gain when transducer B1 (upstream) is
12-15 Float Gain when transducer B2 (downstream stream)
16-19 Float
20-23 Float
24-27 Float
28-31 Float
32 Enum-8 Units decibel codes
receiving a signal
is receiving a signal Gain when transducer C1
receiving a signal Gain when transducer C2
stream) is receiving a signal Gain when transducer D1
receiving a signal Gain when transducer D2
stream) is receiving a signal
* (upstream) is
* (downstream
* (upstream) is
* (downstream
Reads GainA1
Reads GainA2
Reads GainB1
Reads GainB2
Reads GainC1*
Reads GainC2*
Reads GainD1*
Reads GainD2*
HART Units enum for all gain points read.
Must be dB units (see Table 11-11).
*Note:
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-31 Undefined 32 Error Busy 33-127 Undefined
82 Command 165 Read path gains
Page 98
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.37 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 Explanation
0-3 Float Reads the database point Flow Analysis Low
Flow Limit
4-7 Float Reads the database point Flow Analysis High
Flow Limit
8-11 Float Reads the database point Reverse Flow Volume
Limit
12-15 Float 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.
16 Enum-8 Reads the Units code enum for flow velocity
17 Enum-8 Reads the Units code for volume values
18 Enum-8 Enables reverse flow detection. Reads the
database point Reverse Flow Detection Enabled
19 Enum-8 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.
Reads FlowAnalysisLowFlowLmt
Reads FlowAnalysisHighFlowLmt
Reads Reverse FlowVolLmt
Reads ReverseFlowDetectionZeroCut
Units code for all flow velocity values in this
message. See Table 11-8.
Units code for ReverseFlowVolLmt.
See Table 11-1
Reads IsReverseFlowDetectionEnabled
Reads IsAnyBaselineAvail
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1-5 Undefined 6 Error Device-Specific Command Error 7-31 Undefined 32 Error Busy 33-127 Undefined
Command 166 Read flow analysis configuration 83
Page 99
HART Field Device Specification 3410 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0400-3240
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 Explanation
0-3 Float Writes the database point Flow Analysis Low
Flow Limit
4-7 Float Writes the database point Flow Analysis High
Flow Limit
8-11 Float Writes the database point Reverse Flow Volume
Limit
Reads FlowAnalysisLowFlowLmt
Reads FlowAnalysisHighFlowLmt
Reads ReverseFlowVolLmt
12-15 Float Writes the database point Reverse Flow
Detection Zero Cut
16 Enum-8 Units code for reverse flow velocity values. This
17 Enum-8
18 Enum-8 Enable for reverse flow detection. Writes the
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.
Units code for volume values (see Table 11-1)
point Reverse Flow Detection Enabled
Reads ReverseFlowDetectionZeroCut
Reads ReverseFlowVolLmt velocity units code
This is an informational variable; when written, it is
not updated in the device.
Units code for Reverse Flow Limit. This must be a
valid units code for volume (HARTVolUnit).
This is an INFO variable; when written, it is not
updated in the device.
Reads IsReverseFlowDetectionEnabled.
Response data bytes
Same as Request data bytes.
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors 1Undefined 2 Error Invalid Selection
3 Error Passed Parameter Too High
4 Error Passed Parameter Too Low
5 Error Too Few Bytes Received 6 Error Device-Specific Command Error 7ErrorIn Write Protect Mode 8-17 Undefined 18 Error Invalid Units Code
19-31 Undefined 32 Error Busy 33-127 Undefined
Boolean neither 0 or 1
Alarm limit too high
Alarm limit too low (or negative)
The units code for velocity or volume is not
valid
84 Command 167 Write flow analysis configuration
Page 100
10. Device-specific commandsHART Field Device Specification 3410 Series Ultrasonic Meter
00825-0400-3240 April 2022
10.1.39 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 Explanation
0-1 Unsigned
Integer
2-7 Packed
ASCII
8-19 Packed
ASCII
Reads the database point Device Number
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 CPUBd- SwIntVer 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 char­acters, 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
20 Enum-8 Chordal configuration
21 Unsigned-8 Optional I/O Module type in slot 1.
22 Unsigned-8 Optional I/O Module type in slot 2.
23 Enum-8 Diagnostic Chord Enable
Reads the database point ChordalConfig
Reads the database point OptIOModule1Type
Reads the database point OptIOModule2Type
Reads IsDiagnosticChordEnable
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors
1-5 Undefined
6 Error Device-Specific Command Error
7-31 Undefined
32 Error Busy
33-127 Undefined
Command 168 Read general meter information 85
Loading...