bcmxcp_usb(8)

1BCMXCP_USB(8)               Network UPS Tools (NUT)              BCMXCP_USB(8)
2
3
4

NAME

6       bcmxcp - Experimental driver for UPS'es supporting the BCM/XCP protocol
7       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 nutups‐
12       drv(8).  This driver is a variant of the serial driver bcmxcp and  uses
13       the same core code.
14
15

SUPPORTED HARDWARE

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

EXTRA ARGUMENTS

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

DEFAULT VALUES FOR THE EXTRA ARGUMENTS

33       shutdown_delay = 120
34
35

INSTANT COMMANDS

37       This driver supports the following Instant Commands:
38
39
40       shutdown.return
41              Turn off the load and return when power is back.
42
43
44       shutdown.stayoff
45              Turn off the load and remain off.
46
47
48       test.battery.start
49              Start a battery test.
50
51

TODO LIST

53       Report UPS alarm status
54              BCM/XCP supports reporting a wide range of UPS alarm conditions.
55
56
57       Report UPS statistics informations
58              BCM/XCP supports reporting of UPS statistics data.
59
60

EXPERIMENTAL DRIVER

62       This  driver has been tagged experimental, even if it has been reported
63       to be stable. Thus it is not suitable for production systems and it  is
64       not  built  by default. This is mainly due to the fact that it is a new
65       driver.
66
67

INSTALLATION

69       This driver is not built by default.  You can build it by  using  "make
70       usb",  and  install it using "make install‐usb". Note that it will also
71       install other USB drivers.  You also need to install manually the  hot‐
72       plug  files  (libhidups  and  libhid.usermap),  generally  in  etc/hot‐
73       plug/usb/, to address the permission settings problem. Lastly note that
74       the  libhidups  file  must  have  execution flag set (ie using chmod +x
75       ...).
76
77

IMPLEMENTATION

79       bcmxcp_usb only supports 1 UPS at this time. You  can  put  the  "auto"
80       value for port in ups.conf, i.e.:
81
82            [pw3105]
83                 driver = bcmxcp_usb
84                 port = auto
85
86

KNOWN ISSUES AND BUGS

88   Got EPERM: Operation not permitted upon driver startup
89       You  have  forgotten  to install the hotplug files, as explained in the
90       INSTALLATION section above. Don't forget to restart hotplug so that  it
91       applies these changes.
92
93

AUTHOR

95       Tore Ørpetveit <tore@orpetveit.net> Wolfgang Ocker <weo@weo1.de>
96
97