lagertonne/nut
1
0
Fork 0
Code Issues Pull requests Projects Releases 2 Wiki Activity

Imported Upstream version 2.7.3

Browse source
This commit is contained in:
Arnaud Quette 2015-04-30 15:53:36 +02:00
parent a356b56d11
commit fd413a3168
283 changed files with 14978 additions and 6511 deletions
Download patch file Download diff file Expand all files Collapse all files

142
docs/man/nutdrv_qx.8
View file

@ -1,13 +1,13 @@
'\" t
.\" Title: nutdrv_qx
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 02/25/2014
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\" Date: 04/22/2015
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1.5
.\" Source: Network UPS Tools 2.7.3
.\" Language: English
.\"
.TH "NUTDRV_QX" "8" "02/25/2014" "Network UPS Tools 2\&.7\&.1\&." "NUT Manual"
.TH "NUTDRV_QX" "8" "04/22/2015" "Network UPS Tools 2\&.7\&.3" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -112,13 +112,15 @@ seconds (if mains meanwhile returned)\&.
\fBprotocol =\fR \fIstring\fR
.RS 4
Skip autodetection of the protocol to use and only use the one specified\&. Supported values:
\fIbestups\fR,
\fImecer\fR,
\fImegatec\fR,
\fImegatec/old\fR,
\fImustek\fR,
\fIq1\fR,
\fIvoltronic\fR,
\fIvoltronic\-qs\fR
\fIvoltronic\-qs\fR,
\fIvoltronic\-qs\-hex\fR
and
\fIzinto\fR\&.
.sp
@ -201,6 +203,13 @@ Minimum battery load used by the driver to estimate the runtime\&. If not specif
\fBruntimecal\fR
is also specified\&.
.RE
.SS "BESTUPS, MECER, MEGATAEC, MEGATEC/OLD, MUSTEK, Q1, VOLTRONIC\-QS, VOLTRONIC\-QS\-HEX, ZINTO PROTOCOLS"
.PP
\fBignoresab\fR
.RS 4
Some UPSes incorrectly report the \(oqShutdown Active\(cq bit as always on, consequently making the driver believe the UPS is nearing a shutdown (and, as a result, ups\&.status always contains
FSD\&... and you know what this means)\&. Setting this flag will make the driver ignore the \(oqShutdown Active\(cq bit\&.
.RE
.SS "MECER, MEGATAEC, MEGATEC/OLD, MUSTEK, ZINTO PROTOCOLS"
.PP
\fBondelay\fR
@ -226,6 +235,30 @@ Some UPSes will lock up if you attempt to read rating information from them\&. S
.RS 4
Some UPSes will lock up if you attempt to read vendor information from them\&. Setting this flag will make the driver skip this step\&.
.RE
.SS "BESTUPS PROTOCOL"
.PP
\fBondelay\fR
.RS 4
The acceptable range is
60\&.\&.599940
seconds\&.
.RE
.PP
\fBoffdelay\fR
.RS 4
The acceptable range is
12\&.\&.5940
seconds\&.
.RE
.PP
\fBpins_shutdown_mode =\fR \fIvalue\fR
.RS 4
Set
shutdown mode functionality of Pin 1 and Pin 7
on the UPS DB9 communication port (Per Best Power\(cqs EPS\-0059) to
\fIvalue\fR
[0\&.\&.6]\&.
.RE
.SS "Q1 PROTOCOL"
.PP
\fBondelay\fR
@ -241,7 +274,7 @@ The acceptable range is
12\&.\&.600
seconds\&.
.RE
.SS "VOLTRONIC\-QS PROTOCOL"
.SS "VOLTRONIC\-QS, VOLTRONIC\-QS\-HEX PROTOCOLS"
.PP
\fBondelay\fR
.RS 4
@ -374,7 +407,7 @@ Enable or disable Battery Open Status Check [enabled/disabled]\&. If enabled, wh
Enable or disable site fault detection [enabled/disabled]\&. If enabled, the UPS will beep when the input neutral and hot wires are reversed\&.
.RE
.PP
\fBcostant_phase_angle =\fR \fIstring\fR
\fBconstant_phase_angle =\fR \fIstring\fR
.RS 4
Enable or disable Constant Phase Angle Function (output and input phase angles are not equal) [enabled/disabled]\&.
.RE
@ -484,7 +517,6 @@ Examples:
.sp -1
.IP \(bu 2.3
.\}
\-x vendor="Foo\&.Corporation\&.*"
.RE
.sp
@ -496,7 +528,6 @@ Examples:
.sp -1
.IP \(bu 2.3
.\}
\-x vendorid=051d*
(APC)
.RE
@ -509,7 +540,6 @@ Examples:
.sp -1
.IP \(bu 2.3
.\}
\-x product="\&.*(Smart|Back)\-?UPS\&.*"
.RE
.RE
@ -524,10 +554,13 @@ bus="00[2\-3]")\&.
\fBsubdriver =\fR \fIstring\fR
.RS 4
Select a serial\-over\-USB subdriver to use\&. You have a choice between
\fBphoenix\fR,
\fBcypress\fR,
\fBfabula\fR,
\fBfuji\fR,
\fBippon\fR,
\fBcypress\fR, and
\fBkrauler\fR\&. When using this option, it is mandatory to also specify the
\fBkrauler\fR
and
\fBphoenix\fR\&. When using this option, it is mandatory to also specify the
\fBvendorid\fR
and
\fBproductid\fR\&.
@ -543,6 +576,60 @@ subdriver\&. This is mandatory for some devices to work (LDLC, Dynamix and other
or
0x4095), according to your device entry in NUT hardware compatibility list (HCL)\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBIMPLEMENTATION NOTES\fR
.RS 4
.PP
\fB\fIfabula\fR\fR\fB subdriver\fR
.RS 4
This subdriver, meant to be used with the
\fImegatec\fR
protocol, does
\fBnot\fR
support the various
\fBtest\&.battery\fR
commands\&. Plus, the
\fBshutdown\&.return\fR
command ignores the values set in
\fIups\&.delay\&.start\fR/\fBondelay\fR
and makes the UPS turn on the load as soon as power is back\&.
.RE
.PP
\fB\fIfuji\fR\fR\fB subdriver\fR
.RS 4
This subdriver, meant to be used with the
\fImegatec\fR
protocol, does
\fBnot\fR
support the
\fBshutdown\&.stayoff\fR
and
\fBload\&.off\fR
commands\&. Plus, the
\fBshutdown\&.return\fR
command ignores the values set in
\fIups\&.delay\&.start\fR/\fBondelay\fR
and makes the UPS turn on the load as soon as power is back\&.
.RE
.PP
\fB\fIkrauler\fR\fR\fB subdriver\fR
.RS 4
This subdriver, meant to be used with the
\fImegatec\fR
protocol, does
\fBnot\fR
support the shutdown commands, i\&.e\&.:
\fBshutdown\&.return\fR,
\fBshutdown\&.stayoff\fR
and
\fBload\&.off\fR\&.
.RE
.RE
.SH "UPS COMMANDS"
.sp
This driver supports some instant commands (see \fBupscmd\fR(8)):
@ -554,7 +641,7 @@ Toggle the UPS beeper\&. (Not available on some hardware)
.PP
\fBload\&.on\fR
.RS 4
Turn on the load immediately\&.
Turn on the load immediately\&. (Not available on some hardware)
.RE
.PP
\fBload\&.off\fR
@ -597,7 +684,7 @@ Perform a quick (10 second) battery test\&.
.RS 4
Stop a running battery test\&. (Not available on some hardware)
.RE
.SS "MECER, MEGATEC, MEGATEC/OLD, MUSTEK, Q1, ZINTO PROTOCOLS"
.SS "BESTUPS, MECER, MEGATEC, MEGATEC/OLD, MUSTEK, Q1, ZINTO PROTOCOLS"
.PP
\fBtest\&.battery\&.start\fR \fIvalue\fR
.RS 4
@ -763,6 +850,22 @@ driver wants a
\fIvalue\fR
in seconds\&.
.RE
.SH "NOTES FOR THE PREVIOUS USER OF BESTUPS DRIVER"
.sp
The \fBnutdrv_qx\fR driver having replaced the bestups one, some configuration changes may be required by users switching to \fBnutdrv_qx\fR\&.
.sp
Part of this, the following bestups options, in \fBups.conf\fR(5), are no longer supported by this driver:
.PP
\fBnombattvolt\fR, \fBbattvoltmult\fR
.RS 4
See
BATTERY CHARGE\&.
.RE
.PP
\fBID\fR
.RS 4
Discarded\&.
.RE
.SH "NOTES FOR THE PREVIOUS USER OF VOLTRONIC DRIVERS"
.sp
The \fBnutdrv_qx\fR driver having replaced the voltronic ones, some configuration changes may be required by users switching to \fBnutdrv_qx\fR\&.
@ -971,11 +1074,9 @@ After issuing a \fBshutdown\&.return\fR instant command, the UPS won\(cqt wait \
.IP \(bu 2.3
.\}
if the load has been previously (no matter how long before) powered off through
\fBload\&.off\fR/\fBshutdown\&.stayoff\fR
\fIand\fR
\fBload\&.off\fR/\fBshutdown\&.stayoff\fR\fIand\fR
powered on through
\fBload\&.on\fR/\fBshutdown\&.stop\fR
\fIand\fR
\fBload\&.on\fR/\fBshutdown\&.stop\fR\fIand\fR
.RE
.sp
.RS 4
@ -1006,6 +1107,9 @@ command
.RE
.sp
In this case, as soon as mains returns the load will be powered\&.
.SS "VOLTRONIC\-QS\-HEX UNITS"
.sp
\fBshutdown\&.return\fR, \fBload\&.off\fR, and \fBshutdown\&.stayoff\fR instant commands are known to work as expected only if mains is present, otherwise, as soon as mains returns the load will be powered\&.
.SH "UPS WARNINGS (VOLTRONIC PROTOCOL)"
.sp
The UPSes supported by \fIvoltronic\fR protocol report warnings through a 64bit flag (bit1bit2\&...bit63bit64) where 1 means that a warning arose, while 0 means no warning\&. Since more than one warning at a time can be signaled, and because of the limited space in the ups\&.alarm variable, if the length of the warnings exceeds that of ups\&.alarms variable, they will be reported as bits\&. If you want to know the explanation of that bit you can either watch the log or see the next table (unlisted bits equal to unknown warnings)\&.