NOTE

       This man page only documents the hardware-specific features of the usb-
       hid-ups driver.  For information about the  core  driver,  see  nutups-
       drv(8).

       This  driver  replaces  the  legacy hidups driver, which only supported
       Linux systems, and was formerly called newhidups.

SUPPORTED HARDWARE

       usbhid-ups brings USB/HID UPS monitoring to NUT on  all  platform  sup-
       porting  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, usbhid-ups 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. You may use the "explore" driver option to gather informa-
       tion from HID UPSes which are not yet supported; see below for details.

       This driver is known to work on:

           most Linux systems,
           FreeBSD (beta stage) and maybe other *BSD,
           Solaris 10 (not yet validated).

EXTRA ARGUMENTS

       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.


       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/prod-
              uct/serial string (minus any  surrounding  whitespace),  or  the
              whole  4-digit  hexadecimal code for vendorid and productid. Try
              -DD 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 argu-
              ment  is a regular expression that must match the bus name where
              the UPS is connected (e.g. bus="002", bus="00[2-3]").


       explore
              With this option, the driver will connect to any device, includ-
              ing  ones  that  are not yet supported. This must always be com-
              bined with the "vendorid" option. In this mode, the driver  will
              not do anything useful except for printing debugging information
              (typically used with -DD).

INSTALLATION

       This driver is not built by default.  You can build it by  using  "con-
       figure  --with-usb=yes". Note that it will also install other USB driv-
       ers.

       You also need to install manually the legacy hotplug  files  (libhidups
       and  libhid.usermap,  generally in /etc/hotplug/usb/), or the udev file
       (nut-usbups.rules, generally in /etc/udev/rules.d/)to address the  per-
       mission  settings  problem.  For  more information, refer to the README
       file in nut/scripts/hotplug or nut/scripts/udev.

       On Linux with MGE equipment, you will need at least a 2.4.25  or  2.6.2
       kernel  as  well as libusb-0.1.8 or later to disable hiddev support and
       avoid conflict.

                 driver = usbhid-ups
                 port = auto
                 vendorid = 09ae

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/



                                Fri Feb 16 2007                  USBHID-UPS(8)