← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nut/saucy

« back to all changes in this revision

Viewing changes to man/newhidups.8

  • Committer: Bazaar Package Importer
  • Author(s): Arnaud Quette
  • Date: 2004-05-28 13:10:01 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040528131001-yj2m9qcez4ya2w14
Tags: upstream-1.4.2
Import upstream version 1.4.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/newhidups.8
 
1
.TH HIDUPS 8 "Wed Mar 10 2004" "" "Network UPS Tools (NUT)"
 
2
.SH NAME
 
3
hidups \- Experimental Multi-HID Driver for USB/HID UPS equipment
 
4
.SH NOTE
 
5
This man page only documents the hardware-specific features of the
 
6
newhidups driver.  For information about the core driver, see
 
7
\fBnutupsdrv\fR(8).
 
8
 
 
9
This is an experimental driver.  Not all features may work correctly.
 
10
 
 
11
.SH SUPPORTED HARDWARE
 
12
.B newhidups
 
13
is an experiment to bring USB UPS monitoring to NUT on all platform
 
14
supporting USB through libusb. It should detect any UPS that uses
 
15
the HID power device class, but the amount of data will vary depending
 
16
on the manufacturer and model.
 
17
 
 
18
At the present time, newhidups only supports MGE UPS SYSTEMS models.
 
19
 
 
20
On Linux, you will need at least a 2.4.25 or 2.6.2 kernel
 
21
to disable hiddev support and avoid conflict. Otherwise,
 
22
prefer to use hidups driver.
 
23
 
 
24
.SH EXTRA ARGUMENTS
 
25
This driver supports the following optional settings in the 
 
26
\fBups.conf\fR(5):
 
27
 
 
28
.IP "offdelay=\fInum\fR"
 
29
Set the timer before the UPS is turned off after the kill power command is
 
30
sent (via the \fI-k\fR switch).
 
31
The default value is 20 (in seconds), and MUST BE LOWER than ondelay.
 
32
 
 
33
.IP "ondelay=\fInum\fR"
 
34
Set the timer for the UPS to switch on in case the power returns after the
 
35
kill power command had been sent but before the actual switch off. This
 
36
ensures the machines connected to the UPS are, in all cases, rebooted after
 
37
a power failure.
 
38
The default value is 30 (in seconds), and MUST BE GREATER than offdelay.
 
39
 
 
40
.SH EXPERIMENTAL DRIVER
 
41
This driver has been tagged experimental, even if it has been reported
 
42
to be stable. Thus it is not suitable for production systems and it is
 
43
not built by default. This is mainly due to the fact that it is a
 
44
new driver, and that it will be replaced soon with a version using
 
45
an external HID library (libhid), as opposed to the current
 
46
internal ripped version.
 
47
 
 
48
.SH INSTALLATION
 
49
This driver is not built by default.  You can build it by using
 
50
"make usb", and install it using "make install-usb". Note that
 
51
it will also install other USB drivers.
 
52
 
 
53
.SH IMPLEMENTATION
 
54
newhidups only support 1 UPS at this time. You can put the
 
55
"auto" value for port in \fBups.conf\fR, i.e.:
 
56
 
 
57
.nf
 
58
        [newhidups]
 
59
                driver = newhidups
 
60
                port = auto
 
61
.fi
 
62
 
 
63
.SH KNOWN ISSUES AND BUGS
 
64
.SS "Repetitive stale status - Loss of communication"
 
65
 
 
66
Some models might report repetitive stale status, for
 
67
1 sec or less. This is due to a small and temporary
 
68
flood of the UPS �controler.
 
69
 
 
70
To solve this point, simply add "pollinterval=15" in
 
71
ups.conf. Also change the value of MAXAGE to 20 in
 
72
upsd.conf, and optionally DEADTIME to 20 in upsmon.conf.
 
73
You might adapt these values according to your tests
 
74
and configuration.
 
75
 
 
76
.SH AUTHORS
 
77
.SS Sponsored by MGE UPS SYSTEMS <http://opensource.mgeups.com/>
 
78
Arnaud Quette
 
79
 
 
80
.SH SEE ALSO
 
81
 
 
82
.SS The core driver:
 
83
\fBnutupsdrv\fR(8)
 
84
 
 
85
.SS Internet resources:
 
86
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/