2011-01-26 09:35:08 +00:00
|
|
|
BCMXCP_USB(8)
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
bcmxcp_usb - Experimental driver for UPSes supporting the BCM/XCP protocol over USB
|
|
|
|
|
|
|
|
|
|
NOTE
|
|
|
|
|
----
|
|
|
|
|
This man page only documents the hardware-specific features of the
|
2010-03-25 23:20:59 +00:00
|
|
|
bcmxcp_usb driver. For information about the core driver, see
|
2011-01-26 09:35:08 +00:00
|
|
|
linkman:nutupsdrv[8].
|
2010-03-25 23:20:59 +00:00
|
|
|
This driver is a variant of the serial driver bcmxcp and uses the same core code.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
SUPPORTED HARDWARE
|
|
|
|
|
------------------
|
|
|
|
|
This driver should recognize all BCM/XCP-compatible UPSes that are connected
|
2010-03-25 23:20:59 +00:00
|
|
|
via USB. It has been developed and tested on Powerware PW3501 hardware. It also has
|
|
|
|
|
been tested on PW5110 hardware.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
EXTRA ARGUMENTS
|
|
|
|
|
---------------
|
2010-03-25 23:20:59 +00:00
|
|
|
|
|
|
|
|
This driver supports the following optional settings in the
|
2011-01-26 09:35:08 +00:00
|
|
|
linkman:ups.conf[5].
|
2010-03-25 23:20:59 +00:00
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
*shutdown_delay=*'delay'::
|
2010-03-25 23:20:59 +00:00
|
|
|
The number of seconds that the UPS should wait between receiving the
|
|
|
|
|
shutdown command and actually shutting off.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
DEFAULT VALUES FOR THE EXTRA ARGUMENTS
|
|
|
|
|
--------------------------------------
|
|
|
|
|
*shutdown_delay =*'120'
|
2010-03-25 23:20:59 +00:00
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
INSTANT COMMANDS
|
|
|
|
|
----------------
|
2010-03-25 23:20:59 +00:00
|
|
|
This driver supports the following Instant Commands:
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
*shutdown.return*::
|
2010-03-25 23:20:59 +00:00
|
|
|
Turn off the load and return when power is back.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
*shutdown.stayoff*::
|
2010-03-25 23:20:59 +00:00
|
|
|
Turn off the load and remain off.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
*test.battery.start*::
|
2010-03-25 23:20:59 +00:00
|
|
|
Start a battery test.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
TODO LIST
|
|
|
|
|
---------
|
2010-03-25 23:20:59 +00:00
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
*Report UPS alarm status*::
|
2010-03-25 23:20:59 +00:00
|
|
|
BCM/XCP supports reporting a wide range of UPS alarm conditions.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
*Report UPS statistics informations*::
|
2010-03-25 23:20:59 +00:00
|
|
|
BCM/XCP supports reporting of UPS statistics data.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
EXPERIMENTAL DRIVER
|
|
|
|
|
-------------------
|
2010-03-25 23:20:59 +00:00
|
|
|
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.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
INSTALLATION
|
|
|
|
|
------------
|
2010-03-25 23:20:59 +00:00
|
|
|
This driver is not built by default. You can build it by using
|
2011-01-26 09:35:08 +00:00
|
|
|
"configure --with-usb=yes". Note that it will also install other USB
|
2010-03-25 23:20:59 +00:00
|
|
|
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 ...).
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
IMPLEMENTATION
|
|
|
|
|
--------------
|
2010-03-25 23:20:59 +00:00
|
|
|
bcmxcp_usb only supports 1 UPS at this time. You can put the
|
2011-01-26 09:35:08 +00:00
|
|
|
"auto" value for port in `ups.conf`, i.e.:
|
2010-03-25 23:20:59 +00:00
|
|
|
|
|
|
|
|
[pw3105]
|
|
|
|
|
driver = bcmxcp_usb
|
|
|
|
|
port = auto
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
KNOWN ISSUES AND BUGS
|
|
|
|
|
---------------------
|
|
|
|
|
"Got EPERM: Operation not permitted upon driver startup"
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2010-03-25 23:20:59 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
AUTHOR
|
|
|
|
|
------
|
|
|
|
|
Tore Ørpetveit <tore@orpetveit.net>,
|
2010-03-25 23:20:59 +00:00
|
|
|
Wolfgang Ocker <weo@weo1.de>
|
|
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
2010-03-25 23:20:59 +00:00
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
The core driver:
|
|
|
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
|
linkman:nutupsdrv[8]
|
2010-03-25 23:20:59 +00:00
|
|
|
|
2011-01-26 09:35:08 +00:00
|
|
|
Internet resources:
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~
|
2010-03-25 23:20:59 +00:00
|
|
|
The NUT (Network UPS Tools) home page: http://www.networkupstools.org/
|
