bcmxcp(8) [debian man page]

BCMXCP(8)							    NUT Manual								 BCMXCP(8)

NAME

       bcmxcp - Driver for UPSes supporting the serial BCM/XCP protocol

NOTE

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

SUPPORTED HARDWARE

       This driver should recognize all serial BCM/XCP-compatible UPSes. It has been developed and tested on Powerware PW5115 and PW9120 hardware.
       If your UPS has a USB connection, you may also consult the bcmxcp_usb(8) driver documentation.

EXTRA ARGUMENTS

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

       shutdown_delay=delay
	   The number of seconds that the UPS should wait between receiving the shutdown command (upsdrvctl shutdown) and actually shutting off.

       baud_rate=rate
	   Communication speed for the UPS. If this is set to 9600, it tries to connect to the UPS at 9600bps. If it fails to communicate, it will
	   go into baud-hunting. It starts at 1200 and goes up to 19200. If it succeeds, it tell you the speed it connected with. If not included
	   in the config, it defaults to baud-hunting.

DEFAULT VALUES FOR THE EXTRA ARGUMENTS

       o    shutdown_delay = 120

       o    baud_rate = none

INSTANT COMMANDS

       This driver supports the following Instant Commands:

       shutdown.return
	   Turn off the load and return when power is back.

       shutdown.stayoff
	   Turn off the load and remain off.

       test.battery.start
	   Start a battery test.

       outlet.n.shutdown.return
	   Turn off the load on outlet n and return when power is back. (n is the outlet number reported by the upsc command)

TODO LIST

       Report UPS statistics information
	   BCM/XCP supports reporting of UPS statistics data.

       Change settings
	   Access the config register to change settings.

BUGS

       None known.

AUTHOR

       Tore Orpetveit <tore@orpetveit.net>

SEE ALSO

   The core driver:
       nutupsdrv(8)

   The USB BCM/XCP driver:
       bcmxcp_usb(8)

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

Network UPS Tools						    05/21/2012								 BCMXCP(8)

BCMXCP_USB(8)							    NUT Manual							     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 bcmxcp_usb driver. For information about the core driver, see
       nutupsdrv(8). This driver is a variant of the serial driver bcmxcp and uses the same core code.

SUPPORTED HARDWARE

       This driver should recognize all BCM/XCP-compatible UPSes that are connected via USB. It has been developed and tested on Powerware PW3501
       hardware. It also has been tested on PW5110 hardware.

EXTRA ARGUMENTS

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

       shutdown_delay=delay
	   The number of seconds that the UPS should wait between receiving the shutdown command and actually shutting off.

DEFAULT VALUES FOR THE EXTRA ARGUMENTS

       shutdown_delay =120

INSTANT COMMANDS

       This driver supports the following Instant Commands:

       shutdown.return
	   Turn off the load and return when power is back.

       shutdown.stayoff
	   Turn off the load and remain off.

       test.battery.start
	   Start a battery test.

TODO LIST

       Report UPS alarm status
	   BCM/XCP supports reporting a wide range of UPS alarm conditions.

       Report UPS statistics informations
	   BCM/XCP supports reporting of UPS statistics data.

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.

INSTALLATION

       This driver is not built by default. You can build it by using "configure --with-usb=yes". 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 ...).

IMPLEMENTATION

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

	   [pw3105]
		   driver = bcmxcp_usb
		   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.

AUTHOR

       Tore Orpetveit <tore@orpetveit.net>, Wolfgang Ocker <weo@weo1.de>

SEE ALSO

   The core driver:
       nutupsdrv(8)

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

Network UPS Tools						    05/21/2012							     BCMXCP_USB(8)