Belkin UPS Protocol

Version 1.44

indicates the item is supported by N 1~3K series

indicates the item is supported by L series

History

1.0

09/23/1997


1.1

11/14/1997


1.2

12/30/1997

Add VSN(Voltage Sensitivity)

1.3

10/09/1998

Control Outlet

Add Regular Format ID

Add TEL, BRD commands

1.31

01/26/1999

SDR from 99999 to 65535

1.32

03/04/1999

Add STA---Inverter Bad

1.33

04/28/1999

Add ENV, Battery Level, Rating Battery Voltage

Mark some items that UPS must support

1.34

05/03/1999

Change BUZ Status(0: Buzzer off, 1:Buzzer on)

1.35

07/21/1999

Economic Mode enable/disable

Periodic Auto-test

Buzzer Test

ATX Reboot enable/disable

Auto Reboot enable/disable

1.36

07/28/1999

Add RSM---Resume PC, AVL rearrange

1.37

08/17/1999

Change Length of MNU, MOD and VER to 16

Change Range of RNF from 1 to 65535

1.38

05/09/2000

Add the Emergency Power Off item in the STA

1.39

04/03/2001

Add TXF(Raymond), UBD Commands

Define the ARB command

1.40

07/18/2001

Add SOV command

1.41

01/25/2002

Delete the RST command because it is conflict to the ARB command.

Redefine BUZ command to alarm/silence

Add EDB command to enable/disable buzzer alarm

Define a standard string of Windows Plug & Play

1.42

01/30/2002

Redefine 'Battery Temperature' to 'Temperature'




1.44

05/24/2002

Add BTV command for battery test




1.Communication Parameters

Baud Rate 2400

Parity None

Data Bits 8

Stop Bits 1


2.Message Format

2.2 Regular Format

Header

ID

Type

Length

Data

1 byte

2 bytes

1 byte

3 bytes

128 bytes max

2.2.1 Header

The header will be a '~' character.

2.2.2 ID

Default value is '00'.

2.2.3 Type

R - Command rejected (UPS à Computer)

A - Command accepted (UPS à Computer)

P - Polling command (Computer à UPS)

S - Set command (Computer à UPS)

D - Data returned (UPS à Computer)

2.2.4 Length

The length is the number of bytes of data passed.

2.2.5 Data

All data will be separated by ';'. If a variable value is not currently available, a ';' with no data should be placed in the variable location.


3. Regular Format Messages

3.1 Polling Commands

Command

Description

* AVL

Available Commands

* MNU

UPS Manufacturer

* MOD

UPS Model Name

* RAT

Rating(Nominal) Values

SDT

Shutdown Type

* STB

Battery Status

* STI

Input Status

* STO

Output Status

* STP

Bypass Status

* STA

Alarm Status

* TSR

Self Test Results

UBR

UPS Baud Rate

* UID

UPS Identification

* VER

UPS Firmware Version

TXV

Transfer Voltage

VSN

Voltage Sensitivity

* LET

Number of Outlet Relay

* SOL

Outlet Relay Status

TEL

Modem Phone Number

* BRD

Battery Replacement Date

ENV

Environment Information

ATT

Auto Test

ATX

ATX Reboot enable/disable

ARB

AC Fail & Restore Auto-Reboot enable/disable

TXF

Transfer Frequency

UBD

UPS Boot Delay

SOV

Select Output Voltage

BTV

Battery Test Time & Voltage



3.1.1 AVL

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

b19 b18 b17 b16 b15 b14 b13 b12 b11 b10 b9 b8 b7b6 b5 b4 b3 b2 b1 b0

Integer

20

1 = Available

0 = Not supported


Description: b0: UBD, b1: TXF, b2: ECO, b3: ATT, b4: BTT, b5: ATX, b6: ARB, b7: BUZ, b8: RST, b9: SDA, b10: SDR, b11: SDT, b12: TST, b13: UBR, b14: UID, b15: TXV, b16: VSN, b17: RON, b18: ROF, b19: RNF

3.1.2 MNU

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

Manufacturer

String

0 to 16



Description: The string identifies the manufacturer.

3.1.3 MOD

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

Model

String

0 to 16



Description: The string identifies the UPS model name.

3.1.4 RAT

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

* Rating Input Voltage

Integer

0 to 999

Volt


* Rating Input Frequency

Integer

0 to 999

0.1Hz

Rating Output Voltage

Integer

0 to 999

Volt

Rating Output Frequency

Integer

0 to 999

0.1Hz

* Rating VA

Integer

0 to 999999

VA

Rating Output Power

Integer

0 to 999999

Watt


Low Battery Time

Integer

0 to 99

Minute, time from low battery to low battery shutdown


Low Tx Voltage Point

Integer

0 to 999

Volt


High Tx Voltage Point

Integer

0 to 999

Volt


Low Tx Voltage Upper Bound

Integer

0 to 999

Volt


Low Tx Voltage Lower Bound

Integer

0 to 999

Volt


High Tx Voltage Upper Bound

Integer

0 to 999

Volt


High Tx Voltage Lower Bound

Integer

0 to 999

Volt


* UPS Type

Integer

0 to 4

0: On-Line

1: Off-Line

2: Line-Interactive

3: 3 Phase

4: Others


* Rating Battery Voltage

Integer

0 to 999

Volt


Low Tx Freq Point

Integer

0 to 999

0.1Hz


High Tx Freq Point

Integer

0 to 999

0.1Hz


Low Tx Freq Upper Bound

Integer

0 to 999

0.1Hz


Low Tx Freq Lower Bound

Integer

0 to 999

0.1Hz


High Tx Freq Upper Bound

Integer

0 to 999

0.1Hz


High Tx Freq Lower Bound

Integer

0 to 999

0.1Hz


Description: The Tx voltage









3.1.5 SDT

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

Shutdown Type

Integer

1 to 2

1 = UPS output

2 = UPS system


Description: default value is 2.

3.1.6 STB

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

* Battery Condition

Integer

0 to 2

0 = Good

1 = Weak

2 = Replace


* Battery Status

Integer

0 to 2

0 = OK

1 = Low

2 = Depleted

* Battery Charge

Integer

0 to 3

0 = Floating

1 = Charging

2 = Resting

3 = Discharging


Seconds on Battery

Integer

0 to 99999

Seconds


Estimated Minutes Remaining

Integer

0 to 9999

Estimated time from backup to low battery shutdown.


Estimated Charge Remaining

Integer

0 to 999

Estimated of percent battery charge remaining.


Battery Voltage

Integer

0 to 9999

0.1Volt


Battery Current

Integer

0 to 9999

0.1Amp


Temperature

Integer

0 to 999

Degree Celsius


* Battery Level

Integer

0 to 999

%


Description:

Battery Condition: If input power normal and battery normal then UPS replies Good(0). If input power normal and battery low then Weak(1) is replied.

Battery Status: The indication of the capacity remaining in the batteries.

Estimated Minutes Remaining: Estimated time from backup to low battery shutdown base on the current load.

Estimated Charge Remaining: An estimate of the battery charge remaining expressed as a percent of full charge.

Temperature: The temperature value that is measured in the UPS.

3.1.7 STI

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

* Input Num Lines(Phases)

Integer

0 to 9

Number of input lines


Input Frequency1

Integer

0 to 999

0.1Hz


Input Voltage1

Integer

0 to 9999

0.1Volt


Input Current1

Integer

0 to 9999

0.1Amp


Input Power1

Integer

0 to 99999

Watt


Input Frequency2

Integer

0 to 999

0.1Hz


Input Voltage2

Integer

0 to 9999

0.1Volt


Input Current2

Integer

0 to 9999

0.1Amp


Input Power2

Integer

0 to 99999

Watt


Input Frequency3

Integer

0 to 999

0.1Hz


Input Voltage3

Integer

0 to 9999

0.1Volt


Input Current3

Integer

0 to 9999

0.1Amp


Input Power3

Integer

0 to 99999

Watt


3.1.8 STO

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

* Output Source

Integer

0 to 5

0 = Normal

1 = Battery

2 = Bypass(Reserve)

3 = Reducing

4 = Boosting

5 = Manual Bypass

6 = Other

7 = None


Output Frequency

Integer

0 to 999

0.1Hz


* Output Num Lines(Phase)

Integer

0 to 9

Number of output lines


Output Voltage1

Integer

0 to 9999

0.1Volt


Output Current1

Integer

0 to 9999

0.1Amp


Output Power1

Integer

0 to 999999

Watt


* Output Load1

Integer

0 to 999

Percent


Output Voltage2

Integer

0 to 9999

0.1Volt


Output Current2

Integer

0 to 9999

0.1Amp


Output Power2

Integer

0 to 999999

Watt


Output Load2

Integer

0 to 999

Percent


Output Voltage3

Integer

0 to 9999

0.1Volt


Output Current3

Integer

0 to 9999

0.1Amp


Output Power3

Integer

0 to 999999

Watt


Output Load3

Integer

0 to 999

Percent


Description: Output Source: On-Line UPS status will be 0, 1, 2

Off-Line UPS status will be 1, 2, 3, 4

3 Phase UPS status will be 0, 1, 2, 5

The present source of output power.

3.1.9 STP

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

Bypass Frequency

Integer

0 to 999

0.1Hz


* Bypass Num Lines(Phase)

Integer

0 to 9

Number of bypass lines


Bypass Voltage1

Integer

0 to 9999

0.1Volt


Bypass Current1

Integer

0 to 9999

0.1Amp


Bypass Power1

Integer

0 to 999999

Watt


Bypass Voltage2

Integer

0 to 9999

0.1Volt


Bypass Current2

Integer

0 to 9999

0.1Amp


Bypass Power2

Integer

0 to 999999

Watt


Bypass Voltage3

Integer

0 to 9999

0.1Volt


Bypass Current3

Integer

0 to 9999

0.1Amp


Bypass Power3

Integer

0 to 999999

Watt


3.1.10 STA

Data: (UPS->Computer)

Name

Type

Range/Length

Comment

Software

Alarm Temperature

Integer

0 or 1

0 = OK

1 = Over Temperature


Alarm Input Bad

Integer

0 or 1

0 = OK

1 = Input Bad


Alarm Output Bad

Integer

0 or 1

0 = OK

1 = Output Bad


Alarm Overload

Integer

0 or 1

0 = OK

1 = Overload


Alarm Bypass Bad

Integer

0 or 1

0 = OK

1 = Bypass Bad


Alarm Output Off

Integer

0 or 1

0 = Output On

1 = Output Off


Alarm UPS Shutdown

Integer

0 or 1

0 = OK

1 = Shutdown


Alarm Charger Failure

Integer

0 or 1

0 = OK

1 = Charger Failed


Alarm System Off

Integer

0 or 1

0 = System On

1 = System Off


Alarm Fan Failure

Integer

0 or 1

0 = OK

1 = Fan Fault


Alarm Fuse Failure

Integer

0 or 1

0 = OK

1 = Fuse Fault


Alarm General Fault

Integer

0 or 1

0 = OK

1 = General Fault


Alarm Awaiting Power

Integer

0 or 1

0 = OK

1 = Awaiting Power


Alarm Shutdown Pending

Integer

0 or 1

0 = OK

1 = Shutdown Pending


Alarm Shutdown Imminent

Integer

0 or 1

0 = OK

1 = Shutdown Imminent


Buzzer Status

Integer

0 or 1

0 = UPS Buzzer Silence

1 = UPS Buzzer Alarm


Economic Mode

Integer

0 or 1

0 = No

1 = Yes


Alarm Inverter Bad

Integer

0 or 1

0 = No

1 = Yes


Emergency Power Off

Integer

0 or 1

0 = Off

1 = On


Buzzer State

Integer

0 or 1

0 = UPS Buzzer Disable

1 = UPS Buzzer Enable


Description:

Alarm Input Bad: An input condition is out of tolerance. This item is used to indicate the input power fail, a test condition should not set this item on.

Alarm Output Bad: An output condition (other than OutputOverload) is out of tolerance.

Alarm Overload: The output load exceeds the UPS output capacity.

Alarm Bypass Bad: The Bypass is out of tolerance.

Alarm Output Off: The UPS has shutdown as requested, i.e., the output is off.

Alarm UPS Shutdown: The entire UPS has shutdown as commanded.

Alarm Charger Failure: An uncorrected problem has been detected within the UPS charger subsystem.

Alarm System Off: The UPS system is in the off state. For example: The UPS get the input power but does not startup the system.

Alarm Fan Failure: The failure of one or more fans in the UPS has been detected.

Alarm Fuse Failure: The failure of one or more fuses has been detected.

Alarm Awaiting Power: The UPS output is off and the UPS is awaiting the return of input power.

Alarm Shutdown Pending: A shutdown UPS command SDA countdown is underway.

Alarm Shutdown Imminent: The UPS will turn off power to the load in less than 5 seconds; this may be either a timed shutdown or a low battery shutdown.

Alarm Buzzer Status: To indicate the UPS buzzer is silent or alarm.

Economic Mode: The UPS is in the economic mode (act like a off-line UPS).

Emergency Power Off: The User pressed the Emergency Power Off button.

Alarm Buzzer State: To indicate the UPS buzzer is enabled or disabled.

3.1.11 TSR

Data: (UPS->Computer)