http://wiki.fhem.de/w/api.php?action=feedcontributions&user=DelMar&feedformat=atomFHEMWiki - Benutzerbeiträge [de]2024-03-28T15:49:23ZBenutzerbeiträgeMediaWiki 1.39.3http://wiki.fhem.de/w/index.php?title=ZoneMinder&diff=35551ZoneMinder2021-04-20T17:51:59Z<p>DelMar: Kameraprobleme erläutert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Integration mit Events und Kamerasteuerung der ZoneMinder API<br />
|ModType=d<br />
|ModFTopic=91847<br />
|ModTechName=70_ZoneMinder.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
[[ZoneMinder]] ist eine OpenSource Video-Überwachungssoftware. Das modulare Konzept ermöglicht die Integration von Kameras aller Art (IP, Analog, ...) und bietet Bewegungserkennung, verschiedene Aufnahmemodi und Alarmierung.<br />
Mehr Informationen zu Features findet man auf [https://zoneminder.com zoneminder.com], Informationen zur hier angebundenen API gibt es auf [https://zoneminder.readthedocs.io/en/stable/api.html zoneminder.readthedocs.io].<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
ZoneMinder bietet mehrere Arten der Integration, die einzeln in den Optionen aktiviert werden müssen. In der original Doku werden Kameras als Monitor bezeichnet.<br />
<br />
=== Abhängigkeiten ===<br />
Folgende Perl-Libs werden benötigt:<br />
<code>libcrypt-mysql-perl</code><br />
<br />
=== Alerting ===<br />
Wenn ZoneMinder Bewegungen erkennt, wird die jeweilige Kamera für bestimmte Zeit in den Alarm-Modus versetzt.<br />
Damit auch andere Anwendungen diesen Alarmzustand auswerten können, muss in den Optionen im Tab System die Option <code>OPT_TRIGGERS</code> aktiviert werden.<br />
Rein technisch öffnet ZoneMinder mit dieser Option den TCP-Port 6802, zu welchem sich FHEM verbindet und unmittelbar über neue Ereignisse informiert wird.<br />
Das [https://wiki.zoneminder.com/How_to_use_your_external_camera%27s_motion_detection_with_ZM ZoneMinder-Wiki] enthält detailierte Informationen dazu.<br />
<br />
=== Aufzeichnung und Bewegungserkennung ===<br />
Kameras in ZoneMinder kennen unterschiedliche Betriebsarten ([https://zoneminder.readthedocs.io/en/stable/userguide/definemonitor.html Quelle]):<br />
* '''None''' – Die Kamera ist deaktiviert. Streaming, Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Monitor''' – Die Kamera wird nur für Live-Streaming verwendet. Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Modect''' – steht für MOtion DEteCTtion. Sobald eine Bewegung erkannt wird, wird ein Event generiert und die Aufzeichnung gestartet.<br />
* '''Record''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Dieser Modus kennt keine Bewegungserkennung.<br />
* '''Mocord''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Bewegungen werden innerhalb der Aufnahme als Events markiert.<br />
* '''Nodect''' – steht für No DEteCTtion. Dieser Modus wurde für externe Trigger eingeführt. Es erfolgt keine Bewegungserkennung, die Aufzeichnung kann aber durch externe Trigger gestartet werden. Dies könnten eigene Bewegungsmelder sein, oder aber auch FHEM (Trigger an ZoneMinder zb über <code>set ZM_Monitor_xyz Alarm on|off|on-for-timer <sekunden></code>).<br />
Daneben kann pro Kamera die Bewegungserkennung auch noch explizit aktiviert und deaktiviert werden. Der Begriff Enabled/disabled kann hier irreführend sein, da nicht die Kamera als solche, sondern nur die Bewegungserkennung betroffen ist.<br />
Um eine Kamera zu deaktivieren, muss der Betriebsmodus auf None gestellt werden.<br />
<br />
== Einbindung in FHEM ==<br />
Das FHEM Modul kann in drei Ausbaustufen verwendet werden.<br />
=== Events und Alerting ===<br />
Mit folgender definition wird nur das weitergeben von Events nach ZM aktiviert:<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host><br />
</syntaxhighlight><br />
Beispiel<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder 192.168.1.1<br />
</syntaxhighlight><br />
Diese IP wird - wie oben beschrieben - verwendet, um den Event-Port von ZoneMinder zu öffnen.<br />
In den ZoneMinder Optionen muss hierfür ZM_TRIGGERS aktiv sein.<br />
<br />
=== ZoneMinder 1.32 und später ===<br />
Ab ZoneMinder 1.32 muss das folgende Attribut gesetzt sein, damit sich dieses FHEM-Modul an der ZoneMinder API anmelden kann.<br />
<syntaxhighlight lang="perl">attr zm apiVersion post132</syntaxhighlight><br />
<br />
=== ZoneMinder API ===<br />
Um Kamera-Modi in FHEM verändern und auslesen zu können, muss auf die ZoneMinder-API zugegriffen werden.<br />
Die Authentifizierung hierfür besteht (noch) aus ''username'' und ''password''.<br />
Aus Sicherheitsgründen bietet es sich evtl an, einen eigenen User für FHEM einzurichten, der nur die nötigen Rechte hat.<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host> <ZM-Username> <ZM-Password><br />
</syntaxhighlight><br />
<br />
Mit diesen Parametern kann außerdem direkt von ZoneMinder nach FHEM gestreamt werden und das Reading <code>streamUrl</code> wird verfügbar.<br />
Wichtig: diese Stream-URL enthält username und password als GET-Parameter. Diese sind also in der URL sichtbar, was tatsächlich ein Sicherheitsproblem darstellt.<br />
<br />
Damit die API verwendet werden kann, muss in den ZoneMinder Optionen <code>OPT_USE_API</code> aktiviert sein.<br />
<br />
=== Kameramodi setzen ===<br />
ZoneMinder selber kennt zwar unterschiedliche Aufzeichnungsmodi, kann diese aber nicht Zeit- oder Ereignisgesteuert verändern. FHEM füllt diese Lücke und kann die folgenden Kommandos an ZoneMinder senden:<br />
* '''alarmState''': Alert state in ZoneMinder setzen.<br />
* '''monitorFunction''': Entspricht 'Function' in ZoneMinder.<br />
* '''motionDetectionEnabled''': Entspricht 'Enabled' in ZoneMinder<br />
* '''text''': Setzt einen freien Text im Timestamp der Kamera. Der Timestamp der Kamera muss <code>%Q</code> enthalten und ZoneMinder muss uU neu gestartet werden, nachdem <code>%Q</code> hinzugefügt wurde.<br />
<br />
=== Public Streaming-URLs ===<br />
Hierfür muss als Attribut eine öffentlich erreichbare Adresse für ZoneMinder angegeben werden:<br />
<syntaxhighlight lang="perl"><br />
attr zm publicAddress https://my.home.server.net:8043<br />
</syntaxhighlight><br />
Damit wird in den ZM_Monitor Devices neben <code>streamUrl</code> auch noch ein Reading <code>pubStreamUrl</code> erzeugt.<br />
Für dieses Reading wird das eben angegebene Attribut mit dem Wert <code>PATH_ZMS</code> aus der ZoneMinder Konfiguration kombiniert.<br />
<br />
=== Auth Hash ===<br />
Um nicht username und Password öffentlich sichtbar machen zu müssen, bietet ZoneMinder auch das Sicherheitskonzept des Auth-Hash.<br />
Wenn FHEM erkennt, dass in ZoneMinder <code>AUTH_HASH_SECRET</code> und <code>AUTH_HASH_LOGINS</code> konfiguriert sind, wird der Auth-Hash errechnet. Für public streaming URLs wird dann automatisch der Auth-Hash anstatt Username und Passwort verwendet.<br />
Somit kann die URL auch nach außen gegeben werden.<br />
Wie vorher erwähnt, wird diese nach maximal zwei Stunden ungültig.<br />
Für den Login wird der Auth-Hash übrigens nicht akzeptiert, dh man kann maximal für zwei Stunden den Stream sehen, aber der Auth-Hash berechtigt nicht zum Verändern von Werten.<br />
Das FHEM-ZoneMinder Modul errechnet den Auth-Hash jede Stunde neu, somit sollten die Readings immer einen gültigen Hash liefern.<br />
<br />
Bitte beachten, dass das Einbeziehen der IP für den Auth-Hash derzeit nicht unterstützt wird.<br />
<br />
=== Link zur ZoneMinder Console ===<br />
Das ZoneMinder Device zeigt ganz oben einen Link zur ZoneMinder Console (dem Web UI) an.<br />
Ist <code>publicAddress</code> als Attribut definiert, wird dieser Link mit der publicAddress gebildet und sollte auch im Internet funktionieren.<br />
Wer will, kann so bequem von FHEM aus nach ZoneMinder wechseln.<br />
<br />
=== Live-Streams in FHEMWEB anzeigen ===<br />
Wer auf der Detailseite eines ZM_Monitor Devices auch gleich den Live-Stream sehen will, kann das Attribut <code>showLiveStreamInDetail</code> auf <code>1</code> setzen.<br />
<br />
== Probleme mit ZoneMinder ==<br />
Bei Problemen mit ZoneMinder sollten natürlich zuerst die Doku unter https://zoneminder.readthedocs.io/ oder das Forum unter https://forums.zoneminder.com/ konsultiert werden.<br />
<br />
Trotzdem sollen auch hier spezielle Probleme festgehalten werden.<br />
<br />
=== Kamera funktioniert nach ZoneMinder Upgrade auf neue Version nicht mehr zuverlässig ===<br />
ZoneMinder hat eine fixe Abhängigkeit zu FFmpeg und nutzt nur dessen Funktionen. Leider kann die Kompatibilität von FFmpeg zu einer bestimmten Kamera in neueren Versionen schlechter werden.<br />
<br />
Die Reolink RLC-410 mit Firmware v2.x funktioniert mit FFmpeg 3.x einwandfrei, zieht mit FFmpeg 4.x aber schlieren und hat oft ein verschwommenes Bild. ZoneMinder kann hier nix dafür; FFmpeg ist das Problem.<br />
<br />
Oft geht ein ZoneMinder Upgrade Hand in Hand mit einem Upgrade des Betriebssystems, was dann auch zu einer neuen FFmpeg Version führt, und Kameraprobleme verursacht.<br />
<br />
Kompiliert man eine fixe FFmpeg Version von Hand, muss sichergestellt werden, dass auch die shared libs daraus installiert werden (nicht nur das Binary), weil ZoneMinder tatsächlich über die shared library auf FFmpeg Funktionalität zugreift, nicht über das Binary (Ausnahme: Export von Videos).<br />
<br />
== Installation des Moduls ==<br />
Das grunsätzliche Setup sollte hier ausreichend beschrieben sein. Seit Oktober 2018 ist das Modul offizieller Bestandteil von FHEM.<br />
Weitere Hintergrund-Infos finden sich außerdem noch [https://forum.fhem.de/index.php/topic,34570.msg828862.html#msg828862 im Forum].<br />
<br />
== Troubleshooting des Moduls ==<br />
'''Problem:''' ZoneMinder selber funktioniert, allerdings kann FHEM keine Verbindung zur API herstellen. Das Log liefert immer HTTP-404<br />
<br />
'''Antwort:''' Das Problem wird hier diskutiert: https://forums.zoneminder.com/viewtopic.php?t=28554</div>DelMarhttp://wiki.fhem.de/w/index.php?title=HttpUtils&diff=35435HttpUtils2021-04-08T06:38:32Z<p>DelMar: tippfehler incrementalTimout ausgebessert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Hilfsfunktionen für HTTP-Zugriffe<br />
|ModType=u<br />
|ModForumArea=Automatisierung<br />
|ModTechName=HttpUtils.pm<br />
|ModOwner=rudolfkoenig ({{Link2FU|8|Forum}} / [[Benutzer Diskussion:Rudolfkoenig|Wiki]])<br />
}}<br />
<br />
Das Modul [[HttpUtils]](.pm) ist sowohl für Modulentwickler als auch für Endanwender gedacht, um Daten via HTTP auszutauschen. Es stellt dabei eine Reihe von Funktionen zur Verfügung und wird beispielsweise vom Modul [[HTTPMOD]] intensiv genutzt.<br />
<br />
== Primäre Funktionen (HTTP) ==<br />
Es ist zu beachten, dass bei den Funktionen<br />
* <code>GetHttpFile()</code><br />
* <code>GetFileFromURL</code><br />
* <code>GetFileFromURLQuiet</code><br />
* <code>HttpUtils_BlockingGet</code><br />
ein sogenannter "blockierender" Aufruf durchgeführt wird. Das bedeutet, dass FHEM bei einem Aufruf einer dieser Funktionen solange wartet und dabei absolut nichts macht, bis die Antwort vom HTTP-Server eintrifft und die Funktion damit beendet ist. Das kann bei Verbindungsproblemen evtl. dazu führen, dass FHEM für die gesamte Wartezeit (Timeout) steht und nichts verarbeitet. Problematisch ist das gerade bei Anwendungen oder Hardware, die eine zeitnahe Reaktion von FHEM erwarten (z.B. HomeMatic-Geräte). In der Zeit, in der auf eine HTTP Antwort gewartet wird, steht FHEM dabei komplett. <br />
<br />
Es wird daher empfohlen, die Funktionen so sparsam wie möglich zu verwenden und die Timeouts so niedrig wie möglich zu halten, um ein längeres Einfrieren von FHEM möglichst zu vermeiden.<br />
<br />
Um eine Blockierung zu vermeiden wird generell die Verwendung von<br />
:<code>HttpUtils_NonblockingGet</code><br />
empfohlen. Diese führt den HTTP-Request asynchron durch, wodurch ein Blockieren von FHEM verhindert wird. Wie das genau funktioniert, wird in dem entsprechenden Kapitel beschrieben.<br />
<br />
=== GetHttpFile ===<br />
Die Funktion GetHttpFile ist die denkbar einfachste Variante um eine URL aufzurufen. <br />
:<code>GetHttpFile($server, $file)</code><br />
{| class="wikitable"<br />
|-<br />
! Parameter!! Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$server</code>'''<br />
<br />
''mandatory''<br />
|| Der DNS-Name oder die IP-Adresse des HTTP-Servers<br><br />
Beispiel:<br />
<br />
* ''<nowiki>www.myhost.com</nowiki>''<br />
* ''<nowiki>192.168.0.10</nowiki>''<br />
|-<br />
| style="vertical-align:top" | '''<code>$file</code>''' <br />
<br />
''mandatory''<br />
|| Die Datei, welche auf dem HTTP-Server aufgerufen werden soll.<br><br />
Beispiel:<br />
* ''/''<br />
* ''/index.html''<br />
* ''/directory/image.jpg''<br />
|}<br />
<br />
Funktionsergebnis ist der Inhalt der aufgerufenen Seite in Form einer Zeichenkette.<br />
<br />
=== GetFileFromURL ===<br />
Die Funktion GetFileFromURL ruft die HTTP-URL auf und gibt als Funktionsergebnis den Seiteninhalt zurück. Im Gegensatz zu GetHttpFile beinhaltet GetFileFromURL einige Zusatzoptionen in Form von Funktionsparametern.<br />
<br />
'''Aufruf: <code>GetFileFromURL($url, ''[$timeout], [$data], [$noshutdown], [$loglevel]'')</code>'''<br />
<br />
{| class="wikitable"<br />
|-<br />
! Parameter!! Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$url</code>'''<br />
<br />
''mandatory''<br />
|| Die HTTP-URL, welche aufgerufen werden soll. Diese kann optional Usernamen, Passwort und einen Port enthalten. Sowohl HTTP als auch HTTPS wird hierbei unterstützt.<br><br />
Beispiel:<br />
<br />
* ''<nowiki>http://www.myhost.com/directory/</nowiki>''<br />
* ''<nowiki>https://www.myhost.com/</nowiki>''<br />
* ''<nowiki>http://www.myhost.com:8080/</nowiki>''<br />
* ''<nowiki>http://user:password@www.myhost.com/</nowiki>''<br />
<br />
'''WICHTIG:''' Falls ein Username sowie Passwort übergeben werden, so müssen diese vorher jeweils mittels [[#urlEncode|urlEncode()]] in URL-kompatible Form umgewandelt werden um Probleme mit evtl. enthaltenen Sonderzeichen zu vermeiden. <br />
|-<br />
| style="vertical-align:top" | '''<code>$timeout</code>'''<br />
<br />
''optional''<br />
|| Die maximale Dauer in Sekunden für die HTTP-Anfrage<br />
<br />
Beispiel: 5 ''(Sekunden)''<br />
<br />
Standardwert: 4 Sekunden<br />
|-<br />
| style="vertical-align:top" | '''<code>$data</code>'''<br />
<br />
''optional''<br />
|| Wenn man Daten via HTTP-POST übertragen möchte, so kann man die Nutzdaten über $data übergeben. Die Daten werden dabei als Formulardaten übertragen. Wenn man den Content-Type beeinflussen oder mehrere Formular-Felder senden möchte, sollte man zur Funktion HttpUtils_BlockingGet oder HttpUtils_NonblockingGet greifen.<br />
<br />
Standardwert: ''[leer]''<br />
<br />
|-<br />
| style="vertical-align:top" | '''<code>$noshutdown</code>''' <br />
<br />
''optional''<br />
|| Wenn $noshutdown auf 1 gesetzt ist, wird dem HTTP-Server nicht implizit mitgeteilt, dass die Verbindung nach dem Request geschlossen werden soll. Viele Webserver schließen in solch einem Fall die Verbindung, bevor sie die Antwort senden. Bei 0 wird dem Webserver mitgeteilt, dass der Sendevorgang beendet ist und nun die Antwort abgewartet wird.<br />
<br />
Standardwert: 1<br />
|-<br />
| style="vertical-align:top" | '''<code>$loglevel</code>'''<br />
<br />
''optional''<br />
|| Das [[verbose|Loglevel]], in dem sämtliche Logmeldungen zu dieser HTTP-Abfrage erzeugt werden sollen.<br />
<br />
Standardwert: 4<br />
|}<br />
<br />
Funktionsergebnis ist der Inhalt der aufgerufenen Seite in Form eines Strings.<br />
<br />
=== GetFileFromURLQuiet ===<br />
Diese Funktion funktioniert ähnlich wie GetFileFromURL. Allerdings wird die tatsächliche URL in allen erzeugten Log-Meldungen unkenntlich gemacht um z.B. Zugangsdaten nicht preiszugeben. Die aufgerufene Seite wird ebenfalls als Funktionsergebnis zurückgegeben.<br />
<br />
'''Aufruf: <code>GetFileFromURLQuiet($url, ''[$timeout], [$data], [$noshutdown], [$loglevel]'')</code>'''<br />
<br />
{| class="wikitable"<br />
|-<br />
! Parameter!! Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$url</code>'''<br />
<br />
''mandatory''<br />
|| Die HTTP-URL, welche aufgerufen werden soll. Diese kann optional Usernamen, Passwort und einen Port enthalten. Sowohl HTTP als auch HTTPS wird hierbei unterstützt.<br><br />
Beispiel:<br />
<br />
* ''<nowiki>http://www.myhost.com/directory/</nowiki>''<br />
* ''<nowiki>https://www.myhost.com/</nowiki>''<br />
* ''<nowiki>http://www.myhost.com:8080/</nowiki>''<br />
* ''<nowiki>http://user:password@www.myhost.com/</nowiki>''<br />
<br />
'''WICHTIG:''' Falls ein Username sowie Passwort übergeben werden, so müssen diese vorher jeweils mittels [[#urlEncode|urlEncode()]] in URL-kompatible Form umgewandelt werden um Probleme mit evtl. enthaltenen Sonderzeichen zu vermeiden. <br />
|-<br />
| style="vertical-align:top" | '''<code>$timeout</code>'''<br />
<br />
''optional''<br />
|| Die maximale Dauer in Sekunden für die HTTP-Anfrage<br />
<br />
Beispiel: 5 ''(Sekunden)''<br />
<br />
Standardwert: 4 Sekunden<br />
|-<br />
| style="vertical-align:top" | '''<code>$data</code>'''<br />
<br />
''optional''<br />
|| Wenn man Daten via HTTP-POST übertragen möchte, so kann man die Nutzdaten über <code>$data</code> übergeben. Die Daten werden dabei als Formulardaten übertragen. Wenn man den Content-Type beeinflussen möchte, oder mehrere Formular-Felder senden möchte, sollte man zur Funktion HttpUtils_BlockingGet oder HttpUtils_NonblockingGet greifen.<br />
<br />
Standardwert: ''[leer]''<br />
<br />
|-<br />
| style="vertical-align:top" | '''<code>$noshutdown</code>''' <br />
<br />
''optional''<br />
|| Wenn $noshutdown auf 1 gesetzt ist, wird dem HTTP-Server nicht implizit mitgeteilt, dass die Verbindung nach dem Request geschlossen werden soll. Viele Webserver schließen in solch einem Fall die Verbindung bevor, sie die Antwort senden. Bei 0 wird dem Webserver mitgeteilt, dass der Sendevorgang beendet ist und nun die Antwort abgewartet wird.<br />
<br />
Standardwert: 1<br />
|-<br />
| style="vertical-align:top" | '''<code>$loglevel</code>'''<br />
<br />
''optional''<br />
|| Das Loglevel, in dem sämtliche Logmeldungen zu dieser HTTP-Abfrage erzeugt werden sollen.<br />
<br />
Standardwert: 4<br />
|}<br />
<br />
Funktionsergebnis ist der Inhalt der aufgerufenen Seite in Form eines Strings.<br />
<br />
=== HttpUtils_BlockingGet ===<br />
Wenn die bisher genannten Funktionen nicht ausreichen um die gewünschte Abfrage durchzuführen, so kann man diese Funktion verwenden. Aufgrund zahlreicher Parameter ermöglicht sie viele Anpassungsmöglichkeiten. Diese Funktion hat dabei nicht wie üblich eine Liste an Funktionsparametern, sondern lediglich einen Parameter, welcher eine Hashreferenz mit allen Funktionsparametern darstellt. Dieser Hash enthält sämtliche Parameter inkl. Werten. <br />
<br />
'''Aufruf: <code>HttpUtils_BlockingGet($param)</code>'''<br />
<br />
Der Parameter $param ist eine Referenz auf eine Hash-Struktur, welche die einzelnen Parameter enthält. Der Hash $param kann folgende Optionen beinhalten:<br />
<br />
{| class="wikitable"<br />
|-<br />
! style="width:175px" | Parameter !! style="width:auto" | Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{url}</code>'''<br />
<br />
''mandatory''<br />
|| Die HTTP-URL, welche aufgerufen werden soll. Diese kann optional Usernamen, Passwort und einen Port enthalten. Sowohl HTTP als auch HTTPS wird hierbei unterstützt.<br><br />
Beispiel:<br />
<br />
* ''<nowiki>http://www.myhost.com/directory/</nowiki>''<br />
* ''<nowiki>https://www.myhost.com/</nowiki>''<br />
* ''<nowiki>http://www.myhost.com:8080/</nowiki>''<br />
* ''<nowiki>http://user:password@www.myhost.com/</nowiki>''<br />
<br />
'''WICHTIG:''' Alternativ können die Zugangsdaten auch in <code>$param->{user}</code> und <code>$param->{pwd}</code> übergeben werden. Falls Username und Passwort in der URL übergeben werden, so müssen diese vorher jeweils mittels [[#urlEncode|urlEncode()]] in URL-kompatible Form umgewandelt werden um Probleme mit evtl. enthaltenen Sonderzeichen (z.B. ":" und "@") zu vermeiden, da sonst die URL nicht mehr einer validen Syntax entspricht. <br />
|-<br />
| style="vertical-align:top" |'''<code>$param->{timeout}</code>'''<br />
<br />
''optional''<br />
|| Die maximale Dauer in Sekunden bis der Server eine Antwort liefern muss. Andernfalls wird der Request mit einer Fehlermeldung abgebrochen.<br />
<br />
Beispiel: 5 ''(Sekunden)''<br />
<br />
Standardwert: 4 Sekunden<br />
|-<br />
| style="vertical-align:top" |'''<code>$param->{data}</code>'''<br />
<br />
''optional''<br />
|| Wenn man Daten via HTTP-POST übertragen möchte, so kann man die Nutzdaten über <code>$param->{data}</code> übergeben. Die Daten werden dabei als Formulardaten übertragen. Die Daten können dabei auf zwei Arten übergeben werden:<br />
<br />
1. Daten als Zeichenkette:<br />
:* Die Daten werden komplett als gesamte Zeichenkette in <code>$param->{data}</code> abgelegt (z.B.: <code>$param->{data} = "Jede Menge tolle Daten"</code>).<br />
2. Daten als Hash-Struktur:<br />
:* Die Daten werden als Hash mit Key-Value-Pairs übergeben (z.B.: <code>$param->{data}{field1} = "value1", $param{data}{field2} = "value2", ...</code> ). Die Daten werden dann als Formulardaten mit mehrfachen Datenfeldern übertragen.<br />
<br />
Standardwert: ''[leer]''<br />
<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{user}</code>''' <br />
<br />
''optional''<br />
||Im Falle einer notwendigen HTTP-Authentifizierung, der zu benutzende Username um sich gegenüber dem Server zu identifizieren. Alternativ kann der Username und das Passwort auch direkt in der URL mitgegeben werden (siehe jedoch <code>$param->{hideurl}</code>).<br />
<br />
Standardwert: ''[leer]''<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{pwd}</code>''' <br />
<br />
''optional''<br />
||Im Falle einer notwendigen HTTP-Authentifizierung, das zu benutzende Passwort um sich gegenüber dem Server zu identifizieren. Alternativ kann der Username und das Passwort auch direkt in der URL mitgegeben werden (siehe jedoch <code>$param->{hideurl}</code>).<br />
Standardwert: ''[leer]''<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{noshutdown}</code>''' <br />
<br />
''optional''<br />
||Wenn <code>$param->{noshutdown}</code> auf 1 gesetzt ist, wird dem HTTP-Server nicht implizit mitgeteilt, dass die Verbindung nach dem Request geschlossen werden soll. Viele Webserver schließen in solch einem Fall die Verbindung, bevor sie die Antwort senden. Bei 0 wird dem Webserver mitgeteilt, dass der Sendevorgang beendet ist und nun die Antwort abgewartet wird.<br />
<br />
Standardwert: 1<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{loglevel}</code>'''<br />
<br />
''optional''<br />
|| Das Loglevel, in dem sämtliche Logmeldungen zu dieser HTTP-Abfrage erzeugt werden sollen.<br />
<br />
Standardwert: 4<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{hideurl}</code>'''<br />
<br />
''optional''<br />
|| Wenn dieser Parameter den Wert 1 trägt, wird die gesamte URL in sämtlichen Log-Ausgaben unkenntlich gemacht. Dies notwendig, wenn z.B. Zugangsdaten direkt in der URL angegeben wurden, oder die URL ein geheimes Token oder andere schützenswerte Informationen enthält.<br />
<br />
Standardwert: 0<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{ignoreredirects}</code>'''<br />
<br />
''optional''<br />
|| Wenn dieser Parameter den Wert 1 trägt, werden Umleitungen durch den Server ignoriert und der Request beendet. Dies kann erforderlich sein um evtl. Cookies aus der Antwort, welche eine Umleitung enthält aus dem HTTP Header zu extrahieren um diese im nächsten Request weiterzuverwenden.<br />
<br />
Standardwert: 0<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{method}</code>'''<br />
<br />
''optional''<br />
||Die HTTP-Methode, welche zur Abfrage verwendet werden soll. Sofern keine Daten übertragen werden ist dies standardmäßig "GET", ansonsten "POST". Es können aber auch andere Methoden verwendet werden.<br />
<br />
Standardwert: "GET"<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{keepalive}</code>'''<br />
<br />
''optional''<br />
||Wenn dieser Parameter auf 1 gesetzt ist, wird dem Server der Wunsch mitgeteilt, die Verbindung offen zu lassen für weitere Anfragen. Sobald die Antwort auf den jeweiligen Request eintrifft, bleibt die TCP-Verbindung bestehen (sofern der Server dies unterstützt). Anschließend kann man den Parameter-Hash mit einer neuen URL und Optionen füllen. Der Parameter "keepalive" sollte dabei weiterhin gesetzt bleiben, sofern die Verbindung auch weiterhin möglichst erhalten bleiben soll. <br />
<br />
Um eine offene Verbindung endgültig zu schließen, muss die Funktion [[HttpUtils#HttpUtils_Close|HttpUtils_Close]] aufgerufen werden.<br />
<br />
Standardwert: 0<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{header}</code>'''<br />
<br />
''optional''<br />
|| Eigene HTTP-Header-Zeilen können über diesen Parameter eingebracht werden. Er kann dazu genutzt werden um z.B. den Content-Type festzulegen, oder einfach nur zusätzliche Header-Felder zu setzen. Es gibt zwei Möglichkeiten, diesen Parameter zu befüllen.<br />
<br />
# Als '''Zeichenkette'''. Mehrere Header-Zeilen müssen dabei mit "\r\n" getrennt werden.<br />
# Als '''Hash-Struktur'''. Hierbei findet eine Zuordnung von Header-Bezeichnung zum Wert als Key-Value-Pair statt.<br />
<br />
Beispiel:<br />
* <code>"User-Agent: Mozilla/1.22'''<u>\r\n</u>'''Content-Type: application/xml"</code><br />
* <code>"Content-Type: application/xml"</code><br />
* <code>{ "User-Agent" => "Mozilla/1.22", "Content-Type" => "application/xml" }</code><br />
* <code>{ "Content-Type" => "application/xml" }</code><br />
<br />
Standardwert: ''[leer]''<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{sslargs}</code>'''<br />
<br />
''optional''<br />
|| Eigene SSL-Optionen können über diesen Parameter eingebracht werden. Er kann dazu genutzt werden um z.B. die SSL-Zertifikats Verifikation abzuschalten. Die SSL-Optionen müssen als eigene Hash-Referenz übergeben werden. Eine Liste aller möglichen Optionen findet man in der Perl-Dokumentation zu [http://search.cpan.org/~sullr/IO-Socket-SSL-2.016/lib/IO/Socket/SSL.pod#Description_Of_Methods IO::Socket::SSL].<br />
<br />
Beispiel:<br />
* <code>$param->{sslargs} = { SSL_verify_mode => 0, sslOpt2 => 'sslVal2' }</code><br />
<br />
Standardwert: ''{ }''<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{httpversion}</code>'''<br />
<br />
''optional''<br />
|| Die HTTP-Version, welche zur Abfrage verwendet werden soll. Standardmäßig werden alle Abfragen mit HTTP/1.0 durchgeführt. Falls es jedoch notwendig ist HTTP/1.1 zu verwenden, so sollte <code>$param->{httpversion}</code> auf "1.1" gesetzt werden. Bei Version 1.1 wird automatisch der Header "<code>Connection: close</code>" implizit mitgesendet.<br />
<br />
Standardwert: "1.0"<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{digest}</code>'''<br />
<br />
''optional''<br />
|| Wenn dieser Parameter den Wert 1 trägt, wird bei vorhandenen Authentifizierungsdaten (Username+Passwort) eine Authentifizierung via Digest-Verfahren nach RFC 2617<ref name="rfc2617">RFC 2617 - HTTP Authentication: Basic and Digest Access Authentication</ref> erwartet. Die Anmeldedaten werden dann nur verwendet, wenn dieser explizit eine HTTP Digest Authentifizierung einleitet. Ist dieser Parameter nicht gesetzt (Wert: 0), wird bei vorhandenen Authentifizierungsdaten immer eine HTTP Basic<ref name="rfc2617" /> Authentifizierung im Request mitgeschickt.<br />
<br />
Standardwert: 0<br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{compress}</code>'''<br />
<br />
''optional''<br />
|| Wenn dieser Parameter den Wert 1 trägt, wird dem Server die Verwendung von Komprimierung in Form GZIP oder alternativ Deflate<ref>RFC 1951 - DEFLATE Compressed Data Format Specification version 1.3</ref> zur Übertragung der Antwort ermöglicht. Die komprimierte Antwort wird dabei direkt durch HttpUtils.pm wieder dekomprimiert. Wird dieser Parameter auf den Wert 0 gesetzt, so wird keine Komrpimierung ermöglicht.<br />
<br />
'''WICHTIG''': Die Verwendung von Komprimierung in HttpUtils.pm kann mit dem globalen Attribut "httpcompress" (Standardwert: 1) durch setzen auf 0 für die gesamte FHEM Installation durch den Nutzer deaktiviert werden. In diesem Fall ist der Parameter <code>$param->{compress} = 1</code> wirkungslos.<br />
<br />
Standardwert: 1<br />
|}<br />
<br />
Als Rückgabewert von HttpUtils_BlockingGet wird ein Array mit zwei Rückgabewerten zurückgegeben:<br />
:<code>($err, $data) = HttpUtils_BlockingGet( … )</code><br />
Diese zwei Rückgabewerte haben folgende Bedeutung:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Rückgabewert !! Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$err</code>'''|| Falls beim Aufruf der URL ein Fehler aufgetreten ist (z.B. Server nicht erreichbar oder Verbindungstimeout), dann ist dieser Wert mit einer Fehlermeldung gefüllt. <br />
<br />
Wenn kein Fehler aufgetreten ist, ist dieser Wert mit einem Leerstring gefüllt (<code>$err = ""</code>)<br />
|-<br />
| style="vertical-align:top" | '''<code>$data</code>'''|| Die Ergebnisdaten, welche der HTTP-Server zurückgeliefert hat. Die Daten werden als Klartext in Form eines gesamten Strings zurückgegeben.<br />
<br />
Falls ein Fehler aufgetreten ist, ist dieser Wert mit einem Leersting gefüllt (<code>$data = ""</code>)<br />
|}<br />
<br />
=== HttpUtils_NonblockingGet ===<br />
{{Randnotiz|RNText=Die Funktion HttpUtils_NonblockingGet ist nicht komplett durchgehend "non-blocking". DNS-Abfragen sind weiterhin blockierend. Insbesondere wenn der DNS-Name nicht aufgelöst werden kann.}}<br />
Diese Funktion arbeitet ähnlich wie HttpUtils_BlockingGet. Allerdings wird das Ergebnis nicht als Funktionsergebnis zurückgegeben. Die Funktion HttpUtils_NonblockingGet initiiert den Verbindungsaufbau und übergibt alles weitere an FHEM interne Routinen. Sobald eine Antwort vom HTTP-Server eintrifft, wird eine Callback-Funktion mit verschiedenen Parametern (unter anderem auch das Ergebnis) aufgerufen, um die Antwort entgegenzunehmen und weiter zu verarbeiten.<br />
<br />
Der Aufruf ist daher ähnlich zu HttpUtils_BlockingGet mit nur einem Parameter-Hash:<br />
<br />
'''Aufruf: <code>HttpUtils_NonblockingGet($param)</code>'''<br />
<br />
{| class="wikitable"<br />
|-<br />
! style="width:175px" | Parameter !! style="width:auto" | Bedeutung<br />
|-<br />
| colspan="2" style="text-align:center" | '''''<br>Alle Hash-Parameter, welche für HttpUtils_BlockingGet gelten, sind auch für HttpUtils_NonblockingGet gültig'''''<br><br />
|-<br />
| style="vertical-align:top" | '''<code>$param->{callback}</code>''' <br />
<br />
''mandatory''<br />
|| Eine Funktion (oder eine Referenz auf eine Funktion), welche die Ergebnisdaten entgegennimmt und die Antwort entsprechend weiterverarbeitet. Die Callback-Funktion muss dabei 3 Parameter erwarten. Die Funktionsparameter der Callback-Funktion werden im nachfolgenden Abschnitt näher erläutert.<br />
<br />
Beispiel: <br />
* <code>$param->{callback} = \&MyCallbackFn</code> — ''(Referenzzeiger auf Funktionsname)''<br />
* <code>$param->{callback} = sub(){ … }</code> — ''(direkte Funktionsdefinition)''<br />
|-<br />
| style="vertical-align:top;white-space:nowrap;" | '''<code>$param->{incrementalTimeout}</code>''' <br />
<br />
''optional''<br />
|| Sofern gesetzt (Wert: <code>1</code>), wird der Timeout nach jedem Empfang von Teil-Daten wieder zurückgesetzt. So können größere Datenmengen von langsamen Sendern empfangen werden, ohne den Parameter <code>timeout</code> zu erhöhen und dadurch tatsächliche Verbindungsprobleme erst spät zu erkennen.<br />
<br />
Standardwert: 0<br />
|-<br />
| style="vertical-align:top" | ''Benutzerdefinierte Parameter'' <br />
|| Es können im Hash weitere benutzerdefinierte Parameter gesetzt werden, welche evtl. in der Callback-Funktion benötigt werden, um die Antwort korrekt zu verarbeiten.<br />
<br />
Zum Beispiel im Rahmen der Modul-Programmierung wäre das <code>$hash</code> der aktuellen Definition. Alle gesetzten Parameter sind in der Callback-Funktion wieder über <code>$param</code> direkt abrufbar und können ausgewertet werden.<br />
<br />
Beispiel: <br />
* <code>$param->{hash} = $hash</code><br />
* <code>$param->{command} = "on"</code><br />
<br />
|} <br />
<br />
Ein Funktionsrückgabewert von HttpUtils_NonblockingGet existiert nicht, da die eigentliche Rückgabe der Daten über die Callback-Funktion erfolgt. Die Callback-Funktion wird aufgerufen, sobdald der HTTP-Request abgeschlossen ist, oder ein Fehler aufgetreten ist. Der Funktionsaufruf erfolgt mit den folgenden Parametern:<br />
<br />
<code> ''MyCallbackFn'' ( $param, $err, $data )</code><br />
<br />
Diese 3 Parameter haben dabei folgende Bedeutung:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Parameter !! Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$param</code>''' || Der Parameter-Hash, mit allen Argumenten die beim Aufruf der Funktion übergeben worden sind.<br />
<br />
Es ist möglich, dass der Parameter-Hash nach erfolgter Abfrage zusätzliche oder veränderte Elemente enthält:<br />
* '''<code>$param->{redirects}</code>''' - Die Anzahl an Umleitungen die erfolgte, bis die Anfrage beantwortet wurde.<br />
* '''<code>$param->{url}</code>''' - Die URL, die nach erfolgter Umleitung die Anfrage beantwortet hat.<br />
* '''<code>$param->{protocol}</code>''' - Das verwendete Protokoll, welches zur Abfrage verwendet wurde ("http" oder "https").<br />
* '''<code>$param->{path}</code>''' - Der Pfad, welcher auf dem HTTP-Server angefragt wurde.<br />
* '''<code>$param->{host}</code>''' - Der Name oder die IP-Adresse des HTTP-Servers.<br />
* '''<code>$param->{httpheader}</code>''' - Der gesamte HTTP Header, welcher der Server bei der letzten Antwort zurücklieferte.<br />
* '''<code>$param->{code}</code>''' - Der HTTP-Statuscode, mit dem die Anfrage vom Server beantwortet wurde.<br />
* '''<code>$param->{addr}</code>''' - Die HTTP-URL ohne Pfad und evtl. Authentifizerungsinformationen des HTTP-Servers (z.B. "<nowiki>http://myserver.com:8080</nowiki>").<br />
* '''<code>$param->{auth}</code>''' - Ein Flag (0/1) ob Zugangsdaten für den Request zur Verfügung standen (durch Angabe in der URL oder direkt in <code>$param</code>).<br />
|-<br />
| style="vertical-align:top" | '''<code>$err</code>'''|| Falls beim Aufruf der URL ein Fehler aufgetreten ist (z.B. Server nicht erreichbar oder Verbindungstimeout), dann ist dieser Wert mit einer Fehlermeldung gefüllt. <br />
<br />
Wenn kein Fehler aufgetreten ist, ist dieser Wert mit einem Leerstring gefüllt (<code>$err = ""</code>)<br />
|-<br />
| style="vertical-align:top" | '''<code>$data</code>'''|| Die Ergebnisdaten, welche der HTTP-Server zurückgeliefert hat. Die Daten werden als Klartext in Form eines gesamten Strings zurückgegeben. Es handelt sich hierbei ausschließlich um den HTTP-Body. <br />
<br />
Falls ein Fehler aufgetreten ist, ist dieser Wert mit einem Leersting gefüllt (<code>$data = ""</code>)<br />
|}<br />
<br />
Die Callback-Funktion kann nun die Daten aus der HTTP-Antwort verarbeiten oder bei Fehlern entsprechende Log-Meldungen ausgeben.<br />
<br />
==== Beispiel für HttpUtils_NonblockingGet() für Modulprogrammierer ====<br />
Das folgende Beispiel soll eine Hilfestellung für eigene Anwendungen geben<br />
<br />
<syntaxhighlight lang="perl">use HttpUtils;<br />
sub X_PerformHttpRequest($)<br />
{<br />
my ($hash, $def) = @_;<br />
my $name = $hash->{NAME};<br />
my $param = {<br />
url => "http://www.foo.de/",<br />
timeout => 5,<br />
hash => $hash, # Muss gesetzt werden, damit die Callback funktion wieder $hash hat<br />
method => "GET", # Lesen von Inhalten<br />
header => "User-Agent: TeleHeater/2.2.3\r\nAccept: application/json", # Den Header gemäß abzufragender Daten ändern<br />
callback => \&X_ParseHttpResponse # Diese Funktion soll das Ergebnis dieser HTTP Anfrage bearbeiten<br />
};<br />
<br />
HttpUtils_NonblockingGet($param); # Starten der HTTP Abfrage. Es gibt keinen Return-Code. <br />
}<br />
<br />
sub X_ParseHttpResponse($)<br />
{<br />
my ($param, $err, $data) = @_;<br />
my $hash = $param->{hash};<br />
my $name = $hash->{NAME};<br />
<br />
if($err ne "") # wenn ein Fehler bei der HTTP Abfrage aufgetreten ist<br />
{<br />
Log3 $name, 3, "error while requesting ".$param->{url}." - $err"; # Eintrag fürs Log<br />
readingsSingleUpdate($hash, "fullResponse", "ERROR", 0); # Readings erzeugen<br />
}<br />
<br />
elsif($data ne "") # wenn die Abfrage erfolgreich war ($data enthält die Ergebnisdaten des HTTP Aufrufes)<br />
{<br />
Log3 $name, 3, "url ".$param->{url}." returned: $data"; # Eintrag fürs Log<br />
<br />
# An dieser Stelle die Antwort parsen / verarbeiten mit $data<br />
<br />
readingsSingleUpdate($hash, "fullResponse", $data, 0); # Readings erzeugen<br />
}<br />
<br />
# Damit ist die Abfrage zuende.<br />
# Evtl. einen InternalTimer neu schedulen<br />
}</syntaxhighlight><br />
<br />
=== HttpUtils_Close ===<br />
<br />
Für den Abbruch von offenen Verbindungen und noch laufenden NonBockingGet-Aufrufen gibt es die Funktion HttpUtils_Close. Diese kann z.B. beim Löschen eines Devices oder Herunterfahren des Servers aufgerufen werden, um bestehende Verbindungen zu schliessen.<br />
<br />
Wenn man den Parameter "keepalive" beim Aufruf von HttpUtils_NonBlockingGet/HttpUtils_BlockingGet gesetzt hat, muss man HttpUtils_Close aufrufen um die Verbindung tatsächlich zu schließen, da diese noch durch den Server offen gehalten werden kann.<br />
<br />
'''Aufruf: <code>HttpUtils_Close($param)</code>'''<br />
<br />
{| class="wikitable"<br />
|-<br />
! style="width:175px" | Parameter !! style="width:auto" | Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$param</code>''' <br />
<br />
''mandatory''<br />
|| Der Hash, der beim vorherigen Aufruf an HTTPUtils Funktionen (HttpUtils_NonblockingGet oder HttpUtils_BlockingGet) übergeben wurde<br />
<br />
|} <br />
<br />
== Hilfsfunktionen ==<br />
<br />
=== urlEncode ===<br />
<br />
:<syntaxhighlight lang="perl"><br />
$encoded = urlEncode($string);<br />
</syntaxhighlight><br />
Die Funktion urlEncode() wandelt die übergebene Zeichenkette <code>$string</code> in eine URL-kompatible<ref name="rfc3986-2.1">[https://tools.ietf.org/html/rfc3986#section-2.1 RFC 3989] - Abschnitt 2.1 "Percent-Encoding"</ref> Zeichenkette um. Der Rückgabewert <code>$encoded</code> ist eine Zeichenkette welche innerhalb einer URL verwendet werden kann, bspw. als Wert eines GET-Parameters.<br />
<br />
Parameter:<br />
{| class="wikitable"<br />
|-<br />
! Parameter !! Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$string</code>'''<br />
<br />
''mandatory''<br />
|| Die Zeichenkette, welche in eine URL-kompatible Form umgewandelt werden soll.<br />
|}<br />
<br />
Rückgabewerte:<br />
{| class="wikitable"<br />
|-<br />
! Rückgabewert !! Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$encoded </code>''' || Die URL-kompatible Version der übergebenen Zeichenkette. Problematische Zeichen sind in diesem Wert durch ein Prozentzeichen gefolgt von der Hexadezimaldarstellung des Zeichens dargestellt.<br />
<br />
Bsp:<br />
* "a: b" => "a%3a%20b"<br />
* "a/b" => "a%2fb"<br />
|}<br />
<br />
=== urlDecode ===<br />
<br />
<br />
:<syntaxhighlight lang="perl"><br />
$string = urlDecode($encoded);<br />
</syntaxhighlight><br />
Die Funktion urlDecode () normalisiert die übergebene Zeichenkette <code>$encoded</code> und ersetzt dabei sämtliche Hexadezimaldarstellungen<ref name="rfc3986-2.1" /> (eingeleitet mit einem Prozentzeichen) durch die entsprechenden Zeichen. Der Rückgabewert <code>$string</code> ist eine Zeichenkette welche keinerlei Hexadezimaldarstellungen mehr aufweist.<br />
<br />
Parameter:<br />
{| class="wikitable"<br />
|-<br />
! Parameter !! Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$encoded</code>'''<br />
<br />
''mandatory''<br />
|| Eine Zeichenkette, welche URL-kombatible Hexadezimaldarstellungen enthält.<br />
|}<br />
<br />
Rückgabewerte:<br />
{| class="wikitable"<br />
|-<br />
! Rückgabewert !! Bedeutung<br />
|-<br />
| style="vertical-align:top" | '''<code>$string</code>''' || Die normale Version der übergebenen Zeichenkette. Sämtliche Hexadezimalddarstellungen sind in ihre entsprechenden Zeichen umgewandelt.<br />
<br />
Bsp:<br />
* "a%3a%20b" => "a: b"<br />
* "a%2fb" => "a/b"<br />
|}<br />
<br />
== Referenzen ==<br />
<br />
<references /><br />
<br />
[[Kategorie:Development]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35312TA CMI UVR16x2 UVR16112021-03-23T06:56:00Z<p>DelMar: /* Fixwerte setzen */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
=== Konfiguration ===<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten testen, die '''noch nicht''' mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Man will ja nichts kaputt machen, weil man versehentlich den falschen Wert schaltet.</blockquote>Regelmäßig verwendete Befehle können über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Visualisierung und Steuerung ==<br />
Über <code>stateFormat</code> kann man den Status der Steuerung so visualisieren, wie man möchte. Im folgenden Beispiel werden zB CSS-Klassen mit Namen <code>Auto-On</code>, erstellt. Somit können die Readings als CSS-Klassen verwendet werden.<br />
<br />
Außerdem wird ein Link zum CMI bereitgestellt, der direkt die Seite des CAN-Devices öffnet.<br />
attr cmi_rsm610_1 stateFormat \<br />
<style> .Auto-On,.Manual-On{ background-color:lightgreen;; } .Manual-Off{ background-color:red;; } </style>\<br />
<nowiki><div>\</nowiki><br />
<nowiki><span><a href="http://[cmi_rsm610_1:CMIURL]/menupagex.cgi?nodex2=[cmi_rsm610_1:NODEID_HEX]005800#[cmi_rsm610_1:NODEID_HEX]005800" target="_blank">Zum CMI</a></nowiki><nowiki></span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:1_Licht_Wohnzimmer_State_Pretty]">Wohnen</span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:2_Licht_Kueche_State_Pretty]">K&</nowiki>uuml;;che<nowiki></span></nowiki>\<br />
<nowiki></div></nowiki><br />
Sind Befehle über <code>setList</code> konfiguriert, können diese außerdem bequem als <code>webcmd</code> verwendet werden.<br />
attr cmi_rsm610_1 webCmd Wohnen_Ein:Wohnen_Aus:Kueche_Ein:Kueche_Aus<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35311TA CMI UVR16x2 UVR16112021-03-22T09:50:38Z<p>DelMar: /* Visualisierung und Steuerung */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
=== Konfiguration ===<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten testen, die noch nicht mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Die Verwendung dieses Moduls geschieht grundsätzlich auf eigene Verantwortung.</blockquote>Regelmäßig verwendete Befehle können über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Visualisierung und Steuerung ==<br />
Über <code>stateFormat</code> kann man den Status der Steuerung so visualisieren, wie man möchte. Im folgenden Beispiel werden zB CSS-Klassen mit Namen <code>Auto-On</code>, erstellt. Somit können die Readings als CSS-Klassen verwendet werden.<br />
<br />
Außerdem wird ein Link zum CMI bereitgestellt, der direkt die Seite des CAN-Devices öffnet. Temporärer Hinweis: das Internal NODEID_HEX ist erst ab morgen verfügbar.<br />
attr cmi_rsm610_1 stateFormat \<br />
<style> .Auto-On,.Manual-On{ background-color:lightgreen;; } .Manual-Off{ background-color:red;; } </style>\<br />
<nowiki><div>\</nowiki><br />
<nowiki><span><a href="http://[cmi_rsm610_1:CMIURL]/menupagex.cgi?nodex2=[cmi_rsm610_1:NODEID_HEX]005800#[cmi_rsm610_1:NODEID_HEX]005800" target="_blank">Zum CMI</a></nowiki><nowiki></span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:1_Licht_Wohnzimmer_State_Pretty]">Wohnen</span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:2_Licht_Kueche_State_Pretty]">K&</nowiki>uuml;;che<nowiki></span></nowiki>\<br />
<nowiki></div></nowiki><br />
Sind Befehle über <code>setList</code> konfiguriert, können diese außerdem bequem als <code>webcmd</code> verwendet werden.<br />
attr cmi_rsm610_1 webCmd Wohnen_Ein:Wohnen_Aus:Kueche_Ein:Kueche_Aus<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35310TA CMI UVR16x2 UVR16112021-03-22T09:50:27Z<p>DelMar: /* Visualisierung und Steuerung */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
=== Konfiguration ===<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten testen, die noch nicht mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Die Verwendung dieses Moduls geschieht grundsätzlich auf eigene Verantwortung.</blockquote>Regelmäßig verwendete Befehle können über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Visualisierung und Steuerung ==<br />
Über <code>stateFormat</code> kann man den Status der Steuerung so visualisieren, wie man möchte. Im folgenden Beispiel werden zB CSS-Klassen mit Namen <code>Auto-On</code>, erstellt. Somit können die Readings als CSS-Klassen verwendet werden.<br />
<br />
Außerdem wird ein Link zum CMI bereitgestellt, der direkt die Seite des CAN-Devices öffnet. Temporärer Hinweis: das Internal NODEID_HEX ist erst ab morgen verfügbar.<br />
attr cmi_rsm610_1 stateFormat<br />
<style> .Auto-On,.Manual-On{ background-color:lightgreen;; } .Manual-Off{ background-color:red;; } </style>\<br />
<nowiki><div>\</nowiki><br />
<nowiki><span><a href="http://[cmi_rsm610_1:CMIURL]/menupagex.cgi?nodex2=[cmi_rsm610_1:NODEID_HEX]005800#[cmi_rsm610_1:NODEID_HEX]005800" target="_blank">Zum CMI</a></nowiki><nowiki></span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:1_Licht_Wohnzimmer_State_Pretty]">Wohnen</span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:2_Licht_Kueche_State_Pretty]">K&</nowiki>uuml;;che<nowiki></span></nowiki>\<br />
<nowiki></div></nowiki><br />
Sind Befehle über <code>setList</code> konfiguriert, können diese außerdem bequem als <code>webcmd</code> verwendet werden.<br />
attr cmi_rsm610_1 webCmd Wohnen_Ein:Wohnen_Aus:Kueche_Ein:Kueche_Aus<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35309TA CMI UVR16x2 UVR16112021-03-22T09:16:05Z<p>DelMar: /* Visualisierung und Steuerung */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
=== Konfiguration ===<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten testen, die noch nicht mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Die Verwendung dieses Moduls geschieht grundsätzlich auf eigene Verantwortung.</blockquote>Regelmäßig verwendete Befehle können über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Visualisierung und Steuerung ==<br />
Über <code>stateFormat</code> kann man den Status der Steuerung so visualisieren, wie man möchte. Im folgenden Beispiel werden zB CSS-Klassen mit Namen <code>Auto-On</code>, erstellt. Somit können die Readings als CSS-Klassen verwendet werden.<br />
<br />
Außerdem wird ein Link zum CMI bereitgestellt, der direkt die Seite des CAN-Devices öffnet. Temporärer Hinweis: das Internal NODEID_HEX ist erst ab morgen verfügbar.<br />
attr cmi_rsm610_1 stateFormat<br />
<style> .Auto-On,.Manual-On{ background-color:lightgreen;; } .Manual-Off{ background-color:red;; } </style><br />
<nowiki><div>\</nowiki><br />
<nowiki><span><a href="http://[cmi_rsm610_1:CMIURL]/menupagex.cgi?nodex2=[cmi_rsm610_1:NODEID_HEX]005800#[cmi_rsm610_1:NODEID_HEX]005800" target="_blank">Zum CMI</a></nowiki><nowiki></span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:1_Licht_Wohnzimmer_State_Pretty]">Wohnen</span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:2_Licht_Kueche_State_Pretty]">K&</nowiki>uuml;;che<nowiki></span></nowiki>\<br />
<nowiki></div></nowiki><br />
Sind Befehle über <code>setList</code> konfiguriert, können diese außerdem bequem als <code>webcmd</code> verwendet werden.<br />
attr cmi_rsm610_1 webCmd Wohnen_Ein:Wohnen_Aus:Kueche_Ein:Kueche_Aus<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35308TA CMI UVR16x2 UVR16112021-03-22T09:14:58Z<p>DelMar: Visualisierung und Steuerung ergänzt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
=== Konfiguration ===<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten testen, die noch nicht mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Die Verwendung dieses Moduls geschieht grundsätzlich auf eigene Verantwortung.</blockquote>Regelmäßig verwendete Befehle können über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Visualisierung und Steuerung ==<br />
Über <code>stateFormat</code> kann man den Status der Steuerung so visualisieren, wie man möchte. Im folgenden Beispiel werden zB CSS-Klassen mit Namen <code>Auto-On</code>, erstellt. Somit können die Readings als CSS-Klassen verwendet werden.<br />
<br />
Außerdem wird ein Link zum CMI bereitgestellt, der direkt die Seite des CAN-Devices öffnet. Temporärer Hinweis: das Internal NODEID_HEX ist erst ab morgen verfügbar.<br />
attr cmi_rsm610_1 stateFormat<br />
<style> .Auto-On,.Manual-On{ background-color:lightgreen;; } .Manual-Off{ background-color:red;; } </style><br />
<nowiki><div>\</nowiki><br />
<nowiki><span><a href="http://[cmi_rsm610_1:CMIURL]/menupagex.cgi?nodex2=[cmi_rsm610_1:NODEID_HEX]005800#[cmi_rsm610_1:NODEID_HEX]005800" target="_blank">Zum CMI</a></nowiki><nowiki></span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:1_Licht_Wohnzimmer_State_Pretty]">Wohnen</span></nowiki>\<br />
<nowiki><span class="[cmi_rsm610_1:2_Licht_Kueche_State_Pretty]">K&</nowiki>uuml;;che<nowiki></span></nowiki>\<br />
<nowiki></div></nowiki>\<br />
Sind Befehle über <code>setList</code> konfiguriert, können diese außerdem bequem als <code>webcmd</code> verwendet werden.<br />
attr cmi_rsm610_1 webCmd Wohnen_Ein:Wohnen_Aus:Kueche_Ein:Kueche_Aus<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35303TA CMI UVR16x2 UVR16112021-03-21T16:22:53Z<p>DelMar: /* Fixwerte setzen */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
=== Konfiguration ===<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten testen, die noch nicht mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Die Verwendung dieses Moduls geschieht grundsätzlich auf eigene Verantwortung.</blockquote>Regelmäßig verwendete Befehle können über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35302TA CMI UVR16x2 UVR16112021-03-21T16:19:33Z<p>DelMar: /* Die Inoffizielle API */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
=== Konfiguration ===<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten testen, die noch nicht mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Die Verwendung dieses Moduls geschieht grundsätzlich auf eigene Verantwortung.</blockquote>Fegelmäßig verwendete Befehle können über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35301TA CMI UVR16x2 UVR16112021-03-21T16:15:19Z<p>DelMar: /* Fixwerte setzen */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten testen, die noch nicht mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Die Verwendung dieses Moduls geschieht grundsätzlich auf eigene Verantwortung.</blockquote>Fegelmäßig verwendete Befehle können über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35300TA CMI UVR16x2 UVR16112021-03-21T16:14:58Z<p>DelMar: /* Fixwerte setzen */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten verwenden, die noch nicht mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Die Verwendung dieses Moduls geschieht grundsätzlich auf eigene Verantwortung.</blockquote>Fegelmäßig verwendete Befehle können über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35299TA CMI UVR16x2 UVR16112021-03-21T16:14:43Z<p>DelMar: /* Fixwerte setzen */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<blockquote>Die Schnittstelle, die hierfür verwendet wird, ist an sich nicht für den End-Benutzer (also zB dieses Modul) vorgesehen.</blockquote><blockquote>Bitte deshalb vor Verwendung und nach Aktualisierung auf eine neuere Firmware immer mit Fixwerten verwenden, die noch nicht mit tatsächlichen Funktionen verbunden sind. Über das Web-Interface des CMI kann ganz einfach festgestellt werden, ob ein Schaltbefehl von diesem Modul richtig umgesetzt wurde. Die Verwendung dieses Moduls geschieht grundsätzlich auf eigene Verantwortung.</blockquote>Außerdem können regelmäßig verwendete Befehle über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35298TA CMI UVR16x2 UVR16112021-03-21T16:08:21Z<p>DelMar: /* Fixwerte setzen */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
<code>set cmi_rsm610 fixwertAnalog 7 55.9</code><br />
<br />
sendet den Analog-Wert 55.9 and Fixwert 7.<br />
<br />
Außerdem können regelmäßig verwendete Befehle über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35297TA CMI UVR16x2 UVR16112021-03-21T16:05:33Z<p>DelMar: /* Fixwerte setzen */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
Außerdem können regelmäßig verwendete Befehle über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35296TA CMI UVR16x2 UVR16112021-03-21T16:05:11Z<p>DelMar: Fixwerte setzen ergänzt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
Außerdem können regelmäßig verwendete Befehle über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempListe:10,20,30 fixwertAnalog 7<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempListe</code> gibt die drei Werte 10, 20, 30 zur Auswahl und hängt diese als letzten Parameter an.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35295TA CMI UVR16x2 UVR16112021-03-21T16:00:28Z<p>DelMar: neue Features zum Setzen von Fixwerten dokumentiert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestatuswerten über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModCmdRef=TA_CMI_JSON<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
=== Die Inoffizielle API ===<br />
Zusätzlich zur Anbindung an die offizielle API verwendet dieses Modul auch einige der Schnittstellen, die das CMI Web-Interface verwendet.<br />
<br />
Zum Beispiel um den '''Status der Ausgänge''' zeigen. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
Außerdem ist das direkte '''Setzen von Fixwerten''' über Set-Befehle möglich.<br />
<br />
== Einbindung in FHEM ==<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|rechts|User Interface der UVR16x2]]<br />
Definition:<br />
:<code>defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]</code><br />
Konkretes Beispiel:<br />
:<code>defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D</code><br />
<br />
Die <code>nodeId</code> verweist auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als [[Reading|Readings]] in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
<br />
So wird mittels Index ein Name für jeden Wert definiert. Beispiel:<br />
:<code>attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL</code><br />
[[Datei:UVR16x2Readings.png|mini|rechts|Readings]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
:<code>attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar</code><br />
<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Fixwerte setzen ==<br />
Das Setzen von Fixwerten funktioniert über die Set Befehle <code>fixwertAnalog</code>, <code>fixwertDigital</code> und <code>fixwertImpuls</code>.<br />
<br />
Außerdem können regelmäßig verwendete Befehle über <code>setList</code> konfiguriert und direkt ausgeführt werden.<br />
attr cmi_rsm610 setList \<br />
Licht_WC_Ein:noArg fixwertImpuls 3 1\<br />
Licht_WC_Aus:noArg fixwertImpuls 4 1\<br />
Freigabe_Pumpe_ein:noArg fixwertDigital 5 1\<br />
Freigabe_Pumpe_aus:noArg fixwertDigital 5 0\<br />
TempFrei fixwertAnalog 7\<br />
TempWarm fixwertAnalog 7 60.0\<br />
TempKalt fixwertAnalog 7 10.0<br />
<code>Licht_WC_Ein</code> und <code>Licht_WC_Aus</code> sendet Impuls-Befehle (1 für Ein-Impuls, 0 für Aus-Impuls), wie sie zB für die Start-Stop Funktion oder Timer-Funktionen als Trigger verwendet werden.<br />
<br />
<code>Freigabe_Pumpe_ein</code> und <code>Freigabe_Pumpe_aus</code> setzt einen digitalen Fixwert auf Ein/Ja oder Aus/Nein.<br />
<br />
<code>TempFrei</code> sendet einen Wert an Fixwert 7, der Wert selber kann aber über das Textfeld vergeben werden, da kein :noArg angegeben wurde.<br />
<br />
<code>TempWarm</code> sendet den analogen Wert 60.0 and Fixwert 7.<br />
<br />
<code>TempKalt</code> sendet den analogen Wert 10.0 and Fixwert 7.<br />
<br />
== Direktes Setzen von Ausgängen ==<br />
Ausgänge direkt zu setzen (zB Hand-Ein, Hand-Aus) wird von diesem Modul '''nicht''' unterstützt.<br />
<br />
Es wäre sehr einfach umzusetzen, weil es genauso wie das Setzen von Fixwerten funktioniert.<br />
<br />
Allerdings sollte das ''manuelle'' Setzen von Ausgängen nicht ''automatisiert'' erfolgen (wie es über FHEM ja der Fall wäre).<br />
<br />
Der richtige Weg, einen Ausgang über FHEM zu schalten, ist das Anlegen einer Logik-Funktion, welche auf Basis eines Fixwertes einen Ausgang schaltet.<br />
<br />
Und dieser Fixwert kann ja wiederum über dieses Modul gesetzt werden.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]<br />
<br />
== Links ==<br />
* Webseite der Herstellers [https://www.ta.co.at Technische Alternative RT GmbH]<br />
<br />
[[Kategorie:Heizungssteuerung]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=IPCAM&diff=35085IPCAM2021-02-26T21:47:43Z<p>DelMar: Templates erwähnt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Einbindung von Netzwerkkameras<br />
|ModType=d<br />
|ModForumArea=Sonstiges<br />
|ModTechName=49_IPCAM.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
[[IPCAM]] ermöglicht die ereignis- oder zeitgesteuerte Erzeugung von Mitschnitten bei Netzwerkkameras. Außerdem ist es möglich, die Kamera im PTZ-Modus oder über eigene Befehle zu steuern.<br />
<br />
== Voraussetzungen ==<br />
Die Kamera(bilder) müssen über eine URL erreichbar sein.<br />
<br />
== Definition ==<br />
Das IPCAM Objekt wird angelegt mit<br />
:<code><nowiki>define <name> IPCAM <ip[:port]> </nowiki></code><br />
<br />
Zusätzlich zum obigen Define muss zwingend noch das ''path'' Attribut gesetzt werden.<br />
<br />
== Attribute ==<br />
Die wichtigsten Attribute von ''IPCAM'' werden im Folgenden aufgeführt, die komplette Liste findet sich in der {{Link2CmdRef|Anker=IPCAMattr}}.<br />
<br />
=== Authentifizierung ===<br />
;basicauth<br />
:Hinterlegung von Benutzernamen und Passwort <br />
<br />
=== Eigene Befehle ===<br />
;cmd01, cmd02, ... cmd15<br />
:Festlegung von Befehlen, die nicht zu den vordefinierten gehören, z.B. <code>attr ipcam cmd01 led_mode=0</code><br />
<br />
=== Vordefinierte Befehle ===<br />
;cmdPanLeft, cmdPanRight, cmdTiltUp, cmdTiltDown, cmdStep <br />
:Diesen Befehlen können die Kameraspezifischen Werte zugeordnet werden, z.B. <code>attr ipcam cmdTiltUp command=0</code><br />
<br />
=== Pfade ===<br />
;path<br />
;<br />
<br />
=== Templates ===<br />
Die Einrichtung von Kameras kann über Templates einfacher gemacht werden.<br />
<br />
Als funktionierend bekannte Funktionen können im Forum hier https://forum.fhem.de/index.php/topic,10772.msg1135359.html hinterlegt werden, sie werden dann beizeiten ins SVN aufgenommen und stehen so für alle Benutzer zur Verfügung.<br />
<br />
== Unterstützte Netzwerkkameras ==<br />
{{Randnotiz|RNText=Die Aufzählungen der unterstützten und der problematischen Netzwerkkameras sollten ergänzt werden, sobald neue Erkenntnisse vorliegen; beide Listen sind nicht vollständig.}}<br />
Bei den folgenden Netzwerkkameras ist gesichert, dass sie durch das ''IPCAM'' Modul unterstützt sind:<br />
* {{Link2Forum|Topic=33347|Message=257115|LinkText=Foscam 9805W}}<br />
* Foscam FI9831P<br />
* Foscam FI9853EP<br />
* {{Link2Forum|Topic=13826|LinkText=Instar 2905}}<br />
* {{Link2Forum|Topic=100493|LinkText=IN-8015 Full HD}}<br />
* {{Link2Forum|Topic=36201|LinkText=IN-6001HD}}<br />
* {{Link2Forum|Topic=11664|LinkText=Instar 6011, 6012, 2905}}<br />
* {{Link2Forum|Topic=58676|LinkText=Instar IN-5905HD, IN-5907HD, IN-6014HD, IN-6012HD-PoE}}<br />
* {{Link2Forum|Topic=15217|LinkText=WansView (Modell nicht näher spezifiziert)}}<br />
* {{Link2Forum|Topic=11664|Message=158052|LinkText=Wansview 620, 625, 6012}}<br />
* Axis 205<br />
* D-Link DCS-933<br />
* Mobotix (jedenfalls S26 und Q25)<br />
* Xiaomi Dafang (nur mit alternativer Firmware)<br />
<br />
Nicht gesichert, ob die Kamera unterstützt wird bzw. ob alle Funktionen nutzbar sind:<br />
* {{Link2Forum|Topic=33347|LinkText=Foscam FI9831W}}<br />
<br />
<br />
=== Pfad-Parameter für Axis 205 ===<br />
<pre><br />
attr Cam1 path /jpg/image.jpg<br />
</pre><br />
<br />
=== Pfad-Parameter für D-Link DCS-933 ===<br />
<pre>attr Cam1 path image.jpg</pre><br />
<br />
=== Parameter für Hikvision DS-2CD2032-I ===<br />
Mit folgenden Parameter wurde (lt. diesem {{Link2Forum|Topic=39932|Message=322269|LinkText=Forenbeitrag}}) die Hikvision DS-2CD2032-I erfolgreich betrieben:<br />
<pre><br />
define Cam1 IPCAM 192.168.xxx.xxx<br />
attr Cam1 basicauth <username>:<passwort><br />
attr Cam1 delay 0<br />
attr Cam1 group Kamera<br />
attr Cam1 icon it_camera<br />
attr Cam1 path Streaming/channels/1/picture?snapShotImageType=JPEG<br />
attr Cam1 snapshots 1<br />
attr Cam1 storage /opt/fhem/www/snapshots/cam1<br />
</pre><br />
<br />
=== Pfad-Parameter für Foscam FI9831P ===<br />
Die Version ist ohne basicauth und hat Nutzer und Passwort direkt in der URL. Kann natürlich geändert werden.<br />
Sämtliche Befehle für die Foscam HD Kameras findet man [https://www.manualslib.com/manual/728928/Foscam-Ip-Camera.html hier]<br />
<pre><br />
define IPKamera IPCAM <ip>:<port><br />
attr IPKamera cmd01 cmd=ptzStopRun&usr=xxx&pwd=xxx<br />
attr IPKamera cmdPanLeft cmd=ptzMoveLeft&usr=xxx&pwd=xxx<br />
attr IPKamera cmdPanRight cmd=ptzMoveRight&usr=xxx&pwd=xxx<br />
attr IPKamera cmdPos01 cmd=ptzGotoPresetPoint&name=<Nameposition>&usr=xxx&pwd=xxx<br />
attr IPKamera cmdTiltDown cmd=ptzMoveDown&usr=xxx&pwd=xxx<br />
attr IPKamera cmdTiltUp cmd=ptzMoveUp&usr=xxx&pwd=xxx<br />
attr IPKamera path cgi-bin/CGIProxy.fcgi?usr=xxx&pwd=xxx&cmd=snapPicture2<br />
attr IPKamera pathCmd cgi-bin/CGIProxy.fcgi<br />
attr IPKamera pathPanTilt cgi-bin/CGIProxy.fcgi?usr=xxx&pwd=xxx<br />
attr IPKamera storage ./www/images/webcam<br />
</pre><br />
<br />
=== Pfad-Parameter für Mobotix ===<br />
<pre><br />
attr IPKamera path /record/current.jpg<br />
</pre><br />
<br />
=== Pfad-Parameter für reolink (E1 Zoom) ===<br />
<pre><br />
attr IPKamera path cgi-bin/api.cgi?cmd=Snap&width=<Breite>&height=<Hoehe>&channel=0&rs=<irgendwas>&user=Username&password=Passwort<br />
</pre><br />
<br />
Beispiel:<br />
<pre><br />
attr IPKamera path cgi-bin/api.cgi?cmd=Snap&width=1024&height=768&channel=0&rs=12345&user=User&password=Pwd<br />
</pre><br />
<br />
Weitere Befehle sind aktuell noch nicht bekannt.<br />
<br />
Es gibt eine spärliche Doku bzgl. cgi hier: https://cdn.reolink.com/wp-content/uploads/2017/01/Reolink-CGI-command-v1.61.pdf<br />
<br />
Allerdings wird wohl für die Steuerbefehle (PTZ) ein Post-Request benötigt.<br />
<br />
Weitere Kommandos wurden hier gesammelt: https://community.jeedom.com/t/reolink-liste-de-commandes-via-api-maj-29-04/25565<br />
<br />
<br />
=== Einstellungen für Foscam C2 und Foscam R2 ===<br />
Eine ausführliche Beschreibung zur Benutzung der IP Kameras Foscam C2 und Foscam R2 findet sich in {{Link2Forum|Topic=84677|LinkText=diesem Forenthread}}.<br />
<br />
<br />
=== Parameter für Xiaomi Dafang ===<br />
Diese Parameter gelten bei installierter alternativer Firmware von [https://github.com/EliasKotlyar/Xiaomi-Dafang-Hacks hier]<br />
<pre><br />
<br />
Attributes:<br />
attr IPKamera cmdPanLeft cmd=motor_left<br />
attr IPKamera cmdPanRight cmd=motor_right<br />
attr IPKamera cmdTiltDown cmd=motor_down<br />
attr IPKamera cmdTiltUp cmd=motor_up<br />
attr IPKamera delay 10<br />
attr IPKamera event-on-update-reading snapshots<br />
attr IPKamera icon it_camera<br />
attr IPKamera path cgi-bin/currentpic.cgi<br />
attr IPKamera pathPanTilt cgi-bin/action.cgi?<br />
attr IPKamera snapshots 5<br />
attr IPKamera storage /opt/fhem/www/ipcamera/dafang_1/shot<br />
</pre><br />
<br />
=== Parameter für INSTAR Full HD ===<br />
Die vollständige Schnittstelle und weitere Beispiele können direkt im [https://wiki.instar.de/Erweitert/ INSTAR-Wiki] eingesehen werden.<br><br />
Zur Integration einer INSTAR Full HD CAM können zum Beispiel folgende Attribute verwendet werden:<br />
<pre><br />
attr INSTAR_8015 basicauth {USERNAME}:{PASSWORD}<br />
attr INSTAR_8015 cmd01 cmd=setinfrared&-infraredstat=auto<br />
attr INSTAR_8015 cmd02 cmd=setinfrared&-infraredstat=close<br />
attr INSTAR_8015 cmd03 cmd=setinfrared&-infraredstat=open<br />
attr INSTAR_8015 cmd04 cmd=setmdalarm&-aname=ftprec&-switch=on<br />
attr INSTAR_8015 cmd05 cmd=setmdalarm&-aname=ftprec&-switch=off<br />
attr INSTAR_8015 cmd06 cmd=setplanrecattr&-planrec_enable=0<br />
attr INSTAR_8015 cmd07 cmd=setplanrecattr&-planrec_enable=1<br />
attr INSTAR_8015 cmd08 cmd=setplanrecattr&-planrec_chn=11<br />
attr INSTAR_8015 cmd09 cmd=setplanrecattr&-planrec_chn=12<br />
attr INSTAR_8015 cmd10 cmd=manualrec&-act=on<br />
attr INSTAR_8015 cmd11 cmd=manualrec&-act=off<br />
attr INSTAR_8015 cmd12 cmd=sdfrmt<br />
attr INSTAR_8015 cmd13 cmd=preset&-act=goto&-number=0<br />
attr INSTAR_8015 cmd14 cmd=preset&-act=goto&-number=1<br />
attr INSTAR_8015 cmd15 cmd=preset&-act=goto&-number=2<br />
attr INSTAR_8015 cmdPanLeft -act=left<br />
attr INSTAR_8015 cmdPanRight -act=right<br />
attr INSTAR_8015 cmdPos15 -act=stop<br />
attr INSTAR_8015 cmdTiltDown -act=down<br />
attr INSTAR_8015 cmdTiltUp -act=up<br />
attr INSTAR_8015 credentials /<ipcam-conf-path>/ipcam.conf<br />
attr INSTAR_8015 eventMap /pos 15:MOVE-STOP/pan left:MOVE-LEFT/pan right:MOVE-RIGHT/tilt up:MOVE-UP/tilt down:MOVE-DOWN/cmd 1:IR-LED-auto/cmd 2:IR-LED-off/cmd 3:IR-LED-on/cmd 4:FTP-rec-on/cmd 5:FTP-rec-off/cmd 6:REC-SD-DISABLE/cmd 7:REC-SD-ENABLE/cmd 8:REC-SD-QUAL-HIGH/cmd 9:REC-SD-QUAL-MID/cmd 10:MAN-REC-Start/cmd 11:MAN-REC-Stop/cmd 12:FORMAT-SD-CARD/cmd 13:POS-WZ/cmd 14:POS-Flur/cmd 15:POS-Park/<br />
attr INSTAR_8015 icon it_camera<br />
attr INSTAR_8015 path tmpfs/snap.jpg<br />
attr INSTAR_8015 pathCmd param.cgi<br />
attr INSTAR_8015 pathPanTilt ptzctrl.cgi?-step=<br />
attr INSTAR_8015 scheme https<br />
attr INSTAR_8015 storage /<ipcam-snapshot-path>/snapshots<br />
attr INSTAR_8015 webCmd POS-WZ:POS-Flur:POS-Park<br />
</pre><br />
<br />
== Nicht unterstützte Netzwerkkameras ==<br />
{{Randnotiz|RNTyp=y|RNText=Die hier aufgeführten Netzwerkkameras sind definitiv nicht unterstützt oder es gibt gravierende, hier beschriebene Einschränkungen.}}<br />
;TRENDnet TV-IP320PI <br />
:Aufruf der Funktion <code>get ''myCam'' image</code> führt zur Fehlermeldung ''...invalid Format''; auf Kamerabild oder Stream kann jedoch über die URL camHostnameOrIP/Streaming/channels/1/Picture (Bild) bzw. camHostnameOrIP/Streaming/channels/1/httpPreview (Stream) zugegriffen werden.<br />
<br />
== Generierte Ereignisse ==<br />
Das Modul ''IPCAM'' generiert die Ereignisse <br />
* <code><nowiki>last: <name_of_device>_snapshot.<image_extension></nowiki></code><br />
* <code><nowiki>snapshots: <total_number_of_taken_snapshots_at_end></nowiki></code><br />
<br />
== Bekannte Probleme ==<br />
Derzeit (08/2015) ist das Logging aus dem Modul zumindest lückenhaft und verbesserungsfähig. So sollten z.B. einige weitere Meldungen zur Fehlereingrenzung bei der Einrichtung eines IPCAM Objekts eingefügt werden:<br />
* Ausgabe des kompletten Pfads / der URL, die bei der Erzeugung eines Snapshots aus einzelnen Bestandteilen zusammengesetzt wird<br />
** Mit 27. Februar 2021 erhält man mit <code>verbose 4</code> zB folgenden Logeintrag: <code>2021.02.27 23:03:39 4: IPCAM (ipcam_reolink) - set cmd requesting <nowiki>http://x.x.x.x/cgi-bin/api.cgi?user=abc&password=def&cmd=GetOsd</nowiki></code><br />
* Die Zuordnung von Meldungen zu ''verbose''-Leveln sollte kontrolliert und ggf. umgestellt werden<br />
* siehe auch diesen {{Link2Forum|Topic=39932|LinkText=Forenthread}}, der Beschreibung von Problemen, eine Hikvision IPCam in Betrieb zu nehmen<br />
<br />
<s>Außerdem müsste das Modul dringend auf die aktuelle Form des Logging, [[verbose|verbose/Log3]], umgestellt werden.</s> (seit 27. Februar 2021 behoben)<br />
<br />
Eine mögliche Lösung für das Problem "Wrong or not supported image format: unknown" habe ich hier beschrieben: {{Link2Forum|Topic=10772|Message=425265|LinkText=Forenbeitrag}}<br />
<br />
== Links ==<br />
* Forenthread zur {{Link2Forum|Topic=10772|LinkText=Erweiterung des IPCAM Moduls}}<br />
* Forenthread zum Thema {{Link2Forum|Topic=21005|LinkText=Bewegungserkennung}}<br />
* Forenthread zum Thema {{Link2Forum|Topic=30723|LinkText=Bewegungsmelder der Kamera "anzapfen"}}<br />
* Webseite des Modulautors zum Thema [http://www.fischer-net.de/hausautomation/videoueberwachung.html Videoüberwachung]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=IPCAM&diff=35084IPCAM2021-02-26T21:44:29Z<p>DelMar: Bekannte Probleme aktualisiert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Einbindung von Netzwerkkameras<br />
|ModType=d<br />
|ModForumArea=Sonstiges<br />
|ModTechName=49_IPCAM.pm<br />
|ModOwner=DelMar ({{Link2FU|26265|Forum}}/[[Benutzer_Diskussion:DelMar|Wiki]])<br />
}}<br />
<br />
[[IPCAM]] ermöglicht die ereignis- oder zeitgesteuerte Erzeugung von Mitschnitten bei Netzwerkkameras. Außerdem ist es möglich, die Kamera im PTZ-Modus oder über eigene Befehle zu steuern.<br />
<br />
== Voraussetzungen ==<br />
Die Kamera(bilder) müssen über eine URL erreichbar sein.<br />
<br />
== Definition ==<br />
Das IPCAM Objekt wird angelegt mit<br />
:<code><nowiki>define <name> IPCAM <ip[:port]> </nowiki></code><br />
<br />
Zusätzlich zum obigen Define muss zwingend noch das ''path'' Attribut gesetzt werden.<br />
<br />
== Attribute ==<br />
Die wichtigsten Attribute von ''IPCAM'' werden im Folgenden aufgeführt, die komplette Liste findet sich in der {{Link2CmdRef|Anker=IPCAMattr}}.<br />
<br />
=== Authentifizierung ===<br />
;basicauth<br />
:Hinterlegung von Benutzernamen und Passwort <br />
<br />
=== Eigene Befehle ===<br />
;cmd01, cmd02, ... cmd15<br />
:Festlegung von Befehlen, die nicht zu den vordefinierten gehören, z.B. <code>attr ipcam cmd01 led_mode=0</code><br />
<br />
=== Vordefinierte Befehle ===<br />
;cmdPanLeft, cmdPanRight, cmdTiltUp, cmdTiltDown, cmdStep <br />
:Diesen Befehlen können die Kameraspezifischen Werte zugeordnet werden, z.B. <code>attr ipcam cmdTiltUp command=0</code><br />
<br />
=== Pfade ===<br />
;path<br />
:...<br />
<br />
== Unterstützte Netzwerkkameras ==<br />
{{Randnotiz|RNText=Die Aufzählungen der unterstützten und der problematischen Netzwerkkameras sollten ergänzt werden, sobald neue Erkenntnisse vorliegen; beide Listen sind nicht vollständig.}}<br />
Bei den folgenden Netzwerkkameras ist gesichert, dass sie durch das ''IPCAM'' Modul unterstützt sind:<br />
* {{Link2Forum|Topic=33347|Message=257115|LinkText=Foscam 9805W}}<br />
* Foscam FI9831P<br />
* Foscam FI9853EP<br />
* {{Link2Forum|Topic=13826|LinkText=Instar 2905}}<br />
* {{Link2Forum|Topic=100493|LinkText=IN-8015 Full HD}}<br />
* {{Link2Forum|Topic=36201|LinkText=IN-6001HD}}<br />
* {{Link2Forum|Topic=11664|LinkText=Instar 6011, 6012, 2905}}<br />
* {{Link2Forum|Topic=58676|LinkText=Instar IN-5905HD, IN-5907HD, IN-6014HD, IN-6012HD-PoE}}<br />
* {{Link2Forum|Topic=15217|LinkText=WansView (Modell nicht näher spezifiziert)}}<br />
* {{Link2Forum|Topic=11664|Message=158052|LinkText=Wansview 620, 625, 6012}}<br />
* Axis 205<br />
* D-Link DCS-933<br />
* Mobotix (jedenfalls S26 und Q25)<br />
* Xiaomi Dafang (nur mit alternativer Firmware)<br />
<br />
Nicht gesichert, ob die Kamera unterstützt wird bzw. ob alle Funktionen nutzbar sind:<br />
* {{Link2Forum|Topic=33347|LinkText=Foscam FI9831W}}<br />
<br />
<br />
=== Pfad-Parameter für Axis 205 ===<br />
<pre><br />
attr Cam1 path /jpg/image.jpg<br />
</pre><br />
<br />
=== Pfad-Parameter für D-Link DCS-933 ===<br />
<pre>attr Cam1 path image.jpg</pre><br />
<br />
=== Parameter für Hikvision DS-2CD2032-I ===<br />
Mit folgenden Parameter wurde (lt. diesem {{Link2Forum|Topic=39932|Message=322269|LinkText=Forenbeitrag}}) die Hikvision DS-2CD2032-I erfolgreich betrieben:<br />
<pre><br />
define Cam1 IPCAM 192.168.xxx.xxx<br />
attr Cam1 basicauth <username>:<passwort><br />
attr Cam1 delay 0<br />
attr Cam1 group Kamera<br />
attr Cam1 icon it_camera<br />
attr Cam1 path Streaming/channels/1/picture?snapShotImageType=JPEG<br />
attr Cam1 snapshots 1<br />
attr Cam1 storage /opt/fhem/www/snapshots/cam1<br />
</pre><br />
<br />
=== Pfad-Parameter für Foscam FI9831P ===<br />
Die Version ist ohne basicauth und hat Nutzer und Passwort direkt in der URL. Kann natürlich geändert werden.<br />
Sämtliche Befehle für die Foscam HD Kameras findet man [https://www.manualslib.com/manual/728928/Foscam-Ip-Camera.html hier]<br />
<pre><br />
define IPKamera IPCAM <ip>:<port><br />
attr IPKamera cmd01 cmd=ptzStopRun&usr=xxx&pwd=xxx<br />
attr IPKamera cmdPanLeft cmd=ptzMoveLeft&usr=xxx&pwd=xxx<br />
attr IPKamera cmdPanRight cmd=ptzMoveRight&usr=xxx&pwd=xxx<br />
attr IPKamera cmdPos01 cmd=ptzGotoPresetPoint&name=<Nameposition>&usr=xxx&pwd=xxx<br />
attr IPKamera cmdTiltDown cmd=ptzMoveDown&usr=xxx&pwd=xxx<br />
attr IPKamera cmdTiltUp cmd=ptzMoveUp&usr=xxx&pwd=xxx<br />
attr IPKamera path cgi-bin/CGIProxy.fcgi?usr=xxx&pwd=xxx&cmd=snapPicture2<br />
attr IPKamera pathCmd cgi-bin/CGIProxy.fcgi<br />
attr IPKamera pathPanTilt cgi-bin/CGIProxy.fcgi?usr=xxx&pwd=xxx<br />
attr IPKamera storage ./www/images/webcam<br />
</pre><br />
<br />
=== Pfad-Parameter für Mobotix ===<br />
<pre><br />
attr IPKamera path /record/current.jpg<br />
</pre><br />
<br />
=== Pfad-Parameter für reolink (E1 Zoom) ===<br />
<pre><br />
attr IPKamera path cgi-bin/api.cgi?cmd=Snap&width=<Breite>&height=<Hoehe>&channel=0&rs=<irgendwas>&user=Username&password=Passwort<br />
</pre><br />
<br />
Beispiel:<br />
<pre><br />
attr IPKamera path cgi-bin/api.cgi?cmd=Snap&width=1024&height=768&channel=0&rs=12345&user=User&password=Pwd<br />
</pre><br />
<br />
Weitere Befehle sind aktuell noch nicht bekannt.<br />
<br />
Es gibt eine spärliche Doku bzgl. cgi hier: https://cdn.reolink.com/wp-content/uploads/2017/01/Reolink-CGI-command-v1.61.pdf<br />
<br />
Allerdings wird wohl für die Steuerbefehle (PTZ) ein Post-Request benötigt.<br />
<br />
Weitere Kommandos wurden hier gesammelt: https://community.jeedom.com/t/reolink-liste-de-commandes-via-api-maj-29-04/25565<br />
<br />
<br />
=== Einstellungen für Foscam C2 und Foscam R2 ===<br />
Eine ausführliche Beschreibung zur Benutzung der IP Kameras Foscam C2 und Foscam R2 findet sich in {{Link2Forum|Topic=84677|LinkText=diesem Forenthread}}.<br />
<br />
<br />
=== Parameter für Xiaomi Dafang ===<br />
Diese Parameter gelten bei installierter alternativer Firmware von [https://github.com/EliasKotlyar/Xiaomi-Dafang-Hacks hier]<br />
<pre><br />
<br />
Attributes:<br />
attr IPKamera cmdPanLeft cmd=motor_left<br />
attr IPKamera cmdPanRight cmd=motor_right<br />
attr IPKamera cmdTiltDown cmd=motor_down<br />
attr IPKamera cmdTiltUp cmd=motor_up<br />
attr IPKamera delay 10<br />
attr IPKamera event-on-update-reading snapshots<br />
attr IPKamera icon it_camera<br />
attr IPKamera path cgi-bin/currentpic.cgi<br />
attr IPKamera pathPanTilt cgi-bin/action.cgi?<br />
attr IPKamera snapshots 5<br />
attr IPKamera storage /opt/fhem/www/ipcamera/dafang_1/shot<br />
</pre><br />
<br />
=== Parameter für INSTAR Full HD ===<br />
Die vollständige Schnittstelle und weitere Beispiele können direkt im [https://wiki.instar.de/Erweitert/ INSTAR-Wiki] eingesehen werden.<br><br />
Zur Integration einer INSTAR Full HD CAM können zum Beispiel folgende Attribute verwendet werden:<br />
<pre><br />
attr INSTAR_8015 basicauth {USERNAME}:{PASSWORD}<br />
attr INSTAR_8015 cmd01 cmd=setinfrared&-infraredstat=auto<br />
attr INSTAR_8015 cmd02 cmd=setinfrared&-infraredstat=close<br />
attr INSTAR_8015 cmd03 cmd=setinfrared&-infraredstat=open<br />
attr INSTAR_8015 cmd04 cmd=setmdalarm&-aname=ftprec&-switch=on<br />
attr INSTAR_8015 cmd05 cmd=setmdalarm&-aname=ftprec&-switch=off<br />
attr INSTAR_8015 cmd06 cmd=setplanrecattr&-planrec_enable=0<br />
attr INSTAR_8015 cmd07 cmd=setplanrecattr&-planrec_enable=1<br />
attr INSTAR_8015 cmd08 cmd=setplanrecattr&-planrec_chn=11<br />
attr INSTAR_8015 cmd09 cmd=setplanrecattr&-planrec_chn=12<br />
attr INSTAR_8015 cmd10 cmd=manualrec&-act=on<br />
attr INSTAR_8015 cmd11 cmd=manualrec&-act=off<br />
attr INSTAR_8015 cmd12 cmd=sdfrmt<br />
attr INSTAR_8015 cmd13 cmd=preset&-act=goto&-number=0<br />
attr INSTAR_8015 cmd14 cmd=preset&-act=goto&-number=1<br />
attr INSTAR_8015 cmd15 cmd=preset&-act=goto&-number=2<br />
attr INSTAR_8015 cmdPanLeft -act=left<br />
attr INSTAR_8015 cmdPanRight -act=right<br />
attr INSTAR_8015 cmdPos15 -act=stop<br />
attr INSTAR_8015 cmdTiltDown -act=down<br />
attr INSTAR_8015 cmdTiltUp -act=up<br />
attr INSTAR_8015 credentials /<ipcam-conf-path>/ipcam.conf<br />
attr INSTAR_8015 eventMap /pos 15:MOVE-STOP/pan left:MOVE-LEFT/pan right:MOVE-RIGHT/tilt up:MOVE-UP/tilt down:MOVE-DOWN/cmd 1:IR-LED-auto/cmd 2:IR-LED-off/cmd 3:IR-LED-on/cmd 4:FTP-rec-on/cmd 5:FTP-rec-off/cmd 6:REC-SD-DISABLE/cmd 7:REC-SD-ENABLE/cmd 8:REC-SD-QUAL-HIGH/cmd 9:REC-SD-QUAL-MID/cmd 10:MAN-REC-Start/cmd 11:MAN-REC-Stop/cmd 12:FORMAT-SD-CARD/cmd 13:POS-WZ/cmd 14:POS-Flur/cmd 15:POS-Park/<br />
attr INSTAR_8015 icon it_camera<br />
attr INSTAR_8015 path tmpfs/snap.jpg<br />
attr INSTAR_8015 pathCmd param.cgi<br />
attr INSTAR_8015 pathPanTilt ptzctrl.cgi?-step=<br />
attr INSTAR_8015 scheme https<br />
attr INSTAR_8015 storage /<ipcam-snapshot-path>/snapshots<br />
attr INSTAR_8015 webCmd POS-WZ:POS-Flur:POS-Park<br />
</pre><br />
<br />
== Nicht unterstützte Netzwerkkameras ==<br />
{{Randnotiz|RNTyp=y|RNText=Die hier aufgeführten Netzwerkkameras sind definitiv nicht unterstützt oder es gibt gravierende, hier beschriebene Einschränkungen.}}<br />
;TRENDnet TV-IP320PI <br />
:Aufruf der Funktion <code>get ''myCam'' image</code> führt zur Fehlermeldung ''...invalid Format''; auf Kamerabild oder Stream kann jedoch über die URL camHostnameOrIP/Streaming/channels/1/Picture (Bild) bzw. camHostnameOrIP/Streaming/channels/1/httpPreview (Stream) zugegriffen werden.<br />
<br />
== Generierte Ereignisse ==<br />
Das Modul ''IPCAM'' generiert die Ereignisse <br />
* <code><nowiki>last: <name_of_device>_snapshot.<image_extension></nowiki></code><br />
* <code><nowiki>snapshots: <total_number_of_taken_snapshots_at_end></nowiki></code><br />
<br />
== Bekannte Probleme ==<br />
Derzeit (08/2015) ist das Logging aus dem Modul zumindest lückenhaft und verbesserungsfähig. So sollten z.B. einige weitere Meldungen zur Fehlereingrenzung bei der Einrichtung eines IPCAM Objekts eingefügt werden:<br />
* Ausgabe des kompletten Pfads / der URL, die bei der Erzeugung eines Snapshots aus einzelnen Bestandteilen zusammengesetzt wird<br />
** Mit 27. Februar 2021 erhält man mit <code>verbose 4</code> zB folgenden Logeintrag: <code>2021.02.27 23:03:39 4: IPCAM (ipcam_reolink) - set cmd requesting <nowiki>http://x.x.x.x/cgi-bin/api.cgi?user=abc&password=def&cmd=GetOsd</nowiki></code><br />
* Die Zuordnung von Meldungen zu ''verbose''-Leveln sollte kontrolliert und ggf. umgestellt werden<br />
* siehe auch diesen {{Link2Forum|Topic=39932|LinkText=Forenthread}}, der Beschreibung von Problemen, eine Hikvision IPCam in Betrieb zu nehmen<br />
<br />
<s>Außerdem müsste das Modul dringend auf die aktuelle Form des Logging, [[verbose|verbose/Log3]], umgestellt werden.</s> (seit 27. Februar 2021 behoben)<br />
<br />
Eine mögliche Lösung für das Problem "Wrong or not supported image format: unknown" habe ich hier beschrieben: {{Link2Forum|Topic=10772|Message=425265|LinkText=Forenbeitrag}}<br />
<br />
== Links ==<br />
* Forenthread zur {{Link2Forum|Topic=10772|LinkText=Erweiterung des IPCAM Moduls}}<br />
* Forenthread zum Thema {{Link2Forum|Topic=21005|LinkText=Bewegungserkennung}}<br />
* Forenthread zum Thema {{Link2Forum|Topic=30723|LinkText=Bewegungsmelder der Kamera "anzapfen"}}<br />
* Webseite des Modulautors zum Thema [http://www.fischer-net.de/hausautomation/videoueberwachung.html Videoüberwachung]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=AttrTemplate&diff=35079AttrTemplate2021-02-25T22:02:35Z<p>DelMar: Tippfehler ausgebessert, zB wurde Doppelpunkt anstatt Semicolon für 'par' angeführt</p>
<hr />
<div>{{SEITENTITEL:AttrTemplate}}<br />
{{Infobox Modul<br />
|ModPurpose=Hilfsmodul bzw. Befehl, das/der die Einrichtung von Geräten erleichtern kann<br />
|ModType=cmd<br />
|ModCmdRef=<br />
|ModForumArea=Automatisierung<br />
|ModTechName=AttrTemplate.pm <br />
|ModOwner=rudolfkoenig ({{Link2FU|8|Forum}} / [[Benutzer Diskussion:Rudolfkoenig|Wiki]])<br />
}}<br />
<br />
AttrTemplate ist ein Hilfsmodul, mit dessen Hilfe Geräte auf einfache Weise mit einer passenden Konfiguration versehen lassen.<br />
<br />
Das Modul ''AttrTemplate'' ist indirekt Bestandteil der SetExtensions, das Modul kann von Modulautoren aber auch ohne diese mit in beliebige (Geräte-) Module mit eingebaut werden. Über diesen Mechanismus ist der Befehl ''attrTemplate'' in einer Vielzahl von Modulen verfügbar.<br />
<br />
==Einführung==<br />
Ziel von ''attrTemplate'' ist es, den Nutzer bei der Konfiguration von Geräten zu unterstützen, indem vorrangig entsprechende [[Attribute]] gesetzt werden. Grundsätzlich ist es jedoch auch möglich, beliebige FHEM-Befehle oder Perl-Code im Rahmen von attrTemplate auszulösen. <br />
Teilt man entsprechende ''templates'', sollte jedoch deutlich darauf hingewiesen werden, wenn ein Template etwas anderes tut als nur Attribute zu setzen, also insbesondere dauerhafte Konfigurationsänderungen in der Hardware selbst vorzunehmen.<br />
<br />
Um Ihnen die Auswahl zu erleichtern, kann <br />
* mit <code>set <Device-Name> attrTemplate ?</code> eine Liste der vorhandenen Templates samt kurzer Beschreibung aufgerufen werden. <br />
* in der Detailansicht der Geräte über das Dropdownfeld ein ''template'' ausgewählt werden. Nun erhält man unmittelbar unter dem ''set''-Befehl ebenfalls entsprechende weitere Informationen sowie den Code des ''template'' angezeigt, der bei Drücken auf ''set'' ausgeführt wird.<br />
Hat man ein passendes ''template'' gefunden, wird mit <code>set <Device-Name> attrTemplate <template_name></code> angewendet, wodurch die entsprechenden, in dem ''template'' hinterlegten Kommandos ausgeführt werden.<br />
<br />
== Syntax ==<br />
<br />
{{Link2Forum|Topic=104804|Message=988100|LinkText=Hier}} und {{Link2Forum|Topic=99195|Message=925952|LinkText=hier}} hat Rudolf König die Syntax erläutert, die in den attrTemplate-Dateien verwendet werden können:<br />
* leere Zeilen werden ignoriert<br />
* Zeilen die mit # anfangen sind Kommentare (s.u. ''desc:'')<br />
* Zeilen, die mit einem der folgenden Schlüsselwörter beginnen, werden speziell interpretiert: ''name: filter: prereq: option: par: desc: farewell: order:''<br />
** '''name:''' Name des Templates, markiert gleichzeitig das Ende des vorherigen Templates<br />
** '''filter:''' devspec2array Ausdruck, der beschreibt, für welche Geräte dieses Template anwendbar ist. Wird erst beim "set ?" ausgeführt.<br />
** '''prereq:''' ist entweder ein Perl-Ausdruck {}, oder ein ''devspec2array'', was genau ein Gerät spezifiziert. Falls mindestens ein prereq existiert, was nicht zutrifft, wird das betroffene Template aus dem Speicher entfernt. Die Auswertung erfolgt beim FHEM Start oder bei {AttrTemplate_Initialize()} <br />
** '''option:''' Syntax entspricht prereq, wird jedoch beim Einlesen des template Files ausgeführt. Falls nicht wahr ist, werden die darauffolgenden Zeilen des Template nicht ausgeführt. Ist für sowas wie "setze zusätzlich Attribut XY falls die Installation HomeAssistant kennt" gedacht.<br />
** '''par:''' kann mehrfach vorkommen, Syntax: <code>par:<ParameterName>;<Kommentar>;<Perl-Code></code>. ''Perl-Code'' versucht den Wert zu finden, falls nicht möglich (''return undef''), wird ein Dialog mit "Replace" angezeigt (bzw. Usage:... im telnet). ''ParameterName'' wird in jeder Befehlzeile ersetzt mit dem Wert. Zusätzlich: ''DEVICE'' wird mit dem Namen des Gerätes ersetzt, wird ''DEVICE'' (z.B. für Modulnamen) als Text benötigt, muß es ''escaped'' werden (z.B. MQTT2_\DEVICE).<br />
** '''desc:''' Kommentar fuer <code>set attrTemplate help ?</code>. Die letzte Zeile mit # vor ''name:'' wird als ''desc:'' interpretiert, falls kein ''desc:'' vorhanden ist.<br />
** '''farewell:''' wird zum Schluss als Dialog (oder Text in telnet) angezeigt, falls beim Anwenden der Befehle kein Fehler aufgetreten ist.<br />
** '''order:''' bestimmt die Reihenfolge, in der die Templates im [[FHEMWEB|Webfrontend]] angezeigt werden; falls nicht vorhanden, wird ''name:'' genommen.<br />
* alle anderen Zeilen werden als auszuführende Befehle interpretiert, wenn man <code>set <Device-Name> attrTemplate TemplateName</code> ausführt.<br />
<br />
==Eigene Templates entwickeln==<br />
Wer plant, mehrere gleichartige Geräte anzulegen, aber andere Einstellungen zu wählen, als sie in den vorhandenen Templates enthalten sind, kann hierfür ebenfalls die attrTemplate-Funktion mit eigenen Templates nutzen. Hierfür können die vorhandenen Templates der im Unterverzeichnis ''fhem/FHEM/lib/AttrTemplate'' zu findenden Dateien als Basis dienen. Ihre Templates speichern Sie einfach als neue Datei mit der Endung ''.template'' im selben Verzeichnis und lesen diese mit <code>{ AttrTemplate_Initialize() }</code> neu ein. Danach können Sie diese direkt verwenden.<br />
<br />
Haben Sie ein Template erstellt und möchten dieses teilen, erstellen Sie einfach einen Beitrag im entsprechenden Forenbereichen, für manche Module existieren auch spezielle Threads (siehe Linkliste unten)<br />
<br />
=== Sprachsteuerung ===<br />
Zur Einbindung von Sprachsteuerungslösungen ([[Siri|Siri,]] [[Alexa]] und [[Google Assistant FHEM Connect|gassistant]]) gibt es eine Reihe zentraler attrTemplates, die meist direkt aus anderen attrTemplates heraus aufgerufen werden. Es ist auch möglich, diese attrTemplate direkt aufzurufen, z.B. wenn man erst später eine Spracherkennungslösung eingebunden hat. Wegen der Namen der templates sollte man dazu direkt die betreffende attrTemplate-file ''[https://svn.fhem.de/trac/browser/trunk/fhem/FHEM/lib/AttrTemplate/speechrecogn.template speechrecogn.template]'' konsultieren, die Beschreibung, welches template für welche Funktionalität gedacht ist sowie eventuelle Parameter sind jeweils hinter dem ''desc:'' zu finden. <br />
<br />
=== Spezielle Fragen zur Entwicklung neuer Templates ===<br />
* Ersetzungen von Schlüsselbegriffen, die durch den AttrTemplate-Code aufgelöst bzw. durch entsprechende andere Werte ersetzt werden, (insbesondere von ''DEVICE'') kann man verhindern, indem man diese ''escaped''. Beispiel: Um im Ergebnis ein "MQTT2_DEVICE" zu erzielen, muß "MQTT2_\DEVICE" geschrieben werden.<br />
<br />
==Warum finde ich das Template xyz nicht?==<br />
In den dropdown-Auswahllisten entsprechender Geräte werden teils deutlich weniger Möglichkeiten angeboten, als in den attrTemplate-files aufgeführt sind. Gesteuert wird dies durch die bereits oben genannten Ausdrücke ''filter'' und ''prereq'':<br />
<br />
=== filter ===<br />
''filter'' bewirkt, dass das template schlicht nicht in der Auswahlliste erscheint, aber an sich geladen ist und über die Kommandozeile auch angewendet werden kann. Allerdings müssen Sie in diesen Fällen damit rechnen, dass mindestens einzelne Elemente zur Ausführung des template-Code nicht vorhanden sind, und Sie diese Parameter über ein Dialogfeld eingeben müssen.<br />
<br />
Geladene attrTemplate werden angezeigt, wenn man <br />
:<code>set <device> attrTemplate ?</code><br />
ausführt.<br />
<br />
In der Regel ist es zu empfehlen, die in filter abgefragten Daten händisch einzupflegen, also z.B. bei einem Tasmota-MQTT2_DEVICE wenigstens das "LWT"-readingsList-Element anzugeben.<br />
<br />
=== prereq ===<br />
Trifft ein ''prereq'' nicht zu, wird das betreffende Template gar nicht geladen. Es erscheint dann weder bei Aufruf des "?", noch kann es über die Kommandozeile ausgeführt werden. In der Regel macht es auch wenig Sinn, ein template ausführen zu wollen, dessen Voraussetzungen nicht gegeben sind, etwa weil (noch) kein passendes Bridge-Gerät definiert ist.<br />
<br />
=== Deaktivierung über ''global'' ===<br />
Darüber hinaus kann das Modul insgesamt über folgende Einstellung deaktiviert werden:<br />
<syntaxhighlight lang="perl"><br />
attr global disableFeatures attrTemplate<br />
</syntaxhighlight><br />
Dann werden insgesamt keine attrTemplates mehr geladen.<br />
<br />
==Links==<br />
* {{Link2Forum|Topic=93370|LinkText=Ankündigung des Moduls im Forum}}<br />
* [[MQTT2_DEVICE#attrTemplate|Wiki zu attrTemplate und MQTT2_DEVICE]] - enthält auch Links zu speziellen Threads für bestimmte Device-Typen<br />
* {{Link2Forum|Topic=94495|LinkText=Thread für getestete Vorschläge (MQTT2_DEVICE)}}.<br />
* {{Link2Forum|Topic=94494|LinkText=Thread für Fragen und Anregungen (MQTT2_DEVICE)}}.<br />
* {{Link2Forum|Topic=97694|LinkText=Thread für HTTPMOD}}.<br />
<references /><br />
[[Kategorie:FHEM-Verwendung]]<br />
[[Kategorie:HOWTOS]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35056TA CMI UVR16x2 UVR16112021-02-21T22:19:44Z<p>DelMar: Formatierung</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestati über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
Zusätzlich zur Anbindung an die offizielle API kann dieses Modul auch den Status der Ausgänge zeigen, so wie das CMI Webinterface das auch macht. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
== Einbindung in FHEM ==<br />
<syntaxhighlight lang="text"><br />
defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]<br />
</syntaxhighlight><br />
Konkretes Beispiel:<br />
<syntaxhighlight lang="text"><br />
defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D<br />
</syntaxhighlight><br />
<br />
Die <code>nodeId</code> verweißt auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als Readings in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
So wird mittels Index ein Name für jeden Wert definiert.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|zentriert]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR16x2Readings.png|mini|zentriert|-]]<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute <code>outputStatesInterval</code> und <code>readingNamesOutputs</code> gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem <code>get readOutputStates</code> aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche angelegt, die mit <code>_State</code> enden. Diese können die Werte 0, 1, 3, 5 und 7 annehmen.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut <code>prettyOutputStates</code> auf 1 setzen, dann werden auch <code>_State_Pretty</code> Readings angelegt, die sprechende Werte, wie zB <code>Auto-On</code>, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35055TA CMI UVR16x2 UVR16112021-02-21T22:16:05Z<p>DelMar: Anzeige des Status der Ausgänge hinzugefügt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestati über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
Zusätzlich zur Anbindung an die offizielle API kann dieses Modul auch den Status der Ausgänge zeigen, so wie das CMI Webinterface das auch macht. Die Abfrage davon ist nicht an das 60 Sekunden Limit gebunden. Auch das CMI Webinterface fragt diese URL zB alle 5 Sekunden ab.<br />
<br />
== Einbindung in FHEM ==<br />
<syntaxhighlight lang="text"><br />
defmod <name> TA_CMI_JSON <ip> <nodeId> [<queryParams>]<br />
</syntaxhighlight><br />
Konkretes Beispiel:<br />
<syntaxhighlight lang="text"><br />
defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D<br />
</syntaxhighlight><br />
<br />
Die <code>nodeId</code> verweißt auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
Falls nur der Status der Ausgänge (Hand-Ein, Hand-Aus, Auto-Ein, Auto-Aus) abgefragt werden soll, können die queryParams weggelassen werden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als Readings in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
So wird mittels Index ein Name für jeden Wert definiert.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|zentriert]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR16x2Readings.png|mini|zentriert|-]]<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Anzeige des Status der Ausgänge ==<br />
Das CMI Webinterface zeigt am oberen Bildschirmrand eine Statusübersicht über alle Ausgänge in beinahe Echtzeit. <br />
Dafür müssen die Attribute outputStatesInterval und readingNamesOutputs gesetzt sein.<br />
Zur Einmaligen Abfrage kann außerdem get readOutputStates aufgerufen werden.<br />
<br />
Damit werden dann zu den normalen Readings auch welche mit _State angelegt, die die Werte 0, 1, 3, 5 und 7 annehmen können.<br />
Wer es gern etwas sprechender hat, kann außerdem das Attribut prettyOutputStates auf 1 setzen, dann werden auch _State_Pretty Readings angelegt, die sprechende Werte, wie zB Auto-On, enthalten.<br />
<br />
{| class="wikitable"<br />
|-<br />
| 01_Pumpe_FBH_State || 1 || 2021-02-20 18:10:47<br />
|-<br />
| 01_Pumpe_FBH_State_Pretty || Auto-Off|| 2021-02-20 18:10:47<br />
|}<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' Account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=35054TA CMI UVR16x2 UVR16112021-02-21T21:55:39Z<p>DelMar: Unterstützte Geräte erweitert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestati über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| CUVR65 || 8E || Yes<br />
|-<br />
| CAN-EZ3 || 8F || Yes<br />
|-<br />
| UVR610 || 91 || Yes<br />
|-<br />
| UVR67 || 92 || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
== Einbindung in FHEM ==<br />
<syntaxhighlight lang="text"><br />
defmod <name> TA_CMI_JSON <ip> <nodeId> <queryParams><br />
</syntaxhighlight><br />
Konkretes Beispiel:<br />
<syntaxhighlight lang="text"><br />
defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D<br />
</syntaxhighlight><br />
<br />
Die <code>nodeId</code> verweißt auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als Readings in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
So wird mittels Index ein Name für jeden Wert definiert.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|zentriert]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR16x2Readings.png|mini|zentriert|-]]<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=34685CanOverEthernet2021-02-01T10:08:42Z<p>DelMar: Formatierung</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner={{Link2FU|26265|DelMar}}<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen des Herstellers [https://www.ta.co.at/ Technische Alternative].<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über den CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit der vorigen Eingabemaske. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br /><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/17511763-cmi-json-api/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
define nfySendTemperatures notify UVR_Temperaturen:.*<br />
set cmi sendDataAnalog 10.0.0.1 20<br />
1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};;1<br />
2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};;1<br />
3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};;1<br />
4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};;1<br />
5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};;1<br />
6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};;1<br />
Danke an cobra112 aus dem Forum für {{Link2Forum|Topic=96170|Message=982328|LinkText=dieses Beispiel}}.<br />
<br />
Hier ein Beispiel für DOIF. [https://forum.fhem.de/index.php/topic,96170.msg1127945.html#msg1127945 Danke an chunter1 aus dem Forum dafür].<br />
<br />
Die Zeilenumbrüche sind nur zwecks besserer Lesbarkeit eingefügt und müssen entfernt werden, damit das Beispiel funktioniert.<br />
([T_WZ:temperature] or [T_BAD:temperature]) ({<br />
fhem("<br />
set CMI sendDataAnalog 192.168.1.100 3<br />
1=".(sprintf("%.1f",ReadingsVal('T_WZ','temperature','0'))).";;;;1<br />
2=".(sprintf("%.1f",ReadingsVal('T_BAD','temperature','0'))).";;;;1<br />
");; 0<br />
})<br />
Das <code>;; 0</code> am Ende des Beispiels ist wichtig, da das DOIF die Ausführung ansonsten mit einer Fehlermeldung quittiert, obwohl die Werte korrekt gesendet wurden.<br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf eine Abfrage pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]<br />
<br />
== Datum / Uhrzeit automatisch beziehen ==<br />
Das CMI kann Datum und Uhrzeit automatisch aus dem Internet beziehen, und diese können auch automatisch an sämtliche Geräte am Bus weitergegeben werden.<br />
<br />
Damit das funktioniert, muss das CMI Knoten #1 sein. Den Rest erledigen die Geräte selbständig untereinander.</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=34684CanOverEthernet2021-02-01T10:06:11Z<p>DelMar: DOIF Beispiel hinzugefügt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModForumArea=Sonstige Systeme<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner={{Link2FU|26265|DelMar}}<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen des Herstellers [https://www.ta.co.at/ Technische Alternative].<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über den CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit der vorigen Eingabemaske. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br /><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/17511763-cmi-json-api/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<br />
<code><br />
define nfySendTemperatures notify UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};;1 2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};;1 3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};;1 4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};;1 5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};;1 6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};;1<br />
</code><br />
<br />
Danke an cobra112 aus dem Forum für {{Link2Forum|Topic=96170|Message=982328|LinkText=dieses Beispiel}}.<br />
<br />
Hier ein Beispiel für DOIF. [https://forum.fhem.de/index.php/topic,96170.msg1127945.html#msg1127945 Danke an chunter1 aus dem Forum dafür].<br />
<br />
Die Zeilenumbrüche sind nur zwecks besserer Lesbarkeit eingefügt und müssen entfernt werden, damit das Beispiel funktioniert.<br />
([T_WZ:temperature] or [T_BAD:temperature]) ({<br />
fhem("<br />
set CMI sendDataAnalog 192.168.1.100 3<br />
1=".(sprintf("%.1f",ReadingsVal('T_WZ','temperature','0'))).";;;;1<br />
2=".(sprintf("%.1f",ReadingsVal('T_BAD','temperature','0'))).";;;;1<br />
");; 0<br />
})<br />
Das <code>;; 0</code> am Ende des Beispiels ist wichtig, da das DOIF die Ausführung ansonsten mit einer Fehlermeldung quittiert, obwohl die Werte korrekt gesendet wurden.<br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf eine Abfrage pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]<br />
<br />
== Datum / Uhrzeit automatisch beziehen ==<br />
Das CMI kann Datum und Uhrzeit automatisch aus dem Internet beziehen, und diese können auch automatisch an sämtliche Geräte am Bus weitergegeben werden.<br />
<br />
Damit das funktioniert, muss das CMI Knoten #1 sein. Den Rest erledigen die Geräte selbständig untereinander.</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=34442CanOverEthernet2020-12-23T10:56:37Z<p>DelMar: Semikolons</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen des Herstellers [https://www.ta.co.at/ Technische Alternative].<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über den CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit der vorigen Eingabemaske. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br /><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/17511763-cmi-json-api/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<br />
<code><br />
define nfySendTemperatures notify UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};;1 2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};;1 3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};;1 4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};;1 5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};;1 6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};;1<br />
</code><br />
<br />
Danke an cobra112 aus dem Forum für {{Link2Forum|Topic=96170|Message=982328|LinkText=dieses Beispiel}}.<br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf eine Abfrage pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]<br />
<br />
== Datum / Uhrzeit automatisch beziehen ==<br />
Das CMI kann Datum und Uhrzeit automatisch aus dem Internet beziehen, und diese können auch automatisch an sämtliche Geräte am Bus weitergegeben werden.<br />
<br />
Damit das funktioniert, muss das CMI Knoten #1 sein. Den Rest erledigen die Geräte selbständig untereinander.</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=34438TA CMI UVR16x2 UVR16112020-12-22T16:30:55Z<p>DelMar: Link aktualisiert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestati über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://www.ta.co.at/download/dokumente/ unter "Regelgeräte & Erweiterungen"<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
== Einbindung in FHEM ==<br />
<syntaxhighlight lang="text"><br />
defmod <name> TA_CMI_JSON <ip> <nodeId> <queryParams><br />
</syntaxhighlight><br />
Konkretes Beispiel:<br />
<syntaxhighlight lang="text"><br />
defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D<br />
</syntaxhighlight><br />
<br />
Die <code>nodeId</code> verweißt auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als Readings in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
So wird mittels Index ein Name für jeden Wert definiert.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|zentriert]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR16x2Readings.png|mini|zentriert|-]]<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=34437TA CMI UVR16x2 UVR16112020-12-22T16:29:18Z<p>DelMar: Link aktualisiert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestati über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich hier: https://help.ta.co.at/DE/<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
== Einbindung in FHEM ==<br />
<syntaxhighlight lang="text"><br />
defmod <name> TA_CMI_JSON <ip> <nodeId> <queryParams><br />
</syntaxhighlight><br />
Konkretes Beispiel:<br />
<syntaxhighlight lang="text"><br />
defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D<br />
</syntaxhighlight><br />
<br />
Die <code>nodeId</code> verweißt auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als Readings in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
So wird mittels Index ein Name für jeden Wert definiert.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|zentriert]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR16x2Readings.png|mini|zentriert|-]]<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=34436CanOverEthernet2020-12-22T16:27:42Z<p>DelMar: Formulierung verbessert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen des Herstellers [https://www.ta.co.at/ Technische Alternative].<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über den CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit der vorigen Eingabemaske. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br /><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/17511763-cmi-json-api/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<br />
<code><br />
define nfySendTemperatures notify UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};1 2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};1 3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};1 4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};1 5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};1 6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};1<br />
</code><br />
<br />
Danke an cobra112 aus dem Forum für {{Link2Forum|Topic=96170|Message=982328|LinkText=dieses Beispiel}}. <br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf eine Abfrage pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]<br />
<br />
== Datum / Uhrzeit automatisch beziehen ==<br />
Das CMI kann Datum und Uhrzeit automatisch aus dem Internet beziehen, und diese können auch automatisch an sämtliche Geräte am Bus weitergegeben werden.<br />
<br />
Damit das funktioniert, muss das CMI Knoten #1 sein. Den Rest erledigen die Geräte selbständig untereinander.</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=34435CanOverEthernet2020-12-22T16:21:54Z<p>DelMar: Link zur Doku aktualisiert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen des Herstellers [https://www.ta.co.at/ Technische Alternative].<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über den CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit der vorigen Eingabemaske. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br /><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/17511763-cmi-json-api/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<br />
<code><br />
define nfySendTemperatures notify UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};1 2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};1 3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};1 4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};1 5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};1 6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};1<br />
</code><br />
<br />
Danke an cobra112 aus dem Forum für {{Link2Forum|Topic=96170|Message=982328|LinkText=dieses Beispiel}}. <br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]<br />
<br />
== Datum / Uhrzeit automatisch beziehen ==<br />
Das CMI kann Datum und Uhrzeit automatisch aus dem Internet beziehen, und diese können auch automatisch an sämtliche Geräte am Bus weitergegeben werden.<br />
<br />
Damit das funktioniert, muss das CMI Knoten #1 sein. Den Rest erledigen die Geräte selbständig untereinander.</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=34325CanOverEthernet2020-12-03T20:00:37Z<p>DelMar: Datum / Uhrzeit automatisch beziehen hinzugefügt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen des Herstellers [https://www.ta.co.at/ Technische Alternative].<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über den CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit der vorigen Eingabemaske. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br /><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/826810/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<br />
<code><br />
define nfySendTemperatures notify UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};1 2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};1 3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};1 4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};1 5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};1 6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};1<br />
</code><br />
<br />
Danke an cobra112 aus dem Forum für {{Link2Forum|Topic=96170|Message=982328|LinkText=dieses Beispiel}}. <br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]<br />
<br />
== Datum / Uhrzeit automatisch beziehen ==<br />
Das CMI kann Datum und Uhrzeit automatisch aus dem Internet beziehen, und diese können auch automatisch an sämtliche Geräte am Bus weitergegeben werden.<br />
<br />
Damit das funktioniert, muss das CMI Knoten #1 sein. Den Rest erledigen die Geräte selbständig untereinander.</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=33849CanOverEthernet2020-09-04T10:36:50Z<p>DelMar: formulierung</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen des Herstellers [https://www.ta.co.at/ Technische Alternative].<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über den CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit der vorigen Eingabemaske. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br /><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/826810/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<br />
<code><br />
define nfySendTemperatures notify UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};1 2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};1 3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};1 4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};1 5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};1 6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};1<br />
</code><br />
<br />
Danke an cobra112 aus dem Forum für {{Link2Forum|Topic=96170|Message=982328|LinkText=dieses Beispiel}}. <br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=33848CanOverEthernet2020-09-04T10:33:13Z<p>DelMar: Link zum Hersteller eingefügt, Formulierungen verbessert</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen des Herstellers [https://www.ta.co.at/ Technische Alternative].<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über den CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit dem vorigen Schirm. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br /><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/826810/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<br />
<code><br />
define nfySendTemperatures notify UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};1 2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};1 3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};1 4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};1 5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};1 6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};1<br />
</code><br />
<br />
Danke an cobra112 aus dem Forum für {{Link2Forum|Topic=96170|Message=982328|LinkText=dieses Beispiel}}. <br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=ZoneMinder&diff=32618ZoneMinder2020-02-05T06:59:08Z<p>DelMar: Troubleshooting Sektion eingeführt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Integration mit Events und Kamerasteuerung der ZoneMinder API<br />
|ModType=d<br />
|ModFTopic=91847<br />
|ModTechName=70_ZoneMinder.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
[[ZoneMinder]] ist eine OpenSource Video-Überwachungssoftware. Das modulare Konzept ermöglicht die Integration von Kameras aller Art (IP, Analog, ...) und bietet Bewegungserkennung, verschiedene Aufnahmemodi und Alarmierung.<br />
Mehr Informationen zu Features findet man auf [https://zoneminder.com zoneminder.com], Informationen zur hier angebundenen API gibt es auf [https://zoneminder.readthedocs.io/en/stable/api.html zoneminder.readthedocs.io].<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
ZoneMinder bietet mehrere Arten der Integration, die einzeln in den Optionen aktiviert werden müssen. In der original Doku werden Kameras als Monitor bezeichnet.<br />
<br />
=== Abhängigkeiten ===<br />
Folgende Perl-Libs werden benötigt:<br />
<code>libcrypt-mysql-perl</code><br />
<br />
=== Alerting ===<br />
Wenn ZoneMinder Bewegungen erkennt, wird die jeweilige Kamera für bestimmte Zeit in den Alarm-Modus versetzt.<br />
Damit auch andere Anwendungen diesen Alarmzustand auswerten können, muss in den Optionen im Tab System die Option <code>OPT_TRIGGERS</code> aktiviert werden.<br />
Rein technisch öffnet ZoneMinder mit dieser Option den TCP-Port 6802, zu welchem sich FHEM verbindet und unmittelbar über neue Ereignisse informiert wird.<br />
Das [https://wiki.zoneminder.com/How_to_use_your_external_camera%27s_motion_detection_with_ZM ZoneMinder-Wiki] enthält detailierte Informationen dazu.<br />
<br />
=== Aufzeichnung und Bewegungserkennung ===<br />
Kameras in ZoneMinder kennen unterschiedliche Betriebsarten ([https://zoneminder.readthedocs.io/en/stable/userguide/definemonitor.html Quelle]):<br />
* '''None''' – Die Kamera ist deaktiviert. Streaming, Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Monitor''' – Die Kamera wird nur für Live-Streaming verwendet. Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Modect''' – steht für MOtion DEteCTtion. Sobald eine Bewegung erkannt wird, wird ein Event generiert und die Aufzeichnung gestartet.<br />
* '''Record''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Dieser Modus kennt keine Bewegungserkennung.<br />
* '''Mocord''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Bewegungen werden innerhalb der Aufnahme als Events markiert.<br />
* '''Nodect''' – steht für No DEteCTtion. Dieser Modus wurde für externe Trigger eingeführt. Es erfolgt keine Bewegungserkennung, die Aufzeichnung kann aber durch externe Trigger gestartet werden. Dies könnten eigene Bewegungsmelder sein, oder aber auch FHEM (Trigger an ZoneMinder zb über <code>set ZM_Monitor_xyz Alarm on|off|on-for-timer <sekunden></code>).<br />
Daneben kann pro Kamera die Bewegungserkennung auch noch explizit aktiviert und deaktiviert werden. Der Begriff Enabled/disabled kann hier irreführend sein, da nicht die Kamera als solche, sondern nur die Bewegungserkennung betroffen ist.<br />
Um eine Kamera zu deaktivieren, muss der Betriebsmodus auf None gestellt werden.<br />
<br />
== Einbindung in FHEM ==<br />
Das FHEM Modul kann in drei Ausbaustufen verwendet werden.<br />
=== Events und Alerting ===<br />
Mit folgender definition wird nur das weitergeben von Events nach ZM aktiviert:<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host><br />
</syntaxhighlight><br />
Beispiel<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder 192.168.1.1<br />
</syntaxhighlight><br />
Diese IP wird - wie oben beschrieben - verwendet, um den Event-Port von ZoneMinder zu öffnen.<br />
In den ZoneMinder Optionen muss hierfür ZM_TRIGGERS aktiv sein.<br />
<br />
=== ZoneMinder 1.32 und später ===<br />
Ab ZoneMinder 1.32 muss das folgende Attribut gesetzt sein, damit sich dieses FHEM-Modul an der ZoneMinder API anmelden kann.<br />
<syntaxhighlight lang="perl">attr zm apiVersion post132</syntaxhighlight><br />
<br />
=== ZoneMinder API ===<br />
Um Kamera-Modi in FHEM verändern und auslesen zu können, muss auf die ZoneMinder-API zugegriffen werden.<br />
Die Authentifizierung hierfür besteht (noch) aus ''username'' und ''password''.<br />
Aus Sicherheitsgründen bietet es sich evtl an, einen eigenen User für FHEM einzurichten, der nur die nötigen Rechte hat.<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host> <ZM-Username> <ZM-Password><br />
</syntaxhighlight><br />
<br />
Mit diesen Parametern kann außerdem direkt von ZoneMinder nach FHEM gestreamt werden und das Reading <code>streamUrl</code> wird verfügbar.<br />
Wichtig: diese Stream-URL enthält username und password als GET-Parameter. Diese sind also in der URL sichtbar, was tatsächlich ein Sicherheitsproblem darstellt.<br />
<br />
Damit die API verwendet werden kann, muss in den ZoneMinder Optionen <code>OPT_USE_API</code> aktiviert sein.<br />
<br />
=== Kameramodi setzen ===<br />
ZoneMinder selber kennt zwar unterschiedliche Aufzeichnungsmodi, kann diese aber nicht Zeit- oder Ereignisgesteuert verändern. FHEM füllt diese Lücke und kann die folgenden Kommandos an ZoneMinder senden:<br />
* '''alarmState''': Alert state in ZoneMinder setzen.<br />
* '''monitorFunction''': Entspricht 'Function' in ZoneMinder.<br />
* '''motionDetectionEnabled''': Entspricht 'Enabled' in ZoneMinder<br />
* '''text''': Setzt einen freien Text im Timestamp der Kamera. Der Timestamp der Kamera muss <code>%Q</code> enthalten und ZoneMinder muss uU neu gestartet werden, nachdem <code>%Q</code> hinzugefügt wurde.<br />
<br />
=== Public Streaming-URLs ===<br />
Hierfür muss als Attribut eine öffentlich erreichbare Adresse für ZoneMinder angegeben werden:<br />
<syntaxhighlight lang="perl"><br />
attr zm publicAddress https://my.home.server.net:8043<br />
</syntaxhighlight><br />
Damit wird in den ZM_Monitor Devices neben <code>streamUrl</code> auch noch ein Reading <code>pubStreamUrl</code> erzeugt.<br />
Für dieses Reading wird das eben angegebene Attribut mit dem Wert <code>PATH_ZMS</code> aus der ZoneMinder Konfiguration kombiniert.<br />
<br />
=== Auth Hash ===<br />
Um nicht username und Password öffentlich sichtbar machen zu müssen, bietet ZoneMinder auch das Sicherheitskonzept des Auth-Hash.<br />
Wenn FHEM erkennt, dass in ZoneMinder <code>AUTH_HASH_SECRET</code> und <code>AUTH_HASH_LOGINS</code> konfiguriert sind, wird der Auth-Hash errechnet. Für public streaming URLs wird dann automatisch der Auth-Hash anstatt Username und Passwort verwendet.<br />
Somit kann die URL auch nach außen gegeben werden.<br />
Wie vorher erwähnt, wird diese nach maximal zwei Stunden ungültig.<br />
Für den Login wird der Auth-Hash übrigens nicht akzeptiert, dh man kann maximal für zwei Stunden den Stream sehen, aber der Auth-Hash berechtigt nicht zum Verändern von Werten.<br />
Das FHEM-ZoneMinder Modul errechnet den Auth-Hash jede Stunde neu, somit sollten die Readings immer einen gültigen Hash liefern.<br />
<br />
Bitte beachten, dass das Einbeziehen der IP für den Auth-Hash derzeit nicht unterstützt wird.<br />
<br />
=== Link zur ZoneMinder Console ===<br />
Das ZoneMinder Device zeigt ganz oben einen Link zur ZoneMinder Console (dem Web UI) an.<br />
Ist <code>publicAddress</code> als Attribut definiert, wird dieser Link mit der publicAddress gebildet und sollte auch im Internet funktionieren.<br />
Wer will, kann so bequem von FHEM aus nach ZoneMinder wechseln.<br />
<br />
=== Live-Streams in FHEMWEB anzeigen ===<br />
Wer auf der Detailseite eines ZM_Monitor Devices auch gleich den Live-Stream sehen will, kann das Attribut <code>showLiveStreamInDetail</code> auf <code>1</code> setzen.<br />
<br />
== Installation des Moduls ==<br />
Das grunsätzliche Setup sollte hier ausreichend beschrieben sein. Seit Oktober 2018 ist das Modul offizieller Bestandteil von FHEM.<br />
Weitere Hintergrund-Infos finden sich außerdem noch [https://forum.fhem.de/index.php/topic,34570.msg828862.html#msg828862 im Forum].<br />
<br />
== Troubleshooting ==<br />
'''Problem:''' ZoneMinder selber funktioniert, allerdings kann FHEM keine Verbindung zur API herstellen. Das Log liefert immer HTTP-404<br />
<br />
'''Antwort:''' Das Problem wird hier diskutiert: https://forums.zoneminder.com/viewtopic.php?t=28554</div>DelMarhttp://wiki.fhem.de/w/index.php?title=TA_CMI_UVR16x2_UVR1611&diff=32538TA CMI UVR16x2 UVR16112020-01-22T21:48:36Z<p>DelMar: Anmerkung zu Version 5 der API</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Auslesen von Ein- und Ausgabestati über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=92740<br />
|ModTechName=72_TA_CMI_JSON.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Das C.M.I. ist ein Zusatzmodul für mehrere "frei programmierbare Universalregler" der Firma Technische Alternative. Damit können die Steuerungen UVR1611, UVR16x2, RSM610, CAN-I/O45, CAN-EZ2, CAN-MTx2 und CAN-BC2 ins lokale Netzwerk eingebunden werden.<br />
Das C.M.I. bietet eine JSON-Schnittstelle an, über die Input, Output und DL-Bus Werte der angeschlossenen Steuerungen abgefragt werden können.<br />
Die Dokumentation zur hier verwendeten JSON-API des C.M.I. befindet sich [https://www.ta.co.at/fernwartung/cmi/ hier], im Tab "Anleitungen".<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
Die JSON-API erlaubt maximal eine Abfrage pro Minute. Darüber hinausgehende Versuche werden mit der Meldung <code>TOO_MANY_REQUESTS</code> abgewiesen.<br><br />
Wird ein Gerät nicht unterstützt, beantwortet das CMI die Anfrage mit dem Status <code>DEVICE NOT SUPPORTED</code>.<br><br />
Die folgenden Geräte werden laut API Dokumentation Version 3 unterstützt (Quelle siehe oben).<br />
<br />
{| class="wikitable"<br />
|-<br />
! Device !! ID (HEX) !! Supported<br />
|-<br />
| CoE || 7F|| No<br />
|-<br />
| UVR1611 || 80 || Yes<br />
|-<br />
| CAN-MT || 81 || No<br />
|-<br />
| CAN-I/O44 || 82 || No<br />
|-<br />
| CAN-I/O35 || 83 || No<br />
|-<br />
| CAN-BC || 84 || No<br />
|-<br />
| CAN-EZ || 85 || No<br />
|-<br />
| CAN-TOUCH || 86 || No<br />
|-<br />
| UVR16x2 || 87 || Yes<br />
|-<br />
| RSM610 || 88 || Yes<br />
|-<br />
| CAN-I/O45 || 89 || Yes<br />
|-<br />
| CMI || 8A || No<br />
|-<br />
| CAN-EZ2 || 8B || Yes<br />
|-<br />
| CAN-MTx2 || 8C || Yes<br />
|-<br />
| CAN-BC2 || 8D || Yes<br />
|-<br />
| BL-NET || A3 || No<br />
|-<br />
|}<br />
<br />
Welches Gerät erkannt wurde, wird in FHEM außerdem im Internal <code>CAN_DEVICE</code> angezeigt.<br />
<br />
== Einbindung in FHEM ==<br />
<syntaxhighlight lang="text"><br />
defmod <name> TA_CMI_JSON <ip> <nodeId> <queryParams><br />
</syntaxhighlight><br />
Konkretes Beispiel:<br />
<syntaxhighlight lang="text"><br />
defmod cmi TA_CMI_JSON 192.168.4.250 1 I,O,D<br />
</syntaxhighlight><br />
<br />
Die <code>nodeId</code> verweißt auf die UVR16x2. Im CMI Web-Interface im Punkt CAN Bus wird ein Bild der UVR gezeigt. Daneben findet sich auch die Information, welcher Node das ist. Bei mir ist es die <code>1</code>.<br />
<code>queryParams</code> kann entweder <code>I</code>, <code>O</code> oder <code>D</code> für Input, Output oder DL-Bus sein.<br />
Damit wird angegeben, welche Informationen vom CMI abgefragt werden sollen.<br />
Diese Abfrage kann, durch Komma getrennt, auch kombiniert erfolgen: <code>I,O,D</code>. Achtung: keine Leerzeichen verwenden.<br />
<br />
Die Gerätedefinition ist komplett, die Konfiguration aber '''noch nicht''' vollständig.<br />
Um Werte tatsächlich als Readings in FHEM zu speichern, müssen noch Namen für eben jene Readings vergeben werden.<br />
Dies erfolgt mit Hilfe der Attribute <code>readingNamesInputs</code>, <code>readingNamesOutputs</code> und <code>readingNamesDL-Bus</code>.<br />
So wird mittels Index ein Name für jeden Wert definiert.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesDL-Bus 1:Durchfluss_Solar 2:T.Solar_RL<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR_16x2_Ausg%C3%A4nge.png|mini|zentriert]]<br />
Die Reihenfolge der Werte ist im UI der UVR16x2 sichtbar. Bitte beachten: bei dem hier verlangten Index handelt es sich nicht um die Absolute Nummer des Wertes, sondern nur um seine Reihenfolge:<br />
Im hier gezeigten Beispiel muss <code>Ladepumpe-Warmwasser</code> als Index <code>3</code> angegeben werden, da es der dritte Wert ist - nicht als <code>6</code>, was der Nummer des Ausgangs entsprechen würde.<br />
<br />
Das konkrete Beispiel für die Outputs sieht so aus:<br />
<syntaxhighlight lang="text"><br />
attr cmi readingNamesOutputs 1:UWP_FBH 2:UWP_Sonde 3:UWP_WW 4:UWP_Solar<br />
</syntaxhighlight><br />
<br />
[[Datei:UVR16x2Readings.png|mini|zentriert|-]]<br />
Mit richtig konfigurierten Attributen werden die Readings wie im Screenshot angezeigt.<br />
<br />
== Authentifizierung ==<br />
Dieses Modul verwendet die Default-Zugangsdaten, um auf die CMI zuzugreifen.<br />
Sollen andere verwendet werden, kann das über die Attribute <code>username</code> und / oder <code>password</code> konfiguriert werden.<br />
Bitte beachten, dass zur Abfrage der JSON-API entweder ein ''admin'' oder ''user'' account verwendet werden muss. ''gast'' accounts dürfen keine Daten abfragen.<br />
<br />
Ab Version 5 der API muss laut Doku ein ''admin'' account zum Aufrufen der API verwendet werden.<br />
<br />
== Installation des Moduls ==<br />
Das Modul ist seit 2.11.2018 Teil der FHEM Distribution.<br />
<br />
== Unterstützte Geräte ==<br />
Obwohl das CMI mehrere Geräte am CAN-Bus unterstützt, wurde nur das UVR 16x2 vom Autor getestet, weil auch nur dieses zur Verfügung steht. Das UVR1611 wurde von Benutzern erfolgreich getestet. Berichte über weitere erfolgreiche Integrationen sind herzlich willkommen.<br />
Bei Interesse weiterer Integrationen ist eine Anfrage im Forum oder auch ein Pull-Request auf [https://github.com/delMar43/FHEM/raw/master/72_TA_CMI_JSON.pm GitHub] herzlich willkommen.<br />
<br />
== Alternative zu diesem Modul ==<br />
Dieses Modul ist zwar sehr einfach zu konfigurieren, allerdings kann man damit unter Umständen nicht alle Werte auslesen, die man möchte. Es gibt nun ein zweites Modul, welches per Can-Over-Ethernet Werte empfangen kann; die Konfiguration gestaltet sich allerdings etwas aufwändiger. Weitere Informationen dazu gibt es hier: [[CanOverEthernet]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=Onkyo_AV-Receiver&diff=31773Onkyo AV-Receiver2019-12-01T12:24:31Z<p>DelMar: Verweis auf Statistik für genutzte Modelle</p>
<hr />
<div>Für AV-Receiver des Herstellers Onkyo gibt es in FHEM bereits ein entsprechendes Modul mit dem netzwerkfähige Modelle gesteuert werden können.<br />
Für die genaue Benutzung in FHEM siehe dazu die {{Link2CmdRef|Anker=ONKYO_AVR}} zu dem Modul ONKYO_AVR.<br />
<br />
== Kompatibiliät ==<br />
Grundsätzlich sollten alle Receiver von Onkyo (auch jene älter als 2013) und neuere Receiver von Pioneer (ca ab dem Jahr 2016) kompatibel mit diesem Modul sein, sofern sie einen Ethernet-Port oder WiFi haben. Auch Receiver mit serieller RS-232 Schnittstelle werden grundsätzlich unterstützt.<br />
<br />
Für Informationen zu derzeit verwendeten Modellen hilft ein Blick auf die Statistik-Seite von FHEM: https://fhem.de/stats/statistics.html<br />
<br />
Ganz unten auf der Seite kann der Filter auf ONKYO_AVR gesetzt werden. <br />
<br />
[[Datei:FHEM Statistik Onkyo.png||]]<br />
<br />
Ein Klick auf die Zahl in der Spalte "# of defined models" zeigt die Zahl aller derzeit verwendeten Modelle.<br />
<br />
== Links ==<br />
<br />
* {{Link2Forum|Topic=15024|LinkText=Forumthread inkl. Modul}}<br />
* [http://www.de.onkyo.com/ Herstellerseite von Onkyo]<br />
<br />
[[Kategorie:Unterhaltungselektronik]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=Datei:FHEM_Statistik_Onkyo.png&diff=31772Datei:FHEM Statistik Onkyo.png2019-12-01T12:19:53Z<p>DelMar: </p>
<hr />
<div>Die Statistik gibt Auskunft über bereits verwendete Modelle</div>DelMarhttp://wiki.fhem.de/w/index.php?title=DevelopmentModuleIntro&diff=31698DevelopmentModuleIntro2019-11-15T08:52:34Z<p>DelMar: readingsDelete hinzugefügt</p>
<hr />
<div>{{Hinweis|Dieser Text ist in Arbeit und muss noch an einigen Stellen ergänzt werden. }}<br />
<br />
<br />
== Einleitung ==<br />
<br />
Um neue Geräte, Dienste, o.ä. in FHEM verfügbar zu machen, kann man ein eigenes Modul in Perl schreiben. Ein Modul wird in FHEM automatisch geladen, wenn ein entsprechendes Device in FHEM definiert wird. Das Modul ermöglicht eine spezifische Kommunikation mit einem physikalischen Gerät, stellt Ergebnisse ("Readings") und Events innerhalb von FHEM zur Verfügung und erlaubt es, das Gerät mit "Set"-/"Get"-Befehlen zu beeinflussen. Dieser Artikel soll den Einstieg in die Entwicklung eigener Module erleichtern.<br />
<br />
Mit dem FHEM-Befehl <code>define</code> werden Devices in FHEM basierend auf einem Modul definiert. Dieser Befehl sorgt dafür, dass ein neues Modul bei Bedarf geladen und initialisiert wird. Ein gutes Beispiel ist hierbei die zentrale Konfigurationsdatei "fhem.cfg" in der sämtliche Devices in Form von <code>define</code>-Statements gespeichert sind.<br />
<br />
Damit das funktioniert müssen der Name des Moduls und der Name der [[#X_Initialize|Initialisierungsfunktion]] identisch sein. Das folgende Beispiel soll dies verdeutlichen:<br />
<br />
Ein Jeelink USB-Stick könnte beispielsweise mit dem Befehl <code>define JeeLink1 ''JeeLink'' /dev/ttyUSB0@57600</code> definiert werden.<br />
<br />
In fhem.pl wird der <code>define</code>-Befehl verarbeitet und geprüft, ob ein Modul mit dem Namen "JeeLink" schon geladen ist. Falls nicht, wird ein Modul mit Namen XY_JeeLink.pm im Modulverzeichnis (z.B. /opt/fhem/FHEM) gesucht und, falls vorhanden, anschließend geladen. <br />
Danach wird die Funktion <code>''JeeLink''_Initialize()</code> aufgerufen um das Modul in FHEM zu registrieren. Eine Moduldatei muss dazu eine Funktion <code>''&lt;Modulname&gt;''_Initialize()</code> enthalten. Durch den Aufruf dieser Funktion wird FHEM mitgeteilt, welche Funktionalitäten dieses Modul unterstützt und durch welche Perl-Funktionen im Modul selbst diese ausimplementiert werden.<br />
<br />
In der Initialisierungsfunktion des Moduls werden die Namen aller weiteren Perl-Funktionen des Moduls, die von fhem.pl aus aufgerufen werden, bekannt gemacht. Dazu wird für jedes Modul ein eigener Hash (genauer "Modul-Hash") mit entsprechenden Werten gefüllt, der in fhem.pl für jedes Modul entsprechend abgelegt wird. Dadurch weiß FHEM wie dieses Modul anzusprechen ist.<br />
<br />
== Grundlegender Aufbau eines Moduls ==<br />
<br />
=== Dateiname ===<br />
<br />
Ein FHEM-Modul wird als Perl-Modul mit der Dateiendung *.pm abgespeichert. Der Dateiname folgt dabei folgendem Schema:<br />
<br />
:<code>''['''Schlüsselnummer''']''<font color="grey">_</font>''['''Modulname''']''<font color="grey">.pm</font></code><br />
<br />
* '''Schlüsselnummer''' - Eine zweistellige Zahl zwischen 00 - 99. Die Schlüsselnummer hat aktuell keine technische Relevanz mehr. In früheren FHEM-Versionen ist sie relevant für [[#Zweistufiges_Modell_f.C3.BCr_Module|zweistufige Module]] (Reihenfolge für [[DevelopmentModuleAPI#Dispatch|Dispatch()]] um logische Module zu prüfen). Die allgemeine Empfehlung ist hierbei eine Schlüsselnummer eines Moduls zu verwenden, welches eine ähnliche Funktionalität bietet. Die Schlüsselnummer 99 hat hierbei eine besondere Bedeutung, da alle Module mit dieser Schlüsselnummer beim Start von FHEM automatisch geladen werden, selbst, wenn sie in der Konfiguration nicht verwendet werden. Daher wird für myUtils 99 als Schlüsselnummer verwendet (99_myUtils.pm). Module mit der Schlüsselnummer 99 werden im SVN nicht akzeptiert (siehe [[SVN Nutzungsregeln]])<br />
* '''Modulname''' - Der Name des Moduls wie er in FHEM bei dem Anlegen einer Gerätedefinition zu verwenden ist. Der Modulname sollte nur aus den folgenden möglichen Zeichen bestehen: Groß-/Kleinbuchstaben, Zahlen sowie Unterstrich (_)<br />
<br />
=== Inhaltlicher Aufbau ===<br />
<br />
Ein Modul ist inhaltlich in folgende Abschnitte unterteilt:<br />
<br />
<syntaxhighlight lang="perl"><br />
#<br />
# 72_MYMODULE.pm <br />
#<br />
<br />
package main;<br />
<br />
# Laden evtl. abhängiger Perl- bzw. FHEM-Hilfsmodule<br />
use HttpUtils;<br />
use [...]<br />
<br />
# FHEM Modulfunktionen<br />
<br />
sub MYMODULE_Initialize() {<br />
...<br />
}<br />
<br />
sub MYMODULE_Define() {<br />
...<br />
}<br />
<br />
...<br />
<br />
# Eval-Rückgabewert für erfolgreiches<br />
# Laden des Moduls<br />
1;<br />
<br />
<br />
# Beginn der Commandref<br />
<br />
=pod<br />
=item [helper|device|command]<br />
=item summary Kurzbeschreibung in Englisch was MYMODULE steuert/unterstützt<br />
=item summary_DE Kurzbeschreibung in Deutsch was MYMODULE steuert/unterstützt<br />
<br />
=begin html<br />
Englische Commandref in HTML<br />
=end html<br />
<br />
=begin html_DE<br />
Deutsche Commandref in HTML<br />
=end html<br />
<br />
# Ende der Commandref<br />
=cut<br />
</syntaxhighlight><br />
<br />
Man kann hierbei von folgender Reihenfolge sprechen:<br />
<br />
# Perl-Code, welcher das Modul implementiert<br />
# Die Zeile <code>1;</code> nachdem der Perl-Code abgeschlossen ist. Dies dient FHEM der Erkennung, dass das Modul erfolgreich und vollständig geladen wurde. Sollte diese Zeile nicht enthalten sein, wird FHEM beim Laden des Moduls die Fehlermeldung <code>Error:Modul 72_MYMODULE deactivated</code> in das Logfile schreiben.<br />
# Commandref zur Dokumentation des Moduls. Diese Dokumentation soll dem User die möglichen Befehle/Attribute/Readings/Events vermitteln. Weitere Informationen und Hinweise findet man in den [[Guidelines zur Dokumentation]].<br />
<br />
== Der Hash einer Geräteinstanz ==<br />
Eine Besonderheit in Perl sind [http://de.wikipedia.org/wiki/Assoziatives_Array#Perl assoziative Arrays], (nicht ganz richtig als "Hash" bezeichnet) in denen die Adressierung nicht über eine Zählvariable erfolgt, sondern über einen beliebigen String. Die internen Abläufe bei der Adressierung führen dazu, dass die Speicherung in und der Abruf aus Hashes relativ langsam ist.<br />
<br />
Der zentrale Speicherort für Informationen einer Geräteinstanz bei FHEM ist ein solcher Hash, der seinerseits in fhem.pl von einem globalen Hash referenziert wird. <br />
<br />
In fhem.pl werden alle Gerätedefinitionen in dem globalen Hash <code>%defs</code> abgelegt. Der Inhalt von <code>$defs{''&lt;Name&gt;''}</code> in fhem.pl verweist dabei auf den Hash der Geräteinstanz in Form einer Hashreferenz. Diesen Verweis (also nur die Adresse) bekommen die Funktionen eines Moduls übergeben (i.d.R. als <code>$hash</code> bezeichnet), welche direkt von fhem.pl aufgerufen werden. In dem Hash stehen beispielsweise die internen Werte des Geräts, die im Frontend als "Internals" angezeigt werden, sowie die Readings des Geräts. <br />
<br />
Beispiele:<br />
*<code>$hash->{NAME}</code> enthält den Namen der Geräteinstanz, <br />
*<code>$hash->{TYPE}</code> enthält die Typbezeichnung des Geräts (Modulname)<br />
<br />
==Ausführung von Modulen==<br />
FHEM arbeitet intern nicht parallel, sondern arbeitet alle Aufgaben seriell nacheinander kontinuierlich ab. Daher wäre es ungünstig, wenn Module Daten von einem physikalischen Gerät abfragen wollen und dabei innerhalb der selben Funktion auf die Antwort des Geräts warten. In dieser Zeit, in der FHEM auf die Antwort des Gerätes warten muss, wäre der Rest von FHEM blockiert. Da immer nur eine Aufgabe zur selben Zeit bearbeitet wird, müssen alle weiteren Aufgaben solange warten. Eine Datenkommunikation innerhalb eines Moduls sollte daher immer ohne Blockierung erfolgen. Dadurch kann FHEM die Wartezeit effizient für andere Aufgaben nutzen um bspw. anstehende Daten für andere Module zu verarbeiten. Es gibt in FHEM entsprechende Mechanismen, welche eine "Non-Blocking"-Kommunikation über verschiedene Wege (z.B. seriell, HTTP, TCP, ...) ermöglichen.<br />
<br />
Dafür werden in FHEM zwei zentrale Listen gepflegt, in der die Filedeskriptoren der geöffneten Kommunikatonsverbindungen gespeichert sind. Auf Linux- bzw. Unix-basierten Plattformen wird der select-Befehl des Betriebssystems verwendet um Filedeskriptoren auf lesbare Daten zu überprüfen. In FHEM gibt es dazu eine Liste (<code>%selectlist</code>), in der die Filedeskriptoren sämtlicher Geräte (z.B. serielle Verbindung, TCP-Verbindung, etc.) gespeichert sind. <br />
<br />
In der zentralen Schleife (Main-Loop) von fhem.pl wird mit <code>select()</code> überwacht, ob über eine der geöffneten Schnittstellen Daten zum Lesen anstehen. Wenn dies der Fall ist, dann wird die Lesefunktion ([[#X_Read|X_Read]]) des zuständigen Moduls aufgerufen, damit es die Daten entgegennimmt und verarbeitet. Anschließend wird die Schleife weiter ausgeführt.<br />
<br />
Auf Windows-Systemen funktioniert dies anders. Hier können USB/Seriell-Geräte nicht per <code>select()</code> überwacht werden. In FHEM unter Windows werden daher diese Schnittstellen kontinuierlich abgefragt ob Daten bereitstehen. Dafür müssen Module zusätzlich zur Lesefunktion eine Abfragefunktion ([[#X_Ready|X_Ready]]) implementieren, welche prüft, ob Daten zum Lesen anstehen. Auch auf Linux/Unix-Plattformen hat diese Funktion eine Aufgabe. Falls nämlich eine Schnittstelle ausfällt, beziehungsweise ein CUL oder USB-zu-Seriell Adapter ausgesteckt wird, dann wird über diese Funktion regelmäßig geprüft ob die Schnittstelle wieder verfügbar wird.<br />
<br />
Innerhalb der eigentlichen Lesefunktion (X_Read) werden dann die Daten vom zugehörigen Gerät gelesen, das nötige Protokoll implementiert um die Daten zu interpretieren und Werte in Readings geschrieben.<br />
<br />
Auch wenn von einem Anwender über einen Get-Befehl Daten aktiv von einem Gerät angefordert werden, sollte nicht blockierend gewartet werden. Eine asynchrone Ausgabe, sobald das Ergebnis vorliegt, ist über [[DevelopmentModuleAPI#asyncOutput|asyncOutput()]] möglich. Siehe {{Link2Forum|Topic=43771|Message=357870|LinkText=Beschreibung}} und {{Link2Forum|Topic=43771|Message=360935|LinkText=Beispiel}}. Weitere Anwendungsbeispiele finden sich im {{Link2Forum|Topic=43052|Message=353477|LinkText=PLEX Modul}} und im überarbeiteten und nicht-blockierenden {{Link2Forum|Topic=42771|Message=348498|LinkText=SYSSTAT Modul}}.<br />
<br />
== Wichtige globale Variablen aus fhem.pl ==<br />
<br />
FHEM arbeitet mit einer Vielzahl an internen Variablen. Die nun folgenden aufgelisteten Variablen sind die wichtigsten, welche man im Rahmen der Modulprogrammierung kennen sollte:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Variable !! Beschreibung<br />
|-<br />
| <code>$init_done</code> || Dient der Erkennung für fhem.pl sowie den Modulen, ob FHEM den Initialisierungsvorgang abgeschlossen hat. Beim Starten von FHEM ist <code>$init_done</code> gleich <code>0</code>. Erst, wenn das Einlesen der Konfiguration, sowie des State-Files (Readings) abgeschlossen ist, wird <code>$init_done</code> auf <code>1</code> gesetzt.<br />
Das gleiche Verfahren wird auch bei dem Befehl <code>rereadcfg</code> angewandt. Während <code>rereadcfg</code> ausgeführt wird (Konfiguration löschen, neu einlesen), ist <code>$init_done</code> gleich <code>0</code>.<br />
<br />
Dies ist insbesondere in der [[#X_Define|Define]]-Funktion eines Moduls relevant. Durch eine Prüfung auf <code>$init_done</code> kann man erkennen, ob eine Definition von Hand (<code>$init_done</code> = 1) oder im Rahmen der Initialisierung (FHEM Start / Rereadcfg => <code>$init_done</code> = 0) erfolgte. Während der Initialisierung stehen bspw. die gesetzten Attribute der Definition noch nicht zur Verfügung und können daher nicht ausgewertet werden (siehe . <br />
|-<br />
| <code>%attr</code> || In <code>%attr</code> werden sämtliche gesetzten Attribute aller Geräte gespeichert. Diese Datenstruktur wird generell durch den <code>attr</code>-Befehl verwaltet. Hierbei wird einem Gerätenamen eine Mehrzahl an Attributnamen mit einem Wert zugeordnet. Attribut-Inhalte können über die Funktion [[DevelopmentModuleAPI#AttrVal|AttrVal()]] ausgelesen werden.<br />
|-<br />
| <code>%cmds</code> || In <code>%cmds</code> wird jedem in FHEM existierendem Befehl die entsprechende Funktion zugewiesen, welche diesen Befehl umsetzt. Module können durch das Eintragen eines Befehlsnamen samt Funktion in <code>%cmds</code> über die [[#X_Initialize|Initialize]]-Funktion eines Moduls einen (oder mehrere) eigene Befehle in FHEM registrieren.<br />
<br />
Die Struktur ist dabei wiefolgt:<br />
<br />
$cmds{''&lt;Befehlsname&gt;''} = { Fn => "''&lt;Funktionsname&gt;''",<br />
Hlp => "''&lt;Aufrufsyntax&gt;''"};<br />
<br />
|-<br />
| <code>%data</code>|| Der eigentliche Zweck von <code>%data</code> ist dem Nutzer eine Möglichkeit zum Speichern von temporären Daten im globalen Kontext zu ermöglichen. Einige Module verwenden <code>%data</code> jedoch auch um modul- & geräteübergreifend Daten auszutauschen.<br />
|-<br />
| <code>%defs</code>|| In <code>%defs</code> werden sämtliche Gerätedefinitionen, bzw. die Hash-Referenzen auf diese, gespeichert. Hier ist jedem Gerätenamen eine Hash-Referenz zugeordnet.<br />
|-<br />
| <code>%modules</code>|| In <code>%modules</code> sind alle geladenen Module gelistet mit ihren entsprechenden Initialisierungsdaten (Funktionsnamen, Attribut-Listen, spezielle Einstellungen, ...). Hier wird für jeden Modulname der Modul-Hash aus der [[#X_Initialize|Initialize]]-Funktion gespeichert. <br />
Desweiteren legen viele Module, welche nach dem [[DevelopmentModuleIntro#Zweistufiges_Modell_f.C3.BCr_Module|zweistufigen Modulkonzept]] hier eine Rückwärtszuordnung von Geräteadressen zu Geräte-Hash an.<br />
|-<br />
| <code>%readyfnlist</code>|| In <code>%readyfnlist</code> sind alle zu prüfenden Verbindungen mit ihrer entsprechendem Geräte-Hash gelistet. FHEM prüft alle hier gelisteten Geräte regelmäßig über eine Aufruf der entsprechenden [[#X_Ready|Ready]]-Funktion.<br />
<br />
Bei einer Nutzung von dem Hilfsmodul [[DevIo|DevIo.pm]] zum Aufbau einer Kommunikationsverbindung, kümmert sich DevIo selbständig um den entsprechenden Eintrag in <code>%readyfnlist</code>.<br />
|-<br />
| <code>%selectlist</code>|| In <code>%selectlist</code> sind alle geöffneten Verbindungen mit ihrer entsprechendem Geräte-Hash gelistet. FHEM prüft alle hier gelisteten Geräte, ob der geöffnete Filedeskriptor unter <code>$hash->{FD}</code> Daten zum Lesen bereitgestellt hat. Ist dass der Fall, wird die entsprechende [[#X_Read|Read]]-Funktion aufgerufen, um anstehende Daten durch das Modul zu verarbeiten.<br />
Bei einer Nutzung von dem Hilfsmodul [[DevIo|DevIo.pm]] zum Aufbau einer Kommunikationsverbindung, kümmert sich DevIo selbständig um den entsprechenden Eintrag in <code>%selectlist</code>.<br />
|}<br />
<br />
Es gibt durchaus viele weitere globale Variablen, die jedoch für sehr spezielle Anwendungsfälle und z.T. nur einzelne Module gedacht sind und daher hier nicht aufgeführt werden.<br />
<br />
== Internals ==<br />
Daten, die ein Modul im Geräte-Hash speichert nennt man Internals. Sie werden als Unterstruktur des Hashes der jeweiligen Geräteinstanz gespeichert, beispielswiese <code>$hash->{NAME}</code> für den Gerätenamen, welcher beim Define-Befehl übergeben wurde und als Internal gespeichert wird. Diese Daten spielen für FHEM eine sehr wichtige Rolle, da sämtliche gerätespezifischen Daten als Internal im Gerätehash gespeichert werden.<br />
<br />
Falls Werte wie z.B. ein Intervall nicht über den Define-Befehl gesetzt werden sollen und im Betrieb einfach änderbar sein sollten, ist eine alternative Möglichkeit die Speicherung in so genannten Attributen. Dann würde man den Define-Befehl so implementieren, dass er kein Intervall übergeben bekommt und statt dessen das Interval als Attribut über den Befehl <code>attr</code> gesetzt wird.<br />
<br />
Generell werden alle Werte, welche direkt in der ersten Ebene von <code>$hash</code> (Gerätehash) gespeichert werden auf der Detail-Seite einer Definition in der FHEMWEB Oberfläche angezeigt. Es gibt jedoch Ausnahmen:<br />
<br />
* <code>$hash->{helper}{URL}</code> - Alle Elemente, welche als Unterelement wieder einen Hash besitzen werden nicht in FHEMWEB dargestellt. Typischerweise speichern Module Daten unter <code>$hash->{helper}</code> interne Daten zwischen, die für den User nicht relevant sind, sondern nur der internen Verarbeitung dienen.<br />
* <code>$hash->{'''.'''<font color="grey">ELEMENT</font>}</code> - Alle Knoten, welche mit einem Punkt beginnen werden in der FHEMWEB Oberfläche nicht angezeigt. Man kann diese Daten jedoch beim Aufruf des [[List|list-Kommandos]] einsehen.<br />
<br />
Es gibt bereits vorbelegte Internals welche in FHEM dazu dienen definitionsbezogene Informationen wie bspw. Namen und Readings zu speichern. Dies sind im besonderen:<br />
<br />
{| class="wikitable"<br />
|-<br />
! style="min-width: 13em;" | Internal !! Beschreibung<br />
|-<br />
| <code>$hash->{NAME}</code> || Der Definitionsname, mit dem das Gerät angelegt wurde. <br />
|-<br />
| <code>$hash->{READINGS}</code> || Enthält alle aktuell vorhandenen Readings. Daten unterhalb dieses Knotens sollte man nicht direkt manipulieren. Um Readings zu Erzeugen gibt es entsprechende [[DevelopmentModuleAPI#Readings_.2F_Events|Reading-Funktionen]].<br />
|-<br />
| <code>$hash->{NR}</code> || Die Positions-Nr. der Definition innerhalb der Konfiguration. Diese dient dazu die Konfiguration in der gleichen Reihenfolge zu speichern, wie die einzelnen Geräte angelegt wurden.<br />
|-<br />
| <code>$hash->{TYPE}</code> || Der Modulname, mit welchem die Definition angelegt wurde.<br />
|-<br />
| <code>$hash->{DEF}</code> || Sämtliche Argumente, welche beim <code>define</code>-Befehl nach dem Modulnamen übergeben wurden.<br />
|-<br />
| <code>$hash->{CFGFN}</code> || Der Dateiname der Konfigurationsdatei in der diese Definition enthalten ist (sofern nicht in fhem.cfg). Dieser Wert ist nur gefüllt, wenn man mit mehreren Konfigurationsdateien arbeitet, welche dann in fhem.cfg via include-Befehl eingebunden werden.<br />
|-<br />
| <code>$hash->{NTFY_ORDER}</code> || Sofern das Modul Events via [[DevelopmentModuleIntro#X_Notify|Notify-Funktion]] verarbeitet enthält jede Definition eine Notify-Order als Zeichenkette bestehend aus dem Notify Order Prefix und dem Definitionsnamen. Details zur Funktionsweise gibt es in der Beschreibung zur [[DevelopmentModuleIntro#X_Notify|Notify-Funktion]] im Abschnitt "Reihenfolge für den Aufruf der Notify-Funktion beeinflussen".<br />
|-<br />
| <code>$hash->{NOTIFYDEV}</code> || Sofern das Modul Events via NotifyFn verarbeitet kann man damit die Definitionen, von denen man Events erhalten will begrenzen. Details zur Funktionsweise gibt es in der Beschreibung zur [[DevelopmentModuleIntro#X_Notify|Notify-Funktion]] im Abschnitt "Begrenzung der Aufrufe auf bestimmte Geräte".<br />
|-<br />
| <code>$hash->{IODev}</code> || Hier wird das zugeordnete IO-Gerät durch [[DevelopmentModuleAPI#AssignIoPort|AssignIoPort()]] gespeichert, welches für den Datentransport und -empfang dieses logischen Gerätes zuständig ist. Dieser Wert existiert nur bei Modulen die nach dem [[DevelopmentModuleIntro#Zweistufiges_Modell_f.C3.BCr_Module|zweistufigen Modulkonzept]] arbeiten. <br />
|-<br />
| <code>$hash->{CHANGED}</code> || Hier werden alle Events kurzzeitig gesammelt, welche für die Eventverarbeitung anstehen. Insbesondere die [[DevelopmentModuleAPI#Readings_.2F_Events|Reading-Funktionen]] speichern hier alle Events zwischen um sie nach Abschluss via [[DevelopmentModuleAPI#DoTrigger|DoTrigger()]] zu verarbeiten. <br />
|-<br />
| <code>$hash->{FD}</code> || Wenn die Definition eine Netzwerkverbindung oder serielle Schnittstelle geöffnet hat (z.B. via [[DevIo]]), so wird der entsprechende File-Deskriptor in diesem Internal gespeichert. Damit kann FHEM alle geöffneten Filedeskriptoren der entsprechenden Definition zuordnen um bei ankommenden Daten die Definition via [[DevelopmentModuleIntro#X_Read|Read-Funktion]] damit zu versorgen.<br />
|-<br />
| <code>$hash->{EXCEPT_FD}</code> || Ähnlich wie <code>$hash->{FD}</code>. Sofern die Definition in <code>[[#Wichtige_globale_Variablen_aus_fhem.pl|%selectlist]]</code> eingetragen ist und ein Fildeskriptor in diesem Internal gesetzt ist, wird bei einer auftretenden Exception bzw. Interrupt die [[DevelopmentModuleIntro#X_Except|Except]]-Funktion des entsprechenden Moduls aufgerufen um darauf zu reagieren.<br />
|}<br />
<br />
Generell sollte man die meisten der hier genannten systemweiten Internals nicht modifizieren, da ansonsten die korrekte Funktionsweise von FHEM nicht mehr garantiert werden kann.<br />
<br />
== Readings ==<br />
Daten, welche von einem Gerät gelesen werden und in FHEM in einer für Menschen verständlichen Form zur Verfügung gestellt werden können, werden Readings genannt. Sie geben den Status des Gerätes wieder und erzeugen Events innerhalb von FHEM auf die andere Geräte reagieren können. Sie werden als Unterstruktur des Hashes der jeweiligen Geräteinstanz gespeichert, beispielsweise <br />
*<code>$hash->{READINGS}{temperature}{VAL}</code> für die Temperatur eines Fühlers<br />
*<code>$hash->{READINGS}{temperature}{TIME}</code> für den Zeitstempel der Messung<br />
<br />
Für den lesenden Zugriff auf Readings steht die Funktion <code>[[DevelopmentModuleAPI#ReadingsVal|ReadingsVal()]]</code> zur Verfügung. Ein direkter Zugriff auf die Datenstruktur sollte nicht vorgenommen werden.<br />
<br />
Readings werden im Statefile von FHEM automatisch auf der Festplatte zwischengespeichert, damit sie nach einem Neustart sofort wieder zur Verfügung stehen. Dadurch ist der letzte Status eines Gerätes vor einem Neustart nachvollziehbar.<br />
<br />
Readings, die mit einem Punkt im Namen beginnen, haben eine funktionale Besonderheit. Sie werden im FHEMWEB nicht angezeigt und können somit als "Permanentspeicher" für kleinere Daten innerhalb des Moduls genutzt werden. Um größere Datenmengen permanent zu speichern sollte man jedoch die Funktion <code>[[DevelopmentModuleAPI#setKeyValue|setKeyValue()]]</code> verwenden.<br />
<br />
Zum Setzen von Readings sollen <br />
*bei Gruppen von Readings der Funktionsblock <code>[[DevelopmentModuleAPI#readingsBeginUpdate|readingsBeginUpdate()]]</code>, <code>[[DevelopmentModuleAPI#readingsBulkUpdate|readingsBulkUpdate()]]</code> (mehrfach wiederholt), <code>[[DevelopmentModuleAPI#readingsEndUpdate|readingsEndUpdate()]]</code><br />
*bei einzelnen Updates die Funktion <code>[[DevelopmentModuleAPI#readingsSingleUpdate|readingsSingleUpdate()]]</code> <br />
aufgerufen werden. Dabei kann man auch angeben, ob dabei ein Event ausgelöst werden soll oder nicht. Events erzeugen, je nach Hardwareperformance, spürbare Last auf dem System (siehe [[DevelopmentModuleIntro#X_Notify|NotifyFn]]), das Ändern von Readings ohne dass dabei Events erzeugt werden jedoch nicht.<br />
<br />
Eine Sequenz zum Setzen von Readings könnte folgendermaßen aussehen:<br />
<br />
<syntaxhighlight lang="perl"><br />
readingsBeginUpdate($hash);<br />
readingsBulkUpdate($hash, $readingName1, $wert1 );<br />
readingsBulkUpdate($hash, $readingName2, $wert2 );<br />
readingsEndUpdate($hash, 1);<br />
</syntaxhighlight><br />
<br />
Um Readings zu löschen, wird der Befehl <code>readingsDelete</code> empfohlen. Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
readingsDelete($hash, $readingsname) <br />
</syntaxhighlight><br />
<br />
Hintergrundinfo dazu aus dem Forum: https://forum.fhem.de/index.php/topic,83069.msg753066.html#msg753066<br />
<br />
:<code>CommandDeleteReading</code> bzw. <code>deletereading</code> ist eher fuer den Endbenutzer und seine userReadings gedacht, und macht bei den Modulen die unnoetige Schleife ueber devspec2array. Wenn der Modulautor beim Aufruf auch $cl weitergibt, und der Anwender meint, dieses Geraet auf blacklist setzen zu muessen, dann kann das Modul sein eigenes Reading nicht entfernen, und das ist kontraproduktiv.<br />
<br />
== Events ==<br />
<br />
FHEM verfügt über einen Event-Mechanismus um Änderungen verschiedenster Art an einzelne oder alle Definitionen mitzuteilen. Jedes Modul (und damit alle Definitionen dieses Moduls) können auf Events von FHEM selber (Definition <code>global</code>) oder von anderen Definitionen reagieren und dadurch selber aktiv werden. Ein Event wird innerhalb von FHEM als Zeichenkette behandelt.<br />
<br />
Events sind grundsätzlich immer definitionsbezogen. Das bedeutet, dass ein Event immer in Verbindung mit einem Definitionsnamen erzeugt wird. Jede Definition, welche ein Event verarbeitet, erhält den Definitions-Hash (<code>$hash</code>) der auslösenden Definition.<br />
<br />
Events werden typischerweise bei der Erstellung von Readings implizit für jedes einzelne Reading erzeugt. Es gibt jedoch auch Events die nichts mit Readings zu tun haben um anderweitige Änderungen bekannt zu geben.<br />
<br />
Eigene Events können in FHEM mit der Funktion [[DevelopmentModuleAPI#DoTrigger|DoTrigger()]] erzeugt werden. Um auf Events in einem Modul reagieren zu können, muss eine [[#X_Notify|Notify]]-Funktion implementiert sein. Sobald ein oder mehrere Events für eine Definition getriggert werden, prüft FHEM, welche Definitionen über Events der auslösenden Definition informiert werden möchten. Diese werden dann nacheinander in einer bestimmten Reihenfolge durch Aufruf der [[#X_Notify|Notify]]-Funktion über anstehende Events in Kenntnis gesetzt. Es obliegt dann dem jeweiligen Modul, wie es auf die Events reagiert.<br />
<br />
=== globale Events ===<br />
<br />
Als "globale Events" werden alle Events bezeichnet, die durch die Definition <code>global</code> erzeugt werden. Es handelt sich hierbei um Events die Strukturänderungen in der Konfiguration, als auch systemweite Ereignisse zu FHEM selbst signalisieren.<br />
<br />
Hier eine kurze Zusammenfassung, welche Events durch <code>global</code> getriggert werden können:<br />
<br />
<u>Allgemeine Events:</u><br />
<br />
{| class="wikitable"<br />
|-<br />
! Event-Text !! Beschreibung.<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>INITIALIZED</code>''' || Der Start von FHEM ist abgeschlossen. Sämtliche Definitionen und Attribute wurden aus der Konfiguration (fhem.cfg oder configDB) eingelesen, sowie sämtliche Readings sind aus dem State-File eingelesen und stehen nun voll umfänglich zur Verfügung.<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>REREADCFG</code>''' || Die Konfiguration wurde erneut eingelesen. Dies bedeutet, es wurden alle Definitionen/Attribute/Readings aus FHEM entfernt und durch Einlesen der Konfiguration neu angelegt. (FHEM-Befehl: "rereadcfg")<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>SAVE</code>''' || Die laufende Konfiguration soll gespeichert werden (in fhem.cfg oder configDB). Dieses Event wird '''VOR''' dem Speichern der Konfiguration getriggert. Sobald der Trigger verarbeitet wurde, beginnt das Speichern der Konfiguration. (FHEM-Befehl: "save")<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>SHUTDOWN</code>''' || FHEM wird sich beenden. (FHEM-Befehl: "shutdown")<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code> DELAYEDSHUTDOWN </code>''' || FHEM wird sich beenden. (FHEM-Befehl: "shutdown")<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>UPDATE</code>''' || Es wurde ein Update erfolgreich installiert. (FHEM-Befehl: "update")<br />
|}<br />
<br />
<u>Definitionsbezogene Events:</u><br />
<br />
{| class="wikitable"<br />
|-<br />
! Event-Text !! Beschreibung.<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>DEFINED ''<Name>''</code>''' || Es wurde eine neue Definition mit Namen <code>''<Name>''</code> angelegt. (FHEM-Befehl: "define")<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>DELETED ''<Name>''</code>''' || Die Definition mit dem Namen <code>''<Name>''</code> wurde gelöscht. (FHEM-Befehl: "delete")<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>RENAMED ''<Alt>'' ''<Neu>''</code>''' || Die Definition mit dem Namen <code>''<Alt>''</code> wurde in den Namen <code>''<Neu>''</code> umbenannt. (FHEM-Befehl: "rename")<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>MODIFIED ''<Name>''</code>''' || Die Definition mit dem Namen <code>''<Name>''</code> wurde modifiziert. (FHEM-Befehl: "modify")<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | '''<code>UNDEFINED ''<Name> <Modul> <Define-Parameter>''</code>''' || Es wurde eine Nachricht von einem physikalischen Modul (siehe [[#Zweistufiges Modell für Module|zweistufiges Modulkonzept]]) erhalten, für die keine passende logische Definition in FHEM existiert. Details dazu, siehe dazu Abschnitt [[#Automatisches Anlegen von logischen Gerätedefinitionen (autocreate)|Automatisches Anlegen von logischen Gerätedefinitionen (autocreate)]].<br />
|}<br />
<br />
=== Begrenzung von Events ===<br />
<br />
Ein Modul, welches Events verarbeitet, kann die Eventverarbeitung auf bestimmte Definitionen begrenzen. Dadurch werden nur Events an das Modul gemeldet (via [[#X_Notify|X_Notify()]]), welche von einer oder mehreren bestimmten Definitionen getriggert wurden. Dadurch werden unnötige Events nicht an das Modul gemeldet und schont somit Ressourcen.<br />
<br />
Standardmäßig werden sämtliche Events ohne Begrenzung an ein Modul gemeldet, welches eine [[#X_Notify|Notify]]-Funktion implementiert hat und somit Events verarbeiten kann. Details zur Begrenzung von Events findet man in der Beschreibung zur Modulfunktion [[#X_Notify|X_Notify()]].<br />
<br />
=== Reihenfolge der Eventverarbeitung ===<br />
<br />
Ein getriggertes Event wird nacheinander gegen jede Definition geprüft, deren Modul eine [[#X_Notify|Notify]]-Funktion implementiert hat. Dies bedeutet, jede Definition wird nacheinander durch Aufruf der [[#X_Notify|Notify]]-Funktion mit dem Definitionshash der auslösenden Definition aufgerufen.<br />
<br />
Unter bestimmten Umständen kann es erforderlich sein, in diese Reihenfolge einzugreifen. Beispielsweise wenn das eigene Modul und deren Definitionen das Event als letztes oder erstes verarbeiten müssen. Ein Beispiel bietet hierbei das Modul [[dewpoint]], welches Events vor allen anderen Modulen verarbeiten muss.<br />
<br />
Details, wie man die Reihenfolge der Eventverarbeitung steuern kann, findet man in der Beschreibung zur Modulfunktion [[#X_Notify|X_Notify()]].<br />
<br />
== Attribute ==<br />
Damit der Nutzer das Verhalten einer einzelnen Gerätedefinition zur Laufzeit individuell anpassen kann, gibt es in FHEM für jede Definition sogenannte Attribute, welche mit dem Befehl <code>attr</code> gesetzt werden können.<br />
Diese stehen dann dem Modul unmittelbar zur Verfügung um das Verhalten während der Ausführung zu beeinflussen. Attribute werden zusammen mit dem <code>define</code>-Befehl der jeweiligen Definition beim Speichern der aktuellen Konfiguration von FHEM in die Konfigurationsdatei geschrieben. Beim Neustart werden die entsprechenden Befehle ausgeführt um alle Definition inkl. Attribute wieder anzulegen. Zur Laufzeit werden Attribute in dem globalen Hash <code>%attr</code> mit dem Definitionsnamen als Index (<code>$attr{$name} = $value</code>) gespeichert. Ein Attribut mit dem Namen <code>header</code> würde beispielsweise mit <code>$attr{$name}{header}</code> adressiert. Generell sollte <code>%attr</code> nicht durch direkten Zugriff manipuliert/benutzt werden.<br />
<br />
Zum Auslesen von Attributen sollte die Funktion [[DevelopmentModuleAPI#AttrVal|AttrVal()]] verwendet werden.<br />
<br />
Welche Attribute ein Modul unterstützt muss in der Funktion <code>[[#X_Initialize|X_Initialize]]</code> durch Setzen von <code>$hash->{AttrList}</code> bekannt gemacht werden (siehe unten).<br />
<br />
Wenn beim Setzen von Attributen in einer Gerätedefinition entsprechende Werte geprüft werden sollen oder zusätzliche Funktionalitäten implementiert werden müssen, dann muss dies in der Funktion <code>[[#X_Attr|X_Attr]]</code> (siehe unten) implementiert werden. Hier kann man bspw. einen Syntaxcheck für Attribut-Werte implementieren um ungültige Werte zurückzuweisen.<br />
<br />
== Modulfunktionen ==<br />
<br />
Damit fhem.pl ein Modul nutzen kann, muss dieses entsprechende Funktionen mit einer vorgegebenen Aufrufsyntax implementieren. Durch die Bekanntgabe dieser modulspezifischen Funktionen können Daten zwischen fhem.pl und einem Modul entsprechend ausgetauscht werden. Es gibt verschiedene Arten von Funktionen die ein Modul anbieten muss bzw. kann, je nach Funktionsumfang.<br />
<br />
=== Die wichtigsten Funktionen in einem Modul ===<br />
<br />
Folgende Funktion muss ein Modul mit dem beispielhaften Namen "X" mindestens bereitstellen:<br />
<br />
{| class="wikitable"<br />
|-<br />
! style="text-align:left" | Funktionsname !! style="text-align:left" | Kurzbeschreibung<br />
|-<br />
| [[#X_Initialize|X_Initialize]] || Initialisiert das Modul und gibt den Namen zusätzlicher Modulfunktionen bekannt, sowie modulspezifische Einstellungen. Wird direkt nach dem erfolgreichen Laden des Moduls durch fhem.pl aufgerufen.<br />
|}<br />
<br />
Die folgenden Funktionen sind die wichtigsten Funktionen, welche je nach Anwendungsfall zu implementieren sind. Es handelt sich hierbei um die wichtigsten Vertreter, welche in den meisten Modulen Verwendung finden. Nicht alle Funktionen machen jedoch in jedem Modul Sinn. Generell sollte auch hier bei jeder Funktion der Modulname vorangestellt werden um ein einheitliches Namensschema zu gewährleisten. Hier die wichtigsten Modulfunktionen:<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="text-align:left" | Funktionsname !! style="text-align:left" class="unsortable"| Kurzbeschreibung<br />
|-<br />
| [[#X_Define|X_Define]] || Wird im Rahmen des <code>define</code>-Befehls aufgerufen.<br />
|-<br />
| [[#X_Undef|X_Undef]] || Wird im Rahmen des <code>delete</code>-Befehls, sowie <code>rereadcfg</code>-Befehl aufgerufen. Dient zum Abbau von offenen Verbindungen, Timern, etc.<br />
|-<br />
| [[#X_Delete|X_Delete]] || Wird im Rahmen des beim <code>delete</code>-Befehls aufgerufen wenn das Gerät endgültig gelöscht wird um weiterführende Aktionen vor dem Löschen durchzuführen.<br />
|-<br />
| [[#X_Get|X_Get]] || Wird im Rahmen des <code>get</code>-Befehls aufgerufen um Daten vom Gerät abzufragen<br />
|-<br />
| [[#X_Set|X_Set]] || Wird im Rahmen des <code>set</code>-Befehls aufgerufen um Daten an das Gerät zu senden.<br />
|-<br />
| [[#X_Attr|X_Attr]] || Wird im Rahmen des <code>attr</code>-Befehls aufgerufen um Attributwerte zu prüfen)<br />
|-<br />
| [[#X_Read|X_Read]] || Wird durch FHEM aufgerufen, wenn ein gelisteter Filedeskriptor in <code>[[#Wichtige_globale_Variablen_aus_fhem.pl|%selectlist]]</code> Daten zum Lesen bereitstellt.<br />
|-<br />
| [[#X_Ready|X_Ready]] || Wird unter Windows durch FHEM aufgerufen um zyklisch einen seriellen Filedeskriptor auf lesbare Daten zu prüfen. Unter Linux dient diese Funktion dem Wiederaufbau verlorener Verbindungen.<br />
|-<br />
| [[#X_Notify|X_Notify]] || Verarbeitet Events von anderen Geräten innerhalb von FHEM<br />
|-<br />
| [[#X_Rename|X_Rename]] || Wird aufgerufen, wenn ein Gerät umbenannt wird.<br />
|-<br />
| [[#X_Shutdown|X_Shutdown]] || Wird beim Herunterfahren von FHEM ausgeführt.<br />
|-<br />
| [[#X_DelayedShutdown | X_DelayedShutdown]] || Wird beim Herunterfahren von FHEM ausgeführt.<br />
|}<br />
<br />
Diese Funktionen werden in diesem Abschnitt genauer beschrieben.<br />
<br />
==== X_Initialize ====<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Initialize($)<br />
{<br />
my ($hash) = @_;<br />
...<br />
}<br />
</syntaxhighlight><br />
<br />
Das <code>X</code> im Namen muss dabei auf den Namen des Moduls bzw. des definierten Gerätetyps geändert werden. Im Modul mit der Datei <code>36_JeeLink.pm</code> beispielsweise ist der Name der Funktion <code>JeeLink_Initialize</code>. Die Funktion wird von fhem.pl nach dem Laden des Moduls aufgerufen und bekommt eine leere Hashreferenz für den Initialisierungsvorgang übergeben. <br />
<br />
Dieser Hash muss nun von X_Initialize mit allen modulrelevanten Funktionsnamen gefüllt werden. Anschließend wird dieser Hash durch fhem.pl im globalen Hash <code>%modules</code> gespeichert. <code>$modules{ModulName}</code> wäre dabei der Hash für das Modul mit dem Namen <code>ModulName</code>. Es handelt sich also nicht um den oben beschriebenen Hash der Geräteinstanzen sondern einen Hash, der für jedes Modul existiert und modulspezifische Daten wie bspw. die implementierten Modulfunktionen enthält. Die Initialize-Funktion setzt diese Funktionsnamen, in den Hash des Moduls wie folgt:<br />
<br />
<syntaxhighlight lang="perl"><br />
$hash->{DefFn} = "X_Define";<br />
$hash->{UndefFn} = "X_Undef";<br />
$hash->{DeleteFn} = "X_Delete";<br />
$hash->{SetFn} = "X_Set";<br />
$hash->{GetFn} = "X_Get";<br />
$hash->{AttrFn} = "X_Attr";<br />
$hash->{ReadFn} = "X_Read";<br />
$hash->{ReadyFn} = "X_Ready";<br />
$hash->{NotifyFn} = "X_Notify";<br />
$hash->{RenameFn} = "X_Rename";<br />
$hash->{ShutdownFn} = "X_Shutdown";<br />
$hash->{DelayedShutdownFn} = "X_ DelayedShutdown";<br />
</syntaxhighlight><br />
<br />
Um eine entsprechende Funktion in FHEM bekannt zu machen muss dazu der Funktionsname, wie er im Modul als <code>sub &lt;''Funktionsname''&gt;() { ... }</code> definiert ist, als Zeichenkette in <code>$hash</code> gesetzt werden. Dabei sollten die entsprechenden Funktionsnamen immer den Modulnamen (in diesem Beispiel <code>X</code>) als Präfix verwenden.<br />
Auf diese Weise können sämtliche modulspezifisch implementierten Funktionen wie <code>X_Read</code>, <code>X_Parse</code> etc. durch Zuweisung an <code>$hash->{ReadFn}</code> bzw. <code>$hash->{ParseFn}</code> usw. bekannt gemacht werden.<br />
<br />
Darüber hinaus sollten die vom Modul unterstützten Attribute definiert werden:<br />
<br />
<syntaxhighlight lang="perl"><br />
$hash->{AttrList} =<br />
"do_not_notify:1,0 " . <br />
"header " .<br />
$readingFnAttributes; <br />
</syntaxhighlight><br />
<br />
Die Auflistung aller unterstützten modulspezifischen Attribute erfolgt in Form einer durch Leerzeichen getrennten Liste in <code>$hash->{AttrList}}</code>. Es gibt in FHEM globale Attribute, die in allen Gerätedefinitionen verfügbar sind und nur modulspezifische Attribute die jedes Modul via <code>$hash->{AttrList}</code> über die eigene Initialize-Funktion setzt. In fhem.pl werden dann die entsprechenden Attributwerte beim Aufruf eines <code>attr</code>-Befehls in die globale Datenstruktur <code>$attr{$name}</code>, z.B. <code>$attr{$name}{header}</code> für das Attribut <code>header</code> gespeichert. Falls im Modul weitere Aktionen oder Prüfungen beim Setzen eines Attributs nötig sind, dann kann wie im Beispiel oben die [[#X_Attr|Attr]]-Funktion implementiert und in der Initialize-Funktion bekannt gemacht werden.<br />
<br />
Die Variable <code>$readingFnAttributes</code>, die im obigen Beispiel an die Liste der unterstützten Attribute angefügt wird, definiert Attributnamen, die dann zusätzlich gemacht werden, wenn das Modul zum Setzen von Readings die Funktionen <code>[[DevelopmentModuleAPI#readingsBeginUpdate|readingsBeginUpdate()]]</code>, <code>[[DevelopmentModuleAPI#readingsBulkUpdate|readingsBulkUpdate()]]</code>, <code>[[DevelopmentModuleAPI#readingsEndUpdate|readingsEndUpdate()]]</code> oder <code>[[DevelopmentModuleAPI#readingsSingleUpdate|readingsSingleUpdate()]]</code> verwendet. In diesen Funktionen werden Attribute wie <code>event-min-interval</code> oder auch <code>event-on-change-reading</code> ausgewertet. Für Details hierzu siehe commandref zu {{Link2CmdRef|Anker=readingFnAttributes|Label=readingFnAttributes}}.<br />
<br />
<br />
<u>Nutzung von parseParams()</u><br />
<br />
Die Funktion <code> [[DevelopmentModuleAPI#parseParams|parseParams()]]</code> unterstützt Modul-Autoren beim Parsen von Übergabeparametern, welche bei <code>define</code>, <code>get</code> und <code>set</code> Kommandos an die entsprechenden Modulfunktionen übergeben werden. Dadurch lassen sich auf einfache Weise insbesondere komplexe Parameter (wie bspw. Perl-Ausdrücke) sehr einfach parsen.<br />
<br />
Diese Zusatzfunktion kann man in der Initialize-Funktion einfach über folgenden Parameter für [[#X_Define|Define]]-, [[#X_Get|Get]]- und [[#X_Set|Set]]-Funktion modulweit aktivieren:<br />
<syntaxhighlight lang="perl">$hash->{parseParams} = 1;</syntaxhighlight><br />
Sobald es gesetzt ist wird automatisch durch fhem.pl <code>[[DevelopmentModuleAPI#parseParams|parseParams()]]</code> aufgerufen und die an die [[#X_Define|Define]]-, [[#X_Get|Get]]- und [[#X_Set|Set]]-Funktion übergebenen Parameter ändern sich wie weiter unten in den jeweiligen Funktionen beschrieben.<br />
<br />
==== X_Define ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Define($$)<br />
{<br />
my ( $hash, $def ) = @_;<br />
<br />
...<br />
<br />
return $error;<br />
}<br />
</syntaxhighlight><br />
<br />
Die Define-Funktion eines Moduls wird von FHEM aufgerufen wenn der Define-Befehl für ein Geräte ausgeführt wird und das Modul bereits geladen und mit der Initialize-Funktion initialisiert ist. Sie ist typischerweise dazu da, die übergebenen Parameter zu prüfen und an geeigneter Stelle zu speichern sowie einen Kommunikationsweg zum Gerät zu öffnen (z.B. TCP-Verbindung, USB-Schnittstelle o.ä.) oder einen [[#Pollen_von_Geräten|Status-Timer]] zu starten.<br />
Sie beginnt typischerweise mit:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Define($$)<br />
{<br />
my ( $hash, $def ) = @_;<br />
my @a = split( "[ \t][ \t]*", $def );<br />
...<br />
</syntaxhighlight><br />
<br />
Als Übergabeparameter bekommt die Define-Funktion den Hash der Geräteinstanz sowie den die im <code>define</code>-Befehl übergebenen Parameter. Welche bzw. wie viele Parameter <br />
akzeptiert werden und welcher Syntax diese entsprechen müssen ist Sache dieser Funktion. Im obigen Beispiel wird die Argumentzeile <code>$def</code> in ein Array aufgeteilt (durch Leerzeichen/Tabulator getrennt) und so können die vom Modul bzw. der Define-Funktion erwarteten Werte über das Array der Reihe nach verarbeitet werden:<br />
<br />
<syntaxhighlight lang="perl"><br />
my $name = $a[0];<br />
my $module = $a[1];<br />
my $url = $a[2];<br />
my $inter = 300;<br />
<br />
if(int(@a) == 4) { <br />
$inter = $a[3]; <br />
if ($inter < 5) {<br />
return "interval too small, please use something > 5s, default is 300 seconds";<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Damit die übergebenen Werte auch anderen Funktionen zur Verfügung stehen und an die jeweilige Geräteinstanz gebunden sind, werden die Werte typischerweise als Internals im Hash der Geräteinstanz gespeichert:<br />
<br />
<syntaxhighlight lang="perl"><br />
$hash->{url} = $url;<br />
$hash->{Interval} = $inter;<br />
</syntaxhighlight><br />
<br />
Sobald alle Parameter korrekt verarbeitet wurden, wird in der Regel die erste Verbindung zum Gerät aufgebaut. Je nach Art des Geräts kann das eine permanente Datenverbindung sein (z.B. serielle Schnittstelle oder TCP-Verbindung) oder das Starten eines regelmäßigen Timers, der zyklisch den Status z.B. via [[HttpUtils|HTTP]] ausliest.<br />
<br />
Sollten im Rahmen der Define-Funktion Syntax-Probleme der Übergabeparameter festgestellt werden oder es kann bspw. keine Verbindung aufgebaut werden, so ist als Funktionsrückgabewert eine entsprechende Fehlermeldung zurückzugeben. Nur wenn alle Übergabeparameter akzeptiert werden, darf <code>undef</code> zurückgegeben werden. Sobald eine Define-Funktion eine Fehlermeldung zurückmeldet, wird der define-Befehl durch FHEM zurückgewiesen und der User erhält die Fehlermeldung, welche die Define-Funktion produziert hat, als Ausgabe zurück.<br />
<br />
<br />
<u>Verfügbarkeit von Attributen</u><br />
<br />
Während die Define-Funktion ausgeführt wird, sollte man nicht davon ausgehen, dass alle vom Nutzer konfigurierten Attribute via [[DevelopmentModuleAPI#AttrVal|AttrVal()]] verfügbar sind. Attribute stehen in der Define-Funktion nur dann zur Verfügung, wenn FHEM sich nicht in der Initialisierungsphase befindet (globale Variable <code>$init_done</code> ist wahr; der Nutzer hat die Gerätedefinition modifiziert). Daher sollte man weiterführende Funktion, welche auf gesetzte Attribute angewiesen sind, nur dann in der Define-Funktion starten, wenn <code>$init_done</code> zutrifft.<br />
<br />
Andernfalls sollte man den Aufruf in der Notify-Funktion durchführen sobald <code>global:INITIALIZED</code> bzw. <code>global:REREADCFG</code> getriggert wurde:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Define($$)<br />
{<br />
my ( $hash, $def ) = @_;<br />
<br />
...<br />
<br />
$hash->{NOTIFYDEV} = "global";<br />
<br />
X_FunctionWhoNeedsAttr($hash) if($init_done);<br />
}<br />
<br />
sub X_Notify($$)<br />
{<br />
my ($own_hash, $dev_hash) = @_;<br />
my $ownName = $own_hash->{NAME}; # own name / hash<br />
<br />
return "" if(IsDisabled($ownName)); # Return without any further action if the module is disabled<br />
<br />
my $devName = $dev_hash->{NAME}; # Device that created the events<br />
my $events = deviceEvents($dev_hash, 1);<br />
<br />
if($devName eq "global" && grep(m/^INITIALIZED|REREADCFG$/, @{$events}))<br />
{<br />
X_FunctionWhoNeedsAttr($hash);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Dadurch wird die Modulfunktion X_FunctionWhoNeedsAttr() nach dem Start erst aufgerufen, wenn alle Attribute aus der Konfiguration geladen wurden.<br />
<br />
<br />
<u>Nutzung von parseParams()</u><br />
<br />
Zum Aufteilen und Parsen von <code>$def</code> lässt sich die Funktion [[DevelopmentModuleAPI#parseParams|parseParams()]] verwenden um die einzelnen Argumente einfach zu parsen. Wenn in [[#X_Initialize|X_Initialize()]] <code>$hash->{parseParams} = 1;</code> gesetzt wurde dann wird parseParams() automatisch aufgerufen und X_Define() ändert sich wie folgt:<br />
<syntaxhighlight lang="perl"><br />
sub X_Define($$$)<br />
{<br />
my ( $hash, $a, $h ) = @_;<br />
...<br />
</syntaxhighlight><br />
<br />
Die genauen Möglichkeiten von parseParams() sind in dem entsprechenden [[DevelopmentModuleAPI#parseParams|Artikel]] dokumentiert.<br />
<br />
==== X_Undef ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Undef ($$)<br />
{<br />
my ( $hash, $name ) = @_;<br />
<br />
...<br />
<br />
return $error;<br />
}<br />
</syntaxhighlight><br />
Die Undef-Funktion wird aufgerufen wenn ein Gerät mit <code>delete</code> gelöscht wird oder bei der Abarbeitung des Befehls <code>rereadcfg</code>, der ebenfalls alle Geräte löscht und danach das Konfigurationsfile neu einliest. Entsprechend müssen in der Funktion typische Aufräumarbeiten durchgeführt werden wie das saubere Schließen von Verbindungen oder das Entfernen von internen Timern, sofern diese im Modul zum Pollen verwendet wurden (siehe Abschnitt [[#Pollen_von_Geräten|Pollen von Geräten]]). <br />
<br />
Zugewiesene Variablen im Hash der Geräteinstanz, Internals oder Readings müssen hier nicht gelöscht werden. In fhem.pl werden die entsprechenden Strukturen beim Löschen der Geräteinstanz ohnehin vollständig gelöscht.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
sub X_Undef($$) <br />
{ <br />
my ( $hash, $name) = @_; <br />
DevIo_CloseDev($hash); <br />
RemoveInternalTimer($hash); <br />
return undef; <br />
}<br />
</syntaxhighlight><br />
<br />
Sollten im Rahmen der Undef-Funktion Probleme festgestellt werden, die ein Löschen nicht zulassen, so ist als Funktionsrückgabewert eine entsprechende Fehlermeldung zurückzugeben. Nur wenn die Undef-Funktion erfolgreich durchgeführt wurde, darf <code>undef</code> zurückgegeben werden. Nur dann wird eine Gerätedefinition von FHEM auch tatsächlich gelöscht bzw. neu angelegt. Sollte die Undef-Funktion jedoch eine Fehlermeldung zurückgeben, wird der entsprechende Vorgang (<code>delete</code> bzw. <code>rereadcfg</code>) für dieses Gerät abgebrochen. Es bleibt dann unverändert in FHEM bestehen.<br />
<br />
==== X_Delete ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Delete ($$)<br />
{<br />
my ( $hash, $name ) = @_;<br />
<br />
...<br />
<br />
return $error;<br />
}<br />
</syntaxhighlight><br />
<br />
Die Delete-Funktion ist das Gegenstück zur Funktion [[#X_Define|X_Define]] und wird aufgerufen wenn ein Gerät mit dem Befehl <code>delete</code> gelöscht wird. <br />
<br />
Wenn ein Gerät in FHEM gelöscht wird, wird zuerst die Funktion [[#X_Undef|X_Undef]] aufgerufen um offene Verbindungen zu schließen, anschließend wird die Funktion X_Delete aufgerufen. Diese dient eher zum Aufräumen von dauerhaften Daten, welche durch das Modul evtl. für dieses Gerät spezifisch erstellt worden sind. Es geht hier also eher darum, alle Spuren sowohl im laufenden FHEM-Prozess, als auch dauerhafte Daten bspw. im physikalischen Gerät zu löschen die mit dieser Gerätedefinition zu tun haben.<br />
<br />
Dies kann z.B. folgendes sein:<br />
<br />
* Löschen von Dateien im Dateisystem die während der Nutzung dieses Geräts angelegt worden sind.<br />
* Lösen von evtl. Pairings mit dem physikalischen Gerät <br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
sub X_Delete($$) <br />
{ <br />
my ( $hash, $name ) = @_; <br />
<br />
# Löschen von Geräte-assoziiertem Temp-File<br />
unlink($attr{global}{modpath}."/FHEM/FhemUtils/$name.tmp";)<br />
<br />
return undef;<br />
} <br />
</syntaxhighlight><br />
<br />
Sollten im Rahmen der Delete-Funktion Probleme festgestellt werden, die ein Löschen nicht zulassen, so ist als Funktionsrückgabewert eine entsprechende Fehlermeldung zurückzugeben. Nur die Delete-Funktion erfolgreich durchgeführt wurde, darf <code>undef</code> zurückgegeben werden. Nur dann wird eine Gerätedefinition von FHEM auch tatsächlich gelöscht. Sollte die Delete-Funktion eine Fehlermeldung zurückgeben, wird der Löschvorgang abgebrochen und das Gerät bleibt weiter in FHEM bestehen.<br />
<br />
==== X_Get ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Get ($$@)<br />
{<br />
my ( $hash, $name, $opt, @args ) = @_;<br />
<br />
...<br />
<br />
return $result;<br />
}<br />
</syntaxhighlight><br />
Die Get-Funktion wird aufgerufen wenn der FHEM-Befehl <code>get</code> mit einem Gerät dieses Moduls ausgeführt wird. Mit <code>get</code> werden typischerweise Werte von einem Gerät abgefragt. In vielen Modulen wird auf diese Weise auch der Zugriff auf generierte Readings ermöglicht. Der Get-Funktion wird dabei der Geräte-Hash, der Gerätename, sowie die Aufrufparameter des get-Befehls übergeben. Als Rückgabewert wird das Ergebnis des entsprechenden Befehls in Form einer Zeichenkette zurückgegeben. Der Rückgabewert <code>undef</code> hat hierbei keine besondere Bedeutung und wird behandelt wie eine leere Zeichenkette <code>""</code>.<br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Get($$@)<br />
{<br />
my ( $hash, $name, $opt, @args ) = @_;<br />
<br />
return "\"get $name\" needs at least one argument" unless(defined($opt));<br />
<br />
if($opt eq "status") <br />
{<br />
...<br />
}<br />
elsif($opt eq "power")<br />
{<br />
...<br />
}<br />
...<br />
else<br />
{<br />
return "Unknown argument $opt, choose one of status power [...]";<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Wenn eine unbekannte Option an die Get-Funktion übergeben wird, so muss als Rückgabewert der Funktion eine bestimmte Syntax einhalten um FHEM mitzuteilen, welche Optionen für einen Get-Befehl aktuell unterstützt werden. Die Rückgabe muss dabei folgender Syntax entsprechen:<br />
<br />
<code>'''unknown''' argument ''<font color="grey">[Parameter]</font>'' '''choose one of''' ''<font color="grey">[Liste möglicher Optionen]</font>''</code><br />
<br />
Hierbei sind die fett gedruckten Teile der Rückmeldung besonders wichtig. Sind diese nicht vorhanden, kann FHEM nicht die möglichen Get-Kommandos für das entsprechende Gerät ermitteln. Es muss am Anfang der Meldung das Stichwort "unknown" vorkommen gefolgt von einer frei definierbaren Fehlermeldung (i.d.R der übergebene Parameter, welcher ungültig ist). Anschließend folgt "choose one of" mit einer anschließenden Liste möglicher Optionen getrennt durch ein Leerzeichen. <br />
<br />
Beispiel:<br />
<ul><br />
<syntaxhighlight lang="perl">return "unknown argument $opt choose one of status temperature humidity";</syntaxhighlight><br />
<br />
Hier werden als mögliche Optionen für einen Get-Befehl folgende Parameter angegeben:<br />
<br />
* <code>status</code><br />
* <code>temperature</code><br />
* <code>humidity</code><br />
<br />
Dies würde in folgenden, mögliche Get-Befehle für einen User resultieren:<br />
<br />
* <code>get ''&lt;NAME&gt;'' status</code><br />
* <code>get ''&lt;NAME&gt;'' temperature</code><br />
* <code>get ''&lt;NAME&gt;'' humidity</code><br />
</ul><br />
<br />
Die Ausgabe einer solchen Meldung ist sehr wichtig, da sie im GUI-Modul verwendet wird um die möglichen <code>get</code>-Optionen zu ermitteln und als Auswahl anzubieten. Im weiteren Verlauf der Get-Funktion könnte man dann mit dem physischen Gerät kommunizieren und den gefragten Wert direkt abfragen und diesen als Return-Wert der Get-Funktion zurückgeben.<br />
<br />
<br />
<u>Nutzung von parseParams()</u><br />
<br />
Wenn in [[#X_Initialize|X_Initialize()]] <code>$hash->{parseParams} = 1;</code> gesetzt wurde dann wird [[DevelopmentModuleAPI#parseParams|parseParams()]] automatisch aufgerufen und X_Get() ändert sich wie folgt:<br />
<syntaxhighlight lang="perl"><br />
sub X_Get($$$)<br />
{<br />
my ( $hash, $a, $h ) = @_;<br />
...<br />
</syntaxhighlight><br />
<br />
Die genauen Möglichkeiten von parseParams() sind in dem entsprechenden [[DevelopmentModuleAPI#parseParams|Artikel]] dokumentiert.<br />
<br />
==== X_Set ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Set ($$@)<br />
{<br />
my ( $hash, $name, $cmd, @args ) = @_;<br />
<br />
...<br />
<br />
return $error;<br />
return ($error, $skip_trigger);<br />
}<br />
</syntaxhighlight><br />
<br />
Die Set-Funktion ist das Gegenteil zur [[#X_Get|Get]]-Funktion. Sie ist dafür gedacht, Daten zum physischen Gerät zu schicken, bzw. entsprechende Aktionen im Gerät selber auszulösen. Ein Set-Befehl dient daher der direkten Steuerung des physikalischen Gerätes in dem es bspw. Zustände verändert (wie <code>on</code>/<code>off</code>). Der Set-Funktion wird dabei der Geräte-Hash, der Gerätename, sowie die Aufrufparameter des set-Befehls übergeben. Als Rückgabewert kann eine Fehlermeldung in Form Zeichenkette zurückgegeben werden. Der Rückgabewert <code>undef</code> bedeutet hierbei, dass der Set-Befehl erfolgreich durchgeführt wurde. Eine Set-Funktion gibt daher nur im Fehlerfall eine Rückmeldung mit einer entsprechenden Fehlermeldung. Der Wert <code>undef</code> wird als "erfolgreich" interpretiert. <br />
<br />
Standardmäßig wird jeder Set-Befehl, welcher erfolgreich ausgeführt wurde (<code>$error</code> ist <code>undef</code>), als Event getriggert um dies bspw. in einem FileLog festzuhalten. Dieses Verhalten kann optional unterbunden werden indem der zweite Rückgabewert <code>$skip_trigger</code> auf <code>1</code> gesetzt wird. Damit wird das Generieren eines Events für das erfolgreich ausgeführte Set-Kommando unterbunden. Falls nicht gesetzt, wird ein Event erzeugt (<code>$cmd</code> mit sämtlichen <code>@args</code>).<br />
<br />
Rückmeldungen (Fehler) von set-Befehlen sämtlicher Module, die im Rahmen eines ausgeführten [[Notify]] auftreten werden im FHEM Logfile festgehalten.<br />
<br />
Falls nur interne Daten, die ausschließlich für das Modul relevant sind, gesetzt werden müssen, so sollte statt Set die [[#X_Attr|Attr]]-Funktion verwendet werden. Attribute werden bei Save-Config auch in der Fhem.cfg gesichert. Set-Befehle nicht, da sie nur zur Steuerungszwecken im laufenden Betrieb von FHEM dienen.<br />
<br />
Eine Set-Funktion ist ähnlich aufgebaut wie die Get-Funktion, sie bekommt jedoch in der Regel weitere zusätzliche Parameter übergeben um Zustände zu setzen. <br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
sub X_Set($@)<br />
{<br />
my ( $hash, $name, $cmd, @args ) = @_;<br />
<br />
return "\"set $name\" needs at least one argument" unless(defined($cmd));<br />
<br />
if($cmd eq "status")<br />
{<br />
if($args[0] eq "up")<br />
{<br />
...<br />
}<br />
elsif($args[0] eq "down")<br />
{<br />
...<br />
}<br />
else<br />
{<br />
return "Unknown value $args[0] for $cmd, choose one of status power";<br />
} <br />
}<br />
elsif($cmd eq "power")<br />
{<br />
if($args[0] eq "on")<br />
{<br />
...<br />
}<br />
elsif($args[0] eq "off")<br />
{<br />
...<br />
} <br />
else<br />
{<br />
return "Unknown value $args[0] for $cmd, choose one of status power";<br />
} <br />
}<br />
...<br />
else<br />
{<br />
return "Unknown argument $cmd, choose one of status power";<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Wenn eine unbekannte Option an die Set-Funktion übergeben wird, so muss als Rückgabewert der Funktion eine bestimmte Syntax eingehalten werden um FHEM mitzuteilen, welche Optionen für einen Set-Befehl aktuell unterstützt werden. Die Rückgabe muss dabei folgender Syntax entsprechen:<br />
<br />
<code>'''unknown''' argument ''<font color="grey">[Parameter]</font>'' '''choose one of''' ''<font color="grey">[Liste möglicher Optionen]</font>''</code><br />
<br />
Hierbei sind die fett gedruckten Teile der Rückmeldung besonders wichtig. Sind diese nicht vorhanden, kann FHEM nicht die möglichen Set-Kommandos für das entsprechende Gerät ermitteln. Es muss am Anfang der Meldung das Stichwort "unknown" vorkommen gefolgt von einer frei definierbaren Fehlermeldung (i.d.R der übergebene Parameter, welcher ungültig ist). Anschließend folgt "choose one of" mit einer anschließenden Liste möglicher Optionen getrennt durch ein Leerzeichen. <br />
<br />
Beispiel:<br />
<ul><br />
<syntaxhighlight lang="perl">return "unknown argument $cmd choose one of status power";</syntaxhighlight><br />
<br />
Hier werden als mögliche Optionen für einen Set-Befehl folgende Parameter angegeben:<br />
<br />
* <code>status</code><br />
* <code>power</code><br />
<br />
Dies würde in folgenden, mögliche Set-Befehle für einen User resultieren:<br />
<br />
* <code>set ''&lt;NAME&gt;'' status</code><br />
* <code>set ''&lt;NAME&gt;'' power</code><br />
</ul><br />
<br />
Die Ausgabe einer solchen Meldung ist sehr wichtig, da sie im Modul [[FHEMWEB]] verwendet wird um die möglichen <code>set</code>-Optionen zu ermitteln und als Auswahl anzubieten.<br />
<br />
<br />
<u>Nutzung von SetExtensions.pm</u><br />
<br />
Wenn man dem Nutzer zusätzlich zu den Set-Befehlen <code>on</code> und <code>off</code> auch weiterführende Befehle wie <code>on-for-timer</code>, <code>on-till</code>, usw. anbieten möchte, obwohl die zu steuernde Hardware solche Kommandos nicht unterstützt, kann man dies über das Hilfsmodul SetExtensions.pm realisieren.<br />
<br />
Das Hilfsmodul SetExtensions.pm bietet weiterführende Set-Kommandos basierend auf den Befehlen <code>on</code>/<code>off</code> an. Dabei werden durch interne Timer bzw. eigens angelegten [[at]]-Definitionen diese Befehle durch FHEM selber umgesetzt. Je nach ausgeführtem Befehl wird der <code>on</code>- bzw. <code>off</code>-Befehl dann durch FHEM zum richtigen Zeitpunkt ausgeführt. Vorausgesetzt das Modul unterstützt in der Set-Funktion die Befehle <code>on</code> und <code>off</code>, so werden durch den Einsatz von SetExtensions.pm folgende Befehle zusätzlich unterstützt:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Set-Kommando !! Beispiel !! Beschreibung<br />
|-<br />
| style="white-space: nowrap;" | <code>on-for-timer ''&lt;Dauer&gt;''</code> || style="white-space: nowrap;" | <code>on-for-timer 120</code> || Schaltet das Gerät sofort mit dem <code>on</code>-Befehl ein und nach der angegebenen Dauer in Sekunden via <code>off</code> wieder aus.<br />
|-<br />
| style="white-space: nowrap;" | <code>off-for-timer ''&lt;Dauer&gt;''</code> || style="white-space: nowrap;" | <code>off-for-timer 120</code> || Schaltet das Gerät sofort mit dem <code>off</code>-Befehl aus und nach der angegebenen Dauer in Sekunden via <code>on</code> wieder ein.<br />
|-<br />
| style="white-space: nowrap;" | <code>on-till ''&lt;Zeitpunkt&gt;''</code> || style="white-space: nowrap;" | <code>on-till 16:30</code> || Schaltet das Gerät sofort mit dem <code>on</code>-Befehl ein und zum angegebenen Zeitpunkt via <code>off</code> wieder aus.<br />
|-<br />
| style="white-space: nowrap;" | <code>off-till ''&lt;Zeitpunkt&gt;''</code> || style="white-space: nowrap;" | <code>off-till 16:30</code> || Schaltet das Gerät sofort mit dem <code>off</code>-Befehl aus und zum angegebenen Zeitpunkt via <code>on</code> wieder ein.<br />
|-<br />
| style="white-space: nowrap;" | <code>on-till-overnight ''&lt;Zeitpunkt&gt;''</code> || style="white-space: nowrap;" | <code>on-till-overnight 01:00</code> || Ähnlich wie <code>on-till</code>. Der übergebene Zeitpunkt wird aber nicht geprüft, ob er für den heutigen Tag bereits überschritten wurde. Dadurch kann man Abends einen Zeitpunkt setzen, der erst am nächsten Tag zutrifft.<br />
|-<br />
| style="white-space: nowrap;" | <code>off-till-overnight ''&lt;Zeitpunkt&gt;''</code> || style="white-space: nowrap;" | <code>off-till-overnight 01:00</code> || Ähnlich wie <code>off-till</code>. Der übergebene Zeitpunkt wird aber nicht geprüft, ob er für den heutigen Tag bereits überschritten wurde. Dadurch kann man Abends einen Zeitpunkt setzen, der erst am nächsten Tag zutrifft.<br />
|-<br />
| style="white-space: nowrap;" | <code>blink ''&lt;Anzahl&gt; &lt;Interval&gt;''</code> || style="white-space: nowrap;" | <code>blink 3 1</code> || Schaltet das Gerät via <code>on</code> für <code>''&lt;Interval&gt;''</code> Sekunden ein und anschließend via <code>off</code> wieder aus. Nach <code>''&lt;Interval&gt;''</code> Sekunden wird das ganze wiederholt, solange bis die angegebene Anzahl erreicht ist.<br />
|-<br />
| style="white-space: nowrap;" | <code>intervals ''&lt;Start&gt;-&lt;Ende&gt;'' ''&lt;Start&gt;-&lt;Ende&gt;'' ...</code> || style="white-space: nowrap;" | <code>intervals 07:00-08:00 16:30-18:00</code> || Schaltet das Gerät innerhalb der übergebenen Zeiträumen via <code>on</code> ein. Sobald die aktuelle Zeit ausserhalb dieser Zeiträume liegt, wird das Gerät via <code>off</code> wieder ausgeschaltet. Es können dabei beliebig viele Zeiträume angegeben werden.<br />
|-<br />
| style="white-space: nowrap;" | <code>toggle</code> || style="white-space: nowrap;" | <code>toggle</code> || Sofern der aktuelle Status <code>on</code> ist, wird das Gerät via <code>off</code> ausgeschaltet. Andernfalls wird es via <code>on</code> eingeschaltet.<br />
|}<br />
<br />
Eine kurze Beschreibung zu den möglichen Befehlen durch SetExtensions.pm gibt es auch in der commandref zum {{Link2CmdRef|Anker=set|Label=set-Befehl}}.<br />
<br />
Um SetExtensions.pm in der Set-Funktion nutzen zu können müssen folgende Aktionen durchgeführt werden:<br />
<br />
# Laden von SetExtensions.pm via <code>use SetExtensions;</code> am Anfang des Moduls<br />
# Aufruf und Rückgabe der Funktion [[DevelopmentModuleAPI#SetExtensions|SetExtensions()]] sofern die Set-Funktion mit dem übergebenen Befehl nichts anfangen kann.<br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
use SetExtensions;<br />
<br />
...<br />
<br />
sub X_Set($@)<br />
{<br />
my ( $hash, $name, $cmd, @args ) = @_;<br />
my $cmdList = "on off";<br />
<br />
return "\"set $name\" needs at least one argument" unless(defined($cmd));<br />
<br />
if($cmd eq "on")<br />
{<br />
# Gerät einschalten...<br />
}<br />
elsif($cmd eq "off")<br />
{<br />
# Gerät ausschalten...<br />
}<br />
...<br />
else # wenn der übergebene Befehl nicht durch X_Set() verarbeitet werden kann, Weitergabe an SetExtensions()<br />
{<br />
return SetExtensions($hash, $cmdList, $name, $cmd, @args);<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
Sollte der übergebene Set-Befehl auch für SetExtensions unbekannt sein (bspw. <code>set ''&lt;Name&gt;'' ?</code>), so generiert SetExtensions() eine entsprechende Usage-Meldung, welche innerhalb der Set-Funktion an FHEM zurückgegeben werden muss.<br />
<br />
Eine ausführliche Beschreibung zu der Funktion SetExtensions() gibt es in der [[DevelopmentModuleAPI#SetExtensions|API-Referenz]].<br />
<br />
<br />
<br />
<u>Nutzung von parseParams()</u><br />
<br />
Wenn in [[#X_Initialize|X_Initialize()]] <code>$hash->{parseParams} = 1;</code> gesetzt wurde dann wird [[DevelopmentModuleAPI#parseParams|parseParams()]] automatisch aufgerufen und X_Set() ändert sich wie folgt:<br />
<syntaxhighlight lang="perl"><br />
sub X_Set($$$)<br />
{<br />
my ( $hash, $a, $h ) = @_;<br />
...<br />
</syntaxhighlight><br />
<br />
Die genauen Möglichkeiten von parseParams() sind in dem entsprechenden [[DevelopmentModuleAPI#parseParams|Artikel]] dokumentiert.<br />
<br />
<br />
<u>Nutzung von FHEMWEB-Widgets</u><br />
<br />
Das GUI-Modul [[FHEMWEB]] kann für die einzelnen Set-Optionen, die das Modul versteht, automatisch Eingabehilfen wie Drop-Down Boxen oder Slider erzeugen. In der Detailansicht der GUI kann der Anwender dann die jeweiligen Werte komfortabel auswählen. Dafür muss die Set-Funktion, wenn sie mit der Option <code>?</code> aufgerufen wird, nicht nur einen Text mit <code>"Unknown ... choose one of ..."</code> zurückgeben sondern den einzelnen Set-Optionen in diesem Rückgabetext nach einem Doppelpunkt entsprechende Zusatzinformationen anhängen.<br />
Meist prüft man in den Modulen gar nicht auf die Option <code>?</code> sondern gibt generell bei unbekannten Optionen diesen Text zurück. Das Modul FHEMWEB ermittelt die Syntax eines Gerätes jedoch immer mit dem Befehl:<br />
set ''&lt;NAME&gt;'' ?<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
return "Unknown argument $cmd, choose one of status:up,down power:on,off on:noArg off:noArg";<br />
</syntaxhighlight><br />
<br />
Mit Kommata getrennte Werte ergeben eine Drop-Down Liste, mit der der User die Werte auswählen kann<br />
<pre>timer:30,120,300<br />
mode:verbose,ultra,relaxed</pre><br />
<br />
Wird kein Doppelpunkt zum Kommando angegeben, so wird eine Eingabezeile angezeigt, die die freie Eingabe eines Wertes erlaubt.<br />
<br />
Man kann jedoch die Eingabe-/Auswahlmöglichkeiten durch Widgets vereinfachen. Dazu gibt man hinter dem Doppelpunkt einen Widgetnamen und widgetspezifische Parameter an. Es existieren mehrere solcher Widgets in FHEMWEB. Die gebräuchlichsten sind:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Zusatz !! Beispiel !! Beschreibung<br />
|-<br />
| '''noArg''' || <code>reset:noArg</code>|| Es werden keine weiteren Argumente mehr benötigt. In so einem Fall wird bei der Auswahl keine Textbox oder ähnliches angezeigt, da keine weiteren Argumente für diesen Befehl notwendig sind.<br />
|-<br />
| '''slider''',<min>,<step>,<max> || <code>dim:slider,0,1,100</code>|| Es wird ein Schieberegler angezeigt um den Parameter auszuwählen. Dabei werden als Zusatzparameter Minimum, Schrittweite und Maximum angegeben.<br />
|-<br />
| '''colorpicker''' || <code>rgb:colorpicker,RGB</code>|| Es wird ein Colorpicker angezeigt, der dem Anwender die Auswahl einer Farbe ermöglicht. Die genaue Parametersyntax kann man dem Artikel zum [[Color#Colorpicker|Colorpicker]] entnehmen.<br />
|-<br />
| '''multiple''' || <code>group:multiple,Telefon,Multimedia,Licht,Heizung</code> || Es erscheint ein Auswahldialog, wo man verschiedene Werte durch klicken auswählen kann. Optional kann man in einem Freitext eigene Werte ergänzen. dieser Dialog wird bspw. bei der Raum-Auswahl (Attribut "room") oder der Gruppen-Auswahl (Attribut "group") in FHEMWEB genutzt. <br />
|-<br />
| '''sortable''' || <code>command:sortable,monday,tuesday,...</code> || Es erscheint ein Auswahldialog, wo man verschiedene Werte auswählen und sortieren kann. Man kann dabei Werte durch Klicken auswählen und durch Drag'n'Drop sortieren.<br />
|}<br />
<br />
Es gibt noch weitere solcher Widgets. Eine genaue Auflistung dazu findet sich in der {{Link2CmdRef|Anker=widgetOverride}} unter widgetOverride zu FHEMWEB.<br />
<br />
'''Hinweise'''<br />
<br />
* Damit in einer Eingabe bereits der aktuelle Wert vorbelegt bzw. in einer Auswahlliste der aktuelle Wert vorselektiert ist, muss es im Modul bzw. Gerät ein Reading mit dem gleichen Namen wie die Set-Option geben. Der Wert des gleichnamigen Readings wird dann als Vorbelegung / Vorselektion verwendet. <br />
* Der User kann sich in der Raumübersicht nach wie vor via [[WebCmd|webCmd]] eine entsprechende Steuerung anlegen.<br />
<br />
==== X_Attr ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Attr($$$$)<br />
{<br />
my ( $cmd, $name, $attrName, $attrValue ) = @_;<br />
<br />
...<br />
<br />
return $error;<br />
}<br />
</syntaxhighlight><br />
<br />
Die Attr-Funktion dient der Prüfung von Attributen, welche über den <code>attr</code>-Befehl gesetzt werden können. Sobald versucht wird, ein Attribut für ein Gerät zu setzen, wird vorher die Attr-Funktion des entsprechenden Moduls aufgerufen um zu prüfen, ob das Attribut aus Sicht des Moduls korrekt ist.<br />
Liegt ein Problem mit dem Attribut bzw. dem Wert vor, so muss die Funktion eine aussagekräftige Fehlermeldung zurückgeben, welche dem User angezeigt wird.<br />
Sofern das übergebene Attribut samt Inhalt korrekt ist, gibt die Attr-Funktion den Wert <code>undef</code> zurück. Erst dann wird das Attribut in der globalen Datenstruktur <code>%attr</code> gespeichert und ist somit erst aktiv.<br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Attr($$$$)<br />
{<br />
my ( $cmd, $name, $attrName, $attrValue ) = @_;<br />
<br />
# $cmd - Vorgangsart - kann die Werte "del" (löschen) oder "set" (setzen) annehmen<br />
# $name - Gerätename<br />
# $attrName/$attrValue sind Attribut-Name und Attribut-Wert<br />
<br />
if ($cmd eq "set") {<br />
if ($aName eq "Regex") {<br />
eval { qr/$aVal/ };<br />
if ($@) {<br />
Log3 $name, 3, "X ($name) - Invalid regex in attr $name $aName $aVal: $@";<br />
return "Invalid Regex $aVal: $@";<br />
}<br />
}<br />
}<br />
return undef;<br />
}<br />
</syntaxhighlight><br />
<br />
Zusätzlich ist es möglich auch übergebene Attributwerte zu verändern bzw. zu korrigieren, indem man im Parameterarray <code>@_</code> den ursprünglichen Wert anpasst. Dies erfolgt im Beispiel über die Modifikation des Wertes mit Index 3 (entspricht dem 4. Element) im Parameterarray, also <code>$_[3]</code>.<br />
<br />
Da das Attribut zum Zeitpunkt des Aufrufs der Attr-Funktion noch nicht gespeichert ist, wird der neue Wert zu diesem Zeitpunkt noch nicht via [[DevelopmentModuleAPI#AttrVal|AttrVal()]] zurückgegeben. Erst, wenn die Attr-Funktion mit <code>undef</code> beendet ist, wird der neue Wert in FHEM gespeichert und steht dann via AttrVal() zur Verfügung.<br />
<br />
Die Attr-Funktion bekommt nicht den Hash der Geräteinstanz übergeben, da sie normalerweise keine Werte dort speichern muss, sondern lediglich das Attribut auf Korrektheit prüfen muss.<br />
Im obigen Beispiel wird für ein Attribut mit Namen "Regex" geprüft ob der reguläre Ausdruck fehlerhaft ist. Sofern dieser OK ist, wird <code>undef</code> zurückgegeben und fhem.pl speichert den Wert des Attributs in <code>%attr</code>.<br />
<br />
<br />
<u>Attributnamen mit Platzhaltern</u><br />
<br />
Falls man Attribute in der [[#X_Initialize|Initialize]]-Funktion mit Platzhaltern definiert (Wildcard-Attribute) wie z.B.:<br />
<syntaxhighlight lang="perl"><br />
$hash->{AttrList} =<br />
"reading[0-9]*Name " .<br />
# usw.<br />
</syntaxhighlight><br />
dann können Anwender Attribute wie reading01Name, reading02Name etc. setzen. Leider funktioniert das bisher nicht durch Klicken in der Web-Oberfläche, da FHEMWEB nicht alle denkbaren Ausprägungen in einem Dropdown anbieten kann. Der Benutzer muss solche Attribute manuell über den <code>attr</code>-Befehl eingeben.<br />
<br />
Man kann jedoch in der Attr-Funktion neu gesetzte Ausprägungen von Wildcard-Attributen an die gerätespezifische userattr-Variable anfügen. Dann können bereits gesetzte Attribute in FHEMWEB durch Klicken ausgewählt und geändert werden.<br />
Dazu reicht ein Aufruf der Funktion [[DevelopmentModuleAPI#addToDevAttrList|addToDevAttrList()]]: <br />
<br />
<syntaxhighlight lang="perl"><br />
addToDevAttrList($name, $aName);<br />
</syntaxhighlight><br />
<br />
==== X_Read ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Read ($)<br />
{<br />
my ( $hash ) = @_;<br />
<br />
...<br />
}<br />
</syntaxhighlight><br />
Die X_Read-Funktion wird aufgerufen, wenn ein dem Gerät zugeordneter Filedeskriptor (serielle Schnittstelle, TCP-Verbindung, ...) Daten zum Lesen bereitgestellt hat. Die Daten müssen nun eingelesen und interpretiert werden.<br />
<br />
Im folgenden Beispiel wird über eine serielle Schnittstelle (beziehungsweise über einen USB-To-Serial-Konverter) von einem angeschlossenen Gerät gelesen. Dazu werden die bisher verfügbaren Daten mit der Funktion [[DevIo#DevIo_SimpleRead()|DevIo_SimpleRead()]] gelesen. Da die Übertragung möglicherweise noch nicht vollständig ist, kann es sein, dass kurz darauf die X_Read-Funktion wieder aufgerufen wird und ein weiterer Teil oder der Rest der Daten gelesen werden kann.<br />
Die Funktion muss daher prüfen ob schon alle erwarteten Daten angekommen sind und gegebenenfalls die bisher gelesenen Daten in einem eigenen Puffer (idealerweise in <code>$hash</code>) zwischenspeichern (siehe auch [[DevIo#Hinweis bei der Datenverarbeitung (Buffering)|DevIo]]). Im Beispiel ist dies <code>$hash->{helper}{BUFFER}</code> an den die aktuell gelesenen Daten angehängt werden, bis die folgende Prüfung ein für das jeweilige Protokoll vollständige Frame erkennt.<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Read($)<br />
{<br />
my ($hash) = @_;<br />
my $name = $hash->{NAME};<br />
<br />
# einlesen der bereitstehenden Daten<br />
my $buf = DevIo_SimpleRead($hash); <br />
return "" if ( !defined($buf) );<br />
Log3 $name, 5, "X ($name) - received data: ".$buf; <br />
<br />
# Daten in Hex konvertieren und an den Puffer anhängen<br />
$hash->{helper}{BUFFER} .= unpack ('H*', $buf); <br />
Log3 $name, 5, "X ($name) - current buffer content: ".$hash->{helper}{BUFFER};<br />
<br />
# prüfen, ob im Buffer ein vollständiger Frame zur Verarbeitung vorhanden ist.<br />
if ($hash->{helper}{BUFFER} =~ "ff1002(.{4})(.*)1003(.{4})ff(.*)") {<br />
...<br />
</syntaxhighlight><br />
<br />
Die zu lesenden Nutzdaten können dann je nach Protokoll des Geräts beispielsweise an einer festgelegten Stelle im Frame (dann in <code>$hash->{helper}{BUFFER}</code>) stehen oder aus dem Kontext mit einem Regex-Match extrahiert werden und via [[DevelopmentModuleAPI#Readings_.2F_Events|Reading-Funktionen]] in Readings gespeichert werden (siehe unten).<br />
<br />
Der Rückgabewert der Read-Funktion wird nicht geprüft und hat daher keinerlei Bedeutung.<br />
<br />
==== X_Ready ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Ready ($)<br />
{<br />
my ( $hash ) = @_;<br />
<br />
...<br />
<br />
return $success;<br />
}<br />
</syntaxhighlight><br />
<br />
Wird im Main-Loop aufgerufen falls das Modul in der globalen Liste <code>%readyfnlist</code> existiert. Diese Funktion hat, je nachdem auf welchem OS FHEM ausgeführt wird, unterschiedliche Aufgaben:<br />
<br />
* '''UNIX-artiges Betriebssystem:''' prüfen, ob eine Verbindung nach einem Verbindungsabbruch wieder aufgebaut werden kann. Sobald der Verbindungsaufbau erfolgreich war, muss die Funktion einen erfolgreichen Wahrheitswert zurückliefern (z.B. "1") und den eigenen Eintrag entsprechend aus <code>%readyfnlist</code> löschen.<br />
* '''Windows-Betriebssystem:''' prüfen, ob lesbare Daten für ein serielles Device (via COM1, COM2, ...) vorliegen. Sofern lesbare Daten vorliegen, muss Funktion einen erfolgreichen Wahrheitswert zurückliefern (z.B. "1"). Zusätzlich dazu muss die Funktion, wie bei UNIX-artigen Betriebssystem, ebenfalls bei einem Verbindungsabbruch einen neuen Verbindungsversuch initiieren. Der Eintrag in <code>%readyfnlist</code> bleibt solange erhalten, bis die Verbindung seitens FHEM beendet wird.<br />
<br />
Der Windows-spezifische Teil zur Datenprüfung ist dabei nur zu implementieren, wenn das Modul über eine serielle Verbindung kommuniziert.<br />
<br />
Bei der Nutzung des Moduls [[DevIo]] wird dem Modulentwickler der Umgang mit <code>%readyfnlist</code> abgenommen, da DevIo sich selbst um die entsprechenden Einträge kümmert und diese selbstständig wieder entfernt.<br />
<br />
In der Regel sieht eine Ready-Funktion immer gleich aus.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
sub X_Ready($)<br />
{<br />
my ($hash) = @_;<br />
<br />
# Versuch eines Verbindungsaufbaus, sofern die Verbindung beendet ist.<br />
return DevIo_OpenDev($hash, 1, undef ) if ( $hash->{STATE} eq "disconnected" );<br />
<br />
# This is relevant for Windows/USB only<br />
if(defined($hash->{USBDev})) {<br />
my $po = $hash->{USBDev};<br />
my ( $BlockingFlags, $InBytes, $OutBytes, $ErrorFlags ) = $po->status;<br />
return ( $InBytes > 0 );<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
==== X_Notify ====<br />
<br />
Die X_Notify-Funktion wird aus der Funktion [[DevelopmentModuleAPI#DoTrigger|DoTrigger()]] in fhem.pl heraus aufgerufen sobald ein Modul Events erzeugt hat. Damit kann ein Modul auf Events anderer Module reagieren. Typische Beispiele sind dabei das [[FileLog]]-Modul oder das [[notify]]-Modul.<br />
<br />
Die Notify-Funktion bekommt dafür zwei Hash-Referenzen übergeben: den Hash des eigenen Geräts und den Hash des Geräts, das die Events erzeugt hat. <br />
Über den Hash des eigenen Geräts kann die Notify-Funktion beispielsweise auf die Internals oder Attribute des eigenen Geräts zugreifen.<br />
Über den Hash des Gerätes und der [[DevelopmentModuleAPI#deviceEvents|deviceEvents()]]-Funktion kann man auf die generierten Events zugreifen. Über den zweiten Parameter dieser Routine lässt sich bestimmen ob für das Reading <code>state</code> ein 'normales' Event (d.h. in der form <code>state: <wert></code>) erzeugen soll (Wert: 1) oder ob z.b. aus Gründen der Rückwärtskompatibilität ein Event ohne <code>state: </code> erzeugt werden soll. Falls dem Anwender die Wahl des verwendeten Formats überlassen werden soll ist hierzu das {{Link2CmdRef|Anker=addStateEvent|Lang=de|Label=addStateEvent-Attribut}} vorzusehen.<br />
<br />
Der direkte Zugriff auf <code>$hash->{CHANGED}</code> ist nicht mehr zu empfehlen.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
sub X_Notify($$)<br />
{<br />
my ($own_hash, $dev_hash) = @_;<br />
my $ownName = $own_hash->{NAME}; # own name / hash<br />
<br />
return "" if(IsDisabled($ownName)); # Return without any further action if the module is disabled<br />
<br />
my $devName = $dev_hash->{NAME}; # Device that created the events<br />
<br />
my $events = deviceEvents($dev_hash,1);<br />
return if( !$events );<br />
<br />
foreach my $event (@{$events}) {<br />
$event = "" if(!defined($event));<br />
<br />
# Examples:<br />
# $event = "readingname: value" <br />
# or<br />
# $event = "INITIALIZED" (for $devName equal "global")<br />
#<br />
# processing $event with further code<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
<br />
<u>Begrenzung der Aufrufe auf bestimmte Geräte</u><br />
<br />
Da die Notify-Funktion für jedes definierte Gerät mit all seinen Events aufgerufen wird, muss sie in einer Schleife jedesmal prüfen und entscheiden, ob es mit dem jeweiligen Event etwas anfangen kann. Ein Gerät, das die Notify-Funktion implementiert, sieht dafür typischerweise einen regulären Ausdruck vor, welcher für die Filterung verwendet wird.<br />
<br />
Wenn man nur gezielt von bestimmten Definitionen Events erhalten will, kann man diese auch in Form einer {{Link2CmdRef|Lang=de|Anker=devspec|Label=devspec}} in <code>$hash->{NOTIFYDEV}</code> angeben. Bspw. kann man in der Define-Funktion diesen Wert setzen. Dadurch wird die Notify-Funktion nur aufgerufen wenn eine der Definitionen, auf welche die devspec passt, ein Event erzeugt hat. Ein typischer Fall ist die Begrenzung von Events auf "global":<br />
<br />
<syntaxhighlight lang="perl"><br />
in der Define-Funktion:<br />
<br />
$hash->{NOTIFYDEV} = "global";<br />
$hash->{NOTIFYDEV} = "global,Definition_.*";<br />
$hash->{NOTIFYDEV} = "global,Definition_A,Definition_B";<br />
$hash->{NOTIFYDEV} = "global,TYPE=CUL_HM";<br />
</syntaxhighlight><br />
<br />
Dies schont insbesondere bei grossen Installationen Ressourcen, da die Notify-Funktion nicht sämtliche Events, sondern nur noch Events der gewünschten Definitionen erhält. Dadurch erfolgen deutlich weniger Aufrufe der Notify-Funktion, was Systemressourcen schont.<br />
<br />
Sofern in der [[#X_Define|Define-Funktion]] eine Regexp als Argument übergeben wird, die ähnlich wie beim Modul [[notify]] auf Events wie <code>&lt;Definitionsname&gt;</code> bzw. <code>&lt;Definitionsname&gt;:&lt;Event&gt;</code> reagiert, so sollte man in der Define-Funktion die Funktion [[DevelopmentModuleAPI#notifyRegexpChanged|notifyRegexpChanged()]] verwenden. Diese versucht einen passenden Eintrag für <code>$hash->{NOTIFYDEV}</code> basierend auf der übergebenen Regexp zu setzen, sofern dies möglich ist.<br />
<br />
<u>Reihenfolge für den Aufruf der Notify-Funktion beeinflussen</u><br />
<br />
Sobald ein Event ausgelöst wurde, stellt sich FHEM eine Liste aller relevanten Geräte-Hashes zusammen, welche via Notify-Funktion prüfen müssen, ob das Event relevant ist. Dabei wird die Liste nach <code>$hash->{NTFY_ORDER}</code> sortiert. Diese enthält ein Order-Präfix in Form einer Ganzzahl, sowie den Namen der Definition (Bsp: <code>'''50'''-Lampe_Wohnzimmer</code>). Dadurch kann man jedoch nicht sicherstellen, dass Events von bestimmten Modulen zuerst verarbeitet werden.<br />
<br />
Wenn das eigene Modul bei der Eventverarbeitung gegenüber den anderen Modulen eine bestimmte Reihenfolge einhalten muss, kann man in der [[#X_Initialize|Initialize]]-Funktion durch Setzen von <code>$hash->{NotifyOrderPrefix}</code> diese Reihenfolge beeinflussen. Standardmäßig werden Module immer mit einem Order-Präfix von "50-" in FHEM registriert. Durch die Veränderung dieses Präfixes kann man das eigene Modul in der Reihenfolge gegenüber anderen Modulen bei der Eventverarbeitung beeinflussen. <br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Initialize($)<br />
{<br />
my ($hash) = @_;<br />
<br />
...<br />
<br />
$hash->{NotifyOrderPrefix} = "45-" # Alle Definitionen des Moduls X werden bei der Eventverarbeitung zuerst geprüft<br />
<br />
# oder...<br />
<br />
$hash->{NotifyOrderPrefix} = "55-" # Alle Definitionen des Moduls X werden bei der Eventverarbeitung als letztes geprüft<br />
<br />
</syntaxhighlight> <br />
<br />
Da dieses Präfix bei eventverarbeitenden Definitionen in <code>$hash->{NTFY_ORDER}</code> dem Definitionsnamen vorangestellt wird bewirkt es bei einer normalen aufsteigenden Sortierung nach <code>$hash->{NTFY_ORDER}</code> eine veränderte Reihenfolge. Alle Module die in der Initialize-Funktion nicht <code>$hash->{NotifyOrderPrefix}</code> explizit setzen, werden mit "50-" als Standardwert vorbelegt.<br />
<br />
==== X_Rename ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Rename($$)<br />
{<br />
my ( $new_name, $old_name) = @_;<br />
<br />
...<br />
}<br />
</syntaxhighlight><br />
<br />
Die Rename-Funktion wird ausgeführt, nachdem ein Gerät umbenannt wurde. Auf diese Weise kann ein Modul auf eine Namensänderung reagieren, wenn das Gerät <code>$old_name</code> in <code>$new_name</code> umbenannt wurde. Ein typischer Fall ist das Umsetzen der Namensänderungen bei Daten die mittels [[DevelopmentModuleAPI#setKeyValue|setKeyValue()]] gespeichert wurden. Hierbei müssen die Daten, welche unter dem alten Namen gespeichert sind, auf den neuen Namen geändert werden.<br />
<br />
Der Rename-Funktion wird lediglich der alte, sowie der neue Gerätename übergeben. Der Rückgabewert wird nicht ausgewertet.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
sub X_Rename($$)<br />
{<br />
my ( $new_name, $old_name ) = @_;<br />
<br />
my $old_index = "Module_X_".$old_name."_data";<br />
my $new_index = "Module_X_".$new_name."_data";<br />
<br />
my ($err, $data) = getKeyValue($old_index);<br />
return undef unless(defined($old_pwd));<br />
<br />
setKeyValue($new_index, $data);<br />
setKeyValue($old_index, undef);<br />
}<br />
</syntaxhighlight><br />
<br />
==== X_DelayedShutdown ====<br />
<syntaxhighlight lang="perl"><br />
sub X_DelayedShutdown($)<br />
{<br />
my ( $hash ) = @_;<br />
<br />
...<br />
<br />
return $delay_needed;<br />
}<br />
</syntaxhighlight><br />
Mit der X_DelayedShutdown Funktion kann eine Definition das Stoppen von FHEM verzögern um asynchron hinter sich aufzuräumen. Dies kann z.B. der ordnungsgemäße Verbindungsabbau mit dem physikalischen Gerät sein (z.B. Session beenden, Logout, etc.), welcher mehrfache Requests/Responses benötigt. Als Übergabeparameter wird der Geräte-Hash <code>$hash</code> bereitgestellt. Je nach Rückgabewert <code>$delay_needed</code> wird der Stopp von FHEM verzögert. Ist ein verzögerter Stopp von FHEM notwendig, darf der Rückgabewert in diesem Fall nicht <code>0</code> oder <code>undef</code> sein.<br />
<br />
Im Unterschied zur [[#X_Shutdown|Shutdown]]-Funktion steht vor einem bevorstehenden Stopp von FHEM für einen User-konfigurierbaren Zeitraum (global-Attribut: <code>maxShutdownDelay</code> / Standard: 10 Sekunden) weiterhin die asynchrone FHEM Infrastruktur ([[DevIo]]/[[#X_Read|Read]]-Funktion und [[DevelopmentModuleAPI#InternalTimer|InternalTimer]]) zur Verfügung.<br />
<br />
Sobald alle nötigen Maßnahmen erledigt sind, muss der Abschluss mit [[DevelopmentModuleAPI#CancelDelayedShutdown|CancelDelayedShutdown(<code>$name</code>)]] an FHEM zurückgemeldet werden.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
sub X_DelayedShutdown($)<br />
{<br />
my ($hash) = @_;<br />
<br />
# Aufräumen starten<br />
<br />
return 1;<br />
}<br />
</syntaxhighlight><br />
<br />
==== X_Shutdown ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Shutdown ($)<br />
{<br />
my ( $hash ) = @_;<br />
<br />
...<br />
}<br />
</syntaxhighlight><br />
Mit der X_Shutdown Funktion kann ein Modul Aktionen durchführen bevor FHEM gestoppt wird. Dies kann z.B. der ordnungsgemäße Verbindungsabbau mit dem physikalischen Gerät sein (z.B. Session beenden, Logout, etc.). Nach der Ausführung der Shutdown-Fuktion wird FHEM sofort beendet. Falls vor dem Herunterfahren von FHEM asynchrone Kommunikation (via [[DevIo]]/[[#X_Read|X_Read]]) notwendig ist um eine vorhandene Verbindung sauber zu beenden, sollte man [[#X_DelayedShutdownFn|X_DelayedShutdownFn]] verwenden.<br />
<br />
Als Übergabeparameter wird der Geräte-Hash bereitgestellt. Der Rückgabewert einer Shutdown-Funktion wird nicht ausgewertet und ist daher irrelevant.<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
sub X_Shutdown($)<br />
{<br />
my ($hash) = @_;<br />
<br />
# Verbindung schließen<br />
DevIo_CloseDev($hash);<br />
return undef;<br />
}<br />
</syntaxhighlight><br />
<br />
=== Funktionen für zweistufiges Modulkonzept ===<br />
<br />
Für das [[#Zweistufiges_Modell_für_Module|zweistufige Modulkonzept]] gibt es weiterhin:<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! style="text-align:left" | Funktionsname !! style="text-align:left" class="unsortable" | Kurzbeschreibung<br />
|-<br />
| [[#X_Parse|X_Parse]] || Zustellen von Daten via [[DevelopmentModuleAPI#Dispatch|Dispatch()]] vom physischen Modul zum logischen Modul zwecks der Verarbeitung.<br />
|-<br />
| [[#X_Write|X_Write]]|| Zustellen von Daten via [[DevelopmentModuleAPI#Dispatch|IOWrite()]] vom logischen zum physischen Modul um diese an die Hardware weiterzureichen.<br />
|-<br />
| [[#X_Fingerprint|X_Fingerprint]] || Rückgabe eines "Fingerabdrucks" einer Nachricht. Dient der Erkennung von Duplikaten im Rahmen von [[DevelopmentModuleAPI#Dispatch|Dispatch()]]. Kann im physischen, als auch logischen Modul benutzt werden.<br />
|}<br />
<br />
Für das zweistufige Modulkonzept muss in einem logischen Modul eine [[#X_Parse|Parse]]-Funktion im Modul-Hash registriert werden. In einem physikalischen Modul muss eine [[#X_Write|Write]]-Funktion registriert sein. Diese dienen dem Datenaustausch in beide Richtungen und werden von dem jeweils anderen Modul indirekt aufgerufen.<br />
<br />
In der [[#X_Initialize|Initialize]]-Funktion werden diese wie folgt definiert:<br />
<br />
<syntaxhighlight lang="perl"><br />
$hash->{ParseFn} = "X_Parse";<br />
$hash->{WriteFn} = "X_Write";<br />
$hash->{FingerprintFn} = "X_Fingerprint";<br />
</syntaxhighlight><br />
<br />
Diese Funktionen werden in diesem Abschnitt genauer beschrieben.<br />
<br />
==== X_Parse ====<br />
{{Randnotiz|RNTyp=Info|RNText=<font color="red"><u>'''ACHTUNG''':</u></font><br />
Dieser Abschnitt geht davon aus, dass das Modul mit dem Namen "X" ein '''logisches Modul''' im Sinne des zweistufigen Modulkonzepts ist, also Daten mit einem übergeordneten, physikalischen Modul austauscht.}}<br />
<syntaxhighlight lang="perl"><br />
sub X_Parse ($$)<br />
{<br />
my ( $io_hash, $message) = @_;<br />
<br />
...<br />
<br />
return $found;<br />
}<br />
</syntaxhighlight><br />
<br />
Die Funktion X_Parse wird aufgerufen, sobald von dem IO-Gerät <code>$io_hash</code> eine Nachricht <code>$message</code> via [[DevelopmentModuleAPI#Dispatch|Dispatch()]] zur Verarbeitung angefragt wird. Die Parse-Funktion muss dann prüfen, zu welcher Gerätedefinition diese Nachricht gehört und diese entsprechend verarbeiten.<br />
<br />
Üblicherweise enthält eine Nachricht immer eine Komponente durch welche sich die Nachricht einem Gerät zuordnen lässt (z.B. Adresse, ID-Nummer, ...). Eine solche Identifikation sollte man im Rahmen der [[#X_Define|Define]]-Funktion im logischen Modul an geeigneter Stelle speichern, um in der Parse-Funktion eine einfache Zuordnung von Adresse/ID einer Nachricht zur entsprechenden Gerätedefinition zu haben. Dazu wird in der Regel im Modul-Hash im modulspezifischen Bereich eine Liste <code>defptr</code> (Definition Pointer) geführt, welche jede eindeutige Adresse/ID dem entsprechenden Geräte-Hash zuordnet:<br />
<br />
<syntaxhighlight lang="perl"><br />
<br />
sub X_Define ($$)<br />
{<br />
my ( $hash, $def) = @_;<br />
my @a = split("[ \t][ \t]*", $def);<br />
my $name = $a[0];<br />
<br />
...<br />
<br />
# erstes Argument ist die eindeutige Geräteadresse<br />
my $address = $a[1];<br />
<br />
# Adresse rückwärts dem Hash zuordnen (für ParseFn)<br />
$modules{X}{defptr}{$address} = $hash;<br />
<br />
...<br />
}<br />
</syntaxhighlight><br />
<br />
Auf Basis dieses Definition Pointers kann die Parse-Funktion nun sehr einfach prüfen, ob für die empfangene Nachricht bereits eine entsprechende Gerätedefinition existiert. Sofern diese existiert, kann die Nachricht entsprechend verarbeitet werden. Sollte jedoch keine passende Gerätedefinition zu der empfangenen Nachricht existieren, so muss die Parse-Funktion den Gerätenamen "UNDEFINED" zusammen mit den Argumenten für einen <code>define</code>-Befehl zurückgeben, welcher ein passendes Gerät in FHEM anlegen würde (durch [[autocreate]]).<br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
<br />
sub X_Parse ($$)<br />
{<br />
my ( $io_hash, $message) = @_;<br />
<br />
# Die Stellen 10-15 enthalten die eindeutige Identifikation des Geräts<br />
my $address = substr($message, 10, 5); <br />
<br />
# wenn bereits eine Gerätedefinition existiert (via Definition Pointer aus Define-Funktion)<br />
if(my $hash = $modules{X}{defptr}{$address}) <br />
{<br />
... # Nachricht für $hash verarbeiten<br />
<br />
# Rückgabe des Gerätenamens, für welches die Nachricht bestimmt ist.<br />
return $hash->{NAME}; <br />
}<br />
else<br />
{<br />
# Keine Gerätedefinition verfügbar<br />
# Daher Vorschlag define-Befehl: <NAME> <MODULNAME> <ADDRESSE><br />
return "UNDEFINED X_".$address." X $address";<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
==== X_Write ====<br />
{{Randnotiz|RNTyp=Info|RNText=<font color="red"><u>'''ACHTUNG''':</u></font><br />
Dieser Abschnitt geht davon aus, dass das Modul mit dem Namen "X" ein '''physisches Modul''' im Sinne des zweistufigen Modulkonzepts ist, also Daten mit untergeordneten logischen Modulen austauscht. }}<br />
<syntaxhighlight lang="perl"><br />
sub X_Write ($$)<br />
{<br />
my ( $hash, @arguments) = @_;<br />
<br />
...<br />
<br />
return $return;<br />
}<br />
</syntaxhighlight><br />
<br />
Die Write-Funktion wird durch die Funktion [[DevelopmentModuleAPI#IOWrite|IOWrite()]] aufgerufen, sobald eine logische Gerätedefinition Daten per IO-Gerät an die Hardware übertragen möchte. Dazu kümmert sich die Write-Funktion um die Übertragung der Nachricht in geeigneter Form an die verbundene Hardware. Als Argumente wird der Hash des physischen Gerätes übertragen, sowie alle weiteren Argumente, die das logische Modul beim Aufruf von IOWrite() mitgegeben hat. Im Normalfall ist das ein Skalar mit der zu sendenden Nachricht in Textform. Es kann aber auch sein, dass weitere Daten zum Versand notwendig sind (evtl. Schlüssel, Session-Key, ...). Daher ist die Parametersyntax einer zu schreibenden Nachricht via IOWrite-/Write-Funktion zwischen logischem und physikalischem Modul abzustimmen.<br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Write ($$)<br />
{<br />
my ( $hash, $message, $address) = @_;<br />
<br />
DevIo_SimpleWrite($hash, $address.$message, 2);<br />
<br />
return undef;<br />
}<br />
</syntaxhighlight><br />
<br />
==== X_Fingerprint ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Fingerprint($$)<br />
{<br />
my ( $io_name, $msg ) = @_;<br />
<br />
...<br />
<br />
return ( $io_name, $fingerprint );<br />
}<br />
</syntaxhighlight><br />
<br />
Die Fingerprint-Funktion dient der Erkennung von Duplikaten empfangener Nachrichten. Diese Funktion kann dabei sowohl im physischen, als auch im logischen Modul implementiert sein - je nachdem auf welcher Ebene man für eine Nachricht einen Fingerprint bilden kann. <br />
<br />
Als Parameter wird der Name des IO-Geräts <code>$io_name</code> übergeben, sowie die Nachricht <code>$msg</code>, welche empfangen wurde. Nun muss aus dieser Nachricht ein eindeutiger Fingerprint gebildet werden. Dies bedeutet, dass alle variablen Inhalte, die aufgrund des Empfangs dieser Nachricht über unterschiedliche IO-Geräte enthalten sein können, entfernt werden müssen. Dies können bspw. Empfangsadressen von IO-Geräten sein oder Session-ID's die in der Nachricht enthalten sind. Alle Fingerprints sämtlicher Nachrichten, die innerhalb der letzten 500 Millisekunden (konfigurierbar via <code>global</code> Attribut <code>dupTimeout</code>) empfangen wurden, werden gegen diesen generierten Fingerprint getestet. Sollte innerhalb dieser Zeit bereits eine Nachricht mit diesem Fingerprint verarbeitet worden sein, so wird sie als Duplikat erkannt und nicht weiter verarbeitet. In diesem Fall gibt [[DevelopmentModuleAPI#Dispatch|Dispatch()]] den Namen der Gerätedefinition zurück, welche eine Nachricht mit dem selben Fingerprint bereits verarbeitet hat. Es erfolgt dann kein Aufruf der [[#X_Parse|Parse]]-Funktion.<br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Fingerprint($$)<br />
{<br />
my ( $io_name, $msg ) = @_;<br />
<br />
substr( $msg, 2, 2, "--" ); # entferne Empfangsadresse<br />
substr( $msg, 4, 1, "-" ); # entferne Hop-Count<br />
<br />
return ( $io_name, $msg );<br />
}<br />
</syntaxhighlight><br />
<br />
Es wird zuerst, sofern implementiert, die Fingerprint-Funktion des physischen Moduls aufgerufen. Sollte sich hierdurch kein Duplikat erkennen lassen, wird die Fingerprint-Funktion jedes möglichen geladenen logischen Moduls aufgerufen, sofern implementiert. <br />
<br />
Sollte sowohl im physischen, als auch im logischen Modul keine Fingerprint-Funktion implementiert sein, so wird keinerlei Duplikatserkennung durchgeführt.<br />
<br />
=== FHEMWEB-spezifische Funktionen ===<br />
<br />
FHEMWEB bietet Modul-Autoren die Möglichkeit an durch spezielle Funktionsaufrufe in Modulen, eigene HTML-Inhalte zu verwenden. Dadurch können in Verbindung mit zusätzlichem JavaScript komplexe Dialoge/Inhalte/Steuermöglichkeiten dargestellt werden. <br />
<br />
Eine genaue Auflistung aller FHEMWEB-spezifischen Funktionsaufrufe gibt es in dem separaten Artikel [[DevelopmentFHEMWEB]]<br />
<br />
=== sonstige Funktionen ===<br />
<br />
In diesem Abschnitt werden weitere Funktionen behandelt die zum Teil aus FHEM, aber auch aus anderen Modulen aufgerufen werden. Sie sind dabei nur in speziellen Anwendungsfällen relevant. Hier eine Auflistung aller sonstigen Modulfunktionen:<br />
<br />
{| class="wikitable sortable"<br />
|-<br />
! Funktionsname !! class="unsortable" | Kurzbeschreibung<br />
|-<br />
| [[#X_DbLog_split|X_DbLog_split]] || Wird durch das Modul 93_DbLog.pm aufgerufen. Dient dem korrekten Split eines moduleigenen Events in Name/Wert/Einheit für die Nutzung einer Datenbank.<br />
|-<br />
| [[#X_Except|X_Except]]|| Wird aufgerufen, sobald ein ein geöffneter Filedescriptor in [[#Wichtige_globale_Variablen_aus_fhem.pl|<code>%selectlist</code>]], der unter <code>$hash->{EXCEPT_FD}</code> im Geräte-Hash gesetzt ist, einen Interrupt bzw. Exception auslöst.<br />
|-<br />
| [[#X_Copy|X_Copy]]|| Wird durch das Modul 98_copy.pm aufgerufen im Rahmen des <code>copy</code>-Befehls sobald ein Gerät kopiert wurde.<br />
|-<br />
| [[#X_State|X_State]]|| Wird aufgerufen im Rahmen des <code>setstate</code>-Befehls bevor der Status einer Gerätedefinition bzw. eines zugehörigen Readings gesetzt wird.<br />
|-<br />
| [[#X_AsyncOutput|X_AsyncOutput]]|| Nur relevant für Module die via [[TcpServerUtils]] eine Client-Verbindung zu FHEM ermöglichen (z.B. FHEMWEB und telnet). Ermöglicht die asynchrone Ausgabe von Daten via [[DevelopmentModuleAPI#asyncOutput|asyncOutput()]] an einen einzelnen verbundenen Client.<br />
|-<br />
| [[#X_ActivateInform|X_ActivateInform]]|| Nur relevant für Module die via [[TcpServerUtils]] eine Client-Verbindung zu FHEM ermöglichen (z.B. FHEMWEB und telnet). Ermöglicht das Aktivieren des inform-Mechanismus zum Senden von Events für einen einzelnen verbundenen Client.<br />
|-<br />
| [[#X_Authorize|X_Authorize]]|| Wird aufgerufen im Rahmen von [[DevelopmentModuleAPI#Authorized|Authorized()]] um eine gewünschte Vorgangs-Art zu autorisieren.<br />
|-<br />
| [[#X_Authenticate|X_Authenticate]]|| Wird aufgerufen im Rahmen von [[DevelopmentModuleAPI#Authenticate|Authenticate()]] um eine Authentifizierung zu prüfen und ggf. zu genehmigen.<br />
|}<br />
<br />
In der [[#X_Initialize|Initialize]]-Funktion werden diese wie folgt definiert:<br />
<br />
<syntaxhighlight lang="perl"><br />
$hash->{DbLog_splitFn} = "X_DbLog_split";<br />
$hash->{ExceptFn} = "X_Except";<br />
$hash->{CopyFn} = "X_Copy";<br />
$hash->{AsyncOutputFn} = "X_AsyncOutput";<br />
$hash->{ActivateInformFn} = "X_ActivateInform";<br />
$hash->{StateFn} = "X_State";<br />
$hash->{AuthorizeFn} = "X_Authorize";<br />
$hash->{AuthenticateFn} = "X_Authenticate";<br />
</syntaxhighlight><br />
<br />
<br />
Diese Funktionen werden in diesem Abschnitt genauer beschrieben.<br />
==== X_DbLog_split ====<br />
<syntaxhighlight lang="perl"><br />
sub X_DbLog_split ($$)<br />
{<br />
my ( $event, $device_name ) = @_;<br />
<br />
...<br />
<br />
return ( $reading, $value, $unit );<br />
}<br />
</syntaxhighlight><br />
<br />
Die DbLog_split-Funktion wird durch das Modul [[DbLog]] aufgerufen, sofern der Nutzer DbLog benutzt. Sofern diese Funktion implementiert ist, kann der Modul-Autor das Auftrennen von Events in den Reading-Namen, -Wert und der Einheit selbst steuern. Andernfalls nimmt DbLog diese Auftrennung selber mittels Trennung durch Leerzeichen sowie vordefinierten Regeln zu verschiedenen Modulen vor. Je nachdem, welche Readings man in seinem Modul implementiert, passt diese standardmäßige Trennung jedoch nicht immer.<br />
<br />
Der Funktion werden folgende Eingangsparameter übergeben:<br />
# Das generierte Event (Bsp: <code>temperature: 20.5 °C</code>)<br />
# Der Name des Geräts, welche das Event erzeugt hat (Bsp: <code>Temperatursensor_Wohnzimmer</code>)<br />
<br />
Es ist nicht möglich in der DbLog_split-Funktion auf die verarbeitende DbLog-Definition zu referenzieren.<br />
<br />
Als Rückgabewerte muss die Funktion folgende Werte bereitstellen:<br />
# Name des Readings (Bsp: <code>temperature</code>)<br />
# Wert des Readings (Bsp: <code>20.5</code>)<br />
# Einheit des Readings (Bsp: <code>°C</code>)<br />
<br />
Beispiel:<br />
<syntaxhighlight lang="perl"><br />
sub X_DbLog_splitFn($$)<br />
{<br />
my ($event, $device) = @_;<br />
my ($reading, $value, $unit);<br />
my $devhash = $defs{$device}<br />
<br />
if($event =~ m/temperature/) {<br />
$reading = 'temperature';<br />
$value = substr($event,12,4);<br />
$unit = '°C';<br />
} <br />
<br />
return ($reading, $value, $unit);<br />
}<br />
</syntaxhighlight><br />
<br />
==== X_Except ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Except ($)<br />
{<br />
my ( $hash ) = @_;<br />
<br />
...<br />
}<br />
</syntaxhighlight><br />
<br />
Die X_Except-Funktion wird durch fhem.pl aufgerufen, wenn die Gerätedefinition <code>$hash</code> in <code>[[#Wichtige_globale_Variablen_aus_fhem.pl|%selectlist]]</code> aufgeführt ist und der Filedeskriptor in <code>$hash->{EXCEPT_FD}</code> eine Exception bzw. Interrupt auslöst. <br />
<br />
Der Rückgabewert wird nicht ausgewertet und ist daher irrelevant.<br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
use IO::File;<br />
<br />
...<br />
<br />
sub X_Except ($)<br />
{<br />
my ( $hash ) = @_;<br />
<br />
# Filehandle aus Filedescriptor erstellen<br />
my $filehandle = IO::File->new_from_fd($hash->{EXCEPT_FD}, 'r');<br />
seek($filehandle,0,0); <br />
<br />
# aktuellen Inhalt auslesen<br />
my $current_value = $filehandle->getline;<br />
<br />
if($current_value eq "1")<br />
{<br />
...<br />
}<br />
else<br />
{<br />
...<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
==== X_Copy ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Copy ($)<br />
{<br />
my ( $old_name, $new_name ) = @_;<br />
<br />
...<br />
}<br />
</syntaxhighlight><br />
<br />
Die X_Copy-Funktion wird durch das Modul [[copy]] aufgerufen nachdem ein Nutzer eine Gerätedefinition über den Befehl <code>copy</code> kopiert hat. Dazu werden als Funktionsparameter die Definitionsnamen der alten und neuen Gerätedefinition übergeben. Es dient dazu zusätzliche Daten aus der zu kopierenden Gerätedefinition in die neue Definition zu übernehmen. Der Befehl <code>copy</code> überträgt lediglich <code>$hash->{DEF}</code> in die neue Definition sowie sämtliche gesetzte Attribute. Weitere Daten müssen dann durch die X_Copy-Funktion übertragen werden. <br />
<br />
Die X_Copy-Funktion wird erst nach dem erfolgtem Kopiervorgang aufgerufen.<br />
<br />
Der Rückgabewert wird nicht ausgewertet und ist daher irrelevant.<br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
<br />
sub X_Copy ($$)<br />
{<br />
my ( $old_name, $new_name ) = @_;<br />
<br />
my $old_hash = $defs{$old_name};<br />
my $new_hash = $defs{$new_name};<br />
<br />
# copy also temporary session key<br />
$new_hash->{helper}{SESSION_KEY} = $old_hash->{helper}{SESSION_KEY};<br />
}<br />
</syntaxhighlight><br />
<br />
==== X_AsyncOutput ====<br />
{{Randnotiz|RNTyp=Info|RNText='''ACHTUNG:''' Diese Funktion ist nur relevant, wenn man ein Frontend-Modul erstellt über das FHEM von einem Anwender bedient werden kann (FHEMWEB, telnet, yowsup, telegram, alexa-fhem, homebridge-fhem, tabletui, ...).}}<br />
<syntaxhighlight lang="perl"><br />
sub X_AsyncOutput ($)<br />
{<br />
my ( $client_hash, $text ) = @_;<br />
<br />
...<br />
<br />
return $error;<br />
}<br />
</syntaxhighlight><br />
<br />
Die Funktion X_AsyncOutput wird durch [[DevelopmentModuleAPI#asyncOutput|asyncOutput()]] von anderen Modulen aufgerufen. Es erlaubt diesen anderen Modulen die Ausgabe von asynchronen Befehlsergebnissen <code>$text</code> zuvor ausgeführter set-/get-Befehle an den entsprechenden Client (identifiziert durch den Client-Hash <code>$client_hash</code> der temporären Definition) zurückzugeben. <br />
<br />
Wenn ein Client einen set-/get-Befehl ausführt, wird der Client-Hash bei der Ausführung dieser Befehle an die jeweiligen Module übermittelt. Sobald ein Befehl ausgeführt wird, der seine Ausgabe asynchron ausführen möchte und die Client-Verbindung des Server-Moduls dies unterstützt (<code>$client_hash->{canAsyncOutput}</code> ist gesetzt), merkt sich das befehlsausführende Modul den Client-Hash und gibt das Ergebnis des Befehls zu späterer Zeit via [[DevelopmentModuleAPI#asyncOutput|asyncOutput()]] an den ursprünglichen Client zurück. Die Funktion X_AsyncOutput des Server-Moduls kümmert sich darum das Ergebnis dem entsprechenden Client in der notwendigen Form zuzustellen.<br />
<br />
Der Rückgabewert von X_AsyncOutput() wird als Rückgabewert für asyncOutput() verwendet. Man kann hier im Fehlerfall eine Fehlermeldung angeben und im Erfolgsfall <code>undef</code>. Der Rückgabewert wird aber aktuell nicht ausgewertet.<br />
<br />
==== X_ActivateInform====<br />
{{Randnotiz|RNTyp=Info|RNText='''ACHTUNG:''' Diese Funktion ist nur relevant, wenn man ein Frontend-Modul erstellt über das FHEM von einem Anwender bedient werden kann (FHEMWEB, telnet, yowsup, telegram, alexa-fhem, homebridge-fhem, tabletui, ...).}}<br />
<syntaxhighlight lang="perl"><br />
sub X_ActivateInform($$)<br />
{<br />
my ( $client_hash, $arg ) = @_;<br />
<br />
...<br />
}<br />
</syntaxhighlight><br />
<br />
Die Funktion X_ActivateInform wird aktuell nur durch den [[update]]-Befehl aufgerufen, sofern ein Client eines Frontend-Moduls diesen Befehl aufgerufen hat um den Inform-Mechanismus (Senden von Events) zu aktivieren. Dadurch wird im Falle von [[update]] die umgehende Anzeige der Logmeldungen für den ausführenden Client aktiviert. In [[FHEMWEB]] geschieht das über den Event-Monitor, bei telnet mit der direkten Ausgabe.<br />
<br />
Da diese Funktion aktuell nur speziell für den update-Befehl implementiert ist, kann man aktuell keine genaue Angaben zu den möglichen Werten von <code>$arg</code> geben. Dieser Parameter dient dazu genauer zu spezifizieren was exakt an Events an den entsprechenden Client <code>$client_hash</code> zu senden ist. Aktuell wird dazu die Parametersyntax des inform-Befehls verwendet (on|off|log|raw|timer|status).<br />
<br />
==== X_State ====<br />
<syntaxhighlight lang="perl"><br />
sub X_State($$$$)<br />
{<br />
my ( $hash, $time, $readingName, $value ) = @_;<br />
<br />
...<br />
<br />
return $error;<br />
}<br />
</syntaxhighlight><br />
<br />
Die X_State-Funktion wird durch fhem.pl aufgerufen, sobald über den Befehl <code>setstate</code> versucht wird ein Wert für ein Reading oder den Status (<code>$hash->{STATE}</code>) einer Gerätedefinition zu setzen. Dieser Befehl wird primär beim Starten von FHEM aufgerufen sobald das State-File eingelesen wird. Je nachdem, ob im gegebenen Fall ein Reading oder der Definitionsstatus gesetzt wird, haben die Übergabeparameter verschiedene Werte:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Funktionsparameter!! Wert beim Setzen eines Readings !! Wert beim Setzen eines Definitionsstatus<br />
|-<br />
| <code>$hash</code> || colspan=2 align=center | Die Hashreferenz der betreffenden Gerätedefinition<br />
|-<br />
| <code>$time</code>|| Der Zeitstempel auf welchen das Reading <code>$readingName</code> gesetzt werden soll. Das Ergebnis entspricht dem Rückgabewert der Funktion || Der aktuelle Zeitstempel zum jetzigen Zeitpunkt.<br />
|-<br />
| <code>$readingName</code>|| Der Name des Readings, welches auf einen neuen Wert gesetzt werden soll. || Statischer Wert "STATE" um anzuzeigen, dass es sich um den Definitionsstatus handelt, welcher gesetzt werden soll (<code>$hash->{STATE}</code>).<br />
|-<br />
| <code>$value</code> || Den Wert, welchen das Reading <code>$readingName</code> annehmen soll. || Den Wert, welchen die Gerätedefinition als Status annehmen soll.<br />
|}<br />
<br />
Wenn via <code>setstate</code> ein Reading gesetzt wird, kann die X_State-Funktion das Setzen dieses Readings durch die Rückgabe einer aussagekräftigen Fehlermeldung unterbinden. Sofern <code>undef</code> zurückgegeben wird, wird das entsprechende Reading auf den übergebenen Status gesetzt.<br />
<br />
Wenn via <code>setstate</code> der Definitionsstatus gesetzt wird, wird die X_State-Funktion erst nach dem Setzen des Status aufgerufen. Man kann dabei zwar eine Fehlermeldung zurückgeben, der Status wird aber dennoch übernommen. Die Fehlermeldung wird lediglich dem Nutzer angezeigt.<br />
<br />
Beispiel:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_State($$$$)<br />
{<br />
my ( $hash, $time, $readingName, $value ) = @_;<br />
<br />
return undef if($readingName "STATE" || $value ne "inactive");<br />
readingsSingleUpdate($hash, "state", "inactive", 1);<br />
return undef;<br />
}<br />
</syntaxhighlight><br />
<br />
==== X_Authorize ====<br />
<syntaxhighlight lang="perl"><br />
sub X_Authorize($$$$)<br />
{<br />
my ( $hash, $client_hash, $type, $arg ) = @_;<br />
<br />
...<br />
<br />
return $authorized;<br />
}<br />
</syntaxhighlight><br />
<br />
Die Authorize-Funktion wird von fhem.pl aufgerufen um zu erfragen, ob ein bestimmter Client <code>$client_hash</code> die Aktion <code>$type</code>/<code>$arg</code> ausführen darf. Auf diese Weise können Module Einfluss nehmen, welcher User welche Funktionen in FHEM nutzen darf. Wenn ein Client eine Aktion ausführen möchte, werden alle Module, die eine Authorize-Funktion implementiert haben, gefragt, ob diese Aktion ausgeführt werden darf. Als Rückgabewert wird das Ergebnis der Überprüfung zurückgegeben, wobei <code>0</code> (unbekannt / nicht zuständig), <code>1</code> (erlaubt) oder <code>2</code> (verboten) zurückgegeben werden können.<br />
<br />
Es gibt aktuell folgende <code>$type</code>/<code>$arg</code> Kombinationen, mit denen die Authorize-Funktion aufgerufen werden:<br />
<br />
{| class="wikitable"<br />
|-<br />
! $type !! $arg !! Überschrift<br />
|- <br />
|rowspan="3" style="white-space: nowrap;" | <code>'''$type''' = "cmd"</code><br />
<br />
<br />
''Befehlsausführung''<br />
| style="white-space: nowrap;" | <code>'''$arg''' = "set Lampe on"</code> || Jeglicher FHEM-Befehl, der ausgeführt werden soll, wird in <code>$arg</code> hinterlegt, sodass innerhalb einer Authorize-Funktion der Befehl genauer geparst werden kann um zu entscheiden, ob dieser Befehl erlaubt ist, oder nicht.<br />
|-<br />
| style="white-space: nowrap;" | <code>'''$arg''' = "perl"</code> || Ausführen von Perl-Befehlen jeglicher Art. Der genaue Befehl wird dabei nicht an die Authorize-Funktion übergeben.<br />
<br />
Bsp: <code>{ReadingsVal("Lampe", "state", "off"}</code><br />
|-<br />
| style="white-space: nowrap;" | <code>'''$arg''' = "shell"</code> || Ausführen von Shell-Befehlen jeglicher Art. Der genaue Befehl wird dabei nicht an die Authorize-Funktion übergeben.<br />
<br />
Bsp: <code>"/opt/fhem/myScript.sh"</code><br />
|-<br />
|style="white-space: nowrap;" | <code>'''$type''' = "devicename"</code><br />
<br />
<br />
''Sichtbarkeit von Geräten/Definitionen'' <br />
|style="white-space: nowrap;" | <code>'''$arg''' = "Licht_Wohnzimmer"</code> || Sichtbarkeit des jeweiligen Gerät/Definition in FHEM. Dies bedeutet konkret die Auffindbarkeit im <code>list</code>-Befehl, sowie der Suche via [[DevelopmentModuleAPI#devspec2array|devspec2array()]]. Wird eine solche Anfrage durch die Authorize-Funktion abgelehnt, ist das entsprechende Gerät bzw. Definition für den jeweiligen Client nicht sichtbar.<br />
|}<br />
<br />
==== X_Authenticate ====<br />
{{Link2Forum|Topic=72757|Message=644098}}<br />
<br />
== Bereitstellen eines eigenen Befehls (Befehlsmodul) ==<br />
<br />
Ein Modul kann primär einen neuen FHEM-Befehl bereitstellen. Man spricht in so einem Fall nicht von einem Gerätemodul, sondern einem Befehlsmodul. Ein solches Befehlsmodul stellt nur einen einzelnen Befehl bereit, der dem Modulnamen entsprechen muss. Nur, wenn der Modulname dem Befehlsname entspricht, kann FHEM das Modul beim ersten Ausführen dieses unbekannten Befehls finden und nachladen.<br />
<br />
Der entsprechende Befehl wird dazu in der [[#X_Initialize|Initialize]]-Funktion im globalen Hash <code>[[DevelopmentModuleIntro#Wichtige_globale_Variablen_aus_fhem.pl|%cmds]]</code> registriert:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Initialize($$) {<br />
<br />
$cmds{X} = { Fn => "CommandX",<br />
Hlp => "<argument1> [optional_argument2], print something very useful",<br />
<br />
# optionaler Filter für Clientmodule als regulärer Ausdruck<br />
ClientFilter => "FHEMWEB"<br />
};<br />
}<br />
</syntaxhighlight><br />
<br />
Damit wird der neue Befehl <code>X</code> in FHEM registriert. Die Funktion mit dem Namen <code>CommandX</code> setzt diesen Befehl innerhalb des Moduls um. Desweiteren wird eine kurze Aufrufsyntax mitgegeben, welche beim Aufruf des <code>help</code>-Befehls dem Nutzer angezeigt wird um als Gedankenstütze zu dienen. Optional kann man mittels <code>ClientFilter</code> (regulärer Ausdruck für Modulnamen) die Ausführbarkeit nur auf bestimmte Client-Module (wie FHEMWEB oder telnet) beschränken. <br />
<br />
Nun muss noch die Funktion <code>CommandX</code> im Rahmen des Moduls implementiert werden, welche den Befehl <code>X</code> umsetzt:<br />
<br />
<syntaxhighlight lang="Perl"><br />
sub CommandX($$)<br />
{<br />
my ($client_hash, $arguments) = @_;<br />
<br />
...<br />
<br />
return $output;<br />
}<br />
</syntaxhighlight><br />
<br />
Dabei werden der Befehlsfunktion zwei Parameter übergeben. Zuerst die Hash-Referenz des aufrufenden Clients (sofern manuell ausgeführt, ansonsten <code>undef</code>) zwecks Rechteprüfung via [[allowed|allowed-Definitionen]]. Anschließend folgen die Aufrufparameter als zusammenhängende Zeichenkette. Die Trennung der einzelnen Argumente obligt der Funktion (bspw. via [[DevelopmentModuleAPI#parseParams|parseParams()]]). Als Funktionsrückgabewert wird eine Ausgabemeldung erwartet, die dem Nutzer angezeigt werden soll.<br />
<br />
== Pollen von Geräten ==<br />
Wenn Geräte von sich aus keine Informationen senden sondern abgefragt werden müssen, kann man im Modul die Funktion [[DevelopmentModuleAPI#InternalTimer|InternalTimer()]] verwenden um einen Funktionsaufruf zu einem späteren Zeitpunkt durchführen zu können. Man übergibt dabei den Zeitpunkt für den nächsten Aufruf, den Namen der Funktion, die aufgerufen werden soll, sowie den zu übergebenden Parameter. Als zu übergebender Parameter wird üblicherweise der Hash der betroffenen Geräteinstanz verwendet. Damit hat die aufgerufene Funktion Zugriff auf alle wichtigen Daten der Geräteinstanz. Eventuell zusätzlich benötigte Werte können einfach als weitere Internals über den Hash zugänglich gemacht werden.<br />
<br />
Beispielsweise könnte man für das Abfragen eines Geräts in der [[#X_Define|Define]]-Funktion den Timer folgendermaßen setzen:<br />
<br />
<syntaxhighlight lang="perl"><br />
InternalTimer(gettimeofday()+2, "X_GetUpdate", $hash); <br />
</syntaxhighlight><br />
<br />
Alternativ kann man auch in der [[#X_Notify|Notify]]-Funktion auf das Event <code>global:INITIALIZED</code> bzw. <code>global:REREADCFG</code> reagieren und erst dort, den Timer anstoßen, sobald die Konfiguration komplett eingelesen wurde. Dies ist insbesondere notwendig, wenn man sicherstellen will, dass alle Attribute aus der Konfiguration gesetzt sind, sobald man einen Status-Update initiiert.<br />
<br />
In der Funktion <code>X_GetUpdate</code> selbst wird dann der Timer neu gesetzt, so dass nach einem Intervall die Funktion erneut aufgerufen wird:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_GetUpdate($)<br />
{<br />
my ($hash) = @_;<br />
my $name = $hash->{NAME};<br />
Log3 $name, 4, "X: GetUpdate called ...";<br />
<br />
...<br />
<br />
# neuen Timer starten in einem konfigurierten Interval.<br />
InternalTimer(gettimeofday()+$hash->{Interval}, "X_GetUpdate", $hash);<br />
}<br />
</syntaxhighlight><br />
<br />
Innerhalb der Funktion kann man nun das Gerät abfragen und die abgefragten Werte in Readings speichern. Falls das Abfragen der Werte jedoch zu einer Verzögerung und damit zu einer Blockade von FHEM führen kann, ist es möglich, in der GetUpdate-Funktion nur die Aufforderung zum Senden bestimmter Daten an das angeschlossene Gerät zu senden und dann das Lesen über die oben beschriebene [[#X_Read|Read]]-Funktion zu implementieren.<br />
<br />
Eine genaue Beschreibung der Timer-Funktion gibt es [[DevelopmentModuleAPI#Timer|hier im Wiki]]<br />
<br />
== Logging / Debugging ==<br />
Um Innerhalb eines Moduls eine Log-Meldung in die FHEM-Logdatei zu schreiben, wird die Funktion [[DevelopmentModuleAPI#Log3|Log3()]] aufgerufen.<br />
<syntaxhighlight lang="perl"><br />
Log3 $name, 3, "X ($name) - Problem erkannt ...";<br />
</syntaxhighlight><br />
Eine genaue Beschreibung zu der Funktion inkl. Aufrufparameter findet man [[DevelopmentModuleAPI#Log3|hier]]. Es ist generell ratsam in der Logmeldung sowohl den Namen des eigenen Moduls zu schreiben, sowie den Namen des Geräts, welche diese Logmeldung produziert, da die Meldung, so wie sie ist, direkt in das Logfile wandert und es für User ohne diese Informationen schwierig ist, die Meldungen korrekt zuzuordnen.<br />
<br />
Die Funktion Log3() verwendet den Namen der Geräteinstanz um das <code>verbose</code>-Attribut zu prüfen. In der Regel wird bei Modulfunktionen jedoch immer nur der Gerätehash <code>$hash</code> übergeben. Um den Namen der Definition zu ermitteln ist es daher notwendig sich diesen aus dem Hash extrahieren:<br />
<br />
<syntaxhighlight lang="perl"><br />
my $name = $hash->{NAME};<br />
</syntaxhighlight><br />
<br />
Um für eine einzelne Geräteinstanz das Verbose-Level zu erhöhen, ohne gleich für das gesamte FHEM den globalen Verbose-Level zu erhöhen und damit alle Meldungen zu erzeugen, kann man den Befehl <br />
<code>attr <NAME> verbose</code> verwenden. Beispielsweise <code>attr Lichtschalter_Wohnzimmer verbose 5</code><br />
<br />
Logmeldungen sollten je nach Art und Wichtigkeit für den Nutzer in unterschiedlichen Loglevels erzeugt werden. Es gibt insgesamt 5 Stufen in denen geloggt werden kann. Standardmäßig steht der systemweite Loglevel (<code>global</code>-Attribut <code>verbose</code>) auf der Stufe 3. Die Bedeutung der jeweiligen Stufen ist in der {{Link2CmdRef|Lang=de|Anker=verbose}} beschrieben.<br />
<br />
Während der Entwicklung eines Moduls kann man für eigene Debug-Zwecke auch die Funktion [[DevelopmentModuleAPI#Debug|Debug()]] verwenden um schnell und einfach Debug-Ausgaben in das Log zu schreiben. Diese sollten in der endgültigen Fassung jedoch nicht mehr vorhanden sein. Sie dienen ausschließlich zum Debugging während der Entwicklung.<br />
<br />
Eine genaue Beschreibung der Log-Funktion gibt es [[DevelopmentModuleAPI#Logging|hier im Wiki]].<br />
<br />
== Zweistufiges Modell für Module ==<br />
[[Datei:Zweistufiges Modulkonzept.jpg|mini|rechts|Schematische Darstellung am Beispiel CUL]]<br />
Es gibt viele Geräte, welche die Kommunikation mit weiteren Geräten mit tlw. unterschiedlichen Protokollen ermöglichen. Das typischste Beispiel bietet hier der [[CUL]], welcher via Funk mit verschiedenen Protokollen weitere Geräte ansprechen kann (z.B. Aktoren, Sensoren, ...). Hier bildet ein Gerät eine Brücke durch die weitere Geräte in FHEM zugänglich gemacht werden können. Dabei werden über einen Kommunikationsweg (z.B. serielle Schnittstelle, TCP, ...) beliebig viele Geräte gesteuert. Typische Beispiele dazu sind:<br />
<br />
* [[CUL]]: stellt Geräte mit verschiedenen Kommunikationsprotokollen via Funk bereit (u.a. [[FS20]], [[HomeMatic]], [[Funk-Heizkörperregler_Kurz-Bedienungsanleitung_FHT|FHT]], [[MAX]], ...)<br />
* [[HMLAN]]: stellt HomeMatic Geräte via Funk bereit<br />
* [[MAX#MAXLAN|MAXLAN]]: stellt [[MAX|MAX!]] Geräte via Funk bereit<br />
* [[PanStamp#panStick.2FShield|panStamp]]: stellt weitere panStamp Geräte via Funk bereit<br />
<br />
Dabei wird die Kommunikation in 2 Stufen unterteilt:<br />
* physisches Modul - z.B. 00_CUL.pm - zuständig für die physikalische Kommunikation mit der Hardware. Empfangene Daten müssen einem logischen Modul zugeordnet werden.<br />
* logische Modul(e) - z.B. 10_FS20.pm - interpretiert protokollspezifische Nachrichten. Sendet protokollspezifische Daten über das physische Modul an die Hardware.<br />
<br />
<u>physisches Modul</u><br />
<br />
Das physische Modul öffnet die Datenverbindung zum Gerät (z.B. CUL) und verarbeitet sämtliche Daten. Es kümmert sich um den Erhalt der Verbindung (bsp. durch Keep-Alives) und konfiguriert das Gerät so, dass eine Kommunikation mit allen weiteren Geräten möglich ist (bsp. Frequenz, Modulation, Kanal, etc.).<br />
<br />
Empfangene Nutzdaten werden als Zeichenkette über die Funktion [[DevelopmentModuleAPI#Dispatch|Dispatch()]] an logische Module weitergegeben.<br />
<br />
Das Modul stellt eine [[#Die_Match-Liste|Match-Liste]] bereit, anhand FHEM die Nachricht einem Modul zuordnen kann, sofern dieses noch nicht geladen sein sollte. Die Match-Liste enthält eine Liste von regulären Ausdrücken und ordnet diese einem Modul zu. Wenn eine Nachricht auf einen solchen regulären Ausdruck passt und das Modul noch nicht geladen ist, lädt FHEM dieses automatisch nach, zwecks Verarbeitung der Nachricht. <br />
<br />
Anhand einer bereitgestellten [[#Die_Client-Liste|Client-Liste]] (Auflistung von logischen Modulen) kann FHEM feststellen, welche logischen Module mit dem physischen Modul kommunizieren können. Nur die hier aufgelisteten, logischen Module werden beim Aufruf von [[DevelopmentModuleAPI#Dispatch|Dispatch()]] angesprochen.<br />
<br />
Das Modul stellt eine [[#X_Write|Write]]-Funktion zur Verfügung, über die logische Module Daten in beliebiger Form an die Hardware übertragen können. <br />
<br />
<u>logisches Modul</u><br />
<br />
Das logische Modul interpretiert die via Dispatch() übergebene Nachricht (Zeichenkette) durch eine bereitgestellte [[#X_Parse|Parse]]-Funktion und erzeugt entsprechende Readings/Events. Es stellt über <code>set</code>-/<code>get</code>-Kommandos Steuerungsmöglichkeiten dem Nutzer zur Verfügung.<br />
<br />
Es stellt FHEM einen [[#Der_Match-Ausdruck|Match-Ausdruck]] (regulärer Ausdruck) zur Verfügung anhand [[DevelopmentModuleAPI#Dispatch|Dispatch()]] ermitteln kann, ob die Nachricht durch das logische Modul verarbeitet werden kann. Nur Nachrichten, welche auf diesen Ausdruck passen, werden an das logische Modul weitergegeben (Aufruf [[#X_Parse|Parse]]-Funktion).<br />
<br />
=== Die Client-Liste ===<br />
<br />
Die Client-Liste ist eine Auflistung von Modulnamen (genauer: regulären Ausdrücken die auf Modulnamen passen) die in einem physischen Modul gesetzt ist. Damit wird definiert, mit welchen logischen Modulen das physikalische Modul kommunizieren kann. <br />
<br />
Eine Client-Liste ist eine Zeichenkette, welche aus allen logischen Modulnamen besteht. Die einzelnen Namen werden durch einen Doppelpunkt getrennt. Anstatt kompletter Modulnamen können auch reguläre Ausdrücke verwendet werden, die auf mehrere Modulnamen passen (z.B. <code>CUL_.*</code> um die logischen Module CUL_HM, CUL_MAX, etc. zu verwenden).<br />
<br />
Bsp.: Die Client-Liste von dem Modul CUL lautet daher wie folgt:<br />
<br />
FS20:FHT.*:KS300:USF1000:BS:HMS:CUL_EM:CUL_WS:CUL_FHTTK:CUL_HOERMANN:ESA2000:CUL_IR:CUL_TX:Revolt:IT:UNIRoll:SOMFY:STACKABLE_CC:CUL_RFR:CUL_TCM97001:CUL_REDIRECT<br />
<br />
Alle hier aufgelisteten Module können über das Modul CUL Daten empfangen bzw. senden.<br />
<br />
Die Client-Liste hat generell folgende Funktion:<br />
* Die Funktion [[DevelopmentModuleAPI#Dispatch|Dispatch()]] prüft nur Module, welche in der Client-Liste enthalten sind, ob diese die Nachricht verarbeiten können (Prüfung via [[#Der Match-Ausdruck|Match-Ausdruck]])<br />
* Die Funktion [[DevelopmentModuleAPI#AssignIoPort|AssignIoPort()]] prüft anhand sämtlicher Client-Listen in FHEM, welches IO-Gerät für ein logisches Gerät nutzbar ist.<br />
<br />
Üblicherweise wird die Client-Liste in der [[#X_Initialize|Initialize]]-Funktion im Modul-Hash gesetzt:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Initialize($)<br />
{<br />
my ($hash) = @_;<br />
...<br />
$hash->{Clients} = "FS20:KS300:FHT.*";<br />
}<br />
</syntaxhighlight><br />
<br />
Man kann die Client-Liste jedoch auch pro physikalisches Gerät setzen. Eine gesetzte Client-Liste in einem Gerät hat immer Vorrang vor der Liste im Modul-Hash. Eine gerätespezifische Client-Liste wird dann verwendet, wenn bspw. ein Gerät je nach Konfiguration nur bestimmte logische Module bedienen kann. Bspw. kann ein CUL je nach RF-Einstellungen FS20, uvm. oder nur HomeMatic bedienen. In einem solchen Fall wird die Client-Liste im Geräte-Hash gesetzt:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Define($$)<br />
{<br />
my ( $hash, $def ) = @_;<br />
...<br />
$hash->{Clients} = "CUL_HM";<br />
}<br />
</syntaxhighlight><br />
<br />
In vielen Modulen, welche nach dem zweistufigem Konzept arbeiten, beginnt und endet die Client-Liste mit einem Doppelpunkt. Dies ist ein historisches Überbleibsel, da der Prüfmechanismus die Client-Liste früher auf das Vorhandensein von <code>'''<u><font color="red">:</font></u>'''&lt;Modulname&gt;'''<u><font color="red">:</font></u>'''</code> prüfte. Dies ist nun nicht mehr notwendig. Die einzelnen Modulnamen müssen lediglich durch einen Doppelpunkt getrennt werden.<br />
<br />
=== Die Match-Liste ===<br />
{{Randnotiz|RNTyp=Info|RNText=<font color="red"><u>'''ACHTUNG''':</u></font><br />
Sämtliche regulären Ausdrücke in der Match-Liste werden "case insensitive" überprüft. Das bedeutet, dass Groß-/Kleinschreibung nicht berücksichtigt wird.<br />
<br />
Um dennoch in einem regulären Ausdruck auf Groß-/Kleinschreibung zu prüfen, kann man dieses mit dem Modifizierer <code>(?-i)</code> wieder aktivieren:<br />
<br />
<syntaxhighlight lang="perl"><br />
my %matchListFHEMduino = (<br />
....<br />
"5:FHEMduino_PT2262" => "^(?-i)IR.*\$",<br />
....<br />
"13:IT" => "^(?-i)i......\$",<br />
);<br />
</syntaxhighlight><br />
<br />
Siehe dazu Forumsbeitrag: {{Link2Forum|Topic=33422}}<br />
}}<br />
Die Match-Liste ordnet eine Nachrichtensyntax (regulärer Ausdruck) einem Modulnamen zu und wird in einem physikalischen Modul gesetzt. Sollte eine Nachricht vom physikalischen Gerät empfangen werden, die durch kein geladenes Modul verarbeitet werden kann ([[DevelopmentModuleAPI#Dispatch|Dispatch()]] prüft nur alle bisher geladenen Module aus der [[#Die Client-Liste|Client-Liste]]), so wird über die Match-Liste geprüft, welches Modul diese Nachricht verarbeiten kann. Dieses Modul wird anschließend geladen und die Nachricht durch dieses direkt durch Aufruf der [[#X_Parse|Parse]]-Funktion verarbeitet. In dieser Liste findet mittels regulärem Ausdruck eine Zuordnung der Nachrichtenstruktur zum verarbeitenden logischen Modul statt.<br />
<br />
Diese Liste wird ausschließlich in der [[DevelopmentModuleAPI#Dispatch|Dispatch()]]-Funktion verwendet. Sollte keine passendes Modul, welches bereits geladen ist, zur Verarbeitung einer Nachricht gefunden werden, so wird mithilfe der Match-Liste aufgrund der vorliegenden Nachricht das entsprechende Modul ermittelt. Dieses Modul wird dann direkt geladen und die Nachricht wird via [[#X_Parse|Parse]]-Funktion verarbeitet.<br />
<br />
Die Match-Liste ist eine Zuordnung von einem Sortierpräfix + Modulname zu einem regulären Ausdruck:<br />
<br />
<syntaxhighlight lang="perl"><br />
{<br />
"1:FS20" => "^81..(04|0c)..0101a001",<br />
"2:KS300" => "^810d04..4027a001",<br />
"3:FHT" => "^81..(04|09|0d)..(0909a001|83098301|c409c401).."<br />
}<br />
</syntaxhighlight><br />
<br />
Das Sortierpräfix (<code><u>1:</u><font color="grey">FS20</font></code>) dient als Sortierhilfe um so die Reihenfolge der Prüfung festzulegen. Bei der Prüfung wird die Match-Liste mittels sort() nach dem Schlüssel (Sortierpräfix + Modulname) sortiert und die regulären Ausdrücke werden dann nacheinander getestet. Daher sollten die präzisesten Ausdrücke immer zuerst getestet werden, sofern es weniger präzise Ausdrücke in der Match-Liste gibt. Dabei ist zu beachten, dass der Sortierpräfix nicht nach numerischen Regeln sortiert wird, sondern zeichenbasierend.<br />
<br />
Üblicherweise wird die Match-Liste in der [[#X_Initialize|Initialize]]-Funktion im Modul-Hash gesetzt:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Initialize($)<br />
{<br />
my ($hash) = @_;<br />
<br />
...<br />
<br />
$hash->{MatchList} = { "1:FS20" => "^81..(04|0c)..0101a001",<br />
"2:KS300" => "^810d04..4027a001",<br />
"3:FHT" => "^81..(04|09|0d)..(0909a001|83098301|c409c401).." };<br />
}<br />
</syntaxhighlight><br />
<br />
Man kann die Match-Liste, ähnlich wie bei der Client-Liste, auch pro physikalisches Gerät setzen. Dabei hat auch hier die Match-Liste eines Gerätes immer Vorrang vor der Match-Liste aus dem Modul-Hash:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Define($$)<br />
{<br />
my ($hash, $def) = @_;<br />
<br />
...<br />
<br />
$hash->{MatchList} = { "1:CUL_HM" => "^A...................." };<br />
}<br />
</syntaxhighlight><br />
<br />
=== Der Match-Ausdruck ===<br />
<br />
Ein Match-Ausdruck wird in einem logischen Modul gesetzt und dient der Prüfung, ob eine Nachricht durch das eigene Modul via [[#X_Parse|Parse]]-Funktion verarbeitet werden kann. Es handelt sich hierbei um einen einzelnen regulären Ausdruck, den FHEM innerhalb der [[DevelopmentModuleAPI#Dispatch|Dispatch()]]-Funktion prüft. Nur wenn eine Nachricht via Dispatch() auf diesen Audruck matcht, wird die Parse-Funktion des eigenen Moduls aufgerufen um die Nachricht zu verarbeiten. <br />
<br />
Der Hintergrund, warum man den Aufruf mit einem solchen Ausdruck vorher abprüft, liegt in der Möglichkeit, dass ein physikalisches Modul mehrere unterschiedliche logische Module ansprechen kann. So kann FHEM jedes geladene Modul durch diesen Match-Ausdruck prüfen, ob es diese Nachricht verarbeiten kann. Erst, wenn alle geladenen Module, aufgrund einer Prüfung des Ausdrucks, die Nachricht nicht verarbeiten können, wird via [[#Die_Match-Liste|Match-Liste]] ermittelt, welches Modul geladen werden muss um die Nachricht zu verarbeiten. <br />
<br />
Der Match-Ausdruck wird in der [[#X_Initialize|Initialize]]-Funktion zur Verfügung gestellt:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Initialize($)<br />
{<br />
my ($hash) = @_;<br />
<br />
...<br />
<br />
# Dieses Modul verarbeitet FS20 Nachrichten<br />
$hash->{Match} = "^81..(04|0c)..0101a001"; <br />
}<br />
</syntaxhighlight><br />
=== Die vollständige Implementierung ===<br />
<br />
Hier nun eine Zusammenfassung beim zweistufigen Modulkonzept in der jeweiligen Stufe implementiert werden muss, damit die Kommunikation funktioniert.<br />
<br />
==== physisches Modul ====<br />
<br />
Das physische Modul, welches als Kommunikationsbrücke zwischen der Hardware und logischen Modulen fungieren wird, sollte mindestens folgende Funktionen implementieren:<br />
<br />
* [[#X_Initialize|Initialize]]-Funktion - Zum Registrieren des Moduls in FHEM.<br />
* [[#X_Define|Define]]-Funktion - Zum öffnen der Datenverbindung zur Hardware (IP-Adresse/serielle Schnittstelle/...).<br />
* [[#X_Read|Read]]-Funktion - Zum Lesen von Daten, welche die Hardware übermittelt.<br />
* [[#X_Read|Ready]]-Funktion - Zum Wiederaufbau der Verbindung bei Verbindungsabbruch, bzw. Prüfung auf lesbare Daten bei serieller Schnittstelle unter Windows.<br />
* [[#X_Write|Write]]-Funktion - Zum Senden von Daten, welche logische Module via [[DevelopmentModuleAPI#IOWrite|IOWrite()]] an die Hardware übertragen möchten.<br />
* [[#X_Undef|Undef]]-Funktion - Schließen der Verbindung zur Hardware beim Löschen via <code>delete</code> bzw. <code>rereadcfg</code>.<br />
* [[#X_Shutdown|Shutdown]]-Funktion - Schließen der Verbindung zur Hardware beim Stopp von FHEM via <code>shutdown</code>.<br />
* [[#X_DelayedShutdown | DelayedShutdown]]-Funktion - Verzögertes beenden zum Schließen der Verbindung zur Hardware beim Stopp von FHEM via <code>shutdown</code>.<br />
<br />
<br />
Desweiteren müssen in der [[#X_Initialize|Initialize]]-Funktion folgende Daten bereitgestellt werden:<br />
<br />
* [[#Die_Client-Liste|Client-Liste]] - Auflistung aller logischen Module, die über dieses Modul kommunizieren können<br />
* [[#Die_Match-Liste|Match-Liste]] - Zuordnung von Nachrichtensyntax zu Modul zwecks Autoload-Funktionalität.<br />
<br />
==== logisches Modul ====<br />
<br />
Das logische Modul, bildet ein einzelnes Gerät ab, über das mit einem physikalisches Modul kommuniziert werden kann. Es sollte mindestens folgende Funktionen implementieren:<br />
<br />
* [[#X_Initialize|Initialize]]-Funktion - Zum Registrieren des Moduls in FHEM.<br />
* [[#X_Define|Define]]-Funktion - Speichern des Definition Pointers (siehe [[#X_Parse|Parse-Funktion]])<br />
* [[#X_Parse|Parse]]-Funktion - Zum Lesen von Daten, welche die Hardware übermittelt.<br />
* [[#X_Undef|Undef]]-Funktion - Löschen des Definition Pointers beim Löschen via <code>delete</code> bzw. <code>rereadcfg</code>.<br />
<br />
Desweiteren müssen in der [[#X_Initialize|Initialize]]-Funktion folgende Daten bereitgestellt werden:<br />
<br />
* [[#Der_Match-Ausdruck|Match-Ausdruck]] - Prüfausdruck, ob eine Nachricht durch dieses Modul verarbeitet werden kann.<br />
<br />
=== Kommunikation von der Hardware bis zu den logischen Modulen ===<br />
<br />
Die Gerätedefinition des physischen Moduls öffnet eine Verbindung zur Hardware (z.B. via [[DevIo]]). Die [[#X_Read|Read]]-Funktion wird bei anstehenden Daten aus der Hauptschleife von fhem.pl aufgerufen.<br />
<br />
Die Read-Funktion stellt dabei sicher, dass die Daten<br />
* komplett (in der Regel über einen internen Puffer in <code>$hash</code>) und<br />
* korrekt (z.B. via Prüfung mittels regulärem Ausdruck)<br />
sind und ruft die globale Funktion [[DevelopmentModuleAPI#Dispatch|Dispatch()]] mit einer kompletten Nachricht auf.<br />
<br />
Die Funktion Dispatch() prüft alle geladenen Module aus der [[#Die_Client-Liste|Client-Liste]] des physikalischen Moduls nach möglichen logischen Modulen zur Verarbeitung. Alle zum Zeitpunkt geladenen Module, die in der Client-Liste aufgeführt sind, werden über den [[#Der_Match-Ausdruck|Match-Ausdruck]] geprüft, ob sie mit der Nachricht etwas anfangen können. Sollte bei einem logischen Modul der Match-Ausdruck passen, so wird die entsprechende [[#X_Parse|Parse]]-Funktion des logischen Moduls aufgerufen. Sofern keine passendes Modul gefunden wurde, um die Nachricht zu verarbeiten, wird in der [[#Die_Match-Liste|Match-Liste]] im Geräte- bzw. Modul-Hash der physischen Gerätedefinition nach dem passenden Modul gesucht. Sollte es darin ein Modul geben, was diese Art von Nachricht verarbeiten kann, so wird versucht dieses Modul zu laden um nun die Nachricht via Parse-Funktion zu verarbeiten. Es erfolgt in diesem Fall keine Vorprüfung durch den Match-Ausdruck.<br />
<br />
Durch Dispatch() wird nun die [[#X_Parse|Parse]]-Funktion des gefundenen logischen Moduls aufgerufen. Diese<br />
* interpretiert die übergebene Nachricht,<br />
* versucht eine existierende Gerätedefinition in FHEM zu finden (z.B. mittels Definition Pointer), für welche die Nachricht addressiert ist,<br />
* setzt alle [[#Readings|Readings]] für die gefundene Gerätedefinition via [[DevelopmentModuleAPI#Readings_.2F_Events|readings*update]]()-Funktionen,<br />
* gibt den Namen der logischen Definition zurück, welche die Nachricht verarbeitet hat.<br />
<br />
Sollte keine passende Gerätedefinition für die entsprechende Nachricht existieren (Adresse/ID/Kanal/...), wird der Gerätename "UNDEFINED" inkl. einem passenden <code>define</code>-Statement zurückgegeben, um die Definition durch [[autocreate]] erzeugen zu lassen.<br />
<br />
Es findet während der Verarbeitung einer Nachricht durch Dispatch()/Parse-Funktion keine sofortige Eventverarbeitung (via [[DevelopmentModuleAPI#Dispatch|DoTrigger()]]) statt, wenn die [[DevelopmentModuleAPI#Readings_.2F_Events|readings*update]]()-Funktionen verwendet werden.<br />
(Im Gegensatz zum direkten Aufrufen der readings*update Funktionen ohne vorhergehendes Dispatch() )<br />
<br />
Die Funktion Dispatch() triggert das Event-Handling für das von der Parse-Funktion zurückgegebene logische Device selbstständig nach Abschluss der Parse-Funktion.<br />
<br />
Optional führt die Funktion Dispatch() eine Überprüfung auf Nachrichtenduplikate beim Einsatz von mehreren IO-Geräten durch. Dazu wird eine implementierte [[#X_Fingerprint|Fingerprint]]-Funktion im physischen oder logischen Modul benötigt. Sollte der Fingerprint einer Nachricht innerhalb einer bestimmten Zeit (globales Attribut <code>dupTimeout</code>, standardmäßig 500ms) bereits empfangen worden sein, so wird die Nachricht verworfen. Dies ist insbesondere bei funkbasierter Hardware notwendig, wenn mehrere Empfänger die selbe Nachricht empfangen.<br />
<br />
=== Kommunikation von den logischen Modulen bis zur Hardware ===<br />
<br />
Um von einem logischen Modul eine Nachricht an die Hardware senden zu können, muss zunächst im logischen Gerät ein passenden IO-Gerät ausgewählt sein. Dazu muss die Funktion [[DevelopmentModuleAPI#AssignIoPort|AssignIoPort()]] ein entsprechendes IO-Gerät auswählen und in <code>$hash->{IODev}</code> setzen. Dieser Aufruf wird üblicherweise in der [[#X_Define|Define]]-Funktion des logischen Moduls ausgeführt. Erst, wenn ein IO-Gerät ausgewählt wurde, können Daten über das physikalische Gerät an die Hardware übermittelt werden.<br />
<br />
Zum Senden von Daten ruft das logische Modul die Funktion [[DevelopmentModuleAPI#IOWrite|IOWrite()]] samt Daten auf. Diese ruft für das entsprechende IO-Gerät die [[#X_Write|Write]]-Funktion auf und übergibt die Daten zum Schreiben an das physikalische Modul. Die Write-Funktion kümmert sich nun um die Übertragung der Daten an die Hardware. <br />
<br />
Keine direkten Zugriffe zwischen dem logischen und dem physischen Gerät gibt (d.h. keine direkten Aufrufe von Funktionen, kein direktes Überprüfen von <code>$hash</code>-Inhalten, ...), so können die Module hintereinander geschaltet werden (z.B. für Routerfunktionen wie bei der [[RFR_CUL|RFR]]-Funktionalität) oder mittels [[FHEM2FHEM]] im RAW-Modus zwei FHEM-Installationen verbunden werden und die logischen Geräte können dennoch kommunizieren.<br />
<br />
=== Automatisches Anlegen von logischen Gerätedefinitionen (autocreate) ===<br />
<br />
Das logische Modul kann im Rahmen der [[#X_Parse|Parse]]-Funktion eine neue Gerätedefinition anlegen, sofern eine passende Definition nicht existieren sollte. Die Parse-Funktion gibt generell den Namen der logischen Gerätedefinition zurück, für welche die Nachricht verarbeitet wurde. Sollte keine passende Definition gefunden werden, so muss die Parse-Funktion folgenden Rückgabewert liefern (zusammenhängende Zeichenkette):<br />
<br />
UNDEFINED ''&lt;Namensvorschlag&gt;'' ''&lt;Modulname&gt;'' ''&lt;Define-Parameter...&gt;''<br />
<br />
Sollte also bspw. im Rahmen der Parse-Funktion zu Modul X eine Nachricht nicht einer existierenden Gerätedefinition zugeordnet werden können, so muss ein Namensvorschlag erstellt werden der eine eindeutige Komponente wie bspw. eine Adresse/ID/Kanal-Nr enthält. In der Regel wird hier immer der Modulname zusammen mit der eindeutigen Komponente, durch einen Unterstrich getrennt, verwendet (Bsp: <code>X_4834</code>). Der Modulname ist in der Regel immer der, des eigenen Moduls. In besonderen Fällen kann man hier auch einen abweichenden Modulnamen angeben. Dies wird bspw. bei den [[PanStamp#FHEM-Module.2FDevice_Definition_Files|SWAP-Modulen]] eingesetzt. Als Define-Parameter müssen alle notwendigen Parameter angegeben werden, die beim Aufruf des <code>define</code>-Befehls notwendig sind, damit eine neu angelegte Gerätedefinition Nachrichten zu dieser eindeutigen Adresse Daten verarbeitet. Dazu muss mind. die eindeutige Adresse mitgegeben werden.<br />
<br />
Beispiel für FS20:<br />
<br />
UNDEFINED FS20_0ae42f8 FS20 0ae42 f8<br />
<br />
Sobald [[DevelopmentModuleAPI#Dispatch|Dispatch()]] einen solchen Rückgabewert von einer [[#X_Parse|Parse]]-Funktion erhält, wird diese Zeichenkette so wie sie ist via [[DevelopmentModuleAPI#DoTrigger|DoTrigger()]] als Event für die Definition <code>global</code> getriggert.<br />
<br />
Sofern der Nutzer das Modul [[autocreate]] verwendet (definiert hat), kümmert sich dieses nun um das Anlegen einer entsprechenden Gerätedefinition. Es lauscht dabei auf generierte Events der Definition <code>global</code> via [[#X_Notify|Notify]]-Funktion. Der Nutzer kann dabei das Verhalten von autocreate durch entsprechende Parameter beeinflussen.<br />
<br />
Das Modul, für welches autocreate eine neue Definition anlegen möchte, kann das Verhalten durch entsprechende Parameter im Modul-Hash beeinflussen. Dabei gilt, dass gesetzte Attribute durch den Nutzer generell Vorrang haben. Die entsprechenden Parameter werden dabei im Rahmen der [[#X_Initialize|Initialize]]-Funktion im Modul-Hash gesetzt:<br />
<br />
<syntaxhighlight lang="perl"><br />
sub X_Initialize($)<br />
{<br />
my ($hash) = @_;<br />
<br />
...<br />
<br />
$hash->{AutoCreate} = {"X_.*" => { ATTR => "event-on-change-reading:.* event-min-interval:.*:300",<br />
FILTER => "%NAME",<br />
GPLOT => "temp4hum4:Temp/Hum,",<br />
autocreateThreshold => "2:140"<br />
}<br />
};<br />
<br />
}<br />
</syntaxhighlight><br />
<br />
Hierbei wird unterhalb von <code>$hash->{AutoCreate}</code> eine Liste angelegt, wo einem regulären Ausdruck für einen anzulegenden Definitionsnamen entsprechende Optionen zugeordnet werden. Sobald durch autocreate eine Gerätedefintion angelegt wird, auf den ein hier gelisteter Ausdruck matcht, so werden die zugeordneten Optionen berücksichtigt.<br />
<br />
Hier eine Auflistung aller möglichen Optionen und ihrer Bedeutung:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Optionsname !! Beispiel !! Bedeutung<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | <code>ATTR</code>|| style="vertical-align:top; white-space: nowrap;" | <code>"event-on-change-reading:.* event-min-interval:.*:300"</code> || Eine Auflistung von Attributen, die nach dem Anlegen einer Definition zusätzlich gesetzt werden. Es handelt sich hierbei um eine Leerzeichen-separierte Liste von Doppelpunkt-getrennten Tupels mit Attributname und -wert.<br />
<br />
Für das dargestellte Beispiel bedeutet dies, dass nach dem Anlegen der Definition folgende FHEM-Befehle zusätzlich ausgeführt werden:<br />
<br />
attr ''&lt;Name&gt;'' event-on-change-reading .*<br />
attr ''&lt;Name&gt;'' event-min-interval .*:300<br />
<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | <code>FILTER</code> || style="vertical-align:top; white-space: nowrap;" | <code>"%NAME"</code>|| Sofern in der autocreate-Definiton das Attribut <code>filelog</code> entsprechend durch den Nutzer gesetzt ist, wird eine zugehörige FileLog-Definition angelegt. Diese Option setzt den dabei benutzten Filter-Regexp, der beim Anlegen der FileLog-Definition gesetzt wird. <br />
<br />
Dabei werden folgende Platzhalter durch die entsprechenden Werte der neu angelegten Gerätedefinition ersetzt:<br />
<br />
* <code>%NAME</code> - wird ersetzt durch den Definitionsnamen<br />
* <code>%TYPE</code> - wird ersetzt durch den Modulnamen<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | <code>GPLOT</code> || style="vertical-align:top; white-space: nowrap;" | <code>"temp4hum4:Temp/Hum,"</code> || Sofern eine FileLog-Definition angelegt wurde, kann man weiterführend dazu eine passende SVG-Definition erzeugen um Daten aus dem erzeugten FileLog zu visualisieren. Ein typischer Fall sind hierbei Temperatursensoren, wo es sinnvoll sein kann, einen passenden SVG-Plot mit Temperatur/Luftfeuchtigkeit direkt anzulegen.<br />
<br />
Es handelt sich hierbei um eine kommaseparierte Auflistung von gplot-Dateinamen und optionalen Label-Texten durch einen Doppelpunkt getrennt. Im genannten Beispiel entspricht <code>temp4hum4</code> der zu verwendenden GnuPlot-Datei und <code>Temp/Hum</code> dem zu verwendenden Label ([[SVG]] Attribut <code>label</code>). Das Label wird auch durch FileLog verwendet als Link-Text zum entsprechenden SVG Plot. Alternativ kann auch nur die entsprechende GnuPlot-Datei anegeben werden ohne Label. Für jede angegebene GnuPlot-Datei wird anschließend eine entsprechende SVG-Definition erzeugt mit der vorher erzeugten FileLog-Definition als Datenquelle.<br />
<br />
Der gesamte Inhalt der <code>GPLOT</code>-Option wird beim Anlegen einer FileLog-Definition dem Attribut <code>logtype</code> als Wert plus dem Text <code>text</code> zugewiesen. Daher muss der Inhalt der Option <code>GPLOT</code> immer mit einem Komma enden. <br />
<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | <code>autocreateThreshold</code> || style="vertical-align:top; white-space: nowrap;"| <code>"2:10"</code> || Definiert, wie viele Aufrufe (im Bsp: <code>2</code>) von autocreate innerhalb welcher Zeit (im Bsp: <code>10</code> Sek.) stattfinden müssen, bevor die Gerätedefinition tatsächlich durch autocreate angelegt wird. Dadurch kann das ungewollte Anlegen von Geräten verhindert werden die tatsächlich nicht in Echt existieren. Aufgrund von Funkstörungen kann es durchaus zum ungewollten Anlegen einer Definition kommen. Diese Funktion lässt eine Definition erst zu wenn innerhalb einer vorgegeben Zeit eine Mindestzahl an Nachrichten eintrifft.<br />
<br />
Die erste Zahl stellt dabei die Mindestanzahl an Nachrichten dar. Die Zweite Zahl stellt die Zeit in Sekunden dar, in der die Mindestanzahl an Nachrichten erreicht werden muss um eine entsprechende Gerätedefinition anzulegen. <br />
<br />
Sofern diese Option nicht gesetzt ist, wird standardmäßig <code>2:60</code> verwendet.<br />
<br />
Diese Option kann durch den Anwender über das Attribut <code>autocreateThreshold</code> übersteuert werden.<br />
|-<br />
| style="vertical-align:top; white-space: nowrap;" | <code>noAutocreatedFilelog</code>|| style="vertical-align:top; white-space: nowrap;" | <code>1</code>|| Flag. Sofern gesetzt, wird keine FileLog- und ggf. SVG-Definition erzeugt. Selbst wenn der Nutzer durch entsprechende Attribute das Anlegen wünscht. Diese Option ist sinnvoll für Module bzw. Geräte die keine Readings erzeugen.<br />
|}<br />
<br />
== Ergänzende Hinweise ==<br />
Die Wahl der vorangestellten Nummer für den Dateinamen eines neuen Moduls hat keine Bedeutung mehr, es sei denn die Nummer ist 99. Module, die mit 99_ beginnen, werden von FHEM automatisch geladen. Module mit einer anderen Nummer nur wenn ein <code>define</code>-Befehl dafür sorgt, dass das Modul geladen wird.<br />
<br />
Wenn ein Modul Initialisierungsdaten benötigt, sollten diese im Modul selbst enthalten sein. Eine zusätzliche Datei oder sogar ein Unterverzeichnis mit mehreren Dateien ist bei FHEM nicht üblich und sollte bei Modulen, die mit FHEM ausgeliefert werden nur in Rücksprache mit Rudolf König angelegt werden, da sie sonst bei einem Update nicht verteilt werden.<br />
<br />
== Weitere Informationen ==<br />
Wenn man weitere Details wissen möchte, ist ein erster sinnvoller Schritt ein Blick in die Datei fhem.pl. Dort sieht man im Perl-Code wie die Module aufgerufen werden, was vorher passiert und was danach. Am Anfang der Datei (ca. ab Zeile 130) findet man beispielsweise eine Liste der globalen Variablen, die den Modulen zur Verfügung stehen sowie Details zu den wichtigen Hashes %modules und %defs. Wer mit Perl noch nicht so gut klar kommt, dem hilft eventuell ein Blick auf die Perldoc Website[http://perldoc.perl.org/] oder in das Perl-Buch seiner Wahl. Auch die FHEM {{Link2CmdRef}} sollte nicht unterschätzt werden. Es stehen oft mehr interessante Details auch für Modulentwickler darin als man zunächst vermuten könnte.<br />
<br />
<br />
== "Hello World" Beispiel ==<br />
<br />
98_Hello.pm<br />
<br />
<syntaxhighlight lang="perl"><br />
package main;<br />
use strict;<br />
use warnings;<br />
<br />
my %Hello_gets = (<br />
"whatyouwant" => "can't",<br />
"whatyouneed" => "try sometimes",<br />
"satisfaction" => "no"<br />
);<br />
<br />
sub Hello_Initialize($) {<br />
my ($hash) = @_;<br />
<br />
$hash->{DefFn} = 'Hello_Define';<br />
$hash->{UndefFn} = 'Hello_Undef';<br />
$hash->{SetFn} = 'Hello_Set';<br />
$hash->{GetFn} = 'Hello_Get';<br />
$hash->{AttrFn} = 'Hello_Attr';<br />
$hash->{ReadFn} = 'Hello_Read';<br />
<br />
$hash->{AttrList} =<br />
"formal:yes,no "<br />
. $readingFnAttributes;<br />
}<br />
<br />
sub Hello_Define($$) {<br />
my ($hash, $def) = @_;<br />
my @param = split('[ \t]+', $def);<br />
<br />
if(int(@param) < 3) {<br />
return "too few parameters: define <name> Hello <greet>";<br />
}<br />
<br />
my $hash->{name} = $param[0];<br />
my $hash->{greet} = $param[2];<br />
<br />
return undef;<br />
}<br />
<br />
sub Hello_Undef($$) {<br />
my ($hash, $arg) = @_; <br />
# nothing to do<br />
return undef;<br />
}<br />
<br />
sub Hello_Get($@) {<br />
my ($hash, @param) = @_;<br />
<br />
return '"get Hello" needs at least one argument' if (int(@param) < 2);<br />
<br />
my $name = shift @param;<br />
my $opt = shift @param;<br />
if(!$Hello_gets{$opt}) {<br />
my @cList = keys %Hello_gets;<br />
return "Unknown argument $opt, choose one of " . join(" ", @cList);<br />
}<br />
<br />
if($attr{$name}{formal} eq 'yes') {<br />
return $Hello_gets{$opt}.', sir';<br />
}<br />
return $Hello_gets{$opt};<br />
}<br />
<br />
sub Hello_Set($@) {<br />
my ($hash, @param) = @_;<br />
<br />
return '"set Hello" needs at least one argument' if (int(@param) < 2);<br />
<br />
my $name = shift @param;<br />
my $opt = shift @param;<br />
my $value = join("", @param);<br />
<br />
if(!defined($Hello_gets{$opt})) {<br />
my @cList = keys %Hello_gets;<br />
return "Unknown argument $opt, choose one of " . join(" ", @cList);<br />
}<br />
$hash->{STATE} = $Hello_gets{$opt} = $value;<br />
<br />
return "$opt set to $value. Try to get it.";<br />
}<br />
<br />
<br />
sub Hello_Attr(@) {<br />
my ($cmd,$name,$attr_name,$attr_value) = @_;<br />
if($cmd eq "set") {<br />
if($attr_name eq "formal") {<br />
if($attr_value !~ /^yes|no$/) {<br />
my $err = "Invalid argument $attr_value to $attr_name. Must be yes or no.";<br />
Log 3, "Hello: ".$err;<br />
return $err;<br />
}<br />
} else {<br />
return "Unknown attr $attr_name";<br />
}<br />
}<br />
return undef;<br />
}<br />
<br />
1;<br />
<br />
=pod<br />
=begin html<br />
<br />
<a name="Hello"></a><br />
<h3>Hello</h3><br />
<ul><br />
<i>Hello</i> implements the classical "Hello World" as a starting point for module development. <br />
You may want to copy 98_Hello.pm to start implementing a module of your very own. See <br />
<a href="http://wiki.fhem.de/wiki/DevelopmentModuleIntro">DevelopmentModuleIntro</a> for an <br />
in-depth instruction to your first module.<br />
<br><br><br />
<a name="Hellodefine"></a><br />
<b>Define</b><br />
<ul><br />
<code>define &lt;name&gt; Hello &lt;greet&gt;</code><br />
<br><br><br />
Example: <code>define HELLO Hello TurnUrRadioOn</code><br />
<br><br><br />
The "greet" parameter has no further meaning, it just demonstrates<br />
how to set a so called "Internal" value. See <a href="http://fhem.de/commandref.html#define">commandref#define</a> <br />
for more info about the define command.<br />
</ul><br />
<br><br />
<br />
<a name="Helloset"></a><br />
<b>Set</b><br><br />
<ul><br />
<code>set &lt;name&gt; &lt;option&gt; &lt;value&gt;</code><br />
<br><br><br />
You can <i>set</i> any value to any of the following options. They're just there to <br />
<i>get</i> them. See <a href="http://fhem.de/commandref.html#set">commandref#set</a> <br />
for more info about the set command.<br />
<br><br><br />
Options:<br />
<ul><br />
<li><i>satisfaction</i><br><br />
Defaults to "no"</li><br />
<li><i>whatyouwant</i><br><br />
Defaults to "can't"</li><br />
<li><i>whatyouneed</i><br><br />
Defaults to "try sometimes"</li><br />
</ul><br />
</ul><br />
<br><br />
<br />
<a name="Helloget"></a><br />
<b>Get</b><br><br />
<ul><br />
<code>get &lt;name&gt; &lt;option&gt;</code><br />
<br><br><br />
You can <i>get</i> the value of any of the options described in <br />
<a href="#Helloset">paragraph "Set" above</a>. See <br />
<a href="http://fhem.de/commandref.html#get">commandref#get</a> for more info about <br />
the get command.<br />
</ul><br />
<br><br />
<br />
<a name="Helloattr"></a><br />
<b>Attributes</b><br />
<ul><br />
<code>attr &lt;name&gt; &lt;attribute&gt; &lt;value&gt;</code><br />
<br><br><br />
See <a href="http://fhem.de/commandref.html#attr">commandref#attr</a> for more info about <br />
the attr command.<br />
<br><br><br />
Attributes:<br />
<ul><br />
<li><i>formal</i> no|yes<br><br />
When you set formal to "yes", all output of <i>get</i> will be in a<br />
more formal language. Default is "no".<br />
</li><br />
</ul><br />
</ul><br />
</ul><br />
<br />
=end html<br />
<br />
=cut<br />
</syntaxhighlight><br />
<br />
Der HTML-Code zwischen den Tags <code>=pod</code> und <code>=cut</code> dient zur Generierung der commandref.html. Der HTML-Inhalt wird automatisch beim Verteilen des Moduls im Rahmen des Update-Mechanismus aus jedem Modul extrahiert und daraus die Commandref in verschiedenen Sprachen erstellt. Eine detaillierte Beschreibung wie ein Commandref-Abschnitt in einem Modul definiert wird, siehe: [[Guidelines zur Dokumentation]]<br />
<br />
<br />
[[Kategorie:Development]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=ZoneMinder&diff=31399ZoneMinder2019-10-22T10:20:08Z<p>DelMar: </p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Integration mit Events und Kamerasteuerung der ZoneMinder API<br />
|ModType=d<br />
|ModFTopic=91847<br />
|ModTechName=70_ZoneMinder.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
[[ZoneMinder]] ist eine OpenSource Video-Überwachungssoftware. Das modulare Konzept ermöglicht die Integration von Kameras aller Art (IP, Analog, ...) und bietet Bewegungserkennung, verschiedene Aufnahmemodi und Alarmierung.<br />
Mehr Informationen zu Features findet man auf [https://zoneminder.com zoneminder.com], Informationen zur hier angebundenen API gibt es auf [https://zoneminder.readthedocs.io/en/stable/api.html zoneminder.readthedocs.io].<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
ZoneMinder bietet mehrere Arten der Integration, die einzeln in den Optionen aktiviert werden müssen. In der original Doku werden Kameras als Monitor bezeichnet.<br />
<br />
=== Abhängigkeiten ===<br />
Folgende Perl-Libs werden benötigt:<br />
<code>libcrypt-mysql-perl</code><br />
<br />
=== Alerting ===<br />
Wenn ZoneMinder Bewegungen erkennt, wird die jeweilige Kamera für bestimmte Zeit in den Alarm-Modus versetzt.<br />
Damit auch andere Anwendungen diesen Alarmzustand auswerten können, muss in den Optionen im Tab System die Option <code>OPT_TRIGGERS</code> aktiviert werden.<br />
Rein technisch öffnet ZoneMinder mit dieser Option den TCP-Port 6802, zu welchem sich FHEM verbindet und unmittelbar über neue Ereignisse informiert wird.<br />
Das [https://wiki.zoneminder.com/How_to_use_your_external_camera%27s_motion_detection_with_ZM ZoneMinder-Wiki] enthält detailierte Informationen dazu.<br />
<br />
=== Aufzeichnung und Bewegungserkennung ===<br />
Kameras in ZoneMinder kennen unterschiedliche Betriebsarten ([https://zoneminder.readthedocs.io/en/stable/userguide/definemonitor.html Quelle]):<br />
* '''None''' – Die Kamera ist deaktiviert. Streaming, Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Monitor''' – Die Kamera wird nur für Live-Streaming verwendet. Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Modect''' – steht für MOtion DEteCTtion. Sobald eine Bewegung erkannt wird, wird ein Event generiert und die Aufzeichnung gestartet.<br />
* '''Record''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Dieser Modus kennt keine Bewegungserkennung.<br />
* '''Mocord''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Bewegungen werden innerhalb der Aufnahme als Events markiert.<br />
* '''Nodect''' – steht für No DEteCTtion. Dieser Modus wurde für externe Trigger eingeführt. Es erfolgt keine Bewegungserkennung, die Aufzeichnung kann aber durch externe Trigger gestartet werden. Dies könnten eigene Bewegungsmelder sein, oder aber auch FHEM (Trigger an ZoneMinder zb über <code>set ZM_Monitor_xyz Alarm on|off|on-for-timer <sekunden></code>).<br />
Daneben kann pro Kamera die Bewegungserkennung auch noch explizit aktiviert und deaktiviert werden. Der Begriff Enabled/disabled kann hier irreführend sein, da nicht die Kamera als solche, sondern nur die Bewegungserkennung betroffen ist.<br />
Um eine Kamera zu deaktivieren, muss der Betriebsmodus auf None gestellt werden.<br />
<br />
== Einbindung in FHEM ==<br />
Das FHEM Modul kann in drei Ausbaustufen verwendet werden.<br />
=== Events und Alerting ===<br />
Mit folgender definition wird nur das weitergeben von Events nach ZM aktiviert:<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host><br />
</syntaxhighlight><br />
Beispiel<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder 192.168.1.1<br />
</syntaxhighlight><br />
Diese IP wird - wie oben beschrieben - verwendet, um den Event-Port von ZoneMinder zu öffnen.<br />
In den ZoneMinder Optionen muss hierfür ZM_TRIGGERS aktiv sein.<br />
<br />
=== ZoneMinder 1.32 und später ===<br />
Ab ZoneMinder 1.32 muss das folgende Attribut gesetzt sein, damit sich dieses FHEM-Modul an der ZoneMinder API anmelden kann.<br />
<syntaxhighlight lang="perl">attr zm apiVersion post132</syntaxhighlight><br />
<br />
=== ZoneMinder API ===<br />
Um Kamera-Modi in FHEM verändern und auslesen zu können, muss auf die ZoneMinder-API zugegriffen werden.<br />
Die Authentifizierung hierfür besteht (noch) aus ''username'' und ''password''.<br />
Aus Sicherheitsgründen bietet es sich evtl an, einen eigenen User für FHEM einzurichten, der nur die nötigen Rechte hat.<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host> <ZM-Username> <ZM-Password><br />
</syntaxhighlight><br />
<br />
Mit diesen Parametern kann außerdem direkt von ZoneMinder nach FHEM gestreamt werden und das Reading <code>streamUrl</code> wird verfügbar.<br />
Wichtig: diese Stream-URL enthält username und password als GET-Parameter. Diese sind also in der URL sichtbar, was tatsächlich ein Sicherheitsproblem darstellt.<br />
<br />
Damit die API verwendet werden kann, muss in den ZoneMinder Optionen <code>OPT_USE_API</code> aktiviert sein.<br />
<br />
=== Kameramodi setzen ===<br />
ZoneMinder selber kennt zwar unterschiedliche Aufzeichnungsmodi, kann diese aber nicht Zeit- oder Ereignisgesteuert verändern. FHEM füllt diese Lücke und kann die folgenden Kommandos an ZoneMinder senden:<br />
* '''alarmState''': Alert state in ZoneMinder setzen.<br />
* '''monitorFunction''': Entspricht 'Function' in ZoneMinder.<br />
* '''motionDetectionEnabled''': Entspricht 'Enabled' in ZoneMinder<br />
* '''text''': Setzt einen freien Text im Timestamp der Kamera. Der Timestamp der Kamera muss <code>%Q</code> enthalten und ZoneMinder muss uU neu gestartet werden, nachdem <code>%Q</code> hinzugefügt wurde.<br />
<br />
=== Public Streaming-URLs ===<br />
Hierfür muss als Attribut eine öffentlich erreichbare Adresse für ZoneMinder angegeben werden:<br />
<syntaxhighlight lang="perl"><br />
attr zm publicAddress https://my.home.server.net:8043<br />
</syntaxhighlight><br />
Damit wird in den ZM_Monitor Devices neben <code>streamUrl</code> auch noch ein Reading <code>pubStreamUrl</code> erzeugt.<br />
Für dieses Reading wird das eben angegebene Attribut mit dem Wert <code>PATH_ZMS</code> aus der ZoneMinder Konfiguration kombiniert.<br />
<br />
=== Auth Hash ===<br />
Um nicht username und Password öffentlich sichtbar machen zu müssen, bietet ZoneMinder auch das Sicherheitskonzept des Auth-Hash.<br />
Wenn FHEM erkennt, dass in ZoneMinder <code>AUTH_HASH_SECRET</code> und <code>AUTH_HASH_LOGINS</code> konfiguriert sind, wird der Auth-Hash errechnet. Für public streaming URLs wird dann automatisch der Auth-Hash anstatt Username und Passwort verwendet.<br />
Somit kann die URL auch nach außen gegeben werden.<br />
Wie vorher erwähnt, wird diese nach maximal zwei Stunden ungültig.<br />
Für den Login wird der Auth-Hash übrigens nicht akzeptiert, dh man kann maximal für zwei Stunden den Stream sehen, aber der Auth-Hash berechtigt nicht zum Verändern von Werten.<br />
Das FHEM-ZoneMinder Modul errechnet den Auth-Hash jede Stunde neu, somit sollten die Readings immer einen gültigen Hash liefern.<br />
<br />
Bitte beachten, dass das Einbeziehen der IP für den Auth-Hash derzeit nicht unterstützt wird.<br />
<br />
=== Link zur ZoneMinder Console ===<br />
Das ZoneMinder Device zeigt ganz oben einen Link zur ZoneMinder Console (dem Web UI) an.<br />
Ist <code>publicAddress</code> als Attribut definiert, wird dieser Link mit der publicAddress gebildet und sollte auch im Internet funktionieren.<br />
Wer will, kann so bequem von FHEM aus nach ZoneMinder wechseln.<br />
<br />
=== Live-Streams in FHEMWEB anzeigen ===<br />
Wer auf der Detailseite eines ZM_Monitor Devices auch gleich den Live-Stream sehen will, kann das Attribut <code>showLiveStreamInDetail</code> auf <code>1</code> setzen.<br />
<br />
== Installation des Moduls ==<br />
Das grunsätzliche Setup sollte hier ausreichend beschrieben sein. Seit Oktober 2018 ist das Modul offizieller Bestandteil von FHEM.<br />
Weitere Hintergrund-Infos finden sich außerdem noch [https://forum.fhem.de/index.php/topic,34570.msg828862.html#msg828862 im Forum].</div>DelMarhttp://wiki.fhem.de/w/index.php?title=ZoneMinder&diff=31398ZoneMinder2019-10-22T07:38:22Z<p>DelMar: /* ZoneMinder API */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Integration mit Events und Kamerasteuerung der ZoneMinder API<br />
|ModType=d<br />
|ModFTopic=91847<br />
|ModTechName=70_ZoneMinder.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
[[ZoneMinder]] ist eine OpenSource Video-Überwachungssoftware. Das modulare Konzept ermöglicht die Integration von Kameras aller Art (IP, Analog, ...) und bietet Bewegungserkennung, verschiedene Aufnahmemodi und Alarmierung.<br />
Mehr Informationen zu Features findet man auf [https://zoneminder.com zoneminder.com], Informationen zur hier angebundenen API gibt es auf [https://zoneminder.readthedocs.io/en/stable/api.html zoneminder.readthedocs.io].<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
ZoneMinder bietet mehrere Arten der Integration, die einzeln in den Optionen aktiviert werden müssen. In der original Doku werden Kameras als Monitor bezeichnet.<br />
<br />
=== Abhängigkeiten ===<br />
Folgende Perl-Libs werden benötigt:<br />
<code>libcrypt-mysql-perl</code><br />
<br />
=== Alerting ===<br />
Wenn ZoneMinder Bewegungen erkennt, wird die jeweilige Kamera für bestimmte Zeit in den Alarm-Modus versetzt.<br />
Damit auch andere Anwendungen diesen Alarmzustand auswerten können, muss in den Optionen im Tab System die Option OPT_TRIGGERS aktiviert werden.<br />
Rein technisch öffnet ZoneMinder mit dieser Option den TCP-Port 6802, zu welchem sich FHEM verbindet und unmittelbar über neue Ereignisse informiert wird.<br />
Das [https://wiki.zoneminder.com/How_to_use_your_external_camera%27s_motion_detection_with_ZM ZoneMinder-Wiki] enthält detailierte Informationen dazu.<br />
<br />
=== Aufzeichnung und Bewegungserkennung ===<br />
Kameras in ZoneMinder kennen unterschiedliche Betriebsarten ([https://zoneminder.readthedocs.io/en/stable/userguide/definemonitor.html Quelle]):<br />
* '''None''' – Die Kamera ist deaktiviert. Streaming, Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Monitor''' – Die Kamera wird nur für Live-Streaming verwendet. Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Modect''' – steht für MOtion DEteCTtion. Sobald eine Bewegung erkannt wird, wird ein Event generiert und die Aufzeichnung gestartet.<br />
* '''Record''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Dieser Modus kennt keine Bewegungserkennung.<br />
* '''Mocord''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Bewegungen werden innerhalb der Aufnahme als Events markiert.<br />
* '''Nodect''' – steht für No DEteCTtion. Dieser Modus wurde für externe Trigger eingeführt. Es erfolgt keine Bewegungserkennung, die Aufzeichnung kann aber durch externe Trigger gestartet werden. Dies könnten eigene Bewegungsmelder sein, oder aber auch FHEM (Trigger an ZoneMinder zb über <code>set ZM_Monitor_xyz Alarm on|off|on-for-timer <sekunden></code>).<br />
Daneben kann pro Kamera die Bewegungserkennung auch noch explizit aktiviert und deaktiviert werden. Der Begriff Enabled/disabled kann hier irreführend sein, da nicht die Kamera als solche, sondern nur die Bewegungserkennung betroffen ist.<br />
Um eine Kamera zu deaktivieren, muss der Betriebsmodus auf None gestellt werden.<br />
<br />
== Einbindung in FHEM ==<br />
Das FHEM Modul kann in drei Ausbaustufen verwendet werden.<br />
=== Events und Alerting ===<br />
Mit folgender definition wird nur das weitergeben von Events nach ZM aktiviert:<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host><br />
</syntaxhighlight><br />
Beispiel<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder 192.168.1.1<br />
</syntaxhighlight><br />
Diese IP wird - wie oben beschrieben - verwendet, um den Event-Port von ZoneMinder zu öffnen.<br />
In den ZoneMinder Optionen muss hierfür ZM_TRIGGERS aktiv sein.<br />
<br />
=== ZoneMinder 1.32 und später ===<br />
Ab ZoneMinder 1.32 muss das folgende Attribut gesetzt sein, damit sich dieses FHEM-Modul an der ZoneMinder API anmelden kann.<br />
<syntaxhighlight lang="perl">attr zm apiVersion post132</syntaxhighlight><br />
<br />
=== ZoneMinder API ===<br />
Um Kamera-Modi in FHEM verändern und auslesen zu können, muss auf die ZoneMinder-API zugegriffen werden.<br />
Die Authentifizierung hierfür besteht (noch) aus ''username'' und ''password''.<br />
Aus Sicherheitsgründen bietet es sich evtl an, einen eigenen User für FHEM einzurichten, der nur die nötigen Rechte hat.<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host> <ZM-Username> <ZM-Password><br />
</syntaxhighlight><br />
<br />
Mit diesen Parametern kann außerdem direkt von ZoneMinder nach FHEM gestreamt werden und das Reading <code>streamUrl</code> wird verfügbar.<br />
Wichtig: diese Stream-URL enthält username und password als GET-Parameter. Diese sind also in der URL sichtbar, was tatsächlich ein Sicherheitsproblem darstellt.<br />
<br />
Damit die API verwendet werden kann, muss in den ZoneMinder Optionen <code>OPT_USE_API</code> aktiviert sein.<br />
<br />
=== Kameramodi setzen ===<br />
ZoneMinder selber kennt zwar unterschiedliche Aufzeichnungsmodi, kann diese aber nicht Zeit- oder Ereignisgesteuert verändern. FHEM füllt diese Lücke und kann die folgenden Kommandos an ZoneMinder senden:<br />
* '''alarmState''': Alert state in ZoneMinder setzen.<br />
* '''monitorFunction''': Entspricht 'Function' in ZoneMinder.<br />
* '''motionDetectionEnabled''': Entspricht 'Enabled' in ZoneMinder<br />
* '''text''': Setzt einen freien Text im Timestamp der Kamera. Der Timestamp der Kamera muss <code>%Q</code> enthalten und ZoneMinder muss uU neu gestartet werden, nachdem <code>%Q</code> hinzugefügt wurde.<br />
<br />
=== Public Streaming-URLs ===<br />
Hierfür muss als Attribut eine öffentlich erreichbare Adresse für ZoneMinder angegeben werden:<br />
<syntaxhighlight lang="perl"><br />
attr zm publicAddress https://my.home.server.net:8043<br />
</syntaxhighlight><br />
Damit wird in den ZM_Monitor Devices neben <code>streamUrl</code> auch noch ein Reading <code>pubStreamUrl</code> erzeugt.<br />
Für dieses Reading wird das eben angegebene Attribut mit dem Wert <code>PATH_ZMS</code> aus der ZoneMinder Konfiguration kombiniert.<br />
<br />
=== Auth Hash ===<br />
Um nicht username und Password öffentlich sichtbar machen zu müssen, bietet ZoneMinder auch das Sicherheitskonzept des Auth-Hash.<br />
Wenn FHEM erkennt, dass in ZoneMinder <code>AUTH_HASH_SECRET</code> und <code>AUTH_HASH_LOGINS</code> konfiguriert sind, wird der Auth-Hash errechnet. Für public streaming URLs wird dann automatisch der Auth-Hash anstatt Username und Passwort verwendet.<br />
Somit kann die URL auch nach außen gegeben werden.<br />
Wie vorher erwähnt, wird diese nach maximal zwei Stunden ungültig.<br />
Für den Login wird der Auth-Hash übrigens nicht akzeptiert, dh man kann maximal für zwei Stunden den Stream sehen, aber der Auth-Hash berechtigt nicht zum Verändern von Werten.<br />
Das FHEM-ZoneMinder Modul errechnet den Auth-Hash jede Stunde neu, somit sollten die Readings immer einen gültigen Hash liefern.<br />
<br />
Bitte beachten, dass das Einbeziehen der IP für den Auth-Hash derzeit nicht unterstützt wird.<br />
<br />
=== Link zur ZoneMinder Console ===<br />
Das ZoneMinder Device zeigt ganz oben einen Link zur ZoneMinder Console (dem Web UI) an.<br />
Ist <code>publicAddress</code> als Attribut definiert, wird dieser Link mit der publicAddress gebildet und sollte auch im Internet funktionieren.<br />
Wer will, kann so bequem von FHEM aus nach ZoneMinder wechseln.<br />
<br />
=== Live-Streams in FHEMWEB anzeigen ===<br />
Wer auf der Detailseite eines ZM_Monitor Devices auch gleich den Live-Stream sehen will, kann das Attribut <code>showLiveStreamInDetail</code> auf <code>1</code> setzen.<br />
<br />
== Installation des Moduls ==<br />
Das grunsätzliche Setup sollte hier ausreichend beschrieben sein. Seit Oktober 2018 ist das Modul offizieller Bestandteil von FHEM.<br />
Weitere Hintergrund-Infos finden sich außerdem noch [https://forum.fhem.de/index.php/topic,34570.msg828862.html#msg828862 im Forum].</div>DelMarhttp://wiki.fhem.de/w/index.php?title=ZoneMinder&diff=31397ZoneMinder2019-10-22T07:32:17Z<p>DelMar: Hinweis auf "nur v1.30" entfernt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Integration mit Events und Kamerasteuerung der ZoneMinder API<br />
|ModType=d<br />
|ModFTopic=91847<br />
|ModTechName=70_ZoneMinder.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
[[ZoneMinder]] ist eine OpenSource Video-Überwachungssoftware. Das modulare Konzept ermöglicht die Integration von Kameras aller Art (IP, Analog, ...) und bietet Bewegungserkennung, verschiedene Aufnahmemodi und Alarmierung.<br />
Mehr Informationen zu Features findet man auf [https://zoneminder.com zoneminder.com], Informationen zur hier angebundenen API gibt es auf [https://zoneminder.readthedocs.io/en/stable/api.html zoneminder.readthedocs.io].<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
ZoneMinder bietet mehrere Arten der Integration, die einzeln in den Optionen aktiviert werden müssen. In der original Doku werden Kameras als Monitor bezeichnet.<br />
<br />
=== Abhängigkeiten ===<br />
Folgende Perl-Libs werden benötigt:<br />
<code>libcrypt-mysql-perl</code><br />
<br />
=== Alerting ===<br />
Wenn ZoneMinder Bewegungen erkennt, wird die jeweilige Kamera für bestimmte Zeit in den Alarm-Modus versetzt.<br />
Damit auch andere Anwendungen diesen Alarmzustand auswerten können, muss in den Optionen im Tab System die Option OPT_TRIGGERS aktiviert werden.<br />
Rein technisch öffnet ZoneMinder mit dieser Option den TCP-Port 6802, zu welchem sich FHEM verbindet und unmittelbar über neue Ereignisse informiert wird.<br />
Das [https://wiki.zoneminder.com/How_to_use_your_external_camera%27s_motion_detection_with_ZM ZoneMinder-Wiki] enthält detailierte Informationen dazu.<br />
<br />
=== Aufzeichnung und Bewegungserkennung ===<br />
Kameras in ZoneMinder kennen unterschiedliche Betriebsarten ([https://zoneminder.readthedocs.io/en/stable/userguide/definemonitor.html Quelle]):<br />
* '''None''' – Die Kamera ist deaktiviert. Streaming, Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Monitor''' – Die Kamera wird nur für Live-Streaming verwendet. Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Modect''' – steht für MOtion DEteCTtion. Sobald eine Bewegung erkannt wird, wird ein Event generiert und die Aufzeichnung gestartet.<br />
* '''Record''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Dieser Modus kennt keine Bewegungserkennung.<br />
* '''Mocord''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Bewegungen werden innerhalb der Aufnahme als Events markiert.<br />
* '''Nodect''' – steht für No DEteCTtion. Dieser Modus wurde für externe Trigger eingeführt. Es erfolgt keine Bewegungserkennung, die Aufzeichnung kann aber durch externe Trigger gestartet werden. Dies könnten eigene Bewegungsmelder sein, oder aber auch FHEM (Trigger an ZoneMinder zb über <code>set ZM_Monitor_xyz Alarm on|off|on-for-timer <sekunden></code>).<br />
Daneben kann pro Kamera die Bewegungserkennung auch noch explizit aktiviert und deaktiviert werden. Der Begriff Enabled/disabled kann hier irreführend sein, da nicht die Kamera als solche, sondern nur die Bewegungserkennung betroffen ist.<br />
Um eine Kamera zu deaktivieren, muss der Betriebsmodus auf None gestellt werden.<br />
<br />
== Einbindung in FHEM ==<br />
Das FHEM Modul kann in drei Ausbaustufen verwendet werden.<br />
=== Events und Alerting ===<br />
Mit folgender definition wird nur das weitergeben von Events nach ZM aktiviert:<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host><br />
</syntaxhighlight><br />
Beispiel<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder 192.168.1.1<br />
</syntaxhighlight><br />
Diese IP wird - wie oben beschrieben - verwendet, um den Event-Port von ZoneMinder zu öffnen.<br />
In den ZoneMinder Optionen muss hierfür ZM_TRIGGERS aktiv sein.<br />
<br />
=== ZoneMinder 1.32 und später ===<br />
Ab ZoneMinder 1.32 muss das folgende Attribut gesetzt sein, damit sich dieses FHEM-Modul an der ZoneMinder API anmelden kann.<br />
<syntaxhighlight lang="perl">attr zm apiVersion post132</syntaxhighlight><br />
<br />
=== ZoneMinder API ===<br />
Um Kamera-Modi in FHEM verändern und auslesen zu können, muss auf die ZoneMinder-API zugegriffen werden.<br />
Die Authentifizierung hierfür besteht (noch) aus ''username'' und ''password''.<br />
Aus Sicherheitsgründen bietet es sich evtl an, einen eigenen User für FHEM einzurichten, der nur die nötigen Rechte hat.<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host> <ZM-Username> <ZM-Password><br />
</syntaxhighlight><br />
Bitte beachten: Die ZoneMinder API wird derzeit nur für ZoneMinder 1.30.x unterstützt.<br />
<br />
Mit diesen Parametern kann außerdem direkt von ZoneMinder nach FHEM gestreamt werden und das Reading <code>streamUrl</code> wird verfügbar.<br />
Wichtig: diese Stream-URL enthält username und password als GET-Parameter. Diese sind also in der URL sichtbar, was tatsächlich ein Sicherheitsproblem darstellt.<br />
<br />
Damit die API verwendet werden kann, muss in den ZoneMinder Optionen <code>OPT_USE_API</code> aktiviert sein.<br />
<br />
=== Kameramodi setzen ===<br />
ZoneMinder selber kennt zwar unterschiedliche Aufzeichnungsmodi, kann diese aber nicht Zeit- oder Ereignisgesteuert verändern. FHEM füllt diese Lücke und kann die folgenden Kommandos an ZoneMinder senden:<br />
* '''alarmState''': Alert state in ZoneMinder setzen.<br />
* '''monitorFunction''': Entspricht 'Function' in ZoneMinder.<br />
* '''motionDetectionEnabled''': Entspricht 'Enabled' in ZoneMinder<br />
* '''text''': Setzt einen freien Text im Timestamp der Kamera. Der Timestamp der Kamera muss <code>%Q</code> enthalten und ZoneMinder muss uU neu gestartet werden, nachdem <code>%Q</code> hinzugefügt wurde.<br />
<br />
=== Public Streaming-URLs ===<br />
Hierfür muss als Attribut eine öffentlich erreichbare Adresse für ZoneMinder angegeben werden:<br />
<syntaxhighlight lang="perl"><br />
attr zm publicAddress https://my.home.server.net:8043<br />
</syntaxhighlight><br />
Damit wird in den ZM_Monitor Devices neben <code>streamUrl</code> auch noch ein Reading <code>pubStreamUrl</code> erzeugt.<br />
Für dieses Reading wird das eben angegebene Attribut mit dem Wert <code>PATH_ZMS</code> aus der ZoneMinder Konfiguration kombiniert.<br />
<br />
=== Auth Hash ===<br />
Um nicht username und Password öffentlich sichtbar machen zu müssen, bietet ZoneMinder auch das Sicherheitskonzept des Auth-Hash.<br />
Wenn FHEM erkennt, dass in ZoneMinder <code>AUTH_HASH_SECRET</code> und <code>AUTH_HASH_LOGINS</code> konfiguriert sind, wird der Auth-Hash errechnet. Für public streaming URLs wird dann automatisch der Auth-Hash anstatt Username und Passwort verwendet.<br />
Somit kann die URL auch nach außen gegeben werden.<br />
Wie vorher erwähnt, wird diese nach maximal zwei Stunden ungültig.<br />
Für den Login wird der Auth-Hash übrigens nicht akzeptiert, dh man kann maximal für zwei Stunden den Stream sehen, aber der Auth-Hash berechtigt nicht zum Verändern von Werten.<br />
Das FHEM-ZoneMinder Modul errechnet den Auth-Hash jede Stunde neu, somit sollten die Readings immer einen gültigen Hash liefern.<br />
<br />
Bitte beachten, dass das Einbeziehen der IP für den Auth-Hash derzeit nicht unterstützt wird.<br />
<br />
=== Link zur ZoneMinder Console ===<br />
Das ZoneMinder Device zeigt ganz oben einen Link zur ZoneMinder Console (dem Web UI) an.<br />
Ist <code>publicAddress</code> als Attribut definiert, wird dieser Link mit der publicAddress gebildet und sollte auch im Internet funktionieren.<br />
Wer will, kann so bequem von FHEM aus nach ZoneMinder wechseln.<br />
<br />
=== Live-Streams in FHEMWEB anzeigen ===<br />
Wer auf der Detailseite eines ZM_Monitor Devices auch gleich den Live-Stream sehen will, kann das Attribut <code>showLiveStreamInDetail</code> auf <code>1</code> setzen.<br />
<br />
== Installation des Moduls ==<br />
Das grunsätzliche Setup sollte hier ausreichend beschrieben sein. Seit Oktober 2018 ist das Modul offizieller Bestandteil von FHEM.<br />
Weitere Hintergrund-Infos finden sich außerdem noch [https://forum.fhem.de/index.php/topic,34570.msg828862.html#msg828862 im Forum].</div>DelMarhttp://wiki.fhem.de/w/index.php?title=ZoneMinder&diff=31354ZoneMinder2019-10-15T09:52:45Z<p>DelMar: v1.32</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Integration mit Events und Kamerasteuerung der ZoneMinder API<br />
|ModType=d<br />
|ModFTopic=91847<br />
|ModTechName=70_ZoneMinder.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
[[ZoneMinder]] ist eine OpenSource Video-Überwachungssoftware. Das modulare Konzept ermöglicht die Integration von Kameras aller Art (IP, Analog, ...) und bietet Bewegungserkennung, verschiedene Aufnahmemodi und Alarmierung.<br />
Mehr Informationen zu Features findet man auf [https://zoneminder.com zoneminder.com], Informationen zur hier angebundenen API gibt es auf [https://zoneminder.readthedocs.io/en/stable/api.html zoneminder.readthedocs.io].<br />
<br />
== Hinweise zum Betrieb mit FHEM ==<br />
ZoneMinder bietet mehrere Arten der Integration, die einzeln in den Optionen aktiviert werden müssen. In der original Doku werden Kameras als Monitor bezeichnet.<br />
<br />
=== Abhängigkeiten ===<br />
Folgende Perl-Libs werden benötigt:<br />
<code>libcrypt-mysql-perl</code><br />
<br />
=== Alerting ===<br />
Wenn ZoneMinder Bewegungen erkennt, wird die jeweilige Kamera für bestimmte Zeit in den Alarm-Modus versetzt.<br />
Damit auch andere Anwendungen diesen Alarmzustand auswerten können, muss in den Optionen im Tab System die Option OPT_TRIGGERS aktiviert werden.<br />
Rein technisch öffnet ZoneMinder mit dieser Option den TCP-Port 6802, zu welchem sich FHEM verbindet und unmittelbar über neue Ereignisse informiert wird.<br />
Das [https://wiki.zoneminder.com/How_to_use_your_external_camera%27s_motion_detection_with_ZM ZoneMinder-Wiki] enthält detailierte Informationen dazu.<br />
<br />
=== Aufzeichnung und Bewegungserkennung ===<br />
Kameras in ZoneMinder kennen unterschiedliche Betriebsarten ([https://zoneminder.readthedocs.io/en/stable/userguide/definemonitor.html Quelle]):<br />
* '''None''' – Die Kamera ist deaktiviert. Streaming, Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Monitor''' – Die Kamera wird nur für Live-Streaming verwendet. Bewegungserkennung, Aufzeichnung und Alerting sind nicht möglich.<br />
* '''Modect''' – steht für MOtion DEteCTtion. Sobald eine Bewegung erkannt wird, wird ein Event generiert und die Aufzeichnung gestartet.<br />
* '''Record''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Dieser Modus kennt keine Bewegungserkennung.<br />
* '''Mocord''' – Das Kamerabild wird kontinuierlich aufgezeichnet. Bewegungen werden innerhalb der Aufnahme als Events markiert.<br />
* '''Nodect''' – steht für No DEteCTtion. Dieser Modus wurde für externe Trigger eingeführt. Es erfolgt keine Bewegungserkennung, die Aufzeichnung kann aber durch externe Trigger gestartet werden. Dies könnten eigene Bewegungsmelder sein, oder aber auch FHEM (Trigger an ZoneMinder zb über <code>set ZM_Monitor_xyz Alarm on|off|on-for-timer <sekunden></code>).<br />
Daneben kann pro Kamera die Bewegungserkennung auch noch explizit aktiviert und deaktiviert werden. Der Begriff Enabled/disabled kann hier irreführend sein, da nicht die Kamera als solche, sondern nur die Bewegungserkennung betroffen ist.<br />
Um eine Kamera zu deaktivieren, muss der Betriebsmodus auf None gestellt werden.<br />
<br />
== Einbindung in FHEM ==<br />
Das FHEM Modul kann in drei Ausbaustufen verwendet werden.<br />
=== Events und Alerting ===<br />
Mit folgender definition wird nur das weitergeben von Events nach ZM aktiviert:<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host><br />
</syntaxhighlight><br />
Beispiel<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder 192.168.1.1<br />
</syntaxhighlight><br />
Diese IP wird - wie oben beschrieben - verwendet, um den Event-Port von ZoneMinder zu öffnen.<br />
In den ZoneMinder Optionen muss hierfür ZM_TRIGGERS aktiv sein.<br />
<br />
=== ZoneMinder 1.32 und später ===<br />
Ab ZoneMinder 1.32 muss das folgende Attribut gesetzt sein, damit sich dieses FHEM-Modul an der ZoneMinder API anmelden kann.<br />
<syntaxhighlight lang="perl">attr zm apiVersion post132</syntaxhighlight><br />
<br />
=== ZoneMinder API ===<br />
Um Kamera-Modi in FHEM verändern und auslesen zu können, muss auf die ZoneMinder-API zugegriffen werden.<br />
Die Authentifizierung hierfür besteht (noch) aus ''username'' und ''password''.<br />
Aus Sicherheitsgründen bietet es sich evtl an, einen eigenen User für FHEM einzurichten, der nur die nötigen Rechte hat.<br />
<syntaxhighlight lang="perl"><br />
define zm ZoneMinder <ZM-Host> <ZM-Username> <ZM-Password><br />
</syntaxhighlight><br />
Bitte beachten: Die ZoneMinder API wird derzeit nur für ZoneMinder 1.30.x unterstützt.<br />
<br />
Mit diesen Parametern kann außerdem direkt von ZoneMinder nach FHEM gestreamt werden und das Reading <code>streamUrl</code> wird verfügbar.<br />
Wichtig: diese Stream-URL enthält username und password als GET-Parameter. Diese sind also in der URL sichtbar, was tatsächlich ein Sicherheitsproblem darstellt.<br />
<br />
Damit die API verwendet werden kann, muss in den ZoneMinder Optionen <code>OPT_USE_API</code> aktiviert sein.<br />
<br />
=== Kameramodi setzen ===<br />
ZoneMinder selber kennt zwar unterschiedliche Aufzeichnungsmodi, kann diese aber nicht Zeit- oder Ereignisgesteuert verändern. FHEM füllt diese Lücke und kann die folgenden Kommandos an ZoneMinder senden:<br />
* '''alarmState''': Alert state in ZoneMinder setzen.<br />
* '''monitorFunction''': Entspricht 'Function' in ZoneMinder.<br />
* '''motionDetectionEnabled''': Entspricht 'Enabled' in ZoneMinder<br />
* '''text''': Setzt einen freien Text im Timestamp der Kamera. Der Timestamp der Kamera muss <code>%Q</code> enthalten und ZoneMinder muss uU neu gestartet werden, nachdem <code>%Q</code> hinzugefügt wurde.<br />
<br />
=== Public Streaming-URLs ===<br />
Hierfür muss als Attribut eine öffentlich erreichbare Adresse für ZoneMinder angegeben werden:<br />
<syntaxhighlight lang="perl"><br />
attr zm publicAddress https://my.home.server.net:8043<br />
</syntaxhighlight><br />
Damit wird in den ZM_Monitor Devices neben <code>streamUrl</code> auch noch ein Reading <code>pubStreamUrl</code> erzeugt.<br />
Für dieses Reading wird das eben angegebene Attribut mit dem Wert <code>PATH_ZMS</code> aus der ZoneMinder Konfiguration kombiniert.<br />
<br />
=== Auth Hash ===<br />
Um nicht username und Password öffentlich sichtbar machen zu müssen, bietet ZoneMinder auch das Sicherheitskonzept des Auth-Hash.<br />
Wenn FHEM erkennt, dass in ZoneMinder <code>AUTH_HASH_SECRET</code> und <code>AUTH_HASH_LOGINS</code> konfiguriert sind, wird der Auth-Hash errechnet. Für public streaming URLs wird dann automatisch der Auth-Hash anstatt Username und Passwort verwendet.<br />
Somit kann die URL auch nach außen gegeben werden.<br />
Wie vorher erwähnt, wird diese nach maximal zwei Stunden ungültig.<br />
Für den Login wird der Auth-Hash übrigens nicht akzeptiert, dh man kann maximal für zwei Stunden den Stream sehen, aber der Auth-Hash berechtigt nicht zum Verändern von Werten.<br />
Das FHEM-ZoneMinder Modul errechnet den Auth-Hash jede Stunde neu, somit sollten die Readings immer einen gültigen Hash liefern.<br />
<br />
Bitte beachten, dass das Einbeziehen der IP für den Auth-Hash derzeit nicht unterstützt wird.<br />
<br />
=== Link zur ZoneMinder Console ===<br />
Das ZoneMinder Device zeigt ganz oben einen Link zur ZoneMinder Console (dem Web UI) an.<br />
Ist <code>publicAddress</code> als Attribut definiert, wird dieser Link mit der publicAddress gebildet und sollte auch im Internet funktionieren.<br />
Wer will, kann so bequem von FHEM aus nach ZoneMinder wechseln.<br />
<br />
=== Live-Streams in FHEMWEB anzeigen ===<br />
Wer auf der Detailseite eines ZM_Monitor Devices auch gleich den Live-Stream sehen will, kann das Attribut <code>showLiveStreamInDetail</code> auf <code>1</code> setzen.<br />
<br />
== Installation des Moduls ==<br />
Das grunsätzliche Setup sollte hier ausreichend beschrieben sein. Seit Oktober 2018 ist das Modul offizieller Bestandteil von FHEM.<br />
Weitere Hintergrund-Infos finden sich außerdem noch [https://forum.fhem.de/index.php/topic,34570.msg828862.html#msg828862 im Forum].<br />
<br />
== Unterstützte ZoneMinder Version ==<br />
Derzeit wird von diesem Modul nur ZoneMinder 1.30.x unterstützt.<br />
Spätere Versionen arbeiten mit einem neuen API-Login Mechanismus, der bisher nicht erfolgreich getestet werden konnte.<br />
Das Triggern von Events über den Trigger-Port sollte aber auch mit späteren Versionen von ZoneMinder funktionieren.</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=31334CanOverEthernet2019-10-10T17:21:40Z<p>DelMar: Formatierung</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen der Firma Technische Alternative.<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit dem vorigen Schirm. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br/><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/826810/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<br />
<code><br />
define nfySendTemperatures notify UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};1 2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};1 3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};1 4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};1 5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};1 6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};1<br />
</code><br />
<br />
Danke an cobra112 aus dem Forum für dieses Beispiel (https://forum.fhem.de/index.php/topic,96170.msg982328.html#msg982328)<br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=31333CanOverEthernet2019-10-10T17:18:54Z<p>DelMar: Formatierung</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen der Firma Technische Alternative.<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit dem vorigen Schirm. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br/><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/826810/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<code><br />
UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 <br />
1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};1<br />
2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};1<br />
3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};1<br />
4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};1<br />
5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};1<br />
6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};1<br />
</code><br />
Danke an cobra112 aus dem Forum für dieses Beispiel (https://forum.fhem.de/index.php/topic,96170.msg982328.html#msg982328)<br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=31332CanOverEthernet2019-10-10T17:18:03Z<p>DelMar: Beispiel hinzugefügt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen der Firma Technische Alternative.<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit dem vorigen Schirm. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br/><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/826810/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Beispiele ==<br />
Senden von Werten aus FHEM an ein CMI. Wie vorher beschrieben, ist es wichtig, immer alle Werte zu senden. Würde ein Kanal leergelassen, würde der vorher gesendete Wert beim Empfänger mit 0 überschrieben werden.<br />
<code>UVR_Temperaturen:.* set cmi sendDataAnalog 10.0.0.1 20 1={(ReadingsVal("UVR_Temperaturen","Bad_Ist","99"))};1 2={(ReadingsVal("UVR_Temperaturen","Bad_Soll","99"))};1 3={(ReadingsVal("UVR_Temperaturen","Dach_Ist","99"))};1 4={(ReadingsVal("UVR_Temperaturen","Dach_Soll","99"))};1 5={(ReadingsVal("UVR_Temperaturen","Haus_Ist","99"))};1 6={(ReadingsVal("UVR_Temperaturen","Haus_Soll","99"))};1</code><br />
Danke an cobra112 aus dem Forum für dieses Beispiel (https://forum.fhem.de/index.php/topic,96170.msg982328.html#msg982328)<br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=31331CanOverEthernet2019-10-10T17:13:59Z<p>DelMar: Screenshots eingefügt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen der Firma Technische Alternative.<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit dem vorigen Schirm. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br/><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 3 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>3</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/826810/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
Im Screenshot wurde also an die IP des CMI ein Wert geschickt. Als Empfänger wurde Knoten 3 angegeben. In Position 1 wird der Wert von Kanal 1 gespeichert.<br />
<br />
[[Datei:CAN Analogeingänge.png|mini|zentriert]]<br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=Datei:CAN_Analogeing%C3%A4nge.png&diff=31330Datei:CAN Analogeingänge.png2019-10-10T17:13:47Z<p>DelMar: </p>
<hr />
<div>Empfangene Werte werden hier angezeigt</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=31329CanOverEthernet2019-10-10T17:11:05Z<p>DelMar: </p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen der Firma Technische Alternative.<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit dem vorigen Schirm. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br/><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 5 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>5</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/826810/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt.<br />
<br />
Am CMI selber ist keine Konfiguration nötig, es leitet eingehende Übertragungen einfach an alle CAN-Knoten weiter. Sobald ein Knoten (also zB die UVR) einen Wert richtig konfiguriert hat, ist dieser Verfügbar:<br />
[[Datei:CAN-Analogeingang.png|mini|zentriert]]<br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=Datei:CAN-Analogeingang.png&diff=31328Datei:CAN-Analogeingang.png2019-10-10T17:10:52Z<p>DelMar: </p>
<hr />
<div>Ist der CAN-Analogeingang konfiguriert, werden die Werte automatisch angezeigt</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=31327CanOverEthernet2019-10-10T17:07:57Z<p>DelMar: senden von Daten ergänzt</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen der Firma Technische Alternative.<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit dem vorigen Schirm. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
=== Empfangen von Daten ===<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfigAnalog</code> und <code>readingsConfigDigital</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfigAnalog 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br/><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt. Das Format für <code>readingsConfigDigital</code> ist genau gleich.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
=== Senden von Daten ===<br />
Im CanOverEthernet Device können Werte and COE-Empfänger gesendet werden. Das kann zB eine UVR sein, aber auch eine andere FHEM Instanz, die für den Empfang per CanOverEthernet konfiguriert ist.<br><br />
Das Senden von analogen Daten funktioniert so:<br><br />
<code>set cmi sendDataAnalog 10.0.0.1 5 1=22.7;1 2=5.00;13 3=38;0</code><br />
<code>10.0.0.1</code> bezeichnet die IP des Empfängers. Der Port 5441 muss erreichbar sein.<br><br />
<code>5</code> bezeichnet die CAN-Knoten-ID.<br />
<code>1=22.7;1</code> bedeutet, dass auf Kanal 1 der Wert 22.7 gesendet wird. Semicolon 1 gibt an, dass es sich um eine Temperatur handelt. Die Typen sind in der Doku gelistet: https://www.ta.co.at/download/datei/826810/<br />
<br />
Digitale Daten werden ähnlich verschickt. Der einzige Unterschied ist, dass der Typ nicht nötig ist und (natürlich) als Werte nur <code>0</code> und <code>1</code> erlaubt sind. <br />
<br />
Wichtig: CanOverEthernet sendet immer mehrere Werte gleichzeitig übers Netzwerk.<br><br />
Wenn also zB auf Basis eines Notify erst ein Wert auf Kanal 1 und dann ein anderer Wert auf Kanal 2 verschickt wird, dann wird der jeweils andere Wert wieder mit 0 überschrieben. Deshalb ist es wichtig, immer alle Kanäle mit Werten zu befüllen, selbst wenn es keine Änderung gegeben hat.<br />
<br />
Analoge Werte werden in Paketen von 4 verschickt. Dh die Kanäle 1-4, 5-8, 9-12, 13-16, 17-20, 21-24, 25-28, 29-32 werden jeweils gemeinsam versendet.<br />
Digitale Werte werden alle innerhalb eines Paketes verschickt. <br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]</div>DelMarhttp://wiki.fhem.de/w/index.php?title=CanOverEthernet&diff=31272CanOverEthernet2019-09-24T18:07:54Z<p>DelMar: /* Alternative zu diesem Modul */</p>
<hr />
<div>{{Infobox Modul<br />
|ModPurpose=Empfangen von Daten über Push-Nachricht über das CMI der Firma Technische Alternative<br />
|ModType=d<br />
|ModFTopic=96170<br />
|ModTechName=70_CanOverEthernet.pm, 71_COE_Node.pm<br />
|ModOwner=DelMar<br />
}}<br />
<br />
Dieses FHEM-Modul horcht auf Port 5441 nach UDP-Nachrichten, die dem Can-Over-Ethernet Protokoll folgen. Maßgebend für die Entwicklung des Moduls war die Einbindung in Steuerungen der Firma Technische Alternative.<br />
<br />
== Konfigurieren der Steuerung (am Beispiel UVR16x2) ==<br />
Steuerungen, wie die UVR16x2 oder die UVR1611 haben selber keine Ethernet Anbindung, sondern können nur über CAN-Bus Daten austauschen.<br />
Das CMI stellt das fehlende Bindeglied zwischen einer Steuerung und FHEM dar, da es CAN-Bus und Ethernet unter einen Hut bringt.<br />
<br />
Die erstmalige Konfiguration, um Werte per CAN-Bus zu exportieren, kann sehr verwirrend sein.<br />
Grundsätzlich geht ein Wert aus dem Sensor folgenden Weg:<br><br />
<code>Sensor -> CAN-Bus -> CanOverEthernet -> Empfänger (zB FHEM)</code><br><br />
Speziell die Unterscheidung zwischen CAN-Bus und CAN-Over-Ethernet ist sehr wichtig, um alles zu verstehen.<br />
<br />
Um diesen Weg abzubilden, sind folgende Schritte nötig:<br><br />
# Echter Sensor: '''an der Steuerung''' wird der Wert eines echten Sensors einem CAN-Analogausgang zugewiesen.<br />
# CAN-Analogwert: '''Am CMI''' wird der CAN-Analogeingang konfiguriert, damit das CMI weiß, um welchen Wert es sich hier handelt.<br />
# CanOverEthernet: '''Am CMI''' wird der CanOverEthernet-Ausgang so konfiguriert, dass er den Wert aus dem CAN-Eingang ins Ethernet pusht.<br />
<br />
Die folgenden Screenshots zeigen diese drei Schritte im Detail:<br><br />
Als erstes muss man sich unter "Benutzer" entweder als Fachmann oder Experte anmelden. Das Passwort für den Experten sollte man von grundsätzlich bei der Einrichtung der Heizung erhalten haben. Sonst dort nachfragen, wo man die Steuerung gekauft hat.<br />
<br />
[[Datei:CMI Menü 1.jpg|zentriert|mini]]<br />
<br />
Dann muss <code>CAN-Bus</code> ausgewählt werden.<br />
In diesem Menü sind zwei Punkte wichtig:<br />
* CAN-Einstellungen<br />
* CAN-Analogausgänge<br />
<br />
In '''CAN-Einstellungen''' notieren wir uns den Wert, der unter "Knoten" dargestellt wird. Bei mir ist das zB <code>1</code>.<br />
<br />
Danach gehen wir ins Menü '''CAN-Analogausgänge''', oder '''CAN-Digitalausgänge'''. Je nachdem.<br />
[[Datei:CMI Menü 2.1.jpg|zentriert|mini]]<br />
Auf diesem Bildschirm wählt man einen unbenutzten Ausgang. Wenn man als Experte angemeldet ist, kommt man zum folgenden Bildschirm.<br />
<br />
[[Datei:CMI Menü 2.2.jpg.jpg|zentriert|mini]]<br />
Die erste Auswahl bezeichnet, woher der "echte" Sensorwert kommt. In diesem Beispiel ist es ein herkömmlicher "Eingang" der Steuerung.<br><br />
In der zweiten Auswahl wählt man den Eingang, dessen Wert man verwenden möchte.<br><br />
In der dritten Auswahl legt man fest, um welche Art von Wert es sich hierbei handelt. Die Bezeichnungen sollten eigentlich Sprechend sein.<br><br />
In der vierten Auswahl legt man fest, welcher Messwert das ist. Wofür diese Information verwendet wird, weiß ich auch nicht.<br><br />
Die fünfte Auswahl bietet vordefinierte Bezeichnungen an, unter welcher dieser Wert dann in der Liste "CAN-Analogausgang" geführt wird.<br><br />
<br />
Die darunter liegenden '''Sendebedingungen''' erlauben noch, festzulegen, wie oft eine Aktualisierung gesendet werden soll. Ja, jeder möchte hier natürlich Echtzeit-Werte haben, es lohnt aber trotzdem, sich sinnvolle Werte zu überlegen.<br />
<br />
'''Was haben wir bis hier erreicht?''' Der Wert aus einem analogen Sensor wird in den konfigurierten Intervallen in den CAN-Bus geschrieben. Der CAN-Bus ist noch nicht Ethernet, und für dieses FHEM-Modul noch nicht verwendbar. Nun kommt das CMI ins Spiel.<br />
<br />
== Konfigurieren des CMI ==<br />
<br />
[[Datei:CMI Menü Eingänge.jpg|zentriert|mini]]<br />
Das CMI ist mit der Steuerung per CAN-Bus verbunden. Seine Aufgabe ist, den Wert vom CAN-Bus zu lesen. Da das CAN-Bus Protokoll ausschließlich Werte und Datentypen überträgt, müssen wir im CMI erst konfigurieren, welcher Wert das denn überhaupt ist, der über den CAN-Bus hereinkommt.<br />
<br />
Dazu wechseln wir ins Web-Interface des CMI und klicken in der Navigation oben auf "Einstellungen" und dann links auf "Eingänge", wie im Screenshot zu sehen.<br />
Hier wählen wir "CAN-Bus" und "Analog" aus, da wir ja im Interface der Steuerung einen CAN-Analogausgang konfiguriert haben.<br />
<br />
Folgende Parameter sind nötig:<br />
# Knotennummer: diese haben wir zu Beginn im Menü CAN-Einstellungen rausgefunden.<br />
# Netzwerkausgang: das ist die Nummer in der Liste, unter welcher wir den CAN-Analogausgang konfiguriert haben.<br />
Die restlichen Werte sind für die Einrichtung an dieser Stelle nicht relevant und können in der Doku nachgelesen werden.<br />
<br />
'''Was haben wir bis hier erreicht?''' Das CMI liest die hier konfigurierten Werte vom CAN-Bus und sie stehen damit für weitere Zwecke zur Verfügung. Wie zum Beispiel in unserem Fall, den Wert per CanOverEthernet ins LAN zu senden. Wir sind beinahe am Ziel, nur ein Schritt ist noch nötig.<br />
<br />
[[Datei:CMI Menü Ausgänge.jpg|zentriert|mini]]<br />
Ebenfalls im Menü "Einstellungen" klicken wir nun links auf "Ausgänge" und daraufhin findet sich '''endlich''' der Begriff "CoE" in der Liste. Wir wählen hier wiederum "Analog" aus und klicken den ersten leeren Eintrag. Es folgt eine kurze Beschreibung der Parameter:<br />
# Beschreibung: hier können wir eine Freitext Beschreibung angeben, wie auch zuvor dem Wert am analogen CAN-Eingang.<br />
# Eingang: CAN-Bus<br />
# darunter: hier muss sich nun der Wert finden, den wir im vorigen Schritt als analogen CAN-Bus Eingang konfiguriert haben.<br />
# darunter: in diesem Beispiel steht hier "Messwert" und es gibt auch keine Alternativen. Der Wert wird wohl von der Konfiguration in der Steuerung übernommen.<br />
# IP: an diese IP-Adresse werden die CanOverEthernet UDP-Datenpakete gesendet. Kurz: die IP von FHEM<br />
# Knoten: FHEM legt für jeden Knoten ein COE_Node Device an. Egal, welcher Wert hier verwendet wird, es macht Sinn, zusammengehörige Werte an die selbe Knotennummer zu schicken.<br />
# Netzwerkausgang: sozusagen der Index des Wertes. Er wird im FHEM-Modul verwendet, um den Wert einem Reading zuzuweisen.<br />
Die '''Sendebedingung''' ist vergleichbar mit dem vorigen Schirm. Genauere Infos dazu finden sich wiederum in der Dokumentation des CMI.<br><br />
'''Aktueller Wert''' zeigt an, was es verspricht. Das ist der finale Beweis, ob man bis hierher alles richtig gemacht hat.<br />
<br />
Soweit, so gut. Die Konfiguration der Steuerung und des CMI ist soweit abgeschlossen. Nun fehlt nur noch, die Werte in FHEM als Readings zu hinterlegen.<br />
<br />
== Konfigurieren von FHEM ==<br />
Das hier beschriebene FHEM-Modul macht es FHEM möglich, die CanOverEthernet UDP-Datenpakete auszulesen und in Readings zu schreiben.<br><br />
Die Definition ist so einfach, wie nur irgendwie möglich:<br><br />
<code>defmod cmi CanOverEthernet</code><br />
Daraufhin horcht FHEM auf dem UDP-Port 5441. Sobald Werte ankommen, wird pro vorher definiertem Knoten ein eigenes Device von Typ COE_Node angelegt und im Raum "COE_Node" abgelegt.<br />
<br />
Sobald dieses Device existiert, müssen nun dort ein letztes Mal die Werte konfiguriert werden, damit sie richtig zu Readings zugeordnet werden können.<br><br />
Das macht man über das Attribut <code>readingsConfig</code>.<br />
Beispiel:<br><br />
<code>attr COE_Node_cmi_2 readingsConfig 1=T.Kollektor 2=T.Solar_VL 3=T.Aussen</code><br/><br />
Das Format ist immer <code>Index=Readingname</code>. Mehrere Readings werden durch Leerzeichen getrennt. Wenn etwas schiefgeht, prüfen, ob nicht eventuell ein Leerzeichen im Namen des Readings vorkommt.<br />
<br />
Wenn alles gut gegangen ist, sollte man automatisch Readings in der folgenden Form vorfinden:<br />
[[Datei:Readings.jpg|mini|zentriert]]<br />
<br />
== Alternative zu diesem Modul ==<br />
Das CMI bietet auch eine JSON-API, mit der viele Werte abgerufen werden können. Die Abfrage per API ist zwar einfacher als mit diesem Modul, die Auswahl an Werten aber beschränkter und auf einmal pro Minute beschränkt. Informationen dazu gibt es hier [[TA_CMI_UVR16x2_UVR1611]]</div>DelMar