Imported Upstream version 2.6.1

This commit is contained in:
Arnaud Quette 2011-06-01 22:31:49 +02:00
parent 459aaf9392
commit a367d9bc54
178 changed files with 4651 additions and 3279 deletions

View file

@ -2,12 +2,12 @@
.\" Title: powercom
.\" Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/24/2010
.\" Date: 05/31/2011
.\" Manual: NUT Manual
.\" Source: Network UPS Tools
.\" Language: English
.\"
.TH "POWERCOM" "8" "12/24/2010" "Network UPS Tools" "NUT Manual"
.TH "POWERCOM" "8" "05/31/2011" "Network UPS Tools" "NUT Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -41,7 +41,7 @@ This driver supports the following optional settings in the \fBups.conf\fR(5) fi
.PP
\fBlinevoltage\fR=\fIvalue\fR
.RS 4
An integer specifying the mains voltage\&. It can\(cqt be auto detected\&. Acceptable values are in the range of 110\(em120 or 220\(em240\&. The default is
An integer specifying the line voltage\&. It can\(cqt be auto detected\&. Acceptable values are in the range of 110\-120 or 220\-240\&. The default is
\fI230\fR\&.
.RE
.PP
@ -66,23 +66,30 @@ Like modelname above, but for the serial number\&. The default is
\fBtype\fR=\fIname\fR
.RS 4
The exact type of the communication protocol within the powercom family, that will be used to communicate with the UPS\&. The type is named after the first modelname that was coded with that protocol\&. The acceptable names are
\fIKP625AP\fR,
\fITrust\fR,
\fIEgys\fR,
\fIKP625AP\fR,
\fIIMP\fR,
\fIKIN\fR,
\fIBNT\fR,
\fIIMP\fR
and
\fIBNT\fR, and
\fIBNT\-other\fR\&. The default is
\fITrust\fR\&.
.sp
\fIBNT\-other\fR
is a special type for BNT 100\-120V models\&. For this type you can (I think must!) specify voltage, batteryPercentage, loadPercentage and validationSequence\&.
is a special type for other BNT models (such as the 1500A at 120V and can be used to override ALL models using ALL of the following values\&.
.RE
.PP
\fBshutdownArguments\fR={{\fIminutes\fR,\fIseconds\fR},\fIwhether_minutes_should_be_used\fR}
.RS 4
The minutes and seconds that the UPS should wait between receiving the shutdown command and actually shutting off\&. The other argument should be set to the character
\fIn\fR
only when the minutes value should be skipped and not sent to the UPS\&. The default is type\-dependent and is given below\&. The braces and commas are mandatory\&. Note that there should be no whitespace characters\&.
.RE
.PP
\fBnumOfBytesFromUPS\fR=\fIvalue\fR
.RS 4
The number of bytes in a UPS frame\&. The default is type\-dependent and is given below\&.
The number of bytes in a UPS frame: 16 is common, 11 for
\fITrust\fR\&. The default is type\-dependent and is given below\&.
.RE
.PP
\fBmethodOfFlowControl\fR=\fIname\fR
@ -94,36 +101,29 @@ or
\fIno_flow_control\fR\&.
.RE
.PP
\fBshutdownArguments\fR={{\fIminutes\fR,\fIseconds\fR},\fIwhether_minutes_should_be_used\fR}
.RS 4
The minutes and seconds that the UPS should wait between receiving the shutdown command and actually shutting off\&. The other argument should be set to the character
\fIn\fR
only when the minutes value should be skipped and not sent to the UPS\&. The default is type\-dependent and is given below\&. The braces and commas are mandatory\&. Note that there should be no whitespace characters\&.
.RE
.PP
\fBvoltage\fR={\fIcoefficient1\fR,\fIcoefficient2\fR,\fIcoefficient3\fR,\fIcoefficient4\fR}
.RS 4
(Only for types KP625AP, Trust, Egys, BNT\-other\&.) A quad that is used convert the raw data to a human\-readable voltage reading\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory, as well as the lack of whitespace characters\&.
.RE
.PP
\fBfrequency\fR={\fIcoefficient1\fR,\fIcoefficient2\fR}
.RS 4
(Only for types KP625AP, Trust, Egys\&.) A pair to convert the raw data to a human\-readable frequency reading\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory as well, as the lack of whitespace characters\&.
.RE
.PP
\fBbatteryPercentage\fR={\fIcoefficient1\fR,\fIcoefficient2\fR,\fIcoefficient3\fR,\fIcoefficient4\fR,\fIcoefficient5\fR}
.RS 4
(Only for KP625AP, Trust, Egys, BNT\-other\&.) A 5 tuple to convert the raw data to a human\-readable battery percentage reading\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory, as the lack of white space characters\&.
.RE
.PP
\fBloadPercentage\fR={\fIcoefficient1\fR,\fIcoefficient2\fR,\fIcoefficient3\fR,\fIcoefficient4\fR}
.RS 4
(Only for types KP625AP, Trust, Egys, BNT\-other\&.) A quad to convert the raw data to human readable load percentage reading\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory, as the lack of white space characters\&.
.RE
.PP
\fBvalidationSequence\fR={{\fIindex1\fR,\fIvalue1\fR},{\fIindex2\fR,\fIvalue2\fR},{\fIindex3\fR,\fIvalue3\fR}}
.RS 4
(Only for types KP625AP, Trust, Egys, BNT\-other\&.) 3 pairs to be used for validating the UPS by comparing bytes of the raw data with constant values\&. The default is type\-dependent and is given below\&. The braces and commas are mandatory, as the lack of white space characters\&.
(Only for types KP625AP, Trust, Egys\&.) 3 pairs to be used for validating the UPS by comparing bytes of the raw data with constant values\&. The index selects the byte from the UPS (see numOfBytesFromUPS) and the value is for matching to the byte\&. The default is type\-dependent and is given below\&. The braces and commas are mandatory, as the lack of white space characters\&.
.RE
.PP
\fBfrequency\fR={\fIA\fR,\fIB\fR}
.RS 4
(Only for types KP625AP, Trust, Egys\&.) A pair to convert the raw frequency data to a human\-readable frequency reading using the function 1/(A*x+B)\&. If the raw value x IS the frequency, then set A=1/(x^2) and B=0\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory as well, as the lack of whitespace characters\&.
.RE
.PP
\fBloadPercentage\fR={\fIBatteryA\fR,\fIBatteryB\fR,\fILineA\fR,\fILineB\fR}
.RS 4
(Only for types KP625AP, Trust, Egys\&.) A quad to convert the raw load data to human readable load percentage reading using the function A*x+B\&. If the raw value x IS the Load Percent, then set A=1 and B=0\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory, as the lack of white space characters\&.
.RE
.PP
\fBbatteryPercentage\fR={\fIBattery1\fR,\fIBattery2\fR,\fIBattery3\fR,\fILine4\fR,\fILine5\fR}
.RS 4
(Only for KP625AP, Trust, Egys\&.) A 5 tuple to convert the raw battery and line data to a human\-readable battery and line percentage reading using the functions (Battery) A*x+B*y+C and (Line) D*x+E\&. If the raw value x IS the Battery Percent, then set A=1, B=0, C=0, D=1, E=0\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory, as the lack of white space characters\&.
.RE
.PP
\fBvoltage\fR={\fI240A\fR,\fI240B\fR,\fI120A\fR,\fI120B\fR}
.RS 4
(Only for types KP625AP, Trust, Egys\&.) A quad that is used convert the raw voltage data to a human\-readable voltage reading using the function A*x+B\&. If the raw value x IS HALF the Voltage, then set A=2, B=0\&. The default is type\-dependent and is given below\&. Do note that the braces and commas are mandatory, as well as the lack of whitespace characters\&.
.RE
.SH "DEFAULT VALUES FOR THE EXTRA ARGUMENTS"
.sp
@ -141,7 +141,7 @@ type = Trust
.RE
.\}
.sp
The rest of the default values for the extra arguments are type\-dependent:
The rest of the default values for the extra arguments are type\-dependent\&. However, \fIBNT\-other\fR is a special type that can be used to override ALL values for ALL models\&.
.SS "Trust"
.sp
.if n \{\
@ -248,16 +248,17 @@ numOfBytesFromUPS = 16
methodOfFlowControl = no_flow_control
validationSequence = {{8,0},{8,0},{8,0}}
shutdownArguments = {{1,30},y}
loadPercentage = {1\&.4474,0\&.0,0\&.8594,0\&.0}
batteryPercentage = {5\&.0000,0\&.3268,\-825\&.00,0\&.46511,0}
voltage = {1\&.9216,\-0\&.0977,0\&.82857,0\&.0000}
frequency = {0\&.00027778,0\&.0000}
loadPercentage = {1\&.0000,0\&.0,1\&.0000,0\&.0}
batteryPercentage = {1\&.0000,0\&.0000,0\&.0000,1\&.0000,0\&.0000}
voltage = {2\&.0000,0\&.0000,2\&.0000,0\&.0000}
.fi
.if n \{\
.RE
.\}
.SH "AUTHOR"
.sp
Peter Bieringer <pb@bieringer\&.de>, Alexey Sidorov <alexsid@altlinux\&.org>
Peter Bieringer <pb@bieringer\&.de>, Alexey Sidorov <alexsid@altlinux\&.org>, Keven L\&. Ates <atescomp@gmail\&.com>
.SH "SEE ALSO"
.SS "The core driver:"
.sp