FHEM Referenz

Perl special

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 onAt at 07:00 set Lamp1 on;;set Lamp2 on;; define offAt at +00:10 set Lamp1 off;;;;set Lamp2 off

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

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)

[EN DE]

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.

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

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

[EN DE]

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:
Die explizite Variante dieses Attributes hat folgenden Syntax:
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.

Wenn beide Attribute nicht gesetzt sind erzeugt jede Aktualisierung eines jeden "readings" eines Gerätes ein Ereignis.
Wenn eines der Attribute gesetzt ist, erzeugen nur Updates oder änderungen von "readings" die in einem der Attribute gesetzt sind ein Ereignis.
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

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:
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:
<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:
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

[EN DE]

attr [-a|-r] <devspec> <attrname> [<value>]

define


    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

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

cancel

[EN DE]

cancel [<id> [quiet]]

sleep

define

[EN DE]

define [option] <name> <type> <type-specific>

-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

[EN DE]

defmod [-temporary] <name> <type> <type-specific>


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

delete

[EN DE]

delete <devspec>

define

delete lamp

deleteattr

[EN DE]

deleteattr <devspec> [<attrname>]

attr

deleteattr lamp follow-on-for-timer

deleteattr lamp

deletereading

[EN DE]

deletereading <devspec> <readingname>

deletereading mySensor temp1

deletereading mySensor temp\d+

displayattr

[EN DE]

displayattr <devspec> [<attrname>]


    fhem> di WEB

    menuEntries AlarmOn,/fhem?cmd=set%20alarm%20on

    room Misc.

    fhem> di WEB room

    Misc.

get

[EN DE]

get <devspec> <type-specific>

get <device> ?

getstate

[EN DE]

getstate <devspec>


  getstate lamp

  state:1

  

  getstate fl

  ack:0 actuator:2 day-temp:21.5 desired-temp:22.5 [...] measured-temp:22.9 [...]

include

[EN DE]

include <filename>

inform

[EN DE]

inform {on|off|timer|raw} [regexp]

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

[EN DE]

list [devspec] [value]

list {-r|-R} devspec

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)

name

  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%
    [...]

modify

[EN DE]

modify <name> <type-dependent-options>

define lampon at 19:00 set lamp on

modify lampon *19:00

modify lampon 19:00 set lamp on-for-timer 16

quit

[EN DE]

quit

reload

[EN DE]

reload <module>

reload 99_PRIV

rename

[EN DE]

rename <oldname> <newname>

rename FHT_1234 fht.kitchen

rereadcfg

[EN DE]

rereadcfg [fhem-config-file]

statefile

rereadcfg

save

[EN DE]

save [<configfile>]

statefile

configfile

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

[EN DE]

set <devspec> <type-specific>

set <name> ?

[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:
{(perlExpression)} mit dem Ergebnis der perlExpression. $DEV wird dabei mit dem Namen des vom set betroffenen Gerätes ersetzt.

set extensions

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:
on-till-overnight <timedet>
Wie on-till, aber die aktuelle Uhrzeit wird nicht mit der Spezifizierten verglichen, damit folgendes funktioniert:
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.


        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

setdefaultattr

[EN DE]

setdefaultattr [<attrname> [<value>]]

setdefaultattr room kitchen

setdefaultattr loglevel 4

define lamp1 FS20 1234 11

define lamp2 FS20 1234 12

define lamp3 FS20 1234 13

setdefaultattr

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

setreading

[EN DE]

setreading <devspec> <reading> <value>

setreading lampe state on

setstate

[EN DE]

setstate <devspec> <value>

statefile

setstate lampe An

setuuid

[EN DE]

setuuid <device> <uuid>

show

[EN DE]

show <devspec>

show TYPE=CUL_HM

shutdown

[EN DE]

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.

shutdown

shutdown restart

shutdown 1

sleep

[EN DE]

sleep <sec|timespec|suchmuster> [<id>] [quiet]

in Sekunden (Millisekunden genau, da man Nachkommastellen spezifizieren kann)
als timespec (HH:MM or HH::MM::SS oder {perlfunc})
oder als suchmuster (Gerätename oder Gerätename:Event)

cancel

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

trigger

[EN DE]

trigger <devspec> <event>

Hier verweise ich auf den gut gepflegten Wikieintrag

trigger btn3 on

global

[EN DE]

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.:
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:

backupdir
Ein Ordner um die komprimierten Sicherheitsdateien zu speichern. Dieses Attribut wird vom backup Befehl benutzt.
Beispiel:

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:

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 heute entweder Samstag/Sonntag ist, oder 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:
Falls sich einer der Elemente dieser Liste weekEnd nennt, dann wird nicht auf Samstag/Sonntag geprüft. Falls einer der Elemente noWeekEnd ist, und nicht "none" zurückliefert, dann ist $we 0.

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.

maxChangeLog
FHEM speichert Strukturänderungen, diese Daten kann man mit "save ?" oder mittels Klick auf das rote Fragezeichen in FHEMWEB anzeigen. Per Voreinstellung ist diese Liste auf 10 Einträge begrenzt, mit diesem Attribut kann man diesen Wert ändern.

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.

ALL3076

ALL4000T

ALL4027

AMADCommBridge

[EN DE]

AMAD - Automagic Android Device

AMADCommBridge - Kommunikationsbrücke für alle AMAD Geräte

Define

define <name> AMADCommBridge

define AMADBridge AMADCommBridge

Für Autoremote:

Für Tasker:

Readings

JSON_ERROR - JSON Fehlermeldung welche von Perl gemeldet wird
JSON_ERROR_STRING - der String welcher die JSON Fehlermeldung verursacht hat
receiveFhemCommand - ist das Attribut fhemControlMode auf trigger gestellt, wird das Reading gesetzt sobald ein FHEM Befehl übersendet wird. Hierauf kann dann ein Notify triggern.
Wird anstelle von trigger setControl als Wert für fhemControlMode eingestellt, wird das Reading nicht gestzt sondern der set Befehl sofort ausgeführt.
receiveVoiceCommand - wird die Sprachsteuerung von AMAD aktiviert (set DEVICE activateVoiceInput) so wird der letzte erkannten Sprachbefehle in dieses Reading geschrieben.
receiveVoiceDevice - Name des Devices von wo aus der letzte erkannte Sprachbefehl gesendet wurde
state - Status der Bridge, open, closed

Attribute

allowFrom - Regexp der erlaubten IP-Adressen oder Hostnamen. Wenn dieses Attribut gesetzt wurde, werden ausschließlich Verbindungen von diesen Adressen akzeptiert.
Achtung: falls allowfrom nicht gesetzt ist, und keine gütige allowed Instanz definiert ist, und die Gegenstelle eine nicht lokale Adresse hat, dann wird die Verbindung abgewiesen. Folgende Adressen werden als local betrachtet:
IPV4: 127/8, 10/8, 192.168/16, 172.16/10, 169.254/16
IPV6: ::1, fe80/10
debugJSON - wenn auf 1 gesetzt, werden JSON Fehlermeldungen in Readings geschrieben. Siehe hierzu JSON_ERROR* unter Readings
fhemControlMode - steuert die zulässige Art der Kontrolle von FHEM Devices. Du kannst über die Bridge auf 2 Arten FHEM Devices steuern. Entweder per direktem FHEM Befehl aus einem Flow heraus, oder als Sprachbefehl mittels Sprachsteuerung (set DEVICE activateVoiceInput)
- trigger - ist der Wert trigger gesetzt, werden alle an die Bridge gesendeten FHEM set Befehle in das Reading receiveFhemCommand geschrieben und können so mittels notify ausgeführt werden. Sprachsteuerung ist möglich, es werden Readings receiveVoice* gesetzt. Auf dem Androidgerät können bei Sprachsteuerung mehrere Sprachbefehle mittels "und" verknüpft/aneinander gereiht werden. Bsp: schalte die Lichtszene Abends an und schalte den Fernsehr an
- setControl - alle set Befehle welche mittels eines Flows über die Bridge gesendet werden, werden automatisch ausgeführt. Das triggern eines Readings ist nicht nötig. Die Steuerung mittels Sprache verhält sich wie beim Wert trigger
- thirdPartControl - verhält sich wie trigger, bei der Sprachsteuerung ist jedoch ein anreihen von Sprachbefehlen mittels "und" nicht möglich. Dient der Sprachsteuerung über Module anderer Modulautoren ((z.B. 39_TEERKO.pm)

AMADDevice

[EN DE]

AMADDevice - Automagic Android Device

in Verbindung mit der Android APP Automagic oder Tasker

Wie genau verwendet man nun AMADDevice?

stelle sicher das als aller erstes die AMADCommBridge in FHEM definiert wurde
Bei verwendung von Automagic

installiere die App "Automagic Premium" aus dem PlayStore.
installiere das Flowset 74_AMADDeviceautomagicFlowset$VERSION.xml aus dem Ordner $INSTALLFHEM/FHEM/lib/ auf dem Androidgerät
aktiviere den Installationsassistanten Flow in Automagic. Wenn man nun Automagic in den Hintergrund schickt, z.B. Hometaste drücken, startet der Assistant und legt automatisch ein Device für das Androidgerät an.

Bei verwendung von Tasker

installiere die App "Tasker" aus dem PlayStore.
installiere das Tasker Projekt 74_AMADtaskerset_$VERSION.prj.xml aus dem Ordner $INSTALLFHEM/FHEM/lib/ auf dem Androidgerät
Starte den Task "AMAD", es erscheint eine Eingabemaske in der alle Einstellungen vorgenommen werden können, durch einen Klick auf "create Device" wird das Gerät in FHEM erstellt.

Ein AMADDevice Gerät von Hand anlegen.

Define

define <name> AMADDevice <IP-ADRESSE> <AMAD_ID> <REMOTESERVER>

define WandTabletWohnzimmer AMADDevice 192.168.0.23 123456 Automagic

Readings

airplanemode - Status des Flugmodus
androidVersion - aktuell installierte Androidversion
automagicState - Statusmeldungen von der Automagic oder Tasker App (Voraussetzung Android >4.3). Ist Android größer 4.3 vorhanden und im Reading steht "wird nicht unterstützt", muß in den Androideinstellungen unter Ton und Benachrichtigungen -> Benachrichtigungszugriff ein Haken für Automagic/Tasker gesetzt werden
batteryHealth - Zustand der Battery (1=unbekannt, 2=gut, 3=Überhitzt, 4=tot, 5=Überspannung, 6=unbekannter Fehler, 7=kalt) (nur Automagic)
powerPercent - Status der Batterie in %
batterytemperature - Temperatur der Batterie (nur Automagic)
bluetooth - on/off, Bluetooth Status an oder aus
checkActiveTask - Zustand einer zuvor definierten APP. 0=nicht aktiv oder nicht aktiv im Vordergrund, 1=aktiv im Vordergrund, siehe Hinweis unten (nur Automagic)
connectedBTdevices - eine Liste der verbundenen Gerät (nur Automagic)
connectedBTdevicesMAC - eine Liste der MAC Adressen aller verbundender BT Geräte (nur Automagic)
currentMusicAlbum - aktuell abgespieltes Musikalbum des verwendeten Mediaplayers (nur Automagic)
currentMusicApp - aktuell verwendeter Mediaplayer (Amazon Music, Google Play Music, Google Play Video, Spotify, YouTube, TuneIn Player, Aldi Life Music) (nur Automagic)
currentMusicArtist - aktuell abgespielter Musikinterpret des verwendeten Mediaplayers (nur Automagic)
currentMusicIcon - Cover vom aktuell abgespielten Album Noch nicht fertig implementiert (nur Automagic)
currentMusicState - Status des aktuellen/zuletzt verwendeten Mediaplayers (nur Automagic)
currentMusicTrack - aktuell abgespielter Musiktitel des verwendeten Mediaplayers (nur Automagic)
daydream - on/off, Daydream gestartet oder nicht
deviceState - Status des Androidgerätes. unknown, online, offline.
doNotDisturb - aktueller Status des nicht stören Modus
dockingState - undocked/docked Status ob sich das Gerät in einer Dockinstation befindet.
flow_SetCommands - active/inactive, Status des SetCommands Flow
flow_informations - active/inactive, Status des Informations Flow
flowsetVersionAtDevice - aktuell installierte Flowsetversion auf dem Device
incomingCallerName - Anrufername des eingehenden Anrufes
incomingCallerNumber - Anrufernummer des eingehenden Anrufes
incomingWhatsAppMessage - letzte WhatsApp Nachricht
incomingTelegramMessage - letzte Telegram Nachricht
incomingSmsMessage - letzte SMS Nachricht
intentRadioName - zuletzt gesrreamter Intent Radio Name
intentRadioState - Status des IntentRadio Players
keyguardSet - 0/1 Displaysperre gesetzt 0=nein 1=ja, bedeutet nicht das sie gerade aktiv ist
lastSetCommandError - letzte Fehlermeldung vom set Befehl
lastSetCommandState - letzter Status vom set Befehl, Befehl erfolgreich/nicht erfolgreich gesendet
lastStatusRequestError - letzte Fehlermeldung vom statusRequest Befehl
lastStatusRequestState - letzter Status vom statusRequest Befehl, Befehl erfolgreich/nicht erfolgreich gesendet
nextAlarmDay - aktiver Alarmtag
nextAlarmState - aktueller Status des "Androidinternen" Weckers
nextAlarmTime - aktive Alarmzeit
nfc - Status des NFC on/off
nfcLastTagID - nfc_id des zu letzt gescannten Tag's / Damit die ID korrekt erkannt wird muss im Flow NFC Tag Support der Trigger NFC TagIDs bearbeitet werden und die TagId's Kommasepariert eingetragen werden. (nur Automagic)
powerPlugged - Netzteil angeschlossen? 0=NEIN, 1|2=JA
screen - on locked/unlocked, off locked/unlocked gibt an ob der Bildschirm an oder aus ist und gleichzeitig gesperrt oder nicht gesperrt
screenBrightness - Bildschirmhelligkeit von 0-255
screenBrightnessMode - Adaptive Helligkeit on,off
screenFullscreen - on/off, Vollbildmodus (An,Aus)
screenOrientation - Landscape,Portrait, Bildschirmausrichtung (Horizontal,Vertikal)
screenOrientationMode - auto/manual, Modus für die Ausrichtung (Automatisch, Manuell)
state - aktueller Status
userFlowState - aktueller Status eines Flows, festgelegt unter dem setUserFlowState Attribut (nur Automagic)
volume - Media Lautstärkewert
volumeNotification - Benachrichtigungs Lautstärke
wiredHeadsetPlugged - 0/1 gibt an ob ein Headset eingesteckt ist oder nicht

checkActiveTask

attr Nexus10Wohnzimmer checkActiveTask com.android.chrome

Set

activateVoiceInput - aktiviert die Spracheingabe
bluetooth - on/off, aktiviert/deaktiviert Bluetooth
clearNotificationBar - All,Automagic, löscht alle Meldungen oder nur die Automagic/Tasker Meldungen in der Statusleiste
closeCall - beendet einen laufenden Anruf
currentFlowsetUpdate - fürt ein Flowset/Tasker-Projekt update auf dem Device durch
doNotDisturb - schaltet den nicht stören Modus, always immer stören, never niemals stören, alarmClockOnly nur Wecker darf stören, onlyImportant nur wichtige Störungen
installFlowSource - installiert einen Flow auf dem Device, das XML File muss unter /tmp/ liegen und die Endung xml haben. Bsp: set TabletWohnzimmer installFlowSource WlanUebwerwachen.xml (nur Automagic)
mediaPlay - play Befehl zur Media App
mediaStop - stop Befehl zur Media App
mediaNext - nächster Titel Befehl zur Media App
mediaBack - vorheriger Titel zur Media App
nextAlarmTime - setzt die Alarmzeit. gilt aber nur innerhalb der nächsten 24Std.
openCall - ruft eine Nummer an und legt optional nach X Sekunden auf / set DEVICE openCall 01736458 10 / ruft die Nummer an und beendet den Anruf nach 10s
screenBrightness - setzt die Bildschirmhelligkeit, von 0-255.
screenBrightnessMode - schaltet die Adaptive Helligkeit on,off
screenMsg - versendet eine Bildschirmnachricht
sendintent - sendet einen Intentstring Bsp: set $AMADDeviceDEVICE sendIntent org.smblott.intentradio.PLAY url http://stream.klassikradio.de/live/mp3-192/stream.klassikradio.de/play.m3u name Klassikradio, der erste Befehl ist die Aktion und der zweite das Extra. Es können immer zwei Extras mitgegeben werden.
sendSMS - sendet eine SMS an eine bestimmte Telefonnummer. Bsp.: sendSMS Dies ist ein Test|555487263
startDaydream - startet den Daydream
statusRequest - Fordert einen neuen Statusreport beim Device an. Es können nicht von allen Readings per statusRequest die Daten geholt werden. Einige wenige geben nur bei Statusänderung ihren Status wieder.
timer - setzt einen Timer innerhalb der als Standard definierten ClockAPP auf dem Device. Es können nur Minuten angegeben werden.
ttsMsg - versendet eine Nachricht welche als Sprachnachricht ausgegeben wird (um die Sprache für diese eine Durchsage zu ändern setze vor Deinem eigentlichen Text &en; oder &de;)
userFlowState - aktiviert oder deaktiviert einen oder mehrere Flows/Tasker-Profile,set Nexus7Wohnzimmer Badezimmer vorheizen:inactive oder set Nexus7Wohnzimmer Badezimmer vorheizen,Nachtlicht Steven:inactive
userFlowRun - führt den angegebenen Flow/Task aus
vibrate - lässt das Androidgerät vibrieren
volume - setzt die Medialautstärke. Entweder die internen Lautsprecher oder sofern angeschlossen die Bluetoothlautsprecher und per Klinkenstecker angeschlossene Lautsprecher, + oder - vor dem Wert reduziert die aktuelle Lautstärke um den Wert. Der maximale Sliderwert kann über das Attribut setVolMax geregelt werden.
volumeUp - erhöht die Lautstärke um den angegeben Wert im entsprechenden Attribut. Ist kein Attribut angegeben wird per default 2 genommen.
volumeDown - reduziert die Lautstärke um den angegeben Wert im entsprechenden Attribut. Ist kein Attribut angegeben wird per default 2 genommen.
volumeNotification - setzt die Benachrichtigungslautstärke.

Set abhängig von gesetzten Attributen

changetoBtDevice - wechselt zu einem anderen Bluetooth Gerät. Attribut setBluetoothDevice muß gesetzt sein. Siehe Hinweis unten! (nur Automagic)
notifySndFile - spielt die angegebene Mediadatei auf dem Androidgerät ab. Die aufzurufende Mediadatei sollte sich im Ordner /storage/emulated/0/Notifications/ befinden. Ist dies nicht der Fall kann man über das Attribut setNotifySndFilePath einen Pfad vorgeben.
nfc - schaltet nfc an oder aus /on/offAttribut root
openApp - öffnet eine ausgewählte App. Attribut setOpenApp
openURL - öffnet eine URL im Standardbrowser, sofern kein anderer Browser über das Attribut setOpenUrlBrowser ausgewählt wurde. Bsp: attr Tablet setOpenUrlBrowser de.ozerov.fully|de.ozerov.fully.MainActivity, das erste ist der Package Name und das zweite der Class Name
screen - on/off/lock/unlock schaltet den Bildschirm ein/aus oder sperrt/entsperrt ihn, in den Automagic Einstellungen muss "Admin Funktion" gesetzt werden sonst funktioniert "Screen off" nicht. Attribut setScreenOnForTimer ändert die Zeit wie lange das Display an bleiben soll! (Tasker unterstützt nur "screen on/off")
screenFullscreen - on/off, (aktiviert/deaktiviert) den Vollbildmodus. Attribut setFullscreen
screenLock - Sperrt den Bildschirm mit Pinabfrage. Attribut setScreenlockPIN - hier die Pin dafür eingeben. Erlaubt sind nur Zahlen. Es müßen mindestens 4, bis max 16 Zeichen verwendet werden.
screenOrientation - Auto,Landscape,Portait, aktiviert die Bildschirmausrichtung (Automatisch,Horizontal,Vertikal). Attribut setScreenOrientation
system - setzt Systembefehle ab (nur bei gerootetet Geräen). reboot,shutdown,airplanemodeON (kann nur aktiviert werden) Attribut root, in den Automagic Einstellungen muss "Root Funktion" gesetzt werden
takePicture - löst die Kamera aus für ein Foto Attribut setTakePictureResolution
takeScreenshot - macht ein Screenshot Attribut setTakeScreenshotResolution

Attribute

setNotifySndFilePath - setzt den korrekten Systempfad zur Notifydatei (default ist /storage/emulated/0/Notifications/
setTtsMsgSpeed - setzt die Sprachgeschwindigkeit bei der Sprachausgabe(Für Automagic: Werte zwischen 0.5 bis 4.0 in 0.5er Schritten, default:1.0)(Für Tasker: Werte zwischen 1 bis 10 in 1er Schritten, default:5)
setTtsMsgLang - setzt die Sprache bei der Sprachausgabe, de oder en (default ist de)
setTtsMsgVol - wenn gesetzt wird der Wert als neues Media Volume fü die Sprachansage verwendet und danach wieder der alte Wert eingestellt
setVolUpDownStep - setzt den Step für volumeUp und volumeDown
setVolMax - setzt die maximale Volume Gr&uoml;e für den Slider
setNotifyVolMax - setzt den maximalen Lautstärkewert für Benachrichtigungslautstärke für den Slider
setRingSoundVolMax - setzt den maximalen Lautstärkewert für Klingellautstärke für den Slider
setAPSSID - setzt die AccessPoint SSID um ein WLAN sleep zu verhindern (nur Automagic)
setTakePictureResolution - welche Kameraauflösung soll verwendet werden? (800x600,1024x768,1280x720,1600x1200,1920x1080)
setTakePictureCamera - welche Kamera soll verwendet werden (Back,Front).

attr <DEVICE> BTdeviceName1|MAC,BTDeviceName2|MAC

attr Nexus10Wohnzimmer setBluetoothDevice Logitech_BT_Adapter|AB:12:CD:34:EF:32,Anker_A3565|GH:56:IJ:78:KL:76

state

initialized - Ist der Status kurz nach einem define.
active - die Geräteinstanz ist im aktiven Status.
disabled - die Geräteinstanz wurde über das Attribut disable deaktiviert

Anwendungsbeispiele:

Alarm

[EN DE]

Deutsche Dokumentation im Wiki

Alarm

Apt Update Information

[EN DE]

AptToDate - Stellt aktuelle Update Informationen von apt Debian Systemen bereit

Define

define <name> AptToDate <HOST>

define fhemServer AptToDate localhost

Readings

state - update Status des Servers, liegen neue Updates an oder nicht
os-release_ - alle Informationen aus /etc/os-release
repoSync - status des letzten repository sync.
toUpgrade - status des letzten upgrade Befehles
updatesAvailable - Anzahl der verfügbaren Paketupdates

Set

repoSync - holt aktuelle Informationen über den Updatestatus
toUpgrade - führt den upgrade prozess aus.

Get

showUpgradeList - Paketiste aller zur Verfügung stehender Updates
showUpdatedList - Liste aller als letztes aktualisierter Pakete, von der alten Version zur neuen Version
showWarningList - Liste der letzten Warnings
showErrorList - Liste der letzten Fehler
getDistribution - fetch new distribution information

Attributes

disable - Deaktiviert das Device
upgradeListReading - fügt die Upgrade Liste als ein zusäiches Reading im JSON Format ein.
distupgrade - wechselt den upgrade Prozess nach dist-upgrade
disabledForIntervals - Deaktiviert das Device für eine bestimmte Zeit (13:00-18:30 or 13:00-18:30 22:00-23:00)

Air Quality Index

[EN DE]

ArduCounter

Arlo

[EN DE]

Arlo Sicherheitskameras von NETGEAR werden über eine Basisstation an die Arlo Cloud angebunden. Diese kann über eine REST-API angesprochen werden und liefert Ereignisse (wie z.B. erkannte Bewegungen oder sonstige Statusänderungen) über Server-Sent Events (SSE) zurück.

Define

define Arlo_Cloud Arlo ACCOUNT <hans.mustermann@xyz.de> <meinPasswort>

hans.mustermann@xyz.de durch die E-Mail-Adresse ersetzen, mit der man bei Arlo registriert ist, meinPasswort durch das Passwort dort.

Nach der erfolgreichen Definition des Account kann auf dem neu erzeugten Device set Arlo_Cloud autocreate aufgerufen werden. Dies legt die Basistation(en) und Kameras an, die zu dem Arlo Account zugeordnet sind. Die neuen Devices befinden sich initial im Raum Arlo.

Aufgrund der SSE-Schnittstelle ist es notwendig, dass dauerhaft im Hintergrund eine Verbindung zum Arlo-Server gehalten wird. Falls dies nicht gewünscht ist, da Arlo z.B. vorübergehend nicht genutzt wird, kann der Hintergrund-Job verhindert werden, indem das Attribut "disable" des Arlo_Cloud-Device auf 1 gesetzt wird.

Set

autocreate (Subtype ACCOUNT)
Liest alle dem Arlo-Account zugeordneten Geräte und legt dafür FHEM-Devices an, falls es diese nicht schon gibt.
reconnect (Subtype ACCOUNT)
Neuaufbau der Verbindung zum Arlo-Server. Zunächst loggt sich FHEM neu bei Arlo ein, danach wird die SSE-Verbindung aufgebaut. Wird nur benötigt, falls unerwartete Verbindungsabbrüche auftreten.
readModes (Subtype ACCOUNT)
Liest die Modes der Basisstationen (inkl. Custom Modes). Wird automatisch aufgerufen, daher normalerweise kein manueller Aufruf notwendig.
updateReadings (Subtype ACCOUNT)
Aktuelle Daten aller Basisstationen und Kameras aus der Cloud abrufen. Dies passiert einmal stündlich automatisch, falls dies nicht durch Setzen des Attributes disabled=1 am Cloud-Device unterbunden wird. Den Abruf-Intervall kann man durch Setzen des Attributs updateInterval anpassen (Angabe von Sekunden, also z.B. 600 für Abruf alle 10 Minuten oder 7200 für Abruf alle 2 Stunden).
arm (Subtypes BASESTATION, BRIDGE, ARLOQ und BABYCAM)
Aktivieren der Bewegungserkennung.
disarm (Subtype BASESTATION, BRIDGE, ARLOQ und BABYCAM)
Deaktivieren der Bewegungserkennung.
mode (Subtype BASESTATION und BRIDGE)
Setzen eines benutzerdefinierten Modus (Parameter: Name des Modus).
siren (Subtype BASESTATION)
Schaltet die Siren der Basisstation an oder aus (Achtung: laut!!).
subscribe (Subtype BASESTATION, ARLOQ und BABYCAM)
Basisstation für die SSE-Schnittstelle registrieren. Muss normalerweise nie manuell aufgerufen werden, da dies beim Login automatisch passiert.
unsubscribe (Subtype BASESTATION, ARLOQ und BABYCAM)
Registrierung einer Basisstation für die SSE-Schnittstelle rückgängig machen.
brightness (Subtype CAMERA, ARLOQ und BABYCAM)
Helligkeit der Kamera anpassen (mögliche Werte: -2 bis +2).
on (Subtype CAMERA und LIGHT)
Kamera/Licht einschalten.
off (Subtype CAMERA und LIGHT)
Kamera/Licht ausschalten.
snapshot (Subtype CAMERA, ARLOQ und BABYCAM)
Ein Standbild aufnehmen. Dieses kann danach über die URL aus dem Reading snapshotUrl aufgerufen werden. Damit der Befehl funktioniert, muss die Kamera den Status on haben.
startRecording (Subtype CAMERA, ARLOQ und BABYCAM)
Aufnahme starten. Damit der Befehl funktioniert, muss die Kamera den Status on haben.
stopRecording (Subtype CAMERA, ARLOQ und BABYCAM)
Aufnahme stoppen. Die Aufnahme kann danach über lastVideoUrl abgerufen werden, das Standbild dazu unter lastVideoImageUrl und lastVideoThumbnailUrl (klein).
nightlight (Subtype BABYCAM)
Nachtlicht ein-/ausschalten (on/off).
nightlight-brightness (Subtype BABYCAM)
Helligkeit des Nachtlichts anpassen.
nightlight-color (Subtype BABYCAM)
Farbe des Nachtlichts anpassen.

Attribute

event-on-change-reading

event-on-update-reading

downloadDir

Falls dieses Attribut am Cloud-Device (Subtype ACCOUNT) gesetzt ist, werden Dateien, die in der Arlo Cloud erzeugt werden (Videos / Bilder) in das hier angegebene Verzeichnis heruntergeladen. Damit man auf die Dateien über http zugreifen kann, muss ein Verzeichnis unterhalb /opt/fhem/www angegeben werden (oder dieses selbst). Wichtig: der fhem-User muss in in diesem Verzeichnis Schreibrechte haben.

downloadLink

Falls über das Attribut downloadDir die Dateien ins lokale Verzeichnis heruntergeladen werden, kann über dieses Attribut am Cloud-Device angegeben werden, dass die in den Kameras gesetzten Links auf die lokale Kopie zeigen sollen. Die Angabe des Links muss in der Form http://hostname:8083/fhem/unterverzeichnis-unter-www angegeben werden.

disable

Subtype ACCOUNT: Deaktiviert die Verbindung zur Arlo-Cloud.

Subtype BASESTATION: Deaktiviert die regelmäßige Abfrage der Readings aus der Arlo Cloud.

pingInterval

Subtype ACCOUNT: Setzt das Intervall in Sekunden, wie häfuig ein Heartbeat-Ping gesendet wird. Ohne den Heartbeat-Ping würde die Session ablaufen und es könnten keine Events mehr empfangen werden. Standard ist 90.

updateInterval

Subtype ACCOUNT: Setzt das Intervall in Sekunden, wie häufig die Readings der Basisstationen und Kameras abgefragt werden. Standard ist 3600 = 1 Stunde.

ssePollingInterval

Subtype ACCOUNT: Setzt das Intervall in Sekunden, wie häufig die SSE Events abgefragt werden sollen. Standard ist 2 Sekunden.

Astro

[EN DE]

Deutsche Dokumentation im Wiki

Astro

Aurora

AutoShuttersControl

[EN DE]

AutoShuttersControl (ASC) ermöglicht eine vollständige Automatisierung der vorhandenen Rollläden. Das Modul bietet umfangreiche Konfigurationsmöglichkeiten, um Rollläden bspw. nach Sonnenauf- und untergangszeiten, nach Helligkeitswerten oder rein zeitgesteuert zu steuern.

Man kann festlegen, welche Rollläden von ASC in die Automatisierung mit aufgenommen werden sollen. Daraufhin stehen diverse Attribute zur Feinkonfiguration zur Verfügung. So sind unter anderem komplexe Lösungen wie Fahrten in Abhängigkeit des Bewohnerstatus einfach umsetzbar. Beispiel: Hochfahren von Rollläden, wenn der Bewohner erwacht ist und draußen bereits die Sonne aufgegangen ist. Weiterhin ist es möglich, dass der geschlossene Rollladen z.B. nach dem Ankippen eines Fensters in eine Lüftungsposition fährt. Und vieles mehr.

Define

define <name> AutoShuttersControl

define myASControl AutoShuttersControl

myASControl

Readings

Im ASC-Device

..._nextAstroTimeEvent - Uhrzeit des nächsten Astro-Events: Sonnenauf- oder Sonnenuntergang oder feste Zeit
..._PosValue - aktuelle Position des Rollladens
..._lastPosValue - letzte Position des Rollladens
..._lastDelayPosValue - letzter abgesetzter Fahrbefehl, welcher beim nächsten zulässigen Event ausgeführt wird.
partyMode - on/off - Partymodus-Status
ascEnable - on/off - globale ASC Steuerung bei den Rollläden aktiv oder inaktiv
controlShading - on/off - globale Beschattungsfunktion aktiv oder inaktiv
hardLockOut - on/off - Status des hardwareseitigen Aussperrschutzes / gilt nur für Rolläden mit dem Attribut bei denen das Attributs ASC_LockOut entsprechend auf hard gesetzt ist
room_... - Auflistung aller Rollläden, die in den jeweiligen Rämen gefunden wurde. Beispiel: room_Schlafzimmer: Terrasse
selfDefense - Selbstschutz-Status
state - Status des ASC-Devices: active, enabled, disabled oder weitere Statusinformationen
sunriseTimeWeHoliday - on/off - Status der Wochenendunterstützung
userAttrList - Das ASC-Modul verteilt an die gesteuerten Rollladen-Geräte diverse Benutzerattribute (userattr). In diesem Reading kann der Status dieser Verteilung geprüft werden.

In den Rollläden-Geräten

ASC_Enable - on/off - wird der Rollladen über ASC gesteuert oder nicht
ASC_Time_DriveUp - Im Astro-Modus ist hier die Sonnenaufgangszeit für das Rollo gespeichert. Im Brightness- und Zeit-Modus ist hier der Zeitpunkt aus dem Attribut ASC_Time_Up_Late gespeichert.
ASC_Time_DriveDown - Im Astro-Modus ist hier die Sonnenuntergangszeit für das Rollo gespeichert. Im Brightness- und Zeit-Modus ist hier der Zeitpunkt aus dem Attribut ASC_Time_Down_Late gespeichert.
ASC_ShuttersLastDrive - Grund der letzten Fahrt vom Rollladen

Set

ascEnable - on/off - Aktivieren oder deaktivieren der globalen ASC Steuerung
controlShading - on/off - Aktiviert oder deaktiviert die globale Beschattungssteuerung
createNewNotifyDev - Legt die interne Struktur für NOTIFYDEV neu an. Diese Funktion steht nur zur Verfügung, wenn Attribut ASC_expert auf 1 gesetzt ist.
hardLockOut - on/off - Aktiviert den hardwareseitigen Aussperrschutz für die Rollläden, bei denen das Attributs ASC_LockOut entsprechend auf hard gesetzt ist. Mehr Informationen in der Beschreibung bei den Attributen für die Rollladengeräten.
partyMode - on/off - Aktiviert den globalen Partymodus. Alle Rollladen-Geräten, in welchen das Attribut ASC_Partymode auf on gesetzt ist, werden durch ASC nicht mehr gesteuert. Der letzte Schaltbefehl, der bspw. durch ein Fensterevent oder Wechsel des Bewohnerstatus an die Rollläden gesendet wurde, wird beim Deaktivieren des Partymodus ausgeführt
renewSetSunriseSunsetTimer - erneuert bei allen Rollläden die Zeiten für Sonnenauf- und -untergang und setzt die internen Timer neu.
scanForShutters - Durchsucht das System nach GerätenRo mit dem Attribut ASC = 1 oder ASC = 2
selfDefense - on/off - Aktiviert bzw. deaktiviert die Selbstschutzfunktion. Beispiel: Wenn das Residents-Gerät absent meldet, die Selbstschutzfunktion aktiviert wurde und ein Fenster im Haus noch geöffnet ist, so wird an diesem Fenster der Rollladen deaktivieren dann heruntergefahren.
shutterASCenableToggle - on/off - Aktivieren oder deaktivieren der ASC Kontrolle beim einzelnen Rollladens
sunriseTimeWeHoliday - on/off - Aktiviert die Wochenendunterstützung und somit, ob im Rollladengerät das Attribut ASC_Time_Up_WE_Holiday beachtet werden soll oder nicht.
wiggle - bewegt einen oder mehrere Rollläden um einen definierten Wert (Default: 5%) und nach einer Minute wieder zurück in die Ursprungsposition. Diese Funktion könnte bspw. zur Abschreckung in einem Alarmsystem eingesetzt werden.

Get

showShuttersInformations - zeigt eine Übersicht aller Rollläden mit den Fahrzeiten, Modus und diverse weitere Statusanzeigen.
showNotifyDevsInformations - zeigt eine Übersicht der abgelegten NOTIFYDEV Struktur. Diese Funktion wird primär fürs Debugging genutzt. Hierzu ist das Attribut ASC_expert = 1 zu setzen.

Attributes

Im ASC-Device

ASC_autoAstroModeEvening - REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON

ASC_autoAstroModeEveningHorizon - Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeEvening der Wert HORIZON ausgewählt wurde. (default: 0)

ASC_autoAstroModeMorning - REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON

ASC_autoAstroModeMorningHorizon - Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeMorning der Wert HORIZON ausgewählt wurde. (default: 0)

ASC_autoShuttersControlComfort - on/off - schaltet die Komfortfunktion an. Bedeutet, dass ein Rollladen mit einem threestate-Sensor am Fenster beim Öffnen in eine Offenposition fährt. Hierzu muss beim Rollladen das Attribut ASC_ComfortOpen_Pos entsprechend konfiguriert sein. (default: off)

ASC_autoShuttersControlEvening - on/off - Aktiviert die automatische Steuerung durch das ASC-Modul am Abend.

ASC_autoShuttersControlMorning - on/off - Aktiviert die automatische Steuerung durch das ASC-Modul am Morgen.

ASC_blockAscDrivesAfterManual - 0,1 - wenn dieser Wert auf 1 gesetzt ist, dann werden Rollläden vom ASC-Modul nicht mehr gesteuert, wenn zuvor manuell eingegriffen wurde. Voraussetzung hierfür ist jedoch, dass im Reading ASC_ShuttersLastDrive der Status manual enthalten ist und sich der Rollladen auf eine unbekannte (nicht in den Attributen anderweitig konfigurierte) Position befindet.

ASC_brightnessDriveUpDown - WERT-MORGENS:WERT-ABENDS - Werte bei dem Schaltbedingungen für Sonnenauf- und -untergang geprüft werden sollen. Diese globale Einstellung kann durch die WERT-MORGENS:WERT-ABENDS Einstellung von ASC_BrightnessSensor im Rollladen selbst überschrieben werden.

ASC_debug - Aktiviert die erweiterte Logausgabe für Debugausgaben

ASC_expert - ist der Wert 1, so werden erweiterte Informationen bezüglich des NotifyDevs unter set und get angezeigt

ASC_freezeTemp - Temperatur, ab welcher der Frostschutz greifen soll und der Rollladen nicht mehr fährt. Der letzte Fahrbefehl wird gespeichert.

ASC_rainSensor - DEVICENAME[:READINGNAME] MAXTRIGGER[:HYSTERESE] [CLOSEDPOS] - der Inhalt ist eine Kombination aus Devicename, Readingname, Wert ab dem getriggert werden soll, Hysterese Wert ab dem der Status Regenschutz aufgehoben werden soll und der "wegen Regen geschlossen Position".

ASC_residentsDev - DEVICENAME[:READINGNAME] - der Inhalt ist eine Kombination aus Devicenamen und Readingnamen des Residents-Device der obersten Ebene (z.B. rgr_Residents:state)

ASC_shuttersDriveOffset - maximale Zufallsverzögerung in Sekunden bei der Berechnung der Fahrzeiten. 0 bedeutet keine Verzögerung

ASC_tempSensor - DEVICENAME[:READINGNAME] - der Inhalt ist eine Kombination aus Device und Reading für die Außentemperatur

ASC_twilightDevice - das Device, welches die Informationen zum Sonnenstand liefert. Wird unter anderem für die Beschattung verwendet.

ASC_windSensor - DEVICE[:READING] - Sensor für die Windgeschwindigkeit. Kombination aus Device und Reading.

In den Rollläden-Geräten

ASC - 0/1/2 0 = "kein Anlegen der Attribute beim ersten Scan bzw. keine Beachtung eines Fahrbefehles",1 = "Inverse oder Rollo - Bsp.: Rollo oben 0, Rollo unten 100 und der Befehl zum prozentualen Fahren ist position",2 = "Homematic Style - Bsp.: Rollo oben 100, Rollo unten 0 und der Befehl zum prozentualen Fahren ist pct
ASC_Antifreeze - soft/am/pm/hard/off - Frostschutz, wenn soft fährt der Rollladen in die ASC_Antifreeze_Pos und wenn hard/am/pm wird gar nicht oder innerhalb der entsprechenden Tageszeit nicht gefahren (default: off)
ASC_Antifreeze_Pos - Position die angefahren werden soll, wenn der Fahrbefehl komplett schließen lautet, aber der Frostschutz aktiv ist (default: 50)
ASC_AutoAstroModeEvening - aktuell REAL,CIVIL,NAUTIC,ASTRONOMIC (default: none)
ASC_AutoAstroModeEveningHorizon - Höhe über Horizont, wenn beim Attribut ASC_autoAstroModeEvening HORIZON ausgewählt (default: none)
ASC_AutoAstroModeMorning - aktuell REAL,CIVIL,NAUTIC,ASTRONOMIC (default: none)
ASC_AutoAstroModeMorningHorizon - Höhe über Horizont,a wenn beim Attribut ASC_autoAstroModeMorning HORIZON ausgewählt (default: none)
ASC_BlockingTime_afterManual - wie viel Sekunden soll die Automatik nach einer manuellen Fahrt aussetzen. (default: 1200)
ASC_BlockingTime_beforDayOpen - wie viel Sekunden vor dem morgendlichen öffnen soll keine schließen Fahrt mehr stattfinden. (default: 3600)
ASC_BlockingTime_beforNightClose - wie viel Sekunden vor dem nächtlichen schließen soll keine öffnen Fahrt mehr stattfinden. (default: 3600)
ASC_BrightnessSensor - DEVICE[:READING] WERT-MORGENS:WERT-ABENDS / 'Sensorname[:brightness [400:800]]' Angaben zum Helligkeitssensor mit (Readingname, optional) für die Beschattung und dem Fahren der Rollladen nach brightness und den optionalen Brightnesswerten für Sonnenauf- und Sonnenuntergang. (default: none)
ASC_Closed_Pos - in 10 Schritten von 0 bis 100 (Default: ist abhängig vom Attribut ASC)
ASC_ComfortOpen_Pos - in 10 Schritten von 0 bis 100 (Default: ist abhängig vom Attribut ASC)
ASC_Down - astro/time/brightness - bei astro wird Sonnenuntergang berechnet, bei time wird der Wert aus ASC_Time_Down_Early als Fahrzeit verwendet und bei brightness muss ASC_Time_Down_Early und ASC_Time_Down_Late korrekt gesetzt werden. Der Timer läuft dann nach ASC_Time_Down_Late Zeit, es wird aber in der Zeit zwischen ASC_Time_Down_Early und ASC_Time_Down_Late geschaut, ob die als Attribut im Moduldevice hinterlegte ASC_brightnessDriveUpDown der Down Wert erreicht wurde. Wenn ja, wird der Rollladen runter gefahren (default: astro)
ASC_DriveUpMaxDuration - die Dauer des Hochfahrens des Rollladens plus 5 Sekunden (default: 60)
ASC_Drive_Offset - maximaler Wert für einen zufällig ermittelte Verzögerungswert in Sekunden bei der Berechnung der Fahrzeiten, 0 bedeutet keine Verzögerung, -1 bedeutet, dass das gleichwertige Attribut aus dem ASC Device ausgewertet werden soll. (default: -1)
ASC_Drive_OffsetStart - in Sekunden verzögerter Wert ab welchen dann erst das Offset startet und dazu addiert wird. Funktioniert nur wenn gleichzeitig ASC_Drive_Offset gesetzt wird. (default: -1)
ASC_LockOut - soft/hard/off - stellt entsprechend den Aussperrschutz ein. Bei global aktivem Aussperrschutz (set ASC-Device lockOut soft) und einem Fensterkontakt open bleibt dann der Rollladen oben. Dies gilt nur bei Steuerbefehlen über das ASC Modul. Stellt man global auf hard, wird bei entsprechender Möglichkeit versucht den Rollladen hardwareseitig zu blockieren. Dann ist auch ein Fahren über die Taster nicht mehr möglich. (default: off)
ASC_LockOut_Cmd - inhibit/blocked/protection - set Befehl für das Rollladen-Device zum Hardware sperren. Dieser Befehl wird gesetzt werden, wenn man "ASC_LockOut" auf hard setzt (default: none)
ASC_Mode_Down - always/home/absent/off - Wann darf die Automatik steuern. immer, niemals, bei Abwesenheit des Roommate (ist kein Roommate und absent eingestellt, wird gar nicht gesteuert) (default: always)
ASC_Mode_Up - always/home/absent/off - Wann darf die Automatik steuern. immer, niemals, bei Abwesenheit des Roommate (ist kein Roommate und absent eingestellt, wird gar nicht gesteuert) (default: always)
ASC_Open_Pos - in 10 Schritten von 0 bis 100 (default: ist abhängig vom Attribut ASC)
ASC_Partymode - on/off - schaltet den Partymodus an oder aus. Wird am ASC Device set ASC-DEVICE partyMode on geschalten, werden alle Fahrbefehle an den Rollläden, welche das Attribut auf on haben, zwischengespeichert und später erst ausgeführt (default: off)
ASC_Pos_Reading - Name des Readings, welches die Position des Rollladen in Prozent an gibt; wird bei unbekannten Device Typen auch als set Befehl zum fahren verwendet
ASC_PrivacyDownTime_beforNightClose - wie viele Sekunden vor dem abendlichen schließen soll der Rollladen in die Sichtschutzposition fahren, -1 bedeutet das diese Funktion unbeachtet bleiben soll (default: -1)
ASC_PrivacyDown_Pos - Position den Rollladens für den Sichtschutz (default: 50)
ASC_WindProtection - on/off - soll der Rollladen beim Regenschutz beachtet werden. on=JA, off=NEIN.
ASC_Roommate_Device - mit Komma getrennte Namen des/der Roommate Device/s, welche den/die Bewohner des Raumes vom Rollladen wiedergibt. Es macht nur Sinn in Schlaf- oder Kinderzimmern (default: none)
ASC_Roommate_Reading - das Reading zum Roommate Device, welches den Status wieder gibt (default: state)
ASC_Self_Defense_Exclude - on/off - bei on Wert wird dieser Rollladen bei aktiven Self Defense und offenen Fenster nicht runter gefahren, wenn Residents absent ist. (default: off)
ASC_Self_Defense_Mode - absent/gone - ab welchen Residents Status soll Selfdefense aktiv werden ohne das Fenster auf sind. (default: gone)
ASC_Self_Defense_AbsentDelay - um wie viele Sekunden soll das fahren in Selfdefense bei Residents absent verzögert werden. (default: 300)
ASC_Self_Defense_Exclude - on/off - bei on Wert wird dieser Rollladen bei aktiven Self Defense und offenen Fenster nicht runter gefahren, wenn Residents absent ist. (default: off)

Beschreibung der Beschattungsfunktion

Im ASC Device

In den Rollladendevices

ASC_Shading_Angle_Left - Vorlaufwinkel im Bezug zum Fenster, ab wann abgeschattet wird. Beispiel: Fenster 180° - 85° ==> ab Sonnenpos. 95° wird abgeschattet (default: 75)
ASC_Shading_Angle_Right - Nachlaufwinkel im Bezug zum Fenster, bis wann abgeschattet wird. Beispiel: Fenster 180° + 85° ==> bis Sonnenpos. 265° wird abgeschattet (default: 75)
ASC_Shading_Direction - Position in Grad, auf der das Fenster liegt - genau Osten wäre 90, Süden 180 und Westen 270 (default: 180)
ASC_Shading_MinMax_Elevation - ab welcher min Höhe des Sonnenstandes soll beschattet und ab welcher max Höhe wieder beendet werden, immer in Abhängigkeit der anderen einbezogenen Sensorwerte (default: 25.0:100.0)
ASC_Shading_Min_OutsideTemperature - ab welcher Temperatur soll Beschattet werden, immer in Abhängigkeit der anderen einbezogenen Sensorwerte (default: 18)
ASC_Shading_Mode - absent,always,off,home / wann soll die Beschattung nur stattfinden. (default: off)
ASC_Shading_Pos - Position des Rollladens für die Beschattung
ASC_Shading_StateChange_Cloudy - Brightness Wert ab welchen die Beschattung aufgehoben werden soll, immer in Abhängigkeit der anderen einbezogenen Sensorwerte (default: 20000)
ASC_Shading_StateChange_Sunny - Brightness Wert ab welchen Beschattung stattfinden soll, immer in Abhängigkeit der anderen einbezogenen Sensorwerte (default: 35000)
ASC_Shading_WaitingPeriod - wie viele Sekunden soll gewartet werden bevor eine weitere Auswertung der Sensordaten für die Beschattung stattfinden soll (default: 1200)

ASC_ShuttersPlace - window/terrace - Wenn dieses Attribut auf terrace gesetzt ist, das Residence Device in den Status "gone" geht und SelfDefense aktiv ist (ohne das das Reading selfDefense gesetzt sein muss), wird das Rollo geschlossen (default: window)
ASC_Time_Down_Early - Sonnenuntergang frühste Zeit zum Runterfahren (default: 16:00)
ASC_Time_Down_Late - Sonnenuntergang späteste Zeit zum Runterfahren (default: 22:00)
ASC_Time_Up_Early - Sonnenaufgang frühste Zeit zum Hochfahren (default: 05:00)
ASC_Time_Up_Late - Sonnenaufgang späteste Zeit zum Hochfahren (default: 08:30)
ASC_Time_Up_WE_Holiday - Sonnenaufgang frühste Zeit zum Hochfahren am Wochenende und/oder Urlaub (holiday2we wird beachtet). (default: 08:00) ACHTUNG!!! in Verbindung mit Brightness für ASC_Up muss die Uhrzeit kleiner sein wie die Uhrzeit aus ASC_Time_Up_Late
ASC_Up - astro/time/brightness - bei astro wird Sonnenaufgang berechnet, bei time wird der Wert aus ASC_Time_Up_Early als Fahrzeit verwendet und bei brightness muss ASC_Time_Up_Early und ASC_Time_Up_Late korrekt gesetzt werden. Der Timer läuft dann nach ASC_Time_Up_Late Zeit, es wird aber in der Zeit zwischen ASC_Time_Up_Early und ASC_Time_Up_Late geschaut, ob die als Attribut im Moduldevice hinterlegte Down Wert von ASC_brightnessDriveUpDown erreicht wurde. Wenn ja, wird der Rollladen hoch gefahren (default: astro)
ASC_Ventilate_Pos - in 10 Schritten von 0 bis 100 (default: ist abhängig vom Attribut ASC)
ASC_Ventilate_Window_Open - auf lüften, wenn das Fenster gekippt/geöffnet wird und aktuelle Position unterhalb der Lüften-Position ist (default: on)
ASC_WiggleValue - Wert um welchen sich die Position des Rollladens ändern soll (default: 5)
ASC_WindParameters - TRIGGERMAX[:HYSTERESE] [DRIVEPOSITION] / Angabe von Max Wert ab dem für Wind getriggert werden soll, Hytsrese Wert ab dem der Windschutz aufgehoben werden soll TRIGGERMAX - HYSTERESE / Ist es bei einigen Rollläden nicht gewünscht das gefahren werden soll, so ist der TRIGGERMAX Wert mit -1 an zu geben. (default: '50:20 ClosedPosition')
ASC_WindowRec_PosAfterDayClosed - open,lastManual / auf welche Position soll das Rollo nach dem schließen am Tag fahren. Open Position oder letzte gespeicherte manuelle Position (default: open)
ASC_WindowRec - Name des Fensterkontaktes, an dessen Fenster der Rollladen angebracht ist (default: none)
ASC_WindowRec_subType - Typ des verwendeten Fensterkontaktes: twostate (optisch oder magnetisch) oder threestate (Drehgriffkontakt) (default: twostate)

Beschreibung der AutoShuttersControl API

Übersicht für das Rollladen-Device

{ ascAPIget('Getter','ROLLODEVICENAME') }

Getter	Erläuterung
FreezeStatus	1=soft, 2=Daytime, 3=hard
NoOffset	Wurde die Behandlung von Offset deaktiviert (Beispiel bei Fahrten über Fensterevents)
LastDrive	Grund des letzten Fahrens
LastPos	die letzte Position des Rollladens
LastPosTimestamp	Timestamp der letzten festgestellten Position
LastManPos	Position der letzten manuellen Fahrt
LastManPosTimestamp	Timestamp der letzten manuellen Position
SunsetUnixTime	berechnete Unixzeit für Abends (Sonnenuntergang)
Sunset	1=Abendfahrt wurde durchgeführt, 0=noch keine Abendfahrt durchgeführt
SunriseUnixTime	berechnete Unixzeit für Morgens (Sonnenaufgang)
Sunrise	1=Morgenfahrt wurde durchgeführt, 0=noch keine Morgenfahrt durchgeführt
RoommatesStatus	aktueller Status der/des Roommate/s für den Rollladen
RoommatesLastStatus	letzter Status der/des Roommate/s für den Rollladen
ShadingStatus	Ausgabe des aktuellen Shading Status, „in“, „out“, „in reserved“, „out reserved“
ShadingStatusTimestamp	Timestamp des letzten Beschattungsstatus
IfInShading	Befindet sich der Rollladen, in Abhängigkeit des Shading Mode, in der Beschattung
WindProtectionStatus	aktueller Status der Wind Protection „protected“ oder „unprotected“
RainProtectionStatus	aktueller Status der Regen Protection „unprotected“ oder „unprotected“
DelayCmd	letzter Fahrbefehl welcher in die Warteschlange kam. Grund z.B. Partymodus.
Status	Position des Rollladens
ASCenable	Abfrage ob für den Rollladen die ASC Steuerung aktiv ist.
IsDay	Abfrage ob das Rollo im Tag oder Nachtmodus ist. Also nach Sunset oder nach Sunrise
PrivacyDownStatus	Abfrage ob das Rollo aktuell im PrivacyDown Status steht
OutTemp	aktuelle Außentemperatur sofern ein Sensor definiert ist, wenn nicht kommt -100 als Wert zurück

Übersicht für das Rollladen-Device mit Parameterübergabe

{ ascAPIget('Getter','ROLLODEVICENAME',VALUE) }

Getter	Erläuterung
QueryShuttersPos	Rückgabewert 1 bedeutet das die aktuelle Position des Rollos unterhalb der Valueposition ist. 0 oder nichts bedeutet oberhalb der Valueposition.

Übersicht für das ASC Device

{ ascAPIget('Getter') }

Getter	Erläuterung
OutTemp	aktuelle Außentemperatur sofern ein Sensor definiert ist, wenn nicht kommt -100 als Wert zurück
ResidentsStatus	aktueller Status des Residents Devices
ResidentsLastStatus	letzter Status des Residents Devices
Azimuth	Azimut Wert
Elevation	Elevation Wert
ASCenable	ist die ASC Steuerung global aktiv?

BDKM

BEOK

[EN DE]

https://wiki.fhem.de/wiki/BEOK


        sudo apt-get install libcrypt-cbc-perl

	sudo apt-get install libcrypt-rijndael-perl

        sudo apt-get install libssl-dev

	sudo cpan Crypt/OpenSSL/AES.pm

Define

define <name> BEOK <ip> [mac]

define WT BEOK 192.178.1.100

define WT BEOK 192.178.1.100 01:02:03:04:05:06

Set

desired-temp <5 - 99>

mode <auto manual>

loop <12345.67 123456.7 1234567>
12345.67 Montag - Freitag Werktag, Samstag & Sonntag sind Wochenende
123456.7 Montag - Samstag Werktag, nur Sonntag ist Wochendende
1234567 jeder Tag (inklusive Samstag & Sonntag) ist ein Werktag, kein Wochenende

sensor <external internal both>
both = internal control temperature, external limit temperature

time
setzt Uhrzeit und Wochentag

lock <on off>

power-on-memory <on off>

fre <open close>
Frostschutz Funktion

room-temp-adj <-5 - +5>
Korrekturwert (Offset) Raumtemperatur

osv <5 - 99>
Maximum Temperatur für externen Sensor

svh <5 - 99>
Raumtemperatur Maximum

svl <5 - 99>
Raumtemperatur Minimum

dif <1 - 9>
difference of limit temperature value of external sensor

day-profil[1-6]-temp <5 - 99>
Werktagprofil Temperatur

day-profil[1-6]-time <00:00 - 23:59>
Werktagprofil Zeit

we-profile[7-8]-temp <5 - 99>
Wochenendprofil Temperatur

we-profile[7-8]-time <00:00 - 23:59>
Wochenendprofil Zeit

weekprofile
Setzt alle Wochentag Schaltzeiten und Temperaturen mit Werten aus einem Profil des Moduls weekprofile.
Syntax : set weekprofile <weekprofile_device:profil_name[:Wochentag]>
siehe auch Erklärung im Forum bzw. im Wiki.

Attribute

display
auto | always_on , default auto
Displaybeleuchtung bei jeder Statusabfrage einschalten (always_on). Wird ausserdem das Attribut interval auf eine Zeit kleiner 9 Sekunden gesetzt, so leuchtet das Display dauerhaft. ACHTUNG dies hat eine wesentlich höhere Funklast zur Folge !
D.h. die Wahrscheinlichkeit von gelegentlichen Timeouts wird stark zunehmen, siehe auch Attribut skipTimeouts.

interval
Poll Intevall in Sekunden, 0 = kein Polling , default 60

keepAuto
0 | 1 , default 0 (aus)
Schaltet das Thermostat kurz vor Ende eines Tages in den Mode auto sollte es sich zu diesem Zeitpunkt im Mode manu befinden.

language
de oder DE für deutsche Bezeichnungen in der Übersicht, z.B. Raum statt Room , usw.

model
nur für die FHEM Modul Statistik unter https://fhem.de/stats/statistics.html

skipTimeouts
0 - 9 , default 1
Anzahl der max. zulässigen Timeouts in Folge ohne das ein Logeintrag bzw. eine Fehlermeldung erfolgt (default 1)

timeout
Timeout in Sekunden für die Wlan Kommunikation, default 5
ACHTUNG in Verbindung mit dem Attribut Display alaways_on darf diese Wert niemals grösser als interval sein !

timesync
Uhrzeit und Wochentag automatisch mit FHEM synchronisieren, default 1 (an)
Setzt automatisch FHEM Zeit und Wochentag im Thermostsat.

BOSEST

[EN DE]

Hinweis:

libwww-perl
libmojolicious-perl
libxml-simple-perl
libnet-bonjour-perl
libev-perl
liburi-escape-xs-perl
sox
libsox-fmt-mp3

sudo apt-get install libwww-perl libmojolicious-perl libxml-simple-perl libnet-bonjour-perl libev-perl liburi-escape-xs-perl

sudo apt-get install cpanminus

sudo cpanm Mojolicious

Link

Define

define <name> BOSEST

define bosesystem BOSEST

Set

set <name> <command> [<parameter>]

autoAddDLNAServers

Allgemein

on - Lautsprecher einschalten
off - Lautsprecher ausschalten
power - Wechselt zw. on und off
volume [0...100] [+x|-x] - Lautstärke setzen (direkt oder als ±x Differenz zur aktuellen Lautstärke)
channel 0...20 - Present auswählen
saveChannel 07...20 - Aktuelle Wiedergabe als Present 07 bis 20 speichern
play - Startet die Wiedergabe
pause - Pausiert die Wiedergabe
playpause - Wechselt zw. play und pause
stop - Stoppt die Wiedergabe
nextTrack - Nächsten Titel spielen
prevTrack - Vorherigen Titel spielen
playTrack name|location|source[|sourceAccount] - Sucht per DNLA nach dem Titel und spielt ihn ab
Weitere Informationen:
1. "Es ist immer nur eine Suche und die ist nach trackTitle, trackAlbum, trackArtist möglich, so wie in der SoundTouch App" (FHEM Forum Beitrag)
2. "Einfach in der SoundTouch APP auf die Suche klicken und schauen, ob Playlists gefunden und abgespielt werden können." (FHEM Forum Beitrag)
mute on|off|toggle - Stummschaltung
shuffle on|off - Zufallswiedergabe
repeat all|one|off - Wiederholung
bass 0...10 - Basseinstellung
recent 0...15 - Anzahl der Namen, die in der recent list in readings aufgeführt werden
source bluetooth,bt-discover,aux mode, airplay - lokale Quelle auswählen

addDLNAServer Name1 [Name2] [Namex] - DLNA server Name1 (und Name2 bis Namex) zur BOSE Bibliothek hinzufügen
removeDLNAServer Name1 [Name2] [Namex] - DLNA server Name1 (und Name2 bis Namex) aus der BOSE Bibliothek entfernen

set BOSE_1234567890AB volume 25

Zeiten:

on-for-timer 1...x - Schaltet den Lautsprecher für x Sekunden ein
off-for-timer 1...x - Schaltet den Lautsprecher für x Sekunden aus
on-till hh:mm:ss - Schaltet den Lautsprecher bis zur angegebenen Zeit ein
off-till hh:mm:ss - Schaltet den Lautsprecher bis und zur angegebenen Zeit aus
on-till-overneight hh:mm:ss - Schaltet den Lautsprecher bis zur angegebenen Zeit am nächsten Tag ein
off-till-overneight hh:mm:ss - Schaltet den Lautsprecher bis zur angegebenen Zeit am nächsten Tag aus

set BOSE_1234567890AB on-till 23:00:00

Multiroom:

createZone deviceID[,deviceID] - Legt eine Wiedergabe-Zone an und fügt einen oder mehrere Lautsprecher der Wiedergabezone hinzu
addToZone deviceID - Fügt einen Lautsprecher einer bestehenden Wiedergabe-Zone zu
removeFromZone deviceID - Entfernt einen Lautsprecher aus einer Wiedergabe-Zone
playEverywhere - Startet "Überall wiedergeben"
stopPlayEverywhere - Beendet "Überall wiedergeben"

set BOSE_1234567890AB playEverywhere

set BOSE_1234567890AB createZone AB1234567890,12AB34567890

Hinweis:

Uhr Anzeige (nur für ST20/30):

clock enable/disable - Schaltet die Uhrenanzeige im Standby um

set BOSE_1234567890AB clock enable

TextToSpeach (benötigt Google Translate):

speak "message" [0...100] [+x|-x] [en|de|xx] - Text den der Lautsprecher sagen soll, ggf. mit Lautstärkeangabe, die für diese Ansage verwendet werden soll. Nach der Ansage setzt der Lautsprecher die Wiedergabe fort.
speakOff "message" [0...100] [+x|-x] [en|de|xx] - Text den der Lautsprecher sagen soll, ggf. mit Lautstärkeangabe, die für diese Ansage verwendet werden soll. Nach der Ansage schaltet der Lautsprecher ab.

set BOSE_1234567890AB speakOff "Ab isn Bett." 30 en

DNLA Server:

autoAddDLNAServers 0|1 - 1=automatisch alle DLNA servers zur BOSE Bibliothek hinzufügen. Dieser Parameter ist nur für das Hauptmodul BOSEST, nicht für die Lautsprecher!

Get

n/a

Attribute

staticIPs IP-Address [,IP-Address] - Manuelle Angabe der IP Adresse(n). Sollte nur verwendet werden, wenn die automatiche Erkennung nicht funktioniert. (z.B. bei mehreren Sub-Netzwerken oder wenn Teile des Netzwerks manuell verbunden werden, ...)
Beispiel: attr bosesystem staticIPs 192.168.1.52,192.168.1.53
speakChannel channel(s) - Ansage des aktuellen Present vor der Wiedergabe, sinnvoll für SoundTouch Lautsprecher ohne Display (Angabe komma-separiert oder als Bereich: z.B. 2,3,5,6 oder 1-6 ). TTS muss eingerichtet sein.
auto-zone on|off - "Überall Wiedergabe" automatisch starten, wenn Lautsprecher das gleiche wiedergeben ("contentItemLocation" ist identisch); (Standardwert: off)
ttsDirectory "directory" - Angabe des DLNA TTS Verzeichnisses. Der FHEM user muss Schreibrechte in diesem Verzeichnis haben.
ttsLanguage en|de|xx - Standardsprache für TTS setzen (default: en)
ttsSpeakOnError 0|1 - 0= Ansage "not available" unterdrücken
ttsVolume [0...100] [+x|-x] - Lautstärke setzen (direkt oder als ±x Differnez zur aktuellen Lautstärke)
Channel_07 to Channel_20 name|location|source|[sourceAccount] - Festlegen der Present 07 bis 20
Bei Wiedergabe kann in den readings "ContentItemLocationName, ContentItemLocation, etc. " ausgelesen werden. Dies Daten können dann verwendet werden, um die Presents zu belegen.

BOTVAC

BRAVIA

[EN DE]

Define

define <name> BRAVIA <ip-or-hostname> [<poll-interval>]

set register

s_*	: Status
ci_*	: Inhaltsinfo

remotecontrol

Set

set <name> <option> <value>

application
Liste der Anwendungen. Anwenungen sind ab Modelljahr 2013 verfügbar.
channel
Liste aller bekannten Kanäle. Das Modul merkt sich alle aufgerufenen Kanäle. Ab Modelljahr 2013 werden die Kanäle automatisch geladen (Anzahl siehe channelsMax).
channelDown
Einen Kanal zurück schalten.
channelUp
Einen Kanal weiter schalten.
input
Liste der Eingänge. Eingänge sind ab Modelljahr 2013 verfügbar.
mute
Direkte Stummschaltung erfolgt nur per aktiviertem Upnp.
off
Schaltet den TV aus. Der State des Gerätes wird auf "set_off" gesetzt. Dieser Wert wird nach 60 Sekunden wieder überschrieben oder sobald der TV entsprechend "off" meldet.
on
Einschalten des TV, ab Modelljahr 2013 per WOL. Der State des Gerätes wird auf "set_on" gesetzt. Dieser Wert wird nach 60 Sekunden wieder überschrieben oder sobald der TV entsprechend "on" meldet.
openUrl
Öffnet eine URL auf dem Bildschirm. Diese Funktion ist ab Modelljahr 2013 verfügbar.
pause
Pausiert die Wiedergabe einer Aufnahme, einer internen App, etc.
play
Startet die Wiedergabe einer Aufnahme, einer internen App, etc.
record
Startet die Aufnahme des aktuellen Inhalts.
register
Einmalige Registrierung von FHEM als Fernbedienung im TV.
Bei requestFormat = "xml" erfolgt die Registrierung ohne Parameter.
Bei requestFormat = "json" ist die Registrierung zweistufig.
Beim Aufruf des Setter gibt es ein Eingabefeld:
1. Aufruf mit leerem Eingabefeld. Auf dem TV sollte eine PIN zur Registrierung erscheinen.
2. PIN im Eingabefeld eintragen und Registrierung noch mal ausführen
requestFormat
"xml" für xml-basierte Kommunikation 2011er/2012er Geräte
"json" für die Kommunikation seit der 2013er Generation
remoteControl
Direktes Senden von Kommandos an den TV.
statusRequest
Ruft die aktuellen Statusinformationen vom TV ab.
stop
Stoppt die Wiedergabe einer Aufnahme, einer internen App, etc.
text
Überträgt den eingegebenen Text in ein Textfeld der Anzeige.
toggle
Wechselt den Einschaltstatus des TV.
tvpause
Aktiviert den Timeshift-Modus.
upnp
Aktiviert Upnp zum Abfragen und Einstellen der Lautstärke.
volume
Direktes Setzen der Lautstärke erfolgt nur per aktiviertem Upnp.
volumeDown
Verringert die Lautstärke.
volumeUp
Erhöht die Lautstärke.

Attributes

attr <name> <attribute> <value>

channelsMax
Maximale Anzahl der im FHEMWEB angezeigten Kanäle. Der Standartwert ist 50.
macaddr
Ermöglicht das Einschalten des TV per WOL.

BS

Babble

[EN DE]

Deutsche Dokumentation im Wiki

Babble

Broadlink

[EN DE]

Broadlink

ppm install Crypt-CBC

ppm install Crypt-OpenSSL-AES

sudo apt-get install libcrypt-cbc-perl

sudo apt-get install libcrypt-rijndael-perl

sudo cpan Crypt/OpenSSL/AES.pm

Define

define <name> Broadlink <ip/host> <mac> <type=rmpro or rmmini or sp3 or sp3s>

define broadlinkWZ Broadlink 10.23.11.85 34:EA:34:F4:77:7B rmpro

mac

sp3

rmpro

Set für rmpro

set <name> <commandSend> <command name>

Sendet ein vorher aufgenommenen Befehl
set <name> recordNewCommand <command name>

Nimmt ein neuen Befehl auf. Man muss einen Befehlnamen angeben.
set <name> remove <command name>

Löscht einen vorher aufgezeichneten Befehl.
set <name> rename <old command name> <new command name>

Benennt einen vorher aufgezeichneten Befehl um.
set <name> getTemperature

Ermittelt die aktuelle Temperatur die am Gerät gemessen wird.

Set für rmmini

set <name> <commandSend> <command name>

Sendet ein vorher aufgenommenen Befehl
set <name> recordNewCommand <command name>

Nimmt ein neuen Befehl auf. Man muss einen Befehlnamen angeben.
set <name> remove <command name>

Löscht einen vorher aufgezeichneten Befehl.
set <name> rename <old command name> <new command name>

Benennt einen vorher aufgezeichneten Befehl um.

Set für sp3

set <name> on

Schaltet das Gerät an.
set <name> off

Schaltet das Gerät aus.
set <name> toggle

Schaltet das Gerät entweder ein oder aus.
set <name> getStatus

Ermittelt den aktuellen Status des Gerätes.

Set für sp3s

set <name> on

Schaltet das Gerät an.
set <name> off

Schaltet das Gerät aus.
set <name> toggle

Schaltet das Gerät entweder ein oder aus.
set <name> getStatus

Ermittelt den aktuellen Status des Gerätes.
set <name> getEnergy

Ermittelt den aktuellen Stromverbrauch des angeschlossenen Gerätes.

Attribute für alle Broadlink Gräte

socket_timeout

Setzt den Timeout für die Gerätekommunikation.

CALVIEW

[EN DE]

Dieses Modul erstellt ein Device welches als Readings Termine eines oder mehrere Kalender(s), basierend auf dem 57_Calendar.pm Modul, besitzt. Ihr müsst das Perl-Modul Date::Parse installieren!

Bitte setzt das Attribut HideOlderThen in eurem CALENDAR_Device, da sonst auch vergangene Termine gezeigt werden. Define

define <Name> CALVIEW <Kalendername(n) getrennt durch ','> <next> <updateintervall in sek (default 43200)>

define myView CALVIEW Googlekalender next

define myView CALVIEW Googlekalender,holiday next 900

- die Einstellung des Aktualisierungsintervalls wird normalerweise nicht benötigt, da jede Kalenderaktualisierung ein Caview-Update auslöst Set

update readings:

set <Name> update

set myView update

Attributes

datestyle
nicht gesetzt - Standard, Readings bdatetimeiso / edatetimeiso werden nicht gezeigt
ISO8601 - aktiviert die readings bdatetimeiso / edatetimeiso (zeigen Terminstart und Ende im ISO8601 Format zB. 2017-02-27T00:00:00)

disable
0 / nicht gesetzt - aktiviert die interne Notify-Funktion (Standard)
1 - deaktiviert die interne Notify-Funktion welche ausgelöst wird wenn sich einer der Kalender aktualisiert hat

filterSummary <filtersouce>:<filtersummary>[,<filtersouce>:<filtersummary>]
not set - zeigt alle Termine (Standard)
<filtersouce>:<filtersummary>[,<filtersouce>:<filtersummary>] - CALVIEW filtert Termine die <filtersquelle>:<filtertitel> entsprechen, mehrere Filter sind durch Komma (,) zu trennen. zb.: filterSummary Kalender_Abfall:Leichtverpackungen,Kalender_Abfall:Bioabfall filterSummary Kalender_Abfall:Leichtverpackungen,Kalender_Feiertage:.*,Kalender_Christian:.*,Kalender_Geburtstage:.*

fulldaytext [text]
Dieser Text wird bei ganztägigen Terminen in _timeshort Readings genutzt (default ganztägig)

isbirthday
0 / nicht gesetzt - keine Altersberechnung (Standard)
1 - aktiviert die Altersberechnung im Modul. Das Alter wird aus der in der Terminbeschreibung (description) angegebenen Jahreszahl (Geburtsjahr) berechnet. (siehe Attribut yobfield)

maxreadings
bestimmt die Anzahl der Termine als Readings

modes
hier können die CALENDAR modi gewählt werden, welche in der View angezeigt werden sollen

oldStyledReadings
0 die Standarddarstellung für Readings
1 aktiviert die Termindarstellung im "alten" Format "2015.06.21-00:00" mit Wert "Start of Summer"

sourcecolor <calendername>:<colorcode>[,<calendername>:<colorcode>]
Hier kann man die Farben für die einzelnen Calendar definieren die dann zb im Tabletui widget genutzt werden kann. Die calendar:color Elemente sind durch Komma zu trennen. So kann man zb die google-Kalender Farben auch in der TUI für eine gewohnte Anzeige nutzen.

timeshort
0 Zeit in _timeshort Readings im Format 00:00:00 - 00:00:00
1 Zeit in _timeshort Readings im Format 00:00 - 00:00

yobfield
_description - (der Standard) Geburtsjahr wird aus der Terminbechreibung gelesen
_location - Geburtsjahr wird aus dem Terminort gelesen
_summary - Geburtsjahr wird aus dem Termintiele gelesen (verwendet wird die erste folge von 4 Ziffern im String))

weekdayformat
formatiert den Namen im Reading weekdayname
- de-long - (default) Deutsch, lang zb Dienstag
- de-short - Deutsch, kurze zb Di
- en-long - English, lang zb Tuesday
- en-short - English, kurze zb Tue

CM11

CO20

CUL

[EN DE]

Der CUL/CUN(O) ist eine Familie von Funkempfängern, die von der Firma Busware verkauft wird. Mit der OpenSource Firmware culfw können sie verschiedene 868 MHz Funkprotokolle empfangen bzw. senden (FS20/FHT/S300/EM/HMS/MAX!). Man kann diese Geräte auch zur Reichweitenverlängerung, siehe CUL_RFR einsetzen.

Einige Protokolle (FS20, FHT und KS300) werden von diesem Modul in das FHZ Format konvertiert, daher kann dasselbe logische Gerät verwendet werden, egal ob das Funktelegramm von einem CUL oder einem FHZ Gerät empfangen wird.
Andere Protokolle (S300/EM) benötigen ihre eigenen Module. S300 Geräte werden vom Modul CUL_WS verarbeitet, wenn das Signal von einem CUL empfangen wurde, ähnliches gilt für EMWZ/EMGZ/EMEM: diese werden vom CUL_EM Modul verarbeitet.

Es ist möglich mehr als ein Gerät zu verwenden, um einen besseren Empfang zu erhalten, FHEM filtert doppelte Funktelegramme aus.

Bemerkung: Dieses Modul benötigt unter Umständen das Device::SerialPort bzw. Win32::SerialPort Modul, wenn Sie das Gerät über USB anschließen und das Betriebssystem unübliche Parameter für serielle Schnittstellen setzt.

Define

define <name> CUL <device> <FHTID>


          modprobe usbserial vendor=0x03eb product=0x204b

Device::SerialPort

<device> gibt die Hostadresse:Port des Gerätes an, z.B. 192.168.0.244:2323

Set

reopen
Öffnet die Verbindung zum Gerät neu und initialisiert es.

raw
Sendet einen CUL Firmware Befehl. Siehe auch hier für nähere Erläuterungen der CUL Befehle.

freq / bWidth / rAmpl / sens
Nur in der Betriebsart SlowRF.
Bestimmt die CUL Frequenz / Bandbreite / Empfänger Amplitude / Empfindlichkeit
Bitte mit Vorsicht verwenden, da es die verwendete Hardware zerstören kann bzw. es zu illegalen Funkzuständen kommen kann.
Bemerkung: Die Parameter für die RFR Übermittlung werden hierdurch nicht beeinflußt.
- freq bestimmt sowohl die Empfangs- als auch die Sendefrequenz.
  Bemerkung: Auch wenn der CC1101 zwischen den Frequenzen 315 und 915 MHz eingestellt werden kann, ist die Antennenanbindung bzw. die Antenne des CUL exakt auf eine Frequenz eingestellt. Standard ist 868.3 MHz (bzw. 433 MHz).
- bWidth kann zwischen 58 kHz und 812 kHz variiert werden. Große Werte sind empfindlicher gegen Interferencen, aber machen es möglich, nicht genau kalbrierte Signale zu empfangen. Die Einstellung beeinflusst ebenso die Übertragung. Standardwert ist 325 kHz.
- rAmpl ist die Verstärkung des Empfängers mit Werten zwischen 24 and 42 dB. Größere Werte erlauben den Empfang von schwachen Signalen. Standardwert ist 42.
- sens ist die Entscheidungsgrenze zwischen "on" und "off" Zuständen und kann 4, 8, 12 oder 16 dB sein. Kleinere Werte erlauben den Empfang von undeutlicheren Signalen. Standard ist 4 dB.

hmPairForSec
Nur in der Betriebsart HomeMatic.
Versetzt den CUL für die angegebene Zeit in Sekunden in den Anlern-Modus. Jedes HM Gerät, das sich im Anlern-Modus befindet, wird an FHEM angelernt.

hmPairSerial
Nur in der Betriebsart HomeMatic.
Versucht, das angegebene Gerät anzulernen (zu "pairen"). Der Parameter ist eine 10-stellige Zeichenfolge, die normalerweise mit Buchstaben beginnt und mit Ziffern endet; diese sind auf der Rückseite der Geräte aufgedruckt. Wenn das Gerät ein Empfänger ist, ist es nicht notwendig, das angegebene Gerät in den Anlern-Modus zu versetzen.

led
Schaltet die LED des CUL: aus (00), an (01) oder blinkend (02).

ITClock
Setzt die IT clock fü Intertechno V1 Protokoll. Default 250.

Get

version
gibt die Version der CUL Firmware zurück

uptime
gibt die Betriebszeit des CULs zurück (Zeit seit dem letzten Reset des CULs)

raw
Sendet einen CUL Firmware Befehl und wartet auf eine Rückgabe des CULs. Siehe auch README der Firmware für nähere Erläuterungen zu den CUL Befehlen.

fhtbuf
Der CUL hat einen Puffer für Nachrichten für FHT. Wenn der Puffer voll ist, werden neu empfangene Telegramme ignoriert und eine "EOB" Meldung wird in die FHEM Logdatei geschrieben. fhtbuf gibt den freien Speicher dieses Puffers (in hex) zurück, ein leerer Puffer im CUL V2 hat 74 Byte, im CUL V3/CUN(O) hat 200 Byte. Eine Telegramm benötigt 3 + 2x(Anzahl der FHT Befehle) Byte, dies ist ein Grund, warum man mehrere FHT Befehle mit einem set senden sollte. Ein weiterer Grund ist, dass diese FHT Befehle in einem "Paket" zum FHT Gerät gesendet werden.

ccconf
Liest einige CUL Register des CC1101 (Sende- und Empfängerchips) aus (Frequenz, Bandbreite, etc.) und stellt diese in lesbarer Form dar.

cmds
In abhägigkeit der installierten Firmware hat der CUL/CUN(O) unterschiedliche Befehlssätze. Nähere Informationen über die Befehle bzw. deren Interpretation siehe README Datei der verwendeten CUL Firmware. Siehe auch Anmerkungen beim raw Befehl.

credit10ms
Der Funkraum darf für eine Dauer von credit10ms*10 ms belegt werden, bevor die gesetzliche 1% Grenze erreicht ist und eine LOVF Meldung ausgegeben wird.

Attribute

addvaltrigger
Generiert Trigger für zusätzliche Werte. Momentan sind dies RSSI und RAWMSG für die CUL Familie und RAWMSG für FHZ.

connectCommand
culfw Befehl, was nach dem Verbindungsaufbau mit dem USB-Gerät, nach Senden der zum Initialisieren der konfigurierten rfmode benötigten Befehle gesendet wird.
do_not_notify
dummy
hmId
Setzt die HomeMatic ID des Gerätes. Wenn dieses Attribut fehlt, wird die ID zu F1<FHTID> gesetzt. Bemerkung 1: Nach dem Setzen bzw. Verändern dieses Attributes müssen alle HomeMatic Geräte neu angelernt werden. Bemerkung 2: Der Wert muss eine 6-stellige Hexadezimalzahl sein, 000000 ist ungültig. FHEM überprüft nicht, ob die ID korrekt ist, im Zweifelsfall funktioniert die Kommunikation nicht.

hmProtocolEvents
Generiert Ereignisse für HomeMatic Telegramme. Diese werden normalerweise für die Fehlersuche verwendet, z.B. durch Aktivieren von inform timer in einer telnet Sitzung bzw. im Event Monitor Fenster im FHEMWEB Frontend.
Beispiel:

longids
Durch Kommata getrennte Liste von Device-Typen für Empfang von langen IDs mit den CUL. Diese zusätzliche ID erlaubt es Wettersensoren, welche auf dem gleichen Kanal senden zu unterscheiden. Hierzu wird eine zufällig generierte ID hinzugefügt. Wenn Sie longids verwenden, dann wird in den meisten Fällen nach einem Batteriewechsel ein neuer Sensor angelegt. Standardmäßig werden keine langen IDs verwendet.
Folgende Module verwenden diese Funktionalität: 14_Hideki, 41_OREGON, 14_CUL_TCM97001, 14_SD_WS07.
Beispiele:

model (CUL,CUN)

rfmode
Konfiguriert den RF Transceiver des CULs (CC1101). Verfügbare Argumente sind:
- SlowRF
  Für die Kommunikation mit FS20/FHT/HMS/EM1010/S300/Hoermann Geräten @1 kHz Datenrate (Standardeinstellung).
- HomeMatic
  Für die Kommunikation mit HomeMatic Geräten @10 kHz Datenrate.
- MAX
  Für die Kommunikation mit MAX! Geräten @10 kHz Datenrate.
- WMBus_S
- WMBus_T
- WMBus_C
  Für die Kommunikation mit Wireless M-Bus Geräten wie Wasser-, Gas- oder Elektrozählern. Wireless M-Bus verwendet drei unterschiedliche Kommunikationsarten, S-Mode, T-Mode und C-Mode. In diesem Modus ist der Empfang von anderen Protokollen wie SlowRF oder HomeMatic nicht möglich.

sendpool
Wenn mehr als ein CUL verwendet wird, um einen größeren Bereich abzudecken, können diese sich gegenseitig beeinflussen. Dieses Phänomen wird auch Palm-Beach-Resort Effekt genannt. Wenn man diese zu einen gemeinsamen Sende"pool" zusammenschließt, wird das Senden der einzelnen Telegramme seriell (d.h. hintereinander) durchgeführt. Wenn z.B. drei CUN's zur Verfügung stehen, werden folgende Attribute gesetzt:
attr CUN1 sendpool CUN1,CUN2,CUN3 attr CUN2 sendpool CUN1,CUN2,CUN3 attr CUN3 sendpool CUN1,CUN2,CUN3

showtime
readingFnAttributes

CUL_EM

[EN DE]

Define

define <name> CUL_EM <code> [corr1 corr2
                CostPerUnit BasicFeePerMonth]

corr1

corr2

für EMWZ Geräte wird die Umdrehungsgeschwindigkeit (U/kW) des verwendeten Stromzählers (z.B. 150) für corr1 und 12 mal diesen Wert für corr2 verwendet
für EMEM devices ist corr1 mit 0.01 und corr2 mit 0.001 anzugeben

CostPerUnit

BasicFeePerMonth


    define emwz 1 75 900 0.15 12.50


    CUM_DAY: 6.849 CUM: 60123.4 COST: 1.02

    CUM_MONTH: 212.319 CUM: 60123.4 COST: 44.34

Set

N/A

Get

N/A

Attributes

ignore

do_not_notify

showtime

model (EMEM,EMWZ,EMGZ)

IODev

eventMap

readingFnAttributes

maxPeak <number>
Gibt den maximal möglichen Spitzenwert für das EM-Meter an ("TOP:"-Wert in Logdatei). Spitzenwerte größer als dieser Wert gelten als EM-Lesefehler und werden ignoriert. Wenn es z.B. nicht möglich ist mehr zu 40kW Leistung zu beziehen setzt man maxPeak auf 40 um das Auslesen des Stromzählers robuster zu machen.

CounterOffset
Gibt den Unterschied zwischen dem tatsächlichen Zählerstand und dem vom EMGZ gemeldeten Wert an.
CounterOffset = tatsächlicher Zählerstand - Reading "total"
Beispiel:

CUL_FHTTK

[EN DE]

define <name> CUL_FHTTK <devicecode>

<devicecode>

define TK_TEST CUL_FHTTK 965AB0

Set

set <name> <value>

value

Closed
setzt den Fensterstatus zu Closed

Open
setzt den Fensterstatus zu Open

Pair
startet das Anlernen an das FHT80B (FHT80B muss sich im Sync mode befinden) - danach wird der state auf "Closed" gesetzt

ReSync
neu synchronisieren des virtuellen Sensor mit dem FHT80b Module. Damit wird ein virtueller Batteriewechsel simuliert und der angelernte Sensor wieder aufsynchronisiert. (aktuell nur mit Prototyp CUL FW verfügbar Forum 55774)

Spezielles zum "ReSync" von vorhanden FHT80TFs nach einem CUL Firmware Reset:

CUL_FHTTK_ReSyncAll()

nacheinander

1 Stunde

Get

N/A

Attributes

do_not_notify

verbose

model
Mögliche Werte sind: FHT80TF, FHT80TF-2, virtual (zum simulieren eines Fensterkontaktes)

showtime

IODev

ignore

eventMap

readingFnAttributes

CUL_HM

[EN DE]

Lesbarkeit der Definitionen

HMLAN

Define

define <name> CUL_HM <6-digit-hex-code|8-digit-hex-code>


        define livingRoomSwitch CUL_HM 123456

        define LivingroomMainLight CUL_HM 12345601

        define LivingroomBackLight CUL_HM 12345602

autocreate

hmPairForSec

hmPairSerial

Der <6-stellige-Hex-Code>oder HMid+ch <8-stelliger-Hex-Code>
Das ist eine einzigartige, festgelegte Geräteadresse die nicht geändert werden kann (nein, man kann sie nicht willkürlich auswählen wie z.B. bei FS20 Geräten). Man kann sie feststellen indem man das FHEM-Log durchsucht.
Das subType Attribut
Dieses lautet: switch dimmer blindActuator remote sensor swi pushButton threeStateSensor motionDetector keyMatic winMatic smokeDetector
Das model Attribut
ist entsprechend der HM Nomenklatur zu vergeben

Hinweise

Falls das Interface ein Gerät vom Typ CUL ist muss rfmode des zugehörigen CUL/CUN Gerätes auf HomeMatic gesetzt werden. Achtung: Dieser Modus ist nur für BidCos/Homematic. Nachrichten von FS20/HMS/EM/S300 werden durch diese Gerät nicht empfangen. Bereits definierte FS20/HMS Geräte müssen anderen Eingängen zugeordnet werden (CUL/FHZ/etc).
Nachrichten eines Geräts werden nur richtig interpretiert wenn der Gerätetyp bekannt ist. FHEM erhält den Gerätetyp aus einer"pairing request" Nachricht, selbst wenn es darauf keine Antwort erhält (siehe hmPairSerial und hmPairForSec um Parinig zu ermöglichen). Alternativ, setzen des richtigen subType sowie Modelattributes, für eine Liste der möglichen subType-Werte siehe "attr hmdevice ?".

Die sogenannte "AES-Verschlüsselung" ist eigentlich eine Signaturanforderung: Ist sie aktiviert wird ein Aktor den erhaltenen Befehl nur ausführen falls er die korrekte Antwort auf eine zuvor durch den Aktor gestellte Anfrage erhält. Das bedeutet:
- Die Reaktion auf Befehle ist merklich langsamer, da 3 Nachrichten anstatt einer übertragen werden bevor der Befehl vom Aktor ausgeführt wird.
- Jeder Befehl sowie seine Bestätigung durch das Gerät wird in Klartext übertragen, ein externer Beobachter kennt somit den Status jedes Geräts.
- Die eingebaute Firmware ist fehlerhaft: Ein "toggle" Befehl wir ausgeführt bevor die entsprechende Antwort auf die Signaturanforderung empfangen wurde, zumindest bei einigen Schaltern (HM-LC-SW1-PL und HM-LC-SW2-PB-FM).
- Der HMLAN Konfigurator beantwortet Signaturanforderungen selbstständig, ist dabei die 3-Byte-Adresse einer anderen CCU eingestellt welche noch immer das Standardpasswort hat, kann dieser Signaturanfragen korrekt beantworten.
- AES-Verschlüsselung wird durch HMLAN und CUL unterstützt. Bei Einsatz eines CUL ist das Perl-Modul Crypt::Rijndael notwendig. Aufgrund dieser Einschränkungen ist der Einsatz der Homematic-Verschlüsselung nicht zu empfehlen!

Set

clear <[rssi|readings|register|msgEvents|attack|all]>
Eine Reihe von Variablen kann entfernt werden.
getConfig
Liest die Hauptkonfiguration eines HM_Gerätes aus. Angewendet auf einen Kanal erhält man Pairing-Information, List0, List1 und List3 des ersten internen Peers. Außerdem erhält man die Liste der Peers für den gegebenen Kanal. Wenn auf ein Gerät angewendet so bekommt man mit diesem Befehl die vorherigen Informationen für alle zugeordneten Kanäle. Ausgeschlossen davon sind Konfigurationen zusätzlicher Peers.
Der Befehl ist eine Abkürzung für eine Reihe anderer Befehle.
getRegRaw [List0|List1|List2|List3|List4|List5|List6]<peerChannel>
Auslesen der Rohdaten des Registersatzes. Eine Beschreibung der Register sprengt den Rahmen dieses Dokuments.
Die Register sind in sog. Listen strukturiert welche einen Satz Register enthalten.
List0: Geräteeinstellungen z.B: Einstellungen für CUL-Pairing Temperaturlimit eines Dimmers.
List1: Kanaleinstellungen z.B. benötigte Zeit um Rollo hoch und runter zu fahren.
List3: "link" Einstellungen - d.h. Einstellungen für Peer-Kanal. Das ist eine große Datenmenge! Steuert Aktionen bei Empfang eines Triggers vom Peer.
List4: Einstellungen für den Kanal (Taster) einer Fernbedienung.

<PeerChannel> verknüpfte HMid+ch, z.B. 4 byte (8 stellige) Zahl wie '12345601'. Ist verpflichtend für List3 und List4 und kann ausgelassen werden für List0 und 1.
'all' kann verwendet werden um Daten von jedem mit einem Kanal verknüpften Link zu bekommen.
'selfxx' wird verwendet um interne Kanäle zu adressieren (verbunden mit den eingebauten Schaltern falls vorhanden). xx ist die Kanalnummer in dezimaler Notation.
Hinweis 1: Ausführung ist abhängig vom Entity. Wenn List1 für ein Gerät statt einem Kanal abgefragt wird gibt der Befehl List1 für alle zugehörigen Kanäle aus. List3 mit 'peerChannel = all' gibt alle Verbindungen für alle Kanäle eines Gerätes zurück.
Hinweis 2: für 'Sender' siehe auch remote
Hinweis 3: Das Abrufen von Informationen kann dauern - besonders für Geräte mit vielen Kanälen und Verknüpfungen. Es kann nötig sein das Webinterface manuell neu zu laden um die Ergebnisse angezeigt zu bekommen.
Hinweis 4: Direkte Schalter eines HM-Geräts sind standardmäßig ausgeblendet. Dennoch sind sie genauso als Verknüpfungen implemetiert. Um Zugriff auf 'internal links' zu bekommen ist es notwendig folgendes zu erstellen:
'set <name> regSet intKeyVisib visib'
oder
'set <name> regBulk RegL_0. 2:81'
Zurücksetzen lässt es sich indem '81' mit '01' ersetzt wird.
example:
getSerial
Auslesen der Seriennummer eines geräts und speichern in Attribut serialNr.
inhibit [on|off]
Blockieren/Zulassen aller Kanaländerungen eines Aktors, d.h. Zustand des Aktors ist eingefroren bis 'inhibit' wieder deaktiviert wird. 'Inhibit' kann für jeden Aktorkanal ausgeführt werden aber natürlich nicht für Sensoren - würde auch keinen Sinn machen.
Damit ist es praktischerweise möglich Nachrichten ebenso wie verknüpfte Kanalaktionen temporär zu unterdrücken ohne sie löschen zu müssen.
Beispiele:
pair
Verbinden eines Geräts bekannter Seriennummer (z.b. nach einem Reset) mit einer FHEM-Zentrale. Diese Zentrale wird normalerweise durch CUL/CUNO, HMLAN,... hergestellt. Wenn verbunden melden Geräte ihren Status and FHEM. Wenn nicht verbunden wird das Gerät auf bestimmte Anfragen nicht reagieren und auch bestimmte Statusinformationen nicht melden. Pairing geschieht auf Geräteebene. Kanäle können nicht unabhängig von einem Gerät mit der Zentrale verbunden werden. Siehe auch getPair und unpair.
Nicht das Verbinden (mit einer Zentrale) mit verknüpfen (Kanal zu Kanal) oder peerChan verwechseln.
peerBulk <peerch1,peerch2,...> [set|unset]
peerBulk fügt Peer-Kanäle zu einem Kanal hinzu. Alle Peers einer Liste werden dabei hinzugefügt.
Peering setzt die Einstellungen einer Verknüpfung auf Standardwerte. Da Peers nicht in Gruppen hinzugefügt werden werden sie durch HM standardmäßig als'single' für dieses Gerät angelegt.
Eine ausgeklügeltere Funktion wird gegeben durch peerChan.
peerBulk löscht keine vorhandenen Peers sondern bearbeitet nur die Peerliste. Andere bereits angelegt Peers werden nicht verändert.
peerBulk kann verwendet werden um Peers zu löschen indem die unset Option mit Standardeinstellungen aufgerufen wird.
Verwendungszweck dieses Befehls ist hauptsächlich das Wiederherstellen von Daten eines Geräts. Empfehlenswert ist das anschließende Wiederherstellen der Registereinstellung mit regBulk.
Beispiel:
regBulk <reg List>.<peer> <addr1:data1> <addr2:data2>...
Dieser Befehl ersetzt das bisherige regRaw. Er erlaubt Register mit Rohdaten zu beschreiben. Hauptzweck ist das komplette Wiederherstellen eines zuvor gesicherten Registers.
Werte können mit getConfig ausgelesen werden. Die zurückgegebenen Werte können direkt für diesen Befehl verwendet werden.
<reg List> bezeichnet die Liste in die geschrieben werden soll. Mögliches Format '00', 'RegL_00', '01'...
<peer> ist eine optionale Angabe falls die Liste ein Peer benötigt. Der Peer kann als Kanalname oder als 4-Byte (8 chars) HM-Kanal ID angegeben werden.
<addr1:data1> ist die Liste der Register im Hex-Format.
Beispiel:
myblind setzt die maximale Zeit für das Hochfahren der Rollos auf 25,6 Sekunden
regSet [prep|exec] <regName> <value> <peerChannel>
Für einige Hauptregister gibt es eine lesbarere Version die Registernamen <regName> und Wandlung der Werte enthält. Nur ein Teil der Register wird davon unterstützt.
Der optionale Parameter [prep|exec] erlaubt das Packen von Nachrichten und verbessert damit deutlich die Datenübertragung. Benutzung durch senden der Befehle mit Parameter "prep". Daten werden dann für das Senden gesammelt. Der letzte Befehl muss den Parameter "exec" habe um die Information zu übertragen.
<value> enthält die Daten in menschenlesbarer Form die in das Register geschrieben werden.
<peerChannel> wird benötigt falls das Register 'peerChan' basiert definiert wird. Kann ansonsten auf '0' gesetzt werden. Siehe getRegRaw für komplette Definition.
Unterstützte Register eines Geräts können wie folgt bestimmt werden:
Eine verkürzte Beschreibung der Register wird zurückgegeben mit:
reset
Rücksetzen des Geräts auf Werkseinstellungen. Muss danach erneut verbunden werden um es mit FHEM zu nutzen.
sign [on|off]
Ein- oder ausschalten der Signierung (auch "AES-Verschlüsselung" genannt, siehe note). Achtung: Wird das Gerät über einen CUL eingebunden, ist schalten (oder deaktivieren der Signierung) nur möglich, wenn das Perl-Modul Crypt::Rijndael installiert ist.
statusRequest
Aktualisieren des Gerätestatus. Für mehrkanalige Geräte sollte dies kanalbasiert erfolgen.
unpair
Aufheben des "Pairings", z.B. um das verbinden mit einem anderen Master zu ermöglichen. Siehe pair für eine Beschreibung.
virtual <Anzahl an Knöpfen>
Konfiguriert eine vorhandene Schaltung als virtuelle Fernbedienung. Die Anzahl der anlegbaren Knöpfe ist 1 - 255. Wird der Befehl für die selbe Instanz erneut aufgerufen werden Knöpfe hinzugefügt.
Beispiel für die Anwendung:
siehe auch press
deviceRename <newName>
benennt das Device und alle seine Kanäle um.
fwUpdate [onlyEnterBootLoader] <filename> [<waitTime>]
update Fw des Device. Der User muss das passende FW file bereitstellen. waitTime ist optional. Es ist die Wartezeit, um das Device manuell in den FW-update-mode zu versetzen.
"onlyEnterBootLoader" schickt das Device in den Booloader so dass es vom eq3 Firmware Update Tool geflashed werden kann. Hauptsächlich für Unterputz-Aktoren in Verbindung mit FHEM Installationen die ausschliesslich HM-LANs nutzen interessant.

subType abhängige Befehle:

switch
- on - setzt Wert auf 100%
- off - setzt Wert auf 0%
- on-for-timer <sec> - Schaltet das Gerät für die gewählte Zeit in Sekunden [0-85825945] an.
  Hinweis: off-for-timer wie bei FS20 wird nicht unterstützt. Kann aber über Kanalregister programmiert werden.
- on-till <time> - einschalten bis zum angegebenen Zeitpunkt.
  Das momentane Maximum für eine Endzeit liegt bei 24 Stunden.
- pressL <peer> [<repCount>] [<repDelay>]
  simuliert einen Tastendruck eines lokalen oder anderen peers.
  <peer> peer auf den der Tastendruck bezogen wird.
  <repCount> automatische Wiederholungen des long press.
  <repDelay> timer zwischen den Wiederholungen.
  Beispiel: set actor pressL FB_Btn01 # trigger long peer FB button 01 set actor pressL FB_chn-8 # trigger long peer FB button 08 set actor pressL self01 # trigger short des internen peers 01 set actor pressL fhem02 # trigger short des FHEM channel 2
- pressS <peer>
  simuliert einen kurzen Tastendruck entsprechend peerL
- eventL <peer> <condition> [<repCount>] [<repDelay>]
  simuliert einen Event mit zusätzlichem Wert.
  <peer> peer auf den der Tastendruck bezogen wird.
  <codition>wert des Events, 0..255
  Beispiel: set actor eventL md 30 # trigger vom Bewegungsmelder mit Wert 30
- eventS <peer> <condition>
  simuliert einen kurzen Event eines Peers des actors. Typisch senden Sensoren nur short Events.
dimmer, blindActuator
Dimmer können virtuelle Kanäle unterstützen. Diese werden automatisch angelegt falls vorhanden. Normalerweise gibt es 2 virtuelle Kanäle zusätzlich zum primären Kanal. Virtuelle Dimmerkanäle sind standardmäßig deaktiviert, können aber parallel zum ersten Kanal benutzt werden um das Licht zu steuern.
Die virtuellen Kanäle haben Standardnamen SW<channel>_V<nr> z.B. Dimmer_SW1_V1 and Dimmer_SW1_V2.
Virtuelle Dimmerkanäle unterscheiden sich komplett von virtuellen Knöpfen und Aktoren in FHEM, sind aber Teil des HM-Geräts. Dokumentation und Möglichkeiten würde hier aber zu weit führen.
- 0 - 100 [on-time] [ramp-time]
  Setzt den Aktor auf den gegeben Wert (In Prozent) mit einer Auflösung von 0.5.
  Bei Dimmern ist optional die Angabe von "on-time" und "ramp-time" möglich, beide in Sekunden mit 0.1s Abstufung.
  "On-time" verhält sich analog dem "on-for-timer".
  "Ramp-time" beträgt standardmäßig 2.5s, 0 bedeutet umgehend.
- on
- off
- press <[short|long]><[on|off]>
- toggle
- toggleDir - toggelt die fahrtrichtung des Rollo-Aktors. Es wird umgeschaltet zwischen auf/stop/ab/stop
- on-for-timer <sec> - Nur Dimmer!
- on-till <time> - Nur Dimmer!
- stop - Stopt Bewegung (Rollo) oder Dimmerrampe
- old - schaltet auf den vorigen Wert zurück. Nur dimmer.
- pct <level> [<ontime>] [<ramptime>] - setzt Aktor auf gewünschten absolut Wert.
  Optional können für Dimmer "ontime" und "ramptime" angegeben werden.
  "Ontime" kann dabei in Sekunden angegeben werden. Kann auch als Endzeit angegeben werden im Format hh:mm:ss
- up [changeValue] [<ontime>] [<ramptime>] Einen Schritt hochdimmen.
- down [changeValue] [<ontime>] [<ramptime>] Einen Schritt runterdimmen.
  "changeValue" ist optional und gibt den zu ändernden Wert in Prozent an. Mögliche Abstufung dabei ist 0.5%, Standard ist 10%.
  "ontime" ist optional und gibt an wielange der Wert gehalten werden soll. '0' bedeutet endlos und ist Standard.
  "ramptime" ist optional und definiert die Zeit bis eine änderung den neuen Wert erreicht. Hat nur für Dimmer Bedeutung.
remotes, pushButton
Diese Geräteart reagiert nicht auf Anfragen, außer sie befinden sich im Lernmodus. FHEM reagiert darauf indem alle Anfragen gesammelt werden bis der Lernmodus detektiert wird. Manuelles Eingreifen durch den Benutzer ist dazu nötig. Ob Befehle auf Ausführung warten kann auf Geräteebene mit dem Parameter 'protCmdPend' abgefragt werden.
- trgEventS [all|<peer>] <condition>
  Initiiert ein eventS fuer die peer entity. Wenn all ausgewählt ist wird das Kommando bei jedem der Peers ausgeführt. Siehe auch eventS
  <condition>: Ist der Wert welcher mit dem Event versendet wird. Bei einem Bewegungsmelder ist das bspw. die Helligkeit.
- trgEventL [all|<peer>] <condition>
  Initiiert ein eventL fuer die peer entity. Wenn all ausgewählt ist wird das Kommando bei jedem der Peers ausgeführt. Siehe auch eventL
  <condition>: is the condition being transmitted with the event. E.g. the brightness in case of a motion detector.
- trgPressS [all|<peer>]
  Initiiert ein pressS fuer die peer entity. Wenn all ausgewählt ist wird das Kommando bei jedem der Peers ausgeführt. Siehe auch pressS
- trgPressL [all|<peer>]
  Initiiert ein pressL fuer die peer entity. Wenn all ausgewählt ist wird das Kommando bei jedem der Peers ausgeführt. Siehe auch pressL
- peerChan <btn_no> <actChan> [single|dual|reverse] [set|unset] [both|actor|remote]
  "peerChan" richtet eine Verbindung zwischen Sender-Kanal und Aktor-Kanal ein, bei HM "link" genannt. "Peering" darf dabei nicht mit "pairing" verwechselt werden.
  Pairing bezeichnet das Zuordnen eines Geräts zu einer Zentrale.
  Peering bezeichnet das faktische Verbinden von Kanälen.
  Peering erlaubt die direkte Interaktion zwischen Sender und Aktor ohne den Einsatz einer CCU
  Peering eines Senderkanals veranlaßt den Sender nach dem Senden eines Triggers auf die Bestätigung eines - jeden - Peers zu warten. Positives Feedback (z.B. grüne LED) gibt es dabei nur wenn alle Peers den Befehl bestätigt haben.
  Peering eines Aktorkanals richtet dabei einen Satz von Parametern ein welche die auszuführenden Aktionen definieren wenn ein Trigger dieses Peers empfangen wird. Dies bedeutet:
  - nur Trigger von Peers werden ausgeführt
  - die auszuführende Aktion muss für den zugehörigen Trigger eines Peers definiert werden
  Ein Aktorkanal richtet dabei eine Standardaktion beim Peering ein - diese hängt vom Aktor ab. Sie kann ebenfalls davon abhängen ob ein oder zwei Tasten ein einem Befehl gepeert werden. Peert man einen Schalter mit 2 Tasten kann eine Taste für 'on' und eine andere für 'off' angelegt werden. Wenn nur eine Taste definiert wird ist die Funktion wahrscheinlich 'toggle'.
  Die Funktion kann durch programmieren des Register (vom Aktor abhängig) geändert werden.
  Auch wenn der Befehl von einer Fernbedienung oder einem Taster kommt hat er direkten Effekt auf den Aktor. Das Peering beider Seiten ist quasi unabhängig und hat unterschiedlich Einfluss auf Sender und Empfänger.
  Peering eines Aktorkanals mit mehreren Senderkanälen ist ebenso möglich wie das eines Senderkanals mit mehreren Empfängerkanälen.
  <actChan> ist der zu verknüpfende Aktorkanal.
  <btn_no> ist der zu verknüpfende Senderkanal (Knopf). Wird 'single' gewählt werden die Tasten von 1 an gezählt. Für 'dual' ist btn_no die Nummer des zu verwendenden Tasterpaares. Z.B. ist '3' iim Dualmodus das dritte Tasterpaar welches mit Tasten 5 und 6 im Singlemodus übereinstimmt.
  Wird der Befehl auf einen Kanal angewendet wird btn_no igroriert. Muss gesetzt sein, sollte dabei 0 sein.
  [single|dual]: Dieser Modus bewirkt das Standardverhalten des Aktors bei Benutzung eines Tasters. Ein Dimmer kann z.B. an einen einzelnen oder ein Paar von Tastern angelernt werden.
  Standardeinstellung ist "dual".
  'dual' (default) Schalter verknüpft zwei Taster mit einem Aktor. Bei einem Dimmer bedeutet das ein Taster für hoch- und einer für runterdimmen.
  'reverse' identisch zu dual - nur die Reihenfolge der Buttons ist gedreht
  'single' benutzt nur einen Taster des Senders. Ist z.B. nützlich für einen einfachen Schalter der nur zwischen an/aus toggled. Aber auch ein Dimmer kann an nur einen Taster angelernt werden.
  [set|unset]: Wählt aus ob Peer hinzugefügt oder entfernt werden soll.
  Hinzufügen ist Standard.
  'set' stellt Peers für einen Kanal ein.
  'unset' entfernt Peer für einen Kanal.
  [actor|remote|both] beschränkt die Ausführung auf Aktor oder Fernbedienung. Das ermöglicht dem Benutzer das entfernen des Peers vom Fernbedienungskanal ohne die Einstellungen am Aktor zu entfernen.
  Standardmäßig gewählt ist "both" für beides.
  Example:
virtual
- peerChan siehe remote
- press [long|short] [<peer>] [<repCount>] [<repDelay>]
  - [long|short] soll ein langer oder kurzer Taastendrucl simuliert werden? Default ist kurz.
  - [<peer>] legt fest, wessen peer's trigger simuliert werden soll.Default ist self(channelNo).
  - [<repCount>] nur gueltig fuer long. wie viele messages sollen gesendet werden? (Laenge des Button press). Default ist 1.
  - [<repDelay>] nur gueltig fuer long. definiert die Zeit zwischen den einzelnen Messages.
- virtTemp <[off -10..50]> Simuliert ein Thermostat. Wenn mit einem Gerät gepeert wird periodisch eine Temperatur gesendet, solange bis "off" gewählt wird. Siehe auch virtHum
- virtHum <[off -10..50]> Simuliert den Feuchtigkeitswert eines Thermostats. Wenn mit einem Gerät verknüpft werden periodisch Luftfeuchtigkeit undTemperatur gesendet, solange bis "off" gewählt wird. Siehe auch virtTemp
- valvePos <[off 0..100]> steuert einen Ventilantrieb
smokeDetector
Hinweis: All diese Befehle funktionieren momentan nur wenn mehr als ein Rauchmelder vorhanden ist, und diese gepeert wurden um eine Gruppe zu bilden. Um die Befehle abzusetzen muss der Master dieser gruppe verwendet werden, und momentan muss man raten welcher der Master ist.
smokeDetector kann folgendermaßen in Gruppen eingeteilt werden: peerChan. Alle Mitglieder müssen mit dem Master verknüpft werden. Auch der Master muss mit peerChan zur Gruppe zugefügt werden - z.B. mit sich selbst verknüpft! Dadurch hat man volle Kontrolle über die Gruppe und muss nicht raten.
- teamCall - führt einen Netzwerktest unter allen Gruppenmitgliedern aus
- teamCallBat - Simuliert einen low-battery alarm
- alarmOn - löst einen Alarm aus
- alarmOff - schaltet den Alarm aus
4Dis (HM-PB-4DIS-WM|HM-PB-4DIS-WM|HM-RC-DIS-H-X-EU|ROTO_ZEL-STG-RM-DWT-10)
- text <btn_no> [on|off] <text1> <text2>
  Zeigt Text auf dem Display eines Geräts an. Für diesen Zweck muss zuerst ein set-Befehl (oder eine Anzahl davon) abgegeben werden, dann können im "teach-in" Menü des 4Dis mit "Central" Daten übertragen werden.
  Falls auf einen Kanal angewendet dürfen btn_no und on|off nicht verwendet werden, nur reiner Text.
  \_ wird durch ein Leerzeichen ersetzt.
  Beispiel:
Climate-Control (HM-CC-TC)
- desired-temp <temp>
  Setzt verschiedene Temperaturen. <temp> muss zwischen 6°C und 30°C liegen, die Auflösung beträgt 0.5°C.
- tempListSat [prep|exec] HH:MM temp ... 24:00 temp
- tempListSun [prep|exec] HH:MM temp ... 24:00 temp
- tempListMon [prep|exec] HH:MM temp ... 24:00 temp
- tempListTue [prep|exec] HH:MM temp ... 24:00 temp
- tempListThu [prep|exec] HH:MM temp ... 24:00 temp
- tempListWed [prep|exec] HH:MM temp ... 24:00 temp
- tempListFri [prep|exec] HH:MM temp ... 24:00 temp
  Gibt eine Liste mit Temperaturintervallen an. Bis zu 24 Intervall können pro Wochentag definiert werden, die Auflösung dabei sind 10 Minuten. Die letzte Zeitangabe muss 24:00 Uhr sein.
  Beispiel: bis 6:00 soll die Temperatur 19°C sein, dann bis 23:00 Uhr 22.5°C, anschließend werden bis Mitternacht 19°C gewünscht.
  set th tempListSat 06:00 19 23:00 22.5 24:00 19
- partyMode <HH:MM><durationDays>
  setzt die Steuerung für die angegebene Zeit in den Partymodus. Dazu ist die Endzeit sowie Anzahl an Tagen die er dauern soll anzugeben. Falls er am nächsten Tag enden soll ist '1' anzugeben
- sysTime
  setzt Zeit des Klimakanals auf die Systemzeit
Climate-Control (HM-CC-RT-DN|HM-CC-RT-DN-BoM)
- controlMode <auto|boost|day|night>
- controlManu <temp>
- controlParty <temp><startDate><startTime><endDate><endTime>
  setzt die Steuerung in den Partymodus, definiert Temperatur und Zeitrahmen.
  Beispiel:
  set controlParty 15 03-8-13 20:30 5-8-13 11:30
- sysTime
  setzt Zeit des Klimakanals auf die Systemzeit
- desired-temp <temp>
  Setzt verschiedene Temperaturen. <temp> muss zwischen 6°C und 30°C liegen, die Auflösung beträgt 0.5°C.
- tempListSat [prep|exec] HH:MM temp ... 24:00 temp
- tempListSun [prep|exec] HH:MM temp ... 24:00 temp
- tempListMon [prep|exec] HH:MM temp ... 24:00 temp
- tempListTue [prep|exec] HH:MM temp ... 24:00 temp
- tempListThu [prep|exec] HH:MM temp ... 24:00 temp
- tempListWed [prep|exec] HH:MM temp ... 24:00 temp
- tempListFri [prep|exec] HH:MM temp ... 24:00 temp
  Gibt eine Liste mit Temperaturintervallen an. Bis zu 24 Intervall können pro Wochentag definiert werden, die Auflösung dabei sind 10 Minuten. Die letzte Zeitangabe muss immer 24:00 Uhr sein.
  Der optionale Parameter [prep|exec] erlaubt das packen der Nachrichten und verbessert damit deutlich die Datenübertragung. Besonders nützlich wenn das Gerät im "Wakeup"-modus betrieben wird. Benutzung durch senden der Befehle mit Parameter "prep". Daten werden dann für das Senden gesammelt. Der letzte Befehl muss den Parameter "exec" habe um die Information zu übertragen.
  Beispiel: bis 6:00 soll die Temperatur 19°C sein, dann bis 23:00 Uhr 22.5°C, anschließend werden bis Mitternacht 19°C gewünscht.
  set th tempListSat 06:00 19 23:00 22.5 24:00 19
  set th tempListSat prep 06:00 19 23:00 22.5 24:00 19 set th tempListSun prep 06:00 19 23:00 22.5 24:00 19 set th tempListMon prep 06:00 19 23:00 22.5 24:00 19 set th tempListTue exec 06:00 19 23:00 22.5 24:00 19
- tempListTmpl =>"[verify|restore] [[<file>:]templateName] ...
  Die Temperaturlisten für ein oder mehrere Devices können in einem File hinterlegt werden. Es wird ein template für eine Woche hinterlegt. Der User kann dieses template in ein Device schreiben lassen (restore). Er kann auch prüfen, ob das Device korrekt nach dieser Templist programmiert ist (verify). Default Opeartion ist verify.
  Default File ist tempList.cfg.
  Default templateName ist der name der Entity
  Default für file und templateName kann mit dem Attribut tempListTmpl gesetzt werden.
  Beispiel für ein templist File. room1 und room2 sind die Namen 2er Tempaltes:
  entities:room1 tempListSat>08:00 16.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListSun>08:00 16.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListMon>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListTue>07:00 16.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0 tempListWed>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListThu>07:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListFri>07:00 16.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 entities:room2 tempListSat>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListSun>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0 tempListMon>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListTue>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0 tempListWed>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListThu>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0 tempListFri>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0 Specials:
- none: das Template wird ignoriert
- defaultWeekplan: Es wird als Default jeden Tag 18.0 Grad eingestellt. Sinnvoll nutzbar wenn man einen TC als Kontroller nutzt. Der Wochenplan des TC wird dann imlizit genutzt
- tempTmplSet =>"[[ <file> :]templateName]
  Setzt das Attribut und sendet die Änderungen an das Device.
- tplDel =>" <template>
  Löscht eine Template Eintrag dieser entity.
- tplSet_<peer> =>" <template>
  setzt ein Template für einen Peer der Entity. Mögliche Parameter des Templates werde auf den aktuellen Wert der Register gesetzt. Die Parameter können danach mit dem Kommando tplPara* geaendert werden.
  Das Kommando steht nur zu Verfügung wenn HMinfo definiert ist und ein passendes Template erstellt ist.
  Sollte das Template dediziert einem langen (long) oder kurzen (short) Trigger zugeordnet werden wird je ein Kommando zu Verfügung gestellt - siehe long oder short am Ende des Kommandos.
- tplParaxxx_<peer>_<tpl>_<param> =>" <template>
  Ein Parameter eines zugewiesenen Templates kann geaendert werden. Das Kommando bezieht sich auf genau einen Parameter eines Templates.
OutputUnit (HM-OU-LED16)
- led [off|red|green|yellow]
  schaltet die LED des Kanals auf die gewünschte Farbe. Wird der Befehl auf ein Gerät angewandt so werden alle LEDs auf diese Farbe gesetzt.
  Experten können die LEDs separat durch eine 8-stellige Hex-Zahl ansteuern.
- ilum <Helligkeit><Dauer>
  <Helligkeit> [0-15] der Beleuchtung.
  <Dauer> [0-127] in Sekunden, 0 bedeutet dauernd an.
OutputUnit (HM-OU-CFM-PL)
- led <color>[,<color>..] [<repeat>..]
  Mögliche Farben sind [redL|greenL|yellowL|redS|greenS|yellowS|pause]. Eine Folge von Farben kann durch trennen der Farbeinträge mit ',' eingestellt werden. Leerzeichen dürfen in der Liste nicht benutzt werden. 'S' bezeichnet kurze und 'L' lange Beleuchtungsdauer.
  repeat definiert wie oft die Sequenz ausgeführt werden soll. Standard ist 1.
- playTone <MP3No>[,<MP3No>..] [<repeat>] [<volume>]
  Spielt eine Reihe von Tönen. Die Liste muss mit ',' getrennt werden. Leerzeichen dürfen in der Liste nicht benutzt werden.
  replay kann verwendet werden um den zuletzt gespielten Klang zu wiederholen.
  repeat definiert wie oft die Sequenz ausgeführt werden soll. Standard ist 1.
  volume kann im Bereich 0..10 liegen. 0 stoppt jeden aktuell gespielten Sound. Standard ist 10 (100%.
  Beispiel:
HM-RC-19xxx
- alarm <count>
  sendet eine Alarmnachricht an die Steuerung
- service <count>
  sendet eine Servicenachricht an die Steuerung
- symbol <symbol> [set|unset]
  aktiviert ein verfügbares Symbol auf der Steuerung
- beep [off|1|2|3]
  aktiviert Töne
- backlight [off|on|slow|fast]
  aktiviert Hintergrundbeleuchtung
- display <text> comma unit tone backlight <symbol(s)>
  Steuert das Display der Steuerung
  <text> : bis zu 5 Zeichen
  comma : 'comma' aktiviert das Komma, 'no' läßt es aus
  [unit] : setzt Einheitensymbole. [off|Proz|Watt|x3|C|x5|x6|x7|F|x9|x10|x11|x12|x13|x14|x15]. Momentan sind x3..x15 nicht getestet.
  tone : aktiviert einen von 3 Tönen [off|1|2|3]
  backlight: läßt die Hintergrundbeleuchtung aufblinken [off|on|slow|fast]
  <symbol(s)> aktiviert die Anzeige von Symbolen. Mehrere Symbole können zu selben Zeit aktiv sein, Verknüpfung erfolgt komma-getrennt. Dabei keine Leerzeichen verwenden. Mögliche Symbole: [bulb|switch|window|door|blind|scene|phone|bell|clock|arrowUp|arrowDown]
  
  Beispiel:
HM-DIS-WM55
- displayWM help
  displayWM [long|short] <text1> <color1> <icon1> ... <text6> <color6> <icon6>
  displayWM [long|short] <lineX> <text> <color> <icon>
  es können bis zu 6 Zeilen programmiert werden.
  lineX legt die zu ändernde Zeilennummer fest. Es können die 3 Parameter der Zeile geändert werden.
  textNo ist der anzuzeigende Text. Der Inhalt des Texts wird in den Buttonds definiert. txt<BtnNo>_<lineNo> referenziert den Button und dessn jeweiligen Zeile. Alternativ kann ein bis zu 12 Zeichen langer Freitext angegeben werden
  color kann sein white, red, orange, yellow, green, blue
  icon kann sein off, on, open, closed, error, ok, noIcon
  Example:
HM-DIS-EP-WM55
- displayEP help
  displayEP <text1,icon1:text2,icon2:text3,icon3> <sound> <repetition> <pause> <signal>
  bis zu 3 Zeilen werden adressiert.
  Wenn help eingegeben wird wird eine hilfe zum Kommando ausgegeben. Optionen der Parameter werden ausgegeben.
  textx 12 char text für die Zeile. Wenn leer wird der Wert gemäß Reading genutzt. Typisch bedeuted es, dass keine Änderung stattfindet. text0-9 zeigt den vordefinierten Wert der Kanäle 4 bis 8 an. 0xHH erlaubt die anzeige eines hex Zeichens.
  iconx Icon der Zeile. Typisch bedeuted es, dass keine Änderung stattfindet.
  sound sound zum Abspielen.
  repetition 0..15
  pause 1..160
  signal Signalfarbe zum Anzeigen
  
  Note: param reWriteDisplayxx
- Beim Druck einer Taste ueberschreibt das Geraet diemittleren 3 Zeilen. Wenn da Attribut
  attr chan param reWriteDisplayxx
  gesetzt ist werden die 3 Zeilen nach xx Sekunden auf den Orginalwert zurück geschrieben.
keyMatic
- lock
  Schließbolzen fährt in Zu-Position
- unlock [sec]
  Schließbolzen fährt in Auf-Position.
  [sec]: Stellt die Verzögerung ein nach der sich das Schloss automatisch wieder verschließt.
  0 - 65535 Sekunden
- open [sec]
  Entriegelt die Tür sodass diese geöffnet werden kann.
  [sec]: Stellt die Verzögerung ein nach der sich das Schloss automatisch wieder verschließt.
  0 - 65535 Sekunden
winMatic
- level <level> <relockDelay> <speed>
  stellt den Wert ein.
  <level>: Bereich ist 0% bis 100%
  <relockDelay>: Spanne reicht von 0 bis 65535 Sekunden. 'ignore' kann verwendet werden um den Wert zu ignorieren.
  <speed>: Bereich ist 0% bis 100%
- stop
  stopt die Bewegung
CCU_FHEM
- defIgnUnknown
  Definieren die unbekannten Devices und setze das Attribut ignore. Ddann loesche die Readings.
HM-SYS-SRP-PL
legt Einträge für den Repeater an. Bis zu 36 Einträge können angelegt werden.
- setRepeat <entry> <sender> <receiver> <broadcast>
  <entry> [1..36] Nummer des Eintrags in der Tabelle.
  <sender> Name oder HMid des Senders oder der Quelle die weitergeleitet werden soll
  <receiver> Name oder HMid des Empfängers oder Ziels an das weitergeleitet werden soll
  <broadcast> [yes|no] definiert ob Broadcasts von einer ID weitergeleitet werden sollen.
  
  Kurzanwendung:
  setRepeat setAll 0 0 0 schreibt die gesamte Liste der Geräte neu. Daten kommen vom Attribut repPeers.
  Das Attribut repPeers hat folgendes Format:
  src1:dst1:[y/n],src2:dst2:[y/n],src2:dst2:[y/n],...
  
  Formatierte Werte von repPeer:

raw <data> ...
nur für Experimente benötigt. Sendet eine Liste von "Roh"-Befehlen. Der erste Befehl wird unmittelbar gesendet, die folgenden sobald der vorherige bestätigt wurde. Die Länge wird automatisch berechnet und der Nachrichtenzähler wird erhöht wenn die ersten beiden Zeichen ++ sind. Beispiel (AES aktivieren):
```
            set hm1 raw ++A001F100001234560105000000001\
            ++A001F10000123456010802010AF10B000C00\
            ++A001F1000012345601080801\
            ++A001F100001234560106
          
```

Get

configSave <filename>
Sichert die Einstellungen eines Eintrags in einer Datei. Die Daten werden in einem von der FHEM-Befehlszeile ausführbaren Format gespeichert.
Die Datei liegt im FHEM Home-Verzeichnis neben der fhem.cfg. Gespeichert wird kumulativ- d.h. neue Daten werden an die Datei angehängt. Es liegt am Benutzer das doppelte speichern von Einträgen zu vermeiden.
Ziel der Daten ist NUR die Information eines HM-Gerätes welche IM Gerät gespeichert ist. Im Deteil sind das nur die Peer-Liste sowie die Register. Durch die Register wird also das Peering eingeschlossen.
Die Datei ist vom Benutzer les- und editierbar. Zusätzlich gespeicherte Zeitstempel helfen dem Nutzer bei der Validierung.
Einschränkungen:
Auch wenn alle Daten eines Eintrags in eine Datei gesichert werden so sichert FHEM nur die zum Zeitpunkt des Speicherns verfügbaren Daten! Der Nutzer muss also die Daten der HM-Hardware auslesen bevor dieser Befehl ausgeführt wird. Siehe empfohlenen Ablauf unten.
Dieser Befehl speichert keine FHEM-Attribute oder Gerätedefinitionen. Diese verbleiben in der fhem.cfg.
Desweiteren werden gesicherte Daten nicht automatisch zurück auf die HM-Hardware geladen. Der Benutzer muss die Wiederherstellung auslösen.

Ebenso wie ander Befehle wird 'configSave' am besten auf ein Gerät und nicht auf einen Kanal ausgeführt. Wenn auf ein Gerät angewendet werden auch die damit verbundenen Kanäle gesichert.

Empfohlene Arbeitsfolge für ein Gerät 'HMdev': set HMdev clear msgEvents # alte Events löschen um Daten besser kontrollieren zu können set HMdev getConfig # Geräte- und Kanalinformation auslesen # warten bis Ausführung abgeschlossen ist # "protState" sollte dann "CMDs_done" sein # es sollten keine Warnungen zwischen "prot" und den Variablen auftauchen get configSave myActorFile
param <paramName>
Gibt den Inhalt der relevanten Parameter eines Eintrags zurück.
Hinweis: wird der Befehl auf einen Kanal angewandt und 'model' abgefragt so wird das Model des inhalteanbietenden Geräts zurückgegeben.
reg <addr> <list> <peerID>
liefert den Wert eines Registers zurück. Daten werden aus dem Speicher von FHEM und nicht direkt vom Gerät geholt. Falls der Registerinhalt nicht verfügbar ist muss "getConfig" sowie anschließend "getReg" verwendet werden.
<addr> Adresse des Registers in HEX. Registername kann alternativ verwendet werden falls in FHEM bekannt. "all" gibt alle dekodierten Register eines Eintrags in einer Liste zurück.
<list> Liste aus der das Register gewählt wird. Wird der REgistername verwendet wird "list" ignoriert und kann auf '0' gesetzt werden.
<peerID> identifiziert die Registerbänke für "list3" und "list4". Kann als Dummy gesetzt werden wenn nicht benötigt.
regList
gibt eine Liste der von FHEM für dieses Gerät dekodierten Register zurück.
Beachten dass noch mehr Register für ein Gerät implemetiert sein können.
saveConfig <file>
speichert Peers und Register in einer Datei.
Gespeichert werden die Daten wie sie in FHEM verfügbar sind. Es ist daher notwendig vor dem Speichern die Daten auszulesen.
Der Befehl unterstützt Aktionen auf Geräteebene. D.h. wird der Befehl auf ein Gerät angewendet werden auch alle verbundenen Kanaleinträge gesichert.
Das Speichern der Datei erfolgt kumulativ. Wird ein Eintrag mehrfach in der selben Datei gespeichert so werden die Daten an diese angehängt. Der Nutzer kann den Zeitpunkt des Speichern bei Bedarf auslesen.
Der Inhalt der Datei kann verwendet werden um die Geräteeinstellungen wiederherzustellen. Er stellt alle Peers und Register des Eintrags wieder her.
Zwänge/Beschränkungen:
vor dem zurückschreiben der Daten eines Eintrags muss das Gerät mit FHEM verbunden werden.
"restore" löscht keine verknüpften Kanäle, es fügt nur neue Peers hinzu.
listDevice
- bei einer CCU gibt es eine Liste der Devices, welche den ccu service zum zuweisen der IOs zurück
- beim ActionDetector wird eine Komma geteilte Liste der Entities zurückgegeben
  get ActionDetector listDevice # returns alle assigned entities
  get ActionDetector listDevice notActive# returns entities ohne status alive
  get ActionDetector listDevice alive # returns entities mit status alive
  get ActionDetector listDevice unknown # returns entities mit status unknown
  get ActionDetector listDevice dead # returns entities mit status dead

Attribute

eventMap
do_not_notify
ignore
dummy
showtime
readingFnAttributes
readingOnDead definiert wie readings behandelt werden sollten wenn das Device als 'dead' mariert wird.
Das Attribut ist nur auf Devices anwendbar. Es ändert die Readings wenn das Device nach dead geht. Beim Verlasen des Zustandes 'dead' werden die ausgewählten Readings nach 'notDead' geändert. Es kann erwartet werden, dass sinnvolle Werte vom Device eingetragen werden.
Upon leaving state 'dead' the selected readings will be set to 'notDead'. It is expected that useful values will be filled by the normally operating device.
Optionen sind:
noChange: keine Readings ausser Actvity werden geändert. Andere Einträge werden ignoriert.
state: das Reading 'state' wird auf 'dead' gesetzt.
periodValues: periodische numerische Readings des Device werden auf '0' gesetzt.
periodString: periodische string Readings des Device werden auf 'dead' gesetzt.
channels: die Readings der Kanäle werden ebenso wie die des Device behandelt und auch geaendert.
custom readings: der Anwender kann weitere Readingnamen eintragen, welche ggf. auf 'dead' zu setzen sind.

Beispiel:
aesCommReq wenn gesetzt wird IO AES signature anfordern bevor ACK zum Device gesendet wird.
actAutoTry actAutoTry 0_off,1_on
setzen erlaubt dem ActionDetector ein statusrequest zu senden falls das Device dead markiert werden soll. Das Attribut kann fuer Devices nützlich sein, welche sich nicht von selbst zyklisch melden.
actCycle actCycle <[hhh:mm]|off>
Bietet eine 'alive' oder besser 'not alive' Erkennung für Geräte. [hhh:mm] ist die maximale Zeit ohne Nachricht eines Geräts. Wenn innerhalb dieser Zeit keine Nachricht empfangen wird so wird das Event"<device> is dead" generiert. Sendet das Gerät wieder so wird die Nachricht"<device> is alive" ausgegeben.
Diese Erkennung wird durch 'autocreate' für jedes Gerät mit zyklischer Statusmeldung angelegt.
Die Kontrollinstanz ist ein Pseudo-Gerät "ActionDetector" mit der HMId "000000".
Aufgrund von Performanceüberlegungen liegt die Antwortverzögerung bei 600 Sekunden (10min). Kann über das Attribut "actCycle" des "ActionDetector" kontrolliert werden.
Sobald die Überwachung aktiviert wurde hat das HM-Gerät 2 Attribute:
Die gesamte Funktion kann über den "ActionDetector"-Eintrag überprüft werden. Der Status aller Instanzen liegt im READING-Bereich.
Hinweis: Diese Funktion kann ebenfalls für Geräte ohne zyklische Übertragung aktiviert werden. Es obliegt dem Nutzer eine vernünftige Zeitspanne festzulegen.
autoReadReg
'0' autoReadReg wird ignorert.
'1' wird automatisch in getConfig ausgeführt für das Device nach jedem reboot von FHEM.
'2' wie '1' plus nach Power on.
'3' wie '2' plus update wenn auf das Device geschreiben wird.
'4' wie '3' plus fordert Status an, wenn es nicht korrekt erscheint
'5' prüft Registerlisten und peerlisten. Wenn diese nicht komplett sind wird ein update angefordert
'8_stateOnly' es wird nur der Status geprüft, updates für Register werden nicht gemacht.
Ausführung wird verzögert ausgeführt. Wenn das IO eine gewisse Last erreicht hat wird das Kommando weiter verzögert um eine Überlast zu vermeiden.
Empfohlene Zusammenhänge bei Nutzung:
burstAccess
kann für eine Geräteinstanz gesetzt werden falls das Model bedingte Bursts erlaubt. Das Attribut deaktiviert den Burstbetrieb (0_off) was die Nachrichtenmenge des HMLAN reduziert und damit die Wahrscheinlichkeit einer Überlast von HMLAN verringert.
Einschalten (1_auto) erlaubt kürzere Reaktionszeiten eines Geräts. Der Nutzer muss nicht warten bis das Gerät wach ist.
Zu beacht ist dass das Register "burstRx" im Gerät ebenfalls gesetzt werden muss.
expert
Dieses Attribut steuert die Sichtbarkeit der Register Readngs. Damit wird die Darstellung der Geräteparameter kontrolliert.
Es handdelt sich um einen binaer kodierten Wert mit folgenden Empfehlungen:
Wird 'expert' auf ein Gerät angewendet so gilt dies auch für alle verknüpften Kanäle. Kann übergangen werden indem das Attribut ' expert' auch für den Gerätekanal gesetzt wird.
Das Attribut "showInternalValues" bei den globalen Werten muss ebenfalls überprüft werden. "expert" macht sich diese Implementierung zu Nutze. Gleichwohl setzt "showInternalValues" - bei Definition - 'expert' außer Kraft .
readOnly
beschränkt kommandos auf Lesen und Beobachten.
IOgrp
kann an Devices vergeben werden udn zeigt auf eine virtuelle ccu. Danach wird die ccu beim Senden das passende IO für das Device auswählen. Es ist notwendig, dass die virtuelle ccu definiert und alle erlaubten IOs eingetragen sind. Beim Senden wird die ccu prüfen welches IO operational ist und welches den besten rssi-faktor für das Device hat.
Optional kann ein bevorzugtes IO definiert werden. In diesem Fall wird es, wenn operational, genutzt - unabhängig von den rssi Werten.
wenn kein prefIO verfügbar ist und none erkannt wird wird das IO aus IODev gewählt
Beispiel:
levelRange
nur für Dimmer! Der Dimmbereich wird eingeschränkt. Es ist gedacht um z.B. LED Lichter unterstützen welche mit 10% beginnen und bei 40% bereits das Maximum haben. levelrange normalisiert den Bereich entsprechend. D.h. set 100 wird physikalisch den Dimmer auf 40%, 1% auf 10% setzen. 0% schaltet physikalisch aus.
Beeinflusst werdne Kommndos on, up, down, toggle und pct. Nicht beeinflusst werden Kommandos die den Wert physikalisch setzen.
Zu beachten:
dimmer level von Peers gesetzt wird nicht beeinflusst. Dies wird durch Register konfiguriert.
Readings level könnte negative werden oder über 100%. Das kommt daher, dass physikalisch der Bereich 0-100% ist aber auf den logischen bereicht normiert wird.
Sind virtuelle Dimmer Kanäle verfügbar muss das Attribut für jeden Kanal gesetzt werden
Beispiel:
tempListTmpl
Setzt das Default für Heizungskontroller. Ist es nicht gesetzt wird der default filename genutzt und der name der entity als templatename. Z.B. ./tempList.cfg:RT_Clima
Um das template nicht zu nutzen kann man es auf '0'setzen.
Format ist <file>:<templatename>.
modelForce, modelForce überschreibt das model attribut. Dabei wird das Device und seine Kanäle reconfguriert.
Grund für dieses Attribut ist ein eQ3 bug bei welchen Devices mit falscher ID ausgeliefert werden. Das Attribut erlaubt dies zu ueberschreiben
ACHTUNG: Durch das Eintragen eines anderen model werden die Entites modifiziert, ggf. neu angelegt oder gelöscht.
model, subType
Diese Attribute werden bei erfolgreichem Pairing automatisch gesetzt. Sie sollten nicht per Hand gesetzt werden und sind notwendig um Gerätenachrichten korrekt interpretieren oder senden zu können.
param
'param' definiert modelspezifische Verhalten oder Funktionen. Siehe "models" für Details.
msgRepeat
Definiert die Nummer an Wiederholungen falls ein Gerät nicht rechtzeitig antwortet.
Für Geräte die nur den "Config"-Modus unterstützen sind Wiederholungen nicht erlaubt.
Bei Geräte mit wakeup-Modus wartet das Gerät bis zum nächsten Aufwachen. Eine längere Verzögerung sollte in diesem Fall angedacht werden.
Wiederholen von Bursts hat Auswirkungen auf die HMLAN Übertragungskapazität.
rawToReadable
Wird verwendet um Rohdaten von KFM100 in ein lesbares Fomrat zu bringen, basierend auf den gemessenen Werten. Z.B. langsames Füllen eines Tanks, während die Werte mit inform angezeigt werden. Man sieht:
Anwenden dieser Werte: "attr KFM100 rawToReadable 10:0 50:20 79:40 270:100". FHEM für damit eine lineare Interpolation der Werte in den gegebenen Grenzen aus.
unit
setzt die gemeldete Einheit des KFM100 falls 'rawToReadable' aktiviert ist. Z.B.
attr KFM100 unit Liter
autoReadReg
'0' autoReadReg wird ignoriert.
'1' führt ein "getConfig" für ein Gerät automatisch nach jedem Neustart von FHEM aus.
'2' verhält sich wie '1',zusätzlich nach jedem power_on.
'3' wie '2', zusätzlich bei jedem Schreiben auf das Gerät
'4' wie '3' und versucht außerdem den Status abzufragen falls dieser nicht verfügbar erscheint.
'5' kontrolliert 'reglist' und 'peerlist'. Falls das Auslesen unvollständig ist wird 'getConfig' ausgeführt
'8_stateOnly' aktualisiert nur Statusinformationen aber keine Konfigurationen wie Daten- oder Peerregister.
Ausführung wird verzögert um eine Überlastung beim Start zu vermeiden . Daher werden Aktualisierung und Anzeige von Werten abhängig von der Größe der Datenbank verzögert geschehen.
Empfehlungen und Einschränkungen bei Benutzung:

verfügbare Parameter für "param"

HM-SEN-RD-O
offAtPon: nur Heizkanäle: erzwingt Ausschalten der Heizung nach einem powerOn
onAtRain: nur Heizkanäle: erzwingt Einschalten der Heizung bei Status 'rain' und Ausschalten bei Status 'dry'
virtuals
noOnOff: eine virtuelle Instanz wird den Status nicht ändern wenn ein Trigger empfangen wird. Ist dieser Paramter nicht gegeben so toggled die Instanz ihren Status mit jedem trigger zwischen An und Aus
msgReduce: falls gesetzt und der Kanal wird für genutzt wird jede Nachricht außer die der Ventilstellung verworfen um die Nachrichtenmenge zu reduzieren
blind
levelInverse während HM 100% als offen und 0% als geschlossen behandelt ist dies evtl. nicht intuitiv für den Nutzer. Defaut für 100% ist offen und wird als 'on'angezeigt. Das Setzen des Parameters invertiert die Anzeige - 0% wird also offen und 100% ist geschlossen.
ACHTUNG: Die Anpassung betrifft nur Readings und Kommandos. Register sind nicht betroffen.
ponRestoreSmart bei powerup des Device fährt das Rollo in die vermeintlich nächstgelegene Endposition und anschliessend in die ursprüngliche Position.
ponRestoreForce bei powerup des Device fährt das Rollo auf Level 0, dann auf Level 100 und anschliessend in die ursprüngliche Position.
sensRain
siren
powerMeter
switch
dimmer
rgb
showTimed wenn timedOn running ist wird -till an state gehängt. Dies führt dazu, dass ggf. on-till im State steht was das stateIcon handling verbessert.

Erzeugte Events:

Allgemein
recentStateType:[ack|info] # kann nicht verwendet werden um Nachrichten zu triggern
- ack zeigt an das eine Statusinformation aus einer Bestätigung abgeleitet wurde
- info zeigt eine automatische Nachricht eines Geräts an
- sabotageAttackId
  Alarmiert bei Konfiguration des Geräts durch unbekannte Quelle
- sabotageAttack
  Alarmiert bei Konfiguration des Geräts welche nicht durch das System ausgelöst wurde
- trigDst_<name>: noConfig
  Ein Sensor triggert ein Device welches nicht in seiner Peerliste steht. Die Peerliste ist nicht akuell
HM-CC-TC,ROTO_ZEL-STG-RM-FWT
T: $t H: $h
battery:[low|ok]
measured-temp $t
humidity $h
actuator $vp %
desired-temp $dTemp
desired-temp-manu $dTemp #Temperatur falls im manuellen Modus
desired-temp-cent $dTemp #Temperatur falls im Zentrale-Modus
windowopen-temp-%d %.1f (sensor:%s)
tempList$wd hh:mm $t hh:mm $t ...
displayMode temp-[hum|only]
displayTemp [setpoint|actual]
displayTempUnit [fahrenheit|celsius]
controlMode [auto|manual|central|party]
tempValveMode [Auto|Closed|Open|unknown]
param-change offset=$o1, value=$v1
ValveErrorPosition_for_$dname $vep %
ValveOffset_for_$dname : $of %
ValveErrorPosition $vep %
ValveOffset $of %
time-request
trig_<src> <value> #channel was triggered by <src> channel. Dieses Event hängt vom kompletten Auslesen der Kanalkonfiguration ab, anderenfalls können Daten unvollständig oder fehlerhaft sein.
trigLast <channel> #letzter empfangener Trigger
HM-CC-RT-DN and HM-CC-RT-DN-BOM
state:T: $actTemp desired: $setTemp valve: $vp %
motorErr: [ok|ValveTight|adjustRangeTooLarge|adjustRangeTooSmall|communicationERR|unknown|lowBat|ValveErrorPosition] measured-temp $actTemp
desired-temp $setTemp
ValvePosition $vp %
mode [auto|manual|party|boost]
battery [low|ok]
batteryLevel $bat V
measured-temp $actTemp
desired-temp $setTemp
actuator $vp %
time-request
trig_<src> <value> #Kanal wurde durch <src> Kanal ausgelößt.
HM-CC-VD,ROTO_ZEL-STG-RM-FSA
$vp %
battery:[critical|low|ok]
motorErr:[ok|blocked|loose|adjusting range too small|opening|closing|stop]
ValvePosition:$vp %
ValveErrorPosition:$vep %
ValveOffset:$of %
ValveDesired:$vp % # durch Temperatursteuerung gesetzt
operState:[errorTargetNotMet|onTarget|adjusting|changed] # operative Bedingung
operStateErrCnt:$cnt # Anzahl fehlgeschlagener Einstellungen
HM-CC-SCD
[normal|added|addedStrong]
battery [low|ok]
HM-SEC-SFA-SM
powerError [on|off]
sabotageError [on|off]
battery: [critical|low|ok]
HM-LC-BL1-PB-FM
motor: [opening|closing]
HM-LC-SW1-BA-PCB
battery: [low|ok]
HM-OU-LED16
color $value # in Hex - nur für Gerät
$value # in Hex - nur für Gerät
color [off|red|green|orange] # für Kanal
[off|red|green|orange] # für Kanal
HM-OU-CFM-PL
[on|off|$val]
HM-SEN-WA-OD
$level%
level $level%
KFM100
$v
$cv,$unit
rawValue:$v
Sequence:$seq
content:$cv,$unit
KS550/HM-WDS100-C6-O
T: $t H: $h W: $w R: $r IR: $ir WD: $wd WDR: $wdr S: $s B: $b
temperature $t
humidity $h
windSpeed $w
windDirection $wd
windDirRange $wdr
rain $r
isRaining $ir
sunshine $s
brightness $b
unknown $p
HM-SEN-RD-O
lastRain: timestamp # kein Trigger wird erzeugt. Anfang des vorherigen Regen-Zeitstempels des Messwerts ist Ende des Regens.
THSensor und HM-WDC7000
T: $t H: $h AP: $ap
temperature $t
humidity $h
airpress $ap #nur HM-WDC7000
dimmer
overload [on|off]
overheat [on|off]
reduced [on|off]
dim: [up|down|stop]
motionDetector
brightness:$b
alive
motion on (to $dest)
motionCount $cnt _next:$nextTr"-"[0x0|0x1|0x2|0x3|15|30|60|120|240|0x9|0xa|0xb|0xc|0xd|0xe|0xf]
cover [closed|open] # nicht bei HM-SEC-MDIR
sabotageError [on|off] # nur bei HM-SEC-MDIR
battery [low|ok]
devState_raw.$d1 $d2
remote/pushButton/outputUnit
Btn$x onShort
Btn$x offShort
Btn$x onLong $counter
Btn$x offLong $counter
Btn$x onLongRelease $counter
Btn$x offLongRelease $counter
Btn$x onShort (to $dest)
Btn$x offShort (to $dest)
Btn$x onLong $counter (to $dest)
Btn$x offLong $counter (to $dest)
Btn$x onLongRelease $counter (to $dest)
Btn$x offLongRelease $counter (to $dest)
remote/pushButton
battery [low|ok]
trigger [Long|Short]_$no trigger event from channel
swi
Btn$x Short
Btn$x Short (to $dest)
battery: [low|ok]
switch/dimmer/blindActuator
$val
powerOn [on|off|$val]
[unknown|motor|dim] [up|down|stop]:$val
timedOn [running|off]
# "An" ist temporär - z.B. mit dem 'on-for-timer' gestartet
sensRain
$val
powerOn
level <val≥
timedOn [running|off]
# "An" ist temporär - z.B. mit dem 'on-for-timer' gestartet trigger [Long|Short]_$no trigger event from channel
smokeDetector
[off|smoke-Alarm|alive] # für Gruppen-Master
[off|smoke-forward|smoke-alarm] # für Gruppenmitglieder
[normal|added|addedStrong] #HM-CC-SCD
SDteam [add|remove]_$dname
battery [low|ok]
smoke_detect [none|<src>]
teamCall:from $src
threeStateSensor
[open|tilted|closed]
[wet|damp|dry] #nur HM-SEC-WDS
cover [open|closed] #HM-SEC-WDS und HM-SEC-RHS
alive yes
battery [low|ok]
contact [open|tilted|closed]
contact [wet|damp|dry] #nur HM-SEC-WDS
sabotageError [on|off] #nur HM-SEC-SC
winMatic
[locked|$value]
motorErr [ok|TurnError|TiltError]
direction [no|up|down|undefined]
charge [trickleCharge|charge|dischange|unknown]
airing [inactiv|$air]
course [tilt|close]
airing [inactiv|$value]
contact tesed
keyMatic
unknown:40
battery [low|ok]
uncertain [yes|no]
error [unknown|motor aborted|clutch failure|none']
lock [unlocked|locked]
[unlocked|locked|uncertain]

Internals

aesCommToDev
Information über Erfolg und Fehler der AES Kommunikation zwischen IO-device und HM-Device

CUL_HOERMANN

CUL_IR

CUL_MAX

[EN DE]

attr CUL0 rfmode MAX

Define

define <name> CUL_MAX <addr>

Set

pairmode
Versetzt den CUL_MAX für 60 Sekunden in den Pairing Modus, während dieser Zeit kann das Gerät mit anderen Geräten gepaart werden (Heizkörperthermostate, Eco-Taster, etc.). Auch das zu paarende Gerät muss manuell in den Pairing Modus versetzt werden (z.B. beim Heizkörperthermostat durch Drücken der "Boost" Taste für 3 Sekunden).
fakeSC <device> <open>
Sendet eine fingierte ShutterContactState Meldung <open>, dies muss 0 bzw. 1 für "Fenster geschlossen" bzw. "Fenster offen" sein. Wenn das <device> eine Gruppen-ID ungleich Null hat, beeinflusst diese fingierte ShutterContactState Meldung alle Geräte mit dieser Gruppen-ID. Es muss sichergestellt werden, dass vorher alle Zielgeräte mit fakeShutterContact verbunden werden.
fakeWT <device> <desiredTemperature> <measuredTemperature>
Sendet eine fingierte WallThermostatControl Meldung (beide Parameter können eine Nachkommastelle haben, für desiredTemperature darf die Nachkommastelle nur 0 bzw. 5 sein). Wenn das <device> eine Gruppen-ID ungleich Null hat, beeinflusst diese fingierte WallThermostatControl Meldung alle Geräte mit dieser Gruppen-ID. Es muss sichergestellt werden, dass vorher alle Zielgeräte mit fakeWallThermostat verbunden werden.

Get

N/A

Attributes

ignore

do_not_notify

showtime

loglevel

readingFnAttributes

Events

N/A

CUL_REDIRECT

[EN DE]

CUL_RFR

CUL_TCM97001

[EN DE]

Unterstütze Modelle:

ABS700
AURIOL
Eurochron
GT_WT_02
KW9010
NC_WS
TCM21....
TCM97...
PFR-130 (rain)
Prologue
Rubicson
Ventus W155(Auriol): W044(temp/hum) W132(wind) W174(rain)

Define

Generierte Events:

temperature: Die aktuelle Temperatur
humidity: Die aktuelle Luftfeutigkeit (falls verfügbar)
battery: Der Batteriestatus: low oder ok (falls verfügbar)
channel: Kanalnummer (falls verfügbar)
trend: Der Temperaturtrend (falls verfügbar)
israining: Aussage Regen zwichen zwei Messungen (falls verfügbar)
rain: Der Regenwert, eine fortlaufende Zahl bis zum Batteriewechsel (falls verfügbar)
winddir: Die aktuelle Windrichtung
windgrad: Die aktuelle Windrichtung in Grad
windspeed: Die aktuelle Windgeschwindigkeit
windgust: Windböe

Attribute

IODev Spezifiziert das physische Gerät, das die Ausstrahlung der Befehle für das "logische" Gerät ausführt. Ein Beispiel für ein physisches Gerät ist ein CUL.
do_not_notify
ignore
model (ABS700, AURIOL, GT_WT_02, KW9010, NC_WS, PFR-130, Prologue, Rubicson, TCM21...., TCM97…, Unknown, W044, W132, W174)
max-deviation-temp: (Default:1, erlaubte Werte: 1,2,3,4,5,6,7,8,9,10,15,20,25,30,35,40,45,50)
Maximal erlaubte Abweichung der gemessenen Temperatur zum vorhergehenden Wert in Kelvin.
showtime
readingFnAttributes

CUL_TX

CUL_WS

[EN DE]

Define

define <name> CUL_WS <code> [corr1...corr4]

Set

N/A

Get

N/A

Attribute

IODev (!) Achtung: mit diesem Attribut ist es möglich mehrere 8-er Sets an S300-er in FHEM zu definieren. Wichtige Voraussetzung allerdings ist, dass nur das spezifizierte CUL das S300 empfangen kann, z.Bsp. durch Frequenztrennung (433MHz vs. 868MHz).
do_not_notify
eventMap
ignore
model (S300,KS300,ASH2200)
showtime
readingFnAttributes
strangeTempDiff DIFFVAL
Falls gesetzt, werden nur solche Temperaturen akzeptiert, wo der Unterschied bei der gemeldeten Temperatur zum letzten Wert weniger als DIFFVAL ist.

CULflash

[EN DE]

CULflash [fhem-device|none]; <TYPE>

Achtung:

CULflash CUL CUL_V3

          CULflash none CUL_V3

Calendar

[EN DE]

Define

define <name> Calendar ical url <URL> [<interval>]

define <name> Calendar ical file <FILENAME> [<interval>]

URL

https://

IO::Socket::SSL

cpan -i IO::Socket::SSL

<URL>

%d Tag des Monats (01..31)
%m Monat (01..12)
%Y Jahr (1970...)
%w Wochentag (0..6); beginnend mit Sonntag (0)
%j Tag des Jahres (001..366)
%U Wochennummer des Jahres, wobei Wochenbeginn = Sonntag (00..53)
%W Wochennummer des Jahres, wobei Wochenbeginn = Montag (00..53)

Wildcards dürfen in Google Kalender URL nicht verwendet werden!
Du kannst direkt die private iCal-URL des Google-Kalenders nutzen.
Sollte deine Google-Kalender-URL mit https:// beginnen und das Perl-Modul IO::Socket::SSL ist nicht auf deinem System installiert, kannst Du in der URL https:// durch http:// ersetzen, falls keine automatische Umleitung auf die https:// URL erfolgt. Solltest Du unsicher sein, ob dies der Fall ist, überprüfe es bitte zuerst mit deinem Browser.

https://admin:admin@demo.nextcloud.com/wid0ohgh/remote.php/dav/calendars/admin/personal/?export

Der optionale Parameter interval bestimmt die Zeit in Sekunden zwischen den Updates. Default-Wert ist 3600 (1 Stunde).
Eine Intervallangabe von 0 ist nicht erlaubt. Diese wird automatisch durch den Standardwert 3600 ersetzt und im Log protokolliert.

Beispiele:

      define MeinKalender Calendar ical url https://www.google.com/calendar/ical/john.doe%40example.com/private-foo4711/basic.ics
      define DeinKalender Calendar ical url http://www.google.com/calendar/ical/jane.doe%40example.com/private-bar0815/basic.ics 86400
      define IrgendeinKalender Calendar ical file /home/johndoe/calendar.ics

Set

set <name> update

interval

set <name> reload

update

Get

get <name> update

set <name> update

get <name> reload

set <name> reload

get <name> events [format:<formatSpec>] [timeFormat:<timeFormatSpec>] [filter:<filterSpecs>]
    [series:next[=<max>]] [limit:<limitSpecs>]
    [include:<names>]
    [returnType:<returnTypeSpec>]

Das Schweizer Taschenmesser für die Anzeige von Terminen. Die Termine des Kalenders <name> werden Zeile für Zeile entsprechend der Format- und Filterangaben ausgegeben. Keiner, einer oder mehrere der Parameter format, timeFormat, filter, series und limit können angegeben werden, weiterhin ist es sinnvoll, den Parameter filter mehrere Male anzugeben.

Der Parameter format legt den zurückgegeben Inhalt fest.

Folgende Formatspezifikationen stehen zur Verfügung:

<formatSpec>	Beschreibung
`default`	Standardformat (siehe unten)
`full`	entspricht `custom="$U $M $A $T1-$T2 $S $CA $L"`
`text`	entspricht `custom="$T1 $S"`
`custom="<formatString>"`	ein spezifisches Format (siehe unten)
`custom="{ <perl-code> }"`	ein spezifisches Format (siehe unten)

Einzelne Anführungszeichen (') können anstelle von doppelten Anführungszeichen (") innerhalb eines spezifischen Formats benutzt werden. Folgende Variablen können in <formatString> und in <perl-code> verwendet werden:

variable	Bedeutung
`$t1`	Startzeit in Sekunden
`$T1`	Startzeit entsprechend Zeitformat
`$t2`	Endzeit in Sekunden
`$T2`	Endzeit entsprechend Zeitformat
`$a`	Alarmzeit in Sekunden
`$A`	Alarmzeit entsprechend Zeitformat
`$d`	Dauer in Sekunden
`$D`	Dauer in menschenlesbarer Form
`$S`	Zusammenfassung
`$L`	Ortsangabe
`$CA`	Kategorien
`$CL`	Klassifizierung
`$DS`	Beschreibung
`$U`	UID
`$M`	Modus

\, (maskiertes Komma) in Zusammenfassung, Ortsangabe und Beschreibung werden durch ein Komma ersetzt, aber \n (kennzeichnet Absatz) bleibt unberührt.

Wird der Parameter format ausgelassen, dann wird die Formatierung aus defaultFormat benutzt. Ist dieses Attribut nicht gesetzt, wird "$T1 $D $S" als Formatierung benutzt. Das letzte Auftreten von format gewinnt bei mehrfacher Angabe.

Examples:
get MyCalendar events format:full
get MyCalendar events format:custom="$T1-$T2 $S \@ $L"
get MyCalendar events format:custom={ sprintf("%20s %8s", $S, $D) }

Der Parameter timeFormat legt das Format für die Start-, End- und Alarmzeiten fest.

In <timeFormatSpec> kann die POSIX-Spezifikation verwendet werden. Auf strftime.net gibt es ein Tool zum Erstellen von <timeFormatSpec>.

Wenn der Parameter timeFormat ausgelassen, dann wird die Formatierung aus defaultTimeFormat benutzt. Ist dieses Attribut nicht gesetzt, dann wird "%d.%m.%Y %H:%M" als Formatierung benutzt. Zum Umschließen der Formatangabe können einfache (') oder doppelte (") Anführungszeichen verwendet werden.

Das letzte Auftreten von timeFormat gewinnt bei mehrfacher Angabe.

Example:
get MyCalendar events timeFormat:"%e-%b-%Y" format:full

Der Parameter filter schränkt die Anzeige der Termine ein. <filterSpecs> ist eine kommaseparierte Liste von <filterSpec>-Angaben. Alle Filterangaben müssen zutreffen, damit ein Termin angezeigt wird. Die Angabe ist kumulativ: jeder angegebene Filter wird zur Filterliste hinzugef&uum;gt und ber&uum;cksichtigt.

`<filterSpec>`	Beschreibung
`uid=="<uid>"`	UID ist `<uid>` entspricht `field(uid)=="<uid>"`
`uid=~"<regex>"`	Der reguläre Ausdruck `<regex>` entspricht der UID entspricht `field(uid)=~"<regex>"`
`mode=="<mode>"`	Modus ist `<mode>` entspricht `field(mode)=="<mode>"`
`mode=~"<regex>"`	Der reguläre Ausdruck `<regex>` entspricht `mode` entspricht `field(mode)=~"<regex>"`
`field(<field>)=="<value>"`	Inhalt von `<field>` ist `<value>` <field> ist eines von `uid`, `mode`, `summary`, `location`, `description`, `categories`, `classification`
`field(<field>)=~"<regex>"`	Inhalt von <field> entspricht dem regulären Ausdruck `<regex>` <field> ist eines von `uid`, `mode`, `summary`, `location`, `description`, `categories`, `classification`

Die doppelten Anführungszeichen auf der rechten Seite von <filterSpec> sind nicht Teil des regulären Ausdrucks. Es können stattdessen einfache Anführungszeichen verwendet werden.

Examples:
get MyCalendar events filter:uid=="432dsafweq64yehdbwqhkd"
get MyCalendar events filter:uid=~"^7"
get MyCalendar events filter:mode=="alarm"
get MyCalendar events filter:mode=~"alarm|upcoming"
get MyCalendar events filter:field(summary)=~"Mama"
get MyCalendar events filter:field(classification)=="PUBLIC"
get MyCalendar events filter:field(summary)=~"Gelber Sack",mode=~"upcoming|start"
get MyCalendar events filter:field(summary)=~"Gelber Sack" filter:mode=~"upcoming|start"

Der Parameter series bestimmt die Anzeige von wiederkehrenden Terminen. series:next begrenzt die Anzeige auf den nächsten Termin der noch nicht beendeten Termine innerhalb der Serie. series:next=<max> zeigt die nächsten <max> Termine der Serie. Dies gilt pro Serie. Zur Begrenzung der Anzeige siehe den limit-Parameter.

Der Parameter limit begrenzt die Anzeige der Termine. <limitSpecs> ist eine kommaseparierte Liste von <limitSpec> Angaben.

`<limitSpec>`	Beschreibung
`count=<n>`	zeigt `<n>` Termine, wobei `<n>` eine positive Ganzzahl (integer) ist
`from=[+\|-]<timespec>`	zeigt nur Termine die nach einer Zeitspanne <timespec> ab jetzt enden; Minuszeichen für Termine in der Vergangenheit benutzen; <timespec> wird weiter unten im Attribut-Abschnitt beschrieben.
`to=[+\|-]<timespec>`	zeigt nur Termine die vor einer Zeitspanne <timespec> ab jetzt starten; Minuszeichen für Termine in der Vergangenheit benutzen; <timespec> wird weiter unten im Attribut-Abschnitt beschrieben.
`when=today\|tomorrow`	zeigt anstehende Termin für heute oder morgen an

Examples:
get MyCalendar events limit:count=10
get MyCalendar events limit:from=-2d
get MyCalendar events limit:when=today
get MyCalendar events limit:count=10,from=0,to=+10d

Der include Parameter schließt Termine aus anderen Kalendern ein. Das ist nützlich, um Termine aus anderen Kalendern in einer kombimierten Ausgabe anzuzeigen. <names> ist eine mit Kommas getrennte Liste der Namen von Calendar-Geräten. Der Name des Kalenders selbst sowie Duplikate werden stillschweigend ignoriert. Namen von Geräten, die es nicht gibt oder keine Calendar-Geräte sind, werden ignoriert und es wird eine Fehlermeldung ins Log geschrieben.

Example:
get MyCalendar events include:Feiertage,Müllabfuhr

Der Parameter returnType wird verwendet, um die Termine als ein bestimmter Typ zurückzugeben. Das ist nützlich für Perl-Skripte.

`<returnTypeSpec>`	Beschreibung
`$text`	ein mehrzeiliger String in menschenlesbarer Darstellung (Vorgabe)
`@texts`	ein Array von Strings in menschenlesbarer Darstellung
`@event`	ein Array von Calendar::Event-Hashs

get <name> find <regexp>
Gibt zeilenweise die UID von allen Terminen aus, deren Zusammenfassung dem regulären Ausdruck <regexp> entspricht.
get <name> vcalendar
Gibt den Kalender im ICal-Format aus, so wie er von der Quelle abgerufen wurde.
get <name> vevents
Gibt eine Liste aller VEVENT-Einträge mit weiteren Informationen für Debugzwecke zurück. Nur Eigenschaften, die bei der Verarbeitung des Kalenders behalten wurden, werden gezeigt. Die Liste, der aus jedem VEVENT-Eintrag erstellten Termine, wird, ebenso wie die ausgelassenen Termine, gezeigt.

Attributes

defaultFormat <formatSpec>
Setzt das Standardformat für get <name> events. Der Aufbau wird dort erklät. <formatSpec> muss in doppelte Anführungszeichen (") gesetzt werden, wie z.B. attr myCalendar defaultFormat "$T1 $D $S".

defaultTimeFormat <timeFormatSpec>
Setzt das Standardzeitformat für get <name> events. Der Aufbau wird dort erklät. <timeFormatSpec> nicht in Anführungszeichen setzten.

synchronousUpdate 0|1
Wenn dieses Attribut nicht oder auf 0 gesetzt ist, findet die Verarbeitung im Hintergrund statt und FHEM wird während der Verarbeitung nicht blockieren.
Wird dieses Attribut auf 1 gesetzt, findet die Verarbeitung des Kalenders im Vordergrund statt. Umfangreiche Kalender werden FHEM auf langsamen Systemen blockieren.

Das Attribut wird ignoriert, falls FHEM unter Windows betrieben wird. In diesem Fall erfolgt die Verarbeitung immer synchron.

update none|onUrlChanged
Wird dieses Attribut auf none gesetzt ist, wird der Kalender überhaupt nicht aktualisiert.
Wird dieses Attribut auf onUrlChanged gesetzt ist, wird der Kalender nur dann aktualisiert, wenn sich die URL seit dem letzten Aufruf verändert hat, insbesondere nach der Auswertung von wildcards im define.

removevcalendar 0|1
Wenn dieses Attribut auf 1 gesetzt ist, wird der vCalendar nach der Verarbeitung verworfen, gleichzeitig reduziert sich der Speicherverbrauch des Moduls. Ein Abruf über get <name> vcalendar ist dann nicht mehr möglich.

hideOlderThan <timespec>
hideLaterThan <timespec>

Dieses Attribut grenzt die Liste der durch get <name> full|debug|text|summary|location|alarm|start|end ... gezeigten Termine ein. Die Zeit wird relativ zur aktuellen Zeit t angegeben.
Wenn <hideOlderThan> gesetzt ist, werden Termine, die vor <t-hideOlderThan> enden, ingnoriert.
Wenn <hideLaterThan> gesetzt ist, werden Termine, die nach <t+hideLaterThan> anfangen, ignoriert.

Bitte beachte, dass eine Aktion, die durch einen Wechsel in den Modus "end" ausgelöst wird, nicht auf den Termin zugreifen kann, wenn hideOlderThan 0 ist, denn der Termin ist dann schon versteckt. Setze hideOlderThan besser auf 10.

<timespec> muss; einem der folgenden Formate entsprechen:

Format	Beschreibung	Beispiel
SSS	Sekunden	3600
SSSs	Sekunden	3600s
HH:MM	Stunden:Minuten	02:30
HH:MM:SS	Stunden:Minuten:Sekunden	00:01:30
D:HH:MM:SS	Tage:Stunden:Minuten:Sekunden	122:10:00:00
DDDd	Tage	100d

cutoffOlderThan <timespec>
Dieses Attribut schneidet alle Termine weg, die eine Zeitspanne cutoffOlderThan vor der letzten Aktualisierung des Kalenders endeten. Der Zweck dieses Attributs ist es Speicher zu sparen. Auf solche Termine kann gar nicht mehr aus FHEM heraus zugegriffen werden. Serientermine ohne Ende (UNTIL) und Termine ohne Endezeitpunkt (DTEND) werden nicht weggeschnitten.

onCreateEvent <perl-code>
Dieses Attribut führt ein Perlprogramm <perl-code> für jeden erzeugten Termin aus. Weitere Informationen unter Plug-ins im Text.

SSLVerify
Dieses Attribut setzt die Art der Überprüfung des Zertifikats des Partners bei mit SSL gesicherten Verbindungen. Entweder auf 0 setzen für SSL_VERIFY_NONE (keine Überprüfung des Zertifikats) oder auf 1 für SSL_VERIFY_PEER (Überprüfung des Zertifikats). Die Überprüfung auszuschalten ist nützlich für lokale Kalenderinstallationen(e.g. OwnCloud, NextCloud) ohne gütiges SSL-Zertifikat.

ignoreCancelled
Wenn dieses Attribut auf 1 gesetzt ist, werden Termine im Status "CANCELLED" ignoriert. Dieses Attribut auf 1 setzen, falls Termine in einer Serie zurückgegeben werden, die gelöscht sind.

quirks <values>
Parameter für spezielle Situationen. <values> ist eine kommaseparierte Liste der folgenden Schlüsselwörter:
- ignoreDtStamp: wenn gesetzt, dann zeigt ein verändertes DTSTAMP Attribut eines Termins nicht an, dass; der Termin verändert wurde.

readingFnAttributes

Beschreibung

Termine werden erzeugt, wenn FHEM gestartet wird oder der betreffende Eintrag im Quell-Kalender verändert wurde oder der Kalender mit get <name> reload neu geladen wird. Es werden nur Termine innerhalb ±400 Tage um die Erzeugungs des Termins herum erzeugt. Ziehe in Betracht, den Kalender von Zeit zu Zeit neu zu laden, um zu vermeiden, dass; FHEM die künftigen Termine ausgehen. Du kann so etwas wie define reloadCalendar at +*240:00:00 set MyCalendar reload dafür verwenden.

Manche dumme Kalender benutzen LAST-MODIFIED nicht. Das kann dazu führen, dass Veränderungen im Quell-Kalender unbemerkt bleiben. Lade den Kalender neu, wenn Du dieses Problem hast.

Ein Termin wird durch seine UID identifiziert. Die UID wird vom Quellkalender bezogen. Um das Leben leichter zu machen, werden alle nicht-alphanumerischen Zeichen automatisch aus der UID entfernt.

Ein Termin kann sich in einem der folgenden Modi befinden:

upcoming	Weder die Alarmzeit noch die Startzeit des Kalendereintrags ist erreicht.
alarm	Die Alarmzeit ist überschritten, aber die Startzeit des Kalender-Ereignisses ist noch nicht erreicht.
start	Die Startzeit ist überschritten, aber die Ende-Zeit des Kalender-Ereignisses ist noch nicht erreicht.
end	Die Endzeit des Kalender-Ereignisses wurde überschritten.

Ein Kalender-Device hat verschiedene Readings. Mit Ausnahme von calname stellt jedes Reading eine semikolonseparierte Liste aus UID von Kalender-Ereignisse dar, welche bestimmte Zustände haben:

calname	Name des Kalenders
modeAlarm	Ereignisse im Alarm-Modus
modeAlarmOrStart	Ereignisse im Alarm- oder Startmodus
modeAlarmed	Ereignisse, welche gerade in den Alarmmodus gewechselt haben
modeChanged	Ereignisse, welche gerade in irgendeiner Form ihren Modus gewechselt haben
modeEnd	Ereignisse im Endmodus
modeEnded	Ereignisse, welche gerade vom Start- in den Endmodus gewechselt haben
modeStart	Ereignisse im Startmodus
modeStarted	Ereignisse, welche gerade in den Startmodus gewechselt haben
modeUpcoming	Ereignisse im zukünftigen Modus

Für Serientermine werden mehrere Termine mit identischer UID erzeugt. In diesem Fall wird die UID nur im interessantesten gelesenen Modus-Reading angezeigt. Der interessanteste Modus ist der erste zutreffende Modus aus der Liste der Modi start, alarm, upcoming, end.

Die UID eines Serientermins wird nicht angezeigt, solange sich der Termin im Modus: modeEnd oder modeEnded befindet und die Serie nicht beendet ist. Die UID befindet sich in einem der anderen mode... Readings. Hieraus ergibts sich, das FHEM-Events nicht auf einem mode... Reading basieren sollten. Weiter unten im Text gibt es hierzu eine Empfehlung.

Events

triggered

Man kann sich darauf verlassen, dass alle Readings des Kalenders in einem konsistenten und aktuellen Zustand befinden, wenn dieses Event empfangen wird.

Wenn ein Termin geändert wurde, werden zwei FHEM-Events erzeugt:

changed: UID <mode>
<mode>: UID

<mode> ist der aktuelle Modus des Termins nach der änderung. Bitte beachten: Im FHEM-Event befindet sich ein Doppelpunkt gefolgt von einem Leerzeichen.

FHEM-Events sollten nur auf den vorgenannten Events basieren und nicht auf FHEM-Events, die durch ändern eines mode... Readings ausgelöst werden.

Plug-ins

Ein Plug-In ist ein kleines Perl-Programm, das Termine nebenher verändern kann. Das Perl-Programm arbeitet mit der Hash-Referenz $e.
Die wichtigsten Elemente sind:

code	Beschreibung
$e->{start}	Startzeit des Termins, in Sekunden seit 1.1.1970
$e->{end}	Endezeit des Termins, in Sekunden seit 1.1.1970
$e->{alarm}	Alarmzeit des Termins, in Sekunden seit 1.1.1970
$e->{summary}	die Zusammenfassung (Betreff, Titel) des Termins
$e->{location}	Der Ort des Termins

attr MyCalendar onCreateEvent { $e->{alarm}= $e->{start}-86400 if($e->{summary} =~ /Tonne/);; }

Perl specials

attr MyCalendar onCreateEvent { $e->{end}= $e->{start}+86400 unless(defined($e->{end})) }

Anwendungsbeispiele

Alle Termine inkl. Details anzeigen


    get MyCalendar events format:full

    2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom     alarm 31.05.2012 17:00:00 07.06.2012 16:30:00-07.06.2012 18:00:00 Erna for coffee

    992hydf4y44awer5466lhfdsrgl7tin6b6mckf8glmhui4googlecom  upcoming                     08.06.2012 00:00:00-09.06.2012 00:00:00 Vacation

Zeige Termine in Deinem Bilderrahmen

layout description

text 20 60 { fhem("get MyCalendar events timeFormat:'%d.%m.%Y %H:%M' format:custom='$T1 $S' filter:mode=~'alarm|start') }


    07.06.12 16:30 Erna zum Kaffee

    08.06.12 00:00 Urlaub

Schalte das Licht ein, wenn Erna kommt


    get MyCalendar find .*Erna.*

    2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom


    define ErnaComes notify MyCalendar:start:.2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom.* set MyLight on


    define LogErna notify MyCalendar:alarm:.2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom.* { Log3 $NAME, 1, "ALARM name=$NAME event=$EVENT part1=$EVTPART0 part2=$EVTPART1" }

Schalte Aktoren an und aus


    define SwitchActorOn  notify MyCalendar:start:.* { \

                my $reading="$EVTPART0";; \

                my $uid= "$EVTPART1";; \

                my $actor= fhem('get MyCalendar filter:uid=="'.$uid.'" format:custom="$S"');; \

                if(defined $actor) {
                   fhem("set $actor on")
                } \

    }


    define SwitchActorOff  notify MyCalendar:end:.* { \

                my $reading="$EVTPART0";; \

                my $uid= "$EVTPART1";; \

                my $actor= fhem('get MyCalendar filter:uid=="'.$uid.'" format:custom="$S"');; \

                if(defined $actor) {
                   fhem("set $actor off")
                } \

    }


    define LogActors notify MyCalendar:(start|end):.*
    { my $reading= "$EVTPART0";; my $uid= "$EVTPART1";; \

      my $actor= fhem('get MyCalendar filter:uid=="'.$uid.'" format:custom="$S"');; \

     Log3 $NAME, 1, "Actor: $actor, Reading $reading" }

Benachrichtigen über Müllabholung

GarbageCalendar


    define GarbageCollectionNotifier notify GarbageCalendar:alarm:.* { \

      my $uid= "$EVTPART1";; \

      my $summary= fhem('get GarbageCalendar events filter:uid=="'.$uid.'" format:custom="$S"');; \

      # e.g. mail $summary to someone \

    }


    attr GarbageCalendar onCreateEvent { $e->{alarm}= $e->{start}-86400 }

{ CalendarEventsAsHtml('GarbageCalendar','format:text filter:mode=~"alarm|start"') }

Eingebettetes HTML

CalendarAsHtml(<name>,<parameter>)

<name>

<parameter>

get <name> text ...

Diese Funktion ist veraltert und sollte nicht mehr genutzt werden!

Beispiel

define MyCalendarWeblink weblink htmlCode { CalendarAsHtml("MyCalendar","next 3") }

CalendarEventsAsHtml(<name>,<parameter>)

name

parameters

Beispiel

define MyCalendarWeblink weblink htmlCode
    { CalendarEventsAsHtml('F','format:custom="$T1 $D $S" timeFormat:"%d.%m" series:next=3') }

ComfoAir

CustomReadings

DFPlayerMini - FN-M16P Embedded MP3 Audio Module

[EN DE]

Dieses Modul integriert den DFPlayerMini - FN-M16P Embedded MP3 Audio Modul in fhem. Siehe auch das Datenblatt des Moduls für technische Details.
Der MP3-Spieler kann direkt mit einer seriellen Schnittstelle verbunden werden oder per Ethernet/WiFi mittels einer Hardware die eine transparente serielle Übertragung per TCP/IP zur Verfügung stellt, z. B. ESPEasy Ser2Net.

Es ist auch möglich ein anderes fhem Device für den Datentransport zu nutzen, z. B. MYSENSORS.

Das Modul unterstützt alle Kommandos des DFPlayers und bietet weitere Funktionen wie

Integration von Text2Speech um einfach Sprach-MP3-Dateien herunterzuladen
einfachere Kontrolle darüber welche Dateien abgespielt werden sollen
Verwaltung aller Dateien die der DFPlayer abspielen kann
Abspielen mehrerer Dateien hintereinander (playlist)
Erzeugung und Abspielen von Sprachschnipseln um beliebige Zahlen per Sprache auszugeben

Define
define <name> DFPlayerMini {none | devicename[\@baudrate] | devicename\@directio | hostname:port}

Wenn der Player direkt angeschlossen ist wird per <devicename> der Name der seriellen Schnittstelle angegeben an die der DFPlayer Mini angeschlossen ist. Der Name der seriellen Schnittstelle hängt von der Betriebssystemdistribution ab, unter Linux ist das cdc_acm kernel Modul verantwortlich, und normalerweise wird ein /dev/ttyACM0 oder /dev/ttyUSB0 Device angelegt. Man kann auch eine Baudrate angeben in dem dem im Devicenamen nach dem @ Zeichen die Baudrate angegeben wird, z. B. /dev/ttyACM0@9600

Das ist auch die standard Baudrate und sollte normalerweise nicht geändert werden da diese Baudrate beim DFPlayer fest eingestellt ist. Wenn als Baudrate "directio" angegeben wird (z. B.: /dev/ttyACM0@directio) dann wird das perl Modul Device::SerialPort nicht benötigt und fhem öffnet das Device mit simple file io. Das kann funktionieren wenn das Betriebssystem sinnvolle Voreinstellungen für die Parameter der seriellen Schnittstelle verwendet, z. B. einige Linux Distributionen und OSX.
Wenn die Verbindung über TCP/IP statt findet spezifiziert <hostname:port> die IP Adresse und den Port des Device das die transparente serielle Verbindung zum DFP bereit stellt, e.g. 192.168.2.28:23
Für andere Arten des Datentransports kann none als Device angegeben werden. In diesem Fall sollte das Attribute sendCmd angegeben werden. Antworten vom DFPlayer sollten per set response zurück an dieses Module übergeben werden.

Attribute

TTSDev
Der Name eines Text2Speech Devices. Dieses muss bereits vorher mit none als <alsadevice> als Server Device angelegt worden sein. Es sollte ausschließlich für dieses Modul zur Verfügung stehen und nicht für andere Zwecke verwendet werden.
requestAck
Der DFPlayer kann fü jedes Kommando eine Bestätigung senden. Da das zu erhöhter Kommunikation führt kann es über dieses Attribut abgeschaltet werden. Wenn es eingeschaltet ist wird das nächste Kommando erst dann zum DFPlayer wenn das vorherige bestätigt wurde. Das stellt sicher, dass kein Kommando verloren geht selbst wenn der DFPlayer ausgelastet oder im Schlafzustand ist.
sendCmd
Ein fhem Kommando das verwendet wird um ein durch diese Modul erzeugtes DFPlayer Kommando an die DFPlayer Hardware zu senden. Wenn dieses Attribut gesetzt ist wird kein andere Art der Kommunikation mit dem DFPlayer verwendet. Es kann verwendet werden um andere fhem Devices für den Datentransport zu nutzen.
Um z. B. mittels eines MySensor Devices mit dem Namen mys_dfp zu kommunizieren kann
attr <dfp> sendCmd set mys_dfp value11 $msg
verwendet werden. Auf dem MySensors Devices muss eine passende Firmware installiert sein.
Dieses Modul wird dann ein Kommando an den DFP senden in dem $msg mit dem tatsächlichen Kommando <payload> ersetzt wird und dann das fhem Kommando set mys_dfp value11 <payload>
ausgeführt wird. Siehe set response für einen Weg um die Antwort des DFPlayers zurück an dieses Modul zu senden.
uploadPath
Der DFPlayer spielt Dateien von einer an ihn angeschlossenen SD-Karte oder USB-Stick ab. Die mp3/wav Dateien müssen vom Anwender auf dieses Speichermedium kopiert werden. Der Player erwartet die Dateien mit speziellen Namen und in spezifischen Verzeichnissen, im Datenblatt stehen die Einzelheiten. Das Kopieren der Dateien kann auch von diesem Modul durchgeführt werden. Dazu muss das Speichermedium mit dem Rechner verbunden sein auf dem fhem ausgeführt wird. Es muss dazu in dem Pfad gemounted sein der durch diese Attribut angegeben ist.
Siehe auch uploadTTS, uploadTTScache und readFiles Kommandos wo es verwendet wird.
rememberMissingTTS
Wenn gesetzt erzeugen tts Kommandos ohne eine passende Datei ein spezielles Reading. Siehe set tts und set uploadTTScache.
keepAliveInterval
Gibt das Intervall in Sekunden zwischen KeepAlive Kommandos an den DFP an. Das kann verwendet werden um automatisch zu prüfen, ob der DFP noch funktioniert und erreichbar ist.
Nach drei fehlenden Antwortden wird der Status auf disconnected gesetzt.
Interval 0 schaltet die Funktion ab, die Voreinstellung ist 60 Sekunden.

Get

Alle Abfrage Kommandos die vom DFP unterstützt werden haben ein zugehöriges get Kommando:

get	DFP cmd byte	Parameter	Kommentar
storage	0x3F
status	0x42
volume	0x43
equalizer	0x44
noTracksRootUsb	0x47
noTracksRootSd	0x48
currentTrackUsb	0x4B
currentTrackSd	0x4C
noTracksInFolder	0x4E	Verzeichnisnummer	1-99
noFolders	0x4F

Set

Alle Kommandos die vom DFP angeboten werden haben ein zugehöriges set Kommando:

set	DFP cmd byte	Parameter	Kommentar
next	0x01	-
prev	0x02	-
trackNum	0x03	Nummer der Datei im Wurzelverzeichnis	zwischen 1 und 3000 (es wird die Reihenfolge verwendet in der die Dateien angelegt wurden!)
volumeUp	0x04	-
volumeDown	0x05	-
volumeStraight	0x06	Lautstärke	0-30
equalizer	0x07	Name des Equalizermodus	Normal, Pop, Rock, Jazz, Classic, Bass
repeatSingle	0x08	-
storage	0x09	SD oder USB
sleep	0x0A	-	vom DFP nicht unterstützt, danach muss er stromlos gemacht werden um wieder zu funktionieren
wake	0x0B	-	vom DFP nicht unterstützt, aber wahrscheinlich vom FN-M22P
reset	0x0C	-
play	0x0D	-	spielt die aktuelle Datei
play	0x0F, 0x12, 0x13, 0x14	Eine durch Leerzeichen getrennte Liste von Dateien die nacheinander abgespielt werden	Das korrekte DFP Kommando wird automatisch ermittelt. Dateien können über den Namen ihres Readings, den Readingwert oder Verzeichnisname/Dateinummer angegeben werden. Siehe set readFiles
pause	0x0E	-
amplification	0x10	Verstärkungsstufe	0-31
repeatRoot	0x11	on, off
MP3TrackNum	0x12	Dateinummer	1-3000, aus dem Verzeichnis MP3
intercutAdvert	0x13	Dateinummer	1-3000, aus dem Verzeichnis ADVERT
folderTrackNum	0x0F	Verzeichnisnummer Dateinummer	Verzeichnis: 1-99, Datei: 1-255
folderTrackNum3000	0x14	Verzeichnisnummer Dateinummer	Verzeichnis: 1-15, Datei: 1-3000
stopAdvert	0x15	-
stop	0x16	-
repeatFolder	0x17	Verzeichnisnummer	1-99
shuffle	0x18	-
repeatCurrentTrack	0x19	on, off
DAC	0x1A	on, off

Alle anderen set Kommandos werden nicht an den DFPlayer geschickt sondern bieten Komfortfunktionen:

close
raw
sendet ein in Hexadezimal kodiertes Kommando direkt und ohne Prüfung an den DFP
reopen
readFiles
ließt alle Dateien auf dem Speichermedium das in uploadPath gemounted ist. Wenn diese Dateien durch den DFP addressiert werden können (d.h. sie entprechen den Namenskonventionen) so wird ein Reading dafür angelegt. Der Readingname ist File_<Verzeichnis>/<Dateinummer>. Das Verzeichnis kann ., MP3, ADVERT oder 00 bis 99 sein. Der Readingwert ist der Dateiname ohne die Dateinummer und das Suffix.
Beispiel:
Für die Datei MP3/0003SongTitle.mp3 wird das Reading File_MP3/0003 mit dem Wert SongTitle angelegt.
Das set <dfp> play Kommando kann diese Readings verwenden, d.h. es ist möglich entweder set <dfp> play File_MP3/0003, set <dfp> play MP3/3 oder set <dfp> play SongTitle zu verwenden, um die selbe Datei abzuspielen.
uploadTTS <destination path> <Text der in Sprache umgewandelt werden soll>
Der angegebene Text wird in eine MP3 Sprachdatei umgewandelt. Dafür wird das Text2Speech Device verwendet das mit attr TTSDev angegebene wurde. Die MP3 Datei wird dann in das angegebene Zielverzeichnis unterhalb von uploadPath kopiert.
Beispiele:
set <dfp> 01/0001Test Dies ist ein Test
set <dfp> ADVERT/0099Hinweis Achtung
uploadTTScache
Kopiert alle Dateien aus dem cache Verzeichnis des TTSDev in uploadPath. Es wird zuerst in das Verzeichnis 01 kopiert. Nach 3000 Dateien wird das nächste Verzeichnis verwendet. Der MD5 Hash wird als Dateiname verwendet. Zum Schluss wird set readFiles ausgeführt. Das Kommando set tts verwendet die dadurch angelegten Readings.
tts <Text der in Sprache übersetzt werden soll>
TTSDev wird verwendet um den MD5 Hash von <Text der in Sprache übersetzt werden soll> zu berechnen. Anschließend wird versucht die Datei mit diesem Hash abzuspielen. Wenn kein Reading für diesen Hash existiert und das wenn das Attribute rememberMissingTTS gesetzt ist dann wird ein neues Reading Missing_MD5<md5> mit dem Wert <Text der in Sprache übersetzt werden soll> angelegt.
Voraussetzungen:
Das funktioniert nur, wenn vorher der zu übersetzende Text bereits einmal übersetzt wurde und die daraus resultierende MP3 Datei im cache Verzeichnis des TTSDev gespeichert wurde, Die Dateien aus dem Cache müssen auf das Speichermedium mittels set uploadTTScache kopiert werden
uploadNumbers Zielverzeichnis
erzeugt MP3 Dateien für alle Sprachschnipsel die benötigt werden um beliebige deutsche Zahlen zu sprechen.
Beispiel:
set <dfp> uploadNumbers 99
erzeugt die benötigten 31 MP3 Dateien im Verzeichnis 99.
sayNumber Zahl
übersetzt eine Zahl in Sprache und spielt die benötigten Dateien ab. Setzt voraus, dass vorher uploadNumbers verwendet wurde um die Sprachdateien zu erzeugen.
Beispiel:
sayNumber -34.7
entspricht
play minus vier und dreissig komma sieben
response
10 Byte Antwortnachricht vom DFP hexadezimal kodiert

DLNARenderer

DOIF

[EN DE]

Perl-Modus

define <name> DOIF (<Bedingung>) (<Befehle>) DOELSEIF (<Bedingung>) (<Befehle>) DOELSEIF ... DOELSE (<Befehle>)

Einfache Anwendungsbeispiele (vgl. Anwendungsbeispiele im Perl-Modus):

define di_rc_tv DOIF ([remotecontol:"on"]) (set tv on) DOELSE (set tv off)

define di_clock_radio DOIF ([06:30|Mo Di Mi] or [08:30|Do Fr Sa So]) (set radio on) DOELSEIF ([08:00|Mo Di Mi] or [09:30|Do Fr Sa So]) (set radio off)

define di_lamp DOIF ([06:00-09:00] and [sensor:brightness] < 40) (set lamp on) DOELSE (set lamp off)

Erste Schritte mit DOIF

Inhaltsübersicht

Ereignissteuerung

Teilausdrücke abfragen

Ereignissteuerung über Auswertung von Events

Angaben im Ausführungsteil

Filtern nach Ausdrücken mit Ausgabeformatierung

Durchschnitt, Median, Differenz, anteiliger Anstieg

Aggregieren von Werten

Zeitsteuerung

Relative Zeitangaben

Zeitangaben nach Zeitraster ausgerichtet

Relative Zeitangaben nach Zeitraster ausgerichtet

Zeitangaben nach Zeitraster ausgerichtet alle X Stunden

Wochentagsteuerung

Zeitsteuerung mit Zeitintervallen

Indirekten Zeitangaben

Zeitsteuerung mit Zeitberechnung

Intervall-Timer

Kombination von Ereignis- und Zeitsteuerung mit logischen Abfragen

Zeitintervalle, Readings und Status ohne Trigger

Nutzung von Readings, Status oder Internals im Ausführungsteil

Berechnungen im Ausführungsteil

Ersatzwert für nicht existierende Readings oder Status

Verzögerungen

Verzögerungen von Timern

Zurücksetzen des Waittimers für das gleiche Kommando

Wiederholung von Befehlsausführung

Zwangspause für das Ausführen eines Kommandos seit der letzten Zustandsänderung

Begrenzung von Wiederholungen eines Kommandos

Ausführung eines Kommandos nach einer Wiederholung einer Bedingung

Löschen des Waittimers nach einer Wiederholung einer Bedingung

Readingauswertung bei jedem Event des Devices

Eindeutige Statuserkennung

Triggerung durch selbst ausgelöste Events

Setzen der Timer mit Event

Zeitspanne eines Readings seit der letzten Änderung

Darstellungselement mit Eingabemöglichkeit im Frontend und Schaltfunktion

Status des Moduls

uiTable, das User Interface

Reine Statusanzeige ohne Ausführung von Befehlen

Anpassung des Status mit Hilfe des Attributes state

Erzeugen berechneter Readings

Vorbelegung des Status mit Initialisierung nach dem Neustart mit dem Attribut initialize

Deaktivieren des Moduls

Bedingungslose Ausführen von Befehlszweigen

Initialisieren des Moduls

Weitere Anwendungsbeispiele

Attribute

Set Befehle

Get Befehle

Lesbarkeit der Definitionen

`define di_Modul DOIF ([Switch1] eq "on" and [Switch2] eq "on")`	`## wenn Schalter 1 und Schalter 2 on ist`
`(set lamp on)`	`## wird Lampe eingeschaltet`
`DOELSE`	`## im sonst-Fall, also wenn einer der Schalter off ist`
`(set lamp off)`	`## wird die Lampe ausgeschaltet`

define di_Modul DOIF

{ `if ([Switch1] eq "on" and [Switch2] eq "on") {`	`## wenn Schalter 1 und Schalter 2 on ist`
`fhem_set "lamp on"`	`## wird Lampe eingeschaltet`
`} else {`	`## im sonst-Fall, also wenn einer der Schalter off ist`
`fhem_set "lamp off"`	`## wird die Lampe ausgeschaltet`
`}`
`}`

Ereignissteuerung

==, !=, <, <=, >, >=

eq, ne, lt, le, gt, ge, =~, !~

and

or

[<devicename>]

[<devicename>:<readingname>]

[<devicename>:&<internal>]

Anwendungsbeispiel

define di_garage DOIF ([remotecontrol] eq "on") (set garage on) DOELSEIF ([remotecontrol] eq "off") (set garage off)

attr di_garage do always

define di_heating DOIF ([sens:temperature] < 20) (set heating on)

do always

define di_heating DOIF {if ([sens:temperature] < 20) {if (Value("heating") ne "on") {fhem_set"heating on"}}}

Teilausdrücke abfragen

=~

Anwendungsbeispiel

define di_garage DOIF ([remotecontrol] =~ "Long") (set garage on)

attr di_garage do always

define di_garage DOIF {if ([remotecontrol] =~ "Long") {fhem_set"garage on"}}

=~

Ereignissteuerung über Auswertung von Events

[<devicename>:"<regex>"]

Anwendungsbeispiel

define di_garage DOIF ([remotecontrol:"on"]) (set garage on) DOELSEIF ([remotecontrol:"off"]) (set garage off)

define di_garage DOIF {if ([remotecontrol:"on"]) {fhem_set"garage on"} elsif ([remotecontrol:"off"]) {fhem_set"garage off"}}

[<devicename>:?<regex>]

["<device regex>:<event regex>"]

Anwendungsbeispiele

define di_window_open DOIF (["^window_:open"]) (set Pushover msg 'alarm' 'open windows $DEVICE' '' 2 'persistent' 30 3600)

attr di_window_open do always

define di_window_open DOIF {if (["^window_:open"]) {fhem_set"Pushover msg 'alarm' 'open windows $DEVICE' '' 2 'persistent' 30 3600"}}

["regex for trigger",<default value>]

define di_warning DOIF ([":^temperature",0]< 0) (set pushmsg danger of frost $DEVICE)

attr di_warning do always

Filtern nach Ausdrücken mit Ausgabeformatierung

define di_warning DOIF {if ([":^temperature",0]< 0) {fhem_set"pushmsg danger of frost $DEVICE}}

["regex for trigger":"<regex filter>":<output>,<default value>]

Filtern nach Ausdrücken mit Ausgabeformatierung

[<device>:<reading>|<internal>:d<number>|"<regex>":<output>]

define di_heating DOIF ([adjusting:actuator:d] < 10) (set heating off) DOELSE (set heating on)

[mydevice:myreading:d]

[mydevice:myreading:"(-?\d+(\.\d+)?)"]

[mydevice:myreading:"(-?\d+(\.\d+)?)":$1]

[mydevice:myreading:"(-?\d+(\.\d+)?)":"$1"]

[mydevice:myreading:"(-?\d+(\.\d+)?)":sprintf("%s":$1)]

[mydevice:myreading:d3]

... (set mydummy [mydevice:myreading:d2:"$1 °C"])

[mydevice:myreading:"(\d\d):(\d\d):(\d\d)":"hours: $1, minutes $2, seconds: $3"]

[alarm:state:"(.*)":"state of alarm is $1"]

Durchschnitt, Median, Differenz, anteiliger Anstieg

[<device>:<reading>:<function><number of last values>]

Durchschnitt

avg

define di_cold DOIF ([outdoor:temperature:avg5] < 10)(set cold on)

Median

med

define di_frost DOIF ([$SELF:outTempMed] < 0) (set warning frost)



attr di_frost event_Readings outTempMed:[outdoor:temperature:med]

Differenz

diff

define temp_abfall DOIF ([outdoor:temperature:diff5] < -3) (set temp fall in temperature)

anteiliger Anstieg

inc

define humidity_warning DOIF ([bathroom:humidiy:inc] > 0.1) (set bath speak open window)

Angaben im Ausführungsteil (gilt nur für FHEM-Modus)

...(set lamp on)

... (set lamp1 on, set lamp2 off)

...((set lamp1,lamp2 on),set switch on)

... {system ("wmail Peter is at home")}

...{my $name="Peter"; system ("wmail $name is at home");}

... ({system ("wmail Peter is at home")}, set lamp on)

Aggregieren von Werten

Eigene Funktionen - subs-Block

[<function>:<format>:"<regex device>:<regex event>":<reading>|"<regex reading>":<condition>,<default>]

#sum

#max

#min

#average

@max

@min

d<number>

a

s(<splittoken>)

Syntax-Beispiele im Ausführungteil

[#"^window"]

[@:a"^window"]

[@"^window":myreading]

[@"^window":state:"open"]

[@"^window":state:$_ =~ "open"]

[#min:"^abfall$":"Gruenschnitt.*_days$"]

[#average:"^T_":"temp"]

können alle in FHEM definierten Perlfunktionen genutzt werden. Folgende Variablen sind vorbelegt und können ebenfalls benutzt werden:

$_ Inhalt des angegebenen Readings (s.o.)
$number Nach Zahl gefilteres Reading
$name Name des Devices
$TYPE Devices-Typ
$STATE Status des Devices (nicht das Reading state)
$room Raum des Devices
$group Gruppe des Devices

Beispiele für Definition der Aggregationsbedingung <condition>:

Liste der Devices, die mit "rooms" enden und im Reading "temperature" einen Wert größer 20 haben:

[@"rooms$":temperature:$_ > 20]

Liste der Devices im Raum "livingroom", die mit "rooms" enden und im Reading "temperature" einen Wert größer 20 haben:

[@"rooms$":temperature:$_ > 20 and $room eq "livingroom"]

Liste der Devices in der Gruppe "windows", die mit "rooms" enden, deren Status (nicht state-Reading) "on" ist:

[@"rooms$"::$STATE eq "on" and $group eq "windows"]

Liste der Devices, deren state-Reading "on" ist und das Attribut disable nicht auf "1" gesetzt ist:

[@"":state:$_ eq "on" and AttrVal($name,"disable","") ne "1"]

Aggregationsangaben in der DOIF-Bedingung reagieren zusätzlich auf Ereignistrigger, hier sollte die regex-Angabe für das Device um eine regex-Angabe für das zu triggernde Event erweitert werden.

Anzahl der Devices, die mit "window" beginnen. Getriggert wird, wenn eine Eventzeile beginnend mit "window" und dem Wort "open" vorkommt:

[#"^window:open"]

Anwendungsbeispiele

Statusanzeige: Offene Fenster:

define di_window DOIF



attr di_window state Offene Fenster: [@"^window:open":state:"open","keine"]

Statusanzeige: Alle Devices, deren Batterie nicht ok ist:

define di_battery DOIF



attr di_battery state [@":battery":battery:$_ ne "ok","alle OK"]

Statusanzeige: Durchschnittstemperatur aller Temperatursensoren in der Gruppe "rooms":

define di_average_temp DOIF



attr di_average_temp state [#average:d2:":temperature":temperature:$group eq "rooms"]

Fenster Status/Meldung:

define di_Fenster DOIF (["^Window:open"]) 

(push "Fenster $DEVICE wurde geöffnet. Es sind folgende Fenster offen: [@"^Window":state:"open"]")

DOELSEIF ([#"^Window:closed":state:"open"] == 0)

(push "alle Fenster geschlossen")



attr di_Fenster do always

attr di_Fenster cmdState [$SELF:Device] zuletzt geöffnet|alle geschlossen

Raumtemperatur-Überwachung:

define di_temp DOIF (([08:00] or [20:00]) and [?#"^Rooms":temperature: $_ < 20] != 0)

  (push "In folgenden Zimmern ist zu kalt [@"^Rooms":temperature:$_ < 20,"keine"]")

DOELSE

  (push "alle Zimmmer sind warm")
  


attr di_temp do always

attr di_Raumtemp state In folgenden Zimmern ist zu kalt: [@"^Rooms":temperature:$_ < 20,"keine"])

Es soll beim Öffnen eines Fensters eine Meldung über alle geöffneten Fenster erfolgen:

define di_Fenster DOIF (["^Window:open"]) (push "Folgende Fenster: [@"^Window:state:"open"] sind geöffnet")
attr di_Fenster do always

Wenn im Wohnzimmer eine Lampe ausgeschaltet wird, sollen alle anderen Lampen im Wohnzimmer ebenfalls ausgeschaltet werden, die noch an sind:

define di_lamp DOIF (["^lamp_livingroom: off"]) (set [@"^lamp_livingroom":state:"on","defaultdummy"] off)

attr di_lamp DOIF do always

Mit der Angabe des Default-Wertes "defaultdummy", wird verhindert, dass der set-Befehl eine Fehlermeldung liefert, wenn die Device-Liste leer ist. Der angegebene Default-Dummy muss zuvor definiert werden.

Für reine Perlangaben gibt es eine entsprechende Perlfunktion namens AggrDoIf(<function>,<regex Device>,<reading>,<condition>,<default>) diese liefert bei der Angabe @ ein Array statt einer Stringliste, dadurch lässt sie sich gut bei foreach-Schleifen verwenden.

Beispiele

Perl-Modus:

define di_Fenster DOIF {if (["^Window:open"]) {foreach (AggrDoIf('@','^windows','state','"open"')) {Log3 "di_Fenster",3,"Das Fenster $_ ist noch offen"}}}

define di_Temperature DOIF {if (["^room:temperature"]) {foreach (AggrDoIf('@','^room','temperature','$_ < 15')) {Log3 "di_Temperatur",3,"im Zimmer $_ ist zu kalt"}}

Zeitsteuerung back

Zeitangaben in der Bedingung im Format: [HH:MM:SS] oder [HH:MM] oder [Zahl]

Anwendungsbeispiele:

Einschalten um 8:00 Uhr, ausschalten um 10:00 Uhr.

define di_light DOIF ([08:00]) (set switch on) DOELSEIF ([10:00]) (set switch off)

Perl-Modus:

define di_light DOIF

{[08:00];fhem_set"switch on"}

{[10:00];fhem_set"switch on"}

Zeitsteuerung mit mehreren Zeitschaltpunkten:

define di_light DOIF ([08:00] or [10:00] or [20:00]) (set switch on) DOELSEIF ([09:00] or [11:00] or [00:00]) (set switch off)

Perl-Modus:

define di_light DOIF

{if ([08:00] or [10:00] or [20:00]) {fhem_set"switch on"}}

{if ([09:00] or [11:00] or [00:00]) {fhem_set"switch off"}}

Relative Zeitangaben back

Zeitangaben, die mit Pluszeichen beginnen, werden relativ behandelt, d. h. die angegebene Zeit wird zum aktuellen Zeitpunkt hinzuaddiert.

Anwendungsbeispiel: Automatisches Speichern der Konfiguration im Stundentakt:

define di_save DOIF ([+01:00]) (save)

attr di_save do always

Perl-Modus:
define di_save DOIF {[+01:00];fhem"save"}

Ebenfalls lassen sich relative Angaben in Sekunden angeben. [+01:00] entspricht [+3600];
Zeitangaben nach Zeitraster ausgerichtet back

Das Format lautet: [:MM] MM sind Minutenangaben zwischen 00 und 59.

Anwendungsbeispiel: Viertelstunden-Gong

Perl-Modus:

define di_gong DOIF

 {[:00];system"mplayer /opt/fhem/Sound/BigBen_00.mp3 -volume 90 −really−quiet &"}

 {[:15];system"mplayer /opt/fhem/Sound/BigBen_15.mp3 -volume 90 −really−quiet &"}

 {[:30];system"mplayer /opt/fhem/Sound/BigBen_30.mp3 -volume 90 −really−quiet &"}

 {[:45];system"mplayer /opt/fhem/Sound/BigBen_45.mp3 -volume 90 −really−quiet &"}

Relative Zeitangaben nach Zeitraster ausgerichtet back

Das Format lautet: [+:MM] MM sind Minutenangaben zwischen 1 und 59.

Anwendungsbeispiel: Gong alle fünfzehn Minuten um XX:00 XX:15 XX:30 XX:45

define di_gong DOIF ([+:15]) (set Gong_mp3 playTone 1)

attr di_gong do always

Perl-Modus:
define di_gong DOIF {[+:15];fhem_set"Gong_mp3 playTone 1"}

Zeitangaben nach Zeitraster ausgerichtet alle X Stunden back

Format: [+[h]:MM] mit: h sind Stundenangaben zwischen 2 und 23 und MM Minuten zwischen 00 und 59

Anwendungsbeispiel: Es soll immer fünf Minuten nach einer vollen Stunde alle 2 Stunden eine Pumpe eingeschaltet werden, die Schaltzeiten sind 00:05, 02:05, 04:05 usw.

define di_gong DOIF ([+[2]:05]) (set pump on-for-timer 300)

attr di_gong do always

Perl-Modus:
define di_gong DOIF {[+[2]:05];fhem_set"pump on-for-timer 300"}

Wochentagsteuerung back

Hinter der Zeitangabe kann ein oder mehrere Wochentage getrennt mit einem Pipezeichen | angegeben werden. Die Syntax lautet:

[<time>|0123456789] 0-9 entspricht: 0-Sonntag, 1-Montag, ... bis 6-Samstag sowie 7 für Wochenende und Feiertage (entspricht $we), 8 für Arbeitstage (entspricht !$we) und 9 für Wochenende oder Feiertag morgen (entspricht intern $twe)

alternativ mit Buchstaben-Kürzeln:

[<time>|So Mo Di Mi Do Fr Sa WE AT MWE] WE entspricht der Ziffer 7, AT der Ziffer 8 und MWE der Ziffer 9

oder entsprechend mit englischen Bezeichnern:

[<time>|Su Mo Tu We Th Fr Sa WE WD TWE]

Mit Hilfe des Attributes weekdays können beliebige Wochentagbezeichnungen definiert werden. Die Syntax lautet:

weekdays <Bezeichnung für Sonntag>,<Bezeichnung für Montag>,...,<Bezeichnung für Wochenende oder Feiertag>,<Bezeichnung für Arbeitstage>,<Bezeichnung für Wochenende oder Feiertag morgen>

Beispiel: di_mydoif attr weekdays Son,Mon,Die,Mit,Don,Fre,Sam,Wochenende,Arbeitstag,WochenendeMorgen

Anwendungsbeispiel: Radio soll am Wochenende und an Feiertagen um 08:30 Uhr eingeschaltet und um 09:30 Uhr ausgeschaltet werden. Am Montag und Mittwoch soll das Radio um 06:30 Uhr eingeschaltet und um 07:30 Uhr ausgeschaltet werden. Hier mit englischen Bezeichnern:

define di_radio DOIF ([06:30|Mon Wochenende] or [08:30|Wochenende]) (set radio on) DOELSEIF ([07:30|Mon Wochenende] or [09:30|Wochenende]) (set radio off)

attr di_radio weekdays Son,Mon,Die,Mit,Don,Fre,Sam,Wochenende,Arbeitstag,WochenendeMorgen

Perl-Modus:

define di_radio DOIF

{if ([06:30|Mo We] or [08:30|WE]) {fhem_set"radio on"}}

{if ([07:30|Mo We] or [09:30|WE]) {fhem_set"radio off"}}

Bemerkung: Es ist unerheblich wie die definierten Wochenttagbezeichner beim Timer angegeben werden. Sie können mit beliebigen Trennzeichen oder ohne Trennzeichen direkt aneinander angegeben werden.

Anstatt einer direkten Wochentagangabe, kann ein Status oder Reading in eckigen Klammern angegeben werden. Dieser muss zum Triggerzeitpunkt mit der gewünschten Angabe für Wochentage, wie oben definiert, belegt sein.

Anwendungsbeispiel: Der Wochentag soll über einen Dummy bestimmt werden.

define dummy myweekday

set myweekday monday wednesday thursday weekend



define di_radio DOIF ([06:30|[myweekday]]) (set radio on) DOELSEIF ([07:30|[myweekday]]) (set radio off)

attr di_radio weekdays sunday,monday,thuesday,wednesday,thursday,friday,saturday,weekend,workdays,weekendtomorrow

Perl-Modus:

define di_radio DOIF

{[06:30|[myweekday]];fhem_set"radio on"}

{[07:30|[myweekday]];fhem_set"radio off"}


attr di_radio weekdays sunday,monday,thuesday,wednesday,thursday,friday,saturday,weekend,workdays,weekendtomorrow

Zeitsteuerung mit Zeitintervallen back

Zeitintervalle werden im Format angegeben: [<begin>-<end>], für <begin> bzw. <end> wird das gleiche Zeitformat verwendet, wie bei einzelnen Zeitangaben. Getriggert wird das Modul zum Zeitpunkt <begin> und zum Zeitpunkt <end>. Soll ein Zeitintervall ohne Zeittrigger lediglich zur Abfrage dienen, so muss hinter der eckigen Klammer ein Fragezeichen angegeben werden (siehe Beispiele weiter unten). Das Zeitintervall ist als logischer Ausdruck ab dem Zeitpunkt <begin> wahr und ab dem Zeitpunkt <end> nicht mehr wahr.

Anwendungsbeispiele:

Radio soll zwischen 8:00 und 10:00 Uhr an sein:

define di_radio DOIF ([08:00-10:00]) (set radio on) DOELSE (set radio off)

Perl-Modus:
define di_radio DOIF {if ([08:00-10:00]) {fhem_set"radio on"} else {fhem_set"radio off"}}

mit mehreren Zeitintervallen:

define di_radio DOIF ([08:00-10:00] or [20:00-22:00]) (set radio on) DOELSE (set radio off)

Perl-Modus:
define di_radio DOIF {if ([08:00-10:00] or [20:00-22:00]) {fhem_set"radio on"} else {fhem_set"radio off"}}

Nur montags, mittwochs und freitags:

define di_radio DOIF ([08:00-10:00|135]) (set radio on) DOELSE (set radio off)

Nur am Wochenende bzw. an Feiertagen lt. holiday-Datei (7 entspricht $we):

define di_radio DOIF ([08:00-10:00|7]) (set radio on) DOELSE (set radio off)

Zeitintervalle über Mitternacht:

define di_light DOIF ([22:00-07:00]) (set light on) DOELSE (set light off)

in Verbindung mit Wochentagen (einschalten am Freitag ausschalten am Folgetag):

define di_light DOIF ([22:00-07:00|5]) (set light on) DOELSE (set light off)

Zeitintervalle über mehrere Tage müssen als Zeitpunkte angegeben werden.

Einschalten am Freitag ausschalten am Montag:

define di_light DOIF ([22:00|5]) (set light on) DOELSEIF ([10:00|1]) (set light off)

Perl-Modus:

define di_light DOIF

{[22:00|5];fhem_set"light on"}

{[10:00|1];fhem_set"light off"}

Schalten mit Zeitfunktionen, hier: bei Sonnenaufgang und Sonnenuntergang:

define di_light DOIF ([{sunrise(900,"06:00","08:00")}]) (set outdoorlight off) DOELSEIF ([{sunset(900,"17:00","21:00")}]) (set outdoorlight on)

Perl-Modus:

define di_light DOIF

{[{sunrise(900,"06:00","08:00")}];fhem_set"outdoorlight off"}

{[{sunset(900,"17:00","21:00")}];fhem_set"outdoorlight on"}

Indirekten Zeitangaben back

Oft möchte man keine festen Zeiten im Modul angeben, sondern Zeiten, die man z. B. über Dummys über die Weboberfläche verändern kann. Statt fester Zeitangaben können Status, Readings oder Internals angegeben werden. Diese müssen eine Zeitangabe im Format HH:MM oder HH:MM:SS oder eine Zahl beinhalten.

Anwendungsbeispiel: Lampe soll zu einer bestimmten Zeit eingeschaltet werden. Die Zeit soll über den Dummy time einstellbar sein:

define time dummy

set time 08:00



define di_time DOIF ([[time]])(set lamp on)

attr di_time do always

Perl-Modus:
define di_time DOIF {[[time]];fhem_set"lamp on"}

Die indirekte Angabe kann ebenfalls mit einer Zeitfunktion belegt werden. Z. B.

set time {sunset()}

Das Dummy kann auch mit einer Sekundenzahl belegt werden, oder als relative Zeit angegeben werden, hier z. B. schalten alle 300 Sekunden:

define time dummy

set time 300



define di_time DOIF ([+[time]])(save)

attr di_time do always

Perl-Modus:
define di_time DOIF {[+[time]];fhem"save"}

Ebenfalls funktionieren indirekte Zeitangaben mit Zeitintervallen. Hier wird die Ein- und Ausschaltzeit jeweils über einen Dummy bestimmt:

define begin dummy

set begin 08:00



define end dummy

set end 10:00



define di_time DOIF ([[begin]-[end]]) (set radio on) DOELSE (set radio off)

Perl-Modus:
define di_time DOIF {if([[begin]-[end]]) {fhem_set"radio on"} else {fhem_set"radio off"}}

Indirekte Zeitangaben können auch als Übergabeparameter für Zeitfunktionen, wie z. B. sunset oder sunrise übergeben werden:

define di_time DOIF ([{sunrise(0,"[begin]","09:00")}-{sunset(0,"18:00","[end]")}]) (set lamp off) DOELSE (set lamp on)

Bei einer Änderung des angegebenen Status oder Readings wird die geänderte Zeit sofort im Modul aktualisiert.

Angabe eines Readings als Zeitangabe. Beispiel: Schalten anhand eines Twilight-Readings:

define di_time DOIF ([[myTwilight:ss_weather]])(set lamp on)
attr di_timer do always

Perl-Modus:
define di_time DOIF {[[myTwilight:ss_weather]];fhem_set"lamp on"}

Indirekte Zeitangaben lassen sich mit Wochentagangaben kombinieren, z. B.:

define di_time DOIF ([[begin]-[end]|7]) (set radio on) DOELSE (set radio off)

Perl-Modus:
define di_time DOIF {if ([[begin]-[end]|7]) {fhem_set"radio on"} else {fhem_set"radio off"}}

Zeitsteuerung mit Zeitberechnung back

Zeitberechnungen werden innerhalb der eckigen Klammern zusätzlich in runde Klammern gesetzt. Die berechneten Triggerzeiten können absolut oder relativ mit einem Pluszeichen vor den runden Klammern angegeben werden. Es können beliebige Ausdrücke der Form HH:MM und Angaben in Sekunden als ganze Zahl in Perl-Rechenoperationen kombiniert werden. Perlfunktionen, wie z. B. sunset(), die eine Zeitangabe in HH:MM liefern, werden in geschweifte Klammern gesetzt. Zeiten im Format HH:MM bzw. Status oder Readings, die Zeitangaben in dieser Form beinhalten werden in eckige Klammern gesetzt.

Anwendungsbeispiele:

Lampe wird nach Sonnenuntergang zwischen 900 und 1500 (900+600) Sekunden zufällig zeitverzögert eingeschaltet. Ausgeschaltet wird die Lampe nach 23:00 Uhr um bis zu 600 Sekunden zufällig verzögert:

define di_light DOIF ([({sunset()}+900+int(rand(600)))])

   (set lamp on)
DOELSEIF ([([23:00]+int(rand(600)))])

   (set lamp off)

Perl-Modus:

define di_light DOIF

{[({sunset()}+900+int(rand(600)))];fhem_set"lamp on"}

{[([23:00]+int(rand(600)))];;fhem_set"lamp off"}

Zeitberechnung können ebenfalls in Zeitintervallen genutzt werden.

Licht soll eine Stunde vor gegebener Zeit eingeschaltet werden und eine Stunde danach wieder ausgehen:

define Fixtime dummy

set Fixtime 20:00



define di_light DOIF ([([Fixtime]-[01:00]) - ([Fixtime]+[01:00])])

 (set lampe on)
DOELSE

 (set lampe off)

Hier das Gleiche wie oben, zusätzlich mit Zufallsverzögerung von 300 Sekunden und nur an Wochenenden:

define di_light DOIF ([([Fixtime]-[01:00]-int(rand(300))) - ([Fixtime]+[01:00]+int(rand(300)))]|7])

 (set lampe on)
DOELSE

 (set lampe off)

Ein Änderung des Dummys Fixtime z. B. durch "set Fixtime ...", führt zur sofortiger Neuberechnung der Timer im DOIF-Modul.

Für die Zeitberechnung wird der Perlinterpreter benutzt, daher sind für die Berechnung der Zeit keine Grenzen gesetzt.

Intervall-Timer back

Syntax:

[<begin>-<end>,<relative timer>]

Innerhalb des definierten Zeitintervalls, triggert der definierte Timer. Außerhalb des Zeitintervall wird kein Timer gesetzt.

Anwendungsbeispiel: Zwischen 08:00 und 22:00 Uhr soll eine Pumpe jede halbe Stunde für fünf Minuten eingeschaltet werden:

define di_pump DOIF ([08:00-22:00,+:30])(set pump on-for-timer 300)

attr di_pump do always

Perl-Modus:
define di_pump DOIF {[08:00-22:00,+:30];fhem_set"pump on-for-timer 300"}

Es wird um 08:00, 08:30, 09:00, ..., 21:30 Uhr die Anweisung ausgeführt. Um 22:00 wird das letzte Mal getriggert, das Zeitintervall ist zu diesem Zeitpunkt nicht mehr wahr.

Es lassen sich ebenso indirekte Timer, Timer-Funktionen, Zeitberechnungen sowie Wochentage miteinander kombinieren.

define di_rand_lamp DOIF ([{sunset()}-[end:state],+(rand(600)+900)|Sa So])(set lamp on-for-timer 300)

attr di_rand_lamp do always

Perl-Modus:
define di_rand_lamp DOIF {[{sunset()}-[end:state],+(rand(600)+900)|Sa So];fhem_set"lamp on-for-timer 300"}

Kombination von Ereignis- und Zeitsteuerung mit logischen Abfragen back

Anwendungsbeispiel: Lampe soll ab 6:00 Uhr angehen, wenn es dunkel ist und wieder ausgehen, wenn es hell wird, spätestens aber um 9:00 Uhr:

define di_lamp DOIF ([06:00-09:00] and [sensor:brightness] < 40) (set lamp on) DOELSE (set lamp off)

Anwendungsbeispiel: Rollläden sollen an Arbeitstagen nach 6:25 Uhr hochfahren, wenn es hell wird, am Wochenende erst um 9:00 Uhr, herunter sollen sie wieder, wenn es dunkel wird:

define di_shutters DOIF ([sensor:brightness]>100 and [06:25-09:00|8] or [09:00|7]) (set shutters up) DOELSEIF ([sensor:brightness]<50) (set shutters down)

Zeitintervalle, Readings und Status ohne Trigger back

Angaben in eckigen Klammern, die mit einem Fragezeichen beginnen, führen zu keiner Triggerung des Moduls, sie dienen lediglich der Abfrage.

Anwendungsbeispiel: Licht soll zwischen 06:00 und 10:00 angehen, getriggert wird nur durch den Taster nicht um 06:00 bzw. 10:00 Uhr und nicht durch das Device Home

define di_motion DOIF ([?06:00-10:00] and [button] and [?Home] eq "present")(set lamp on-for-timer 600)

attr di_motion do always

Perl-Modus:
define di_motion DOIF {if ([?06:00-10:00] and [button] and [?Home] eq "present"){fhem_set"lamp on-for-timer 600"}}

Nutzung von Readings, Status oder Internals im Ausführungsteil back

Anwendungsbeispiel: Wenn ein Taster betätigt wird, soll Lampe1 mit dem aktuellen Zustand der Lampe2 geschaltet werden:

define di_button DOIF ([button]) (set lamp1 [lamp2])

attr di_button do always

Anwendungsbeispiel: Benachrichtigung beim Auslösen eines Alarms durch Öffnen eines Fensters:

define di_pushmsg DOIF ([window] eq "open" and [alarm] eq "armed") (set Pushover msg 'alarm' 'open windows [window:LastDevice]' '' 2 'persistent' 30 3600)

Berechnungen im Ausführungsteil back

Berechnungen können in geschweiften Klammern erfolgen. Aus Kompatibilitätsgründen, muss die Berechnung unmittelbar mit einer runden Klammer beginnen. Innerhalb der Perlberechnung können Readings, Status oder Internals wie gewohnt in eckigen Klammern angegeben werden.

Anwendungsbeispiel: Es soll ein Vorgabewert aus zwei verschiedenen Readings ermittelt werden und an das set Kommando übergeben werden:

define di_average DOIF ([08:00]) (set TH_Modul desired {([default:temperature]+[outdoor:temperature])/2})

attr di_average do always

Ersatzwert für nicht existierende Readings oder Status back

Es kommt immer wieder vor, dass in der Definition des DOIF-Moduls angegebene Readings oder Status zur Laufzeit nicht existieren. Der Wert ist dann leer. Bei der Definition von Status oder Readings kann für diesen Fall ein Vorgabewert oder sogar eine Perlberechnung am Ende des Ausdrucks kommagetrennt angegeben werden.

Syntax:

[<device>,<default value>]
oder
[<device>:<reading>,<default value>]

Beispiele:


[lamp,"off"]

[room:temperatur,20]

[brightness,3*[myvalue]+2]

[heating,AttrVal("mydevice","myattr","")]

[[mytime,"10:00"]]

Möchte man stattdessen einen bestimmten Wert global für das gesamte Modul definieren, so lässt sich das über das Attribut notexist bewerkstelligen. Ein angegebener Default-Wert beim Status oder beim Reading übersteuert das "notexist"-Attribut.

Syntax: attr <DOIF-module> notexist "<default value>"

Verzögerungen back

Verzögerungen für die Ausführung von Kommandos werden pro Befehlsfolge über das Attribut "wait" definiert. Syntax:

attr <DOIF-module> wait <Sekunden für Befehlsfolge des ersten DO-Falls>:<Sekunden für Befehlsfolge des zweiten DO-Falls>:...

Sollen Verzögerungen innerhalb von Befehlsfolgen stattfinden, so müssen diese Kommandos in eigene Klammern gesetzt werden, das Modul arbeitet dann mit Zwischenzuständen.

Beispiel: Bei einer Befehlssequenz, hier: (set lamp1 on, set lamp2 on), soll vor dem Schalten von lamp2 eine Verzögerung von einer Sekunde stattfinden. Die Befehlsfolge muss zunächst mit Hilfe von Klammerblöcke in eine Befehlssequenz aufgespalten werden: (set lamp1 on)(set lamp2 on). Nun kann mit dem wait-Attribut nicht nur für den Beginn der Sequenz, sondern für jeden Klammerblock eine Verzögerung, getrennt mit Komma, definieren werden, hier also: wait 0,1. Damit wird lamp1 sofort, lamp2 eine Sekunde danach geschaltet. Die Verzögerungszeit bezieht sich immer auf den vorherigen Befehl.

Beispieldefinition bei mehreren DO-Blöcken mit Befehlssequenzen:

DOIF (Bedingung1)

(set ...) ## erster Befehl der ersten Sequenz soll um eine Sekunde verzögert werden

(set ...) ## zweiter Befehl der ersten Sequenz soll um 2 Sekunden nach dem ersten Befehl verzögert werden

DOELSEIF (Bedingung2)

(set ...) ## erster Befehl der zweiten Sequenz soll um 3 Sekunden verzögert werden

(set ...) ## zweiter Befehl der zweiten Sequenz soll um 0,5 Sekunden nach dem ersten Befehl verzögert werden



attr <DOIF-module> wait 1,2:3,0.5

Das Aufspalten einer kommagetrennten Befehlskette in eine Befehlssequenz, wie im obigen Beispiel, sollte nicht vorgenommen werden, wenn keine Verzögerungen zwischen den Befehlen benötigt werden. Denn bei einer Befehlssequenz werden Zwischenzustände cmd1_1, cmd1_2 usw. generiert, die Events erzeugen und damit unnötig FHEM-Zeit kosten.

Für Kommandos, die nicht verzögert werden sollen, werden Sekundenangaben ausgelassen oder auf Null gesetzt. Die Verzögerungen werden nur auf Events angewandt und nicht auf Zeitsteuerung. Eine bereits ausgelöste Verzögerung wird zurückgesetzt, wenn während der Wartezeit ein Kommando eines anderen DO-Falls, ausgelöst durch ein neues Ereignis, ausgeführt werden soll.

Statt Sekundenangaben können ebenfalls Status, Readings in eckigen Klammern, Perl-Funktionen sowie Perl-Berechnung angegeben werden. Dabei werden die Trennzeichen Komma und Doppelpunkt in Klammern geschützt und gelten dort nicht als Trennzeichen. Diese Angaben können ebenfalls bei folgenden Attributen gemacht werden: cmdpause, repeatcmd, repeatsame, waitsame, waitdel

Beispiel:

attr my_doif wait 1:[mydummy:state]*3:rand(600)+100,Attr("mydevice","myattr","")

Verzögerungen von Timern back

Verzögerungen können mit Hilfe des Attributs timerWithWait auf Timer ausgeweitet werden.

Anwendungsbeispiel: Lampe soll zufällig nach Sonnenuntergang verzögert werden.

define di_rand_sunset DOIF ([{sunset()}])(set lamp on)

attr di_rand_sunset wait rand(1200)

attr di_rand_sunset timerWithWait 1

attr di_rand_sunset do always

Anwendungsbeispiel: Benachrichtigung "Waschmaschine fertig", wenn Verbrauch mindestens 5 Minuten unter 2 Watt (Perl-Code wird in geschweifte Klammern gesetzt):

define di_washer DOIF ([power:watt]<2) ({system("wmail washer finished")})

attr di_washer wait 300

Eine erneute Benachrichtigung wird erst wieder ausgelöst, wenn zwischendurch der Verbrauch über 2 Watt angestiegen war.

Anwendungsbeispiel: Rollladen um 20 Minuten zeitverzögert bei Sonne runter- bzw. hochfahren (wenn der Zustand der Sonne wechselt, wird die Verzögerungszeit zurückgesetzt):

define di_shutters DOIF ([Sun] eq "on") (set shutters down) DOELSE (set shutters up) 

attr di_shutters wait 1200:1200

Anwendungsbeispiel: Beschattungssteuerung abhängig von der Temperatur. Der Rollladen soll runter von 11:00 Uhr bis Sonnenuntergang, wenn die Temperatur über 26 Grad ist. Temperaturschwankungen um 26 Grad werden mit Hilfe des wait-Attributes durch eine 15 minutige Verzögerung ausgeglichen.

define di_shutters DOIF ([sensor:temperature] > 26 and [11:00-{sunset_abs()}] (set shutters down) DOELSE (set shutters up)

attr di_shutters wait 900:900

Anwendungsbeispiel: Belüftung in Kombination mit einem Lichtschalter mit Nachlaufsteuerung. Der Lüfter soll angehen, wenn das Licht mindestens 2 Minuten lang brennt oder die Luftfeuchtigkeit 65 % überschreitet, der Lüfter soll ausgehen, drei Minuten nachdem die Luftfeuchtigkeit unter 60 % fällt und das Licht aus ist bzw. das Licht ausgeht und die Luftfeuchtigkeit unter 60% ist. Definitionen lassen sich über die Weboberfläche (DEF-Eingabebereich) übersichtlich gestalten:

define di_fan DOIF ([light] eq "on")

   
  (set fan on)

  
DOELSEIF ([sensor:humidity]>65)

  
  (set fan on)

  
DOELSEIF ([light] eq "off" and [sensor:humidity]<60)
  
  (set fan off)

  


attr di_fan wait 120:0:180

Zurücksetzen des Waittimers für das gleiche Kommando back

Im Gegensatz zu do always wird ein Waittimer mit dem Attribut do resetwait auch dann zurückgesetzt, wenn die gleiche Bedingung wiederholt wahr wird.
Damit können Ereignisse ausgelöst werden, wenn etwas innerhalb einer Zeitspanne nicht passiert.
Das Attribut do resetwait impliziert eine beliebige Wiederholung wie do always. Diese lässt sich allerdings mit dem Attribut repeatsame einschränken s. u.

Anwendungsbeispiel: Meldung beim Ausbleiben eines Events

define di_push DOIF ([Tempsensor])(set pushmsg "sensor failed again")

attr di_push wait 1800

attr di_push do resetwait

Wiederholung von Befehlsausführung back

Wiederholungen der Ausführung von Kommandos werden pro Befehlsfolge über das Attribut "repeatcmd" definiert. Syntax:

attr <DOIF-modul> repeatcmd <Sekunden für Befehlsfolge des ersten DO-Falls>:<Sekunden für Befehlsfolge des zweiten DO-Falls>:...

Statt Sekundenangaben können ebenfalls Status in eckigen Klammen oder Perlbefehle angegeben werden.

Die Wiederholung findet so lange statt, bis der Zustand des Moduls in einen anderen DO-Fall wechselt.

Anwendungsbeispiel: Nach dem Eintreffen des Ereignisses wird die push-Meldung stündlich wiederholt, bis Frost ungleich "on" ist.

define di_push DOIF ([frost] eq "on")(set pushmsg "danger of frost")

attr di_push repeatcmd 3600

Eine Begrenzung der Wiederholungen kann mit dem Attribut repeatsame vorgenommen werden
attr di_push repeatsame 3

Ebenso lässt sich das repeatcmd-Attribut mit Zeitangaben kombinieren.

Anwendungsbeispiel: Wiederholung ab einem Zeitpunkt

define di_alarm_clock DOIF ([08:00])(set alarm_clock on)

attr di_alarm_clock repeatcmd 300

attr di_alarm_clock repeatsame 3

attr di_alarm_clock do always

Ab 8:00 Uhr wird 3 mal der Weckton jeweils nach 5 Minuten wiederholt.

Anwendungsbeispiel: Warmwasserzirkulation

define di_pump_circ DOIF ([05:00-22:00])(set pump on)(set pump off) DOELSE (set pump off)

attr di_pump_circ wait 0,300

attr di_pump_circ repeatcmd 3600

Zwischen 5:00 und 22:00 Uhr läuft die Zirkulationspumpe alle 60 Minuten jeweils 5 Minuten lang.

Anwendungsbeispiel: Anwesenheitssimulation

define di_presence_simulation DOIF ([19:00-00:00])(set lamp on-for-timer {(int(rand(1800)+300))}) DOELSE (set lamp off)

attr di_presence_simulation repeatcmd rand(3600)+2200

Zwangspause für das Ausführen eines Kommandos seit der letzten Zustandsänderung back

Mit dem Attribut cmdpause <Sekunden für cmd_1>:<Sekunden für cmd_2>:... wird die Zeitspanne in Sekunden angegeben für eine Zwangspause seit der letzten Zustandsänderung. In der angegebenen Zeitspanne wird ein Kommando nicht ausgeführt, auch wenn die dazugehörige Bedingung wahr wird.

Anwendungsbeispiel: Meldung über Frostgefahr alle 60 Minuten

define di_frost DOIF ([outdoor:temperature] < 0) (set pushmsg "danger of frost")

attr di_frost cmdpause 3600

attr di_frost do always

Begrenzung von Wiederholungen eines Kommandos back

Mit dem Attribut repeatsame <maximale Anzahl von cmd_1>:<maximale Anzahl von cmd_2>:... wird die maximale Anzahl hintereinander folgenden Ausführungen festgelegt.

Anwendungsbeispiel: Die Meldung soll maximal dreimal erfolgen mit einer Pause von mindestens 10 Minuten

define di_washer DOIF ([Watt]<2) (set pushmeldung "washer finished")

attr di_washer repeatsame 3

attr di_washer cmdpause 600

Das Attribut repeatsame lässt sich mit do always oder do resetwait kombinieren. Wenn die maximale Anzahl für ein Kommando ausgelassen oder auf Null gesetzt wird, so gilt für dieses Kommando der Defaultwert "einmalige Wiederholung"; in Kombination mit do always bzw. do resetwait gilt für dieses Kommando "beliebige Wiederholung".

Anwendungsbeispiel: cmd_1 soll beliebig oft wiederholt werden, cmd_2 maximal zweimal

attr di_repeat repeatsame 0:2

attr di_repeat do always

Ausführung eines Kommandos nach einer Wiederholung einer Bedingung back

Mit dem Attribut waitsame <Zeitspanne in Sekunden für cmd_1>:<Zeitspanne in Sekunden für das cmd_2>:... wird ein Kommando erst dann ausgeführt, wenn innerhalb einer definierten Zeitspanne die entsprechende Bedingung zweimal hintereinander wahr wird.
Für Kommandos, für die waitsame nicht gelten soll, werden die entsprechenden Sekundenangaben ausgelassen oder auf Null gesetzt.

Anwendungsbeispiel: Rollladen soll hoch, wenn innerhalb einer Zeitspanne von 2 Sekunden ein Taster betätigt wird

define di_shuttersup DOIF ([Button])(set shutters up)

attr di_shuttersup waitsame 2

attr di_shuttersup do always

Löschen des Waittimers nach einer Wiederholung einer Bedingung back

Das Gegenstück zum repeatsame-Attribut ist das Attribut waitdel. Die Syntax mit Sekundenangaben pro Kommando entspricht der, des wait-Attributs. Im Gegensatz zum wait-Attribut, wird ein laufender Timer gelöscht, falls eine Bedingung wiederholt wahr wird. Sekundenangaben können pro Kommando ausgelassen oder auf Null gesetzt werden.

Anwendungsbeispiel: Rollladen soll herunter, wenn ein Taster innerhalb von zwei Sekunden nicht wiederholt wird

define di_shuttersdown DOIF ([Button])(set shutters down)

attr di_shuttersdown waitdel 2

attr di_shuttersdown do always

"di_shuttersdown" kann nicht mit dem vorherigen Anwendungsbeispiel "di_shuttersup" innerhalb eines DOIF-Moduls kombiniert werden, da in beiden Fällen die gleiche Bedingung vorkommt.
siehe auch Einknopf-Fernbedienung im Perl-Modus

Die Attribute wait und waitdel lassen sich für verschiedene Kommandos kombinieren. Falls das Attribut für ein Kommando nicht gesetzt werden soll, kann die entsprechende Sekundenzahl ausgelassen oder eine Null angegeben werden.

Beispiel: Für cmd_1 soll wait gelten, für cmd_2 waitdel

attr di_cmd wait 2:0

attr di_cmd waitdel 0:2

Readingauswertung bei jedem Event des Devices back

Bei Angaben der Art [<Device>:<Reading>] wird das Modul getriggert, wenn ein Ereignis zum angegebenen Device und Reading kommt. Soll das Modul, wie bei Statusangaben der Art [<Device>], auf alle Ereignisse des Devices reagieren, so muss das Attribut auf Null gesetzt werden.

Bemerkung: In früheren Versionen des Moduls war checkReadingEvent 0 die Voreinstellung des Moduls. Da die aktuelle Voreinstellung des Moduls checkReadingEvent 1 ist, hat das Setzen von checkReadingEvent 1 keine weitere Funktion mehr.

Eindeutige Statuserkennung back

Bei Änderungen des Readings state wird in FHEM standardmäßig, im Gegensatz zu allen anderen Readings, der Readingname hier: "state: " im Event nicht vorangestellt. Möchte man eindeutig eine Statusänderung eines Moduls erkennen, so lässt sich das mit dem Attribut addStateEvent bewerksteligen. Bei Statusänderungen eines Devices wird bei der Angabe des Attributes addStateEvent im Event "state: " vorangestellt, darauf kann man dann gezielt im DOIF-Modul triggern.

Beispiel:

define di_lamp ([FB:"^state: on$"]) (set lamp on)

attr di_lamp do always

attr di_lamp addStateEvent

Triggerung durch selbst ausgelöste Events back

Standardmäßig unterbindet das DOIF-Modul Selbsttriggerung. D. h. das Modul reagiert nicht auf Events, die es selbst direkt oder indirekt auslöst. Dadurch werden Endlosschleifen verhindert. Wenn das Attribut selftrigger wait gesetzt ist, kann das DOIF-Modul auf selbst ausgelöste Events reagieren. Dazu müssen die entsprchenden Kommandos mit wait verzögert werden. Bei der Angabe selftrigger all reagiert das Modul grundsätzlich alle selbst ausgelösten Trigger.

Zu beachten ist, dass der Zustand des Moduls erst nach der Ausführung des Befehls gesetzt wird, dadurch wird die Zustandsverwaltung (ohne do always) ausgehebelt. Die Auswertung des eigenen Zustands z. B. über [$SELF:cmd] funktioniert dagegen korrekt, weil dieser immer bei der eigenen Triggerung bereits gesetzt ist. Bei der Verwendung des Attributes selftrigger all sollte beachtet werden, dass bereits in der zweiten Rekursion, wenn ein Befehl nicht durch wait verzögert wird, FHEM eine weitere Triggerung unterbindet, um Endlosschleifen zu verhindern.

Setzen der Timer mit Event back

Wenn das Attribut timerevent ungleich Null gesetzt ist, wird beim Setzen der Timer im DOIF-Modul ein Event erzeugt. Das kann z. B. bei FHEM2FHEM nützlich sein, um die Timer-Readings zeitnah zu aktualisieren.

Zeitspanne eines Readings seit der letzten Änderung back

Bei Readingangaben kann die Zeitspanne mit [<Device>:<Reading>:sec] in Sekunden seit der letzten Änderung bestimmt werden.

Anwendungsbeispiel: Licht soll angehen, wenn der Status des Bewegungsmelders in den letzten fünf Sekunden upgedatet wurde.

define di_lamp DOIF ([BM:state:sec] < 5) (set lamp on-for-timer 300)

attr di_lamp do always

Bei HM-Bewegungsmelder werden periodisch Readings aktualisiert, dadurch wird das Modul getrigger, auch wenn keine Bewegung stattgefunden hat. Der Status bleibt dabei auf "motion". Mit der obigen Abfrage lässt sich feststellen, ob der Status aufgrund einer Bewegung tatsächlich upgedatet wurde.

Alle Bedingungen prüfen back

Bei der Abarbeitung der Bedingungen, werden nur die Bedingungen überprüft, die zum ausgelösten Event das dazughörige Device bzw. die dazugehörige Triggerzeit beinhalten. Mit dem Attribut checkall lässt sich das Verhalten so verändern, dass bei einem Event-Trigger auch Bedingungen geprüft werden, die das triggernde Device nicht beinhalten. Folgende Parameter können angegeben werden:

checkall event Es werden alle Bedingungen geprüft, wenn ein Event-Trigger auslöst.
checkall timer Es werden alle Bedingungen geprüft, wenn ein Timer-Trigger auslöst.
checkall all Es werden grundsätzlich alle Bedingungen geprüft.

Zu beachten ist, dass bei einer wahren Bedingung die dazugehörigen Befehle ausgeführt werden und die Abarbeitung immer beendet wird - es wird also grundsätzlich immer nur ein Befehlszweig ausgeführt und niemals mehrere.

Darstellungselement mit Eingabemöglichkeit im Frontend und Schaltfunktion back

Die unter Dummy beschriebenen Attribute readingList und setList stehen auch im DOIF zur Verfügung. Damit wird erreicht, dass DOIF im WEB-Frontend als Eingabeelement mit Schaltfunktion dienen kann. Zusätzliche Dummys sind nicht mehr erforderlich. Es können im Attribut setList, die in FHEMWEB angegebenen Modifier des Attributs widgetOverride verwendet werden.

Anwendungsbeispiel: Eine Schaltuhr mit time-Widget für die Ein- u. Ausschaltzeiten und der Möglichkeit über eine Auswahlliste manuell ein und aus zu schalten.


define time_switch DOIF (["$SELF:mybutton: on"] or [[$SELF:mybegin,"00:00"]])
(set lamp on)
DOELSEIF (["$SELF:mybutton: off"] or [[$SELF:myend,"00:00"]])
(set lamp off)


attr time_switch cmdState on|off

attr time_switch readingList mybutton mybegin myend

attr time_switch setList mybutton:on,off mybegin:time myend:time

attr time_switch webCmd mybutton:mybegin:myend

Anwendungsbeispiel: Ausführung von Befehlen abhängig einer Auswahl ohne Zusatzreading

define di_web DOIF ([$SELF:"myInput first"]) (do something) DOELSEIF ([$SELF:"myInput second"]) (do something else)



attr di_web setList myInput:first,second

Links
readingList
setList
webCmd
webCmdLabel
widgetOverride
weiterführendes Beispiel für Tablet-UI
benutzerdefinierte Readings
Bedingungsloses Ausführen von Befehlen

uiTable, das User Interface back

Mit dem Attribut uiTable kann innerhalb eines DOIF-Moduls ein User Interface in Form einer Tabelle erstellt werden. Die Definition der Tabelle wird mit Hilfe von Perl sowie FHEM-Widgets kombiniert mit DOIF-Syntax vorgenommen.

Features:

- pro DOIF eine beliebige UI-Tabelle definierbar
- alle FHEM-Widgets nutzbar
- alle FHEM-Icons nutzbar
- DOIF-Syntax verwendbar
- alle Devices und Readings in FHEM direkt darstellbar und ansprechbar
- dynamische Styles (z. B. Temperaturfarbe abhängig vom Temperaturwert)
- es brauchen keine eigenen CSS- oder js-Dateien definiert werden
- Nutzung vordefinierter Templates aus Template-Dateien

Aufbau des uiTable-Attributs

{

 <Perlblock für Definition von Template-Attributen, Zellenformatierungen, eigenen Perlfunktionen>

}



<Template-Methoden>



<Tabellendefinition>

Der Perlblock ist optional. Er wird in geschweiften Klammern mit wenigen Ausnahmen in Perl definiert. Hier können Template-Attribute für Zeichenketten, das Layout der Tabelle über HMTL-Zellenformatierungen sowie eigene Perlfunktionen definiert werden. Im Anschluß an den Perlblock können optional Template-Methoden definiert werden, um komplexere wiederverwendbare Widget-Definitionen zu formulieren. Diese werden in der Tabellendefinition benutzt. Die eigentliche Tabellendefinition wird über die Definition von Zellen vorgenommen. Zellen werden mit | voneinander abgegrenzt. Kommentare können an beliebiger Stelle beginnend mit ## bis zum Zeilenende eingefügt werden.

Die Tabellendefinition


<Zellendefinition erste Zeile erste Spalte>  | <Zellendefinition erste Zeile zweite Spalte  | ... # Definition der ersten Tabellenzeile

<Zellendefinition zweite Zeile erste Spalte> | <Zellendefinition zweite Zeile zweite Spalte | ... # Definition der zweiten Tabellenzeile

usw.

Endet eine Zeile mit |, so wird deren Definition in der nächsten Zeile fortgesetzt. Dadurch können längere Zeilendefinition einer Tabelle auf mehrerer Zeilen aufgeteilt werden.

Eine Zellendefinition kann sein:

1)

<Perlausdruck mit [DOIF-Syntax]>

STY(<Perlausdruck mit [DOIF-Syntax]>,<css-Style-Definition mit [DOIF-Syntax]>)

WID([<DEVICE>:<READING>],<FHEM-Widget-Definition mit [DOIF-Syntax]>,"<set-/setreading-Kommando optional>")

Die oberen Definitionen können innerhalb einer Zelle mit Punkt bzw. Komma beliebig kombiniert werden. Beim Punkt werden die Ausdrücke aneinandergereiht, bei Komma werden die Ausdrücke mit Zeilenumbruch untereinander innerhalb einer Zelle angeordnet.

Zu 1)

Diese Definition wird verwendet für: Texte, Inhalte von Readings oder Rechenausdrücke. Angaben, die die Zelle aktualisieren sollen, müssen in gewohnte DOIF-Syntax angegeben werden.
Beispiele:

Einfacher Text:

"Status"

Reading:

[outdoor:temperature]

Berechnung:

([livingroom:temperature]+[kitchen:temperature])/2

Perlfunktion:

min([livingroom:temperature],[ktichen:temperature])

Mehrere Angaben einer Zelle können mit einem Punkt, wie auch in Perl bei Zeichenketten üblich, konkateniert werden:

"Temperature: ".[outdoor:temperatur]

"Die maximale Temperatur der Kinderzimmer beträgt: ".max([child1:temperature],[child2:temperature])

Zu 2)

Über die Funktion STY werden Angaben mit Formatierungen über das CSS-Style-Attribut vorgenommen.

Beispiele:

Formatierter Text:

STY("diningroom","font-weight:bold;font-size:16pt;color:#0000FF")

Formatiertes Reading:

STY([fridge:temperature],"color:#0000FF")

Formatiertes Reading mit dynamischer Farbgebung abhängig von der Temperatur

STY([basement:humidity],"color:".DOIF_hsv([basement:humidity],50,75,40,264,60,90))

DOIF_hsv ist eine DOIF-Funktion, bei der man den Farbverlauf definieren kann.

Syntax für die DOIF_hsv Funktion:

DOIF_hsv(<value>,<min_value>,<max_value>,<min_hsv>,<max_hsv>,<saturation>,<lightness>)

Es wird durch eine feste Vorgabe von saturation und lightness, linear ein Farbton (Hue) für value errechnet, dabei entspricht min_value min_hsv und max_value max_hsv.

Die gewünschten Werte für <min_hsv>,<max_hsv>,<saturation>,<lightness> können mit Hilfe eines Color-Pickers bestimmt werden.

Weiterhin lässt sich ebenfalls jede andere Perlfunktion verwenden, die eine beliebige css-Style-Formatierung vornimmt.

Zu 3)

Über die Funktion WID werden FHEM-Widgets definiert. Es können alle in FHEM vorhanden FHEM-Widgets verwendet werden.

Beispiele:

Brennericon

WID([burner:state],"iconLabel,closed,sani_boiler_temp\@DarkOrange,open,sani_boiler_temp")

Die Widget-Definition entspricht der Syntax der FHEM-Widgets.

Thermostatdefinition mit Hilfe des knob-Widgets:

WID([TH_Bathroom_HM:desired-temp],"knob,min:17,max:25,width:45,height:40,step:0.5,fgColor:DarkOrange,bgcolor:grey,anglearc:270,angleOffset:225,cursor:10,thickness:.3","set")

Der Perlblock: Definition von Template-Attributen, Zellenformatierungen und Perl-Funktionen

Im ersten Bereich werden sog. Template-Attribute als Variablen definiert, um wiederholende Zeichenketten in Kurzform anzugeben. Template-Attribute werden intern als hash-Variablen abgelegt. Die Syntax entspricht weitgehend der Perl-Syntax.

Die Syntax lautet:

$TPL{<name>}=<Perlsyntax für Zeichenketten>

<name> ist beliebig wählbar.

Bsp.

$TPL{HKnob}="knob,min:17,max:25,width:45,height:40,step:0.5,fgColor:DarkOrange,bgcolor:grey,anglearc:270,angleOffset:225,cursor:10,thickness:.3";

Damit würde die obige Beispiel-Definition des Thermostat-Widgets wie folgt aussehen:

WID([TH_Bad_HM:desired-temp],$TPL{HKnob},"set")

Weiterhin können die Tabelle, einzelne Zellen-, Zeilen- oder Spaltenformatierungen definiert werden, dazu werden folgende Bezeichner benutzt:

$TABLE="<CSS-Attribute>"

$TD{<Zellenbereich für Zeilen>}{<Zellenbereich für Spalten>}="<CSS-Attribute der Zellen>"

$TC{<Zellenbereich für Spalten>}="<CSS-Attribute der Spalten>"

$TR{Zeilenbereich}="<CSS-Attribute der Zeilen>"

mit

<Zellen/Spalten/Zeilen-Bereich>: Zahl|kommagetrennte Aufzählung|Bereich von..bis

Beispiele:


$TABLE = "width:300px; height:300px; background-image:url(/fhem/www/pgm2/images/Grundriss.png); background-size: 300px 300px;";

$TD{0}{0} = "style='border-right-style:solid; border-right-width:10px'";

$TR{0} = "class='odd' style='font-weight:bold'";

$TC{1..5} = "align='center'";

$TC{1,3,5} = "align='center'";

$TC{last} = "style='font-weight:bold'";

Es können ebenfalls beliebige Perl-Funktionen definiert werden, die innerhalb der Tabellendefinition genutzt werden können. Sie sollten mit FUNC_ beginnen. Damit wird sichergestellt, dass die Funktionen systemweit eindeutig sind.

Bsp.

Funktion für temperaturabhängige Farbgebung


sub FUNC_temp

 {

  my ($temp)=@_

    return ("font-weight:bold;font-size:12pt;color:".DOIF_hsv ($temp,15,35,210,360,60,90));

 }

Steuerungsattribute

Ausblenden des Status in der Devicezeile:

$SHOWNOSTATE=1;

Standardmäßig werden Texte innerhalb der Tabelle, die einem vorhandenen FHEM-Device entsprechen als Link zur Details-Ansicht dargestellt. Soll diese Funktionalität unterbunden werden, so kann man dies über folgendes Attribut unterbinden:

$SHOWNODEVICELINK=1;

Die Gerätezeile wird ausgeblendet, wenn der "Reguläre Ausdruck" <regex room> zum Raumnamen passt, gilt nicht für den Raum Everything.

$SHOWNODEVICELINE = "<regex room>";

Die Detailansicht wird umorganisiert, hilfreich beim Editieren längerer uiTable-Definitionen.

$ATTRIBUTESFIRST = 1;

Template-Methoden

Bei Widgetdefinition, die mehrfach verwendet werden sollen, können Template-Methoden definiert werden. Die Definition beginnt mit dem Schlüsselwort DEF. Die Template_Methode muss mit TPL_ beginnen.

Syntax

DEF TPL_<name>(<Definition mit Platzhaltern $1,$2 usw.>)

<name> ist beliebig wählbar.

In der Tabellendefinition können die zuvor definierten Template-Methoden genutzt werden. Die Übergabeparameter werden an Stelle der Platzhalter $1, $2 usw. eingesetzt.

Beispiel

Template-Methoden-Definition:

DEF TPL_Thermostat(WID($1,$TPL{HKnob},"set"))

Nutzung der Template-Methode in der Tabellendefinition:


"Bathroom" | TPL_Thermostat([TH_Bathroom_HM:desired-temp])

"Kitchen" | TPL_Thermostat([TH_Kitchen_HM:desired-temp])

"Livingroom" | TPL_Thermostat([TH_Livingroom_HM:desired-temp])

Import von Templates und Funktionen

Mit Hilfe des Befehls IMPORT können Definitionen aus Dateien importiert werden. Damit kann der Perlblock sowie Template-Methoden in eine Datei ausgelagert werden. Der Aufbau der Datei entspricht dem des uiTable-Attributes. Tabellendefinitionen selbst können nicht importiert werden. Der IMPORT-Befehl kann vor dem Perlblock oder vor dem Tabellendefintionsbereich angegeben werden. Ebenso können mehrere IMPORT-Befehle angegeben werden. Gleiche Definitionen von Funktionen, Templates usw. aus einer IMPORT-Datei überlagern die zuvor definierten. Der IMPORT-Befehl kann ebenfalls innerhalb einer Import-Datei angegeben werden.

Syntax

IMPORT <Pfad mit Dateinamen>

Bespiel:

in uiTable

IMPORT /fhem/contrib/DOIF/mytemplates.tpl



## table definition



"outdoor" | TPL_temp([outdoor:temperature])

in mytemplates.tpl

## templates and functions

{

 $TPL{unit}="°C";

 sub FUNC_temp

 {
     my ($temp)=@_;

     return ("height:6px;font-weight:bold;font-size:16pt;color:".DOIF_hsv ($temp,-10,30,210,360,60,90));

 }

}



## template methode

DEF TPL_temp(STY($1.$TPL{unit},FUNC_temp($1)))

Links
FHEMWEB-Widgets

Status des Moduls back

Der Status des Moduls wird standardmäßig mit cmd_1, cmd_2, usw., bzw. cmd1_1 cmd1_2 usw. für Befehlssequenzen belegt. Dieser lässt sich über das Attribut "cmdState" mit Komma bzw. | getrennt umdefinieren:

attr <DOIF-modul> cmdState <Status für cmd1_1>,<Status für cmd1_2>,...| <Status für cmd2_1>,<Status für cmd2_2>,...|...

Beispiele:

attr di_lamp cmdState on|off

Pro Status können ebenfalls Status oder Readings in eckigen Klammern oder Perlfunktionen sowie Berechnungen in Klammern der Form {(...)} angegeben werden.
Die Trennzeichen Komma und | sind in Klammern und Anführungszeichen geschützt und gelten dort nicht als Trennzeichen.

Zustände cmd1_1, cmd1 und cmd2 sollen wie folgt umdefiniert werden:

attr di_mytwilight cmdState [mytwilight:ss_astro], {([mytwilight:twilight_weather]*2+10)}|My attribut is: {(Attr("mydevice","myattr",""))}

Reine Statusanzeige ohne Ausführung von Befehlen back

Der Ausführungsteil kann jeweils ausgelassen werden.

Anwendungsbeispiel: Aktuelle Außenfeuchtigkeit im Status

define di_hum DOIF ([outdoor:humidity]>70) DOELSEIF ([outdoor:humidity]>50) DOELSE

attr di_hum cmdState wet|normal|dry

Anpassung des Status mit Hilfe des Attributes state back

Es können beliebige Reading und Status oder Internals angegeben werden.

Anwendungsbeispiel: Aktuelle Außenfeuchtigkeit inkl. Klimazustand (Status des Moduls wurde mit cmdState definiert s. o.)

attr di_hum state The current humidity is [outdoor:humidity], it is [di_hum]

Es können beim Attribut state ebenfalls Berechnungen in geschweiften Klammern durchgeführt werden. Aus Kompatibilitätsgründen, muss die Berechnung mit einer runden Klammer beginnen.

Anwendungsbeispiel: Berechnung des Mittelwertes zweier Readings:

define di_average DOIF 

attr di_average state Average of the two rooms is {([room1:temperature]+[room2:temperature])/2}

Der Status wird automatisch aktualisiert, sobald sich eine der Temperaturen ändert

Da man beliebige Perl-Ausdrücke verwenden kann, lässt sich z. B. der Mittelwert auf eine Stelle mit der Perlfunktion sprintf formatieren:

attr di_average state Average of the two rooms is {(sprintf("%.1f",([room1:temperature]+[room2:temperature])/2))}

Erzeugen berechneter Readings ohne Events back

Mit Hilfe des Attributes DOIF_Readings können eigene Readings innerhalb des DOIF definiert werden, auf die man im selben DOIF-Device zugreifen kann. Die Nutzung ist insbesondere dann sinnvoll, wenn zyklisch sendende Sensoren, im Perl-Modus oder mit dem Attribut do always, abgefragt werden. DOIF_Readings-Berechnungen funktionieren ressourcenschonend ohne Erzeugung FHEM-Events nach außen. Änderungen dieser Readings triggern intern das eigene DOIF-Modul, allerdings nur, wenn sich deren Inhalt ändert.

Syntax

attr <DOIF-Modul> DOIF_Readings <readingname1>:<definiton>, <readingname2>:<definition>,...

<definition>: Beliebiger Perlausdruck ergänzt um DOIF-Syntax in eckigen Klammern. Angaben in eckigen Klammern wirken triggernd und aktualisieren das definierte Reading.

Beispiel

Perl-Modus:

define heating DOIF {if ([switch] eq "on" and [$SELF:frost]) {fhem_set"heating on"} else {fhem_set"heating off"}}

attr heating DOIF_Readings frost:([outdoor:temperature] < 0)

Das Reading frost triggert nur dann die definierte Abfrage, wenn sich sein Zustand ändert. Dadurch wird sichergestellt, dass ein wiederholtes Schalten der Heizung vermieden wird, obwohl der Sensor outdoor zyklisch sendet.

Beispiel: Push-Mitteilung über die durchschnittliche Temperatur aller Zimmer

define di_temp DOIF ([$SELF:temperature]>20) (push "Die Durchschnittstemperatur ist höher als 20 Grad, sie beträgt [$SELF:temperature]")



attr di_temp DOIF_Readings temperature:[#average:d2:":temperature":temperature]

Hierbei wird der aufwändig berechnete Durchschnittswert nur einmal berechnet, statt zwei mal, wenn man die Aggregationsfunktion direkt in der Bedingung und im Ausführungsteil angeben würde.

Erzeugen berechneter Readings mit Events back

Mit Hilfe des Attributes event_Readings können eigene Readings innerhalb des DOIF definiert werden. Dieses Atrribut hat die gleiche Syntax wie DOIF_Readings. Der Unterschied besteht darin, dass event_Readings im Gegensatz zu DOIF_Readings beim Setzen der definierten Readings jedes mal Events produziert. Die Nutzung von event_Readings ist insb. dann sinnvoll, wenn man eventgesteuert außerhalb des Moduls auf die definierten Readings zugreifen möchte.

Syntax

attr <DOIF-Modul> event_Readings <readingname1>:<definiton>, <readingname2>:<definition>,...

<definition>: Beliebiger Perlausdruck ergänzt um DOIF-Syntax in eckigen Klammern. Angaben in eckigen Klammern wirken triggernd und aktualisieren das definierte Reading.

Bsp.:

define outdoor DOIF ##



attr outdoor event_Readings\

median:[outdoor:temperature:med],\

average:[outdoor:temperature:avg10],\

diff: [outdoor:temperature:diff],\

increase: [outdoor:temperature:inc]

Auf die definierten Readings des Moduls outdoor (hier: median, average, diff und increase) kann in anderenen Modulen eventgesteuert zugegriffen werden.

Bemerkung: Sind Events des definierten Readings nicht erforderlich und nur die interne Triggerung des eigenen DOIF-Moduls interessant, dann sollte man das Attribut DOIF_Readings nutzen, da es durch die interne Triggerung des Moduls weniger das System belastet als event_Readings.

Vorbelegung des Status mit Initialisierung nach dem Neustart back

Mit dem Attribut initialize Wird der Status vorbelegt, mit Initialisierung nach dem Neustart.

Anwendungsbeispiel: Nach dem Neustart soll der Zustand von di_lamp mit "initialized" vorbelegt werden. Das Reading cmd_nr wird auf 0 gesetzt, damit wird ein Zustandswechsel provoziert, das Modul wird initialisiert - der nächste Trigger führt zum Ausführen eines Kommandos.

attr di_lamp initialize initialized

Das ist insb. dann sinnvoll, wenn das System ohne Sicherung der Konfiguration (unvorhergesehen) beendet wurde und nach dem Neustart die zuletzt gespeicherten Zustände des Moduls nicht mit den tatsächlichen übereinstimmen.

Ausführen von Befehlsketten beim Starten von FHEM back

Beim Hochfahren von FHEM lässt sich eine bestimme Aktion ausführen. Es kann dazu genutzt werden, um sofort nach dem Hochfahren des Systems einen definierten Zustand des Moduls zu erreichen. Dabei wird sichergestellt, dass die angegebenen Befehle erst dann ausgeführt werden, wenn FHEM komplett hochgefahren ist.

Symtax:

attr <DOIF-Modul> startup <FHEM-Befehl oder Perl-Befehl in geschweiften Klammern mit DOIF-Syntax>

Die Syntax entspricht der eines DOIF-Ausführungsteils (runde Klammern brauchen nicht angegeben werden).

Beispiele:

attr di_test startup set $SELF cmd_1
attr di_test startup set $SELF checkall
attr di_test startup sleep 60;set lamp1 off;set lamp2 off
attr di_test startup {myfunction()},set lamp1 on,set lamp2 on

Deaktivieren des Moduls back

Ein DOIF-Modul kann mit Hilfe des Attributes disable, deaktiviert werden. Dabei werden alle Timer und Readings des Moduls gelöscht. Soll das Modul nur vorübergehend deaktiviert werden, so kann das durch set <DOIF-modul> disable geschehen.

Set-Befehle

Überprüfung aller DOIF-Bedingungen mit Ausführung eines DOIF-Zweiges back

Mit dem set-Befehl checkall werden wie beim gleichnamigen Attribut alle DOIF-Bedingung überprüft, sobald eine Bedingung als wahr geprüft ist, wird das dazugehörige Kommando ausgeführt. Zu beachten ist, dass nur der erste wahre DOIF-Zweig ausgeführt wird und dass nur Zustandsabfragen sowie Zeitintervalle sinnvoll überprüft werden können. Ereignisabfragen sowie Zeitpunkt-Definitionen, sind zum Zeitpunkt der checkall-Abfrage normalerweise nicht wahr.

Beispiel:

attr di_test startup set $SELF checkall

Inaktivieren des Moduls back

Mit dem set-Befehl disable wird ein DOIF-Modul inaktiviert. Hierbei bleiben alle Timer aktiv, sie werden aktualisiert - das Modul bleibt im Takt, allerdings werden keine Befehle ausgeführt. Das Modul braucht mehr Rechenzeit, als wenn es komplett über das Attribut disable deaktiviert wird. Ein inaktiver Zustand bleibt nach dem Neustart erhalten. Ein inaktives Modul kann über set-Befehle enable bzw. initialize wieder aktiviert werden.

Aktivieren des Moduls back

Mit dem set-Befehl enable wird ein inaktives DOIF-Modul wieder aktiviert. Im Gegensatz zum set-Befehl initialize wird der letzte Zustand vor der Inaktivierung des Moduls wieder hergestellt.

Initialisieren des Moduls back

mit dem set-Befehl initialize wird ein DOIF-Modul initialisiert. Ein inaktives DOIF-Modul wieder aktiviert. Im Gegensatz zum set-Befehl enable wird der letzte Zustand des Moduls gelöscht, damit wird ein Zustandswechsel herbeigeführt, der nächste Trigger führt zur Ausführung eines wahren DOIF-Zweiges. Diese Eigenschaft kann auch dazu genutzt werden, ein bereits aktives Modul zu initialisieren.

Auführen von Befehlszweigen ohne Auswertung der Bedingung back

Mit set <DOIF-modul> cmd_<nr> lässt sich ein Befehlszweig (cmd_1, cmd_2, usw.) bedingunglos ausführen.

Der Befehl hat folgende Eigenschaften:

1) der set-Befehl übersteuert alle Attribute wie z. B. wait, do, usw.
2) ein laufender Wait-Timer wird unterbrochen
3) beim deaktivierten oder im Modus disable befindlichen Modul wird der set Befehl ignoriert

Anwendungsbeispiel: Schaltbare Lampe über Fernbedienung und Webinterface


define di_lamp DOIF ([FB:"on"]) (set lamp on) DOELSEIF ([FB:"off"]) (set lamp off)



attr di_lamp devStateIcon cmd_1:on:cmd_2 initialized|cmd_2:off:cmd_1

Mit der Definition des Attributes devStateIcon führt das Anklicken des on/off-Lampensymbol zum Ausführen von set di_lamp cmd_1 bzw. set di_lamp cmd_2 und damit zum Schalten der Lampe.

Wenn mit cmdState eigene Zuständsbezeichnungen definiert werden, so können diese ebenfalls per set-Befehl angegeben werden.


define di_lamp DOIF ([FB:"on"]) (set lamp on) DOELSEIF ([FB:"off"]) (set lamp off)



attr di_lamp cmdState on|off

attr di_lamp setList on off

set di_lamp on entspricht hier set di_lamp cmd_1 und set di_lamp off set di_lamp cmd_2
Zusätzlich führt die Definition von setList zur Ausführung von set di_lamp on/off durch das Anlicken des Lampensymbols wie im vorherigen Beispiel.

Weitere Anwendungsbeispiele back

Zweipunktregler a la THRESHOLD

define di_threshold DOIF ([sensor:temperature]<([$SELF:desired]-1))

  (set heating on)

DOELSEIF ([sensor:temperature]>[$SELF:desired])

  (set heating off)



attr di_threshold cmdState on|off

attr di_threshold readingList desired

attr di_threshold setList desired:17,18,19,20,21,22

attr di_threshold webCmd desired

Die Hysterese ist hier mit einem Grad vorgegeben. Die Vorwahltemperatur wird per Dropdown-Auswahl eingestellt.

on-for-timer

Die Nachbildung eines on-for-timers lässt sich wie folgt realisieren:

define di_on_for_timer ([detector:"motion"])

  (set light on)

  (set light off)

attr di_on_for_timer do resetwait

attr di_on_for_timer wait 0,30

Hiermit wird das Licht bei Bewegung eingeschaltet. Dabei wird, solange es brennt, bei jeder Bewegung die Ausschaltzeit neu auf 30 Sekunden gesetzt, "set light on" wird dabei nicht unnötig wiederholt.
siehe auch Treppenhauslicht mit Bewegungsmelder im Perl-Modus

Die Beispiele stellen nur eine kleine Auswahl von möglichen Problemlösungen dar. Da sowohl in der Bedingung (hier ist die komplette Perl-Syntax möglich), als auch im Ausführungsteil, keine Einschränkungen gegeben sind, sind die Möglichkeiten zur Lösung eigener Probleme mit Hilfe des Moduls sehr vielfältig.

Zu beachten back

In jeder Bedingung muss mindestens ein Trigger angegeben sein (Angaben in eckigen Klammern). Die entsprechenden DO-Fälle werden nur dann ausgewertet, wenn auch das entsprechende Event oder Zeit-Trigger ausgelöst wird.

Zeitangaben der Art:

define di_light DOIF ([08:00] and [10:00]) (set switch on)

sind nicht sinnvoll, da diese Bedingung nie wahr sein wird.

Angaben, bei denen aufgrund der Definition kein Zustandswechsel erfolgen kann z. B.:

define di_light DOIF ([08:00]) (set switch on)

attr di_light do always

müssen mit Attribut do always definiert werden, damit sie nicht nur einmal, sondern jedes mal (hier jeden Tag) ausgeführt werden.

Bei Devices, die mit Zwischenzuständen arbeiten, insbesondere HM-Komponenten (Zwischenzustand: set_on, set_off), sollte die Definition möglichst genau formuliert werden, um unerwünschte Effekte zu vermeiden:

statt:

define di_lamp DOIF ([HM_switch] eq "on") (set lamp on) DOELSE (set lamp off)

konkreter spezifizieren:

define di_lamp DOIF ([HM_switch] eq "on") (set lamp on) DOELSEIF ([HM_switch] eq "off") (set lamp off)

Namenskonvention: Da der Doppelpunkt bei Readingangaben als Trennzeichen gilt, darf er nicht im Namen des Devices vorkommen. In solchen Fällen bitte das Device umbenennen.

Standardmäßig, ohne das Attribut do always, wird das Wiederholen desselben Kommmandos vom Modul unterbunden. Daher sollte nach Möglichkeit eine Problemlösung mit Hilfe eines und nicht mehrerer DOIF-Module realisiert werden, getreu dem Motto "wer die Lampe einschaltet, soll sie auch wieder ausschalten". Dadurch wird erreicht, dass unnötiges (wiederholendes) Schalten vom Modul unterbunden werden kann, ohne dass sich der Anwender selbst darum kümmern muss.

Mehrere Bedingungen, die zur Ausführung gleicher Kommandos führen, sollten zusammengefasst werden. Dadurch wird ein unnötiges Schalten aufgrund verschiedener Zustände verhindert.

Beispiel:

define di_lamp DOIF ([brightness] eq "off") (set lamp on) DOELSEIF ([19:00]) (set lamp on) DOELSE (set lamp off)

Hier wird um 19:00 Uhr Lampe eingeschaltet, obwohl sie evtl. vorher schon durch das Ereignis brightness "off" eingeschaltet wurde.

define di_lamp DOIF ([brightness] eq "off" or [19:00]) (set lamp on) DOELSE (set lamp off)

Hier passiert das nicht mehr, da die ursprünglichen Zustände cmd_1 und cmd_2 jetzt nur noch einen Zustand cmd_1 darstellen und dieser wird nicht wiederholt.

Kurzreferenz back

⟨⟩ kennzeichnet optionale Angaben
Definition

define <name> DOIF ⟨(<Bedingung>) ⟨⟨(⟨<Befehle>⟩)⟩ ⟨⟨⟨DOELSEIF (<Bedingung>) ⟨(⟨<Befehle>⟩)⟩⟩ ... ⟩⟨DOELSE ⟨(⟨<Befehle>⟩)⟩⟩⟩⟩⟩: Befehlstrennzeichen ist das Komma (<Befehl>, <Befehl>, ...); Befehlssequenzen werden in runde Klammern gesetzt (<Befehlssequenz A>) (<Befehlssequenz B>) ...; Enthält ein Befehl Kommata, ist er zusätzlich in runde Klammern einzuschliessen (<Befehlsteil a>, <Befehlsteil b> ... ); Perl-Befehle {<Perl-Befehl>} sind in geschweifte Klammern einzuschliessen; Jede Berechnung {(<Berechnung>)⟨<Berechnung>⟩} in einem Befehl ist in geschweifte Klammern einzuschliessen und muss mit einer geöffneten runden Klammer beginnen.

Readings

Device: Name des auslösenden Gerätes
block_<block name>: Zeigt die Ausführung eines Perl-Blocks an (Perl).
cmd: Nr. des letzten ausgeführten Befehls als Dezimalzahl oder 0 nach Initialisierung des DOIF, in der Form <Nr. des Befehlszweiges>⟨.<Nr. der Sequenz>⟩
cmd_event: Angabe des auslösenden Ereignisses
cmd_nr: Nr. des letzten ausgeführten Befehlszweiges
cmd_seqnr: Nr. der letzten ausgeführten Befehlssequenz
e_<Device>_<Reading>|<Internal>|Events: Bezeichner und Wert der auslösenden Geräte mit Readings, Internals oder Events
error: Enthält Fehlermeldungen oder Rückgabewerte von Befehlen, siehe Besonderheit des Error-Reading
last_cmd: letzter Status
matched_event_c<lfd. Nr. der Bedingung>_<lfd. Nr. des Events>: Wert, der mit dem Regulären Ausdruck übereinstimmt
mode: der Modus, in dem sich DOIF befindet: <enabled|disabled|deactivated>
state: Status des DOIF nach Befehlsausführung, Voreinstellung: cmd_<Nr. des Befehlszweiges>⟨_<Nr. der Befehlssequenz>⟩
timer_<lfd. Nr.>_c<Nr. des Befehlszweiges>: verwendete Timer mit Angabe des nächsten Zeitpunktes
timer_<timer name>: verwendete, benannte Timer mit Angabe des nächsten Zeitpunktes (Perl)
wait_timer: Angabe des aktuellen Wait-Timers
warning: Perl-Warnung bei der Auswertung einer Bedingung
<A-Z>_<readingname>: Readings, die mit einem Großbuchstaben und nachfolgendem Unterstrich beginnen, sind für User reserviert und werden auch zukünftig nicht vom Modul selbst benutzt.

Operanden in der Bedingung und den Befehlen und im Perl-Modus

Status [<Device>⟨,<Default>⟩]
Readings [<Device>:<Reading>⟨,<Default>⟩]
Internals [<Device>:&<Internal>⟨,<Default>⟩]
Filtern allgemein nach Ausdrücken mit Ausgabeformatierung: [<Device>:<Reading>|<Internal>:"<Filter>"⟨:<Output>⟩⟨,<Default>⟩]
Filtern einer Zahl [<Device>:<Reading>:d⟨,<Default>⟩]
Zeitspanne eines Readings seit der letzten Änderung [<Device>:<Reading>:sec⟨,<Default>⟩]
$DEVICE: für den Gerätenamen
$EVENT: für das zugehörige Ereignis
$EVENTS: für alle zugehörigen Ereignisse eines Triggers
$SELF: für den Gerätenamen des DOIF
<Perl-Funktionen>: vorhandene und selbsterstellte Perl-Funktionen

Operanden in der Bedingung und im Perl-Modus

Events [<Device>:"<Regex-Events>"] oder ["<Regex-Devices>:<Regex-Events>"] oder ["<Regex-Devices>"⟨:"<Regex-Filter>"⟩⟨:<Output>⟩,<Default>]: für <Regex> gilt: ^<ist eindeutig>$, ^<beginnt mit>, <endet mit>$, "" entspricht ".*", Regex-Filter ist mit [^\:]*: (.*) vorbelegt siehe auch Reguläre Ausdrücke und Events des Gerätes global
Zeitpunkte [<time>]: als [HH:MM], [HH:MM:SS] oder [Zahl] in Sekunden nach Mitternacht
Zeitintervalle [<begin>-<end>]: als [HH:MM], [HH:MM:SS] oder [Zahl] in Sekunden nach Mitternacht
indirekte Zeitangaben [[<indirekte Zeit>]]: als [HH:MM], [HH:MM:SS] oder [Zahl] in Sekunden nach Mitternacht, <indirekte Zeit> ist ein Status, Reading oder Internal
relative Zeitangaben [+<time>]: als [HH:MM], [HH:MM:SS] oder [Zahl] in Sekunden
ausgerichtete Zeitraster [:MM]: in Minuten zwischen 00 und 59
rel. Zeitraster ausgerichtet [+:MM]: in Minuten zwischen 1 und 59
rel. Zeitraster ausgerichtet alle X Stunden [+[h]:MM]: MM in Minuten zwischen 1 und 59, h in Stunden zwischen 2 und 23
Wochentagsteuerung [<time>|0123456789], [<begin>-<end>]|0123456789]: Pipe, gefolgt von ein o. mehreren Ziffern. Bedeutung: 0 bis 6 für So. bis Sa., 7 für $we, Wochenende oder Feiertag, 8 für !$we, Werktags, 9 für $twe, Wochenende oder Feiertag morgen.
berechnete Zeitangaben [(<Berechnung, gibt Zeit in Sekunden zurück, im Sinne von time>)]: Berechnungen sind mit runden Klammern einzuschliessen. Perlfunktionen, die HH:MM zurückgeben sind mit geschweiften Klammern einzuschliessen.
Intervall-Timer [<begin>-<end>,<relativ timer>]: Löst zu den aus <relativ timer> berechneten Zeitpunkten im angegebenen Zeitintervall <begin>-<end> aus.
Trigger verhindern [?<devicename>], [?<devicename>:<readingname>], [?<devicename>:&<internalname>], [?<time specification>]: Werden Status, Readings, Internals und Zeitangaben in der Bedingung mit einem Fragezeichen eingeleitet, triggern sie nicht.
$device, $event, $events: Perl-Variablen mit der Bedeutung der Schlüsselworte $DEVICE, $EVENT, $EVENTS
$cmd: Perl-Variablen mit der Bedeutung [$SELF:cmd]
<Perl-Zeitvariablen>: Variablen für Zeit- und Datumsangaben, $sec, $min, $hour, $mday, $month, $year, $wday, $yday, $isdst, $week, $hms, $hm, $md, $ymd, $we, $twe

set-Befehle

disable set <name> checkall: Überprüfung aller DOIF-Bedingungen mit Ausführung eines wahren DOIF-Zweiges
disable set <name> disable: blockiert die Befehlsausführung
initialize set <name> initialize: initialisiert das DOIF und aktiviert die Befehlsausführung
enable set <name> enable: aktiviert die Befehlsausführung, im Gegensatz zur obigen Initialisierung bleibt der letzte Zustand des Moduls erhalten
cmd_<nr> set <name> cmd_<nr>: führt ohne Auswertung der Bedingung den Befehlszweig mit der Nummer <nr> aus

get-Befehle

html: liefert HTML-Code einer definierten uiTable zurück.

Attribute

Verzögerungen attr <name> wait <timer_1_1>,<timer_1_2>,...:<timer_2_1>,<timer_2_2>,...:...: Zeit in Sekunden als direkte Angabe oder Berechnung, ein Doppelpunkt trennt die Timer der Bedingungsweige, ein Komma die Timer der Befehlssequenzen eines Bedingungszweiges.
Verzögerung von Timern attr <name> timerWithWait: erweitert wait auf Zeitangaben
attr <name> do <always|resetwait>: always wiederholt den Ausführungsteil, wenn die selbe Bedingung wiederholt wahr wird.
resetwait setzt den Waittimer zurück, wenn die selbe Bedingung wiederholt wahr wird.
Befehle wiederholen attr <name> repeatcmd <timer Bedingungszweig 1>:<timer Bedingungszweig 2>:...: Zeit in Sekunden als direkte Angabe oder Berechnung, nach der Befehle wiederholt werden.
Pause für Wiederholung attr <name> cmdpause <Pause cmd_1>:<Pause cmd_2>:...: Zeit in Sekunden als direkte Angabe oder Berechnung, blockiert die Befehlsausführung während der Pause.
Begrenzung von Wiederholungen attr <name> repeatsame <maximale Anzahl von cmd_1>:<maximale Anzahl von cmd_2>:...: Anzahl als direkte Angabe oder Berechnung, begrenzt die maximale Anzahl unmittelbar folgender Befehlsausführungen.
Warten auf Wiederholung attr <name> waitsame <Wartezeit cmd_1>:<Wartezeit cmd_2>:...: Wartezeit in Sekunden als direkte Angabe oder Berechnung, für ein unmittelbar wiederholtes Zutreffen einer Bedingung.
Löschen des Waittimers attr <name> waitdel <timer_1_1>,<timer_1_2>,...:<timer_2_1>,<timer_2_2>,...:...: Zeit in Sekunden als direkte Angabe oder Berechnung, ein laufender Timer wird gelöscht und die Befehle nicht ausgeführt, falls eine Bedingung vor Ablauf des Timers wiederholt wahr wird.
Readingauswertung bei jedem Event des Devices attr <name> checkReadingEvent <0|1>: 0 deaktiviert, 1 keine Funktion mehr, entspricht internen der Voreinstellung des Moduls.
Selbsttriggerung attr <name> selftrigger <wait|all>: lässt die Triggerung des Gerätes durch sich selbst zu. wait zugelassen für verzögerte Befehle, all zugelassen auch für nicht durch wait verzögerte Befehle; es ist nur eine Rekusion möglich
Event beim Setzen eines Timers attr <name> timerevent <0|ungleich Null>: erzeugt beim Setzen eines Timers ein Event. ungleich Null aktiviert, 0 deaktiviert
Gerätestatus ersetzen attr <name> cmdState <Ersatz cmd_1_1>,...,<Ersatz cmd_1>|<Ersatz cmd_2_1>,...,<Ersatz cmd_2>|...: ersetzt die Standartwerte des Gerätestatus als direkte Angabe oder Berechnung, die Ersatzstatus von Befehlssequenzen werden durch Kommata, die von Befehlszweigen durch Pipe Zeichen getrennt.
Befehle bei FHEM-Start ausführen attr <name> startup <FHEM-Befehle>|{<Perl-Befehle mit DOIF-Syntax>}
dynamischer Status attr <name> state <content>: <content> ist das Ergebnis eines Perl-Ausdrucks, DOIF-Syntax ([<device>:<reading>], usw.) triggert bei Event die Berechnung.
Erzeugen berechneter Readings attr <name> DOIF_Readings <readingname_1>:<content_1>,<readingname_2>:<content_2> ...: <content_n> ist das Ergebnis von Perl-Ausdrücken, DOIF-Syntax ([<device>:<reading>], usw.) triggert bei Event die Berechnung.
Ersatzwert für nicht existierende Readings oder Status attr <name> notexist "<Ersatzwert>"
Status Initialisierung nach Neustart attr <name> intialize <Status nach Neustart>
Gerät vollständig deaktivieren attr <name> disable <0|1>: 1 deaktiviert das Modul vollständig, 0 aktiviert es.
Alle Bedingungen prüfen attr <name> checkall <event|timer|all>: event Alle Bedingungen werden geprüft, wenn ein Event-Trigger (Ereignisauslöser) auslöst.
timer Alle Bedingungen werden geprüft, wenn ein Timer-Trigger (Zeitauslöser) auslöst.
all Alle Bedingungen werden geprüft.
Die Befehle nach der ersten wahren Bedingung werden ausgeführt.
Eindeutige Statuserkennung attr <name> addStateEvent <0|ungleich Null>: fügt einem Gerätestatus-Event "state:" hinzu. ungleich Null aktiviert, 0 deaktiviert, siehe auch addStateEvent
attr <name> readingList <Reading1> <Reading2> ...: fügt zum set-Befehl direkt setzbare, durch Leerzeichen getrennte Readings hinzu.
attr <name> setList <Reading1>:⟨<Modifier1>,⟩<Value1>,<Value2>,<...> <Reading2>:⟨<Modifier2>,⟩<Value1>,<Value2>,<...> ...: fügt einem Reading einen optionalen Widgetmodifier und eine Werteliste (, getrennt) hinzu. setList, widgetOverride, und webCmd
User Interface für DOIF attr <name> uiTable ⟨{<perl code (format specification, template specification, function definition, control variable, ...)>}\n⟩<template file import, method definition, table definition>: format specification:; $TABLE = "<CSS-Attribute>" ergänzt das table-Elemente um CSS-Attribute.; $TD{<rows>}{<columns>} = "<HTML Attribute>" ergänzt td-Elemente um HTML-Attribute.; $TR{<rows>} = "<HTML Attribute>" ergänzt tr-Elemente um HTML-Attribute.; $TC{<columns>} = "<HTML Attribute>" ergänzt zu columns gehörende td-Elemente um HTML-Attribute.; template specification:; $TPL{<name>} = "<Zeichenkette>" speichert ein Template.; function definition:; sub FUNC_<name> {<function BLOCK>} definiert eine Funktion.; control variables:; $ATTRIBUTESFIRST = 1; organisiert die Detailansicht um.; $SHOWNOSTATE = 1; blendet den Status in der Gerätezeile aus.; $SHOWNODEVICELINE = "<regex room>"; blendet die Gerätezeile aus, wenn <regex room> zum Raumnamen passt, gilt nicht für den Raum Everything.; $SHOWNODEVICELINK = 1; schaltet das Ersetzen des Gerätenamen durch einen Link auf die Detailseite aus.; template file import:; IMPORT <path with filename> importiert eine Templatedatei.; method definition:; DEF TPL_<name>(<definition with place holder $1,$2 usw.>) erzeugt ein Methodentemplate zur wiederholten Nutzung in der Tabellendefinition.; table definition:; Schreiben die nachstehenden Elemente HTML-Code in die Tabellenzelle, so wird er interpretiert.; ↵ oder ↵↵ trennt Tabellenzeilen.; | oder |↵ trennt Tabellenzellen.; >↵ oder ,↵ sind zur Textstrukturierung zugelassen.; WID([<device>:<reading>],"<widget modifier>"⟨,"<command>"⟩) bindet ein Widget an <device>:<reading>, <command> steht für set oder setreading, siehe widgetOverride und FHEMWEB-Widgets; STY(<content>,<CSS style attributes>) schreibt den Inhalt von <content> in die Zelle und formatiert ihn mit <CSS style attributes>.; <content> schreibt den Inhalt von <content> in die Zelle.; <content> und <CSS style attributes> sind das Ergebnis von Perl-Ausdrücken. Enthalten sie DOIF-Syntax ([<device>:<reading>], usw.), werden sie dynamisch erzeugt.; PUP(<DOIF-name to show interface table>, <iconname[@color number]>); gibt ein Link zum Öffnen eines Popup-Fensters zurück.; <DOIF-name to show interface table> Name des DOIF-Gerätes dessen Benutzerschnittstelle angezeigt werden soll.; <iconname[@color number]|string> gibt ein Icon an, wenn das Icon nicht verfügbar ist, wird <string> angezeigt.
readingFnAttributes

Perl-Funktionen

DOIF_hsv(<current value>, <lower value>, <upper value>, <lower HUE value>, <upper HUE value>, <saturation>, <lightness>): gibt eine im HSV-Raum interpolierte HTML Farbnummer zurück, mit Prefix #; <current value> aktueller Wert, für den die Farbnummer erzeugt wird.; <lower value> unterer Wert, des Bereiches auf den die Farbnummer skaliert wird.; <upper value> oberer Wert, des Bereiches auf den die Farbnummer skaliert wird.; <lower HUE value> unterer HUE-Wert, der mit dem unteren Wert korrespondiert (0-360).; <upper HUE value> oberer HUE-Wert, der mit dem oberen Wert korrespondiert (0-360).; <saturation> Farbsättigung (0-100).; <lightness> Hellwert (0-100).
DOIF_rgb(<start color number>, <end color number>, <lower value>, <upper value>, <current value>): gibt eine linear interpolierte RGB Farbnummer zurück, abhängig vom Prefix der Start- o. Endfarbnummer mit oder ohne Prefix #.; <start color number> Startfarbnummer des Farbbereiches, mit oder ohne Prefix #.; <end color number> Endfarbnummer des Farbbereiches, mit oder ohne Prefix #.; <lower value> unterer Wert, des Bereiches auf den die Farbnummer skaliert wird.; <upper value> oberer Wert, des Bereiches auf den die Farbnummer skaliert wird.; <current value> aktueller Wert, für den die Farbnummer erzeugt wird.
FW_makeImage(<iconname[@color number]>): gibt HTML-Code zurück, der ein FHEM icon einbindet.; <color number> optionale Farbnummer in Großschreibung, mit oder ohne Prefix #.; weitere Infos im Quelltext von 01_FHEMWEB.pm.

Perl Modus

Der Perl-Modus ist sowohl für einfache, als auch für komplexere Automatisierungsabläufe geeignet. Der Anwender hat mehr Einfluss auf den Ablauf der Steuerung als im FHEM-Modus. Die Abläufe lassen sich, wie in höheren Programmiersprachen üblich, strukturiert programmieren. Zum Zeitpunkt der Definition werden alle DOIF-spezifischen Angaben in Perl übersetzt, zum Zeitpunkt der Ausführung wird nur noch Perl ausgeführt, dadurch wird maximale Performance gewährleistet.

Syntax Perl-Modus:

define <name> DOIF <Blockname> {<Ereignisblock: Perlcode mit Ereignis-/Zeittriggern in eckigen Klammern>}

Ein Ereignisblock wird ausgeführt, wenn dieser bedingt durch Ereignis- und Zeittrigger in eckigen Klammern innerhalb des Blocks, getriggert wird. Es wird die vollständige Perl-Syntax unterstützt. Es können beliebig viele Ereignisblöcke innerhalb eines DOIF-Devices definiert werden. Sie werden unabhängig voneinander durch passende Trigger ausgeführt. Der Name eines Ereignisblocks ist optional.

Der Status des Moduls wird nicht vom Modul gesetzt, er kann vom Anwender mit Hilfe der Funktion set_State verändert werden, siehe spezifische Perl-Funktionen im Perl-Modus. FHEM-Befehle werden durch den Aufruf der Perlfunktion fhem("...") ausgeführt. Für den häufig genutzten fhem-Befehl set wurde eine kompatible Perlfunktion namens fhem_set definiert. Sie ist performanter und sollte bevorzugt verwendet werden, da das Parsen nach dem FHEM set-Befehl entfällt.

Der Benutzer kann mit der Funktion set_Exec beliebig viele eigene Timer definieren, die unabhängig voneinander gesetzt und ausgewertet werden können, siehe Spezifische Perl-Funktionen im Perl-Modus.

Definitionen im FHEM-Modus mit do-Attribut der Form:

DOIF (<Bedingung mit Trigger>) (<FHEM-Befehle>) DOELSE (<FHEM-Befehle>)

lassen sich wie folgt in Perl-Modus übertragen:

DOIF {if (<Bedingung mit Trigger>) {fhem"<FHEM-Befehle>"} else {fhem"<FHEM-Befehle>"}}

Die Bedingungen des FHEM-Modus können ohne Änderungen in Perl-Modus übernommen werden.

Einfache Anwendungsbeispiele (vgl. Anwendungsbeispiele im FHEM-Modus):

define di_rc_tv DOIF {if ([remotecontol:"on"]) {fhem_set"tv on"} else {fhem_set"tv off"}}

define di_clock_radio DOIF {if ([06:30|Mo Di Mi] or [08:30|Do Fr Sa So]) {fhem_set"radio on"}} {if ([08:00|Mo Di Mi] or [09:30|Do Fr Sa So]) {fhem_set"radio off"}}

define di_lamp DOIF {if ([06:00-09:00] and [sensor:brightness] < 40) {fhem_set"lamp:FILTER=STATE!=on on"} else {fhem_set"lamp:FILTER=STATE!=off off"}}

Bemerkung: Im Gegensatz zum FHEM-Modus arbeitet der Perl-Modus ohne Auswertung des eigenen Status (Zustandsauswertung), daher muss der Anwender selbst darauf achten, wiederholende Ausführungen zu vermeiden (im oberen Beispiel z.B. mit FILTER-Option). Elegant lässt sich das Problem der wiederholenden Ausführung bei zyklisch sendenden Sensoren mit Hilfe des Attributes DOIF_Readings lösen.

Es können beliebig viele Ereignisblöcke definiert werden, die unabhängig von einander durch einen oder mehrere Trigger ausgewertet und zur Ausführung führen können:

DOIF

{ if (<Bedingung mit Triggern>) ... }

{ if (<Bedingung mit Triggern>) ... }

...

Einzelne Ereignis-/Zeittrigger, die nicht logisch mit anderen Bedingungen oder Triggern ausgewertet werden müssen, können auch ohne if-Anweisung angegeben werden, z. B.:

DOIF

{["lamp:on"];...}

{[08:00];...}

...

Ereignis-/Zeittrigger sind intern Perlfunktionen, daher können sie an beliebiger Stelle im Perlcode angegeben werden, wo Perlfunktionen vorkommen dürfen, z. B.:

DOIF {Log 1,"state of lamp: ".[lamp:state]}

DOIF {fhem_set("lamp ".[remote:state])}

Es sind beliebige Hierarchietiefen möglich:

DOIF

{ if (<Bedingung>) {

    if (<Bedingung>) {

      if (<Bedingung mit Triggern>...

        ...

      }

    }

  }

}

Bemerkung: Innerhalb eines Ereignisblocks muss mindestens ein Trigger definiert werden, damit der gesamte Block beim passenden Trigger ausgeführt wird.

Inhaltsübersicht Perl-Modus

Eigene Funktionen mit Parametern

Eigener_Namensraum

Spezifische Perl-Funktionen im Perl-Modus:

Initialisierung - init-Block

Device-Variablen

Blockierende Funktionsaufrufe

Attribute im Perl-Modus

Anwendungsbeispiele im Perl-Modus

Eigene Funktionen back

Ein besonderer Block ist der Block namens subs. In diesem Block werden Perlfunktionen definiert, die innerhalb des DOIFs genutzt werden. Um eine möglichst hohe Kompatibilität zu Perl sicherzustellen, wird keine DOIF-Syntax in eckigen Klammern unterstützt, insb. gibt es keine Trigger, die den Block ausführen können.

Beispiel:


DOIF 
subs { ## Definition von Perlfunktionen lamp_on und lamp_off

  sub lamp_on {

     fhem_set("lamp on");

     set_State("on");

  }

  sub lamp_off {

     fhem_set("lamp off");

     set_State("off");

  }

}

{[06:00];lamp_on()}  ## Um 06:00 Uhr wird die Funktion lamp_on aufgerufen

{[08:00];lamp_off()} ## Um 08:00 Uhr wird die Funktion lamp_off aufgerufen

Eigene Funktionen mit Parametern back

Unter Verwendung von Funktionsparamerter lassen sich Definitionen oft vereinfachen, das obige Beispiel lässt sich mit Hilfe nur einer Funktion kürzer wie folgt definieren:


DOIF 
subs { ## Definition der Perlfunktion lamp

  sub lamp {

     my ($state)=@_;  # Variable $state mit dem Parameter belegen

     fhem_set("lamp $state");

     set_State($state);

  }

}

{[06:00];lamp("on")}  ## Um 06:00 Uhr wird die Funktion lamp mit Parameter "on" aufgerufen

{[08:00];lamp("off")} ## Um 08:00 Uhr wird die Funktion lamp mit dem Parameter "off" aufgerufen

Eigener Namensraum back

Der Namensraum im Perl-Modus ist gekapselt. Selbstdefinierte Funktionen im DOIF-Device können nicht bereits existierende Perlfunktionen in FHEM (Namensraum main) überschreiben. Funktionen aus dem Namensraum main müssen mit vorangestellem Doppelpunkt angegeben werden: ::<perlfunction>

Eigene Perlfunktionen, die in myutils ausgelagert sind, befinden sich ebenfalls im Namensraum main. Wenn sie ausschließich in DOIF-Devices benutzt werden sollen, so kann am Anfang vor deren Definition in myutils "package DOIF;" angegeben werden. In diesen Fall sind auch diese Funktion im DOIF-Device bekannt - sie können dann ohne vorangestellten Doppelpunkt genutzt werden.

Folgende FHEM-Perlfunktionen wurden ebenfalls im DOIF-Namensraum definiert, sie können, wie gewohnt ohne Doppelpunkt genutzt werden:

fhem, Log, Log3, InternVal, InternalNum, OldReadingsVal, OldReadingsNum, OldReadingsTimestamp, ReadingsVal, ReadingsNum, ReadingsTimestamp, ReadingsAge, Value, OldValue, OldTimestamp, AttrVal, AttrNum

Spezifische Perl-Funktionen im Perl-Modus   back

FHEM set-Befehl ausführen: fhem_set(<content>), mit <content> Übergabeparameter des FHEM set-Befehls

Beispiel: Lampe ausschalten:

fhem_set("lamp off");

entspricht:

fhem("set lamp off");

Der Aufruf der fhem_set-Funktion ist performater, da das Parsen nach dem set-Befehl im Gegensatz zum Aufruf mit der Funktion fhem entfällt.

Ein beliebiges FHEM-Event absetzen: set_Event(<Event>)

Beispiel: Setze das Event "on":

set_Event("on");

Status setzen: set_State(<value>,<trigger>), mit <trigger>: 0 ohne Trigger, 1 mit Trigger, <trigger> ist optional, default ist 1

Beispiel: Status des eignen DOIF-Device auf "on" setzen:

set_State("on");

Status des eigenen DOIF-Devices holen: get_State()

Beispiel: Schalte lampe mit dem eigenen Status:

fhem_set("lamp ".get_State());

Reading des eigenen DOIF-Devices schreiben: set_Reading(<readingName>,<value>,<trigger>), mit <trigger>: 0 ohne Trigger, 1 mit Trigger, <trigger> ist optional, default ist 0

set_Reading("weather","cold");

Reading des eigenen DOIF-Devices holen: get_Reading(<readingName>)

Beispiel: Schalte Lampe mit dem Inhalt des eigenen Readings "dim":

fhem_set("lamp ".get_Reading("dim"));

Setzen mehrerer Readings des eigenen DOIF-Devices in einem Eventblock:

set_Reading_Begin()
set_Reading_Update(<readingName>,<value>,<change>), <change> ist optional
set_Reading_End(<trigger>), mit <trigger>: 0 ohne Trigger, 1 mit Trigger, <trigger>

Die obigen Funktionen entsprechen den FHEM-Perlfunktionen: readingsBegin, readingsBulkUpdate, readingsEndUpdate.

Beispiel:

Die Readings "temperature" und "humidity" sollen in einem Eventblock mit dem zuvor belegten Inhalt der Variablen $temp bzw. $hum belegt werden.

set_Reading_Begin;
set_Reading_Update("temperature",$temp);
set_Reading_Update("humidity",$hum);
set_Reading_End(1);

Ausführungstimer   back

Mit Hilfe von Ausführungstimern können Anweisungen verzögert ausgeführt werden. Im Gegensatz zum FHEM-Modus können beliebig viele Timer gleichzeitig genutzt werden. Ein Ausführungstimer wird mit einem Timer-Namen eindeutig definiert. Über den Timer-Namen kann die Restlaufzeit abgefragt werden, ebenfalls kann er vor seinem Ablauf gelöscht werden.

Timer setzen: set_Exec(<timerName>, <seconds>, <perlCode>, <parameter>), mit <timerName>: beliebige Angabe, sie spezifiziert eindeutig einen Timer, welcher nach Ablauf den angegebenen Perlcode <perlCode> aufruft. Falls als Perlcode eine Perlfunktion angegeben wird, kann optional ein Übergabeparameter <parameter> angegeben werden. Die Perlfunkion muss eindeutig sein und in FHEM zuvor deklariert worden sein. Wird set_Exec mit dem gleichen <timerName> vor seinem Ablauf erneut aufgerufen, so wird der laufender Timer gelöscht und neugesetzt.

Timer holen: get_Exec(<timerName>), Returnwert: 0, wenn Timer abgelaufen oder nicht gesetzt ist, sonst Anzahl der Sekunden bis zum Ablauf des Timers

Laufenden Timer löschen: del_Exec(<timerName>)

Beispiel: Funktion namens "lamp" mit dem Übergabeparameter "on" 30 Sekunden verzögert aufrufen:

set_Exec("lamp_timer",30,'lamp','on');

alternativ

set_Exec("lamp_timer",30,'lamp("on")');

Beispiel: Lampe verzögert um 30 Sekunden ausschalten:

set_Exec("off",30,'fhem_set("lamp off")');

Beispiel: Das Event "off" 30 Sekunden verzögert auslösen:

set_Exec("off_Event",30,'set_Event("off")');

init-Block   back

Wird ein Ereignisblock mit dem Namen init benannt, so wird dieser Block beim Systemstart ausgeführt. Er bietet sich insb. an, um Device-Variablen des Moduls vorzubelegen.

Device-Variablen   back

Device-Variablen sind sogenannte Instanzvariablen, die global innerhalb eines DOIF-Devices genutzt werden können. Deren Inhalt bleibt von Trigger zu Trigger während der Laufzeit des System erhalten. Sie beginnen mit $_ und müssen nicht deklariert werden. Wenn sie nicht vorbelegt werden, gelten sie als nicht definiert. Das lässt sich abfragen mit:

if (defined $_...) ...

Instanzvariablen überleben nicht den Neustart, sie können jedoch z.B. im init-Block, der beim Systemstart ausgewertet wird, aus Readings vorbelegt werden.

Bsp. Vorbelgung einer Instanzvariablen beim Systemstart mit dem Status des Moduls:

init {$_status=get_State()}

Instanzvariablen lassen sich indizieren, z. B.:

my $i=0;

$_betrag{$i}=100;

Ebenso funktionieren hash-Variablen z. B.:
$_betrag{heute}=100;

Blockierende Funktionsaufrufe (blocking calls) back

DOIF verwaltet blockierende Funktionsaufrufe, d.h. die in diesem Zusammenhang gestarteten FHEM-Instanzen werden gelöscht, beim Herunterfahren (shutdown), Wiedereinlesen der Konfiguration (rereadcfg) Änderung der Konfiguration (modify) und Deaktivieren des Gerätes (disabled).

Die Handhabung von blockierenden Funktionsaufrufen ist im FHEMwiki erklärt, s. Blocking Call.

Der von der Funktion BlockingCall zurückgegebene Datensatz ist unterhalb von $_blockingcalls abzulegen, z.B.

$_blockingcalls{<blocking call name>} = ::BlockingCall(<blocking function>, <argument>, <finish function>, <timeout>, <abort function>, <abort argument>) unless(defined($_blockingcalls{<blocking call name>}));

Für unterschiedliche blockierende Funktionen ist jeweils ein eigener Name (<blocking call name>) unterhalb von $_blockingcalls anzulegen.

Wenn <blocking function>, <finish function> und <abort function> im Package DOIF definiert werden, dann ist dem Funktionsnamen DOIF:: voranzustellen, im Aufruf der Funktion BlockingCall, z.B. DOIF::<blocking function>

$_blockingcalls ist eine für DOIF reservierte Variable und darf nur in der beschriebener Weise verwendet werden.

Nutzbare Attribute im Perl-Modus back

Anwendungsbeispiele im Perlmodus: back

Treppenhauslicht mit Bewegungsmelder


define di_light DOIF {

  if (["FS:motion"]) {                          # bei Bewegung

    fhem_set("lamp on") if ([?lamp] ne "on");   # Lampe einschalten, wenn sie nicht an ist

    set_Exec("off",30,'fhem_set("lamp off")');  # Timer namens "off" für das Ausschalten der Lampe auf 30 Sekunden setzen bzw. verlängern

  }

}

Einknopf-Fernbedienung

Anforderung: Wenn eine Taste innerhalb von zwei Sekunden zwei mal betätig wird, soll der Rollladen nach oben, bei einem Tastendruck nach unten.


define di_shutter DOIF {

  if (["FS:^on$"] and !get_Exec("shutter")){          # wenn Taste betätigt wird und kein Timer läuft

    set_Exec("shutter",2,'fhem_set("shutter down")'); # Timer zum shutter down auf zwei Sekunden setzen

  } else {                                            # wenn Timer läuft, d.h. ein weitere Tastendruck innerhalb von zwei Sekunden

    del_Exec("shutter");                              # Timer löschen

    fhem_set("shutter up");                           # Rollladen hoch

  }

}

Aktion auslösen, wenn innerhalb einer bestimmten Zeitspanne ein Ereignis x mal eintritt

Im folgenden Beispiel wird die Nutzung von Device-Variablen demonstriert.


define di_count DOIF {

  if (["FS:on"] and !get_Exec("counter")) {                                        # wenn Ereignis (hier "FS:on") eintritt und kein Timer läuft

    $_count=1;                                                                     # setze count-Variable auf 1

    set_Exec("counter",3600,'Log (3,"count: $_count action") if ($_count > 10)');  # setze Timer auf eine Stunde zum Protokollieren der Anzahl der Ereignisse, wenn sie über 10 ist

  } else {

    $_count++;                                                                     # wenn Timer bereits läuft zähle Ereignis

  }

}

Verzögerte Fenster-offen-Meldung mit Wiederholung für mehrere Fenster


define di_window DOIF

subs {

  sub logwin {                                       # Definition der Funktion namens "logwin"

    my ($window)=@_;                                 # übernehme Parameter in die Variable $window

    Log 3,"Fenster offen, bitte schließen: $window"; # protokolliere Fenster-Offen-Meldung

    set_Exec ("$window",1800,"logwin",$window);      # setze Timer auf 30 Minuten für eine wiederholte Meldung

  }

}

{ if (["_window$:open"]) {set_Exec ("$DEVICE",600,'logwin',"$DEVICE")}} # wenn, Fenster geöffnet wird, dann setze Timer auf Funktion zum Loggen namens "logwin"

{ if (["_window$:closed"]) {del_Exec ("$DEVICE")}}                       # wenn, Fenster geschlossen wird, dann lösche Timer

DOIFtools

[EN DE]

erstellen von readingsGroup Definitionen, zur Beschriftung von Frontendelementen.
erstellen eines Debug-Logfiles, in dem mehrere DOIF und zugehörige Geräte geloggt werden.
optionales DOIF-Listing bei jeder Status und Wait-Timer Aktualisierung im Debug-Logfile.
Navigation zwischen den DOIF-Listings im Logfile, wenn es über DOIFtools geöffnet wird.
erstellen von userReadings in DOIF-Geräten zur Anzeige des realen Datums bei Wochentag behafteten Timern.
löschen von benutzerdefinierten Readings in DOIF-Definitionen über eine Mehrfachauswahl.
löschen von Readings in anderen Geräten über eine Mehrfachauswahl, nicht state.
erfassen statistischer Daten über Events.
Begrenzung der Datenaufzeichnungsdauer.
erstellen eines Statistikreports.
Liste aller DOIF-Definitionen in probably associated with.
Zugriff auf DOIFtools aus jeder DOIF-Definition über die Liste in probably associated with.
Zugriff aus DOIFtools auf vorhandene DOIFtoolsLog-Logdateien.
zeigt den Event Monitor in der Detailansicht von DOIFtools.
ermöglicht den Zugriff auf den Event Monitor in der Detailansicht von DOIF.
erzeugt DOIF-Operanden aus einer Event-Zeile des Event-Monitors.

Ist der Event-Monitor in DOIF geöffnet, dann kann die Definition des DOIF geändert werden.
Ist der Event-Monitor in DOIFtools geöffnet, dann kann die Definition eines DOIF erzeugt werden.

prüfen der Definitionen mit Empfehlungen für DOIF-Modus FHEM.
erstellen von Shortcuts
optionalen Menüeintrag erstellen
Liste der laufenden Wait-Timer anzeigen
skaliert Werte zu Farbnummern und RGB Werten zum Einfärben, z.B. von Icons.

Inhalt

Bedienungsanleitung

Bedienungsanleitung für DOIFtools

Definition

define <name> DOIFtools

probably associated with

Definitionsvorschlag

Raw definition


        defmod DOIFtools DOIFtools

        attr DOIFtools DOIFtoolsEventMonitorInDOIF 1

        attr DOIFtools DOIFtoolsExecuteDefinition 1

        attr DOIFtools DOIFtoolsExecuteSave 1

        attr DOIFtools DOIFtoolsMenuEntry 1

        attr DOIFtools DOIFtoolsMyShortcuts ##My Shortcuts:,,list DOIFtools,fhem?cmd=list DOIFtools,remove_DOIFtoolsLog,fhem?cmd=delete DOIFtoolsLog;%22rm ./log/DOIFtoolsLog*.log%22

Set

set <name> deleteReadingInTargetDOIF <readings to delete name>
deleteReadingInTargetDOIF löscht die benutzerdefinierten Readings im Ziel-DOIF
set <name> targetDOIF <target name>
targetDOIF vor dem Löschen der Readings muss das Ziel-DOIF gesetzt werden.
set <name> deleteReadingInTargetDevice <readings to delete name>
deleteReadingInTargetDevice löscht sichtbare Readings, ausser state im Ziel-Gerät. Bitte den Gefahrenhinweis zum Befehl deletereading beachten ! Commandref#deletereading
set <name> targetDevice <target name>
targetDevice vor dem Löschen der Readings muss das Ziel-Gerät gesetzt werden.
set <name> sourceAttribute <readingList>
sourceAttribute vor dem Erstellen einer ReadingsGroup muss das Attribut gesetzt werden aus dem die Readings gelesen werden, um die ReadingsGroup zu erstellen und zu beschriften. Default, readingsList
set <name> statisticsDeviceFilterRegex <regular expression as device filter>
statisticsDeviceFilterRegex setzt einen Filter auf Gerätenamen, nur die gefilterten Geräte werden im Bericht ausgewertet. Default, ".*".
set <name> statisticsTYPEs <List of TYPE used for statistics generation>
statisticsTYPEs setzt eine Liste von TYPE für die Statistikdaten erfasst werden, bestehende Statistikdaten werden gelöscht. Default, "".
set <name> statisticsShowRate_ge <integer value for event rate>
statisticsShowRate_ge setzt eine Event-Rate, ab der ein Gerät in die Auswertung einbezogen wird. Default, 0.
set <name> specialLog <0|1>
specialLog 1 DOIF-Listing bei Status und Wait-Timer Aktualisierung im Debug-Logfile. Default, 0.
set <name> doStatistics <enabled|disabled|deleted>
doStatistics
deleted setzt die Statistik zurück und löscht alle stat_ Readings.
disabled pausiert die Statistikdatenerfassung.
enabled startet die Statistikdatenerfassung.
set <name> recording_target_duration <hours>
recording_target_duration gibt an wie lange Daten erfasst werden sollen. Default, 0 die Dauer ist nicht begrenzt.

Get

get <name> DOIF_to_Log <DOIF names for logging>
DOIF_to_Log erstellt eine FileLog-Definition, die für alle angegebenen DOIF-Definitionen loggt. Der Reguläre Ausdruck wird aus den, direkt in den DOIF-Greräte angegebenen und den wahrscheinlich verbundenen Geräten, ermittelt.
get <name> checkDOIF
checkDOIF führt eine einfache Syntaxprüfung durch und empfiehlt Änderungen für DOIF-Modus FHEM.
get <name> readingsGroup_for <DOIF names to create readings groups>
readingsGroup_for erstellt readingsGroup-Definitionen für die angegebenen DOIF-namen. sourceAttribute verweist auf das Attribut, dessen Readingsliste als Basis verwendet wird. Die Eingabeelemente im Frontend werden mit den Readingsnamen beschriftet.
get <name> userReading_nextTimer_for <DOIF names where to create real date timer readings>
userReading_nextTimer_for erstellt userReadings-Attribute für Timer-Readings mit realem Datum für Timer, die mit Wochentagangaben angegeben sind, davon ausgenommen sind indirekte Wochentagsangaben.
get <name> statisticsReport
statisticsReport erstellt einen Bericht aus der laufenden Datenerfassung.

Die Statistik kann genutzt werden, um Geräte mit hohen Ereignisaufkommen zu erkennen. Bei einer hohen Rate, sollte im Interesse der Systemperformance geprüft werden, ob die Events eingeschränkt werden können. Werden keine Events eines Gerätes weiterverarbeitet, kann das Attribut event-on-change-reading auf none oder eine andere Zeichenfolge, die im Gerät nicht als Readingname vorkommt, gesetzt werden.FHEM-Wiki: Events
get <name> runningTimerInDOIF
runningTimerInDOIF zeigt eine Liste der laufenden Timer. Damit kann entschieden werden, ob bei einem Neustart wichtige Timer gelöscht werden und der Neustart ggf. verschoben werden sollte. Zeigt nachrichtlich das Ergebnis von blockinginfo an.
get <name> SetAttrIconForDOIF <DOIF names for setting the attribute icon to helper_doif>
SetAttrIconForDOIF setzt für die ausgewählten DOIF das Attribut icon auf helper_doif.
get <name> linearColorGradient <start color number>,<end color number>,<minimal value>,<maximal value>,<step width>
linearColorGradient erzeugt eine Tabelle mit linear abgestuften Farbnummern und RGB-Werten.
<start color number>, ist eine HTML-Farbnummer, Beispiel: #0000FF für Blau.
<end color number>, , ist eine HTML-Farbnummer, Beispiel: #FF0000 für Rot.
<minimal value>, der Minimalwert auf den die Startfarbnummer skaliert wird, Beispiel: 7.
<maximal value>, der Maximalwert auf den die Endfarbnummer skaliert wird, Beispiel: 30.
<step width>, für jeden Schritt wird ein Farbwert erzeugt, Beispiel: 0.5.
Beispiel: get DOIFtools linearColorGradient #0000FF,#FF0000,7,30,0.5
get <name> modelColorGradient <minimal value>,<middle value>,<maximal value>,<step width>,<color model>
modelColorGradient erzeugt eine Tabelle mit modellbedingt abgestuften Farbnummern und RGB-Werten, siehe FHEM-Wiki Farbskala mit Color::pahColor
<minimal value>, der Minimalwert auf den die Startfarbnummer skaliert wird, Beispiel: 7.
<middle value>, der Mittenwert ist ein Fixpunkt zwischen Minimal- u. Maximalwert, Beispiel: 20.
<maximal value>, der Maximalwert auf den die Endfarbnummer skaliert wird, Beispiel: 30.
<step width>, für jeden Schritt wird ein Farbwert erzeugt, Beispiel: 1.
<color model>, die Angabe eines vordefinierten Modells <0|1|2> oder fünf RGB-Werte als Array [r1,g1,b1,r2,g2,b2,r3,g3,b3,r4,g4,b4,r5,g5,b5] für ein eigenes Model.

Beispiele:
get DOIFtools modelColorGradient 7,20,30,1,0
get DOIFtools modelColorGradient 0,50,100,5,[255,255,0,127,255,0,0,255,0,0,255,255,0,127,255]
Farbskala mit Color::pahColor
get <name> hsvColorGradient <HUE start value>,<HUE end value>,<minimal value>,<maximal value>,<step width>,<saturation>,<lightness>
hsvColorGradient erzeugt eine Tabelle über HUE-Werte abgestufte Farbnummern und RGB-Werten.
<Hue start value>, der HUE-Startwert, Beispiel: 240 für Blau.
<HUE end value>, der HUE-Endwert, Beispiel: 360 für Rot.
<minimal value>, der Minimalwert auf den der HUE-Startwert skaliert wird, Beispiel: 7.
<maximal value>, der Maximalwert auf den der HUE-Endwert skaliert wird, Beispiel: 30.
<step width>, für jeden Schritt wird ein Farbwert erzeugt, Beispiel: 1.
<saturation>, die Angabe eines Wertes für die Farbsättigung <0-100>, Beispiel 80.
<lightness>, die Angabe eines Wertes für die Helligkeit <0-100>, Beispiel 80.

Beispiele:
get DOIFtools hsvColorGradient 240,360,7,30,1,80,80

Attribute

attr <name> DOIFtoolsExecuteDefinition <0|1>
DOIFtoolsExecuteDefinition 1 führt die erzeugten Definitionen aus. Default 0, zeigt die erzeugten Definitionen an, sie können mit Raw definition importiert werden.
attr <name> DOIFtoolsExecuteSave <0|1>
DOIFtoolsExecuteSave 1, die Definitionen werden automatisch gespeichert. Default 0, der Benutzer kann die Definitionen speichern.
attr <name> DOIFtoolsTargetGroup <group names for target>
DOIFtoolsTargetGroup gibt die Gruppen für die zu erstellenden Definitionen an. Default, die Gruppe der Ursprungs Definition.
attr <name> DOIFtoolsTargetRoom <room names for target>
DOIFtoolsTargetRoom gibt die Räume für die zu erstellenden Definitionen an. Default, der Raum der Ursprungs Definition.
attr <name> DOIFtoolsReadingsPrefix <user defined prefix>
DOIFtoolsReadingsPrefix legt den Präfix der benutzerdefinierten Readingsnamen für die Zieldefinition fest. Default, DOIFtools bestimmt den Präfix.
attr <name> DOIFtoolsEventMonitorInDOIF <1|0>
DOIFtoolsEventMonitorInDOIF 1, die Anzeige des Event-Monitors wird in DOIF ermöglicht. Default 0, kein Zugriff auf den Event-Monitor im DOIF.
attr <name> DOIFtoolsEMbeforeReadings <1|0>
DOIFtoolsEMbeforeReading 1, die Anzeige des Event-Monitors wird in DOIF direkt über den Readings angezeigt. Default 0, anzeige des Event-Monitors über den Internals.
attr <name> DOIFtoolsHideGetSet <0|1>
DOIFtoolsHideGetSet 1, verstecken der Set- und Get-Shortcuts. Default 0.
attr <name> DOIFtoolsNoLookUp <0|1>
DOIFtoolsNoLookUp 1, es werden keine Lookup-Fenster in DOIFtools geöffnet. Default 0.
attr <name> DOIFtoolsNoLookUpInDOIF <0|1>
DOIFtoolsNoLookUpInDOIF 1, es werden keine Lookup-Fenster in DOIF geöffnet. Default 0.
attr <name> DOIFtoolsHideModulShortcuts <0|1>
DOIFtoolsHideModulShortcuts 1, verstecken der DOIFtools Shortcuts. Default 0.
attr <name> DOIFtoolsHideStatReadings <0|1>
DOIFtoolsHideStatReadings 1, verstecken der stat_ Readings. Das Ändern des Attributs löscht eine bestehende Event-Aufzeichnung. Default 0.
attr <name> DOIFtoolsEventOnDeleted <0|1>
DOIFtoolsEventOnDeleted 1, es werden Events für alle stat_ erzeugt, bevor sie gelöscht werden. Damit könnten die erfassten Daten geloggt werden. Default 0.
attr <name> DOIFtoolsMyShortcuts <shortcut name>,<command>, ...
DOIFtoolsMyShortcuts <Bezeichnung>,<Befehl>,... anzeigen eigener Shortcuts, siehe globales Attribut menuEntries.
Zusätzlich gilt, wenn ein Eintrag mit ## beginnt und mit ,, endet, wird er als HTML interpretiert.
Beispiel:
attr DOIFtools DOIFtoolsMyShortcuts ##<br>My Shortcuts:,,list DOIFtools,fhem?cmd=list DOIFtools
menuEntries
attr <name> DOIFtoolsMenuEntry <0|1>
DOIFtoolsMenuEntry 1, erzeugt einen Menüeintrag im FHEM-Menü. Default 0.
attr <name> DOIFtoolsLogDir <path to DOIFtools logfile>
DOIFtoolsLogDir <path>, gibt den Pfad zum Logfile an Default ./log oder der Pfad aus dem Attribut global logdir.

disabledForIntervals pausiert die Statistikdatenerfassung.

Readings

Action zeigt den Status der Event-Aufzeichnung an.
DOIF_version zeigt die Version des DOIF an.
FHEM_revision zeigt die Revision von FHEM an.
doStatistics zeigt den Status der Statistikerzeugung an
logfile gibt den Pfad und den Dateinamen mit Ersetzungszeichen an.
recording_target_duration gibt an wie lange Daten erfasst werden sollen.
stat_<devicename> zeigt die Anzahl der gezählten Ereignisse, die das jeweilige Gerät erzeugt hat.
statisticHours zeigt die kumulierte Zeit für den Status enabled an, während der, Statistikdaten erfasst werden.
statisticShowRate_ge zeigt die Event-Rate, ab der Geräte in die Auswertung einbezogen werden.
statisticsDeviceFilterRegex zeigt den aktuellen Gerätefilterausdruck an.
statisticsTYPEs zeigt eine Liste von TYPE an, für deren Geräte die Statistik erzeugt wird.
targetDOIF zeigt das Ziel-DOIF, bei dem Readings gelöscht werden sollen.
targetDevice zeigt das Ziel-Gerät, bei dem Readings gelöscht werden sollen.

Links

DOIFtools im FHEM-Forum

DOIFtools im FHEM-Wiki

DOIF im FHEM-Wiki

Erste Schritte mit DOIF

DOIF: Einsteigerleitfaden, Grundfunktionen und Erläuterungen

DOIF-Labor - ausführbare, praxisnahe Beispiele als Problemlösung zum Experimentieren

DOIF: Tipps zur leichteren Bedienung

DOIF: Tools und Fehlersuche

DUOFERN

DUOFERNSTICK

DWD_OpenData

[EN DE]

Open Data Server

OpenData_weather_content.xls

FHEMWiki

DWD_OpenData

Dashboard

[EN DE]

Define

define <name> Dashboard

define anyViews Dashboard

Bestpractice Anfängerkonfiguration


	define anyViews Dashboard

	attr anyViews dashboard_colcount 2

	attr anyViews dashboard_rowcentercolwidth 30,70

	attr anyViews dashboard_tab1groups <Group1>,<Group2>,<Group3>

Set

set <name> lock

set <name> unlock

Get

N/A

Attributes

dashboard_tabcount
Gibt die Anzahl der angezeigten Tabs an. (Dieser Parameter is veraletet, die Anzahl der Tabs wird aus der Dashboard-Konfiguration gelesen) Standard: 1

dashboard_activetab
Gibt an welches Tab aktiviert ist. Kann manuell gesetzt werden, wird aber auch durch den Schalter "Set" auf das gerade aktive Tab gesetzt. Standard: 1

dashboard_tabXname
Titel des X. Tab.

dashboard_tabXsorting
Enthält die Poistionierung jeder Gruppe im Tab X. Der Wert wird mit der Schaltfläche "Set" geschrieben. Es wird nicht empfohlen dieses Attribut manuelle zu ändern

dashboard_row
Auswahl welche Zeilen angezeigt werden sollen. top (nur Oben), center (nur Mitte), bottom (nur Unten) und den Kombinationen daraus.
Standard: center

dashboard_width
Zum bestimmen der Dashboardbreite. Der Wert kann in % (z.B. 80%) angegeben werden oder als absolute Breite (z.B. 1200) in Pixel.
Standard: 100%

dashboard_rowcenterheight
Höhe der mittleren Zeile, in der die Gruppen angeordnet werden.
Standard: 400

dashboard_rowcentercolwidth
Über dieses Attribut wird die Breite der einzelnen Spalten der mittleren Dashboardreihe festgelegt. Dabei kann je Spalte ein separater Wert hinterlegt werden. Die Werte sind durch ein Komma (ohne Leerzeichen) zu trennen. Jeder Wert bestimmt die Spaltenbreite in %! Der erste Wert gibt die Breite der ersten Spalte an, der zweite Wert die Breite der zweiten Spalte usw. Ist die Summe der Breite größer als 100 werden die Spaltenbreiten reduziert. Sind mehr Spalten als Breiten definiert werden die fehlenden Breiten um die Differenz zu 100 festgelegt. Sind hingegen weniger Spalten als Werte definiert werden die überschüssigen Werte ignoriert.
Standard: 100

dashboard_rowtopheight
Höhe der oberen Zeile, in der die Gruppen angeordnet werden.
Standard: 250

"dashboard_rowbottomheight
Höhe der unteren Zeile, in der die Gruppen angeordnet werden.
Standard: 250

dashboard_tab1groups
Durch Komma getrennte Liste mit den Namen der Gruppen, die im Tab 1 angezeigt werden. Falsche Gruppennamen werden hervorgehoben.
Jede Gruppe kann zusätzlich ein Icon anzeigen, dazu muss der Gruppen name um ":<icon>@<farbe>"ergänzt werden
Beispiel: Light:Icon_Fisch@blue,AVIcon_Fisch@red,Single Lights:Icon_Fisch@yellow
Der Gruppenname kann ebenfalls einen regulären Ausdruck beinhalten, um alle Gruppen anzuzeigen, die darauf passen.
Beispiel: .*Licht.* zeigt alle Gruppen an, die das Wort "Licht" im Namen haben.

dashboard_tabXdevices
devspec Liste von Geräten, die im Tab angezeigt werden sollen. Das format ist:
GROUPNAME:devspec1,devspec2,...,devspecN:ICONNAME
Das Icon ist optional. Auch der Gruppenname muss nicht vorhanden sein. Im Falle dass dieser fehlt, werden die gefunden Geräte nicht gruppiert sondern als einzelne Widgets im Tab angezeigt. Für weitere Details bezüglich devspec: Dev-Spec

dashboard_tabXicon
Zeigt am Tab ein Icon an. Es muss sich dabei um ein exisitereindes Icon mit modpath Verzeichnis handeln. Handelt es sich um ein SVG Icon kann der Suffix @colorname für die Farbe des Icons angegeben werden.

dashboard_colcount
Die Anzahl der Spalten in der Gruppen dargestellt werden können. Dennoch ist es möglich, mehrere Gruppen
in einer Spalte nebeneinander zu positionieren. Dies ist abhängig von der Breite der Spalten und Gruppen.
Gilt nur für die mittlere Spalte!
Standard: 1

dashboard_tabXcolcount
Die Anzahl der Spalten im Tab X in der Gruppen dargestellt werden können. Dennoch ist es möglich, mehrere Gruppen
in einer Spalte nebeneinander zu positionieren. Dies ist abhängig von der Breite der Spalten und Gruppen.
Gilt nur für die mittlere Spalte!
Standard:

dashboard_tabXbackgroundimage
Zeigt ein Hintergrundbild für den X-ten Tab an. Das Bild wird nicht gestreckt, es sollte also auf die Größe des Tabs passen oder diese überschreiten. Standard:

dashboard_flexible
Hat dieser Parameter einen Wert > 0, dann können die Widgets in den Tabs frei positioniert werden und hängen nicht mehr an den Spalten fest. Der Wert gibt ebenfalls das Raster an, in dem die Positionierung "zu schnappt". Standard: 0

dashboard_showfullsize
Blendet die FHEMWEB Raumliste (kompleter linker Bereich der Seite) und den oberen Bereich von FHEMWEB aus wenn der Wert auf 1 gesetzt ist.
Default: 0

dashboard_showtabs
Zeigt die Tabs/Schalterleiste des Dashboards oben oder unten an, oder blendet diese aus. Wenn die Schalterleiste ausgeblendet wird ist das Dashboard gespert.
Standard: tabs-and-buttonbar-at-the-top

dashboard_showtogglebuttons
Zeigt eine Schaltfläche in jeder Gruppe mit der man diese auf- und zuklappen kann.
Standard: 0

dashboard_backgroundimage
Zeig in Hintergrundbild im Dashboard an. Das Bild wird nicht gestreckt, es sollte daher auf die Größe des Dashboards passen oder diese überschreiten. Default:

dashboard_debug
Zeigt Debug-Felder an. Sollte nicht gesetzt werden!
Standard: 0

DbLog

[EN DE]

Voraussetzungen

DBI

DBD::<dbtype>

cpan -i <module>

DBI	: `sudo apt-get install libdbi-perl`
MySQL	: `sudo apt-get install [mysql-server] mysql-client libdbd-mysql libdbd-mysql-perl` (mysql-server nur bei lokaler MySQL-Server-Installation)
SQLite	: `sudo apt-get install sqlite3 libdbi-perl libdbd-sqlite3-perl`
PostgreSQL	: `sudo apt-get install libdbd-pg-perl`

Vorbereitungen

Hinweis:

SVN -> contrib/dblog/db_create_<DBType>.sql

Achtung:

current

history

current

history

SVN -> contrib/dblog/db_create_<DBType>.sql

current

history

TIMESTAMP	: Zeitpunkt des Events, z.B. `2007-12-30 21:45:22`
DEVICE	: Name des Devices, z.B. `Wetterstation`
TYPE	: Type des Devices, z.B. `KS300`
EVENT	: das auftretende Event als volle Zeichenkette, z.B. `humidity: 71 (%)`
READING	: Name des Readings, ermittelt aus dem Event, z.B. `humidity`
VALUE	: aktueller Wert des Readings, ermittelt aus dem Event, z.B. `71`
UNIT	: Einheit, ermittelt aus dem Event, z.B. `%`

Index anlegen

Index "Search_Idx"

MySQL	: CREATE INDEX Search_Idx ON `fhem`.`history` (DEVICE, READING, TIMESTAMP);
SQLite	: CREATE INDEX Search_Idx ON `history` (DEVICE, READING, TIMESTAMP);
PostgreSQL	: `CREATE INDEX "Search_Idx" ON history USING btree (device, reading, "timestamp");`

Konfigurationsdatei

list

Konfigurationsdatei

    ####################################################################################
    # database configuration file     
    # 	
    # NOTE:
    # If you don't use a value for user / password please delete the leading hash mark
    # and write 'user => ""' respectively 'password => ""' instead !	
    #
    #
    ## for MySQL                                                      
    ####################################################################################
    #%dbconfig= (                                                    
    #    connection => "mysql:database=fhem;host=<database host>;port=3306",    
    #    user => "fhemuser",                                          
    #    password => "fhempassword",
    #    # optional enable(1) / disable(0) UTF-8 support (at least V 4.042 is necessary) 	
    #    utf8 => 1   
    #);                                                              
    ####################################################################################
    #                                                                
    ## for PostgreSQL                                                
    ####################################################################################
    #%dbconfig= (                                                   
    #    connection => "Pg:database=fhem;host=<database host>",        
    #    user => "fhemuser",                                     
    #    password => "fhempassword"                              
    #);                                                              
    ####################################################################################
    #                                                                
    ## for SQLite (username and password stay empty for SQLite)      
    ####################################################################################
    #%dbconfig= (                                                   
    #    connection => "SQLite:dbname=/opt/fhem/fhem.db",        
    #    user => "",                                             
    #    password => ""                                          
    #);                                                              
    ####################################################################################

Hinweis zu Sonderzeichen:

Define

define <name> DbLog <configfilename> <regexp>

<configfilename>

Konfigurationsdatei

<regexp>

FileLog

Beispiel:

define myDbLog DbLog /etc/fhem/db.conf .*:.*

Konfigurationscheck

set <name> configCheck

yes

1

get myDbLog - - 2012-11-10 2012-11-10 KS300:temperature

FileLog-Dateien nach DbLog übertragen

hier

Forumthread

Reporting und Management von DbLog-Datenbankinhalten

SVG

DbRep

Troubleshooting

Wurden die vorbereitenden Schritte gemacht, die in der commandref beschrieben sind ? (Softwarekomponenten installieren, Tabellen, Index anlegen)
Wurde ein "set <name> configCheck" nach dem Define durchgeführt und eventuelle Fehler beseitigt bzw. Empfehlungen umgesetzt ?
Falls configDB in Benutzung ... wurde das DB-Konfigurationsfile in configDB importiert (z.B. mit "configDB fileimport ./db.conf") ?
Beim Anlegen eines SVG-Plots erscheint keine Drop-Down Liste mit Vorschlagswerten -> Attribut "DbLogType" auf "Current/History" setzen.

Set

Beispiel:

set <name> addLog <devspec>:<Reading> [Value] [CN=<caller name>] [!useExcludes]

<devspec>:<Reading> - Das Device kann als Geräte-Spezifikation angegeben werden.
Die Angabe von "Reading" wird als regulärer Ausdruck ausgewertet. Ist das Reading nicht vorhanden und der Wert "Value" angegeben, wird das Reading in die DB eingefügt wenn es kein regulärer Ausdruck und ein valider Readingname ist.
Value - Optional kann "Value" für den Readingwert angegeben werden. Ist Value nicht angegeben, wird der aktuelle Wert des Readings in die DB eingefügt.
CN=<caller name> - Mit dem Schlüssel "CN=" (Caller Name) kann dem addLog-Aufruf ein String, z.B. der Name des aufrufenden Devices (z.B. eines at- oder notify-Devices), mitgegeben werden. Mit Hilfe der im Attribut "valueFn" hinterlegten Funktion kann dieser Schlüssel über die Variable $CN ausgewertet werden. Dadurch ist es möglich, das Verhalten des addLogs abhängig von der aufrufenden Quelle zu beeinflussen.
!useExcludes - Ein eventuell im Quell-Device gesetztes Attribut "DbLogExclude" wird von der Funktion berücksichtigt. Soll dieses Attribut nicht berücksichtigt werden, kann das Schüsselwort "!useExcludes" verwendet werden.

Beispiele:

set <name> clearReadings

Leert Readings die von verschiedenen DbLog-Funktionen angelegt wurden.

set <name> eraseReadings

Löscht alle Readings außer dem Reading "state".

set <name> commitCache

set <name> configCheck

Es werden einige wichtige Einstellungen geprüft und Empfehlungen gegeben falls potentielle Verbesserungen identifiziert wurden.

set <name> count

Zählt die Datensätze in den Tabellen current und history und schreibt die Ergebnisse in die Readings countCurrent und countHistory.

set <name> countNbl

Hinweis:

set <name> deleteOldDays <n>

Löscht Datensätze in Tabelle history, die älter sind als <n> Tage sind. Die Anzahl der gelöschten Datensätze wird in das Reading lastRowsDeleted geschrieben.

set <name> deleteOldDaysNbl <n>

Hinweis:

set <name> exportCache [nopurge | purgecache]

set <name> importCachefile <file>

set <name> listCache

Wenn DbLog im asynchronen Modus betrieben wird (Attribut asyncMode=1), können mit diesem Befehl die im Speicher gecachten Events angezeigt werden.

set <name> purgeCache

set <name> reduceLog <no>[:<nn>] [average[=day]] [exclude=device1:reading1,device2:reading2,...]

SQL-Wildcards "%" und "_"

Beispiel:

ACHTUNG:

komplett blockiert !

set <name> reduceLogNbl <no>[:<nn>] [average[=day]] [exclude=device1:reading1,device2:reading2,...]

Hinweis:

set <name> reopen [n]

set <name> rereadcfg

set <name> userCommand <validSqlStatement>

DbRep

Get

get <name> ReadingsVal <device> <reading> <default>

get <name> ReadingsTimestamp <device> <reading> <default>

get <name> <infile> <outfile> <from>
          <to> <column_spec>

<in>
Ein Parameter um eine Kompatibilität zum Filelog herzustellen. Dieser Parameter ist per default immer auf - zu setzen.
Folgende Ausprägungen sind zugelassen:
- current: die aktuellen Werte aus der Tabelle "current" werden gelesen.
- history: die historischen Werte aus der Tabelle "history" werden gelesen.
- -: identisch wie "history"
<out>
Ein Parameter um eine Kompatibilität zum Filelog herzustellen. Dieser Parameter ist per default immer auf - zu setzen um die Ermittlung der Daten aus der Datenbank für die Plotgenerierung zu prüfen.
Folgende Ausprägungen sind zugelassen:
- ALL: Es werden alle Spalten der Datenbank ausgegeben. Inclusive einer Überschrift.
- Array: Es werden alle Spalten der Datenbank als Hash ausgegeben. Alle Datensätze als Array zusammengefasst.
- INT: intern zur Plotgenerierung verwendet
- -: default
<from> / <to>
Wird benutzt um den Zeitraum der Daten einzugrenzen. Es ist das folgende Zeitformat oder ein Teilstring davon zu benutzen:
<column_spec>
Für jede column_spec Gruppe wird ein Datenset zurückgegeben welches durch einen Kommentar getrennt wird. Dieser Kommentar repräsentiert die column_spec.
Syntax: <device>:<reading>:<default>:<fn>:<regexp>
- <device>
  Der Name des Devices. Achtung: Gross/Kleinschreibung beachten!
  Es kann ein % als Jokerzeichen angegeben werden.
- <reading>
  Das Reading des angegebenen Devices zur Datenselektion.
  Es kann ein % als Jokerzeichen angegeben werden.
  Achtung: Gross/Kleinschreibung beachten!
- <default>
  Zur Zeit noch nicht implementiert.
- <fn> Angabe einer speziellen Funktion:
  - int
    Ermittelt den Zahlenwert ab dem Anfang der Zeichenkette aus der Spalte "VALUE". Benutzt z.B. für Ausprägungen wie 10%.
  - int<digit>
    Ermittelt den Zahlenwert ab dem Anfang der Zeichenkette aus der Spalte "VALUE", inclusive negativen Vorzeichen und Dezimaltrenner. Benutzt z.B. für Auspägungen wie -5.7°C.
  - delta-h / delta-d
    Ermittelt die relative Veränderung eines Zahlenwertes pro Stunde oder pro Tag. Wird benutzt z.B. für Spalten die einen hochlaufenden Zähler enthalten wie im Falle für ein KS300 Regenzähler oder dem 1-wire Modul OWCOUNT.
  - delta-ts
    Ermittelt die vergangene Zeit zwischen dem letzten und dem aktuellen Logeintrag in Sekunden und ersetzt damit den originalen Wert.
- <regexp>
  Diese Zeichenkette wird als Perl Befehl ausgewertet. Die regexp wird vor dem angegebenen <fn> Parameter ausgeführt.
  Bitte zur Beachtung: Diese Zeichenkette darf keine Leerzeichen enthalten da diese sonst als <column_spec> Trennung interpretiert werden und alles nach dem Leerzeichen als neue <column_spec> gesehen wird.
  Schlüsselwörter
- $val ist der aktuelle Wert die die Datenbank für ein Device/Reading ausgibt.
- $ts ist der aktuelle Timestamp des Logeintrages.
- Wird als $val das Schlüsselwort "hide" zurückgegeben, so wird dieser Logeintrag nicht ausgegeben, trotzdem aber für die Zeitraumberechnung verwendet.
- Wird als $val das Schlüsselwort "ignore" zurückgegeben, so wird dieser Logeintrag nicht für eine Folgeberechnung verwendet.

Beispiele:

get myDbLog - - 2012-11-10 2012-11-20 KS300:temperature
get myDbLog current ALL - - %:temperature

get myDbLog - - 2012-11-10_10 2012-11-10_20 KS300:temperature::int1
gibt Daten aus von 10Uhr bis 20Uhr am 10.11.2012
get myDbLog - all 2012-11-10 2012-11-20 KS300:temperature
get myDbLog - - 2012-11-10 2012-11-20 KS300:temperature KS300:rain::delta-h KS300:rain::delta-d
get myDbLog - - 2012-11-10 2012-11-20 MyFS20:data:::$val=~s/(on|off).*/$1eq"on"?1:0/eg
gibt 1 zurück für alle Ausprägungen von on* (on|on-for-timer etc) und 0 für alle off*
get myDbLog - - 2012-11-10 2012-11-20 Bodenfeuchte:data:::$val=~s/.*B:\s([-\.\d]+).*/$1/eg
Beispiel von OWAD: Ein Wert wie z.B.: "A: 49.527 % B: 66.647 % C: 9.797 % D: 0.097 V"
und die Ausgabe ist für das Reading B folgende: 2012-11-20_10:23:54 66.647
get DbLog - - 2013-05-26 2013-05-28 Pumpe:data::delta-ts:$val=~s/on/hide/
Realisierung eines Betriebsstundenzählers. Durch delta-ts wird die Zeit in Sek zwischen den Log- Einträgen ermittelt. Die Zeiten werden bei den on-Meldungen nicht ausgegeben welche einer Abschaltzeit entsprechen würden.

Get

get <name> <infile> <outfile> <from>
          <to> <device> <querytype> <xaxis> <yaxis> <savename>

<name>
Der Name des definierten DbLogs, so wie er in der fhem.cfg angegeben wurde.
<in>
Ein Dummy Parameter um eine Kompatibilität zum Filelog herzustellen. Dieser Parameter ist immer auf - zu setzen.
<out>
Ein Dummy Parameter um eine Kompatibilität zum Filelog herzustellen. Dieser Parameter ist auf webchart zu setzen um die Charting Get Funktion zu nutzen.
<from> / <to>
Wird benutzt um den Zeitraum der Daten einzugrenzen. Es ist das folgende Zeitformat zu benutzen:
<device>
Ein String, der das abzufragende Device darstellt.
<querytype>
Ein String, der die zu verwendende Abfragemethode darstellt. Zur Zeit unterstützte Werte sind:
getreadings um für ein bestimmtes device alle Readings zu erhalten
getdevices um alle verfügbaren devices zu erhalten
timerange um Chart-Daten abzufragen. Es werden die Parameter 'xaxis', 'yaxis', 'device', 'to' und 'from' benötigt
savechart um einen Chart unter Angabe eines 'savename' und seiner zugehörigen Konfiguration abzuspeichern
deletechart um einen zuvor gespeicherten Chart unter Angabe einer id zu löschen
getcharts um eine Liste aller gespeicherten Charts zu bekommen.
getTableData um Daten aus der Datenbank abzufragen und in einer Tabelle darzustellen. Benötigt paging Parameter wie start und limit.
hourstats um Statistiken für einen Wert (yaxis) für eine Stunde abzufragen.
daystats um Statistiken für einen Wert (yaxis) für einen Tag abzufragen.
weekstats um Statistiken für einen Wert (yaxis) für eine Woche abzufragen.
monthstats um Statistiken für einen Wert (yaxis) für einen Monat abzufragen.
yearstats um Statistiken für einen Wert (yaxis) für ein Jahr abzufragen.
<xaxis>
Ein String, der die X-Achse repräsentiert
<yaxis>
Ein String, der die Y-Achse repräsentiert
<savename>
Ein String, unter dem ein Chart in der Datenbank gespeichert werden soll
<chartconfig>
Ein jsonstring der den zu speichernden Chart repräsentiert
<pagingstart>
Ein Integer um den Startwert für die Abfrage 'getTableData' festzulegen
<paginglimit>
Ein Integer um den Limitwert für die Abfrage 'getTableData' festzulegen

Beispiele:

get logdb - webchart "" "" "" getcharts
Liefert alle gespeicherten Charts aus der Datenbank
get logdb - webchart "" "" "" getdevices
Liefert alle verfügbaren Devices aus der Datenbank
get logdb - webchart "" "" ESA2000_LED_011e getreadings
Liefert alle verfügbaren Readings aus der Datenbank unter Angabe eines Gerätes
get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e timerange TIMESTAMP day_kwh
Liefert Chart-Daten, die auf folgenden Parametern basieren: 'xaxis', 'yaxis', 'device', 'to' und 'from'
Die Ausgabe erfolgt als JSON, z.B.: [{'TIMESTAMP':'2013-02-11 00:10:10','VALUE':'0.22431388090756'},{'TIMESTAMP'.....}]
get logdb - webchart 2013-02-11_00:00:00 2013-02-12_00:00:00 ESA2000_LED_011e savechart TIMESTAMP day_kwh tageskwh
Speichert einen Chart unter Angabe eines 'savename' und seiner zugehörigen Konfiguration
get logdb - webchart "" "" "" deletechart "" "" 7
Löscht einen zuvor gespeicherten Chart unter Angabe einer id

Attribute

addStateEvent

asyncMode

bulkInsert

commitMode

cacheEvents

cacheLimit

colEvent

colReading

colValue

DbLogType


	   attr <device> DbLogType [Current|History|Current/History|SampleFill/History]

history

Current	Events werden nur in die current-Tabelle geloggt. Die current-Tabelle wird bei der SVG-Erstellung ausgewertet.
History	Events werden nur in die history-Tabelle geloggt. Es wird keine DropDown-Liste mit Vorschlägen bei der SVG-Erstellung erzeugt.
Current/History	Events werden sowohl in die current- also auch in die hitory Tabelle geloggt. Die current-Tabelle wird bei der SVG-Erstellung ausgewertet.
SampleFill/History	Events werden nur in die history-Tabelle geloggt. Die current-Tabelle wird bei der SVG-Erstellung ausgewertet und kann zur Erzeugung einer DropDown-Liste mittels einem DbRep-Device "set <DbRep-Name> tableCurrentFillup" mit einem einstellbaren Extract der history-Tabelle gefüllt werden (advanced Feature).

Hinweis:

DbLogSelectionMode

DbLogInclude

DbLogExclude

DbLogValueFn

disable

excludeDevs

expimpdir

exportCacheAppend

noNotifyDev

noSupportPK

showproctime

showNotifyTime

syncEvents

syncInterval

suppressAddLogV3

suppressUndef

timeout

traceFlag


	  attr <device> traceFlag [ALL|SQL|CON|ENC|DBD|TXN]

ALL	schaltet alle DBI- und Treiberflags an.
SQL	verfolgt die SQL Statement Ausführung. (Default)
CON	verfolgt den Verbindungsprozess.
ENC	verfolgt die Kodierung (Unicode Übersetzung etc).
DBD	verfolgt nur DBD Nachrichten.
TXN	verfolgt Transaktionen.

traceLevel


	  attr <device> traceLevel [0|1|2|3|4|5|6|7]

Achtung !

sehr viele Einträge

0	Tracing ist disabled. (Default)
1	Tracing von DBI Top-Level Methoden mit deren Ergebnissen und Fehlern
2	Wie oben. Zusätzlich Top-Level Methodeneintäge mit Parametern.
3	Wie oben. Zusätzliche werden einige High-Level Informationen des Treibers und einige interne Informationen des DBI hinzugefügt.
4	Wie oben. Zusätzlich werden mehr detaillierte Informationen des Treibers eingefügt.
5-7	Wie oben, aber mit mehr und mehr internen Informationen.

useCharfilter

valueFn

verbose4Devs

DbRep

[EN DE]

Selektion aller Datensätze innerhalb einstellbarer Zeitgrenzen
Darstellung der Datensätze einer Device/Reading-Kombination innerhalb einstellbarer Zeitgrenzen.
Selektion der Datensätze unter Verwendung von dynamisch berechneter Zeitgrenzen zum Ausführungszeitpunkt.
Dubletten-Hervorhebung bei Datensatzanzeige (fetchrows)
Berechnung der Anzahl von Datensätzen einer Device/Reading-Kombination unter Berücksichtigung von Zeitgrenzen und verschiedenen Aggregationen.
Die Berechnung von Summen-, Differenz-, Maximum-, Minimum- und Durchschnittswerten numerischer Readings in Zeitgrenzen und verschiedenen Aggregationen.
Speichern von Summen-, Differenz- , Maximum- , Minimum- und Durchschnittswertberechnungen in der Datenbank
Löschung von Datensätzen. Die Eingrenzung der Löschung kann durch Device und/oder Reading sowie fixer oder dynamisch berechneter Zeitgrenzen zum Ausführungszeitpunkt erfolgen.
Export von Datensätzen in ein File im CSV-Format
Import von Datensätzen aus File im CSV-Format
Umbenennen von Device/Readings in Datenbanksätzen
Ändern von Reading-Werten (VALUES) in der Datenbank (changeValue)
automatisches Umbenennen von Device-Namen in Datenbanksätzen und DbRep-Definitionen nach FHEM "rename" Befehl (siehe DbRep-Agent)
Ausführen von beliebigen Benutzer spezifischen SQL-Kommandos (non-blocking)
Ausführen von beliebigen Benutzer spezifischen SQL-Kommandos (blocking) zur Verwendung in eigenem Code (dbValue)
Backups der FHEM-Datenbank im laufenden Betrieb erstellen (MySQL, SQLite)
senden des Dumpfiles zu einem FTP-Server nach dem Backup incl. Versionsverwaltung
Restore von SQLite- und MySQL-Dumps
Optimierung der angeschlossenen Datenbank (optimizeTables, vacuum)
Ausgabe der existierenden Datenbankprozesse (MySQL)
leeren der current-Tabelle
Auffüllen der current-Tabelle mit einem (einstellbaren) Extrakt der history-Tabelle
Bereinigung sequentiell aufeinander folgender Datensätze mit unterschiedlichen Zeitstempel aber gleichen Werten (sequentielle Dublettenbereinigung)
Reparatur einer korrupten SQLite Datenbank ("database disk image is malformed")
Übertragung von Datensätzen aus der Quelldatenbank in eine andere (Standby) Datenbank (syncStandby)
Reduktion der Anzahl von Datensätzen in der Datenbank (reduceLog)
Löschen von doppelten Datensätzen (delDoublets)
Löschen und (Wieder)anlegen der für DbLog und DbRep benötigten Indizes (index)

Autorename

DbRep-Agent

UserExit

Modul 93_DbRep - Reporting und Management von Datenbankinhalten (DbLog)

DbReadingsVal

dbReadingsVal


    DbReadingsVal("<name>","<device:reading>","<timestamp>","<default>")

Beispiele:


    dbReadingsVal <name> <device:reading> <timestamp> <default>

Beispiel:

<name>	: Name des abzufragenden DbRep-Device
<device:reading>	: Device:Reading dessen Wert geliefert werden soll
<timestamp>	: Zeitpunkt des zu liefernden Readingwertes (*) im Format "YYYY-MM-DD_hh:mm:ss"
<default>	: Defaultwert falls kein Readingwert ermittelt werden konnte

DbRep - Reporting und Management von DbLog-Datenbankinhalten

Voraussetzungen

Definition


    define <name> DbRep <Name der DbLog-Instanz>

nicht


    set <name> index recreate_Report_Idx

Set

averageValue [display | writeToDB] - berechnet einen Durchschnittswert des Datenbankfelds "VALUE" in den gegebenen Zeitgrenzen ( siehe Attribute). Es muss das auszuwertende Reading über das Attribut "reading" angegeben sein.
Mit dem Attribut "averageCalcForm" wird die Berechnungsvariante zur Mittelwertermittlung definiert. Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen in der Datenbank gespeichert.
Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet, wobei der originale Readingname durch das Attribut "readingNameMap" ersetzt werden kann. Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen.
Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann. Das Feld "EVENT" wird mit "calculated" gefüllt.

Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":

Zusammengefasst sind die zur Steuerung dieser Funktion relevanten Attribute:

aggregation	: Auswahl einer Aggregationsperiode
averageCalcForm	: Auswahl der Berechnungsvariante für den Durchschnitt
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start Operation
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende Operation
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
readingNameMap	: die entstehenden Ergebnisreadings werden partiell umbenannt
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

cancelDump - bricht einen laufenden Datenbankdump ab.

changeValue - ändert den gespeicherten Wert eines Readings. Ist die Selektion auf bestimmte Device/Reading-Kombinationen durch die Attribute "device" bzw. "reading" beschränkt, werden sie genauso berücksichtigt wie gesetzte Zeitgrenzen (Attribute time.*).
Fehlen diese Beschränkungen, wird die gesamte Datenbank durchsucht und der angegebene Wert geändert.

Syntax:

<old string> :	ein einfacher String mit/ohne Leerzeichen, z.B. "OL 12" ein String mit Verwendung von SQL-Wildcard, z.B. "%OL%"
<new string> :	ein einfacher String mit/ohne Leerzeichen, z.B. "12 kWh" Perl Code eingeschlossen in "{}" inkl. Quotes, z.B. "{($VALUE,$UNIT) = split(" ",$VALUE)}". Dem Perl-Ausdruck werden die Variablen $VALUE und $UNIT übergeben. Sie können innerhalb des Perl-Code geändert werden. Der zurückgebene Wert von $VALUE und $UNIT wird in dem Feld VALUE bzw. UNIT des Datensatzes gespeichert.

Beispiele:

device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
aggregation	: Auswahl einer Aggregationsperiode
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start changeValue
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende changeValue
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

Hinweis:

countEntries [history | current] - liefert die Anzahl der Tabelleneinträge (default: history) in den gegebenen Zeitgrenzen (siehe Attribute). Sind die Timestamps nicht gesetzt, werden alle Einträge der Tabelle gezählt. Beschränkungen durch die Attribute Device bzw. Reading gehen in die Selektion mit ein.
Standardmäßig wird die Summe aller Datensätze, gekennzeichnet mit "ALLREADINGS", erstellt. Ist das Attribut "countEntriesDetail" gesetzt, wird die Anzahl jedes einzelnen Readings zusätzlich ausgegeben.

Die für diese Funktion relevanten Attribute sind:

aggregation	: Zusammenfassung/Gruppierung von Zeitintervallen
countEntriesDetail	: detaillierte Ausgabe der Datensatzanzahl
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
readingNameMap	: die entstehenden Ergebnisreadings werden partiell umbenannt
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

delDoublets [adviceDelete | delete] - zeigt bzw. löscht doppelte / mehrfach vorkommende Datensätze. Dazu wird Timestamp, Device,Reading und Value ausgewertet.
Die Attribute zur Aggregation,Zeit-,Device- und Reading-Abgrenzung werden dabei berücksichtigt. Ist das Attribut "aggregation" nicht oder auf "no" gesetzt, wird im Standard die Aggregation "day" verwendet.

adviceDelete	: ermittelt die zu löschenden Datensätze (es wird nichts gelöscht !)
delete	: löscht die Dubletten

Aus Sicherheitsgründen muss das Attribut "allowDeletion" für die "delete" Option gesetzt sein.
Die Anzahl der anzuzeigenden Datensätze des Kommandos "delDoublets adviceDelete" ist zunächst begrenzt (default 1000) und kann durch das Attribut "limit" angepasst werden. Die Einstellung von "limit" hat keinen Einfluss auf die "delDoublets delete" Funktion, sondern beeinflusst NUR die Anzeige der Daten.
Vor und nach der Ausführung von "delDoublets" kann ein FHEM-Kommando bzw. Perl-Routine ausgeführt werden. (siehe Attribute "executeBeforeProc", "executeAfterProc")

Beispiel:

Zusammengefasst sind die zur Steuerung dieser Funktion relevanten Attribute:

allowDeletion	: needs to be set to execute the delete option
aggregation	: Auswahl einer Aggregationsperiode
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
limit	: begrenzt NUR die Anzahl der anzuzeigenden Datensätze
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start des Befehls
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende des Befehls
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

delEntries - löscht alle oder die durch die Attribute device und/oder reading definierten Datenbankeinträge. Die Eingrenzung über Timestamps erfolgt folgendermaßen:

bis

zwischen

älter

Aus Sicherheitsgründen muss das Attribut "allowDeletion" gesetzt sein um die Löschfunktion freizuschalten.

Die zur Steuerung von delEntries relevanten Attribute:

allowDeletion	: Freischaltung der Löschfunktion
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
readingNameMap	: die entstehenden Ergebnisreadings werden partiell umbenannt
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start delEntries
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende delEntries
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

delSeqDoublets [adviceRemain | adviceDelete | delete] - zeigt bzw. löscht aufeinander folgende identische Datensätze. Dazu wird Device,Reading und Value ausgewertet. Nicht gelöscht werden der erste und der letzte Datensatz einer Aggregationsperiode (z.B. hour, day, week usw.) sowie die Datensätze vor oder nach einem Wertewechsel (Datenbankfeld VALUE).
Die Attribute zur Aggregation,Zeit-,Device- und Reading-Abgrenzung werden dabei berücksichtigt. Ist das Attribut "aggregation" nicht oder auf "no" gesetzt, wird als Standard die Aggregation "day" verwendet. Für Datensätze mit numerischen Werten kann mit dem Attribut "seqDoubletsVariance" eine Abweichung eingestellt werden, bis zu der aufeinander folgende numerische Werte als identisch angesehen und gelöscht werden sollen.

adviceRemain	: simuliert die nach der Operation in der DB verbleibenden Datensätze (es wird nichts gelöscht !)
adviceDelete	: simuliert die zu löschenden Datensätze (es wird nichts gelöscht !)
delete	: löscht die sequentiellen Dubletten (siehe Beispiel)

Aus Sicherheitsgründen muss das Attribut "allowDeletion" für die "delete" Option gesetzt sein.
Die Anzahl der anzuzeigenden Datensätze der Kommandos "delSeqDoublets adviceDelete", "delSeqDoublets adviceRemain" ist zunächst begrenzt (default 1000) und kann durch das Attribut "limit" angepasst werden. Die Einstellung von "limit" hat keinen Einfluss auf die "delSeqDoublets delete" Funktion, sondern beeinflusst NUR die Anzeige der Daten.
Vor und nach der Ausführung von "delSeqDoublets" kann ein FHEM-Kommando bzw. Perl-Routine ausgeführt werden. (siehe Attribute "executeBeforeProc", "executeAfterProc")

Beispiel

fett

2017-11-25_00-00-05__eg.az.fridge_Pwr__power 0

2017-11-25_01-08-21__eg.az.fridge_Pwr__power 0

2017-11-25_01-08-59__eg.az.fridge_Pwr__power 60.32

2017-11-25_01-11-21__eg.az.fridge_Pwr__power 56.26

2017-11-25_01-27-54__eg.az.fridge_Pwr__power 6.19

2017-11-25_01-28-51__eg.az.fridge_Pwr__power 0

2017-11-25_02-39-29__eg.az.fridge_Pwr__power 0

2017-11-25_02-41-18__eg.az.fridge_Pwr__power 105.28

2017-11-25_02-41-26__eg.az.fridge_Pwr__power 61.52

2017-11-25_03-00-06__eg.az.fridge_Pwr__power 47.46

2017-11-25_03-00-33__eg.az.fridge_Pwr__power 0

2017-11-25_23-40-10__eg.az.fridge_Pwr__power 0

2017-11-25_23-42-24__eg.az.fridge_Pwr__power 1

2017-11-25_23-45-27__eg.az.fridge_Pwr__power 1

2017-11-25_23-47-07__eg.az.fridge_Pwr__power 0

2017-11-25_23-48-15__eg.az.fridge_Pwr__power 0

2017-11-25_23-50-21__eg.az.fridge_Pwr__power 59.1

2017-11-25_23-55-14__eg.az.fridge_Pwr__power 52.31

2017-11-25_23-58-09__eg.az.fridge_Pwr__power 51.73

Zusammengefasst sind die zur Steuerung dieser Funktion relevanten Attribute:

allowDeletion	: needs to be set to execute the delete option
aggregation	: Auswahl einer Aggregationsperiode
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
limit	: begrenzt NUR die Anzahl der anzuzeigenden Datensätze
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
readingNameMap	: die entstehenden Ergebnisreadings werden partiell umbenannt
seqDoubletsVariance	: bis zu diesem Wert werden aufeinander folgende numerische Datensätze als identisch angesehen und werden gelöscht
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start des Befehls
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende des Befehls
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

deviceRename <old_name>,<new_name> - benennt den Namen eines Device innerhalb der angeschlossenen Datenbank (Internal DATABASE) um. Der Gerätename wird immer in der gesamten Datenbank umgesetzt. Eventuell gesetzte Zeitgrenzen oder Beschränkungen durch die Attribute Device bzw. Reading werden nicht berücksichtigt.

diffValue [display | writeToDB] - berechnet den Differenzwert des Datenbankfelds "VALUE" in den Zeitgrenzen (Attribute) "timestamp_begin", "timestamp_end" bzw "timeDiffToNow / timeOlderThan". Es muss das auszuwertende Reading im Attribut "reading" angegeben sein. Diese Funktion ist z.B. zur Auswertung von Eventloggings sinnvoll, deren Werte sich fortlaufend erhöhen und keine Wertdifferenzen wegschreiben.
Es wird immer die Differenz aus dem Value-Wert des ersten verfügbaren Datensatzes und dem Value-Wert des letzten verfügbaren Datensatzes innerhalb der angegebenen Zeitgrenzen/Aggregation gebildet, wobei ein Übertragswert der Vorperiode (Aggregation) zur darauf folgenden Aggregationsperiode berücksichtigt wird sofern diese einen Value-Wert enhtält.
Dabei wird ein Zählerüberlauf (Neubeginn bei 0) mit berücksichtigt (vergleiche Attribut "diffAccept").
Wird in einer auszuwertenden Zeit- bzw. Aggregationsperiode nur ein Datensatz gefunden, kann die Differenz in Verbindung mit dem Differenzübertrag der Vorperiode berechnet werden. in diesem Fall kann es zu einer logischen Ungenauigkeit in der Zuordnung der Differenz zu der Aggregationsperiode kommen. Deswegen wird eine Warnung im "state" und das Reading "less_data_in_period" mit einer Liste der betroffenen Perioden wird erzeugt.

Hinweis:

Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen in der Datenbank gespeichert.
Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet, wobei der originale Readingname durch das Attribut "readingNameMap" ersetzt werden kann. Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen.
Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann. Das Feld "EVENT" wird mit "calculated" gefüllt.

Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":

Zusammengefasst sind die zur Steuerung dieser Funktion relevanten Attribute:

aggregation	: Auswahl einer Aggregationsperiode
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start Operation
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende Operation
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
readingNameMap	: die entstehenden Ergebnisreadings werden partiell umbenannt
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

dumpMySQL [clientSide | serverSide] - erstellt einen Dump der angeschlossenen MySQL-Datenbank.
Abhängig von der ausgewählten Option wird der Dump auf der Client- bzw. Serverseite erstellt.
Die Varianten unterscheiden sich hinsichtlich des ausführenden Systems, des Erstellungsortes, der Attributverwendung, des erzielten Ergebnisses und der benötigten Hardwareressourcen.
Die Option "clientSide" benötigt z.B. eine leistungsfähigere Hardware des FHEM-Servers, sichert aber alle Tabellen inklusive eventuell angelegter Views.
Mit dem Attribut "dumpCompress" kann eine Komprimierung der erstellten Dumpfiles eingeschaltet werden.

Option clientSide

Achtung !
Um ein Blockieren von FHEM zu vermeiden, muß DbLog im asynchronen Modus betrieben werden wenn die Tabellenoptimierung verwendet wird !

dumpComment	: User-Kommentar im Dumpfile
dumpCompress	: Komprimierung des Dumpfiles nach der Erstellung
dumpDirLocal	: das lokale Zielverzeichnis für die Erstellung des Dump
dumpMemlimit	: Begrenzung der Speicherverwendung
dumpSpeed	: Begrenzung die CPU-Belastung
dumpFilesKeep	: Anzahl der aufzubwahrenden Dumpfiles
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor dem Dump
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach dem Dump
optimizeTablesBeforeDump	: Tabelloptimierung vor dem Dump ausführen

Namenskonvention der Dumpfiles

Option serverSide

im CSV-Format

Achtung !
Um ein Blockieren von FHEM zu vermeiden, muß DbLog im asynchronen Modus betrieben werden wenn die Tabellenoptimierung verwendet wird !

dumpDirRemote	: das Erstellungsverzeichnis des Dumpfile auf dem entfernten Server
dumpCompress	: Komprimierung des Dumpfiles nach der Erstellung
dumpDirLocal	: Directory des lokal gemounteten dumpDirRemote-Verzeichnisses
dumpFilesKeep	: Anzahl der aufzubwahrenden Dumpfiles
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor dem Dump
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach dem Dump
optimizeTablesBeforeDump	: Tabelloptimierung vor dem Dump ausführen

Hinweis:

Beispiel:

Namenskonvention der Dumpfiles

FTP Transfer nach Dump

ftpUse	: FTP Transfer nach dem Dump wird eingeschaltet (ohne SSL Verschlüsselung)
ftpUser	: User zur Anmeldung am FTP-Server, default: anonymous
ftpUseSSL	: FTP Transfer mit SSL Verschlüsselung nach dem Dump wird eingeschaltet
ftpDebug	: Debugging des FTP Verkehrs zur Fehlersuche
ftpDir	: Verzeichnis auf dem FTP-Server in welches das File übertragen werden soll (default: "/")
ftpDumpFilesKeep	: Es wird die angegebene Anzahl Dumpfiles im <ftpDir> belassen (default: 3)
ftpPassive	: setzen wenn passives FTP verwendet werden soll
ftpPort	: FTP-Port, default: 21
ftpPwd	: Passwort des FTP-Users, default nicht gesetzt
ftpServer	: Name oder IP-Adresse des FTP-Servers. notwendig !
ftpTimeout	: Timeout für die FTP-Verbindung in Sekunden (default: 30).

dumpSQLite - erstellt einen Dump der angeschlossenen SQLite-Datenbank.
Diese Funktion nutzt die SQLite Online Backup API und ermöglicht es konsistente Backups der SQLite-DB in laufenden Betrieb zu erstellen. Der Dump wird per default im log-Verzeichnis des FHEM-Rechners gespeichert. Das Zielverzeichnis kann mit dem Attribut "dumpDirLocal" verändert werden und muß durch FHEM beschreibbar sein. Vor dem Dump kann optional eine Tabellenoptimierung (Attribut "optimizeTablesBeforeDump") zugeschaltet werden.

Achtung !
Um ein Blockieren von FHEM zu vermeiden, muß DbLog im asynchronen Modus betrieben werden wenn die Tabellenoptimierung verwendet wird !

Vor und nach dem Dump kann ein FHEM-Kommando (siehe Attribute "executeBeforeProc", "executeAfterProc") ausgeführt werden.

Die für diese Funktion relevanten Attribute sind:

dumpCompress	: Komprimierung des Dumpfiles nach der Erstellung
dumpDirLocal	: Directory des lokal gemounteten dumpDirRemote-Verzeichnisses
dumpFilesKeep	: Anzahl der aufzubwahrenden Dumpfiles
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor dem Dump
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach dem Dump
optimizeTablesBeforeDump	: Tabelloptimierung vor dem Dump ausführen

Nach einem erfolgreichen Dump werden alte Dumpfiles gelöscht und nur die Anzahl Files, definiert durch das Attribut "dumpFilesKeep" (default: 3), verbleibt im Zielverzeichnis "dumpDirLocal". Falls "dumpFilesKeep = 0" gesetzt, werden alle Dumpfiles (auch das aktuell erstellte File), gelöscht. Diese Einstellung kann sinnvoll sein, wenn FTP aktiviert ist und die erzeugten Dumps nur im FTP-Zielverzeichnis erhalten bleiben sollen.

Die Namenskonvention der Dumpfiles ist: <dbname>_<date>_<time>.sqlitebkp[.gzip]

Die Datenbank kann mit "set <name> restoreSQLite <Filename>" wiederhergestellt werden.
Das erstellte Dumpfile kann auf einen FTP-Server übertragen werden. Siehe dazu die Erläuterungen unter "dumpMySQL".

eraseReadings - Löscht alle angelegten Readings im Device, außer dem Reading "state" und Readings, die in der Ausnahmeliste definiert mit Attribut "readingPreventFromDel" enthalten sind.

exportToFile [</Pfad/File>] [MAXLINES=<lines>] - exportiert DB-Einträge im CSV-Format in den gegebenen Zeitgrenzen.

Der Dateiname wird durch das Attribut "expimpfile" bestimmt. Alternativ kann "/Pfad/File" als Kommando-Option angegeben werden und übersteuert ein eventuell gesetztes Attribut "expimpfile". Optional kann über den Parameter "MAXLINES" die maximale Anzahl von Datensätzen angegeben werden, die in ein File exportiert werden. In diesem Fall werden mehrere Files mit den Extensions "_part1", "_part2", "_part3" usw. erstellt (beim Import berücksichtigen !).

Einschränkungen durch die Attribute "device" bzw. "reading" gehen in die Selektion mit ein. Der Dateiname kann Wildcards enthalten (siehe Attribut "expimpfile").
Durch das Attribut "aggregation" wird der Export der Datensätze in Zeitscheiben der angegebenen Aggregation vorgenommen. Ist z.B. "aggregation = month" gesetzt, werden die Daten in monatlichen Paketen selektiert und in das Exportfile geschrieben. Dadurch wird die Hauptspeicherverwendung optimiert wenn sehr große Datenmengen exportiert werden sollen und vermeidet den "died prematurely" Abbruchfehler.

Die für diese Funktion relevanten Attribute sind:

aggregation	: Festlegung der Selektionspaketierung
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
executeBeforeProc	: FHEM Kommando (oder Perl-Routine) vor dem Export ausführen
executeAfterProc	: FHEM Kommando (oder Perl-Routine) nach dem Export ausführen
expimpfile	: der Name des Exportfiles
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

fetchrows [history|current] - liefert alle Tabelleneinträge (default: history) in den gegebenen Zeitgrenzen bzw. Selektionsbedingungen durch die Attribute "device" und "reading". Eine evtl. gesetzte Aggregation wird dabei nicht berücksichtigt.
Die Leserichtung in der Datenbank kann durch das Attribut "fetchRoute" bestimmt werden.

Jedes Ergebnisreading setzt sich aus dem Timestring des Datensatzes, einem Index, dem Device und dem Reading zusammen. Die Funktion fetchrows ist in der Lage, mehrfach vorkommende Datensätze (Dubletten) zu erkennen. Solche Dubletten sind mit einem Index > 1 gekennzeichnet.
Dubletten können mit dem Attribut "fetchMarkDuplicates" farblich hervorgehoben werden.

Hinweis:
Hervorgehobene Readings werden nach einem Restart bzw. nach rereadcfg nicht mehr angezeigt da sie nicht im statefile gesichert werden (Verletzung erlaubter Readingnamen durch Formatierung).

Dieses Attribut ist mit einigen Farben vorbelegt, kann aber mit dem colorpicker-Widget überschrieben werden:


                                 attr <name> widgetOverride fetchMarkDuplicates:colorpicker

Die Ergebnisreadings von fetchrows sind nach folgendem Schema aufgebaut:

Beispiel:

Zur besseren Übersicht sind die zur Steuerung von fetchrows relevanten Attribute hier noch einmal dargestellt:

fetchRoute	: Leserichtung der Selektion innerhalb der Datenbank
limit	: begrenzt die Anzahl zu selektierenden bzw. anzuzeigenden Datensätze
fetchMarkDuplicates	: Hervorhebung von gefundenen Dubletten
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
valueFilter	: filtert die anzuzeigenden Datensätze mit einem regulären Ausdruck (Datenbank spezifischer REGEXP). Der REGEXP wird auf Werte des Datenbankfeldes 'VALUE' angewendet.

Hinweis:
Auch wenn das Modul bezüglich der Datenbankabfrage nichtblockierend arbeitet, kann eine zu große Ergebnismenge (Anzahl Zeilen bzw. Readings) die Browsersesssion bzw. FHEMWEB blockieren. Aus diesem Grund wird die Ergebnismenge mit dem Attribut "limit" begrenzt. Bei Bedarf kann dieses Attribut geändert werden, falls eine Anpassung der Selektionsbedingungen nicht möglich oder gewünscht ist.

index <Option> - Listet die in der Datenbank vorhandenen Indexe auf bzw. legt die benötigten Indexe an. Ist ein Index bereits angelegt, wird er erneuert (gelöscht und erneut angelegt)

Die möglichen Optionen sind:

list_all	: listet die vorhandenen Indexe auf
recreate_Search_Idx	: erstellt oder erneuert (falls vorhanden) den Index Search_Idx in Tabelle history (Index für DbLog)
drop_Search_Idx	: löscht den Index Search_Idx in Tabelle history
recreate_Report_Idx	: erstellt oder erneuert (falls vorhanden) den Index Report_Idx in Tabelle history (Index für DbRep)
drop_Report_Idx	: löscht den Index Report_Idx in Tabelle history

insert - Manuelles Einfügen eines Datensatzes in die Tabelle "history". Obligatorisch sind Eingabewerte für Datum, Zeit und Value. Die Werte für die DB-Felder Type bzw. Event werden mit "manual" gefüllt, sowie die Werte für Device, Reading aus den gesetzten Attributen genommen.

importFromFile [<File>] - importiert Datensätze im CSV-Format aus einer Datei in die Datenbank.
Der Dateiname wird durch das Attribut "expimpfile" bestimmt.
Alternativ kann die Datei (/Pfad/Datei) als Kommando-Option angegeben werden und übersteuert ein eventuell gesetztes Attribut "expimpfile". Der Dateiname kann Wildcards enthalten (siehe Attribut "expimpfile").

Datensatzformat:

Beispiel:

executeBeforeProc	: FHEM Kommando (oder Perl-Routine) vor dem Import ausführen
executeAfterProc	: FHEM Kommando (oder Perl-Routine) nach dem Import ausführen
expimpfile	: der Name des Importfiles

maxValue [display | writeToDB] - berechnet den Maximalwert des Datenbankfelds "VALUE" in den Zeitgrenzen (Attribute) "timestamp_begin", "timestamp_end" bzw. "timeDiffToNow / timeOlderThan". Es muss das auszuwertende Reading über das Attribut "reading" angegeben sein. Die Auswertung enthält den Zeitstempel des ermittelten Maximumwertes innerhalb der Aggregation bzw. Zeitgrenzen. Im Reading wird der Zeitstempel des letzten Auftretens vom Maximalwert ausgegeben falls dieser Wert im Intervall mehrfach erreicht wird.
Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen in der Datenbank gespeichert.
Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet, wobei der originale Readingname durch das Attribut "readingNameMap" ersetzt werden kann. Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen.
Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann. Das Feld "EVENT" wird mit "calculated" gefüllt.

Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":

Zusammengefasst sind die zur Steuerung dieser Funktion relevanten Attribute:

aggregation	: Auswahl einer Aggregationsperiode
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start Operation
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende Operation
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
readingNameMap	: die entstehenden Ergebnisreadings werden partiell umbenannt
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

minValue [display | writeToDB] - berechnet den Minimalwert des Datenbankfelds "VALUE" in den Zeitgrenzen (Attribute) "timestamp_begin", "timestamp_end" bzw. "timeDiffToNow / timeOlderThan". Es muss das auszuwertende Reading über das Attribut "reading" angegeben sein. Die Auswertung enthält den Zeitstempel des ermittelten Minimumwertes innerhalb der Aggregation bzw. Zeitgrenzen. Im Reading wird der Zeitstempel des ersten Auftretens vom Minimalwert ausgegeben falls dieser Wert im Intervall mehrfach erreicht wird.
Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen in der Datenbank gespeichert.
Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet, wobei der originale Readingname durch das Attribut "readingNameMap" ersetzt werden kann. Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen.
Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann. Das Feld "EVENT" wird mit "calculated" gefüllt.

Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":

Zusammengefasst sind die zur Steuerung dieser Funktion relevanten Attribute:

aggregation	: Auswahl einer Aggregationsperiode
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start Operation
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende Operation
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
readingNameMap	: die entstehenden Ergebnisreadings werden partiell umbenannt
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

optimizeTables - optimiert die Tabellen in der angeschlossenen Datenbank (MySQL).
Vor und nach der Optimierung kann ein FHEM-Kommando ausgeführt werden. (siehe Attribute "executeBeforeProc", "executeAfterProc")
readingRename <[Device:]alterReadingname>,<neuerReadingname>
Benennt den Namen eines Readings innerhalb der angeschlossenen Datenbank (siehe Internal DATABASE) um. Der Readingname wird immer in der gesamten Datenbank umgesetzt. Eventuell gesetzte Zeitgrenzen oder Beschränkungen durch die Attribute Device bzw. Reading werden nicht berücksichtigt.
Optional kann eine Device angegeben werden. In diesem Fall werden nur die alten Readings dieses Devices in den neuen Readingnamen umgesetzt.
Die Anzahl der umbenannten Device-Datensätze wird im Reading "reading_renamed" ausgegeben.
Wird der umzubenennende Readingname in der Datenbank nicht gefunden, wird eine WARNUNG im Reading "reading_not_renamed" ausgegeben.
Entsprechende Einträge erfolgen auch im Logfile mit verbose=3.

Hinweis:
Obwohl die Funktion selbst non-blocking ausgelegt ist, sollte das zugeordnete DbLog-Device im asynchronen Modus betrieben werden um ein Blockieren von FHEMWEB zu vermeiden (Tabellen-Lock).

reduceLog [average[=day]]
Reduziert historische Datensätze innerhalb der durch die "time.*"-Attribute bestimmten Zeitgrenzen auf einen Eintrag (den ersten) pro Stunde je Device & Reading. Es muss mindestens eines der "time.*"-Attribute gesetzt sein (siehe Tabelle unten). Die jeweils fehlende Zeitabgrenzung wird in diesem Fall durch das Modul errechnet.

Durch die optionale Angabe von 'average' wird nicht nur die Datenbank bereinigt, sondern alle numerischen Werte einer Stunde werden auf einen einzigen Mittelwert reduziert. Mit der Option 'average=day' werden alle numerischen Werte eines Tages auf einen einzigen Mittelwert reduziert (impliziert 'average').

Mit den Attributen "device" und "reading" können die zu berücksichtigenden Datensätze eingeschlossen bzw. ausgeschlossen werden. Beide Eingrenzungen reduzieren die selektierten Daten und verringern den Ressourcenbedarf. Das Reading "reduceLogState" enthält das Ausführungsergebnis des letzten reduceLog-Befehls.

Die für diese Funktion relevanten Attribute sind:

executeBeforeProc	: FHEM Kommando (oder Perl-Routine) vor dem Export ausführen
executeAfterProc	: FHEM Kommando (oder Perl-Routine) nach dem Export ausführen
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
timeOlderThan	: es werden Datenbankeinträge älter als dieses Attribut reduziert
timestamp_end	: es werden Datenbankeinträge älter als dieses Attribut reduziert
timeDiffToNow	: es werden Datenbankeinträge neuer als dieses Attribut reduziert
timestamp_begin	: es werden Datenbankeinträge neuer als dieses Attribut reduziert
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

Aus Kompatibilitätsgründen kann der Befehl optional durch die Zusätze "EXCLUDE" bzw. "INCLUDE" ergänzt werden um device/reading Kombinationen von reduceLog auszuschließen bzw. einzuschließen:

Diese Angabe wird als Regex ausgewertet und überschreibt die Attribute "device" und "reading", die in diesem Fall nicht beachtet werden.

Beispiele:

Hinweis:
Obwohl die Funktion selbst non-blocking ausgelegt ist, sollte das zugeordnete DbLog-Device im asynchronen Modus betrieben werden um ein Blockieren von FHEMWEB zu vermeiden (Tabellen-Lock).
Weiterhin wird dringend empfohlen den standard INDEX 'Search_Idx' in der Tabelle 'history' anzulegen !
Die Abarbeitung dieses Befehls dauert unter Umständen (ohne INDEX) extrem lange.

repairSQLite - repariert eine korrupte SQLite-Datenbank.
Eine Korruption liegt im Allgemeinen vor wenn die Fehlermitteilung "database disk image is malformed" im state des DbLog-Devices erscheint. Wird dieses Kommando gestartet, wird das angeschlossene DbLog-Device zunächst automatisch für 10 Stunden (36000 Sekunden) von der Datenbank getrennt (Trennungszeit). Nach Abschluss der Reparatur erfolgt wieder eine sofortige Neuverbindung zur reparierten Datenbank.
Dem Befehl kann eine abweichende Trennungszeit (in Sekunden) als Argument angegeben werden.
Die korrupte Datenbank wird als <database>.corrupt im gleichen Verzeichnis gespeichert.
restoreMySQL <File> - stellt die Datenbank aus einem serverSide- oder clientSide-Dump wieder her.
Die Funktion stellt über eine Drop-Down Liste eine Dateiauswahl für den Restore zur Verfügung.

Verwendung eines serverSide-Dumps
Es wird der Inhalt der history-Tabelle aus einem serverSide-Dump wiederhergestellt. Dazu ist das Verzeichnis "dumpDirRemote" des MySQL-Servers auf dem Client zu mounten und im Attribut "dumpDirLocal" dem DbRep-Device bekannt zu machen.
Es werden alle Files mit der Endung "csv[.gzip]" und deren Name mit der verbundenen Datenbank beginnt (siehe Internal DATABASE), aufgelistet.

Verwendung eines clientSide-Dumps
Es werden alle Tabellen und eventuell vorhandenen Views wiederhergestellt. Das Verzeichnis, in dem sich die Dump-Files befinden, ist im Attribut "dumpDirLocal" dem DbRep-Device bekannt zu machen.
Es werden alle Files mit der Endung "sql[.gzip]" und deren Name mit der verbundenen Datenbank beginnt (siehe Internal DATABASE), aufgelistet.
Die Geschwindigkeit des Restores ist abhängig von der Servervariable "max_allowed_packet". Durch Veränderung dieser Variable im File my.cnf kann die Geschwindigkeit angepasst werden. Auf genügend verfügbare Ressourcen (insbesondere RAM) ist dabei zu achten.

Der Datenbankuser benötigt Rechte zum Tabellenmanagement, z.B.:
CREATE, ALTER, INDEX, DROP, SHOW VIEW, CREATE VIEW

restoreSQLite <File>.sqlitebkp[.gzip] - stellt das Backup einer SQLite-Datenbank wieder her.
Die Funktion stellt über eine Drop-Down Liste die für den Restore zur Verfügung stehenden Dateien zur Verfügung. Die aktuell in der Zieldatenbank enthaltenen Daten werden gelöscht bzw. überschrieben. Es werden alle Files mit der Endung "sqlitebkp[.gzip]" und deren Name mit dem Namen der verbundenen Datenbank beginnt, aufgelistet .

sqlCmd - führt ein beliebiges benutzerspezifisches Kommando aus.
Enthält dieses Kommando eine Delete-Operation, muss zur Sicherheit das Attribut "allowDeletion" gesetzt sein.
Bei der Ausführung dieses Kommandos werden keine Einschränkungen durch gesetzte Attribute "device", "reading", "time.*" bzw. "aggregation" berücksichtigt.
Dieses Kommando akzeptiert ebenfalls das Setzen von SQL Session Variablen wie z.B. "SET @open:=NULL, @closed:=NULL;" oder die Verwendung von SQLite PRAGMA vor der Ausführung des SQL-Statements. Soll die Session Variable oder das PRAGMA vor jeder Ausführung eines SQL Statements gesetzt werden, kann dafür das Attribut "sqlCmdVars" verwendet werden.
Sollen die im Modul gesetzten Attribute "timestamp_begin" bzw. "timestamp_end" im Statement berücksichtigt werden, können die Platzhalter "§timestamp_begin§" bzw. "§timestamp_end§" dafür verwendet werden.

Soll ein Datensatz upgedated werden, ist dem Statement "TIMESTAMP=TIMESTAMP" hinzuzufügen um eine Änderung des originalen Timestamps zu verhindern.

Beispiele für Statements:

set <name> sqlCmd select DEVICE, count(*) from history where TIMESTAMP >= "2017-01-06 00:00:00" group by DEVICE having count(*) > 800
set <name> sqlCmd select DEVICE, count(*) from history where TIMESTAMP >= "2017-05-06 00:00:00" group by DEVICE
set <name> sqlCmd select DEVICE, count(*) from history where TIMESTAMP >= §timestamp_begin§ group by DEVICE
set <name> sqlCmd select * from history where DEVICE like "Te%t" order by `TIMESTAMP` desc
set <name> sqlCmd select * from history where `TIMESTAMP` > "2017-05-09 18:03:00" order by `TIMESTAMP` desc
set <name> sqlCmd select * from current order by `TIMESTAMP` desc
set <name> sqlCmd select sum(VALUE) as 'Einspeisung am 04.05.2017', count(*) as 'Anzahl' FROM history where `READING` = "Einspeisung_WirkP_Zaehler_Diff" and TIMESTAMP between '2017-05-04' AND '2017-05-05'
set <name> sqlCmd delete from current
set <name> sqlCmd delete from history where TIMESTAMP < "2016-05-06 00:00:00"
set <name> sqlCmd update history set TIMESTAMP=TIMESTAMP,VALUE='Val' WHERE VALUE='TestValue'
set <name> sqlCmd select * from history where DEVICE = "Test"
set <name> sqlCmd insert into history (TIMESTAMP, DEVICE, TYPE, EVENT, READING, VALUE, UNIT) VALUES ('2017-05-09 17:00:14','Test','manuell','manuell','Tes§e','TestValue','°C')

set <name> sqlCmd SET @open:=NULL, @closed:=NULL; SELECT TIMESTAMP, VALUE,DEVICE, @open AS open, @open := IF(VALUE = 'open', TIMESTAMP, NULL) AS curr_open, @closed := IF(VALUE = 'closed', TIMESTAMP, NULL) AS closed FROM history WHERE DATE(TIMESTAMP) = CURDATE() AND DEVICE = "HT_Fensterkontakt" AND READING = "state" AND (VALUE = "open" OR VALUE = "closed") ORDER BY TIMESTAMP;
set <name> sqlCmd PRAGMA temp_store=MEMORY; PRAGMA synchronous=FULL; PRAGMA journal_mode=WAL; PRAGMA cache_size=4000; select count(*) from history;
set <name> sqlCmd PRAGMA temp_store=FILE; PRAGMA temp_store_directory = '/opt/fhem/'; VACUUM;

Reading

executeBeforeProc	: FHEM Kommando (oder Perl-Routine) vor der Operation ausführen
executeAfterProc	: FHEM Kommando (oder Perl-Routine) nach der Operation ausführen
allowDeletion	: aktiviert Löschmöglichkeit
sqlResultFormat	: legt die Darstellung des Kommandoergebnis fest
sqlResultFieldSep	: Auswahl Feldtrenner im Ergebnis
sqlCmdHistoryLength	: Aktivierung Kommando-Historie und deren Umfang
sqlCmdVars	: setzt SQL Session Variablen oder PRAGMA vor jeder Ausführung des SQL-Statements

Hinweis:

sqlCmdHistory - Wenn mit dem Attribut "sqlCmdHistoryLength" aktiviert, kann aus einer Liste ein bereits erfolgreich ausgeführtes sqlCmd-Kommando wiederholt werden.
Mit Ausführung des letzten Eintrags der Liste, "__purge_historylist__", kann die Liste gelöscht werden.
Falls das Statement "," enthält, wird dieses Zeichen aus technischen Gründen in der History-Liste als "<c>" dargestellt.

Zur besseren Übersicht sind die zur Steuerung dieser Funktion von relevanten Attribute hier noch einmal zusammenstellt:

executeBeforeProc	: FHEM Kommando (oder Perl-Routine) vor der Operation ausführen
executeAfterProc	: FHEM Kommando (oder Perl-Routine) nach der Operation ausführen
allowDeletion	: aktiviert Löschmöglichkeit
sqlResultFormat	: legt die Darstellung des Kommandoergebnis fest
sqlResultFieldSep	: Auswahl Feldtrenner im Ergebnis

sqlSpecial - Die Funktion bietet eine Drop-Downliste mit einer Auswahl vorbereiter Auswertungen an.
Das Ergebnis des Statements wird im Reading "SqlResult" dargestellt. Die Ergebnis-Formatierung kann durch das Attribut "sqlResultFormat" ausgewählt, sowie der verwendete Feldtrenner durch das Attribut "sqlResultFieldSep" festgelegt werden.

Die für diese Funktion relevanten Attribute sind:

executeBeforeProc	: FHEM Kommando (oder Perl-Routine) vor der Operation ausführen
executeAfterProc	: FHEM Kommando (oder Perl-Routine) nach der Operation ausführen
sqlResultFormat	: Optionen der Ergebnisformatierung
sqlResultFieldSep	: Auswahl des Trennzeichens zwischen Ergebnisfeldern

Es sind die folgenden vordefinierte Auswertungen auswählbar:

50mostFreqLogsLast2days	: ermittelt die 50 am häufigsten vorkommenden Loggingeinträge der letzten 2 Tage
allDevCount	: alle in der Datenbank vorkommenden Devices und deren Anzahl
allDevReadCount	: alle in der Datenbank vorkommenden Device/Reading-Kombinationen und deren Anzahl

sumValue [display | writeToDB] - Berechnet die Summenwerte des Datenbankfelds "VALUE" in den Zeitgrenzen (Attribute) "timestamp_begin", "timestamp_end" bzw. "timeDiffToNow / timeOlderThan". Es muss das auszuwertende Reading im Attribut "reading" angegeben sein. Diese Funktion ist sinnvoll wenn fortlaufend Wertedifferenzen eines Readings in die Datenbank geschrieben werden.
Ist keine oder die Option "display" angegeben, werden die Ergebnisse nur angezeigt. Mit der Option "writeToDB" werden die Berechnungsergebnisse mit einem neuen Readingnamen in der Datenbank gespeichert.
Der neue Readingname wird aus einem Präfix und dem originalen Readingnamen gebildet, wobei der originale Readingname durch das Attribut "readingNameMap" ersetzt werden kann. Der Präfix setzt sich aus der Bildungsfunktion und der Aggregation zusammen.
Der Timestamp der neuen Readings in der Datenbank wird von der eingestellten Aggregationsperiode abgeleitet, sofern kein eindeutiger Zeitpunkt des Ergebnisses bestimmt werden kann. Das Feld "EVENT" wird mit "calculated" gefüllt.

Beispiel neuer Readingname gebildet aus dem Originalreading "totalpac":

Zusammengefasst sind die zur Steuerung dieser Funktion relevanten Attribute:

aggregation	: Auswahl einer Aggregationsperiode
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start Operation
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende Operation
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
readingNameMap	: die entstehenden Ergebnisreadings werden partiell umbenannt
time.*	: eine Reihe von Attributen zur Zeitabgrenzung
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

syncStandby <DbLog-Device Standby> - Es werden die Datensätze aus der angeschlossenen Datenbank (Quelle) direkt in eine weitere Datenbank (Standby-Datenbank) übertragen. Dabei ist "<DbLog-Device Standby>" das DbLog-Device, welches mit der Standby-Datenbank verbunden ist.

Es werden alle Datensätze übertragen, die durch Timestamp-Attribute bzw. die Attribute "device", "reading" bestimmt sind.
Die Datensätze werden dabei in Zeitscheiben entsprechend der eingestellten Aggregation übertragen. Hat das Attribut "aggregation" den Wert "no" oder "month", werden die Datensätze automatisch in Tageszeitscheiben zur Standby-Datenbank übertragen. Quell- und Standby-Datenbank können unterschiedlichen Typs sein.

Die zur Steuerung der syncStandby Funktion relevanten Attribute sind:

aggregation	: Einstellung der Zeitscheiben zur Übertragung (hour,day,week)
executeBeforeProc	: ausführen FHEM Kommando (oder Perl-Routine) vor Start Operation
executeAfterProc	: ausführen FHEM Kommando (oder Perl-Routine) nach Ende Operation
device	: einschließen oder ausschließen von Datensätzen die <device> enthalten
reading	: einschließen oder ausschließen von Datensätzen die <reading> enthalten
time.*	: Attribute zur Zeitabgrenzung der zu übertragenden Datensätze.
valueFilter	: ein zusätzliches REGEXP um die Datenselektion zu steuern. Der REGEXP wird auf das Datenbankfeld 'VALUE' angewendet.

tableCurrentFillup - Die current-Tabelle wird mit einem Extrakt der history-Tabelle aufgefüllt. Die Attribute zur Zeiteinschränkung bzw. device, reading werden ausgewertet. Dadurch kann der Inhalt des Extrakts beeinflusst werden. Im zugehörigen DbLog-Device sollte sollte das Attribut "DbLogType=SampleFill/History" gesetzt sein.

tableCurrentPurge - löscht den Inhalt der current-Tabelle. Es werden keine Limitierungen, z.B. durch die Attribute "timestamp_begin", "timestamp_end", device, reading, usw. , ausgewertet.

vacuum - optimiert die Tabellen in der angeschlossenen Datenbank (SQLite, PostgreSQL).
Vor und nach der Optimierung kann ein FHEM-Kommando ausgeführt werden. (siehe Attribute "executeBeforeProc", "executeAfterProc")

Für alle Auswertungsvarianten (Ausnahme sqlCmd,deviceRename,readingRename) gilt:

Hinweis:

Get

Hinweis:

blockinginfo - Listet die aktuell systemweit laufenden Hintergrundprozesse (BlockingCalls) mit ihren Informationen auf. Zu lange Zeichenketten (z.B. Argumente) werden gekürzt ausgeschrieben.

dbstatus - Listet globale Informationen zum MySQL Serverstatus (z.B. Informationen zum Cache, Threads, Bufferpools, etc. ). Es werden zunächst alle verfügbaren Informationen berichtet. Mit dem Attribut "showStatus" kann die Ergebnismenge eingeschränkt werden, um nur gewünschte Ergebnisse abzurufen. Detailinformationen zur Bedeutung der einzelnen Readings sind hier verfügbar.
dbValue <SQL-Statement> - Führt das angegebene SQL-Statement blockierend aus. Diese Funktion ist durch ihre Arbeitsweise speziell für den Einsatz in benutzerspezifischen Scripten geeignet.
Die Eingabe akzeptiert Mehrzeiler und gibt ebenso mehrzeilige Ergebisse zurück. Dieses Kommando akzeptiert ebenfalls das Setzen von SQL Session Variablen wie z.B. "SET @open:=NULL, @closed:=NULL;".
Werden mehrere Felder selektiert und zurückgegeben, erfolgt die Feldtrennung mit dem Trenner des Attributes "sqlResultFieldSep" (default "|"). Mehrere Ergebniszeilen werden mit Newline ("\n") separiert.
Diese Funktion setzt/aktualisiert nur Statusreadings, die Funktion im Attribut "userExitFn" wird nicht aufgerufen.
Erstellt man eine kleine Routine in 99_myUtils, wie z.B.:
```
sub dbval($$) {
  my ($name,$cmd) = @_;
  my $ret = CommandGet(undef,"$name dbValue $cmd"); 
return $ret;
}                            
                            
```
kann dbValue vereinfacht verwendet werden mit Aufrufen wie:

dbvars - Zeigt die globalen Werte der MySQL Systemvariablen. Enthalten sind zum Beispiel Angaben zum InnoDB-Home, dem Datafile-Pfad, Memory- und Cache-Parameter, usw. Die Ausgabe listet zunächst alle verfügbaren Informationen auf. Mit dem Attribut "showVariables" kann die Ergebnismenge eingeschränkt werden um nur gewünschte Ergebnisse abzurufen. Weitere Informationen zur Bedeutung der ausgegebenen Variablen sind hier verfügbar.
minTimestamp - Ermittelt den Zeitstempel des ältesten Datensatzes in der Datenbank (wird implizit beim Start von FHEM ausgeführt). Der Zeitstempel wird als Selektionsbeginn verwendet wenn kein Zeitattribut den Selektionsbeginn festlegt.

procinfo - Listet die existierenden Datenbank-Prozesse in einer Tabelle auf (nur MySQL).
Typischerweise werden nur die Prozesse des Verbindungsusers (angegeben in DbLog-Konfiguration) ausgegeben. Sollen alle Prozesse angezeigt werden, ist dem User das globale Recht "PROCESS" einzuräumen.
Für bestimmte SQL-Statements wird seit MariaDB 5.3 ein Fortschrittsreporting (Spalte "PROGRESS") ausgegeben. Zum Beispiel kann der Abarbeitungsgrad bei der Indexerstellung verfolgt werden.
Weitere Informationen sind hier verfügbar.

svrinfo - allgemeine Datenbankserver-Informationen wie z.B. die DBMS-Version, Serveradresse und Port usw. Die Menge der Listenelemente ist vom Datenbanktyp abhängig. Mit dem Attribut "showSvrInfo" kann die Ergebnismenge eingeschränkt werden. Weitere Erläuterungen zu den gelieferten Informationen sind hier zu finden.
tableinfo - ruft Tabelleninformationen aus der mit dem DbRep-Device verbundenen Datenbank ab (MySQL). Es werden per default alle in der verbundenen Datenbank angelegten Tabellen ausgewertet. Mit dem Attribut "showTableInfo" können die Ergebnisse eingeschränkt werden. Erläuterungen zu den erzeugten Readings sind hier zu finden.
versionNotes [hints | rel | <key>] - Zeigt Release Informationen und/oder Hinweise zum Modul an. Es sind nur Release Informationen mit Bedeutung für den Modulnutzer enthalten.
Sind keine Optionen angegben, werden sowohl Release Informationen als auch Hinweise angezeigt. "rel" zeigt nur Release Informationen und "hints" nur Hinweise an. Mit der <key>-Angabe wird der Hinweis mit der angegebenen Nummer angezeigt.

Attribute

Hinweis zur SQL-Wildcard Verwendung:

ausser

aggregation - Zusammenfassung der Device/Reading-Selektionen in Stunden, Tagen, Kalenderwochen, Kalendermonaten, Kalenderjahren oder "no".
Liefert z.B. die Anzahl der DB-Einträge am Tag (countEntries) oder die Summierung von Differenzwerten eines Readings (sumValue) usw.
Mit Aggregation "no" (default) wird das Ergebnis aus allen Werten einer Device/Reading-Kombination im selektierten Zeitraum ermittelt.

allowDeletion - schaltet die Löschfunktion des Moduls frei

averageCalcForm - legt die Berechnungsvariante für die Ermittlung des Durchschnittswertes mit "averageValue" fest.

Zur Zeit sind folgende Varianten implementiert:

avgArithmeticMean :	es wird der arithmetische Mittelwert berechnet (default)
avgDailyMeanGWS :	berechnet die Tagesmitteltemperatur entsprechend den Vorschriften des deutschen Wetterdienstes (siehe "get <name> versionNotes 2"). Diese Variante verwendet automatisch die Aggregation "day".
avgTimeWeightMean :	berechnet den zeitgewichteten Mittelwert

countEntriesDetail - Wenn gesetzt, erstellt die Funktion "countEntries" eine detallierte Ausgabe der Datensatzzahl pro Reading und Zeitintervall. Standardmäßig wird nur die Summe aller selektierten Datensätze ausgegeben.

device - Abgrenzung der DB-Selektionen auf ein bestimmtes oder mehrere Devices.
Es können Geräte-Spezifikationen (devspec) angegeben werden.
Innerhalb von Geräte-Spezifikationen wird SQL-Wildcard (%) als normales ASCII-Zeichen gewertet. Die Devicenamen werden vor der Selektion aus der Geräte-Spezifikationen und den aktuell in FHEM vorhandenen Devices abgeleitet.
Wird dem Device bzw. der Device-Liste oder Geräte-Spezifikation ein "EXCLUDE=" vorangestellt, werden diese Devices von der Selektion ausgeschlossen.
Falls weitere Informationen zu Geräte-Spezifikationen benötigt werden, bitte "get <name> versionNotes 3" ausführen.

diffAccept - gilt für Funktion diffValue. diffAccept legt fest bis zu welchem Schwellenwert eine berechnete positive Werte-Differenz zwischen zwei unmittelbar aufeinander folgenden Datensätzen akzeptiert werden soll (Standard ist 20).
Damit werden fehlerhafte DB-Einträge mit einem unverhältnismäßig hohen Differenzwert von der Berechnung ausgeschlossen und verfälschen nicht das Ergebnis. Sollten Schwellenwertüberschreitungen vorkommen, wird das Reading "diff_overrun_limit_<diffLimit>" erstellt. (<diffLimit> wird dabei durch den aktuellen Attributwert ersetzt) Es enthält eine Liste der relevanten Wertepaare. Mit verbose 3 werden diese Datensätze ebenfalls im Logfile protokolliert.

disable - deaktiviert das Modul

dumpComment - User-Kommentar. Er wird im Kopf des durch den Befehl "dumpMyQL clientSide" erzeugten Dumpfiles eingetragen.

dumpCompress - wenn gesetzt, werden die Dumpfiles nach "dumpMySQL" bzw. "dumpSQLite" komprimiert

dumpDirLocal - Zielverzeichnis für die Erstellung von Dumps mit "dumpMySQL clientSide". default: "{global}{modpath}/log/" auf dem FHEM-Server.
Ebenfalls werden in diesem Verzeichnis alte Backup-Files durch die interne Versionsverwaltung von "dumpMySQL" gesucht und gelöscht wenn die gefundene Anzahl den Attributwert "dumpFilesKeep" überschreitet. Das Attribut dient auch dazu ein lokal gemountetes Verzeichnis "dumpDirRemote" DbRep bekannt zu machen.

dumpDirRemote - Zielverzeichnis für die Erstellung von Dumps mit "dumpMySQL serverSide". default: das Home-Dir des MySQL-Servers auf dem MySQL-Host

dumpMemlimit - erlaubter Speicherverbrauch für das Dump SQL-Script zur Generierungszeit (default: 100000 Zeichen). Bitte den Parameter anpassen, falls es zu Speicherengpässen und damit verbundenen Performanceproblemen kommen sollte.

dumpSpeed - Anzahl der abgerufenen Zeilen aus der Quelldatenbank (default: 10000) pro Select durch "dumpMySQL ClientSide". Dieser Parameter hat direkten Einfluß auf die Laufzeit und den Ressourcenverbrauch zur Laufzeit.

dumpFilesKeep - Es wird die angegebene Anzahl Dumpfiles im Dumpdir belassen (default: 3). Sind mehr (ältere) Dumpfiles vorhanden, werden diese gelöscht nachdem ein neuer Dump erfolgreich erstellt wurde. Das globale Attribut "archivesort" wird berücksichtigt.

executeAfterProc - Es kann ein FHEM-Kommando oder eine Perl-Funktion angegeben werden welche nach der Befehlsabarbeitung ausgeführt werden soll.
Funktionen sind in {} einzuschließen.

executeBeforeProc - Es kann ein FHEM-Kommando oder eine Perl-Funktion angegeben werden welche vor der Befehlsabarbeitung ausgeführt werden soll.
Funktionen sind in {} einzuschließen.

expimpfile </Pfad/Filename> [MAXLINES=<lines>] - Pfad/Dateiname für Export/Import in/aus einem File.

Optional kann über den Parameter "MAXLINES" die maximale Anzahl von Datensätzen angegeben werden, die in ein File exportiert werden. In diesem Fall werden mehrere Files mit den Extensions "_part1", "_part2", "_part3" usw. erstellt.
Der Dateiname kann Platzhalter enthalten die gemäß der nachfolgenden Tabelle ersetzt werden. Weiterhin können %-wildcards der POSIX strftime-Funktion des darunterliegenden OS enthalten sein (siehe auch strftime Beschreibung).

%L	: wird ersetzt durch den Wert des global logdir Attributs
%TSB	: wird ersetzt durch den (berechneten) Wert des timestamp_begin Attributs

	Allgemein gebräuchliche POSIX-Wildcards sind:
%d	: Tag des Monats (01..31)
%m	: Monat (01..12)
%Y	: Jahr (1970...)
%w	: Wochentag (0..6); beginnend mit Sonntag (0)
%j	: Tag des Jahres (001..366)
%U	: Wochennummer des Jahres, wobei Wochenbeginn = Sonntag (00..53)
%W	: Wochennummer des Jahres, wobei Wochenbeginn = Montag (00..53)

Beispiele:

attr <name> expimpfile /sds1/backup/exptest_%TSB.csv

attr <name> expimpfile /sds1/backup/exptest_%Y-%m-%d.csv

Zur POSIX Wildcardverwendung siehe auch die Erläuterungen zu Filelog.

fastStart - Normalerweise verbindet sich jedes DbRep-Device beim FHEM-Start kurz mit seiner Datenbank um benötigte Informationen abzurufen und das Reading "state" springt bei Erfolg auf "connected". Ist dieses Attribut gesetzt, erfolgt die initiale Datenbankverbindung erst dann wenn das DbRep-Device sein erstes Kommando ausführt.
Das Reading "state" verbleibt nach FHEM-Start solange im Status "initialized". Diese Einstellung kann hilfreich sein wenn viele DbRep-Devices definiert sind.

fetchMarkDuplicates - Markierung von mehrfach vorkommenden Datensätzen im Ergebnis des "fetchrows" Kommandos

fetchRoute [descent | ascent] - bestimmt die Leserichtung des fetchrows-Befehl.

ftpUse - FTP Transfer nach einem Dump wird eingeschaltet (ohne SSL Verschlüsselung). Das erzeugte Datenbank Backupfile wird non-blocking zum angegebenen FTP-Server (Attribut "ftpServer") übertragen.

ftpUseSSL - FTP Transfer mit SSL Verschlüsselung nach einem Dump wird eingeschaltet. Das erzeugte Datenbank Backupfile wird non-blocking zum angegebenen FTP-Server (Attribut "ftpServer") übertragen.

ftpUser - User zur Anmeldung am FTP-Server nach einem Dump, default: "anonymous".

ftpDebug - Debugging der FTP Kommunikation zur Fehlersuche.

ftpDir - Verzeichnis des FTP-Servers in welches das File nach einem Dump übertragen werden soll (default: "/").

ftpDumpFilesKeep - Es wird die angegebene Anzahl Dumpfiles im <ftpDir> belassen (default: 3). Sind mehr (ältere) Dumpfiles vorhanden, werden diese gelöscht nachdem ein neuer Dump erfolgreich übertragen wurde.

ftpPassive - setzen wenn passives FTP verwendet werden soll

ftpPort - FTP-Port, default: 21

ftpPwd - Passwort des FTP-Users, default nicht gesetzt

ftpServer - Name oder IP-Adresse des FTP-Servers zur Übertragung von Files nach einem Dump.

ftpTimeout - Timeout für eine FTP-Verbindung in Sekunden (default: 30).

limit - begrenzt die Anzahl der resultierenden Datensätze im select-Statement von "fetchrows", bzw. der anzuzeigenden Datensätze der Kommandos "delSeqDoublets adviceDelete", "delSeqDoublets adviceRemain" (default 1000). Diese Limitierung soll eine Überlastung der Browsersession und ein blockieren von FHEMWEB verhindern. Bei Bedarf entsprechend ändern bzw. die Selektionskriterien (Zeitraum der Auswertung) anpassen.

optimizeTablesBeforeDump - wenn "1", wird vor dem Datenbankdump eine Tabellenoptimierung ausgeführt (default: 0). Dadurch verlängert sich die Laufzeit des Dump.

reading - Abgrenzung der DB-Selektionen auf ein bestimmtes oder mehrere Readings sowie exkludieren von Readings. Mehrere Readings werden als Komma separierte Liste angegeben. SQL Wildcard (%) wird in einer Liste als normales ASCII-Zeichen gewertet.
Wird dem Reading bzw. der Reading-Liste ein "EXCLUDE=" vorangestellt, werden diese Readings von der Selektion ausgeschlossen.

readingNameMap - der Name des ausgewerteten Readings wird mit diesem String für die Anzeige überschrieben

readingPreventFromDel - Komma separierte Liste von Readings die vor einer neuen Operation nicht gelöscht werden sollen

role - die Rolle des DbRep-Device. Standard ist "Client". Die Rolle "Agent" ist im Abschnitt "DbRep-Agent" beschrieben.
Siehe auch Abschnitt DbRep-Agent.

seqDoubletsVariance - akzeptierte Abweichung (+/-) für das Kommando "set <name> delSeqDoublets".
Der Wert des Attributs beschreibt die Abweichung bis zu der aufeinanderfolgende numerische Werte (VALUE) von Datensätze als gleich angesehen und gelöscht werden sollen. "seqDoubletsVariance" ist ein absoluter Zahlenwert, der sowohl als positive als auch negative Abweichung verwendet wird.

showproctime - wenn gesetzt, zeigt das Reading "sql_processing_time" die benötigte Abarbeitungszeit (in Sekunden) für die SQL-Ausführung der durchgeführten Funktion. Dabei wird nicht ein einzelnes SQl-Statement, sondern die Summe aller notwendigen SQL-Abfragen innerhalb der jeweiligen Funktion betrachtet.

showStatus - grenzt die Ergebnismenge des Befehls "get <name> dbstatus" ein. Es können SQL-Wildcard (%) verwendet werden.

showVariables - grenzt die Ergebnismenge des Befehls "get <name> dbvars" ein. Es können SQL-Wildcard (%) verwendet werden.

showSvrInfo - grenzt die Ergebnismenge des Befehls "get <name> svrinfo" ein. Es können SQL-Wildcard (%) verwendet werden.

showTableInfo - grenzt die Ergebnismenge des Befehls "get <name> tableinfo" ein. Es können SQL-Wildcard (%) verwendet werden.

sqlCmdHistoryLength - aktiviert die Kommandohistorie von "sqlCmd" und legt deren Länge fest

sqlCmdVars - Setzt eine SQL Session Variable oder PRAGMA vor jedem mit sqlCmd ausgeführten SQL-Statement

sqlResultFieldSep - legt den verwendeten Feldseparator (default: "|") im Ergebnis des Kommandos "set ... sqlCmd" fest.

sqlResultFormat - legt die Formatierung des Ergebnisses des Kommandos "set <name> sqlCmd" fest. Mögliche Optionen sind:

timeYearPeriod - Mit Hilfe dieses Attributes wird eine jährliche Zeitperiode für die Datenbankselektion bestimmt. Die Zeitgrenzen werden zur Ausführungszeit dynamisch berechnet. Es wird immer eine Jahresperiode bestimmt. Eine unterjährige Angabe ist nicht möglich.
Dieses Attribut ist vor allem dazu gedacht Auswertungen synchron zu einer Abrechnungsperiode, z.B. der eines Energie- oder Gaslieferanten, anzufertigen.

timestamp_begin - der zeitliche Beginn für die Datenselektion
Das Format von Timestamp ist "YYYY-MM-DD HH:MM:SS". Für die Attribute "timestamp_begin", "timestamp_end" kann ebenso eine der folgenden Eingaben verwendet werden. Dabei wird das timestamp-Attribut dynamisch belegt:

timestamp_end - das zeitliche Ende für die Datenselektion. Wenn nicht gesetzt wird immer die aktuelle Datum/Zeit-Kombi für das Ende der Selektion eingesetzt.
Das Format von Timestamp ist "YYYY-MM-DD HH:MM:SS". Für die Attribute "timestamp_begin", "timestamp_end" kann ebenso eine der folgenden Eingaben verwendet werden. Dabei wird das timestamp-Attribut dynamisch belegt:
Natürlich sollte man immer darauf achten dass "timestamp_begin" < "timestamp_end" ist.
Hinweis
Wird das Attribut "timeDiffToNow" gesetzt, werden die eventuell gesetzten anderen Zeit-Attribute ("timestamp_begin","timestamp_end","timeYearPeriod") gelöscht. Das Setzen von "timestamp_begin" bzw. "timestamp_end" bedingt die Löschung von anderen Zeit-Attribute falls sie vorher gesetzt waren.

timeDiffToNow - der Selektionsbeginn wird auf den Zeitpunkt "<aktuelle Zeit> - <timeDiffToNow>" gesetzt (z.b. werden die letzten 24 Stunden in die Selektion eingehen wenn das Attribut auf "86400" gesetzt wurde). Die Timestampermittlung erfolgt dynamisch zum Ausführungszeitpunkt.
Sind die Attribute "timeDiffToNow" und "timeOlderThan" gleichzeitig gesetzt, wird der Selektionszeitraum zwischen diesen Zeitpunkten dynamisch kalkuliert.

timeOlderThan - das Selektionsende wird auf den Zeitpunkt "<aktuelle Zeit> - <timeOlderThan>" gesetzt. Dadurch werden alle Datensätze bis zu dem Zeitpunkt "<aktuelle Zeit> - <timeOlderThan>" berücksichtigt (z.b. wenn auf 86400 gesetzt, werden alle Datensätze die älter als ein Tag sind berücksichtigt). Die Timestampermittlung erfolgt dynamisch zum Ausführungszeitpunkt.
Sind die Attribute "timeDiffToNow" und "timeOlderThan" gleichzeitig gesetzt, wird der Selektionszeitraum zwischen diesen Zeitpunkten dynamisch kalkuliert.

timeout - das Attribut setzt den Timeout-Wert für die Blocking-Call Routinen in Sekunden (Default: 86400)

userExitFn - stellt eine Schnittstelle zur Ausführung eigenen Usercodes zur Verfügung.
Um die Schnittstelle zu aktivieren, wird zunächst die aufzurufende Subroutine in 99_myUtls.pm nach folgendem Muster erstellt:
```
        sub UserFunction {
          my ($name,$reading,$value) = @_;
          my $hash = $defs{$name};
          ...
          # z.B. übergebene Daten loggen
          Log3 $name, 1, "UserExitFn $name called - transfer parameter are Reading: $reading, Value: $value " ;
          ...
        return;
        }
  	    
```
Die Aktivierung der Schnittstelle erfogt durch Setzen des Funktionsnamens im Attribut. Optional kann ein Reading:Value Regex als Argument angegeben werden. Wird kein Regex angegeben, werden alle Wertekombinationen als "wahr" gewertet (entspricht .*:.*).
Grundsätzlich arbeitet die Schnittstelle OHNE Eventgenerierung bzw. benötigt zur Funktion keinen Event. Sofern das Attribut gesetzt ist, erfolgt Die Regexprüfung NACH der Erstellung eines Readings. Ist die Prüfung WAHR, wird die angegebene Funktion aufgerufen. Zur Weiterverarbeitung werden der aufgerufenenen Funktion folgende Variablen übergeben:
- $name - der Name des DbRep-Devices
- $reading - der Namen des erstellen Readings
- $value - der Wert des Readings

valueFilter - Regulärer Ausdruck (REGEXP) zur Filterung von Datensätzen innerhalb bestimmter Funktionen. Der REGEXP wird auf ein bestimmtes Feld oder den gesamten selektierten Datensatz (inkl. Device, Reading usw.) angewendet. Bitte beachten sie die Erläuterungen zu den entsprechenden Set-Kommandos. Weitere Informationen sind mit "get <name> versionNotes 4" verfügbar.

Readings

state - enthält den aktuellen Status der Auswertung. Wenn Warnungen auftraten (state = Warning) vergleiche Readings "diff_overrun_limit_<diffLimit>" und "less_data_in_period"

errortext - Grund eines Fehlerstatus

background_processing_time - die gesamte Prozesszeit die im Hintergrund/Blockingcall verbraucht wird

diff_overrun_limit_<diffLimit> - enthält eine Liste der Wertepaare die eine durch das Attribut "diffAccept" festgelegte Differenz <diffLimit> (Standard: 20) überschreiten. Gilt für Funktion "diffValue".

less_data_in_period - enthält eine Liste der Zeitperioden in denen nur ein einziger Datensatz gefunden wurde. Die Differenzberechnung berücksichtigt den letzten Wert der Vorperiode. Gilt für Funktion "diffValue".

sql_processing_time - der Anteil der Prozesszeit die für alle SQL-Statements der ausgeführten Operation verbraucht wird

SqlResult - Ergebnis des letzten sqlCmd-Kommandos. Die Formatierung erfolgt entsprechend des Attributes "sqlResultFormat"

sqlCmd - das letzte ausgeführte sqlCmd-Kommando

DbRep Agent - automatisches Ändern von Device-Namen in Datenbanken und DbRep-Definitionen nach FHEM "rename" Kommando

in der dem DbRep-Agenten zugeordneten Datenbank (Internal Database) wird nach Datensätzen mit dem alten Gerätenamen gesucht und dieser Gerätename in allen betroffenen Datensätzen in den neuen Namen geändert.

in dem DbRep-Agenten zugeordneten DbLog-Device wird in der Definition das alte durch das umbenannte Device ersetzt. Dadurch erfolgt ein weiteres Logging des umbenannten Device in der Datenbank.

in den existierenden DbRep-Definitionen vom Typ "Client" wird ein evtl. gesetztes Attribut "device = alter Devicename" in "device = neuer Devicename" geändert. Dadurch werden Auswertungsdefinitionen bei Geräteumbenennungen automatisch konstistent gehalten.

es kann nur einen Agenten pro Datenbank in der FHEM-Installation geben. Ist mehr als eine Datenbank mit DbLog definiert, können ebenso viele DbRep-Agenten eingerichtet werden

mit der Umwandlung in einen Agenten wird nur noch das Set-Komando "renameDevice" verfügbar sein sowie nur ein eingeschränkter Satz von DbRep-spezifischen Attributen zugelassen. Wird ein DbRep-Device vom bisherigen Typ "Client" in einen Agenten geändert, werden evtl. gesetzte und nun nicht mehr zugelassene Attribute glöscht.

Beispiel


        define Rep.Agent DbRep LogDB  

        attr Rep.Agent devStateIcon connected:10px-kreis-gelb .*disconnect:10px-kreis-rot .*done:10px-kreis-gruen 

        attr Rep.Agent icon security      

        attr Rep.Agent role Agent         

        attr Rep.Agent room DbLog         

        attr Rep.Agent showproctime 1     

        attr Rep.Agent stateFormat { ReadingsVal("$name","state", undef) eq "running" ? "renaming" : ReadingsVal("$name","state", undef). " »; ProcTime: ".ReadingsVal("$name","sql_processing_time", undef)." sec"}  

        attr Rep.Agent timeout 86400

Hinweis:

DoorBird

[EN DE]

Das DoorBird Modul ermöglicht die Komminikation zwischen der DoorBird Interkommunikationseinheit und dem fhem Automationssystem basierend auf der API des Herstellers her.
Für den vollen Funktionsumfang muss sichergestellt werden, dass das Setting "API-Operator" in der DoorBird Android/iPhone - APP unter "Administration -> User -> Edit -> Permission -> API-Operator" gesetzt ist. Die folgenden Software - Pakete müssen noch zusätzlich installiert werden, sofern dies nicht schon durch andere Module erfolgt ist. (Die Beispiele sind auf dem Raspberry JESSIE gestestet):


					sudo apt-get install sox					
					sudo apt-get install libsox-fmt-all			
					sudo apt-get install libsodium-dev			
					sudo cpan Crypt::Argon2						
					sudo cpan Alien::Base::ModuleBuild			
					sudo cpan Alien::Sodium						
					sudo cpan Crypt::NaCl::Sodium

Define

define <name> DoorBird <IPv4-address> <Username> <Passwort>

`<name>` :	Der Name des Device unter fhem. Beispiel: "myDoorBird".
`<IPv4-Addresse>` :	Eine gültige IPv4 - Addresse der DoorBird-Anlage. Ggf. muss man im Router nach der entsprechenden DHCP Addresse suchen, die der DoorBird Anlage vergeben wurde.
`<Username>` :	Der Username zum einloggen auf der DoorBird Anlage.
`<Passwort>` :	Das Passwort zum einloggen auf der DoorBird Anlage.

Set

Die Set - Funktion ist in der lage auf der DoorBird - Anlage die folgenden Einstellungen vorzunehmen bzw. zu de-/aktivieren:

`set Light_On`	: Schaltet das IR lichht der DoorBird Anlage ein. Das IR Licht schaltet sich automatisch nach der in der DoorBird - Anlage vorgegebenen Default Zeit wieder aus.
`set Live_Audio <on:off>`	: Aktiviert/Deaktiviert den Live Audio Stream der DoorBird - Anlage Ein oder Aus und wechselt den direkten link in dem versteckten Reading `.AudioURL.`
`set Live_Video <on:off>`	: Aktiviert/Deaktiviert den Live Video Stream der DoorBird - Anlage Ein oder Aus und wechselt den direkten link in dem versteckten Reading `.VideoURL.`
`set Open Door <Value>`	: Aktiviert das Relais der DoorBird - Anlage mit dessen Adresse. Die Liste der installierten Relais werden mit der Initialisierung der Parameter importiert.
`set Restart`	: Sendet das Kommando zum rebooten der DoorBird - Anlage.
`set Transmit_Audio <Path>`	: Konvertiert die angegebene Audio-Datei und sendet diese zur Ausgabe an die DoorBird - Anlage. Es benötigt einen Dateipfad zu der Audio-Datei zu dem der User "fhem" Schreibrechte braucht (z.B.: /opt/fhem/audio).

Get

`get History_Request`	: Lädt die Bilder der letzten Ereignisse durch die Türklingel und dem Bewegungssensor herunter. (Siehe auch Attribut `MaxHistory`)
`get Image_Request`	: Lädt das gegenwärtige Bild der DoorBird - Kamera herunter.
`get Info_Request`	: Lädt das interne Setup (Firmware Version, Relais Konfiguration etc.) herunter. Die übermittelten Relais-Adressen werden als Option für das Kommando `Open_Door` verwendet.

Attributes

room

`disable` :	Stoppt das Gerät von weiteren Reaktionen auf die von der DoorBird ß Anlage ausgesendeten UDP - Datageramme Der Default Wert ist 0 = aktiviert
`KeepAliveTimeout` :	Timeout in Sekunden ohne "still-alive" - UDP Datagramme bevor der Status des Gerätes auf "disconnected" gesetzt wird. Der Default Wert ist 30s
`MaxHistory` :	Anzahl der herunterzuladenden Bilder aus dem Historien-Archiv sowohl für Ereignisse seitens der Türklingel als auch für den Bewegungssensor. Der Default Wert ist "50" = Maximum.
`PollingTimeout` :	Timeout in Sekunden before der Download-Versuch aufgrund fehlender Antwort seitens der DoorBird-Anlage terminiert wird. Eine Adjustierung mag notwendig sein, sobald Netzwerk-Latenzen aufteten. Der Default-Wert ist 10s.
`UdpPort` :	Port Nummer auf welcher das DoorBird - Modul nach den UDP Datagrammen der DoorBird - Anlage hören soll. Die Ports sind von der Firmware vorgegeben. Der Default Port ist 6524
`SessionIdSec` :	Zeit in Sekunden nach welcher die Session Id erneuert werden soll. Diese ist für die sichere Übertragung der Video und Audio Verbindungsdaten notwendig. Die DoorBird-Unit devalidiert die Session Id automatisch nach 10min. Für den Fall, dass die DoorBird Kamera an ein Überwachungssystem angebunden werden soll, muss diese Funktion ausser Betrieb genommen werden indem man den Wert auf 0 setzt 0. Der Default Wert ist 540s = 9min.
`SipDevice` :	Name des fhem SIP Device mit wessen Nummer in der DoorBird - Anlage hinterlegt wurde die die DoorBird - Anlage anrufen dürfen. Refer to SIP. Der Default Wert ist das erste SIP device in fhem.
`SipNumber` :	Die Telefonnummer unter der die DoorBird / Anlage registriert und erreicht werden kann. Der Default Wert ist `**620`
`ImageFileDir` :	Der relative (z.B. "images") oder absolute (z.B. "/mnt/NAS/images") Verzeichnispfad mit oder ohne nachfolgendem Pfadzeichen "/" in welchen die Bild-Dateien gespeichert werden sollen. Der Default Wert ist `0` = deaktiviert
`EventReset` :	Zeit in Sekunden nach welcher die Readings für die Events (z.B. "doorbell_button", "motions sensor", "keypad")wieder auf "idle" gesetzt werden sollen. Der Default Wert ist 5s
`WaitForHistory` :	Zeit in Sekunden die das Modul auf das Bereitstellen eines korrespondierenden History Bildes zu einem Event warten soll. Muss ggf. adjustiert werden, sobald deutliche Unterschiede in der Systemzeit zwischen fhemßServer und DoorBird Station vorliegen. Der Default Wert ist 7s

Dooya

EC3000

ECMD

ECMDDevice

EGPM Steckdose

[EN DE]

EGPM2LAN

Define

define <name> EGPM <device> <socket-nr>

Set

set <name> <[on|off|toggle]>

fritzbox-remote-phonebook

define lampe1 EGPM steckdose 1

set lampe1 on

Get

N/A

Attributes

readingFnAttributes

Generated events

EGPM <name> <[on|off]>

EGPM2LAN

[EN DE]

Define

define <name> EGPM2LAN <IP-Address>

Energenie EG-PM2-LAN

Logoff

Set

set <name> <[on|off|toggle]> <socketnr.>

set <name> <[on|off]> <all>

set <name> password [<mein-passwort>]

set <name> <staterequest>

autocreate

EGPM

set <name> <clearreadings>

Get

get <name> state

Attribute

stateDisplay

socketNumer

socketName

set statusrequest

autocreate

EGPM

set

loglevel
readingFnAttributes

define sleiste EGPM2LAN 10.192.192.20

set sleiste password SecretGarden

set sleiste on 1

EIB

EM

EMEM

EMGZ

EMT7110

EMWZ

ENECSYSGW

ENECSYSINV

ENIGMA2

[EN DE]

Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:

ENIGMA2

EQ3BT

ESA2000

ESPEasy

ElectricityCalculator

[EN DE]

Das ElectricityCalculator Modul berechnet den Verbrauch an elektrischer Energie (Stromverbrauch) und den verbundenen Kosten von einem oder mehreren Elektrizitätszählern.
Es ist kein eigenes Zählermodul sondern benötigt eine Regular Expression (regex or regexp) um das Reading mit den Zählimpulse von einem oder mehreren Electrizitätszählern zu finden.

Sobald das Modul in der fhem.cfg definiert wurde, reagiert das Modul auf jedes durch das regex definierte event wie beispielsweise ein myOWDEVICE:counter.* etc.

Das ElectricityCalculator Modul berechnet augenblickliche, historische statistische und vorhersehbare Werte von einem oder mehreren Elektrizitätszählern und erstellt die entsprechenden Readings.

Um zu verhindern, dass man bis zu 12 Monate warten muss, bis alle Werte der Realität entsprechen, müssen die Readings
<DestinationDevice>_<SourceCounterReading>_CounterDay1st,
<DestinationDevice>_<SourceCounterReading>_CounterMonth1st,
<DestinationDevice>_<SourceCounterReading>_CounterYear1st und
<DestinationDevice>_<SourceCounterReading>_CounterMeter1st
entsprechend mit dem setreading - Befehl korrigiert werden.
Diese Werte findet man unter Umständen auf der letzten Abrechnung des Elektrizitätsversorgers. Andernfalls dauert es bis zu 24h für die täglichen, 30 Tage für die monatlichen und bis zu 12 Monate für die jährlichen Werte bis diese der Realität entsprechen.

Intervalle kleienr als 10s werden ignoriert um Spitzen zu verhindern die von Blockaden des fhem Systems hervorgerufen werden (z.B. DbLog - reducelog).

Define

define <name> ElectricityCalculator <regex>

`<name>` :	Der Name dieses Berechnungs-Device. Empfehlung: "myElectricityCalculator".
`<regex>` :	Eine gültige Regular Expression (regex or regexp) von dem Event wo der Zählerstand gefunden werden kann

define myElectricityCalculator ElectricityCalculator myElectricityCounter:countersA.*

Set

set

Get

get

Attributes

room


`BasicPricePerAnnum` :	Eine gültige float Zahl für die jährliche Grundgebühr in der gewählten Währung für die Elektrizitäts-Versorgung zum Endverbraucher. Dieser Wert stammt vom Elektrizitätsversorger und steht auf der Abrechnung. Der Standard Wert ist 0.00


`Currency` :	Eines der vordefinerten Währungssymbole: [€,£,$]. Der Standard Wert ist €


`disable` :	Deaktiviert das device. Das Modul wird nicht mehr auf die Events reagieren die durch die Regular Expression definiert wurde. Der Standard Wert ist 0 = aktiviert.


`ElectricityCounterOffset` :	Eine gültige float-Zahl für den Unterschied = Offset (Nicht der Unterschied zwischen Zählimpulsen) zwischen dem am mechanischen Elektrizitätszählern und dem angezeigten Wert im Reading dieses Device. Der Offset-Wert wird wie folgt ermittelt: W_Offset = W_Mechanisch - W_Module Der Standard-Wert ist 0.00

ElectricityKwhPerCounts : Eine gültige float-Zahl für die Menge kWh pro Zählimpulsen.
Der Wert ist durch das mechanische Zählwerk des Elektrizitätszählern vorgegeben. ElectricityKwhPerCounts = 0.001 bedeutet, dass jeder Zählimpuls ein Tausendstel einer kWh ist (=Wh).
Einige elektronische Z�hler (Bsp.: HomeMatic HM-ES-TX-WM) stellen die gez�hlte Menge an elektrischer Energie als Wh bereit.
Aus diesem Grund muss dieses Attribut auf 0.001 gesetzt werden um eine korrekte Transformation in kWh zu ermöglichen.
Der Standard-Wert ist 1


`ElectricityPricePerKWh` :	Eine gültige float-Zahl für den Preis pro kWh. Dieser Wert stammt vom Elektrizitätsversorger und steht auf der Abrechnung. Der Standard-Wert ist 0.2567


`MonthlyPayment` :	Eine gültige float-Zahl für die monatlichen Abschlagszahlungen in der gewählten Währung an den Elektrizitätsversorger. Der Standard-Wert ist 0.00


`MonthOfAnnualReading` :	Eine gültige Ganz-Zahl für den Monat wenn der mechanische Elektrizitätszähler jedes Jahr durch den Elektrizitätsversorger abgelesen wird. Der Standard-Wert ist 5 (Mai)


`ReadingDestination` :	Eines der vordefinerten Device als Ziel der errechneten Readings: [CalculatorDevice,CounterDevice]. Das CalculatorDevice ist das mit diesem Modul erstellte Device. Das CounterDevice ist das Device von welchem der mechanische Zähler ausgelesen wird. Der Standard-Wert ist CalculatorDevice.


`SiPrefixPower` :	Ein Wert der vorgegebenen Auswahlliste: W (Watt), kW (Kilowatt), MW (Megawatt) or GW (Gigawatt). Es definiert welcher SI-Prefix verwendet werden soll und teilt die Leistung entsprechend durch ein Vielfaches von 1000. Der Standard-Wert ist W (Watt).

Readings

<DestinationDevice>

ReadingDestination

<SourceCounterReading>


`<DestinationDevice>_<SourceCounterReading>_CounterCurrent` :	Aktueller Zählerstand am mechanischen Zähler. Bei Unterschied muss das Offset-Attribut entspechend korrigiert werden.


`<DestinationDevice>_<SourceCounterReading>_CounterDay1st` :	Der erste Zählerstand des laufenden Tages seit Mitternacht.


`<DestinationDevice>_<SourceCounterReading>_CounterDayLast` :	Der letzte Zählerstand des vorherigen Tages.


`<DestinationDevice>_<SourceCounterReading>_CounterMeter1st` :	Der erste Zählerstand seit Mitternacht des ersten Tages der laufenden Ableseperiode.


`<DestinationDevice>_<SourceCounterReading>_CounterMeterLast` :	Der letzte Zählerstand seit Mitternacht des ersten Tages der vorherigen Ableseperiode.


`<DestinationDevice>_<SourceCounterReading>_CounterMonth1st` :	Der erste Zählerstand seit Mitternacht des ersten Tages des laufenden Monats.


`<DestinationDevice>_<SourceCounterReading>_CounterMonthLast` :	Der letzte Zählerstand des vorherigen Monats.


`<DestinationDevice>_<SourceCounterReading>_CounterYear1st` :	Der erste Zählerstand seit Mitternacht des ersten Tages des laufenden Jahres.


`<DestinationDevice>_<SourceCounterReading>_CounterYearLast` :	Der letzte Zählerstand des letzten Jahres.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostDayLast` :	Elektrische Energiekosten des letzten Tages.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostMeterLast` :	Elektrische Energiekosten der letzten Ableseperiode.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostMonthLast` :	Elektrische Energiekosten des letzten Monats.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostYearLast` :	Elektrische Energiekosten des letzten Kalenderjahres.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostDay` :	Energiekosten in gewählter Währung seit Mitternacht des laufenden Tages.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostMeter` :	Energiekosten in gewählter Währung seit Beginn der laufenden Ableseperiode.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostMonth` :	Energiekosten in gewählter Währung seit Beginn des laufenden Monats.


`<DestinationDevice>_<SourceCounterReading>_EnergyCostYear` :	Energiekosten in gewählter Währung seit Beginn des laufenden Kalenderjahres.


`<DestinationDevice>_<SourceCounterReading>_EnergyDay` :	Energieverbrauch seit Beginn der aktuellen Tages (Mitternacht).


`<DestinationDevice>_<SourceCounterReading>_EnergyDayLast` :	Energieverbrauch in kWh des vorherigen Tages.


`<DestinationDevice>_<SourceCounterReading>_EnergyMeter` :	Energieverbrauch seit Beginn der aktuellen Ableseperiode.


`<DestinationDevice>_<SourceCounterReading>_EnergyMeterLast` :	Energieverbrauch in kWh der vorherigen Ableseperiode.


`<DestinationDevice>_<SourceCounterReading>_EnergyMonth` :	Energieverbrauch seit Beginn des aktuellen Monats.


`<DestinationDevice>_<SourceCounterReading>_EnergyMonthLast` :	Energieverbrauch in kWh des vorherigen Monats.


`<DestinationDevice>_<SourceCounterReading>_EnergyYear` :	Energieverbrauch seit Beginn des aktuellen Kalenderjahres.


`<DestinationDevice>_<SourceCounterReading>_EnergyYearLast` :	Energieverbrauch in kWh des vorherigen Kalenderjahres.


`<DestinationDevice>_<SourceCounterReading>_FinanceReserve` :	Finanzielle Reserve basierend auf den Abschlagszahlungen die jeden Monat an den Elektrizitätsversorger gezahlt werden. Bei negativen Werten ist von einer Nachzahlung auszugehen.


`<DestinationDevice>_<SourceCounterReading>_MonthMeterReading` :	Anzahl der Monate seit der letzten Z�hlerablesung. Der Monat der Z�hlerablesung ist der erste Monat = 1.


`<DestinationDevice>_<SourceCounterReading>_PowerCurrent` :	Aktuelle elektrische Leistung. (Mittelwert zwischen aktueller und letzter Messung)


`<DestinationDevice>_<SourceCounterReading>_PowerDayAver` :	Mittlere elektrische Leistung seit Mitternacht.


`<DestinationDevice>_<SourceCounterReading>_PowerDayMax` :	Maximale elektrische Leistungsaufnahme seit Mitternacht.


`<DestinationDevice>_<SourceCounterReading>_PowerDayMin` :	Minimale elektrische Leistungsaufnahme seit Mitternacht.

EleroDrive

EleroStick

EleroSwitch

ElsnerWS

EnOcean

FBAHA

[EN DE]

FBDECT

Define

define <name> FBAHA <device>

define fb1 FBAHA fritz.box:2002

define fb1 FBAHA UNIX:SEQPACKET:/var/tmp/me_avm_home_external.ctl

Set

createDevs
legt FHEM Geräte an für jedes auf dem AHA-Server gefundenen DECT Eintrag, siehe auch "get devList".
reopen
Schließt und öffnet die Verbindung zum AHA Server. Nur für debugging.
reregister
Gibt den AHA handle frei, und registriert sich erneut beim AHA Server. Nur für debugging.

Get

devList
liefert die Liste aller DECT-Einträge der AHA Server zurück, mit einem kurzen Info.

Attributes

dummy

Generierte Events:

UNDEFINED FBDECT_$ahaName_${NR} FBDECT $id"

FBAHAHTTP

FBDECT

[EN DE]

FBAHA

FBAHAHTTP

Define

define <name> FBDECT [<FBAHAname>:]<id> props

define lampe FBDECT 16 switch,powerMeter

Achtung:

autocreate

Set

on/off
Gerät einschalten bzw. ausschalten.
desired-temp <value>
Gewünschte Temperatur beim Comet DECT setzen. 7.5 entspricht aus, 28.5 bedeutet an.
Die set extensions werden unterstützt.
msgInterval <sec>
Anzahl der Sekunden zwischen den Sensornachrichten (nur mit FBAHA als IODev).

Get

devInfo
meldet Geräte-Informationen (nur mit FBAHA als IODev)

Attribute

IODev
disable
disabledForIntervals
do_not_notify
ignore
dummy
showtime
model
readingFnAttributes

Generierte events:

on
off
set_on
set_off
current: $v A
voltage: $v V
power: $v W
energy: $v Wh
powerFactor: $v"
temperature: $v C ([measured|corrected])
options: uninitialized
options: powerOnState:[on|off|last],lock:[none,webUi,remoteFb,button]
control: disabled
control: on power < $v delay:$d sec do:state [on|off]
relaytimes: disabled
relaytimes: HEX

FB_CALLLIST

[EN DE]

FB_CALLMONITOR

iconPath

blau - Eingehender Anruf (aktiv oder beendet)
grün - Ausgehender Anruf (aktiv oder beendet))
rot - Verpasster Anruf (eingehend)

show-icons

<= ((o)) - Ausgehender Anruf (klingelt)
=> ((o)) - Eingehender Anruf (klingelt)

<= [=] - Ausgehender Anruf (laufendes Gespräch)
=> [=] - Eingehender Anruf (laufendes Gespräch)

<= X - Ausgehender, erfolgloser Anruf (Gegenseite nicht abgenommen)
=> X - Eingehender, erfolgloser Anruf (Verpasster Anruf)

=> O_O - Eingehender Anruf, der durch einen Anrufbeantworter entgegen genommen wurde

<= - Ausgehender Anruf (beendet)
=> - Eingehender Anruf (beendet)

Definition

define <Name> FB_CALLLIST <FB_CALLMONITOR Name>

Set-Kommandos

clear - löscht die gesamte Anrufliste

Get

N/A

Attributes

do_not_notify
readingFnAttributes

answMachine-is-missed-call 0,1

list-type

create-readings 0,1

event-on-change-reading

.*

connection-mapping <hash>

attr <name> connection-mapping {'DECT_1' => 'Mobilteil Küche', 'FON1' => 'Fax', 'Answering_Machine_1' => 'Anrufbeantworter'}

nicht gesetzt

contactImageDirectory <Verzeichnis>

visible-columns

0123456789.jpg

0345678901.gif

contactDefaultImage <Dateiname>

contactImageDirectory

unknown.jpg

contactImageDirectory

disable 0,1,2,3

0 => Anrufliste ist aktiv, verarbeitet Events und aktualisiert die Darstellung kontinuierlich.
1 => Events werden NICHT verarbeitet. Die Darstellung wird NICHT aktualisiert (bleibt wie sie ist).
2 => Events werden NICHT verarbeitet. Die Darstellung zeigt nur "disabled" an (keine Einträge mehr).
3 => Events werden NICHT verarbeitet. Die Liste wird NICHT mehr angezeigt.

disabledForIntervals HH:MM-HH:MM HH:MM-HH:MM...

disable

23:00-24:00 00:00-01:00

nicht gesetzt

processEventsWhileDisabled 0,1

disabled

disabledForIntervals

expire-calls-after <Zeitfenster>

als Minuten: 1 minute oder 30 minutes
als Stunden: 1 hour oder 12 hours
als Tage: 1 day oder 5 days
als Monate: 1 month oder 6 months (ein Monat entspricht hierbei 30 Tagen month is here equal to 30 days)
als Jahr: 1 year oder 2 years (ein Jahr entspricht hierbei 365 Tagen)

WICHTIG:

0.5 day

0

external-mapping <Hash>

attr <name> external-mapping {'ISDN' => 'Festnetz', 'SIP0' => 'Anbieter A', 'SIP1' => 'Anbieter B'}

nicht gesetzt

icon-mapping <hash>

attr <name> icon-mapping {'incoming.connected' => 'phone_ring_in@yellow', 'outgoing.missed' => 'phone_missed_out@red'}

incoming.ring => phone_ring@blue
outgoing.ring => phone_ring@green
incoming.connected => phone_ring_in@blue
outgoing.connected => phone_ring_in@green
incoming.missed => phone_missed_in@red
outgoing.missed => phone_missed_out@green
incoming.done => phone_call_end_in@blue
outgoing.done => phone_call_end_out@green
incoming.tam => phone_answering@blue

nicht gesetzt

internal-number-filter <hash>

attr <name> internal-number-filter 304050,304060


      attr <name>  internal-number-filter {'304050' => 'geschftl.', '304060' => 'privat'}

Wichtig:

nicht gesetzt

list-order descending,ascending

list-type all,incoming,outgoing,missed-calls,completed,active

all - Alle Anrufe werden angezeigt
incoming - Alle eingehenden Anrufe werden angezeigt (aktive und abgeschlossene)
outgoing - Alle ausgehenden Anrufe werden angezeigt (aktive und abgeschlossene)
missed-calls - Alle eingehenden, verpassten Anrufe werden angezeigt.
completed - Alle abgeschlossenen Anrufe werden angezeigt (eingehend und ausgehend)
active - Alle aktuell laufenden Anrufe werden angezeigt (eingehend und ausgehend)

no-heading 0,1

no-table-header 0,1

number-cmd <Befehl>

$NUMBER

set FRITZBOX call $NUMBER
{dialNumber("$NUMBER")}

number-of-calls 1..40

show-icons 0,1

time-format-string <String>

%a - Der abgekürzte Wochentagname
%b - Der abgekürzte Monatsname
%S - Die Sekunden als Dezimalzahl
%M - Die Minuten als Dezimalzahl
%H - Die Stunden als Dezimalzahl
%d - Der Tag im Monat als Dezimalzahl
%m - Der Monat als Dezimalzahl
%Y - Das Jahr als Dezimalzahl (4-stellig).

strftime()

language en,de

visible-columns row,state,timestamp,image,name,number,internal,external,connection,duration

row,state,timestamp,image,name,number,internal,external,connection,duration

Generierte Events:

count-all - Die Gesamtanzahl aller angezeigten Anrufe
count-incoming - Die Anzahl aller angezeigten eingehenden Anrufe
count-outgoing - Die Anzahl aller angezeigten ausgehenden Anrufe
count-active - Die Anzahl aller laufenden (noch nicht beendeten) Anrufe
count-completed - Die Anzahl aller bereits abgeschlossenen Anrufe
count-missed-calls - Die Anzahl aller verpassten Anrufe

FB_CALLMONITOR

[EN DE]

Ereignisse

#96*5* - Callmonitor aktivieren
#96*4* - Callmonitor deaktivieren

Definition

define <name> FB_CALLMONITOR <IP-Addresse>[:Port]

Set-Kommandos

reopen - schliesst die Verbindung zur FritzBox und öffnet sie erneut
rereadCache - Liest den Cache aus der Datei neu ein (sofern konfiguriert, siehe dazu Attribut reverse-search-cache-file)
rereadPhonebook - Liest das Telefonbuch der FritzBox neu ein (per Datei, Telnet oder direkt lokal)
rereadTextfile - Liest die nutzereigene Textdatei neu ein (sofern konfiguriert, siehe dazu Attribut reverse-search-text-file)
password - speichert das FritzBox Passwort, welches für das Einlesen aller Telefonbücher direkt von der FritzBox benötigt wird. Dieses Kommando ist nur verfügbar, wenn ein Passwort benötigt wird um das Telefonbuch via Netzwerk einzulesen, siehe dazu Attribut fritzbox-remote-phonebook.

Get-Kommandos

search <Rufnummer> - gibt den Namen der Telefonnummer zurück (aus Cache, Telefonbuch oder Rückwärtssuche)
showPhonebookIds - gibt eine Liste aller verfügbaren Telefonbücher auf der FritzBox zurück (nicht verfügbar wenn das Telefonbuch via Telnet-Verbindung eingelesen wird)
showPhonebookEntries [Phonebook-ID] - gibt eine Liste aller bekannten Telefonbucheinträge, oder nur eines bestimmten Telefonbuchs, zurück (nur verfügbar, wenn eine Rückwärtssuche via Telefonbuch aktiviert ist)
showCacheEntries - gibt eine Liste aller bekannten Cacheeinträge zurück (nur verfügbar, wenn die Cache-Funktionalität der Rückwärtssuche aktiviert ist))
showTextEntries - gibt eine Liste aller Einträge aus der nutzereigenen Textdatei zurück (nur verfügbar, wenn eine Textdatei als Attribut definiert ist))

Attribute

do_not_notify
readingFnAttributes

disable 0,1

disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...

disable

23:00-24:00 00:00-01:00

nicht gesetzt

answMachine-is-missed-call 0,1

Generated Events

reverse-search (phonebook,dasoertliche.de,11880.com,search.ch,dasschnelle.at,herold.at)

reverse-search-cache 0,1

reverse-search-cache-file <Dateipfad>

reverse-search-text-file <Dateipfad>

    <Nummer1>,<Name1>
    <Nummer2>,<Name2>
    ...
    <NummerN>,<NameN>

reverse-search-phonebook-file <Dateipfad>

remove-leading-zero 0,1

unique-call-ids 0,1

local-area-code <Ortsvorwahl>

country-code <Landesvorwahl>

check-deflections 0,1

fritzbox-remote-phonebook-via

fritzbox-remote-phonebook 0,1

fritzbox-remote-phonebook-via tr064,web,telnet

fritzbox-remote-phonebook-exclude <Liste>

fritzbox-remote-phonebook-via

Get-Kommando

showPhonebookIds

fritzbox-user <Username>

fritzbox-remote-phonebook

apiKeySearchCh <API-Key>

tel.search.ch

reverse-search

sendKeepAlives (none,5m,10m,15m,30m,1h)

contactImageDirectory <Verzeichnis>

contactDefaultImage

contactDefaultImage <Dateiname>

contactImageViaTR064 0,1

fritzbox-remote-phonebook-via

tr064

contactImageDirectory

Generierte Events:

event (call|ring|connect|disconnect) - Welches Event wurde genau ausgelöst. ("call" => ausgehender Rufversuch, "ring" => eingehender Rufversuch, "connect" => Gespräch ist zustande gekommen, "disconnect" => es wurde aufgelegt)
direction (incoming|outgoing) - Die Anruf-Richtung ("incoming" => eingehender Anruf, "outgoing" => ausgehender Anruf)
external_number - Die Rufnummer des Gegenübers, welcher anruft (event: ring) oder angerufen wird (event: call)
external_name - Das Ergebniss der Rückwärtssuche (sofern aktiviert). Im Fehlerfall kann diese Reading auch den Inhalt "unknown" (keinen Eintrag gefunden) enthalten. Im Falle einer Zeitüberschreitung bei der Rückwärtssuche und aktiviertem Caching, wird die Rufnummer beim nächsten Mal erneut gesucht.
internal_number - Die interne Rufnummer (Festnetz, VoIP-Nummer, ...) auf welcher man angerufen wird (event: ring) oder die man gerade nutzt um jemanden anzurufen (event: call)
internal_connection - Der interne Anschluss an der Fritz!Box welcher genutzt wird um das Gespräch durchzuführen (FON1, FON2, ISDN, DECT, ...)
external_connection - Der externe Anschluss welcher genutzt wird um das Gespräch durchzuführen ("POTS" => analoges Festnetz, "SIPx" => VoIP Nummer, "ISDN", "GSM" => Mobilfunk via GSM/UMTS-Stick)
call_duration - Die Gesprächsdauer in Sekunden. Dieser Wert wird nur bei einem disconnect-Event erzeugt. Ist der Wert 0, so wurde das Gespräch von niemandem angenommen.
call_id - Die Identifizierungsnummer eines einzelnen Gesprächs. Dient der Zuordnung bei zwei oder mehr parallelen Gesprächen, damit alle Events eindeutig einem Gespräch zugeordnet werden können
missed_call - Dieses Event wird nur generiert, wenn ein eingehender Anruf nicht beantwortet wird. Sofern der Name dazu bekannt ist, wird dieser ebenfalls mit angezeigt.
contact_image - Dieses Event wird nur generiert, wenn das Attribut contactImageDirectory gesetzt ist. Es enthält das zugehörige Kontaktfoto als Dateiname oder "none", falls kein entsprechendes Kontaktfoto existiert, oder die Rufnummer unterdrückt ist.

FHEM2FHEM

[EN DE]

Define

define <name> FHEM2FHEM <host>[:<portnr>][:SSL] [LOG:regexp|RAW:devicename] {portpassword}

remote (entfernten)

Wenn das remote FHEM auf einem eigenen Host läuft, muss "telnetPort" des remote FHEM mit der global Option definiert sein.
ab FHEM Version 5.9 wird in der ausgelieferten Initialversion der fhem.cfg keine telnet Instanz vorkonfiguriert, man muss sie z.Bsp. folgendermaßen definieren:

LOG
Bei Verwendung dieses Verbindungstyps werden alle Ereignisse (Events) der remote FHEM-Installation empfangen. Die Ereignisse sehen aus wie die, die nach inform on Befehl erzeugt werden. Sie können wie lokale Ereignisse durch FileLog oder notify genutzt werden und mit einem regulären Ausdruck gefiltert werden. Die Syntax dafür ist unter der notify-Definition beschrieben.
Einschränkungen: die Geräte der remote Installation werden nicht lokal angelegt und können weder mit list angezeigt noch lokal angesprochen werden. Auf beiden FHEM-Installationen können Geräte gleichen Namens angelegt werden, aber wenn beide dasselbe Ereignis empfangen (z.B. wenn an beiden Installationen CULs angeschlossen sind), werden alle FileLogs und notifys doppelt ausgelöst.
Falls man lokal Geräte mit dem gleichen Namen (z.Bsp. als dummy) angelegt hat, dann werden die Readings von dem lokalen Gerät aktualisiert.
RAW
Bei diesem Verbindungstyp werden unaufbereitete Ereignisse (raw messages) des remote FHEM-Geräts devicename genau so empfangen, als wäre das Gerät lokal verbunden.
Einschränkungen: nur Geräte, welche die "Dispatch-Funktion" unterstützen (CUL, FHZ, CM11, SISPM, RFXCOM, TCM, TRX, TUL) erzeugen raw messages, und für jedes entfernte Gerät muss ein eigenes FHEM2FHEM Objekt erzeugt werden.
devicename muss mit demselben Namen und Typ wie das Remote Devive angelegt sein, aber als Dummy, d.h. als device-node "none". Zusätzlich müssen alle notwendigen Attribute lokal gesetzt sein (z.B. rfmode, wenn die remote CUL im HomeMatic-Modus läuft). Die Verwendung bereits bestehender lokaler Geräte ist zu vermeiden, weil sonst die Duplikatsfilterung nicht richtig funktioniert (siehe dupTimeout).

portpassword

define ds1 FHEM2FHEM 192.168.178.22:7072 LOG:.*

define RpiCUL CUL none 0000

define ds2 FHEM2FHEM 192.168.178.22:7072 RAW:RpiCUL

rename CUL_0 RpiCUL

Set

reopen
Öffnet die Verbindung erneut.

Get

N/A

Attribute

dummy
disable
disabledForIntervals
eventOnly
falls gesetzt, werden nur die Events generiert, und es wird kein Reading aktualisiert. Ist nur im LOG-Mode aktiv.
addStateEvent
falls gesetzt, werden state Events als solche uebertragen. Zu beachten: das Attribut ist nur für LOG-Mode relevant, beim Setzen wird eine zusätzliche reopened Logzeile generiert, und die andere Seite muss aktuell sein.
excludeEvents <regexp> die auf das <regexp> zutreffende Events werden nicht bereitgestellt.

FHEMWEB

[EN DE]

Define

define <name> FHEMWEB <tcp-portnr> [global|IP]

hier

Set

rereadicons
Damit wird die Liste der Icons neu eingelesen, für den Fall, dass Sie Icons löschen oder hinzufügen.
clearSvgCache
Im Verzeichnis www/SVGcache werden SVG Daten zwischengespeichert, wenn das Attribut SVGcache gesetzt ist. Mit diesem Befehl leeren Sie diesen Zwischenspeicher.

Get

icon <logical icon>
Liefert den absoluten Pfad des (logischen) Icons zurück. Beispiel:
pathlist
Zeigt diejenigen Verzeichnisse an, in welchen die verschiedenen Dateien für FHEMWEB liegen.

Attribute

addHtmlTitle
Falls der Wert 0 ist, wird bei den set/get/attr Parametern in der DetailAnsicht der Geräte kein title Attribut gesetzt. Das is bei manchen Screenreadern erforderlich. Die Voreinstellung ist 1.

addStateEvent

alias_<RoomName>
Falls man das Attribut alias_<RoomName> definiert, und dieses Attribut für ein Gerät setzt, dann wird dieser Wert bei Anzeige von <RoomName> verwendet.
Achtung: man kann im userattr auch alias_.* verwenden um alle möglichen Räume abzudecken, in diesem Fall wird aber die Attributauswahl in der Detailansicht für alias_.* nicht funktionieren.

allowfrom

allowedCommands, basicAuth, basicAuthMsg
Diese Attribute müssen ab sofort bei dem passenden allowed Gerät angelegt werden, und sind für eine FHEMWEB Instanz unerwünscht.

allowedHttpMethods
FHEMWEB implementiert die HTTP Methoden GET, POST und OPTIONS. Manche externe Geräte benötigen HEAD, das ist aber in FHEMWEB nicht korrekt implementiert, da FHEMWEB immer ein body zurückliefert, was laut Spec falsch ist. Da ein body in manchen Fällen kein Problem ist, kann man HEAD durch setzen dieses Attributes auf GET|POST|HEAD aktivieren, die Voreinstellung ist GET|POST. OPTIONS ist immer aktiviert.

closeConn
Falls gesetzt, wird pro TCP Verbindung nur ein HTTP Request durchgeführt. Für iOS9 WebApp startups scheint es zu helfen.

cmdIcon
Leerzeichen getrennte Auflistung von cmd:iconName Paaren. Falls gesetzt, wird das webCmd text durch den icon gesetzt. Am einfachsten setzt man cmdIcon indem man "Extend devStateIcon" im Detail-Ansicht verwendet, und den Wert nach cmdIcon kopiert.
Beispiel:

column
Damit werden mehrere Spalten für einen Raum angezeigt, indem sie verschiedene Gruppen Spalten zuordnen. Beispiel:
In diesem Beispiel werden im Raum LivingRoom die FS20 sowie die notify Gruppe in der ersten Spalte, die FHZ und das notify in der zweiten Spalte angezeigt.
Anmerkungen: einige Elemente, wie SVG Plots und readingsGroup können nur dann Teil einer Spalte sein wenn sie in group stehen. Dieses Attribut kann man zum sortieren der Gruppen auch dann verwenden, wenn man nur eine Spalte hat. Leerzeichen im Raum- und Gruppennamen sind für dieses Attribut als %20 zu schreiben. Raum- und Gruppenspezifikation ist jeweils ein %regulärer Ausdruck.

confirmDelete
Löschaktionen weden mit einem Dialog bestätigt. Falls dieses Attribut auf 0 gesetzt ist, entfällt das.

confirmJSError
JavaScript Fehler werden per Voreinstellung in einem Dialog gemeldet. Durch setzen dieses Attributes auf 0 werden solche Fehler nicht gemeldet.

CORS
Wenn auf 1 gestellt, wird FHEMWEB einen "Cross origin resource sharing" Header bereitstellen, näheres siehe Wikipedia.

csrfToken
Falls gesetzt, wird der Wert des Attributes als fwcsrf Parameter bei jedem über FHEMWEB abgesetzten Kommando verlangt, es dient zum Schutz von Cross Site Resource Forgery Angriffen. Falls der Wert random ist, dann wird ein Zufallswert beim jeden FHEMWEB Start neu generiert, falls er none ist, dann wird kein Parameter verlangt. Default ist random für featurelevel 5.8 und größer, und none für featurelevel kleiner 5.8

csrfTokenHTTPHeader
Falls gesetzt (Voreinstellung), FHEMWEB sendet im HTTP Header den csrfToken als X-FHEM-csrfToken, das wird von manchen FHEM-Clients benutzt. Mit 0 kann man das abstellen, um Sites wie shodan.io die Erkennung von FHEM zu erschweren.

CssFiles
Leerzeichen getrennte Liste von .css Dateien, die geladen werden. Die Dateinamen sind relativ zum www Verzeichnis anzugeben. Beispiel:

Css
CSS, was nach dem CssFiles Abschnitt im Header eingefuegt wird.

defaultRoom
Zeigt den angegebenen Raum an falls kein Raum explizit ausgewählt wurde. Achtung: falls gesetzt, wird motd nicht mehr angezeigt. Beispiel:
attr WEB defaultRoom Zentrale

devStateIcon
Erste Variante:
Zweite Variante:
Anmerkung: Obiges gilt pro STATE Zeile. Wenn STATE (durch stateFormat) mehrzeilig ist, wird pro Zeile ein Icon erzeugt.

devStateStyle
Für ein best. Gerät einen best. HTML-Style benutzen. Beispiel:

deviceOverview
Gibt an ob die Darstellung aus der Raum-Ansicht (Zeile mit Gerüteicon, Stateicon und webCmds/cmdIcons) auch in der Detail-Ansicht angezeigt werden soll. Kann auf always, onClick, iconOnly oder never gesetzt werden. Der Default ist always.

editConfig
Falls dieses FHEMWEB Attribut (auf 1) gesetzt ist, dann kann man die FHEM Konfigurationsdatei in dem "Edit files" Abschnitt bearbeiten. Beim Speichern dieser Datei wird automatisch rereadcfg ausgefuehrt, was diverse Nebeneffekte hat.

editFileList
Definiert die Liste der angezeigten Dateien in der "Edit Files" Abschnitt. Es ist eine Newline getrennte Liste von Tripeln bestehend aus Titel, Verzeichnis für die Suche als perl Ausdruck(!), und Regexp. Die Voreinstellung ist:
Achtung: die Verzeichnis Angabe ist nicht flexibel: alle .js/.css/_defs.svg Dateien sind in www/pgm2 ($FW_cssdir), .gplot Dateien in $FW_gplotdir (www/gplot), alles andere in $MW_dir (FHEM).

endPlotNow
Wenn Sie dieses FHEMWEB Attribut auf 1 setzen, werden Tages und Stunden-Plots zur aktuellen Zeit beendet. (Ähnlich wie endPlotToday, nur eben minütlich). Ansonsten wird der gesamte Tag oder eine 6 Stunden Periode (0, 6, 12, 18 Stunde) gezeigt. Dieses Attribut wird nicht verwendet, wenn das SVG Attribut startDate benutzt wird.

endPlotToday
Wird dieses FHEMWEB Attribut gesetzt, so enden Wochen- bzw. Monatsplots am aktuellen Tag, sonst wird die aktuelle Woche/Monat angezeigt.

extraRooms
Durch Leerzeichen oder Zeilenumbruch getrennte Liste von dynamischen Räumen, die zusätzlich angezeigt werden sollen. Beispiel:
attr WEB extraRooms name=Offen:devspec=contact=open.* name=Geschlossen:devspec=contact=closed.*

forbiddenroom
Wie hiddenroom, aber der Zugriff auf die Raum- oder Detailansicht über direkte URL-Eingabe wird unterbunden.

fwcompress
Aktiviert die HTML Datenkompression (Standard ist 1, also ja, 0 stellt die Kompression aus).

hiddengroup
Wie hiddenroom (siehe unten), jedoch auf Gerätegruppen bezogen.
Beispiel: attr WEBtablet hiddengroup FileLog,dummy,at,notify

hiddengroupRegexp
Ein regulärer Ausdruck, um Gruppen zu verstecken.

hiddenroom
Eine Komma getrennte Liste, um Räume zu verstecken, d.h. nicht anzuzeigen. Besondere Werte sind input, detail und save. In diesem Fall werden diverse Eingabefelder ausgeblendent. Durch direktes Aufrufen der URL sind diese Räume weiterhin erreichbar!
Ebenso können Einträge in den Logfile/Commandref/etc Block versteckt werden.

hiddenroomRegexp
Ein regulärer Ausdruck, um Räume zu verstecken. Beispiel:
Achtung: die besonderen Werte input, detail und save müssen mit hiddenroom spezifiziert werden.

httpHeader
Eine oder mehrere HTTP-Header Zeile, die in jede Antwort eingebettet wird. Beispiel:

HTTPS
Ermöglicht HTTPS Verbindungen. Es werden die Perl Module IO::Socket::SSL benötigt, installierbar mit cpan -i IO::Socket::SSL oder apt-get install libio-socket-ssl-perl; (OSX und die FritzBox-7390 haben dieses Modul schon installiert.)
Ein lokales Zertifikat muss im Verzeichis certs erzeugt werden. Dieses Verzeichnis muss im modpath angegeben werden, also auf der gleichen Ebene wie das FHEM Verzeichnis. Beispiel:

icon
Damit definiert man ein Icon für die einzelnen Geräte in der Raumübersicht. Es gibt einen passenden Link in der Detailansicht um das zu vereinfachen. Um ein Bild für die Räume selbst zu definieren muss ein Icon mit dem Namen ico<Raumname>.png im iconPath existieren (oder man verwendet roomIcons, s.u.)

iconPath
Durch Doppelpunkt getrennte Aufzählung der Verzeichnisse, in welchen nach Icons gesucht wird. Die Verzeichnisse müssen unter fhem/www/images angelegt sein. Standardeinstellung ist: $styleSheetPrefix:fhemSVG:openautomation:default
Setzen Sie den Wert auf fhemSVG:openautomation um nur SVG Bilder zu benutzen.

JavaScripts
Leerzeichen getrennte Liste von JavaScript Dateien, die geladen werden. Die Dateinamen sind relativ zum www Verzeichnis anzugeben. Für jede Datei wird ein zusätzliches Attribut angelegt, damit der Benutzer dem Skript Parameter weiterreichen kann. Bei diesem Attributnamen werden Verzeichnisname und fhem_ Präfix entfernt und Param als Suffix hinzugefügt. Beispiel:

longpoll [0|1|websocket]
Falls gesetzt, FHEMWEB benachrichtigt den Browser, wenn Gerätestatuus, Readings or Attribute sich ändern, ein Neuladen der Seite ist nicht notwendig. Zum deaktivieren 0 verwenden.
Falls websocket spezifiziert ist, läuft die Benachrichtigung des Browsers über dieses Verfahren sonst über HTTP longpoll. Achtung: ältere Browser haben keine websocket Implementierung.

longpollSVG
Lädt SVG Instanzen erneut, falls ein Ereignis dessen Inhalt ändert. Funktioniert nur, falls die dazugehörige Definition der Quelle in der .gplot Datei folgenden Form hat: deviceName.Event bzw. deviceName.*. Wenn man den Plot Editor benutzt, ist das übrigens immer der Fall. Die SVG Datei wird bei jedem auslösenden Event dieses Gerätes neu geladen. Die Voreinstellung ist aus. Achtung: das plotEmbed Attribute muss gesetzt sein.

mainInputLength
Länge des maininput Eingabefeldes (Anzahl der Buchstaben, Ganzzahl).

menuEntries
Komma getrennte Liste; diese Links werden im linken Menü angezeigt. Beispiel:
attr WEB menuEntries fhem.de,http://fhem.de,culfw.de,http://culfw.de
attr WEB menuEntries AlarmOn,http://fhemhost:8083/fhem?cmd=set%20alarm%20on

nameDisplay
Das Argument ist Perl-Code, was für jedes Gerät in der Raum-Übersicht ausgeführt wird, um den angezeigten Namen zu berechnen. Dabei kann man die Variable $DEVICE für den aktuellen Gerätenamen, und $ALIAS für den aktuellen alias bzw. Name, falls alias nicht gesetzt ist, verwenden. Z.Bsp. für eine FHEMWEB Instanz mit ungarischer Anzeige fügt man ein global userattr alias_hu hinzu, und man setzt nameDisplay für diese FHEMWEB Instanz auf dem Wert:

nrAxis
(bei mehrfach-Y-Achsen im SVG-Plot) Die Darstellung der Y Achsen benötigt Platz. Hierdurch geben Sie an wie viele Achsen Sie links,rechts [useLeft,useRight] benötigen. Default ist 1,1 (also 1 Achse links, 1 Achse rechts).

ploteditor
Gibt an ob der Plot Editor in der SVG detail ansicht angezeigt werden soll. Kann auf always, onClick oder never gesetzt werden. Der Default ist always.

plotEmbed 0
Falls gesetzt (auf 1), dann werden SVG Grafiken mit <embed> Tags gerendert, da auf älteren Browsern das die einzige Möglichkeit war, SVG dastellen zu können. Falls 0 (die Voreinstellung), dann werden die SVG Grafiken "in-place" gezeichnet.

plotfork
Falls gesetzt, dann werden bestimmte Berechnungen (z.Bsp. SVG und RSS) auf nebenläufige Prozesse verteilt. Voreinstellung ist 0. Achtung: nicht auf Systemen mit wenig Hauptspeicher verwenden.

plotmode
Spezifiziert, wie Plots erzeugt werden sollen:
- SVG
  Die Plots werden mit Hilfe des SVG Moduls als SVG Grafik gerendert. Das ist die Standardeinstellung.
- gnuplot-scroll
  Die plots werden mit dem Programm gnuplot erstellt. Das output terminal ist PNG. Der einfache Zugriff auf historische Daten ist möglich (analog SVG).
- gnuplot-scroll-svg
  Wie gnuplot-scroll, aber als output terminal wird SVG angenommen.

plotsize
gibt die Standardbildgröße aller erzeugten Plots an als Breite,Höhe an. Um einem individuellen Plot die Größe zu ändern muss dieses Attribut bei der entsprechenden SVG Instanz gesetzt werden. Default sind 800,160 für Desktop und 480,160 für Smallscreen

plotWeekStartDay
Starte das Plot in der Wochen-Ansicht mit diesem Tag. 0 ist Sonntag, 1 ist Montag, usw.

redirectCmds
Damit wird das URL Eingabefeld des Browser nach einem Befehl geleert. Standard ist eingeschaltet (1), ausschalten kann man es durch setzen des Attributs auf 0, z.Bsp. um den Syntax der Kommunikation mit FHEMWEB zu untersuchen.

refresh
Damit erzeugen Sie auf den ausgegebenen Webseiten einen automatischen Refresh, z.B. nach 5 Sekunden.

reverseLogs
Damit wird das Logfile umsortiert, die neuesten Einträge stehen oben. Der Vorteil ist, dass man nicht runterscrollen muss um den neuesten Eintrag zu sehen, der Nachteil dass FHEM damit deutlich mehr Hauptspeicher benötigt, etwa 6 mal so viel, wie das Logfile auf dem Datenträger groß ist. Das kann auf Systemen mit wenig Speicher (FRITZ!Box) zum Terminieren des FHEM Prozesses durch das Betriebssystem führen.

roomIcons
Leerzeichen getrennte Liste von room:icon Zuordnungen Der erste Teil wird als regexp interpretiert, daher muss ein Leerzeichen als Punkt geschrieben werden. Beispiel:
attr WEB roomIcons Anlagen.EDV:icoEverything

sortby
Der Wert dieses Attributs wird zum sortieren von Geräten in Räumen verwendet, sonst wäre es der Alias oder, wenn keiner da ist, der Gerätename selbst. Falls der Wert des sortby Attributes in {} eingeschlossen ist, dann wird er als ein perl Ausdruck evaluiert. $NAME wird auf dem Gerätenamen gesetzt.

showUsedFiles
Zeige nur die verwendeten Dateien in der "Edit files" Abschnitt. Achtung: aktuell ist das nur für den "Gplot files" Abschnitt implementiert.

sortRooms
Durch Leerzeichen getrennte Liste von Räumen, um deren Reihenfolge zu definieren. Da die Räume in diesem Attribut als Regexp interpretiert werden, sind Leerzeichen im Raumnamen als Punkt (.) zu hinterlegen. Beispiel:
attr WEB sortRooms DG OG EG Keller

smallscreenCommands
Falls auf 1 gesetzt werden Kommandos, Slider und Dropdown Menüs im Smallscreen Landscape Modus angezeigt.

sslVersion
Siehe das global Attribut sslVersion.

sslCertPrefix
Setzt das Präfix der SSL-Zertifikate, die Voreinstellung ist certs/server-, siehe auch das HTTP Attribut.

styleData
wird von dynamischen styles wie f18 werwendet

stylesheetPrefix
Präfix für die Dateien style.css, svg_style.css und svg_defs.svg. Wenn die Datei mit dem Präfix fehlt, wird die Default Datei (ohne Präfix) verwendet. Diese Dateien müssen im FHEM Ordner liegen und können direkt mit "Select style" im FHEMWEB Menüeintrag ausgewählt werden. Beispiel:
Anmerkung:Wenn der Parametername smallscreen oder touchpad enthält, wird FHEMWEB das Layout/den Zugriff für entsprechende Geräte (Smartphones oder Touchpads) optimieren
Standardmäßig werden 3 FHEMWEB Instanzen aktiviert: Port 8083 für Desktop Browser, Port 8084 für Smallscreen, und 8085 für Touchpad.
Wenn touchpad oder smallscreen benutzt werden, wird WebApp support aktiviert: Nachdem Sie eine Seite am iPhone oder iPad mit Safari angesehen haben, können Sie einen Link auf den Homescreen anlegen um die Seite im Fullscreen Modus zu sehen. Links werden in diesem Modus anders gerendert, um ein "Zurückfallen" in den "normalen" Browser zu verhindern.

SVGcache
Plots die sich nicht mehr ändern, werden im SVGCache Verzeichnis (www/SVGcache) gespeichert, um die erneute, rechenintensive Berechnung der Grafiken zu vermeiden. Default ist 0, d.h. aus.
Siehe den clearSvgCache Befehl um diese Daten zu löschen.

title
Setzt den Titel der Seite. Falls in {} eingeschlossen, dann wird es als Perl Ausdruck evaluiert.

viewport
Setzt das "viewport" Attribut im HTML Header. Das kann benutzt werden um z.B. die Breite fest vorzugeben oder Zoomen zu verhindern.
Beispiel: attr WEB viewport width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no

webCmd
Durch Doppelpunkte getrennte Auflistung von Befehlen, die für ein bestimmtes Gerät gelten sollen. Funktioniert nicht mit smallscreen, ein Ersatz dafür ist der devStateIcon Befehl.
Beispiel:
Der erste angegebene Befehl wird in der "set device ?" list nachgeschlagen (Siehe das setList Attrib für Dummy Geräte). Wenn dort bekannte Modifier sind, wird ein anderes Widget angezeigt. Siehe auch widgetOverride.
Wenn der Befehl state ist, wird der Wert als Kommando interpretiert.
Beispiele:
Anmerkung: dies ist ein Attribut für das anzuzeigende Gerät, nicht für die FHEMWEBInstanz.

webCmdLabel
Durch Doppelpunkte getrennte Auflistung von Texten, die vor dem jeweiligen webCmd angezeigt werden. Der Anzahl der Texte muss exakt den Anzahl der webCmds entsprechen. Um mehrzeilige Anzeige zu realisieren, kann ein Return nach dem Text und vor dem Doppelpunkt eingefuehrt werden.

webname
Der Pfad nach http://hostname:port/ . Standard ist fhem, so ist die Standard HTTP Adresse http://localhost:8083/fhem

widgetOverride
Leerzeichen separierte Liste von Name/Modifier Paaren, mit dem man den vom Modulautor für einen bestimmten Parameter (Set/Get/Attribut) vorgesehene Widgets ändern kann. Folgendes ist die Liste der bekannten Modifier:
- :sortable,val1,val2,... - damit ist es möglich aus den gegebenen Werten eine Liste der gewünschten Werte durch Drag & Drop zusammenzustellen. Die Reihenfolge der Werte kann dabei entsprechend geändert werden. Es müssen keine Werte explizit vorgegeben werden, das Widget kann auch ohne vorgegebenen Werte benutzt werden. Es können eigene Werte zur Liste hinzugefügt und einsortiert werden. Das Ergebnis ist Komma-separiert entsprechend aufsteigend sortiert.
- :sortable-strict,val1,val2,... - damit ist es möglich aus den gegebenen Werten eine Liste der gewünschten Werte durch Drag & Drop zusammenzustellen. Die Reihenfolge der Werte kann dabei entsprechend geändert werden. Es können jedoch keine eigenen Werte zur Liste hinzugefügt werden. Das Ergebnis ist Komma-separiert entsprechend aufsteigend sortiert.
- :sortable-given,val1,val2,... - damit ist es möglich aus den gegebenen Werten eine sortierte Liste der gewünschten Werte durch Drag & Drop zusammenzustellen. Es können keine Elemente gelöscht und hinzugefügt werden. Es müssen alle gegeben Werte benutzt und entsprechend sortiert sein. Das Ergebnis ist Komma-separiert entsprechend aufsteigend sortiert.
- iconRadio,[class<classname>@][use4icon@]<select color>,<value>,<icon>[@<color>][,<value>,<icon>[@<color>]]... - zeigt Icons als Radiobutton an und gibt Value bei Betätigung zurück.
  <value> ist der Rückgabe- u.Vergleichswert. Wenn eine numerische Folge von <value> angegeben wird, dann passt der laufende Wert zum nächsten höheren Vergleichswert. Vor und hinter der numerischen Folge dürfen nicht numerische Werte angegeben werden, dazwischen nicht. Die numerische Folge muss auf- oder absteigend sein.
  Beispiel: iconRadio,808080,zu,control_arrow_down,10,fts_shutter_10,20,fts_shutter_20,30,fts_shutter_30,auf,control_arrow_up
  <select color> die Hintergrundfarbe des gewählten Icons oder die Farbe des Icons wenn der Prefix use4icon@ vorangestellt wird.
  Das Widget enthält eine CSS-Klasse "iconRadio_widget".
- iconButtons,[class<classname>@][use4icon@]<select color>,<value>,<icon>[@<color>][,<value>,<icon>[@<color>]]... - zeigt Icons als Tastenleiste an und gibt durch Komma getrennte Werte der betätigten Tasten zurück.
  <value> ist der Rückgabewert.
  <select color> die Hintergrundfarbe des gewählten Icons oder die Farbe des Icons wenn der Prefix use4icon@ vorangestellt wird.
  Das Widget enthält eine CSS-Klasse "iconButton_widget".
- iconLabel[,[class<classname>@]<reference value>,[<icon>][@<color>]][,<reference value>,[<icon>][@<color>]]... - zeigt Zustände durch colorierte Werte, Beschriftungen und Icons an, wenn der aktuelle Wert zum Vergleichswert passt. Ein Zustand wird durch ein Parameterpaar beschrieben. Es können beliebig viele Paare angegeben werden. Ein Paar besteht aus einem Vergleichswert <reference value> und einem optionalen Anzeigewert mit optionaler mit Farbangabe [,<reference value>,[<icon>][@<color>]].
  <reference value> kann eine Zahl oder ein regulärer Ausdruck sein.
  Wenn <icon> keinem Iconnamen entspricht, wird der Text angezeigt, sonst das Icon. Wird <icon> nicht angegeben, wird der aktuelle Wert angezeigt.
- iconSwitch,[class<classname>@]<reference value>,[<icon>][@<color>][,<reference value>,[<icon>][@<color>]]... - schaltet zyklisch nach jeder Betätigung in den angezeigten Zustand, dabei wird der aktuelle Wert auf den Vergleichswert gesetzt. Ein Zustand wird durch ein Parameterpaar beschrieben. Es können beliebig viele Paare angegeben werden. Ein Paar besteht aus einem Vergleichswert <reference value> und einem optionalen Anzeigewert mit optionaler mit Farbangabe [,<reference value>,[<icon>][@<color>]].
  <reference value> kann eine Zahl oder eine Zeichenkette sein.
  Wenn <icon> keinem Iconnamen entspricht, wird der Text angezeigt, sonst das Icon. Wird <icon> nicht angegeben, wird der Vergleichwert angezeigt.
- noArg - es wird kein weiteres Eingabefeld angezeigt.
- time - zeigt ein Zeitauswahlmenü. Beispiel: attr FS20dev widgetOverride on-till:time
- textField - zeigt ein Eingabefeld.
  Beispiel: attr WEB widgetOverride room:textField
- textField-long - ist wie textField, aber beim Click im Eingabefeld wird ein Dialog mit einer HTML textarea (60x25) wird geöffnet.
- slider,<min>,<step>,<max>[,1] - zeigt einen Schieberegler. Das optionale 1 (isFloat) vermeidet eine Rundung der Fliesskommazahlen.
- multiple,<val1>,<val2>,... - zeigt eine Mehrfachauswahl mit einem zusätzlichen Eingabefeld. Das Ergebnis ist Komma separiert.
- multiple-strict,<val1>,<val2>,... - ist wie :multiple, bloß ohne Eingabefeld.
- selectnumbers,<min>,<step>,<max>,<number of digits after decimal point>,lin|log10" zeigt ein HTML-select mit einer Zahlenreihe vom Wert min bis Wert max mit Schritten von step angezeigt.
  Die Angabe lin erzeugt eine konstant ansteigende Reihe. Die Angabe log10 erzeugt eine exponentiell ansteigende Reihe zur Basis 10, step bezieht sich auf den Exponenten, z.B. 0.0625.
- select,<val1>,<val2>,... - zeigt ein HTML select mit allen Werten. Achtung: so ein Widget wird auch dann angezeigt, falls kein passender Modifier gefunden wurde.
- bitfield,<size>,<mask> - zeigt eine Tabelle von Kontrollkästchen (8 pro Zeile), um einzelne Bits setzen zu koennen. Die Voreinstellung fuer size ist 8 und fuer mask 2^32-1.
- uzsuToggle,zust1,zust2 - damit ist es möglich mit einem Toggle-Button zwischen zwei Zuständen zu wählen. Der Erste ist der aktive Zustand.
- uzsuSelect,val1,val2,... - damit ist es mögliche in einer Buttonleiste meherere Werte auszuwählen. Das Ergebnis ist Komma-separiert.
- uzsuSelectRadio,val1,val2,... - damit ist es mögliche in einer Buttonleiste einen aus meherere Werten auszuwählen.
- uzsuDropDown,val1,val2,... - damit ist es mögliche mit einem DropDown Menü einen der Werte auszuwählen.
- uzsuTimerEntry[,modifier2] - damit werden je ein uzsuSelect, uzsuDropDown und uzsuToggle Widget kombiniert um einen Schaltzeitpunkt auszuwählen. Über den optionalen modifier2 kann ein Widget zur Auswahl des Schaltwertes angegeben werden. Siehe Beispiele unten. Das Ergebniss is eine komma-separiert Liste von Wochentagen gefolgt vom Zeitpunkt, eine Aktiv-Indikator und dem Schaltwert, jeweils durch | abetrennt. Zum Beispiel: Mo,Di,Sa,So|00:00|enabled|19.5
- uzsu[,modifier2] - damit werden mehrere uzsuTimerEntry Widets kombiniert um eine beliebige Anzahl an Schaltzeiten einzugeben. Über den optionalen modifier2 kann ein Widget zur Auswahl des Schaltwertes angegeben werden. Siehe Beispiele unten. Das Ergebiss ist eine durch leerzeichen getrennte Liste von uzsuTimerEntry Ergebnissen.
  Beispiele:
- knob,min:1,max:100,... - zeigt das jQuery knob Widget.Die Parameter werden als eine Komma separierte Liste von Key:Value Paaren spezifiziert, wobei das data- Präfix entfällt.Für Details siehe die jQuery knob Dokumentation.
  Beispiel: attr dimmer widgetOverride dim:knob,min:1,max:100,step:1,linecap:round

FHT

[EN DE]

FHZ

Define

set

Set

Folgende Events werden (mehr oder weniger regelmäßig) von jedem FHT Device gemeldet:
Diese Strings können für notify oder FileLog Definitionen verwendet werden.
- Warnings können folgende Strings enthalten: none, Battery low,Temperature too low, Window open, Fault on window sensor
- actuator (ohne Suffix) steht für alle Aktoren.
- actuator or actuator1..8 kann folgende Werte verarbeiten:
  - <value>%
    Das ist der Normalfall. Der Aktor wird angewiesen auf diesen Wert zu öffnen.
  - offset <value>%
    Der Aktor läuft mit diesem Offset.
  - lime-protection
    Der Aktor wird angewiesen die lime-protection (Kalkschutz) Prozedur auszuführen.
  - synctime
    Wenn Sond/Sync beim FHT80B gewählt wird, wird ein Countdown gesetzt.
  - test
    Der Aktor wird vom FHT80b angewiesen zu piepsen (beep).
  - pair
    Das FHT80b sendet ein "you-belong-to-me" (Du-gehörst-zu-mir) an diesen Aktor.

Das FHT ist sehr sparsam (oder faul). Es akzeptiert eine Nachricht vom FHZ1x00 alle 115+x Sekunden, wobei x von der fhtaddress abhängt. Nicht überrascht sein wenn ein Befehl erst 10 Minuten später vom Gerät angenommen wird. Die FHT Befehle werden im FHZ1x00/CUL gepuffert bis sie zum FHT geschickt werden. Siehe den zugehörigen fhtbuf Eintrag im der get Abschnitt. Es können bis zu 8 Befehle in einer Nachricht an ein FHT geschickt werden wenn diese alle als Argumente im gleichen set Befehl zusammengefasst werden. Siehe nachfolgendes Beispiel.

time setzt Stunde und Minute auf lokale Zeit

date setzt Jahr, Monat und Tag auf lokale Zeit

refreshvalues ist ein Alias für report1 255 report2 255

Alle *-temp Werte brauchen eine Temperatur als Argument welche auf 0.5°C gerundet wird.
Temperatur Werte müssen zwischen 5.5°C und 30.5°C sein. Der Wert 5.5 setzt den Aktor auf OFF, der Wert 30.5 setzt den Aktor auf ON

mode kann auto, manual, holiday or holiday_short sein.
Wenn der mode holiday ist, schaltet dieser zurück auf entweder auto oder manual um 00:00 des Tages der wie folgt spezifiziert wird:
- holiday1 setzt Endtag des Urlaubs
- holiday2 setzt den Endmonat des Urlaubs
Für holiday_short (Party Modus)
- holiday1 setzt die absolute Stunde zu der von diesem Modus zurück geschalten wird (in 10-Minuten Schritten, max. 144)
- holiday2 setzt den Tag des Monats an dem von diesem Modus zurück geschalten wird (kann nur heute oder morgen sein, da holiday1 nur 24h akzeptiert.)
Die Temperatur für den Urlaubszeitraum wird durch den desired-temperature Parameter setzt.
Bitte beachten, dass der Holiday Mode nicht früher als auf Übermorgen eingestellt werden kann. Alternativ muss hier holiday_short genutzt werden.
Weiterhin bitte beachten das diese Kommandos nur in einem "Sammelkommando" erfolgen können. Beispiel:
set FHT1 mode holiday holiday1 24 holiday2 12 desired-temp 14

Die *-from1/*-from2/*-to1/*-to2 Wertetypen brauchen eine Zeitspezifikation als Argument im Format HH:MM. Diese definieren den Zeitraum in dem die day-temp gültig ist. Minuten (MM) werden auf 10er gerundet, 24:00 bedeutet OFF.

Um die FHZ Zeit zu synchronisieren und um "stumme" Geräte zu wecken, wird folgendes Kommando empfohlen:
define fht_sync at +*3:30 set TYPE=FHT time

report1 mit dem Parameter 255 fordert das Senden aller Einstellungen von Montag bis Sonntag an. Das Argument ist ein Bitfeld um einzelne Werte wie folgt anzufordern:
- 1: monday
- 2: tuesday
- 4: thursday
- 8: wednesday
- 16: friday
- 32: saturday
- 64: sunday
measured-temp und actuator werden mitgesendet wenn vom FHT als notwendig erachtet.

Hinweis: Dieser Befehl erzeugt sehr viel Funkverkehr was zu weiteren Problemen führen kann, besonders wenn Empfang nicht gut ist.

report2 mit dem Parameter 255 fordert die Ausgabe der nachfolgenden Einstellungen an:
day-temp night-temp windowopen-temp lowtemp-offset desired-temp measured-temp mode warnings.
Das Argument ist ein Bitfeld, um einzelne Werte abzufragen folgendes anhängen:
- 1: warnings
- 2: mode
- 4: day-temp, night-temp, windowopen-temp
- 8: desired-temp
- 64: lowtemp-offset
measured-temp und actuator werden mitgesendet wenn vom FHT als notwendig erachtet.
lowtemp-offset braucht eine Temperatur als Argument. Gültige Werte müssen zwischen 1.0 und 5.0°C liegen.
Wird eine Warnung erzeugen wenn die desired-temp - measured-temp > lowtemp-offset, jedoch frühestens 1,5Stunden nach der letzten Änderung der desired-temp.

FHEM hat optional einen internen Softwarepuffer für FHT Devices. Dieser Puffer soll vor Übertragungsfehlern schützen. Wenn nach einem bestimmten Zeitraum keine Bestätigung erhalten wurde wird FHEM den Befehl erneut senden. Die Befehle in der Warteschlagen können mit list <fht-device> angezeigt werden. Siehe die Attribute fhtsoftbuffer, retrycount und minfhtbuffer für weitere Details.

Befehle im Softwarepuffer werden in folgender Reihenfolge gesendet:
desired-temp,mode,report1,report2,holiday1,holiday2,day-temp,night-temp, [all other commands]

Get

N/A

Attribute

dummy
Hinweis: Es macht Sinn ein FHT Device auch für ein FHT8b zu definieren da sonst der Fehler "unknown FHT device, please define one" für jedes FHT8b generiert wird, denn das CUL meldet die 8b Nachrichten. Das dummy Attribut sollte bei diesen Devices gesetzt werden da sonst der interne FHT Buffer des CUL mit 8b-Daten gefüllt wird die niemals gebraucht werden. Wenn der Puffer dann voll ist werden "EOB" Nachrichten vom CUL erzeugt, und Senden zu den 8b ist nicht mehr möglich.

retrycount
Wenn das fhtsoftbuffer Attribut gesetzt ist, dann werden die Befehle entsprechend dem retrycount n-mal erneut versendet wenn nach 240 Sekunden keine Bestätigungsmeldung vom entsprechenden FHZ Device empfangen wurde.
Der Default-Wert ist 1.

minfhtbuffer
FHEM sendet keine Befehle mehr zum FHZ wenn der fhtbuffer-Wert diesen Wert unterschritten hat. Default-Wert ist 0. Wenn dieser Wert zu niedrig ist hat die Reihenfolge von fht-Befehlen weniger Einfluss da nur Befehle im Softbuffer priorisiert werden können. (Siehe Hinweise in der FHT Sektion set) Der Maximalwert sollte 7 unter dem Hardware Maximum sein, siehe fhtbuf.

lazy
Wenn das Attribut lazy (faul) gesetzt wurde sendet FHEM keine Befehle wenn die aktuell gelesenen Werte und der zu setzende Wert identisch sind. Das spart Funkzeit und hilft Konflikte mit der Regelung die besagt, dass maximal 1% der Zeit als Funkzeit verwendet werden darf, zu vermeiden. Nicht standardmäßig aktiviert.

tmpcorr
Korrigiert die Werte die vom FHZ gemeldet werden um den angegebenen Wert. Hinweis: nur die measured-temp Werte die von FHEM gemeldet (für Logging genutzt) werden angepasst.

ignore
do_not_notify
model (fht80b)
showtime
IODev
eventMap
readingFnAttributes

Erzeugte Events:

actuator
actuator1 actuator2 actuator3 actuator4
actuator5 actuator6 actuator7 actuator8
(wird gesendet wenn ein Offset zum entsprechenden Ventil konfiguriert wurde)
mon-from1 mon-to1 mon-from2 mon-to2
tue-from1 tue-to1 tue-from2 tue-to2
wed-from1 wed-to1 wed-from2 wed-to2
thu-from1 thu-to1 thu-from2 thu-to2
fri-from1 fri-to1 fri-from2 fri-to2
sat-from1 sat-to1 sat-from2 sat-to2
sun-from1 sun-to1 sun-from2 sun-to2
mode
holiday1 holiday2
desired-temp
measured-temp measured-low measured-high
warnings
manu-temp
year month day hour minute
day-temp night-temp lowtemp-offset windowopen-temp
ack can-xmit can-rcv ack2 start-xmit end-xmit (Nur wenn das CUL für die Übertragung von FHT Protokoll Daten konfiguriert ist)

FHT8V

[EN DE]

PID

Define

define <name> FHT8V <Hauscode> [IODev|FHTID]

<Hauscode>

Bei gegebenem Hauscode des CUL als AABB muss dieser Hauscode die Form CCBB haben, wobei CC größer oder gleich AA, aber kleiner AA+8 sein muss.

<IODev>

IODev

define wz FHT8V 3232

Set

set <name> valve <Wert>
Öffnet das Ventil auf den angegebenen Wert (in Prozent, von 0 bis 100).
set <name> pair
Verbindet das Ventil mit dem CUL.
set <name> decalc
Startet einen Entkalkungslauf des angegebenen Ventils.

Get

get <name> valve
Liest die Ventilöffnung aus dem FHT-Puffer des CUL und wandelt sie in Prozent (von 0 bis 100) um.

Attributes

IODev
dummy
ignore
eventMap

readingFnAttributes

FHZ

FLAMINGO

[EN DE]

Define

define <name> FLAMINGO <code> <model>

<code> ist der automatisch angelegte eindeutige code des FLAMINGO Rauchmelders. Dieser ändern sich nach dem Pairing mit einem Master.
<model> ist die Modelbezeichnung

unknown

define

Set

Counterreset
- Alarmzähler auf 0 setzen
Testalarm
- auslösen eines Testalarmes. (Der Testalarm erhöht nicht den Alarmzähler!)

Get

N/A

Attributes

IODev (!)
do_not_notify
eventMap
ignore

model
FA20RF, FA21RF, FA22RF, KD-101LA, LM-101LD, unknown

showtime
readingFnAttributes

Generierte Readings

Anleitung

Melder paaren (Master-Slave Prinzip)

Master bestimmen
LEARN-Taste bis grüne Anzeige LED leuchtet
Slave bestimmen
LEARN-Taste bis rote Anzeige LED leuchtet
Master, TEST-Taste gedrückt halten, bevor LEDś abschalten und alles "Slaves" ein Alarmsignal erzeugen

Paarung aufheben / Standalone Betrieb

LEARN-Taste bis grüne Anzeige LED leuchtet
TEST-Taste gedrückt halten bis ein Alarmsignal erzeugt wird

FLOORPLAN

[EN DE]

Englisch

Deutsch

Define

define <name> FLOORPLAN

Hinweis:


      define Grundriss FLOORPLAN

      fp_Grundriss.png

Set

Get

get <name> config

incl. allen Attributen an. Kann fuer ein include-file verwendet werden.

Attribute

userattr fp_<name> <top>,<left>[,<style>[,<description>]]

A userattr fp_<name> wird automatisch angelegt, sofern es noch nicht existiert.
- top = Bildschirmposition, pixel vom oberen Bildschirmrand
- left = Bildschirmposition, pixel vom linken Bildschirmrand
- style =
  - 0 nur icon/Status
  - 1 Gerätename und icon/Status
  - 2 Gerätename, icon/Status und Kommandos
  - 3 Geräte-reading und optionale Beschreibung
  - 4 S300TH-spezifisch, zeigt Temperatur und Luftfeuchtigkeit an
  - 5 icon/Status und Kommandos (ohne Gerätename)
  - 6 Geräte-reading, Zeitstempel und optionale Beschreibung
  - 7 nur Kommandos
  - 8 popup für kommandos
- Eine ggf. angegebene Bschreibung wird anstelle des original-Gerätenamens angezeigt.

`attr lamp1 fp_Erdgeschoss 100,100`	`#display lamp1 with icon only at screenposition 100,100`
`attr lamp2 fp_Erdgeschoss 100,140,1,Art-Deco`	`#display lamp2 with description 'Art-Deco-Light' at 100,140`
`attr lamp2 fp_ErsteEtage 130,100,1`	`#display the same device at different positions on other floorplans`
`attr myFHT fp_Erdgeschoss 300,20,10,Temperature`	`#display given Text + FHT-temperature`

Hinweis:

fp_arrange
Aktiviert den "arrange-Modus" der ein zusätzliches Menü anzeigt, mit dem Geräte auf dem Bildschirm angeordnet werden können. Bei aktiviertem arrange-mode können alle devices per drag&drop platziert werden.
Beispiel:
stylesheet
Ermöglicht die Verwendung eines eigenen css-stylesheet für Ihren floorplan. Dieses Attribut hat Vorrang vor dem Standard-stylesheet. Das Standard-stylesheet für floorplans ist floorplanstyle.css. Falls stylesheetPrefix in der korrespondierenden FHEMWEB-Instanz gesetzt ist, wird dieser stylesheetPrefix auch dem stylesheet für floorplans vorangestellt (prepend).
Alle stylesheets werden im stylesheet-Ordner des fhem-Dateisystems abgelegt. Legen Sie dort Ihr eigenes stylesheet neben floorplanstyle.css in demselben Ordner ab.
Beispiel:
fp_default
Der floorplan-Startbildschirm wird übersprungen wenn dieses Attribut einem der von Ihnen definierten floorplans zugeordnet ist.

attr Erdgeschoss fp_default 1

fp_noMenu
Blendet das floorplans-Menü aus, das normalerweise am linken Bildschirmrand angezeigt wird.

attr Erdgeschoss fp_noMenu 1

commandfield
Fügt Ihrem floorplan ein fhem-Kommandofeld hinzu.

attr Erdgeschoss commandfield 1

fp_backgroundimg
Gestattet die Bennung eine Hintergundbilds unabhängig vom floorplan-Namen.
Hinweis: Das Attribut kann mittels notify geändert werden, um z.B. unterschiedliche Hintergundbidlder am Tag oder in der Nacht anzuzeigen.
Beispiel:
fp_viewport
Gestattet die Verwendung eines abweichenden viewport-Wertes für die touchpad-Ausgabe.
Die Default-viewport-Angbe ist "width=768".

fp_roomIcons
Mit Leerstellen getrennte Liste von floorplan:icon -Paaren, um einem Eintrag des floorplan-Menues icons zuzuordnen, genau wie die entsprechende Funktionalitaet in FHEMWEB. Beispiel:
attr Grundriss fp_roomIcons Grundriss:control_building_empty Media:audio_eq
Vererbt von FHEMWEB
Die folgenden Attribute werden von der zugrundliegenden FHEMWEB-Instanz vererbt:

FRAMEBUFFER

FRITZBOX

[EN DE]

FHEM-Wiki

einmalig

Einige Modul-Funktionen sind dadurch nicht oder nur eingeschränkt verfügbar (siehe Anmerkungen zu benötigten API).

SYSMON

FB_CALLMONITOR

Das Modul nutzt das Perlmodule 'Net::Telnet', 'JSON::XS', 'LWP', 'SOAP::Lite' für den Fernzugriff.

Define

define <name> FRITZBOX [host]

host

define Fritzbox FRITZBOX

define MyEasterEgg weblink htmlCode { FRITZBOX_fritztris("Fritzbox") }

Set

set <name> alarm <Nummer> [on|off] [time] [once|daily|Mo|Tu|We|Th|Fr|Sa|So]
Schaltet den Weckruf Nummer 1, 2 oder 3 an oder aus (Standard ist on). Setzt die Zeit und den Wochentag.
Benötigt die API: Telnet oder webcm.

set <name> call <number> [Dauer] [say:Text|play:MP3URL]
Ruf für 'Dauer' Sekunden (Standard 60 s) die angegebene Telefonnummer von einem internen Telefonanschluss an (Standard ist 1 oder das Attribut 'ringWithIntern'). Wenn der Angerufene abnimmt, hört er die Wartemusik oder den angegebenen Text oder Klang. Der interne Telefonanschluss klingelt ebenfalls.
"say:" und "play:" benötigen die API: Telnet oder webcm.

set <name> checkAPIs
Startet eine erneute Abfrage der exitierenden Programmierschnittstellen der FRITZ!BOX.

set <name> customerRingTone <internalNumber> <MP3DateiInklusivePfad>
Lädt die MP3-Datei als Klingelton auf das angegebene Telefon. Die Datei muss im Dateisystem der Fritzbox liegen.
Das Hochladen dauert etwa eine Minute bis der Klingelton verfügbar ist. (API: Telnet)

set <name> dect <on|off>
Schaltet die DECT-Basis der Box an oder aus.
Benötigt die API: Telnet oder webcm.

set <name> diversity <number> <on|off>
Schaltet die Rufumleitung (Nummer 1, 2 ...) für einzelne Rufnummern an oder aus.
Die Rufumleitung muss zuvor auf der Fritz!Box eingerichtet werden. Benötigt die API: Telnet oder webcm.
Achtung! Es lassen sich nur Rufumleitungen für einzelne angerufene Telefonnummern (also nicht "alle") und ohne Abhängigkeit von der anrufenden Nummer schalten. Es muss also ein diversity-Geräwert geben.
Benötigt die API: Telnet, webcm oder TR064 (>=6.50).

set <name> guestWLAN <on|off>
Schaltet das Gäste-WLAN an oder aus. Das Gäste-Passwort muss gesetzt sein. Wenn notwendig wird auch das normale WLAN angeschaltet.

set <name> moh <default|sound|customer> [<MP3DateiInklusivePfad|say:Text>]
Beispiel: set fritzbox moh customer say:Die Wanne ist voll
set fritzbox moh customer /var/InternerSpeicher/warnung.mp3
ändert die Wartemusik ('music on hold') der Box. Mit dem Parameter 'customer' kann eine eigene MP3-Datei aufgespielt werden. Alternativ kann mit "say:" auch ein Text gesprochen werden. Die Wartemusik hat immer eine Länge von 8,13 s. Sie wird kontinuierlich während des Makelns von Gesprächen aber auch bei Nutzung der internen Wählhilfe bis zum Abheben des rufenden Telefons abgespielt. Dadurch können über FHEM dem Angerufenen 8s-Nachrichten vorgespielt werden.

set <name> password <Passwort>
Speichert das Passwort für den Fernzugriff über Telnet.

set <name> ring <intNummern> [Dauer [Klingelton]] [show:Text] [say:Text | play:Link]
Beispiel:

set fritzbox ring 611,612 5 Budapest show:Es regnet
set fritzbox ring 610 8 say:Es regnet
set fritzbox ring 610 10 play:http://raspberrypi/sound.mp3
Lässt die internen Nummern für "Dauer" Sekunden und (auf Fritz!Fons) mit dem angegebenen "Klingelton" klingeln.
Mehrere interne Nummern müssen durch ein Komma (ohne Leerzeichen) getrennt werden.
Standard-Dauer ist 5 Sekunden. Es kann aber zu Verzögerungen in der Fritz!Box kommen. Standard-Klingelton ist der interne Klingelton des Gerätes. Der Klingelton wird für Rundrufe (9 oder 50) ignoriert.
Wenn der Anruf angenommen wird, hört der Angerufene die Wartemusik (music on hold), welche ebenfalls zur Nachrichtenübermittlung genutzt werden kann.
Die Parameter Klingelton, show:, say: und play: benötigen die API Telnet oder webcm.

Wenn das Attribut 'ringWithIntern' existiert, wird der Text hinter 'show:' als Name des Anrufers angezeigt. Er darf maximal 30 Zeichen lang sein.

Auf Fritz!Fons wird der Text (max. 100 Zeichen) hinter dem Parameter 'say:' direkt angesagt und ersetzt den Klingelton.
Alternativ kann mit 'play:' auch ein MP3-Link (vom einem Webserver) abgespielt werden. Dabei wird die Internetradiostation 39 'FHEM' erzeugt und translate.google.com für Text2Speech genutzt. Es wird immer der komplette Text/Klang abgespielt. Bis zum Ende der 'Klingeldauer' klingelt das Telefon dann mit seinem Standard-Klingelton. Das Abspielen ist eventuell nicht auf mehreren Fritz!Fons gleichzeitig möglich.
Je nach Fritz!OS kann das beschriebene Verhalten abweichen.

set <name> sendMail [to:<Address>] [subject:<Subject>] [body:<Text>]
Sendet eine Email über den Emailbenachrichtigungsservice der als Push Service auf der Fritz!Box konfiguriert wurde. Mit "\n" kann einen Zeilenumbruch im Textkörper erzeut werden. Alle Parameter können ausgelassen werden. Bitte kontrolliert, dass die Email nicht im Junk-Verzeichnis landet.
Benötigt einen Telnet Zugang zur Box.

set <name> startRadio <internalNumber> [Name oder Nummer]
Startet das Internetradio auf dem angegebenen Fritz!Fon. Eine verfügbare Radiostation kann über den Namen oder die (Gerätewert)Nummer ausgewählt werden. Ansonsten wird die in der Box als Internetradio-Klingelton eingestellte Station abgespielt. (Also nicht die am Telefon ausgewählte.)

set <name> tam <number> <on|off>
Schaltet den Anrufbeantworter (Nummer 1, 2 ...) an oder aus. Der Anrufbeantworter muss zuvor auf der Fritz!Box eingerichtet werden.

set <name> update
Startet eine Aktualisierung der Gerätewerte.

set <name> wlan <on|off>
Schaltet WLAN an oder aus.

Get

get <name> ringTones
Zeigt die Liste der Klingeltöne, die benutzt werden können.

get <name> shellCommand <Befehl>
Führt den angegebenen Befehl auf der Fritz!Box-Shell aus und gibt das Ergebnis zurück. Kann benutzt werden, um Shell-Befehle auszuführen, die nicht im Modul implementiert sind.
Muss zuvor über das Attribute "allowShellCommand" freigeschaltet werden.

get <name> tr064Command <service> <control> <action> [[argName1 argValue1] ...]
Führt über TR-064 Aktionen aus (siehe Schnittstellenbeschreibung von AVM).
argValues mit Leerzeichen müssen in Anführungszeichen eingeschlossen werden.
Beispiel: get Fritzbox tr064Command X_AVM-DE_OnTel:1 x_contact GetDECTHandsetInfo NewDectID 1
Muss zuvor über das Attribute "allowTR064Command" freigeschaltet werden.

get <name> tr064ServiceListe
Zeigt die Liste der TR-064-Dienste und Aktionen, die auf dem Gerät erlaubt sind.

Attributes

allowShellCommand <0 | 1>
Freischalten des get-Befehls "shellCommand"

allowTR064Command <0 | 1>
Freischalten des get-Befehls "tr064Command" und "luaQuery"

boxUser <user name>
Benutzername für den TR064- oder einen anderen webbasierten Zugang. Normalerweise wird keine Benutzername für das Login benötigt. Wenn die Fritz!Box anders konfiguriert ist, kann der Nutzer über dieses Attribut definiert werden.

defaultCallerName <Text>
Standard-Text, der auf dem angerufenen internen Telefon als "Anrufer" gezeigt wird.
Dies erfolgt, indem während des Klingelns temporär der Name der internen anrufenden Nummer geändert wird.
Es sind maximal 30 Zeichen erlaubt. Das Attribute "ringWithIntern" muss ebenfalls spezifiziert sein.
Benötigt die API: Telnet oder webcmd

defaultUploadDir <fritzBoxPath>
Dies ist der Standard-Pfad der für Dateinamen benutzt wird, die nicht mit einem / (Schrägstrich) beginnen.
Es muss ein Pfad auf der Fritz!Box sein. D.h., er sollte mit /var/InternerSpeicher starten, wenn es in Windows unter \\ip-address\fritz.nas erreichbar ist.

forceTelnetConnection <0 | 1>
Erzwingt den Fernzugriff über Telnet (anstatt über die WebGUI oder TR-064).
Dieses Attribut muss bei älteren Geräten/Firmware aktiviert werden.

fritzBoxIP <IP-Adresse>
Veraltet.

INTERVAL <Sekunden>
Abfrage-Interval. Standard ist 300 (Sekunden). Der kleinste mögliche Wert ist 60.

ringWithIntern <1 | 2 | 3>
Um ein Telefon klingeln zu lassen, muss in der Fritzbox eine Anrufer (Wählhilfe, Wert 'box_stdDialPort') spezifiziert werden.
Um während des Klingelns eine Nachricht (Standard: "FHEM") anzuzeigen, kann hier die interne Nummer 1-3 angegeben werden. Der entsprechende analoge Telefonanschluss muss vorhanden sein.

telnetTimeOut <Sekunden>
Maximale Zeit, bis zu der während einer Telnet-Sitzung auf Antwort gewartet wird. Standard ist 10 s.

telnetUser <user name>
Benutzername für den Telnetzugang. Normalerweise wird keine Benutzername für das Login benötigt. Wenn die Fritz!Box anders konfiguriert ist, kann der Nutzer über dieses Attribut definiert werden.

useGuiHack <0 | 1>
Falls die APIs der Box nicht mehr die änderung des Klingeltones unterstützen (Fritz!OS >6.24), kann dieses Attribute entsprechend der WIKI-Anleitung genutzt werden.

readingFnAttributes

Readings

alarm1 - Name des Weckrufs 1
alarm1_state - Aktueller Status des Weckrufs 1
alarm1_target - Interne Nummer des Weckrufs 1
alarm1_time - Weckzeit des Weckrufs 1
alarm1_wdays - Wochentage des Weckrufs 1

box_dect - Aktueller Status des DECT-Basis
box_fwVersion - Firmware-Version der Box, wenn veraltet dann wird '(old)' angehangen
box_guestWlan - Aktueller Status des Gäste-WLAN
box_guestWlanCount - Anzahl der Geräte die über das Gäste-WLAN verbunden sind
box_guestWlanRemain - Verbleibende Zeit bis zum Ausschalten des Gäste-WLAN
box_ipExtern - Internet IP der Fritz!Box
box_model - Fritz!Box-Modell
box_moh - Wartemusik-Einstellung
box_powerRate - aktueller Stromverbrauch in Prozent der maximalen Leistung
box_rateDown - Download-Geschwindigkeit des letzten Intervals in kByte/s
box_rateUp - Upload-Geschwindigkeit des letzten Intervals in kByte/s
box_stdDialPort - Anschluss der geräteseitig von der Wählhilfe genutzt wird
box_tr064 - Anwendungsschnittstelle TR-064 (wird auch von diesem Modul benötigt)
box_tr069 - Provider-Fernwartung TR-069 (sicherheitsrelevant!)
box_wlanCount - Anzahl der Geräte die über WLAN verbunden sind
box_wlan_2.4GHz - Aktueller Status des 2.4-GHz-WLAN
box_wlan_5GHz - Aktueller Status des 5-GHz-WLAN

dect1 - Name des DECT Telefons 1
dect1_alarmRingTone - Klingelton beim Wecken über das DECT Telefon 1
dect1_custRingTone - Benutzerspezifischer Klingelton des DECT Telefons 1
dect1_fwVersion - Firmware-Version des DECT Telefons 1
dect1_intern - Interne Nummer des DECT Telefons 1
dect1_intRingTone - Interner Klingelton des DECT Telefons 1
dect1_manufacturer - Hersteller des DECT Telefons 1
dect1_model - Modell des DECT Telefons 1
dect1_radio - aktueller Internet-Radio-Klingelton des DECT Telefons 1

diversity1 - Eigene Rufnummer der Rufumleitung 1
diversity1_dest - Zielnummer der Rufumleitung 1
diversity1_state - Aktueller Status der Rufumleitung 1

fon1 - Name des analogen Telefonanschlusses 1 an der Fritz!Box
fon1_intern - Interne Nummer des analogen Telefonanschlusses 1
fon1_out - ausgehende Nummer des Anschlusses 1

gsm_internet - Internetverbindung errichtet über Mobilfunk-Stick
gsm_rssi - Indikator der empfangenen GSM-Signalstärke (0-100)
gsm_state - Status der Mobilfunk-Verbindung
gsm_technology - GSM-Technologie, die für die Datenübertragung genutzt wird (GPRS, EDGE, UMTS, HSPA)

mac_01_26_FD_12_01_DA - MAC Adresse und Name eines aktiven Netzwerk-Gerätes.
Bei einer WLAN-Verbindung wird "WLAN" und (von der Box gesehen) die Sende- und Empfangsgeschwindigkeit und die Empfangsstärke angehangen. Bei einer LAN-Verbindung wird der LAN-Port und die LAN-Geschwindigkeit angehangen. Gast-Verbindungen werden mit "gWLAN" oder "gLAN" gekennzeichnet.
Inaktive oder entfernte Geräte erhalten zuerst den Werte "inactive" und werden beim nächsten Update gelöscht.

radio01 - Name der Internetradiostation 01

tam1 - Name des Anrufbeantworters 1
tam1_newMsg - Anzahl neuer Nachrichten auf dem Anrufbeantworter 1
tam1_oldMsg - Anzahl alter Nachrichten auf dem Anrufbeantworter 1
tam1_state - Aktueller Status des Anrufbeantworters 1

user01 - Name von Nutzer/IP 1 für den eine Zugangsbeschränkung (Kindersicherung) eingerichtet ist
user01_thisMonthTime - Internetnutzung des Nutzers/IP 1 im aktuellen Monat (Kindersicherung)
user01_todaySeconds - heutige Internetnutzung des Nutzers/IP 1 in Sekunden (Kindersicherung)
user01_todayTime - heutige Internetnutzung des Nutzers/IP 1 (Kindersicherung)

FRM

FRM_AD

FRM_I2C

FRM_IN

[EN DE]

Englisch

FRM_LCD

FRM_OUT

FRM_PWM

FRM_RGB

FRM_ROTENC

FRM_SERVO

FRM_STEPPER

FReplacer

FS10

[EN DE]

Das FS10-Modul entschlüsselt und sendet Nachrichten vom Typ FS10, die vom SIGNALduino verarbeitet werden. Unterstützt werden z.Z. folgende Typen: simple, dimmer, timer, remote

Define

define <name> FS10 <hauscode>_<button>

<name> ist ein beliebiger Name, der dem Gerät zugewiesen wird. Zur besseren Übersicht wird empfohlen einen Namen in der Form " FS10_6_12" zu verwenden, wobei "6" der verwendete Hauscode und "12" die Adresse darstellt.

<hauscode> entspricht dem Hauscode der verwendeten Fernbedienung bzw. des Gerätes, das gesteuert werden soll. Als Hauscode wird 1-8 verwendet.

<button> stellt die Tastaturebene bzw. Adresse der verwendeten Geräte dar. Adresse "11" entspricht auf der Fernbedienung FS10-S8 z.B. den beiden Tasten der obersten Reihe.

Set

set <name> <value> [<anz>]

<value>

  dimdown
  dimup
  off
  on

Get

N/A Attribute

IODev
do_not_notify
eventMap
follow-on-for-timer (enable/disable follow-on-timer)
follow-on-timer (Anzahl Sekunden nachdem beim Timer des FS10_SA der state automatisch wieder auf off geht)
ignore
model

    FS10_ST  simple
    FS10_DI  dimmer
    FS10_HD  dimmer
    FS10_SA  timer
    FS10_MS  simple
    FS10_S4  remote
    FS10_S8  remote

readingFnAttributes

FS20

[EN DE]

FHZ

Define

define <name> FS20 <housecode> <button>
    [fg <fgaddr>] [lm <lmaddr>] [gm FF]

<housecode> ist eine 4 stellige Hex oder 8 stellige ELV4 Zahl, entsprechend der Hauscode Adresse.
<button> ist eine 2 stellige Hex oder 4 stellige ELV4 Zahl, entsprechend dem Button des Transmitters.
Optional definiert <fgaddr> die Funktionsgruppe mit einer 2 stelligen Hex oder 4 stelligen ELV4 Adresse. Bei Hex muss die erste Stelle F, bei ELV4 die ersten zwei Stellen 44 sein.
Optional definiert <lmaddr> definiert einen local master mit einer 2 stelligen Hex oder 4 stelligen ELV4 Adresse. Bei Hex muss die letzte Stelle F, bei ELV4 die letzten zwei Stellen 44 sein.
Optional definiert gm den global master. Die Adresse muss FF bei HEX und 4444 bei ELV4 Notation sein.

define lamp FS20 7777 00 fg F1 gm F

define roll1 FS20 7777 01

define otherlamp FS20 24242424 1111 fg 4412 gm 4444

define otherroll1 FS20 24242424 1114

Set

set <name> <value> [<time>]

value


      dim06% dim12% dim18% dim25% dim31% dim37% dim43% dim50%

      dim56% dim62% dim68% dim75% dim81% dim87% dim93% dim100%

      dimdown

      dimup

      dimupdown

      off

      off-for-timer

      on                # dimmer: Setze auf diesen Wert vor dem Ausschalten

      on-for-timer      # Siehe Hinweise

      on-old-for-timer  # Setze zum vorherigen (vor dem Einschalten)

      ramp-on-time      # Zeit bis zum erreichen des gewünschten Dim-Wertes

      ramp-off-time     # Zeit bis zum Ausschalten bei Dimmern

      reset

      sendstate

      timer

      toggle            # zwischen aus und dem letztern Dim-Wert

set lamp on

set lamp1,lamp2,lamp3 on

set lamp1-lamp3 on

set lamp on-for-timer 12

reset nur mit Vorsicht verwenden: Auch der Hauscode wird gelöscht.
Da das FS20 Protokoll 0.22Sek für eine Funksequenz benötigt wird nach jeder Ausführung eine Pause von 0.22Sek eingefügt.
Das FS20ST schaltet für dim*% und dimup ein. Es reagiert nicht auf sendstate.
Wenn ein Timer gesetzt ist (und dieser nicht 0 ist) werden on, dim*, und *-for-timer berücksichtigt (zumindest beim FS20ST).
Das time Argument geht von 0.25Sek bis 4Std und 16Min. Da time nur mit einem Byte dargestellt wird ergeben sich hieraus nur 112 eindeutige Zeit-Werte die mit ansteigender größe immer gröber aufgelöst werden. Das Programm zeigt die exakte Restzeit an wenn die gewählte Auflösung nicht eindeutig war. Die Auflösung ist is 0.25Sek von 0 bis 4 Sekunden, 0.5Sek von 4 bis 8Sek, 1Sek von 8 bis 16 Sek und so weiter. Wenn eine höhere Genauigkeit bei großen Werten gebraucht wird, dann hilft at mit einer Auflösung von 1Sek.

Get

N/A

Attribute

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.

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. Beispiele:

dummy
Setzt das Attribut dummy um Devices zu definieren, die keine Funksignale absetzen. Zugehörige notifys werden ausgeführt wenn das Signal empfangen wird. Wird beispielsweise genutzt um auf Code eines Sender zu reagieren, dennoch wird es auch dann kein Signal senden wenn es im Web Frontend getriggert wird.

follow-on-for-timer
Plant ein "setstate off;trigger off" für die angegebene Zeit als Argument zum on-for-timer Command. Oder das gleiche mit "on" wenn der Befehl "follow-off-for-timer" war.

follow-on-timer
Wie follow-on-for-timer plant es ein "setstate off;trigger off", aber diesmal als Argument in Sekunden zum Attribut. Wird verwendet um dem vorprogrammierten Timer zu folgen welcher vorher durch den timer-Befehl, oder manuell durch Drücken des Buttons gesetzt wurde. Im Handbuch finden sich noch mehr Informationen. Beachtet bei on und dim Befehlen.

model
Das "model" Attribut bezeichnet den Modelltyp des Gerätes. Dieses Attribut wird (derzeit) nicht direkt durch fhem.pl genutzt. Es kann beispielsweise von externen Programmen oder Webinterfaces genutzt werden um Geräteklassen zu unterscheiden und dazu passende Befehle zu senden (z.B. "on" oder "off" an ein fs20st, "dim..%" an ein fs20du etc.). Die Schreibweise des Modellnamens ist wie die in Anführungszeichen in der Anleitung gedruckte Bezeichnung die jedem Gerät beiliegt. Dieser Name wird ohne Leerzeichen ausschließlich in Kleinbuchstaben verwendet. Gültige Zeichen sind a-z 0-9 und -, andere Zeichen sind zu vermeiden. Hier ist eine Liste der "offiziellen" Devices:

Sender/Sensor: fs20fms fs20hgs fs20irl fs20kse fs20ls fs20pira fs20piri fs20piru fs20s16 fs20s20 fs20s4 fs20s4a fs20s4m fs20s4u fs20s4ub fs20s8 fs20s8m fs20sd fs20sn fs20sr fs20ss fs20str fs20tc1 fs20tc6 fs20tfk fs20tk fs20uts fs20ze fs20bf fs20si3

Dimmer: fs20di fs20di10 fs20du

Empfänger/Aktor: fs20as1 fs20as4 fs20ms2 fs20rgbsa fs20rst fs20rsu fs20sa fs20sig fs20sm4 fs20sm8 fs20st fs20su fs20sv fs20ue1 fs20usr fs20ws1

ignore
Ignoriere dieses Gerät, beispielsweise wenn es dem Nachbar gehört. Das Gerät wird keine FileLogs/notifys triggern, empfangene Befehle werden stillschweigend ignoriert (es wird kein Funksignal gesendet, wie auch beim dummy Attribut). Das Gerät wird weder in der Device-List angezeigt (es sei denn, es wird explizit abgefragt), noch wird es in Befehlen mit "Wildcard"-Namenspezifikation (siehe devspec) erscheinen. Es kann mit dem "ignored=1" devspec dennoch erreicht werden.

do_not_notify
showtime
readingFnAttributes
useSetExtensions
Falls es auf 0 gesetzt wird, werden die SetExtensions Befehle nicht angeboten. Die Voreinstellung ist 1.

Erzeugte Events:

on
off
toggle
dimdown
dimup
dimupdown
on-for-timer

FTUISRV

FULLY

FileLog

[EN DE]

Define

define <name> FileLog <filename> <regexp> [readonly]

<filename>



      YYYY-MM-DD_HH:MM:SS <device> <event>

<filename>

%d Tag des Monats (01..31)
%m Monat (01..12)
%Y Jahr (1970...)
%w Wochentag (0..6); beginnend mit Sonntag (0)
%j Tag des Jahres (001..366)
%U Wochennummer des Jahres, wobei Wochenbeginn = Sonntag (00..53)
%W Wochennummer des Jahres, wobei Wochenbeginn = Montag (00..53)

%L

%V

%G

%Y

define lamplog FileLog %L/lamp.log lamp

define wzlog FileLog ./log/wz-%Y-%U.log
              wz:(measured-temp|actuator).*

define wzlog FileLog ./log/wz-%G-%V.log
              wz:(measured-temp|actuator).*

Set

reopen
clear
addRegexpPart <device> <regexp>
removeRegexpPart <re>
absorb secondFileLog

Get

get <name> <infile> <outfile> <from>
          <to> <column_spec>

<infile>
Name des Logfiles, auf das zugegriffen werden soll. Sonderfälle: "-" steht für das aktuelle Logfile, und "CURRENT" öffnet die zum "from" passende Datei.
<outfile>
Bei einem "-", bekommt man die Daten auf der aktuellen Verbindung zurück, anderenfall ist es das Name (eigentlich Prefix, s.u.) des Output-Files. Wenn mehr als ein File angesprochen wird, werden die einzelnen Dateinamen durch ein "-" getrennt, anderenfalls werden die Daten in einzelne Dateien geschrieben, die - beginnend mit 0 - durchnummeriert werden.
<from> <to>
Bezeichnet den gewünschten Datenbereich. Die beiden Elemente müssen ganz oder mit dem Anfang des Zeitformates übereinstimmen.
<column_spec>
Jede column_spec sendet die gewünschten Daten entweder in eine gesonderte Datei oder über die gegenwärtige Verbindung durch "-" getrennt.
Syntax: <col>:<regexp>:<default>:<fn>
- <col> gibt die Spaltennummer zurück, beginnend mit 1 beim Datum. Wenn die Spaltenmummer in doppelten Anführungszeichen steht, handelt es sich um einen festen Text und nicht um eine Spaltennummer.
- <regexp> gibt, falls vorhanden, Zeilen mit Inhalten von regexp zurück. Groß- und Kleinschreibung beachten.
- <default>
  Wenn keine Werte gefunden werden, und der Default-Wert (Voreinstellung) wurde gesetzt, wird eine Zeile zurückgegeben, die den von-Wert (from) und diesen Default-Wert enthält. Dieses Leistungsmerkmal ist notwendig, da gnuplot abbricht, wenn ein Datensatz keine Daten enthält.
- <fn> Kann folgende Inhalte haben:
  - int
    Löst den Integer-Wert zu Beginn eines Strings heraus. Wird z.B. bei 10% gebraucht.
  - delta-h oder delta-d
    Gibt nur den Unterschied der Werte-Spalte pro Stunde oder pro Tag aus. Wird benötigt, wenn die Spalte einen Zähler enthält, wie im Falles des KS300 in der Spalte für die Regenmenge.
  - alles andere
    Dieser String wird als Perl-Ausdruck ausgewertet. @fld enthaelt die aktuelle Zeile getrennt durch Leerzeichen. Achtung: Dieser String/Perl-Ausdruck darf keine Leerzeichen enthalten.



        get outlog out-2008.log - 2008-01-01 2008-01-08 4:IR:int: 9:IR::

Attribute

addStateEvent

archivecmd / archivedir / nrarchive
Wenn eine neue FileLog-Datei geöffnet wird, wird der FileLog archiver aufgerufen. Das geschieht aber nur , wenn der Name der Datei sich geändert hat(abhängig von den zeitspezifischen Wildcards, die weiter oben unter FileLog (define) beschrieben werden) und gleichzeitig ein neuer Datensatz in diese Datei geschrieben werden muss.
Wenn das Attribut archivecmd benutzt wird, startet es als shell-Kommando ( eine Einbettung in " ist nicht notwendig), und jedes % in diesem Befehl wird durch den Namen des alten Logfiles ersetzt.
Wenn dieses Attribut nicht gesetzt wird, aber dafür nrarchive, werden nrarchive viele Logfiles im aktuellen Verzeichnis gelassen, und ältere Dateien in das Archivverzeichnis (archivedir) verschoben (oder gelöscht, falls kein archivedir gesetzt wurde).
Achtung: "ältere Dateien" sind die, die in der alphabetisch sortierten Liste oben sind.
Hinweis: Werden diese Attribute als global instance gesetzt, hat das auschließlich auf das FHEM logfile Auswirkungen.

archiveCompress
Falls nrarchive, archivedir und archiveCompress gesetzt ist, dann werden die Dateien im archivedir komprimiert abgelegt.

createGluedFile
Falls gesetzt (1), und im SVG-Plot ein Zeitbereich abgefragt wird, was in mehreren Logdateien gespeichert ist, dann wird für die Anfrage eine temporäre Datei mit dem Inhalt aller Dateien erzeugt.

disable
disabledForIntervals

eventOnThreshold
Falls es auf eine (nicht Null-) Zahl gesetzt ist, dann wird das linesInTheFile Event generiert, falls die Anzahl der Zeilen in der Datei ein Mehrfaches der gesetzen Zahl ist. Achtung: der Zähler ist nur für solche Dateien korrekt, die nach dem Impementieren dieses Features angelegt wurden. Ein Absturz/Abschuß von FHEM verfälscht die Zählung.

ignoreRegexp

logtype
Wird vom SVG Modul benötigt, um daten grafisch aufzubereiten. Der String wird aus komma-separierten Tokens (,) erzeugt, wobei jeder Token ein eigenes gnuplot-Programm bezeichnet. Die Token können Doppelpunkte (:) enthalten. Der Teil vor dem Doppelpunkt bezeichnet den Namen des Programms; der Teil nach dem Doppelpunkt ist der String, der im Web.Frontend dargestellt werden soll. Gegenwärtig sind folgende Typen von gnuplot-Programmen implementiert:
- fs20
  Zeichnet on als 1 and off als 0. Die geeignete filelog-Definition für das Gerät fs20dev lautet:
  define fslog FileLog log/fs20dev-%Y-%U.log fs20dev
- fht
  Zeichnet die Ist-Temperatur/Soll-temperatur/Aktor Kurven. Die passende FileLog-Definition (für das FHT-Gerät mit Namen fht1)sieht wie folgt aus:
  define fhtlog1 FileLog log/fht1-%Y-%U.log fht1:.*(temp|actuator).*
- temp4rain10
  Zeichnet eine Kurve aus der Temperatur und dem Niederschlag (pro Stunde und pro Tag) eines KS300. Die dazu passende FileLog-Definition (für das KS300 Gerät mit Namen ks300) sieht wie folgt aus:
  define ks300log FileLog log/fht1-%Y-%U.log ks300:.*H:.*
- hum6wind8
  Zeichnet eine Kurve aus der Feuchtigkeit und der Windgeschwindigkeit eines ks300. Die geeignete FileLog-Definition ist identisch mit der vorhergehenden Definition. Beide programme erzeugen das gleiche Log.
- text
  Zeigt das LogFile in seiner ursprünglichen Form (Nur Text).Eine gnuplot-Definition ist nicht notwendig.
Beispiel:
attr ks300log1 logtype temp4rain10:Temp/Rain,hum6wind8:Hum/Wind,text:Raw-data

mseclog

reformatFn
wird verwendet, um "fremde" Dateien für die SVG-Anzeige ins FileLog-Format zu konvertieren. Es enthält nur den Namen einer Funktion, der mit der ursprünglichen Zeile aufgerufen wird. Z.Bsp. um die NTP loopstats Datei zu visualisieren kann man den Wert von reformatFn auf ntpLoopstats setzen, und folgende Funktion in 99_myUtils.pm definieren:
```
      sub            
      ntpLoopstats($)
      {
        my ($d) = @_;
        return $d if($d !~ m/^(\d{5}) (\d+)\.(\d{3}) (.*)$/);
        my ($r, $t) = ($4, FmtDateTime(($1-40587)*86400+$2));
        $t =~ s/ /_/;
        return "$t ntpLoopStats $r";
      }
```

GAEBUS

GEOFANCY

[EN DE]

Eine deutsche Version der Dokumentation ist derzeit nicht vorhanden. Die englische Version ist hier zu finden:

GEOFANCY

GHoma

[EN DE]

Vorbereitung:

WLAN konfigurieren (bis Firmware 1.06):
Gerät in den AP modus bringen (Knopf für mehr als 3s drücken, diesen Schritt wiederholen bis die LED permanent leuchtet)
Nun einen Computer mit der SSID G-Home verbinden.
Im Browser zu 10.10.100.254 (username:passwort = admin:admin)
In STA Setting WLAN Einstellungen eintragen
WLAN konfigurieren:
Gerät in den AP modus bringen (Knopf für mehr als 3s drücken, diesen Schritt wiederholen bis die LED permanent leuchtet)
Mit der G-Homa App das WLAN des Zwischensteckers einstellen
Network Parameters settings (bis Firmware 1.06):
Other Setting -> Protocol auf TCP-Server
Other Setting -> Port ID (wird später für FHEM benötigt)
Other Setting -> Server Address (IP Adresse des FHEM Servers)
Network Parameters settings:
Über set ... ConfigAll des Server Gerätes die Parameter automatisch setzen.
Optional:
Im Router alle ausgehenden Verbindungen für G-Homa blockieren.

Define

define <name> GHoma <port>

define <name> GHoma <Id>

Id

Set

set <name> <value>

value


        off

        on