upscode2(8)

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

NAME

6       upscode2 - Driver for UPScode II compatible UPS equipment
7

NOTE

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

SUPPORTED HARDWARE

14       This driver supports UPS equipment which can be controlled via the
15       UPScode II protocol. This is mainly Fiskars, Powerware equipment, but
16       also some (probably OEM’ed) products from Compaq.
17

EXTRA ARGUMENTS

19       This driver supports the following optional settings in the
20       ups.conf(5):
21
22       manufacturer=value
23           Autodetection of this parameter is not possible yet (and it
24           probably never will be). Therefore, this user-defined string
25           accepts any name. The default is unknown.
26
27       input_timeout=value
28           The timeout waiting for a response from the UPS. Some UPS models
29           have shown to be rather slow, resulting in frequent messages about
30           empty responses from the UPS. If you see this, try increasing this
31           value.
32
33       output_pace=value
34           Delay between characters sent to the UPS. This was added for
35           completeness with the above parameter. It has not shown to be
36           needed yet.
37
38       baudrate=value
39           The default baudrate is 1200, which is the standard for the UPScode
40           II protocol.
41
42       full_update_timer=value
43           Number of seconds between collection of normative values.
44
45       use_crlf
46           Flag to set if commands towards to UPS need to be terminated with
47           CR-LF, and not just CR.
48
49       use_pre_lf
50           Flag to set if commands towards to UPS need to be introduced with
51           an LF. A Compaq T1500h is known to need this.
52

COMMANDS

54       The driver supports the following commands for those UPSes that support
55       them. The available commands are autodetected during initialization, so
56       you should check availability with upscmd -l.
57
58       •   test.panel.start - Start UPS self test
59
60       •   test.battery.start - Start battery self test
61
62       •   beeper.enable - Enable UPS beeper
63
64       •   beeper.disable - Disable UPS beeper
65
66       •   shutdown.return - Shut down in 1 second and wait for power to
67           return
68
69       •   shutdown.stayoff - Shut down in 1 seconds
70
71       •   shutdown.reboot - Shut down in 1 seconds and reboot after 1 minute
72
73       •   shutdown.reboot.graceful - Shut down in 20 seconds and reboot after
74           1 minute
75

NOTES

77       The Powerware UPS models that this driver has been tested against until
78       now have not returned a value for battery.charge. Therefore, the driver
79       will guestimate a value based on the nominal battery min/max and the
80       current battery voltage.
81

AUTHORS

83       •   Håvard Lygre <hklygre@online.no>
84
85       •   Niels Baggesen <niels@baggesen.net>
86