1
.TH MEGATEC_USB 8 "Sun Mar 4 2007" "" "Network UPS Tools (NUT)"
3
megatec_usb \- Driver for Megatec protocol based USB UPS equipment
5
This man page only documents the hardware\(hyspecific features of the
6
megatec_usb driver. For information about the core driver, see
9
\fBNote.\fR This driver is experimental at the moment. It is currently being
10
worked on and may change over time. However, it is stable in execution and
13
.SH SUPPORTED HARDWARE
15
The megatec_usb driver is known to work with various UPSes from Krauler, Agiler,
16
and Upsonic (Ablerex interface). Others that use the Megatec protocol
17
may work, but haven't been tested.
19
This driver supports the USB versions of UPSs, if you have only serial interface then use the
20
straight \fBmegatec\fR(8) driver.
22
If you find that this driver does not work, and you are sure that your hardware speaks megatec protocol,
23
then you can easily extend this driver. However, you will need to do some analysis of the
24
commands that are sent to the UPS. Please see the forums for discussions on this and how
25
to extend this driver.
27
.SH EXTENSIONS TO MEGATEC
29
This driver extends the standard \fBmegatec\fR(8) driver to work with certain UPSes that have
30
a USB interface. These devices do not obey the normal rules for HID USB devices and therefore the
31
\fBnewhidups\fR(8) driver will not work for them.
33
This driver takes the standard serial interface and passes this over USB to the UPS.
34
This means that most, but not all, commands available for the serial driver will
35
work. For Krauler, Agiler, and Upsonic (with Ablerex interface) UPSes
36
it appears to give very similar results to the serial interface. The
37
driver supports monitoring most of the usual UPS variables, and also
38
supports automatic shutdown.
42
.IP "mfr=\fIstring\fR"
44
Optional. Specify the UPS manufacturer name.
46
.IP "model=\fIstring\fR"
48
Optional. Specify the UPS model name.
50
.IP "serial=\fIstring\fR"
52
Optional. Specify the UPS serial number.
54
.IP "lowbatt=\fIfloat\fR"
56
Optional. Low battery level (%). Overrides the hardware default level.
58
.IP "ondelay=\fIint\fR"
60
Optional. Delay before the UPS is turned back on (minutes).
62
.IP "offdelay=\fIint\fR"
64
Optional. Delay before the UPS is turned off (minutes).
66
.IP "battvolts=\fIfloat\fR:\fIfloat\fR"
68
Optional. The battery voltage interval <empty:full> (volts).
70
.IP "vendor=\fIregex\fR"
71
.IP "product=\fIregex\fR"
72
.IP "vendorid=\fIregex\fR"
73
.IP "productid=\fIregex\fR"
75
Select a specific UPS, in case there is more than one connected via
76
USB. Each option specifies an extended regular expression (see
77
\fBregex(7)\fR) that must match the UPS's entire vendor/product/serial
78
string (minus any surrounding whitespace), or the whole 4-digit
79
hexadecimal code for vendorid and productid. Try \fB-DD\fR for
80
finding out the strings to match.
84
\fB-x vendor="Foo.Corporation.*"\fR
86
\fB-x vendorid=05b8\fR (Agiler)
88
\fB-x product=".*(Smart|Back)-?UPS.*"\fR
92
Select a UPS on a specific USB bus or group of busses. The argument is
93
a regular expression that must match the bus name where the UPS is
94
connected (e.g. bus="002", bus="00[2-3]").
96
.IP "subdriver=\fIstring\fR"
98
Select a serial-over-USB subdriver to use. You have a choice between "agiler" and "krauler" subdrivers currently.
102
This driver supports some extra commands (see \fBupscmd\fR(8)):
105
Toggle the UPS beeper. (Not available on some hardware.)
108
Turn on the load immediately.
111
Turn off the load immediately. (Not yet supported)
113
.IP reset.input.minmax
114
Reset minimum and maximum input voltage status. (Not yet supported)
117
Restarts the UPS watchdog timeout. The watchdog is started if it isn't running,
118
which means the UPS shuts down one minute after this command is executed for
119
the last time, restarting one minute afterwards. To cancel the watchdog, run
120
the "shutdown.stop" command.
123
Turn off the load and return when power is back. (Not yet supported)
126
Turn off the load and remain off. (Not yet supported)
129
Stop a shutdown in progress.
131
.IP test.battery.start.deep
132
Perform a long battery test (Not available on some hardware.)
134
.IP test.battery.start
135
Perform a (10 second) battery test.
137
.IP test.battery.stop
138
Stop a running battery test. (Not available on some hardware.)
142
The behavior of the driver can be controlled by some user definable
143
variables (see \fBupsrw\fR(8)):
145
.IP ups.delay.shutdown
146
Interval to wait after shutdown with delay command (seconds)
149
Interval to wait before (re)starting the load (seconds)
153
The battery charge (%) value is only a best-effort calculation and may be
154
incorrect, or non-existant, for some UPS models. In any case, you can always
155
resort to finding the voltages at which the battery becomes fully discharged
156
and fully charged, and specify them manually using the "battvolts" option.
157
If you do this, please notify the author of this driver.
159
Some UPS commands aren't supported by all models. In most cases, the driver
160
will send a message to the system log when the user tries to execute an
161
unsupported command. Unfortunately, some models don't even provide a way for
162
the driver to check for this, so the unsupported commands will silently
165
Some models report a bogus value for the beeper status (will always be
166
"enabled" or "disabled"). So, the "beeper.toggle" command may appear to have
167
no effect in the status reported by the driver when, in fact, it is working
170
The temperature value is also known to be bogus in some models.
174
Carlos Rodrigues <carlos.efr at mail.telepac.pt>
176
Andrey Lelikov <nut-driver at lelik.org>
178
Alexander Gordeev <lasaine at lvk.cs.msu.su>
180
Jon Gough <jon.gough at eclipsesystems.com.au>
184
\fBmegatec\fR(8), \fBnutupsdrv\fR(8), \fBupsc\fR(8), \fBupscmd\fR(8), \fBupsrw\fR(8)
186
.SS Internet resources:
187
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/