Summary of the content on the page No. 1
Apcupsd is a UPS control system that permits orderly
shutdown of your computer in the event of a power failure.
Kern Sibbald
April 3, 2005
This manual documents apcupsd version 3.10.17
Copyright (C) 1999-2005 Kern Sibbald
Summary of the content on the page No. 2
Copying and distribution of this le, with or without modi cation, are per- mitted in any medium without royalty provided the name Apcupsd, the copyright notice, and this notice are preserved. Apcupsd source code is released under the GNU General Public License version 2. Please see the le COPYING in the main source directory. For more information on the project, please visit the main web site at http://www.apcupsd.com 1
Summary of the content on the page No. 3
Contents Apcupsd User's Manual . . . . . . . . . . . . . . . . . . . . . . . . 6 Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 New Features . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 How To Use This Manual . . . . . . . . . . . . . . . . . . . . . . . 9 Basic User's Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Planning Your Installation . . . . . . . . . . . . . . . . . . . . . . . 9 Quick Start for Beginners . . . . . . . . . . . . . .
Summary of the content on the page No. 4
Checking Your Con guration File . . . . . . . . . . . . . . . . 44 Arranging for Reboot on Power-Up . . . . . . . . . . . . . . . 45 Making sure apcupsd Is Running . . . . . . . . . . . . . . . . 46 Con guration Examples . . . . . . . . . . . . . . . . . . . . . . . . 47 Simple USB Con guration . . . . . . . . . . . . . . . . . . . . 47 Simple Con guration for a SmartUPS . . . . . . . . . . . . . 48 Simple Con guration for a Simple Signaling or Dumb . . . . 49 Simple Master Con guration . . . .
Summary of the content on the page No. 5
Apcupsd Noti cation and Events . . . . . . . . . . . . . . . . 70 hid-ups and USB Speci c Information . . . . . . . . . . . . . 71 apcupsd Network Monitoring (CGI) Programs . . . . . . . . . 71 Setting up and Testing the CGI Programs . . . . . . . . . . . 71 Con guring Your EEPROM . . . . . . . . . . . . . . . . . . . 79 Maintaining Your UPS . . . . . . . . . . . . . . . . . . . . . . . . . 82 What Various People Have to Say about Batteries . . . . . . 83 Where Carl Suggests You Get Batteries .
Summary of the content on the page No. 6
Running the server as a child of apcupsd . . . . . . . . . . . . 110 Running apcnisd from INETD . . . . . . . . . . . . . . . . . 111 Running apcnisd Standalome . . . . . . . . . . . . . . . . . . 112 apcupsd System Logging . . . . . . . . . . . . . . . . . . . . . . . . 113 Logging Types . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Implementation Details . . . . . . . . . . . . . . . . . . . . . 114 Developers Notes . . . . . . . . . . . . . . . . . . . . . . . . . 115 Installation:
Summary of the content on the page No. 7
Connecting a APC USB UPS to either a PC USB or Serial Port . 131 Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Smart-Custom Cable for SmartUPSes . . . . . . . . . . . . . 131 Smart Signalling Cable for BackUPS CS Models . . . . . . . 132 Voltage-Signalling Cable for "dumb" UPSes . . . . . . . . . . 134 Other APC Cables that apcupsd Supports . . . . . . . . . . . 136 Voltage Signalling Features Supported by Apcupsd for Various Cables137 Voltage Signalling . . . .
Summary of the content on the page No. 8
Con guration Directive Reference . . . . . . . . . . . . . . . . . . . 159 General Con guration Directives . . . . . . . . . . . . . . . . 159 Con guration Directives Used by the Network Information Server160 Con guration Directives used during Power Failures . . . . . 161 Con guration Directives used to Control System Logging . . 164 Con guration Directives for Sharing a UPS . . . . . . . . . . 165 Con guration Directives Used to Set the UPS EPROM . . . 168 apcupsd Status Logging . . . . . . .
Summary of the content on the page No. 9
Alert messages . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Register 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Register 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Register 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Interpretation of the Old Firmware Revision . . . . . . . . . . 191 Interpretation of the New Firmware Revision . . . . . . . . . 192 EEPROM Values . . . . . . . . . . . . . . . . . . . . . . . . . 192 Programm
Summary of the content on the page No. 10
List of Figures Multimon Main Page . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Multimon Statistics Display . . . . . . . . . . . . . . . . . . . . . . 74 Windows Install - Explorer Window . . . . . . . . . . . . . . . . . 116 Windows Install - Winzip Unpack . . . . . . . . . . . . . . . . . . 117 Windows Install - Winzip Extract Window . . . . . . . . . . . . . 117 Windows Install - Setup Complete . . . . . . . . . . . . . . . . . . 119 Windows NT - Start Service . . . . . . . . . . .
Summary of the content on the page No. 11
List of Tables Supported UPS Models . . . . . . . . . . . . . . . . . . . . . . . . 13 Supported Features . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 RS232 Wiring and Signal Conventions . . . . . . . . . . . . . . . . 148 Single Character Commands . . . . . . . . . . . . . . . . . . . . . 183 DIP Switch Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 UPS Status Bits . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Alert Messages . . . . . . . . . . . . .
Summary of the content on the page No. 12
Apcupsd User's Manual Release Notes This release contains a good number of cleanups and bug xes to prior 3.10.x versions, and is intended to be the ocial release. See the ChangeLog below for more details. New Features - Implement USB on all *BSD systems. Note, the kernel drivers on most of these systems are still fragile. There are known problems, for example, on FreeBSD. - Fix killpower on USB UPSes to properly turn off UPS. - More killpower fixes for BackUPS Pros. - Fix killpower sequence fo
Summary of the content on the page No. 13
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 patch to fix aastr... supplied by Manfred Schwarb. - Changed Solaris to use mailx by default at the suggestion of Neil Brookins. - Added Adam's snoopdecode.c
Summary of the content on the page No. 14
- 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() and astrncat()s as I could find. There still remain some drivers and the cgi code to do. - Implemented true/false and bool. Started implementing it in
Summary of the content on the page No. 15
How To Use This Manual This is the manual for apcupsd, a daemon for communicating with UPSes (Uninterruptible Power Supplies) made by American Power Corporation (APC). If you have an APC-made UPS, whether sold under the APC name- plate or OEMed (The HP PowerTrust 2997A UPS has been tested as a \smartups" with cable Hewlett Packard part number 5061-2575 equivalent to a custom-smart cable), and you want you get it working with a computer running Linux, Unix, or Windows NT, you are reading the righ
Summary of the content on the page No. 16
1. First, check to see if apcupsd supports your UPS and operating system (see Supported Operating Systems; UPSes and Cables). 2. Second, plan your con guration type (see Choosing a Con guration Type). If you have just one UPS and one computer, this is easy. If you have more than one machine being served by the same UPS, or more than one UPS supplying power to computers that are on the same local network, you have more choices to make. 3. Third, gure out if you have one of the easy setups. If yo
Summary of the content on the page No. 17
9. To verify that your UPS is communicating with your computer and will do the right thing when the power goes out, read and follow the instructions in the Testing (see Testing Apcupsd) section. 10. If you run into problems, read the Troubleshooting (see Troubleshooting Your Installation) section of this manual. 11. If you still need help, send a message to the developer's email list apcupsd-users at lists.sourceforge.net describing your problem, what version of apcupsd you are using, what opera
Summary of the content on the page No. 18
We'll describe the possible values here, because they're a good way to ex- plain your UPS's single most important interface property { the kind of protocol it uses to talk with its computer. apcsmart An APCSmart UPS and its computer also communicate through an RS232C serial connection, but they actually use it as a character channel (2400bps, 8 data bits, 1 stop bit, no parity) and pass commands back and forth in a primitive language (see APC smart protocol) resembling modem-control codes. The d
Summary of the content on the page No. 19
of the models, particularly USB enabled models, can be run in multiple modes, so they may appear more than once in the table. APC is putting out new models at a furious rate, and so it is very likely that your model is not listed in the table. If it is USB enabled, it will probably work in USB mode. Please note that some of these new models are extremely inexpensive, so they are stripped down versions of more expensive units, and as such they do not o er as many features, so some of the example
Summary of the content on the page No. 20
BackUPS CS usb usb (note: Supported in version>=3.9.8 USB, Pro using APC USB, ES USB, cables 940- RS/XS 1000, 0127A/B/C) RS/XS 1500, and probably other USB models SmartUPS usb usb (note: us- Supported, version >=3.9.8 USB, Back- ing APC cable, UPS Oce no number) USB, and any other USB UPS All SNMP- snmp ether Supported capable models BackUPS dumb simple (note: Supported using Simple- Custom (This cable is not an APC product. You have to build it your- self using the instructions in Cables.), 94
