NEWHIDUPS(8)

NAME
newhidups - New driver for USB/HID UPS equipment

NOTE
This man page only documents the hardware-specific features of the newhidups driver. For information about the core driver, see nutupsdrv(8).

SUPPORTED HARDWARE
newhidups brings USB/HID UPS monitoring to NUT on all platform supporting USB through libusb.It should detect any UPS that uses the HID power device class, but the amount of data will vary depending on the manufacturer and model. At the present time, newhidups supports:
    all MGE UPS SYSTEMS USB models,
    some APC models,
    some Belkin models,
    some Cyber Power Systems models. For a more complete list, refer to the NUT hardware compatibility list, available in the source distribution as data/drivers.list, or on the NUT website. This driver is known to work on:
    most Linux systems,
    FreeBSD (beta stage) and maybe other *BSD,
    Solaris 10 (not yet validated).

EXTRA ARGUMENTS
If you only have one local USB UPS, newhidups can autodetect it by setting the port value to "auto" either on the command line, or in the ups.conf file. This driver also supports the following optional settings:

offdelay=num
    Set the timer before the UPS is turned off after the kill power command is sent (via the -k switch). The default value is 20 (in seconds), and MUST BE LOWER than ondelay.

ondelay=num
    Set the timer for the UPS to switch on in case the power returns after the kill power command had been sent but before the actual switch off. This ensures the machines connected to the UPS are, in all cases, rebooted after a power failure. The default value is 30 (in seconds), and MUST BE GREATER than offdelay.

vendor=regex

product=regex

serial=regex

vendorid=regex

productid=regex
    Select a specific UPS, in case there is more than one connected via USB. Each option specifies an extended regular expression (see regex(7)) that must match the UPS's entire vendor/product/serial string (minus any surrounding whitespace), or the whole 4-digit hexadecimal code for vendorid and productid. Try -D -D for finding out the strings to match. Examples:
        -x vendor="Foo.Corporation.*"
        -x vendorid=051d (APC)
        -x product=".*(Smart|Back)-?UPS.*"

bus=regex
    Select a UPS on a specific USB bus or group of busses. The argument is a regular expression that must match the bus name where the UPS is connected (e.g. bus="002", bus="00[2-3]").

INSTALLATION
This driver is not built by default. You can build it by using "make usb", and install it using "make install-usb". Note that it will also install other USB drivers. You also need to install manually the hotplug files (libhidups and libhid.usermap), generally in etc/hotplug/usb/, to address the permission settings problem. Lastly note that the libhidups file must have execution flag set (ie using chmod +x ...). On Linux, you will need at least a 2.4.25 or 2.6.2 kernel and libusb 0.1.8 to disable the hiddev support and avoid conflict. This hiddev kernel driver was needed by the legacy NUT hidups driver, which newhidups replaces.

KNOWN ISSUES AND BUGS

  Got EPERM: Operation not permitted upon driver startup
You have forgotten to install the hotplug files, as explained in the INSTALLATION section above. Don't forget to restart hotplug so that it applies these changes.

AUTHORS

  Sponsored by MGE UPS SYSTEMS <http://opensource.mgeups.com/>
Arnaud Quette, Peter Selinger

SEE ALSO

  The core driver:
nutupsdrv(8)

  Internet resources:
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/