Rosemount 3810 Series Ultrasonic Flow Meters HART Field Device Specification Quick Start Guide
Page 1
HART® Field Device Specification
00825-0300-3810, Rev AA
Rosemount™ 3810 Series Liquid Ultrasonic
Meter
April 2022
3814 Liquid Ultrasonic Flow Meter
3818 LNG Liquid Ultrasonic Flow Meter
3812 Liquid Ultrasonic Flow Meter
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
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
Contents
1. Introduction
1.1 Scope ............................................................................................................ 1
1.2 Purpose ......................................................................................................... 1
1.3 Who should use this document? ...................................................................... 1
1.4 Definitions, abbreviations, acronyms and references ......................................... 1
1.4.1 Definitions........................................................................................................... 2
1.4.2 Acronyms............................................................................................................. 2
1.4.3 Abbreviations....................................................................................................... 2
1.4.4 References ........................................................................................................... 3
2. Device identification
Contents
April 2022
2.1 Rosemount 3810 Series Liquid Ultrasonic Flow Meter identification ................... 5
2.2 Physical description ........................................................................................6
3. Product overview
3.1 Device function, purpose and features ............................................................. 7
3.2 Process connections ....................................................................................... 7
3.3 External interfaces (electrical and non-electrical) .............................................. 7
3.4 Other required equipment............................................................................... 7
4. Product interfaces
4.1 Process interfaces ........................................................................................... 9
4.1.1 Sensor input channels .......................................................................................... 9
4.1.2 Sensor analog output channels........................................................................... 10
4.1.3 Time Stamp........................................................................................................ 13
5. Device variables
5.1 Device variable 0 - uncorrected flow rate ........................................................ 15
5.2 Device variable 6 - pressure ........................................................................... 15
5.3 Device variable 7 - temperature ..................................................................... 16
5.4 HART slave device variables good status indicators .......................................... 16
6. Dynamic variables
Contents i
Page 5
HART Field Device Specification 3810 Series Ultrasonic MeterContents
April 2022 00825-0300-3810
6.1 Fixed dynamic variables ................................................................................. 17
6.2 Dynamic variables with configurable mapping.................................................17
7. Status information
7.1 Device status ................................................................................................20
7.2 Additional device status (Command 48).......................................................... 22
8. Universal commands
8.1 HART universal commands.............................................................................27
9. Common-practice commands
9.1 Supported commands ...................................................................................29
9.2 Burst Mode ...................................................................................................30
9.3 Catch Device Variable .................................................................................... 30
10. Device-specific commands
10.1 Public, device-specific commands ................................................................31
10.1.1 Command 128 Write analog output configuration .............................................32
10.1.2 Command 129 Read analog output configuration ..............................................34
10.1.3 Command 130 Write Frequency/Digital Output configuration ...........................35
10.1.4 Command 131 Read frequency and digital output configuration........................37
10.1.5 Command 132 Write flow pressure configuration ..............................................38
10.1.6 Command 133 Read flow pressure configuration ...............................................40
10.1.7 Command 134 Write flow temperature configuration ........................................41
10.1.8 Command 135 Read flow temperature configuration.........................................43
10.1.9 Command 136 Write device units.......................................................................44
10.1.10 Command 137 Read device units......................................................................45
10.1.11 Command 138 Write device variable range.......................................................46
10.1.12 Command 139 Read device variable range........................................................48
10.1.13 Command 140 Read detailed status..................................................................49
10.1.14 Command 141 Acknowledge alarm ..................................................................52
10.1.15 Command 142 Write digital input configuration...............................................54
10.1.16 Command 143 Read digital input configuration................................................55
10.1.17 Command 144 Read velocity zero calibration status.........................................56
10.1.18 Command 145 Write velocity zero calibration control ......................................58
10.1.19 Command 146 Read Miscellaneous Non-Write Protected Parameters ..............63
10.1.20 Command 147 Read miscellaneous write protected parameters ......................64
10.1.21 Command 153 Read running averages..............................................................65
10.1.22 Command 154 Read Baselines ..........................................................................67
10.1.23 Command 155 Write Baselines .........................................................................69
10.1.24 Command 159 Read meter chord data .............................................................71
10.1.25 Command 160 Read meter flow data................................................................72
ii
Contents
Page 6
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
10.1.26 Command 161 Read path signal amplitude data .............................................. 73
10.1.27 Command 162 Read noise amplitudes ............................................................. 74
10.1.28 Command 163 Read path SNR data.................................................................. 75
10.1.29 Command 164 Read path percent good ........................................................... 76
10.1.30 Command 165 Read path gains........................................................................ 77
10.1.31 Command 166 Read flow analysis configuration............................................... 78
10.1.32 Command 167 Write flow analysis configuration.............................................. 79
10.1.33 Command 168 Read general meter information............................................... 81
10.1.34 Command 169 Read flow totals........................................................................ 82
10.1.35 Command 172 Write Ethernet configuration.................................................... 83
10.1.36 Command 173 Read Ethernet Configuration .................................................... 85
10.1.37 Command 174 Write serial port configuration.................................................. 86
10.1.38 Command 175 Read serial port configuration................................................... 88
10.1.39 Command 176 Write transducer chord configuration....................................... 89
10.1.40 Command 177 Read transducer chord configuration ....................................... 90
10.1.41 Command 178 Write polynomial calibration configuration .............................. 91
10.1.42 Command 179 Read polynomial calibration configuration ............................... 92
10.1.43 Command 180 Write meter factor.................................................................... 93
10.1.44 Command 181 Read meter factor..................................................................... 94
10.1.45 Command 182 Write archive log configuration ................................................ 95
10.1.46 Command 183 Read Archive Log configuration................................................ 96
10.1.47 Command 184 Write acquisition configuration ................................................ 97
10.1.48 Command 185 Read acquisition configuration ................................................. 99
10.1.49 Command 186 Write meter limits .................................................................. 100
10.1.50 Command 187 Read meter limits ................................................................... 102
10.1.51 Command 188 Write meter body configuration .............................................103
10.1.52 Command 189 Read meter body configuration.............................................. 105
10.1.53 Command 190 Write signal parameters ......................................................... 106
10.1.54 Command 191 Read signal parameters ..........................................................108
10.1.55 Command 192 Write target parameters......................................................... 109
10.1.56 Command 193 Read target parameters.......................................................... 111
10.1.57 Command 194 Reset chord proportions to defaults ....................................... 112
10.1.58 Command 195 Enter/exit fixed frequency output mode ................................. 113
10.1.59 Command 196 Enter/exit fixed digital output mode.......................................114
10.1.60 Command 197 Set transducer type ................................................................115
10.1.61 Command 198 Write Frequency/Digital Output sources ................................ 117
10.1.62 Command 199 Read Frequency/Digital Output sources .................................119
10.1.63 Command 200 Write miscellaneous write protected parameters ................... 120
10.1.64 Command 201 Write analog input calibration ................................................ 121
10.1.65 Command 202 Read analog input calibration ................................................. 122
10.1.66 Command 203 Write piecewise linearization flow rates.................................. 123
10.1.67 Command 204 Read piecewise linearization flow rates................................... 125
Contents
April 2022
Contents iii
Page 7
HART Field Device Specification 3810 Series Ultrasonic MeterContents
April 2022 00825-0300-3810
10.1.68 Command 205 Write piecewise linearization meter factors ............................126
10.1.69 Command 206 Read piecewise linearization meter factors .............................127
10.1.70 Command 207 Write meter text .....................................................................128
10.1.71 Command 208 Read meter text......................................................................129
10.1.72 Command 217 Write baseline times and comments.......................................130
10.1.73 Command 218 Read baseline times and comments........................................132
10.1.74 Command 219 Reset tracking targets to defaults ...........................................133
10.1.75 Command 220 Write local display configuration.............................................134
10.1.76 Command 221 Read local display configuration..............................................136
10.1.77 Command 222 Enable local display test mode ................................................137
10.1.78 Command 223 Write general meter information ............................................138
10.1.79 Command 224 Write miscellaneous non-write protected
parameters....................................................................................................... 139
10.1.80 Comman
d 225 Write Piecewise Linearization High Viscosity Meter Factors
parameters....................................................................................................... 141
10.1.81 Command 226 Read Piecewise Linearization High Viscosity Meter Factors .....143
10.1.82 Command 227 Write Piecewise Linearization Profile Factors...........................144
10.1.83 Command 228 Read Piecewise Linearization Profile Factors............................146
10.1.84 Command 231 Enter/Exit Fixed Analog Output Mode .....................................147
10.2 Device-specific command error (response code 6) ....................................... 148
11. Tables
11.1 Volume units ............................................................................................ 149
11.2 Time units (flow rate) ................................................................................ 149
11.3 Volumetric flow rate units .......................................................................... 150
11.4 Pressure units ........................................................................................... 150
11.5 Temperature units ..................................................................................... 151
11.6 Velocity units ............................................................................................ 151
11.7 Decibel units............................................................................................. 151
11.8 Voltage units ............................................................................................ 151
11.9 Current units ............................................................................................ 152
11.10 Percent units ........................................................................................... 152
11.11 Length units ............................................................................................ 152
11.12 Thermal expansion units .......................................................................... 152
11.13 Viscosity units ......................................................................................... 153
11.14 Unit conversion factors ............................................................................153
iv
Contents
Page 8
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
11.15 Pressure and temperature tables .............................................................. 154
11.15.1 Live pressure................................................................................................... 155
11.15.2 Live temperature ........................................................................................... 156
Contents
12. Performance
12.1 Sampling rates.......................................................................................... 157
12.2 Power-up .................................................................................................. 157
12.3 Device reset ............................................................................................. 158
12.4 Self test ................................................................................................... 158
12.5 Command response delay .......................................................................... 158
12.5.1 Long messages................................................................................................. 159
12.5.2 Non-volatile memory ....................................................................................... 159
12.5.3 Operating modes ............................................................................................. 159
12.5.4 Write protection............................................................................................... 159
12.5.5 Damping value ................................................................................................. 159
A Annex A. Device capability checklist
A.1 Device capability ...................................................................................................... 161
B Annex B. Default device configuration
B.1 Default factory settings ............................................................................................ 163
C Annex C. Device variable calculations
C.1 Uncorrected flow rate............................................................................................... 165
C.2 Pressure ................................................................................................................... 166
C.3 Temperature ............................................................................................................ 166
D Annex D. Supported field device operations
D.1 AMS Device Manager ............................................................................................... 167
D.2 375/475 field communicator menu tree .................................................................. 168
E Annex E. Revision history
E.1 Document release..................................................................................................... 169
E.2 Changes Revision 2 ................................................................................................... 170
E.3 Changes Revision 3 ................................................................................................... 172
E.4 Changes Revision 4 ................................................................................................... 174
E.5 Changes Revision 5 ................................................................................................... 175
Contents v
Page 9
HART Field Device Specification 3810 Series Ultrasonic MeterContents
April 2022 00825-0300-3810
vi
Contents
Page 10
List of FiguresHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
List of Figures
Figure 2-1 3810 Series Liquid Ultrasonic Flow Meter Electronics - CPU Module .................................. 6
Figure D-1 AMS Device Manage menu tree..................................................................................... 167
List of Figures VII
Page 11
List of Figures HART Field Device Specification 3810 Series Ultrasonic Meter
April 2022 00825-0300-3810
VIII List of Figures
Page 12
List of TablesHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 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 3810 Series Liquid Ultrasonic Flow Meter device identification........................................... 5
Table 4-1 Analog output configuration parameters ......................................................................... 11
Table 4-2 Device variables time stamp............................................................................................. 13
Table 4-3 Time stamp calculations for additional device variables.................................................... 13
Table 5-1 Device variable 0 - uncorrected flow rate.......................................................................... 15
Table 5-2 Device variable 6 - pressure ............................................................................................. 15
Table 5-3 Device variable 7 - temperature ....................................................................................... 16
Table 5-4 Device variable good indicators........................................................................................ 16
Table 6-1 Dynamic variables configurable mapping......................................................................... 17
Table 7-1 Device status byte database point mapping ..................................................................... 20
Table 7-2 Additional device status (Command 48)........................................................................... 22
Table 8-1 HART universal commands for slave implementation....................................................... 27
Table 9-1 Common-practice commands.......................................................................................... 29
Table 11-1 Volume units.................................................................................................................. 149
Table 11-2 Time units ...................................................................................................................... 149
Table 11-3 Volumetric flow rate engineering unit codes.................................................................. 150
Table 11-4 Pressure units................................................................................................................. 150
Table 11-5 Temperature units.......................................................................................................... 151
Table 11-6 Velocity units ................................................................................................................. 151
Table 11-7 Decibel units .................................................................................................................. 151
Table 11-8 Voltage units.................................................................................................................. 151
Table 11-9 Current units .................................................................................................................. 152
Table 11-10 Percent units .................................................................................................................. 152
Table 11-11 Length units ................................................................................................................... 152
Table 11-12 Thermal Expansion units................................................................................................. 152
Table 11-13 Viscosity units ................................................................................................................ 153
Table 11-14 Unit conversion factors................................................................................................... 153
Table 11-15 Pressure and temperature tables.................................................................................... 154
Table 11-16 Data points for pressure inputs....................................................................................... 155
List of Tables IX
Page 13
List of Tables HART Field Device Specification 3810 Series Ultrasonic Meter
April 2022 00825-0300-3810
Table 11-17 Data points for temperature inputs ................................................................................156
Table 12-1 Sampling rates................................................................................................................157
Table 12-2 Command 42 device reset ..............................................................................................158
Table 12-3 Command response delay ..............................................................................................158
Table A-1 Capability checklist .........................................................................................................161
Table B-1 Device factory settings configuration .............................................................................163
X List of Tables
Page 14
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
10
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 Rosemount 3810 Series Liquid Ultrasonic Flow Meters,
Purpose
The purpose of this document is to list the functional requirements for developing the 3810
Series Liquid 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. This document assumes the reader is
familiar with HART Protocol requirements and terminology.
Definitions, abbreviations, acronyms and
references
The following is a list of commonly used definitions used throughout this document.
Scope 1
Page 15
1. Introduction HART Field Device Specification 3810 Series Ultrasonic Meter
April 2022 00825-0300-3810
1.4.1 Definitions
Table 1-1 Definitions
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
ATE X Atmospheres E xplosives (Fren ch)
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 16
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
1.4.4 References
The documents referenced within the text of this document are listed in the table below:
Table 1-4 Reference documentation
Title Document number, revision, date
1. Introduction
April 2022
American Petroleum Institute (API) Manual of Petroleum Measurement 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 17
1. Introduction HART Field Device Specification 3810 Series Ultrasonic Meter
April 2022 00825-0300-3810
4 References
Page 18
2. Device identificationHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
21
2. Device identification
This section details the Rosemount 3810 Series Liquid Ultrasonic Flow Meter identification
and physical description.
2.1
Rosemount 3810 Series Liquid Ultrasonic Flow
Meter identification
The Rosemount 3810 Series Liquid Ultrasonic Flow Meter Field Device Identification
summary is shown in Table 2-1 below.
Table 2-1 3810 Series Liquid Ultrasonic Flow Meter device identification
Rosemount 3810
Series Liquid
Manufacturer Name:
Manufacture ID Code: 13 (D Hex) Device Type Code: 41 (29 Hex)
HART Protocol Revision: 7 Device Revision: 6
Number of Device Variables: 3
Physical Layers Supported: Bell 202 FSK Note:
Physical Device Category:
Emerson
Rosemount Series 3810
Liquid Ultrasonic F
low Meter
Model Name(s):
HART Hardware Revision 4
HART Software Revision: 26
Ultrasonic Flow
Meter
Rosemount 3810 Series Liquid Ultrasonic Flow Meter identification
5
Page 19
HART Field Device Specification 3810 Series Ultrasonic Meter2. Device identification
April 2022 00825-0300-3810
2.2 Physical description
The Series 3810 Liquid Ultrasonic Meter electronics enables the meter to easily communicate
with other field devices, and ultimately, communicate key diagnostic information through
PlantWeb 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 3810 Series Liquid Ultrasonic Flow Meter Electronics - CPU Module
6 Physical description
Page 20
3. Product overviewHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
3. Product overview
This section specifies the purpose and application of the Rosemount 3810 Series Liquid
Ultrasonic Flow Meter for HART communications.
3.1
3.2
3.3
Device function, purpose and features
The Rosemount 3810 Series Liquid Ultrasonic Flow Meter enables communication 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 3810 Series Liquid Ultrasonic Flow Meter’s electronics (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 3810 Series Liquid Ultrasonic
Flow Meter is configured using a hand-held communicator (e.g., Emerson's 375 Field
Communicator) and not via the meter such as for device address, device tag, limits, and units.
The Rosemount 3810 Series Liquid Ultrasonic Flow Meter is compliant with Asset Management
Solutions, AMSTM Device Manager, software applications that provides operator interface
between a HART enabled field device and a remote PC.
3.4
Device function, purpose and features 7
Other required equipment
An RS-232C/RS-485 (half duplex) serial communication port for Modbus communication is
provided on Port A, Port B and Port C.
Any programmable device on the Rosemount 3810 Series Liquid Ultrasonic Flow Meter (such
as a FPGA) is programmed via the CPU Module.
Page 21
HART Field Device Specification 3810 Series Ultrasonic Meter3. Product overview
April 2022 00825-0300-3810
8 Other required equipment
Page 22
00825-0300-3810
4
4. Product interfaces
This section discusses the Rosemount 3810 Series Liquid Ultrasonic Flow Meter for
HART communications, electrical interface, and input and output requirements.
4. Product interfacesHART Field Device Specification 3810 Series Ultrasonic Meter
April 2022
4.1
4.1.1
Process interfaces
The Rosemount 3810 Series Liquid 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 3810 Series Liquid Ultrasonic Flow Meter provides an RS-232C/RS-485 halfduplex 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 3810 Series Liquid 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
(Selectable)
Ethernet Port One Ethernet Port (TCP/IP)
Frequency/Digital Output(s) Maximum frequency for the frequency outputs
Serial Port One serial RS-232/RS-485 port
Process interfaces 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
• 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)
(115 kbps baud rate) (Modbus RTU/ASCII)
Page 23
HART Field Device Specification 3810 Series Ultrasonic Meter4. Product interfaces
April 2022 00825-0300-3810
Name
Tra n sd uc er s • LT- 01
Functional description
•LT-03
•LT-04
•LT-05
•LT-06
•LT-07
•LT-08
•LT-09
•LT-10
•LT-11
•LT-14
•LT-15
•LT-16
•LT-17
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, IsAO1Avail indicates the presence
of Analog Output 1 (AO1). NOTE: HART communication is available over AO1 only.
10 Sensor analog output channels
Page 24
4. Product interfacesHART Field Device Specification 3810 Series Ultrasonic Meter
Configuration via the HART slave port, requires device-specific commands.
00825-0300-3810
Table 4-1 Analog output configuration parameters
Val ues
Direction
Linear over-range Down greater than -3.125% 3.5 mA
Up less than +106.25% 21 mA
Maximum current +106.25% 21 mA
Multi-drop current draw
Lift-off voltage 7 V @ full scale
(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):
• uncorrected volumetric flow rate
The Rosemount 3810 Series Liquid 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):
Values
(e.g., in mA)
April 2022
• 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
Sensor analog output channels 11
Page 25
HART Field Device Specification 3810 Series Ultrasonic Meter4. Product interfaces
AOX
TRIM
AOXCurrentTrimGain AOXOutput 4–()¥()4 AOXCurrenTrimZero++=
April 2022 00825-0300-3810
• The HART slave output supports configurable preamble length.
• The HART slave supports the HART Rev. 7 commands listed in Section 8 through
Section 10.
• The HART slave does not support transfer functions.
Each analog output has individually configurable alarm selections. The selections includes:
• 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 Trim the analog outputs via HART, 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 pretrimmed, 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 AOXOutput Trim
The user shall be able to zero the meter (i.e., perform zero-flow calibration) via any serial,
Ethernet, or HART slave port.
12 Sensor analog output channels
Page 26
4. Product interfacesHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
4.1.3 Time Stamp
A time stamp shall be calculated for each of the HART device variables when the device variable
is updated and the status is good. The time stamps shall be associated with the corresponding
data points shown in Table 4-2
Table 4-2 Device variables time stamp
Device variable Associated time stamp data point name
Uncorrected flow rate (QFlow) HARTQFlowUpdateTime
Pressure (FlowPressure) HARTPressureUpdateTime
Temperature (FlowTemperature) HARTTemperatureUpdateTime
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
.
April 2022
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 27
HART Field Device Specification 3810 Series Ultrasonic Meter4. Product interfaces
April 2022 00825-0300-3810
14 Time Stamp
Page 28
5. Device variablesHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
51
5. Device variables
The Rosemount 3810 Series Liquid Ultrasonic Flow Meter does not use Device Family
commands.
5.1
Table 5-1 Device variable 0 - uncorrected flow rate
Device Variable
Number:
Classification:
Device variable 0 - uncorrected flow rate
The flow-condition volumetric flow rate is the result of applying expansion correction and flowprofile correction to the raw volumetric flow rate derived as subject to the low-flow cut-off. 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
5.2 Device variable 6 - pressure
The Rosemount 3810 Series 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.
Uncorrected Flow Rate
(Table 11- 5 )
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-2 Device variable 6 - pressure
Device Variable
Number:
Classification:
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.15.
Device variable 0 - uncorrected flow rate 15
6
65
Pressure
Name
Unit Codes
Pressure
(Table 11- 4 )
Page 29
HART Field Device Specification 3810 Series Ultrasonic Meter5. Device variables
April 2022 00825-0300-3810
5.3 Device variable 7 - temperature
The Rosemount 3810 Series 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.
The flow-condition temperature is configurable (via the EnableTemperatureInput data point) to
be:
• disabled (0)
• live (1) (4-20 mA input) or
• fixed (2)
Table 5-3 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 MaxInputTemperature.
To configure the live temperature, plus associated alarms, configure the data points in Section
11.15.
Name
Unit Codes
Temperature
(Table 5-3)
5.4 HART slave device variables good status
indicators
Refer to the following table for HART Slave Device Variables database points indicating the
response status is good.
Table 5-4 Device variable good indicators
Device variable
Code - content
0 - Uncorrected flow rate 66 QFlowValidity
6 - Pressure (3rd and 4th variable only) 65 HARTIsPressureGood
7- Temperature (3rd and 4th variable only) 64 HARTIsTemperatureGood
Device variable
Classification code
Device variable
Good indicators
16 Device variable 7 - temperature
Page 30
6. Dynamic variablesHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
61
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
SV
TV
QV
Fixed dynamic variables
There are no fixed Dynamic Variables for this device.
Dynamic variables with configurable mapping
The Rosemount 3810 Series Liquid Ultrasonic Flow Meter allows the following userconfigurable Dynamic Variables mapped to the Device Variables:
• 0 • 0 Uncorrected Flow Rate
• 0 • 0 Uncorrected Flow Rate
• 0, 6 or 7 • 0, 6, 7: PV + Pressure, Temperature
• 0, 6 or 7 • 0, 6, 7: PV + Pressure, Temperature
The default primary Dynamic Variable is Uncorrected Flow Rate for all meters.
Fixed dynamic variables 17
Page 31
HART Field Device Specification 3810 Series Ultrasonic Meter6. Dynamic variables
April 2022 00825-0300-3810
18 Dynamic variables with configurable mapping
Page 32
7. Status informationHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
71
7. Status information
This section documents the HART primary, secondary, tertiary, and quaternary variables
for Rosemount Liquid Ultrasonic Flow Meters.
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
(Section 10.1.13).
Device-Specific Command 141 (Section 10.1.14) is used to acknowledge status Boolean
database points that require acknowledgement.
Alerts are sorted into three groups: Failed, Maintenance, and Advisory. These groups are
TM
displayed in AMS
Device Manager and communicated via Universal Command 48 (see
Section 7.2) unless it is indicated via the device status byte.
The database point mapping for the Device Status Byte is shown in Tab le 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 is communicated via Device-Specific Command 140 (illustrated in the command
definition in Section 10.1.13).
19
Page 33
HART Field Device Specification 3810 Series Ultrasonic Meter7. Status information
April 2022 00825-0300-3810
7.1 Device status
Table 7-1 Device status byte database point mapping
Device
Status Bit
7 (msb) Device Malfunction - The
6 Configuration Changed - An
5 Cold Start - A power failure or
4More Status Available - More
3 Loop Current Fixed - The Loop
Definition Explanation Related Database Point(s)
device detected a serious error
or failure that compromises
device operation.
This will be the logical OR’ing of the
related database points.
• IsAcqModuleError
• IsCorePresent
• WatchDo gReset
• IsElecVoltOutOfRange
• IsAcqModuleIncompatible
operation was performed that
changed the device's configuration.
Device Reset has occurred.
status information is available
via Command 48, Read Additional Status Information.
Current is being held at a fixed
value and is not responding to
process variations.
Configuration Changed flag of corresponding master. If the request is
made by primary master then
primary master config changed
flag will be communicated else
secondary master config changed
flag.
For the Series 3810 platform, the
term "cold start" is used to refer to
the initial start of the board (when
all non-volatile database points are
initialized to their default values)
whereas the term "warm start" is
used to refer to a power failure.
Thus, the HART term "cold start" is
equivalent to the Mark XX term
"warm start." Note that this bit is
automatically reset by the first
command that recognizes it (refer
to HCF_SPEC 99 rev. 7.1, ver. A,
section 3.3) although the database
point is not reset.
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
• HARTDidPrimaryConfigChange
OR
• HARTDidSecondaryConfigChange
• HARTDidPowerFailPrimary
Or
• HARTDidPowerFailSecondary
• N/A
• IsAO1EnableTest
•AO1IsFixed
20 Device status
Page 34
00825-0300-3810
Table 7-1 Device status byte database point mapping
Device
Status Bit
2 Loop Current Saturated - The
1 Non-Primary Variable Out of
0 (lsb) Primary Variable Out of Limits
Definition Explanation Related Database Point(s)
loop Current has reached its
upper (or lower) endpoint limit
and cannot increase (or
decrease) any further.
This bit shall be set whenever any
Limits - A Device Variable not
map ped t o the PV is beyon d its
operating limits.
- The Primary Variable is
beyond its operating limit.
Device Variable not mapped to the
PV is out-of-limits. It shall be the
logical OR’ing of the related out-of-
limits database points. It shall use
the AO1Content database point to
determine which Device Variable is
mapped to the PV.
This bit shall be set whenever the
Device Variable mapped to the PV
is out-of-limits. It shall use the
AO1Content database point to
determine which Device Variable is
mapped to the PV. Note that some
Device Variables do not have limits
and thus do not have associated
out-of-limits database points.
7. Status informationHART Field Device Specification 3810 Series Ultrasonic Meter
April 2022
• AO1IsSaturated
• FlowPressureIsOutOfLimits
• FlowTemperatureIsOutOfLimits
• AO1Content
Device status 21
Page 35
HART Field Device Specification 3810 Series Ultrasonic Meter7. Status information
Bit Description Related Database Point(s)
7 (msb) Acquisition Mode
• IsAcqMode
6Meter cold-start
• DidColdStart
5Acquisition Mode Latched
• IsAcqModeLatched
4 Number of operating chords below
specified minimum
latched
• IsTooFewOperChordsLatched
3 Number of operating chords below
specified minimum
• IsTooFewOperChords
2 Acquisition board communications error
latched
• IsAcqModuleErrorLatched
1 Acquisition Module is not compatible
with firmware/configuration
• IsAcqModuleIncompatible
0 (lsb)
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
• Reserved
2
• Reserved
1Batch data received failed
• IsBatchDataRcvFailed
0 (lsb)
April 2022 00825-0300-3810
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.
Response Data Bytes
Table 7-2 Additional device status (Command 48)
Byte Format Description
0BitsFailed Status Byte 0
1 Bits Maintenance Status Byte 0
22 Additional device status (Command 48)
Page 36
7. Status informationHART Field Device Specification 3810 Series Ultrasonic Meter
Bit Description Related Database Point(s)
7 (msb) Flow-condition pressure invalid
• PressureInvalid
6 Flow-condition temperature invalid
• Tem pe ra tu re In va li d
5
• Reser ved
4
3
2 Live digital pressure latched
• PressureInvalidLatched
1 Live digital temperature latched
• Tem pe ra tu re In va li dL atc he d
0(lsb)
• Reser ved
Bit Description Related Database Point(s)
7 (msb)
• Reser ved
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-0300-3810 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) 23
Page 37
HART Field Device Specification 3810 Series Ultrasonic Meter7. Status information
Bit Description Related Database Point(s)
7 (msb) Invalid measurement - logical OR'ing of
the related database points
• QFlowValidity (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
4 Power failure
• DidPowerFail
3Latched alarm
• IsMeterVelAboveMaxLmtLatched
2 Configuration Checksum changed
• DidCnfgChksumChg
1 Average sound velocity range error
• IsAvgSoundVelRangeErr
0 (lsb) Latched alarm
• IsAvgSoundVelRangeErrLatched
April 2022 00825-0300-3810
Table 7-2 Additional device status (Command 48)
Byte Format Description
4 Bits Advisory Status Byte 0
24 Additional device status (Command 48)
Page 38
7. Status informationHART Field Device Specification 3810 Series Ultrasonic Meter
Bit Description Related Database Point(s)
7 (msb) One or more logs full - 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
• FlowTemperatureIsOutOfLimits
2 Forward baseline not set
• IsFwdBaselineNotSet
1 Reverse baseline not set
• IsRevBaselineNotSet
0 (lsb) Electronics temperature is out of
nominal range
• IsElecTempOutOfRange
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-0300-3810 April 2022
Byte Format Description
5Bits 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
11 Bits Standardized status 2, shall be set to 0.
12 Bits Standardized status 3, shall be set to 0.
13 Bits Analog Output Fixed, Respectively LSB to MSB: AO2 (bit mapped) where each bit is the OR'ing
revision 20.0)
AO2 will be used.
of the related database points of IsAO<n>EnableTest and AO<n>IsFixed. Only the bit for AO2 is
used.
Additional device status (Command 48) 25
Page 39
HART Field Device Specification 3810 Series Ultrasonic Meter7. Status information
Bit Description Related database point(s)
7 (msb) • Reserved
6•Reserved
5•Reserved
4•Reserved
3Reverse flow detected • IsReverseFlowDetected
2
1
0 (lsb)
Bit Description Related Database Point(s)
7 (msb) • Reserved
6•Reserved
5•Reserved
4•Reserved
3 Reverse flow detected, latched
until acknowledged
• IsReverseFlowDetectedLatched
2
1
0 (lsb) Transducer firing synchronization
error
• IsXdcrFiringSyncError
April 2022 00825-0300-3810
14 Bits Advisory - Advanced Diagnostic Alarms
15 Bits Advisory - Advanced Diagnostic Alarms Latched
16-24 Bits, Unsigned-24
or Enum
Not used at this time and thus not sent.
26 Additional device status (Command 48)
Page 40
00825-0300-3810
8
8. Universal commands
This section documents the HART Slave universal commands.
8. Universal commandsHART Field Device Specification 3810 Series Ultrasonic Meter
April 2022
8.1
HART universal commands
The HART Slave implements the HART universal commands available with the Rosemount
3810 Series Liquid Ultrasonic Flow Meter are shown below.
Table 8-1 HART 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 Of
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
9Read Device Variables with Status
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.
Range Reads the Loop Current and its associated Percent of Range.
Read Dynamic Variables and Loop
Current
Read Dynamic Variable Classifications Reads the classification associated with the Dynamic variables.
Read Unique Identifier Associated
With Tag
Read Primary Variable Transducer
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.
HART universal commands 27
Page 41
HART Field Device Specification 3810 Series Ultrasonic Meter8. Universal commands
April 2022 00825-0300-3810
Table 8-1 HART universal commands for slave implementation
18 Write Tag, Descriptor, Date Write the Tag, Descriptor, and Date Code into the meter.
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 Associated
21
with Long Tag
22 Write Long Tag Writes the long tag into meter.
38 Reset Configuration Changed Flag If the received configuration changed counter matches with device con-
48 Read Additional Device Status Returns meter status information not included in the Response Code or
If the specified long tag matches that of the meter, it responds with the
command 0 response.
figuration changed counter, then resets the configuration changed flag
(Device Status Byte bit 6) of the requesting master
(i.e. Primary/Secondary).
Device Status Byte.
28 HART universal commands
Page 42
9. Common-practice commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
9
April 2022
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 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
Assignments
51 Write Dynamic Variable
Assignments
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
95 Read Device Communication
Statistics
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.
Responds with counts of STX messages received, ACK messages sent and
BACK messages sent.
Supported commands 29
Page 43
HART Field Device Specification 3810 Series Ultrasonic Meter9. Common-practice commands
April 2022 00825-0300-3810
9.2 Burst Mode
This device does not support burst mode.
9.3 Catch Device Variable
This device does not support catch device variable.
30 Burst Mode
Page 44
00825-0300-3810
101
10. Device-specific commands
This section documents the Device-Specific Commands implemented for the Rosemount 3810
Series Liquid Ultrasonic Flow Meter.
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
April 2022
10.1
Public, device-specific commands
The Series 3810 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 31
Page 45
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
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-
ured.
This is an informational index variable; when
written, it is not updated in the device.
1 Unsigned-8 Device Variable assigned to the specified
2 Enum-8 Upper and Lower Range Values Units
3-6 Float Upper Range Value
7-10 Float Lower Range Value
11 Enum-8 Flow direction to be represented by
12 Enum-8
analog output
Code
specified analog output
Alarm Selection Code (Section 11) • Writes AOXActionUponInvalidContent.
• 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.
• Writes AOXFullScaleVolFlowRate
• Reserved
• Writes AOXDir,
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 Error Undefined
5 Error Too Few Data Bytes Received
6 Error Device-Specific Command Error
7Error In Write Protect Mode
32 Command 128 Write analog output configuration
• Units code, flow direction or alarm code
selection invalid.
• Lower range value > Upper range value
Page 46
00825-0300-3810
Code Class Description Explanation
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
• 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.
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
April 2022
Command 128 Write analog output configuration 33
Page 47
HART Field Device Specification 3810 Series Ultrasonic Meter10. Device-specific commands
April 2022 00825-0300-3810
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 (0 for Analog Output 1, 1
for Analog Output 2)
Response data bytes
Byte Format Description Explanation
0 Unsigned-8 Analog output selector
1 Unsigned-8 Device Variable assigned to the specified analog
output
2 Enum-8 Upper and Lower Range Values Units Code
3-6 Float Upper Range Value
7-10 Float Lower Range Value
11 Enum-8 Flow direction to be represented by specified
analog output
12 Enum-8 Alarm Selection Code
13 Enum-8 Analog output availability
Used to select which analog output to be
configured
• Specifies which analog output is being
read.
• Reads AOXContent.
• Specifies the units for the Upper and
Lower Range Values.
• Reads AOXFullScaleVolFlowRate, AOXMax-
Vel, AOXFullScaleMassRate, AOXFullScaleE nergyRate.
• Reads AOXMinVel.
• Reads AOXDir.
• Reads AOXActionUponInvalidContent.
• Reads IsAOXAvail.
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 Analog Channel Code Number The analog channel does not exist in this field
device.
16-31 Undefined
32 Error Busy
33-127 Undefined
34 Command 129 Read analog output configuration
Page 48
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
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
1 Unsigned-8 Frequency Output Content selector
2 Enum-8 Upper and Lower Range Values Units
Code
to be configured.
This is an informational index variable; when
written, it is not updated in the device.
• Writes FreqXContent. 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 frequency output content.
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.
If Frequency Output Content selection is Profile
Factor, HART unit None (251) shall be used.
This is an informational variable; when written, it is
not updated in the device.
3-6 Float Upper Range Value Writes:
• FreqXFullScaleVolFlowRate
• FreqXFullScaleProfileFactor
Always zero. Write shall be rejected if the Lower
Range Value is non-zero.
This value corresponds to zero frequency.
7-10 Float Lower Range Value Always zero.
Write shall be rejected if the Lower Range Value is
non-zero.
This value corresponds to zero frequency.
11-12 Enum-16 Maximum Frequency (Hertz) Writes:
• FreqXM axFrequenc y.
13 Enum-8 Flow direction to be represented by
Frequency Output Pair
14 Enum-8 Frequency B Phase zero-on-error con-
figuration
Writes Freq XDir.
Writes IsFreqXBZeroedOnErr.
Command 130 Write Frequency/Digital Output configuration 35
Page 49
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
15 Enum-8 Frequency B Phase relative to
Frequency A Phase configuration
16 Unsigned-8 Frequency feedback correction per-
centage
17 Enum-8 Selected Digital Output A inverted
polarity configuration
18 Enum-8 Selected Digital Output A content
selector
19 Enum-8 Selected Digital Output B inverted
polarity configuration selector
20 Enum-8 Selected Digital Output B content
selector
Writes FreqXBPhase.
Writes FreqXFeedbackCorrectionPcnt.
Writes DOXAIsInvPolarity
Writes DOXAContent
Writes DOXBIsInvPolarity.
Writes DOXBContent.
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 > Upper Range Value
• Lower Range Value was above the Upper Trans-
ducer Limit or some other physical device limitation is exceeded.
• Lower Range Value was below the Lower Trans-
ducer Limit or some other physical device limitation 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.
36 Command 130 Write Frequency/Digital Output configuration
Page 50
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
April 2022
10.1.4 Command 131 Read frequency and digital output configuration
This command is used to read the meter's specified frequency output pair and its associated
digital output pair configuration. The meter provides two frequency output pairs: Frequency
Output Pair 1 (Freq1A and Freq1B) and Frequency Output Pair 2 (Freq2A and Freq2B).
Associated with each Frequency Output Pair is a Digital Output Pair: Digital Output Pair 1 (DO1A
and DO1B) is associated with Frequency Output Pair 1, Digital Output Pair 2 (DO2A and DO2B)
is associated with Frequency Output Pair 2. The parameters are returned using the units code
selection for the Device Variable represented by the specified frequency output pair.
Request data bytes
Byte Format Description Explanation
0 Unsigned-8 Frequency/Digital Output Pair number Used to select which Frequency/Digital Output
pair to be configured.
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
5Error
6 Error Device-Specific Command Error
7-14 Undefined
15 Error Invalid Frequency/Digital Output Pair
16-31 Undefined
32 Error Busy
33-127 Undefined
Too Few Data Bytes Received
selector
• The frequency/digital output pair does not
exist in this field device.
Command 131 Read frequency and digital output configuration 37
Page 51
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
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, a HART input, or fixed at a specified value. For
conventional 4-20 mA and HART inputs, Analog Input 2 (AI2) is used for pressure.
Request data bytes
Byte Format Description Explanation
0 Enum-8 Input Selector Code Writes EnablePressureInput
1Enum-8
2-5 Float Conventional Analog or Fixed
6-9 Float Conventional Analog or Fixed
10-13 Float Conventional Analog Upper
14-17 Float Conventional Analog Lower
18-21 Float Fixed Value
22 Enum-8 Pressure and Temperature
23 Enum-8 Absolute pressure input type
24-27 Float Atmospheric Pressure Value
Units Code (see Section 11) • Specifies the units for related values (such as alarm values,
range values, fixed (specified) value). This units code is
only pertinent for interpreting this command's data values
and for the units of the response's data values.
This is an informational variable; when written, it is not
updated in the device.
• Writes HighPressureAlarm. This value is only applicable if
Upper Alarm Value
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
Lower Alarm Value
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
Range Value
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
Range Value
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
Alarm Selection Code (
Section 11
)
see
to both pressure and temperature inputs. Writes Flow-
POrTSrcUponAlarm 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).
indicator
Writes InputPressureUnit.
• Required when the input pressure is gage. Writes Atmo-
sphericPress.
00825-0300-3810
Response data bytes
Same as Request data bytes.
38 Command 132 Write flow pressure configuration
Page 52
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors
1Undefined
2 Error Invalid Selection
3 Passed Parameter Too High
4 Passed Parameter Too Low
5 Error Too Few Data Bytes Received
6 Error Device-Specific Command Error
7Error 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 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 39
Page 53
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.6 Command 133 Read flow pressure configuration
This command is used to read the meter's flow-condition pressure input configuration. The
parameters are returned using the Pressure Device Variable configured units code.
Request data bytes
Byte Format Description Explanation
None
Response data bytes
Same as Command 132 Write Flow Pressure Configuration.
Command-specific response codes
Code Class Description 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
00825-0300-3810
40 Command 133 Read flow pressure configuration
Page 54
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 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 Writes EnableTemperatureInput
1 Enum-8
2-5 Float Conventional Analog or Fixed Upper
6-9 Float Conventional Analog or Fixed Lower
10-13 Float Conventional Analog Upper Range
14-17 Float Conventional Analog Lower Range
18-21 Float Fixed Value
22 Enum-8 Pressure and Temperature Alarm
Units Code (see Section 11) • Specifies the units for related values (such as alert
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 HighTemperatureAlarm. This value is only
Alarm Value
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 LowTemperatureAlarm. This value is only
Alarm Value
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 MaxInputTemperature. This value is only
Val ue
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 MinInputTemperature. This value is only
Val ue
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 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
Selection Code (
see Section 11)
applicable to both pressure and temperature
inputs. Used to set 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).
Response data bytes
Same as Request data bytes.
Command 134 Write flow temperature configuration 41
Page 55
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
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
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.
This is used
• lower alarm value > upper alarm value
• lower range value > upper range value
• requested value is outside its sanity limits.
• 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 below the Lower Transducer
Limit.
1
to indicate an error when either:
00825-0300-3810
1. Also used for unsupported selector code, e.g. Live HART is not supported v1.60 and later firmware.
42 Command 134 Write flow temperature configuration
Page 56
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
10.1.8 Command 135 Read flow temperature configuration
This command is used to read the meter's flow-condition temperature input configuration. The
parameters are returned using the Temperature Device Variable configured units code.
Request data bytes
Byte Format Description Explanation
None
Response data bytes
Same as Command 134 Write Flow Pressure-Specific Configuration.
Command-specific response codes
Code Class Description 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
April 2022
Command 135 Read flow temperature configuration 43
Page 57
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
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 device variable) shall be derived from the Volume
Units Code and the Flow Rate Time Units Code: if the Volume Units Code is cubic meters and the
Flow Rate Time Units Code is hourly, then the derived Volumetric Flow Rate Units Code shall be
cubic meters per hour. The supported HART Units Codes are listed in Section 11.
Request data bytes
Byte Format Description
0 Enum-8
1 Enum-8
2 Enum-8
3 Enum-8
4 Enum-8
Response data bytes
Volume Units Code (HARTVolUnit) (Table 11-1)
Flow Rate Time Units Code (HARTRateTimeUnit) (Table 11-2)
Pressure Units Code (HARTPressureUnit) (Tab l e 11- 4)
Temperature Units Code (HARTTemperatureUnit) (Table 11-5)
Velocity Units Code (HARTVelUnit) (Table 11-6)
00825-0300-3810
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
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.
44 Command 136 Write device units
Page 58
00825-0300-3810
10.1.10 Command 137 Read device units
This command is used to read the device's units. The response message content shall be
different between the gas and liquid meters as indicated below.
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
6Error Device-Specific Command
Error
7-31 Undefined
32 Error Busy
33-127 Undefined
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
April 2022
Command 137 Read device units 45
Page 59
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
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
TM
system (AMS
Request data bytes
Byte Format Description Explanation
0 Unsigned-8 Device Variable Selector
1 Enum-8 Units Code
Device Manager).
(see Section 11)
• Specifies the device variable for which the range values
are to be set.
•
This is an informational variable; when written, it is not
updated in the device.
• 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.
00825-0300-3810
This is an informational variable; when written, it is not
updated in the device.
2-5 Float Upper Range Value
6-9 Float Lower Range Value
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
• Units code selection invalid.
• Lower Range Value is greater than Upper Range
Val ue.
• Lower Range Value was above the Upper Trans-
ducer Limit or some other physical device limitation is exceeded.
• Lower Range Value was below the Lower Trans-
ducer 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.
46 Command 138 Write device variable range
Page 60
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
Code Class Description Explanation
13-27 Undefined
28 Error Invalid Device Variable Index The requested Device Variable does not exist in this
field device or is not supported by the requested
command or operation.
29-31 Undefined
32 Error Busy
33-127 Undefined
Command 138 Write device variable range 47
Page 61
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
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
Byte Format Description Explanation
0 Success No Command-Specific Errors
1-4 Undefined
5Error 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.
00825-0300-3810
48 Command 139 Read device variable range
Page 62
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
Bit Description Explanation
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 Explanation
7 (msb)
• Reserve d
6
5
• Reserve d
4
• Reserve d
3
2
1
0 (lsb)
00825-0300-3810 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). The purpose of having a separate device-specific command is to 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
TM
Device Manager Alert Monitor.
1 Bits Maintenance Detail Status Byte 0
Command 140 Read detailed status 49
Page 63
10. Device-specific commands
Bit Description Explanation
7 (msb) Flow-condition volumetric flow rate validity
• QFlowValidity (inverted)
6
• Reserved
5
• Reserved
4
• Reserved
3
• Reserved
2
• Reserved
1
0 (lsb)
Bit Description Explanation
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 Explanation
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
Byte Format Description
2 Bits Advisory Detail Status Byte 0
3 Bits Advisory Detail Status Byte 1
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
4 Bits Advisory Detail Status Byte 2
50 Command 140 Read detailed status
Page 64
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
Bit Description Explanation
7 (msb) Flow data quality indicator
• IsMeterVelAboveMaxLmt
6
• Reserved
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-0300-3810 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 51
Page 65
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.14 Command 141 Acknowledge alarm
This command is used to acknowledge (clear/reset) an acknowledgeable alarm. The request
shall include an enumeration to specify which alarm to acknowledge where the enumeration
shall be as listed in the table below:
Enumeration Alarm
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
• IsCorePresent
• IsAvgSoundVelRangeErrLatched
• WatchDogReset
• DidCnfgChksumChg
• DidColdStart
• DidPowerFail
• IsReverseFlowDetectedLatched
• IsAcqModuleErrorLatched
• IsMeterVelAboveMaxLmtLatched
• Temp er at ur eI nv al id Lat ch ed
• PressureInvalidLatched
• IsAcqModeLatched
• IsTooFewOperChordsLatched
• IsFwdBaselineNotSet
• IsRevBaselineNotSet
00825-0300-3810
52 Command 141 Acknowledge alarm
Page 66
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
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.
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.
April 2022
Command 141 Acknowledge alarm 53
Page 67
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.15 Command 142 Write digital input configuration
This command is used to configure the meter's specified digital input configuration. The meter
provides a single digital input that can be used to gate a calibration pass (such as for
synchronizing the meter's calibration with prover switches).
Request data bytes
Byte Format Description Explanation
0 Enum-8 General purpose polarity
1 Enum-8 Calibration input polarity
2 Enum-8 Calibrating gating type
3 Enum-8 Digital Input 1 mode
• Applicable when the digital input is used as a general purpose
input. Specifies the digital input polarity for interpreting the
input value. Used to set DI1IsInvPolarity.
• Applicable when the digital input is used for calibration.
Specifies the digital input polarity for starting/stopping calibration. Used to set IsDI1ForCalActiveLow.
• Applicable when the digital input is used for calibration.
Specifies the digital input polarity for starting/stopping calibration. Used to set IsDI1ForCalStateGated.
• Writes DI1Mode
00825-0300-3810
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 Undefined
7 Error In Write Protect Mode
8-31 Undefined
32 Error Busy
33-127 Undefined
• DI1IsInvPolarity, IsDI1ForCalActiveLow,
IsDI1ForCalStateGated or DI1Mode
selection invalid.
54 Command 142 Write digital input configuration
Page 68
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
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
April 2022
Command 143 Read digital input configuration 55
Page 69
10. Device-specific commands
Code Description
0 Zero calibration process inactive
1 Zero calibration process in progress
2 Zero calibration process completed successfully
3 Zero calibration process failed due to chord failure during process
4 Zero calibration process failed due to too-large offset
5 Zero calibration process failed due to too-large estimated maximum deviation
6 Zero calibration process failed due to high viscosity calibration method selection
change while zero calibration process in progress
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.17 Command 144 Read velocity zero calibration status
Commands 144 and 145 are used to perform velocity zero calibration on liquid ultrasonic flow
meters. Two commands are used to achieve command-query separation (see link below).
http://en.wikipedia.org/wiki/Command-Query_Separation
This simplifies the acquisition of velocity zero calibration status in a HART host edit display or
when used in a DDL method. The engineering units for velocity are pre-configured in the device
(see Section 11.6).
The command's request and response data bytes as well as the command-specific response
codes are indicated below (with the functional requirements following associated Command
145):
Request data bytes
Byte Format Description Explanation
None
00825-0300-3810
Response data bytes
Byte Format Description
0 Enum-8
1 Unsigned-8 Zero calibration duration in minutes (ZeroFlowCalReqDuration)
2 Unsigned-8 Zero calibration progress % (zero when status is 0) updated every 5 seconds
3 Enum-8
4-7 Float Instantaneous zero flow velocity (DryCalVel) (included for display/charting purposes)
8-11 Float Proposed zero calibration value (Zero flow velocity offset) (only relevant when the zero calibration
12 Enum-8 High viscosity calibration method selector (HighViscosityMethod)
Zero calibration process status. This should be included in the AMS
DDL post-read method can use status change to 2 to accept/reject proposed zero calibration
value.
(ZeroFlowCalProgress)
Zero flow velocity Units Code (
process status is 2)
see Section 11.6)
TM
Device Manager so that a
56 Command 144 Read velocity zero calibration status
Page 70
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
Command-specific response codes
Code Class Description Explanation
0 Success No Command-Specific Errors
1-5 Undefined
6 Error Busy
7-31 Undefined
32 Error
33-127 Undefined
Command 144 Read velocity zero calibration status 57
Page 71
10. Device-specific commands
Code Description
0 Abort zero calibration process
1 Start zero calibration process
2 Accept proposed zero calibration value
and exit process
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.18 Command 145 Write velocity zero calibration control
This command is used to control the velocity zero calibration process on liquid ultrasonic flow
meters.
The command's request and response data bytes as well as the command-specific response
codes are indicated below (with the functional requirements following):
Request data bytes
Byte Format Description Explanation
0 Enum-8 Zero calibration control
• Controls the meter's zero calibration
process. This sets the
ZeroFlowCalReqControl data point.
00825-0300-3810
1 Unsigned-8 Zero calibration duration (minutes)
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
8-31 Undefined
32 Error Busy
33-127 Undefined
58 Command 145 Write velocity zero calibration control
• This byte is only relevant when the
zero calibration control value is 1.
This value specifies the zero calibration process duration in minutes
within the range [2, 10]. The default
duration is 4 minutes. This shall set
the (new) ZeroFlowCalReqDuration
data point.
• The requested zero calibration control value is
invalid (outside of its limits) or the specified
duration is outside of its limits.
• The requested zero calibration control value is
inappropriate (such as - attempting to abort a
zero calibration when zero calibration is
inactive; attempting to start a zero calibration
while zero calibration is already in progress;
attempting to accept a zero calibration value
when zero calibration is inactive, in progress or
failed).
Page 72
00825-0300-3810
Velocity zero flow calibration functional requirements
These database points are read every second (DryCalVel, AvgWtdFlowVel, IsFailedForBatchA, …
IsFailedForBatchD) and success/failure criteria are used. Running values are not available during
the calibration process - only the proposed zero calibration value (ZeroFlowCalResult (i.e., the
value to be written to FwdA0 and RevA0 when HighViscosityMethod is Disabled, or written to
FwdA0HighViscosity and RevA0HighViscosity when HighViscosityMethod is Enabled) is available
upon successful completion.
The functional requirements for performing zero flow calibration via the request and response
messages listed above are as follows:
1. When the meter is not currently in the zero calibration process, it enters the zero
calibration process upon receiving HART Command 145 with the zero calibration
control value of 1. Upon entering the zero calibration process, the zero calibration
process status is set to 1 (in progress).
2. The zero calibration process duration (in minutes) is set according to the Zero
calibration duration value received with the calibration start command (if valid).
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
April 2022
3. While in the zero calibration process, once per second the meter reads the uncalibrated
and dry-calibrated flow velocities (via the AvgWtdFlowVel and DryCalVel data points) and
the meter's chord status values (via the IsFailedForBatchA…IsFailedForBatchD data points)
and meter's high viscosity calibration method selection (HighViscosityMethod).
4. While in the zero calibration process, once per five seconds the meter updates the zero
calibration progress which is a percentage of completion based upon the specified
duration. A new data point (ZeroFlowCalProgress) indicates the progress.
5. The meter exits any calibration process in progress if any chord failure is detected (via
the IsFailedForBatchA…IsFailedForBatchD data points). In this case, the meter responds to
a calibration status read request (via Command 144) with the zero calibration process
status value of 3.
6. While the meter is in the zero calibration process prior to the completion of the
specified process duration, it responds to an abort request (via Command 145 control
value of 0). In this case, the meter changes the zero calibration process status value to 0
(inactive).
7. While the meter is in the zero calibration process prior to the completion of the
specified process duration, it ignores requests to re-start the calibration (via Command
145 control value of 1) and shall respond with the Device-Specific Command Error
Response Code.
8. While the meter is in the zero calibration process prior to the completion of the
specified process duration, it responds to all calibration status read requests (via
Command 144) with the zero calibration process status value of 1 (zero calibration in
progress).
Command 145 Write velocity zero calibration control 59
Page 73
10. Device-specific commands
ZeroCalibrationValue AvgWtdFlowVel–=
AvgWtdFlowVel
EstimatedMaximumDeviation
DryCalVel
3
δ
DryCalVel
N
------------------------------
×=
δ
DryCalVel
April 2022
9. While the meter is in the zero calibration process prior to the completion of the
specified process duration, it ignores requests to accept the proposed zero calibration
value (via Command 145 control value of 2) and responds with the Device-Specific
Command Error Response Code.
10. When the zero calibration process reaches the specified process duration, then the
meter determines whether the calibration was successful or not as follows:
(a) If the absolute value of the proposed zero calibration value (calculated as
The proposed zero calibration value is calculated as follows:
where
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
shown below) is greater than 0.02 ft/sec, then the zero calibration failed. In this
case, the meter responds to the next calibration process status read request
(via Command 144) with a zero calibration process status value of 4.
is the average of the average weighted flow velocity values (ft/sec)
(b) If the dry-calibrated flow velocity Estimated Maximum Deviation (calculated as
shown below) is greater than 0.002 ft/sec, then the zero calibration failed. In
this case, the meter responds to the next calibration process status read
request (via Command 144) with a zero calibration process status value of 5.
The dry-calibrated flow velocity Estimated Maximum Deviation is calculated as follows:
where:
is the dry-calibrated flow velocity standard deviation during the process (ft/
sec)
N is the number of dry-calibrated flow velocity values taken during the process
(c) Otherwise, the zero calibration completed successfully and the meter responds
to the next calibration process status read request (via Command 144) with a
zero calibration process status value of 2 and the proposed zero calibration
value (in the HART-configured velocity units).
11. When a zero calibration process ends unsuccessfully (i.e., with a status value of 3, 4, or
5), the meter ignores requests to accept the proposed zero calibration value
(via Command 145 control value of 2). In this case, the meter responds with the DeviceSpecific Command Error Response Code.
12. When a zero calibration process ends unsuccessfully (i.e., with a status value of 3, 4, or
5), the meter continues to respond to zero calibration process status read requests (via
Command 144) with the same status response until the calibration is exited/aborted
(via Command 145 control value of 0) or re-started (via Command 145 control value of
1).
60 Command 145 Write velocity zero calibration control
Page 74
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
(a) In this case, the meter responds to the exit/abort command by setting the
status value to 0 (inactive).
(b) In this case, the meter responds to the start command by setting the status
value to 1 (in progress).
13. When the zero calibration process ends successfully, the meter continues to respond to
zero calibration process status read requests (via Command 144) with the successful
completion response (status value of 2) until any other following occurs:
(a) The proposed zero calibration value is accepted (via Command 145 control
value of 2) .
i. If HighViscosityMethod is set to Disabled, then the meter shall write the
proposed zero calibration value to the FwdA0 and RevA0 data points and
set the status value to 0 (inactive).
ii. If HighViscosityMethod is set to Enabled, then the meter shall write the
proposed zero calibration value to the FwdA0HighViscosity and RevA0High-
Viscosity data points. Changes to FwdA0HighViscosity and RevA0HighVis-
cosity shall be audit-logged.
(b) The proposed zero calibration value is rejected via aborting the process (via
Command 145 control value of 0) - the meter discards the proposed zero
calibration value and set the status value to 0 (in active).
(c) The proposed zero calibration value is rejected via re-starting the process (via
Command 145 control value of 1) - the meter discards the proposed zero
calibration value and re-start the process. In this case, the meter sets the status
value to 1 (in progress).
14. When the meter is not in the zero calibration process, it responds to requests to abort
(via Command 145 control value of 0) with the Device-Specific Command Error
Response Code.
15. When the meter is not in the zero calibration process, it responds to requests to accept
the proposed zero calibration value (via Command 145 control value of 2) with the
Device-Specific Command Error Response Code.
16. The meter shall exit any calibration process in progress if the HighViscosityMethod value
is changed. In this case, the meter responds to a calibration status read request (via
Command 144) with the zero calibration process status value of 6.
Possible HART master perspective
From the user a HART™ master’s perspective, the process for performing a zero calibration
might be as follows (Note: there is more than one way to implement the process):
• Issue Command 145 with zero calibration control value of 1 (start zero calibration
process) and a calibration duration. The meter will respond with response code 2 if the
calibration duration is outside of its limits. The meter will respond with response code 6
if zero calibration control value is inappropriate (such as attempting to accept a zero
calibration value after a failed calibration or attempting to start a zero calibration while
one is already in progress).
• Repeatedly issue Command 144 while the meter responds with a zero calibration
process status value of 1 (process in progress).
• If the zero calibration process completed successfully, then the zero calibration value is
returned in the previously-configured velocity units. Issue Command 145 with zero
Command 145 Write velocity zero calibration control 61
Page 75
10. Device-specific commands
April 2022
calibration control value of 2 to accept the new zero calibration value (which writes the
new value to the FwdA0 and RevA0 non-volatile data points if HighViscosityMethod is set
to Disabled or to the FwdA0HighViscosity and RevA0HighViscosity non-volatile data
points if HighViscosityMethod is set to Enabled) or 0 to abort the zero calibration process
(which rejects the zero calibration result).
• If the zero calibration process completed unsuccessfully, then issue Command 145 with
zero calibration control value of 0 (abort zero calibration process) to exit the process.
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
62 Command 145 Write velocity zero calibration control
Page 76
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
April 2022
10.1.19 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
Command 146 Read Miscellaneous Non-Write Protected Parameters 63
Page 77
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
10.1.20 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
1 Unsigned-8 Number of Slave response preamble bytes
2 Unsigned-8 Number of Master command preamble bytes
3 Unsigned-8 Non-normal operation timeout
4 Unsigned-8 Hour of day to log daily record in military time
5 Enum-8 Modbus access units system
6 Enum-8 Flow rate time unit for Modbus communications
7 Enum-8 U.S. Customary volume unit for Modbus com-
munications
8 Enum-8 Metric volume unit for Modbus communica-
tions
• Reads HARTPollingAddress (the least-sig-
nificant 4 bits of the short frame address)
• Reads HARTNumPreambleBytesFromSlave
• Reads HARTMinNumPreambles
• Reads NonNormalModeTimeout used for
frequency testing in units of minute
• Reads ContractHour
• Reads UnitsSystem
• Reads VolFlowRateTimeUnit
• Reads Vol UnitUS
• Reads Vol UnitMe tric
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
64 Command 147 Read miscellaneous write protected parameters
Page 78
00825-0300-3810
10.1.21 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. Turbulence, Cross- Flow,
Symmetry, and Profile unit 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. Unit
code tables used by the meter are specified in Section 11.
*Note: Chords C and D are not available for 3812 Liquid Ultrasonic Flow 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 • Reads RunningAvgFlowTemperature.
Average Flow Pressure • Reads RunningAvgFlowPressure.
Average Turbulence A • Reads RunningAvgTurbulenceA.
• Constant units of percentage.
Average Turbulence B • Reads RunningAvgTurbulenceB.
• Constant units of percentage.
Average Turbulence C • Reads RunningAvgTurbulenceC.
• Constant units of percentage.
Average Turbulence D • Reads RunningAvgTurbulenceD.
• Constant units of percentage.
Average Flow • Reads RunningAvgAvgFlow.
Average Cross Flow • Reads RunningAvgCrossFlow.
Average Profile Factor • Reads RunningAvgProfileFactor.
Average Swirl Angle • Reads RunningAvgSwirlAngle.
• Constant units of degrees.
Average Symmetry • Reads RunningAvgSymmetry.
Average Standard Deviation of Cross Flow • Reads RunningAvgSDevCrossFlow.
Average Standard Deviation of Profile Factor • Reads RunningAvgSDevProfileFactor.
Average Standard Deviation of Symmetry • Reads RunningAvgSDevSymmetry.
Running average validity • Reads IsRunningAvgValid.
Flow Direction • Reads FlowDirection.
Units Code for Temperature values • Units for Average Flow Temperature. Can
only be valid units for temperature (HART-
TemperatureUnit).
Units Code for Pressure values • Units for Average Flow Pressure. Can only
be valid units for pressure (HARTPressure-
Unit).
Units Code for flow velocity • Units code for Average Flow. Can only be
valid units for flow velocity (HARTVel-
Unit).
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
April (&((
(see Section 11.5)
(see Section 11.4)
(see Section 11.6).
Command 153 Read running averages 65
Page 79
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
Command-specific response codes
Code Class Description
0 Success No Command-Specific Errors
1-5 Undefined
6 Error Device-Specific Command Error
7-31 Undefined
32 Error Busy
33-127 Undefined
00825-0300-3810
66 Command 153 Read running averages
Page 80
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
April 2022
10.1.22 Command 154 Read Baselines
This command will read the forward or reverse baseline values depending upon the parameter
passed in the command request.
Request Data Bytes
Byte Format Description Explanation
0 Enum-8 Forward/Reverse selection 0 = Reverse, 1 = Forward
Response Data Bytes
Byte Format Description Explanation
0 Enum-8 Forward/Reverse selection 0 = Reverse, 1 = Forward
1-4 Float Profile Factor Reads XBaselineProfileFactor.
5-8 Float Flow Pressure Reads XbaselineFlowPressure.
9-12 Float Turbulence A Reads XBaselineTurbulenceA.
13-16 Float Turbulence B Reads XBaselineTurbulenceB.
17-20 Float Turbulence C Reads XBaselineTurbulenceC.
21-24 Float Turbulence D Reads XBaselineTurbulenceD.
25-28 Float Average Flow Reads XBaselineAvgFlow.
29-32 Float Cross Flow Reads XBaselineCrossFlow.
33-36 Float Swirl Angle Reads XBaselineSwirlAngle. Constant units of
37-40 Float Symmetry Reads XBaselineSymmetry.
41-44 Float Temperature Read XBaselineFlowTemperature.
45 Unsigned-8 Baseline Not Set Boolean Reads IsXBaselineNotSet.
46 Enum-8 Units Code for Flow Temperature Units for Flow Temperature. This can only be a
47 Enum-8 Units Code for Flow Pressure Units for Flow Pressure. This can only be a units
48 Enum-8 Units Code for Flow Velocity Units for Average Flow. This can only be a units
Constant units of percentage.
Constant units of percentage.
Constant units of percentage.
Constant units of percentage.
degrees.
units code allowed for temperature values (HART-
TemperatureUnit).
code allowed for pressure values (HARTPressure-
Unit).
code allowed for flow velocity values (HARTVel-
Unit).
Command 154 Read Baselines 67
Page 81
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
Command-Specific Response Codes
Code Class Description Explanation
0 Success No Command-Specific Errors
1Undefined
2 Error Invalid Selection Invalid value for Forward / Reverse 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
68 Command 154 Read Baselines
Page 82
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
10.1.23 Command 155 Write Baselines
Writes forward or reverse baseline values depending upon first byte in the command request.
The IsXBaselineNotSet Boolean will be cleared if the baseline set was successful.
If IsAnyBaselineAvail is FALSE, then this command will respond with success and existing baseline
parameters in the meter, without writing new baseline parameters in the meter.
Request Data Bytes
Byte Format Description Explanation
0 Enum-8 Forward / Reverse Selection 0 = Reverse, 1 = Forward
1-4 Float Profile Factor
5-8 Float Flow Pressure
9-12 Float Turbulence A
13-16 Float Turbulence B
17-20 Float Turbulence C
21-24 Float Turbulence D
25-28 Float Average Flow
29-32 Float Swirl Angle
33-36 Float Cross Flow
37-40 Float Symmetry
41-44 Float Flow Temperature
45 Enum-8 Units Code for Flow Temperature Units for Flow Temperature. This can only be a
This is an INFO INDEX variable; when written, it is
not updated in the device.
Note: Contrary to device-specific commands
guideline 'Indices format should be Unsigned<#bits>', format Enum-8 is used for backward
compatibility.
• Writes XBaselineProfileFactor.
• Writes XBaselineFlowPressure.
• Writes XBaselineTurbulenceA.
• Constant units of percentage.
• Writes XBaselineTurbulenceB.
• Constant units of percentage.
• Writes XBaselineTurbulenceC.
• Constant units of percentage.
• Writes XBaselineTurbulenceD.
• Constant units of percentage.
• Writes XBaselineAvgFlow.
• Writes XBaselineCrossFlow.
• Writes XBaselineSwirlAngle. Constant units of
degrees.
• Writes XBaselineSymmetry.
• Writes XBaselineFlowTemperature.
units code allowed for temperature values (HART-
TemperatureUnit).
This is an INFO variable; when written, it is not
updated in the device.
46 Enum-8 Units Code for Flow Pressure 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.
Command 155 Write Baselines 69
Page 83
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
Byte Format Description Explanation
47 Enum-8 Units Code for flow velocity 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 Error 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
70 Command 155 Write Baselines
Page 84
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
10.1.24 Command 159 Read meter chord data
This command will read meter flow related data (flow velocities, sound velocities and
turbulence). The units code values for velocity are specified in Section 11.6. Turbulence units are
always percentage.
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
Sound Velocity Chord D
Turb ulen ce Ch ord C
Turb ulen ce Ch ord D
*Note: Chords C and D are not available for 3812 Liquid Ultrasonic Flow
• Reads FlowVelA
• Reads FlowVelB
*•Reads FlowVelC*
*•Reads FlowVelD*
• Reads SndVelA
• Reads SndVelB
*•Reads SndVelC*
*•Reads SndVelD*
• Reads Tu r bul en ce A
• Reads Tu r bul en ce B
*•Reads Tu rb ul enc eC *
*•Reads Tu rb ul enc eD *
• Units code that applies to all velocity values in
this message (
see Table 11.6).
Command-specific response codes
Code Class Description
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 159 Read meter chord data 71
Page 85
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.25 Command 160 Read meter flow data
This command reads flow related data (symmetry, cross flow, flow direction, profile factor, and
swirl angle). The units code for velocity and volume are defined in Section 11. 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
32-35
36 Enum-8 Sets the flow direction
37 Enum-8
38 Enum-8 Units code for volume
Units code for velocity • Units code that applies to all velocity values
• Symmetry
• CrossFlow
• Profile Factor
• SwirlAngle
• AvgFlow
• AvgSndVel
• Reverse FlowVol
• Reserved
• Reserved
• Flow Direction
in this message (
• Units code for volume values
(
see Table 11-1).
00825-0300-3810
see Table 11-6).
Command-specific response codes
Code Class Description
0 Success No Command-Specific Errors
1-31 Undefined
32 Error Busy
33-127 Undefined
72 Command 160 Read meter flow data
Page 86
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
10.1.26 Command 161 Read path signal amplitude data
This command reads the path Signal Amplitude data. Voltage units codes in Section 11.
*Note: Chords C and D are not available for 3812 Liquid Ultrasonic Flow 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* upstream • SignalAmplitudeC1*
Signal Amplitude C
Signal Amplitude D
Signal Amplitude D* downstream • SignalAmplitudeD2*
*downstream • SignalAmplitudeC2*
* upstream • SignalAmplitudeD1*
• SignalAmplitudeA1
• SignalAmplitudeA2
• SignalAmplitudeB1
• SignalAmplitudeB2
• A HART Units enum indicating the units for all the
amplitude values in this message. This must be
Millivolts units (see Table 11-8).
Command-specific response codes
Code Class Description
0 Success No Command-Specific Errors
1-31 Undefined
32 Error Busy
33-127 Undefined
Command 161 Read path signal amplitude data 73
Page 87
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.27 Command 162 Read noise amplitudes
This command reads the path noise amplitudes. Units codes for voltage are specified in
Table 11-8.
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
*Note: Chords C and D are not available for 3812 Liquid Ultrasonic Flow Meters.
• NoiseAmplitudeA1
• NoiseAmplitudeA2
• NoiseAmplitudeB1
• NoiseAmplitudeB2
Noise Amplitude C
Noise Amplitude C
Noise Amplitude D * upstream • NoiseAmplitudeD1*
Noise Amplitude D
* upstream • NoiseAmplitudeC1*
*downstream • NoiseAmplitudeC2*
* downstream • NoiseAmplitudeD2*
• A HART Units enum indicating the units for all
the amplitude values in this message. This must
be Millivolts (see Table 11-8).
00825-0300-3810
Command-specific response codes
Code Class Description
0 Success No Command-Specific Errors
1-31 Undefined
32 Error Busy
33-127 Undefined
74 Command 162 Read noise amplitudes
Page 88
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
10.1.28 Command 163 Read path SNR data
This command reads the SNR (signal-to-noise ratio) values for each path. SNR values are in
decibels. Unit codes for decibels are specified in Table 11-7.
available for 3812 Liquid Ultrasonic Flow 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* upstream • SNRC1*
Signal Noise Ratio C
Signal Noise Ratio D
Signal Noise Ratio D
*downstream • SNRC2*
* upstream • SNRD1*
* downstream • SNRD2*
• SNRA1
• SNRA2
• SNRB1
• SNRB2
• HART Unit code for SNR ratio. Must be
*Note: Chords C and D are not
decibel units (
see Table 11-7).
Command-specific response codes
Code Class Description
0 Success No Command-Specific Errors
1-31 Undefined
32 Error Busy
33-127 Undefined
Command 163 Read path SNR data 75
Page 89
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.29 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 3812 Liquid Ultrasonic Flow 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
Percent Good Path C
Percent Good Path D
Percent Good Path D
* upstream • PctGoodC1*
* downstream • PctGoodC2*
* upstream • PctGoodD1*
* downstream • PctGoodD2*
*Note: Chords C and D are not
• PctGoodA1
• PctGoodA2
• PctGoodB1
• PctGoodB2
00825-0300-3810
Command-specific response codes
Code Class Description
0 Success No Command-Specific Errors
1-31 Undefined
32 Error Busy
33-127 Undefined
76 Command 164 Read path percent good
Page 90
00825-0300-3810
10.1.30 Command 165 Read path gains
This command reads all path gain values. The decibel units code is a device specific units code,
see Section 11.7. Note: If the gains in the meter are currently in some other unit than decibels
(such as hardware or software gain), the HART slave must convert the values to decibels.
*Note: Chords C and D are not available for 3812 Liquid Ultrasonic Flow 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)
8-11 Float Gain when transducer B1 (upstream) is receiving
12-15 Float Gain when transducer B2 (downstream stream) is
16-19 Float
20-23 Float
24-27 Float Gain when transducer D1 (upstream) is receiving
28-31 Float Gain when transducer D2 (downstream stream)
32 Enum-8 Units decibel codes
is receiving a signal
a signal
receiving a signal
Gain when transducer C1* (upstream) is
receiving a signal
Gain when transducer C2
is receiving a signal
a signal
is receiving a signal
*(downstream stream)
• GainA1
• GainA2
• GainB1
• GainB2
• GainC1*
• GainC2*
• GainD1*
• GainD2*
• HART Units enum for all gain points read.
Must be dB units (
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
April 2022
see Table 11-7).
Command-specific response codes
Code Class Description
0 Success No Command-Specific Errors
1-31 Undefined
32 Error Busy
33-127 Undefined
Command 165 Read path gains 77
Page 91
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.31 Command 166 Read flow analysis configuration
This command reads flow analysis configuration data. See Table 11-6 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 FlowDetectionZero Cut. This value is a
flow velocity and has the same units as the
other flow velocity values in this message (
Table 11.6
16 Enum-8 Reads the Units code enum for flow velocity
see Table 11-6)
(
17 Enum-8 Reads the Units code for volume values
see Table 11-1)
(
18 Enum-8 Enables reverse flow detection. Reads the
19 Enum-8 If this database point is FALSE, the baselines are
database point Reverse Flow Detection Enabled
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.
).
• FlowAnalysisLowFlowLmt
• FlowAnalysisHighFlowLmt
• ReverseFlowVolLmt
• ReverseFlowDetectionZeroCut
see
• Units code for all flow velocity values in this
message
• Units code for ReverseFlowVolLmt.
• IsReverseFlowDetectionEnabled
• IsAnyBaselineAvail
00825-0300-3810
Command-specific response codes
Code Class Description
0 Success No Command-Specific Errors
1-5 Undefined
6 Error Device-Specific Command Error
7-31 Undefined
32 Error Busy
33-127 Undefined
78 Command 166 Read flow analysis configuration
Page 92
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
10.1.32 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-6 for 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
12-15 Float Writes the database point Reverse Flow
16 Enum-8 Units code for flow velocity values
17 Enum-8 Units code for volume values
Volume Limit
Detection Zero Cut
see Table 11-6)
(
• FlowAnalysisLowFlowLmt
• FlowAnalysisHighFlowLmt
• Reverse FlowVolLmt
• ReverseFlowDetectionZeroCut
• Units code for flow velocity values. This unit
applies to all flow values including Reverse Flow
Limit. This must be a units code that is valid for
velocit y.
• Units code for Reverse Flow Limit. This must be
a valid units code for volume (
see Table 11-1).
This is an informational variable; when written, it is
not updated in the device.
18 Enum-8 Enable for reverse flow detection.
Writes the point Reverse Flow Detection
Enabled
• 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
6Undefined
7 Error In Write Protect Mode
8-31 Undefined
12 Error Invalid Units Code
13-31 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
Command 167 Write flow analysis configuration 79
Page 93
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
Code Class Description Explanation
32 Error Busy
33-127 Undefined
00825-0300-3810
80 Command 167 Write flow analysis configuration
Page 94
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810
10.1.33 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
20 Enum-8
21 Unsigned-8
22 Unsigned-8
• DeviceNumber
• FirmwareVersion
• MeterSerialNumber
• Chordal configuration
• Optional I/O Module type in slot 1.
• Optional I/O Module type in slot 2.
Reads the database point Device Number
Reads a PACKED ASCII string which is just the
major version number and the minor version
number followed by spaces padded out to 8
characters. This string will not be stored in
nvram but shall be created from CPUBdSwIntVer
by the HART Slave. The string will be in the format%d.%d (major.minor), numbers only
Reads the database point MeterSerialNumber
converted to a PACKED ASCII 16 character
string. If serial number is shorter than 16 characters, the number will be padded with spaces, if it
is longer than 16 characters, the number will be
truncated to 16 characters.
Reads ChordalConfig
Reads OptIOModuleType
Reads OptIOModuleType
April 2022
Command-specific response codes
Code Class Description
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 81
Page 95
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.34 Command 169 Read flow totals
This command reads the flow totals. The flow totals will be sent as 4 byte integers rolling over at
999,999,999 so that same mechanism used in Modbus for flow totals can be used. See
Section 11 for unit code values. Values that do not exist or are not supported set values to 0.
Request data bytes
Byte Format Description Explanation
None
Response data bytes
Byte Format Description Explanation
0-3 Unsigned-32Reads the database point PosVolFlow with a
maximum limit of 999,999,999
4-7 Unsigned-32Reads the database point NegVolFlow with a
8-11 Unsigned-32Reads the database point PosVolBase with a
12-15 Unsigned-32Reads the database point NegVolBase with a
16-19
20 - 23
24-27
28-31
32 Enum-8
33 Enum-8
34 Enum-8
maximum limit of 999,999,999.
maximum limit of 999,999,999.
maximum limit of 999,999,999
Units code for volume
• PosVolFlow
• NegVolFlow
• PosVolBase
• NegVolBase
• Reserved
• Reserved
• Reserved
• Reserved
• Units code for all volume related values in this
message. This must be a valid units code for
volume values (
• Reserved
• Reserved
00825-0300-3810
see Table 11-1).
Command-specific response codes
Code Class Description
0 Success No Command-Specific Errors
1-5 Undefined
6 Error Device-Specific Command Error
7-31 Undefined
32 Error Busy
33-127 Undefined
82 Command 169 Read flow totals
Page 96
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
10.1.35 Command 172 Write Ethernet configuration
This command writes configuration parameters for the Ethernet port(s).
Request data bytes
Byte Format Description Explanation
0 Unsigned-8 Ethernet port selector Select which Ethernet Port Number to configure.
1-15 Latin-1 Ethernet port IP address
16-30 Latin-1 Ethernet port subnet mask
31-45 Latin-1 Ethernet default gateway address
46-49 Unsigned-32 Alternate TCP port used for Modbus TCP
50 Unsigned-8 Ethernet port Modbus ID
This is an informational variable; when written, it
is not updated in the device.
• Writes Eth<PortNumber>IPAddr.
This must be in the format X.X.X.X where
each X is 0 to 255. Meter must validate that
this is a valid IP address. If it is shorter than 15
characters, it will be padded with zeros
(0x00).
• Writes Eth<PortNumber>SubnetMask. This
must be in the format X.X.X.X where each X is
0 to 255. Meter must validate that this is a
valid subnet mask. If it is shorter than 15 characters, it will be padded with zeros (0x00).
• Writes Eth<PortNumber>DfltGate-
wayAddr
where each X is 0 to 255. Meter must validate
that this is a valid IP address. If it is shorter
than 15 characters, it will be padded with
zeros (0x00).
. This must be in the format X.X.X.X
• Writes Eth<PortNumber>AltModbusPort.
• Writes Eth<PortNumber>ModbusID.
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 large
4 Error Passed parameter too small
5 Error Too few bytes received
6 Error Device-Specific command error
7-28 Error Undefined
• Indicates the Ethernet port selector
was invalid.
• The value written for Ethernet Port
Number Alternate Modbus Port is above a
maximum limit.
• The value written for Ethernet Port
Number Alternate Modbus Port is below a
minimum limit.
Command 172 Write Ethernet configuration 83
Page 97
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
Code Class Description Explanation
29 Error Invalid IP format
30-31 Undefined
32 Error Busy
33-127 Undefined
• Either Ethernet port IP address, Ethernet port
subnet mask or Ethernet default gateway
address format is invalid or value written for
Ethernet Port Number Alternate Modbus Port
is reserved.
00825-0300-3810
84 Command 172 Write Ethernet configuration
Page 98
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
10.1.36 Command 173 Read Ethernet Configuration
This command reads the configuration parameters for the Ethernet port(s).
Request data bytes
Byte Format Description Explanation
0 Unsigned-8 Ethernet port selector Selects which Ethernet port to read.
Response data bytes
Same as Command 172 Write Ethernet configuration.
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 bytes received
6 Error Device-Specific command error
7-31 Undefined
32 Error Busy
33-127 Undefined
• The Ethernet port selector requested does
not exist in this field device.
Command 173 Read Ethernet Configuration 85
Page 99
10. Device-specific commands
April 2022
HART Field Device Specification 3810 Series Ultrasonic Meter
10.1.37 Command 174 Write serial port configuration
This command writes configuration parameters for the Serial ports.
Request data bytes
Byte Format Description Explanation
0 Unsigned-8 Serial port selector Selects which serial port to read.
1 Enum-8 Communication port availability
2 Enum-8 Communication port baud rate
3 Unsigned-8 Communication port Modbus ID
4 Enum-8 Hardware protocol on Communication port
5 Unsigned-8 Communication port response delay
6 Unsigned-8 Communication port timeout value
7-8 Unsigned-16 Communication port handshaking RTS off
9-10 Unsigned-16 Communication port handshaking RTS on
11 Unsigned-8
12 Enum-8
13-14 Unsigned-16
delay time.
delay time
Inactivity timeout for PPP connections
Enable communication port hardware flow
control
Maximum Datagram Size
This is an INFO INDEX variable; when written, it is
not updated in the device.
• IsPort<PortNumber>Avail.
• This is an INFO variable; when written, it is not
updated in the device.
• Writes BaudPort<PortNumber>. Constant
units of bits per second.
• Writes ModbusIDPort<PortNumber>.
• Writes DriverSelectionPort<PortNumber> for
port A, Port B, and Port C.
• Writes CommRspDlyPor t<PortNumber>.
Constant units of millisecond.
• Writes CommTimeoutPort<PortNumber>.
Constant units of second.
• Writes RTSOffDelayPort<PortNumber> for Por t
A only. For all other ports this must be written
0. Constant units of millisecond.
• Writes RTSOnDelayPort<PortNumber> for Port
A. For all other ports this must be written 0.
Constant units of millisecond.
• Writes CommTCPTimeoutPort<PortNumber>.
Constant units of second.
• Writes IsHWFlowControlEnabledPort<Port-
Number> for Port A only. For all other ports
this must be written 0.
• Writes CommTCPMaxDatagramSizePort<Port-
Number.
00825-0300-3810
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
86 Command 174 Write serial port configuration
The serial port requested does not exist in this
field device. Also indicates BaudPort<PortNumber>
or IsHWFlowControlEnabledPort<PortNumber> is
invalid.
Page 100
10. Device-specific commandsHART Field Device Specification 3810 Series Ultrasonic Meter
00825-0300-3810 April 2022
Code Class Description Explanation
3 Error Passed Parameter too Large Indicates ModbusIDPort X, DriverSelectionPort X,
CommRspDlyPort<PortNumber>, RTSOffDelayPort
X,
RTSOnDelayPort X,
CommTCPTimeoutPort X or
CommTCPMaxDatagramSizePort X is above a
maximum limit.
4 Error Passed Parameter too Small Indicates ModbusIDPort X,
DriverSelectionPort X,
CommRspDlyPort X, RTSOffDelayPort X,
RTSOnDelayPort X, CommTCPTimeoutPort X or
CommTCPMaxDatagramSizePort X is below a
minimum limit.
5 Error Too Few Bytes Received
6 Error Device-Specific Command Error
7-31 Undefined
32 Error Busy
33-127 Undefined
Command 174 Write serial port configuration 87
Loading...