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

FreeBSD Manual Pages

  
 
  

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

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

SYNOPSIS
     bcmxcp -h

     bcmxcp -a UPS_NAME [OPTIONS]

	 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 suc-
	 ceeds, 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
     *	 shutdown_delay = 120

     *	 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 Arpetveit <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: https://www.networkupstools.org/

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

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

home | help