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

NAME

6       blazer_usb - Driver for Megatec/Q1 protocol USB based UPS equipment
7

NOTE

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

SUPPORTED HARDWARE

13       The blazer driver is known to work with various UPSes from Blazer,
14       Energy Sistem, Fenton Technologies, General Electric, Mustek and many
15       others. The NUT compatibility table lists all the known supported
16       models. Keep in mind, however, that other models not listed there may
17       also be supported, but haven’t been tested.
18
19       All devices with a serial interface (use the blazer_ser driver) and
20       many with a USB interface (use the blazer_usb driver) are supported.
21

EXTRA ARGUMENTS

23       You may need to override or provide defaults for some values, depending
24       on the make and model of your UPS. The following are the ones that most
25       likely will need changing (see ups.conf(5)):
26
27       default.battery.voltage.high = value
28           Maximum battery voltage that is reached after about 12 to 24 hours
29           charging. If you want the driver to report a guesstimated
30           battery.charge, you need to specify this (see BATTERY CHARGE).
31
32       default.battery.voltage.low = value
33           Minimum battery voltage just before the UPS automatically shuts
34           down. If you want the driver to report a guesstimated
35           battery.charge, you need to specify this (see BATTERY CHARGE).
36
37       default.battery.voltage.nominal = value,
38       override.battery.voltage.nominal = value
39           Some devices show a wrong nominal battery voltage (or none at all),
40           so you may need to override or set a default value.
41
42       override.battery.packs = value
43           Some devices report a part of the total battery voltage. For
44           instance, if battery.voltage.nominal is 24 V, but it reports a
45           battery.voltage of around 2 V, the number of battery.packs to
46           correct this reading would be 12. The driver will attempt to detect
47           this automatically, but if this fails somehow, you may want to
48           override this value.
49
50       ondelay = value
51           Time to wait before switching on the UPS (minutes). Note that a
52           value below 3 minutes, may cause earlier firmware versions to not
53           switch on automatically, so it defaults to 3 minutes. The
54           acceptable range is 0..9999 minutes.
55
56       offdelay = value
57           Time to wait before shutting down the UPS (seconds). This value is
58           truncated to units of 6 seconds (less than 60 seconds) or 60
59           seconds (more than 60 seconds). Defaults to 30 seconds. The
60           acceptable range is 12..600 seconds.
61
62       norating
63           Some UPSes will lock up if you attempt to read rating information
64           from them. Setting this flag will make the driver skip this step.
65
66       novendor
67           Some UPSes will lock up if you attempt to read vendor information
68           from them. Setting this flag will make the driver skip this step.
69
70       protocol = string
71           Skip autodetection of the protocol to use and only use the one
72           specified. Supported values megatec, megatec/old, mustek and zinto.
73
74       runtimecal = value,value,value,value
75           Parameter used in the (optional) runtime estimation. This takes two
76           runtimes at different loads. Typically, this uses the runtime at
77           full load and the runtime at half load. For instance, if your UPS
78           has a rated runtime of 240 seconds at full load and 720 seconds at
79           half load, you would enter
80
81               runtimecal = 240,100,720,50
82
83           The first load should always be higher than the second. If you have
84           values available for loads other than 100 and 50 % respectively,
85           you can use those too, but keep them spaced apart as far as
86           reasonably possible. Just don’t get too close to no load
87           (prediction of runtime depends more on idle load for the battery
88           then).
89
90       chargetime = value
91           The time needed to fully recharge the battery after being fully
92           discharged. If not specified, the driver defaults to 43200 seconds
93           (12 hours). Only used if runtimecal is also specified.
94
95       idleload = value
96           Minimum battery load used by the driver to estimate the runtime. If
97           not specified, the driver defaults to 10%. Only used if runtimecal
98           is also specified.
99
100   USB INTERFACE ONLY
101       vendorid = regex, productid = regex, vendor = regex, product = regex,
102       serial = regex
103           Select a specific UPS, in case there is more than one connected via
104           USB. Each option specifies an extended regular expression (see
105           regex(7)) that must match the UPS’s entire vendor/product/serial
106           string (minus any surrounding whitespace), or the whole 4-digit
107           hexadecimal code for vendorid and productid. Try -DD for finding
108           out the strings to match.
109
110           Examples:
111
112           ·   -x vendor="Foo.Corporation.*"
113
114           ·   -x vendorid=051d* (APC)
115
116           ·   -x product=".*(Smart|Back)-?UPS.*"
117
118       bus = regex
119           Select a UPS on a specific USB bus or group of busses. The argument
120           is a regular expression that must match the bus name where the UPS
121           is connected (e.g. bus="002", bus="00[2-3]").
122
123       subdriver = string
124           Select a serial-over-USB subdriver to use. You have a choice
125           between phoenix, ippon, cypress, and krauler. When using this
126           option, it is mandatory to also specify the vendorid and productid.
127
128       langid_fix = value
129           Apply the language ID workaround to the krauler subdriver. This is
130           mandatory for some devices to work (LDLC, Dynamix and others). You
131           must to provide value (0x409 or 0x4095), according to your device
132           entry in NUT hardware compatibility list (HCL).
133

UPS COMMANDS

135       This driver supports some instant commands (see upscmd(8)):
136
137       beeper.toggle
138           Toggle the UPS beeper. (Not available on some hardware.)
139
140       load.on
141           Turn on the load immediately.
142
143       load.off
144           Turn off the load immediately (see KNOWN PROBLEMS).
145
146       shutdown.return
147           Turn off the load and return when power is back. Uses the timers
148           defined by ondelay and offdelay.
149
150       shutdown.stayoff
151           Turn off the load and remain off (see KNOWN PROBLEMS). Uses the
152           timer defined by offdelay.
153
154       shutdown.stop
155           Stop a shutdown in progress.
156
157       test.battery.start.deep
158           Perform a long battery test (Not available on some hardware.)
159
160       test.battery.start.quick
161           Perform a (10 second) battery test.
162
163       test.battery.start value
164           Perform a battery test for the duration of value minutes.
165
166       test.battery.stop
167           Stop a running battery test (not available on some hardware.)
168

BATTERY CHARGE

170       Due to popular demand, this driver will report a guesstimated
171       battery.charge and optionally battery.runtime, provided you specified a
172       couple of the EXTRA ARGUMENTS listed above.
173
174       If you specify both battery.voltage.high and battery.voltage.low in
175       ups.conf(5), but don’t enter runtimecal, it will guesstimate the state
176       of charge by looking at the battery voltage alone. This is not reliable
177       under load, as this only gives reasonably accurate readings if you
178       disconnect the load, let the battery rest for a couple of minutes and
179       then measure the open cell voltage. This just isn’t practical if the
180       power went out and the UPS is providing power for your systems.
181
182                                battery.voltage - battery.voltage.low
183           battery.charge =  ------------------------------------------ x 100 %
184                             battery.voltage.high - battery.voltage.low
185
186       There is a way to get better readings without disconnecting the load
187       but this requires one to keep track on how much (and how fast) current
188       is going in- and out of the battery. If you specified the runtimecal,
189       the driver will attempt to do this. Note however, that this heavily
190       relies on the values you enter and that the UPS must be able to report
191       the load as well. There are quite a couple of devices that report 0 %
192       (or any other fixed value) at all times, in which case this obviously
193       doesn’t work.
194
195       The driver also has no way of determining the degradation of the
196       battery capacity over time, so you’ll have to deal with this yourself
197       (by adjusting the values in runtimecal). Also note that the driver
198       guesses the initial state of charge based on the battery voltage, so
199       this may be less than 100 %, even when you are certain that they are
200       full. There is just no way to reliably measure this between 0 and 100 %
201       full charge.
202
203       This is better than nothing (but not by much). If any of the above
204       calculations is giving you incorrect readings, you are the one that put
205       in the values in ups.conf(5), so don’t complain with the author. If you
206       need something better, buy a UPS that reports battery.charge and
207       battery.runtime all by itself without the help of a NUT driver.
208

NOTES FOR THE PREVIOUS USER OF MEGATEC DRIVERS

210       The blazer drivers having replaced the megatec ones, some configuration
211       changes may be required by users switching to blazer.
212
213       Part of this, the following megatec options, in ups.conf, have to be
214       changed:
215
216       battvolts
217           You need to use default.battery.voltage.high and
218           default.battery.voltage.low
219
220       dtr and rts
221           You need to use cablepower
222
223       ignoreoff
224           This parameter can simply be discarded, since it was a wrong
225           understanding of the specification.
226

KNOWN PROBLEMS

228       Some UPS commands aren’t supported by all models. In most cases, the
229       driver will send a message to the system log when the user tries to
230       execute an unsupported command. Unfortunately, some models don’t even
231       provide a way for the driver to check for this, so the unsupported
232       commands will silently fail.
233
234       Both the load.off and shutdown.stayoff instant commands are meant to
235       turn the load off indefinitely. However, some UPS models don’t allow
236       this.
237
238       Some models report a bogus value for the beeper status (will always be
239       enabled or disabled). So, the beeper.toggle command may appear to have
240       no effect in the status reported by the driver when, in fact, it is
241       working fine.
242
243       The temperature and load value is known to be bogus in some models.
244

AUTHORS

246       Arjen de Korte <adkorte-guest at alioth.debian.org>, Alexander Gordeev
247       <lasaine at lvk.cs.msu.su>
248

SEE ALSO

250       blazer_ser(8), nutupsdrv(8), upsc(8), upscmd(8), upsrw(8)
251
252   Internet Resources:
253       The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
254
255       The NUT HCL: http://www.networkupstools.org/stable-hcl.html
256
257
258
259Network UPS Tools 2.7.3.          12/29/2015                     BLAZER_USB(8)
Impressum