newhidups

HIDUPS(8)                   Network UPS Tools (NUT)                  HIDUPS(8)

NAME

       hidups - Experimental Multi-HID 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  nutups-
       drv(8).

       This is an experimental driver.  Not all features may work correctly.

SUPPORTED HARDWARE

       newhidups  is  an  experiment to bring USB 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 only supports MGE UPS SYSTEMS models.

       On Linux, you will need at least a 2.4.25 or 2.6.2  kernel  to  disable
       hiddev  support  and  avoid  conflict.  Otherwise, prefer to use hidups
       driver.

EXTRA ARGUMENTS

       This  driver  supports  the  following   optional   settings   in   the
       ups.conf(5):


       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.

EXPERIMENTAL DRIVER

       This  driver has been tagged experimental, even if it has been reported
       to be stable. Thus it is not suitable for production systems and it  is
       not  built  by default. This is mainly due to the fact that it is a new
       driver, and that it will be replaced  soon  with  a  version  using  an
       external  HID  library  (libhid),  as  opposed  to the current internal
       ripped version.

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  hot-
       plug  files  (libhidups  and  libhid.usermap),  generally  in  etc/hot-
       plug/usb/, to address the permission settings problem.

IMPLEMENTATION

       newhidups only support 1 UPS at this time. You can put the "auto" value
       for port in ups.conf, i.e.:

            [newhidups]
                 driver = newhidups
                 port = auto

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

SEE ALSO

   The core driver:
       nutupsdrv(8)


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



                                Wed May 25 2005                      HIDUPS(8)