FHEMWiki - Benutzerbeiträge [de]

FileLogConvert

2024-04-12T11:56:48Z

50watt: /* Events unterdrücken */ Tippfehler

{{SEITENTITEL:FileLogConvert}}
{{Infobox Modul
|ModPurpose=einlesen von Filelogs in eine logdb
|ModType=h
|ModCmdRef=FileLogConvert
|ModForumArea=FHEM
|ModTechName=98_FileLogConvert.pm
|ModOwner={{Link2FU|8|DeeSPe}}
}}

Kann dazu verwendet werden, um FileLogs in eine DbLog-Datenbank einzulesen.

== Vorbereitung ==

Zuerst brauchen wir ein DbLog-Device:

[[DbLog|DbLog-Device erstellen]]

dazu könnte ein DbRep-Device helfen:

[[DbRep - Reporting und Management von DbLog-Datenbankinhalten| DbRep-Device erstellen]]

Wenn das soweit erledigt ist, muss das FileLogConvert-Modul aus contrib nach FHEM kopiert werden:

cp /opt/fhem/contrib/98_FileLogConvert.pm /opt/fhem/FHEM

Wenn die Datei nicht vorhanden ist, muss ein [[Cmdalias#svnupdate|update von contrib]] vorgenommen werden:

svn checkout https://svn.fhem.de/fhem/trunk/fhem/contrib/ contrib
Das neue Modul muss in fhem geladen sein:

reload 98_FileLogConvert.pm

dann kann ein FileLogConvert-Device angelegt werden

define flc FileLogConvert <DbLogDevice>

== Arbeiten mit dem FileLogConvert-Device ==

nun können mit
set flc import2DbLog <Filelog-Dateiname.log>

die logdateien importiert werden

== Tipps und Tricks ==

=== Events unterdrücken ===
wenn man bei Erstellung des DbLog-Devices ein
attr .* DbLogExclude .*
absetzt, werden keine Events geloggt.
Dadurch kann man hinterher die Zeilen der Datei
wc -l Dateiname
mit den importierten Zeilen
Reading lines-imported
mit den in der Datenbank vorhandenen Zeilen
sqlite3 db.db
select count(*) from history;
vergleichen. Der Count-Befehl gibt die totale anzahl an Zeilen an, so dass hier ggf. eine Verrechnung mit den vorher in der Datenbank vorhandenen Zeilen notwendig ist.
Das ganze funktioniert natürlich nur, wenn man in der Zwischenzeit keine neuen Logeinträge schreiben lässt (durch DbLog).
Abgesehen davon erhöht das ganze noch die Stabilität und Konsistenz der Datenbank

=== Log-Dateien splitten ===

Wenn man größere Logdateien hat, dauert der import unter umständen sehr lange.
Daher besteht die Möglichkeit, die Logdateien in kleinere Stücke zu unterteilen, damit man z.B. zwischendurch unterbrechen kann:
split -C 5m --numeric-suffixes input-file output-prefix
Blöderweise kann man nur Dateien importieren, die mit .log enden.
Deshalb muss man noch eine kleine verrenkung machen:

[[Kategorie:Logging]]

DOIF/Perl-Modus

2024-03-09T11:36:02Z

50watt: Tippfehler

[[Datei:Licht-Szenarien.png|600px|rechts|Licht-Automatisierung]]

Das DOIF-Modul arbeitet im DOIF-Perl-Modus, wie auch im DOIF-FHEM-Modus, ereignisgesteuert. Ein Steuerungsablauf wird in Perl in DOIF-Perl-Blöcken programmiert. Innerhalb eines DOIF-Devices können mehrere DOIF-Perl-Blöcke programmiert werden, die durch passende Event- oder Zeittrigger unabhängig von einander zur Ausführung gebracht werden.

Die Abläufe lassen sich, wie in höheren Programmiersprachen üblich, strukturiert programmieren. Es können innerhalb eines DOIF-Devices eigene Perlfunktionen definiert und genutzt werden. Es werden ebenfalls sog. Templates (deutsch: Schablonen) unterstützt. Mit Hilfe eines Templates kann ein bestimmter Automatisierungsablauf für mehrere Szenarien in einem DOIF-Device erstellt werden.

Zum Zeitpunkt der Definition werden alle DOIF-spezifischen Angaben in Perl übersetzt. Das garantiert zur Laufzeit eine maximal mögliche Performance.

Genauso wie der DOIF-FHEM-Modus, lässt sich der DOIF-Perl-Modus mit Hilfe des [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg uiTable-Attributes] um eine Web-Oberfläche ergänzen. Auf diese Weise kann sowohl die Steuerung als auch die Benutzeroberfläche innerhalb eines Devices erstellt werden. In der Abbildung rechts sieht man eine [https://wiki.fhem.de/wiki/DOIF/Automatisierung#Helligkeitsabh.C3.A4ngige_Zeitsteuerung_f.C3.BCr_mehrere_Szenarien_mit_tabellarischer_.C3.9Cbersicht helligkeitsabhängige Lichtsteuerung für mehrere Szenarien] erstellt im DOIF-Perl-Modus mit einer Benutzeroberfläche.

==Aufbau einer Definition im DOIF-Perl-Modus==

Der Aufbau der Definition im DOIF-Perl-Modus wird in drei Bereiche unterteilt: '''DOIF-Perl-Blöcke''', '''Template-Definitionen''' und '''Template-Aufrufe'''. Die letzten beiden Bereiche sind optional, die Reihenfolge der drei Bereiche ist frei wählbar.

<syntaxhighlight lang="perl">
define <name> DOIF
<DOIF-Perl-Blöcke>
<Template-Definitionen (optional)>
<Aufrufe zuvor definierter Templates (optional)>
</syntaxhighlight>

===Aufbau eines DOIF-Perl-Blocks===

<syntaxhighlight lang="perl">
<Blockname (optional)> {<Perlcode mit Ereignis-/Zeittriggern>}
</syntaxhighlight>

Ein DOIF-Perl-Block wird in Perl programmiert. Dabei muss man [https://wiki.fhem.de/wiki/DOIF/Perl-Modus#Ereignistrigger Ereignis-]/[https://wiki.fhem.de/wiki/DOIF/Perl-Modus#Zeittrigger Zeittrigger] in einer DOIF-spezifischen Syntax in eckigen Klammern im Programmcode einsetzen. Bei der Definition werden diese Angaben vom Modul ausgewertet, es werden intern entsprechende Trigger aufgesetzt, anschließend werden die Trigger-Angaben gegen interne Perlfunktionen ersetzt. So entsteht intern ein reiner Perl-Block, der zur Laufzeit ausgeführt wird, wenn ein Ereignis im System auftritt, welches zu den definierten Triggern des Blocks passt. Es können beliebig viele voneinander unabhängige Perl-Blöcke innerhalb eines DOIF-Devices definiert werden. Wird kein Name eines Perl-Blocks definiert, so wird der Block unter dem Namen '''block_<nr>''' intern geführt.

'''Beispiel'''

Definition eines DOIF-Perl-Blocks mit einem Ereignistrigger und einer Fallunterscheidung

<syntaxhighlight lang="perl">

defmod di_rc_tv DOIF \
{ ## Beginn eines Perlblocks ohne Namen\
if ([remotecontol:"on"]) ## Das Device "remotecontrol" triggert das Modul, wenn im Event "on" vorkommt\
{fhem_set"tv on"} ## wird der Befehl "set tv on" ausgeführt\
else ## sonst\
{fhem_set"tv off"} ## wenn im Event "on" nicht kommt, wird "set tv off" ausgeführt\
} ## Ende des Perlblocks
</syntaxhighlight>

'''Beispiel'''

Definition von zwei benannten DOIF-Perl-Blöcken mit Zeittriggern

<syntaxhighlight lang="perl">
defmod di_clock_radio DOIF \
radio_on { ## Beginn eines Perlblocks namens radio_on\
if ([06:30|Mo Di Mi] or [08:30|Do Fr Sa So]) ## zu definierten Zeitpunkten wird der Block getriggert\
{fhem_set"radio on"} ## der Befehl "set radio on" wird ausgeführt\
} ## Ende des Perlblocks namens radio_on\
\
radio_off { ## Beginn eines Perlblocks namens radio_off\
if ([08:00|Mo Di Mi] or [09:30|Do Fr Sa So]) ## zu definierten Zeitpunkten wird der Block getriggert\
{fhem_set"radio off"} ## der Befehl "set radio off" wird ausgeführt\
} ## Ende des Perlblocks namens radio_off
</syntaxhighlight>

===Aufbau einer Template-Definition===
{{Randnotiz|RNText='''nützliche Links'''
[https://wiki.fhem.de/wiki/DOIF/Templates DOIF-Templates]
}}
<syntaxhighlight lang="perl">
DEF TPL_<Template-Name>(<DOIF-Block-Definition mit Platzhaltern: $1,$2,...>)
</syntaxhighlight>

Die Definition eines Templates ist optional. Sie bietet sich dann an, wenn mehrere gleich aufgebaute Abläufe (hier Szenen) definiert werden sollen. Eine Template-Definition beginnt mit '''DEF''' gefolgt vom Namen des Templates welches mit '''TPL_''' beginnen muss. Anschließend wird eingefasst in runde Klammern ein Perl-Block programmiert. Variable Stellen innerhalb des Perl-Blocks werden mit Platzhaltern: $1, $2, usw. angegeben. Diese werden beim Aufruf des Templates gegen konkrete Angaben ersetzt. Insbesondere können so verschiedene Ereignis- oder Zeittrigger in den zuvor programmierten Ablauf eingesetzt werden.

'''Beispiel'''

<syntaxhighlight lang="perl">
DEF TPL_light ( ## Definition des Templates namens TPL_light zur Steuerung einer Lichtszene\
light_$1 { ## DOIF Block namens light_<Szene>\
## Platzhalter für: Szenennamen Daemmerungssensor Zeitspanne on-Befehl(e) off-Befehl(e)\
## Nr. des Platzhalters: $1 $2 $3 $4 $5\
if (($3) and [$2] eq "on") { ## Innerhalb Zeitspanne (hier $3) und wenn Dämmerung (hier $2) gleich on\
fhem_set($4);; ## schalte on-Befehle\
set_State("Szene: $1");; ## Setze Status des DOIF-Moduls auf den Szenennamen\
} else {\
fhem_set ($5);; ## sonst, schalte off-Befehle\
}\
} ## Ende des Perl-Blocks\
) ## Ende der Templatedefinition\
</syntaxhighlight>

===Aufruf eines Templates===

<syntaxhighlight lang="perl">
TPL_<Template-Name>(<Übergabeparameter für $1>,<Übergabeparameter für $2>,...>)
</syntaxhighlight>

Ein Template wird durch die Angabe des zuvor definierten Template-Namens aufgerufen. Hinter dem Template-Namen werden in runden Klammern kommagetrennten Angaben für die Platzhalter $1, $2, usw. gemacht. Durch den Aufruf wird intern ein Perl-Block generiert, bei dem alle Platzhalter im definierten Perl-Block des Templates gegen konkrete Angaben getauscht wurden.

'''Beispiele'''

Das oben definierte Beispiel-Template wird für zwei verschiedene Szenarien benutzt. Hierbei entstehen mit dem im Template definierten Ablauf zwei Perl-Blöcke, die unabhängig von einander arbeiten.

<syntaxhighlight lang="perl">
TPL_light (Erdgeschoss,Daemmerung2,[06:25-08:00|8] or [15:00-23:00],"Lampekueche,LampeFlur on","Lampekueche,LampeFlur off")\
TPL_light (Kind2,Daemmerung2,[06:25-08:00|8] or [15:00-23:10],"schrank2 on","schrank2 off")
</syntaxhighlight>

===Ereignistrigger===
In einem DOIF-Perl-Block sollte mindestens eine Ereignis- oder Zeittriggerangabe vorkommen. Diese Angabe ist erforderlich, damit der Perl-Block beim passenden Event oder der angegeben Zeit ausgeführt wird. Sie wird grundsätzlich in eckigen Klammern angegeben und bei der Definition intern gegen eine Perlfunktion ersetzt, die einen Rückgabewert bei ihrer Ausführung liefert.

====Eventtrigger mit Inhalt====
'''Inhalt des Internals STATE'''
<syntaxhighlight lang="perl">
[<device>] reagiert auf alle Events vom angegebenen Device, Rückgabewert: STATE des Devices (nicht das Reading state des Devices)
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
define di_lamp DOIF {if ([lamp] eq "on) {fhem("push lamp on")}}
</syntaxhighlight>
'''Inhalt eines Readings'''
<syntaxhighlight lang="perl">
[<device>:<reading>] reagiert auf alle Events vom angegebenen Device mit dem angegebenen Reading, Rückgabewert: Inhalt des Readings des Devices
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
define di_lamp DOIF {if ([lamp:state] eq "on) {fhem("push lamp on")}}
</syntaxhighlight>

====Eventtrigger mit Rückgabewert wahr/falsch====
'''Eventtrigger für ein bestimmtes Device'''
<syntaxhighlight lang="perl">
[<device>:"<Regex-Events>"] reagiert auf alle Events vom angegebenen Device, Rückgabewert: wahr (true) zum Zeitpunkt des Events, wenn der Regex-Ausdruck passt, sonst falsch (false)
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
define di_button DOIF {if ([button:"^btn1:"]) {fhem_set("lamp on")}} # die if-Bedingung ist wahr und führt zur Ausführung, wenn vom Device button, das Event beginnend mit btn1: vorkommt
</syntaxhighlight>
'''Eventtrigger für mehrere Devices'''
<syntaxhighlight lang="perl">
["<Regex-Devices>:<Regex-Events>"] reagiert auf Events mit Devices mit Events, die den jeweiligen Regex-Angaben entsprechen, Rückgabewert: wahr (true) zum Zeitpunkt des Events, sonst falsch (false)
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
define di_window DOIF {if (["^window:on$"]) {fhem("push window $device on")}} # die Bedingung ist wahr und führt zur Ausführung, wenn ein Devices beginnend mit window ein Event endend mit on liefert
</syntaxhighlight>

===Zeittrigger===
====Zeittrigger zu einer bestimmten Uhrzeit====
<syntaxhighlight lang="perl">
[<time>] der Zeitpunkt-Trigger mit <time>: HH:MM, HH:MM:SS triggert seinen Perl-Block zum angegebenen Zeitpunkt, Rückgabewert: wahr (true) zum Triggerzeitpunkt, sonst falsch (false)
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
define di_pump DOIF {if ([10:00] or [11:00:30]) {fhem_set("pump on-for-timer 300")}} # um 10:00 Uhr und um 11:00:30 wird der entsprechende Perl-Block ausgeführt, die if-Bedingung ist zu diesen beiden Zeitpunkten wahr und führt zur Ausführung der Anweisung

</syntaxhighlight>

====Zeitintervalle====
<syntaxhighlight lang="perl">
[<begin>-<end>] <begin>, <end> als HH:MM, HH:MM:SS, triggert seinen Perl-Block zu <begin>-Zeit und zu <end>-Zeit, das Intervall ist ab <begin>-Zeitpunkt wahr und ab <end>-Zeitpunkt falsch
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
define di_lamp_on_off DOIF {if ([10:00-22:00]) {fhem_set("lamp on")} else {fhem_set("lamp off")}} # um 10:00 Uhr und um 22:00 Uhr wird der entsprechende Perl-Block getriggert, die if-Bedingung ist ab 10:00 Uhr wahr, lamp wird eingeschaltet, um 22:00 uhr ist die if-Bedingung nicht mehr wahr, lamp wird ausgeschaltet
</syntaxhighlight>

====indirekte Zeitangaben====
'''Zeittrigger, deren Zeitangabe in einem Reading gespeichert wird'''
<syntaxhighlight lang="perl">[[<device>:<reading>]] im angegebenen Reading muss eine gültige Zeitangabe als HH:MM, HH:MM:SS stehen, um diese Zeit wird der entsprechende Perl-Block ausgeführt, die Bedingung ist dann wahr, sonst falsch
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
{if ([[mydevice:time]]) {fhem_set("lamp on")}} # zum Zeitpunkt, der sich im Reading time des Devices mydevice wird der Perl-Block getriggert, die if-Bedingung ist wahr und lamp wird eingeschaltet

{if ([[mydevice:from]-[mydevice:to]]) {fhem_set("lamp on")} else {fhem_set("lamp off")}} # im Zeitintervall from-to brennt lamp, sonst ist sie aus
</syntaxhighlight>

====relative Zeitangaben====
'''Zyklischer Trigger im zeitlichen Abstand'''
<syntaxhighlight lang="perl">
[+<time>] <time> als HH:MM, HH:MM:SS oder Zahl in Sekunden
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
{[+00:30];fhem("save")} # sichern der Konfiguration alle 30 Minuten
</syntaxhighlight>

====ausgerichtete Zeittrigger====
'''X-Minuten nach einer vollen Stunde'''
<syntaxhighlight lang="perl">
[:MM] mit MM sind Minutenangaben zwischen 00 und 59
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
{[:15];[:45];fhem_set("pump on-for-timer 300")} # Pumpe 15 und 45 Minuten nach einer vollen Stunde für 5 Minuten einschalten
</syntaxhighlight>
'''Alle X-Minuten ab einer vollen Stunde'''
<syntaxhighlight lang="perl">
[+:MM] mit MM in Minuten als Teiler von 60, sinnvolle Angaben sind: 02, 03, 04, 05, 06, 10, 12, 15, 20, 30
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
{[+:15];fhem_set("pump on-for-timer 300")} # Pumpe um HH:00, HH:15, HH:30, HH:45 für fünf Minuten einschalten
</syntaxhighlight>
'''X-Minuten nach einer vollen Stunde, alle X-Stunden'''
<syntaxhighlight lang="perl">
[+[h]:MM] mit MM in Minuten zwischen 1 und 59, h in Stunden als Teiler von 24, sinnvolle Angaben für h sind: 2, 3, 4, 6, 8, 12
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
{[+[4]:05]; fhem_set("pump on-for-timer 300")} # Pumpe um 00:05, 04:05, 08:05, 12:05, 16:05, 20:05 Uhr für fünf Minuten einschalten
</syntaxhighlight>

====Wochentagsteuerung====
'''Zeittrigger an bestimmen Wochen-/Ferientagen'''
<syntaxhighlight lang="perl">
[<time-trigger>|0123456789] Bedeutung: 0 bis 6 für So. bis Sa., 7 Wochenende oder Feiertag, 8 Werktags, 9 Wochenende oder Feiertag am kommenden Tag
alternativ
[<time-trigger>|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
[<time-trigger>|Su Mo Tu We Th Fr Sa WE WD TWE] WE entspricht der Ziffer 7, WD der Ziffer 8 und TWE der Ziffer 9
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
defmod di_lamp DOIF\
{[22:00|Sa];;fhem_set("lamp on")}\
{[08:00|Mo];;fhem_set("lamp off")}
</syntaxhighlight>

====Intervall-Timer====
'''Zyklischer Zeittrigger innerhalb einer Zeitspanne'''
<syntaxhighlight lang="perl">
[<begin>-<end>,<relativ timer>] triggert zu den aus <relativ timer> berechneten Zeitpunkten im angegebenen Zeitintervall <begin>-<end>
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
defmod di_pump DOIF {[08:00-22:00,+:30];;fhem_set("pump on-for-timer 300")} # von 08:00 Uhr bis 22:00 Uhr wird Pumpe alle 30 Minuten eingeschaltet, erste Schaltpunkt ist um 08:00 Uhr, der letzte um 21:30 Uhr
</syntaxhighlight>

===Trigger unterbinden===

Soll eine Ereignis-/Zeitangabe nicht triggern, so lässt sich die Triggerung durch ein vorangestelltes Fragezeichen unterbinden.

<syntaxhighlight lang="perl">
[?<Triggerangabe>] <Triggerangabe> kann eine Ereignis- oder Zeitangabe sein
</syntaxhighlight>

<syntaxhighlight lang="perl">
defmod di_lamp DOIF \
{ # hier triggert nur [darkness:state], dagegen wird das Zeitintervall nur abgefragt, \
if ([darkness:state] eq "on" and [?15:00-22:00]) { # es gibt keinen Trigger um 15:00 Uhr bzw. um 22:00 Uhr \
fhem_set("lamp on") \
} else { \
fhem_set("lamp off") \
} \
}
</syntaxhighlight>

===Aggregationsfunktionen===
{{Randnotiz|RNText=Aggregationsfunktion
<syntaxhighlight lang="perl">
[<function>:<format>:"<regex device>:<regex event>":<reading>:<condition>,<default>]

<function>: #, @, #sum, #max, #min, #average, #median, @max, @min
# Anzahl der betroffenen Devices, @ kommagetrennte Liste Devices
#sum Summe, #max höchster Wert, #min niedrigster Wert, #average Durchschnitt, #median Medianwert
@max Device des höchsten Wertes, @min Device des niedrigsten Wertes

<format>: d<number>, a, s(<splittoken>)
d<number> zum Runden des Wertes mit Nachkommastellen, a für Aliasnamen bei Devicelisten, s(<splittoken>) <splittoken> sind Trennzeichen in der Device-Liste

"<regex Device>:<regex Event>" spezifiziert sowohl die betroffenen Devices, als auch den Ereignistrigger, die Syntax entspricht der DOIF-Syntax für Ereignistrigger.

<reading> konkretes Reading, welches überprüft werden soll
alternativ eine Regex in Anführungszeichen
"<regex reading>" Regex für Readings, die überprüft werden sollen

<condition> Aggregationsbedingung
wird <condition> in Anführungszeichen gesetzt, so werden Reading mit eq mit dem angegebenen Wert verglichen. Sonst kann ein Perlausdruck angegeben werden. Folgende Variablen sind vorbelegt und können im Perlausdruck benutzt werden:

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

<default> Default-Wert, falls kein Device gefunden wird, entspricht der Syntax des Default-Wertes bei Readingangaben

<format>, <reading>, <condition>, <default> sind optional

</syntaxhighlight>
}}
Mit Hilfe einer Aggregationsfunktion können mehrere Readings im System ausgewertet werden, die einem bestimmten Kriterium entsprechen. Die Filterkriterien können mit Hilfe von Regex-Ausdrücken für Devices, Events und Readings angegeben werden. Die Aggregationsangabe wirkt triggernd, soll sie nicht triggern, so muss ein Fragezeichen vorangestellt werden, siehe [https://wiki.fhem.de/wiki/DOIF/Perl-Modus#Trigger_unterbinden Trigger unterbinden]

<syntaxhighlight lang="perl">
[<function>:<format>:"<regex device>:<regex event>":<reading>:<condition>,<default>]
</syntaxhighlight>

'''Beispiele'''

Offene Fenster anzeigen. Wenn ein Device beginnend mit "window" im Namen ein Event sendet, dann wird bei allen Devices im System, deren Name mit "window" beginnt, status auf "open" geprüft. Diese werden im Status von di_windows angezeigt. Wird kein Device mit status "open" gefunden, so wird der Default-Wert "keine" übernommen.

<syntaxhighlight lang="perl">
defmod di_windows DOIF init {set_State([@:"^window":state:"open","keine"])}
</syntaxhighlight>

Durchschnittstemperatur aller Temperatursensoren in der Gruppe "livingroom" gerundet auf 2 Nachkommastellen. Wenn ein Event von irgendeinem Device beginnend mit "temperature" auftritt, dann werden alle Devices im System durchsucht, die ein Reading namens "temperature" besitzen und sich in der Gruppe "livingroom" befinden.

<syntaxhighlight lang="perl">
defmod di_average_temp DOIF init {set_State ([#average:d2:":^temperature":temperature:$group eq "livingroom"])}
</syntaxhighlight>

Um 18:00 Uhr werden alle Devices im System durchsucht, deren Reading "battery" nicht "ok" ist. Damit die Aggregationsangabe den DOIF-Perl-Block nicht triggert, muss am Anfang der Angabe ein Fragezeichen vorangestellt werden.

<syntaxhighlight lang="perl">
defmod di_batterie_not_ok DOIF init {[18:00];;set_State([?@:":battery":battery:$_ ne "ok","alle OK"])}
</syntaxhighlight>

Um 18:00 Uhr werden alle Devices im System durchsucht, die ein Reading namens "Battery" oder "battery" haben. Bei diesen Readings wird die letzte Aktualisierung geprüft. Wenn sie älter als 24 Stunden ist, dann wird dessen Device in die Liste aufgenommen. Im Status des Moduls befinden sich danach alle Devices, deren Batterie-Reading länger nicht aktualisiert wurde.

<syntaxhighlight lang="perl">
defmod di_batteriecheck DOIF init {[18:00];;set_State([?@:"":"^[Bb]attery$":ReadingsAge($name,$reading,0) > 3600*24,"keine"])}
</syntaxhighlight>

Das Modul wird getriggert wenn ein beliebiges Device ein Event beginnend mit "temperature" sendet, es werden daraufhin alle Devices nach dem Reading "temperature" durchsucht und der maximale/minimale Wert im Reading max/min von di_min_max gespeichert.

<syntaxhighlight lang="perl">
defmod di_min_max DOIF\
{set_Reading("max",[#max:":^temperature":temperature])}\
{set_Reading("min",[#min:":^temperature":temperature])}
</syntaxhighlight>

==Für Umsteiger vom DOIF-FHEM-Modus==
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 always-Attribut der Form:

<syntaxhighlight lang="perl">
DOIF (<Bedingung mit Trigger>) (<FHEM-Befehle>) DOELSE (<FHEM-Befehle>)
</syntaxhighlight>

lassen sich wie folgt in Perl-Modus übertragen:

<syntaxhighlight lang="perl">
DOIF {if (<Bedingung mit Trigger>) {fhem("<FHEM-Befehle>")} else {fhem("<FHEM-Befehle>")}}
</syntaxhighlight>

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. Elegant lässt sich das Problem der wiederholenden Ausführung bei zyklisch sendenden Sensoren mit Hilfe des Attributes '''DOIF_Readings''' lösen.

'''Beispiel'''

Heizung soll bei einer Temperatur unter 21 Grad eingeschaltet werden, sonst soll sie ausgeschaltet werden. Das Unterschreiten bzw. Überschreiten der Wunschtemperatur wird über die Definition des Readings '''cold''' realisiert. Obwohl der Temperatursensor zyklisch seine Daten sendet, triggert das Reading '''cold''' das eigene Modul und führt zum Schalten der Heizung nur wenn sich sein Zustand (on/off) ändert.

<syntaxhighlight lang="perl">
defmod di_Threshold DOIF { \
if ([$SELF:cold] eq "on") { # wenn es kalt ist\
fhem_set("heating on");; # Heizung einschalten\
set_State ("heating");; # Status auf 'heating' setzen\
} else { # sonst\
fhem_set("heating off");; # Heizung ausschalten\
set_State ("not heating");;# Status auf 'not heating' setzen\
} \
}
attr di_Threshold DOIF_Readings cold: ([room:temperature] < 21 ? "on" : "off")
</syntaxhighlight>

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

<syntaxhighlight lang="perl">
DOIF
{ if (<Bedingung mit Triggern>) ... } ## erster Block
{ if (<Bedingung mit Triggern>) ... } ## zweiter Block
...
</syntaxhighlight>

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

'''Beispiel'''

<syntaxhighlight lang="perl">
defmod di_einschalten DOIF\
{["Daemmerung:on"];;fhem_set("lamp on")}\
{[08:00];;fhem_set("radio on")}
</syntaxhighlight>

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

'''Beispiele'''

<syntaxhighlight lang="perl">
defmod di_log DOIF {Log 1,"state of lamp: ".[lamp:state]}

defmod di_set_lamp DOIF {fhem_set("lamp ".[remote:state])}
</syntaxhighlight>

Innerhalb eines Perlblocks sind beliebige Hierarchietiefen möglich, dabei kann der Trigger irgendwo innerhalb des Blocks vorkommen:

<syntaxhighlight lang="perl">
DOIF
{ if (<Bedingung>) {
if (<Bedingung>) {
if (<Bedingung mit Triggern>...
...
}
}
}
}
</syntaxhighlight>

'''Bemerkung'''

Innerhalb eines DOIF-Perl-Blocks muss mindestens ein Trigger definiert werden. Zu beachten ist, dass beim passenden Trigger nicht nur ein Zweig, sondern der gesamte Block ausgeführt wird.

==Eigene Funktionen==

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

'''Beispiel'''

<syntaxhighlight lang="perl">
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
</syntaxhighlight>

'''Eigene Funktionen mit Parametern'''

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

'''Beispiel'''

<syntaxhighlight lang="perl">
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
</syntaxhighlight>

==Eigener Namensraum: DOIF==

Der Namensraum im DOIF-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 vorangestelltem Doppelpunkt angegeben werden: '''::<perlfunction>'''. Variablen aus dem Namensraum '''main''' werden wie folgt angegeben: '''$::<Variablenname>'''-

Eigene Perlfunktionen, die in myutils ausgelagert sind, befinden sich ebenfalls im Namensraum main. Wenn sie ausschließlich 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, OldReadingsAge, ReadingsVal, ReadingsNum, ReadingsTimestamp, ReadingsAge, Value, OldValue, OldTimestamp, AttrVal, AttrNum
'''

==Spezifische Perl-Funktionen im Perl-Modus==
Die folgenden Perl-Funktionen befinden sich im Package DOIF, sie können in der DOIF-Definition unmittelbar genutzt werden.
===FHEM-set-Befehl ausführen: '''fhem_set()'''===
<syntaxhighlight lang="perl">
fhem_set(<content>); mit <content> Angaben des FHEM-set-Befehls
</syntaxhighlight>

'''Beispiel'''

Lampe namens '''lamp''' ausschalten:

<syntaxhighlight lang="perl">
fhem_set("lamp off");
</syntaxhighlight>

entspricht:

<syntaxhighlight lang="perl">
fhem("set lamp off");
</syntaxhighlight>

Der Aufruf der fhem_set-Funktion ist performanter, da das Parsen nach dem set-Befehl mit Hilfe der Funktion '''fhem''' entfällt.

===Ein FHEM-Event auslösen: '''set_Event()'''===
<syntaxhighlight lang="perl">
set_Event(<Event>); mit <Event> das zu generierende FHEM-Event
</syntaxhighlight>
'''Beispiel'''

Generiere das Event '''on''':

<syntaxhighlight lang="perl">
set_Event("on");
</syntaxhighlight>

===Eigenen Status setzen: '''set_State()'''===
<syntaxhighlight lang="perl">
set_State(<value>,<trigger>); mit <trigger>: 0 ohne Trigger, 1 mit Trigger, <trigger> ist optional, default ist 1
</syntaxhighlight>

'''Beispiel'''

Status des eignen DOIF-Device auf '''on''' setzen:

<syntaxhighlight lang="perl">
set_State("on");
</syntaxhighlight>

===Status des eigenen DOIF-Devices auslesen: '''get_State()'''===
Die Funktion besitzt keine Parameter.

'''Beispiel'''

Schalte Lampe namens '''lamp''' mit dem Status des eigenen DOIF-Devices:

<syntaxhighlight lang="perl">
fhem_set("lamp ".get_State());
</syntaxhighlight>

===Reading des eigenen DOIF-Devices setzen: '''set_Reading()'''===
<syntaxhighlight lang="perl">
set_Reading(<readingName>,<value>,<Event>); mit <Event>: 0 ohne Eventgenerierung, 1 mit Eventgenerierung, <Event> ist optional, default ist 0
</syntaxhighlight>
'''Beispiel'''
<syntaxhighlight lang="perl">
set_Reading("weather","cold");
</syntaxhighlight>

===Reading des eigenen DOIF-Devices auslesen: '''get_Reading()'''===

'''Beispiel'''

Schalte Lampe mit dem Inhalt des Readings namens '''dim''':
<syntaxhighlight lang="perl">
fhem_set("lamp ".get_Reading("dim"));
</syntaxhighlight>

===Setzen mehrerer Readings des eigenen DOIF-Devices in einem Eventblock===
<syntaxhighlight lang="perl">
set_Reading_Begin();
set_Reading_Update(<readingName>,<value>,<change>); <change> ist optional
set_Reading_End(<Event>); mit <Event>: 0 ohne Eventgenerierung, 1 mit Eventgenerierung
</syntaxhighlight>

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:
<syntaxhighlight lang="perl">
set_Reading_Begin;
set_Reading_Update("temperature",$temp);
set_Reading_Update("humidity",$hum);
set_Reading_End(1);
</syntaxhighlight>

==Interne Timer==

Mit Hilfe von Timern können Perl-Anweisungen verzögert ein- oder mehrmalig ausgeführt werden. Im Gegensatz zum wait-Timer im DOIF-FHEM-Modus, können beliebig viele Timer gleichzeitig genutzt werden. Ein Timer 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()'''===
<syntaxhighlight lang="perl">
set_Exec(<timerName>, <seconds>, <perlCode>, <paramRef>, <condition>);

<timerName>: beliebige Angabe, sie spezifiziert eindeutig einen Timer

<seconds>: Verzögerungszeit, sie wird per eval-Perlbefehl ausgewertet und kann daher Perlcode zur Bestimmung der Verzögerungszeit beinhalten

<perlCode>: Perl-Anweisung, die nach Ablauf der Verzögerungszeit per eval-Perlbefehl ausgeführt wird

<paramRef>: wird unter <perlCode> eine Perlfunktion angegeben, so kann optional hier eine Referenz auf den Übergabeparameter der Perlfunktion angegeben werden

<condition>: optionale Bedingung zur Wiederholung der Perl-Ausführung. Sie wird per eval-Perlbefehl vor dem Setzen des Timers und vor der Ausführung der Perl-Anweisung auf wahr geprüft. Bei falsch wird die Wiederholung der Ausführungskette beendet. Wird <condition> nicht angegeben, so erfolgt keine Wiederholung der Perl-Anweisung.
</syntaxhighlight>

Wird '''set_Exec''' mit dem gleichen Timer-Namen '''<timerName>''' vor seinem Ablauf erneut aufgerufen, so wird der laufender Timer gelöscht und neugesetzt.

===Anwendungsbeispiele für einmalige verzögerte Ausführung===

'''Beispiel'''

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

<syntaxhighlight lang="perl">
set_Exec("lamp_timer",30,'lamp("on")');
</syntaxhighlight>

'''Beispiel'''

Lampe verzögert um 30 Sekunden ausschalten:

<syntaxhighlight lang="perl">
set_Exec("off_timer",30,'fhem_set("lamp off")');
</syntaxhighlight>

'''Beispiel'''

Das Event '''off''' 30 Sekunden verzögert generieren:

<syntaxhighlight lang="perl">
set_Exec("Event_timer",30,'set_Event("off")');
</syntaxhighlight>

'''Beispiel'''

Funktion namens '''check_shutters''' wird mit einer Referenz auf ein zuvor definiertes Array namens '''shutters''' um 5 Sekunden verzögert ausgeführt:

<syntaxhighlight lang="perl">
set_Exec("check_timer",5,"check_shutters",\@shutters);
</syntaxhighlight>

===Anwendungsbeispiele mit bedingter Wiederholung einer Ausführung===

'''Beispiel'''

Wenn Alarm ausgelöst wird, soll eine Benachrichtigung gesendet werden und alle 60 Sekunden wiederholt werden, solange Alarmanlage auf '''on''' steht:

<syntaxhighlight lang="perl">
defmod di_alarm DOIF {["alarm:on"];;fhem("send myphone alarm!");;set_Exec("timer",60,'fhem("send myphone alarm!")','ReadingsVal("alarm","state","on") eq "on"')}
</syntaxhighlight>

'''Beispiel'''

Wenn Taster auslöst, Lampe auf '''on''' schalten und noch zwei mal im Abstand von einer Sekunde wiederholt auf '''on''' schalten.

<syntaxhighlight lang="perl">
defmod di_lamp_on DOIF {["button:on"];;fhem_set"lamp on";;set_Exec("timer",1,'fhem_set("lamp on")','$count < 2')}
</syntaxhighlight>

alternativ:

<syntaxhighlight lang="perl">
defmod di_lamp_on DOIF {["button:on"];;set_Exec("timer",'$count == 0 ? 0 : 1','fhem_set("lamp on")','$count < 2')}
</syntaxhighlight>
'''$count''' ist eine interne Variable, die beginnend bei 0 nach jedem Durchlauf um eins erhöht wird.

'''Beispiel'''

Wenn Fenster geöffnet wird, dann soll eine Benachrichtigung erfolgen, dabei soll die Benachrichtigung bis zu 10 mal jeweils um weitere 60 Sekunden verzögert werden: erste Benachrichtigung nach 5 Minuten, zweite Benachrichtigung nach weiteren 6 Minuten, dritte Benachrichtigung nach weiteren 7 Minuten usw.

<syntaxhighlight lang="perl">
defmod di_window DOIF {if ([window:state] eq "open") {\
set_Exec("timer",'300+$count*60','fhem("echo speak window open")','$count < 9')\
} else {\
del_Exec("timer")\
}\
}
</syntaxhighlight>

'''Beispiel'''

Pumpe alle zwei Stunden im Abstand von fünf Minuten 3 mal einschalten, beim ersten mal für 60 Sekunden, beim zweiten mal für 80 Sekunden und beim dritten mal für 100 Sekunden.

<syntaxhighlight lang="perl">
defmod di_pump DOIF {[08:00-20:00,+[2]:00];;set_Exec("timer",300,'fhem_set("pump on-for-timer ".60+$count*20)','$count < 3')}
</syntaxhighlight>

'''Beispiel'''

Hochdimmen beim Tastendruck im Sekundentakt.

<syntaxhighlight lang="perl">
defmod di_dimm DOIF {["button:on"];;@{$_pct}=(10,35,65,80,90,100);;set_Exec("timer",1,'fhem_set"lamp pct ".$_pct[$count]','$count < 6')}
</syntaxhighlight>

'''$_pct''' ist hier ein Array mit Helligkeitswerten, auf das innerhalb des Devices zu jedem Zeitpunkt zugegriffen werden kann.

===Restzeit des Timers bestimmen: '''get_Exec()'''===
<syntaxhighlight lang="perl">
get_Exec(<timerName>); Returnwert: 0, wenn Timer abgelaufen oder nicht gesetzt ist, sonst Anzahl der Sekunden bis zum Ablauf des Timers
</syntaxhighlight>

===Laufenden Timer löschen: '''del_Exec()'''===
<syntaxhighlight lang="perl">
del_Exec(<timerName>); <timeName> Name des Timers
</syntaxhighlight>

==init-Block==

Wird ein DOIF-Perl-Block mit dem Namen '''init''' benannt, so wird dieser Block beim Systemstart von FHEM ausgeführt.

'''Beispiel'''

Lampe um 22:00 Uhr oder wenn das FHEM-System hochgefahren wird ausschalten:

<syntaxhighlight lang="perl">
defmod di_lamp_off DOIF init {[22:00];;fhem_set("lamp off")}
</syntaxhighlight>

==Device-Variablen==

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 mit '''my''' deklariert werden. Intern handelt es sich um hash-Variablen des jeweiligen DOIF-Devices.

'''Beispiel'''

<syntaxhighlight lang="perl">
defmod di_var DOIF\
init {$_myvalue=10} ## nach dem Starten des FHEM-System Variable namens $_myvalue mit dem Wert 10 initialisieren\
{[+:30];;fhem_set("mydevice $_myvalue");;$_myvalue++} ## alle 30 Minuten set mydevice mit dem Wert von $_myvalue ausführen und diesen anschließend um eins erhöhen
</syntaxhighlight>

Wenn eine Instanzvariable nicht initialisiert wird, gilt sie als nicht definiert. Das lässt sich mit dem Perlbefehl '''define''' abfragen.

'''Beispiel'''

<syntaxhighlight lang="perl">
if (!defined $_value) ($_value=30);
</syntaxhighlight>

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

'''Beispiel'''

Initialisierung einer Instanzvariablen namens '''$_status''' beim Systemstart mit dem Status des Moduls:

<syntaxhighlight lang="perl">
init {$_status=get_State()}
</syntaxhighlight>

Instanzvariablen lassen sich wie Perl-Hashes indizieren:

'''Beispiel'''

<syntaxhighlight lang="perl">
my $i=0;
$_betrag{$i}=100;
</syntaxhighlight>

oder mit konkreten Angaben hier '''heute''':

<syntaxhighlight lang="perl">
$_betrag{heute}=100;
</syntaxhighlight>

==Blockierende Funktionsaufrufe (blocking calls)==

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.

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

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==
Folgende Auswahl an Attributen ist im DOIF-Perl-Modus nutzbar:

'''addStateEvent checkReadingEvent DOIF_Readings disable event_Readings notexist readingList setList uiTable uiState weekdays readingFnAttributes'''

Die Funktionsweise der Attribute kann im DOIF-FHEM-Modus nachgeschlagen werden.

==set-Befehle im Perl-Modus==
===set <name> disable===

blockiert die Befehlsausführung

===set <name> enable===

aktiviert die Befehlsausführung

===set <name> <Blockname>===

führt den entsprechenden DOIF-Perl-Block unmittelbar aus
==FOR-Schleife==
Mit Hilfe der FOR-Schleife kann ein Template in einer Schleife mehrfach aufgerufen werden. Damit können mit einer Parameterliste gleiche Abläufe für verschiedene Szenarien erstellt werden.
<syntaxhighlight lang="perl">
FOR (<Array>,<Template>($_$1,$_$2,...)) mit $_$1 erstes Element des Arrays, $_$2 zweites Element des Arrays usw. der jeweiligen Zeile
</syntaxhighlight>

'''Beispiel'''

Lichtsteuerung für mehrere Szenarien

<syntaxhighlight lang="perl">
defmod di_light DOIF subs {\
## In einem Array namens $_sc wird pro Szenario eine Definitionszeile mit Parametern erstellt \
## Zeitspanne Einschaltbefehl Ausschaltbefehl\
push (@{$_sc},["[06:25-08:00|8] or [18:00-23:30]", "Lampekueche,Lampeflur on", "Lampekueche,Lampeflur off"]);;\
push (@{$_sc},["[06:25-08:00|8] or [18:00-22:10]", "schrank2 on", "schrank2 off"]);;\
## Das Array kann um weitere Szenarien mit Hilfe des push-Befehls erweitert werden \
} \
## Template zur Steuerung des Lichtes für ein Szenario\
DEF TPL_light ( \
{ ## Perl-Block \
if ($1) { ## In der Zeitspanne \
fhem_set("$2") ## Licht einschalten \
} else { \
fhem_set("$3") ## Licht ausschalten \
} \
} ## Ende des Perl-Blocks \
) ## Ende von TPL_light \
\
## Mit Hilfe der FOR-Schleife wird das Array $_sc durchlaufen, für jede Szene (Zeile des Arrays) wird das oben definierte Template mit den Parametern der Szene: Zeitspanne $_$1, Einschaltbefehl $_$2 und Ausschaltbefehl $_$2 aufgerufen \
\
FOR (@{$_sc},TPL_light($_$1,$_$2,$_$3)) \
\
## Die FOR-Schleife ruft auf: \
## TPL_light("[06:25-08:00|8] or [18:00-23:30]", "Lampekueche,Lampeflur on", "Lampekueche,Lampeflur off") \
## TPL_light("[06:25-08:00|8] or [18:00-22:10]", "schrank2 on", "schrank2 off")
</syntaxhighlight>

Bei dieser Vorgehensweise können weitere Szenarien durch Hinzufügen einer Array-Zeile erstellt werden, ohne den restlichen Code anpassen zu müssen. Desweitern können die Elemente des Arrays für Visualisierungszwecke über das [https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg uiTable-Attribut] genutzt werden, siehe: [https://wiki.fhem.de/wiki/DOIF/Automatisierung#Helligkeitsabh.C3.A4ngige_Zeitsteuerung_f.C3.BCr_mehrere_Szenarien_mit_tabellarischer_.C3.9Cbersicht Helligkeitsabhängige Lichtsteuerung mit Web-Oberfläche]

==Einfache Anwendungsbeispiele==

===Treppenhauslicht mit Bewegungsmelder===
<syntaxhighlight lang="perl">
defmod 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\
}\
}
</syntaxhighlight>

===Einknopf-Fernbedienung===

'''Beispiel'''

Wenn eine Taste innerhalb von zwei Sekunden zwei mal betätig wird, soll der Rollladen nach oben, bei einem Tastendruck nach unten:
<syntaxhighlight lang="perl">
defmod 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\
}\
}
</syntaxhighlight>

'''Aktion auslösen, wenn innerhalb einer bestimmten Zeitspanne ein Ereignis x mal auftritt'''

'''Beispiel'''

<syntaxhighlight lang="perl">
defmod di_count DOIF {\
if (["FS:on"] and !get_Exec("counter")) { # wenn Ereignis (hier "FS:on") eintritt und kein Timer läuft\
$_my_count=1;; # setze count-Variable auf 1\
set_Exec("counter",3600,'Log (3,"count: $_my_count action") if ($_my_count > 10)');; # setze Timer auf eine Stunde zum Protokollieren der Anzahl der Ereignisse, wenn sie über 10 ist\
} else {\
$_my_count++;; # wenn Timer bereits läuft zähle Ereignis\
}\
}
</syntaxhighlight>

==Weitere Anwendungsbeispiele im DOIF-Perl-Modus==
===[https://wiki.fhem.de/wiki/DOIF/Automatisierung#Helligkeitsabh.C3.A4ngige_Zeitsteuerung_f.C3.BCr_mehrere_Szenarien Lichtsteuerung für mehrere Szenarien]===
===[https://wiki.fhem.de/wiki/DOIF/Automatisierung#Zeitgesteuerte_Heizungsregelung_mit_Hilfe_von_Raumthermostaten Steuerung von Raumthermostaten für mehrere Räume]===
===[https://wiki.fhem.de/wiki/DOIF/Automatisierung#Beschattungssteuerung_abh.C3.A4ngig_von_der_Zimmertemperatur_und_Sonneneinstrahlung_f.C3.BCr_mehrere_Szenarien Beschattungssteuerung für mehrere Szenarien]===
===[https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Anzahl_der_Tage_bis_zur_Abfall-Entsorgung Abfallentsorgung]===
===[https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Visualisierung_und_Steuerung:_Heiztherme Heiztherme]===
===[https://wiki.fhem.de/wiki/DOIF/uiTable_Schnelleinstieg#Visualisierung:_Anwesenheitsstatus Anwesenheitsstatus]===
[[Kategorie:HOWTOS]]

EnOcean-FSR61VA-10A-Stromstoß-Schaltrelais mit Strommessung

2023-07-13T06:55:19Z

50watt: /* Links */ Link zum Datenblatt war tot - aktualisiert

{{Infobox Hardware
|Bild=FSR61VA-10A.JPG
|Bildbeschreibung=Eltako FSR61VA-10A
|HWProtocol=EnOcean
|HWType=Empfänger, Aktor, Sender, Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=1 Schaltkanal, 2 EnOcean IDs (bidirektional)
|HWVoltage=230V~
|HWPowerConsumption=Standby: 0,8W
|HWPoweredBy=230V~
|HWSize= 45mm lang, 55mm breit, 33mm tief
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Eltako
}}

'''EnOcean-FSR61VA-10A-Stromstoß-Schaltrelais mit Strommessung''' (FSR61VA) sind in einem Gehäuse für Einbaumontage
zwei FHEM-Device:
# Ein Schalt-Kanal mit 10A maximalem Schaltstrom (2000W Glühlampen)
# Sensor für Scheinleistung

== Features ==
=== Relais ===
(ER)
solange es ein Steuersignal gibt, bleibt der Kontakt geschlossen, ohne Steuersignal ist der Kontakt geöffnet
=== Einschaltwischrelais ===
(EW)
Der Kontakt schließt mit dem Steuersignal und öffnet nach der eingestellten Wischzeit - auch wenn das Steuersignal noch an ist. Die Wischzeit (0 - 120 Sekunden) ist für alle Kanäle gleich und wird am oberen Drehschalter eingestellt
=== Stromstoßschalter ===
(ES)
Mit jedem Steuerimpuls schaltet der Kanal ein -> aus bzw. aus -> ein ..."toggle".
=== Stromstoßschalter mit Rückfallverzögerung ===
(ESV)
Mit jedem Steuerimpuls schaltet der Kanal ein -> aus bzw. aus -> ein ..."toggle". Am oberen Drehschalter kann für alle Kanäle die gleiche Rückfallverzögerungszeit (0-120 Minuten) eingestellt werden.
Tasterdauerlicht: Wird der Taster länger als eine Sekunde gedrückt, bleibt der Schalter für 2 Stunden geschlossen und schaltet danach ab.
Ausschaltvorwarnung: Ist diese aktiviert, wird 30 Sekunden vor dem endgültigen Ausschalten, 3 Mal kurz ausgeschaltet

=== Scheinleistungmessung ===
Messbereich: 10VA bis 2300VA
=== Einlernbare Sensoren ===
* Funktaster (siehe auch FHEM Attribut [http://fhem.de/commandref.html#switchType switchType])
** Richtungstaster (eine Taste für EIN, eine Taste für AUS)
** Universaltaster (eine Taste für EIN und AUS -> toggle)
** Zentraltaster (eine Taste für EIN, eine Taste für AUS, Zentraltaster haben Priorität vor anderen Tastern -> ist der Zentraltaster EIN, kann mit Richtungstastern und Universaltastern nicht AUS geschaltet werden)
* Funkbewegungshelligkeitssensoren
* Funkhelligkeitssensoren
* Funkfenster-Tür-Kontakte

== Hinweise zum Betrieb mit FHEM ==
=== Minimalkonfiguration ===
==== Aktor ====
<pre>
define EnO_switch_FSR61VA EnOcean FFAABBC0 --> EnO_switch_FSR61VA ist ein frei gewählter eindeutiger Name
für das FHEM-Device.
FFAABBC0 ist die erste am Boden des FSR61VA aufgedruckte SenderID.
Damit sendet das FSR61VA den Schaltzustand (B0/BI --> ein/aus)
attr EnO_switch_FSR61VA IODev TCM310_0 --> TCM310_0 ist der Name des Devices, mit dem FHEM EnOcean-Funk
sendet und empfängt.
attr EnO_switch_FSR61VA subDef getNextID --> "getNextID" ersetzt FHEM automatisch durch eine freie SenderID des TCMs. Damit sendet FHEM an den FSR61VA
attr EnO_switch_FSR61VA subType switch --> es handelt sich um einen EnOcean Schalter (der kann A0, AI, B0, BI,...)
attr EnO_switch_FSR61VA switchMode pushbutton --> als "pushbutton" sendet FHEM bei einem
"set EnO_switch_FSR61VA B0" nach dem Kommando (B0) noch ein "release".
Das braucht's, wenn der FSR61VA als ES oder ESV betrieben wird.
Sonst wird jedes "set"-Kommando vom FSR61VA als
"länger als eine Sekunde gedrückt" interpretiert -> "Tasterdauerlicht".
Beim Betrieb als "ER" wird das Attribut "switchMode" nicht angegeben ("ER"
passt gut, wenn der FSR61VA exklusiv via FHEM bedient wird.)
</pre>

==== Scheinleistungssensor ====
<pre>
define EnO_sensor_FSR61VA EnOcean FFAABBC1 --> EnO_sensor_FSR61VA ist ein frei gewählter eindeutiger Name
für das FHEM-Device.
FFAABBC1 ist die zweite am Boden des FSR61VA aufgedruckte SenderID.
Damit sendet das FSR61VA die gemessene Scheinleistung in Watt.
attr EnO_sensor_FSR61VA IODev TCM310_0
attr EnO_sensor_FSR61VA subType autoMeterReading.01 --> es handelt sich um einen EnOcean Automated meter reading (AMR),
Electricity (EEP A5-12-01)
</pre>
Definition des Logs für den Sensor:
<pre>
define FileLog_EnO_sensor_FSR61VA FileLog ./log/EnO_sensor_FSR61VA-%Y.log EnO_sensor_FSR61VA:power:.*
attr FileLog_EnO_sensor_FSR61VA logtype text
</pre>
* FileLog_EnO_sensor_FSR61VA ist der FHEM-Name des Logs
* ./log/EnO_sensor_FSR61VA-%Y.log beschreibt, dass
** im Verzeichnis "log" die Logdateien angelegt werden
** es wird jedes Jahr ("-%Y") eine neue Datei erstellt
** die Logdatei hat im Jahr 2014 den Namen: EnO_sensor_FSR61VA-2014.log
* EnO_sensor_FSR61VA:power:.* gibt an, dass nur Zeilen mit "EnO_sensor_FSR61VA power:" ins Log aufgenommen werden

Auszug aus dem Log des Sensors:
<pre>
2014-07-25_23:27:30 EnO_sensor_FSR61VA power: 21
2014-07-25_23:28:44 EnO_sensor_FSR61VA power: 0
2014-07-25_23:33:07 EnO_sensor_FSR61VA power: 21
2014-07-25_23:33:23 EnO_sensor_FSR61VA power: 0
2014-07-25_23:43:28 EnO_sensor_FSR61VA power: 0
2014-07-25_23:53:32 EnO_sensor_FSR61VA power: 0
</pre>

=== FHEM Device in FSR61VA einlernen ===
Damit der FSR61VA auf FHEM reagieren kann (Ein/Ausschalten), wird das FHEM-Device EnO_switch_FSR61VA in den FSR61VA als Richtungstaster (bzw. Taster ein/aus) eingelernt:
# Unterer Drehschalter je nach Produktionswoche des FSR61VA (aufgedruckt):
## bis KW 2/13: "ca. Mitte" (Taster Ein/Aus einlernen)
## ab KW 3/13 bis KW 10/14: "60" (Taster Ein/Aus einlernen)
## ab KW 11/14: "40" (Richtungstaster einlernen)
# Oberer Funktions-Drehschalter: "LRN" (LED blinkt)
# FHEM Eingabefeld: „set EnO_switch_FSR61VA B0“, <Enter> (LED erlischt)
# Oberer Funktions-Drehschalter: Eine der ESV-Einstellungen
# Unterer Funktions-Drehschalter: auf "oo" einstellen (unendlich)

== Einsatzbeispiel ==
=== FSR61VA im Webfrontend anzeigen und schalten ===
Ziel: Eine an das FSR61VA angeschlossene Lampe an der Stiege soll aus dem FHEM Webfrontend ein- und ausgeschaltet werden können.

Die minimale FHEM Config für [[#Aktor|FSR61VA Aktor]] hat für dieses Beispiel noch folgende Schwächen:
# Im Webfrontend wird der Status des FSR61VA als B0 (ein) oder BI (aus) angezeigt -> wünschenswert wären "on" bzw "off"
===== Visualisierung verbessern =====
Ein Möglichkeit B0/BI auf on/off zu ändern ist das Attribut [http://fhem.de/commandref_DE.html#eventMap eventMap]
<pre>attr EnO_switch_FSR61VA eventMap BI:off B0:on</pre>
Der Name im Webfrontend könnte vielsprechender sein:
<pre>attr EnO_switch_FSR61VA alias Treppenlicht</pre>
FHEM kommt mit Icons...
<pre>attr EnO_switch_FSR61VA icon light_stairs</pre>
Icon abhängig ob on/off:
* wenn "on" dann gelb (@yellow)
* wenn "on" dann beim Klick auf das Icon: "off" (:off)
<pre>attr EnO_switch_FSR61VA devStateIcon on:light_stairs@yellow:off off:light_stairs@white:on</pre>
"group" fasst noch die Gruppe der Lichter zusammen
<pre>attr EnO_switch_FSR61VA group Licht</pre>

==== FHEM-Device EnO_switch_FSR61VA in FSR61VA einlernen ====
Das FSR61VA wird als ES verwendet.
Einlernvorgang siehe [[#FHEM Device in FSR61VA einlernen|oben]].
==== Ergebnis ====
[[Image:ScreenshotWebFrontendFSR61VA.png]]

Klick auf das linke Icon öffnet die Details zum FHEM Device.
Klick auf das rechte Icon ändert den Status vom Treppenlicht: EIN -> AUS bzw. AUS -> EIN.
Klick auf "on" schaltet das Treppenlicht definiert ein.
Klick auf "off" schaltet das Treppenlicht definiert aus.

== Links ==
* Datenblatt: [https://www.eltako.com/fileadmin/downloads/de/datenblatt/Datenblatt_FSR61VA-10A.pdf PDF]
* Anleitung: [https://www.eltako.com/de/product/professional-standard/drehstromzaehler-und-wechselstromzaehler/fsr61va-10a/ PDF]

[[Kategorie:EnOcean Components]]
[[Kategorie:Schalter (Empfänger)]]
[[Kategorie:Energieverbrauchsmessung]]

Homebridge User Configs

2023-06-28T14:38:02Z

50watt: Secu-Signal Fentergriff hinzugefügt

Dieser Eintrag dient zur Sammlung funktionsfähiger Homebridge Configs.

Bitte immer die FHEM Version und Homebridge Version angegeben.

Sehr gute Hinweise gibt es hier: http://www.meintechblog.de/2015/10/mit-siri-und-fhem-das-gesamte-smart-home-per-stimme-steuern/
== Mögliche Mappings ==
Die Möglichen Mappings können hier nachgelesen werden https://github.com/KhaosT/HAP-NodeJS/tree/master/src/lib/gen insbesondere in HomeKit.ts.

Hier ein Beispiel:
Characteristic.Brightness = function() {
Characteristic.call(this, 'Brightness', '00000008-0000-1000-8000-0026BB765291');
this.setProps({
format: Characteristic.Formats.INT,
unit: Characteristic.Units.PERCENTAGE,
maxValue: 100,
minValue: 0,
minStep: 1,
perms: [Characteristic.Perms.READ, Characteristic.Perms.WRITE, Characteristic.Perms.NOTIFY]
});
this.value = this.getDefaultValue();
};

Das Mapping in diesem Fall, hat den Titel Brightness.

Die Werte können in 1er Schritten zwischen 0 und 100 liegen (max und min Value)
== Erstellung eines HomebridgeMappings am Beispiel "Feuchtesensor" ==
Zum Einstieg etwas leicht nachvollziehbares.

Feuchtesensoren haben in der Regel ein "humidity" Reading, im Falle des Opus XT300 Bodenfeuchtesensors auch Temperatur und Batterie Level. Homekit unterstützt einen "HumiditySensor" Service. Dieser ist in homebridge-fhem nicht standardmäßig vorhanden (kann also nicht aus dem dropdown ausgewählt werden, sondern muss über das Befehlsfeld zugewiesen werden):

<code>attr meinSensor genericDeviceType HumiditySensor</code>

Im nächsten Schritt werden die Readings gemappt:

<code>attr meinSensor homebridgeMapping clear CurrentRelativeHumidity=humidity StatusLowBattery=battery,values=ok:BATTERY_LEVEL_NORMAL;;/^.*/:BATTERY_LEVEL_LOW CurrentTemperature=temperature</code>

<code>clear</code>löscht default mappings - das wird in der Regel nicht notwendig sein, schadet aber nicht

<code>CurrentRelativeHumidity</code> ist die relevante Homekit Characteristic - wird mit dem entsprechenden Reading des Sensors gemappt.

<code>StatusLowBattery</code> erwartet entweder BATTERY_LEVEL_NORMAL oder _LOW. Mein Sensor liefert ok zurück, wenn alles gut ist, also wird "ok" auf _NORMAL gemappt, alles andere auf _LOW.

Der Opus XT300 Bodenfeuchtesensors liefert auch noch die Temperatur - der HumiditySensor Service sieht das eigentlich nicht vor, daher wird die Temperatur auch nicht in der Apple "Home" App angezeigt. Bei Eve wird die Temperatur hingegen berücksichtigt.

== BRAVIA Fernseher ==
Ein Beispiel homebridgeMapping für Sony Bravia Fernseher (iOS 12.2 beta!) und genericDeviceType Television:
<pre>
clear
ConfiguredName:model
Active:state,values=off:INACTIVE;on:ACTIVE,cmds=ACTIVE:on;INACTIVE:off
RemoteKey:key,cmds=REWIND:remoteControl+Rewind;FAST_FORWARD:remoteControl+FastForward;NEXT_TRACK:remoteControl+NEXT_TRACK;PREVIOUS_TRACK:remoteControl+PREVIOUS_TRACK;ARROW_UP:remoteControl+Up;ARROW_DOWN:remoteControl+Down;ARROW_LEFT:remoteControl+Left;ARROW_RIGHT:remoteControl+Right;SELECT:remoteControl+Ok;BACK:remoteControl+RETURN;EXIT:remoteControl+Exit;PLAY_PAUSE:remoteControl+Play;INFORMATION:remoteControl+Info
SleepDiscoveryMode:default=ALWAYS_DISCOVERABLE
ClosedCaptions:default=0
DisplayOrder:default=Test1
CurrentMediaState:default=0:currentTitle
TargetMediaState:default=0,cmds=PLAY:remoteControl+play;PAUSE:remoteControl+pause;STOP:remoteControl+stop;
PictureMode:default=1
PowerModeSelection:default=1,cmds=0:remoteControl+options
ActiveIdentifier:input,default=0,values=/tv.dvbt|TV...DVB-T/:1;/HDMI.3/:2,cmds=1:input+TV+/+DVB-T;2:input+HDMI+3/ARC;3:application+Plex
TelevisionSpeaker#Mute=mute
Active:default=ACTIVE
VolumeSelector:volume,cmds=INCREMENT:VolumeUp;DECREMENT:VolumeDown
VolumeControlType:default=RELATIVE_WITH_CURRENT
linkedTo=Television
InputSource(1)#Identifier:default=1
ConfiguredName:default=TV
IsConfigured:default=CONFIGURED
InputSourceType:default=TUNER
CurrentVisibilityState:default=SHOWN
linkedTo=Television
InputSource(2)#Identifier:default=2
ConfiguredName:default=APPLE+TV
IsConfigured:default=CONFIGURED
InputSourceType:default=HDMI
CurrentVisibilityState:default=SHOWN
linkedTo=Television
InputSource(3)#Identifier:default=3
ConfiguredName:default=PLEX
IsConfigured:default=CONFIGURED
InputSourceType:default=APPLICATION
CurrentVisibilityState:default=SHOWN
linkedTo=Television
</pre>

damit lässt sich der Fernseher über Siri/Homekit ein- und ausschalten sowie über das appleTV Control-Center Widget steuern.

== EnOcean STM 250 Tür-/Fensterkontakt ==
Der STM 250 liefert als Status in FHEM <code>open</code>, wenn das Fenster offen und damit der Kontakt "offen" ist. Analog liefert er <code>closed</code> wenn das Fenster geschlossen und damit auch der Kontakt geschlossen ist. Diese Statusangaben sind sehr intuitiv zu verstehen und zu interpretieren.

Die characteristic <code>ContactSensorState</code> von HomeKit liefert entweder den Wert <code>CONTACT_DETECTED=0</code> oder <code>CONTACT_NOT_DETECTED=1</code> zurück. Wobei <code>CONTACT_DETECTED</code> bedeutet, dass der Kontakt geschlossen ist. Je nach Darstellung in der HomeKit-fähigen App muss dieses Verhalten bei der Interpretation berücksichtigt werden. Die App Eve von Elgato zum Beispiel liefert für Kontaktsensoren "JA" oder "NEIN" mit der Bedeutung <code>CONTACT_DETECTED=0=JA</code> bzw. <code>CONTACT_NOT_DETECTED=1=NEIN</code> zurück.

Noch ein wichtiger Punkt: Um einen Sensorkontakt sinnvoll einzurichten sollte als zusätzlicher Wert für das Attribut <code>genericdeviceType</code> der Wert <code>ContactSensor</code> hinzugefügt werden. Wie das geht ist im Eintrag [[Homebridge_einrichten#FHEM_konfigurieren | Homebridge einrichten]] ausführlicher beschrieben.

Folgende Attribute dann hinzufügen:
attr STM250 genericDeviceType ContactSensor
attr STM250 homebridgeMapping ContactSensorState=state,values=closed:CONTACT_DETECTED;open:CONTACT_NOT_DETECTED

Getestet mit
FHEM 5.7 Rev. 9893
Homebridge 0.2.16
homebridge-fhem Vorschauversion aus {{Link2Forum|Topic=48558|Message=402024|LinkText=homebridge/homekit}}
== EnOcean Secu-Signal Fenstergriff ==
Der [[EnOcean-SecuSignal-Fenstergriff|Secu-Signal Fenstergriff]] liefert als Status in FHEM <code>open</code> beziehungsweise <code>open_from_tilted</code>, wenn das Fenster offen ist. Analog liefert er <code>closed</code> wenn das Fenster geschlossen ist. Ist das Fenster gekippt, wird der Status <code>tilted</code> gesetzt. Diese Statusangaben sind sehr intuitiv zu verstehen und zu interpretieren.
Die Integration in HomeKit via HomeBridge erfordert zwei weitere Attribute:
<pre>
attr SecuSignal genericDeviceType window
attr SecuSignal homebridgeMapping CurrentPosition=state,values=closed:0;open:100;tilted:75;open_from_tilted:100; TargetPosition=state,values=open:100;closed:0;tilted:75;open_from_tilted:100;
</pre>
Getestet mit
FHEM 6.2
Homebridge 1.6.1
homebridge-fhem v0.5.38
== Modul RESIDENTS für Anwesenheitserkennung und Steuerung der Anwesenheit benutzen ==
[[Datei:Homebridge_bewohner_zu_szene.jpeg|mini|Schaltzustand eines Bewohners zu einer Szene hinzufügen]]
Aus den einzelnen Komponenten des Moduls RESIDENTS, homebridge sowie der characteristic <code>On</code> und der Szenensteuerung lässt sich eine gleichzeitige Steuerung der Anwesenheit und Anwesenheitserkennung basteln.

Dazu müssen folgende Schritte unternommen werden:
* einem Bewohner aus dem Modul ROOMMATE die Steuerung über homebridgeMapping hinzufügen
* Szene für "Ich bin zu Hause" und "Ich gehe jetzt" in einer HomeKit-fähigen App wie z.B. Eve einrichten

Man kann einen beliebigen Bewohner aus dem Modul ROOMMATE nehmen und ihn über die characteristic <code>On</code> in Form eines Schalters sozusagen schaltbar machen. Nur wird das Ein- und Ausschalten des Bewohners über HomeKit in FHEM auf den Status home bzw. absent gemappt. Seit dem 06.02.2016 werden RESIDENTS automatisch als Occupancy Sensor für HomeKit annonciert. Nun noch die Attribute des ROOMMATE wie folgt setzen:
attr <ROOMMATE> genericDeviceType switch
attr <ROOMMATE> homebridgeMapping On=state,valueOn=/home|awoken|asleep|gotosleep/,valueOff=/gone|absent/,cmdOn=home,cmdOff=absent

Natürlich muss der Bewohner noch dem Filter von homebridge hinzugefügt und homebridge neu gestartet werden.

Anschließend geht es in der HomeKit-fähigen App Deiner Wahl weiter. In Eve von Elgato ist von vornherein zum Beispiel vorgesehen, dass man zwei Szenen "Ich bin zuhause" und "Ich verlasse das Haus" hat. Zu diesen Szenen wird eine Aktion hinzugefügt indem der Bewohner, den das ROOMMATE-Modul meldet zur Szene hinzugefügt wird und beim Nachhausekommen "eingeschaltet" wird. Genauso wird mit der Szene "Ich verlasse das Haus" verfahren: Bewohner zur Szene hinzufügen und den Schaltvorgang auf "ausschalten" setzen.

Mit den Sprachbefehlen "Ich bin zuhause" oder "Ich verlasse das Haus" wird die entsprechende Szene eingeschaltet, homebridge schaltet über das <code>homebridgeMapping</code> Attribut dann den Bewohner auf "home" oder "absent".

Getestet mit
FHEM 5.7 Rev. 9893
Homebridge 0.2.16
homebridge-fhem Vorschauversion aus {{Link2Forum|Topic=48558|Message=402024|LinkText=homebridge/homekit}}

Eine noch etwas bessere Schaltmöglichkeit bietet '''genericDeviceType security'''.
Das Mapping für ROOMMATE sieht wie folgt aus:
attr TYPE=ROOMMATE genericDeviceType security
attr TYPE=ROOMMATE homebridgeMapping SecuritySystemCurrentState=state,values=/home|awoken/:0;;absent:1;;/asleep|gotosleep/:2;;gone:3 SecuritySystemTargetState=SecuritySystemCurrentState,cmds=0:state+home;;1:state+absent;;2:state+gotosleep;;3:state+gone,delay=1
für GUEST:
attr TYPE=GUEST genericDeviceType security
attr TYPE=GUEST homebridgeMapping SecuritySystemCurrentState=state,values=/home|awoken/:0;;absent:1;;/asleep|gotosleep/:2;;none:3 SecuritySystemTargetState=SecuritySystemCurrentState,cmds=0:state+home;;1:state+absent;;2:state+gotosleep;;3:state+none,delay=1

== Homematic Luftfeuchtigkeits- und Temperatursensoren ==

Mit folgenden Geräten wurde folgendes Mapping erstellt und somit erfolgreich getestet:

- HM-WDS10-TH-O
- HM-WDS40-TH-I
- HM-WDS40-TH-I-2

Achtung: Hier wird genericDeviceType "TemperatureSensor" verwendet, um eine history in EVE zu erhalten. Mit einem "HumiditySensor" funktionierte dies bei den Tests (Februar 2019) nicht.

attr <THSensor> genericDeviceType TemperatureSensor

attr <THSensor> CurrentRelativeHumidity=humidity
CurrentTemperature=temperature
StatusLowBattery=battery,values=ok:BATTERY_LEVEL_NORMAL;/^.*/:BATTERY_LEVEL_LOW
history:size=1024

== Homematic SmokeDetector HM-SEC-SD und HM-SEC-SD2 ==
[[Datei:Homebridge-Homematic-Smokedetector-Gen1.jpg|mini|Homebridge-Homematic-Smokedetector-Gen1 in EVE]]
Es sind keine Homebridge Mappings für die Rauch Meldung erforderlich.

Allerdings ist ein Mapping für den Batterie Zustand nötig, siehe Unten.

attr <SmokeDetector> genericDeviceType SmokeSensor
attr <SmokeDetector> subType smokeDetector

attr <SmokeDetector> homebridgeMapping StatusLowBattery=battery,values=ok:BATTERY_LEVEL_NORMAL;;/^.*/:BATTERY_LEVEL_LOW

== Homematic Heizkörperthermostat HM-CC-RT-DN ==
[[Datei:HM-CC-RT-DN-Eve.PNG|mini|Darstellung des HM-CC-RT-DN in der iOS App Eve]]
attr <HMCCRTDN_Channel2_Clima> homebridgeMapping TargetTemperature=desired-temp::desired-temp,minValue=5,maxValue=35,minStep=0.5,nocache=1
CurrentTemperature=BU_Heizung_01_Clima:measured-temp,nocache=1
StatusLowBattery=BU_Heizung_01:battery,values=ok:BATTERY_LEVEL_NORMAL;;/^.*/:BATTERY_LEVEL_LOW
TargetHeatingCoolingState=heatingState,values=OFF:0;;HEAT:1;;COOL:2;;AUTO:3,cmds=OFF:controlManu+off;;HEAT:controlMode+boost;;AUTO:controlMode+auto;;COOL:controlManu+17.0
CurrentHeatingCoolingState=heatingState,values=OFF:0;;HEAT:1;;COOL:2;;AUTO:0,valud=OFF
attr <HMCCRTDN_Channel2_Clima> siriName Robby
Dieses Mapping bezieht sich auf ein vorhandenes ''userReading'' mit dem Namen <code>heatingState</code>, womit Homekit die einzelnen Status nachher unterscheidet.
attr <HM-CC-RT-DN_Clima> userReadings heatingState {(ReadingsVal($NAME,"ValvePosition",0) > 0 || ReadingsVal($NAME,"desired-temp","-") eq "on") ? "HEAT" : ReadingsVal($NAME,"desired-temp","-") eq "off" ? "OFF" : ReadingsVal($NAME,"controlMode","auto") eq "auto" ? "AUTO" : (ReadingsVal($NAME,"measured-temp",20) > ReadingsVal($NAME,"desired-temp",20)) ? "COOL" : "AUTO"}
Global auf alle in FHEM angelegten HM-CC-RT-DN, lässt sich mit folgendem Befehl das ''userReading'' anlegen.
Siehe [https://forum.fhem.de/index.php/topic,59211.msg505986.html#msg505986 Forumsthread].

attr TYPE=CUL_HM:FILTER=model=HM-CC-RT-DN:FILTER=chanNo=04 userReadings heatingState {(ReadingsVal($NAME,"ValvePosition",0) > 0 || ReadingsVal($NAME,"desired-temp","-") eq "on") ? "HEAT" : ReadingsVal($NAME,"desired-temp","-") eq "off" ? "OFF" : ReadingsVal($NAME,"controlMode","auto") eq "auto" ? "AUTO" : (ReadingsVal($NAME,"measured-temp",20) > ReadingsVal($NAME,"desired-temp",20)) ? "COOL" : "AUTO"}

== Homematic IP Wandthermostat mit Schaltausgang HmIP-BWTH ==
attr <HmIP_BWTH_Thermostat> homebridgeMapping TargetTemperature=1.SET_POINT_TEMPERATURE::1.SET_POINT_TEMPERATURE,,minValue=17,maxValue=25,minStep=0.5,cmd=control,nocache=true
CurrentTemperature=1.ACTUAL_TEMPERATURE
CurrentHeatingCoolingState=heatingState,values=HEAT:1;COOL:2;OFF:0;AUTO:0
TargetHeatingCoolingState=heatingState,values=OFF:0;HEAT:1;COOL:2;AUTO:3,cmds=OFF:datapoint+1.CONTROL_MODE+1;HEAT:datapoint+1.BOOST_MODE+1;COOL:datapoint+1.BOOST_MODE+0;AUTO:datapoint+1.CONTROL_MODE+0
CurrentRelativeHumidity=1.HUMIDITY

Dieses Mapping bezieht sich auf ein vorhandenes ''userReading'' mit dem Namen <code>heatingState</code>, womit Homekit die einzelnen Status nachher unterscheidet.
attr <HmIP_BWTH_Thermostat> userReadings heatingState {(ReadingsVal($NAME,"10.STATE",0) eq 1 && ReadingsVal($NAME,"1.HEATING_COOLING",0) eq 0) ? "HEAT" : ReadingsVal($NAME,"1.SET_POINT_TEMPERATURE","-") eq "off" ? "OFF" : ReadingsVal($NAME,"1.SET_POINT_MODE","-") eq 0 ? "AUTO" : (ReadingsVal($NAME,"10.STATE",0) eq 1 && ReadingsVal($NAME,"1.HEATING_COOLING",0) eq 1) ? "COOL" : "OFF"}

== Homematic Wetterstation OC3 HM-WDS100-C6-O-2 ==
[[Datei: homebridge-wetter.jpg|mini|Wetterstation in EVE]]
Mit der EVE und den hier: [https://github.com/naofireblade/homebridge-weather-plus/blob/master/util/characteristics.js] beschriebenen Characteristics lässt sich eine lokale Homematic OC3 Wetterstation aus FHEM einbinden:
<pre>
clear
CurrentTemperature:temperature
CurrentRelativeHumidity:humidity
49C8AE5A-A3A5-41AB-BF1F-12D5654F9F41:windSpeed,name=WINDGESCHWINDIGKEIT,format=FLOAT,unit=kmh,maxValue=250,minValue=0,minStep=1
46f1284c-1912-421b-82f5-eb75008b167e:windDirection,name=WINDRICHTUNG,format=UINT8,unit=ARC_DEGREE,maxValue=360,minValue=0,minStep=1
StatusLowBattery:battery,values=ok:BATTERY_LEVEL_NORMAL;/^.*/:BATTERY_LEVEL_LOW
ccc04890-565b-4376-b39a-3113341d9e0f:RegenmengeLast24Hours:state,name=REGEN_24h,format=FLOAT,unit=mm,maxValue=100,minValue=0,minStep=1
10c88f40-7ec4-478c-8d5a-bd0c3cce14b7:RegenmengeLast1Hours:state,name=REGEN_1h,format=FLOAT,unit=mm,maxValue=100,minValue=0,minStep=1
0000006B-0000-1000-8000-0026BB765291:brightness,name=BRIGHTNESS,format=FLOAT,unit=LUX,maxValue=10000,minValue=0,minStep=.0001
cd65a9ab-85ad-494a-b2bd-2f380084134c:isRaining,name=BEDINGUNGKATEGORIE,values=0:0;1:2,format=UINT8,maxValue=3,minValue=0,minStep=1
cd65a9ab-85ad-494a-b2bd-2f380084134d:isRaining,name=BEDINGUNG,format=STRING,values=0:-;/.*/:Regen
</pre>

== Roomba über THINKINGCLEANER Modul ==
attr <THINKINGCLEANER> genericDeviceType switch
attr <THINKINGCLEANER> homebridgeMapping clear On=state,valueOn=/^(on|dock)/,cmdOn=on,cmdOff=off,nocache=1 ChargingState=deviceStatus,values=/(_recon|_full|_trickle)$/:CHARGING;/^.*/:NOT_CHARGING
attr <THINKINGCLEANER> siriName Robby

Getestet mit
FHEM 5.7 Rev. 12680
homebridge 0.4.11
homebridge-fhem 0.2.66

== Vallox Belüftungsanlage ==
Die Steuerung der Lüftungsgeschwindigkeit ist nur in Prozent möglich. Die Umrechnung erfolgt im [[Vallox]] Modul.
Hierzu wurde das Reading ''FanSpeedPct'' hinzugefügt.

attr <Vallox> genericDeviceType Fan
attr <Vallox> homebridgeMapping clear
model=Vallox
On=PowerState,valueOn=1,readOnly=1
RotationSpeed=FanSpeedPct,minValue=1,maxValue=100,cmd=FanSpeedPct,delay=1

== Xiaomi Vacuum Cleaner 1. Generation ==
[[Datei:XIAOMI_VACUUM_CLEANER-Gen1.jpg|mini|XIAOMI VACUUM 1. GEN in EVE]]
Voraussetzung zur Verwendung der Mappings, ist ein eingebundener Staubsauger mit dem Modul 72_XiaomiDevice.

Siehe [https://forum.fhem.de/index.php/topic,73052.0.html Forumsthread]
Das Modul muss manuell installiert werden.

attr <XIAOMI> genericDeviceType switch
attr <XIAOMI> homebridgeMapping On=state,valueOn=Cleaning,cmdOn=start,cmdOff=charge
RotationSpeed=fan_power,minValue=0,maxValue=90,cmd=fan_power,delay=1
BatteryLevel=batteryLevel,maxValue=100,minValue=0,minStep=1
StatusLowBattery=battery,values=ok:BATTERY_LEVEL_NORMAL;;low:BATTERY_LEVEL_LOW
ChargingState=state,values=Docked:NOT_CHARGING;;Charging:CHARGING;;/.*/:NOT_CHARGEABLE
OccupancyDetected=state,values=/Docked|Charging/:OCCUPANCY_DETECTED;;/.*/:OCCUPANCY_NOT_DETECTED
FilterLifeLevel=consumables_filter,minValue=0,maxValue=100
FilterChangeIndication=consumables_filter,values=0:CHANGE_FILTER

== Roborock S50 (2. Generation des Xiaomi Vacuum Cleaners) ==
[[Datei:Roborock S50.png|mini]]
Voraussetzung zur Verwendung der Mappings, ist ein eingebundener Staubsauger mit dem Modul 72_XiaomiDevice.

Siehe [https://forum.fhem.de/index.php/topic,73052.0.html Forumsthread]
Das Modul muss manuell installiert werden.

Das folgende Mapping für den Roborook S50 beinhaltet neben den Characteristics der 1. Genration des Xiaomi Vacuum Cleaners weitere Custom Mappings. Diese werden auch auf dem Bild dargestellt. Falls das einem zu viele Informationen sind, können diese beim Einfügen einfach weggelassen oder in EVE ausgeblendet werden.

attr <XIAOMI> genericDeviceType switch
attr <XIAOMI> homebridgeMapping On=state,valueOn=Cleaning,cmdOn=start,cmdOff=charge
RotationSpeed=fan_power,minValue=0,maxValue=90,cmd=fan_power,delay=1
BatteryLevel=batteryPercent,maxValue=100,minValue=0,minStep=1
StatusLowBattery=batteryState,values=ok:BATTERY_LEVEL_NORMAL;;low:BATTERY_LEVEL_LOW
ChargingState=state,values=Docked:NOT_CHARGING;;Charging:CHARGING;;/.*/:NOT_CHARGEABLE
OccupancyDetected=state,values=/Docked|Charging/:OCCUPANCY_DETECTED;;/.*/:OCCUPANCY_NOT_DETECTED
2af6d0d0-3691-4f0d-9c9c-c1098295b1cb=consumables_sensors,name=Reinigung+Sensoren,minValue=0,maxValue=100,format=FLOAT,minStep=1,unit=%
fd11b965-052e-430f-b08f-206287d8bc00=consumables_filter,name=Austausch+Filter,minValue=0,maxValue=100,format=FLOAT,minStep=1,unit=%
fe7a8dac-dff3-4a07-8a5e-0d6abbf0df0c=consumables_main_brush,name=Austausch+Hauptbürste,minValue=0,maxValue=100,format=FLOAT,minStep=1,unit=%
4f9b2a22-b764-4fc1-8cd2-99383924394c=consumables_side_brush,name=Austausch+Seitenbürste,minValue=0,maxValue=100,format=FLOAT,minStep=1,unit=%
FilterLifeLevel=consumables_filter,minValue=0,maxValue=100
FilterChangeIndication=consumables_filter,values=0:CHANGE_FILTER
4896763a-26f7-400b-9734-2ce6564ceba2=total_clean_time,name=Lebenszeitersparnis,format=FLOAT,minStep=1,unit=h
82af5fd7-50a3-4ab3-81d3-1f7903de612a=total_clean_area,name=Gereinigte+Fläche,format=FLOAT,minStep=1,unit=m²
00d2ef14-b429-4569-8af3-c342d41cf383=total_cleans,name=Reinigungsvorgänge,format=FLOAT,minStep=1
e8d1027e-b068-40d5-9efd-f161b1b52774=device_firmware,name=Firmware,format=STRING

== Xiaomi Fan (ältere Generationen mit Luftfeuchtigkeits- und Temperatursensor und Battery-Readings) ==
[[Datei:Xiaomi DC Pedestal Fan.png|mini]]
Voraussetzung zur Verwendung der Mappings, ist ein eingebundener Ventilator mit dem Modul 72_XiaomiDevice.
Siehe [https://forum.fhem.de/index.php/topic,73052.0.html Forumsthread]
Das Modul muss manuell installiert werden.

Die ältere Generation enthält Sensoren und somit Readings für Luftfeuchtigkeit, Temperatur und auch Batteriestatus. Diese fehlen bei den neueren Generation dieses Ventilators, siehe Bilder. Da anscheinend jedes Jahr neue Generationen dieses Ventilators herausgekommen sind, ist nicht klar bis zu welcher Generation diese Sensoren enthalten waren.

Mit folgenden Geräten wurde folgendes Mapping erstellt und somit erfolgreich getestet:

- Xiaomi DC Pedestal Fan (FHEM model fehlt, Default Hostname am Router: zhimi-fan-v3)
- Liste bitte ergänzen!

Um möglichst viele Funktionen bereitzustellen, wurden auch Characteristics von anderen DeviceTypes verwendet. Erklärung zu den Characteristics:

- Die Kindersicherung (LockPhysicalControls) ist in Eve über das kleine Einstellungssymbol zu finden.
- Mit AudioFeedback/Audio-Bestätigung werden die Töne des Lüfters ein bzw. ausgeschaltet.
- Mit NightVision/Nachtsicht werden die LEDs ein (bright) bzw. ausgeschaltet (off).
- Mit Mute/Audio wird der Windmodus von Straight zu Natural geschaltet.
- Mit TargetTiltAngle/Neigung kann der Schwenkwinkel justiert werden.
- Mit SwingMode/Schwenken kann der Schwenkmodus ein bzw. ausgeschaltet werden.
- Der Rest ist selbsterklärend.

homebridgeMapping:

attr <XIAOMI> genericDeviceType Fan
attr <XIAOMI> homebridgeMapping
clear
On:power,cmdOn=on,cmdOff=off,valueOn=on,valueOff=off
LockPhysicalControls=child_lock,values=on:CONTROL_LOCK_ENABLED;;off:CONTROL_LOCK_DISABLED,cmds=CONTROL_LOCK_ENABLED:child_lock+on;CONTROL_LOCK_DISABLED:child_lock+off
RotationSpeed=level,minValue=0,maxValue=100,cmd=level,delay=1
TargetTiltAngle=angle,minValue=30,maxValue=120,minStep=30,cmd=angle
SwingMode=angle_enable,values=on:SWING_ENABLED;;off:SWING_DISABLED,cmdOn=angle_enable+on,cmdOff=angle_enable+off
CurrentRelativeHumidity=humidity
CurrentTemperature=temperature
BatteryLevel=batteryPercent,maxValue=100,minValue=0,minStep=1
StatusLowBattery=batteryState,values=ok:BATTERY_LEVEL_NORMAL;;low:BATTERY_LEVEL_LOW
ChargingState=charging,values=complete:NOT_CHARGING;;progress:CHARGING;;/.*/:NOT_CHARGEABLE
AudioFeedback:buzzer,cmdOn=buzzer+on,cmdOff=buzzer+off,valueOn=on,valueOff=off
NightVision:led,cmdOn=led+off,cmdOff=led+bright,valueOn=off,valueOff=bright
Mute:mode,cmdOn=mode+straight,cmdOff=mode+natural,valueOn=straight,valueOff=natural
CurrentFanState:power,values=on:BLOWING_AIR;;off:INACTIVE;;/.*/:IDLE

== Xiaomi Fan (neuere Generationen ohne Luftfeuchtigkeits- und Temperatursensor und Battery-Readings) ==
[[Datei:Xiaomi Standing Fan 2 bzw. 2S.png|mini]]
Voraussetzung zur Verwendung der Mappings, ist ein eingebundener Ventilator mit dem Modul 72_XiaomiDevice.
Siehe [https://forum.fhem.de/index.php/topic,73052.0.html Forumsthread]
Das Modul muss manuell installiert werden.

Den neueren Generationen dieses Ventilators fehlen Sensoren und somit Readings für Luftfeuchtigkeit, Temperatur und auch Batteriestatus. Diese sind bei der älteren Generation dieses Ventilators enthalten, siehe vorangegangenes Beispiel.

Dieses Mapping wurde mit dem "2S" erstellt. Es sollte aber mindestens auch mit einem "Xiaomi Standing Fan 2" (ohne Akku) funktionieren, da auch der "Xiaomi Standing Fan 2S" (mit Akku) kein Reading für die Batterie bereitstellt. Ansonsten gibt es wohl auch noch Generationen zwischen dem "Xiaomi DC Pedestal Fan" und den "Xiaomi Standing Fan 2/2S". Es ist davon auszugehen, dass dieses Beispiel genauso auch bei diesen Modellen funktioniert.

Mit folgenden Geräten wurde folgendes Mapping erstellt und somit erfolgreich getestet:

- 2019 Xiaomi Standing Fan 2S (FHEM model bzw. Default Hostname am Router: zhimi-fan-za4)
- 2018 Xiaomi ZhiMiDCVariableFrequencyFan ZRFFS01ZM (FHEM model bzw. Default Hostname am Router: zhimi-fan-za1)
- Liste bitte ergänzen!

Um möglichst viele Funktionen bereitzustellen, wurden auch Characteristics von anderen DeviceTypes verwendet. Erklärung zu den Characteristics:

- Die Kindersicherung (LockPhysicalControls) ist in Eve über das kleine Einstellungssymbol zu finden.
- Mit AudioFeedback/Audio-Bestätigung werden die Töne des Lüfters ein bzw. ausgeschaltet.
- Mit NightVision/Nachtsicht werden die LEDs ein (bright) bzw. ausgeschaltet (off).
- Mit Mute/Audio wird der Windmodus von Straight zu Natural geschaltet.
- Mit TargetTiltAngle/Neigung kann der Schwenkwinkel justiert werden.
- Mit SwingMode/Schwenken kann der Schwenkmodus ein bzw. ausgeschaltet werden.
- Der Rest ist selbsterklärend.

homebridgeMapping:

attr <XIAOMI> genericDeviceType Fan
attr <XIAOMI> homebridgeMapping
clear
On:power,cmdOn=on,cmdOff=off,valueOn=on,valueOff=off
LockPhysicalControls=child_lock,values=on:CONTROL_LOCK_ENABLED;;off:CONTROL_LOCK_DISABLED,cmds=CONTROL_LOCK_ENABLED:child_lock+on;CONTROL_LOCK_DISABLED:child_lock+off
RotationSpeed=level,minValue=0,maxValue=100,cmd=level,delay=1
TargetTiltAngle=angle,minValue=30,maxValue=120,minStep=30,cmd=angle
SwingMode=angle_enable,values=on:SWING_ENABLED;;off:SWING_DISABLED,cmdOn=angle_enable+on,cmdOff=angle_enable+off
AudioFeedback:buzzer,cmdOn=buzzer+on,cmdOff=buzzer+off,valueOn=on,valueOff=off
NightVision:led,cmdOn=led+off,cmdOff=led+bright,valueOn=off,valueOff=bright
Mute:mode,cmdOn=mode+straight,cmdOff=mode+natural,valueOn=straight,valueOff=natural
CurrentFanState:power,values=on:BLOWING_AIR;;off:INACTIVE;;/.*/:IDLE

== ZWave Türschloss Vision ZM1701 einbinden ==
Das ZWave Türschloss ZM1701 von der Firma Vision sendet seinen aktuellen Schließstatus in ein einzelnes Reading wie "lock", sondern schickt eine ganze Reihe von Informationen über den Zustand in das Reading <code>doorLockOperation</code>. Das Schließen und Öffnen der Türschlosses wird auch nicht mit einem Setzen des <code>state</code> erreicht, sondern mit dem Setzen von <code>doorLockOperation</code>. Das macht das Einbinden in homebridge nicht trivial, funktioniert aber über folgendes Homebridge-Mapping:
attr <ZM1701> genericDeviceType lock
attr <ZM1701> homebridgeMapping LockCurrentState=doorLockOperation,values=/\ssecured/:SECURED;/unsecured/:UNSECURED LockTargetState=doorLockOperation,values=/\ssecured/:SECURED;/unsecured/:UNSECURED,cmds=SECURED:doorLockOperation+close;UNSECURED:doorLockOperation+open

Kurz zur Erklärung: Um ein Schloss über HomeKit steuern zu können braucht es zwei characteristics. LockCurrentState zeigt an, ob das Schloss geöffnet oder geschlossen ist. Und mit LockTargetState wird das Schloss geöffnet oder geschlossen. Damit der aktuelle Status des Schlosses ausgelesen werden kann, muss aus dem FHEM-Reading <code>doorLockOperation</code> die Zeichenfolge <code> secured</code> oder <code>unsecured</code> extrahiert werden, daher die beiden regulären Ausdrücke <code>/\ssecured/</code> und <code>/unsecured/</code>. In der characteristic <code>LockTargetState</code> muss sowohl der aktuelle Status des Schlosses als auch das Kommando angegeben werden, schließlich möchte man ein geschlossenes Schloss nicht nochmal schließen. Daher wird erst aus dem Reading <code>doorLockOperation</code> der aktuelle Status des Schlosses ausgelesen und die damit korrespondierenden Befehle über <code>cmds=SECURED:doorLockOperation+close;UNSECURED:doorLockOperation+open</code> generiert.

Wer es in FHEM über ein webCmd einfacher zu bedienen haben möchte, fügt bitte noch die dafür notwendigen Attribute und die leicht geänderten homebridgeMappings wie folgt ein:
attr <ZM1701> genericDeviceType lock
attr <ZM1701> homebridgeMapping LockCurrentState=doorLockOperation,values=/\ssecured/:SECURED;/unsecured/:UNSECURED LockTargetState=doorLockOperation,values=/\ssecured/:SECURED;/unsecured/:UNSECURED,cmds=SECURED:close;UNSECURED:open
attr <ZM1701> /doorLockOperation open:open/doorLockOperation close:close
attr <ZM1701> webCmd open:close

== Garagentorsteuerung und Schließzustandserkennung mit einem Shelly Plus 1 anhand eines Sommer S9080 base+ Antriebs ==

=== 1. Konfiguration und Installation des Shellys ===
[[Datei:Shelly Input Output.jpg|mini|alternativtext=|Änderung des Relay Types]]
[[Datei:Shelly AutoOff.jpg|mini|alternativtext=|Shelly als Taster konfigurieren]]
[[Datei:Shelly-Verkableung.jpg|mini|alternativtext=|Shelly, Garagentor Platine und Relay]]
Da der Shelly hierbei zwei verschiedene Aufgaben übernehmen soll, müssen zunächst die nachfolgenden Einstellungen am Shelly vorgenommen werden:
# Im Webend des Shellys (unter seiner IP-Adresse zu erreichen) in den Einstellungen ''Channel Settings > Input output settings'' den relay type auf "''Detached''" stellen. Dies hat zur Folge, dass die Eingänge für den Schalter (also da wo normalerweise z. B. der Lichtschalter angeschlossen und vom Shelly ausgewertet wird) vom internen Relay des Shellys (das z.B. den Strom zur Lampe schaltet) losgelöst wird. Somit lässt sich später der Zustand des des angeschlossenen Schalters (in diesem Beispiel der Schließzustand des Garagentors) separat auswerten ohne, dass etwas geschaltet wird.
# Da der Shelly zum Öffnen des Tors nur ein kurzen Stromstoß, wie beispielsweise ein Tastschalter, an die Garagentor-Elektronik schicken soll, müssen wir in den Einstellungen ''Timers > Auto'' off einen Aus-Timer einstellen. Der Shelly funktioniert somit als Taster.
Gemäß der Anleitung benötigt man beim besagten Garagentorantrieb der Firma Sommer ein weiteres Relay (als Zubehörteil erhältlich), welches einfach auf die Hauptplatine aufgesteckt wird, um den Schließzustand des Tors auszuwerten. Das Relay zieht an, sobald das Tor nicht geschlossen ist.

=== 2. FHEM + Homebridge-Mapping ===
Der Shelly wird per Autocreate des MQTT2 Moduls selbstständig angelegt. In diesem Beispiel mit dem Namen shellyplus1_a8032abd6100. Das Reading "''params_input_0_state''" liefert uns hierbei den Wert des losgelösten Schaltereingangs (also den Schließzustand des Garagentors). Hierbei ist zu beachten, dass das Reading erst auftaucht sobald der Schalter das erste mal geschlossen (also das Garagentor geöffnet) wurde.

Die weitere Konfiguration erfolgte mit:
attr MQTT2_shellyplus1_a8032abd6100 alias Garagentor
attr MQTT2_shellyplus1_a8032abd6100 webCmd auf:zu
attr MQTT2_shellyplus1_a8032abd6100 devStateIcon 1.open:fts_garage_door_10 1.closed:fts_garage_door_100\
attr MQTT2_shellyplus1_a8032abd6100 eventMap on:auf on:zu
attr MQTT2_shellyplus1_a8032abd6100 genericDeviceType garage
attr MQTT2_shellyplus1_a8032abd6100 group Garage
attr MQTT2_shellyplus1_a8032abd6100 homebridgeMapping CurrentDoorState=homebridgestate,values=0:CLOSED;;1:OPEN TargetDoorState=CurrentDoorState,cmds=OPEN:on;;CLOSED:on
attr MQTT2_shellyplus1_a8032abd6100 icon fts_garage
attr MQTT2_shellyplus1_a8032abd6100 room Homekit
attr MQTT2_shellyplus1_a8032abd6100 stateFormat 1:TOR\
<nowiki> </nowiki><nowiki> FGStatus
attr MQTT2_shellyplus1_a8032abd6100 userReadings TOR {(ReadingsVal($name,"params_input_0_state","true") eq "true")?"open":"closed"},\
FGStatus {if (ReadingsVal($name,"params_input_0_state","") eq "true") {ReadingsTimestamp($name,"params_input_0_state","") =~ /^(\d+)-(\d+)-(\d+)\s(\d+:\d+):(\d+)$/;; return "Letzte Öffnung: am $3.$2.$1 um $4 Uhr"} else {ReadingsTimestamp($name,"params_input_0_state","") =~ /^(\d+)-(\d+)-(\d+)\s(\d+:\d+):(\d+)$/;; return "Letzte Schließung: am $3.$2.$1 um $4 Uhr"}},\
homebridgestate {(ReadingsVal($name,"params_input_0_state","true") eq "true")?1:0}</nowiki>
Ergänzt wurde das MQTT2-Modul automatisch angelegt Attribut um die letzten beiden Zeilen (auf, zu):
<nowiki>attr MQTT2_shellyplus1_a8032abd6100 setList toggle:noArg $DEVICETOPIC/rpc {"id":0,"src":"fhem","method":"Switch.Toggle","params": {"id":0}}\</nowiki>
<nowiki> </nowiki><nowiki> off:noArg $DEVICETOPIC/rpc {"id":0,"src":"fhem","method":"Switch.Set","params": {"id":0,"on":false}}\</nowiki>
<nowiki> </nowiki><nowiki> on:noArg $DEVICETOPIC/rpc {"id":0,"src":"fhem","method":"Switch.Set","params": {"id":0,"on":true}}\</nowiki>
<nowiki> </nowiki><nowiki> on-for-timer $DEVICETOPIC/rpc {"id":0,"src":"fhem","method":"Switch.Set","params": {"id":0,"on":true,"toggle_after":$EVTPART1}}\</nowiki>
<nowiki> </nowiki><nowiki> x_update:noArg $DEVICETOPIC/rpc {"id":0,"src":"fhem","method":"Shelly.Update","params": {"stage":"stable"}}\</nowiki>
<nowiki> </nowiki> x_reboot:noArg $DEVICETOPIC/rpc {"id":0,"src":"fhem","method":"Shelly.Reboot"}\
<nowiki> </nowiki><nowiki> auf:noArg $DEVICETOPIC/rpc {"id":0,"src":"fhem","method":"Switch.Set","params": {"id":0,"on":true}}\</nowiki>
<nowiki> </nowiki><nowiki> zu:noArg $DEVICETOPIC/rpc {"id":0,"src":"fhem","method":"Switch.Set","params": {"id":0,"on":false}}</nowiki>
[[Datei:IOs.png|mini|alternativtext=|Ansicht in HomeKit]]

[[Datei:FHEM.jpg|mini|alternativtext=|Ergebnis in FHEM]]

Getestet mit
FHEM 6.1 Rev. 25376
homebridge 1.4.0
homebridge-fhem 0.5.33

[[Kategorie:HOWTOS]]
[[Kategorie:Sprachsteuerung]]
[[Kategorie:Code Snippets]]

EnOcean-SecuSignal-Fenstergriff

2023-06-28T14:25:44Z

50watt: Homebridge Attribute hinzugefügt

{{Infobox Hardware
|Bild=FHF-al.jpg
|Bildbeschreibung=Eltako FHF-al
|HWProtocol=EnOcean
|HWType=Sender, Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=
|HWVoltage=
|HWPowerConsumption=
|HWPoweredBy=Bewegungsenergie bei Positonsänderung
|HWSize=
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Hoppe
}}

'''EnOcean-SecuSignal-Fenstergriff''' ist ein Fenstergriff mit integrierten Funk-Sendemodul

== Features ==
Fenstergriff mit integriertem EnOcean-Funkmodul, der als nicht abschließbare und abschließbare Variante in verschiedenen Farben erhältlich ist. Funktelegramme werden beim Öffnen, Kippen und Schließen erzeugt.
Der Fenstergriff wird auch unter anderen Bezeichnungen vermarktet (beispielsweise als Eltako FHF)

== Hinweise zum Betrieb mit FHEM ==
=== Definition/Anlernvorgang ===
Der Fenstergriff wird bei Empfang des ersten Funktelegramms durch Änderung der Griffposition vollständig von FHEM im <code>learningMode</code> erkannt. Definition das FHEM-Device für den Fenstergriff nebst [[FileLog]] und [[SVG]] für einen Plot erfolgt dann automatisch durch [[autocreate]].

Anlernvorgang:
# FHEM in Lernmodus schalten: <code><nowiki>set <IODev> teach <time/s></nowiki></code>
# Funktelegramm durch Drehen des Fenstergiffes auslösen. Das Anlegen in der Konfiguration erfolgt dann automatisch per autocreate.

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der [[Konfiguration]]:
<pre>
define Kuechenfenster EnOcean FF010101
attr Kuechenfenster IODev TCM310_0
attr Kuechenfenster eep F6-10-00
attr Kuechenfenster room EnOcean
attr Kuechenfenster subType windowHandle
define FileLog_Kuechenfenster FileLog ./log/EnO_switch_Kuechenfenster-%Y.log Kuechenfenster
attr FileLog_Kuechenfenster logtype text
attr FileLog_Kuechenfenster room EnOcean
</pre>

=== Logbeispiel ===
<pre>
2014-08-11_12:03:02 Kuechenfenster open_from_tilted
2014-08-11_12:03:03 Kuechenfenster closed
2014-08-11_12:03:05 Kuechenfenster open
2014-08-11_12:03:05 Kuechenfenster tilted
2014-08-11_12:03:07 Kuechenfenster open_from_tilted
2014-08-11_12:03:08 Kuechenfenster closed
2014-08-11_12:03:10 Kuechenfenster open
2014-08-11_12:03:11 Kuechenfenster tilted
2014-08-11_12:03:13 Kuechenfenster open_from_tilted
2014-08-11_12:03:14 Kuechenfenster closed
2014-08-11_12:03:15 Kuechenfenster open
2014-08-11_12:03:15 Kuechenfenster tilted
</pre>

== Einsatzbeispiel ==
=== Anzeige Fensterstatus im WebFrontend ===
Durch folgendes Attribut wird der Fensterstatus im WebFrontend bildlich dargestellt:
attr Kuechenfenster devStateIcon closed:fts_window_2w open:fts_window_2w_open_l tilted:fts_window_2w_tilt_l open_from_tilted:fts_window_2w_open_l

aus {{Link2Forum|Topic=25990|Message=190198|LinkText=Forenbeitrag}}

=== Plot des Fenstergriffstatus ===
In aktuellen FHEM-Versionen wird ein Plot nebst FileLog für den EnOcean-Fensterkontakt automatisch beim Anlernen angelegt. Eine manuelle Anlage ist nicht mehr notwendig. Bei alten FHEM-Installationen kann das von FHEM mitgeliefert Plot nachträglich durch folgende Vorgehensweise erzeugt werden: im DEF der Detailansicht des FHEM-Devices hinter der SenderID des Fenstergriffes (hier im Config-Auszug: FF010101) nach einem Leerzeichen das EEP <code>F6.10.00</code> eintragen und den Button {{Taste|modify <device>}} anklicken. Das Filelog und der Plot werden automatisch angelegt.

Die nachfolgenden Angaben sind für manuelle Anlage und Bearbeitung von Plots weiterhin noch aktuell.

Als "function":
<pre>$fld[2]=~"ope.*"?1:($fld[2]=~"tilted"?0.8:0)</pre>
Als "Tics as"
<pre>("offen" 1,"gekippt" 0.8,"zu" 0)</pre>
[[Image:Plot tuergriff 1.png]]

== HomeBridge Integration ==
Die Integration in HomeKit via HomeBridge erfordert zwei weitere Attribute:
<pre>
attr Kuechenfenster genericDeviceType window
attr Kuechenfenster homebridgeMapping CurrentPosition=state,values=closed:0;open:100;tilted:75;open_from_tilted:100; TargetPosition=state,values=open:100;closed:0;tilted:75;open_from_tilted:100;
</pre>
== Links ==
* Datenblatt: [http://www.eltako.com/fileadmin/downloads/de/Datenblatt/FUNK_datenblatt_FHF.pdf PDF]

[[Kategorie:EnOcean Components]]
[[Kategorie:Schalter (Sender)]]
[[Kategorie:Zustandssensoren]]

Wetter und Wettervorhersagen

2023-05-11T05:00:27Z

50watt: /* Deutscher Wetterdienst (DWD) */ national versus international

Wetterdaten und Wettervorhersagen können auf verschiedene Weise in FHEM eingebunden werden.
== Modul Weather ==
Das Modul [[Weather]] extrahiert Wetterdaten via API von den Wetterdatenanbietern
* [https://openweathermap.org/ Openweathermap]
** Vorschauzeitraum: 5 Tage (zeitliche Auflösung: 3 Stunden)
** Aktuelle Daten (minütlich)
** 1000 Abrufe pro Tag mit dem Gratis-API-Key (Stand: Juni 2021)
* [https://www.wunderground.com/ wunderground]
** API-KEY nur für Gerätebesitzer
* [https://darksky.net/ DarkSky]
** API soll Ende 2022 abgeschaltet werden
** Es können keine neuen API-Key erstellt werden (Stand: Juni 2021)

Da die Yahoo Weather API zum 03.01.2019 abgeschaltet wurde, kann Weather keine Wetterdaten von Yahoo mehr beziehen.

== Unwetterzentrale ==
Informationen der Seite(n) Unwetterzentrale.de können mit Hilfe des Moduls [[UWZ]] eingebunden werden.

== Modul OPENWEATHER ==
Das Modul [[OPENWEATHER]] extrahiert Wetterdaten über die "openweather"-Schnittstelle (API) von www.wetter.com.
*Vorschau-Zeitraum: 3 Tage
*Vorschau-Interval: 6:00, 11:00, 17:00, 23:00
*Aktuelle Daten: keine

== Modul PROPLANTA ==
Das Modul [[PROPLANTA]] extrahiert Wetterdaten von der Website www.proplanta.de. (keine API)
*Vorschau-Zeitraum: 12 Tage
*Vorschau-Interval: 3 h
*Aktuelle Daten: jede volle Stunde

== Modul WWO ==
Das {{Link2CmdRef|Anker=WWO|Label=Modul WWO}} extrahiert Wetterdaten über die (alte) API von worldweatheronline.com
*Vorschau-Zeitraum: ?? Tage<BR>
*Vorschau-Interval: ??<br>
*Aktuelle Daten: ??

== Deutscher Wetterdienst (DWD) ==

=== Modul DWD_OpenData ===
Das Modul [[DWD_OpenData]] stellt einen Teil der frei verfügbaren Daten des Deutschen Wetterdienstes (DWD) bereit, die über den [https://www.dwd.de/DE/leistungen/opendata/opendata.html Open Data Server] abgerufen werden können (diverse Datenformate, keine API).
*Vorschau-Zeitraum: 10 Tage
*Vorschau-Interval: datenabhängig, viele mit 3 h
*Vorschau-Orte: national und international (weniger Daten, z.B. keine Radiation)
*Aktuelle Daten: nicht implementiert
*Wetterwarnungen: national für Deutschland für Landkreise und Gemeinden in deutsch oder englisch

Es gibt zum Modul auch einen Weblink für [[FHEMWEB]], der zwei Icons pro Tag in horizontaler Form darstellt. Die Anzahl der insgesamt dargestellten Icons ist konfigurierbar. Liegen Wetterwarnungen vor, wird zusätzlich ein Warnsymbol angezeigt, über das man per Klick weitere Details zur Wetterwarnung abrufen kann.

[[DWD_OpenData|Weitere Details und Installationsbeschreibung]]

=== Wetterwarnungen als Karte ===
Der Deutsche Wetterdienst [http://www.dwd.de DWD] stellt neben diversen Wetterdaten auch Wetterwarnungen in Bildform bereit. Diese können sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden - das ist zwar nicht die schönste Form, aber die schnellste.

Dazu sucht man sich zuerst auf der [http://www.dwd.de/bvbw/appmanager/bvbw/dwdwwwDesktop?_nfpb=true&_pageLabel=_dwdwww_wetter_warnungen_warnungen&T92053gsbDocumentPath=BEA__Navigation%2FWetter__Warnungen%2FWarnungen.html%3F__nnn%3Dtrue&lastPageLabel=dwdwww_wetter_warnungen Warnungsseite des DWD] die eigene Region heraus (in der Karte durchklicken). Die gewünschte URL für Berlin Stadt ist z.B. <code>http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html#WS_ANCHOR_0</code>. Das Anhängsel <code>#WS_ANCHOR_0</code> kann man in der Konfiguration auch weglassen.

Die Einbindung in FHEM sieht dann wie folgt aus:
<pre>
define dwd_warnmeldung weblink iframe http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html
attr dwd_warnmeldung group Wetterwarnungen (DWD)
attr dwd_warnmeldung htmlattr width="100%" height="300" frameborder="0" marginheight="0" marginwidth="0"
attr dwd_warnmeldung room Wettervorhersage,Startseite
</pre>

== Vorhersage-Diagramm von YR ==
[http://www.yr.no YR] ist die Seite des norwegischen Wetterdiensts. Er ist zwar nur in Teilen auf Englisch (und gar nicht auf Deutsch) verfügbar, bietet aber sehr gute Wettervorhersagen - auch mit eigenen Vorhersagen für kleine Dörfer. Neben etlichen Detailinfos bietet YR eine sehr schicke 48h-Vorhersage-Grafik. Diese kann sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden.

Dazu geht man auf die [http://www.yr.no Startseite von YR] und gibt in das Suchfeld den Namen seines Dörfchens ein - die Ergebnissliste kann ziemlich lang werden, sodass man evtl. sehr genau schauen muss, welches das eigene Kaff ist - bei mir war es an 29. Stelle... ;-) Auf der gewünschten Seite gibt es einen Unterpunkt "Forecast as SVG", wo sich die besagte Grafik findet. Hier kopiert man sich einfach die URL der Grafik.

Die Einbindung in FHEM sieht dann bspw. wie folgt aus:
<pre>
define Wetter_yr_Vorhersage weblink iframe https://www.yr.no/en/content/2-2950159/meteogram.svg
attr Wetter_yr_Vorhersage group Wettervorhersage (yr)
attr Wetter_yr_Vorhersage htmlattr width="782" height="391" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter_yr_Vorhersage room Wettervorhersage,Start
</pre>

== Wetter von Weather Underground ==
{{Randnotiz|RNTyp=r|RNText=Das ("offene") API von Weather Underground wird derzeit (März 2019) "retired" = abgestellt, ist also künftig nicht mehr nutzbar! Den benötigten API-Key bekommen "nur noch" Betreiber einer Wetterstation, die diese bei wundergound registrieren und ihre Daten hochladen.}}
'''Hinweis:''' Die hier beschriebene Vorgehensweise ist etwas anspruchsvoller und somit eher für erfahrene FHEM-User geeignet.

[http://www.wunderground.com/ Weather Underground] bietet eine sehr umfassende Sammlung aller möglichen offiziellen und privaten (aber teils sehr professionellen) Wetterstationen weltweit. Es besteht eine recht hohe Wahrscheinlichkeit, dass es in der eigenen Umgebung schon eine Wetterstation gibt. Anstatt nun selbst eine komplette Wetterstation aufzubauen, kann man alternativ auf die Daten der Nachbarstation zugreifen.

{{Randnotiz|RNTyp=y|RNText=Neben dem hier vorgestellten Abruf der Weather Underground-Daten mit [[HTTPMOD]] kann auf Weather Underground-Daten auch mit dem darauf spezialisierten Modul [http://fhem.de/commandref.html#Wunderground Wunderground] zugegriffen werden.}}

Dazu sind grundsätzlich die folgenden Schritte notwendig:
* Finden der geeigneten Station
* Auswerten der XML-Daten
* Erstellen passender gplot-Dateien

=== Finden der geeigneten Station ===
Als erstes geht man auf die [http://www.wunderground.com Startseite von Weather Underground] und gibt in das Suchfeld den Namen seines Dörfchens oder der nächsten Stadt ein - für Berlin landet man bspw. auf Seite für "Berlin Alexanderplatz". Es gibt aber manchmal sehr viele Wetterstationen in der direkten Umgebung. Diese findet man indem am auf "Change Station" klickt und sich eine passende Station aussucht. Nähere Infos (zB. zur verwendeten Hard- und Software) zu der gewählten Wetterstation erhält man, wenn man auf den Namen der Station klickt und dann auf "About this PWS".

Weather Underground stellt die Daten der Wetterstation auch über eine API als XML bereit, die wir auswerten können. Die entsprechende URL findet sich ebenfalls unter "About this PWS" unter "Download current conditions XML". Für Berlin Prenzlauer Berg wäre dies z.B.
<code>http://api.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&format=XML</code>.

Entscheidend für die jeweilige Station ist der Teil nach "?=ID", also in diesem Fall "IBERLIN15". Dieser Teil des Links lässt sich leicht durch die ID einer anderen Station ersetzen und die Suche nach dem entsprechenden Link auf der Seite der Station bleibt erspart.

=== Auswerten der XML-Daten ===
Die Auswertung der XML-Daten erfolgt via [[HTTPMOD]]. Da dies nicht ganz trivial ist, sind im Folgenden zuerst die wesentlichen Konfigurationsschritte exemplarisch beschrieben. Weiter unten findet sich dann die fertige vollständige Konfiguration.

Es erstes wird das Device HTTPMOD definiert (die 600 am Schluss ist der Aktualisierungszyklus in Sekunden, also alle 10 min):
:<code>define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600 </code>

Dann werden Attribute für alle Readings definiert:
:<code>attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date ... </code>

Dann wird jedem Attribut ein Name zugewiesen (unter diesem Namen wird der Wert ins Log geschrieben):
:<code>attr wetter_prenzelberg readingsName_cloudiness cloudiness </code>

Zum Schluss wird das Reading selbst definiert:
:<code>attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+) </code>

Die gesamte Konfiguration für alle von der API angebotenen Wetterwerte sieht dann wie folgt aus:
<pre>
define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600
attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date readingsName_dewpointTemperature readingsName_fog readingsName_heatindex readingsName_humidity readingsName_pressure readingsName_solarRadiation readingsName_solarUV readingsName_temperature readingsName_time readingsName_windChill readingsName_windDegrees readingsName_windDirection readingsName_windGust readingsName_windSpeed readingsRegex_cloudiness readingsRegex_date readingsRegex_dewpointTemperature readingsRegex_fog readingsRegex_heatindex readingsRegex_humidity readingsRegex_pressure readingsRegex_solarRadiation readingsRegex_solarUV readingsRegex_temperature readingsRegex_time readingsRegex_windChill readingsRegex_windDegrees readingsRegex_windDirection readingsRegex_windGust readingsRegex_windSpeed
attr wetter_prenzelberg readingsName_cloudiness cloudiness
attr wetter_prenzelberg readingsName_date date
attr wetter_prenzelberg readingsName_dewpointTemperature dewpointTemperature
attr wetter_prenzelberg readingsName_fog fog
attr wetter_prenzelberg readingsName_heatindex heatindex
attr wetter_prenzelberg readingsName_humidity humidity
attr wetter_prenzelberg readingsName_pressure pressure
attr wetter_prenzelberg readingsName_solarRadiation solarRadiation
attr wetter_prenzelberg readingsName_solarUV solarUV
attr wetter_prenzelberg readingsName_temperature temperature
attr wetter_prenzelberg readingsName_time time
attr wetter_prenzelberg readingsName_windChill windChill
attr wetter_prenzelberg readingsName_windDegrees windDegrees
attr wetter_prenzelberg readingsName_windDirection windDirection
attr wetter_prenzelberg readingsName_windGust windGust
attr wetter_prenzelberg readingsName_windSpeed windSpeed
attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_date date date" content="([\d\.]+)
attr wetter_prenzelberg readingsRegex_dewpointTemperature <dewpoint_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_fog fog id="FOG" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_heatindex <heat_index_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_humidity <relative_humidity>([\d\.]+)
attr wetter_prenzelberg readingsRegex_pressure <pressure_mb>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarRadiation <solar_radiation>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarUV <UV>([\d\.]+)
attr wetter_prenzelberg readingsRegex_temperature <temp_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_time time Zeit([\d\:]+)
attr wetter_prenzelberg readingsRegex_windChill <windchill_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_windDegrees <wind_degrees>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windDirection <wind_dir>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windGust <wind_gust_mph>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windSpeed <wind_mph>([\d\.]+)
</pre>
Hinweis: Nicht immer werden alle Werte geliefert (wenn keine Sonne, dann kein UV-Wert...). Im System-Log kann das als Fehler auftauchen, ist aber kein Problem.

=== Erstellen passender gplot-Dateien ===
Um die ausgelesenen Werte als Graphen darstellen zu können müssen eigene gplot-Dateien erstellt werden. Eine grundsätzliche Anleitung dazu findet sich unter [[Creating Plots]]. Deshalb sollen hier nur Beispiele für die eigentlichen gplot-Dateien vorgestellt werden. Beispiele sollten sowohl für [[FileLog]] wie [[DbLog]] funktionieren.

Temperatur und Luftfeuchte:
<pre>
set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
#set title '<L1>'
set title ''
set ytics
set y2tics
set grid ytics
set ylabel "Temperature in C"
set y2label "Humidity (%)"

#FileLog 4:temperature\x3a::
#FileLog 4:windChill\x3a::
#FileLog 4:humidity\x3a::

#DbLog <SPEC1>:temperature::
#DbLog <SPEC1>:windChill::
#DbLog <SPEC1>:humidity::

plot "<IN>" using 1:2 axes x1y1 title 'Temperatur (C)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Gefühlte Temperatur (C)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Luftfeuchtigkeit (%)' ls l2fill lw 0.2 with lines
</pre>

Wind und Windrichtung:
<pre>
set terminal png transparent size <SIZE> crop

set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "

set ytics
set y2tics ("Nord" 0, "Ost" 80, "Süd" 180, "West" 270, "Nord" 360)

#set title '<L1>'
set title ''

set grid xtics ytics

set yrange [0:20]
set y2range [0:360]

set ylabel "Wind (mph)"
set y2label "Richtung"

#FileLog 4:windSpeed:0:
#FileLog 4:windGust:0:
#FileLog 4:windDegrees:0:

#DbLog <SPEC1>:windSpeed::
#DbLog <SPEC1>:windGust::
#DbLog <SPEC1>:windDegrees::

plot "<IN>" using 1:2 axes x1y1 title 'Wind (mph)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Böen (mph)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Windrichtung (°)' ls l2fill lw 0.2 with points
</pre>

Sonnenintensität und UV-Werte:
<pre>
set terminal png transparent size <SIZE> crop

set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "

set ytics
set y2tics

#set title '<L1>'
set title ''

set grid xtics ytics

set ylabel "Sonnenstrahlung (W/qm)"
set y2label "UV"

#FileLog 4:solarRadiation:0:
#FileLog 4:solarUV:0:

#DbLog <SPEC1>:solarRadiation::
#DbLog <SPEC1>:solarUV::

plot "<IN>" using 1:2 axes x1y1 title 'Strahlung' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'UV' ls l1 lw 1.5 with lines
</pre>

'''Weitere TBD'''

=== Vergangene Daten abfragen ===
Ein konkretes vergangenes Datum der Wetterstation kann man übrigens auch abrufen - für den 28.11.2014 wäre dies bspw.
<code>http://www.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&day=28&month=11&year=2014&graphspan=day&format=1</code>.

=== Eigene Wetterdaten hochladen ===
{{Randnotiz|RNTyp=g|RNText=Unterstützung für das Modul gibt es im dazugehörigen {{Link2Forum|Topic=65587|LinkText=Forumsthread }}.}}
Wer eigene Wetterdaten hochladen will, kann hierzu das {{Link2CmdRef|Anker=WUup|Label=Modul WUup}} verwenden. Dazu benötigt man die Zugangsdaten (stationID und Paßwort) für eine eigene Wetterstation. Mit dem Modul können die meisten vom [http://web.archive.org/web/20180815041359/http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol PWS Upload Protocol] unterstützten Daten hochgeladen werden:
* Winddir - [0-360 momentane Windrichtung]
* Windspeedmph - [mph momentane Windgeschwindigkeit]
* Windgustmph - [mph aktuellen Böe, mit Software-spezifischem Zeitraum]
* Windgustdir - [0-360 mit Software-spezifischer Zeit]
* Windspdmph_avg2m - [mph durchschnittliche Windgeschwindigkeit innerhalb 2 Minuten]
* Winddir_avg2m - [0-360 durchschnittliche Windrichtung innerhalb 2 Minuten]
* Windgustmph_10m - [mph Böen der vergangenen 10 Minuten]
* Windgustdir_10m - [0-360 Richtung der Böen der letzten 10 Minuten]
* Feuchtigkeit - [% Außenfeuchtigkeit 0-100%]
* Dewptf- [F Taupunkt im Freien]
* Tempf - [F Außentemperatur]
* Rainin - [in Regen in der vergangenen Stunde]
* Dailyrainin - [in Regenmenge bisher heute]
* Baromin - [inHg barometrischer Druck]
* Soiltempf - [F Bodentemperatur]
* Bodenfeuchtigkeit - [%]
* Solarradiation - [W/m²]
* UV - [Index]
* AqPM2.5 - Feinstaub PM2,5 [µg/m³]
* AqPM10 - Feinstaub PM10 [µg/m³]

Die Werte werden im Modul für Wunderground ins anglo-amerikanische System umgerechnet. Temperaturen werden also automatisch von °Celsius in Fahrenheit, Windgeschwindigkeiten von km/h in mph, mm in Inch und der barometrische Druck von hPa in inHg umgerechnet.

== Wetternetzwerk auf wetter.com ==
Ein vollständiges Beispiel zur Nutzung der Informationen über die Regenmenge (Station 1445, Weinheim) von wetter.com ist in {{Link2Forum|Topic=39600|Message=332837|LinkText=diesem Forenbeitrag}} beschrieben.

== Wetter von netatmo ==
Das FHEM-Modul [[netatmo]] ermöglicht den Datenimport von privaten und öffentlichen netatmo Wetterstationen sowie den Abruf der in der Netatmo App verfügbaren Wettervorhersage. Eine Übersicht über die verfügbaren öffentlichen Stationen findet sich auf der Seite [http://www.netatmo.com/de-DE/weathermap Weathermap]. Die meisten öffentlichen Stationen liefern Temperatur, Luftfeuchte und Luftdruck, einige auch Wind, Regen und Daten zur Luftqualität (CO<sub>2</sub>).

== Links ==
* {{Link2Forum|Topic=33610|LinkText=Forenthema}} mit Sammlung und Beipielen von Internet-Links für die Anzeige von teilweise animierten Wetterbildern
* [http://bloglich.de/art/rpi/wetterdaten-auf-dem-raspberry-pi-in-fhem/ Beispiel in Blog(de)]
* [[HTTPMOD]]

[[Kategorie:Code Snippets]]
[[Kategorie:HOWTOS]]
[[Kategorie:Wetterstationen]]

Sonos2mqtt

2023-01-06T13:03:23Z

50watt: Formatierung

== Grundeinrichtung ==
Die Grundeinrichtung ist bereits im Artikel [[MQTT2-Module - Praxisbeispiele#Sonos2Mqtt|MQTT2-Module - Praxisbeispiele]] beschrieben. Hier soll es um die praktische Verwendung und Erweiterung gehen.

Für alle Erweiterungen wird versucht vorhandene Devices in FHEM zu verwenden.

Viele Dinge werden derzeit noch entwickelt und können frei gestaltet werden - der Vorteil von generischen FHEM Devices.

== Tipps zur Verwendung ==
Die automatische Konfiguration setzt den alias entsprechend dem im Sonos vergeben Namen . Die langen MQTT2_RINCON_ Namen sind unhandlich und schlecht lesbar. Man kann Player mit einem devspec ansprechen, das simpelste ist:
:<code>set alias=Büro play</code>
Oder alle Player
:<code>set model=sonos2mqtt_speaker leaveGroup</code>

== Konfiguration der Player ==
Mit dem Template sonos_bridge_comfort wird aus dem contrib Ordner eine Datei 99_sonos2mqttUtils.pm nachgeladen und aktiviert. Darin befindet sich der wesentliche Code, die sonos2mqtt Geräte selbst enthalten nur rudimentäre Aufrufe.

Selbstverständlich kann man diese Datei jederzeit selbst gestalten (FHEM Menu:Edit Files) aber man sollte beachten, dass eine erneute Anwendung des Templates die Datei überschreibt.

Man kann auch jederzeit diese Datei aus dem SVN neu laden:
<syntaxhighlight lang="perl">
{ Svn_GetFile("contrib/AttrTemplate/99_sonos2mqttUtils.pm", "FHEM/99_sonos2mqttUtils.pm", sub(){ CommandReload(undef, "99_sonos2mqttUtils") }) }
</syntaxhighlight>Hauptroutine ist sonos2mqtt die mit zwei Parametern aufgerufen wird. <code>{sonos2mqtt($NAME,$EVENT)}</code>

Die Optik des Players wird mit der Routine <code>sonos2mqtt_devStateIcon</code> bestimmt.

Man kann die Player mittels <code>attr a:model=sonos2mqtt_speaker webCmd volume</code> mit einem Slider in der Übersicht ausstatten.

Ändert man die Sonoslandschaft, kann man auch alles einreißen und neu erzeugen lassen. Zunächst alles löschen (für die FHEM Kommandozeile):<syntaxhighlight lang="perl">
{fhem("delete a:model=sonos2mqtt_speaker;;delete FileLog_MQTT2_RINCON.*");;qx(rm ./log/MQTT2_RINCON_*);;return ""}
</syntaxhighlight>Danach muss man sonos2mqtt einfach neu starten: pm2 start ... bzw den docker container neu starten.

== Befehle nachrüsten ==
Um Befehle in der setList / getList / readingList nachzurüsten gibt es die Routine <code>sonos2mqtt_mod_list(devspec,attrName,line)</code>

Vorhandenen Zeilen werden ersetzt. Identifiziert wird nur der erste Teil bis zum ":". Beispiel für die Komandozeile:

<code>{sonos2mqtt_mod_list('a:model=sonos2mqtt_bridge','readingList','sonos/RINCON_([0-9A-Z]+)/Reply:.* Reply')}</code>

== Sprachausgabe ==
Man hat zwei Möglichkeiten, dies umzusetzen:
# Text2Speech FHEM intern
# Mit dem sonos text to speech Server https://svrooij.io/sonos2mqtt/

=== Text2Speech Variante einrichten ===
Zwei zusätzliche Geräte sind notwendig:
* [[Text2Speech]] im Servermodus, erzeugt mp3 Dateien im cache Verzeichnis und legt einen Link im Reading httpName ab.
* Ein HTTP Server stellt die Dateien im gleichen Verzeichnis bereit
'''Hinweis''': Für die vollständige Funktion und Installation von Text2Speech ist die Commandref zu beachten! Für das unten im Beispiel verwendete Feature UseMP3Wrap muss das Tool mp3wrap installiert werden (z.B. <code>apt install mp3wrap</code>). Dies ist bei längeren Texten und bei der Verwendung von eingebetteten festen Sounds existenziell!

Für die Funktion ist wichtig, dass das Sonos System den Host im Link zur Datei richtig auflösen kann. Deshalb wird der Hostname und Port des Servers im Reading host des TTS Device als Name oder IP Adresse abgelegt! Dies kann entweder mit dem hier gezeigten Befehl oder vollständig manuell erfolgen. Für FHEM innerhalb Docker muss man die Adresse des Docker Host angeben.
<syntaxhighlight lang="perl">
defmod SonosTTS Text2Speech none
attr SonosTTS TTS_UseMP3Wrap 1
attr SonosTTS TTS_Language Deutsch
attr SonosTTS userReadings httpName:lastFilename.* {'http://'.ReadingsVal($name,'host','set host:port first').'/fhem/'.ReadingsVal($name,'lastFilename','')}
attr SonosTTS TTS_CacheFileDir cache
setreading SonosTTS host {(qx(hostname -s|tr -d '\n').':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host {((split(' ', qx(hostname -I)))[0].':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host <hostname>:<port>

defmod SonosSpeakWeb HTTPSRV cache cache SonosSpeakWeb
</syntaxhighlight>
Der Sprachausgabe Befehle im Player Device läuft in 3 Schritten:
# mit dem TTS Gerät wird die mp3 Datei erzeugt,
# mit dem sleep wird auf die Fertigstellung gewartet,
# die Datei wird mit <code>set Player notify volume uri</code> abgespielt.
Durch den "sonos2mqtt notify" Befehl wird die laufende Umgebung wiederhergestellt.
* Wird der Sprachbefehl an den Gruppenmaster gesendet wird die mp3 Datei in der gesamten Gruppe gespielt.
* Wird der Sprachbefehl an ein Mitglied einer Gruppe gesendet (nicht den Master) wird die Gruppe aufgetrennt und später wieder hergestellt.
Es sind zwei Befehle zur Sprachausgabe eingebaut:

=== sayText Befehl ===
Dieser Befehl orientiert sich an den FHEM [[DevelopmentGuidelinesAV|DevelopmentGuidelines]] und sammelt "gleichzeitig" eintreffende Sprachnachrichten, damit nichts verloren geht. Informationen im Forum dazu in {{Link2Forum|Topic=111711|Message=1100112|LinkText=diesem Beitrag}}.

Die Lautstärke wird separat in SonosTTS gesetzt: <code>setreading SonosTTS vol 15</code>, ebenso die Sprache (einmalig bei der Einrichtung oder bei Bedarf zwischendurch) <code>attr SonosTTS TTS_Language Deutsch</code>

''Hinweis: Der Befehl <code>set SonosTTS volume xx</code> hat im Servermodus des Devices keine Wirkung!''
=== Speak Befehl ===
Dieser Befehl ist ähnlich wie der in der FHEM-Sonos Umgebung:
:<code>set Player speak <volume> text</code>

Verwendet man diesen Syntax (mit Sprache und Stimme am Anfang), wird automatisch der speak Befehl an die sonos-tts abgesetzt. Die sonos-tts muss man separat installieren/integrieren!

<code>set EG.KU.Sonos speak de-DE Vicki 25 Test</code>

Will man keine laufenden Sendung unterbrechen sondern einfach eine Ansage machen und danach etwas starten, kann man so vorgehen:
<syntaxhighlight lang="perl">
set SonosTTS tts Hier steht die Ansage;sleep SonosTTS:playing:.0 ; set alias=PlayerAlias playUri [SonosTTS:httpName]
</syntaxhighlight>

=== Volume Befehl ===
Der Befehl akzeptiert einen zweiten Wert als Startwert d.h. set volume 25 10 setzt sofort auf 10 und startet dann fading auf 25. Ein zweiter Wert -1 erzeugt ein fading vom aktuellen Wert auf den angegebenen.

==== Spiele feste Sounds ====
Generell kann man feste mp3 Dateien (Klingeltöne, Klänge usw.) auch im cache Verzeichnis ablegen und direkt mit dem Link starten.

Es gibt zahlreiche Soundquellen im Internet, ist der gewünschte Sound dabei, kann man ihn innerhalb FHEM herunterladen und an Ort und Stelle platzieren. (Beispiel ohne und mit Umbennung)
<syntaxhighlight lang="perl">
"wget -qP ./cache https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"
"wget -qO ./cache/KlingelTon.mp3 https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"
</syntaxhighlight>
Vergewissern ob der gewünschte Sound auch da ist: {qx(ls -lha ./cache)}

Mit set magic kann man dabei einfach Teile aus anderen Readings holen.
<syntaxhighlight lang="perl">
set alias=Büro notify 25 {('http://[SonosTTS:host]/fhem/cache/KlingelTon.mp3')}
</syntaxhighlight>
Man kann auch den setter im Gerät erweitern <code>{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList',q(playSound:textField ....))}</code> :
<syntaxhighlight lang="perl">
playSound:textField {my $tts="SonosTTS";my ($cmd,$vol,$file)=split(' ', $EVENT,3);$file=($file=~m/.*\.mp3$/)?"$file":"$file.mp3";fhem("set $NAME notify $vol http://[$tts:host]/fhem/[a:$tts:TTS_CacheFileDir]/$file")}
</syntaxhighlight>
Damit sind dann dieser Syntax möglich:
<syntaxhighlight lang="perl">
set alias=Büro playSound 40 KlingelTon.mp3
</syntaxhighlight>
oder ohne Dateiendung (wird auf mp3 gesetzt)
<syntaxhighlight lang="perl">
set alias=Büro playSound 40 KlingelTon
</syntaxhighlight>

=== SonosBridge ===
Die SonsoBridge enthält bereits ein paar zentrale Funktionen und Readings, z.B. wird beim Laden der Favoritenliste ein Reading favlist und grouplist erzeugt, welches zur Erweiterung der Player mit Auswahllisten dienen kann.

=== Player mit Favoritenliste und Gruppenliste ausstatten ===
Wenn nicht schon geschehen muss man jetzt die Favoriten zum ersten Mal einlesen: <syntaxhighlight lang="perl">
get SonosBridge Favorites
</syntaxhighlight>Nachdem die SonosBridge "aufgerüstet" ist, kann man allen Playern die Favoritenliste zum Auswählen eintragen. Beide Zeile sind für die FHEM Kommandozeile und verwenden die Routine aus der 99_sonos2mqttUtils.
<syntaxhighlight lang="perl">
{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','joinGroup:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'grouplist','').q( {sonos2mqtt($NAME,$EVENT)}))}
{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','playFav:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'favlist','').q( {sonos2mqtt($NAME,$EVENT)}))}
</syntaxhighlight>
Man kann den playFav Befehl auch im set Befehl mit einem Teil des Favoriten Namen verwenden. Enthält die Favoritenliste z.B. Radio Leipzig würde der auch mit diesem Befehl angesteuert werden:<syntaxhighlight lang="perl">
set alias=Bad playFav leipzig
</syntaxhighlight>

=== Listen der Favoriten Radios und Playlist erstellen ===
Im Sonos System kann man an (mindestens) drei Stellen Favoriten hinterlegen: Sonos-Favoriten, Sonos-Playlisten, TuneIn: Meine Radiosender

Diese drei Listen kann man einlesen und für die einfache Suche und Auswahl verwenden. Der play Befehl akzeptiert dazu zwei weitere Parameter und sucht in den entsprechenden Listen.

Diese play Befehle starten nicht sofort, sondern erst nach einem folgenden set ... play. Damit kann man etwas vorbereiten und gezielt starten.

<code>set alias=Büro play Favorite Deutschlandfunk</code>

<code>set alias=Büro play Radio HitRadio</code>

<code>set alias=Büro play Playlist Meine Hits</code>

Die Sonos-Favoriten-, TuneIn: Meine Radiosender- und Sonos-Playlisten dazu vom Sonos System einmalig (bzw. bei Veränderungen) einlesen:
<pre>
get SonosBridge Reply Playlists;sleep SonosBridge:Reply.*;setreading SonosBridge Playlists [SonosBridge:Reply]
get SonosBridge Reply Favorites;sleep SonosBridge:Reply.*;setreading SonosBridge Favorites [SonosBridge:Reply]
get SonosBridge Reply Radios;sleep SonosBridge:Reply.*;setreading SonosBridge Radios [SonosBridge:Reply]
</pre>

Beispiel für ein Guten Morgen Radio:
<pre>
set alias=BadWanne,alias=Kueche joinGroup Bad;
set alias=BadWanne,alias=Bad volume 13 6;
set alias=Bad play Favorite Deutschlandfunk.Kultur.RP;
set alias=Kueche volume 18 8;
sleep 0.2;set alias=Bad play
</pre>

=== Radioliste durchtasten ===
Will man eine Liste von bestimmten Radiostation mit einem Taster "durchtasten" kann man das wie folgt tun:

Das oben erwähnte <code>99_sonos2mqttUtils.pm</code> (ab 6.1.2023) schreibt die Radios aus dem Reading <code>Favoriten</code> in das userReading <code>favlist</code> im SonosBridge Device und aktualisiert das auch.

==== Der Befehl zum weiterschalten ====
Jedes Mal wenn dieser Befehl ausgeführt wird, wird der nächste "Radio-Favorit" (aus dem userReading <code>favlist</code> des SonosBridge Devices) gestartet.

Wird eine Radiosender gespielt wird bei einem <code>set ''sonos2mqtt_speaker'' next</code> auf den nächsten Sender in dieser Liste geschaltet und der <code>transportState</code> wird beibehalten.

==== Name der Radiostation vor dem Umschalten ansagen ====
Will man vor dem Radiostart noch die Ansage des Senders haben, geht das zwar auch mit dem <code>speak</code> Befehl, die direkte Ausgabe ohne Restore der Umgebung (sonos2mqtt notify) ist aber effektiver.

Damit das funktioniert müssen wir die Events einschränken:
<syntaxhighlight lang="perl">
attr model=sonos2mqtt_speaker event-on-change-reading .*
{my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];;my $r=Each($dev,ReadingsVal($dev,'favlist',''));;my $play = (devspec2array('alias=Büro'))[0];;my $tts="SonosTTS";;fhem("set $tts tts Es folgt $r;;sleep $tts:playing:.0;;set $play playUri [$tts:httpName];;sleep $play:play;;sleep $play:PLAYING;;sleep $play:STOPPED;;set $play playFav $r")}
</syntaxhighlight>
Kurze Erklärung zum Code
* ermittelt den nächsten Radiosender in der Liste: <code>my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];;my $r=Each($dev,ReadingsVal($dev,'favlist',<nowiki>''</nowiki>))</code>
* ermitteln des Namens des <code>''sonos2mqtt_speaker''</code> Devices anhand des <code>alias</code> Attributes: <code>my $play = (devspec2array('alias=Büro'))[0]</code>
* erzeugt die Ansage "Es folgt SenderXY": <code>my $tts="SonosTTS";;fhem("set $tts tts Es folgt $r</code>
* wenn die mp3 Datei fertig erzeugt ist: <code>sleep $tts:playing:.0</code>, wird sie mit dem Befehl playUri an den oben ermittelten <code>''sonos2mqtt_speaker''</code> gesendet: <code>set $play playUri [$tts:httpName]</code>
* es wird eine Eventfolge abgewartet -> play / PLAYING / STOPPED: <code>sleep $play:play;;sleep $play:PLAYING;;sleep $play:STOPPED</code>
* danach wird der Radiosender gestartet: <code>set $play playFav $r</code>
Der Code ist so einfach und relativ "steif" für die Kommandozeile. Man kann das auch in einen Setter packen (<code>set ''sonos2mqtt_speaker'' toggleRadio</code>). Dazu den Text unten in das Attribut <code>setList</code> des <code>''sonos2mqtt_speaker''</code> Devices hinzufügen:
<syntaxhighlight lang="perl">
toggleRadio:noArg {my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];my $r=Each($dev,ReadingsVal($dev,'favlist',''));my $tts="SonosTTS";fhem("set $tts tts Es folgt $r;sleep $tts:playing:.0;set $NAME playUri [$tts:httpName];sleep $NAME:play;sleep $NAME:PLAYING;sleep $NAME:STOPPED;set $NAME playFav $r")}
</syntaxhighlight>

== Dokumentationen und weitere Entwicklungen ==
ToDo

Erweiterung um Alarmhandling siehe [https://forum.fhem.de/index.php/topic,111711.msg1162031.html#msg1162031 Forum]

[[Kategorie:MQTT]]

Sonos2mqtt

2023-01-06T12:59:20Z

50watt: "Erklärung zum Code" ausgebaut

== Grundeinrichtung ==
Die Grundeinrichtung ist bereits im Artikel [[MQTT2-Module - Praxisbeispiele#Sonos2Mqtt|MQTT2-Module - Praxisbeispiele]] beschrieben. Hier soll es um die praktische Verwendung und Erweiterung gehen.

Für alle Erweiterungen wird versucht vorhandene Devices in FHEM zu verwenden.

Viele Dinge werden derzeit noch entwickelt und können frei gestaltet werden - der Vorteil von generischen FHEM Devices.

== Tipps zur Verwendung ==
Die automatische Konfiguration setzt den alias entsprechend dem im Sonos vergeben Namen . Die langen MQTT2_RINCON_ Namen sind unhandlich und schlecht lesbar. Man kann Player mit einem devspec ansprechen, das simpelste ist:
:<code>set alias=Büro play</code>
Oder alle Player
:<code>set model=sonos2mqtt_speaker leaveGroup</code>

== Konfiguration der Player ==
Mit dem Template sonos_bridge_comfort wird aus dem contrib Ordner eine Datei 99_sonos2mqttUtils.pm nachgeladen und aktiviert. Darin befindet sich der wesentliche Code, die sonos2mqtt Geräte selbst enthalten nur rudimentäre Aufrufe.

Selbstverständlich kann man diese Datei jederzeit selbst gestalten (FHEM Menu:Edit Files) aber man sollte beachten, dass eine erneute Anwendung des Templates die Datei überschreibt.

Man kann auch jederzeit diese Datei aus dem SVN neu laden:
<syntaxhighlight lang="perl">
{ Svn_GetFile("contrib/AttrTemplate/99_sonos2mqttUtils.pm", "FHEM/99_sonos2mqttUtils.pm", sub(){ CommandReload(undef, "99_sonos2mqttUtils") }) }
</syntaxhighlight>Hauptroutine ist sonos2mqtt die mit zwei Parametern aufgerufen wird. <code>{sonos2mqtt($NAME,$EVENT)}</code>

Die Optik des Players wird mit der Routine <code>sonos2mqtt_devStateIcon</code> bestimmt.

Man kann die Player mittels <code>attr a:model=sonos2mqtt_speaker webCmd volume</code> mit einem Slider in der Übersicht ausstatten.

Ändert man die Sonoslandschaft, kann man auch alles einreißen und neu erzeugen lassen. Zunächst alles löschen (für die FHEM Kommandozeile):<syntaxhighlight lang="perl">
{fhem("delete a:model=sonos2mqtt_speaker;;delete FileLog_MQTT2_RINCON.*");;qx(rm ./log/MQTT2_RINCON_*);;return ""}
</syntaxhighlight>Danach muss man sonos2mqtt einfach neu starten: pm2 start ... bzw den docker container neu starten.

== Befehle nachrüsten ==
Um Befehle in der setList / getList / readingList nachzurüsten gibt es die Routine <code>sonos2mqtt_mod_list(devspec,attrName,line)</code>

Vorhandenen Zeilen werden ersetzt. Identifiziert wird nur der erste Teil bis zum ":". Beispiel für die Komandozeile:

<code>{sonos2mqtt_mod_list('a:model=sonos2mqtt_bridge','readingList','sonos/RINCON_([0-9A-Z]+)/Reply:.* Reply')}</code>

== Sprachausgabe ==
Man hat zwei Möglichkeiten, dies umzusetzen:
# Text2Speech FHEM intern
# Mit dem sonos text to speech Server https://svrooij.io/sonos2mqtt/

=== Text2Speech Variante einrichten ===
Zwei zusätzliche Geräte sind notwendig:
* [[Text2Speech]] im Servermodus, erzeugt mp3 Dateien im cache Verzeichnis und legt einen Link im Reading httpName ab.
* Ein HTTP Server stellt die Dateien im gleichen Verzeichnis bereit
'''Hinweis''': Für die vollständige Funktion und Installation von Text2Speech ist die Commandref zu beachten! Für das unten im Beispiel verwendete Feature UseMP3Wrap muss das Tool mp3wrap installiert werden (z.B. <code>apt install mp3wrap</code>). Dies ist bei längeren Texten und bei der Verwendung von eingebetteten festen Sounds existenziell!

Für die Funktion ist wichtig, dass das Sonos System den Host im Link zur Datei richtig auflösen kann. Deshalb wird der Hostname und Port des Servers im Reading host des TTS Device als Name oder IP Adresse abgelegt! Dies kann entweder mit dem hier gezeigten Befehl oder vollständig manuell erfolgen. Für FHEM innerhalb Docker muss man die Adresse des Docker Host angeben.
<syntaxhighlight lang="perl">
defmod SonosTTS Text2Speech none
attr SonosTTS TTS_UseMP3Wrap 1
attr SonosTTS TTS_Language Deutsch
attr SonosTTS userReadings httpName:lastFilename.* {'http://'.ReadingsVal($name,'host','set host:port first').'/fhem/'.ReadingsVal($name,'lastFilename','')}
attr SonosTTS TTS_CacheFileDir cache
setreading SonosTTS host {(qx(hostname -s|tr -d '\n').':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host {((split(' ', qx(hostname -I)))[0].':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host <hostname>:<port>

defmod SonosSpeakWeb HTTPSRV cache cache SonosSpeakWeb
</syntaxhighlight>
Der Sprachausgabe Befehle im Player Device läuft in 3 Schritten:
# mit dem TTS Gerät wird die mp3 Datei erzeugt,
# mit dem sleep wird auf die Fertigstellung gewartet,
# die Datei wird mit <code>set Player notify volume uri</code> abgespielt.
Durch den "sonos2mqtt notify" Befehl wird die laufende Umgebung wiederhergestellt.
* Wird der Sprachbefehl an den Gruppenmaster gesendet wird die mp3 Datei in der gesamten Gruppe gespielt.
* Wird der Sprachbefehl an ein Mitglied einer Gruppe gesendet (nicht den Master) wird die Gruppe aufgetrennt und später wieder hergestellt.
Es sind zwei Befehle zur Sprachausgabe eingebaut:

=== sayText Befehl ===
Dieser Befehl orientiert sich an den FHEM [[DevelopmentGuidelinesAV|DevelopmentGuidelines]] und sammelt "gleichzeitig" eintreffende Sprachnachrichten, damit nichts verloren geht. Informationen im Forum dazu in {{Link2Forum|Topic=111711|Message=1100112|LinkText=diesem Beitrag}}.

Die Lautstärke wird separat in SonosTTS gesetzt: <code>setreading SonosTTS vol 15</code>, ebenso die Sprache (einmalig bei der Einrichtung oder bei Bedarf zwischendurch) <code>attr SonosTTS TTS_Language Deutsch</code>

''Hinweis: Der Befehl <code>set SonosTTS volume xx</code> hat im Servermodus des Devices keine Wirkung!''
=== Speak Befehl ===
Dieser Befehl ist ähnlich wie der in der FHEM-Sonos Umgebung:
:<code>set Player speak <volume> text</code>

Verwendet man diesen Syntax (mit Sprache und Stimme am Anfang), wird automatisch der speak Befehl an die sonos-tts abgesetzt. Die sonos-tts muss man separat installieren/integrieren!

<code>set EG.KU.Sonos speak de-DE Vicki 25 Test</code>

Will man keine laufenden Sendung unterbrechen sondern einfach eine Ansage machen und danach etwas starten, kann man so vorgehen:
<syntaxhighlight lang="perl">
set SonosTTS tts Hier steht die Ansage;sleep SonosTTS:playing:.0 ; set alias=PlayerAlias playUri [SonosTTS:httpName]
</syntaxhighlight>

=== Volume Befehl ===
Der Befehl akzeptiert einen zweiten Wert als Startwert d.h. set volume 25 10 setzt sofort auf 10 und startet dann fading auf 25. Ein zweiter Wert -1 erzeugt ein fading vom aktuellen Wert auf den angegebenen.

==== Spiele feste Sounds ====
Generell kann man feste mp3 Dateien (Klingeltöne, Klänge usw.) auch im cache Verzeichnis ablegen und direkt mit dem Link starten.

Es gibt zahlreiche Soundquellen im Internet, ist der gewünschte Sound dabei, kann man ihn innerhalb FHEM herunterladen und an Ort und Stelle platzieren. (Beispiel ohne und mit Umbennung)
<syntaxhighlight lang="perl">
"wget -qP ./cache https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"
"wget -qO ./cache/KlingelTon.mp3 https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"
</syntaxhighlight>
Vergewissern ob der gewünschte Sound auch da ist: {qx(ls -lha ./cache)}

Mit set magic kann man dabei einfach Teile aus anderen Readings holen.
<syntaxhighlight lang="perl">
set alias=Büro notify 25 {('http://[SonosTTS:host]/fhem/cache/KlingelTon.mp3')}
</syntaxhighlight>
Man kann auch den setter im Gerät erweitern <code>{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList',q(playSound:textField ....))}</code> :
<syntaxhighlight lang="perl">
playSound:textField {my $tts="SonosTTS";my ($cmd,$vol,$file)=split(' ', $EVENT,3);$file=($file=~m/.*\.mp3$/)?"$file":"$file.mp3";fhem("set $NAME notify $vol http://[$tts:host]/fhem/[a:$tts:TTS_CacheFileDir]/$file")}
</syntaxhighlight>
Damit sind dann dieser Syntax möglich:
<syntaxhighlight lang="perl">
set alias=Büro playSound 40 KlingelTon.mp3
</syntaxhighlight>
oder ohne Dateiendung (wird auf mp3 gesetzt)
<syntaxhighlight lang="perl">
set alias=Büro playSound 40 KlingelTon
</syntaxhighlight>

=== SonosBridge ===
Die SonsoBridge enthält bereits ein paar zentrale Funktionen und Readings, z.B. wird beim Laden der Favoritenliste ein Reading favlist und grouplist erzeugt, welches zur Erweiterung der Player mit Auswahllisten dienen kann.

=== Player mit Favoritenliste und Gruppenliste ausstatten ===
Wenn nicht schon geschehen muss man jetzt die Favoriten zum ersten Mal einlesen: <syntaxhighlight lang="perl">
get SonosBridge Favorites
</syntaxhighlight>Nachdem die SonosBridge "aufgerüstet" ist, kann man allen Playern die Favoritenliste zum Auswählen eintragen. Beide Zeile sind für die FHEM Kommandozeile und verwenden die Routine aus der 99_sonos2mqttUtils.
<syntaxhighlight lang="perl">
{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','joinGroup:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'grouplist','').q( {sonos2mqtt($NAME,$EVENT)}))}
{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','playFav:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'favlist','').q( {sonos2mqtt($NAME,$EVENT)}))}
</syntaxhighlight>
Man kann den playFav Befehl auch im set Befehl mit einem Teil des Favoriten Namen verwenden. Enthält die Favoritenliste z.B. Radio Leipzig würde der auch mit diesem Befehl angesteuert werden:<syntaxhighlight lang="perl">
set alias=Bad playFav leipzig
</syntaxhighlight>

=== Listen der Favoriten Radios und Playlist erstellen ===
Im Sonos System kann man an (mindestens) drei Stellen Favoriten hinterlegen: Sonos-Favoriten, Sonos-Playlisten, TuneIn: Meine Radiosender

Diese drei Listen kann man einlesen und für die einfache Suche und Auswahl verwenden. Der play Befehl akzeptiert dazu zwei weitere Parameter und sucht in den entsprechenden Listen.

Diese play Befehle starten nicht sofort, sondern erst nach einem folgenden set ... play. Damit kann man etwas vorbereiten und gezielt starten.

<code>set alias=Büro play Favorite Deutschlandfunk</code>

<code>set alias=Büro play Radio HitRadio</code>

<code>set alias=Büro play Playlist Meine Hits</code>

Die Sonos-Favoriten-, TuneIn: Meine Radiosender- und Sonos-Playlisten dazu vom Sonos System einmalig (bzw. bei Veränderungen) einlesen:
<pre>
get SonosBridge Reply Playlists;sleep SonosBridge:Reply.*;setreading SonosBridge Playlists [SonosBridge:Reply]
get SonosBridge Reply Favorites;sleep SonosBridge:Reply.*;setreading SonosBridge Favorites [SonosBridge:Reply]
get SonosBridge Reply Radios;sleep SonosBridge:Reply.*;setreading SonosBridge Radios [SonosBridge:Reply]
</pre>

Beispiel für ein Guten Morgen Radio:
<pre>
set alias=BadWanne,alias=Kueche joinGroup Bad;
set alias=BadWanne,alias=Bad volume 13 6;
set alias=Bad play Favorite Deutschlandfunk.Kultur.RP;
set alias=Kueche volume 18 8;
sleep 0.2;set alias=Bad play
</pre>

=== Radioliste durchtasten ===
Will man eine Liste von bestimmten Radiostation mit einem Taster "durchtasten" kann man das wie folgt tun:

Das oben erwähnte <code>99_sonos2mqttUtils.pm</code> (ab 6.1.2023) schreibt die Radios aus dem Reading "Favoriten" in das userReading "<code>favlist</code>" im SonosBridge Device und aktualisiert das auch.

==== Der Befehl zum weiterschalten ====
Jedes Mal wenn dieser Befehl ausgeführt wird, wird der nächste "Radio-Favorit" (aus dem userReading "<code>favlist</code>" des SonosBridge Devices) gestartet.

Wird eine Radiosender gespielt wird bei einem <code>set ''sonos2mqtt_speaker'' next</code> auf den nächsten Sender in dieser Liste geschaltet und der <code>transportState</code> wird beibehalten.

==== Name der Radiostation vor dem Umschalten ansagen ====
Will man vor dem Radiostart noch die Ansage des Senders haben, geht das zwar auch mit dem speak Befehl, die direkte Ausgabe ohne Restore der Umgebung (sonos2mqtt notify) ist aber effektiver.

Damit das funktioniert müssen wir die Events einschränken:
<syntaxhighlight lang="perl">
attr model=sonos2mqtt_speaker event-on-change-reading .*
{my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];;my $r=Each($dev,ReadingsVal($dev,'favlist',''));;my $play = (devspec2array('alias=Büro'))[0];;my $tts="SonosTTS";;fhem("set $tts tts Es folgt $r;;sleep $tts:playing:.0;;set $play playUri [$tts:httpName];;sleep $play:play;;sleep $play:PLAYING;;sleep $play:STOPPED;;set $play playFav $r")}
</syntaxhighlight>
Kurze Erklärung zum Code
* ermittelt den nächsten Radiosender in der Liste: <code>my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];;my $r=Each($dev,ReadingsVal($dev,'favlist',<nowiki>''</nowiki>))</code>
* ermitteln des Namens des <code>''sonos2mqtt_speaker''</code> Devices anhand des <code>alias</code> Attributes: <code>my $play = (devspec2array('alias=Büro'))[0]</code>
* erzeugt die Ansage "Es folgt SenderXY": <code>my $tts="SonosTTS";;fhem("set $tts tts Es folgt $r</code>
* wenn die mp3 Datei fertig erzeugt ist: <code>sleep $tts:playing:.0</code>, wird sie mit dem Befehl playUri an den oben ermittelten <code>''sonos2mqtt_speaker''</code> gesendet: <code>set $play playUri [$tts:httpName]</code>
* es wird eine Eventfolge abgewartet -> play / PLAYING / STOPPED: <code>sleep $play:play;;sleep $play:PLAYING;;sleep $play:STOPPED</code>
* danach wird der Radiosender gestartet: <code>set $play playFav $r</code>
Der Code ist so einfach und relativ "steif" für die Kommandozeile. Man kann das auch in einen Setter packen (<code>set ''sonos2mqtt_speaker'' toggleRadio</code>). Dazu den Text unten in das Attribut <code>setList</code> des Sonos Player Device hinzufügen:
<syntaxhighlight lang="perl">
toggleRadio:noArg {my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];my $r=Each($dev,ReadingsVal($dev,'favlist',''));my $tts="SonosTTS";fhem("set $tts tts Es folgt $r;sleep $tts:playing:.0;set $NAME playUri [$tts:httpName];sleep $NAME:play;sleep $NAME:PLAYING;sleep $NAME:STOPPED;set $NAME playFav $r")}
</syntaxhighlight>

== Dokumentationen und weitere Entwicklungen ==
ToDo

Erweiterung um Alarmhandling siehe [https://forum.fhem.de/index.php/topic,111711.msg1162031.html#msg1162031 Forum]

[[Kategorie:MQTT]]

Sonos2mqtt

2023-01-06T12:46:17Z

50watt: /* Radioliste durchtasten */ Änderungen von 99_sonos2mqttUtils.pm eingearbeitet

== Grundeinrichtung ==
Die Grundeinrichtung ist bereits im Artikel [[MQTT2-Module - Praxisbeispiele#Sonos2Mqtt|MQTT2-Module - Praxisbeispiele]] beschrieben. Hier soll es um die praktische Verwendung und Erweiterung gehen.

Für alle Erweiterungen wird versucht vorhandene Devices in FHEM zu verwenden.

Viele Dinge werden derzeit noch entwickelt und können frei gestaltet werden - der Vorteil von generischen FHEM Devices.

== Tipps zur Verwendung ==
Die automatische Konfiguration setzt den alias entsprechend dem im Sonos vergeben Namen . Die langen MQTT2_RINCON_ Namen sind unhandlich und schlecht lesbar. Man kann Player mit einem devspec ansprechen, das simpelste ist:
:<code>set alias=Büro play</code>
Oder alle Player
:<code>set model=sonos2mqtt_speaker leaveGroup</code>

== Konfiguration der Player ==
Mit dem Template sonos_bridge_comfort wird aus dem contrib Ordner eine Datei 99_sonos2mqttUtils.pm nachgeladen und aktiviert. Darin befindet sich der wesentliche Code, die sonos2mqtt Geräte selbst enthalten nur rudimentäre Aufrufe.

Selbstverständlich kann man diese Datei jederzeit selbst gestalten (FHEM Menu:Edit Files) aber man sollte beachten, dass eine erneute Anwendung des Templates die Datei überschreibt.

Man kann auch jederzeit diese Datei aus dem SVN neu laden:
<syntaxhighlight lang="perl">
{ Svn_GetFile("contrib/AttrTemplate/99_sonos2mqttUtils.pm", "FHEM/99_sonos2mqttUtils.pm", sub(){ CommandReload(undef, "99_sonos2mqttUtils") }) }
</syntaxhighlight>Hauptroutine ist sonos2mqtt die mit zwei Parametern aufgerufen wird. <code>{sonos2mqtt($NAME,$EVENT)}</code>

Die Optik des Players wird mit der Routine <code>sonos2mqtt_devStateIcon</code> bestimmt.

Man kann die Player mittels <code>attr a:model=sonos2mqtt_speaker webCmd volume</code> mit einem Slider in der Übersicht ausstatten.

Ändert man die Sonoslandschaft, kann man auch alles einreißen und neu erzeugen lassen. Zunächst alles löschen (für die FHEM Kommandozeile):<syntaxhighlight lang="perl">
{fhem("delete a:model=sonos2mqtt_speaker;;delete FileLog_MQTT2_RINCON.*");;qx(rm ./log/MQTT2_RINCON_*);;return ""}
</syntaxhighlight>Danach muss man sonos2mqtt einfach neu starten: pm2 start ... bzw den docker container neu starten.

== Befehle nachrüsten ==
Um Befehle in der setList / getList / readingList nachzurüsten gibt es die Routine <code>sonos2mqtt_mod_list(devspec,attrName,line)</code>

Vorhandenen Zeilen werden ersetzt. Identifiziert wird nur der erste Teil bis zum ":". Beispiel für die Komandozeile:

<code>{sonos2mqtt_mod_list('a:model=sonos2mqtt_bridge','readingList','sonos/RINCON_([0-9A-Z]+)/Reply:.* Reply')}</code>

== Sprachausgabe ==
Man hat zwei Möglichkeiten, dies umzusetzen:
# Text2Speech FHEM intern
# Mit dem sonos text to speech Server https://svrooij.io/sonos2mqtt/

=== Text2Speech Variante einrichten ===
Zwei zusätzliche Geräte sind notwendig:
* [[Text2Speech]] im Servermodus, erzeugt mp3 Dateien im cache Verzeichnis und legt einen Link im Reading httpName ab.
* Ein HTTP Server stellt die Dateien im gleichen Verzeichnis bereit
'''Hinweis''': Für die vollständige Funktion und Installation von Text2Speech ist die Commandref zu beachten! Für das unten im Beispiel verwendete Feature UseMP3Wrap muss das Tool mp3wrap installiert werden (z.B. <code>apt install mp3wrap</code>). Dies ist bei längeren Texten und bei der Verwendung von eingebetteten festen Sounds existenziell!

Für die Funktion ist wichtig, dass das Sonos System den Host im Link zur Datei richtig auflösen kann. Deshalb wird der Hostname und Port des Servers im Reading host des TTS Device als Name oder IP Adresse abgelegt! Dies kann entweder mit dem hier gezeigten Befehl oder vollständig manuell erfolgen. Für FHEM innerhalb Docker muss man die Adresse des Docker Host angeben.
<syntaxhighlight lang="perl">
defmod SonosTTS Text2Speech none
attr SonosTTS TTS_UseMP3Wrap 1
attr SonosTTS TTS_Language Deutsch
attr SonosTTS userReadings httpName:lastFilename.* {'http://'.ReadingsVal($name,'host','set host:port first').'/fhem/'.ReadingsVal($name,'lastFilename','')}
attr SonosTTS TTS_CacheFileDir cache
setreading SonosTTS host {(qx(hostname -s|tr -d '\n').':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host {((split(' ', qx(hostname -I)))[0].':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host <hostname>:<port>

defmod SonosSpeakWeb HTTPSRV cache cache SonosSpeakWeb
</syntaxhighlight>
Der Sprachausgabe Befehle im Player Device läuft in 3 Schritten:
# mit dem TTS Gerät wird die mp3 Datei erzeugt,
# mit dem sleep wird auf die Fertigstellung gewartet,
# die Datei wird mit <code>set Player notify volume uri</code> abgespielt.
Durch den "sonos2mqtt notify" Befehl wird die laufende Umgebung wiederhergestellt.
* Wird der Sprachbefehl an den Gruppenmaster gesendet wird die mp3 Datei in der gesamten Gruppe gespielt.
* Wird der Sprachbefehl an ein Mitglied einer Gruppe gesendet (nicht den Master) wird die Gruppe aufgetrennt und später wieder hergestellt.
Es sind zwei Befehle zur Sprachausgabe eingebaut:

=== sayText Befehl ===
Dieser Befehl orientiert sich an den FHEM [[DevelopmentGuidelinesAV|DevelopmentGuidelines]] und sammelt "gleichzeitig" eintreffende Sprachnachrichten, damit nichts verloren geht. Informationen im Forum dazu in {{Link2Forum|Topic=111711|Message=1100112|LinkText=diesem Beitrag}}.

Die Lautstärke wird separat in SonosTTS gesetzt: <code>setreading SonosTTS vol 15</code>, ebenso die Sprache (einmalig bei der Einrichtung oder bei Bedarf zwischendurch) <code>attr SonosTTS TTS_Language Deutsch</code>

''Hinweis: Der Befehl <code>set SonosTTS volume xx</code> hat im Servermodus des Devices keine Wirkung!''
=== Speak Befehl ===
Dieser Befehl ist ähnlich wie der in der FHEM-Sonos Umgebung:
:<code>set Player speak <volume> text</code>

Verwendet man diesen Syntax (mit Sprache und Stimme am Anfang), wird automatisch der speak Befehl an die sonos-tts abgesetzt. Die sonos-tts muss man separat installieren/integrieren!

<code>set EG.KU.Sonos speak de-DE Vicki 25 Test</code>

Will man keine laufenden Sendung unterbrechen sondern einfach eine Ansage machen und danach etwas starten, kann man so vorgehen:
<syntaxhighlight lang="perl">
set SonosTTS tts Hier steht die Ansage;sleep SonosTTS:playing:.0 ; set alias=PlayerAlias playUri [SonosTTS:httpName]
</syntaxhighlight>

=== Volume Befehl ===
Der Befehl akzeptiert einen zweiten Wert als Startwert d.h. set volume 25 10 setzt sofort auf 10 und startet dann fading auf 25. Ein zweiter Wert -1 erzeugt ein fading vom aktuellen Wert auf den angegebenen.

==== Spiele feste Sounds ====
Generell kann man feste mp3 Dateien (Klingeltöne, Klänge usw.) auch im cache Verzeichnis ablegen und direkt mit dem Link starten.

Es gibt zahlreiche Soundquellen im Internet, ist der gewünschte Sound dabei, kann man ihn innerhalb FHEM herunterladen und an Ort und Stelle platzieren. (Beispiel ohne und mit Umbennung)
<syntaxhighlight lang="perl">
"wget -qP ./cache https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"
"wget -qO ./cache/KlingelTon.mp3 https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"
</syntaxhighlight>
Vergewissern ob der gewünschte Sound auch da ist: {qx(ls -lha ./cache)}

Mit set magic kann man dabei einfach Teile aus anderen Readings holen.
<syntaxhighlight lang="perl">
set alias=Büro notify 25 {('http://[SonosTTS:host]/fhem/cache/KlingelTon.mp3')}
</syntaxhighlight>
Man kann auch den setter im Gerät erweitern <code>{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList',q(playSound:textField ....))}</code> :
<syntaxhighlight lang="perl">
playSound:textField {my $tts="SonosTTS";my ($cmd,$vol,$file)=split(' ', $EVENT,3);$file=($file=~m/.*\.mp3$/)?"$file":"$file.mp3";fhem("set $NAME notify $vol http://[$tts:host]/fhem/[a:$tts:TTS_CacheFileDir]/$file")}
</syntaxhighlight>
Damit sind dann dieser Syntax möglich:
<syntaxhighlight lang="perl">
set alias=Büro playSound 40 KlingelTon.mp3
</syntaxhighlight>
oder ohne Dateiendung (wird auf mp3 gesetzt)
<syntaxhighlight lang="perl">
set alias=Büro playSound 40 KlingelTon
</syntaxhighlight>

=== SonosBridge ===
Die SonsoBridge enthält bereits ein paar zentrale Funktionen und Readings, z.B. wird beim Laden der Favoritenliste ein Reading favlist und grouplist erzeugt, welches zur Erweiterung der Player mit Auswahllisten dienen kann.

=== Player mit Favoritenliste und Gruppenliste ausstatten ===
Wenn nicht schon geschehen muss man jetzt die Favoriten zum ersten Mal einlesen: <syntaxhighlight lang="perl">
get SonosBridge Favorites
</syntaxhighlight>Nachdem die SonosBridge "aufgerüstet" ist, kann man allen Playern die Favoritenliste zum Auswählen eintragen. Beide Zeile sind für die FHEM Kommandozeile und verwenden die Routine aus der 99_sonos2mqttUtils.
<syntaxhighlight lang="perl">
{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','joinGroup:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'grouplist','').q( {sonos2mqtt($NAME,$EVENT)}))}
{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','playFav:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'favlist','').q( {sonos2mqtt($NAME,$EVENT)}))}
</syntaxhighlight>
Man kann den playFav Befehl auch im set Befehl mit einem Teil des Favoriten Namen verwenden. Enthält die Favoritenliste z.B. Radio Leipzig würde der auch mit diesem Befehl angesteuert werden:<syntaxhighlight lang="perl">
set alias=Bad playFav leipzig
</syntaxhighlight>

=== Listen der Favoriten Radios und Playlist erstellen ===
Im Sonos System kann man an (mindestens) drei Stellen Favoriten hinterlegen: Sonos-Favoriten, Sonos-Playlisten, TuneIn: Meine Radiosender

Diese drei Listen kann man einlesen und für die einfache Suche und Auswahl verwenden. Der play Befehl akzeptiert dazu zwei weitere Parameter und sucht in den entsprechenden Listen.

Diese play Befehle starten nicht sofort, sondern erst nach einem folgenden set ... play. Damit kann man etwas vorbereiten und gezielt starten.

<code>set alias=Büro play Favorite Deutschlandfunk</code>

<code>set alias=Büro play Radio HitRadio</code>

<code>set alias=Büro play Playlist Meine Hits</code>

Die Sonos-Favoriten-, TuneIn: Meine Radiosender- und Sonos-Playlisten dazu vom Sonos System einmalig (bzw. bei Veränderungen) einlesen:
<pre>
get SonosBridge Reply Playlists;sleep SonosBridge:Reply.*;setreading SonosBridge Playlists [SonosBridge:Reply]
get SonosBridge Reply Favorites;sleep SonosBridge:Reply.*;setreading SonosBridge Favorites [SonosBridge:Reply]
get SonosBridge Reply Radios;sleep SonosBridge:Reply.*;setreading SonosBridge Radios [SonosBridge:Reply]
</pre>

Beispiel für ein Guten Morgen Radio:
<pre>
set alias=BadWanne,alias=Kueche joinGroup Bad;
set alias=BadWanne,alias=Bad volume 13 6;
set alias=Bad play Favorite Deutschlandfunk.Kultur.RP;
set alias=Kueche volume 18 8;
sleep 0.2;set alias=Bad play
</pre>

=== Radioliste durchtasten ===
Will man eine Liste von bestimmten Radiostation mit einem Taster "durchtasten" kann man das wie folgt tun:

Das oben erwähnte <code>99_sonos2mqttUtils.pm</code> (ab 6.1.2023) schreibt die Radios aus dem Reading "Favoriten" in das userReading "<code>favlist</code>" im SonosBridge Device und aktualisiert das auch.

==== Der Befehl zum weiterschalten ====
Jedes Mal wenn dieser Befehl ausgeführt wird, wird der nächste "Radio-Favorit" (aus dem userReading "<code>favlist</code>" des SonosBridge Devices) gestartet.

Wird eine Radiosender gespielt wird bei einem <code>set ''sonos2mqtt_speaker'' next</code> auf den nächsten Sender in dieser Liste geschaltet und der <code>transportState</code> wird beibehalten.

==== Name der Radiostation vor dem Umschalten ansagen ====
Will man vor dem Radiostart noch die Ansage des Senders haben, geht das zwar auch mit dem speak Befehl, die direkte Ausgabe ohne Restore der Umgebung (sonos2mqtt notify) ist aber effektiver.

Damit das funktioniert müssen wir die Events einschränken:
<syntaxhighlight lang="perl">
attr model=sonos2mqtt_speaker event-on-change-reading .*
{my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];;my $r=Each($dev,ReadingsVal($dev,'favlist',''));;my $play = (devspec2array('alias=Büro'))[0];;my $tts="SonosTTS";;fhem("set $tts tts Es folgt $r;;sleep $tts:playing:.0;;set $play playUri [$tts:httpName];;sleep $play:play;;sleep $play:PLAYING;;sleep $play:STOPPED;;set $play playFav $r")}
</syntaxhighlight>
Kurze Erklärung zum Code
* ermittelt den nächsten Radiosender in der Liste: <code>my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];;my $r=Each($dev,ReadingsVal($dev,'favlist',<nowiki>''</nowiki>))</code>
* erzeugt die Ansage "Es folgt SenderXY",
* wenn die mp3 Datei fertig erzeugt ist, wird sie mit dem Befehl playUri an den Player gesendet,
* es wird eine Eventfolge abgewartet -> play / PLAYING / STOPPED,
* danach wird der Radiosender gestartet.
Der Code ist so einfach und relativ "steif" für die Kommandozeile. Man kann das auch in einen Setter packen (<code>set ''sonos2mqtt_speaker'' toggleRadio</code>). Dazu den Text unten in das Attribut <code>setList</code> des Sonos Player Device hinzufügen:
<syntaxhighlight lang="perl">
toggleRadio:noArg {my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];my $r=Each($dev,ReadingsVal($dev,'favlist',''));my $tts="SonosTTS";fhem("set $tts tts Es folgt $r;sleep $tts:playing:.0;set $NAME playUri [$tts:httpName];sleep $NAME:play;sleep $NAME:PLAYING;sleep $NAME:STOPPED;set $NAME playFav $r")}
</syntaxhighlight>

== Dokumentationen und weitere Entwicklungen ==
ToDo

Erweiterung um Alarmhandling siehe [https://forum.fhem.de/index.php/topic,111711.msg1162031.html#msg1162031 Forum]

[[Kategorie:MQTT]]

Sonos2mqtt

2022-04-10T18:46:33Z

50watt: /* Player mit Favoritenliste und Gruppenliste ausstatten */ Tippfehler

== Grundeinrichtung ==
Die Grundeinrichtung ist bereits im Artikel [[MQTT2-Module - Praxisbeispiele#Sonos2Mqtt|MQTT2-Module - Praxisbeispiele]] beschrieben. Hier soll es um die praktische Verwendung und Erweiterung gehen.

Für alle Erweiterungen wird versucht vorhandene Devices in FHEM zu verwenden.

Viele Dinge werden derzeit noch entwickelt und können frei gestaltet werden - der Vorteil von generischen FHEM Devices.

== Tipps zur Verwendung ==
Die automatische Konfiguration setzt den alias entsprechend dem im Sonos vergeben Namen . Die langen MQTT2_RINCON_ Namen sind unhandlich und schlecht lesbar. Man kann Player mit einem devspec ansprechen, das simpelste ist:
:<code>set alias=Büro play</code>
Oder alle Player
:<code>set model=sonos2mqtt_speaker leaveGroup</code>

== Konfiguration der Player ==
Mit dem Template sonos_bridge_comfort wird aus dem contrib Ordner eine Datei 99_sonos2mqttUtils.pm nachgeladen und aktiviert. Darin befindet sich der wesentliche Code, die sonos2mqtt Geräte selbst enthalten nur rudimentäre Aufrufe.

Selbstverständlich kann man diese Datei jederzeit selbst gestalten (FHEM Menu:Edit Files) aber man sollte beachten, dass eine erneute Anwendung des Templates die Datei überschreibt.

Man kann auch jederzeit diese Datei aus dem SVN neu laden:
<syntaxhighlight lang="perl">
{ Svn_GetFile("contrib/AttrTemplate/99_sonos2mqttUtils.pm", "FHEM/99_sonos2mqttUtils.pm", sub(){ CommandReload(undef, "99_sonos2mqttUtils") }) }
</syntaxhighlight>Hauptroutine ist sonos2mqtt die mit zwei Parametern aufgerufen wird. <code>{sonos2mqtt($NAME,$EVENT)}</code>

Die Optik des Players wird mit der Routine <code>sonos2mqtt_devStateIcon</code> bestimmt.

Man kann die Player mittels <code>attr a:model=sonos2mqtt_speaker webCmd volume</code> mit einem Slider in der Übersicht ausstatten.

Ändert man die Sonoslandschaft, kann man auch alles einreißen und neu erzeugen lassen. Zunächst alles löschen (für die FHEM Kommandozeile):<syntaxhighlight lang="perl">
{fhem("delete a:model=sonos2mqtt_speaker;;delete FileLog_MQTT2_RINCON.*");;qx(rm ./log/MQTT2_RINCON_*);;return ""}
</syntaxhighlight>Danach muss man sonos2mqtt einfach neu starten: pm2 start ... bzw den docker container neu starten.

== Befehle nachrüsten ==
Um Befehle in der setList / getList / readingList nachzurüsten gibt es die Routine <code>sonos2mqtt_mod_list(devspec,attrName,line)</code>

Vorhandenen Zeilen werden ersetzt. Identifiziert wird nur der erste Teil bis zum ":". Beispiel für die Komandozeile:

<code>{sonos2mqtt_mod_list('a:model=sonos2mqtt_bridge','readingList','sonos/RINCON_([0-9A-Z]+)/Reply:.* Reply')}</code>

== Sprachausgabe ==
Man hat zwei Möglichkeiten, dies umzusetzen:
# Text2Speech FHEM intern
# Mit dem sonos text to speech Server https://svrooij.io/sonos2mqtt/

=== Text2Speech Variante einrichten ===
Zwei zusätzliche Geräte sind notwendig:
* [[Text2Speech]] im Servermodus, erzeugt mp3 Dateien im cache Verzeichnis und legt einen Link im Reading httpName ab.
* Ein HTTP Server stellt die Dateien im gleichen Verzeichnis bereit
'''Hinweis''': Für die vollständige Funktion und Installation von Text2Speech ist die Commandref zu beachten! Für das unten im Beispiel verwendete Feature UseMP3Wrap muss das Tool mp3wrap installiert werden (z.B. <code>apt install mp3wrap</code>). Dies ist bei längeren Texten und bei der Verwendung von eingebetteten festen Sounds existenziell!

Für die Funktion ist wichtig, dass das Sonos System den Host im Link zur Datei richtig auflösen kann. Deshalb wird der Hostname und Port des Servers im Reading host des TTS Device als Name oder IP Adresse abgelegt! Dies kann entweder mit dem hier gezeigten Befehl oder vollständig manuell erfolgen. Für FHEM innerhalb Docker muss man die Adresse des Docker Host angeben.
<syntaxhighlight lang="perl">
defmod SonosTTS Text2Speech none
attr SonosTTS TTS_UseMP3Wrap 1
attr SonosTTS TTS_Language Deutsch
attr SonosTTS userReadings httpName:lastFilename.* {'http://'.ReadingsVal($name,'host','set host:port first').'/fhem/'.ReadingsVal($name,'lastFilename','')}
attr SonosTTS TTS_CacheFileDir cache
setreading SonosTTS host {(qx(hostname -s|tr -d '\n').':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host {((split(' ', qx(hostname -I)))[0].':'.InternalVal('WEB','PORT','8083'))}
#setreading SonosTTS host <hostname>:<port>

defmod SonosSpeakWeb HTTPSRV cache cache SonosSpeakWeb
</syntaxhighlight>
Der Sprachausgabe Befehle im Player Device läuft in 3 Schritten:
# mit dem TTS Gerät wird die mp3 Datei erzeugt,
# mit dem sleep wird auf die Fertigstellung gewartet,
# die Datei wird mit <code>set Player notify volume uri</code> abgespielt.
Durch den "sonos2mqtt notify" Befehl wird die laufende Umgebung wiederhergestellt.
* Wird der Sprachbefehl an den Gruppenmaster gesendet wird die mp3 Datei in der gesamten Gruppe gespielt.
* Wird der Sprachbefehl an ein Mitglied einer Gruppe gesendet (nicht den Master) wird die Gruppe aufgetrennt und später wieder hergestellt.
Es sind zwei Befehle zur Sprachausgabe eingebaut:

=== sayText Befehl ===
Dieser Befehl orientiert sich an den FHEM [[DevelopmentGuidelinesAV|DevelopmentGuidelines]] und sammelt "gleichzeitig" eintreffende Sprachnachrichten, damit nichts verloren geht. Informationen im Forum dazu in {{Link2Forum|Topic=111711|Message=1100112|LinkText=diesem Beitrag}}.

Die Lautstärke wird separat in SonosTTS gesetzt: <code>setreading SonosTTS vol 15</code>, ebenso die Sprache (einmalig bei der Einrichtung oder bei Bedarf zwischendurch) <code>attr SonosTTS TTS_Language Deutsch</code>

''Hinweis: Der Befehl <code>set SonosTTS volume xx</code> hat im Servermodus des Devices keine Wirkung!''
=== Speak Befehl ===
Dieser Befehl ist ähnlich wie der in der FHEM-Sonos Umgebung:
:<code>set Player speak <volume> text</code>

Verwendet man diesen Syntax (mit Sprache und Stimme am Anfang), wird automatisch der speak Befehl an die sonos-tts abgesetzt. Die sonos-tts muss man separat installieren/integrieren!

<code>set EG.KU.Sonos speak de-DE Vicki 25 Test</code>

Will man keine laufenden Sendung unterbrechen sondern einfach eine Ansage machen und danach etwas starten, kann man so vorgehen:
<syntaxhighlight lang="perl">
set SonosTTS tts Hier steht die Ansage;sleep SonosTTS:playing:.0 ; set alias=PlayerAlias playUri [SonosTTS:httpName]
</syntaxhighlight>

=== Volume Befehl ===
Der Befehl akzeptiert einen zweiten Wert als Startwert d.h. set volume 25 10 setzt sofort auf 10 und startet dann fading auf 25. Ein zweiter Wert -1 erzeugt ein fading vom aktuellen Wert auf den angegebenen.

==== Spiele feste Sounds ====
Generell kann man feste mp3 Dateien (Klingeltöne, Klänge usw.) auch im cache Verzeichnis ablegen und direkt mit dem Link starten.

Es gibt zahlreiche Soundquellen im Internet, ist der gewünschte Sound dabei, kann man ihn innerhalb FHEM herunterladen und an Ort und Stelle platzieren. (Beispiel ohne und mit Umbennung)
<syntaxhighlight lang="perl">
"wget -qP ./cache https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"
"wget -qO ./cache/KlingelTon.mp3 https://cdn.smartersoft-group.com/various/pull-bell-short.mp3"
</syntaxhighlight>
Vergewissern ob der gewünschte Sound auch da ist: {qx(ls -lha ./cache)}

Mit set magic kann man dabei einfach Teile aus anderen Readings holen.
<syntaxhighlight lang="perl">
set alias=Büro notify 25 {('http://[SonosTTS:host]/fhem/cache/KlingelTon.mp3')}
</syntaxhighlight>
Man kann auch den setter im Gerät erweitern <code>{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList',q(playSound:textField ....))}</code> :
<syntaxhighlight lang="perl">
playSound:textField {my $tts="SonosTTS";my ($cmd,$vol,$file)=split(' ', $EVENT,3);$file=($file=~m/.*\.mp3$/)?"$file":"$file.mp3";fhem("set $NAME notify $vol http://[$tts:host]/fhem/[a:$tts:TTS_CacheFileDir]/$file")}
</syntaxhighlight>
Damit sind dann dieser Syntax möglich:
<syntaxhighlight lang="perl">
set alias=Büro playSound 40 KlingelTon.mp3
</syntaxhighlight>
oder ohne Dateiendung (wird auf mp3 gesetzt)
<syntaxhighlight lang="perl">
set alias=Büro playSound 40 KlingelTon
</syntaxhighlight>

=== SonosBridge ===
Die SonsoBridge enthält bereits ein paar zentrale Funktionen und Readings, z.B. wird beim Laden der Favoritenliste ein Reading favlist und grouplist erzeugt, welches zur Erweiterung der Player mit Auswahllisten dienen kann.

=== Player mit Favoritenliste und Gruppenliste ausstatten ===
Wenn nicht schon geschehen muss man jetzt die Favoriten zum ersten Mal einlesen: <syntaxhighlight lang="perl">
get SonosBridge Favorites
</syntaxhighlight>Nachdem die SonosBridge "aufgerüstet" ist, kann man allen Playern die Favoritenliste zum Auswählen eintragen. Beide Zeile sind für die FHEM Kommandozeile und verwenden die Routine aus der 99_sonos2mqttUtils.
<syntaxhighlight lang="perl">
{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','joinGroup:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'grouplist','').q( {sonos2mqtt($NAME,$EVENT)}))}
{sonos2mqtt_mod_list('a:model=sonos2mqtt_speaker','setList','playFav:'.ReadingsVal((devspec2array('a:model=sonos2mqtt_bridge'))[0],'favlist','').q( {sonos2mqtt($NAME,$EVENT)}))}
</syntaxhighlight>
Man kann den playFav Befehl auch im set Befehl mit einem Teil des Favoriten Namen verwenden. Enthält die Favoritenliste z.B. Radio Leipzig würde der auch mit diesem Befehl angesteuert werden:<syntaxhighlight lang="perl">
set alias=Bad playFav leipzig
</syntaxhighlight>

=== Listen der Favoriten Radios und Playlist erstellen ===
Im Sonos System kann man an (mindestens) drei Stellen Favoriten hinterlegen: Sonos-Favoriten, Sonos-Playlisten, TuneIn: Meine Radiosender

Diese drei Listen kann man einlesen und für die einfache Suche und Auswahl verwenden. Der play Befehl akzeptiert dazu zwei weitere Parameter und sucht in den entsprechenden Listen.

Diese play Befehle starten nicht sofort, sondern erst nach einem folgenden set ... play. Damit kann man etwas vorbereiten und gezielt starten.

<code>set alias=Büro play Favorite Deutschlandfunk</code>

<code>set alias=Büro play Radio HitRadio</code>

<code>set alias=Büro play Playlist Meine Hits</code>

Die Sonos-Favoriten-, TuneIn: Meine Radiosender- und Sonos-Playlisten dazu vom Sonos System einmalig (bzw. bei Veränderungen) einlesen:
<pre>
get SonosBridge Reply Playlists;sleep SonosBridge:Reply.*;setreading SonosBridge Playlists [SonosBridge:Reply]
get SonosBridge Reply Favorites;sleep SonosBridge:Reply.*;setreading SonosBridge Favorites [SonosBridge:Reply]
get SonosBridge Reply Radios;sleep SonosBridge:Reply.*;setreading SonosBridge Radios [SonosBridge:Reply]
</pre>

Beispiel für ein Guten Morgen Radio:
<pre>
set alias=BadWanne,alias=Kueche joinGroup Bad;
set alias=BadWanne,alias=Bad volume 13 6;
set alias=Bad play Favorite Deutschlandfunk.Kultur.RP;
set alias=Kueche volume 18 8;
sleep 0.2;set alias=Bad play
</pre>

=== Radioliste durchtasten ===
Will man eine Liste von bestimmten Radiostation mit einem Taster "durchtasten" kann man das wie folgt tun:

Eine eigene Radio Liste in ein Reading schreiben (Die Namen müssen zumindest in Teilen mit den Favoriten Titeln übereinstimmen)
<syntaxhighlight lang="perl">
setreading model=sonos2mqtt_bridge favRadios Deutschlandfunk Kultur,Radio Leipzig,Radio Station 3
</syntaxhighlight>
Im Template wird durch ein userReading die Liste beim Auslesen der Favoriten vorbelegt.

Der Befehl zum weiterschalten. Jedes Mal wenn dieser Befehl ausgeführt wird, wird der nächste Favorit gestartet.

Wird eine Radiosender gespielt wird bei einem set ... next auf den nächsten Sender in dieser Liste geschaltet und der transportState wird beibehalten.

=== Weitere Ideen ===
Will man vor dem Radiostart noch die Ansage des Senders haben, geht das zwar auch mit dem speak Befehl, die direkte Ausgabe ohne Restore der Umgebung (sonos2mqtt notify) ist aber effektiver.

Damit das funktioniert müssen wir die Events einschränken:
<syntaxhighlight lang="perl">
attr model=sonos2mqtt_speaker event-on-change-reading .*
{my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];;my $r=Each($dev,ReadingsVal($dev,'favRadios',''));;my $play = (devspec2array('alias=Büro'))[0];;my $tts="SonosTTS";;fhem("set $tts tts Es folgt $r;;sleep $tts:playing:.0;;set $play playUri [$tts:httpName];;sleep $play:play;;sleep $play:PLAYING;;sleep $play:STOPPED;;set $play playFav $r")}
</syntaxhighlight>
Kurze Erklärung zum Code
* ermittelt den nächsten Radiosender in der Liste,
* erzeugt die Ansage "Es folgt SenderXY",
* wenn die mp3 Datei fertig erzeugt ist, wird sie mit dem Befehl playUri an den Player gesendet,
* es wird eine Eventfolge abgewartet -> play / PLAYING / STOPPED,
* danach wird der Radiosender gestartet.
Der Code ist so einfach und relativ "steif" für die Kommandozeile. Man kann das auch in einen Setter packen (set ... toggleRadio). Dazu den Text unten in das Attribut setList des Sonos Player Device hinzufügen:
<syntaxhighlight lang="perl">
toggleRadio:noArg {my $dev = (devspec2array('model=sonos2mqtt_bridge'))[0];my $r=Each($dev,ReadingsVal($dev,'favRadios',''));my $tts="SonosTTS";fhem("set $tts tts Es folgt $r;sleep $tts:playing:.0;set $NAME playUri [$tts:httpName];sleep $NAME:play;sleep $NAME:PLAYING;sleep $NAME:STOPPED;set $NAME playFav $r")}
</syntaxhighlight>

== Dokumentationen und weitere Entwicklungen ==
ToDo

Erweiterung um Alarmhandling siehe [https://forum.fhem.de/index.php/topic,111711.msg1162031.html#msg1162031 Forum]

[[Kategorie:MQTT]]

Wetter und Wettervorhersagen

2021-11-16T14:24:10Z

50watt: /* Vorhersage-Diagramm von YR */ YR hat das Format des Links zum Meteogram leicht geändert

Wetterdaten und Wettervorhersagen können auf verschiedene Weise in FHEM eingebunden werden.

== Modul Weather ==
Das Modul [[Weather]] extrahiert Wetterdaten via API von den Wetterdatenanbietern
* [https://openweathermap.org/ Openweathermap]
** Vorschauzeitraum: 5 Tage (zeitliche Auflösung: 3 Stunden)
** Aktuelle Daten (minütlich)
** 1000 Abrufe pro Tag mit dem Gratis-API-Key (Stand: Juni 2021)
* [https://www.wunderground.com/ wunderground]
** API-KEY nur für Gerätebesitzer
* [https://darksky.net/ DarkSky]
** API soll Ende 2022 abgeschaltet werden
** Es können keine neuen API-Key erstellt werden (Stand: Juni 2021)

Da die Yahoo Weather API zum 03.01.2019 abgeschaltet wurde, kann Weather keine Wetterdaten von Yahoo mehr beziehen.

== Unwetterzentrale ==
Informationen der Seite(n) Unwetterzentrale.de können mit Hilfe des Moduls [[UWZ]] eingebunden werden.

== Modul OPENWEATHER ==
Das Modul [[OPENWEATHER]] extrahiert Wetterdaten über die "openweather"-Schnittstelle (API) von www.wetter.com.
*Vorschau-Zeitraum: 3 Tage
*Vorschau-Interval: 6:00, 11:00, 17:00, 23:00
*Aktuelle Daten: keine

== Modul PROPLANTA ==
Das Modul [[PROPLANTA]] extrahiert Wetterdaten von der Website www.proplanta.de. (keine API)
*Vorschau-Zeitraum: 12 Tage
*Vorschau-Interval: 3 h
*Aktuelle Daten: jede volle Stunde

== Modul WWO ==
Das {{Link2CmdRef|Anker=WWO|Label=Modul WWO}} extrahiert Wetterdaten über die (alte) API von worldweatheronline.com
*Vorschau-Zeitraum: ?? Tage<BR>
*Vorschau-Interval: ??<br>
*Aktuelle Daten: ??

== Deutscher Wetterdienst (DWD) ==

=== Modul DWD_OpenData ===
Das Modul [[DWD_OpenData]] stellt einen Teil der frei verfügbaren Daten des Deutschen Wetterdienstes (DWD) bereit, die über den [https://www.dwd.de/DE/leistungen/opendata/opendata.html Open Data Server] abgerufen werden können (diverse Datenformate, keine API).
*Vorschau-Zeitraum: 10 Tage
*Vorschau-Interval: datenabhängig, viele mit 3 h
*Vorschau-Orte: national und international
*Aktuelle Daten: nicht implementiert
*Wetterwarnungen: für Landkreise und Gemeinden in deutsch oder englisch

Es gibt zum Modul auch einen Weblink für [[FHEMWEB]], der zwei Icons pro Tag in horizontaler Form darstellt. Die Anzahl der insgesamt dargestellten Icons ist konfigurierbar. Liegen Wetterwarnungen vor, wird zusätzlich ein Warnsymbol angezeigt, über das man per Klick weitere Details zur Wetterwarnung abrufen kann.

[[DWD_OpenData|Weitere Details und Installationsbeschreibung]]

=== Wetterwarnungen als Karte ===
Der Deutsche Wetterdienst [http://www.dwd.de DWD] stellt neben diversen Wetterdaten auch Wetterwarnungen in Bildform bereit. Diese können sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden - das ist zwar nicht die schönste Form, aber die schnellste.

Dazu sucht man sich zuerst auf der [http://www.dwd.de/bvbw/appmanager/bvbw/dwdwwwDesktop?_nfpb=true&_pageLabel=_dwdwww_wetter_warnungen_warnungen&T92053gsbDocumentPath=BEA__Navigation%2FWetter__Warnungen%2FWarnungen.html%3F__nnn%3Dtrue&lastPageLabel=dwdwww_wetter_warnungen Warnungsseite des DWD] die eigene Region heraus (in der Karte durchklicken). Die gewünschte URL für Berlin Stadt ist z.B. <code>http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html#WS_ANCHOR_0</code>. Das Anhängsel <code>#WS_ANCHOR_0</code> kann man in der Konfiguration auch weglassen.

Die Einbindung in FHEM sieht dann wie folgt aus:
<pre>
define dwd_warnmeldung weblink iframe http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html
attr dwd_warnmeldung group Wetterwarnungen (DWD)
attr dwd_warnmeldung htmlattr width="100%" height="300" frameborder="0" marginheight="0" marginwidth="0"
attr dwd_warnmeldung room Wettervorhersage,Startseite
</pre>

== Vorhersage-Diagramm von YR ==
[http://www.yr.no YR] ist die Seite des norwegischen Wetterdiensts. Er ist zwar nur in Teilen auf Englisch (und gar nicht auf Deutsch) verfügbar, bietet aber sehr gute Wettervorhersagen - auch mit eigenen Vorhersagen für kleine Dörfer. Neben etlichen Detailinfos bietet YR eine sehr schicke 48h-Vorhersage-Grafik. Diese kann sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden.

Dazu geht man auf die [http://www.yr.no Startseite von YR] und gibt in das Suchfeld den Namen seines Dörfchens ein - die Ergebnissliste kann ziemlich lang werden, sodass man evtl. sehr genau schauen muss, welches das eigene Kaff ist - bei mir war es an 29. Stelle... ;-) Auf der gewünschten Seite gibt es einen Unterpunkt "Forecast as SVG", wo sich die besagte Grafik findet. Hier kopiert man sich einfach die URL der Grafik.

Die Einbindung in FHEM sieht dann bspw. wie folgt aus:
<pre>
define Wetter_yr_Vorhersage weblink iframe https://www.yr.no/en/content/2-2950159/meteogram.svg
attr Wetter_yr_Vorhersage group Wettervorhersage (yr)
attr Wetter_yr_Vorhersage htmlattr width="782" height="391" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter_yr_Vorhersage room Wettervorhersage,Start
</pre>

== Wetter von Weather Underground ==
{{Randnotiz|RNTyp=r|RNText=Das ("offene") API von Weather Underground wird derzeit (März 2019) "retired" = abgestellt, ist also künftig nicht mehr nutzbar! Den benötigten API-Key bekommen "nur noch" Betreiber einer Wetterstation, die diese bei wundergound registrieren und ihre Daten hochladen.}}
'''Hinweis:''' Die hier beschriebene Vorgehensweise ist etwas anspruchsvoller und somit eher für erfahrene FHEM-User geeignet.

[http://www.wunderground.com/ Weather Underground] bietet eine sehr umfassende Sammlung aller möglichen offiziellen und privaten (aber teils sehr professionellen) Wetterstationen weltweit. Es besteht eine recht hohe Wahrscheinlichkeit, dass es in der eigenen Umgebung schon eine Wetterstation gibt. Anstatt nun selbst eine komplette Wetterstation aufzubauen, kann man alternativ auf die Daten der Nachbarstation zugreifen.

{{Randnotiz|RNTyp=y|RNText=Neben dem hier vorgestellten Abruf der Weather Underground-Daten mit [[HTTPMOD]] kann auf Weather Underground-Daten auch mit dem darauf spezialisierten Modul [http://fhem.de/commandref.html#Wunderground Wunderground] zugegriffen werden.}}

Dazu sind grundsätzlich die folgenden Schritte notwendig:
* Finden der geeigneten Station
* Auswerten der XML-Daten
* Erstellen passender gplot-Dateien

=== Finden der geeigneten Station ===
Als erstes geht man auf die [http://www.wunderground.com Startseite von Weather Underground] und gibt in das Suchfeld den Namen seines Dörfchens oder der nächsten Stadt ein - für Berlin landet man bspw. auf Seite für "Berlin Alexanderplatz". Es gibt aber manchmal sehr viele Wetterstationen in der direkten Umgebung. Diese findet man indem am auf "Change Station" klickt und sich eine passende Station aussucht. Nähere Infos (zB. zur verwendeten Hard- und Software) zu der gewählten Wetterstation erhält man, wenn man auf den Namen der Station klickt und dann auf "About this PWS".

Weather Underground stellt die Daten der Wetterstation auch über eine API als XML bereit, die wir auswerten können. Die entsprechende URL findet sich ebenfalls unter "About this PWS" unter "Download current conditions XML". Für Berlin Prenzlauer Berg wäre dies z.B.
<code>http://api.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&format=XML</code>.

Entscheidend für die jeweilige Station ist der Teil nach "?=ID", also in diesem Fall "IBERLIN15". Dieser Teil des Links lässt sich leicht durch die ID einer anderen Station ersetzen und die Suche nach dem entsprechenden Link auf der Seite der Station bleibt erspart.

=== Auswerten der XML-Daten ===
Die Auswertung der XML-Daten erfolgt via [[HTTPMOD]]. Da dies nicht ganz trivial ist, sind im Folgenden zuerst die wesentlichen Konfigurationsschritte exemplarisch beschrieben. Weiter unten findet sich dann die fertige vollständige Konfiguration.

Es erstes wird das Device HTTPMOD definiert (die 600 am Schluss ist der Aktualisierungszyklus in Sekunden, also alle 10 min):
:<code>define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600 </code>

Dann werden Attribute für alle Readings definiert:
:<code>attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date ... </code>

Dann wird jedem Attribut ein Name zugewiesen (unter diesem Namen wird der Wert ins Log geschrieben):
:<code>attr wetter_prenzelberg readingsName_cloudiness cloudiness </code>

Zum Schluss wird das Reading selbst definiert:
:<code>attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+) </code>

Die gesamte Konfiguration für alle von der API angebotenen Wetterwerte sieht dann wie folgt aus:
<pre>
define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600
attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date readingsName_dewpointTemperature readingsName_fog readingsName_heatindex readingsName_humidity readingsName_pressure readingsName_solarRadiation readingsName_solarUV readingsName_temperature readingsName_time readingsName_windChill readingsName_windDegrees readingsName_windDirection readingsName_windGust readingsName_windSpeed readingsRegex_cloudiness readingsRegex_date readingsRegex_dewpointTemperature readingsRegex_fog readingsRegex_heatindex readingsRegex_humidity readingsRegex_pressure readingsRegex_solarRadiation readingsRegex_solarUV readingsRegex_temperature readingsRegex_time readingsRegex_windChill readingsRegex_windDegrees readingsRegex_windDirection readingsRegex_windGust readingsRegex_windSpeed
attr wetter_prenzelberg readingsName_cloudiness cloudiness
attr wetter_prenzelberg readingsName_date date
attr wetter_prenzelberg readingsName_dewpointTemperature dewpointTemperature
attr wetter_prenzelberg readingsName_fog fog
attr wetter_prenzelberg readingsName_heatindex heatindex
attr wetter_prenzelberg readingsName_humidity humidity
attr wetter_prenzelberg readingsName_pressure pressure
attr wetter_prenzelberg readingsName_solarRadiation solarRadiation
attr wetter_prenzelberg readingsName_solarUV solarUV
attr wetter_prenzelberg readingsName_temperature temperature
attr wetter_prenzelberg readingsName_time time
attr wetter_prenzelberg readingsName_windChill windChill
attr wetter_prenzelberg readingsName_windDegrees windDegrees
attr wetter_prenzelberg readingsName_windDirection windDirection
attr wetter_prenzelberg readingsName_windGust windGust
attr wetter_prenzelberg readingsName_windSpeed windSpeed
attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_date date date" content="([\d\.]+)
attr wetter_prenzelberg readingsRegex_dewpointTemperature <dewpoint_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_fog fog id="FOG" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_heatindex <heat_index_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_humidity <relative_humidity>([\d\.]+)
attr wetter_prenzelberg readingsRegex_pressure <pressure_mb>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarRadiation <solar_radiation>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarUV <UV>([\d\.]+)
attr wetter_prenzelberg readingsRegex_temperature <temp_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_time time Zeit([\d\:]+)
attr wetter_prenzelberg readingsRegex_windChill <windchill_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_windDegrees <wind_degrees>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windDirection <wind_dir>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windGust <wind_gust_mph>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windSpeed <wind_mph>([\d\.]+)
</pre>
Hinweis: Nicht immer werden alle Werte geliefert (wenn keine Sonne, dann kein UV-Wert...). Im System-Log kann das als Fehler auftauchen, ist aber kein Problem.

=== Erstellen passender gplot-Dateien ===
Um die ausgelesenen Werte als Graphen darstellen zu können müssen eigene gplot-Dateien erstellt werden. Eine grundsätzliche Anleitung dazu findet sich unter [[Creating Plots]]. Deshalb sollen hier nur Beispiele für die eigentlichen gplot-Dateien vorgestellt werden. Beispiele sollten sowohl für [[FileLog]] wie [[DbLog]] funktionieren.

Temperatur und Luftfeuchte:
<pre>
set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
#set title '<L1>'
set title ''
set ytics
set y2tics
set grid ytics
set ylabel "Temperature in C"
set y2label "Humidity (%)"

#FileLog 4:temperature\x3a::
#FileLog 4:windChill\x3a::
#FileLog 4:humidity\x3a::

#DbLog <SPEC1>:temperature::
#DbLog <SPEC1>:windChill::
#DbLog <SPEC1>:humidity::

plot "<IN>" using 1:2 axes x1y1 title 'Temperatur (C)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Gefühlte Temperatur (C)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Luftfeuchtigkeit (%)' ls l2fill lw 0.2 with lines
</pre>

Wind und Windrichtung:
<pre>
set terminal png transparent size <SIZE> crop

set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "

set ytics
set y2tics ("Nord" 0, "Ost" 80, "Süd" 180, "West" 270, "Nord" 360)

#set title '<L1>'
set title ''

set grid xtics ytics

set yrange [0:20]
set y2range [0:360]

set ylabel "Wind (mph)"
set y2label "Richtung"

#FileLog 4:windSpeed:0:
#FileLog 4:windGust:0:
#FileLog 4:windDegrees:0:

#DbLog <SPEC1>:windSpeed::
#DbLog <SPEC1>:windGust::
#DbLog <SPEC1>:windDegrees::

plot "<IN>" using 1:2 axes x1y1 title 'Wind (mph)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Böen (mph)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Windrichtung (°)' ls l2fill lw 0.2 with points
</pre>

Sonnenintensität und UV-Werte:
<pre>
set terminal png transparent size <SIZE> crop

set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "

set ytics
set y2tics

#set title '<L1>'
set title ''

set grid xtics ytics

set ylabel "Sonnenstrahlung (W/qm)"
set y2label "UV"

#FileLog 4:solarRadiation:0:
#FileLog 4:solarUV:0:

#DbLog <SPEC1>:solarRadiation::
#DbLog <SPEC1>:solarUV::

plot "<IN>" using 1:2 axes x1y1 title 'Strahlung' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'UV' ls l1 lw 1.5 with lines
</pre>

'''Weitere TBD'''

=== Vergangene Daten abfragen ===
Ein konkretes vergangenes Datum der Wetterstation kann man übrigens auch abrufen - für den 28.11.2014 wäre dies bspw.
<code>http://www.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&day=28&month=11&year=2014&graphspan=day&format=1</code>.

=== Eigene Wetterdaten hochladen ===
{{Randnotiz|RNTyp=g|RNText=Unterstützung für das Modul gibt es im dazugehörigen {{Link2Forum|Topic=65587|LinkText=Forumsthread }}.}}
Wer eigene Wetterdaten hochladen will, kann hierzu das {{Link2CmdRef|Anker=WUup|Label=Modul WUup}} verwenden. Dazu benötigt man die Zugangsdaten (stationID und Paßwort) für eine eigene Wetterstation. Mit dem Modul können die meisten vom [http://web.archive.org/web/20180815041359/http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol PWS Upload Protocol] unterstützten Daten hochgeladen werden:
* Winddir - [0-360 momentane Windrichtung]
* Windspeedmph - [mph momentane Windgeschwindigkeit]
* Windgustmph - [mph aktuellen Böe, mit Software-spezifischem Zeitraum]
* Windgustdir - [0-360 mit Software-spezifischer Zeit]
* Windspdmph_avg2m - [mph durchschnittliche Windgeschwindigkeit innerhalb 2 Minuten]
* Winddir_avg2m - [0-360 durchschnittliche Windrichtung innerhalb 2 Minuten]
* Windgustmph_10m - [mph Böen der vergangenen 10 Minuten]
* Windgustdir_10m - [0-360 Richtung der Böen der letzten 10 Minuten]
* Feuchtigkeit - [% Außenfeuchtigkeit 0-100%]
* Dewptf- [F Taupunkt im Freien]
* Tempf - [F Außentemperatur]
* Rainin - [in Regen in der vergangenen Stunde]
* Dailyrainin - [in Regenmenge bisher heute]
* Baromin - [inHg barometrischer Druck]
* Soiltempf - [F Bodentemperatur]
* Bodenfeuchtigkeit - [%]
* Solarradiation - [W/m²]
* UV - [Index]
* AqPM2.5 - Feinstaub PM2,5 [µg/m³]
* AqPM10 - Feinstaub PM10 [µg/m³]

Die Werte werden im Modul für Wunderground ins anglo-amerikanische System umgerechnet. Temperaturen werden also automatisch von °Celsius in Fahrenheit, Windgeschwindigkeiten von km/h in mph, mm in Inch und der barometrische Druck von hPa in inHg umgerechnet.

== Wetternetzwerk auf wetter.com ==
Ein vollständiges Beispiel zur Nutzung der Informationen über die Regenmenge (Station 1445, Weinheim) von wetter.com ist in {{Link2Forum|Topic=39600|Message=332837|LinkText=diesem Forenbeitrag}} beschrieben.

== Wetter von netatmo ==
Das FHEM-Modul [[netatmo]] ermöglicht den Datenimport von privaten und öffentlichen netatmo Wetterstationen sowie den Abruf der in der Netatmo App verfügbaren Wettervorhersage. Eine Übersicht über die verfügbaren öffentlichen Stationen findet sich auf der Seite [http://www.netatmo.com/de-DE/weathermap Weathermap]. Die meisten öffentlichen Stationen liefern Temperatur, Luftfeuchte und Luftdruck, einige auch Wind, Regen und Daten zur Luftqualität (CO<sub>2</sub>).

== Links ==
* {{Link2Forum|Topic=33610|LinkText=Forenthema}} mit Sammlung und Beipielen von Internet-Links für die Anzeige von teilweise animierten Wetterbildern
* [http://bloglich.de/art/rpi/wetterdaten-auf-dem-raspberry-pi-in-fhem/ Beispiel in Blog(de)]
* [[HTTPMOD]] [[Kategorie:Code Snippets]] [[Kategorie:HOWTOS]] [[Kategorie:Wetterstationen]]

AutoShuttersControl

2021-06-19T19:14:30Z

50watt: /* Bedingungen */

{{Infobox Modul
|ModPurpose=Steuerung von Rollläden
|ModCategory=Automatisierung
|ModType=d
|ModForumArea=Automatisierung
|ModTechName=73_AutoShuttersControl.pm
|ModOwner=CoolTux ({{Link2FU|13684|Forum}}/[[Benutzer Diskussion:CoolTux|Wiki]])}}
Mit [[AutoShuttersControl]] oder kurz '''ASC''' können Rollläden automatisch hoch und herunter gefahren werden. Zum Beispiel Öffnen bei Sonnenaufgang, Schließen bei Sonnenuntergang, Beschatten abhängig vom Sonnenstand oder Anfahren von Lüftungspositionen nach Öffnen des zugehörigen Fensters.

== Basics ==
{{Hinweis|Das Modul befindet sich derzeit noch in der Entwicklung; der derzeit aktuelle Stand ist diesem {{Link2Forum|Topic=112325|LinkText="Thread im Forum"}} zu entnehmen.}}
Als Voraussetzung sollten folgende FHEM-Devices bereits vorhanden sein:
* Rollläden,
* Fensterkontakte,
* Bewohnerstatus auf Basis von Residents/Roomates in englisch. Ersatzweise andere Devices, z.B. Dummys, welche als ''state'' ''home'', ''absent'', ''asleep'', ''gotosleep'' und ''awoken'' setzen sowie ein Reading ''lastState''.
* Helligkeitssensor (Steuerung nach Helligkeit für Beschattung)
* Ein Device zur Bestimmung des Sonnenstands (nur für Beschattung). Unterstützt werden derzeit [[Modul Astro|Astro]] und [[Twilight]]<ref>Dabei müssen ggf. in [[Global|global]] auch Angaben zu ''longitude'' und ''latitude'' vorhanden sein</ref>.
* Wenn Feiertage berücksichtigt werden sollen: Ein oder mehrere {{Link2CmdRef|Anker=holiday2we|Lang=en|Label=holiday2we}}-Angaben in [[Global|global]] samt entsprechender [[Wochenende, Feiertage und Schulferien#Feiertage mittels holiday-Datei|holiday]]-Dateien<ref>Es kann auch z.B. ein Dummy-Device verwendet werden, dieses sollte dann aber neben dem eigentlichen Feiertags-''state'' auch in einem Reading ''tomorrow'' Angaben zu anstehenden Feiertagen enthalten.</ref> <ref>Bitte verfahren Sie entsprechend, wenn Urlaubs- oder Ferientage wie Feiertage behandelt werden sollen.</ref>.

Die Einrichtung des Moduls bzw. dessen Funktionalität erfolgt in mehreren Schritten:
* Definition des ASC-Devices
* Einstellung zentraler Vorgaben am ASC-Device
* Markieren der zukünftig zu steuernden Rollladen-Devices
* Einbinden der Rollladen-Devices in das ASC-Device
* Einstellen der individuellen Vorgaben je Rollladen (am Rollladen-Device)
Dabei geht man am einfachsten schrittweise vor und erweitert die Funktionalität nach und nach um die gewünschten Funktionen. Dann benötigt man jeweils nur einen kleinen Teil der vielen per Attribut einstellbaren Optionen, und kann die Auswirkungen der jeweiligen Änderung besser nachvollziehen.

== Einrichtung ==
{{Hinweis|ASC kann auch verwendet werden, um lediglich Teilaufgaben der Rollladensteuerung zu erfüllen, also z.B. nur das morgendliche Öffnen der Rollläden. Allerdings geht dabei ein erheblicher Teil des Komforts verloren, der dadurch entsteht, dass die Steuerung innerhalb der vollintegrierten Lösung jeweils nachvollzieht, aus welchem Grund eine Fahrt erfolgt war und dies ggf. bei der nächsten Aktion berücksichtigt.}}

=== Vorbereitung ===
Zunächst sollten die in den [[#Basics|Basics]] beschriebenen Geräte vorhanden und funktionsfähig sein.

=== Define des ASC-Devices ===
Es genügt ein einfaches define ohne weitere Parameter.
<code>define <name> AutoShuttersControl</code>
Dies bewirkt neben der Anlage des Devices selbst auch, dass als weiteres globales Attribut ''ASC'' verfügbar wird.

=== Einstellung zentraler Vorgaben ===
Mit Attributen am ASC-Device wird das Verhalten des ASC-Devices eingestellt, z.B. Vermeiden von morgendlichen oder abendlichen Fahrten, Frostschutzfunktion bei Gefahr von festgefrorenen Rollläden oder die Reaktion auf Fensterkontakte. Details sind der Commandref zu entnehmen.
Diese Attribute können jederzeit geändert werden.

=== Auswählen zu steuernder Rollladen-Devices ===
Für jeden vom ASC-Device kontrollierten Rollladen muss das globale Attribut ''ASC'' gesetzt werden. Das steht nach dem Definieren des ASC-Devices zur Verfügung. Das Attribut ist mit 1 oder 2 festzulegen:
# Je ''kleiner'' der <code>pct</code> Wert um so weiter ist der Rollladen geschlossen. Typischerweise ist dann 0 ''offen'' und 100 ''geschlossen''. Dies ist z.B. die passende Wahl für ROLLO-Devices
# Je ''größer'' der <code>pct</code> Wert desto weiter ist der Rollladen geschlossen, also ''offen'' für <code>set <name> pct 100</code>. Typische Vertreter dieses Typs sind HomeMatic (CUL_HM-) Geräte oder die Shelly2-Aktoren.

Basierend auf dem Parameter leitet das Modul bestimmte Voreinstellungen (''defaults'') für den Rollladen ab. Es genügt daher, nur jeweils die Einstellungen zu verändern, die anders gewünscht werden oder für den Rollladenaktortyp anders sein müssen (z.B. ''dim 99'' für vollständiges Öffnen eines ZWave-Aktors).
{{Hinweis|Das Vorstehende gilt jeweils für den nicht-invertierten Modus! Wer z.B. ein HomeMatic-Gerät mit ''levelinverse'' betreibt, sollte ''ASC'' auf "1" setzen usw.. Maßgeblich ist letztlich nur die Frage, ob die Offen-Positionsangabe nummerisch kleiner oder größer als die Geschlossen-Positionsangabe ist; die konkreten Zahlenwerte spielen dabei keine Rolle, die Angabe ''position'' oder ''pct'' kann auch später über ein weiteres Attribut passend eingestellt werden.}}

=== Einbinden in das ASC-Device ===
Nachdem das ASC Attribut für die betreffenden Rollladen-Devices gesetzt ist, muss mit <code>set <name> scanForShutters</code> ein Suchlauf gestartet werden, mit dem diese Rollläden in die Steuerungslogik eingebunden werden.

=== Einstellen der individuellen Vorgaben ===
Die gefundenen Rollladen-Devices erhalten weitere Attribute, mit denen für den jeweiligen Rollladen benötigte Einstellungen vorgenommen werden.
Diese Attribute sind in der commandref beschrieben.

== Readings ==
===Readings im zentralen ASC-Device ===

{| class="wikitable"
|-
! Name !! Datentyp/<BR />Wertebereich !! Bedeutung
|-
|..._nextAstroTimeEvent || || Zeit wird abhängig von der eingestellten Attribute ASC_Time_Up/ASC_Time_Down angezeigt. Bei ''astro'' die Uhrzeit des Sonnenauf- oder Sonnenuntergang, bei ''time'' und ''brightness'' die Zeit aus ASC_Time_Up_Early/ASC_Time_Down_Late pro Rollonamen
|-
|..._lastPosValue || || Position pro Rollonamen, bevor ASC die Rollläden verfahren hat.
|-
|..._PosValue || ||aktuelle Position pro Rollonamen.
|-
|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 Rollläden mit dem Attribut bei denen das Attributs ASC_LockOut entsprechend auf hard gesetzt ist.
|-
|selfDefense || on, off ||globale Selbstschutzfunktion aktiv oder inaktiv
|-
|partyMode ||on, off || globaler Partymodus aktiv oder inaktiv
|-
|state || ||Status des ASC-Devices: active, enabled, disabled oder weitere Statusinformationen wie z.B. Grund der letzen Fahrt.
|-
|room_... || ||Auflistung aller Rollläden, welche in den jeweiligen Räumen gefunden wurden, Bsp.: room_Schlafzimmer,Terrasse.
|-
|sunriseTimeWeHoliday|| on,off ||globale Wochenendunterstützung aktiv oder inaktiv.
|-
|userAttrList || rolled out ||Das ASC-Modul verteilt an die gesteuerten Rollladen-Geräte diverse Benutzerattribute (userattr). In diesem Reading kann der Status dieser Verteilung geprüft werden.

|}

=== Readings in den Rolllädendevices ===

{| class="wikitable"
|-
! Name !! Bedeutung
|-
|ASC_Enable ||Status von ASC_Enable (on,off).
|-
|ASC_ShuttersLastDrive ||Grund der letzten Fahrt des Rollladens.
|-
|ASC_Time_DriveDown ||Zeit wird abhängig von der eingestellten Attribute ASC_Time_Down angezeigt. Bei astro die Uhrzeit des Sonnenuntergangs, bei time und brightness die Zeit aus /ASC_Time_Down_Late
|-
|ASC_Time_DriveUp ||Zeit wird abhängig von der eingestellten Attribute ASC_Time_Up angezeigt. Bei astro die Uhrzeit des Sonnenaufgangs, bei time und brightness die Zeit aus /ASC_Time_Up_Early
|}

==set- und get-Befehle für das ASC-Device==
=== set-Anweisungen ===
{| class="wikitable"
|-
! Name !! Datentyp/<BR />Wertebereich !! Beschreibung
|-
|advDriveDown ||on, off ||Nachholen der durch ASC_Adv on ausgesetzten Fahrten.
|-
|ascEnable||on, off ||Aktiviert oder deaktiviert die globale 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 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
|-
|renewAllTimer || ||Erneuert bei allen Rollläden die Zeiten gemäß ASC_UP/ASC_DOWN und setzt die internen Timer neu.
|-
|renewTimer || ||Erneuert bei dem ausgewählten Rollladen die Zeiten gemäß ASC_UP/ASC_DOWN und setzt die internen Timer neu.
|-
|scanForShutters || ||Sucht alle FHEM Devices mit dem Attribut ''ASC'' ''1'' oder ''2'' und legt diese im ASC-Modul an
|-
|selfDefence ||on, off||Aktiviert bzw. deaktiviert die Selbstschutzfunktion. Beispiel 1: Wenn das Residents-Gerät ''gone'' meldet, alle Rollläden dann heruntergefahren. Beispiel 2 : Wenn das Residents-Gerät ''absent'' meldet, das Attribut ASC_ShuttersPlace=terrace ist und ein Fenster im Haus noch geöffnet ist, so wird an diesem Fenster der Rollladen dann heruntergefahren.
|-
|shutterASCenableToggle || ||Aktivieren oder deaktivieren der ASC Kontrolle des einzelnen Rollladens.
|-
|sunriseTimeWeHoliday || on,off ||Aktiviert die Wochenendunterstützung. Dann wird das Attribut ASC_Time_Up_WE_Holiday am Rollladen-Device beachtet.
|-
|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-Anweisungen ===

{| class="wikitable"
|-
! Name !! Beschreibung
|-
| showNotifyDevsInformations ||Zeigt eine Übersicht der abgelegten NOTIFYDEV Struktur. Diese Funktion wird für das Debugging genutzt. Hierzu ist das Attribut ASC_expert = 1 zu setzen.
|}

== Attribute ==
{{Hinweis|Die Attributnamen haben sich teilweise geändert, nachfolgend ist der Stand von Modulversion v0.8.x wiedergegeben.}}
{{Hinweis|In der commandref findet sich häufig die Schreibweise <code><nowiki>ASC_BrightnessSensor Sensorname[:brightness [400:800]]</nowiki></code>. Dabei sind die Angaben in den eckigen Klammern optional. Dies müssen also nicht angegeben werden, stattdessen verwendet das Modul dann Standardwerte (siehe cref), die in der cref zu findenden Angaben entsprechen dabei den defaults. Werden Werte angegeben, sind die eckigen Klammern '''wegzulassen'''! Beispiel: <code>ASC_BrightnessSensor hm_motion_1 70:100</code> würde das brightness-Reading des Sensors hm_motion_1 verwenden und einen morgendlichen Schwellenwert von 70 bzw. 100 für abends.}}
===Attribute direkt am ASC-Device ===

{| class="wikitable"
|-
! Name !! Datentyp/<BR />Wertebereich !! Default-Wert !! Beschreibung
|-
|ASC_autoAstroModeEvening || ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON ||nach welchem ASTRO-Modus soll die Abendfahrt berechnet werden
|-
|ASC_autoAstroModeEveningHorizon || - 9 bis 9 || 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeEvening der Wert HORIZON ausgewählt wurde.
|-
|ASC_autoAstroModeMorning || ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON || nach welchem ASTRO-Modus soll die Morgendfahrt berechnet werden
|-
|ASC_autoAstroModeMorningHorizon || - 9 bis 9|| 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeMorning der Wert HORIZON ausgewählt wurde.
|-
|ASC_autoShuttersControlComfort ||on, off || 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.
|-
|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 || || || Werte (z.B. Lux) 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 ||0, 1 || 0||Aktiviert die erweiterte Logausgabe für Debugausgaben (nur nach Aufforderung nutzen)
|-
|ASC_expert ||0, 1 ||0 ||ist der Wert 1, so werden erweiterte Informationen bezüglich des NotifyDevs unter ''set und get'' angezeigt
|-
|ASC_freezeTemp ||-5 bis 5 || ||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_shuttersDriveDelay || || ||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.
|-
| || || ||
|-
| || || ||
|}

===Attribute in den Rolllädendevices===

{| class="wikitable"
|-
! Name !! Datentyp/<BR />Wertebereich !! Default-Wert !! Beschreibung
|-
|ASC || 0, 1, 2|| ||"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_Adv || on, off||||bei on wird das runterfahren des Rollos während der Weihnachtszeit (1. Advent bis 6. Januar) ausgesetzt! Durch set <ASCDEVICE> advDriveDown werden alle ausgesetzten Fahrten nachgeholt.
|-
|ASC_Antifreeze ||off, soft, hard, am, pm || ||Frostschutz, wenn soft fährt der Rollladen in die ASC_Antifreeze_Pos, bei hard/am/pm wird gar nicht oder innerhalb der entsprechenden Tageszeit nicht gefahren
|-
|ASC_Antifreeze_Pos || || ||Position des Rolllades die angefahren werden soll, wenn der Fahrbefehl komplett schließen lautet, aber der Frostschutz aktiv ist !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_autoAstroModeEvening ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON || ||nach welchem ASTRO-Modus soll die Abendfahrt berechnet werden
|-
|ASC_autoAstroModeEveningHorizon || - 9 bis 9 || 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeEvening der Wert HORIZON ausgewählt wurde.
|-
|ASC_autoAstroModeMorning ||REAL, CIVIL, NAUTIC, ASTRONOMIC oder HORIZON || || nach welchem ASTRO-Modus soll die Morgendfahrt berechnet werden
|-
|ASC_autoAstroModeMorningHorizon || - 9 bis 9|| 0|| Höhe über dem Horizont. Wird nur berücksichtigt, wenn im Attribut ASC_autoAstroModeMorning der Wert HORIZON ausgewählt wurde.
|-
|ASC_BlockingTime_afterManual || ||1200 ||wie viel Sekunden soll die Automatik nach einer manuellen Fahrt aussetzen
|-
|ASC_BlockingTime_beforeDayOpen || ||3600 ||wie viel Sekunden vor dem morgendlichen öffnen soll keine schließen Fahrt mehr stattfinden.
|-
|ASC_BlockingTime_beforeNightClose || ||3600 ||ie viel Sekunden vor dem nächtlichen schließen soll keine öffnen Fahrt mehr stattfinden.
|-
|ASC_BrightnessSensor || ||none ||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
|-
|ASC_Closed_Pos || ||default Vorgabe ist abhängig vom Attribut ''ASC''||in 10er-Schritten von 0 bis 100
wird angefahren wenn SelfDefense aktiv ist
|-
|ASC_ComfortOpen_Pos || || || in 10er Schritten von 0 bis 100 !!! Die eingestellte Position wird bei einem threestate Sensor angefahren. Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_Down || time, astro, brightness, roommate || astro||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.
|-
|ASC_DiveUpMaxDuration || || 60||die Dauer des Hochfahrens des Rollladens plus 5 Sekunden
|-
|ASC_Drive_Delay || || -1|| 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
|-
|ASC_Drive_DelayStart || || -1|| in Sekunden verzögerter Wert ab welchen dann erst das Offset startet und dazu addiert wird. Funktioniert nur wenn gleichzeitig ASC_DriveDelay gesetzt wird.
|-
|ASC_ExternalTrigger || |||| DEVICE:READING VALUEACTIVE:VALUEINACTIVE POSACTIVE:POSINACTIVE, Beispiel: "WohnzimmerTV:state on:off 66:100" bedeutet das wenn ein "state:on" Event kommt soll das Rollo in Position 66 fahren, kommt ein "state:off" Event soll es in Position 100 fahren. Es ist möglich die POSINACTIVE weg zu lassen dann fährt das Rollo in LastStatus Position.
|-
|ASC_GuestRoom || on, off |||| aktuell noch nicht umgesetzt...
|-
|ASC_LockOut || soft, hard, off ||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
|-
|ASC_LockOut_Cmd || inhibit, blocked, protection ||none|| set Befehl für das Rollladen-Device zum Hardware sperren. Dieser Befehl wird gesetzt werden, wenn man "ASC_LockOut" auf hard setzt
|-
|ASC_Mode_Down ||absent, always, off, home || always ||Wann darf die Automatik steuern. immer, niemals, bei Abwesenheit des Roommate (ist kein Roommate und absent eingestellt, wird gar nicht gesteuert)
|-
|ASC_Mode_Up ||absent, always, off, home || always ||Wann darf die Automatik steuern. immer, niemals, bei Abwesenheit des Roommate (ist kein Roommate und absent eingestellt, wird gar nicht gesteuert)
|-
|ASC_Open_Pos || ||default Vorgabe ist abhängig vom Attribut ''ASC''||in 10er-Schritten von 0 bis 100
|-
|ASC_Partymode || on, off || 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ühr
|-
|ASC_Pos_Reading || || ||Name des Readings, welches die Position des Rollladen in Prozent angibt. Wird bei unbekannten Device-Typen auch als ''set'' Befehl zum Fahren verwendet
|-
|ASC_PrivacyDownValue_beforNightClose || || -1||wie viele Sekunden vor dem abendlichen schließen soll der Rollladen in die Sichtschutzposition fahren, oder bei Brightness ab welchem minimum Brightnesswert soll das Rollo in die Privacy Position fahren. Bei Brightness muss zusätzlich zum Zeitwert der Brightnesswert mit angegeben werden 1800:300 bedeutet 30 min vor night close oder bei unter einem Brightnesswert von 300
|-
|ASC_PrivacyDown_Pos || ||50||Position den Rollladens für den abendlichen Sichtschutz!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_PrivacyUpValue_beforDay || || -1||wie viele Sekunden vor dem morgendlichen öffnen soll der Rollladen in die Sichtschutzposition fahren, oder bei Brightness ab welchem minimum Brightnesswert soll das Rollo in die Privacy Position fahren. Bei Brightness muss zusätzlich zum Zeitwert der Brightnesswert mit angegeben werden 1800:600 bedeutet 30 min vor day open oder bei über einem Brightnesswert von 600
|-
|ASC_PrivacyUp_Pos || ||50||Position den Rollladens für den morgendlichen Sichtschutz!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_RainProtection ||on, off || ||soll der Rollladen beim Regenschutz beachtet werden. on=JA, off=NEIN.
|-
|ASC_Roommate_Device || || none ||mit Komma getrennte Namen des/der Roommate-Device/s welche den/die Bewohner des Rollladen-Raumes wiedergibt. Macht nur Sinn in Schlaf- oder Kinderzimmern
|-
|ASC_Roommate_Reading || || ||Reading des Roommate-Device, welches den Status wieder gibt
|-
|ASC_Self_Defense_AbsentDelay || || 300||um wie viele Sekunden soll das fahren in Selfdefense bei Residents absent verzögert werden
|-
|ASC_Self_Defense_Mode || || gone||ab welchen Residents Status soll Selfdefense aktiv werden ohne das Fenster auf sind
|-
|ASC_Shading_InOutAzimuth || ||95:265 ||Azimut Wert ab dem bei Überschreiten Beschattet und bei Unterschreiten Endschattet werden soll
|-
|ASC_Shading_MinMax_Elevation || ||25.0:100.0 ||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
|-
|ASC_Shading_MinOutsideTemperature_ || ||18 ||ab welcher Temperatur soll Beschattet werden, immer in Abhängigkeit der anderen einbezogenen Sensorwert
|-
|ASC_ShadingMode ||absent, always, off, home || off||wann soll die Beschattung nur stattfinden
|-
|ASC_Shading_Pos || || ||Position des Rollladens für die Beschattung !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss eine positive Zahl/Dezimalzahl sein!!!
|-
|ASC_Shading_StateChange_SunnyCloudy || ||35000:20000 ||Brightness Wert ab welchen die Beschattung stattfinden und aufgehoben werden soll, immer in Abhängigkeit der anderen einbezogenen Sensorwerte
|-
|ASC_Shading_WaitingPeriod || ||1200 ||wie viele Sekunden soll gewartet werden bevor eine weitere Auswertung der Sensordaten für die Beschattung stattfinden soll
|-
|ASC_Shutter_IdleDetection || ||||READING:VALUE gibt das Reading an welches Auskunft über den Fahrstatus des Rollos gibt, sowie als zweites den Wert im Reading welcher aus sagt das das Rollo nicht fährt
|-
|ASC_ShuttersPlace || window, terrace || ||wenn dieses Attribut auf ''terrace'' gesetzt ist und das Residents-Device in den Status ''absent'' geht, ''selfDefence'' aktiv ist und das Fenster geöffnet ist, wird das Rollo geschlossen. Wenn ein twostate Senso genutzt wird und dieses Attribut auf ''terrace'' gesetzt ist wird ASC_Ventilate_Pos ignoriert und das Rollo wird beim öffnen des Fenster komplett geöffnet. Wenn dieses Attribut auf ''window'' gesetzt ist wird ASC_Ventilate_Pos berücksichtigt und das Rollo wird entsprechend der ASC_Ventilate_Pos geöffnet. Wenn das Fenster wieder geschlossen wird, dann wird das Rollo unabhängig von ''windows oder terrace'' vollständig geschlossen.
|-
|ASC_Sleep_Pos || || ||in 10er-Schritten von 0 bis 100, default Vorgabe ist abhängig vom Attribut ''ASC.'' Position wird angefahren wenn Bedingung für modeDown aktiv ist. Hiermit kann z.B. das komplette abendliche Schließen des Rollos begrenzt werden.
|-
|ASC_TempSensor || || ||DEVICENAME[:READINGNAME] - der Inhalt ist eine Kombination aus Device und Reading für die Außentemperatur
|-
|ASC_Time_Down_Early || ||16:00 ||Sonnenuntergang frühste Zeit zum Runterfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Down_Late || ||22:00 ||Sonnenuntergang späteste Zeit zum Runterfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Up_Early || || 05:00||Sonnenaufgang frühste Zeit zum Hochfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Up_Late || ||08:30 ||Sonnenaufgang späteste Zeit zum Hochfahren !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Time_Up_WE_Holiday || ||08:00 ||Sonnenaufgang frühste Zeit zum Hochfahren am Wochenende und/oder Urlaub (holiday2we wird beachtet).ACHTUNG!!! in Verbindung mit Brightness für ASC_Up muss die Uhrzeit kleiner sein wie die Uhrzeit aus ASC_Time_Up_Late !!!Verwendung von Perlcode ist möglich, dieser muss in {} eingeschlossen sein. Rückgabewert muss ein Zeitformat in Form HH:MM[:SS] sein!!!
|-
|ASC_Ventilate_Window_Open ||on, off ||on||auf lüften, wenn das Fenster gekippt/geöffnet wird und aktuelle Position unterhalb der Lüften-Position ist
|-
|ASC_WiggleValue || ||5 ||Wert, um welchen sich die Position des Rollladens bei ''Wiggle'' ändern soll
|-
|ASC_WindParameters || ||5 ||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_WindProtection ||on, off || ||soll der Rollladen beim Windschutz beachtet werden. on=JA, off=NEIN.
|-
|ASC_WindowRec || ||none ||Name des Fensterkontakts, an welchen Fenster der Rollladen angebracht ist. WINDOWREC:[READING], Name des Fensterkontaktes, an dessen Fenster der Rollladen angebracht ist. Reading ist optional
|-
|ASC_WindowRec_PosAfterDayClosed ||open, lastManual ||open ||Name des Fensterkontakts, an welchen Fenster der Rollladen angebracht ist. Sein Reading ''state'' muss die Werte ''open'', ''closed'' oder ''tilted'' enthalten.
|-
|ASC_WindowRec_subType ||twostate, threestate ||twostate||Typ des verwendeten Fensterkontaktes: twostate (optisch oder magnetisch) oder threestate (Drehgriffkontakt)
|-
| || || ||
| || || ||
|-
| || || ||
|-
| || || ||
|-
| || || ||
|}

== Hilfsmittel ==
{{Hinweis|Die Device-Namen sind auf die eigene Installation anzupassen.}}

{{Hinweis|Codezeilen sind im [[Import von Code Snippets|RAW]]-Format.}}

{{Randnotiz|RNTyp=g|RNText= Stand 2019-05-03
* Erfolgreich getestet mit Homematic Devices, Beta-User
* Die Farbgebung entspricht dem Standard, wenn unter dem Style f18 der Farbpreset ''light'' gewählt wird.
}}

=== readingsGroup für Level ===
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Level readingsGroup <Gerät>,<Stand>,<Schliessen bis>,<Öffnen auf>,<Beschattung>,<Komfort>,<Lüften>,<Privacy> (Rollladen_.*|Jalousie_.*)..:level,!?ASC_Closed_Pos,!?ASC_Open_Pos,!?ASC_Shading_Pos,!?ASC_ComfortOpen_Pos,!?ASC_Ventilate_Pos,!?ASC_PrivacyDown_Pos
attr rg_ASC_Rolllaeden_Level commands {level => 'pct:selectnumbers,0,5,100,0,lin',\
ASC_Closed_Pos => 'ASC_Closed_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Open_Pos => 'ASC_Open_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Pos => 'ASC_Shading_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:selectnumbers,0,5,100,0,lin',\
ASC_ComfortOpen_Pos => 'ASC_ComfortOpen_Pos:selectnumbers,0,5,100,0,lin',\
ASC_PrivacyDown_Pos => 'ASC_PrivacyDown_Pos:selectnumbers,0,5,100,0,lin'}
</pre>

=== readingsGroup für Zeiten ===
[[Bild:ReadingsGroup ASC times.png|thumb|right|ReadingsGroup - Zeitenbeispiel]]
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Times readingsGroup <Gerät>,<Position>,<Time_Up_Early>,<Time_Up_Late>,<Time_Up_WE/Hol>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up> \
(.*Rollo.*|.*Rollladen|Jalousie_.*):level,!?ASC_Time_Up_Early,!?ASC_Time_Up_Late,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up
attr rg_ASC_Rolllaeden_Times commands {level => 'pct:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100', \
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00', \
ASC_Time_Down_Late => 'ASC_Time_Down_Late:19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30', \
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',\
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:55,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Time_Up_Late => 'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off', \
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off' }
attr rg_ASC_Rolllaeden_Times room Rollladen</pre>

[[Bild:ASC RG Zeiten HM ZWave Siro.png|thumb|right|ReadingsGroup - CUL_HM+ZWave+Siro mit widgets]]Neue Version mit time-Widgets und pct/dim/position-widget (5-er Schritte), passend für CUL_HM, ZWave und Siro-Geräte:
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Times readingsGroup <Gerät>,<Stand>,<Time_Up_Early >,<Time_Up_WE >,<Time_Up_Late >,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up> (Rollo_.*|Jalousie_.*)..:(level|dim|position),!?ASC_Time_Up_Early,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Up_Late,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up
attr rg_ASC_Rolllaeden_Times commands {level => 'pct:selectnumbers,0,5,100,0,lin', \
dim => 'dim:selectnumbers,0,5,99,0,lin',\
position => 'pct:selectnumbers,0,5,99,0,lin',\
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off',\
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off',\
ASC_Time_Down_Early => 'ASC_Time_Down_Early:time', \
ASC_Time_Down_Late => 'ASC_Time_Down_Late:time',\
ASC_Time_Up_Early => 'ASC_Time_Up_Early:time', \
ASC_Time_Up_Late =>'ASC_Time_Up_Late:time',\
ASC_Time_Up_WE_Holiday =>'ASC_Time_Up_WE_Holiday:time'}
attr rg_ASC_Rolllaeden_Times room Rollladen
</pre>

=== readingsGroup für die Beschattung ===
[[Datei:Shading.png.png|alternativtext=|mini|ReadingsGroup - Beschattungsbeispiel]]
<pre style="width:65%;word-wrap: break-word;">
defmod RG_test readingsGroup <Gerät>,<InAzi>,<OutAzi>,<MinEle>,<MaxEle>,<Sunny>,<Cloudy>\
(Rollo|Jalousie)_.*..:<{ascAPIget('ShadingAzimuthLeft',$DEVICE)}>,<{ascAPIget('ShadingAzimuthRight',$DEVICE)}>,<{ascAPIget('ShadingMinElevation',$DEVICE)}>,<{ascAPIget('ShadingMaxElevation',$DEVICE)}>,<{ascAPIget('ShadingStateChangeSunny',$DEVICE)}>,<{ascAPIget('ShadingStateChangeCloudy',$DEVICE)}></pre>

=== readingsGroup für FIBARO Roller Shutter FGR-222 Devices ===
{{Randnotiz|RNTyp=g|RNText=Getestet von majestro84, Stand 2019-01-28.
* {{Link2Forum|Topic=92628|Message=897099|LinkText=Forenbeitrag dazu}}
* Die Farbgebung entspricht dem Standard, wenn unter dem Style f18 der Farbpreset ''dark'' gewählt wird}}
[[Bild:ASC Jalousien Times.JPG|thumb|right|Beispiel]]
<pre style="width:65%;word-break: break-all;word-wrap: break-word;">define ASC_Jalousien_Times readingsGroup <Gerät>,<Stand>,<Time_Up_Early>,<Time_Up_WE>,<Time_Up_Late>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up>,<PartyMode>,<LockOut> (.*_Jalousie.*):position,!?ASC_Time_Up_Early,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Up_Late,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up,!?ASC_Partymode,!?ASC_LockOut

attr ASC_Jalousien_Times commands {position => 'dim:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off',
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off',
ASC_Partymode => 'ASC_Partymode:on,off',
ASC_LockOut => 'ASC_LockOut:soft,hard,off',
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00',
ASC_Time_Down_Late => 'ASC_Time_Down_Late:20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30',
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:45,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_Late =>'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00'}
attr ASC_Jalousien_Times room Jalousien</pre>

[[Bild:ASC Jalousien Level.JPG|thumb|right|Beispiel]]
<pre style="width:65%;word-break: break-all;word-wrap: break-word;"> define Jalousien_Level readingsGroup <Gerät>,<Closed_Pos>,<Open_Pos>,<Comfort_Pos>,<Ventilate_Pos>,<PrivacyDown_Pos>,<Shading_Pos> (.*_Jalousie.*):!?ASC_Closed_Pos,!?ASC_Open_Pos,!?ASC_ComfortOpen_Pos,!?ASC_Ventilate_Pos,!?ASC_PrivacyDown_Pos,!?ASC_Shading_Pos
attr Jalousien_Level commands { ASC_Closed_Pos => 'ASC_Closed_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Open_Pos => 'ASC_Open_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_ComfortOpen_Pos => 'ASC_ComfortOpen_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_PrivacyDown_Pos => 'ASC_PrivacyDown_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Shading_Pos => 'ASC_Shading_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99'}
attr Jalousien_Level room Jalousien</pre>

== Einrichtungsbeispiel (nach Sonnenstand) ==
=== Ziel und Vorgaben ===
Es sollen die Rollläden und Jalousien innerhalb bestimmter zeitlicher Perioden sonnenstandsabhängig geöffnet und geschlossen werden. An den Wochenenden und an Ferientagen soll etwas später geöffnet werden. Es sind Tür- und Fensterkontakte vorhanden (Türkontakte: twoState, Fensterkontakte: threeState), wobei bei jeder Öffnung ein eventuell geschlossener Rollladen geöffnet werden soll. Bei allen Rollladenaktoren, Tür- und Fensterkontakten handelt es sich um CUL_HM-Geräte.

=== Vorarbeiten ===
Im global-Device sind Angaben zu latitude und longitude vorhanden, holiday2we wie folgt<ref>''ferien'' ist eine automatisiert erstellte holiday-Datei nach diesem {{Link2Forum|Topic=85759|Message=885883|LinkText=Foren-Beitrag}}.</ref>:
attr global holiday2we bw,ferien
Weitere Angaben werden zunächst nicht benötigt, das Astro-Device wird erst in der Beschattungskonfiguration definiert.
Dann erfolgt das ''Define des ASC-Devices'' wie oben beschrieben:
<code>define Rollladenautomatik AutoShuttersControl</code>
Folgen die einzubindenden Rollladenaktoren einem einheitlichen Namensschema, können diese sodann z.B. mit
attr (Jalousie|Rollladen)_.* ASC 2
auf einen Rutsch mit dem passenden ASC-Typ gekennzeichnet werden.

{{Hinweis|Achtung: Das AutoShuttersControl-Device selbst darf kein ASC-Attribut bekommen!}}

Dann werden mit
set Rollladenautomatik scanForShutters
die nachfolgend weiter zu bearbeitenden Attribute angelegt.
=== Schließen morgens und abends ===
{{Randnotiz|RNTyp=g|RNText=Alternative: Fahren nach brightness:
Soll insgesamt oder an einzelnen Rollläden helligkeitsgesteuert gefahren werden, muß zentral oder für jeden Rollladen ein Helligkeitssensor definiert und die Helligkeitsgrenzwerte festgelegt sein (''ASC_BrightnessSensor'' etc.), bei deren Überschreitung geöffnet bzw. Unterschreitung geschlossen werden soll.}}
==== Konfiguration des ASC-Devices ====
Sonnenstandsabhängige Fahrzeiten werden wie folgt aktiviert:
<pre>
attr Rollladenautomatik ASC_autoAstroModeEvening CIVIL
attr Rollladenautomatik ASC_autoAstroModeMorning CIVIL
</pre>
Aus der Angabe ''CIVIL'' und den Vorgaben in den einzelnen Rollladen wird dabei mit Hilfe von [[SUNRISE_EL]] die effektive Fahrzeit berechnet, dort finden sich auch weitere Hinweise, zu den meisten anderen Optionen für die ersten beiden Attribute.
Bei allen Fensteröffnungen soll auf eine Lüften-Position gefahren werden, also schalten wir diese Funktion ebenfalls zentral an<ref>Sonst wird bei threeState-Sensoren nur bei ''tilted'' auf die in ''ASC_Ventilate_Pos'' gefahren.</ref>:
attr Rollladenautomatik ASC_autoShuttersControlComfort on
Zuletzt legen wir noch einen Temperatur-Sensor fest. Dieser wird beim Frostschutz sowie bei der Beschattung berücksichtigt.
<pre>
attr Rollladenautomatik ASC_tempSensor Aussentemperatur_Nord:temperature
attr Rollladenautomatik ASC_freezeTemp 3
</pre>{{Hinweis|Achtung: Für jede weitere Sensor-Information (z.B. zu Regen oder Wind) muß ein eigenes Device verwendet werden. Sollen unterschiedliche Readings desselben Sensors ausgewertet werden, müssen diese in ein eigenes Device übertragen werden, z.B. über einen readingsProxy mit gesetztem event-on-update-reading-Attribut (sonst triggert dieser nicht bei Aktualisierung des Readings)!}}

tbd:
* Rain
* Wind
==== Konfiguration der Rollladendevices ====
{{Hinweis|Positionen dürfen sich innerhalb eines Rollos nicht überschneiden - Auch ASC_Closed_Pos 100 ASC_Shading_Pos 98 ASC_ComfortOpen_Pos 97 usw... sind bereits unterschiedliche Positionen.}}

===== Fahrzeiten =====
Zur Konfiguration der Fahrzeiten bietet es sich an, eine ReadingsGroup zu nutzen, wie unter [[#Hilfsmittel|Hilfsmittel]] dargestellt. Alternativ kann man die Zeiten auch manuell in den einzelnen Rollläden hinterlegen.
===== Bewohner =====
Wird ein Raum von einer oder mehreren bestimmten Person/en bewohnt oder gibt es ein Sammel-Gerät für mehrere Bewohner, kann dies mit den Attributen ''ASC_Roommate_Device'' und ''ASC_Roommate_Reading'' einem Rollladen zugeordnet werden. Ist einer der Bewohner ''asleep'', wird morgens erst geöffnet, wenn auch der letzte Roommate nicht mehr ''asleep'' ist.
===== Fensterkontakte =====
Dann werden ggf. vorhandene Fensterkontakte mit ''ASC_WindowRec'' zugeordnet und der Sensortyp mit ''ASC_WindowRec_subType'' festgelegt. Im Falle von threeState-Sensoren wird das übergreifende ''ASC_autoShuttersControlComfort'' beachtet, wobei dann bei vollständiger Öffnung des Fensters auf den in ''ASC_ComfortOpen_Pos'' festgelegten Wert gefahren wird.
===== Frostschutz =====
Zuletzt können die Attribute ''ASC_Antifreeze'' und ''ASC_Antifreeze_Pos'' festgelegt werden, wenn die Frostschutzfunktion aktiviert werden soll.

=== Beschattung ===
==== Konfiguration des ASC-Devices ====
Im ASC DEVICE das Reading "controlShading" auf ''on'', sowie ein Astro/Twilight Device im Attribut "ASC_twilightDevice" und das Attribut "ASC_tempSensor" definieren.

==== Konfiguration der Rollladendevices ====
Es wird ein Helligkeitssensor als Attribut "ASC_BrightnessSensor" benötigt. Wird der Sensor nur für die Beschattung verwendet, ist der Wert DEVICENAME[:READING] ausreichend.
Alle weiteren Attribute sind optional und wenn nicht gesetzt mit Default-Werten belegt. Sie sollten entsprechend der Gegebenheiten angepasst werden. Die Werte für die Fensterposition und den Vor-/Nachlaufwinkel ''(ASC_Shading_InOutAzimuth)'' sowie die Grenzwerte für <code>''ASC_shading_StateChange_SunnyCloudy''</code> sind besonders wichtig.

==== Bedingungen ====
Damit die Beschattung startet müssen '''alle''' Bedingungen erfüllt sein. Entschattet wird, sobald '''eine''' der Bedingungen wegfällt und die Zeit entsprechend <code>ASC_Shading_WaitingPeriod</code> abgelaufen ist.

Der Sonnensensor <ASC_BrightnessSensor> muss mindestens zwei Messwerte geliefert haben, bevor das ASC-Modul in die Beschattungsposition fährt! Beim (zeitlich) ersten Messwert wird der Zustand ''in-reserved'' gesetzt. Erst beim zweiten Messwert wechselt der Zustand nach ''in shading''. Die Anzahl der berücksichtigten Messwerte ist abhängig vom "moving average window", der mit dem dritten Parameter des Attributs ''ASC_Shading_StateChange_SunnyCloudy'' konfiguriert wird.

'''Von Standardwerten ausgehend ist nachfolgender Ablauf angestrebt:'''
# Ein Event vom Astro oder Helligkeits Device kommt -> sind alle Werte innerhalb des Arbeitsbereiches, ändert sich der ASC Info-Zustand im Rollo von xx auf „in reserved“ (Beschattung vorbereitet)
# Ein erneutes Event vom Astro oder Helligkeits Device kommt -> Überprüfung der Werte -> sind diese weiterhin gegeben folgt der Wechsel von „in reserved“ auf „in“ (Beschattung aktiv)
# Bei Verwendung von ''ASC_Shading_StateChange_SunnyCloudy'' ist zu beachten, dass ein Durchschnitt über die letzten drei Brightness Events gerechnet wird. Möchte man das vermeiden muss man SUNNY:CLOUDY 1[2] setzen.
# Die Zeiten ''ASC_Shading_WaitingPeriod'' und ''ASC_BlockingTime_afterManual'' können hier zusätzlich für eine Verzögerung sorgen.
'''Wichtig zu beachten:''' Es müssen immer mehrere (mind. 2) Events für den Betrieb erfolgen. In den Standardeinstellungen vom Astro Modul erfolgt dieses z.B. nur 1 x pro Stunde. Kommt also ein Helligkeits-Event auch nur 1x pro Stunde, könnte es 2 Std dauern, bis die Beschattungsfunktion greift.

Wenn das Rollo einmal aus der Beschattung manuell (im Rollo Device muss bei ''ASC_ShuttersLastDrive manuel'' stehen gefahren wurde wird das Rollo erst wieder nach einer Entschattung und erneuter Beschattung gefahren. Also es muss einmal shading out kommen und beim nächsten shading in fährt er dann wieder.

=== Weitere Funktionen ===
==== WeekendHoliday Funktion im Brightnessbetrieb ====
Am Wochenende oder Feiertag und wenn am ASC-Device sunriseTimeWeHoliday aktiviert sowie im Rollo das Attribut ASC_Time_Up_WE_Holiday gesetzt sind, wird zur angegebenen ASC_Time_Up_WE_Holiday Zeit das Rollo geöffnet, ungeachtet des Brightnesswertes.

==== Privacy ====
Werden hierfür Werte festgelegt, werden die betreffenden Rollläden die festgelegte Zeit/Helligkeit vor dem abendlichen Schließen vorab teilweise geschlossen. Dies kann z.B. gewünscht sein, um Rollläden zur Straße hin mit viel Fußgängerverkehr zwar nicht vollständig abzudunkeln, aber gleichzeitig zu verhindern, dass von außen in Wohnräume geschaut werden kann, sobald dort das Licht angeschaltet wird

==== BlockingTime====
Bewirkt, dass nach einer manuellen Fahrt, eine vom ASC Modul initiierte Fahrt zunächst ausgesetzt wird, bis die im Attribute angegebene Zeit überschritten ist. Erst dann wird eine vom ASC Modul initiierte Fahrt tatsächlich durchgeführt.
Genau so wird ein Hochfahren eines Rollos durch das ASC Modul nicht mehr ausgeführt, wenn es innerhalb der Zeit von ASC_BlockingTime_beforNightClose und das Runterfahren wird nicht mehr erfolgen, wenn es innerhalb von ASC_BlockingTime_beforDayOpen ist.
Beispiel: Meine Tochter geht früh außer Haus und Ihre Rollos sind nicht hochgefahren. Diese fahren auch nicht mehr hoch, da die ausschließlich bei home (anwesend) fahren sollen. Nun kommt sie am Nachmittag um 16:23 Uhr nach Hause. Eigentlich sollten nun die Rollos fahren. Doch die Sonnenuntergangsfahrt (schließen) wäre schon 16:51 Uhr und damit innerhalb der 3600 ASC_BlockingTime_beforNightClose. Die Rollos bleiben also unten. Es lohnt sich für die paar Minuten einfach nicht mehr.

==== wiggle====
Mit einem <code>set <ASC-Device> wiggle</code> können alle Rollladen mit einem entsprechenden Attribut zu einer kurzen Fahrt veranlasst werden, nach Ablauf von einer Minute wieder um denselben Wert zurück. Dabei wird jeweils in die Richtung gefahren, die den weiteren Weg ermöglicht. Wenn also zu 70% geschlossen ist, wird der Rollladen hoch fahren.
==== Partymode ====
Dieser wird am ASC-Device selbst aktiviert mittels <code>set <ASC-Device> partyMode on</code>. Alle Rollladen-Devices, welche das Attribut ''ASC_Partymode'' auf ''on'' gestellt haben, werden nicht mehr gesteuert. Der letzte Schaltbefehl, der durch ein Fensterevent oder Bewohnerstatus an die Rollläden gesendet wurde, beim Beenden des Modus durch <code>set ASC-Device partyMode off</code> ausgeführt.
==== lock-out ====
Man kann mit dem Befehl <code> set <ASC-Device> hardLockOut</code> auf einen Schlag alle Rollos sperren welche <code> attr <ROLLO-Device> ASC_LockOut hard</code> gesetzt haben.
Das ist dafür gedacht, wenn Du eine gewisse Zeit den Rolloaktor sperren willst. Zum Beispiel das die Kinder nicht schalten sollen.

== Sonstige Hinweise und Problemlösungen ==
* Werden Attribute geändert, kann es vereinzelt vorkommen, dass das ASC-Modul dies nicht mitbekommt und das tatsächliche Verhalten nicht den Erwartungen entspricht. In so einem Fall empfielt es sich, das NOTIFYDEV nochmals aufbauen zu lassen. Dazu werden zunächst mit <code>set <ASC-Modul> expert 1</code> erweiterte Informationen bezüglich des NotifyDevs unter set und get aktiviert und anschließend ein <code>set <ASC-Modul> createNewNotifyDev</code> ausgeführt.

* Hin und wieder berichten Nutzer davon, wenn Sie die ''Privacy Funktion'' nutzen, dass sich im NOTIFYDEV anstelle des Device Namen ein Raumname befindet. Diese Problem kann damit gelöst werden, dass in dem betroffenen '''Rollo Device''' das Atribut <code>attr event-on-change .*</code> gesetzt wird.
'''Wichtig!''' Nicht verwechseln mit dem ASC Device dort darf <code>attr event-on-change</code> '''nicht''' gesetzt sein!
* Wenn mehrere Rollladen gleichzeitig den Fahrbefehl bekommen, kann es (z. B. bei zwave) dazu kommen, dass ein Rollladen seinen Befehl nicht bekommt. Dies kann durch eine zeitverzögerte Aussendung der Fahrbefehle vermieden werden. Dazu in den jeweiligen Rollo Devices das Attribut ASC_Drive_DelayStart wie folgt benutzen im: ersten Rollo Device braucht das Attribut nicht gesetzt werden, im zweiten Rollo Device im Attribut ASC_Drive_DelayStart dann 4 Sekunden eintragen, im dritten Rollo Device im Attribut ASC_Drive_DelayStart 8 Sekunden eintragen, usw. Ein Abstand von 3-4 Sekunden ist dabei zielführend.

==== Spezielle Hardware ====
{{Link2Forum|Topic=101182|LinkText="Thread zu getesteter Hardware im Forum"}}

== Weblinks ==
* {{Link2Forum|Topic=92628|LinkText="Thread zum Modul im Forum"}}
* {{Link2Forum|Topic=90751|LinkText="Thread zur Entwicklung im Forum"}}
* {{Link2Forum|Topic=73964|LinkText="Thread zu den Scripten von user cluni"}}, die der Entwicklung des Moduls zugrunde liegen
* Daten zum Sonnenstand z.B. hier https://www.sonnenverlauf.de/

<references />

[[Kategorie:Code Snippets]]
[[Kategorie:Rollladensteuerung]]

SSFile - Integration der Synology File Station

2021-06-19T16:18:28Z

50watt: /* Backup des FHEM Filesystems über Synology Kalendereinplanung */

Das Modul 50_SSFile wird ab dem 26.05.2021 offiziell per Update verteilt.

Die aktuelle Entwicklungsversion bzw. Testmodulversion kann über den nachfolgenden Download bezogen werden.

Bitte den Befehl so komplett mit den Ausführungszeichen am Anfang und Ende in der FHEMWEB Kommandozeile eingeben:

<pre>
"wget -qO ./FHEM/50_SSFile.pm https://svn.fhem.de/fhem/trunk/fhem/contrib/DS_Starter/50_SSFile.pm"
</pre>

Danach FHEM restarten.

FHEM muß aktuell sein, insbesondere die Files im Verzeichnis '''/opt/fhem/lib/FHEM/SynoModules'''.

== Arbeitsweise ==

Das Modul SSFile arbeitet mit der Synology File Station zusammen, d.h. das Paket File Station muß auf der Diskstation aktiviert sein. Für die Kommunikation mit der File Station, d.h. um Files/Ordner hoch- bzw. herunterzuladen, wird ein User der Diskstation verwendet. Dieser User muß natürlich die Rechte besitzen um die beabsichtigten Lese- und Schreiboperationen auszuführen.

Alle Operationen des Moduls sind Queue gesteuert. Das bedeutet, alles durchzuführenden Aktivitäten werden zunächst in eine Queue gestellt und danach abgearbeitet. Bei den meisten Befehlen wird die Abarbeitung der Queue implizit gestartet. Aber z.B. die set-Befehle '''prepareDownload''' und '''prepareUpload''' erstellen lediglich die Queueeinträge.
Um die Abarbeitung zu starten, ist in diesen Fällen ein abschließer Befehl

set <Name> startQueue

nötig wenn nicht durch das gesetzte Attribut '''interval''' ein regelmäßiger Queue-Start automatisch erfolgt.

Mit diesem Modul sind zum Beispiel regelmäßige Backups des gesamten FHEM-Systems möglich. Auch gezielte Restores von ausgewählten Dateien oder Verzeichnissen ohne Zippen oder Entzippen sind möglich.

Durch die asynchrone Queue-Abarbeitung werden auch Ausfallzeiten der Diskstation toleriert. Ist die Diskstation zum Beipiel im Wartungsmodus oder im Sleep-Mode, bleiben die Einträge in der Queue erhalten und werden abgearbeitet sobald wieder eine Verbindung zur Diskstation hergestellt werden kann.

Das Modul benötigt keinerlei Mounts von freigegebenen Verzeichnissen der Diskstation auf dem FHEM-Server. Die Datenverarbeitung erfolgt komplett nicht-blockierend. Da die API-Schnittstelle genutzt wird, dauert die Datenübertragung länger als bei der Nutzung von Betriebsystem Kopierkommandos.

== Definition ==

Die Definition ist sehr einfach, z.B.:

define SynFile SSFile 192.168.2.20

Die IP-Adresse ist dabei die Adresse der Synology Diskstation. Sie kann auch ein DNS-Name sein. In diesem Fall bitte auch das globale Attribut '''dnsServer''' nicht vergessen zu setzen.

[[Datei:ssfile1.PNG|right|thumb|300px|API Versionen Popup]]
Es kann ebenfalls das https-Protokoll oder ein vom default abweichender Port verwendet werden, z.B.:

define SynFile SSFile 192.168.2.20 9001 https

oder

define SynFile SSFile 192.168.2.20 5010 http

Nach der initialen Definition müssen zunächst die Credentials für die Verbindung zur Synology DS definiert werden:

set <Name> credentials <User> <Passwort>

Sind die Credentials gespeichert, kann die Funktion einfach getestet werden mit dem Befehl:

get <Name> apiInfo

Wird der Login erfolgreich ausgeführt, erscheint nach kurzer Zeit ein Popup mit den aktuell vorhandenen und verwendeten API-Versionen.

== Upload von Objekten zur Synology Diskstation (Backup) ==

Es können ein oder mehrere Dateien, sowie ganze Ordner in einen Zielpfad auf der Synology Diskstation hochgeladen werden.
Zum Hochladen stehen zwei Set-Kommandos zur Verfügung:

; Upload: die angegebenen Dateien/Ordner werden durch das Modul bewertet und danach der Upload sofort gestartet

; prepareUpload: die angegebenen Dateien/Ordener werden durch das Modul bewertet und nur in die interne Queue zur Abarbeitung gestellt.<br> Erst nach dem Kommando '''set <Name> startQueue''' wird die Abarbeitung gestartet. Alternativ kann auch das Attribut '''interval''' verwendet werden. Das triggert ebenfalls die Queue-Abarbeitung alle X Sekunden automatisch.

Der Zielpfad wird mit dem Argument '''dest=''' bestimmt und beginnt immer mit einem auf der Synology angelegten "shared Folder". In dem Zielpfad werden alle Objekte strukturerhaltend, d.h. inkl. ihrer Quellverzeichnisse, gespeichert. Das Verhalten ist mit dem Argument '''struc=''' veränderbar.

Benötigte Unterverzeichnisse werden im Standard automatisch im Zielpfad angelegt.

Die generelle Syntax für beide möglichen Upload-Befehle ist:

set <Name> Upload "<File>[,<File>,...]" | "<Ordner>[,<Ordner>,...]" <args>

bzw.

set <Name> prepareUpload "<File>[,<File>,...]" | "<Ordner>[,<Ordner>,...]" <args>

Die hochzuladenden Dateien bzw. Ordner werden durch Komma getrennt angegeben. Dateien und Ordner können kombiniert im Set-Befehl angegeben werden. Die Arbeitsweise des Upload-Befehls wird durch Argumente (<args>) gesteuert, die kombiniert werden können:

;dest=: '''<Ordner>''': Zielpfad zur Speicherung der Dateien im Synology Dateisystem (der Pfad beginnnt mit einem shared Folder und endet ohne "/"). Diese Angabe ist verpflichtend. Es können [https://metacpan.org/pod/POSIX::strftime::GNU POSIX %-Wildcards] als Bestandteil des Zielpfads verwendet werden. Prominente Vertreter sind:<br><br> * %d Tag des Monats (01..31)<br> * %m Monat (01..12)<br> * %Y Jahr (1970...)<br> * %H Stunde im 24-Stunden Format (00..23)<br> * %M die Minute (00..59)<br> * %S die Sekunde (00..60), (Der Bereich ist bis zu 60, um gelegentliche Schaltsekunden zu ermöglichen)

;ow=: '''true''': die Datei wird überschrieben, wenn sie im Ziel-Pfad schon vorhanden ist (default), '''false''': eine bereits vorhandene Datei wird nicht überschrieben

;cdir=: '''true''': übergeordnete(n) Ordner erstellen, falls nicht vorhanden. (default), '''false''': übergeordnete(n) Ordner nicht erstellen

;mode=: '''full''': alle außer im Attribut excludeFromUpload angegebenen Objekte werden berücksichtigt (default)<br> '''inc''': nur neue Objekte und Objekte die sich nach dem letzten Upload verändert haben werden berücksichtigt<br> '''nth:<Tage>''': nur Objekte neuer als <Tage> werden berücksichtigt (gebrochene Zahlen sind erlaubt, z.B. 3.6)

;struc=: '''true''': alle Objekte werden inkl. ihrer Verzeichnisstruktur im Zielpfad gespeichert (default)<br>'''false''': alle Objekte werden ohne die ursprüngliche Verzeichnisstruktur im Zielpfad gespeichert

Der lokale Pfad zur Datei bzw. zum Ordner kann entweder ein absoluter Pfad oder eine relativer Pfad zum FHEM-Wurzelverzeichnis (siehe globales Attribut modpath) sein. Alle Quellen, Dateien/Ordner, müssen insgesamt in Quotes (") eingeschlossen werden.

Nachfolgend einige Beispiele (Upload kann auch durch pepareUpload ersetzt werden):

::<b>set <Name> Upload "./text.txt" dest=/home/upload</b>
::die Datei "text.txt" aus dem FHEM-Wurzelverzeichnis wird in das Zielverzeichnis "/home/upload" übertragen

::<b>set <Name> Upload "/opt/fhem/old data.txt" dest=/home/upload ow=false</b>
::die Datei "old data.txt" im Verzeichnis "/opt/fhem" wird nach "/home/upload/opt/fhem" übertragen sofern sie dort noch nicht existiert

::<b>set <Name> Upload "./log" dest=/home/upload mode=inc</b>
::die Dateien im Verzeichnis "log" des FHEM-Wurzelverzeichnisses werden nach "/home/upload/log" inkrementell übertragen.

::<b>set <Name> Upload "./log" dest=/home/upload mode=full struc=false</b>
::die Dateien im Verzeichnis "log" des FHEM-Wurzelverzeichnisses werden nach "/home/upload" übertragen, unabhängig davon, ob sie seit der letzten Übertragung geändert wurden.

::<b>set <Name> Upload "./log" dest=/home/upload/%Y_%m_%d_%H_%M_%S mode=full struc=false</b>
::wie voriges Beispiel. Der Zielpfad wird dynamisch mit dem aktuellen Datum + Uhrzeit ergänzt.

::<b>set <Name> Upload "./" dest=/home/upload mode=inc</b>
::die Dateien des gesamten FHEM-Systems werden nach "/home/upload" inkrementell und strukturerhaltend übertragen.

::<b>set <Name> Upload "/opt/fhem/fhem.pl,./www/images/PlotToChat.png,./log/fhem-2020-10-41.log" dest=/home/upload</b>
::nur die angegebenen Dateien werden nach "/home/upload/<entsprechendes Unterverzeichnis>" übertragen.

=== Informationen über den Uploadstatus ===

Das Reading QueueLength enthält die Anzahl der in der Queue befindlichen Befehle. Hier werden nicht nur Upload-Befehle berücksichtigt, sondern sämtliche noch offenen (oder mit Fehlerstatus behafteten) Einträge.

Wird der Upload ausgeführt, erfolgt ein permanentes Herunterzählen dieses Readings bis auf "0" im Idealfall. Sollte nach Abarbeitung von Befehlen das Reading QueueLength noch den Wert größer "0" haben, konnten nicht alle Befehle abgearbeitet werden. Sätze mit permanenten Fehlerstatus werden zukünftig von der Abarbeitung ausgenommen, andere Einträge mit einem zeitlichen Versatz wiederholt, z.B. wenn die Synology Diskstation zum Zeitpunkt des Uploads nicht erreichbar war.

[[Datei:ssfile2.PNG|right|thumb|300px|Upload Historie]]
Die Ergebnisse der Uploads werden in einer internen Datenabank gespeichert.
Man kann sich die Upload-Historie ausgeben lassen mit dem Befehl:

set <Name> listUploadsDone

Die Übersicht zeigt die übertragenen Quelldateien mit ihrem Ursprungspfad, dem Zielpfad sowie das Datum + Zeit der Übertragung.
Diese Informationen bleiben auch nach einem FHEM Restart erhalten und sind die Grundlage für die Bewertung einer inkrementellen Übertragung.

Die Historie kann bei Bedarf gelöscht werden mit:

set <Name> deleteUploadsDone

Die auf der Synology gespeicherten Dateien werden durch diesen Befehl aber nicht gelöscht.

<br>
= Download von Objekten zum FHEM-Server (Restore) =

Zum Herunterladen von Dateien oder ganzen Ordnern stehen die Befehle '''Download''' bzw. '''prepareDownload''' zur Verfügung.
Die Syntax und das Ergebnis ist bei beiden Befehlen identisch, nur werden bei prepareDownload die herunterzuladenden Objekte zunächst nur in die Ausführungsqueue gestellt. Zum Starten ist dann der Befehl
[[Datei:ssfile3.PNG|right|thumb|300px|Ausgabe von set <> listQueue]]

set <Name> startQueue

auszuführen. Der Setter Download führt die Anweisung sofort aus.
Die mit '''prepareDownload''' erzeugten Queueeinträge können vor der Ausführung mit dem Befehl:

set <Name> listQueue

anzeigt werden. Diese Liste könnte zum Beispiel so aussehen:

5 => retryCount=>0, reqtype=>GET, params=>&path="/backup/Carport-20200625-1147065130.jpg", opmode=>download, method=>download, header=>Accept: application/json, dest=>./Carport-20200625-1147065130.jpg, api=>DOWNLOAD

Am Anfang steht immer der Index des Eintrags, hier ist es der Index 5.
Unerwünschte oder falsche Downloads können bei Bedarf noch gelöscht werden. Der Befehl

set <Name> purgeQueue <Index>

löscht den angegebenen Eintrag mit dem Index, z.B. 5.

Beim Download von Dateien/Ordnern ist zu beachten, dass die Objekte immer in den FHEM root-Ordner, überlicherweise /opt/fhem, geladen werden. Allerdings kann der Zielordner auf dem FHEM-Server durch den Zusatz von '''dest=''' bestimmt werden.

Als Argument von dest= kann angegeben werden:

::* <Filename>: das Objekt wird mit neuem Namen im default Pfad gespeichert
::* <Pfad/Filename>: das Objekt wird mit neuem Namen im angegebenen Pfad gespeichert
::* <Pfad/>: das Objekt wird mit ursprünglichen Namen im angegebenen Pfad gespeichert. '''Wichtig:''' der Pfad muß mit einem "/" enden.

Wird als herunterzuladendes Objekt ein ganzer Ordner des Synology Dateisystems bestimmt, wird der Inhalt des Ordners in ein zip-Archiv verpackt und im Ziel auf dem FHEM-Server gespeichert. Die Dateien sind dann entsprechend aus dem Archiv zu entpacken.

Nachfolgend ein paar Beispiele. Wichtig is es, die angegbenen Objekte in '''""''' einzuschließen, was besondere Bedeutung hat, wenn die Dateien/Ordner Leerzeichen enthalten. Mehrere Objekte (Files, Ordner oder beides gemischt) werden durch Komma getrennt.

<pre>
set <Name> Download "/backup/Carport-20200625-1147065130.jpg"
set <Name> Download "/backup/Carport-20200625-1147065130.jpg" dest=carport.jpg
set <Name> Download "/backup/Carport-20200625-1147065130.jpg" dest=./log/carport.jpg
set <Name> Download "/backup/Carport-20200625-1147065130.jpg" dest=./log/
set <Name> Download "/Temp/Anträge 2020,/backup/Carport-20200625-1147065130.jpg"
set <Name> Download "/backup/Carport-20200625-1147065130.jpg,/Temp/card.txt" dest=/opt/
</pre>

[[Datei:ssfile4.PNG|right|thumb|300px|Ausgabe von get <> remoteFolderList]]
Um sich einen Überblick über die auf der Synology vorhandenen Dateien zu verschaffen, kann man sich vor dem Download ein Liste der Objekte erstellen lassen. Dazu verwendet man den Befehl:

get <Name> remoteFolderList

Ohne weiteres Argument erstellt der Befehl eine Übersicht aller auf der Synology vorhandenenen shared Folder. Um den Inhalt eines bestimmten Ordners anzuzeigen, wird dieser Ordner (inkl. eventueller Unterordner) als Argument mitgegeben, z.B.:

get <Name> remoteFolderList "/FHEM-Prod/2020_11_29"

Das Ordnerobjekt beginnt immer mit einem '''/''' und wird in '''""''' eingeschlossen, um auch Ordnernamen mit Leerzeichen verarbeiten zu können.
Es können noch weitere Optionen mitgegeben werden,um die angezeigten Informationen zu beeinflussen (siehe Commandref zu SSFile).

<br>
= Beispiele zur Anwendung =

== Backup des FHEM Filesystems über Synology Kalendereinplanung ==

Es wird vorgestellt, wie man mit Hilfe des Synology Kalenders Backups des FHEM-Filesystems einplant und ausführen lässt. Dabei werden sowohl Full-Backups als auch inkrementelle Backups erstellt.

Das Backupregime verfolgt folgendes Ziel bzw. Features:

* jede Woche Montag wird ein Full-Backup des gesamten FHEM-Verzeichnisses angefertigt
* die restlichen Tage der Woche werden nur neue oder geänderte Dateien gesichert (inkrementelles Backup)
* jede Sicherung wird auf der Synology in einem gemeinsamen Ordner (z.B. /FHEM-Prod) in jeweils einem separaten Verzeichnis gespeichert
* die Ordnerstruktur der Quelle bleibt innerhalb der Sicherung erhalten (d.h. man weiß genau wohin eine Datei der Sicherung in der Quelle gehört)
* die Sicherungsdateien können direkt wiederhergestellt werden, d.h. es ist kein dekomprimieren oder entpacken nötig.
* bei Bedarf können die Sicherungen ihrerseits durch Synology Backup Werkzeuge (z.B. Hyper Backup) auf externe Datenträger versioniert werden und stehen dadurch lange Zeit zur Verfügung
* die Sicherungen des laufenden Monats bleiben auf der Synology online verfügbar, ältere Backupverzeichnisse werden gelöscht und können bei Bedarf von einem externen Datenträger wiederhergestellt werden
* eine grafische chronologische Übersicht der auszuführenden Sicherungen (und Löschungen) ist z.B. zur Anzeige auf einem Tablet verfügbar

Für das vorgestellte Scenario werden die Module SSFile und SSCal ([[SSCal - Integration des Synology Calendar Servers]]) verwendet. Das Modul SSCal zur Steuerung des Synology Kalenders wird hier nur insofern erläutert,wie es für den hier vorgesehenen Einsatzzweck benötigt wird. Weiterführende Informationen findet man in dem [[SSCal - Integration des Synology Calendar Servers|Wiki-Artikel]] zu SSCal.

Um das oben definierte Scenario umzusetzen, werden die dazu nötigen Schritte nachfolgend beschrieben. Es sind dazu '''keine Volume-Mounts''' auf dem FHEM-Server '''nötig'''. Jede Kommunikation und Datenübertragung wird über das lokale Netzwerk abgewickelt.

<br>
=== FHEM Backup-Device anlegen ===

Zur Durchführung der Backup wird ein SSFile Device mit dem Namen '''SynFile''' definiert. Es wird in dem Beispiel die Verbindung zur Synology mit der Adresse 192.168.2.10 hergestellt.

[[Datei:ssfcb0.PNG|right|thumb|400px|Backup Device SynFile]]

<pre>
defmod SynFile SSFile 192.168.2.10
attr SynFile alias Backup auf Synology (API)
attr SynFile devStateIcon .*running:control_arrow_rightward .*done|.*Upload\squeue\sfill\sfinished:control_on_off:startQueue .*Error:control_arrow_rightward@red .*Initialized:control_standby@orange
attr SynFile excludeFromUpload ./FHEM/FhemUtils/cacheSSCam.*,\
./www/SVGcache.*
attr SynFile group Backup
attr SynFile icon system_backup
attr SynFile interval 0
attr SynFile noAsyncFillQueue 0
attr SynFile room Dienste->Allgemein
attr SynFile showPassInLog 0
attr SynFile stateFormat <b>letzter Update:</b> lastUpdate\
<br>\
1:state
attr SynFile verbose 2
</pre>

Nach der Erstdefinition sind die Credentials zur Verbindung mit der DS einzutragen. Im Attribut '''excludeFromUpload''' angegebene Objekte werden von den Backups ausgeschlossen. In dem Beispiel sind es gecachte Daten die im Restorefall nicht benötigt werden.

Dieses Backup-Device wird später von automatisch erstellten at-Devices angesprochen.

<br>
=== freigegebenen Ordner auf Synology DS erstellen ===

Als Ziel für die auszuführenden Backups wird auf der Synology ein freigebener Ordner '''FHEM-Prod''' angelegt.
Die Schritte dazu sind in dieser [https://www.synology.com/de-de/knowledgebase/DSM/help/DSM/AdminCenter/file_share_create Online-Hilfe] beschrieben.

<br>

=== Synology Kalender anlegen ===
[[Datei:ssfcb1.PNG|right|thumb|200px|Synology Kalender]]
Für die vorgesehenen Steuerungen wird ein Kalender auf der Synology DS angelegt wenn noch nicht vorhanden. Im vorliegenden Beispiel wird dazu der Kalender '''Haussteuerung Prod''' verwendet.

Wie ein Synology Kalender angelegt wird, ist z.B. in diesem [https://www.synology.com/de-de/knowledgebase/DSM/help/Calendar/calendar_creating_calendars Hilfeartikel] beschrieben bzw. ist in diversen Onlinemedien abrufbar.

Die von mir verwendete Definition des Synology Kalenders zur Aufnahme von Haussteuerungseinträgen zeigt nebenstehende Abbildung.

<br>

=== den angelegten Synology Kalender in FHEM integrieren ===

Zur FHEM Integration wird das Modul 57_SSCal verwendet. Dieses Modul ist speziell für die Integration des Synology Calendar Servers entwickelt und verfügt über Features die die Erstellung automatisierter Vorgänge in FHEM sehr vereinfachen. Die umfangreichen Möglichkeiten des Modul sind im [http://sds1.myds.me/mediawiki/index.php?title=SSCal_-_Integration_des_Synology_Calendar_Servers|SSCal Wiki-Artikel] näher beschrieben.

Zur Integration des vorher angelegten Kalenders '''Haussteuerung Prod''' wird folgende RAW-Definition des Kalenderdevices '''SynControl''' verwendet:

<pre>
defmod SynControl SSCal 192.168.2.10
attr SynControl alias Synology Kalender Haussteuerung
attr SynControl asyncMode 1
attr SynControl createATDevs 1
attr SynControl cutLaterDays 2
attr SynControl cutOlderDays 1
attr SynControl event-on-update-reading .*Summary.*,state
attr SynControl group Haussteuerung
attr SynControl icon time_calendar
attr SynControl interval 400
attr SynControl room Dienste->Kalender
attr SynControl stateFormat <b>Status:</b> state - <b>Last Update</b>: lastUpdate - <b>Next Update</b>: nextUpdate
attr SynControl tableFields Begin,End,DaysLeft,Weekday,Summary,Status,Calendar
attr SynControl tableSpecs {\
"cellStyle" => {\
"noHeader" => "0",\
"headerAlign" => "center",\
"columnAlign" => "center",\
"columnSymbolAlign" => "center",\
"columnSummaryAlign" => "left",\
},\
"columnMapIcon" => [{\
"Status" => "eq 'ended' ",\
"icon" => "rc_WEB@grey", \
},\
{\
"daysLeft" => ">= 1 ",\
"icon" => "rc_WEB", \
}],\
"columnMapProvider" => "GoogleMaps",\
"columnStateIcon" => [\
{\
"Status" => "eq 'ended' ",\
"icon" => "1px-spacer",\
},\
{\
"Status" => "eq 'started' ",\
"icon" => "10px-kreis-gruen",\
},\
{\
"Status" => "eq 'upcoming' ",\
"icon" => "10px-kreis-gelb",\
},\
{\
"Status" => "eq 'alarmed' ",\
"icon" => "10px-kreis-gruen",\
},\
],\
"columnSymbolIcon" => "time_manual_mode", \
}
attr SynControl usedCalendars Haussteuerung Prod
</pre>

[[Datei:ssfcb2.PNG|right|thumb|400px|grafische Kalenderübersicht]]
Nach der Erstdefinition des Devices muss der verwendete User mit seinen Credentials im Device gesetzt werden. Dadurch werden automatisch alle verfügbaren Kalender der in der DEF angegebenen Synology Diskstation (hier die DS mit der Adresse 192.168.2.10) abgerufen. Der/die relevante(n) Kalender werden danach mit dem '''Attribut usedCalendars''' selektiert.

Wichtig ist das Attribut '''createATDevs'''. Es bewirkt, dass eine im Feld '''Beschreibung''' eines Kalendereintrags vorhandene Codedefinition automatisch in ein at-Device in FHEM umgesetzt wird. Die dazu nötige Syntax wird im Abschnitt "Anlegen eines Kalendereintrags" näher erläutert.

Das Attribut '''tableSpecs''' legt die gewünschten Merkmale zur Gestaltung der graphischen Kalenderanzeige in FHEM fest. Nebenstehende Abbildung zeigt die Kalendergrafik des fertig angelegten Kalenderdevices. Die Übersicht enthält bereits Einträge zur Haussteuerung die es allerdings in einem frisch defninierten Kalender noch nicht gibt und erst durch die nachfolgend beschriebenen Verfahren hinzukommen.

Der im Attribut interval eingestellte Wert 400 definiert einen Abruf der Kalendereinträge alle 400 Sekunden. Dabei werden eventuell im Feld Beschreibung des Kalendereintrags enthaltene Codefinitionen ausgewertet aund automatisch korrespondierende at-Devices angelegt bzw. auch gelöscht/verändert wenn ein Kalendereintrag gelöscht oder entfernt wurde.

<br>

=== den Eintrag für Full-Backup im Synology Kalender Haussteuerung vornehmen ===

Ein Full-Backup soll wöchentlich jeden Montag um 02:15 ausgeführt werden. In der Synology Kalenderapplikation wird dazu der abgebildete Kalendereintag vorgenommen.

[[Datei:ssfcb3.PNG|left|thumb|200px|Kalendereintrag Vollsicherung]]

Ist eine Information über die bevorstehenden Start einer Sicherung gewünscht, kann im Punkt '''Warnung''' ein entsprechender Eintrag vorgenommen werden. Bei der Anlage des Kalendereintrags ist an dieser Stelle der Kalenderdefault hinterlegt, der im vorliegenden Beispiel komplett gelöscht wurde um keinerlei Hinweispopups oder dgl. zu erhalten.

[[Datei:ssfcb4.PNG|right|thumb|300px|Wiederholung Vollsicherung]]

Zur Einplanung der Wiederholung der Vollsicherung wird der Haken bei '''Ereignis wiederholen''' gesetzt und die entsprechende Einstellung zur wöchentlichen Wiederholung vorgenommen.

[[Datei:ssfcb5.PNG|right|thumb|300px|Codedefinition Vollsicherung]]
Die im Ereignis auszuführenden Aktion wird im Feld Beschreibung eingetragen. Das SSCal Device erkennt ein auszuführendes FHEM-Kommando an in geschweifte Klammern '''{...}''' eingebetteten Text.
Um eine Vollsicherung auszuführen, wird folgender Code in diesem Feld eingetragen

{ set SynFile Upload "./" dest=/FHEM-Prod/%Y_%m_%d_Full }

Die Quelle '''./''', also der gesamte root-Ordner der FHEM-Installation, wird gesichert (normalerweise /opt/fhem). Das Zielverzeichnis %Y_%m_%d_Full wird im freigegebenen Ordner FHEM-Prod automatisch angelegt wenn es nicht vorhanden ist. Dabei werden die POSIX Variablen %Y durch das Jahr, %m durch den aktuellen Monat und %d durch den aktuellen Tag ersetzt.

<br>
=== den Eintrag für inkrementelles Backup im Synology Kalender Haussteuerung vornehmen ===

Ein inkrementelles Backup wird an allen anderen Tagen (als Montag) um 02:15 ausgeführt. In der Synology Kalenderapplikation wird dazu der abgebildete Kalendereintag vorgenommen.

[[Datei:ssfcb6.PNG|left|thumb|200px|Kalendereintrag inkrementelle Sicherung]]

Die '''Warnung''' wird bei diesem Eintrag wieder entfernt um keinerlei Hinweispopups oder dgl. vor dem Start der Aktion zu erhalten.

[[Datei:ssfcb7.PNG|right|thumb|300px|Wiederholung inkrementelle Sicherung]]

Zur Einplanung der Wiederholung der inkremntellen Sicherung wird der Haken bei '''Ereignis wiederholen''' gesetzt und die entsprechende Einstellung zur wöchentlichen Wiederholung vorgenommen.

[[Datei:ssfcb8.PNG|right|thumb|300px|Codedefinition Vollsicherung]]
Im Feld Beschreibung wird wieder die Codierung für die Ausführung der inkrementellen Sicherung eingetragen:

{ set SynFile Upload "./" dest=/FHEM-Prod/%Y_%m_%d mode=inc }

Die Codierung entspricht dem oben beschriebenen Vollbackup, außer dass der Zusatz '''mode=inc''' das inkrementelle Backup bewirkt.

<br>

=== den Eintrag zum Löschen alter Backups im Synology Kalender Haussteuerung vornehmen ===

[[Datei:ssfcb9.PNG|left|thumb|200px|Ablagestruktur Sicherungen]]

[[Datei:ssfcb10.PNG|right|thumb|200px|Eintrag Löschen Backups]]
Werden die in den vorangegangenen Punkten definierten Sicherungen ausgeführt, wird jedes Backup in einem separaten Verzeichnis im freigegebenen Ordner FHEM-Prod auf der Synology DS abgelegt wie z.B. im Bild gezeigt.

Es sollen alte Backups des Vormonats gelöscht werden.

Dazu wird am 9. Tag jedes Monats ein Löschvorgang angelegt, der alle Backupverzeichnisse des Vormonats mit deren Inhalten löscht. Die Aktion wird erst einige Tage nach dem Start eines Monats ausgeführt, damit immer hinreichend aktuelle Backups online auf dem NAS zur Verfügung stehen.

Es wird der dargestellte Eintrag um 01:15 angelegt. Die Standardwarnungen werden wiederum gelöscht. Die Wiederholung wird monatlich mit dem Kriterium "Tag des Monats" ausgeführt.

[[Datei:ssfcb11.PNG|left|thumb|200px|Wiederholung Löschen Backups]]

Wie bereits beschrieben, wird der Code des auszuführenden Kommandos im Feld Beschreibung eingetragen. Dieses Mal soll Perl-Code statt eines einfachen FHEM Kommandos ausgeführt werden.

Dazu wird der Code in doppelte geschweifte Klammern eingefügt <nowiki>{{...}}</nowiki>. SSCal erkannt dadurch dass es sich hierbei um Perl-Code handelt und behandelt es entsprechend bei der Anlage des korrespondierenden at-Devices.

[[Datei:ssfcb12.PNG|right|thumb|200px|Code im Beschreibungs Feld]]
<pre>
{{
my $dev = "SynFile";
my $folder = "/FHEM-Prod/%Y_%m_";
my $folderres = strftime "$folder", localtime(time-1728000); # heute - 20 Tage

for my $d (1..31) {
my $d = sprintf "%02d", $d;
my $fstr = $folderres.$d;
my $fstr1 = $folderres.$d."_Full";
CommandSet (undef, qq{$dev deleteRemoteObject "$fstr"});
CommandSet (undef, qq{$dev deleteRemoteObject "$fstr1"});
}
}}
</pre>

<br>

=== Zusammenfassung ===

Wurden alle Aktionen wie beschrieben durchgeführt, enthält das Kalenderdevice SynControl nach jedem Update die auszuführenden Backup-Aktivitäten. Durch die Aktivierung von '''createATDevs''' werden bei jedem Kalenderupdate at-Devices angelegt welche die gewünschten Backup-Aktionen terminieren und ausführen.

[[Datei:ssfcb13.PNG|right|thumb|200px|erzeugte at-Devices]]
[[Datei:ssfcb14.PNG|left|thumb|200px|erzeugtes at-Device]]
[[Datei:ssfcb15.PNG|right|thumb|200px|Backup Übersicht]]

Das Kalenderdevice enthält im Abschnitt '''Probably associated with''' eine Übersicht der automatisch erzeugten at-Devices.
Die Namen der Devices sind generisch und enthalten neben der EventId auch den geplanten Ausführungszeitpunkt.

Mit jedem Backup-Lauf wird ein Unterverzeichnis <Jahr>_<Monat>_<Tag> in FHEM-Prod angelegt in dem die gesicherten Dateien gespeichert werden. Die Sicherung ist strukturerhaltend, d.h. die FHEM-Verzeichnisse der gesicherten Daten werden ebenfalls mit angelegt.
Sicherungen die die älter sind als der aktuelle Monat werden am neunten Tag des aktuellen Monats entfernt.

Möchte man die Sicherungen längere Zeit versioniert speichern, bietet sich der zusätzliche Einsatz des Tools Hyper Backup an.

Zur Anzeige der grafischen Backup-Übersicht auf einem Tablet kann zum Beispiel ein [[SSCal_-_Integration_des_Synology_Calendar_Servers#Termintabelle_als_Weblink_einf.C3.BCgen|Weblink-Device]] verwendet werden.

<br>

= Beschränkungen und Known Bugs =

* es werden bei '''Upload/prepareUpload''' nur Dateien/Verzeichnisse berücksichtigt deren Name '''kein @''' beinhaltet.

SSFile - Integration der Synology File Station

2021-06-19T16:14:56Z

50watt: /* Arbeitsweise */

Das Modul 50_SSFile wird ab dem 26.05.2021 offiziell per Update verteilt.

Die aktuelle Entwicklungsversion bzw. Testmodulversion kann über den nachfolgenden Download bezogen werden.

Bitte den Befehl so komplett mit den Ausführungszeichen am Anfang und Ende in der FHEMWEB Kommandozeile eingeben:

<pre>
"wget -qO ./FHEM/50_SSFile.pm https://svn.fhem.de/fhem/trunk/fhem/contrib/DS_Starter/50_SSFile.pm"
</pre>

Danach FHEM restarten.

FHEM muß aktuell sein, insbesondere die Files im Verzeichnis '''/opt/fhem/lib/FHEM/SynoModules'''.

== Arbeitsweise ==

Das Modul SSFile arbeitet mit der Synology File Station zusammen, d.h. das Paket File Station muß auf der Diskstation aktiviert sein. Für die Kommunikation mit der File Station, d.h. um Files/Ordner hoch- bzw. herunterzuladen, wird ein User der Diskstation verwendet. Dieser User muß natürlich die Rechte besitzen um die beabsichtigten Lese- und Schreiboperationen auszuführen.

Alle Operationen des Moduls sind Queue gesteuert. Das bedeutet, alles durchzuführenden Aktivitäten werden zunächst in eine Queue gestellt und danach abgearbeitet. Bei den meisten Befehlen wird die Abarbeitung der Queue implizit gestartet. Aber z.B. die set-Befehle '''prepareDownload''' und '''prepareUpload''' erstellen lediglich die Queueeinträge.
Um die Abarbeitung zu starten, ist in diesen Fällen ein abschließer Befehl

set <Name> startQueue

nötig wenn nicht durch das gesetzte Attribut '''interval''' ein regelmäßiger Queue-Start automatisch erfolgt.

Mit diesem Modul sind zum Beispiel regelmäßige Backups des gesamten FHEM-Systems möglich. Auch gezielte Restores von ausgewählten Dateien oder Verzeichnissen ohne Zippen oder Entzippen sind möglich.

Durch die asynchrone Queue-Abarbeitung werden auch Ausfallzeiten der Diskstation toleriert. Ist die Diskstation zum Beipiel im Wartungsmodus oder im Sleep-Mode, bleiben die Einträge in der Queue erhalten und werden abgearbeitet sobald wieder eine Verbindung zur Diskstation hergestellt werden kann.

Das Modul benötigt keinerlei Mounts von freigegebenen Verzeichnissen der Diskstation auf dem FHEM-Server. Die Datenverarbeitung erfolgt komplett nicht-blockierend. Da die API-Schnittstelle genutzt wird, dauert die Datenübertragung länger als bei der Nutzung von Betriebsystem Kopierkommandos.

== Definition ==

Die Definition ist sehr einfach, z.B.:

define SynFile SSFile 192.168.2.20

Die IP-Adresse ist dabei die Adresse der Synology Diskstation. Sie kann auch ein DNS-Name sein. In diesem Fall bitte auch das globale Attribut '''dnsServer''' nicht vergessen zu setzen.

[[Datei:ssfile1.PNG|right|thumb|300px|API Versionen Popup]]
Es kann ebenfalls das https-Protokoll oder ein vom default abweichender Port verwendet werden, z.B.:

define SynFile SSFile 192.168.2.20 9001 https

oder

define SynFile SSFile 192.168.2.20 5010 http

Nach der initialen Definition müssen zunächst die Credentials für die Verbindung zur Synology DS definiert werden:

set <Name> credentials <User> <Passwort>

Sind die Credentials gespeichert, kann die Funktion einfach getestet werden mit dem Befehl:

get <Name> apiInfo

Wird der Login erfolgreich ausgeführt, erscheint nach kurzer Zeit ein Popup mit den aktuell vorhandenen und verwendeten API-Versionen.

== Upload von Objekten zur Synology Diskstation (Backup) ==

Es können ein oder mehrere Dateien, sowie ganze Ordner in einen Zielpfad auf der Synology Diskstation hochgeladen werden.
Zum Hochladen stehen zwei Set-Kommandos zur Verfügung:

; Upload: die angegebenen Dateien/Ordner werden durch das Modul bewertet und danach der Upload sofort gestartet

; prepareUpload: die angegebenen Dateien/Ordener werden durch das Modul bewertet und nur in die interne Queue zur Abarbeitung gestellt.<br> Erst nach dem Kommando '''set <Name> startQueue''' wird die Abarbeitung gestartet. Alternativ kann auch das Attribut '''interval''' verwendet werden. Das triggert ebenfalls die Queue-Abarbeitung alle X Sekunden automatisch.

Der Zielpfad wird mit dem Argument '''dest=''' bestimmt und beginnt immer mit einem auf der Synology angelegten "shared Folder". In dem Zielpfad werden alle Objekte strukturerhaltend, d.h. inkl. ihrer Quellverzeichnisse, gespeichert. Das Verhalten ist mit dem Argument '''struc=''' veränderbar.

Benötigte Unterverzeichnisse werden im Standard automatisch im Zielpfad angelegt.

Die generelle Syntax für beide möglichen Upload-Befehle ist:

set <Name> Upload "<File>[,<File>,...]" | "<Ordner>[,<Ordner>,...]" <args>

bzw.

set <Name> prepareUpload "<File>[,<File>,...]" | "<Ordner>[,<Ordner>,...]" <args>

Die hochzuladenden Dateien bzw. Ordner werden durch Komma getrennt angegeben. Dateien und Ordner können kombiniert im Set-Befehl angegeben werden. Die Arbeitsweise des Upload-Befehls wird durch Argumente (<args>) gesteuert, die kombiniert werden können:

;dest=: '''<Ordner>''': Zielpfad zur Speicherung der Dateien im Synology Dateisystem (der Pfad beginnnt mit einem shared Folder und endet ohne "/"). Diese Angabe ist verpflichtend. Es können [https://metacpan.org/pod/POSIX::strftime::GNU POSIX %-Wildcards] als Bestandteil des Zielpfads verwendet werden. Prominente Vertreter sind:<br><br> * %d Tag des Monats (01..31)<br> * %m Monat (01..12)<br> * %Y Jahr (1970...)<br> * %H Stunde im 24-Stunden Format (00..23)<br> * %M die Minute (00..59)<br> * %S die Sekunde (00..60), (Der Bereich ist bis zu 60, um gelegentliche Schaltsekunden zu ermöglichen)

;ow=: '''true''': die Datei wird überschrieben, wenn sie im Ziel-Pfad schon vorhanden ist (default), '''false''': eine bereits vorhandene Datei wird nicht überschrieben

;cdir=: '''true''': übergeordnete(n) Ordner erstellen, falls nicht vorhanden. (default), '''false''': übergeordnete(n) Ordner nicht erstellen

;mode=: '''full''': alle außer im Attribut excludeFromUpload angegebenen Objekte werden berücksichtigt (default)<br> '''inc''': nur neue Objekte und Objekte die sich nach dem letzten Upload verändert haben werden berücksichtigt<br> '''nth:<Tage>''': nur Objekte neuer als <Tage> werden berücksichtigt (gebrochene Zahlen sind erlaubt, z.B. 3.6)

;struc=: '''true''': alle Objekte werden inkl. ihrer Verzeichnisstruktur im Zielpfad gespeichert (default)<br>'''false''': alle Objekte werden ohne die ursprüngliche Verzeichnisstruktur im Zielpfad gespeichert

Der lokale Pfad zur Datei bzw. zum Ordner kann entweder ein absoluter Pfad oder eine relativer Pfad zum FHEM-Wurzelverzeichnis (siehe globales Attribut modpath) sein. Alle Quellen, Dateien/Ordner, müssen insgesamt in Quotes (") eingeschlossen werden.

Nachfolgend einige Beispiele (Upload kann auch durch pepareUpload ersetzt werden):

::<b>set <Name> Upload "./text.txt" dest=/home/upload</b>
::die Datei "text.txt" aus dem FHEM-Wurzelverzeichnis wird in das Zielverzeichnis "/home/upload" übertragen

::<b>set <Name> Upload "/opt/fhem/old data.txt" dest=/home/upload ow=false</b>
::die Datei "old data.txt" im Verzeichnis "/opt/fhem" wird nach "/home/upload/opt/fhem" übertragen sofern sie dort noch nicht existiert

::<b>set <Name> Upload "./log" dest=/home/upload mode=inc</b>
::die Dateien im Verzeichnis "log" des FHEM-Wurzelverzeichnisses werden nach "/home/upload/log" inkrementell übertragen.

::<b>set <Name> Upload "./log" dest=/home/upload mode=full struc=false</b>
::die Dateien im Verzeichnis "log" des FHEM-Wurzelverzeichnisses werden nach "/home/upload" übertragen, unabhängig davon, ob sie seit der letzten Übertragung geändert wurden.

::<b>set <Name> Upload "./log" dest=/home/upload/%Y_%m_%d_%H_%M_%S mode=full struc=false</b>
::wie voriges Beispiel. Der Zielpfad wird dynamisch mit dem aktuellen Datum + Uhrzeit ergänzt.

::<b>set <Name> Upload "./" dest=/home/upload mode=inc</b>
::die Dateien des gesamten FHEM-Systems werden nach "/home/upload" inkrementell und strukturerhaltend übertragen.

::<b>set <Name> Upload "/opt/fhem/fhem.pl,./www/images/PlotToChat.png,./log/fhem-2020-10-41.log" dest=/home/upload</b>
::nur die angegebenen Dateien werden nach "/home/upload/<entsprechendes Unterverzeichnis>" übertragen.

=== Informationen über den Uploadstatus ===

Das Reading QueueLength enthält die Anzahl der in der Queue befindlichen Befehle. Hier werden nicht nur Upload-Befehle berücksichtigt, sondern sämtliche noch offenen (oder mit Fehlerstatus behafteten) Einträge.

Wird der Upload ausgeführt, erfolgt ein permanentes Herunterzählen dieses Readings bis auf "0" im Idealfall. Sollte nach Abarbeitung von Befehlen das Reading QueueLength noch den Wert größer "0" haben, konnten nicht alle Befehle abgearbeitet werden. Sätze mit permanenten Fehlerstatus werden zukünftig von der Abarbeitung ausgenommen, andere Einträge mit einem zeitlichen Versatz wiederholt, z.B. wenn die Synology Diskstation zum Zeitpunkt des Uploads nicht erreichbar war.

[[Datei:ssfile2.PNG|right|thumb|300px|Upload Historie]]
Die Ergebnisse der Uploads werden in einer internen Datenabank gespeichert.
Man kann sich die Upload-Historie ausgeben lassen mit dem Befehl:

set <Name> listUploadsDone

Die Übersicht zeigt die übertragenen Quelldateien mit ihrem Ursprungspfad, dem Zielpfad sowie das Datum + Zeit der Übertragung.
Diese Informationen bleiben auch nach einem FHEM Restart erhalten und sind die Grundlage für die Bewertung einer inkrementellen Übertragung.

Die Historie kann bei Bedarf gelöscht werden mit:

set <Name> deleteUploadsDone

Die auf der Synology gespeicherten Dateien werden durch diesen Befehl aber nicht gelöscht.

<br>
= Download von Objekten zum FHEM-Server (Restore) =

Zum Herunterladen von Dateien oder ganzen Ordnern stehen die Befehle '''Download''' bzw. '''prepareDownload''' zur Verfügung.
Die Syntax und das Ergebnis ist bei beiden Befehlen identisch, nur werden bei prepareDownload die herunterzuladenden Objekte zunächst nur in die Ausführungsqueue gestellt. Zum Starten ist dann der Befehl
[[Datei:ssfile3.PNG|right|thumb|300px|Ausgabe von set <> listQueue]]

set <Name> startQueue

auszuführen. Der Setter Download führt die Anweisung sofort aus.
Die mit '''prepareDownload''' erzeugten Queueeinträge können vor der Ausführung mit dem Befehl:

set <Name> listQueue

anzeigt werden. Diese Liste könnte zum Beispiel so aussehen:

5 => retryCount=>0, reqtype=>GET, params=>&path="/backup/Carport-20200625-1147065130.jpg", opmode=>download, method=>download, header=>Accept: application/json, dest=>./Carport-20200625-1147065130.jpg, api=>DOWNLOAD

Am Anfang steht immer der Index des Eintrags, hier ist es der Index 5.
Unerwünschte oder falsche Downloads können bei Bedarf noch gelöscht werden. Der Befehl

set <Name> purgeQueue <Index>

löscht den angegebenen Eintrag mit dem Index, z.B. 5.

Beim Download von Dateien/Ordnern ist zu beachten, dass die Objekte immer in den FHEM root-Ordner, überlicherweise /opt/fhem, geladen werden. Allerdings kann der Zielordner auf dem FHEM-Server durch den Zusatz von '''dest=''' bestimmt werden.

Als Argument von dest= kann angegeben werden:

::* <Filename>: das Objekt wird mit neuem Namen im default Pfad gespeichert
::* <Pfad/Filename>: das Objekt wird mit neuem Namen im angegebenen Pfad gespeichert
::* <Pfad/>: das Objekt wird mit ursprünglichen Namen im angegebenen Pfad gespeichert. '''Wichtig:''' der Pfad muß mit einem "/" enden.

Wird als herunterzuladendes Objekt ein ganzer Ordner des Synology Dateisystems bestimmt, wird der Inhalt des Ordners in ein zip-Archiv verpackt und im Ziel auf dem FHEM-Server gespeichert. Die Dateien sind dann entsprechend aus dem Archiv zu entpacken.

Nachfolgend ein paar Beispiele. Wichtig is es, die angegbenen Objekte in '''""''' einzuschließen, was besondere Bedeutung hat, wenn die Dateien/Ordner Leerzeichen enthalten. Mehrere Objekte (Files, Ordner oder beides gemischt) werden durch Komma getrennt.

<pre>
set <Name> Download "/backup/Carport-20200625-1147065130.jpg"
set <Name> Download "/backup/Carport-20200625-1147065130.jpg" dest=carport.jpg
set <Name> Download "/backup/Carport-20200625-1147065130.jpg" dest=./log/carport.jpg
set <Name> Download "/backup/Carport-20200625-1147065130.jpg" dest=./log/
set <Name> Download "/Temp/Anträge 2020,/backup/Carport-20200625-1147065130.jpg"
set <Name> Download "/backup/Carport-20200625-1147065130.jpg,/Temp/card.txt" dest=/opt/
</pre>

[[Datei:ssfile4.PNG|right|thumb|300px|Ausgabe von get <> remoteFolderList]]
Um sich einen Überblick über die auf der Synology vorhandenen Dateien zu verschaffen, kann man sich vor dem Download ein Liste der Objekte erstellen lassen. Dazu verwendet man den Befehl:

get <Name> remoteFolderList

Ohne weiteres Argument erstellt der Befehl eine Übersicht aller auf der Synology vorhandenenen shared Folder. Um den Inhalt eines bestimmten Ordners anzuzeigen, wird dieser Ordner (inkl. eventueller Unterordner) als Argument mitgegeben, z.B.:

get <Name> remoteFolderList "/FHEM-Prod/2020_11_29"

Das Ordnerobjekt beginnt immer mit einem '''/''' und wird in '''""''' eingeschlossen, um auch Ordnernamen mit Leerzeichen verarbeiten zu können.
Es können noch weitere Optionen mitgegeben werden,um die angezeigten Informationen zu beeinflussen (siehe Commandref zu SSFile).

<br>
= Beispiele zur Anwendung =

== Backup des FHEM Filesystems über Synology Kalendereinplanung ==

Es wird vorgestellt, wie man mit Hilfe des Synology Kalenders Backups des FHEM-Filesystems einplant und ausführen lässt. Dabei werden sowohl Full-Backups als auch inkrementelle Backups erstellt.

Das Backupregime verfolgt folgendes Ziel bzw. Features:

* jede Woche Montag wird ein Full-Backup des gesamten FHEM-Verzeichnisses angefertigt
* die restlichen Tage der Woche werden nur neue oder geänderte Dateien gesichert (inkrementelles Backup)
* jede Sicherung wird auf der Synology in einem gemeinsamen Ordner (z.B. /FHEM-Prod) in jeweils einem separaten Verzeichnis gespeichert
* die Ordnerstruktur der Quelle bleibt innerhalb der Sicherung erhalten (d.h. man weiß genau wohin eine Datei der Sicherung in der Quelle gehört)
* die Sicherungsdateien können direkt wiederhergestellt werden, d.h. es ist kein dekomprimieren oder entpacken nötig.
* bei Bedarf können die Sicherungen ihrerseits durch Synology Backup Werkzeuge (z.B. Hyper Backup) auf externe Datenträger versioniert werden und stehen dadurch lange Zeit zur Verfügung
* die Sicherungen des laufenden Monats bleiben auf der Synology online verfügbar, ältere Backupverzeichnisse werden gelöscht und können bei Bedarf von einem externen Datenträger wiederhergestellt werden
* eine grafische chronologische Übersicht der auszuführenden Sicherungen (und Löschungen) ist z.B. zur Anzeige auf einem Tablet verfügbar

Für das vorgestellte Scenario werden die Module SSFile und SSCal ([[SSCal - Integration des Synology Calendar Servers]]) verwendet. Das Modul SSCal zur Steuerung des Synology Kelenders wird hier nur insofern erläutert wie es für den hier vorgesehenen Einsatzzweck benötigt wird. Weiterführende Informationen findet man in dem [[SSCal - Integration des Synology Calendar Servers|Wiki-Artikel]] zu SSCal.

Um das oben definierte Scenario umzusetzen, werden die dazu nötigen Schritte nachfolgend beschrieben. Es sind dazu '''keine Volume-Mounts''' auf dem FHEM-Server '''nötig'''. Jede Kommunikation und Datenübertragung wird über das lokale Netzwerk abgewickelt.

<br>
=== FHEM Backup-Device anlegen ===

Zur Durchführung der Backup wird ein SSFile Device mit dem Namen '''SynFile''' definiert. Es wird in dem Beispiel die Verbindung zur Synology mit der Adresse 192.168.2.10 hergestellt.

[[Datei:ssfcb0.PNG|right|thumb|400px|Backup Device SynFile]]

<pre>
defmod SynFile SSFile 192.168.2.10
attr SynFile alias Backup auf Synology (API)
attr SynFile devStateIcon .*running:control_arrow_rightward .*done|.*Upload\squeue\sfill\sfinished:control_on_off:startQueue .*Error:control_arrow_rightward@red .*Initialized:control_standby@orange
attr SynFile excludeFromUpload ./FHEM/FhemUtils/cacheSSCam.*,\
./www/SVGcache.*
attr SynFile group Backup
attr SynFile icon system_backup
attr SynFile interval 0
attr SynFile noAsyncFillQueue 0
attr SynFile room Dienste->Allgemein
attr SynFile showPassInLog 0
attr SynFile stateFormat <b>letzter Update:</b> lastUpdate\
<br>\
1:state
attr SynFile verbose 2
</pre>

Nach der Erstdefinition sind die Credentials zur Verbindung mit der DS einzutragen. Im Attribut '''excludeFromUpload''' angegebene Objekte werden von den Backups ausgeschlossen. In dem Beispiel sind es gecachte Daten die im Restorefall nicht benötigt werden.

Dieses Backup-Device wird später von automatisch erstellten at-Devices angesprochen.

<br>
=== freigegebenen Ordner auf Synology DS erstellen ===

Als Ziel für die auszuführenden Backups wird auf der Synology ein freigebener Ordner '''FHEM-Prod''' angelegt.
Die Schritte dazu sind in dieser [https://www.synology.com/de-de/knowledgebase/DSM/help/DSM/AdminCenter/file_share_create Online-Hilfe] beschrieben.

<br>

=== Synology Kalender anlegen ===
[[Datei:ssfcb1.PNG|right|thumb|200px|Synology Kalender]]
Für die vorgesehenen Steuerungen wird ein Kalender auf der Synology DS angelegt wenn noch nicht vorhanden. Im vorliegenden Beispiel wird dazu der Kalender '''Haussteuerung Prod''' verwendet.

Wie ein Synology Kalender angelegt wird, ist z.B. in diesem [https://www.synology.com/de-de/knowledgebase/DSM/help/Calendar/calendar_creating_calendars Hilfeartikel] beschrieben bzw. ist in diversen Onlinemedien abrufbar.

Die von mir verwendete Definition des Synology Kalenders zur Aufnahme von Haussteuerungseinträgen zeigt nebenstehende Abbildung.

<br>

=== den angelegten Synology Kalender in FHEM integrieren ===

Zur FHEM Integration wird das Modul 57_SSCal verwendet. Dieses Modul ist speziell für die Integration des Synology Calendar Servers entwickelt und verfügt über Features die die Erstellung automatisierter Vorgänge in FHEM sehr vereinfachen. Die umfangreichen Möglichkeiten des Modul sind im [http://sds1.myds.me/mediawiki/index.php?title=SSCal_-_Integration_des_Synology_Calendar_Servers|SSCal Wiki-Artikel] näher beschrieben.

Zur Integration des vorher angelegten Kalenders '''Haussteuerung Prod''' wird folgende RAW-Definition des Kalenderdevices '''SynControl''' verwendet:

<pre>
defmod SynControl SSCal 192.168.2.10
attr SynControl alias Synology Kalender Haussteuerung
attr SynControl asyncMode 1
attr SynControl createATDevs 1
attr SynControl cutLaterDays 2
attr SynControl cutOlderDays 1
attr SynControl event-on-update-reading .*Summary.*,state
attr SynControl group Haussteuerung
attr SynControl icon time_calendar
attr SynControl interval 400
attr SynControl room Dienste->Kalender
attr SynControl stateFormat <b>Status:</b> state - <b>Last Update</b>: lastUpdate - <b>Next Update</b>: nextUpdate
attr SynControl tableFields Begin,End,DaysLeft,Weekday,Summary,Status,Calendar
attr SynControl tableSpecs {\
"cellStyle" => {\
"noHeader" => "0",\
"headerAlign" => "center",\
"columnAlign" => "center",\
"columnSymbolAlign" => "center",\
"columnSummaryAlign" => "left",\
},\
"columnMapIcon" => [{\
"Status" => "eq 'ended' ",\
"icon" => "rc_WEB@grey", \
},\
{\
"daysLeft" => ">= 1 ",\
"icon" => "rc_WEB", \
}],\
"columnMapProvider" => "GoogleMaps",\
"columnStateIcon" => [\
{\
"Status" => "eq 'ended' ",\
"icon" => "1px-spacer",\
},\
{\
"Status" => "eq 'started' ",\
"icon" => "10px-kreis-gruen",\
},\
{\
"Status" => "eq 'upcoming' ",\
"icon" => "10px-kreis-gelb",\
},\
{\
"Status" => "eq 'alarmed' ",\
"icon" => "10px-kreis-gruen",\
},\
],\
"columnSymbolIcon" => "time_manual_mode", \
}
attr SynControl usedCalendars Haussteuerung Prod
</pre>

[[Datei:ssfcb2.PNG|right|thumb|400px|grafische Kalenderübersicht]]
Nach der Erstdefinition des Devices muss der verwendete User mit seinen Credentials im Device gesetzt werden. Dadurch werden automatisch alle verfügbaren Kalender der in der DEF angegebenen Synology Diskstation (hier die DS mit der Adresse 192.168.2.10) abgerufen. Der/die relevante(n) Kalender werden danach mit dem '''Attribut usedCalendars''' selektiert.

Wichtig ist das Attribut '''createATDevs'''. Es bewirkt, dass eine im Feld '''Beschreibung''' eines Kalendereintrags vorhandene Codedefinition automatisch in ein at-Device in FHEM umgesetzt wird. Die dazu nötige Syntax wird im Abschnitt "Anlegen eines Kalendereintrags" näher erläutert.

Das Attribut '''tableSpecs''' legt die gewünschten Merkmale zur Gestaltung der graphischen Kalenderanzeige in FHEM fest. Nebenstehende Abbildung zeigt die Kalendergrafik des fertig angelegten Kalenderdevices. Die Übersicht enthält bereits Einträge zur Haussteuerung die es allerdings in einem frisch defninierten Kalender noch nicht gibt und erst durch die nachfolgend beschriebenen Verfahren hinzukommen.

Der im Attribut interval eingestellte Wert 400 definiert einen Abruf der Kalendereinträge alle 400 Sekunden. Dabei werden eventuell im Feld Beschreibung des Kalendereintrags enthaltene Codefinitionen ausgewertet aund automatisch korrespondierende at-Devices angelegt bzw. auch gelöscht/verändert wenn ein Kalendereintrag gelöscht oder entfernt wurde.

<br>

=== den Eintrag für Full-Backup im Synology Kalender Haussteuerung vornehmen ===

Ein Full-Backup soll wöchentlich jeden Montag um 02:15 ausgeführt werden. In der Synology Kalenderapplikation wird dazu der abgebildete Kalendereintag vorgenommen.

[[Datei:ssfcb3.PNG|left|thumb|200px|Kalendereintrag Vollsicherung]]

Ist eine Information über die bevorstehenden Start einer Sicherung gewünscht, kann im Punkt '''Warnung''' ein entsprechender Eintrag vorgenommen werden. Bei der Anlage des Kalendereintrags ist an dieser Stelle der Kalenderdefault hinterlegt, der im vorliegenden Beispiel komplett gelöscht wurde um keinerlei Hinweispopups oder dgl. zu erhalten.

[[Datei:ssfcb4.PNG|right|thumb|300px|Wiederholung Vollsicherung]]

Zur Einplanung der Wiederholung der Vollsicherung wird der Haken bei '''Ereignis wiederholen''' gesetzt und die entsprechende Einstellung zur wöchentlichen Wiederholung vorgenommen.

[[Datei:ssfcb5.PNG|right|thumb|300px|Codedefinition Vollsicherung]]
Die im Ereignis auszuführenden Aktion wird im Feld Beschreibung eingetragen. Das SSCal Device erkennt ein auszuführendes FHEM-Kommando an in geschweifte Klammern '''{...}''' eingebetteten Text.
Um eine Vollsicherung auszuführen, wird folgender Code in diesem Feld eingetragen

{ set SynFile Upload "./" dest=/FHEM-Prod/%Y_%m_%d_Full }

Die Quelle '''./''', also der gesamte root-Ordner der FHEM-Installation, wird gesichert (normalerweise /opt/fhem). Das Zielverzeichnis %Y_%m_%d_Full wird im freigegebenen Ordner FHEM-Prod automatisch angelegt wenn es nicht vorhanden ist. Dabei werden die POSIX Variablen %Y durch das Jahr, %m durch den aktuellen Monat und %d durch den aktuellen Tag ersetzt.

<br>
=== den Eintrag für inkrementelles Backup im Synology Kalender Haussteuerung vornehmen ===

Ein inkrementelles Backup wird an allen anderen Tagen (als Montag) um 02:15 ausgeführt. In der Synology Kalenderapplikation wird dazu der abgebildete Kalendereintag vorgenommen.

[[Datei:ssfcb6.PNG|left|thumb|200px|Kalendereintrag inkrementelle Sicherung]]

Die '''Warnung''' wird bei diesem Eintrag wieder entfernt um keinerlei Hinweispopups oder dgl. vor dem Start der Aktion zu erhalten.

[[Datei:ssfcb7.PNG|right|thumb|300px|Wiederholung inkrementelle Sicherung]]

Zur Einplanung der Wiederholung der inkremntellen Sicherung wird der Haken bei '''Ereignis wiederholen''' gesetzt und die entsprechende Einstellung zur wöchentlichen Wiederholung vorgenommen.

[[Datei:ssfcb8.PNG|right|thumb|300px|Codedefinition Vollsicherung]]
Im Feld Beschreibung wird wieder die Codierung für die Ausführung der inkrementellen Sicherung eingetragen:

{ set SynFile Upload "./" dest=/FHEM-Prod/%Y_%m_%d mode=inc }

Die Codierung entspricht dem oben beschriebenen Vollbackup, außer dass der Zusatz '''mode=inc''' das inkrementelle Backup bewirkt.

<br>

=== den Eintrag zum Löschen alter Backups im Synology Kalender Haussteuerung vornehmen ===

[[Datei:ssfcb9.PNG|left|thumb|200px|Ablagestruktur Sicherungen]]

[[Datei:ssfcb10.PNG|right|thumb|200px|Eintrag Löschen Backups]]
Werden die in den vorangegangenen Punkten definierten Sicherungen ausgeführt, wird jedes Backup in einem separaten Verzeichnis im freigegebenen Ordner FHEM-Prod auf der Synology DS abgelegt wie z.B. im Bild gezeigt.

Es sollen alte Backups des Vormonats gelöscht werden.

Dazu wird am 9. Tag jedes Monats ein Löschvorgang angelegt, der alle Backupverzeichnisse des Vormonats mit deren Inhalten löscht. Die Aktion wird erst einige Tage nach dem Start eines Monats ausgeführt, damit immer hinreichend aktuelle Backups online auf dem NAS zur Verfügung stehen.

Es wird der dargestellte Eintrag um 01:15 angelegt. Die Standardwarnungen werden wiederum gelöscht. Die Wiederholung wird monatlich mit dem Kriterium "Tag des Monats" ausgeführt.

[[Datei:ssfcb11.PNG|left|thumb|200px|Wiederholung Löschen Backups]]

Wie bereits beschrieben, wird der Code des auszuführenden Kommandos im Feld Beschreibung eingetragen. Dieses Mal soll Perl-Code statt eines einfachen FHEM Kommandos ausgeführt werden.

Dazu wird der Code in doppelte geschweifte Klammern eingefügt <nowiki>{{...}}</nowiki>. SSCal erkannt dadurch dass es sich hierbei um Perl-Code handelt und behandelt es entsprechend bei der Anlage des korrespondierenden at-Devices.

[[Datei:ssfcb12.PNG|right|thumb|200px|Code im Beschreibungs Feld]]
<pre>
{{
my $dev = "SynFile";
my $folder = "/FHEM-Prod/%Y_%m_";
my $folderres = strftime "$folder", localtime(time-1728000); # heute - 20 Tage

for my $d (1..31) {
my $d = sprintf "%02d", $d;
my $fstr = $folderres.$d;
my $fstr1 = $folderres.$d."_Full";
CommandSet (undef, qq{$dev deleteRemoteObject "$fstr"});
CommandSet (undef, qq{$dev deleteRemoteObject "$fstr1"});
}
}}
</pre>

<br>

=== Zusammenfassung ===

Wurden alle Aktionen wie beschrieben durchgeführt, enthält das Kalenderdevice SynControl nach jedem Update die auszuführenden Backup-Aktivitäten. Durch die Aktivierung von '''createATDevs''' werden bei jedem Kalenderupdate at-Devices angelegt welche die gewünschten Backup-Aktionen terminieren und ausführen.

[[Datei:ssfcb13.PNG|right|thumb|200px|erzeugte at-Devices]]
[[Datei:ssfcb14.PNG|left|thumb|200px|erzeugtes at-Device]]
[[Datei:ssfcb15.PNG|right|thumb|200px|Backup Übersicht]]

Das Kalenderdevice enthält im Abschnitt '''Probably associated with''' eine Übersicht der automatisch erzeugten at-Devices.
Die Namen der Devices sind generisch und enthalten neben der EventId auch den geplanten Ausführungszeitpunkt.

Mit jedem Backup-Lauf wird ein Unterverzeichnis <Jahr>_<Monat>_<Tag> in FHEM-Prod angelegt in dem die gesicherten Dateien gespeichert werden. Die Sicherung ist strukturerhaltend, d.h. die FHEM-Verzeichnisse der gesicherten Daten werden ebenfalls mit angelegt.
Sicherungen die die älter sind als der aktuelle Monat werden am neunten Tag des aktuellen Monats entfernt.

Möchte man die Sicherungen längere Zeit versioniert speichern, bietet sich der zusätzliche Einsatz des Tools Hyper Backup an.

Zur Anzeige der grafischen Backup-Übersicht auf einem Tablet kann zum Beispiel ein [[SSCal_-_Integration_des_Synology_Calendar_Servers#Termintabelle_als_Weblink_einf.C3.BCgen|Weblink-Device]] verwendet werden.

<br>

= Beschränkungen und Known Bugs =

* es werden bei '''Upload/prepareUpload''' nur Dateien/Verzeichnisse berücksichtigt deren Name '''kein @''' beinhaltet.

Wetter und Wettervorhersagen

2021-06-19T15:25:11Z

50watt: /* Yahoo-Wetter */ umbenannt nach Weather Modul, APIs aufgelistet

Wetterdaten und Wettervorhersagen können auf verschiedene Weise in FHEM eingebunden werden.

== Modul Weather ==
Das Modul [[Weather]] extrahiert Wetterdaten via API von den Wetterdatenanbietern
* [https://openweathermap.org/ Openweathermap]
** Vorschauzeitraum: 5 Tage (zeitliche Auflösung: 3 Stunden)
** Aktuelle Daten (minütlich)
** 1000 Abrufe pro Tag mit dem Gratis-API-Key (Stand: Juni 2021)
* [https://www.wunderground.com/ wunderground]
** API-KEY nur für Gerätebesitzer
* [https://darksky.net/ DarkSky]
** API soll Ende 2022 abgeschaltet werden
** Es können keine neuen API-Key erstellt werden (Stand: Juni 2021)

Da die Yahoo Weather API zum 03.01.2019 abgeschaltet wurde, kann Weather keine Wetterdaten von Yahoo mehr beziehen.

== Unwetterzentrale ==
Informationen der Seite(n) Unwetterzentrale.de können mit Hilfe des Moduls [[UWZ]] eingebunden werden.

== Modul OPENWEATHER ==
Das Modul [[OPENWEATHER]] extrahiert Wetterdaten über die "openweather"-Schnittstelle (API) von www.wetter.com.
*Vorschau-Zeitraum: 3 Tage
*Vorschau-Interval: 6:00, 11:00, 17:00, 23:00
*Aktuelle Daten: keine

== Modul PROPLANTA ==
Das Modul [[PROPLANTA]] extrahiert Wetterdaten von der Website www.proplanta.de. (keine API)
*Vorschau-Zeitraum: 12 Tage
*Vorschau-Interval: 3 h
*Aktuelle Daten: jede volle Stunde

== Modul WWO ==
Das {{Link2CmdRef|Anker=WWO|Label=Modul WWO}} extrahiert Wetterdaten über die (alte) API von worldweatheronline.com
*Vorschau-Zeitraum: ?? Tage<BR>
*Vorschau-Interval: ??<br>
*Aktuelle Daten: ??

== Deutscher Wetterdienst (DWD) ==

=== Modul DWD_OpenData ===
Das Modul [[DWD_OpenData]] stellt einen Teil der frei verfügbaren Daten des Deutschen Wetterdienstes (DWD) bereit, die über den [https://www.dwd.de/DE/leistungen/opendata/opendata.html Open Data Server] abgerufen werden können (diverse Datenformate, keine API).
*Vorschau-Zeitraum: 10 Tage
*Vorschau-Interval: datenabhängig, viele mit 3 h
*Vorschau-Orte: national und international
*Aktuelle Daten: nicht implementiert
*Wetterwarnungen: für Landkreise und Gemeinden in deutsch oder englisch

Es gibt zum Modul auch einen Weblink für [[FHEMWEB]], der 2 Icons pro Tag in horizontaler Form darstellt. Die Anzahl der insgesamt dargestellten Icons ist konfigurierbar. Liegen Wetterwarnungen vor, wird zusätzlich ein Warnsymbol angezeigt, über das man per Klick weitere Details zur Wetterwarnung abrufen kann.

[[DWD_OpenData|Weitere Details und Installationsbeschreibung]]

=== Wetterwarnungen als Karte ===
Der Deutsche Wetterdienst [http://www.dwd.de DWD] stellt neben diversen Wetterdaten auch Wetterwarnungen in Bildform bereit. Diese können sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden - das ist zwar nicht die schönste Form, aber die schnellste.

Dazu sucht man sich zuerst auf der [http://www.dwd.de/bvbw/appmanager/bvbw/dwdwwwDesktop?_nfpb=true&_pageLabel=_dwdwww_wetter_warnungen_warnungen&T92053gsbDocumentPath=BEA__Navigation%2FWetter__Warnungen%2FWarnungen.html%3F__nnn%3Dtrue&lastPageLabel=dwdwww_wetter_warnungen Warnungsseite des DWD] die eigene Region heraus (in der Karte durchklicken). Die gewünschte URL für Berlin Stadt ist z.B. <code>http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html#WS_ANCHOR_0</code>. Das Anhängsel <code>#WS_ANCHOR_0</code> kann man in der Konfiguration auch weglassen.

Die Einbindung in FHEM sieht dann wie folgt aus:
<pre>
define dwd_warnmeldung weblink iframe http://www.dwd.de/dyn/app/ws/html/reports/BXX_warning_de.html
attr dwd_warnmeldung group Wetterwarnungen (DWD)
attr dwd_warnmeldung htmlattr width="100%" height="300" frameborder="0" marginheight="0" marginwidth="0"
attr dwd_warnmeldung room Wettervorhersage,Startseite
</pre>

== Vorhersage-Diagramm von YR ==
[http://www.yr.no YR] ist die Seite des norwegischen Wetterdiensts. Er ist zwar nur in Teilen auf Englisch (und gar nicht auf Deutsch) verfügbar, bietet aber sehr gute Wettervorhersagen - auch mit eigenen Vorhersagen für kleine Dörfer. Neben etlichen Detailinfos bietet YR eine sehr schicke 48h-Vorhersage-Grafik. Diese kann sehr einfach via [http://fhem.de/commandref_DE.html#weblink weblink iframe] in FHEM eingebunden werden.

Dazu geht man auf die [http://www.yr.no Startseite von YR] und gibt in das Suchfeld den Namen seines Dörfchens ein - die Ergebnissliste kann ziemlich lang werden, sodass man evtl. sehr genau schauen muss, welches das eigene Kaff ist - bei mir war es an 29. Stelle... ;-) Auf der gewünschten Seite gibt es einen Unterpunkt "Hour by hour", wo sich die besagte Grafik findet. Hier kopiert man sich einfach die URL der Grafik.

Die Einbindung in FHEM sieht dann bspw. wie folgt aus:
<pre>
define Wetter_yr_Vorhersage weblink iframe http://www.yr.no/place/Germany/Berlin/Berlin/meteogram.png
attr Wetter_yr_Vorhersage group Wettervorhersage (yr)
attr Wetter_yr_Vorhersage htmlattr width="100%" height="300" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter_yr_Vorhersage room Wettervorhersage,Start
</pre>

== Wetter von Weather Underground ==
{{Randnotiz|RNTyp=r|RNText=Das ("offene") API von Weather Underground wird derzeit (März 2019) "retired" = abgestellt, ist also künftig nicht mehr nutzbar! Den benötigten API-Key bekommen "nur noch" Betreiber einer Wetterstation, die diese bei wundergound registrieren und ihre Daten hochladen.}}
'''Hinweis:''' Die hier beschriebene Vorgehensweise ist etwas anspruchsvoller und somit eher für erfahrene FHEM-User geeignet.

[http://www.wunderground.com/ Weather Underground] bietet eine sehr umfassende Sammlung aller möglichen offiziellen und privaten (aber teils sehr professionellen) Wetterstationen weltweit. Es besteht eine recht hohe Wahrscheinlichkeit, dass es in der eigenen Umgebung schon eine Wetterstation gibt. Anstatt nun selbst eine komplette Wetterstation aufzubauen, kann man alternativ auf die Daten der Nachbarstation zugreifen.

{{Randnotiz|RNTyp=y|RNText=Neben dem hier vorgestellten Abruf der Weather Underground-Daten mit [[HTTPMOD]] kann auf Weather Underground-Daten auch mit dem darauf spezialisierten Modul [http://fhem.de/commandref.html#Wunderground Wunderground] zugegriffen werden.}}

Dazu sind grundsätzlich die folgenden Schritte notwendig:
* Finden der geeigneten Station
* Auswerten der XML-Daten
* Erstellen passender gplot-Dateien

=== Finden der geeigneten Station ===
Als erstes geht man auf die [http://www.wunderground.com Startseite von Weather Underground] und gibt in das Suchfeld den Namen seines Dörfchens oder der nächsten Stadt ein - für Berlin landet man bspw. auf Seite für "Berlin Alexanderplatz". Es gibt aber manchmal sehr viele Wetterstationen in der direkten Umgebung. Diese findet man indem am auf "Change Station" klickt und sich eine passende Station aussucht. Nähere Infos (zB. zur verwendeten Hard- und Software) zu der gewählten Wetterstation erhält man, wenn man auf den Namen der Station klickt und dann auf "About this PWS".

Weather Underground stellt die Daten der Wetterstation auch über eine API als XML bereit, die wir auswerten können. Die entsprechende URL findet sich ebenfalls unter "About this PWS" unter "Download current conditions XML". Für Berlin Prenzlauer Berg wäre dies z.B.
<code>http://api.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&format=XML</code>.

Entscheidend für die jeweilige Station ist der Teil nach "?=ID", also in diesem Fall "IBERLIN15". Dieser Teil des Links lässt sich leicht durch die ID einer anderen Station ersetzen und die Suche nach dem entsprechenden Link auf der Seite der Station bleibt erspart.

=== Auswerten der XML-Daten ===
Die Auswertung der XML-Daten erfolgt via [[HTTPMOD]]. Da dies nicht ganz trivial ist, sind im Folgenden zuerst die wesentlichen Konfigurationsschritte exemplarisch beschrieben. Weiter unten findet sich dann die fertige vollständige Konfiguration.

Es erstes wird das Device HTTPMOD definiert (die 600 am Schluss ist der Aktualisierungszyklus in Sekunden, also alle 10 min):
:<code>define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600 </code>

Dann werden Attribute für alle Readings definiert:
:<code>attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date ... </code>

Dann wird jedem Attribut ein Name zugewiesen (unter diesem Namen wird der Wert ins Log geschrieben):
:<code>attr wetter_prenzelberg readingsName_cloudiness cloudiness </code>

Zum Schluss wird das Reading selbst definiert:
:<code>attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+) </code>

Die gesamte Konfiguration für alle von der API angebotenen Wetterwerte sieht dann wie folgt aus:
<pre>
define wetter_prenzelberg HTTPMOD http://api.wunderground.com/weatherstation/WXCurrentObXML.asp?ID=IBERLIN15 600
attr wetter_prenzelberg userattr readingsName_cloudiness readingsName_date readingsName_dewpointTemperature readingsName_fog readingsName_heatindex readingsName_humidity readingsName_pressure readingsName_solarRadiation readingsName_solarUV readingsName_temperature readingsName_time readingsName_windChill readingsName_windDegrees readingsName_windDirection readingsName_windGust readingsName_windSpeed readingsRegex_cloudiness readingsRegex_date readingsRegex_dewpointTemperature readingsRegex_fog readingsRegex_heatindex readingsRegex_humidity readingsRegex_pressure readingsRegex_solarRadiation readingsRegex_solarUV readingsRegex_temperature readingsRegex_time readingsRegex_windChill readingsRegex_windDegrees readingsRegex_windDirection readingsRegex_windGust readingsRegex_windSpeed
attr wetter_prenzelberg readingsName_cloudiness cloudiness
attr wetter_prenzelberg readingsName_date date
attr wetter_prenzelberg readingsName_dewpointTemperature dewpointTemperature
attr wetter_prenzelberg readingsName_fog fog
attr wetter_prenzelberg readingsName_heatindex heatindex
attr wetter_prenzelberg readingsName_humidity humidity
attr wetter_prenzelberg readingsName_pressure pressure
attr wetter_prenzelberg readingsName_solarRadiation solarRadiation
attr wetter_prenzelberg readingsName_solarUV solarUV
attr wetter_prenzelberg readingsName_temperature temperature
attr wetter_prenzelberg readingsName_time time
attr wetter_prenzelberg readingsName_windChill windChill
attr wetter_prenzelberg readingsName_windDegrees windDegrees
attr wetter_prenzelberg readingsName_windDirection windDirection
attr wetter_prenzelberg readingsName_windGust windGust
attr wetter_prenzelberg readingsName_windSpeed windSpeed
attr wetter_prenzelberg readingsRegex_cloudiness cloudiness id="NN" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_date date date" content="([\d\.]+)
attr wetter_prenzelberg readingsRegex_dewpointTemperature <dewpoint_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_fog fog id="FOG" percent="([\d\.]+)
attr wetter_prenzelberg readingsRegex_heatindex <heat_index_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_humidity <relative_humidity>([\d\.]+)
attr wetter_prenzelberg readingsRegex_pressure <pressure_mb>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarRadiation <solar_radiation>([\d\.]+)
attr wetter_prenzelberg readingsRegex_solarUV <UV>([\d\.]+)
attr wetter_prenzelberg readingsRegex_temperature <temp_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_time time Zeit([\d\:]+)
attr wetter_prenzelberg readingsRegex_windChill <windchill_c>(\+|-?[\d\.]+)
attr wetter_prenzelberg readingsRegex_windDegrees <wind_degrees>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windDirection <wind_dir>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windGust <wind_gust_mph>([\d\.]+)
attr wetter_prenzelberg readingsRegex_windSpeed <wind_mph>([\d\.]+)
</pre>
Hinweis: Nicht immer werden alle Werte geliefert (wenn keine Sonne, dann kein UV-Wert...). Im System-Log kann das als Fehler auftauchen, ist aber kein Problem.

=== Erstellen passender gplot-Dateien ===
Um die ausgelesenen Werte als Graphen darstellen zu können müssen eigene gplot-Dateien erstellt werden. Eine grundsätzliche Anleitung dazu findet sich unter [[Creating Plots]]. Deshalb sollen hier nur Beispiele für die eigentlichen gplot-Dateien vorgestellt werden. Beispiele sollten sowohl für [[FileLog]] wie [[DbLog]] funktionieren.

Temperatur und Luftfeuchte:
<pre>
set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
#set title '<L1>'
set title ''
set ytics
set y2tics
set grid ytics
set ylabel "Temperature in C"
set y2label "Humidity (%)"

#FileLog 4:temperature\x3a::
#FileLog 4:windChill\x3a::
#FileLog 4:humidity\x3a::

#DbLog <SPEC1>:temperature::
#DbLog <SPEC1>:windChill::
#DbLog <SPEC1>:humidity::

plot "<IN>" using 1:2 axes x1y1 title 'Temperatur (C)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Gefühlte Temperatur (C)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Luftfeuchtigkeit (%)' ls l2fill lw 0.2 with lines
</pre>

Wind und Windrichtung:
<pre>
set terminal png transparent size <SIZE> crop

set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "

set ytics
set y2tics ("Nord" 0, "Ost" 80, "Süd" 180, "West" 270, "Nord" 360)

#set title '<L1>'
set title ''

set grid xtics ytics

set yrange [0:20]
set y2range [0:360]

set ylabel "Wind (mph)"
set y2label "Richtung"

#FileLog 4:windSpeed:0:
#FileLog 4:windGust:0:
#FileLog 4:windDegrees:0:

#DbLog <SPEC1>:windSpeed::
#DbLog <SPEC1>:windGust::
#DbLog <SPEC1>:windDegrees::

plot "<IN>" using 1:2 axes x1y1 title 'Wind (mph)' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'Böen (mph)' ls l1 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y2 title 'Windrichtung (°)' ls l2fill lw 0.2 with points
</pre>

Sonnenintensität und UV-Werte:
<pre>
set terminal png transparent size <SIZE> crop

set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "

set ytics
set y2tics

#set title '<L1>'
set title ''

set grid xtics ytics

set ylabel "Sonnenstrahlung (W/qm)"
set y2label "UV"

#FileLog 4:solarRadiation:0:
#FileLog 4:solarUV:0:

#DbLog <SPEC1>:solarRadiation::
#DbLog <SPEC1>:solarUV::

plot "<IN>" using 1:2 axes x1y1 title 'Strahlung' ls l0 lw 1.5 with lines,\
"<IN>" using 1:2 axes x1y1 title 'UV' ls l1 lw 1.5 with lines
</pre>

'''Weitere TBD'''

=== Vergangene Daten abfragen ===
Ein konkretes vergangenes Datum der Wetterstation kann man übrigens auch abrufen - für den 28.11.2014 wäre dies bspw.
<code>http://www.wunderground.com/weatherstation/WXDailyHistory.asp?ID=IBERLIN15&day=28&month=11&year=2014&graphspan=day&format=1</code>.

=== Eigene Wetterdaten hochladen ===
{{Randnotiz|RNTyp=g|RNText=Unterstützung für das Modul gibt es im dazugehörigen {{Link2Forum|Topic=65587|LinkText=Forumsthread }}.}}
Wer eigene Wetterdaten hochladen will, kann hierzu das {{Link2CmdRef|Anker=WUup|Label=Modul WUup}} verwenden. Dazu benötigt man die Zugangsdaten (stationID und Paßwort) für eine eigene Wetterstation. Mit dem Modul können die meisten vom [http://web.archive.org/web/20180815041359/http://wiki.wunderground.com/index.php/PWS_-_Upload_Protocol PWS Upload Protocol] unterstützten Daten hochgeladen werden:
* Winddir - [0-360 momentane Windrichtung]
* Windspeedmph - [mph momentane Windgeschwindigkeit]
* Windgustmph - [mph aktuellen Böe, mit Software-spezifischem Zeitraum]
* Windgustdir - [0-360 mit Software-spezifischer Zeit]
* Windspdmph_avg2m - [mph durchschnittliche Windgeschwindigkeit innerhalb 2 Minuten]
* Winddir_avg2m - [0-360 durchschnittliche Windrichtung innerhalb 2 Minuten]
* Windgustmph_10m - [mph Böen der vergangenen 10 Minuten]
* Windgustdir_10m - [0-360 Richtung der Böen der letzten 10 Minuten]
* Feuchtigkeit - [% Außenfeuchtigkeit 0-100%]
* Dewptf- [F Taupunkt im Freien]
* Tempf - [F Außentemperatur]
* Rainin - [in Regen in der vergangenen Stunde]
* Dailyrainin - [in Regenmenge bisher heute]
* Baromin - [inHg barometrischer Druck]
* Soiltempf - [F Bodentemperatur]
* Bodenfeuchtigkeit - [%]
* Solarradiation - [W/m²]
* UV - [Index]
* AqPM2.5 - Feinstaub PM2,5 [µg/m³]
* AqPM10 - Feinstaub PM10 [µg/m³]

Die Werte werden im Modul für Wunderground ins anglo-amerikanische System umgerechnet. Temperaturen werden also automatisch von °Celsius in Fahrenheit, Windgeschwindigkeiten von km/h in mph, mm in Inch und der barometrische Druck von hPa in inHg umgerechnet.

== Wetternetzwerk auf wetter.com ==
Ein vollständiges Beispiel zur Nutzung der Informationen über die Regenmenge (Station 1445, Weinheim) von wetter.com ist in {{Link2Forum|Topic=39600|Message=332837|LinkText=diesem Forenbeitrag}} beschrieben.

== Wetter von netatmo ==
Das FHEM-Modul [[netatmo]] ermöglicht den Datenimport von privaten und öffentlichen netatmo Wetterstationen sowie den Abruf der in der Netatmo App verfügbaren Wettervorhersage. Eine Übersicht über die verfügbaren öffentlichen Stationen findet sich auf der Seite [http://www.netatmo.com/de-DE/weathermap Weathermap]. Die meisten öffentlichen Stationen liefern Temperatur, Luftfeuchte und Luftdruck, einige auch Wind, Regen und Daten zur Luftqualität (CO<sub>2</sub>).

== Links ==
* {{Link2Forum|Topic=33610}} mit Sammlung und Beipielen von Internet-Links für die Anzeige von teilweise animierten Wetterbildern
* [http://bloglich.de/art/rpi/wetterdaten-auf-dem-raspberry-pi-in-fhem/ Beispiel in Blog(de)]
* [[HTTPMOD]] [[Kategorie:Code Snippets]] [[Kategorie:HOWTOS]] [[Kategorie:Wetterstationen]]

Speedtest

2021-05-16T16:14:11Z

50watt: Kleinigkeiten zum ookla binary ergänzt

{{Infobox Modul
|ModPurpose=Testet die Internetgeschwindigkeit
|ModType=d
|ModCmdRef=speedtest
|ModForumArea=Sonstiges
|ModTechName=32_speedtest.pm
|ModOwner=Andre / justme1968 ({{Link2FU|430|Forum}} / [[Benutzer_Diskussion:Justme|Wiki]])}}
[[Speedtest]] ist ein Modul, mit dem in regelmäßigen Abständen die Internet-Geschwindigket (Download, Upload, Ping) gemessen werden kann. Dabei wird auf das externe Python-Script [https://github.com/sivel/speedtest-cli speedtest-cli] zurückgegriffen.

Mit dem Stand vom 05.10.2020 kann alternativ auch das offizielle CLI Binary von ookla verwendet werden. Dies liefert in der Regel genauere Werte, vor allem bei höheren Bandbreiten.

== Voraussetzungen ==
Für diese Anleitung ist notwendig:
* Debian-Derivat (Debian, Ubuntu, Raspbian, ...)
* Linux-Grundkenntnisse
* Paket- und Quellenverwaltung apt-get
* wget

Alle in diesen Kapitel genannten Befehle müssen auf der Kommandozeile abgesetzt werden.

=== Installation von speedtest-cli ===
Voraussetzung:
* Python 2.4 - 3.4
{{Hinweis|Sollte [https://www.python.org/ Python] und/oder [https://www.gnu.org/software/wget/ wget] nicht installiert sein, kann das mit folgenden zwei Befehlen erledigt werden:
sudo apt-get update
sudo apt-get install python wget
}}
Zuerst muss das speedtest-cli - Script heruntergeladen werden. Der folgende Befehl erledigt das mit Hilfe von wget und speichert die Datei im Verzeichnis ''/usr/local/bin'':
sudo wget -O /usr/local/bin/speedtest-cli https://raw.githubusercontent.com/sivel/speedtest-cli/master/speedtest.py

Anschließend muss die Datei noch als "ausführbar" markiert werden:
sudo chmod +x /usr/local/bin/speedtest-cli

Ob alles funktioniert hat, kann man dann mit einem einfachen Aufruf überprüfen:
speedtest-cli --help

Weitere Installationsanleitungen sind auf der [https://github.com/sivel/speedtest-cli speedtest-cli - Webseite] zu finden.

=== Installation des CLI Binary von ookla ===

Alternativ das CLI Binary von ookla: https://www.speedtest.net/apps/cli herunterladen.

Für RasperryPi:
* <code> wget https://install.speedtest.net/app/cli/ookla-speedtest-1.0.0-arm-linux.tgz</code>
* <code> tar -xzvf ookla-speedtest-1.0.0-arm-linux.tgz</code>
* <code>mv speedtest /usr/local/bin/</code>

und setzen des Attributs <code>ookla</code> mit dem Wert 1.

Falls damit der folgende Fehler im FHEM-Log angezeigt wird
<pre>
2020.10.07 11:52:14.721 5: speedtest done
what(): basic_string::_M_construct null not valid
terminate called after throwing an instance of 'std::logic_error'
</pre>
muss das FHEM-Start -Script angepasst werden. Beispiel in {{Link2Forum|Topic=114118|Message=1090706|LinkText=diesem Forenbeitrag}}.

== Definition ==
Das Modul wird folgendermaßen definiert:
define <name> speedtest [interval] [server]

=== Optionen ===
*<code><interval></code>: Optional. Der Wert bestimmt, in welchen Zeitabständen ein Geschwindigkeitstest durchgeführt wird. Wird kein Intervall angegeben, wird der Standard-Wert (3600s) verwendet. Minimum sind 1800 Sekunden.
*<code><server></code>: Optional. Hier kann die ID eines Speedtest-Servers eingetragen werden, gegen den die Geschwindigkeits-Tests gefahren werden. Ist kein Wert angegeben, wird der "nächstgelegene" Server verwendet.

{{Hinweis|Eine Liste aller verfügbaren Speedtest-Server kann mittels <code>speedtest-cli --list</code> bzw. <code>speedtest-cli --list {{!}} grep Germany</code> angezeigt werden}}

=== Readings ===
* <code>ping</code> (ms)
* <code>download</code> (MBit/s)
* <code>upload</code> (MBit/s)

=== Set ===
* <code>statusRequest</code>: Startet einen manuellen Durchlauf des definierten Tests

=== Attribute ===
Bei der Definition des Moduls können folgende Attribute gesetzt werden:
* <code>path</code>: Hier kann das Verzeichnis des speedtest-cli-Scripts angegeben werden (z.B.: /usr/local/bin).
* <code>checks-till-disable</code>: Über dieses Attribut lässt sich festlegen, wie häufig speedtest-cli ausgeführt werden soll, bevor der automatische Aufruf deaktiviert wird. Nach Ablauf des Zählers wird das Modul automatisch auf disable gesetzt. Bei jedem Durchlauf wird der Zähler um 1 reduziert.
* <code>disable</code>: Ist dieses Attribut auf 1 gesetzt, ist die automatische Ausführung deaktiviert. Das manuelle Ausführen über <code>set</code> ist trotzdem möglich.
* <code>ookla</code>: Ist dieses Attribut auf 1 gesetzt, wird das CLI Binary von ookla verwendet.
== Beispiel ==
[[File:speedtest01.png|mini|right|200px|Ein speedtest-Device nach dem Geschwindigkeits-Test]]

=== Definition des Moduls ===
<syntaxhighlight lang="perl">
define MySpeedtest speedtest 1800 5255
attr MySpeedtest path /usr/local/bin
</syntaxhighlight>

=== Logging in eine Datei ===
Das Speichern der Ergebnisse in ein Logfile erreicht man z.B. so:
<syntaxhighlight lang="perl">
define FileLog_MySpeedtest FileLog ./log/MySpeedtest-%Y%m.log MySpeedtest:.*
attr FileLog_MySpeedtest logtype text
</syntaxhighlight>

==== Plot (FileLog)====
Ein zugehörige SVG-Plot könnte wie folgt aussehen:
<syntaxhighlight lang="perl">
############################
# Display speedtest results

set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title '<L1>'

set yrange [0:1]
set y2range [0:12]
set y3range [0:120]

set ylabel "Mbit/s"
set y2label "Mbit/s"
set y3label "ms"

#FileLog 4:speedtest.download\x3a::
#FileLog 4:speedtest.upload\x3a::
#FileLog 4:speedtest.ping\x3a::

plot
using 1:2 ls l0 axes x1y2 title 'download (Mbit/s)' with lines,
using 1:2 ls l1 axes x1y1 title 'upload (Mbit/s)' with lines,
using 1:2 ls l2 axes x1y3 title 'ping (ms)' with lines
</syntaxhighlight>

Der Weblink dazu wird wie folgt definiert:
<syntaxhighlight lang="perl">
define wl_speedtest SVG FileLog_speedtest:speedtest3:CURRENT
</syntaxhighlight>

=== Logging mit Hilfe von [[DbLog]] ===
Das Loggen in eine Datenbank erfolgt, wenn ein Reading explizit oder generell alle Readings bei der Definition von [[DbLog]] angegeben worden sind und bei der Definition des Moduls [[Speedtest]] die Readings nicht über ''DbLogExclude'' ausgeschlossen wurden.

==== Plot (DbLog) ====
Definition des Plots bei Verwendung von DbLog:
<syntaxhighlight lang="perl">
define wl_speedtest SVG myDbLog:speedtest:HISTORY
attr wl_speedtest label "DL $data{currval1} / UL $data{currval2} / ping $data{currval3}"
attr wl_speedtest plotfunction speedtest
</syntaxhighlight>

Definition der Datei speedtest.gplots:
<syntaxhighlight lang="perl">
############################
# Display speedtest results

set terminal png transparent size <SIZE> crop
set output '<OUT>.png'
set xdata time
set timefmt "%Y-%m-%d_%H:%M:%S"
set xlabel " "
set title '<L1>'

set yrange [0:1]
set y2range [0:12]
set y3range [0:120]

set ylabel "Mbit/s"
set y2label "Mbit/s"
set y3label "ms"

#myDbLog <SPEC1>:download:::$val=~s/([\d.]*).*/$1/eg
#myDbLog <SPEC1>:upload:::$val=~s/([\d.]*).*/$1/eg
#myDbLog <SPEC1>:ping:::$val=~s/([\d.]*).*/$1/eg

plot
using 1:2 ls l0 axes x1y2 title 'download (Mbit/s)' with lines,
using 1:2 ls l1 axes x1y1 title 'upload (Mbit/s)' with lines,
using 1:2 ls l2 axes x1y3 title 'ping (ms)' with lines
</syntaxhighlight>

== Bekannte Probleme ==
* Für den Betrieb ist Python notwendig. Daher läuft das Script nicht ohne Weiteres auf einer FritzBox.
* Zwischenzeitlich wurde das Script umbenannt. Das Modul erwartet nach wie vor den ursprünglichen Namen. Daher ist wie oben beschrieben darauf zu achten, dass das abgelegte Script <code>speedtest-cli</code> heißt und notfalls dementsprechend umbenannt wird.
* Das Modul bricht ggf. mit einer Perl-Fehlermeldung im FHEM-Log ab, obwohl das Script von der Konsole aus einwandfrei läuft. Dies tritt z.B. bei Verwendung von Rasbian mit installierten Python 2.7 und Python 3 auf. Zur Behebung muss im Script <code>speedtest-cli</code> die erste Zeile auf <code>#!/usr/bin/env python'''3'''</code> geändert werden.
* Auf manchen Systemen muss in aktuellen speedtest-cli Versionen die Zeile <code>'(%s; U; %s; en-us)' % (platform.system(), platform.architecture()[0]),</code> auskommentiert werden.

== Troubleshooting ==
Im Folgenden sind ein paar Ansatzpunkte genannt, um beim Troubleshooting zu unterstützen:
* Das Script läuft auf der Kommandzeile problemlos, das Modul bringt aber Fehler:
** Script ist nicht ausführbar (<code>chmod +x speedtest-cli</code>)
** Der FHEM-User (''fhem'') hat keine Berechtigung das Script auszuführen

* SVG-Plot zeigt nichts an:
** Verweis auf Filelog oder DbLog falsch
** Falsches gplot-File angegeben
** Übergabe der Plotfunktion (bei DbLog) nicht korrekt
** Falsche Groß-/Kleinschreibung verwendet (case sensitive)

* Fehlermeldung ''isn't numeric in sprintf at ./FHEM/98_SVG.pm''
** Dieses kommt grundsätzlich immer dann vor, wenn SVG versucht einen Wert einzulesen, der neben der Zahl auch die Einheit enthält. Dieses kann bei der Verwendung von DbLog vorkommen, weil DbLog nicht weiß, wie es Wert und Einheit trennen soll. Abhilfe schafft eine entsprechende Regular Expression, die nur den Zahlenwert liefert.

== Weblinks ==
* Beschreibung des Scripts [http://binarynature.blogspot.de/2013/03/measure-internet-connection-speed-from-linux-command-line.html binarynature.blogspot.de]
* [https://pypi.python.org/pypi/speedtest-cli speedtest-cli auf pypi.python.org]
* [https://github.com/sivel/speedtest-cli speedtest-cli auf github.com]
* Forumseintrag über die Entwicklung des Moduls {{Link2Forum|Topic=13419|Message=83189|LinkText=Thema: Internetgeschwindigkeit überwachen}}
* Forumseintrag darüber, dass das Binary nicht auf der Fritzbox läuft {{Link2Forum|Topic=27242|Message=201516|LinkText=Thema: Internetgeschwindigkeit - speedtest}}
* Forumseintrag über aus der Idee wird ein Modul {{Link2Forum|Topic=13483|Message=83538|LinkText=Thema: Internetgeschwindigkeit überwachen}}
* Forumsbeitrag zum Einsatz unter Windows {{Link2Forum|Topic= 111602|LinkText=Thema: Speedtest für windows}}

== Sonstiges ==
Besten Dank an wkarl, Puschel74, justme1968 für Idee, Modulerstellung/Pflege und Installationsanleitung.

EnOcean-TF61J-Eltako-TippFunk-Jalousieaktor

2021-05-09T07:40:28Z

50watt: /* Einrichtung des TF61J Langversion */ Tippfehler

{{Infobox Hardware
|Bild=Tf61j.png
|Bildbeschreibung=TF61J Fertigungswoche 21/18
|HWProtocol=EnOcean
|HWType=Aktor, Empfänger
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=bidirektional
|HWVoltage=230V~
|HWPowerConsumption=Eigenverbrauch ca. 0,8W
|HWPoweredBy=230V
|HWSize=45x45x18mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Eltako
}}

{{Randnotiz|RNText=Getestet mit Geräten aus der Fertigungswoche 21/18}}

'''EnOcean-TF61J-Eltako-TippFunk-Jalousieaktor''' ist ein Aktor
* für
** Unterputzmontage
* für
** Steuerung von Rollladen und Beschattungselementen

== Einleitung ==

Ich betreibe 14 TF61J in meinem Haus. In einigen Räumen betreibe ich bis zu 3 TF61J.
Bei der Einrichtung gab es hierdurch viele Komplikationen, weshalb ich meine Erfahrunge teilen will.

== Wissenswertes zu Tipp-Funk Geräten: ==
Tipp-Funk ist die Low Cost Serie von Eltako. Verständlicher muss der Hersteller hier einige Funktionen abspecken um den Preis zu erreichen.
Folgendes ist deshalb zu beachten.

'''1. Konfiguration / Schalter / LEDs'''

Die Geräte verfügen über keine LEDs oder Schalter. Alles wird über Taster Kommandos eingestellt, als Rückmeldung dienen Fahrbewegungen der Motoren.

Die fabrikneuen Geräte gehen beim Anschalten in den Lernmodus, was Sie durch kurze Fahrbewegungen anzeigen.
Wurde schon einmal mit den Geräten gespielt kann es sein das Sie nicht in den Lernmodus gehen.
Deshalb beim Einlernen immer komplett resetten!

Werden zwei oder mehr Tipp-Funk Geräte gleichzeitig eingschalten, sind beide im Lernmodus. Jedes Einlernen wird also auf beide Geräte übertragen und beide bewegen sich.
Deshalb immer den Lernmodus sperren!

'''2. Bidirektionale Kommunikation'''

Diese ist standardmäßig aus.
Also zuerst immer einschalten!

'''3. Verschlüsselung'''

Alle Eltako Tipp-Funk TF Geräte verfügen nicht über Verschüsselung.
Wer dieses Feature möchte muss zum anderen Eltako Produkten greifen.
Aus meiner Sicht ist das fehlen von Verschlüsselung für Jalousien im normalen Haushalt aber ok.

'''4. Repeater'''

Alle Eltako Tipp-Funk TF Geräte verfügen nicht über eine Repeater Funktion.
Wer dieses Feature möchte muss zum anderen Eltako Produkten greifen.
Dieses Feature kann bei größeren Entfernungen Sinn machen, wobei hier ein einziges Gerät als Repeater evtl. schon reichen würde.

== Einrichtung des TF61J Kurzversion ==
# EnOID aufschreiben
# Strom An/Aus
# Bidirektionale Kummunikation anschalten
# Bei mehreren TF61J pro Stromkreis -> Lernmodus sperren
# Device in FHEM anlegen
# Eventuell automatisch erkannte Geräte löschen
# Strom An/Aus
# Speicherinhalt komplett löschen (Auslieferzustand herstellen)
# Device in FHEM teachen
# Lernmods sperren

== Einrichtung des TF61J Langversion ==
Die Schritte sind nicht unbedingt alle nötig. Waren die TF61J jedoch schon einmal konfiguriert, ist unklar in welchem Zustand / Konfiguration sie sich befinden.
Dies hat bei mir zu vielen Problemen geführt. Deshalb meine Empfehlung: alle Schritte durchlaufen, dann funktioniert es sicher!

'''1. Vor dem Einbau'''

Die EnOID aufschreibe. Diese brauchen wir später!

'''2. Strom An/Aus'''

'''3. Bidirektionale Kommunikation (Bestätigungs Telegramme) einschalten.'''

Der TF61J kann rückmelden was er gerade tut und uns Bestätigungstelegramme schicken. Diese Funktion ist ab Werk deaktiviert.
Taucht im EventMonitor von FHEM beim drücken eines mit einem TF Gerät verbunden Tasters keine Nachricht auf, ist die Bidirektionale Kommunikation entweder deaktiviert oder das Gerät zu weit vom Sender entfernt.
Um einzuschalten: Am örtlichen Taster 7-mal kurz plus 1-mal lang (>1 Sekunde) tippen. Der TF muss dann 2-malig kurzen 'Ab, Halt' signalisieren.

'''4. Bei mehreren TF61J pro Stromkreis -> Lermodus Sperren'''

Damit nicht mehrere TF gleichzeitig lernen und so z.B. bei Steuerung aus FHEM heraus gleichzeitig fahren, darf immer nur ein TF lernbereit sein.
Lernmodus AN für den TF der Lernen soll: Am örtlichen Taster 4-mal kurz plus 1-mal lang (>1 Sekunde) tippen. Der TF muss dann 1-malig kurz 'Ab, Halt' signalisieren.
Lernmodus AUSfür den TF der nicht Lernen soll: Am örtlichen Taster 3-mal kurz plus 1-mal lang (>1 Sekunde) tippen. Der TF muss dann 2-malig kurz 'Ab, Halt' signalisieren.

'''5. Anlegen in FHEM'''
Jetzt legen wir das Gerät in FHEM an.
Hierzu geben wir einen RolloNamen ein.
Die EnOID haben wir vom Gerät abgeschrieben.
H5-3F-7F ist die EEP mit der wir definieren das es ein TF61J ist. (Wird später durch FHEM auf A5-3F-7F geändert was scheinbar so sein muss)

define <RolloName> EnOcean <EnOID> H5-3F-7F

Jetzt empfehle ich noch die subDef (das ist die EnoceanID des virtuellen Senders aus FHEM heraus) fest vorzugeben.
Ich hatte hier viele Probleme: Plötzlich sind andere Rollos mitgefahren, weil FHEM hier die DEF (EnOID) anderer Rollos eingetragen hat.
Vermutlich hatte ich vorher schon zuviele konfiguriert und wieder gelöscht und einiges blieb wohl im System hängen.

Mit

{EnOcean_CheckSenderID("getUsedID","<IODev>","0000000")};

schauen wir uns an, welche Sender-IDs schon vergeben sind. Hier einfach die ganz rechte nehmen und 1 dazu zählen (HEX):
Beispiel:
FFDFE101 FFDFE102 FFDFE103
Also nehmen wir FFDFE104
Sollte in dieser Liste eine EnOID eines deiner Geräte auftauchen, ist eines schon falsch konfiguriert.

'''6. Eventuell automatisch erkannte Geräte löschen'''
Sind Geräte durch Strom An/Aus automatisch erkannt worden, stehen Sie z.B. unter switch als EnO_xxxxxxx device. Ich habe diese in diesem Schritt immer gelöscht.

'''7. Strom An/Aus'''

'''8. TF61J Speicherinhalt komplett löschen (Auslieferzustand herstellen)'''
Sehr wichtig! Einfach machen, dann funktioniert die Konfiguration sicher!
Am örtlichen Taster 8-mal kurz plus 1-mal lang (>1 Sekunde) tippen. Der TF muss dann 1-malig kurz 'Ab, Halt' signalisieren.

'''9. Teachen'''
Jetzt müssen wir den TF61J noch vernünftig einlernen

set <RolloName> teach

Der Rollladen sollte nun einmal 2 kurz als Bestätigung fahren.

'''10. Lernmodus sperren'''
Am Ende immer den Lernmodus sperren. Sonst könnte der TF versehentlich andere Taster mitlernen.

== Bekannte Probleme ==

'''1. Falscher Rollladen fährt bzw. fährt zusätzlich bei Steuerung aus FHEM heraus'''

Bei Einlernen waren mehrer TF61J im Lernmodus. Alle haben den Software Taster des FHEM eingelernt.
-> Alle betroffenen Geräte neu Konfigurieren

Die SubDef eines Gerätes ist auf eine EnOID eines anderen Gerätes eingestellt, dann fährt dieses mit.
-> SubDef wie in Punkt 5 beschrieben Auswählen und Ändern.
-> Alle betroffenen Geräte neu Konfigurieren

'''2. Ich sehe die Kommandos des angeschlossenen Tasters in FHEM, jedoch kann ich den Rollladen aus FHEM nicht steuern.'''

Konfiguration hat nicht funktioniert.
-> Noch einmal von vorne anfangen.

'''3. Der TF61J reagiert nicht auf Tasterkommandos'''

*Der angeschlossene Taster hackt oder prellt. Beim Eingeben der Tasterkommandos hin hören, was das Relais macht (klack). Durch kürzeres oder längeres Drücken funktioniert es dann meistens.

*Der TF61J ist nicht im Lernmodus. Entsperren.

*Der TF61J hat den Lernmodus verlassen (geschieht nach 120s). Strom An/Aus.

== Links ==
[https://www.tipp-funk.de/bedienungsanleitungen/ Bedienungsanleitungen (Fertigungswoche beachten!)]

[[Kategorie:EnOcean Components]]
[[Kategorie:Rollladensteuerung]]

EnOcean-TF61J-Eltako-TippFunk-Jalousieaktor

2021-05-09T07:37:20Z

50watt: /* Einrichtung des TF61J Langversion */ Tippfehler

{{Infobox Hardware
|Bild=Tf61j.png
|Bildbeschreibung=TF61J Fertigungswoche 21/18
|HWProtocol=EnOcean
|HWType=Aktor, Empfänger
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=bidirektional
|HWVoltage=230V~
|HWPowerConsumption=Eigenverbrauch ca. 0,8W
|HWPoweredBy=230V
|HWSize=45x45x18mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Eltako
}}

{{Randnotiz|RNText=Getestet mit Geräten aus der Fertigungswoche 21/18}}

'''EnOcean-TF61J-Eltako-TippFunk-Jalousieaktor''' ist ein Aktor
* für
** Unterputzmontage
* für
** Steuerung von Rollladen und Beschattungselementen

== Einleitung ==

Ich betreibe 14 TF61J in meinem Haus. In einigen Räumen betreibe ich bis zu 3 TF61J.
Bei der Einrichtung gab es hierdurch viele Komplikationen, weshalb ich meine Erfahrunge teilen will.

== Wissenswertes zu Tipp-Funk Geräten: ==
Tipp-Funk ist die Low Cost Serie von Eltako. Verständlicher muss der Hersteller hier einige Funktionen abspecken um den Preis zu erreichen.
Folgendes ist deshalb zu beachten.

'''1. Konfiguration / Schalter / LEDs'''

Die Geräte verfügen über keine LEDs oder Schalter. Alles wird über Taster Kommandos eingestellt, als Rückmeldung dienen Fahrbewegungen der Motoren.

Die fabrikneuen Geräte gehen beim Anschalten in den Lernmodus, was Sie durch kurze Fahrbewegungen anzeigen.
Wurde schon einmal mit den Geräten gespielt kann es sein das Sie nicht in den Lernmodus gehen.
Deshalb beim Einlernen immer komplett resetten!

Werden zwei oder mehr Tipp-Funk Geräte gleichzeitig eingschalten, sind beide im Lernmodus. Jedes Einlernen wird also auf beide Geräte übertragen und beide bewegen sich.
Deshalb immer den Lernmodus sperren!

'''2. Bidirektionale Kommunikation'''

Diese ist standardmäßig aus.
Also zuerst immer einschalten!

'''3. Verschlüsselung'''

Alle Eltako Tipp-Funk TF Geräte verfügen nicht über Verschüsselung.
Wer dieses Feature möchte muss zum anderen Eltako Produkten greifen.
Aus meiner Sicht ist das fehlen von Verschlüsselung für Jalousien im normalen Haushalt aber ok.

'''4. Repeater'''

Alle Eltako Tipp-Funk TF Geräte verfügen nicht über eine Repeater Funktion.
Wer dieses Feature möchte muss zum anderen Eltako Produkten greifen.
Dieses Feature kann bei größeren Entfernungen Sinn machen, wobei hier ein einziges Gerät als Repeater evtl. schon reichen würde.

== Einrichtung des TF61J Kurzversion ==
# EnOID aufschreiben
# Strom An/Aus
# Bidirektionale Kummunikation anschalten
# Bei mehreren TF61J pro Stromkreis -> Lernmodus sperren
# Device in FHEM anlegen
# Eventuell automatisch erkannte Geräte löschen
# Strom An/Aus
# Speicherinhalt komplett löschen (Auslieferzustand herstellen)
# Device in FHEM teachen
# Lernmods sperren

== Einrichtung des TF61J Langversion ==
Die Schritte sind nicht unbedingt alle nötig. Waren die TF61J jedoch schon einmal konfiguriert, ist unklar in welchem Zustand / Konfiguration sie sich befinden.
Dies hat bei mir zu vielen Problemen geführt. Deshalb meine Empfehlung: alle Schritte durchlaufen, dann funktioniert es sicher!

'''1. Vor dem Einbau'''

Die EnOID aufschreibe. Diese brauchen wir später!

'''2. Strom An/Aus'''

'''3. Bidirektionale Kommunikation (Bestätigungs Telegramme) einschalten.'''

Der TF61J kann rückmelden was er gerade tut und uns Bestätigungstelegramme schicken. Diese Funktion ist ab Werk deaktiviert.
Taucht im EventMonitor von FHEM beim drücken eines mit einem TF Gerät verbunden Tasters keine Nachricht auf, ist die Bidirektionale Kommunikation entweder deaktiviert oder das Gerät zu weit vom Sender entfernt.
Um einzuschalten: Am örtlichen Taster 7-mal kurz plus 1-mal lang (>1 Sekunde) tippen. Der TF muss dann 2-malig kurzen 'Ab, Halt' signalisieren.

'''4. Bei mehreren TF61J pro Stromkreis -> Lermodus Sperren'''

Damit nicht mehrere TF gleichzeitig lernen und so z.B. bei Steuerung aus FHEM heraus gleichzeitig fahren, darf immer nur ein TF lernbereit sein.
Lernmodus AN für den TF der Lernen soll: Am örtlichen Taster 4-mal kurz plus 1-mal lang (>1 Sekunde) tippen. Der TF muss dann 1-malig kurz 'Ab, Halt' signalisieren.
Lernmodus AUSfür den TF der nicht Lernen soll: Am örtlichen Taster 3-mal kurz plus 1-mal lang (>1 Sekunde) tippen. Der TF muss dann 2-malig kurz 'Ab, Halt' signalisieren.

'''5. Anlegen in FHEM'''
Jetzt legen wir das Gerät in FHEM an.
Hierzu geben wir einen RolloNamen ein.
Die EnOID haben wir vom Gerät abgeschrieben.
H5-3F-7F ist die EEP mit der wir definieren das es ein TF61J ist. (Wird später durch FHEM auf A5-3F-7F geändert was scheinbar so sein muss)

define <RolloName> EnOcean <EnOID> H5-3F-7F

Jetzt empfehle ich noch die subDef (Die Adresse des Virtuellen Senders aus FHEM heraus) fest vorzugeben.
Ich hatte hier viele Probleme das plötzlich andere Rollos mit gefahren sind weil FHEM hier die DEF (EnOID) anderere Rollos eingetragen hat.
Vermutlich hatte ich vorher schon zuviele konfiguriert und wieder gelöscht und einiges blieb wohl im System hängen.

Mit

{EnOcean_CheckSenderID("getUsedID","<IODev>","0000000")};

schauen wir uns an, welche Sender-IDs schon vergeben sind. Hier einfach die ganz rechte nehmen und 1 dazu zählen (HEX):
Beispiel:
FFDFE101 FFDFE102 FFDFE103
Also nehmen wir FFDFE104
Sollte in dieser Liste eine EnOID eines deiner Geräte auftauchen, ist eines schon falsch konfiguriert.

'''6. Eventuell automatisch erkannte Geräte löschen'''
Sind Geräte durch Strom An/Aus automatisch erkannt worden, stehen Sie z.B. unter switch als EnO_xxxxxxx device. Ich habe diese in diesem Schritt immer gelöscht.

'''7. Strom An/Aus'''

'''8. TF61J Speicherinhalt komplett löschen (Auslieferzustand herstellen)'''
Sehr wichtig! Einfach machen, dann funktioniert die Konfiguration sicher!
Am örtlichen Taster 8-mal kurz plus 1-mal lang (>1 Sekunde) tippen. Der TF muss dann 1-malig kurz 'Ab, Halt' signalisieren.

'''9. Teachen'''
Jetzt müssen wir den TF61J noch vernünftig einlernen

set <RolloName> teach

Der Rollladen sollte nun einmal 2 kurz als Bestätigung fahren.

'''10. Lernmodus sperren'''
Am Ende immer den Lernmodus sperren. Sonst könnte der TF versehentlich andere Taster mitlernen.

== Bekannte Probleme ==

'''1. Falscher Rollladen fährt bzw. fährt zusätzlich bei Steuerung aus FHEM heraus'''

Bei Einlernen waren mehrer TF61J im Lernmodus. Alle haben den Software Taster des FHEM eingelernt.
-> Alle betroffenen Geräte neu Konfigurieren

Die SubDef eines Gerätes ist auf eine EnOID eines anderen Gerätes eingestellt, dann fährt dieses mit.
-> SubDef wie in Punkt 5 beschrieben Auswählen und Ändern.
-> Alle betroffenen Geräte neu Konfigurieren

'''2. Ich sehe die Kommandos des angeschlossenen Tasters in FHEM, jedoch kann ich den Rollladen aus FHEM nicht steuern.'''

Konfiguration hat nicht funktioniert.
-> Noch einmal von vorne anfangen.

'''3. Der TF61J reagiert nicht auf Tasterkommandos'''

*Der angeschlossene Taster hackt oder prellt. Beim Eingeben der Tasterkommandos hin hören, was das Relais macht (klack). Durch kürzeres oder längeres Drücken funktioniert es dann meistens.

*Der TF61J ist nicht im Lernmodus. Entsperren.

*Der TF61J hat den Lernmodus verlassen (geschieht nach 120s). Strom An/Aus.

== Links ==
[https://www.tipp-funk.de/bedienungsanleitungen/ Bedienungsanleitungen (Fertigungswoche beachten!)]

[[Kategorie:EnOcean Components]]
[[Kategorie:Rollladensteuerung]]

Homebridge User Configs

2020-09-30T21:22:16Z

50watt: /* Homematic Luftfeuchtigkeits- und Tmeperatursensoren */ Tippfehler

Dieser Eintrag dient zur Sammlung funktionsfähiger Homebridge Configs.

Bitte immer die FHEM Version und Homebridge Version angegeben.

Sehr gute Hinweise gibt es hier: http://www.meintechblog.de/2015/10/mit-siri-und-fhem-das-gesamte-smart-home-per-stimme-steuern/
== Mögliche Mappings ==
Die Möglichen Mappings können hier nachgelesen werden https://github.com/KhaosT/HAP-NodeJS/tree/master/src/lib/gen insbesondere in HomeKit.ts.

Hier ein Beispiel:
Characteristic.Brightness = function() {
Characteristic.call(this, 'Brightness', '00000008-0000-1000-8000-0026BB765291');
this.setProps({
format: Characteristic.Formats.INT,
unit: Characteristic.Units.PERCENTAGE,
maxValue: 100,
minValue: 0,
minStep: 1,
perms: [Characteristic.Perms.READ, Characteristic.Perms.WRITE, Characteristic.Perms.NOTIFY]
});
this.value = this.getDefaultValue();
};

Das Mapping in diesem Fall, hat den Titel Brightness.

Die Werte können in 1er Schritten zwischen 0 und 100 liegen (max und min Value)
== Erstellung eines HomebridgeMappings am Beispiel "Feuchtesensor" ==
Zum Einstieg etwas leicht nachvollziehbares.

Feuchtesensoren haben in der Regel ein "humidity" Reading, im Falle des Opus XT300 Bodenfeuchtesensors auch Temperatur und Batterie Level. Homekit unterstützt einen "HumiditySensor" Service. Dieser ist in homebridge-fhem nicht standardmäßig vorhanden (kann also nicht aus dem dropdown ausgewählt werden, sondern muss über das Befehlsfeld zugewiesen werden):

<code>attr meinSensor genericDeviceType HumiditySensor</code>

Im nächsten Schritt werden die Readings gemappt:

<code>attr meinSensor homebridgeMapping clear CurrentRelativeHumidity=humidity StatusLowBattery=battery,values=ok:BATTERY_LEVEL_NORMAL;;/^.*/:BATTERY_LEVEL_LOW CurrentTemperature=temperature</code>

<code>clear</code>löscht default mappings - das wird in der Regel nicht notwendig sein, schadet aber nicht

<code>CurrentRelativeHumidity</code> ist die relevante Homekit Characteristic - wird mit dem entsprechenden Reading des Sensors gemappt.

<code>StatusLowBattery</code> erwartet entweder BATTERY_LEVEL_NORMAL oder _LOW. Mein Sensor liefert ok zurück, wenn alles gut ist, also wird "ok" auf _NORMAL gemappt, alles andere auf _LOW.

Der Opus XT300 Bodenfeuchtesensors liefert auch noch die Temperatur - der HumiditySensor Service sieht das eigentlich nicht vor, daher wird die Temperatur auch nicht in der Apple "Home" App angezeigt. Bei Eve wird die Temperatur hingegen berücksichtigt.

== BRAVIA Fernseher ==
Ein Beispiel homebridgeMapping für Sony Bravia Fernseher (iOS 12.2 beta!) und genericDeviceType Television:
<pre>
clear
ConfiguredName:model
Active:state,values=off:INACTIVE;on:ACTIVE,cmds=ACTIVE:on;INACTIVE:off
RemoteKey:key,cmds=REWIND:remoteControl+Rewind;FAST_FORWARD:remoteControl+FastForward;NEXT_TRACK:remoteControl+NEXT_TRACK;PREVIOUS_TRACK:remoteControl+PREVIOUS_TRACK;ARROW_UP:remoteControl+Up;ARROW_DOWN:remoteControl+Down;ARROW_LEFT:remoteControl+Left;ARROW_RIGHT:remoteControl+Right;SELECT:remoteControl+Ok;BACK:remoteControl+RETURN;EXIT:remoteControl+Exit;PLAY_PAUSE:remoteControl+Play;INFORMATION:remoteControl+Info
SleepDiscoveryMode:default=ALWAYS_DISCOVERABLE
ClosedCaptions:default=0
DisplayOrder:default=Test1
CurrentMediaState:default=0:currentTitle
TargetMediaState:default=0,cmds=PLAY:remoteControl+play;PAUSE:remoteControl+pause;STOP:remoteControl+stop;
PictureMode:default=1
PowerModeSelection:default=1,cmds=0:remoteControl+options
ActiveIdentifier:input,default=0,values=/tv.dvbt|TV...DVB-T/:1;/HDMI.3/:2,cmds=1:input+TV+/+DVB-T;2:input+HDMI+3/ARC;3:application+Plex
TelevisionSpeaker#Mute=mute
Active:default=ACTIVE
VolumeSelector:volume,cmds=INCREMENT:VolumeUp;DECREMENT:VolumeDown
VolumeControlType:default=RELATIVE_WITH_CURRENT
linkedTo=Television
InputSource(1)#Identifier:default=1
ConfiguredName:default=TV
IsConfigured:default=CONFIGURED
InputSourceType:default=TUNER
CurrentVisibilityState:default=SHOWN
linkedTo=Television
InputSource(2)#Identifier:default=2
ConfiguredName:default=APPLE+TV
IsConfigured:default=CONFIGURED
InputSourceType:default=HDMI
CurrentVisibilityState:default=SHOWN
linkedTo=Television
InputSource(3)#Identifier:default=3
ConfiguredName:default=PLEX
IsConfigured:default=CONFIGURED
InputSourceType:default=APPLICATION
CurrentVisibilityState:default=SHOWN
linkedTo=Television
</pre>

damit lässt sich der Fernseher über Siri/Homekit ein- und ausschalten sowie über das appleTV Control-Center Widget steuern.

== EnOcean STM 250 Tür-/Fensterkontakt ==
Der STM 250 liefert als Status in FHEM <code>open</code>, wenn das Fenster offen und damit der Kontakt "offen" ist. Analog liefert er <code>closed</code> wenn das Fenster geschlossen und damit auch der Kontakt geschlossen ist. Diese Statusangaben sind sehr intuitiv zu verstehen und zu interpretieren.

Die characteristic <code>ContactSensorState</code> von HomeKit liefert entweder den Wert <code>CONTACT_DETECTED=0</code> oder <code>CONTACT_NOT_DETECTED=1</code> zurück. Wobei <code>CONTACT_DETECTED</code> bedeutet, dass der Kontakt geschlossen ist. Je nach Darstellung in der HomeKit-fähigen App muss dieses Verhalten bei der Interpretation berücksichtigt werden. Die App Eve von Elgato zum Beispiel liefert für Kontaktsensoren "JA" oder "NEIN" mit der Bedeutung <code>CONTACT_DETECTED=0=JA</code> bzw. <code>CONTACT_NOT_DETECTED=1=NEIN</code> zurück.

Noch ein wichtiger Punkt: Um einen Sensorkontakt sinnvoll einzurichten sollte als zusätzlicher Wert für das Attribut <code>genericdeviceType</code> der Wert <code>ContactSensor</code> hinzugefügt werden. Wie das geht ist im Eintrag [[Homebridge_einrichten#FHEM_konfigurieren | Homebridge einrichten]] ausführlicher beschrieben.

Folgende Attribute dann hinzufügen:
attr STM250 genericDeviceType ContactSensor
attr STM250 homebridgeMapping ContactSensorState=state,values=closed:CONTACT_DETECTED;open:CONTACT_NOT_DETECTED

Getestet mit
FHEM 5.7 Rev. 9893
Homebridge 0.2.16
homebridge-fhem Vorschauversion aus {{Link2Forum|Topic=48558|Message=402024|LinkText=homebridge/homekit}}

== Modul RESIDENTS für Anwesenheitserkennung und Steuerung der Anwesenheit benutzen ==
[[Datei:Homebridge_bewohner_zu_szene.jpeg|mini|Schaltzustand eines Bewohners zu einer Szene hinzufügen]]
Aus den einzelnen Komponenten des Moduls RESIDENTS, homebridge sowie der characteristic <code>On</code> und der Szenensteuerung lässt sich eine gleichzeitige Steuerung der Anwesenheit und Anwesenheitserkennung basteln.

Dazu müssen folgende Schritte unternommen werden:
* einem Bewohner aus dem Modul ROOMMATE die Steuerung über homebridgeMapping hinzufügen
* Szene für "Ich bin zu Hause" und "Ich gehe jetzt" in einer HomeKit-fähigen App wie z.B. Eve einrichten

Man kann einen beliebigen Bewohner aus dem Modul ROOMMATE nehmen und ihn über die characteristic <code>On</code> in Form eines Schalters sozusagen schaltbar machen. Nur wird das Ein- und Ausschalten des Bewohners über HomeKit in FHEM auf den Status home bzw. absent gemappt. Seit dem 06.02.2016 werden RESIDENTS automatisch als Occupancy Sensor für HomeKit annonciert. Nun noch die Attribute des ROOMMATE wie folgt setzen:
attr <ROOMMATE> genericDeviceType switch
attr <ROOMMATE> homebridgeMapping On=state,valueOn=/home|awoken|asleep|gotosleep/,valueOff=/gone|absent/,cmdOn=home,cmdOff=absent

Natürlich muss der Bewohner noch dem Filter von homebridge hinzugefügt und homebridge neu gestartet werden.

Anschließend geht es in der HomeKit-fähigen App Deiner Wahl weiter. In Eve von Elgato ist von vornherein zum Beispiel vorgesehen, dass man zwei Szenen "Ich bin zuhause" und "Ich verlasse das Haus" hat. Zu diesen Szenen wird eine Aktion hinzugefügt indem der Bewohner, den das ROOMMATE-Modul meldet zur Szene hinzugefügt wird und beim Nachhausekommen "eingeschaltet" wird. Genauso wird mit der Szene "Ich verlasse das Haus" verfahren: Bewohner zur Szene hinzufügen und den Schaltvorgang auf "ausschalten" setzen.

Mit den Sprachbefehlen "Ich bin zuhause" oder "Ich verlasse das Haus" wird die entsprechende Szene eingeschaltet, homebridge schaltet über das <code>homebridgeMapping</code> Attribut dann den Bewohner auf "home" oder "absent".

Getestet mit
FHEM 5.7 Rev. 9893
Homebridge 0.2.16
homebridge-fhem Vorschauversion aus {{Link2Forum|Topic=48558|Message=402024|LinkText=homebridge/homekit}}

Eine noch etwas bessere Schaltmöglichkeit bietet '''genericDeviceType security'''.
Das Mapping für ROOMMATE sieht wie folgt aus:
attr TYPE=ROOMMATE genericDeviceType security
attr TYPE=ROOMMATE homebridgeMapping SecuritySystemCurrentState=state,values=/home|awoken/:0;;absent:1;;/asleep|gotosleep/:2;;gone:3 SecuritySystemTargetState=SecuritySystemCurrentState,cmds=0:state+home;;1:state+absent;;2:state+gotosleep;;3:state+gone,delay=1
für GUEST:
attr TYPE=GUEST genericDeviceType security
attr TYPE=GUEST homebridgeMapping SecuritySystemCurrentState=state,values=/home|awoken/:0;;absent:1;;/asleep|gotosleep/:2;;none:3 SecuritySystemTargetState=SecuritySystemCurrentState,cmds=0:state+home;;1:state+absent;;2:state+gotosleep;;3:state+none,delay=1

== Homematic Luftfeuchtigkeits- und Temperatursensoren ==

Mit folgenden Geräten wurde folgendes Mapping erstellt und somit erfolgreich getestet:

- HM-WDS10-TH-O
- HM-WDS40-TH-I
- HM-WDS40-TH-I-2

Achtung: Hier wird genericDeviceType "TemperatureSensor" verwendet, um eine history in EVE zu erhalten. Mit einem "HumiditySensor" funktionierte dies bei den Tests (Februar 2019) nicht.

attr <THSensor> genericDeviceType TemperatureSensor

attr <THSensor> CurrentRelativeHumidity=humidity
CurrentTemperature=temperature
StatusLowBattery=battery,values=ok:BATTERY_LEVEL_NORMAL;/^.*/:BATTERY_LEVEL_LOW
history:size=1024

== Homematic SmokeDetector HM-SEC-SD und HM-SEC-SD2 ==
[[Datei:Homebridge-Homematic-Smokedetector-Gen1.jpg|mini|Homebridge-Homematic-Smokedetector-Gen1 in EVE]]
Es sind keine Homebridge Mappings für die Rauch Meldung erforderlich.

Allerdings ist ein Mapping für den Batterie Zustand nötig, siehe Unten.

attr <SmokeDetector> genericDeviceType SmokeSensor
attr <SmokeDetector> subType smokeDetector

attr <SmokeDetector> homebridgeMapping StatusLowBattery=battery,values=ok:BATTERY_LEVEL_NORMAL;;/^.*/:BATTERY_LEVEL_LOW

== Homematic Heizkörperthermostat HM-CC-RT-DN ==
[[Datei:HM-CC-RT-DN-Eve.PNG|mini|Darstellung des HM-CC-RT-DN in der iOS App Eve]]
attr <HMCCRTDN_Channel2_Clima> homebridgeMapping TargetTemperature=desired-temp::desired-temp,minValue=5,maxValue=35,minStep=0.5,nocache=1
CurrentTemperature=BU_Heizung_01_Clima:measured-temp,nocache=1
StatusLowBattery=BU_Heizung_01:battery,values=ok:BATTERY_LEVEL_NORMAL;;/^.*/:BATTERY_LEVEL_LOW
TargetHeatingCoolingState=heatingState,values=OFF:0;;HEAT:1;;COOL:2;;AUTO:3,cmds=OFF:controlManu+off;;HEAT:controlMode+boost;;AUTO:controlMode+auto;;COOL:controlManu+17.0
CurrentHeatingCoolingState=heatingState,values=OFF:0;;HEAT:1;;COOL:2;;AUTO:0,valud=OFF
attr <HMCCRTDN_Channel2_Clima> siriName Robby
Dieses Mapping bezieht sich auf ein vorhandenes ''userReading'' mit dem Namen <code>heatingState</code>, womit Homekit die einzelnen Status nachher unterscheidet.
attr <HM-CC-RT-DN_Clima> userReadings heatingState {(ReadingsVal($NAME,"ValvePosition",0) > 0 || ReadingsVal($NAME,"desired-temp","-") eq "on") ? "HEAT" : ReadingsVal($NAME,"desired-temp","-") eq "off" ? "OFF" : ReadingsVal($NAME,"controlMode","auto") eq "auto" ? "AUTO" : (ReadingsVal($NAME,"measured-temp",20) > ReadingsVal($NAME,"desired-temp",20)) ? "COOL" : "AUTO"}
Global auf alle in FHEM angelegten HM-CC-RT-DN, lässt sich mit folgendem Befehl das ''userReading'' anlegen.
Siehe [https://forum.fhem.de/index.php/topic,59211.msg505986.html#msg505986 Forumsthread].

attr TYPE=CUL_HM:FILTER=model=HM-CC-RT-DN:FILTER=chanNo=04 userReadings heatingState {(ReadingsVal($NAME,"ValvePosition",0) > 0 || ReadingsVal($NAME,"desired-temp","-") eq "on") ? "HEAT" : ReadingsVal($NAME,"desired-temp","-") eq "off" ? "OFF" : ReadingsVal($NAME,"controlMode","auto") eq "auto" ? "AUTO" : (ReadingsVal($NAME,"measured-temp",20) > ReadingsVal($NAME,"desired-temp",20)) ? "COOL" : "AUTO"}

== Homematic Wetterstation OC3 HM-WDS100-C6-O-2 ==
[[Datei: homebridge-wetter.jpg|mini|Wetterstation in EVE]]
Mit der EVE und den hier: [https://github.com/naofireblade/homebridge-weather-plus/blob/master/util/characteristics.js] beschriebenen Characteristics lässt sich eine lokale Homematic OC3 Wetterstation aus FHEM einbinden:
<pre>
clear
CurrentTemperature:temperature
CurrentRelativeHumidity:humidity
49C8AE5A-A3A5-41AB-BF1F-12D5654F9F41:windSpeed,name=WINDGESCHWINDIGKEIT,format=FLOAT,unit=kmh,maxValue=250,minValue=0,minStep=1
46f1284c-1912-421b-82f5-eb75008b167e:windDirection,name=WINDRICHTUNG,format=UINT8,unit=ARC_DEGREE,maxValue=360,minValue=0,minStep=1
StatusLowBattery:battery,values=ok:BATTERY_LEVEL_NORMAL;/^.*/:BATTERY_LEVEL_LOW
ccc04890-565b-4376-b39a-3113341d9e0f:RegenmengeLast24Hours:state,name=REGEN_24h,format=FLOAT,unit=mm,maxValue=100,minValue=0,minStep=1
10c88f40-7ec4-478c-8d5a-bd0c3cce14b7:RegenmengeLast1Hours:state,name=REGEN_1h,format=FLOAT,unit=mm,maxValue=100,minValue=0,minStep=1
0000006B-0000-1000-8000-0026BB765291:brightness,name=BRIGHTNESS,format=FLOAT,unit=LUX,maxValue=10000,minValue=0,minStep=.0001
cd65a9ab-85ad-494a-b2bd-2f380084134c:isRaining,name=BEDINGUNGKATEGORIE,values=0:0;1:2,format=UINT8,maxValue=3,minValue=0,minStep=1
cd65a9ab-85ad-494a-b2bd-2f380084134d:isRaining,name=BEDINGUNG,format=STRING,values=0:-;/.*/:Regen
</pre>

== Roomba über THINKINGCLEANER Modul ==
attr <THINKINGCLEANER> genericDeviceType switch
attr <THINKINGCLEANER> homebridgeMapping clear On=state,valueOn=/^(on|dock)/,cmdOn=on,cmdOff=off,nocache=1 ChargingState=deviceStatus,values=/(_recon|_full|_trickle)$/:CHARGING;/^.*/:NOT_CHARGING
attr <THINKINGCLEANER> siriName Robby

Getestet mit
FHEM 5.7 Rev. 12680
homebridge 0.4.11
homebridge-fhem 0.2.66

== Vallox Belüftungsanlage ==
Die Steuerung der Lüftungsgeschwindigkeit ist nur in Prozent möglich. Die Umrechnung erfolgt im [[Vallox]] Modul.
Hierzu wurde das Reading ''FanSpeedPct'' hinzugefügt.

attr <Vallox> genericDeviceType Fan
attr <Vallox> homebridgeMapping clear
model=Vallox
On=PowerState,valueOn=1,readOnly=1
RotationSpeed=FanSpeedPct,minValue=1,maxValue=100,cmd=FanSpeedPct,delay=1

== Xiaomi Vacuum Cleaner 1. Generation ==
[[Datei:XIAOMI_VACUUM_CLEANER-Gen1.jpg|mini|XIAOMI VACUUM 1. GEN in EVE]]
Voraussetzung zur Verwendung der Mappings, ist ein eingebundener Staubsauger mit dem Modul 72_XiaomiDevice.

Siehe [https://forum.fhem.de/index.php/topic,73052.0.html Forumsthread]
Das Modul muss manuell installiert werden.

attr <XIAOMI> genericDeviceType switch
attr <XIAOMI> homebridgeMapping On=state,valueOn=Cleaning,cmdOn=start,cmdOff=charge
RotationSpeed=fan_power,minValue=0,maxValue=90,cmd=fan_power,delay=1
BatteryLevel=batteryLevel,maxValue=100,minValue=0,minStep=1
StatusLowBattery=battery,values=ok:BATTERY_LEVEL_NORMAL;;low:BATTERY_LEVEL_LOW
ChargingState=state,values=Docked:NOT_CHARGING;;Charging:CHARGING;;/.*/:NOT_CHARGEABLE
OccupancyDetected=state,values=/Docked|Charging/:OCCUPANCY_DETECTED;;/.*/:OCCUPANCY_NOT_DETECTED
FilterLifeLevel=consumables_filter,minValue=0,maxValue=100
FilterChangeIndication=consumables_filter,values=0:CHANGE_FILTER

== Roborock S50 (2. Generation des Xiaomi Vacuum Cleaners) ==
[[Datei:Roborock S50.png|mini]]
Voraussetzung zur Verwendung der Mappings, ist ein eingebundener Staubsauger mit dem Modul 72_XiaomiDevice.

Siehe [https://forum.fhem.de/index.php/topic,73052.0.html Forumsthread]
Das Modul muss manuell installiert werden.

Das folgende Mapping für den Roborook S50 beinhaltet neben den Characteristics der 1. Genration des Xiaomi Vacuum Cleaners weitere Custom Mappings. Diese werden auch auf dem Bild dargestellt. Falls das einem zu viele Informationen sind, können diese beim Einfügen einfach weggelassen oder in EVE ausgeblendet werden.

attr <XIAOMI> genericDeviceType switch
attr <XIAOMI> homebridgeMapping On=state,valueOn=Cleaning,cmdOn=start,cmdOff=charge
RotationSpeed=fan_power,minValue=0,maxValue=90,cmd=fan_power,delay=1
BatteryLevel=batteryPercent,maxValue=100,minValue=0,minStep=1
StatusLowBattery=batteryState,values=ok:BATTERY_LEVEL_NORMAL;;low:BATTERY_LEVEL_LOW
ChargingState=state,values=Docked:NOT_CHARGING;;Charging:CHARGING;;/.*/:NOT_CHARGEABLE
OccupancyDetected=state,values=/Docked|Charging/:OCCUPANCY_DETECTED;;/.*/:OCCUPANCY_NOT_DETECTED
2af6d0d0-3691-4f0d-9c9c-c1098295b1cb=consumables_sensors,name=Reinigung+Sensoren,minValue=0,maxValue=100,format=FLOAT,minStep=1,unit=%
fd11b965-052e-430f-b08f-206287d8bc00=consumables_filter,name=Austausch+Filter,minValue=0,maxValue=100,format=FLOAT,minStep=1,unit=%
fe7a8dac-dff3-4a07-8a5e-0d6abbf0df0c=consumables_main_brush,name=Austausch+Hauptbürste,minValue=0,maxValue=100,format=FLOAT,minStep=1,unit=%
4f9b2a22-b764-4fc1-8cd2-99383924394c=consumables_side_brush,name=Austausch+Seitenbürste,minValue=0,maxValue=100,format=FLOAT,minStep=1,unit=%
FilterLifeLevel=consumables_filter,minValue=0,maxValue=100
FilterChangeIndication=consumables_filter,values=0:CHANGE_FILTER
4896763a-26f7-400b-9734-2ce6564ceba2=total_clean_time,name=Lebenszeitersparnis,format=FLOAT,minStep=1,unit=h
82af5fd7-50a3-4ab3-81d3-1f7903de612a=total_clean_area,name=Gereinigte+Fläche,format=FLOAT,minStep=1,unit=m²
00d2ef14-b429-4569-8af3-c342d41cf383=total_cleans,name=Reinigungsvorgänge,format=FLOAT,minStep=1
e8d1027e-b068-40d5-9efd-f161b1b52774=device_firmware,name=Firmware,format=STRING

== Xiaomi Fan (ältere Generationen mit Luftfeuchtigkeits- und Temperatursensor und Battery-Readings) ==
[[Datei:Xiaomi DC Pedestal Fan.png|mini]]
Voraussetzung zur Verwendung der Mappings, ist ein eingebundener Ventilator mit dem Modul 72_XiaomiDevice.
Siehe [https://forum.fhem.de/index.php/topic,73052.0.html Forumsthread]
Das Modul muss manuell installiert werden.

Die ältere Generation enthält Sensoren und somit Readings für Luftfeuchtigkeit, Temperatur und auch Batteriestatus. Diese fehlen bei den neueren Generation dieses Ventilators, siehe Bilder. Da anscheinend jedes Jahr neue Generationen dieses Ventilators herausgekommen sind, ist nicht klar bis zu welcher Generation diese Sensoren enthalten waren.

Mit folgenden Geräten wurde folgendes Mapping erstellt und somit erfolgreich getestet:

- Xiaomi DC Pedestal Fan (FHEM model fehlt, Default Hostname am Router: zhimi-fan-v3)
- Liste bitte ergänzen!

Um möglichst viele Funktionen bereitzustellen, wurden auch Characteristics von anderen DeviceTypes verwendet. Erklärung zu den Characteristics:

- Die Kindersicherung (LockPhysicalControls) ist in Eve über das kleine Einstellungssymbol zu finden.
- Mit AudioFeedback/Audio-Bestätigung werden die Töne des Lüfters ein bzw. ausgeschaltet.
- Mit NightVision/Nachtsicht werden die LEDs ein (bright) bzw. ausgeschaltet (off).
- Mit Mute/Audio wird der Windmodus von Straight zu Natural geschaltet.
- Mit TargetTiltAngle/Neigung kann der Schwenkwinkel justiert werden.
- Mit SwingMode/Schwenken kann der Schwenkmodus ein bzw. ausgeschaltet werden.
- Der Rest ist selbsterklärend.

homebridgeMapping:

attr <XIAOMI> genericDeviceType Fan
attr <XIAOMI> homebridgeMapping
clear
On:power,cmdOn=on,cmdOff=off,valueOn=on,valueOff=off
LockPhysicalControls=child_lock,values=on:CONTROL_LOCK_ENABLED;;off:CONTROL_LOCK_DISABLED,cmds=CONTROL_LOCK_ENABLED:child_lock+on;CONTROL_LOCK_DISABLED:child_lock+off
RotationSpeed=level,minValue=0,maxValue=100,cmd=level,delay=1
TargetTiltAngle=angle,minValue=30,maxValue=120,minStep=30,cmd=angle
SwingMode=angle_enable,values=on:SWING_ENABLED;;off:SWING_DISABLED,cmdOn=angle_enable+on,cmdOff=angle_enable+off
CurrentRelativeHumidity=humidity
CurrentTemperature=temperature
BatteryLevel=batteryPercent,maxValue=100,minValue=0,minStep=1
StatusLowBattery=batteryState,values=ok:BATTERY_LEVEL_NORMAL;;low:BATTERY_LEVEL_LOW
ChargingState=charging,values=complete:NOT_CHARGING;;progress:CHARGING;;/.*/:NOT_CHARGEABLE
AudioFeedback:buzzer,cmdOn=buzzer+on,cmdOff=buzzer+off,valueOn=on,valueOff=off
NightVision:led,cmdOn=led+off,cmdOff=led+bright,valueOn=off,valueOff=bright
Mute:mode,cmdOn=mode+straight,cmdOff=mode+natural,valueOn=straight,valueOff=natural
CurrentFanState:power,values=on:BLOWING_AIR;;off:INACTIVE;;/.*/:IDLE

== Xiaomi Fan (neuere Generationen ohne Luftfeuchtigkeits- und Temperatursensor und Battery-Readings) ==
[[Datei:Xiaomi Standing Fan 2 bzw. 2S.png|mini]]
Voraussetzung zur Verwendung der Mappings, ist ein eingebundener Ventilator mit dem Modul 72_XiaomiDevice.
Siehe [https://forum.fhem.de/index.php/topic,73052.0.html Forumsthread]
Das Modul muss manuell installiert werden.

Den neueren Generationen dieses Ventilators fehlen Sensoren und somit Readings für Luftfeuchtigkeit, Temperatur und auch Batteriestatus. Diese sind bei der älteren Generation dieses Ventilators enthalten, siehe vorangegangenes Beispiel.

Dieses Mapping wurde mit dem "2S" erstellt. Es sollte aber mindestens auch mit einem "Xiaomi Standing Fan 2" (ohne Akku) funktionieren, da auch der "Xiaomi Standing Fan 2S" (mit Akku) kein Reading für die Batterie bereitstellt. Ansonsten gibt es wohl auch noch Generationen zwischen dem "Xiaomi DC Pedestal Fan" und den "Xiaomi Standing Fan 2/2S". Es ist davon auszugehen, dass dieses Beispiel genauso auch bei diesen Modellen funktioniert.

Mit folgenden Geräten wurde folgendes Mapping erstellt und somit erfolgreich getestet:

- 2019 Xiaomi Standing Fan 2S (FHEM model bzw. Default Hostname am Router: zhimi-fan-za4)
- 2018 Xiaomi ZhiMiDCVariableFrequencyFan ZRFFS01ZM (FHEM model bzw. Default Hostname am Router: zhimi-fan-za1)
- Liste bitte ergänzen!

Um möglichst viele Funktionen bereitzustellen, wurden auch Characteristics von anderen DeviceTypes verwendet. Erklärung zu den Characteristics:

- Die Kindersicherung (LockPhysicalControls) ist in Eve über das kleine Einstellungssymbol zu finden.
- Mit AudioFeedback/Audio-Bestätigung werden die Töne des Lüfters ein bzw. ausgeschaltet.
- Mit NightVision/Nachtsicht werden die LEDs ein (bright) bzw. ausgeschaltet (off).
- Mit Mute/Audio wird der Windmodus von Straight zu Natural geschaltet.
- Mit TargetTiltAngle/Neigung kann der Schwenkwinkel justiert werden.
- Mit SwingMode/Schwenken kann der Schwenkmodus ein bzw. ausgeschaltet werden.
- Der Rest ist selbsterklärend.

homebridgeMapping:

attr <XIAOMI> genericDeviceType Fan
attr <XIAOMI> homebridgeMapping
clear
On:power,cmdOn=on,cmdOff=off,valueOn=on,valueOff=off
LockPhysicalControls=child_lock,values=on:CONTROL_LOCK_ENABLED;;off:CONTROL_LOCK_DISABLED,cmds=CONTROL_LOCK_ENABLED:child_lock+on;CONTROL_LOCK_DISABLED:child_lock+off
RotationSpeed=level,minValue=0,maxValue=100,cmd=level,delay=1
TargetTiltAngle=angle,minValue=30,maxValue=120,minStep=30,cmd=angle
SwingMode=angle_enable,values=on:SWING_ENABLED;;off:SWING_DISABLED,cmdOn=angle_enable+on,cmdOff=angle_enable+off
AudioFeedback:buzzer,cmdOn=buzzer+on,cmdOff=buzzer+off,valueOn=on,valueOff=off
NightVision:led,cmdOn=led+off,cmdOff=led+bright,valueOn=off,valueOff=bright
Mute:mode,cmdOn=mode+straight,cmdOff=mode+natural,valueOn=straight,valueOff=natural
CurrentFanState:power,values=on:BLOWING_AIR;;off:INACTIVE;;/.*/:IDLE

== ZWave Türschloss Vision ZM1701 einbinden ==
Das ZWave Türschloss ZM1701 von der Firma Vision sendet seinen aktuellen Schließstatus in ein einzelnes Reading wie "lock", sondern schickt eine ganze Reihe von Informationen über den Zustand in das Reading <code>doorLockOperation</code>. Das Schließen und Öffnen der Türschlosses wird auch nicht mit einem Setzen des <code>state</code> erreicht, sondern mit dem Setzen von <code>doorLockOperation</code>. Das macht das Einbinden in homebridge nicht trivial, funktioniert aber über folgendes Homebridge-Mapping:
attr <ZM1701> genericDeviceType lock
attr <ZM1701> homebridgeMapping LockCurrentState=doorLockOperation,values=/\ssecured/:SECURED;/unsecured/:UNSECURED LockTargetState=doorLockOperation,values=/\ssecured/:SECURED;/unsecured/:UNSECURED,cmds=SECURED:doorLockOperation+close;UNSECURED:doorLockOperation+open

Kurz zur Erklärung: Um ein Schloss über HomeKit steuern zu können braucht es zwei characteristics. LockCurrentState zeigt an, ob das Schloss geöffnet oder geschlossen ist. Und mit LockTargetState wird das Schloss geöffnet oder geschlossen. Damit der aktuelle Status des Schlosses ausgelesen werden kann, muss aus dem FHEM-Reading <code>doorLockOperation</code> die Zeichenfolge <code> secured</code> oder <code>unsecured</code> extrahiert werden, daher die beiden regulären Ausdrücke <code>/\ssecured/</code> und <code>/unsecured/</code>. In der characteristic <code>LockTargetState</code> muss sowohl der aktuelle Status des Schlosses als auch das Kommando angegeben werden, schließlich möchte man ein geschlossenes Schloss nicht nochmal schließen. Daher wird erst aus dem Reading <code>doorLockOperation</code> der aktuelle Status des Schlosses ausgelesen und die damit korrespondierenden Befehle über <code>cmds=SECURED:doorLockOperation+close;UNSECURED:doorLockOperation+open</code> generiert.

Wer es in FHEM über ein webCmd einfacher zu bedienen haben möchte, fügt bitte noch die dafür notwendigen Attribute und die leicht geänderten homebridgeMappings wie folgt ein:
attr <ZM1701> genericDeviceType lock
attr <ZM1701> homebridgeMapping LockCurrentState=doorLockOperation,values=/\ssecured/:SECURED;/unsecured/:UNSECURED LockTargetState=doorLockOperation,values=/\ssecured/:SECURED;/unsecured/:UNSECURED,cmds=SECURED:close;UNSECURED:open
attr <ZM1701> /doorLockOperation open:open/doorLockOperation close:close
attr <ZM1701> webCmd open:close

Getestet mit
FHEM 5.7 Rev. 12191
homebridge 0.4.6
homebridge-fhem 0.2.48

[[Kategorie:HOWTOS]]

[[Kategorie:Sprachsteuerung]]

[[Kategorie:Code Snippets]]

Raspberry Pi

2020-01-05T12:19:46Z

50watt: /* Nützliche Zusatzpakete */ ENOCEAN Perl libs hinzugefügt

Beim '''Raspberry Pi''' handelt es sich um einen postkartengroßen Einplatinen-Computer, der von der Raspberry Pi Foundation entwickelt wird. Die Hardware basiert auf dem BCM 283x SoC (System-on-Chip) von Broadcom, einem ARM-Prozessor. Zu Hardwaredetails und den verschiedenen Modellen sowie Produktentwicklungen siehe [http://de.wikipedia.org/wiki/Raspberry_Pi#Hardware Wikipedia].
Dank der kleinen Abmessungen, dem recht geringen Energieverbrauch (bis ca. 4 Watt) sowie der günstigen Anschaffungskosten (ca. 30€) ist der Raspberry Pi eine attraktive Hardware für die Heimautomatisierung mit FHEM. Er ist dank dem Linux-Betriebssystem vollständig kompatibel zur aktuell vorhandenen und von FHEM unterstützen Hardware. Das derzeit empfohlene Standard-Image zum Betrieb des Raspberry Pi ist die auf Debian basierende Raspbian Distribution.

== Installation / Setup ==
=== Betriebssystem ===
====Vorbemerkung====
Raspbian ist direkt bei raspberrybi.org unter [https://www.raspberrypi.org/downloads/raspbian/ https://www.raspberrypi.org/downloads/raspbian/] herunterladbar. Die folgende Anleitung gilt für die lite-Version ohne grafischen Desktop und für die Modelle für B, B+, B2, B3, B3+, Zero W. (Stand Juni 2018)

Alle in diesem Abschnitt verwendeten Code Blöcke benötigen root Rechte. Deshalb bitte immer am Besten im Kontext <code>sudo su</code> ausführen. Man kann auch einzelne Befehle mit sudo davor ausführen, allerdings wird die Berechtigung bei Pipe Befehlen nicht durchgereicht.

Alle Dateien müssen im Linux-Format (nur LF als Zeilenende) erzeugt/editiert werden! Unbedingt einen geeigneten Editor verwenden und auf das Format beim Speichern achten!

====SD-Karte vorbereiten====
Die heruntergeladene Datei muss entpackt und auf die Speicherkarte geschrieben werden. Es gibt dazu verschiedene Tools je nach Betriebssystem. Für Windows ist windisk32imager zu empfehlen Projektseite [https://sourceforge.net/projects/win32diskimager/].

Detaillierte Anleitungen zur Vorgehensweise finden sich für die Betriebssysteme Linux, Mac OS und Windows unter [https://www.raspberrypi.org/documentation/installation/installing-images/README.md Writing an image to the SD card]

Die SD Card enthält nun zwei Partitionen/Laufwerke, das erste Laufwerk ist unter alle Betriebssystemen lesbar. In diesem Laufwerk (/boot) müssen jetzt noch zwei Dateien erzeugt werden:
* eine leere Datei mit dem Namen ssh um den (headless) Zugriff per ssh zu ermöglichen. Hinweis: Eine spätere Aktivierung von SSH ist mit <code>sudo raspi-config</code> (Punkt 5 "Interfacing Options", dann Punkt 2 SSH) möglich, erfordert dann aber Tastatur und Monitor am RPi.
* eine Textdatei im Linux Format mit Namen wpa_supplicant.conf und folgendem Inhalt wenn der Pi sofort mit wlan starten soll.

<pre>country=DE
ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
update_config=1
network={
ssid="FRITZ!Box 7490"
psk="12345678901234567890"
}
</pre>
* SD Karte auswerfen.
* SD Karte in Raspberry Pi stecken und booten.

Alternativ kann auch Monitor und Tastatur verwendet werden.

====Anmeldung und Grundkonfiguration====
Mit einem Terminal Programm verbindet man sich per ssh (z.B. Windows -> Putty) auf den Host <code>raspberrypi</code> und meldet sich mit User pi und Passwort raspberry an.
* Unbedingt Passwort ändern! -> Dem Sicherheitshinweis folgen und <code>passwd</code> eingeben.

Jetzt muss noch Zeitzone, Sprache und Hostname angepasst werden.
Entweder Menügeführt mit <code>sudo raspi-config</code>
oder per Script / Shell Befehle:

<source lang="bash"># Zeitzone einstellen & Zeitsynchronisierung über das Internet aktivieren
timedatectl set-timezone Europe/Berlin
timedatectl set-ntp true

# Konfigurieren lokale Sprache deutsch
sed -i -e 's/# de_DE.UTF-8 UTF-8/de_DE.UTF-8 UTF-8/' /etc/locale.gen
locale-gen
localectl set-locale LANG=de_DE.UTF-8 LANGUAGE=de_DE

# Hostname
hostnamectl set-hostname mymachine

# System aktualisieren
apt-get update
apt-get upgrade

#Neustart
reboot</source>

====Verwendung UART für Zusatzmodule====
Einige Aufsteckmodule (z.B. HM-MOD-RPI-PCB) für den GPIO Port verwenden dort die serielle Schnittstelle UART. Der Zugriff auf diese serielle Schnittstelle erfordert eine modellabhängige Konfiguration.

Bei allen Modellen muss die Verwendung der seriellen Linux console an ttyAMA0 deaktiviert werden:
<source lang="bash"># seriell-getty Dienst für ttyAMA0 dauerhaft deaktivieren
systemctl stop serial-getty@ttyAMA0.service
systemctl disable serial-getty@ttyAMA0.service
systemctl mask serial-getty@ttyAMA0.service
</source>
Bei den Modellen mit Bluetooth muss die UART aktiviert und umkonfiguriert werden:
<source lang="bash"># serielle Schnittstelle aktivieren und mit BT Schnittstelle tauschen
echo "enable_uart=1" >> /boot/config.txt
echo "dtoverlay=pi3-miniuart-bt" >> /boot/config.txt
echo "core_freq=250" >> /boot/config.txt
</source>
Um die Konfiguration abzuschließen ist ein Neustart erforderlich
<source lang="bash">#Neustart erforderlich
reboot</source>

====Troubleshooting====
'''Kontrolle der seriellen Schnittstelle'''

Der Befehl <code>ls -l /dev/ttyAMA0</code> muss folgende Ausgabe liefern.
crw-rw---- 1 root dialout 204, 64 Jun 7 22:56 /dev/ttyAMA0
Sollte dies nicht der Fall sein, muss der Dienst serial-getty@ttyAMA0.service deaktiviert werden!

Kontrolle der Verlinkung von /dev/serial*

Der Befehl <code>ls -l /dev/serial*</code> muss folgende Ausgabe liefern.
* Bei Modellen mit BT und richtiger Konfiguration
lrwxrwxrwx 1 root root 7 Jun 7 22:55 /dev/serial0 -> ttyAMA0
lrwxrwxrwx 1 root root 5 Jun 7 22:55 /dev/serial1 -> ttyS0
* Bei den Modellen ohne BT und richtiger Konfiguration
lrwxrwxrwx 1 root root 7 Jun 8 18:30 /dev/serial0 -> ttyAMA0
Sollte das nicht der Fall sein, sind die Einträge in der /boot/config.txt fehlerhaft.

'''Kontrolle Bluetooth'''

Die Funktion von Bluetooth kann mit dem hcitool überprüft werden. Mit <code>hcitool dev</code> wird das interne BT Gerät mit MAC Adresse angezeigt. Mit <code>hcitool scan</code> bzw. <code>hcitool lescan</code> kann nach sichtbaren Geräten gesucht werden.

Weitergehende Informationen zur Anpassung der Konfiguration von Raspbian sind nachzulesen auf [https://www.raspberrypi.org/documentation/configuration/ https://www.raspberrypi.org/documentation/configuration/].

=== FHEM ===
Die Installation von FHEM kann nach der Raspbian-Installation sehr einfach über das Debian-Repository [http://debian.fhem.de] erfolgen.
* Es wird unbedingt empfohlen zur Grundinstallation zunächst keine Module, USB Sticks oder ähnliche Zusatzbaugruppen an den IO Ports des Raspberry gesteckt zu haben.
* Dieser Abschnitt beschreibt nur die Grundinstallation von FHEM auf einem Raspberry Pi mit Raspbian!
* Weitere Installationsschritte sind je nach verwendeten FHEM-Modulen notwendig.
** Informationen hierzu liefert üblicherweise die {{Link2CmdRef}} zum jeweiligen Modul.
** Den weiteren Einstieg in FHEM findet man im Artikel [[Quick-Start]]

==== Der einfache Weg zum aktuellen System ====
Der folgende Befehlsblock ist die praktische Umsetzung der Beschreibung auf [http://debian.fhem.de http://debian.fhem.de]. Bitte unbedingt vor Installation rückversichern, ob es dort (insbesondere unter ''The easy way: use apt-get'') Aktualisierungen gab.
* Dieser Befehlsblock erfordert erhöhte Rechte also bitte als Erstes <code>sudo su</code> ausführen!
* Beim Kopieren aufpassen! Jede Zeile muss einzeln ausgeführt werden!
<source lang="bash"># von debian.fhem.de installieren - siehe aktuelle Anleitung dort https://debian.fhem.de/
wget -qO - http://debian.fhem.de/archive.key | apt-key add -
echo "deb http://debian.fhem.de/nightly/ /" >> /etc/apt/sources.list
apt-get update
apt-get install fhem
</source>

==== Das offizielle Release ====
Man kann FHEM mit dem Debian-Paket von [https://fhem.de/#Installation fhem.de] installieren. Dieser Weg führt zu einem offiziellen Release, welches aber unter Umständen erheblich vom aktuellen Versions- und Diskussionsstand im Forum abweicht.

Alternativ kann man auch den manuellen Weg von [https://debian.fhem.de/ https://debian.fhem.de/] wählen.

==== Empfohlener Patch ====
Da gerade auf dem Raspberry die automatische Erkennung der USB Schnittstellen zu 100% CPU Last führt (FHEM träge und reagiert nicht), wird empfohlen sofort nach der Installation noch diesen "Patch" auszuführen. Sollte an dieser Stelle schon der USB Check beim automatischen Start von FHEM nach der Installation zum Problem geführt haben, hilft nach dem Patch ein einfacher <code>reboot</code> des Systems.
<source lang="bash"># Den USB Check abschalten
/opt/fhem/fhem.pl 7072 "attr initialUsbCheck disable 1"
/opt/fhem/fhem.pl 7072 "save"
</source>
{{Hinweis|Für neue Installationen ab featurelevel 5.9 ist telnet deaktiviert. Damit funktioniert dieser Patch nicht mehr direkt. Stattdessen sollte FHEM starten, wenn alle USB-Geräte ausgesteckt sind. Dann kann man <code>attr initialUsbCheck disable 1</code> in der Kommandozeile in FHEMWEB eingeben, <code>save</code> ausführen und FHEM anschließen wieder mit eingesteckten USB-Geräten neu starten.}}

==== Deinstallation ====
Man kann FHEM auch wieder spurlos vom System entfernen und ganz von vorn beginnen. Allerdings sollte man sich im Klaren sein, damit ensteht kein jungfräuliches System!
<source lang="bash">sudo apt-get purge fhem
sudo apt-get autoremove
</source>

=== Nützliche Zusatzpakete ===
Nachdem der Rpi eingerichtet ist, können weitere Pakete installiert werden. Keines davon ist zwingend erforderlich, um FHEM grundsätzlich betreiben zu können. Einige Pakete erhöhen aber den Bedienungskomfort oder sind zur Nutzung bestimmter FHEM-Module (siehe {{Link2CmdRef}}) erforderlich. Hier eine Übersicht.
{| class="wikitable"
! style="width:10%" | Beschreibung
! style="width:10%" | Paketname
! style="width:50%" | Kontext
! style="width:30%" | Installieren
|-
|Zeitserver
|ntpdate
|Setzt die Systemzeit bei Start des RPi. Wird für FHEM benötigt, da es sonst nicht startet.
|<code>sudo apt-get install ntpdate
sudo ntpdate -u de.pool.ntp.org</code>
|-
|Perl JSON
|JSON
|Wird von einigen Modulen benötigt, z.B. harmony, iTunes
|<code>sudo apt-get install libjson-perl</code>
|-
|Samba-Server
|samba
|Mittels Samba kann man z.B. den Ordner /opt/fhem als Share freigeben. Dieser Share kann z.B. im Windows-Explorer als Laufwerk verbunden werden, so dass die Bearbeitung von config- und Programmdateien bequem möglich ist. Hier eine hilfreiche [https://www.elektronik-kompendium.de/sites/raspberry-pi/2007071.htm Kurzanleitung] aus der (wenn man auf einen speziellen user verzichtet) nur die Einträge für smb.conf gesetzt werden müssen.
|<code>sudo apt-get install samba cifs-utils</code>
Danach muss der share definiert werden mittels

<code>sudo nano /etc/samba/smb.conf</code>
|-
|Mailversand
|sendemail (alt: sendEmail)
|Wird benötigt, um Mails versenden zu können, bspw. für Alarm-Benachrichtigungen.
Nach Installation des Paketes benötigt man noch eine Routine in FHEM gemäß [[E-Mail senden#Raspberry Pi]]
|<code>sudo apt-get install sendemail</code> bzw. <code>sudo apt-get install sendEmail</code>
|-
|Wake-on-LAN
|etherwake
|Wird z.B. für das Modul WOL benötigt.
|<code>sudo apt-get install etherwake</code>
|-
|Perl Telnet
|telnet
|Wurde vor Fritz!OS 6.2x z.B. für das Modul [[FRITZBOX]] benötigt, da es eine im Netzwerk vorhandene Fritzbox über deren Telnet-Port ansprach. Mittlerweile wird TR-64 und SOAP verwendet.
|<code>sudo apt-get install libnet-telnet-perl</code>
|-
|Socat
|socat
|Kann verwendet werden, um auf anderen Rechnern im Netzwerk Linux-Befehle oder Skripts auszuführen. Auch können auf Slave-FHEM-Installationen Befehl ausgeführt werden, z.B. mit

<code><nowiki>system("echo 'set lampe on' | /usr/bin/socat - TCP:1.2.3.4:7072");</nowiki></code>

1.2.3.4 muss natürlich durch die IP-Adresse des Zielrechners ersetzt werden.
|<code>sudo apt-get install socat</code>
|-
|Libcrypt
|Libcrypt
|Perl libcrypt, erforderlich falls Homematic-devices mit AES verwendet werden sollen.
|<code>sudo apt-get install libcrypt-rijndael-perl</code>
|-
|libdatetime
|libdatetime
|Perl libdatetime, erforderlich für das Weather-Modul.
|<code>sudo apt-get install libdatetime-format-strptime-perl</code>
|-
|EnOcean XML functions
|libxml simple
|Perl XML::SIMPLE, erforderlich für die XML Funktionen des ENOCEAN Moduls.
|<code>sudo apt-get install libxml-simple-perl</code>
|-
|EnOcean Cryptographic functions
|libcrypt-random-source-perl
|Perl Crypt::Random, erforderlich für die Cryptographic Funktionen des ENOCEAN Moduls.
|<code>sudo /usr/bin/perl -MCPAN -e 'install Crypt::Random'</code>
|}

== Bekannte Probleme ==
=== Netzteil ===
Der RPi verwendet ein USB Netzteil als Spannungsversorgung. Gemessen kann der RPi allein bereits um die 900mA Strom fordern. Das bringt kleine Netzteile, besonders wenn noch CULs oder WLAN Sticks an USB hängen schnell an die Grenze. Die Fehler die daraus resultieren sind Abstürze, Netzwerkprobleme uvm. Daher bitte ein ausreichend starkes Netzteil mit mind. 2000mA oder einen aktiven USB-HUB für die Periperie verwenden.

=== Echtzeituhr ===
Der RPi hat keine [http://de.wikipedia.org/wiki/Echtzeituhr Real-Time-Clock] (RTC), das heißt, dass er nach einem Neustart keine gültige (im Sinne von aktuell) Systemzeit hat, sondern ein Datum in der Vergangenheit. Dieses Problem wird sinnvollerweise mit einer [http://de.wikipedia.org/wiki/Network_Time_Protocol NTP-Konfiguration] oder durch [[Raspberry Pi: RTC Hat|Installation einer Echtzeituhr]] umgangen.

Dabei muss Sorge getragen werden, dass der [http://wiki.debian.org/NTP ntpd] schon einen Datums-/Zeitabgleich gemacht hat, bevor FHEM gestartet wird. Geschieht der Abgleich nicht vorher, sondern erst nachdem FHEM schon läuft, stellt FHEM die Logs zwar auf das nun aktuelle Datum um (die "alten" Logs mit dem eigentlich ungültigen Datum werden natürlich behalten), aber irgendetwas scheint FHEM dabei so zu belasten, dass es eine Last von über 0.8 bis 0.9 erzeugt. Diese Last besteht auf Dauer und verschwindet erst, wenn man das Ganze sauber durchkonfiguriert und FHEM neu gestartet hat. Die hohe Systemauslastung zeigt sich auch in einem sehr trägen Laden der FHEM-Webseiten in einem beliebigen Browser. (siehe {{Link2Forum|Topic=70741}})

=== Last durch Backup (während update) ===
Bei einen [[Update]] von FHEM durch den Befehl <code>update</code> kann durch Setzen des Attributs "<code>attr global backup_before_update 1</code>" automatisch vorab ein [[Backup]] durchgeführt werden. Die (ggf. großen) Log-Dateien werden dabei ebenfalls archiviert. Während der Archivierung ist FHEM blockiert. Durch die beschränkte Leistungsfähigkeit des Raspberry Pi kann das Backup zudem lange dauern. Durch ein "<code>attr global updateInBackground 1</code>" wird ein Backup im Hintergrund ausgeführt (Quelle: {{Link2Forum|Topic=15729}}).

Alternative Möglichkeiten:
* Backup ausschalten und manuell durchführen
* Backup-Befehl anpassen und so große Dateien bzw. Verzeichnisse (log/) nicht archivieren

== Watchdog einrichten ==
Man kann den RPi alle halbe Stunde prüfen lassen, ob FHEM noch läuft und gegebenenfalls einen Neustart durchführen lassen. Eine mögliche Vorgehensweise ist in diesem {{Link2Forum|Topic=20553|LinkText=Forumsthema}} beschrieben.
{{Hinweis|Statt des Einsatzes derartiger Methoden ist zu empfehlen, nach der eigentliche Fehlerursache zu forschen und diese abzustellen. Haben Sie dennoch einen solchen Watchdog eingerichtet, sollten Sie bei Fragen zu Ihnen seltsam erscheinenden Phänomänen im Forum darauf hinweisen, auch wenn die Symptome scheinbar nichts mit dem Watchdog zu tun haben sollten.}}

== Interne Links ==
* [[CUL am Raspberry Pi flashen]]
* [[Raspberry Pi und 1-Wire]]

== Externe Links ==
* {{Link2Forum|Topic=33460|Message=264679}} zum Umzug von Raspberry B auf Raspberry Pi 2
* [http://www.raspberrypi.org/ Offizielle Webseite der Raspberry Pi Foundation]
* [http://www.raspberrypi.org/downloads Offizielle Downloads der Raspberry Pi Foundation]

[[Kategorie:Raspberry Pi]]
[[Kategorie:HOWTOS]]

PRESENCE

2020-01-03T07:55:00Z

50watt: /* Konfiguration auf Shellebene */ Tippfehler

{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h
|ModForumArea=Unterstützende Dienste
|ModTechName=73_PRESENCE.pm
|ModOwner=Markus Bloch ({{Link2FU|117|Forum}}/[[Benutzer Diskussion:Markusbloch|Wiki]])
}}

Das [[PRESENCE]] Modul bietet für die Anwesenheitserkennung mehrere Varianten an:

* '''lan-ping''' - Das Überwachen via PING Checks, die durch den FHEM Server versandt werden.
* '''fritzbox''' - Das Überwachen von Geräten auf einer FritzBox via ctlmgr_ctl (Nur auf einer FritzBox möglich)
* ''' Bluetooth'''
:- '''local-bluetooth''' - Das Überwachen via Bluetooth Checks, die vom FHEM Server direkt durchgeführt werden (angeschlossener Bluetooth-Stick und die Software bluez voraussgesetzt)
:- '''lan-bluetooth''' - Das Überwachen von Bluetoothgeräten, über Netzwerk. Auf einer oder mehreren Maschinen im Netzwerk (z.B. [[:Kategorie:Raspberry Pi|Raspberry Pi]]) läuft ein Presence-Daemon, der nach Bluetooth-Geräten sucht. Um mehrere Presence-Daemon mit FHEM zu verbinden, gibt es den Collector-Daemon, der sich zu allen Presence-Damons im Netzwerk verbindet und das Ergebnis von allen zusammenfasst.
* '''function''' - Das Überwachen mithilfe einer selbst geschrieben Perl-Funktion, die den Anwesenheitsstatus zurückgibt (0 oder 1)
* '''shell-script''' - Das Überwachen mithilfe eines selbst geschriebenen Shell-Programms/Skript, das eine 0 oder 1 ausgibt, um den Anwesenheitsstatus mitzuteilen.

= Überwachen mittels Ping im WLAN/LAN =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Um ein Gerät via Ping zu überwachen, muss folgende Definition durchgeführt werden:
:<code>define Handy PRESENCE lan-ping 192.168.0.30</code>

Dadurch wird die IP-Addresse 192.168.0.30 alle 30 Sekunden geprüft, ob sie erreichbar ist. Wenn sie erreichbar ist, ist der Status "present" (anwesend), ansonsten "absent" (abwesend).

Der Timeout kann verändert werden, indem ein Wert (in Sekunden) an das Define anhängt wird:
:<code>define Handy PRESENCE lan-ping 192.168.0.30 '''60'''</code>

Nun würde das Handy alle 60 Sekunden geprüft werden.

Nur wenn bei einem iPhone/iPad die Funktion "über WLAN synchronisieren" aktiviert ist, ist es auch im Standby zuverlässig pingbar. Standardmäßig deaktivieren Apple-Geräte ihr WLAN im Standby-Betrieb um die Akkulaufzeit zu verlängern.

Sollte die Fehlermeldung
:<code> PRESENCE (Handy) - ping command returned with output: ping: icmp open socket: Operation not permitted </code>
im Log auftauchen und lan-ping dadurch nicht funktionieren, liegt ein Berechtigungsproblem vor. Kein Grund den User fhem zu root zu machen!
Prüfe zu erst als User root ob die Capabilities gesetzt sind.
:<code>getcap /bin/ping</code>
Sollte folgendes Ergeben zu Tage fördern.
:<code>/bin/ping = cap_net_raw+ep</code>
Ist dem nicht so, setzen wir die benötigten Capabilities
:<code>setcap cap_net_raw+ep /bin/ping</code>
Mehr Informationen zum Thema Capabilities [https://manpages.debian.org/jessie/manpages-de/capabilities.7.de.html].

= FritzBox: direktes Abfragen der Aktivität via ctlmgr_ctl =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Eine sehr häufige und auch zuverlässige Methode ist auf einer FritzBox die Abfrage mittels ctlmgr_ctl Befehl. Über diesen lassen sich alle Geräte abfragen ob sie aktiv sind. Ist ein Gerät aktiv, so gilt es als anwesend.

Dieser Modus kann allerdings nur in FHEM Installationen direkt auf einer FritzBox verwendet werden. Des weiteren muss FHEM unter dem User root laufen. Um ein Gerät zu überwachen, wird lediglich der Gerätename benötigt, so wie er unter dem Menüpunkt "Heimnetz" auftaucht.

Die erforderliche Definition:
:<code>define Handy PRESENCE fritzbox iPhone-4S</code>

= Überwachung mittels Perl-Code =
Es ist möglich zum Überwachen von Geräten eine eigene Perl-Funktion zu verwenden die dann vom PRESENCE Modul im Hintergrund aufgerufen wird.

define <name> PRESENCE function {...} [ <check-interval> [ <present-check-interval> ] ]

Sobald die Funktion den Rückgabewert 1 hat, ist das Gerät anwesend, bei 0 abwesend.

== Beispiel DHCP Überwachung auf Airport Basestation ==
Die hier vorgestellte Überwachung der DHCP Lease auf Airport Basestations per SNMP ist absolut robust gegenüber dem Ruhezustand von iOS und setzt keine weitere Konfiguration auf dem iPhone voraus. Das Abmelden beim Verlassen des Empfangsbereiches der Basestation geschieht mit etwa 5-10 Minuten Verzögerung und ist somit auch vor kurzzeitigen Empfangsproblemen sicher. Das nebenstehende Bild (???) verdeutlicht noch mal die Unterschiede zwischen einer IP-Basierten Ping-Überwachung und der Überwachung auf Ebene der Basestation oder FritzBox.

Bevor der folgende Code verwendet werden kann ist das Perl Modul Net:SNMP zu installieren (z. B. mit: <code>cpan install use Net::SNMP</code>).

Zuerst ist folgender Code in 99_myUtils.pm einzufügen, sollte diese noch nicht vorhanden sein muss diese aus dem Template welches unter Edit Files zu finden ist erzeugt werden.
'''Achtung, das ist nicht der komplette Inhalt der 99_myUtils!''' Das ist nur die einzelne Routine

<pre>
use Net::SNMP;
sub
snmpCheck($$)
{
my ($airport,$client)= @_;

my $community = "public";
my $host = $airport;
my $oid = ".1.3.6.1.2.1.3.1.1.2";
#my $oid = ".1.3.6.1.2.1.3.1.1.2.25.1.10.0.1";

my ( $session, $error ) = Net::SNMP->session(
-hostname => $host,
-community => $community,
-port => 161,
-version => 1
);

if( !defined($session) ) {
return 0;
return "Can't connect to host $host.";
}

my @snmpoids = ();

my $response = $session->get_next_request($oid);
my @nextid = keys %$response;
while ( @nextid && $nextid[0] && $nextid[0] =~ m/^$oid/ ) {
push( @snmpoids, $nextid[0] );

$response = $session->get_next_request( $nextid[0] );
@nextid = keys %$response;
}

if( !defined($response = $session->get_request( @snmpoids ) ) ) {
return 0;
}

foreach my $value (values %$response) {
return 1 if( $value eq $client )
}

return 0;
}
</pre>

Danach lässt sich das Mobilgerät so überwachen:
:<code>define iPhone PRESENCE function {snmpCheck("10.0.1.1","0x44d77429f35c")} 30 30</code>

wobei 10.0.1.1 durch die IP-Adresse der Basestation und 0x44d77429f35c durch die MAC Adresse des Geräts als HEX-Zahl ersetzt werden muss.

== Beispiel Anwesenheitserkennung mittels UniFi Controller ==

Die Anwesenheitserkennung bei Geräten in Verbindung mit UniFi-Produkten funktioniert selbst dann, wenn sich die Geräte im PowerSave-Modus befinden.

Beachte: Die Geräte werden erst ungefähr nach 5 Minuten, nachdem das Gerät das WLAN verlassen hat als disconnected angezeigt.

<code>define <NAME> PRESENCE function {ReadingsVal("<UniFi>","<NamedDevice>","") eq "connected" ? 1:0}</code>

= Überwachen mittels Events =
Der Vorteil gegenüber der Function-Variante ist, dass diese Variante ohne Blocking.pm-Overhead direkt ausgeführt werden kann und in "Echtzeit" abläuft (siehe {{Link2Forum|Topic=40287|Message=562823}}).

<code>define <NAME> PRESENCE event UniFi:NamedDevice:.disconnected UniFi:NamedDevice:.connected</code>

Dabei wird <UniFi> mit dem Namen des Unifi-Devices in FHEM ersetzt, <NamedDevice> mit dem Namen des zu überwachenden Devices im Unifi-Controller ersetzt.

= Überwachen mittels Bluetooth =
== Vorbereitung und Informationen ==
=== Getestete Hardware/Software ===
* '''Raspbian System''' - wheezy, Jessie (interner BT-Controller)
* '''BT-Dongle''' - CSL NET BT USB2.0 Stick, Bluetooth V4.0, Nano <br />'''Achtung''': Es muss ein BT V4.0 oder höher verwendet werden. Nur dieser unterstützt ''LowEnergy''
* '''BT-TAG''' - Gtag von Gigaset, TrackR, UDOO Neo, PebbleBee, iTag von Unitec, X4-LIFE Multifunkti BL-Anhänger, iTag Wireless Anti, Trackr bravo, GhostyuBeacon iBc41

=== BT-Dongle am RaspberryPI installieren ===
Um den BT-Dongle ''(hier: CSL NET BT USB2.0)'' am RaspberryPI verwenden zu können, müssen die notwendigen Pakete über die Paketverwaltung von debian nachinstalliert werden.
Wer bereits ein BT-Dongle installiert hat, kann diesen Schritt überspringen.
<pre>
apt-get install bluetooth
</pre>
Nach erfolgreicher Installation der Pakete sollte der RaspberryPI neu gestartet werden.
<pre>
sudo reboot
</pre>

Nach dem erfolgten Reboot bitte das Log des RaspberryPI auf folgende Einträge prüfen:
<pre>
Feb 12 19:52:55 fhem kernel: [ 4.773600] Bluetooth: Core ver 2.20
Feb 12 19:52:55 fhem kernel: [ 4.773748] NET: Registered protocol family 31
Feb 12 19:52:55 fhem kernel: [ 4.773765] Bluetooth: HCI device and connection manager initialized
Feb 12 19:52:55 fhem kernel: [ 4.773797] Bluetooth: HCI socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773821] Bluetooth: L2CAP socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773890] Bluetooth: SCO socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.797531] usbcore: registered new interface driver btusb
</pre>
Sobald der BT-Dongle erkannt wurde ''leuchtet'' (wenn vorhanden) auch die ''blaue/gelbe'' LED am Dongle auf.

=== BT-Tags aktivieren ===
Jetzt kann der BT-Tag aktiviert werden. Bei einigen BT-Tags muss dafür die '''Batteriesicherung''' gezogen werden.

Ein BT-Tag wird mit folgendem Befehl auf der Konsole gesucht:
<syntaxhighlight lang="bash">
sudo hcitool lescan

Ausgabe z.B.:
LE Scan ...
7C:2F:80:A1:XA:XD (unknown)
7C:2F:80:A1:XA:XD Gigaset G-tag
7C:2F:80:A1:X4:X1 (unknown)</syntaxhighlight>
Eine Übersicht über die möglichen Befehle von hcitool gibt es mit der Eingabe von:
<pre>
sudo hcitool

Ausgabe z.B.:
hcitool - HCI Tool ver 5.23
Usage:
hcitool [options] <command> [command parameters]
Options:
--help Display help
-i dev HCI device
Commands:
dev Display local devices
inq Inquire remote devices
scan Scan for remote devices
name Get name from remote device
info Get information from remote device
spinq Start periodic inquiry
epinq Exit periodic inquiry
cmd Submit arbitrary HCI commands
con Display active connections
cc Create connection to remote device
dc Disconnect from remote device
sr Switch master/slave role
cpt Change connection packet type
rssi Display connection RSSI
lq Display link quality
tpl Display transmit power level
afh Display AFH channel map
lp Set/display link policy settings
lst Set/display link supervision timeout
auth Request authentication
enc Set connection encryption
key Change connection link key
clkoff Read clock offset
clock Read local or remote clock
lescan Start LE scan
lewladd Add device to LE White List
lewlrm Remove device from LE White List
lewlsz Read size of LE White List
lewlclr Clear LE White list
lecc Create a LE Connection
ledc Disconnect a LE Connection
lecup LE Connection Update
</pre>

Falls beim SCAN kein BT-Tag gefunden wird, sollte das BT Interface neu gestartet werden. Dazu ist kein Reboot des RaspBerryPI notwendig.
<syntaxhighlight lang="bash">
sudo hciconfig hci0 down
sudo hciconfig hci0 up
sudo hcitool dev
</syntaxhighlight>

== Überwachung durch den FHEM Server direkt ==
[[Datei:Bluetooth-Adresse-iPhone.png|thumb|Bluetooth-Adresse eines iPhones]]
Jenach Aufstellungsort des FHEM Servers kann es sinnvoll sein, eine Bluetooth-Überwachung direkt durch den FHEM Server durchzuführen. Hierbei gilt allerdings zu beachten, dass Bluetooth nicht für große Reichweiten gedacht ist und in den meisten Fällen keine Wände überwinden kann. Das heisst, dass in den meisten Fällen damit nur ein Raum überwacht werden kann.

Je nach Einsatzzweck kann das auch so gewollt sein. Bluetooth USB Sticks, die bereits Bluetooth 4.0 unterstützen, können höhere Reichweiten über Zimmerwände hinaus erreichen. Vorausgesetzt, das Mobilgerät unterstützt Bluetooth 4.0.

Um eine Überwachung per Bluetooth durchführen zu können, benötigt man die Bluetooth-Adresse eines Gerätes. Diese ähnelt vom Aufbau einer MAC-Adresse. Generell wird die Adresse in den Telefon-Informationen bei Smartphones angezeigt.

Um eine Anwesenheitserkennung via Bluetooth durchzuführen, wird folgende Definition in der [[Konfiguration]] benötigt:
:<code>define Handy PRESENCE local-bluetooth XX:XX:XX:XX:XX:XX</code>

== Überwachung durch verteilte Agenten in der Wohnung (presenced/lepresenced/collectord) ==
[[Datei:Raspberry-Pi-mit-WLAN-und-Bluetooth-Stick.jpg|thumb|left|Raspberry Pi mit Bluetooth- und WLAN-USB-Stick]]
Um eine zuverlässige und flächendeckende Bluetooth-Anwesenheitserkennung durchzuführen, ist es unerlässlich, mehrere Bluetooth-Empfänger zu verwenden, die auf mehrere oder alle Räume verteilt sind.

Hierfür bietet sich zum Beispiel ein [[Raspberry Pi]] mit einem Mini-Bluetooth-USB-Stick und evtl. einem WLAN-USB-Stick an. Jeder Raum wird mit solch einem Raspberry ausgestattet und ist im WLAN Netz verfügbar.

Dieses Netz aus Raspberrys wird mit dem presenced / lepresenced Programm ausgestattet. Beide Programme sind Perl-Skripte, die als Daemon im Hintergrund laufen und auf Anfragen via Netzwerk warten. Es wird lediglich eine vollständige Perl-Grundinstallation mit Standardmodulen benötigt.

=== Unterschied presenced / lepresenced / collectord ===
presenced und lepresenced sind Programme, welche in regelmäßigen Abständen nach Bluetooth-Geräten suchen. Sobald ein Gerät, welches vorab definiert wurde, gefunden wird, wechselt der Status des Geräts in FHEM auf Anwesend. Der Unterschied zwischen presenced und lepresenced ist, dass lepresenced insbesondere für [https://de.wikipedia.org/wiki/Bluetooth_Low_Energy Bluetooth-LE-Devices] ist und presenced für "normale" Bluetooth-Geräte.

collectord wiederum ist ein Programm, welches mehrere Pis verbindet und auf allen den aktuellen Status von presenced/lepresenced abfragt. Ist das gesuchte Bluetooth-Gerät auf einem der Pi anwesend, so wird es auch in der definierten Hauptinstanz auf anwesend gesetzt. Zusätzlich wird der Pi auf dem das Gerät gefunden wurde als Reading angegeben. Sofern alle Räume einen Empfangspegel (RSSI) ermitteln können, wird bei mehreren anwesenden Räumen der Raum mit dem besten Empfangspegel selektiert (siehe {{Link2Forum|Topic=54482}}).

=== Installation von (le)presenced ===
Diese Anleitung ist sowohl für presenced, als auch für lepresenced gültig. Einfachheitshalber wird nur lepresenced erwähnt, sämtliche Schritte gehen jedoch auch mit presenced, wobei einfach die genannten Daten durch presenced ersetzt werden müssen.

Die Software lepresenced kann aktuell über drei Varianten installiert werden. Dabei ist die bevorzugte Variante (Variante 1) die Installation über das bereitgestellte .deb-Paket.
Die Variante 2 setzt voraus, dass im FHEM contrib Verzeichnis (/opt/fhem/contrib) die aktuelle Version des .deb-Pakets liegt. Die Variante 3 ist dafür gedacht, wenn man keine .deb-Pakete installieren kann/will oder es aus anderen Gründen nicht funktioniert. Es wird davon abgeraten die Variante 3 zu verwenden. Vollständigkeitshalber wird sie aber aufgeführt.

===== Installation per .deb-Paket =====

Die bevorzugte Variante ist die Installation von lepresenced durch die passenden .deb Pakete.
{{Randnotiz|RNText=Bei einem Upgrade einer älteren Version reicht es, das neue .deb Paket mit
:<code>sudo dpkg -i lepresenced-X.XX-X.deb</code>
zu aktualisieren}}

'''1.Variante:'''
Herunterladen der aktuellen lepresenced-0.83-3.deb (Stand August 2017) Datei über den Webbrowser
[https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/ SVN-Repository]. Im SVN die passende Datei auswählen und in der folgende Webseite den Link unter:
<pre>
Download in other formats:
Original Format
</pre>
anklicken und die Datei herunterladen.
Die Datei kann jetzt auf den RPi kopiert und mit folgenden Befehlen ausgeführt werden (ggf. Berechtigungen anpassen).

Alternativ per wget Befehl direkt auf den RPi (aktuelle Versionsnummer beachten)
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/lepresenced-0.83-3.deb

'''2.Variante:''' (zu Verwenden, wenn es Probleme bei Variante 1 gibt)
Herunterladen aus dem fhem contrib Verzeichnis:
Hierzu muss das contrib auf dem aktuellen Stand sein. Dazu wird die Installation von subversion (normal bereits vorhanden) benötigt.

sudo apt-get install subversion

Danach kann per
sudo svn checkout https://svn.fhem.de/fhem/trunk/fhem/contrib svnrepo

Das aktuelle Repository auf den Pi heruntergeladen werden. Danach sollte im gewählten Verzeichnis die eingecheckten Dateien verfügbar sein.
/opt/fhem/svnrepo/PRESENCE/deb

''' Installation der Variante 1 oder 2 '''

Egal welche Variante gewählt wurde, nun kann mit folgenden Befehlen das Paket installiert werden. Bitte Pfade ggf. anpassen.

'''Wichtig''': Das '''Paket''' hat eine ca. Größe von '''6,5Kb'''. Ab und an gibt es wohl Probleme mit der Installation, wodurch die Datei 11,5kb groß wird.
Diese Datei lässt sich nicht Installieren. In diesem Fall das Paket bitte mit der Variante 1 und dem Bereich "Download in other formats" herunterladen.

sudo dpkg -i lepresenced-0.83-3.deb

sudo apt-get -f install

Die Ausgabe der Installation sollte am Ende ein [ ok ] Starting lepresenced (via systemctl): lepresenced.service. ausgeben.

<pre>
Paketlisten werden gelesen... Fertig
Abhängigkeitsbaum wird aufgebaut.
Statusinformationen werden eingelesen.... Fertig
Abhängigkeiten werden korrigiert ... Fertig
Die folgenden zusätzlichen Pakete werden installiert:
bluez-hcidump
Die folgenden NEUEN Pakete werden installiert:
bluez-hcidump
0 aktualisiert, 1 neu installiert, 0 zu entfernen und 0 nicht aktualisiert.
1 nicht vollständig installiert oder entfernt.
Es müssen 157 kB an Archiven heruntergeladen werden.
Nach dieser Operation werden 490 kB Plattenplatz zusätzlich benutzt.
Möchten Sie fortfahren? [J/n]
Holen: 1 http://archive.raspberrypi.org/debian/ jessie/main bluez-hcidump armhf 5.23-2+rpi2 [157 kB]
Es wurden 157 kB in 0 s geholt (921 kB/s).
Vormals nicht ausgewähltes Paket bluez-hcidump wird gewählt.
(Lese Datenbank ... 42033 Dateien und Verzeichnisse sind derzeit installiert.)
Vorbereitung zum Entpacken von .../bluez-hcidump_5.23-2+rpi2_armhf.deb ...
Entpacken von bluez-hcidump (5.23-2+rpi2) ...
Trigger für man-db (2.7.0.2-5) werden verarbeitet ...
bluez-hcidump (5.23-2+rpi2) wird eingerichtet ...
lepresenced (0.82-1) wird eingerichtet ...
[ ok ] Starting lepresenced (via systemctl): lepresenced.service.
</pre>

'''3.Variante:'''

Bei dieser Variante wird das aktuellste lepresenced Skript aus github heruntergeladen. Das bedeutet, dass jegliche Konfiguration wie automatischer Start, Berechtigungen etc.
manuell konfiguriert werden muss. Diese Variante eignet sich nur für diejenigen, die keine .deb-Pakete installieren wollen/können oder die genau Wissen, was sie tun!
<pre>
https://github.com/mhop/fhem-mirror/blob/master/fhem/contrib/PRESENCE/lepresenced
</pre>

Zur "Installation" des Skripts folgendermaßen vorgehen:
Unter /fhem manuell den Ordner „script“ anlegen:
<pre>
mkdir script
</pre>
Datei lepresenced reinkopieren und ausführbar machen:
<pre>
sudo chmod +x /opt/fhem/script/lepresenced
sudo chgrp -cR dialout lepresenced
</pre>
Skript erstmalig starten:
<pre>
sudo ./lepresenced --loglevel LOG_EMERG -d
</pre>
Kommt beim Starten des Skript eine Fehlermeldung, müssen die Abhängigkeiten aufgelöst werden.
<pre>
Can't locate Net/Server/Daemonize.pm in @INC (@INC contains: /etc/perl /usr/local/lib/perl/5.14.2 /usr/local/share/perl/5.14.2 /usr/lib/perl5 /usr/share/perl5 / usr/lib/perl/5.14 /usr/share/perl/5.14 /usr/local/lib/site_perl .) at /opt/fhem/lepresenced line 17.
BEGIN failed--compilation aborted at /opt/fhem/lepresenced line 17.
</pre>
Um die Abhängigkeiten aufzulösen muss folgendes nachinstalliert werden und anschließend ein Reboot durchgeführt werden.
<pre>
sudo apt-get install libnet-server-*
</pre>

===== Einrichtung eines Bluetooth-Geräts über FHEM =====

Nach dem letzten Schritt sind alle Bedingungen für eine abschließende Konfiguration eines BT-Geräts in FHEM abgeschlossen worden.
Jetzt kann der zum Beispiel ein G-Tag dem FHEM-Server bekannt gemacht werden:
<pre>
-- Name Modul Modus MAC vom Gtag IP vom PI Port Abfragezeit in Sekunden
define MeinGtAG PRESENCE lan-bluetooth xx:xx:xx:xx:xx:xx 127.0.0.1:5333 120
</pre>

'''Wichtig ist den angegeben Port zu unterscheiden. Für presenced muss der Port 5111 genommen werden, für lepresenced der Port 5333.'''
Den absent und present Mode kann man einfach testen, in dem man den Gtag mit Alufolie einwickelt.

Diese Variante sollte eingesetzt werden, wenn nur ein Pi nach Bluetooth-Geräten sucht. Möchte man mehr als ein Gerät nutzen um zum Beispiel eine größere Fläche abzudecken so muss mit collectored gearbeitet werden.

=== Alle Räume gemeinsam ansprechen mittels collectord ===
Um zwei presenced- oder lepresenced Installationen zu verbinden wird der collectord Daemon von Markus Bloch benötigt. Dieser kennt alle presenced-Installationen im Netzwerk und führt eine koordinierte Suche nach den gewünschten Geräten durch. Sobald ein Gerät in einem Raum erkannt wurde, meldet der collectord den Status einschließlich der Angabe des Raumes, in dem das Gerät erkannt wurde.

[[Datei:Presence_Collectord_Uebersicht.jpg|200px|thumb|left|Schematische Darstellung Presence und Collectord, Danke an dtavb]]
Auf Basis folgender Skizze wird die Einrichtung und der Betrieb der Anwesenheitserkennung und Überwachung <p></p>
mit dem PRESENCE-Modul sowie dem Skript (.deb-Paket) lepresenced beschrieben. Zusätzlich wird für die Verbindung <p></p>
mehrere lepresenced Instanzen der collectord verwendet.<p></p>
Diese Skizze dient als Basis für alle genannten Konfigurationen innerhalb dieses Artikels.
{{NeuerTextBlock}}

==== Aufbau ====
; RPi1 (Hauptinstanz):
: FHEM Installation
: presence/lepresenced Installation
: collectord installation
: Sämtliche Bluetooth-Geräte in FHEM definiert
; RPi2 (Zweitsystem):
: FHEM installation
: presence/lepresenced Installation
: Sämtliche Bluetooth-Geräte in FHEM definiert

==== Installation per .deb-Paket ====
collectord wird heruntergeladen und installiert:
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/collectord-1.8.deb (Stand Januar 2018)
<pre>
sudo dpkg -i collectord-1.8.deb
</pre>

Nach der Installation befindet sich im Verzeichnis: /etc/collectord.conf die Konfigurationsdatei für das collectord. Weitere Einstellungen können unter /etc/default/collectord vorgenommen werden.

==== Konfiguration auf Shellebene ====
<pre>
sudo vi /etc/collectord.conf
</pre>

Diese Datei muss jetzt nach folgender Vorlage angepasst werden.
<pre>
# room definition
#[room-name] # name of the room
#address=192.168.0.10 # ip-address or hostname
#port=5111 # tcp port which should be used (5111 is default)
#presence_timeout=120 # timeout in seconds for each check when devices are present
#absence_timeout=20 # timeout in seconds for each check when devices are absent

[RPi1] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=127.0.0.1 # Lokale Adresse RPi1 , da hier das Collectord später laufen soll!
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaehlte Pruefintervalle
absence_timeout=60 # Selbstgewaehlte Pruefintervalle

[RPi2] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=192.168.178.127 # IP-Adresse der Instanz, wo nur das Presence laueft, also RPi2
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaehlte Pruefintervalle
absence_timeout=60 # Selbstgewaehlte Pruefintervalle
</pre>

Hinweis:
* Es dürfen keine [Namen] mit Leerzeichen verwendet werden
* Der angegebene Port richtet sich danach, ob auf dem Pi presenced (Port 5111) oder lepresenced (Port 5333) nach dem Bluetooth-Gerät sucht

==== Konfiguration in FHEM ====
;RPi1
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 127.0.0.1:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222)''
;RPi2
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 192.168.178.127:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222 - die IP-Adresse von die von RPi1)''

Nach der Konfiguration kann der Daemon gestartet werden.
Sobald das Bluetoothgerät irgendwo in der Wohnung erkannt wurde, meldet der Collectord dies sofort
an FHEM und teilt den Raum mit in dem es erkannt worden ist. Diese Information wird im Reading "rooms" des jeweiligen BT-Gerätes dargestellt.

Zum testen sollte collectord einmalig manuell gestartet werden. Dies hat den Vorteil, dass man nochmal den Port des collectord prüfen kann, dieser steht in der Zeile <pre>created socket on 0.0.0.0 with port 5222</pre> und man sehen kann, ob der collectord richtig startet, oder Fehler auswirft. Gestartet wird mit folgendem Kommando:
<pre>
sudo collectord -vv -c /etc/collectord.conf
</pre>
Die Ausgabe sieht wie folgt aus:
<pre>
2017-04-02 17:52:55 - =================================================
2017-04-02 17:52:55 - started with PID 15554
2017-04-02 17:52:55 - reading configuration file
2017-04-02 17:52:55 - no config errors found
2017-04-02 17:52:56 - created socket on 0.0.0.0 with port 5222
2017-04-02 17:53:20 - new connection from 127.0.0.1:48656
2017-04-02 17:53:20 - created thread 1 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - created thread 2 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - new connection from 127.0.0.1:48662
2017-04-02 17:53:20 - new connection from 127.0.0.1:48664
2017-04-02 17:53:20 - created thread 3 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 4 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 5 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:20 - created thread 6 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51638
2017-04-02 17:53:22 - created thread 7 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - created thread 8 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51640
2017-04-02 17:53:22 - created thread 9 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:23 - created thread 10 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:29 - new connection from 192.168.xxx.xxx:51642
2017-04-02 17:53:29 - created thread 11 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
2017-04-02 17:53:29 - created thread 12 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
</pre>

Wenn das Log wie oben abgebildet aussieht wurde alles richtig gemacht und unter dem Device in FHEM erscheint ein neues Reading "rooms" mit dem Wert der erkannten PRESENCE-Installation.

'''Verhalten presence timeout im zusammenhang mit dem Attribut "absenceThreshold" der PRESENCE Konfiguration in FHEM'''
<br>
In der collectord.conf sind <code>presence_timeout</code> und <code>absence_timeout</code> für den jeweiligen Raum konfiguriert.
Das bedeutet, sobald irgendein Gerät in diesem jeweiligen Raum anwesend/abwesend ist, wird das jeweilige Timeout an den verbundenen presenced/lepresenced geschickt um damit das Check-Interval entsprechend zu ändern.

In der PRESENCE-Definition kann man ebenfalls ein <code>absence_timeout</code>/<code>presence_timeout</code> setzen. Sobald sich der Zustand ändert, wird auch das jeweilige Timeout an den collectord gesandt. Dies hat aber auf die Checks in den jeweiligen Räumen und damit der collectord.conf keinen Einfluss. Der collectord schickt ein Statusupdate an PRESENCE nur, wenn das vorgegebene Timeout (von PRESENCE) erreicht ist und keine Statusänderung stattfand. Sobald eine Änderung des Status erfolgt wird natürlich sofort der Status an PRESENCE geschickt.

Das Attribut absenceThreshold/presenceThreshold funktioniert nachwievor. Hier ist nur wichtig wie man die Timeouts sowohl in PRESENCE als auch collectord.conf setzt.

'''Das Reading "room" bei einer PRESENCE Definition und der Zusammenhang zu collectord'''
<br>
Wenn ein BT LE Empfänger in mehr als einem Raum detektiert wird, führt der collectord (ab Version 1.8) eine RSSI-Erkennung durch. Sofern alle Räume den Empfangspegel (RSSI) ermitteln können, wird der Raum mit dem besten Empfangspegel als Raum für das "room"-Reading ausgewählt. Der lepresenced in aktueller Version von PatrickR gibt immer den Empfangspegel aus.

==== Automatischer Start ====
Wenn der collectord per .deb Paket installiert wurde, startet er automatisch bei einem Reboot mit (via systemd/init-Skript).
<br>

Der Collectord wird standardmäßig mit dem Port 5222 gestartet. Um diese anzupassen sind zwei Schritte notwendig:<br>
'''1.)''' Anpassen der /usr/bin/collectord
Hier bitte den Parameter my $opt_p von 5222 auf 5XXX abändern.

Da der collectord mittlerweile per systemd beim reboot des RPi gestarte wird muss auch diese Konfiguration auf den neuen Port angepasst werden.<br>
'''2.)''' Anpassen der /etc/default/collectord
<pre>
# collectord startup defaults:
# The TCP port collectord will listen for incoming connections (default: 5222)
PORT=5111
# The location of the configuration file (default: /etc/collectord.conf
CFGFILE=/etc/collectord.conf
</pre>

Manuell starten als Daemon (Parameter <code>-d</code>) mit:
<pre>
sudo collectord -c /etc/collectord.conf -d -v -l /var/log/collectord.log
</pre>

== Batterieüberwachung ==

=== Batterieüberwachung mit dem Modul BleTagBattery ===
{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h

|ModTechName=74_BleTagBattery
|ModOwner=mumpitzstuff
}}
Mit dem Modul BleTagBattery - können die Batteriestati aller BT-LE Devices gelesen werden.
Es wird das batteryLevel und battery angelegt welches als BT-LE Tags an einer PRESENCE-Installation registriert wurden.

Vorraussetzung und Installation:

Bluez und Gattool
sudo apt-get install bluez

Das Gattool ist in den Installationen von Bluez inbegriffen.

Hinzufügen des githup für das Modul
update add http://raw.githubusercontent.com/mumpitzstuff/fhem-BleTagBattery/master/controls_bletagbattery.txt
update all
restart fhem: shutdown restart
BT-LE tags muss an einer PRESENCE-Installation des type "lan-bluetooth" registriert sein.

Nach dem Neustart von FHEM kann das Modul definiert werden:
define a new device: define <name of device> BleTagBattery

Das Modul versucht in der Standardkonfiguration alle 6 Stunden die BT-LE Devices zu erreichen und das Reading batteryLevel und battery zu aktualisieren.
Das Update kann auch manuell mit dem folgenden Befehl erzwungen werden

set <name of device> statusRequest.

Weiter Informationen und Disskussionen können dem eigentlichen [https://forum.fhem.de/index.php?topic=68104.0 Forumsbeitrag] entnommen werden,

=== Batterieüberwachung (aktuell nur G-Tags) ===

Leider überträgt der G-Tag nach der Einrichtung als Device in FHEM kein Reading mit seinem aktuellen Batteriestatus.
Dem wurde mit Hilfe des Forum Abhilfe geschaffen.
Im Folgenden wird erläutert wie die Batterieüberwachung eingerichtet werden kann.

'''Voraussetzung:'''

bc - Basiscalculator [https://packages.debian.org/de/sid/bc Bc-Paket]
<pre> sudo apt-get install bc </pre>

Anlegen eines Shellskript auf dem Raspberry System.
Die Parameter <<MAC-Adresse>> und <<TagName>> müssen durch die Werte des auszulesenden G-Tags ersetzt werden.
<pre>
#!/bin/bash
stringZ=$(sudo gatttool -b 5C:2B:80:C1:14:41 --char-read --handle=0x001b)
stringZ=${stringZ:33:2}
stringZ=$(echo "$stringZ" | tr a-f A-F)
decimal=$(echo "ibase=16; $stringZ" | bc)
perl /opt/fhem/fhem.pl 7072 "setreading MeinGtag Batterie $decimal"
</pre>

Dem Device in FHEM (hier MeinGtag) ein userReading mit dem Namen '''Batterie''' hinzufügen.
Das Shellskript mit folgendem Befehl starten:
<pre>
./GtagBatterie.sh
</pre>
'''Wichtig ist hierbei,''' dass Skript mit "./" und nicht mit "sh" aufzurufen. Beim Aufruf mit "sh GtagBatterie.sh" produziert es einen Fehler
<pre>GtagBatterie.sh: 3: GtagBatterie.sh: Bad substitution </pre>

Das Reading wird auf den ausgelesenen Wert der Batterie gesetzt.

Hinweis: Es sollte für jeden G-Tag ein eigenes Skript abgelegt werden. Das Skript kann per crontab oder fhem Kommando (system) regelmäßig aufgerufen werden.

=== Batterieüberwachung (alle Devices vom Typ "MODE=lan-bluetooth") ===

Es gibt eine weitere Möglichkeit um den Batteriestatus von LE Devices abzurufen und in FHEM als Reading darzustellen.
Dabei wird der Batteriezustand für alle LE Devices, die bereits in FHEM konfiguriert sind und per lepresenced überwacht werden, automatisch in einem shell-Script ermittelt.
Näheres dazu im Forumartikel {{Link2Forum|Topic=56960|LinkText=Erweiterung: Anwesenheitserkennung/Batterieüberwachung}}.

Vorteile:
* Automatische Ermittlung aller in FHEM konfigurierten LE Devices
* Möglichkeit, diese Devices alternativ manuell im Script einzutragen
* Es werden nur Devices abgefragt, die im Status "present" sind, also mit ziemlicher Sicherheit auch verfügbar sind
* Ein eventuell auf dem FHEM telnet-Port gesetztes Passwort kann im Script hinterlegt werden

'''Voraussetzung:'''

'''Funktionierendes lepresenced''' - siehe [[Anwesenheitserkennung#Anleitung_f.C3.BCr_ein_LE_Device_.28z.B._Gtags.2CPebbles_etc..29|Anleitung für ein LE Device (z.B. Gtags,Pebbles etc.)]]

'''socat''' - TCP port forwarder
<pre>
sudo apt-get update && sudo apt-get install socat
</pre>

'''gawk''' - Zum extrahieren der Daten
<pre>
sudo apt-get update && sudo apt-get install gawk
</pre>

'''gatttool''' - Bestandteil von bluez

gatttool ist auf den meisten Distributionen im bluez-Paket, allerdings nicht bei Opensuse. Dort muss man das Sourcepaket von bluez installieren und selbst kompilieren.
gatttool sollte dann nach /usr/bin oder /usr/local/bin kopiert werden,

Zusätzlich zu den notwendigen Erweiterungen werden für die Ausführung von gatttool '''Root-Rechte benötigt'''!

Das Script selbst gibt es hier: [https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery lebattery]

Am Besten unter /opt/fhem/script/lebattery speichern und ausführbar machen:
<syntaxhighlight lang="bash">
sudo su -
mkdir /opt/fhem/script
cd /opt/fhem/script
wget https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery
chmod 755 lebattery
</syntaxhighlight>

Je nach Bedarf können im Script noch die folgenden 3 Parameter angepasst werden:
<syntaxhighlight lang="bash">
# If allowed_telnetPort is protected by a password, add the password here
TELNETPASSWORD=""
# Attribute for batterylevel in FHEM
ATTRIBUT="batterylevel"
# Use this, if you dont want the script to determine the tags on its own
LETAGS=""
</syntaxhighlight>

Das Skript wird dann unter root folgendermaßen gestartet:
<pre>
/opt/fhem/script/lebattery -v
</pre>

Ausgabe des Skripts, wenn es mit dem Verbose Parameter -v gestartet wird.

Beide Devices sind vom Typ NUT mini, das Device mit dem FHEM-Namen '''nut_Micky''' ist im Status '''absent'''. Das zweite Device ist im Status '''present'''.
<pre>
Determining address for nut_Micky ...
nut_Micky is in state absent, no further action required

Determining address for nut_Test ...
Fetching batterylevel for nut_Test (F3:44:04:81:54:89) ...
Setting batterylevel for nut_Test to 100%
</pre>

Mein crontab-Eintrag (User root) sieht so aus:
<pre>
3 3 * * * /opt/fhem/script/lebattery -v >/opt/fhem/script/lebattery.log 2>&1
</pre>
Damit wird jeden Morgen um 3 Minuten nach 3 Uhr der Zustand der Batterien aller Devices ermittelt und in FHEM abgespeichert.<br>
Bevor man das mit crontab macht, sollte man allerdings zunächst sicher stellen, dass es auch ohne crontab funktioniert....

Bei Problemen kann man auch erstmal schauen, ob das mit dem gattool überhaupt funktioniert:
<pre>
gatttool -t <Typ> -b <MAC-Adresse> --char-read --uuid 0x2a19

handle: 0x0017 value: 64
</pre>
In diesem Fall hat die Batterie noch 100% (hex 64).<br>
Der Typ ist abhängig vom Hersteller und kann public (G-Tags) bzw. random (Nut) sein. Im Zweifelsfall beides ausprobieren.

= Beispiele =
== Anwesenheitserkennung / Anwesenheitsbenachrichtigung mit G-Tags ==
Ein Skript zur Nutzung der Gigaset G-TAGs zur Alarmierung bei öffnen und schließen von Türen und zur Anwesenheitserkennung, um die Alarmierung zu aktivieren bzw. deaktivieren.
Es kann verwendet werden um die Anwesenheit von mehrern Personen im Haushalt zu erkennen. Dabei wird eingeschränkt, dass nur bestimmte Personen die Alarmierung aktivieren können ( Eltern/Kind -Beziehung ).
Des Weiteren werden im Beispiel die Eltern benachrichtigt wenn eins der Kinder das Haus verlässt und die Eltern nicht anwesend sind.

{{Randnotiz|RNText=Namen der G-Tags in den Skripten bitte anpassen!}}

Für die ''Notify'' und die ''RESIDENTS-Erweiterung'' wird ein Dummy benötigt.
<pre>
define Alarm dummy
attr Alarm devStateIcon aktiv:secur_locked@red inaktiv:secur_open@lightgreen
attr Alarm eventMap on:aktiv off:inaktiv
attr Alarm setList on off
attr Alarm webCmd aktiv:inaktiv
attr Alarm room Alarm
</pre>

=== Mit Notify ===
<pre>
gtag.*.presence:.* {Anwesenheit_check("$EVTPART1", "$NAME")}
</pre>

Code für die 99_myUtils.pm
<pre>
### GTAG ANWESENHEITS CHECK
sub Anwesenheit_check($$) {
my ($EVENT, $NAME) = @_;

# gtag_rot - Alias Marco
# gtag_schwarz - Alias Ulli
# gtag_gruen - Alias Frida
# gtag_orange - Alias Hannah

my $RESIDENT = "rr_"; # Alle GTAGs sind Standardmäßig Residents Roommate
# $RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur Gäste (Roomguest) Auskommentiert, da ich es so nicht brauche
my $ROOMMATE = ("$RESIDENT" . "$NAME"); # Residentsname zusammenbauen
my $ALIASNAME = AttrVal($ROOMMATE,'alias',$ROOMMATE); # ALIAS des Roommates auslesen

my $GTAG1 = Value('gtag_rot'); # ELTERN
my $GTAG2 = Value('gtag_schwarz'); # ELTERN

my $STATUS = "wahrscheinlich gerade los";
$STATUS = "anwesend" if ($EVENT eq "present"); # Status: anwesend
$STATUS = "unterwegs" if ($EVENT eq "absent"); # Status: unterwegs

Log 1, "$ALIASNAME ist $STATUS."; # LOG Eintrag erzeugen

if (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME ist da..."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME ist da...'"); # Pushover
}
elsif (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_rot" xor $NAME eq "gtag_schwarz")) {
fhem("set teleBot send ALARMIERUNG INAKTIV: $ALIASNAME ist da...; set Alarm inaktiv"); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG INAKTIV' '$ALIASNAME ist da...'; set Alarm inaktiv"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME hat das Haus verlassen.'"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "inaktiv") && ($GTAG1 eq "absent" && $GTAG2 eq "absent")) {
fhem("set Alarm aktiv; set teleBot send ALARMIERUNG AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Alarm aktiv; set Infopush msg 'ALARMIERUNG AKTIV' '$ALIASNAME hat das Haus verlassen.' '' 0 ''"); # Pushover
}
}
</pre>

<br>

=== Mit Notify und Integration des RESIDENTS-MODUL ===

Der hier beschriebene Code erweitert die Funktionen unter dem Punkt 5.93.
Das Notify muss daher mit der folgenden Zeile erweitert werden.

<pre>
define Alarm_AnwesenheitCheck notify gtag.*.presence:.* { Anwesenheit_check("$EVTPART1", "$NAME"), Anwesenheit_check_resi("$NAME") }
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die RESIDENTS Funktion nutzen zu können:
<pre>
### RESIDENTS
sub Anwesenheit_check_resi($) {
my ($NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME); # ALIASNAME des GTAGs auslesen

my $RESIDENT = "rr_"; # Als Standard sind alle GTAGs Roommates
$RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur GTAG Namen der Gäste (Roomguest)
my $ROOMMATE = ("$RESIDENT" . "$ALIASNAME"); # Residentsname zusammenbauen

if (ReadingsVal($NAME,'presence',$NAME) eq "absent") {
fhem("set $ROOMMATE absent"); # Resisents Status von Roommates setzen
}
elsif(ReadingsVal($NAME,'presence',$NAME) eq "present") {
fhem("set $ROOMMATE home"); # Resisents Status von Roommates setzen
}
}
</pre>
<br>

=== Mit Notify und Fenster/Tür. -Kontakt Überwachung ===

Erweiterung für die Überwachung von Fenster/Tür. -Kontakten. Dazu sind zwei weitere Notifys notwendig die auf die Trigger der Kontakte regagieren
und so eine weitere Funktion in der 99_myUtils.pm ansprechen. Die Notifys triggern auf Kontakte die mit dem Namen Kontakt* beginnen.
Sollten die eigenen Fenster/Tür. -Kontakt anderen Namen besitzen, müssen die Skripte dementsprechend angepasst werden.
<pre>
define Alarm_Kontaktmeldung notify Kontakt.*:contact:.* {Kontakt_Meldung("$EVTPART1", "$NAME")}
</pre>
<pre>
define Alarm_Sabotagealarm notify Kontakt.*.sabotageError:.on {Kontakt_Sabotage("$EVTPART1", "$NAME")}
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die TÜRKONTAKTE-Meldung nutzen zu können:
<pre>
### TÜRKONTAKTE-Meldung/Zustand
sub Kontakt_Meldung($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME wurde $EVENT";
if (ReadingsVal("Alarm", "state", "on") eq "on") {
fhem("set teleBot send $ALIASNAME wurde $EVENT"); # Nachricht über Telegram
# fhem("set Infopush msg '$ALIASNAME' '$ALIASNAME wurde $EVENT'"); # Nachricht über Pushover
}
}

### TÜRKONTAKTE-Sabotagealarm

sub Kontakt_Sabotage($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME meldet Sabotagealarm";
fhem("set teleBot send Alarm: $ALIASNAME meldet Sabotagealarm"); # Nachricht über Telegram
# fhem("set Infopush msg 'Alarmanlage' '$ALIASNAME meldet Sabotagealarm' '' 2 ' ' 60 600 "); # Nachricht über Pushover
}
</pre>
<br>

=== Hinweis zur Benutzung / Fehlerhandling ===

Der Alarm dummy hat den Zustand on:off. Die Bezeichnungen und Namen müssen 1:1 übernommen werden damit das Script funktioniert.
Andernfalls müssen die Bezeichnungen für z.B. absent:unterwegs und present:anwesend - angepasst werden.
Die Benachrichtigung kann aktuell per ''[[TelegramBot|Telegram]]'' sowie ''Pushover'' ('''Achtung mit zweiterem sind Abokosten verbunden!''') realisiert werden.
Diskussion zum Thema im Forum unter: {{Link2Forum|Topic=64080}}
<br>

= Problemlösungen =
Falls es '''Probleme beim Starten des Skripts''' gibt bzw. man das Skript ohne Reboot des Systems neustarten möchte, kann man dies per kill Befehl erledigen.
<syntaxhighlight lang="bash">
ps -ef | grep lepresenced
sudo kill <pid>
</syntaxhighlight>

Debuglevel lepresenced setzen:
{{Randnotiz|RNText=Um Debug-Meldungen zu bekommen (Vorsicht bei SD-Karten-Systemen wie dem RPi) - Hierbei werden die Schreibzyklen auf die SD-Karte erhöht.}}

Der Log Level muss im lepresenced-Skript selbst verändert werden. Um den Log-Level auf INFO/WARNING/DEBUG zu setzen, das Skript lepresenced mit einem Editor öffnen und die Stellen, wo LOG_WARNING zu finden ist, durch den nötigen LOG-Eintrag ersetzen.

<pre>
lepresenced --loglevel LOG_DEBUG
</pre>
Nur das wichtigste Loggen:
<pre>
lepresenced --loglevel LOG_WARNING
</pre>
Keinerlei LOG-Einträge
<pre>
lepresenced --loglevel LOG_EMERG
</pre>

Bei '''Problemen mit der Batterieüberwachung''' der Tags kann die Pi Firmware mit folgenden Befehl auf eine ältere Version zurückgesetzt werden.
Fehlermeldung beim Aufruf des lebattery oder anderen Batterietestskripten:
<pre>connect: Connection refused (111)</pre>

Lösung (vorübergehend)
<pre>
sudo rpi-update 8521fd34c8f66b6d109acce943f6e25ec93ec005
</pre>

Mehr dazu unter: {{Link2Forum|Topic=56960|Message=589165}}

'''Das BT-Device ist ständig "absent"'''<br>
Eine Mögliche Lösung kann sein, das Paket bluez-hcidump zu installieren. Das Werkzeug hcidump erlaubt die Beobachtung von Bluetooth-Aktivitäten.
Dies ist nicht notwendig, wenn bereits bluez installiert ist, da dies Teil des bluez Paketes ist
<pre>
sudo apt-get install bluez-hcidump
</pre>

'''Fehler in Logdateien /var/log/syslog und /var/log/kernel'''
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634211] bt_err_ratelimited: 1 callbacks suppressed
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634231] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:12 raspberrypi kernel: [ 4906.647350] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.532081] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.655564] Bluetooth: hci0 advertising data length corrected

Die Ursache des Problems ist noch nicht ergründet, allerdings betrifft dies aktuell nur den RPi3. Die Fehlermeldungen werden in verschiedene Logs geschrieben. Darunter maßgeblich "syslog" und "kern.log".

Lösung (vorübergehend):
Unterbinden der Einträge durch Anlage eines blocklist Eintrag:

1. Unter "/etc/rsyslog.d" eine Datei erzeugen mit dem Namen "01-blocklist.conf"
2. Inhalt: (Die Ausdrücke in den "" sind diejenigen, die aus dem log verschwinden sollen. - bei mir waren es die untenstehenden")
:msg,contains,"Bluetooth: hci0 advertising data length corrected" stop
:msg,contains,"bt_err_ratelimited:" stop
3. Dienst neu starten "sudo service rsyslog restart"

Weiter Infos werden im offiziellen Thema {{Link2Forum|Topic=28753|Message=499184|LinkText=hier}} diskutiert.

Seit Version 0.82 kann es beim Start zu folgenden Meldungen im Log kommen.
Sep 06 16:13:45 raspberrypi systemd[1]: Started lepresenced.
Sep 06 16:13:45 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: Received 'Set scan parameters failed: Input/output error', ...tting...
Sep 06 16:13:46 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: hcitool exited, retrying...

Diese Meldungen können ignoriert werden. Abhilfe schafft sich lepresenced selbst, indem es sich resettet.

'''Moderne iPhones und Android Geräte wechseln in den Schlaf-Modus''', um Energie zu sparen. Somit sind die Geräte zur Anwesenheitserkennung nicht per Ping zu erreichen.
Durch das Programm hping3, lassen sich zyklisch Pakete an die Geräte senden, um sie wieder "aufzuwecken".

Mehr im Forum [https://forum.fhem.de/index.php/topic,76342.0.html]

= Versionsänderungen lepresenced =
<pre>
--Version 0.81 (BasisVersion)
--Version 0.82 (stable 08/2017)
-Neue Kommandozeilenoption "--debug": Startet lepresenced im Vordergrund und gibt ausführliche Debug-Informationen auf STDOUT aus.
-Sanity Check: lepresenced prüft beim Starten die Verfügbarkeit von hciconfig, hcitool und hcidump.
-Model: lepresenced übermittelt das Reading model nun als lan-lepresenced. Das erlaubt die Erkennung von lepresenced in der FHEM-Statistik (sofern aktiviert).
--Version 0.83 (stable 09/2017)
- Behebung von Systemstart Fehlern
- Weitere Debug-Möglichkeiten. U. a. wird nun mitgezählt, ob hcitool lescan ("legacy") und hcidump eine identische Zahl an Beacons empfangen
</pre>

= Ansprechpartner =
# {{Link2FU|117|markusbloch }} (Markus) für das PRESENCE-Modul und collectord
# {{Link2FU|5068|PatrikR}} (Patrick) für lepresenced
# [[Benutzer Diskussion:Devender|Devender]] ({{Link2FU|20043|Dirk}}) für Wiki und Doku

[[Kategorie:Anwesenheitserkennung]]

AutoShuttersControl

2019-12-15T07:05:12Z

50watt: /* BlockingTime */ Tippfehler

{{Baustelle}}
{{Infobox Modul
|ModPurpose=Steuerung von Rollläden
|ModCategory=Automatisierung
|ModType=d
|ModForumArea=Automatisierung
|ModTechName=73_AutoShuttersControl.pm
|ModOwner=CoolTux ({{Link2FU|13684|Forum}}/[[Benutzer Diskussion:CoolTux|Wiki]])}}

Mit [[AutoShuttersControl]] oder kurz ASC können typische Aufgabenstellungen im Zusammenhang mit Rollläden u.ä. automatisiert werden, wie zum Beispiel das Öffnen bei Sonnenaufgang, Schließen bei Sonnenuntergang oder das Anfahren von Lüftungspositionen beim Öffnen des zugehörigen Fensters.

== Basics ==
{{Hinweis|Das Modul befindet sich derzeit noch in der Entwicklung; der jeweils aktuelle Stand ist diesem {{Link2Forum|Topic=90751|LinkText="Thread im Forum"}} zu entnehmen.}}
Zur Nutzung des Moduls sollten folgende andere FHEM-Devices vorhanden sein:
* Rollläden
* Fensterkontakte und
* Bewohnerstatus auf Basis von Residents/Roomates in englisch. Ersatzweise andere Devices, z.B. Dummys, welche als ''state'' ''home'', ''asleep'', ''gotosleep'' und ''awoken'' setzen sowie ein Reading ''lastState''.
* Optional:
** Ein Helligkeitssensor (Steuerung nach Helligkeit und Beschattung)
** Ein Device zur Bestimmung des Sonnenstands (nur für Beschattung). Unterstützt werden derzeit [[Modul Astro|Astro]] und [[Twilight]]<ref>Dabei müssen ggf. in [[Global|global]] auch Angaben zu ''longitude'' und ''latitude'' vorhanden sein</ref>.
** Wenn Feiertage berücksichtigt werden sollen: Ein oder mehrere {{Link2CmdRef|Anker=holiday2we|Lang=en|Label=holiday2we}}-Angaben in [[Global|global]] samt entsprechender [[Wochenende, Feiertage und Schulferien#Feiertage mittels holiday-Datei|holiday]]-Dateien<ref>Es kann auch z.B. ein Dummy-Device verwendet werden, dieses sollte dann aber neben dem eigentlichen Feiertags-''state'' auch in einem Reading ''tomorrow'' Angaben zu anstehenden Feiertagen enthalten.</ref> <ref>Bitte verfahren Sie entsprechend, wenn Urlaubs- oder Ferientage wie Feiertage behandelt werden sollen.</ref>.

Die Einrichtung des Moduls bzw. dessen Funktionalität erfolgt in mehreren Schritten:
* Definition des ASC-Devices
* Einstellung zentraler Vorgaben am ASC-Device
* Markieren der zukünftig zu steuernden Rollladen-Devices
* Einbinden der Rollladen-Devices in das ASC-Device
* Einstellen der individuellen Vorgaben je Rollladen (am Rollladen-Device)
Dabei geht man am einfachsten schrittweise vor und erweitert die Funktionalität nach und nach um die gewünschten Funktionen. Dann benötigt man jeweils nur einen kleinen Teil der vielen per Attribut einstellbaren Optionen, und kann die Auswirkungen der jeweiligen Änderung besser nachvollziehen.

== Einrichtung ==
{{Hinweis|ASC kann auch verwendet werden, um lediglich Teilaufgaben der Rollladensteuerung zu erfüllen, also z.B. nur das morgendliche Öffnen der Rollläden. Allerdings geht dabei ein erheblicher Teil des Komforts verloren, der dadurch entsteht, dass die Steuerung innerhalb der vollintegrierten Lösung jeweils nachvollzieht, aus welchem Grund eine Fahrt erfolgt war und dies ggf. bei der nächsten Aktion berücksichtigt.}}

=== Vorbereitung ===
Zunächst sollten die in den [[#Basics|Basics]] beschriebenen Geräte vorhanden und funktionsfähig sein.

=== Define des ASC-Devices ===
Es genügt ein einfaches define ohne weitere Parameter.
<code>define <name> AutoShuttersControl</code>
Dies bewirkt neben der Anlage des Devices selbst auch, dass als weiteres globales Attribut ''ASC'' verfügbar wird.

=== Einstellung zentraler Vorgaben ===
Es stehen am ASC-Device einige Attribute zur Verfügung, über die sich das Verhalten des ASC-Devices insgesamt steuern lässt, z.B. zur Vermeidung von morgendlichen oder abendlichen Fahrten sowie bei Gefahr von Schäden an den Rollläden durch Frost oder zur Reaktion auf Fensterkontakte. Details sind der Commandref zu entnehmen.
Diese Attribute können auch nachträglich noch geändert werden.

=== Markieren zu steuernder Rollladen-Devices ===
Um einen oder mehrere Rollläden durch das ASC-Device zu steuern, wird für jeden Rollladen jeweils das neue globale Attribut ''ASC'' gesetzt. Der Wert ist mit 1 oder 2 festzulegen, wobei '''1''' bedeutet, dass
* die Offen-Position kleiner ist als die Geschlossen-Position, also typischerweise 0 ''offen'' bedeutet und 100 für ''geschlossen'' steht
* eine bestimmte Position mit '''position''' angefahren wird, also z.B. <code>set <name> position 70</code>.
Dies ist z.B. die passende Wahl für ROLLO-Devices

Die '''2''' steht für ein umgekehrtes Verhalten und den Befehlsteil ''pct'', also ''offen'' für <code>set <name> pct 100</code>. Typischer Vertreter dieses Typs sind HomeMatic (CUL_HM-) Geräte oder die Shelly2-Aktoren.

Aus dieser Vorgabe leitet das Modul dann jeweils bestimmte Voreinstellungen (''defaults'') für den Rolladen ab, ohne dass die betreffenden, dafür vorgesehenen Attribute ausdrücklich gesetzt werden müssen. Es genügt daher, nur jeweils die Einstellungen zu verändern, die anders gewünscht werden oder für den Rollladenaktortyp anders sein müssen (z.B. ''dim 99'' für vollständiges Öffnen eines ZWave-Aktors).
{{Hinweis|Das Vorstehende gilt jeweils für den nicht-invertierten Modus! Wer z.B. ein HomeMatic-Gerät mit ''levelinverse'' betreibt, sollte ''ASC'' auf "1" setzen usw.. Maßgeblich ist letztlich nur die Frage, ob die Offen-Positionsangabe nummerisch kleiner oder größer als die Geschlossen-Positionsangabe ist; die konkreten Zahlenwerte spielen dabei keine Rolle, die Angabe ''position'' oder ''pct'' kann auch später über ein weiteres Attribut passend eingestellt werden.}}

=== Einbinden in das ASC-Device ===
Nachdem man das obige Attribut bei einem oder mehreren Rollladen-Devices gesetzt hat, kann mit
<code>set <name> scanForShutters</code> ein Suchlauf gestartet werden, mit dem dann diese Rollläden durch das Modul gefunden und in die Steuerungslogik eingebunden werden.

=== Einstellen der individuellen Vorgaben ===
Nach der Einbindung sind an den Rollladen-Devices weitere Attribute verfügbar, mit denen die für den jeweiligen Rollladen geltenden Einstellungen vorgenommen werden können.
Die Beschreibung der Attribute ist in der commandref enthalten.

== Readings ==

===Readings im ASC-Device selbst ===

{|class="wikitable"
|-
! Name !! Datentyp/<BR/>Wertebereich !! Bedeutung
|-
|..._nextAstroTimeEvent || ||Uhrzeit des nächsten Astro-Events, Sonnenauf- oder Sonnenuntergang oder feste Zeit pro Rollonamen
|-
|..._lastPosValue || ||zuletzt abgesetzter Fahrbefehl pro Rollonamen
|-
|..._lastDelayPosValue || ||zuletzt abgesetzter Fahrbefehl, welcher beim nächsten zulässigen Event ausgeführt wird
|-
|partyMode ||on, off || aktiviert den globalen Partymodus. Alle Rollläden, welche das Attribut ''AutoShuttersControl_Partymode'' bei sich auf ''on'' gestellt haben, werden nicht mehr gesteuert. Der letzte Schaltbefehl, welcher durch ein Fensterevent oder Bewohnerstatus an die Rollläden gesendet wurde, wird erst beim off-setzen (set <ASC-Device> partyMode off) ausgeführt
|-
|lockOut || on, off ||für das Aktivieren des Aussperrschutzes gemäß des entsprechenden Attributs ''AutoShuttersControl_lock-out'' im jeweiligen Rolladen (siehe Beschreibung bei den Attributen für die Rolladendevices)
|-
|room_... || ||Auflistung aller Rollläden, welche in den jeweiligen Räumen gefunden wurden, Bsp.: room_Schlafzimmer,Terrasse
|-
|state || ||Status des <ASC-Device> active, enabled, disabled
|-
|sunriseTimeWeHoliday|| on,off ||legt fest, ob das Rolladendevice das Attribut ''AutoShuttersControl_Time_Up_WE_Holiday'' beachtet oder nicht
|-
|userAttrList || rolled out ||Status der UserAttribute, welche an die Rollläden gesendet werden
|}

=== Readings in den Rolllädendevices ===

{|class="wikitable"
|-
! Name !! Bedeutung
|-
|ASC_Time_DriveUp ||Sonnenaufgangszeit für das Rollo
|-
|ASC_Time_DriveDown ||Sonnenuntergangszeit für das Rollo
|-
|ASC_ShuttersLastDrive ||Grund des letzten Fahrens vom Rolladen
|}

==set- und get-Befehle für das ASC-Device==

=== set-Anweisungen ===
{|class="wikitable"
|-
! Name !! Datentyp/<BR/>Wertebereich !! Beschreibung
|-
|partyMode ||on, off ||aktiviert den globalen Partymodus. Siehe Reading ''partyMode''
|-
|lockOut ||on, off ||aktiviert den globalen Aussperrschutz. Siehe Reading ''lockOut''
|-
|renewSetSunriseSunsetTimer || || erneuert bei allen Rollläden die Zeiten für Sunset und Sunrise und setzt die internen Timer neu.
|-
|scanForShutters || ||sucht alle FHEM Devices mit dem Attribut ''AutoShuttersControl'' ''1'' oder ''2''
|-
|sunriseTimeWeHoliday || on,off ||aktiviert/deaktiviert die Beachtung des Attributes ''AutoShuttersControl_Time_Up_WE_Holiday'' für Rollladen-Devices
|-
|createNewNotifyDev || ||Legt die interne Struktur für NOTIFYDEV neu an
|-
|selfDefence ||on, off||aktiviert/deaktiviert den Selbstschutz: wenn das Residents-Device ''absent'' meldet, ''selfDefence'' aktiv ist und ein Fenster im Haus noch offen steht, wird an diesem Fenster das Rollo runtergefahren
|-
|wiggle ||||bewegt einen Rollladen oder alle Rollläden (für Abschreckungszwecke bei der Alarmierung) um ''ASC_WiggleValue''-%, und nach 1 Minute wieder zurück zur Ursprungsposition
|-
|||||
|}

=== get-Anweisungen ===

{|class="wikitable"
|-
! Name !! Beschreibung
|-
| showShuttersInformations ||zeigt eine Übersicht der Automatik-Fahrzeiten
|-
| showNotifyDevsInformations ||zeigt eine Übersicht der abgelegten NOTIFYDEV Struktur. Dient zur Kontrolle
|}
== Attribute ==
{{Hinweis|Die Attributnamen haben sich teilweise geändert, nachfolgend ist noch ein Stand vor Modulversion 0.6.5.x wiedergegeben. Die aktuellen Benennungen sind der Commandref zu entnehmen.}}
{{Hinweis|In der commandref findet sich häufig die Schreibweise <code>ASC_BrightnessSensor Sensorname[:brightness [400:800]]</code>. Dabei sind die Angaben in den eckigen Klammern optional. Dies müssen also nicht angegeben werden, stattdessen verwendet das Modul dann Standardwerte (siehe cref), die in der cref zu findenden Angaben entsprechen dabei den defaults. Werden Werte angegeben, sind die eckigen Klammern '''wegzulassen'''! Beispiel: <code>ASC_BrightnessSensor hm_motion_1 70:100</code> würde das brightness-Reading des Sensors hm_motion_1 verwenden und einen morgendlichen Schwellenwert von 70 bzw. 100 für abends.}}
===Attribute direkt am ASC-Device ===

{|class="wikitable"
|-
! Name !! Datentyp/<BR/>Wertebereich !! Default-Wert !! Beschreibung
|-
|ASC_antifreezeTemp || || ||Temperatur, ab welcher der Frostschutz greift und das Rollo nicht mehr fährt. Der letzte Fahrbefehl wird gespeichert
|-
|ASC_autoAstroModeEvening ||aktuell REAL, CIVIL, NAUTIC, ASTRONOMIC, HORIZON || || (in genau dieser Schreibweise)
|-
|ASC_autoAstroModeEveningHorizon || || || Höhe über Horizont, wenn beim Attribut ''AutoShuttersControl_autoAstroModeEvening'' ''HORIZON'' ausgewählt
|-
|ASC_autoAstroModeMorning ||aktuell REAL, CIVIL, NAUTIC, ASTRONOMIC, HORIZON || ||(in genau dieser Schreibweise)
|-
|ASC_autoAstroModeMorningHorizon || || ||Höhe über Horizont, wenn beim Attribut ''AutoShuttersControl_autoAstroModeMorning'' ''HORIZON'' ausgewählt
|-
|ASC_autoShuttersControlComfort ||on, off || ||aktiviert die Komfortfunktion. Bedeutet, dass ein Rollladen mit einem threestate (Drehgriff-) Sensor am Fenster beim Öffnen in die "Komfortposition" fährt. Diese wird beim Rollladendevice über das Attribut ''AutoShuttersControl_Pos_after_ComfortOpen'' eingestellt.
|-
|ASC_autoShuttersControlEvening ||on, off || ||ob Abends die Rollläden automatisch zeitgesteuert werden sollen
|-
|ASC_autoShuttersControlMorning ||on, off || ||ob Morgens die Rollläden automatisch zeitgesteuert werden sollen
|-
|ASC_temperatureReading || || ||Reading für die Außentemperatur
|-
|ASC_temperatureSensor || || ||Device für die Außentemperatur
|-
|ASC_timeUpHolidayDevice || || ||Device zur Urlaubserkennung oder Sonstiges / muss ''0'' oder ''1'' im Reading ''state'' beinhalten.
|-
|ASC_residentsDevice|| || ||Devicenamen des Residents-Device der obersten Ebene
|-
|ASC_residentsDeviceReading|| || ||Status Reading des Residents-Device der obersten Ebene
|-
|ASC_brightnessMinVal|| || ||minimaler Lichtwert, bei dem Schaltbedingungen noch geprüft werden sollen
|-
|ASC_brightnessMaxVal || || ||maximaler Lichtwert, bei dem Schaltbedingungen noch geprüft werden sollen
|-
|ASC_rainSensorDevice || || ||Device, welches bei Regen getriggert wird
|-
|ASC_rainSensorReading || || ||das ensprechende Reading zum Regendevice
|-
|ASC_rainSensorShuttersClosedPos || || ||Position in pct, welche der Rollladen bei Regen anfahren soll
|-
|ASC_shuttersDriveOffset || || ||maximale zufällige Verzögerung in Sekunden bei der Berechnung der Fahrzeiten, ''0'' bedeutet keine Verzögerung
|-
|ASC_twilightDevice || || ||Device, welches Informationen zum Sonnenstand liefert, wird unter anderem für die Beschattung verwendet.
|-
|ASC_expert || || ||bei ''1'' werden erweiterte Informationen bezüglich des NotifyDevs unter ''set'' und ''get'' angezeigt
|-
| || || ||
|-
| || || ||
|}

===Attribute in den Rolllädendevices===

{|class="wikitable"
|-
! Name !! Datentyp/<BR/>Wertebereich !! Default-Wert !! Beschreibung
|-
|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'', bei ''hard/am/pm'' wird gar nicht oder innerhalb der entsprechenden Tageszeit nicht gefahren
|-
|ASC_Antifreeze_Pos || || ||Position, die angefahren werden soll, wenn der Fahrbefehl komplett schließen lautet, aber der Frostschutz aktiv ist
|-
|ASC_AutoAstroModeEvening ||REAL, CIVIL, NAUTIC, ASTRONOMIC, HORIZON || ||aktuell REAL,CIVIL,NAUTIC,ASTRONOMIC
|-
|ASC_AutoAstroModeEveningHorizon || || ||Höhe über Horizont, wenn beim Attribut ''ASC_autoAstroModeEvening'' ''HORIZON'' ausgewählt ist
|-
|ASC_AutoAstroModeMorning ||REAL, CIVIL, NAUTIC, ASTRONOMIC, HORIZON || ||aktuell REAL,CIVIL,NAUTIC,ASTRONOMIC
|-
|ASC_AutoAstroModeMorningHorizon || || ||Höhe über Horizont, wenn beim Attribut ''ASC_autoAstroModeMorning'' ''HORIZON'' ausgewählt ist
|-
|ASC_Closed_Pos || || ||in 10er Schritten von 0 bis 100,default Vorgabe 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_brightnessMinVal'' erreicht wurde. Wenn ja, wird der Rolladen runter gefahren
|-
|ASC_Mode_Down ||always, home, absent, off || ||wann darf die Automatik herunterfahren. immer, niemals oder bei Abwesenheit des Roommate (ist kein Roommate und ''absent'' eingestellt, wird gar nicht gesteuert)
|-
|ASC_Mode_Up ||always, home, absent, off || ||wann darf die Automatik hochfahren. immer, niemals oder bei Abwesenheit des Roommate (ist kein Roommate und ''absent'' eingestellt, wird gar nicht gesteuert)
|-
|ASC_Drive_Offset || || ||maximale zufällige Verzögerung in Sekunden bei der Berechnung der Fahrzeiten, ''0'' bedeutet sofort, ''-1'' bedeutet, dass das gleichwertige Attribut aus dem ASC-Device ausgewertet werden soll
|-
|ASC_Open_Pos || || ||in 10er-Schritten von 0 bis 100, default Vorgabe ist abhängig vom Attribut ''ASC''
|-
|ASC_Partymode || on, off || ||schaltet den Partymodus an oder aus. Wird dann am ASC Device ''set <ASC-DEVICE> partyMode on'' geschaltet, werden alle Fahrbefehle an den Rollläden, welche das Attribut auf ''on'' haben, zwischengespeichert und erst später ausgeführt
|-
|ASC_Pos_Reading || || ||Name des Readings, welches die Position des Rollladen in Prozent angibt. Wird bei unbekannten Device-Typen auch als ''set'' Befehl zum Fahren verwendet
|-
|ASC_Pos_after_ComfortOpen || || ||in 10er-Schritten von 0 bis 100, default Vorgabe ist abhängig vom Attribut ''ASC''
|-
|ASC_Roommate_Reading || || ||Reading des Roommate-Device, welches den Status wieder gibt
|-
|ASC_Roommate_Device || || ||mit Komma getrennte Namen des/der Roommate-Device/s welche den/die Bewohner des Rollladen-Raumes wiedergibt. Macht nur Sinn in Schlaf- oder Kinderzimmern
|-
|ASC_Time_Down_Early || || ||Sunset früheste Zeit zum Runterfahren
|-
|ASC_Time_Down_Late || || ||Sunset späteste Zeit zum Runterfahren
|-
|ASC_Time_Up_Early || || ||Sunrise früheste Zeit zum Hochfahren
|-
|ASC_Time_Up_Late || || ||Sunrise späteste Zeit zum Hochfahren
|-
|ASC_Time_Up_WE_Holiday || || ||Sunrise früheste Zeit zum Hochfahren am Wochenende und/oder Urlaub (holiday2we wird beachtet).
|-
|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'' müssen ''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 ''ASC_brightnessMinVal'' erreicht wurde. Wenn ja, wird der Rolladen runter gefahren
|-
|ASC_Ventilate_Pos || || ||in 10er-Schritten von 0 bis 100, default Vorgabe 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
|-
|ASC_WindowRec || || ||Name des Fensterkontakts, an welchen Fenster der Rollladen angebracht ist. Sein Reading ''state'' muss die Werte ''open'', ''closed'' oder ''tilted'' enthalten.
|-
|ASC_WindowRec_subType || || ||Typ des verwendeten Fensterkontakts: ''twostate'' (optisch oder magnetisch) oder ''threestate'' (Drehgriffkontakt)
|-
|ASC_LockOut || soft, hard || ||stellt entsprechend den Aussperrschutz ein. Bei global aktiven Aussperrschutz (''set ASC-Device lockOut soft'') und einem Fensterkontakt ''open'' bleibt dann der Rolladen oben. Dies gilt nur bei Steuerbefehle ü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.
|-
|ASC_LockOutCmd || inhibit, blocked || ||set Befehl für das Rolladen-Device zum Sperren per Hardware. Der Befehl wird verwendet, wenn ''ASC_LockOut'' auf ''hard'' gesetzt ist
|-
|ASC_Self_Defense_Exclude || on, off || ||bei ''on'' wird dieser Rolladen bei aktiven ''selfDefence'' und offenen Fenster nicht runter gefahren, wenn Residents absent ist
|-
|ASC_Shading_Brightness_Sensor || || ||Sensor-Device, welches für die Lichtwerte verwendet wird. ACHTUNG! Findet auch Verwendung bei ASC_Down - brightness
|-
|ASC_BrightnessMinVal || || ||minimaler Lichtwert, bei dem Schaltbedingungen noch geprüft werden sollen / wird der Wert von ''-1'' nicht geändert, so wird automatisch der Wert aus dem Moduldevice genommen
|-
|ASC_BrightnessMaxVal || || ||maximaler Lichtwert, bei dem Schaltbedingungen noch geprüft werden sollen / wird der Wert von ''-1'' nicht geändert, so wird automatisch der Wert aus dem Moduldevice genommen
|-
|ASC_ShuttersPlace || window, terrace || ||wenn dieses Attribut auf ''terrace'' gesetzt ist und das Residents-Device in den Status ''gone'' geht und ''selfDefence'' aktiv ist, wird das Rollo geschlossen
|-
|ASC_WiggleValue || || ||Wert, um welchen sich die Position des Rollladens bei ''Wiggle'' ändern soll
|-
|ASC_BlockingTime_afterManual || || ||Wartezeit in Sekunden, die die Automatik nach einer manuellen Fahrt aussetzen soll
|-
|ASC_BlockingTime_beforNightClose || || ||Vorgabezeit in Sekunden, innerhalb derer vor dem nächtlichen Schließen keine Öffnen-Fahrt mehr ausgeführt werden soll
|-
|ASC_BlockingTime_beforDayOpen || || ||Vorgabezeit in Sekunden, innerhalb derer vor dem morgendlichen Öffnen keine Schließen-Fahrt mehr ausgeführt werden soll
|-
|ASC_Shading_Direction || || ||Position in Grad, auf der das Fenster liegt - genau Osten wäre 90, Süden 180 und Westen 270
|-
|ASC_Shading_Pos || || ||Position des Rollladens für die Beschattung
|-
|ASC_Shading_Angle_Left || || ||Vorlaufwinkel im Bezug zum Fenster, ab wann abgeschattet wird. Beispiel: Fenster 180° - 85° ==> ab Sonnenpos. 95° wird abgeschattet
|-
|ASC_Shading_Angle_Right || || ||Nachlaufwinkel im Bezug zum Fenster, bis wann abgeschattet wird. Beispiel: Fenster 180° + 85° ==> bis Sonnenpos. 265° wird abgeschattet
|-
|ASC_Shading_Mode || || ||absent,always,off,home / Vorgabe, wann Beschattungsaktionen durchzuführen sind
|-
|ASC_Shading_StateChange_Sunny || || ||Brightness Wert ab welchen Beschattung statt finden soll, immer in Abhängikkeit der anderen einbezogenden Sensorwerte
|-
|ASC_Shading_StateChange_Cloudy || || ||Brightness Wert ab welchen die Beschattung aufgehoben werden soll, immer in Abhängikkeit der anderen einbezogenden Sensorwerte
|-
|ASC_Shading_Min_Elevation || || ||ab welcher Höhe des Sonnenstandes soll beschattet werden, immer in Abhängikkeit der anderen einbezogenden Sensorwerte
|-
|ASC_Shading_Min_OutsideTemperature || || ||ab welcher Temperatur soll Beschattet werden, immer in Abhängikkeit der anderen einbezogenden Sensorwerte
|-
|ASC_Shading_WaitingPeriod || || ||wie viele Sekunden soll gewartet werden bevor eine weitere Auswertung der Sensordaten für die Beschattung statt finden soll
|-
|ASC_PrivacyDownTime_beforNightClose || || ||wie viele Sekunden vor dem abendlichen schlie&zlig;en soll der Rollladen in die Sichtschutzposition fahren, -1 bedeutet das diese Funktion unbeachtet bleiben soll
|-
|ASC_PrivacyDown_Pos || || ||Position den Rollladens für den Sichtschutz
|-
| || || ||
| || || ||
|-
| || || ||
|-
| || || ||
|-
| || || ||
|}

== Hilfsmittel ==
{{Hinweis|Die Device-Namen sind auf die eigene Installation anzupassen.}}

=== Interne Übersicht ===
[[Bild:ASC Overview.JPG|thumb|right|weblink - Beispiel]]
<pre style="width:65%;word-break: break-all;word-wrap: break-word;">
define ASC_Jalousie_Info weblink htmlCode {AutoShuttersControl::GetShuttersInformation($defs{'JalousieControl'})}
</pre>

{{Hinweis|Codezeilen sind im [[Import von Code Snippets|RAW]]-Format.}}

=== readingsGroup für Level ===

{{Randnotiz|RNTyp=g|RNText= Stand 2019-05-03
* Erfolgreich getestet mit Homematic Devices, Beta-User
* Die Farbgebung entspricht dem Standard, wenn unter dem Style f18 der Farbpreset ''light'' gewählt wird.
}}

<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Level readingsGroup <Gerät>,<Stand>,<Schliessen bis>,<Öffnen auf>,<Beschattung>,<Komfort>,<Lüften>,<Privacy> (Rollladen_.*|Jalousie_.*)..:level,!?ASC_Closed_Pos,!?ASC_Open_Pos,!?ASC_Shading_Pos,!?ASC_ComfortOpen_Pos,!?ASC_Ventilate_Pos,!?ASC_PrivacyDown_Pos
attr rg_ASC_Rolllaeden_Level commands {level => 'pct:selectnumbers,0,5,100,0,lin',\
ASC_Closed_Pos => 'ASC_Closed_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Open_Pos => 'ASC_Open_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Pos => 'ASC_Shading_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:selectnumbers,0,5,100,0,lin',\
ASC_ComfortOpen_Pos => 'ASC_ComfortOpen_Pos:selectnumbers,0,5,100,0,lin',\
ASC_PrivacyDown_Pos => 'ASC_PrivacyDown_Pos:selectnumbers,0,5,100,0,lin'}
</pre>

=== readingsGroup für Zeiten ===
[[Bild:ReadingsGroup ASC times.png|thumb|right|ReadingsGroup - Zeitenbeispiel]]
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Times readingsGroup <Gerät>,<Position>,<Time_Up_Early>,<Time_Up_Late>,<Time_Up_WE/Hol>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up> \
(.*Rollo.*|.*Rollladen|Jalousie_.*):level,!?ASC_Time_Up_Early,!?ASC_Time_Up_Late,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up
attr rg_ASC_Rolllaeden_Times commands {level => 'pct:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100', \
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00', \
ASC_Time_Down_Late => 'ASC_Time_Down_Late:19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30', \
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',\
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:55,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Time_Up_Late => 'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off', \
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off' }
attr rg_ASC_Rolllaeden_Times room Rollladen</pre>

[[Bild:ASC RG Zeiten HM ZWave Siro.png|thumb|right|ReadingsGroup - CUL_HM+ZWave+Siro mit widgets]]Neue Version mit time-Widgets und pct/dim/position-widget (5-er Schritte), passend für CUL_HM, ZWave und Siro-Geräte:
<pre style="width:65%;word-wrap: break-word;">defmod rg_ASC_Rolllaeden_Times readingsGroup <Gerät>,<Stand>,<Time_Up_Early >,<Time_Up_WE >,<Time_Up_Late >,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up> (Rollo_.*|Jalousie_.*)..:(level|dim|position),!?ASC_Time_Up_Early,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Up_Late,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up
attr rg_ASC_Rolllaeden_Times commands {level => 'pct:selectnumbers,0,5,100,0,lin', \
dim => 'dim:selectnumbers,0,5,99,0,lin',\
position => 'pct:selectnumbers,0,5,99,0,lin',\
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off',\
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off',\
ASC_Time_Down_Early => 'ASC_Time_Down_Early:time', \
ASC_Time_Down_Late => 'ASC_Time_Down_Late:time',\
ASC_Time_Up_Early => 'ASC_Time_Up_Early:time', \
ASC_Time_Up_Late =>'ASC_Time_Up_Late:time',\
ASC_Time_Up_WE_Holiday =>'ASC_Time_Up_WE_Holiday:time'}
attr rg_ASC_Rolllaeden_Times room Rollladen
</pre>

=== readingsGroup für die Beschattung ===
[[Bild:ReadingsGroup ASC shading.png|thumb|right|ReadingsGroup - Beschattungsbeispiel]]
<pre style="width:65%;word-wrap: break-word;">
defmod rg_ASC_Rolllaeden_Shading readingsGroup <Gerät>,<Modus>,<Position>,<Richtung>,<°links>,<°rechts>,<Elevation>,<Sunny>,<Cloudy>,<Min Temp> (Rollo|Jalousie)_.*..:!?ASC_Shading_Mode,!?ASC_Shading_Pos,!?ASC_Shading_Direction,!?ASC_Shading_Angle_Left,!?ASC_Shading_Angle_Right,!?ASC_Shading_MinMax_Elevation,!?ASC_Shading_StateChange_Sunny,!?ASC_Shading_StateChange_Cloudy,!?ASC_Shading_Min_OutsideTemperature
attr rg_ASC_Rolllaeden_Shading alias Rollläden: Beschattung
attr rg_ASC_Rolllaeden_Shading commands {ASC_Shading_Pos => 'ASC_Shading_Pos:knob,min:0,max:100,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round',\
ASC_Shading_Mode => 'ASC_Shading_Mode:always,home,absent,off',\
ASC_Shading_Direction => 'ASC_Shading_Direction:knob,min:0,max:360,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:1,cursor:true,lineCap:round',\
ASC_Shading_Angle_Left => 'ASC_Shading_Angle_Left:knob,min:0,max:85,angleArc:85,rotation:anticlockwise,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round,angleOffset:270',\
ASC_Shading_Angle_Right => 'ASC_Shading_Angle_Right:knob,min:0,max:85,angleArc:85,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round,',\
ASC_Shading_MinMax_Elevation => 'ASC_Shading_MinMax_Elevation:knob,min:0,max:35,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:1,lineCap:round,angleArc:120,angleOffset:270',\
ASC_Shading_StateChange_Sunny => 'ASC_Shading_StateChange_Sunny:knob,min:100,max:40000,angleArc:85,rotation:anticlockwise,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:20,lineCap:round,angleOffset:270',\
ASC_Shading_StateChange_Cloudy => 'ASC_Shading_StateChange_Cloudy:knob,min:100,max:40000,angleArc:85,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:20,lineCap:round,',\
ASC_Shading_Min_OutsideTemperature => 'ASC_Shading_Min_OutsideTemperature:knob,min:5,max:30,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:0.5,lineCap:round,angleArc:120,angleOffset:270'}
attr rg_ASC_Rolllaeden_Shading room Rollladen</pre>
<br>
Anderes {{Link2Forum|Topic=99980|Message=946357|LinkText=Foren-Beispiel}} für eine RG zu Beschattung (für V. 0.6.x):
[[Bild:ReadingsGroup ASC shading2.png|thumb|right|ReadingsGroup - Beschattungsbeispiel]]
<pre style="width:65%;word-wrap: break-word;">
defmod rg_ASC_Shading readingsGroup <Gerät>,<Grad>,<Position>,<Mode>,<Links>,<Rechts>,<Wait>,<ShadeIn>,<ShadeOut>,<Elevation>,<Temperature>,<Device>\
(Rollo_.*|Jalousie.*):!?ASC_Shading_Direction,!?ASC_Shading_Pos,!?ASC_Shading_Mode,!?ASC_Shading_Angle_Left,!?ASC_Shading_Angle_Right,!?ASC_Shading_WaitingPeriod,!?ASC_Shading_StateChange_Sunny,!?ASC_Shading_StateChange_Cloudy,!?ASC_Shading_MinMax_Elevation,!?ASC_Shading_Min_OutsideTemperature,!?ASC_BrightnessSensor\

attr rg_ASC_Shading commands {ASC_Shading_Direction => 'ASC_Shading_Direction:129,255,309',\
ASC_Shading_Pos => 'ASC_Shading_Pos:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Mode => 'ASC_Shading_Mode:absent,always,off,home',\
ASC_Shading_Angle_Left => 'ASC_Shading_Angle_Left:selectnumbers,0,5,100,0,lin',\
ASC_Shading_Angle_Right => 'ASC_Shading_Angle_Right:selectnumbers,0,5,100,0,lin',\
ASC_Shading_WaitingPeriod => 'ASC_Shading_WaitingPeriod:selectnumbers,0,60,1200,0,lin',\
ASC_Shading_StateChange_Sunny => 'ASC_Shading_StateChange_Sunny:selectnumbers,0,20,1000,0,lin',\
ASC_Shading_StateChange_Cloudy => 'ASC_Shading_StateChange_Cloudy:selectnumbers,0,20,1000,0,lin',\
ASC_Shading_MinMax_Elevation =>\
'ASC_Shading_Min_Elevation:selectnumbers,0,1,40,0,lin' ,\
ASC_Shading_Min_OutsideTemperature =>\
'ASC_Shading_Min_OutsideTemperature:selectnumbers,0,1,30,0,lin'}
attr rg_ASC_Shading room Rollladen</pre>

=== readingsGroup für FIBARO Roller Shutter FGR-222 Devices ===
{{Randnotiz|RNTyp=g|RNText=Getestet von majestro84, Stand 2019-01-28.
* https://forum.fhem.de/index.php/topic,92628.msg897099.html#msg897099
* Die Farbgebung entspricht dem Standard, wenn unter dem Style f18 der Farbpreset ''dark'' gewählt wird}}

[[Bild:ASC Jalousien Times.JPG|thumb|right|Beispiel]]
<pre style="width:65%;word-break: break-all;word-wrap: break-word;">define ASC_Jalousien_Times readingsGroup <Gerät>,<Stand>,<Time_Up_Early>,<Time_Up_WE>,<Time_Up_Late>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up>,<PartyMode>,<LockOut> (.*_Jalousie.*):position,!?ASC_Time_Up_Early,!?ASC_Time_Up_WE_Holiday,!?ASC_Time_Up_Late,!?ASC_Time_Down_Early,!?ASC_Time_Down_Late,!?ASC_Mode_Down,!?ASC_Mode_Up,!?ASC_Partymode,!?ASC_LockOut

attr ASC_Jalousien_Times commands {position => 'dim:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off',
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off',
ASC_Partymode => 'ASC_Partymode:on,off',
ASC_LockOut => 'ASC_LockOut:soft,hard,off',
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00',
ASC_Time_Down_Late => 'ASC_Time_Down_Late:20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30',
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:45,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_Late =>'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00'}
attr ASC_Jalousien_Times room Jalousien</pre>

[[Bild:ASC Jalousien Level.JPG|thumb|right|Beispiel]]
<pre style="width:65%;word-break: break-all;word-wrap: break-word;"> define Jalousien_Level readingsGroup <Gerät>,<Closed_Pos>,<Open_Pos>,<Comfort_Pos>,<Ventilate_Pos>,<PrivacyDown_Pos>,<Shading_Pos> (.*_Jalousie.*):!?ASC_Closed_Pos,!?ASC_Open_Pos,!?ASC_ComfortOpen_Pos,!?ASC_Ventilate_Pos,!?ASC_PrivacyDown_Pos,!?ASC_Shading_Pos
attr Jalousien_Level commands { ASC_Closed_Pos => 'ASC_Closed_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Open_Pos => 'ASC_Open_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_ComfortOpen_Pos => 'ASC_ComfortOpen_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_PrivacyDown_Pos => 'ASC_PrivacyDown_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Shading_Pos => 'ASC_Shading_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99'}
attr Jalousien_Level room Jalousien</pre>

== Einrichtungsbeispiel ==
=== Zielsetzung und Vorgaben ===
Es sollen alle Rollläden und Jalousien in einem Haus innerhalb bestimmter zeitlicher Grenzen Morgens und Abends sonnenstandsabhängig gefahren werden, an den Wochenenden und an Ferientagen soll etwas später geöffnet werden. Es sind Tür- und Fensterkontakte vorhanden (Türkontakte: twoState, Fensterkontakte: threeState), wobei bei jeder Öffnung ein eventuell geschlossener Rollladen geöffnet werden soll. Bei allen Rollladenaktoren, Tür- und Fensterkontakten handelt es sich um CUL_HM-Geräte.

=== Vorarbeiten ===
Im global-Device sind Angaben zu latitude und longitude vorhanden, holiday2we wie folgt<ref>''ferien'' ist eine automatisiert erstellte holiday-Datei nach diesem {{Link2Forum|Topic=85759|Message=885883|LinkText=Foren-Beitrag}}.</ref>:
attr global holiday2we bw,ferien
Weitere Angaben benötigen wir zunächst nicht, die Festlegung eines Astro-Devices erfolgt hier erst im Rahmen der Beschattung.
Dann erfolgt das ''Define des ASC-Devices'' wie oben beschrieben:
<code>define Rollladenautomatik AutoShuttersControl</code>
Folgen die einzubindenden Rollladenaktoren einem einheitlichen Namensschema, können diese sodann z.B. mit
attr (Jalousie|Rollladen)_.* ASC 2
auf einen Rutsch mit dem passenden ASC-Typ gekennzeichnet werden. Dann verteilen wir mir
set Rollladenautomatik scanForShutters
die nachfolgend weiter zu bearbeitenden Attribute.
=== Schließen morgens und abends ===
{{Randnotiz|RNTyp=g|RNText=Alternative: Fahren nach brightness:
Will man insgesamt oder nur an einzelnen Rollläden stattdessen helligkeitsgesteuert fahren, muß für jeden Rollladen ein Helligkeitssensor definiert und entweder zentral oder am einzelnen Rollladen jeweils ein Höchst- bzw. Mindestwert festgelegt werden (''ASC_BrightnessMinVal'' etc.), bei dessen Überschreitung geöffnet bzw. Unterschreitung geschlossen werden soll.}}
==== Konfiguration des ASC-Devices ====
Da wir sonnenstandsabhängig Fahrzeiten wollen, legen wir erst einmal fest, dass dies morgens und abends berücksichtigt werden soll:
<pre>
attr Rollladenautomatik ASC_autoAstroModeEvening CIVIL
attr Rollladenautomatik ASC_autoAstroModeMorning CIVIL
attr Rollladenautomatik ASC_autoShuttersControlEvening on
attr Rollladenautomatik ASC_autoShuttersControlMorning on
</pre>
Aus der Angabe ''CIVIL'' und den Vorgaben in den einzelnen Rollladen wird dabei mit Hilfe von [[SUNRISE_EL]] die effektive Fahrzeit berechnet, dort finden sich auch weitere Hinweise, zu den meisten anderen Optionen für die ersten beiden Attribute.
Bei allen Fensteröffnungen soll auf eine Lüften-Position gefahren werden, also schalten wir diese Funktion ebenfalls zentral an<ref>Sonst wird bei threeState-Sensoren nur bei ''tilted'' auf die in ''ASC_Ventilate_Pos'' gefahren.</ref>:
attr Rollladenautomatik ASC_autoShuttersControlComfort on
Zuletzt legen wir noch einen Temperatur-Sensor fest. Dieser wird beim Frostschutz sowie bei der Beschattung berücksichtigt.
<pre>
attr Rollladenautomatik ASC_temperatureSensor Aussentemperatur_Nord
attr Rollladenautomatik ASC_temperatureReading temperature
attr Rollladenautomatik ASC_freezeTemp 3
</pre>

tbd:
* Rain
* Wind
==== Konfiguration der Rollladendevices ====
===== Fahrzeiten =====
Zur Konfiguration der Fahrzeiten bietet es sich an, eine ReadingsGroup zu nutzen, wie unter [[#Hilfsmittel|Hilfsmittel]] dargestellt. Alternativ kann man die Zeiten auch manuell in den einzelnen Rollläden hinterlegen.
===== Bewohner =====
Wird ein Raum von einer oder mehreren bestimmten Person/en bewohnt oder gibt es ein Sammel-Gerät für mehrere Bewohner, kann dies mit den Attributen ''ASC_Roommate_Device'' und ''ASC_Roommate_Reading'' einem Rollladen zugeordnet werden. Ist einer der Bewohner ''asleep'', wird morgens erst geöffnet, wenn auch der letzte Roommate nicht mehr ''asleep'' ist.
===== Fensterkontakte =====
Dann werden ggf. vorhandene Fensterkontakte mit ''ASC_WindowRec'' zugeordnet und der Sensortyp mit ''ASC_WindowRec_subType'' festgelegt. Im Falle von threeState-Sensoren wird das übergreifende ''ASC_autoShuttersControlComfort'' beachtet, wobei dann bei vollständiger Öffnung des Fensters auf den in ''ASC_ComfortOpen_Pos'' festgelegten Wert gefahren wird.
===== Frostschutz =====
Zuletzt können die Attribute ''ASC_Antifreeze'' und ''ASC_Antifreeze_Pos'' festgelegt werden, wenn die Frostschutzfunktion aktiviert werden soll.
=== Beschattung ===
==== Konfiguration des ASC-Devices ====
Benötigt werden Informationen zum Sonnenstand. Hierfür wird ein astro- oder twilight-Device benötigt. Ist ein solches definiert, wird dies - ggf. auch nach einem Neustart vom Modul automatisch erkannt und in das Attribut ''ASC_twilightDevice'' eingetragen. Wir legen daher zunächst ein entsprechendes Device an bzw. passen die Angabe ggf. an, wenn ein anderes als das eingetragene genutzt werden soll.
Weiter ist ein Temperatursensor für die Beschattung festzulegen (''ASC_temperatureSensor.*''-Attribute) wie bereits oben beschrieben.

==== Konfiguration der Rollladendevices ====
Zum einen legt man einen Helligkeitssensor fest (''ASC_Brightness_Sensor'' und ''ASC_Brightness_Reading''). Dieser ist der eigentliche Trigger. Nur, wenn sich der Brightness Wert ändert, werden Azimut, Elevation, Temperatur und die Ein- und Ausfallswinkel ausgelesen und/oder berechnet und basierend auf diesen Werten entschieden ob shading in oder shading out stattfinden soll, die Schwellwerte werden in ''ASC_Shading_StateChange_Sunny'' (Beschattung soll eingeschaltet werden) und ''ASC_Shading_StateChange_Cloudy'' (Beschattung soll beendet werden) festgelegt, wobei immer nur gefahren wird, wenn auch alles andere - insbesondere die Mindesthöhe des Sonnenstands (''ASC_Shading_Min_Elevation'') und die Mindesttemperatur ''ASC_Shading_Min_OutsideTemperature'' - passt.
Dann sind die Winkelangaben festzulegen, ggf. kann ein Kompass zu Hilfe genommen werden (''ASC_Shading_Direction'' ist die Richtung des Fensters, 90 Grad entspricht Ost, 180 Grad Süden, ''ASC_Shading_Angle_Left'' ist der Sonneneintritt ins Zimmer, wird von -Direction abgezogen, ''ASC_Shading_Angle_Right'' hat diesselbe Funktion für den Austrittswinkel.

=== Weitere Funktionen ===
==== Privacy ====
Werden hierfür Werte festgelegt, werden die betreffenden Rollläden die festgelegte Zeit vor dem abendlichen Schließen vorab teilweise geschlossen. Dies kann z.B. gewünscht sein, um Rollläden zur Straße hin mit viel Fußgängerverkehr zwar nicht vollständig abzudunkeln, aber gleichzeitig zu verhindern, dass von außen in Wohnräume geschaut werden kann, sobald dort das Licht angeschaltet wird
==== BlockingTime====
Bewirkt, dass nach einer manuellen Fahrt, eine vom ASC Modul initiierte Fahrt zunächst ausgesetzt wird, bis die im Attribute angegebene Zeit überschritten ist. Erst dann wird eine vom ASC Modul initiierte Fahrt tatsächlich durchgeführt.
Genau so wird ein Hochfahren eines Rollos durch das ASC Modul nicht mehr ausgeführt, wenn es innerhalb der Zeit von ASC_BlockingTime_beforNightClose und das Runterfahren wird nicht mehr erfolgen, wenn es innerhalb von ASC_BlockingTime_beforDayOpen ist.
Beispiel: Meine Tochter geht früh außer Haus und Ihre Rollos sind nicht hochgefahren. Diese fahren auch nicht mehr hoch, da die ausschließlich bei home (anwesend) fahren sollen. Nun kommt sie am Nachmittag um 16:23 Uhr nach Hause. Eigentlich sollten nun die Rollos fahren. Doch die Sonnenuntergangsfahrt (schließen) wäre schon 16:51 Uhr und damit innerhalb der 3600 ASC_BlockingTime_beforNightClose. Die Rollos bleiben also unten. Es lohnt sich für die paar Minuten einfach nicht mehr.

==== wiggle====
Mit einem <code>set <ASC-Device> wiggle</code> können alle Rollladen mit einem entsprechenden Attribut zu einer kurzen Fahrt veranlasst werden, nach Ablauf von einer Minute wieder um denselben Wert zurück. Dabei wird jeweils in die Richtung gefahren, die den weiteren Weg ermöglicht. Wenn also zu 70% geschlossen ist, wird der Rollladen hoch fahren.
==== Partymode ====
Dieser wird am ASC-Device selbst aktiviert mittels <code>set <ASC-Device> partyMode on</code>. Alle Rollladen-Devices, welche das Attribut ''ASC_Partymode'' auf ''on'' gestellt haben, werden nicht mehr gesteuert. Der letzte Schaltbefehl, der durch ein Fensterevent oder Bewohnerstatus an die Rollläden gesendet wurde, beim Beenden des Modus durch <code>set ASC-Device partyMode off</code> ausgeführt.
==== lock-out ====
(tbd auch hier: Doku ist etwas verteilt, könnte man im Wiki jeweils unter einem eigenen Unterabschnitt im Zusammenhang darstellen)

==== SelfDefense ====
Das bei einem absent nur da die Rollläden geschlossen werden wo das Fenster vergessen wurde zu schließen.
Beim wechsel in gone wird nur an den makierten Terassentüren (''ASC_ShuttersPlace terrace'') der Rollladen runter gefahren.
Weitere Attribute dazu: ''ASC_Self_Defense_Exclude''

== Sonstige Hinweise ==
* Werden Attribute geändert, kann es vereinzelt vorkommen, dass das ASC-Modul dies nicht mitbekommt und das tatsächliche Verhalten nicht den Erwartungen entspricht. In so einem Fall empfielt es sich, das NOTIFYDEV nochmals aufbauen zu lassen. Dazu werden zunächst mit <code>set <ASC-Modul> expert 1</code> erweiterte Informationen bezüglich des NotifyDevs unter set und get aktiviert und anschließend ein <code>set <ASC-Modul> createNewNotifyDev</code> ausgeführt.

== Weblinks ==
* {{Link2Forum|Topic=92628|LinkText="Thread zum Modul im Forum"}}
* {{Link2Forum|Topic=90751|LinkText="Thread zur Entwicklung im Forum"}}
* {{Link2Forum|Topic=73964|LinkText="Thread zu den Scripten von user cluni"}}, die der Entwicklung des Moduls zugrunde liegen

<references />

[[Kategorie:Code Snippets]]
[[Kategorie:Rollladensteuerung]]

EnOcean-SIN-2-RS-01-Rollladenmodul

2019-05-30T14:43:57Z

50watt: Initiale Version

{{Infobox Hardware
|Bild=SIN-2-RS-01 Rollladenmodul.jpg
|Bildbeschreibung=SIN-2-RS-01-Rollladenmodul mit AAA-Batterie zum Größenvergleich
|HWProtocol=EnOcean
|HWType=Aktor, Empfänger, Sender, Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=1 (bidirektional)
|HWVoltage=230V~
|HWPowerConsumption=Eigenverbrauch <1W
|HWPoweredBy=230V
|HWSize=40x44x16.9mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Nodon
}}

'''EnOcean-SIN-2-RS-01-Rollladenmodul''' ist ein Aktor
* für
** Unterputzmontage
* für die
** Steuerung von Rollladen- und Beschattungselementen
== Features ==
Aktor für Beschattungselemente und Rollladen

== Hinweise zum Betrieb mit FHEM ==
=== Definition/Anlernvorgang ===
UTE-Teach-In:
#FHEM in Lernmodus schalten: <code>set <nowiki><IODev> teach 600</nowiki></code>
#Taster am SIN-2-RS-01 dreimal drücken
#SIN-2-RS-01 wird in FHEM automatisch mit allen notwendigen Parametern angelegt.

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der [[Konfiguration|fhem.cfg]]:
defmod EnO_05100000 EnOcean 05100000 ## automatisch von FHEM erzeugt
attr EnO_05100000 IODev synoTCM ## automatisch von FHEM erzeugt
attr EnO_05100000 alias Rollladen Küche
attr EnO_05100000 comMode biDir ## automatisch von FHEM erzeugt
attr EnO_05100000 comment Nodon SIN-2-RS-01 Rollladenmodul in der Küche (rechts oben neben dem Fenster)
attr EnO_05100000 devChannel 1 ## automatisch von FHEM erzeugt
attr EnO_05100000 devStateIcon closed:fts_shutter_100@green:opens open:fts_window_2w:closes open_ack:fts_window_2w@green:closes 25:fts_shutter_30 50:fts_shutter_50 75:fts_shutter_70 down:fts_shutter_down@red:stop up:fts_shutter_up@yellow:stop
attr EnO_05100000 eep D2-05-00 ## automatisch von FHEM erzeugt
attr EnO_05100000 eventMap /opens:AUF/closes:ZU/ ## übersetzt "opens" und "closes" zu "AUF" und "ZU"
attr EnO_05100000 group Rollladen
attr EnO_05100000 icon fts_shutter_updown
attr EnO_05100000 manufID 046 ## automatisch von FHEM erzeugt
attr EnO_05100000 room EnOcean,Küche
attr EnO_05100000 shutTime 26 ## Zeit in Sekunden, die der Rolladen von ganz geschlossen bis ganz offen braucht. Dient der ermittlung der aktuellen Position des Rollladens
attr EnO_05100000 shutTimeCloses 28 ## Zeit in Sekunden, um sicher von einer Endposition zur anderen zu gelangen. Danach wird bei "opens" und "closes" gestoppt
attr EnO_05100000 subDef FFFB0000 ## automatisch von FHEM erzeugt
attr EnO_05100000 subType blindsCtrl.00 ## automatisch von FHEM erzeugt
attr EnO_05100000 teachMethod UTE ## automatisch von FHEM erzeugt
attr EnO_05100000 webCmd AUF:stop:ZU:position ## erzeugt im Webfrontend deutsche Schaltflächen für "AUF" und "ZU"

[[Datei:SIN-2-RS-01 im webfrontend.jpg|mini|SIN-2-RS-01 im Webfrontend]]

== Links ==
* Anleitung: [https://www.enocean-alliance.org/wp-content/uploads/2018/04/NodOn-SIN-2-RS-01-UserGuide-DE-180419-interactive.pdf PDF]

[[Kategorie:EnOcean Components]]
[[Kategorie:Rollladensteuerung]]

Datei:SIN-2-RS-01 im webfrontend.jpg

2019-05-30T14:37:43Z

50watt: Nodon SIN-2-RS-01 im Webfrontend

== Beschreibung ==
Nodon SIN-2-RS-01 im Webfrontend

EnOcean-SIN-2-RS-01-Rollladenmodul

2019-05-30T14:01:54Z

50watt:

Datei:SIN-2-RS-01 Rollladenmodul.jpg

2019-05-30T14:00:14Z

50watt: SIN-2-RS-01 Rollladenmodul von Nodon, mit AAA Batterie zum Größenvergleich

== Beschreibung ==
SIN-2-RS-01 Rollladenmodul von Nodon, mit AAA Batterie zum Größenvergleich

EnOcean-SIN-2-RS-01-Rollladenmodul

2019-05-30T13:58:43Z

50watt: work in progress

{{Infobox Hardware
|Bild=SIN-2-RS-01-Rollladenmodul.jpg
|Bildbeschreibung=SIN-2-RS-01-Rollladenmodul mit AAA-Batterie zum Größenvergleich
|HWProtocol=EnOcean
|HWType=Aktor, Empfänger, Sender, Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=1 (bidirektional)
|HWVoltage=230V~
|HWPowerConsumption=Eigenverbrauch ca. 0,7W - 0,9W
|HWPoweredBy=230V
|HWSize=40x44x16.9mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Nodon
}}

'''EnOcean-SIN-2-RS-01-Rollladenmodul''' ist ein Aktor
* für
** Unterputzmontage
* für die
** Steuerung von Rollladen- und Beschattungselementen
== Features ==
Aktor für Beschattungselemente und Rollladen

AutoShuttersControl

2019-05-01T11:11:13Z

50watt: /* Zielsetzung und Vorgaben */ Tippfehler

{{Baustelle}}
{{Infobox Modul
|ModPurpose=Steuerung von Rollläden
|ModCategory=Automatisierung
|ModType=d
|ModForumArea=Automatisierung
|ModTechName=73_AutoShuttersControl.pm
|ModOwner=CoolTux ({{Link2FU|13684|Forum}}/[[Benutzer Diskussion:CoolTux|Wiki]])}}

Mit [[AutoShuttersControl]] oder kurz ASC können typische Aufgabenstellungen im Zusammenhang mit Rollläden u.ä. automatisiert werden, wie zum Beispiel das Öffnen bei Sonnenaufgang, Schließen bei Sonnenuntergang oder das Anfahren von Lüftungspositionen beim Öffnen des zugehörigen Fensters.

== Basics ==
{{Hinweis|Das Modul befindet sich derzeit noch in der Entwicklung; der jeweils aktuelle Stand ist diesem {{Link2Forum|Topic=90751|LinkText="Thread im Forum"}} zu entnehmen.}}
Zur Nutzung des Moduls sollten folgende andere FHEM-Devices vorhanden sein:
* Rollläden
* Fensterkontakte und
* Bewohnerstatus auf Basis von Residents/Roomates in englisch. Ersatzweise andere Devices, z.B. Dummys, welche als ''state'' ''home'', ''asleep'', ''gotosleep'' und ''awoken'' setzen sowie ein Reading ''lastState''.
* Optional:
** Ein Helligkeitssensor (Steuerung nach Helligkeit und Beschattung)
** Ein Device zur Bestimmung des Sonnenstands (nur für Beschattungf). Unterstützt werden derzeit [[Modul Astro|Astro]] und [[Twilight]]<ref>Dabei müssen ggf. in [[Global|global]] auch Angaben zu ''longitude'' und ''latitude'' vorhanden sein</ref>.
** Wenn Feiertage berücksichtigt werden sollen: Ein oder mehrere {{Link2CmdRef|Anker=holiday2we|Lang=en|Label=holiday2we}}-Angaben in [[Global|global]] samt entsprechender [[Wochenende, Feiertage und Schulferien#Feiertage mittels holiday-Datei|holiday]]-Dateien<ref>Es kann auch z.B. ein Dummy-Device verwendet werden, dieses sollte dann aber neben dem eigentlichen Feiertags-''state'' auch in einem Reading ''tomorrow'' Angaben zu anstehenden Feiertagen enthalten.</ref> <ref>Bitte verfahren Sie entsprechend, wenn Urlaubs- oder Ferientage wie Feiertage behandelt werden sollen.</ref>.

Die Einrichtung des Moduls bzw. dessen Funktionalität erfolgt in mehreren Schritten:
* Definition des ASC-Devices
* Einstellung zentraler Vorgaben am ASC-Device
* Markieren der zukünftig zu steuernden Rollladen-Devices
* Einbinden der Rollladen-Devices in das ASC-Device
* Einstellen der individuellen Vorgaben je Rollladen (am Rollladen-Device)
Dabei geht man am einfachsten schrittweise vor und erweitert die Funktionalität nach und nach um die gewünschten Funktionen. Dann benötigt man jeweils nur einen kleinen Teil der vielen per Attribut einstellbaren Optionen, und kann die Auswirkungen der jeweiligen Änderung besser nachvollziehen.

== Einrichtung ==
{{Hinweis|ASC kann auch verwendet werden, um lediglich Teilaufgaben der Rollladensteuerung zu erfüllen, also z.B. nur das morgendliche Öffnen der Rollläden. Allerdings geht dabei ein erheblicher Teil des Komforts verloren, der dadurch entsteht, dass die Steuerung innerhalb der vollintegrierten Lösung jeweils nachvollzieht, aus welchem Grund eine Fahrt erfolgt war und dies ggf. bei der nächsten Aktion berücksichtigt.}}

=== Vorbereitung ===
Zunächst sollten die in den [[#Basics|Basics]] beschriebenen Geräte vorhanden und funktionsfähig sein.

=== Define des ASC-Devices ===
Es genügt ein einfaches define ohne weitere Parameter.
<code>define <name> AutoShuttersControl</code>
Dies bewirkt neben der Anlage des Devices selbst auch, dass als weiteres globales Attribut ''ASC'' verfügbar wird.

=== Einstellung zentraler Vorgaben ===
Es stehen am ASC-Device einige Attribute zur Verfügung, über die sich das Verhalten des ASC-Devices insgesamt steuern lässt, z.B. zur Vermeidung von morgendlichen oder abendlichen Fahrten sowie bei Gefahr von Schäden an den Rollläden durch Frost oder zur Reaktion auf Fensterkontakte. Details sind der Commandref zu entnehmen.
Diese Attribute können auch nachträglich noch geändert werden.

=== Markieren zu steuernder Rollladen-Devices ===
Um einen oder mehrere Rollläden durch das ASC-Device zu steuern, wird für jeden Rollladen jeweils das neue globale Attribut ''ASC'' gesetzt. Der Wert ist mit 1 oder 2 festzulegen, wobei '''1''' bedeutet, dass
* die Offen-Position kleiner ist als die Geschlossen-Position, also typischerweise 0 ''offen'' bedeutet und 100 für ''geschlossen'' steht
* eine bestimmte Position mit '''position''' angefahren wird, also z.B. <code>set <name> position 70</code>.
Dies ist z.B. die passende Wahl für ROLLO-Devices

Die '''2''' steht für ein umgekehrtes Verhalten und den Befehlsteil ''pct'', also ''offen'' für <code>set <name> pct 100</code>. Typischer Vertreter dieses Typs sind HomeMatic (CUL_HM-) Geräte oder die Shelly2-Aktoren.

=== Einbinden in das ASC-Device ===
Nachdem man das obige Attribut bei einem oder mehreren Rollladen-Devices gesetzt hat, kann mit
<code>set <name> scanForShutters</code> ein Suchlauf gestartet werden, mit dem dann diese Rollläden durch das Modul gefunden und in die Steuerungslogik eingebunden werden.

=== Einstellen der individuellen Vorgaben ===
Nach der Einbindung sind an den Rollladen-Devices weitere Attribute verfügbar, mit denen die für den jeweiligen Rollladen geltenden Einstellungen vorgenommen werden können.
Die Beschreibung der Attribute ist in der commandref enthalten.

== Readings ==

===Readings im ASC-Device selbst ===

{|class="wikitable"
|-
! Name !! Datentyp/<BR/>Wertebereich !! Bedeutung
|-
|..._nextAstroTimeEvent || ||Uhrzeit des nächsten Astro-Events, Sonnenauf- oder Sonnenuntergang oder feste Zeit pro Rollonamen
|-
|..._lastPosValue || ||zuletzt abgesetzter Fahrbefehl pro Rollonamen
|-
|..._lastDelayPosValue || ||zuletzt abgesetzter Fahrbefehl, welcher beim nächsten zulässigen Event ausgeführt wird
|-
|partyMode ||on, off || aktiviert den globalen Partymodus. Alle Rollläden, welche das Attribut ''AutoShuttersControl_Partymode'' bei sich auf ''on'' gestellt haben, werden nicht mehr gesteuert. Der letzte Schaltbefehl, welcher durch ein Fensterevent oder Bewohnerstatus an die Rollläden gesendet wurde, wird erst beim off-setzen (set <ASC-Device> partyMode off) ausgeführt
|-
|lockOut || on, off ||für das Aktivieren des Aussperrschutzes gemäß des entsprechenden Attributs ''AutoShuttersControl_lock-out'' im jeweiligen Rolladen (siehe Beschreibung bei den Attributen für die Rolladendevices)
|-
|room_... || ||Auflistung aller Rollläden, welche in den jeweiligen Räumen gefunden wurden, Bsp.: room_Schlafzimmer,Terrasse
|-
|state || ||Status des <ASC-Device> active, enabled, disabled
|-
|sunriseTimeWeHoliday|| on,off ||legt fest, ob das Rolladendevice das Attribut ''AutoShuttersControl_Time_Up_WE_Holiday'' beachtet oder nicht
|-
|userAttrList || rolled out ||Status der UserAttribute, welche an die Rollläden gesendet werden
|}

=== Readings in den Rolllädendevices ===

{|class="wikitable"
|-
! Name !! Bedeutung
|-
|ASC_Time_DriveUp ||Sonnenaufgangszeit für das Rollo
|-
|ASC_Time_DriveDown ||Sonnenuntergangszeit für das Rollo
|-
|ASC_ShuttersLastDrive ||Grund des letzten Fahrens vom Rolladen
|}

==set- und get-Befehle für das ASC-Device==

=== set-Anweisungen ===
{|class="wikitable"
|-
! Name !! Datentyp/<BR/>Wertebereich !! Beschreibung
|-
|partyMode ||on, off ||aktiviert den globalen Partymodus. Siehe Reading ''partyMode''
|-
|lockOut ||on, off ||aktiviert den globalen Aussperrschutz. Siehe Reading ''lockOut''
|-
|renewSetSunriseSunsetTimer || || erneuert bei allen Rollläden die Zeiten für Sunset und Sunrise und setzt die internen Timer neu.
|-
|scanForShutters || ||sucht alle FHEM Devices mit dem Attribut ''AutoShuttersControl'' ''1'' oder ''2''
|-
|sunriseTimeWeHoliday || on,off ||aktiviert/deaktiviert die Beachtung des Attributes ''AutoShuttersControl_Time_Up_WE_Holiday'' für Rollladen-Devices
|-
|createNewNotifyDev || ||Legt die interne Struktur für NOTIFYDEV neu an
|-
|selfDefence ||on, off||aktiviert/deaktiviert den Selbstschutz: wenn das Residents-Device ''absent'' meldet, ''selfDefence'' aktiv ist und ein Fenster im Haus noch offen steht, wird an diesem Fenster das Rollo runtergefahren
|-
|wiggle ||||bewegt einen Rollladen oder alle Rollläden (für Abschreckungszwecke bei der Alarmierung) um ''ASC_WiggleValue''-%, und nach 1 Minute wieder zurück zur Ursprungsposition
|-
|||||
|}

=== get-Anweisungen ===

{|class="wikitable"
|-
! Name !! Beschreibung
|-
| showShuttersInformations ||zeigt eine Übersicht der Automatik-Fahrzeiten
|-
| showNotifyDevsInformations ||zeigt eine Übersicht der abgelegten NOTIFYDEV Struktur. Dient zur Kontrolle
|}
== Attribute ==

===Attribute direkt am ASC-Device ===

{|class="wikitable"
|-
! Name !! Datentyp/<BR/>Wertebereich !! Default-Wert !! Beschreibung
|-
|ASC_antifreezeTemp || || ||Temperatur, ab welcher der Frostschutz greift und das Rollo nicht mehr fährt. Der letzte Fahrbefehl wird gespeichert
|-
|ASC_autoAstroModeEvening ||aktuell REAL, CIVIL, NAUTIC, ASTRONOMIC, HORIZON || || (in genau dieser Schreibweise)
|-
|ASC_autoAstroModeEveningHorizon || || || Höhe über Horizont, wenn beim Attribut ''AutoShuttersControl_autoAstroModeEvening'' ''HORIZON'' ausgewählt
|-
|ASC_autoAstroModeMorning ||aktuell REAL, CIVIL, NAUTIC, ASTRONOMIC, HORIZON || ||(in genau dieser Schreibweise)
|-
|ASC_autoAstroModeMorningHorizon || || ||Höhe über Horizont, wenn beim Attribut ''AutoShuttersControl_autoAstroModeMorning'' ''HORIZON'' ausgewählt
|-
|ASC_autoShuttersControlComfort ||on, off || ||aktiviert die Komfortfunktion. Bedeutet, dass ein Rollladen mit einem threestate (Drehgriff-) Sensor am Fenster beim Öffnen in die "Komfortposition" fährt. Diese wird beim Rollladendevice über das Attribut ''AutoShuttersControl_Pos_after_ComfortOpen'' eingestellt.
|-
|ASC_autoShuttersControlEvening ||on, off || ||ob Abends die Rollläden automatisch zeitgesteuert werden sollen
|-
|ASC_autoShuttersControlMorning ||on, off || ||ob Morgens die Rollläden automatisch zeitgesteuert werden sollen
|-
|ASC_temperatureReading || || ||Reading für die Außentemperatur
|-
|ASC_temperatureSensor || || ||Device für die Außentemperatur
|-
|ASC_timeUpHolidayDevice || || ||Device zur Urlaubserkennung oder Sonstiges / muss ''0'' oder ''1'' im Reading ''state'' beinhalten.
|-
|ASC_residentsDevice|| || ||Devicenamen des Residents-Device der obersten Ebene
|-
|ASC_residentsDeviceReading|| || ||Status Reading des Residents-Device der obersten Ebene
|-
|ASC_brightnessMinVal|| || ||minimaler Lichtwert, bei dem Schaltbedingungen noch geprüft werden sollen
|-
|ASC_brightnessMaxVal || || ||maximaler Lichtwert, bei dem Schaltbedingungen noch geprüft werden sollen
|-
|ASC_rainSensorDevice || || ||Device, welches bei Regen getriggert wird
|-
|ASC_rainSensorReading || || ||das ensprechende Reading zum Regendevice
|-
|ASC_rainSensorShuttersClosedPos || || ||Position in pct, welche der Rollladen bei Regen anfahren soll
|-
|ASC_shuttersDriveOffset || || ||maximale zufällige Verzögerung in Sekunden bei der Berechnung der Fahrzeiten, ''0'' bedeutet keine Verzögerung
|-
|ASC_twilightDevice || || ||Device, welches Informationen zum Sonnenstand liefert, wird unter anderem für die Beschattung verwendet.
|-
|ASC_expert || || ||bei ''1'' werden erweiterte Informationen bezüglich des NotifyDevs unter ''set'' und ''get'' angezeigt
|-
| || || ||
|-
| || || ||
|}

===Attribute in den Rolllädendevices===

{|class="wikitable"
|-
! Name !! Datentyp/<BR/>Wertebereich !! Default-Wert !! Beschreibung
|-
|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'', bei ''hard/am/pm'' wird gar nicht oder innerhalb der entsprechenden Tageszeit nicht gefahren
|-
|ASC_Antifreeze_Pos || || ||Position, die angefahren werden soll, wenn der Fahrbefehl komplett schließen lautet, aber der Frostschutz aktiv ist
|-
|ASC_AutoAstroModeEvening ||REAL, CIVIL, NAUTIC, ASTRONOMIC, HORIZON || ||aktuell REAL,CIVIL,NAUTIC,ASTRONOMIC
|-
|ASC_AutoAstroModeEveningHorizon || || ||Höhe über Horizont, wenn beim Attribut ''ASC_autoAstroModeEvening'' ''HORIZON'' ausgewählt ist
|-
|ASC_AutoAstroModeMorning ||REAL, CIVIL, NAUTIC, ASTRONOMIC, HORIZON || ||aktuell REAL,CIVIL,NAUTIC,ASTRONOMIC
|-
|ASC_AutoAstroModeMorningHorizon || || ||Höhe über Horizont, wenn beim Attribut ''ASC_autoAstroModeMorning'' ''HORIZON'' ausgewählt ist
|-
|ASC_Closed_Pos || || ||in 10er Schritten von 0 bis 100,default Vorgabe 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_brightnessMinVal'' erreicht wurde. Wenn ja, wird der Rolladen runter gefahren
|-
|ASC_Mode_Down ||always, home, absent, off || ||wann darf die Automatik herunterfahren. immer, niemals oder bei Abwesenheit des Roommate (ist kein Roommate und ''absent'' eingestellt, wird gar nicht gesteuert)
|-
|ASC_Mode_Up ||always, home, absent, off || ||wann darf die Automatik hochfahren. immer, niemals oder bei Abwesenheit des Roommate (ist kein Roommate und ''absent'' eingestellt, wird gar nicht gesteuert)
|-
|ASC_Drive_Offset || || ||maximale zufällige Verzögerung in Sekunden bei der Berechnung der Fahrzeiten, ''0'' bedeutet sofort, ''-1'' bedeutet, dass das gleichwertige Attribut aus dem ASC-Device ausgewertet werden soll
|-
|ASC_Open_Pos || || ||in 10er-Schritten von 0 bis 100, default Vorgabe ist abhängig vom Attribut ''ASC''
|-
|ASC_Partymode || on, off || ||schaltet den Partymodus an oder aus. Wird dann am ASC Device ''set <ASC-DEVICE> partyMode on'' geschaltet, werden alle Fahrbefehle an den Rollläden, welche das Attribut auf ''on'' haben, zwischengespeichert und erst später ausgeführt
|-
|ASC_Pos_Reading || || ||Name des Readings, welches die Position des Rollladen in Prozent angibt. Wird bei unbekannten Device-Typen auch als ''set'' Befehl zum Fahren verwendet
|-
|ASC_Pos_after_ComfortOpen || || ||in 10er-Schritten von 0 bis 100, default Vorgabe ist abhängig vom Attribut ''ASC''
|-
|ASC_Roommate_Reading || || ||Reading des Roommate-Device, welches den Status wieder gibt
|-
|ASC_Roommate_Device || || ||mit Komma getrennte Namen des/der Roommate-Device/s welche den/die Bewohner des Rollladen-Raumes wiedergibt. Macht nur Sinn in Schlaf- oder Kinderzimmern
|-
|ASC_Time_Down_Early || || ||Sunset früheste Zeit zum Runterfahren
|-
|ASC_Time_Down_Late || || ||Sunset späteste Zeit zum Runterfahren
|-
|ASC_Time_Up_Early || || ||Sunrise früheste Zeit zum Hochfahren
|-
|ASC_Time_Up_Late || || ||Sunrise späteste Zeit zum Hochfahren
|-
|ASC_Time_Up_WE_Holiday || || ||Sunrise früheste Zeit zum Hochfahren am Wochenende und/oder Urlaub (holiday2we wird beachtet).
|-
|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'' müssen ''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 ''ASC_brightnessMinVal'' erreicht wurde. Wenn ja, wird der Rolladen runter gefahren
|-
|ASC_Ventilate_Pos || || ||in 10er-Schritten von 0 bis 100, default Vorgabe 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
|-
|ASC_WindowRec || || ||Name des Fensterkontakts, an welchen Fenster der Rollladen angebracht ist. Sein Reading ''state'' muss die Werte ''open'', ''closed'' oder ''tilted'' enthalten.
|-
|ASC_WindowRec_subType || || ||Typ des verwendeten Fensterkontakts: ''twostate'' (optisch oder magnetisch) oder ''threestate'' (Drehgriffkontakt)
|-
|ASC_lock-out || soft, hard || ||stellt entsprechend den Aussperrschutz ein. Bei global aktiven Aussperrschutz (''set ASC-Device lockOut soft'') und einem Fensterkontakt ''open'' bleibt dann der Rolladen oben. Dies gilt nur bei Steuerbefehle ü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.
|-
|ASC_lock-outCmd || inhibit, blocked || ||set Befehl für das Rolladen-Device zum Sperren per Hardware. Der Befehl wird verwendet, wenn ''ASC_lock-out'' auf ''hard'' gesetzt ist
|-
|ASC_Self_Defense_Exclude || on, off || ||bei ''on'' wird dieser Rolladen bei aktiven ''selfDefence'' und offenen Fenster nicht runter gefahren, wenn Residents absent ist
|-
|ASC_Shading_Brightness_Sensor || || ||Sensor-Device, welches für die Lichtwerte verwendet wird. ACHTUNG! Findet auch Verwendung bei ASC_Down - brightness
|-
|ASC_BrightnessMinVal || || ||minimaler Lichtwert, bei dem Schaltbedingungen noch geprüft werden sollen / wird der Wert von ''-1'' nicht geändert, so wird automatisch der Wert aus dem Moduldevice genommen
|-
|ASC_BrightnessMaxVal || || ||maximaler Lichtwert, bei dem Schaltbedingungen noch geprüft werden sollen / wird der Wert von ''-1'' nicht geändert, so wird automatisch der Wert aus dem Moduldevice genommen
|-
|ASC_ShuttersPlace || window, terrace || ||wenn dieses Attribut auf ''terrace'' gesetzt ist und das Residents-Device in den Status ''gone'' geht und ''selfDefence'' aktiv ist, wird das Rollo geschlossen
|-
|ASC_WiggleValue || || ||Wert, um welchen sich die Position des Rollladens bei ''Wiggle'' ändern soll
|-
|ASC_BlockingTime_afterManual || || ||Wartezeit in Sekunden, die die Automatik nach einer manuellen Fahrt aussetzen soll
|-
|ASC_BlockingTime_beforNightClose || || ||Vorgabezeit in Sekunden, innerhalb derer vor dem nächtlichen Schließen keine Öffnen-Fahrt mehr ausgeführt werden soll
|-
|ASC_BlockingTime_beforDayOpen || || ||Vorgabezeit in Sekunden, innerhalb derer vor dem morgendlichen Öffnen keine Schließen-Fahrt mehr ausgeführt werden soll
|-
|ASC_Shading_Direction || || ||Position in Grad, auf der das Fenster liegt - genau Osten wäre 90, Süden 180 und Westen 270
|-
|ASC_Shading_Pos || || ||Position des Rollladens für die Beschattung
|-
|ASC_Shading_Angle_Left || || ||Vorlaufwinkel im Bezug zum Fenster, ab wann abgeschattet wird. Beispiel: Fenster 180° - 85° ==> ab Sonnenpos. 95° wird abgeschattet
|-
|ASC_Shading_Angle_Right || || ||Nachlaufwinkel im Bezug zum Fenster, bis wann abgeschattet wird. Beispiel: Fenster 180° + 85° ==> bis Sonnenpos. 265° wird abgeschattet
|-
|ASC_Shading_Mode || || ||absent,always,off,home / Vorgabe, wann Beschattungsaktionen durchzuführen sind
|-
|ASC_Shading_StateChange_Sunny || || ||Brightness Wert ab welchen Beschattung statt finden soll, immer in Abhängikkeit der anderen einbezogenden Sensorwerte
|-
|ASC_Shading_StateChange_Cloudy || || ||Brightness Wert ab welchen die Beschattung aufgehoben werden soll, immer in Abhängikkeit der anderen einbezogenden Sensorwerte
|-
|ASC_Shading_Min_Elevation || || ||ab welcher Höhe des Sonnenstandes soll beschattet werden, immer in Abhängikkeit der anderen einbezogenden Sensorwerte
|-
|ASC_Shading_Min_OutsideTemperature || || ||ab welcher Temperatur soll Beschattet werden, immer in Abhängikkeit der anderen einbezogenden Sensorwerte
|-
|ASC_Shading_WaitingPeriod || || ||wie viele Sekunden soll gewartet werden bevor eine weitere Auswertung der Sensordaten für die Beschattung statt finden soll
|-
|ASC_PrivacyDownTime_beforNightClose || || ||wie viele Sekunden vor dem abendlichen schlie&zlig;en soll der Rollladen in die Sichtschutzposition fahren, -1 bedeutet das diese Funktion unbeachtet bleiben soll
|-
|ASC_PrivacyDown_Pos || || ||Position den Rollladens für den Sichtschutz
|-
| || || ||
| || || ||
|-
| || || ||
|-
| || || ||
|-
| || || ||
|}

== Hilfsmittel ==
{{Hinweis|Die Device-Namen sind auf die eigene Installation anzupassen.}}

=== Interne Übersicht ===

define ASC_Jalousie_Info weblink htmlCode {AutoShuttersControl::GetShuttersInformation($defs{'JalousieControl'})}

[[Datei:ASC Overview.JPG|600px|]]

=== readingsGroup für Level ===

{{Randnotiz|RNTyp=g|RNText=Erfolgreich getestet mit Homematic Devices, Stand 2019-01-28 no_Legend}}

{{Hinweis|Codezeilen wurden aus der Config Datei kopiert.}}

[[Datei:RG AutoShuttersControl Homematic.png|600px|]]

<pre> define rg_ASC_Rollaeden_Level readingsGroup <Gerät>,<ASC>,<Antifreeze>,<Antifreeze_Pos>,<Closed_Pos>,<Open_Pos>,<ASC_Ventilate_Pos> \
(.*Rollladen.*|.*Rollladen|Jalousie_.*):?ASC,?ASC_Antifreeze,?ASC_Antifreeze_Pos,?ASC_Closed_Pos,?ASC_Open_Pos,?ASC_Ventilate_Pos
setuuid rg_ASC_Rollaeden_Level 5c4308e1-f33f-abd1-167d-cc1b5f137cf793c8
attr rg_ASC_Rollaeden_Level commands {ASC => 'ASC:0,1,2',\
ASC_Antifreeze => 'ASC_Antifreeze:off,soft,hard,am,pm',\
ASC_Antifreeze_Pos =>'ASC_Antifreeze_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100', \
ASC_Closed_Pos => 'ASC_Closed_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100', \
ASC_Open_Pos => 'ASC_Open_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100', \
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100'}
attr rg_ASC_Rollaeden_Level room 9.72_Rolladen</pre>

=== readingsGroup für Zeiten ===
<pre> define rg_ASC_Rollaeden_Times readingsGroup <Gerät>,<Position>,<Time_Up_Early>,<Time_Up_Late>,<Time_Up_WE/Hol>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up> \
(.*Rollladen.*|.*Rollladen|Jalousie_.*):level,?ASC_Time_Up_Early,?ASC_Time_Up_Late,?ASC_Time_Up_WE_Holiday,?ASC_Time_Down_Early,?ASC_Time_Down_Late,?ASC_Mode_Down,?ASC_Mode_Up
setuuid rg_ASC_Rollaeden_Times 5c4308e1-f33f-abd1-94a7-fbf717635760f863
attr rg_ASC_Rollaeden_Times commands {level => 'pct:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,100', \
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00', \
ASC_Time_Down_Late => 'ASC_Time_Down_Late:19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30', \
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',\
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:45,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Time_Up_Late => 'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00', \
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off', \
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off' }
attr rg_ASC_Rollaeden_Times room 9.72_Rolladen</pre>

=== readingsGroup für das Einstellen der Beschattungs-Attribute ===
[[Datei:ReadingsGroup ASC shading.png|350px|thumb|right|Beispiel]]
<pre>
defmod rg_ASC_Rolllaeden_Shading readingsGroup <Gerät>,<Modus>,<Position>,<Richtung>,<°links>,<°rechts>,<Min Elevation>,<Min Temp> (Rollladen|Jalousie)_.*..:?ASC_Shading_Mode,?ASC_Shading_Pos,?ASC_Shading_Direction,?ASC_Shading_Angle_Left,?ASC_Shading_Angle_Right,?ASC_Shading_Min_Elevation,?ASC_Shading_Min_OutsideTemperature
attr rg_ASC_Rolllaeden_Shading alias Rollläden: Beschattung
attr rg_ASC_Rolllaeden_Shading commands {ASC_Shading_Pos => 'ASC_Shading_Pos:knob,min:0,max:100,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round',\
ASC_Shading_Mode => 'ASC_Shading_Mode:always,home,absent,off',\
ASC_Shading_Direction => 'ASC_Shading_Direction:knob,min:0,max:360,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:1,cursor:true,lineCap:round',\
ASC_Shading_Angle_Left => 'ASC_Shading_Angle_Left:knob,min:0,max:85,angleArc:85,rotation:anticlockwise,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round,angleOffset:270',\
ASC_Shading_Angle_Right => 'ASC_Shading_Angle_Right:knob,min:0,max:85,angleArc:85,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:5,lineCap:round,',\
ASC_Shading_Min_Elevation => 'ASC_Shading_Min_Elevation:knob,min:15,max:35,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:1,lineCap:round,angleArc:20,angleOffset:55,rotation:anticlockwise',\
ASC_Shading_Min_OutsideTemperature => 'ASC_Shading_Min_OutsideTemperature:knob,min:5,max:25,width:50,height:50,fgColor:#FF9900,bgColor:#CCCCCC,step:0.5,lineCap:round,angleArc:120,angleOffset:270'}
attr rg_ASC_Rolllaeden_Shading room Steuerung->Rollladen
</pre>
Hinweis: Die Farbgebung entspricht dem Standard, wenn unter dem Style f18 der Farbpreset ''dark'' gewählt wird.
=== readingsGroup für FIBARO Roller Shutter FGR-222 Devices ===
{{Randnotiz|RNTyp=g|RNText=Getestet von majestro84 https://forum.fhem.de/index.php/topic,92628.msg897099.html#msg897099; Stand 2019-01-28.}}
[[Datei:ASC Jalousien Level.JPG|600px|]]

[[Datei:ASC Jalousien Times.JPG|600px|]]

<pre> define ASC_Jalousien_Times readingsGroup <Gerät>,<Stand>,<Time_Up_Early>,<Time_Up_WE>,<Time_Up_Late>,<Time_Down_Early>,<Time_Down_Late>,<Mode_Down>,<Mode_Up>,<PartyMode>,<LockOut> (.*_Jalousie.*):position,?ASC_Time_Up_Early,?ASC_Time_Up_WE_Holiday,?ASC_Time_Up_Late,?ASC_Time_Down_Early,?ASC_Time_Down_Late,?ASC_Mode_Down,?ASC_Mode_Up,?ASC_Partymode,?ASC_LockOut
attr ASC_Jalousien_Times commands {position => 'dim:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Mode_Down => 'ASC_Mode_Down:always,absent,off',
ASC_Mode_Up => 'ASC_Mode_Up:always,absent,off',
ASC_Partymode => 'ASC_Partymode:on,off',
ASC_LockOut => 'ASC_LockOut:soft,hard,off',
ASC_Time_Down_Early => 'ASC_Time_Down_Early:15:00,15:15,15:30,15:45,16:00,16:15,16:30,16:45,17:00,17:15,17:30,17:45,18:00,18:15,18:30,18:45,19:00,19:15,19:30,19:45,20:00,20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00',
ASC_Time_Down_Late => 'ASC_Time_Down_Late:20:15,20:30,20:45,21:00,21:15,21:30,21:45,22:00,22:15,22:30,22:45,23:00,23:15,23:30',
ASC_Time_Up_Early => 'ASC_Time_Up_Early:05:00,05:05,05:30,05:45,06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_Late =>'ASC_Time_Up_Late:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00',
ASC_Time_Up_WE_Holiday => 'ASC_Time_Up_WE_Holiday:06:00,06:15,06:30,06:45,07:00,07:15,07:30,07:45,08:00,08:15,08:30,08:45,09:00,09:15,09:30,09:45,10:00'}
attr ASC_Jalousien_Times room Jalousien</pre>

<pre> define Jalousien_Level readingsGroup <Gerät>,<Closed_Pos>,<Open_Pos>,<Comfort_Pos>,<Ventilate_Pos>,<PrivacyDown_Pos>,<Shading_Pos> (.*_Jalousie.*):?ASC_Closed_Pos,?ASC_Open_Pos,?ASC_ComfortOpen_Pos,?ASC_Ventilate_Pos,?ASC_PrivacyDown_Pos,?ASC_Shading_Pos
attr Jalousien_Level commands { ASC_Closed_Pos => 'ASC_Closed_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Open_Pos => 'ASC_Open_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_ComfortOpen_Pos => 'ASC_ComfortOpen_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Ventilate_Pos => 'ASC_Ventilate_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_PrivacyDown_Pos => 'ASC_PrivacyDown_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99',
ASC_Shading_Pos => 'ASC_Shading_Pos:0,10,20,30,35,40,45,50,55,60,65,70,75,80,85,90,95,99'}
attr Jalousien_Level room Jalousien</pre>

== Einrichtungsbeispiel ==
=== Zielsetzung und Vorgaben ===
Es sollen alle Rollläden und Jalousien in einem Haus innerhalb bestimmter zeitlicher Grenzen Morgens und Abends sonnenstandsabhängig gefahren werden, an den Wochenenden und an Ferientagen soll etwas später geöffnet werden. Es sind Tür- und Fensterkontakte vorhanden (Türkontakte: twoState, Fensterkontakte: threeState), wobei bei jeder Öffnung ein eventuell geschlossener Rollladen geöffnet werden soll. Bei allen Rollladenaktoren, Tür- und Fensterkontakten handelt es sich um CUL_HM-Geräte.

=== Vorarbeiten ===
Im global-Device sind Angaben zu latitude und longitude vorhanden, holiday2we wie folgt<ref>''ferien'' ist eine automatisiert erstellte holiday-Datei nach diesem {{Link2Forum|Topic=85759|Message=885883|LinkText=Foren-Beitrag}}.</ref>:
attr global holiday2we bw,ferien
Weitere Angaben benötigen wir zunächst nicht, die Festlegung eines Astro-Devices erfolgt hier erst im Rahmen der Beschattung.
Dann erfolgt das ''Define des ASC-Devices'' wie oben beschrieben:
<code>define Rollladenautomatik AutoShuttersControl</code>
Folgen die einzubindenden Rollladenaktoren einem einheitlichen Namensschema, können diese sodann z.B. mit
attr (Jalousie|Rollladen)_.* ASC 2
auf einen Rutsch mit dem passenden ASC-Typ gekennzeichnet werden. Dann verteilen wir mir
set Rollladenautomatik scanForShutters
die nachfolgend weiter zu bearbeitenden Attribute.
=== Schließen morgens und abends ===
{{Randnotiz|RNTyp=g|RNText=Alternative: Fahren nach brightness:
Will man insgesamt oder nur an einzelnen Rollläden stattdessen helligkeitsgesteuert fahren, muß für jeden Rollladen ein Helligkeitssensor definiert und entweder zentral oder am einzelnen Rollladen jeweils ein Höchst- bzw. Mindestwert festgelegt werden (''ASC_BrightnessMinVal'' etc.), bei dessen Überschreitung geöffnet bzw. Unterschreitung geschlossen werden soll.}}
==== Konfiguration des ASC-Devices ====
Da wir sonnenstandsabhängig Fahrzeiten wollen, legen wir erst einmal fest, dass dies morgens und abends berücksichtigt werden soll:
<pre>
attr Rollladenautomatik ASC_autoAstroModeEvening CIVIL
attr Rollladenautomatik ASC_autoAstroModeMorning CIVIL
attr Rollladenautomatik ASC_autoShuttersControlEvening on
attr Rollladenautomatik ASC_autoShuttersControlMorning on
</pre>
Aus der Angabe ''CIVIL'' und den Vorgaben in den einzelnen Rollladen wird dabei mit Hilfe von [[SUNRISE_EL]] die effektive Fahrzeit berechnet, dort finden sich auch weitere Hinweise, zu den meisten anderen Optionen für die ersten beiden Attribute.
Bei allen Fensteröffnungen soll auf eine Lüften-Position gefahren werden, also schalten wir diese Funktion ebenfalls zentral an<ref>Sonst wird bei threeState-Sensoren nur bei ''tilted'' auf die in ''ASC_Ventilate_Pos'' gefahren.</ref>:
attr Rollladenautomatik ASC_autoShuttersControlComfort on
Zuletzt legen wir noch einen Temperatur-Sensor fest. Dieser wird beim Frostschutz sowie bei der Beschattung berücksichtigt.
<pre>
attr Rollladenautomatik ASC_temperatureSensor Aussentemperatur_Nord
attr Rollladenautomatik ASC_temperatureReading temperature
attr Rollladenautomatik ASC_freezeTemp 3
</pre>

tbd:
* Rain
* Wind
==== Konfiguration der Rollladendevices ====
===== Fahrzeiten =====
Zur Konfiguration der Fahrzeiten bietet es sich an, eine ReadingsGroup zu nutzen, wie unter [[#Hilfsmittel|Hilfsmittel]] dargestellt. Alternativ kann man die Zeiten auch manuell in den einzelnen Rollläden hinterlegen.
===== Bewohner =====
Wird ein Raum von einer oder mehreren bestimmten Person/en bewohnt oder gibt es ein Sammel-Gerät für mehrere Bewohner, kann dies mit den Attributen ''ASC_Roommate_Device'' und ''ASC_Roommate_Reading'' einem Rollladen zugeordnet werden. Ist einer der Bewohner ''asleep'', wird morgens erst geöffnet, wenn auch der letzte Roommate nicht mehr ''asleep'' ist.
===== Fensterkontakte =====
Dann werden ggf. vorhandene Fensterkontakte zugeordnet und der Typ festgelegt, wobei im Falle von threeState-Sensoren das übergreifende ''ASC_autoShuttersControlComfort'' beachtet wird, wobei dann bei vollstäniger Öffnung des Fensters auf den in ''ASC_ComfortOpen_Pos'' festgelegten Wert gefahren wird.
===== Frostschutz =====
Zuletzt können die Attribute ''ASC_Antifreeze'' und ''ASC_Antifreeze_Pos'' festgelegt werden, wenn die Frostschutzfunktion aktiviert werden soll.
=== Beschattung ===
==== Konfiguration des ASC-Devices ====
Benötigt werden Informationen zum Sonnenstand. Hierfür wird ein astro- oder twilight-Device benötigt. Ist ein solches definiert, wird dies - ggf. auch nach einem Neustart vom Modul automatisch erkannt und in das Attribut ''ASC_twilightDevice'' eingetragen. Wir legen daher zunächst ein entsprechendes Device an bzw. passen die Angabe ggf. an, wenn ein anderes als das eingetragene genutzt werden soll.
Weiter ist ein Temperatursensor für die Beschattung festzulegen (''ASC_temperatureSensor.*''-Attribute) wie bereits oben beschrieben.

==== Konfiguration der Rollladendevices ====
Zum einen legt man einen Helligkeitssensor fest (''ASC_Brightness_Sensor'' und ''ASC_Brightness_Reading''). Dieser ist der eigentliche Trigger. Nur, wenn sich der Brightness Wert ändert, werden Azimut, Elevation, Temperatur und die Ein- und Ausfallswinkel ausgelesen und/oder berechnet und basierend auf diesen Werten entschieden ob shading in oder shading out stattfinden soll, die Schwellwerte werden in ''ASC_Shading_StateChange_Sunny'' (Beschattung soll eingeschaltet werden) und ''ASC_Shading_StateChange_Cloudy'' (Beschattung soll beendet werden) festgelegt, wobei immer nur gefahren wird, wenn auch alles andere - insbesondere die Mindesthöhe des Sonnenstands (''ASC_Shading_Min_Elevation'') und die Mindesttemperatur ''ASC_Shading_Min_OutsideTemperature'' - passt.
Dann sind die Winkelangaben festzulegen, ggf. kann ein Kompass zu Hilfe genommen werden (''ASC_Shading_Direction'' ist die Richtung des Fensters, 90 Grad entspricht Ost, 180 Grad Süden, ''ASC_Shading_Angle_Left'' ist der Sonneneintritt ins Zimmer, wird von -Direction abgezogen, ''ASC_Shading_Angle_Right'' hat diesselbe Funktion für den Austrittswinkel.

=== Weitere Funktionen ===
==== Privacy ====
Werden hierfür Werte festgelegt, werden die betreffenden Rollläden die festgelegte Zeit vor dem abendlichen Schließen vorab teilweise geschlossen. Dies kann z.B. gewünscht sein, um Rollläden zur Straße hin mit viel Fußgängerverkehr zwar nicht vollständig abzudunkeln, aber gleichzeitig zu verhindern, dass von außen in Wohnräume geschaut werden kann, sobald dort das Licht angeschaltet wird
==== BlockingTime====
Bewirkt, dass nach einer manuellen Fahrt wird eine vom ASC Modul initiierte Fahrt zunächst ausgesetzt wird, bis die im Attribute angegebene Zeit überschritten ist. Erst dann wird eine dann vom ASC Modul initiierte Fahrt tatsächlich durchgeführt.
Genau so wird ein hochfahren eines Rollos durch das ASC Modul nicht mehr ausgeführt wenn es innerhalb der Zeit von ASC_BlockingTime_beforNightClose und das runterfahren wird nicht mehr erfolgen wenn es innerhalb von ASC_BlockingTime_beforDayOpen ist.
Beispiel: Meine Tochter geht früh aus Haus und Ihre Rollos sind nicht hoch gefahren. Diese fahren auch nicht mehr hoch da die ausschließlich bei home (anwesend) fahren sollen. Nun kommt sie am Nachmittag um 16:23 Uhr nach Hause, eigentlich sollten nun die Rollos fahren. Doch die Sonnenuntergangsfahrt (schließen) wäre schon 16:51 Uhr und damit innerhalb der 3600 ASC_BlockingTime_beforNightClose. Die Rollos bleiben also unten. Es lohnt sich für die paar Minuten einfach nicht mehr.
==== wiggle====
Mit einem <code>set <ASC-Device> wiggle</code> können alle Rollladen mit einem entsprechenden Attribut zu einer kurzen Fahrt veranlasst werden, nach Ablauf von einer Minute wieder um denselben Wert zurück. Dabei wird jeweils in die Richtung gefahren, die den weiteren Weg ermöglicht. Wenn also zu 70% geschlossen ist, wird der Rollladen hoch fahren.
==== Partymode ====
Dieser wird am ASC-Device selbst aktiviert mittels <code>set <ASC-Device> partyMode on</code>. Alle Rollladen-Devices, welche das Attribut ''ASC_Partymode'' auf ''on'' gestellt haben, werden nicht mehr gesteuert. Der letzte Schaltbefehl, der durch ein Fensterevent oder Bewohnerstatus an die Rollläden gesendet wurde, beim Beenden des Modus durch <code>set ASC-Device partyMode off</code> ausgeführt.
==== lock-out ====
(tbd auch hier: Doku ist etwas verteilt, könnte man im Wiki jeweils unter einem eigenen Unterabschnitt im Zusammenhang darstellen)

==== SelfDefense ====
Das bei einem absent nur da die Rollläden geschlossen werden wo das Fenster vergessen wurde zu schließen.
Beim wechsel in gone wird nur an den makierten Terassentüren (''ASC_ShuttersPlace terrace'') der Rollladen runter gefahren.
Weitere Attribute dazu: ''ASC_Self_Defense_Exclude''

== Sonstige Hinweise ==
* Werden Attribute geändert, kann es vereinzelt vorkommen, dass das ASC-Modul dies nicht mitbekommt und das tatsächliche Verhalten nicht den Erwartungen entspricht. In so einem Fall empfielt es sich, das NOTIFYDEV nochmals aufbauen zu lassen mit <code>set <ASC-Modul> createNewNotifyDev</code>.

== Weblinks ==
* {{Link2Forum|Topic=92628|LinkText="Thread zum Modul im Forum"}}
* {{Link2Forum|Topic=90751|LinkText="Thread zur Entwicklung im Forum"}}
* {{Link2Forum|Topic=73964|LinkText="Thread zu den Scripten von user cluni"}}, die der Entwicklung des Moduls zugrunde liegen

<references />

[[Kategorie:Code Snippets]]
[[Kategorie:Rollladensteuerung]]

EnOcean-D-452-FU-EBIM-JR-Aktor-Beschattungselemente-Rollladen

2018-12-16T11:47:25Z

50watt: /* Probleme */ Tippfehler

{{Infobox Hardware
|Bild=452_FU-EBIM_JR_oT.jpg
|Bildbeschreibung=PEHA 452 FU-EBIM_JR o.T.
|HWProtocol=EnOcean
|HWType=Empfänger, Aktor und Sender, Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=2 (bidirektional)
|HWVoltage=230V~
|HWPowerConsumption=Eigenverbrauch < 0,5 W
|HWPoweredBy=230V~
|HWSize=
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Peha
}}

[[EnOcean-D-452-FU-EBIM-JR-Aktor-Beschattungselemente-Rollladen]] ist ein
* Unterputzaktor
** 2-Kanal mit Positionserkennung

== Features ==
Bidirektionaler 2-Kanal-Jalousieaktor mit Positionserkennung (und/durch Energiemessung)

== Hinweise zum Betrieb mit FHEM ==
=== Definition/Anlernvorgang ===
Der Aktor kann nicht vollautomatisch per autocreate in FHEM angelegt werden. Die Einbindung in FHEM kann entweder über die Nutzung des gerätespezifischen EEP (empfohlen) '''oder''' über die manuelle Vorgehensweise erfolgen.

===== Nutzung des EEP =====
Folgende Schritte sind durchzuführen:
* FHEM-Device <name> (hier: Jalousie) mit der Sender-ID des Aktors (hier: FFB4C911) und dem EEP für den Aktor (A5-11-03) durch Eingabe in das [[Konfiguration#Befehl-Eingabefeld|Befehls-Eingabefeld]] definieren:
: <code>define Jalousie EnOcean FFB4C911 A5-11-03</code>
: Hierdurch wird ein FHEM-Device mit allen grundlegenden Attributen angelegt. Nur das Attribut <code>manufID</code> sollte noch auf den unten im Config-Auszug gezeigten Wert für PEHA geändert werden, bevor das FHEM-Device am Aktor angelernt wird.
* Am Aktor anlernen
** Aktor in Lernmodus bringen
* FHEM Eingabefeld: <code>set Jalousie teach</code>

Zusätzlich zum FHEM-Device wird bei der Anlage über das EEP automatisch ein Plot angelegt.

===== Alternative: manuelle Vorgehensweise =====
Folgende Schritte sind durchzuführen:
* EnOcean-FHEM-Device <code><name></code> mit der Sender-ID des Aktors definieren
* Das Attribut <code>subDef</code> mit einer freien SenderId des TCMs anlegen ODER falls keine freie Sender-ID bekannt ist, das Attribut komplett weglassen, damit die Vergabe automatisch durch FHEM erfolgt
* Die Attribute <code>gwCmd</code>, <code>manufID</code>, <code>subType</code> und <code>subTypeSet</code> wie nachfolgend im Config-Auszug anlegen
* Am Aktor anlernen
** Aktor in Lernmodus bringen
* FHEM Eingabefeld: <code>set <name> teach</code>

=== Konfiguration ===
Anschließend muss die Laufzeit für ein vollständiges Öffnen bzw. Schließen der Jalousie ermittelt werden:

Dazu die Jalousie durch Ansteuerung mit FHEM 3x vollständig öffen bzw. schließen lassen. Bei aktuellen Aktorversionen ist danach die Laufzeit automatisch ermittelt. Im Reading <code>position</code> wird dann die aktuelle Position der Jalousie in % angezeigt und der Aktor kann mit <code>set <name> position position/% α/°</code> prozentual -zusätzlich zu den laufzeitabhängigen Befehlen- angesteuert werden.

Führt dieses Vorgehen nicht zu einer korrekten Anzeige der Position, so muss bei älteren Aktorversionen mit <code>set <name> runtimeSet <tu/s> <td/s></code> die Laufzeit für ein vollständiges Öffnen bzw. Schließen der Jalousie manuell gemessen und im Aktor hinterlegt werden. Die Laufzeitwerte können in diesem Fall nicht nachträglich vom Aktor abgefragt werden. Sie stehen "nur" in den Readings des Aktors. Es empfiehlt sich diese Werte separat festzuhalten. Hierzu kann man beispielsweise Attribut <code>comment</code> des FHEM-Device nutzen.

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der [[Konfiguration]]:
define Jalousie EnOcean FFB4C911 <----- SenderId des Aktors
attr Jalousie eep A5-11-03
attr Jalousie gwCmd blindCmd
attr Jalousie manufID 001
attr Jalousie subDef FFAEEE86 <----- freie SenderID des TCM
attr Jalousie subType shutterCtrlState.01
attr Jalousie subTypeSet gateway
attr Jalousie webCmd opens:stop:closes:position

=== Logbeispiel ===
2014-09-13_12:28:58 Jalousie position: 40
2014-09-13_12:28:58 Jalousie anglePos: 0
2014-09-13_12:28:58 Jalousie alarm: off
2014-09-13_12:28:58 Jalousie endPosition: not_reached
2014-09-13_12:28:58 Jalousie not_reached
2014-09-13_12:28:58 Jalousie shutterState: closes
2014-09-13_12:28:58 Jalousie serviceOn: no
2014-09-13_12:28:58 Jalousie positionMode: normal
2014-09-13_12:28:58 Jalousie position: 50
2014-09-13_12:28:58 Jalousie anglePos: 0
2014-09-13_12:28:58 Jalousie alarm: off
2014-09-13_12:28:58 Jalousie endPosition: not_reached
2014-09-13_12:28:58 Jalousie not_reached
2014-09-13_12:28:58 Jalousie shutterState: closes
2014-09-13_12:28:58 Jalousie serviceOn: no
2014-09-13_12:28:58 Jalousie positionMode: normal

=== Probleme ===
In ersten Versionen des Aktors gab es Probleme mit der Winkelverstellung der Lammellen. Diese Probleme sollen in aktuellen Versionen behoben sein. Details: {{Link2Forum|Topic=40102|Message=336564}}

Ausfälle sind häufig auf eine reduzierte Kapazität des X2-Kondensators im verwendeten Kondensatornetzteil zurück zu führen. Ersatz durch gleichen 470nF 305V X2 schafft Abhilfe. Allerdings muss auch der 270 V Varistor gegen einen 250 V Typ ausgetauscht werden, sonst hat man das Problem ein Jahr später wieder. Dieser Austausch betrifft sicherheitsrelevante Teile mit Netzspannung und darf nur durch Elektrofachkräfte durchgeführt werden.

== Einsatzbeispiel ==
=== Anzeige Rollladenstand im WebFrontend ===
Durch die folgenden zwei Attribute wird der Rollladenstand im WebFrontend bildlich dargestellt und bei Fahrten animiert visualisiert (positionMode: inverse; einstellbar über den Befehl <code>set <name> positionLogic inverse</code>):
:<code>attr Jalousie stateFormat position</code>
:<code>attr Jalousie devStateIcon 0:fts_shutter_100 100:fts_window_2w 1\d.*:fts_shutter_90 2\d.*:fts_shutter_80 3\d.*:fts_shutter_70 4\d.*:fts_shutter_60 5\d.*:fts_shutter_50 6\d.*:fts_shutter_40 7\d.*:fts_shutter_30 8\d.*:fts_shutter_20 9\d.*:fts_shutter_10 \d.*:fts_shutter_90</code>

== Links ==
* Datenblatt/Anleitung: [http://www.peha.de/cms/front_content.php?getFile=1&client=1&file=../../edi/import/de/Dokumente/PEHA_M_452FU_EBIM_JR_OT.pdf PDF]
* Forenbeitrag zur FHEM-Einbindung: {{Link2Forum|Topic=26692}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Rollladensteuerung]]

EnOcean-D-452-FU-EBIM-JR-Aktor-Beschattungselemente-Rollladen

2018-12-16T10:41:38Z

50watt: Bild hinzugefügt

{{Infobox Hardware
|Bild=452_FU-EBIM_JR_oT.jpg
|Bildbeschreibung=PEHA 452 FU-EBIM_JR o.T.
|HWProtocol=EnOcean
|HWType=Empfänger, Aktor und Sender, Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=2 (bidirektional)
|HWVoltage=230V~
|HWPowerConsumption=Eigenverbrauch < 0,5 W
|HWPoweredBy=230V~
|HWSize=
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Peha
}}

[[EnOcean-D-452-FU-EBIM-JR-Aktor-Beschattungselemente-Rollladen]] ist ein
* Unterputzaktor
** 2-Kanal mit Positionserkennung

== Features ==
Bidirektionaler 2-Kanal-Jalousieaktor mit Positionserkennung (und/durch Energiemessung)

== Hinweise zum Betrieb mit FHEM ==
=== Definition/Anlernvorgang ===
Der Aktor kann nicht vollautomatisch per autocreate in FHEM angelegt werden. Die Einbindung in FHEM kann entweder über die Nutzung des gerätespezifischen EEP (empfohlen) '''oder''' über die manuelle Vorgehensweise erfolgen.

===== Nutzung des EEP =====
Folgende Schritte sind durchzuführen:
* FHEM-Device <name> (hier: Jalousie) mit der Sender-ID des Aktors (hier: FFB4C911) und dem EEP für den Aktor (A5-11-03) durch Eingabe in das [[Konfiguration#Befehl-Eingabefeld|Befehls-Eingabefeld]] definieren:
: <code>define Jalousie EnOcean FFB4C911 A5-11-03</code>
: Hierdurch wird ein FHEM-Device mit allen grundlegenden Attributen angelegt. Nur das Attribut <code>manufID</code> sollte noch auf den unten im Config-Auszug gezeigten Wert für PEHA geändert werden, bevor das FHEM-Device am Aktor angelernt wird.
* Am Aktor anlernen
** Aktor in Lernmodus bringen
* FHEM Eingabefeld: <code>set Jalousie teach</code>

Zusätzlich zum FHEM-Device wird bei der Anlage über das EEP automatisch ein Plot angelegt.

===== Alternative: manuelle Vorgehensweise =====
Folgende Schritte sind durchzuführen:
* EnOcean-FHEM-Device <code><name></code> mit der Sender-ID des Aktors definieren
* Das Attribut <code>subDef</code> mit einer freien SenderId des TCMs anlegen ODER falls keine freie Sender-ID bekannt ist, das Attribut komplett weglassen, damit die Vergabe automatisch durch FHEM erfolgt
* Die Attribute <code>gwCmd</code>, <code>manufID</code>, <code>subType</code> und <code>subTypeSet</code> wie nachfolgend im Config-Auszug anlegen
* Am Aktor anlernen
** Aktor in Lernmodus bringen
* FHEM Eingabefeld: <code>set <name> teach</code>

=== Konfiguration ===
Anschließend muss die Laufzeit für ein vollständiges Öffnen bzw. Schließen der Jalousie ermittelt werden:

Dazu die Jalousie durch Ansteuerung mit FHEM 3x vollständig öffen bzw. schließen lassen. Bei aktuellen Aktorversionen ist danach die Laufzeit automatisch ermittelt. Im Reading <code>position</code> wird dann die aktuelle Position der Jalousie in % angezeigt und der Aktor kann mit <code>set <name> position position/% α/°</code> prozentual -zusätzlich zu den laufzeitabhängigen Befehlen- angesteuert werden.

Führt dieses Vorgehen nicht zu einer korrekten Anzeige der Position, so muss bei älteren Aktorversionen mit <code>set <name> runtimeSet <tu/s> <td/s></code> die Laufzeit für ein vollständiges Öffnen bzw. Schließen der Jalousie manuell gemessen und im Aktor hinterlegt werden. Die Laufzeitwerte können in diesem Fall nicht nachträglich vom Aktor abgefragt werden. Sie stehen "nur" in den Readings des Aktors. Es empfiehlt sich diese Werte separat festzuhalten. Hierzu kann man beispielsweise Attribut <code>comment</code> des FHEM-Device nutzen.

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der [[Konfiguration]]:
define Jalousie EnOcean FFB4C911 <----- SenderId des Aktors
attr Jalousie eep A5-11-03
attr Jalousie gwCmd blindCmd
attr Jalousie manufID 001
attr Jalousie subDef FFAEEE86 <----- freie SenderID des TCM
attr Jalousie subType shutterCtrlState.01
attr Jalousie subTypeSet gateway
attr Jalousie webCmd opens:stop:closes:position

=== Logbeispiel ===
2014-09-13_12:28:58 Jalousie position: 40
2014-09-13_12:28:58 Jalousie anglePos: 0
2014-09-13_12:28:58 Jalousie alarm: off
2014-09-13_12:28:58 Jalousie endPosition: not_reached
2014-09-13_12:28:58 Jalousie not_reached
2014-09-13_12:28:58 Jalousie shutterState: closes
2014-09-13_12:28:58 Jalousie serviceOn: no
2014-09-13_12:28:58 Jalousie positionMode: normal
2014-09-13_12:28:58 Jalousie position: 50
2014-09-13_12:28:58 Jalousie anglePos: 0
2014-09-13_12:28:58 Jalousie alarm: off
2014-09-13_12:28:58 Jalousie endPosition: not_reached
2014-09-13_12:28:58 Jalousie not_reached
2014-09-13_12:28:58 Jalousie shutterState: closes
2014-09-13_12:28:58 Jalousie serviceOn: no
2014-09-13_12:28:58 Jalousie positionMode: normal

=== Probleme ===
In ersten Versionen des Aktors gab es Probleme mit der Winkelverstellung der Lammellen. Diese Probleme sollen in aktuellen Versionen behoben sein. Details: {{Link2Forum|Topic=40102|Message=336564}}

Ausfälle sind häufig auf eine reduzierte Kapazität des X2-Kondensators im verwendenten Kondensatornetzteil zurück zu führen. Ersatz durch gleichen 470nF 305V X2 schafft Abhilfe. Allerdings muss auch der 270 V Varistor gegen einen 250 V Typ ausgetauscht werden, sonst hat man das Problem ein Jahr später wieder. Dieser Austausch betrifft sicherheitsrelevante Teile mit Netzspannung und darf nur durch Elektrofachkräfte durchgeführt werden.

== Einsatzbeispiel ==
=== Anzeige Rollladenstand im WebFrontend ===
Durch die folgenden zwei Attribute wird der Rollladenstand im WebFrontend bildlich dargestellt und bei Fahrten animiert visualisiert (positionMode: inverse; einstellbar über den Befehl <code>set <name> positionLogic inverse</code>):
:<code>attr Jalousie stateFormat position</code>
:<code>attr Jalousie devStateIcon 0:fts_shutter_100 100:fts_window_2w 1\d.*:fts_shutter_90 2\d.*:fts_shutter_80 3\d.*:fts_shutter_70 4\d.*:fts_shutter_60 5\d.*:fts_shutter_50 6\d.*:fts_shutter_40 7\d.*:fts_shutter_30 8\d.*:fts_shutter_20 9\d.*:fts_shutter_10 \d.*:fts_shutter_90</code>

== Links ==
* Datenblatt/Anleitung: [http://www.peha.de/cms/front_content.php?getFile=1&client=1&file=../../edi/import/de/Dokumente/PEHA_M_452FU_EBIM_JR_OT.pdf PDF]
* Forenbeitrag zur FHEM-Einbindung: {{Link2Forum|Topic=26692}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Rollladensteuerung]]

EnOcean-D-452-FU-EBIM-JR-Aktor-Beschattungselemente-Rollladen

2018-12-16T10:39:16Z

50watt: /* Features */

{{Infobox Hardware
|Bild=platzHalter.png
|Bildbeschreibung=todo
|HWProtocol=EnOcean
|HWType=Empfänger, Aktor und Sender, Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=2 (bidirektional)
|HWVoltage=230V~
|HWPowerConsumption=Eigenverbrauch < 0,5 W
|HWPoweredBy=230V~
|HWSize=
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Peha
}}

[[EnOcean-D-452-FU-EBIM-JR-Aktor-Beschattungselemente-Rollladen]] ist ein
* Unterputzaktor
** 2-Kanal mit Positionserkennung

== Features ==
Bidirektionaler 2-Kanal-Jalousieaktor mit Positionserkennung (und/durch Energiemessung)

== Hinweise zum Betrieb mit FHEM ==
=== Definition/Anlernvorgang ===
Der Aktor kann nicht vollautomatisch per autocreate in FHEM angelegt werden. Die Einbindung in FHEM kann entweder über die Nutzung des gerätespezifischen EEP (empfohlen) '''oder''' über die manuelle Vorgehensweise erfolgen.

===== Nutzung des EEP =====
Folgende Schritte sind durchzuführen:
* FHEM-Device <name> (hier: Jalousie) mit der Sender-ID des Aktors (hier: FFB4C911) und dem EEP für den Aktor (A5-11-03) durch Eingabe in das [[Konfiguration#Befehl-Eingabefeld|Befehls-Eingabefeld]] definieren:
: <code>define Jalousie EnOcean FFB4C911 A5-11-03</code>
: Hierdurch wird ein FHEM-Device mit allen grundlegenden Attributen angelegt. Nur das Attribut <code>manufID</code> sollte noch auf den unten im Config-Auszug gezeigten Wert für PEHA geändert werden, bevor das FHEM-Device am Aktor angelernt wird.
* Am Aktor anlernen
** Aktor in Lernmodus bringen
* FHEM Eingabefeld: <code>set Jalousie teach</code>

Zusätzlich zum FHEM-Device wird bei der Anlage über das EEP automatisch ein Plot angelegt.

===== Alternative: manuelle Vorgehensweise =====
Folgende Schritte sind durchzuführen:
* EnOcean-FHEM-Device <code><name></code> mit der Sender-ID des Aktors definieren
* Das Attribut <code>subDef</code> mit einer freien SenderId des TCMs anlegen ODER falls keine freie Sender-ID bekannt ist, das Attribut komplett weglassen, damit die Vergabe automatisch durch FHEM erfolgt
* Die Attribute <code>gwCmd</code>, <code>manufID</code>, <code>subType</code> und <code>subTypeSet</code> wie nachfolgend im Config-Auszug anlegen
* Am Aktor anlernen
** Aktor in Lernmodus bringen
* FHEM Eingabefeld: <code>set <name> teach</code>

=== Konfiguration ===
Anschließend muss die Laufzeit für ein vollständiges Öffnen bzw. Schließen der Jalousie ermittelt werden:

Dazu die Jalousie durch Ansteuerung mit FHEM 3x vollständig öffen bzw. schließen lassen. Bei aktuellen Aktorversionen ist danach die Laufzeit automatisch ermittelt. Im Reading <code>position</code> wird dann die aktuelle Position der Jalousie in % angezeigt und der Aktor kann mit <code>set <name> position position/% α/°</code> prozentual -zusätzlich zu den laufzeitabhängigen Befehlen- angesteuert werden.

Führt dieses Vorgehen nicht zu einer korrekten Anzeige der Position, so muss bei älteren Aktorversionen mit <code>set <name> runtimeSet <tu/s> <td/s></code> die Laufzeit für ein vollständiges Öffnen bzw. Schließen der Jalousie manuell gemessen und im Aktor hinterlegt werden. Die Laufzeitwerte können in diesem Fall nicht nachträglich vom Aktor abgefragt werden. Sie stehen "nur" in den Readings des Aktors. Es empfiehlt sich diese Werte separat festzuhalten. Hierzu kann man beispielsweise Attribut <code>comment</code> des FHEM-Device nutzen.

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der [[Konfiguration]]:
define Jalousie EnOcean FFB4C911 <----- SenderId des Aktors
attr Jalousie eep A5-11-03
attr Jalousie gwCmd blindCmd
attr Jalousie manufID 001
attr Jalousie subDef FFAEEE86 <----- freie SenderID des TCM
attr Jalousie subType shutterCtrlState.01
attr Jalousie subTypeSet gateway
attr Jalousie webCmd opens:stop:closes:position

=== Logbeispiel ===
2014-09-13_12:28:58 Jalousie position: 40
2014-09-13_12:28:58 Jalousie anglePos: 0
2014-09-13_12:28:58 Jalousie alarm: off
2014-09-13_12:28:58 Jalousie endPosition: not_reached
2014-09-13_12:28:58 Jalousie not_reached
2014-09-13_12:28:58 Jalousie shutterState: closes
2014-09-13_12:28:58 Jalousie serviceOn: no
2014-09-13_12:28:58 Jalousie positionMode: normal
2014-09-13_12:28:58 Jalousie position: 50
2014-09-13_12:28:58 Jalousie anglePos: 0
2014-09-13_12:28:58 Jalousie alarm: off
2014-09-13_12:28:58 Jalousie endPosition: not_reached
2014-09-13_12:28:58 Jalousie not_reached
2014-09-13_12:28:58 Jalousie shutterState: closes
2014-09-13_12:28:58 Jalousie serviceOn: no
2014-09-13_12:28:58 Jalousie positionMode: normal

=== Probleme ===
In ersten Versionen des Aktors gab es Probleme mit der Winkelverstellung der Lammellen. Diese Probleme sollen in aktuellen Versionen behoben sein. Details: {{Link2Forum|Topic=40102|Message=336564}}

Ausfälle sind häufig auf eine reduzierte Kapazität des X2-Kondensators im verwendenten Kondensatornetzteil zurück zu führen. Ersatz durch gleichen 470nF 305V X2 schafft Abhilfe. Allerdings muss auch der 270 V Varistor gegen einen 250 V Typ ausgetauscht werden, sonst hat man das Problem ein Jahr später wieder. Dieser Austausch betrifft sicherheitsrelevante Teile mit Netzspannung und darf nur durch Elektrofachkräfte durchgeführt werden.

== Einsatzbeispiel ==
=== Anzeige Rollladenstand im WebFrontend ===
Durch die folgenden zwei Attribute wird der Rollladenstand im WebFrontend bildlich dargestellt und bei Fahrten animiert visualisiert (positionMode: inverse; einstellbar über den Befehl <code>set <name> positionLogic inverse</code>):
:<code>attr Jalousie stateFormat position</code>
:<code>attr Jalousie devStateIcon 0:fts_shutter_100 100:fts_window_2w 1\d.*:fts_shutter_90 2\d.*:fts_shutter_80 3\d.*:fts_shutter_70 4\d.*:fts_shutter_60 5\d.*:fts_shutter_50 6\d.*:fts_shutter_40 7\d.*:fts_shutter_30 8\d.*:fts_shutter_20 9\d.*:fts_shutter_10 \d.*:fts_shutter_90</code>

== Links ==
* Datenblatt/Anleitung: [http://www.peha.de/cms/front_content.php?getFile=1&client=1&file=../../edi/import/de/Dokumente/PEHA_M_452FU_EBIM_JR_OT.pdf PDF]
* Forenbeitrag zur FHEM-Einbindung: {{Link2Forum|Topic=26692}}

[[Kategorie:EnOcean Components]]
[[Kategorie:Rollladensteuerung]]

Datei:452 FU-EBIM JR oT.jpg

2018-12-16T10:36:52Z

50watt: PEHA D-452-FU-EBI-JR

== Beschreibung ==
PEHA D-452-FU-EBI-JR

Anwesenheitssimulation

2018-08-05T15:29:44Z

50watt: /* Beispiel: Lichter schalten */ Tippfehler

Eine häufige Anwendung von Hausautomatisierungstechnik ist die Anwesenheitssimulation.
Dabei sollen automatisch bei Abwesenheit Aktivitäten simuliert werden, die dem Beobachter von außen den Eindruck vermitteln das Haus sein bewohnt.
__TOC__
== Einleitung ==
Denkbar sind eine ganze Reihe von Aktivitäten:
* Lichter ein- und ausschalten
* Geräusche abspielen
* Rollläden bewegen
* Betrieb eines Fernsehers simulieren
* Rasensprenger ein- und ausschalten
* Verstellbare Antennen, Kameras o.Ä. bewegen
Jeder Aktor der von außen wahrnehmbar ist könnte zur Anwendung kommen.
Entscheiden dabei ist die glaubwürdige Erscheinung dieser Aktivitäten.
Ist die Simulation von außen als solche erkennbar, so bewirkt sie gerade das Gegenteil von dem, was man damit erreichen möchte.
Ein potentieller Einbrecher würde durch die Anwesenheitssimulation nicht abgeschreckt sondern angelockt.

Eher ungeeignete Beispiele sind Zeitschaltuhren die nur in ein oder zwei Räumen immer zur gleichen Zeit das Licht einschalten.
Im Handel werden gerade für die Simulation von Fernsehern teilweise extrem schlechte Geräte angeboten.
Sie spielen zyklisch immer das gleiche Muster mit teilweise harten, auffälligen und einprägsamen Farbwechseln.
Ist dann der Zyklus auch noch relativ kurz, ist jedem Beobachter sehr schnell klar, dass in diesem Haus eine Simulation läuft.

Betätigungszeiten von Lampen und Rollläden sollten den üblichen Gewohnheiten der Bewohner entsprechen, aber nicht mit messbar mechanischer Präzision durchgeführt werden.
Gerade organisierte Banden reduzieren ihr Risiko durch sorgfältige Beobachtung, was sich heutzutage mit wetterfesten Action/Wild-Kameras sehr einfach und unauffällig bewerkstelligen lässt.
Es sollte nie vergessen werden, dass die gegnerische Seite auch über technische Möglichkeiten verfügt.
Zeigt ein solches Video präzise wiederkehrende Schaltzeiten, werden die Lichter wohl kaum von Bewohnern betätigt.

Eine perfekte Anwesenheitssimulation ist extrem aufwändig wenn nicht unmöglich.
Der Briefkasten müssten geleert werden, Vorhänge bewegt, die Einfahrt gefegt und nicht zuletzt sollte man ab und zu jemanden sehen der dort wohnt.
Manche Einbrecher präparieren die Haustüre (stecken z.B. etwas in den Türspalt) um einige Tage danach sehen zu können ob die Türe überhaupt einmal bewegt wurde.
Kaum jemand wird seine Hausautomatisierung hin und wieder die Haustüre entriegeln und öffnen lassen.

== Methoden ==
Anwesenheitssimulation ist immer ein Kompromiss zwischen Aufwand und Glaubwürdigkeit.

=== Statistik ===
Für Betätigungszeiten von Lampen und Jalousien gibt es Systeme die über die Betätigungszeiten der Bewohner eine Statistik erstellen.
Sind die Bewohner nicht anwesend, führt das System zu ähnlichen aber eben nicht exakt gleichen Zeiten Betätigungen aus.
Im einfachsten Fall werden für jedes Signal (z.B. Licht an/aus) Wahrscheinlichkeitsverteilungen bestimmt.
Bei der Simulation wird dann regelmäßig "gewürfelt" ob das Signal betätigt werden soll.

Komplizierter (aber auch glaubwürdiger) wird es, wenn man Zusammenhänge zwischen Signalen berücksichtigt.
Ein Bewohner schaltet jeden Abend in einem bestimmten Raum das Licht an und lässt gleich darauf den Rollladen herunter.
Bei der reinen Betrachtung einzelner Betätigungen könnte es vorkommen, dass erst der Rollladen herunter gelassen wird und man das danach eingeschaltete Licht nicht sieht.
Die dafür nötigen Auswertungen des Verhaltens der Bewohner sind deutlich aufwändiger.

Ein Kompromiss ist die explizite Vorgabe von Zusammenhängen, so dass das Hausautomatisierungssystem wieder nur die Verteilungen bestimmen muss.
Geht z.B. nachts jemand auf die Toilette, so schaltet er erst das Licht im Gang an und etwas später in der Toilette.
Auf dem Rückweg dann umgekehrt.
Eine Simulation sollte also so eingestellt werden, dass vor dem Einschalten der Toilettenbeleuchtung auch der Gang eingeschaltet wird und auch etwas länger an bleibt.

=== Vernetzung ===
Die Vernetzung von Sensoren und Aktoren bei der Hausautomatisierung erlaubt es außerdem, Reaktionen wesentlich vielfältiger als üblich zu gestalten.
Außenbeleuchtung mit Bewegungsmeldern sind jedem Einbrecher wohl bekannt.
Es ist vielleicht lästig plötzlich im Licht zu stehen aber erschrecken kann man damit niemanden.
Wesentlich irritierender ist es, wenn plötzlich im Haus ein Licht oder Geräusch an geht.
In diesem Fall ist der Zusammenhang zum Bewegungsmelder nicht unmittelbar erkennbar
Die einfache Vernetzung ermöglicht hier schon einen verbesserten Effekt.
Mit etwas Fantasie lassen sich andere Anwendungen finden.
Tagsüber könnte ein Bewegungsmelder statt eines Lichts z.B. den Rasensprenger einschalten.

== Möglichkeiten in FHEM ==
* [[RandomTimer|98_RandomTimer.pm]] ''Hilfsmodul, mit dem in einem bestimmten Zeitraum zu zufälligen Zeitpunkten Schaltvorgänge ausgelöst werden können''

=== Beispiel: Lichter schalten ===
Im Handel sind Schaltuhren mit Zufallsfunktion. Diese müssen aber oft umständlich eingestellt werden und lassen sich dann oft auch nicht anderweitig schalten. Man müsste immer wenn man das Haus länger verlässt die Schaltuhren alle aktivieren.
Komfortabler und auch nicht unbedingt teurer geht das mit FHEM.
Man benötigt
# ein Gerät auf dem FHEM läuft (z.B. ein [[Raspberry_Pi|Raspberry Pi]] oder [[BeagleBone Black]]) mit
# einem [[CUL]] und
# ein paar preiswerte Funkschalter (z.B. intertechno ITR-1500 drei Stück für unter 28€).
Damit lässt sich ein System zur zentralen Steuerung von Lampen, Fernsehern, Radios u.A. realisieren.
Das FHEM installieren und den [[CUL]] konfigurieren.
Dann die Funkschalter im FHEM mit einem frei gewählten 26-Bit Code anmelden (siehe [[Intertechno_Code_Berechnung#Definition]]).
define sw_it_01 IT 01010101010101010101010101 0 0000
define sw_it_02 IT 01010101010101010101010101 0 0001
define sw_it_03 IT 01010101010101010101010101 0 0010
Wer möchte kann auch jedem Schalter seinen eigenen 26-Bit Code geben.
Dem Modul mitteilen, dass es sich um gewöhnliche Schalter (keine Dimmer) handelt.
attr sw_it_XX model itswitch
Das <code>XX</code> muss für jeden Schalter durch seine Nummer ersetzt werden.
Jetzt kann man auf der Anzeige "Everything" die Schalter finden und durch klick auf <code>on</code> oder <code>off</code> betätigen. Um die Funkschalter an zu lernen muss man in den ersten 5 Sekunden nach dem Einstecken die Funktion <code>on</code> betätigen. Hat man das für alle Schalter durchgeführt, kann man sie jetzt über FHEM bedienen.

==== Zufällig ====
Um eine zufällige Betätigung zu erreichen, kann das Modul [[RandomTimer]] verwendet werden:
define <name> RandomTimer <timespec_start> <device> <timespec_stop> [<timeToSwitch>]
Wollen wir z.B. den Schalter <code>sw_it_01</code> zwischen 20:00 und 22:00 für eine Stunden einschalten können wir das mit diesem Befehl erreichen:
define rand_sw_01 RandomTimer 20:00 sw_it_01 22:00 3600

==== Sonnenauf und -untergang ====
Das Modul [[SUNRISE_EL]] stellt die anhand der geographischen Position errechneten Zeiten für den Sonnenaufgang und den Sonnenuntergang zur Verfügung.
Dazu stellt man zunächst die eigene Position ein (z.B. Berlin):
attr global latitude 52.51861
attr global longitude 13.40833
Soll der Funkschalter <code>sw_it_01</code> immer Nachts eingeschaltet sein erreicht man das mit
define sw_it_01_aus at *{sunrise(0)} set sw_it_01 off
define sw_it_01_ein at *{sunset(0)} set sw_it_01 on
Optional kann man den Zeitraum noch vorgeben (siehe [[SUNRISE_EL]]).
Eine ähnliche Funktion unter Einbeziehung der Wetterlage bietet das Modul [[Twilight]].
Mit ihm kann ein Twilight-Objekt für Berlin angelegt werden:
define myTL Twilight 52.51861 13.40833 1 638242
Die letzte Ziffer ist die Yahoo-Wetter-ID die man im [https://www.yahoo.com/news/weather/ Yahoo-Wetter-Dienst] ermitteln kann indem man {{Taste|Change location}} betätigt und dann die Nummer der URL entnimmt.
Dieses Twilight-Objekt kann nun für Schaltaktionen verwendet werden.
define sw_it_01_ein at *{twilight("myTL","sr_indoor","7:30","9:00")} set sw_it_01 on
define sw_it_01_aus at *{twilight("myTL","ss_indoor","17:30","22:30")} set sw_it_01 off

==== Kombination Zufall und Sonnenlauf ====
Die Start- und Stopzeit des [[RandomTimer]] kann auch von rechnerischen Sonnenunter- oder -aufgang abhängig gemacht werden:
define rand_sw_01 RandomTimer *{sunset_abs()} sw_it_01 *{sunset_abs(3*3600)} 3600

== Hardware ==
=== Lampen schalten ===
* [[:Kategorie:Schalter (Empfänger)]]
* [[FS20 ST Steckdosenfunkschalter]]
* Funkschalter von Intertechno u.Ä. (siehe [[Intertechno Code Berechnung]])

=== Rollläden, Jalousien u.Ä. ===
* [[:Kategorie:Rollladensteuerung]]
* [[EnOcean-FSB61-Aktor-Beschattungselemente-Rollladen]]
* [[EnOcean-FSB14-RS485-Bus-Schaltaktor-2-Kanal-Beschattungselemente-Rollladen]]

=== Betrieb eines Fernsehers simulieren ===
* [[HM-LC-RGBW-WM Funk-RGBW-Controller]]

== Links ==
* [https://de.wikipedia.org/wiki/Anwesenheitssimulation Anwesenheitssimulation] in der deutsche Wikipedia
* [http://www.elv.de/mein-elv-projekt-anwesenheitssimulation.html ELV - Wissen immer noch alle, dass Sie nicht da sind?]

[[Kategorie:Code Snippets]]
[[Kategorie:Glossary]]
[[Kategorie:HOWTOS]]

HOMEMODE

2018-08-02T20:14:10Z

50watt: /* Grundkonfiguration */ Tippfehler

{{
Infobox Modul
|ModPurpose=Das Modul wurde entworfen um den gesamten Heim-/Hausstatus in einem Gerät abzubilden und viele grundlegende Automationen durch Hinzufügen weiterer Geräte bereitzustellen.
|ModType=h
|ModCmdRef=HOMEMODE
|ModFTopic=64317
|ModForumArea=Automatisierung
|ModTechName=22_HOMEMODE.pm
|ModOwner=DeeSPe
}}
Diese Seite beschreibt die Konfiguration und Verwendung des Moduls ''22_HOMEMODE.pm''.

=Allgemeines=
Das Modul ''22_HOMEMODE.pm'' wurde entworfen um den gesamten Heim-/Hausstatus in einem Gerät abzubilden.<br>
Die hier aufgeführte Anleitung entspricht dem Modul in Version 1.4.2.

Viele allgemein typische Automationen sind bereits fertig integriert.

Die jeweils per Event auszuführenden Befehle können in den entsprechenden ''HomeCMD...'' Atributen hinterlegt werden und so in der Detail Ansicht des HOMEMODE Geräts übersichtlich angezeigt und bearbeitet werden.

Das Anlegen vieler notify/DOIF ist durch den Einsatz von ''HOMEMODE'' unnötig.

Zusätzlich wurde das Modul für die Verwendung mit HomeKit als GUI optimiert. Alle möglichen Mappings für Homebridge sind bereits enthalten und können über einen set Befehl aktualisiert werden.

[[Datei:HOMEMODE_Device.png|800px]]

==Voraussetzungen==
Um Modul ''22_HOMEMODE.pm'' benutzen zu können benötigt man als Mindestvoraussetzung ein bereits angelegtes RESIDENTS Gerät mit entsprechenden ROOMMATE/GUEST Geräten.

==Mögliche Automationen==
Alle Automationen sind optional.

Hier ein paar Beispiele:
*Änderung des Zustands von ROOMMATE/GUEST Geräten anhand von PRESENCE Geräten
*Bereistellung von CMD Attributen für mögliche Events rund um den Heim-/Hausstatus
*Bereistellung von Platzhaltern innerhalb der CMD Attribute, z.B. %MODE%, %SEASON% oder %PREVMODE% für die Werte der Readings mode, season und prevMode
*Einbindung von Kontakt Sensoren, für z.B. Offen-Warnungen nach bestimmten Zeitraum oder Alarm Meldungen in bestimmten Alarm Modus - kann pro Kontakt Sensor konfiguriert werden
*Einbindung von Bewegungs Sensoren, für z.B. automatische Licht Schaltungen oder Alarm Meldungen in bestimmten Alarm Modus - kann pro Bewegungs Sensor konfiguriert werden
*Darstellungen und Auslösen von Sabotage Alarmen der eingebundenen Kontakt- und Bewegungssensoren
*Einbindung von jeweils einem Temperatur und Luftfeuchtigkeitssensor
*Einbindung eines lokalen Yahoo Wetter Devices zur Ermittlung und Ausgabe der lokalen Wetterdaten und Erzeugung der Wettervorhersage
*Einbindung von Power und Energy Sensoren zur Ermittlung der Gesamtmengen
*Einbindung von Calendar/holiday Devices für spezielle im HOMEMODE Device verfügbar zu machende Events
*von Uhrzeit abhängiger Anwesend-Modus
*Bewohner unabhängige Tageszeit-Modus
*Alarm-Modus
*DND-Modus
*Überwachung von Batteriewerten

=HOMEMODE-Gerät=
==Definition==
Das HOMEMODE Gerät - hier mit dem Namen ''Home'' versehen - selbst wird über
define Home HOMEMODE
bei Vorhandensein nur eines RESIDENTS Geräts definiert.

Bei Verwendung mehrerer RESIDENTS Geräte muss das Master RESIDENTS Gerät beim Definieren mit angegeben werden
define Home HOMEMODE rgr_Residents
Dieses Modul verwendet das globale Attribut ''language'' zur Bestimmung der Anzeigedaten (Standard: EN=english). Für deutsche Ausgabedaten kann das Attribut
attr global language DE
gesetzt werden.<br>
Alternativ kann auch nur das HOMEMODE Gerät auf deutsch geändert werden
attr Home HomeLanguage DE

==Set-Befehle==
''set <required> [optional]''

set Home anyoneElseAtHome <on/off>
einschalten wenn jemand anderes zu Hause ist der kein registrierter ROOMMATE/GUEST ist, z.B. Hund/Katze oder unregistrierte Gäste<br>
wenn eingeschaltet, dann wird der Alarm Mode beim Verlassen statt auf armaway nur auf armhome gestellt<br>
schaltet man ein und hat schon Haus/Wohnung verlassen, so wird der Alarm Mode von armaway auf armhome gestellt<br>
Platzhalter '''%AEAH%''' ist in allen HomeCMD Attributen verfügbar

set Home dnd <on/off>
schaltet den "Bitte nicht stören" Modus ein<br>
z.B. um Benachrichtigungen zu deaktivieren<br>
Platzhalter '''%DND%''' ist in allen HomeCMD Attributen verfügbar

set Home dnd-for-minutes <MINUTES>
schaltet den "Bitte nicht stören" Modus für die angegebenen Minuten ein<br>
kehrt danach zum vorherigen (tageszeitabhängigen) Modus zurück

set Home deviceDisable <DEVICE>
deaktiviert das Gerät für sämtliche HOMEMODE Automationen<br>
Platzhalter '''%DISABLED%''' ist in allen HomeCMD Attributen verfügbar<br>
Platzhalter '''%DEVICE%''' und '''%ALIAS%''' sind in allen HomeCMD Attributen verfügbar

set Home deviceEnable <DEVICE>
reaktiviert das Gerät für sämtliche HOMEMODE Automationen<br>
Platzhalter '''%DISABLED%''' ist in allen HomeCMD Attributen verfügbar<br>
Platzhalter '''%DEVICE%''' und '''%ALIAS%''' sind in allen HomeCMD Attributen verfügbar

set Home location <arrival/home/bed/underway/wayhome>
manueller Ortswechsel<br>
Platzhalter '''%LOCATION%''' ist in allen HomeCMD Attributen verfügbar

set Home mode <morning/day/afternoon/evening/night/gotosleep/asleep/absent/gone/home>
manueller Moduswechsel<br>
Platzhalter '''%MODE%''' und '''%PREVMODE%''' sind in allen HomeCMD Attributen verfügbar

set Home modeAlarm <armaway/armhome/armnight/disarm>
schaltet den angegebenen Alarm Modus ein<br>
Platzhalter '''%AMODE%''' und '''%PREVAMODE%''' sind in allen HomeCMD Attributen verfügbar

set Home modeAlarm-for-minutes <armaway/armhome/armnight/disarm> <MINUTES>
schaltet den angegebenen Alarm Modus für die angegebenen Minuten ein
kehrt danach zum vorherigen Alarm Modus zurück

set Home updateHomebridgeMapping
aktualisiert das Attribut homebridgeMapping des HOMEMODDE Device abhängig von den verfügbaren Informationen

set Home updateInternalForce
führt eine Aktualisierung der Internals des HOMEMODE Device aus<br>
das sollte manuell benutzt werden nachdem das Modul aktualisiert und nur ein reload statt restart gemacht wurde<br>
auch wenn man überwachte/kontrollierte Geräte ändert sollte man diesen Befehl manuell ausführen, z.B. neue ROOMMATE/GUEST im RESIDENTS Device hinzufügt, oder Geräte in FHEM hinzufügt die dem selben Devspec wie bisher entsprechen (Steckdosen, Sensoren)

==Get-Befehle==
''get <required> [optional]''

get Home contactsOpen <all/doorsinside/doorsoutside/doorsmain/outside/windows>
Liste von all/doorsinside/doorsoutside/doorsmain/outside/windows offenen Kontakten<br>
Platzhalter '''%OPEN%''', '''%OPENCT%''' und '''%OPENHR%''' sind in allen HomeCMD Attributen verfügbar

get Home devicesDisabled
Anzeige der für HOMEMODE deaktivierten Geräte<br>
Platzhalter '''%DISABLED%''' ist in allen HomeCMD Attributen verfügbar

get Home mode
Anzeige von mode<br>
Platzhalter '''%MODE%''' ist in allen HomeCMD Attributen verfügbar

get Home modeAlarm
Anzeige von modeAlarm<br>
Platzhalter '''%AMODE%''' und '''%MODEALARM%''' sind in allen HomeCMD Attributen verfügbar

get Home publicIP
holen der öffentlichen IP Adresse<br>
Platzhalter '''%IP%''' ist in allen HomeCMD Attributen verfügbar

get Home sensorsTampered
Liste aller sabotierten Sensoren<br>
Platzhalter '''%TAMPERED%''', '''%TAMPEREDCT%''' und '''%TAMPEREDHR%''' sind in allen HomeCMD Attributen verfügbar

get Home weather <long/short>
Wetterinfo im angegebenen Format anzeigen<br>
Platzhalter '''%WEATHER%''' und '''%WEATHERLONG%''' sind in allen HomeCMD Attributen verfügbar

get Home weatherForecast [TAG]
Wettervorhersage für angegebenen Tag<br>
wenn kein Tag angegeben wird, so wird die Vorhersage für morgen (2) ausgegeben<br>
Platzhalter '''%FORECAST%''' (morgen) und '''%FORECASTTODAY%''' (heute) sind in allen HomeCMD Attributen verfügbar

==webCmd==
Die Schaltmöglichkeiten sind absichtlich gering gehalten, denn im normalen Betrieb sollte nicht mehr benötigt werden als die hier gebotenen.<br>
Es lässt sich der Alarm Mode manuell umschalten und beim Klick auf das devStateIcon wird der DND Mode an- und ausgeschaltet.

=Konfiguration=

==Grundkonfiguration==

Diese Grundkonfiguration sollte immer als erstes erfolgen um entsprechend darauf weiter aufzubauen. Als zweiter Schritt ist dann die erweiterte Konfiguration angedacht.

Bei der Namensvergabe der Attribute vom HOMEMODE Device wurde nach einem möglichst kurzem Prefix gesucht und nach vielen Tests wurde sich für das Prefix "Home" entschieden. Das hat den Vorteil, dass alle Attribute beisammen stehen und diese auch (durch den Großbuchstaben am Anfang) ziemlich weit oben in der Liste der Attribute stehen. Ebenso wurde bei der Namensvergabe versucht, selbsterklärende Namen zu wählen. Das hat den Vorteil, dass man relativ einfach genau erkennen kann wofür das Attribut steht, allerdings auch den Nachteil, dass einige Attributnamen ganz schön lang werden.

===Attribute===

====HomeAdvancedUserAttr====
Als Erstes wird empfohlen, gerade für Anfänger, das Attribut "HomeAdvancedUserAttr" auf 1 zu setzen. Dadurch werden viel mehr HomeCMD Attribute freigeschaltet. Diese werden im Attribut userattr des HOMEMODE Device hinzugefügt.<br>
Standardwert: 0

====HomeAutoAlarmModes====
Als Nächstes sollte man sich entscheiden, ob die Alarm Modus evtl. nicht automatisch zum jeweiligen Modus des HOMEMODE Device geschaltet werden sollen. Standardmäßig werden die Alarm Modus automatisch gesteuert. Ist das nicht erwünscht, so ist der Wert dieses Attributs auf 0 zu setzen.<br>
Bei Modus "absent" des HOMEMODE Device wird automatisch auf "armaway" geschaltet.<br>
Bei Modus "home" des HOMEMODE Device wird automatisch auf "disarm" geschaltet.<br>
Bei Modus "asleep" des HOMEMODE Device wird automatisch auf "armnight" geschaltet.<br>
Alarm Modus "armhome" kann nur manuell gesetzt werden.<br>
Werte: 0 oder 1<br>
Standardwert: 1

====HomeAutoArrival====
Ist hier ein Wert größer 0 angegeben, so wird bei Ankunft jedes ROOMMATE/GUEST die location des jeweiligen ROOMMATE/GUEST für die hier angegeben Zeit in Minuten auf "arrival" gesetzt. Beim ersten nach Hause kommenden ROOMMATE/GUEST wird zusätzlich die location des HOMEMODE Device für die hier eingestellte Zeit in Minuten auf "arrival" gesetzt.<br>
Nach Ablauf der hier eingestellten Minuten wechselt das jeweilige Device von "arrival" auf "home", sofern es noch die location "arrival" hat.<br>
Werte: 0 bis 5999.9<br>
Standardwert: 0

====HomeAutoAsleep====
Ist hier ein Wert größer 0 angegeben, so wird beim Schlafengehen (gotosleep) jedes ROOMMATE/GUEST ein Timer gestartet, der den jeweiligen ROOMMATE/GUEST nach der hier angegeben Zeit in Minuten auf "asleep" setzt.<br>
Werte: 0 bis 5999.9<br>
Standardwert: 0

====HomeAutoAwoken====
Ist hier ein Wert größer 0 angegeben, so wird beim Erwachen ("awoken" oder "home nach asleep") jedes ROOMMATE/GUEST dieser auf "awoken" gesetzt und ein Timer gestartet, der den jeweiligen ROOMMATE/GUEST nach der hier angegeben Zeit in Minuten auf "home" setzt.<br>
Werte: 0 bis 5999.9<br>
Standardwert: 0

====HomeAutoDaytime====
Standardmäßig wird mode anhand der Tageszeit automatisch gesetzt. Ist das nicht gewünscht, kann das über den Wert 0 deaktiviert werden. Dann stehen allerdings tageszeitabhängigen mode(s) nicht mehr zur Verfügung.<br>
Werte: 0 oder 1<br>
Standardwert: 1

====HomeResidentCmdDelay====
Normalerweise werden die Events der ROOMMATE/GUEST vor denen des HOMEMODE Device ausgeführt. Um das zu ändern wird die Ausführung der ROOMMATE/GUEST HomeCMD Attribute um die hier eingestellte Zeit in Sekunden verzögert.<br>
Je genauer der Name des jeweiligen HomeCMD Attributs beschrieben wird, desto später wird dieser ausgeführt.<br>
Das heißt z.B. dass HomeCMDmode vor HomeCMDmode-absent und dieser wiederrum vor HomeCMDmode-absent-ROOMMATE/GUEST-NAME ausgeführt wird usw.<br>
Um das normale Verhalten wiederherzustellen ist der Wert dieses Attributs auf 0 zu setzen. Dann wird HomeCMDmode-absent-ROOMMATE/GUEST-NAME vor HomeCMDmode-absent und vor HomeCMDmode ausgeführt.<br>
Werte: 0 bis unendlich in Sekunden<br>
Standardwert: 1

==Konfiguration Presence Devices (automatische anwesend/abwesend Umschaltung von ROOMMATE/GUEST)==
Damit die automatische Zuordnung der Presence Devices zu ihren ROOMMATE/GUEST Devices zuverlässig funktioniert, ist es nötig dass der Hauptteil des Namens des ROOMMATE/GUEST innerhalb des Namens des zugehörigen PRESENCE Device(s) vorkommt.<br>
Im Attribut HomePresenceDeviceType kann man den zu suchenden TYPE von Presence Device vorgeben.<br>
Per Default werden nur Devices vom TYPE PRESENCE gesucht und versucht den ROOMMATE/GUEST zuzuweisen.<br>
Falls man z.B. auch Devices vom TYPE dummy zur Anwesenheitssteuerung benutzt, kann man diese im Attribut HomePresenceDeviceType mit hinzunehmen. Es sind alles Device TYPEn möglich die ein "presence" Reading mit den Werten "present/appeared" und "absent/disappeared" bereitstellen. Mehrere TYPEn sind möglich da in diesem Attribut ein Regex erwartet wird. z.B.: dummy oder PRESENCE|dummy oder PRESENCE|dummy|ONKYO_AVR.

===Beispiel===
Der Device Name meines ROOMMATE ist "rr_Dan".<br>
Auf der Suche nach dem zugehörigen Presence Device wird der erste Teil (rr_ oder rg_) weggeschnitten und der Rest in Kleinbuchstaben umgewandelt.<br>
Mit dem was übrig bleibt, bei mir also nur dan, werden die möglichen Presence Devices versucht zu erkennen.<br>
Mein zugehöriges Presence Device heißt, historisch gewachsen, PRESENCE_rr_Dan und würde somit problemlos zugeordnet werden können.<br>
Die Namen der zugehörigen Presence Devives könnten in ihrer kürzesten Form auch wie folgt sein um meinen ROOMMATE/GUEST Device zugeordnet zu werden:<br>
pdan
danp
ZDan
DANZ
wenndannsonst
Aber Achtung, es funktioniert nicht mehr wenn die Namen nicht eindeutig sind. Wenn es z.B. eine rr_Dana geben würde mit Presence Device Name "pdani", dann würde dieser Name auch bei mir (dan) passen. Das könnte man aber auch bewußt nutzen um mit einem Presence Device 2 ROOMMATE/GUEST Devices gleichzeitig zu steuern.<br>
Wenn die Namen wirklich absolut eindeutig sind, dann könnte man den Regex im Attribut HomePresenceDeviceType sogar auf ".*" setzen.

Werden pro ROOMMATE/GUEST mehrere Presence Devices gefunden und zugeordnet, so wird automatisch dass Attribut HomePresenceDeviceAbsentCount-<NAME-ROOMMATE/GUEST> auf die Anzahl der gefundenen Presence Devices gesetzt, so dass der/die jeweilige ROOMMATE/GUEST immer erst als abwesend gewertet wird sobald alle zugehörigen Presence Devices abwesend sind. Analog dazu gibt es noch das Attribut HomePresenceDevicePresentCount-<NAME-ROOMMATE/GUEST>.

===Attribute===

====HomeAutoPresence====
Ist dieses Attribut auf 1 gesetzt, so werden die ROOMMATE/GUEST Devices automatisch zum Status ihrer zugehörigen PRESENCE Devices geschaltet.<br>
PRESENCE Device present - ROOMMATE/GUEST home<br>
PRESENCE Device absent - ROOMMATE/GUEST absent<br>
Falls es sich bei den von Euch benutzen PRESENCE Devices nicht um Devices vom TYPE PRESENCE handeln sollte, sondern z.B. um PRESENCE und dummy, so kann dieses im Attribut HomePresenceDeviceType als Regex konfiguriert werden! z.B.: PRESENCE|dummy<br>
Damit ein Device als Presence Device erkannt werden kann, muss dieses über ein presence Reading verfügen.<br>
Werte: 0 oder 1<br>
Standardwert: 0

====HomeAutoPresenceSuppressState====
unterdrücke Anwesenheitsänderung in angegebenen State(s) der RESIDENTS<br>
z.B. für "mysteriös" verschwindende Anwesenheitsgeräte in der Nacht<br>
Werte: asleep|awoken|gotosleep<br>
Standardwert:

====HomePresenceDeviceType====
Regex des TYPEs/der TYPEn von Presence Devices<br>
Werte: Regex der Device TYPEn<br>
Standardwert: PRESENCE

==Erweiterte Konfiguration==
Um das HOMEMODE Device vollumfänglich zu benutzen ist es sinnvoll weitere Devices (zur Überwachung) hinzuzufügen.

Die bereits möglichen hinzuzufügenden Devices werden hier folgend nach Attributnamen erklärt.

===Attribute zum Hinzufügen weiterer Geräte===

====HomeEventsCalendarDevices====
Hier ist ein Devspec von holiday/Calendar Device(s) anzugeben.<br>
''Es wird empfohlen die holiday/Calendar Namen in Großbuchstaben anzulegen, da dann die daraus resultierenden Platzhalter ebenfalls Großbuchstaben sind und somit zu den anderen Platzhaltern passen.''<br>
Es werden alle Typen von holiday Events (1,2,3,4,5) unterstützt.<br>
Bei Calendar sind auch gleichzeitig startende/laufende Events möglich, sie müssen nur unterschiedliche Titel haben (summary).<br>
Der jeweilige Event Text kann auch Leerzeichen enthalten, welche in den HomeCMD Attributen durch Bindestriche (-) ersetzt werden.<br>
Diese Devices stellen zusätzlich die Platzhalter '''%CALENDAR%''', '''%EVENT%''' und '''%PREVEVENT%''' in den HomeCMDevent Attributen zur Verfügung. '''%CALENDAR%''' wird dann durch den Namen, '''%EVENT%''' durch das aktuelle Event und '''%PREVEVENT%''' durch das vorherige Event des jeweiligen Kalenders ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec von holiday/Calendar Geräten<br>
Standardwert:

====HomeEventsHolidayDevices====
Hier ist ein Devspec von holiday/Calendar Device(s) anzugeben.<br>
''Es wird empfohlen die holiday/Calendar Namen in Großbuchstaben anzulegen, da dann die daraus resultierenden Platzhalter ebenfalls Großbuchstaben sind und somit zu den anderen Platzhaltern passen.''<br>
Es werden alle Typen von holiday Events (1,2,3,4,5) unterstützt.<br>
Bei Calendar sind auch gleichzeitig startende/laufende Events möglich, sie müssen nur unterschiedliche Titel haben (summary).<br>
Der jeweilige Event Text kann auch Leerzeichen enthalten, welche in den HomeCMD Attributen durch Bindestriche (-) ersetzt werden.<br>
Diese Devices stellen zusätzlich die Platzhalter '''%CALENDAR%''', '''%EVENT%''' und '''%PREVEVENT%''' in den HomeCMDevent Attributen zur Verfügung. '''%CALENDAR%''' wird dann durch den Namen, '''%EVENT%''' durch das aktuelle Event und '''%PREVEVENT%''' durch das vorherige Event des jeweiligen Kalenders ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec von holiday/Calendar Geräten<br>
Standardwert:

====HomeSensorAirpressure====
Luftdrucksensor aussen<br>
Werte: frei wählbar<br>
Werteformat: Name des Sensors<br>
Standardwert:

====HomeSensorHumidityOutside====
Hier ist der Name des (Haupt)Aussensensors für Luftfeuchtigkeit anzugeben. Dieser muss ein Reading humidity besitzen.<br>
Falls der Sensor für (Aussen)Luftfeuchtigkeit und Aussentemperatur ein und der selbe ist, so muss dieser nur einmalig im Attribut HomeSensorTemperatureOutside hinterlegt werden. Dieser muss dann die beiden Readings humidity und temperature haben. Im Bedarfsfall können diese Readings auch vorher entsprechend durch eigene userReadings erstellt werden.<br>
Dieser Sensor stellt den Platzhalter '''%HUMIDITY%''' für den Wert des Readings humidity zur Verfügung.<br>
Werte: frei wählbar<br>
Werteformat: Device Name mit Reading humidity<br>
Standardwert:

====HomeSensorTemperatureOutside====
Hier ist der Name des (Haupt)Aussentemperatursensors anzugeben. Dieser muss mindestens ein Reading temperature besitzen.<br>
Falls der Sensor für Aussentemperatur auch ein Reading humidity besitzen sollte und dieses auch der Sensor für die Aussenlufteuchtigkeit ist, so muss dieser nur einmalig hier in diesem Attribut hinterlegt werden.<br>
Dieser Sensor stellt den Platzhalter '''%TEMPERATURE%''' für den Wert des Readings temperature zur Verfügung.<br>
Werte: frei wählbar<br>
Werteformat: Device Name mit Reading temperature und optional humidity<br>
Standardwert:

====HomeSensorsContact====
Hier können alle Kontakt Sensoren als Devspec hinterlegt werden.<br>
Diese Devices stellen zusätzlich die Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' in den HomeCMDcontact Attributen zur Verfügung. '''%ALIAS%''' wird dann durch den Alias, '''%SENSOR%''' durch den Namen und '''%STATE%''' durch den aktuellen state des zuletzt ausgelösten Kontakts ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:<br>
''In meinem Falle sind das optische und magnetische Kontaktsensoren vom HomeMatic. HM-SEC-SCo und HM-SEC-SC-2.''<br>
''Darum ist bei mir als Devspec '''model=HM-SEC-SC(o|-2)''' eingetragen um alle diese Kontaktsensoren zu erfassen.''<br>
Nach Übernehmen des Attributs werden alle gefundenen Kontaktsensoren mit ihren Namen im Internal SENSORSCONTACT des HOMEMODE Device einzeln aufgelistet und können dort auch direkt angeklickt werden.<br>
Des weiteren werden beim Übernehmen dieses Attributs jedem Kontaktsensor folgende Attribute im Attribut userattr hinzugefügt:<br>

=====HomeContactType=====
Typ des Kontakts - wird versucht anhand des Namen/Alias beim Hinzufügen zum HOMEMODE Device zu ermitteln, sollte jedoch für jeden Kontaktsensor einzeln überprüft werden<br>
Werte: doorinside,dooroutside,doormain,window<br>
Werteformat: vorgegebene Werteauswahl<br>
Standardwert: window

=====HomeModeAlarmActive=====
Regex der Alarm Mode(s) in denen der Kontaktsensor eine erfolgte Öffnung als Alarm melden soll.<br>
Werte: armaway|armhome|armnight<br>
Werteformat: Regex von Alarm Modes<br>
Standardwert: armaway

=====HomeOpenDontTriggerModes=====
Regex der Mode(s) des HOMEMODE Device in denen keine Offen Warnungen erfolgen sollen.<br>
Ist ein Kontakt geöffnet während die hier eingestellten Mode(s) eintreten, so wird der noch bestehende Timer abgebrochen. Entgegengesetzt startet er wieder sobal die hier eingestellten Mode(s) verlassen werden.<br>
Ist hier z.B. "gotosleep|asleep" eingestellt, so kann man z.B. das Fenster schon vor dem Auslösen von gotosleep oder asleep öffnen und der bestehende Offenwarnung-Timer wird dann abgebrochen. Sobald man am Morgen z.B. awoken oder home auslöst, so wird ein neuer Timer gestartet der einen dann an das noch offene Fenster erinnert.<br>
Werte: alle Modes des HOMEMODE Device<br>
Werteformat: Regex von Modes<br>
Standardwert:

=====HomeOpenDontTriggerModesResidents=====
Devspec der ROOMMATE/GUEST Devices deren Status statt der Modes des HOMEMODE Device für Attribut HomeOpenDontTriggerModes benutzt werden soll.<br>
Werte: alle überwachten ROOMMATE/GUEST<br>
Werteformat: Devspec<br>
Standardwert:

=====HomeOpenMaxTrigger=====
Maximale Anzahl an Warnmeldungen<br>
Werte: 0 bis ~<br>
Werteformat: ganze Zahl<br>
Standardwert:

=====HomeOpenTimes=====
Leerzeichenseparierte Liste von Offen Warnung Zeiten in Minuten.<br>
Der erste Wert entspricht der ersten Zeit, der zweite Wert der zweiten Zeit usw.<br>
Die Anzahl sollte dem Wert im Attribut HomeOpenMaxTrigger entsprechen. Wenn hier weniger Zeiten vorgegeben werden, so wird für weitere Offen Warnungen immer die letzte hier angegebene Zeit verwendet.<br>
Werte: frei wählbar<br>
Werteformat: leerzeichenseparierte Liste von Zahlen mit einer Kommmastelle, z.B. 2.5<br>
Standardwert: 10

=====HomeOpenTimesDividers=====
Leerzeichenseparierte Liste von Offenwarnzeit Teilern.<br>
Es müssen so viele Werte angegeben werden wie in HomeSeasons Jahreszeiten hinterlegt worden sind (Default 4).<br>
Bei einer normalen Offenwarnzeit von 10 Minuten und den hier anzugebenen Teilern z.B. "2 1 2 3" ergeben sich für Frühling und Herbst Offenwarnzeiten von jeweils 5 Minuten und im Winter 3.3 Minuten.<br>
Die hier eingetragenen Werte überschreiben die Werte aus dem Attribut HomeSensorsContactOpenTimeDividers des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: leerzeichenseparierte Liste von Zahlen mit einer Kommmastelle, z.B. 2 1 2 2.5<br>
Standardwert:

=====HomeReadings=====
Zwei leerzeichenseparierte Readings für open und sabotage Status.<br>
Die hier eingetragenen Readings überschreiben die Werte aus dem Attribut HomeSensorsContactReadings des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: zwei Wörter<br>
Standardwert: state sabotageError

=====HomeValues=====
Regex der Werte die für offen und sabotiert stehen.<br>
Die hier eingetragenen Werte überschreiben die Werte aus dem Attribut HomeSensorsContactValues des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: Regex<br>
Standardwert: open|tilted|on

====HomeSensorsContactReadings====
Zwei leerzeichenseparierte Readings für open und sabotage Status.<br>
Die hier eingetragenen Readings sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeReadings in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: zwei Wörter<br>
Standardwert: state sabotageError

====HomeSensorsContactValues====
Regex der Werte die für offen und sabotiert stehen.<br>
Die hier eingetragenen Werte sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeValues in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: Regex<br>
Standardwert: open|tilted|on

====HomeSensorsContactOpenTimeDividers====
Leerzeichenseparierte Liste von Offenwarnzeit Teilern.<br>
Es müssen so viele Werte angegeben werden wie in HomeSeasons Jahreszeiten hinterlegt worden sind (Default 4).<br>
Bei einer normalen Offenwarnzeit von 10 Minuten und den hier anzugebenen Teilern z.B. "2 1 2 3" ergeben sich für Frühling und Herbst Offenwarnzeiten von jeweils 5 Minuten und im Winter 3.3 Minuten.<br>
Die hier eingetragenen Werte sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeOpenTimesDividers in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: leerzeichenseparierte Liste von Zahlen mit max. einer Kommmastelle, z.B. 2 1 2 2.5 (für 4 Jahreszeiten)<br>
Standardwert:

====HomeSensorsContactOpenTimeMin====
Minimale Zeit in Minuten die mindestens für eine Offenwarnung gewartet werden soll - im Falle dass sich durch den Teiler evtl. zu kleine Werte ergeben.<br>
Werte: frei wählbar<br>
Werteformat: eine Zahle mit max. einer Kommmastelle, z.B. 2.5<br>
Standardwert:

====HomeSensorsContactOpenTimes====
Leerzeichenseparierte Liste von Offen Warnung Zeiten in Minuten.<br>
Der erste Wert entspricht der ersten Zeit, der zweite Wert der zweiten Zeit usw.<br>
Die Anzahl sollte dem Wert im Attribut HomeOpenMaxTrigger entsprechen. Wenn hier weniger Zeiten vorgegeben werden, so wird für weitere Offen Warnungen immer die letzte hier angegebene Zeit verwendet.<br>
Werte: frei wählbar<br>
Werteformat: leerzeichenseparierte Liste von Zahlen mit max. einer Kommmastelle, z.B. 7.5<br>
Standardwert: 10

====HomeSensorsLuminance====
Devspec von (Innen-)Lichtsensoren deren Durchschnittswert berechnet werden soll<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

====HomeSensorsMotion====
Hier können alle Bewegungs Sensoren als Devspec hinterlegt werden.<br>
Diese Devices stellen zusätzlich die Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' in den HomeCMDmotion Attributen zur Verfügung. '''%ALIAS%''' wird dann durch den Alias, '''%SENSOR%''' durch den Namen und '''%STATE%''' durch den aktuellen state des zuletzt ausgelösten Kontakts ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

''In meinem Falle sind das Fibaro Motion Sensor Gen4/5.''<br>
''Darum ist bei mir als Devspec '''modelId=010f-0801-1001|010f-0800-1001''' eingetragen um alle diese Bewegungssensoren zu erfassen.''<br>
''Damit bei den Gen5 Sensoren auch das open im reading state steht, habe ich mir bei diesen Sensoren ein userReading angelegt.''<br>
Nach Übernehmen des Attributs werden alle gefundenen Bewegungssensoren mit ihren Namen im Internal SENSORSMOTION des HOMEMODE Device einzeln aufgelistet und können dort auch direkt angeklickt werden.<br>
Des weiteren werden beim Übernehmen dieses Attributs jedem Bewegungssensor folgende Attribute im Attribut userattr hinzugefügt:

=====HomeModeAlarmActive=====
Regex der Alarm Mode(s) in denen der Bewegungssensor eine erfolgte Öffnung als Alarm melden soll.<br>
Werte: armaway|armhome|armnight<br>
Werteformat: Regex von Alarm Modes<br>
Standardwert: armaway

=====HomeReadings=====
2 leerzeichenseparierte Readings für open und sabotage.<br>
Die hier eingetragenen Readings überschreiben die Werte aus dem Attribut HomeSensorsMotionReadings des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: zwei Wörter<br>
Standardwert: state sabotageError

=====HomeSensorLocation=====
Standort des Bewegungssensors (außen oder innen) - wird standardmäßig beim Hinzufügen zum HOMEMODE Device auf "inside" gesetzt, sollte jedoch für jeden Kontaktsensor einzeln überprüft werden<br>
Werte: inside,outside<br>
Werteformat: vorgegebene Werteauswahl<br>
Standardwert: inside

=====HomeValues=====
Regex der Werte die für offen und sabotiert stehen.<br>
Die hier eingetragenen Werte überschreiben die Werte aus dem Attribut HomeSensorsMotionValues des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: Regex<br>
Standardwert: open|on

====HomeSensorsMotionReadings====
2 leerzeichenseparierte Readings für open und sabotage.<br>
Die hier eingetragenen Readings sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeReadings in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: zwei Wörter<br>
Standardwert: state sabotageError

====HomeSensorsMotionValues====
Regex der Werte die für offen und sabotiert stehen.<br>
Die hier eingetragenen Werte sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeValues in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: Regex<br>
Standardwert: open|on

====HomeSensorsPowerEnergy====
Hier können alle Energie Sensoren als Devspec hinterlegt werden. Diese müssen die beiden Readings power und energy besitzen.<br>
Anhand dieser Readings wird dann der Gesamtverbrauch und die derzeitige gesamte Leistungsaufnahme berechnet.<br>
''In meinem Falle sind das Fibaro Wall Plugs Gen4/5.''<br>
''Darum ist bei mir als Devspec '''modelId=010f-0600-1000|010f-0602-1001''' eingetragen um alle diese Energie Sensoren zu erfassen.''<br>
Werte: frei wählbar<br>
Werteformat: Devspec mit vorhandenen energy und power Readings<br>
Standardwert:

====HomeSensorsSmoke====
Devspec mit Rauchmeldern<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

====HomeSensorWindspeed====
Sensor für Windgeschwindigkeit<br>
Werte: frei wählbar<br>
Werteformat: Name des Sensors und Reading der Windgeschwindigkeit separiert mit : (z.B. ga_Windsensor:wind)<br>
Standardwert:

====HomeSensorsBattery====
Devspec von Batteriesensoren mit einem Reading "battery"<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

====HomeTriggerAnyoneElseAtHome====
auslösendes Gerät für anyoneElseAtHome<br>
Werte: frei wählbar<br>
Werteformat: device:reading:valueOn:valueOff<br>
Standardwert:

====HomeTriggerPanic====
auslösendes Gerät für Panikalarm<br>
valueOff ist optional, wird es weggelassen, so fungiert valueOn als toggle<br>
Werte: frei wählbar<br>
Werteformat: device:reading:valueOn[:valueOff]<br>
Standardwert:

====HomeTwilightDevice====
Hier ist der Name des lokalen Twilight Device anzugeben.<br>
Diese Device stellt zusätzlich die Platzhalter '''%LIGHT%''', '''%TWILIGHT%''' und '''%TWILIGHTEVENT%''' in den HomeCMD Attributen zur Verfügung. '''%LIGHT%''' wird dann durch das Reading light, '''%TWILIGHT%''' durch das Reading twilight und '''%TWILIGHTEVENT%''' durch das aktuelle Twilight Event ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

====HomeUWZ====
Hier ist der Name des lokalen UWZ Geräts anzugeben.<br>
Platzhalter '''%UWZ%''', '''%UWZSHORT%''' und '''%UWZLONG%''' sind verfügbar in allen HomeCMD Attributen<br>
Werte: frei wählbar<br>
Werteformat: Name des UWZ Geräts<br>
Standardwert:

====HomeYahooWeatherDevice====
Hier ist der Name des lokalen Yahoo Weather Geräts anzugeben.<br>
Diese Device stellt zusätzlich einige Platzhalter zur Verfügung. Für die genaue Beschreibung derer siehe "Platzhalter".<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

===HomeText Attribute===
Die HomeText Attribute sind größtenteils zur Übersetzung einiger benötigter Begriffe gedacht.<br>
In den speziellen Attributen die mit HomeTextWeather anfangen, sind ganze Texte mit entsprechenden Platzhaltern einzufügen.

====HomeTextAndAreIs====
Übersetzung für "and", "are" und "is"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort/Wörter<br>
Standardwert: and|are|is<br>
'''Beispiel:'''
und|sind|ist

====HomeTextClosedOpen====
Übersetzung für "closed" und "open"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort<br>
Standardwert: closed|open<br>
'''Beispiel:'''
geschlossen|geöffnet

====HomeTextNosmokeSmoke====
Übersetzung für "no smoke" und "smoke"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort<br>
Standardwert: no smoke|smoke<br>
'''Beispiel:'''
kein Rauch|Rauch

====HomeTextRisingConstantFalling====
Übersetzung für "rising", "constant" und "falling"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort<br>
Standardwert: rising|constant|falling<br>
'''Beispiel:'''
steigend|gleichbleibend|fallend

====HomeTextTodayTomorrowAfterTomorrow====
Übersetzung für "today", "tomorrow" und "day after tomorrow"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort<br>
Standardwert: today|tomorrow|day after tomorrow<br>
'''Beispiel:'''
Heute|Morgen|Übermorgen

====HomeTextWeatherNoForecast====
Übersetzung für "No forecast available" - Text wenn keine Wettervorhersage verfügbar ist<br>
Werte: frei wählbar<br>
Werteformat: Text<br>
Standardwert: No forecast available<br>
'''Beispiel:'''
Es ist leider keine Wettervorhersage für den angegebenen Tag verfügbar!

====HomeTextWeatherForecastInSpecDays====
Text mit Platzhaltern für Wettervorhersage in 4-10 Tagen<br>
spezielle Platzhalter die nur in diesem Attribut gültig sind: '''%CONDITION%''', '''%DAY%''', '''%HIGH%''' und '''%LOW%'''<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
In %DAY% Tagen %CONDITION% bei Temperaturen von %LOW% bis %HIGH%°C.

====HomeTextWeatherForecastToday====
Text mit Platzhaltern für Wettervorhersage für heute<br>
spezielle Platzhalter die nur in diesem Attribut gültig sind: '''%CONDITION%''', '''%DAY%''', '''%HIGH%''' und '''%LOW%'''<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
%DAY% %CONDITION% bei Temperaturen von %LOW% bis %HIGH%°C. Aktuelle Temperatur %TEMPERATURE%°C bei einer Luftfeuchtigkeit von %HUMIDITY%%. Die gefühlte Temperatur ist %WINDCHILL%°C bei einer Windgeschwindigkeit von %WIND%km/h.

====HomeTextWeatherForecastTomorrow====
Text mit Platzhaltern für Wettervorhersage für morgen/übermorgen<br>
spezielle Platzhalter die nur in diesem Attribut gültig sind: '''%CONDITION%''', '''%DAY%''', '''%HIGH%''' und '''%LOW%'''<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
%DAY% %CONDITION% bei Temperaturen von %LOW% bis %HIGH%°C.

====HomeTextWeatherLong====
Langer Text mit Platzhaltern für aktuelle Wetterdaten<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
Es %TOBE% %CONDITION% bei %TEMPERATURE%°C und %HUMIDITY%% Luftfeuchtigkeit. Die gefühlte Temperatur ist %WINDCHILL%°C bei einer Windgeschwindigkeit von %WIND%km/h. Der Luftdruck ist %PRESSURETREND% bei %PRESSURE%hPa.

====HomeTextWeatherShort====
Kurzer Text mit Platzhaltern für aktuelle Wetterdaten<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
%CONDITION%, %TEMPERATURE%°C, %HUMIDITY%% Luftfeuchtigkeit, Luftdruck %PRESSURE%hPa

===weitere Attribute===
Viele weitere Dinge lassen sich anpassen.

====HomeAdvancedDetails====
mehr Details anzeigen, abhängig von den zu HOMEMODE hinzugefügten Geräten<br>
Werte: none, detail, both, room<br>
Werteformat: Auswahlliste<br>
Standardwert: none

====HomeDaytimes====
Eigene Tageszeiten als Paare aus Zeit|Wort<br>
Werte: Zeit|Wort Paare separiert mit Leerzeichen<br>
Werteformat: Zeit|Wort<br>
Standardwert: 05:00|morning 10:00|day 14:00|afternoon 18:00|evening 23:00|night<br>
'''Beispiel:'''
00:00|Mitternacht
00:05|Nacht
06:30|Morgen
10:00|Vormittag
13:00|Mittag
14:30|Nachmittag
17:30|Vorabend
19:00|Abend
23:00|Spätabend

====HomeIcewarningOnOffTemps====
2 leerzeichenseparierte Temperaturen für das Ein- und Ausschalten der Eiswarnung.<br>
Werte: frei wählbar<br>
Werteformat: zwei leerzeichenseparierte Temperaturen mit maximal einer Kommastelle<br>
Standardwert: 2 3

====HomeModeAlarmArmDelay====
Zeit in Sekunden um das aktivieren der Alarmschaltung zu verzögern.<br>
Werte: 0 bis 99999<br>
Werteformat: einzelne Zahl (gleiche Verzögerung für alle modeAlarm) oder 3 leerzeichenseparierte Zahlen für jeden modeAlarm (Reihenfolge: armaway armnight armhome)<br>
Standardwert: 0

====HomeAtTmpRoom====
Diesen Raum zu temporäre at(s) hinzufügen die von HOMEMODE generiert werden<br>
Werte: frei wählbar<br>
Werteformat: Wort<br>
Standardwert:

====HomePresenceDeviceAbsentCount-<ROOMMATE/GUEST>====
Anzahl der dem ROOMMATE/GUEST zugeordneten Presence Geräte um den jeweiligen ROOMMATE/GUEST auf "absent" zu setzen<br>
Das Attribut ist nur verfügbar wenn mehr als ein Presence Gerät pro ROOMMATE/GUEST gefunden/zugeordnet wurde<br>
Werte: 0 bis ~<br>
Werteformat: einzelne Zahl<br>
Standardwert: maximale Anzahl von verfügbaren Presence Geräten für jeden ROOMMATE/GUEST

====HomePresenceDevicePresentCount-<ROOMMATE/GUEST>====
Anzahl der dem ROOMMATE/GUEST zugeordneten Presence Geräte um den jeweiligen ROOMMATE/GUEST auf "present" zu setzen<br>
Das Attribut ist nur verfügbar wenn mehr als ein Presence Gerät pro ROOMMATE/GUEST gefunden/zugeordnet wurde<br>
Werte: 0 bis ~<br>
Werteformat: einzelne Zahl<br>
Standardwert: 1

====HomePublicIpCheckInterval====
Interval in Minuten für die Überprüfung der öffentlichen IP-Adresse<br>
Werte: 0 bis 99999<br>
Werteformat: einzelne Zahl<br>
Standardwert: 0 (deaktiviert)

====HomeSeasons====
Eigene Jahreszeiten als Paare aus Datum|Wort<br>
Werte: Datum|Wort Paare separiert mit Leerzeichen<br>
Werteformat: Datum|Wort<br>
Standardwert: 03.01|spring 06.01|summer 09.01|autumn 12.01|winter<br>
'''Beispiel:'''
03.01|Frühling
06.01|Sommer
09.01|Herbst
12.01|Winter

====HomeSensorsBatteryLowPercentage====
Prozentsatz um einen Batteriesensor mit geringer Batterie anzuzeigen (nur bei Sensoren die ihren Batteriewert prozentual angeben)<br>
Werte: frei wählbar<br>
Werteformat: Zahl<br>
Standardwert: 50

====HomeSensorsBatteryReading====
Reading der Batteriesensoren welches statt "battery" benutzt werden soll<br>
Werte: frei wählbar<br>
Werteformat: einzelnes Wort<br>
Standardwert: battery

====HomeSensorsLuminanceReading====
Reading der Lichtsensoren welches statt "luminance" benutzt werden soll<br>
Werte: frei wählbar<br>
Werteformat: einzelnes Wort<br>
Standardwert: luminance

====HomeSensorsPowerEnergyReadings====
Readings der Power/Energy Sensoren welche statt "power" und "energy" benutzt werden sollen<br>
Werte: frei wählbar<br>
Werteformat: 2 leerzeichenseparierte Wörter<br>
Standardwert: power energy

====HomeSensorsSmokeReading====
Readings der Rauchmelder welche statt "state" benutzt werden sollen<br>
Werte: frei wählbar<br>
Werteformat: ein Wort<br>
Standardwert: state

====HomeSensorsSmokeValue====
Regex der Auslösewerte von Rauchmeldern<br>
Werte: frei wählbar<br>
Werteformat: RegEx<br>
Standardwert: on

====HomeSpecialLocation====
Hier können eigene zusätzliche location(s) als kommaseparierte Liste angegeben werden.<br>
Diese können dann über "set <HOMEMODE> location <LOCATION>" gesetzt werden. Dazu passend werden HomeCMD Attribute erstellt.<br>
Werte: frei wählbar<br>
Werteformat: kommaseparierte Liste von Wörtern<br>
Standardwert:

====HomeSpecialModes====
Hier können eigene zusätzliche mode(s) als kommaseparierte Liste angegeben werden.<br>
Diese können dann über "set <HOMEMODE> mode <MODE>" gesetzt werden. Dazu passend werden HomeCMD Attribute erstellt.<br>
Werte: frei wählbar<br>
Werteformat: kommaseparierte Liste von Wörtern<br>
Standardwert:

====HomeTrendCalcAge====
Zeit in Sekunden für das Maximalalter des vorherigen Wertes für die Trendberechnung<br>
Werte: frei wählbar<br>
Werteformat: Zeit in Sekunden<br>
Standardwert: 900

Ein weiterer Teil der Konfiguration ist das Befüllen der HomeCMD Attribute. Da dieses durch die Vermischung von FHEM Code, Perl Code und zusätzlichen Platzhaltern erst einmal sehr befremdlich sein kann, habe ich bei der Beschreibung der HomeCMD Attribute teilweise Beispiele hinzugefügt um den Einstieg weiter zu erleichtern.

==HomeCMD Attribute (mit Beispielen)==
Die HomeCMD Attribute sind zum Festlegen der jeweiligen Schaltaktionen gedacht und können damit evtl. vorhandene notify/DOIF ablösen. Sie können mit FHEM-Code, Perl-Code oder aber auch mit beidem vermischt befüllt werden (wovon ich allerdings abrate). Zusätzlich sind noch diverse Platzhalter (siehe Platzhalter) verfügbar.

'''Bei Perl-Code innerhalb der HomeCMD Attribute gibt es hier Besonderheiten.'''<br>
*Im Gegensatz zur FHEM-Eingabezeile müssen hier keine Semikolon verdoppelt werden
*Kommetarzeilen sind zulässig
*Kommentare am Ende einer Perl-Zeile sind nicht zulässig

Typischer Weise werden in den HomeCMD Attributen weitere Module angesprochen.<br>
Z.B. benutze ich für jegliche Form der Benachrichtigung den msg Befehl.

Keines der HomeCMD Attribute hat einen Standardwert. Es müssen alle Befehle selbst programmiert werden.

Platzhalter die Text(e) (string) beinhalten, müssen im Perl-Code in Anführungszeichen gesetzt werden (Beispiel %SENSOR%).<br>
Platzhalter die Zahlen beinhalten (int,float) sollten nicht in Anführungszeichen gesetzt werden damit Zahlenvergleiche (mittels ==, <=, >=, >, <) funktionieren (Beispiel %LIGHT%, %ICE% oder %TEMPERATURE%).

====HomeCMDalarmSmoke====
Befehle die beim Anfang/Ende eines Rauchalarms ausgeführt werden sollen.<br>

====HomeCMDalarmSmoke-off====
Befehle die beim Ende eines Rauchalarms ausgeführt werden sollen.<br>
Auslöser: Ende Rauchalarm eines beliebigen (von HOMEMODE überwachten) Rauchmelders<br>
'''Beispiel:'''
msg push ENTWARNUNG: Alle Rauchalarme sind beendet!

====HomeCMDalarmSmoke-on====
Befehle die bei einem Rauchalarm ausgeführt werden sollen.<br>
Auslöser: Rauchalarm eines beliebigen (von HOMEMODE überwachten) Rauchmelders<br>
'''Beispiel:'''
{
my $is = "meldet";
$is = "melden" if (%SMOKECT% > 1);
fhem "msg push ACHTUNG: %SMOKEHR% $is Rauchalarm!";
}

====HomeCMDalarmTampered====
Befehle die beim Anfang/Ende eines Sabotage Alarms ausgeführt werden sollen.

====HomeCMDalarmTampered-off====
Befehle die beim Ende eines Sabotage Alarms ausgeführt werden sollen.<br>
Auslöser: Ende Sabotage Alarm eines beliebigen (von HOMEMODE überwachten) Kontakt-/Bewegungs-Sensors<br>
'''Beispiel:'''
msg push ENTWARNUNG: Alle Manipulationen wurden beseitigt!

====HomeCMDalarmTampered-on====
Befehle die bei einem Sabotage Alarm ausgeführt werden sollen.<br>
Auslöser: Sabotage Alarm eines beliebigen (von HOMEMODE überwachten) Kontakt-/Bewegungs-Sensors<br>
'''Beispiel:'''
{
my $is = "ist";
$is = "sind" if (%TAMPEREDCT% > 1);
fhem "msg push ACHTUNG: %TAMPEREDHR% $is sabotiert!";
}

====HomeCMDalarmTriggered====
Befehle die beim Anfang/Ende eines Alarms ausgeführt werden sollen.

====HomeCMDalarmTriggered-off====
Befehle die beim Ende eines Alarms ausgeführt werden sollen.<br>
Auslöser: Ende Alarm eines beliebigen (von HOMEMODE überwachten) Kontakt-/Bewegungs-Sensors<br>
'''Beispiel:'''
msg ENTWARNUNG: Alle Alarme sind beendet!

====HomeCMDalarmTriggered-on====
Befehle die bei einem Alarm ausgeführt werden sollen.<br>
Auslöser: Alarm eines beliebigen (von HOMEMODE überwachten) Kontakt-/Bewegungs-Sensors<br>
'''Beispiel:'''
{
my $is = "ist";
$is = "sind" if (%ALARMCT% > 1);
fhem "msg audio,push,light 3 !!! ALARM !!! %ALARMHR% $is ausgelöst!";
}

====HomeCMDanyoneElseAtHome====
Befehle die beim on/off von anyoneElseAtHome ausgeführt werden sollen.

====HomeCMDanyoneElseAtHome-off====
Befehle die ausgeführt werden sollen sobald anyoneElseAtHome deaktiviert wird.<br>
Bei Abwesenheit und nicht deaktiviertem HomeAutoAlarmModes wird der Alarm Mode von "armaway" auf "armhome" umgeschaltet damit evtl. vorhandene Bewegungsmelder keinen Alarm mehr melden.<br>
Auslöser: anyoneElseAtHome on<br>
'''Beispiel:'''
msg HINWEIS: Es ist nun niemand anderes mehr zu Hause!

====HomeCMDanyoneElseAtHome-on====
Befehle die ausgeführt werden sollen sobald anyoneElseAtHome aktiviert wird.<br>
Bei Abwesenheit und nicht deaktiviertem HomeAutoAlarmModes wird der Alarm Mode von "armhome" auf "armaway" umgeschaltet damit evtl. vorhandene Bewegungsmelder wieder Alarme melden können.<br>
Wird anyoneElseAtHome bei Anwesenheit und nicht deaktiviertem HomeAutoAlarmModes aktiviert, so passiert erst einmal nichts, ausser dass die hier angegebenen Befehle ausgeführt werden. Wird dann später die Abwesenheit erkannt, schaltet der Alarm Mode auf "armhome" statt auf "armaway" damit evtl. vorhandene Bewegungsmelder keinen Alarm mehr melden.<br>
Auslöser: anyoneElseAtHome off<br>
'''Beispiel:'''
msg HINWEIS: Es ist nun noch jemand anderes zu Hause!

====HomeCMDbatteryLow====
Befehle die ausgeführt werden sollen sobald ein Sensor einen niedrigen Batteriewert meldet.<br>
'''Beispiel:'''
{
my $msg;
$msg = "Die Batterien von %BATTERYLOW% gehen zur Neige und sollten ausgetauscht werden!" if (%BATTERYLOWCT% == 1);
$msg = "Die Batterien bei folgenden Geräten sollten ausgetauscht werden: %BATTERYLOWALL%" if (%BATTERYLOWCT% > 1);
fhem "msg push $msg";
}

====HomeCMDcontact====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor open/tilted/closed meldet.<br>
Die speziellen Platzhalter %ALIAS%, %SENSOR% und %STATE% können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor open/tilted/closed<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun %STATE%!";
}

====HomeCMDcontactClosed====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor geschlossen meldet.<br>
Die speziellen Platzhalter %ALIAS%, %SENSOR% und %STATE% können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor closed<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun geschlossen!";
}

====HomeCMDcontactOpen====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor offen meldet.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor open/tilted<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun offen!";
}

====HomeCMDcontactDoormain====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor des Types doormain open/tilted/closed meldet.<br>
Die speziellen Platzhalter %ALIAS%, %SENSOR% und %STATE% können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor Type doormain open/tilted/closed<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun %STATE%!";
}

====HomeCMDcontactDoormainClosed====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor des Types doormain closed meldet.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor vom Typ doormain wird geschlossen<br>
'''Beispiel:'''
{
# Wenn es Ankommende gibt
if ("%ARRIVERS%")
{
# Zusammenstellen der Begrüßung
my $msg = "Gute";

# "n" anhängen wenn Tageszeit nicht Nacht ist
$msg .= "n" if ("%DAYTIME%" ne "Nacht");

# Leerzeichen einfügen
$msg .= " ";

# den Feiertag der Tageszeit voranstellen wenn ein Feiertag im Kalender FEIERTAG ist
$msg .= "%FEIERTAG%-" if ("%FEIERTAG%");

# Tageszeit einfügen
$msg .= "%DAYTIME% ";

# bei ROOMMATE "zu Hause" in Begrüßung einfügen
$msg .= "zu Hause " if ("%RESIDENT%" =~ /^rr_/);

# Ankommende einfügen
$msg .= "%ARRIVERS%";

# Begrüßung am Sonos im Flur ausgeben bei Abwesenheit über 60 min
fhem "msg audio \@fl_Sonos $msg!" if (%DURABSENCELAST% > 60);
}
}

====HomeCMDcontactDoormainOpen====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor des Types doormain open/tilted meldet.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor vom Typ doormain geöffnet<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun geöffnet!";
}

====HomeCMDcontactOpenWarning1====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor die erste Offenwarnzeit erreicht hat.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: erste Offenwarnzeit des Kontakts erreicht<br>
'''Beispiel:'''
msg audio %ALIAS% steht noch offen!

====HomeCMDcontactOpenWarning2====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor die zweite Offenwarnzeit erreicht hat.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: ab Erreichen der zweiten Offenwarnzeit des Kontakts<br>
'''Beispiel:'''
msg audio %ALIAS% steht immer noch offen!

====HomeCMDcontactOpenWarningLast====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor die letzte Offenwarnzeit erreicht hat.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: Erreichen der letzten Offenwarnzeit des Kontakts<br>
'''Beispiel:'''
msg audio Das ist der letzte Hinweis %ALIAS% endlich zu schliessen!

====HomeCMDdaytime====
Befehle die ausgeführt werden sollen sobald sich die Tageszeit (daytime) auf einen beliebigen Wert ändert.<br>
Um die jeweilige eingetretene Tageszeit zu ermitteln ist der Platzhalter '''%DAYTIME%''' vorgesehen.<br>
Auslöser: Änderung der Tageszeit (daytime)

====HomeCMDdaytime-<DAYTIME>====
Befehle die ausgeführt werden sollen sobald die jeweilige Tageszeit (daytime) erreicht ist.<br>
Auslöser: Änderung der Tageszeit (daytime) auf bestimmten Wert<br>
Bei "night" könnte man z.B. die Heizung bewohnerunabhängig ausschalten, bei "morning" wieder ein.

====HomeCMDdeviceDisable====
Befehle die ausgeführt werden sollen sobald ein Gerät deaktiviert wird.<br>
Auslöser: 'set deviceDisable <DEVICE>'<br>
'''Beispiel:'''
{
speak "Das Gerät %ALIAS% ist nun deaktiviert!";

# optional wirklich attr disable für Device setzen und Konfig speichern
#fhem "attr %DEVICE%:FILTER=disable!=1 disable 1; save";

# ROOMMATE/GUEST auf gone/none setzen wenn Presence Devices deaktiviert werden
if ("%DEVICE%" =~ /^PRESENCE\d?_(r[rg]_.*)/)
{
my $resident = $1;
my $gone = $resident =~ /^rr_/ ? "gone" : "none";
fhem "set $resident:FILTER=state!=$gone state $gone";
}
}

====HomeCMDdeviceEnable====
Befehle die ausgeführt werden sollen sobald ein Gerät aktiviert wird.<br>
Auslöser: 'set deviceEnable <DEVICE>'<br>
'''Beispiel:'''
{
speak "Das Gerät %ALIAS% ist nun aktiviert!";

# optional attr disable für Device entfernen und Konfig speichern
#fhem "deleteattr %DEVICE%:FILTER=disable=1 disable; save";

# ROOMMATE/GUEST auf home setzen wenn Presence Devices aktiviert werden und anwesend sind
if ("%DEVICE%" =~ /^PRESENCE\d?_(r[rg]_.*)/)
{
fhem "set $1:FILTER=state!=home state home" if (ReadingsVal("%DEVICE%","presence","") eq "present");
}
}

====HomeCMDdnd====
Befehle die beim Anfang/Ende des DND Modus ausgeführt werden sollen.<br>
Auslöser: Ende des DND Modus<br>
'''Beispiel:'''
{
if (%DND%)
{
fhem "msg audio Der DND Modus ist nun eingeschaltet!";
}
else
{
fhem "msg audio Der DND Modus ist nun beendet!";
}
}

====HomeCMDdnd-off====
Befehle die beim Ende des DND Modus ausgeführt werden sollen.<br>
Auslöser: Ende des DND Modus<br>
'''Beispiel:'''
msg audio Der DND Modus ist nun beendet!

====HomeCMDdnd-on====
Befehle die beim Beginn des DND Modus ausgeführt werden sollen.<br>
Auslöser: Beginn des DND Modus<br>
'''Beispiel:'''
msg audio Der DND Modus ist nun eingeschaltet!

====HomeCMDevent====
Befehle die beim Beginn eines beliebigen (holiday)Kalender Events ausgeführt werden sollen.<br>
Auslöser: Beginn eines beliebigen (holiday)Kalender Events<br>
Platzhalter '''%CALENDAR%''', '''%EVENT%''' und '''%PREVEVENT%''' können zusätzlich verwendet werden<br>
'''Beispiel:'''
{
fhem "set Weihnachten on" if ("%EVENT%" eq "Weihnachten");
fhem "set Weihnachten off" if ("%PREVEVENT%" eq "Weihnachten");
}

====HomeCMDevent-<KALENDER>-each====
Befehle die beim Beginn/Ende eines beliebigen (holiday)Kalender Events eines bestimmten KALENDERs ausgeführt werden sollen.<br>
Auslöser: Beginn eines beliebigen (holiday)Kalender Events eines bestimmten KALENDERs<br>
Platzhalter '''%EVENT%''' und '''%PREVEVENT%''' können zusätzlich verwendet werden<br>
'''Beispiel für "HomeCMDevent-FEIERTAGE-each":'''
{
fhem "set Weihnachten off" if ("%PREVEVENT%" eq "Weihnachten");
}
'''Beispiel für "HomeCMDevent-URLAUBDAN-each":'''
{
if ("%EVENT%" =~ /urlaub/i)
{
speak "Dan hat jetzt Urlaub!!!";
}
elsif ("%PREVEVENT%" =~ /urlaub/i)
{
speak "Der Urlaub von Dan ist nun zu Ende!!!";
}
}

'''Beispiel für "HomeCMDevent-WOHNUNG-each":'''
{
# Heizung an/aus schalten
my $heiz = "([bksw]z|ku)_Thermostat";
if ("%EVENT%" =~ /^heizung(..+)?$/i)
{
my $zeit = $1;
if ("%SEASON%" ne "Sommer")
{

# morgens nicht alle Thermostaten schalten
$heiz = "([bks]z|ku)_Thermostat" if ($zeit && $zeit =~ /morgens?$/i);
fhem "set $heiz:FILTER=controlMode!=day controlMode day"
}
}
elsif ("%PREVEVENT%" =~ /^heizung/i)
{
fhem "set $heiz:FILTER=controlMode!=night controlMode night" if ("%SEASON%" ne "Sommer");
}

# WLAN an/aus schalten
elsif ("%EVENT%" =~ /^wlan|wifi|wi-fi/i)
{
fhem "set Router wifi off";
}
elsif ("%PREVEVENT%" =~ /^wlan|wifi|wi-fi/i)
{
fhem "set Router wifi on";
}

# G-Tag für Putzfrau (de)aktivieren
elsif ("%EVENT%" =~ /^putz/i)
{
fhem "set %NAME% deviceEnable PRESENCE_rg_Inge";
}
elsif ("%PREVEVENT%" =~ /^putz/i)
{
fhem "set %NAME% deviceDisable PRESENCE_rg_Inge";
}

# G-Tag für Gast (de)aktivieren
elsif ("%EVENT%" =~ /g([aä]|ae)st/i)
{
fhem "set %NAME% deviceEnable PRESENCE_rg_Gast";
}
elsif ("%PREVEVENT%" =~ /g([aä]|ae)st/i)
{
fhem "set %NAME% deviceDisable PRESENCE_rg_Gast";
}
}

====HomeCMDevent-<KALENDER>-<EVENT>-begin====
Befehle die beim Beginn eines bestimmten (holiday)Kalender EVENTs eines bestimmten KALENDERs ausgeführt werden sollen.<br>
Auslöser: Beginn eines bestimmten (holiday)Kalender EVENTs eines bestimmten KALENDERs<br>
Platzhalter '''%PREVEVENT%''' kann zusätzlich verwendet werden<br>
'''Beispiel für "HomeCMDevent-FEIERTAGE-Neujahr-begin":'''
set %SENSORSENERGY% meterReset

====HomeCMDevent-<KALENDER>-<EVENT>-end====
Befehle die bei Ende der (holiday)Kalender EVENTs eines bestimmten KALENDERs ausgeführt werden sollen.<br>
Auslöser: Ende der (holiday)Kalender EVENTs eines bestimmten KALENDERs<br>
Platzhalter '''%PREVEVENT%''' kann zusätzlich verwendet werden

====HomeCMDfhemDEFINED====
Befehle die ausgeführt werden sollen wenn ein neues Gerät angelegt wird (define)<br>
'''Beispiel:'''
{
# Jedem neu definierten Gerät den Geräte-TYPE auch als Raum im Menüpunkt Module zuweisen
fhem "attr %DEFINED% room Module->".$defs{"%DEFINED%"}->{TYPE};
}

====HomeCMDfhemINITIALIZED====
Befehle die ausgeführt werden sollen wenn FHEM gestartet wurde<br>
'''Beispiel:'''
msg FHEM Home wurde gestartet...

====HomeCMDfhemSAVE====
Befehle die ausgeführt werden sollen wenn in FHEM die Konfigurationsdatei gespeichert wird<br>
'''Beispiel (Backup von fhem.cfg und fhem.state):'''
{
# Datum/Uhrzeit
my $now = Timeow();
# Leerzeichen durch Unterstriche ersetzen
$now =~ s/ /_/g;
# Backup der Datei fhem.cfg
`cp $attr{global}{configfile} ./backup/fhem.cfg.$now`;
# Log-Ausgabe der gespeicherten Datei
Log3 undef,3,"saved ./backup/fhem.cfg.$now";
# Backup der Datei fhem.state
`cp $attr{global}{statefile} ./backup/fhem.state.$now`;
# Log-Ausgabe der gespeicherten Datei
Log3 undef,3,"saved ./backup/fhem.state.$now";
}

====HomeCMDfhemUPDATE====
Befehle die ausgeführt werden sollen wenn das Update von FHEM ausgeführt wurde<br>
'''Beispiel:'''
msg audio Das Update für FHEM ist beendet!

====HomeCMDicewarning====
Befehle die bei Anfang/Ende der Eiswarnung ausgeführt werden sollen<br>
Auslöser: icewarning 0/1<br>
'''Beispiel:'''
{
if (%ICE%)
{
fhem "msg push ACHTUNG!!! Es sind nur noch %TEMPERATURE%°C! Somit könnte es glatt werden!";
}
else
{
fhem "msg audio Es sind wieder %TEMPERATURE%°C! Die Glättewarnung ist damit beendet!.";
}
}

====HomeCMDicewarning-off====
Befehle die bei Ende der Eiswarnung ausgeführt werden sollen<br>
Auslöser: icewarning 0<br>
'''Beispiel:'''
msg audio Es sind wieder %TEMPERATURE%°C! Die Glättewarnung ist damit beendet!

====HomeCMDicewarning-on====
Befehle die bei Beginn der Eiswarnung ausgeführt werden sollen<br>
Auslöser: icewarning 1<br>
'''Beispiel:'''
msg audio ACHTUNG!!! Es sind nur noch %TEMPERATURE%°C! Somit könnte es glatt werden!

====HomeCMDlocation====
Befehle die beim Ändern der location ausgeführt werden sollen.<br>
Auslöser: Änderung location

====HomeCMDlocation-<LOCATION>====
Befehle die bei Änderung auf eine bestimmte location ausgeführt werden sollen.<br>
Auslöser: Änderung auf bestimmte location

====HomeCMDmode====
Befehle die beim Ändern von mode ausgeführt werden sollen.<br>
Auslöser: Änderung mode

====HomeCMDmode-absent-belated====
Befehle die nachträglich zur Abwesenheit ausgeführt werden sollen, die Zeit kann im Atteribut "HomeModeAbsentBelatedTime" eingestellt werden<br>
Auslöser: Abwesenheit + XX min<br>
'''Beispiel:'''
set Heizungen [FILTER=controlManu!=off] controlMode night

====HomeCMDmode-<MODE>====
Befehle die bei Änderung auf einen bestimmten mode ausgeführt werden sollen.<br>
Auslöser: Änderung auf bestimmten mode<br>
'''Beispiel für "HomeCMDmode-absent":'''
set HarmonyHub:FILTER=activity!=PowerOff activity PowerOff;
set wz_Ventilator:FILTER=speed!=0 speed 0;
set TYPE=SONOSPLAYER:FILTER=Volume>0 Volume 0;
set Sonos stopAll;
sleep 3;
set Wohnung [FILTER=state!=off] off"
'''Beispiel für "HomeCMDmode-asleep":'''
define atTmp_wz_Media_aus_%SELF% at +01:00:00 set HarmonyHub:FILTER=currentActivity!=PowerOff activity PowerOff;
define atTmp_wz_Venti_aus_%SELF% at +01:00:00 set wz_Ventilator:FILTER=speed!=0 speed 0;
define atTmp_wzLS_aus_%SELF% at +00:30:00 set wz_LS scene aus;
define atTmp_all_Sonos_vol_down_%SELF% at +00:02:00 set TYPE=SONOSPLAYER:FILTER=Volume!=0 Volume 0 1;
define atTmp_all_Sonos_off_%SELF% at +00:02:30 set Sonos stopAll;
set [sw]z_Auto(Music|Light):FILTER=state!=off off;
set Heizungen [FILTER=controlManu!=off] controlMode night
'''Beispiel für "HomeCMDmode-awoken":'''
set [sw]z_Auto(Music|Light):FILTER=state!=on on
'''Beispiel für "HomeCMDmode-gone":'''
set Heizungen [FILTER=controlManu!=off] controlManu off

====HomeCMDmode-<MODE>-resident====
Befehle die bei Änderung auf einen bestimmten mode, ausgelöst durch einen beliebigen Resident, ausgeführt werden.<br>
Auslöser: Änderung mode von beliebigem Resident ausgelöst<br>
'''Beispiel für "HomeCMDmode-asleep-resident":'''
msg audio @%AUDIO% Guten Nacht und schlaf' gut %ALIAS%!
'''Beispiel für "HomeCMDmode-awoken-resident":'''
{
my $msg = "Guten";
$msg .= " %FEIERTAG%" if ("%FEIERTAG%");
$msg .= " Morgen %ALIAS%";
fhem "msg audio \@%AUDIO% $msg";
fhem "defmod atTmp_wetter_%RESIDENT%_%SELF% at +00:07:00 msg audio Wettervorhersage für heute: %FORECASTTODAY%";
}

====HomeCMDmode-<MODE>-<ROOMMATE/GUEST>====
Befehle die bei Änderung auf einen bestimmten mode, ausgelöst durch einen bestimmten Resident, ausgeführt werden.<br>
Auslöser: Änderung mode von bestimmten Resident ausgelöst

====HomeCMDmodeAlarm====
Befehle die beim Ändern von modeAlarm ausgeführt werden sollen.<br>
Auslöser: Änderung modeAlarm

====HomeCMDmodeAlarm-<armaway/armhome/armnight/disarm>====
Befehle die bei Änderung auf einen bestimmten modeAlarm ausgeführt werden sollen.<br>
Auslöser: Änderung auf bestimmten modeAlarm<br>
'''Beispiel für "HomeCMDmodeAlarm-armaway":'''
{
if ("%PREVAMODE%" eq "disarm")
{
# Alarmanlage einschalten
fhem "set AA_Arm:FILTER=level!=100 alarmLevel armAll";

# Nachricht zusammensetzen
my $msg;
$msg .= "Die Alarmanlage ist nun scharf geschaltet!" if ("%RESIDENT%" ne "rr_Dan");
my $is = "%ALARMHR%" =~ /und/ ? "sind" : "ist";
$msg .= " " if ($msg);
$msg .= "ACHTUNG: %ALARMHR% $is noch offen!!!" if (%ALARMCT%);

# Nachricht an ROOMMATE/GUEST senden
fhem "msg \@%RESIDENT% $msg" if ($msg);

# Eingangstür abschließen falls noch nicht geschehen
fhem "set fl_Tuerschloss:FILTER=state!=locked lock";
}
}
'''Beispiel für "HomeCMDmodeAlarm-armhome":'''
AA_Arm:FILTER=level!=25 alarmLevel armExtSens;
set fl_Tuerschloss:FILTER=state!=locked lock
'''Beispiel für "HomeCMDmodeAlarm-armnight":'''
AA_Arm:FILTER=level!=25 alarmLevel armExtSens;
set fl_Tuerschloss:FILTER=state!=locked lock
'''Beispiel für "HomeCMDmodeAlarm-disarm":'''
{
# Alarmanlage ausschalten
fhem "set AA_Arm:FILTER=level!=0 alarmLevel disarmed";
my $prio = "";

# Nachrichtenpriorität auf 1 setzen bei Ankunft (höhere Lautstärke beim Abspielen damit man das auch vor der Tür hört)
$prio = " 1" if ("%LOCATION%" eq "arrival");

# Nachricht an ROOMMATE/GUEST senden wenn der vorherige alarmMode nicht "armnight" ist
fhem "msg audio \@fl_Sonos$prio Die Alarmanlage ist nun ausgeschaltet %ALIAS%!" if ("%PREVAMODE%" ne "armnight");
}

====HomeCMDmotion====
Befehle die bei Statusänderung eines beliebigen Bewegungsmelders ausgeführt werden sollen<br>
Auslöser: öffnen/schließen eines beliebigen Bewegungsmelders<br>
'''Beispiel:'''
{
# Raum aus Sensornamen ermitteln, z.B. bz_Sensor
my $room = (split /_/,"%SENSOR%")[0];

# Status des structure aller Lichter dieses Raums
my $lichter = Value($room."_Lichter");

# Status des dummy Tageslicht
my $tl = Value("Tageslicht");

if ("%STATE%" eq "geöffnet")
{
# Lichtwert des Sensors
my $lum = ReadingsNum("%SENSOR%","luminance",100);

# Löschen des evtl. schon vorhandenen "at"
fhem "delete atTmp_Bewegungsmelder_Licht_aus_".$room."_%SELF%" if (IsDevice("atTmp_Bewegungsmelder_Licht_aus_".$room."_%SELF%"));

# Licht nur wenn kein Tageslicht oder Lichtwert des Sensors kleiner als 10 und AutoLight eingeschaltet und modeAlarm nicht armaway
if (($tl eq "off" || $lum < 10) && $lichter eq "off" && Value($room."_AutoLight") eq "on" && "%AMODE%" ne "armaway")
{
my $scene;

# verschiedene Szenen für verschiedene Modus bzw. Aussenlichtstärken
if ("%MODE%" eq "gotosleep")
{
$scene = "Abend";
}
elsif ("%MODE%" eq "asleep")
{
$scene = "Nacht";
}
elsif (%LIGHT% > 3)
{
$scene = "viel";
}
elsif (%LIGHT% < 4)
{
$scene = "mittel";
}

# Schalten der entsprechenden Szene (Modul LightScene)
fhem "set ".$room."_LS scene $scene" if ($scene);
}
}
else
{
# unterschiedliche Ausschaltzeiten für unterschiedliche Räume
my $t = 3;
$t = 15 if ($room eq "wz");
$t = 2 if ($room eq "bz" || ($room =~ /wz|ku/ && "%MODE%" =~ /sleep/));
$t = 1 if ($room eq "fl");

# Zahl in Minuten umrechnen in einen Zeitpunkt für das "at"
my $d = HOMEMODE_hourMaker($t);

# Anlegen des "at" zum Ausschalten des Lichts wenn die Lichter angeschaltet sind und auch AutoLight eingeschaltet ist
if ($lichter ne "off" && Value($room."_AutoLight") eq "on")
{
my $cmd = "set ".$room."_LS scene aus";
fhem "defmod atTmp_Bewegungsmelder_Licht_aus_".$room."_%SELF% at +$d $cmd";
}
}
}

====HomeCMDmotion-off====
Befehle die bei Ende der Bewegung eines beliebigen Bewegungsmelders ausgeführt werden sollen<br>
Auslöser: Ende der Bewegung eines beliebigen Bewegungsmelders

====HomeCMDmotion-on====
Befehle die bei Beginn der Bewegung eines beliebigen Bewegungsmelders ausgeführt werden sollen<br>
Auslöser: Beginn der Bewegung eines beliebigen Bewegungsmelders

====HomeCMDpresence-<absent/present>====
Befehle die bei Änderung von presence ausgeführt werden sollen<br>
Auslöser: Änderung presence<br>
'''Beispiel für "HomeCMDpresence-present":'''
set w_Steckdosen [FILTER=state!=on] on;
set Heizungen [FILTER=controlManu!=off] controlMode auto

====HomeCMDpresence-<absent/present>-device====
Befehle die bei Änderung von presence, ausgelöst durch ein beliebiges Presence Device, ausgeführt werden sollen<br>
Auslöser: Änderung presence, ausgelöst durch beliebiges Presence Device<br>
'''Beispiel für "HomeCMDpresence-present-device":'''
{
# mindestens 1x täglich den Batteriewert des PRESENCE Geräts bei erkannter Anwesenheit holen
fhem '"sudo /opt/fhem/scripts/GTag-bat.sh %DEVICE% %ADDRESS% &"'
if ("%DEVICE%" =~ /^PRESENCE_/ && (!defined ReadingsVal("%DEVICE%","battery",undef) || ReadingsAge("%DEVICE%","battery",0) > 64800));
}

====HomeCMDpresence-<absent/present>-resident====
Befehle die bei Änderung von presence, ausgelöst durch einen beliebigen Resident, ausgeführt werden sollen<br>
Auslöser: Änderung presence, ausgelöst durch beliebigen Resident<br>
'''Beispiel für "HomeCMDpresence-absent-resident":'''
{
# Mich benachrichtigen wenn ich nicht zu hause bin und jemand anderes die Wohnung verlässt
fhem "msg push \@rr_Dan %ALIAS% hat gerade die Wohnung verlassen!"
if ("%RESIDENT%" ne "rr_Dan" && ReadingsVal("rr_Dan","presence","") ne "present");

# Verabschiedungsnachricht zusammensetzen
my $msg;

# Alle außer mich selbst verabschieden
$msg .= "Bis bald und auf Wiedersehen %ALIAS%..." if ("%RESIDENT%" ne "rr_Dan");

# Glättewarnung wenn nötig
$msg .= " ACHTUNG!!! Es ist %TEMPERATURE%°C kalt! Somit könnte es glatt werden!" if (%ICE%);

# Nachricht senden wenn vorhanden
fhem "msg \@%RESIDENT% $msg" if ($msg);
}
'''Beispielcode für "HomeCMDpresence-present-resident":'''
{
# alle Ankommenden außer mir selbst
if ("%RESIDENT%" ne "rr_Dan")
{
# Benachrichtigung wenn jemand kommt
fhem "msg audio %ALIAS% kommt gerade!" if ("%LOCATION%" ne "arrival");

# Nachricht an Ankommende(n) zusammensetzen
my $g = "gute";
$g .= "n" if ("%DAYTIME%" ne "Nacht);

# Nachricht an Ankommende(n) senden
fhem "msg \@%RESIDENT% Willkommen und $g %DAYTIME% %ALIAS%!";
}
}

====HomeCMDpresence-<absent/present>-<ROOMMATE/GUEST>====
Befehle die bei Änderung von presence, ausgelöst durch einen bestimmten Resident, ausgeführt werden sollen<br>
Auslöser: Änderung presence, ausgelöst durch bestimmten Resident<br>

====HomeCMDpresence-<absent/present>-<ROOMMATE/GUEST>-<DEVICE>====
Befehle die bei Änderung von presence, ausgelöst durch ein bestimmtes Presence Device eines bestimmten Resident, ausgeführt werden sollen<br>
Dieses Attribut ist nur verfügbar wenn ein Resident mehr als ein Presence Device hat<br>
Auslöser: Änderung presence, ausgelöst durch bestimmtes Presence Device eines bestimmten Resident

====HomeCMDseason====
Befehle die bei Änderung der Jahreszeit ausgeführt werden sollen<br>
Auslöser: Änderung Jahreszeit<br>
'''Beispiel'''
{
my $t = "%SEASON%";
$t .= "s" if ($t eq "Frühling");
fhem "msg push Die Wohnung ist nun im $t-Modus!";
fhem "set Heizungen [FILTER=controlMode!=auto] controlMode auto" if ($t ne "Sommer");
}

====HomeCMDseason-<SEASON>====
Befehle die bei Änderung der Jahreszeit in eine bestimmte Jahreszeit ausgeführt werden sollen<br>
Auslöser: Änderung bestimmte Jahreszeit

====HomeCMDtwilight====
Befehle die bei Änderung der Dämmerung ausgeführt werden sollen<br>
Auslöser: Änderung Dämmerung

====HomeCMDtwilight-<sr/sr_astro/sr_civil/sr_indoor/sr_weather/ss/ss_astro/ss_civil/ss_indoor/ss_weather>====
Befehle die bei Änderung zu bestimmter Dämmerung ausgeführt werden sollen<br>
Auslöser: Änderung zu bestimmter Dämmerung

====HomeCMDuwz-warn====
Befehle die bei Beginn/Ende der UWZ Warnungen ausgeführt werden sollen<br>
Auslöser: Beginn/Ende der UWZ Warnungen

====HomeCMDuwz-warn-begin====
Befehle die bei Beginn der UWZ Warnungen ausgeführt werden sollen<br>
Auslöser: Beginn der UWZ Warnungen<br>
'''Beispiel:'''
msg %UWZLONG%

====HomeCMDuwz-warn-end====
Befehle die beim Ende der UWZ Warnungen ausgeführt werden sollen<br>
Auslöser: Ende der UWZ Warnungen<br>
'''Beispiel:'''
msg Alle Unwetterwarnungen sind nun beendet!

=Platzhalter=
==verfügbar in allen HomeCMD Attributen==
===%ADDRESS%===
MAC Adresse des zuletzt ausgelösten Presence Geräts

===%ALARM%===
Liste mit Namen der ausgelösten Alarm Geräte<br>
Wert ist 0 wenn kein Alarm Device ausgelöst ist

===%ALARMCT%===
Anzahl der ausgelösten Alarm Geräte

===%ALARMHR%===
Liste mit (human readable) Namen der ausgelösten Alarm Geräte<br>
Wert ist 0 wenn kein Alarm Device ausgelöst ist<br>
kann z.B. für msg benutzt werden

===%ALIAS%===
Alias des zuletzt ausgelösten Resident

===%AMODE%===
aktueller Alarm Mode

===%AEAH%===
Wert von anyoneElseAtHome<br>
Wert ist 1 wenn on und 0 wenn off

===%ARRIVERS%===
Alias-Liste der ROOMMATE/GUEST deren location auf arrival steht<br>
kann z.B. dafür benutzt werden um Residents zu begrüßen<br>
z.B. Peter, Paul und Marry

===%AUDIO%===
Audio Device des zuletzt ausgelösten ROOMMATE/GUEST (Attribut msgContactAudio)<br>
wenn das Attribut msgContactAudio des jeweiligen Resident keinen Wert hat, so wird versucht den Wert des Attributs aus dem globalMsg (sofern vorhanden) auszulesen<br>
kann z.B. dafür benutzt werden um Resident spezifische msg(s) vom Typ audio zu senden, z.B. Nacht/Morgen Grüße/Wünsche

===%BATTERYLOW%===
Alias des zu letzt gemeldeten Geräts mit niedrigem Batteriestand

===%BATTERYLOWALL%===
Wert des Reading batteryLow_hr

===%BATTERYLOWCT%===
Wert des Reading batteryLow_ct

===%CONDITION%===
Wert des Reading condition des überwachten Yahoo weather Device<br>
kann z.B. für Wetter(vorhersage) benutzt werden

===%CONTACT%===
Wert des Reading lastContact (Name des zuletzt geöffneten Kontakt Sensor)<br>
kann z.B. dafür benutzt werden um msg zu versenden

===%DAYTIME%===
Wert des Reading daytime<br>
kann z.B. dafür benutzt werden um Tageszeit spezifische Aktionen zu schalten

===%DEVICE%===
Name des zuletzt ausgelösten Presence Gerät

===%DEVICEA%===
Wert des Reading lastAbsentByPresenceDevice

===%DEVICEP%===
Wert des Reading lastPresentByPresenceDevice

===%DISABLED%===
Wert des Reading devicesDisabled

===%DND%===
DND Status<br>
1 wenn an, 0 wenn aus

===%DURABSENCE%===
Wert des Reading durTimerAbsence_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURABSENCELAST%===
Wert des Reading lastDurAbsence_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURPRESENCE%===
Wert des Reading durTimerPresence_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURPRESENCELAST%===
Wert des Reading lastDurPresence_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURSLEEP%===
Wert des Reading durTimerSleep_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURSLEEPLAST%===
Wert des Reading lastDurSleep_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%<CALENDARNAME>%===
Event des benannten Kalenders<br>
0 wenn kein gerade kein Event ist

===%<CALENDARNAME-EVENTNAME>%===
0 wenn das benannte Event nicht aktiv ist<br>
1 wenn das benannte Event aktiv ist

===%FORECAST%===
Wettervorhersage für morgen

===%FORECASTTODAY%===
Wettervorhersage für heute

===%HUMIDITY%===
Wert des Reading humidity von HOMEMODE

===%HUMIDITYTREND%===
Wert des Reading humidityTrend von HOMEMODE

===%ICE%===
0 wenn keine Eiswarnung besteht<br>
1 wenn Eiswarnung besteht

===%IP%===
Wert des Reading publicIP von HOMEMODE

===%LIGHT%===
Wert des Reading light von HOMEMODE

===%LOCATION%===
Wert des Reading location von HOMEMODE

===%LOCATIONR%===
Wert des Reading location des zu letzt ausgelösten ROOMMATE/GUEST

===%LUMINANCE%===
Wert des Reading luminance von HOMEMODE

===%LUMINANCETREND%===
Wert des Reading luminanceTrend von HOMEMODE

===%MODE%===
gerade aktiver Modus von HOMEMODE (Reading mode)

===%MODEALARM%===
aktueller Alarm Mode (wie %AMODE%)

===%MOTION%===
Wert des Reading lastMotion von HOMEMODE

===%NAME%===
Name des HOMEMODE Geräts selbst (identisch zu %SELF%)

===%OPEN%===
Wert des Reading contactsOutsideOpen von HOMEMODE

===%OPENCT%===
Wert des Reading contactsOutsideOpen_ct von HOMEMODE

===%OPENHR%===
Wert des Reading contactsOutsideOpen_hr von HOMEMODE

===%PANIC%===
0 wenn panic ausgeschaltet ist<br>
1 wenn panic eingeschaltet ist

===%RESIDENT%===
Name des zu letzt ausgelösten ROOMMATE/GUEST

===%PRESENT%===
presence von HOMEMODE
0 wenn absent
1 wenn present

===%PRESENTR%===
presence des zu letzt ausgelösten ROOMMATE/GUEST
0 wenn absent
1 wenn present

===%PRESSURE%===
Wert des Reading pressure von HOMEMODE

===%PRESSURETREND%===
Wert des Reading pressureTrend von HOMEMODE

===%PREVAMODE%===
vorheriger modeAlarm von HOMEMODE

===%PREVCONTACT%===
vorheriger geöffneter Kontaktsensor

===%PREVMODE%===
vorheriger mode von HOMEMODE

===%PREVMODER%===
vorheriger state des zu letzt ausgelösten ROOMMATE/GUEST

===%PREVMOTION%===
vorheriger geöffneter Bewegungsmelder

===%SEASON%===
Wert des Reading season von HOMEMODE

===%SELF%===
Name des HOMEMODE Geräts selbst (identisch zu %NAME%)

===%SENSORSBATTERY%===
Liste aus Internal SENSORSBATTERY

===%SENSORSCONTACT%===
Liste aus Internal SENSORSCONTACT

===%SENSORSENERGY%===
Liste aus Internal SENSORSENERGY

===%SENSORSMOTION%===
Liste aus Internal SENSORSMOTION

===%SENSORSSMOKE%===
Liste aus Internal SENSORSSMOKE

===%SMOKE%===
Wert des Reading alarmSmoke von HOMEMODE
0 wenn kein Alarm

===%SMOKECT%===
Wert des Reading alarmSmoke_ct von HOMEMODE

===%SMOKEHR%===
Wert des Reading alarmSmoke_hr von HOMEMODE

===%TAMPERED%===
Wert des Reading sensorsTampered von HOMEMODE

===%TAMPEREDCT%===
Wert des Reading sensorsTampered_ct von HOMEMODE

===%TAMPEREDHR%===
Wert des Reading sensorsTampered_hr von HOMEMODE

===%TEMPERATURE%===
Wert des Reading temperature von HOMEMODE

===%TEMPERATURETREND%===
Wert des Reading temperatureTrend von HOMEMODE

===%TOBE%===
are/sind oder is/ist der Wetterkondition

===%TWILIGHT%===
Wert des Reading twilight von HOMEMODE

===%TWILIGHTEVENT%===
aktuelles twilight Event

===%UWZ%===
UWZ Warnlevel

===%UWZLONG%===
alle aktuellen UWZ Warnungen (lange Version)

===%UWZSHORT%===
alle aktuellen UWZ Warnungen (kurze Version)

===%WEATHER%===
Wert von "get <HOMEMODE> weather short"

===%WEATHERLONG%===
Wert von "get <HOMEMODE> weather long"

===%WIND%===
Wert des Reading wind von HOMEMODE

===%WINDCHILL%===
Wert des Reading wind_chill vom eingebundenen Yahoo Wetter Gerät

==verfügbar in den HomeCMDcontact, HomeCMDmotion und HomeCMDalarm Attributen==
===%ALIAS%===
alias des zuletzt ausgelösten Kontakt/Bewegungs/Rauchsensors

===%SENSOR%===
name des zuletzt ausgelösten Kontakt/Bewegungs/Rauchsensors

===%STATE%===
state des zuletzt ausgelösten Kontakt/Bewegungs/Rauchsensors

==verfügbar in den HomeTextWeatherForecast Attributen==
===%CONDITION%===
Wert des Readings condition des Yahoo Weather Geräts

===%DAY%===
Tag der Wettervorhersage (1 - heute, 2 - morgen)

===%HIGH%===
maximale Temperatur der Wettervorhersage

===%LOW%===
minimale Temperatur der Wettervorhersage

==verfügbar in den HomeCMDevent Attributen==
===%CALENDAR%===
Name der Kalenders

===%DESCRIPTION%===
Beschreibung des aktuellen Event des Kalenders (nicht verfügbar bei holiday Geräten)

===%EVENT%===
Name/Titel des aktuellen Event des Kalenders

===%PREVEVENT%===
Name/Titel des vorherigen Event des Kalenders

==verfügbar in den HomeCMDdevice Attributen==
===%DEVICE%===
name der deaktivierten Geräts

===%ALIAS%===
alias der deaktivierten Geräts

=Benötigte Events=
Folgende Events werden von HOMEMODE ausgewertet bzw. werden benötigt damit HOMEMODE vollumfänglich funktionieren kann.

<table>
<tr>
<td><b>DEVICE-TYPE</b></td>
<td><b>EVENT</b></td>
</tr>
<tr>
<td>RESIDENTS</td>
<td>state</td>
</tr>
<tr>
<td></td>
<td>presence</td>
</tr>
<tr>
<td>ROOMMATE,GUEST</td>
<td>state</td>
</tr>
<tr>
<td></td>
<td>presence</td>
</tr>
<tr>
<td></td>
<td>wayhome</td>
</tr>
<tr>
<td>{SENSORSCONTACT}</td>
<td>state</td>
</tr>
<tr>
<td></td>
<td>sabotageError</td>
</tr>
<tr>
<td></td>
<td>"HomeReadings"</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsContactReadings"</td>
</tr>
<tr>
<td>{SENSORSMOTION}</td>
<td>state</td>
</tr>
<tr>
<td></td>
<td>sabotageError</td>
</tr>
<tr>
<td></td>
<td>"HomeReadings"</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsMotionReadings"</td>
</tr>
<tr>
<td>{SENSORSLUMINANCE}</td>
<td>luminance</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsLuminanceReading"</td>
</tr>
<tr>
<td>{SENSORSENERGY}</td>
<td>power</td>
</tr>
<tr>
<td></td>
<td>energy</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsPowerEnergyReadings"</td>
</tr>
<tr>
<td>{SENSORSBATTERY}</td>
<td>battery</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsBatteryReading"</td>
</tr>
<tr>
<td>"HomePresenceDeviceType"</td>
<td>presence</td>
</tr>
<tr>
<td>"HomeYahooWeatherDevice"</td>
<td>humidity</td>
</tr>
<tr>
<td></td>
<td>temperature</td>
</tr>
<tr>
<td></td>
<td>wind</td>
</tr>
<tr>
<td></td>
<td>pressure</td>
</tr>
<tr>
<td>"HomeTwilightDevice"</td>
<td>light</td>
</tr>
<tr>
<td></td>
<td>twilight</td>
</tr>
<tr>
<td></td>
<td>aktEvent</td>
</tr>
<tr>
<td></td>
<td>pressure</td>
</tr>
<tr>
<td>"HomeSensorTemperatureOutside"</td>
<td>temperature</td>
</tr>
<tr>
<td></td>
<td>humidity</td>
</tr>
<tr>
<td>"HomeSensorHumidityOutside"</td>
<td>humidity</td>
</tr>
<tr>
<td>"HomeSensorWindspeed"</td>
<td>"HomeSensorWindspeed"</td>
</tr>
<tr>
<td>"HomeSensorAirpressure"</td>
<td>"HomeSensorAirpressure"</td>
</tr>
<tr>
<td>"HomeEventsHolidayDevices"</td>
<td>state</td>
</tr>
<tr>
<td>"HomeUWZ"</td>
<td>WarnCount</td>
</tr>
</table>

HOMEMODE

2018-08-02T19:59:33Z

50watt: /* Get-Befehle */ Tippfehler

{{
Infobox Modul
|ModPurpose=Das Modul wurde entworfen um den gesamten Heim-/Hausstatus in einem Gerät abzubilden und viele grundlegende Automationen durch Hinzufügen weiterer Geräte bereitzustellen.
|ModType=h
|ModCmdRef=HOMEMODE
|ModFTopic=64317
|ModForumArea=Automatisierung
|ModTechName=22_HOMEMODE.pm
|ModOwner=DeeSPe
}}
Diese Seite beschreibt die Konfiguration und Verwendung des Moduls ''22_HOMEMODE.pm''.

=Allgemeines=
Das Modul ''22_HOMEMODE.pm'' wurde entworfen um den gesamten Heim-/Hausstatus in einem Gerät abzubilden.<br>
Die hier aufgeführte Anleitung entspricht dem Modul in Version 1.4.2.

Viele allgemein typische Automationen sind bereits fertig integriert.

Die jeweils per Event auszuführenden Befehle können in den entsprechenden ''HomeCMD...'' Atributen hinterlegt werden und so in der Detail Ansicht des HOMEMODE Geräts übersichtlich angezeigt und bearbeitet werden.

Das Anlegen vieler notify/DOIF ist durch den Einsatz von ''HOMEMODE'' unnötig.

Zusätzlich wurde das Modul für die Verwendung mit HomeKit als GUI optimiert. Alle möglichen Mappings für Homebridge sind bereits enthalten und können über einen set Befehl aktualisiert werden.

[[Datei:HOMEMODE_Device.png|800px]]

==Voraussetzungen==
Um Modul ''22_HOMEMODE.pm'' benutzen zu können benötigt man als Mindestvoraussetzung ein bereits angelegtes RESIDENTS Gerät mit entsprechenden ROOMMATE/GUEST Geräten.

==Mögliche Automationen==
Alle Automationen sind optional.

Hier ein paar Beispiele:
*Änderung des Zustands von ROOMMATE/GUEST Geräten anhand von PRESENCE Geräten
*Bereistellung von CMD Attributen für mögliche Events rund um den Heim-/Hausstatus
*Bereistellung von Platzhaltern innerhalb der CMD Attribute, z.B. %MODE%, %SEASON% oder %PREVMODE% für die Werte der Readings mode, season und prevMode
*Einbindung von Kontakt Sensoren, für z.B. Offen-Warnungen nach bestimmten Zeitraum oder Alarm Meldungen in bestimmten Alarm Modus - kann pro Kontakt Sensor konfiguriert werden
*Einbindung von Bewegungs Sensoren, für z.B. automatische Licht Schaltungen oder Alarm Meldungen in bestimmten Alarm Modus - kann pro Bewegungs Sensor konfiguriert werden
*Darstellungen und Auslösen von Sabotage Alarmen der eingebundenen Kontakt- und Bewegungssensoren
*Einbindung von jeweils einem Temperatur und Luftfeuchtigkeitssensor
*Einbindung eines lokalen Yahoo Wetter Devices zur Ermittlung und Ausgabe der lokalen Wetterdaten und Erzeugung der Wettervorhersage
*Einbindung von Power und Energy Sensoren zur Ermittlung der Gesamtmengen
*Einbindung von Calendar/holiday Devices für spezielle im HOMEMODE Device verfügbar zu machende Events
*von Uhrzeit abhängiger Anwesend-Modus
*Bewohner unabhängige Tageszeit-Modus
*Alarm-Modus
*DND-Modus
*Überwachung von Batteriewerten

=HOMEMODE-Gerät=
==Definition==
Das HOMEMODE Gerät - hier mit dem Namen ''Home'' versehen - selbst wird über
define Home HOMEMODE
bei Vorhandensein nur eines RESIDENTS Geräts definiert.

Bei Verwendung mehrerer RESIDENTS Geräte muss das Master RESIDENTS Gerät beim Definieren mit angegeben werden
define Home HOMEMODE rgr_Residents
Dieses Modul verwendet das globale Attribut ''language'' zur Bestimmung der Anzeigedaten (Standard: EN=english). Für deutsche Ausgabedaten kann das Attribut
attr global language DE
gesetzt werden.<br>
Alternativ kann auch nur das HOMEMODE Gerät auf deutsch geändert werden
attr Home HomeLanguage DE

==Set-Befehle==
''set <required> [optional]''

set Home anyoneElseAtHome <on/off>
einschalten wenn jemand anderes zu Hause ist der kein registrierter ROOMMATE/GUEST ist, z.B. Hund/Katze oder unregistrierte Gäste<br>
wenn eingeschaltet, dann wird der Alarm Mode beim Verlassen statt auf armaway nur auf armhome gestellt<br>
schaltet man ein und hat schon Haus/Wohnung verlassen, so wird der Alarm Mode von armaway auf armhome gestellt<br>
Platzhalter '''%AEAH%''' ist in allen HomeCMD Attributen verfügbar

set Home dnd <on/off>
schaltet den "Bitte nicht stören" Modus ein<br>
z.B. um Benachrichtigungen zu deaktivieren<br>
Platzhalter '''%DND%''' ist in allen HomeCMD Attributen verfügbar

set Home dnd-for-minutes <MINUTES>
schaltet den "Bitte nicht stören" Modus für die angegebenen Minuten ein<br>
kehrt danach zum vorherigen (tageszeitabhängigen) Modus zurück

set Home deviceDisable <DEVICE>
deaktiviert das Gerät für sämtliche HOMEMODE Automationen<br>
Platzhalter '''%DISABLED%''' ist in allen HomeCMD Attributen verfügbar<br>
Platzhalter '''%DEVICE%''' und '''%ALIAS%''' sind in allen HomeCMD Attributen verfügbar

set Home deviceEnable <DEVICE>
reaktiviert das Gerät für sämtliche HOMEMODE Automationen<br>
Platzhalter '''%DISABLED%''' ist in allen HomeCMD Attributen verfügbar<br>
Platzhalter '''%DEVICE%''' und '''%ALIAS%''' sind in allen HomeCMD Attributen verfügbar

set Home location <arrival/home/bed/underway/wayhome>
manueller Ortswechsel<br>
Platzhalter '''%LOCATION%''' ist in allen HomeCMD Attributen verfügbar

set Home mode <morning/day/afternoon/evening/night/gotosleep/asleep/absent/gone/home>
manueller Moduswechsel<br>
Platzhalter '''%MODE%''' und '''%PREVMODE%''' sind in allen HomeCMD Attributen verfügbar

set Home modeAlarm <armaway/armhome/armnight/disarm>
schaltet den angegebenen Alarm Modus ein<br>
Platzhalter '''%AMODE%''' und '''%PREVAMODE%''' sind in allen HomeCMD Attributen verfügbar

set Home modeAlarm-for-minutes <armaway/armhome/armnight/disarm> <MINUTES>
schaltet den angegebenen Alarm Modus für die angegebenen Minuten ein
kehrt danach zum vorherigen Alarm Modus zurück

set Home updateHomebridgeMapping
aktualisiert das Attribut homebridgeMapping des HOMEMODDE Device abhängig von den verfügbaren Informationen

set Home updateInternalForce
führt eine Aktualisierung der Internals des HOMEMODE Device aus<br>
das sollte manuell benutzt werden nachdem das Modul aktualisiert und nur ein reload statt restart gemacht wurde<br>
auch wenn man überwachte/kontrollierte Geräte ändert sollte man diesen Befehl manuell ausführen, z.B. neue ROOMMATE/GUEST im RESIDENTS Device hinzufügt, oder Geräte in FHEM hinzufügt die dem selben Devspec wie bisher entsprechen (Steckdosen, Sensoren)

==Get-Befehle==
''get <required> [optional]''

get Home contactsOpen <all/doorsinside/doorsoutside/doorsmain/outside/windows>
Liste von all/doorsinside/doorsoutside/doorsmain/outside/windows offenen Kontakten<br>
Platzhalter '''%OPEN%''', '''%OPENCT%''' und '''%OPENHR%''' sind in allen HomeCMD Attributen verfügbar

get Home devicesDisabled
Anzeige der für HOMEMODE deaktivierten Geräte<br>
Platzhalter '''%DISABLED%''' ist in allen HomeCMD Attributen verfügbar

get Home mode
Anzeige von mode<br>
Platzhalter '''%MODE%''' ist in allen HomeCMD Attributen verfügbar

get Home modeAlarm
Anzeige von modeAlarm<br>
Platzhalter '''%AMODE%''' und '''%MODEALARM%''' sind in allen HomeCMD Attributen verfügbar

get Home publicIP
holen der öffentlichen IP Adresse<br>
Platzhalter '''%IP%''' ist in allen HomeCMD Attributen verfügbar

get Home sensorsTampered
Liste aller sabotierten Sensoren<br>
Platzhalter '''%TAMPERED%''', '''%TAMPEREDCT%''' und '''%TAMPEREDHR%''' sind in allen HomeCMD Attributen verfügbar

get Home weather <long/short>
Wetterinfo im angegebenen Format anzeigen<br>
Platzhalter '''%WEATHER%''' und '''%WEATHERLONG%''' sind in allen HomeCMD Attributen verfügbar

get Home weatherForecast [TAG]
Wettervorhersage für angegebenen Tag<br>
wenn kein Tag angegeben wird, so wird die Vorhersage für morgen (2) ausgegeben<br>
Platzhalter '''%FORECAST%''' (morgen) und '''%FORECASTTODAY%''' (heute) sind in allen HomeCMD Attributen verfügbar

==webCmd==
Die Schaltmöglichkeiten sind absichtlich gering gehalten, denn im normalen Betrieb sollte nicht mehr benötigt werden als die hier gebotenen.<br>
Es lässt sich der Alarm Mode manuell umschalten und beim Klick auf das devStateIcon wird der DND Mode an- und ausgeschaltet.

=Konfiguration=

==Grundkonfiguration==

Diese Grundkonfiguration sollte immer als erstes erfolgen um entsprechend darauf weiter aufzubauen. Als zweiter Schritt ist dann die erweiterte Konfiguration angedacht.

Bei der Namensvergabe der Attribute vom HOMEMODE Device wurde nach einem möglichst kurzem Prefix gesucht und nach vielen Tests wurde sich für das Prefix "Home" entschieden. Das hat den Vorteil dass alle Attribute beisammen stehen und diese auch (durch den Großbuchstaben am Anfang) ziemlich weit oben in der Liste der Attribute stehen. Ebenso wurde bei der Namensvergabe versucht selbsterklärende Namen zu wählen, das hat den Vorteil dass man relativ einfach genau erkennen kann wofür das Attribut steht, allerdings auch den Nachteil dass einige Attributnamen ganz schön lang werden.

===Attribute===

====HomeAdvancedUserAttr====
Als Erstes wird empfohlen, gerade für Anfänger, das Attribut "HomeAdvancedUserAttr" auf 1 zu setzen. Dadurch werden viel mehr HomeCMD Attribute freigeschaltet. Diese werden im Attribut userattr des HOMEMODE Device hinzugefügt.<br>
Standardwert: 0

====HomeAutoAlarmModes====
Als nächstes sollte man sich entscheiden ob die Alarm Modus evtl. nicht automatisch zum jeweiligen Modus des HOMEMODE Device geschaltet werden sollen. Standardmäßig werden die Alarm Modus automatisch gesteuert. Ist das nicht erwünscht, so ist der Wert dieses Attributs auf 0 zu setzen.<br>
Bei Modus "absent" des HOMEMODE Device wird automatisch auf "armaway" geschaltet.<br>
Bei Modus "home" des HOMEMODE Device wird automatisch auf "disarm" geschaltet.<br>
Bei Modus "asleep" des HOMEMODE Device wird automatisch auf "armnight" geschaltet.<br>
Alarm Modus "armhome" kann nur manuell gesetzt werden.<br>
Werte: 0 oder 1<br>
Standardwert: 1

====HomeAutoArrival====
Ist hier ein Wert größer 0 angegeben, so wird bei Ankunft jedes ROOMMATE/GUEST die location des jeweiligen ROOMMATE/GUEST für die hier angegeben Zeit in Minuten auf "arrival" gesetzt. Beim ersten nach Hause kommenden ROOMMATE/GUEST wird zusätzlich die location des HOMEMODE Device für die hier eingestellte Zeit in Minuten auf "arrival" gesetzt.<br>
Nach Ablauf der hier eingestellten Minuten wechelt das jeweilige Device von "arrival" auf "home" sofern es noch die location "arrival" hat.<br>
Werte: 0 bis 5999.9<br>
Standardwert: 0

====HomeAutoAsleep====
Ist hier ein Wert größer 0 angegeben, so wird beim Schlafengehen (gotosleep) jedes ROOMMATE/GUEST ein Timer gestartet der den jeweiligen ROOMMATE/GUEST nach der hier angegeben Zeit in Minuten auf "asleep" setzt.<br>
Werte: 0 bis 5999.9<br>
Standardwert: 0

====HomeAutoAwoken====
Ist hier ein Wert größer 0 angegeben, so wird beim Erwachen ("awoken" oder "home nach asleep") jedes ROOMMATE/GUEST dieser auf "awoken" gesetzt und ein Timer gestartet der den jeweiligen ROOMMATE/GUEST nach der hier angegeben Zeit in Minuten auf "home" setzt.<br>
Werte: 0 bis 5999.9<br>
Standardwert: 0

====HomeAutoDaytime====
Standardmäßig wird mode anhand der Tageszeit automatisch gesetzt. Ist das nicht gewünscht kann das über den Wert 0 deaktiviert werden. Dann stehen allerdings tageszeitabhängigen mode(s) nicht mehr zur Verfügung.<br>
Werte: 0 oder 1<br>
Standardwert: 1

====HomeResidentCmdDelay====
Normalerweise werden die Events der ROOMMATE/GUEST vor denen des HOMEMODE Device ausgeführt, um das zu ändern wird die Ausführung der ROOMMATE/GUEST HomeCMD Attribute um die hier eingestellte Zeit in Sekunden verzögert.<br>
Je genauer der Name des jeweiligen HomeCMD Attributs beschrieben wird, desto später wird dieser ausgeführt.<br>
Das heißt z.B. dass HomeCMDmode vor HomeCMDmode-absent und dieser wiederrum vor HomeCMDmode-absent-ROOMMATE/GUEST-NAME ausgeführt wird usw.<br>
Um das normale Verhalten wiederherzustellen ist der Wert dieses Attributs auf 0 zu setzen. Dann wird HomeCMDmode-absent-ROOMMATE/GUEST-NAME vor HomeCMDmode-absent und vor HomeCMDmode ausgeführt.<br>
Werte: 0 bis unendlich in Sekunden<br>
Standardwert: 1

==Konfiguration Presence Devices (automatische anwesend/abwesend Umschaltung von ROOMMATE/GUEST)==
Damit die automatische Zuordnung der Presence Devices zu ihren ROOMMATE/GUEST Devices zuverlässig funktioniert, ist es nötig dass der Hauptteil des Namens des ROOMMATE/GUEST innerhalb des Namens des zugehörigen PRESENCE Device(s) vorkommt.<br>
Im Attribut HomePresenceDeviceType kann man den zu suchenden TYPE von Presence Device vorgeben.<br>
Per Default werden nur Devices vom TYPE PRESENCE gesucht und versucht den ROOMMATE/GUEST zuzuweisen.<br>
Falls man z.B. auch Devices vom TYPE dummy zur Anwesenheitssteuerung benutzt, kann man diese im Attribut HomePresenceDeviceType mit hinzunehmen. Es sind alles Device TYPEn möglich die ein "presence" Reading mit den Werten "present/appeared" und "absent/disappeared" bereitstellen. Mehrere TYPEn sind möglich da in diesem Attribut ein Regex erwartet wird. z.B.: dummy oder PRESENCE|dummy oder PRESENCE|dummy|ONKYO_AVR.

===Beispiel===
Der Device Name meines ROOMMATE ist "rr_Dan".<br>
Auf der Suche nach dem zugehörigen Presence Device wird der erste Teil (rr_ oder rg_) weggeschnitten und der Rest in Kleinbuchstaben umgewandelt.<br>
Mit dem was übrig bleibt, bei mir also nur dan, werden die möglichen Presence Devices versucht zu erkennen.<br>
Mein zugehöriges Presence Device heißt, historisch gewachsen, PRESENCE_rr_Dan und würde somit problemlos zugeordnet werden können.<br>
Die Namen der zugehörigen Presence Devives könnten in ihrer kürzesten Form auch wie folgt sein um meinen ROOMMATE/GUEST Device zugeordnet zu werden:<br>
pdan
danp
ZDan
DANZ
wenndannsonst
Aber Achtung, es funktioniert nicht mehr wenn die Namen nicht eindeutig sind. Wenn es z.B. eine rr_Dana geben würde mit Presence Device Name "pdani", dann würde dieser Name auch bei mir (dan) passen. Das könnte man aber auch bewußt nutzen um mit einem Presence Device 2 ROOMMATE/GUEST Devices gleichzeitig zu steuern.<br>
Wenn die Namen wirklich absolut eindeutig sind, dann könnte man den Regex im Attribut HomePresenceDeviceType sogar auf ".*" setzen.

Werden pro ROOMMATE/GUEST mehrere Presence Devices gefunden und zugeordnet, so wird automatisch dass Attribut HomePresenceDeviceAbsentCount-<NAME-ROOMMATE/GUEST> auf die Anzahl der gefundenen Presence Devices gesetzt, so dass der/die jeweilige ROOMMATE/GUEST immer erst als abwesend gewertet wird sobald alle zugehörigen Presence Devices abwesend sind. Analog dazu gibt es noch das Attribut HomePresenceDevicePresentCount-<NAME-ROOMMATE/GUEST>.

===Attribute===

====HomeAutoPresence====
Ist dieses Attribut auf 1 gesetzt, so werden die ROOMMATE/GUEST Devices automatisch zum Status ihrer zugehörigen PRESENCE Devices geschaltet.<br>
PRESENCE Device present - ROOMMATE/GUEST home<br>
PRESENCE Device absent - ROOMMATE/GUEST absent<br>
Falls es sich bei den von Euch benutzen PRESENCE Devices nicht um Devices vom TYPE PRESENCE handeln sollte, sondern z.B. um PRESENCE und dummy, so kann dieses im Attribut HomePresenceDeviceType als Regex konfiguriert werden! z.B.: PRESENCE|dummy<br>
Damit ein Device als Presence Device erkannt werden kann, muss dieses über ein presence Reading verfügen.<br>
Werte: 0 oder 1<br>
Standardwert: 0

====HomeAutoPresenceSuppressState====
unterdrücke Anwesenheitsänderung in angegebenen State(s) der RESIDENTS<br>
z.B. für "mysteriös" verschwindende Anwesenheitsgeräte in der Nacht<br>
Werte: asleep|awoken|gotosleep<br>
Standardwert:

====HomePresenceDeviceType====
Regex des TYPEs/der TYPEn von Presence Devices<br>
Werte: Regex der Device TYPEn<br>
Standardwert: PRESENCE

==Erweiterte Konfiguration==
Um das HOMEMODE Device vollumfänglich zu benutzen ist es sinnvoll weitere Devices (zur Überwachung) hinzuzufügen.

Die bereits möglichen hinzuzufügenden Devices werden hier folgend nach Attributnamen erklärt.

===Attribute zum Hinzufügen weiterer Geräte===

====HomeEventsCalendarDevices====
Hier ist ein Devspec von holiday/Calendar Device(s) anzugeben.<br>
''Es wird empfohlen die holiday/Calendar Namen in Großbuchstaben anzulegen, da dann die daraus resultierenden Platzhalter ebenfalls Großbuchstaben sind und somit zu den anderen Platzhaltern passen.''<br>
Es werden alle Typen von holiday Events (1,2,3,4,5) unterstützt.<br>
Bei Calendar sind auch gleichzeitig startende/laufende Events möglich, sie müssen nur unterschiedliche Titel haben (summary).<br>
Der jeweilige Event Text kann auch Leerzeichen enthalten, welche in den HomeCMD Attributen durch Bindestriche (-) ersetzt werden.<br>
Diese Devices stellen zusätzlich die Platzhalter '''%CALENDAR%''', '''%EVENT%''' und '''%PREVEVENT%''' in den HomeCMDevent Attributen zur Verfügung. '''%CALENDAR%''' wird dann durch den Namen, '''%EVENT%''' durch das aktuelle Event und '''%PREVEVENT%''' durch das vorherige Event des jeweiligen Kalenders ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec von holiday/Calendar Geräten<br>
Standardwert:

====HomeEventsHolidayDevices====
Hier ist ein Devspec von holiday/Calendar Device(s) anzugeben.<br>
''Es wird empfohlen die holiday/Calendar Namen in Großbuchstaben anzulegen, da dann die daraus resultierenden Platzhalter ebenfalls Großbuchstaben sind und somit zu den anderen Platzhaltern passen.''<br>
Es werden alle Typen von holiday Events (1,2,3,4,5) unterstützt.<br>
Bei Calendar sind auch gleichzeitig startende/laufende Events möglich, sie müssen nur unterschiedliche Titel haben (summary).<br>
Der jeweilige Event Text kann auch Leerzeichen enthalten, welche in den HomeCMD Attributen durch Bindestriche (-) ersetzt werden.<br>
Diese Devices stellen zusätzlich die Platzhalter '''%CALENDAR%''', '''%EVENT%''' und '''%PREVEVENT%''' in den HomeCMDevent Attributen zur Verfügung. '''%CALENDAR%''' wird dann durch den Namen, '''%EVENT%''' durch das aktuelle Event und '''%PREVEVENT%''' durch das vorherige Event des jeweiligen Kalenders ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec von holiday/Calendar Geräten<br>
Standardwert:

====HomeSensorAirpressure====
Luftdrucksensor aussen<br>
Werte: frei wählbar<br>
Werteformat: Name des Sensors<br>
Standardwert:

====HomeSensorHumidityOutside====
Hier ist der Name des (Haupt)Aussensensors für Luftfeuchtigkeit anzugeben. Dieser muss ein Reading humidity besitzen.<br>
Falls der Sensor für (Aussen)Luftfeuchtigkeit und Aussentemperatur ein und der selbe ist, so muss dieser nur einmalig im Attribut HomeSensorTemperatureOutside hinterlegt werden. Dieser muss dann die beiden Readings humidity und temperature haben. Im Bedarfsfall können diese Readings auch vorher entsprechend durch eigene userReadings erstellt werden.<br>
Dieser Sensor stellt den Platzhalter '''%HUMIDITY%''' für den Wert des Readings humidity zur Verfügung.<br>
Werte: frei wählbar<br>
Werteformat: Device Name mit Reading humidity<br>
Standardwert:

====HomeSensorTemperatureOutside====
Hier ist der Name des (Haupt)Aussentemperatursensors anzugeben. Dieser muss mindestens ein Reading temperature besitzen.<br>
Falls der Sensor für Aussentemperatur auch ein Reading humidity besitzen sollte und dieses auch der Sensor für die Aussenlufteuchtigkeit ist, so muss dieser nur einmalig hier in diesem Attribut hinterlegt werden.<br>
Dieser Sensor stellt den Platzhalter '''%TEMPERATURE%''' für den Wert des Readings temperature zur Verfügung.<br>
Werte: frei wählbar<br>
Werteformat: Device Name mit Reading temperature und optional humidity<br>
Standardwert:

====HomeSensorsContact====
Hier können alle Kontakt Sensoren als Devspec hinterlegt werden.<br>
Diese Devices stellen zusätzlich die Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' in den HomeCMDcontact Attributen zur Verfügung. '''%ALIAS%''' wird dann durch den Alias, '''%SENSOR%''' durch den Namen und '''%STATE%''' durch den aktuellen state des zuletzt ausgelösten Kontakts ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:<br>
''In meinem Falle sind das optische und magnetische Kontaktsensoren vom HomeMatic. HM-SEC-SCo und HM-SEC-SC-2.''<br>
''Darum ist bei mir als Devspec '''model=HM-SEC-SC(o|-2)''' eingetragen um alle diese Kontaktsensoren zu erfassen.''<br>
Nach Übernehmen des Attributs werden alle gefundenen Kontaktsensoren mit ihren Namen im Internal SENSORSCONTACT des HOMEMODE Device einzeln aufgelistet und können dort auch direkt angeklickt werden.<br>
Des weiteren werden beim Übernehmen dieses Attributs jedem Kontaktsensor folgende Attribute im Attribut userattr hinzugefügt:<br>

=====HomeContactType=====
Typ des Kontakts - wird versucht anhand des Namen/Alias beim Hinzufügen zum HOMEMODE Device zu ermitteln, sollte jedoch für jeden Kontaktsensor einzeln überprüft werden<br>
Werte: doorinside,dooroutside,doormain,window<br>
Werteformat: vorgegebene Werteauswahl<br>
Standardwert: window

=====HomeModeAlarmActive=====
Regex der Alarm Mode(s) in denen der Kontaktsensor eine erfolgte Öffnung als Alarm melden soll.<br>
Werte: armaway|armhome|armnight<br>
Werteformat: Regex von Alarm Modes<br>
Standardwert: armaway

=====HomeOpenDontTriggerModes=====
Regex der Mode(s) des HOMEMODE Device in denen keine Offen Warnungen erfolgen sollen.<br>
Ist ein Kontakt geöffnet während die hier eingestellten Mode(s) eintreten, so wird der noch bestehende Timer abgebrochen. Entgegengesetzt startet er wieder sobal die hier eingestellten Mode(s) verlassen werden.<br>
Ist hier z.B. "gotosleep|asleep" eingestellt, so kann man z.B. das Fenster schon vor dem Auslösen von gotosleep oder asleep öffnen und der bestehende Offenwarnung-Timer wird dann abgebrochen. Sobald man am Morgen z.B. awoken oder home auslöst, so wird ein neuer Timer gestartet der einen dann an das noch offene Fenster erinnert.<br>
Werte: alle Modes des HOMEMODE Device<br>
Werteformat: Regex von Modes<br>
Standardwert:

=====HomeOpenDontTriggerModesResidents=====
Devspec der ROOMMATE/GUEST Devices deren Status statt der Modes des HOMEMODE Device für Attribut HomeOpenDontTriggerModes benutzt werden soll.<br>
Werte: alle überwachten ROOMMATE/GUEST<br>
Werteformat: Devspec<br>
Standardwert:

=====HomeOpenMaxTrigger=====
Maximale Anzahl an Warnmeldungen<br>
Werte: 0 bis ~<br>
Werteformat: ganze Zahl<br>
Standardwert:

=====HomeOpenTimes=====
Leerzeichenseparierte Liste von Offen Warnung Zeiten in Minuten.<br>
Der erste Wert entspricht der ersten Zeit, der zweite Wert der zweiten Zeit usw.<br>
Die Anzahl sollte dem Wert im Attribut HomeOpenMaxTrigger entsprechen. Wenn hier weniger Zeiten vorgegeben werden, so wird für weitere Offen Warnungen immer die letzte hier angegebene Zeit verwendet.<br>
Werte: frei wählbar<br>
Werteformat: leerzeichenseparierte Liste von Zahlen mit einer Kommmastelle, z.B. 2.5<br>
Standardwert: 10

=====HomeOpenTimesDividers=====
Leerzeichenseparierte Liste von Offenwarnzeit Teilern.<br>
Es müssen so viele Werte angegeben werden wie in HomeSeasons Jahreszeiten hinterlegt worden sind (Default 4).<br>
Bei einer normalen Offenwarnzeit von 10 Minuten und den hier anzugebenen Teilern z.B. "2 1 2 3" ergeben sich für Frühling und Herbst Offenwarnzeiten von jeweils 5 Minuten und im Winter 3.3 Minuten.<br>
Die hier eingetragenen Werte überschreiben die Werte aus dem Attribut HomeSensorsContactOpenTimeDividers des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: leerzeichenseparierte Liste von Zahlen mit einer Kommmastelle, z.B. 2 1 2 2.5<br>
Standardwert:

=====HomeReadings=====
Zwei leerzeichenseparierte Readings für open und sabotage Status.<br>
Die hier eingetragenen Readings überschreiben die Werte aus dem Attribut HomeSensorsContactReadings des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: zwei Wörter<br>
Standardwert: state sabotageError

=====HomeValues=====
Regex der Werte die für offen und sabotiert stehen.<br>
Die hier eingetragenen Werte überschreiben die Werte aus dem Attribut HomeSensorsContactValues des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: Regex<br>
Standardwert: open|tilted|on

====HomeSensorsContactReadings====
Zwei leerzeichenseparierte Readings für open und sabotage Status.<br>
Die hier eingetragenen Readings sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeReadings in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: zwei Wörter<br>
Standardwert: state sabotageError

====HomeSensorsContactValues====
Regex der Werte die für offen und sabotiert stehen.<br>
Die hier eingetragenen Werte sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeValues in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: Regex<br>
Standardwert: open|tilted|on

====HomeSensorsContactOpenTimeDividers====
Leerzeichenseparierte Liste von Offenwarnzeit Teilern.<br>
Es müssen so viele Werte angegeben werden wie in HomeSeasons Jahreszeiten hinterlegt worden sind (Default 4).<br>
Bei einer normalen Offenwarnzeit von 10 Minuten und den hier anzugebenen Teilern z.B. "2 1 2 3" ergeben sich für Frühling und Herbst Offenwarnzeiten von jeweils 5 Minuten und im Winter 3.3 Minuten.<br>
Die hier eingetragenen Werte sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeOpenTimesDividers in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: leerzeichenseparierte Liste von Zahlen mit max. einer Kommmastelle, z.B. 2 1 2 2.5 (für 4 Jahreszeiten)<br>
Standardwert:

====HomeSensorsContactOpenTimeMin====
Minimale Zeit in Minuten die mindestens für eine Offenwarnung gewartet werden soll - im Falle dass sich durch den Teiler evtl. zu kleine Werte ergeben.<br>
Werte: frei wählbar<br>
Werteformat: eine Zahle mit max. einer Kommmastelle, z.B. 2.5<br>
Standardwert:

====HomeSensorsContactOpenTimes====
Leerzeichenseparierte Liste von Offen Warnung Zeiten in Minuten.<br>
Der erste Wert entspricht der ersten Zeit, der zweite Wert der zweiten Zeit usw.<br>
Die Anzahl sollte dem Wert im Attribut HomeOpenMaxTrigger entsprechen. Wenn hier weniger Zeiten vorgegeben werden, so wird für weitere Offen Warnungen immer die letzte hier angegebene Zeit verwendet.<br>
Werte: frei wählbar<br>
Werteformat: leerzeichenseparierte Liste von Zahlen mit max. einer Kommmastelle, z.B. 7.5<br>
Standardwert: 10

====HomeSensorsLuminance====
Devspec von (Innen-)Lichtsensoren deren Durchschnittswert berechnet werden soll<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

====HomeSensorsMotion====
Hier können alle Bewegungs Sensoren als Devspec hinterlegt werden.<br>
Diese Devices stellen zusätzlich die Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' in den HomeCMDmotion Attributen zur Verfügung. '''%ALIAS%''' wird dann durch den Alias, '''%SENSOR%''' durch den Namen und '''%STATE%''' durch den aktuellen state des zuletzt ausgelösten Kontakts ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

''In meinem Falle sind das Fibaro Motion Sensor Gen4/5.''<br>
''Darum ist bei mir als Devspec '''modelId=010f-0801-1001|010f-0800-1001''' eingetragen um alle diese Bewegungssensoren zu erfassen.''<br>
''Damit bei den Gen5 Sensoren auch das open im reading state steht, habe ich mir bei diesen Sensoren ein userReading angelegt.''<br>
Nach Übernehmen des Attributs werden alle gefundenen Bewegungssensoren mit ihren Namen im Internal SENSORSMOTION des HOMEMODE Device einzeln aufgelistet und können dort auch direkt angeklickt werden.<br>
Des weiteren werden beim Übernehmen dieses Attributs jedem Bewegungssensor folgende Attribute im Attribut userattr hinzugefügt:

=====HomeModeAlarmActive=====
Regex der Alarm Mode(s) in denen der Bewegungssensor eine erfolgte Öffnung als Alarm melden soll.<br>
Werte: armaway|armhome|armnight<br>
Werteformat: Regex von Alarm Modes<br>
Standardwert: armaway

=====HomeReadings=====
2 leerzeichenseparierte Readings für open und sabotage.<br>
Die hier eingetragenen Readings überschreiben die Werte aus dem Attribut HomeSensorsMotionReadings des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: zwei Wörter<br>
Standardwert: state sabotageError

=====HomeSensorLocation=====
Standort des Bewegungssensors (außen oder innen) - wird standardmäßig beim Hinzufügen zum HOMEMODE Device auf "inside" gesetzt, sollte jedoch für jeden Kontaktsensor einzeln überprüft werden<br>
Werte: inside,outside<br>
Werteformat: vorgegebene Werteauswahl<br>
Standardwert: inside

=====HomeValues=====
Regex der Werte die für offen und sabotiert stehen.<br>
Die hier eingetragenen Werte überschreiben die Werte aus dem Attribut HomeSensorsMotionValues des HOMEMODE Device.<br>
Werte: frei wählbar<br>
Werteformat: Regex<br>
Standardwert: open|on

====HomeSensorsMotionReadings====
2 leerzeichenseparierte Readings für open und sabotage.<br>
Die hier eingetragenen Readings sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeReadings in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: zwei Wörter<br>
Standardwert: state sabotageError

====HomeSensorsMotionValues====
Regex der Werte die für offen und sabotiert stehen.<br>
Die hier eingetragenen Werte sind global für alle Kontaktsensoren, können aber durch setzen des Attributs HomeValues in jedem Sensor überschrieben werden.<br>
Werte: frei wählbar<br>
Werteformat: Regex<br>
Standardwert: open|on

====HomeSensorsPowerEnergy====
Hier können alle Energie Sensoren als Devspec hinterlegt werden. Diese müssen die beiden Readings power und energy besitzen.<br>
Anhand dieser Readings wird dann der Gesamtverbrauch und die derzeitige gesamte Leistungsaufnahme berechnet.<br>
''In meinem Falle sind das Fibaro Wall Plugs Gen4/5.''<br>
''Darum ist bei mir als Devspec '''modelId=010f-0600-1000|010f-0602-1001''' eingetragen um alle diese Energie Sensoren zu erfassen.''<br>
Werte: frei wählbar<br>
Werteformat: Devspec mit vorhandenen energy und power Readings<br>
Standardwert:

====HomeSensorsSmoke====
Devspec mit Rauchmeldern<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

====HomeSensorWindspeed====
Sensor für Windgeschwindigkeit<br>
Werte: frei wählbar<br>
Werteformat: Name des Sensors und Reading der Windgeschwindigkeit separiert mit : (z.B. ga_Windsensor:wind)<br>
Standardwert:

====HomeSensorsBattery====
Devspec von Batteriesensoren mit einem Reading "battery"<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

====HomeTriggerAnyoneElseAtHome====
auslösendes Gerät für anyoneElseAtHome<br>
Werte: frei wählbar<br>
Werteformat: device:reading:valueOn:valueOff<br>
Standardwert:

====HomeTriggerPanic====
auslösendes Gerät für Panikalarm<br>
valueOff ist optional, wird es weggelassen, so fungiert valueOn als toggle<br>
Werte: frei wählbar<br>
Werteformat: device:reading:valueOn[:valueOff]<br>
Standardwert:

====HomeTwilightDevice====
Hier ist der Name des lokalen Twilight Device anzugeben.<br>
Diese Device stellt zusätzlich die Platzhalter '''%LIGHT%''', '''%TWILIGHT%''' und '''%TWILIGHTEVENT%''' in den HomeCMD Attributen zur Verfügung. '''%LIGHT%''' wird dann durch das Reading light, '''%TWILIGHT%''' durch das Reading twilight und '''%TWILIGHTEVENT%''' durch das aktuelle Twilight Event ersetzt.<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

====HomeUWZ====
Hier ist der Name des lokalen UWZ Geräts anzugeben.<br>
Platzhalter '''%UWZ%''', '''%UWZSHORT%''' und '''%UWZLONG%''' sind verfügbar in allen HomeCMD Attributen<br>
Werte: frei wählbar<br>
Werteformat: Name des UWZ Geräts<br>
Standardwert:

====HomeYahooWeatherDevice====
Hier ist der Name des lokalen Yahoo Weather Geräts anzugeben.<br>
Diese Device stellt zusätzlich einige Platzhalter zur Verfügung. Für die genaue Beschreibung derer siehe "Platzhalter".<br>
Werte: frei wählbar<br>
Werteformat: Devspec<br>
Standardwert:

===HomeText Attribute===
Die HomeText Attribute sind größtenteils zur Übersetzung einiger benötigter Begriffe gedacht.<br>
In den speziellen Attributen die mit HomeTextWeather anfangen, sind ganze Texte mit entsprechenden Platzhaltern einzufügen.

====HomeTextAndAreIs====
Übersetzung für "and", "are" und "is"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort/Wörter<br>
Standardwert: and|are|is<br>
'''Beispiel:'''
und|sind|ist

====HomeTextClosedOpen====
Übersetzung für "closed" und "open"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort<br>
Standardwert: closed|open<br>
'''Beispiel:'''
geschlossen|geöffnet

====HomeTextNosmokeSmoke====
Übersetzung für "no smoke" und "smoke"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort<br>
Standardwert: no smoke|smoke<br>
'''Beispiel:'''
kein Rauch|Rauch

====HomeTextRisingConstantFalling====
Übersetzung für "rising", "constant" und "falling"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort<br>
Standardwert: rising|constant|falling<br>
'''Beispiel:'''
steigend|gleichbleibend|fallend

====HomeTextTodayTomorrowAfterTomorrow====
Übersetzung für "today", "tomorrow" und "day after tomorrow"<br>
Werte: frei wählbar separiert mit |<br>
Werteformat: Wort<br>
Standardwert: today|tomorrow|day after tomorrow<br>
'''Beispiel:'''
Heute|Morgen|Übermorgen

====HomeTextWeatherNoForecast====
Übersetzung für "No forecast available" - Text wenn keine Wettervorhersage verfügbar ist<br>
Werte: frei wählbar<br>
Werteformat: Text<br>
Standardwert: No forecast available<br>
'''Beispiel:'''
Es ist leider keine Wettervorhersage für den angegebenen Tag verfügbar!

====HomeTextWeatherForecastInSpecDays====
Text mit Platzhaltern für Wettervorhersage in 4-10 Tagen<br>
spezielle Platzhalter die nur in diesem Attribut gültig sind: '''%CONDITION%''', '''%DAY%''', '''%HIGH%''' und '''%LOW%'''<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
In %DAY% Tagen %CONDITION% bei Temperaturen von %LOW% bis %HIGH%°C.

====HomeTextWeatherForecastToday====
Text mit Platzhaltern für Wettervorhersage für heute<br>
spezielle Platzhalter die nur in diesem Attribut gültig sind: '''%CONDITION%''', '''%DAY%''', '''%HIGH%''' und '''%LOW%'''<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
%DAY% %CONDITION% bei Temperaturen von %LOW% bis %HIGH%°C. Aktuelle Temperatur %TEMPERATURE%°C bei einer Luftfeuchtigkeit von %HUMIDITY%%. Die gefühlte Temperatur ist %WINDCHILL%°C bei einer Windgeschwindigkeit von %WIND%km/h.

====HomeTextWeatherForecastTomorrow====
Text mit Platzhaltern für Wettervorhersage für morgen/übermorgen<br>
spezielle Platzhalter die nur in diesem Attribut gültig sind: '''%CONDITION%''', '''%DAY%''', '''%HIGH%''' und '''%LOW%'''<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
%DAY% %CONDITION% bei Temperaturen von %LOW% bis %HIGH%°C.

====HomeTextWeatherLong====
Langer Text mit Platzhaltern für aktuelle Wetterdaten<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
Es %TOBE% %CONDITION% bei %TEMPERATURE%°C und %HUMIDITY%% Luftfeuchtigkeit. Die gefühlte Temperatur ist %WINDCHILL%°C bei einer Windgeschwindigkeit von %WIND%km/h. Der Luftdruck ist %PRESSURETREND% bei %PRESSURE%hPa.

====HomeTextWeatherShort====
Kurzer Text mit Platzhaltern für aktuelle Wetterdaten<br>
Werte: frei wählbar<br>
Werteformat: Text mit Platzhaltern<br>
Standardwert:<br>
'''Beispiel:'''
%CONDITION%, %TEMPERATURE%°C, %HUMIDITY%% Luftfeuchtigkeit, Luftdruck %PRESSURE%hPa

===weitere Attribute===
Viele weitere Dinge lassen sich anpassen.

====HomeAdvancedDetails====
mehr Details anzeigen, abhängig von den zu HOMEMODE hinzugefügten Geräten<br>
Werte: none, detail, both, room<br>
Werteformat: Auswahlliste<br>
Standardwert: none

====HomeDaytimes====
Eigene Tageszeiten als Paare aus Zeit|Wort<br>
Werte: Zeit|Wort Paare separiert mit Leerzeichen<br>
Werteformat: Zeit|Wort<br>
Standardwert: 05:00|morning 10:00|day 14:00|afternoon 18:00|evening 23:00|night<br>
'''Beispiel:'''
00:00|Mitternacht
00:05|Nacht
06:30|Morgen
10:00|Vormittag
13:00|Mittag
14:30|Nachmittag
17:30|Vorabend
19:00|Abend
23:00|Spätabend

====HomeIcewarningOnOffTemps====
2 leerzeichenseparierte Temperaturen für das Ein- und Ausschalten der Eiswarnung.<br>
Werte: frei wählbar<br>
Werteformat: zwei leerzeichenseparierte Temperaturen mit maximal einer Kommastelle<br>
Standardwert: 2 3

====HomeModeAlarmArmDelay====
Zeit in Sekunden um das aktivieren der Alarmschaltung zu verzögern.<br>
Werte: 0 bis 99999<br>
Werteformat: einzelne Zahl (gleiche Verzögerung für alle modeAlarm) oder 3 leerzeichenseparierte Zahlen für jeden modeAlarm (Reihenfolge: armaway armnight armhome)<br>
Standardwert: 0

====HomeAtTmpRoom====
Diesen Raum zu temporäre at(s) hinzufügen die von HOMEMODE generiert werden<br>
Werte: frei wählbar<br>
Werteformat: Wort<br>
Standardwert:

====HomePresenceDeviceAbsentCount-<ROOMMATE/GUEST>====
Anzahl der dem ROOMMATE/GUEST zugeordneten Presence Geräte um den jeweiligen ROOMMATE/GUEST auf "absent" zu setzen<br>
Das Attribut ist nur verfügbar wenn mehr als ein Presence Gerät pro ROOMMATE/GUEST gefunden/zugeordnet wurde<br>
Werte: 0 bis ~<br>
Werteformat: einzelne Zahl<br>
Standardwert: maximale Anzahl von verfügbaren Presence Geräten für jeden ROOMMATE/GUEST

====HomePresenceDevicePresentCount-<ROOMMATE/GUEST>====
Anzahl der dem ROOMMATE/GUEST zugeordneten Presence Geräte um den jeweiligen ROOMMATE/GUEST auf "present" zu setzen<br>
Das Attribut ist nur verfügbar wenn mehr als ein Presence Gerät pro ROOMMATE/GUEST gefunden/zugeordnet wurde<br>
Werte: 0 bis ~<br>
Werteformat: einzelne Zahl<br>
Standardwert: 1

====HomePublicIpCheckInterval====
Interval in Minuten für die Überprüfung der öffentlichen IP-Adresse<br>
Werte: 0 bis 99999<br>
Werteformat: einzelne Zahl<br>
Standardwert: 0 (deaktiviert)

====HomeSeasons====
Eigene Jahreszeiten als Paare aus Datum|Wort<br>
Werte: Datum|Wort Paare separiert mit Leerzeichen<br>
Werteformat: Datum|Wort<br>
Standardwert: 03.01|spring 06.01|summer 09.01|autumn 12.01|winter<br>
'''Beispiel:'''
03.01|Frühling
06.01|Sommer
09.01|Herbst
12.01|Winter

====HomeSensorsBatteryLowPercentage====
Prozentsatz um einen Batteriesensor mit geringer Batterie anzuzeigen (nur bei Sensoren die ihren Batteriewert prozentual angeben)<br>
Werte: frei wählbar<br>
Werteformat: Zahl<br>
Standardwert: 50

====HomeSensorsBatteryReading====
Reading der Batteriesensoren welches statt "battery" benutzt werden soll<br>
Werte: frei wählbar<br>
Werteformat: einzelnes Wort<br>
Standardwert: battery

====HomeSensorsLuminanceReading====
Reading der Lichtsensoren welches statt "luminance" benutzt werden soll<br>
Werte: frei wählbar<br>
Werteformat: einzelnes Wort<br>
Standardwert: luminance

====HomeSensorsPowerEnergyReadings====
Readings der Power/Energy Sensoren welche statt "power" und "energy" benutzt werden sollen<br>
Werte: frei wählbar<br>
Werteformat: 2 leerzeichenseparierte Wörter<br>
Standardwert: power energy

====HomeSensorsSmokeReading====
Readings der Rauchmelder welche statt "state" benutzt werden sollen<br>
Werte: frei wählbar<br>
Werteformat: ein Wort<br>
Standardwert: state

====HomeSensorsSmokeValue====
Regex der Auslösewerte von Rauchmeldern<br>
Werte: frei wählbar<br>
Werteformat: RegEx<br>
Standardwert: on

====HomeSpecialLocation====
Hier können eigene zusätzliche location(s) als kommaseparierte Liste angegeben werden.<br>
Diese können dann über "set <HOMEMODE> location <LOCATION>" gesetzt werden. Dazu passend werden HomeCMD Attribute erstellt.<br>
Werte: frei wählbar<br>
Werteformat: kommaseparierte Liste von Wörtern<br>
Standardwert:

====HomeSpecialModes====
Hier können eigene zusätzliche mode(s) als kommaseparierte Liste angegeben werden.<br>
Diese können dann über "set <HOMEMODE> mode <MODE>" gesetzt werden. Dazu passend werden HomeCMD Attribute erstellt.<br>
Werte: frei wählbar<br>
Werteformat: kommaseparierte Liste von Wörtern<br>
Standardwert:

====HomeTrendCalcAge====
Zeit in Sekunden für das Maximalalter des vorherigen Wertes für die Trendberechnung<br>
Werte: frei wählbar<br>
Werteformat: Zeit in Sekunden<br>
Standardwert: 900

Ein weiterer Teil der Konfiguration ist das Befüllen der HomeCMD Attribute. Da dieses durch die Vermischung von FHEM Code, Perl Code und zusätzlichen Platzhaltern erst einmal sehr befremdlich sein kann, habe ich bei der Beschreibung der HomeCMD Attribute teilweise Beispiele hinzugefügt um den Einstieg weiter zu erleichtern.

==HomeCMD Attribute (mit Beispielen)==
Die HomeCMD Attribute sind zum Festlegen der jeweiligen Schaltaktionen gedacht und können damit evtl. vorhandene notify/DOIF ablösen. Sie können mit FHEM-Code, Perl-Code oder aber auch mit beidem vermischt befüllt werden (wovon ich allerdings abrate). Zusätzlich sind noch diverse Platzhalter (siehe Platzhalter) verfügbar.

'''Bei Perl-Code innerhalb der HomeCMD Attribute gibt es hier Besonderheiten.'''<br>
*Im Gegensatz zur FHEM-Eingabezeile müssen hier keine Semikolon verdoppelt werden
*Kommetarzeilen sind zulässig
*Kommentare am Ende einer Perl-Zeile sind nicht zulässig

Typischer Weise werden in den HomeCMD Attributen weitere Module angesprochen.<br>
Z.B. benutze ich für jegliche Form der Benachrichtigung den msg Befehl.

Keines der HomeCMD Attribute hat einen Standardwert. Es müssen alle Befehle selbst programmiert werden.

Platzhalter die Text(e) (string) beinhalten, müssen im Perl-Code in Anführungszeichen gesetzt werden (Beispiel %SENSOR%).<br>
Platzhalter die Zahlen beinhalten (int,float) sollten nicht in Anführungszeichen gesetzt werden damit Zahlenvergleiche (mittels ==, <=, >=, >, <) funktionieren (Beispiel %LIGHT%, %ICE% oder %TEMPERATURE%).

====HomeCMDalarmSmoke====
Befehle die beim Anfang/Ende eines Rauchalarms ausgeführt werden sollen.<br>

====HomeCMDalarmSmoke-off====
Befehle die beim Ende eines Rauchalarms ausgeführt werden sollen.<br>
Auslöser: Ende Rauchalarm eines beliebigen (von HOMEMODE überwachten) Rauchmelders<br>
'''Beispiel:'''
msg push ENTWARNUNG: Alle Rauchalarme sind beendet!

====HomeCMDalarmSmoke-on====
Befehle die bei einem Rauchalarm ausgeführt werden sollen.<br>
Auslöser: Rauchalarm eines beliebigen (von HOMEMODE überwachten) Rauchmelders<br>
'''Beispiel:'''
{
my $is = "meldet";
$is = "melden" if (%SMOKECT% > 1);
fhem "msg push ACHTUNG: %SMOKEHR% $is Rauchalarm!";
}

====HomeCMDalarmTampered====
Befehle die beim Anfang/Ende eines Sabotage Alarms ausgeführt werden sollen.

====HomeCMDalarmTampered-off====
Befehle die beim Ende eines Sabotage Alarms ausgeführt werden sollen.<br>
Auslöser: Ende Sabotage Alarm eines beliebigen (von HOMEMODE überwachten) Kontakt-/Bewegungs-Sensors<br>
'''Beispiel:'''
msg push ENTWARNUNG: Alle Manipulationen wurden beseitigt!

====HomeCMDalarmTampered-on====
Befehle die bei einem Sabotage Alarm ausgeführt werden sollen.<br>
Auslöser: Sabotage Alarm eines beliebigen (von HOMEMODE überwachten) Kontakt-/Bewegungs-Sensors<br>
'''Beispiel:'''
{
my $is = "ist";
$is = "sind" if (%TAMPEREDCT% > 1);
fhem "msg push ACHTUNG: %TAMPEREDHR% $is sabotiert!";
}

====HomeCMDalarmTriggered====
Befehle die beim Anfang/Ende eines Alarms ausgeführt werden sollen.

====HomeCMDalarmTriggered-off====
Befehle die beim Ende eines Alarms ausgeführt werden sollen.<br>
Auslöser: Ende Alarm eines beliebigen (von HOMEMODE überwachten) Kontakt-/Bewegungs-Sensors<br>
'''Beispiel:'''
msg ENTWARNUNG: Alle Alarme sind beendet!

====HomeCMDalarmTriggered-on====
Befehle die bei einem Alarm ausgeführt werden sollen.<br>
Auslöser: Alarm eines beliebigen (von HOMEMODE überwachten) Kontakt-/Bewegungs-Sensors<br>
'''Beispiel:'''
{
my $is = "ist";
$is = "sind" if (%ALARMCT% > 1);
fhem "msg audio,push,light 3 !!! ALARM !!! %ALARMHR% $is ausgelöst!";
}

====HomeCMDanyoneElseAtHome====
Befehle die beim on/off von anyoneElseAtHome ausgeführt werden sollen.

====HomeCMDanyoneElseAtHome-off====
Befehle die ausgeführt werden sollen sobald anyoneElseAtHome deaktiviert wird.<br>
Bei Abwesenheit und nicht deaktiviertem HomeAutoAlarmModes wird der Alarm Mode von "armaway" auf "armhome" umgeschaltet damit evtl. vorhandene Bewegungsmelder keinen Alarm mehr melden.<br>
Auslöser: anyoneElseAtHome on<br>
'''Beispiel:'''
msg HINWEIS: Es ist nun niemand anderes mehr zu Hause!

====HomeCMDanyoneElseAtHome-on====
Befehle die ausgeführt werden sollen sobald anyoneElseAtHome aktiviert wird.<br>
Bei Abwesenheit und nicht deaktiviertem HomeAutoAlarmModes wird der Alarm Mode von "armhome" auf "armaway" umgeschaltet damit evtl. vorhandene Bewegungsmelder wieder Alarme melden können.<br>
Wird anyoneElseAtHome bei Anwesenheit und nicht deaktiviertem HomeAutoAlarmModes aktiviert, so passiert erst einmal nichts, ausser dass die hier angegebenen Befehle ausgeführt werden. Wird dann später die Abwesenheit erkannt, schaltet der Alarm Mode auf "armhome" statt auf "armaway" damit evtl. vorhandene Bewegungsmelder keinen Alarm mehr melden.<br>
Auslöser: anyoneElseAtHome off<br>
'''Beispiel:'''
msg HINWEIS: Es ist nun noch jemand anderes zu Hause!

====HomeCMDbatteryLow====
Befehle die ausgeführt werden sollen sobald ein Sensor einen niedrigen Batteriewert meldet.<br>
'''Beispiel:'''
{
my $msg;
$msg = "Die Batterien von %BATTERYLOW% gehen zur Neige und sollten ausgetauscht werden!" if (%BATTERYLOWCT% == 1);
$msg = "Die Batterien bei folgenden Geräten sollten ausgetauscht werden: %BATTERYLOWALL%" if (%BATTERYLOWCT% > 1);
fhem "msg push $msg";
}

====HomeCMDcontact====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor open/tilted/closed meldet.<br>
Die speziellen Platzhalter %ALIAS%, %SENSOR% und %STATE% können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor open/tilted/closed<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun %STATE%!";
}

====HomeCMDcontactClosed====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor geschlossen meldet.<br>
Die speziellen Platzhalter %ALIAS%, %SENSOR% und %STATE% können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor closed<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun geschlossen!";
}

====HomeCMDcontactOpen====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor offen meldet.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor open/tilted<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun offen!";
}

====HomeCMDcontactDoormain====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor des Types doormain open/tilted/closed meldet.<br>
Die speziellen Platzhalter %ALIAS%, %SENSOR% und %STATE% können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor Type doormain open/tilted/closed<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun %STATE%!";
}

====HomeCMDcontactDoormainClosed====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor des Types doormain closed meldet.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor vom Typ doormain wird geschlossen<br>
'''Beispiel:'''
{
# Wenn es Ankommende gibt
if ("%ARRIVERS%")
{
# Zusammenstellen der Begrüßung
my $msg = "Gute";

# "n" anhängen wenn Tageszeit nicht Nacht ist
$msg .= "n" if ("%DAYTIME%" ne "Nacht");

# Leerzeichen einfügen
$msg .= " ";

# den Feiertag der Tageszeit voranstellen wenn ein Feiertag im Kalender FEIERTAG ist
$msg .= "%FEIERTAG%-" if ("%FEIERTAG%");

# Tageszeit einfügen
$msg .= "%DAYTIME% ";

# bei ROOMMATE "zu Hause" in Begrüßung einfügen
$msg .= "zu Hause " if ("%RESIDENT%" =~ /^rr_/);

# Ankommende einfügen
$msg .= "%ARRIVERS%";

# Begrüßung am Sonos im Flur ausgeben bei Abwesenheit über 60 min
fhem "msg audio \@fl_Sonos $msg!" if (%DURABSENCELAST% > 60);
}
}

====HomeCMDcontactDoormainOpen====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor des Types doormain open/tilted meldet.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: Kontaktsensor vom Typ doormain geöffnet<br>
'''Beispiel:'''
{
my $a = "%ALIAS%";
$a =~ s/d/D/;
fhem "msg $a ist nun geöffnet!";
}

====HomeCMDcontactOpenWarning1====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor die erste Offenwarnzeit erreicht hat.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: erste Offenwarnzeit des Kontakts erreicht<br>
'''Beispiel:'''
msg audio %ALIAS% steht noch offen!

====HomeCMDcontactOpenWarning2====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor die zweite Offenwarnzeit erreicht hat.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: ab Erreichen der zweiten Offenwarnzeit des Kontakts<br>
'''Beispiel:'''
msg audio %ALIAS% steht immer noch offen!

====HomeCMDcontactOpenWarningLast====
Befehle die ausgeführt werden sollen sobald ein Kontaktsensor die letzte Offenwarnzeit erreicht hat.<br>
Die speziellen Platzhalter '''%ALIAS%''', '''%SENSOR%''' und '''%STATE%''' können in diesem Attribut benutzt werden.<br>
Auslöser: Erreichen der letzten Offenwarnzeit des Kontakts<br>
'''Beispiel:'''
msg audio Das ist der letzte Hinweis %ALIAS% endlich zu schliessen!

====HomeCMDdaytime====
Befehle die ausgeführt werden sollen sobald sich die Tageszeit (daytime) auf einen beliebigen Wert ändert.<br>
Um die jeweilige eingetretene Tageszeit zu ermitteln ist der Platzhalter '''%DAYTIME%''' vorgesehen.<br>
Auslöser: Änderung der Tageszeit (daytime)

====HomeCMDdaytime-<DAYTIME>====
Befehle die ausgeführt werden sollen sobald die jeweilige Tageszeit (daytime) erreicht ist.<br>
Auslöser: Änderung der Tageszeit (daytime) auf bestimmten Wert<br>
Bei "night" könnte man z.B. die Heizung bewohnerunabhängig ausschalten, bei "morning" wieder ein.

====HomeCMDdeviceDisable====
Befehle die ausgeführt werden sollen sobald ein Gerät deaktiviert wird.<br>
Auslöser: 'set deviceDisable <DEVICE>'<br>
'''Beispiel:'''
{
speak "Das Gerät %ALIAS% ist nun deaktiviert!";

# optional wirklich attr disable für Device setzen und Konfig speichern
#fhem "attr %DEVICE%:FILTER=disable!=1 disable 1; save";

# ROOMMATE/GUEST auf gone/none setzen wenn Presence Devices deaktiviert werden
if ("%DEVICE%" =~ /^PRESENCE\d?_(r[rg]_.*)/)
{
my $resident = $1;
my $gone = $resident =~ /^rr_/ ? "gone" : "none";
fhem "set $resident:FILTER=state!=$gone state $gone";
}
}

====HomeCMDdeviceEnable====
Befehle die ausgeführt werden sollen sobald ein Gerät aktiviert wird.<br>
Auslöser: 'set deviceEnable <DEVICE>'<br>
'''Beispiel:'''
{
speak "Das Gerät %ALIAS% ist nun aktiviert!";

# optional attr disable für Device entfernen und Konfig speichern
#fhem "deleteattr %DEVICE%:FILTER=disable=1 disable; save";

# ROOMMATE/GUEST auf home setzen wenn Presence Devices aktiviert werden und anwesend sind
if ("%DEVICE%" =~ /^PRESENCE\d?_(r[rg]_.*)/)
{
fhem "set $1:FILTER=state!=home state home" if (ReadingsVal("%DEVICE%","presence","") eq "present");
}
}

====HomeCMDdnd====
Befehle die beim Anfang/Ende des DND Modus ausgeführt werden sollen.<br>
Auslöser: Ende des DND Modus<br>
'''Beispiel:'''
{
if (%DND%)
{
fhem "msg audio Der DND Modus ist nun eingeschaltet!";
}
else
{
fhem "msg audio Der DND Modus ist nun beendet!";
}
}

====HomeCMDdnd-off====
Befehle die beim Ende des DND Modus ausgeführt werden sollen.<br>
Auslöser: Ende des DND Modus<br>
'''Beispiel:'''
msg audio Der DND Modus ist nun beendet!

====HomeCMDdnd-on====
Befehle die beim Beginn des DND Modus ausgeführt werden sollen.<br>
Auslöser: Beginn des DND Modus<br>
'''Beispiel:'''
msg audio Der DND Modus ist nun eingeschaltet!

====HomeCMDevent====
Befehle die beim Beginn eines beliebigen (holiday)Kalender Events ausgeführt werden sollen.<br>
Auslöser: Beginn eines beliebigen (holiday)Kalender Events<br>
Platzhalter '''%CALENDAR%''', '''%EVENT%''' und '''%PREVEVENT%''' können zusätzlich verwendet werden<br>
'''Beispiel:'''
{
fhem "set Weihnachten on" if ("%EVENT%" eq "Weihnachten");
fhem "set Weihnachten off" if ("%PREVEVENT%" eq "Weihnachten");
}

====HomeCMDevent-<KALENDER>-each====
Befehle die beim Beginn/Ende eines beliebigen (holiday)Kalender Events eines bestimmten KALENDERs ausgeführt werden sollen.<br>
Auslöser: Beginn eines beliebigen (holiday)Kalender Events eines bestimmten KALENDERs<br>
Platzhalter '''%EVENT%''' und '''%PREVEVENT%''' können zusätzlich verwendet werden<br>
'''Beispiel für "HomeCMDevent-FEIERTAGE-each":'''
{
fhem "set Weihnachten off" if ("%PREVEVENT%" eq "Weihnachten");
}
'''Beispiel für "HomeCMDevent-URLAUBDAN-each":'''
{
if ("%EVENT%" =~ /urlaub/i)
{
speak "Dan hat jetzt Urlaub!!!";
}
elsif ("%PREVEVENT%" =~ /urlaub/i)
{
speak "Der Urlaub von Dan ist nun zu Ende!!!";
}
}

'''Beispiel für "HomeCMDevent-WOHNUNG-each":'''
{
# Heizung an/aus schalten
my $heiz = "([bksw]z|ku)_Thermostat";
if ("%EVENT%" =~ /^heizung(..+)?$/i)
{
my $zeit = $1;
if ("%SEASON%" ne "Sommer")
{

# morgens nicht alle Thermostaten schalten
$heiz = "([bks]z|ku)_Thermostat" if ($zeit && $zeit =~ /morgens?$/i);
fhem "set $heiz:FILTER=controlMode!=day controlMode day"
}
}
elsif ("%PREVEVENT%" =~ /^heizung/i)
{
fhem "set $heiz:FILTER=controlMode!=night controlMode night" if ("%SEASON%" ne "Sommer");
}

# WLAN an/aus schalten
elsif ("%EVENT%" =~ /^wlan|wifi|wi-fi/i)
{
fhem "set Router wifi off";
}
elsif ("%PREVEVENT%" =~ /^wlan|wifi|wi-fi/i)
{
fhem "set Router wifi on";
}

# G-Tag für Putzfrau (de)aktivieren
elsif ("%EVENT%" =~ /^putz/i)
{
fhem "set %NAME% deviceEnable PRESENCE_rg_Inge";
}
elsif ("%PREVEVENT%" =~ /^putz/i)
{
fhem "set %NAME% deviceDisable PRESENCE_rg_Inge";
}

# G-Tag für Gast (de)aktivieren
elsif ("%EVENT%" =~ /g([aä]|ae)st/i)
{
fhem "set %NAME% deviceEnable PRESENCE_rg_Gast";
}
elsif ("%PREVEVENT%" =~ /g([aä]|ae)st/i)
{
fhem "set %NAME% deviceDisable PRESENCE_rg_Gast";
}
}

====HomeCMDevent-<KALENDER>-<EVENT>-begin====
Befehle die beim Beginn eines bestimmten (holiday)Kalender EVENTs eines bestimmten KALENDERs ausgeführt werden sollen.<br>
Auslöser: Beginn eines bestimmten (holiday)Kalender EVENTs eines bestimmten KALENDERs<br>
Platzhalter '''%PREVEVENT%''' kann zusätzlich verwendet werden<br>
'''Beispiel für "HomeCMDevent-FEIERTAGE-Neujahr-begin":'''
set %SENSORSENERGY% meterReset

====HomeCMDevent-<KALENDER>-<EVENT>-end====
Befehle die bei Ende der (holiday)Kalender EVENTs eines bestimmten KALENDERs ausgeführt werden sollen.<br>
Auslöser: Ende der (holiday)Kalender EVENTs eines bestimmten KALENDERs<br>
Platzhalter '''%PREVEVENT%''' kann zusätzlich verwendet werden

====HomeCMDfhemDEFINED====
Befehle die ausgeführt werden sollen wenn ein neues Gerät angelegt wird (define)<br>
'''Beispiel:'''
{
# Jedem neu definierten Gerät den Geräte-TYPE auch als Raum im Menüpunkt Module zuweisen
fhem "attr %DEFINED% room Module->".$defs{"%DEFINED%"}->{TYPE};
}

====HomeCMDfhemINITIALIZED====
Befehle die ausgeführt werden sollen wenn FHEM gestartet wurde<br>
'''Beispiel:'''
msg FHEM Home wurde gestartet...

====HomeCMDfhemSAVE====
Befehle die ausgeführt werden sollen wenn in FHEM die Konfigurationsdatei gespeichert wird<br>
'''Beispiel (Backup von fhem.cfg und fhem.state):'''
{
# Datum/Uhrzeit
my $now = Timeow();
# Leerzeichen durch Unterstriche ersetzen
$now =~ s/ /_/g;
# Backup der Datei fhem.cfg
`cp $attr{global}{configfile} ./backup/fhem.cfg.$now`;
# Log-Ausgabe der gespeicherten Datei
Log3 undef,3,"saved ./backup/fhem.cfg.$now";
# Backup der Datei fhem.state
`cp $attr{global}{statefile} ./backup/fhem.state.$now`;
# Log-Ausgabe der gespeicherten Datei
Log3 undef,3,"saved ./backup/fhem.state.$now";
}

====HomeCMDfhemUPDATE====
Befehle die ausgeführt werden sollen wenn das Update von FHEM ausgeführt wurde<br>
'''Beispiel:'''
msg audio Das Update für FHEM ist beendet!

====HomeCMDicewarning====
Befehle die bei Anfang/Ende der Eiswarnung ausgeführt werden sollen<br>
Auslöser: icewarning 0/1<br>
'''Beispiel:'''
{
if (%ICE%)
{
fhem "msg push ACHTUNG!!! Es sind nur noch %TEMPERATURE%°C! Somit könnte es glatt werden!";
}
else
{
fhem "msg audio Es sind wieder %TEMPERATURE%°C! Die Glättewarnung ist damit beendet!.";
}
}

====HomeCMDicewarning-off====
Befehle die bei Ende der Eiswarnung ausgeführt werden sollen<br>
Auslöser: icewarning 0<br>
'''Beispiel:'''
msg audio Es sind wieder %TEMPERATURE%°C! Die Glättewarnung ist damit beendet!

====HomeCMDicewarning-on====
Befehle die bei Beginn der Eiswarnung ausgeführt werden sollen<br>
Auslöser: icewarning 1<br>
'''Beispiel:'''
msg audio ACHTUNG!!! Es sind nur noch %TEMPERATURE%°C! Somit könnte es glatt werden!

====HomeCMDlocation====
Befehle die beim Ändern der location ausgeführt werden sollen.<br>
Auslöser: Änderung location

====HomeCMDlocation-<LOCATION>====
Befehle die bei Änderung auf eine bestimmte location ausgeführt werden sollen.<br>
Auslöser: Änderung auf bestimmte location

====HomeCMDmode====
Befehle die beim Ändern von mode ausgeführt werden sollen.<br>
Auslöser: Änderung mode

====HomeCMDmode-absent-belated====
Befehle die nachträglich zur Abwesenheit ausgeführt werden sollen, die Zeit kann im Atteribut "HomeModeAbsentBelatedTime" eingestellt werden<br>
Auslöser: Abwesenheit + XX min<br>
'''Beispiel:'''
set Heizungen [FILTER=controlManu!=off] controlMode night

====HomeCMDmode-<MODE>====
Befehle die bei Änderung auf einen bestimmten mode ausgeführt werden sollen.<br>
Auslöser: Änderung auf bestimmten mode<br>
'''Beispiel für "HomeCMDmode-absent":'''
set HarmonyHub:FILTER=activity!=PowerOff activity PowerOff;
set wz_Ventilator:FILTER=speed!=0 speed 0;
set TYPE=SONOSPLAYER:FILTER=Volume>0 Volume 0;
set Sonos stopAll;
sleep 3;
set Wohnung [FILTER=state!=off] off"
'''Beispiel für "HomeCMDmode-asleep":'''
define atTmp_wz_Media_aus_%SELF% at +01:00:00 set HarmonyHub:FILTER=currentActivity!=PowerOff activity PowerOff;
define atTmp_wz_Venti_aus_%SELF% at +01:00:00 set wz_Ventilator:FILTER=speed!=0 speed 0;
define atTmp_wzLS_aus_%SELF% at +00:30:00 set wz_LS scene aus;
define atTmp_all_Sonos_vol_down_%SELF% at +00:02:00 set TYPE=SONOSPLAYER:FILTER=Volume!=0 Volume 0 1;
define atTmp_all_Sonos_off_%SELF% at +00:02:30 set Sonos stopAll;
set [sw]z_Auto(Music|Light):FILTER=state!=off off;
set Heizungen [FILTER=controlManu!=off] controlMode night
'''Beispiel für "HomeCMDmode-awoken":'''
set [sw]z_Auto(Music|Light):FILTER=state!=on on
'''Beispiel für "HomeCMDmode-gone":'''
set Heizungen [FILTER=controlManu!=off] controlManu off

====HomeCMDmode-<MODE>-resident====
Befehle die bei Änderung auf einen bestimmten mode, ausgelöst durch einen beliebigen Resident, ausgeführt werden.<br>
Auslöser: Änderung mode von beliebigem Resident ausgelöst<br>
'''Beispiel für "HomeCMDmode-asleep-resident":'''
msg audio @%AUDIO% Guten Nacht und schlaf' gut %ALIAS%!
'''Beispiel für "HomeCMDmode-awoken-resident":'''
{
my $msg = "Guten";
$msg .= " %FEIERTAG%" if ("%FEIERTAG%");
$msg .= " Morgen %ALIAS%";
fhem "msg audio \@%AUDIO% $msg";
fhem "defmod atTmp_wetter_%RESIDENT%_%SELF% at +00:07:00 msg audio Wettervorhersage für heute: %FORECASTTODAY%";
}

====HomeCMDmode-<MODE>-<ROOMMATE/GUEST>====
Befehle die bei Änderung auf einen bestimmten mode, ausgelöst durch einen bestimmten Resident, ausgeführt werden.<br>
Auslöser: Änderung mode von bestimmten Resident ausgelöst

====HomeCMDmodeAlarm====
Befehle die beim Ändern von modeAlarm ausgeführt werden sollen.<br>
Auslöser: Änderung modeAlarm

====HomeCMDmodeAlarm-<armaway/armhome/armnight/disarm>====
Befehle die bei Änderung auf einen bestimmten modeAlarm ausgeführt werden sollen.<br>
Auslöser: Änderung auf bestimmten modeAlarm<br>
'''Beispiel für "HomeCMDmodeAlarm-armaway":'''
{
if ("%PREVAMODE%" eq "disarm")
{
# Alarmanlage einschalten
fhem "set AA_Arm:FILTER=level!=100 alarmLevel armAll";

# Nachricht zusammensetzen
my $msg;
$msg .= "Die Alarmanlage ist nun scharf geschaltet!" if ("%RESIDENT%" ne "rr_Dan");
my $is = "%ALARMHR%" =~ /und/ ? "sind" : "ist";
$msg .= " " if ($msg);
$msg .= "ACHTUNG: %ALARMHR% $is noch offen!!!" if (%ALARMCT%);

# Nachricht an ROOMMATE/GUEST senden
fhem "msg \@%RESIDENT% $msg" if ($msg);

# Eingangstür abschließen falls noch nicht geschehen
fhem "set fl_Tuerschloss:FILTER=state!=locked lock";
}
}
'''Beispiel für "HomeCMDmodeAlarm-armhome":'''
AA_Arm:FILTER=level!=25 alarmLevel armExtSens;
set fl_Tuerschloss:FILTER=state!=locked lock
'''Beispiel für "HomeCMDmodeAlarm-armnight":'''
AA_Arm:FILTER=level!=25 alarmLevel armExtSens;
set fl_Tuerschloss:FILTER=state!=locked lock
'''Beispiel für "HomeCMDmodeAlarm-disarm":'''
{
# Alarmanlage ausschalten
fhem "set AA_Arm:FILTER=level!=0 alarmLevel disarmed";
my $prio = "";

# Nachrichtenpriorität auf 1 setzen bei Ankunft (höhere Lautstärke beim Abspielen damit man das auch vor der Tür hört)
$prio = " 1" if ("%LOCATION%" eq "arrival");

# Nachricht an ROOMMATE/GUEST senden wenn der vorherige alarmMode nicht "armnight" ist
fhem "msg audio \@fl_Sonos$prio Die Alarmanlage ist nun ausgeschaltet %ALIAS%!" if ("%PREVAMODE%" ne "armnight");
}

====HomeCMDmotion====
Befehle die bei Statusänderung eines beliebigen Bewegungsmelders ausgeführt werden sollen<br>
Auslöser: öffnen/schließen eines beliebigen Bewegungsmelders<br>
'''Beispiel:'''
{
# Raum aus Sensornamen ermitteln, z.B. bz_Sensor
my $room = (split /_/,"%SENSOR%")[0];

# Status des structure aller Lichter dieses Raums
my $lichter = Value($room."_Lichter");

# Status des dummy Tageslicht
my $tl = Value("Tageslicht");

if ("%STATE%" eq "geöffnet")
{
# Lichtwert des Sensors
my $lum = ReadingsNum("%SENSOR%","luminance",100);

# Löschen des evtl. schon vorhandenen "at"
fhem "delete atTmp_Bewegungsmelder_Licht_aus_".$room."_%SELF%" if (IsDevice("atTmp_Bewegungsmelder_Licht_aus_".$room."_%SELF%"));

# Licht nur wenn kein Tageslicht oder Lichtwert des Sensors kleiner als 10 und AutoLight eingeschaltet und modeAlarm nicht armaway
if (($tl eq "off" || $lum < 10) && $lichter eq "off" && Value($room."_AutoLight") eq "on" && "%AMODE%" ne "armaway")
{
my $scene;

# verschiedene Szenen für verschiedene Modus bzw. Aussenlichtstärken
if ("%MODE%" eq "gotosleep")
{
$scene = "Abend";
}
elsif ("%MODE%" eq "asleep")
{
$scene = "Nacht";
}
elsif (%LIGHT% > 3)
{
$scene = "viel";
}
elsif (%LIGHT% < 4)
{
$scene = "mittel";
}

# Schalten der entsprechenden Szene (Modul LightScene)
fhem "set ".$room."_LS scene $scene" if ($scene);
}
}
else
{
# unterschiedliche Ausschaltzeiten für unterschiedliche Räume
my $t = 3;
$t = 15 if ($room eq "wz");
$t = 2 if ($room eq "bz" || ($room =~ /wz|ku/ && "%MODE%" =~ /sleep/));
$t = 1 if ($room eq "fl");

# Zahl in Minuten umrechnen in einen Zeitpunkt für das "at"
my $d = HOMEMODE_hourMaker($t);

# Anlegen des "at" zum Ausschalten des Lichts wenn die Lichter angeschaltet sind und auch AutoLight eingeschaltet ist
if ($lichter ne "off" && Value($room."_AutoLight") eq "on")
{
my $cmd = "set ".$room."_LS scene aus";
fhem "defmod atTmp_Bewegungsmelder_Licht_aus_".$room."_%SELF% at +$d $cmd";
}
}
}

====HomeCMDmotion-off====
Befehle die bei Ende der Bewegung eines beliebigen Bewegungsmelders ausgeführt werden sollen<br>
Auslöser: Ende der Bewegung eines beliebigen Bewegungsmelders

====HomeCMDmotion-on====
Befehle die bei Beginn der Bewegung eines beliebigen Bewegungsmelders ausgeführt werden sollen<br>
Auslöser: Beginn der Bewegung eines beliebigen Bewegungsmelders

====HomeCMDpresence-<absent/present>====
Befehle die bei Änderung von presence ausgeführt werden sollen<br>
Auslöser: Änderung presence<br>
'''Beispiel für "HomeCMDpresence-present":'''
set w_Steckdosen [FILTER=state!=on] on;
set Heizungen [FILTER=controlManu!=off] controlMode auto

====HomeCMDpresence-<absent/present>-device====
Befehle die bei Änderung von presence, ausgelöst durch ein beliebiges Presence Device, ausgeführt werden sollen<br>
Auslöser: Änderung presence, ausgelöst durch beliebiges Presence Device<br>
'''Beispiel für "HomeCMDpresence-present-device":'''
{
# mindestens 1x täglich den Batteriewert des PRESENCE Geräts bei erkannter Anwesenheit holen
fhem '"sudo /opt/fhem/scripts/GTag-bat.sh %DEVICE% %ADDRESS% &"'
if ("%DEVICE%" =~ /^PRESENCE_/ && (!defined ReadingsVal("%DEVICE%","battery",undef) || ReadingsAge("%DEVICE%","battery",0) > 64800));
}

====HomeCMDpresence-<absent/present>-resident====
Befehle die bei Änderung von presence, ausgelöst durch einen beliebigen Resident, ausgeführt werden sollen<br>
Auslöser: Änderung presence, ausgelöst durch beliebigen Resident<br>
'''Beispiel für "HomeCMDpresence-absent-resident":'''
{
# Mich benachrichtigen wenn ich nicht zu hause bin und jemand anderes die Wohnung verlässt
fhem "msg push \@rr_Dan %ALIAS% hat gerade die Wohnung verlassen!"
if ("%RESIDENT%" ne "rr_Dan" && ReadingsVal("rr_Dan","presence","") ne "present");

# Verabschiedungsnachricht zusammensetzen
my $msg;

# Alle außer mich selbst verabschieden
$msg .= "Bis bald und auf Wiedersehen %ALIAS%..." if ("%RESIDENT%" ne "rr_Dan");

# Glättewarnung wenn nötig
$msg .= " ACHTUNG!!! Es ist %TEMPERATURE%°C kalt! Somit könnte es glatt werden!" if (%ICE%);

# Nachricht senden wenn vorhanden
fhem "msg \@%RESIDENT% $msg" if ($msg);
}
'''Beispielcode für "HomeCMDpresence-present-resident":'''
{
# alle Ankommenden außer mir selbst
if ("%RESIDENT%" ne "rr_Dan")
{
# Benachrichtigung wenn jemand kommt
fhem "msg audio %ALIAS% kommt gerade!" if ("%LOCATION%" ne "arrival");

# Nachricht an Ankommende(n) zusammensetzen
my $g = "gute";
$g .= "n" if ("%DAYTIME%" ne "Nacht);

# Nachricht an Ankommende(n) senden
fhem "msg \@%RESIDENT% Willkommen und $g %DAYTIME% %ALIAS%!";
}
}

====HomeCMDpresence-<absent/present>-<ROOMMATE/GUEST>====
Befehle die bei Änderung von presence, ausgelöst durch einen bestimmten Resident, ausgeführt werden sollen<br>
Auslöser: Änderung presence, ausgelöst durch bestimmten Resident<br>

====HomeCMDpresence-<absent/present>-<ROOMMATE/GUEST>-<DEVICE>====
Befehle die bei Änderung von presence, ausgelöst durch ein bestimmtes Presence Device eines bestimmten Resident, ausgeführt werden sollen<br>
Dieses Attribut ist nur verfügbar wenn ein Resident mehr als ein Presence Device hat<br>
Auslöser: Änderung presence, ausgelöst durch bestimmtes Presence Device eines bestimmten Resident

====HomeCMDseason====
Befehle die bei Änderung der Jahreszeit ausgeführt werden sollen<br>
Auslöser: Änderung Jahreszeit<br>
'''Beispiel'''
{
my $t = "%SEASON%";
$t .= "s" if ($t eq "Frühling");
fhem "msg push Die Wohnung ist nun im $t-Modus!";
fhem "set Heizungen [FILTER=controlMode!=auto] controlMode auto" if ($t ne "Sommer");
}

====HomeCMDseason-<SEASON>====
Befehle die bei Änderung der Jahreszeit in eine bestimmte Jahreszeit ausgeführt werden sollen<br>
Auslöser: Änderung bestimmte Jahreszeit

====HomeCMDtwilight====
Befehle die bei Änderung der Dämmerung ausgeführt werden sollen<br>
Auslöser: Änderung Dämmerung

====HomeCMDtwilight-<sr/sr_astro/sr_civil/sr_indoor/sr_weather/ss/ss_astro/ss_civil/ss_indoor/ss_weather>====
Befehle die bei Änderung zu bestimmter Dämmerung ausgeführt werden sollen<br>
Auslöser: Änderung zu bestimmter Dämmerung

====HomeCMDuwz-warn====
Befehle die bei Beginn/Ende der UWZ Warnungen ausgeführt werden sollen<br>
Auslöser: Beginn/Ende der UWZ Warnungen

====HomeCMDuwz-warn-begin====
Befehle die bei Beginn der UWZ Warnungen ausgeführt werden sollen<br>
Auslöser: Beginn der UWZ Warnungen<br>
'''Beispiel:'''
msg %UWZLONG%

====HomeCMDuwz-warn-end====
Befehle die beim Ende der UWZ Warnungen ausgeführt werden sollen<br>
Auslöser: Ende der UWZ Warnungen<br>
'''Beispiel:'''
msg Alle Unwetterwarnungen sind nun beendet!

=Platzhalter=
==verfügbar in allen HomeCMD Attributen==
===%ADDRESS%===
MAC Adresse des zuletzt ausgelösten Presence Geräts

===%ALARM%===
Liste mit Namen der ausgelösten Alarm Geräte<br>
Wert ist 0 wenn kein Alarm Device ausgelöst ist

===%ALARMCT%===
Anzahl der ausgelösten Alarm Geräte

===%ALARMHR%===
Liste mit (human readable) Namen der ausgelösten Alarm Geräte<br>
Wert ist 0 wenn kein Alarm Device ausgelöst ist<br>
kann z.B. für msg benutzt werden

===%ALIAS%===
Alias des zuletzt ausgelösten Resident

===%AMODE%===
aktueller Alarm Mode

===%AEAH%===
Wert von anyoneElseAtHome<br>
Wert ist 1 wenn on und 0 wenn off

===%ARRIVERS%===
Alias-Liste der ROOMMATE/GUEST deren location auf arrival steht<br>
kann z.B. dafür benutzt werden um Residents zu begrüßen<br>
z.B. Peter, Paul und Marry

===%AUDIO%===
Audio Device des zuletzt ausgelösten ROOMMATE/GUEST (Attribut msgContactAudio)<br>
wenn das Attribut msgContactAudio des jeweiligen Resident keinen Wert hat, so wird versucht den Wert des Attributs aus dem globalMsg (sofern vorhanden) auszulesen<br>
kann z.B. dafür benutzt werden um Resident spezifische msg(s) vom Typ audio zu senden, z.B. Nacht/Morgen Grüße/Wünsche

===%BATTERYLOW%===
Alias des zu letzt gemeldeten Geräts mit niedrigem Batteriestand

===%BATTERYLOWALL%===
Wert des Reading batteryLow_hr

===%BATTERYLOWCT%===
Wert des Reading batteryLow_ct

===%CONDITION%===
Wert des Reading condition des überwachten Yahoo weather Device<br>
kann z.B. für Wetter(vorhersage) benutzt werden

===%CONTACT%===
Wert des Reading lastContact (Name des zuletzt geöffneten Kontakt Sensor)<br>
kann z.B. dafür benutzt werden um msg zu versenden

===%DAYTIME%===
Wert des Reading daytime<br>
kann z.B. dafür benutzt werden um Tageszeit spezifische Aktionen zu schalten

===%DEVICE%===
Name des zuletzt ausgelösten Presence Gerät

===%DEVICEA%===
Wert des Reading lastAbsentByPresenceDevice

===%DEVICEP%===
Wert des Reading lastPresentByPresenceDevice

===%DISABLED%===
Wert des Reading devicesDisabled

===%DND%===
DND Status<br>
1 wenn an, 0 wenn aus

===%DURABSENCE%===
Wert des Reading durTimerAbsence_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURABSENCELAST%===
Wert des Reading lastDurAbsence_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURPRESENCE%===
Wert des Reading durTimerPresence_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURPRESENCELAST%===
Wert des Reading lastDurPresence_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURSLEEP%===
Wert des Reading durTimerSleep_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%DURSLEEPLAST%===
Wert des Reading lastDurSleep_cr des zu letzt ausgelösten ROOMMATE/GUEST

===%<CALENDARNAME>%===
Event des benannten Kalenders<br>
0 wenn kein gerade kein Event ist

===%<CALENDARNAME-EVENTNAME>%===
0 wenn das benannte Event nicht aktiv ist<br>
1 wenn das benannte Event aktiv ist

===%FORECAST%===
Wettervorhersage für morgen

===%FORECASTTODAY%===
Wettervorhersage für heute

===%HUMIDITY%===
Wert des Reading humidity von HOMEMODE

===%HUMIDITYTREND%===
Wert des Reading humidityTrend von HOMEMODE

===%ICE%===
0 wenn keine Eiswarnung besteht<br>
1 wenn Eiswarnung besteht

===%IP%===
Wert des Reading publicIP von HOMEMODE

===%LIGHT%===
Wert des Reading light von HOMEMODE

===%LOCATION%===
Wert des Reading location von HOMEMODE

===%LOCATIONR%===
Wert des Reading location des zu letzt ausgelösten ROOMMATE/GUEST

===%LUMINANCE%===
Wert des Reading luminance von HOMEMODE

===%LUMINANCETREND%===
Wert des Reading luminanceTrend von HOMEMODE

===%MODE%===
gerade aktiver Modus von HOMEMODE (Reading mode)

===%MODEALARM%===
aktueller Alarm Mode (wie %AMODE%)

===%MOTION%===
Wert des Reading lastMotion von HOMEMODE

===%NAME%===
Name des HOMEMODE Geräts selbst (identisch zu %SELF%)

===%OPEN%===
Wert des Reading contactsOutsideOpen von HOMEMODE

===%OPENCT%===
Wert des Reading contactsOutsideOpen_ct von HOMEMODE

===%OPENHR%===
Wert des Reading contactsOutsideOpen_hr von HOMEMODE

===%PANIC%===
0 wenn panic ausgeschaltet ist<br>
1 wenn panic eingeschaltet ist

===%RESIDENT%===
Name des zu letzt ausgelösten ROOMMATE/GUEST

===%PRESENT%===
presence von HOMEMODE
0 wenn absent
1 wenn present

===%PRESENTR%===
presence des zu letzt ausgelösten ROOMMATE/GUEST
0 wenn absent
1 wenn present

===%PRESSURE%===
Wert des Reading pressure von HOMEMODE

===%PRESSURETREND%===
Wert des Reading pressureTrend von HOMEMODE

===%PREVAMODE%===
vorheriger modeAlarm von HOMEMODE

===%PREVCONTACT%===
vorheriger geöffneter Kontaktsensor

===%PREVMODE%===
vorheriger mode von HOMEMODE

===%PREVMODER%===
vorheriger state des zu letzt ausgelösten ROOMMATE/GUEST

===%PREVMOTION%===
vorheriger geöffneter Bewegungsmelder

===%SEASON%===
Wert des Reading season von HOMEMODE

===%SELF%===
Name des HOMEMODE Geräts selbst (identisch zu %NAME%)

===%SENSORSBATTERY%===
Liste aus Internal SENSORSBATTERY

===%SENSORSCONTACT%===
Liste aus Internal SENSORSCONTACT

===%SENSORSENERGY%===
Liste aus Internal SENSORSENERGY

===%SENSORSMOTION%===
Liste aus Internal SENSORSMOTION

===%SENSORSSMOKE%===
Liste aus Internal SENSORSSMOKE

===%SMOKE%===
Wert des Reading alarmSmoke von HOMEMODE
0 wenn kein Alarm

===%SMOKECT%===
Wert des Reading alarmSmoke_ct von HOMEMODE

===%SMOKEHR%===
Wert des Reading alarmSmoke_hr von HOMEMODE

===%TAMPERED%===
Wert des Reading sensorsTampered von HOMEMODE

===%TAMPEREDCT%===
Wert des Reading sensorsTampered_ct von HOMEMODE

===%TAMPEREDHR%===
Wert des Reading sensorsTampered_hr von HOMEMODE

===%TEMPERATURE%===
Wert des Reading temperature von HOMEMODE

===%TEMPERATURETREND%===
Wert des Reading temperatureTrend von HOMEMODE

===%TOBE%===
are/sind oder is/ist der Wetterkondition

===%TWILIGHT%===
Wert des Reading twilight von HOMEMODE

===%TWILIGHTEVENT%===
aktuelles twilight Event

===%UWZ%===
UWZ Warnlevel

===%UWZLONG%===
alle aktuellen UWZ Warnungen (lange Version)

===%UWZSHORT%===
alle aktuellen UWZ Warnungen (kurze Version)

===%WEATHER%===
Wert von "get <HOMEMODE> weather short"

===%WEATHERLONG%===
Wert von "get <HOMEMODE> weather long"

===%WIND%===
Wert des Reading wind von HOMEMODE

===%WINDCHILL%===
Wert des Reading wind_chill vom eingebundenen Yahoo Wetter Gerät

==verfügbar in den HomeCMDcontact, HomeCMDmotion und HomeCMDalarm Attributen==
===%ALIAS%===
alias des zuletzt ausgelösten Kontakt/Bewegungs/Rauchsensors

===%SENSOR%===
name des zuletzt ausgelösten Kontakt/Bewegungs/Rauchsensors

===%STATE%===
state des zuletzt ausgelösten Kontakt/Bewegungs/Rauchsensors

==verfügbar in den HomeTextWeatherForecast Attributen==
===%CONDITION%===
Wert des Readings condition des Yahoo Weather Geräts

===%DAY%===
Tag der Wettervorhersage (1 - heute, 2 - morgen)

===%HIGH%===
maximale Temperatur der Wettervorhersage

===%LOW%===
minimale Temperatur der Wettervorhersage

==verfügbar in den HomeCMDevent Attributen==
===%CALENDAR%===
Name der Kalenders

===%DESCRIPTION%===
Beschreibung des aktuellen Event des Kalenders (nicht verfügbar bei holiday Geräten)

===%EVENT%===
Name/Titel des aktuellen Event des Kalenders

===%PREVEVENT%===
Name/Titel des vorherigen Event des Kalenders

==verfügbar in den HomeCMDdevice Attributen==
===%DEVICE%===
name der deaktivierten Geräts

===%ALIAS%===
alias der deaktivierten Geräts

=Benötigte Events=
Folgende Events werden von HOMEMODE ausgewertet bzw. werden benötigt damit HOMEMODE vollumfänglich funktionieren kann.

<table>
<tr>
<td><b>DEVICE-TYPE</b></td>
<td><b>EVENT</b></td>
</tr>
<tr>
<td>RESIDENTS</td>
<td>state</td>
</tr>
<tr>
<td></td>
<td>presence</td>
</tr>
<tr>
<td>ROOMMATE,GUEST</td>
<td>state</td>
</tr>
<tr>
<td></td>
<td>presence</td>
</tr>
<tr>
<td></td>
<td>wayhome</td>
</tr>
<tr>
<td>{SENSORSCONTACT}</td>
<td>state</td>
</tr>
<tr>
<td></td>
<td>sabotageError</td>
</tr>
<tr>
<td></td>
<td>"HomeReadings"</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsContactReadings"</td>
</tr>
<tr>
<td>{SENSORSMOTION}</td>
<td>state</td>
</tr>
<tr>
<td></td>
<td>sabotageError</td>
</tr>
<tr>
<td></td>
<td>"HomeReadings"</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsMotionReadings"</td>
</tr>
<tr>
<td>{SENSORSLUMINANCE}</td>
<td>luminance</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsLuminanceReading"</td>
</tr>
<tr>
<td>{SENSORSENERGY}</td>
<td>power</td>
</tr>
<tr>
<td></td>
<td>energy</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsPowerEnergyReadings"</td>
</tr>
<tr>
<td>{SENSORSBATTERY}</td>
<td>battery</td>
</tr>
<tr>
<td></td>
<td>"HomeSensorsBatteryReading"</td>
</tr>
<tr>
<td>"HomePresenceDeviceType"</td>
<td>presence</td>
</tr>
<tr>
<td>"HomeYahooWeatherDevice"</td>
<td>humidity</td>
</tr>
<tr>
<td></td>
<td>temperature</td>
</tr>
<tr>
<td></td>
<td>wind</td>
</tr>
<tr>
<td></td>
<td>pressure</td>
</tr>
<tr>
<td>"HomeTwilightDevice"</td>
<td>light</td>
</tr>
<tr>
<td></td>
<td>twilight</td>
</tr>
<tr>
<td></td>
<td>aktEvent</td>
</tr>
<tr>
<td></td>
<td>pressure</td>
</tr>
<tr>
<td>"HomeSensorTemperatureOutside"</td>
<td>temperature</td>
</tr>
<tr>
<td></td>
<td>humidity</td>
</tr>
<tr>
<td>"HomeSensorHumidityOutside"</td>
<td>humidity</td>
</tr>
<tr>
<td>"HomeSensorWindspeed"</td>
<td>"HomeSensorWindspeed"</td>
</tr>
<tr>
<td>"HomeSensorAirpressure"</td>
<td>"HomeSensorAirpressure"</td>
</tr>
<tr>
<td>"HomeEventsHolidayDevices"</td>
<td>state</td>
</tr>
<tr>
<td>"HomeUWZ"</td>
<td>WarnCount</td>
</tr>
</table>

MQTT Einführung

2018-07-15T12:06:02Z

50watt: /* Links */ Tippfehler

MQTT ist ein Protokoll ("Message Queue Telemetry Transport"), mit dem Daten und Befehle zwischen verschiedenen Geräten ausgetauscht werden. Die Kommunikation erfolgt dabei über einen Broker, den so genannten MQTT-Broker.

MQTT wurde entwickelt, um möglichst effizient, sicher und mit wenig Datenlast zu kommunizieren. MQTT ist ergebnisorientiert und daher muss ein Client nicht beständig beim Server anfragen, ob neue Daten vorliegen. Heute findet sich MQTT vor allem im Bereich des Internet-of-Things (IoT). Insbesondere dort, wo viele Sensoren ausgelesen werden müssen, wird MQTT eingesetzt.

Es ist daher nicht verwunderlich, dass mehr und mehr Geräte MQTT einsetzen. MQTT kann leicht mit FHEM verbunden werden, ohne dass dabei größerer CPU- oder Datenverbrauch entsteht.

== Eine sehr kurze Einführung in MQTT ==
Die folgende Einführung soll denjenigen helfen, die noch nie von MQTT gehört haben und überlegen, ob sie es in FHEM einsetzen. Sie kann eine vollwertige Einleitung wie beispielsweise [https://github.com/mqtt/mqtt.github.io/wiki diese Wikieinträge] nicht ersetzen.

Bei MQTT findet die Kommunikation nur zwischen den Geräten (seien es Empfänger oder Sender) auf der einen Seite und dem Broker auf der anderen Seite statt. Die Geräte kommunizieren nicht untereinander. Eine Nachricht besteht im Wesentlichen aus zwei Dingen: Einem Topic und einem Payload. Dies ist nicht ganz korrekt. Es gibt zwei weitere Elemente, die zu einer Nachricht gehören: Den Quality of Service (soll geprüft werden, ob die Nachricht zugestellt wurde und mit welcher "Tiefe"?) und Retained Message. Details bitte in der oben genannten Einführung nachlesen.

Eine anschauliche Beschreibung würde beide Begriffe mit einem Brief vergleichen. Der Topic entspricht der Adresse, an die der Brief geschickt wird. Der Payload ist der Inhalt, der sich im Briefumschlag befindet.

Ein Topic schafft damit eine Hierarchie der Nachrichten und sortiert für die Clienten, um was für Nachrichten es sich handelt. Topics sind einfache Strings, die mit Schrägstrichen getrennt werden (keine Leerzeichen erlaubt, das gilt auch für gewisse Sonderzeichen). Ein Topic könnte beispielhaft so lauten:
:'''zuHause/1OG/Kueche/Licht/state'''
Offensichtlich sind hier Objekte zuerst danach sortiert, ob sie sich zu Haus befinden, dann wird nach Stockwerken sortiert und im ersten Stock schaut man auf die Küche sowie das dort vorhandene Licht.

Ein Payload kann beliebige Inhalte aufnehmen. Oft enthalten Topics Befehle oder Daten.

Eine Besonderheit von MQTT besteht darin, dass die Geräte nur mit dem Broker kommunizieren. Sendet ein Gerät also Daten, werden diese an den Broker geschickt und der Broker nimmt sie entgegen. Wollen die Clienten wissen, welche Daten vorliegen, müssen sie dem Broker mitteilen, dass sie über diese Daten informiert werden wollen. Diesen Vorgang nennt man "subscribe". Im IoT ist besonders interessant, dass Sender und Empfänger von Nachrichten durch den Broker vollständig entkoppelt werden können - jemand, der Daten bereit stellt, muss sich also nicht darum kümmern, wer diese Daten empfängt.

== Installation in FHEM ==
Um MQTT in FHEM zu nutzen, benötigt man einen MQTT-Broker. Ein gern verwendeter Broker ist beispielsweise [http://mosquitto.org Mosquitto]. Er kann ohne weiteres auf dem Raspberry Pi, der bereits eine FHEM-Installation besitzt, installiert werden und wird keine größere CPU- oder Netzwerklast verursachen. MQTT kommuniziert über Port 1883.

Eine Anleitung zur Installation findet sich beispielsweise in diesem [http://blog.wenzlaff.de/?p=6487 Blogeintrag]. Im wesentlichen beschränkt sich die Installation eines MQTT Servers aber auf wenige Arbeitsschritte. Bei ''stretch'' ist ''Mosquitto'' bereits in der Distribution enthalten und kann - zusammen mit dem client Befehl ''mosquito_sub'', der weiter unten benötigt wird, wie folgt installiert und getestet werden<ref>Die für den Betrieb mit FHEM erforderlichen Perl-Module sind teilweise (noch) nicht in den Paketquellen verfügbar. Sie können dennoch statt mit cpan auch als Debian-Paket mit Hilfe von ''dh-make-perl'' installiert werden, wobei vorab das in den Paketquellen bereits vorhandene ''libmodule-pluggable-perl'' installiert werden sollte:<br>
:<br>
sudo apt-get install dh-make-perl<br>
dh-make-perl --install --cpan Net::MQTT::simple<br>
dh-make-perl --install --cpan Net::MQTT::Constants<br>
sudo dpkg -i libnet-mqtt-simple-perl*.deb<br>
sudo dpkg -i libnet-mqtt-perl*.deb</ref>:
{{Randnotiz|RNTyp=g|RNText=Für ältere Distributionen (hier am Beispiel von ''jessie'') muß ggf. aus einer zusätzlichen Paketquelle installiert werden:
wget http://repo.mosquitto.org/debian/mosquitto-repo.gpg.key
sudo apt-key add mosquitto-repo.gpg.key
cd /etc/apt/sources.list.d/
sudo wget http://repo.mosquitto.org/debian/mosquitto-jessie.list
sudo apt-get update
Danach kann die eigentliche Installation durchgeführt werden wie links für ''stretch'' beschrieben.}}<source lang="bash">
sudo apt-get install mosquitto mosquitto-clients

# MQTT Server Test
sudo service mosquitto status

# Start / Stop des Servers
sudo service mosquitto stop
sudo service mosquitto start

# Perl Version ausgeben
perl -v
# Perl MQTT Module nachinstallieren (läuft ein paar Minuten)
sudo cpan install Net::MQTT:Simple
sudo cpan install Net::MQTT:Constants
</source>
Danach ist FHEM mit <nowiki>shutdown restart</nowiki> neu zu starten.

Zur Kommunikation mit dem Broker von seiten eines Arduinos böte sich der PubSubClient an.
Um die Funktionalität des Brokers zu testen kann z.B. ein Analyse-Tool wie MQTT.fx verwendet werden.


== MQTT und Sonoff-Tasmota ==
Eine derzeit oft genutzte Möglichkeit für MQTT bilden die [[Sonoff]]-Geräte. Werden diese mit einer offenen Firmware von [https://github.com/arendst arendst] geflasht, so kommunizieren sie über MQTT. Um diese Geräte einzubinden, ist wie folgt vorzugehen. Zuerst ist Mosquitto zu installieren.

Unter Sonoff sind einige Topics voreingestellt. arendst stellt insbesondere drei Topic-Präfixe bereit, die seiner Meinung jedes Topic einleiten sollen (in den Eingabemasken als "%prefix%" notiert). Das sind einmal Kommandos (abgekürzt als cmnd), die dazu dienen, Befehle auszuführen. Daten werden mit tele und stat übertragen. Ein Topic besteht dann zuerst aus diesem Präfix und danach dem eigentlichen Topic. Wer also beispielsweise einem Sonoff_Switch einen Befehl senden will, sollte als Topic cmnd/Sonoff_Switch wählen. Wenn der Switch ein- und ausgeschaltet werden kann, muss der Topic noch das Wort POWER enthalten (in MQTT werden viele Kennworte komplett groß geschrieben). Der Topic lautet damit vollständig "cmnd/Sonoff_Switch/POWER/set"

Die Einrichtung in FHEM wird von den Modulen 00_MQTT.pm, 10_MQTT_BRIDGE und 10_MQTT_DEVICE.pm unterstützt.
Ebenso wird das Modul 98_expandJSON.pm benötigt, um den {{Link2Forum|Topic=66761|LinkText=JSON String zu filtern}}.

Briges und Devices unterscheiden sich wie folgt. Eine Bridge ist ein Gerät, das bereits in FHEM angelegt wurde und nur mit MQTT verbunden werden soll. Ein Device existiert noch nicht in FHEM und soll erst angelegt werden.

Link zum Forum: {{Link2Forum|Topic=27532|LinkText=MQTT FHEM Einrichtung}}

{{Randnotiz|RNTyp=g|RNText=Sofern der Broker mit FEHM über localhost kommunizieren kann, sollte als IP 127.0.0.1 verwendet werden.}}
### 1. Broker anlegen ###
define myBroker MQTT 10.0.0.5:1883 ## bitte EIGENE IP-Adresse eintragen

### 2. FHEM Device mit MQTT verbinden ###
define Sonoff_Switch MQTT_DEVICE
attr Sonoff_Switch IODev myBroker
attr Sonoff_Switch devStateIcon ON:rc_GREEN:OFF OFF:rc_RED:ON
attr Sonoff_Switch icon hue_filled_br30
attr Sonoff_Switch publishSet ON OFF cmnd/TestSwitch/POWER
attr Sonoff_Switch room MQTT
attr Sonoff_Switch subscribeReading_Licht stat/Sonoff_Switch/POWER
attr Sonoff_Switch subscribeReading_Sensor tele/Sonoff_Switch/SENSOR
attr Sonoff_Switch subscribeReading_Status stat/Sonoff_Switch/STATUS
attr Sonoff_Switch webCmd ON:OFF

Der hier dargestellte Beispielcode realisiert die Kommunikation zwischen FHEM und dem sonoff Modul via MQTT Broker. Zu beachten ist hier, dass '''subscribeReading_Licht''' und '''subscribeReading_Status''' unterschiedliche Syntax des Topic Strings haben!

== Sicherheit ==
Prinzipiell ist MQTT ebenso sicher wie eine Postkarte. Solange man es nicht extra absichert, kann jeder der, im eigenen LAN ist (und die Adresse vom Broker kennt) alle Topics mitlesen.
:<code>meinHaus/Flur/Haustuer:open / close</code>
ist da nicht wirklich schlau!

Abhilfe:
=== Username / Passwort ===
Zunächst kann man erst mal einen Username / Passwort vergeben. Da ist zwar auch noch lange nicht sicher, aber zumindest steigert es den Aufwand schon mal. Jetzt muss man zumindest schon mal Pakete sniffen und verstehen, um unbefugt zu lesen oder gar zu publishen.

=== TLS ===
Um wirklich sicher zu werden, führt kein Weg an TLS vorbei. Leider kann z.B. ein Arduino das schlicht nicht mehr. Irgendwo machen sich der Speicher und die Rechenleistung dann doch bemerkbar.

== Links ==
* [http://mqtt.org Offizielle Homepage von MQTT, englisch]
* [http://www.hivemq.com/blog/mqtt-essentials-part-1-introducing-mqtt Sehr gute Einführung, englisch, sind 5 lesenswerte Teile]
* [https://www.heise.de/developer/artikel/MQTT-Protokoll-fuer-das-Internet-der-Dinge-2168152.html Ein Exkurs von Heise mit Beispielen, deutsch, sehr lesenswert]
* [http://www.mqttfx.org/ MQTT FX - ein sehr praktisches Analysetool]
* {{Link2Forum|Topic=69230|LinkText=Diskussionsthread im Forum}}
* [[MQTT_Einf%C3%BChrung_Teil_2|Teil 2 der MQTT Einführung]]; schwerere Kost
* [[MQTT Einführung Teil 3|Teil 3 der MQTT Einführung: Hände schmutzig machen]]

== Hinweise ==
<references />
[[Kategorie:Glossary]]
[[Kategorie:HOWTOS]]

PRESENCE

2018-06-29T12:53:30Z

50watt: /* BT-Tags aktivieren */

{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h

|ModTechName=73_PRESENCE.pm
|ModOwner=markusbloch
}}

Das [[PRESENCE]] Modul bietet für die Anwesenheitserkennung mehrere Varianten an:

* '''lan-ping''' - Das Überwachen via PING Checks, die durch den FHEM Server versandt werden.
* '''fritzbox''' - Das Überwachen von Geräten auf einer FritzBox via ctlmgr_ctl (Nur auf einer FritzBox möglich)
* ''' Bluetooth'''
:- '''local-bluetooth''' - Das Überwachen via Bluetooth Checks, die vom FHEM Server direkt durchgeführt werden (angeschlossener Bluetooth-Stick und die Software bluez voraussgesetzt)
:- '''lan-bluetooth''' - Das Überwachen von Bluetoothgeräten, über Netzwerk. Auf einer oder mehreren Maschinen im Netzwerk (z.B. [[:Kategorie:Raspberry Pi|Raspberry Pi]]) läuft ein Presence-Daemon, der nach Bluetooth-Geräten sucht. Um mehrere Presence-Daemon mit FHEM zu verbinden, gibt es den Collector-Daemon, der sich zu allen Presence-Damons im Netzwerk verbindet und das Ergebnis von allen zusammenfasst.
* '''function''' - Das Überwachen mithilfe einer selbst geschrieben Perl-Funktion, die den Anwesenheitsstatus zurückgibt (0 oder 1)
* '''shell-script''' - Das Überwachen mithilfe eines selbst geschriebenen Shell-Programms/Skript, das eine 0 oder 1 ausgibt, um den Anwesenheitsstatus mitzuteilen.

= Überwachen mittels Ping im WLAN/LAN =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Um ein Gerät via Ping zu überwachen, muss folgende Definition durchgeführt werden:
:<code>define Handy PRESENCE lan-ping 192.168.0.30</code>

Dadurch wird die IP-Addresse 192.168.0.30 alle 30 Sekunden geprüft, ob sie erreichbar ist. Wenn sie erreichbar ist, ist der Status "present" (anwesend), ansonsten "absent" (abwesend).

Der Timeout kann verändert werden, indem ein Wert (in Sekunden) an das Define anhängt wird:
:<code>define Handy PRESENCE lan-ping 192.168.0.30 '''60'''</code>

Nun würde das Handy alle 60 Sekunden geprüft werden.

Nur wenn bei einem iPhone/iPad die Funktion "über WLAN synchronisieren" aktiviert ist, ist es auch im Standby zuverlässig pingbar. Standardmäßig deaktivieren Apple-Geräte ihr WLAN im Standby-Betrieb um die Akkulaufzeit zu verlängern.

Sollte die Fehlermeldung
:<code> PRESENCE (Handy) - ping command returned with output: ping: icmp open socket: Operation not permitted </code>
im Log auftauchen und lan-ping dadurch nicht funktionieren, liegt ein Berechtigungsproblem vor. Kein Grund den User fhem zu root zu machen!
Prüfe zu erst als User root ob die Capabilities gesetzt sind.
:<code>getcap /bin/ping</code>
Sollte folgendes Ergeben zu Tage fördern.
:<code>/bin/ping = cap_net_raw+ep</code>
Ist dem nicht so, setzen wir die benötigten Capabilities
:<code>setcap cap_net_raw+ep /bin/ping</code>
Mehr Informationen zum Thema Capabilities [https://manpages.debian.org/jessie/manpages-de/capabilities.7.de.html].

= FritzBox: direktes Abfragen der Aktivität via ctlmgr_ctl =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Eine sehr häufige und auch zuverlässige Methode ist auf einer FritzBox die Abfrage mittels ctlmgr_ctl Befehl. Über diesen lassen sich alle Geräte abfragen ob sie aktiv sind. Ist ein Gerät aktiv, so gilt es als anwesend.

Dieser Modus kann allerdings nur in FHEM Installationen direkt auf einer FritzBox verwendet werden. Des weiteren muss FHEM unter dem User root laufen. Um ein Gerät zu überwachen, wird lediglich der Gerätename benötigt, so wie er unter dem Menüpunkt "Heimnetz" auftaucht.

Die erforderliche Definition:
:<code>define Handy PRESENCE fritzbox iPhone-4S</code>

= Überwachung mittels Perl-Code =
Es ist möglich zum Überwachen von Geräten eine eigene Perl-Funktion zu verwenden die dann vom PRESENCE Modul im Hintergrund aufgerufen wird.

define <name> PRESENCE function {...} [ <check-interval> [ <present-check-interval> ] ]

Sobald die Funktion den Rückgabewert 1 hat, ist das Gerät anwesend, bei 0 abwesend.

== Beispiel DHCP Überwachung auf Airport Basestation ==
Die hier vorgestellte Überwachung der DHCP Lease auf Airport Basestations per SNMP ist absolut robust gegenüber dem Ruhezustand von iOS und setzt keine weitere Konfiguration auf dem iPhone voraus. Das Abmelden beim Verlassen des Empfangsbereiches der Basestation geschieht mit etwa 5-10 Minuten Verzögerung und ist somit auch vor kurzzeitigen Empfangsproblemen sicher. Das nebenstehende Bild (???) verdeutlicht noch mal die Unterschiede zwischen einer IP-Basierten Ping-Überwachung und der Überwachung auf Ebene der Basestation oder FritzBox.

Bevor der folgende Code verwendet werden kann ist das Perl Modul Net:SNMP zu installieren (z. B. mit: <code>cpan install use Net::SNMP</code>).

Zuerst ist folgender Code in 99_myUtils.pm einzufügen, sollte diese noch nicht vorhanden sein muss diese aus dem Template welches unter Edit Files zu finden ist erzeugt werden.
'''Achtung, das ist nicht der komplette Inhalt der 99_myUtils!''' Das ist nur die einzelne Routine

<pre>
use Net::SNMP;
sub
snmpCheck($$)
{
my ($airport,$client)= @_;

my $community = "public";
my $host = $airport;
my $oid = ".1.3.6.1.2.1.3.1.1.2";
#my $oid = ".1.3.6.1.2.1.3.1.1.2.25.1.10.0.1";

my ( $session, $error ) = Net::SNMP->session(
-hostname => $host,
-community => $community,
-port => 161,
-version => 1
);

if( !defined($session) ) {
return 0;
return "Can't connect to host $host.";
}

my @snmpoids = ();

my $response = $session->get_next_request($oid);
my @nextid = keys %$response;
while ( @nextid && $nextid[0] && $nextid[0] =~ m/^$oid/ ) {
push( @snmpoids, $nextid[0] );

$response = $session->get_next_request( $nextid[0] );
@nextid = keys %$response;
}

if( !defined($response = $session->get_request( @snmpoids ) ) ) {
return 0;
}

foreach my $value (values %$response) {
return 1 if( $value eq $client )
}

return 0;
}
</pre>

Danach lässt sich das Mobilgerät so überwachen:
:<code>define iPhone PRESENCE function {snmpCheck("10.0.1.1","0x44d77429f35c")} 30 30</code>

wobei 10.0.1.1 durch die IP-Adresse der Basestation und 0x44d77429f35c durch die MAC Adresse des Geräts als HEX-Zahl ersetzt werden muss.

== Beispiel Anwesenheitserkennung mittels UniFi Controller ==

Die Anwesenheitserkennung bei Geräten in Verbindung mit UniFi-Produkten funktioniert selbst dann, wenn sich die Geräte im PowerSave-Modus befinden.

Beachte: Die Geräte werden erst ungefähr nach 5 Minuten, nachdem das Gerät das WLAN verlassen hat als disconnected angezeigt.

<code>define <NAME> PRESENCE function {ReadingsVal("<UniFi>","<NamedDevice>","") eq "connected" ? 1:0}</code>

= Überwachen mittels Events =
Der Vorteil gegenüber der Function-Variante ist, dass diese Variante ohne Blocking.pm-Overhead direkt ausgeführt werden kann und in "Echtzeit" abläuft (siehe {{Link2Forum|Topic=40287|Message=562823}}).

<code>define <NAME> PRESENCE event UniFi:NamedDevice:.disconnected UniFi:NamedDevice:.connected</code>

= Überwachen mittels Bluetooth =
== Vorbereitung und Informationen ==
=== Getestete Hardware/Software ===
* '''Raspbian System''' - wheezy, Jessie (interner BT-Controller)
* '''BT-Dongle''' - CSL NET BT USB2.0 Stick, Bluetooth V4.0, Nano <br />'''Achtung''': Es muss ein BT V4.0 oder höher verwendet werden. Nur dieser unterstützt ''LowEnergy''
* '''BT-TAG''' - Gtag von Gigaset, TrackR, UDOO Neo, PebbleBee, iTag von Unitec, X4-LIFE Multifunkti BL-Anhänger, iTag Wireless Anti, Trackr bravo

=== BT-Dongle am RaspberryPI installieren ===
Um den BT-Dongle ''(hier: CSL NET BT USB2.0)'' am RaspberryPI verwenden zu können, müssen die notwendigen Pakete über die Paketverwaltung von debian nachinstalliert werden.
Wer bereits ein BT-Dongle installiert hat, kann diesen Schritt überspringen.
<pre>
apt-get install bluetooth
</pre>
Nach erfolgreicher Installation der Pakete sollte der RaspberryPI neu gestartet werden.
<pre>
sudo reboot
</pre>

Nach dem erfolgten Reboot bitte das Log des RaspberryPI auf folgende Einträge prüfen:
<pre>
Feb 12 19:52:55 fhem kernel: [ 4.773600] Bluetooth: Core ver 2.20
Feb 12 19:52:55 fhem kernel: [ 4.773748] NET: Registered protocol family 31
Feb 12 19:52:55 fhem kernel: [ 4.773765] Bluetooth: HCI device and connection manager initialized
Feb 12 19:52:55 fhem kernel: [ 4.773797] Bluetooth: HCI socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773821] Bluetooth: L2CAP socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773890] Bluetooth: SCO socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.797531] usbcore: registered new interface driver btusb
</pre>
Sobald der BT-Dongle erkannt wurde ''leuchtet'' (wenn vorhanden) auch die ''blaue/gelbe'' LED am Dongle auf.

=== BT-Tags aktivieren ===
Jetzt kann der BT-Tag aktiviert werden. Bei einigen BT-Tags muss dafür die '''Batteriesicherung''' gezogen werden.

Ein BT-Tag wird mit folgendem Befehl auf der Konsole gesucht:
<syntaxhighlight lang="bash">
sudo hcitool lescan

Ausgabe z.B.:
LE Scan ...
7C:2F:80:A1:XA:XD (unknown)
7C:2F:80:A1:XA:XD Gigaset G-tag
7C:2F:80:A1:X4:X1 (unknown)</syntaxhighlight>
Eine Übersicht über die möglichen Befehle von hcitool gibt es mit der Eingabe von:
<pre>
sudo hcitool

Ausgabe z.B.:
hcitool - HCI Tool ver 5.23
Usage:
hcitool [options] <command> [command parameters]
Options:
--help Display help
-i dev HCI device
Commands:
dev Display local devices
inq Inquire remote devices
scan Scan for remote devices
name Get name from remote device
info Get information from remote device
spinq Start periodic inquiry
epinq Exit periodic inquiry
cmd Submit arbitrary HCI commands
con Display active connections
cc Create connection to remote device
dc Disconnect from remote device
sr Switch master/slave role
cpt Change connection packet type
rssi Display connection RSSI
lq Display link quality
tpl Display transmit power level
afh Display AFH channel map
lp Set/display link policy settings
lst Set/display link supervision timeout
auth Request authentication
enc Set connection encryption
key Change connection link key
clkoff Read clock offset
clock Read local or remote clock
lescan Start LE scan
lewladd Add device to LE White List
lewlrm Remove device from LE White List
lewlsz Read size of LE White List
lewlclr Clear LE White list
lecc Create a LE Connection
ledc Disconnect a LE Connection
lecup LE Connection Update
</pre>

Falls beim SCAN kein BT-Tag gefunden wird, sollte das BT Interface neu gestartet werden. Dazu ist kein Reboot des RaspBerryPI notwendig.
<syntaxhighlight lang="bash">
sudo hciconfig hci0 down
sudo hciconfig hci0 up
sudo hcitool dev
</syntaxhighlight>

== Überwachung durch den FHEM Server direkt ==
[[Datei:Bluetooth-Adresse-iPhone.png|thumb|Bluetooth-Adresse eines iPhones]]
Jenach Aufstellungsort des FHEM Servers kann es sinnvoll sein, eine Bluetooth-Überwachung direkt durch den FHEM Server durchzuführen. Hierbei gilt allerdings zu beachten, dass Bluetooth nicht für große Reichweiten gedacht ist und in den meisten Fällen keine Wände überwinden kann. Das heisst, dass in den meisten Fällen damit nur ein Raum überwacht werden kann.

Je nach Einsatzzweck kann das auch so gewollt sein. Bluetooth USB Sticks, die bereits Bluetooth 4.0 unterstützen, können höhere Reichweiten über Zimmerwände hinaus erreichen. Vorausgesetzt, das Mobilgerät unterstützt Bluetooth 4.0.

Um eine Überwachung per Bluetooth durchführen zu können, benötigt man die Bluetooth-Adresse eines Gerätes. Diese ähnelt vom Aufbau einer MAC-Adresse. Generell wird die Adresse in den Telefon-Informationen bei Smartphones angezeigt.

Um eine Anwesenheitserkennung via Bluetooth durchzuführen, wird folgende Definition in der [[Konfiguration]] benötigt:
:<code>define Handy PRESENCE local-bluetooth XX:XX:XX:XX:XX:XX</code>

== Überwachung durch verteilte Agenten in der Wohnung (presenced/lepresenced/collectord) ==
[[Datei:Raspberry-Pi-mit-WLAN-und-Bluetooth-Stick.jpg|thumb|left|Raspberry Pi mit Bluetooth- und WLAN-USB-Stick]]
Um eine zuverlässige und flächendeckende Bluetooth-Anwesenheitserkennung durchzuführen, ist es unerlässlich, mehrere Bluetooth-Empfänger zu verwenden, die auf mehrere oder alle Räume verteilt sind.

Hierfür bietet sich zum Beispiel ein [[Raspberry Pi]] mit einem Mini-Bluetooth-USB-Stick und evtl. einem WLAN-USB-Stick an. Jeder Raum wird mit solch einem Raspberry ausgestattet und ist im WLAN Netz verfügbar.

Dieses Netz aus Raspberrys wird mit dem presenced / lepresenced Programm ausgestattet. Beide Programme sind Perl-Skripte, die als Daemon im Hintergrund laufen und auf Anfragen via Netzwerk warten. Es wird lediglich eine vollständige Perl-Grundinstallation mit Standardmodulen benötigt.

=== Unterschied presenced / lepresenced / collectord ===
presenced und lepresenced sind Programme, welche in regelmäßigen Abständen nach Bluetooth-Geräten suchen. Sobald ein Gerät, welches vorab definiert wurde, gefunden wird, wechselt der Status des Geräts in FHEM auf Anwesend. Der Unterschied zwischen presenced und lepresenced ist, dass lepresenced insbesondere für [https://de.wikipedia.org/wiki/Bluetooth_Low_Energy Bluetooth-LE-Devices] ist und presenced für "normale" Bluetooth-Geräte.

collectord wiederum ist ein Programm, welches mehrere Pis verbindet und auf allen den aktuellen Status von presenced/lepresenced abfragt. Ist das gesuchte Bluetooth-Gerät auf einem der Pi anwesend, so wird es auch in der definierten Hauptinstanz auf anwesend gesetzt. Zusätzlich wird der Pi auf dem das Gerät gefunden wurde als Reading angegeben. Sofern alle Räume einen Empfangspegel (RSSI) ermitteln können, wird bei mehreren anwesenden Räumen der Raum mit dem besten Empfangspegel selektiert (siehe {{Link2Forum|Topic=54482}}).

=== Installation von (le)presenced ===
Diese Anleitung ist sowohl für presenced, als auch für lepresenced gültig. Einfachheitshalber wird nur lepresenced erwähnt, sämtliche Schritte gehen jedoch auch mit presenced, wobei einfach die genannten Daten durch presenced ersetzt werden müssen.

Die Software lepresenced kann aktuell über drei Varianten installiert werden. Dabei ist die bevorzugte Variante (Variante 1) die Installation über das bereitgestellte .deb-Paket.
Die Variante 2 setzt voraus, dass im FHEM contrib Verzeichnis (/opt/fhem/contrib) die aktuelle Version des .deb-Pakets liegt. Die Variante 3 ist dafür gedacht, wenn man keine .deb-Pakete installieren kann/will oder es aus anderen Gründen nicht funktioniert. Es wird davon abgeraten die Variante 3 zu verwenden. Vollständigkeitshalber wird sie aber aufgeführt.

===== Installation per .deb-Paket =====

Die bevorzugte Variante ist die Installation von lepresenced durch die passenden .deb Pakete.
{{Randnotiz|RNText=Bei einem Upgrade einer älteren Version reicht es, das neue .deb Paket mit
:<code>sudo dpkg -i lepresenced-X.XX-X.deb</code>
zu aktualisieren}}

'''1.Variante:'''
Herunterladen der aktuellen lepresenced-0.83-3.deb (Stand August 2017) Datei über den Webbrowser
[https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/ SVN-Repository]. Im SVN die passende Datei auswählen und in der folgende Webseite den Link unter:
<pre>
Download in other formats:
Original Format
</pre>
anklicken und die Datei herunterladen.
Die Datei kann jetzt auf den RPi kopiert und mit folgenden Befehlen ausgeführt werden (ggf. Berechtigungen anpassen).

Alternativ per wget Befehl direkt auf den RPi (aktuelle Versionsnummer beachten)
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/lepresenced-0.83-3.deb

'''2.Variante:''' (zu Verwenden, wenn es Probleme bei Variante 1 gibt)
Herunterladen aus dem fhem contrib Verzeichnis:
Hierzu muss das contrib auf dem aktuellen Stand sein. Dazu wird die Installation von subversion (normal bereits vorhanden) benötigt.

sudo apt-get install subversion

Danach kann per
sudo svn checkout https://svn.fhem.de/fhem/trunk/fhem/contrib svnrepo

Das aktuelle Repository auf den Pi heruntergeladen werden. Danach sollte im gewählten Verzeichnis die eingecheckten Dateien verfügbar sein.
/opt/fhem/svnrepo/PRESENCE/deb

''' Installation der Variante 1 oder 2 '''

Egal welche Variante gewählt wurde, nun kann mit folgenden Befehlen das Paket installiert werden. Bitte Pfade ggf. anpassen.

'''Wichtig''': Das '''Paket''' hat eine ca. Größe von '''6,5Kb'''. Ab und an gibt es wohl Probleme mit der Installation, wodurch die Datei 11,5kb groß wird.
Diese Datei lässt sich nicht Installieren. In diesem Fall das Paket bitte mit der Variante 1 und dem Bereich "Download in other formats" herunterladen.

sudo dpkg -i lepresenced-0.83-3.deb

sudo apt-get -f install

Die Ausgabe der Installation sollte am Ende ein [ ok ] Starting lepresenced (via systemctl): lepresenced.service. ausgeben.

<pre>
Paketlisten werden gelesen... Fertig
Abhängigkeitsbaum wird aufgebaut.
Statusinformationen werden eingelesen.... Fertig
Abhängigkeiten werden korrigiert ... Fertig
Die folgenden zusätzlichen Pakete werden installiert:
bluez-hcidump
Die folgenden NEUEN Pakete werden installiert:
bluez-hcidump
0 aktualisiert, 1 neu installiert, 0 zu entfernen und 0 nicht aktualisiert.
1 nicht vollständig installiert oder entfernt.
Es müssen 157 kB an Archiven heruntergeladen werden.
Nach dieser Operation werden 490 kB Plattenplatz zusätzlich benutzt.
Möchten Sie fortfahren? [J/n]
Holen: 1 http://archive.raspberrypi.org/debian/ jessie/main bluez-hcidump armhf 5.23-2+rpi2 [157 kB]
Es wurden 157 kB in 0 s geholt (921 kB/s).
Vormals nicht ausgewähltes Paket bluez-hcidump wird gewählt.
(Lese Datenbank ... 42033 Dateien und Verzeichnisse sind derzeit installiert.)
Vorbereitung zum Entpacken von .../bluez-hcidump_5.23-2+rpi2_armhf.deb ...
Entpacken von bluez-hcidump (5.23-2+rpi2) ...
Trigger für man-db (2.7.0.2-5) werden verarbeitet ...
bluez-hcidump (5.23-2+rpi2) wird eingerichtet ...
lepresenced (0.82-1) wird eingerichtet ...
[ ok ] Starting lepresenced (via systemctl): lepresenced.service.
</pre>

'''3.Variante:'''

Bei dieser Variante wird das aktuellste lepresenced Skript aus github heruntergeladen. Das bedeutet, dass jegliche Konfiguration wie automatischer Start, Berechtigungen etc.
manuell konfiguriert werden muss. Diese Variante eignet sich nur für diejenigen, die keine .deb-Pakete installieren wollen/können oder die genau Wissen, was sie tun!
<pre>
https://github.com/mhop/fhem-mirror/blob/master/fhem/contrib/PRESENCE/lepresenced
</pre>

Zur "Installation" des Skripts folgendermaßen vorgehen:
Unter /fhem manuell den Ordner „script“ anlegen:
<pre>
mkdir script
</pre>
Datei lepresenced reinkopieren und ausführbar machen:
<pre>
sudo chmod +x /opt/fhem/script/lepresenced
sudo chgrp -cR dialout lepresenced
</pre>
Skript erstmalig starten:
<pre>
sudo ./lepresenced --loglevel LOG_EMERG -d
</pre>
Kommt beim Starten des Skript eine Fehlermeldung, müssen die Abhängigkeiten aufgelöst werden.
<pre>
Can't locate Net/Server/Daemonize.pm in @INC (@INC contains: /etc/perl /usr/local/lib/perl/5.14.2 /usr/local/share/perl/5.14.2 /usr/lib/perl5 /usr/share/perl5 / usr/lib/perl/5.14 /usr/share/perl/5.14 /usr/local/lib/site_perl .) at /opt/fhem/lepresenced line 17.
BEGIN failed--compilation aborted at /opt/fhem/lepresenced line 17.
</pre>
Um die Abhängigkeiten aufzulösen muss folgendes nachinstalliert werden und anschließend ein Reboot durchgeführt werden.
<pre>
sudo apt-get install libnet-server-*
</pre>

===== Einrichtung eines Bluetooth-Geräts über FHEM =====

Nach dem letzten Schritt sind alle Bedingungen für eine abschließende Konfiguration eines BT-Geräts in FHEM abgeschlossen worden.
Jetzt kann der zum Beispiel ein G-Tag dem FHEM-Server bekannt gemacht werden:
<pre>
-- Name Modul Modus MAC vom Gtag IP vom PI Port Abfragezeit in Sekunden
define MeinGtAG PRESENCE lan-bluetooth xx:xx:xx:xx:xx:xx 127.0.0.1:5333 120
</pre>

'''Wichtig ist den angegeben Port zu unterscheiden. Für presenced muss der Port 5111 genommen werden, für lepresenced der Port 5333.'''
Den absent und present Mode kann man einfach testen, in dem man den Gtag mit Alufolie einwickelt.

Diese Variante sollte eingesetzt werden, wenn nur ein Pi nach Bluetooth-Geräten sucht. Möchte man mehr als ein Gerät nutzen um zum Beispiel eine größere Fläche abzudecken so muss mit collectored gearbeitet werden.

=== Alle Räume gemeinsam ansprechen mittels collectord ===
Um zwei presenced- oder lepresenced Installationen zu verbinden wird der collectord Daemon von Markus Bloch benötigt. Dieser kennt alle presenced-Installationen im Netzwerk und führt eine koordinierte Suche nach den gewünschten Geräten durch. Sobald ein Gerät in einem Raum erkannt wurde, meldet der collectord den Status einschließlich der Angabe des Raumes, in dem das Gerät erkannt wurde.

[[Datei:Presence_Collectord_Uebersicht.jpg|200px|thumb|left|Schematische Darstellung Presence und Collectord, Danke an dtavb]]
Auf Basis folgender Skizze wird die Einrichtung und der Betrieb der Anwesenheitserkennung und Überwachung <p></p>
mit dem PRESENCE-Modul sowie dem Skript (.deb-Paket) lepresenced beschrieben. Zusätzlich wird für die Verbindung <p></p>
mehrere lepresenced Instanzen der collectord verwendet.<p></p>
Diese Skizze dient als Basis für alle genannten Konfigurationen innerhalb dieses Artikels.
{{NeuerTextBlock}}

==== Aufbau ====
; RPi1 (Hauptinstanz):
: FHEM Installation
: presence/lepresenced Installation
: collectord installation
: Sämtliche Bluetooth-Geräte in FHEM definiert
; RPi2 (Zweitsystem):
: FHEM installation
: presence/lepresenced Installation
: Sämtliche Bluetooth-Geräte in FHEM definiert

==== Installation per .deb-Paket ====
collectord wird heruntergeladen und installiert:
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/collectord-1.8.deb (Stand Januar 2018)
<pre>
sudo dpkg -i collectord-1.8.deb
</pre>

Nach der Installation befindet sich im Verzeichnis: /etc/collectord.conf die Konfigurationsdatei für das collectord. Weitere Einstellungen können unter /etc/default/collectord vorgenommen werden.

==== Konfiguration auf Shellebene ====
<pre>
sudo vi /etc/collectord.conf
</pre>

Diese Datei muss jetzt nach folgender Vorlage angepasst werden.
<pre>
# room definition
#[room-name] # name of the room
#address=192.168.0.10 # ip-address or hostname
#port=5111 # tcp port which should be used (5111 is default)
#presence_timeout=120 # timeout in seconds for each check when devices are present
#absence_timeout=20 # timeout in secondsfor each check when devices are absent

[RPi1] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=127.0.0.1 # Lokale Adresse RPi1 , da hier das Collectord später laufen soll!
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaelte Pruefintervalle
absence_timeout=60 # Selbstgewaelte Pruefintervalle

[RPi2] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=192.168.178.127 # IP-Adresse der Instanz, wo nur das Presence laueft, also RPi2
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaelte Pruefintervalle
absence_timeout=60 # Selbstgewaelte Pruefintervalle
</pre>

Hinweis:
* Es dürfen keine [Namen] mit Leerzeichen verwendet werden
* Der angegebene Port richtet sich danach, ob auf dem Pi presenced (Port 5111) oder lepresenced (Port 5333) nach dem Bluetooth-Gerät sucht

==== Konfiguration in FHEM ====
;RPi1
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 127.0.0.1:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222)''
;RPi2
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 192.168.178.127:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222 - die IP-Adresse von die von RPi1)''

Nach der Konfiguration kann der Daemon gestartet werden.
Sobald das Bluetoothgerät irgendwo in der Wohnung erkannt wurde, meldet der Collectord dies sofort
an FHEM und teilt den Raum mit in dem es erkannt worden ist. Diese Information wird im Reading "rooms" des jeweiligen BT-Gerätes dargestellt.

Zum testen sollte collectord einmalig manuell gestartet werden. Dies hat den Vorteil, dass man nochmal den Port des collectord prüfen kann, dieser steht in der Zeile <pre>created socket on 0.0.0.0 with port 5222</pre> und man sehen kann, ob der collectord richtig startet, oder Fehler auswirft. Gestartet wird mit folgendem Kommando:
<pre>
sudo collectord -vv -c /etc/collectord.conf
</pre>
Die Ausgabe sieht wie folgt aus:
<pre>
2017-04-02 17:52:55 - =================================================
2017-04-02 17:52:55 - started with PID 15554
2017-04-02 17:52:55 - reading configuration file
2017-04-02 17:52:55 - no config errors found
2017-04-02 17:52:56 - created socket on 0.0.0.0 with port 5222
2017-04-02 17:53:20 - new connection from 127.0.0.1:48656
2017-04-02 17:53:20 - created thread 1 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - created thread 2 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - new connection from 127.0.0.1:48662
2017-04-02 17:53:20 - new connection from 127.0.0.1:48664
2017-04-02 17:53:20 - created thread 3 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 4 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 5 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:20 - created thread 6 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51638
2017-04-02 17:53:22 - created thread 7 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - created thread 8 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51640
2017-04-02 17:53:22 - created thread 9 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:23 - created thread 10 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:29 - new connection from 192.168.xxx.xxx:51642
2017-04-02 17:53:29 - created thread 11 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
2017-04-02 17:53:29 - created thread 12 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
</pre>

Wenn das Log wie oben abgebildet aussieht wurde alles richtig gemacht und unter dem Device in FHEM erscheint ein neues Reading "rooms" mit dem Wert der erkannten PRESENCE-Installation.

'''Verhalten presence timeout im zusammenhang mit dem Attribut "absenceThreshold" der PRESENCE Konfiguration in FHEM'''
<br>
In der collectord.conf sind <code>presence_timeout</code> und <code>absence_timeout</code> für den jeweiligen Raum konfiguriert.
Das bedeutet, sobald irgendein Gerät in diesem jeweiligen Raum anwesend/abwesend ist, wird das jeweilige Timeout an den verbundenen presenced/lepresenced geschickt um damit das Check-Interval entsprechend zu ändern.

In der PRESENCE-Definition kann man ebenfalls ein <code>absence_timeout</code>/<code>presence_timeout</code> setzen. Sobald sich der Zustand ändert, wird auch das jeweilige Timeout an den collectord gesandt. Dies hat aber auf die Checks in den jeweiligen Räumen und damit der collectord.conf keinen Einfluss. Der collectord schickt ein Statusupdate an PRESENCE nur, wenn das vorgegebene Timeout (von PRESENCE) erreicht ist und keine Statusänderung stattfand. Sobald eine Änderung des Status erfolgt wird natürlich sofort der Status an PRESENCE geschickt.

Das Attribut absenceThreshold/presenceThreshold funktioniert nachwievor. Hier ist nur wichtig wie man die Timeouts sowohl in PRESENCE als auch collectord.conf setzt.

'''Das Reading "room" bei einer PRESENCE Definition und der Zusammenhang zu collectord'''
<br>
Wenn ein BT LE Empfänger in mehr als einem Raum detektiert wird, führt der collectord (ab Version 1.8) eine RSSI-Erkennung durch. Sofern alle Räume den Empfangspegel (RSSI) ermitteln können, wird der Raum mit dem besten Empfangspegel als Raum für das "room"-Reading ausgewählt. Der lepresenced in aktueller Version von PatrickR gibt immer den Empfangspegel aus.

==== Automatischer Start ====
Wenn der collectord per .deb Paket installiert wurde, startet er automatisch bei einem Reboot mit (via systemd/init-Skript).
<br>

Der Collectord wird standardmäßig mit dem Port 5222 gestartet. Um diese anzupassen sind zwei Schritte notwendig:<br>
'''1.)''' Anpassen der /usr/bin/collectord
Hier bitte den Parameter my $opt_p von 5222 auf 5XXX abändern.

Da der collectord mittlerweile per systemd beim reboot des RPi gestarte wird muss auch diese Konfiguration auf den neuen Port angepasst werden.<br>
'''2.)''' Anpassen der /etc/default/collectord
<pre>
# collectord startup defaults:
# The TCP port collectord will listen for incoming connections (default: 5222)
PORT=5111
# The location of the configuration file (default: /etc/collectord.conf
CFGFILE=/etc/collectord.conf
</pre>

Manuell starten als Daemon (Parameter <code>-d</code>) mit:
<pre>
sudo collectord -c /etc/collectord.conf -d -v -l /var/log/collectord.log
</pre>

== Batterieüberwachung ==

=== Batterieüberwachung mit dem Modul BleTagBattery ===
{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h

|ModTechName=74_BleTagBattery
|ModOwner=mumpitzstuff
}}
Mit dem Modul BleTagBattery - können die Batteriestati aller BT-LE Devices gelesen werden.
Es wird das batteryLevel und battery angelegt welches als BT-LE Tags an einer PRESENCE-Installation registriert wurden.

Vorraussetzung und Installation:

Bluez und Gattool
sudo apt-get install bluez

Das Gattool ist in den Installationen von Bluez inbegriffen.

Hinzufügen des githup für das Modul
update add http://raw.githubusercontent.com/mumpitzstuff/fhem-BleTagBattery/master/controls_bletagbattery.txt
update all
restart fhem: shutdown restart
BT-LE tags muss an einer PRESENCE-Installation des type "lan-bluetooth" registriert sein.

Nach dem Neustart von FHEM kann das Modul definiert werden:
define a new device: define <name of device> BleTagBattery

Das Modul versucht in der Standardkonfiguration alle 6 Stunden die BT-LE Devices zu erreichen und das Reading batteryLevel und battery zu aktualisieren.
Das Update kann auch manuell mit dem folgenden Befehl erzwungen werden

set <name of device> statusRequest.

Weiter Informationen und Disskussionen können dem eigentlichen [https://forum.fhem.de/index.php?topic=68104.0 Forumsbeitrag] entnommen werden,

=== Batterieüberwachung (aktuell nur G-Tags) ===

Leider überträgt der G-Tag nach der Einrichtung als Device in FHEM kein Reading mit seinem aktuellen Batteriestatus.
Dem wurde mit Hilfe des Forum Abhilfe geschaffen.
Im Folgenden wird erläutert wie die Batterieüberwachung eingerichtet werden kann.

'''Voraussetzung:'''

bc - Basiscalculator [https://packages.debian.org/de/sid/bc Bc-Paket]
<pre> sudo apt-get install bc </pre>

Anlegen eines Shellskript auf dem Raspberry System.
Die Parameter <<MAC-Adresse>> und <<TagName>> müssen durch die Werte des auszulesenden G-Tags ersetzt werden.
<pre>
#!/bin/bash
stringZ=$(sudo gatttool -b 5C:2B:80:C1:14:41 --char-read --handle=0x001b)
stringZ=${stringZ:33:2}
stringZ=$(echo "$stringZ" | tr a-f A-F)
decimal=$(echo "ibase=16; $stringZ" | bc)
perl /opt/fhem/fhem.pl 7072 "setreading MeinGtag Batterie $decimal"
</pre>

Dem Device in FHEM (hier MeinGtag) ein userReading mit dem Namen '''Batterie''' hinzufügen.
Das Shellskript mit folgendem Befehl starten:
<pre>
./GtagBatterie.sh
</pre>
'''Wichtig ist hierbei,''' dass Skript mit "./" und nicht mit "sh" aufzurufen. Beim Aufruf mit "sh GtagBatterie.sh" produziert es einen Fehler
<pre>GtagBatterie.sh: 3: GtagBatterie.sh: Bad substitution </pre>

Das Reading wird auf den ausgelesenen Wert der Batterie gesetzt.

Hinweis: Es sollte für jeden G-Tag ein eigenes Skript abgelegt werden. Das Skript kann per crontab oder fhem Kommando (system) regelmäßig aufgerufen werden.

=== Batterieüberwachung (alle Devices vom Typ "MODE=lan-bluetooth") ===

Es gibt eine weitere Möglichkeit um den Batteriestatus von LE Devices abzurufen und in FHEM als Reading darzustellen.
Dabei wird der Batteriezustand für alle LE Devices, die bereits in FHEM konfiguriert sind und per lepresenced überwacht werden, automatisch in einem shell-Script ermittelt.
Näheres dazu im Forumartikel {{Link2Forum|Topic=56960|LinkText=Erweiterung: Anwesenheitserkennung/Batterieüberwachung}}.

Vorteile:
* Automatische Ermittlung aller in FHEM konfigurierten LE Devices
* Möglichkeit, diese Devices alternativ manuell im Script einzutragen
* Es werden nur Devices abgefragt, die im Status "present" sind, also mit ziemlicher Sicherheit auch verfügbar sind
* Ein eventuell auf dem FHEM telnet-Port gesetztes Passwort kann im Script hinterlegt werden

'''Voraussetzung:'''

'''Funktionierendes lepresenced''' - siehe [[Anwesenheitserkennung#Anleitung_f.C3.BCr_ein_LE_Device_.28z.B._Gtags.2CPebbles_etc..29|Anleitung für ein LE Device (z.B. Gtags,Pebbles etc.)]]

'''socat''' - TCP port forwarder
<pre>
sudo apt-get update && sudo apt-get install socat
</pre>

'''gawk''' - Zum extrahieren der Daten
<pre>
sudo apt-get update && sudo apt-get install gawk
</pre>

'''gatttool''' - Bestandteil von bluez

gatttool ist auf den meisten Distributionen im bluez-Paket, allerdings nicht bei Opensuse. Dort muss man das Sourcepaket von bluez installieren und selbst kompilieren.
gatttool sollte dann nach /usr/bin oder /usr/local/bin kopiert werden,

Zusätzlich zu den notwendigen Erweiterungen werden für die Ausführung von gatttool '''Root-Rechte benötigt'''!

Das Script selbst gibt es hier: [https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery lebattery]

Am Besten unter /opt/fhem/script/lebattery speichern und ausführbar machen:
<syntaxhighlight lang="bash">
sudo su -
mkdir /opt/fhem/script
cd /opt/fhem/script
wget https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery
chmod 755 lebattery
</syntaxhighlight>

Je nach Bedarf können im Script noch die folgenden 3 Parameter angepasst werden:
<syntaxhighlight lang="bash">
# If allowed_telnetPort is protected by a password, add the password here
TELNETPASSWORD=""
# Attribute for batterylevel in FHEM
ATTRIBUT="batterylevel"
# Use this, if you dont want the script to determine the tags on its own
LETAGS=""
</syntaxhighlight>

Das Skript wird dann unter root folgendermaßen gestartet:
<pre>
/opt/fhem/script/lebattery -v
</pre>

Ausgabe des Skripts, wenn es mit dem Verbose Parameter -v gestartet wird.

Beide Devices sind vom Typ NUT mini, das Device mit dem FHEM-Namen '''nut_Micky''' ist im Status '''absent'''. Das zweite Device ist im Status '''present'''.
<pre>
Determining address for nut_Micky ...
nut_Micky is in state absent, no further action required

Determining address for nut_Test ...
Fetching batterylevel for nut_Test (F3:44:04:81:54:89) ...
Setting batterylevel for nut_Test to 100%
</pre>

Mein crontab-Eintrag (User root) sieht so aus:
<pre>
3 3 * * * /opt/fhem/script/lebattery -v >/opt/fhem/script/lebattery.log 2>&1
</pre>
Damit wird jeden Morgen um 3 Minuten nach 3 Uhr der Zustand der Batterien aller Devices ermittelt und in FHEM abgespeichert.<br>
Bevor man das mit crontab macht, sollte man allerdings zunächst sicher stellen, dass es auch ohne crontab funktioniert....

Bei Problemen kann man auch erstmal schauen, ob das mit dem gattool überhaupt funktioniert:
<pre>
gatttool -t <Typ> -b <MAC-Adresse> --char-read --uuid 0x2a19

handle: 0x0017 value: 64
</pre>
In diesem Fall hat die Batterie noch 100% (hex 64).<br>
Der Typ ist abhängig vom Hersteller und kann public (G-Tags) bzw. random (Nut) sein. Im Zweifelsfall beides ausprobieren.

= Beispiele =
== Anwesenheitserkennung / Anwesenheitsbenachrichtigung mit G-Tags ==
Ein Skript zur Nutzung der Gigaset G-TAGs zur Alarmierung bei öffnen und schließen von Türen und zur Anwesenheitserkennung, um die Alarmierung zu aktivieren bzw. deaktivieren.
Es kann verwendet werden um die Anwesenheit von mehrern Personen im Haushalt zu erkennen. Dabei wird eingeschränkt, dass nur bestimmte Personen die Alarmierung aktivieren können ( Eltern/Kind -Beziehung ).
Des Weiteren werden im Beispiel die Eltern benachrichtigt wenn eins der Kinder das Haus verlässt und die Eltern nicht anwesend sind.

{{Randnotiz|RNText=Namen der G-Tags in den Skripten bitte anpassen!}}

Für die ''Notify'' und die ''RESIDENTS-Erweiterung'' wird ein Dummy benötigt.
<pre>
define Alarm dummy
attr Alarm devStateIcon aktiv:secur_locked@red inaktiv:secur_open@lightgreen
attr Alarm eventMap on:aktiv off:inaktiv
attr Alarm setList on off
attr Alarm webCmd aktiv:inaktiv
attr Alarm room Alarm
</pre>

=== Mit Notify ===
<pre>
gtag.*.presence:.* {Anwesenheit_check("$EVTPART1", "$NAME")}
</pre>

Code für die 99_myUtils.pm
<pre>
### GTAG ANWESENHEITS CHECK
sub Anwesenheit_check($$) {
my ($EVENT, $NAME) = @_;

# gtag_rot - Alias Marco
# gtag_schwarz - Alias Ulli
# gtag_gruen - Alias Frida
# gtag_orange - Alias Hannah

my $RESIDENT = "rr_"; # Alle GTAGs sind Standardmäßig Residents Roommate
# $RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur Gäste (Roomguest) Auskommentiert, da ich es so nicht brauche
my $ROOMMATE = ("$RESIDENT" . "$NAME"); # Residentsname zusammenbauen
my $ALIASNAME = AttrVal($ROOMMATE,'alias',$ROOMMATE); # ALIAS des Roommates auslesen

my $GTAG1 = Value('gtag_rot'); # ELTERN
my $GTAG2 = Value('gtag_schwarz'); # ELTERN

my $STATUS = "wahrscheinlich gerade los";
$STATUS = "anwesend" if ($EVENT eq "present"); # Status: anwesend
$STATUS = "unterwegs" if ($EVENT eq "absent"); # Status: unterwegs

Log 1, "$ALIASNAME ist $STATUS."; # LOG Eintrag erzeugen

if (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME ist da..."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME ist da...'"); # Pushover
}
elsif (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_rot" xor $NAME eq "gtag_schwarz")) {
fhem("set teleBot send ALARMIERUNG INAKTIV: $ALIASNAME ist da...; set Alarm inaktiv"); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG INAKTIV' '$ALIASNAME ist da...'; set Alarm inaktiv"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME hat das Haus verlassen.'"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "inaktiv") && ($GTAG1 eq "absent" && $GTAG2 eq "absent")) {
fhem("set Alarm aktiv; set teleBot send ALARMIERUNG AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Alarm aktiv; set Infopush msg 'ALARMIERUNG AKTIV' '$ALIASNAME hat das Haus verlassen.' '' 0 ''"); # Pushover
}
}
</pre>

<br>

=== Mit Notify und Integration des RESIDENTS-MODUL ===

Der hier beschriebene Code erweitert die Funktionen unter dem Punkt 5.93.
Das Notify muss daher mit der folgenden Zeile erweitert werden.

<pre>
define Alarm_AnwesenheitCheck notify gtag.*.presence:.* { Anwesenheit_check("$EVTPART1", "$NAME"), Anwesenheit_check_resi("$NAME") }
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die RESIDENTS Funktion nutzen zu können:
<pre>
### RESIDENTS
sub Anwesenheit_check_resi($) {
my ($NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME); # ALIASNAME des GTAGs auslesen

my $RESIDENT = "rr_"; # Als Standard sind alle GTAGs Roommates
$RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur GTAG Namen der Gäste (Roomguest)
my $ROOMMATE = ("$RESIDENT" . "$ALIASNAME"); # Residentsname zusammenbauen

if (ReadingsVal($NAME,'presence',$NAME) eq "absent") {
fhem("set $ROOMMATE absent"); # Resisents Status von Roommates setzen
}
elsif(ReadingsVal($NAME,'presence',$NAME) eq "present") {
fhem("set $ROOMMATE home"); # Resisents Status von Roommates setzen
}
}
</pre>
<br>

=== Mit Notify und Fenster/Tür. -Kontakt Überwachung ===

Erweiterung für die Überwachung von Fenster/Tür. -Kontakten. Dazu sind zwei weitere Notifys notwendig die auf die Trigger der Kontakte regagieren
und so eine weitere Funktion in der 99_myUtils.pm ansprechen. Die Notifys triggern auf Kontakte die mit dem Namen Kontakt* beginnen.
Sollten die eigenen Fenster/Tür. -Kontakt anderen Namen besitzen, müssen die Skripte dementsprechend angepasst werden.
<pre>
define Alarm_Kontaktmeldung notify Kontakt.*:contact:.* {Kontakt_Meldung("$EVTPART1", "$NAME")}
</pre>
<pre>
define Alarm_Sabotagealarm notify Kontakt.*.sabotageError:.on {Kontakt_Sabotage("$EVTPART1", "$NAME")}
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die TÜRKONTAKTE-Meldung nutzen zu können:
<pre>
### TÜRKONTAKTE-Meldung/Zustand
sub Kontakt_Meldung($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME wurde $EVENT";
if (ReadingsVal("Alarm", "state", "on") eq "on") {
fhem("set teleBot send $ALIASNAME wurde $EVENT"); # Nachricht über Telegram
# fhem("set Infopush msg '$ALIASNAME' '$ALIASNAME wurde $EVENT'"); # Nachricht über Pushover
}
}

### TÜRKONTAKTE-Sabotagealarm

sub Kontakt_Sabotage($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME meldet Sabotagealarm";
fhem("set teleBot send Alarm: $ALIASNAME meldet Sabotagealarm"); # Nachricht über Telegram
# fhem("set Infopush msg 'Alarmanlage' '$ALIASNAME meldet Sabotagealarm' '' 2 ' ' 60 600 "); # Nachricht über Pushover
}
</pre>
<br>

=== Hinweis zur Benutzung / Fehlerhandling ===

Der Alarm dummy hat den Zustand on:off. Die Bezeichnungen und Namen müssen 1:1 übernommen werden damit das Script funktioniert.
Andernfalls müssen die Bezeichnungen für z.B. absent:unterwegs und present:anwesend - angepasst werden.
Die Benachrichtigung kann aktuell per ''Telegram'' sowie ''Pushover'' ('''Achtung mit zweiterem sind Abokosten verbunden!''') realisiert werden.
Diskussion zum Thema im Forum unter: {{Link2Forum|Topic=64080}}
<br>

= Problemlösungen =
Falls es '''Probleme beim Starten des Skripts''' gibt bzw. man das Skript ohne Reboot des Systems neustarten möchte, kann man dies per kill Befehl erledigen.
<syntaxhighlight lang="bash">
ps -ef | grep lepresenced
sudo kill <pid>
</syntaxhighlight>

Debuglevel lepresenced setzen:
{{Randnotiz|RNText=Um Debug-Meldungen zu bekommen (Vorsicht bei SD-Karten-Systemen wie dem RPi) - Hierbei werden die Schreibzyklen auf die SD-Karte erhöht.}}

Der Log Level muss im lepresenced-Skript selbst verändert werden. Um den Log-Level auf INFO/WARNING/DEBUG zu setzen, dass Skript lepresenced mit einem Editor öffnen und die Stellen, wo LOG_WARNING zu finden sind durch den nötigen LOG-Eintrag ersetzen.

<pre>
lepresenced --loglevel LOG_DEBUG
</pre>
Nur das wichtigste Loggen:
<pre>
lepresenced --loglevel LOG_WARNING
</pre>
Keinerlei LOG-Einträge
<pre>
lepresenced --loglevel LOG_EMERG
</pre>

Bei '''Problemen mit der Batterieüberwachung''' der Tags kann die Pi Firmeware mit folgenden Befehl auf eine ältere Version zurückgesetzt werden.
Fehlermeldung beim Aufruf des lebattery oder anderen Batterietestskripten:
<pre>connect: Connection refused (111)</pre>

Lösung (vorübergehend)
<pre>
sudo rpi-update 8521fd34c8f66b6d109acce943f6e25ec93ec005
</pre>

Mehr dazu unter: {{Link2Forum|Topic=56960|Message=589165}}

'''Das BT-Device ist ständig "absent"'''<br>
Eine Mögliche Lösung kann sein, dass Paket bluez-hcidump zu installieren. Das Werkzeug hcidump erlaubt die Beobachtung von Bluetooth-Aktivität.
Dies ist nicht notwendig, wenn bereits bluez installiert ist, da dies Teil des bluez Paketes ist
<pre>
sudo apt-get install bluez-hcidump
</pre>

'''Fehler in Logdateien /var/log/syslog und /var/log/kernel'''
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634211] bt_err_ratelimited: 1 callbacks suppressed
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634231] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:12 raspberrypi kernel: [ 4906.647350] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.532081] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.655564] Bluetooth: hci0 advertising data length corrected

Die Ursache des Problems ist noch nicht ergründet, allerdings betrifft dies aktuell nur den RPi3. Die Fehlermeldungen werden in verschiedene log's geschrieben. Darunter maßgeblich "syslog" und "kern.log".

Lösung (vorübergehend)
Unterbinden der Einträge durch Anlage eines blocklist Eintrag:

1. Unter "/etc/rsyslog.d" eine Datei erzeugen mit dem Namen "01-blocklist.conf"
2. Inhalt: (Die Ausdrücke in den "" sind diejenigen, die aus dem log verschwinden sollen. - bei mir waren es die unten stehenden")
:msg,contains,"Bluetooth: hci0 advertising data length corrected" stop
:msg,contains,"bt_err_ratelimited:" stop
3. Dienst neu starten "sudo service rsyslog restart"

Weiter Infos werden im offiziellen Thema {{Link2Forum|Topic=28753|Message=499184|LinkText=hier}} diskutiert.

Seit Version 0.82 kann es beim Start zu folgenden Meldungen im Log kommen.
Sep 06 16:13:45 raspberrypi systemd[1]: Started lepresenced.
Sep 06 16:13:45 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: Received 'Set scan parameters failed: Input/output error', ...tting...
Sep 06 16:13:46 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: hcitool exited, retrying...

Diese Meldungen können ignoriert werden. Abhilfe schafft sich lepresenced selbst indem es sich resettet.

'''Moderne iPhones und Android Geräte wechseln zum "deep standby" Modus''', und werden dann als "abwesend" gemeldet.
Mittels einer Funktion, die via hping3 Packete an den Geräte senden, um die "wach" zu halten, und dann die MacAdresse ausliest, kann man dieses Problem umgehen. Mehr im Forum [https://forum.fhem.de/index.php/topic,76342.0.html]

= Versionsänderungen lepresenced =
<pre>
--Version 0.81 (BasisVersion)
--Version 0.82 (stable 08/2017)
-Neue Kommandozeilenoption "--debug": Startet lepresenced im Vordergrund und gibt ausführliche Debug-Informationen auf STDOUT aus.
-Sanity Check: lepresenced prüft beim Starten die Verfügbarkeit von hciconfig, hcitool und hcidump.
-Model: lepresenced übermittelt das Reading model nun als lan-lepresenced. Das erlaubt die Erkennung von lepresenced in der FHEM-Statistik (sofern aktiviert).
--Version 0.83 (stable 09/2017)
- Behebung von Systemstart Fehlern
- Weitere Debug-Möglichkeiten. U. a. wird nun mitgezählt, ob hcitool lescan ("legacy") und hcidump eine identische Zahl an Beacons empfangen
</pre>

= Ansprechpartner =
# {{Link2FU|117|markusbloch }} (Markus) für das PRESENCE-Modul und collectord
# {{Link2FU|5068|PatrikR}} (Patrick) für lepresenced
# [[Benutzer Diskussion:Devender|Devender]] ({{Link2FU|20043|Dirk}}) für Wiki und Doku

PRESENCE

2018-06-29T12:51:50Z

50watt: /* BT-Dongle am PI installieren */

{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h

|ModTechName=73_PRESENCE.pm
|ModOwner=markusbloch
}}

Das [[PRESENCE]] Modul bietet für die Anwesenheitserkennung mehrere Varianten an:

* '''lan-ping''' - Das Überwachen via PING Checks, die durch den FHEM Server versandt werden.
* '''fritzbox''' - Das Überwachen von Geräten auf einer FritzBox via ctlmgr_ctl (Nur auf einer FritzBox möglich)
* ''' Bluetooth'''
:- '''local-bluetooth''' - Das Überwachen via Bluetooth Checks, die vom FHEM Server direkt durchgeführt werden (angeschlossener Bluetooth-Stick und die Software bluez voraussgesetzt)
:- '''lan-bluetooth''' - Das Überwachen von Bluetoothgeräten, über Netzwerk. Auf einer oder mehreren Maschinen im Netzwerk (z.B. [[:Kategorie:Raspberry Pi|Raspberry Pi]]) läuft ein Presence-Daemon, der nach Bluetooth-Geräten sucht. Um mehrere Presence-Daemon mit FHEM zu verbinden, gibt es den Collector-Daemon, der sich zu allen Presence-Damons im Netzwerk verbindet und das Ergebnis von allen zusammenfasst.
* '''function''' - Das Überwachen mithilfe einer selbst geschrieben Perl-Funktion, die den Anwesenheitsstatus zurückgibt (0 oder 1)
* '''shell-script''' - Das Überwachen mithilfe eines selbst geschriebenen Shell-Programms/Skript, das eine 0 oder 1 ausgibt, um den Anwesenheitsstatus mitzuteilen.

= Überwachen mittels Ping im WLAN/LAN =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Um ein Gerät via Ping zu überwachen, muss folgende Definition durchgeführt werden:
:<code>define Handy PRESENCE lan-ping 192.168.0.30</code>

Dadurch wird die IP-Addresse 192.168.0.30 alle 30 Sekunden geprüft, ob sie erreichbar ist. Wenn sie erreichbar ist, ist der Status "present" (anwesend), ansonsten "absent" (abwesend).

Der Timeout kann verändert werden, indem ein Wert (in Sekunden) an das Define anhängt wird:
:<code>define Handy PRESENCE lan-ping 192.168.0.30 '''60'''</code>

Nun würde das Handy alle 60 Sekunden geprüft werden.

Nur wenn bei einem iPhone/iPad die Funktion "über WLAN synchronisieren" aktiviert ist, ist es auch im Standby zuverlässig pingbar. Standardmäßig deaktivieren Apple-Geräte ihr WLAN im Standby-Betrieb um die Akkulaufzeit zu verlängern.

Sollte die Fehlermeldung
:<code> PRESENCE (Handy) - ping command returned with output: ping: icmp open socket: Operation not permitted </code>
im Log auftauchen und lan-ping dadurch nicht funktionieren, liegt ein Berechtigungsproblem vor. Kein Grund den User fhem zu root zu machen!
Prüfe zu erst als User root ob die Capabilities gesetzt sind.
:<code>getcap /bin/ping</code>
Sollte folgendes Ergeben zu Tage fördern.
:<code>/bin/ping = cap_net_raw+ep</code>
Ist dem nicht so, setzen wir die benötigten Capabilities
:<code>setcap cap_net_raw+ep /bin/ping</code>
Mehr Informationen zum Thema Capabilities [https://manpages.debian.org/jessie/manpages-de/capabilities.7.de.html].

= FritzBox: direktes Abfragen der Aktivität via ctlmgr_ctl =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Eine sehr häufige und auch zuverlässige Methode ist auf einer FritzBox die Abfrage mittels ctlmgr_ctl Befehl. Über diesen lassen sich alle Geräte abfragen ob sie aktiv sind. Ist ein Gerät aktiv, so gilt es als anwesend.

Dieser Modus kann allerdings nur in FHEM Installationen direkt auf einer FritzBox verwendet werden. Des weiteren muss FHEM unter dem User root laufen. Um ein Gerät zu überwachen, wird lediglich der Gerätename benötigt, so wie er unter dem Menüpunkt "Heimnetz" auftaucht.

Die erforderliche Definition:
:<code>define Handy PRESENCE fritzbox iPhone-4S</code>

= Überwachung mittels Perl-Code =
Es ist möglich zum Überwachen von Geräten eine eigene Perl-Funktion zu verwenden die dann vom PRESENCE Modul im Hintergrund aufgerufen wird.

define <name> PRESENCE function {...} [ <check-interval> [ <present-check-interval> ] ]

Sobald die Funktion den Rückgabewert 1 hat, ist das Gerät anwesend, bei 0 abwesend.

== Beispiel DHCP Überwachung auf Airport Basestation ==
Die hier vorgestellte Überwachung der DHCP Lease auf Airport Basestations per SNMP ist absolut robust gegenüber dem Ruhezustand von iOS und setzt keine weitere Konfiguration auf dem iPhone voraus. Das Abmelden beim Verlassen des Empfangsbereiches der Basestation geschieht mit etwa 5-10 Minuten Verzögerung und ist somit auch vor kurzzeitigen Empfangsproblemen sicher. Das nebenstehende Bild (???) verdeutlicht noch mal die Unterschiede zwischen einer IP-Basierten Ping-Überwachung und der Überwachung auf Ebene der Basestation oder FritzBox.

Bevor der folgende Code verwendet werden kann ist das Perl Modul Net:SNMP zu installieren (z. B. mit: <code>cpan install use Net::SNMP</code>).

Zuerst ist folgender Code in 99_myUtils.pm einzufügen, sollte diese noch nicht vorhanden sein muss diese aus dem Template welches unter Edit Files zu finden ist erzeugt werden.
'''Achtung, das ist nicht der komplette Inhalt der 99_myUtils!''' Das ist nur die einzelne Routine

<pre>
use Net::SNMP;
sub
snmpCheck($$)
{
my ($airport,$client)= @_;

my $community = "public";
my $host = $airport;
my $oid = ".1.3.6.1.2.1.3.1.1.2";
#my $oid = ".1.3.6.1.2.1.3.1.1.2.25.1.10.0.1";

my ( $session, $error ) = Net::SNMP->session(
-hostname => $host,
-community => $community,
-port => 161,
-version => 1
);

if( !defined($session) ) {
return 0;
return "Can't connect to host $host.";
}

my @snmpoids = ();

my $response = $session->get_next_request($oid);
my @nextid = keys %$response;
while ( @nextid && $nextid[0] && $nextid[0] =~ m/^$oid/ ) {
push( @snmpoids, $nextid[0] );

$response = $session->get_next_request( $nextid[0] );
@nextid = keys %$response;
}

if( !defined($response = $session->get_request( @snmpoids ) ) ) {
return 0;
}

foreach my $value (values %$response) {
return 1 if( $value eq $client )
}

return 0;
}
</pre>

Danach lässt sich das Mobilgerät so überwachen:
:<code>define iPhone PRESENCE function {snmpCheck("10.0.1.1","0x44d77429f35c")} 30 30</code>

wobei 10.0.1.1 durch die IP-Adresse der Basestation und 0x44d77429f35c durch die MAC Adresse des Geräts als HEX-Zahl ersetzt werden muss.

== Beispiel Anwesenheitserkennung mittels UniFi Controller ==

Die Anwesenheitserkennung bei Geräten in Verbindung mit UniFi-Produkten funktioniert selbst dann, wenn sich die Geräte im PowerSave-Modus befinden.

Beachte: Die Geräte werden erst ungefähr nach 5 Minuten, nachdem das Gerät das WLAN verlassen hat als disconnected angezeigt.

<code>define <NAME> PRESENCE function {ReadingsVal("<UniFi>","<NamedDevice>","") eq "connected" ? 1:0}</code>

= Überwachen mittels Events =
Der Vorteil gegenüber der Function-Variante ist, dass diese Variante ohne Blocking.pm-Overhead direkt ausgeführt werden kann und in "Echtzeit" abläuft (siehe {{Link2Forum|Topic=40287|Message=562823}}).

<code>define <NAME> PRESENCE event UniFi:NamedDevice:.disconnected UniFi:NamedDevice:.connected</code>

= Überwachen mittels Bluetooth =
== Vorbereitung und Informationen ==
=== Getestete Hardware/Software ===
* '''Raspbian System''' - wheezy, Jessie (interner BT-Controller)
* '''BT-Dongle''' - CSL NET BT USB2.0 Stick, Bluetooth V4.0, Nano <br />'''Achtung''': Es muss ein BT V4.0 oder höher verwendet werden. Nur dieser unterstützt ''LowEnergy''
* '''BT-TAG''' - Gtag von Gigaset, TrackR, UDOO Neo, PebbleBee, iTag von Unitec, X4-LIFE Multifunkti BL-Anhänger, iTag Wireless Anti, Trackr bravo

=== BT-Dongle am RaspberryPI installieren ===
Um den BT-Dongle ''(hier: CSL NET BT USB2.0)'' am RaspberryPI verwenden zu können, müssen die notwendigen Pakete über die Paketverwaltung von debian nachinstalliert werden.
Wer bereits ein BT-Dongle installiert hat, kann diesen Schritt überspringen.
<pre>
apt-get install bluetooth
</pre>
Nach erfolgreicher Installation der Pakete sollte der RaspberryPI neu gestartet werden.
<pre>
sudo reboot
</pre>

Nach dem erfolgten Reboot bitte das Log des RaspberryPI auf folgende Einträge prüfen:
<pre>
Feb 12 19:52:55 fhem kernel: [ 4.773600] Bluetooth: Core ver 2.20
Feb 12 19:52:55 fhem kernel: [ 4.773748] NET: Registered protocol family 31
Feb 12 19:52:55 fhem kernel: [ 4.773765] Bluetooth: HCI device and connection manager initialized
Feb 12 19:52:55 fhem kernel: [ 4.773797] Bluetooth: HCI socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773821] Bluetooth: L2CAP socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773890] Bluetooth: SCO socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.797531] usbcore: registered new interface driver btusb
</pre>
Sobald der BT-Dongle erkannt wurde ''leuchtet'' (wenn vorhanden) auch die ''blaue/gelbe'' LED am Dongle auf.

=== BT-Tags aktivieren ===
Jetzt kann der BT-Tag aktiviert werden. Bei einigen Tags muss dafür die '''Batteriesicherung''' gezogen werden.

Einen Tag wird mit folgendem Befehl auf der Konsole gesucht:
<syntaxhighlight lang="bash">
sudo hcitool lescan

Ausgabe z.B.:
LE Scan ...
7C:2F:80:A1:XA:XD (unknown)
7C:2F:80:A1:XA:XD Gigaset G-tag
7C:2F:80:A1:X4:X1 (unknown)</syntaxhighlight>
Eine Übersicht über die möglichen Befehle von hcitool gibt es mit der Eingabe von:
<pre>
sudo hcitool

Ausgabe z.B.:
hcitool - HCI Tool ver 5.23
Usage:
hcitool [options] <command> [command parameters]
Options:
--help Display help
-i dev HCI device
Commands:
dev Display local devices
inq Inquire remote devices
scan Scan for remote devices
name Get name from remote device
info Get information from remote device
spinq Start periodic inquiry
epinq Exit periodic inquiry
cmd Submit arbitrary HCI commands
con Display active connections
cc Create connection to remote device
dc Disconnect from remote device
sr Switch master/slave role
cpt Change connection packet type
rssi Display connection RSSI
lq Display link quality
tpl Display transmit power level
afh Display AFH channel map
lp Set/display link policy settings
lst Set/display link supervision timeout
auth Request authentication
enc Set connection encryption
key Change connection link key
clkoff Read clock offset
clock Read local or remote clock
lescan Start LE scan
lewladd Add device to LE White List
lewlrm Remove device from LE White List
lewlsz Read size of LE White List
lewlclr Clear LE White list
lecc Create a LE Connection
ledc Disconnect a LE Connection
lecup LE Connection Update
</pre>

Falls beim SCAN kein Tag gefunden wird, sollte das BT Interface neu gestartet werden. Dazu ist kein Reboot des PI notwendig.
<syntaxhighlight lang="bash">
sudo hciconfig hci0 down
sudo hciconfig hci0 up
sudo hcitool dev
</syntaxhighlight>

== Überwachung durch den FHEM Server direkt ==
[[Datei:Bluetooth-Adresse-iPhone.png|thumb|Bluetooth-Adresse eines iPhones]]
Jenach Aufstellungsort des FHEM Servers kann es sinnvoll sein, eine Bluetooth-Überwachung direkt durch den FHEM Server durchzuführen. Hierbei gilt allerdings zu beachten, dass Bluetooth nicht für große Reichweiten gedacht ist und in den meisten Fällen keine Wände überwinden kann. Das heisst, dass in den meisten Fällen damit nur ein Raum überwacht werden kann.

Je nach Einsatzzweck kann das auch so gewollt sein. Bluetooth USB Sticks, die bereits Bluetooth 4.0 unterstützen, können höhere Reichweiten über Zimmerwände hinaus erreichen. Vorausgesetzt, das Mobilgerät unterstützt Bluetooth 4.0.

Um eine Überwachung per Bluetooth durchführen zu können, benötigt man die Bluetooth-Adresse eines Gerätes. Diese ähnelt vom Aufbau einer MAC-Adresse. Generell wird die Adresse in den Telefon-Informationen bei Smartphones angezeigt.

Um eine Anwesenheitserkennung via Bluetooth durchzuführen, wird folgende Definition in der [[Konfiguration]] benötigt:
:<code>define Handy PRESENCE local-bluetooth XX:XX:XX:XX:XX:XX</code>

== Überwachung durch verteilte Agenten in der Wohnung (presenced/lepresenced/collectord) ==
[[Datei:Raspberry-Pi-mit-WLAN-und-Bluetooth-Stick.jpg|thumb|left|Raspberry Pi mit Bluetooth- und WLAN-USB-Stick]]
Um eine zuverlässige und flächendeckende Bluetooth-Anwesenheitserkennung durchzuführen, ist es unerlässlich, mehrere Bluetooth-Empfänger zu verwenden, die auf mehrere oder alle Räume verteilt sind.

Hierfür bietet sich zum Beispiel ein [[Raspberry Pi]] mit einem Mini-Bluetooth-USB-Stick und evtl. einem WLAN-USB-Stick an. Jeder Raum wird mit solch einem Raspberry ausgestattet und ist im WLAN Netz verfügbar.

Dieses Netz aus Raspberrys wird mit dem presenced / lepresenced Programm ausgestattet. Beide Programme sind Perl-Skripte, die als Daemon im Hintergrund laufen und auf Anfragen via Netzwerk warten. Es wird lediglich eine vollständige Perl-Grundinstallation mit Standardmodulen benötigt.

=== Unterschied presenced / lepresenced / collectord ===
presenced und lepresenced sind Programme, welche in regelmäßigen Abständen nach Bluetooth-Geräten suchen. Sobald ein Gerät, welches vorab definiert wurde, gefunden wird, wechselt der Status des Geräts in FHEM auf Anwesend. Der Unterschied zwischen presenced und lepresenced ist, dass lepresenced insbesondere für [https://de.wikipedia.org/wiki/Bluetooth_Low_Energy Bluetooth-LE-Devices] ist und presenced für "normale" Bluetooth-Geräte.

collectord wiederum ist ein Programm, welches mehrere Pis verbindet und auf allen den aktuellen Status von presenced/lepresenced abfragt. Ist das gesuchte Bluetooth-Gerät auf einem der Pi anwesend, so wird es auch in der definierten Hauptinstanz auf anwesend gesetzt. Zusätzlich wird der Pi auf dem das Gerät gefunden wurde als Reading angegeben. Sofern alle Räume einen Empfangspegel (RSSI) ermitteln können, wird bei mehreren anwesenden Räumen der Raum mit dem besten Empfangspegel selektiert (siehe {{Link2Forum|Topic=54482}}).

=== Installation von (le)presenced ===
Diese Anleitung ist sowohl für presenced, als auch für lepresenced gültig. Einfachheitshalber wird nur lepresenced erwähnt, sämtliche Schritte gehen jedoch auch mit presenced, wobei einfach die genannten Daten durch presenced ersetzt werden müssen.

Die Software lepresenced kann aktuell über drei Varianten installiert werden. Dabei ist die bevorzugte Variante (Variante 1) die Installation über das bereitgestellte .deb-Paket.
Die Variante 2 setzt voraus, dass im FHEM contrib Verzeichnis (/opt/fhem/contrib) die aktuelle Version des .deb-Pakets liegt. Die Variante 3 ist dafür gedacht, wenn man keine .deb-Pakete installieren kann/will oder es aus anderen Gründen nicht funktioniert. Es wird davon abgeraten die Variante 3 zu verwenden. Vollständigkeitshalber wird sie aber aufgeführt.

===== Installation per .deb-Paket =====

Die bevorzugte Variante ist die Installation von lepresenced durch die passenden .deb Pakete.
{{Randnotiz|RNText=Bei einem Upgrade einer älteren Version reicht es, das neue .deb Paket mit
:<code>sudo dpkg -i lepresenced-X.XX-X.deb</code>
zu aktualisieren}}

'''1.Variante:'''
Herunterladen der aktuellen lepresenced-0.83-3.deb (Stand August 2017) Datei über den Webbrowser
[https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/ SVN-Repository]. Im SVN die passende Datei auswählen und in der folgende Webseite den Link unter:
<pre>
Download in other formats:
Original Format
</pre>
anklicken und die Datei herunterladen.
Die Datei kann jetzt auf den RPi kopiert und mit folgenden Befehlen ausgeführt werden (ggf. Berechtigungen anpassen).

Alternativ per wget Befehl direkt auf den RPi (aktuelle Versionsnummer beachten)
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/lepresenced-0.83-3.deb

'''2.Variante:''' (zu Verwenden, wenn es Probleme bei Variante 1 gibt)
Herunterladen aus dem fhem contrib Verzeichnis:
Hierzu muss das contrib auf dem aktuellen Stand sein. Dazu wird die Installation von subversion (normal bereits vorhanden) benötigt.

sudo apt-get install subversion

Danach kann per
sudo svn checkout https://svn.fhem.de/fhem/trunk/fhem/contrib svnrepo

Das aktuelle Repository auf den Pi heruntergeladen werden. Danach sollte im gewählten Verzeichnis die eingecheckten Dateien verfügbar sein.
/opt/fhem/svnrepo/PRESENCE/deb

''' Installation der Variante 1 oder 2 '''

Egal welche Variante gewählt wurde, nun kann mit folgenden Befehlen das Paket installiert werden. Bitte Pfade ggf. anpassen.

'''Wichtig''': Das '''Paket''' hat eine ca. Größe von '''6,5Kb'''. Ab und an gibt es wohl Probleme mit der Installation, wodurch die Datei 11,5kb groß wird.
Diese Datei lässt sich nicht Installieren. In diesem Fall das Paket bitte mit der Variante 1 und dem Bereich "Download in other formats" herunterladen.

sudo dpkg -i lepresenced-0.83-3.deb

sudo apt-get -f install

Die Ausgabe der Installation sollte am Ende ein [ ok ] Starting lepresenced (via systemctl): lepresenced.service. ausgeben.

<pre>
Paketlisten werden gelesen... Fertig
Abhängigkeitsbaum wird aufgebaut.
Statusinformationen werden eingelesen.... Fertig
Abhängigkeiten werden korrigiert ... Fertig
Die folgenden zusätzlichen Pakete werden installiert:
bluez-hcidump
Die folgenden NEUEN Pakete werden installiert:
bluez-hcidump
0 aktualisiert, 1 neu installiert, 0 zu entfernen und 0 nicht aktualisiert.
1 nicht vollständig installiert oder entfernt.
Es müssen 157 kB an Archiven heruntergeladen werden.
Nach dieser Operation werden 490 kB Plattenplatz zusätzlich benutzt.
Möchten Sie fortfahren? [J/n]
Holen: 1 http://archive.raspberrypi.org/debian/ jessie/main bluez-hcidump armhf 5.23-2+rpi2 [157 kB]
Es wurden 157 kB in 0 s geholt (921 kB/s).
Vormals nicht ausgewähltes Paket bluez-hcidump wird gewählt.
(Lese Datenbank ... 42033 Dateien und Verzeichnisse sind derzeit installiert.)
Vorbereitung zum Entpacken von .../bluez-hcidump_5.23-2+rpi2_armhf.deb ...
Entpacken von bluez-hcidump (5.23-2+rpi2) ...
Trigger für man-db (2.7.0.2-5) werden verarbeitet ...
bluez-hcidump (5.23-2+rpi2) wird eingerichtet ...
lepresenced (0.82-1) wird eingerichtet ...
[ ok ] Starting lepresenced (via systemctl): lepresenced.service.
</pre>

'''3.Variante:'''

Bei dieser Variante wird das aktuellste lepresenced Skript aus github heruntergeladen. Das bedeutet, dass jegliche Konfiguration wie automatischer Start, Berechtigungen etc.
manuell konfiguriert werden muss. Diese Variante eignet sich nur für diejenigen, die keine .deb-Pakete installieren wollen/können oder die genau Wissen, was sie tun!
<pre>
https://github.com/mhop/fhem-mirror/blob/master/fhem/contrib/PRESENCE/lepresenced
</pre>

Zur "Installation" des Skripts folgendermaßen vorgehen:
Unter /fhem manuell den Ordner „script“ anlegen:
<pre>
mkdir script
</pre>
Datei lepresenced reinkopieren und ausführbar machen:
<pre>
sudo chmod +x /opt/fhem/script/lepresenced
sudo chgrp -cR dialout lepresenced
</pre>
Skript erstmalig starten:
<pre>
sudo ./lepresenced --loglevel LOG_EMERG -d
</pre>
Kommt beim Starten des Skript eine Fehlermeldung, müssen die Abhängigkeiten aufgelöst werden.
<pre>
Can't locate Net/Server/Daemonize.pm in @INC (@INC contains: /etc/perl /usr/local/lib/perl/5.14.2 /usr/local/share/perl/5.14.2 /usr/lib/perl5 /usr/share/perl5 / usr/lib/perl/5.14 /usr/share/perl/5.14 /usr/local/lib/site_perl .) at /opt/fhem/lepresenced line 17.
BEGIN failed--compilation aborted at /opt/fhem/lepresenced line 17.
</pre>
Um die Abhängigkeiten aufzulösen muss folgendes nachinstalliert werden und anschließend ein Reboot durchgeführt werden.
<pre>
sudo apt-get install libnet-server-*
</pre>

===== Einrichtung eines Bluetooth-Geräts über FHEM =====

Nach dem letzten Schritt sind alle Bedingungen für eine abschließende Konfiguration eines BT-Geräts in FHEM abgeschlossen worden.
Jetzt kann der zum Beispiel ein G-Tag dem FHEM-Server bekannt gemacht werden:
<pre>
-- Name Modul Modus MAC vom Gtag IP vom PI Port Abfragezeit in Sekunden
define MeinGtAG PRESENCE lan-bluetooth xx:xx:xx:xx:xx:xx 127.0.0.1:5333 120
</pre>

'''Wichtig ist den angegeben Port zu unterscheiden. Für presenced muss der Port 5111 genommen werden, für lepresenced der Port 5333.'''
Den absent und present Mode kann man einfach testen, in dem man den Gtag mit Alufolie einwickelt.

Diese Variante sollte eingesetzt werden, wenn nur ein Pi nach Bluetooth-Geräten sucht. Möchte man mehr als ein Gerät nutzen um zum Beispiel eine größere Fläche abzudecken so muss mit collectored gearbeitet werden.

=== Alle Räume gemeinsam ansprechen mittels collectord ===
Um zwei presenced- oder lepresenced Installationen zu verbinden wird der collectord Daemon von Markus Bloch benötigt. Dieser kennt alle presenced-Installationen im Netzwerk und führt eine koordinierte Suche nach den gewünschten Geräten durch. Sobald ein Gerät in einem Raum erkannt wurde, meldet der collectord den Status einschließlich der Angabe des Raumes, in dem das Gerät erkannt wurde.

[[Datei:Presence_Collectord_Uebersicht.jpg|200px|thumb|left|Schematische Darstellung Presence und Collectord, Danke an dtavb]]
Auf Basis folgender Skizze wird die Einrichtung und der Betrieb der Anwesenheitserkennung und Überwachung <p></p>
mit dem PRESENCE-Modul sowie dem Skript (.deb-Paket) lepresenced beschrieben. Zusätzlich wird für die Verbindung <p></p>
mehrere lepresenced Instanzen der collectord verwendet.<p></p>
Diese Skizze dient als Basis für alle genannten Konfigurationen innerhalb dieses Artikels.
{{NeuerTextBlock}}

==== Aufbau ====
; RPi1 (Hauptinstanz):
: FHEM Installation
: presence/lepresenced Installation
: collectord installation
: Sämtliche Bluetooth-Geräte in FHEM definiert
; RPi2 (Zweitsystem):
: FHEM installation
: presence/lepresenced Installation
: Sämtliche Bluetooth-Geräte in FHEM definiert

==== Installation per .deb-Paket ====
collectord wird heruntergeladen und installiert:
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/collectord-1.8.deb (Stand Januar 2018)
<pre>
sudo dpkg -i collectord-1.8.deb
</pre>

Nach der Installation befindet sich im Verzeichnis: /etc/collectord.conf die Konfigurationsdatei für das collectord. Weitere Einstellungen können unter /etc/default/collectord vorgenommen werden.

==== Konfiguration auf Shellebene ====
<pre>
sudo vi /etc/collectord.conf
</pre>

Diese Datei muss jetzt nach folgender Vorlage angepasst werden.
<pre>
# room definition
#[room-name] # name of the room
#address=192.168.0.10 # ip-address or hostname
#port=5111 # tcp port which should be used (5111 is default)
#presence_timeout=120 # timeout in seconds for each check when devices are present
#absence_timeout=20 # timeout in secondsfor each check when devices are absent

[RPi1] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=127.0.0.1 # Lokale Adresse RPi1 , da hier das Collectord später laufen soll!
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaelte Pruefintervalle
absence_timeout=60 # Selbstgewaelte Pruefintervalle

[RPi2] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=192.168.178.127 # IP-Adresse der Instanz, wo nur das Presence laueft, also RPi2
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaelte Pruefintervalle
absence_timeout=60 # Selbstgewaelte Pruefintervalle
</pre>

Hinweis:
* Es dürfen keine [Namen] mit Leerzeichen verwendet werden
* Der angegebene Port richtet sich danach, ob auf dem Pi presenced (Port 5111) oder lepresenced (Port 5333) nach dem Bluetooth-Gerät sucht

==== Konfiguration in FHEM ====
;RPi1
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 127.0.0.1:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222)''
;RPi2
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 192.168.178.127:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222 - die IP-Adresse von die von RPi1)''

Nach der Konfiguration kann der Daemon gestartet werden.
Sobald das Bluetoothgerät irgendwo in der Wohnung erkannt wurde, meldet der Collectord dies sofort
an FHEM und teilt den Raum mit in dem es erkannt worden ist. Diese Information wird im Reading "rooms" des jeweiligen BT-Gerätes dargestellt.

Zum testen sollte collectord einmalig manuell gestartet werden. Dies hat den Vorteil, dass man nochmal den Port des collectord prüfen kann, dieser steht in der Zeile <pre>created socket on 0.0.0.0 with port 5222</pre> und man sehen kann, ob der collectord richtig startet, oder Fehler auswirft. Gestartet wird mit folgendem Kommando:
<pre>
sudo collectord -vv -c /etc/collectord.conf
</pre>
Die Ausgabe sieht wie folgt aus:
<pre>
2017-04-02 17:52:55 - =================================================
2017-04-02 17:52:55 - started with PID 15554
2017-04-02 17:52:55 - reading configuration file
2017-04-02 17:52:55 - no config errors found
2017-04-02 17:52:56 - created socket on 0.0.0.0 with port 5222
2017-04-02 17:53:20 - new connection from 127.0.0.1:48656
2017-04-02 17:53:20 - created thread 1 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - created thread 2 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - new connection from 127.0.0.1:48662
2017-04-02 17:53:20 - new connection from 127.0.0.1:48664
2017-04-02 17:53:20 - created thread 3 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 4 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 5 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:20 - created thread 6 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51638
2017-04-02 17:53:22 - created thread 7 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - created thread 8 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51640
2017-04-02 17:53:22 - created thread 9 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:23 - created thread 10 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:29 - new connection from 192.168.xxx.xxx:51642
2017-04-02 17:53:29 - created thread 11 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
2017-04-02 17:53:29 - created thread 12 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
</pre>

Wenn das Log wie oben abgebildet aussieht wurde alles richtig gemacht und unter dem Device in FHEM erscheint ein neues Reading "rooms" mit dem Wert der erkannten PRESENCE-Installation.

'''Verhalten presence timeout im zusammenhang mit dem Attribut "absenceThreshold" der PRESENCE Konfiguration in FHEM'''
<br>
In der collectord.conf sind <code>presence_timeout</code> und <code>absence_timeout</code> für den jeweiligen Raum konfiguriert.
Das bedeutet, sobald irgendein Gerät in diesem jeweiligen Raum anwesend/abwesend ist, wird das jeweilige Timeout an den verbundenen presenced/lepresenced geschickt um damit das Check-Interval entsprechend zu ändern.

In der PRESENCE-Definition kann man ebenfalls ein <code>absence_timeout</code>/<code>presence_timeout</code> setzen. Sobald sich der Zustand ändert, wird auch das jeweilige Timeout an den collectord gesandt. Dies hat aber auf die Checks in den jeweiligen Räumen und damit der collectord.conf keinen Einfluss. Der collectord schickt ein Statusupdate an PRESENCE nur, wenn das vorgegebene Timeout (von PRESENCE) erreicht ist und keine Statusänderung stattfand. Sobald eine Änderung des Status erfolgt wird natürlich sofort der Status an PRESENCE geschickt.

Das Attribut absenceThreshold/presenceThreshold funktioniert nachwievor. Hier ist nur wichtig wie man die Timeouts sowohl in PRESENCE als auch collectord.conf setzt.

'''Das Reading "room" bei einer PRESENCE Definition und der Zusammenhang zu collectord'''
<br>
Wenn ein BT LE Empfänger in mehr als einem Raum detektiert wird, führt der collectord (ab Version 1.8) eine RSSI-Erkennung durch. Sofern alle Räume den Empfangspegel (RSSI) ermitteln können, wird der Raum mit dem besten Empfangspegel als Raum für das "room"-Reading ausgewählt. Der lepresenced in aktueller Version von PatrickR gibt immer den Empfangspegel aus.

==== Automatischer Start ====
Wenn der collectord per .deb Paket installiert wurde, startet er automatisch bei einem Reboot mit (via systemd/init-Skript).
<br>

Der Collectord wird standardmäßig mit dem Port 5222 gestartet. Um diese anzupassen sind zwei Schritte notwendig:<br>
'''1.)''' Anpassen der /usr/bin/collectord
Hier bitte den Parameter my $opt_p von 5222 auf 5XXX abändern.

Da der collectord mittlerweile per systemd beim reboot des RPi gestarte wird muss auch diese Konfiguration auf den neuen Port angepasst werden.<br>
'''2.)''' Anpassen der /etc/default/collectord
<pre>
# collectord startup defaults:
# The TCP port collectord will listen for incoming connections (default: 5222)
PORT=5111
# The location of the configuration file (default: /etc/collectord.conf
CFGFILE=/etc/collectord.conf
</pre>

Manuell starten als Daemon (Parameter <code>-d</code>) mit:
<pre>
sudo collectord -c /etc/collectord.conf -d -v -l /var/log/collectord.log
</pre>

== Batterieüberwachung ==

=== Batterieüberwachung mit dem Modul BleTagBattery ===
{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h

|ModTechName=74_BleTagBattery
|ModOwner=mumpitzstuff
}}
Mit dem Modul BleTagBattery - können die Batteriestati aller BT-LE Devices gelesen werden.
Es wird das batteryLevel und battery angelegt welches als BT-LE Tags an einer PRESENCE-Installation registriert wurden.

Vorraussetzung und Installation:

Bluez und Gattool
sudo apt-get install bluez

Das Gattool ist in den Installationen von Bluez inbegriffen.

Hinzufügen des githup für das Modul
update add http://raw.githubusercontent.com/mumpitzstuff/fhem-BleTagBattery/master/controls_bletagbattery.txt
update all
restart fhem: shutdown restart
BT-LE tags muss an einer PRESENCE-Installation des type "lan-bluetooth" registriert sein.

Nach dem Neustart von FHEM kann das Modul definiert werden:
define a new device: define <name of device> BleTagBattery

Das Modul versucht in der Standardkonfiguration alle 6 Stunden die BT-LE Devices zu erreichen und das Reading batteryLevel und battery zu aktualisieren.
Das Update kann auch manuell mit dem folgenden Befehl erzwungen werden

set <name of device> statusRequest.

Weiter Informationen und Disskussionen können dem eigentlichen [https://forum.fhem.de/index.php?topic=68104.0 Forumsbeitrag] entnommen werden,

=== Batterieüberwachung (aktuell nur G-Tags) ===

Leider überträgt der G-Tag nach der Einrichtung als Device in FHEM kein Reading mit seinem aktuellen Batteriestatus.
Dem wurde mit Hilfe des Forum Abhilfe geschaffen.
Im Folgenden wird erläutert wie die Batterieüberwachung eingerichtet werden kann.

'''Voraussetzung:'''

bc - Basiscalculator [https://packages.debian.org/de/sid/bc Bc-Paket]
<pre> sudo apt-get install bc </pre>

Anlegen eines Shellskript auf dem Raspberry System.
Die Parameter <<MAC-Adresse>> und <<TagName>> müssen durch die Werte des auszulesenden G-Tags ersetzt werden.
<pre>
#!/bin/bash
stringZ=$(sudo gatttool -b 5C:2B:80:C1:14:41 --char-read --handle=0x001b)
stringZ=${stringZ:33:2}
stringZ=$(echo "$stringZ" | tr a-f A-F)
decimal=$(echo "ibase=16; $stringZ" | bc)
perl /opt/fhem/fhem.pl 7072 "setreading MeinGtag Batterie $decimal"
</pre>

Dem Device in FHEM (hier MeinGtag) ein userReading mit dem Namen '''Batterie''' hinzufügen.
Das Shellskript mit folgendem Befehl starten:
<pre>
./GtagBatterie.sh
</pre>
'''Wichtig ist hierbei,''' dass Skript mit "./" und nicht mit "sh" aufzurufen. Beim Aufruf mit "sh GtagBatterie.sh" produziert es einen Fehler
<pre>GtagBatterie.sh: 3: GtagBatterie.sh: Bad substitution </pre>

Das Reading wird auf den ausgelesenen Wert der Batterie gesetzt.

Hinweis: Es sollte für jeden G-Tag ein eigenes Skript abgelegt werden. Das Skript kann per crontab oder fhem Kommando (system) regelmäßig aufgerufen werden.

=== Batterieüberwachung (alle Devices vom Typ "MODE=lan-bluetooth") ===

Es gibt eine weitere Möglichkeit um den Batteriestatus von LE Devices abzurufen und in FHEM als Reading darzustellen.
Dabei wird der Batteriezustand für alle LE Devices, die bereits in FHEM konfiguriert sind und per lepresenced überwacht werden, automatisch in einem shell-Script ermittelt.
Näheres dazu im Forumartikel {{Link2Forum|Topic=56960|LinkText=Erweiterung: Anwesenheitserkennung/Batterieüberwachung}}.

Vorteile:
* Automatische Ermittlung aller in FHEM konfigurierten LE Devices
* Möglichkeit, diese Devices alternativ manuell im Script einzutragen
* Es werden nur Devices abgefragt, die im Status "present" sind, also mit ziemlicher Sicherheit auch verfügbar sind
* Ein eventuell auf dem FHEM telnet-Port gesetztes Passwort kann im Script hinterlegt werden

'''Voraussetzung:'''

'''Funktionierendes lepresenced''' - siehe [[Anwesenheitserkennung#Anleitung_f.C3.BCr_ein_LE_Device_.28z.B._Gtags.2CPebbles_etc..29|Anleitung für ein LE Device (z.B. Gtags,Pebbles etc.)]]

'''socat''' - TCP port forwarder
<pre>
sudo apt-get update && sudo apt-get install socat
</pre>

'''gawk''' - Zum extrahieren der Daten
<pre>
sudo apt-get update && sudo apt-get install gawk
</pre>

'''gatttool''' - Bestandteil von bluez

gatttool ist auf den meisten Distributionen im bluez-Paket, allerdings nicht bei Opensuse. Dort muss man das Sourcepaket von bluez installieren und selbst kompilieren.
gatttool sollte dann nach /usr/bin oder /usr/local/bin kopiert werden,

Zusätzlich zu den notwendigen Erweiterungen werden für die Ausführung von gatttool '''Root-Rechte benötigt'''!

Das Script selbst gibt es hier: [https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery lebattery]

Am Besten unter /opt/fhem/script/lebattery speichern und ausführbar machen:
<syntaxhighlight lang="bash">
sudo su -
mkdir /opt/fhem/script
cd /opt/fhem/script
wget https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery
chmod 755 lebattery
</syntaxhighlight>

Je nach Bedarf können im Script noch die folgenden 3 Parameter angepasst werden:
<syntaxhighlight lang="bash">
# If allowed_telnetPort is protected by a password, add the password here
TELNETPASSWORD=""
# Attribute for batterylevel in FHEM
ATTRIBUT="batterylevel"
# Use this, if you dont want the script to determine the tags on its own
LETAGS=""
</syntaxhighlight>

Das Skript wird dann unter root folgendermaßen gestartet:
<pre>
/opt/fhem/script/lebattery -v
</pre>

Ausgabe des Skripts, wenn es mit dem Verbose Parameter -v gestartet wird.

Beide Devices sind vom Typ NUT mini, das Device mit dem FHEM-Namen '''nut_Micky''' ist im Status '''absent'''. Das zweite Device ist im Status '''present'''.
<pre>
Determining address for nut_Micky ...
nut_Micky is in state absent, no further action required

Determining address for nut_Test ...
Fetching batterylevel for nut_Test (F3:44:04:81:54:89) ...
Setting batterylevel for nut_Test to 100%
</pre>

Mein crontab-Eintrag (User root) sieht so aus:
<pre>
3 3 * * * /opt/fhem/script/lebattery -v >/opt/fhem/script/lebattery.log 2>&1
</pre>
Damit wird jeden Morgen um 3 Minuten nach 3 Uhr der Zustand der Batterien aller Devices ermittelt und in FHEM abgespeichert.<br>
Bevor man das mit crontab macht, sollte man allerdings zunächst sicher stellen, dass es auch ohne crontab funktioniert....

Bei Problemen kann man auch erstmal schauen, ob das mit dem gattool überhaupt funktioniert:
<pre>
gatttool -t <Typ> -b <MAC-Adresse> --char-read --uuid 0x2a19

handle: 0x0017 value: 64
</pre>
In diesem Fall hat die Batterie noch 100% (hex 64).<br>
Der Typ ist abhängig vom Hersteller und kann public (G-Tags) bzw. random (Nut) sein. Im Zweifelsfall beides ausprobieren.

= Beispiele =
== Anwesenheitserkennung / Anwesenheitsbenachrichtigung mit G-Tags ==
Ein Skript zur Nutzung der Gigaset G-TAGs zur Alarmierung bei öffnen und schließen von Türen und zur Anwesenheitserkennung, um die Alarmierung zu aktivieren bzw. deaktivieren.
Es kann verwendet werden um die Anwesenheit von mehrern Personen im Haushalt zu erkennen. Dabei wird eingeschränkt, dass nur bestimmte Personen die Alarmierung aktivieren können ( Eltern/Kind -Beziehung ).
Des Weiteren werden im Beispiel die Eltern benachrichtigt wenn eins der Kinder das Haus verlässt und die Eltern nicht anwesend sind.

{{Randnotiz|RNText=Namen der G-Tags in den Skripten bitte anpassen!}}

Für die ''Notify'' und die ''RESIDENTS-Erweiterung'' wird ein Dummy benötigt.
<pre>
define Alarm dummy
attr Alarm devStateIcon aktiv:secur_locked@red inaktiv:secur_open@lightgreen
attr Alarm eventMap on:aktiv off:inaktiv
attr Alarm setList on off
attr Alarm webCmd aktiv:inaktiv
attr Alarm room Alarm
</pre>

=== Mit Notify ===
<pre>
gtag.*.presence:.* {Anwesenheit_check("$EVTPART1", "$NAME")}
</pre>

Code für die 99_myUtils.pm
<pre>
### GTAG ANWESENHEITS CHECK
sub Anwesenheit_check($$) {
my ($EVENT, $NAME) = @_;

# gtag_rot - Alias Marco
# gtag_schwarz - Alias Ulli
# gtag_gruen - Alias Frida
# gtag_orange - Alias Hannah

my $RESIDENT = "rr_"; # Alle GTAGs sind Standardmäßig Residents Roommate
# $RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur Gäste (Roomguest) Auskommentiert, da ich es so nicht brauche
my $ROOMMATE = ("$RESIDENT" . "$NAME"); # Residentsname zusammenbauen
my $ALIASNAME = AttrVal($ROOMMATE,'alias',$ROOMMATE); # ALIAS des Roommates auslesen

my $GTAG1 = Value('gtag_rot'); # ELTERN
my $GTAG2 = Value('gtag_schwarz'); # ELTERN

my $STATUS = "wahrscheinlich gerade los";
$STATUS = "anwesend" if ($EVENT eq "present"); # Status: anwesend
$STATUS = "unterwegs" if ($EVENT eq "absent"); # Status: unterwegs

Log 1, "$ALIASNAME ist $STATUS."; # LOG Eintrag erzeugen

if (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME ist da..."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME ist da...'"); # Pushover
}
elsif (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_rot" xor $NAME eq "gtag_schwarz")) {
fhem("set teleBot send ALARMIERUNG INAKTIV: $ALIASNAME ist da...; set Alarm inaktiv"); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG INAKTIV' '$ALIASNAME ist da...'; set Alarm inaktiv"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME hat das Haus verlassen.'"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "inaktiv") && ($GTAG1 eq "absent" && $GTAG2 eq "absent")) {
fhem("set Alarm aktiv; set teleBot send ALARMIERUNG AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Alarm aktiv; set Infopush msg 'ALARMIERUNG AKTIV' '$ALIASNAME hat das Haus verlassen.' '' 0 ''"); # Pushover
}
}
</pre>

<br>

=== Mit Notify und Integration des RESIDENTS-MODUL ===

Der hier beschriebene Code erweitert die Funktionen unter dem Punkt 5.93.
Das Notify muss daher mit der folgenden Zeile erweitert werden.

<pre>
define Alarm_AnwesenheitCheck notify gtag.*.presence:.* { Anwesenheit_check("$EVTPART1", "$NAME"), Anwesenheit_check_resi("$NAME") }
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die RESIDENTS Funktion nutzen zu können:
<pre>
### RESIDENTS
sub Anwesenheit_check_resi($) {
my ($NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME); # ALIASNAME des GTAGs auslesen

my $RESIDENT = "rr_"; # Als Standard sind alle GTAGs Roommates
$RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur GTAG Namen der Gäste (Roomguest)
my $ROOMMATE = ("$RESIDENT" . "$ALIASNAME"); # Residentsname zusammenbauen

if (ReadingsVal($NAME,'presence',$NAME) eq "absent") {
fhem("set $ROOMMATE absent"); # Resisents Status von Roommates setzen
}
elsif(ReadingsVal($NAME,'presence',$NAME) eq "present") {
fhem("set $ROOMMATE home"); # Resisents Status von Roommates setzen
}
}
</pre>
<br>

=== Mit Notify und Fenster/Tür. -Kontakt Überwachung ===

Erweiterung für die Überwachung von Fenster/Tür. -Kontakten. Dazu sind zwei weitere Notifys notwendig die auf die Trigger der Kontakte regagieren
und so eine weitere Funktion in der 99_myUtils.pm ansprechen. Die Notifys triggern auf Kontakte die mit dem Namen Kontakt* beginnen.
Sollten die eigenen Fenster/Tür. -Kontakt anderen Namen besitzen, müssen die Skripte dementsprechend angepasst werden.
<pre>
define Alarm_Kontaktmeldung notify Kontakt.*:contact:.* {Kontakt_Meldung("$EVTPART1", "$NAME")}
</pre>
<pre>
define Alarm_Sabotagealarm notify Kontakt.*.sabotageError:.on {Kontakt_Sabotage("$EVTPART1", "$NAME")}
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die TÜRKONTAKTE-Meldung nutzen zu können:
<pre>
### TÜRKONTAKTE-Meldung/Zustand
sub Kontakt_Meldung($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME wurde $EVENT";
if (ReadingsVal("Alarm", "state", "on") eq "on") {
fhem("set teleBot send $ALIASNAME wurde $EVENT"); # Nachricht über Telegram
# fhem("set Infopush msg '$ALIASNAME' '$ALIASNAME wurde $EVENT'"); # Nachricht über Pushover
}
}

### TÜRKONTAKTE-Sabotagealarm

sub Kontakt_Sabotage($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME meldet Sabotagealarm";
fhem("set teleBot send Alarm: $ALIASNAME meldet Sabotagealarm"); # Nachricht über Telegram
# fhem("set Infopush msg 'Alarmanlage' '$ALIASNAME meldet Sabotagealarm' '' 2 ' ' 60 600 "); # Nachricht über Pushover
}
</pre>
<br>

=== Hinweis zur Benutzung / Fehlerhandling ===

Der Alarm dummy hat den Zustand on:off. Die Bezeichnungen und Namen müssen 1:1 übernommen werden damit das Script funktioniert.
Andernfalls müssen die Bezeichnungen für z.B. absent:unterwegs und present:anwesend - angepasst werden.
Die Benachrichtigung kann aktuell per ''Telegram'' sowie ''Pushover'' ('''Achtung mit zweiterem sind Abokosten verbunden!''') realisiert werden.
Diskussion zum Thema im Forum unter: {{Link2Forum|Topic=64080}}
<br>

= Problemlösungen =
Falls es '''Probleme beim Starten des Skripts''' gibt bzw. man das Skript ohne Reboot des Systems neustarten möchte, kann man dies per kill Befehl erledigen.
<syntaxhighlight lang="bash">
ps -ef | grep lepresenced
sudo kill <pid>
</syntaxhighlight>

Debuglevel lepresenced setzen:
{{Randnotiz|RNText=Um Debug-Meldungen zu bekommen (Vorsicht bei SD-Karten-Systemen wie dem RPi) - Hierbei werden die Schreibzyklen auf die SD-Karte erhöht.}}

Der Log Level muss im lepresenced-Skript selbst verändert werden. Um den Log-Level auf INFO/WARNING/DEBUG zu setzen, dass Skript lepresenced mit einem Editor öffnen und die Stellen, wo LOG_WARNING zu finden sind durch den nötigen LOG-Eintrag ersetzen.

<pre>
lepresenced --loglevel LOG_DEBUG
</pre>
Nur das wichtigste Loggen:
<pre>
lepresenced --loglevel LOG_WARNING
</pre>
Keinerlei LOG-Einträge
<pre>
lepresenced --loglevel LOG_EMERG
</pre>

Bei '''Problemen mit der Batterieüberwachung''' der Tags kann die Pi Firmeware mit folgenden Befehl auf eine ältere Version zurückgesetzt werden.
Fehlermeldung beim Aufruf des lebattery oder anderen Batterietestskripten:
<pre>connect: Connection refused (111)</pre>

Lösung (vorübergehend)
<pre>
sudo rpi-update 8521fd34c8f66b6d109acce943f6e25ec93ec005
</pre>

Mehr dazu unter: {{Link2Forum|Topic=56960|Message=589165}}

'''Das BT-Device ist ständig "absent"'''<br>
Eine Mögliche Lösung kann sein, dass Paket bluez-hcidump zu installieren. Das Werkzeug hcidump erlaubt die Beobachtung von Bluetooth-Aktivität.
Dies ist nicht notwendig, wenn bereits bluez installiert ist, da dies Teil des bluez Paketes ist
<pre>
sudo apt-get install bluez-hcidump
</pre>

'''Fehler in Logdateien /var/log/syslog und /var/log/kernel'''
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634211] bt_err_ratelimited: 1 callbacks suppressed
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634231] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:12 raspberrypi kernel: [ 4906.647350] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.532081] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.655564] Bluetooth: hci0 advertising data length corrected

Die Ursache des Problems ist noch nicht ergründet, allerdings betrifft dies aktuell nur den RPi3. Die Fehlermeldungen werden in verschiedene log's geschrieben. Darunter maßgeblich "syslog" und "kern.log".

Lösung (vorübergehend)
Unterbinden der Einträge durch Anlage eines blocklist Eintrag:

1. Unter "/etc/rsyslog.d" eine Datei erzeugen mit dem Namen "01-blocklist.conf"
2. Inhalt: (Die Ausdrücke in den "" sind diejenigen, die aus dem log verschwinden sollen. - bei mir waren es die unten stehenden")
:msg,contains,"Bluetooth: hci0 advertising data length corrected" stop
:msg,contains,"bt_err_ratelimited:" stop
3. Dienst neu starten "sudo service rsyslog restart"

Weiter Infos werden im offiziellen Thema {{Link2Forum|Topic=28753|Message=499184|LinkText=hier}} diskutiert.

Seit Version 0.82 kann es beim Start zu folgenden Meldungen im Log kommen.
Sep 06 16:13:45 raspberrypi systemd[1]: Started lepresenced.
Sep 06 16:13:45 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: Received 'Set scan parameters failed: Input/output error', ...tting...
Sep 06 16:13:46 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: hcitool exited, retrying...

Diese Meldungen können ignoriert werden. Abhilfe schafft sich lepresenced selbst indem es sich resettet.

'''Moderne iPhones und Android Geräte wechseln zum "deep standby" Modus''', und werden dann als "abwesend" gemeldet.
Mittels einer Funktion, die via hping3 Packete an den Geräte senden, um die "wach" zu halten, und dann die MacAdresse ausliest, kann man dieses Problem umgehen. Mehr im Forum [https://forum.fhem.de/index.php/topic,76342.0.html]

= Versionsänderungen lepresenced =
<pre>
--Version 0.81 (BasisVersion)
--Version 0.82 (stable 08/2017)
-Neue Kommandozeilenoption "--debug": Startet lepresenced im Vordergrund und gibt ausführliche Debug-Informationen auf STDOUT aus.
-Sanity Check: lepresenced prüft beim Starten die Verfügbarkeit von hciconfig, hcitool und hcidump.
-Model: lepresenced übermittelt das Reading model nun als lan-lepresenced. Das erlaubt die Erkennung von lepresenced in der FHEM-Statistik (sofern aktiviert).
--Version 0.83 (stable 09/2017)
- Behebung von Systemstart Fehlern
- Weitere Debug-Möglichkeiten. U. a. wird nun mitgezählt, ob hcitool lescan ("legacy") und hcidump eine identische Zahl an Beacons empfangen
</pre>

= Ansprechpartner =
# {{Link2FU|117|markusbloch }} (Markus) für das PRESENCE-Modul und collectord
# {{Link2FU|5068|PatrikR}} (Patrick) für lepresenced
# [[Benutzer Diskussion:Devender|Devender]] ({{Link2FU|20043|Dirk}}) für Wiki und Doku

PRESENCE

2018-06-29T12:51:11Z

50watt: /* BT-Dongle am PI installieren */

{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h

|ModTechName=73_PRESENCE.pm
|ModOwner=markusbloch
}}

Das [[PRESENCE]] Modul bietet für die Anwesenheitserkennung mehrere Varianten an:

* '''lan-ping''' - Das Überwachen via PING Checks, die durch den FHEM Server versandt werden.
* '''fritzbox''' - Das Überwachen von Geräten auf einer FritzBox via ctlmgr_ctl (Nur auf einer FritzBox möglich)
* ''' Bluetooth'''
:- '''local-bluetooth''' - Das Überwachen via Bluetooth Checks, die vom FHEM Server direkt durchgeführt werden (angeschlossener Bluetooth-Stick und die Software bluez voraussgesetzt)
:- '''lan-bluetooth''' - Das Überwachen von Bluetoothgeräten, über Netzwerk. Auf einer oder mehreren Maschinen im Netzwerk (z.B. [[:Kategorie:Raspberry Pi|Raspberry Pi]]) läuft ein Presence-Daemon, der nach Bluetooth-Geräten sucht. Um mehrere Presence-Daemon mit FHEM zu verbinden, gibt es den Collector-Daemon, der sich zu allen Presence-Damons im Netzwerk verbindet und das Ergebnis von allen zusammenfasst.
* '''function''' - Das Überwachen mithilfe einer selbst geschrieben Perl-Funktion, die den Anwesenheitsstatus zurückgibt (0 oder 1)
* '''shell-script''' - Das Überwachen mithilfe eines selbst geschriebenen Shell-Programms/Skript, das eine 0 oder 1 ausgibt, um den Anwesenheitsstatus mitzuteilen.

= Überwachen mittels Ping im WLAN/LAN =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Um ein Gerät via Ping zu überwachen, muss folgende Definition durchgeführt werden:
:<code>define Handy PRESENCE lan-ping 192.168.0.30</code>

Dadurch wird die IP-Addresse 192.168.0.30 alle 30 Sekunden geprüft, ob sie erreichbar ist. Wenn sie erreichbar ist, ist der Status "present" (anwesend), ansonsten "absent" (abwesend).

Der Timeout kann verändert werden, indem ein Wert (in Sekunden) an das Define anhängt wird:
:<code>define Handy PRESENCE lan-ping 192.168.0.30 '''60'''</code>

Nun würde das Handy alle 60 Sekunden geprüft werden.

Nur wenn bei einem iPhone/iPad die Funktion "über WLAN synchronisieren" aktiviert ist, ist es auch im Standby zuverlässig pingbar. Standardmäßig deaktivieren Apple-Geräte ihr WLAN im Standby-Betrieb um die Akkulaufzeit zu verlängern.

Sollte die Fehlermeldung
:<code> PRESENCE (Handy) - ping command returned with output: ping: icmp open socket: Operation not permitted </code>
im Log auftauchen und lan-ping dadurch nicht funktionieren, liegt ein Berechtigungsproblem vor. Kein Grund den User fhem zu root zu machen!
Prüfe zu erst als User root ob die Capabilities gesetzt sind.
:<code>getcap /bin/ping</code>
Sollte folgendes Ergeben zu Tage fördern.
:<code>/bin/ping = cap_net_raw+ep</code>
Ist dem nicht so, setzen wir die benötigten Capabilities
:<code>setcap cap_net_raw+ep /bin/ping</code>
Mehr Informationen zum Thema Capabilities [https://manpages.debian.org/jessie/manpages-de/capabilities.7.de.html].

= FritzBox: direktes Abfragen der Aktivität via ctlmgr_ctl =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Eine sehr häufige und auch zuverlässige Methode ist auf einer FritzBox die Abfrage mittels ctlmgr_ctl Befehl. Über diesen lassen sich alle Geräte abfragen ob sie aktiv sind. Ist ein Gerät aktiv, so gilt es als anwesend.

Dieser Modus kann allerdings nur in FHEM Installationen direkt auf einer FritzBox verwendet werden. Des weiteren muss FHEM unter dem User root laufen. Um ein Gerät zu überwachen, wird lediglich der Gerätename benötigt, so wie er unter dem Menüpunkt "Heimnetz" auftaucht.

Die erforderliche Definition:
:<code>define Handy PRESENCE fritzbox iPhone-4S</code>

= Überwachung mittels Perl-Code =
Es ist möglich zum Überwachen von Geräten eine eigene Perl-Funktion zu verwenden die dann vom PRESENCE Modul im Hintergrund aufgerufen wird.

define <name> PRESENCE function {...} [ <check-interval> [ <present-check-interval> ] ]

Sobald die Funktion den Rückgabewert 1 hat, ist das Gerät anwesend, bei 0 abwesend.

== Beispiel DHCP Überwachung auf Airport Basestation ==
Die hier vorgestellte Überwachung der DHCP Lease auf Airport Basestations per SNMP ist absolut robust gegenüber dem Ruhezustand von iOS und setzt keine weitere Konfiguration auf dem iPhone voraus. Das Abmelden beim Verlassen des Empfangsbereiches der Basestation geschieht mit etwa 5-10 Minuten Verzögerung und ist somit auch vor kurzzeitigen Empfangsproblemen sicher. Das nebenstehende Bild (???) verdeutlicht noch mal die Unterschiede zwischen einer IP-Basierten Ping-Überwachung und der Überwachung auf Ebene der Basestation oder FritzBox.

Bevor der folgende Code verwendet werden kann ist das Perl Modul Net:SNMP zu installieren (z. B. mit: <code>cpan install use Net::SNMP</code>).

Zuerst ist folgender Code in 99_myUtils.pm einzufügen, sollte diese noch nicht vorhanden sein muss diese aus dem Template welches unter Edit Files zu finden ist erzeugt werden.
'''Achtung, das ist nicht der komplette Inhalt der 99_myUtils!''' Das ist nur die einzelne Routine

<pre>
use Net::SNMP;
sub
snmpCheck($$)
{
my ($airport,$client)= @_;

my $community = "public";
my $host = $airport;
my $oid = ".1.3.6.1.2.1.3.1.1.2";
#my $oid = ".1.3.6.1.2.1.3.1.1.2.25.1.10.0.1";

my ( $session, $error ) = Net::SNMP->session(
-hostname => $host,
-community => $community,
-port => 161,
-version => 1
);

if( !defined($session) ) {
return 0;
return "Can't connect to host $host.";
}

my @snmpoids = ();

my $response = $session->get_next_request($oid);
my @nextid = keys %$response;
while ( @nextid && $nextid[0] && $nextid[0] =~ m/^$oid/ ) {
push( @snmpoids, $nextid[0] );

$response = $session->get_next_request( $nextid[0] );
@nextid = keys %$response;
}

if( !defined($response = $session->get_request( @snmpoids ) ) ) {
return 0;
}

foreach my $value (values %$response) {
return 1 if( $value eq $client )
}

return 0;
}
</pre>

Danach lässt sich das Mobilgerät so überwachen:
:<code>define iPhone PRESENCE function {snmpCheck("10.0.1.1","0x44d77429f35c")} 30 30</code>

wobei 10.0.1.1 durch die IP-Adresse der Basestation und 0x44d77429f35c durch die MAC Adresse des Geräts als HEX-Zahl ersetzt werden muss.

== Beispiel Anwesenheitserkennung mittels UniFi Controller ==

Die Anwesenheitserkennung bei Geräten in Verbindung mit UniFi-Produkten funktioniert selbst dann, wenn sich die Geräte im PowerSave-Modus befinden.

Beachte: Die Geräte werden erst ungefähr nach 5 Minuten, nachdem das Gerät das WLAN verlassen hat als disconnected angezeigt.

<code>define <NAME> PRESENCE function {ReadingsVal("<UniFi>","<NamedDevice>","") eq "connected" ? 1:0}</code>

= Überwachen mittels Events =
Der Vorteil gegenüber der Function-Variante ist, dass diese Variante ohne Blocking.pm-Overhead direkt ausgeführt werden kann und in "Echtzeit" abläuft (siehe {{Link2Forum|Topic=40287|Message=562823}}).

<code>define <NAME> PRESENCE event UniFi:NamedDevice:.disconnected UniFi:NamedDevice:.connected</code>

= Überwachen mittels Bluetooth =
== Vorbereitung und Informationen ==
=== Getestete Hardware/Software ===
* '''Raspbian System''' - wheezy, Jessie (interner BT-Controller)
* '''BT-Dongle''' - CSL NET BT USB2.0 Stick, Bluetooth V4.0, Nano <br />'''Achtung''': Es muss ein BT V4.0 oder höher verwendet werden. Nur dieser unterstützt ''LowEnergy''
* '''BT-TAG''' - Gtag von Gigaset, TrackR, UDOO Neo, PebbleBee, iTag von Unitec, X4-LIFE Multifunkti BL-Anhänger, iTag Wireless Anti, Trackr bravo

=== BT-Dongle am PI installieren ===
Um den BT-Dongle ''(hier: CSL NET BT USB2.0)'' am RaspberryPI verwenden zu können, müssen die notwendigen Pakete über die Paketverwaltung von debian nachinstalliert werden.
Wer bereits ein BT-Dongle installiert hat, kann diesen Schritt überspringen.
<pre>
apt-get install bluetooth
</pre>
Nach erfolgreicher Installation der Pakete sollte der RaspberryPI neu gestartet werden.
<pre>
sudo reboot
</pre>

Nach dem erfolgten Reboot bitte das Log des RaspberryPI auf folgende Einträge prüfen:
<pre>
Feb 12 19:52:55 fhem kernel: [ 4.773600] Bluetooth: Core ver 2.20
Feb 12 19:52:55 fhem kernel: [ 4.773748] NET: Registered protocol family 31
Feb 12 19:52:55 fhem kernel: [ 4.773765] Bluetooth: HCI device and connection manager initialized
Feb 12 19:52:55 fhem kernel: [ 4.773797] Bluetooth: HCI socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773821] Bluetooth: L2CAP socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773890] Bluetooth: SCO socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.797531] usbcore: registered new interface driver btusb
</pre>
Sobald der BT-Dongle erkannt wurde ''leuchtet'' (wenn vorhanden) auch die ''blaue/gelbe'' LED am Dongle auf.

=== BT-Tags aktivieren ===
Jetzt kann der BT-Tag aktiviert werden. Bei einigen Tags muss dafür die '''Batteriesicherung''' gezogen werden.

Einen Tag wird mit folgendem Befehl auf der Konsole gesucht:
<syntaxhighlight lang="bash">
sudo hcitool lescan

Ausgabe z.B.:
LE Scan ...
7C:2F:80:A1:XA:XD (unknown)
7C:2F:80:A1:XA:XD Gigaset G-tag
7C:2F:80:A1:X4:X1 (unknown)</syntaxhighlight>
Eine Übersicht über die möglichen Befehle von hcitool gibt es mit der Eingabe von:
<pre>
sudo hcitool

Ausgabe z.B.:
hcitool - HCI Tool ver 5.23
Usage:
hcitool [options] <command> [command parameters]
Options:
--help Display help
-i dev HCI device
Commands:
dev Display local devices
inq Inquire remote devices
scan Scan for remote devices
name Get name from remote device
info Get information from remote device
spinq Start periodic inquiry
epinq Exit periodic inquiry
cmd Submit arbitrary HCI commands
con Display active connections
cc Create connection to remote device
dc Disconnect from remote device
sr Switch master/slave role
cpt Change connection packet type
rssi Display connection RSSI
lq Display link quality
tpl Display transmit power level
afh Display AFH channel map
lp Set/display link policy settings
lst Set/display link supervision timeout
auth Request authentication
enc Set connection encryption
key Change connection link key
clkoff Read clock offset
clock Read local or remote clock
lescan Start LE scan
lewladd Add device to LE White List
lewlrm Remove device from LE White List
lewlsz Read size of LE White List
lewlclr Clear LE White list
lecc Create a LE Connection
ledc Disconnect a LE Connection
lecup LE Connection Update
</pre>

Falls beim SCAN kein Tag gefunden wird, sollte das BT Interface neu gestartet werden. Dazu ist kein Reboot des PI notwendig.
<syntaxhighlight lang="bash">
sudo hciconfig hci0 down
sudo hciconfig hci0 up
sudo hcitool dev
</syntaxhighlight>

== Überwachung durch den FHEM Server direkt ==
[[Datei:Bluetooth-Adresse-iPhone.png|thumb|Bluetooth-Adresse eines iPhones]]
Jenach Aufstellungsort des FHEM Servers kann es sinnvoll sein, eine Bluetooth-Überwachung direkt durch den FHEM Server durchzuführen. Hierbei gilt allerdings zu beachten, dass Bluetooth nicht für große Reichweiten gedacht ist und in den meisten Fällen keine Wände überwinden kann. Das heisst, dass in den meisten Fällen damit nur ein Raum überwacht werden kann.

Je nach Einsatzzweck kann das auch so gewollt sein. Bluetooth USB Sticks, die bereits Bluetooth 4.0 unterstützen, können höhere Reichweiten über Zimmerwände hinaus erreichen. Vorausgesetzt, das Mobilgerät unterstützt Bluetooth 4.0.

Um eine Überwachung per Bluetooth durchführen zu können, benötigt man die Bluetooth-Adresse eines Gerätes. Diese ähnelt vom Aufbau einer MAC-Adresse. Generell wird die Adresse in den Telefon-Informationen bei Smartphones angezeigt.

Um eine Anwesenheitserkennung via Bluetooth durchzuführen, wird folgende Definition in der [[Konfiguration]] benötigt:
:<code>define Handy PRESENCE local-bluetooth XX:XX:XX:XX:XX:XX</code>

== Überwachung durch verteilte Agenten in der Wohnung (presenced/lepresenced/collectord) ==
[[Datei:Raspberry-Pi-mit-WLAN-und-Bluetooth-Stick.jpg|thumb|left|Raspberry Pi mit Bluetooth- und WLAN-USB-Stick]]
Um eine zuverlässige und flächendeckende Bluetooth-Anwesenheitserkennung durchzuführen, ist es unerlässlich, mehrere Bluetooth-Empfänger zu verwenden, die auf mehrere oder alle Räume verteilt sind.

Hierfür bietet sich zum Beispiel ein [[Raspberry Pi]] mit einem Mini-Bluetooth-USB-Stick und evtl. einem WLAN-USB-Stick an. Jeder Raum wird mit solch einem Raspberry ausgestattet und ist im WLAN Netz verfügbar.

Dieses Netz aus Raspberrys wird mit dem presenced / lepresenced Programm ausgestattet. Beide Programme sind Perl-Skripte, die als Daemon im Hintergrund laufen und auf Anfragen via Netzwerk warten. Es wird lediglich eine vollständige Perl-Grundinstallation mit Standardmodulen benötigt.

=== Unterschied presenced / lepresenced / collectord ===
presenced und lepresenced sind Programme, welche in regelmäßigen Abständen nach Bluetooth-Geräten suchen. Sobald ein Gerät, welches vorab definiert wurde, gefunden wird, wechselt der Status des Geräts in FHEM auf Anwesend. Der Unterschied zwischen presenced und lepresenced ist, dass lepresenced insbesondere für [https://de.wikipedia.org/wiki/Bluetooth_Low_Energy Bluetooth-LE-Devices] ist und presenced für "normale" Bluetooth-Geräte.

collectord wiederum ist ein Programm, welches mehrere Pis verbindet und auf allen den aktuellen Status von presenced/lepresenced abfragt. Ist das gesuchte Bluetooth-Gerät auf einem der Pi anwesend, so wird es auch in der definierten Hauptinstanz auf anwesend gesetzt. Zusätzlich wird der Pi auf dem das Gerät gefunden wurde als Reading angegeben. Sofern alle Räume einen Empfangspegel (RSSI) ermitteln können, wird bei mehreren anwesenden Räumen der Raum mit dem besten Empfangspegel selektiert (siehe {{Link2Forum|Topic=54482}}).

=== Installation von (le)presenced ===
Diese Anleitung ist sowohl für presenced, als auch für lepresenced gültig. Einfachheitshalber wird nur lepresenced erwähnt, sämtliche Schritte gehen jedoch auch mit presenced, wobei einfach die genannten Daten durch presenced ersetzt werden müssen.

Die Software lepresenced kann aktuell über drei Varianten installiert werden. Dabei ist die bevorzugte Variante (Variante 1) die Installation über das bereitgestellte .deb-Paket.
Die Variante 2 setzt voraus, dass im FHEM contrib Verzeichnis (/opt/fhem/contrib) die aktuelle Version des .deb-Pakets liegt. Die Variante 3 ist dafür gedacht, wenn man keine .deb-Pakete installieren kann/will oder es aus anderen Gründen nicht funktioniert. Es wird davon abgeraten die Variante 3 zu verwenden. Vollständigkeitshalber wird sie aber aufgeführt.

===== Installation per .deb-Paket =====

Die bevorzugte Variante ist die Installation von lepresenced durch die passenden .deb Pakete.
{{Randnotiz|RNText=Bei einem Upgrade einer älteren Version reicht es, das neue .deb Paket mit
:<code>sudo dpkg -i lepresenced-X.XX-X.deb</code>
zu aktualisieren}}

'''1.Variante:'''
Herunterladen der aktuellen lepresenced-0.83-3.deb (Stand August 2017) Datei über den Webbrowser
[https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/ SVN-Repository]. Im SVN die passende Datei auswählen und in der folgende Webseite den Link unter:
<pre>
Download in other formats:
Original Format
</pre>
anklicken und die Datei herunterladen.
Die Datei kann jetzt auf den RPi kopiert und mit folgenden Befehlen ausgeführt werden (ggf. Berechtigungen anpassen).

Alternativ per wget Befehl direkt auf den RPi (aktuelle Versionsnummer beachten)
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/lepresenced-0.83-3.deb

'''2.Variante:''' (zu Verwenden, wenn es Probleme bei Variante 1 gibt)
Herunterladen aus dem fhem contrib Verzeichnis:
Hierzu muss das contrib auf dem aktuellen Stand sein. Dazu wird die Installation von subversion (normal bereits vorhanden) benötigt.

sudo apt-get install subversion

Danach kann per
sudo svn checkout https://svn.fhem.de/fhem/trunk/fhem/contrib svnrepo

Das aktuelle Repository auf den Pi heruntergeladen werden. Danach sollte im gewählten Verzeichnis die eingecheckten Dateien verfügbar sein.
/opt/fhem/svnrepo/PRESENCE/deb

''' Installation der Variante 1 oder 2 '''

Egal welche Variante gewählt wurde, nun kann mit folgenden Befehlen das Paket installiert werden. Bitte Pfade ggf. anpassen.

'''Wichtig''': Das '''Paket''' hat eine ca. Größe von '''6,5Kb'''. Ab und an gibt es wohl Probleme mit der Installation, wodurch die Datei 11,5kb groß wird.
Diese Datei lässt sich nicht Installieren. In diesem Fall das Paket bitte mit der Variante 1 und dem Bereich "Download in other formats" herunterladen.

sudo dpkg -i lepresenced-0.83-3.deb

sudo apt-get -f install

Die Ausgabe der Installation sollte am Ende ein [ ok ] Starting lepresenced (via systemctl): lepresenced.service. ausgeben.

<pre>
Paketlisten werden gelesen... Fertig
Abhängigkeitsbaum wird aufgebaut.
Statusinformationen werden eingelesen.... Fertig
Abhängigkeiten werden korrigiert ... Fertig
Die folgenden zusätzlichen Pakete werden installiert:
bluez-hcidump
Die folgenden NEUEN Pakete werden installiert:
bluez-hcidump
0 aktualisiert, 1 neu installiert, 0 zu entfernen und 0 nicht aktualisiert.
1 nicht vollständig installiert oder entfernt.
Es müssen 157 kB an Archiven heruntergeladen werden.
Nach dieser Operation werden 490 kB Plattenplatz zusätzlich benutzt.
Möchten Sie fortfahren? [J/n]
Holen: 1 http://archive.raspberrypi.org/debian/ jessie/main bluez-hcidump armhf 5.23-2+rpi2 [157 kB]
Es wurden 157 kB in 0 s geholt (921 kB/s).
Vormals nicht ausgewähltes Paket bluez-hcidump wird gewählt.
(Lese Datenbank ... 42033 Dateien und Verzeichnisse sind derzeit installiert.)
Vorbereitung zum Entpacken von .../bluez-hcidump_5.23-2+rpi2_armhf.deb ...
Entpacken von bluez-hcidump (5.23-2+rpi2) ...
Trigger für man-db (2.7.0.2-5) werden verarbeitet ...
bluez-hcidump (5.23-2+rpi2) wird eingerichtet ...
lepresenced (0.82-1) wird eingerichtet ...
[ ok ] Starting lepresenced (via systemctl): lepresenced.service.
</pre>

'''3.Variante:'''

Bei dieser Variante wird das aktuellste lepresenced Skript aus github heruntergeladen. Das bedeutet, dass jegliche Konfiguration wie automatischer Start, Berechtigungen etc.
manuell konfiguriert werden muss. Diese Variante eignet sich nur für diejenigen, die keine .deb-Pakete installieren wollen/können oder die genau Wissen, was sie tun!
<pre>
https://github.com/mhop/fhem-mirror/blob/master/fhem/contrib/PRESENCE/lepresenced
</pre>

Zur "Installation" des Skripts folgendermaßen vorgehen:
Unter /fhem manuell den Ordner „script“ anlegen:
<pre>
mkdir script
</pre>
Datei lepresenced reinkopieren und ausführbar machen:
<pre>
sudo chmod +x /opt/fhem/script/lepresenced
sudo chgrp -cR dialout lepresenced
</pre>
Skript erstmalig starten:
<pre>
sudo ./lepresenced --loglevel LOG_EMERG -d
</pre>
Kommt beim Starten des Skript eine Fehlermeldung, müssen die Abhängigkeiten aufgelöst werden.
<pre>
Can't locate Net/Server/Daemonize.pm in @INC (@INC contains: /etc/perl /usr/local/lib/perl/5.14.2 /usr/local/share/perl/5.14.2 /usr/lib/perl5 /usr/share/perl5 / usr/lib/perl/5.14 /usr/share/perl/5.14 /usr/local/lib/site_perl .) at /opt/fhem/lepresenced line 17.
BEGIN failed--compilation aborted at /opt/fhem/lepresenced line 17.
</pre>
Um die Abhängigkeiten aufzulösen muss folgendes nachinstalliert werden und anschließend ein Reboot durchgeführt werden.
<pre>
sudo apt-get install libnet-server-*
</pre>

===== Einrichtung eines Bluetooth-Geräts über FHEM =====

Nach dem letzten Schritt sind alle Bedingungen für eine abschließende Konfiguration eines BT-Geräts in FHEM abgeschlossen worden.
Jetzt kann der zum Beispiel ein G-Tag dem FHEM-Server bekannt gemacht werden:
<pre>
-- Name Modul Modus MAC vom Gtag IP vom PI Port Abfragezeit in Sekunden
define MeinGtAG PRESENCE lan-bluetooth xx:xx:xx:xx:xx:xx 127.0.0.1:5333 120
</pre>

'''Wichtig ist den angegeben Port zu unterscheiden. Für presenced muss der Port 5111 genommen werden, für lepresenced der Port 5333.'''
Den absent und present Mode kann man einfach testen, in dem man den Gtag mit Alufolie einwickelt.

Diese Variante sollte eingesetzt werden, wenn nur ein Pi nach Bluetooth-Geräten sucht. Möchte man mehr als ein Gerät nutzen um zum Beispiel eine größere Fläche abzudecken so muss mit collectored gearbeitet werden.

=== Alle Räume gemeinsam ansprechen mittels collectord ===
Um zwei presenced- oder lepresenced Installationen zu verbinden wird der collectord Daemon von Markus Bloch benötigt. Dieser kennt alle presenced-Installationen im Netzwerk und führt eine koordinierte Suche nach den gewünschten Geräten durch. Sobald ein Gerät in einem Raum erkannt wurde, meldet der collectord den Status einschließlich der Angabe des Raumes, in dem das Gerät erkannt wurde.

[[Datei:Presence_Collectord_Uebersicht.jpg|200px|thumb|left|Schematische Darstellung Presence und Collectord, Danke an dtavb]]
Auf Basis folgender Skizze wird die Einrichtung und der Betrieb der Anwesenheitserkennung und Überwachung <p></p>
mit dem PRESENCE-Modul sowie dem Skript (.deb-Paket) lepresenced beschrieben. Zusätzlich wird für die Verbindung <p></p>
mehrere lepresenced Instanzen der collectord verwendet.<p></p>
Diese Skizze dient als Basis für alle genannten Konfigurationen innerhalb dieses Artikels.
{{NeuerTextBlock}}

==== Aufbau ====
; RPi1 (Hauptinstanz):
: FHEM Installation
: presence/lepresenced Installation
: collectord installation
: Sämtliche Bluetooth-Geräte in FHEM definiert
; RPi2 (Zweitsystem):
: FHEM installation
: presence/lepresenced Installation
: Sämtliche Bluetooth-Geräte in FHEM definiert

==== Installation per .deb-Paket ====
collectord wird heruntergeladen und installiert:
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/collectord-1.8.deb (Stand Januar 2018)
<pre>
sudo dpkg -i collectord-1.8.deb
</pre>

Nach der Installation befindet sich im Verzeichnis: /etc/collectord.conf die Konfigurationsdatei für das collectord. Weitere Einstellungen können unter /etc/default/collectord vorgenommen werden.

==== Konfiguration auf Shellebene ====
<pre>
sudo vi /etc/collectord.conf
</pre>

Diese Datei muss jetzt nach folgender Vorlage angepasst werden.
<pre>
# room definition
#[room-name] # name of the room
#address=192.168.0.10 # ip-address or hostname
#port=5111 # tcp port which should be used (5111 is default)
#presence_timeout=120 # timeout in seconds for each check when devices are present
#absence_timeout=20 # timeout in secondsfor each check when devices are absent

[RPi1] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=127.0.0.1 # Lokale Adresse RPi1 , da hier das Collectord später laufen soll!
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaelte Pruefintervalle
absence_timeout=60 # Selbstgewaelte Pruefintervalle

[RPi2] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=192.168.178.127 # IP-Adresse der Instanz, wo nur das Presence laueft, also RPi2
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaelte Pruefintervalle
absence_timeout=60 # Selbstgewaelte Pruefintervalle
</pre>

Hinweis:
* Es dürfen keine [Namen] mit Leerzeichen verwendet werden
* Der angegebene Port richtet sich danach, ob auf dem Pi presenced (Port 5111) oder lepresenced (Port 5333) nach dem Bluetooth-Gerät sucht

==== Konfiguration in FHEM ====
;RPi1
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 127.0.0.1:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222)''
;RPi2
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 192.168.178.127:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222 - die IP-Adresse von die von RPi1)''

Nach der Konfiguration kann der Daemon gestartet werden.
Sobald das Bluetoothgerät irgendwo in der Wohnung erkannt wurde, meldet der Collectord dies sofort
an FHEM und teilt den Raum mit in dem es erkannt worden ist. Diese Information wird im Reading "rooms" des jeweiligen BT-Gerätes dargestellt.

Zum testen sollte collectord einmalig manuell gestartet werden. Dies hat den Vorteil, dass man nochmal den Port des collectord prüfen kann, dieser steht in der Zeile <pre>created socket on 0.0.0.0 with port 5222</pre> und man sehen kann, ob der collectord richtig startet, oder Fehler auswirft. Gestartet wird mit folgendem Kommando:
<pre>
sudo collectord -vv -c /etc/collectord.conf
</pre>
Die Ausgabe sieht wie folgt aus:
<pre>
2017-04-02 17:52:55 - =================================================
2017-04-02 17:52:55 - started with PID 15554
2017-04-02 17:52:55 - reading configuration file
2017-04-02 17:52:55 - no config errors found
2017-04-02 17:52:56 - created socket on 0.0.0.0 with port 5222
2017-04-02 17:53:20 - new connection from 127.0.0.1:48656
2017-04-02 17:53:20 - created thread 1 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - created thread 2 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - new connection from 127.0.0.1:48662
2017-04-02 17:53:20 - new connection from 127.0.0.1:48664
2017-04-02 17:53:20 - created thread 3 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 4 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 5 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:20 - created thread 6 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51638
2017-04-02 17:53:22 - created thread 7 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - created thread 8 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51640
2017-04-02 17:53:22 - created thread 9 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:23 - created thread 10 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:29 - new connection from 192.168.xxx.xxx:51642
2017-04-02 17:53:29 - created thread 11 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
2017-04-02 17:53:29 - created thread 12 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
</pre>

Wenn das Log wie oben abgebildet aussieht wurde alles richtig gemacht und unter dem Device in FHEM erscheint ein neues Reading "rooms" mit dem Wert der erkannten PRESENCE-Installation.

'''Verhalten presence timeout im zusammenhang mit dem Attribut "absenceThreshold" der PRESENCE Konfiguration in FHEM'''
<br>
In der collectord.conf sind <code>presence_timeout</code> und <code>absence_timeout</code> für den jeweiligen Raum konfiguriert.
Das bedeutet, sobald irgendein Gerät in diesem jeweiligen Raum anwesend/abwesend ist, wird das jeweilige Timeout an den verbundenen presenced/lepresenced geschickt um damit das Check-Interval entsprechend zu ändern.

In der PRESENCE-Definition kann man ebenfalls ein <code>absence_timeout</code>/<code>presence_timeout</code> setzen. Sobald sich der Zustand ändert, wird auch das jeweilige Timeout an den collectord gesandt. Dies hat aber auf die Checks in den jeweiligen Räumen und damit der collectord.conf keinen Einfluss. Der collectord schickt ein Statusupdate an PRESENCE nur, wenn das vorgegebene Timeout (von PRESENCE) erreicht ist und keine Statusänderung stattfand. Sobald eine Änderung des Status erfolgt wird natürlich sofort der Status an PRESENCE geschickt.

Das Attribut absenceThreshold/presenceThreshold funktioniert nachwievor. Hier ist nur wichtig wie man die Timeouts sowohl in PRESENCE als auch collectord.conf setzt.

'''Das Reading "room" bei einer PRESENCE Definition und der Zusammenhang zu collectord'''
<br>
Wenn ein BT LE Empfänger in mehr als einem Raum detektiert wird, führt der collectord (ab Version 1.8) eine RSSI-Erkennung durch. Sofern alle Räume den Empfangspegel (RSSI) ermitteln können, wird der Raum mit dem besten Empfangspegel als Raum für das "room"-Reading ausgewählt. Der lepresenced in aktueller Version von PatrickR gibt immer den Empfangspegel aus.

==== Automatischer Start ====
Wenn der collectord per .deb Paket installiert wurde, startet er automatisch bei einem Reboot mit (via systemd/init-Skript).
<br>

Der Collectord wird standardmäßig mit dem Port 5222 gestartet. Um diese anzupassen sind zwei Schritte notwendig:<br>
'''1.)''' Anpassen der /usr/bin/collectord
Hier bitte den Parameter my $opt_p von 5222 auf 5XXX abändern.

Da der collectord mittlerweile per systemd beim reboot des RPi gestarte wird muss auch diese Konfiguration auf den neuen Port angepasst werden.<br>
'''2.)''' Anpassen der /etc/default/collectord
<pre>
# collectord startup defaults:
# The TCP port collectord will listen for incoming connections (default: 5222)
PORT=5111
# The location of the configuration file (default: /etc/collectord.conf
CFGFILE=/etc/collectord.conf
</pre>

Manuell starten als Daemon (Parameter <code>-d</code>) mit:
<pre>
sudo collectord -c /etc/collectord.conf -d -v -l /var/log/collectord.log
</pre>

== Batterieüberwachung ==

=== Batterieüberwachung mit dem Modul BleTagBattery ===
{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h

|ModTechName=74_BleTagBattery
|ModOwner=mumpitzstuff
}}
Mit dem Modul BleTagBattery - können die Batteriestati aller BT-LE Devices gelesen werden.
Es wird das batteryLevel und battery angelegt welches als BT-LE Tags an einer PRESENCE-Installation registriert wurden.

Vorraussetzung und Installation:

Bluez und Gattool
sudo apt-get install bluez

Das Gattool ist in den Installationen von Bluez inbegriffen.

Hinzufügen des githup für das Modul
update add http://raw.githubusercontent.com/mumpitzstuff/fhem-BleTagBattery/master/controls_bletagbattery.txt
update all
restart fhem: shutdown restart
BT-LE tags muss an einer PRESENCE-Installation des type "lan-bluetooth" registriert sein.

Nach dem Neustart von FHEM kann das Modul definiert werden:
define a new device: define <name of device> BleTagBattery

Das Modul versucht in der Standardkonfiguration alle 6 Stunden die BT-LE Devices zu erreichen und das Reading batteryLevel und battery zu aktualisieren.
Das Update kann auch manuell mit dem folgenden Befehl erzwungen werden

set <name of device> statusRequest.

Weiter Informationen und Disskussionen können dem eigentlichen [https://forum.fhem.de/index.php?topic=68104.0 Forumsbeitrag] entnommen werden,

=== Batterieüberwachung (aktuell nur G-Tags) ===

Leider überträgt der G-Tag nach der Einrichtung als Device in FHEM kein Reading mit seinem aktuellen Batteriestatus.
Dem wurde mit Hilfe des Forum Abhilfe geschaffen.
Im Folgenden wird erläutert wie die Batterieüberwachung eingerichtet werden kann.

'''Voraussetzung:'''

bc - Basiscalculator [https://packages.debian.org/de/sid/bc Bc-Paket]
<pre> sudo apt-get install bc </pre>

Anlegen eines Shellskript auf dem Raspberry System.
Die Parameter <<MAC-Adresse>> und <<TagName>> müssen durch die Werte des auszulesenden G-Tags ersetzt werden.
<pre>
#!/bin/bash
stringZ=$(sudo gatttool -b 5C:2B:80:C1:14:41 --char-read --handle=0x001b)
stringZ=${stringZ:33:2}
stringZ=$(echo "$stringZ" | tr a-f A-F)
decimal=$(echo "ibase=16; $stringZ" | bc)
perl /opt/fhem/fhem.pl 7072 "setreading MeinGtag Batterie $decimal"
</pre>

Dem Device in FHEM (hier MeinGtag) ein userReading mit dem Namen '''Batterie''' hinzufügen.
Das Shellskript mit folgendem Befehl starten:
<pre>
./GtagBatterie.sh
</pre>
'''Wichtig ist hierbei,''' dass Skript mit "./" und nicht mit "sh" aufzurufen. Beim Aufruf mit "sh GtagBatterie.sh" produziert es einen Fehler
<pre>GtagBatterie.sh: 3: GtagBatterie.sh: Bad substitution </pre>

Das Reading wird auf den ausgelesenen Wert der Batterie gesetzt.

Hinweis: Es sollte für jeden G-Tag ein eigenes Skript abgelegt werden. Das Skript kann per crontab oder fhem Kommando (system) regelmäßig aufgerufen werden.

=== Batterieüberwachung (alle Devices vom Typ "MODE=lan-bluetooth") ===

Es gibt eine weitere Möglichkeit um den Batteriestatus von LE Devices abzurufen und in FHEM als Reading darzustellen.
Dabei wird der Batteriezustand für alle LE Devices, die bereits in FHEM konfiguriert sind und per lepresenced überwacht werden, automatisch in einem shell-Script ermittelt.
Näheres dazu im Forumartikel {{Link2Forum|Topic=56960|LinkText=Erweiterung: Anwesenheitserkennung/Batterieüberwachung}}.

Vorteile:
* Automatische Ermittlung aller in FHEM konfigurierten LE Devices
* Möglichkeit, diese Devices alternativ manuell im Script einzutragen
* Es werden nur Devices abgefragt, die im Status "present" sind, also mit ziemlicher Sicherheit auch verfügbar sind
* Ein eventuell auf dem FHEM telnet-Port gesetztes Passwort kann im Script hinterlegt werden

'''Voraussetzung:'''

'''Funktionierendes lepresenced''' - siehe [[Anwesenheitserkennung#Anleitung_f.C3.BCr_ein_LE_Device_.28z.B._Gtags.2CPebbles_etc..29|Anleitung für ein LE Device (z.B. Gtags,Pebbles etc.)]]

'''socat''' - TCP port forwarder
<pre>
sudo apt-get update && sudo apt-get install socat
</pre>

'''gawk''' - Zum extrahieren der Daten
<pre>
sudo apt-get update && sudo apt-get install gawk
</pre>

'''gatttool''' - Bestandteil von bluez

gatttool ist auf den meisten Distributionen im bluez-Paket, allerdings nicht bei Opensuse. Dort muss man das Sourcepaket von bluez installieren und selbst kompilieren.
gatttool sollte dann nach /usr/bin oder /usr/local/bin kopiert werden,

Zusätzlich zu den notwendigen Erweiterungen werden für die Ausführung von gatttool '''Root-Rechte benötigt'''!

Das Script selbst gibt es hier: [https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery lebattery]

Am Besten unter /opt/fhem/script/lebattery speichern und ausführbar machen:
<syntaxhighlight lang="bash">
sudo su -
mkdir /opt/fhem/script
cd /opt/fhem/script
wget https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery
chmod 755 lebattery
</syntaxhighlight>

Je nach Bedarf können im Script noch die folgenden 3 Parameter angepasst werden:
<syntaxhighlight lang="bash">
# If allowed_telnetPort is protected by a password, add the password here
TELNETPASSWORD=""
# Attribute for batterylevel in FHEM
ATTRIBUT="batterylevel"
# Use this, if you dont want the script to determine the tags on its own
LETAGS=""
</syntaxhighlight>

Das Skript wird dann unter root folgendermaßen gestartet:
<pre>
/opt/fhem/script/lebattery -v
</pre>

Ausgabe des Skripts, wenn es mit dem Verbose Parameter -v gestartet wird.

Beide Devices sind vom Typ NUT mini, das Device mit dem FHEM-Namen '''nut_Micky''' ist im Status '''absent'''. Das zweite Device ist im Status '''present'''.
<pre>
Determining address for nut_Micky ...
nut_Micky is in state absent, no further action required

Determining address for nut_Test ...
Fetching batterylevel for nut_Test (F3:44:04:81:54:89) ...
Setting batterylevel for nut_Test to 100%
</pre>

Mein crontab-Eintrag (User root) sieht so aus:
<pre>
3 3 * * * /opt/fhem/script/lebattery -v >/opt/fhem/script/lebattery.log 2>&1
</pre>
Damit wird jeden Morgen um 3 Minuten nach 3 Uhr der Zustand der Batterien aller Devices ermittelt und in FHEM abgespeichert.<br>
Bevor man das mit crontab macht, sollte man allerdings zunächst sicher stellen, dass es auch ohne crontab funktioniert....

Bei Problemen kann man auch erstmal schauen, ob das mit dem gattool überhaupt funktioniert:
<pre>
gatttool -t <Typ> -b <MAC-Adresse> --char-read --uuid 0x2a19

handle: 0x0017 value: 64
</pre>
In diesem Fall hat die Batterie noch 100% (hex 64).<br>
Der Typ ist abhängig vom Hersteller und kann public (G-Tags) bzw. random (Nut) sein. Im Zweifelsfall beides ausprobieren.

= Beispiele =
== Anwesenheitserkennung / Anwesenheitsbenachrichtigung mit G-Tags ==
Ein Skript zur Nutzung der Gigaset G-TAGs zur Alarmierung bei öffnen und schließen von Türen und zur Anwesenheitserkennung, um die Alarmierung zu aktivieren bzw. deaktivieren.
Es kann verwendet werden um die Anwesenheit von mehrern Personen im Haushalt zu erkennen. Dabei wird eingeschränkt, dass nur bestimmte Personen die Alarmierung aktivieren können ( Eltern/Kind -Beziehung ).
Des Weiteren werden im Beispiel die Eltern benachrichtigt wenn eins der Kinder das Haus verlässt und die Eltern nicht anwesend sind.

{{Randnotiz|RNText=Namen der G-Tags in den Skripten bitte anpassen!}}

Für die ''Notify'' und die ''RESIDENTS-Erweiterung'' wird ein Dummy benötigt.
<pre>
define Alarm dummy
attr Alarm devStateIcon aktiv:secur_locked@red inaktiv:secur_open@lightgreen
attr Alarm eventMap on:aktiv off:inaktiv
attr Alarm setList on off
attr Alarm webCmd aktiv:inaktiv
attr Alarm room Alarm
</pre>

=== Mit Notify ===
<pre>
gtag.*.presence:.* {Anwesenheit_check("$EVTPART1", "$NAME")}
</pre>

Code für die 99_myUtils.pm
<pre>
### GTAG ANWESENHEITS CHECK
sub Anwesenheit_check($$) {
my ($EVENT, $NAME) = @_;

# gtag_rot - Alias Marco
# gtag_schwarz - Alias Ulli
# gtag_gruen - Alias Frida
# gtag_orange - Alias Hannah

my $RESIDENT = "rr_"; # Alle GTAGs sind Standardmäßig Residents Roommate
# $RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur Gäste (Roomguest) Auskommentiert, da ich es so nicht brauche
my $ROOMMATE = ("$RESIDENT" . "$NAME"); # Residentsname zusammenbauen
my $ALIASNAME = AttrVal($ROOMMATE,'alias',$ROOMMATE); # ALIAS des Roommates auslesen

my $GTAG1 = Value('gtag_rot'); # ELTERN
my $GTAG2 = Value('gtag_schwarz'); # ELTERN

my $STATUS = "wahrscheinlich gerade los";
$STATUS = "anwesend" if ($EVENT eq "present"); # Status: anwesend
$STATUS = "unterwegs" if ($EVENT eq "absent"); # Status: unterwegs

Log 1, "$ALIASNAME ist $STATUS."; # LOG Eintrag erzeugen

if (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME ist da..."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME ist da...'"); # Pushover
}
elsif (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_rot" xor $NAME eq "gtag_schwarz")) {
fhem("set teleBot send ALARMIERUNG INAKTIV: $ALIASNAME ist da...; set Alarm inaktiv"); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG INAKTIV' '$ALIASNAME ist da...'; set Alarm inaktiv"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME hat das Haus verlassen.'"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "inaktiv") && ($GTAG1 eq "absent" && $GTAG2 eq "absent")) {
fhem("set Alarm aktiv; set teleBot send ALARMIERUNG AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Alarm aktiv; set Infopush msg 'ALARMIERUNG AKTIV' '$ALIASNAME hat das Haus verlassen.' '' 0 ''"); # Pushover
}
}
</pre>

<br>

=== Mit Notify und Integration des RESIDENTS-MODUL ===

Der hier beschriebene Code erweitert die Funktionen unter dem Punkt 5.93.
Das Notify muss daher mit der folgenden Zeile erweitert werden.

<pre>
define Alarm_AnwesenheitCheck notify gtag.*.presence:.* { Anwesenheit_check("$EVTPART1", "$NAME"), Anwesenheit_check_resi("$NAME") }
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die RESIDENTS Funktion nutzen zu können:
<pre>
### RESIDENTS
sub Anwesenheit_check_resi($) {
my ($NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME); # ALIASNAME des GTAGs auslesen

my $RESIDENT = "rr_"; # Als Standard sind alle GTAGs Roommates
$RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur GTAG Namen der Gäste (Roomguest)
my $ROOMMATE = ("$RESIDENT" . "$ALIASNAME"); # Residentsname zusammenbauen

if (ReadingsVal($NAME,'presence',$NAME) eq "absent") {
fhem("set $ROOMMATE absent"); # Resisents Status von Roommates setzen
}
elsif(ReadingsVal($NAME,'presence',$NAME) eq "present") {
fhem("set $ROOMMATE home"); # Resisents Status von Roommates setzen
}
}
</pre>
<br>

=== Mit Notify und Fenster/Tür. -Kontakt Überwachung ===

Erweiterung für die Überwachung von Fenster/Tür. -Kontakten. Dazu sind zwei weitere Notifys notwendig die auf die Trigger der Kontakte regagieren
und so eine weitere Funktion in der 99_myUtils.pm ansprechen. Die Notifys triggern auf Kontakte die mit dem Namen Kontakt* beginnen.
Sollten die eigenen Fenster/Tür. -Kontakt anderen Namen besitzen, müssen die Skripte dementsprechend angepasst werden.
<pre>
define Alarm_Kontaktmeldung notify Kontakt.*:contact:.* {Kontakt_Meldung("$EVTPART1", "$NAME")}
</pre>
<pre>
define Alarm_Sabotagealarm notify Kontakt.*.sabotageError:.on {Kontakt_Sabotage("$EVTPART1", "$NAME")}
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die TÜRKONTAKTE-Meldung nutzen zu können:
<pre>
### TÜRKONTAKTE-Meldung/Zustand
sub Kontakt_Meldung($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME wurde $EVENT";
if (ReadingsVal("Alarm", "state", "on") eq "on") {
fhem("set teleBot send $ALIASNAME wurde $EVENT"); # Nachricht über Telegram
# fhem("set Infopush msg '$ALIASNAME' '$ALIASNAME wurde $EVENT'"); # Nachricht über Pushover
}
}

### TÜRKONTAKTE-Sabotagealarm

sub Kontakt_Sabotage($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME meldet Sabotagealarm";
fhem("set teleBot send Alarm: $ALIASNAME meldet Sabotagealarm"); # Nachricht über Telegram
# fhem("set Infopush msg 'Alarmanlage' '$ALIASNAME meldet Sabotagealarm' '' 2 ' ' 60 600 "); # Nachricht über Pushover
}
</pre>
<br>

=== Hinweis zur Benutzung / Fehlerhandling ===

Der Alarm dummy hat den Zustand on:off. Die Bezeichnungen und Namen müssen 1:1 übernommen werden damit das Script funktioniert.
Andernfalls müssen die Bezeichnungen für z.B. absent:unterwegs und present:anwesend - angepasst werden.
Die Benachrichtigung kann aktuell per ''Telegram'' sowie ''Pushover'' ('''Achtung mit zweiterem sind Abokosten verbunden!''') realisiert werden.
Diskussion zum Thema im Forum unter: {{Link2Forum|Topic=64080}}
<br>

= Problemlösungen =
Falls es '''Probleme beim Starten des Skripts''' gibt bzw. man das Skript ohne Reboot des Systems neustarten möchte, kann man dies per kill Befehl erledigen.
<syntaxhighlight lang="bash">
ps -ef | grep lepresenced
sudo kill <pid>
</syntaxhighlight>

Debuglevel lepresenced setzen:
{{Randnotiz|RNText=Um Debug-Meldungen zu bekommen (Vorsicht bei SD-Karten-Systemen wie dem RPi) - Hierbei werden die Schreibzyklen auf die SD-Karte erhöht.}}

Der Log Level muss im lepresenced-Skript selbst verändert werden. Um den Log-Level auf INFO/WARNING/DEBUG zu setzen, dass Skript lepresenced mit einem Editor öffnen und die Stellen, wo LOG_WARNING zu finden sind durch den nötigen LOG-Eintrag ersetzen.

<pre>
lepresenced --loglevel LOG_DEBUG
</pre>
Nur das wichtigste Loggen:
<pre>
lepresenced --loglevel LOG_WARNING
</pre>
Keinerlei LOG-Einträge
<pre>
lepresenced --loglevel LOG_EMERG
</pre>

Bei '''Problemen mit der Batterieüberwachung''' der Tags kann die Pi Firmeware mit folgenden Befehl auf eine ältere Version zurückgesetzt werden.
Fehlermeldung beim Aufruf des lebattery oder anderen Batterietestskripten:
<pre>connect: Connection refused (111)</pre>

Lösung (vorübergehend)
<pre>
sudo rpi-update 8521fd34c8f66b6d109acce943f6e25ec93ec005
</pre>

Mehr dazu unter: {{Link2Forum|Topic=56960|Message=589165}}

'''Das BT-Device ist ständig "absent"'''<br>
Eine Mögliche Lösung kann sein, dass Paket bluez-hcidump zu installieren. Das Werkzeug hcidump erlaubt die Beobachtung von Bluetooth-Aktivität.
Dies ist nicht notwendig, wenn bereits bluez installiert ist, da dies Teil des bluez Paketes ist
<pre>
sudo apt-get install bluez-hcidump
</pre>

'''Fehler in Logdateien /var/log/syslog und /var/log/kernel'''
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634211] bt_err_ratelimited: 1 callbacks suppressed
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634231] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:12 raspberrypi kernel: [ 4906.647350] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.532081] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.655564] Bluetooth: hci0 advertising data length corrected

Die Ursache des Problems ist noch nicht ergründet, allerdings betrifft dies aktuell nur den RPi3. Die Fehlermeldungen werden in verschiedene log's geschrieben. Darunter maßgeblich "syslog" und "kern.log".

Lösung (vorübergehend)
Unterbinden der Einträge durch Anlage eines blocklist Eintrag:

1. Unter "/etc/rsyslog.d" eine Datei erzeugen mit dem Namen "01-blocklist.conf"
2. Inhalt: (Die Ausdrücke in den "" sind diejenigen, die aus dem log verschwinden sollen. - bei mir waren es die unten stehenden")
:msg,contains,"Bluetooth: hci0 advertising data length corrected" stop
:msg,contains,"bt_err_ratelimited:" stop
3. Dienst neu starten "sudo service rsyslog restart"

Weiter Infos werden im offiziellen Thema {{Link2Forum|Topic=28753|Message=499184|LinkText=hier}} diskutiert.

Seit Version 0.82 kann es beim Start zu folgenden Meldungen im Log kommen.
Sep 06 16:13:45 raspberrypi systemd[1]: Started lepresenced.
Sep 06 16:13:45 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: Received 'Set scan parameters failed: Input/output error', ...tting...
Sep 06 16:13:46 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: hcitool exited, retrying...

Diese Meldungen können ignoriert werden. Abhilfe schafft sich lepresenced selbst indem es sich resettet.

'''Moderne iPhones und Android Geräte wechseln zum "deep standby" Modus''', und werden dann als "abwesend" gemeldet.
Mittels einer Funktion, die via hping3 Packete an den Geräte senden, um die "wach" zu halten, und dann die MacAdresse ausliest, kann man dieses Problem umgehen. Mehr im Forum [https://forum.fhem.de/index.php/topic,76342.0.html]

= Versionsänderungen lepresenced =
<pre>
--Version 0.81 (BasisVersion)
--Version 0.82 (stable 08/2017)
-Neue Kommandozeilenoption "--debug": Startet lepresenced im Vordergrund und gibt ausführliche Debug-Informationen auf STDOUT aus.
-Sanity Check: lepresenced prüft beim Starten die Verfügbarkeit von hciconfig, hcitool und hcidump.
-Model: lepresenced übermittelt das Reading model nun als lan-lepresenced. Das erlaubt die Erkennung von lepresenced in der FHEM-Statistik (sofern aktiviert).
--Version 0.83 (stable 09/2017)
- Behebung von Systemstart Fehlern
- Weitere Debug-Möglichkeiten. U. a. wird nun mitgezählt, ob hcitool lescan ("legacy") und hcidump eine identische Zahl an Beacons empfangen
</pre>

= Ansprechpartner =
# {{Link2FU|117|markusbloch }} (Markus) für das PRESENCE-Modul und collectord
# {{Link2FU|5068|PatrikR}} (Patrick) für lepresenced
# [[Benutzer Diskussion:Devender|Devender]] ({{Link2FU|20043|Dirk}}) für Wiki und Doku

PRESENCE

2018-06-29T12:50:31Z

50watt: /* BT Dongle am PI installieren */ Tippfehler in der Überschrift korrigiert

{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h

|ModTechName=73_PRESENCE.pm
|ModOwner=markusbloch
}}

Das [[PRESENCE]] Modul bietet für die Anwesenheitserkennung mehrere Varianten an:

* '''lan-ping''' - Das Überwachen via PING Checks, die durch den FHEM Server versandt werden.
* '''fritzbox''' - Das Überwachen von Geräten auf einer FritzBox via ctlmgr_ctl (Nur auf einer FritzBox möglich)
* ''' Bluetooth'''
:- '''local-bluetooth''' - Das Überwachen via Bluetooth Checks, die vom FHEM Server direkt durchgeführt werden (angeschlossener Bluetooth-Stick und die Software bluez voraussgesetzt)
:- '''lan-bluetooth''' - Das Überwachen von Bluetoothgeräten, über Netzwerk. Auf einer oder mehreren Maschinen im Netzwerk (z.B. [[:Kategorie:Raspberry Pi|Raspberry Pi]]) läuft ein Presence-Daemon, der nach Bluetooth-Geräten sucht. Um mehrere Presence-Daemon mit FHEM zu verbinden, gibt es den Collector-Daemon, der sich zu allen Presence-Damons im Netzwerk verbindet und das Ergebnis von allen zusammenfasst.
* '''function''' - Das Überwachen mithilfe einer selbst geschrieben Perl-Funktion, die den Anwesenheitsstatus zurückgibt (0 oder 1)
* '''shell-script''' - Das Überwachen mithilfe eines selbst geschriebenen Shell-Programms/Skript, das eine 0 oder 1 ausgibt, um den Anwesenheitsstatus mitzuteilen.

= Überwachen mittels Ping im WLAN/LAN =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Um ein Gerät via Ping zu überwachen, muss folgende Definition durchgeführt werden:
:<code>define Handy PRESENCE lan-ping 192.168.0.30</code>

Dadurch wird die IP-Addresse 192.168.0.30 alle 30 Sekunden geprüft, ob sie erreichbar ist. Wenn sie erreichbar ist, ist der Status "present" (anwesend), ansonsten "absent" (abwesend).

Der Timeout kann verändert werden, indem ein Wert (in Sekunden) an das Define anhängt wird:
:<code>define Handy PRESENCE lan-ping 192.168.0.30 '''60'''</code>

Nun würde das Handy alle 60 Sekunden geprüft werden.

Nur wenn bei einem iPhone/iPad die Funktion "über WLAN synchronisieren" aktiviert ist, ist es auch im Standby zuverlässig pingbar. Standardmäßig deaktivieren Apple-Geräte ihr WLAN im Standby-Betrieb um die Akkulaufzeit zu verlängern.

Sollte die Fehlermeldung
:<code> PRESENCE (Handy) - ping command returned with output: ping: icmp open socket: Operation not permitted </code>
im Log auftauchen und lan-ping dadurch nicht funktionieren, liegt ein Berechtigungsproblem vor. Kein Grund den User fhem zu root zu machen!
Prüfe zu erst als User root ob die Capabilities gesetzt sind.
:<code>getcap /bin/ping</code>
Sollte folgendes Ergeben zu Tage fördern.
:<code>/bin/ping = cap_net_raw+ep</code>
Ist dem nicht so, setzen wir die benötigten Capabilities
:<code>setcap cap_net_raw+ep /bin/ping</code>
Mehr Informationen zum Thema Capabilities [https://manpages.debian.org/jessie/manpages-de/capabilities.7.de.html].

= FritzBox: direktes Abfragen der Aktivität via ctlmgr_ctl =
{{Randnotiz|RNText=Um diese Methode auf einer FritzBox nutzen zu können, muss FHEM mit root-Rechten laufen. Dies ist standardmäßig nicht der Fall. Bitte dazu den Wiki Artikel [[FritzBox: fhem unter root starten]] beachten.}}
Eine sehr häufige und auch zuverlässige Methode ist auf einer FritzBox die Abfrage mittels ctlmgr_ctl Befehl. Über diesen lassen sich alle Geräte abfragen ob sie aktiv sind. Ist ein Gerät aktiv, so gilt es als anwesend.

Dieser Modus kann allerdings nur in FHEM Installationen direkt auf einer FritzBox verwendet werden. Des weiteren muss FHEM unter dem User root laufen. Um ein Gerät zu überwachen, wird lediglich der Gerätename benötigt, so wie er unter dem Menüpunkt "Heimnetz" auftaucht.

Die erforderliche Definition:
:<code>define Handy PRESENCE fritzbox iPhone-4S</code>

= Überwachung mittels Perl-Code =
Es ist möglich zum Überwachen von Geräten eine eigene Perl-Funktion zu verwenden die dann vom PRESENCE Modul im Hintergrund aufgerufen wird.

define <name> PRESENCE function {...} [ <check-interval> [ <present-check-interval> ] ]

Sobald die Funktion den Rückgabewert 1 hat, ist das Gerät anwesend, bei 0 abwesend.

== Beispiel DHCP Überwachung auf Airport Basestation ==
Die hier vorgestellte Überwachung der DHCP Lease auf Airport Basestations per SNMP ist absolut robust gegenüber dem Ruhezustand von iOS und setzt keine weitere Konfiguration auf dem iPhone voraus. Das Abmelden beim Verlassen des Empfangsbereiches der Basestation geschieht mit etwa 5-10 Minuten Verzögerung und ist somit auch vor kurzzeitigen Empfangsproblemen sicher. Das nebenstehende Bild (???) verdeutlicht noch mal die Unterschiede zwischen einer IP-Basierten Ping-Überwachung und der Überwachung auf Ebene der Basestation oder FritzBox.

Bevor der folgende Code verwendet werden kann ist das Perl Modul Net:SNMP zu installieren (z. B. mit: <code>cpan install use Net::SNMP</code>).

Zuerst ist folgender Code in 99_myUtils.pm einzufügen, sollte diese noch nicht vorhanden sein muss diese aus dem Template welches unter Edit Files zu finden ist erzeugt werden.
'''Achtung, das ist nicht der komplette Inhalt der 99_myUtils!''' Das ist nur die einzelne Routine

<pre>
use Net::SNMP;
sub
snmpCheck($$)
{
my ($airport,$client)= @_;

my $community = "public";
my $host = $airport;
my $oid = ".1.3.6.1.2.1.3.1.1.2";
#my $oid = ".1.3.6.1.2.1.3.1.1.2.25.1.10.0.1";

my ( $session, $error ) = Net::SNMP->session(
-hostname => $host,
-community => $community,
-port => 161,
-version => 1
);

if( !defined($session) ) {
return 0;
return "Can't connect to host $host.";
}

my @snmpoids = ();

my $response = $session->get_next_request($oid);
my @nextid = keys %$response;
while ( @nextid && $nextid[0] && $nextid[0] =~ m/^$oid/ ) {
push( @snmpoids, $nextid[0] );

$response = $session->get_next_request( $nextid[0] );
@nextid = keys %$response;
}

if( !defined($response = $session->get_request( @snmpoids ) ) ) {
return 0;
}

foreach my $value (values %$response) {
return 1 if( $value eq $client )
}

return 0;
}
</pre>

Danach lässt sich das Mobilgerät so überwachen:
:<code>define iPhone PRESENCE function {snmpCheck("10.0.1.1","0x44d77429f35c")} 30 30</code>

wobei 10.0.1.1 durch die IP-Adresse der Basestation und 0x44d77429f35c durch die MAC Adresse des Geräts als HEX-Zahl ersetzt werden muss.

== Beispiel Anwesenheitserkennung mittels UniFi Controller ==

Die Anwesenheitserkennung bei Geräten in Verbindung mit UniFi-Produkten funktioniert selbst dann, wenn sich die Geräte im PowerSave-Modus befinden.

Beachte: Die Geräte werden erst ungefähr nach 5 Minuten, nachdem das Gerät das WLAN verlassen hat als disconnected angezeigt.

<code>define <NAME> PRESENCE function {ReadingsVal("<UniFi>","<NamedDevice>","") eq "connected" ? 1:0}</code>

= Überwachen mittels Events =
Der Vorteil gegenüber der Function-Variante ist, dass diese Variante ohne Blocking.pm-Overhead direkt ausgeführt werden kann und in "Echtzeit" abläuft (siehe {{Link2Forum|Topic=40287|Message=562823}}).

<code>define <NAME> PRESENCE event UniFi:NamedDevice:.disconnected UniFi:NamedDevice:.connected</code>

= Überwachen mittels Bluetooth =
== Vorbereitung und Informationen ==
=== Getestete Hardware/Software ===
* '''Raspbian System''' - wheezy, Jessie (interner BT-Controller)
* '''BT-Dongle''' - CSL NET BT USB2.0 Stick, Bluetooth V4.0, Nano <br />'''Achtung''': Es muss ein BT V4.0 oder höher verwendet werden. Nur dieser unterstützt ''LowEnergy''
* '''BT-TAG''' - Gtag von Gigaset, TrackR, UDOO Neo, PebbleBee, iTag von Unitec, X4-LIFE Multifunkti BL-Anhänger, iTag Wireless Anti, Trackr bravo

=== BT Dongle am PI installieren ===
Um den BT Dongle ''(hier: CSL NET BT USB2.0)'' am RaspberryPI verwenden zu können, müssen die notwendigen Pakete über die Paketverwaltung von debian nachinstalliert werden.
Wer bereits ein BT-Dongle installiert hat, kann diesen Schritt überspringen.
<pre>
apt-get install bluetooth
</pre>
Nach erfolgreicher Installation der Pakete sollte der RaspberryPI neu gestartet werden.
<pre>
sudo reboot
</pre>

Nach dem erfolgten Reboot bitte das Log des RaspberryPI auf folgende Einträge prüfen:
<pre>
Feb 12 19:52:55 fhem kernel: [ 4.773600] Bluetooth: Core ver 2.20
Feb 12 19:52:55 fhem kernel: [ 4.773748] NET: Registered protocol family 31
Feb 12 19:52:55 fhem kernel: [ 4.773765] Bluetooth: HCI device and connection manager initialized
Feb 12 19:52:55 fhem kernel: [ 4.773797] Bluetooth: HCI socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773821] Bluetooth: L2CAP socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.773890] Bluetooth: SCO socket layer initialized
Feb 12 19:52:55 fhem kernel: [ 4.797531] usbcore: registered new interface driver btusb
</pre>
Sobald der BT-Dongle erkannt wurde ''leuchtet'' (wenn vorhanden) auch die ''blaue/gelbe'' LED am Dongle auf.

=== BT-Tags aktivieren ===
Jetzt kann der BT-Tag aktiviert werden. Bei einigen Tags muss dafür die '''Batteriesicherung''' gezogen werden.

Einen Tag wird mit folgendem Befehl auf der Konsole gesucht:
<syntaxhighlight lang="bash">
sudo hcitool lescan

Ausgabe z.B.:
LE Scan ...
7C:2F:80:A1:XA:XD (unknown)
7C:2F:80:A1:XA:XD Gigaset G-tag
7C:2F:80:A1:X4:X1 (unknown)</syntaxhighlight>
Eine Übersicht über die möglichen Befehle von hcitool gibt es mit der Eingabe von:
<pre>
sudo hcitool

Ausgabe z.B.:
hcitool - HCI Tool ver 5.23
Usage:
hcitool [options] <command> [command parameters]
Options:
--help Display help
-i dev HCI device
Commands:
dev Display local devices
inq Inquire remote devices
scan Scan for remote devices
name Get name from remote device
info Get information from remote device
spinq Start periodic inquiry
epinq Exit periodic inquiry
cmd Submit arbitrary HCI commands
con Display active connections
cc Create connection to remote device
dc Disconnect from remote device
sr Switch master/slave role
cpt Change connection packet type
rssi Display connection RSSI
lq Display link quality
tpl Display transmit power level
afh Display AFH channel map
lp Set/display link policy settings
lst Set/display link supervision timeout
auth Request authentication
enc Set connection encryption
key Change connection link key
clkoff Read clock offset
clock Read local or remote clock
lescan Start LE scan
lewladd Add device to LE White List
lewlrm Remove device from LE White List
lewlsz Read size of LE White List
lewlclr Clear LE White list
lecc Create a LE Connection
ledc Disconnect a LE Connection
lecup LE Connection Update
</pre>

Falls beim SCAN kein Tag gefunden wird, sollte das BT Interface neu gestartet werden. Dazu ist kein Reboot des PI notwendig.
<syntaxhighlight lang="bash">
sudo hciconfig hci0 down
sudo hciconfig hci0 up
sudo hcitool dev
</syntaxhighlight>

== Überwachung durch den FHEM Server direkt ==
[[Datei:Bluetooth-Adresse-iPhone.png|thumb|Bluetooth-Adresse eines iPhones]]
Jenach Aufstellungsort des FHEM Servers kann es sinnvoll sein, eine Bluetooth-Überwachung direkt durch den FHEM Server durchzuführen. Hierbei gilt allerdings zu beachten, dass Bluetooth nicht für große Reichweiten gedacht ist und in den meisten Fällen keine Wände überwinden kann. Das heisst, dass in den meisten Fällen damit nur ein Raum überwacht werden kann.

Je nach Einsatzzweck kann das auch so gewollt sein. Bluetooth USB Sticks, die bereits Bluetooth 4.0 unterstützen, können höhere Reichweiten über Zimmerwände hinaus erreichen. Vorausgesetzt, das Mobilgerät unterstützt Bluetooth 4.0.

Um eine Überwachung per Bluetooth durchführen zu können, benötigt man die Bluetooth-Adresse eines Gerätes. Diese ähnelt vom Aufbau einer MAC-Adresse. Generell wird die Adresse in den Telefon-Informationen bei Smartphones angezeigt.

Um eine Anwesenheitserkennung via Bluetooth durchzuführen, wird folgende Definition in der [[Konfiguration]] benötigt:
:<code>define Handy PRESENCE local-bluetooth XX:XX:XX:XX:XX:XX</code>

== Überwachung durch verteilte Agenten in der Wohnung (presenced/lepresenced/collectord) ==
[[Datei:Raspberry-Pi-mit-WLAN-und-Bluetooth-Stick.jpg|thumb|left|Raspberry Pi mit Bluetooth- und WLAN-USB-Stick]]
Um eine zuverlässige und flächendeckende Bluetooth-Anwesenheitserkennung durchzuführen, ist es unerlässlich, mehrere Bluetooth-Empfänger zu verwenden, die auf mehrere oder alle Räume verteilt sind.

Hierfür bietet sich zum Beispiel ein [[Raspberry Pi]] mit einem Mini-Bluetooth-USB-Stick und evtl. einem WLAN-USB-Stick an. Jeder Raum wird mit solch einem Raspberry ausgestattet und ist im WLAN Netz verfügbar.

Dieses Netz aus Raspberrys wird mit dem presenced / lepresenced Programm ausgestattet. Beide Programme sind Perl-Skripte, die als Daemon im Hintergrund laufen und auf Anfragen via Netzwerk warten. Es wird lediglich eine vollständige Perl-Grundinstallation mit Standardmodulen benötigt.

=== Unterschied presenced / lepresenced / collectord ===
presenced und lepresenced sind Programme, welche in regelmäßigen Abständen nach Bluetooth-Geräten suchen. Sobald ein Gerät, welches vorab definiert wurde, gefunden wird, wechselt der Status des Geräts in FHEM auf Anwesend. Der Unterschied zwischen presenced und lepresenced ist, dass lepresenced insbesondere für [https://de.wikipedia.org/wiki/Bluetooth_Low_Energy Bluetooth-LE-Devices] ist und presenced für "normale" Bluetooth-Geräte.

collectord wiederum ist ein Programm, welches mehrere Pis verbindet und auf allen den aktuellen Status von presenced/lepresenced abfragt. Ist das gesuchte Bluetooth-Gerät auf einem der Pi anwesend, so wird es auch in der definierten Hauptinstanz auf anwesend gesetzt. Zusätzlich wird der Pi auf dem das Gerät gefunden wurde als Reading angegeben. Sofern alle Räume einen Empfangspegel (RSSI) ermitteln können, wird bei mehreren anwesenden Räumen der Raum mit dem besten Empfangspegel selektiert (siehe {{Link2Forum|Topic=54482}}).

=== Installation von (le)presenced ===
Diese Anleitung ist sowohl für presenced, als auch für lepresenced gültig. Einfachheitshalber wird nur lepresenced erwähnt, sämtliche Schritte gehen jedoch auch mit presenced, wobei einfach die genannten Daten durch presenced ersetzt werden müssen.

Die Software lepresenced kann aktuell über drei Varianten installiert werden. Dabei ist die bevorzugte Variante (Variante 1) die Installation über das bereitgestellte .deb-Paket.
Die Variante 2 setzt voraus, dass im FHEM contrib Verzeichnis (/opt/fhem/contrib) die aktuelle Version des .deb-Pakets liegt. Die Variante 3 ist dafür gedacht, wenn man keine .deb-Pakete installieren kann/will oder es aus anderen Gründen nicht funktioniert. Es wird davon abgeraten die Variante 3 zu verwenden. Vollständigkeitshalber wird sie aber aufgeführt.

===== Installation per .deb-Paket =====

Die bevorzugte Variante ist die Installation von lepresenced durch die passenden .deb Pakete.
{{Randnotiz|RNText=Bei einem Upgrade einer älteren Version reicht es, das neue .deb Paket mit
:<code>sudo dpkg -i lepresenced-X.XX-X.deb</code>
zu aktualisieren}}

'''1.Variante:'''
Herunterladen der aktuellen lepresenced-0.83-3.deb (Stand August 2017) Datei über den Webbrowser
[https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/ SVN-Repository]. Im SVN die passende Datei auswählen und in der folgende Webseite den Link unter:
<pre>
Download in other formats:
Original Format
</pre>
anklicken und die Datei herunterladen.
Die Datei kann jetzt auf den RPi kopiert und mit folgenden Befehlen ausgeführt werden (ggf. Berechtigungen anpassen).

Alternativ per wget Befehl direkt auf den RPi (aktuelle Versionsnummer beachten)
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/lepresenced-0.83-3.deb

'''2.Variante:''' (zu Verwenden, wenn es Probleme bei Variante 1 gibt)
Herunterladen aus dem fhem contrib Verzeichnis:
Hierzu muss das contrib auf dem aktuellen Stand sein. Dazu wird die Installation von subversion (normal bereits vorhanden) benötigt.

sudo apt-get install subversion

Danach kann per
sudo svn checkout https://svn.fhem.de/fhem/trunk/fhem/contrib svnrepo

Das aktuelle Repository auf den Pi heruntergeladen werden. Danach sollte im gewählten Verzeichnis die eingecheckten Dateien verfügbar sein.
/opt/fhem/svnrepo/PRESENCE/deb

''' Installation der Variante 1 oder 2 '''

Egal welche Variante gewählt wurde, nun kann mit folgenden Befehlen das Paket installiert werden. Bitte Pfade ggf. anpassen.

'''Wichtig''': Das '''Paket''' hat eine ca. Größe von '''6,5Kb'''. Ab und an gibt es wohl Probleme mit der Installation, wodurch die Datei 11,5kb groß wird.
Diese Datei lässt sich nicht Installieren. In diesem Fall das Paket bitte mit der Variante 1 und dem Bereich "Download in other formats" herunterladen.

sudo dpkg -i lepresenced-0.83-3.deb

sudo apt-get -f install

Die Ausgabe der Installation sollte am Ende ein [ ok ] Starting lepresenced (via systemctl): lepresenced.service. ausgeben.

<pre>
Paketlisten werden gelesen... Fertig
Abhängigkeitsbaum wird aufgebaut.
Statusinformationen werden eingelesen.... Fertig
Abhängigkeiten werden korrigiert ... Fertig
Die folgenden zusätzlichen Pakete werden installiert:
bluez-hcidump
Die folgenden NEUEN Pakete werden installiert:
bluez-hcidump
0 aktualisiert, 1 neu installiert, 0 zu entfernen und 0 nicht aktualisiert.
1 nicht vollständig installiert oder entfernt.
Es müssen 157 kB an Archiven heruntergeladen werden.
Nach dieser Operation werden 490 kB Plattenplatz zusätzlich benutzt.
Möchten Sie fortfahren? [J/n]
Holen: 1 http://archive.raspberrypi.org/debian/ jessie/main bluez-hcidump armhf 5.23-2+rpi2 [157 kB]
Es wurden 157 kB in 0 s geholt (921 kB/s).
Vormals nicht ausgewähltes Paket bluez-hcidump wird gewählt.
(Lese Datenbank ... 42033 Dateien und Verzeichnisse sind derzeit installiert.)
Vorbereitung zum Entpacken von .../bluez-hcidump_5.23-2+rpi2_armhf.deb ...
Entpacken von bluez-hcidump (5.23-2+rpi2) ...
Trigger für man-db (2.7.0.2-5) werden verarbeitet ...
bluez-hcidump (5.23-2+rpi2) wird eingerichtet ...
lepresenced (0.82-1) wird eingerichtet ...
[ ok ] Starting lepresenced (via systemctl): lepresenced.service.
</pre>

'''3.Variante:'''

Bei dieser Variante wird das aktuellste lepresenced Skript aus github heruntergeladen. Das bedeutet, dass jegliche Konfiguration wie automatischer Start, Berechtigungen etc.
manuell konfiguriert werden muss. Diese Variante eignet sich nur für diejenigen, die keine .deb-Pakete installieren wollen/können oder die genau Wissen, was sie tun!
<pre>
https://github.com/mhop/fhem-mirror/blob/master/fhem/contrib/PRESENCE/lepresenced
</pre>

Zur "Installation" des Skripts folgendermaßen vorgehen:
Unter /fhem manuell den Ordner „script“ anlegen:
<pre>
mkdir script
</pre>
Datei lepresenced reinkopieren und ausführbar machen:
<pre>
sudo chmod +x /opt/fhem/script/lepresenced
sudo chgrp -cR dialout lepresenced
</pre>
Skript erstmalig starten:
<pre>
sudo ./lepresenced --loglevel LOG_EMERG -d
</pre>
Kommt beim Starten des Skript eine Fehlermeldung, müssen die Abhängigkeiten aufgelöst werden.
<pre>
Can't locate Net/Server/Daemonize.pm in @INC (@INC contains: /etc/perl /usr/local/lib/perl/5.14.2 /usr/local/share/perl/5.14.2 /usr/lib/perl5 /usr/share/perl5 / usr/lib/perl/5.14 /usr/share/perl/5.14 /usr/local/lib/site_perl .) at /opt/fhem/lepresenced line 17.
BEGIN failed--compilation aborted at /opt/fhem/lepresenced line 17.
</pre>
Um die Abhängigkeiten aufzulösen muss folgendes nachinstalliert werden und anschließend ein Reboot durchgeführt werden.
<pre>
sudo apt-get install libnet-server-*
</pre>

===== Einrichtung eines Bluetooth-Geräts über FHEM =====

Nach dem letzten Schritt sind alle Bedingungen für eine abschließende Konfiguration eines BT-Geräts in FHEM abgeschlossen worden.
Jetzt kann der zum Beispiel ein G-Tag dem FHEM-Server bekannt gemacht werden:
<pre>
-- Name Modul Modus MAC vom Gtag IP vom PI Port Abfragezeit in Sekunden
define MeinGtAG PRESENCE lan-bluetooth xx:xx:xx:xx:xx:xx 127.0.0.1:5333 120
</pre>

'''Wichtig ist den angegeben Port zu unterscheiden. Für presenced muss der Port 5111 genommen werden, für lepresenced der Port 5333.'''
Den absent und present Mode kann man einfach testen, in dem man den Gtag mit Alufolie einwickelt.

Diese Variante sollte eingesetzt werden, wenn nur ein Pi nach Bluetooth-Geräten sucht. Möchte man mehr als ein Gerät nutzen um zum Beispiel eine größere Fläche abzudecken so muss mit collectored gearbeitet werden.

=== Alle Räume gemeinsam ansprechen mittels collectord ===
Um zwei presenced- oder lepresenced Installationen zu verbinden wird der collectord Daemon von Markus Bloch benötigt. Dieser kennt alle presenced-Installationen im Netzwerk und führt eine koordinierte Suche nach den gewünschten Geräten durch. Sobald ein Gerät in einem Raum erkannt wurde, meldet der collectord den Status einschließlich der Angabe des Raumes, in dem das Gerät erkannt wurde.

[[Datei:Presence_Collectord_Uebersicht.jpg|200px|thumb|left|Schematische Darstellung Presence und Collectord, Danke an dtavb]]
Auf Basis folgender Skizze wird die Einrichtung und der Betrieb der Anwesenheitserkennung und Überwachung <p></p>
mit dem PRESENCE-Modul sowie dem Skript (.deb-Paket) lepresenced beschrieben. Zusätzlich wird für die Verbindung <p></p>
mehrere lepresenced Instanzen der collectord verwendet.<p></p>
Diese Skizze dient als Basis für alle genannten Konfigurationen innerhalb dieses Artikels.
{{NeuerTextBlock}}

==== Aufbau ====
; RPi1 (Hauptinstanz):
: FHEM Installation
: presence/lepresenced Installation
: collectord installation
: Sämtliche Bluetooth-Geräte in FHEM definiert
; RPi2 (Zweitsystem):
: FHEM installation
: presence/lepresenced Installation
: Sämtliche Bluetooth-Geräte in FHEM definiert

==== Installation per .deb-Paket ====
collectord wird heruntergeladen und installiert:
https://svn.fhem.de/trac/export/HEAD/trunk/fhem/contrib/PRESENCE/deb/collectord-1.8.deb (Stand Januar 2018)
<pre>
sudo dpkg -i collectord-1.8.deb
</pre>

Nach der Installation befindet sich im Verzeichnis: /etc/collectord.conf die Konfigurationsdatei für das collectord. Weitere Einstellungen können unter /etc/default/collectord vorgenommen werden.

==== Konfiguration auf Shellebene ====
<pre>
sudo vi /etc/collectord.conf
</pre>

Diese Datei muss jetzt nach folgender Vorlage angepasst werden.
<pre>
# room definition
#[room-name] # name of the room
#address=192.168.0.10 # ip-address or hostname
#port=5111 # tcp port which should be used (5111 is default)
#presence_timeout=120 # timeout in seconds for each check when devices are present
#absence_timeout=20 # timeout in secondsfor each check when devices are absent

[RPi1] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=127.0.0.1 # Lokale Adresse RPi1 , da hier das Collectord später laufen soll!
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaelte Pruefintervalle
absence_timeout=60 # Selbstgewaelte Pruefintervalle

[RPi2] # Name (wird als Reading room bei den BT-Tags angezeigt) der presence Instanze
address=192.168.178.127 # IP-Adresse der Instanz, wo nur das Presence laueft, also RPi2
port=5333 # Port der Presence Installation
presence_timeout=60 # Selbstgewaelte Pruefintervalle
absence_timeout=60 # Selbstgewaelte Pruefintervalle
</pre>

Hinweis:
* Es dürfen keine [Namen] mit Leerzeichen verwendet werden
* Der angegebene Port richtet sich danach, ob auf dem Pi presenced (Port 5111) oder lepresenced (Port 5333) nach dem Bluetooth-Gerät sucht

==== Konfiguration in FHEM ====
;RPi1
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 127.0.0.1:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222)''
;RPi2
define Gtag PRESENCE lan-bluetooth XX:XX:XX:XX:XX:XX 192.168.178.127:5222 60 ''Hinweis: (Der Port ist der, des collectord!! Standard 5222 - die IP-Adresse von die von RPi1)''

Nach der Konfiguration kann der Daemon gestartet werden.
Sobald das Bluetoothgerät irgendwo in der Wohnung erkannt wurde, meldet der Collectord dies sofort
an FHEM und teilt den Raum mit in dem es erkannt worden ist. Diese Information wird im Reading "rooms" des jeweiligen BT-Gerätes dargestellt.

Zum testen sollte collectord einmalig manuell gestartet werden. Dies hat den Vorteil, dass man nochmal den Port des collectord prüfen kann, dieser steht in der Zeile <pre>created socket on 0.0.0.0 with port 5222</pre> und man sehen kann, ob der collectord richtig startet, oder Fehler auswirft. Gestartet wird mit folgendem Kommando:
<pre>
sudo collectord -vv -c /etc/collectord.conf
</pre>
Die Ausgabe sieht wie folgt aus:
<pre>
2017-04-02 17:52:55 - =================================================
2017-04-02 17:52:55 - started with PID 15554
2017-04-02 17:52:55 - reading configuration file
2017-04-02 17:52:55 - no config errors found
2017-04-02 17:52:56 - created socket on 0.0.0.0 with port 5222
2017-04-02 17:53:20 - new connection from 127.0.0.1:48656
2017-04-02 17:53:20 - created thread 1 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - created thread 2 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 127.0.0.1 (UUID: d0beb79dd4771532eb5e207c7bf31788)
2017-04-02 17:53:20 - new connection from 127.0.0.1:48662
2017-04-02 17:53:20 - new connection from 127.0.0.1:48664
2017-04-02 17:53:20 - created thread 3 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 4 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 127.0.0.1 (UUID: 7495a112063d5db45e6335d3fe305e36)
2017-04-02 17:53:20 - created thread 5 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:20 - created thread 6 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 127.0.0.1 (UUID: c228f8d4d33b06787f995c7903c02760)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51638
2017-04-02 17:53:22 - created thread 7 for processing device 7C:2F:80:E1:14:31 in room RPi2 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - created thread 8 for processing device 7C:2F:80:E1:14:31 in room RPi1 for peer 192.168.xxx.xxx (UUID: 5db7012e709d6dc2fcd8159fc0344e40)
2017-04-02 17:53:22 - new connection from 192.168.xxx.xxx:51640
2017-04-02 17:53:22 - created thread 9 for processing device 7C:2F:80:ED:BC:F7 in room RPi2 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:23 - created thread 10 for processing device 7C:2F:80:ED:BC:F7 in room RPi1 for peer 192.168.xxx.xxx (UUID: c4b4d7c654132cf88e8c1fec3a956d3d)
2017-04-02 17:53:29 - new connection from 192.168.xxx.xxx:51642
2017-04-02 17:53:29 - created thread 11 for processing device 7C:2F:80:E1:2A:4D in room RPi2 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
2017-04-02 17:53:29 - created thread 12 for processing device 7C:2F:80:E1:2A:4D in room RPi1 for peer 192.168.xxx.xxx (UUID: ecd7081e5ae3a0d8e735c8750cb116a1)
</pre>

Wenn das Log wie oben abgebildet aussieht wurde alles richtig gemacht und unter dem Device in FHEM erscheint ein neues Reading "rooms" mit dem Wert der erkannten PRESENCE-Installation.

'''Verhalten presence timeout im zusammenhang mit dem Attribut "absenceThreshold" der PRESENCE Konfiguration in FHEM'''
<br>
In der collectord.conf sind <code>presence_timeout</code> und <code>absence_timeout</code> für den jeweiligen Raum konfiguriert.
Das bedeutet, sobald irgendein Gerät in diesem jeweiligen Raum anwesend/abwesend ist, wird das jeweilige Timeout an den verbundenen presenced/lepresenced geschickt um damit das Check-Interval entsprechend zu ändern.

In der PRESENCE-Definition kann man ebenfalls ein <code>absence_timeout</code>/<code>presence_timeout</code> setzen. Sobald sich der Zustand ändert, wird auch das jeweilige Timeout an den collectord gesandt. Dies hat aber auf die Checks in den jeweiligen Räumen und damit der collectord.conf keinen Einfluss. Der collectord schickt ein Statusupdate an PRESENCE nur, wenn das vorgegebene Timeout (von PRESENCE) erreicht ist und keine Statusänderung stattfand. Sobald eine Änderung des Status erfolgt wird natürlich sofort der Status an PRESENCE geschickt.

Das Attribut absenceThreshold/presenceThreshold funktioniert nachwievor. Hier ist nur wichtig wie man die Timeouts sowohl in PRESENCE als auch collectord.conf setzt.

'''Das Reading "room" bei einer PRESENCE Definition und der Zusammenhang zu collectord'''
<br>
Wenn ein BT LE Empfänger in mehr als einem Raum detektiert wird, führt der collectord (ab Version 1.8) eine RSSI-Erkennung durch. Sofern alle Räume den Empfangspegel (RSSI) ermitteln können, wird der Raum mit dem besten Empfangspegel als Raum für das "room"-Reading ausgewählt. Der lepresenced in aktueller Version von PatrickR gibt immer den Empfangspegel aus.

==== Automatischer Start ====
Wenn der collectord per .deb Paket installiert wurde, startet er automatisch bei einem Reboot mit (via systemd/init-Skript).
<br>

Der Collectord wird standardmäßig mit dem Port 5222 gestartet. Um diese anzupassen sind zwei Schritte notwendig:<br>
'''1.)''' Anpassen der /usr/bin/collectord
Hier bitte den Parameter my $opt_p von 5222 auf 5XXX abändern.

Da der collectord mittlerweile per systemd beim reboot des RPi gestarte wird muss auch diese Konfiguration auf den neuen Port angepasst werden.<br>
'''2.)''' Anpassen der /etc/default/collectord
<pre>
# collectord startup defaults:
# The TCP port collectord will listen for incoming connections (default: 5222)
PORT=5111
# The location of the configuration file (default: /etc/collectord.conf
CFGFILE=/etc/collectord.conf
</pre>

Manuell starten als Daemon (Parameter <code>-d</code>) mit:
<pre>
sudo collectord -c /etc/collectord.conf -d -v -l /var/log/collectord.log
</pre>

== Batterieüberwachung ==

=== Batterieüberwachung mit dem Modul BleTagBattery ===
{{Infobox Modul
|ModPurpose=Anwesenheitserkennung
|ModType=h

|ModTechName=74_BleTagBattery
|ModOwner=mumpitzstuff
}}
Mit dem Modul BleTagBattery - können die Batteriestati aller BT-LE Devices gelesen werden.
Es wird das batteryLevel und battery angelegt welches als BT-LE Tags an einer PRESENCE-Installation registriert wurden.

Vorraussetzung und Installation:

Bluez und Gattool
sudo apt-get install bluez

Das Gattool ist in den Installationen von Bluez inbegriffen.

Hinzufügen des githup für das Modul
update add http://raw.githubusercontent.com/mumpitzstuff/fhem-BleTagBattery/master/controls_bletagbattery.txt
update all
restart fhem: shutdown restart
BT-LE tags muss an einer PRESENCE-Installation des type "lan-bluetooth" registriert sein.

Nach dem Neustart von FHEM kann das Modul definiert werden:
define a new device: define <name of device> BleTagBattery

Das Modul versucht in der Standardkonfiguration alle 6 Stunden die BT-LE Devices zu erreichen und das Reading batteryLevel und battery zu aktualisieren.
Das Update kann auch manuell mit dem folgenden Befehl erzwungen werden

set <name of device> statusRequest.

Weiter Informationen und Disskussionen können dem eigentlichen [https://forum.fhem.de/index.php?topic=68104.0 Forumsbeitrag] entnommen werden,

=== Batterieüberwachung (aktuell nur G-Tags) ===

Leider überträgt der G-Tag nach der Einrichtung als Device in FHEM kein Reading mit seinem aktuellen Batteriestatus.
Dem wurde mit Hilfe des Forum Abhilfe geschaffen.
Im Folgenden wird erläutert wie die Batterieüberwachung eingerichtet werden kann.

'''Voraussetzung:'''

bc - Basiscalculator [https://packages.debian.org/de/sid/bc Bc-Paket]
<pre> sudo apt-get install bc </pre>

Anlegen eines Shellskript auf dem Raspberry System.
Die Parameter <<MAC-Adresse>> und <<TagName>> müssen durch die Werte des auszulesenden G-Tags ersetzt werden.
<pre>
#!/bin/bash
stringZ=$(sudo gatttool -b 5C:2B:80:C1:14:41 --char-read --handle=0x001b)
stringZ=${stringZ:33:2}
stringZ=$(echo "$stringZ" | tr a-f A-F)
decimal=$(echo "ibase=16; $stringZ" | bc)
perl /opt/fhem/fhem.pl 7072 "setreading MeinGtag Batterie $decimal"
</pre>

Dem Device in FHEM (hier MeinGtag) ein userReading mit dem Namen '''Batterie''' hinzufügen.
Das Shellskript mit folgendem Befehl starten:
<pre>
./GtagBatterie.sh
</pre>
'''Wichtig ist hierbei,''' dass Skript mit "./" und nicht mit "sh" aufzurufen. Beim Aufruf mit "sh GtagBatterie.sh" produziert es einen Fehler
<pre>GtagBatterie.sh: 3: GtagBatterie.sh: Bad substitution </pre>

Das Reading wird auf den ausgelesenen Wert der Batterie gesetzt.

Hinweis: Es sollte für jeden G-Tag ein eigenes Skript abgelegt werden. Das Skript kann per crontab oder fhem Kommando (system) regelmäßig aufgerufen werden.

=== Batterieüberwachung (alle Devices vom Typ "MODE=lan-bluetooth") ===

Es gibt eine weitere Möglichkeit um den Batteriestatus von LE Devices abzurufen und in FHEM als Reading darzustellen.
Dabei wird der Batteriezustand für alle LE Devices, die bereits in FHEM konfiguriert sind und per lepresenced überwacht werden, automatisch in einem shell-Script ermittelt.
Näheres dazu im Forumartikel {{Link2Forum|Topic=56960|LinkText=Erweiterung: Anwesenheitserkennung/Batterieüberwachung}}.

Vorteile:
* Automatische Ermittlung aller in FHEM konfigurierten LE Devices
* Möglichkeit, diese Devices alternativ manuell im Script einzutragen
* Es werden nur Devices abgefragt, die im Status "present" sind, also mit ziemlicher Sicherheit auch verfügbar sind
* Ein eventuell auf dem FHEM telnet-Port gesetztes Passwort kann im Script hinterlegt werden

'''Voraussetzung:'''

'''Funktionierendes lepresenced''' - siehe [[Anwesenheitserkennung#Anleitung_f.C3.BCr_ein_LE_Device_.28z.B._Gtags.2CPebbles_etc..29|Anleitung für ein LE Device (z.B. Gtags,Pebbles etc.)]]

'''socat''' - TCP port forwarder
<pre>
sudo apt-get update && sudo apt-get install socat
</pre>

'''gawk''' - Zum extrahieren der Daten
<pre>
sudo apt-get update && sudo apt-get install gawk
</pre>

'''gatttool''' - Bestandteil von bluez

gatttool ist auf den meisten Distributionen im bluez-Paket, allerdings nicht bei Opensuse. Dort muss man das Sourcepaket von bluez installieren und selbst kompilieren.
gatttool sollte dann nach /usr/bin oder /usr/local/bin kopiert werden,

Zusätzlich zu den notwendigen Erweiterungen werden für die Ausführung von gatttool '''Root-Rechte benötigt'''!

Das Script selbst gibt es hier: [https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery lebattery]

Am Besten unter /opt/fhem/script/lebattery speichern und ausführbar machen:
<syntaxhighlight lang="bash">
sudo su -
mkdir /opt/fhem/script
cd /opt/fhem/script
wget https://raw.githubusercontent.com/micky0867/lebattery/master/lebattery
chmod 755 lebattery
</syntaxhighlight>

Je nach Bedarf können im Script noch die folgenden 3 Parameter angepasst werden:
<syntaxhighlight lang="bash">
# If allowed_telnetPort is protected by a password, add the password here
TELNETPASSWORD=""
# Attribute for batterylevel in FHEM
ATTRIBUT="batterylevel"
# Use this, if you dont want the script to determine the tags on its own
LETAGS=""
</syntaxhighlight>

Das Skript wird dann unter root folgendermaßen gestartet:
<pre>
/opt/fhem/script/lebattery -v
</pre>

Ausgabe des Skripts, wenn es mit dem Verbose Parameter -v gestartet wird.

Beide Devices sind vom Typ NUT mini, das Device mit dem FHEM-Namen '''nut_Micky''' ist im Status '''absent'''. Das zweite Device ist im Status '''present'''.
<pre>
Determining address for nut_Micky ...
nut_Micky is in state absent, no further action required

Determining address for nut_Test ...
Fetching batterylevel for nut_Test (F3:44:04:81:54:89) ...
Setting batterylevel for nut_Test to 100%
</pre>

Mein crontab-Eintrag (User root) sieht so aus:
<pre>
3 3 * * * /opt/fhem/script/lebattery -v >/opt/fhem/script/lebattery.log 2>&1
</pre>
Damit wird jeden Morgen um 3 Minuten nach 3 Uhr der Zustand der Batterien aller Devices ermittelt und in FHEM abgespeichert.<br>
Bevor man das mit crontab macht, sollte man allerdings zunächst sicher stellen, dass es auch ohne crontab funktioniert....

Bei Problemen kann man auch erstmal schauen, ob das mit dem gattool überhaupt funktioniert:
<pre>
gatttool -t <Typ> -b <MAC-Adresse> --char-read --uuid 0x2a19

handle: 0x0017 value: 64
</pre>
In diesem Fall hat die Batterie noch 100% (hex 64).<br>
Der Typ ist abhängig vom Hersteller und kann public (G-Tags) bzw. random (Nut) sein. Im Zweifelsfall beides ausprobieren.

= Beispiele =
== Anwesenheitserkennung / Anwesenheitsbenachrichtigung mit G-Tags ==
Ein Skript zur Nutzung der Gigaset G-TAGs zur Alarmierung bei öffnen und schließen von Türen und zur Anwesenheitserkennung, um die Alarmierung zu aktivieren bzw. deaktivieren.
Es kann verwendet werden um die Anwesenheit von mehrern Personen im Haushalt zu erkennen. Dabei wird eingeschränkt, dass nur bestimmte Personen die Alarmierung aktivieren können ( Eltern/Kind -Beziehung ).
Des Weiteren werden im Beispiel die Eltern benachrichtigt wenn eins der Kinder das Haus verlässt und die Eltern nicht anwesend sind.

{{Randnotiz|RNText=Namen der G-Tags in den Skripten bitte anpassen!}}

Für die ''Notify'' und die ''RESIDENTS-Erweiterung'' wird ein Dummy benötigt.
<pre>
define Alarm dummy
attr Alarm devStateIcon aktiv:secur_locked@red inaktiv:secur_open@lightgreen
attr Alarm eventMap on:aktiv off:inaktiv
attr Alarm setList on off
attr Alarm webCmd aktiv:inaktiv
attr Alarm room Alarm
</pre>

=== Mit Notify ===
<pre>
gtag.*.presence:.* {Anwesenheit_check("$EVTPART1", "$NAME")}
</pre>

Code für die 99_myUtils.pm
<pre>
### GTAG ANWESENHEITS CHECK
sub Anwesenheit_check($$) {
my ($EVENT, $NAME) = @_;

# gtag_rot - Alias Marco
# gtag_schwarz - Alias Ulli
# gtag_gruen - Alias Frida
# gtag_orange - Alias Hannah

my $RESIDENT = "rr_"; # Alle GTAGs sind Standardmäßig Residents Roommate
# $RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur Gäste (Roomguest) Auskommentiert, da ich es so nicht brauche
my $ROOMMATE = ("$RESIDENT" . "$NAME"); # Residentsname zusammenbauen
my $ALIASNAME = AttrVal($ROOMMATE,'alias',$ROOMMATE); # ALIAS des Roommates auslesen

my $GTAG1 = Value('gtag_rot'); # ELTERN
my $GTAG2 = Value('gtag_schwarz'); # ELTERN

my $STATUS = "wahrscheinlich gerade los";
$STATUS = "anwesend" if ($EVENT eq "present"); # Status: anwesend
$STATUS = "unterwegs" if ($EVENT eq "absent"); # Status: unterwegs

Log 1, "$ALIASNAME ist $STATUS."; # LOG Eintrag erzeugen

if (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME ist da..."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME ist da...'"); # Pushover
}
elsif (($EVENT eq "present" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_rot" xor $NAME eq "gtag_schwarz")) {
fhem("set teleBot send ALARMIERUNG INAKTIV: $ALIASNAME ist da...; set Alarm inaktiv"); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG INAKTIV' '$ALIASNAME ist da...'; set Alarm inaktiv"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "aktiv") && ($NAME eq "gtag_gruen" xor $NAME eq "gtag_orange")) {
fhem("set teleBot send ALARMIERUNG BLEIBT AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Infopush msg 'ALARMIERUNG BLEIBT AKTIV' '$ALIASNAME hat das Haus verlassen.'"); # Pushover
}
elsif (($EVENT eq "absent" && Value("Alarm") eq "inaktiv") && ($GTAG1 eq "absent" && $GTAG2 eq "absent")) {
fhem("set Alarm aktiv; set teleBot send ALARMIERUNG AKTIV: $ALIASNAME hat das Haus verlassen."); # Telegram
# fhem("set Alarm aktiv; set Infopush msg 'ALARMIERUNG AKTIV' '$ALIASNAME hat das Haus verlassen.' '' 0 ''"); # Pushover
}
}
</pre>

<br>

=== Mit Notify und Integration des RESIDENTS-MODUL ===

Der hier beschriebene Code erweitert die Funktionen unter dem Punkt 5.93.
Das Notify muss daher mit der folgenden Zeile erweitert werden.

<pre>
define Alarm_AnwesenheitCheck notify gtag.*.presence:.* { Anwesenheit_check("$EVTPART1", "$NAME"), Anwesenheit_check_resi("$NAME") }
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die RESIDENTS Funktion nutzen zu können:
<pre>
### RESIDENTS
sub Anwesenheit_check_resi($) {
my ($NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME); # ALIASNAME des GTAGs auslesen

my $RESIDENT = "rr_"; # Als Standard sind alle GTAGs Roommates
$RESIDENT = "rg_" if (($NAME eq "gtag_orange") xor ($NAME eq "gtag_weis")); # Hier nur GTAG Namen der Gäste (Roomguest)
my $ROOMMATE = ("$RESIDENT" . "$ALIASNAME"); # Residentsname zusammenbauen

if (ReadingsVal($NAME,'presence',$NAME) eq "absent") {
fhem("set $ROOMMATE absent"); # Resisents Status von Roommates setzen
}
elsif(ReadingsVal($NAME,'presence',$NAME) eq "present") {
fhem("set $ROOMMATE home"); # Resisents Status von Roommates setzen
}
}
</pre>
<br>

=== Mit Notify und Fenster/Tür. -Kontakt Überwachung ===

Erweiterung für die Überwachung von Fenster/Tür. -Kontakten. Dazu sind zwei weitere Notifys notwendig die auf die Trigger der Kontakte regagieren
und so eine weitere Funktion in der 99_myUtils.pm ansprechen. Die Notifys triggern auf Kontakte die mit dem Namen Kontakt* beginnen.
Sollten die eigenen Fenster/Tür. -Kontakt anderen Namen besitzen, müssen die Skripte dementsprechend angepasst werden.
<pre>
define Alarm_Kontaktmeldung notify Kontakt.*:contact:.* {Kontakt_Meldung("$EVTPART1", "$NAME")}
</pre>
<pre>
define Alarm_Sabotagealarm notify Kontakt.*.sabotageError:.on {Kontakt_Sabotage("$EVTPART1", "$NAME")}
</pre>

Zusätzlicher Code für die 99_myUtils.pm um die TÜRKONTAKTE-Meldung nutzen zu können:
<pre>
### TÜRKONTAKTE-Meldung/Zustand
sub Kontakt_Meldung($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME wurde $EVENT";
if (ReadingsVal("Alarm", "state", "on") eq "on") {
fhem("set teleBot send $ALIASNAME wurde $EVENT"); # Nachricht über Telegram
# fhem("set Infopush msg '$ALIASNAME' '$ALIASNAME wurde $EVENT'"); # Nachricht über Pushover
}
}

### TÜRKONTAKTE-Sabotagealarm

sub Kontakt_Sabotage($$) {
my ($EVENT, $NAME) = @_;
my $ALIASNAME = AttrVal($NAME,'alias',$NAME);
Log 1, "$ALIASNAME meldet Sabotagealarm";
fhem("set teleBot send Alarm: $ALIASNAME meldet Sabotagealarm"); # Nachricht über Telegram
# fhem("set Infopush msg 'Alarmanlage' '$ALIASNAME meldet Sabotagealarm' '' 2 ' ' 60 600 "); # Nachricht über Pushover
}
</pre>
<br>

=== Hinweis zur Benutzung / Fehlerhandling ===

Der Alarm dummy hat den Zustand on:off. Die Bezeichnungen und Namen müssen 1:1 übernommen werden damit das Script funktioniert.
Andernfalls müssen die Bezeichnungen für z.B. absent:unterwegs und present:anwesend - angepasst werden.
Die Benachrichtigung kann aktuell per ''Telegram'' sowie ''Pushover'' ('''Achtung mit zweiterem sind Abokosten verbunden!''') realisiert werden.
Diskussion zum Thema im Forum unter: {{Link2Forum|Topic=64080}}
<br>

= Problemlösungen =
Falls es '''Probleme beim Starten des Skripts''' gibt bzw. man das Skript ohne Reboot des Systems neustarten möchte, kann man dies per kill Befehl erledigen.
<syntaxhighlight lang="bash">
ps -ef | grep lepresenced
sudo kill <pid>
</syntaxhighlight>

Debuglevel lepresenced setzen:
{{Randnotiz|RNText=Um Debug-Meldungen zu bekommen (Vorsicht bei SD-Karten-Systemen wie dem RPi) - Hierbei werden die Schreibzyklen auf die SD-Karte erhöht.}}

Der Log Level muss im lepresenced-Skript selbst verändert werden. Um den Log-Level auf INFO/WARNING/DEBUG zu setzen, dass Skript lepresenced mit einem Editor öffnen und die Stellen, wo LOG_WARNING zu finden sind durch den nötigen LOG-Eintrag ersetzen.

<pre>
lepresenced --loglevel LOG_DEBUG
</pre>
Nur das wichtigste Loggen:
<pre>
lepresenced --loglevel LOG_WARNING
</pre>
Keinerlei LOG-Einträge
<pre>
lepresenced --loglevel LOG_EMERG
</pre>

Bei '''Problemen mit der Batterieüberwachung''' der Tags kann die Pi Firmeware mit folgenden Befehl auf eine ältere Version zurückgesetzt werden.
Fehlermeldung beim Aufruf des lebattery oder anderen Batterietestskripten:
<pre>connect: Connection refused (111)</pre>

Lösung (vorübergehend)
<pre>
sudo rpi-update 8521fd34c8f66b6d109acce943f6e25ec93ec005
</pre>

Mehr dazu unter: {{Link2Forum|Topic=56960|Message=589165}}

'''Das BT-Device ist ständig "absent"'''<br>
Eine Mögliche Lösung kann sein, dass Paket bluez-hcidump zu installieren. Das Werkzeug hcidump erlaubt die Beobachtung von Bluetooth-Aktivität.
Dies ist nicht notwendig, wenn bereits bluez installiert ist, da dies Teil des bluez Paketes ist
<pre>
sudo apt-get install bluez-hcidump
</pre>

'''Fehler in Logdateien /var/log/syslog und /var/log/kernel'''
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634211] bt_err_ratelimited: 1 callbacks suppressed
Jul 29 15:08:11 raspberrypi kernel: [ 4905.634231] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:12 raspberrypi kernel: [ 4906.647350] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.532081] Bluetooth: hci0 advertising data length corrected
Jul 29 15:08:13 raspberrypi kernel: [ 4907.655564] Bluetooth: hci0 advertising data length corrected

Die Ursache des Problems ist noch nicht ergründet, allerdings betrifft dies aktuell nur den RPi3. Die Fehlermeldungen werden in verschiedene log's geschrieben. Darunter maßgeblich "syslog" und "kern.log".

Lösung (vorübergehend)
Unterbinden der Einträge durch Anlage eines blocklist Eintrag:

1. Unter "/etc/rsyslog.d" eine Datei erzeugen mit dem Namen "01-blocklist.conf"
2. Inhalt: (Die Ausdrücke in den "" sind diejenigen, die aus dem log verschwinden sollen. - bei mir waren es die unten stehenden")
:msg,contains,"Bluetooth: hci0 advertising data length corrected" stop
:msg,contains,"bt_err_ratelimited:" stop
3. Dienst neu starten "sudo service rsyslog restart"

Weiter Infos werden im offiziellen Thema {{Link2Forum|Topic=28753|Message=499184|LinkText=hier}} diskutiert.

Seit Version 0.82 kann es beim Start zu folgenden Meldungen im Log kommen.
Sep 06 16:13:45 raspberrypi systemd[1]: Started lepresenced.
Sep 06 16:13:45 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: Received 'Set scan parameters failed: Input/output error', ...tting...
Sep 06 16:13:46 raspberrypi lepresenced[16010]: [tid:1] main::bluetooth_scan_thread: hcitool exited, retrying...

Diese Meldungen können ignoriert werden. Abhilfe schafft sich lepresenced selbst indem es sich resettet.

'''Moderne iPhones und Android Geräte wechseln zum "deep standby" Modus''', und werden dann als "abwesend" gemeldet.
Mittels einer Funktion, die via hping3 Packete an den Geräte senden, um die "wach" zu halten, und dann die MacAdresse ausliest, kann man dieses Problem umgehen. Mehr im Forum [https://forum.fhem.de/index.php/topic,76342.0.html]

= Versionsänderungen lepresenced =
<pre>
--Version 0.81 (BasisVersion)
--Version 0.82 (stable 08/2017)
-Neue Kommandozeilenoption "--debug": Startet lepresenced im Vordergrund und gibt ausführliche Debug-Informationen auf STDOUT aus.
-Sanity Check: lepresenced prüft beim Starten die Verfügbarkeit von hciconfig, hcitool und hcidump.
-Model: lepresenced übermittelt das Reading model nun als lan-lepresenced. Das erlaubt die Erkennung von lepresenced in der FHEM-Statistik (sofern aktiviert).
--Version 0.83 (stable 09/2017)
- Behebung von Systemstart Fehlern
- Weitere Debug-Möglichkeiten. U. a. wird nun mitgezählt, ob hcitool lescan ("legacy") und hcidump eine identische Zahl an Beacons empfangen
</pre>

= Ansprechpartner =
# {{Link2FU|117|markusbloch }} (Markus) für das PRESENCE-Modul und collectord
# {{Link2FU|5068|PatrikR}} (Patrick) für lepresenced
# [[Benutzer Diskussion:Devender|Devender]] ({{Link2FU|20043|Dirk}}) für Wiki und Doku

EnOcean-FSB61-Aktor-Beschattungselemente-Rollladen

2018-06-27T21:07:38Z

50watt: /* FHEM Config-Auszug */ attr <device> model Eltako_FSB_ACK ergänzt

{{Infobox Hardware
|Bild=Fsb61np.jpg
|Bildbeschreibung=FSB61NP Fertigungswoche XX/12
|HWProtocol=EnOcean
|HWType=Aktor, Empfänger, ab Fertigungswoche 41/11 auch Sender, Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=1 (unidirektional, ab Fertigungswoche 41/11 bidirektional)
|HWVoltage=230V~
|HWPowerConsumption=Eigenverbrauch ca. 0,7W - 0,9W
|HWPoweredBy=230V
|HWSize=45x55x33mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Eltako
}}

{{Randnotiz|RNText=Seite gilt nur für die '''bidirektionale''' Variante des Aktors ab Fertigungswoche 41/11}}

'''EnOcean-FSB61-Aktor-Beschattungselemente-Rollladen''' ist ein Aktor
* für
** Unterputzmontage
* für
** Steuerung von Rollladen und Beschattungselementen
== Features ==
Aktor für Beschattungselemente und Rolladen (ab Fertigungswoche 41/11 bidirektional)

== Hinweise zum Betrieb mit FHEM ==
Volle Funktionsfähigkeit erfordert, dass die Bestätigungstelegramme am Aktor eingeschaltet sind

=== Definition/Anlernvorgang ===
Der Aktor kann nicht vollautomatisch per autocreate in FHEM angelegt werden.
Die Einbindung in FHEM kann entweder über die Nutzung der inoffiziellen, gerätespezifischen EEP (empfohlen) '''oder''' über die manuelle Vorgehensweise erfolgen.

===== Nutzung der inoffziellen EEP =====
Folgende Schritte sind durchzuführen:
* FHEM-Device <name> (hier: EnO_switch_FSB61) mit dem inoffiziellen EEP für den FSB61 (G5-3F-7F) und der Sender-ID des FSB61 (siehe Rückseite des Aktors; hier: 01036620) durch Eingabe in das [[Konfiguration#Befehl-Eingabefeld|Befehls-Eingabefeld]] definieren:
: <code>define EnO_switch_FSB61 EnOcean 01036620 G5-3F-7F</code>
: Hierdurch wird ein FHEM-Device mit allen grundlegenden Attributen angelegt. Nur das Attribut <code>model</code> muss noch wie unten im Config-Auszug gezeigt mit dem Wert Eltako_FSB61 angelegt werden, bevor das FHEM-Device am Aktor angelernt werden kann.
* Am Aktor
** Oberer Funktions-Drehschalter: auf LRN
** Unterer Funktions-Drehschalter: auf MAX (zum Einlernen PC)
* FHEM Eingabefeld: <code>set EnO_switch_FSB61 teach</code>
* Am Aktor nach dem Einlernen beide Drehschalter in die ursprüngliche Position
* Abschließend müssen die Attribute <code>shutTime</code> und <code>shutTimeCloses</code> für die Laufzeitsteuerung angelegt und mit den individuellen Werten der zu steuernden Jalousien angepasst werden. Infos zu den Attributen finden sich unten im [[#FHEM_Config-Auszug|FHEM-Config-Auszug]].

===== Alternative: manuelle Vorgehensweise =====
Folgende Schritte sind durchzuführen:
* EnOcean-FHEM-Device <name> mit der Sender-ID des FSB (siehe Rückseite des Aktors) definieren
* Das Attribut subDef mit einer freien SenderId des TCMs anlegen ODER falls keine freie Sender-ID bekannt ist, das Attribut komplett weglassen, damit die Vergabe automatisch durch FHEM erfolgt
* Die Attribute subType, model und manufID wie nachfolgend im Config-Auszug anlegen
* Die Attribute shutTime und shutTimeCloses mit individullen Werten anlegen (vgl. Erläuterungen zum Config-Auszug)
* Am Aktor
** Oberer Funktions-Drehschalter: auf LRN
** Unterer Funktions-Drehschalter: auf MAX (zum Einlernen PC)
* FHEM Eingabefeld: „set <name> teach"
* Am Aktor nach dem Einlernen beide Drehschalter in die ursprüngliche Position

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der [[Konfiguration|fhem.cfg]]:
define EnO_switch_FSB61 EnOcean 01036620 <--- SenderID des FSB61 (Aktors)
attr EnO_switch_FSB61 eep A5-3F-7F
attr EnO_switch_FSB61 manufID 00D
attr EnO_switch_FSB61 model Eltako_FSB_ACK
attr EnO_switch_FSB61 subDef AABBCC05 <--- AABBCC05 ist eine der 127 SenderID's des TCM mit der FHEM sendet
attr EnO_switch_FSB61 subType manufProfile
attr EnO_switch_FSB61 webCmd opens:stop:closes
attr EnO_switch_FSB61 shutTime 35
attr EnO_switch_FSB61 shutTimeCloses 40
* '''shutTime''': Zeit (in Sekunden) die der Rollladen von "vollständig geöffnet" bis "vollständig geschlossen" braucht. Diese Zeit verwendet FHEM um die Position des Rollladens zu errechnen. Fährt man den Rollladen von der oberen Endlage mit <pre>set EnO_switch_FSB61 position 50</pre> so fährt der Rollladen die Hälfte der shutTime in Sekunden runter bevor er stoppt. Der Rollladen steht nun in der Position 50%.
* '''shutTimeCloses''': Zeit (in Sekunden), um den Rollladen sicher in eine definierte Endlage zu fahren.
** shutTimeCloses ist größer als shutTime
** shutTimeCloses ist (etwas) größer als die am FSB61 eingestellte Rückfallverzögerung (unterer Drehschalter, 0-120 Sekunden)
: Fährt man den Rollladen von der oberen Endlage mit <pre>set EnO_switch_FSB61 closes</pre> zu, so fährt FHEM den Rollladen shutTimeCloses Sekunden runter -> die untere Endlage wird sicher erreicht und der FSB61 sendet die diesbezügliche Bestätigung.
* '''model''':
Grundsätzlich wird der Status „open_ack“ vom FSB61 Aktor versendet, wenn länger nach oben gefahren wird, als die am Aktor per Drehschalter eingestellte Zeit oder eben beim Hochfahren am lokalen Steuereingang. Damit befindet sicher der Aktor sicher in Position "0". Mit <pre>attr <device> model Eltako_FSB_ACK</pre> wird das in FHEM auch so umgesetzt.

== Einsatzbeispiel ==
=== Rollladensteuerung in Abhängigkeit von Sonnenauf- und -untergang ===
define RolladenHoch at *{sunrise(0,"07:00","09:00")} set EnO_switch_FSB61 opens
define RolladenZu at *{sunset(0,"17:30","22:00")} set EnO_switch_FSB61 closes

Der Rolladen wird

* morgens zum Sonnenaufgang, aber nicht vor 07:00 und nicht nach 09:00 Uhr hochgefahren und
* abends zum Sonnenuntergang zugefahren, aber nicht vor 17:30 Uhr und nicht nach 22:00 Uhr.

Siehe auch: [[SUNRISE_EL]]

=== Anzeige Rollladenstand im WebFrontend ===
Durch die folgenden zwei Attribute wird der Rollladenstand im WebFrontend bildlich dargestellt:
:<code>attr EnO_switch_FSB61 stateFormat position</code>
:<code>attr EnO_switch_FSB61 devStateIcon down:fts_shutter_100 up:fts_window_2w 1\d.*:fts_shutter_90 2\d.*:fts_shutter_80 3\d.*:fts_shutter_70 4\d.*:fts_shutter_60 5\d.*:fts_shutter_50 6\d.*:fts_shutter_40 7\d.*:fts_shutter_30 8\d.*:fts_shutter_20 9\d.*:fts_shutter_10 \d.*:fts_shutter_90</code>

Siehe auch [[FTUI_Snippets#Rollladen_Circle_Menu|dieses Beispiel für Tablet UI]]

== Links ==
* Datenblatt: [https://www.eltako.com/fileadmin/downloads/de/datenblatt/Datenblatt_FSB61NP-230V.pdf PDF]
* Anleitung: [https://www.eltako.com/fileadmin/downloads/de/_bedienung/FSB61NP_30200430-7_dt.pdf PDF]

[[Kategorie:EnOcean Components]]
[[Kategorie:Rollladensteuerung]]

EnOcean-FSB61-Aktor-Beschattungselemente-Rollladen

2018-04-29T19:04:24Z

50watt: /* Anzeige Rollladenstand im WebFrontend */

{{Infobox Hardware
|Bild=Fsb61np.jpg
|Bildbeschreibung=FSB61NP Fertigungswoche XX/12
|HWProtocol=EnOcean
|HWType=Aktor, Empfänger, ab Fertigungswoche 41/11 auch Sender, Sensor
|HWCategory=EnOcean
|HWComm=EnOcean Funk, 868Mhz
|HWChannels=1 (unidirektional, ab Fertigungswoche 41/11 bidirektional)
|HWVoltage=230V~
|HWPowerConsumption=Eigenverbrauch ca. 0,7W - 0,9W
|HWPoweredBy=230V
|HWSize=45x55x33mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#EnOcean EnOcean]
|HWManufacturer=Eltako
}}

{{Randnotiz|RNText=Seite gilt nur für die '''bidirektionale''' Variante des Aktors ab Fertigungswoche 41/11}}

'''EnOcean-FSB61-Aktor-Beschattungselemente-Rollladen''' ist ein Aktor
* für
** Unterputzmontage
* für
** Steuerung von Rollladen und Beschattungselementen
== Features ==
Aktor für Beschattungselemente und Rolladen (ab Fertigungswoche 41/11 bidirektional)

== Hinweise zum Betrieb mit FHEM ==
Volle Funktionsfähigkeit erfordert, dass die Bestätigungstelegramme am Aktor eingeschaltet sind

=== Definition/Anlernvorgang ===
Der Aktor kann nicht vollautomatisch per autocreate in FHEM angelegt werden.
Die Einbindung in FHEM kann entweder über die Nutzung der inoffiziellen, gerätespezifischen EEP (empfohlen) '''oder''' über die manuelle Vorgehensweise erfolgen.

===== Nutzung der inoffziellen EEP =====
Folgende Schritte sind durchzuführen:
* FHEM-Device <name> (hier: EnO_switch_FSB61) mit dem inoffiziellen EEP für den FSB61 (G5-3F-7F) und der Sender-ID des FSB61 (siehe Rückseite des Aktors; hier: 01036620) durch Eingabe in das [[Konfiguration#Befehl-Eingabefeld|Befehls-Eingabefeld]] definieren:
: <code>define EnO_switch_FSB61 EnOcean 01036620 G5-3F-7F</code>
: Hierdurch wird ein FHEM-Device mit allen grundlegenden Attributen angelegt. Nur das Attribut <code>model</code> muss noch wie unten im Config-Auszug gezeigt mit dem Wert Eltako_FSB61 angelegt werden, bevor das FHEM-Device am Aktor angelernt werden kann.
* Am Aktor
** Oberer Funktions-Drehschalter: auf LRN
** Unterer Funktions-Drehschalter: auf MAX (zum Einlernen PC)
* FHEM Eingabefeld: <code>set EnO_switch_FSB61 teach</code>
* Am Aktor nach dem Einlernen beide Drehschalter in die ursprüngliche Position
* Abschließend müssen die Attribute <code>shutTime</code> und <code>shutTimeCloses</code> für die Laufzeitsteuerung angelegt und mit den individuellen Werten der zu steuernden Jalousien angepasst werden. Infos zu den Attributen finden sich unten im [[#FHEM_Config-Auszug|FHEM-Config-Auszug]].

===== Alternative: manuelle Vorgehensweise =====
Folgende Schritte sind durchzuführen:
* EnOcean-FHEM-Device <name> mit der Sender-ID des FSB (siehe Rückseite des Aktors) definieren
* Das Attribut subDef mit einer freien SenderId des TCMs anlegen ODER falls keine freie Sender-ID bekannt ist, das Attribut komplett weglassen, damit die Vergabe automatisch durch FHEM erfolgt
* Die Attribute subType, model und manufID wie nachfolgend im Config-Auszug anlegen
* Die Attribute shutTime und shutTimeCloses mit individullen Werten anlegen (vgl. Erläuterungen zum Config-Auszug)
* Am Aktor
** Oberer Funktions-Drehschalter: auf LRN
** Unterer Funktions-Drehschalter: auf MAX (zum Einlernen PC)
* FHEM Eingabefeld: „set <name> teach"
* Am Aktor nach dem Einlernen beide Drehschalter in die ursprüngliche Position

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der [[Konfiguration|fhem.cfg]]:
define EnO_switch_FSB61 EnOcean 01036620 <--- SenderID des FSB61 (Aktors)
attr EnO_switch_FSB61 eep A5-3F-7F
attr EnO_switch_FSB61 manufID 00D
attr EnO_switch_FSB61 model Eltako_FSB61
attr EnO_switch_FSB61 subDef AABBCC05 <--- AABBCC05 ist eine der 127 SenderID's des TCM mit der FHEM sendet
attr EnO_switch_FSB61 subType manufProfile
attr EnO_switch_FSB61 webCmd opens:stop:closes
attr EnO_switch_FSB61 shutTime 35
attr EnO_switch_FSB61 shutTimeCloses 40
* '''shutTime''': Zeit (in Sekunden) die der Rollladen von "vollständig geöffnet" bis "vollständig geschlossen" braucht. Diese Zeit verwendet FHEM um die Position des Rollladens zu errechnen. Fährt man den Rollladen von der oberen Endlage mit <pre>set EnO_switch_FSB61 position 50</pre> so fährt der Rollladen die Hälfte der shutTime in Sekunden runter bevor er stoppt. Der Rollladen steht nun in der Position 50%.
* '''shutTimeCloses''': Zeit (in Sekunden), um den Rollladen sicher in eine definierte Endlage zu fahren.
** shutTimeCloses ist größer als shutTime
** shutTimeCloses ist (etwas) größer als die am FSB61 eingestellte Rückfallverzögerung (unterer Drehschalter, 0-120 Sekunden)
: Fährt man den Rollladen von der oberen Endlage mit <pre>set EnO_switch_FSB61 closes</pre> zu, so fährt FHEM den Rollladen shutTimeCloses Sekunden runter -> die untere Endlage wird sicher erreicht und der FSB61 sendet die diesbezügliche Bestätigung.

== Einsatzbeispiel ==
=== Rollladensteuerung in Abhängigkeit von Sonnenauf- und -untergang ===
define RolladenHoch at *{sunrise(0,"07:00","09:00")} set EnO_switch_FSB61 opens
define RolladenZu at *{sunset(0,"17:30","22:00")} set EnO_switch_FSB61 closes

Der Rolladen wird

* morgens zum Sonnenaufgang, aber nicht vor 07:00 und nicht nach 09:00 Uhr hochgefahren und
* abends zum Sonnenuntergang zugefahren, aber nicht vor 17:30 Uhr und nicht nach 22:00 Uhr.

Siehe auch: [[SUNRISE_EL]]

=== Anzeige Rollladenstand im WebFrontend ===
Durch die folgenden zwei Attribute wird der Rollladenstand im WebFrontend bildlich dargestellt:
:<code>attr EnO_switch_FSB61 stateFormat position</code>
:<code>attr EnO_switch_FSB61 devStateIcon down:fts_shutter_100 up:fts_window_2w 1\d.*:fts_shutter_90 2\d.*:fts_shutter_80 3\d.*:fts_shutter_70 4\d.*:fts_shutter_60 5\d.*:fts_shutter_50 6\d.*:fts_shutter_40 7\d.*:fts_shutter_30 8\d.*:fts_shutter_20 9\d.*:fts_shutter_10 \d.*:fts_shutter_90</code>

Siehe auch [[FTUI_Snippets#Rollladen_Circle_Menu|dieses Beispiel für Tablet UI]]

== Links ==
* Datenblatt: [https://www.eltako.com/fileadmin/downloads/de/datenblatt/Datenblatt_FSB61NP-230V.pdf PDF]
* Anleitung: [https://www.eltako.com/fileadmin/downloads/de/_bedienung/FSB61NP_30200430-7_dt.pdf PDF]

[[Kategorie:EnOcean Components]]
[[Kategorie:Rollladensteuerung]]

Event monitor

2018-04-12T20:52:18Z

50watt: /* Vorgehensweise beim Ändern eines Gerätes */ Tippfehler

[[Datei:EventMonitor.png|mini|400px|rechts|Event Monitor Anzeige mit Beispiel-Ereignissen]]
Der [[Event monitor]] (<code>/fhem?cmd=style%20eventMonitor</code> [[#Die_o.a._eventMonitor-URL_kann_nicht_erfolgreich_aufgerufen_werden]]) ist eine Seite im [[PGM2|Standard Interface]] von FHEM, auf der alle von FHEM verarbeiteten Ereignisse angezeigt werden. Ereignisse im genannten Sinn sind neben eingehenden Funktelegrammen auch [[notify]]- und [[at]]-Anweisungen.

Die Ereignisanzeige wird bei jedem Aufruf des Monitor-Fensters geleert, nur im Anschluss daran auftretende Ereignisse werden angezeigt, es können also keine Ereignisse der Vergangenheit angezeigt werden. Um einen längeren Zeitraum "aufzuzeichnen", muss das Monitor-Fenster demzufolge durchgehend geöffnet sein.

In einer Telnet-Sitzung ist eine äquivalente Funktionalität über das "inform" Kommando verfügbar.

Im gezeigten Beispiel sind im überwachten Zeitraum vier Nachrichten eines [[FHT80TF-2]] aufgetreten.

== Events "filtern" ==
[[Datei:EventMonitorFiltered.png|mini|rechts|Event Monitor, gefilterte Ausgabe]]
Um die Ausgabe im Event monitor auf eine Teilmenge zu begrenzen, kann an die URL ein Filter angehängt werden; im gezeigten Beispiel werden nur Ereignisse Devices angezeigt, die den Text ''pca'' in Namen enthalten. Die URL muss bis FHEM-Updatestand vom 26.03.2015 dafür auf <code>/fhem?cmd=style eventMonitor pca</code> abgeändert / ergänzt werden, der angewendete Filter wird unter dem Befehlseingabefeld angezeigt.

Der Filter funktioniert bis FHEM-Updatestand vom 26.03.2015 nur auf den Device Namen bzw. Teile davon, nicht jedoch auf den Device Typ (im gezeigten Beispiel würde also ein Filtern auf PCA301 nicht funktionieren).

Mit FHEM-Update vom 27.03.2015 wurde Aufruf und Bedienung des Event Monitors vereinfacht sowie die Filtermöglichkeiten ausgebaut. Der Filter muss nicht mehr über eine Anpassung der URL, sondern kann direkt im Event Monitor dialogunterstützt eingestellt werden. Es sind nun auch Filter auf Device Typ möglich und es kann ein beliebiger regulärer Ausdruck in Perl für den Filter genutzt werden. Bei Aufruf des Event Monitors werden zunächst weiterhin alle Events angezeigt. Erkennbar an der Titelzeile "Events (Filter:.*):". Durch Anklicken des ".*" in der Titelzeile öffnet sich eine Dialogbox in der man einen regulären Ausdruck eintragen kann. Nach Bestätigung der Dialogbox mit OK wird dieser reguläre Ausdruck zum Filtern der Events genutzt und in der Titelzeile angezeigt (bspw. "Events (Filter:pca):"). Beispiele zu den neuen Filtermöglichkeiten enthält dieser {{Link2Forum|Topic=12398|Message=278553|LinkText=Forenbeitrag}}.

== Geräte anlegen/ändern ==
Der [[Event monitor]] bietet die Möglichkeit aus einer markierten [[Event]]-Zeile Gerätedefinitionen abzuleiten und die [[Gerät|Geräte]] anzulegen.
Es können Definitionen für folgende Gerätemodule angelegt werden:

* [[DOIF]]
* [[FileLog]]
* [[notify]]
* [[sequence]]
* [[watchdog]]

Für einige [[Gerät|Geräte]] können die Definitionen auch geändert werden. Die [[Gerätename|Gerätenamen]] werden in einer Auswahlliste angezeigt.

=== Vorgehensweise beim Anlegen eines Gerätes ===
* [[Event]]-Zeile komplett markieren
* den Knopf {{Taste|Create/Modify Device}} betätigen
* ein Gerätemodul auswählen
* '''Create''' auswählen
* die gewünschte Form des [[Event|Events]] auswählen
* den Knopf {{Taste|OK}} betätigen
Danach öffnet sich die Detailansicht des angelegten [[Gerät|Gerätes]], dort kann die Definition weiter bearbeitet werden.

=== Vorgehensweise beim Ändern eines Gerätes ===
* [[Event]]-Zeile komplett markieren
* den Knopf {{Taste|Create/Modify Device}} betätigen
* '''Modify''' auswählen
* ein [[Gerät]] auswählen
* die gewünschte Form des [[Event|Events]] auswählen
* den Knopf {{Taste|OK}} betätigen
Danach öffnet sich die Detailansicht des angelegten [[Gerät|Gerätes]], dort kann die Definition weiter bearbeitet werden.

== Bekannte Probleme ==
=== Die eventMonitor-URL kann nicht erfolgreich aufgerufen werden ===

Der Event-Monitor kann bei aktiviertem CSRF<ref>[https://de.wikipedia.org/wiki/Cross-Site-Request-Forgery Cross-Site-Request-Forgery] - Wikipedia</ref>-Schutz (FHEMWEB Attribut <code>csrfToken</code>) nur aus dem FHEMWEB-Frontend heraus geöffnet werden. Es handelt sich hierbei um einen Sicherheitsmechanismus, welcher seit Feature-Level 5.8 standardmäßig aktiviert ist. Jeder Aufruf des Event-Monitors in FHEMWEB muss standardmäßig das aktuell gültige CSRF-Token im URL-Aufruf enthalten um den Event-Monitor angezeigt zu bekommen:

<font color="grey">/fhem?cmd=style%20eventMonitor</font>'''&fwcsrf=csrf_193851249212150'''

Dieses Verhalten kann durch das FHEMWEB Attribut <code>csrfToken</code> (siehe {{Link2CmdRef|Lang=de|Anker=csrfToken}}) verändert werden. Details dazu finden sich in dem Artikel [[CsrfToken-HowTo]].

=== Event Monitor schreibt keine Events ===
Es sind diverse Situationen bekannt geworden, in denen der Event Monitor keine Events schreibt, z.B.:
* aufgrund von Problemen mit dem {{Link2Forum|Topic=35715|Message=291061|LinkText=Netzwerkkartentreiber ''E2200 KILLER''}}
* {{Link2Forum|Topic=35715|Message=289167|LinkText=Firewall (Sophos)}}

== Links ==
* {{Link2Forum|Topic=12398}} ''Filter im Event Monitor''
* [[Event|Event, Ereignis]]

[[Kategorie:HOWTOS]]

Event monitor

2018-04-12T20:51:39Z

50watt: /* Vorgehensweise beim Anlegen eines Gerätes */ Tippfehler

[[Datei:EventMonitor.png|mini|400px|rechts|Event Monitor Anzeige mit Beispiel-Ereignissen]]
Der [[Event monitor]] (<code>/fhem?cmd=style%20eventMonitor</code> [[#Die_o.a._eventMonitor-URL_kann_nicht_erfolgreich_aufgerufen_werden]]) ist eine Seite im [[PGM2|Standard Interface]] von FHEM, auf der alle von FHEM verarbeiteten Ereignisse angezeigt werden. Ereignisse im genannten Sinn sind neben eingehenden Funktelegrammen auch [[notify]]- und [[at]]-Anweisungen.

Die Ereignisanzeige wird bei jedem Aufruf des Monitor-Fensters geleert, nur im Anschluss daran auftretende Ereignisse werden angezeigt, es können also keine Ereignisse der Vergangenheit angezeigt werden. Um einen längeren Zeitraum "aufzuzeichnen", muss das Monitor-Fenster demzufolge durchgehend geöffnet sein.

In einer Telnet-Sitzung ist eine äquivalente Funktionalität über das "inform" Kommando verfügbar.

Im gezeigten Beispiel sind im überwachten Zeitraum vier Nachrichten eines [[FHT80TF-2]] aufgetreten.

== Events "filtern" ==
[[Datei:EventMonitorFiltered.png|mini|rechts|Event Monitor, gefilterte Ausgabe]]
Um die Ausgabe im Event monitor auf eine Teilmenge zu begrenzen, kann an die URL ein Filter angehängt werden; im gezeigten Beispiel werden nur Ereignisse Devices angezeigt, die den Text ''pca'' in Namen enthalten. Die URL muss bis FHEM-Updatestand vom 26.03.2015 dafür auf <code>/fhem?cmd=style eventMonitor pca</code> abgeändert / ergänzt werden, der angewendete Filter wird unter dem Befehlseingabefeld angezeigt.

Der Filter funktioniert bis FHEM-Updatestand vom 26.03.2015 nur auf den Device Namen bzw. Teile davon, nicht jedoch auf den Device Typ (im gezeigten Beispiel würde also ein Filtern auf PCA301 nicht funktionieren).

Mit FHEM-Update vom 27.03.2015 wurde Aufruf und Bedienung des Event Monitors vereinfacht sowie die Filtermöglichkeiten ausgebaut. Der Filter muss nicht mehr über eine Anpassung der URL, sondern kann direkt im Event Monitor dialogunterstützt eingestellt werden. Es sind nun auch Filter auf Device Typ möglich und es kann ein beliebiger regulärer Ausdruck in Perl für den Filter genutzt werden. Bei Aufruf des Event Monitors werden zunächst weiterhin alle Events angezeigt. Erkennbar an der Titelzeile "Events (Filter:.*):". Durch Anklicken des ".*" in der Titelzeile öffnet sich eine Dialogbox in der man einen regulären Ausdruck eintragen kann. Nach Bestätigung der Dialogbox mit OK wird dieser reguläre Ausdruck zum Filtern der Events genutzt und in der Titelzeile angezeigt (bspw. "Events (Filter:pca):"). Beispiele zu den neuen Filtermöglichkeiten enthält dieser {{Link2Forum|Topic=12398|Message=278553|LinkText=Forenbeitrag}}.

== Geräte anlegen/ändern ==
Der [[Event monitor]] bietet die Möglichkeit aus einer markierten [[Event]]-Zeile Gerätedefinitionen abzuleiten und die [[Gerät|Geräte]] anzulegen.
Es können Definitionen für folgende Gerätemodule angelegt werden:

* [[DOIF]]
* [[FileLog]]
* [[notify]]
* [[sequence]]
* [[watchdog]]

Für einige [[Gerät|Geräte]] können die Definitionen auch geändert werden. Die [[Gerätename|Gerätenamen]] werden in einer Auswahlliste angezeigt.

=== Vorgehensweise beim Anlegen eines Gerätes ===
* [[Event]]-Zeile komplett markieren
* den Knopf {{Taste|Create/Modify Device}} betätigen
* ein Gerätemodul auswählen
* '''Create''' auswählen
* die gewünschte Form des [[Event|Events]] auswählen
* den Knopf {{Taste|OK}} betätigen
Danach öffnet sich die Detailansicht des angelegten [[Gerät|Gerätes]], dort kann die Definition weiter bearbeitet werden.

=== Vorgehensweise beim Ändern eines Gerätes ===
* [[Event]]-Zeile komplett markieren
* den Knopf {{Taste|Create/Modify Device}} betätigen
* '''Modify''' auswählen
* ein [[Gerät]] auswählen
* die gewünschte Form des [[Event|Events]] auswählen
* den Knopf {{Taste|OK}} betätigen
Danach öffnet sich die Detailansicht des angelegten [[Gerät|Gerätes]], dort kann die Definition weiter beatbeitet werden.

== Bekannte Probleme ==
=== Die eventMonitor-URL kann nicht erfolgreich aufgerufen werden ===

Der Event-Monitor kann bei aktiviertem CSRF<ref>[https://de.wikipedia.org/wiki/Cross-Site-Request-Forgery Cross-Site-Request-Forgery] - Wikipedia</ref>-Schutz (FHEMWEB Attribut <code>csrfToken</code>) nur aus dem FHEMWEB-Frontend heraus geöffnet werden. Es handelt sich hierbei um einen Sicherheitsmechanismus, welcher seit Feature-Level 5.8 standardmäßig aktiviert ist. Jeder Aufruf des Event-Monitors in FHEMWEB muss standardmäßig das aktuell gültige CSRF-Token im URL-Aufruf enthalten um den Event-Monitor angezeigt zu bekommen:

<font color="grey">/fhem?cmd=style%20eventMonitor</font>'''&fwcsrf=csrf_193851249212150'''

Dieses Verhalten kann durch das FHEMWEB Attribut <code>csrfToken</code> (siehe {{Link2CmdRef|Lang=de|Anker=csrfToken}}) verändert werden. Details dazu finden sich in dem Artikel [[CsrfToken-HowTo]].

=== Event Monitor schreibt keine Events ===
Es sind diverse Situationen bekannt geworden, in denen der Event Monitor keine Events schreibt, z.B.:
* aufgrund von Problemen mit dem {{Link2Forum|Topic=35715|Message=291061|LinkText=Netzwerkkartentreiber ''E2200 KILLER''}}
* {{Link2Forum|Topic=35715|Message=289167|LinkText=Firewall (Sophos)}}

== Links ==
* {{Link2Forum|Topic=12398}} ''Filter im Event Monitor''
* [[Event|Event, Ereignis]]

[[Kategorie:HOWTOS]]

Z-Wave-FIB FGRM-222-Rollladenaktor

2018-02-27T05:57:13Z

50watt: /* Links */Links zu den Manuals funktionierten nicht

{{Infobox Hardware
|Bild=Z-Wave-FIB FGRM-222.JPG
|Bildbeschreibung=Fibaro FGRM-222
|HWProtocol=Z-Wave
|HWType=Sensor, Sender und Aktor, Empfänger
|HWCategory=Z-Wave
|HWComm=Funk 868MHz
|HWChannels=2
|HWVoltage=230V~
|HWPowerConsumption=<0,8W
|HWPoweredBy=230V~
|HWSize=42x37x17mm
|HWDeviceFHEM=[http://fhem.de/commandref.html#ZWave Z-Wave]
|HWManufacturer=[http://www.fibaro.com/de Fibar Group]
}}

[[Z-Wave-FIB FGRM-222-Rollladenaktor]] ist ein Jalousiesteuereinsatz für die Steuerung von Rollos, Markisen, Jalousien, Garagentoren und anderen Einphasen-Wechselstrom-Geräten mit Energiemessfunktion

== Features ==
Der Jalousieaktor bietet Positionserkennung, spezielle Steuerkommandos für Lammellen (Winkelverstellung) und misst den Energieverbrauch.

== Hinweise zum Betrieb mit FHEM ==
=== Inklusion ===
Der Aktor wird bei der Inklusion und aktivierten autocreate vollautomatisch erkannt und definiert. Zur Steuerung von Lamellen von Jalousien muss das Kommando <code>get <device> model</code> erfolgreich ausgeführt worden sein, damit die speziellen Fibaro-Kommandos zur Lammellensteuerung bereitstehen.

=== Assoziation ===
Der Controller muss zur korrekten Funktion in die Assoziationsgruppe 3 des Aktors aufgenommen werden:
:<code>set <device> associationAdd 3 <Controller-NodeID></code>
Dies wird aufgrund der Informationen in der XML-Config-Datei für den FGRM-222 automatisch bei der Inklusion durchgeführt. Bitte die korrekte Verarbeitung des Befehls per <code>get <device> association 3</code> überprüfen.

=== Konfiguration ===
{{Randnotiz|RNText=Ab {{Link2Forum|Topic=37121|Message=294480|LinkText=Updatestand 15.05.2015}} wird bei der Inklusion von Geräten automatisch der Befehl <code>get <name> model</code> ausgeführt.}}
Das Gerät von FHEM einmalig durch folgenden Befehl identifizieren:
:<code>get <device> model</code>
Die Readings <code>model</code>, <code>modelID</code> und <code>modelConfig</code> werden dadurch erzeugt. In <code>model</code> steht nach korrekter Ausführung des Befehls der Klartextname des Gerätes "FIBARO System FGRM222 Roller Shutter Controller 2". Zudem sind dann spezielle set/get-Kommandos configXYZ des Gerätes im Auswahldialog der Detailansicht mit den zugehörigen Hilfetexten verfügbar.

Der Aktor muss anschließend kalibriert werden. Dazu Parameter 29 auf 1 setzen:
:<code>set <device> configByte 29 1</code>
oder
:<code>set <device> configForcedRollerShutterCalibration StartCalibrationProcess</code>

Der Aktor fährt die Rolllade zur Kalibrierung vollständig hoch, runter und wieder hoch.

==== Rollladen ====
Nach Kalibrierung kann die Rolllade sofort prozentual durch
:<code>set <device> dim <%> </code>
gesteuert werden. Weitere Parametereinstellung sind grundsätzlich nicht notwendig.

Standardmäßig wird die Rollladenposition mit "off", "dimXY" (xy=1-99) und "on" angezeigt.
Möchte man das Reading "position" mit aussschließlich zahlenmäßiger Angabe der Position haben, dann muss die Konfiguration für den Versand des Fibaro-Reports angepasst werden:
:<code>set <device> configByte 3 1 </code>
oder
:<code>set <device> configReportsType BlindPositionReportsSentToThe1 </code>

==== Jalousie mit Lammellen ====
Zur Steuerung von Jalousien mit Lammellen ist der Jalousiemodus mit Positionsunterstützung zu wählen:
:<code>set <device> configByte 10 2 </code>
oder
:<code>set <device> configRollerShutterOperatingModes VenetianBlindModeWithPositioning </code>

Der Jalousie-Positions-Report sollte als Fibaro Kommando an den Controller gesendet werden, da nur so der eingestellte Winkel vom Aktor an den Controller gesendet wird:
:<code>set <device> configByte 3 1 </code>
oder
:<code>set <device> configReportsType BlindPositionReportsSentToThe1 </code>

Zudem ist die Zeit für ein vollständiges Drehen der Lammellen einzustellen:
:<code><nowiki>set <device> configWord 12 <time></nowiki></code>
oder
:<code><nowiki>set <device> configInVenetianBlindModeTheParameter12 <time> </nowiki></code>

Nach dem Setzen dieser Parameter kann die Jalousie mit Lammellen folgermaßen gesteuert werden:
:<code>set <device> positionSlat <%> </code>
Fährt die Lammelle in den angegebenen Winkel.

:<code>set <device> positionBlind <%> </code>
Fährt die Jalousie zur angegebenen Position und fährt die Lammellen auf Position 0% (geschlossen).<br/>
Ausnahme: Bei sehr geringen Änderungen an der Ausgangsposition (ca. 1-3%) wird der zuletzt gewählt Winkel der Lammellen wieder hergestellt.

:<code>set <device> dim <%> </code>
Fährt die Jalousie zur angegebenen Position und fährt die Lammellen in den zuletzt per <code>set <device> positionSlat <%></code> gewählten Winkel.

Obige Hinweise beziehen sich auf einen Aktor ohne örtliche Steuerung durch Taster/Schalter. Auswirkungen einer örtlichen Steuerung auf die FHEM-Befehle (Winkeleinstellungen!) können daher nicht beurteilt werden.

=== Definition ===
Ein exemplarischer Auszug aus der [[Konfiguration]]:
define ZWave_SWITCH_MULTILEVEL_4 ZWave e345c452 4
attr ZWave_SWITCH_MULTILEVEL_4 IODev ZWDongle_0
attr ZWave_SWITCH_MULTILEVEL_4 classes MANUFACTURER_SPECIFIC VERSION CONFIGURATION ASSOCIATION SWITCH_BINARY POWERLEVEL METER SENSOR_MULTILEVEL FIRMWARE_UPDATE_MD SWITCH_BINARY MANUFACTURER_PROPRIETARY PROTECTION MARK METER SENSOR_MULTILEVEL MANUFACTURER_PROPRIETARY SCENE_ACTIVATION SWITCH_MULTILEVEL SWITCH_BINARY
attr ZWave_SWITCH_MULTILEVEL_4 room ZWave
define FileLog_ZWave_SWITCH_MULTILEVEL_4 FileLog ./log/ZWave_SWITCH_MULTILEVEL_4-%Y.log ZWave_SWITCH_MULTILEVEL_4
attr FileLog_ZWave_SWITCH_MULTILEVEL_4 logtype text
attr FileLog_ZWave_SWITCH_MULTILEVEL_4 room ZWave

=== Logbeispiel ===
Log mit Parameter 3 auf 0 = Jalousie Positions Report wird als Z-Wave Kommando an Primärcontroller gesendet. (Standardeinstellung)

2014-09-27_13:41:46 ZWave_SWITCH_MULTILEVEL_4 power: 81.6 W
2014-09-27_13:42:36 ZWave_SWITCH_MULTILEVEL_4 power: 59.5 W
2014-09-27_13:42:41 ZWave_SWITCH_MULTILEVEL_4 power: 0.0 W
2014-09-27_13:42:41 ZWave_SWITCH_MULTILEVEL_4 dim 95
2014-09-27_13:42:41 ZWave_SWITCH_MULTILEVEL_4 reportedState: dim 95
2014-09-27_13:44:40 ZWave_SWITCH_MULTILEVEL_4 dim 53
2014-09-27_13:44:41 ZWave_SWITCH_MULTILEVEL_4 power: 85.1 W
2014-09-27_13:45:05 ZWave_SWITCH_MULTILEVEL_4 dim 53
2014-09-27_13:45:05 ZWave_SWITCH_MULTILEVEL_4 reportedState: dim 53
2014-09-27_13:45:05 ZWave_SWITCH_MULTILEVEL_4 power: 0.0 W
2014-09-27_13:45:20 ZWave_SWITCH_MULTILEVEL_4 dim 0
2014-09-27_13:45:21 ZWave_SWITCH_MULTILEVEL_4 power: 85.8 W
2014-09-27_13:45:55 ZWave_SWITCH_MULTILEVEL_4 off
2014-09-27_13:45:55 ZWave_SWITCH_MULTILEVEL_4 reportedState: off
2014-09-27_14:54:46 ZWave_SWITCH_MULTILEVEL_4 energy: 0.01 kWh

Log mit Parameter 3 auf 1 = Jalousie Positions Report wird als Fibaro Kommando an Primärcontroller gesendet.
2014-09-28_14:33:55 ZWave_SWITCH_MULTILEVEL_4 positionBlinds 15
2014-09-28_14:34:01 ZWave_SWITCH_MULTILEVEL_4 position: Blind 15 Slat 25
2014-09-28_14:34:01 ZWave_SWITCH_MULTILEVEL_4 power: 0.0 W

== Links ==
* Hersteller-Anleitung: [https://manuals.fibaro.com/content/manuals/en/FGR-222/FGR-222-EN-A-v1.1.pdf PDF], englisch
* Zwaveeurope-Anleitung: [http://manuals-backend.z-wave.info/make.php?lang=DE&sku=FIB_FGRM-222 HTML], deutsch

[[Kategorie:Z-Wave Components|Rolladen]]
[[Kategorie:Rollladensteuerung]]
[[Kategorie:Energieverbrauchsmessung]]

HomeMatic

2018-02-27T05:20:03Z

50watt: /* Protokoll */Tippfehler korrigiert

'''HomeMatic''' (HM) ist ein System des Herstellers eQ-3 zur Steuerung und Überwachung von zahlreichen Aufgaben und Situationen im Haus. Erhältlich sind sowohl Geräte mit Funkschnittstelle 868.3 MHz, als auch (seit 2008) drahtgebundene Geräte mit RS485-Schnittstelle. Im Programm sind Geräte zur Heizungs- und Lichtsteuerung, Temperatur-, Luftfeuchte- und Feuchtemessung, Zutrittskontrolle, als Wasser-, Brand- und Bewegungsmelder sowie als Wetterstation, ferner gibt es noch Fernbedienungen und Statusdisplays.

Das ähnliche klingende '''''[[HomeMatic IP]]''''' ist eine neue Generation von Geräten und Funkprotokoll (HM-IP: IP over BidCos). Die dort angebotenen Geräte lassen sich über den Einsatz einer (physischen) CCU2 oder anderen Lösungen wie YHAM, raspberrymatic usw. und den [[HMCCU|HomeMatic-Modulen]] integrieren.

=Grundlagen=
HomeMatic-Geräte können untereinander ''gepeert'' werden (engl. ''peers'' = "Gleiche"), im einfachsten Fall kann deshalb bereits ein Sensor (z.B. ein Temperatursensor) mit einem Aktor (z.B. einem Heizkörperregler) verbunden werden und diesen steuern. Hierbei können mehrere Sensoren und Aktoren untereinander verbunden werden, die Vorstellung der "Gleichen" ist also zutreffend.

HomeMatic-Geräte können auch mit einer Zentrale verbunden (''gepairt'') werden, die dann einen Teil der Steuerungslogik übernehmen kann. Bei dieser Verbindung spricht man vom ''Pairing'', weil jedes HomeMatic-Gerät nur mit einer Zentrale verbunden werden kann. Gepairte Geräte können auch nicht mehr direkt gepeert werden - dies geht dann nur noch unter Beteiligung der Zentrale.

==Voraussetzungen==
Für den Betrieb ohne Zentrale sind keine weiteren Voraussetzungen zu erfüllen.
===Zentrale von eQ-3===
Vom Hersteller eQ-3 selbst wird eine Zentrale (derzeit aktuell CCU-2) und Windows-Software zur Steuerung und Auswertung der HM-Komponenten angeboten. Diese Zentrale kann wie eingangs dargestellt über das Modul [[HMCCU]] in FHEM eingebunden werden und dann neben HM-IP- und HM-wired-Komponenten auch solche mit BidCoS verwalten.

===FHEM als Zentrale===
Zur Kommunikation mit HomeMatic benötigt FHEM eine Schnittstelle, die im 868,3-MHz-Band funken kann. Infrage kommen:
* [[HM-MOD-RPI-PCB HomeMatic Funkmodul f%C3%BCr Raspberry_Pi]] (RPI, WLAN, LAN, USB)
* [[HM-LGW-O-TW-W-EU Funk-LAN Gateway]] (LAN)
* [[HM-CFG-LAN]] (oft auch "HMLAN" genannt; LAN; nicht mehr lieferbar)
* [[HM-CFG-USB USB Konfigurations-Adapter|HM-CFG-USB]] (USB, nicht mehr lieferbar)
* [[CUL]] und andere Geräte mit CC110x-Transceiver, [[CUNO]], SelbstbauCUL, nanoCUL, umgeflashter MAX-Cube, MapleCUx, CUNX usw. (USB, GPIO, LAN , WLAN)

Erfahrungsgemäß ist der Einsatz originaler HomeMatic IOs empfehlenswert, da es bei allen CUL-Derivaten immer wieder zu Schwierigkeiten kommen kann, vor allem in größeren Installationen und bei der Kommunikation mit komplexeren Geräten. Wer dennoch einen CUL für HomeMatic verwenden will, sollte eine speziell für den Betrieb mit HomeMatic optimierte CUL-firmware ([https://forum.fhem.de/index.php/topic,24436.0.html TimeStamp Firmware]) verwenden. Bei HomeMatic ist das Timing der Telegramme entscheidend sonst kann es zu "MISSING_ACK" bzw. "RESPONSE TIMEOUT:RegisterRead" u.ä. Meldungen kommen! Zusätzlich sind '''unbedingt''' die Hinweise im Artikel [[AES_Encryption]] zu beachten!

Für ''HomeMatic Wired'' benötigt man eine RS485-Schnittstelle. Das "offizielle" Gateway [[HomeMatic Wired RS485 LAN Gateway|HMW-LGW-O-DR-GS-EU]] (LAN) funktioniert prinzipiell mit FHEM, der Einsatz wird aber nicht empfohlen. Hier gibt es Alternativen dazu: [[Serial/Netzwerk-RS485-Adapter]].

===Migration von CCU-2 zu FHEM===
Der Umzug einer bestehenden HomeMatic Installation von einer HomeMatic CCU-2 auf FHEM ist möglich. Um die an die Zentrale angebundenen Devices in FHEM ohne größere Umkonfiguration weiter verwenden zu können, muß die HM-Id und, falls verwendet, die AES-Schlüssel der CCU-2 in FHEM übernommen werden. Um diese Daten aus der CCU-2 auszulesen, wird eine SSH-Verbindung (zum Beispiel mit PuTTY unter Windows) aufgebaut. Die HM-Id befindet sich in der Datei <code>/usr/local/etc/config/rfd/BidCoS-RF.dev</code> in einer Zeile wie dieser:

<device serial="BidCoS-RF" type="HM-RCV-50" address="<span style="color: maroon; font-weight: bold;">0xABCDEF</span>" aes_key_index="0" firmware_version="2.11.9" bidcos_interface="KEQ1234567" roaming="true">

Die HM-Id ist der Wert des <code>address</code>-Attributs. Die dort angegebene hexadezimale Zahl (hier <code>0xABCDEF</code>) ist die HM-Id und wird in FHEM ohne das "0x"-Präfix verwendet.

Falls AES-Schlüssel eingerichtet sind, sind diese in der Datei <code>/etc/config_templates/crypttool.cfg</code> zu finden und können 1:1 als Schlüssel im [[HM-CFG-LAN]] in der gleichen Reihenfolge hinterlegt werden.
{{Todo|Wie werden AES-Schlüssel in HM-CFG-LAN "hinterlegt"?}}

==Protokoll==
HM-Geräte kommunizieren untereinander mit dem Protokoll ''Bidirectional Communication Standard'', abgekürzt ''BidCoS''. Jedes HM-Gerät enthält also Sender und Empfänger, das ist einer der wesentlichen Unterschiede z.B. zum FS20-System.
*Jedes HM-Gerät meldet beim Empfang eines Steuerbefehls durch einen Peer an diesen eine Bestätigung „ACK“ zurück. Erkennt das HM-Gerät den Befehl nicht, sendet es ein ''NACK''. Kommt vom HM-Gerät keine Rückmeldung innerhalb einer festgelegten Zeit, meldet der steuernde Peer ein ''MISSING ACK''.
*Jedes HM-Gerät meldet ferner seinen Status nach dem Erhalt eines Steuerbefehls zurück - so kann auch ein lokal am Gerät erfolgender Tastendruck in beim steuernden Peer oder in der Zentrale registriert werden.

Das Protokoll ''BidCoS'' wurde zum großen Teil entschlüsselt, seine offen verfügbare Variante heißt ''AskSin''. Unter Verwendung der AskSin-Library entstehen derzeit erste Geräte, die in das HomeMatic-System eingebunden werden können. Zur Unterscheidung zwischen HM und den neuen Geräten werden diese als [[HomeBrew]] (HB) bezeichnet.

=Betrieb mit FHEM=
Die Kenntnis des Dokumentes [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Einsteigerdokuments "Heimautomatisierung mit FHEM"] wird vorausgesetzt. Im Anhang dieses Dokuments findet sich ein Teil über den Aufbau und die Funktion von HM-Geräten.

=== Einrichten des IO-Devices (Funkschnittstelle)===
Zuerst muss ein IO-Device eingerichtet werden, um mit HM Geräten kommunizieren zu können. Hier ist eine Liste der [[HomeMatic#FHEM als Zentrale|Schnittstellen]].

=== Struktur von HM Geräten===
HM Geräte sind logisch in ein '''Device (Gerät)''' und ein oder mehrere '''Channels (Kanäle)''' gegliedert. Jedes Device und jeder Channel wird in einer Entity in FHEM repräsentiert. <br>
Ausnahme: Sollte ein Gerät nur einen Kanal haben werden diese zusammen in einer Entity angelegt.
====Device====
Das Device ist für die Kommunikation verantwortlich. Es sortiert und ordnet die zu sendenden und empfangenden Nachrichten.
Man kann prüfen, ob alle Nachrichten übertragen sind, oder ob es Probleme gegeben hat. Die Variablen "prot..." geben Auskunft darüber. Siehe auch [[Homematic_HMInfo#protoEvents]].
Zu beachten sind zudem die Übertragungsmodi. Nicht alle Devices sind ständig auf Empfang - FHEM muss berücksichtigen, wann gesendet werden kann. In '''protState''' kann man sehen, ob Kommandos auf Verarbeitung warten, also pending sind. Einige Devices unterstützen mehrere Modi parallel.

===== Config=====
Wird von allen Devices unterstützt, auch wenn es bei Always kaum genutzt werden kann.
Man setzt die Kommandos in FHEM ab und diese warten in der Kommando-Queue.
Wenn die Config-Funktion am Device ausgelöst wird (Anlerntaste drücken) sendet FHEM die wartenden Nachrichten der Reihe nach. Config wird bei allen Devices zum Pairen genutzt.

===== Always=====
Trifft man meist bei netzbetriebenen Geräten an, da diese kein Problem mit dem Energieverbrauch haben. Man kann immer mit dem Device kommunizieren.

===== Burst=====
Nur der Empfänger des Device ist aktiv. Über eine Aufweck-Sequenz kann das Device geweckt werden. Man kann quasi immer mit dem Device kommunizieren. Nachteil des Aufwecken ist zum Einen, dass immer ALLE Devices im Funknetz geweckt werden, was deren Batterie belastet. Zum Anderen ist die Aufweck-Sequenz funktechnisch aufwändig und belastet die maximal erlaubte Sendekapazität des IO device je Stunde.

===== ConditionalBurst=====
Bei einigen Devices kann man den Burst mode zuschalten. Dies sind Devices, die zusätzlich über andere modi verfügen, so z.B. wakeup. Schaltet man Burst-Empfang ein kann man immer und sofort mit dem Device reden, es kostet aber etwas mehr Batterie. Siehe hierzu Attribut '''burstAccess''', Kommando '''burstXmit''' und Register '''burstRx'''
===== LazyConfig=====
Kommandos in der Queue werden bearbeitet, wenn eine Aktion vom Device ausgeht. So zum Beispiel ein Tastendruck bei einer Fernbedienung.
Dieser mode wird von CUL/CUNO nicht unterstützt. FHEM ignoriert diese Option automatisch und wartet i.A. auf ein Config.
===== Wakeup=====
Die Devices wachen regelmäßig auf und senden Daten, z.B. Temperatursensoren. Zu diesem Zeitpunkt kann FHEM die Nachrichten übertragen. Die Aufwachperiode ist unterschiedlich von 3 min bis zu 24h.

====Channel====
Ein Kanal ist die Funktionseinheit des Geräts. Hier ist die Funktion des Sensors oder Aktors realisiert.

Nutzt ein Gerät nur einen Kanal, wird dieser in FHEM der Übersichtlichkeit halber nicht einzeln angelegt. Für die Kommandos und das Peering wird trotzdem die HM-ID des 1. Kanals verwendet.

Nutzt ein Gerät hingegen mehrere Kanäle, werden diese per [[autocreate]] zusätzlich zum Device angelegt. Es ist aber möglich, bei Geräten mit virtuellen Kanälen, diese zu löschen und fehlende Attribute manuell dem Device hinzu zu fügen. Danach kann es wie ein 1-Kanal-Gerät genutzt werden. Allerdings werden die Kanäle beim erneuten Pairing von [[autocreate]] neu angelegt.

=====virtuelle Kanäle=====
Einige Dimmer unterstützen virtuelle Kanäle. Eigentlich haben sie keinen Hauptkanal sondern nur 3 virtuelle Kanäle, die je nach Verknüpfungslogik, den endgültigen Zustand des Aktors bestimmen. Dieses Verhalten wird in jedem Kanal per Register '''logicCombination''' gesetzt. <br />
Folgende Logik wird dabei angewendet: <tt>phyLevel = (((0% o Ch1) o Ch2) o Ch3)</tt> [o = Logik-Platzhalter]

D.h. es wird immer der Kanal mit dem gesetzten Register mit dem vorherigen Teilergebnis kombiniert, angefangen mit Kanal1. <br />
Es gibt folgende Logik-Optionen: [einzelne Betrachtung von <tt>(Vorergebnis o Kanal)</tt>]
{|
!style="text-align:left;"|Wert!!style="text-align:left;"|Bedeutung!!style="text-align:left;"|Beispiel (alle Werte in %)
|-
|inactive||keine Verknüpfung|| 30 inactive 80 = 30
|-
|or||oder (höchster Wert zählt)|| 30 or 80 = 80
|-
|and||und (kleinster Wert zählt)|| 30 and 80 = 30
|-
|xor||entweder-oder (nur 1 Kanal darf über 0% sein)|| 30 xor 80 = 0 ''aber'' 30 xor 0 = 30
|-
|nor||oder negiert (höchster Wert subtrahiert von 100%)|| 30 nor 80 ''= !80'' = 20
|-
|nand||und negiert (niedrigster Wert subtrahiert von 100%)|| 30 nand 80 ''= !30'' = 70
|-
|orinv||oder mit invertiertem Kanal|| 30 orinv 80 ''= 30 or 20'' = 30
|-
|andinv||und mit invertiertem Kanal|| 30 andinv 80 ''= 30 and 20'' = 20
|-
|plus||Vorergebnis addiert mit Kanal|| 30 plus 80 = 100
|-
|minus||Vorergebnis subtrahiert mit Kanal|| 30 minus 80 = 0
|-
|mul||Vorergebnis multipliziert mit Kanal|| 30 mul 80 = 24
|-
|plusinv||Vorergebnis addiert mit invertiertem Kanal|| 30 plusinv 80 ''= 30 plus 20'' = 50
|-
|minusinv||Vorergebnis subtrahiert mit invertiertem Kanal|| 30 minusinv 80 ''= 30 minus 20'' = 10
|-
|mulinv||Vorergebnis multipliziert mit invertiertem Kanal|| 30 mulinv 80 ''= 30 mul 20'' = 6
|-
|invPlus||invertiertes Vorergebnis addiert mit Kanal|| 30 invPlus 80 ''= 70 plus 80'' = 100
|-
|invMinus||invertiertes Vorergebnis subtrahiert mit Kanal|| 30 invMinus 80 ''= 70 minus 80'' = 0
|-
|invMul||invertiertes Vorergebnis multipliziert mit Kanal|| 30 invMul 80 ''= 70 mul 80'' = 56
|}
: ''→ Siehe auch: [[HM-LC-Dim1PWM-CV Dimmaktor PWM DC-LED#Beispiele|Verknüpfungsbeispiel]]''

=== Variablen===
Wie alle FHEM Entities werden 4 Gruppen von Daten unterstützt:
* Internals: Im Web-Interface sichtbare Variablen, die allgemeine Informationen über den Zustand enthalten.
* Readings: Im Web-Interface sichtbare Variablen. Sie werden aus von Entities empfangenen Nachrichten generiert. Man kann mit notify Trigger auf diese setzen. Readings werden im Statefile bei save und gewissen neustarts gesichert und beim Booten eingelesen. Readings haben einen Zeitstempel.
* Attribute: Im Web-Interface sichtbare Variablen. Über sie kann man die Eigenschaften der Entity in FHEM steuern.
* Helper: Im Web-Interface nicht sichtbare Variablen. Man kann sie mit dem Kommando 'list' sehen. Es sind Hilfsvariablen, die für den User keine Bedeutung haben sollen.
==== Internals====
Viele Variablen sind nicht HM spezifisch - deren Bedeutung muss im allgemeinen Teil nachgelesen werden. Spezifische Variablen sind:
*Device
** channel_xx: Liste der Kanäle, die dem Device zugeordnet sind.
** prot... : Gruppe von Daten zum Zustand des <u>[[HomeMatic#Protokol|Protokolls]]</u>, also der Kommunikation mit dem Device.
** rssi...: Gruppe von Daten die den <u>[[HomeMatic#Rssi|Empfangspegel]]</u> des Device bei IOs, Peers und Repeatern darstellt.

*Kanäle
** device: Das übergeordnete Device
** chanNo: Die Kanalnummer
** peerList: Ist die Entity mit einem anderen gepeert, so steht hier der Name der Peers. Siehe auch attribut peerIDs und Reading peerList. Diese Variable ist mit dem peer verlinkt, man kann darauf 'clicken'.

==== Readings====
Readings für HM Entities unterliegenden allgemeinen FHEM Regeln.
Generell gilt, dass ein Wert, der von FHEM gesetzt wurde mit dem prefix '''"set_"''' versehen wird. Wenn der Zustand bestätigt ist, wird das set_ entfernt. Sollte man also ein Reading mit diesem prefix haben, das sich nicht selbst entfernt sollt man unbedingt den Zustand kontrollieren. <br>
So ist nach einem "set Licht on" der Zustand des Licht erst einmal "set_on". Mit der Antwort des Device wird es dann auf "on" gesetzt. <br>
Register machen eine Ausnahme:

=====Register=====
Register sind Konfigurationsparameter, die '''im Device flash''' gespeichert werden. Daten, die Registern zugeordnet sind, beginnen mit "R-". Sollte das Register einem peer zugeordnet sein kommt dieser danach. Der Namen ist also '''R-<peer>-<registerName>'''.

Der Zugriff ist indirekt, geht also nur über Methoden und Kommandos. Man kann die Konfiguration (Register und peers) mit '''getConfig''' aus dem Device lesen und in FHEM dargestellen. FHEM bemüht sich, die angezeigten Register aktuell zu halten - der User muss aber eine gewisse Vorsicht im Umgang damit walten lassen. Register können mit '''regSet''' gesetzt werden. Ob die gelesenen Register komplett sind prüft [[Homematic_HMInfo#Integrit.C3.A4tspr.C3.BCfungen|configCheck]]. Da einige Entities viele Register haben kann man mit dem Attribut '''expert''' die Sichtbarkeit steuern (siehe auch [[Homematic_HMInfo#Infos|Register]]).

Von einigen Devices sind Register schwer zu lesen, z.B. config devices. Man kann die Register-Readings [[Homematic_HMInfo#archConfig|archivieren]] und beim reboot wieder [[Homematic_HMInfo#archConfig|laden]].

==== Attribute====
Attribute sind i.A. Parameter, die das Verhalten der Entity steuern. Sie werden mit '''save''' in fhem.cfg oder einem seiner subfiles gespeichert. Nach einer Änderung sollte der User ein "save" machen, sonst sind diese nach einem Reboot verloren.<br>
Hier werden nur '''HM spezifische Attribute''' besprochen.<br>
Attribute, die das System '''automatisch''' anlegt. Sollten diese nicht mehr stimmen kann der User anlernen am Device drücken und sie werden wieder hergestellt. Der User sollte sie '''nicht ändern'''.
* model
* subType
* peerIDs: HMIds der peers. Wird gelegentlich verschoben!
* serialNr: auslaufend - durch Reading D-serianNr ersetzt
* firmware: auslaufend - durch Reading D-firmware ersetzt

Attribute für HM Entities, die der User steuern kann
* webCmd: FHEM setzt ggf. einen Default, der User kann dies anpassen
* expert: schaltet mehr oder weniger Readings sichtbar - dient der Übersichtlichkeit des Web-Interface.
* autoReadReg: steuert das automatische Lesen der Konfiguration - ggf. zeitverzögert um Resourcen zu schonen. Es wird Level 5 empfohlen

Attribute für HM Entities am Device, die der User steuern kann
* msgRepeat: kann man im Device einstellen. Es legt fest, wie oft eine Nachricht wiederholt werden soll, falls sie nicht empfangen wird. Beachte, dass unabhängig davon ein HMLAN/USB immer 3-mal probiert zu senden. Insbesondere bei Burst Devices sollte man einen niedrigen Level einstellen.
* IODev: Sollte man auf das IO device setzen, über das zu diesem Device gesendet werden soll. Es wird i.A. beim Pairen gesetzt.

Empfohlene Attribute außerhalb von HM
* event-on-change-reading .*

===Kommandos===
====Allgemein====
* get <name> cmdList ''# zeigt alle Kommandos mit Parametern für diese Entity an''
* clear [readings|register|rssi|msgEvents] ''# löschen von Readings oder Zählern''
====Register kommandos====
* set <name> getConfig ''# liest alle Peers und Register. Auf ein Device angewendet werden ALLE channels auch gelesen''
* set <name> regSet [prep|exec] <regName> <value> ... [<peerChannel>]'' #schreiben eines Registerwerts. Das Kommando landet im Kommandstack''
* set <name> regbulk ...''# kommando zum Setzen von rohdaten und ganzen Registerlisten. Ausser zum re-configurieren eines ganzen Device eher nicht für den User zu gebrauchen''

* set <name> sign [on|off ''# setzt das Register um AES einzuschalten. Man sollte sich über AES '''vorher''' einlesen!!''

* get <name> regList ''# zeigt alle Register, die diese Entity '''unterstützt''' - incl Beschreibung und Wertebereich. Als Anfänger sollte man einmal hinsehen!''
* get <name> reg all ''# zeigt alle Register, die diese Entity '''hat''' und den aktuellen Wert''

===Kommunikation===
Die Kommunikation zwischen Device und der Zentrale folgt einem Protokoll. Für die meisten Nachrichten erwartet der Sender eine Empfangsbestätigung. FHEM beachtet das Protokoll und implementiert es entsprechend der Fähigkeiten des IO device.

Grundsätzlich kann jedes Device an jedes andere Nachrichten senden. Damit dies auch einen erfolg hat, müssen die Kanäle gepeert werden.

Um FHEM zu erlauben, Nachrichten an das Device zu richten muss FHEM gepairt werden.<br>
Das Senden der Nachrichten macht IMMER das Device - ein Kanal selbst kann nicht wirklich senden.

====Protokoll====
Da für das Senden das Device verantwortlich ist sind hier die entsprechenden Informationen zu finden. Zu Beachten sind die [[HomeMatic#Device|Übertragungsmodi]], die ein Device unterstützt. Die Internals "prot..." enthalten alle notwendigen Daten.
* protState: Der Zustand der Protokollmaschine
** CMDs_done: alle Nachrichten übertragen, keine Fehler in diesem Durchgang aufgetreten
** CMDs_done_Error:xx : es hat xx Fehler bei der letzten Übertragung gegeben.
** CMDs_pending: Nachrichten warten auf das Senden
** CMDs_processing... : die Nachrichtenübertragung ist im Gange
** Info_Cleared: die Protokoll Statistik wurde rückgesetzt
* protCmdPend: Anzahl der Nachrichten, die auf das Senden warten
* protCmdDel: Anzahl gelöschter Nachrichten aufgrund von Fehlern
* protCmdNack: Anzahl der negativen Acknowledges
* protCmdResnd: Anzahl der Wiederholungen - die Nachrichten wurden nicht gelöscht.
* protCmdResndFail: Anzahl der fehlgeschlagenen Wiederholungen - die Nachrichten wurden gelöscht.
* protCmdIOerr: Anzahl der IO Fehler - Übertragung war nicht Möglich, weil das IO Device Probleme hatte. Der Grund sollte im IO Device nachgesehen werden.
* protCmdIOdly: Anzahl der Verzögerungen aufgrund von IO Problemen
* protCmdTimedOn: Anzahl der Nachrichten, wenn ein Timer im Device genutzt wird - z.B. durch on-for-timer
* protCmdRcv: Anzahl empfangene Nachrichten
* protCmdSnd: Anzahl gesendete Nachrichten
* protCmdErrIoId_...: Anzahl der Sendeversuche zum Device von einer anderen Zentrale
* protCmdErrIoAttack: Anzahl der Sendeversuche zum Device die nicht von FHEM kam- es könnte ein Versuch sein, das System zu hacken. Dies wird auch im Reading '''sabotageAttack''' ausgegeben und man kann ein notify darauf ansetzen.

* protCmdEvt_AESCom: Anzahl der AES Nachrichten von Device
* protCmdEvt_AESKey: Benutzter AES key

Die Zähler können mit '''set <device> clear msgEvents''' rückgesetzt werden. Dies kann vor Konfigurationsänderungen Sinn machen, um Probleme besser erkennen zu können. <br>
Eine Übersicht kann man mit HMInfo <u>[[Homematic_HMInfo#protoEvents|protoEvents]]</u> erhalten. Auch das Löschen aller Zähler ist von HMInfo aus möglich.

====RSSI====
Zeigt den Empfangspegel, den ein Device von einem Anderen misst. Die Variablen sind in Internals abgelegt. Angegeben werden minimale und maximale Wert. Außerdem wird der Durchschnitt und die Anzahl der Nachrichten ausgewertet.<br>
HM liefert Empfangspegel am IO Device (FHEM standard) aber auch den Empfangspegel am Device selbst. Ebenfalls ausgewertet werden Pegel, die beim Senden zwischen Peers erreicht werden.<br>
Die Zähler können mit '''set <device> clear rssi''' rückgesetzt werden.<br>
Eine Übersicht erhält man mit HMInfo <u>[[Homematic_HMInfo#RSSI|Rssi]]</u>. Das Löschen der Zähler aller HM devices ist von HMInfo aus möglich.<br>

Man kann RSSI kontinuierlich aufzeichnen, wenn das Attribut '''rssiLog''' im Device gesetzt ist. Es wird ein Reading rssi_<name> erzeugt. Das generelle Setzen dieses Attributs wird aus Performance-Gründen nicht empfohlen.

== Pairen und Peeren ==
: ''→ Siehe auch: [[Pairing und Peering]]''

HomeMatic-Geräte können mit einer Zentrale (FHEM) ''gepairt'' und mit anderen HM-Geräten ''gepeert'' werden.

=== Pairen ===
: ''→ Siehe auch: [[Pairing (HomeMatic)]]''
: ''→ Anleitung: [[HomeMatic Devices pairen]]''

HM-Geräte können mit und ohne Zentrale betrieben werden. FHEM geht davon aus, dass Geräte immer von einer Zentrale aus gesteuert werden können. Dazu muss das Gerät mit der Zentrale ''gepairt'' werden.

=== Peeren ===
: ''→ Siehe auch: [[Peering (HomeMatic)]]

Um es Geräten zu ermöglichen auch ohne Zentrale zu interagieren (zum Beispiel wenn die Zentrale einen Defekt hat), können HM-Geräte untereinander ''gepeert'' werden.
Dazu wird ein Sensor-Kanal mit einem Aktor-Kanal verknüpft.

== HMInfo ==
: ''→ Siehe auch: [[Homematic HMInfo]]''

Bei der Betreuung einer HomeMatic-Installation ist das Modul [[Homematic_HMInfo|HMInfo]] sehr hilfreich. Es stellt eine Übersicht der HomeMatic-Komponenten zur Verfügung, kann die Konfiguration prüfen und Alarmierungen gesammelt auswerten.

== Besondere Entities ==

=== Virtuelle Entities ===
Virtuelle Entities sind nicht reale HM Devices und Kanäle. Man kann sie als Sender und Empfänger nutzen, auch im Zusammenhang mit Rauchmeldern oder zur Steuerung von Heizungsventilen. Die spezifischen Anwendungen sind im entsprechenden Kapitel nachzulesen. <br>
Angelegt wird das Device, dann wird per Kommando eine Anzahl Kanäle angelegt.
define <virtDev> CUL_HM 112233
set <virtDev> virtual 10
jetzt hat man ein virtuelles Device mit 10 Kanälen angelegt.
Die die gültigen Kommandos kann man wie immer mit '''get <entity> cmdList''' erfahren.<br>
Auch einem Virtuellen Device sollte man das '''Attribut IODev setzen '''.
=== IO Entities ===
: ''→ Siehe auch: [[Virtueller Controller VCCU#Virtuelle Kanäle der VCCU]]

'''IO-Entities''' sind virtuelle Kanäle der Zentrale, mit denen andere HomeMatic-Geräte gepeert werden können. Diese Kanäle sind einem ''IO-Device'' zugeordnet – im Unterschied zu ''virtuellen Entities'' gibt es kein virtuelles HomeMatic-Gerät welches die Kanäle beherbergt.

Jedem IO-Device können bis zu 50 Kanäle zugewiesen werden. Wenn mehrere IO-Devices die gleiche HMId nutzen, zum Beispiel wenn ein [[Virtueller Controller VCCU|virtueller Controller]] verwendet wird, teilen sich diese IO-Devices die Kanäle.

'''Anlegen:'''

# IO-Device definieren
define <IO-Device> CUL_HM c0ffee
attr <IO-Device> model CCU-FHEM

# 4 IO-Entities definieren
set <IO-Device> virtual 4

=== Action Detector===
Einige Devices der HM-Geräteserie senden periodisch Nachrichten. Manche alle 3 Minuten, andere alle 3 Tage. Wenn so eine Zeit für ein Device spezifiziert ist, wird diese automatisch vom ActionDetector überwacht.<br>
Meist sind dies batteriebetriebene Geräte. Sollte aus irgendwelchen Gründen der Batteriealarm übersehen werden und das Gerät keine Nachricht mehr senden, wird es auf Dead gesetzt.
Die Kontrollinstanz ist ein Pseudo-Gerät "ActionDetector" mit der HMId "000000"

* attribut
** actCycle: gibt an, in welchen Abständen sich das Device melden muss
** actStatus: gibt den Zustand an
*** alive: Device hat sich in der erwarteten Zeit min einmal gemeldet
*** dead: Device hat sich in der erwarteten Zeit nicht gemeldet
*** unknown: Device hat sich nicht gemeldet, es ist aber seit dem letzten reboot die Zykluszeit noch nicht abgelaufen.

* readings
** Activity: entsprechend dem actStatus.

* get
** listDevice: Gibt alle Objekte zurück
** listDevice notActive: Gibt alle Objekte zurück die nicht "alive" sind
** listDevice alive: Gibt alle Objekte zurück die "alive" sind
** listDevice unknown: Gibt alle Objekte zurück die "unknown" sind
** listDevice dead: Gibt alle Objekte zurück die "dead" sind

Durch das Setzen des Attributs im HM device wird der ActionDetector automatisch definiert - nach einem save steht er auch in der fhem.cfg.
Alternativ ist auch eine manuelle Definition möglich und sollte in etwa so aussehen:

define ActionDetector CUL_HM 000000
attr ActionDetector actCycle 30
attr ActionDetector event-on-change-reading .*
attr ActionDetector model ActionDetector

Die HMId "000000" darf nicht geändert werden.

In der Entity actionDetector kann man die Infos gesammelt einsehen.
Der User kann durch das Setzen des Attributs actCycle jedes Device in diese Liste aufnehmen. Es wird dann geprüft, ob sich das Device in dieser Zeit auch meldet. Der User muss dies aber selbst sicherstellen.

== Tipps / HowTos / Beispiele ==

* [[HomeMatic Devices pairen|HM Devices pairen]] zum '''Pairen''' der Geräte untereinander.
* [[CUL]] (also gleichzeitig)?
* [[Slider für HM-Rolladensteuerung anzeigen]]
* Für den "Fall der Fälle": Erstellen Sie eine Liste aller HM-Geräte mit den Installationsorten, HM-Namen, FHEM-Namen '''und''' den Geräte-IDs. Falls Sie sich ihr FHEM einmal zerschießen, wird diese Liste sehr hilfreich sein. Zur Abwicklung von Gewährleistungsansprüchen sind Daten über Kaufdatum und Lieferant (bei größeren Installationen mit Zukauf in zeitlichen Abständen) ebenfalls angebracht.

== Probleme ==

=== Messages Sniffen ===
Um Probleme besser nachvollziehen zu können, kann man <u>[[Homematic_Nachrichten_sniffen|Nachrichten mitsniffen]]</u>

=== Daten können empfangen werden, Befehle werden nicht übertragen ===

Das kann mehrere Ursachen haben:
* Pairing nicht abgeschlossen (bei den ''Readings'' "PairedTo" bzw. "R-pairCentral" steht der Wert '''set_'''0x1A2B3C). Das Pairing ist erst dann erfolgreich abgeschlossen, wenn das '''set_''' fehlt, also nur noch (beispielhaft) "0x1A2B3C" steht. Siehe [[HomeMatic_Devices_pairen]]
* Sender (CUL/HM-LAN) und Empfänger (HM-Device) stehen zu nah (RSSI-Werte bei ~ "-17") beieinander
* Sender (CUL/HM-LAN) und Empfänger (HM-Device) stehen zu weit (RSSI-Werte bei unter ~ "-80") voneinander entfernt
* ...

=== Notifys und anderes funktionieren nach einem FHEM-Neustart nicht mehr oder nicht mehr zeitnah ===

Obwohl HomeMatic wegen der höheren Datenübertragungsrate wesentlich weniger von der [[1% Regel]] betroffen ist als z.B. FS20 oder FHT, so kann es dennoch zu Funkkontingentüberschreitungen kommen.

Insbesondere ist bei FHEM Versionen ab Oktober 2013 das Attribut ''autoReadReg'' auf "4_reqStatus" gesetzt. Damit wird für jedes HM-Device mit diesem so gesetzten Attribut beim FHEM-Start ein ''getConfig'' durchgeführt, was viel Funkverkehr erfordert.

Je nach Anzahl der Geräte kann es dazu kommen, dass insgesamt zu viel Funklast erzeugt wird - im Logfile erscheint dann eine Meldung wie:

2013.10.03 13:41:18 2: HMLAN_Parse: HMLAN1 new condition ERROR-Overload

Ab diesem Moment werden eben auch keine anderen Befehle mehr an weitere HM-Geräte geschickt, da das Funkkontingent aufgebraucht ist. Erst nach einer Stunde kann erneut gesendet werden. Als '''Notbehelf''' kann die Funkschnittstelle resetted oder ([[HMLAN Konfigurator]]) kurz stromlos gemacht werden. Dann wird der Zähler wieder auf Null gesetzt.

Alternativ können so viele HM-Geräte wie möglich auf ''autoReadReg 0_off'' gesetzt werden.

Siehe auch: [[1% Regel]]

=== Spannungsversorgung ===
Die Batterielebensdauer der HomeMatic Komponenten ist durchwachsen. Besonders die mitgelieferten Batterien sind mitunter schon nach wenigen Wochen leer, trotzdem werden öfters keine ''battery low'' Meldung erzeugt. Bei Störung des Funkverkehrs (z.B. blinkendes Antennensymbol im HM-CC-TC und kurzes Piepen zur vollen Stunde von morgens bis abends, fehlende ACK Meldungen, nicht auslösende IR-Bewegungssensoren und ähnliches) sollte also immer auch eine schlechte Spannungsversorgung in Betracht gezogen werden.

Gute neue Batterien halten jedoch i.d.R. 12 Monate und mehr, auch Lebensdauern über 2 Jahre sind bei einigen Geräten (Tür/Fensterkontakte, Sender, Retroanzeige, IR-Bewegungsmelder) keine Seltenheit.

== Links ==
* [http://www.homematic.com/ HomeMatic] Homepage
* Hersteller [http://www.eq-3.de eQ-3]

[[Kategorie:HomeMatic Components]]
[[Kategorie:Glossary]]

DOIF/uiTable

2018-01-03T22:30:25Z

50watt: /* Positionierung über die Matrixstruktur einer Tabelle */Tippfehler

Das DOIF-Attribut '''uiTable''' dient der Definition eines User Interface im Kontext von FHEMWEB.
Die Syntax ist in der Befehlsreferenz zu [https://fhem.de/commandref_DE.html#DOIF_uiTable uiTable] beschrieben und wird hier nicht behandelt.
An dieser Stelle werden Beispiele zur Gestaltung der '''uiTable''' gezeigt.

== Sensorauswahl mit WID und DOIF_Readings ==
{{Randnotiz|RNText=Besonderheiten
* funktionsloses DOIF <code>Sensorauswahl_Labor DOIF (1)</code>
* DOIF_Readings <code>showtemp:ReadingsVal([$SELF:sensorselect],"temperature","nix")</code>
* Aggregationsfunktion <code>[@":temperature":temperature]</code>
}}
[[Datei:Uitable_sensorauswahl.png|300px|thumb|right|Sensorauswahl mit Wertanzeige des ausgewählten Sensors]]
Im Auswahlfeld werden alle [[Gerät|Geräte]], die ein [[Readings|Reading]] '''temperature''' enthalten aufgelistet. Die Temperatur des gewählten [[Gerät|Gerätes]] wird angezeigt.

=== Beschreibung ===
<code>WID([$SELF:sensorselect],[@"":temperature])</code> legt in '''uiTable''' ein [[FHEMWEB/Widgets|Select-Widget]] für das [[Readings|Reading]] '''sensorselect''' an. Die Liste des [[FHEMWEB/Widgets|Widgets]] wird über die Aggregationsfunktion <code>[@":temperature":temperature]</code> erzeugt.
Über das [[Attribute|Attribut]] '''DOIF_Readings''' <code>showtemp:ReadingsVal([$SELF:sensorselect],"temperature","nix")</code> wird ein [[Readings|Reading]] '''showtemp''' mit der Temperatur des ausgewählten Sensors gesetzt.
In '''uiTable''' zeigt <code>[$SELF:showtemp]</code> den in '''showtemp''' enthaltenen Wert an.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang="perl">
defmod Sensorauswahl_Labor DOIF (1)
attr Sensorauswahl_Labor DOIF_Readings showtemp:ReadingsVal([$SELF:sensorselect],"temperature","nix" )
attr Sensorauswahl_Labor room DOIF_Labor
attr Sensorauswahl_Labor uiTable "Sensor auswählen"|"T/°C"\
WID([$SELF:sensorselect],[@":temperature":temperature])|[$SELF:showtemp]
</syntaxhighlight>

== Kombination von WID und STY zu einem Thermostat Widget ==
{{Randnotiz|RNText=Besonderheiten
* HTML-Elemente <code><div></div></code>
* CSS-Styleattribute <code>position</code>, <code>text-align</code>, <code>width</code>, <code>left</code>, <code>top</code>, <code>font-weight</code>, <code>font-size</code>, <code>color</code>
* uiTable Templates <code>$TPL{<name>}="<template content>"</code>
* uiTable Funktionen <code>WID([<device>:<reading>],<widget parameter>)</code>, <code>STY(<content>,<style attributes>)</code>
}}
[[Datei:Uitable_widget_kombi_thermostat.png|300px|thumb|right|Kombination von FHEMWEB-Widgets zu einem Thermostat-Widget]]
Das Thermostat Widget zeigt mit dem inneren Teilkreis die Isttemperatur an und mit dem äusseren Teilkreis wird die Solltemperatur gesetzt. Das obere Textfeld zeigt den Zahlenwert der Solltemperatur, der Untere den der Isttemperatur. Die Farbe, der Soll- und Isttemperatur ändert sich mit ihrem Wert.

=== Beschreibung der Kombination ===
'''uiTable''' ist tabellenförmig aufgebaut, in einer Tabellenzelle können mehrere Elemente kombiniert werden. Da zwei gleich große knob-Widgets übereinander liegen ist nur das obere Widget, die Solltemperatur, bedienbar.
Die Widgetkombination wird durch den folgenden Code-Auszug beschrieben.
<syntaxhighlight lang="perl">
$TPL{style2}="text-align:right;width:23px;position:absolute;left:13px;top:26px;font-weight:bold;font-size:12px;color:";
$TPL{style3}="text-align:right;width:23px;position:absolute;left:13px;top:13px;font-weight:bold;font-size:12px;color:";

$TPL{knob1}="knob,thickness:.4,fgColor:#00A5FF,min:7,max:30,width:50,height:50,step:.5,angleArc:270,angleOffset:225,displayInput:false";
$TPL{knob2}="knob,thickness:.3,fgColor:#FFA500,min:7,max:30,width:50,height:50,step:.5,angleArc:270,angleOffset:225,displayInput:false";

"<div style='position:relative;width:50px;height:50px'><div style='position:absolute;left:0px;top:0px'>".WID([HMdummy_Labor:measured-temp],$TPL{knob1})."</div><div style='position:absolute;left:0px;top:0px'>".WID([HMdummy_Labor:desired-temp],$TPL{knob2},"set")."</div>".STY([HMdummy_Labor:measured-temp:d1],$TPL{style2}.DOIF_hsv([HMdummy_Labor:measured-temp],7,25,240,360,100,100)).STY([HMdummy_Labor:desired-temp:d1],$TPL{style3}.DOIF_hsv([HMdummy_Labor:desired-temp],7,25,240,360,100,100))."</div>"</syntaxhighlight>

Mit style2, style3, knob1 und knob2 werden vier Templates gespeichert. Sie werden jeweils nur einmal verwendet, verkürzen aber die Tabellendefinition.
Die Templates knob1 und knob2 beschreiben die [[FHEMWEB/Widgets|Knob-Widgets]].
Die Templates style2 und style3 beschreiben die Textfelder für die Soll- und Isttemperatur durch die Angabe der entsprechenden CSS-Attribute.

==== Struktur der Kombination ====
Die Tabellenzelle wird mit div-Elementen nach folgenden Schema strukturiert.
<syntaxhighlight lang="html">
<div mit relativer Position zum Elternelement>
<div mit absoluter Position zum Elternelement> Knob-Widget Isttemperatur </div> unterste Ebene
<div mit absoluter Position zum Elternelement> Knob-Widget Solltemperatur </div>
<div mit absoluter Position zum Elternelement> Solltemperatur </div> in STY enthalten und beschrieben durch style3
<div mit absoluter Position zum Elternelement> Isttemperatur </div> in STY enthalten und beschrieben durch style2, oberste Ebene
</div>
</syntaxhighlight>
Mit <code>position:relative;width:50px;height:50px</code> wird das oberste div-Element in der Tabellenzelle positioniert. Durch die Verwendung des CSS-Attributes '''position''' wird das div-Element zum Bezugspunkt der nachfolgenden Elemente mit absoluter Positionsangabe.

==== Positionierung der FHEMWEB-Widgets ====
Mit <code>position:absolute;left:0px;top:0px</code> werden die das knob-Widget umschliessenden div-Elemente in die linke obere Ecke ihres Elternelementes positioniert.

==== Position und Format der Textanzeige ====
<code>position:absolute;left:13px;top:26px</code> positioniert das div-Element absolut zum Bezugspunkt, 13 Pixel nach rechts und 26 Pixel nach unten, von links oben aus.

<code>width:23px</code> legt die Breite des div-Elements auf 23 Pixel fest.

<code>font-weight:bold</code> formatiert den Text fett.

<code>font-size:12px</code> legt die Schriftgröße auf 12 Pixel fest.

<code>text-align:right</code> richtet den Text rechtsbündig aus.

==== Dynamische Farben ====
<code>color:#<berechnete Farbe></code> legt die Farbe fest.

Mit <code>$TPL{style2}.DOIF_hsv([HMdummy_Labor:measured-temp],7,25,240,360,100,100)</code> wird die Farbnummer an das Template '''style3'' angehängt.
Die Farbnummer wird mit der DOIF internen Funktion DOIF_hsv berechnet. Die Funktion wird mit den Parametern <laufender Wert>,<unterer Wert>,<oberer Wert>,<HUE-Startwert>,<HUE-Endwert>,<Farbsättigung>,<Hellwert> aufgerufen. Der laufende Wert ergibt sich aus dem [[Readings|Reading]] '''measured-temp''' des [[Gerät|Gerätes]] '''HMdummy_Labor'''.

=== Alternativ, die Nutzung von Methodentemplates ===
{{Randnotiz|RNText=Besonderheiten
* Methodentemplates definieren<code>DEF TPL_<name>(<template definition>)</code>
* Methodentemplates anwenden <code>TPL_<name>(<parameter1;,<parameter2;, ...)</code>
}}
Die Kombination wird als Template einer Methode angelegt. Damit wird die Tabellendefinition übersichtlicher und das Template kann mit anderen Parametern aufgerufen werden.

Das Template mit den Platzhaltern <syntaxhighlight lang="perl" inline>$1</syntaxhighlight> bis <syntaxhighlight lang="perl" inline>$4</syntaxhighlight>
<syntaxhighlight lang="perl">
DEF TPL_Thermostat("<div style='position:relative;width:50px;height:50px'><div style='position:absolute;left:0px;top:0px'>".WID($1,$TPL{knob1})."</div><div style='position:absolute;left:0px;top:0px'>".WID($2,$TPL{knob2},"set")."</div>".STY($3,$TPL{style2}.DOIF_hsv($1,7,25,240,360,100,100)).STY($4,$TPL{style3}.DOIF_hsv($2,7,25,240,360,100,100))."</div>")
</syntaxhighlight>
und die Definition des Widgets in der Tabelle mit vier Parametern in DOIF-Syntax.
<syntaxhighlight lang="perl">
TPL_Thermostat([HMdummy_Labor:measured-temp],[HMdummy_Labor:desired-temp],[HMdummy_Labor:measured-temp:d1],[HMdummy_Labor:desired-temp:d1])</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] (nur das Attribut uiTable) ===
<syntaxhighlight lang="perl">
attr widgetkombi_Labor uiTable {\
$TPL{style2}="text-align:right;;width:23px;;position:absolute;;left:13px;;top:26px;;font-weight:bold;;font-size:12px;;color:";;\
$TPL{style3}="text-align:right;;width:23px;;position:absolute;;left:13px;;top:13px;;font-weight:bold;;font-size:12px;;color:";;\
\
$TPL{knob1}="knob,thickness:.4,fgColor:#00A5FF,min:7,max:30,width:50,height:50,step:.5,angleArc:270,angleOffset:225,displayInput:false";;\
$TPL{knob2}="knob,thickness:.3,bgColor:#808080,fgColor:#FFA500,min:7,max:30,width:50,height:50,step:.5,angleArc:270,angleOffset:225,displayInput:false";;\
}\
\
DEF TPL_Thermostat("<div style='position:relative;;width:50px;;height:50px'><div style='position:absolute;;left:0px;;top:0px'>".WID($1,$TPL{knob1})."</div><div style='position:absolute;;left:0px;;top:0px'>".WID($2,$TPL{knob2},"set")."</div>".STY($3,$TPL{style2}.DOIF_hsv($1,7,25,240,360,100,100)).STY($4,$TPL{style3}.DOIF_hsv($2,7,25,240,360,100,100))."</div>")\
\
WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable,disabled")\
\
TPL_Thermostat([HMdummy_Labor:measured-temp],[HMdummy_Labor:desired-temp],[HMdummy_Labor:measured-temp:d1],[HMdummy_Labor:desired-temp:d1])</syntaxhighlight>

== Kombination von WID und STY zum Festlegen zweier Grenzwerte ==
[[Datei:Uitable_widget_kombi_grenzwert.png|100px|right]]
Die Kombination ist so angelegt, dass beide Widgets bedienbar sind.
Es wird jeweils ein Reading durch ein Widget gesetzt.

=== Positionierung der knob-Widgets ===
Die Widget sind unterschiedlich groß.
<syntaxhighlight lang=perl>
$TPL{knob1}="... width:50,height:50 ..."
$TPL{knob2}="... width:38,height:38 ..."
</syntaxhighlight>
Daher muss '''knob2''' 6px nach rechts und unten positioniert werden.
<syntaxhighlight lang=html><div style='... left:6px;;top:6px'></syntaxhighlight>
Damit wird erreicht, dass beide Widgets bedienbar bleiben.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang=perl>
defmod widgetkombi2_Labor DOIF (1)
attr widgetkombi2_Labor group Labor: uiTable
attr widgetkombi2_Labor room DOIF_Labor
attr widgetkombi2_Labor uiTable {\
$TPL{style2}="text-align:center;;width:23px;;position:absolute;;left:13px;;top:13px;;font-weight:bold;;font-size:12px;;color:red";;\
$TPL{style3}="text-align:center;;width:23px;;position:absolute;;left:13px;;top:26px;;font-weight:bold;;font-size:12px;;color:blue";;\
\
$TPL{knob1}="knob,thickness:.23,bgColor:lightgrey,fgColor:#FF0000,min:0,max:100,width:50,height:50,step:1,angleArc:270,angleOffset:225,displayInput:false,cursor:1,lineCap:round";;\
$TPL{knob2}="knob,thickness:.32,bgColor:#808080,fgColor:#0000FF,min:0,max:100,width:38,height:38,step:1,angleArc:270,angleOffset:225,displayInput:false,cursor:1,lineCap:round";;\
}\
\
"<div style='position:relative;;width:50px;;height:50px'><div style='position:absolute;;left:px;;top:0px'>".WID([$SELF:obererGrenzwert],$TPL{knob1})."</div><div style='position:absolute;;left:6px;;top:6px'>".WID([$SELF:untererGrenzwert],$TPL{knob2})."</div>".STY([$SELF:obererGrenzwert],$TPL{style2}).STY([$SELF:untererGrenzwert],$TPL{style3})."</div>"

setstate widgetkombi2_Labor initialized
setstate widgetkombi2_Labor 2017-10-25 11:20:15 cmd 0
setstate widgetkombi2_Labor 2017-10-25 11:55:42 obererGrenzwert 87
setstate widgetkombi2_Labor 2017-10-25 11:20:15 state initialized
setstate widgetkombi2_Labor 2017-10-25 11:55:45 untererGrenzwert 10
</syntaxhighlight>

== FHEM-Befehl mit Icon und Text-Overlay ==
{{Randnotiz|RNText=Besonderheiten
* HTML-Elemente <code><a></a></code>
* Link-Attribute <code>target</code>, <code>href</code>, <code>title</code>
* uiTable Formatierung einer Tabellenzelle <code>$TD{row}{col}="<HTML-Attribute>"</code>
* CSS-Attribute , <code>background-color</code>
* FHEMWEB-Funktion <code>FW_makeImage(<image name>)</code>
* FHEMWEB-Variablen <code>$FW_ME</code>, <code>$FW_CSRF</code>
}}
[[Datei:Uitable_widget_cmdlink_icon_text.png|300px|thumb|right|Befehlslink mit Icon, Text und Hinweistext]]
Mit dieser Widgetkombination wird ein FHEM-Befehl als Link in eine Tabellenzelle der '''uiTable''' eingefügt. Als Linktext wird ein Icon eingebunden und ein Text über das Icon positioniert. Der Link enthält einen Hinweistext. Siehe auch {{Link2Forum|Topic=80835|Message=729002|LinkText=Link mit Icon und FHEM-Befehl}} ff.
=== Beschreibung ===
Mit <code>$TD{0}{0}="style='position:relative'";</code> wird die oberste linke Zelle als der Bezugspunkt für die Textpositionierung festgelegt. Als erstes wird der der Link mit dem a-Element angelegt. Mit dem Attribut <code>target='_blank'</code> erfolgt die Ausgabe der aufgerufenen Seite in einem neuen Browser-Tab. Die URL wird in dem Attribut <code>href='$FW_ME?detail=$SELF&cmd.$SELF=list $SELF$FW_CSRF' title='list $SELF'</code> angegeben. Darin liefert <code>$FW_ME</code> den Webnamen von FHEM, <code>$SELF</code> den Eigennamen des DOIF, und <code>$FW_CSRF</code> das aktuelle CSRF-Token. Das Attribut <code>title='list $SELF'</code> gibt den Hinweistext an. Als Linktext liefert die Funktion <code>FW_makeImage("time_note\@lightblue")</code> den HTML-code zum Anzeigen des Icons, dabei beschreibt <code>"time_note\@lightblue"</code> den Iconnamen und die Einfärbung des Icons. Auch der über das Icon gelegte Text gehört zum Linktext, er wird aber durch die Positionsangaben <code>style='position:absolute; left:12px; top:20px;</code> auf das Icon geschoben. Die Angaben <code>font-size:12px; background-color:lightblue; color:darkred;</code> dienen der Formatierung des Textes.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===

<syntaxhighlight lang="perl">
defmod widget_cmdlink_icon_text DOIF (1)
attr widget_cmdlink_icon_text group Labor: uiTable
attr widget_cmdlink_icon_text room DOIF_Labor,DOIFalone
attr widget_cmdlink_icon_text uiTable {\
$TD{0}{0}="style='position:relative'";;\
}\
\
"<a target='_blank' href='$FW_ME?cmd.$SELF=list $SELF$FW_CSRF' title='list $SELF'>".FW_makeImage("time_note\@lightblue")."<div style='position:absolute;; left:12px;; top:20px;; font-size:12px;; background-color:lightblue;; color:darkred'>list</div></a>"\
</syntaxhighlight>

== Frontendelemente über einem Hintergrund (Grundriss) platzieren ==
{{Randnotiz|RNText=Besonderheiten
* Formatierung des table-Element <code>$TABLE</code>
* CSS-Attribute <code>background-image:url</code>, <code>background-size</code>, <code>text-align:center</code>
* HTML Zeilenumbruch <code><br></code>, Leerzeichen <code>&nbsp;</code>
}}
[[Datei:Grundriss1.png|300px|thumb|right|Positionierung von Text und Widget auf einem Hintergrundbild]]
In diesem Beispiel wird ein Hintergundbild geladen und das Bild mit Widgets und Text beschriftet.
Dem table-Element der uiTable wird über <code>$TABLE = "CSS-Attribute";</code> eine Formatierung zugewiesen. Die Formatierung beinhaltet das Laden eine Hintergrundbildes mit <code>background-image:url($FW_ME/www/pgm2/images/Grundriss.svg);</code>.
=== Positionierung über die Matrixstruktur einer Tabelle ===
Durch die Formatierung <code>text-align:center</code> wird der Zelleninhalt zentriert. Die Positionierung von Text und Widget, die Verschiebung aus der Mitte der Zelle, erfolgt durch Zeilenumbruch <code><br></code> und Leerzeichen <code>&nbsp;</code>. Da Text und Widget in der Tabellenzelle durch ein Komma getrennt werden, erfolgt dort ein Zeilenumbruch.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
Das Beispiel funktioniert nur, wenn das Hintergrundbild in das Verzeichnis <code>/www/pgm2/images/</code> gespeichert wird.

* Download von [[Medium:Grundriss.svg|Grundriss.svg]].
<syntaxhighlight lang="perl">
defmod Grundriss_Labor DOIF (1)
attr Grundriss_Labor group Labor: uiTable
attr Grundriss_Labor room DOIF_Labor
attr Grundriss_Labor uiTable {\
$TABLE = " text-align:center;;width:300px;; height:300px;; background-image:url($FW_ME/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TR{1,3} = "class=''";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
"Schlafen",WID([$SELF:SZ],$TPL{switch})|"Küche",WID([$SELF:Kue],$TPL{switch})|" Bad ; ; ;",WID([$SELF:Bad],$TPL{switch})\
" "|" "|" Diele ",WID([$SELF:Diele],$TPL{switch})\
"Wohnen A",WID([$SELF:WZ1],$TPL{switch})|" ;<br>Kind ",WID([$SELF:Ki],$TPL{switch})|" "\
"Wohnen B",WID([$SELF:WZ2],$TPL{switch})|" ;<br>Balkon ; ; ;",WID([$SELF:Balkon],$TPL{switch})|" "

setstate Grundriss_Labor initialized
setstate Grundriss_Labor 2017-11-04 07:45:28 Bad off
setstate Grundriss_Labor 2017-11-04 07:45:22 Balkon off
setstate Grundriss_Labor 2017-11-04 07:45:28 Diele off
setstate Grundriss_Labor 2017-11-04 07:45:42 Ki on
setstate Grundriss_Labor 2017-11-04 18:47:30 Kue on
setstate Grundriss_Labor 2017-11-04 18:47:31 SZ on
setstate Grundriss_Labor 2017-11-04 07:45:46 WZ1 on
setstate Grundriss_Labor 2017-11-04 07:45:23 WZ2 off
setstate Grundriss_Labor 2017-11-04 19:10:03 cmd 0
setstate Grundriss_Labor 2017-11-04 19:10:03 state initialized
</syntaxhighlight>

=== Alternativ, freie Positionierung von Text und Widgets ===
{{Randnotiz|RNText=Besonderheiten
* Festlegen des Positionierungsbezugspunktes mit <code>position:relative;</code>
* Positionierung der Frontendelemente mit <code>position:absolute; Left:<Pixel nach rechts>px; top:<Pixel nach unten>px;</code>
* Verwendung nur einer Tabellenzelle
}}
[[Datei:Grundriss2.png|300px|thumb|right|Absolute Positionierung]]Widgets und Texte werden auf dem Hintergrundbild durch Angabe ihrer absoluten Position zur linken oberen Ecke der Tabelle, bzw. des Hintergrundbilder positioniert. Die Positionierung kann pixelgenau angegeben werden.

Der gesamte Text und die Widgets werden nur in einer Tabellenzelle platziert. Die linke obere Ecke der Tabelle wird mit <code>position:relative;</code> zum Bezugspunkt. Die zu positionierenden Elemente werden mit <code>position:absolute; Left:<Pixel nach rechts>px; top:<Pixel nach unten>px;</code> platziert. Text u. Widget sind von einem div-Element umschlossen, so dass sie als Einheit positioniert werden können.

Die Definition des [[Attribute|Attributes]] '''uiTable''' mit absoluten Positionsangaben.
<syntaxhighlight lang="perl">
{
$TABLE = "font-size:10pt;position:relative; text-align:center;width:300px; height:300px; background-image:url($FW_ME/www/pgm2/images/Grundriss.svg); background-size: 300px 300px;";
$TPL{switch}="iconSwitch,on,off,off,on";
}

"<div style='position:absolute; left:35px; top:25px;'>Schlafen",WID([$SELF:SZ],$TPL{switch})."</div>
<div style='position:absolute; left:145px; top:25px;'>Küche",WID([$SELF:Kue],$TPL{switch})."</div>
<div style='position:absolute; left:225px; top:25px;'>Bad",WID([$SELF:Bad],$TPL{switch})."</div>
<div style='position:absolute; left:145px; top:105px;'>Diele ".WID([$SELF:Diele],$TPL{switch})."</div>
<div style='position:absolute; left:35px; top:160px;'>Wohnen A",WID([$SELF:WZ1],$TPL{switch})."</div>
<div style='position:absolute; left:35px; top:220px;'>Wohnen B",WID([$SELF:WZ2],$TPL{switch})."</div>
<div style='position:absolute; left:145px; top:160px;'>Kind",WID([$SELF:Ki],$TPL{switch})."</div>
<div style='position:absolute; left:145px; top:250px;'>Balkon",WID([$SELF:Balkon],$TPL{switch})."</div>"</syntaxhighlight>

=== Beispiel 1 für [[Import_von_Code_Snippets|Raw definition]] ===
In diesem Beispiel wurde gegenüber dem vorhergehenden Beispiel nur die Definiton des [[Attribute|Attributes]] '''uiTable''' geändert.
<syntaxhighlight lang="perl">
defmod Grundriss_position_Labor DOIF (1)
attr Grundriss_position_Labor group Labor: uiTable
attr Grundriss_position_Labor room DOIF_Labor
attr Grundriss_position_Labor uiTable {\
$ATTRIBUTESFIRST = 1;;\
$TABLE = "font-size:10pt;;position:relative;; text-align:center;;width:300px;; height:300px;; background-image:url($FW_ME/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
"<div style='position:absolute;; Left:35px;; top:25px;;'>Schlafen",WID([$SELF:SZ],$TPL{switch})."</div>\
<div style='position:absolute;; Left:145px;; top:25px;;'>Küche",WID([$SELF:Kue],$TPL{switch})."</div>\
<div style='position:absolute;; Left:225px;; top:25px;;'>Bad",WID([$SELF:Bad],$TPL{switch})."</div>\
<div style='position:absolute;; Left:145px;; top:105px;;'>Diele ".WID([$SELF:Diele],$TPL{switch})."</div>\
<div style='position:absolute;; Left:35px;; top:160px;;'>Wohnen A",WID([$SELF:WZ1],$TPL{switch})."</div>\
<div style='position:absolute;; Left:35px;; top:220px;;'>Wohnen B",WID([$SELF:WZ2],$TPL{switch})."</div>\
<div style='position:absolute;; Left:145px;; top:160px;;'>Kind",WID([$SELF:Ki],$TPL{switch})."</div>\
<div style='position:absolute;; Left:145px;; top:250px;;'>Balkon",WID([$SELF:Balkon],$TPL{switch})."</div>"

setstate Grundriss_position_Labor initialized
setstate Grundriss_position_Labor 2017-11-05 14:39:22 Bad off
setstate Grundriss_position_Labor 2017-11-05 14:38:46 Balkon off
setstate Grundriss_position_Labor 2017-11-05 14:39:30 Diele off
setstate Grundriss_position_Labor 2017-11-04 21:30:27 Ki on
setstate Grundriss_position_Labor 2017-11-05 14:39:28 Kue on
setstate Grundriss_position_Labor 2017-11-05 14:39:27 SZ off
setstate Grundriss_position_Labor 2017-11-05 14:38:43 WZ1 off
setstate Grundriss_position_Labor 2017-11-04 21:30:29 WZ2 on
setstate Grundriss_position_Labor 2017-11-04 21:29:59 cmd 0
setstate Grundriss_position_Labor 2017-11-04 21:29:59 state initialized
</syntaxhighlight>

=== Beispiel 2 für [[Import_von_Code_Snippets|Raw definition]], mit Methodentemplate ===
In diesem Beispiel wurde gegenüber dem vorhergehenden Beispiel nur die Definiton des [[Attribute|Attributes]] '''uiTable''' geändert.
In dieser Variante wird ein Methodentemplate für das Objekt aus Text und Widget verwendet.
<syntaxhighlight lang="perl">
defmod Grundriss_position_Labor DOIF (1)
attr Grundriss_position_Labor group Labor: uiTable
attr Grundriss_position_Labor room DOIF_Labor
attr Grundriss_position_Labor uiTable {\
$ATTRIBUTESFIRST = 1;;\
$TABLE = "font-size:10pt;;position:relative;; text-align:center;;width:300px;; height:300px;; background-image:url(./fhem/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
DEF TPL_Objekt("<div style='position:absolute;; Left:".$1."px;; top:".$2."px;;'>".$3.WID($4,$TPL{switch})."</div>")\
\
TPL_Objekt("35","25","Schlafen<br>",[$SELF:SZ])|\
TPL_Objekt("145","25","Küche<br>",[$SELF:Kue])|\
TPL_Objekt("225","25","Bad<br>",[$SELF:Bad])|\
TPL_Objekt("145","105","Diele ",[$SELF:Diele])|\
TPL_Objekt("35","160","Wohnen A<br>",[$SELF:WZ1])|\
TPL_Objekt("35","220","Wohnen B<br>",[$SELF:WZ2])|\
TPL_Objekt("145","160","Kind<br>",[$SELF:Ki])|\
TPL_Objekt("145","250","Balkon<br>",[$SELF:Balkon])

setstate Grundriss_position_Labor initialized
setstate Grundriss_position_Labor 2017-11-05 14:39:22 Bad off
setstate Grundriss_position_Labor 2017-11-05 14:38:46 Balkon off
setstate Grundriss_position_Labor 2017-11-05 14:39:30 Diele off
setstate Grundriss_position_Labor 2017-11-04 21:30:27 Ki on
setstate Grundriss_position_Labor 2017-11-05 14:39:28 Kue on
setstate Grundriss_position_Labor 2017-11-05 14:39:27 SZ off
setstate Grundriss_position_Labor 2017-11-05 14:38:43 WZ1 off
setstate Grundriss_position_Labor 2017-11-04 21:30:29 WZ2 on
setstate Grundriss_position_Labor 2017-11-04 21:29:59 cmd 0
setstate Grundriss_position_Labor 2017-11-04 21:29:59 state initialized

</syntaxhighlight>

== Icon mit animierter Füllung ==
{{Randnotiz|RNText=Besonderheiten
* benutzerdefinierte Perl-Funktion <code>sub FUNC_<name>{<Funktionsblock>}</code>
* CSS-Attribute <code>linear-gradient</code>
* RGB-Farbangabe mit α-Kanal <code>rgba(<rotwert>,<grünwert>,<blauwert>,<transparenzwert>)</code>
}}
[[Datei:uiTable_gradiend_Labor.png|300px|thumb|right|Icon mit animierter Füllung]]
Das Icon für eine Zisterne wird mit einem veränderlichen Hintergrund angezeigt, der den Füllstand darstellt.

=== Aufbau der Kombination ===
Der Zelleninhalt hat folgende Struktur.
<syntaxhighlight lang="html">
<div Bezugspunkt>
<div dynamischer Gradiend untere Ebene></div>
<div obere Ebene mit SVG als Inhalt>SVG</div>
</div>
</syntaxhighlight>
Der Bezugspunkt und die Größe wird mit <syntaxhighlight lang="perl" inline>"<div style='width:32px;height:35px;position:relative;'>"</syntaxhighlight> angegeben.

Die untere Ebene wird durch <code>STY</code> beschrieben, der Inhalt wird durch <code>FUNC_zisterne([HMdummy_Labor:level])</code> erzeugt, die Formatierung erfolgt über
<code>"positon:absolute;left:0px;top:0px;"</code>.

Die obere Ebene wird durch das div-Element <syntaxhighlight lang="perl" inline>"<div style='position:absolute;left:0px;top:0px;'>".FW_makeImage('zisterne')."</div>"</syntaxhighlight> beschrieben, wobei der Inhalt, das Icon, durch die Funktion <code>FW_makeImage('zisterne')</code> zurückgegeben wird.

Die selbst definierte Funktion <code>FUNC_zisterne</code> gibt ein div-Element zurück, dass die Form der Füllung des Icons, die Richtung der Füllung <code>to top</code> mit der Position der Farbgrenze <code>rgba(0,0,230,0.5) ($val*24/100)px, rgba(0,0,0,0) ($val*24/100)px);</code> durch den <code>linear-gradient</code> festlegt.

Durch ein Verschieben der Farbgrenze über den Wert des [[Readings]] <code>HMdummy_Labor:level</code>, wird die Füllhöhe animiert.

Die Füllhöhe der Zisterne (0-100) wird umgerechnet auf die Füllhöhe des Icons (0px-24px) mit <code>$val*24/100</code>, dabei ist <code>$val</code> die aktuelle Füllhöhe der Zisterne, dargestellt durch das [[Readings|Reading]] <code>HMdummy_Labor:level</code>

=== Die Definition des [[Attribute|Attributes]] '''uiTable''' mit absoluten Positionsangaben ===
<syntaxhighlight lang="perl">
{
sub FUNC_zisterne {
my($val)= @_;
my $ret= "<div style=\"position:absolute;bottom:3px;left:6px;width:20px;height:24px;background:linear-gradient( to top, rgba(0,0,230,0.5) ".($val*24/100)."px, rgba(0,0,0,0) ".($val*24/100)."px);\"></div>";
return $ret;
}
}

WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable")

"<div style='width:32px;height:35px;position:relative;'>".STY(FUNC_zisterne([HMdummy_Labor:level]),"positon:absolute;left:0px;top:0px;")."<div style='position:absolute;left:0px;top:0px;'>".FW_makeImage('zisterne')."</div>"
</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
Das Beispiel funktioniert nur, wenn das Icon '''zisterne.svg''' in ein Verzeichnis unterhalb von <code>/www/images/</code> gespeichert wird.

* Download von [[Medium:zisterne.svg|zisterne.svg]].
<syntaxhighlight lang="perl">
defmod gradiend_Labor DOIF (1) ## HMsensor_Labor HMdummy_Labor
attr gradiend_Labor group Labor: uiTable
attr gradiend_Labor room DOIF_Labor,DOIFalone
attr gradiend_Labor uiTable {\
sub FUNC_zisterne {\
my($val)= @_;;\
my $ret= "<div style=\"position:absolute;;bottom:3px;;left:6px;;width:20px;;height:24px;;background:linear-gradient( to top, rgba(0,0,230,0.5) ".($val*24/100)."px, rgba(0,0,0,0) ".($val*24/100)."px);;\"></div>";;\
return $ret;;\
}\
}\
\
WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable")\
\
"<div style='width:32px;;height:35px;;position:relative;;'>".STY(FUNC_zisterne([HMdummy_Labor:level]),"positon:absolute;;left:0px;;top:0px;;")."<div style='position:absolute;;left:0px;;top:0px;;'>".FW_makeImage('zisterne')."</div>"

defmod HMdummy_Labor dummy
attr HMdummy_Labor group Labor: uiTable
attr HMdummy_Labor room DOIF_Labor
attr HMdummy_Labor userReadings desired-temp {ReadingsNum($name,"state",7)}

defmod HMsensor_Labor DOIF ([+1])\
(setreading HMdummy_Labor measured-temp {(if ([HMdummy_Labor:measured-temp] < [HMdummy_Labor:desired-temp]){[HMdummy_Labor:measured-temp]+.5} else {7})},\
setreading HMdummy_Labor level {(if ([HMdummy_Labor:level] < 100){[HMdummy_Labor:level]+5} else {0})})
attr HMsensor_Labor do always
attr HMsensor_Labor group Labor: uiTable
attr HMsensor_Labor room DOIF_Labor
attr HMsensor_Labor webCmd enable:disable

setstate HMdummy_Labor desired-temp 29
setstate HMdummy_Labor 2017-11-08 23:34:23 desired-temp 29
setstate HMdummy_Labor 2017-11-08 23:34:23 level 75
setstate HMdummy_Labor 2017-11-08 23:34:23 measured-temp 27
setstate HMdummy_Labor 2017-11-06 12:04:39 state desired-temp 29

setstate HMsensor_Labor disabled
setstate HMsensor_Labor 2017-11-08 23:34:23 cmd 1
setstate HMsensor_Labor 2017-11-08 23:34:23 cmd_event timer_1
setstate HMsensor_Labor 2017-11-08 23:34:23 cmd_nr 1
setstate HMsensor_Labor 2017-11-08 23:34:23 last_cmd cmd_1
setstate HMsensor_Labor 2017-11-08 23:34:23 mode disabled
setstate HMsensor_Labor 2017-11-08 23:34:23 state disabled
setstate HMsensor_Labor 2017-11-08 23:54:37 timer_01_c01 08.11.2017 23:54:38

setstate gradiend_Labor initialized
setstate gradiend_Labor 2017-11-08 23:35:44 cmd 0
setstate gradiend_Labor 2017-11-08 23:35:44 state initialized

</syntaxhighlight>

== Ladezustand als vertikaler, linearer Gradiend ==
{{Randnotiz|RNText=Besonderheiten
* benutzerdefinierte Perl-Funktion <code>sub FUNC_<name>{<Funktionsblock>}</code>
* uiTable-Funktion <code>STY</code>
* CSS-Attribute <code>linear-gradient</code>,<code>border-style</code>,<code>border-width</code>,<code>border-color</code>
* RGB-Farbangabe mit α-Kanal <code>rgba(<rotwert>,<grünwert>,<blauwert>,<transparenzwert>)</code>
}}
[[Datei:uiTable_verticalGradient.png|height 100px|thumb|right|Vertikaler Gradiend mit animierter Überlagerung]]
Der farbige Gradiend (rot, gelb, grün von unten nach oben) wird zu dem Teil abgedeckt, welcher der Ergänzung des Ladezustandes zu 100 entspricht.

=== Aufbau der Kombination ===
Der Zelleninhalt hat folgende Struktur.
<syntaxhighlight lang="html">
<div Bezugspunkt und statischer Gradiend (rot,gelb,grün) als Hintergrung>
<div untere Ebene dynamischem Gradienten></div>
<div obere Ebene mit Wert als Inhalt>Wert</div>
</div>
</syntaxhighlight>
Der Bezugspunkt, die Größe, der Rahmen und der statische Gradiend wird mit <syntaxhighlight lang="html" inline><div style='border-width:2px;border-style:solid;border-color:gray;position:relative;width:25px;height:100px;background:linear-gradient( to top, red 0px,yellow 50px,green 100px);'></syntaxhighlight> festgelegt.

Der dynamische Gradiend wird durch die benutzerdefinierte Funktion <code>FUNC_batt</code> zurückgegeben, <code>(100-$val)</code> berechnet den abzudeckenden Teil des rot, gelb, grünen Gradienten.

Durch <code>STY([HMdummy_Labor:level]."%","font-size:9px;position:absolute;top:45px;right:1px")</code> wird der Wert positioniert und angezeigt.

=== Die Definition des [[Attribute|Attributes]] '''uiTable''' mit absoluten Positionsangaben ===
<syntaxhighlight lang="perl">
{
$TD{0}{0}=" colspan=2 ";
sub FUNC_batt {
my($val)=@_;
my $ret="position:absolute;left:0px;width:25px;height:100px;background:linear-gradient( to bottom,#F8F8E0 ".(100-$val)."px,rgba(0,0,0,0) ".(100-$val)."px);";
return $ret;
}
sub FUNC_batt2 {
my($val)=@_;
my $ret="position:absolute;left:9px;top:6px;width:14px;height:27px;background:linear-gradient( to bottom,#F8F8E0 ".(100-$val)."%,rgba(0,0,0,0) ".(100-$val)."%);";
return $ret;
}
}
WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable")

"<div style='border-width:2px;border-style:solid;border-color:gray;position:relative;width:25px;height:100px;background:linear-gradient( to top, red 0px,yellow 50px,green 100px);'>".STY(" ",FUNC_batt([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:9px;position:absolute;top:45px;right:1px")."</div>"|
"<div style='position:relative'>
<div style='position:absolute;left:9px;top:6px;width:14px;height:27px;background:linear-gradient( to top, red 0%,yellow 50%,green 100%);'></div>
".STY(" ",FUNC_batt2([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:6px;position:absolute;top:15px;left:10px").STY(FW_makeImage("measure_battery_0"))."</div>"</syntaxhighlight>

Die Anwendung des Anwendung der überlagerten Gradienten auf ein Batterieicon wird durch den nachstehenden Codeteil erzeugt.
<syntaxhighlight lang="perl">
"<div style='position:relative'>
<div style='position:absolute;left:9px;top:6px;width:14px;height:27px;background:linear-gradient( to top, red 0%,yellow 50%,green 100%);'></div>
".STY(" ",FUNC_batt2([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:6px;position:absolute;top:15px;left:10px").STY(FW_makeImage("measure_battery_0"))."</div>"</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang="perl">
defmod verticalGradiend_Labor DOIF (1) ## HMsensor_Labor HMdummy_Labor
attr verticalGradiend_Labor group Labor: uiTable
attr verticalGradiend_Labor room DOIF_Labor
attr verticalGradiend_Labor uiTable {\
$TD{0}{0}=" colspan=2 ";;\
sub FUNC_batt {\
my($val)=@_;;\
my $ret="position:absolute;;left:0px;;width:25px;;height:100px;;background:linear-gradient( to bottom,#F8F8E0 ".(100-$val)."px,rgba(0,0,0,0) ".(100-$val)."px);;";;\
return $ret;;\
}\
sub FUNC_batt2 {\
my($val)=@_;;\
my $ret="position:absolute;;left:9px;;top:6px;;width:14px;;height:27px;;background:linear-gradient( to bottom,#F8F8E0 ".(100-$val)."%,rgba(0,0,0,0) ".(100-$val)."%);;";;\
return $ret;;\
}\
}\
WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable")\
\
"<div style='border-width:2px;;border-style:solid;;border-color:gray;;position:relative;;width:25px;;height:100px;;background:linear-gradient( to top, red 0px,yellow 50px,green 100px);;'>".STY(" ",FUNC_batt([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:9px;;position:absolute;;top:45px;;right:1px")."</div>"|\
"<div style='position:relative'>\
<div style='position:absolute;;left:9px;;top:6px;;width:14px;;height:27px;;background:linear-gradient( to top, red 0%,yellow 50%,green 100%);;'></div>\
".STY(" ",FUNC_batt2([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:6px;;position:absolute;;top:15px;;left:10px").STY(FW_makeImage("measure_battery_0"))."</div>"

defmod HMdummy_Labor dummy
attr HMdummy_Labor group Labor: uiTable
attr HMdummy_Labor room DOIF_Labor
attr HMdummy_Labor userReadings desired-temp {ReadingsNum($name,"state",7)}

defmod HMsensor_Labor DOIF ([+1])\
(setreading HMdummy_Labor measured-temp {(if ([HMdummy_Labor:measured-temp] < [HMdummy_Labor:desired-temp]){[HMdummy_Labor:measured-temp]+.5} else {7})},\
setreading HMdummy_Labor level {(if ([HMdummy_Labor:level] < 100){[HMdummy_Labor:level]+5} else {0})})
attr HMsensor_Labor do always
attr HMsensor_Labor group Labor: uiTable
attr HMsensor_Labor room DOIF_Labor
attr HMsensor_Labor webCmd enable:disable

setstate HMdummy_Labor desired-temp 29
setstate HMdummy_Labor 2017-11-10 12:36:07 desired-temp 29
setstate HMdummy_Labor 2017-11-10 12:36:07 level 85
setstate HMdummy_Labor 2017-11-10 12:36:07 measured-temp 28
setstate HMdummy_Labor 2017-11-06 12:04:39 state desired-temp 29

setstate HMsensor_Labor disabled
setstate HMsensor_Labor 2017-11-10 12:36:07 cmd 1
setstate HMsensor_Labor 2017-11-10 12:36:07 cmd_event timer_1
setstate HMsensor_Labor 2017-11-10 12:36:07 cmd_nr 1
setstate HMsensor_Labor 2017-11-10 12:36:07 last_cmd cmd_1
setstate HMsensor_Labor 2017-11-10 12:36:07 mode disabled
setstate HMsensor_Labor 2017-11-10 12:36:07 state disabled
setstate HMsensor_Labor 2017-11-10 13:26:42 timer_01_c01 10.11.2017 13:26:43

setstate verticalGradiend_Labor initialized
setstate verticalGradiend_Labor 2017-11-09 08:59:32 cmd 0
setstate verticalGradiend_Labor 2017-11-09 08:59:32 state initialized
</syntaxhighlight>

== Abwechselnde Anzeige zweier Größen an gleicher Position ==
{{Randnotiz|RNText=Besonderheiten
* HTML-Attribute <code>class</code>
* CSS-Datei und Attribute <code>@keyframes</code>, <code>animation</code>, <code>overflow</code>, <code>opacity</code>, <code>height</code>
}}
[[Datei:UiTable_swapValues1.png|height 100px|thumb|right|Feuchte als erste Größe]][[Datei:Uitable_swapValues2.png|height 100px|thumb|right|Temperatur als zweite Größe]]

Die Größen Feuchte und Temperatur werden abwechselnd angezeigt

=== Aufbau der Kombination ===
Der Zelleninhalt hat folgende Struktur.
<syntaxhighlight lang="html">
<div 1. Klasse mit Wert als Inhalt>Wert</div>
<div 2. Klasse mit Wert als Inhalt>Wert</div>
</syntaxhighlight>

=== Die Definition des [[Attribute|Attributes]] '''uiTable''' ===
<syntaxhighlight lang="perl">
"<div class='humchange' >".STY([$SELF:humidity],"font-size:16pt;font-weight:bold;color:red;")." relH%</div>
<div class='tempchange' >".STY([$SELF:temperature:d1],"font-size:16pt;font-weight:bold;color:blue;")."°C</div>"
</syntaxhighlight>

=== Die dazu gehörende CSS-Definition ===
Damit die Wechselnde Anzeige funktioniert, muss die Definition in eine Datei kopiert werden, die Dateiendung muss ''css'' sein (uitable_changer.css). Die Datei ist in das Verzeichniss ./pgm2 zu kopieren. Sie muss dann über das FHEMWEB-Attribut <code>attr <fhemwebname> CssFiles pgm2/uitable_changer.css</code> eingebunden werden.

<syntaxhighlight lang="css">
div.humchange {
opacity: 0;
height: 0;
overflow: hidden;
animation: humidity 15s infinite ease-in;
}
div.tempchange {
opacity: 1
height: auto;
overflow: hidden;
animation: temperature 15s infinite ease-in;
}

@keyframes humidity {
0% {
opacity: 0;
height: auto;
}
0.001% {
opacity: 0;
height: auto;
}
5% {
opacity: 1;
height: auto;
}
45% {
opacity: 1;
height: auto;
}
49.999% {
opacity: 0;
height: auto;
}
50% {
opacity: 0;
height: 0;
}
100% {
opacity: 0;
height: 0;
}
}
@keyframes temperature {
0% {
opacity: 0;
height: 0;
}
49.999% {
opacity: 0;
height: 0;
}
50% {
opacity: 0;
height: auto;
}
55% {
opacity: 1;
height: auto;
}
95% {
opacity: 1;
height: auto;
}
100% {
opacity: 0;
height: auto;
}
}
</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang="perl">
defmod swapValues_Labor DOIF (1) ## HMsensor_Labor HMdummy_Labor
attr swapValues_Labor group Labor: uiTable
attr swapValues_Labor room DOIF_Labor,DOIFalone
attr swapValues_Labor uiTable "<div class='humchange' >".STY([$SELF:humidity],"font-size:16pt;;font-weight:bold;;color:red;;")." relH%</div>\
<div class='tempchange' >".STY([$SELF:temperature:d1],"font-size:16pt;;font-weight:bold;;color:blue;;")."°C</div>"

setstate swapValues_Labor initialized
setstate swapValues_Labor 2017-11-13 10:44:16 cmd 0
setstate swapValues_Labor 2017-11-14 17:01:24 humidity 82
setstate swapValues_Labor 2017-11-13 10:44:16 state initialized
setstate swapValues_Labor 2017-11-14 17:01:24 temperature 20.7
</syntaxhighlight>

== Anzeige der uiTable anderer DOIF als Popup-Fenster ==
{{Randnotiz|RNText=Besonderheiten
* DOIF-Funktion <code>PUP(<Name des anderen DOIF>,<Iconname@optionale Farbe>)</code>, wenn das Icon nicht existiert wird der Text als Link in Standardfarbe angezeigt.
}}
[[Datei:UiTable_PopUp.png|height 100px|thumb|right|Link oder Icon zur Anzeige eines Popup-Fensters]]

In einer uiTable können die UI-Tabellen anderer DOIF als Popup-Fenster angezeigt werden.

=== Die Definition des [[Attribute|Attributes]] '''uiTable''' ===
Die Funktion <syntaxhighlight lang="perl" inline>PUP("Grundriss_Labor","control_building_modern_s_okg_eg\@orange")</syntaxhighlight> erzeugt einen Link mit einem orange gefäbten Icon '''control_building_modern_s_okg_eg''', der die UI-Tabelle des DOIF '''Grundriss_Labor''' in einem Popup-Fenster anzeigt.

<syntaxhighlight lang="perl">
PUP("Grundriss_Labor","control_building_modern_s_okg_eg\@orange")
PUP("Grundriss_position_Labor","control_building_modern_s_okg_og\@orange")
</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang="perl">
defmod PopUp_Labor DOIF (1) ## Grundriss_position_Labor Grundriss_Labor
attr PopUp_Labor group Labor: uiTable
attr PopUp_Labor room myHome,DOIF_Labor
attr PopUp_Labor uiTable PUP("Grundriss_Labor","control_building_modern_s_okg_eg\@orange")\
PUP("Grundriss_position_Labor","control_building_modern_s_okg_og\@orange")

defmod Grundriss_Labor DOIF (1)
attr Grundriss_Labor group Labor: uiTable
attr Grundriss_Labor room DOIF_Labor
attr Grundriss_Labor uiTable {\
$TABLE = " text-align:center;;width:300px;; height:300px;; background-image:url(./fhem/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TR{1,3} = "class=''";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
"Schlafen",WID([$SELF:SZ],$TPL{switch})|"Küche",WID([$SELF:Kue],$TPL{switch})|" Bad ; ; ;",WID([$SELF:Bad],$TPL{switch})\
" "|" "|" Diele ",WID([$SELF:Diele],$TPL{switch})\
"Wohnen A",WID([$SELF:WZ1],$TPL{switch})|" ;<br>Kind ",WID([$SELF:Ki],$TPL{switch})|" "\
"Wohnen B",WID([$SELF:WZ2],$TPL{switch})|" ;<br>Balkon ; ; ;",WID([$SELF:Balkon],$TPL{switch})|" "

defmod Grundriss_position_Labor DOIF (1)
attr Grundriss_position_Labor group Labor: uiTable
attr Grundriss_position_Labor room DOIF_Labor
attr Grundriss_position_Labor uiTable {\
$ATTRIBUTESFIRST = 1;;\
$TABLE = "font-size:10pt;;position:relative;; text-align:center;;width:300px;; height:300px;; background-image:url(./fhem/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
DEF TPL_Objekt("<div style='position:absolute;; Left:".$1."px;; top:".$2."px;;'>".$3.WID($4,$TPL{switch})."</div>")\
\
TPL_Objekt("35","25","Schlafen<br>",[$SELF:SZ])|\
TPL_Objekt("145","25","Küche<br>",[$SELF:Kue])|\
TPL_Objekt("225","25","Bad<br>",[$SELF:Bad])|\
TPL_Objekt("145","105","Diele ",[$SELF:Diele])|\
TPL_Objekt("35","160","Wohnen A<br>",[$SELF:WZ1])|\
TPL_Objekt("35","220","Wohnen B<br>",[$SELF:WZ2])|\
TPL_Objekt("145","160","Kind<br>",[$SELF:Ki])|\
TPL_Objekt("145","250","Balkon<br>",[$SELF:Balkon])

setstate Grundriss_Labor initialized
setstate Grundriss_Labor 2017-11-04 07:45:28 Bad off
setstate Grundriss_Labor 2017-11-04 07:45:22 Balkon off
setstate Grundriss_Labor 2017-11-04 07:45:28 Diele off
setstate Grundriss_Labor 2017-11-04 07:45:42 Ki on
setstate Grundriss_Labor 2017-11-04 18:47:30 Kue on
setstate Grundriss_Labor 2017-11-04 18:47:31 SZ on
setstate Grundriss_Labor 2017-11-04 07:45:46 WZ1 on
setstate Grundriss_Labor 2017-11-04 07:45:23 WZ2 off
setstate Grundriss_Labor 2017-11-04 19:10:03 cmd 0
setstate Grundriss_Labor 2017-11-04 19:10:03 state initialized

setstate Grundriss_position_Labor initialized
setstate Grundriss_position_Labor 2017-11-05 14:39:22 Bad off
setstate Grundriss_position_Labor 2017-11-05 14:38:46 Balkon off
setstate Grundriss_position_Labor 2017-11-05 14:39:30 Diele off
setstate Grundriss_position_Labor 2017-11-29 14:04:19 Ki off
setstate Grundriss_position_Labor 2017-11-26 16:21:37 Kue off
setstate Grundriss_position_Labor 2017-11-29 14:05:41 SZ off
setstate Grundriss_position_Labor 2017-11-05 14:38:43 WZ1 off
setstate Grundriss_position_Labor 2017-11-29 14:04:46 WZ2 off
setstate Grundriss_position_Labor 2017-11-04 21:29:59 cmd 0
setstate Grundriss_position_Labor 2017-11-04 21:29:59 state initialized

setstate PopUp_Labor initialized
setstate PopUp_Labor 2017-11-29 16:04:05 cmd 0
setstate PopUp_Labor 2017-11-29 16:04:05 state initialized
</syntaxhighlight>

== Anzeige einer uiTable über [[weblink]] als Popup-Fenster ==
{{Randnotiz|RNText=Besonderheiten
* DOIF-Funktion <code>DOIF_tablePopUp(<Name des DOIF auf dessen UI-Tabelle verwiesen werden soll>,<Name des DOIF auf dessen UI-Tabelle verwiesen werden soll>,<Iconname@optionale Farbe>)</code>, wenn das Icon nicht existiert wird der Text als Link in Standardfarbe angezeigt.
}}
In einer [[weblink]] Definition kann ein Link auf eine uiTable angelegt werden. Damit kann die UI-Tabelle eines DOIF als Popup-Fenster angezeigt werden.

=== Die Definition des [[weblink]] ===
Die Funktion <syntaxhighlight lang="perl" inline>DOIF_tablePopUp("PopUp_Labor","PopUp_Labor","rc_PLUS\@orange")</syntaxhighlight> erzeugt einen Link mit einem orange gefäbten Icon '''rc_PLUS''', der die UI-Tabelle des DOIF '''PopUp_Labor''' in einem Popup-Fenster anzeigt. Aus Gründen der Kompatibilität muss der Name des DOIF auf dessen UI-Tabelle der Link verweisen soll, zweimal angegeben werden. Der Kurzname <code>PUP</code> kann hier nicht verwendet werden.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
Das Beispiel funktioniert nur, wenn die Definitionen aus dem vorhergehenden Beispile angelegt sind.
<syntaxhighlight lang="perl">
defmod WebLink_Labor weblink htmlCode {DOIF_tablePopUp("PopUp_Labor","PopUp_Labor","rc_PLUS\@orange")}
attr WebLink_Labor group Labor: uiTable
attr WebLink_Labor room DOIF_Labor

setstate WebLink_Labor initialized
</syntaxhighlight>

== Uhrzeit und Datum ==
=== Darstellung einer Analoguhr ===
[[Datei:Analoguhr_uiTable.png|100px|thumb|right|Beispiel für eine Analoguhr]]
Auf der Seite [http://3quarks.com/de/Bahnhofsuhr/ http://3quarks.com/de/Bahnhofsuhr/] wird ein Javascript für eine Analoguhr bereitgestellt und die Konfiguration beschrieben.

Das in diesem Forenbeitrag {{Link2Forum|Topic=77690|Message=727276|LinkText=Analoguhr für uiTable}} bereitgestellte Script ''doifanaloguhr.js'' zum Laden und Starten des Uhrenscriptes ''station-clock.js'', ist in der betroffenen FHEMWEB-Instanz über das Attribut JavaScripts einzubinden.
Die beiden Javascripte ''station-clock.js'' und ''doifanaloguhr.js'' müssen in dem Verzeichnis pgm2 enthalten sein. Die Datei ''doifanaloguhr.js'' ersetzt ''excanvas.js''. In ''doifanaloguhr.js'' ist bei Bedarf die Konfiguration des Erscheinungsbildes der Uhr vorzunehmen.
<syntaxhighlight lang="perl">attr <Name der FHEMWEB-Instanz> pgm2/station-clock.js</syntaxhighlight>
Im Attribut '''uiTable''' eines DOIF ist Uhr mit einem canvas-Element einzubinden, z.B.
<syntaxhighlight lang="html">"<canvas id='doifanaloguhr' width='50' height='50'>error</canvas>"</syntaxhighlight>

=== Darstellung von Zeit und Datum ===
[[Datei:Timedate Labor.png|200px|thumb|right|Beispiele für Zeit und Datum]]

Mit dem in diesem Forenbeitrag {{Link2Forum|Topic=77690|Message=729761|LinkText=Zeit und Datum in uiTable}} bereitgestellten Script ''doiftimedate.js'' können Datum und Uhrzeit in verschiedenen Darstellungsweisen angezeigt werden.
Das Script muss in das Verzeichnis pgm2 kopiert werden und in die entsprechende FHEMWEB-Instanz eingebunden werden über:
<syntaxhighlight lang="perl">attr <Name der FHEMWEB-Instanz> pgm2/doiftimedate.js</syntaxhighlight>
Im Attribut '''uiTable''' eines DOIF sind die Zeit- u. Datumteile über einen Klassennamen einzubinden, z.B.
<syntaxhighlight lang="html">"<span class='doif-hour'>hour</span>"</syntaxhighlight>
um Stunden anzuzeigen.

Die drei ersten Zeilen des Bildes sind eingebaute Darstellungsweisen, die vierte Zeile ist aus den einzelnen Bestandteilen eines Datums zusammengesetzt.

Die möglichen Klassennamen gehen aus der nachstehenden uiTable-Definition hervor.
<syntaxhighlight lang="html">
"<div class='doif-hourminute'>hourminute</div>"

"<div class='doif-date'>date</div>"

"<div class='doif-hourminutedate'>hourminutedate</div>"

"<div style='color:orange;font-size:16pt;font-weight:bold;'>
<span class='doif-hour'>hour</span>
:<span class='doif-minute'>minute</span>
:<span class='doif-second'>second</span>
, <span class='doif-day'>day</span>
.<span class='doif-month'>month</span>
.<span class='doif-year'>year</span>
</div>"</syntaxhighlight>

==== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ====
<syntaxhighlight lang="perl">
defmod timedate_Labor DOIF (#1)
attr timedate_Labor group Labor: uiTable
attr timedate_Labor room DOIF_Labor
attr timedate_Labor uiTable "<div class='doif-hourminute'>hourminute</div>"\
\
"<div class='doif-date'>date</div>"\
\
"<div class='doif-hourminutedate'>hourminutedate</div>"\
\
"<div style='color:orange;;font-size:16pt;;font-weight:bold;;'>\
<span class='doif-hour'>hour</span>\
:<span class='doif-minute'>minute</span>\
:<span class='doif-second'>second</span>\
, <span class='doif-day'>day</span>\
.<span class='doif-month'>month</span>\
.<span class='doif-year'>year</span>\
</div>"
</syntaxhighlight>

== Weitere Hinweise ==
=== Arbeitsfläche der Detailansicht für die Bearbeitung von uiTable einrichten ===
{{Randnotiz|RNText=Besonderheiten
* Steuervariable <code>$ATTRIBUTESFIRST=1;</code>
}}
[[Datei:Attributesfirst.png|200px|thumb|right|Beispiel für die veränderte Detailansicht]]
Zum Erstellen der UI-Tabelle, wird das Attribut uiTable häufiger gesetzt, um Veränderungen in der uiTable sichtbar zu machen.
Damit beim Wechsel zwischen der Ansicht der UI-Tabelle und der Attributbearbeitung nicht immer über den DEF-Bereich und die Readings gescrollt werden muss können die Attribute unter die UI-Tabelle geschoben werden.
Wenn die Steuervariable <code>$ATTRIBUTESFIRST=1;</code> im oberen Bereich der Tabellendefinition angegeben wird, dann werden die Attribute vor den DEF-Bereich verschoben.

=== Browserunterstützung ===
Die verschiedenen Browser, Versionen und Mobile-Varianten unterstützen CSS unterschiedlich, siehe z.B. [https://www.w3schools.com/cssref/css3_browsersupport.asp W3Schools CSS Browser Support Reference]

Zur Problemlösung können die entsprechenden Entwicklerseiten beitragen.

* Mozilla [https://developer.mozilla.org/de/docs/Web/CSS https://developer.mozilla.org/de/docs/Web/CSS]
* Google [https://developers.google.com/web/tools/chrome-devtools/css/ https://developers.google.com/web/tools/chrome-devtools/css/]
* Apple [https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariCSSRef/Introduction.html https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariCSSRef/Introduction.html]
* Microsoft [https://msdn.microsoft.com/de-de/library/cc351024(v=vs.85).aspx https://msdn.microsoft.com/de-de/library/cc351024(v=vs.85).aspx]

== Links ==
* [[DOIF]]
* [[DOIFtools#Farbtabellen_erzeugen|DOIFtools Farbtabellen anzeigen]]
* Style-Attribute [https://www.w3schools.com/cssref/default.asp https://www.w3schools.com/cssref/default.asp]
* Liste der aktuellen HTML-Elemente [https://developer.mozilla.org/de/docs/Web/HTML/HTML5/HTML5_element_list https://developer.mozilla.org/de/docs/Web/HTML/HTML5/HTML5_element_list]

[[Kategorie:HOWTOS]]
[[Kategorie:Code Snippets]]

DOIF/uiTable

2018-01-03T22:28:58Z

50watt: /* Frontendelemente über einem Hintergrund (Grundriss) platzieren */Tippfehler

Das DOIF-Attribut '''uiTable''' dient der Definition eines User Interface im Kontext von FHEMWEB.
Die Syntax ist in der Befehlsreferenz zu [https://fhem.de/commandref_DE.html#DOIF_uiTable uiTable] beschrieben und wird hier nicht behandelt.
An dieser Stelle werden Beispiele zur Gestaltung der '''uiTable''' gezeigt.

== Sensorauswahl mit WID und DOIF_Readings ==
{{Randnotiz|RNText=Besonderheiten
* funktionsloses DOIF <code>Sensorauswahl_Labor DOIF (1)</code>
* DOIF_Readings <code>showtemp:ReadingsVal([$SELF:sensorselect],"temperature","nix")</code>
* Aggregationsfunktion <code>[@":temperature":temperature]</code>
}}
[[Datei:Uitable_sensorauswahl.png|300px|thumb|right|Sensorauswahl mit Wertanzeige des ausgewählten Sensors]]
Im Auswahlfeld werden alle [[Gerät|Geräte]], die ein [[Readings|Reading]] '''temperature''' enthalten aufgelistet. Die Temperatur des gewählten [[Gerät|Gerätes]] wird angezeigt.

=== Beschreibung ===
<code>WID([$SELF:sensorselect],[@"":temperature])</code> legt in '''uiTable''' ein [[FHEMWEB/Widgets|Select-Widget]] für das [[Readings|Reading]] '''sensorselect''' an. Die Liste des [[FHEMWEB/Widgets|Widgets]] wird über die Aggregationsfunktion <code>[@":temperature":temperature]</code> erzeugt.
Über das [[Attribute|Attribut]] '''DOIF_Readings''' <code>showtemp:ReadingsVal([$SELF:sensorselect],"temperature","nix")</code> wird ein [[Readings|Reading]] '''showtemp''' mit der Temperatur des ausgewählten Sensors gesetzt.
In '''uiTable''' zeigt <code>[$SELF:showtemp]</code> den in '''showtemp''' enthaltenen Wert an.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang="perl">
defmod Sensorauswahl_Labor DOIF (1)
attr Sensorauswahl_Labor DOIF_Readings showtemp:ReadingsVal([$SELF:sensorselect],"temperature","nix" )
attr Sensorauswahl_Labor room DOIF_Labor
attr Sensorauswahl_Labor uiTable "Sensor auswählen"|"T/°C"\
WID([$SELF:sensorselect],[@":temperature":temperature])|[$SELF:showtemp]
</syntaxhighlight>

== Kombination von WID und STY zu einem Thermostat Widget ==
{{Randnotiz|RNText=Besonderheiten
* HTML-Elemente <code><div></div></code>
* CSS-Styleattribute <code>position</code>, <code>text-align</code>, <code>width</code>, <code>left</code>, <code>top</code>, <code>font-weight</code>, <code>font-size</code>, <code>color</code>
* uiTable Templates <code>$TPL{<name>}="<template content>"</code>
* uiTable Funktionen <code>WID([<device>:<reading>],<widget parameter>)</code>, <code>STY(<content>,<style attributes>)</code>
}}
[[Datei:Uitable_widget_kombi_thermostat.png|300px|thumb|right|Kombination von FHEMWEB-Widgets zu einem Thermostat-Widget]]
Das Thermostat Widget zeigt mit dem inneren Teilkreis die Isttemperatur an und mit dem äusseren Teilkreis wird die Solltemperatur gesetzt. Das obere Textfeld zeigt den Zahlenwert der Solltemperatur, der Untere den der Isttemperatur. Die Farbe, der Soll- und Isttemperatur ändert sich mit ihrem Wert.

=== Beschreibung der Kombination ===
'''uiTable''' ist tabellenförmig aufgebaut, in einer Tabellenzelle können mehrere Elemente kombiniert werden. Da zwei gleich große knob-Widgets übereinander liegen ist nur das obere Widget, die Solltemperatur, bedienbar.
Die Widgetkombination wird durch den folgenden Code-Auszug beschrieben.
<syntaxhighlight lang="perl">
$TPL{style2}="text-align:right;width:23px;position:absolute;left:13px;top:26px;font-weight:bold;font-size:12px;color:";
$TPL{style3}="text-align:right;width:23px;position:absolute;left:13px;top:13px;font-weight:bold;font-size:12px;color:";

$TPL{knob1}="knob,thickness:.4,fgColor:#00A5FF,min:7,max:30,width:50,height:50,step:.5,angleArc:270,angleOffset:225,displayInput:false";
$TPL{knob2}="knob,thickness:.3,fgColor:#FFA500,min:7,max:30,width:50,height:50,step:.5,angleArc:270,angleOffset:225,displayInput:false";

"<div style='position:relative;width:50px;height:50px'><div style='position:absolute;left:0px;top:0px'>".WID([HMdummy_Labor:measured-temp],$TPL{knob1})."</div><div style='position:absolute;left:0px;top:0px'>".WID([HMdummy_Labor:desired-temp],$TPL{knob2},"set")."</div>".STY([HMdummy_Labor:measured-temp:d1],$TPL{style2}.DOIF_hsv([HMdummy_Labor:measured-temp],7,25,240,360,100,100)).STY([HMdummy_Labor:desired-temp:d1],$TPL{style3}.DOIF_hsv([HMdummy_Labor:desired-temp],7,25,240,360,100,100))."</div>"</syntaxhighlight>

Mit style2, style3, knob1 und knob2 werden vier Templates gespeichert. Sie werden jeweils nur einmal verwendet, verkürzen aber die Tabellendefinition.
Die Templates knob1 und knob2 beschreiben die [[FHEMWEB/Widgets|Knob-Widgets]].
Die Templates style2 und style3 beschreiben die Textfelder für die Soll- und Isttemperatur durch die Angabe der entsprechenden CSS-Attribute.

==== Struktur der Kombination ====
Die Tabellenzelle wird mit div-Elementen nach folgenden Schema strukturiert.
<syntaxhighlight lang="html">
<div mit relativer Position zum Elternelement>
<div mit absoluter Position zum Elternelement> Knob-Widget Isttemperatur </div> unterste Ebene
<div mit absoluter Position zum Elternelement> Knob-Widget Solltemperatur </div>
<div mit absoluter Position zum Elternelement> Solltemperatur </div> in STY enthalten und beschrieben durch style3
<div mit absoluter Position zum Elternelement> Isttemperatur </div> in STY enthalten und beschrieben durch style2, oberste Ebene
</div>
</syntaxhighlight>
Mit <code>position:relative;width:50px;height:50px</code> wird das oberste div-Element in der Tabellenzelle positioniert. Durch die Verwendung des CSS-Attributes '''position''' wird das div-Element zum Bezugspunkt der nachfolgenden Elemente mit absoluter Positionsangabe.

==== Positionierung der FHEMWEB-Widgets ====
Mit <code>position:absolute;left:0px;top:0px</code> werden die das knob-Widget umschliessenden div-Elemente in die linke obere Ecke ihres Elternelementes positioniert.

==== Position und Format der Textanzeige ====
<code>position:absolute;left:13px;top:26px</code> positioniert das div-Element absolut zum Bezugspunkt, 13 Pixel nach rechts und 26 Pixel nach unten, von links oben aus.

<code>width:23px</code> legt die Breite des div-Elements auf 23 Pixel fest.

<code>font-weight:bold</code> formatiert den Text fett.

<code>font-size:12px</code> legt die Schriftgröße auf 12 Pixel fest.

<code>text-align:right</code> richtet den Text rechtsbündig aus.

==== Dynamische Farben ====
<code>color:#<berechnete Farbe></code> legt die Farbe fest.

Mit <code>$TPL{style2}.DOIF_hsv([HMdummy_Labor:measured-temp],7,25,240,360,100,100)</code> wird die Farbnummer an das Template '''style3'' angehängt.
Die Farbnummer wird mit der DOIF internen Funktion DOIF_hsv berechnet. Die Funktion wird mit den Parametern <laufender Wert>,<unterer Wert>,<oberer Wert>,<HUE-Startwert>,<HUE-Endwert>,<Farbsättigung>,<Hellwert> aufgerufen. Der laufende Wert ergibt sich aus dem [[Readings|Reading]] '''measured-temp''' des [[Gerät|Gerätes]] '''HMdummy_Labor'''.

=== Alternativ, die Nutzung von Methodentemplates ===
{{Randnotiz|RNText=Besonderheiten
* Methodentemplates definieren<code>DEF TPL_<name>(<template definition>)</code>
* Methodentemplates anwenden <code>TPL_<name>(<parameter1;,<parameter2;, ...)</code>
}}
Die Kombination wird als Template einer Methode angelegt. Damit wird die Tabellendefinition übersichtlicher und das Template kann mit anderen Parametern aufgerufen werden.

Das Template mit den Platzhaltern <syntaxhighlight lang="perl" inline>$1</syntaxhighlight> bis <syntaxhighlight lang="perl" inline>$4</syntaxhighlight>
<syntaxhighlight lang="perl">
DEF TPL_Thermostat("<div style='position:relative;width:50px;height:50px'><div style='position:absolute;left:0px;top:0px'>".WID($1,$TPL{knob1})."</div><div style='position:absolute;left:0px;top:0px'>".WID($2,$TPL{knob2},"set")."</div>".STY($3,$TPL{style2}.DOIF_hsv($1,7,25,240,360,100,100)).STY($4,$TPL{style3}.DOIF_hsv($2,7,25,240,360,100,100))."</div>")
</syntaxhighlight>
und die Definition des Widgets in der Tabelle mit vier Parametern in DOIF-Syntax.
<syntaxhighlight lang="perl">
TPL_Thermostat([HMdummy_Labor:measured-temp],[HMdummy_Labor:desired-temp],[HMdummy_Labor:measured-temp:d1],[HMdummy_Labor:desired-temp:d1])</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] (nur das Attribut uiTable) ===
<syntaxhighlight lang="perl">
attr widgetkombi_Labor uiTable {\
$TPL{style2}="text-align:right;;width:23px;;position:absolute;;left:13px;;top:26px;;font-weight:bold;;font-size:12px;;color:";;\
$TPL{style3}="text-align:right;;width:23px;;position:absolute;;left:13px;;top:13px;;font-weight:bold;;font-size:12px;;color:";;\
\
$TPL{knob1}="knob,thickness:.4,fgColor:#00A5FF,min:7,max:30,width:50,height:50,step:.5,angleArc:270,angleOffset:225,displayInput:false";;\
$TPL{knob2}="knob,thickness:.3,bgColor:#808080,fgColor:#FFA500,min:7,max:30,width:50,height:50,step:.5,angleArc:270,angleOffset:225,displayInput:false";;\
}\
\
DEF TPL_Thermostat("<div style='position:relative;;width:50px;;height:50px'><div style='position:absolute;;left:0px;;top:0px'>".WID($1,$TPL{knob1})."</div><div style='position:absolute;;left:0px;;top:0px'>".WID($2,$TPL{knob2},"set")."</div>".STY($3,$TPL{style2}.DOIF_hsv($1,7,25,240,360,100,100)).STY($4,$TPL{style3}.DOIF_hsv($2,7,25,240,360,100,100))."</div>")\
\
WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable,disabled")\
\
TPL_Thermostat([HMdummy_Labor:measured-temp],[HMdummy_Labor:desired-temp],[HMdummy_Labor:measured-temp:d1],[HMdummy_Labor:desired-temp:d1])</syntaxhighlight>

== Kombination von WID und STY zum Festlegen zweier Grenzwerte ==
[[Datei:Uitable_widget_kombi_grenzwert.png|100px|right]]
Die Kombination ist so angelegt, dass beide Widgets bedienbar sind.
Es wird jeweils ein Reading durch ein Widget gesetzt.

=== Positionierung der knob-Widgets ===
Die Widget sind unterschiedlich groß.
<syntaxhighlight lang=perl>
$TPL{knob1}="... width:50,height:50 ..."
$TPL{knob2}="... width:38,height:38 ..."
</syntaxhighlight>
Daher muss '''knob2''' 6px nach rechts und unten positioniert werden.
<syntaxhighlight lang=html><div style='... left:6px;;top:6px'></syntaxhighlight>
Damit wird erreicht, dass beide Widgets bedienbar bleiben.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang=perl>
defmod widgetkombi2_Labor DOIF (1)
attr widgetkombi2_Labor group Labor: uiTable
attr widgetkombi2_Labor room DOIF_Labor
attr widgetkombi2_Labor uiTable {\
$TPL{style2}="text-align:center;;width:23px;;position:absolute;;left:13px;;top:13px;;font-weight:bold;;font-size:12px;;color:red";;\
$TPL{style3}="text-align:center;;width:23px;;position:absolute;;left:13px;;top:26px;;font-weight:bold;;font-size:12px;;color:blue";;\
\
$TPL{knob1}="knob,thickness:.23,bgColor:lightgrey,fgColor:#FF0000,min:0,max:100,width:50,height:50,step:1,angleArc:270,angleOffset:225,displayInput:false,cursor:1,lineCap:round";;\
$TPL{knob2}="knob,thickness:.32,bgColor:#808080,fgColor:#0000FF,min:0,max:100,width:38,height:38,step:1,angleArc:270,angleOffset:225,displayInput:false,cursor:1,lineCap:round";;\
}\
\
"<div style='position:relative;;width:50px;;height:50px'><div style='position:absolute;;left:px;;top:0px'>".WID([$SELF:obererGrenzwert],$TPL{knob1})."</div><div style='position:absolute;;left:6px;;top:6px'>".WID([$SELF:untererGrenzwert],$TPL{knob2})."</div>".STY([$SELF:obererGrenzwert],$TPL{style2}).STY([$SELF:untererGrenzwert],$TPL{style3})."</div>"

setstate widgetkombi2_Labor initialized
setstate widgetkombi2_Labor 2017-10-25 11:20:15 cmd 0
setstate widgetkombi2_Labor 2017-10-25 11:55:42 obererGrenzwert 87
setstate widgetkombi2_Labor 2017-10-25 11:20:15 state initialized
setstate widgetkombi2_Labor 2017-10-25 11:55:45 untererGrenzwert 10
</syntaxhighlight>

== FHEM-Befehl mit Icon und Text-Overlay ==
{{Randnotiz|RNText=Besonderheiten
* HTML-Elemente <code><a></a></code>
* Link-Attribute <code>target</code>, <code>href</code>, <code>title</code>
* uiTable Formatierung einer Tabellenzelle <code>$TD{row}{col}="<HTML-Attribute>"</code>
* CSS-Attribute , <code>background-color</code>
* FHEMWEB-Funktion <code>FW_makeImage(<image name>)</code>
* FHEMWEB-Variablen <code>$FW_ME</code>, <code>$FW_CSRF</code>
}}
[[Datei:Uitable_widget_cmdlink_icon_text.png|300px|thumb|right|Befehlslink mit Icon, Text und Hinweistext]]
Mit dieser Widgetkombination wird ein FHEM-Befehl als Link in eine Tabellenzelle der '''uiTable''' eingefügt. Als Linktext wird ein Icon eingebunden und ein Text über das Icon positioniert. Der Link enthält einen Hinweistext. Siehe auch {{Link2Forum|Topic=80835|Message=729002|LinkText=Link mit Icon und FHEM-Befehl}} ff.
=== Beschreibung ===
Mit <code>$TD{0}{0}="style='position:relative'";</code> wird die oberste linke Zelle als der Bezugspunkt für die Textpositionierung festgelegt. Als erstes wird der der Link mit dem a-Element angelegt. Mit dem Attribut <code>target='_blank'</code> erfolgt die Ausgabe der aufgerufenen Seite in einem neuen Browser-Tab. Die URL wird in dem Attribut <code>href='$FW_ME?detail=$SELF&cmd.$SELF=list $SELF$FW_CSRF' title='list $SELF'</code> angegeben. Darin liefert <code>$FW_ME</code> den Webnamen von FHEM, <code>$SELF</code> den Eigennamen des DOIF, und <code>$FW_CSRF</code> das aktuelle CSRF-Token. Das Attribut <code>title='list $SELF'</code> gibt den Hinweistext an. Als Linktext liefert die Funktion <code>FW_makeImage("time_note\@lightblue")</code> den HTML-code zum Anzeigen des Icons, dabei beschreibt <code>"time_note\@lightblue"</code> den Iconnamen und die Einfärbung des Icons. Auch der über das Icon gelegte Text gehört zum Linktext, er wird aber durch die Positionsangaben <code>style='position:absolute; left:12px; top:20px;</code> auf das Icon geschoben. Die Angaben <code>font-size:12px; background-color:lightblue; color:darkred;</code> dienen der Formatierung des Textes.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===

<syntaxhighlight lang="perl">
defmod widget_cmdlink_icon_text DOIF (1)
attr widget_cmdlink_icon_text group Labor: uiTable
attr widget_cmdlink_icon_text room DOIF_Labor,DOIFalone
attr widget_cmdlink_icon_text uiTable {\
$TD{0}{0}="style='position:relative'";;\
}\
\
"<a target='_blank' href='$FW_ME?cmd.$SELF=list $SELF$FW_CSRF' title='list $SELF'>".FW_makeImage("time_note\@lightblue")."<div style='position:absolute;; left:12px;; top:20px;; font-size:12px;; background-color:lightblue;; color:darkred'>list</div></a>"\
</syntaxhighlight>

== Frontendelemente über einem Hintergrund (Grundriss) platzieren ==
{{Randnotiz|RNText=Besonderheiten
* Formatierung des table-Element <code>$TABLE</code>
* CSS-Attribute <code>background-image:url</code>, <code>background-size</code>, <code>text-align:center</code>
* HTML Zeilenumbruch <code><br></code>, Leerzeichen <code>&nbsp;</code>
}}
[[Datei:Grundriss1.png|300px|thumb|right|Positionierung von Text und Widget auf einem Hintergrundbild]]
In diesem Beispiel wird ein Hintergundbild geladen und das Bild mit Widgets und Text beschriftet.
Dem table-Element der uiTable wird über <code>$TABLE = "CSS-Attribute";</code> eine Formatierung zugewiesen. Die Formatierung beinhaltet das Laden eine Hintergrundbildes mit <code>background-image:url($FW_ME/www/pgm2/images/Grundriss.svg);</code>.
=== Positionierung über die Matrixstruktur einer Tabelle ===
Durch die Formatierung <code>text-align:center</code> werden wird der Zelleninhalt zentriert. Die Positionierung von Text und Widget, die Verschiebung aus der Mitte der Zelle, erfolgt durch Zeilenumbruch <code><br></code> und Leerzeichen <code>&nbsp;</code>. Da Text und Widget in der Tabellenzelle durch ein Komma getrennt werden, erfolgt dort ein Zeilenumbruch.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
Das Beispiel funktioniert nur, wenn das Hintergrundbild in das Verzeichnis <code>/www/pgm2/images/</code> gespeichert wird.

* Download von [[Medium:Grundriss.svg|Grundriss.svg]].
<syntaxhighlight lang="perl">
defmod Grundriss_Labor DOIF (1)
attr Grundriss_Labor group Labor: uiTable
attr Grundriss_Labor room DOIF_Labor
attr Grundriss_Labor uiTable {\
$TABLE = " text-align:center;;width:300px;; height:300px;; background-image:url($FW_ME/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TR{1,3} = "class=''";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
"Schlafen",WID([$SELF:SZ],$TPL{switch})|"Küche",WID([$SELF:Kue],$TPL{switch})|" Bad ; ; ;",WID([$SELF:Bad],$TPL{switch})\
" "|" "|" Diele ",WID([$SELF:Diele],$TPL{switch})\
"Wohnen A",WID([$SELF:WZ1],$TPL{switch})|" ;<br>Kind ",WID([$SELF:Ki],$TPL{switch})|" "\
"Wohnen B",WID([$SELF:WZ2],$TPL{switch})|" ;<br>Balkon ; ; ;",WID([$SELF:Balkon],$TPL{switch})|" "

setstate Grundriss_Labor initialized
setstate Grundriss_Labor 2017-11-04 07:45:28 Bad off
setstate Grundriss_Labor 2017-11-04 07:45:22 Balkon off
setstate Grundriss_Labor 2017-11-04 07:45:28 Diele off
setstate Grundriss_Labor 2017-11-04 07:45:42 Ki on
setstate Grundriss_Labor 2017-11-04 18:47:30 Kue on
setstate Grundriss_Labor 2017-11-04 18:47:31 SZ on
setstate Grundriss_Labor 2017-11-04 07:45:46 WZ1 on
setstate Grundriss_Labor 2017-11-04 07:45:23 WZ2 off
setstate Grundriss_Labor 2017-11-04 19:10:03 cmd 0
setstate Grundriss_Labor 2017-11-04 19:10:03 state initialized
</syntaxhighlight>

=== Alternativ, freie Positionierung von Text und Widgets ===
{{Randnotiz|RNText=Besonderheiten
* Festlegen des Positionierungsbezugspunktes mit <code>position:relative;</code>
* Positionierung der Frontendelemente mit <code>position:absolute; Left:<Pixel nach rechts>px; top:<Pixel nach unten>px;</code>
* Verwendung nur einer Tabellenzelle
}}
[[Datei:Grundriss2.png|300px|thumb|right|Absolute Positionierung]]Widgets und Texte werden auf dem Hintergrundbild durch Angabe ihrer absoluten Position zur linken oberen Ecke der Tabelle, bzw. des Hintergrundbilder positioniert. Die Positionierung kann pixelgenau angegeben werden.

Der gesamte Text und die Widgets werden nur in einer Tabellenzelle platziert. Die linke obere Ecke der Tabelle wird mit <code>position:relative;</code> zum Bezugspunkt. Die zu positionierenden Elemente werden mit <code>position:absolute; Left:<Pixel nach rechts>px; top:<Pixel nach unten>px;</code> platziert. Text u. Widget sind von einem div-Element umschlossen, so dass sie als Einheit positioniert werden können.

Die Definition des [[Attribute|Attributes]] '''uiTable''' mit absoluten Positionsangaben.
<syntaxhighlight lang="perl">
{
$TABLE = "font-size:10pt;position:relative; text-align:center;width:300px; height:300px; background-image:url($FW_ME/www/pgm2/images/Grundriss.svg); background-size: 300px 300px;";
$TPL{switch}="iconSwitch,on,off,off,on";
}

"<div style='position:absolute; left:35px; top:25px;'>Schlafen",WID([$SELF:SZ],$TPL{switch})."</div>
<div style='position:absolute; left:145px; top:25px;'>Küche",WID([$SELF:Kue],$TPL{switch})."</div>
<div style='position:absolute; left:225px; top:25px;'>Bad",WID([$SELF:Bad],$TPL{switch})."</div>
<div style='position:absolute; left:145px; top:105px;'>Diele ".WID([$SELF:Diele],$TPL{switch})."</div>
<div style='position:absolute; left:35px; top:160px;'>Wohnen A",WID([$SELF:WZ1],$TPL{switch})."</div>
<div style='position:absolute; left:35px; top:220px;'>Wohnen B",WID([$SELF:WZ2],$TPL{switch})."</div>
<div style='position:absolute; left:145px; top:160px;'>Kind",WID([$SELF:Ki],$TPL{switch})."</div>
<div style='position:absolute; left:145px; top:250px;'>Balkon",WID([$SELF:Balkon],$TPL{switch})."</div>"</syntaxhighlight>

=== Beispiel 1 für [[Import_von_Code_Snippets|Raw definition]] ===
In diesem Beispiel wurde gegenüber dem vorhergehenden Beispiel nur die Definiton des [[Attribute|Attributes]] '''uiTable''' geändert.
<syntaxhighlight lang="perl">
defmod Grundriss_position_Labor DOIF (1)
attr Grundriss_position_Labor group Labor: uiTable
attr Grundriss_position_Labor room DOIF_Labor
attr Grundriss_position_Labor uiTable {\
$ATTRIBUTESFIRST = 1;;\
$TABLE = "font-size:10pt;;position:relative;; text-align:center;;width:300px;; height:300px;; background-image:url($FW_ME/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
"<div style='position:absolute;; Left:35px;; top:25px;;'>Schlafen",WID([$SELF:SZ],$TPL{switch})."</div>\
<div style='position:absolute;; Left:145px;; top:25px;;'>Küche",WID([$SELF:Kue],$TPL{switch})."</div>\
<div style='position:absolute;; Left:225px;; top:25px;;'>Bad",WID([$SELF:Bad],$TPL{switch})."</div>\
<div style='position:absolute;; Left:145px;; top:105px;;'>Diele ".WID([$SELF:Diele],$TPL{switch})."</div>\
<div style='position:absolute;; Left:35px;; top:160px;;'>Wohnen A",WID([$SELF:WZ1],$TPL{switch})."</div>\
<div style='position:absolute;; Left:35px;; top:220px;;'>Wohnen B",WID([$SELF:WZ2],$TPL{switch})."</div>\
<div style='position:absolute;; Left:145px;; top:160px;;'>Kind",WID([$SELF:Ki],$TPL{switch})."</div>\
<div style='position:absolute;; Left:145px;; top:250px;;'>Balkon",WID([$SELF:Balkon],$TPL{switch})."</div>"

setstate Grundriss_position_Labor initialized
setstate Grundriss_position_Labor 2017-11-05 14:39:22 Bad off
setstate Grundriss_position_Labor 2017-11-05 14:38:46 Balkon off
setstate Grundriss_position_Labor 2017-11-05 14:39:30 Diele off
setstate Grundriss_position_Labor 2017-11-04 21:30:27 Ki on
setstate Grundriss_position_Labor 2017-11-05 14:39:28 Kue on
setstate Grundriss_position_Labor 2017-11-05 14:39:27 SZ off
setstate Grundriss_position_Labor 2017-11-05 14:38:43 WZ1 off
setstate Grundriss_position_Labor 2017-11-04 21:30:29 WZ2 on
setstate Grundriss_position_Labor 2017-11-04 21:29:59 cmd 0
setstate Grundriss_position_Labor 2017-11-04 21:29:59 state initialized
</syntaxhighlight>

=== Beispiel 2 für [[Import_von_Code_Snippets|Raw definition]], mit Methodentemplate ===
In diesem Beispiel wurde gegenüber dem vorhergehenden Beispiel nur die Definiton des [[Attribute|Attributes]] '''uiTable''' geändert.
In dieser Variante wird ein Methodentemplate für das Objekt aus Text und Widget verwendet.
<syntaxhighlight lang="perl">
defmod Grundriss_position_Labor DOIF (1)
attr Grundriss_position_Labor group Labor: uiTable
attr Grundriss_position_Labor room DOIF_Labor
attr Grundriss_position_Labor uiTable {\
$ATTRIBUTESFIRST = 1;;\
$TABLE = "font-size:10pt;;position:relative;; text-align:center;;width:300px;; height:300px;; background-image:url(./fhem/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
DEF TPL_Objekt("<div style='position:absolute;; Left:".$1."px;; top:".$2."px;;'>".$3.WID($4,$TPL{switch})."</div>")\
\
TPL_Objekt("35","25","Schlafen<br>",[$SELF:SZ])|\
TPL_Objekt("145","25","Küche<br>",[$SELF:Kue])|\
TPL_Objekt("225","25","Bad<br>",[$SELF:Bad])|\
TPL_Objekt("145","105","Diele ",[$SELF:Diele])|\
TPL_Objekt("35","160","Wohnen A<br>",[$SELF:WZ1])|\
TPL_Objekt("35","220","Wohnen B<br>",[$SELF:WZ2])|\
TPL_Objekt("145","160","Kind<br>",[$SELF:Ki])|\
TPL_Objekt("145","250","Balkon<br>",[$SELF:Balkon])

setstate Grundriss_position_Labor initialized
setstate Grundriss_position_Labor 2017-11-05 14:39:22 Bad off
setstate Grundriss_position_Labor 2017-11-05 14:38:46 Balkon off
setstate Grundriss_position_Labor 2017-11-05 14:39:30 Diele off
setstate Grundriss_position_Labor 2017-11-04 21:30:27 Ki on
setstate Grundriss_position_Labor 2017-11-05 14:39:28 Kue on
setstate Grundriss_position_Labor 2017-11-05 14:39:27 SZ off
setstate Grundriss_position_Labor 2017-11-05 14:38:43 WZ1 off
setstate Grundriss_position_Labor 2017-11-04 21:30:29 WZ2 on
setstate Grundriss_position_Labor 2017-11-04 21:29:59 cmd 0
setstate Grundriss_position_Labor 2017-11-04 21:29:59 state initialized

</syntaxhighlight>

== Icon mit animierter Füllung ==
{{Randnotiz|RNText=Besonderheiten
* benutzerdefinierte Perl-Funktion <code>sub FUNC_<name>{<Funktionsblock>}</code>
* CSS-Attribute <code>linear-gradient</code>
* RGB-Farbangabe mit α-Kanal <code>rgba(<rotwert>,<grünwert>,<blauwert>,<transparenzwert>)</code>
}}
[[Datei:uiTable_gradiend_Labor.png|300px|thumb|right|Icon mit animierter Füllung]]
Das Icon für eine Zisterne wird mit einem veränderlichen Hintergrund angezeigt, der den Füllstand darstellt.

=== Aufbau der Kombination ===
Der Zelleninhalt hat folgende Struktur.
<syntaxhighlight lang="html">
<div Bezugspunkt>
<div dynamischer Gradiend untere Ebene></div>
<div obere Ebene mit SVG als Inhalt>SVG</div>
</div>
</syntaxhighlight>
Der Bezugspunkt und die Größe wird mit <syntaxhighlight lang="perl" inline>"<div style='width:32px;height:35px;position:relative;'>"</syntaxhighlight> angegeben.

Die untere Ebene wird durch <code>STY</code> beschrieben, der Inhalt wird durch <code>FUNC_zisterne([HMdummy_Labor:level])</code> erzeugt, die Formatierung erfolgt über
<code>"positon:absolute;left:0px;top:0px;"</code>.

Die obere Ebene wird durch das div-Element <syntaxhighlight lang="perl" inline>"<div style='position:absolute;left:0px;top:0px;'>".FW_makeImage('zisterne')."</div>"</syntaxhighlight> beschrieben, wobei der Inhalt, das Icon, durch die Funktion <code>FW_makeImage('zisterne')</code> zurückgegeben wird.

Die selbst definierte Funktion <code>FUNC_zisterne</code> gibt ein div-Element zurück, dass die Form der Füllung des Icons, die Richtung der Füllung <code>to top</code> mit der Position der Farbgrenze <code>rgba(0,0,230,0.5) ($val*24/100)px, rgba(0,0,0,0) ($val*24/100)px);</code> durch den <code>linear-gradient</code> festlegt.

Durch ein Verschieben der Farbgrenze über den Wert des [[Readings]] <code>HMdummy_Labor:level</code>, wird die Füllhöhe animiert.

Die Füllhöhe der Zisterne (0-100) wird umgerechnet auf die Füllhöhe des Icons (0px-24px) mit <code>$val*24/100</code>, dabei ist <code>$val</code> die aktuelle Füllhöhe der Zisterne, dargestellt durch das [[Readings|Reading]] <code>HMdummy_Labor:level</code>

=== Die Definition des [[Attribute|Attributes]] '''uiTable''' mit absoluten Positionsangaben ===
<syntaxhighlight lang="perl">
{
sub FUNC_zisterne {
my($val)= @_;
my $ret= "<div style=\"position:absolute;bottom:3px;left:6px;width:20px;height:24px;background:linear-gradient( to top, rgba(0,0,230,0.5) ".($val*24/100)."px, rgba(0,0,0,0) ".($val*24/100)."px);\"></div>";
return $ret;
}
}

WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable")

"<div style='width:32px;height:35px;position:relative;'>".STY(FUNC_zisterne([HMdummy_Labor:level]),"positon:absolute;left:0px;top:0px;")."<div style='position:absolute;left:0px;top:0px;'>".FW_makeImage('zisterne')."</div>"
</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
Das Beispiel funktioniert nur, wenn das Icon '''zisterne.svg''' in ein Verzeichnis unterhalb von <code>/www/images/</code> gespeichert wird.

* Download von [[Medium:zisterne.svg|zisterne.svg]].
<syntaxhighlight lang="perl">
defmod gradiend_Labor DOIF (1) ## HMsensor_Labor HMdummy_Labor
attr gradiend_Labor group Labor: uiTable
attr gradiend_Labor room DOIF_Labor,DOIFalone
attr gradiend_Labor uiTable {\
sub FUNC_zisterne {\
my($val)= @_;;\
my $ret= "<div style=\"position:absolute;;bottom:3px;;left:6px;;width:20px;;height:24px;;background:linear-gradient( to top, rgba(0,0,230,0.5) ".($val*24/100)."px, rgba(0,0,0,0) ".($val*24/100)."px);;\"></div>";;\
return $ret;;\
}\
}\
\
WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable")\
\
"<div style='width:32px;;height:35px;;position:relative;;'>".STY(FUNC_zisterne([HMdummy_Labor:level]),"positon:absolute;;left:0px;;top:0px;;")."<div style='position:absolute;;left:0px;;top:0px;;'>".FW_makeImage('zisterne')."</div>"

defmod HMdummy_Labor dummy
attr HMdummy_Labor group Labor: uiTable
attr HMdummy_Labor room DOIF_Labor
attr HMdummy_Labor userReadings desired-temp {ReadingsNum($name,"state",7)}

defmod HMsensor_Labor DOIF ([+1])\
(setreading HMdummy_Labor measured-temp {(if ([HMdummy_Labor:measured-temp] < [HMdummy_Labor:desired-temp]){[HMdummy_Labor:measured-temp]+.5} else {7})},\
setreading HMdummy_Labor level {(if ([HMdummy_Labor:level] < 100){[HMdummy_Labor:level]+5} else {0})})
attr HMsensor_Labor do always
attr HMsensor_Labor group Labor: uiTable
attr HMsensor_Labor room DOIF_Labor
attr HMsensor_Labor webCmd enable:disable

setstate HMdummy_Labor desired-temp 29
setstate HMdummy_Labor 2017-11-08 23:34:23 desired-temp 29
setstate HMdummy_Labor 2017-11-08 23:34:23 level 75
setstate HMdummy_Labor 2017-11-08 23:34:23 measured-temp 27
setstate HMdummy_Labor 2017-11-06 12:04:39 state desired-temp 29

setstate HMsensor_Labor disabled
setstate HMsensor_Labor 2017-11-08 23:34:23 cmd 1
setstate HMsensor_Labor 2017-11-08 23:34:23 cmd_event timer_1
setstate HMsensor_Labor 2017-11-08 23:34:23 cmd_nr 1
setstate HMsensor_Labor 2017-11-08 23:34:23 last_cmd cmd_1
setstate HMsensor_Labor 2017-11-08 23:34:23 mode disabled
setstate HMsensor_Labor 2017-11-08 23:34:23 state disabled
setstate HMsensor_Labor 2017-11-08 23:54:37 timer_01_c01 08.11.2017 23:54:38

setstate gradiend_Labor initialized
setstate gradiend_Labor 2017-11-08 23:35:44 cmd 0
setstate gradiend_Labor 2017-11-08 23:35:44 state initialized

</syntaxhighlight>

== Ladezustand als vertikaler, linearer Gradiend ==
{{Randnotiz|RNText=Besonderheiten
* benutzerdefinierte Perl-Funktion <code>sub FUNC_<name>{<Funktionsblock>}</code>
* uiTable-Funktion <code>STY</code>
* CSS-Attribute <code>linear-gradient</code>,<code>border-style</code>,<code>border-width</code>,<code>border-color</code>
* RGB-Farbangabe mit α-Kanal <code>rgba(<rotwert>,<grünwert>,<blauwert>,<transparenzwert>)</code>
}}
[[Datei:uiTable_verticalGradient.png|height 100px|thumb|right|Vertikaler Gradiend mit animierter Überlagerung]]
Der farbige Gradiend (rot, gelb, grün von unten nach oben) wird zu dem Teil abgedeckt, welcher der Ergänzung des Ladezustandes zu 100 entspricht.

=== Aufbau der Kombination ===
Der Zelleninhalt hat folgende Struktur.
<syntaxhighlight lang="html">
<div Bezugspunkt und statischer Gradiend (rot,gelb,grün) als Hintergrung>
<div untere Ebene dynamischem Gradienten></div>
<div obere Ebene mit Wert als Inhalt>Wert</div>
</div>
</syntaxhighlight>
Der Bezugspunkt, die Größe, der Rahmen und der statische Gradiend wird mit <syntaxhighlight lang="html" inline><div style='border-width:2px;border-style:solid;border-color:gray;position:relative;width:25px;height:100px;background:linear-gradient( to top, red 0px,yellow 50px,green 100px);'></syntaxhighlight> festgelegt.

Der dynamische Gradiend wird durch die benutzerdefinierte Funktion <code>FUNC_batt</code> zurückgegeben, <code>(100-$val)</code> berechnet den abzudeckenden Teil des rot, gelb, grünen Gradienten.

Durch <code>STY([HMdummy_Labor:level]."%","font-size:9px;position:absolute;top:45px;right:1px")</code> wird der Wert positioniert und angezeigt.

=== Die Definition des [[Attribute|Attributes]] '''uiTable''' mit absoluten Positionsangaben ===
<syntaxhighlight lang="perl">
{
$TD{0}{0}=" colspan=2 ";
sub FUNC_batt {
my($val)=@_;
my $ret="position:absolute;left:0px;width:25px;height:100px;background:linear-gradient( to bottom,#F8F8E0 ".(100-$val)."px,rgba(0,0,0,0) ".(100-$val)."px);";
return $ret;
}
sub FUNC_batt2 {
my($val)=@_;
my $ret="position:absolute;left:9px;top:6px;width:14px;height:27px;background:linear-gradient( to bottom,#F8F8E0 ".(100-$val)."%,rgba(0,0,0,0) ".(100-$val)."%);";
return $ret;
}
}
WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable")

"<div style='border-width:2px;border-style:solid;border-color:gray;position:relative;width:25px;height:100px;background:linear-gradient( to top, red 0px,yellow 50px,green 100px);'>".STY(" ",FUNC_batt([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:9px;position:absolute;top:45px;right:1px")."</div>"|
"<div style='position:relative'>
<div style='position:absolute;left:9px;top:6px;width:14px;height:27px;background:linear-gradient( to top, red 0%,yellow 50%,green 100%);'></div>
".STY(" ",FUNC_batt2([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:6px;position:absolute;top:15px;left:10px").STY(FW_makeImage("measure_battery_0"))."</div>"</syntaxhighlight>

Die Anwendung des Anwendung der überlagerten Gradienten auf ein Batterieicon wird durch den nachstehenden Codeteil erzeugt.
<syntaxhighlight lang="perl">
"<div style='position:relative'>
<div style='position:absolute;left:9px;top:6px;width:14px;height:27px;background:linear-gradient( to top, red 0%,yellow 50%,green 100%);'></div>
".STY(" ",FUNC_batt2([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:6px;position:absolute;top:15px;left:10px").STY(FW_makeImage("measure_battery_0"))."</div>"</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang="perl">
defmod verticalGradiend_Labor DOIF (1) ## HMsensor_Labor HMdummy_Labor
attr verticalGradiend_Labor group Labor: uiTable
attr verticalGradiend_Labor room DOIF_Labor
attr verticalGradiend_Labor uiTable {\
$TD{0}{0}=" colspan=2 ";;\
sub FUNC_batt {\
my($val)=@_;;\
my $ret="position:absolute;;left:0px;;width:25px;;height:100px;;background:linear-gradient( to bottom,#F8F8E0 ".(100-$val)."px,rgba(0,0,0,0) ".(100-$val)."px);;";;\
return $ret;;\
}\
sub FUNC_batt2 {\
my($val)=@_;;\
my $ret="position:absolute;;left:9px;;top:6px;;width:14px;;height:27px;;background:linear-gradient( to bottom,#F8F8E0 ".(100-$val)."%,rgba(0,0,0,0) ".(100-$val)."%);;";;\
return $ret;;\
}\
}\
WID([HMsensor_Labor],"uzsuSelectRadio,enable,disable")\
\
"<div style='border-width:2px;;border-style:solid;;border-color:gray;;position:relative;;width:25px;;height:100px;;background:linear-gradient( to top, red 0px,yellow 50px,green 100px);;'>".STY(" ",FUNC_batt([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:9px;;position:absolute;;top:45px;;right:1px")."</div>"|\
"<div style='position:relative'>\
<div style='position:absolute;;left:9px;;top:6px;;width:14px;;height:27px;;background:linear-gradient( to top, red 0%,yellow 50%,green 100%);;'></div>\
".STY(" ",FUNC_batt2([HMdummy_Labor:level])).STY([HMdummy_Labor:level]."%","font-size:6px;;position:absolute;;top:15px;;left:10px").STY(FW_makeImage("measure_battery_0"))."</div>"

defmod HMdummy_Labor dummy
attr HMdummy_Labor group Labor: uiTable
attr HMdummy_Labor room DOIF_Labor
attr HMdummy_Labor userReadings desired-temp {ReadingsNum($name,"state",7)}

defmod HMsensor_Labor DOIF ([+1])\
(setreading HMdummy_Labor measured-temp {(if ([HMdummy_Labor:measured-temp] < [HMdummy_Labor:desired-temp]){[HMdummy_Labor:measured-temp]+.5} else {7})},\
setreading HMdummy_Labor level {(if ([HMdummy_Labor:level] < 100){[HMdummy_Labor:level]+5} else {0})})
attr HMsensor_Labor do always
attr HMsensor_Labor group Labor: uiTable
attr HMsensor_Labor room DOIF_Labor
attr HMsensor_Labor webCmd enable:disable

setstate HMdummy_Labor desired-temp 29
setstate HMdummy_Labor 2017-11-10 12:36:07 desired-temp 29
setstate HMdummy_Labor 2017-11-10 12:36:07 level 85
setstate HMdummy_Labor 2017-11-10 12:36:07 measured-temp 28
setstate HMdummy_Labor 2017-11-06 12:04:39 state desired-temp 29

setstate HMsensor_Labor disabled
setstate HMsensor_Labor 2017-11-10 12:36:07 cmd 1
setstate HMsensor_Labor 2017-11-10 12:36:07 cmd_event timer_1
setstate HMsensor_Labor 2017-11-10 12:36:07 cmd_nr 1
setstate HMsensor_Labor 2017-11-10 12:36:07 last_cmd cmd_1
setstate HMsensor_Labor 2017-11-10 12:36:07 mode disabled
setstate HMsensor_Labor 2017-11-10 12:36:07 state disabled
setstate HMsensor_Labor 2017-11-10 13:26:42 timer_01_c01 10.11.2017 13:26:43

setstate verticalGradiend_Labor initialized
setstate verticalGradiend_Labor 2017-11-09 08:59:32 cmd 0
setstate verticalGradiend_Labor 2017-11-09 08:59:32 state initialized
</syntaxhighlight>

== Abwechselnde Anzeige zweier Größen an gleicher Position ==
{{Randnotiz|RNText=Besonderheiten
* HTML-Attribute <code>class</code>
* CSS-Datei und Attribute <code>@keyframes</code>, <code>animation</code>, <code>overflow</code>, <code>opacity</code>, <code>height</code>
}}
[[Datei:UiTable_swapValues1.png|height 100px|thumb|right|Feuchte als erste Größe]][[Datei:Uitable_swapValues2.png|height 100px|thumb|right|Temperatur als zweite Größe]]

Die Größen Feuchte und Temperatur werden abwechselnd angezeigt

=== Aufbau der Kombination ===
Der Zelleninhalt hat folgende Struktur.
<syntaxhighlight lang="html">
<div 1. Klasse mit Wert als Inhalt>Wert</div>
<div 2. Klasse mit Wert als Inhalt>Wert</div>
</syntaxhighlight>

=== Die Definition des [[Attribute|Attributes]] '''uiTable''' ===
<syntaxhighlight lang="perl">
"<div class='humchange' >".STY([$SELF:humidity],"font-size:16pt;font-weight:bold;color:red;")." relH%</div>
<div class='tempchange' >".STY([$SELF:temperature:d1],"font-size:16pt;font-weight:bold;color:blue;")."°C</div>"
</syntaxhighlight>

=== Die dazu gehörende CSS-Definition ===
Damit die Wechselnde Anzeige funktioniert, muss die Definition in eine Datei kopiert werden, die Dateiendung muss ''css'' sein (uitable_changer.css). Die Datei ist in das Verzeichniss ./pgm2 zu kopieren. Sie muss dann über das FHEMWEB-Attribut <code>attr <fhemwebname> CssFiles pgm2/uitable_changer.css</code> eingebunden werden.

<syntaxhighlight lang="css">
div.humchange {
opacity: 0;
height: 0;
overflow: hidden;
animation: humidity 15s infinite ease-in;
}
div.tempchange {
opacity: 1
height: auto;
overflow: hidden;
animation: temperature 15s infinite ease-in;
}

@keyframes humidity {
0% {
opacity: 0;
height: auto;
}
0.001% {
opacity: 0;
height: auto;
}
5% {
opacity: 1;
height: auto;
}
45% {
opacity: 1;
height: auto;
}
49.999% {
opacity: 0;
height: auto;
}
50% {
opacity: 0;
height: 0;
}
100% {
opacity: 0;
height: 0;
}
}
@keyframes temperature {
0% {
opacity: 0;
height: 0;
}
49.999% {
opacity: 0;
height: 0;
}
50% {
opacity: 0;
height: auto;
}
55% {
opacity: 1;
height: auto;
}
95% {
opacity: 1;
height: auto;
}
100% {
opacity: 0;
height: auto;
}
}
</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang="perl">
defmod swapValues_Labor DOIF (1) ## HMsensor_Labor HMdummy_Labor
attr swapValues_Labor group Labor: uiTable
attr swapValues_Labor room DOIF_Labor,DOIFalone
attr swapValues_Labor uiTable "<div class='humchange' >".STY([$SELF:humidity],"font-size:16pt;;font-weight:bold;;color:red;;")." relH%</div>\
<div class='tempchange' >".STY([$SELF:temperature:d1],"font-size:16pt;;font-weight:bold;;color:blue;;")."°C</div>"

setstate swapValues_Labor initialized
setstate swapValues_Labor 2017-11-13 10:44:16 cmd 0
setstate swapValues_Labor 2017-11-14 17:01:24 humidity 82
setstate swapValues_Labor 2017-11-13 10:44:16 state initialized
setstate swapValues_Labor 2017-11-14 17:01:24 temperature 20.7
</syntaxhighlight>

== Anzeige der uiTable anderer DOIF als Popup-Fenster ==
{{Randnotiz|RNText=Besonderheiten
* DOIF-Funktion <code>PUP(<Name des anderen DOIF>,<Iconname@optionale Farbe>)</code>, wenn das Icon nicht existiert wird der Text als Link in Standardfarbe angezeigt.
}}
[[Datei:UiTable_PopUp.png|height 100px|thumb|right|Link oder Icon zur Anzeige eines Popup-Fensters]]

In einer uiTable können die UI-Tabellen anderer DOIF als Popup-Fenster angezeigt werden.

=== Die Definition des [[Attribute|Attributes]] '''uiTable''' ===
Die Funktion <syntaxhighlight lang="perl" inline>PUP("Grundriss_Labor","control_building_modern_s_okg_eg\@orange")</syntaxhighlight> erzeugt einen Link mit einem orange gefäbten Icon '''control_building_modern_s_okg_eg''', der die UI-Tabelle des DOIF '''Grundriss_Labor''' in einem Popup-Fenster anzeigt.

<syntaxhighlight lang="perl">
PUP("Grundriss_Labor","control_building_modern_s_okg_eg\@orange")
PUP("Grundriss_position_Labor","control_building_modern_s_okg_og\@orange")
</syntaxhighlight>

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
<syntaxhighlight lang="perl">
defmod PopUp_Labor DOIF (1) ## Grundriss_position_Labor Grundriss_Labor
attr PopUp_Labor group Labor: uiTable
attr PopUp_Labor room myHome,DOIF_Labor
attr PopUp_Labor uiTable PUP("Grundriss_Labor","control_building_modern_s_okg_eg\@orange")\
PUP("Grundriss_position_Labor","control_building_modern_s_okg_og\@orange")

defmod Grundriss_Labor DOIF (1)
attr Grundriss_Labor group Labor: uiTable
attr Grundriss_Labor room DOIF_Labor
attr Grundriss_Labor uiTable {\
$TABLE = " text-align:center;;width:300px;; height:300px;; background-image:url(./fhem/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TR{1,3} = "class=''";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
"Schlafen",WID([$SELF:SZ],$TPL{switch})|"Küche",WID([$SELF:Kue],$TPL{switch})|" Bad ; ; ;",WID([$SELF:Bad],$TPL{switch})\
" "|" "|" Diele ",WID([$SELF:Diele],$TPL{switch})\
"Wohnen A",WID([$SELF:WZ1],$TPL{switch})|" ;<br>Kind ",WID([$SELF:Ki],$TPL{switch})|" "\
"Wohnen B",WID([$SELF:WZ2],$TPL{switch})|" ;<br>Balkon ; ; ;",WID([$SELF:Balkon],$TPL{switch})|" "

defmod Grundriss_position_Labor DOIF (1)
attr Grundriss_position_Labor group Labor: uiTable
attr Grundriss_position_Labor room DOIF_Labor
attr Grundriss_position_Labor uiTable {\
$ATTRIBUTESFIRST = 1;;\
$TABLE = "font-size:10pt;;position:relative;; text-align:center;;width:300px;; height:300px;; background-image:url(./fhem/www/pgm2/images/Grundriss.svg);; background-size: 300px 300px;;";;\
$TPL{switch}="iconSwitch,on,off,off,on";;\
}\
\
DEF TPL_Objekt("<div style='position:absolute;; Left:".$1."px;; top:".$2."px;;'>".$3.WID($4,$TPL{switch})."</div>")\
\
TPL_Objekt("35","25","Schlafen<br>",[$SELF:SZ])|\
TPL_Objekt("145","25","Küche<br>",[$SELF:Kue])|\
TPL_Objekt("225","25","Bad<br>",[$SELF:Bad])|\
TPL_Objekt("145","105","Diele ",[$SELF:Diele])|\
TPL_Objekt("35","160","Wohnen A<br>",[$SELF:WZ1])|\
TPL_Objekt("35","220","Wohnen B<br>",[$SELF:WZ2])|\
TPL_Objekt("145","160","Kind<br>",[$SELF:Ki])|\
TPL_Objekt("145","250","Balkon<br>",[$SELF:Balkon])

setstate Grundriss_Labor initialized
setstate Grundriss_Labor 2017-11-04 07:45:28 Bad off
setstate Grundriss_Labor 2017-11-04 07:45:22 Balkon off
setstate Grundriss_Labor 2017-11-04 07:45:28 Diele off
setstate Grundriss_Labor 2017-11-04 07:45:42 Ki on
setstate Grundriss_Labor 2017-11-04 18:47:30 Kue on
setstate Grundriss_Labor 2017-11-04 18:47:31 SZ on
setstate Grundriss_Labor 2017-11-04 07:45:46 WZ1 on
setstate Grundriss_Labor 2017-11-04 07:45:23 WZ2 off
setstate Grundriss_Labor 2017-11-04 19:10:03 cmd 0
setstate Grundriss_Labor 2017-11-04 19:10:03 state initialized

setstate Grundriss_position_Labor initialized
setstate Grundriss_position_Labor 2017-11-05 14:39:22 Bad off
setstate Grundriss_position_Labor 2017-11-05 14:38:46 Balkon off
setstate Grundriss_position_Labor 2017-11-05 14:39:30 Diele off
setstate Grundriss_position_Labor 2017-11-29 14:04:19 Ki off
setstate Grundriss_position_Labor 2017-11-26 16:21:37 Kue off
setstate Grundriss_position_Labor 2017-11-29 14:05:41 SZ off
setstate Grundriss_position_Labor 2017-11-05 14:38:43 WZ1 off
setstate Grundriss_position_Labor 2017-11-29 14:04:46 WZ2 off
setstate Grundriss_position_Labor 2017-11-04 21:29:59 cmd 0
setstate Grundriss_position_Labor 2017-11-04 21:29:59 state initialized

setstate PopUp_Labor initialized
setstate PopUp_Labor 2017-11-29 16:04:05 cmd 0
setstate PopUp_Labor 2017-11-29 16:04:05 state initialized
</syntaxhighlight>

== Anzeige einer uiTable über [[weblink]] als Popup-Fenster ==
{{Randnotiz|RNText=Besonderheiten
* DOIF-Funktion <code>DOIF_tablePopUp(<Name des DOIF auf dessen UI-Tabelle verwiesen werden soll>,<Name des DOIF auf dessen UI-Tabelle verwiesen werden soll>,<Iconname@optionale Farbe>)</code>, wenn das Icon nicht existiert wird der Text als Link in Standardfarbe angezeigt.
}}
In einer [[weblink]] Definition kann ein Link auf eine uiTable angelegt werden. Damit kann die UI-Tabelle eines DOIF als Popup-Fenster angezeigt werden.

=== Die Definition des [[weblink]] ===
Die Funktion <syntaxhighlight lang="perl" inline>DOIF_tablePopUp("PopUp_Labor","PopUp_Labor","rc_PLUS\@orange")</syntaxhighlight> erzeugt einen Link mit einem orange gefäbten Icon '''rc_PLUS''', der die UI-Tabelle des DOIF '''PopUp_Labor''' in einem Popup-Fenster anzeigt. Aus Gründen der Kompatibilität muss der Name des DOIF auf dessen UI-Tabelle der Link verweisen soll, zweimal angegeben werden. Der Kurzname <code>PUP</code> kann hier nicht verwendet werden.

=== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ===
Das Beispiel funktioniert nur, wenn die Definitionen aus dem vorhergehenden Beispile angelegt sind.
<syntaxhighlight lang="perl">
defmod WebLink_Labor weblink htmlCode {DOIF_tablePopUp("PopUp_Labor","PopUp_Labor","rc_PLUS\@orange")}
attr WebLink_Labor group Labor: uiTable
attr WebLink_Labor room DOIF_Labor

setstate WebLink_Labor initialized
</syntaxhighlight>

== Uhrzeit und Datum ==
=== Darstellung einer Analoguhr ===
[[Datei:Analoguhr_uiTable.png|100px|thumb|right|Beispiel für eine Analoguhr]]
Auf der Seite [http://3quarks.com/de/Bahnhofsuhr/ http://3quarks.com/de/Bahnhofsuhr/] wird ein Javascript für eine Analoguhr bereitgestellt und die Konfiguration beschrieben.

Das in diesem Forenbeitrag {{Link2Forum|Topic=77690|Message=727276|LinkText=Analoguhr für uiTable}} bereitgestellte Script ''doifanaloguhr.js'' zum Laden und Starten des Uhrenscriptes ''station-clock.js'', ist in der betroffenen FHEMWEB-Instanz über das Attribut JavaScripts einzubinden.
Die beiden Javascripte ''station-clock.js'' und ''doifanaloguhr.js'' müssen in dem Verzeichnis pgm2 enthalten sein. Die Datei ''doifanaloguhr.js'' ersetzt ''excanvas.js''. In ''doifanaloguhr.js'' ist bei Bedarf die Konfiguration des Erscheinungsbildes der Uhr vorzunehmen.
<syntaxhighlight lang="perl">attr <Name der FHEMWEB-Instanz> pgm2/station-clock.js</syntaxhighlight>
Im Attribut '''uiTable''' eines DOIF ist Uhr mit einem canvas-Element einzubinden, z.B.
<syntaxhighlight lang="html">"<canvas id='doifanaloguhr' width='50' height='50'>error</canvas>"</syntaxhighlight>

=== Darstellung von Zeit und Datum ===
[[Datei:Timedate Labor.png|200px|thumb|right|Beispiele für Zeit und Datum]]

Mit dem in diesem Forenbeitrag {{Link2Forum|Topic=77690|Message=729761|LinkText=Zeit und Datum in uiTable}} bereitgestellten Script ''doiftimedate.js'' können Datum und Uhrzeit in verschiedenen Darstellungsweisen angezeigt werden.
Das Script muss in das Verzeichnis pgm2 kopiert werden und in die entsprechende FHEMWEB-Instanz eingebunden werden über:
<syntaxhighlight lang="perl">attr <Name der FHEMWEB-Instanz> pgm2/doiftimedate.js</syntaxhighlight>
Im Attribut '''uiTable''' eines DOIF sind die Zeit- u. Datumteile über einen Klassennamen einzubinden, z.B.
<syntaxhighlight lang="html">"<span class='doif-hour'>hour</span>"</syntaxhighlight>
um Stunden anzuzeigen.

Die drei ersten Zeilen des Bildes sind eingebaute Darstellungsweisen, die vierte Zeile ist aus den einzelnen Bestandteilen eines Datums zusammengesetzt.

Die möglichen Klassennamen gehen aus der nachstehenden uiTable-Definition hervor.
<syntaxhighlight lang="html">
"<div class='doif-hourminute'>hourminute</div>"

"<div class='doif-date'>date</div>"

"<div class='doif-hourminutedate'>hourminutedate</div>"

"<div style='color:orange;font-size:16pt;font-weight:bold;'>
<span class='doif-hour'>hour</span>
:<span class='doif-minute'>minute</span>
:<span class='doif-second'>second</span>
, <span class='doif-day'>day</span>
.<span class='doif-month'>month</span>
.<span class='doif-year'>year</span>
</div>"</syntaxhighlight>

==== Beispiel für [[Import_von_Code_Snippets|Raw definition]] ====
<syntaxhighlight lang="perl">
defmod timedate_Labor DOIF (#1)
attr timedate_Labor group Labor: uiTable
attr timedate_Labor room DOIF_Labor
attr timedate_Labor uiTable "<div class='doif-hourminute'>hourminute</div>"\
\
"<div class='doif-date'>date</div>"\
\
"<div class='doif-hourminutedate'>hourminutedate</div>"\
\
"<div style='color:orange;;font-size:16pt;;font-weight:bold;;'>\
<span class='doif-hour'>hour</span>\
:<span class='doif-minute'>minute</span>\
:<span class='doif-second'>second</span>\
, <span class='doif-day'>day</span>\
.<span class='doif-month'>month</span>\
.<span class='doif-year'>year</span>\
</div>"
</syntaxhighlight>

== Weitere Hinweise ==
=== Arbeitsfläche der Detailansicht für die Bearbeitung von uiTable einrichten ===
{{Randnotiz|RNText=Besonderheiten
* Steuervariable <code>$ATTRIBUTESFIRST=1;</code>
}}
[[Datei:Attributesfirst.png|200px|thumb|right|Beispiel für die veränderte Detailansicht]]
Zum Erstellen der UI-Tabelle, wird das Attribut uiTable häufiger gesetzt, um Veränderungen in der uiTable sichtbar zu machen.
Damit beim Wechsel zwischen der Ansicht der UI-Tabelle und der Attributbearbeitung nicht immer über den DEF-Bereich und die Readings gescrollt werden muss können die Attribute unter die UI-Tabelle geschoben werden.
Wenn die Steuervariable <code>$ATTRIBUTESFIRST=1;</code> im oberen Bereich der Tabellendefinition angegeben wird, dann werden die Attribute vor den DEF-Bereich verschoben.

=== Browserunterstützung ===
Die verschiedenen Browser, Versionen und Mobile-Varianten unterstützen CSS unterschiedlich, siehe z.B. [https://www.w3schools.com/cssref/css3_browsersupport.asp W3Schools CSS Browser Support Reference]

Zur Problemlösung können die entsprechenden Entwicklerseiten beitragen.

* Mozilla [https://developer.mozilla.org/de/docs/Web/CSS https://developer.mozilla.org/de/docs/Web/CSS]
* Google [https://developers.google.com/web/tools/chrome-devtools/css/ https://developers.google.com/web/tools/chrome-devtools/css/]
* Apple [https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariCSSRef/Introduction.html https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariCSSRef/Introduction.html]
* Microsoft [https://msdn.microsoft.com/de-de/library/cc351024(v=vs.85).aspx https://msdn.microsoft.com/de-de/library/cc351024(v=vs.85).aspx]

== Links ==
* [[DOIF]]
* [[DOIFtools#Farbtabellen_erzeugen|DOIFtools Farbtabellen anzeigen]]
* Style-Attribute [https://www.w3schools.com/cssref/default.asp https://www.w3schools.com/cssref/default.asp]
* Liste der aktuellen HTML-Elemente [https://developer.mozilla.org/de/docs/Web/HTML/HTML5/HTML5_element_list https://developer.mozilla.org/de/docs/Web/HTML/HTML5/HTML5_element_list]

[[Kategorie:HOWTOS]]
[[Kategorie:Code Snippets]]

DevelopmentGuidelinesAV

2017-06-27T21:46:03Z

50watt: /* Implementation in Modulen */ Pioneer stateAV & playStatus

== Einleitung ==
Auf dieser Seite sollen Richtlinien für AV-Module gesammelt werden damit es einfacher wird diese zusammen mit anderen Modulen wie remotecontroll oder LightScene zu verwenden. Auch Benachrichtigungen wie Sprachdurchsagen oder Einblendungen lassen sich universeller verwenden wenn sie bei allen Geräten die dies unterstützen gleich angesprochen werden.

Der Text aus dem ursprünglichen Forumsthread war folgender:

::gerade ist ja mit den tv und verstärker modulen sowie dem remotecontrol modul ziemlich schwung in den bereich audio und video geräte gekommen. zusätzlich gibt es noch eine ganze reihe älterer module wie sonor und xbmc und zwei arten itunes anzusprechen und neue module wie für die web radios oder das raspberry multiroom stehen vor der tür.

::wie wäre es sich rechtzeitig auf ein möglichst einheitiches kommando set zu verständigen damit grundlegende dinge wie play/pause/volume/next bei allen geräten einheitlich, in gleicher schreibweise und mit möglichst ähnlichen parametern funktionieren?

::das würde module wie die remotecontrol aber auch structure und lightscene deutlich einfacher und nützlicher machen und auch alternative frontends erleichtern wenn bestimmte features wie audio,video oder cover über ein einheitliches schema markiert würden.

::mein vorschlag wäre sich an das sonos modul anzulehnen weil es mir in dieser hinsicht am fortgeschrittensten erscheint und auch weitergehende features wie cover oder durchsagen anbietet.

::zu vereinheitlichen wäre dann u.a.:
::- welche kommandos zu welchem zweck
::- kommandos sollten einheitlich geschrieben werden. also z.b. immer klein oder immer mixed case.
::- parameter sollten so weit möglich den gleichen wertebereich haben. also z.b. volume immer von 0-100.
::- wenn es aus irgendeinem grund noch ein gerätespezifischer wertebereich nötig ist sollte der zusätzlich vorhanden sein.
::- cover sollten immer auf die gleiche art gelesen werden können
::- ...

Der Thread ist {{Link2Forum|Topic=13784|LinkText=hier}} zu finden.

== Bezeichner ==
siehe [[DevelopmentGuidelines#Bezeichnungen|Bezeichnungen allgmein]]

== Kommandos ==

Diese Tabelle soll eine einheitliche Definition von set-Befehlen aufzeigen. Dazu zählen auch ggf. Parameter und deren Bedeutung.

{| class="wikitable sortable"
! Name !! Parameter !! Bedeutung
|-
| '''on''' || || Schaltet das Gerät ein, so dass es benutzt werden kann.
|-
| '''off''' || || Schaltet das Gerät aus.
|-
| '''play''' || || Startet das Abspielen von Medien (Video, mp3, Radio stream etc.)
|-
| '''pause''' || || Pausiert das Abspielen von Medien, stoppt es aber nicht.
|-
| '''stop''' || || Stoppt (beendet) das Abspielen von Medien.
|-
| '''volume''' || 0 - 100 || Setzt die Lautstärke auf einen prozentualen Wert.
|-
| '''volumeStraight''' || X-Y || Setzt die Lautstärke auf den absoluten Wert, so wie er vom Gerät tatsächlich verwendet wird (z.B. dB)<br><br>''Nur zu Verwenden, wenn das Gerät einen anderen Wertebereich als 0-100% intern verwendet.''
|-
| '''volumeUp''' || [0 - 100] || Erhöht die Lautstärke um einen gerätespezifischen Schritt (z.b. 5%). Wenn die Schrittweite konfigurierbar ist soll das über das Attribut volumeStep erfolgen. Optional kann das Inkrement als optionaler Parameter mit angegeben werden.
|-
| '''volumeDown''' || [0 - 100] || Verringert die Lautstärke um einen gerätespezifischen Schritt (z.b. 5%). Wenn die Schrittweite konfigurierbar ist soll das über das Attribut volumeStep erfolgen. Optional kann das Dekrement als optionaler Parameter mit angegeben werden.
|-
| '''mute''' || <nowiki>on | off | toggle</nowiki> || Aktiviert, deaktiviert oder schaltet die Mutefunktion = Lautstärke der aktuellen Ausgabe wird verringert bzw. abgschaltet (Gerätespezifisch)
|-
| '''repeat''' || <nowiki>one | all | off</nowiki> || Aktivieren der Repeatfunktion = wiederholen des aktuellen Titels/Albums
|-
| '''shuffle''' || <nowiki>on | off</nowiki> || Aktiviert oder deaktiviert die Shufflefunktion = zufällige Wiedergabe.
|-
| '''channel''' || 0 - 9999 || Schaltet auf einen absoluten Sender- oder Programmspeicherplatz (Nicht zu verwechseln mit input)
|-
| '''channelUp''' || || Springt zum nächsten Sender- oder Programmspeicherplatz.
|-
| '''channelDown''' || || Springt zum vorherigen Sender- oder Programmspeicherplatz.
|-
| '''remoteControl''' || # || Parameter ist Hersteller- und Gerätespezifisch. Funktion bei Geräten, die es erlauben die mitgelieferte Hardware Fernbedienung zu simulieren. Parameter in lowerCamelCaps (ggf. muss im Modul selber auf die Herstellerspezifische Schreibweise umcodiert werden; Alles groß- oder klein geschrieben)
|-
| '''input''' || <nowiki>z.B. hdmi[1-n] | av[1-n] | usb | airplay | server [1-n]</nowiki> || Auswahl von Hardwarekanälen (HDMI, DVB-S, PAL, DVI) oder Softwarekanälen (Airplay, IPTV, IP-Radiostream) die das zu steuernde Gerät aktiv schalten soll (zur Darstellung auf TV, Kanalwahl bei AV-Receivern etc.). Da diese Kanäle je nach Gerät und Modellreihen unterschiedliche Bezeichnungen besitzen, sollten alle möglichen Bezeichnungen in Form von lowerCamelCaps angeboten werden.
|-
| '''output''' || <nowiki>z.B. Airtunes1,Airtunes2,Intern</nowiki> || Auswahl des/der Ausgabegerätes.
|-
| '''statusRequest''' || || Den aktuellen Status des Gerätes abfragen
|-
|colspan="3"| ...
|}

== Readings ==

Diese Tabelle soll eine einheitliche Wertedefinition von Readings. Dazu zählen auch die verwendeten Werte und deren Bedeutung.

Wenn es zwischen reading und zugehörigen set eine 1:1 Beziehung gibt sollte sich der Inhalt des readings als Argument des set verwenden lassen um genau diesen dargestellten Zustand zu erreichen.

{| class="wikitable"
|-
! Name !! mögliche Werte !! Bedeutung
|-
| '''power''' || <nowiki>on|off</nowiki> || Ist das Gerät an oder aus?
|-
| '''presence''' || <nowiki>present|absent</nowiki> || Ist das Gerät aktuell ansprechbar? Sollte das Gerät aufgrund abgeschalteten Stromzufuhr, o.ä. aktuell nicht steuerbar sein, so sollte dies mit dem Wert "absent" verdeutlicht werden. In solch einem Fall sollte ein set-Befehl eine entsprechende Fehlermeldung bringen. Evtl. StatusUpdate-Timer sollten ensprechende Fehlermeldungen nur einmal im Log, etc. festhalten und Fehlermeldungen beim nächsten Status-Update entsprechend unterdrücken um so die Logfiles nicht unnötig vollzuschreiben. Auch das presence reading sollte nur dann aktualisiert werden wenn sich der Status geändert hat um am timestamp sehen zu können wann das war. event-on-change-reading ist hierzu nicht ausreichend weil nur das Event unterdrückt wird der Timestamp sich aber trotzdem ändert.
|-
| '''volume''' || 0-100 || Der prozentuale Lautstärkepegel gemessen der maximal möglichen tatsächlichen Werte.
|-
| '''volumeStraight''' || X-Y || Der tatsächliche Lautstärkepegel des Gerätes, so wie er am Gerät angezeigt/verwendet wird. <br><br>''Nur zu Verwenden, wenn das Gerät einen anderen Wertebereich als 0-100% intern verwendet.''
|-
| '''mute''' || <nowiki>on | off</nowiki> || Ist das Gerät aktuell stumm geschaltet?
|-
| '''repeat''' || <nowiki>one | all | off</nowiki> || Ist das Gerät im repeat modus?
|-
| '''shuffle''' || <nowiki>on | off</nowiki> || Ist das Gerät im shuffle modus?
|-
| '''input''' || ''aktuell gewählter Eingangskanal'' ||
|-
| '''output''' || ''aktuell gewählte(s) Ausgabegerät(e)'' ||
|-
| '''channel''' || ''aktuell gewählter Eingangskanal entsprechend dem Gerät''||
|-
| '''currentArtist''' || ''aktueller Interpret'' ||
|-
| '''currentAlbum''' || ''aktuelles Album'' ||
|-
| '''currentTitle''' || ''aktueller Titelname'' ||
|-
| '''currentMedia''' || ''"Name" der Wiedergabe"datei"'' || kann alles sein: Datei vom Filesystem, Stream aus dem Internet, m3u-URL oder was auch immer
|-
| '''playStatus''' || <nowiki>playing | paused | stopped</nowiki> ||
|-
| '''state''' || <nowiki>on | off | absent</nowiki> || Sofern das Gerät empfangsbereit ist, soll der Schaltzustand des Gerätes (Reading: power, sofern anwendbar) zurückgegeben werden. Ansonsten ist die Abwesenheit des Gerätes durch den Wert "absent" anzuzeigen.
|-
| '''stateAV''' || <nowiki><presence> | <power> | <mute> | <playStatus></nowiki> || Kombiniert den Status von bestehenden Readings zu einer logisch abhängigen Einheit nach folgendem Format: Wenn presence=absent=>absent, sonst power=off=>off, sonst mute=on=>muted, sonst playStatus!=stopped=>playStatus, sonst =>power. Das Reading gilt auch als Ersatz für das normale state Reading, wenn dieses z.B. bei Verwendung von DevIO nicht die genannten Status annimmt, sondern denen von DevIO entspricht (appeared, disappeared).
|-
|colspan="3"| ...
|}

== Implementation in Modulen ==
{{yes}} = Implementiert {{yes2}} = device spezifisch {{planed}} = Implementation geplant/in Arbeit {{no}} = Nicht implementiert/Keine Implementation geplant

{| class="wikitable"
! set-Befehl !! LGTV !! LISTENLIVE !! STV !! VIERA !! YAMAHA_AVR !! iTunes !! ENIGMA2 !! ONKYO_AVR !! Squeezebox !! PHTV !! PIONEER !! harmony !! plex
|-
| '''on''' || || || || {{no-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} ||
|-
| '''off''' || || || || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} ||
|-
| '''play''' || || || || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{yes-c}}
|-
| '''pause''' || || || || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{yes-c}}
|-
| '''stop''' || || || || {{no-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{yes-c}}
|-
| '''volume''' || || || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}}
|-
| '''volumeStraight''' || || || || {{no-c}} || {{yes-c}} || {{no-c}} || {{no-c}} || {{planed-c}}|| {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{no-c}}
|-
| '''volumeUp''' || || || || {{yes-c}} || {{yes-c}} || {{planed-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{no-c}}
|-
| '''volumeDown''' || || || || {{yes-c}} || {{yes-c}} || {{planed-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{no-c}}
|-
| '''mute''' || || || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{no-c}}
|-
| '''repeat''' || || || || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes2-c}} || {{yes-c}} || {{no-c}} || {{yes2-c}} || {{yes2-c}} || {{yes-c}}
|-
| '''shuffle''' || || || || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes2-c}} || {{yes-c}} || {{no-c}} || {{yes2-c}} || {{yes2-c}} || {{yes-c}}
|-
| '''channel''' || || || || {{yes-c}} || {{no-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{no-c}}
|-
| '''channelUp''' || || || || {{yes-c}} || {{no-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{no-c}}
|-
| '''channelDown''' || || || || {{yes-c}} || {{no-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{no-c}}
|-
| '''remoteControl''' || || || || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes2-c}} || {{yes2-c}} || {{no-c}}
|-
| '''input''' || {{yes-c}} || || || {{no-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}}|| {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{no-c}}
|-
| '''output''' || || || || {{no-c}} || {{no-c}} || {{yes-c}} || {{no-c}} || {{no-c}} || {{no-c}} || {{no-c}} || {{no-c}} || {{yes2-c}} || {{no-c}}
|-
| '''statusRequest''' || || {{yes-c}} || || {{yes-c}} || {{yes-c}} || {{planed-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{no-c}}
|-
! Reading !! LGTV !! LISTENLIVE !! STV !! VIERA !! YAMAHA_AVR !! iTunes !! ENIGMA2 !! ONKYO_AVR !! Squeezebox !! PHTV !! PIONEER !! harmony
|-
| '''power''' || || || || {{yes-c}} || {{yes-c}} || {{planed-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} ||
|-
| '''presence''' || || || || {{yes-c}} || {{yes-c}} || {{planed-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}}
|-
| '''volume''' || || || || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}}
|-
| '''volumeStraight''' || || || || {{no-c}} || {{yes-c}} || {{no-c}} || {{no-c}} || {{planed-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{no-c}}
|-
| '''mute''' || || || || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{planed-c}}
|-
| '''repeat''' || || || || {{no-c}} || {{no-c}} || {{yes-c}} || {{no-c}} || {{yes2-c}} || {{yes-c}} || {{no-c}} || {{no-c}} || {{no-c}} || {{planed-c}}
|-
| '''shuffle''' || || || || {{no-c}} || {{no-c}} || {{yes-c}} || {{no-c}} || {{yes2-c}} || {{yes-c}} || {{no-c}} || {{no-c}} || {{no-c}} || {{planed-c}}
|-
| '''input''' || || || || {{no-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{no-c}}
|-
| '''output''' || || || || {{no-c}} || {{no-c}} || {{yes-c}} || {{no-c}} || {{no-c}} || {{no-c}} || {{no-c}} || {{no-c}} || {{no-c}} || {{no-c}}
|-
| '''channel''' || || || || {{yes-c}} || {{no-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{no-c}}
|-
| '''currentArtist''' || || || || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{no-c}} || {{yes-c}}
|-
| '''currentAlbum''' || || || || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{no-c}} || {{yes-c}}
|-
| '''currentTitle''' || || || || {{no-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{no-c}} || {{yes-c}}
|-
| '''currentMedia''' || || || || {{no-c}} || {{no-c}} || {{planed-c}} || {{yes-c}} || {{planed-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{no-c}} ||
|-
| '''playStatus''' || || || || {{no-c}} || {{yes-c}} || {{yes-c}} || {{planed-c}} || {{yes2-c}} || {{yes-c}} || {{no-c}} || {{yes2-c}} || {{no-c}} ||
|-
| '''state''' || || || || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{yes2-c}} || {{yes-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}}
|-
| '''stateAV''' || || || || {{no-c}} || {{no-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{yes-c}} || {{yes-c}} || {{no-c}} || {{no-c}}
|}

== Sonstiges ==
=== Wie funktioniert Cover Art? ===
Reading mit URL-Link oder als Gerätestatus???

=== Wie funktionieren Sprachdurchsagen oder Text Einblendungen? ===

Obwohl dies sehr stark davon abhängt, ob das jeweilige Gerät eine solche Funktion unterstützt, oder ob sie anderweitig (z.B. durch Google Service) umgesetzt werden können, so sollen dennoch solche Features über die folgenden Set-Kommandos angeboten werden.
{| class="wikitable"
|-
! Kommando !! Beispiel !! Beschreibung
|-
| '''sayText'''|| <pre>set ''<device>'' sayText "Anruf in Abwesenheit"</pre>
|| Dieses Kommando soll den übergebenen Text auf dem jeweiligen Device in Audio-Form wieder ausgeben. Hierbei kann auf einen Synthese-Anbieter im Internet zurückgegriffen werden, der ein solches Audiosample erzeugt, oder geräteinterne Kommandos verwendet werden, je nach dem was vorhanden und unterstützt wird.
|-
| '''showText''' || <pre>set ''<device>'' showText "Anruf in Abwesenheit"</pre>|| Dieses Kommando soll einen Text z.B. auf dem Display des Gerätes (oder Fernseher) in geeigneter Form anzeigen, sofern das Gerät eine solche Funktion unterstützt.
|-
! colspan="3"| Alternativvorschlag
|-
| '''message''' || <pre>set ''<device>'' message "Anruf in Abwesenheit" [audio|video]</pre>|| Dieses Kommando soll eine Nachricht mit dem Gerät anzeigen (video) oder abspielen (audio), sofern das Gerät eine solche Funktion unterstützt. Ohne die optionale Wiedergabe-Art oder wenn die angegebene nicht unterstützt ist über die von diesem Gerät bevorzugte Methode.
|}

=== Wie funktionieren Playlisten? ===

Sofern anwendbar, sollten diese mit dem Kommando <code>set <device> playlist XY</code> aufrufbar sein. Dabei sollten die zur Verfügung stehenden Playlists bereits bekannt sein und als möglicher Kommando-Parameter angeboten werden.

=== Wie funktionieren Zonen? ===

Jede einzelne Zone eines Gerätes wird durch ein eigenes FHEM-Device repräsentiert. Die gewünschte Zone ist als optionaler Parameter in den Definitions-Argumenten zu übergeben.

Wenn keine bestimmte Zone explizit in der Definition übergeben wird, ist die Hauptzone (Main-Zone) zu verwenden. Die zur Verfügung stehenden Zonen sollten in den Internals aufgelistet sein, mindestens jedoch in der commandref des entsprechenden Moduls.

Jede Definition sollte nur die tatsächlich möglichen Befehle, Eingänge, etc. der entsprechenden Zone anbieten.

[[Kategorie:Development]]

FTUI Widget Push

2017-05-30T19:42:12Z

50watt: /* Lampe für 5 Minuten einschalten */ Tippfehler

Das [[{{PAGENAME}}|Push Widget]] ist ein Widget für [[FHEM Tablet UI]] in Form eines Button-förmigen Knopfes, der, ähnlich einem Taster, einen einfachen Befehl an FHEM sendet (zum Beispiel hoch/runter, Play/Pause, Nächster/vorheriger Titel, usw.). Der Befehl kann beim Drücken, beim Loslassen, oder beide Male ausgeführt werden.

<gallery>
File:Ftui_widget_push.PNG
File:Push1.png
File:Push2.png
File:Ftui_widget_push_on-for-timer.png
</gallery>

==Attribute==
{| class="wikitable"
!Attribut
!Beschreibung
!Standard-Wert
!Beispiel
|-
|'''data-device'''||FHEM-Device, dessen Reading gesetzt werden soll (<command> '''<device>''' <reading> <value>)||||
|-
|'''data-set'''||Reading, das gesetzt werden soll (<command> <device> '''<reading>''' <value>)||||
|-
|'''data-set-on'''||Wert, der beim Drücken gesendet werden soll. Kann auch ein Array sein, um verschiedene Werte abwechselnd zu schalten||on||data-set-on="1"
|-
|'''data-set-off'''||Wert, der nach dem Loslassen gesendet werden soll||||data-set-off="0"
|-
|'''data-cmd'''||Befehl, der gesendet werden soll ('''<command>''' <device> <reading> <value>) (z.B. setstate, set, setreading, trigger)||set||
|-
|'''data-doubleclick'''||Zeit, die vergehen muss, bis das Element ein zweites mal betätigt werden kann. '0' schaltet dieses Verhalten ab.||0||
|-
|'''data-countdown'''||Sekunden für Fortschrittsanzeige (progress control / 'on-for-timer')||Automatische Erkennung von 'on-for-timer' bei '''data-set-on'''||
|-
|'''data-warn'''||Reading, dessen Inhalt als rotes Kennzeichen angezeigt wird. Der Inhalt des Readings muss eine Ganzzahl (Integer) sein.||||
|-
|'''data-get'''||Reading, dessen Inhalt zur Zustandsanzeige (ON/OFF) wird||keiner (muss explizit angegeben werden)||
|-
|'''data-get-on'''||Zeichenkette, die als Zustand ON interpretiert wird||||
|-
|'''data-get-off'''||Zeichenkette, die als Zustand OFF interpretiert wird||||
|-
|'''data-hide'''||Reading zum Verstecken des Push-Elementes. Das Element verschwindet, wenn der Wert mit '''data-hide-on''' übereinstimmt.||STATE||
|-
|'''data-hide-on'''||Zeichenkette, bei der das Element versteckt wird||true,1,on||
|-
|'''data-hide-off'''||Zeichenkette, bei der das Element angezeigt wird||!on||
|-
|'''data-hideparents'''||jQuery-Selector, um auch die Eltern-Elemente zu verstecken||||data-hideparents="#Name"
|-
|'''data-lock'''||Reading, mit dem das Element für eine Bedienung gesperrt wird. Gültige Werte sind ''true'', ''1'' oder ''on''||||
|-
|'''data-reachable'''||Reading, dessen Inhalt angibt, ob das Device erreichbar ist, oder nicht. Der Inhalt des Readings muss eine Ganzzahl (Integer) sein.||||
|-
|'''data-icon'''||Name des Icons im Vordergrund||fa-power-off||
|-
|'''data-background-icon'''||Name des Icons, das als Hintergrund verwendet werden soll||fa-circle-thin||
|-
|'''data-on-color'''||Feste Iconfarbe für den Zustand ON, oder '''<device>:<reading>''', um einen entsprechenden Wert dynamisch aus FHEM abzurufen.||#aa6900||
|-
|'''data-on-background-color'''||Feste Hintergrundfarbe für den Zustand ON, oder '''<device>:<reading>'''||#aa6900||
|-
|'''data-off-color'''||Feste Iconfarbe für den Zustand OFF, oder '''<device>:<reading>''', um einen entsprechenden Wert dynamisch aus FHEM abzurufen.||#505050||
|-
|'''data-off-background-color'''||Feste Hintergrundfarbe für den Zustand OFF, oder '''<device>:<reading>'''||#505050||
|}

==CSS Klassen==
{|class="wikitable"
!Klasse!!Beschreibung
|-
{{FTUI Klasse|height-narrow}}
|}

==Weitere Möglichkeiten==
Das Push-Widget kann auch dazu verwendet werden, Readings darzustellen. Über '''data-get''' und '''data-get-on''' wird beispielsweise der Kreis (Hintergrund-Icon) eingefärbt. Der Wert des Readings selbst wird dann per [[FTUI_Widget_Label|Label]] angezeigt, welches innerhalb des Push-Widgets platziert wird. Siehe hierzu auch den {{Link2Forum|Topic=66800|LinkText=Hinweis im Forum}}.

<source lang="html">
<div data-type="push" ...>
<div data-type="label" ...></div>
</div>
</source>

==Beispiele==
===Alle Lampen einschalten===

<source lang="html">
<div data-type="push"
data-device="LightAll"
data-cmd="trigger"
data-set-on="on">
</div>
</source>

===Steuerung hoch/runter (horizontal)===
[[File:Push1.png]]

<source lang="html">
<div>
<div class="doublebox-h">
<div data-type="push" data-device="Rollo"
data-icon="fa-angle-up" data-background-icon="fa-square-o"
data-set-on="up">
</div>
<div data-type="push" data-device="Rollo"
data-icon="fa-angle-down" data-background-icon="fa-square-o"
data-set-on="down">
</div>
</div>
</div>
</source>

===Steuerung hoch/runter (vertikal)===
[[File:Push2.png]]

<source lang="html">
<div>
<div class="doublebox-v">
<div data-type="push" data-device="Rollo"
data-icon="fa-chevron-up" data-background-icon="fa-square-o"
data-set-on="up">
</div>
<div data-type="push" data-device="Rollo"
data-icon="fa-chevron-down" data-background-icon="fa-square-o"
data-set-on="down">
</div>
</div>
</div>
</source>

===Lampe für 5 Minuten einschalten===
Das Push-Widget zeigt einen abnehmenden Kreis, solange der Countdown läuft. Die Dauer wird automatisch aus dem '''on-for-timer'''-Befehl erkannt. Mit '''data-countdown''' kann jedoch auch auch ein eigener Wert angegeben werden.
Wenn das Device ein Dummy ist, muss in diesem das FHEM-Attribut <code>useSetExtensions 1</code> gesetzt werden. Weitere Beispiele für Timer sind [[FTUI_Zeitschaltung|hier]] zu finden.

[[File:Ftui_widget_push_on-for-timer.png]]

<source lang="html">
<div data-type="push" data-device="MyLamp" data-set-on="on-for-timer 300" ></div>
</source>

===Push-Widget verstecken===

<source lang="html">
<div class="hbox">
<div class="vbox">
<div data-type="push" data-device="ftuitest" data-set-on="1"></div>
<div>on</div>
</div>
<div class="vbox">
<div data-type="push" data-device="ftuitest" data-set-on="0"></div>
<div>off</div>
</div>
<div class="vbox">
<div data-type="push" data-device="dummy1" data-get="STATE" data-get-on="on" data-hide="ftuitest:STATE" data-hide-on="1" class=""></div>
</div>
</div>

</source>

[[Kategorie:FHEM Tablet UI]]