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 Blazer,
15 Energy Sistem, Fenton Technologies, General Electric, Mustek, Voltronic
16 Power (rebranded by many, many - have I said many? - others.. Long
17 story short: if your UPS came with a software called Viewpower, chances
18 are high that it works with this driver with one of the voltronic*
19 protocols or with the mecer one) and many others.
20 The NUT compatibility table lists all the known supported models. Keep
22 in mind, however, that other models not listed there may also be
23 supported, but haven’t been tested.
24 All devices with a serial interface and many with a USB interface are
26 supported.
27
29 You may need to override or provide defaults for some values, depending
30 on the make and model of your UPS.
31 The following are the ones that most likely will need changing (see
33 ups.conf(5)):
34 ondelay = value
36 Time to wait before switching on the UPS (seconds). This value is
37 truncated to units of 60 seconds.
38 Note that a value below 3 minutes, may cause earlier firmware
40 versions to not switch on automatically, so it defaults to 3
41 minutes (i.e. 180 seconds).
42 This option provides a default value for ups.delay.start that will
44 then be used by the driver in the automatic shutdown sequence (i.e.
45 calling the driver with the -k option, calling upsdrvctl(8) with
46 the shutdown option or when the FSD flag is set and upsmon(8)
47 enters its shutdown sequence): however you can change this value
48 ‘on the fly’ for the actual session, only for the use with instant
49 commands, setting ups.delay.start with upsrw(8).
50 offdelay = value
52 Time to wait before shutting down the UPS (seconds). This value is
53 truncated to units of 6 seconds (less than 60 seconds) or 60
54 seconds (more than 60 seconds). Defaults to 30 seconds.
55 This option provides a default value for ups.delay.shutdown that
57 will then be used by the driver in the automatic shutdown sequence
58 (i.e. calling the driver with the -k option, calling upsdrvctl(8)
59 with the shutdown option or when the FSD flag is set and upsmon(8)
60 enters its shutdown sequence): however you can change this value
61 ‘on the fly’ for the actual session, only for the use with instant
62 commands, setting ups.delay.shutdown with upsrw(8).
63 stayoff
65 If you set stayoff in ups.conf(5) when FSD arises the UPS will call
66 a shutdown.stayoff shutting down after ups.delay.shutdown seconds
67 and won’t return (see KNOWN PROBLEMS), otherwise (standard
68 behaviour) the UPS will call shutdown.return shutting down after
69 ups.delay.shutdown seconds and then turn on after ups.delay.start
70 seconds (if mains meanwhile returned).
71 protocol = string
73 Skip autodetection of the protocol to use and only use the one
74 specified. Supported values: bestups, mecer, megatec, megatec/old,
75 mustek, q1, voltronic, voltronic-qs, voltronic-qs-hex and zinto.
76 Note that if you end up using the q1 protocol, you may want to give
78 a try to the mecer, megatec and zinto ones setting the
79 novendor/norating flags (only one, or both).
80 pollfreq = value
82 Set polling frequency, in seconds, to reduce the data flow. Between
83 two polling requests the driver will do ‘quick polls’ dealing just
84 with ups.status. The default value is 30 (in seconds).
85 If your UPS doesn’t report either battery.charge or battery.runtime you
87 may want to add the following ones in order to have guesstimated
88 values:
89 default.battery.voltage.high = value
91 Maximum battery voltage that is reached after about 12 to 24 hours
92 charging. If you want the driver to report a guesstimated
93 battery.charge, you need to specify this (see BATTERY CHARGE).
94 default.battery.voltage.low = value
96 Minimum battery voltage just before the UPS automatically shuts
97 down. If you want the driver to report a guesstimated
98 battery.charge, you need to specify this (see BATTERY CHARGE).
99 default.battery.voltage.nominal = value,
101 override.battery.voltage.nominal = value
102 Some devices show a wrong nominal battery voltage (or none at all),
103 so you may need to override or set a default value.
104 override.battery.packs = value
106 Some devices report a part of the total battery voltage. For
107 instance, if battery.voltage.nominal is 24 V, but it reports a
108 battery.voltage of around 2 V, the number of battery.packs to
109 correct this reading would be 12. The driver will attempt to detect
110 this automatically, but if this fails somehow, you may want to
111 override this value.
112 runtimecal = value,value,value,value
114 Parameter used in the (optional) runtime estimation. This takes two
115 runtimes at different loads. Typically, this uses the runtime at
116 full load and the runtime at half load. For instance, if your UPS
117 has a rated runtime of 240 seconds at full load and 720 seconds at
118 half load, you would enter
119 runtimecal = 240,100,720,50
121 The first load should always be higher than the second. If you have
123 values available for loads other than 100 and 50 % respectively,
124 you can use those too, but keep them spaced apart as far as
125 reasonably possible. Just don’t get too close to no load
126 (prediction of runtime depends more on idle load for the battery
127 then).
128 chargetime = value
130 The time needed to fully recharge the battery after being fully
131 discharged. If not specified, the driver defaults to 43200 seconds
132 (12 hours). Only used if runtimecal is also specified.
133 idleload = value
135 Minimum battery load used by the driver to estimate the runtime. If
136 not specified, the driver defaults to 10%. Only used if runtimecal
137 is also specified.
138 BESTUPS, MECER, MEGATAEC, MEGATEC/OLD, MUSTEK, Q1, VOLTRONIC-QS,
140 VOLTRONIC-QS-HEX, ZINTO PROTOCOLS
141 ignoresab
142 Some UPSes incorrectly report the ‘Shutdown Active’ bit as always
143 on, consequently making the driver believe the UPS is nearing a
144 shutdown (and, as a result, ups.status always contains FSD... and
145 you know what this means). Setting this flag will make the driver
146 ignore the ‘Shutdown Active’ bit.
147 MECER, MEGATAEC, MEGATEC/OLD, MUSTEK, ZINTO PROTOCOLS
149 ondelay
150 The acceptable range is 0..599940 seconds.
151 offdelay
153 The acceptable range is 12..600 seconds.
154 norating
156 Some UPSes will lock up if you attempt to read rating information
157 from them. Setting this flag will make the driver skip this step.
158 novendor
160 Some UPSes will lock up if you attempt to read vendor information
161 from them. Setting this flag will make the driver skip this step.
162 BESTUPS PROTOCOL
164 ondelay
165 The acceptable range is 60..599940 seconds.
166 offdelay
168 The acceptable range is 12..5940 seconds.
169 pins_shutdown_mode = value
171 Set shutdown mode functionality of Pin 1 and Pin 7 on the UPS DB9
172 communication port (Per Best Power’s EPS-0059) to value [0..6].
173 Q1 PROTOCOL
175 ondelay
176 The acceptable range is 0..599940 seconds.
177 offdelay
179 The acceptable range is 12..600 seconds.
180 VOLTRONIC-QS, VOLTRONIC-QS-HEX PROTOCOLS
182 ondelay
183 The acceptable range is 60..599940 seconds.
184 offdelay
186 The acceptable range is 12..540 seconds.
187 VOLTRONIC PROTOCOL
189 The following options are supported only by the voltronic protocol. Not
190 all of them are available on all the UPSes supported by this protocol.
191 ondelay
193 The acceptable range is 0..599940 seconds.
194 offdelay
196 The acceptable range is 12..5940 seconds.
197 battery_number = value
199 Set number of batteries that make a pack to value [1..9]. This
200 setting will change the charge and runtime estimation reported by
201 the UPS.
202 output_phase_angle = value
204 Changes output phase angle to the provided value [000, 120, 180,
205 240]°.
206 UPS CAPABILITY SETTINGS
208 reset_to_default
209 Reset capability options and their voltage and frequency limits
210 to safe default values. (Doable only when the UPS is in Standby
211 Mode)
212 Note that setting this option will reset also ups.start.auto,
214 battery.protection, battery.energysave, ups.start.battery,
215 outlet.0.switchable, input.transfer.high, input.transfer.low,
216 input.frequency.high and input.frequency.low.
217 These UPSes can be fine-tuned to suit your needs enabling or
219 disabling the following options (the driver should tell you which
220 one the UPS is capable of on startup: the settable ones will be
221 reported either ar enabled or disabled in the logs):
222 alarm_control = string
224 Enable or disable alarm (BEEP!) [enabled/disabled]. Settable
225 also ‘on the fly’ with beeper.enable and beeper.disable instant
226 commands.
227 bypass_alarm = string
229 Enable or disable alarm (BEEP!) at Bypass Mode
230 [enabled/disabled].
231 battery_alarm = string
233 Enable or disable alarm (BEEP!) at Battery Mode
234 [enabled/disabled].
235 bypass_when_off = string
237 Enable or disable bypass when the UPS is Off
238 [enabled/disabled]. If enabled, AC will directly provide power
239 to connected devices when the UPS is off.
240 bypass_forbidding = string
242 Enable or disable Bypass Forbidding [enabled/disabled]. If
243 enabled, the UPS will not transfer to bypass mode under any
244 condition.
245 converter_mode = string
247 Enable or disable Converter Mode [enabled/disabled]. When input
248 frequency is within 40 Hz to 70 Hz, the UPS can be set at a
249 constant output frequency, 50 Hz or 60 Hz. The UPS will still
250 charge battery under this mode.
251 eco_mode = string
253 Enable or disable ECO Mode [enabled/disabled]. When input
254 voltage/frequency are within acceptable range, the UPS will
255 bypass voltage to output for energy saving. PFC and INVERTER
256 are still active at this mode. Settable also ‘on the fly’ with
257 bypass.start and bypass.stop instant commands.
258 advanced_eco_mode = string
260 Enable or disable Advanced ECO Mode [enabled/disabled]. When
261 input voltage/frequency are within acceptable range, the UPS
262 will bypass voltage to output for energy saving. PFC and
263 INVERTER are off at this mode.
264 battery_open_status_check = string
266 Enable or disable Battery Open Status Check [enabled/disabled].
267 If enabled, when the UPS is turned on, it will check if the
268 battery is connected or not.
269 site_fault_detection = string
271 Enable or disable site fault detection [enabled/disabled]. If
272 enabled, the UPS will beep when the input neutral and hot wires
273 are reversed.
274 constant_phase_angle = string
276 Enable or disable Constant Phase Angle Function (output and
277 input phase angles are not equal) [enabled/disabled].
278 limited_runtime_on_battery = string
280 Enable or disable limited runtime on battery mode
281 [enabled/disabled].
282 BYPASS MODE VOLTAGE/FREQUENCY LIMITS
284 Variables to fine-tune voltage and frequency limits for Bypass
285 mode. These limits are reset to safe default values by
286 reset_to_default.
287 If AC voltage and frequency are within acceptable range, Bypass
289 mode will be used (If the UPS is capable of and it’s enabled).
290 Since these values are device-specific, if your UPS support them,
292 you will get their settable limits printed in the logs on startup.
293 max_bypass_volt = value
295 Maximum voltage for Bypass Mode (V).
296 min_bypass_volt = value
298 Minimum voltage for Bypass Mode (V).
299 max_bypass_freq = value
301 Maximum frequency for Bypass Mode (Hz).
302 min_bypass_freq = value
304 Minimum frequency for Bypass Mode (Hz).
305 OPTIONS SPECIFIC FOR P31 UPSES
307 The following options are available only on P31 UPSes.
308 work_range_type = string
310 Device grid working range for P31 UPSes [Appliance/UPS].
311 TESTING
313 This protocol comes with a couple of functions that are not enabled
314 by default because of the lack of knowledge of some part of the
315 communication protocol used by these UPSes by your friendly
316 neighborhood developer. Since these functions are supposed to be
317 queries to the UPS for some kind of informations, they should not
318 make your UPS go boom. So if you are brave enough to risk your UPS
319 and attached devices' life to help the developers, this will be
320 very appreciated.. Do it at your own risk.
321 testing
323 If invoked the driver will exec also commands that still need
324 testing.
325 SERIAL INTERFACE ONLY
327 cablepower = string
328 By default the driver will set DTR and clear RTS (normal). If you
329 find that your UPS isn’t detected or the communication with the UPS
330 is unreliable, you may try if clear DTR and set RTS (reverse), set
331 DTR and RTS (both) or clear DTR and RTS (none) improves this
332 situation.
333 USB INTERFACE ONLY
335 port = string
336 You must set value to auto.
337 vendorid = regex, productid = regex, vendor = regex, product = regex,
339 serial = regex
340 Select a specific UPS, in case there is more than one connected via
341 USB. Each option specifies an extended regular expression (see
342 regex(7)) that must match the UPS’s entire vendor/product/serial
343 string (minus any surrounding whitespace), or the whole 4-digit
344 hexadecimal code for vendorid and productid. Try -DD for finding
345 out the strings to match.
346 Examples:
348 · -x vendor="Foo.Corporation.*"
350 · -x vendorid=051d* (APC)
352 · -x product=".*(Smart|Back)-?UPS.*"
354 bus = regex
356 Select a UPS on a specific USB bus or group of busses. The argument
357 is a regular expression that must match the bus name where the UPS
358 is connected (e.g. bus="002", bus="00[2-3]").
359 subdriver = string
361 Select a serial-over-USB subdriver to use. You have a choice
362 between cypress, fabula, fuji, ippon, krauler, phoenix and sgs.
363 When using this option, it is mandatory to also specify the
364 vendorid and productid.
365 langid_fix = value
367 Apply the language ID workaround to the krauler subdriver. This is
368 mandatory for some devices to work (LDLC, Dynamix and others). You
369 must provide value (0x409 or 0x4095), according to your device
370 entry in NUT hardware compatibility list (HCL).
371 IMPLEMENTATION NOTES
373 fabula subdriver
374 This subdriver, meant to be used with the megatec protocol,
375 does not support the various test.battery commands. Plus, the
376 shutdown.return command ignores the values set in
377 ups.delay.start/ondelay and makes the UPS turn on the load as
378 soon as power is back.
379 fuji subdriver
381 This subdriver, meant to be used with the megatec protocol,
382 does not support the shutdown.stayoff and load.off commands.
383 Plus, the shutdown.return command ignores the values set in
384 ups.delay.start/ondelay and makes the UPS turn on the load as
385 soon as power is back.
386 krauler subdriver
388 This subdriver, meant to be used with the megatec protocol,
389 does not support the shutdown commands, i.e.: shutdown.return,
390 shutdown.stayoff and load.off.
391
393 This driver supports some instant commands (see upscmd(8)):
394 beeper.toggle
396 Toggle the UPS beeper. (Not available on some hardware)
397 load.on
399 Turn on the load immediately. (Not available on some hardware)
400 load.off
402 Turn off the load immediately (see KNOWN PROBLEMS).
403 shutdown.return
405 Turn off the load and return when power is back. Uses the timers
406 defined by ups.delay.start and ups.delay.shutdown.
407 shutdown.stayoff
409 Turn off the load and remain off (see KNOWN PROBLEMS). Uses the
410 timer defined by ups.delay.shutdown.
411 shutdown.stop
413 Stop a shutdown in progress.
414 test.battery.start.deep
416 Perform a long battery test. (Not available on some hardware)
417 test.battery.start.quick
419 Perform a quick (10 second) battery test.
420 test.battery.stop
422 Stop a running battery test. (Not available on some hardware)
423 BESTUPS, MECER, MEGATEC, MEGATEC/OLD, MUSTEK, Q1, ZINTO PROTOCOLS
425 test.battery.start value
426 Perform a battery test for the duration of value seconds (truncated
427 to 60 seconds) [60..5940].
428 VOLTRONIC POWER P98 UNITS (WITH MECER PROTOCOL)
430 test.battery.start value
431 Perform a battery test for the duration of value seconds
432 (truncated to 60 seconds) [12..5940]. This value is truncated
433 to units of 6 seconds (less than 60 seconds) or 60 seconds
434 (more than 60 seconds).
435 VOLTRONIC PROTOCOL
437 The following instant commands are available for the voltronic
438 protocol. Not all of them are available on all the UPSes supported by
439 this protocol.
440 beeper.enable
442 Enable the UPS beeper.
443 beeper.disable
445 Disable the UPS beeper.
446 test.battery.start value
448 Perform a battery test for the duration of value seconds
449 [12..5940]. This value is truncated to units of 6 seconds (less
450 than 60 seconds) or 60 seconds (more than 60 seconds).
451 outlet.1.load.off
453 Turn off outlet 1 load immediately.
454 outlet.1.load.on
456 Turn on outlet 1 load immediately.
457 outlet.2.load.off
459 Turn off outlet 2 load immediately.
460 outlet.2.load.on
462 Turn on outlet 2 load immediately.
463 outlet.3.load.off
465 Turn off outlet 3 load immediately.
466 outlet.3.load.on
468 Turn on outlet 3 load immediately.
469 outlet.4.load.off
471 Turn off outlet 4 load immediately.
472 outlet.4.load.on
474 Turn on outlet 4 load immediately.
475 bypass.start
477 Put the UPS in ECO Mode.
478 bypass.stop
480 Take the UPS out of ECO Mode.
481
483 Due to popular demand, this driver will report a guesstimated
484 battery.charge and optionally battery.runtime, provided you specified a
485 couple of the EXTRA ARGUMENTS listed above.
486 If you specify both battery.voltage.high and battery.voltage.low in
488 ups.conf(5), but don’t enter runtimecal, it will guesstimate the state
489 of charge by looking at the battery voltage alone. This is not reliable
490 under load, as this only gives reasonably accurate readings if you
491 disconnect the load, let the battery rest for a couple of minutes and
492 then measure the open cell voltage. This just isn’t practical if the
493 power went out and the UPS is providing power for your systems.
494 battery.voltage - battery.voltage.low
496 battery.charge = ------------------------------------------ x 100 %
497 battery.voltage.high - battery.voltage.low
498 There is a way to get better readings without disconnecting the load
500 but this requires one to keep track on how much (and how fast) current
501 is going in and out of the battery. If you specified the runtimecal,
502 the driver will attempt to do this. Note however, that this heavily
503 relies on the values you enter and that the UPS must be able to report
504 the load as well. There are quite a couple of devices that report 0 %
505 (or any other fixed value) at all times, in which case this obviously
506 doesn’t work.
507 The driver also has no way of determining the degradation of the
509 battery capacity over time, so you’ll have to deal with this yourself
510 (by adjusting the values in runtimecal). Also note that the driver
511 guesses the initial state of charge based on the battery voltage, so
512 this may be less than 100 %, even when you are certain that they are
513 full. There is just no way to reliably measure this between 0 and 100 %
514 full charge.
515 This is better than nothing (but not by much). If any of the above
517 calculations is giving you incorrect readings, you are the one that put
518 in the values in ups.conf(5), so don’t complain with the author. If you
519 need something better, buy a UPS that reports battery.charge and
520 battery.runtime all by itself without the help of a NUT driver.
521
523 The nutdrv_qx driver having replaced the megatec ones, some
524 configuration changes may be required by users switching to nutdrv_qx.
525 Part of this, the following megatec options, in ups.conf(5), have to be
527 changed:
528 battvolts
530 You need to use default.battery.voltage.high and
531 default.battery.voltage.low
532 dtr and rts
534 You need to use cablepower
535 ignoreoff
537 This parameter can simply be discarded, since it was a wrong
538 understanding of the specification.
539
541 The nutdrv_qx driver having replaced the blazer ones, some
542 configuration changes may be required by users switching to nutdrv_qx.
543 Part of this, the following blazer options, in ups.conf(5), have to be
545 changed:
546 ondelay
548 While the previous blazer drivers expected minutes, the new
549 nutdrv_qx driver wants seconds.
550 The following instant command has also been changed:
552 test.battery.start value
554 While the old blazer drivers expected a value in minutes, the
555 nutdrv_qx driver wants a value in seconds.
556
558 The nutdrv_qx driver having replaced the bestups one, some
559 configuration changes may be required by users switching to nutdrv_qx.
560 Part of this, the following bestups options, in ups.conf(5), are no
562 longer supported by this driver:
563 nombattvolt, battvoltmult
565 See BATTERY CHARGE.
566 ID
568 Discarded.
569
571 The nutdrv_qx driver having replaced the voltronic ones, some
572 configuration changes may be required by users switching to nutdrv_qx.
573 Part of this, the following voltronic options, in ups.conf(5), have to
575 be changed:
576 ondelay
578 While the previous voltronic drivers expected minutes, the new
579 nutdrv_qx driver wants seconds. It no longer defaults to 0 minutes
580 but to 3 minutes (i.e. 180 seconds) for compatibility with the
581 users switching from the old blazer drivers.
582 battnumb
584 This option has been renamed to battery_number.
585 The following options are no longer supported by this driver, you can
587 now change them more conveniently ‘on the fly’ calling upsrw(8) with
588 the appropriate NUT variable - provided that your UPS supports them.
589 battpacks → battery.packs
597 Set number of battery
599 packs in parallel [1..99].
600 This setting will change
601 the charge and runtime
602 estimation reported by the
603 UPS.
604 battlow → battery.voltage.low
606 Set minimum battery
608 voltage just before the
609 UPS automatically shuts
610 down. This setting will
611 change the charge and
612 runtime estimation
613 reported by the UPS.
614 auto_reboot → ups.start.auto
616 Enable or disable auto
618 reboot [enabled/disabled].
619 If enabled, the UPS will
620 auto recover when AC power
621 returns.
622 battery_protection → battery.protection
624 Enable or disable battery
626 deep discharge protection
627 [enabled/disabled].
628 energy_saving → battery.energysave
630 Enable or disable Green
632 power function
633 [enabled/disabled]. If
634 enabled, for energy
635 saving, the UPS will auto
636 off when there is no load.
637 cold_start → ups.start.battery
639 Enable or disable Cold
641 Start [enabled/disabled].
642 If enabled, the UPS can be
643 turned on also if AC is
644 not connected to the UPS.
645 outlet_control → outlet.0.switchable
663 Enable or disable
665 programmable outlets
666 control at battery mode
667 [enabled/disabled]. If
668 enabled, the UPS will cut
669 off programmable outlets
670 after backup time (set
671 through
672 outlet.{1,2,3,4}.delay.shutdown)
673 arrives. If disabled, the
674 UPS will provide
675 continuous power to
676 programmable outlets until
677 the battery is running
678 out.
679 max_eco_volt → input.transfer.high
681 Maximum voltage for ECO Mode
683 (V). If AC voltage is within
684 acceptable range, ECO mode will
685 be used (If the UPS is capable
686 of and it’s enabled).
687 min_eco_volt → input.transfer.low
689 Minimum voltage for ECO Mode
691 (V). If AC voltage is within
692 acceptable range, ECO mode will
693 be used (If the UPS is capable
694 of and it’s enabled).
695 max_eco_freq → input.frequency.high
697 Maximum frequency for ECO Mode
699 (Hz). If AC frequency is within
700 acceptable range, ECO mode will
701 be used (If the UPS is capable
702 of and it’s enabled).
703 min_eco_freq → input.frequency.low
705 Minimum frequency for ECO Mode
707 (Hz). If AC frequency is within
708 acceptable range, ECO mode will
709 be used (If the UPS is capable
710 of and it’s enabled).
711 outlet1_delay → outlet.1.delay.shutdown
713 Delay time before programmable
715 outlet 1 shuts down the load
716 when on battery mode [0..59940]
717 (seconds).
718 outlet2_delay → outlet.2.delay.shutdown
720 Delay time before programmable
722 outlet 2 shuts down the load
723 when on battery mode [0..59940]
724 (seconds).
725 outlet3_delay → outlet.3.delay.shutdown
729 Delay time before programmable
731 outlet 3 shuts down the load
732 when on battery mode [0..59940]
733 (seconds).
734 outlet4_delay → outlet.4.delay.shutdown
736 Delay time before programmable
738 outlet 4 shuts down the load
739 when on battery mode [0..59940]
740 (seconds).
741 batt_type → battery.type
743 Battery type (for P31 UPSes
745 only) [Li/Flooded/AGM].
746
749 Some UPS commands aren’t supported by all models. In most cases, the
750 driver will send a message to the system log when the user tries to
751 execute an unsupported command. Unfortunately, some models don’t even
752 provide a way for the driver to check for this, so the unsupported
753 commands will silently fail.
754 Both the load.off and shutdown.stayoff instant commands are meant to
756 turn the load off indefinitely. However, some UPS models don’t allow
757 this.
758 Some models report a bogus value for the beeper status (will always be
760 enabled or disabled). So, the beeper.toggle command may appear to have
761 no effect in the status reported by the driver when, in fact, it is
762 working fine.
763 The temperature and load value is known to be bogus in some models.
765 VOLTRONIC-QS UNITS
767 Both load.off and shutdown.stayoff instant commands are known to work
768 as expected (i.e. turn the load off indefinitely) only if mains is
769 present, otherwise, as soon as mains returns the load will be powered.
770 After issuing a shutdown.return instant command, the UPS won’t wait
772 ondelay before powering on the load, provided the following conditions
773 are met:
774 · if the load has been previously (no matter how long before) powered
776 off through load.off/shutdown.stayoffand powered on through
777 load.on/shutdown.stopand
778 · if AC wasn’t cut after issuing the load.off/shutdown.stayoff (i.e.
780 the UPS didn’t turn itself off) and
781 · if there’s a power outage after issuing the shutdown.return command
783 In this case, as soon as mains returns the load will be powered.
785 VOLTRONIC-QS-HEX UNITS
787 shutdown.return, load.off, and shutdown.stayoff instant commands are
788 known to work as expected only if mains is present, otherwise, as soon
789 as mains returns the load will be powered.
790
792 The UPSes supported by voltronic protocol report warnings through a
793 64bit flag (bit1bit2...bit63bit64) where 1 means that a warning arose,
794 while 0 means no warning. Since more than one warning at a time can be
795 signaled, and because of the limited space in the ups.alarm variable,
796 if the length of the warnings exceeds that of ups.alarms variable, they
797 will be reported as bits. If you want to know the explanation of that
798 bit you can either watch the log or see the next table (unlisted bits
799 equal to unknown warnings).
800 Table 1. UPS Warnings for voltronic UPSes
802 ┌───┬────────────────────────────┐
803 │ # │ Corresponding Warning │
804 ├───┼────────────────────────────┤
805 │ │ │
806 │ 1 │ Battery disconnected │
807 ├───┼────────────────────────────┤
808 │ │ │
809 │ 2 │ Neutral not connected │
810 ├───┼────────────────────────────┤
811 │ │ │
812 │ 3 │ Site fault │
813 ├───┼────────────────────────────┤
814 │ │ │
815 │ 4 │ Phase sequence incorrect │
816 ├───┼────────────────────────────┤
817 │ │ │
818 │ 5 │ Phase sequence incorrect │
819 │ │ in bypass │
820 ├───┼────────────────────────────┤
821 │ │ │
822 │ 6 │ Input frequency unstable │
823 │ │ in bypass │
824 ├───┼────────────────────────────┤
825 │ │ │
826 │ 7 │ Battery overcharged │
827 ├───┼────────────────────────────┤
828 │ │ │
829 │ 8 │ Low battery │
830 ├───┼────────────────────────────┤
831 │ │ │
832 │ 9 │ Overload alarm │
833 ├───┼────────────────────────────┤
834 │ │ │
835 │10 │ Fan alarm │
836 ├───┼────────────────────────────┤
837 │ │ │
838 │11 │ EPO enabled │
839 ├───┼────────────────────────────┤
840 │ │ │
841 │12 │ Unable to turn on UPS │
842 ├───┼────────────────────────────┤
843 │ │ │
844 │13 │ Over temperature alarm │
845 ├───┼────────────────────────────┤
846 │ │ │
847 │14 │ Charger alarm │
848 ├───┼────────────────────────────┤
849 │ │ │
850 │15 │ Remote auto shutdown │
851 ├───┼────────────────────────────┤
852 │ │ │
853 │16 │ L1 input fuse not working │
854 ├───┼────────────────────────────┤
855 │ │ │
856 │17 │ L2 input fuse not working │
857 ├───┼────────────────────────────┤
858 │ │ │
859 │18 │ L3 input fuse not working │
860 ├───┼────────────────────────────┤
861 │ │ │
862 │19 │ Positive PFC abnormal in │
863 │ │ L1 │
864 ├───┼────────────────────────────┤
865 │ │ │
866 │20 │ Negative PFC abnormal in │
867 │ │ L1 │
868 ├───┼────────────────────────────┤
869 │ │ │
870 │21 │ Positive PFC abnormal in │
871 │ │ L2 │
872 ├───┼────────────────────────────┤
873 │ │ │
874 │22 │ Negative PFC abnormal in │
875 │ │ L2 │
876 ├───┼────────────────────────────┤
877 │ │ │
878 │23 │ Positive PFC abnormal in │
879 │ │ L3 │
880 ├───┼────────────────────────────┤
881 │ │ │
882 │24 │ Negative PFC abnormal in │
883 │ │ L3 │
884 ├───┼────────────────────────────┤
885 │ │ │
886 │25 │ Abnormal in CAN-bus │
887 │ │ communication │
888 ├───┼────────────────────────────┤
889 │ │ │
890 │26 │ Abnormal in synchronous │
891 │ │ signal circuit │
892 ├───┼────────────────────────────┤
893 │ │ │
894 │27 │ Abnormal in synchronous │
895 │ │ pulse signal circuit │
896 ├───┼────────────────────────────┤
897 │ │ │
898 │28 │ Abnormal in host signal │
899 │ │ circuit │
900 ├───┼────────────────────────────┤
901 │ │ │
902 │29 │ Male connector of parallel │
903 │ │ cable not connected well │
904 ├───┼────────────────────────────┤
905 │ │ │
906 │30 │ Female connector of │
907 │ │ parallel cable not │
908 │ │ connected well │
909 ├───┼────────────────────────────┤
910 │ │ │
911 │31 │ Parallel cable not │
912 │ │ connected well │
913 ├───┼────────────────────────────┤
914 │ │ │
915 │32 │ Battery connection not │
916 │ │ consistent in parallel │
917 │ │ systems │
918 ├───┼────────────────────────────┤
919 │ │ │
920 │33 │ AC connection not │
921 │ │ consistent in parallel │
922 │ │ systems │
923 ├───┼────────────────────────────┤
924 │ │ │
925 │34 │ Bypass connection not │
926 │ │ consistent in parallel │
927 │ │ systems │
928 ├───┼────────────────────────────┤
929 │ │ │
930 │35 │ UPS model types not │
931 │ │ consistent in parallel │
932 │ │ systems │
933 ├───┼────────────────────────────┤
934 │ │ │
935 │36 │ Capacity of UPSs not │
936 │ │ consistent in parallel │
937 │ │ systems │
938 ├───┼────────────────────────────┤
939 │ │ │
940 │37 │ Auto restart setting not │
941 │ │ consistent in parallel │
942 │ │ systems │
943 ├───┼────────────────────────────┤
944 │ │ │
945 │38 │ Battery cell over charge │
946 ├───┼────────────────────────────┤
947 │ │ │
948 │39 │ Battery protection setting │
949 │ │ not consistent in parallel │
950 │ │ systems │
951 ├───┼────────────────────────────┤
952 │ │ │
953 │40 │ Battery detection setting │
954 │ │ not consistent in parallel │
955 │ │ systems │
956 ├───┼────────────────────────────┤
957 │ │ │
958 │41 │ Bypass not allowed setting │
959 │ │ not consistent in parallel │
960 │ │ systems │
961 ├───┼────────────────────────────┤
962 │ │ │
963 │42 │ Converter setting not │
964 │ │ consistent in parallel │
965 │ │ systems │
966 ├───┼────────────────────────────┤
967 │ │ │
968 │43 │ High loss point for │
969 │ │ frequency in bypass mode │
970 │ │ not consistent in parallel │
971 │ │ systems │
972 ├───┼────────────────────────────┤
973 │ │ │
974 │44 │ Low loss point for │
975 │ │ frequency in bypass mode │
976 │ │ not consistent in parallel │
977 │ │ systems │
978 ├───┼────────────────────────────┤
979 │ │ │
980 │45 │ High loss point for │
981 │ │ voltage in bypass mode not │
982 │ │ consistent in parallel │
983 │ │ systems │
984 ├───┼────────────────────────────┤
985 │ │ │
986 │46 │ Low loss point for voltage │
987 │ │ in bypass mode not │
988 │ │ consistent in parallel │
989 │ │ systems │
990 ├───┼────────────────────────────┤
991 │ │ │
992 │47 │ High loss point for │
993 │ │ frequency in AC mode not │
994 │ │ consistent in parallel │
995 │ │ systems │
996 ├───┼────────────────────────────┤
997 │ │ │
998 │48 │ Low loss point for │
999 │ │ frequency in AC mode not │
1000 │ │ consistent in parallel │
1001 │ │ systems │
1002 ├───┼────────────────────────────┤
1003 │ │ │
1004 │49 │ High loss point for │
1005 │ │ voltage in AC mode not │
1006 │ │ consistent in parallel │
1007 │ │ systems │
1008 ├───┼────────────────────────────┤
1009 │ │ │
1010 │50 │ Low loss point for voltage │
1011 │ │ in AC mode not consistent │
1012 │ │ in parallel systems │
1013 ├───┼────────────────────────────┤
1014 │ │ │
1015 │51 │ Warning for locking in │
1016 │ │ bypass mode after 3 │
1017 │ │ consecutive overloads │
1018 │ │ within 30 min │
1019 ├───┼────────────────────────────┤
1020 │ │ │
1021 │52 │ Warning for three-phase AC │
1022 │ │ input current unbalance │
1023 ├───┼────────────────────────────┤
1024 │ │ │
1025 │53 │ Warning for a three-phase │
1026 │ │ input current unbalance │
1027 │ │ detected in battery mode │
1028 ├───┼────────────────────────────┤
1029 │ │ │
1030 │54 │ Warning for Inverter │
1031 │ │ inter-current unbalance │
1032 ├───┼────────────────────────────┤
1033 │ │ │
1034 │55 │ Programmable outlets cut │
1035 │ │ off pre-alarm │
1036 ├───┼────────────────────────────┤
1037 │ │ │
1038 │56 │ Warning for Battery │
1039 │ │ replace │
1040 ├───┼────────────────────────────┤
1041 │ │ │
1042 │57 │ Abnormal warning on input │
1043 │ │ phase angle │
1044 ├───┼────────────────────────────┤
1045 │ │ │
1046 │58 │ Warning!! Cover of │
1047 │ │ maintain switch is open │
1048 ├───┼────────────────────────────┤
1049 │ │ │
1050 │62 │ EEPROM operation error │
1051 └───┴────────────────────────────┘
1052
1054 Daniele Pezzini <hyouko@gmail.com>, Arnaud Quette
1055 <arnaud.quette@gmail.com>, John Stamp <kinsayder@hotmail.com>, Peter
1056 Selinger <selinger@users.sourceforge.net>, Arjen de Korte
1057 <adkorte-guest@alioth.debian.org>, Alexander Gordeev
1058 <lasaine@lvk.cs.msu.su>
1059
1061 blazer_ser(8), blazer_usb(8), nutupsdrv(8), ups.conf(5), upsc(8),
1062 upscmd(8), upsdrvctl(8), upsmon(8), upsrw(8)
1063 Internet Resources:
1065 The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
1066 The NUT HCL: http://www.networkupstools.org/stable-hcl.html
1068Network UPS Tools 2.7.3. 03/09/2016 NUTDRV_QX(8)