APC Smart-UPS Communications Application Note

[ APPLICATION NOTE #181 ]
Smart-UPSTM Communications
By Daniel Cohen & Manuel J. Palomino
PROJECT AT A GLANCE
Project Type
Manage the behavior of the Smart-UPS
with one of the smart interfaces.
Communicate with the UPS to monitor,
configure and control its operation, or to
integrate shutdown sequences with
external equipment, including servers.
Applicable Products
All APC Smart-UPS with an RJ-45 (serial)
connector, including: SMT, SMC, SMX, and
SURTD.
Smart-UPS Communications
Connecting and communicating with your APC Smart-UPS allows you to
get the most value out of the UPS and you entire system. With multiple
options available, chose the one that best fits your application.
Management and configuration of the UPS can be achieved using APC's
software products, such as Power Chute Business Edition, APC’s
network accessories via Ethernet, or through custom written applications.
Connecting your computer to the UPS is essential.
This document outlines the various options available in the Smart-UPS
products to connect to your server or equipment.
1 Introduction ............................................................................................................................. 3 2 Communication Options ........................................................................................................ 4 3 USB Communications ............................................................................................................ 5 3.1 Standard Features ............................................................................................................. 5 3.1.1 PowerChute Business Edition ................................................................................... 5 3.1.2 Native Operating System Safe Shutdown ................................................................. 5 3.1.3 Custom Programming Interface ................................................................................. 5 3.2 Optional Accessories ......................................................................................................... 6 3.2.1 Legacy Communications Card (AP9620) .................................................................. 6 4 Electrical Signal Communications ........................................................................................ 7 4.1 Standard Features ............................................................................................................. 7 4.1.1 Output Type 1 Characteristics ................................................................................... 7 4.1.2 Output Type 2 Characteristics ................................................................................... 7 4.1.3 Input Type 1 Characteristics ...................................................................................... 7 4.1.4 Input Type 2 Characteristics ...................................................................................... 7 4.2 Optional Accessories ......................................................................................................... 8 4.2.1 Simple Signal Cable (AP940-0625) ........................................................................... 8 4.2.2 Relay I/O Card (AP9613) ........................................................................................... 8 4.2.3 UPS Signaling Cable for IBM iSeries or AS/400 (AP98275) ..................................... 9 4.2.4 Legacy Communications Card (AP9620) .................................................................. 9 4.2.5 UPS Network Management Card 2 with Environmental Monitoring (AP9631)
with Dry Contact I/O Accessory (AP9810) ................................................................ 9 5 Serial Communications ........................................................................................................ 10 5.1 Standard Features ........................................................................................................... 10 5.1.1 Power Chute Business Edition ................................................................................ 10 5.2 Optional Accessories ....................................................................................................... 10 5.2.1 Legacy Communications Card (AP9620) ................................................................ 10 5.2.2 UPS Network Management Card 2 (AP9630) or UPS Network Management
Card 2 with Environmental Monitoring (AP9631) .................................................... 11 ©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.
Table of Contents
Table of Figures
Figure 1 – Electrical Signal Communication Interface.......................................................................... 7 Figure 2 – Serial Communication Interface ........................................................................................ 10 APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
Telephone: +1 978-670-2440
www.apc.com
February 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.
Introduction
(1)
X
X
SMT
X
X
X
SMX
X
X
X
SMX*NC
X
X
SURTD under
5kVA
SURTD 5kVA and
higher
X(1)
SmartSlot
SMC
X
X
X(1)
X
SURTD offers different functionality through this interface
Table 1- Applicable Products
UPS communication options can be
divided into 2 categories: those
available as a standard feature, and
those that require an additional
accessory. For the purposes of this
document, communication options
that are available in the standard
product as delivered to the user are
classified as STANDARD, while ones
that require an accessory are
classified as OPTIONAL.
APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
UPS communications occur on one of
several physical media:




USB
Serial communications
Electrical signals
communications
Ethernet
The document is divided into sections
related to each physical layer and the
options for using these layers.
Telephone: +1 978-670-2440 www.apc.com
February 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.
©2012 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.
Smart-UPS
Online
USB -Type B
Smart-UPS
The following Smart-UPS product
families are covered in this document:
Serial RJ-45
There are several different methods
available to communicate with APC
Smart-UPS™.
Pre-installed
UPS Network
Management
Card 2
1
2
Communication Options
Interface
Cables &
Connections
Communication
Types
Software options
Standard
USB
Interface
Standard
SmartUPS
Interfaces
USB
Serial RJ-45
AP9620
AP9630
AP9631
AP9810
(1)
Smart
Communications
AP940-0625(3)
or
AP940-1525(3)
Smart
Communications
940-0128(3)
Simple Signaling
Native OS
Management
Custom(1)
using USB Power
Summary
Custom(1)
using Modbus(2)
PowerChute
Business Edition
Custom(1) using
Modbus (2)
PowerChute
Business Edition
Custom
AP9613
Optional
SmartSlot
Interfaces
USB 2.0 Type A
to Type B
Custom
Simple Signaling
Custom
Dry Contact I/O
Card
Custom
I/O Signals
Custom
Legacy
Communications
Card
USB 2.0 Type A
to Type B
or
DB-9 serial
cable (supplied
with comm.
card)
Smart
communications
Ethernet
Smart
communications
UPS Network
Management
Card 2
UPS Network
Management
Card 2 with
Environmental
Monitoring
Dry Contact I/O
Accessory for
AP9631
PowerChute
Business Edition
ver ≤8.0
Custom(1)
Web page
Custom(1) SNMP
Web page
Ethernet
Smart
communications
Custom(1) SNMP
Custom
I/O
-
Open source application available for this option (e.g. APCUPSD)
Modbus communications supported in some models. See AN #176 for details
(3)
Contact APC Tech Support for availability
Table 2- Smart-UPS Communication Options
(2)
APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
Telephone: +1 978-670-2440
www.apc.com
©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.
PowerChute
Business Edition
February 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.
.
USB Communications
3.1
computer. The host operating system
will be capable of instructing the
computer to shut down when the UPS
deems it necessary. Compatibility with
Windows and MAC is provided by the
operating system, and Linux native
shutdown is commonly provided via
APCUPSD, an open source application.
All of these are tested for compatibility
with our UPS for shutdown functionality.
Standard Features
Only available on products with USB
ports: SMT, SMC, and SMX product
families. (Note: Not available on
SURTD)
3.1.1 PowerChute Business Edition
Using a standard USB cable, connect
the UPS to a computer running the
software PowerChute Business Edition which ships with every UPS rated below
5kVA. PowerChute gives the user the
ability to configure and monitor the UPS
and to allow the UPS to safely shut
down the computer when there is a
power outage.
3.1.3
The following table indicates a partial
list of data points that are available via
the USB communications interface
that is included in all Smart-UPS units.
For a complete list of data items and
interface options, see App Note #178
(USB HID Implementation in SmartUPS).
3.1.2
Native Operating System
Safe Shutdown
The UPS implements industry standard
data elements, ensuring compatibility
with the operating system of the
Signal
Firmware Version
SKU Name
Serial Number
Manufacture Date
Alarm Mute
UPS Output
Output
Output
Output
Output
Input
Run Time Remaining
Output
Battery Voltage
Output
State of Charge
Output
Shutdown Imminent
Battery Replacement
On Battery
Battery Present
Overload
Temperature
Output
Output
Output
Output
Output
Output
Shutdown UPS
Input
Transfer Sensitivity
Input
Custom Programming
Interface
Description
Firmware version of the UPS
SKU number of the UPS
Serial Number of the UPS
Manufacturer date of the UPS
Commands the beeper to enable or disable
The amount of run time that the unit has remaining
when on battery
The battery voltage
The state of charge of the battery system (100% = fully
charged)
Indicates that the UPS will turn off its output
Indicates that the battery needs replacement
Indicates that the unit is operating on battery
Indicates that the battery is present
Indicates that the unit is in an overload condition
Indicates the temperature of the unit
Commands the UPS to turn its output off (can be done
with delay)
Configures the sensitivity of the UPS to input power.
Table 3- Partial List of Data Available via USB
APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
Telephone: +1 978-670-2440 www.apc.com
February 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.
©2012 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.
3
3.2
Optional Accessories
Accessory
AP9620
Description
Legacy Communications Card
Table 4- Accessories for USB communication
Legacy Communications Card
(AP9620)
This SmartSlot™ card may be used to
provide the historical USB interface that
existed on previous versions of
products. This is useful for customers
who have already written software to
communicate with older products and
APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
want compatibility with the new product.
This card emulates the serial
communications that was supported on
previous versions of the product through
DB-9 connectors.
Note: USB functionality is not supported
on SURTD family.
Telephone: +1 978-670-2440 www.apc.com
February 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.
©2012 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.
3.2.1
4
4.1
Electrical Signal Communications
Standard Features
All Smart-UPS covered by this
document contain a similar
communications interface.
This interface offers one connector, an
RJ-45 serial connector.
The RJ-45 serial connector provides the
following physical port on the back of
the UPS.
Figure 1 – Electrical Signal Communication Interface
Table 4 describes the signals available
on this interface. Below are the
definitions to the various input and
output types used.
4.1.1 Output Type 1 Characteristics
This output will have a voltage of 5V
when active, and voltage of -5V when
inactive. It is intended to be connected
to an RS-232 device, and can drive a
non-inductive impedance of ≥ 3KOhm.
There is a tolerance of the voltage of
±10%.
4.1.2 Output Type 2 Characteristics
This is an Open Collector output, and
will sink current when active. It should
be connected to a supply voltage
between 2.4V and 25V with appropriate
APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
non-inductive impedance to limit the
current to <5mA. The open collector
output voltage may be as high as 1.2V
when sinking current up to 5mA.
©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.
This interface is designed to connect to
a computer’s serial port, therefore one
should consider the power available to
be driven through an NPN transistor and
have a pull down voltage of 0.5V (min)
with a maximum of 20mA.
4.1.3 Input Type 1 Characteristics
The input circuit is designed to be active
when a voltage of between 2.4V and
25V is applied. The signal is inactive
when the input is < 0.6V or left
unconnected. This pin is intended to
interface with RS-232 drivers.
Resistance to ground is approximately
3KOhms. The maximum voltage that
can be applied to this pin is +/-25V.
4.1.4 Input Type 2 Characteristics
The input circuit is designed to be active
when a voltage of between 4.8V and
25V is applied. The signal is inactive
when the input is < 0.6V or left
unconnected. This pin is intended to
interface with RS-232 drivers.
Resistance to ground is approximately
100KOhms. The maximum voltage that
can be applied to this pin is +/-25V.
Telephone: +1 978-670-2440
www.apc.com
February 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.
Signal
Direction
Description
1
+24V
Output
Switched 24 Volt DC output, jumper required to enable
Not supported by SURTD
2
Power Fail
Output Type 1
Positive voltage indicates an AC Power Failure. RS-232
level output.
3
Shutdown
Imminent
Output Type 2
Stops sinking current when the output of the UPS is
scheduled to turn off.
4
Chassis
Ground
Output
5
+24V Enable
Input
7
Signal GND
Output
8
Inverter
Shutdown
Input
Type 1
9
UPS Turn Off
Input Type 2
10
UPS Turn On
Input Type 2
Used for drain wire termination in shielded cables.
Used to enable the +24V output at pin 1. Short pin 5 to
pin 7 to enable Pin 1 +24V output.
Not supported by SURTD
Signal ground for all inputs and outputs
Application of positive voltage for >= 5 seconds starts a
delayed shut down of the UPS during a power failure.
RS-232 level input.
Application of positive voltage for >= 0.25 seconds turns
off the UPS immediately.
Not supported by SURTD
Application of positive voltage for >= 0.25 seconds when
AC power is OK starts a (delayed) turns on of the UPS.
Not supported by SURTD
Table 5- Signals Available on Electrical Interface
4.2
Optional Accessories
Accessory
AP940-0128
AP9613
AP98275
AP9620
AP9631
AP9810
Description
Simple Signal Cable – RJ-45 to DB-9 Serial port (6ft or 15ft in length)
Relay I/O
Kit including RJ-45 converter to Legacy DB-9 connector
Legacy Communications Card
UPS Network Management Card 2 with Environmental Monitoring
Dry Contact I/O Accessory for AP9631
Table 6- Accessories for Electrical Signal Communications
4.2.1
Simple Signal Cable (AP9400625)
This cable is designed to interface a
Smart-UPS to a computer’s serial port.
It provides 3 signals to the serial port,
APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
Power Failure, Shutdown Imminent, and
the Shutdown Command pin.
4.2.2 Relay I/O Card (AP9613)
This SmartSlot™ card is designed to
provide isolated dry contacts for user
interface to equipment. This is typically
Telephone: +1 978-670-2440
www.apc.com
©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.
Pin
February 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.
used in applications which do not have a
computer connected.
4.2.3
UPS Signaling Cable for IBM
iSeries or AS/400 (AP98275)
Although this cable package indicates
that it is for the AS/400 computer
systems it contains several cables. One
of these cables (940-3000A) is a
converter from the RJ-45 to the legacy
DB-9 connector. This solution replicates
the interface that was on the SUA
product family however it does not
implement pin 6 (On Battery normally
closed), or the Remote Off functionality.
products. This is useful for customers
who have already written software to
communicate with older products and
want compatibility with the new product.
4.2.5
UPS Network Management
Card 2 with Environmental
Monitoring (AP9631) with Dry
Contact I/O Accessory
(AP9810)
This solution provides an input and
output contacts which can be configured
with the web interface that is provided
with the SmartSlot™ card.
Legacy Communications Card
(AP9620)
This SmartSlot™ card may be used to
provide the historical USB interface that
existed on previous versions of
©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.
4.2.4
APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
Telephone: +1 978-670-2440
www.apc.com
February 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.
5
Serial Communications
5.1
used by the customer. The cables 9400625 or 940-1525 can be used to
interface with a standard DB-9
connector on a computer.
Standard Features
All Smart-UPS covered by this
document contain a serial
communications interface that can be
Pin
1
2
3
4
5
7
8
9
10
Signal
Direction
Description
UPS TX
Output
RS-232 output from the UPS
Chassis Ground
Output
Used for drain wire termination in shielded cables.
Signal GND
UPS RX
Output
Input
Signal ground for all inputs and outputs
RS-232 input to the UPS
©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.
Figure 2 – Serial Communication Interface
Table 7- Signals Available on Electrical Interface
can be used to provide safe shut down
5.1.1 Power Chute Business
of the computer, as well as give the user
Edition
the ability to configure and monitor the
The serial cable provided with the UPS
UPS.
can be connected to a computer’s serial
port to allow communication. The
software Power Chute Business Edition
5.2
Optional Accessories
Accessory
AP9620
AP9630
AP9631
Description
Legacy Communications Card
UPS Network Management Card 2
UPS Network Management Card 2 with Environmental Monitoring
Table 8- Accessories for USB Communication
5.2.1
Legacy Communications Card
(AP9620)
This SmartSlot™ card may be used to
provide the USB interface that existed
on previous products. This is useful for
customers who have already written
APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
software to communicate to this
specification.
Note: AP9620 is not compatible with
SURTD family.
Telephone: +1 978-670-2440
www.apc.com
February 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.
UPS Network Management
Card 2 (AP9630) or UPS
Network Management Card 2
with Environmental Monitoring
(AP9631)
This solution provides a serial
programming interface which can be
used to communicate to both the
network interface and the UPS
parameters.
©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.
5.2.2
APC by Schneider Electric 85 Rangeway Road, North Billerica, MA
Telephone: +1 978-670-2440
www.apc.com
February 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.
">