← Back to branch summary

~ubuntu-branches/ubuntu/saucy/nut/saucy

« back to all changes in this revision

Viewing changes to man/powercom.8

  • Committer: Bazaar Package Importer
  • Author(s): Reinhard Tartler
  • Date: 2005-07-20 19:48:50 UTC
  • mto: (16.1.1 squeeze)
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20050720194850-oo61wjr33rrx2mre
Tags: upstream-2.0.2
Import upstream version 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/powercom.8
3
3
powercom \- UPS driver for Powercom/Trust/Advice UPS equipment
4
4
 
5
5
.SH NOTE
6
 
This man page only documents the hardware-specific features of the
 
6
This man page only documents the hardware\(hyspecific features of the
7
7
powercom driver.  For information about the core driver, see
8
8
\fBnutupsdrv\fR(8).
9
9
 
17
17
\fBups.conf\fR(5):
18
18
 
19
19
.IP "linevoltage=\fIvalue\fR"
20
 
An integer specifying the mains voltage. It can't be autodetected. 
21
 
Acceptable values are in the range of 110-120 or 220-240. The default
22
 
 is \fI230\fR.
 
20
An integer specifying the mains voltage. It can't be auto detected. 
 
21
Acceptable values are in the range of 110\(hy120 or 220\(hy240. The default
 
22
is \fI230\fR.
23
23
 
24
 
.IP "manufacturer=\fIvalue\fR"
25
 
Specify the manufacturer name, which also can't be autodetected. This is 
 
24
.IP "manufacturer=\fIname\fR"
 
25
Specify the manufacturer name, which also can't be auto detected. This is 
26
26
a user defined string so any name is acceptable. The default is 
27
27
\fIPowerCom\fR.
28
28
 
29
 
.IP "modelname=\fIvalue\fR"
30
 
Specify the model name, which also can't be autodetected. This is a 
31
 
user defined string so any name is acceptable. The default is \fIUnknown\fR.
 
29
.IP "modelname=\fIname\fR"
 
30
Specify the model name, which also can't be auto detected. This is a 
 
31
user defined string so any name is acceptable. The default is 
 
32
\fIUnknown\fR.
32
33
 
33
34
.IP "serialnumber=\fIvalue\fR"
34
 
Like modelname above, but for the serial number. The default is \fIUnknown\fR.
35
 
 
36
 
.IP "type=\fIvalue\fR"
37
 
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 KP625AP, Trust, KIN2200AP or Egys.  The default is \fITrust\fR.
 
35
Like modelname above, but for the serial number. The default is 
 
36
\fIUnknown\fR.
 
37
 
 
38
.IP "type=\fIname\fR"
 
39
The exact type of the communication protocol within the powercom family, 
 
40
that will be used to communicate with the UPS. The type is named after 
 
41
the first modelname that was coded with that protocol. The acceptable 
 
42
names are KP625AP, Trust, KIN2200AP, Egys, KIN525AP or KIN1500AP. The 
 
43
default is \fITrust\fR.
 
44
 
 
45
.IP "numOfBytesFromUPS=\fIvalue\fR"
 
46
The number of bytes in a UPS frame. The default is type dependant and 
 
47
is given below.
 
48
 
 
49
.IP "voltage=\fI{coefficient1,coefficient2,coefficient3,coefficient4}\fR"
 
50
A quad that is used convert the raw data to human readable voltage 
 
51
reading. The default is type dependant and is given below. Do note that 
 
52
the braces and commas are mandatory, as well as the lack of white space
 
53
characters.
 
54
 
 
55
.IP "methodOfFlowControl=\fIname\fR"
 
56
The method of serial communication flow control that is engaged by the 
 
57
UPS. The default is type dependant and is given below. Acceptable names 
 
58
are dtr0rts1, dtr1 or no_flow_control.
 
59
 
 
60
.IP "frequency=\fI{coefficient1,coefficient2}\fR"
 
61
A pair to convert the raw data to human readable frequency reading. The 
 
62
default is type dependant and is given below. Do note that the braces 
 
63
and commas are mandatory as well, as the lack of white space characters.
 
64
 
 
65
.IP "batteryPercentage=\fI{coefficient1,coefficient2,coefficient3,coefficient4,coefficient5}\fR"
 
66
A 5 tuple to convert the raw data to human readable battery percentage 
 
67
reading. The default is type dependant and is given below. Do note that 
 
68
the braces and commas are mandatory, as the lack of white space 
 
69
characters.
 
70
 
 
71
.IP "loadPercentage=\fI{coefficient1,coefficient2,coefficient3,coefficient4}\fR"
 
72
A quad to convert the raw data to human readable load percentage 
 
73
reading. The default is type dependant and is given below. Do note that 
 
74
the braces and commas are mandatory, as the lack of white space 
 
75
characters.
 
76
 
 
77
.IP "validationSequence=\fI{{index1,value1},{index2,value2},{index3,value3}}\fR"
 
78
3 pairs to be used for validating the UPS by comparing bytes of the raw 
 
79
data with constant values. The default is type dependant and is given 
 
80
below. The braces and commas are mandatory, as the lack of white space
 
81
characters.
 
82
 
 
83
.IP "shutdownArguments=\fI{{minutes,seconds},whether_minutes_should_be_used}\fR"
 
84
The minutes and seconds that the UPS should wait between receiving the 
 
85
shutdown command and actually shutting off. The other argument should 
 
86
be set to the character \fIn\fR only when the minutes value should be 
 
87
skipped and not sent to the UPS. The default is type dependant and is 
 
88
given below. The braces and commas are mandatory. Note that there should 
 
89
be no white space characters.
 
90
 
 
91
.SH DEFAULT VALUES FOR THE EXTRA ARGUMENTS
 
92
.IP "linevoltage = \fI230\fR"
 
93
.IP "manufacturer = \fIPowerCom\fR"
 
94
.IP "modelname = \fIUnknown\fR"
 
95
.IP "serialnumber = \fIUnknown\fR"
 
96
.IP "type = \fITrust\fR"
 
97
 
 
98
.P 
 
99
The rest of the default values for the extra arguments are type 
 
100
dependant:
 
101
 
 
102
.IP "Trust"
 
103
.RS
 
104
.IP "numOfBytesFromUPS = 11"
 
105
.IP "methodOfFlowControl = dtr0rts1"
 
106
.IP "validationSequence = {{5,0},{7,0},{8,0}}"
 
107
.IP "shutdownArguments = {{0,10},n}"
 
108
.IP "frequency = {0.00020997,0.00020928}"
 
109
.IP "loadPercentage = {6.1343,\-0.3808,4.3110,0.1811}"
 
110
.IP "batteryPercentage = {5.0000,0.3268,\-825.00,4.5639,\-835.82}"
 
111
.IP "voltage = {1.9216,\-0.0977,0.9545,0.0000}"
 
112
.RE
 
113
 
 
114
.IP "KP625AP"
 
115
.RS
 
116
.IP "numOfBytesFromUPS = 16"
 
117
.IP "methodOfFlowControl = dtr0rts1"
 
118
.IP "validationSequence = {{5,0x80},{7,0},{8,0}}"
 
119
.IP "shutdownArguments = {{0,10},n}"
 
120
.IP "frequency = {0.00020997,0.00020928}"
 
121
.IP "loadPercentage = {6.1343,\-0.3808,4.3110,0.1811}"
 
122
.IP "batteryPercentage = {5.0000,0.3268,\-825.00,4.5639,\-835.82}"
 
123
.IP "voltage = {1.9216,\-0.0977,0.9545,0.0000}"
 
124
.RE
 
125
 
 
126
.IP "KIN2200AP"
 
127
.RS
 
128
.IP "numOfBytesFromUPS = 16"
 
129
.IP "methodOfFlowControl = dtr0rts1"
 
130
.IP "validationSequence = {{7,0},{8,0},{8,0}}"
 
131
.IP "shutdownArguments = {{0,10},n}"
 
132
.IP "frequency = {0.00020997,0.0}"
 
133
.IP "loadPercentage = {6.1343,\-0.3808,1.075,0.1811}"
 
134
.IP "batteryPercentage = {5.0000,0.3268,\-825.00,0.46511,0}"
 
135
.IP "voltage = {1.9216,\-0.0977,0.82857,0.0000}"
 
136
.RE
 
137
 
 
138
.IP "Egys"
 
139
.RS
 
140
.IP "numOfBytesFromUPS = 16"
 
141
.IP "methodOfFlowControl = no_flow_control"
 
142
.IP "validationSequence = {{5,0x80},{7,0},{8,0}}"
 
143
.IP "shutdownArguments = {{0,10},n}"
 
144
.IP "frequency = {0.00020997,0.00020928}"
 
145
.IP "loadPercentage = {6.1343,\-0.3808,1.3333,0.6667}"
 
146
.IP "batteryPercentage = {5.0000,0.3268,\-825.00,2.2105,\-355.37}"
 
147
.IP "voltage = {1.9216,\-0.0977,0.9545,0.0000}"
 
148
.RE
 
149
 
 
150
.IP "KIN525AP"
 
151
.RS
 
152
.IP "numOfBytesFromUPS = 16"
 
153
.IP "methodOfFlowControl = dtr1"
 
154
.IP "validationSequence = {{5,0x80},{7,0},{8,0}}"
 
155
.IP "shutdownArguments = {{0,10},y}"
 
156
.IP "frequency = {0.00020997,0.00020928}"
 
157
.IP "loadPercentage = {6.1343,\-0.3808,4.3110,0.1811}"
 
158
.IP "batteryPercentage = {5.0000,0.3268,\-825.00,4.5639,\-835.82}"
 
159
.IP "voltage = {1.9216,\-0.0977,0.9545,0.0000}"
 
160
.RE
 
161
 
 
162
.IP "KIN1500AP"
 
163
.RS
 
164
.IP "numOfBytesFromUPS = 16"
 
165
.IP "methodOfFlowControl = no_flow_control"
 
166
.IP "validationSequence = {{7,0},{8,0},{8,0}}"
 
167
.IP "shutdownArguments = {{0,10},n}"
 
168
.IP "frequency = {0.00020997,0.0}"
 
169
.IP "loadPercentage = {6.1343,\-0.3808,1.075,0.1811}"
 
170
.IP "batteryPercentage = {5.0000,0.3268,\-825.00,0.46511,0}"
 
171
.IP "voltage = {1.9216,\-0.0977,0.82857,0.0000}"
 
172
.RE
38
173
 
39
174
.SH AUTHOR
40
175
Peter Bieringer <pb@bieringer.de>