1GENERICUPS(8)                     NUT Manual                     GENERICUPS(8)
2
3
4

NAME

6       genericups - Driver for contact-closure UPS equipment
7

NOTE

9       This man page only documents the specific features of the genericups
10       driver. For information about the core driver, see nutupsdrv(8).
11

SUPPORTED HARDWARE

13       This driver supports hardware from many different manufacturers as it
14       only uses the very simplest of signaling schemes. Contact closure
15       refers to a kind of interface where basic high/low signals are provided
16       to indicate status. This kind of UPS can only report line power and
17       battery status.
18
19       This means that you will only get the essentials in ups.status: OL, OB,
20       and LB. Anything else requires a smarter UPS.
21

CABLING

23       Cabling is different for every kind of UPS. See the table below for
24       information on what is known to work with a given UPS type.
25

EXTRA ARGUMENTS

27       This driver supports the following settings in the ups.conf(5):
28
29       upstype=type
30           Required. Configures the driver for a specific kind of UPS. See the
31           UPS Types section below for more information on which entries are
32           available.
33
34       mfr=string
35           Optional. The very nature of a generic UPS driver sometimes means
36           that the stock manufacturer data has no relation to the actual
37           hardware that is attached. With the mfr setting, you can change the
38           value that is seen by clients that monitor this UPS.
39
40       model=string
41           Optional. This is like mfr above, but it overrides the model string
42           instead.
43
44       serial=string
45           Optional. This is like mfr above and intended to record the
46           identification string of the UPS. It is titled "serial" because
47           usually this string is referred to as the serial number.
48
49       sdtime=value
50           Optional. The driver will sleep for this many seconds after setting
51           the shutdown signal. This is necessary for some hardware which
52           requires a sustained level to activate the shutdown sequence.
53
54           The default behavior of the driver is to exit immediately. If this
55           doesn’t reliably trigger a shutdown in your UPS hardware, use this
56           setting to give it more time to react.
57
58           Note
59           very large values for sdtime may create warnings from upsdrvctl if
60           it gets tired of waiting for the driver to return.
61

CUSTOM CONFIGURATIONS

63       You may override the values for CP, OL, LB, and SD by defining them in
64       the ups.conf(5) after the upstype setting.
65
66       For example, to set the cable power to DTR and the low battery value to
67       DCD, it would look like this:
68
69           CP = DTR
70
71           LB = DCD
72
73       Recognized values for input lines are CTS, DCD, and RNG. Recognized
74       values for output lines are DTR, RTS, and ST. See below for more about
75       what these signals mean.
76
77       These values may be negated for active low signals. That is, "LB=-DCD"
78       recognizes a low battery condition when DCD is not held high.
79

TYPE INFORMATION

81       The essence of a UPS definition in this driver is how it uses the
82       serial lines that are available. These are the abbreviations you will
83       see below:
84
85       OL
86           On line (no power failure) (opposite of OB - on battery)
87
88       LB
89           Low battery
90
91       SD
92           Shutdown load
93
94       CP
95           Cable power (must be present for cable to have valid reading)
96
97       CTS
98           Clear to Send. Received from the UPS.
99
100       RTS
101           Ready to Send. Sent by the PC.
102
103       DCD
104           Data Carrier Detect. Received from the UPS.
105
106       RNG
107           Ring indicate. Received from the UPS.
108
109       DTR
110           Data Terminal Ready. Sent by the PC.
111
112       ST
113           Send a BREAK on the transmit data line
114
115       A "-" in front of a signal name (like -RNG) means that the indicated
116       condition is signaled with an active low signal. For example, [LB=-RNG]
117       means the battery is low when the ring indicate line goes low, and that
118       the battery is OK when that line is held high.
119

UPS TYPES

121       0 = UPSonic LAN Saver 600
122
123           [CP=DTR+RTS] [OL=-CTS] [LB=DCD] [SD=DTR]
124
125       1 = APC Back-UPS/Back-UPS Pro/Smart-UPS with 940-0095A/C cable
126
127           [CP=DTR] [OL=-RNG] [LB=DCD] [SD=RTS]
128
129       2 = APC Back-UPS/Back-UPS Pro/Smart-UPS with 940-0020B cable
130
131           [CP=RTS] [OL=-CTS] [LB=DCD] [SD=DTR+RTS]
132
133           Type 2 has also been reported to work with the 940-0020C cable.
134
135       3 = PowerTech Comp1000 with DTR cable power
136
137           [CP=DTR] [OL=CTS] [LB=DCD] [SD=DTR+RTS]
138
139       4 = Generic RUPS Model
140
141           [CP=RTS] [OL=CTS] [LB=-DCD] [SD=-RTS]
142
143       5 = Tripp Lite UPS with Lan2.2 interface (black 73-0844 cable)
144
145           [CP=DTR] [OL=CTS] [LB=-DCD] [SD=DTR+RTS]
146
147       6 = Best Patriot with INT51 cable
148
149           [CP=DTR] [OL=CTS] [LB=-DCD] [SD=RTS]
150
151       7 = CyberPower Power99 Also Upsonic Power Guardian PG-500, Belkin
152       Belkin Home Office, F6H350-SER, F6H500-SER, F6H650-SER, Eaton
153       Management Card Contact - Config3 with cable 66033 (shutdown does not
154       work)
155
156           [CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
157
158       8 = Nitram Elite 500
159
160           [CP=DTR] [OL=CTS] [LB=-DCD] [SD=???]
161
162       9 = APC Back-UPS/Back-UPS Pro/Smart-UPS with 940-0023A cable
163
164           [CP=none] [OL=-DCD] [LB=CTS] [SD=RTS]
165
166       10 = Victron Lite with crack cable
167
168           [CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
169
170       11 = Powerware 3115
171
172           [CP=DTR] [OL=-CTS] [LB=-DCD] [SD=ST]
173
174       12 = APC Back-UPS Office with 940-0119A cable
175
176           [CP=RTS] [OL=-CTS] [LB=DCD] [SD=DTR]
177
178       13 = RPT Repoteck RPT-800A/RPT-162A
179
180           [CP=DTR+RTS] [OL=DCD] [LB=-CTS] [SD=ST]
181
182       14 = Online P-series
183
184           [CP=DTR] [OL=DCD] [LB=-CTS] [SD=RTS]
185
186       15 = Powerware 5119, 5125
187
188           [CP=DTR] [OL=CTS] [LB=-DCD] [SD=ST]
189
190       16 = Nitram Elite 2002
191
192           [CP=DTR+RTS] [OL=CTS] [LB=-DCD] [SD=???]
193
194       17 = PowerKinetics 9001
195
196           [CP=DTR] [OL=CTS] [LB=-DCD] [SD=???]
197
198       18 = TrippLite Omni 450LAN with Martin’s cabling
199
200           [CP=DTR] [OL=CTS] [LB=DCD] [SD=none]
201
202       19 = Fideltronic Ares Series
203
204           [CP=DTR] [OL=CTS] [LB=-DCD] [SD=RTS]
205
206       20 = Powerware 5119 RM
207
208           [CP=DTR] [OL=-CTS] [LB=DCD] [SD=ST]
209
210           Check docs/cables/powerware.txt
211
212       21 = Generic RUPS 2000 (Megatec M2501 cable)
213
214           [CP=RTS] [OL=CTS] [LB=-DCD] [SD=RTS+DTR]
215
216       22 = Gamatronic All models with alarm interface (also CyberPower SL
217       series)
218
219           [CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
220

SIMILAR MODELS

222       Many different UPS companies make models with similar interfaces. The
223       RUPS cable seems to be especially popular in the "power strip" variety
224       of UPS found in office supply stores. If your UPS works with an entry
225       in the table above, but the model or manufacturer information don’t
226       match, don’t despair. You can fix that easily by using the mfr and
227       model variables documented above in your ups.conf(5).
228

TESTING COMPATIBILITY

230       If your UPS isn’t listed above, you can try going through the list
231       until you find one that works. There is a lot of cable and interface
232       reuse in the UPS world, and you may find a match.
233
234       To do this, first make sure nothing important is plugged into the
235       outlets on the UPS, as you may inadvertently switch it off. Definitely
236       make sure that the computer you’re using is not plugged into that UPS.
237       Plug in something small like a lamp so you know when power is being
238       supplied to the outlets.
239
240       Now, you can either attempt to make an educated guess based on the
241       documentation your manufacturer has provided (if any), or just start
242       going down the list.
243
244   Step 1
245       Pick a driver to try from the list (genericups -h) and go to step 2.
246
247   Step 2
248       Start the driver with the type you want to try -
249
250           genericups -x upstype=n /dev/port
251
252       Let upsd sync up (watch the syslog), and then run upsc to see what it
253       found. If the STATUS is right (should be OL for on line), continue to
254       Step 3, otherwise go back to step 1.
255
256       Alternatively, you can run genericups in debug mode -
257
258           genericups -DDDDD -x upstype=n /dev/port
259
260       In this mode it will be running in the foreground and continuously
261       display the line and battery status of the UPS.
262
263   Step 3
264       Disconnect the UPS from the wall/mains power. This is easiest if you
265       have a switched outlet in between it and the wall, but you can also
266       just pull the plug to test. The lamp should stay lit, and the status
267       should switch to "OB". If the lamp went out or the status didn’t go to
268       "OB" within about 15 seconds, go to Step 1. Otherwise, continue to Step
269       4.
270
271   Step 4
272       At this point, we know that OL and OB work. If nothing else beyond this
273       point works, you at least know what your OL/OB value should be.
274
275       Wait for the UPS to start complaining about a low battery. Depending on
276       the size of your UPS battery and the lamp’s bulb, this could take
277       awhile. It should start complaining audibly at some point. When this
278       happens, STATUS should show "OB LB" within 15 seconds. If not, go to
279       Step 1, otherwise continue to Step 5.
280
281   Step 5
282       So far: OL works, OB works, and LB works.
283
284       With the UPS running on battery, run the genericups driver with the -k
285       switch to shut it down.
286
287           genericups -x upstype=n -k /dev/port
288
289       If the UPS turns off the lamp, you’re done. At this point, you have
290       verified that the shutdown sequence actually does what you want. You
291       can start using the genericups driver with this type number for normal
292       operations.
293
294       You should use your findings to add a section to your ups.conf. Here is
295       a quick example:
296
297           [myups]
298                   driver = genericups
299                   port = /dev/ttyS0
300                   upstype = 1
301
302       Change the port and upstype values to match your system.
303

NEW SUPPORT

305       If the above testing sequence fails, you will probably need to create a
306       new entry to support your hardware. All UPS types are determined from
307       the table in the genericups.h file in the source tree.
308
309       On a standard 9 pin serial port, there are 6 lines that are used as the
310       standard "high/low" signal levels. 4 of them are incoming (to the PC,
311       from the UPS), and the other 2 are outgoing (to the UPS, from the PC).
312       The other 3 are the receive/transmit lines and the ground.
313
314       Be aware that many manufacturers remap pins within the cable. If you
315       have any doubts, a quick check with a multimeter should confirm whether
316       the cable is straight-through or not. Another thing to keep in mind is
317       that some cables have electronics in them to do special things. Some
318       have resistors and transistors on board to change behavior depending on
319       what’s being supplied by the PC.
320

SPECIFIC MODEL NOTES

322       These have been contributed by users of this driver.
323
324       The Centralion CL series may power down the load if the driver starts
325       up with the UPS running on battery as the default line settings contain
326       the shutdown sequence. - Neil Muller
327
328       The Tripp-Lite Internet Office 700 must be used with the black 73-0844
329       cable instead of the gray 73-0743 cable. This entry should work with
330       any of their models with the Lan 2.2 interface - see the sticker by the
331       DB9 connector on the UPS. - Stephen Brown
332
333       Type 5 should work with the Tripp-Lite Lan 2.1 interface and the
334       73-0724 cable. This was tested with the OmniSmart 675 PNP on Red Hat
335       7.2. - Q Giese
336
337       Types 7 and 10 should both work with the PhoenixTec A1000.
338

BUGS

340       There is no way to reliably detect a contact-closure UPS. This means
341       the driver will start up happily even if no UPS is detected. It also
342       means that if the connection between the UPS and computer is
343       interrupted, you may not be able to sense this in software.
344
345       Most contact-closure UPSes will not power down the load if the line
346       power is present. This can create a race when using slave upsmon(8)
347       systems. See the upsmon(8) man page for more information.
348
349       The solution to both of these problems is to upgrade to a smart
350       protocol UPS of some kind that allows detection and proper load cycling
351       on command.
352

SEE ALSO

354   The core driver
355       nutupsdrv(8)
356
357   Internet resources
358       The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
359
360
361
362Network UPS Tools 2.7.3.          12/29/2015                     GENERICUPS(8)
Impressum