Badger m2000 Hart Manual
Badger m2000 Hart Manual
CONTENTS
About This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Installing the Daughterboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Additional Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Fixed Current Mode (Multi-Drop) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Command Action Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Empty Pipe Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Analog Output Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Data Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Device Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Compliance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Scope
This document discusses the supported features of HART and how these features are related to the M2000. This document
also discusses special considerations and the type of data that is accessible over HART. This document is intended for readers
who have a general understanding of the HART protocol. For further information regarding the HART protocol please refer to
www.hartcomm.org.
The M2000 HART daughterboard supports Universal Command Revision 7.
INTRODUCTION
HART protocol provides the means for sending and receiving digital information across analog wires. HART is a bi-directional
communication protocol that provides data access between intelligent field instruments (like the M2000) and host systems
(like the Emerson Field Communicator). HART technology is a master/slave protocol, which means that a field device only
speaks when spoken to by a master. The M2000 operates as a slave device. In order to connect with the M2000 using the HART
protocol, the HART daughterboard is required. As an accessory module to the M-Series M2000, the HART daughterboard
allows access to many of the M2000 measurements and configuration data using the analog wires. In addition, the HART
daughterboard allows for real-time control and monitoring of the M2000.
The Device Description (DD) files for the M2000 are located on www.hartcomm.org under Product Catalog > All Products >
M2000. These files describe the supported features and functions of the M2000 with respect to HART. The DD includes details
of menus and graphic display features to be used by host applications in order to access all parameters and data in the
M2000. These files describe what parameters are accessible and should be installed in host systems.
In order to provide access to the M2000 over HART, the daughterboard converts HART protocol commands to
MODBUS™ RTU commands.
HART
M2000 INTELLIGENT
Daughter
DSP HOST
Board
INSTALLATION
Prerequisites
Installing a HART daughterboard into an M2000 has two requirements:
• Firmware v1.10 or later.
• M2000 PCB serial number must indicate that the board was manufactured week 19 of Year 2011 or later.
The PCB serial number is listed in the menus at Main Menu > Info/Help > Serial Number.
The PCB serial number is of the following format: WWYYSSSS, where WW = Week, YY = Year.
A label on the main board also indicates the week and year.
Device Variables
There are thirteen device variables as defined in the table below. Device variables can be accessed with universal
command #9:
No. Name Classification Units
0 Flow Rate 66 USER UNITS
1 Flow Velocity 67 m/s
2 T1/T+ 68 USER UNITS
3 T2/T- 68 USER UNITS
4 T3/Tn 68 USER UNITS
5 Relative Flow Rate 81 %
6 Flow Rate 66 m3/s
7 T1/T+ 68 m3
8 T2/T- 68 m3
9 T3/Tn 68 m3
10 PS 68 m3
11 PS 68 USER UNITS
12 Power Loss Totalizer 70 Seconds
Dynamic Variables
Four dynamic variables are supported. Dynamic variables can be accessed with universal command #3. The assignment to
dynamic variables is fixed and is defined in the table below.
No. Name Classification Units
PV – Primary Variable Flow Rate 66 USER UNITS
SV – Secondary T1/T+ 68 USER UNITS
Variable
TV – Tertiary Variable T2/T- 68 USER UNITS
FV – Fourth Variable T3/Tn 68 USER UNITS
Device Status
HART defined device status information is available. Only those bits supported by the M2000 are listed in the table below. All
other bits will be set to 0.
Bit Description Comments
0 PV Out of Range Set if the primary variable is exceeding the sensor limits
1 Non PV Out of Range Not Used
2 PV Output Saturated Set if the primary variables analog loop current exceeds the limits of 4 mA and 20 mA.
3 PV Output Fixed Set if the daughterboard is configured for multi-drop mode and the polling address is
non-zero. When set current is fixed at 4 mA.
4 More Status Available Set when alarm or failure is detected. Refer to command #48 for further information.
5 Device Reset Set at power-up or on reset of the meter
6 Configuration Changed Indicates when M2000 configuration has been changed. This bit can be cleared by
Universal command #38.
7 Field Device Malfunction Set when there is failure of the M2000 that prevents flow measurement.
ADDITIONAL FEATURES
Security
The M2000 Security feature, when enabled, also applies to remote access (that is, HART). Refer to the M2000 IOM for
information on how to configure security.
Remote reads are always allowed regardless of security rights. Remote writes using the HART protocol are not allowed unless
the user has remotely logged into the meter with the appropriate access level. The remote login pins are the same as the login
pins that are used on the M2000 display.
Remote writes are not allowed if a user is actively navigating the menus at the display. Remote login expires five minutes after
the last remote write. To remotely logout more quickly, do one of the following:
• Write an invalid pin to the Remote Login parameter.
IIMPORTAN
As a result of the M2000 having an active analog output, only five M2000s can be configured for multi-drop mode within the
same network.
2. Wire the meters in parallel as shown in Figure 5:
41 42 43 44 Polling Address = 1
41 42 43 44 Polling Address = 2
41 42 43 44 Polling Address = 3
Amp Meter
12 mA
250 Ω
Load
IIMPORTAN
The analog output alarm mode has no effect while the meter is configured for multi-drop mode.
• Executing the empty pipe calibration application will leave Empty Pipe enabled regardless of the state prior to
execution.
41 42 43 44 Polling Address = 0
Reference Meter
Fluke Amp Meter
250 Ω
Load
Handheld Field
Communicator
DATA MANAGEMENT
Below is a table identifying all M2000 specific data that is accessible over HART. This table lists the HART Protocol commands
used to access the data. This table also lists the security privileges and data types of the data. Typically the DD files handle all
data access. Refer to the DD files for further information.
Product Identification
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
1 FIRMWARE Product Code UINT16 DS 130 (Read)
2 FIRMWARE Product Name UCHAR16[8] DS 131 (Read)
3 FIRMWARE Firmware Name UCHAR16[16] DS 132 (Read)
4 FACTORY Application Version UCHAR16[10] DS 133 (Read)
5 FIRMWARE Compile Date [MM:DD:YYYY] UCHAR16[16] DS 134 (Read)
6 FIRMWARE Compile Time [HH:MM:SS] UCHAR16[16] DS 134 (Read)
7 FACTORY PCB Serial Number UCHAR16[5] DS 141 (Read)
8 FIRMWARE OTP Boot Checksum UCHAR16[3] DS 135 (Read)
9 FIRMWARE Flash OS Checksum UCHAR16[3] DS 136 (Read)
10 FIRMWARE Boot Version UCHAR16[5] DS 137 (Read)
11 FIRMWARE Os Version UCHAR16[4] DS 138 (Read)
12 NONE Daughterboard Product Type UINT16 DS 139 (Read)
13 NONE Daughterboard Major Version UINT16 DS 140 (Read)
14 NONE Daughterboard Minor Version UINT16 DS 140 (Read)
15 NONE Meter Tag Name UCHAR16[17] UN 20/22 (Read/Write)
Meter Calibration
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
16 ADMIN Detector Diameter UINT16 DS 150 (Read)
17 ADMIN Detector Diameter Other [mm] UINT16 DS 152 (Read)
18 ADMIN Detector Factor FLOAT32 DS 154 (Read)
19 ADMIN Detector Offset [m/s] FLOAT32 DS 156 (Read)
20 ADMIN Amplifier Factor FLOAT32 DS 158 (Read)
21 ADMIN Detector Current [mA] FLOAT32 DS 160 (Read)
22 SERVICE Power Line Frequency [Hz] UINT16 DS 162/163 (Read/Write)
23 ADMIN Excitation Frequency [Hz] UINT16 DS 164/165 (Read/Write)
24 SERVICE Scale Factor [%] FLOAT32 DS 166/167 (Read/Write)
Analog Output
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
35 SERVICE Analog Customer Offset 4 MA [A] FLOAT32 DS 193/194 (Read/Write)
36 SERVICE Analog Customer Offset 20 MA [A] FLOAT32 DS 195/196 (Read/Write)
37 FIRMWARE Analog Output Current [ A ] FLOAT32 UN 2/3 - (Read /Read)
38 SERVICE Alarm Mode UINT16 DS 197 (Write)
39 NONE Fixed Current Mode FLOAT32 UN 6/7 (Read/Write)
Output #1
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
40 SERVICE Output #1: Pulses Per Unit [User Units] FLOAT32 DS 200/201) Read/Write)
41 SERVICE Output #1: Pulse Width [ms] UINT16 DS 202/203 (Read/Write)
42 SERVICE Output #1: Flow Alarm Minimum [%] UINT16 DS 204/205 (Read/Write)
43 SERVICE Output #1: Flow Alarm Maximum [%] UINT16 DS 206/207 (Read/Write)
44 SERVICE Output #1: Output Mode UINT16 DS 208/209 (Read/Write)
45 SERVICE Output #1: Output Operation UINT16 DS 210/211 (Read/Write)
Output #2
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
46 SERVICE Output #2: Pulses Per Unit [User Units] FLOAT32 DS 200/201 (Read/Write)
47 SERVICE Output #2: Pulse Width [ms] UINT16 DS 202/203 (Read/Write)
48 SERVICE Output #2: Flow Alarm Minimum [%] UINT16 DS 204/205 (Read/Write)
49 SERVICE Output #2: Flow Alarm Maximum [%] UINT16 DS 206/207 (Read/Write)
50 SERVICE Output #2: Output Mode UINT16 DS 208/209 (Read/Write)
51 SERVICE Output #2: Output Operation UINT16 DS 210/211 (Read/Write)
Output #3
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
52 SERVICE Output #3:Full Scale Frequency [Hz] UINT16 DS 212/213 (Read/Write)
53 SERVICE Output #3: Flow Alarm Minimum [%] UINT16 DS 204/205 (Read/Write)
54 SERVICE Output #3: Flow Alarm Maximum [%] UINT16 DS 206/207 (Read/Write)
55 SERVICE Output #3: Output Mode UINT16 DS 208/209 (Read/Write)
56 SERVICE Output #3: Hardware Select UINT16 DS 214/215 (Read/Write)
57 SERVICE Output #3: Output Operation UINT16 DS 210/211 (Read/Write)
Output #4
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
58 SERVICE Output #4: Flow Alarm Minimum [%] UINT16 DS 204/205 (Read/Write)
59 SERVICE Output #4: Flow Alarm Maximum [%] UINT16 DS 206/207 (Read/Write)
60 SERVICE Output #4: Output Mode UINT16 DS 208/209 Read/Write)
61 SERVICE Output #4: Hardware Select UINT16 DS 214/215 Read/Write)
62 SERVICE Output #4: Output Operation UINT16 DS 210/211 Read/Write)
Port A Diagnostic Counters
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
63 FIRMWARE Port A: Packets Processed UINT16 DS 220 (Read)
64 FIRMWARE Port A: Broadcast Packets UINT16 DS 220 (Read)
65 FIRMWARE Port A: CRC Errors UINT16 DS 220 (Read)
66 FIRMWARE Port A: Packets Received UINT16 DS 220 (Read)
67 FIRMWARE Port A: Packets Sent UINT16 DS 220 (Read)
68 FIRMWARE Port A: Parity Errors UINT16 DS 220 (Read)
69 FIRMWARE Port A: Framing Errors UINT16 DS 220 (Read)
70 FIRMWARE Port A: Overrun Errors UINT16 DS 220 (Read)
71 FIRMWARE Port A: Break Detects UINT16 DS 220 (Read)
Measurements
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
81 FIRMWARE T1 / T+ [m3] FLOAT32 UN 9 (Read)
82 FIRMWARE T1 / T+ [User Units] FLOAT32 UN 3/9 (Read)
83 FIRMWARE T2 / T- [m3] FLOAT32 UN 9 (Read)
84 FIRMWARE T2 / T- [User Units] FLOAT32 UN 3/9 (Read)
85 FIRMWARE T3 / TN [m3] FLOAT32 UN 9 (Read)
86 FIRMWARE T3 / TN [User Units] FLOAT32 UN 3/9 (Read)
87 FIRMWARE T1 / T+ Rollover Counter UINT16 DS 239 (Read)
88 FIRMWARE T2 / T- Rollover Counter UINT16 DS 239 (Read)
89 FIRMWARE Flow Velocity [m/s] FLOAT32 UN 9 (Read)
90 FIRMWARE Flow Rate [m3/s] FLOAT32 UN 9 (Read)
91 FIRMWARE Flow Rate [User Units] FLOAT32 UN 1/3/9 (Read)
92 FIRMWARE Relative Flow Rate [ % ] FLOAT32 UN 2/9 (Read)
93 FIRMWARE Preset Batch Totalizer [m3] FLOAT32 UN 9 (Read)
94 FIRMWARE Preset Batch Totalizer [User Units] FLOAT32 UN 9 (Read)
95 FIRMWARE Flow Direction UINT16 DS 239 (Read)
Meter Diagnostic Counters
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
96 FIRMWARE Power Up Counter UINT16 DS 222 (Read)
97 FIRMWARE Detector Error Counter UINT16 DS 222 (Read)
98 FIRMWARE Empty Pipe Counter UINT16 DS 222 (Read)
99 FIRMWARE Full Scale Counter UINT16 DS 222 (Read)
100 FIRMWARE Totalizer Overflow Counter UINT16 DS 222 (Read)
101 FIRMWARE Pulse Sync Counter UINT16 DS 222 (Read)
102 FIRMWARE ADC Interrupt Counter UINT16 DS 222 (Read)
103 FIRMWARE ADC Range Counter UINT16 DS 222 (Read)
104 FIRMWARE WDT Resets Counter UINT16 DS 222 (Read)
105 FIRMWARE WDT Location UINT16 DS 222 (Read)
106 FIRMWARE System Error # UINT16 DS 222 (Read)
107 FIRMWARE Meter Status UINT16 UN 48 (Read)
108 FIRMWARE Action Request Overflows UINT16 DS 222 (Read)
109 FIRMWARE Measurement Overflows UINT16 DS 222 (Read)
110 FIRMWARE Remote Resets UINT16 DS 222 (Read)
Miscellaneous
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
111 FIRMWARE Power Loss Totalizer [ seconds ] UINT32 UN 9 (Read)
112 USER Display Backlight Mode UINT16 DS 225/226 (Read/Write)
113 SERVICE Preset Batch Amount [m3] FLOAT32 DS 227/228 (Read/Write)
114 USER Menu Language Setting UINT16 DS 229/230 (Read/Write)
115 NONE Port B Extended Address UINT16 UN 6/7 (Read/Write)
Empty Pipe
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
116 ADMIN Empty Pipe Calibration [Volts] FLOAT32 DS 233/234 (Read/Write)
117 FIRMWARE Empty Pipe Measure Value [Volts] FLOAT32 DS 237 (Read)
118 ADMIN Full Pipe Calibration [Volts] FLOAT32 DS 235/236 (Read/Write)
119 SERVICE Empty Pipe Mode UINT16 DS 231/232 (Read/Write)
Control Commands
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific
UN = Universal)
120 NONE Command Action Request UINT16 DS 244 (Write)
121 SERVICE Flow Simulation SINT16 DS 240/241 (Read/Write)
Security
HART Command Support
No.: Write Security Register Name Register Type (DS = Device Specific UN =
Universal)
122 FIRMWARE Security Status UINT16 DS 243 (Read)
123 FIRMWARE Random Value UINT32 DS 247 (Read)
124 NONE Remote Login UINT32 DS 242 (Write)
DEVICE DESCRIPTION
The device descriptions, located on www.hartcomm.org under Product Catalog > All Products > M2000, can be installed into
host systems such as the Emerson 475 Field Communicator.
Periodically, the device description monitors the attached device for non-zero status codes (universal command #48). These
codes inform the user of the status of the M2000. If the status of the M2000 does not clear, these informational dialogs will
continue to be presented. To reduce the amount of dialogs, correct the state of the meter or configure the host to ignore
these non-zero status codes.
In addition, performing changes to the meter’s configuration generates a “configuration changed” status dialog. This bit must
be manually cleared to prevent future display of this dialog. This can be done within the DD file by navigating to
M2000>Advanced>Miscellaneous>Service>Reset Config Change or separately issuing universal command #38.
TROUBLESHOOTING
Symptom Solution
Using DD files, not able to change
—
values with the handheld
Check the wiring.
Verify load is above minimum required resistance of 230 Ohms.
Unable to communicate with the
Verify installation requirements are met (firmware v1.10 or later, PCB serial number
meter over HART
1911xxxx or later).
Verify the loop current is within range, especially if configured for multi-drop.
Unable to find the calibration These methods only are visible when the meter is unsecured or when properly
methods for empty pipe or the logged into a secured meter. For secured meters, these methods require SERVICE level
analog output authorization.
To eliminate this condition and any concerns regarding this condition, it is advisable
to reset the M2000. This can be done by issuing the RESET command in the
The configuration error flag is set Advanced>Miscellaneous>Service menu. Shortly thereafter the M2000 resets and
the daughterboard image updates to match the M2000 image. Then re-verify all
configuration data is as desired.
Verify the meter is not configured for multi-drop mode. A meter configured for multi-
My analog current is always 4 mA drop mode will have a non-zero polling address. Set the polling address to zero.
Verify flow rate is non-zero. Flow rate is directly proportional to the analog current.
COMPLIANCE