HMinfo

HMinfo
Zweck / Funktion
Übersicht über alle HomeMatic Geräte
Allgemein
Typ	Hilfsmodul
Details
Dokumentation	EN / DE
Support (Forum)	HomeMatic
Modulname	98_HMinfo.pm
Ersteller	martinp876 (martinp876 / Wiki)
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!

HMInfo ist ein Modul, das einen Überblick über alle definierten HomeMatic Geräte gibt. 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

Zu berücksichtigen bei allen Funktionen von HMInfo ist die Tatsache, dass die Prüfung jeweils auf den innerhalb von FHEM vorliegenden Informationen passiert. Erste Korrekturmaßnahme ist daher immer von den betroffenen Devices die Informationen mit einem set <Device> getConfig zu aktualisieren. Dabei ist darüber hinaus zu berücksichtigen, dass entsprechend der konfigurierten Kommunikationsmethode (z.B. config) einige Devices erst nach einer gewissen Zeit oder nach Betätigen der Anlerntaste die Informationen als Antwort zurückliefern.

Befehle, um die Gültigkeit von verschiedenen HomeMatic Eigenschaften zu überprüfen:

peerCheck

Mit dem Befehl

get hm peerCheck

wird der Zustand der Peerings überprüft, d.h., ob alle Peerings auch beidseitig sind. Mögliche Meldungen, die eine Überarbeitung und/oder Korrektur von Definitionen erforderlich machen können:

peer not verified. Check that peer is set on both sides

ausgegebener Wert (z.B.): actorChan p:switchChan

erforderliche Korrekturmaßnahme: Erneutes setzen des Links und Sicherstellen, dass das Kommando das entsprechende Device auch erreicht hat (s.o., ggf. bei Bedarf die Anlerntaste betätigen).

regCheck

Mit dem Befehl

get hm regCheck

wird überprüft, ob alle Register korrekt gelesen wurden. Mögliche Meldungen:

missing register list

ausgegebener Wert (z.B.): dev01Ch01: RegL_01:

erforderliche Korrekturmaßnahme: set dev01Ch01 getConfig

oder device01Ch01: .RegL_03:sensor01Ch01,.RegL_03:sensor01Ch02

erforderliche Korrekturmaßnahme: Deutet darauf hin, dass nicht alle Informationen aus einem Device gelesen wurden. Ein set <Device> getConfig sollte alle Register auslesen. Sicherstellen, dass das Kommando zum Auslesen das entsprechende Device auch erreicht und eine Antwort geliefert hat (s.o., ggf. bei Bedarf die Anlerntaste betätigen).

Register changes pending

ausgegebener Wert (z.B.): sensor01Ch01

erforderliche Korrekturmaßnahme: Ein set <Device> getConfig sollte alle Register auslesen. Sicherstellen, dass das Kommando das entsprechende Device auch erreicht und eine Antwort geliefert hat (s.o., ggf. bei Bedarf die Anlerntaste betätigen).

configCheck

Mit dem Befehl

get hm configCheck werden die Befehle peerCheck und regCheck ausgeführt. Zusätzlich können noch Ergebnisse auftauchen wie

PairedTo mismatch to IODev

ausgegebener Wert (z.B.): sensor01Ch01 paired:0x000000 IO attr: xxxxxx.

erforderliche Korrekturmaßnahme: IODevice in den hmPairForSec Modus versetzen, Pairing-Modus am Device aktivieren und dadurch das pairing wiederholen. Ein Anschließendes set <Device> getConfig kann nicht schaden. Sicherstellen, dass das Kommando zum Auslesen das entsprechende Device auch erreicht und eine Antwort geliefert hat (s.o., ggf. bei Bedarf die Anlerntaste betätigen).

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

get hm protoEvents [<filter>][short|long]

Siehe HMinfo Protokoll

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 allem ist hier ein kompletter Überblick zur Kommunikation zu sehen. Der Befehl

set hm clear [<filter>] Protocol

setzt die Protokoleinträge aller HomeMatic-Geräte gemäß Filter zurück. Das kann gut vor einer Konfigurationsaktion genutzt werden um zu kontrollieren, ob Fehler aufgetreten sind.
Für tieferes Verständnis siehe HMinfo Protokoll

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 ein Verzeichnis festlegen, in das alles geschrieben wird.

saveConfig

Peers und Register werden in eine Datei geschrieben. Die Daten kann man ggf. wieder in ein Gerät oder ein Austauschgerät schreiben. Die Speicherung erfolgt kumulativ, man kann alles in eine Datei schreiben.

set hm saveConfig [<filter>] [<file>]

archConfig

Arbeitet prinzipiell wie saveConfig. Es werden jedoch nur vollständige Registersätze gespeichert, was einen höheren Level an Sicherheit der Dateninhalte gewährt.

set hm archConfig [-a] [<file>]

Mit dem Attribut autoArchive kann man einstellen, dass automatisch nach erfolgreichem Lesen einer Device-Konfiguration diese archiviert wird. Das Speichern erfolgt kumulativ. Ab einer Dateigröße von 1MB wird gepurged, also alles bis auf den neusten Eintrag jeder Entity gelöscht.

Um eine Konfiguration zu sichern, sollte eine Kopie des Archivs gemacht werden. Das Archiv wird bei Gelegenheit überschrieben.

Template erstellen:

set hm saveConfig -f ^meinDevice$ <myTemplateFile>

loadConfig

set hm loadConfig [<filter>] [<filename>]

Liest die Registerwerte, die 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, die 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 Templates. 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 einmal.

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 , extend time with each trigger
 motionOnDim      params:ontime brightness        Info:Dimmer: on for time if MDIR-brightness below level
 motionOnSw       params:ontime brightness        Info:Switch: on for time if MDIR-brightness below level

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 , extend time with each trigger
   ActionType       :jmpToTarget
   OffTime          :111600
   OnTime           :time
   SwJtDlyOff       :dlyOn
   SwJtDlyOn        :no
   SwJtOff          :dlyOn
   SwJtOn           :on

Ein templateList auf ein einzelnes Template zeigt im Detail, was das Template verändern wird.

templateSet

Um ein Template auf einen Aktor anzuwenden,muss man den Bereich wählen, auf den er angewendet werden soll. Je nach template kann das die Gruppe der Register zu einem Peer, zu short oder long eines Peer oder Register ohne peer sein.

 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
 set hm templateSet Licht1 SwOff FB1_Btn2:short
 set hm templateSet Licht1 SwOnOff FB1_Btn2:both
 set hm templateSet LichtDev setHost 0

Licht1 soll, wenn ein kurzer Trigger von FB1_Btn2 kommt für 10 sec eingeschaltet werden, dann ausgehen (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 eingeschaltet, 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, im Gegensatz zur Nutzung eines Templates mit set - das ist für Anfänger gedacht. Man kann sein template manuell definieren oder ein bekanntes Device als Muster nutzen (fromMaster). Ein Template kann nur Gruppen von Registern setzen, nicht alle Register eines Device. Um die Gruppen anzusprechen muss man "peer" wie folgt setzen:

 0            Register ohne peer
 <peer>:both  Register eines peers
 <peer>:short Register eines peers nur Short
 <peer>:long  Register eines peers nur Long

setzen. Man kann das template "dynamisch" gestalten, indem man einzelne Register beim templateSet übergibt. Erst einmal statische Templates. Param ist hier "0"

 set hm templateDef <templateName> <param1[:<param2>...]> <description> <reg1>:<val1> [<reg2>:<val2>] ... 

 set hm templateDef t1 0 "TP1" OnTime:10 OffTime:20 OnDly:0 

 set hm templateDef t1 fromMaster <entity> 0 
 set hm templateDef t2 fromMaster <entity> <peer>:both 
 set hm templateDef t3 fromMaster <entity> <peer>:short
 set hm templateDef t4 fromMaster <entity> <peer>:long

 set hm templateDef t4 fromMaster LichtWz remoteBtn1:long

Dynamische Templates haben eine Parameterliste (bis zu 9) <param1[:<param2>...]>. Diese werden als p0 bis p8 genutzt - der Name ist dabei egal, er dient dem User also Hilfe beim templateList

 set hm templateDef myTemplate anzeit:auszeit "licht schaltet ständig an und aus" OnTime:p0 OffTime:p1 OnDly:0

 set hm templateDef myAutoOff AnZeit "treppenhausschalter" ActionType:jmpToTarget OffTime:unused OnTime:p0 SwJtDlyOff:dlyOn SwJtDlyOn:no SwJtOff:dlyOn SwJtOn:on

Die "Anzeit" ist der erste Parameter, also p0. Der Wert, den man bei Set einträgt wird in OnTime geschrieben. OnTime:p0

Beim Definieren eines Templates wird die Registergültigkeit nicht geprüft. Das kommt beim Set.

Mit dem Parameter del kann ein (fehlerhaftes) Template (hier myTemplate) wieder gelöscht werden.

 set hm templateDef myTemplate del

templateChk

Template definitionen und zuweisungen (set) kann man mit

 set hm archConfig

speichern und mit

 set hm loadConfig

mach einem reboot laden. Welche templates einer entity zugewiesen sind kann man mit

 attr <entity> expert 12

in den Readings sichtbar machen. Siehe auch templateUsg.

Man kann prüfen, ob ein Aktor/Peer gemäss einem Template programmiert ist. Sinnvoll ist eine komplette Prüfung aller zugewiesenen templates. Man kann aber auch filtern.

 get hm templateChk 
 get hm templateChk [<filter>] 
 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, nur für short Einträge

templateUsg

Gibt eine Liste der zugewiesenen templates zurück

 get hm templateUsg  
 get hm templateUsg sortTemplate
 get hm templateUsg sortPeer

templateExe

Nach einem loadConfig oder einem templateChk können Fehler erkannt worden sein, die Register entsprächen nicht dem Template. Mit diesem Kommando werden alle nicht korrekten Register in die Devices geschrieben. Sollten die Werte stimmen, wird nichts gemacht.

set hm templateExe

Das Kommando kann also bedenkenlos eingesetzt werden, wenn die templates schon stimmen. Es wird nichts gesendet, keine Funklast erzeugt.

templateDel

eine Zuweisung des Templates kann gelöscht werden

set hm templateDel <entity> <template>

Temperaturlisten

HMInfo bietet verschiedene Methoden, Temperaturlisten für Thermostate (CC-TC, TC-IT oder RT) zu verwalten und zu nutzen. Siehe hierzu Homematic Weekplan

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 zweiten 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 Reihe 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 Variablen 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 einem 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 Fehlerfall

 internal:
   ERR_names <devicename1>,<devicename2>
 Readings:
   ERR_battery low:2

Der default aller Fehlermeldungen 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 E-Mail zu senden.

Warnungen

Hierzu gehören Wiederholungen von Nachrichten (nicht aber Abbrüche, das sind Fehler). Es wird auch ausstehendes Lesen der Konfiguration, das 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 gefunden wurde. Es könnte so aussehen

 stop:on:4;stop:1;

Vier Komponenten stehen auf motor: stop:on und eine 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

Rücksetzen von Variablen und Zählern

set HM clear [<typeFilter>] [Protocol|readings|msgStat|register|rssi]

• register löscht alle Register-readings
• readings löscht alle readings
• Protocol löscht alle Protokol-einträge, pending Kommandos und Protokoll-fehler.
• rssi löscht alle ermittelten RSSI Werte
• msgStat setzt die Message Statistik zurück

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 virtuelle 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 den nameFilter, mit dem mittels regexp auf den 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

• autoArchive automatisch archivieren von vollständigen Konfigurationen.
• autoUpdate startet regelmäßig das Komamndo "update". Die Wiederholzeit wird eingestellt mit hh:mm. Sinnvoll erscheint z.B. alle 5 Minuten, also 00:05.
• configDir bietet die Möglichkeit, ein Verzeichnis zu definieren, in das HMInfo Dateien ablegen und von dem es die Dateien lesen wird. Default ist fhem_root.
• configFilename legt einen default Namen fest, der bei save und archive genutzt wird. Default ist regSave.cfg.
• hmAutoReadScan zeitinterval in Minuten, in denen CUL_HM prüft, ob offene autoRead bereitstehen und die IOs die Kapazität haben. Default ist 4 min.

Weiterführende Links

• HomeMatic Templates

Quellen

• Thread HMinfo im FHEM Forum
• Thread HMINfo, Intention, Sinn und Zweck im FHEM Forum