FHEM Command Beispiele
Allgemeines
Dies soll kein Ersatz für die FHEM Command Reference sein. Es geht hier vorwiegend um voll ausgeschriebene Befehle zum besseren Verständnis. Die Command Reference listet alle Befehle, Optionen und Möglichkeiten auf, aber manchmal übersieht man in der Vielzahl an Informationen eine Kleinigkeit und schon funktioniert es nicht. Es werden nicht alle Optionen erläutert.
Sofern es im Wiki schon Beiträge gibt, die einzelne Befehle ähnlich diesem Beitrag abhandeln, erfolgt ein Verweis auf diese; alle existierenden Beiträge zu Fhem-Befehlen sind zudem in der Kategorie FhemBefehl aufgelistet.
at
at kann man vergleichen mit den "Geplanten Tasks" (Windows) oder "cron" (Linux). Abhängig von der Uhrzeit (immer um 04:00 Uhr) bzw. abgelaufenen Zeitspannen (alle 5 Minuten) werden weitere Befehle ausgelöst. Dieses Hilfsmodul ist auf einer eigenen Seite beschrieben.
attr
Mit attr weist man einem FHEM-Gerät bestimmte Attribute (Merkmale / Eigenschaften) zu. Weiterhin setzt man damit z.B. auch allgemein gültige (globale) Eigenschaften der FHEM-Installation (latitude, longitude, verbose).
attr global latitude 5X.XYZ
Wert für die geographische Breite (früher Breitengrad) setzen. Erforderlich vor Nutzung der Sonnenauf- / Sonnenuntergangsfunktionen (sunrise/sunset usw.)
attr global longitude 6.XYZ
Wert für die geographischen Länge (früher Längengrad) setzen. Erforderlich vor Nutzung der Sonnenauf- / Sonnenuntergangsfunktionen (sunrise/sunset usw.)
attr global verbose X
Mit dem Wert "X" legt man die Detailtiefe der protokollierten Informationen fest.
Hat X den Wert
- 0 wird nur der Start und das Beenden des FHEM-Servers protokolliert
- 1 werden zusätzlich Fehlermeldungen und unbekannte Pakete ausgegeben.
- 2 erfolgt eine Ausgabe der wichtigen Ereignisse (events) und Alarmmeldungen.
- 3 werden ausgesendete Befehle geloggt.
- 4 wird protokolliert, was von den verschiedenen Geräte empfangen wurde.
- 5 wird alles ausgegeben ("debugging", Fehlersuche)
Ein größerer Wert führt also zu einer höheren Detailtiefe.
Für den Normalgebrauch wird Level 3 empfohlen.
attr <Geräte-Name> ignore X
Ausblenden von fremden Geräten aus der FHEM-Konfiguration.
attr <Geräte-Name> room <Raum1>[,Raum2]
Über dieses (optionale) Attribut weist man ein FHEM-Gerät einem Raum oder mehreren Räumen zu, der in der linken Spalte der FHEM-Weboberfläche erscheint. Alle diesem Raum zugewiesenen Geräte bzw. FHEM-Einträge tauchen nach einem Klick auf den Namen dieses Raumes dann auf der entsprechenden Raumseite auf.
Mit der erstmaligen Verwendung eines Raumnamens (also neuer Name) wird automatisch dieser Raum erzeugt und in die Raumliste eingefügt.
Hinweis: Ein evtl. zweiter Raumname ist mit Komma vom ersten Raumnamen zu trennen. Nach dem Komma darf kein Leerzeichen stehen, sonst würde
attr MeinGerät room Keller, Zentrale
einen Raum " Zentrale" erstellen (also mit einem führenden Leerzeichen, das in der FHEM-Raumliste aber nicht sichtbar ist und die Fehlersuche erschwert).
Richtig lautet die o.a. Anweisung also
attr MeinGerät room Keller,Zentrale
Wenn ein Device einem Raum "..., Zentrale" und ein anderes einem Raum "...,Zentrale" zugewiesen ist, würden in der Raumliste dann zwei Räume mit dem Namen Zentrale erscheinen.
backup
Sicherung der Fhem-Installation. Dieser Befehl ist auf einer eigenen Seite beschrieben.
include
Die Nutzung von include wird nur noch "Experten" empfohlen. Der Sinn wird zunehmend (auch von Experten) angezweifelt. Siehe auch Konfiguration.
Es können - z.B. aus Gründen der Übersichtlichkeit, Struktur, Ordnung - Teile der fhem.cfg in separate Dateien auslagern. Mit dem Befehls include müssen diese "Auslagerungsdateien" dann wieder in FHEM eingebunden werden, z.B. so:
include /opt/fhem/FHEM/homematic.cfg
Sofern diese Dateien im Ordner /opt/fhem/FHEM/ gespeichert sind, können sie innerhalb der FHEM-Weboberfläche über den Menüpunkt Edit files erreicht (editiert) werden. Sie stehen dann im Bereich der Own modules and helper files. Ansonsten muss man auf diese Dateien per remote-Sitzung oder einem anderen Programm (SSH / FTP) zugreifen.
Bei Verwendung von includes (wie generell bei direktem Bearbeiten der Konfigurationsdatei(en)) können Fehler auftreten, die allein auf der Reihenfolge der Abarbeitung von Definitionen beruhen. Bei alleiniger Bearbeitung der Konfiguration über die Benutzeroberfläche trägt Fhem selbst Sorge dafür, dass die erforderliche Reihenfolge eingehalten wird.
list
Mittels list können Sie sich z.B. die Eigenschaften / Auswirkungen eines at-Befehls oder eines Gerätes ausgeben lassen.
list .* DEF # Auflistung der Definitionen aller Geräte list wz.* DEF # Auflistung der Definitionen der Geräte, die mit wz beginnen.
reload
Eine einzelne Moduldatei soll neu eingelesen werden. Dadurch werden - ohne Neustart - vorgenommene Änderungen in dieser Moduldatei verfügbar.
Beispiel: reload 99_myUtils
rereadcfg
Dieser Befehl, abgesetzt z.B. über das Befehls-Eingabefeld der Fhem-Oberfläche, veranlasst ein Neueinlesen der aktuellen oder einer alternativen Konfiguration. Im letzteren Fall muss der Name der neu einzulesenden Konfiguration explizit angegeben werden.
Es können nicht einzelne include Dateien auf diesem Weg neu eingelesen werden. Das "reread" bezieht sich immer auf eine komplette Konfiguration, also der Basisdatei (Standard: fhem.cfg) einschließlich aller eventuell darüber hinaus referenzierten include Dateien (siehe auch diesen Beitrag)!
update
Aktualisierung der Fhem-Installation. Dieser Befehl ist auf einer eigenen Seite beschrieben.