Modbus Implementation in APC Smart-UPS v12
Modbus Implementation in APC Smart-UPS v12
PROJECT AT A GLANCE
Project Type
Control, monitor and configure one or
multiple Smart-UPS devices through a
custom application making use of standard
Modbus communications to collect and
deliver data from the UPS management
system.
Products Supported
Most APC Smart-UPS in the SMT family
and all models in the SRT family are
supported. SMT rack mount 1U models
are not supported and only SMT models
running firmware greater than UPS 09.0
are supported. SMT models with UPS 08.0
or higher may be updated. See Knowledge Modbus implementation in SMART-UPS
Base article FA164737 on APC.com for
information on firmware updates. Modbus is a serial communications protocol, managed and made publicly
available by the Modbus Organization (www.modbus.org.). While it was
Additional Equipment Required developed for, and is heavily used in, industrial control environments, it is
No additional hardware is required for a well defined protocol suitable for machine to machine communications.
RS-232 Modbus communications. A wide variety of readily available software and hardware devices exist
If RS-485 is required an adaptor may be today that support communications via Modbus.
used. Review the Knowledge Base article
Schneider Electric’s APC Smart-UPS implement the Modbus protocol to
FA156062 in APC.com for
provide access to controls and configuration parameters through user-
recommendations.
defined applications. The data available via Modbus is the same data
accessible through APC's software products.
Recommended References
Modbus Application Protocol Specification This document outlines Modbus communications over the range of
V1.1b3 – Modbus Organization, 2012 transport layers, as well as where the implementation deviates from the
MODBUS specifications. The standard definition of the Modbus protocol
can be obtained, royalty-free, from www.modbus.org.
Modbus over serial line specification and
implementation guide V1.02 – Modbus
Organization, 2006
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Table of Contents
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
3.2.2 Not Applicable Register..............................................................................7
3.3 Writing a Modbus Register.................................................................................7
4 Modbus RTU............................................................................................................ 8
4.1 MODBUS DEVICE ADDRESS...................................................................................8
4.2 UNSUPPORTED FEATURES....................................................................................8
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
4.2.1 ASCII Transmission Mode..........................................................................8
4.2.2 Modbus Message RTU Framing.................................................................8
4.3 Modbus RTU- RS232 Serial...............................................................................8
4.4 Modbus RTU- USB............................................................................................. 9
4.4.1 Overview.................................................................................................... 9
4.4.2 USB Host Drivers.......................................................................................9
4.4.3 USB HID Usages........................................................................................ 9
4.4.4 Framing...................................................................................................... 9
5 Modbus Register Organization.............................................................................10
5.1 Status Data (0x0000 – 0x0007F)......................................................................10
5.2 Dynamic Data (0x0080 – 0x01FF)....................................................................10
5.3 Inventory Information (0x0200 – 0x03FF).........................................................10
5.4 Static Data (0x0400 – 0x5FF)...........................................................................10
5.5 Commands (0x0600 – 0x6FF)..........................................................................11
5.6 Protocol Verification (0x0800 – 0x8FF)............................................................11
6 Enabling Modbus on Smart-UPS..........................................................................11
6.1 Model compatibility...........................................................................................11
6.2 Firmware Update.............................................................................................. 11
6.3 Enabling Modbus Communications..................................................................11
Appendix A – Register List............................................................................................ 12
Appendix B – Register Bit Descriptions.......................................................................20
UPSStatus_BF........................................................................................................ 20
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
SimpleSignalingStatus_BF......................................................................................20
GeneralError_BF..................................................................................................... 21
PowerSystemError_BF............................................................................................21
BatterySystemError_BF...........................................................................................21
ReplaceBatteryTestStatus_BF................................................................................22
RunTimeCalibrationStatus_BF................................................................................22
LifeTimeStatus_BF.................................................................................................. 23
UserInterfaceStatus_BF.......................................................................................... 23
Input.InputStatus_BF............................................................................................... 24
VoltageACSetting_BF..............................................................................................24
AcceptableFrequencySetting_BF............................................................................24
UPSCommand_BF.................................................................................................. 25
SimpleSignalingCommand_BF................................................................................25
Register: UPSStatus_BF......................................................................................... 25
RunTimeCalibrationCommand_BF..........................................................................25
UserInterfaceCommand_BF....................................................................................25
OutletStatus_BF...................................................................................................... 26
OutletCommand_BF................................................................................................27
I_SOGRelayConfigSetting_BF................................................................................28
Appendix C – Enumeration Descriptions.....................................................................29
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
All data is always conveyed in MSB first Point Number
(big-endian) method unless otherwise The following sections show how to
specified. convert a number from floating point to a
BPI and back. For the example we will
use the value of -56.8, and convert it to a
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
1.2.1 Bitfield Data Type
BPI of size 2 with a BPL of 5.
A bitfield data type is one that is designed to
store binary states of related or unrelated data
items. It is used to compress the data 1.2.3.2 Converting from Floating Point
representation to multiples of bytes. Bitfields Number to Binary-Point-Integer
may have bits that are defined as being
mutually exclusive so that only one bit can be Multiply the number by 2bpl by the
set at a time. Bitfields are defined in units of 8 absolute value
bit bytes up to 8 bytes so that states can be o N*2bpl 56.8 * 25 =
written in one bitfield, valid size for bitfields are
8, 16, 32 and 64 bits. 1816.96
Add a ½ to round the number.
An example bitfield could be the presence of
modules on a device. For a device that has a Remember this is a lossy some
maximum of 6 modules, the bitmask might be precision will be lost.
0x3F. If the value reported by the Modbus o 1817.6 +0.5 = 1818.1
slave is 0x10 then the 4th module is present, if
the value reported is 0x11 then the 0th and 4th Discard the decimal remainder
module are present. A value of 0x80 would you are now left with an integer
be invalid since it is outside of the bit mask. value
o 1818
1.2.2 Enumeration Data Type
Do the two’s complement ( Only
This data type is an integer that represents a
value out of a set of possibilities for a particular
if it is a negative number we are
property of a device. converting)
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
o 1818 becomes -> 63718 1.3 Mapping of Data Types into
or in hex F8E6 <- this is Modbus Registers
the BPI with BPL 5 (float APC’s UPS implementation of Modbus
= -56.8) memory map will only use register (16-bit
integer). Since usage data is not
1.2.3.3 Converting from Binary-Point-Integer restricted to 16-bit registers, the following
sections describe how the usage data is
to Floating Point Number mapped into Modbus registers.
We will take the number F8E6 and covert Mapping of numeric data (BPI,
it from BPI size 2, BPL 5 back to a Enumerations) is as follows:
floating point number
Do the twos complement (only if 1.3.1 Numbers
the data type is defined as
signed and the most significant 1.3.1.1 Octet / Bytes (8 bits)
bit is 1 The upper 8 bits will be set to 0, the lower 8 bits
o F8E6 becomes -> 71A will receive the data, and the resultant number
which is 1818 in decimal will be stored as a 16-bit number
10
Divide by 2bpl 1.3.1.2 16 bit Words
o 1818/25 = 56.815 The number will be stored as a 16-bit number.
16 bit words are transmitted according to
Because the original number Modbus spec MSB first (Big-Endian).
was negative. We know this
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
because the most significant bit 1.3.1.3 Odd Number of Octets (24 bits, 40
in the Binary point integer was 1, bits, etc)
we negate the number to get the This data size is not allowed, so there will be no
original value. mapping required.
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
o -56.815
1.3.1.4 Long, and Long Long (32 and 64 bit
This number now needs to be numbers)
rounded to the correct number of This data will be stored in 16-bit chunks
decimal places. In the Master data crossing multiple Modbus registers. The MSW
dictionary definition of the data type (highest 16-bits will be stored in the lowest
the number of decimal places is Modbus register number) followed in sequential
Modbus registers.
specified. For a data type of this
nature a value 1 would be
appropriate 1.3.1.5 Unusual sized numbers (48 bits, and
>64 bits)
1.2.4 String Data Type This data size is not allowed, so there will be no
mapping required.
A string data type is an array of single
byte characters. The range of valid
characters is defined as US-ASCII only 1.3.1.6 Signed Numbers
(0x20 - 0x7E). Strings do not have null Signed numbers use twos compliment
termination characters at the end. encoding.
Whenever a string is written, the entire
string has to be written (no partial string 1.3.1.7 Scaling of Numbers
writes are allowed). Padding for unused Modbus registers are inherently integers.
characters within a string should use Scaling is done with base 2 multipliers in the
spaces (0x20). same format as usage BPI’s.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
2 Transport Layers of Communication
The Modbus protocol will be available on a 2.2 USB CONNECTION
various physical layers. The layers are largely
USB v2.0 Full Speed is implemented via Human
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
independent; however they use a common core
of the Modbus design. Different products that Interface Device (HID) usages. Set and Get
use the Modbus protocol will only need to Feature are implemented as well as
implement the physical layers that are relevant asynchronous via Interrupt. Support for USB
to that product. v3.0 is not available at this time. This physical
layer implementation will use the Modbus RTU
packets but will have some minor changes to
2.1 SERIAL CONNECTION support USB. See Section Modbus RTU.
The Serial interface uses RS-232 and is
configured to 9600 BPS, No Parity, 8 Data bits,
1 Stop Bit. This physical layer will use Modbus
RTU. See Section Modbus RTU.
3 Modbus Implementation
This implementation is based on the 3.1 Register Blocks
Modbus Application specification, which In this implementation, registers can be
can be found at: combined into logical blocks for single data
items that are larger than 16 bits.
http://www.modbus.org/docs/
Modbus_Application_Protocol_V1_1b.pdf
3.1.1 Register Block Reads
The following items in this section are Reading blocks of registers is accepted as long
as the combination of address and quantity of
areas of non-compliance or extensions to registers to read does not split a register block.
the above specification.
Example: Assume the following register blocks:
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
0 0 4
1 4 2
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
Address Quantity of Registers Response
1 or 2 or 3 X Exception, Illegal Data Address
0 1 or 2 or 3 Exception, Illegal Data Address
0 5 Exception, Illegal Data Address
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
0 4 Write Accepted to Register Block 0
0 6 Exception, Illegal Data Address
4 1 Exception, Illegal Data Address
4 2 Write Accepted to Register Block 1
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
most common reason that a write will not work When writing a command to verify that the
is that the value written was illegal. command has worked properly a read of the
associated status register should be done to
When writing a usage that spans Modbus determine the status of the command.
registers (one that is more than 2 bytes in
length and must be written with Modbus For example when writing a
function code 0x16), the application should do a ReplaceBatteryCommand, the
read using function code 0x4 to verify if the ReplaceBatteryStatus should be read to
write has functioned properly. determine the result of the command.
4 Modbus RTU
Modbus RTU specification is based on the 4.2 UNSUPPORTED FEATURES
Modbus over Serial Line Specification and APC devices will not support the following
Implementation guide v1.02. This features that are called out in the
document is available on the specification.
www.modbus.org web site, at:
http://www.modbus.org/docs/Modbus_over
4.2.1 ASCII Transmission Mode
_serial_line_V1_02.pdf
The following sections describe the This is an optional feature and is not
implemented.
implementation details which differ from the
specification.
4.2.2 Modbus Message RTU Framing
4.1 MODBUS DEVICE ADDRESS Reference 2.5.1.1 of specification. Modbus
framing of packet requirements are unusual
The slave address of the APC device will since there is no start of character. For 9600
default to 1 unless changed via some other (No Parity) the following idle time before a
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
mechanism. Likely mechanisms for changing packet is required:
the address will be the local display. The
address of a device if configurable will be 1 Character = 1.04ms, 3.5 Character = 3.64ms
from 1-223. Addresses 224-247 are and 4.5 Character = 4.6875ms
prohibited as they are reserved for internal
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
use.
The specification calls out an inter-character
timing of maximum of 1.5 characters = 1.56ms
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
parity which differs from the specification. Even slight departure from the Implementation Class
parity may not be supported. support defined in the Modbus over serial line
specification and implementation guide V1.02.
Default baud rate is 9600, with 8 data bits, no
parity bit, one stop bit, no flow control. This is a
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
Mode RTU only RTU RTU
Electrical RS232 only RS485 2W-cabling RS485 2W-cabling
Interface or RS232
Connector RJ 50 (10P10C) RJ 45 ( recommended ) -
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
4.4 Modbus RTU- USB 4.4.2 USB Host Drivers
On Windows and Linux operating systems, a
4.4.1 Overview system driver is attached to the UPS device
upon enumeration (when the device is
APC Smart-UPS devices enumerate as HID
connected to the host computer for the first
Power Devices. See the following documents
time). In order to communicate via interrupt
for background information on USB HID Class
transfers, the default operating system driver
and USB HID Class Power Devices:
must be replaced with an alternative driver.
www.usb.org/developers/devclass_docs/
HID1_11.pdf 4.4.3 USB HID Usages
www.usb.org/developers/devclass_docs/
pdcv10.pdf
The following USB HID usages are used in
Modbus RTU-USB communication is done via Modbus-RTU-USB:
Interrupt Transfers, on Endpoint 1 of the APC
device, through vendor-specific usages.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
If the data payload is longer than 61 bytes, the following interrupt transfers will contain the remainder
of the message, broken into 63-byte fragments:
USB HID
Data
Report ID
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
1 byte 0 up to 63 byte(s)
A maximum of 5 interrupt transfers may be required to transmit the entire Modbus RTU message.
USB HID
Data
Report ID
1 byte 0 up to 63 byte(s)
USB HID
Data
Report ID
1 byte 0 up to 63 byte(s)
USB HID
Data Unused
Report ID
1 byte 0 up to 2 byte(s)
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
following section describes the regions of the Manufacturing Date. User Configuration
Modbus register map. strings will be in this region as well.
5.1 Status Data (0x0000 – 0x0007F) 5.4 Static Data (0x0400 – 0x5FF)
Status and Alarm Registers. The static data consists of string
information, and configuration data that
5.2 Dynamic Data (0x0080 – does not change frequently.
0x01FF)
The dynamic data consists of information 5.5 Commands (0x0600 – 0x6FF)
that changes during the operation and Write only commands that affect
consists of measurement information. operation..
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
Most Smart-UPS in the SMT and SRT families (http://www.apc.com/site/support/index.cf
will be able to use the new Modbus m/faq/ )
functionality, with exception of the SMT Rack
Mount 1U models. Please visit APC.com to
view the SMT models currently available. 6.3 Enabling Modbus
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
Communications
6.2 Firmware Update
All APC Smart-UPS that support the
UPS Firmware support for Modbus is not
Modbus communication interface ship with
available for all Smart-UPS models.
this feature disabled. To enable the
The following Smart-UPS models have Modbus Modbus communication functionality, in the
support: front control console of the UPS, go to
SMT models with firmware UPS9.0 or Advanced Menu mode, under
higher Configuration and enable Modbus.
SMX models with firmware UPS10.0 or
higher
All versions of SRT models
To find your current Firmware level, from the
main menu of the LCD screen select "About"
and scroll down to "UPS Firmware".
You may also run the Firmware Update Wizard
and it will identify the version before performing
the update. The Wizard can be found in the
article referenced below.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Size Bin
Register Register Name Customer Description
(bytes) pt
0 4 UPSStatus_BF The purpose of this register
is to convey the mode of
operation of the UPS at
macro level. Anytime the
value of this usage changes
the
UPSStatusChangeCause_E
N usage will change as well.
This usage is NOT intended
to be a direct mapping to the
internal UPS state machine.
See bit descriptions in
Appendix B
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
2 2 UPSStatusChangeCause_E See bit descriptions in
N Appendix B
3 4 MOG.OutletStatus_BF See bit descriptions in
Appendix B
6 4 SOG[0].OutletStatus_BF See bit descriptions in
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
Appendix B
9 4 SOG[1].OutletStatus_BF See bit descriptions in
Appendix B
12 4 SOG[2].OutletStatus_BF See bit descriptions in
Appendix B
15 4 SOG[3].OutletStatus_BF See bit descriptions in
Appendix B
18 2 SimpleSignalingStatus_BF See bit descriptions in
Appendix B
19 2 GeneralError_BF See bit descriptions in
Appendix B
20 4 PowerSystemError_BF See bit descriptions in
Appendix B
22 2 BatterySystemError_BF See bit descriptions in
Appendix B
23 2 ReplaceBatteryTestStatus_ See bit descriptions in
BF Appendix B
24 2 RunTimeCalibrationStatus_ See bit descriptions in
BF Appendix B
25 2 Battery.LifeTimeStatus_BF See bit descriptions in
Appendix B
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Size Bin
Register Register Name Customer Description
(bytes) pt
26 2 UserInterfaceStatus_BF See bit descriptions in
Appendix B
128 4 RunTimeRemaining The number of seconds until U0
power will go out when
running on battery. This
should never be compared
as an actual value, but
should be compared as LTE.
130 2 StateOfCharge_Pct This represents the % state U9
of charge in the battery.
(known as Battery Capacity
in UPS-link).
131 2 Battery.Positive.VoltageDC This is the measured DC S5
voltage. (Positive Half if there
are 2 parts)
133 2 Battery.Date This is the number of days U0
since 1999 (0=1-jan-2000).
This is the theoretical battery
replacement date, it should
not be interpreted to be more
accurate than a month.
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
135 2 Battery.Temperature This is the temperature in S7
Degrees C.
136 2 Output[0].RealPower_Pct Phase 1 - Measured real U8
power as a percent of full
rating.
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
138 2 Output[0].ApparentPower_P Phase 1 - Measured U8
ct apparent power as a percent
of full rating. Never be
implemented with
ApparentPower usage.
140 2 Output[0].CurrentAC Phase 1 - This is the U5
measured AC RMS Current.
142 2 Output[0].VoltageAC Phase 1 - This is the U6
measured Output Voltage
144 2 Output.Frequency This is the measured AC U7
frequency on the output.
145 4 Output.Energy This is the number of Watt U0
Hours consumed
150 2 Input.InputStatus_BF See bit descriptions in
Appendix B
151 2 Input[0].VoltageAC Phase 1 - This is the U6
measured Input Voltage
(0xFFFF if not applicable)
154 2 Input.Efficiency_EN Efficiency is defined as S0
RealPowerOut /
RealPowerIn. Apparent
Power (VA) measurements
should not be used.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Size Bin
Register Register Name Customer Description
(bytes) pt
155 2 MOG.TurnOffCountdown_E Time remaining till output off S0
N -1-NotActive -no countdown
in progress.
0-CountdownExpired-
Countdown has ended.
(1)-(32767)-Seconds
remaining for countdown.
156 2 MOG.TurnOnCountdown_E Time remaining till output on- S0
N 1-NotActive - no countdown
in progress.0-
CountdownExpired-
Countdown has ended.(1)-
(32767)-Seconds remaining
for countdown.
157 4 MOG.StayOffCountdown_E Minimum time to remain off S0
N after a shutdown.
-1-NotActive-No countdown
in progress.
0-CountdownExpired-
Countdown has ended.
(1)-(2147483647)-Seconds
remaining for countdown.
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
159 2 SOG[0].TurnOffCountdown Time remaining till output off S0
_EN SOG 0
-1-NotActive_Cancel-
Reading: no countdown in
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
progress.
0-CountdownExpired-
Countdown has ended.
(1)-(32767)-Seconds
remaining for countdown.
160 2 SOG[0].TurnOnCountdown Time remaining till output on S0
_EN SOG 0
-1-NotActive_Cancel-
Reading: no countdown in
progress.
0-CountdownExpired-
Countdown has ended.
(1)-(32767)-Seconds
remaining for countdown.
161 4 SOG[0].StayOffCountdown_ Minimum time to remain off S0
EN after a shutdown. SOG 0
-1-NotActive-No countdown
in progress.
0-CountdownExpired-
Countdown has ended.
(1)-(2147483647)-Seconds
remaining for countdown.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Size Bin
Register Register Name Customer Description
(bytes) pt
163 2 SOG[1].TurnOffCountdown Time remaining till output off S0
_EN SOG 1
-1-NotActive_Cancel-
Reading: no countdown in
progress.
0-CountdownExpired-
Countdown has ended.
(1)-(32767)-Seconds
remaining for countdown.
164 2 SOG[1].TurnOnCountdown Time remaining till output on S0
_EN SOG 1
-1-NotActive_Cancel-
Reading: no countdown in
progress.
0-CountdownExpired-
Countdown has ended.
(1)-(32767)-Seconds
remaining for countdown.
165 4 SOG[1].StayOffCountdown_ Minimum time to remain off S0
EN after a shutdown. SOG 1
-1-NotActive-No countdown
in progress.
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
0-CountdownExpired-
Countdown has ended.
(1)-(2147483647)-Seconds
remaining for countdown.
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
167 2 SOG[2].TurnOffCountdown Time remaining till output off
_EN SOG 2
-1-NotActive_Cancel-
Reading: no countdown in
progress.
0-CountdownExpired-
Countdown has ended.
(1)-(32767)-Seconds
remaining for countdown.
168 2 SOG[2].TurnOnCountdown Time remaining till output on
_EN SOG 2
-1-NotActive_Cancel-
Reading: no countdown in
progress.
0-CountdownExpired-
Countdown has ended.
(1)-(32767)-Seconds
remaining for countdown.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Size Bin
Register Register Name Customer Description
(bytes) pt
169 4 SOG[2].StayOffCountdown_ Minimum time to remain off
EN after a shutdown. SOG 2
-1-NotActive-No countdown
in progress.
0-CountdownExpired-
Countdown has ended.
(1)-(2147483647)-Seconds
remaining for countdown.
171 2 SOG[3].TurnOffCountdown Time remaining till output off
_EN SOG 3
-1-NotActive_Cancel-
Reading: no countdown in
progress.
0-CountdownExpired-
Countdown has ended.
(1)-(32767)-Seconds
remaining for countdown.
172 2 SOG[3].TurnOnCountdown Time remaining till output on
_EN SOG 3
-1-NotActive_Cancel-
Reading: no countdown in
progress.
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
0-CountdownExpired-
Countdown has ended.
(1)-(32767)-Seconds
remaining for countdown.
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
173 4 SOG[3].StayOffCountdown_ Minimum time to remain off
EN after a shutdown. SOG 3
-1-NotActive-No countdown
in progress.
0-CountdownExpired-
Countdown has ended.
(1)-(2147483647)-Seconds
remaining for countdown.
516 16 FWVersion_STR UPS Firmware Version
532 32 Model_STR Model Name
548 32 SKU_STR SKU Name
564 16 SerialNumber_STR Serial Number
572 16 Battery.SKU_STR The replacemant Battery
Pack for the internal battery
pack (or the system if there is
only one type)
580 16 Battery.ExternalBattery.SK The replacemant Battery
U_STR Pack for the external battery
pack (or the system if there is
only one type)
588 2 Output.ApparentPowerRatin The rated apprent full power. U0
g
589 2 Output.RealPowerRating The rated real full power. U0
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Size Bin
Register Register Name Customer Description
(bytes) pt
590 2 I_SOGRelayConfigSetting_ See bit descriptions in
BF Appendix B
591 2 Date Manufcture Date - This is the U0
number of days since 1999
(0=1-jan-2000).
592 2 Output.VoltageACSetting_B See bit descriptions in
F Appendix B
595 2 Battery.DateSetting Battery Installation Date,
Days since 1999 (1/1/00 = 0)
596 16 Name_STR The name assigned to the
UPS.
1029 2 MOGTurnOffCountdownSet Seconds of delay to use for a S0
ting_EN off. This value will be loaded
into the
TurnOffCountdown_EN when
a delayed off command is
requested.
1030 2 MOGTurnOnCountdownSet Seconds of delay to use for a S0
ting_EN on. This value will be loaded
into the
TurnOnCountdown_EN when
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
a delayed on command is
requested.
1031 4 MOGStayOffCountdownSett Seconds to keep an output S0
ing_4B off before starting it again.
Typically minimum value of
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
4, maximum of 300.
1034 2 SOG[0]TurnOffCountdownS Seconds of delay to use for a S0
etting_EN off. This value will be loaded
into the
TurnOffCountdown_EN when
a delayed off command is
requested.
1035 2 SOG[0]TurnOnCountdownS Seconds of delay to use for a S0
etting_EN on. This value will be loaded
into the
TurnOnCountdown_EN when
a delayed on command is
requested.
1036 4 SOG[0]StayOffCountdownS Seconds to keep an output S0
etting_4B off before starting it again.
Typically minimum value of
4, maximum of 300.
1039 2 SOG[1]TurnOffCountdownS Seconds of delay to use for a S0
etting_EN off. This value will be loaded
into the
TurnOffCountdown_EN when
a delayed off command is
requested.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Size Bin
Register Register Name Customer Description
(bytes) pt
1040 2 SOG[1]TurnOnCountdownS Seconds of delay to use for a S0
etting_EN on. This value will be loaded
into the
TurnOnCountdown_EN when
a delayed on command is
requested.
1041 4 SOG[1]StayOffCountdownS Seconds to keep an output S0
etting_4B off before starting it again.
Typically minimum value of
4, maximum of 300.
1044 2 SOG[2]TurnOffCountdownS Seconds of delay to use for a S0
etting_EN off. This value will be loaded
into the
TurnOffCountdown_EN when
a delayed off command is
requested.
1045 2 SOG[2]TurnOnCountdownS Seconds of delay to use for a S0
etting_EN on. This value will be loaded
into the
TurnOnCountdown_EN when
a delayed on command is
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
requested.
1046 4 SOG[2]StayOffCountdownS Seconds to keep an output S0
etting_4B off before starting it again.
Typically minimum value of
4, maximum of 300.
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
1049 2 SOG[3]TurnOffCountdownS Seconds of delay to use for a S0
etting_EN off. This value will be loaded
into the
TurnOffCountdown_EN when
a delayed off command is
requested.
1050 2 SOG[3]TurnOnCountdownS Seconds of delay to use for a S0
etting_EN on. This value will be loaded
into the
TurnOnCountdown_EN when
a delayed on command is
requested.
1051 4 SOG[3]StayOffCountdownS Seconds to keep an output S0
etting_4B off before starting it again.
Typically minimum value of
4, maximum of 300.
1536 4 UPSCommand_BF See bit descriptions in
Appendix B
1538 4 OutletCommand_BF See bit descriptions in
Appendix B
1540 2 SimpleSignalingCommand_ See bit descriptions in
BF Appendix B
1541 2 ReplaceBatteryTestComma See bit descriptions in
nd_BF Appendix B
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Size Bin
Register Register Name Customer Description
(bytes) pt
1542 2 RunTimeCalibrationComma See bit descriptions in
nd_BF Appendix B
1543 2 UserInterfaceCommand_BF See bit descriptions in
Appendix B
2048 4 ModbusMapID Reports the Modbus map ID ST
as a string, no null RIN
terminator. G
2050 8 TestString Always Reports "12345678" - ST
included to debug end RIN
customer protocol byte order. G
2054 4 Test4BNumber1 Always Reports 0x12345678 U0
- included to debug end
customer protocol byte order.
2056 4 Test4BNumber2 Always Reports 0x-5 - S0
included to debug end
customer protocol byte order.
2058 2 Test2BNumber1 Always Reports 0x1234 - U0
included to debug end
customer protocol byte order.
2059 2 Test2BNumber2 Always Reports 0x-5 - S0
included to debug end
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
customer protocol byte order.
2060 2 TestBPINumber1 Always Reports 128.5 - S6
included to debug end
customer protocol byte order.
2061 2 TestBPINumber2 Always Reports -128.5 - S6
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
included to debug end
customer protocol byte order.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
UPSStatus_BF
Bit Index Description
0 Reserved
1 StateOnline-State - Indicating that the power for the output is being sourced
from the input. Mutually exclusive with other state bits.
2 StateOnBattery-State - Indicating that the power for the output is being
sourced from the battery. Mutually exclusive with other state bits.
3 Reserved
4 StateOutputOff-State - Indicates that the output is not powered through the
UPS (Including any internal bypass paths). Some examples are: Off
because of Fault or Low-Battery. Mutually exclusive with other state bits.
5 Fault-Modifier - Indicates that a fault of any severity (Warning, or Critical) is
present in the system, which may have caused a transition.
6 6-InputBad-Modifier - Indicates that the input is not acceptable.
7 Test-Modifier - Indicates that a test is in progress.
8 PendingOutputOn-Modifier - Indicates that the state is pending output on
(either on line, on battery, or bypass). Should only be set in combination
with StateOutputOff.
9 PendingOutputOff-Modifier - Indicates that the state is pending output off.
Master sets this whenever the ups is in process of turning off, or
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
immediately when on battery for input bad. Will never be set in combination
with StateOutputOff. When set the slave should monitor
RunTimeRemaining. When / if run time is less than or equal to the slave's
minimum run time threshold, the slave should start the shutdown process.
This bit may also be set in conditions other than above, e.g., in bypass due
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
to fault.
10 Reserved
11 Reserved
12 Reserved
13 HighEfficiency-Modifier - Indicates that the UPS is operating in a high
efficiency mode (eg. green mode, Economy Mode, ECO Mode).
14 InformationalAlert-Modifier - Indicates that the UPS has an informational
alert active. (eg. Lifetime Status near end).
15 Reserved
SimpleSignalingStatus_BF
Bit Index Description
0
0-PowerFailure-Indicates that the input power has failed. Signal will be
driven with output on or off. Complement of InputStatus.Acceptable.
1 ShutdownImminent-
Indicates that the UPS is committed to disconnecting power from its
output(s). The bit is set when UPSStatus_BF.PendingOutputOff is set AND
RunTimeRemaining is less than or equal to LowRunTimeWarningSetting
OR any of the following depending upon the UPS configuration.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Bit Index Description
* For UPS with no unswitched outlet group and with switched outlet
group(s) - when the "last commanded"
UPSSystem.SwitchedOutletGroup[x].TurnOffCountdown_EN is greater than
-1.
* For UPS with no unswitched outlet group and with no switched outlet
groups - when the UPSSystem.OutputSystem.TurnOffCountdown_EN is
greater than -1.
In response to this bit becoming set, the device using the simple signaling
interface should drive request to shutdown if it hasn't already done so (this
ensures that TurnOffCountdown_EN timer will be set to at least the
minimum time needed by the simple signaling host).
GeneralError_BF
Bit Index Description
0 SiteWiring-A site wiring fault exists.
1 EEPROM-A eeprom fault exists.
2 ADConverter-An A/D converter fault exists.
3 LogicPowerSupply-A logic power supply fault exists.
4 InternalCommunication-A fault in the processor communication system.
5 UIButton-One (or more) of the Front Panel Buttons is not working properly.
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
6 Reserved
7 EPOActive-There is an active or unacknowledged Emergency Power Off
signal.
8 Reserved
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
PowerSystemError_BF
Bit Index Description
0 OutputOverload-The output is overloaded (either real or apparent power).
1 OutputShortCircuit-The output is short circuited. [Put here for SU5G ease
of implementation.]
2 OutputOvervoltage-The output voltage is too high.
3 Reserved
4 Overtemperature-Indicates that a component's temperature is too high.
5 BackfeedRelay-The backfeed relay (or its driver) has a fault.
6 AVRRelay-An AVR relay (or its driver) has a fault.
7 PFCInputRelay-A PFC input relay (or its driver) has a fault.
8 OutputRelay-An output relay (or its driver) has a fault.
9 BypassRelay-A bypass relay (or its driver) has a fault.
10 Reserved
11 PFC-A PFC fault exists.
12 DCBusOvervoltage-A DC bus voltage is too high.
13 Inverter-An inverter fault exists.
14 Reserved
BatterySystemError_BF
Bit Index Description
0 Disconnected-Indicates that the battery is electrically disconnected
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Bit Index Description
(missing).
1 Overvoltage-Indicates that the battery voltage is too high.
2 NeedsReplacement-Indicates that the battery is at the end of its service life.
3 OvertemperatureCritical-Indicates that the battery temperature has
exceeded a critical level. (Exclusive with OvertemperatureWarning)
4 Charger-A battery charger fault exists
5 TemperatureSensor-A battery temperature sensor fault exists.
6 BusSoftStart-A battery bus soft start fault exists.
7 Reserved
8 Reserved
9 Reserved
10 Reserved
11 Reserved
ReplaceBatteryTestStatus_BF
Bit Index Description
0 Pending-Replace battery test is pending (high level acknowledgement of
command).
1 InProgress-Replace battery test is in progress.
2 Passed-Replace battery test passed (completed successfully).
3 Failed-Replace battery test failed (completed unsuccessfully).
4 Refused-Replace battery test was refused (check "result modifier" bits for
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
potentially additional details). Note: should not change source modifier
when refusing a test as the refusal is always internal and the origin of the
test would be lost any time the test is refused.
5 Aborted-Replace battery test was aborted (check "result modifier" and
"source modifier" bits for potentially additional details).
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
6 Protocol-Source modifier: the protocol is the origin for initiation or abortion
of the replace battery test.
7 LocalUI-Source modifier: the local user interface is the origin for initiation or
abortion of the replace battery test. Includes local terminal mode interface if
applicable.
8 Internal-Source modifier: internal control is the origin for initiation or
abortion of the replace battery test.
9 InvalidState-Result modifier: invalid UPS operating state (e.g., shutdown
pending, output off, ups in bypass, input voltage not acceptable).
10 InternalFault-Result modifier: an internal fault exists (e.g., battery is
missing, inverter failure). Also, overload in progress which is not in the
error usages.
11 StateOfChargeNotAcceptable-Result modifier: the battery state of charge is
not acceptable.
RunTimeCalibrationStatus_BF
Bit Index Description
0 Pending-Run time calibration is pending (high level acknowledgement of
command).
1 InProgress-Run time calibration is in progress.
2 Passed-Run time calibration passed (completed successfully).
3 Failed-Run time calibration failed (completed unsuccessfully).
4 Refused-Run time calibration was refused (check "result modifier" bits for
potentially additional details). Note: should not change source modifier
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Bit Index Description
when refusing a test as the refusal is always internal and the origin of the
test would be lost any time the test is refused.
5 Aborted-Run time calibration was aborted (check "result modifier" and
"source modifier" bits for potentially additional details).
6 Protocol-Source modifier: the protocol is the origin for initiation or abortion
of the run time calibration.
7 LocalUI-Source modifier: the local user interface is the origin for initiation or
abortion of the run time calibration. Includes local terminal mode interface if
applicable.
8 Internal-Source modifier: internal control is the origin for initiation or
abortion of the run time calibration. Note: Internal should be reported if
there is a "scheduled" internal test eg. every 3 months. Internal should also
be used when a "natural" test completes successfully.
9 InvalidState-Result modifier: invalid UPS operating state (e.g., shutdown
pending, output off, ups in bypass, input voltage not acceptable).
10 InternalFault-Result modifier: an internal fault exists (e.g., battery is
missing, inverter failure). Also, overload in progress which is not in the
error usages.
11 StateOfChargeNotAcceptable-Result modifier: the battery state of charge is
not acceptable.
12 LoadChange-Result modifier: the load changed. (previous version has this
incorrectly as bit 13 with no bit 12).
13 ACInputNotAcceptable-Result modifier: the AC input is not acceptable so
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
the run time calibration was aborted.
14 LoadTooLow-Result modifier: the load is too low to recalibrate the run time
accurately.
15 OverChargeInProgress-Result modifier: a battery overcharge is currently in
progress therefore the run time calibration is refused (to prevent an
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
inaccurate result).
LifeTimeStatus_BF
Bit Index Description
0 LifeTimeStatusOK-Lifetime is OK. Mutually exclusive with bits 1-2
1 LifeTimeNearEnd-Lifetime is near end. Mutually exclusive with bits 0 and 2
2 LifeTimeExceeded-Lifetime is exceeded. Mutually exclusive with bits 0-1
3 LifeTimeNearEndAcknowledged-Alert has been acknowledged but still
exists
4
LifeTimeExceededAcknowledged-Alert has been acknowledged but still
exists
UserInterfaceStatus_BF
Bit Index Description
0 ContinuousTestInProgress-The continuous local UI test is in progress.
1 AudibleAlarmInProgress-There is an active alarm that is causing the local
UI beeper to sound. This bit indicates that the command to mute is
available.
2 AudibleAlarmMuted-There is an active alarm that is currently being muted.
This bit indicates that the command to cancel mute is available.
3 Reserved
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Bit Index Description
Input.InputStatus_BF
Bit Index Description
0 Acceptable-Input (both voltage and frequency) is acceptable and all other
system constraints are met so that the UPS can power the output with this
input source.
1 PendingAcceptable-Input (both voltage and frequency) is acceptable but at
least one other system constraint is not met preventing the line from being
declared acceptable (e.g. line is not stable long enough).
2 VoltageTooLow-Indicates that the input voltage is too low to be acceptable.
3 VoltageTooHigh-Indicates that the input voltage is too high to be
acceptable.
4 Distorted-Indicates a distorted input waveform. The input voltage is too
different from reference waveform, the frequency is moving too fast to track,
or the frequency is out of measurable range.
5 Boost-Indicates that the UPS is attempting to amplify the input voltage.
6 Trim-Indicates that the UPS is attempting to attenuate the input voltage.
7 FrequencyTooLow-Indicates frequency is measurably too low.
8 FrequencyTooHigh-Indicates frequency is measurably too high.
9 FreqAndPhaseNotLocked-Indicates that the system is not frequency and
phase locked to the input frequency and phase.
10 Reserved
11 Reserved
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
12 Reserved
13 Reserved
14 Reserved
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
VoltageACSetting_BF
Bit Index Description
0 VAC120-Output voltage 100VAC
1 VAC120-Output voltage 120VAC
2 VAC120-Output voltage 200VAC
3 VAC120-Output voltage 208VAC
4 VAC120-Output voltage 220VAC
5 VAC120-Output voltage 230VAC
6 VAC120-Output voltage 240VAC
7 Reserved
8 Reserved
9 Reserved
10 Reserved
11 Reserved
12 Reserved
13 Reserved
14 Reserved
15 Reserved
16 Reserved
AcceptableFrequencySetting_BF
Bit Index Description
0 Reserved
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Bit Index Description
1 Reserved
2 Reserved
3 Reserved
4 Reserved
5 Reserved
6 Reserved
UPSCommand_BF
Bit Index Description
0 Reserved
1 Reserved
2 Reserved
3 RestoreFactorySettings-Restore factory default settings for all operational
parameters that can be safely returned to factory defaults. Output Voltage
Setting and Output Frequency Setting are not altered. Strings, User
Language settings, logs, and statistical information are not reset with this
command.
4 Reserved
5 Reserved
6 Reserved
7 Reserved
8 Reserved
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
9 Reserved
SimpleSignalingCommand_BF
Bit Index Description
0 RequestShutdown - If there is no "shutdown" action in process this bit
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
indicates a command to the master to shutdown. The UPS will accept this
command regardless of the UPS State (Online or On Battery) It is the
responsibility of the slave to only issue this command at the appropriate
time.
1 RemoteOff - This is the equivalent of pressing and holding the power off
button. This will execute an immediate off function of all outlets that are on
and the UPS output.
2 RemoteOn - This is the equivalent of pressing the ON power off button.
This will execute a sequenced on.
Register: UPSStatus_BF
Bit Index Description
0 Start-Start the test.
1 Reserved
RunTimeCalibrationCommand_BF
Bit Index Description
0 Start-Start the run time calibration.
1 Abort-Cancel the run time calibration if InProgress.
UserInterfaceCommand_BF
Bit Index Description
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Bit Index Description
0 ShortTest-Perform the momentary local UI test, e.g., light all the LEDs and
sound the beeper.
1 ContinuousTest-Perform the continuous local UI test, e.g., light all the LEDs
and sound the beeper until canceled. To cancel, set
UICommand_BF.ShortTest. Local muting should cancel this as well.
2 MuteAllActiveAudibleAlarms-Mute all the active alarms in the UPS. Will not
silence the beeper during the short or continuous test or under other
implementation specific reasons (for example, key click).
3 CancelMute-Cancels any muting (same as audible disabled then enabled).
4 Reserved
5 AcknowledgeBatteryAlarms-Acknowledge active battery alarms.
OutletStatus_BF
Bit Index Description
0 StateOn-State - indicates the outlet is powered. Mutually exclusive with
other state bits.
1 StateOff-State - Indicates the outlet is not powered. Mutually exclusive with
other state bits.
2 ProcessReboot-Modifier - indicates that a reboot command was issued and
is still in progress. A reboot command can be issued by writing to the
command bitfield or by writing timers. Mutually exclusive with other
process bits.
3 ProcessShutdown-Modifier - indicates that shutdown command was issued
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
and is still in progress. A shutdown command can be issued by writing to
the command bitfield or by writing timers. Mutually exclusive with other
process bits.
4 ProcessSleep-Modifier - indicates that a sleep command was issued and is
still in progress. A sleep command can be issued by writing to the
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
command bitfield or by writing timers. A master should indicate sleep
rather than reboot if the StayOffCountdown_EN_4B timer is initially loaded
with a value greater than 300 seconds. Mutually exclusive with other
process bits.
5 Reserved
6 Reserved
7 PendingOffDelay-Modifier - indicates the outlet has an active process that
requires an off delay when switching an outlet from on to off.
8 PendingOnACPresence-Modifier - indicates the outlet will not turn on
unless AC input power is available.
9 PendingOnMinRuntime-Modifier - indicates the outlet will not turn on unless
sufficient runtime is available.
10 MemberGroupProcess1-Modifier - indicates the outlet is participating in the
1st "group process command".
11 MemberGroupProcess2-Modifier - indicates the outlet is participating in the
2nd "group process command".
12 LowRuntime-Modifier - indicates the run time is below the setting for the
outlet group.
13 Reserved
14 Reserved
15 Reserved
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Bit Index Description
OutletCommand_BF
Bit Index Description
0 Cancel-Cancels pending actions to the targets selected. No modifiers are
allowed.
1 OutputOn-Command the output to turn on. The only valid modifiers (in any
combination) are UseOnDelay and ColdBootAllowed.
2 OutputOff-Command the output to turn off (and not come back on
automatically). The only valid modifier is UseOffDelay.
3 OutputShutdown-Command the output to turn off and then back on
automatically when AC input power is restored. The only valid modifiers (in
any combination) are UseOffDelay and UseOnDelay.
MinimumReturnRuntimeSetting is enforced when turning on.
4 OutputReboot-Command the output to turn off and then back on
automatically. The only valid modifiers (in any combination) are
UseOffDelay, UseOnDelay and ColdBootAllowed.
MinimumReturnRuntimeSetting is not enforced when turning on. A Reboot
command is interpretted as a sleep command when the stayofftime
countdown is greater than 300 seconds.
5 ColdBootAllowed-Modifier - allow the output to turn on without AC input
power conditions met.
6 UseOnDelay-Modifier - use the on delay settings for the applied command
7 UseOffDelay-Modifier - use the off delay settings for the applied command
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
8 UnswitchedOutletGroup-Target - command applies to the unswitched outlet
group
9 SwitchedOutletGroup0-Target - command applies to switched outlet group
0
10 SwitchedOutletGroup1-Target - command applies to switched outlet group
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
1
11 SwitchedOutletGroup2-Target - command applies to switched outlet group
2
12 USBPort-Source - Command came from a device connected to the USB
port
13 LocalUser-Source - Command came from a local user interface.
14 RJ45Port-Source - Command came from a device connected to the
Computer Interface port (Typically RJ45), This includes software over the
serial RJ45 and simple signal via RJ45
15 SmartSlot1-Source - Command came from a device in SmartSlot 1.
16 Reserved
17 Reserved
18 Reserved
19 Reserved
20 Reserved
21 Reserved
22 Reserved
23 Reserved
24 Reserved
25 Reserved
26 Reserved
27 Reserved
28 Reserved
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Bit Index Description
29 Reserved
30 Reserved
31 Reserved
I_SOGRelayConfigSetting_BF
Bit Index Description
0 MOGPresent-A user accessible MOG is present
1 SOG0Present-SOG 0 is present
2 SOG1Present-SOG 1 is present
3 SOG2Present-SOG 2 is present
4 SOG3Present-SOG 3 is present
5 Reserved
6 Reserved
7 Reserved
8 Reserved
9 Reserved
10 Reserved
11 Reserved
12 Reserved
13 Reserved
14 Reserved
15 Reserved
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
aborted causes that will be captured with this value are the ones that result
in the same status after the test has been aborted. For example, a load
10
change during a run time calibration that causes the test to abort and the
status to return to on-line. As opposed to a local UI command (off button)
that causes the run time calibration to be aborted but the status does not
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
change to on-line.
LocalUICommand-Indicates the user pressed the on/off or other button
11 locally to cause the transition. Includes local terminal mode interface if
applicable.
ProtocolCommand-Indicates that a command received over the smart
12
interface has caused the state change.
LowBatteryVoltage-A low battery voltage caused the transition. This would
13 be used for low battery shutdown but may also be used when transitioning
between other states due to a low battery voltage criteria.
GeneralError-A general error caused the transistion. GeneralError_BF
14
usage contains the specific fault if still valid.
PowerSystemError-A power system error caused the transistion.
15
PowerSystemError_BF usage contains the specific fault if still valid.
BatterySystemError-A battery system error caused the transistion.
16
BatterySystemError_BF usage contains the specific fault if still valid.
ErrorCleared-Indicates that the system changed states due to an error
17 clearing. (Some errors may still exist but a state change occurred even with
those errors present.).
AutomaticRestart-Indicates that internal conditions have met to allow the
18 output to turn on, after a battery depletion. (8051 may not use this one
because it requires EEPROM storage of the state).
DistortedInverterOutput-Indicates that the system changed states due to a
19
distorted waveform detected on the output ("turbo").
20 InverterOutputAcceptable-Indicates that the system changed states due to
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.
[ APPLICATION NOTE #176 ] Modbus Implementation in Smart-UPS
Value Description
no further distortion on the output waveform.
EPOInterface-Indicates that an input was received at the UPS through the
21
EPO interface to turn off the output.
22 InputPhaseDeltaOutOfRange-Indicates input phase delta is out of limi
23 InputNeutralNotConnected-Indicates that neutral leg is missing
24 ATSTransfer-Indicates that state change was caused due to ATS operation
ConfigurationChange-Indicates that state change was caused by a
25
configuration change. (eg. a change in AllowedOperatingMode_BF)
26 AlertAsserted-An informational alert has caused the transistion.
AlertCleared-Indicates that the system changed states due to an
27
Informational alert acknowledge or cleared.
PlugRatingExceeded-Indicates transition happened because Input current
28 exceeded plug rating. Example: when operating in "boost" mode when
input current exceeds line cord rating transition to battery.
OutletGroupStateChange-Indicates the transition occured due to MOG or
29
SOG state change.
FailureBypassExpired-Indicates that load was turned off due to inability to
30
continue operating in failure bypass.
©2013 Schneider Electric. All Rights Reserved. Schneider Electric and APC are trademarks owned by Schneider Electric
Industries SAS or its affiliated companies. All other trademarks are property of their respective owners.
APC by Schneider Electric 800 Federal Street, Andover MA 01810 Telephone: +1 978-794-0800 www.apc.com AN-176 v12 September 2014
The information in this document is provided solely to allow communications with Schneider Electric’s APC-brand devices via software. Any Software published using
any portion of the information contained in this document must include this document in its distribution. Hardware or Software products generated using any portion of
the information from this document may not be produced for commercial purposes without the express written consent of Schneider Electric. Distribution of this
document is allowed only in its entirety in exact form.