GENERICUPS(8) | NUT Manual | GENERICUPS(8) |
NAME¶
genericups - Driver for contact-closure UPS equipmentNOTE¶
This man page only documents the specific features of the genericups driver. For information about the core driver, see nutupsdrv(8).SUPPORTED HARDWARE¶
This driver supports hardware from many different manufacturers as it only uses the very simplest of signaling schemes. Contact closure refers to a kind of interface where basic high/low signals are provided to indicate status. This kind of UPS can only report line power and battery status.CABLING¶
Cabling is different for every kind of UPS. See the table below for information on what is known to work with a given UPS type.EXTRA ARGUMENTS¶
This driver supports the following settings in the ups.conf(5): upstype= typeRequired. Configures the driver for a specific
kind of UPS. See the UPS Types section below for more information on which
entries are available.
mfr= string
Optional. The very nature of a generic UPS
driver sometimes means that the stock manufacturer data has no relation to the
actual hardware that is attached. With the mfr setting, you can change the
value that is seen by clients that monitor this UPS.
model= string
Optional. This is like mfr above, but it
overrides the model string instead.
serial= string
Optional. This is like mfr above and intended
to record the identification string of the UPS. It is titled
"serial" because usually this string is referred to as the serial
number.
sdtime= value
Optional. The driver will sleep for this many
seconds after setting the shutdown signal. This is necessary for some hardware
which requires a sustained level to activate the shutdown sequence.
The default behavior of the driver is to exit immediately. If this doesn’t
reliably trigger a shutdown in your UPS hardware, use this setting to give it
more time to react.
CUSTOM CONFIGURATIONS¶
You may override the values for CP, OL, LB, and SD by defining them in the ups.conf(5) after the upstype setting.CP = DTR
LB = DCD
TYPE INFORMATION¶
The essence of a UPS definition in this driver is how it uses the serial lines that are available. These are the abbreviations you will see below: OLOn line (no power failure) (opposite of OB -
on battery)
LB
Low battery
SD
Shutdown load
CP
Cable power (must be present for cable to have
valid reading)
CTS
Clear to Send. Received from the UPS.
RTS
Ready to Send. Sent by the PC.
DCD
Data Carrier Detect. Received from the
UPS.
RNG
Ring indicate. Received from the UPS.
DTR
Data Terminal Ready. Sent by the PC.
ST
Send a BREAK on the transmit data line
UPS TYPES¶
0 = UPSonic LAN Saver 600[CP=DTR+RTS] [OL=-CTS] [LB=DCD] [SD=DTR]
[CP=DTR] [OL=-RNG] [LB=DCD] [SD=RTS]
[CP=RTS] [OL=-CTS] [LB=DCD] [SD=DTR+RTS]
Type 2 has also been reported to work with the 940-0020C cable.
[CP=DTR] [OL=CTS] [LB=DCD] [SD=DTR+RTS]
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=-RTS]
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=DTR+RTS]
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=RTS]
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=???]
[CP=none] [OL=-DCD] [LB=CTS] [SD=RTS]
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
[CP=DTR] [OL=-CTS] [LB=-DCD] [SD=ST]
[CP=RTS] [OL=-CTS] [LB=DCD] [SD=DTR]
[CP=DTR+RTS] [OL=DCD] [LB=-CTS] [SD=ST]
[CP=DTR] [OL=DCD] [LB=-CTS] [SD=RTS]
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=ST]
[CP=DTR+RTS] [OL=CTS] [LB=-DCD] [SD=???]
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=???]
[CP=DTR] [OL=CTS] [LB=DCD] [SD=none]
[CP=DTR] [OL=CTS] [LB=-DCD] [SD=RTS]
[CP=DTR] [OL=-CTS] [LB=DCD] [SD=ST]
Check docs/cables/powerware.txt
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=RTS+DTR]
[CP=RTS] [OL=CTS] [LB=-DCD] [SD=DTR]
SIMILAR MODELS¶
Many different UPS companies make models with similar interfaces. The RUPS cable seems to be especially popular in the "power strip" variety of UPS found in office supply stores. If your UPS works with an entry in the table above, but the model or manufacturer information don’t match, don’t despair. You can fix that easily by using the mfr and model variables documented above in your ups.conf(5).TESTING COMPATIBILITY¶
If your UPS isn’t listed above, you can try going through the list until you find one that works. There is a lot of cable and interface reuse in the UPS world, and you may find a match.Step 1¶
Pick a driver to try from the list (genericups -h) and go to step 2.Step 2¶
Start the driver with the type you want to try -genericups -x upstype=n /dev/port
genericups -DDDDD -x upstype=n /dev/port
Step 3¶
Disconnect the UPS from the wall/mains power. This is easiest if you have a switched outlet in between it and the wall, but you can also just pull the plug to test. The lamp should stay lit, and the status should switch to "OB". If the lamp went out or the status didn’t go to "OB" within about 15 seconds, go to Step 1. Otherwise, continue to Step 4.Step 4¶
At this point, we know that OL and OB work. If nothing else beyond this point works, you at least know what your OL/OB value should be.Step 5¶
So far: OL works, OB works, and LB works.genericups -x upstype=n -k /dev/port
[myups] driver = genericups port = /dev/ttyS0 upstype = 1
NEW SUPPORT¶
If the above testing sequence fails, you will probably need to create a new entry to support your hardware. All UPS types are determined from the table in the genericups.h file in the source tree.SPECIFIC MODEL NOTES¶
These have been contributed by users of this driver.BUGS¶
There is no way to reliably detect a contact-closure UPS. This means the driver will start up happily even if no UPS is detected. It also means that if the connection between the UPS and computer is interrupted, you may not be able to sense this in software.SEE ALSO¶
The core driver¶
nutupsdrv(8)Internet resources¶
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/05/21/2012 | Network UPS Tools |