1NUTDRV_QX(8) NUT Manual NUTDRV_QX(8)
2
6 nutdrv_qx - Driver for Q* protocol serial and USB based UPS equipment
7
9 This man page only documents the hardware-specific features of the
10 nutdrv_qx driver. For information about the core driver, see
11 nutupsdrv(8).
12
14 The nutdrv_qx driver is known to work with various UPSes from Armac,
15 Blazer, Energy Sistem, Fenton Technologies, General Electric, Hunnox,
16 Masterguard, Mustek, Powercool, Voltronic Power (rebranded by many,
17 many - have I said many? - others...
18 Long story short: if your UPS came with a software called Viewpower,
20 chances are high that it works with this driver with one of the
21 voltronic* protocols or with the mecer one), and many others.
22 The NUT compatibility table lists all the known supported models. Keep
24 in mind, however, that other models not listed there may also be
25 supported, but haven’t been tested or reported back.
26 All devices with a serial interface and many with a USB interface are
28 supported.
29
31 You may need to override or provide defaults for some values, depending
32 on the make and model of your UPS.
33 The following are the ones that most likely will need changing (see
35 ups.conf(5)):
36 ondelay = value
38 Time to wait before switching on the UPS (seconds). This value is
39 truncated to units of 60 seconds.
40 Note that a value below 3 minutes, may cause earlier firmware
42 versions to not switch on automatically, so it defaults to 3
43 minutes (i.e. 180 seconds).
44 This option provides a default value for ups.delay.start that will
46 then be used by the driver in the automatic shutdown sequence (i.e.
47 calling the driver with the -k option, calling upsdrvctl(8) with
48 the shutdown option or when the FSD flag is set and upsmon(8)
49 enters its shutdown sequence): however you can change this value
50 ‘on the fly’ for the actual session, only for the use with instant
51 commands, setting ups.delay.start with upsrw(8).
52 offdelay = value
54 Time to wait before shutting down the UPS (seconds). This value is
55 truncated to units of 6 seconds (less than 60 seconds) or 60
56 seconds (more than 60 seconds). Defaults to 30 seconds.
57 This option provides a default value for ups.delay.shutdown that
59 will then be used by the driver in the automatic shutdown sequence
60 (i.e. calling the driver with the -k option, calling upsdrvctl(8)
61 with the shutdown option or when the FSD flag is set and upsmon(8)
62 enters its shutdown sequence): however you can change this value
63 ‘on the fly’ for the actual session, only for the use with instant
64 commands, setting ups.delay.shutdown with upsrw(8).
65 stayoff
67 If you set stayoff in ups.conf(5) when FSD arises the UPS will call
68 a shutdown.stayoff shutting down after ups.delay.shutdown seconds
69 and won’t return (see KNOWN PROBLEMS), otherwise (standard
70 behaviour) the UPS will call shutdown.return shutting down after
71 ups.delay.shutdown seconds and then turn on after ups.delay.start
72 seconds (if mains meanwhile returned).
73 protocol = string
75 Skip autodetection of the protocol to use and only use the one
76 specified. Supported values: bestups, hunnox, masterguard, mecer,
77 megatec, megatec/old, mustek, q1, voltronic, voltronic-qs,
78 voltronic-qs-hex and zinto.
79 Note that if you end up using the q1 protocol, you may want to give
81 a try to the mecer, megatec and zinto ones setting the
82 novendor/norating flags (only one, or both).
83 pollfreq = num
85 Set polling interval for full updates, in seconds, to reduce the
86 message traffic. Between two polling requests, the driver will do
87 quick polls dealing just with ups.status at an interval specified
88 by the pollinterval driver option (details in ups.conf(5)). The
89 default value is 30 (in seconds).
90 If your UPS doesn’t report either battery.charge or battery.runtime you
92 may want to add the following ones in order to have guesstimated
93 values:
94 default.battery.voltage.high = value
96 Maximum battery voltage that is reached after about 12 to 24 hours
97 charging. If you want the driver to report a guesstimated
98 battery.charge, you need to specify this (see BATTERY CHARGE).
99 default.battery.voltage.low = value
101 Minimum battery voltage just before the UPS automatically shuts
102 down. If you want the driver to report a guesstimated
103 battery.charge, you need to specify this (see BATTERY CHARGE).
104 default.battery.voltage.nominal = value,
106 override.battery.voltage.nominal = value
107 Some devices show a wrong nominal battery voltage (or none at all),
108 so you may need to override or set a default value.
109 override.battery.packs = value
111 Some devices report a part of the total battery voltage. For
112 instance, if battery.voltage.nominal is 24 V, but it reports a
113 battery.voltage of around 2 V, the number of battery.packs to
114 correct this reading would be 12. The driver will attempt to detect
115 this automatically, but if this fails somehow, you may want to
116 override this value.
117 runtimecal = value,value,value,value
119 Parameter used in the (optional) runtime estimation. This takes two
120 runtimes at different loads. Typically, this uses the runtime at
121 full load and the runtime at half load. For instance, if your UPS
122 has a rated runtime of 240 seconds at full load and 720 seconds at
123 half load, you would enter
124 runtimecal = 240,100,720,50
126 The first load should always be higher than the second. If you have
128 values available for loads other than 100 and 50 % respectively,
129 you can use those too, but keep them spaced apart as far as
130 reasonably possible. Just don’t get too close to no load
131 (prediction of runtime depends more on idle load for the battery
132 then).
133 chargetime = value
135 The time needed to fully recharge the battery after being fully
136 discharged. If not specified, the driver defaults to 43200 seconds
137 (12 hours). Only used if runtimecal is also specified.
138 idleload = value
140 Minimum battery load used by the driver to estimate the runtime. If
141 not specified, the driver defaults to 10%. Only used if runtimecal
142 is also specified.
143 BESTUPS, MECER, MEGATAEC, MEGATEC/OLD, MUSTEK, Q1, VOLTRONIC-QS,
145 VOLTRONIC-QS-HEX, ZINTO PROTOCOLS
146 ignoresab
147 Some UPSes incorrectly report the ‘Shutdown Active’ bit as always
148 on, consequently making the driver believe the UPS is nearing a
149 shutdown (and, as a result, ups.status always contains FSD... and
150 you know what this means). Setting this flag will make the driver
151 ignore the ‘Shutdown Active’ bit.
152 MECER, MEGATAEC, MEGATEC/OLD, MUSTEK, ZINTO PROTOCOLS
154 ondelay
155 The acceptable range is 0..599940 seconds.
156 offdelay
158 The acceptable range is 12..600 seconds.
159 norating
161 Some UPSes will lock up if you attempt to read rating information
162 from them. Setting this flag will make the driver skip this step.
163 novendor
165 Some UPSes will lock up if you attempt to read vendor information
166 from them. Setting this flag will make the driver skip this step.
167 BESTUPS PROTOCOL
169 ondelay
170 The acceptable range is 60..599940 seconds.
171 offdelay
173 The acceptable range is 12..5940 seconds.
174 pins_shutdown_mode = value
176 Set shutdown mode functionality of Pin 1 and Pin 7 on the UPS DB9
177 communication port (Per Best Power’s EPS-0059) to value [0..6].
178 MASTERGUARD PROTOCOL
180 slave_addr = value
181 Make the claim function verify it’s talking to the specified slave
182 address (ups.id). Safeguard against talking to the wrong one of
183 several identical UPSes on the same USB bus. Note that when
184 changing ups.id (through upsrw(8)) the driver will continue to talk
185 to the UPS with the new slave address, but won’t claim it again on
186 restart until the slave_addr parameter is adjusted.
187 Q1 PROTOCOL
189 ondelay
190 The acceptable range is 0..599940 seconds.
191 offdelay
193 The acceptable range is 12..600 seconds.
194 VOLTRONIC-QS, VOLTRONIC-QS-HEX PROTOCOLS
196 ondelay
197 The acceptable range is 60..599940 seconds.
198 offdelay
200 The acceptable range is 12..540 seconds.
201 VOLTRONIC PROTOCOL
203 The following options are supported only by the voltronic protocol. Not
204 all of them are available on all the UPSes supported by this protocol.
205 ondelay
207 The acceptable range is 0..599940 seconds.
208 offdelay
210 The acceptable range is 12..5940 seconds.
211 battery_number = value
213 Set number of batteries that make a pack to value [1..9]. This
214 setting will change the charge and runtime estimation reported by
215 the UPS.
216 output_phase_angle = value
218 Changes output phase angle to the provided value [000, 120, 180,
219 240]°.
220 UPS CAPABILITY SETTINGS
222 reset_to_default
223 Reset capability options and their voltage and frequency limits
224 to safe default values. (Doable only when the UPS is in Standby
225 Mode)
226 Note that setting this option will reset also ups.start.auto,
228 battery.protection, battery.energysave, ups.start.battery,
229 outlet.0.switchable, input.transfer.high, input.transfer.low,
230 input.frequency.high and input.frequency.low.
231 These UPSes can be fine-tuned to suit your needs enabling or
233 disabling the following options (the driver should tell you which
234 one the UPS is capable of on startup: the settable ones will be
235 reported either are enabled or disabled in the logs):
236 alarm_control = string
238 Enable or disable alarm (BEEP!) [enabled/disabled]. Settable
239 also ‘on the fly’ with beeper.enable and beeper.disable instant
240 commands.
241 bypass_alarm = string
243 Enable or disable alarm (BEEP!) at Bypass Mode
244 [enabled/disabled].
245 battery_alarm = string
247 Enable or disable alarm (BEEP!) at Battery Mode
248 [enabled/disabled].
249 bypass_when_off = string
251 Enable or disable bypass when the UPS is Off
252 [enabled/disabled]. If enabled, AC will directly provide power
253 to connected devices when the UPS is off.
254 bypass_forbidding = string
256 Enable or disable Bypass Forbidding [enabled/disabled]. If
257 enabled, the UPS will not transfer to bypass mode under any
258 condition.
259 converter_mode = string
261 Enable or disable Converter Mode [enabled/disabled]. When input
262 frequency is within 40 Hz to 70 Hz, the UPS can be set at a
263 constant output frequency, 50 Hz or 60 Hz. The UPS will still
264 charge battery under this mode.
265 eco_mode = string
267 Enable or disable ECO Mode [enabled/disabled]. When input
268 voltage/frequency are within acceptable range, the UPS will
269 bypass voltage to output for energy saving. PFC and INVERTER
270 are still active at this mode. Settable also ‘on the fly’ with
271 bypass.start and bypass.stop instant commands.
272 advanced_eco_mode = string
274 Enable or disable Advanced ECO Mode [enabled/disabled]. When
275 input voltage/frequency are within acceptable range, the UPS
276 will bypass voltage to output for energy saving. PFC and
277 INVERTER are off at this mode.
278 battery_open_status_check = string
280 Enable or disable Battery Open Status Check [enabled/disabled].
281 If enabled, when the UPS is turned on, it will check if the
282 battery is connected or not.
283 site_fault_detection = string
285 Enable or disable site fault detection [enabled/disabled]. If
286 enabled, the UPS will beep when the input neutral and hot wires
287 are reversed.
288 constant_phase_angle = string
290 Enable or disable Constant Phase Angle Function (output and
291 input phase angles are not equal) [enabled/disabled].
292 limited_runtime_on_battery = string
294 Enable or disable limited runtime on battery mode
295 [enabled/disabled].
296 BYPASS MODE VOLTAGE/FREQUENCY LIMITS
298 Variables to fine-tune voltage and frequency limits for Bypass
299 mode. These limits are reset to safe default values by
300 reset_to_default.
301 If AC voltage and frequency are within acceptable range, Bypass
303 mode will be used (If the UPS is capable of and it’s enabled).
304 Since these values are device-specific, if your UPS support them,
306 you will get their settable limits printed in the logs on startup.
307 max_bypass_volt = value
309 Maximum voltage for Bypass Mode (V).
310 min_bypass_volt = value
312 Minimum voltage for Bypass Mode (V).
313 max_bypass_freq = value
315 Maximum frequency for Bypass Mode (Hz).
316 min_bypass_freq = value
318 Minimum frequency for Bypass Mode (Hz).
319 OPTIONS SPECIFIC FOR P31 UPSES
321 The following options are available only on P31 UPSes.
322 work_range_type = string
324 Device grid working range for P31 UPSes [Appliance/UPS].
325 TESTING
327 This protocol comes with a couple of functions that are not enabled
328 by default because of the lack of knowledge of some part of the
329 communication protocol used by these UPSes by your friendly
330 neighborhood developer. Since these functions are supposed to be
331 queries to the UPS for some kind of information, they should not
332 make your UPS go boom. So if you are brave enough to risk your UPS
333 and attached devices' life to help the developers, this will be
334 very appreciated.. Do it at your own risk.
335 testing
337 If invoked the driver will exec also commands that still need
338 testing.
339 SERIAL INTERFACE ONLY
341 cablepower = string
342 By default the driver will set DTR and clear RTS (normal). If you
343 find that your UPS isn’t detected or the communication with the UPS
344 is unreliable, you may try if clear DTR and set RTS (reverse), set
345 DTR and RTS (both) or clear DTR and RTS (none) improves this
346 situation.
347 USB INTERFACE ONLY
349 port = string
350 You must set value to auto.
351 vendorid = regex, productid = regex, vendor = regex, product = regex,
353 serial = regex
354 Select a specific UPS, in case there is more than one connected via
355 USB. Each option specifies an extended regular expression (see
356 regex(7)) that must match the UPS’s entire vendor/product/serial
357 string (minus any surrounding whitespace), or the whole 4-digit
358 hexadecimal code for vendorid and productid. Try -DD for finding
359 out the strings to match.
360 Examples:
362 • -x vendor="Foo.Corporation.*"
364 • -x vendorid=051d* (APC)
366 • -x product=".*(Smart|Back)-?UPS.*"
368 bus = regex
370 Select a UPS on a specific USB bus or group of buses. The argument
371 is a regular expression that must match the bus name where the UPS
372 is connected (e.g. bus="002", bus="00[2-3]").
373 device = regex
375 Select a UPS on a specific USB device or group of devices. The
376 argument is a regular expression that must match the device name
377 where the UPS is connected (e.g. device="001", device="00[1-2]").
378 Note that device numbers are not guaranteed by the OS to be stable
379 across re-boots or device re-plugging.
380 subdriver = string
382 Select a serial-over-USB subdriver to use. You have a choice
383 between cypress, fabula, fuji, hunnox, ippon, krauler, phoenix,
384 phoenixtec, sgs, snr, armac and ablerex. When using this option, it
385 is mandatory to also specify the vendorid and productid.
386 langid_fix = value
388 Apply the language ID workaround to the krauler subdriver. This is
389 mandatory for some devices to work (LDLC, Dynamix and others). You
390 must provide value (0x409 or 0x4095), according to your device
391 entry in NUT hardware compatibility list (HCL).
392 noscanlangid
394 If this flag is set, don’t autoscan valid range for langid.
395 IMPLEMENTATION NOTES
397 armac subdriver
398 The Armac communication subdriver reproduces a communication
399 protocol used by an old release of "PowerManagerII" software,
400 which doesn’t seem to be Armac specific: its banner is "2004
401 Richcomm Technologies, Inc. Dec 27 2005 ver 1.1." Maybe other
402 Richcomm UPSes would work with this — maybe better than with
403 the older standalone richcomm_usb driver.
404 fabula subdriver
406 This subdriver, meant to be used with the megatec protocol,
407 does not support the various test.battery commands. Plus, the
408 shutdown.return command ignores the values set in
409 ups.delay.start/ondelay and makes the UPS turn on the load as
410 soon as power is back.
411 hunnox subdriver
413 This protocol subdriver is closely related to fabula one, with
414 a few tweaks for devices not directly supported by that driver.
415 fuji subdriver
417 This subdriver, meant to be used with the megatec protocol,
418 does not support the shutdown.stayoff and load.off commands.
419 Plus, the shutdown.return command ignores the values set in
420 ups.delay.start/ondelay and makes the UPS turn on the load as
421 soon as power is back.
422 krauler subdriver
424 This subdriver, meant to be used with the megatec protocol,
425 does not support the shutdown commands, i.e.: shutdown.return,
426 shutdown.stayoff and load.off.
427 snr subdriver
429 This subdriver, meant to be used with the megatec protocol,
430 does not support the shutdown commands, i.e.: shutdown.return,
431 shutdown.stayoff and load.off.
432
434 This driver supports some instant commands (see upscmd(8)):
435 beeper.toggle
437 Toggle the UPS beeper. (Not available on some hardware)
438 load.on
440 Turn on the load immediately. (Not available on some hardware)
441 load.off
443 Turn off the load immediately (see KNOWN PROBLEMS).
444 shutdown.return
446 Turn off the load and return when power is back. Uses the timers
447 defined by ups.delay.start and ups.delay.shutdown.
448 shutdown.stayoff
450 Turn off the load and remain off (see KNOWN PROBLEMS). Uses the
451 timer defined by ups.delay.shutdown.
452 shutdown.stop
454 Stop a shutdown in progress.
455 test.battery.start.deep
457 Perform a long battery test. (Not available on some hardware)
458 test.battery.start.quick
460 Perform a quick (10 second) battery test.
461 test.battery.stop
463 Stop a running battery test. (Not available on some hardware)
464 BESTUPS, MECER, MEGATEC, MEGATEC/OLD, MUSTEK, Q1, ZINTO PROTOCOLS
466 test.battery.start value
467 Perform a battery test for the duration of value seconds (truncated
468 to 60 seconds) [60..5940].
469 MASTERGUARD PROTOCOL
471 beeper.enable
472 Enable the UPS beeper.
473 beeper.disable
475 Disable the UPS beeper.
476 test.battery.start value
478 Perform a battery test for the duration of value seconds (truncated
479 to 60 seconds) [0..5940]. This value is truncated to units of 6
480 seconds (less than 60 seconds) or 60 seconds (more than 60
481 seconds).
482 bypass.start
484 Put the UPS in bypass mode
485 bypass.stop
487 Take the UPS in normal mode
488 VOLTRONIC POWER P98 UNITS (WITH MECER PROTOCOL)
490 test.battery.start value
491 Perform a battery test for the duration of value seconds
492 (truncated to 60 seconds) [12..5940]. This value is truncated
493 to units of 6 seconds (less than 60 seconds) or 60 seconds
494 (more than 60 seconds).
495 VOLTRONIC PROTOCOL
497 The following instant commands are available for the voltronic
498 protocol. Not all of them are available on all the UPSes supported by
499 this protocol.
500 beeper.enable
502 Enable the UPS beeper.
503 beeper.disable
505 Disable the UPS beeper.
506 test.battery.start value
508 Perform a battery test for the duration of value seconds
509 [12..5940]. This value is truncated to units of 6 seconds (less
510 than 60 seconds) or 60 seconds (more than 60 seconds).
511 outlet.1.load.off
513 Turn off outlet 1 load immediately.
514 outlet.1.load.on
516 Turn on outlet 1 load immediately.
517 outlet.2.load.off
519 Turn off outlet 2 load immediately.
520 outlet.2.load.on
522 Turn on outlet 2 load immediately.
523 outlet.3.load.off
525 Turn off outlet 3 load immediately.
526 outlet.3.load.on
528 Turn on outlet 3 load immediately.
529 outlet.4.load.off
531 Turn off outlet 4 load immediately.
532 outlet.4.load.on
534 Turn on outlet 4 load immediately.
535 bypass.start
537 Put the UPS in ECO Mode.
538 bypass.stop
540 Take the UPS out of ECO Mode.
541
543 Due to popular demand, this driver will report a guesstimated
544 battery.charge and optionally battery.runtime, provided you specified a
545 couple of the EXTRA ARGUMENTS listed above.
546 If you specify both battery.voltage.high and battery.voltage.low in
548 ups.conf(5), but don’t enter runtimecal, it will guesstimate the state
549 of charge by looking at the battery voltage alone. This is not reliable
550 under load, as this only gives reasonably accurate readings if you
551 disconnect the load, let the battery rest for a couple of minutes and
552 then measure the open cell voltage. This just isn’t practical if the
553 power went out and the UPS is providing power for your systems.
554 battery.voltage - battery.voltage.low
556 battery.charge = ------------------------------------------ x 100 %
557 battery.voltage.high - battery.voltage.low
558 There is a way to get better readings without disconnecting the load
560 but this requires one to keep track on how much (and how fast) current
561 is going in and out of the battery. If you specified the runtimecal,
562 the driver will attempt to do this. Note however, that this heavily
563 relies on the values you enter and that the UPS must be able to report
564 the load as well. There are quite a couple of devices that report 0 %
565 (or any other fixed value) at all times, in which case this obviously
566 doesn’t work.
567 The driver also has no way of determining the degradation of the
569 battery capacity over time, so you’ll have to deal with this yourself
570 (by adjusting the values in runtimecal). Also note that the driver
571 guesses the initial state of charge based on the battery voltage, so
572 this may be less than 100 %, even when you are certain that they are
573 full. There is just no way to reliably measure this between 0 and 100 %
574 full charge.
575 This is better than nothing (but not by much). If any of the above
577 calculations is giving you incorrect readings, you are the one that put
578 in the values in ups.conf(5), so don’t complain with the author. If you
579 need something better, buy a UPS that reports battery.charge and
580 battery.runtime all by itself without the help of a NUT driver.
581
583 The nutdrv_qx driver having replaced the megatec ones, some
584 configuration changes may be required by users switching to nutdrv_qx.
585 Part of this, the following megatec options, in ups.conf(5), have to be
587 changed:
588 battvolts
590 You need to use default.battery.voltage.high and
591 default.battery.voltage.low
592 dtr and rts
594 You need to use cablepower
595 ignoreoff
597 This parameter can simply be discarded, since it was a wrong
598 understanding of the specification.
599
601 The nutdrv_qx driver having replaced the blazer ones, some
602 configuration changes may be required by users switching to nutdrv_qx.
603 Part of this, the following blazer options, in ups.conf(5), have to be
605 changed:
606 ondelay
608 While the previous blazer drivers expected minutes, the new
609 nutdrv_qx driver wants seconds.
610 The following instant command has also been changed:
612 test.battery.start value
614 While the old blazer drivers expected a value in minutes, the
615 nutdrv_qx driver wants a value in seconds.
616
618 The nutdrv_qx driver having replaced the bestups one, some
619 configuration changes may be required by users switching to nutdrv_qx.
620 Part of this, the following bestups options, in ups.conf(5), are no
622 longer supported by this driver:
623 nombattvolt, battvoltmult
625 See BATTERY CHARGE.
626 ID
628 Discarded.
629
631 The nutdrv_qx driver having replaced the voltronic ones, some
632 configuration changes may be required by users switching to nutdrv_qx.
633 Part of this, the following voltronic options, in ups.conf(5), have to
635 be changed:
636 ondelay
638 While the previous voltronic drivers expected minutes, the new
639 nutdrv_qx driver wants seconds. It no longer defaults to 0 minutes
640 but to 3 minutes (i.e. 180 seconds) for compatibility with the
641 users switching from the old blazer drivers.
642 battnumb
644 This option has been renamed to battery_number.
645 The following options are no longer supported by this driver, you can
647 now change them more conveniently ‘on the fly’ calling upsrw(8) with
648 the appropriate NUT variable - provided that your UPS supports them.
649 battpacks → battery.packs
652 Set number of battery
654 packs in parallel [1..99].
655 This setting will change
656 the charge and runtime
657 estimation reported by the
658 UPS.
659 battlow → battery.voltage.low
663 Set minimum battery
665 voltage just before the
666 UPS automatically shuts
667 down. This setting will
668 change the charge and
669 runtime estimation
670 reported by the UPS.
671 auto_reboot → ups.start.auto
673 Enable or disable auto
675 reboot [enabled/disabled].
676 If enabled, the UPS will
677 auto recover when AC power
678 returns.
679 battery_protection → battery.protection
681 Enable or disable battery
683 deep discharge protection
684 [enabled/disabled].
685 energy_saving → battery.energysave
687 Enable or disable Green
689 power function
690 [enabled/disabled]. If
691 enabled, for energy
692 saving, the UPS will auto
693 off when there is no load.
694 cold_start → ups.start.battery
696 Enable or disable Cold
698 Start [enabled/disabled].
699 If enabled, the UPS can be
700 turned on also if AC is
701 not connected to the UPS.
702 outlet_control → outlet.0.switchable
704 Enable or disable
706 programmable outlets
707 control at battery mode
708 [enabled/disabled]. If
709 enabled, the UPS will cut
710 off programmable outlets
711 after backup time (set
712 through
713 outlet.{1,2,3,4}.delay.shutdown)
714 arrives. If disabled, the
715 UPS will provide
716 continuous power to
717 programmable outlets until
718 the battery is running
719 out.
720 max_eco_volt → input.transfer.high
729 Maximum voltage for ECO Mode
731 (V). If AC voltage is within
732 acceptable range, ECO mode will
733 be used (If the UPS is capable
734 of and it’s enabled).
735 min_eco_volt → input.transfer.low
737 Minimum voltage for ECO Mode
739 (V). If AC voltage is within
740 acceptable range, ECO mode will
741 be used (If the UPS is capable
742 of and it’s enabled).
743 max_eco_freq → input.frequency.high
745 Maximum frequency for ECO Mode
747 (Hz). If AC frequency is within
748 acceptable range, ECO mode will
749 be used (If the UPS is capable
750 of and it’s enabled).
751 min_eco_freq → input.frequency.low
753 Minimum frequency for ECO Mode
755 (Hz). If AC frequency is within
756 acceptable range, ECO mode will
757 be used (If the UPS is capable
758 of and it’s enabled).
759 outlet1_delay → outlet.1.delay.shutdown
761 Delay time before programmable
763 outlet 1 shuts down the load
764 when on battery mode [0..59940]
765 (seconds).
766 outlet2_delay → outlet.2.delay.shutdown
768 Delay time before programmable
770 outlet 2 shuts down the load
771 when on battery mode [0..59940]
772 (seconds).
773 outlet3_delay → outlet.3.delay.shutdown
775 Delay time before programmable
777 outlet 3 shuts down the load
778 when on battery mode [0..59940]
779 (seconds).
780 outlet4_delay → outlet.4.delay.shutdown
782 Delay time before programmable
784 outlet 4 shuts down the load
785 when on battery mode [0..59940]
786 (seconds).
787 batt_type → battery.type
789 Battery type (for P31 UPSes
791 only) [Li/Flooded/AGM].
792
795 Some UPS commands aren’t supported by all models. In most cases, the
796 driver will send a message to the system log when the user tries to
797 execute an unsupported command. Unfortunately, some models don’t even
798 provide a way for the driver to check for this, so the unsupported
799 commands will silently fail.
800 Both the load.off and shutdown.stayoff instant commands are meant to
802 turn the load off indefinitely. However, some UPS models don’t allow
803 this.
804 Some models report a bogus value for the beeper status (will always be
806 enabled or disabled). So, the beeper.toggle command may appear to have
807 no effect in the status reported by the driver when, in fact, it is
808 working fine.
809 The temperature and load value is known to be bogus in some models.
811 MASTERGUARD UNITS
813 The driver is supposed to support both "new" A series
814 (A700/1000/2000/3000 and their -19 cousins) and E series (E60/100/200)
815 but was tested only on A due to lack of E hardware.
816 VOLTRONIC-QS UNITS
818 Both load.off and shutdown.stayoff instant commands are known to work
819 as expected (i.e. turn the load off indefinitely) only if mains is
820 present, otherwise, as soon as mains returns the load will be powered.
821 After issuing a shutdown.return instant command, the UPS won’t wait
823 ondelay before powering on the load, provided the following conditions
824 are met:
825 • if the load has been previously (no matter how long before) powered
827 off through load.off/shutdown.stayoff and powered on through
828 load.on/shutdown.stop and
829 • if AC wasn’t cut after issuing the load.off/shutdown.stayoff (i.e.
831 the UPS didn’t turn itself off) and
832 • if there’s a power outage after issuing the shutdown.return command
834 In this case, as soon as mains returns the load will be powered.
836 VOLTRONIC-QS-HEX UNITS
838 shutdown.return, load.off, and shutdown.stayoff instant commands are
839 known to work as expected only if mains is present, otherwise, as soon
840 as mains returns the load will be powered.
841
843 The UPSes supported by voltronic protocol report warnings through a
844 64bit flag (bit1bit2...bit63bit64) where 1 means that a warning arose,
845 while 0 means no warning. Since more than one warning at a time can be
846 signaled, and because of the limited space in the ups.alarm variable,
847 if the length of the warnings exceeds that of ups.alarms variable, they
848 will be reported as bits. If you want to know the explanation of that
849 bit you can either watch the log or see the next table (unlisted bits
850 equal to unknown warnings).
851 Table 1. UPS Warnings for voltronic UPSes
853 ┌───┬────────────────────────────┐
854 │ # │ Corresponding Warning │
855 ├───┼────────────────────────────┤
856 │ │ │
857 │ 1 │ Battery disconnected │
858 ├───┼────────────────────────────┤
859 │ │ │
860 │ 2 │ Neutral not connected │
861 ├───┼────────────────────────────┤
862 │ │ │
863 │ 3 │ Site fault │
864 ├───┼────────────────────────────┤
865 │ │ │
866 │ 4 │ Phase sequence incorrect │
867 ├───┼────────────────────────────┤
868 │ │ │
869 │ 5 │ Phase sequence incorrect │
870 │ │ in bypass │
871 ├───┼────────────────────────────┤
872 │ │ │
873 │ 6 │ Input frequency unstable │
874 │ │ in bypass │
875 ├───┼────────────────────────────┤
876 │ │ │
877 │ 7 │ Battery overcharged │
878 ├───┼────────────────────────────┤
879 │ │ │
880 │ 8 │ Low battery │
881 ├───┼────────────────────────────┤
882 │ │ │
883 │ 9 │ Overload alarm │
884 ├───┼────────────────────────────┤
885 │ │ │
886 │10 │ Fan alarm │
887 ├───┼────────────────────────────┤
888 │ │ │
889 │11 │ EPO enabled │
890 ├───┼────────────────────────────┤
891 │ │ │
892 │12 │ Unable to turn on UPS │
893 ├───┼────────────────────────────┤
894 │ │ │
895 │13 │ Over temperature alarm │
896 ├───┼────────────────────────────┤
897 │ │ │
898 │14 │ Charger alarm │
899 ├───┼────────────────────────────┤
900 │ │ │
901 │15 │ Remote auto shutdown │
902 ├───┼────────────────────────────┤
903 │ │ │
904 │16 │ L1 input fuse not working │
905 ├───┼────────────────────────────┤
906 │ │ │
907 │17 │ L2 input fuse not working │
908 ├───┼────────────────────────────┤
909 │ │ │
910 │18 │ L3 input fuse not working │
911 ├───┼────────────────────────────┤
912 │ │ │
913 │19 │ Positive PFC abnormal in │
914 │ │ L1 │
915 ├───┼────────────────────────────┤
916 │ │ │
917 │20 │ Negative PFC abnormal in │
918 │ │ L1 │
919 ├───┼────────────────────────────┤
920 │ │ │
921 │21 │ Positive PFC abnormal in │
922 │ │ L2 │
923 ├───┼────────────────────────────┤
924 │ │ │
925 │22 │ Negative PFC abnormal in │
926 │ │ L2 │
927 ├───┼────────────────────────────┤
928 │ │ │
929 │23 │ Positive PFC abnormal in │
930 │ │ L3 │
931 ├───┼────────────────────────────┤
932 │ │ │
933 │24 │ Negative PFC abnormal in │
934 │ │ L3 │
935 ├───┼────────────────────────────┤
936 │ │ │
937 │25 │ Abnormal in CAN-bus │
938 │ │ communication │
939 ├───┼────────────────────────────┤
940 │ │ │
941 │26 │ Abnormal in synchronous │
942 │ │ signal circuit │
943 ├───┼────────────────────────────┤
944 │ │ │
945 │27 │ Abnormal in synchronous │
946 │ │ pulse signal circuit │
947 ├───┼────────────────────────────┤
948 │ │ │
949 │28 │ Abnormal in host signal │
950 │ │ circuit │
951 ├───┼────────────────────────────┤
952 │ │ │
953 │29 │ Male connector of parallel │
954 │ │ cable not connected well │
955 ├───┼────────────────────────────┤
956 │ │ │
957 │30 │ Female connector of │
958 │ │ parallel cable not │
959 │ │ connected well │
960 ├───┼────────────────────────────┤
961 │ │ │
962 │31 │ Parallel cable not │
963 │ │ connected well │
964 ├───┼────────────────────────────┤
965 │ │ │
966 │32 │ Battery connection not │
967 │ │ consistent in parallel │
968 │ │ systems │
969 ├───┼────────────────────────────┤
970 │ │ │
971 │33 │ AC connection not │
972 │ │ consistent in parallel │
973 │ │ systems │
974 ├───┼────────────────────────────┤
975 │ │ │
976 │34 │ Bypass connection not │
977 │ │ consistent in parallel │
978 │ │ systems │
979 ├───┼────────────────────────────┤
980 │ │ │
981 │35 │ UPS model types not │
982 │ │ consistent in parallel │
983 │ │ systems │
984 ├───┼────────────────────────────┤
985 │ │ │
986 │36 │ Capacity of UPSs not │
987 │ │ consistent in parallel │
988 │ │ systems │
989 ├───┼────────────────────────────┤
990 │ │ │
991 │37 │ Auto restart setting not │
992 │ │ consistent in parallel │
993 │ │ systems │
994 ├───┼────────────────────────────┤
995 │ │ │
996 │38 │ Battery cell over charge │
997 ├───┼────────────────────────────┤
998 │ │ │
999 │39 │ Battery protection setting │
1000 │ │ not consistent in parallel │
1001 │ │ systems │
1002 ├───┼────────────────────────────┤
1003 │ │ │
1004 │40 │ Battery detection setting │
1005 │ │ not consistent in parallel │
1006 │ │ systems │
1007 ├───┼────────────────────────────┤
1008 │ │ │
1009 │41 │ Bypass not allowed setting │
1010 │ │ not consistent in parallel │
1011 │ │ systems │
1012 ├───┼────────────────────────────┤
1013 │ │ │
1014 │42 │ Converter setting not │
1015 │ │ consistent in parallel │
1016 │ │ systems │
1017 ├───┼────────────────────────────┤
1018 │ │ │
1019 │43 │ High loss point for │
1020 │ │ frequency in bypass mode │
1021 │ │ not consistent in parallel │
1022 │ │ systems │
1023 ├───┼────────────────────────────┤
1024 │ │ │
1025 │44 │ Low loss point for │
1026 │ │ frequency in bypass mode │
1027 │ │ not consistent in parallel │
1028 │ │ systems │
1029 ├───┼────────────────────────────┤
1030 │ │ │
1031 │45 │ High loss point for │
1032 │ │ voltage in bypass mode not │
1033 │ │ consistent in parallel │
1034 │ │ systems │
1035 ├───┼────────────────────────────┤
1036 │ │ │
1037 │46 │ Low loss point for voltage │
1038 │ │ in bypass mode not │
1039 │ │ consistent in parallel │
1040 │ │ systems │
1041 ├───┼────────────────────────────┤
1042 │ │ │
1043 │47 │ High loss point for │
1044 │ │ frequency in AC mode not │
1045 │ │ consistent in parallel │
1046 │ │ systems │
1047 ├───┼────────────────────────────┤
1048 │ │ │
1049 │48 │ Low loss point for │
1050 │ │ frequency in AC mode not │
1051 │ │ consistent in parallel │
1052 │ │ systems │
1053 ├───┼────────────────────────────┤
1054 │ │ │
1055 │49 │ High loss point for │
1056 │ │ voltage in AC mode not │
1057 │ │ consistent in parallel │
1058 │ │ systems │
1059 ├───┼────────────────────────────┤
1060 │ │ │
1061 │50 │ Low loss point for voltage │
1062 │ │ in AC mode not consistent │
1063 │ │ in parallel systems │
1064 ├───┼────────────────────────────┤
1065 │ │ │
1066 │51 │ Warning for locking in │
1067 │ │ bypass mode after 3 │
1068 │ │ consecutive overloads │
1069 │ │ within 30 min │
1070 ├───┼────────────────────────────┤
1071 │ │ │
1072 │52 │ Warning for three-phase AC │
1073 │ │ input current unbalance │
1074 ├───┼────────────────────────────┤
1075 │ │ │
1076 │53 │ Warning for a three-phase │
1077 │ │ input current unbalance │
1078 │ │ detected in battery mode │
1079 ├───┼────────────────────────────┤
1080 │ │ │
1081 │54 │ Warning for Inverter │
1082 │ │ inter-current unbalance │
1083 ├───┼────────────────────────────┤
1084 │ │ │
1085 │55 │ Programmable outlets cut │
1086 │ │ off pre-alarm │
1087 ├───┼────────────────────────────┤
1088 │ │ │
1089 │56 │ Warning for Battery │
1090 │ │ replace │
1091 ├───┼────────────────────────────┤
1092 │ │ │
1093 │57 │ Abnormal warning on input │
1094 │ │ phase angle │
1095 ├───┼────────────────────────────┤
1096 │ │ │
1097 │58 │ Warning!! Cover of │
1098 │ │ maintain switch is open │
1099 ├───┼────────────────────────────┤
1100 │ │ │
1101 │62 │ EEPROM operation error │
1102 └───┴────────────────────────────┘
1103
1105 • Daniele Pezzini <hyouko@gmail.com>
1106 • Arnaud Quette <arnaud.quette@gmail.com>
1108 • John Stamp <kinsayder@hotmail.com>
1110 • Peter Selinger <selinger@users.sourceforge.net>
1112 • Arjen de Korte <adkorte-guest@alioth.debian.org>
1114 • Alexander Gordeev <lasaine@lvk.cs.msu.su>
1116 • Edgar Fuß <ef@math.uni-bonn.de>
1118
1120 blazer_ser(8), blazer_usb(8), nutupsdrv(8), ups.conf(5), upsc(8),
1121 upscmd(8), upsdrvctl(8), upsmon(8), upsrw(8)
1122 Internet Resources:
1124 • The NUT (Network UPS Tools) home page:
1125 http://www.networkupstools.org/
1126 • The NUT HCL: http://www.networkupstools.org/stable-hcl.html
1128Network UPS Tools 2.8.0 04/26/2022 NUTDRV_QX(8)