Satec PM130 series User manual

PM130
Powermeters
Reference Guide
ASCII
Communications
Protocol
BG0309 Rev. A1

SERIES PM130 POWERMETERS
COMMUNICATIONS
ASCII Communications Protocol
REFERENCE GUIDE

2
Every effort has been made to ensure that the material herein is complete and accurate.
However, the manufacturer is not responsible for any mistakes in printing or faulty instructions
contained in this book. Notification of any errors or misprints will be received with appreciation.
For further information regarding a particular installation, operation or maintenance of
equipment, contact the manufacturer or your local representative or distributor.
This book is copyrighted. No part of this book may be reproduced, stored in a retrieval system,
or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or
otherwise without the prior written permission of the manufacturer.
BG0309 Rev.A1

3
Table of Contents
1 GENERAL...................................................................................................... 4
2 ASCII FRAMING ........................................................................................... 5
3 EXCEPTION RESPONSES ........................................................................... 7
4 SPECIFIC ASCII REQUESTS........................................................................ 8
4.1 Basic Data ......................................................................................................................... 8
4.2 Basic Setup ....................................................................................................................... 9
4.3 Instrument Status ............................................................................................................ 10
4.4 Reset/Clear Functions..................................................................................................... 11
4.5 Reset the Instrument (warm restart) ............................................................................... 11
4.6 Read Firmware Version Number .................................................................................... 11
4.7 Extended Instrument Status............................................................................................ 12
4.8 Pulsing Setpoints ............................................................................................................ 13
4.9 Min/Max Log.................................................................................................................... 14
5 DIRECT READ/WRITE REQUESTS............................................................ 15
5.1 General............................................................................................................................ 15
5.1.1 Long-Size Direct Read/Write................................................................................ 15
5.1.2 Variable-Size Direct Read/Write .......................................................................... 16
5.1.3 User Assignable Registers ................................................................................... 16
5.2 Extended Data Registers ................................................................................................ 17
5.3 Basic Setup Registers..................................................................................................... 21
5.4 User Selectable Options Setup....................................................................................... 22
5.5 Communications Setup ................................................................................................... 22
5.6 Alarm/Event Setpoints..................................................................................................... 23
5.7 Relay Operation Control Registers ................................................................................. 25
5.8 Instrument Options Registers ......................................................................................... 25
5.9 Extended Status Registers.............................................................................................. 26
5.10 Alarm Status Registers ................................................................................................. 26
5.11 Reset/Synchronization Registers.................................................................................. 27

4
1 GENERAL
This document specifies the ASCII serial communications protocol used to transfer data
between a master computer station and the PM130. The document provides the complete
information necessary to develop a third-party communications software capable of
communication with the Series PM130 instruments.
All messages within the ASCII communications protocol are designed to consist only of
printable characters.
Additional information concerning communications operation, configuring the communications
parameters and communications connections is found in "Series PM130 Powermeters,
Installation and Operation Manual".
IMPORTANT
In 3-wire connection schemes, the unbalanced current and phase readings for power factor, active power,
and reactive power will be zeros, because they have no meaning. Only the total three-phase power values
can be used.

5
2 ASCII FRAMING
The following specifies the ASCII message frame:
Field No. 1 2 3 4 5 6 7
Contents SYNC
(!)
Message
length
Slave
address
Message
type
Message
body
Check
sum
Trailer
(CRLF)
Length, char 1 3 2 1 0 to 246 1 2
SYNC
Synchronization character: one character '!' (ASCII 33), used for starting synchronization.
Message length
The length of the message including only number of bytes in fields #2, #3, #4 and #5. Contains
three characters between '006' and '252'.
Slave address
Two characters between '00' and '99'. The instrument with address '00' responds to requests
with any incoming address. For RS-422/RS-485 communications (multi-drop mode), this field
must NEVER be zero.
Message type
One character representing the type of a host request. A list of the message types is shown in
Tables 2-1 and 2-2. Note that they are case-sensitive.
Message body
Contains the message parameters in ASCII representation. All parameter fields have a fixed
format. The data fields vary in length depending on the data type. Unless otherwise indicated,
the parameters should be right justified and left-padded with zeros. Most parameters are
represented in ASCII hexadecimal notation, and in some cases (to provide compatibility with old
instruments) a decimal representation is preserved.
In a decimal notation, the parameters are transferred in a decimal representation as is, i.e., no
conversion is needed. When a value is between 0 and 1, a decimal point is placed in the data
field. When the whole value exceeds the field range, it is divided by 1000 and truncated to the
right. A decimal point is placed after the thousands to denote that the value has been truncated
and must be multiplied by 1000 before it will be processed.
In a hexadecimal notation, all parameters are whole binary numbers of a 1-byte, 2-byte or 4-
byte length. Each byte is transferred as two hexadecimal digits in ASCII notation (i.e., ASCII
printable characters 0-9, A-F are used to represent hexadecimal digits 0h-9h, 0ah-0fh). Each
byte is transmitted high order digit first. Each 2-byte and 4-byte parameter is transmitted high
order bytes first. Negative numbers are transmitted in 2-complement code.
To represent numbers between 0 and 1, a modulus method is used. Fractional numbers are
divided by a modulus and stored in the Powermeter as whole numbers. The modulus depends
on the number of decimal digits in the fractional part, i.e., on the value precision. The modulus is
given in the form ×0.1, ×0.01 or ×0.001. For example, the frequency value of 50.01 Hz having
the modulus of ×0.01 will be received from the instrument as the whole number of 5001. To
process the value received from the instrument in this format, the value must be multiplied by
the modulus. To write such a number to the instrument, the number must be divided by the
modulus.

6
Check sum
Arithmetic sum, calculated in a 2-byte word over fields #2, #3, #4 and #5 to produce a one-byte
check sum in the range of 22h to 7Eh (hexadecimal) as follows: [Σ(each byte - 22H)] mod 5CH
+ 22H
Trailer
Two ASCII characters CR (ASCII 13) and LF (ASCII 10).
NOTE
Fields #3 and #4 of the instrument response are always the same as those in the host request.
Table 2-1 Specific ASCII Requests
Message type Description
Char ASCII Hex
0 30h Read basic data registers
1 31h Read basic setup
2 32h Write basic setup
3 33h Read instrument status
4 34h Reset/clear functions
8 38h Reset the instrument
9 39h Read version number
? 3F Read extended status
G 47h Read pulsing setpoint (E)
g 67h Write pulsing setpoint (E)
O 4Fh Read Min/Max log
(E) - available in the PM130E
Table 2-2 Direct Read/Write ASCII Requests
Message type Description
Char ASCII Hex
A 41h Long-size direct read
a 61h Long-size direct write
X 58h Variable-size direct read
x 78h Variable-size direct write

7
3 EXCEPTION RESPONSES
The instrument will send the following error codes in the message body in response to incorrect
host requests:
XK - the instrument is in programming mode
XM -
invalid request type or illegal operation
XP - invalid data address or data value, or data is not available
NOTE
When a check or framing error is detected, the instrument will not act on or respond to the
master's request.

8
4 SPECIFIC ASCII REQUESTS
4.1 Basic Data
Table 4-1 Read Request
Message type (ASCII)
0
Message body (decimal)
Request - no body
Response
Field Offset Length Parameter Unit Range c
1 0 4 Voltage L1/L12 hV/kV d0 to Vmax
2 4 4 Voltage L2/L21
hV/kV d0 to Vmax
3 8 4 Voltage L3/L31
hV/kV d0 to Vmax
4 12 5 Current L1 A 0 to Imax
5 17 5 Current L2 A 0 to Imax
6 22 5 Current L3 A 0 to Imax
7 27 6 kW L1 (P) kW/MW
d-Pmax to Pmax
8 33 6 kW L2 (P) kW/MW
d-Pmax to Pmax
9 39 6 kW L3 (P) kW/MW
d-Pmax to Pmax
10 45 4 Power factor L1 (P) 0.01 -.99 to 1.00 f
11 49 4 Power factor L2 (P) 0.01 -.99 to 1.00 f
12 53 4 Power factor L3 (P) 0.01 -.99 to 1.00 f
13 57 6 kW total (P) kW/MW
d-Pmax to Pmax
14 63 4 Power factor total (P) 0.01 -.99 to 1.00 f
15 67 6 kWh import (E) MWh e0 to 99999.
16 73 5 Neutral (unbalanced) current A 0 to Imax
17 78 4 Frequency 0.1 Hz 45.0 to 65.0
18 82 6 kvar L1 (P) kvar/Mvard-Pmax to Pmax
19 88 6 kvar L2 (P) kvar/Mvard-Pmax to Pmax
20 94 6 kvar L3 (P) kvar/Mvard-Pmax to Pmax
21 100 6 kVA L1 (P) kVA/MVA
d0 to Pmax
22 106 6 kVA L2 (P) kVA/MVA
d0 to Pmax
23 112 6 kVA L3 (P) kVA/MVA
d0 to Pmax
24 118 6 kvarh net (E) Mvarh
e-9999. to 99999.
25 124 6 kvar total (E) kvar/Mvar d-Pmax to Pmax
26 130 6 kVA total (E) kVA/MVA d0 to Pmax
27 136 6 Maximum sliding window kW demand g(E) kW/MW d0 to Pmax
28 142 6 Accumulated kW demand (E) kW/MW d0 to Pmax
29 148 5 Maximum ampere demand L1 A 0 to Imax
30 153 5 Maximum ampere demand L2 A 0 to Imax
31 158 5 Maximum ampere demand L3 A 0 to Imax
32 163 2 Reserved 0
33 165 6 kWh export (E) MWh e0 to 99999.
34 171 6 Maximum sliding window kVA demandg(E) kVA/MVA d0 to Pmax
35 177 4 Reserved
36 181 4 Reserved
37 185 4 Reserved
38 189 4 Reserved
39 193 4 Reserved
40 197 4 Reserved
41 201 8 kVAh (E) MVAh
e0 to 99999.99
42 209 6 Present sliding window kW demand g(E) kW/MW d0 to Pmax
43 215 6 Present sliding window kVA demand g(E) kVA/MVA d0 to Pmax
44 221 4 PF at maximum KVA demand (E) 0.01 0 to 1.00
45 225 4 Reserved
46 229 4 Reserved

9
47 233 4 Reserved
Fields indicated by an N/A mark are padded with ASCII zeros.
cThe parameter limits are as follows:
Vmax (690 V input option) = 828V @ PT Ratio = 1
Vmax (690 V input option) = 144 ×PT Ratio [V] @ PT Ratio > 1
Vmax (120 V input option) =144 ×PT Ratio [V]
Imax (50% over-range) = 1.5 ×CT primary current [A]
Pmax = (Imax ×Vmax ×3)/1000 [kW] if wiring mode is 4LN3 or 3LN3
Pmax = (Imax ×Vmax ×2)/1000 [kW] if wiring mode is 4LL3, 3OP2, 3DIR2, 3OP3 or 3LL3
dWhen the value width is greater than the field resolution, the reading is converted to higher units and
transmitted with a decimal point. The right-most digits of the reading are truncated.
eEnergy readings are transmitted in MWh, Mvarh and MVAh units with a decimal point. If the energy
value exceeds the field resolution, the right-most digits are truncated. The energy roll value is user
selectable (see Section 5.4).
fFor negative power factor, the minus sign is transmitted before a decimal point as shown in the table.
gTo get block interval demand readings, set the number of demand periods equal to 1 (see Table 4-4).
hWhen the 4LN3 or 3LN3 wiring mode is selected, the voltages will be line-to-neutral; for any other
wiring mode, they will be line-to-line voltages.
(P) available in the PM130P and PM130E
(E) available in the PM130E
4.2 Basic Setup
Table 4-2 Read Request
Message type (ASCII)
1
Message body (decimal)
Request
Field Offset Length Parameter Range
1 0 3 Parameter identifier see Table 4-4
Response
Field Offset Length Parameter Range
1 0 3 Parameter identifier see Table 4-4
2 3 4 Not used permanently set to 00.0
3 7 6 Parameter value see Table 4-4
Table 4-3 Write Request
Message type (ASCII)
2
Message body (decimal)
Request/Response
Field Offset Length Parameter Range
1 0 3 Parameter identifier see Table 4-4
2 3 4 Not used set to 00.0
3 7 6 Parameter value see Table 4-4
Table 4-4 Basic Setup Parameters
Parameter Identifier Range
Wiring mode c W40 0 = 3OP2, 1 = 4LN3, 2 = 3DIR2,
3 = 4LL3, 4 = 3OP3, 5 = 3LN3,
6 = 3LL3
PT ratio U14 1.0 to 6500.0