diff --git a/apcups/user_doc.rst b/apcups/user_doc.rst index b37310870..e8c22464f 100644 --- a/apcups/user_doc.rst +++ b/apcups/user_doc.rst @@ -2,9 +2,9 @@ .. index:: apcups -=============================== +====== apcups -=============================== +====== .. image:: webif/static/img/plugin_logo.png @@ -14,8 +14,6 @@ apcups :scale: 50 % :align: left - - Anforderungen ============= @@ -33,7 +31,7 @@ Wenn der Daemon lokal installiert ist, sollte die Datei ``/etc/apcupsd/apcupsd.c Unterstützte Geräte ------------------- -Aollte mit allen APC UPS Geräten funktionieren die den apcupsd unterstützen. Getestet wurde nur mit einer **smartUPS**. +Sollte mit allen APC UPS Geräten funktionieren, die den apcupsd unterstützen. Getestet wurde nur mit einer **smartUPS**. Konfiguration @@ -134,18 +132,15 @@ Zu den Informationen, welche Funktionen das Plugin bereitstellt (z.B. zur Nutzun bitte die Dokumentation :doc:`Dokumentation ` lesen, die aus den Metadaten der plugin.yaml erzeugt wurde (siehe oben). - - -| Beispiele ========= -Beispiel -~~~~~~~ +Schlüssel auslesen +~~~~~~~~~~~~~~~~~~ -The example below will read the keys **LINEV**, **STATUS** and -**TIMELEFT** and returns their values. +Das folgende Beispiel liest die Schlüssel **LINEV**, **STATUS** und +**TIMELEFT** und gibt deren Werte zurück. .. code:: yaml @@ -170,165 +165,142 @@ The example below will read the keys **LINEV**, **STATUS** and type: num apcups: timeleft -**type** depends on the values. +**type** hängt von den Werten ab. Status Report Fields ~~~~~~~~~~~~~~~~~~~~ -Due to a look into this -http://apcupsd.org/manual/manual.html#configuration-examples file the -meaning of the above variables are as follows +Laut `APC `_) +ist die Bedeutung der Variablen wie folgt: :: - 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). - MODEL - 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 power. - 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. - + APC + Header-Datensatz, der den Revisionsstand des STATUS-Formats, die Anzahl der Datensätze, die auf die APC-Anweisung folgen, und die Anzahl der Bytes, die auf den Datensatz folgen, angibt. + DATE + Das Datum und die Uhrzeit, zu der die Informationen zuletzt von der USV abgerufen wurden. + HOSTNAME + Der Name des Rechners, der die USV-Daten erfasst hat. + UPSNAME + Der Name der USV, wie er im EEPROM oder in der Direktive UPSNAME in der Konfigurationsdatei gespeichert ist. + VERSION + Die apcupsd-Versionsnummer, das Erstellungsdatum und die Plattform. + KABEL + Das Kabel, wie in der Konfigurationsdatei angegeben (UPSCABLE). + MODELL + Das USV-Modell, das aus den Informationen der USV abgeleitet wurde. + UPSMODE + Der Modus, in dem apcupsd arbeitet, wie in der Konfigurationsdatei angegeben (UPSMODE) + STARTTIME + Die Uhrzeit/das Datum, zu der/dem apcupsd gestartet wurde. + STATUS + Der aktuelle Status der USV (ONLINE, ONBATT, etc.) + LINEV + Die aktuelle Netzspannung, wie sie von der USV zurückgegeben wird. + LOADPCT + Der von der USV geschätzte Prozentsatz der Lastkapazität. + BCHARGE + Die prozentuale Ladung der Batterien. + TIMELEFT + Die von der USV geschätzte Restlaufzeit der Batterien. + MBATTCHG + Wenn der Prozentsatz der Batterieladung (BCHARGE) unter diesen Wert fällt, schaltet apcupsd Ihr System ab. Der Wert wird in der Konfigurationsdatei (BATTERYLEVEL) festgelegt. + MINTIMEL + apcupsd fährt Ihr System herunter, wenn die verbleibende Laufzeit diesen Wert erreicht oder unterschreitet. Der Wert wird in der Konfigurationsdatei festgelegt (MINUTES) + MAXTIME + apcupsd schaltet Ihr System ab, wenn die Akkulaufzeit diesen Wert überschreitet. Ein Wert von Null deaktiviert die Funktion. Der Wert wird in der Konfigurationsdatei festgelegt (TIMEOUT) + MAXLINEV + Die maximale Netzspannung seit dem Start der USV, wie von der USV gemeldet + MINLINEV + Die minimale Netzspannung seit dem Start der USV, wie von der USV zurückgemeldet + OUTPUTV + Die Spannung, die die USV an Ihre Geräte liefert + SENSE + Der Empfindlichkeitsgrad der USV gegenüber Schwankungen der Netzspannung. + DWAKE + Die Zeit, die die USV wartet, bevor sie die Stromversorgung Ihrer Geräte nach einem Stromausfall wiederherstellt, wenn die Stromversorgung wiederhergestellt ist. + DSHUTD + Die Wartezeit, die die USV nach Erhalt eines Ausschaltbefehls von apcupsd einhält, bevor sie Ihre Geräte ausschaltet. + DLOWBATT + Die verbleibende Laufzeit, bei deren Unterschreitung die USV das Signal für eine schwache Batterie sendet. An diesem Punkt erzwingt apcupsd eine sofortige Notabschaltung. + LOTRANS + Die Netzspannung, unterhalb derer die USV auf Batterien umschaltet. + HITRANS + Die Netzspannung, oberhalb derer die USV auf Batterien umschaltet. + RETPCT + Die prozentuale Ladung, die die Batterien nach einem Stromausfall haben müssen, bevor die USV die Stromversorgung Ihrer Geräte wiederherstellt. + ITEMP + Interne USV-Temperatur, wie von der USV geliefert. + ALARMDEL + Die Verzögerungszeit für den USV-Alarm. + BATTV + Batteriespannung, wie sie von der USV geliefert wird. + LINEFREQ + Netzfrequenz in Hertz, wie von der USV angegeben. + LASTXFER + Der Grund für die letzte Übertragung an die Batterien. + NUMXFERS + Die Anzahl der Übertragungen an die Batterien seit dem Start von apcupsd. + XONBATT + Uhrzeit und Datum der letzten Übertragung in die Batterien oder N/A. + TONBATT + Zeit in Sekunden, die derzeit auf Batterien übertragen wird, oder 0. + CUMONBATT + Gesamte (kumulative) Zeit auf den Batterien in Sekunden seit dem Start von apcupsd. + XOFFBATT + Zeit und Datum der letzten Übertragung von den Batterien oder N/A. + SELFTEST + Die Ergebnisse des letzten Selbsttests und können die folgenden Werte haben: + + OK: Selbsttest zeigt gute Batterie an + BT: Selbsttest wegen unzureichender Batteriekapazität fehlgeschlagen + NG: Selbsttest aufgrund von Überlastung fehlgeschlagen + NO: Keine Ergebnisse (d.h. in den letzten 5 Minuten wurde kein Selbsttest durchgeführt) + + STESTI + Das Intervall in Stunden zwischen den automatischen Selbsttests. + STATFLAG + Statusflagge. Die englische Version wird durch STATUS angegeben. + DIPSW + Die aktuellen Dip-Schalter-Einstellungen bei USVs, die über solche verfügen. + REG1 + Der Wert aus dem USV-Fehlerregister 1. + REG2 + Der Wert aus dem USV-Fehlerregister 2. + REG3 + Der Wert aus dem USV-Fehlerregister 3. + MANDATE + Das Datum, an dem die USV hergestellt wurde. + SERIENNUMMER + Die Seriennummer der USV. + BATTDATUM + Das Datum, an dem die Batterien zuletzt ausgetauscht wurden. + NOMOUTV + Die Ausgangsspannung, die die USV versucht zu liefern, wenn sie mit Batterien betrieben wird. + NOMINV + Die Eingangsspannung, für die die USV konfiguriert ist. + NOMBATTV + Die Nennspannung der Batterie. + NOMPOWER + Die maximale Leistung in Watt, für die die USV ausgelegt ist. + FEUCHTIGKEIT + Die von der USV gemessene Luftfeuchtigkeit. + AMBTEMP + Die von der USV gemessene Umgebungstemperatur. + EXTBATTEN + Die Anzahl der externen Batterien, wie vom Benutzer definiert. Eine korrekte Zahl hier hilft der USV, die verbleibende Laufzeit genauer zu berechnen. + BADBATTS + Die Anzahl der defekten Akkus. + FIRMWARE + Die Firmware-Revisionsnummer, wie von der USV gemeldet. + APCMODEL + Der alte APC-Modellidentifikationscode. + END APC + Die Uhrzeit und das Datum, an dem der STATUS-Datensatz geschrieben wurde. | Web Interface ============= -Aktuell hat das Plugin kein Webinterface - -Tab 1: ----------------------- - - - -.. image:: assets/webif_tab1.jpg - :class: screenshot - - - - +Aktuell hat das Plugin kein Webinterface.