powerpanel(8)

1POWERPANEL(8)                     NUT Manual                     POWERPANEL(8)
2
3
4

NAME

6       powerpanel - Driver for serial PowerPanel Plus compatible UPS equipment
7

NOTE

9       This man page only documents the hardware-specific features of the
10       powerpanel driver. For information about the core driver, see
11       nutupsdrv(8).
12

SUPPORTED HARDWARE

14       This driver supports CyberPower BC1200, PR2200 and many other similar
15       devices, both for the text and binary protocols. The driver will
16       autodetect which protocol is used.
17
18       If your Cyber Power Systems UPS has a USB port, you may wish to use the
19       usbhid-ups(8) driver. The snmp-ups(8) driver supports several network
20       cards via SNMP.
21

EXTRA ARGUMENTS

23       This driver supports the following optional settings in ups.conf(5):
24
25       protocol=[text,binary]
26           Override the default autodetection of the protocol.
27
28       manufacturer=value
29           If you don’t like the autodetected value, you can override this by
30           setting it here.
31
32       model=value
33           Like manufacturer above.
34
35       serial=value
36           Like manufacturer above.
37
38       ondelay=value
39           Time to wait before switching on the UPS (1 - 9999 minutes,
40           0=indefinite). Only available with the text protocol driver (see
41           Support Status).
42
43       offdelay=value
44           Time to wait before shutting down the UPS (6 - 600 seconds). Values
45           below 60 seconds will be truncated to 6 seconds intervals, values
46           above 60 seconds to 60 seconds intervals. Only available with the
47           text protocol driver (see Support Status).
48

VARIABLES

50       Depending on the type of your UPS unit, some of the following variables
51       may be changed with upsrw(8). If the driver can’t read a variable from
52       the UPS, it will not be made available.
53
54       input.transfer.high
55           writable: high transfer voltage point in V
56
57       input.transfer.low
58           writable: low transfer voltage point in V
59
60       battery.charge.low
61           writable: remaining battery charge percentage for low battery
62           warning
63
64       output.voltage.nominal
65           writable: nominal output voltage in V
66
67       ups.start.battery
68           writable: allow cold start from battery
69

COMMANDS

71       Depending on the type of your UPS unit, some of the following commands
72       may be available.
73
74       •   test.battery.start.quick, test.battery.stop
75
76       •   beeper.enable, beeper.disable, beeper.toggle
77
78       •   shutdown.return, shutdown.reboot, shutdown.stayoff
79
80       On many devices, these commands are unreliable, so before using them
81       you must verify that these work as expected (see Shutdown Issues).
82
83       •   shutdown.stop
84

SUPPORT STATUS

86       Vendor support is absent for this driver, so if you need some features
87       that are currently not available, provide ample documentation on what
88       the driver should sent to the UPS in order to make this work. If more
89       information would be available on the binary protocol, it would
90       probably be possible to make ondelay and offdelay configurable. So far,
91       nobody has taken the time to investigate what we should tell the UPS to
92       make this work, and CyberPower isn’t willing to share this with us.
93

SHUTDOWN ISSUES

95       If the shutdown.return command on your UPS doesn’t seem to work,
96       chances are that your UPS is an older model. Try a couple of different
97       settings for offdelay. If no value in the range 6..600 works, your UPS
98       likely doesn’t support this. In order to get the expected behaviour, it
99       requires shutdown.stayoff (when on battery) and shutdown.reboot (when
100       on mains). The driver will automatically fallback to these commands if
101       shutdown.return fails, and tries to detect which one should be used
102       when called with the -k option (or through upsdrvctl shutdown).
103
104       This isn’t bullet-proof, however, and you should be prepared that the
105       power will either not be shutdown or that it doesn’t return when the
106       power comes back. All models supported by the binary protocol and many
107       supported through the text protocol are affected by this.
108

KNOWN PROBLEMS

110       The CyberPower OP series don’t offer direct voltage, charge, frequency
111       and temperature readings. Instead, they will return a binary value that
112       needs conversion to the actual value.
113
114       The exact conversion needed is unknown at the time of this writing,
115       hence an estimation was made based om readings from actual devices.
116       This may (probably will) be off, possibly a lot. Unless you can tell us
117       the exact mapping between values from the UPS and actual readings,
118       don’t bother to complain. We’ve done the best we can based on the
119       limited information available. Remember, a UPS isn’t a measuring
120       instrument.
121

AUTHORS

123       Arjen de Korte <arjen@de-korte.org>, Doug Reynolds <mav@wastegate.net>
124