APC UPS control system manual

Ap cupsd is a UPS control system that p ermits orderly sh utdo wn of y our computer in the even t of a pow er failure. Kern Sibbald April 3, 2005 This manual documents apcupsd v ersion 3.10.17 Cop yrigh t (C) 1999-2005 Kern Sibbald[...]

Cop ying and distribution of this file, with or without mo dification, are p er- mitted in any medium without ro y alt y pro vided the name Ap cupsd, the cop yrigh t notice, and this notice are preserv ed. Ap cupsd source co de is released under the GNU General Public License v ersion 2. Please see the file COPYING in the main source directory .[...]

Con ten ts Ap cupsd User’s Man ual . . . . . . . . . . . . . . . . . . . . . . . . 6 Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 New F eatures . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Ho w T o Use This Manual . . . . . . . . . . . . . . . . . . . . . . . 9 Basic User’s Guide . . . . . . . . . . . .[...]

Chec king Y our Configuration File . . . . . . . . . . . . . . . . 44 Arranging for Reb o ot on Po w er-Up . . . . . . . . . . . . . . . 45 Making sure ap cupsd Is Running . . . . . . . . . . . . . . . . 46 Configuration Examples . . . . . . . . . . . . . . . . . . . . . . . . 47 Simple USB Configuration . . . . . . . . . . . . . . . . . . . . 4[...]

Ap cupsd Notification and Ev en ts . . . . . . . . . . . . . . . . 70 hid-ups and USB Sp ecific Information . . . . . . . . . . . . . 71 ap cupsd Netw ork Monitoring (CGI) Programs . . . . . . . . . 71 Setting up and T esting the CGI Programs . . . . . . . . . . . 71 Configuring Y our EEPR OM . . . . . . . . . . . . . . . . . . . 79 Main taining[...]

Running the serv er as a c hild of ap cupsd . . . . . . . . . . . . 110 Running ap cnisd from INETD . . . . . . . . . . . . . . . . . 111 Running ap cnisd Standalome . . . . . . . . . . . . . . . . . . 112 ap cupsd System Logging . . . . . . . . . . . . . . . . . . . . . . . . 113 Logging T yp es . . . . . . . . . . . . . . . . . . . . . . . . . . [...]

Connecting a APC USB UPS to either a PC USB or Serial Port . 131 C a b l e s ..... .......... ........... ........1 3 1 Smart-Custom Cable for SmartUPSes . . . . . . . . . . . . . 131 Smart Signalling Cable for BackUPS CS Mo dels . . . . . . . 132 V oltage-Signalling Cable for ”dum b” UPSes . . . . . . . . . . 134 Other APC Cables that ap cupsd[...]

Configuration Directive Reference . . . . . . . . . . . . . . . . . . . 159 General Configuration Directives . . . . . . . . . . . . . . . . 159 Configuration Directiv es Used by the Net w ork Information Server 160 Configuration Directives used during P o w er F ailures . . . . . 161 Configuration Directiv es used to Control System Logging . [...]

Alert messages . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Register 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Register 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Register 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 In terpretation of the Old Firm w are Revision . . . . . . .[...]

List of Figures Multimon Main Page . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Multimon Statistics Displa y . . . . . . . . . . . . . . . . . . . . . . 74 Windo ws Install - Explorer Window . . . . . . . . . . . . . . . . . 116 Windo ws Install - Winzip Unpac k . . . . . . . . . . . . . . . . . . 117 Windo ws Install - Winzip Extract Win[...]

List of T ables Supp orted UPS Mo dels . . . . . . . . . . . . . . . . . . . . . . . . 13 Supp orted F eatures . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 RS232 Wiring and Signal Con v en tions . . . . . . . . . . . . . . . . 148 Single Character Commands . . . . . . . . . . . . . . . . . . . . . 183 DIP Switc h Info . . . . . . . . .[...]

Ap cupsd User’s Man ual Release Notes This release contains a go o d n um b er of cleanups and bug fixes to prior 3.10.x v ersions, and is in tended to b e the official release. See the ChangeLog b elow for more details. New F eatures - Implement USB on all *BSD systems. Note, the kernel drivers on most of these systems are still fragile. There [...]

page. Change Log for older versions ----> Release 3.10.16 04Nov04 - Adam has fixed the killpower problem for USB so that the USB now properly turns off the power. Nice job. - Converted manual from docbook to texinfo format. There is some cleanup to be done, but we get an index. - Thanks to Adam for converting the .png images to .pdf - Apply patc[...]

- ifdef code in apcaccess that tries to write in the shared memory buffer. - Applied Adam’s patch for fixing the pthreads dependencies in asys.c - Tweak the patch a bit hopefully so that OpenBSD will work. - Made a sweep through quite a few files updating the copyright, eliminating the disclaimer (now in DISCLAIMER), and adding as many astrncpy()[...]

Ho w T o Use This Man ual This is the manual for ap cupsd, a daemon for communicating with UPSes (Unin terruptible P o w er Supplies) made by American P o w er Corporation (APC). If y ou hav e an APC-made UPS, whether sold under the APC name- plate or OEMed (The HP P o w erT rust 2997A UPS has b een tested as a “smartups” with cable Hewlett P a[...]

1. First, c hec k to see if ap cupsd supp orts y our UPS and op erating system (see Supp orted Op erating Systems; UPSes and Cables ). 2. Second, plan y our configuration t yp e (see Cho osing a Configuration Type ). If y ou hav e just one UPS and one computer, this is easy . If y ou hav e more than one mac hine b eing serv ed b y the same UPS, o[...]

9. T o verify that y our UPS is comm unicating with your computer and will do the righ t thing when the p o w er go es out, read and follow the instructions in the T esting (see T esting Ap cupsd) section. 10. If y ou run into problems, read the T roubleshooting (see T roublesho oting Y our Installation ) section of this man ual. 11. If you still n[...]

W e’ll describ e the p ossible v alues here, b ecause they’re a go o d wa y to ex- plain your UPS’s single most imp ortant in terface prop erty – the kind of proto col it uses to talk with its computer. ap csmart An APCSmart UPS and its computer also communicate through an RS232C serial connection, but they actually use it as a c haracter c[...]

of the mo dels, particularly USB enabled models, can be run in multiple mo des, so they may appear more than once in the table. APC is putting out new models at a furious rate, and so it is v ery likely that y our mo del is not listed in the table. If it is USB enabled, it will probably w ork in USB mo de. Please note that some of these new mo dels[...]

Bac kUPS CS USB, Pro USB, ES USB, RS/XS 1000, RS/XS 1500, and probably other USB mo dels usb usb (note: using APC cables 940- 0127A/B/C) Supp orted in version > =3.9.8 SmartUPS USB, Bac k- UPS Office USB, and any other USB UPS usb usb (note: us- ing APC cable, no n um b er) Supp orted, v ersion > =3.9.8 All SNMP- capable mo dels snmp ether Su[...]

p o w ers a single computer. This is the most common configuration. If you’re w orking with just one mac hine and one UPS, skip the rest of this section. Y our choices b ecome more interesting if you are running a small cluster or a big serv er farm. Under those circumstances, it may not b e p ossible or ev en desirable to pair a UPS with every [...]

driv er to b e enabled on other platforms, it will only compile and run on Lin ux and *BSD systems. - W ork around: T ry using UPS in serial mo de instead of USB. - Problem: Lin ux 2.4 series k ernels older than 2.4.22 do not bind the USB device to the prop er driver. This is evidenced by /pro c/bus/usb/devices listing the UPS correctly but it will[...]

Chec king Out Y our USB Subsystem Y ou can skip this section if y our UPS has an Ethernet or RS232-C in terface or y ou are not running on a Linux k ernel. If it has a USB in terface, you need to make sure that your USB subsystem can see the UPS. On a Linux system this is easy , just do this from a shell prompt (please see b elow for 2.6 k ernel co[...]

T: Bus=01 Lev=01 Prnt=01 Port=00 Cnt=01 Dev#= 2 Spd=1.5 MxCh= 0 D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1 P: Vendor=051d ProdID=0002 Rev= 1.00 S: Manufacturer=American Power Conversion S: Product=Back-UPS 350 FW: 5.2.I USB FW: c1 S: SerialNumber=BB0115017954 C:* #Ifs= 1 Cfg#= 1 Atr=a0 MxPwr= 30mA I: If#= 0 Alt= 0 #EPs= 1 Cls=03([...]

esr@grelber$ cat /proc/bus/usb/drivers and y ou should get: usbdevfs hub 96-111: hiddev hid On Lin ux-2.6.x, mak e sure the sysfs filesystem is moun ted on /sys and do: adk0212@mail$ ls -l /sys/bus/usb/drivers/ where y ou should get total 0 drwxr-xr-x 2 root root 0 May 1 18:55 hid drwxr-xr-x 2 root root 0 May 1 18:55 hiddev drwxr-xr-x 2 root root [...]

CONFIG USB, CONFIG USB HID, CONFIG USB HIDDEV, and CON- FIG USB DEVICEFS as well as at least one USB Host Controller Driv er (CONFIG USB UHCI HCD [2.6.x], CONFIG USB UHCI [2.4.x], etc.). If CONFIG USB is set as M, CONFIG USB HID must be M (if enabled at all). If CONFIG USB is set as Y, CONFIG USB HID can be M or Y. hiddev, in turn, will b e built h[...]

where y ou replace the [ and ] with braces and the serial n um b er with the one that correspnds to y our UPS. Some kernels ship, suc h as Mandrak e 10, ship with CON- FIG USB D YNAMIC MINORS turned on. This is not ideal for running with ap cupsd, and the easiest solution is to turn CON- FIG USB D YNAMIC MINORS off and rebuild y our k ernel, or ?[...]

Finally , c hec k that appropriate USB devices exist. On a Red Hat system y ou can do this: esr@grelber$ ls /dev/usb/h* /dev/usb/hiddev0 /dev/usb/hiddev12 /dev/usb/hiddev2 /dev/usb/hiddev6 /dev/usb/hiddev1 /dev/usb/hiddev13 /dev/usb/hiddev3 /dev/usb/hiddev7 /dev/usb/hiddev10 /dev/usb/hiddev14 /dev/usb/hiddev4 /dev/usb/hiddev8 /dev/usb/hiddev11 /dev[...]

If all there things chec k out and y ou still can’t see the UPS, something is more seriously wrong than this man ual can co ver – find exp ert help. If you are unable to list USB devices or driv ers, you k ernel ma y not b e USB-capable and that needs to b e fixed. Please chec k if your k ernel has the three patc hes listed in the < ap cup[...]

FreeBSD-4.11 NetBSD-2.0 NetBSD-1.6.2 OpenBSD-3.6 F reeBSD-5.3 has had the most testing since it is the primary platform on whic h the driv er is developed. The other platforms and v ersions ha v e had somewhat less testing. The only arc hitecture tested so far (on any platform) is i386, althought there is no reason to think it will not work on othe[...]

Note that the “ugen” driver is called out. If you see “uhid” instead, it probably means you did not prop erly disable the uhid driver when y ou compiled y our k ernel or p erhaps you’re not running the new kernel. Y ou can also c heck with ’usb devs -d’ to get a list of USB devices recognized b y the system as w ell as the drivers the[...]

The DEVICE setting is blank on purp ose; ap cupsd will automatically lo cate y our UPS. The dela y-, timeout-, and NIS-related settings should b e configured as p er y our usual preference. Building and Installing ap cupsd Installation from Binary P ac k ages Red Hat Linux: F or Red Hat systems, ap cupsd is av ailable in binary RPM format. This is[...]

Installation from Source Installation from source migh t ha v e to be b e done different w a ys dep ending on what system you are running. The basic pro cedure inv olv es getting a source distribution, running the configuration, rebuilding, and installing. The basic installation from a tar source file is rather simple: 1. Unpac k the source co d[...]

without redoing the configuration pro cess by simply editing the ap cupsd.conf file. Other configuration options can b e used to set up the installation of HTML do cumen tation and optional mo dules, notably the CGI in terface that enables the UPS state to b e queried via the W eb and the optional p ow erflute curses- based con trol panel. Stil[...]

/sbin/apcupsd $ whereis apcupsd apcupsd: /sbin/apcupsd /etc/apcupsd /etc/apcupsd.conf /etc/apcupsd.status /usr/man/man8/apcupsd.8.gz /usr/man/man8/apcupsd.8 If y ou find an ap cupsd in /usr/sbin, /usr/lo cal/sbin, /usr/lib, or another suc h directory , it is probably a piece of an old version of ap cupsd that you can delete. If you are in doubt, d[...]

The purp ose of mo difying the system halt files is so that ap cupsd will b e recalled after the system is in a stable state. A t that p oint, ap cupsd will instruct the UPS to sh ut off the p ow er. This is necessary if you wish y our system to automatically reb o ot when the mains pow er is restored. If y ou prefer to manually reb o ot your sys[...]

—sbindir= < path > This defines the directory for the executable files suc h as apcupsd. The default is /sbin. Y ou may be tempted to place the executable files in /usr/sbin or /usr/local/sbin. Please use caution here as these directories may b e unmounted during a shutdo wn and th us ma y preven t the halt script from calling ap cupsd t[...]

—enable-test This turns on a test driver that is used only for debugging. By default it is disabled. —enable-nis T urns on the Netw ork Information Server (NIS) co de within ap cupsd. This is enabled b y default. If you do not wan t to access the status of the UPS from the net w ork and y ou are not con trolling any sla v es via NIS (enable-net[...]

—with-nis-p ort= < p ort > This option allows y ou to sp ecify what p ort ap cupsd will use for the Net w ork Information Server (the CGI pro- grams). The default is system dep endent but usually 3551 b ecause that p ort has b een officially assigned to ap cupsd by the IANA. This option simply sets the appropriate port in the ap cupsd.conf [...]

./configure --prefix=/usr --sbindir=/sbin --enable-usb --enable-pthreads and y ou can optionally build and install the CGI programs as follows: ./configure --prefix=/usr --sbindir=/sbin --enable-usb --enable-cgi --with-cgi-bin=/home/httpd/cgi-bin --enable-pthreads Compilers and Options Some systems require un usual options for compilation or [...]

Op erating System Sp ecifics With the exception of Linux SUSE and Linux Red Hat systems used by the dev elop ers, w e rely on users to help create installation scripts and in- structions as w ell as to test that ap cupsd runs correctly on their system. As y ou can imagine, most of these p eople are system administrators rather than dev elop ers so[...]

DEVICE /dev/tty01 In addition, y ou should ensure serial port lo ck file in apcupsd.conf is defined as: LOCKFILE /var/spool/locks Unlik e the Linux systems, the system halt routine is lo cated in /sbin/rc0, so after the make install , please chec k that this file has b een correctly up dated. The start/stop script can b e found in: /sbin/init.d/[...]

single pro cess, and th us is less efficien t (consumes more CPU time) than the forking version of ap cupsd. W e hop e to rectify this in a future version b y using the F reeBSD LinuxThreads implemen tation of pthreads. On the F reeBSD OS, there is no known w ay for a user program to get con trol when all the disks are synced. This is needed for ap[...]

Op enBSD to freeze up. The b est solution is probably to build without pthread. How ever, in doing so, y ou must realize that the bulk of this man- ual assumes that pthreads is enabled, and thus man y of the comments ab out ap caccess will not b e applicable. A second solution that seems to work is to delete all calls to the email notification rou[...]

As alwa ys, remem b er testing UPSes can be hazardous to y ou system, and, ap cupsd may c ontain bugs that c an damage your system and data files! Y ou m ust accept all resp onsibilit y for running this softw are. An unexp ected p o w er-off of a running system can be a disaster. As alwa ys, mak e bac kups of an y critical information b efore you[...]

./configure --prefix=/opt/apcupsd --sbindir=/etc/opt/apcupsd/sbin --sysconfdir=/etc/opt/apcupsd --with-cgi-bin=/opt/apcupsd/cgi-bin The w ay to setup the /sbin directory as the executables directory is to pass configure the sbindir=/sbin option. No other arguments should b e required, and your setup and platform should b e detected automat[...]

# If this is changed, mountall, umountall and rcS should also change. /sbin/umountall /sbin/umount /var/adm >/dev/null 2>&1 /sbin/umount /var >/dev/null 2>&1 /sbin/umount /usr >/dev/null 2>&1 echo ’The system is down.’ W e need to insert the following lines just b efore the last ’echo’: #see if this is a pow[...]

y our UPS mo del and cable t yp e, and the serial p ort that y ou hav e attac hed the UPS to. P eople hav e used b oth /dev/tt y a and /dev/ttyb with no problems. Y ou should b e sure that logins are disabled on the port y ou are going to use, otherwise you will not be able to communicate with the UPS. If y ou are not sure that logins are disabled [...]

pac k age. W e are striving to pro vide a useful pac k age that w orks across all platforms, and w elcome your feedbac k. Best regards, and thanks for your interest and help, The Ap cupsd Develop- men t T eam. Unkno wn System: During the ./configure , if ap cupsd do es not find one of the systems for whic h it has specific installation programs, [...]

After whic h, y ou can do a: make And to install ap cupsd, do: make install Finally , y ou should follow the Win32 (see Installation on Windows) instal- lation instruction, skipping the part that describ es unZipping the binary release. After Installation Chec king Y our Configuration File Once y ou ha v e installed ap cupsd, either from a binary [...]

Note that you should en ter “/dev/usb/hiddev[0-15]” literally as sho wn. The “[0-15]” expression tells apcupsd to searc h all hiddev devices until it finds a UPS. Y ou can restrict the search to a subset of devices by using something lik e “[0-4]”, but keep in mind this will limit ap cupsd’s ability to lo cate the UPS if the kernel r[...]

to P o w er On . This means that whenev er the p o w er is applied they are on. The only w a y to sh ut them off is to pull the plug or to ha v e a special program that p ow ers them off (/sbin/p ow eroff on Linux systems). If after making all the c hanges suggested ab o v e, you cannot get y our computer to automatically reb o ot, you migh t ex[...]

T o start ap cupsd man ually (as y ou will probably do immediately follo wing the installation), enter the follo wing: /etc/rc.d/apcupsd start Normally , when prop erly installed, apcupsd will b e started and stopp ed au- tomatically by y our system. Unfortunately , the details are different for eac h system. Below, we giv e the commands for selec[...]

Notice that we hav e not sp ecified a device. In doing so, apcupsd will try all the well kno wn USB p orts. W e strongly recommend you use this (empt y device address) form unless you ha v e a go o d reason to do otherwise. An alternate wa y of sp ecifying the device is to sp ecify a range of device addressess as follo ws: DEVICE /dev/usb/hid/hidd[...]

Normally y ou w ould ha v e man y more configuration directiv es to completely customize your installation, but this example shows y ou the minimum re- quired. A Simple Configuration for a Simple Signaling or Dum b If y ou hav e a simple signaling or dumb UPS suc h as a BackUPS, y ou will need to know exactly what cable y ou hav e and sp ecify it[...]

## apcupsd.conf v1.1 ## UPSCABLE smart UPSTYPE smartups DEVICE /dev/ttyS0 LOCKFILE /var/lock UPSCLASS netmaster UPSMODE net NETTIME 10 NETPORT 6666 SLAVE slave1.mynetwork.com SLAVE slave2.mynetwork.com Note, the main difference from the stand alone configuration is that y ou ha v e sp ecified UPSCLASS netmaster and UPSMODE net . In addition, y o[...]

Please note, there are rep orts that y ou m ust use UPSTYPE smartups on the sla v e even if the master is using UPSTYPE dumb . This is apparently some bug in the new dum b driv er. In this configuration, the sh utdo wn will be initiated b y the master. It is also p ossible to sp ecify BA TTER YLEVEL, MINUTES, and TIMEOUT configu- ration directiv [...]

thing lik e what follows. What is imp ortant is that you get the information from an ether cable ov er the net work and y ou must specify the address of a “NIS serv er” that is running NIS (not the Master/Slav e netw orking de- scrib ed ab ov e). The NIS sla v e ap cupsd will then p oll the NIS serv er at the NETTIME in terv al you sp ecify to [...]

UPS). The :3551 that follows the NIS server address is the port to use. The default is 3551, but older versions of ap cupsd used p ort 7000. Please do not confuse this NIS serv er/slav e mo de with the old master/slav e net w ork configuration that is describ ed ab ov e. This is a master/sla v e setup, but m uch simpler (the NIS serv er do es not [...]

or the equiv alent for your system. If y ou are running on Linux and using the fork()ing v ersion of ap cupsd, y ou should something similar to the follo wing output. 4492 ? S 0:00 apcmain -f /etc/apcupsd/apcupsd.conf 4496 ? S 0:00 _ apcser -f /etc/apcupsd/apcupsd.conf 4497 ? S 0:00 _ apcnis -f /etc/apcupsd/apcupsd.conf This indicates that ap cup[...]

Logging T est Once you ha v e established that the prop er pro cesses are running, do a tail of the system log file, normally /v ar/log/messages: tail /var/log/messages Y ou should see output that lo oks similar to the following: Dec 5 17:01:05 matou apcupsd[5917]: apcupsd 3.7.2 startup succeeded And if y ou ha v e configured the netw ork informa[...]

in y our ap cupsd.conf file. T o run the ap caccess test, use the following command: apcaccess status Dep ending on the t yp e of UPS you ha v e, y ou will get sligh tly different output, but an example F or a Smart-UPS is as follo ws: APC : 001,048,1088 DATE : Fri Dec 03 16:49:24 EST 1999 HOSTNAME : daughter RELEASE : 3.7.2 CABLE : APC Cable 940[...]

NOMOUTV : 115.0 NOMBATTV : 24.0 HUMIDITY : N/A AMBTEMP : N/A EXTBATTS : N/A BADBATTS : N/A FIRMWARE : N/A APCMODEL : 6TD END APC : Fri Dec 03 16:49:25 EST 1999 F or a simple signaling or dumb UPS suc h as Bac kUPS, your output will b e v ery minimal as follows: APC : 001,012,0319 DATE : Mon Feb 18 09:11:50 CST 2002 RELEASE : 3.8.5 UPSNAME : UPS_IDE[...]

If y ou see a message to the effect of: attach_shmarea: shared memory version mismatch (or UPS not yet ready to report) or if all the displa yed v alues are zero, you ha v e not waited long enough. W ait a bit longer and then re-execute the apcaccess status command. If y ou see a message to the effect of: APCACCESS FATAL ERROR in apcaccess.c at l[...]

A t the same time, it sends the same message to the system log and to the temp orary EVENTS file (/etc/ap cupsd/ap cupsd.ev en ts). Plug the serial p ort plug back in to your computer, and within ab out 12 seconds, ap cupsd should reestablish comm unications and broadcast and log the follo wing message: Comm unications with UPS restored. If these [...]

A though this should not b e necessary , as an extra precaution, you can sh ut- do wn y our mac hine, remo v e the plug from the UPS y ou are testing, and plug y our mac hine into another UPS or directly into the wall. Doing so, will ensure that the UPS doesn’t cut the p o w er to y our mac hine at a bad time. Remem b er at the end of the testing[...]

A t this p oin t, w e recommend that y ou do a sim ulated p o w er do wn of y our system. If you are adven turesome or hav e b een through this b efore, skip to the next section in this manual and do the real p o w er fail shutdo wn. If y ou con tin ue with the sim ulated p ow er down and if all go es w ell, ap cupsd will go through all the motions[...]

No w when y ou pull the p o w er plug, and either the timer expires or the batteries are exhausted (see the next section for more details), the system should b e fully shutdo wn. After p erforming this test, please be sure to restore /etc/ap cupsd/ap ccon trol to its previous state. F ull P o w er Do wn T est T o complete the testing, you should do[...]

lo ok at the “Sh utdo wn grace dela y”. Sh utdo wn Sequence If y ou exp erienced so problems with the abov e testing pro cedures, or if y ou are p orting apcupsd to another system, or you are simply curious, you may w an t to know exactly what is going on during the shutdo wn pro cess. If so, please see the Shutdo wn Sequence (see Sh utdo wn Se[...]

2003-07-07 11:19:21 apctest 3.10.6 (07 July 2003) redhat Checking configuration ... Attached to driver: apcsmart sharenet.type = DISABLE cable.type = CUSTOM_SMART You are using a SMART cable type, so I’m entering SMART test mode mode.type = SMART Setting up serial port ... Creating serial port lock file ... Hello, this is the apcupsd Cable Test p[...]

should some how b ecome disconnected during the test. Item 5 is used to program the EEPROM. Please see the Configuration Directiv es Used to Set the UPS EPROM c hapter of this man ual for the details. Item 6 will initiate a direct comm unication b et w een your terminal and the UPS at which point, you can en ter raw UPS commands. Please b e aw are[...]

P o w er Off (killp ow er) of UPS Do es Not W ork: Curren tly (as of 3.10.6) the co de to p o w er off the UPS works only if y ou ha v e a Linux k ernel v ersion 2.4.22 or greater, or you ha ve applied the patches in the examples directory to your k ernel. ap cupsd Cannot Reconnect After a Reb o ot: If ap cupsd does not connect to the USB p ort w[...]

y ou to do this include one command-line utility (ap caccess) and a GUI you can use through a W eb browser. Y ou can also use ap ctest to tune some parameters of the UPS itself. ap caccess ap caccess is a program (normally found in /sbin/apcaccess) that p ermits y ou to print out the complete status of your UPS. Although there are a num b er of com[...]

whic h means that ap caccess can access an y UPS on the netw ork running the Net w ork Information Server. The status command line option of ap caccess will produce a full prin tout of all the ST A TUS v ariables used b y ap cupsd. This can b e v ery helpful for c hec king the condition of y our UPS and to know whether or not ap cupsd is properly c[...]

LOADPCT : 11.4 Percent Load Capacity BATTV : 27.7 Volts BCHARGE : 100.0 Percent MBATTCHG : 5 Percent TIMELEFT : 112.0 Minutes MINTIMEL : 3 Minutes SENSE : Low DWAKE : 060 Seconds DSHUTD : 180 Seconds LOTRANS : 204.0 Volts HITRANS : 253.0 Volts RETPCT : 050.0 Percent STATFLAG : 0x08 Status Flag STATUS : ONLINE ITEMP : 29.2 C Internal ALARMDEL : Low [...]

ted v alues that can b e set in the EPR OM. F or information ab out chang- ing these v alues, see the section on tuning EEPROM parameters (see Configuring Y our EEPROM). A t ypical output from apcaccess eprom is: Valid EPROM values for the SMART-UPS 1000 Config Current Permitted Description Directive Value Values ==================================[...]

hid-ups and USB Sp ecific Information The UPS has an internal set of timers and remaining capacity counters, whic h it uses to determine when to shutdo wn. These are in addition to the ap cupsd counters BA TTER YLEVEL and MINUTES. As a conse- quence, ap cupsd will shutdo wn on the first limit that triggers (either an ap cupsd limit, or a UPS limi[...]

Next you m ust edit the hosts file /etc/ap cupsd/hosts.conf and at the end, add the name of the hosts y ou wan t to monitor and a lab el string for them. Kern Sibbald uses multimon.conf unmo dified from what is on the source distribution. Ho w ev er, he has mo dified the hosts.conf file to con tain the follo wing three lines: MONITOR matou &quo[...]

Content-type: text/html <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loos e.dtd"> <HTML> <HEAD><TITLE>Multimon: UPS Status Page</TITLE></HEAD> <BODY BGCOLOR="#FFFFFF"> <TABLE BGCOLOR="#50A0A0" ALIGN=CENTER> <T[...]

m ultimon.cgi: This program monitors multiple UPSes at the same time. A typical output of m ultimon.cgi as display ed in your W eb bro wser migh t lo ok like the following: The mac hines monitored as well as the v alues and their col- umn headings are all configurable (see /etc/ap cupsd/hosts.conf and /etc/ap cupsd/m ultimon.conf ) upsstats.cgi: B[...]

Y ou can displa y different bar graphs by selecting differen t v ariables from the drop do wn menus at the top of each of the three bar graphs. As with multimon, if y ou hav e y our lo cal host configured in the /etc/ap cupsd/hosts.conf file, you can execute it from a Unix shell from the source cgi directory as follows: ./upsstats.cgi: As with [...]

LASTXFER : U command or Self Test SELFTEST : NO STESTI : 336 DLOWBATT : 02 Minutes DIPSW : 0x00 Dip Switch REG1 : 0x00 Register 1 REG2 : 0x00 Register 2 REG3 : 0x00 Register 3 MANDATE : 01/11/99 SERIALNO : GS9903001147 BATTDATE : 01/11/99 NOMOUTV : 230.0 NOMBATTV : 24.0 HUMIDITY : N/A AMBTEMP : N/A EXTBATTS : 0 BADBATTS : N/A FIRMWARE : 60.11.I APC[...]

Where host is the name of the host or the IP address of the host running the Net w ork Information Server. The default is the lo cal host. Y ou ma y optionally sp ecify a p ort address separated from the host name with a colon. Y ou may also optionally sp ecify a single command to b e executed. If you sp ecify a command, that command will b e execu[...]

Credits: Man y thanks go to Russell Kroll < rkroll at exploits.org > who wrote the CGI programs to work with his UPS Monitoring system named Net w ork UPS T o ols (NUT) . Thanks also to Jonathan Benson < jb enson at tec hnologist.com > for initially adapting the upsstatus.cgi program to w ork with ap cupsd. W e hav e enhanced the bar gr[...]

Configuring Y our EEPR OM If y ou ha v e a SmartUPS, there are dep ending on the UPS at least 12 differen t v alues stored in the EEPROM that determine ho w the UPS reacts to v arious conditions such as high line v oltage, lo w line voltage, p o w er do wn grace p erio ds, etc. In general, for the moment, we do not recommend that you c hange y ou[...]

Lower transfer voltage LOTRANSFER 196 196 188 208 204 Return threshold RETURNCHARGE 0 00 15 50 90 Output voltage on batts OUTPUTVOLTS 230 230 240 220 225 Sensitivity SENSITIVITY H H M L L Low battery warning LOWBATT 2 02 05 07 10 Shutdown grace delay SLEEP 20 020 180 300 600 Alarm delay BEEPSTATE 0 0 T L N Wakeup delay WAKEUP 0 000 060 180 300 Self[...]

4) Monitor Battery Calibration progress 5) Program EEPROM 6) Enter TTY mode communicating with UPS 7) Quit Select function number: Y ou migh t wan t to run option 1) just to ensure that ap ctest is prop erly talking to your UPS. It will produce quite ab out 70 lines of output. T o program the EEPROM, select option 5), and y ou will get the EEPR OM [...]

Valid EEPROM values for the SMART-UPS 1000 Config Current Permitted Description Directive Value Values ====================================== ============= ============= === Upper transfer voltage HITRANSFER 253 253 264 271 280 Lower transfer voltage LOTRANSFER 196 196 188 208 204 Return threshold RETURNCHARGE 0 00 15 50 90 Output voltage on batts [...]

found that it tak es sev eral discharge/c harges b efore the run time calibration is accurate. T ake care not to disc harge y our battery to o m uc h as it tends to shorten the battery life. What V arious P eople Ha v e to Say about Batteries Here is what John W alker has to say ab out APC UPS batteries: I though t I’d pass on some information I?[...]

Newport Beach CA 9266? Tel: +1 714 548-5259 J-W Batteries, Inc. Tel: +1 714 548-4017 WPS 49-1200 GEL-CELL KB-35 BATTERY F or those that do not know what this means........ I found the b est battery for APCC UPS products that use In the t w o systems b elo w: SMART-UPS 3000 10.9% is running at 327W runs for 47.0 min. Smart-UPS 1250 22.3% is running [...]

The 1250 can outrun the 3000 b y a factor of t w o under identical p ercen tages, or run head to head for the same time. SMAR T-UPS 3000 is a 48V based or 4 batteries. Smart-UPS 1250 is a 24V based or 2 batteries. Cheers, Andre Hedrick Linux ATA Development Finally , here is what Carl Erhorn has to say about batteries: Hi, F olks. W ell, Kern was a[...]

Surprise! (Or maybe not?) Kern was righ t - there is nothing wrong with the in verter or the c harging circuit, and the new cells fixed ev erything. What confused me is that there was no ’replace battery’ indi- cation from the UPS, even when it failed, plus a fair amount of run time indicated with a full c harge. So if you see suc h b eha vior[...]

Bac kground: An APC Smart-UPS has a micropro cessor which calculates run- time primarily based on the load attached to the UPS and on its battery capacity . On the right side of the fron t display panel there is a vertical graph of fiv e LEDs. Eac h LED is an indica- tion of battery charge in incremen ts of tw en t y p ercent: 20, 40, 60, 80, 100%[...]

monitoring soft w are. Set the UPS sh utdown time to 2 min utes, all other settings to nominal, and disconnect the serial p ort cable from the UPS b e- fore running the recalibration. If you leav e a monitoring program running through the serial p ort, it will turn the UPS off early , and you don’t wan t to do that during a recalibration run. Wh[...]

Where Carl Suggests Y ou Get Batteries Hi, F olks. I’m just replacing the batteries in one of m y SmartUPS models, and it o ccurs to me that some of y ou may not know about the place I get them from. I ha ve no relationship with this com- pan y , other than as a customer, but I feel they know what they are doing, their prices are fair, and they h[...]

and hav e never b een disapp oin ted. The owner of the place also is v ery go o d on tec hnical issues, so if you ha ve questions on their pro ducts, he can get as technical as you need to go. Regards, --Carl Here is a link to the APC Battery Store . F requen tly-Ask ed Questions See the bugs section of this do cument for a list of known bugs and s[...]

Q: Do es apcupsd support Windows? A: With release 3.8.0, ap cupsd now runs on Win95/98, WinMe, WinNT, and Win2000 mac hines. All features of the Unix v ersions of apcupsd are implemented. The UPS EEPR OM programming features of ap cupsd ha v e not b een tested under Windo ws. V ersion 3.8.0 do es not supp ort simple signaling UPSes (BackUPS, etc). [...]

A: No, the error is not serious. Unfortunately , the do cumentation in the area of master/slav es is not v ery detailed, and for that reason, your sla v e setup is not totally correct as explained b elow. On master mac hines, w e mo dify /etc/rc.d/init.d/halt to re-inv oke ap cupsd with the --killpower option (actually the script ap ccon- trol is c[...]

A: This problem and the problem of cannot create shm area are due to the fact that the shared memory key that apcupsd w ants to use is already in use. This happ ens most frequently when there is an old zom bie apcupsd pro cess still in the system. The solution is to remo v e the old pro cess. Y ou can often see what is going on by doing a: ipcs com[...]

sla v e that is sufficiently short that y ou are sure that the slav e will sh utdo wn b efore the master. If the shutdo wn is done with a p o w eroff, this will also sav e p ow er so that the master can sta y up longer. Q: Ho w do I ensure that my database server is correctly shutdo wn? A: Y ou simply add whatever commands are necessary in the app[...]

Q: When using USB, I get the follo wing log messages: usb-uhci.c: in ter- rupt, status 3, frame# 826. What do es it mean? A: It means one transfer w ork ed (bit 0 in status) and another one (after that) failed (bit 1) at time frame 826. This kind of soft error is common on USB and if everything seems to b e working, y ou can ignore it. Q: ap cnisd [...]

Ap cupsd Bugs Unfortunately , it seems that every program has some bugs. W e do our best to k eep the bugs to a minim um b y extensive testing. Ho wev er, b ecause of our inherent nature to o ccasionally ov erlo ok things and the fact that we don’t ha v e all the UPS mo dels nor the APC do cumentation on those models, ap cupsd will ha ve some bug[...]

w an t to send an email message to ro ot. At presen t the argumen ts that ap ccon trol recognizes are: When ap cupsd detects an even t, it calls the ap ccon trol script with four argumen ts as: ap ccon trol < ev en t > < ups-name > < connected > < p o w ered > where: ev en t is the ev ent that o ccurred and it ma y b e an y [...]

commfailure This ev en t is generated eac h time the comm unications line with the computer is severed. This ev en t is not detected on dum b signaling UPSes. Default -do es a printf ‘‘Warning serial port communications with UPS lost.’’ | wall then exits. commok After a commfailure even t is issued, when the communications to the computer i[...]

on battery This ev en t is generated 5 or 6 seconds after an initial p ow- erfailure is detected. It means that ap cupsd definitely considers the UPS to b e on batteries. The onset of this even t can b e dela y ed by the ONBA TTER YDELA Y ap cupsd.conf configuration directive. Default — do es a printf ‘‘Power failure. Running on UPS batteri[...]

Do es a printf ‘‘UPS battery runtime limit exceeded. Doing shutdown. n’’ | wall then exits. After completing this even t, ap cupsd will immediately initiate a doshutdown ev en t. startselftest This even t is generated when ap cupsd detects a self test by the UPS. Normally due to the 6 second onbattery delay default time, self test even ts[...]

p ort), which is called the master, can pro vide information to other machines p o w ered b y the UPS, called slav es. When the master detects a p ow er failure, it will notify all the slav es (maxim um of tw ent y). If the master detects that the battery is low, it will also notify the slav e so that the sla v e ma y p erform a sh utdo wn. In addi[...]

net w orking is considerably different from the old metho d describ ed at the b eginning of this c hapter. In the old co de, there is a lot of configuration on b oth the master and sla ve side, and the master p olls or sends info to the sla v e. Using the net driver is m uc h simpler. Ho w ev er, you should carefully c hec k that the NIS slav e d[...]

Net w ork Problems with Master/Slav e or Server/Sla v e Con- figurations When w orking with a master/sla v e or serv er/slav e configurations (one UPS p o w ering more than one computer), the master/server and slav e commu- nicate via the netw ork. In man y configurations, ap cupsd is started b efore the net w ork is initialized. In this case, i[...]

same. Please be sure you are running the same v ersion of ap cupsd on all y our master and slav e mac hines. to slav e SSS failed This message is logged when the master attempts to connect to slav e SSS and no connection is accepted. The most common cause of this problem is that the slav e cop y of ap cusp d is not y et ready to accept connections [...]

attempt from master MMM The master named MMM (probably an IP address) contacted the slav e but MMM is not the master that was listed on the MASTER configuration directiv e in /etc/ap cupsd.conf, and consequently , it is not authorized to comm unicate with the slav e. Please chec k that your MASTER and SLA VE names in y our slav e and master confi[...]

Con trolling Multiple UPSes on one Mac hine Y ou ma y w an t to use y our serv er to con trol m ultiple UPSes. This is p ossible b y prop er configuration and by running one cop y of ap cupsd for each UPS to b e controlled (recall the Configuration t yp es. ). Configuration The w ay to accomplish the ab ov e is to ensure that none of the critica[...]

./configure --prefix=$HOME/apcupsd/bin --sbindir=$HOME/apcupsd/bin --enable-cgi --with-cgi-bin=$HOME/apcupsd/bin --with-log-dir=$HOME/apcupsd/bin --with-pid-dir=$HOME/apcupsd/bin --sysconfdir=$HOME/apcupsd/bin --with-lock-dir=$HOME/apcupsd/bin --with-pwrfail-dir=$HOME/apcupsd/bin --with-serial-dev=/dev/ttyS1 --enable-pthreads [...]

a serial p ort card for it, or perhaps use a USB UPS. T o ensure that it is prop erly sh utdo wn if Computer A go es do wn, y ou could run a second copy of ap cupsd on Computer B as a slav e connected to the main cop y of apcupsd on Computer A. Thus Computer B w ould b e running t w o slav es, one driv en by the master con trolling UPS 1 and the ot[...]

• The read-write comm unit y string, usually it is “priv ate” for read-write access. Building and Installing ap cupsd F ollo w the instructions in Building and Installing ap cupsdl, b eing sure to include the following options (in addition to any others you need) on the ./configure line: ./configure --with-serial-dev=<your-SNMP-device&g[...]

parameter to 180 seconds or more, depending on how muc h time y our system shutdo wn requires to umount all the filesystems. • Change /etc/rc.d/ap cupsd script adding the ’—kill-on-p ow erfail’ to the apcupsd inv o cation. • Restart y our ap cupsd With this setup your UPS op erations should b e safe. Alternate W ays T o Run The Net w ork[...]

b e necessary if y ou use the default ap cupsd.conf, since it is already turned on. Although this metho d is simple, it affords no protection from the outside w orld accessing y our netw ork server unless y ou are b ehind a firewall. In addition, if there is a bug in the net w ork server code, or if a malicious user sends bad data, it may b e p o[...]

Next, you m ust mo dify /etc/inetd.conf to ha v e the following line: apcnisd stream tcp nowait root /usr/sbin/tcpd /sbin/apcnisd -i If y ou do not wan t to run the TCP wrapper, then the line should b e en tered as follo ws (not tested): apcnisd stream tcp nowait root /sbin/apcnisd -i Please chec k that the file lo cations are correct for y our sy[...]

/sbin/apcnisd The adv antage of running the netw ork information server standalone is that if for some reason, a client causes the netw ork server to crash, it will not affect the op eration of ap cupsd. ap cupsd System Logging The ap cupsd philosoph y is that all logging should b e done through the sys- log facilit y (see: man syslog ). This is n[...]

F or more details on ST A TUS logging, see the Status (see ap cupsd Status Logging) section of the T ec hnical Reference. Logging Ev en ts logging consists of logging ev en ts as they happ en. F or example, successful startup, p o w er fail, battery failure, system shutdo wn, ... See the manual section on customizing even t handling (see Customizin[...]

More w ork needs to b e done to the co de to ensure that it corresp onds to the ab o v e lev els. As a practical example of ho w to setup y our syslog() to use the new log- ging feature, supp ose y ou wish to direct all D A T A logging to a file named /v ar/log/ap cupsd.data, all EVENTS to the standard /v ar/log/messages file (to b e mixed with o[...]

Installation: Windo ws The Windo ws V ersion of ap cupsd The Windows version of ap cupsd has b een tested on Win95, Win98, WinMe, WinNT, WinXP , and Win2000 systems. This version of ap cupsd has b een built to run under the CYGWIN en vironmen t, which provides man y of the features of Unix on Windo ws systems. It also p ermitted a rapid p ort with [...]

• When Zip sa ys that it has one file and asks if it should unpac k it into a temporary file, respond with Y es . • Ensure that you extract all files and that the extraction will go into C: 122[...]

If y ou wish to install the pack age elsewhere, please note that y ou will need to pro ceed with a man ual installation, which is not particularly easy as y ou m ust rebuild the source and change the configuration file as well. This installation assumes that you do not ha v e CYGWIN installed on y our computer. If y ou do, and y ou use mount p oi[...]

m ulti(0)disk(0)rdisk(0)partition(1) WINNT=“Windows NT W ork- station V ersion 4.00” and add the follo wing to the end of the line: /NoSerialMice:COM1 (or COM2 dep ending on what y ou w an t to use). The new line should lo ok similar to: m ulti(0)disk(0)rdisk(0)partition(1) WINNT=“Windows NT W ork- station V ersion 4.00” /NoSerialMice:C[...]

What is imp ortant to v erify in the DOS window is that the ro ot di- rectory is moun ted on device c: . The DOS window will be follow ed immediately by a Windo ws dialogue b o x as follows: ! -- imagename=“Windo ws Install - Success” -- ¿ • On Windo ws 98, to actually start the service, either reb o ot the ma- c hine, which is not neces[...]

If the Services dialog rep orts a problem, it is normally b ecause your DEVICE statemen t do es not contain the correct serial p ort name. Y ou probably should also click on the Startup... button to ensure that the correct defaults are set. The dialogue b ox that app ears should hav e Startup T yp e set to Automatic and Logon should b e set to Syst[...]

c harged, the plug icon will b ecome a plug with a lightning b olt in the middle to indicate that the battery is charging. Installation Directory The Win32 v ersion of ap cupsd must reside in the c: ap cupsd directory , and there m ust b e a c: tmp directory on your mac hine. The installation will do this automatically , and we recommend that[...]

running v ersion of apcupsd, through the Services dialogue in the Con trol P anel , first click on the Stop button : then clic k on the Startup ... button, and in the Startup dialogue select the Disabled button to disable ap cupsd: After closing the dialogues, reb o ot the system, t ypical of Microsoft :-(. When the system comes bac k up, ap cupsd[...]

automatic service, using the Control P anel : reset ap cupsd to Automatic startup in the Startup dialogue, then restart ap cupsd in the Services di- alogue as sho wn ab ov e in the installation instructions. F requen tly after an upgrade, you will clic k on the Start button and after a few seconds, the system reports that it failed to start. The ca[...]

and stopping ap cupsd do not work. Use the services con trol panel instead. On Win95 systems, there are rep orts that the PIF files do not work. If y ou find that to b e the case, the simplest solution is to use the batch files that we ha v e supplied in the c:/ap cupsd/bin directory . Also, on Win95 systems, we ha ve an unconfirmed rep ort tha[...]

The functions of Stop , ups-even ts , and ups-status can b e more easily in v ok ed b y righ t clic king on the ap cupsd icon in the system tra y and selecting the desired function from the popup menu. Disclaimer Some of the features such as EEPR OM programming hav e not b een exhaus- tiv ely tested on Win32 systems. If at all p ossible, we recomme[...]

Email Notification of Even ts On Win95/98 systems, it is p ossible to receive notification of ap cupsd even ts that are passed to ap ccontrol. This is p ossible using a simple email program that unfortunately is not functioning 100% correctly . In addition, I (Kern) w as not able to mak e this program w ork on WinNT while ap cupsd is running as a[...]

c:apcupsdapcupsd.exe /service found under the key: HKEY_LOCAL_MACHINE SoftwareMicrosoftWindowsCurrentVe rsionRunServ ices to c:apcupsdapcupsd.exe /service -p If y ou hav e a Smart UPS, y ou can configure the kill p o w er grace p erio d, and y ou might w an t to set it to 3 minutes. If y ou ha v e a dumb UPS, there is no grace p erio d and[...]

Command Line Options Specific to the Windo ws V ersion These options are not normally seen or used b y the user, and are do cumen ted here only for information purp oses. A t the curren t time, to c hange the default options, y ou must either man ually run ap cupsd or y ou must man ually edit the system registry and mo dify the appropriate entries[...]

Installation: Serial-Line UPSes Ov erview of Serial-In terface UPSes If y ou ha v e a UPS that communicates via serial p ort, you need to do t w o things b efore y ou can even think ab out configuring the soft w are. First, y ou need to figure out whether it’s a dum b (v oltage-signalling) UPS or sp eaks the ap csmart proto col (see this discus[...]

Connecting a APC USB UPS to either a PC USB or Serial P ort An in teresting fact is that the USB p orts (actually an RJ45 connector) on APC UPSes not only sp eak USB, but also serial ap csmart and dumb v oltage-signalling as w ell! This is something that one of our users disco v ered b y acciden t. With the Custom RJ45 cable (actually a RJ45 to ser[...]

When using this cable with ap cupsd sp ecify the following in ap cupsd.conf: If y ou ha v e an OS that requires DCD or R TS to b e set b efore y ou can receiv e input, you migh t try building the standard APC Smart 940-0024C cable listed b elo w. UPSCABLE smart UPSTYPE apcsmart DEVICE /dev/ttyS0 (or whatever your serial port is) If you wish to buil[...]

CUSTOM-RJ45 CABLE Signal Computer UPS UPS DB9F RJ45-8 RJ45-10 RxD 2 ---------------- 1 2 TxD Send TxD 3 ---------------- 7 8 RxD Receive GND 5 ---------------- 6 7 Ground FG Shield ---------------- 3 4 Frame Ground The RJ45-8 pins are: looking at the end of the connector: 8 7 6 5 4 3 2 1 ___________________ | . . . . . . . . | | | -----------------[...]

V oltage-Signalling Cable for “dum b” UPSes NOTE. YOU DO NOT HA VE THIS CABLE UNLESS YOU BUIL T IT YOURSELF. THE SIMPLE-CUSTOM CABLE IS NOT AN APC PRODUCT. F or “dum b” UPSes using v oltage signalling, if you are going to build y our o wn cable, we recommend to make the cable designed b y the ap cupsd team as follo ws: SIMPLE-CUSTOM CABLE S[...]

5. Double chec k y our w ork. W e use the DTR (pin 4 on the female connector) as our +5 v olts p ow er for the circuit. It is used as the Vcc pull-up v oltage for testing the outputs on an y “UPS by APC” in v oltage-signalling mode. This cable ma y not work on a BackUPS Pro if the default communications are in ap csmart mo de. This cable is als[...]

n/c | 1 | Frame/Case Gnd (optional) | 9 | 22 Note: the <- and -> indicate the signal direction. Optional connections of original SIMPLE-CUSTOM specification that are not used. 4.7K ohm DTR 4 --[####]--* Note needed | RxD 2 ----------*--------- 3 Not used by Apcupsd When using this cable with ap cupsd sp ecify the following in ap cupsd.conf: U[...]

V oltage Signalling F eatures Supp orted by Apcupsd for V ari- ous Cables The follo wing table shows the features supported b y the curren t v ersion of ap cupsd (3.8.5 or later) for v arious cables running the UPS in v oltage- signalling mo de. Cable P o w er Loss Lo w Battery Kill P o w er Cable Discon- nected 940-0020B Y es No Y es No 940-0020C [...]

Note 2: the same as note 1 except that the line is normally closed, and opens when the line voltage fails. The Back-UPS Office 500 signals The Bac k-UPS Office UPS has a telephone type jack as output, which looks lik e the following: Looking at the end of the connector: 6 5 4 3 2 1 _____________ | . . . . . . | | | | |----------| |__| It app ears t[...]

analysis) indicates that this cable under the right conditions ma y provide the Low Battery signal. This is to b e confirmed. APC Part# - 940-0020B Signal Computer UPS DB9F DB9M CTS 8 -------------------- 2 On Battery DTR 4 -------------------- 1 Kill power GND 5 ---------------*---- 4 Ground | --- *---- 9 Common DCD 1 ----|///|----------- 5 Low B[...]

940-0023A Cable Wiring: This diagram is for informational purp oses and ma y not b e complete, w e don’t recommend that use it to build you build one yourself. This cable can only b e used on v oltage-signalling UPSes, and apparen tly only provides the On Battery signal. As a consequence, this cable is prett y m uch useless, and w e recommend tha[...]

| B | *-------| 2N3906 PNP | | C | | *----< DCD (1) Low Batt | | R 4.7k 3 | 4.7k | SHUTDOWN (1) >----------*----R4----*----< TxD (3) | | 1N4148 *----K|---------< RTS (7) Shutdown POWER-FAIL (2) >--------------------------< RxD,RI (2,9) On Batt GROUND (4,9) >--------------------------< GND (5) Operation: * DTR is "cab[...]

940-0095B Cable Wiring: This diagram is for informational purp oses and ma y not b e complete, w e don’t recommend that use it to build one yourself. APC Part# - 940-0095B Signal Computer UPS DB9F DB9M DTR 4 ----* CTS 8 ----| DSR 6 ----| DCD 1 ----* GND 5 ---------------*---- 4 Ground | *---- 9 Common RI 9 ----* | RxD 2 ----*--------------- 2 On [...]

Bac kOffice ES: The BackUPS ES has a straight through serial cable with no identification on the plugs. T o mak e it work with ap cupsd, sp ecify the UPSCABLE 940-0119A and UPSTYPE bac kups . The equiv alen t of cable 940-0119A is done on a PCB inside the unit. Thanks to William Sto ck for supplying us with the information ab out the straigh t thr[...]

The solution to the problem (thanks to T om Suzda) is to unplug the UPS and while it is still chattering, press the p ow er button (on the fron t of the unit) un til the unit b eeps and the c hattering stops. After that the UPS should b eha v e normally and p ow er down 1-2 min utes after requested to do so. An amazing discov ery b y slither man al[...]

_______________________ | . . . . . . . . . . | | | ----------------------- |____| F rom Jan Babinski jbabinsk at pulsarb eacon dot com: (many thanks) The BackUPS XS1000(BX-1000) ships with the 940-0127B usb cable and the optional 940-0128D serial cable. I’m trying to get it running under Op enBSD so usb is out of the question. I’v e tried smar[...]

(Shield)--------------------------(4)C hassis GND Cable 940-0127B USB(Computer) RJ45-10(UPS) _________ ____________ | = = = = | [ oooooooooo ] |_________| [____________] (1) (4) (10) [_] (1) +5V(1)-----------(1)+5V DATA+(2)-----------(9)DATA+ DATA-(3)-----------(10)DATA- GND(4)-----------(7)Signal GND (Shield)-----------(4)Chassis GRND Win32 Implem[...]

condition = serial port initialization cable = 0095A, 0095B, 0095C action = ioctl(TIOMBIC, RTS) clear RTS (set PnP mode) cable = 0119A, 0127A, 0128A action = ioctl(TIOMBIC, DTR) clear DTR (killpower) action = ioctl(TIOMBIS, RTS) set RTS (ready to receive) apcserial.c: condition = save_dumb_status cable = CUSTOM_SIMPLE action = ioctl(TIOMBIC, DTR) c[...]

action = ioctl(TIOMCBIS, DTR) set DTR (kills power) RS232 Wiring and Signal Conv en tions DB-25 Pin # DB-9 Pin # Name DTE-DCE Description 1 — F G – F rame Ground/Chassis GND 2 3 TD – > T ransmitted Data, TxD 3 2 RD < – Receiv ed Data, RxD 4 7 R TS – > Request T o Send 5 8 CTS < – Clear T o Send 6 6 DSR < – Data Set Read[...]

The diagram above represents the Female end of the cable. The male end is the same, but looking from inside the cable. DTE : Data Terminal Equipment (i.e. computer) DCE : Data Communications Equipment (i.e. UPS) RxD : Data received; 1 is transmitted "low", 0 as "high" TxD : Data sent; 1 is transmitted "low", 0 as "[...]

to cause premature sh utdo wns of the UPS p o w er, we str ongly recommend, esp ecially for voltage- signaling (dumb) UPSes, that y ou do most of the ini- tial testing with your computer plugged in to the wall rather than y our UPS. Th us if the UPS p ow er is suddenly sh ut off, y our computer will con tin ue to run. W e also recommend using safe[...]

• Mak e sure you are doing y our testing as ro ot otherwise, you ma y hav e p ermissions problems accessing the serial p ort. • Y ou may ha v e cabling problems, either with an incorrect cable, or the incorrect cable sp ecification directive in the configuration file. • Y ou may ha ve a problem with the /etc/ap cupsd/acpupsd.conf file. F [...]

• T ry connecting your UPS to another machine. If it w orks, then you probably ha v e a bad serial port card. As unlikely as this may sound, at least tw o of our users ha v e had to replace bad serial p ort cards. • T ry doing an lsof /dev/ttyS0 where y ou replace the /dev/ttyS0 with y our serial p ort name. If you get no output, the p ort is f[...]

Using ap ctest on Serial-Line UPSses On an apcsmart serial-line UPS, ap ctest will give y ou access to the battery of lo w-level tests w e describ ed in ap ctest. If y ou ha v e a v oltage-signalling UPS, it enables a different test repertoire which is described here, Among other things, if you are uncertain ab out what kind of cable you ha ve, y [...]

3) Test 3 - no power 4) Test 4 - low battery (requires test 3 first) 5) Test 5 - battery exhausted 6) Test 6 - kill UPS power 7) Test 7 - run tests 1 through 5 8) Guess which is the appropriate cable 9) quit Select test number: Run tests 1, 2, and 3. Note, none of the curren tly supported cables will indicate a change for test 2. Y ou can then run [...]

Exp ected ap ctest Signals for a BackUPS Pro: If y ou hav e configured your UPS as: UPSTYPE backupspro UPSCABLE APC_940_0095A or APC_940_0095C here are the t ypical signals you w ould exp ect to see in the output from the v arious tests of ap ctest: Test 1 normal: RTS not set Test 2 no serial cable: not important Test 3 no AC power: RNG Test 4 bat[...]

T esting Ap cupsd) section. One additional note applies: Bizarre Intermitten t Beha vior: In one case, a user rep orted that he received random incorrect v alues from the UPS in the status output. It turned out that gpm, the mouse control program for command windows, w as using the serial port without using the standard Unix lo cking mechanism. As [...]

damage to the UPS. T ry sending an upper case Y to the UPS (with- out a return at the end). It should respond with SM. If this is not the case, read the chapter on testing. If y ou fat finger the Y and en ter y instead, no cause for alarm, y ou will simply get the APC cop yright notice. • when y ou are sure y ou are prop erly connected send an u[...]

MAINS : LineVoltageState LASTEVNT : LastEventObserved Bac kUPS and NetUPS Simple Signals LINEFAIL : OnlineStatus BATTSTAT : BatteryStatus D A T A Logging This feature is somewhat outdated and not often used. Data logging consists of perio dically logging important data concerning the op eration of the UPS. F or the definitive definition of the fo[...]

T ec hnical Reference Configuration Directiv e Reference Configuration directives in /etc/ap cupsd/ap cupsd.conf control the b ehavior of the apcupsd daemon. F or most installations it is only necessary to set a handful of general directiv es. The rest can b e left at their defaults unless y ou hav e an exotic configuration. General Configurati[...]

qualified name or IP address of the host (NIS server) and the p ort (optional) is the p ort to use to contact the server. If y ou sp ecified UPSTYPE snmp , then the device name b ecomes hostname:v endor:comm unit y . Please see the SNMP c hapter (see Supp ort for SNMP UPSes ) in this man ual for more details. LOCKFILE < path to lo c kfile >[...]

NISPOR T < p ort > This configuration directiv e sp ecifies the p ort to b e used by the ap cupsd Netw ork Information Serv er. The default is platform dep endent, but t ypically 3551, which w e ha v e received from IANA as the official ap cupsd netw orking p ort. If y ou c hange this p ort, you m ust manually c hange the #define SER V TCP[...]

and means that the default v alues do not generate annoy messages: KES). Note that if NOLOGON is set to disable the annoy messages will also b e disabled. ANNO YDELA Y < time in seconds > Sp ecify delay time in seconds b efore ap cupsd b egins requesting logged in users to get off the system during a p ow er failure. This timer starts only a[...]

min utes sp ecifies that ap cupsd should prohibit logins when the re- maining run time in min utes reaches 110% or less than the v alue sp ecified on the MINUTES configuration directive. Thus if MINUTES is set to 3, ap cupsd will prohibit logins when the remaining runtime is less than 3 min utes (3 X 110% = 3). alw a ys causes ap cupsd to immedi[...]

the slav es to p erform a sh utdo wn then ap cupsd will sleep for 30 sec- onds b efore issuing the shutdo wn of its o wn computer. If y ou need the master to wait additional time b efore shutting do wn (to allo w for sh utdo wn of slow er sla v es or of sla ves running soft w are that requires more time to shutdo wn – e.g. databases), y ou can do[...]

the Data (see DA T A Logging ) section of this manual for additional details. F A CILITY < log-facility > The facilit y directive can b e used to c hange the system logging class or facility . The default is D AEMON . This parameter can b e useful if y ou wish to direct the ap cupsd system logging information to other than your system default[...]

where there are no other computers dep endent on pow er from the same UPS. This is the normal case. Use netmaster , if and only if you ha v e a serial p ort connection to the UPS and there are other mac hines deriving p o w er from the same UPS. This is required in all master configuration files. Use netsla v e if and only if you ha ve no serial [...]

MASTER < name of the master > for sla v e mac hines. Used in sla v e configuration files, this is the netw ork name of the master whic h is authorized to send commands to this slav e. In all cases (of which I am a w are), when y ou specify a MASTER directiv e, y ou will also sp ecify UPSCABLE ether since y our information ab out the UPS wil[...]

SLA VE directiv es b e put in y our /etc/hosts file so that ap cupsd will b e able to resolve the machine name during startup and shutdo wn ev en if DNS is not running. Alternatively , you can use IP addresses on the MASTER and SLA VE directiv es, but this is less flexible. USERMA GIC < user defined magic > used only in SLA VE config- ura[...]

Under normal apcupsd op erations (no --configure option), ap cupsd will read the v alue stored in the UPS and displa y it in the ST A TUS output. W AKEUP < set w akeup dela y > The UPS p o w er restart delay v alue in [0,60,180,300] in seconds after the UPS has shut do wn during a p ow er failure. This is to preven t the p o w er from coming [...]

RETURNCHAR GE < min. batt. c harge lev el > This parameter sp ecifies what battery p ercentage c harge is necessary b efore the UPS will supply pow er to your equipmen t after a p ow er do wn. Differ- en t v alues are p ermitted based on the UPS mo del, classification, and man ufacture date. Use apcaccess eeprom to show y ou whic h v alues[...]

Status logging consists of perio dically logging ALL a v ailable information concerning the UPS. Since the v olume of data is rather large (o v er 1000 b ytes p er status), the ST A TUS data is not automatically sen t to the system log file, instead, it is written as a series of data records to a specific file (normally /etc/ap cupsd/ap cupsd.st[...]

MODEL : SMART-UPS 1000 UPSMODE : Stand Alone STARTTIME: Wed Sep 27 10:39:23 CEST 2000 UPSNAME : UPS_IDEN STATUS : ONLINE LINEV : 235.3 Volts LOADPCT : 9.3 Percent Load Capacity BCHARGE : 100.0 Percent TIMELEFT : 130.0 Minutes MBATTCHG : 5 Percent MINTIMEL : 3 Minutes MAXTIME : 0 Seconds MAXLINEV : 239.2 Volts MINLINEV : 234.0 Volts OUTPUTV : 236.6 [...]

Status Rep ort Fields The meaning of the ab ov e v ariables are: APC is the header record indicating the ST A TUS format revision lev el, the n um b er of records that follo w the APC statement, and the num b er of b ytes that follo w the record. D A TE is the date and time that the information w as last obtained from the UPS. HOSTNAME is the name [...]

MAXLINEV is the maximum line voltage since the last ST A TUS as returned b y the UPS. MINLINEV is the minimum line v oltage since the last ST A TUS as re- turned b y the UPS. OUTPUTV is the voltage the UPS is supplying to your equipmen t. SENSE is the sensitivit y level of the UPS to line v oltage fluctuations. D W AKE is the amoun t of time the U[...]

X OFFBA TT time and date of last transfer from batteries, or N/A. SELFTEST is the results of the last self test, and ma y hav e the follo wing v alues: OK - self test indicates goo d battery BT - self test failed due to insufficien t battery capacit y NG - self test failed due to o verload NO - No results (i.e. no self test p erformed in the last 5[...]

Logging the ST A TUS Information If specified in the configuration file, the ST A TUS data will also b e written to the system log file. Please note, that it would not normally b e wise to write this data to a normal system log file as there is no mec hanism in syslog() to rewind the file and hence the log file w ould quic kly b ecome enormo[...]

sh utdo wn(8) command. Y ou can mo dify the b ehavior b y editing the /etc/ap cupsd/ap ccon trol script, but doing so will make it more com- plicated to upgrade to the next ap cupsd version. The conditions that trigger the sh utdo wn can b e: running time on batteries hav e expired (TIMEOUT), the battery run time remaining is b elow the configured[...]

This final step is imp ortan t if you w an t to ensure that y our system will automatically rebo ot when the p ow er comes bac k on. The actual co de used on the Red Hat v ersion is: # See if this is a powerfail situation. # ***apcupsd*** if [ -f /etc/apcupsd/powerfail ]; then # ***apcupsd*** echo # ***apcupsd*** echo "APCUPSD will now power [...]

The output should lo ok something lik e the following: apcaccess eeprom Valid EPROM values for the SMART-UPS 1000 Config Current Permitted Description Directive Value Values ====================================== ============= ============= === Upper transfer voltage HITRANSFER 253 253 264 271 280 Lower transfer voltage LOTRANSFER 196 196 188 208 2[...]

Configuration section of this manual for more information. See the EEP- R OM (see Configuring Y our EEPROM) of this man ual for further details on ho w to change these EPROM v alues. Sh utdo wn Problems Ob viously if y our halt script is not prop erly mo dified, ap cupsd will not be able to shut off the p ow er to the UPS, and if the p o w er r[...]

Startup Normally , ap cupsd is automatically started when your system is rebo oted. This normally o ccurs because the startup script ap cupsd is linked into the appropriate places in /etc/rc.d. On most Linux systems, there is a program called chk config(8) that will automatically link the startup script. This program is inv ok ed by the make insta[...]

and information graciously supplied b y APC. Hop efully , the additions made herein can b enefit the original author and his programming pro ject, and ma yb e some day , the ap cupsd pro ject and the NUT pro ject can join forces. Description Here’s the information on the elusive APC smart signaling proto col used b y their higher end units (Back[...]

diagram are used to keep Po w erCh ute happ y b y allo wing cable detection. If y ou use the NUT ap csmart driv er, those pins don’t matter. Man y thanks to Steve Drap er for pro viding this scan. F or additional information on cables, see the section on custom cables (see Cables) in this manual. The Smart Proto col Despite the lack of official i[...]

E Automatic self test interv als Default = 336 (336 hours = 14 da ys) (336=14 days, 168=7 da ys, ON=p o w er on, OFF=nev er) F Line frequency , Hz 60.00 (50.0 in Europe) G Cause of transfer R = unacceptable utility voltage rate of change, H = high utilit y v oltage, L = lo w utility v oltage, T = line v oltage notc h or spik e, O = no transfers yet[...]

X Results of last self test “OK” - go o d battery , “BT” - failed due to insufficient capac- it y , “NG” - failed due to ov erload, “NO” - no results av ailable (no test p erformed in last 5 minutes) Y Enter smart mode “SM” Z—Z Shutdo wn immediately (no dela y) - need > 1.5s b etw een first and sec- ond Z N/A a Show protoc[...]

p Sh utdo wn grace delay , seconds Default “020” (020/180/300/600) q Lo w battery w arning, min utes Default “02” r W ak eup delay (time) - seconds Default “000” (000/060/180/300) s Sensitivit y “H” - highest, “M” - medium, “L” - lo w est, “A” - autoadjust (Matrix only) u Upp er transfer v oltage Default “132” or “[...]

7 Dip switch positions (if applica- ble) See b elo w 8 Register #3 See b elo w 9 Line quality “FF” acceptable, “00” unaccept- able > Num b er of external battery pac ks attac hed SmartCell mo dels: “nnn” where nnn is how man y external packs are connected Non-SmartCell units: whatever has b een set with > + and > - by the user [...]

Dip switch info Bit Switc h Option when bit=1 0 4 Lo w battery alarm c hanged from 2 to 5 mins. Autostartup disabled on SU370ci and 400 1 3 Audible alarm delay ed 30 seconds 2 2 Output transfer set to 115 V AC (from 120 V A C) or to 240 V AC (from 230 V AC) 3 1 UPS desensitized - input voltage range expanded 4-7 - Un used at this time Status bits T[...]

Alert messages These single c haracter messages are sent b y the UPS an y time there is an Alert condition. All other resp onses indicated abov e are sent b y the UPS only in resp onse to a query or action command. Character Description ! Line F ail - sent when the UPS go es on-battery , rep eated every 30 seconds un til low battery condition reach[...]

Register 1 All bits are v alid on the Matrix UPS. SmartUPS mo dels only support bits 6 and 7. Other mo dels do not resp ond. Bit Hex Bit Meaning 0 0x01 In w ak eup mo de (t ypically lasts < 2s) 1 0x02 In bypass mo de due to in ternal fault - see register 2 or 3 2 0x04 Going to b ypass mo de due to command 3 0x08 In bypass mo de due to command 4 [...]

= messages. Bit Meaning 0 Output unp o w ered due to sh utdo wn b y low battery 1 Unable to transfer to battery due to o v erload 2 Main relay malfunction - UPS turned off 3 In sleep mo de from @ (maybe others) 4 In sh utdo wn mo de from S 5 Battery charger failure 6 Bypass relay malfunction 7 Normal op erating temp erature exceeded In terpretatio[...]

I == International 230 Volts A == Asia ?? 100 Volts J == Japan ?? 100 Volts In terpretation of the New Firmw are Revision New Firmware revison and model ID String in NN.M.L is the format where NN == UPS ID Code. 12 == Back-UPS Pro 650 13 == Back-UPS Pro 1000 52 == Smart-UPS 700 60 == SmartUPS 1000 72 == Smart-UPS 1400 where NN now Nn has possible m[...]

It lo oks bizarre and ugly , but is easily parsed. The # is some kind of mark er/iden t character. Skip it. The rest fits this form: • Command c haracter - use this to select the v alue • Lo cale - use ’b’ to find out what yours is (the last c haracter), ’4’ applies to all • Num b er of choices - ’4’ means there are 4 p ossibili[...]

DFO == (4)-all-countries (D)omestic (I)nternational (A)sia (J)apan (M) North America - servers. RSP == Total number possible answers returned by a given CMD. FSZ == Max. number of field positions to be filled. FVL == Values that are returned and legal. Programming the UPS EEPROM There are at this time a maxim um of 12 different v alues that can b [...]

Ac kno wledgemen ts The ap cupsd has a rather long and tormen ted history . Many thanks to the guys that, with time, contributed to the general public knowledge. P a v el Korensky < pav elk at dator3.anet.cz > , Andre M. Hedric k < hedrick at suse.de > , Christopher J. Reimer < reimer at doe.carleton.ca > , Kevin D. Smolk o wski &[...]

rpmbuild -ba --define "build_rh7 1" apcupsd.spec rpmbuild --rebuild --define build_rh7 1" apcupsd-x.x.x-x.src.rpm Ho w do I control whether usb supp ort gets built? By default stan- dard serial p ort supp ort will b e built and the ap cupsd-std pack age will b e pro duced. T o get the usb pac k age and supp ort either set the %define[...]

in y our home directory (or edit the file if it already exists) and add the follo wing line: %_topdir /home/myuser/redhat Credits The success of ap cupsd is due to the many p eople that help ed in dev elop- men t, testing and in many other w a ys. Thank all the developers that w orked hard to make APCUPSDone of the b est piece of softw are for UPS[...]

Caldera: John Pinner (john at clo cksoft.com) HP-UX P ort Carl Erhorn (Carl Erhorn at hyperion.com) Rob ert K Nelson (rnelson at airflowsciences.com) SOLARIS P ort: Carl Erhorn (Carl Erhorn at hyperion.com) Op enBSD P ort: Devin Reade (gdr at gno.org) NetBSD P ort: Neil Darlow (neil at darlo w.co.uk) Win32 P ort: Kern Sibbald (kern at sibbald dot [...]

Pro ject Discussions: APCUPSD Mailing List Thanks to American Po w er Con version (APC) who help ed in giving tec hni- cal information on their UPSes. A sp ecial thanks to APC who gav e me (Riccardo) a Smart UPS1400 INET when m y old Bac k UPS v/s 650’s battery died. Thank you guys, your help has b een in v aluable. Thanks to all the users that s[...]

ENTIRE RISK AS TO THE QUALITY AND PERF ORMANCE OF THE PR OGRAM IS WITH YOU. SHOULD THE PR OGRAM PR O VE DEFEC- TIVE, YOU ASSUME THE COST OF ALL NECESSAR Y SER VICING, REP AIR OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LA W OR A GREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER P AR TY WHO MA Y MODIFY AND/OR REDISTRIBUTE THE [...]

# CONFIG_USB_BLUETOOTH_TTY is not set # CONFIG_USB_ACM is not set # CONFIG_USB_PRINTER is not set CONFIG_USB_STORAGE=m # CONFIG_USB_STORAGE_DEBUG is not set # CONFIG_USB_STORAGE_DATAFAB is not set # CONFIG_USB_STORAGE_FREECOM is not set # CONFIG_USB_STORAGE_ISD200 is not set # CONFIG_USB_STORAGE_DPCM is not set # CONFIG_USB_STORAGE_HP8200e is not s[...]

# CONFIG_USB_CATC is not set # CONFIG_USB_KAWETH is not set # CONFIG_USB_PEGASUS is not set # CONFIG_USB_RTL8150 is not set # CONFIG_USB_USBNET is not set # # USB port drivers # # CONFIG_USB_USS720 is not set # # USB Serial Converter support # # CONFIG_USB_SERIAL is not set # # USB Miscellaneous drivers # # CONFIG_USB_EMI62 is not set # CONFIG_USB_[...]

An alternative and more permanent method would be to add none /proc/bus/usb usbfs defaults 0 0 to /etc/fstab. This will mount usbfs at each reboot. You can then issue ‘cat /proc/bus/usb/devices‘ to extract USB device information, and user mode drivers can use usbfs to interact with USB devices. There are a number of mount options supported by u[...]

THE /proc/bus/usb/drivers FILE: ------------------------------- Each of the USB device drivers linked into your kernel (statically, or dynamically using "modprobe") is listed in the "drivers" file. Here’s an example from one system: usbdevfs hub 0- 15: usblp usbnet serial usb-storage pegasus If you see this file, "usbdevf[...]

d = decimal number (may have leading spaces or 0’s) x = hexadecimal number (may have leading spaces or 0’s) s = string Topology info: T: Bus=dd Lev=dd Prnt=dd Port=dd Cnt=dd Dev#=ddd Spd=ddd MxCh=dd | | | | | | | | |__MaxChildren | | | | | | | |__Device Speed in Mbps | | | | | | |__DeviceNumber | | | | | |__Count of devices at this level | | | [...]

| | |__DeviceClass | |__Device USB version |__Device info tag #1 where P: Vendor=xxxx ProdID=xxxx Rev=xx.xx | | | |__Product revision number | | |__Product ID code | |__Vendor ID code |__Device info tag #2 String descriptor info: S: Manufacturer=ssss | |__Manufacturer of this device as read from the device. | For USB host controller drivers (virtua[...]

interface serves a distinct "function", which is typically bound to a different USB device driver. One common example is a USB speaker with an audio interface for playback, and a HID interface for use with software volume control. Interface descriptor info (can be multiple per Config): I: If#=dd Alt=dd #EPs=dd Cls=xx(sssss) Sub=xx Prot=xx[...]

If a user or script is interested only in Topology info, for example, use something like "grep ^T: /proc/bus/usb/devices" for only the Topology lines. A command like "grep -i ^[tdp]: /proc/bus/usb/devices" can be used to list only the lines that begin with the characters in square brackets, where the valid characters are TDPCIE.[...]

S: Product=Peracom USB to Serial Converter C:* #Ifs= 1 Cfg#= 1 Atr=a0 MxPwr=100mA I: If#= 0 Alt= 0 #EPs= 3 Cls=00(>ifc ) Sub=00 Prot=00 Driver=serial E: Ad=81(I) Atr=02(Bulk) MxPS= 64 Ivl= 16ms E: Ad=01(O) Atr=02(Bulk) MxPS= 16 Ivl= 16ms E: Ad=82(I) Atr=03(Int.) MxPS= 8 Ivl= 8ms Selecting only the "T:" and "I:" lines from thi[...]

### END ### In terpretation of /pro c/bus/usb info on 2.6 k ernels: /proc/bus/usb filesystem output =============================== (version 2003.05.30) The usbfs filesystem for USB devices is traditionally mounted at /proc/bus/usb. It provides the /proc/bus/usb/devices file, as well as the /proc/bus/usb/BBB/DDD files. **NOTE**: If /proc/bus/usb ap[...]

or USB cable), so a device might be 002/027 when you first connect it and 002/048 sometime later. These files can be read as binary data. The binary data consists of first the device descriptor, then the descriptors for each configuration of the device. That information is also shown in text form by the /proc/bus/usb/devices file, described later. [...]

x = hexadecimal number (may have leading spaces or 0’s) s = string Topology info: T: Bus=dd Lev=dd Prnt=dd Port=dd Cnt=dd Dev#=ddd Spd=ddd MxCh=dd | | | | | | | | |__MaxChildren | | | | | | | |__Device Speed in Mbps | | | | | | |__DeviceNumber | | | | | |__Count of devices at this level | | | | |__Connector/Port on Parent for this device | | | |_[...]

| |__Device USB version |__Device info tag #1 where P: Vendor=xxxx ProdID=xxxx Rev=xx.xx | | | |__Product revision number | | |__Product ID code | |__Vendor ID code |__Device info tag #2 String descriptor info: S: Manufacturer=ssss | |__Manufacturer of this device as read from the device. | For USB host controller drivers (virtual root hubs) this m[...]

to a different USB device driver. One common example is a USB speaker with an audio interface for playback, and a HID interface for use with software volume control. Interface descriptor info (can be multiple per Config): I: If#=dd Alt=dd #EPs=dd Cls=xx(sssss) Sub=xx Prot=xx Driver=ssss | | | | | | | |__Driver name | | | | | | | or "(none)&quo[...]

If a user or script is interested only in Topology info, for example, use something like "grep ^T: /proc/bus/usb/devices" for only the Topology lines. A command like "grep -i ^[tdp]: /proc/bus/usb/devices" can be used to list only the lines that begin with the characters in square brackets, where the valid characters are TDPCIE.[...]

C:* #Ifs= 1 Cfg#= 1 Atr=a0 MxPwr=100mA I: If#= 0 Alt= 0 #EPs= 3 Cls=00(>ifc ) Sub=00 Prot=00 Driver=serial E: Ad=81(I) Atr=02(Bulk) MxPS= 64 Ivl= 16ms E: Ad=01(O) Atr=02(Bulk) MxPS= 16 Ivl= 16ms E: Ad=82(I) Atr=03(Int.) MxPS= 8 Ivl= 8ms Selecting only the "T:" and "I:" lines from this (for example, by using "procusb ti&q[...]

### END ### 222[...]

Index /ab out , 129 /ev en ts , 129 /help , 129 /install , 129 /kill , 129 /remo v e , 129 /run , 129 /service , 129 /servicehelp er , 129 /status , 129 —disable-install-distdir , 33 —enable-ap csmart , 31 —enable-cgi , 31 —enable-dum b , 31 —enable-master-sla v e , 31 —enable-net , 31 —enable-nis , 32 —enable-p o w erflute , 31 ?[...]

Ap ctest , 63 Ap cupsd Building and Installing , 26, 109 T esting , 53 Ap cupsd Bugs , 96 Ap cupsd Kno wn USB Issues , 15 Ap cupsd Net w ork Monitoring (CGI) Programs , 71 Ap cupsd Notification and Even ts , 70 Ap cupsd Status Logging , 170 Ap cupsd Supp ort and Knowledge Base: , 198 Ap cupsd System Logging , 113 Ap cupsd User’s Man ual , 6 Ap c[...]

Once y ou ha v e established se- rial , 155 T roublesho oting Serial Line , 155 Comm unications T est , 58 Compilers and Options , 34 Config Kernel , 200 Configuration Simple Master , 49 Simple Sla v e , 50 Simple USB , 47 V ariation on the Master/Slav e , 51 Configuration , 106 Configuration Directiv e Reference , 159 Configuration Directiv e[...]

Disclaimer: NO W ARRANTY , 199 Discon ten ts Sh uto wn Sequence and its , 176 Distribution Main tainers: , 198 DLO WBA TT , 174 doreb o ot , 98 dosh utdo wn , 98 Driv er Sample NIS Slav e Configura- tion Using the Net , 51 DSHUTD , 174 Dum b Simple Configuration for a Simple Signaling or , 49 dum b , 12 D W AKE , 174 EEPR OM Configuring Y our , [...]

Determining Which V oltage- Signaling Cable Y ou , 155 Hid-ups and USB Sp ecific Infor- mation , 71 HITRANS , 174 HITRANSFER < upp er limit of ups batt. transfer > , 169 HOSTNAME , 173 Ho w do I build Ap cupsd for plat- form xxx? , 195 Ho w do I control whether usb sup- p ort gets built? , 196 Ho w T o Use This Man ual , 9 HP-UX P ort , 198 [...]

Con trolling Multiple UPSes on one , 106 mainsbac k , 98 Main taining Y our UPS , 82 Making sure ap cupsd Is Running , 46 MAND A TE , 175 Man ual Ap cupsd User’s , 6 Ho w T o Use This , 9 MASTER < name of the master > for sla v e machines. , 167 Master/Sla v e Configurations , 100 Master/Sla v e Problems , 101 Master/Sla v e Shutdo wn , 18[...]

p ercen t , 162 Pin Assignmen t for the Serial P ort (RS-232C), 25-pin and 9- pin, F emale End , 148 Planning Y our Installation , 9 P ort Connecting a APC USB UPS to either a PC USB or Se- rial , 131 Connecting a Serial-Line UPS to a USB , 130 P ost Installation , 124 P o w er Down During Shutdo wn , 128 p o w ered , 97 p o w erout , 99 Problem Ar[...]

SENSITIVITY < sets sensitivit y lev el > , 168 Sequence Sh utdo wn , 63, 176 Serial Comm unications: , 197 SERIALNO , 175 Serv er Alternate W a ys T o Run The Net w ork Information , 110 Configuration Directiv es Used b y the Netw ork Informa- tion , 160 Setting up and T esting the CGI Programs , 71 Sh utdo wn Master/Sla v e , 180 P o w er D[...]

Supp orted Op erating Systems, UPSes and Cables , 11 Supp orts Other APC Cables that ap cupsd , 136 System Shutdo wn T est , 61 Systems Recommended Options for most , 33 TCP W rapp ers , 78 T ec hnical Reference , 159 T est ap caccess , 55 Comm unications , 58 F ull P o w er Down , 62 Logging , 55 Pro cess-Status , 53 Sim ulated P o w er F ail , 59[...]

EEPR OM , 192 V ariation on the Master/Sla v e Configuration , 51 V erifying a Source Installation , 28 V ersion Command Line Options Sp e- cific to the Windo ws , 129 V oltage Signalling , 137 V oltage Signalling F eatures Sup- p orted by Ap cupsd for V arious Cables , 137 V oltage-Signalling Cable for dumb UPSes , 134 W AKEUP < set wak eup d[...]