Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
BCMXCP_USB(8)			   NUT Manual			   BCMXCP_USB(8)

NAME
     bcmxcp_usb  - Experimental driver for UPSes supporting the BCM/XCP protocol
     over USB

SYNOPSIS
     bcmxcp_usb -h

     bcmxcp_usb -a UPS_NAME [OPTIONS]

	 Note

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

	 Note

	 This driver is a variant of the serial driver bcmxcp(8)  and  uses  the
	 same core code.

SUPPORTED HARDWARE
     This  driver  should  recognize  all BCM/XCP-compatible UPSes that are con-
     nected via USB. It has been developed and tested on Powerware PW3501  hard-
     ware. 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.

	 Note

	 This driver does not currently support USB-matching settings common  to
	 other	drivers,  such	as vendor, vendorid, product, productid, serial,
	 device or bus.

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 information
	 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 may be not
     built by default. This is mainly due to the fact that it is a new driver.

INSTALLATION
     This driver may be not built by default. You can require building it by us-
     ing  ./configure  --with-usb=yes  (note that it will also install other USB
     drivers), or ./configure --with-drivers=bcmxcp_usb. Either way,  you  would
     need  libusb-dev  (libraries  and	headers package) or equivalent for other
     platforms.

     You also need to install manually the hotplug  files  (libhidups  and  lib-
     hid.usermap), generally in etc/hotplug/usb/, to address the permission set-
     tings 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  IN-
     STALLATION  section  above.  Don't forget to restart hotplug so that it ap-
     plies these changes.

AUTHORS
     *	 Tore Arpetveit <tore@orpetveit.net>

     *	 Wolfgang Ocker <weo@weo1.de>

SEE ALSO
   The core driver:
     nutupsdrv(8)

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

Network UPS Tools 2.8.5.	   08/04/2026			   BCMXCP_USB(8)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=bcmxcp_usb&sektion=8&manpath=FreeBSD+Ports+15.1.quarterly>

home | help