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

Imported Upstream version 2.7.2

Browse source
This commit is contained in:
Laurent Bigonville 2014-04-22 20:39:47 +02:00
parent 0121794af9
commit a356b56d11
263 changed files with 6039 additions and 8151 deletions
Download patch file Download diff file Expand all files Collapse all files

152
docs/man/nutdrv_qx.8
View file

@ -2,12 +2,12 @@
.\" Title: nutdrv_qx
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\" Date: 11/18/2013
.\" Date: 02/25/2014
.\" Manual: NUT Manual
.\" Source: Network UPS Tools 2.7.1-pre2
.\" Source: Network UPS Tools 2.7.1.5
.\" Language: English
.\"
.TH "NUTDRV_QX" "8" "11/18/2013" "Network UPS Tools 2\&.7\&.1\-p" "NUT Manual"
.TH "NUTDRV_QX" "8" "02/25/2014" "Network UPS Tools 2\&.7\&.1\&." "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -34,7 +34,7 @@ nutdrv_qx \- Driver for Q* protocol serial and USB based UPS equipment
This man page only documents the hardware\-specific features of the \fBnutdrv_qx\fR driver\&. For information about the core driver, see \fBnutupsdrv\fR(8)\&.
.SH "SUPPORTED HARDWARE"
.sp
The \fBnutdrv_qx\fR driver is known to work with various UPSes from \fIBlazer\fR, \fIEnergy Sistem\fR, \fIFenton Technologies\fR, \fIGeneral Electric\fR, \fIMustek\fR, \fIVoltronic Power\fR (rebranded by many, many \- have I said many? \- others\&.\&. Long story short: if your UPS came with a software called \fIViewpower\fR, chances are high that it works with this driver with the \fIvoltronic\fR protocol) and many others\&.
The \fBnutdrv_qx\fR driver is known to work with various UPSes from \fIBlazer\fR, \fIEnergy Sistem\fR, \fIFenton Technologies\fR, \fIGeneral Electric\fR, \fIMustek\fR, \fIVoltronic Power\fR (rebranded by many, many \- have I said many? \- others\&.\&. Long story short: if your UPS came with a software called \fIViewpower\fR, chances are high that it works with this driver with one of the \fIvoltronic*\fR protocols or with the \fImecer\fR one) and many others\&.
.sp
The NUT compatibility table lists all the known supported models\&. Keep in mind, however, that other models not listed there may also be supported, but haven\(cqt been tested\&.
.sp
@ -47,9 +47,11 @@ The following are the ones that most likely will need changing (see \fBups.conf\
.PP
\fBondelay =\fR \fIvalue\fR
.RS 4
Time to wait before switching on the UPS (seconds)\&. This value is truncated to units of 60 seconds\&. The acceptable range is
0\&.\&.599940
seconds\&. Note that a value below 3 minutes, may cause earlier firmware versions to not switch on automatically, so it defaults to 3 minutes (i\&.e\&. 180 seconds)\&. This option provides a default value for
Time to wait before switching on the UPS (seconds)\&. This value is truncated to units of 60 seconds\&.
.sp
Note that a value below 3 minutes, may cause earlier firmware versions to not switch on automatically, so it defaults to 3 minutes (i\&.e\&. 180 seconds)\&.
.sp
This option provides a default value for
\fBups\&.delay\&.start\fR
that will then be used by the driver in the automatic shutdown sequence (i\&.e\&. calling the driver with the
\fB\-k\fR
@ -69,7 +71,9 @@ with
.PP
\fBoffdelay =\fR \fIvalue\fR
.RS 4
Time to wait before shutting down the UPS (seconds)\&. This value is truncated to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60 seconds)\&. Defaults to 30 seconds\&. This option provides a default value for
Time to wait before shutting down the UPS (seconds)\&. This value is truncated to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60 seconds)\&. Defaults to 30 seconds\&.
.sp
This option provides a default value for
\fBups\&.delay\&.shutdown\fR
that will then be used by the driver in the automatic shutdown sequence (i\&.e\&. calling the driver with the
\fB\-k\fR
@ -95,7 +99,8 @@ when FSD arises the UPS will call a
\fBshutdown\&.stayoff\fR
shutting down after
\fBups\&.delay\&.shutdown\fR
seconds and won\(cqt return, otherwise (standard behaviour) the UPS will call
seconds and won\(cqt return (see
KNOWN PROBLEMS), otherwise (standard behaviour) the UPS will call
\fBshutdown\&.return\fR
shutting down after
\fBups\&.delay\&.shutdown\fR
@ -106,14 +111,27 @@ seconds (if mains meanwhile returned)\&.
.PP
\fBprotocol =\fR \fIstring\fR
.RS 4
Skip autodetection of the protocol to use and only use the one specified\&. Supported values
Skip autodetection of the protocol to use and only use the one specified\&. Supported values:
\fImecer\fR,
\fImegatec\fR,
\fImegatec/old\fR,
\fImustek\fR,
\fIvoltronic\fR
\fIq1\fR,
\fIvoltronic\fR,
\fIvoltronic\-qs\fR
and
\fIzinto\fR\&.
.sp
Note that if you end up using the
\fIq1\fR
protocol, you may want to give a try to the
\fImecer\fR,
\fImegatec\fR
and
\fIzinto\fR
ones setting the
\fBnovendor\fR/\fBnorating\fR flags
(only one, or both)\&.
.RE
.PP
\fBpollfreq =\fR \fIvalue\fR
@ -185,6 +203,13 @@ is also specified\&.
.RE
.SS "MECER, MEGATAEC, MEGATEC/OLD, MUSTEK, ZINTO PROTOCOLS"
.PP
\fBondelay\fR
.RS 4
The acceptable range is
0\&.\&.599940
seconds\&.
.RE
.PP
\fBoffdelay\fR
.RS 4
The acceptable range is
@ -201,10 +226,47 @@ 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 "Q1 PROTOCOL"
.PP
\fBondelay\fR
.RS 4
The acceptable range is
0\&.\&.599940
seconds\&.
.RE
.PP
\fBoffdelay\fR
.RS 4
The acceptable range is
12\&.\&.600
seconds\&.
.RE
.SS "VOLTRONIC\-QS PROTOCOL"
.PP
\fBondelay\fR
.RS 4
The acceptable range is
60\&.\&.599940
seconds\&.
.RE
.PP
\fBoffdelay\fR
.RS 4
The acceptable range is
12\&.\&.540
seconds\&.
.RE
.SS "VOLTRONIC PROTOCOL"
.sp
The following options are supported only by the \fIvoltronic\fR protocol\&. Not all of them are available on all the UPSes supported by this protocol\&.
.PP
\fBondelay\fR
.RS 4
The acceptable range is
0\&.\&.599940
seconds\&.
.RE
.PP
\fBoffdelay\fR
.RS 4
The acceptable range is
@ -535,7 +597,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, ZINTO PROTOCOLS"
.SS "MECER, MEGATEC, MEGATEC/OLD, MUSTEK, Q1, ZINTO PROTOCOLS"
.PP
\fBtest\&.battery\&.start\fR \fIvalue\fR
.RS 4
@ -543,6 +605,22 @@ Perform a battery test for the duration of
\fIvalue\fR
seconds (truncated to 60 seconds) [60\&.\&.5940]\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBVOLTRONIC POWER P98 UNITS (WITH MECER PROTOCOL)\fR
.RS 4
.PP
\fBtest\&.battery\&.start\fR \fIvalue\fR
.RS 4
Perform a battery test for the duration of
\fIvalue\fR
seconds (truncated to 60 seconds) [12\&.\&.5940]\&. This value is truncated to units of 6 seconds (less than 60 seconds) or 60 seconds (more than 60 seconds)\&.
.RE
.RE
.SS "VOLTRONIC PROTOCOL"
.sp
The following instant commands are available for the \fIvoltronic\fR protocol\&. Not all of them are available on all the UPSes supported by this protocol\&.
@ -878,6 +956,56 @@ Both the \fBload\&.off\fR and \fBshutdown\&.stayoff\fR instant commands are mean
Some models report a bogus value for the beeper status (will always be \fIenabled\fR or \fIdisabled\fR)\&. So, the \fBbeeper\&.toggle\fR command may appear to have no effect in the status reported by the driver when, in fact, it is working fine\&.
.sp
The temperature and load value is known to be bogus in some models\&.
.SS "VOLTRONIC\-QS UNITS"
.sp
Both \fBload\&.off\fR and \fBshutdown\&.stayoff\fR instant commands are known to work as expected (i\&.e\&. turn the load off indefinitely) only if mains is present, otherwise, as soon as mains returns the load will be powered\&.
.sp
After issuing a \fBshutdown\&.return\fR instant command, the UPS won\(cqt wait \fBondelay\fR before powering on the load, provided the following conditions are met:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.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
powered on through
\fBload\&.on\fR/\fBshutdown\&.stop\fR
\fIand\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
if AC wasn\(cqt cut after issuing the
\fBload\&.off\fR/\fBshutdown\&.stayoff\fR
(i\&.e\&. the UPS didn\(cqt turn itself off)
\fIand\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
if there\(cqs a power outage after issuing the
\fBshutdown\&.return\fR
command
.RE
.sp
In this case, 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)\&.