powerpanel(8)

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

NAME

6       powerpanel - Driver for 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

EXTRA ARGUMENTS

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

VARIABLES

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

COMMANDS

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

SUPPORT STATUS

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

SHUTDOWN ISSUES

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

KNOWN PROBLEMS

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

AUTHORS

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