mirror of
https://github.com/fhem/fhem-mirror.git
synced 2025-01-31 12:49:34 +00:00
34_NUT: added
git-svn-id: https://svn.fhem.de/fhem/trunk@6593 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
narsskrarc
parent
637b5c74c8
commit
5c6e2a0487
@ -1,5 +1,6 @@
|
||||
# Add changes at the top of the list. Keep it in ASCII, and 80-char wide.
|
||||
# Do not insert empty lines here, update check depends on it.
|
||||
- added: 34_NUT.pm (maintainer: creideiki)
|
||||
- feature: SYSMON: added new reading: perl_version
|
||||
- feature: add toggle to SetExtensions (introduced for ZWave)
|
||||
- bugfix: plotEmbed FHEMWEB attribute (fix for an iOS8 bug)
|
||||
|
||||
452
fhem/FHEM/34_NUT.pm
Normal file
452
fhem/FHEM/34_NUT.pm
Normal file
@ -0,0 +1,452 @@
|
||||
#
|
||||
# $Id$
|
||||
#
|
||||
# Abfrage einer UPS über die Network UPS Tools (www.networkupstools.org)
|
||||
#
|
||||
|
||||
# DEFINE bla NUT <upsname> [<host>[:<port>]]
|
||||
# Readings:
|
||||
# Da sind alle realisierbar, die die USV liefert.
|
||||
# Auf jeden Fall dabei ist
|
||||
# ups.status
|
||||
# da das auch den Status des Geräts ergibt.
|
||||
# Weitere sind mit dem Attribut asReadings definierbar (s.a. TODO).
|
||||
#
|
||||
# Attrs:
|
||||
# disable:0,1 Polling abklemmen
|
||||
# pollState Häufigkeit, mit der der Status der USV abgefragt wird (Default 5 sec)
|
||||
# pollVal Häufigkeit, mit der die anderen Readings abgefragt werden (Default 60 sec, Vielfaches von pollState)
|
||||
# asReadings Werte des USV, die als Readings zur Verfügung stehen sollen
|
||||
#
|
||||
#
|
||||
|
||||
#
|
||||
# TODO
|
||||
# A - Alive setzen
|
||||
# A - Sollte man als Reading einfach die Bezeichnung der USV nehmen (also z.B. input.voltage) oder
|
||||
# Aliase nehmen (z.B. voltage) bzw. modifizierte Bezeichnungen (z.B. inputVoltage)?
|
||||
# B - attr pollInterval: Wertebereich prüfen (min. 5, max. ?)
|
||||
# B - readingFnAttributes implementieren
|
||||
# C - per GET könnte man alle Werte der USV verfügbar machen
|
||||
# D - SET implementieren, um diverse Dinge mit der USV anstellen zu können (Test, Ausschalten, ...)
|
||||
#
|
||||
#
|
||||
# FIXME
|
||||
# - DevIo_Expect funktioniert nicht, da ich den Status auf OL setze. Da die Daten sowieso nicht schnell genug da sind
|
||||
# und ich NUT_Read brauche, wäre es wohl besser, die Anfrage einfach zu schreiben.
|
||||
# Wie kriege ich raus, ob die Verbindung noch steht?
|
||||
# - Fehlermeldung in fhem.log: "Notify Loop for ..." Wieso?
|
||||
#
|
||||
|
||||
|
||||
package main;
|
||||
use strict;
|
||||
use warnings;
|
||||
use POSIX;
|
||||
|
||||
|
||||
sub NUT_Initialize($);
|
||||
sub NUT_Define($$);
|
||||
sub NUT_Undef($$);
|
||||
sub NUT_Ready($);
|
||||
sub NUT_DevInit($);
|
||||
sub NUT_Read($);
|
||||
sub NUT_ListVar($);
|
||||
sub NUT_Auswertung($);
|
||||
sub NUT_DbLog_split($);
|
||||
|
||||
|
||||
# Definitionen für die Berechnung der Einheit aus dem Namen
|
||||
my @nutunits = (
|
||||
['percent' => '%'],
|
||||
['temperature' => '°C'],
|
||||
['humidity' => '%'],
|
||||
['voltage' => 'V'],
|
||||
['transfer' => 'V'],
|
||||
['realpower' => 'W'],
|
||||
['power' => 'VA'],
|
||||
['current' => 'A'],
|
||||
['frequency' => 'Hz'],
|
||||
['load' => '%'],
|
||||
['charge' => '%'],
|
||||
['capacity' => '%'],
|
||||
['delay' => 'sec'],
|
||||
['timer' => 'sec'],
|
||||
['interval' => 'sec'],
|
||||
['runtime' => 'sec']
|
||||
);
|
||||
|
||||
# Stichwörter, die zeigen, dass _keine_ Einheit vorhanden ist
|
||||
my @nutunitsexclude = ('alarm', 'extended', 'transfer.reason', 'factor');
|
||||
|
||||
|
||||
|
||||
sub NUT_Initialize($) {
|
||||
my ($hash) = @_;
|
||||
|
||||
require "$attr{global}{modpath}/FHEM/DevIo.pm";
|
||||
|
||||
$hash->{DefFn} = "NUT_Define";
|
||||
$hash->{UndefFn} = "NUT_Undef";
|
||||
$hash->{ReadyFn} = "NUT_Ready";
|
||||
$hash->{ReadFn} = "NUT_Read";
|
||||
$hash->{DbLog_splitFn} = "NUT_DbLog_split";
|
||||
|
||||
$hash->{AttrList} = "disable:0,1 pollState pollVal asReadings model serNo";
|
||||
# $readingFnAttributes;
|
||||
|
||||
}
|
||||
|
||||
|
||||
sub NUT_Define($$) {
|
||||
my ( $hash, $def ) = @_;
|
||||
my @a = split( "[ \t][ \t]*", $def );
|
||||
|
||||
|
||||
# Syntaxprüfung
|
||||
|
||||
if (@a < 3 or @a > 4) {
|
||||
my $msg = "wrong syntax: define <name> NUT <upsname> [<host>[:<port>]]";
|
||||
Log3 $hash, 2, $msg;
|
||||
return $msg;
|
||||
}
|
||||
DevIo_CloseDev($hash);
|
||||
|
||||
|
||||
# Parameter auswerten
|
||||
|
||||
my $name = $a[0];
|
||||
$hash->{UpsName} = $a[2];
|
||||
|
||||
my $dev = $a[3];
|
||||
if (defined $dev) {
|
||||
$dev .= ":3493" if ($dev !~ m/:/);
|
||||
} else {
|
||||
$dev = "localhost:3493";
|
||||
}
|
||||
$hash->{DeviceName} = $dev;
|
||||
$hash->{buffer} = '';
|
||||
|
||||
# Defaults setzen
|
||||
|
||||
$attr{$name}{pollState} = 5;
|
||||
$attr{$name}{pollVal} = 60;
|
||||
$attr{$name}{disable} = 0;
|
||||
$attr{$name}{asReadings} = 'battery.charge battery.runtime input.voltage ups.load ups.power ups.realpower';
|
||||
|
||||
$hash->{pollValState} = 0;
|
||||
$hash->{lastStatus} = "";
|
||||
|
||||
return DevIo_OpenDev($hash, 0, "NUT_DevInit");
|
||||
}
|
||||
|
||||
|
||||
sub NUT_Undef($$) {
|
||||
my ($hash, $arg) = @_;
|
||||
my $name = $hash->{NAME};
|
||||
RemoveInternalTimer("pollTimer:".$name);
|
||||
DevIo_CloseDev($hash);
|
||||
return undef;
|
||||
}
|
||||
|
||||
|
||||
sub NUT_Ready($) {
|
||||
my ($hash) = @_;
|
||||
return DevIo_OpenDev($hash, 1, "NUT_DevInit");
|
||||
}
|
||||
|
||||
|
||||
sub NUT_DevInit($) {
|
||||
my ($hash) = @_;
|
||||
|
||||
NUT_ListVar($hash);
|
||||
|
||||
return undef;
|
||||
}
|
||||
|
||||
|
||||
sub NUT_Read($) {
|
||||
my ($hash) = @_;
|
||||
my $name = $hash->{NAME};
|
||||
|
||||
# read from serial device
|
||||
my $buf = DevIo_SimpleRead($hash);
|
||||
return '' if (!defined($buf));
|
||||
|
||||
$hash->{buffer} .= $buf;
|
||||
# Log3 $name, 5, "Current buffer content: " . $hash->{buffer};
|
||||
NUT_Auswertung($hash);
|
||||
|
||||
return '';
|
||||
}
|
||||
|
||||
|
||||
sub NUT_ListVar($) {
|
||||
my ($hash) = @_;
|
||||
my $name = $hash->{NAME};
|
||||
|
||||
if ($attr{$name}{disable} == 0) {
|
||||
# TODO
|
||||
# - Mechanismus, der verhindert, dass lauter Befehle abgesendet werden, während er noch auf Antworten wartet
|
||||
|
||||
if (defined $hash->{WaitForAnswer}) {
|
||||
# Keine Antwort auf die letzte Frage -> NUT nicht mehr erreichbar!
|
||||
Log3 $name, 3, "NUT antwortet nicht";
|
||||
DevIo_Disconnected($hash);
|
||||
DevIo_OpenDev($hash, 0, undef);
|
||||
}
|
||||
|
||||
my $ups = $hash->{UpsName};
|
||||
Log3 $name, 5, "Sending 'LIST VAR $ups'...";
|
||||
DevIo_SimpleWrite($hash, "LIST VAR $ups\n", 0);
|
||||
$hash->{WaitForAnswer} = 1;
|
||||
|
||||
} else {
|
||||
Log3 $name, 5, "NUT polling disabled.";
|
||||
}
|
||||
|
||||
$hash->{pollValState} += $attr{$name}{pollState};
|
||||
RemoveInternalTimer("pollTimer:".$name);
|
||||
InternalTimer(gettimeofday() + $attr{$name}{pollState}, "NUT_PollTimer", "pollTimer:".$name, 0);
|
||||
}
|
||||
|
||||
|
||||
sub NUT_PollTimer($) {
|
||||
my $in = shift;
|
||||
my (undef,$name) = split(':',$in);
|
||||
my $hash = $defs{$name};
|
||||
|
||||
NUT_ListVar($hash);
|
||||
}
|
||||
|
||||
|
||||
sub NUT_Auswertung($) {
|
||||
my ($hash) = @_;
|
||||
my $name = $hash->{NAME};
|
||||
my $buf = $hash->{buffer};
|
||||
|
||||
|
||||
# Fehlermeldungen auswerten
|
||||
while ($buf =~ m/(.*)^ERR (.+?)$(.*)/m) {
|
||||
Log3 $name, 2, "NUT Error: $2";
|
||||
readingsSingleUpdate($hash, 'lastError', $2, 1);
|
||||
# Fehlermeldung rauswerfen
|
||||
$buf = $1 . "\n" . $3;
|
||||
delete $hash->{WaitForAnswer};
|
||||
}
|
||||
$hash->{buffer} = $buf;
|
||||
|
||||
# Auswerten
|
||||
if ($buf =~ m'(.*?)\s*^BEGIN LIST VAR (.+?)$(.*)^END LIST VAR \g2$\s*(.*)'ms) {
|
||||
Log3 $name, 4, "Daten vor LIST VAR:\n'$1'" unless $1 eq "";
|
||||
Log3 $name, 4, "Daten nach LIST VAR:\n'$4'" unless $4 eq "";
|
||||
my $ups = $hash->{UpsName};
|
||||
Log3 $name, 3, "Falsche USV: $2 statt $ups" unless $2 eq $ups;
|
||||
|
||||
# Relevante Daten in den Readings speichern
|
||||
my @readings = split('\n', $3);
|
||||
Log3 $name, 5, "Anzahl Readings von $name: $#readings";
|
||||
|
||||
delete $hash->{helper};
|
||||
foreach (@readings) {
|
||||
# Log3 $name, 5, "Test $_...";
|
||||
if (m/VAR \w+ ([\w\.]+) "(.*)"/) {
|
||||
$hash->{helper}{$1} = $2;
|
||||
# Log3 $name, 5, "... found $1 -> $2";
|
||||
}
|
||||
}
|
||||
|
||||
# set Arrtibutes
|
||||
$attr{$name}{model} = $hash->{helper}{'ups.model'} unless defined $attr{$name}{model};
|
||||
$attr{$name}{serNo} = $hash->{helper}{'ups.serial'} unless defined $attr{$name}{serNo};
|
||||
|
||||
# Create derived readings
|
||||
unless (defined $hash->{helper}{'ups.power'}) {
|
||||
if (defined $hash->{helper}{'ups.load'} and defined $hash->{helper}{'ups.power.nominal'}) {
|
||||
$hash->{helper}{'ups.power'} = $hash->{helper}{'ups.power.nominal'} * $hash->{helper}{'ups.load'} / 100;
|
||||
}
|
||||
}
|
||||
unless (defined $hash->{helper}{'ups.realpower'}) {
|
||||
if (defined $hash->{helper}{'ups.load'} and defined $hash->{helper}{'ups.realpower.nominal'}) {
|
||||
$hash->{helper}{'ups.realpower'} = $hash->{helper}{'ups.realpower.nominal'} * $hash->{helper}{'ups.load'} / 100;
|
||||
}
|
||||
}
|
||||
|
||||
# Einheiten an die Werte anfügen
|
||||
# Das soll ja eigentlich nicht passieren, aber da die interfaces nur sehr unvollständig passen, geht das nicht anders.
|
||||
# Geht das effizienter?
|
||||
my $excl = join('|', @nutunitsexclude);
|
||||
foreach (keys %{$hash->{helper}}) {
|
||||
unless (m/($excl)/) {
|
||||
foreach my $unit (@nutunits) {
|
||||
if (m/$unit->[0]/) {
|
||||
$hash->{helper}{$_} .= ' ' . $unit->[1];
|
||||
last;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Log3 $name, 5, "Set Readings";
|
||||
|
||||
# Der Status wird ja oft abgefragt, um nichts zu verpassen. Damit das nicht jedes Mal
|
||||
# Notifies gibt, wird dieser nur getriggert, wenn sich am Status etwas ändert.
|
||||
# FIXME und was ist mit event-on-*-reading?
|
||||
readingsSingleUpdate($hash, 'state', $hash->{helper}{'ups.status'}, $hash->{helper}{'ups.status'} ne $hash->{lastStatus});
|
||||
$hash->{lastStatus} = $hash->{helper}{'ups.status'};
|
||||
|
||||
if ($hash->{pollValState} > $attr{$name}{pollVal}) {
|
||||
$hash->{pollValState} = 0;
|
||||
readingsBeginUpdate($hash);
|
||||
foreach (split (' ', $attr{$name}{asReadings})) {
|
||||
readingsBulkUpdate($hash, $_, $hash->{helper}{$_}) if defined $hash->{helper}{$_};
|
||||
}
|
||||
readingsEndUpdate($hash, 1);
|
||||
}
|
||||
|
||||
# FIXME Mehrere Readings im Buffer werden hier ignoriert
|
||||
$hash->{buffer} = '';
|
||||
delete $hash->{WaitForAnswer};
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
sub NUT_DbLog_split($) {
|
||||
my ($event) = @_;
|
||||
my ($reading, $value) = split(": ", $event);
|
||||
my $unit = "";
|
||||
|
||||
if ($value =~ m/([\d\.]+) (.*)/) {
|
||||
$value = $1;
|
||||
$unit = $2;
|
||||
}
|
||||
|
||||
return ($reading, $value, $unit);
|
||||
}
|
||||
|
||||
|
||||
1;
|
||||
|
||||
=pod
|
||||
=begin html
|
||||
|
||||
<a name="NUT"></a>
|
||||
<h3>NUT</h3>
|
||||
<ul>
|
||||
The Network UPS Tools (<a href="http://www.networkupstools.org">www.networkupstools.org</a>) provide support for Uninterruptable Power Supplies and the like.
|
||||
This module gives access to a running nut server. You can read data (status, runtime, input voltage, sometimes even temperature and so on). In the future it will
|
||||
also be possible to control the UPS (start test, switch off).<br>
|
||||
Which values you can use as readings is set with <a href="#NUT_asReadings">asReadings</a>. Which values are available with this UPS, you can check with
|
||||
<code>list theUPS</code>. Only ups.status is always read and used as the status of the device.<br>
|
||||
In addition to the values which are provided by the UPS there are some values calculated by the module, if they are not provided by the UPS. At the moment these are
|
||||
<ul>
|
||||
<li>ups.power = ups.power.nominal * ups.load / 100</li>
|
||||
<li>ups.realpower = ups.realpower.nominal * ups.load / 100</li>
|
||||
</ul>
|
||||
|
||||
<br><br>
|
||||
|
||||
<a name=NUTdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <name> NUT <ups> [<host>[:<port>]]</code> <br>
|
||||
<br>
|
||||
<ups> is the name of a ups defined in the nut server.
|
||||
<br>
|
||||
[<host>[:<port>]] is the host of the nut server. If omitted, <code>localhost:3493</code> is used.
|
||||
<br><br>
|
||||
Example: <br>
|
||||
<code>define theUPS NUT myups otherserver</code>
|
||||
<br>
|
||||
</ul>
|
||||
<br>
|
||||
|
||||
<a name="NUTset"></a>
|
||||
<b>Set</b> <ul>N/A</ul><br>
|
||||
|
||||
<a name="NUTget"></a>
|
||||
<b>Get</b> <ul>N/A</ul><br>
|
||||
|
||||
<a name="NUTattr"></a>
|
||||
<b>Attributes</b>
|
||||
<ul>
|
||||
<li><a href="#disable">disable</a></li><br>
|
||||
<li><a name="">pollState</a><br>
|
||||
Polling interval in seconds for the state of the ups. Default: 5</li><br>
|
||||
<li><a name="">pollVal</a><br>
|
||||
Polling interval in seconds of the other Readings. This should be a multiple of pollState. Default: 60</li><br>
|
||||
<li><a name="">asReadings</a><br>
|
||||
Values of the UPS which are used as Readings<br>
|
||||
Example:<br>
|
||||
<code>attr theUPS asReadings battery.charge battery.runtime input.voltage ups.load ups.power ups.realpower</code> </li><br>
|
||||
<li><a name="">model</a><br>
|
||||
This is automatically filled with the model name of the UPS.</li><br>
|
||||
<li><a name="">serNo</a><br>
|
||||
This is automatically filled with the serial number of the UPS.</li><br>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
=end html
|
||||
|
||||
=begin html_DE
|
||||
|
||||
<a name="NUT"></a>
|
||||
<h3>NUT</h3>
|
||||
<ul>
|
||||
Die Network UPS Tools (<a href="http://www.networkupstools.org">www.networkupstools.org</a>) bieten Unterstützung für Unterbrechungsfreie Stromversorgungen (USV)
|
||||
und ähnliches. Dieses Modul ermöglicht den Zugriff auf einen NUT-Server, womit man Daten auslesen kann (z.B. den Status, Restlaufzeit, Eingangsspannung, manchmal
|
||||
auch Temperatur u.ä.) und zukünftig die USV auch steuern kann (Test aktivieren, USV herunterfahren u.ä.).<br>
|
||||
Welche Readings zur Verfügung stehen, bestimmt das Attribut <a href="#NUT_asReadings">asReadings</a>. Welche Werte eine USV zur Verfügung stellt, kann man mit
|
||||
<code>list dieUSV</code> unter <i>Helper:</i> ablesen. Nur ups.status wird immer ausgelesen und ergibt den Status des Geräts.<br>
|
||||
Zusätzlich zu den Werten, die die USV zur Verfügung stellt, werden ggf. noch weitere Werte berechnet, falls sie nicht durch die USV geliefert werden. Zur Zeit sind dies
|
||||
<ul>
|
||||
<li>ups.power = ups.power.nominal * ups.load / 100</li>
|
||||
<li>ups.realpower = ups.realpower.nominal * ups.load / 100</li>
|
||||
</ul>
|
||||
|
||||
<br><br>
|
||||
|
||||
<a name=NUTdefine"></a>
|
||||
<b>Define</b>
|
||||
<ul>
|
||||
<code>define <name> NUT <ups> [<host>[:<port>]]</code> <br>
|
||||
<br>
|
||||
<ups> ist der im NUT-Server definierte Name der USV.
|
||||
<br>
|
||||
[<host>[:<port>]] ist Host und Port des NUT-Servers. Default ist <code>localhost:3493</code>.
|
||||
<br><br>
|
||||
Beispiel: <br>
|
||||
<code>define dieUSV NUT myups einserver</code>
|
||||
<br>
|
||||
</ul>
|
||||
<br>
|
||||
|
||||
<a name="NUTset"></a>
|
||||
<b>Set</b> <ul>N/A</ul><br>
|
||||
|
||||
<a name="NUTget"></a>
|
||||
<b>Get</b> <ul>N/A</ul><br>
|
||||
|
||||
<a name="NUTattr"></a>
|
||||
<b>Attributes</b>
|
||||
<ul>
|
||||
<li><a href="#disable">disable</a></li><br>
|
||||
<li><a name="">pollState</a><br>
|
||||
Polling-Intervall in Sekunden für den Status der USV. Default: 5</li><br>
|
||||
<li><a name="">pollVal</a><br>
|
||||
Polling-Intervall für die anderen Werte. Dieser Wert wird auf ein Vielfaches von pollState gerundet. Default: 60</li><br>
|
||||
<li><a name="NUT_asReadings">asReadings</a><br>
|
||||
Mit Leerzeichen getrennte Liste der USV-Werte, die als Readings verwendet werden sollen.<br>
|
||||
Beispiel:<br>
|
||||
<code>attr dieUSV asReadings battery.charge battery.runtime input.voltage ups.load ups.power ups.realpower</code> </li><br>
|
||||
<li><a name="">model</a><br>
|
||||
Wird automatisch mit der Modellbezeichnung der USV gefüllt.</li><br>
|
||||
<li><a name="">serNo</a><br>
|
||||
Wird automatisch mit der Seriennummer der USV gefüllt.</li><br>
|
||||
</ul>
|
||||
</ul>
|
||||
|
||||
=end html_DE
|
||||
=cut
|
||||
|
||||
@ -592,3 +592,6 @@
|
||||
|
||||
- Sun Aug 03 2014 (xusader)
|
||||
- added new module 70_PushNotifier.pm to support Push Messages with PushNotifier
|
||||
|
||||
- Mon Sep 22 2014 (creideiki)
|
||||
- added new module 34_NUT to support the Network UPS Tools
|
||||
|
||||
@ -107,6 +107,7 @@ FHEM/33_readingsGroup.pm justme1968 http://forum.fhem.de Frontends
|
||||
FHEM/33_readingsHistory.pm justme1968 http://forum.fhem.de Frontends
|
||||
FHEM/33_readingsProxy.pm justme1968 http://forum.fhem.de Automatisierung
|
||||
FHEM/32_speedtest.pm justme1968 http://forum.fhem.de Sonstiges
|
||||
FHEM/34_NUT.pm creideiki http://forum.fhem.de Sonstige Systeme
|
||||
FHEM/34_panStamp.pm justme1968 http://forum.fhem.de Sonstige Systeme
|
||||
FHEM/34_SWAP.pm justme1968 http://forum.fhem.de Sonstige Systeme
|
||||
FHEM/35_SWAP_0000002200000003.pm justme1968 http://forum.fhem.de Sonstige Systeme
|
||||
|
||||
Loading…
Reference in New Issue
Block a user