### Inhalt

Einleitung
FHEM Befehls-Typen
Geräte-Spezifikation
Attribute
FHEM-Befehle

apptime attr cancel createlog define defmod delete deleteattr deletereading displayattr get IF include inform list modify notice quit reload rename rereadcfg save set setdefaultattr setreading setstate setuuid shutdown sleep trigger usb

Gerätemodule

global

Hilfs (Erweiterungs-) Module

PERL Besonderheiten
gnuplot file Syntax

### Einleitung

FHEM wird hauptsächlich zur Heimautomatisierung benutzt, ist aber ebenso für andere Aufgaben einsetzbar wo Benachrichtigungen, Zeitschaltungen und Datensammlungen eine wichtige Rolle spielen.

FHEM unterstützt verschiedene Hardwaregeräte die eine Verbindung mittels unterschiedlicher Protokolle (z.B. FHZ1000 mit Interfaces vom Typ FS20 und HMS, CM11 um mit X10 zu arbeiten) sowie logischer Geräte wie FS20 oder FHT die einen Nachrichtenaustausch mit verschiedensten Geräten die diese Protokolle verwenden ermöglichen.

FHEM ist modular. Abhängig von den unterschiedlichen Geräten werden in den Modulen verschiedene Funktionen (z.B. define, get, set) realisiert. FHEM enthält weitere Funktionen wie Trigger (notify), Zeitabhängige Funktionen (at) die die Funktionalität erweitern.

FHEM wird entweder über einfache ASCII-Kommandozeilen gesteuert die in Dateien wie z.B. der Konfigurationsdatei fhem.cfg gespeichert sind oder über eine TCP/IP Verbindung, entweder direkt in einer "telnet"-Sitzung, oder per fhem.pl im Client-Modus oder über eines der Webfrontends.

Wenn Sie den FHEM-Server starten, müssen Sie eine Konfigurationsdatei auswählen:

`perl fhem.pl fhem.cfg`

Nachstehend eine Minimal-Konfiguration Datei:

        attr global logfile log/fhem.log
        attr global modpath .
        attr global statefile log/fhem.save
        attr global verbose 3
        define telnetPort telnet 7072 global
        define WEB FHEMWEB 8083 global

Die letzten zwei Zeilen definieren einen telnet und einen WEB Zugang, beide können aber bei Bedarf auch abgeschaltet werden.
Die WEB Schnittstelle kann über

http://<fhemhost>:8083

erreicht werden.
Die Kommunikation mit FHEM kann entweder in einer "session" (über telnet) oder über einzelne Klient-Kommandos (über fhem.pl) erfolgen. Beispiel:

`telnet <fhemhost> 7072
<NL>` (Die Betätigung der "Enter"-Taste schaltet in den "prompt" Modus)`
<command>...
quit`

oder

`fhem.pl <fhemhost>:7072 "<command>..."`

Falls FHEM als root gestartet wurde, und ein OS-Benutzer fhem existiert, dann wechselt FHEM nach dem start zu diesem Benutzer (via setuid).

### FHEM Befehlstypen

Es gibt drei Arten von Befehlen: "fhem" Befehle (werden in diesem Dokument beschrieben), SHELL-Befehle (diese müssen von doppelten Anführungszeichen "" eingeschlossen werden) und PERL-Ausdrücken (von geschwungenen Klammern {} eingeschlossen). SHELL-Befehle oder PERL-Ausdrücke werden für komplexe at oder notify Ausdrücke benötigt, können aber auch als "normale" Befehle angewendet werden.
Die folgenden drei Befehle bewirken z.B. dasselbe Ergebnis, wenn sie am telnet-Prompt eingegeben werden:

set lamp off
"fhem.pl 7072 "set lamp off""
{fhem("set lamp off")}

SHELL-Kommandos werden im Hintergrund ausgeführt, PERL-Ausdrücke und FHEM-Kommandos werden im Haupt-"thread" ausgeführt. Um PERL-Ausdrücke leichter eingeben zu können, sind einige Spezialfunktionen und Variablen verfügbar. Lesen Sie sich bitte die Abschnitte Perl special zum besseren Verständnis durch.

Um FHEM-Befehle in einen SHELL-Script zu triggern (dies ist eine "andere" Möglichkeit), benutzen Sie bitte die oben beschriebene Client-Form der fhem.pl.
Mehrere FHEM-Kommandos hintereinander werden mittels Semikolon (;) getrennt. Weil Semikola auch in PERL-Code oder SHELL-Programmen benutzt werden, müssen sie mittels doppelten Semikola geschützt werden. Lesen Sie sich bitte die Bermerkungen des notify-Abschnittes zu Kommandoparametern und Regeln durch.
Z.B. schaltet die erste der folgenden Befehlszeilen die Lampe 1 nur/erst zur Uhrzeit 07:00 Uhr aus, die Lampe 2 aber sofort und die zweite Befehlszeile schaltet Lampe 1 und 2 um 7:00 Uhr gleichzeitig aus.

define lampoff at 07:00 set Lamp1 off; set Lamp2 off
define lampoff at 07:00 set Lamp1 off;; set Lamp2 off

Für jede weitere Indirektion muss man die Strichpunkte verdoppeln. Um also die beiden Lampen um 7:00 für 10 Minuten einzuschalten schreibt man:

define onAt at 07:00 set Lamp1 on;;set Lamp2 on;; define offAt at +00:10 set Lamp1 off;;;;set Lamp2 off

Keine Angst, das Vorherige kann in FHEM auch deutlich einfacher formuliert werden als:

define onAt at 07:00 set Lamp1,Lamp2 on-for-timer 600

Befehle können entweder direkt eingegeben oder aus einer Datei (z.B. am Start von FHEM aus der Konfugurationsdatei) eingelesen werden. Die Befehle werden entweder direkt ausgeführt oder später wenn sie als Argumente eines at oder notify-Befehles verwendet werden.

Eine mit einem \ abgeschlossene Zeile wird mit der nachfolgenden Zeile verbunden. Somit können lange Befehlszeilen (die z.B. aus mehreren PERL-Befehlen bestehen) auf mehrere Zeilen aufgteilt werden. Einige Web-Frontends (z.B. webpgm2) erleichtern die Eingabe von sich über mehrere Zeilen erstreckende Befehle, indem man keine \ am Zeilenende eingeben muss.

### Geräte-Spezifikation (devspec)

Die Befehle attr, set, get, usw. attr, deleteattr, displayattr, delete, get, list, set, setreading, setstate, trigger können eine komplexere Gerätespezifikation als Argumente enthalten, die auch eine Anzahl von Geräten betreffen kann. Eine Gerätespezifikation kann folgendes sein:

- ein einzelner Gerätename. Dies ist der Normalfall
- eine durch Komma(,) getrennte Liste von Gerätenamen
- ein regulärer Ausdruck
- ein NAME=WERT Ausdruck, wo NAME ein "Internal" Wert wie TYPE ist, ein Reading-Name oder ein Attribut. WERT ist ein regulärer Ausdruck. Um die Bedingung zu negieren, muss NAME!=WERT verwendet werden. Um die Suche einzugrenzen, kann man als Praefix i: für internal Werte, r: für Reading-Namen und a: für Attribute verwenden, siehe das Beispiel unten. Groß-/Kleinschreibung wird durch die Verwendung von ~ oder !~ ignoriert.
- Falls die Spezifikation von :FILTER=NAME=WERT gefolgt wird, dann wird die zuvor gefundene Liste durch diesen neuen Ausdruck gefiltert.

Beispiele:

`set lamp1 on`
`set lamp1,lamp2,lamp3 on`
`set lamp.* on`
`set room=kitchen off`
`set room=kitchen:FILTER=STATE=on off`
`set room=kitchen:FILTER=STATE!=off off`
`list disabled=`
`list room~office`
`list TYPE=FS20 STATE`
`list i:TYPE=FS20 STATE`

Bemerkungen:

- die Spezifikation kann keine Leerzeichen enthalten.
- falls ein Gerätename exakt dem Spezifikation entspricht, dann werden keine reguläre Ausdrücke oder Filter ausgewertet.
- zuerst wird die durch Komma getrennte Spezifikation abgearbeitet, dann folgen die regulären Ausdrücke und die Filter
- die Befehlszeile kann die selbe Gerätebezeichnung mehrfach enthalten z.B.: "set lamp3,lamp3 on". Lamp3 wird hier zwei Mal eingeschalten.
- um Strukturen mit komplexeren Anforderungen zu realisieren lesen Sie bitte den Abschnitt zu structure.

### Attribute

Alle Geräte haben Attribute. Diese werden mittels des Befehls attr gesetzt, angezeigt mit dem Befehl displayattr, und mit dem Kommando deleteattr entfernt.

Es gibt globale Attribute, die von allen Geräten genutzt werden, und lokale Attribute, die nur auf individuelle Geräteklassen zutreffen.

Manche Geräte (wie FHEMWEB) definieren automatisch neue globale Attribute bei der ersten Definition eines Gerätes dieses Typs.

Sie können den Befehl

`attr global userattr <attributelist>`

für das Gerät global verwenden, um neue globale Attribute zu deklarieren, und

`attr <devicespec> userattr <attributelist>`,

um neue lokale Attribute für bestimmte individuelle Geräte gemäß devspec zu deklarieren. `<attributelist>` ist eine durch Leerzeichen getrennte Liste, die die Namen der zusätzlichen Attribute enthält. In der Dokumentation zum Befehl attr sind Beispiele.

Seien Sie vorsichtig und überschreiben Sie keine zusätzlichen globale Attribute, die bereits zuvor durch Sie selbst oder ein Gerät definiert wurden. `attr global userattr <attributelist>` sollte so früh wie möglich in der Konfiguration erscheinen.

#### Gerätespezifische Attribute

Gerätespezifische Attribute sind in dem jeweiligen Abschnitt zum Gerät dokumentiert.

#### Globale Attribute für alle Geräte

- alias
  Wird in FHEMWEB benutzt, um ein en anderen Namen für ein Gerät anzuzeigen z.B. wenn Sonderzeichen/Leerzeichen nicht in der Gerätedefinition verwendet werden können.
- comment
  Fügt einen beliebigen Kommentar hinzu.
- eventMap
  Ersetze Event Namen und setze Argumente. Der Wert dieses Attributes besteht aus einer Liste von durch Leerzeichen getrennte Werten. Jeder Wert ist ein durch Doppelpunkt getrenntes Paar. Der erste Teil stellt den "alten" Wert, der zweite Teil den "neuen" Wert dar. Wenn der erste Wert ein Slash (/) oder ein Komma (,) ist, dann wird nicht durch Leerzeichen sondern durch das vorgestellte Zeichen getrennt. Optional kann man auch ein widgetOverride angeben (angehängt nach einem Doppelpunkt (z.Bsp. on-for-timer:OnFor:texField). Die Voreinstellung ist :noArg, um das Input Feld bei cmdList zu vermeiden. Beispiele:
  `attr store eventMap on:open off:closed
  attr store eventMap /on-for-timer 10:open/off:closed/
  set store open`
  Die explizite Variante dieses Attributes hat folgenden Syntax:
  `attr store eventMap { dev=>{'on'=>'open'}, usr=>{'open'=>'on'} }
  attr store eventMap { dev=>{'^on(-for-timer)?(.*)'=>'open$2'}, usr=>{'^open(.*)'=>'on$1'}, fw=>{'^open(.*)'=>'open'} }`
  Diese Variante muss dann verwendet werden, falls das Mapping nicht symmetrisch ist. Der erste Teil (dev) spezifiziert dabei die Richtung Gerät zu Benutzer, d.h. falls das Gerät on 100 oder on-for-timer 100 meldet, dann wird der Benutzer open 100 zu sehen bekommen. Der zweite Teil (usr) spezifiziert die Richtung Benutzer zu Gerät, d.h. wenn man "set XX open 100" eingibt, dann wird das Kommando "on 100" an das Gerät gesendet. In beiden Fällen wird der Schlüssel zuerst direkt, und dann als Regexp mit dem Wert verglichen. Falls man Regexps mit Wildcards im usr Teil verwendet, dann muss man den fw Teil mit dem exakt gleichen Schlüsseln ausfüllen, damit FHEMWEB in der Detail-Ansicht den set-Auswahl richtig anzeigen kann.
- genericDisplayType
  Wird von bestimmten Frontends (aber nicht FHEMWEB) verwendet, um für das Gerät passende Voreinstellungen (Bild/Befehle/etc) anzubieten. Z.Zt werden folgende Werte unterstützt: switch,outlet,light,blind,speaker,thermostat
- group
  Gerätegruppen. FHEMWEB zeigt Geräte die in die gleiche Gruppe gehören auch in einer gemeinsamen Box an. Ein Gerät kann zu mehr als einer Gruppe gehören. In diesem Fall müssen die entsprechenden Gruppen durch Kommata getrennt eingetragen werden. Wenn dieses Attribut nicht gesetzt ist, wird der in der Gerätegruppe gesetzte Gerätetyp verwendet.
- room
  Filtert/gruppiert Geräte. Ein Gerät kann zu mehr als einem Raum zugeordnet werden. In diesem Fall müssen die Raumzuordnungen durch Kommata getrennt angegeben werden.
  Geräte, die dem Raum mit der Bezeichnung "hidden" zugeordnet werden, erscheinen nicht auf der Webseite. Mit -> werden Räume strukturiert, z.Bsp. OG->Schlafzimmer
- showtime
  Wird im FHEMWEB verwendet, um die Zeit der letzten Aktivität anstelle des Status in der Gesamtansicht anzuzeigen. Nützlich z.B. für FS20 PIRI Geräte.
- suppressReading
  Wird verwendet, um nicht gewollte Readings zu entfernen. Der Wert ist ein Regular Expression, ergänzt mit ^ und $. Wird nur in Ausnahmefällen benötigt.
- verbose
  Setzt den Schwellwert für die Logfile-Meldungen. Mögliche Werte sind:
  - 0 - Server start/stop
  - 1 - Fehlermeldungen oder unbekannte Pakete
  - 2 - bedeutende Ereigbisse/Alarme.
  - 3 - ausgesendete Kommandos werden gelogged.
  - 4 - von den einzelnen Geräten empfangene Daten.
  - 5 - Fehlersuche.
  Der für die global Instanz gesetzte Wert gilt als Voreinstellung für die Instanzen, die dieses Attribut nicht gesetzt haben.

#### readingFnAttribute

Die folgenden Attribute werden bei Modulen verwendet, die standardisierte "readings" Aktualisierung der fhem.pl benutzen. Informieren Sie sich in der Liste der Modulattribute wenn Sie wissen möchten ob dies unterstützt wird.

- stateFormat
  Ändert den Gerätestatus, dies ist z.Bsp. in der Ausgabe des list Kommandos zu sehen, oder in der Raumübersicht von FHEMWEB. Falls nicht gesetzt, dann wird das state Reading übernommen. Sonst werden alle Wörter im Wert des Attributes durch das entsprechende Reading des Gerätes ersetzt (soweit vorhanden). Falls der Wert in {} eingeschlossen ist, dann wird es als Perl Ausdruck ausgewertet. Die Auswertung passiert bei jeder Änderung eines Readings.
  Die hier beschriebene "set magic" wird auch angewendet.
- event-on-update-reading
  Wenn nicht gesetzt, erzeugt jede Veränderung eines "readings" ein Ereignis, welches z.B. von notify oder FileLog berücksichtigt wird. Wenn gesetzt erzeugen nur Aktualisierungen der eingetragenen "readings" ein Ereignis.
- event-on-change-reading
  Dieses Attribut enthält eine durch Kommata getrennte Liste von "readings". Wenn gesetzt, erzeugen nur Veränderungen der gelisteten "readings" ein Ereignis. Wenn die aktualiserten Werte der gelisteten "readings" identisch sind, wird kein Ereignis generiert.
  Wenn hinter dem Namen eines "readings" eine :Schwelle angegeben ist, wird das Event nur getriggert wenn die Änderung grösser als diese Schwelle ist.
Die unterschiedlichen Bedeutungen von event-on-update-reading und event-on-change-reading sind folgende:

1. Wenn beide Attribute nicht gesetzt sind erzeugt jede Aktualisierung eines jeden "readings" eines Gerätes ein Ereignis.
2. Wenn eines der Attribute gesetzt ist, erzeugen nur Updates oder änderungen von "readings" die in einem der Attribute gesetzt sind ein Ereignis.
3. Wenn ein "reading" in event-on-update-reading aufgeführt ist, erzeugt eine Aktualisierung ein Ereignis unabhängig ob das "reading" auch in event-on-change-reading aufgelistet ist.

- timestamp-on-change-reading
  Dieses Attribut enthält eine durch Kommata getrennte Liste von "readings". Wenn gesetzt, werden die Zeitstempel der gelisteten "readings" nicht aktualisiert wenn durch ein ebenfalls gesetztes event-on-change-reading für dieses "reading" kein Ereignis erzeugen würde.

- event-aggregator
The primary uses of this attribute are to calculate (time-weighted) averages of readings over time periods and to throttle the update rate of readings and thus the amount of data written to the logs.

This attribute takes a comma-separated list of `reading:interval:method:function:holdTime` quintuples. You may use regular expressions for `reading`. If set, updates for the listed readings are ignored and associated events are suppressed for a black-out period of at least `interval` seconds (downsampling). After the black-out period has expired, the reading is updated with a value that is calculated from the values and timestamps of the previously ignored updates within the black-out period as follows:

function | description
--- | ---
v | the last value encountered
v0 | the first value encountered
min | the smallest value encountered
max | the largest value encountered
mean | the arithmetic mean of all values
sd | the standard deviation from the mean
median | the median of all values (requires holdTime and function none)
integral | the arithmetic sum (if not time-weighted) or integral area (if time-weighted) of all values
n | number of samples
t | timestamp of the last value
t0 | timestamp of the first value

If `method` is `none`, then that's all there is. If `method` is `const` or `linear`, the time-weighted series of values is taken into account instead. The weight is the timespan between two subsequent updates. With the `const` method, the value is the value of the reading at the beginning of the timespan; with the `linear` method, the value is the arithmetic average of the values at the beginning and the end of the timespan. Rollovers of black-out periods are handled as one would expect it.

One would typically use the `linear` method with the `mean` function for quantities continuously varying over time like electric power consumption, temperature or speed. For cumulative quantities like energy consumed, rain fallen or distance covered, the `none` method with the `v` function is used. The `constant` method is for discrete quantities that stay constant until the corresponding reading is updated, e.g. counters, switches and the like.

If the `holdTime` in seconds is defined, the samples will be kept in memory allowing the calculation of floating statistics instead of blocked statistics. With `holdTime` defined the `interval` can be kept undefined so that the readings update rate is unchanged or it can be set to a value less then `holdTime` for downsampling as described above with a full history of the readings in memory. Note that the historic samples are not persistent and will be lost when restarting FHEM.

The event aggregator only takes into consideration those updates that remain after preprocessing according to the `event-on-update-reading` and `event-on-change-reading` directives. Besides which, any update of a reading that occurs within a timespan from the preceding update that is smaller than the resolution of FHEM's time granularity is ditched.

When more than one function should be calculated for the same reading, the original reading must be multiplied (e.g. by using a notify) before applying the event-aggregator to the derived readings.

Examples:
`attr myPowerMeter event-aggregator EP_POWER_METER:300:linear:mean,EP_ENERGY_METER:300:none:v`
`attr myBadSensor event-aggregator TEMP::none:median:300`
`attr mySunMeter event-aggregator SUN_INTENSITY_24H::const:integral:86400`

- event-min-interval
  Dieses Attribut enthält eine durch Kommata getrennte Liste von "readings:minInterval" Paare. readings kann ein regexp sein. Ein Event wird nur dann generiert, falls seit dem letzten Auftreten des gleichen Events mindestens minInterval Sekunden vergangen sind. Falls event-on-change-reading auch spezifiziert ist, dann werden sie mit ODER kombiniert, d.h. wenn einer der beiden Bedingungen wahr ist.
- oldreadings
  Dieses Attribut enthält eine durch Kommata getrennte Liste von Readings. regex sind erlaubt. Für jedes Reading aus der Liste speichert FHEM intern den vorherigen Wert wenn sich das Reading ändert. Zum Zugriff auf die Werte gibt es die OldReadings.* Routinen.
- userReadings
  Komma getrennte Liste von benutzerdefinierten Readings. Jede Definition hat folgendes Format:
  `<reading>[:<trigger>] [<modifier>] { <perl code> }`
  Diese benutzerdefinierte Readings werden bei jeder Aktualisierung der Gerätereadings gesetzt, indem das spezifizierte perl code `{ <perl code> }` ausgeführt wird, und dessen Wert dem Reading zugewiesen wird. Falls <trigger> spezifiziert ist, dann findet diese Ausführung nur dann statt, falls einer der aktualisierten Readings dem regexp <trigger> entspricht (matched).
  Beispiele:
  `attr myEnergyMeter userReadings energy { ReadingsVal("myEnergyMeter","counters.A",0)/1250.0;; }
  attr myMultiMeter userReadings energy1:counters.A.* {ReadingsVal("myMultiMeter","counters.A",0)/1250.0}, energy2:counters.B.* {ReadingsVal("myMultiMeter","counters.B",0)/1250.0}`
  `<modifier>` kann die folgenden Werte haben:
  - none: als ob man es gar nicht spezifiziert hätte.
  - difference: das Reading wird auf die Differenz zw. dem aktuellen und dem vorherigen Wert gesetzt.
  - differential: das Reading wird auf die Differenz zw. dem aktuellen und dem vorherigen Wert, geteilt durch die Sekunden zw. der aktuellen Zeit und der letzten Auswertung, sekundengenau. Kein Wert wird berechnet, falls der Unterschied unter eine Sekunde liegt.
  - integral: das Gegenteil von differential. Das Ergebnis wird um das Produkt aus der Zeit-Differenz und der Durschnittswert der letzten zwei Readings erhöht.
    result += (time - timeold) * (oldval + value) / 2
  - offset: wenn der aktuellen Wert kleiner als der vorherige Wert ist wird der vorherige Wert zum Reading addiert. Das Reading kann dann als offset verwendet werden um einen Zähler der durch Sromverlust zurückgesetzt wird zu korrigieren.
  - monotonic: wenn die Differenz zw. dem aktuellen und dem vorherigen Wert positiv ist wird diese Differenz zum Reading addiert. Damit lässt sich von einem Zähler der bei Stromverlust zurückgesetzt wird ein monoton wachsender Zähler ableiten.
  Beispiel:
  `attr myPowerMeter userReadings power differential { ReadingsVal("myPowerMeter","counters.A",0)/1250.0}`
  Achtung:
  - Falls difference oder differential spezifiziert ist, dann werden für die Berechnung ältere Werte benötigt, d.h. der Wert wird frühestens beim zweiten Änderung gesetzt.
  - der Name der definierten Readings besteht aus alphanumerischen Zeichen, Unterstrich (_) und Minus-Zeichen (-).

#### Allgemeine Attribute

Die folgenden lokalen Attribute werden von mehreren Geräten verwendet:

- IODev
  Setzt das IO oder das physische Device, welches zum Senden der Signale an dieses logische Device verwendet werden soll (Beispielsweise FHZ oder CUL). Hinweis: Beim Start weist FHEM jedem logischen Device das letzte physische Device zu, das Daten von diesem Typ empfangen kann. Das Attribut IODev muss nur gesetzt werden, wenn mehr als ein physisches Device fähig ist, Signale von diesem logischen Device zu empfangen.
- Attribut "disable" umschalten
  Das Attribut "disable" kann, sofern vom Gerätemodul bereitgestellt,
  mit folgendem Befehl einfach umgeschaltet werden:
  `attr <device> disable toggle`

### attr

`attr [-a|-r] <devspec> <attrname> [<value>]`
Dieser Befehl setzt ein Attribut für ein Gerät welches mit define definiert wurde. value ist optional, und ist 1 falls nicht spezifiziert. Sie können auch Ihre eigenen Attribute definieren, um sie in anderen Applikationen anzuwenden. Geben Sie "<attr <name> ?" ein, um eine Liste verfügbarer Attribute anzuzeigen. Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Gerätespezifische Attribute sind in der Beschreibung zum jeweiligen Gerät aufgeführt. Nach der Durchführung das globale Ereignis "ATTR" wird generiert.
Falls die Option -a spezifiziert ist, dann wird value zum aktuellen Wert hinzugefügt. Achtung: falls value nicht mit einem Komma (,) anfängt, dann wird es mit einem Leerzeichen angehängt.
Mit der -r Option kann man Teile eines Attributes wieder entfernen.
Beispiele:

`attr global verbose 3
attr lamp room kitchen
attr lamp group lights
attr lamp loglevel 6
attr weatherstation event-on-update-reading wind,temperature,humidity
attr weatherstation event-on-change-reading israining
attr weatherstation event-on-change-reading israining,state
attr heating stateFormat Temp:measured-temp, Valve:actuator
attr -a TYPE=SVG room ,SvgRoom attr -r TYPE=SVG room ,SvgRoom`

Bemerkungen:

- Lesen Sie unter deleteattr nach um Attribute zu löschen.

### cancel

`cancel [<id> [quiet]]`
Entfernt ein benanntes sleep.

### define

`define [option] <name> <type> <type-specific>`
Definiert ein Gerät. Sie müssen Geräte einrichten um sie zu beeinflussen (z.B. das Kommando set on/off auszuführen). Gleichfalls ist das Logfile besser lesbar wenn es z.B. "lamp off" anstatt "Device 5673, Button 00, Code 00 (off)" als Text enthält.
Nach der Durchführung wird das globale Ereignis "DEFINED" generiert.
Je nach Typ benötigt man unterscheidliche Argumente, lesen Sie sich bitte die zu dem jeweiligen Gerät gehörenden Abschnitte durch.
Optionen:

- -temporary
  Setzt den TEMPORARY Marker, was das Abspeichern dieser Definition in fhem.cfg verhindert.
- -ignoreErr
  Reduziert die Anzahl der Fehlermeldungen, falls ein FHEM-Modul nicht geladen werden kann. Wird in fhem.cfg.demo verwendet, da das RSS Beispiel etliche, normalerweise nicht installierte perl-Module benötigt.

### defmod

`defmod [-temporary] <name> <type> <type-specific>`
Definiert ein Gerät, oder ändert es, falls es exisitiert. Um z.Bsp. eine Lampe 10 Minuten nach der letzten Meldung eines Bewegungsmelders abzuschalten, könnte man folgendes definieren:

`define mdNtfy notify motionDetector defmod mdOff at +00:10 set lamp off`

Falls man statt defmod ein define verwenden würde, dann würde eine Meldung innerhalb von 10 Minuten nach der letzten Meldung zu einem Fehler führen, da mdOff noch existiert.

### delete

`delete <devspec>`
Löscht etwas was mit dem define Befehl erstellt worden ist.
Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Nach dem löschen, wird das globale Ereignis "DELETED" erzeugt.
Beispiel:

`delete lamp`

### deleteattr

`deleteattr <devspec> [<attrname>]`
Löscht entweder ein einzelnes Attribut (siehe Abschnitt attr ) oder alle Attribute eines Gerätes (falls kein <attrname> angegeben wird).
Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Nach der Durchführung das globale Ereignis "DELETEATTR" wird generiert.
Beispiele:

`deleteattr lamp follow-on-for-timer`
`deleteattr lamp`

### deletereading

`deletereading <devspec> <readingname>`
Entfernt das Reading <readingname> für das spezifizierte Gerät. <readingname> ist ein perl Regular-Expression, was den vollständigen Namen des Readings erfassen muss. Mit größter Sorgfalt verwenden! FHEM kann abstürzen, falls man lebenswichtige Readings entfernt.
Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Beispiele:

`deletereading mySensor temp1`
`deletereading mySensor temp\d+`

### displayattr

`displayattr <devspec> [<attrname>]`
Zeigt entweder den Wert eines Attributes an (falls <attrname> spezifiziert wurde) oder alle Attribute eines Gerätes. Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Falls mehrere Geräte spezifiziert wurden, dann enthält die Ausgabe den Namen der Geräte.
Beispiele:

`fhem> di WEB
menuEntries AlarmOn,/fhem?cmd=set%20alarm%20on
room Misc.
fhem> di WEB room
Misc.
`

### get

`get <devspec> <type-specific>`
Fragt einen Wert direkt (aktuell) vom Gerät ab und wartet auf eine Antwort. Eine allgemeine Liste möglicher Paramter erhalten Sie mit

`get <device> ?`

Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Jedes Gerät hat unterschiedliche "get"-Parameter. Lesen Sie Details bitte im zugehörigen Abschnitt nach.

### getstate

`getstate <devspec>`
Gibt einen kurzen, durch Leerzeichen getrennte Statusliste für <devspec> aus . Dies ist nützlich, um das Gerät in z.B. Cacti zu beobachten.
Beispiel:

`getstate lamp
state:1
getstate fl
ack:0 actuator:2 day-temp:21.5 desired-temp:22.5 [...] measured-temp:22.9 [...]`

Bemerkung: Um diesen Befehl nutzen zu können, kopieren Sie bitte die Datei 99_getstate.pm aus dem Verzeichnis contrib/getstate/ in Ihr FHEM Verzeichnis.

### include

`include <filename>`
Liest (z.B. als Befehlszeile in der fhem.cfg) die in <filename> angegebene Datei in FHEM ein und interpretiert jede Dateizeile als FHEM Befehl. Dieses Befehl sollte nur von Experten verwendet werden.

### inform

`inform {on|off|timer|raw} [regexp]`
Ermöglicht Event-Verfolgung über das telnet Interface. Es ist das telnet Equivalent des FHEMWEB Event-Monitors, es kann aber auch von weiteren Programmen zur Benachrichtigung verwendet werden. Optionen:

- on
  aktiviert die Benachrichtigung.
- onWithState
  zeigt auch das zusätzliche state Event
- off
  deaktiviert die Benachrichtigung (sowohl Events wie auch Logs, s.u.)
- raw
  zeigt (nur) die raw Events der physikalischen Module
- timer
  stellt der Daten ein Zeitstempel vor
- log
  zeigt die vom FHEM Log Interface protokollierten Daten
- status
  zeigt den aktuellen Status

### list

`list [devspec] [value]`
oder
`list {-r|-R} devspec`
Auflistung aller "definitions", "notify" und "at"-Definitionen. Dies ist eines der wenigen Befehle, die im Normalfall eine Zeichenkette ausgeben.
Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Wenn value angegeben ist, der von ( DEF, TYPE, usw) oder reading (actuator, measured-temp) für alle Geräte die in devspec angegeben sind.
Beispiel:

    fhem> list

      Type list  for detailed info.

      Internal:
        global               (Internal)

      FHZ:
        FHZ                  (fhtbuf: 23)

      FS20:
        Btn4                 (on-old-for-timer)
        Roll1                (on)
        Stehlampe            (off)

      FHT:
        fl                   (measured-temp: 21.1 (Celsius))

      KS300:
        out1                 (T: 2.9  H: 74  W: 2.2  R: 8.2  IR: no)

      at:
        at_rollup            (Next: 07:00:00)

      notify:
        ntfy_btn4            (active)

      FileLog:
        avglog               (active)

Wenn Sie für `name` einen Gerätenamen eingeben, dann erhalten Sie einen genauen Status für das in`name` angegebene Gerät angezeigt, z.B.:

      fhem> list fl

      Internals:
        CODE       5102
        DEF        5102
        NAME       fl
        NR         15
        STATE      measured-temp: 21.1 (Celsius)
        TYPE       FHT
        IODev      FHZ
      Attributes:
        room       Heizung
      Readings:
        2006-11-02 09:45:56   actuator        19%
        [...]

Mit der -r (raw) Option werden die Daten in einem für fhem.cfg bzw. fhem.state passenden Format generiert. -R liefert diese Daten auch für alle von diesem Gerät vermutlich benögten Geräte. Achtung: die Bestimmung dieser Liste ist ungenau.

### modify

`modify <name> <type-dependent-options>`
Dieser Befehl wird benutzt, um Definitionen zu verändern. Er ist nützlich, um at oder notify Definitionen zu verändern. Wenn Sie einen Wert einer an Definition verändern, dann wird nur der für die Zeit zuständige Teil geändert. Im Falle der Veränderung einer Definition vom Typ "notify" wird nur der regex Teil geändert. Alle anderen Werte (Stati, Attribute, etc) bleiben erhalten. After modify, the global event "MODIFIED" will be generated. Nach der Durchführung das globale Ereignis "MODIFIED" wird generiert.
Beispiel:

`define lampon at 19:00 set lamp on`
`modify lampon *19:00`
`modify lampon 19:00 set lamp on-for-timer 16`

### quit

`quit`
Dieser Befehl wird in einer TCP/IP Session benutzt um die Client-Sitzung zu beenden.
Wird dieser Befehl in einem Skript benutzt, wird das abarbeiten des Skriptes beendet.
Beispiel:

`quit`

### reload

`reload <module>`
Reload the given module from the module directory. It is a convenient way to test modules whithout restarting the program.
Example:

`reload 99_PRIV`

### rename

`rename <oldname> <newname>`
Benennt ein Gerät von <oldname> in <newname>, einschliesslich der Attribute, um. Das globale Ereignis "RENAMED" wird erstellt, Lesen Sie bitte den Abschnitt "notify" durch um Details zu erfahren.
Beispiel:

`rename FHT_1234 fht.kitchen`

### rereadcfg

`rereadcfg [fhem-config-file]`
Liest entweder die aktuelle Konfigurationsdatei oder die angegebene Datei ein.
Der Ablauf ist dabei wie folgt: Zuerst wird das statefile gesichert. Dann werden alle Geräte gelöscht. Dann wird die aktuelle Konfigurationsdatei (oder die angegebene Datei) eingelesen zuletzt wird das statefile neu eingelesen.
Wenn dieser Ablauf abgeschlossen ist, wird das globale REREADCFG Ereignis ausgelöst. Alle existierenden Verbindungenwerden bis zum "rereadcfg" Ereignis getrennt.
Beipiel:

`rereadcfg`

### save

`save [<configfile>]`
Sichert zuerst das statefile und dann das configfile. Wenn ein Parameter angegeben wird dieser anstelle der allgemeinen Konfigurationsdatei benutzt.
Hinweise:

- Der Befehl speichert nur "definitions" und "attributes" aber keine (set/get) Befehle die vorher Teil der Konfigurationsdatei waren. Wenn Sie solche Befehle nach der Initialisierung (z.B. FHTcode) benötigen,dann müssen Sie sie mit notify triggern wenn das INITIALIZED Ereignis eintritt.
- Der Befehl "save" versucht Kommentarzeilen (Zeilen die mit # beginnen) und "include"-Zeilen zu erhalten, aber arbeitet nicht korrekt wenn FHEM für diese Dateien keine Schreibrechte besitzt.
- Vor dem Überschreiben der Dateien wird die alte Version gesichert, siehe restoreDirs für Einzelheiten.

### set

`set <devspec> <type-specific>`
Der Befehl setzt Geräteparameter/sendet Signale an ein Gerät. Sie erhalten eine Liste verfügbarer Parameter wenn Sie folgendes eingeben:

`set <name> ?`

Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Der "set"-Befehl gibt nur bei Fehler einen Wert zurück.
Jedes Gerät hat verschiedene Parameter die mit "set" gesetzt werden können. Lesen Sie bitte den entsprechenden Abschnitt für das Gerät für Details durch.
Ab featurelevel 5.7 ersetzt der set und setreading Befehl

- [device:name] mit dem Wert des Readings, Internals oder Attributes für device, falls sowohl device, als auch Reading, Internal oder Attribut existiert, und nicht leer ist.
  - Man kann einen der Präfixe r:, i: oder a: verwenden, um die Suche einzuschränken, genau wie im devspec.
  - Das Suffix :d extrahiert die erste Zahl.
  - Das Suffix :i extrahiert die erste Zahl als Ganzzahl.
  - Das Suffix :r<n> extrahiert die erste Zahl, und rundet sie auf <n> Dezimalstellen. Falls <n> fehlt, dann wird auf eine Dezimalstelle gerundet.
  - Das Suffix :t liefert den Zeitstempel des Readings
  - Das Suffix :sec liefert Anzahl der Sekunden seit Änderung des Readings.
  Beispiel:
  set Lamp blink [blinkDummy:number] [r:blinkDummy:duration:d]
- {(perlExpression)} mit dem Ergebnis der perlExpression. $DEV wird dabei mit dem Namen des vom set betroffenen Gerätes ersetzt.

Diese Ersetzungen sind unter dem Namen "set magic" bekannt.
Manche Module unterstützen die sog. set extensions, und in der entsprechenden Dokumentation ist ein Link auf diesem Text zu finden. Falls im Modul selber einer der unten aufgeführten Befehle implementiert ist, dann wird die Modul-Implementation verwendet.

- on-for-timer <sekunden>
  Das Gerät wird per "on" eingeschaltet, und ein interner Zeitgeber wird erstellt, um nach <sekunden> ein "off" Kommando auszuführen. Um diesen Zeitgeber zu entfernen sollte man das Kommando mit dem Argument 0 erneut aufrufen. Achtung: dieser Zeitgeber wird bei einem restart nicht gespeichert.
- off-for-timer <sekunden>
  siehe on-for-timer.
- on-till <timedet>
  Das Gerät wird per "on" eingeschaltet, und ein at Instanz wird definiert, um es um <timedet> (Format: HH:MM[:SS]) per off auszuschalten. Diese at Instanz ist sichtbar unter dem Namen geräteName+"_till". Um das Ausschalten zu deaktivieren löscht man diese at Definition. Achtung: das Ein/Ausschalten wird nicht durchgeführt, falls die aktuelle Uhrzeit nach der spezifizierten Zeit ist, um folgende Szenarien zu vereinfachen:
  `define morningLight at *06:00 set Lamp on-till {sunrise()}`
- on-till-overnight <timedet>
  Wie on-till, aber die aktuelle Uhrzeit wird nicht mit der Spezifizierten verglichen, damit folgendes funktioniert:
  `define nightLight at *{sunset()} set Lamp on-till-overnight 01:00`
- off-till <timedet>
  siehe on-till.
- off-till-overnight <timedet>
  siehe on-till-overnight.
- blink <anzahl> <blink-periode>
  Das Gerät wird mit "on" für die <blink-periode> eingeschaltet, und das wird nach <blink-periode> wiederholt. Um das Blinken vorzeitig zu stoppen spezifiziert man "0 0" als Argument.
- intervals <from1>-<till1> <from2>-<till2>... Das Gerät wird für die spezifizierten Intervalle eingeschaltet. Die einzelnen Intervalle sind Leerzeichen getrennt, und ein Intervall besteht aus zwei Zeitspezifikationen, die mit einem "-" getrennt sind.
- toggle
  Das Gerät wird mit "on" eingeschaltet, falls STATE "off" ist (oder dim 0), sonst wird es mit "off" ausgeschaltet.

Beispiele:

`set switch on-for-timer 12.5
set switch on-till {sunset()}
set switch blink 3 1
set switch intervals 08:00-12:00 13:00-18:00
`

attrTemplate
mit diesem Befehl kann man eine Menge an vordefinierten Attributen setzen. Die Einträge befinden sich in Dateien im FHEM/lib/AttrTemplate Verzeichnis. Einträge können modul-spezifisch sein, und möglicherweise erfordern weitere Parameter.

### setdefaultattr

`setdefaultattr [<attrname> [<value>]]`
Fügt Sie ein Standardattribut hinzu. Jedem nach dieser Zuweisung definierte Gerät wird dieses Attribut zugewiesen. Wenn kein "attrname" angegeben wird, dann wird die Liste der Standardattribute gelöscht.
Beispiel, um das Attribut "room kitchen" und "loglevel 4" allen Lampen zuzuweisen:

`setdefaultattr room kitchen`
`setdefaultattr loglevel 4`
`define lamp1 FS20 1234 11`
`define lamp2 FS20 1234 12`
`define lamp3 FS20 1234 13`
`setdefaultattr`

Anmerkungen:

- es gibt keine Möglichkeit, ein einzelnes Standardattribut aus der Liste tu löschen.

### setreading

`setreading <devspec> <reading> <value>`
Der Befehl setzt das Reading <reading> auf den Wert <value> ohne Signale an das betroffene Gerät zu senden, generiert aber Ereignisse und die übliche eventMap und stateFormat Umwandlung wird auch durchgeführt.
Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec> und die Beschreibung des set Befehls für Ersetzung.
Beispiel:

setreading lampe state on

Achtung: setreading generiert kein Event für ein Gerät X, falls es aus einem notify für Gerät X aufgerufen wurde. In so einem Fall könnte man auf "sleep 0.1; setreading X Y Z" ausweichen.

### setstate

`setstate <devspec> <value>`
Der Befehl setzt den STATE Eintrag des Gerätes direkt, ohne Ereignisse zu generieren oder ein Signal an das Gerät zu senden. Dieser Eintrag ist maßgebend für die Status-Anzeige in diversen Frontends. Dieser Befehl wird auch im statefile benutzt.
Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Beispiel:

setstate lampe An

### setuuid

`setuuid <device> <uuid>`
Systembefehl, um den FUUID internen Wert zu setzen. Ist nicht vom Benutzer zu verwenden.

### shutdown

`shutdown [restart] [exitValue]`

Der Befehl fährt FHEM herunter (nach dem Sichern aller Gerätestatus). Er triggert den `global:SHUTDOWN`-Event. Mit dem optionalen Parameter restart startet FHEM danach neu. Der exitValue ist möglicherweise bei bestimmten Start-Skripten zur korrekten Funktion vonnöten bzw. wichtig.

Beispiel:

`shutdown`
`shutdown restart`
`shutdown 1`

### sleep

`sleep <sec> [<id>] [quiet]`
sleep gefolgt von weiteren Befehlen ist vergleichbar mit einem namenlosen at Kommando, es führt die nachfolgenden Befehle aus, nachdem es die spezifizierte Zeitspanne gewartet hat. Die Einheit ist Sekunde, Millisekunden genau, da man Nachkommastellen spezifizieren kann.
Ein sleep mit einer <id> ersetzt ein sleep mit der gleichen <id> and can mit cancel entfernt werden. Falls sleep in at/notify/etc aufgerufen wurde, und die nachfolgenden Kommandos einen nicht leeren Text zurückgeliefert haben, dann wird dieser Text mit loglevel 2 protokolliert.
quiet vermeidet diese Protokollierung.
Beispiele:

`sleep 0.5`
`define n3 notify btn3.* set lamp toggle;;sleep 0.5;;set lamp toggle`
`define a3 at +*00:05 set Windsensor 1w_measure;; sleep 2 quiet;; get Windsensor 1w_temp`

Bemerkung: falls sleep von keinem Befehl gefolgt wird, dann wird FHEM blockiert. Das ist unerwünscht, und im FHEM-Log wird eine Warnung protokolliert.

### trigger

`trigger <devspec> <event>`
Generiert das Ereignis <event>, was z.Bsp. ein notify anstoßen kann, oder den FileLog zum protokollieren dieser Zeile bewegen kann.
Siehe den Abschnitt über Geräte-Spezifikation für Details der <devspec>.
Beispiel:

`trigger btn3 on`

### global

Das "global" Gerät wird benutzt, um allgemeingültige Attribute zu setzen. Es wird automatisch erstellt und kann nicht gelöscht oder umbenannt werden. Es hat keine "set" oder "get" Parameter.
Define

N/A

Set

N/A

Get

N/A

Attributes

- altitude
  Höhe in Metern über dem Meeresspiegel, Voreinstellung ist 0.
- archivedir
- archivecmd
- nrarchive
- archivesort
  archivesort kann auf dem (voreingestellten) Wert alphanum oder timestamp gesetzt werden, und bestimmt die Methode für die Reihenfolgenberechnung der Dateien für nrarchive.
- autoload_undefined_devices
  wenn dieses Attribut gesetzt ist, werden die zu einer neu empfangenen Nachricht zugehörigen Module automatisch geladen. Dies erfolgt vom autocreate Gerät, um so automatisch ein FHEM-Gerät bei erreichen einer entsprechenden Nachricht zu erstellen.
- backupcmd
  Sie können das Update durch Ihre eigenen Befehle/Skripts durchführen indem Sie dieses Attribut setzen. Wenn dieses Attribut gesetzt ist, dann startet es als ein SHELL-Befehl und erstellt eine durch Leerzeichen getrennte Liste von Dateien/Verzeichnissen als ein Argument zum Befehl, z.B.:
  `"/etc/fhem.cfg /var/log/fhem/fhem.save /usr/share/fhem/contrib /usr/share/fhem/FHEM /usr/share/fhem/foo /usr/share/fhem/foobar /usr/share/fhem/www"`
  Bemerkung: Ihr Befehl/Skript muss die Zeichenkette "backup done" zurückgeben oder eine entsprechende Zeichenkette um Fehlermeldungen auszugeben, damit die Zusammenarbeit mit update funktioniert!
  Dieses Attribut wird vom backup Befehl benutzt.
  Beispiel:
  attr global backupcmd /usr/local/bin/myBackupScript.sh
- backupdir
  Ein Ordner um die komprimierten Sicherheitsdateien zu speichern. Dieses Attribut wird vom backup Befehl benutzt.
  Beispiel:
  attr global backupdir /Volumes/BigHD
- backupsymlink
  Wenn dieses Attribut auf etwas anderes als "no", dann unterstützt der Archviierungsbefehl "tar" symbolische Links in Ihrem Backup. Andererseits, wenn dieses Attribut auf "no" gesetzt ist werden symbolische Links vom Befehl "tar" ignoriert. Dieses Attribut wird vom backup Befehl benutzt.
  Beispiel:
  attr global backupsymlink yes
- blockingCallMax
  Begrenzt die Anzahl der parallel laufenden Prozesse, die von der BlockingCall FHEM Hilfsroutine gestartet wurden. Sinnvoll auf weniger leistungsfaehigen Hardware.
- configfile
  Enthält den Namen der FHEM Konfigurationsdatei. Wenn save ohne Argumente aufgerufen wird dann wird die Ausgabedatei unter diesem Dateinamen gespeichert.
- commandref
  Falls der Wert "full" (die Voreinstellung) ist, dann wird nach jedem update ein komplettes commandref.html generiert. Falls der Wert "modular" ist, dann wird die Moduldokumentation erst nach Bedarf waehrend der Laufzeit per JavaScript geladen.
- dnsHostsFile
  Falls dnsServer gesetzt ist, wird die angegebene Datei nach dem Hostnamen durchsucht. Um die vom System verwendete Datei zu benutzen, ist es unter Linux/Unix/OSX auf /etc/hosts und unter Windows auf C:\windows\system32\drivers\etc\hosts zu setzen. Achtung: es wird nur IPv4 unterstützt.
- dnsServer
  Enthält die IP Adresse des DNS Servers. Die von bestimmten Modulen (oder eigenen Code) aufgerufene HttpUtils_NonblockingGet wird auch bei der DNS Auflösung nicht mehr blockieren, falls dieses Attribut gesetzt ist, da es in diesem Fall FHEM eigene Routinen aufgerufen werden. Sonst werden die OS-eigenen, blockierenden Routinen inet_aton bzw gethostbyname aufgerufen.
- featurelevel
  Aktiviere bzw. deaktiviere bestimmte alte oder neue Funktionen, basierend auf die FHEM Version. Z.Bsp. das $value hash für notify wird nur bis featurelevel 5.6 befüllt, da es unerwünscht ist. Stattdessen sollte man die Value() Funktion verwenden.
- holiday2we
  Wenn dieses Attribut gesetzt wurde, dann wird die $we Variable als "true" betrachtet, wenn der Wert der holiday Variable zu diesem Attribut nicht "none" ist.
  Falls es eine Komma getrennte Liste ist, dann ist es wahr, falls einer der referenzierten Instanzen nicht "none" ist.
  Beispiel:
  attr global holiday2we hessen
- httpcompress
  das HttpUtils Modul wird von etlichen FHEM modulen verwendet und aktiviert Komprimierung in der Voreinstellung. Falls man httpcompress auf 0 setzt, wird die Komprimierung deaktiviert.
- keyFileName
  FHEM Module speichern Passwörter und IDs in der Datei FHEM/FhemUtils/uniqueID. Um mehrere FHEM-Instanzen im gleichen Verzeichnis starten zu können, kann man dieses Attribut setzen, dessen Wert an FHEM/FhemUtils/ angehängt wird.
- latitude
  Geographische Breite in Dezimalgrad, Voreinstellung ist 50.112, Frankfurt am Main.
- longitude
  Geographische Länge in Dezimalgrad, Voreinstellung ist 8.686, Frankfurt am Main.
- logdir
  Falls gesetzt, wird %L in dem logfile Attribut (oder in der Dateinamen Spezifikation des FileLog Moduls) durch den Wert des Attributes ersetzt. Achtung: ändern des Wertes bewirkt nicht das Verschieben bereits erstellter Dateien, und kann zu diversen Problemen führen.
- logfile
  Gibt das Logfile an, in welches gespeichert werden soll. Sie können "-" für die Ausgabe in das stdout-Gerät. In diesem Fall stellt sich der Server nicht selbst in den Hintergrund.
  Der Name der Logdatei kann auch "wildcards" enthalten, um eine einfachere Abfolge für die Dateien zu erreichen. Lesen Sie bitte den Abschnitt FileLog. Fügen Sie die Attribute `archivecmd / archivedir / nrarchive` zum `global` Gerät hinzu wie Sie es auch bei einem FileLog device tun könnten.
  Sie können den Namen der Logdatei mit `{ $currlogfile }festlegen`.
- maxShutdownDelay
  Einige Module benötigen Zeit zum Aufräumen beim shutdown, aber FHEM begrenzt diese Zeit auf 10 Sekunden. Mit diesem Attribut kann man sie anpassen.
- modpath
  Mit modpath geben Sie den Pfad zu dem Verzeichnis der `FHEM` Module an. Der Pfad enthält nicht das Verzeichnis FHEM. Durch das setzen der Attribute, wird das Verzeichnis nach Dateinamen in der Form NN_<NAME>.pm durchsucht, und sie werden für die Definition von Geräten unter dem Namen <NAME> verfügbar gemacht. Wenn das erste Gerät des Typs <NAME> definiert wird, werden die entsprechenden Module geladen und in dem Modul die entsprechende Funktion mit dem Namen <NAME>_Initialize wird aufgerufen. Eine Ausnahme bilden Module die mit der Nummer 99 im Dateinamen beginnen. Diese enthalten PERL-Hilfsfunktionen und werden zur Startzeit geladen.
- motd
  Nachricht des Tages. Wird im Begrüßungsbildschirm von FHEM angezeigt, oder direkt beim Start einer "telnet" Sitzung, bevor der fhem> Prompt erscheint. Der SecurityCheck setzt motd wenn es bisher nicht gesetzt ist. Um das zu verhindern, können sie den Wert von motd auf "none" setzen. motd wird auch verwendet, um Fehlermeldungen während des FHEM-Starts zu sammeln und anzuzeigen.
- mseclog
  Wenn dieses Attribut gesetzt ist, enthalten Datums/Zeiteinträge (timestamp) in der Logdatei einen Millisekunden-Eintrag.
- nofork
  Wenn dieses Attribut oder "attr global logfile -" gesetzt ist, dann wird FHEM nicht im Hintergrund abgearbeitet. Dieses Attribut ist bei einigen FHEM Installationen auf FRITZ!-Boxen notwendig, und wid fuer Windows automatisch gesetzt.
- pidfilename
  Schreibt die PERL Prozess-ID in die angegebene Datei. Der Server läuft als Daemon und einige Distributionen wollen anhand der PID testen, ob der FHEM Prozess läuft. Die Datei wird bei Ausführung des "shutdown"-Kommandos gelöscht.
- proxy
  IP:PORT des proxy Servers, wird von HttpUtils benutzt.
- proxyAuth
  Base64 kodiertes Benutzername:Passwort
- proxyExclude
  Regexp, um bestimmte Hosts nicht via proxy zu kontaktieren.
- restoreDirs
  update sichert jede Datei vor dem Überschreiben mit der neuen Version aus dem Web. Für diesen Zweck wird zuerst ein restoreDir/update Verzeichnis in der global modpath Verzeichnis angelegt, und danach ein Unterverzeichnis mit dem aktuellen Datum. In diesem Verzeichnis werden vor dem Überschreiben die alten Versionen der Dateien gerettet. Die Voreinstellung ist 3, d.h. die letzten 3 Datums-Verzeichnisse werden aufgehoben, und die älteren entfernt.
  Auch fhem.cfg und fhem.state wird auf diese Weise vor dem ausfüren von save gesichert, diesmal in das restoreDir/save Verzeichnis. Zum restaurieren der alten Dateien kann man das restore Befehl verwenden.
  Falls man den Wert auf 0 setzt, dann ist dieses Feature deaktiviert.
- sendStatistics
- statefile
  Dieses Attribut legt den Namen der Datei fest, in die Statusinformationen aller Geräte gespeichert werden bevor der Server heruntergefahren wird. Falls diese Datei nicht angegeben wird, so werden keinerlei Informationen gesichert.
- title
- useInet6
  Die HttpUtils Routinen verwenden IPv6 für die Kommunikation, falls der Server eine IPv6 Adresse hat. Achtung: das Perl-Modul IO::Socket::INET6 wird benötigt.
- userattr
  Enthält eine durch Leerzeichen getrennte Liste in welcher die Namen zusätzlicher Attribute aufgeführt sind. Diese müssen zuerst in dieser Liste definiert werden, bevor sie (bei allen Geräten) angewendet werden können.
  userattr kann auch für einzelne Geräte spezifiziert werden, um weitere Attribute für diese Geräte zu definieren.
- dupTimeout
  Definert die Wartezeit, nach der 2 identische Ereignisse zweier Empfänger als Duplikat angesehen werden. Voreingestellt sind 0,5 Sekunden.
- showInternalValues
  Attribute/Geräte-Eintraege/Readings die mit Punkt (.) anfangen werden nicht angezeigt, es sei denn das globale Attribut showInternalValues ist gesetzt. Diese Variable wird bei dem list und xmllist Befehl, und bei der FHEMWEB Raumansicht geprüft.
- sslVersion
  Setzt die akzeptierten Crypto-Algorithmen im TcpServices Hilfsmodul. Die Voreinstellung TLSv12:!SSLv3 wird als sicherer erachtet als die vorherige SSLv23:!SSLv3:!SSLv2, aber sie kann Probleme mit nicht ausreichend aktualisierten Netzwerk-Diensten verursachen.
- stacktrace
  Falls gesetzt (auf 1), schreibt ins FHEM-Log zusätzlich zu jedem "PERL WARNING" den stacktrace.
- restartDelay
  Setzt die Verzögerung beim Neustart mit shutdown restart, die Voreinstellung ist 2 (Sekunden).
- autosave
  Erlaubt manchen Modulen save auszuführen, nach einer automatischen Änderung der Konfiguration, z.Bsp. nachdem ein Gerät angelegt wurde. Die Voreinstellung ist 1 (wahr), man kann es ausschalten, indem man den Wert auf 0 setzt.

Events

- INITIALIZED
  sobald die Initialization vollständig ist.
- REREADCFG
  nachdem die Konfiguration erneut eingelesen wurde.
- SAVE
  bevor die Konfiguration gespeichert wird.
- SHUTDOWN
  bevor FHEM heruntergefahren wird.
- DEFINED <devname>
  nach dem Definieren eines Gerätes.
- DELETED <devname>
  nach dem Löschen eines Gerätes.
- RENAMED <old> <new>
  nach dem Umbenennen eines Gerätes.
- UNDEFINED <defspec>
  beim Auftreten einer Nachricht für ein undefiniertes Gerät.
- MODIFIED <defspec>
  nach Änderung einer Gerätedefinition.
- UPDATE
  nach Abschluss eines Updates.

### Perl specials

Wenn Sie einige Aufgaben automatisieren wollen, dann sollten Sie die Befehle at oder notify nutzen. Für komplexere Aufgaben sollten Sie lieber ein SHELL-Skript oder einen PERL "oneliner" als das at/notify argument anwenden. Dieser Abschnitt gibt Ihnen einige Tipps zur Anwendung der PERL-oneliner.
- Um PERL-"oneliner" zu testen, geben Sie diese am "telnet" Prompt (oder in der FHEMWEB Text-Eingabezeile) eingeschlossen von geschweiften Klammern {} in einer Zeile ein. Die letzte Beispielzeile schreibt nur etwas in die Logdatei, während das Ergebnis der anderen Zeilen direkt auf der Webseite sichtbar ist.
  Beispiele:

  { "Hello" }
  { 1+3*4 }
  { `ls /etc` }
  { Log 1, "Hello" }

- PERL Ausdrücke werden durch ein Semikolon (;) getrennt. In FHEM "oneliners" müssen sie durch ein weiteres Semikolon (;;) "escaped" (maskiert) werden
  Beispiel:
  { my $a = 1+1;; Log 1, "Hello $a" }
- Um FHEM-Kommandos in den PERL-Ausdrücken zu verwenden, benutzen Sie bitte die Funktion fhem(), mit einem Textargument. Dieser Text wird als FHEM-Kommando interpretiert.

  Beispiel

  { fhem "set light on" }
  define n1 notify piri:on { fhem "set light on" }

  Bemerkung: Wenn diese Funktion einen wert zurück liefert, wird dieser in der allgemeinen Logdatei gespeichert.. Benutzen sie "1" als zweites Argument um dieses speichern zu verhindern. Sinnvoll ist dieses Argument bei der Abfrage von Werten mittels "get...".
- Notify kann auch dazu verwendet werden, um Macros manuell auszuführen. Verwenden Sie den trigger-Befehl um das Makro zu starten:
  define MyMacro notify MyMacro { Log 1, "Hello"}
  trigger MyMacro
  define MacroWithArg notify MyMacro { Log 1, "Hello %"}
  trigger MyMacro MyArg
- Um die Verwendung von Datum und Zeitangaben zu vereinfachen, wurden die Variablen $sec, $min, $hour, $mday, $month, $year, $wday, $yday, $isdst und $hms für die Verwendung in PERL-"oneliners" eingeführt (s. unter perldoc -f localtime). Ausnahmen: $month hat einen Wertebereich von 1 bis 12 und $year ist korrigiert von 1900. Weiterhin enthält $hms die Zeit in dem HH:MM:SS Format und $today das aktuellen Datum in YYYY-MM-DD Format.
  Die Variabe $we hat den Wert 1 wenn der abgefragte Tag auf ein Wochenende fällt (Z.B. $wday == 0 [Sonntag] oder $wday == 6 [Samstag]), und 0 für die anderen Wochentage. Wenn man das global holiday2we Attribut setzt, dann ist $we ebenfalls 1 bei Urlaubstagen.
  define n2 notify piri:on { if($hour > 18 || $hour < 5) { fhem "set light on" } }
  define roll_en *07:45:00 { fhem "trigger SwitchAllRoll on" if(!$we) }
  define roll_en *08:30:00 { fhem "trigger SwitchAllRoll on" if($we) }
- Die folgenden Hilfsfunktionen sind in der Datei 99_Util.pm definiert (wird wie jede mit 99_ beginnende Datei automatisch geladen):
  - min(a,b), max(a,b)
  - time_str2num("YYYY-MM-DD HH:MM:SS") gibt einen numerischen Wert zurück, der die Berechnung von Zeitdifferenzen vereinfacht
  - abstime2rel("HH:MM:SS") wandelt absolute in relative Zeitangaben um
- Um auf die Gerätestatus/Attribute zuzugreifen benutzen Sie bitte die folgenden Funktionen:
  - Value(<devicename>)
    gibt den Status eines Gerätes zurück (entsprechend dem Ausdruck in Klammern, den Sie beim List-Befehl sehen).
  - OldValue(<devicename>)
  - OldTimestamp(<devicename>)
    gibt den vorherigen Wert/Zeitstempel des Gerätes zurück.
  - ReadingsVal(<devicename>,<reading>,<defaultvalue>)
    Gibt den Inhalt der "readings" zurück (den Inhalt der in dem "Readings"-Abschnitt von "list device" angezeigt wird)
  - ReadingsNum(<devicename>,<reading>, <defaultvalue>,<round>)
    Gibt die erste Zahl aus dem Readingswert zurück. Falls <round> spezifiziert ist, wird sie auf diese Anzahl von Dezimalstellen gerundet.
  - ReadingsTimestamp(<devicename>, <reading>,<defaultvalue>)
    gibt den Zeitstempel des Readings zurück.
  - ReadingsAge(<devicename>,<reading>,<defaultvalue>)
    gibt das Alter des Readings in Sekunden zurück.
  - OldReadingsVal(<devicename>,<reading> ,<defaultvalue>)
    OldReadingsNum(<devicename>,<reading>, <defaultvalue>,<round>)
    OldReadingsTimestamp(<devicename>,<reading> ,<defaultvalue>)
    OldReadingsAge(<devicename>,<reading>,< defaultvalue>)
    analog zu den Routinen oben, aber zum Zugriff auf die vorherigen Werte. siehe: oldreadings
  - AttrVal(<devicename>,<attribute>,<defaultvalue>)
    Gibt das entsprechende Attribut des Gerätes zurück
    { Value("wz") }
    { OldValue("wz") }
    { time_str2num(OldTimestamp("wz")) }
    { ReadingsVal("wz", "measured-temp", "20")+0 }
    { ReadingsTimestamp("wz", "measured-temp", 0)}
    { AttrVal("wz", "room", "none") }
  - AttrNum(<devicename>,<attribute>, <defaultvalue>,<round>)
    Gibt die erste Zahl aus dem Attributwert zurück. Falls <round> spezifiziert ist, wird sie auf diese Anzahl von Dezimalstellen gerundet.
  - InternalVal(<devicename>,<internal>, <defaultvalue>)
    Gibt den Inhalt der "internal" zurück (den Inhalt der in dem "Internals"-Abschnitt von "list device" angezeigt wird)
  - InternalNum(<devicename>,<internal>, <defaultvalue>,<round>)
    Gibt die erste Zahl aus dem "internal" zurück. Falls <round> spezifiziert ist, wird sie auf diese Anzahl von Dezimalstellen gerundet.
- Wenn Sie das 99_SUNRISE_EL.pm Modul benutzen, haben Sie zugriff auf folgende Funktionen:
  sunset($offset, $min, $max)
  sunrise($offset, $min, $max)
  isday()
  Der Wert von "offset" wird in Sekunden angegeben und das Format für min/max ist "HH:MM" oderr "HH:MM:SS". isday gibt 1 zurück, wenn die Sonne sichtbar ist und ansonsten den Wert 0.

### gnuplot file syntax

Die .gplot Dateien werden ebenso von den FHEMWEB/SVG Modulen falls das plotmode-Attribut auf SVG gesetzt ist. In diesem Fall wird nur eine geringere Anzahl der .gnuplot Attribute benutzt, und einige Linien haben eine besondere Bedeutung: Die Unterschiede werden in diesem Kapitel erklärt. Lesen Sie bitte auch diesen FHEM Wiki Eintrag zur Erstellung von Logdateien.
Im folgenden ist eine minimale .gplot Definition (gültig nur bei Plotmode SVG):

      set terminal size <SIZE>
      #FileLog 4:::
      plot title 'Temperature' with lines

Die .gnuplot Datei besteht aus 3 Teilen:

- set Befehle
  Folgende "sets" werden erkannt:
  - terminal, nur die Größenparameter.
    Dieser ist in der Regel auf <SIZE> gesetzt, welcher ersetzt wird durch das plotsize Attribut von FHEMWEB oder einer Weblink-Instanz.
  - title
    Normalerweise gesetzt auf <TL> welcher durch das Weblink title-Attribut, oder durch <Lx>, welches wiederum vom Weblink label Attribut ersetzt wird.
  - ylabel,y2label
    Linke und rechte vertikale Achsenbeschriftungen. Are also subject to label replacement.
  - yrange,y2range
    Legen den Wertebereich der linken und rechten y-Achse fest. Beispiele:
    set yrange [-0.1:1.1]
    set y2range [0:]
  - ytics,y2tics
    Beschriftung für die Werte der rechten/linken y-Achse. Beispiele:
    set ytics ("on" 0, "off" 1)
    set y2tics
- #FileLog Einträge
  Jede Line des Plots muss eine dazugehörige #FileLog Zeile haben. Zur Syntax lesen Sie bitte den Abschnitt "column_spec paragraph" von der Filelog get Beschreibung. Beachten sie bitte, das bei SVG-Plots die erste Spalte der Datei unbedingt im FHEM-Zeitstempelformat (YYYY-MM-DD_HH:MM:SS) formatiert sein muss
- Plot Einträge
  bestehen immer aus einem Plotbefehl und aus durch Kommata getrenne Argumentblöcke. Jeder Argumentblock repräsentiert eine darzustellende Linie und hat seine eigenen Paramter. Folgende Parameter werden are anerkannt:
  - axes x1y1 / x1y2
    weist das Programm an die aktuelle Zeile einer der beiden Achsen (links oder rechts) zuzuweisen.
  - title
    Beschriftung der Linie. Wenn man auf diesen Titel klickt, dann ändert ein kleines Javascript-Programm den Titel auf die min/max und last-Werte des Plots, Weiterhin erlaubt das Programm diese Linie zu kopieren oder eine bereits kopierte Linie einzufügen (die existierende Skalierung des Plots wird dabei nicht verändert, nur die eingefügte Linie wird skaliert/angepasst. Andere Linien des Plots werden zeitweise nicht angezeigt.
  - with <linetype>
    spezifiziert die Art der Linie. Folgende Linienarten können verwendet werden: points, steps, fsteps, histeps and lines. Nicht bekannte Linienarten werden als Typ "lines" dargestellt. SVG Spezial: cubic und quadratic werden zu den SVG path Typen C und Q gewandelt.
  - ls <linestyle>
    Der Linienstil stellt die erste Linie als l0 dar, die zweite Linie als l1 und so weiter. Definiert ist dies in der svg_style.css Datei. Darin sind zwei Sets definiert: l0-l8 and l0fill-l6fill. Das zweite Set muss aber explizit angegeben werden. Wenn der Name des Linienstils das Wort "fill" enthält, dann haben Plots des Linientyps "lines" ein zusätzliches Start- und Endsegment für eine korrekte Darstellung.
    Bitte lesen sie die SVG Spezifikationen, um Details über diese css-Datei zu erfahren. Notiz: Wenn Sie dieses Attribut einsetzen möchten, müssen Sie es für alle Linien (Attributblocks) im Plotbefehl spezifizieren.
  - lw <linewidth>
    Setzt die Linienbreite der Linie. Dieses Attribut ist veraltet. Das entprechende Feature der css-Datei/(Attribut ls) muss verwendet werden.