All devices

ProMinent · Dosing pump

gamma/ XL (GXLa) solenoid metering pump, control option 'M' (Modbus RTU) Modbus register map

Serial device: in Modbus Connect, choose “Add to existing device” and pick the serial (RTU) device you created on your COM port.

Default configuration

Protocol
Modbus RTU over RS-485
Unit ID
20
Addressing
1-based
Byte order
Big endian
Word order
High word first
Baud rate
19200
Parity
Even
Data bits
8
Stop bits
1

To read this device over Modbus RTU in Modbus Connect:

  1. In Modbus Connect, add a serial (RTU) device on your COM port with the serial settings and unit ID shown above.
  2. Click Add to Modbus Connect (or open the downloaded JSON), choose “Add to existing device” and pick that serial device. Its registers, byte order and word order are added; the serial device keeps its own line settings.

The “Add device” tab creates a Modbus TCP device (IP address and port), so use it only when you reach this device through a Modbus RTU-to-TCP gateway set to the serial settings above.

Register map

AddressCountNameTypeUnitScaleAccess
632
Modbus endianness pattern
Read-only register 63 of the 'Modbus' block: the pump stores the pattern 0xAABBCCDD here so a master can determine the endianness of the Modbus access. The document prints no byte or word order for its 32-bit values, so the seed declares BigEndian + HighFirst and this register is the documented way to verify it on site.
UInt32-1R
10002
Status register
Bits 2-4 = operating mode (0 stop, 1 manual, 2 contact, 3 batch, 4 analogue), 5 error present, 6 warnings present, 7 manually stopped, 8 stopped, 9 priming, 10 auxiliary operation, 11 pause, 12 field bus mode, 13 metering monitor enabled, 14 batch memory active, 15 calibrated, 16 relay 1 present, 17 relay 2 present, 18 analogue output present, 19 diaphragm rupture option, 20 concentration calculation active, 22 cavitation detected, 23 air in the dosing head, 24 back pressure too high, 25 back pressure too low, 26 bleeding; bits 0, 1, 21 and 27-31 are reserved.
UInt32-1R
10022
Error flags (1st register)
Bit 0 configuration data error (system), 1 power input too low, 2 power input too high, 3 level error, 4 diaphragm rupture, 5 metering monitor error, 6 position determination error, 7 temperature too high, 8 initialisation error (system), 9 drive error, 10 invalid metering parameter, 11 overpressure, 12 overcurrent, 13 undervoltage, 14 air in the head, 15 bleeding unsuccessful, 16 overflow batch memory, 17 input current smaller than limit, 18 input current larger than limit, 19 negative pressure, 20 no pump-to-module connection, 21 no pump-to-master connection, 22 internal CAN bus error.
UInt32-1R
10042
Error flags (2nd register)
The document prints bits 0-31 as reserved for this register.
UInt32-1R
10062
Warning flags
Warning bit field, beginning with bit 0 = level warning.
UInt32-1R
10081
Actual stroke rate
Range 1 to the maximum possible stroke rate.
UInt16strokes/h1R
10092
Actual stroke length
Stroke length actually applied, 1-100 %.
Float32%1R
10111
Maximum possible stroke rate
Determined by the device context, e.g. the set suction stroke.
UInt16strokes/h1R
10182
Actual capacity
Actual feed rate; the unit depends on the dosing head fitted and the device context.
Float32-1R
10202
Maximum possible capacity
Determined by the dosing head fitted and the device context.
Float32-1R
10242
Actual concentration
If the actual concentration is >= 0.1 % it is displayed in %, otherwise in ppm.
Float32%1R
10262
Switch-on counter
Number of previous power-ups.
UInt32-1R
10282
Total operating time
Total operating time in hours, range 0 to (2^32-1)/3600 h.
UInt32h1R
10302
Total stroke counter
Total number of strokes, range 0 to 2^32-1.
UInt32strokes1R
10342
Total metering quantity
Total metered volume in litres.
Float32l1R
10382
Remaining strokes
Strokes remaining in the current batch or contact cycle.
UInt32strokes1R
10402
Remaining metering quantity
Metered volume remaining in the current batch or contact cycle.
Float32l1R
10422
Metering quantity of last stroke
Volume of the last stroke; the unit depends on the dosing head and the device context.
Float32-1R
10442
Medium system pressure
Back pressure at the dosing head, 0.0 bar to the operating pressure.
Float32bar1R
10461
Liquid level monitoring
Level reported by the level switch / suction lance, 0-100 %.
UInt16%1R
12012
Target stroke length
Target stroke length, 1-100 %.
Float32%1RW
12031
Target stroke rate
Target stroke rate, 1 to the maximum possible stroke rate.
UInt16strokes/h1RW
12112
Target capacity
Target feed rate; the unit depends on the dosing head fitted and the device context.
Float32-1RW
12152
Metering volume per batch
Batch-mode set-point; the value range is controlled by the metering volume settings.
Float32-1RW
12171
Metering time for batch
Batch-mode metering time; min/max values are controlled by the batch settings.
UInt16s1RW
12212
Metering volume per contact
Contact-mode set-point.
Float32-1RW
12262
Desired final concentration
Target concentration for concentration mode, 0.01-100000 ppm.
Float32ppm1RW
12331
Priming duration
Priming time, 1-60 s.
UInt16s1RW
12351
Trigger a batch/contact cycle
Writing a Modbus message with this register number and the user data pattern given in the document triggers a batch or contact cycle, depending on the operating mode.
UInt16-1RW
12361
Delete error requiring acknowledgement
Writing a Modbus message with this register number and user data pattern 0x5555 resets all errors that require acknowledgement.
UInt16-1RW

Read this device live with Modbus Connect, free for Windows, macOS and Linux

Related guides

Notes

Source: ProMinent 'Supplementary Operating Instructions for Modbus RTU' for the solenoid metering pumps gamma/ XL, GXLa, document 981604 (BA G-061 09-19, 'ErgBA Optionen Komm GXLa'), chapter 2 - sections 2.4 (operating menu defaults), 2.5.1 (telegram structure), 2.10.1-2.10.2 (device identification and Modbus registers) and 2.10.5/2.10.6 (current and target operating parameters); vendor-hosted at prominent.de, SHA-256 6475d9b21c475cb150911d6fe7f417617eb343ff435637e2dc0e581cb903f909. Factory frame: the document's default-settings box says the pump is delivered with bus address 20 and 19200 baud, and its telegram table (Tab. 25) fixes the characters at 1 start bit, 8 data bits, 1 parity bit 'even' and 1 stop bit, with 19200 as the preset data rate. Addressing: the register tables number their rows 1, 3, 4, 9 ... 1000, 1002 ... with no wire-address column and no frame example, so the seed declares one_based (register number minus one), the same reading the library applied to the Sentera maps; the inference is recorded here rather than hidden. The document prints no byte or word order for its FLOAT32/UINT32 values - instead register 63 stores the pattern 0xAABBCCDD so the master can determine it - so BigEndian + HighFirst is declared as the Modbus convention and register 63 is seeded to verify it. Omitted on purpose: every row the document types UINT8, BOOLEAN or Enum (1234, 1225, 1228-1232, the Modbus module settings 50-56 and 1200 start/stop) because this schema has no 8-bit type; the advanced-configuration and accessories/debug blocks; and the device-identification/production-data blocks 1-33 and 200-526, whose strings and production data are identity rather than process values.