upscode2(8)

1UPSCODE2(8)                 Network UPS Tools (NUT)                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  nutups‐
11       drv(8).
12
13

SUPPORTED HARDWARE

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

EXTRA ARGUMENTS

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

UPSCMD

64       The driver supports the following commands for those UPSen that support
65       them.   The  available commands are autodetected during initialization,
66       so you should check availability with upscmd -l.
67
68       test.panel.start ‐ Start UPS self test
69
70       test.battery.start ‐ Start battery self test
71
72       beeper.on ‐ Enable UPS beeper
73
74       beeper.off ‐ Disable UPS beeper
75
76       shutdown.return ‐ Shut down in 1 second and wait for power to return
77
78       shutdown.stayoff ‐ Shut down in 1 seconds
79
80       shutdown.reboot ‐ Shut down in 1 seconds and reboot after 1 minute
81
82       shutdown.reboot.graceful ‐ Shut down in 20 seconds and reboot  after  1
83       minute
84
85

NOTES

87       The Powerware UPS models that this driver has been tested against until
88       now has not returned a value for battery.charge. Therefore  the  driver
89       will  guesstimate  a value based on the nominal battery min/max and the
90       current battery voltage.
91
92

AUTHOR

94       Håvard Lygre <hklygre@online.no>, Niels Baggesen <niels@baggesen.net>
95
96