Badger Meter Europa GmbH
ModMAG® M1000
HART® protocol
INSTALLATION AND
OPERATION MANUAL
April 2017
MID_M1000_BA_HART_02_1704
Contents Page
1. Basic safety recommendations ..................................................................................... 5
2. Dynamic variables .......................................................................................................... 5
Volumetric flow unit codes ....................................................................................... 5
Volume unit code .................................................................................................... 6
3. Device variables .............................................................................................................. 6
4. Field device status .......................................................................................................... 8
5. Universal commands ...................................................................................................... 9
Command 0 Read Transmitter Unique Identifier ...................................................... 9
Command 1 Read primary variable ........................................................................10
Command 2 Read Loop Current and Percent of Range .........................................10
Command 3 Read Dynamic Variables and Loop Current .......................................11
Command 3 Read Dynamic Variables and Loop Current .......................................12
Command 6 Write Polling Address .........................................................................13
Backward compatibility TEST .................................................................................14
Command 7 Read Loop Configuration ...................................................................15
Command 8 Read Dynamic Variable Classification ................................................15
Command 9 Read Device Variable with Status ......................................................16
Command 11 Read Unique Identifier Associated With Tag ....................................18
Command 12 Read message .................................................................................18
Command 13 Read tag descriptor, and date ..........................................................19
Command 14 Read PV sensor information ............................................................20
Command 15 Read PV output sensor information ..................................................21
Command 16 Read Assembly Number ..................................................................22
Command 17 Write Message .................................................................................22
Command 18 Write Tag, Description, Date ............................................................23
Command 19 Write Assembly number ...................................................................24
Command 20 Read Long tag .................................................................................25
Command 21 Read Unique Identifier Associated With Long Tag ...........................26
Command 22 Write Long tag ..................................................................................26
Command 38 Reset Configuration Changed Flag ..................................................27
Command 48 Read Additional Device Status .........................................................28
6. Additional features ........................................................................................................30
Command 40 Enter/Exit Fixed Current Mode .........................................................30
Command 42 Perform Device Reset ......................................................................31
Command 44 Write Primary Variable Units ............................................................32
Command 59 Write Number of Response Preambles ............................................32
7. Device specific commands ...........................................................................................34
Command 130 Read Product Code ........................................................................34
Command 131 Read Product Name .......................................................................34
Command 132 Read Firmware Name ....................................................................35
Command 133 Read Application Version ...............................................................36
MID_M1000_BA_HART_02_1704
Contents Page
Command 134 Read Compile Date ........................................................................36
Command 135 Read OTP Boot Checksum ............................................................37
Command 136 Read Flash OS Checksum .............................................................37
Command 141 Read Serial Number .......................................................................38
Command 150 Read Detector Diameter .................................................................39
Command 154 Read Detector Factor .....................................................................40
Command 156 Read Detector Offset .....................................................................41
Command 158 Read Amplifier Factor ....................................................................41
Command 160 Read Detector Current ...................................................................42
Command 162 Read Power Line Frequency ..........................................................43
Command 163 Write Power Line Frequency ..........................................................43
Command 164 Read Excitation Frequency ............................................................44
Command 165 Write Excitation Frequency ............................................................45
Command 166 Read Scale Factor .........................................................................45
Command 167 Write Scale Factor ..........................................................................46
Command 172 Read Polarization Voltage ..............................................................47
Command 173 Read Full Scale Flow .....................................................................47
Command 174 Write Full Scale Flow .....................................................................48
Command 175 Read Flow Unit ..............................................................................48
Command 176 Write Flow Unit ...............................................................................49
Command 177 Read Volume Unit ..........................................................................50
Command 178 Write Volume Unit ..........................................................................50
Command 181 Read Full Scale Velocity ................................................................51
Command 182 Write Full Scale Velocity .................................................................51
Command 183 Read Low Flow Cut Off ..................................................................52
Command 184 Write Low Flow Cut Off ..................................................................53
Command 185 Read Flow Direction .......................................................................53
Command 186 Write Flow Direction .......................................................................54
Command 189 Read Coil Settling Time..................................................................54
Command 190 Read Digital Input Operation ..........................................................55
Command 191 Write Flow Direction .......................................................................56
Command 192 Read Digital Input Status ................................................................57
Command 197 Write Alarm Mode ..........................................................................58
Command 200 Read Pulses per Unit .....................................................................58
Command 201 Write Pulses per Unit .....................................................................59
Command 202 Read Pulse Width ..........................................................................60
Command 203 Write Pulse Width...........................................................................60
Command 204 Read Flow Alarm Min .....................................................................61
Command 205 Write Flow Alarm Min .....................................................................62
Command 206 Read Flow Alarm Max ....................................................................63
Command 207 Write Flow Alarm Max ....................................................................64
Command 208 Read Digital Output Mode ..............................................................64
Command 209 Write Digital Output Mode ..............................................................65
MID_M1000_BA_HART_02_1704
Contents Page
Command 210 Read Digital Output Operation .......................................................66
Command 211 Write Digital Output Operation........................................................67
Command 212 Read Full Scale Frequency ............................................................68
Command 213 Write Full Scale Frequency ............................................................68
Command 214 Read Median ..................................................................................69
Command 215 Write Median ..................................................................................69
Command 216 Read Moving Average ....................................................................70
Command 217 Write Moving Average ....................................................................71
Command 229 Read Menu Language Code ..........................................................71
Command 231 Read Empty Pipe Mode .................................................................73
Command 232 Write Empty Pipe Mode..................................................................73
Command 233 Read Empty Pipe Threshold Resistance ........................................74
Command 234 Write Empty Pipe Threshold Resistance ........................................74
Command 238 Read Empty Pipe Actual Resistance ..............................................75
Command 240 Read Flow Simulation ....................................................................76
Command 241 Write Flow Simulation ....................................................................77
Command 242 Remote Login .................................................................................79
Command 243 Read Rights ...................................................................................79
Command 244 Command Action Request .............................................................80
Command 247 Read Random ................................................................................81
8. Rights – summary ..........................................................................................................82
9. Return of goods for repair/Harmless declaration ........................................................83
MID_M1000_BA_HART_02_1704
Basic safety recommendations / Dynamic variables Page 5/83
Imperial Gallons per Minute
Imperial Gallons per Hour
Imperial Gallons per Second
US Fluid ounces per minute
1. Basic safety recommendations
Please see “Basic safety recommendations” in installation and operation manual
ModMAG
®
M1000.
2. Dynamic variables
Primary Variable Volumetric Flow rate
Secondary Variable T1+
Tertiary Variable T1-
Quaternary Variable T1NET
Volumetric flow unit codes
MID_M1000_BA_HART_02_1704
Dynamic variables / Device variables Page 6/83
Volume unit code
3. Device variables
MID_M1000_BA_HART_02_1704
Dynamic variables / Device variables Page 7/83
Manual fixed; Not limited
Status α
Status β
MID_M1000_BA_HART_02_1704
Field device status Page 8/83
Some fault occurred, except pulse output
overload
Set whenever a configuration change is
Set, for one transaction only to each
master, when a field device is powered up
Some fault occurred. Use command #48
to retrieve further information
The device is in multidrop mode, or the
flow simulation is active (command #241)
Analog output is out of range
Primary variable out of limits
Relative flow rate <0% or relative flow rate
>100%
Non-primary variable out of limits
Not implemented, always 0
4. Field device status
made by any host, or through a local
MID_M1000_BA_HART_02_1704
Universal commands Page 9/83
Device Type Code for Expansion
Manufacturer Identification Mode
Number of Requested Preambles
Revision Level of Universal Command
Revision Level of Transmitter Document
(Most Significant 5 Bits) Hardware Revision Level
(Least Significant 3 Bits) Physical Signaling Code
Flags, none defined at this time
Device Identification Number, 24Bit, MSB
Device Identification Number, 24Bit
Device Identification Number, 24Bit, LSB
Number of Preambles to be sent
Maximum Number of Device Variables
Configuration Change Counter, MSB
Configuration Change Counter, LSB
Extended Field Device Status
Manufacturer Identification Code, MSB
Manufacturer Identification Code, LSB
Private Distributor Identification Code, MSB
Private Distributor Identification Code, LSB
No Command Specific Error
5. Universal commands
Command 0 Read Transmitter Unique Identifier
Request Data Bytes
Response data bytes
* Configurable
Response Codes
Request example:
MID_M1000_BA_HART_02_1704
Universal commands Page 10/83
Address Command Byte count Status
FE BD 03 05 07 01 0E 08 00 0A E1 39 05 0D 00 01 00 00 BD 00
BD 01
No Command Specific Error
Command Byte count Status
Primary Variable Loop Current (units of mA) , IEEE754
Primary Variable Percent of Range (units of percent) , IEEE754
No Command Specific Error
Response example:
Command 1 Read primary variable
Request Data Bytes
Response Codes
Request example:
Response example:
Command 2 Read Loop Current and Percent of Range
Request Data Bytes
Response Data Bytes
Long frame from slave
Response Codes
MID_M1000_BA_HART_02_1704
Universal commands Page 11/83
Command Byte count Status
Primary Variable Loop Current (units of mA) , IEEE754
Primary Variable Unit Code
Primary Variable, IEEE754
Secondary Variable Unit Code
Secondary Variable, IEEE754
Tertiary Variable Unit Code
Tertiary Variable, IEEE754
Quaternary Variable Unit Code
Quaternary Variable, IEEE754
No Command Specific Error
Request example:
Response example:
Long frame from
slave
Data:
14.09194 mA
63.0746 %
Command 3 Read Dynamic Variables and Loop Current
Request Data Bytes
Response Data Bytes
Response Codes
Request example:
MID_M1000_BA_HART_02_1704
Universal commands Page 12/83
41 A0 00 00 18 40 A0 E0 91 29 49 4C EF 7C 29 42
7D F6 14 29 49 4C EB 84
Primary Variable Loop Current (units of mA) , IEEE754
Primary Variable Unit Code
Volumetric Flow Unit
Codes
Primary Variable, IEEE754
Secondary Variable Unit Code
Secondary Variable, IEEE754
Tertiary Variable Unit Code
Tertiary Variable, IEEE754
Quaternary Variable Unit Code
Quaternary Variable, IEEE754
No Command Specific Error
Response example:
Long frame
from slave
Data:
20mA
5.0274128913879395 L/S
839415.75 L
63.49031066894531 L
839352.25 L
Command 3 Read Dynamic Variables and Loop Current
Request Data Bytes
Response Data Bytes
Response Codes
Request example:
MID_M1000_BA_HART_02_1704
Universal commands Page 13/83
Command Byte count Status
41 A0 00 00 18 40 A0 E0 91 29 49 4C EF 7C 29
0 = signaling disabled; 1 = signaling enabled
0 = signaling disabled; 1 = signaling enabled
No Command Specific Error
Invalid Polling Address Selection
Too Few Data Bytes Received
Response example:
Long frame
from slave
FF
39
Data:
20mA
5.0274128913879395 L/S
839415.75 L
63.49031066894531 L
839352.25 L
Command 6 Write Polling Address
Request Data Bytes
Response Data Bytes
Response Codes
42
42 7D F6 14 29 49 4C EB 84
1
Request example:
MID_M1000_BA_HART_02_1704
Long frame
from slave
Universal commands Page 14/83
Command Byte count Status
Command Byte count Status
Command Byte count Status
Response example:
Long frame
from slave
Data:
Polling address = 0
Loop Current Mode = 0 (signaling disabled)
Backward compatibility TEST
Request example:
Long frame
from slave
Response example:
Long frame
from slave
Data:
Polling address = 0
Loop Current Mode = 1 (signaling enabled)
Request example:
Long frame
from slave
Response example:
Long frame
from slave
Data:
Polling address = 63
MID_M1000_BA_HART_02_1704
Universal commands Page 15/83
No Command Specific Error
Command Byte count Status
Primary Variable Classification
Secondary Variable Classification
Tertiary Variable Classification
Quaternary Variable Classification
Command 7 Read Loop Configuration
Request Data Bytes
Response Data Bytes
Response Codes
Request example:
Response example:
Command 8 Read Dynamic Variable Classification
Request Data Bytes
Response Data Bytes
Long frame
from slave
MID_M1000_BA_HART_02_1704
Universal commands Page 16/83
No Command Specific Error
Command Byte count Status
Slot 0: Device Variable Code
Slot 1: Device Variable Code
Slot 2: Device Variable Code
Slot 3: Device Variable Code
Slot 4: Device Variable Code
Slot 5: Device Variable Code
Slot 6: Device Variable Code
Slot 7: Device Variable Code
Extended Field Device Status
Slot 0: Device Variable Code
Slot 0: Device Variable Classification
Slot 0: Device Variable Value
Slot 0: Device Variable Status
Response Codes
Request example:
Response example:
Command 9 Read Device Variable with Status
Request Data Bytes
Response Data Bytes
Long frame
from slave
MID_M1000_BA_HART_02_1704
Universal commands Page 17/83
No Command Specific Error
Too Few Data Bytes Received
Device Variables Returned for Device Variables
Command Response Truncated
Command Byte count Status
Response Codes
Request example:
Response example:
Long frame
from slave
Data:
0 .. Extended Field Device Status
Slot 0: Volumetric Flow; 5.029623031616211 L/s; Good
Slot1: Velocity; 2.561566114425659 m/s; Good
Slot2: Volume; 853399.1875 L; Good
Slot3: Volume; 63.49031066894531 L; Good
Slot4: Volume; 853335.6875 L; Good
Slot 5: Analytical; 102.462646484375 %; Good
Slot 6: Volumetric Flow; 0.00502962339669466 m
Slot7: Volume; 853.399169921875 m
3
; Good
3
/s; Good
Time Stamp
00 42 18 40 A0 F2 AC C0
01 43 15 40 23 F0 B3 C0
02 44 29 49 50 59 73 C0
03 44 29 42 7D F6 14 C0
04 44 29 49 50 55 7B C0
05 51 39 42 CC EC E0 C0
06 42 1C 3B A4 CF 8A C0
07 44 2B 44 55 59 8C C0
MID_M1000_BA_HART_02_1704
Universal commands Page 18/83
No Command Specific Error
Command Byte count Status
FE BD 03 05 07 01 0E 08 00 0A E1 39 05 0D 00
01 00 00 BD 00 BD 01
No Command Specific Error
Command 11 Read Unique Identifier Associated With Tag
Request Data Bytes
Response Data Bytes
Same as Command 0 Read Unique Identifier
Response Codes
Request example:
Data:
“M1000 ”
Response example:
Start delimiter
Command 12 Read message
Request Data Bytes
Response Data Bytes
Response Codes
Request example:
MID_M1000_BA_HART_02_1704
Universal commands Page 19/83
Command Byte count Status
08 11 07 15 28 0D 15 41 52 80 93
Descriptor (Packed ASCII)
Date Code (Day, Month, Year)
No Command Specific Error
Command Byte count Status
37 1C 30 C2 08 20 82 08 20 82 08 20 82 08
20 82 08 20 01 01 00
Response example:
Long frame
from slave
39
Data:
“BADGER METER INC, M1000
Command 13 Read tag descriptor, and date
Request Data Bytes
Response Data Bytes
Response Codes
Request example:
83
B2 03 71 C3 0C 20 82 08 20 82 08
Response example:
Data:
Tag: “M1000 ”
Descriptor: “ ”
Day:1
Month: 1
Year: 1900
Long frame
from slave
MID_M1000_BA_HART_02_1704
Universal commands Page 20/83
Transducer Limits and Minimum Span Units Code
Volumetric Flow
Unit Codes
No Command Specific Error
Command Byte count Status
0A E1 39 18 41 BC 7E DE 3D 71 46 3A 40
16 6B 62
Command 14 Read PV sensor information
Request Data Bytes
Response Data Bytes
Response Codes
Request example:
Response example:
Long frame
from slave
Data:
Transducer Serial Number: 0AE139
Transducer Limits and Minimum Span Units Code: L/s
Upper Transducer Limit: 23.561946868896484
Lower Transducer Limit: 0.05890486389398575
Minimum Span: 2.350304126739502
MID_M1000_BA_HART_02_1704
Universal commands Page 21/83
PV Transfer Function Code
PV Upper and Lower Range Values Units Code
Volumetric Flow Unit
Codes
No Command Specific Error
FB 00 18 40 9D 14 63 00 00 00 00 00 00 00
00 FB FA 00
Command 15 Read PV output sensor information
Request Data Bytes
Response Data Bytes
1 … Low
251 … None
Response Codes
Request example:
Response example:
Long frame
from slave
Data:
Alarm Selection: None
Transfer Function: Linear
Upper Range: 4.908738613128662L/s
Lower Range: 0 L/s
Damping Value: 0 s
Write Protect Code: None
Reserved: 250
Analog Channel Flags: 0
count
MID_M1000_BA_HART_02_1704
Universal commands Page 22/83
No Command Specific Error
Command Byte count Status
No Command Specific Error
Too Few Data Bytes Received
Command 16 Read Assembly Number
Request Data Bytes
Response Data Bytes
Response Codes
Request example:
Response example:
Long frame
from slave
Data:
Final Assembly Number: 0A 1B 2C
Command 17 Write Message
Request Data Bytes
Response Data Bytes
Response Codes
MID_M1000_BA_HART_02_1704
Universal commands Page 23/83
08 11 07 15 28 0D 15 41 52 80 93 83
B2 03 71 C3 0C 20 82 08 20 82 08 2D
Command Byte count Status
08 11 07 15 28 0D 15 41 52 80 93 83
Descriptor (Packed ASCII)
Date Code (Day, Month, Year)
Descriptor (Packed ASCII)
Date Code (Day, Month, Year)
No Command Specific Error
Too Few Data Bytes Received
Invalid Date Code Detected
37 1C 30 C2 08 20 82 08 20 82 08 20 82 08 20 82
08 20 1B 08 72
Request example:
Long frame
from slave
Response example:
Long frame
from slave
FF
39
Data:
“BADGER METER INC, M1000 -”
Command 18 Write Tag, Description, Date
Request Data Bytes
B2 03 71 C3 0C 20 82 08 20 82 08
Response Data Bytes
Response Codes
Request example:
Long frame
from slave
MID_M1000_BA_HART_02_1704
Universal commands Page 24/83
Command Byte count Status
37 1C 30 C2 08 20 82 08 20 82 08 20 82 08 20
82 08 20 1B 08 72
No Command Specific Error
Too Few Data Bytes Received
Response example:
Long frame
from slave
Data:
Tag: “M1000 ”
Descriptor: “ ”
Day:27
Month: 8
Year: 2014
Command 19 Write Assembly number
Request Data Bytes
Response Data Bytes
Response Codes
Request example:
Long frame
from slave
MID_M1000_BA_HART_02_1704
Universal commands Page 25/83
Command Byte count Status
No Command Specific Error
Command Byte count Status
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
Response example:
Long frame
from slave
Data:
Final Assembly Number: 2C 1B 0A
Command 20 Read Long tag
Request Data Bytes
Response Data Bytes
Response Codes
Request example:
Response example:
F
Long frame
from slave
39
42
00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
E
MID_M1000_BA_HART_02_1704
Universal commands Page 26/83
No Command Specific Error
00 00 00 00 00 00 00 00 00 00 00 00 00 00
Command Byte count Status
FE BD 03 05 07 01 0E 08 00 0A E1 39 05 0D 00 02
00 00 BD 00 BD 01
No Command Specific Error
Too Few Data Bytes Received
Command 21 Read Unique Identifier Associated With Long Tag
Request Data Bytes
Response Data Bytes
Same as Command 0 Read Unique Identifier
Response Codes
Request example:
Response example:
Command 22 Write Long tag
Request Data Bytes
Response Data Bytes
00 00 00 00 00 00 00 00 00 00 00 00 00 00
Response Codes
MID_M1000_BA_HART_02_1704