Apc UPS control system User Manual

Browse online or download User Manual for Tools Apc UPS control system. APC UPS control system User Manual

  • Download
  • Add to my manuals
  • Print
  • Page
    / 233
  • Table of contents
  • BOOKMARKS
  • Rated. / 5. Based on customer reviews

Summary of Contents

Page 1 - April 3, 2005

Apcupsd is a UPS control system that permits orderlyshutdown of your computer in the event of a power failure.Kern SibbaldApril 3, 2005This manual doc

Page 2

List of FiguresMultimon Main Page . . . . . . . . . . . . . . . . . . . . . . . . . . 74Multimon Statistics Display . . . . . . . . . . . . . . . . .

Page 3 - Contents

slave that is sufficiently short that you are sure that the slave willshutdown before the master. If the shutdown is done with a poweroff,this will also

Page 4

Q: When using USB, I get the following log messages: usb-uhci.c: inter-rupt, status 3, frame# 826. What does it mean?A: It means one transfer worked (

Page 5

Apcupsd BugsUnfortunately, it seems that every program has some bugs. We do our bestto keep the bugs to a minimum by extensive testing. However, becau

Page 6

want to send an email message to root. At present the arguments thatapccontrol recognizes are:When apcupsd detects an event, it calls the apccontrol s

Page 7

commfailure This event is generated each time the communications linewith the computer is severed. This event is not detected on dumbsignaling UPSes.D

Page 8

onbattery This event is generated 5 or 6 seconds after an initial pow-erfailure is detected. It means that apcupsd definitely considers theUPS to be on

Page 9

Does a printf ‘‘UPS battery runtime limit exceeded. Doingshutdown.\n’’ | wall then exits. After completing this event,apcupsd will immediately initiat

Page 10 - List of Figures

port), which is called the master, can provide information to other machinespowered by the UPS, called slaves. When the master detects a power failure

Page 11 - List of Tables

networking is considerably different from the old method described at thebeginning of this chapter. In the old code, there is a lot of configuration onb

Page 12 - Release Notes

Network Problems with Master/Slave or Server/Slave Con-figurationsWhen working with a master/slave or server/slave configurations (one UPSpowering more

Page 13 - Change Log for older versions

List of TablesSupported UPS Models . . . . . . . . . . . . . . . . . . . . . . . . 13Supported Features . . . . . . . . . . . . . . . . . . . . . . .

Page 14

same. Please be sure you are running the same version of apcupsd on allyour master and slave machines.to slave SSS failedThis message is logged when t

Page 15 - Planning Your Installation

attempt from master MMMThe master named MMM (probably an IP address) contacted the slave butMMM is not the master that was listed on the MASTER configu

Page 16

Controlling Multiple UPSes on one MachineYou may want to use your server to control multiple UPSes. This is possibleby proper configuration and by runn

Page 17

./configure \--prefix=$HOME/apcupsd/bin \--sbindir=$HOME/apcupsd/bin \--enable-cgi \--with-cgi-bin=$HOME/apcupsd/bin \--with-log-dir=$HOME/apcupsd/bin

Page 18

a serial port card for it, or perhaps use a USB UPS. To ensure that it isproperly shutdown if Computer A goes down, you could run a second copy ofapcu

Page 19

• The read-write community string, usually it is “private” for read-writeaccess.Building and Installing apcupsdFollow the instructions in Building and

Page 20

parameter to 180 seconds or more, depending on how much time yoursystem shutdown requires to umount all the filesystems.• Change /etc/rc.d/apcupsd scri

Page 21 - Apcupsd Known USB Issues

be necessary if you use the default apcupsd.conf, since it is already turnedon.Although this method is simple, it affords no protection from the outsid

Page 22

Next, you must modify /etc/inetd.conf to have the following line:apcnisd stream tcp nowait root /usr/sbin/tcpd /sbin/apcnisd -iIf you do not want to r

Page 23

/sbin/apcnisdThe advantage of running the network information server standalone is thatif for some reason, a client causes the network server to crash

Page 24

Apcupsd User’s ManualRelease NotesThis release contains a good number of cleanups and bug fixes to prior 3.10.xversions, and is intended to be the offici

Page 25

For more details on STATUS logging, see the Status (seeapcupsd Status Logging) section of the Technical Reference.LoggingEvents logging consists of lo

Page 26

More work needs to be done to the code to ensure that it corresponds to theabove levels.As a practical example of how to setup your syslog() to use th

Page 27

Installation: WindowsThe Windows Version of apcupsdThe Windows version of apcupsd has been tested on Win95, Win98, WinMe,WinNT, WinXP, and Win2000 sys

Page 28

• When Zip says that it has one file and asks if it should unpack it intoa temporary file, respond with Yes.• Ensure that you extract all files and that

Page 29

If you wish to install the package elsewhere, please note that you will needto proceed with a manual installation, which is not particularly easy as y

Page 30

multi(0)disk(0)rdisk(0)partition(1)\WINNT=“Windows NT Work-station Version 4.00”and add the following to the end of the line: /NoSerialMice:COM1 (orCO

Page 31

What is important to verify in the DOS window is that the root di-rectory \ is mounted on device c:\.The DOS window will be followed immediately by a

Page 32

If the Services dialog reports a problem, it is normally because yourDEVICE statement does not contain the correct serial port name.You probably shoul

Page 33 - Installation from Source

charged, the plug icon will become a plug with a lightning bolt in the middleto indicate that the battery is charging.Installation DirectoryThe Win32

Page 34

running version of apcupsd, through the Services dialogue in the ControlPanel, first click on the Stop button:then click on the Startup ... button, and

Page 35

page.Change Log for older versions----> Release 3.10.16 04Nov04- Adam has fixed the killpower problem for USB so that theUSB now properly turns off

Page 36 - Configure Options

automatic service, using the Control Panel: reset apcupsd to Automaticstartup in the Startup dialogue, then restart apcupsd in the Services di-alogue

Page 37

and stopping apcupsd do not work. Use the services control panel instead.On Win95 systems, there are reports that the PIF files do not work. Ifyou find

Page 38

The functions of Stop, ups-events, and ups-status can be more easilyinvoked by right clicking on the apcupsd icon in the system tray and selectingthe

Page 39

Email Notification of EventsOn Win95/98 systems, it is possible to receive notification of apcupsd eventsthat are passed to apccontrol. This is possible

Page 40 - Compilers and Options

c:\apcupsd\apcupsd.exe /servicefound under the key:HKEY_LOCAL_MACHINE Software\Microsoft\Windows\CurrentVersion\RunServicestoc:\apcupsd\apcupsd.exe /s

Page 41 - Operating System Specifics

Command Line Options Specific to the Windows VersionThese options are not normally seen or used by the user, and are documentedhere only for informatio

Page 42 - /sbin/init.d/apcupsd

Installation: Serial-Line UPSesOverview of Serial-Interface UPSesIf you have a UPS that communicates via serial port, you need to do twothings before

Page 43

Connecting a APC USB UPS to either a PC USBor Serial PortAn interesting fact is that the USB ports (actually an RJ45 connector)on APC UPSes not only s

Page 44

When using this cable with apcupsd specify the following in apcupsd.conf:If you have an OS that requires DCD or RTS to be set before you canreceive in

Page 45

CUSTOM-RJ45 CABLESignal Computer UPS UPSDB9F RJ45-8 RJ45-10RxD 2 ---------------- 1 2 TxD SendTxD 3 ---------------- 7 8 RxD ReceiveGND 5 ------------

Page 46

- ifdef code in apcaccess that tries to write in the shared memorybuffer.- Applied Adam’s patch for fixing the pthreads dependencies in asys.c- Tweak

Page 47

Voltage-Signalling Cable for “dumb” UPSesNOTE. YOU DO NOT HAVE THIS CABLE UNLESS YOUBUILT IT YOURSELF. THE SIMPLE-CUSTOM CABLE ISNOT AN APC PRODUCT.Fo

Page 48

5. Double check your work.We use the DTR (pin 4 on the female connector) as our +5 volts power forthe circuit. It is used as the Vcc pull-up voltage f

Page 49

n/c | 1 | Frame/Case Gnd (optional) | 9 | 22Note: the <- and -> indicate the signal direction.Optional connections of original SIMPLE-CUSTOM spe

Page 50 - After Installation

Voltage Signalling Features Supported by Apcupsd for Vari-ous CablesThe following table shows the features supported by the current versionof apcupsd

Page 51

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 signalsThe Back-UPS Offic

Page 52 - /sbin/apcupsd

analysis) indicates that this cable under the right conditions may providethe Low Battery signal. This is to be confirmed.APC Part# - 940-0020BSignal C

Page 53

940-0023A Cable Wiring:This diagram is for informational purposes and may not be complete, wedon’t recommend that use it to build you build one yourse

Page 54

| B |*-------| 2N3906 PNP||\\ C||*----< DCD (1) Low Batt||R 4.7k3|4.7k |SHUTDOWN (1) >----------*----R4----*----< TxD (3)|| 1N4148*----K|----

Page 55 - A Simple Master Configuration

940-0095B Cable Wiring:This diagram is for informational purposes and may not be complete, wedon’t recommend that use it to build one yourself.APC Par

Page 56 - A Simple Slave Configuration

BackOffice ES:The BackUPS ES has a straight through serial cable with no identificationon the plugs. To make it work with apcupsd, specify the UPSCABLE94

Page 57

How To Use This ManualThis is the manual for apcupsd, a daemon for communicating with UPSes(Uninterruptible Power Supplies) made by American Power Cor

Page 58

The solution to the problem (thanks to Tom Suzda) is to unplug the UPSand while it is still chattering, press the power button (on the front of theuni

Page 59 - Testing Apcupsd

_______________________| . . . . . . . . . . || |-----------------------|____|From Jan Babinski jbabinsk at pulsarbeacon dot com: (many thanks)The Bac

Page 60

(Shield)--------------------------(4)Chassis GNDCable 940-0127BUSB(Computer) RJ45-10(UPS)_________ ____________| = = = = | [ oooooooooo ]|_________| [

Page 61 - Logging Test

condition = serial port initializationcable = 0095A, 0095B, 0095Caction = ioctl(TIOMBIC, RTS) clear RTS (set PnP mode)cable = 0119A, 0127A, 0128Aactio

Page 62

action = ioctl(TIOMCBIS, DTR) set DTR (kills power)RS232 Wiring and Signal ConventionsDB-25 Pin # DB-9 Pin # Name DTE-DCE Description1 — FG – Frame Gr

Page 63

The diagram above represents the Female end of the cable. Themale end is the same, but looking from inside the cable.DTE : Data Terminal Equipment (i.

Page 64 - Communications Test

to cause premature shutdowns of the UPS power, we strongly recommend,especially for voltage- signaling (dumb) UPSes, that you do most of the ini-tial

Page 65 - Simulated Power Fail Test

• Make sure you are doing your testing as root otherwise, you may havepermissions problems accessing the serial port.• You may have cabling problems,

Page 66 - Power has returned

• Try connecting your UPS to another machine. If it works, then youprobably have a bad serial port card. As unlikely as this may sound,at least two of

Page 67

Using apctest on Serial-Line UPSsesOn an apcsmart serial-line UPS, apctest will give you access to the batteryof low-level tests we described in apcte

Page 68 - Full Power Down Test

1. First, check to see if apcupsd supports your UPS and operating system(see Supported Operating Systems; UPSes and Cables).2. Second, plan your config

Page 69

3) Test 3 - no power4) Test 4 - low battery (requires test 3 first)5) Test 5 - battery exhausted6) Test 6 - kill UPS power7) Test 7 - run tests 1 thro

Page 70

Expected apctest Signals for a BackUPS Pro:If you have configured your UPS as:UPSTYPE backupsproUPSCABLE APC_940_0095Aor APC_940_0095Chere are the typi

Page 71 - Known Problems with USB UPSes

Testing Apcupsd) section.One additional note applies:Bizarre Intermittent Behavior:In one case, a user reported that he received random incorrect valu

Page 72

damage to the UPS. Try sending an upper case Y to the UPS (with-out a return at the end). It should respond with SM. If this is not thecase, read the

Page 73 - NISPORT 3551

MAINS : LineVoltageStateLASTEVNT : LastEventObservedBackUPS and NetUPS Simple SignalsLINEFAIL : OnlineStatusBATTSTAT : BatteryStatusDATA LoggingThis f

Page 74

Technical ReferenceConfiguration Directive ReferenceConfiguration directives in /etc/apcupsd/apcupsd.conf control the behaviorof the apcupsd daemon. For

Page 75

qualified name or IP address of the host (NIS server) and the port(optional) is the port to use to contact the server.If you specified UPSTYPE snmp, the

Page 76

NISPORT <port> This configuration directive specifies the port to beused by the apcupsd Network Information Server. The default isplatform depende

Page 77

and means that the default values do not generate annoy messages:KES).Note that if NOLOGON is set to disable the annoy messages willalso be disabled.A

Page 78

minutes specifies that apcupsd should prohibit logins when the re-maining runtime in minutes reaches 110% or less than the valuespecified on the MINUTES

Page 79

9. To verify that your UPS is communicating with your computer andwill do the right thing when the power goes out, read and follow theinstructions in

Page 80

the slaves to perform a shutdown then apcupsd will sleep for 30 sec-onds before issuing the shutdown of its own computer. If you needthe master to wai

Page 81

the Data (see DATA Logging) section of this manual for additionaldetails.FACILITY<log-facility> The facility directive can be used to changethe

Page 82

where there are no other computers dependent on power from the sameUPS. This is the normal case.Use netmaster, if and only if you have a serial port c

Page 83 - ./client

MASTER <name of the master> for slave machines. Used in slaveconfiguration files, this is the network name of the master which isauthorized to sen

Page 84

SLAVE directives be put in your /etc/hosts file so that apcupsd willbe able to resolve the machine name during startup and shutdowneven if DNS is not r

Page 85 - Configuring Your EEPROM

Under normal apcupsd operations (no --configure option), apcupsdwill read the value stored in the UPS and display it in the STATUSoutput.WAKEUP <se

Page 86

RETURNCHARGE <min. batt. charge level> This parameterspecifies what battery percentage charge is necessary before the UPSwill supply power to you

Page 87

Status logging consists of periodically logging ALL available informationconcerning the UPS. Since the volume of data is rather large (over 1000bytes

Page 88 - Maintaining Your UPS

MODEL : SMART-UPS 1000UPSMODE : Stand AloneSTARTTIME: Wed Sep 27 10:39:23 CEST 2000UPSNAME : UPS_IDENSTATUS : ONLINELINEV : 235.3 VoltsLOADPCT : 9.3 P

Page 89 - 1587 Monrovia Ave

Status Report FieldsThe meaning of the above variables are:APC is the header record indicating the STATUS format revision level,the number of records

Page 90

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 ofproto

Page 91 - Linux ATA Development

MAXLINEV is the maximum line voltage since the last STATUS asreturned by the UPS.MINLINEV is the minimum line voltage since the last STATUS as re-turn

Page 92

XOFFBATT time and date of last transfer from batteries, or N/A.SELFTEST is the results of the last self test, and may have the followingvalues: OK - s

Page 93

Logging the STATUS InformationIf specified in the configuration file, the STATUS data will also be written tothe system log file. Please note, that it wou

Page 94

shutdown(8) command. You can modify the behavior by editing the/etc/apcupsd/apccontrol script, but doing so will make it more com-plicated to upgrade

Page 95

This final step is important if you want to ensure that your systemwill automatically reboot when the power comes back on. The actualcode used on the R

Page 96 - Frequently-Asked Questions

The output should look something like the following:apcaccess eepromValid EPROM values for the SMART-UPS 1000Config Current PermittedDescription Direc

Page 97

Configuration section of this manual for more information. See the EEP-ROM (see Configuring Your EEPROM) of this manual for further detailson how to cha

Page 98

StartupNormally, apcupsd is automatically started when your system is rebooted.This normally occurs because the startup script apcupsd is linked into

Page 99

and information graciously supplied by APC. Hopefully, the additions madeherein can benefit the original author and his programming project, andmaybe s

Page 100 - DEVICE /dev/com2

diagram are used to keep PowerChute happy by allowing cable detection.If you use the NUT apcsmart driver, those pins don’t matter.Many thanks to Steve

Page 101

of the models, particularly USB enabled models, can be run in multiplemodes, so they may appear more than once in the table. APC is puttingout new mod

Page 102 - Customizing Event Handling

E Automatic self test intervals Default = 336 (336 hours = 14days) (336=14 days, 168=7 days,ON=power on, OFF=never)F Line frequency, Hz 60.00 (50.0 in

Page 103

X Results of last self test “OK” - good battery, “BT” -failed due to insufficient capac-ity, “NG” - failed due to overload,“NO” - no results available (

Page 104

p Shutdown grace delay, seconds Default “020” (020/180/300/600)q Low battery warning, minutes Default “02”r Wakeup delay (time) - seconds Default “000

Page 105

7 Dip switch positions (if applica-ble)See below8 Register #3 See below9 Line quality “FF” acceptable, “00” unaccept-able> Number of external batte

Page 106 - Master/Slave Configurations

Dip switch infoBit Switch Option when bit=10 4 Low battery alarm changed from 2 to 5 mins. Autostartupdisabled on SU370ci and 4001 3 Audible alarm del

Page 107 - Configuration Directives

Alert messagesThese single character messages are sent by the UPS any time there is anAlert condition. All other responses indicated above are sent by

Page 108

Register 1All bits are valid on the Matrix UPS. SmartUPS models only support bits6 and 7. Other models do not respond.Bit HexBitMeaning0 0x01 In wakeu

Page 109 - figurations

= messages.Bit Meaning0 Output unpowered due to shutdown by low battery1 Unable to transfer to battery due to overload2 Main relay malfunction - UPS t

Page 110

I == International 230 VoltsA == Asia ?? 100 VoltsJ == Japan ?? 100 VoltsInterpretation of the New Firmware RevisionNew Firmware revison and model ID

Page 111

It looks bizarre and ugly, but is easily parsed. The # is some kind ofmarker/ident character. Skip it. The rest fits this form:• Command character - us

Page 112 - Configuration

Copying and distribution of this file, with or without modification, are per-mitted in any medium without royalty provided the name Apcupsd, thecopyrigh

Page 113

BackUPS CSUSB, ProUSB, ES USB,RS/XS 1000,RS/XS 1500,and probablyother USBmodelsusb usb (note:using APCcables 940-0127A/B/C)Supported in version >=3

Page 114 - Support for SNMP UPSes

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

Page 115 - Known Problems

AcknowledgementsThe apcupsd has a rather long and tormented history. Many thanks to theguys that, with time, contributed to the general public knowled

Page 116

rpmbuild -ba --define "build_rh7 1" apcupsd.specrpmbuild --rebuild --define build_rh7 1" apcupsd-x.x.x-x.src.rpmHow do I control whethe

Page 117 - Running apcnisd from INETD

in your home directory (or edit the file if it already exists) and addthe following line:%_topdir /home/myuser/redhatCreditsThe success of apcupsd is d

Page 118 - Running apcnisd Standalome

Caldera: John Pinner (john at clocksoft.com)HP-UX Port Carl Erhorn (Carl Erhorn at hyperion.com)Robert K Nelson (rnelson at airflowsciences.com)SOLARIS

Page 119 - Logging Types

Project Discussions: APCUPSD Mailing ListThanks to American Power Conversion (APC) who helped in giving techni-cal information on their UPSes.A specia

Page 120 - Implementation Details

ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THEPROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFEC-TIVE, YOU ASSUME THE COST OF ALL NECESSARY SER

Page 121 - Developers Notes

# CONFIG_USB_BLUETOOTH_TTY is not set# CONFIG_USB_ACM is not set# CONFIG_USB_PRINTER is not setCONFIG_USB_STORAGE=m# CONFIG_USB_STORAGE_DEBUG is not s

Page 122 - Installation: Windows

# 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

Page 123

An alternative and more permanent method would be to addnone /proc/bus/usb usbfs defaults 0 0to /etc/fstab. This will mount usbfs at each reboot.You c

Page 124

powers a single computer. This is the most common configuration. If you’reworking with just one machine and one UPS, skip the rest of this section.Your

Page 125

THE /proc/bus/usb/drivers FILE:-------------------------------Each of the USB device drivers linked into your kernel (statically,or dynamically using

Page 126

d = decimal number (may have leading spaces or 0’s)x = hexadecimal number (may have leading spaces or 0’s)s = stringTopology info:T: Bus=dd Lev=dd Prn

Page 127

| | |__DeviceClass| |__Device USB version|__Device info tag #1whereP: Vendor=xxxx ProdID=xxxx Rev=xx.xx| | | |__Product revision number| | |__Product

Page 128 - Upgrading

interface serves a distinct "function", which is typically boundto a different USB device driver. One common example is a USBspeaker with an

Page 129

If a user or script is interested only in Topology info, forexample, use something like "grep ^T: /proc/bus/usb/devices"for only the Topolog

Page 130 - Problem Areas

S: Product=Peracom USB to Serial ConverterC:* #Ifs= 1 Cfg#= 1 Atr=a0 MxPwr=100mAI: If#= 0 Alt= 0 #EPs= 3 Cls=00(>ifc ) Sub=00 Prot=00 Driver=serial

Page 131 - Utility Functions

### END ###Interpretation of /proc/bus/usb info on 2.6 kernels:/proc/bus/usb filesystem output===============================(version 2003.05.30)The u

Page 132 - Disclaimer

or USB cable), so a device might be 002/027 when you first connectit and 002/048 sometime later.These files can be read as binary data. The binary dat

Page 133 - Killpower under Windows

x = hexadecimal number (may have leading spaces or 0’s)s = stringTopology info:T: Bus=dd Lev=dd Prnt=dd Port=dd Cnt=dd Dev#=ddd Spd=ddd MxCh=dd| | | |

Page 134 - Power Down During Shutdown

| |__Device USB version|__Device info tag #1whereP: Vendor=xxxx ProdID=xxxx Rev=xx.xx| | | |__Product revision number| | |__Product ID code| |__Vendor

Page 135

driver to be enabled on other platforms, it will only compile and run onLinux and *BSD systems.- Workaround: Try using UPS in serial mode instead of U

Page 136 - DEVICE /dev/ttyUSB0

to a different USB device driver. One common example is a USBspeaker with an audio interface for playback, and a HID interfacefor use with software vo

Page 137

If a user or script is interested only in Topology info, forexample, use something like "grep ^T: /proc/bus/usb/devices"for only the Topolog

Page 138

C:* #Ifs= 1 Cfg#= 1 Atr=a0 MxPwr=100mAI: If#= 0 Alt= 0 #EPs= 3 Cls=00(>ifc ) Sub=00 Prot=00 Driver=serialE: Ad=81(I) Atr=02(Bulk) MxPS= 64 Ivl= 16m

Page 139

### END ###222

Page 140

Index/about , 129/events , 129/help , 129/install , 129/kill , 129/remove , 129/run , 129/service , 129/servicehelper , 129/status , 129—disable-insta

Page 141

Apctest , 63ApcupsdBuilding and Installing , 26,109Testing , 53Apcupsd Bugs , 96Apcupsd Known USB Issues , 15Apcupsd Network Monitoring(CGI) Programs

Page 142

Once you have established se-rial , 155Troubleshooting Serial Line ,155Communications Test , 58Compilers and Options , 34ConfigKernel , 200Configuration

Page 143 - Voltage Signalling

Disclaimer: NO WARRANTY ,199DiscontentsShutown Sequence and its ,176Distribution Maintainers: , 198DLOWBATT , 174doreboot , 98doshutdown , 98DriverSam

Page 144 - Analyses of APC Cables

Determining Which Voltage-Signaling Cable You , 155Hid-ups and USB Specific Infor-mation , 71HITRANS , 174HITRANSFER <upper limit ofups batt. transf

Page 145

Controlling Multiple UPSeson one , 106mainsback , 98Maintaining Your UPS , 82Making sure apcupsd Is Running ,46MANDATE , 175ManualApcupsd User’s , 6Ho

Page 146

Checking Out Your USB SubsystemYou can skip this section if your UPS has an Ethernet or RS232-C interfaceor you are not running on a Linux kernel. If

Page 147

percent , 162Pin Assignment for the Serial Port(RS-232C), 25-pin and 9-pin, Female End , 148Planning Your Installation , 9PortConnecting a APC USB UPS

Page 148

SENSITIVITY <sets sensitivitylevel> , 168SequenceShutdown , 63, 176Serial Communications: , 197SERIALNO , 175ServerAlternate Ways To Run TheNetw

Page 149

Supported Operating Systems,UPSes and Cables , 11SupportsOther APC Cables thatapcupsd , 136System Shutdown Test , 61SystemsRecommended Options formost

Page 150

EEPROM , 192Variation on the Master/SlaveConfiguration , 51Verifying a Source Installation , 28VersionCommand Line Options Spe-cific to the Windows , 12

Page 151

T: Bus=01 Lev=01 Prnt=01 Port=00 Cnt=01 Dev#= 2 Spd=1.5 MxCh= 0D: Ver= 1.10 Cls=00(>ifc ) Sub=00 Prot=00 MxPS= 8 #Cfgs= 1P: Vendor=051d ProdID=0002

Page 152

esr@grelber$ cat /proc/bus/usb/driversand you should get:usbdevfshub96-111: hiddevhidOn Linux-2.6.x, make sure the sysfs filesystem is mounted on /sys

Page 153

CONFIG USB, CONFIG USB HID, CONFIG USB HIDDEV, and CON-FIGUSB DEVICEFS as well as at least one USB Host Controller Driver(CONFIG USB UHCI HCD [2.6.x],

Page 154 - 9-pin, Female End

where you replace the [ and ] with braces and the serial number with theone that correspnds to your UPS.Some kernels ship, such as Mandrake 10, ship w

Page 155 - Testing Serial-Line UPSes

Finally, check that appropriate USB devices exist. On a Red Hat systemyou can do this:esr@grelber$ ls /dev/usb/h*/dev/usb/hiddev0 /dev/usb/hiddev12 /d

Page 156

If all there things check out and you still can’t see the UPS, something ismore seriously wrong than this manual can cover – find expert help. If youar

Page 157

ContentsApcupsd User’s Manual . . . . . . . . . . . . . . . . . . . . . . . . 6Release Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Page 158

FreeBSD-4.11NetBSD-2.0NetBSD-1.6.2OpenBSD-3.6FreeBSD-5.3 has had the most testing since it is the primary platform onwhich the driver is developed. Th

Page 159

Note that the “ugen” driver is called out. If you see “uhid” instead, itprobably means you did not properly disable the uhid driver when youcompiled y

Page 160

The DEVICE setting is blank on purpose; apcupsd will automatically locateyour UPS.The delay-, timeout-, and NIS-related settings should be configured a

Page 161

Installation from SourceInstallation from source might have to be be done different ways dependingon what system you are running. The basic procedure i

Page 162 - Recalibrating the UPS Runtime

without redoing the configuration process by simply editing the apcupsd.conffile.Other configuration options can be used to set up the installation of HT

Page 163 - BATTSTAT : BatteryStatus

/sbin/apcupsd$ whereis apcupsdapcupsd: /sbin/apcupsd /etc/apcupsd /etc/apcupsd.conf/etc/apcupsd.status /usr/man/man8/apcupsd.8.gz/usr/man/man8/apcupsd

Page 164

The purpose of modifying the system halt files is so that apcupsd will berecalled after the system is in a stable state. At that point, apcupsd willins

Page 165 - Technical Reference

—sbindir=<path> This defines the directory for the executable filessuch as apcupsd. The default is /sbin. You may be tempted to placethe executabl

Page 166

—enable-test This turns on a test driver that is used only for debugging.By default it is disabled.—enable-nis Turns on the Network Information Server

Page 167

—with-nis-port=<port> This option allows you to specify what portapcupsd will use for the Network Information Server (the CGI pro-grams). The de

Page 168

Checking Your Configuration File . . . . . . . . . . . . . . . . 44Arranging for Reboot on Power-Up . . . . . . . . . . . . . . . 45Making sure apcupsd

Page 169

./configure --prefix=/usr --sbindir=/sbin --enable-usb \--enable-pthreadsand you can optionally build and install the CGI programs as follows:./config

Page 170

Operating System SpecificsWith the exception of Linux SUSE and Linux Red Hat systems used bythe developers, we rely on users to help create installatio

Page 171

DEVICE /dev/tty01In addition, you should ensure serial port lock file in apcupsd.conf is definedas:LOCKFILE /var/spool/locksUnlike the Linux systems, th

Page 172

single process, and thus is less efficient (consumes more CPU time) than theforking version of apcupsd. We hope to rectify this in a future version byus

Page 173

OpenBSD to freeze up. The best solution is probably to build withoutpthread. However, in doing so, you must realize that the bulk of this man-ual assu

Page 174

As always, remember testing UPSes can be hazardous to you system, and,apcupsd may contain bugs that can damage your system and data files! Youmust acce

Page 175

./configure \--prefix=/opt/apcupsd \--sbindir=/etc/opt/apcupsd/sbin \--sysconfdir=/etc/opt/apcupsd \--with-cgi-bin=/opt/apcupsd/cgi-binThe way to setu

Page 176 - Status report format

# If this is changed, mountall, umountall and rcS should also change./sbin/umountall/sbin/umount /var/adm >/dev/null 2>\&1/sbin/umount /var

Page 177 - Status Report Example

your UPS model and cable type, and the serial port that you have attachedthe UPS to. People have used both /dev/ttya and /dev/ttyb with noproblems. Yo

Page 178

package. We are striving to provide a useful package that works across allplatforms, and welcome your feedback.Best regards, and thanks for your inter

Page 179 - Status Report Fields

Apcupsd Notification and Events . . . . . . . . . . . . . . . . 70hid-ups and USB Specific Information . . . . . . . . . . . . . 71apcupsd Network Monit

Page 180

After which, you can do a:makeAnd to install apcupsd, do:make installFinally, you should follow the Win32 (see Installation on Windows) instal-lation

Page 181

Note that you should enter “/dev/usb/hiddev[0-15]” literally as shown. The“[0-15]” expression tells apcupsd to search all hiddev devices until it finds

Page 182 - Shutdown Sequence

to Power On. This means that whenever the power is applied they areon. The only way to shut them off is to pull the plug or to have a specialprogram th

Page 183

To start apcupsd manually (as you will probably do immediately followingthe installation), enter the following:/etc/rc.d/apcupsd startNormally, when p

Page 184

Notice that we have not specified a device. In doing so, apcupsd will tryall the well known USB ports. We strongly recommend you use this (emptydevice

Page 185

Normally you would have many more configuration directives to completelycustomize your installation, but this example shows you the minimum re-quired.A

Page 186 - Master/Slave Shutdown

## apcupsd.conf v1.1 ##UPSCABLE smartUPSTYPE smartupsDEVICE /dev/ttyS0LOCKFILE /var/lockUPSCLASS netmasterUPSMODE netNETTIME 10NETPORT 6666SLAVE slave

Page 187 - APC smart protocol

Please note, there are reports that you must use UPSTYPE smartups onthe slave even if the master is using UPSTYPE dumb. This is apparentlysome bug in

Page 188 - Diagram for cable hackers

thing like what follows. What is important is that you get the informationfrom an ether cable over the network and you must specify the address ofa “N

Page 189 - The Smart Protocol

UPS). The :3551 that follows the NIS server address is the port to use. Thedefault is 3551, but older versions of apcupsd used port 7000.Please do not

Page 190

Running the server as a child of apcupsd . . . . . . . . . . . . 110Running apcnisd from INETD . . . . . . . . . . . . . . . . . 111Running apcnisd St

Page 191

or the equivalent for your system. If you are running on Linux and using thefork()ing version of apcupsd, you should something similar to the followin

Page 192

Logging TestOnce you have established that the proper processes are running, do a tailof the system log file, normally /var/log/messages:tail /var/log/

Page 193

in your apcupsd.conf file.To run the apcaccess test, use the following command:apcaccess statusDepending on the type of UPS you have, you will get slig

Page 194 - Status bits

NOMOUTV : 115.0NOMBATTV : 24.0HUMIDITY : N/AAMBTEMP : N/AEXTBATTS : N/ABADBATTS : N/AFIRMWARE : N/AAPCMODEL : 6TDEND APC : Fri Dec 03 16:49:25 EST 199

Page 195 - Alert messages

If you see a message to the effect of:attach_shmarea: shared memory version mismatch (or UPS not yet ready to report)or if all the displayed values are

Page 196 - Register 3

At the same time, it sends the same message to the system log and to thetemporary EVENTS file (/etc/apcupsd/apcupsd.events).Plug the serial port plug b

Page 197

Athough this should not be necessary, as an extra precaution, you can shut-down your machine, remove the plug from the UPS you are testing, andplug yo

Page 198 - EEPROM Values

At this point, we recommend that you do a simulated power down of yoursystem. If you are adventuresome or have been through this before, skipto the ne

Page 199

Now when you pull the power plug, and either the timer expires or thebatteries are exhausted (see the next section for more details), the systemshould

Page 200 - Programming the UPS EEPROM

look at the “Shutdown grace delay”.Shutdown SequenceIf you experienced so problems with the above testing procedures, or if youare porting apcupsd to

Page 201 - Apcupsd — RPM Packaging FAQ

Connecting a APC USB UPS to either a PC USB or Serial Port . 131Cables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131Smart-Cu

Page 202

2003-07-07 11:19:21 apctest 3.10.6 (07 July 2003) redhatChecking configuration ...Attached to driver: apcsmartsharenet.type = DISABLEcable.type = CUST

Page 203 - Contributors

should some how become disconnected during the test.Item 5 is used to program the EEPROM. Please see theConfiguration Directives Used to Set the UPS EP

Page 204

Power Off (killpower) of UPS Does Not Work:Currently (as of 3.10.6) the code to power off the UPS works only if you havea Linux kernel version 2.4.22 or

Page 205 - Disclaimer: NO WARRANTY

you to do this include one command-line utility (apcaccess) and a GUI youcan use through a Web browser. You can also use apctest to tune someparameter

Page 206 - Kernel Config

which means that apcaccess can access any UPS on the network running theNetwork Information Server.The status command line option of apcaccess will pr

Page 207

LOADPCT : 11.4 Percent Load CapacityBATTV : 27.7 VoltsBCHARGE : 100.0 PercentMBATTCHG : 5 PercentTIMELEFT : 112.0 MinutesMINTIMEL : 3 MinutesSENSE : L

Page 208

ted values that can be set in the EPROM. For information about chang-ing these values, see the section on tuning EEPROM parameters (seeConfiguring Your

Page 209

hid-ups and USB Specific InformationThe UPS has an internal set of timers and remaining capacity counters,which it uses to determine when to shutdown.

Page 210

Next you must edit the hosts file /etc/apcupsd/hosts.conf and at the end,add the name of the hosts you want to monitor and a label string for them.Kern

Page 211

Content-type: text/html<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd"

Page 212

Configuration Directive Reference . . . . . . . . . . . . . . . . . . . 159General Configuration Directives . . . . . . . . . . . . . . . . 159Configurat

Page 213

multimon.cgi:This program monitors multiple UPSes at the same time. A typical output ofmultimon.cgi as displayed in your Web browser might look like t

Page 214

You can display different bar graphs by selecting different variables from thedrop down menus at the top of each of the three bar graphs.As with multimo

Page 215

LASTXFER : U command or Self TestSELFTEST : NOSTESTI : 336DLOWBATT : 02 MinutesDIPSW : 0x00 Dip SwitchREG1 : 0x00 Register 1REG2 : 0x00 Register 2REG3

Page 216

Where host is the name of the host or the IP address of the host runningthe Network Information Server. The default is the local host. You mayoptional

Page 217

Credits:Many thanks go to Russell Kroll <rkroll at exploits.org> who wrotethe CGI programs to work with his UPS Monitoring system namedNetwork U

Page 218

Configuring Your EEPROMIf you have a SmartUPS, there are depending on the UPS at least 12 differentvalues stored in the EEPROM that determine how the UP

Page 219

Lower transfer voltage LOTRANSFER 196 196 188 208 204Return threshold RETURNCHARGE 0 00 15 50 90Output voltage on batts OUTPUTVOLTS 230 230 240 220 22

Page 220

4) Monitor Battery Calibration progress5) Program EEPROM6) Enter TTY mode communicating with UPS7) QuitSelect function number:You might want to run op

Page 221

Valid EEPROM values for the SMART-UPS 1000Config Current PermittedDescription Directive Value Values==================================================

Page 222

found that it takes several discharge/charges before the runtime calibrationis accurate. Take care not to discharge your battery too much as it tends

Page 223 - ### END ###

Alert messages . . . . . . . . . . . . . . . . . . . . . . . . . . 189Register 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190Register

Page 224

Newport Beach CA 9266?Tel: +1 714 548-5259J-W Batteries, Inc.Tel: +1 714 548-4017WPS 49-1200GEL-CELL KB-35 BATTERYFor those that do not know what this

Page 225

The 1250 can outrun the 3000 by a factor of two under identicalpercentages, or run head to head for the same time.SMART-UPS 3000 is a 48V based or 4 b

Page 226

Surprise! (Or maybe not?) Kern was right - there is nothingwrong with the inverter or the charging circuit, and the newcells fixed everything.What conf

Page 227

Background:An APC Smart-UPS has a microprocessor which calculates run-time primarily based on the load attached to the UPS and onits battery capacity.

Page 228

monitoring software.Set the UPS shutdown time to 2 minutes, all other settings tonominal, and disconnect the serial port cable from the UPS be-fore ru

Page 229

Where Carl Suggests You Get BatteriesHi, Folks.I’m just replacing the batteries in one of my SmartUPS models,and it occurs to me that some of you may

Page 230

and have never been disappointed. The owner of the place alsois very good on technical issues, so if you have questions on theirproducts, he can get a

Page 231

Q: Does apcupsd support Windows?A: With release 3.8.0, apcupsd now runs on Win95/98, WinMe, WinNT,and Win2000 machines. All features of the Unix versi

Page 232

A: No, the error is not serious. Unfortunately, the documentation in thearea of master/slaves is not very detailed, and for that reason, yourslave set

Page 233

A: This problem and the problem of cannot create shm area are dueto the fact that the shared memory key that apcupsd wants to useis already in use. Th

Comments to this Manuals

No comments