UPS Communication Protocol
As Used On The Following SOLA/ Best Power UPS Models:
- SOLA Australia
-
-
SOLA 320
-
SOLA 325
-
SOLA 520
-
SOLA 525
-
SOLA 610
-
SOLA 620
-
- BEST Power
-
-
Patriot Pro
-
Patriot Pro II
-
Fortress
-
Fortress.TeleCom
-
Best 610
-
Axxium
-
General
This document contains specific information regarding the RS232C communication protocol for UPS models built for Best Power and SOLA. The protocol provides features to allow the user to:
-
Monitor charger status.
-
Monitor battery status and condition.
-
Monitor inverter status.
-
Monitor UPS status.
-
Monitor the utility status.
-
Shut off power to the UPS load
-
Turn off power to the UPS load and allow the power to return after a user-selected amount of time
<cr> as used in this document is the IBM PC ASCII code for Carriage Return.
It has the HEX code of 0D . |
The connected computer will control information exchange through a query command followed by <cr>
.
The UPS is case sensitive to commands received from the connected computer.
The UPS will respond with information followed by a <cr>
or a specific action will take place without a serial response.
Some data/functions will be different depending on whether the UPS is a standby or on-line (double-conversion) system.
UPS data will be provided at a rate of 2400 baud and consist of 8 data bits, 1 stop bit, and no parity bit. All the information is provided in ASCII format.
Standby UPS systems following this specification will be capable of performing a UPS test. This test will be short term, user specified term, or to a low battery warning.
All system will respond to inverter shut down and output shut down after a specified delay and for specified time. They will also permit cancellation of the shut down sequence.
Hardware
The DB9S (Female) Communication Port on the UPS must conform to Best Power’s BestPort Communication Port Specification. Reference document number: EPS-0059.
For the communications described in this document, the following pins a functionality are required:
Pin | Function | ||
---|---|---|---|
1 (6 on 610) |
RS-232 Receive Data Receives incoming RS-232 communication data at 2400 baud, 8 bits, no parity and 1 stop bit. |
||
2 (9 on 610) |
RS-232 Transmit Data Sends outgoing RS-232 communication data at 2400 baud, 8 bits, no parity and 1 stop bit. |
||
4 (7 on 610) |
Common The signal ground for all signal pins. |
||
6 (NC on 610) |
Reserved or Plug and Play Sense UPS Models that support Microsoft Plug and Play (PnP) compatibility use this pin to sense the PnP request from the PC. Currently, models that have PnP support are the Patriot Pro, Patriot Pro II, SOLA 320, SOLA 325, Fortress 520 Series, SOLA 520, Fortress.TeleCom and SOLA 525. The 610 series, Axxium, SOLA 620 do not support Plug and Play compatibility.
|
CABLING
Best Power’s INT-0062 (SOLA’s 0999-3400M3) cable shall be used to connect a PC’s DB9P (Male) serial port to the DB9S (Female) port (BestPort) on all models except the 610 series.
The cable used on the 610 series is part number A4D0044. (SOLA’s 0999-3403M3)
COMMUNICATION PROTOCOL COMMAND DEFINITIONS
Status Inquiry #1
Computer Sends:
|
|
UPS Responds:
|
UPS status stream with the format |
Where:
(
|
Start Byte |
||||||||||||||||||
MMM.M
|
Input Voltage
|
||||||||||||||||||
NNN.N
|
Input Fault Voltage
|
||||||||||||||||||
PPP.P
|
Output Voltage
|
||||||||||||||||||
QQQ
|
Output Load For Offline UPS Models, For Online UPS Models, |
||||||||||||||||||
RR.R
|
Input Frequency
|
||||||||||||||||||
SS.S or SSSS
|
Battery voltage
|
||||||||||||||||||
TT.T
|
Temperature
|
||||||||||||||||||
<U>
|
UPS Status
The table below defines the bits as they are decoded:
|
||||||||||||||||||
<cr>
|
Stop Byte |
Example
Computer Sends:
|
|
UPS Responds:
|
|
U
represents the byte equivalent of 00110000
Decodes to:
-
Input voltage = 208.4 Volts
-
Input Fault Voltage =140.0 Volts
-
Output Voltage = 208.4 Volts
-
Output Load = 34%
-
Input Frequency = 59.9 Hertz
-
Battery voltage = 39.6 Volts
-
Temperature = 35.0 Degrees of Centigrade
-
Utility Power has not failed
-
The Battery is not low
-
The UPS Bypass is active
-
The UPS has failed
-
The UPS Type is Online
-
UPS Test is not in progress
-
UPS Shutdown is not in progress
Status Inquiry #2
Computer Sends:
|
|
UPS Responds:
|
UPS status stream with the format |
Note that a single space character separates each parameter. One space follows the Temperature data (precedes the status bytes.)
The binary Status code (from the Q
response) is modified to 8 bytes ASCII code to avoid any confusion between the binary code and the ASCII control code.
Where:
(
|
Start Byte |
||||||||||||||||||
MMM.M
|
Input Voltage
|
||||||||||||||||||
NNN.N
|
Input Fault Voltage
|
||||||||||||||||||
PPP.P
|
Output Voltage
|
||||||||||||||||||
QQQ
|
Output Load For Offline UPS Models, For Online UPS Models, |
||||||||||||||||||
RR.R
|
Input Frequency
|
||||||||||||||||||
SS.S or SSSS
|
Battery voltage
|
||||||||||||||||||
TT.T
|
Temperature
|
||||||||||||||||||
b7b6b5b4b3b2b1b0
|
UPS Status Bytes
The table below defines the bytes as they are decoded:
|
||||||||||||||||||
<cr>
|
Stop Byte |
Example
Computer Sends:
|
|
UPS Responds:
|
|
Decodes to:
-
Input voltage = 208.4 Volts
-
Input Fault Voltage =140.0 Volts
-
Output Voltage = 208.4 Volts
-
Output Load = 34%
-
Input Frequency = 59.9 Hertz
-
Battery voltage = 39.6 Volts
-
Temperature = 35.0 Degrees of Centigrade
-
Utility Power has not failed
-
The Battery is not low
-
The UPS Bypass is active
-
The UPS has failed
-
The UPS Type is Online
-
UPS Test is not in progress
-
UPS Shutdown is not in progress
10 Seconds Test
Computer Sends:
|
|
UPS Responds:
|
with a Test for 10 seconds and return to utility |
If battery low occur during testing, UPS will return to utility immediately.
This command is available in all Best Power/Sola UPS models.
Test Until Low Battery
Computer Sends:
|
|
UPS Responds:
|
with a Test that lasts until a Low Battery condition exists and then the UPS returns to utility power. |
This command is available in all Best Power/Sola UPS models.
Test for specified time period
Computer Sends:
|
|
UPS Responds:
|
with a Test that lasts for the specified number of minutes |
Where <n>
is the number of minutes (01
- 99
) the test should continue for.
During the test, the UPS will return to utility immediately if a Low Battery condition occurs.
This command is available in all Best Power/Sola UPS models.
Shutdown Command
Computer Sends:
|
|
UPS Responds:
|
by shutting the UPS output off in |
Where <n>
is the number of minutes (see below) to wait before turning off the UPS output.
The UPS output will turn off in <n>
minutes, even if utility power is present.
If a Low Battery condition occurs before <n>
minutes, the UPS output is turned off immediately.
After UPS shuts down, the UPS must not restart even though the input power is restored or is still present unless the user turns the unit on again.
Best/SOLA 610 and Patriot Pro/SOLA 320 Models will restart after a 10 second delay upon the return of AC input power. |
<n>
is a number ranging from .2
, .3
, …, 01
, 02
, …, to 99
.
The Cancel Shutdown command (C
) may be used to cancel the shutdown of the UPS output during the countdown period defined by <n>
minutes (shutdown waiting status).
Example
Computer Sends:
|
|
UPS Responds:
|
by shutting the output off in |
Shutdown and Restore Command
Computer Sends:
|
|
UPS Responds:
|
by shutting the UPS output off in |
The UPS output will turn off in <n>
minutes, even if utility power is present.
<n>
is a number ranging from .2
, .3
, …, 01
, 02
, …, to 99
.
If a Low Battery condition occurs before <n>
minutes, the UPS output is turned off immediately.
<m>
is a number ranging from 0001
to 9999
.
If <m>
minutes expires and the utility power has not returned, the UPS must wait until utility power is restored before turning on the UPS output again.
The Cancel Shutdown command (C
) may be used to cancel the shutdown of the UPS output during the countdown period defined by <n>
minutes (shutdown waiting status).
The Cancel Shutdown command (C
) may be used to cancel the delay before turning on the UPS output defined by the countdown period <m>
minutes (restore waiting status).
The UPS output must remain off for at least 10 additional seconds before turning on (if utility power is present).
Cancel Shutdown Command
Computer Sends:
|
|
UPS Responds:
|
by canceling the |
The Cancel Shutdown command may be used to cancel the shutdown of the UPS output during the countdown period defined by <n>
minutes (shutdown waiting status).
The Cancel Shutdown command may be used to cancel the delay before turning on the UPS output defined by the countdown period <m>
minutes (restore waiting status).
The UPS output must remain off for at least 10 additional seconds before turning on (if utility power is present).
Cancel Test Command
Computer Sends:
|
|
UPS Responds:
|
by canceling all test activity and connecting the utility power to the UPS output immediately. |
UPS Runtime Remaining Inquiry
Computer Sends:
|
|
UPS Responds:
|
with the calculated battery runtime remaining Where |
This command provides the number of minutes the UPS can run on battery before a low battery shutdown occurs.
This command is not available on the Best/SOLA 610 model series. It is also not available on Patriot Pro/SOLA 320 model series.
Set the Quantity of Attached Battery Packs
Computer Sends:
|
|
UPS Responds:
|
by understanding that there are now |
Where <n>
is an integer ranging from 0
to 5
.
This command is only available on the Axxium/SOLA 620 model series.
Examples
Computer Sends:
|
|
UPS Responds:
|
by understanding that there is no attached battery pack |
Computer Sends:
|
|
UPS Responds:
|
by understanding that there are |
Attached Battery Packs Inquiry
Computer Sends:
|
|
UPS Responds:
|
|
Where <nn>
represents the number of battery packs the UPS currently understands it has.
A leading O
(zero) is always supplied, assuming that less than 10
(ten) battery packs are connected.
-
00
→ No attached battery packs -
01
→ One attached battery pack -
02
→ Two attached battery packs -
03
→ Three attached battery packs -
04
→ Four attached battery packs -
05
→ Five attached battery packs
This command is only available on the Axxium/SOLA 620 model series.
UPS ID Inquiry
Computer Sends:
|
|
UPS Responds:
|
with the UPS Identification stream with the format: |
Where:
AAA
|
is the three-character identification for the UPS model as define by Best Power and listed in the table below:
|
||||||||||||||||||||||
BBBB
|
is the output power in VA (volt amperes).
Example: |
||||||||||||||||||||||
CCC
|
is the Nominal Input Voltage.
|
||||||||||||||||||||||
DDD
|
is the Nominal Output Voltage.
|
||||||||||||||||||||||
EE.E
|
is the Battery Voltage that will cause the UPS to shut itself off.
|
||||||||||||||||||||||
FF.F or FFF.F
|
is the Battery Voltage at full charge.
Typically, for 700VA, 1KVA and 1.5KVA units, the format is |
This command is not available on the Best/SOLA 610 model series.
Shutdown Set Command
Computer Sends:
|
|
UPS Responds:
|
by setting the shutdown mode functionality of Pin 1 and Pin 7 on the UPS DB9 communication port (Per Best Power’s EPS-0059) |
Where:
<n>
is an integer number ranging from 0
to 6
.
The following table summarizes the effects on Pin 1 and Pin 7 functionality:
Shutdown Set # mode | LEDs on UPS | Pin 1 Functionality | Pin 7 Functionality |
---|---|---|---|
|
LEDs OFF |
Shut off after 2 minutes on battery, even if input power returns during the 2 minutes. Restart after a 12 second delay following shutdown, once input power returns. |
Emergency Power Off (EPO) immediately under any condition (normal input power or on battery). UPS will not restart. |
|
LED 1 |
Shut off after 2 minutes on battery, even if input power returns during the 2 minutes. UPS will not restart when normal input power returns. |
Shut off after 2 minutes on battery, even if input power returns during the 2 minutes. UPS will not restart when normal input power returns. |
|
LED 2 |
Shut off after 1 minute on battery.
|
Shut off after 1 minute on battery.
|
|
LED 3 |
Shut off after 3 minutes on battery. |
Shut off after 3 minutes on battery. |
|
LED 4 |
Shut off after 5 minutes on battery. |
Shut off after 5 minutes on battery. |
|
LED 5 |
Shut off after 10 minutes on battery. |
Shut off after 10 minutes on battery. |
|
LED 6 |
Shut off after 20 minutes on battery. |
Shut off after 20 minutes on battery. |
This command is not available on the Best/SOLA 610 model series.
Shutdown Set Inquiry Command
Computer Sends:
|
|
UPS Responds:
|
by reporting the current value set as the Shutdown mode as |
Where <n>
is an integer number between 0
and 6
representing the functionality listed on the table above.
This command is not available on the Best/SOLA 610 model series.
COMMAND SUMMARY
Below is a summary of all the commands listed in this document:
Q
|
Status Inquiry |
Q1
|
Status Inquiry (typically used by CheckUPS) |
T
|
10 Seconds Test |
TL
|
Test until Low Battery occurs |
T<n>
|
Test for a Specified Time Period |
S<n>
|
Shutdown Command |
S<n>R<n>
|
Shutdown and Restore Command |
C
|
Cancel Shutdown Command |
CT
|
Cancel Test Command |
RT
|
UPS Runtime Remaining Inquiry |
BP<n>
|
Set the Quantity of Attached Battery Packs |
BP?
|
Attached Battery Packs Inquiry |
ID
|
UPS ID Inquiry |
SS<n>
|
Shutdown Set Command |
SS?
|
Shutdown Set Inquiry Command |