Badger Meter TFX-5000 User Manual

Transit Time Ultrasonic Flow Meters

TFX-5000 Meter Modbus RTU Protocol

TTM-UM-03073-EN-01 (August 2019)

User Manual

Transit Time Ultrasonic Flow Meters, TFX-5000 Meter Modbus RTU Protocol

CONTENTS

Supported Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Wiring. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Communication Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Registers/Starting Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Function Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Word Order/Endian . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Modbus Registers and Coils. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

Flow Meter Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Coils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Energy Meter Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Coils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Enumerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Warning and Alarm Message Codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

Failure Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Check Function Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Out-of-Specication Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Informational Events Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Page ii August 2019TTM-UM-03073-EN-01

Supported Features

SUPPORTED FEATURES

TFX-5000 meters include an EIA-485 port that is selectable for Modbus RTU or BACnet MS/TP protocol. The meter can be
wired on a single daisy chain network and be queried for flow rate and totalizer readings along with diagnostic and
other information.

For further information on the proper installation of the transmitter, see the TFX-5000 user manual.

EIA-485 port on the TFX-5000 automatically detects which lines are A and B for transmitting and receiving. The hardware
automatically corrects for the RS485 negative and positive connections being swapped.

WIRING

RS485 Output

The RS485 feature allows up to 126 transmitters to be placed on a single three-wire cable up to 4000 feet. All transmitters are
assigned a unique numeric address that allows all of the transmitters on the cable network to be independently accessed.
Either Modbus RTU or BACnet MS/TP protocol is used to interrogate the transmitters.

Flow rate and total can be monitored over the digital communications bus.

When a USB programming cable is connected, the RS485 and frequency outputs are disabled.

Terminator Resistors

(Enabled through Parameter Setting)

60.4 Ohms

60.4 Ohms

A B

Figure 1: Typical RS485 interface

TB700

3

4

External Equipment

RS485 +

RS485 −

COMMUNICATION SETTINGS

To set up the meter for Modbus RTU:

1. Go to Main Menu > System Setup > Communications menu.

2. Select Modbus RTU.

3. Set the address (1…127).

4. Check that the baud rate, parity, stop bits and word order (endian) match the master device.

5. Enable the terminating resistor if the meter is the last device in the network. TFX-5000 meters have a built-in resistor that
can be selected through the communication setting.

6. Select the master timeout. TFX-5000 meters can display a warning when the master device does not send a packet within
the specified time. Setting the master timeout to 0 disables the warning.

7. Select which parameters the master device can write to:

a. All coil outputs and read/write holding registers

b. Coil outputs only (resets)

c. None (read only).

Page 3 August 2019 TTM-UM-03073-EN-01

Registers/Starting Address

REGISTERS/STARTING ADDRESS

It is important to know whether the master device uses starting addresses or registers/coils as these numbers are offset by 1.
For example, holding output coil 00001 is starting address 00 (hex).

Function Codes

TFX-5000 transmitters support the following function codes, as applicable:

01 (0x01 hex) Read Coils

03 (0x03 hex) Read Holding Registers

04 (0x04 hex) Read Input Registers

05 (0x05 hex) Write Single Coil

06 (0x06 hex) Write Single Register

16 (0x10 hex) Write Multiple Registers

Word Order/Endian

Each Modbus holding register represents a 16-bit integer value (2 bytes). The official Modbus standard defines Modbus as a
‘big-endian’ protocol where the most significant byte of a 16-bit value is sent before the least significant byte. For example,
the 16-bit hex value of ‘1234’ is transferred as ‘12’ ‘34’.

Beyond 16-bit values, the protocol itself does not specify how 32-bit (or larger) numbers that span over multiple registers
should be handled. It is very common to transfer 32-bit values as pairs of two consecutive 16-bit registers in little-endian word
order. For example, the 32-bit hex value of ‘12345678’ is transferred as ‘56’ ‘78’ ‘12’ ‘34’. The register bytes are still sent in big­endian order per the Modbus protocol, but the 16-bit registers are sent in little-endian order. Alternatively, some devices store
and transfer the Modbus registers in big-endian word order. For example, the 32-bit hex value of ‘12345678’ is transferred as
‘12’ ‘34’ ‘56’ ‘78’.

As long as the transferring and receiving device transmit the data in the same manner, it does not matter in which order the
words are sent. The word order is selectable in the TFX-5000 meter. This option is useful in applications where the Modbus
master cannot be configured for endianness.

Page 4 August 2019TTM-UM-03073-EN-01

MODBUS REGISTERS AND COILS

Flow Meter Registers

Modbus Registers and Coils

Descriptive Name Description

READINGS

Flow Rate on Screen

Velocity on Screen

Delta Time Filtered (ns)

Flow Rate (gal/min) Flow rate in gallons/minute. R 40201-40202 40801-40802 41401-41404
Velocity (ft/sec) Fluid velocity in feet/second. R 40203-40204 40803-40804 41405-41408
Flow Rate (l/min) Flow rate in liters/minute. R 40401-40402 41001-41002 41601-41604
Velocity (m/sec) Fluid velocity in meters/second. R 40403-40404 41003-41004 41605-41608

TOTALS

Net Flow Totalizer
(home screen units)

Positive Flow Totalizer
(home screen units)

Negative Flow Totalizer
(home screen units)

Gross Flow Totalizer
(home screen units)

Flow Totalizer
Overflow Counter
(Net)

Flow Totalizer
Overflow Counter
(Positive)

Flow Totalizer
Overflow Counter
(Negative)

Flow Totalizer
Overflow Counter
(Gross)

Net Flow Totalizer (gal)

Positive Flow Totalizer
(gal)

Negative Flow Totalizer
(gal)

Gross Flow Totalizer
(gal)

Totalizer Overflow
Counter (Net)

Totalizer Overflow
Counter (Positive)

Totalizer Overflow
Counter (Negative)

Totalizer Overflow
Counter (Gross)

Net Flow Totalizer
(liters)

Positive Flow Totalizer
(liters)

Negative Flow Totalizer
(liters)

Gross Flow Totalizer
(liters)

Flow rate displayed on home screen. Unit is based on selection for
home screen.

Fluid velocity displayed on home screen. Unit is based on selection for
home screen.

Time of flight difference between upstream and downstream used to
calculated the flow rate. Units are nanoseconds.

Total volume as forward flow minus reverse flow. A negative total results
when reverse flow is greater than forward flow. Unit is based on selection for
home screen.

Total volume of flow in forward direction. Reverse flow is not accounted for
in the total. Unit is based on selection for home screen.

Total volume of flow in reverse direction. Forward flow is not accounted for
in the total. Unit is based on selection for home screen.

Total volume of forward and reverse flow. Unit is based on selection for
home screen.

Number of times the net flow total overruns. R 42009-42010 — —

Number of times the positive flow total overruns. R 42011-42012 — —

Number of times the negative flow total overruns. R 42013-42014 — —

Number of times the gross flow total overruns. R 42015-42016 — —

Total volume as forward flow minus reverse flow. A negative total results
when reverse flow is greater than forward flow.

Total volume of flow in forward direction. Reverse flow is not accounted for
in the total.

Total volume of flow in reverse direction. Forward flow is not accounted for
in the total.

Total volume of forward and reverse flow. R 42107-42108 42407-42408 42713-42716

Number of times the net flow total overruns. R 42109-42110 — —

Number of times the positive flow total overruns. R 42111-42112 — —

Number of times the negative flow total overruns. R 42113-42114 — —

Number of times the gross flow total overruns. R 42115-42116 — —

Total volume as forward flow minus reverse flow. A negative total results
when reverse flow is greater than forward flow.

Total volume of flow in forward direction. Reverse flow is not accounted for
in the total.

Total volume of flow in reverse direction. Forward flow is not accounted for
in the total.

Total volume of forward and reverse flow. R 42207-42208 42507-42508 42813-42816

Integer and

Long Integer

Access

Network

R 40001-40002 40601-40602 41201-41204

R 40003-40004 40603-40604 41205-41208

R 40005-40006 40605-40606 41209-41212

R 42001-42002 42301-42302 42601-42604

R 42003-42004 42303-42304 42605-42608

R 42005-42006 42305-42306 42609-42612

R 42007-42008 42307-42308 42613-42615

R 42101-42102 42401-42402 42701-42704

R 42103-42104 42403-42404 42705-42708

R 42105-42106 42405-42406 42709-42712

R 42201-42202 42501-42502 42801-42804

R 42203-42204 42503-42504 42805-42808

R 42205-42206 42505-42506 42809-42812

Single

Precision

32-bit

floating point

Double

Precision

64-bit

floating point

Page 5 August 2019 TTM-UM-03073-EN-01