Pqube 3 Modbus Interface: Reference Manual
Pqube 3 Modbus Interface: Reference Manual
Table of Contents
1. Background .....................................................................................................................................3
2. Basics ............................................................................................................................... 3
2.1 Registers and Coils .................................................................................................... 3
2.2 Address Space ........................................................................................................... 3
2.3 Query functions .......................................................................................................... 4
2.4 Scan rates, client load, and limitations ....................................................................... 4
2.5 Error responses .......................................................................................................... 4
2.4 PQube 3 Configuration ............................................................................................... 5
2.2 Clients ........................................................................................................................ 5
2.3 Register Map .............................................................................................................. 5
3. Register Bank Tables ....................................................................................................... 7
3.1 PQube Classic Register Bank (Offset 0x0)................................................................. 7
3.2 PQube Static Configuration Bank (Offset 0x1000) ................................................... 12
3.3 PQube Voltages Bank (Offset 0x2000) .................................................................... 13
3.4 PQube Currents Bank (Offset 0x6000) ..................................................................... 23
3.5 PQube DC/HF Bank (Offset 0x6000) ....................................................................... 35
1. Background
Modbus is a communication protocol originally created by Modicon (now Schneider
Electric) in 1979 for communication between programmable logic controllers (PLCs).
Modbus became an independently owned standard in 2004 by the Modbus Organization
due to its widespread usage and popularity in industrial and SCADA systems.
Links:
Wikipedia: en.wikipedia.org/wiki/Modbus
Modbus Site: modbus.org
Modicon Modbus Protocol:
interlog.com/~speff/usefulinfo/modbus_protocol.pdf
2. Basics
A modbus device presents an abstract set of registers and coils to another device for
reading or writing over a communication stack. That stack can be RS232, RS485, or lately
TCP/IP. The use of Modbus-TCP/IP allows for modbus-based traffic to flow over the
Internet, greatly expanding the complexity of modbus-networked systems.
The PQube 3 and PQube Classic support Modbus-TCP/IP.
necessarily map to device internal memory addresses. On the PQube 3, all registers are
addressed relative to a common base addressed defined in the PQube setup.ini file.
Therefore, a PQube can re-locate its modbus address space, but not change relative
offsets. Some devices conventionally offset holding registers from address 0x4000, and
input registers from 0x3000. The PQube 3 sets the default base address to 0x7000.
“Input registers” are conventionally defined as PLC registers that are refreshed from
device input sensors continually. “Holding registers” are conventionally defined as registers
that are kept in memory and have read/write state. The PQube3 does not distinguish
between “input registers” and “holding registers.” All registers are considered to be
memory-stored registers with READ_ONLY or READ_WRITE permissions. Therefore,
function queries 0x3 and 0x4 will both return the same register result regardless of address.
ILLEGAL_ADDRESS_VALUE
Used for queries outside of the address space.
ILLEGAL_DATA_VALUE
Used for queries beyond the packet limit.
ILLEGAL_FUNCTION_VALUE
Used for queries at function values other than 0x3,0x4,0x6, or 0x10.
2.2 Clients
The PQube3 supports the PSL Modbus Demo client, third party free Modbus clients,
or any software conforming to the Modbus protocol (such as groov).
This register bank supports most of the PQube Classic functionality, with exceptions
in registers: 92-95, 154-165, 167-173.
PQube Classic Bank
Offset Register Format Units Comments
Volt L1 to earth – U
0-1 L1-E Float rms10/12
(RMS)
Volt L2 to earth – U
2-3 L2-E Float rms10/12
(RMS)
Volt L3 to earth – U
4-5 L3-E Float rms10/12
(RMS)
Volt Neutral to earth – U
6-7 N-E Float rms10/12
(RMS)
Volt L1 to neutral – U
8-9 L1-N Float rms10/12
(RMS)
Volt L2 to neutral – U
10-11 L2-N Float rms10/12
(RMS)
Volt L3 to neutral – U
12-13 L3-N Float rms10/12
(RMS)
Volt L1 to L2 – U
14-15 L1-L2 Float rms10/12
(RMS)
Volt L2 to L3 – U
16-17 L2-L3 Float rms10/12
(RMS)
Volt L3 to L1 – U
18-19 L3-L1 Float rms10/12
(RMS)
Volt Analog 1 to Earth – U
20-21 AN1-E Float rms10/12
(RMS)
Volt Analog2 to Earth – U
22-23 AN2-E Float rms10/12
(RMS)
Volt Analog1 to Analog2 – U
24-25 AN1-AN2 Float rms10/12
(RMS)
26-27 Frequency Float Hz
Amps A
28-29 L1 Current Float rms10/12
(RMS)
Amps A
30-31 L2 Current Float rms10/12
(RMS)
Amps A
32-33 L3 Current Float rms10/12
(RMS)
Amps Neutral current - A
34-35 N Current Float rms10/12
(RMS)
36-37 Power (W) Float Watt Also see 204-209
38-39 Apparent Power (VA) Float VA Also see 210-215
40-41 Digital Input Float (none) Usually 0 or 1; a fractional value indicates duty cycle
Amps A
42-43 Peak Current (1-cycle) Float rms10/12
(RMS) See also registers 122-124:
Peak Current (1- Amps 1-minute RMS average
44-45 Float
minute) (RMS) See also registers 122-124
N-minute RMS average
Peak Current (N- Amps
46-47 Float Typically N is 10 minutes or 15 minutes. See register 1024.
minute) (RMS)
Also, see also registers 122-124
48-49 Peak Power (1-cycle) Float Watt See also registers 125-127
50-51 Peak Power (1-minute) Float Watt See also registers 125-127
Typically N is 10 minutes or 15 minutes. See register 1024. Also, see registers 125-
52-53 Peak Power (N-minute) Float W
127
54-55 Peak VA (1-cycle) Float VA See also registers 128-130
56-57 Peak VA (1-minute) Float VA See also registers 128-130
58-59 Peak VA (N-minute) Float VA See registers 128-130. Typically N is 10 minutes or 15 minutes - see register 1024.
60-61 Energy (Wh) Float Wh Also, see registers 131-133
62-63 Apparent Energy (VAh) Float VAh Also, see registers 131-133
64-65 Voltage THD Float % Also, see registers 192-197
66-67 Current TDD Float % Also, see register 1020-1021: base current for TDD. Also, see registers 198-203.
ANSI Voltage
68-69 Float % If using IEC or GB methods, see registers 174-175 and 178-179
Unbalance
ANSI Current
70-71 Float % If using IEC or GB methods, see registers 176-177 and 180-181
Unbalance
72-73 L1 Flicker P Float - Instantaneous value. For L2 and L3 see 228-239.
inst
74-75 L1 Flicker P Float - 10-minute value. For L2 and L3 see 228-239.
ST
76-77 L1 Flicker P Float - 2-hour value. For L2 and L3 see 228-239.
LT
Number of new events recorded by PQube since last time this register was polled.
78 New Event Recordings Integer - This register is incremented when the files are fully available for download. This
register is cleared by reading it.
Number of new trends (daily, weekly, monthly) recorded by PQube since last time
79 New Trend Recordings Integer - this register was polled. This register is incremented when the files are fully
available for download. This register is cleared by reading it.
80-81 Volt-amps reactive Float VAR Also, see registers 216-221
82-83 True power factor Float - Value between -1.0 and +1.0
Temperature – Probe
84-85 Float °C Modbus register is always in °C, even if user has selected °F for display
1
86-87 Humidity – Probe 1 Float %RH Relative humidity
Temperature – Probe
88-89 Float °C Modbus register is always in °C, even if user has selected °F for display
2
90-91 Humidity – Probe 2 Float %RH Relative humidity
CO rate Grams per
92-93 2 Float Not yet supported
hour
94-95 CO accumulated Float Grams Not yet supported.
2
Amps A
96-97 Earth current Float rms10/12
(RMS)
L1-N voltage
Volt
98-99 fundamental Float For delta systems, the PQube calculates a metering Neutral for this parameter.
(RMS)
magnitude
100- L1-N voltage
Float degrees Range: ±180.0º
101 fundamental angle
L2-N voltage
102- Volt
fundamental Float For delta systems, the PQube calculates a metering Neutral for this parameter.
103 (RMS)
magnitude
104- L2-N voltage
Float degrees Range: ±180.0º
105 fundamental angle
L3-N voltage
106- Volt
fundamental Float For delta systems, the PQube calculates a metering Neutral for this parameter.
107 (RMS)
magnitude
108- L3-N voltage
Float degrees Range: ±180.0º
109 fundamental angle
L1 current
110- Amps
fundamental Float
111 (RMS)
magnitude
112- L1 current
Float degrees Range: ±180.0º
113 fundamental angle
L2 current
114- Amps
fundamental Float
115 (RMS)
magnitude
116- L2 current
Float degrees Range: ±180.0º
117 fundamental angle
L3 current
118- Amps
fundamental Float
119 (RMS)
magnitude
120- L3 current
Float degrees Range: ±180.0º
121 fundamental angle
Peak current – “since”
122 Integer Year Typical values: 2009, 2010, etc.
date
Peak current – “since”
123 Integer Month Range: 1 – 12
date
Peak current – “since”
124 Integer Day Range: 1 – 31
date
Peak power – “since”
125 Integer Year Typical values: 2009, 2010, etc.
date
Peak power – “since”
126 Integer Month Range: 1 – 12
date
Peak power – “since”
127 Integer Day Range: 1 – 31
date
Peak VA – “since”
128 Integer Year Typical values: 2009, 2010, etc.
date
Peak VA – “since”
129 Integer Month Range: 1 – 12
date
Peak VA – “since”
130 Integer Day Range: 1 – 31
date
Energy (Wh) –
131 Integer Year Typical values: 2009, 2010, etc.
“since” date
Energy (Wh) –
132 Integer Month Range: 1 – 12
“since” date
Energy (Wh) –
133 Integer Day Range: 1 – 31
“since” date
134 PQube clock-calendar Integer Year Typical values: 2009, 2010, etc.
135 PQube clock-calendar Integer Month Range: 1 – 12
136 PQube clock-calendar Integer Day Range: 1 – 31
137 PQube clock-calendar Integer Hour Range 0 – 23
138 PQube clock-calendar Integer Min Range 0 – 59
139 PQube clock-calendar Integer Second Range 0 – 59
140- PQube offset from
Float Hours Range -12.0 - +12.0 . Set by user in Setup.ini file.
141 UTC
142- Volt
Harmonic – L1-N Volt Float Harmonic order specified in 166
143 (RMS)
144- Volt
Harmonic – L2-N Volt Float Harmonic order specified in 166
145 (RMS)
146- Volt
Harmonic – L3-N Volt Float Harmonic order specified in 166
147 (RMS)
148- Amps
Harmonic – L1 current Float Harmonic order specified in 166
149 (RMS)
150- Amps
Harmonic – L2 current Float Harmonic order specified in 166
151 (RMS)
152- Amps
Harmonic – L3 current Float Harmonic order specified in 166
153 (RMS)
154- Harmonic – L1-N
Float degrees Not supported
155 voltage angle
156- Harmonic – L2-N
Float degrees Not supported
157 voltage angle
158- Harmonic – L3-N
Float degrees Not supported
159 voltage angle
160- Harmonic – L1 current
Float degrees Not supported.
161 angle
162- Harmonic – L2 current
Float degrees Not supported.
163 angle
164- Harmonic – L3 current
Float degrees Not supported.
165 angle
Harmonic order of Integer Range: 1-50, selected by user on PQube harmonic meters screens – defaults to
166 - rd
interest (Read/Write) 3 harmonic
0 = not installed
1 = not locked
167 GPS status Integer -
2 = locked onto satellites and operating
Not supported yet
168- GPS latitude Float degrees Range: ±90.0000° from equato
234- L3 Flicker P
ST Float - 10-minute value. For L1 see 74-75
235
236- L2 Flicker P
LT Float - 2-hour value. For L1 see 76-77
237
238- L3 Flicker P
LT Float - 2-hour value. For L1 see 76-77
239
240- VAR-hours accumulated since [date] - shares this reset date with Energy, see
VARh Float
241 registers 131-133
DC Energy– “since”
242 Integer Year Typical values: 2009, 2010, etc.
date
DC Energy– “since”
243 Integer Month Range: 1 – 12
date
DC Energy– “since”
244 Integer Day Range: 1 – 31
date
Reset Energy
245 Write-only - Set this register to 1 to reset the energy accumulators in your PQube
Accumulators
Reset Analog Energy
246 Write-only - Set this register to 1 to reset the analog energy accumulators in your PQube
Accumulators
2234 L1_Voltage_Harmonic_H2 Float Volt OR %H1 Unit is function of configuration tag in PQube3 See register 8028
6014 AN_Power_1 Float Watt Requires the configuration to declare Energy mode for Analog inputs 1 and
2
6016 AN_Power_2 Float Watt Requires the configuration to declare Energy mode for Analog inputs 1 and
2
6018 Analog_Energy Float Wh Requires the configuration to declare Energy mode for Analog inputs 1 and
2
6020 Analog_Energy_2 Float Wh Requires the configuration to declare Energy mode for Analog inputs 1 and
2
Meters per
6836 Ext_Probe_1_Tilt Angle Float
Second^2
6838 Ext_Probe_2_Ambient_Temp Float DegC
6840 Ext_Probe_2_Humidity Float %RH
6842 Ext_Probe_2_Pressure Float HPa
6904 Ext_Probe_1_Trigger Snaphot Write 1 Writing to this register triggers a Probe A accelerometer snapshot event
6906 Ext_Probe_2_Trigger Snaphot Write 1 Writing to this register triggers a Probe A accelerometer snapshot event
6914 Ext_Probe_2_Model_Number Float Probe 2 model number (1,2,3) for ENV1, ENV2, or ENV3
6916 Ext_Probe_1_ThermoCouple_1_Temp Float Degrees C Not yet enabled
Meters per
6920 Ext_Probe_1_Acceleration_Min_X Float Minimum X axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6922 Ext_Probe_1_Acceleration_Avg_X Float Average X axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6924 Ext_Probe_1_Acceleration_Max_X Float Maximum X axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6926 Ext_Probe_1_Acceleration_Min_Y Float Minimum Y axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6928 Ext_Probe_1_Acceleration_Avg_Y Float Average Y axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6930 Ext_Probe_1_Acceleration_Max_Y Float Maximum Y axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6932 Ext_Probe_1_Acceleration_Min_Z Float Minimum Z axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6934 Ext_Probe_1_Acceleration_Avg_Z Float Average Z axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6936 Ext_Probe_1_Acceleration_Max_Z Float Maximum Z axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per Maximum vector acceleration amplitude over the last second, measured
6938 Ext_Probe_1_Vector_Acceleration_Amplitude_Min Float
Second^2 at 32 HZ
Meters per Maximum vector acceleration amplitude over the last second, measured
6940 Ext_Probe_1_Vector_Acceleration_Amplitude_Min Float
Second^2 at 32 HZ
Meters per Maximum vector acceleration amplitude over the last second, measured
6942 Ext_Probe_1_Vector_Acceleration_Amplitude_Min Float
Second^2 at 32 HZ
6944 Ext_Probe_2_ThermoCouple_1_Temp Float Degrees C Not yet enabled
Meters per
6948 Ext_Probe_2_Acceleration_Min_X Float Minimum X axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6950 Ext_Probe_2_Acceleration_Avg_X Float Average X axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6952 Ext_Probe_2_Acceleration_Max_X Float Maximum X axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6954 Ext_Probe_2_Acceleration_Min_Y Float Minimum Y axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6956 Ext_Probe_2_Acceleration_Avg_Y Float Average Y axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6958 Ext_Probe_2_Acceleration_Max_Y Float Maximum Y axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6960 Ext_Probe_2_Acceleration_Min_Z Float Minimum Z axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6962 Ext_Probe_2_Acceleration_Avg_Z Float Average Z axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per
6964 Ext_Probe_2_Acceleration_Max_Z Float Maximum Z axis acceleration over the last second, measured at 32 HZ
Second^2
Meters per Maximum vector acceleration amplitude over the last second, measured
6966 Ext_Probe_2_Vector_Acceleration_Amplitude_Min Float
Second^2 at 32 HZ
Meters per Maximum vector acceleration amplitude over the last second, measured
6968 Ext_Probe_2_Vector_Acceleration_Amplitude_Min Float
Second^2 at 32 HZ
Meters per Maximum vector acceleration amplitude over the last second, measured
6970 Ext_Probe_2_Vector_Acceleration_Amplitude_Min Float
Second^2 at 32 HZ