version 2, including all changes.
.
Rev |
Author |
# |
Line |
1 |
perry |
1 |
POWERCOM |
|
|
2 |
!!!POWERCOM |
|
|
3 |
NAME |
|
|
4 |
SYNOPSIS |
|
|
5 |
DESCRIPTION |
|
|
6 |
OPTIONS |
|
|
7 |
DIAGNOSTICS |
|
|
8 |
FILES |
|
|
9 |
BUGS |
|
|
10 |
AUTHOR |
|
|
11 |
SEE ALSO |
|
|
12 |
---- |
|
|
13 |
!!NAME |
|
|
14 |
|
|
|
15 |
|
|
|
16 |
powercom - UPS model driver for powercom kind of interface |
|
|
17 |
!!SYNOPSIS |
|
|
18 |
|
|
|
19 |
|
|
|
20 |
__powercom [[-h] |
|
|
21 |
powercom [[-d__ '''' __] -k__ |
|
|
22 |
''''__ |
|
|
23 |
powercom [[-i__ '''' __] [[-l__ |
|
|
24 |
'''' __] [[-m__ '''' __] |
|
|
25 |
[[-s__ '''' __]__ |
|
|
26 |
'''' |
|
|
27 |
!!DESCRIPTION |
|
|
28 |
|
|
|
29 |
|
2 |
perry |
30 |
__powercom__ is a driver for the !PowerCom UPS. It serves |
1 |
perry |
31 |
as a communication channel between the UPS attached on |
|
|
32 |
'''' and the upsd daemon. The driver's task |
|
|
33 |
is to pass upsd process information about UPS state and |
|
|
34 |
parameters. The driver can also send the UPS instant |
|
|
35 |
commands. Alternatively it can instruct the UPS to shutoff |
|
|
36 |
the load in a timely fashion when instructed to on the |
|
|
37 |
command line.__ |
|
|
38 |
powercom__ has two modes of operation which are determined |
|
|
39 |
by the command line switches. In the first mode, which is |
|
|
40 |
what will be activated almost all the time, __powercom__ |
|
|
41 |
will periodically inquire the UPS for its state and |
|
|
42 |
parameters and have the results of this inquiries avaiable |
|
|
43 |
to upsd and there after for the various clients. In this |
|
|
44 |
mode of operation it will also have instant commands sent by |
|
|
45 |
upsd transferred to the UPS. This mode is operational |
|
|
46 |
whenever the __-k__ switch has not been given on the |
|
|
47 |
command line. |
|
|
48 |
In its second mode of operation, __powercom__ will |
|
|
49 |
instructs the UPS to cut of the power, possibly after some |
|
|
50 |
delay. This mode of operation is intended for cases when it |
|
|
51 |
is known that the UPS is on battery and the mains |
|
|
52 |
electricity supply will not be back in a short while and |
|
|
53 |
therefore the machine has to be turned off. |
|
|
54 |
!!OPTIONS |
|
|
55 |
|
|
|
56 |
|
|
|
57 |
-h |
|
|
58 |
|
|
|
59 |
|
|
|
60 |
display an help message without doing anything else. This |
|
|
61 |
option is the only one for which the '''' |
|
|
62 |
parameter is ignored and can be omitted. This option |
|
|
63 |
overides any other option. |
|
|
64 |
|
|
|
65 |
|
|
|
66 |
-d |
|
|
67 |
|
|
|
68 |
|
|
|
69 |
this optional flag might be used only when the UPS is |
|
|
70 |
instructed to cut off the power. It is meant to have |
|
|
71 |
__powercom__ wait additional '''' seconds |
|
|
72 |
before announcing that driver failed command the UPS to turn |
|
|
73 |
off the power to the load. |
|
|
74 |
|
|
|
75 |
|
|
|
76 |
-k |
|
|
77 |
|
|
|
78 |
|
|
|
79 |
instructs __powercom__ to order the UPS which is attached |
|
|
80 |
to '''' to cut off the power. |
|
|
81 |
|
|
|
82 |
|
|
|
83 |
-i |
|
|
84 |
|
|
|
85 |
|
|
|
86 |
gives the UPS that is attached to '''' the |
|
|
87 |
identification of the string '''' The default |
|
|
88 |
value for it is '' |
|
|
89 |
|
|
|
90 |
|
|
|
91 |
-l |
|
|
92 |
|
|
|
93 |
|
|
|
94 |
indicates which is the mains electricity voltage that is fed |
|
|
95 |
to the UPS which it is connected to. '''' |
|
|
96 |
Consequently, this voltage should be regarded as on line. |
|
|
97 |
The default value is 230 volts. |
|
|
98 |
|
|
|
99 |
|
|
|
100 |
-m |
|
|
101 |
|
|
|
102 |
|
|
|
103 |
A string that represents the model of the UPS that is |
|
|
104 |
attached to '''' The default name is |
|
|
105 |
'' |
|
|
106 |
|
|
|
107 |
|
|
|
108 |
-s |
|
|
109 |
|
|
|
110 |
|
|
|
111 |
A string that represents the serial number of the UPS that |
|
|
112 |
is attached to '''' The default string is |
|
|
113 |
'' |
|
|
114 |
!!DIAGNOSTICS |
|
|
115 |
|
|
|
116 |
|
|
|
117 |
In addition to recording activities such as first |
|
|
118 |
activation, instant commands and cutting the power in the |
|
|
119 |
system logs and the console there are clients for inspecting |
|
|
120 |
the state and parameters values of the UPS as well as |
|
|
121 |
clients for sending the UPS instant commands. |
|
|
122 |
!!FILES |
|
|
123 |
|
|
|
124 |
|
|
|
125 |
In normal operation __powercom__ will be called only from |
|
|
126 |
the system init scripts. These might be |
|
|
127 |
''/etc/init.d/nut'' and ''/etc/init.d/halt.'' In this |
|
|
128 |
way of using it the configuration files ''upsd.conf'' and |
|
|
129 |
''upsmon.conf'' controls its operation. These files might |
|
|
130 |
be in ''/etc/nut.'' Please note that all paths are system |
|
|
131 |
dependant. |
|
|
132 |
!!BUGS |
|
|
133 |
|
|
|
134 |
|
|
|
135 |
Some of the conversions of binary data that is reported by |
|
|
136 |
the UPS into numerical values, notably the battery |
|
|
137 |
precentage, are wrong. Yet the UPS also reports when its |
|
|
138 |
battery is low, which is why the bad conversion of the |
|
|
139 |
battery precentage does not harm the functionality of the |
|
|
140 |
model driver. |
|
|
141 |
The -d switch is ignored when not being given with |
|
|
142 |
conjunction with the -k switch. |
|
|
143 |
There is no verification or otherwise cross matching between |
|
|
144 |
the -i name and the corresponding name in the configuration |
|
|
145 |
files. |
|
|
146 |
!!AUTHOR |
|
|
147 |
|
|
|
148 |
|
|
|
149 |
The author of this model driver is Shaul Karl, |
|
|
150 |
!!SEE ALSO |
|
|
151 |
|
|
|
152 |
|
|
|
153 |
__The main controlling process is__ |
|
|
154 |
|
|
|
155 |
|
|
|
156 |
upsd(8) |
|
|
157 |
|
|
|
158 |
|
|
|
159 |
__The available clients are:__ |
|
|
160 |
|
|
|
161 |
|
|
|
162 |
multimon, upsc, upscmd, upsct, upsct2, upsimage.cgi, upslog, |
|
|
163 |
upsmon, upsset, upsstats.cgi |
|
|
164 |
|
|
|
165 |
|
|
|
166 |
__Other models drivers are:__ |
|
|
167 |
|
|
|
168 |
|
|
|
169 |
apcsmart(8), belkin(8), bestfort(8), bestups(8), |
|
|
170 |
engetron(8), fentonups(8), genericups(8), ipt-anzen(8), |
|
|
171 |
mustekups(8), optiups(8), victronups(8) |
|
|
172 |
|
|
|
173 |
|
|
|
174 |
__Internet resources:__ |
|
|
175 |
|
|
|
176 |
|
|
|
177 |
The NUT (Network UPS Tools) home page is at |
|
|
178 |
http://www.exploits.org/nut. |
|
|
179 |
|
|
|
180 |
|
|
|
181 |
NUT mailing list archives and information: |
|
|
182 |
http://lists.exploits.org/ |
|
|
183 |
---- |