Network UPS Tools - SEC UPS Protocol

Message Format

All messages passed between the PC and the UPS look like

^<type><len><data>

where

`^`	The header character
`<type>`	The type of message being passed. The PC passes the following message types to the UPS: `P` → PC polls UPS (a query) `S` → PC sets UPS variable The UPS returns the following message types to the PC: `D` → UPS returns Data to PC (result of query) `0` → UPS rejected command sent from PC `1` → UPS accepted command sent from PC
`<len>`	3 chars - length of following data (zero padded decimal ascii)
`<data>`	`<len>` characters of data

Set Commands

Command	Description	Argument	Value
`ATR`	Enable/Disable Auto Restart	Enable/Disable Auto Restart	`0` → Enable `1` → Disable
`PSD`	Shutdown After Delay	Delay (seconds)	min: `1` max: `999`
`PSD`	Cancel Shutdown	`-1`
`RWD`	Reboot With Duration	Delay (seconds)	min: `1` max: `30000`
`SDA`	Set Shutdown Type	Shutdown Type	`0` → UPS Output `1` → UPS System
`STD`	Startup After Delay	Delay (seconds)	min: `1` max: `30000`
`TST`	UPS Test	UPS Test	`0` → General Test `1` → Battery Test `2` → Deep Battery Test
`TST`	Abort Test	`-1`
`UID`	Set Identification	Set Identification	a string
`NOM`	Set Nominal Input Voltage	Nominal Input Voltage	`0` - `110` `1` - `120` `2` - `208` `3` - `220` `4` - `230` `5` - `240`
`NOM,`	Set Nominal Input Frequency	Nominal Input Frequency (Hz)	`0` - `50` `1` - `60`
`NOM,,`	Set Nominal Output Voltage	Nominal Output Voltage (Volts)	`0` - `110` `1` - `120` `2` - `208` `3` - `220` `4` - `230` `5` - `240`
`NOM,,,`	Set Nominal Output Frequency	Nominal Output Frequency (Hz)	`0` - `50` `1` - `60`
`NOM,,,,`	Set Nominal Volt-Amp Rating	Nominal Volt-Amp Rating	a string
`NOM,,,,,`	Set Nominal Output Power	Nominal Output Power (Watts)	a string
`NOM,,,,,,`	Set Low Battery Time	Time (minutes)	`0` - `2` `1` - `5` `2` - `10`
`NOM,,,,,,,`	Set Audible Alarm State	Audible Alarm	`0` → Disabled `1` → Enabled `2` → Muted `3` → Low Battery
`NOM,,,,,,,,,,`	Set Battery Install Date	Enter date in `MMDDYYYY` format	a string
`NOM,,,,,,,,,,,`	Set Battery Life	Enter battery life in days	min: `0` max: `3000`
`NOM,,,,,,,,`	Set Low Voltage Transfer Point	Set the low voltage at which the UPS should switch to battery	min: `50` max: `240`
`NOM,,,,,,,,,`	Set High Voltage Xfer Pt.	Set the high voltage at which the UPS should switch to battery	min: `50` max: `240`
`UBR`	Set the UPS Baud Rate	UPS Baud Rate	`0` - `1200` `1` - `2400` `2` - `4800` `3` - `9600` `4` - `19200`
`STD`	Cancel Restart	`-1`

Query (Poll) Commands

Command	Field	Variable Name
`AP1`		Returns part 1 of a list of variable numbers that are supported by this UPS
`AP2`		Returns part 2 of a list of variable numbers that are supported by this UPS
`ATR`	1	Auto Restart
`MAN`	1	Manufacturer
`MOD`	1	Model
`NOM`	1	Nominal Input Voltage
	2	Nom Input Frequency
	3	Nom Output Voltage
	4	Nom Output Frequency
	5	Nom VA Rating
	6	Nominal Output Power
	7	Nom Low Battery Time
	8	Audible Alarm
	9	Low Volt Xfer Pt
	10	High Volt Xfer Pt
	11	Battery Installed
	12	Nominal Battery Life
`SDA`	1	Shutdown Type
`ST1`	1	Battery Condition
	2	Battery Status
	3	Battery Charge
	4	Seconds on Battery
	5	Estimated Minutes
	6	Estimated Charge
	7	Battery Voltage
	8	Battery Current
	9	Battery Temperature
`ST2`	1	Input Line Bads
	2	Input Num Lines
	3	Input Frequency
	4	Input Voltage
	5	Input Current
	6	Input Power
	7	Input Frequency 2
	8	Input Voltage 2
	9	Input Current 2
	10	Input Power 2
	11	Input Frequency 3
	12	Input Voltage 3
	13	Input Current 3
	14	Input Power 3
`ST3`	1	Output Source
	2	Output Frequency
	3	Output Num Lines
	4	Output Voltage
	5	Output Current
	6	Output Power
	7	Output Load
	8	Output Voltage 2
	9	Output Current 2
	10	Output Power 2
	11	Output Load 2
	12	Output Voltage 3
	13	Output Current 3
	14	Output Power 3
	15	Output Load 3
`ST4`	1	Bypass Frequency
	2	Bypass Num Lines
	3	Bypass Voltage
	4	Bypass Current
	5	Bypass Power
	6	Bypass Voltage 2
	7	Bypass Current 2
	8	Bypass Power 2
	9	Bypass Voltage 3
	10	Bypass Current 3
	11	Bypass Power 3
`ST5`	1	Temperature Alarm
	2	Input Bad Alarm
	3	Output Bad Alarm
	4	Overload Alarm
	5	Bypass Bad Alarm
	6	Output Off Alarm
	7	UPS Shutdown Alarm
	8	Charger Failure Alarm
	9	System Off Alarm
	10	Fan Failure Alarm
	11	Fuse Failure Alarm
	12	General Fault Alarm
	13	Awaiting Power Alarm
	14	Shutdown Pending Alm
	15	Shutdown Imminent Alm
`STR`	1	Test Results Summary
`STR`	2	Test Results Detail
`UID`	1	UPS Identification
`VER`	1	Software Version

Variables

Number	Variable	Units	Command	Field	Value
1	Awaiting Power Alarm		`ST5`	13	`0` → Normal `1` → Alarm
2	Bypass Bad Alarm		`ST5`	5	`0` → Normal `1` → Alarm
3	Charger Failure Alarm		`ST5`	8	`0` → Normal `1` → Alarm
4	Fan Failure Alarm		`ST5`	10	`0` → Normal `1` → Alarm
5	Fuse Failure Alarm		`ST5`	11	`0` → Normal `1` → Alarm
6	General Fault Alarm		`ST5`	12	`0` → Normal `1` → Alarm
7	Input Bad Alarm		`ST5`	2	`0` → Normal `1` → Alarm
8	Output Bad Alarm		`ST5`	3	`0` → Normal `1` → Alarm
9	Output Off Alarm		`ST5`	6	`0` → Normal `1` → Alarm
10	Overload Alarm		`ST5`	4	`0` → Normal `1` → Alarm
11	Shutdown Imminent Alm		`ST5`	15	`0` → Normal `1` → Alarm
12	Shutdown Pending Alm		`ST5`	14	`0` → Normal `1` → Alarm
13	System Off Alarm		`ST5`	9	`0` → Normal `1` → Alarm
14	Temperature Alarm		`ST5`	1	`0` → Normal `1` → Alarm
15	UPS Shutdown Alarm		`ST5`	7	`0` → Normal `1` → Alarm
16	Audible Alarm		`NOM`	8	`0` → Disabled `1` → Enabled `2` → Muted `3` → Low Battery
17	Auto Restart		`ATR`	1	`0` → Enable `1` → Disable
18	Battery Charge		`ST1`	3	`0` → Floating `1` → Charging `2` → Resting `3` → Discharging
19	Battery Condition		`ST1`	1	`0` → Good `1` → Weak `2` → Replace
20	Battery Current	A/10	`ST1`	8	<a number>
21	Battery Installed		`NOM`	11	<a string>
22	Battery Status		`ST1`	2	`0` → Normal `1` → Low `2` → Depleted
23	Battery Temperature	C	`ST1`	9	<a number>
24	Battery Voltage	V/10	`ST1`	7	<a number>
25	Bypass Current	A/10	`ST4`	4	<a number>
26	Bypass Current 2	A/10	`ST4`	7	<a number>
27	Bypass Current 3	A/10	`ST4`	10	<a number>
28	Bypass Frequency	Hz/10	`ST4`	1	<a number>
29	Bypass Num Lines		`ST4`	2	<a number>
30	Bypass Power	W	`ST4`	5	<a number>
31	Bypass Power 2	W	`ST4`	8	<a number>
32	Bypass Power 3	W	`ST4`	11	<a number>
33	Bypass Voltage	V/10	`ST4`	3	<a number>
34	Bypass Voltage 2	V/10	`ST4`	6	<a number>
35	Bypass Voltage 3	V/10	`ST4`	9	<a number>
36	Estimated Charge	%	`ST1`	6	<a number>
37	Estimated Minutes		`ST1`	5	<a number>
38	High Volt Xfer Pt	V	`NOM`	10	<a string>
39	UPS Identification		`UID`	1	<a string>
40	Input Current	A/10	`ST2`	5	<a number>
41	Input Current 2	A/10	`ST2`	9	<a number>
42	Input Current 3	A/10	`ST2`	13	<a number>
43	Input Frequency	Hz/10	`ST2`	3	<a number>
44	Input Frequency 2	Hz/10	`ST2`	7	<a number>
45	Input Frequency 3	Hz/10	`ST2`	11	<a number>
46	Input Line Bads		`ST2`	1	<a number>
47	Input Num Lines		`ST2`	2	<a number>
48	Input Power	W	`ST2`	6	<a number>
49	Input Power 2	W	`ST2`	10	<a number>
50	Input Power 3	W	`ST2`	14	<a number>
51	Input Voltage	V/10	`ST2`	4	<a number>
52	Input Voltage 2	V/10	`ST2`	8	<a number>
53	Input Voltage 3	V/10	`ST2`	12	<a number>
54	Low Volt Xfer Pt	V	`NOM`	9	<a string>
55	Manufacturer		`MAN`	1	<a string>
56	Model		`MOD`	1	<a string>
57	Nominal Battery Life	Days	`NOM`	12	<a string>
58	Nom Input Frequency	Hz/10	`NOM`	2	<a number>
59	Nominal Input Voltage	V	`NOM`	1	<a string>
60	Nom Low Battery Time		`NOM`	7	<a string>
61	Nom Output Frequency	Hz/10	`NOM`	4	<a number>
62	Nominal Output Power	W	`NOM`	6	<a string>
63	Nom Output Voltage	V	`NOM`	3	<a string>
64	Nom VA Rating	VA	`NOM`	5	<a string>
65	Output Current	A/10	`ST3`	5	<a number>
66	Output Current 2	A/10	`ST3`	9	<a number>
67	Output Current 3	A/10	`ST3`	13	<a number>
68	Output Frequency	Hz/10	`ST3`	2	<a number>
69	Output Load	%	`ST3`	7	<a number>
70	Output Load 2	%	`ST3`	11	<a number>
71	Output Load 3	%	`ST3`	15	<a number>
72	Output Num Lines		`ST3`	3	<a number>
73	Output Power	W	`ST3`	6	<a number>
74	Output Power 2	W	`ST3`	10	<a number>
75	Output Power 3	W	`ST3`	14	<a number>
76	Output Source		`ST3`	1	`0` → Normal `1` → On Battery `2` → On Bypass `3` → Reducing `4` → Boosting `5` → Other
77	Output Voltage	V/10	`ST3`	4	<a number>
78	Output Voltage 2	V/10	`ST3`	8	<a number>
79	Output Voltage 3	V/10	`ST3`	12	<a number>
80	Reboot With Duration		`RWD`	1	<a number>
81	Seconds on Battery		`ST1`	4	<a number>
82	Shutdown Type		`SDA`	1	`0` → UPS Output `1` → UPS System
83	Shutdown After Delay		`STD`	1	<a number>
84	Software Version		`VER`	1	<a string>
85	Startup After Delay		`STD`	1	<a number>
86	Test Results Detail		`STR`	2	<a string>
87	Test Results Summary		`STR`	1	`0` → No Test `1` → Passed `2` → In Progress `3` → GenTestFail `4` → BattTstFail `5` → DeepTstFail
88	Test Type		`TST`	1	<a number>
89	Baud Rate		`UBR`	1	<a number>