ModMAG M2000 User manual

Electromagnetic Flow Meters
M2000 HART® Bi-Directional Communication Protocol
MAG-UM-01408-EN-05 (December 2021) User Manual

Electromagnetic Flow Meters, M2000 HART® Bi-Directional Communication Protocol
Page ii December 2021MAG-UM-01408-EN-05

CONTENTS
About This Manual. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Denitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Installation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Prerequisites. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
Installing the Daughterboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
M2000 and HART . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Device Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Dynamic Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Device Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Meter Status Register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Universal Command #0 – Read Unique Identier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Universal Command #9 – Read Device Variables with Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Universal Command #48 – Read Additional Device Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
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
User Manual
Page iiiDecember 2021 MAG-UM-01408-EN-05

Electromagnetic Flow Meters, M2000 HART® Bi-Directional Communication Protocol
Page iv December 2021MAG-UM-01408-EN-05

ABOUT THIS MANUAL
Denitions
DD Device Description
HART Highway Addressable Remote Transducer
HOST Host System, typically the master (i.e. handheld device)
PV Primary Variable
SV Secondary Variable
TV Tertiary Variable
FV Fourth Variable
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, see
eldcommgroup.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 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 https://www.fieldcommgroup.org/technologies/hart/documents-
and-downloads-hart. 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.
M2000
DSP
HART
Daughter
Board
Modbus RTU HART
INTELLIGENT
HOST
Figure 1: HART-to-Modbus RTU commands
About This Manual
Page 5December 2021 MAG-UM-01408-EN-05

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.
Figure 2: Main board label
Installing the Daughterboard
The daughterboard connects to the 11-pin connector labeled as COMMUNICATION on the main amplifier.
Figure 3: Daughterboard connection
Installation
Page 6 December 2021MAG-UM-01408-EN-05

Follow these steps to install the daughterboard:
1. Prior to installing the daughterboard, verify or congure the M2000 Communication Port B. Access the port settings at
Main Menu > Communications > Port B Settings.
Parameter Value Comments
Port Address 001 —
Extended Port Address — Not applicable for HART
Baud Rate 38400 HART Daughterboard auto-bauds, all baud rates supported
Data Bits 8 —
Parity EVEN —
Stop Bits 1 —
2. Verify or congure the analog output range at 4…20 mA.
Access the analog output range at Main Menu > Inputs/Outputs > Analog Output Range.
3. Power o the M2000.
DISCONNECT THE INPUT POWER BEFORE ACCESSING THE EQUIPMENT.
THIS STEP IS IMPORTANT FOR THE M2000 TO PROPERLY RECOGNIZE THE HART DAUGHTERBOARD AND FULFILL
HART COMPLIANCE.
4. Prior to inserting the daughterboard, install the foam insulation pad as shown below. Be sure to align the groove with the
two screws attaching the detector or wall mount bracket to the enclosure. The primary purpose of this pad is to ensure
the daughterboard is insulated from the enclosure wall. It is important to install this pad flush with the top of the
enclosure wall.
Figure 4: Installing foam insulation pad
5. Insert the daughterboard into the 11-pin connector.
6. Use the following information to make appropriate wiring of analog wires to the 4-pin customer connector.
Pin Number Pin Description Comments
41 Analog Ground —
42 Analog Signal Requires minimum loop impedance of 230 Ω for communication
43 Analog Shield Only for shielded wires
44 Chassis Jumper Connect to screw in corner
7. Power on the M2000.
8. Allow time for the daughterboard to properly power up and be recognized by the M2000 before navigating the menus.
This time is typically 5 seconds. If the HART daughterboard is not recognized, then the M2000 should be power cycled.
9. Verify recognition of the HART daughterboard. Navigate to Main Menu > Info > Help. The Daughterboard Info eld indicates
the Daughterboard Type is HART.
Apply insulation pad
flush with the top of
the housing.
Installation
Page 7December 2021 MAG-UM-01408-EN-05

M2000 AND HART
HART protocol has three categories of commands: Universal, Device-Specific and Common Practice. The M2000 HART
daughterboard supports only some Universal commands and Device-Specific commands. Universal commands
supported include:
Command
Number Command Description
0 Read Unique Identifier
1Read Primary Variable
2 Read Current and Percent of Range
3 Read Current and Four Dynamic Variables
6 Write Polling Address
7 Read Loop Configuration
8 Read Dynamic Variable Class
9 Read Device Variables with Status
11 Read Unique Identifier Associated with Tag
12 Read Message
13 Read Tag, Descriptor, Date
14 Read PV Sensor Information
15 Read Output Information
16 Read Final Assembly Number
17 Write Message
18 Write Tag, Descriptor, Date
19 Write Final Assembly Number
20 Read Long Tag
21 Read Unique Identifier Associated with Long Tag
22 Write Long Tag
38 Reset Configuration Changed Flag
48 Read Additional Device Status
Typically, these commands are used by advanced users of HART or the usage of these commands is embedded within the
DD files. With the use of the HART universal commands, device variables and dynamic variables are accessible. Device and
dynamic variables are defined later. For further understanding of the format and function of the HART Universal Commands
please refer to HART protocol documentation.
Device-specific commands are mainly for accessing many of the M2000 data parameters, including configuration, identity
and diagnostic parameters. Much of the data accessible with device specific commands is accessed through the use of the DD
files. The DD files provide all the necessary information for data management within the M2000. Installing and using the DD
files in the applications host is the most convenient method for communicating to the M2000 over HART.
Using both the HART universal commands and device-specific commands allows for complete access to the M2000
parameters, including the ability to read or write M2000 parameters. The Data Management section defines the M2000 data
and the associated HART command.
M2000 and HART
Page 8 December 2021MAG-UM-01408-EN-05

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
1Flow 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
Variable
T1/T+ 68 USER UNITS
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.
M2000 and HART
Page 9December 2021 MAG-UM-01408-EN-05

Meter Status Register
Meter status is a status variable accessible over Modbus that identifies the error state of the M2000. The HART daughterboard
shall query this Modbus register and report status through the usage of Universal Command #9 and #48. Below is a table that
defines the meter status register. Unused bits are not listed in the table and are always set to 0.
Bit Description
0 Detector Error
1 Empty Pipe Error
2 Full Scale Flow Error
3 Totalizer Rollover Error
4 Totalizer Rollover Status
5 Flow Simulation Status
6 Reserved
7 ADC Interrupt Error
8 ADC Range Error
Universal Command #0 – Read Unique Identier
Command #0 has particular status information that requires definition. Below is a table that defines byte 16 of the response,
Extended Field Device Status.
Bit Description
0 Maintenance Required - Set when Meter Status bits 0, 1, 3, 4, 7, or 8 are set
1 Alert State - Set when Meter Status bits 2,5,or 6 are set
Universal Command #9 – Read Device Variables with Status
Command #9 has particular status information that requires definition. Below is a table that defines the device variable status
byte coding. Only those defined in the table below can be observed.
Bit 7 Bit 6 Bit 5 Bit 4 Bit 3 Bit 2 Bit 1 Bit 0
Description
Process
Data
Status
Limit
Status Reserved – Always 0
1 1 X X 0 0 0 0 Good Data – M2000 is without error and all measurements are proper
0 0 X X 0 0 0 0 Bad Data – M2000 is with error and measurements are not relating to
actual flow
Bad data is considered when“additional device status”indicates an error condition. Refer to Universal Command #48. Warning
conditions are considered good data.
M2000 and HART
Page 10 December 2021MAG-UM-01408-EN-05