bcmxcp_usb(8)

1BCMXCP_USB(8)                     NUT Manual                     BCMXCP_USB(8)
2
3
4

NAME

6       bcmxcp_usb - Experimental driver for UPSes supporting the BCM/XCP
7       protocol over USB
8

NOTE

10       This man page only documents the hardware-specific features of the
11       bcmxcp_usb driver. For information about the core driver, see
12       nutupsdrv(8). This driver is a variant of the serial driver bcmxcp and
13       uses the same core code.
14

SUPPORTED HARDWARE

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

EXTRA ARGUMENTS

21       This driver supports the following optional settings in the
22       ups.conf(5).
23
24       shutdown_delay=delay
25           The number of seconds that the UPS should wait between receiving
26           the shutdown command and actually shutting off.
27

DEFAULT VALUES FOR THE EXTRA ARGUMENTS

29       shutdown_delay =120
30

INSTANT COMMANDS

32       This driver supports the following Instant Commands:
33
34       shutdown.return
35           Turn off the load and return when power is back.
36
37       shutdown.stayoff
38           Turn off the load and remain off.
39
40       test.battery.start
41           Start a battery test.
42

TODO LIST

44       Report UPS alarm status
45           BCM/XCP supports reporting a wide range of UPS alarm conditions.
46
47       Report UPS statistics informations
48           BCM/XCP supports reporting of UPS statistics data.
49

EXPERIMENTAL DRIVER

51       This driver has been tagged experimental, even if it has been reported
52       to be stable. Thus it is not suitable for production systems and it is
53       not built by default. This is mainly due to the fact that it is a new
54       driver.
55

INSTALLATION

57       This driver is not built by default. You can build it by using
58       "configure --with-usb=yes". Note that it will also install other USB
59       drivers.
60
61       You also need to install manually the hotplug files (libhidups and
62       libhid.usermap), generally in etc/hotplug/usb/, to address the
63       permission settings problem. Lastly note that the libhidups file must
64       have execution flag set (ie using chmod +x ...).
65

IMPLEMENTATION

67       bcmxcp_usb only supports 1 UPS at this time. You can put the "auto"
68       value for port in ups.conf, i.e.:
69
70           [pw3105]
71                   driver = bcmxcp_usb
72                   port = auto
73

KNOWN ISSUES AND BUGS

75    Got EPERM: Operation not permitted upon driver startup""
76       You have forgotten to install the hotplug files, as explained in the
77       INSTALLATION section above. Don’t forget to restart hotplug so that it
78       applies these changes.
79

AUTHOR

81       Tore Ørpetveit <tore@orpetveit.net>, Wolfgang Ocker <weo@weo1.de>
82