Manuel utilisateur APCUPSD – Serveur d’impression

Apcupsd est un système de contrôle UPS qui permet l’arrêt méthodique de votre ordinateur en cas de panne de courant. Copie et distribution de ce fichier, avec ou sans modification, sont autorisés sur n'importe quel support sans redevance à condition d'appeler le nom Apcupsd, la notice de copyright, et cette notice sont préservées. Le code source d'Apcupsd est publié sous licence GNU General Public License version 2. Veuillez voir le fichier COPYING dans le répertoire source principal. Pour plus d'informations sur le projet, veuillez visiter le site web principal au http://www.apcupsd.com

Personne ne devrait s’appuyer sur le contenu du manuel de l’APCUPSD («le manuel») sans avoir au préalable obtenu l’avis du support technique APC. Le manuel est fourni sur les termes et comprendre que:

les auteurs, contributeurs et éditeurs ne sont pas responsables de la les résultats des actions entreprises sur la base des informations contenues dans le manuel, ni pour toute erreur ou omission dans le manuel; et les auteurs, contributeurs et éditeurs ne sont pas impliqués dans le rendu conseils ou services techniques ou autres.

Les auteurs, contributeurs et éditeurs, déclinent expressément tout et tout responsabilité envers toute personne, que ce soit un lecteur du manuel ou non, à l'égard de quoi que ce soit, et des conséquences de quoi que ce soit, fait ou omis par une telle personne en toute confiance, en tout ou en partie, sur tout ou partie du contenu du manuel. Sans limiter le la généralité de ce qui précède, aucun auteur, contributeur ou éditeur ne doit avoir responsabilité pour tout acte ou omission de tout autre auteur, contributeur ou éditeur.

Ceci est le manuel pour apcupsd, un démon pour la communication avec les UPS (Uninterruptible Power Fournitures) fabriquées par American Power Conversion Corporation (APC). Si vous avez un Les onduleurs fabriqués par APC, qu’ils soient vendus sous la plaque signalétique APC ou OEM (par exemple, le PowerTrust 2997A), et vous voulez le faire fonctionner avec un ordinateur en marche Linux, Unix ou Windows, vous lisez le bon document. Ce manuel est divisé en parties qui augmentent en profondeur technique comme ils vont. Si vous venez d'acheter un onduleur à la pointe de la technologie avec une interface USB ou Ethernet, et vous exécutez un courant version de Red Hat ou SUSE Linux, alors apcupsd est presque plug-and-play et vous devrez lire que le De base Guide de l'utilisateur. Si votre système d’exploitation est plus ancien ou si vous avez un système démodé l’onduleur série, vous devrez vous renseigner sur l’installation en série (voir Installation: Onduleurs de ligne série). Si vous avez besoin de plus des détails sur l’administration dans des situations inhabituelles (comme un configuration maître / esclave ou multi-UPS), vous devez lire les sections sur ces sujets aussi. Finalement, il existe un certain nombre de sections de référence techniques qui donne des détails complets sur des choses comme les directives de fichier de configuration et formats de journalisation des événements. Vous devriez commencer par lire le guide de démarrage rapide (voir Démarrage rapide pour Débutants) instructions.

Démarrage rapide pour les débutants apcupsd est un logiciel complexe, mais la plupart de ses complexités sont destinées à traiter avec du matériel ancien et systèmes d'exploitation. Obtention du matériel et des logiciels actuels courir ne devrait pas être très compliqué. Ce qui suit est un guide d’aide sur les étapes à suivre pour obtenir apcupsd mis en place et en cours d'exécution aussi indolore que possible.

Vérifiez si apcupsd prend en charge votre UPS et votre câble (voir UPS et câbles pris en charge). Vérifiez si apcupsd prend en charge votre système d’exploitation (voir Systèmes d'exploitation pris en charge). Planifiez votre type de configuration (voir Choisir une configuration Type). Si vous avez juste un UPS et un ordinateur, c'est facile. Si vous avez plus d’une machine en cours de desservi par le même UPS, ou par plus d’un UPS alimentant ordinateurs qui sont sur le même réseau local, vous avez plus de choix faire. Déterminez si vous avez l'une des configurations faciles. Si vous avez une clé USB UPS, et un système d'exploitation pris en charge et que vous souhaitez utiliser un UPS avec un ordinateur, la configuration est simple. APC fournit le câble besoin de parler avec cet UPS avec l'onduleur. Tout ce que vous devez faire vérifiez que votre sous-système USB fonctionne (voir USB Configuration) si oui, vous pouvez aller à la construction et installez l'étape. Si vous avez un onduleur conçu pour communiquer via SNMP via Ethernet, c'est aussi une installation relativement facile. Détails sont fournis dans Assistance pour les onduleurs SNMP. Si vous avez un UPS qui communique via un port série RS232C l'interface et c'est un SmartUPS, alors les choses sont relativement simples, sinon, votre vie est sur le point de devenir intéressante.

Si vous avez un câble fourni par le fournisseur, déterminez quel type de câble vous avez un numéro sur les extrémités plates du câble, comme le 940-0020A, estampé dans le plastique. Si vous n'avez pas de câble fourni par le fournisseur ou si votre type n'est pas vous devrez peut-être en construire un vous-même (voir Câbles). Voici en espérant que tu es bon avec une soudure le fer!

Vous êtes maintenant prêt à lire le document Building and Install (voir Construire et installer apcupsd) section du manuel et suivez ces instructions. Si vous êtes l’installation à partir d’un RPM ou d’une autre forme de paquet binaire, cette L’étape consistera probablement à exécuter une seule commande. Modifiez votre fichier /etc/apcupsd/apcupsd.conf si nécessaire. Souvent il ne sera pas. Modifiez les paramètres du BIOS (voir Organiser le redémarrage sur Power-Up) sur ton ordinateur de sorte que chaque démarrage, il démarre. (Ce n'est pas la valeur par défaut sur la plupart des systèmes.) Pour vérifier que votre UPS communique avec votre ordinateur et va faire la bonne chose quand le courant est coupé, lire et suivre les instructions du test (voir Essai Apcupsd) section. Si vous rencontrez des problèmes, consultez la liste de messagerie des utilisateurs d'apcupsd archive pour des problèmes similaires. C’est une excellente ressource avec réponses à toutes sortes de questions. Voir http://sourceforge.net/mailarchive/forum.php?forum_name=apcupsd-users. Si vous avez toujours besoin d'aide, envoyez un message au courrier électronique des utilisateurs d'apcupsd. liste (apcupsd-users@lists.sourceforge.net) décrivant votre problème, quelle version de apcupsd que vous utilisez, quel système d'exploitation vous utilisez et tout ce que vous pensez pourrait être utile. Lisez la section du manuel sur la surveillance et le réglage de votre onduleur.

Systèmes d'exploitation supportés apcupsd prend en charge de nombreux systèmes d’exploitation de type UNIX, ainsi que plusieurs variantes de Windows. En raison du manque de normalisation des API, la prise en charge USB n’est pas prise en charge. disponible sur toutes les plateformes. Voir Support de la plateforme ci-dessous pour plus de détails. En général, il est recommandé d’obtenir un paquet pré-construit pour votre plate-forme. Compte tenu de la manière dont apcupsd doit s’intégrer au mécanisme d’arrêt du système d’exploitation et la vitesse à laquelle ces mécanismes sont modifiés par fournisseurs, les ports de plate-forme de l’arborescence apcupsd peuvent devenir obsolètes. Dans Dans certains cas, les paquets binaires sont fournis par l’équipe apcupsd (RedHat, Mandriva, SuSE, Windows, Mac OS X). Pour les autres plateformes, il est recommandé de vérifier les référentiels de paquets de votre fournisseur et les référentiels tiers pour paquets binaires récents. Notez que certains fournisseurs continuent à distribuer anciennes versions de apcupsd avec des défauts connus. Ces paquets devraient ne pas être utilisé.

Support de plate-forme LINUX

Chapeau rouge SuSE Mandriva / Mandrake Debian Slackware Engarde Chien jaune Gentoo

LES FENÊTRES

Windows NT 4 Windows 98 / ME / 2000 Windows XP / Vista (y compris 64 bits) Windows Server 2003/2008 (64 bits inclus) Windows 7

AUTRES

Mac OS X Darwin Solaris 8/9 Solaris 10 NetBSD FreeBSD OpenBSD HPUX Unifix QNX

UPS et câbles pris en charge apcupsd prend en charge presque tous les modèles d'onduleurs APC existants et suffisamment différents types de câbles à connecter à chacun d’eux. le UPSTYPE le champ est la valeur que vous allez mettre en votre fichier /etc/apcupsd/apcupsd.conf pour indiquer à apcupsd quel type d'onduleur tu as. Nous allons décrire les valeurs possibles ici, car ils sont un bon moyen d'expliquer l'interface la plus importante de votre UPS propriété: le type de protocole utilisé pour parler avec ses ordinateur.

apcsmart Le protocole 'apcsmart' utilise une connexion série RS232 pour passer commandes dans un langage primitif ressemblant à codes de contrôle du modem. APC appelle cette langue "UPS-Link". À l'origine introduit pour les modèles Smart-UPS (d'où le nom «apcsmart»), cette la classe d'onduleurs est en déclin, elle est rapidement remplacée par le produit d'APC ligne par UPS et MODBUS. USB Un onduleur USB parle un contrôle universel bien défini la langue sur un fil USB. La plupart des membres d'APC utilisent maintenant cette méthode à la fin de 2003, et il semble probable qu’il prendra complètement le relais leur gamme basse et moyenne. Les derniers onduleurs APC ne prennent en charge qu’une ensemble limité de données sur l'interface USB. MODBUS (voir ci-dessous) est requis afin d'accéder aux données avancées. net C’est le mot clé pour spécifier si vous utilisez votre UPS en mode esclave (c’est-à-dire que la machine n’est pas directement connectée à l'onduleur, mais à une autre machine qui est), et il est connecté à le maître via une connexion ethernet. Vous devez avoir apcupsd's Network Information Services NIS activé pour que ce mode fonctionne. snmp Les onduleurs SNMP communiquent via une carte réseau Ethernet et firmware qui parle Simple Network Management Protocol. stupide Un onduleur muet ou à signalisation de tension et son ordinateur communiquer via les lignes de contrôle (pas les lignes de données) sur un RS232C connexion série. Pas grand-chose ne peut être réellement transmis de cette façon autre que un ordre de fermeture. Les UPS de signalisation de tension sont obsolètes. toi sont peu susceptibles de rencontrer un autre que comme matériel hérité. Si vous Si vous avez le choix, nous vous recommandons d’éviter les simples UPS de signalisation. pcnet PCNET est une alternative au SNMP disponible sur APC Famille AP9617 de modules de logement intelligent. Le protocole est beaucoup plus simple et potentiellement plus sécurisé que SNMP. modbus MODBUS est le dernier protocole APC et fonctionne sur des liaisons série RS232 ou USB. MODBUS est le remplacement d'APC pour le 'apcsmart' (UPS-Link) protocole. MODBUS est le seul moyen d'accéder à un contrôle et à un statut détaillés informations sur les onduleurs les plus récents (en particulier ceux de la série SMT).

Choisir un type de configuration Il y a trois principaux manières de faire fonctionner apcupsd sur votre système. Le premier est un autonome configuration où apcupsd contrôle un seul onduleur, qui alimente un ordinateur unique. C'est la configuration la plus courante. Si vous êtes travaillant avec une seule machine et un onduleur, ignorez le reste de cette section. Vos choix deviennent plus intéressants si vous utilisez un petit cluster ou une grande batterie de serveurs. Dans ces circonstances, il se peut que être possible ou même souhaitable de coupler un onduleur à chaque machine. apcupsd prend en charge certains arrangements alternatifs. Le second type de configuration est le NIS (Network Information Information Network). Serveur) serveur et client. Dans cette configuration, où un UPS alimente plusieurs ordinateurs, une copie d’apcupsd en exécutant un l'ordinateur agira en tant que serveur, tandis que les autres agiront en tant que clients du réseau qui interrogent le serveur pour obtenir des informations sur la UPS. Notez que "NIS" est ne pas liés au service d'annuaire de Sun également appelé "NIS" ou "Pages Jaunes". La troisième configuration est celle où un seul l'ordinateur contrôle plusieurs UPS. Dans ce cas, il y a plusieurs cas d’apcupsd sur le même ordinateur, chacun contrôlant un différent UPS. Une instance d’apcupsd s’exécutera en mode autonome, et l'autre instance fonctionnera normalement en mode réseau. Ce type de configuration peut convenir aux gros serveurs exploitations utilisant une seule machine dédiée à la surveillance et à Diagnostique Voici un schéma qui résume les possibilités:

Types de configuration ----------*----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 "cable power" and must be held at SPACE. DSR or CTS may be used as a loopback input to determine if the cable is plugged dans.

DCD is the "battery low" signal to the computer. A SPACE on this line means the battery is low. This is signalled by BATTERY-LOW being pulled down (it is probably open circuit normally). Normally, the transistor is turned off, and DCD is held at the MARK voltage by TxD. When BATTERY-LOW is pulled down, the voltage divider R2/R1 biases the transistor so that it is turned on, causing DCD to be pulled up to the SPACE voltage.

TxD must be held at MARK; this is the default state when no data is being transmitted. This sets the default bias for both DCD and SHUTDOWN. If this line is an open circuit, then when BATTERY-LOW is signalled, SHUTDOWN will be automatically signalled; this would be true if the cable were plugged in to the UPS and not the computer, or if the computer were turned off.

RTS is the "shutdown" signal from the computer. A SPACE on this line tells the UPS to shut down.

RxD and RI are both the "power-fail" signals to the computer. UNE MARK on this line means the power has failed.

SPACE is a positive voltage, typically +12V. MARK is a negative voltage, typically -12V. Linux appears to translate SPACE to a 1 and MARK to a 0.

940-0095B Cable Wiring

Supported Models: Many simple-signaling (aka voltage signaling) models such as BackUPS

This diagram is for informational purposes and may not be complete. We don't recommend that use it to build you 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 Battery  TxD 3 ----------[####]---- 1 Kill UPS Power                       4.7K ohm

940-0119A Cable Wiring

Supported Models: Older BackUPS Office

This diagram is for informational purposes and may not be complete. We don't recommend that use it to build you build one yourself.

APC Part# - 940-0119A

  UPS Computer   pins pins Signal Signal meaning 1 (brown) 4,6 DSR DTR On battery power 3 (blue) 1,2 CD RxD -> Low battery 4 (red) 5 Ground 5 (yellow) 7 RTS <- Begin signalling on other pins 6 (none) none

Serial BackUPS ES Wiring

Supported Models: Older Serial BackUPS ES

Contributed by: William Stock

The BackUPS ES has a straight through serial cable with no identification on the plugs. To make it work with apcupsd, specify the UPSCABLE 940-0119A and UPSTYPE backups. The equivalent of cable 940-0119A is done on a PCB inside the unit.

computer ----------- BackUPS-ES ----------------- DB9-M DB-9F pin signal pin

 4 DSR -> 4 --+                         | diode resistor  6 DTR -> 6 --+---->|----///---o kill power

 1 DCD <- 1 --+                         |  2 RxD 7 --------+--///--+                               |                               +--///--+                                          |  8 RI <- 8 --+----------------+--o on battery                         |  9 CTS <- 9 --+

 5 GND --- 5 ----------------------o ground

 3 TxD 3 nc

940-0128A Cable Wiring

Supported Models: Older USB BackUPS ES and CS

Contributed by: Many, thanks to all for your help!

Though these UPSes are USB UPSes, APC supplies a serial cable (typically with a green DB9 F connector) that has 940-0128A stamped into one side of the plastic serial port connector. The other end of the cable is a 10 pin RJ45 connector that plugs into the UPS (thanks to Dean Waldow for sending a cable!). Apcupsd version 3.8.5 and later supports this cable when specified as UPSCABLE 940-0128A and UPSTYPE dumb. However, running in this mode much of the information that would be available in USB mode is lost. Dans addition, when apcupsd attempts to instruct the UPS to kill the power, it begins cycling about 4 times a second between battery and line. The solution to the problem (thanks to Tom Suzda) is to unplug the UPS and while it is still chattering, press the power button (on the front of the unit) until the unit beeps and the chattering stops. After that the UPS should behave normally and power down 1-2 minutes after requested to do so. Thanks to all the people who have helped test this and have provided information on the cable wiring, our best guess for the cable schematic is the following:

APC Part# - 940-0128A

computer --------- Inside the Connector--------- UPS DB9-F | | RJ45 pin - signal | | Pin - Color               | |  4 DSR ->|---+ |               | | diode resistor |  6 DTR ->|---+---->|----///---o kill power | 8 Orange               | |  1 DCD <-|----+ |               | | |  2 RxD |----------+--///--+ |               | | |               | +--///--+ |               | | |  8 RI <-|----+----------------+--o on battery | 2 Black               | | |  9 CTS <-|----+ |               | signal |  5 GND --|-----------------------o ground | 7 Red               | |  3 TxD | |               | chassis |  Chassis/GND |-----------------------o ground | 4 Black               | |               | Not connected | 1, 5, 6, 9, 10               --------------------------------------

The RJ45 pins are: looking at the end of the connector:

10 9 8 7 6 5 4 3 2 1 _______________________ | . . . . . . . . . . | | | -----------------------        |____|

940-0128D Cable Wiring

Supported Models: BackUPS XS1000(BX-1000), Possibly other USB models

Contributed by: Jan Babinski jbabinsk at pulsarbeacon dot com

940-0128D is functionally similar to the 940-0128A cable except for NC on (6) DTR and (2) RD on the computer side. Unverified: Try setting apcupsd to UPSTYPE dumb et UPSCABLE 940-0128A.

APC Part# - 940-0128D

DB9(Computer) RJ45-10(UPS)

 (5) (1) ____________ ( o o o o o ) [ oooooooooo ] o o o o / [____________] (9) (6) (10) [_] (1)

 RI(9)<---+           | CTS(8)|---------| 2k 1N5819           +---vvvv---+--[>|------<(3)LowBatt           | |           +--- C |                 |___|                 /| B DCD(1)-------------------------->(8)KillPwr

GND(5)----------------------------(7)Signal GND (Shield)--------------------------(4)Chassis GND

940-0127B Cable Wiring

Supported Models: BackUPS XS1000(BX-1000), Possibly other USB models

Contributed by: Jan Babinski jbabinsk at pulsarbeacon dot com

Standard USB cable for USB-capable models with 10-pin RJ45 connector.

APC Part# - 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 Implementation Restrictions for Simple UPSes Due to inadequacies in the Win32 API, it is not possible to set/clear/get all the serial port line signals. apcupsd can detect: CTS, DSR, RNG, and CD. It can set and clear: RTS and DTR. This imposes a few minor restrictions on the functionality of some of the cables. In particular, LineDown on the Custom Simple cable, and Low Battery on the 0023A cable are not implemented.

Note: In a future release of apcupsd this procedure will be replaced by a daemon operation that can be performed on all types of UPS. This section does not apply to voltage-signalling or dumb UPSes such as the older BackUPS models. Smart UPSes internally compute the remaining runtime, and apcupsd uses the value supplied by the UPS. As the batteries age (after say two or three years), the runtime computation may no longer be accurate since the batteries no longer hold the same charge. As a consequence, in the event of a power failure, the UPS and thus apcupsd can report a runtime of 5 minutes remaining when in fact only one minute remains. This can lead to a shutdown before you might expect it, because regardless of the runtime remaining that is reported, the UPS will always correctly detect low batteries and report it, thus causing apcupsd to correctly shutdown your computer. If you wish to have the UPS recalibrate the remaining runtime calculations, you can do so manually as the current version of apcupsd does not support this feature. To do so,

Shutdown apcupsd contact your UPS directly using some terminal program such as minicom, tip, or cu with the settings 2400 8N1 (2400 baud, 8 bits, no parity, 1 stop bit). Be extremely careful what you send to your UPS as certain characters may cause it to power down or may even cause damage to the UPS. Try sending an upper case Y to the UPS (without a return at the end). It should respond with SM. If this is not the case, read the chapter on testing. If you fat finger the Y and enter y instead, no cause for alarm, you will simply get the APC copyright notice. when you are sure you are properly connected send an upper case D (no cr). This will put the UPS into calibration mode, and it will drain the battery down to 25% capacity (35% for a Matrix) at which point it will go back on the mains. In doing so, it will recompute the runtime calibration. If you wish to abort the calibration, enter a second D command. When you are done, restart apcupsd.

In principle, you should be able to do this with the computer powered by the UPS, but if you wish to be completely safe, you should plug your computer into the wall prior to performing the runtime calibration. In that case, you will need to artificially load the UPS with light bulbs or other means. You should supply a load of about 30 to 35% but not more than 50%. You can determine the load by looking at the output of the apcaccess status command while apcupsd is running. You should not run the recalibration command more than once or twice per year as discharging these kinds of batteries tends to shorten their life span.

There is a good deal of information available about the UPS and apcupsd's statut. This document describes the format of that information. Normally you will get at it via apcaccess, but there are other ways ainsi que.

Status report format STATUS output is in ASCII format with a single data value or piece of information on each line output. Because not all UPSes supply the same information, the output varies based on the type of UPS that you are using. In general, if the information is not available for your UPS, the line will be missing entirely or the data portion of the output record will contain an N / A indicating that the information is not available. Status logging consists of periodically logging ALL available information concerning the UPS. Since the volume of data is rather large (over 1000 bytes per status), the STATUS data is not automatically sent to the system log file. Instead, it is written as a series of data records in a specific file (normally /etc/apcupsd/apcupsd.status). After each write, the file is rewound so that the size of the file remains constant. The STATUS file is kept for backward compatibility and will be eliminated in a future version of apcupsd. The preferred method for obtaining this information is from apcaccess or by using the CGI interface (see apcupsd Network Monitoring (CGI) Programs). To make reading the status data reliable via a named pipe, the first record written contains a version number, the number of records that follow the first record, and the total number of bytes in those subsequent records. An actual example of such a status file (/etc/apcupsd/apcupsd.status) is shown below. Consequently, the first record always consists of 24 bytes (23 characters followed by a newline). This record starts with APC and as indicated in the example is followed by 37 records consisting of 906 bytes. The last record begins with END APC and contains the date and time matching the DATE record. When this data is written to a file, it is written as two records, the first record, and all the other records together. In reading the file, it can be either be read a record at a time, or in one big read. When this data is written to syslog(), it is written a record at a temps. The first record is the first 24 bytes. By having the number of records and the size in the first record, the complete status can be reliably reassembled.

Status Report Example An example of output from a BackUPS RS 1500 follows:

APC : 001,037,0906 DATE : Sun Apr 26 17:22:22 EDT 2009 HOSTNAME : mail.kroptech.com VERSION : 3.14.2 (10 September 2007) redhat UPSNAME : ups0 CABLE : USB Cable MODEL : Back-UPS RS 1500 UPSMODE : Stand Alone STARTTIME: Sun Apr 26 10:22:46 EDT 2009 STATUS : ONLINE LINEV : 123.0 Volts LOADPCT : 24.0 Percent Load Capacity BCHARGE : 100.0 Percent TIMELEFT : 144.5 Minutes MBATTCHG : 5 Percent MINTIMEL : 3 Minutes MAXTIME : 0 Seconds SENSE : Medium LOTRANS : 097.0 Volts HITRANS : 138.0 Volts ALARMDEL : Always BATTV : 26.8 Volts LASTXFER : Low line voltage NUMXFERS : 0 TONBATT : 0 seconds CUMONBATT: 0 seconds XOFFBATT : N/A SELFTEST : NO STATFLAG : 0x07000008 Status Flag MANDATE : 2003-05-08 SERIALNO : JB0319033692 BATTDATE : 2001-09-25 NOMINV : 120 NOMBATTV : 24.0 FIRMWARE : 8.g6 .D USB FW:g6 APCMODEL : Back-UPS RS 1500 END APC : Sun Apr 26 17:22:32 EDT 2009

Status Report Fields The meaning of the above variables are:

APC Header record indicating the STATUS format revision level, the number of records that follow the APC statement, and the number of bytes that follow the record. DATE The date and time that the information was last obtained from the UPS. HOSTNAME The name of the machine that collected the UPS data. UPSNAME The name of the UPS as stored in the EEPROM or in the UPSNAME directive in the configuration file. VERSION The apcupsd release number, build date, and platform. CABLE The cable as specified in the configuration file (UPSCABLE). MODÈLE The UPS model as derived from information from the UPS. UPSMODE The mode in which apcupsd is operating as specified in the configuration file (UPSMODE) STARTTIME The time/date that apcupsd was started. STATUS The current status of the UPS (ONLINE, ONBATT, etc.) LINEV The current line voltage as returned by the UPS. LOADPCT The percentage of load capacity as estimated by the UPS. BCHARGE The percentage charge on the batteries. TIMELEFT The remaining runtime left on batteries as estimated by the UPS. MBATTCHG If the battery charge percentage (BCHARGE) drops below this value, apcupsd will shutdown your system. Value is set in the configuration file (BATTERYLEVEL) MINTIMEL apcupsd will shutdown your system if the remaining runtime equals or is below this point. Value is set in the configuration file (MINUTES) MAXTIME apcupsd will shutdown your system if the time on batteries exceeds this value. A value of zero disables the feature. Value is set in the configuration file (TIMEOUT) MAXLINEV The maximum line voltage since the UPS was started, as reported by the UPS MINLINEV The minimum line voltage since the UPS was started, as returned by the UPS OUTPUTV The voltage the UPS is supplying to your equipment SENSE The sensitivity level of the UPS to line voltage fluctuations. DWAKE The amount of time the UPS will wait before restoring power to your equipment after a power off condition when the power is restored. DSHUTD The grace delay that the UPS gives after receiving a power down command from apcupsd before it powers off your equipment. DLOWBATT The remaining runtime below which the UPS sends the low battery signal. At this point apcupsd will force an immediate emergency shutdown. LOTRANS The line voltage below which the UPS will switch to batteries. HITRANS The line voltage above which the UPS will switch to batteries. RETPCT The percentage charge that the batteries must have after a power off condition before the UPS will restore power to your equipment. ITEMP Internal UPS temperature as supplied by the UPS. ALARMDEL The delay period for the UPS alarm. BATTV Battery voltage as supplied by the UPS. LINEFREQ Line frequency in hertz as given by the UPS. LASTXFER The reason for the last transfer to batteries. NUMXFERS The number of transfers to batteries since apcupsd startup. XONBATT Time and date of last transfer to batteries, or N/A. TONBATT Time in seconds currently on batteries, or 0. CUMONBATT Total (cumulative) time on batteries in seconds since apcupsd startup. XOFFBATT Time and date of last transfer from batteries, or N/A. SELFTEST

The results of the last self test, and may have the following values:

OK: self test indicates good battery BT: self test failed due to insufficient battery capacity NG: self test failed due to overload NO: No results (i.e. no self test performed in the last 5 minutes)

STESTI The interval in hours between automatic self tests. STATFLAG Status flag. English version is given by STATUS. DIPSW The current dip switch settings on UPSes that have them. REG1 The value from the UPS fault register 1. REG2 The value from the UPS fault register 2. REG3 The value from the UPS fault register 3. MANDATE The date the UPS was manufactured. SERIALNO The UPS serial number. BATTDATE The date that batteries were last replaced. NOMOUTV The output voltage that the UPS will attempt to supply when on battery Puissance. NOMINV The input voltage that the UPS is configured to expect. NOMBATTV The nominal battery voltage. NOMPOWER The maximum power in Watts that the UPS is designed to supply. HUMIDITY The humidity as measured by the UPS. AMBTEMP The ambient temperature as measured by the UPS. EXTBATTS The number of external batteries as defined by the user. A correct number here helps the UPS compute the remaining runtime more accurately. BADBATTS The number of bad battery packs. FIRMWARE The firmware revision number as reported by the UPS. APCMODEL The old APC model identification code. END APC The time and date that the STATUS record was written.

Logging the STATUS Information If specified in the configuration file, the STATUS data will also be written to the system log file. Please note, that it would not normally be wise to write this data to a normal system log file as there is no mechanism in syslog() to rewind the file and hence the log file would quickly become enormous. However, in two cases, it can be very useful to use syslog() to write this information. The first case is to set up your syslog.conf file so that the data is written to a named pipe. In this case, normally not more than about 8192 bytes of data will be kept before it is discarded by the système. The second case is to setup your syslog.conf file so that the status data is sent to another machine, which presumably then writes it to a named pipe. Consequently, with this mechanism, provides a simple means of networking apcupsd STATUS information. Although we mention system logging of STATUS information, we strongly recommend that you use apcaccess or the CGI interface to get this information.

Shutdown Sequence If you experienced so problems with the testing procedures, or if you are porting apcupsd to another system, or you are simply curious, you may want to know exactly what is going on during the shutdown process. The shutdown sequence is as follows:

apcupsd detects that there is a power problem and it calls /etc/apcupsd/apccontrol powerout. By default this event does nothing, but it can be overridden to notify users, etc.

After the configured ONBATTERYDELAY, apcupsd calls /etc/apcupsd/apccontrol onbattery, which normally sends a message to all users informing them that the UPS is on batteries.

When one of the conditions listed below occurs, apcupsd issues a shutdown command by calling /etc/apcupsd/apccontrol doshutdown, which should perform a shutdown of your system using the system shutdown(8) command. You can modify the behavior as described in Customizing Event Handling. The conditions that trigger the shutdown can be any of the following:

Running time on batteries have expired (TIMEOUT) The battery runtime remaining is below the configured value (BATTERYLEVEL) The estimated remaining runtime is below the configured value (MINUTES) The UPS signals that the batteries are exhausted.

A shutdown could also be initiated if apcupsd detects that the batteries are no longer functioning correctly. This case, though very unusual, can happen at any time even if there is proper mains voltage, and /etc/apcupsd/apccontrol emergency is called. Just before initiating any shutdown through the apccontrol script, apcupsd will create the file /etc/apcupsd/powerfail. This file will be used later in the shutdown sequence to recall apcupsd after syncing of the disks to initiate a power off of the UPS. If the /etc/nologin file has not already been created, it will normally be created during the shutdown sequence to prevent additional users from logging in (see the NOLOGIN configuration directive). Even though apcupsd has requested the system to perform a shutdown, it continues running.

When the system signals apcupsd to do exit, it does so. This is part of the normal system shutdown (at least on Unix and Linux systems) and the exact time that apcupsd receives the termination signal depends on how the shutdown links (usually in /etc/rc.d) are set. Note that on Windows NT systems, apcupsd apparently continues to run as a Service even though the machine is "shutdown".

During the shutdown of the system after apcupsd has been forced to exit, one of the last things done by the system shutdown is to call the halt script, which is usually in /etc/rc.d/halt or /etc/rc.d/init.d/halt, or possibly in /sbin/init.d/rc.0 depending on your system. If apcupsd was properly installed, this standard halt script was modified to include a bit of new logic just before the final halt of the system. It first tests if the file /etc/apcupsd/powerfail exists, and if it does, it executes /etc/apcupsd/apccontrol killpower. It is this last step that will cause apcupsd to be re-executed with the --killpower option on the command line. This option tells apcupsd to inform the UPS to kill the power.

This final step is important if you want to ensure that your system will automatically reboot when the power comes back on. The actual code used on the Red Hat version is:

# See if this is a powerfail situation. # ***apcupsd*** if [ -f /etc/apcupsd/powerfail ]; then # ***apcupsd***   echo # ***apcupsd***   echo "APCUPSD will now power off the UPS" # ***apcupsd***   echo # ***apcupsd***   /etc/apcupsd/apccontrol killpower # ***apcupsd***   echo # ***apcupsd***   echo "Please ensure that the UPS has powered off before rebooting" # ***apcupsd***   echo "Otherwise, the UPS may cut the power during the reboot!!!" # ***apcupsd***   echo # ***apcupsd*** fi # ***apcupsd***

The above code must be inserted as late as possible in the halt script. On many systems, such as Red Hat, all the disk drives were unmounted, then remounted read-only, thus permitting access to the /etc files and the apcupsd executable. If your system does not explicitly remount the disks, you must remount them in read-only mode in the code that you add. Examples of code fragments that do this can be found in the distributions/suse subdirectory of the la source. If you are not able to insert the above code in your halt script because there is no halt script, or because your halt script calls the init program as some Unix systems do, you can either just forget about powering off the UPS, which means that your machine will not automatically reboot after a power failure, or there is yet another alternative, though not at all as satisfying as inserting code in the halt script. Only if you cannot insert the appropriate code in the halt script, when you start apcupsd, normally from the /etc/rc.d/init.d/apcupsd script, use the --kill-on-powerfail option. This will cause apcupsd to program the UPS to shutoff the power just before it (apcupsd) does the system shutdown. Please note that this is not the most ideal solution. Read on to understand why. A very important consideration is that you must set the EEPROM in your UPS so that it waits a sufficient time for the system to halt before it shuts off the UPS power. When using a USB connection, apcupsd automatically sets this value to 60 seconds. When using a serial connection to a SmartUPS, you must configure the value in the UPS EEPROM by hand using apctest.

Shutdown Problems Obviously if your halt script is not properly modified, apcupsd will not be able to shut off the power to the UPS, and if the power returns before the batteries are exhausted your system will not automatically reboot. In any case, your machine should have been cleanly shut down.

Master/Slave Shutdown In master/slave configurations, however, the master cannot be 100 percent sure that the slaves have all shutdown before it performs the power off. To avoid this situation, be sure to configure any slaves (clients) to shut down before the master by setting different TIMEOUT, BATTERYLEVEL, ou MINUTES parameters in the config file. Also, on a slave machine, you do not want to use the modified halt script since it will recall apcupsd, which will detect that it is a slave (i.e. no connection to the UPS) and will complain that it cannot do the killpower. This situation is not harmful just annoying and possibly confusing. One possible problem during shutdown can be caused by remnants of old versions. Please be sure to delete or rename all prior versions (/usr/local/sbin/apcupsd or /sbin/powersc).

Startup Normally, apcupsd is automatically started when your system is rebooted. This normally occurs because the startup script apcupsd is linked into the appropriate places in /etc/rc.d. On most Linux systems, there is a program called chkconfig(8) that will automatically link the startup script. This program is invoked by the make install scripts, or it is explicitly done for those systems that do not have chkconfig(8). If this is not the case, you can either link it in appropriately yourself or explicitly call it from your rc.local file. The appropriate manual way to startup apcupsd is by executing:

/apcupsd start

où path is normally /etc/rc.d or /etc/rc.d/init.d depending on your system. Using this script is important so that any files remaining around after a power failure are removed. Likewise, shutting down apcupsd should be done with the same script:

/apcupsd stop

The APC UPS protocol was originally analyzed by Pavel Korensky with additions from Andre H. Hendrick beginning in 1995, and we want to give credit for good, hard work, where credit is due. After having said that, you will see that Steven Freed built much of the original apcupsd information file. The start of this chapter of the apcupsd manual in HTML format was pulled from the Network UPS Tools (NUT) site (http://www.networkupstools.org/ups-protocols/apcsmart.html). Il has been an invaluable tool in improving apcupsd, and I consider it the Bible of APC UPS programming. In the course of using it, I have added information gleaned from apcupsd and information graciously supplied by APC.

La description Here's the information on the elusive APC smart signaling protocol used by their higher end units (Back-UPS Pro, Smart-UPS, Matrix-UPS, etc). What you see here has been collected from a variety of sources. Some people analyzed the chatter between PowerChute and their hardware. Others sent various characters to the UPS and figured out what the results meant.

RS-232 differences Normal 9 pin serial connections have TxD on 3 and RxD on 2. APC's smart serial ports put TxD on pin 1 and RxD on pin 2. This means you go nowhere if you use a normal straight through serial cable. In fact, you might even power down the load if you plug one of those cables in. This is due to the odd routing of pins – DTR and RTS from the PC usually wind up driving the on/off line. So, when you open the port, they go high and *poof* your computer dies.

The Smart Protocol Despite the lack of official information from APC, this table has been constructed. It's standard RS-232 serial communications at 2400 bps/8N1. Don't rush the UPS while transmitting or it may stop talking to you. This isn't a problem with the normal single character queries, but it really does matter for multi-char things like "@000". Sprinkle a few calls to usleep() in your code and everything will work a lot better. The following table describes the single character "Code" or command that you can send to the UPS, its meaning, and what sort of response the UPS will provide. Typically, the response shown below is followed by a newline (n in C) and a carriage return (r in C). If you send the UPS a command that it does not recognize or that is not available on your UPS, it will normally respond with "NA" for "not available", otherwise the response is given in the "Typical results" column.

Personnage Sens Typical results Other info

^A Model string SMART-UPS 700 Spotty support for this query on older des modèles

^N Turn on UPS n / a Send twice, with 1.5s delay between chars. Only on 3rd gen SmartUPS and Black Back-UPS Pros

^Z Permitted EEPROM Values long string Gives the EEPROM permitted values for your model. See EEPROM Values for details.

UNE Front panel test Light show + "OK" Also sounds the beeper for 2 seconds

B Batterie voltage 27.87 Varies based on current level of charge. See also Nominal Battery Voltage.

C Interne Temperature 036.0 Units are degrees C

ré Runtime calibration !, then $ Runs until battery is below 25% (35% for Matrix) Updates the 'j' values. Only works at 100% battery charge. Pouvez be aborted with a second "D"

E Automatic self test interval 336

Writable variable. Possible values:

"336" (14 days) "168" (7 days) "ON " (at power on) note extra space "OFF" (never)

F Ligne la fréquence 60.00 Units are Hz. Value varies based on locality, usually 50/60.

g Cause of last transfert to battery O

Possible values:

R (unacceptable utility voltage rate of change) H (high utility voltage) L (low utility voltage) T (line voltage notch or spike) O (no transfers since turnon) S (transfer due to U command or activation of UPS test from front panel) NA (transfer reason still not available; read again)

je Measure-UPS Alarm enable FF not decoded yet

J Measure-UPS Alarm status 0F,00 not decoded yet

K Shutdown with grace period (no return) OK or * Send twice with > 1.5s delay between chars. Older units send "*" instead of "OK". Length of grace period is set with Grace Period command. UPS will remain off and NOT power on if utility power is restored.

L Input line voltage 118.3 Value varies based on locality. Does not always read 000.0 on line failure.

M Maximum line voltage 118.9 This is the max voltage since the last time this query was run.

N Minimum line voltage 118.1 This is the min voltage since the last time this query was run.

O Output voltage 118.3 Also see on battery output voltage.

P Power load % 023.5 Relative to capacity of the UPS.

Q Status flags 08 Bitmapped, see status bits below

R Turn dumb BYE Only on 3rd gen SmartUPS, SmartUPS v/s, BackUPS Pro. Must send enter smart mode command to resume comms.

S Soft shutdown D'accord Command executes after grace period. UPS goes online when power returns. Only works when on battery.

U Simulate power failure !, then $ See Alert messages section for info on ! and $.

V Old firmware revision "GWD" or "IWI" Voir Interpretation of the Old Firmware Revision

W Self test D'accord Tests battery, like pushing button on the front panel. Results stored in "X"

X Self test résultats D'accord

Possible values:

OK = good battery BT = failed due to insufficient capacité NG = failed due to overload NO = no results available (no test performed in last 5 minutes)

Y Enter smart mode SM This must be sent before any other commands will work. See also turn dumb command to exit smart mode.

Z Shutdown immédiatement n / a Send twice with > 1.5s delay between chars. UPS switches load off immediately (no grace period)

une Protocol info long string

Returns three main sections delimited by periods:

Protocol version Alert messages (aka async notifiers) Valid commands

b Firmware revision 50.9.D

Voir Interpretation of the New Firmware Revision. Decoding the example:

50 = SKU (variable length) 9 = firmware revision D = country code (D=USA, I=International, A=Asia, J=Japan, M=Canada)

c UPS local id UPS_IDEN Writable variable. Up to 8 letter identifier for keeping track of your hardware.

e Return threshold 00

Writable variable. Minimum battery charge % before UPS will return online after a soft shutdown. Possible values:

00 = 00% (UPS turns on immediately) 01 = 15% 02 = 25% 03 = 90%

f Batterie level % 099.0 Percentage of battery charge remaining

g Nominal batterie voltage 024 The battery voltage that's expected to be present in the UPS normally. Cette is a constant based on the type, number, and wiring of batteries in the UPS. Typically "012", "024" or "048".

h Measure-UPS ambient humidity (%) 042.4 Percentage. Only works on models with Measure-UPS SmartSlot card.

je Measure-UPS dry contacts 00

Bitmapped hex variable. Mapping:

10 = contact 1 20 = contact 2 40 = contact 3 80 = contact 4

j Estimated runtime 0327: Value is in minutes. Terminated with a colon.

k Alarm delay 0

Writable variable. Controls behavior of UPS beeper. Possible values:

0 = 5 second delay after power fail T = 30 second delay L = alarm at low battery only N = no alarm

l Low transfer voltage 103 Writable variable. UPS goes on battery when voltage drops below this point.

m Manufacture date 11/29/96 Format may vary by country (MM/DD/YY vs DD/MM/YY). Unique within groups of UPSes (production runs)

n Serial nombre WS9643050926 Unique for each UPS

o Nominal Output Tension 115 Expected output voltage when running on batteries. May be a writable variable on 220/230/240 VAC units.

p Shutdown grace delay 020 Seconds. Writable variable. Sets the delay before soft shutdown completes. (020/180/300/600)

q Low battery warning 02 Minutes. Writable variable. The UPS will report a low battery condition this many minutes before it runs out of power

r Wakeup delay 000 Seconds. Writable variable. The UPS will wait this many seconds after reaching the minimum charge before returning online. (000/060/180/300)

s Sensitivity H

Writable variable. Possible values:

H = highest M = medium L = lowest A = autoadjust (Matrix only)

t Measure-UPS ambient temperature 80.5 Degrees C. Only works on models with the Measure-UPS SmartSlot card.

vous Upper transfert voltage 132 Writable variable. UPS goes on battery when voltage rises above this point.

v Measure-UPS firmware 4Kx Firmware information for Measure-UPS board

X Last battery change date 11/29/96 Writable variable. Holds whatever the user set in it. Eight characters.

y droits d'auteur remarquer (C) APCC Only works if firmware letter is later than O

z Reset to factory settings CLEAR Resets most variables to initial factory values except identity or battery change date. Not available on SmartUPS v/s or BackUPS Pro.

+ Capability cycle (forward) various Cycle forward through possible capability values. UPS sends afterward to confirm change to EEPROM.

– Capability cycle (backward) various Cycle backward through possible capability values. UPS sends afterward to confirm change to EEPROM.

@nnn Shutdown and revenir OK or * UPS shuts down after grace period with delayed wakeup after nnn tenths of an hour plus any wakeup delay time. Older models send "*" instead of "OK".

0x7f Abort shutdown D'accord Use to abort @, S, K

~ Register #1 see below See Register 1 table

' Register #2 see below See Register 2 table

0 Batterie constant Voir Resetting the UPS Battery Constant

4 ??? Prints 35 on SmartUPS 1000

5 ??? Prints EF on SmartUPS 1000

6 ??? Prints F9 on SmartUPS 1000

sept DIP switch positions See Dip switch info

8 Register #3 see below See Register 3 table

9 Line quality FF

Possible values:

00 = unacceptable FF = acceptable

> Number of externe batterie packs SmartCell models return number of connected packs. Other models return value set by the user (use +/-).

[[[[ Measure-UPS Upper temp limit NO,NO Degrees C. Writable Variable. Possible values: 55, 50, 45, …, 05. Use +/- to change values.

] Measure-UPS lower temp limit NO,NO Degrees C. Writable Variable. Possible values: 55, 50, 45, …, 05. Use +/- to change values.

Measure-UPS Upper humidity limit NO,NO Percentage. Writable Variable. Possible values: 90, 80, 70, …, 10. Use +/- to change values.

Measure-UPS lower humidity limit NO,NO Percentage. Writable Variable. Possible values: 90, 80, 70, …, 10. Use +/- to change values.

Matrix-UPS and Symmetra Commands

^ Run in bypass mode BYP, INV, ERR If online, "BYP" response is received as bypass mode starts. If already in bypass, "INV" is received and UPS goes online. If UPS can't transfer, "ERR" received

< Number of bad battery packs 000 Count of bad packs connected to the UPS

/ Load current nn.nn True RMS load current drawn by UPS

Apparent load power nnn.nn Output load as percentage of full rated load in VA.

^V Output voltage selection

Writable variable. Possible values:

A = automatic (based on input tap) M = 208 VAC I = 240 VAC

^L Front panel language

Writable variable. Possible values:

E = English F = French G = German S = Spanish 1 = unknown 2 = unknown 3 = unknown 4 = unknown

w Run time conservation

Writable variable. Minutes of runtime to leave in battery (UPS shuts down "early"). Possible values:

NO = disabled 02 = leave 2 minutes of runtime 05 = leave 5 minutes 08 = leave 8 minutes

Dip switch info

Bit Commutateur Option when bit=1

0 4 Low battery alarm changed from 2 to 5 mins. Autostartup disabled on SU370ci and 400

1 3 Audible alarm delayed 30 seconds

2 2 Output transfer set to 115 VAC (from 120 VAC) or to 240 VAC (from 230 VAC)

3 1 UPS desensitized – input voltage range expanded

4-7 Unused at this time

Status bits This is probably the most important register of the UPS, which indicates the overall UPS status. Some common things you'll see:

08 = On line, battery OK 10 = On battery, battery OK 50 = On battery, battery low SM = Status bit is still not available (retry reading)

Bit Meaning when bit=1

0 Runtime calibration occurring (Not reported by Smart UPS v/s and BackUPS Pro)

1 SmartTrim (Not reported by 1st and 2nd generation SmartUPS models)

2 SmartBoost

3 On line (this is the normal condition)

4 On battery

5 Overloaded output

6 Battery low

sept Replace battery

Alert messages These single character messages are sent by the UPS any time there is an Alert condition. All other responses indicated above are sent by the UPS only in response to a query or action command.

Personnage Sens La description

! Line Fail Sent when the UPS goes on-battery, repeated every 30 seconds until low battery condition reached. quelquefois occurs more than once in the first 30 seconds.

$ Return from line fail UPS back on line power. Only sent if a ! has been sent previously.

% Low battery Sent to indicate low battery. Not implemented on SmartUPS v/s or BackUPS Pro models

+ Return from low batt Sent when the battery has been recharged to some level Only sent if a % has been sent previously.

? Abnormal état Sent for conditions such as "shutdown due to overload" or "shutdown due to low battery capacity". Also occurs within 10 minutes of turnon.

= Return from abnormal état Sent when the UPS returns from an abnormal condition where ? was sent, but not a turn-on. Not implemented on SmartUPS v/s or BackUPS Pro models.

* About to turn off Sent when the UPS is about to switch off the load. Non commands are processed after this character is sent. ne pas implemented on SmartUPS v/s, BackUPS Pro, or 3rd generation SmartUPS models.

# Remplacer batterie Sent when the UPS detects that the battery needs to be replaced. Sent every 5 hours until a new battery test is run or the UPS is shut off. Not implemented on SmartUPS v/s or BackUPS Pro models.

Et Check alarm register for fault (Measure-UPS) Sent to signal that temp or humidity out of set limits. Also sent when one of the contact closures changes Etat. Sent every 2 minutes until the alarm conditions are reset. Only sent for alarms enabled with I. Cause of alarm may be determined with J. Not implemented on SmartUPS v/s or BackUPS Pro.

| Variable change in EEPROM Sent whenever any EEPROM variable is changed. Only supported on Matrix UPS and 3rd generation SmartUPS models.

Register 1 All bits are valid on the Matrix UPS. SmartUPS models only support bits 6 and 7. Other models do not respond.

Bit Meaning when bit=1

0 In wakeup mode (typically lasts < 2s)

1 In bypass mode due to internal fault (see Register 2 or Register 3)

2 Going to bypass mode due to command

3 In bypass mode due to command

4 Returning from bypass mode

5 In bypass mode due to manual bypass control

6 Ready to power load on user command

sept Ready to power load on user command or return of line power

Register 2 Matrix UPS models report bits 0-5. SmartUPS models only support bits 4-6. SmartUPS v/s and BackUPS Pro report bits 4, 6, 7. Unused bits are set to 0. Other models do not respond.

Bit Meaning when bit=1

0 Fan failure in electronics, UPS in bypass

1 Fan failure in isolation unit

2 Bypass supply failure

3 Output voltage select failure, UPS in bypass

4 DC imbalance, UPS in bypass

5 Battery is disconnected

6 Relay fault in SmartTrim or SmartBoost

sept Bad output voltage

Register 3 All bits are valid on the Matrix UPS and 3rd generation SmartUPS models. SmartUPS v/s and BackUPS Pro models report bits 0-5. Tout others report 0-4. State change of bits 1,2,5,6,7 are reported asynchronously with ? and = messages.

Bit Meaning when bit=1

0 Output unpowered due to shutdown by low battery

1 Unable to transfer to battery due to overload

2 Main relay malfunction – UPS turned off

3 In sleep mode from @ command (maybe others)

4 In shutdown mode from S command

5 Battery charger failure

6 Bypass relay malfunction

sept Normal operating temperature exceeded

Interpretation of the Old Firmware Revision The Old Firmware Revision is obtained with the "V" command, which gives a typical response such as "GWD" or "IWI", and can be interpreted as follows:

Old Firmware revision and model ID String for SmartUPS & MatrixUPS

This is a three character string XYZ

   where X == Smart-UPS or Matrix-UPS ID Code.      range 0-9 and A-P        1 == unknown        0 == Matrix 3000        5 == Matrix 5000      the rest are Smart-UPS and Smart-UPS-XL        2 == 250 3 == 400 4 == 400        6 == 600 7 == 900 8 == 1250        9 == 2000 A == 1400 B == 1000        C == 650 D == 420 E == 280        F == 450 G == 700 H == 700XL        I == 1000 J == 1000XL K == 1400        L == 1400XL M == 2200 N == 2200XL        O == 3000 P == 5000

   where Y == Possible Level of Smart Features, unknown???        G == Stand Alone        T == Stand Alone                V == ???        W == Rack Mount

   where Z == National Model Use Only Codes        D == Domestic 115 Volts        I == International 230 Volts        A == Asia ?? 100 Volts        J == Japan ?? 100 Volts

Interpretation of the New Firmware Revision

New Firmware revision 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 meanings.             N == Class of UPS             1n == Back-UPS Pro             5n == Smart-UPS             7n == Smart-UPS NET

             n == Level of intelligence             N1 == Simple Signal, if detectable WAG(*)             N2 == Full Set of Smart Signals             N3 == Micro Subset of Smart Signals

    where M == Possible Level of Smart Features, unknown???         1 == Stand Alone         8 == Rack Mount         9 == Rack Mount

    where L == National Model Use Only Codes         D == Domestic 115 Volts         I == International 230 Volts         A == Asia ?? 100 Volts         J == Japan ?? 100 Volts         M == North America 208 Volts (Servers)

EEPROM Values Upon sending a ^Z, your UPS will probably spit back approximately 254 characters something like the following (truncated here for the example):

#uD43132135138129uM43229234239224uA43110112114108 ....

It looks bizarre and ugly, but is easily parsed. The # is some kind of marker/ident character. Skip it. The rest fits this form:

Command character – use this to select the value Locale – use 'b' to find out what yours is (the last character), '4' applies to all Number of choices – '4' means there are 4 possibilities coming en haut Choice length – '3' means they are all 3 chars long

Then it's followed by the choices, and it starts over. Matrix-UPS models have ## between each grouping for some reason. Here is an example broken out to be more readable:

CMD DFO RSP FSZ FVL u D 4 3 127 130 133 136 u M 4 3 229 234 239 224 u A 4 3 108 110 112 114 u I 4 3 253 257 261 265 l D 4 3 106 103 100 097 l M 4 3 177 172 168 182 l A 4 3 092 090 088 086 l I 4 3 208 204 200 196 e 4 4 2 00 15 50 90 o D 1 3 115 o J 1 3 100 o I 1 3 230 240 220 225 o M 1 3 208 s 4 4 1 H M L L q 4 4 2 02 05 07 10 p 4 4 3 020 180 300 600 k 4 4 1 0 T L N r 4 4 3 000 060 180 300 E 4 4 3 336 168 ON OFF

CMD == UPSlink Command.     u = upper transfer voltage     l = lower transfer voltage     e = return threshold     o = output voltage     s = sensitivity     p = shutdown grace delay     q = low battery warning     k = alarm delay     r = wakeup delay     E = self test interval

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 maximum of 12 different values that can be programmed into the UPS EEPROM. They are:

Commander Sens

c The UPS Id or name

X The last date the batteries were replaced

vous The Upper Transfer Voltage

l The Lower Transfer Voltage

e The Return Battery Charge Percentage

o The Output Voltage when on Batteries

s The Sensitivity to Line Quality

p The Shutdown Grace Delay

q The Low Battery Warning Delay

k The Alarm Delay

r The Wakeup Delay

E The Automatic Self Test Interval

The first two cases (Ident and Batt date) are somewhat special in that you tell the UPS you want to change the value, then you supply 8 characters that are saved in the EEPROM. The last ten item are programmed by telling the UPS that you want it to cycle to the next permitted value. In each case, you indicate to the UPS that you want to change the EEPROM by first sending the appropriate query command (e.g. "c" for the UPS ID or "u" for the Upper Transfer voltage. This command is then immediately followed by the cycle EEPROM command or "-". Dans the case of the UPS Id or the battery date, you follow the cycle command by the eight characters that you want to put in the EEPROM. In the case of the other ten items, there is nothing more to enter. The UPS will respond by "OK" and approximately 5 seconds later by a vertical bar (|) to indicate that the EEPROM was changed.

Click to rate this post! [Total: 0 Average: 0]