HMinfo: Unterschied zwischen den Versionen
(→verify) |
K (→Definition) |
||
| Zeile 6: | Zeile 6: | ||
Danach können alle Funktionen aufgelistet werden mit | Danach können alle Funktionen aufgelistet werden mit | ||
:<code> | :<code>get HM help</code> | ||
== Integritätsprüfungen == | == Integritätsprüfungen == | ||
Version vom 14. April 2014, 18:43 Uhr
HMInfo ist ein Modul, das alle HomeMatic repräsentiert. Es bietet Funktionen zur Übersicht, Kontrolle, Archivierung und, begrenzt, zur Programmierung der Homematic Komponenten. Somit soll es eine Hilfestellung bei Konfiguration und Fehlerbehandlung geben.
Definition
HMInfo wird erstellt / angelegt mit dem Befehl
define HM HMinfo
Danach können alle Funktionen aufgelistet werden mit
get HM help
Integritätsprüfungen
Befehle, um die Gültigkeit von verschiedenen HomeMatic Eigenschaften zu überprüfen:
| Erläuterungen | Definition |
|---|---|
| Überprüfen, ob alle peerings auch beidseitig sind: | set HM peerCheck
|
| Überprüfen, ob alle register korrekt gelesen wurden: | set HM regCheck
|
| Kombination von peerCheck und regCheck | set HM configCheck
|
Anzeigen zur Übertragungssituation
RSSI
get HM rssi [<filter>]
Erzeugt eine Tabelle aller RSSI Werte.
set hm clear [<filter>] rssi
setzt die RSSI Werte aller devices gemäß filter zurück. Eine neue Messung kann beginnen
protoEvents
getHM protoEvents [<filter>][short|long]
Es wird eine Tabelle mit allen wichtigen Ereignissen zur Datenübertragung erzeugt. Dies beinhaltet Wiederholungen sowie Übertragungsfehler. short ist eine Fassung ohne Zeitstempel und lässt sich besser am Bildschirm darstellen. Ausserdem kann man sehen, welche Abfragen noch in der queue sind, z.B. durch autoReadReg erzeugt. Die Zustände aller für HM zuständigen IOs sind beinhaltet. Alles in allen ist hier ein kompletter Überblick zur Kommunikation zu sehen. Insbesondere bei
set hm clear [<filter>] Protocol
setzt die Protokol Einträge aller gemäß filter zurück. Kann gut vor einer Konfigurations-aktion genutzt werden um hinterher zu kontrollieren, ob Fehler aufgetreten sind.
msgStat
set hm msgStat
Statistic der Übertragenen Messages insgesamt. Es gibt eine Tabelle über die letzten 24h und eine über die letzte Woche.
Speichern von Konfigurationen
HMInfo speichert Konfigurationen der Geräte in Files. Mit dem Attribut configDir kann man eine directory festlegen, in die alles geschrieben wird.
saveConfig
Peers und Register werden in ein file geschrieben. Die Daten kann man ggf. wieder in ein gerät oder ein Austauschgerät schreiben. Die Speicherung erfolgt kumulativ, man kann alles in ein File schreiben.
set HM saveConfig [<filter>] [<file>]
archConfig
Arbeiter prinzipiell wie saveConfig. Es werden jedoch nur vollständige Registersätze gespeichert.
set HM archConfig [-a] [<file>]
Mit dem Attribut autoArchive kann man einstellen, dass automatisch nach einem erfolgreichen Lesen einer Device-Konfiguration diese Archiviert wird. Das Speichern erfolgt auch hier Kumulativ, jedoch wird ab einer Filegröße von 1MB gepurged, also alles bis auf den neusten Eintrag für eine Entity gelöscht.
Will man eine bekannt gute Konfiguration sicherm, muss man sich ggf. eine Kopie des Archivs machen - dies wird bei nächster Gelegenheit überschrieben.
Template erstellen:
set HM saveConfig -f ^meinDevice$ <myTempalteFile>
loadConfig
set hm loadConfig [<filter>] [<filename>]
Liest die Registerwerte, welche für eine Entity in einem File gespeichert sind, zurück in die Readings. Sollten die Register schon in FHEM vorhanden sein, wird nicht überschrieben. Sinn macht dies beispielsweise für remotes, welche nicht automatisch gelesen werden sollen. Man kann somit nach einem system-reboot die Register "rekonstruieren" und wieder darstellen. Es liegt im ermessen des User, eine bekannt aktuelle Version der Register einzulesen.
purgeConfig
set hm purgeConfig [<filename>]
Löscht alle älteren Datensätze in einem File.
Konfigurationen bearbeiten
Templates
HMInfo erlaubt das Erstellen und Nutzen von Tempaltes. Das sind Schablonen, die das Setzen von Registern abstrahieren und auf eine höhere Ebene heben. So kann man das Setzen der Konfiguration eines Aktors beispielsweise um mit einem Bewegungsmelder zusammen zu arbeiten in einem Kommando zusammenfassen. Faktisch setzt das Template also eine Gruppe von Registern auf ein mal.
templateList
Die vorhandenen templates kann man mit templateList sehen.
get hm templateList SwOnCond params:level cond Info:switch: execute only if condition [geLo|ltLo] level is below limit SwToggle params: Info:Switch: toggle on trigger autoOff params:time Info:staircase - auto off after
Die Liste der verfügbaren Tempaltes, deren Parameter falls nötig und eine kurze Info, was das Template bewirken soll
get hm templateList autoOff
autoOff params:time Info:staircase - auto off after
Ein templaetList auf ein einzelnes Template zeigt die Details, was das Template verändern wird.
templateSet
Um ein Template auf einen Aktor anzuwenden muss man neben den spezifischen Parametern angeben, für welchen Peer es gelten soll und ob es bei einem kurzen oder langen Tastendruck angewendet werden soll.
set hm templateSet <entity> <templateName> <peer:[long|short]> [<param1> ...] set hm templateSet Licht1 autoOff FB1_Btn2:short 10 set hm templateSet Licht1 SwOn FB1_Btn2:long
Licht1 soll, wenn ein kurzer Trigger von FB1_Btn2 kommt für 10 sec eingeschaltet werden, dann aus gehen (Treppenhausfunktion). Kommt aber ein langer Tastendruck wird das Licht dauerhaft eingeschaltet.
set hm templateSet Licht1 motionOnSw MD1:short 30 20
Der Switch Aktor Licht1 soll mit einem Bewegungsmelder betrieben werden. Der Bewegungsmelder sendet keine 'langen' Trigger sondern nur kurze. Im Beispiel wird Licht1 für 30 Sekunden angeschaltet, wenn der Bewegungsmelder einen Trigger sendet UND es dunkler ist als "20" (Brightness level).
templateDef
Neben den vorbereiteten Templates kann der User eigene definieren oder von anderen Usern sich Templates geben lassen. Die Definition von Templates ist für erfahrene User gedacht, um gegensatz zur Nutzung eines Templates mit set - das ist für Anfänger gedacht.
set hm templateDef <templateName> <param1[:<param2>...] <description> <reg1>:<val1> [<reg2>:<val2>] ... set hm templateDef myTemplate anzeit:auszeit "licht schaltet ständig an und aus" OnTime:anzeit OffTime:auszeit OnDly:0
mit diesem Template wird die Anzeit und die Auszeit eines Schalt-Aktors auf den vom User gewünschten Wert gesetzt. Die Verzögerung OnDly wird auf 0 gesetzt.
templateChk
Man kann prüfen, ob ein Aktor/Peer gemäss einem tempalte programmiert ist.
get hm templateChk [<filter>] <templateName> <peer:[long|short]> [<param1> ...] get hm templateChk -f Rollo RolloHoch self01 5
Es wird geprüft für alle HM-Komponenten, die "Rollo" im Namen haben (siehe Filter) dem (hoffentlich vorhandenen) template "RolloHoch" verglichen. Geprüft wird nur der Peer "self01", aber für long UND short.
get hm templateChk -f Rollo RolloHoch self01:sort 5
das selbe, aber nur für short Einträge
Temperaturlisten
HMInfo bietet verschiedenen Methoden, Temperaturlisten für Thermostate (TC oder RT) zu verwalten und zu nutzen. Prinzip ist, dass die Temperaturlisten in einem Konfigurationsfile Abgelegt werden. Der Filename ist frei wählbar - der Default ist tempList.cfg. Für alle Kommandos können die Filter genutzt werden. Voraussetzung für die Kommandos ist, dass die Daten aus dem Device gelesen wurden - die in FHEM vorhandenen Daten werden als korrekt angenommen. Siehe auch autoReagReg Attribut der HM Komponenten.
speichern
set hm tempList save <filename>
Die in FHEM vorhandenen Temperaturlisten aller devices (hier ist kein Filter gesetzt also alle) in das File <filename> geschrieben. Man kann dieses als Basis nehmen um seine Temperaturlisten zu bearbeiten.
prüfen
set hm tempList verify <filename>
HMInfo vergleicht die im File abgelegten Temperaturlisten mit denen, in FHEM vorliegenden. Unterschieden werden gemeldet. Es wird nichts in das Device geschrieben oder verändert
restore
set hm tempList restore <filename>
Es werden alle temperaturlisten aus dem File in die dafür eingerichteten Komponenten eingetragen. Dabei werden ausschließlich die Änderungen geschrieben. Liegen keine Unterschieden zwischen File in Daten vor, wird auch nichts geschrieben. Ein mehrfaches anwendend des Kommandos ist also keine Belastung des Systems. Will man das Schreiben ungeachtet der vorhandenen Daten erzwingen sollte man mit "clear Register" die in FHEM vorhandenen Einträge löschen und dann ein tempList restore ausführen.
Aufbau Tempfile
Zu erstmaligen Erstellen eines Files nutzt man am Einfachsten das Kommando tempList save.
entities:HK1,HK2 R_0_tempListSat>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0 R_1_tempListSun>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0 R_2_tempListMon>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 R_3_tempListTue>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0 R_4_tempListWed>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 R_5_tempListThu>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 R_6_tempListFri>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 entities:HK3 R_0_tempListSat>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0 R_1_tempListSun>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0 R_2_tempListMon>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 R_3_tempListTue>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0 R_4_tempListWed>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 R_5_tempListThu>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 R_6_tempListFri>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0
Die Zeile entities legt fest, für welche Komponenten die nachfolgende Liste gültig sein soll. Die Erste ist also gültig für HK1 und HK2, die Zweite für HK3. Will man identisch Listen für mehrere Komponenten nutzen, schreibt man deren Namen einfach in die liste der Entities. Zu Beachten ist, das nach ändern der Liste ein erneutes templistSave auf den gleichen Filenamen die Daten verändern kann. Es könnte daher ratsam sein, den Filenamen einer manuell bearbeiteten Konfiguration nicht beim Default zu belassen.
tempList Templates
User möchten möglicherweise die Temperaturlisten einer Komponente über das Jahr verändern (sommer und Winterprofil). Dazu kann man Templates festlegen. Das ganze funktioniert wie das Kommando tempList mit dem Unterschied, dass der Namen des Templates angegeben werden kann. Im File wird der Name des Templates in der Zeile Entities eingegeben, identisch wir der Name einer Komponente.
set hm tempListTmpl -f hkWZ wzSommer restore tempListFile.cfg
Allen Thermostate mit hkWZ im Namen wird die Templiste, die im File tempListFile.cfg unter entity "wzSommer" abgelegt ist überschrieben. Wie bei tempList restore wird auch hier nur geschrieben, wenn ein Unterschied erkannt wird.
Registersätze kopieren
HMInfo erlaubt das kopieren von Register-Listen. Über Register wird ein HM-Gerät eingestellt und die Register sind in Listen gruppiert. Die Reaktion und das Verhalten eines Aktors auf einen Trigger eines Sensors wird in dem Registersatz zu diesem Peer komplett beschrieben. Durch die Möglichkeit einen solchen Registersatz im Device zu kopieren kann man das Verhalten, das man für einen Knopf/Sensor festgelegt hat identisch in einen 2. kopieren. HMInfo geht davon aus, dass die vom Gerät gelesene Konfiguration vor dem Kommando aktuell und komplett ist.
set HM cpRegs Licht1:FB3_Btn2 Licht3:FB1_Btn4 set HM cpRegs Licht2:FB3_Btn2 Licht2:FB1_Btn4 set HM cpRegs Licht4:FB3_Btn2 Licht4:FB5_Btn2
Die obigen Beispiele bewirken der reihen nach: Duplizieren das Verhalten, das Fernbedienungsknopf 2 der Fernbedienung 3 bei Aktor Licht1 hervorruft auch nach Licht3 für Fernbedienungsknopf4 der Fernbedienung 1. Duplizieren das Verhalten, das Fernbedienungsknopf 2 der Fernbedienung 3 bei Aktor Licht2 hervorruft auch nach Licht2 (selber Aktor) für Fernbedienungsknopf4 der Fernbedienung 1.
web Einträge und Readings
Readings und Internals von HMInfo bieten eine Zusammenfassung des Zustands aller HM Komponenten. Diese sind in Fehler ERR' , Warnungen W_ und Information I_ untergliedert. Die Prüfung und Erneuerung der Zähler und Werte wird mit:
set hm update
erreicht. Mit dem Attribut autoUpdate kann man es automatisch regelmäßig starten.
Fehlermeldungen
Als Fehler erkannte Zustände werden in Variablem beginnend mit ERR dargestellt. Erfasste Fehler sind Kritische RSSI werte und Protokoll/Übertragungsfehler. Ausserdem kann man im Attribut sumERROR eintragen, welche Readings zu einer Fehlermeldung führen sollen. Eingetragen werden: Reading:<gutwert>. Wenn ein Reading mit einen anderen als dem "gutwert" gefunden wird, wird dies alarmiert. Beispiel:
battery:ok
hat eine HM Komponente ein Reading "battery" und dieses hat einen anderen Wert als "ok" wird dies alarmiert. In den Readings von HMInfo würde im Feherfall
internal: ERR_names <devicename1>,<devicename2> Readings: ERR_battery low:2
Der default aller Error-meldungen ist battery:ok,sabotageError:off,powerError:ok,overload:off,overheat:off,reduced:off,motorError:no,error:none,uncertain:yes,smoke_detect:none,cover:closed
Diese zusammenfassung der Fehlermeldungen könnte man nutzen, um über notify einen Alarm auszulösen oder eine email zusenden.
Warnungen
Hierzu gehören Wiederholungen von Nachrichten (nicht aber Abbrüche, das sind Fehler). Es wird auch ausstehendes Lesen der Konfiguration, welches durch autoReadReg getriggert wird hier angezeigt.
Statusmeldungen
Analog zu den Fehlermeldungen kann man mit dem Attribut sumStatus gewisse Readings zählen lassen. Beipiel wäre
attr HM sumStatus motor
HMInfo zeigt in dem Reading I_sum_motor dann an, welcher Inhalt des Readings "motor" wie oft gefinden wurde. Es könnte so aussehen
stop:on:4;stop:1;
4 Komponenten stehen auf motor: stop:on und einer steht auf motor: stop
Das Internal I_HM_IOdevices zeigt die von HM Komponenten genutzten IOs und deren State.
Infos
get hm models [-f <regexp>] get hm models get hm models -f remote get hm models -f HM_RC
zeigt alle in FHEM unterstützten Modelle und deren wesentliche Parameter. Man kann mittels regexp die Liste filtern.
get hm param [<typefilter>] [-f <nameFilter>] parameter1 parameter2 get hm param -d IODev DEF model get hm param -c -f Rollo peerList
man kann sich listen von Parametern anzeigen lassen
get hm register [<typefilter>] [-f <nameFilter>]
zeigt Register in tabellarischer Form.
get hm peerXref[<typefilter>] [-f <nameFilter>]
gibt an, wer mit wem gepeert ist
Readings Rücksetzen
Counter zurücksetzen:
set HM clear [<typeFilter>] [Protocol|readings|msgStat|register|rssi]
Filter
Kommandos in HMInfo wirken auf alle HM Komponenten. Man kann dies mit Hilfe der Filter einschränken. Zum einen gibt es modelsFilter, womit man nur devices, nur channels, nur virtuellen Entities bearbeiten kann
set <name> <cmd> [-dcasevi] [params]
entities according to list will be processed"
d - device :include devices"
c - channels :include channels"
i - ignore :include devices marked as ignore"
v - virtual :supress fhem virtual"
p - physical :supress physical"
a - aktor :supress actor"
s - sensor :supress sensor"
e - empty :include results even if requested fields are empty"
Ein auf -d gefiltertes Kommando wird nur auf devices, nicht aber auf channels angewendet.
Dann gibt es noch dem nameFilter, mit dem man mittels regexp auf dem Namen der Entity gefiltert werden kann
-f Rollo # alle Entities mit Rollo im Namen -f ^Rollo$ # nur Entity mit Namen "Rollo" -f Rollo$ # nur Entity deren Name auf Rollo endet
Die Filter kann man kombinieren mit
-c -f Rollo # alle Kanäle mit Rollo im Namen
Beispiel: Zeige mir die Parameter IODev und room der Devices mit Rollo im Namen
set hm param -d -f Rollo IODev room
Attribute
- configDir bietet die Möglichkeit ein directory zu definieren, in welches HMInfo Files ablegen und von welchem es die Files lesen wird.
- configFilename legt einen default Namen fest, der bei save und archive genutzt wird.
- autoArchive automatisch archivieren von vollständigen Konfigurationen.
- autoUpdate started regelmäsig das Komamndo "update". Die Wiederholzeit wird eingestellt mit hh:mm. Sinnvoll erscheint z.B. alle 5 Minuten, also 00:05.
Quellen
- Thread HMinfo im Fhem Forum
- Thread HMINfo, Intention, Sinn und Zweck im Fhem Forum