1
.TH GENERICUPS 8 "Sun Nov 2 2003" "" "Network UPS Tools (NUT)"
3
genericups \- Driver for contact-closure UPS equipment
6
This man page only documents the specific features of the genericups
7
driver. For information about the core driver, see \fBnutupsdrv\fR(8).
10
This driver supports hardware from many different manufacturers as it only
11
uses the very simplest of signaling schemes. Contact closure refers to a
12
kind of interface where basic high/low signals are provided to indicate
13
status. This kind of UPS can only report line power and battery status.
15
This means that you will only get the essentials in ups.status: OL, OB,
16
and LB. Anything else requires a smarter UPS.
19
Cabling is different for every kind of UPS. See the table below for
20
information on what is known to work with a given UPS type.
23
This driver supports the following settings in the \fBups.conf\fR(5):
25
.IP "upstype=\fItype\fR"
27
Required. Configures the driver for a specific kind of UPS. See the UPS
28
Types section below for more information on which entries are available.
30
.IP "mfr=\fIstring\fR"
32
Optional. The very nature of a generic UPS driver sometimes means that
33
the stock manufacturer data has no relation to the actual hardware that is
34
attached. With the mfr setting, you can change the value that is seen by
35
clients that monitor this UPS.
37
.IP "model=\fIstring\fR"
39
Optional. This is like mfr above, but it overrides the model string
42
.IP "serial=\fIstring\fR"
44
Optional. This is like mfr above and intended to record the identification
45
string of the UPS. It is titled serial because usually this string is
46
referred to as the serial number.
48
.SH CUSTOM CONFIGURATIONS
50
You may override the values for CP, OL, LB, and SD by defining them in
51
the \fBups.conf\fR after the upstype setting.
53
For example, to set the cable power to DTR and the low battery value to
54
DCD, it would look like this:
60
Recognized values for input lines are CTS, DCD, and RNG. Recognized
61
values for output lines are DTR, RTS, and ST. See below for more about
62
what these signals mean.
64
These values may be negated for active low signals. That is, "LB=-DCD"
65
recognizes a low battery condition when DCD is not held high.
68
The essence of a UPS definition in this driver is how it uses the serial
69
lines that are available. These are the abbreviations you will see below:
71
OL - On line (no power failure) (opposite of OB - on battery)
77
CP - Cable power (must be present for cable to have valid reading)
79
CTS - Clear to Send. Received from the UPS.
81
RTS - Ready to Send. Sent by the PC.
83
DCD - Data Carrier Detect. Received from the UPS.
85
RNG - Ring indicate. Received from the UPS.
87
DTR - Data Terminal Ready. Sent by the PC.
89
ST - Send a BREAK on the transmit data line
91
A - in front of a signal name (like -RNG) means that the indicated
92
condition is signaled with an active low signal. For example, [LB=-RNG]
93
means the battery is low when the ring indicate line goes low, and that
94
the battery is OK when that line is held high.
98
0 = UPSonic LAN Saver 600
99
[CP=DTR+RTS] [OL=-CTS] [LB=DCD] [SD=DTR]
101
1 = APC Back-UPS/Back-UPS Pro/Smart-UPS with 940-0095A/C cable
102
[CP=DTR] [OL=-RNG] [LB=DCD] [SD=RTS]
104
2 = APC Back-UPS/Back-UPS Pro/Smart-UPS with 940-0020B cable
105
[CP=RTS] [OL=-CTS] [LB=DCD] [SD=DTR+RTS]
107
Type 2 has also been reported to work with the 940-0020C cable.
109
3 = PowerTech Comp1000 with DTR cable power
110
[CP=DTR] [OL=CTS] [LB=DCD] [SD=DTR+RTS]
112
4 = Generic RUPS Model
113
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=-RTS]
115
5 = Tripp Lite UPS with Lan2.2 interface (black 73-0844 cable)
116
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=DTR+RTS]
118
6 = Best Patriot with INT51 cable
119
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=RTS]
121
7 = CyberPower Power99
122
also Upsonic Power Guardian PG-500
124
Also Belkin Belkin Home Office
125
F6H350-SER, F6H500-SER, F6H650-SER
127
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
130
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=???]
132
9 = APC Back-UPS/Back-UPS Pro/Smart-UPS with 940-0023A cable
133
[CP=none] [OL=-DCD] [LB=CTS] [SD=RTS]
135
10 = Victron Lite with crack cable
136
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
139
[CP=DTR] [OL=-CTS] [LB=-DCD] [SD=ST]
141
12 = APC Back-UPS Office with 940-0119A cable
142
[CP=RTS] [OL=-CTS] [LB=DCD] [SD=DTR]
144
13 = RPT Repoteck RPT-800A/RPT-162A
145
[CP=DTR+RTS] [OL=DCD] [LB=-CTS] [SD=ST]
148
[CP=DTR] [OL=DCD] [LB=-CTS] [SD=RTS]
151
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=ST]
153
16 = Nitram Elite 2002
154
[CP=DTR+RTS] [OL=CTS] [LB=-DCD] [SD=???]
156
17 = PowerKinetics 9001
157
[CP=DTR] [OL=CTS] [LB=DCD] [SD=???]
159
18 = TrippLite Omni 450LAN with Martin's cabling
160
[CP=DTR] [OL=CTS] [LB=DCD] [SD=none]
162
http://lists.exploits.org/upsdev/Jul2002/00012.html
164
19 = Fideltronic Ares Series
165
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=RTS]
167
20 = Powerware 5119 RM
168
[CP=DTR] [OL=-CTS] [LB=DCD] [SD=ST]
170
http://lists.exploits.org/ups/Oct2003/00052.html
174
Many different UPS companies make models with similar interfaces. The
175
RUPS cable seems to be especially popular in the "power strip" variety of
176
UPS found in office supply stores. If your UPS works with an entry in the
177
table above, but the model or manufacturer information don't match,
178
don't despair. You can fix that easily by using the mfr and model
179
variables documented above in your \fBups.conf\fR(5).
181
.SH TESTING COMPATIBILITY
183
If your UPS isn't listed above, you can try going through the list until
184
you find one that works. There is a lot of cable and interface reuse in
185
the UPS world, and you may find a match.
187
To do this, first make sure nothing important is plugged into the
188
outlets on the UPS, as you may inadvertently switch it off. Definitely
189
make sure that the computer you're using is not plugged into that UPS.
190
Plug in something small like a lamp so you know when power is being
191
supplied to the outlets.
193
Now, you can either attempt to make an educated guess based on the
194
documentation your manufacturer has provided (if any), or just start
199
Pick a driver to try from the list (genericups -h) and go to step 2.
203
Start the driver with the type you want to try -
205
genericups -x upstype=n /dev/port
207
Let upsd sync up (watch the syslog), and then run upsc to see what it
208
found. If the STATUS is right (should be OL for on line), go to step 3,
209
otherwise go back to step 1.
213
Disconnect the UPS from the wall/mains power. This is easiest if you
214
have a switched outlet in between it and the wall, but you can also just
215
pull the plug to test. The lamp should stay lit, and the status should
216
switch to "OB". If the lamp went out or the status didn't go to "OB"
217
within about 15 seconds, go to step 1. Otherwise, continue to step 4.
221
At this point, we know that OL and OB work. If nothing else beyond
222
this point works, you at least know what your OL/OB value should be.
224
Wait for the UPS to start complaining about a low battery. Depending on
225
the size of your UPS battery and the lamp's bulb, this could take
226
awhile. It should start complaining audibly at some point. When this
227
happens, STATUS should show "OB LB" within 15 seconds. If not, go to
228
step 1, otherwise continue to step 5.
232
So far: OL works, OB works, and LB works.
234
With the UPS running on battery, run the genericups driver with the -k
235
switch to shut it down.
237
genericups -x upstype=n -k /dev/port
239
If the UPS turns off the lamp, you're done. At this point, you have
240
verified that the shutdown sequence actually does what you want. You
241
can start using the genericups driver with this type number for normal
244
You should use your findings to add a section to your ups.conf.
245
Here is a quick example:
252
Change the port and upstype values to match your system.
256
If the above testing sequence fails, you will probably need to create a
257
new entry to support your hardware. All UPS types are determined from the
258
table in the genericups.h file in the source tree.
260
On a standard 9 pin serial port, there are 6 lines that are used as the
261
standard "high/low" signal levels. 4 of them are incoming (to the PC,
262
from the UPS), and the other 2 are outgoing (to the UPS, from the PC).
263
The other 3 are the receive/transmit lines and the ground.
265
Be aware that many manufacturers remap pins within the cable. If you have
266
any doubts, a quick check with a multimeter should confirm whether the
267
cable is straight-through or not. Another thing to keep in mind is that
268
some cables have electronics in them to do special things. Some have
269
resistors and transistors on board to change behavior depending on what's
270
being supplied by the PC.
272
.SH SPECIFIC MODEL NOTES
274
These have been contributed by users of this driver.
276
The Centralion CL series may power down the load if the driver starts up
277
with the UPS running on battery as the default line settings contain the
278
shutdown sequence. - Neil Muller
280
The Tripp-Lite Internet Office 700 must be used with the black 73-0844
281
cable instead of the gray 73-0743 cable. This entry should work with any
282
of their models with the Lan 2.2 interface - see the sticker by the DB9
283
connector on the UPS. - Stephen Brown
285
Type 5 should work with the Tripp-Lite Lan 2.1 interface and the 73-0724
286
cable. This was tested with the OmniSmart 675 PNP on Red Hat 7.2. - Q
289
Types 7 and 10 should both work with the PhoenixTec A1000.
293
There is no way to reliably detect a contact-closure UPS. This means the
294
driver will start up happily even if no UPS is detected. It also means
295
that if the connection between the UPS and computer is interrupted, you
296
may not be able to sense this in software.
298
Most contact-closure UPSes will not power down the load if the line power
299
is present. This can create a race when using slave \fBupsmon\fR(8)
300
systems. See the \fBupsmon\fR(8) man page for more information.
302
The solution to both of these problems is to upgrade to a smart protocol
303
UPS of some kind that allows detection and proper load cycling on command.
310
.SS Internet resources:
311
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
added
removed
man/genericups.8
