FHEMWiki - Benutzerbeiträge [de]

Remotecontrol

2020-09-05T20:27:22Z

Plaicy: /* Kopplung an das ausführende Gerät */ typo Tastendrücke

{{SEITENTITEL:remotecontrol}}
{{Infobox Modul
|ModPurpose=Grafische Darstellung einer Fernbedienung
|ModType=h

|ModCmdRef=remotecontrol

|ModTechName=95_remotecontrol.pm
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=86 ulimaass]}}

[[Datei:remotecontrol_samsung.jpg|thumb|right|Grafische Darstellung einer Fernbedienung]]
Das Modul '''remotecontrol''' stellt einen Weblink bereit, der eine grafische Abbildung einer physischen Fernbedienung anzeigt, siehe Beispiel rechts. Dieser Weblink kann in FHEM-Frontends wie [[PGM2|FHEMWEB]] oder [[FLOORPLAN]] verwendet werden.

Die Tastenbelegung (das Layout) ist frei wählbar. Standard-Layouts sind für unterschiedliche Geräte verfügbar. Das remotecontrol-device wird per notify an das FHEM-device gekoppelt, das nach einem Tastendruck den Befehl an das physische Gerät sendet.

== Einrichtung ==
=== Define ===
Das define erfolgt nach der üblichen FHEM-Syntax:
<source lang="text">
# Syntax:
define <name> remotecontrol
# Beispiel:
define rc1 remotecontrol
</source>

Damit ist eine leere Fernbedienung (zunächst noch ohne Tasten) angelegt.

Zu Testzwecken kann man sein Device zunächst einem Testraum zuordnen, z. B.
<source lang="text">
attr rc1 room TestRemote
</source>

'''Hinweis:''' Nicht vergessen, nach dem Erzeugen der Fernbedienung die Konfiguration zu speichern. Ansonsten ist sie nach einem Neustart von FHEM nicht mehr vorhanden. Details dazu finden sich auf der Seite [[Konfiguration]].

=== Standard-Tastaturlayouts nutzen ===
Jedes FHEM-Modul kann Tastaturlayouts für das Modul ''remotecontrol'' bereitstellen.

Die Liste der vorhandenen Tastaturlayouts wird angezeigt mit
<nowiki>
# Syntax:
get <name> layout
# Beispiel:
get rc1 layout </nowiki>

Die Liste der vordefinierten Tastaturlayouts wird nun angezeigt.

Ein Tastatur-Layout kann zugeordnet (geladen) werden mit
<nowiki>
# Syntax:
set <name< layout <layoutname<
# Beispiel:
set rc1 layout itunes </nowiki>

'''Hinweis:''' Das Laden von Standard-Layouts ändert die Werte der Attribute row00 - row19. Diese werden erst durch den Befehl ''save'' nach fhem.cfg geschrieben. Soll der Befehl ''save'' nicht verwendet werden, kann die Konfiguration auch manuell in fhem.cfg eingetragen werden. Ein Beispiel befindet sich am Ende dieses Wiki-Artikels.

'''Hinweis:''' Ein Standard-Tastaturlayout wird erst nach dem Laden eines Moduls bereitgestellt. Wenn Sie also erst zu einem späteren Zeitpunkt ein weiteres Modul (z.B. [[VIERA]] für Panasonic-TV) in Ihre Konfiguration aufnehmen, wird ein ggf. vorhandenes remotecontrol-Standard-Layout erst dann angezeigt. Man sollte also auch später ab und zu mit dem o.g. Befehl prüfen, ob für weitere Geräte Standardlayouts vorhanden/hinzugekommen sind.

Im Modul ''remotecontrol'' selbst sind die Beispiel-Layouts "itunes" und "samsung" vorhanden.

=== Eigene Tastaturlayouts einrichten ===
Die Tastatur der Fernbedienung ist aufgeteilt in bis zu 20 Zeilen. Je Zeile können beliebig viele Tasten definiert werden.

Jede Taste auf der Fernbedienung wird definiert durch
* den Befehl, der nach einem Tastendruck ausgeführt werden soll
* das icon, das als Taste erscheinen soll

Man muss also je Taste diese beiden Werte festlegen. Mehrere Tasten in einer Zeile werden jeweils durch ein Komma voneinander getrennt.

==== Icon-Pfad festlegen ====
Einmalig ermitteln, in welchem Ordner die Icons liegen, die für die Tastatur verwendet werden sollen. Die Standard-icons liegen im Ordner <code>www/images/default/remotecontrol</code>. Um das nicht bei jeder Taste angeben zu müssen, setzt man
:<code>attr <name> rc_iconpath icons/remotecontrol</code>

==== Icon-Prefix festlegen ====
Ggf. einmalig einen prefix für Dateinamen festlegen. Die Standard-icons folgen der Namenskonvention black_btn_<Beschreibung>. Um den Teil vor der Beschreibung nicht bei jeder Taste mit angeben zu müssen, setzt man
:<code>attr <name> rc_iconprefix black_btn_</code>

==== Tasten definieren ====
# ermitteln, welcher Befehl an das ausführende FHEM-Gerät gesendet werden soll. Als Beispiel soll der Befehl "play" dienen. Groß-/Kleinschreibung ist zu beachten.
# ermitteln, welches Icon zur Darstellung der Taste verwendet werden soll. Unter den Standardicons gibt es ein icon mit dem Dateinamen black_btn_'''PLAY'''.png. Der vordere Teil ist bereits als prefix hinterlegt, die Datei-Endung muss nicht angegeben werden. Als icon für die Tastaturdefinition kann man also einfach '''PLAY''' angeben. Groß-/Kleinschreibung ist zu beachten.

Nachdem nun der Befehl (play) und der Icon-Name (PLAY) ermittelt sind, können diese - durch einen Doppelpunkt getrennt - als Definition einer Taste hinterlegt werden.

<nowiki>
# Syntax:
attr <name> rowXX <command>:<icon>
# Beispiel:
attr rc1 row00 play:PLAY # als Befehl wird play gesendet, als icon wird PLAY verwendet</nowiki>

Sollen weitere Tasten definiert werden, hängt man sie durch Komma getrennt an.
<nowiki>
# Syntax:
attr <name> rowXX <command>:<icon>[,<command>:<icon>][,....]
# Beipiel:
attr rc1 row01 play:PLAY,anhalten:STOP</nowiki>

Sollen auf der Tastatur Leer-Räume abgebildet werden, gibt man als Tastendefinition ''':blank''' an (also kein Befehl, Icon blank). Das Icon mit dem Namen 'blank' ist vorhanden, hat ein Drittel der regulären Tastenhöhe und ist 100% transparent.

<nowiki>
attr rc1 row02 play:PLAY,:blank,anhalten:STOP</nowiki>

Eine "Trennzeile" lässt sich einfügen durch
<nowiki>
attr rc1 row03 :blank,:blank,:blank</nowiki>

'''Hinweis:''' Manche Browser stellen in einer Zeile, in der die letzte Taste nicht definiert ist, den Rahmen nicht dar. Füllen Sie in diesem Fall die Tastaturzeile mit :blank soweit auf, dass sie dieselbe Anzahl Tasten aufweist wie die längste Tastaturzeile auf Ihrer Fernbedienung.

Für den Fall, dass der Befehl und der Icon-Name identisch sind (incl. Groß-/Kleinschreibung) besteht zur Vereinfachung die Möglichkeit, nur das Kommando anzugeben. Dieses wird dann auch als icon-Name verwendet.

<nowiki>
# Syntax:
attr <name> rowXX [<command>:<icon>|<command_icon>][,[<command>:<icon>|<command_icon>]]...
# Beispiele:
attr rc1 row04 PLAY # als Befehl wird PLAY gesendet, als icon wird PLAY verwendet
attr rc1 row05 PLAY,:blank,anhalten:STOP # auch Mischformen sind möglich</nowiki>

==== Verwenden von .svg-icons ====
Endet der Dateiname nicht auf .svg, verhält sich die die img-Generierung wie oben beschrieben unter Beachtung von rc_iconpath und rc_iconprefix.

Enthält der angegebene Dateiname ".svg" , so wird der svg-Lesemechanismus aus FHEMWEB verwendet. Dabei werden die Attribute rc_iconpath und rc_iconprefix '''ignoriert''', es wird die "ganz normale" Zugriffsfolge verwendet wie im FHEMWEB-Attribut iconPath gesetzt (z. B. fhemSVG:openautomation:default)

<nowiki>
Attributes:
rc_iconpath icons
row00 play:audio_play.svg # svg-icon ohne Farbangabe
row01 oldplay:remotecontrol/black_btn_PLAY # nicht-svg-icon, Pfadangabe bei iconpath "icons"
row02 redplay:audio_play.svg@red # svg-icon mit Farbangabe</nowiki>

==== Neue Icons für Tasten erstellen und verwenden ====
Im Ordner www/images/default/remotecontrol liegt das Template für weitere Tasten. Die Datei heisst _black_btn_template.pdn und kann z. B. mit paint.net bearbeitet werden.

Neue Dateien bitte als png analog der vorhandenen Namenskonvention erstellen: Prefix black_btn_, Beschreibung in Grossbuchstaben.

Zur Erweiterung des icon-Vorrats neue Dateien bitte zum Einchecken an den Modulautor mailen.

'''Hinweis:''' Neue Dateien werden in FHEM erst angezeigt, nachdem das interne Icon-Listing aktualisiert wurde. Dies geschieht nach jedem FHEM-(re)start oder mit dem Befehl
<nowiki>set WEB rereadicons</nowiki>

=== Kopplung an das ausführende Gerät ===
Bei jedem Tastendruck wird der Befehl (command), der der Taste zugeordnet ist, als STATE des remotecontrol-device angezeigt.

Außerdem wird ein entsprechendes System-Event erzeugt. Dieses kann mit notify geprüft und an das ausführende Gerät weitergegeben werden.

Als Beispiel soll wie oben gezeigt eine Fernbedienung mit dem Namen '''rc1''' bereits erstellt worden sein. Tastendrücke sollen zur Ausführung an das bereits vorhandene FHEM-device '''myTV''' weitergegeben werden.

Das entsprechende notify kann "manuell" oder per set-Befehl erzeugt werden:
<nowiki>
# Syntax:
set <name> makenotify <executingDevice>
# Beispiel:
set rc1 makenotify myTV #erzeugt: define notify_rc1 notify rc1 set myTV $EVENT</nowiki>

Bei jedem Tastendruck löst die Fernbedienung ''rc1'' ein event aus. Darauf reagiert das notify und sendet den entsprechenden set-Befehl an das Gerät ''myTV'' zur Ausführung.

'''Hinweis:''' Der Befehl ''makenotify'' erzeugt ein neues notify-device. Dieses wird erst durch den Befehl ''save'' in die fhem.cfg geschrieben. Möchten Sie den Befehl ''save'' nicht verwenden, tragen Sie das notify manuell in fhem.cfg ein. Ein weiteres Beispiel befindet sich am Ende dieses Wiki-Artikels.

Es können auch eigene Scripte (z. B. in 99_myUtils.pm) aufgerufen werden. Wenn es z. B. dort eine Routine <code>MeineRoutine($)</code> gibt, kann diese mit der Fernbedienung gesteuert werden durch
<nowiki>
define n_rc1 notify rc1 {MeineRoutine("$EVENT")}</nowiki>

=== Optional: Weblink erzeugen und einbinden ===
Zusätzlich zum remotecontrol-device selbst kann auch ein weblink zum Anzeigen der grafischen Fernbedienung verwendet werden. Beim Erzeugen des Weblinks kann man einen Namen angeben. Wird kein Name angegeben, wird der default-Name "weblink_<name>" verwendet.

<nowiki>
set rc1 makeweblink # erzeugt Weblink mit dem Namen weblink_rc1
set rc1 makeweblink w_rc1 # erzeugt Weblink mit dem Namen w_rc1</nowiki>

Zu Testzwecken kann man auch den Weblink einem Testraum zuordnen, z. B.
<nowiki>
attr weblink_rc1 room TestRemote
attr weblink_rc1 group rc</nowiki>

Durch die Zuordnung zu einer Gruppe wird der Name des Weblinks ebenfalls angezeigt, was zum Testen sehr praktisch ist.
Während der Einrichtungsphase ist zu empfehlen, in einem Fenster den Detailscreen des remotecontrol-device anzuzeigen, während man in einem zweiten Fenster den Weblink anzeigt. So kann man durch einfaches Refresh die Auswirkungen der Konfigurationsänderungen sofort sehen.

== Troubleshooting ==
=== Eine Taste wird nicht angezeigt ===
* Groß/Kleinschreibung icon-Namens prüfen
* Nach dem Anlegen neuer icons muss ausgeführt werden
:<code>set WEB rereadicons</code>
* Mit dem Befehl
:<code>get <name> htmlcode</code> den html-Code der grafischen Fernbedienung anzeigen. Darin suchen nach "<img src" und dann Link und Dateiname prüfen. Erwarteter Wert: <code><nowiki><img src="/fhem/icons/remotecontrol/black_btn_PLAY"></nowiki></code>

=== Der rechte Rahmen wird mit Lücken dargestellt ===
Manche Browser stellen in einer Zeile, in der die letzte Taste gar nicht definiert ist, den Rahmen nicht dar. Füllen Sie in diesem Fall die Tastaturzeile mit :blank soweit auf, dass sie dieselbe Anzahl Tasten aufweist wie die längste Tastaturzeile auf Ihrer Fernbedienung.

== Für Entwickler ==
Entwickler können aus ihren Modulen heraus Tastatur-Standardlayouts hinterlegen. Auch eine eigene Routine für makenotify ist möglich.

=== Neue Standard-Layouts hinterlegen ===
Standard-Layouts werden im eigenen Modul in Arrays abgelegt. Die Umwandung von Arrays in rowXX-Attribute sowie das Rendern zu html übernimmt das Modul ''remotecontrol''.

Vorgehensweise im eigenen Modul:

# Eine Funktion implementieren, die ein Array mit dem Standard-Tastaturlayout zurückgibt. Als Vorlage dient aus dem Quelltext von 95_remotecontrol.pm eine der Routinen <code>RC_layout_samsung()</code> oder <code>RC_layout_itunes()</code>.
# Im eigenen Modul in der [[DevelopmentModuleIntro#X_Initialize|Initialize]]-Funktion (nicht erst in der [[DevelopmentModuleIntro#X_Define|Define]]-Funktion!) einen Eintrag für <code>$data{RC_layout}{''<Layoutname>''}</code> vornehmen. Als Inhalt ist der Funktionsname der im ersten Schritt hinterlegten eigenen Layout-Funktion als Zeichenkette zu setzen.
#* Beispiel: Das Layout soll für den Nutzer '''MeinLayout''' heißen, die eigene Array-Routine heißt <code>Mein_Modul_Layout()</code>. Dafür ist in der eigenen [[DevelopmentModuleIntro#X_Initialize|Initialize]]-Funktion zu hinterlegen:<code>$data{RC_layout}{MeinLayout} = "Mein_Modul_Layout";</code>Als Vorlage kann wiederum das Modul ''95_remotecontrol.pm'' dienen, siehe dort am Ende der Initialize-Funktion.
#* In einer definierten remotecontrol den Befehl<code>get <name> layout</code>absetzen. Das eigene Layout sollte nun in der Liste erscheinen.
#* Das eigene Layout kann dann mit<code>set <name> layout <MeinLayout></code>geladen werden.

=== Eigene makenotify-Routine hinterlegen ===
Beim Aufruf von <code>set ''<Device>'' makenotify</code> wird ein [[notify]] erzeugt der Form
:<code>define ''<Name>'' notify ''<RC-Name>'' set ''<ausführendes Gerät>'' $EVENT </code>
Das sollte in 90% der Fälle passen. Wenn für das eigene Modul jedoch ein abweichendes Kommando erforderlich ist, z. B.
:<code>set ''<ausführendes Gerät>'' command <Befehl></code>
dann passt das standardmäßig durch makenotify erzeugte notify nicht. In diesem Fall kann das notify durch eine eigene Routine angelegt werden. Dazu wird im eigenen Modul eine Routine zur Erzeugung des notify hinterlegt. Der Name der Routine wird wiederum in <code>%data</code> hinterlegt mit:

<code>$data{RC_makenotify}{''<Modulname>''} = "Mein_Modul_Makenotify";</code>

<syntaxhighlight lang="perl">
# Beispiel:
$data{RC_makenotify}{VIERA} = "VIERA_makenotify"; </syntaxhighlight>

Beim Aufruf von
:<code>set ''<rc>'' makenotify ''<ausführendes Gerät>''</code>
wird nun der TYPE von <code>''<ausführendes Gerät>''</code> ermittelt und gesucht, ob es einen passenden Eintrag in <code>$data{RC_makenotify}</code> gibt. Ist dieser vorhanden, wird die dort angegebene Routine aufgerufen. Als Beispiel kann das Modul [[VIERA]] dienen.

== Beispiel-Layouts mit screenshots ==
=== iTunes ===
[[Datei:remotecontrol_iTunes.jpg|thumb|right]]
<nowiki>
define rc_itunes remotecontrol

attr rc_itunes rc_iconpath icons/remotecontrol
attr rc_itunes rc_iconprefix black_btn_
attr rc_itunes row00 play:PLAY,pause:PAUSE,prev:REWIND,next:FF,louder:VOLUP,quieter:VOLDOWN

define weblink_itunes weblink htmlCode {fhem("get rc_itunes htmlcode", 1)}
define notify_itunes rc_itunes {doiTunes("$EVENT");}
</nowiki>

=== Samsung ===
[[Datei:remotecontrol_samsung.jpg|thumb|right]]
<nowiki>
define rc_samsung remotecontrol

attr rc_samsung rc_iconpath icons/remotecontrol
attr rc_samsung rc_iconprefix black_btn_
attr rc_samsung row00 POWEROFF,TV,HDMI
attr rc_samsung row01 :blank,:blank,:blank
attr rc_samsung row02 1,2,3
attr rc_samsung row03 4,5,6
attr rc_samsung row04 7,8,9
attr rc_samsung row05 :blank,0,PRECH
attr rc_samsung row06 :blank,:blank,:blank
attr rc_samsung row07 VOLUP,MUTE,CHUP
attr rc_samsung row08 VOLDOWN,CH_LIST,CHDOWN
attr rc_samsung row09 MENU,:blank,GUIDE
attr rc_samsung row10 :blank,:blank,:blank
attr rc_samsung row11 TOOLS,UP,INFO
attr rc_samsung row12 LEFT,ENTER,RIGHT
attr rc_samsung row13 RETURN,DOWN,EXIT

define weblink_rc_samsung weblink htmlCode {fhem("get rc_samsung htmlcode", 1)}
define notify_rc_samsung notify rc_samsung set myTV $EVENT
</nowiki>

[[Kategorie:Unterhaltungselektronik]]

Remotecontrol

2020-09-05T20:26:19Z

Plaicy: /* Kopplung an das ausführende Gerät */ typo "Außerdem"

{{SEITENTITEL:remotecontrol}}
{{Infobox Modul
|ModPurpose=Grafische Darstellung einer Fernbedienung
|ModType=h

|ModCmdRef=remotecontrol

|ModTechName=95_remotecontrol.pm
|ModOwner=[http://forum.fhem.de/index.php?action=profile;u=86 ulimaass]}}

[[Datei:remotecontrol_samsung.jpg|thumb|right|Grafische Darstellung einer Fernbedienung]]
Das Modul '''remotecontrol''' stellt einen Weblink bereit, der eine grafische Abbildung einer physischen Fernbedienung anzeigt, siehe Beispiel rechts. Dieser Weblink kann in FHEM-Frontends wie [[PGM2|FHEMWEB]] oder [[FLOORPLAN]] verwendet werden.

Die Tastenbelegung (das Layout) ist frei wählbar. Standard-Layouts sind für unterschiedliche Geräte verfügbar. Das remotecontrol-device wird per notify an das FHEM-device gekoppelt, das nach einem Tastendruck den Befehl an das physische Gerät sendet.

== Einrichtung ==
=== Define ===
Das define erfolgt nach der üblichen FHEM-Syntax:
<source lang="text">
# Syntax:
define <name> remotecontrol
# Beispiel:
define rc1 remotecontrol
</source>

Damit ist eine leere Fernbedienung (zunächst noch ohne Tasten) angelegt.

Zu Testzwecken kann man sein Device zunächst einem Testraum zuordnen, z. B.
<source lang="text">
attr rc1 room TestRemote
</source>

'''Hinweis:''' Nicht vergessen, nach dem Erzeugen der Fernbedienung die Konfiguration zu speichern. Ansonsten ist sie nach einem Neustart von FHEM nicht mehr vorhanden. Details dazu finden sich auf der Seite [[Konfiguration]].

=== Standard-Tastaturlayouts nutzen ===
Jedes FHEM-Modul kann Tastaturlayouts für das Modul ''remotecontrol'' bereitstellen.

Die Liste der vorhandenen Tastaturlayouts wird angezeigt mit
<nowiki>
# Syntax:
get <name> layout
# Beispiel:
get rc1 layout </nowiki>

Die Liste der vordefinierten Tastaturlayouts wird nun angezeigt.

Ein Tastatur-Layout kann zugeordnet (geladen) werden mit
<nowiki>
# Syntax:
set <name< layout <layoutname<
# Beispiel:
set rc1 layout itunes </nowiki>

'''Hinweis:''' Das Laden von Standard-Layouts ändert die Werte der Attribute row00 - row19. Diese werden erst durch den Befehl ''save'' nach fhem.cfg geschrieben. Soll der Befehl ''save'' nicht verwendet werden, kann die Konfiguration auch manuell in fhem.cfg eingetragen werden. Ein Beispiel befindet sich am Ende dieses Wiki-Artikels.

'''Hinweis:''' Ein Standard-Tastaturlayout wird erst nach dem Laden eines Moduls bereitgestellt. Wenn Sie also erst zu einem späteren Zeitpunkt ein weiteres Modul (z.B. [[VIERA]] für Panasonic-TV) in Ihre Konfiguration aufnehmen, wird ein ggf. vorhandenes remotecontrol-Standard-Layout erst dann angezeigt. Man sollte also auch später ab und zu mit dem o.g. Befehl prüfen, ob für weitere Geräte Standardlayouts vorhanden/hinzugekommen sind.

Im Modul ''remotecontrol'' selbst sind die Beispiel-Layouts "itunes" und "samsung" vorhanden.

=== Eigene Tastaturlayouts einrichten ===
Die Tastatur der Fernbedienung ist aufgeteilt in bis zu 20 Zeilen. Je Zeile können beliebig viele Tasten definiert werden.

Jede Taste auf der Fernbedienung wird definiert durch
* den Befehl, der nach einem Tastendruck ausgeführt werden soll
* das icon, das als Taste erscheinen soll

Man muss also je Taste diese beiden Werte festlegen. Mehrere Tasten in einer Zeile werden jeweils durch ein Komma voneinander getrennt.

==== Icon-Pfad festlegen ====
Einmalig ermitteln, in welchem Ordner die Icons liegen, die für die Tastatur verwendet werden sollen. Die Standard-icons liegen im Ordner <code>www/images/default/remotecontrol</code>. Um das nicht bei jeder Taste angeben zu müssen, setzt man
:<code>attr <name> rc_iconpath icons/remotecontrol</code>

==== Icon-Prefix festlegen ====
Ggf. einmalig einen prefix für Dateinamen festlegen. Die Standard-icons folgen der Namenskonvention black_btn_<Beschreibung>. Um den Teil vor der Beschreibung nicht bei jeder Taste mit angeben zu müssen, setzt man
:<code>attr <name> rc_iconprefix black_btn_</code>

==== Tasten definieren ====
# ermitteln, welcher Befehl an das ausführende FHEM-Gerät gesendet werden soll. Als Beispiel soll der Befehl "play" dienen. Groß-/Kleinschreibung ist zu beachten.
# ermitteln, welches Icon zur Darstellung der Taste verwendet werden soll. Unter den Standardicons gibt es ein icon mit dem Dateinamen black_btn_'''PLAY'''.png. Der vordere Teil ist bereits als prefix hinterlegt, die Datei-Endung muss nicht angegeben werden. Als icon für die Tastaturdefinition kann man also einfach '''PLAY''' angeben. Groß-/Kleinschreibung ist zu beachten.

Nachdem nun der Befehl (play) und der Icon-Name (PLAY) ermittelt sind, können diese - durch einen Doppelpunkt getrennt - als Definition einer Taste hinterlegt werden.

<nowiki>
# Syntax:
attr <name> rowXX <command>:<icon>
# Beispiel:
attr rc1 row00 play:PLAY # als Befehl wird play gesendet, als icon wird PLAY verwendet</nowiki>

Sollen weitere Tasten definiert werden, hängt man sie durch Komma getrennt an.
<nowiki>
# Syntax:
attr <name> rowXX <command>:<icon>[,<command>:<icon>][,....]
# Beipiel:
attr rc1 row01 play:PLAY,anhalten:STOP</nowiki>

Sollen auf der Tastatur Leer-Räume abgebildet werden, gibt man als Tastendefinition ''':blank''' an (also kein Befehl, Icon blank). Das Icon mit dem Namen 'blank' ist vorhanden, hat ein Drittel der regulären Tastenhöhe und ist 100% transparent.

<nowiki>
attr rc1 row02 play:PLAY,:blank,anhalten:STOP</nowiki>

Eine "Trennzeile" lässt sich einfügen durch
<nowiki>
attr rc1 row03 :blank,:blank,:blank</nowiki>

'''Hinweis:''' Manche Browser stellen in einer Zeile, in der die letzte Taste nicht definiert ist, den Rahmen nicht dar. Füllen Sie in diesem Fall die Tastaturzeile mit :blank soweit auf, dass sie dieselbe Anzahl Tasten aufweist wie die längste Tastaturzeile auf Ihrer Fernbedienung.

Für den Fall, dass der Befehl und der Icon-Name identisch sind (incl. Groß-/Kleinschreibung) besteht zur Vereinfachung die Möglichkeit, nur das Kommando anzugeben. Dieses wird dann auch als icon-Name verwendet.

<nowiki>
# Syntax:
attr <name> rowXX [<command>:<icon>|<command_icon>][,[<command>:<icon>|<command_icon>]]...
# Beispiele:
attr rc1 row04 PLAY # als Befehl wird PLAY gesendet, als icon wird PLAY verwendet
attr rc1 row05 PLAY,:blank,anhalten:STOP # auch Mischformen sind möglich</nowiki>

==== Verwenden von .svg-icons ====
Endet der Dateiname nicht auf .svg, verhält sich die die img-Generierung wie oben beschrieben unter Beachtung von rc_iconpath und rc_iconprefix.

Enthält der angegebene Dateiname ".svg" , so wird der svg-Lesemechanismus aus FHEMWEB verwendet. Dabei werden die Attribute rc_iconpath und rc_iconprefix '''ignoriert''', es wird die "ganz normale" Zugriffsfolge verwendet wie im FHEMWEB-Attribut iconPath gesetzt (z. B. fhemSVG:openautomation:default)

<nowiki>
Attributes:
rc_iconpath icons
row00 play:audio_play.svg # svg-icon ohne Farbangabe
row01 oldplay:remotecontrol/black_btn_PLAY # nicht-svg-icon, Pfadangabe bei iconpath "icons"
row02 redplay:audio_play.svg@red # svg-icon mit Farbangabe</nowiki>

==== Neue Icons für Tasten erstellen und verwenden ====
Im Ordner www/images/default/remotecontrol liegt das Template für weitere Tasten. Die Datei heisst _black_btn_template.pdn und kann z. B. mit paint.net bearbeitet werden.

Neue Dateien bitte als png analog der vorhandenen Namenskonvention erstellen: Prefix black_btn_, Beschreibung in Grossbuchstaben.

Zur Erweiterung des icon-Vorrats neue Dateien bitte zum Einchecken an den Modulautor mailen.

'''Hinweis:''' Neue Dateien werden in FHEM erst angezeigt, nachdem das interne Icon-Listing aktualisiert wurde. Dies geschieht nach jedem FHEM-(re)start oder mit dem Befehl
<nowiki>set WEB rereadicons</nowiki>

=== Kopplung an das ausführende Gerät ===
Bei jedem Tastendruck wird der Befehl (command), der der Taste zugeordnet ist, als STATE des remotecontrol-device angezeigt.

Außerdem wird ein entsprechendes System-Event erzeugt. Dieses kann mit notify geprüft und an das ausführende Gerät weitergegeben werden.

Als Beispiel soll wie oben gezeigt eine Fernbedienung mit dem Namen '''rc1''' bereits erstellt worden sein. Tastendrucke sollen zur Ausführung an das bereits vorhandene FHEM-device '''myTV''' weitergegeben werden.

Das entsprechende notify kann "manuell" oder per set-Befehl erzeugt werden:
<nowiki>
# Syntax:
set <name> makenotify <executingDevice>
# Beispiel:
set rc1 makenotify myTV #erzeugt: define notify_rc1 notify rc1 set myTV $EVENT</nowiki>

Bei jedem Tastendruck löst die Fernbedienung ''rc1'' ein event aus. Darauf reagiert das notify und sendet den entsprechenden set-Befehl an das Gerät ''myTV'' zur Ausführung.

'''Hinweis:''' Der Befehl ''makenotify'' erzeugt ein neues notify-device. Dieses wird erst durch den Befehl ''save'' in die fhem.cfg geschrieben. Möchten Sie den Befehl ''save'' nicht verwenden, tragen Sie das notify manuell in fhem.cfg ein. Ein weiteres Beispiel befindet sich am Ende dieses Wiki-Artikels.

Es können auch eigene Scripte (z. B. in 99_myUtils.pm) aufgerufen werden. Wenn es z. B. dort eine Routine <code>MeineRoutine($)</code> gibt, kann diese mit der Fernbedienung gesteuert werden durch
<nowiki>
define n_rc1 notify rc1 {MeineRoutine("$EVENT")}</nowiki>

=== Optional: Weblink erzeugen und einbinden ===
Zusätzlich zum remotecontrol-device selbst kann auch ein weblink zum Anzeigen der grafischen Fernbedienung verwendet werden. Beim Erzeugen des Weblinks kann man einen Namen angeben. Wird kein Name angegeben, wird der default-Name "weblink_<name>" verwendet.

<nowiki>
set rc1 makeweblink # erzeugt Weblink mit dem Namen weblink_rc1
set rc1 makeweblink w_rc1 # erzeugt Weblink mit dem Namen w_rc1</nowiki>

Zu Testzwecken kann man auch den Weblink einem Testraum zuordnen, z. B.
<nowiki>
attr weblink_rc1 room TestRemote
attr weblink_rc1 group rc</nowiki>

Durch die Zuordnung zu einer Gruppe wird der Name des Weblinks ebenfalls angezeigt, was zum Testen sehr praktisch ist.
Während der Einrichtungsphase ist zu empfehlen, in einem Fenster den Detailscreen des remotecontrol-device anzuzeigen, während man in einem zweiten Fenster den Weblink anzeigt. So kann man durch einfaches Refresh die Auswirkungen der Konfigurationsänderungen sofort sehen.

== Troubleshooting ==
=== Eine Taste wird nicht angezeigt ===
* Groß/Kleinschreibung icon-Namens prüfen
* Nach dem Anlegen neuer icons muss ausgeführt werden
:<code>set WEB rereadicons</code>
* Mit dem Befehl
:<code>get <name> htmlcode</code> den html-Code der grafischen Fernbedienung anzeigen. Darin suchen nach "<img src" und dann Link und Dateiname prüfen. Erwarteter Wert: <code><nowiki><img src="/fhem/icons/remotecontrol/black_btn_PLAY"></nowiki></code>

=== Der rechte Rahmen wird mit Lücken dargestellt ===
Manche Browser stellen in einer Zeile, in der die letzte Taste gar nicht definiert ist, den Rahmen nicht dar. Füllen Sie in diesem Fall die Tastaturzeile mit :blank soweit auf, dass sie dieselbe Anzahl Tasten aufweist wie die längste Tastaturzeile auf Ihrer Fernbedienung.

== Für Entwickler ==
Entwickler können aus ihren Modulen heraus Tastatur-Standardlayouts hinterlegen. Auch eine eigene Routine für makenotify ist möglich.

=== Neue Standard-Layouts hinterlegen ===
Standard-Layouts werden im eigenen Modul in Arrays abgelegt. Die Umwandung von Arrays in rowXX-Attribute sowie das Rendern zu html übernimmt das Modul ''remotecontrol''.

Vorgehensweise im eigenen Modul:

# Eine Funktion implementieren, die ein Array mit dem Standard-Tastaturlayout zurückgibt. Als Vorlage dient aus dem Quelltext von 95_remotecontrol.pm eine der Routinen <code>RC_layout_samsung()</code> oder <code>RC_layout_itunes()</code>.
# Im eigenen Modul in der [[DevelopmentModuleIntro#X_Initialize|Initialize]]-Funktion (nicht erst in der [[DevelopmentModuleIntro#X_Define|Define]]-Funktion!) einen Eintrag für <code>$data{RC_layout}{''<Layoutname>''}</code> vornehmen. Als Inhalt ist der Funktionsname der im ersten Schritt hinterlegten eigenen Layout-Funktion als Zeichenkette zu setzen.
#* Beispiel: Das Layout soll für den Nutzer '''MeinLayout''' heißen, die eigene Array-Routine heißt <code>Mein_Modul_Layout()</code>. Dafür ist in der eigenen [[DevelopmentModuleIntro#X_Initialize|Initialize]]-Funktion zu hinterlegen:<code>$data{RC_layout}{MeinLayout} = "Mein_Modul_Layout";</code>Als Vorlage kann wiederum das Modul ''95_remotecontrol.pm'' dienen, siehe dort am Ende der Initialize-Funktion.
#* In einer definierten remotecontrol den Befehl<code>get <name> layout</code>absetzen. Das eigene Layout sollte nun in der Liste erscheinen.
#* Das eigene Layout kann dann mit<code>set <name> layout <MeinLayout></code>geladen werden.

=== Eigene makenotify-Routine hinterlegen ===
Beim Aufruf von <code>set ''<Device>'' makenotify</code> wird ein [[notify]] erzeugt der Form
:<code>define ''<Name>'' notify ''<RC-Name>'' set ''<ausführendes Gerät>'' $EVENT </code>
Das sollte in 90% der Fälle passen. Wenn für das eigene Modul jedoch ein abweichendes Kommando erforderlich ist, z. B.
:<code>set ''<ausführendes Gerät>'' command <Befehl></code>
dann passt das standardmäßig durch makenotify erzeugte notify nicht. In diesem Fall kann das notify durch eine eigene Routine angelegt werden. Dazu wird im eigenen Modul eine Routine zur Erzeugung des notify hinterlegt. Der Name der Routine wird wiederum in <code>%data</code> hinterlegt mit:

<code>$data{RC_makenotify}{''<Modulname>''} = "Mein_Modul_Makenotify";</code>

<syntaxhighlight lang="perl">
# Beispiel:
$data{RC_makenotify}{VIERA} = "VIERA_makenotify"; </syntaxhighlight>

Beim Aufruf von
:<code>set ''<rc>'' makenotify ''<ausführendes Gerät>''</code>
wird nun der TYPE von <code>''<ausführendes Gerät>''</code> ermittelt und gesucht, ob es einen passenden Eintrag in <code>$data{RC_makenotify}</code> gibt. Ist dieser vorhanden, wird die dort angegebene Routine aufgerufen. Als Beispiel kann das Modul [[VIERA]] dienen.

== Beispiel-Layouts mit screenshots ==
=== iTunes ===
[[Datei:remotecontrol_iTunes.jpg|thumb|right]]
<nowiki>
define rc_itunes remotecontrol

attr rc_itunes rc_iconpath icons/remotecontrol
attr rc_itunes rc_iconprefix black_btn_
attr rc_itunes row00 play:PLAY,pause:PAUSE,prev:REWIND,next:FF,louder:VOLUP,quieter:VOLDOWN

define weblink_itunes weblink htmlCode {fhem("get rc_itunes htmlcode", 1)}
define notify_itunes rc_itunes {doiTunes("$EVENT");}
</nowiki>

=== Samsung ===
[[Datei:remotecontrol_samsung.jpg|thumb|right]]
<nowiki>
define rc_samsung remotecontrol

attr rc_samsung rc_iconpath icons/remotecontrol
attr rc_samsung rc_iconprefix black_btn_
attr rc_samsung row00 POWEROFF,TV,HDMI
attr rc_samsung row01 :blank,:blank,:blank
attr rc_samsung row02 1,2,3
attr rc_samsung row03 4,5,6
attr rc_samsung row04 7,8,9
attr rc_samsung row05 :blank,0,PRECH
attr rc_samsung row06 :blank,:blank,:blank
attr rc_samsung row07 VOLUP,MUTE,CHUP
attr rc_samsung row08 VOLDOWN,CH_LIST,CHDOWN
attr rc_samsung row09 MENU,:blank,GUIDE
attr rc_samsung row10 :blank,:blank,:blank
attr rc_samsung row11 TOOLS,UP,INFO
attr rc_samsung row12 LEFT,ENTER,RIGHT
attr rc_samsung row13 RETURN,DOWN,EXIT

define weblink_rc_samsung weblink htmlCode {fhem("get rc_samsung htmlcode", 1)}
define notify_rc_samsung notify rc_samsung set myTV $EVENT
</nowiki>

[[Kategorie:Unterhaltungselektronik]]

ROLLO

2020-09-05T12:32:14Z

Plaicy: fix typo

{{SEITENTITEL:ROLLO}}
{{Infobox Modul
|ModPurpose=Rollo-Steuerung zur einfachen Anzeige/Programmierung
|ModType=h
|ModFTopic=95832


|ModForumArea=Unterstützende Dienste
|ModTechName=44_ROLLO.pm
|ModOwner=KernSani}}
Das Modul [[ROLLO]] bietet eine einfache Möglichkeit, mit ein bis zwei Relais den Hoch-/Runterlauf eines Rolladen zu steuern und punktgenau anzuhalten. Außerdem wird die aktuelle Position in fhem abgebildet.
Über welche Hardware/Module die Ausgänge angesprochen werden ist dabei egal.
__TOC__
Das Modul unterstützt beliebige Konfigurationen welche Befehle ausgeführt werden müssen um die Hardware des Rollos zu steuern.

* Die Rollo-Position wird in 10%-Schritten von 0% (offen) bis 100% (geschlossen) zwischengespeichert um auf der Oberfläche für jede Position ein Icon festlegen zu können.

[[Datei:Rolladen Eintrag.PNG|right|thumb|400px|Verschiedene Ansichten des Rollo:offen, fährt gerade herunter, position 50, fährt gerade hoch, geschlossen]]
Vorteil dieses Moduls:

Ist ein Rollo mit diesem Modul definiert kann man auf der Oberfläche per Klick das Rollo hoch/runter oder auf eine bestimmte Position fahren. Der aktuelle Status des Rollo (fährt hoch/runter,offen,geschlossen,etc.) wird angezeigt.
Die Oberflächenicons werden per devStateIcon gesteuert, Icons und Farben können für jeden Status individuell formatiert werden, die Standard Kommandos auf der Oberfläche (hier: offen, geschlossen, schlitz, Position) können ebenfalls per Attribut angepasst werden. Das Status-Icon ist anklickbar.
Beim Anlegen des Moduls werden die Attribute zur Darstellung in fhem mit Standardwerten angelegt, so dass man sich einiges an Tipparbeit sparen kann, aber trotzdem die Möglichkeit hat die Darstellung individuell anzupassen.

== Voraussetzungen ==
Das eigentliche ansteuern des Rollo muss mit FHEM Befehlen ausführbar sein, diese Modul ist "nur" eine Oberfläche/Bedienmodul, kein Hardwaremodul.

Wenn ROLLO installiert wurde, bevor es Bestandteil von FHEM wurde und lange kein Update gemacht wurde, wirst du die "position" readings und das entsprechende set Kommando vermissen. "position" wurde durch "pct" ersetzt, um Kompatibilität mit anderen Modulen [https://fhem.de/commandref_DE.html#AutoShuttersControl Automatic Shutter Control - ASC] sicher zu stellen. Bitte passe deine NOTIFYs/DOIFs entsprechend an.

== Installation ==

{{Hinweis|Dieses Modul ist in der offiziellen FHEM-Auslieferung enthalten.}}

== Anwendung ==
=== Define ===
define <name> ROLLO

=== Attribute ===
{|class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Default-Wert !! Beschreibung
|-
|rl_type ||attr <Rollo-Device> rl_type [normal|HomeKit] ||||Typunterscheidung zur unterstützung verschiedener Hardware. Abhängig vom gewählten Typ wird die Richtung von der die pct gerechnet wird festgelegt:

normal = pct 0 ist offen, pct 100 ist geschlossen
HomeKit = pct 100 ist offen, pct 0 ist geschlossen
|-
|rl_secondsDown||attr <Rollo-Device> rl_secondsDown <number> ||||Sekunden zum hochfahren
|-
|rl_secondsUp ||attr <Rollo-Device> rl_secondsUp <number> ||||Sekunden zum herunterfahren
|-
|rl_excessTop ||attr <Rollo-Device> rl_excessTop <number> ||||Zeit, die mein Rollo fahren muss, ohne dass sich die Rollo-pct ändert (bei mir fährt der Rollo noch in die Wand, ohne dass man es am Fenster sieht, die pct ist also schon bei 0%).
|-
|rl_excessBottom ||attr <Rollo-Device> rl_excessBottom <number> ||||(siehe excessTop)
|-
|rl_switchTime ||attr <Rollo-Device> rl_switchTime <number> ||||Zeit, die zwischen 2 gegensätzlichen Laufbefehlen pausiert werden soll, also wenn der Rollo z.B. gerade runter fährt und ich den Befehl gebe hoch zu fahren, dann soll 1 Sekunde gewartet werden bis der Motor wirklich zum stillstand kommt, bevor es wieder in die andere Richtung weiter geht. Dies ist die einzige Zeit, die nichts mit der eigentlichen Laufzeit des Motors zu tun hat, sondern ein Timer zwischen den Laufzeiten.
|-
|rl_resetTime ||attr <Rollo-Device> rl_resetTime <number> ||||Zeit, die beim Anfahren von Endpositionen (offen,geschlossen) der Motor zusätzlich an bleiben soll, um sicherzustellen, dass die Endposition wirklich angefahren wurde. Dadurch können Differenzen in der Positionsberechnung korrigiert werden.
|-
|rl_reactionTime ||attr <Rollo-Device> rl_reactionTime <number> ||||Zeit für den Motor zum reagieren
|-
|rl_autoStop ||attr <Rollo-Device> rl_autoStop [0|1] ||||Es muss kein Stop-Befehl ausgeführt werden, das Rollo stoppt von selbst.
|-
|rl_commandUp ||attr <Rollo-Device> rl_commandUp <string> ||||Es werden bis zu 3 beliebige Befehle zum hochfahren ausgeführt
|-
|rl_commandDown ||attr <Rollo-Device> rl_commandDown <string> ||||Es werden bis zu 3 beliebige Befehle zum runterfahren ausgeführt
|-
|rl_commandStop ||attr <Rollo-Device> rl_commandStop <string> ||||Befehl der zum Stoppen ausgeführt wird, sofern nicht commandStopDown bzw. commandStopUp definiert sind
|-
|rl_commandStopDown ||attr <Rollo-Device> rl_commandStopDown <string> ||||Befehl der zum stoppen ausgeführt wird, wenn der Rollo gerade herunterfährt. Wenn nicht definiert wird commandStop ausgeführt
|-
|rl_commandStopUp ||attr <Rollo-Device> rl_commandStopUp <string> ||||Befehl der zum Stoppen ausgeführt wird,wenn der Rollo gerade hochfährt. Wenn nicht definiert wird commandStop ausgeführt
|-
|rl_blockMode ||attr <Rollo-Device> rl_blockMode [blocked|force-open|force-closed|only-up|only-down|half-up|half-down|none] ||||wenn ich den Befehl blocked ausführe, dann wird aufgrund der blockMode-Art festgelegt wie mein Rollo reagieren soll:

blocked = Rollo lässt sich nicht mehr bewegen
force-open = bei einem beliebigen Fahrbefehl wird Rollo hochgefahren
force-closed = bei einem beliebigen Fahrbefehl wird Rollo runtergefahren
only-up = Befehle zum runterfahren werden ignoriert
only-down = Befehle zum hochfahren werden ignoriert
half-up = es werden nur die Positionen 50-100 angefahren, bei pct <50 wird pct 50% angefahren,
half-down = es werden nur die Positionen 0-50 angefahren, bei pct >50 wird pct 50 angefahren
none = block-Modus ist deaktiviert
|-
|automatic-enabled ||attr <Rollo-Device> automatic-enabled [on|off] ||||Wenn auf off gestellt, haben Befehle über Modul ROLLO_Automatic keine Auswirkungen auf diesen Rollo
|-
|automatic-delay ||attr <Rollo-Device> automatic-delay <number> ||||Dieses Attribut wird nur für die Modulerweiterung ROLLADEN_Automatic benötigt.
Hiermit kann einge Zeitverzögerung für den Rolladen eingestellt werden, werden die Rolladen per Automatic heruntergefahren, so wird dieser um die angegebenen Minuten später heruntergefahren.
|-
|rl_forceDrive ||attr <Rollo-Device> rl_forceDrive [0|1] ||||open/closed wird ausgeführt, auch wenn das ROLLO bereits in der Zielposition ist
|-
|rl_noSetPosBlocked ||attr <Rollo-Device> rl_noSetPosBlocked [0|1] ||||Wenn deaktiviert, können Positionsn (pct) auch gesetzt werden, wenn der ROLLO geblockt ist. Nach dem unblocken wird die entsprechende Position angefahren.
|-
|||disableattr <Rollo-Device> disable [0|1] ||||Wenn deaktiviert, können keine set oder get commandos für den ROLLO ausgeführt werden.
|-
|||||||
|-
|||||||
|-
|||||||
|}

=== Set ===

{|class="wikitable"
|-
!Name !!set Befehl !!Beschreibung
|-
|open ||set <Rollo-Device> open ||Fährt das Rollo komplett auf (pct 0)
|-
|closed ||set <Rollo-Device> closed||Fährt das Rollo komplett zu (pct 100)
|-
|up ||set <Rollo-Device> up ||Fährt das Rollo um 10 auf (pct +10)
|-
|down ||set <Rollo-Device> down ||Fährt das Rollo um 10 zu (pct -10)
|-
|half || set <Rollo-Device> half ||Fährt das Rollo zur Hälfte runter bzw. hoch (pct 50)
|-
|stop ||set <Rollo-Device> stop ||Stoppt das Rollo
|-
|drive ||set <Rollo-Device> drive up 5||Fährt das Rollo in die angegebene Richtung für die angegebene Zeit (in Sekunden)
|-
|blocked ||set <Rollo-Device> blocked ||wenn aktiviert, kann der ROLLO nur noch eingeschränkt gesteuert werden. Siehe Attribut block_mode für Details.
|-
|unblocked ||set <Rollo-Device> unblocked ||Aktiviert einen geblockten ROLLO wieder für die normale Benutzung
|-
|pct ||set <Rollo-Device> pct <value> ||Fährt das Rollo auf eine beliebige pct zwischen 0 (offen) - 100 (geschlossen)
|-
|reset ||set <Rollo-Device> reset <value> ||Sagt dem Modul in welcher pct sich der Rollo befindet
|-
|extern ||set <Rollo-Device> extern <value> ||Der Software mitteilen dass gerade Befehl X bereits ausgeführt wurde und nun z.B,. das berechnen der aktuellen pct gestartet werden soll
|}

=== Get ===

{|class="wikitable"
|-
!Name !!set Befehl !!Beschreibung
|-
|version ||get <Rollo-Device> version ||Gibt die version des Modul Rollos aus
|}

=== Readings ===
{|class="wikitable"
|-
!Name !!Wert !!Beschreibung
|-
|command||open,stop,closed||
|-
|desired_pct||0-100||Zielposition die angefahren werden soll (nur sinnvoll während das Rollo fährt)
|-
|drive-type||modul,extern||bei dem Befehl "set rollo extern .." wird dieses attribut auf "extern" gestellt, sonst immer "modul"
|-
|last_drive||drive-up,drive-down||die zuletzt benutzte Fahrtrichtung
|-
|pct||0-100||exakte Position des Rollo
|-
|state||open,closed,position-[0-100]||die Position gerundet auf ganze 10% Schritte, identisch mit dem Internal STATE
|}

== Anwendungsbeispiele ==
===Set===
set RolladenWohnzimmer pct 50
set RolladenWohnzimmer geschlossen
set RolladenWohnzimmer offen
Drei Beispiele das Rollo-Modul anzuweisen verschiedene Positionen anzufahren.

set RolladenWohnzimmer extern stop
Das Rollo-Modul wird angewiesen den status auf "nicht fahren" zu setzen, die aktuelle Rollo-Position zu berechnen und als neue Position abzuspeichern. Der eigentliche Rollo-Stop-Befehl wird dabei aber nicht gesendet.

set RolladenWohnzimmer reset closed
In der Oberfläche von fhem wird für das Rollo die Position "geschlossen" gespeichert, ohne Berechnungen durchzuführen oder Hardware zu steuern. Wird evtl. benötigt wenn der Ist-Status von den Soll-Werten aus fhem abweicht.

===Zusammenspiel mit externem Taster===
In einem Anwendungszenario hat ein Nutzer zusätzliche Taster an seinem Rollo-Motor über die er ihn ebenfalls steuern kann.
Die Taster selber senden keine Events an fhem, nur der Rollo-Motor.
Hier ein Beispiel wie das ganze für aussehen könnte und diese Taster in das ROLLO-Modul integriert werden:

define rollo_manuell_auf DOIF ([meinRollo_Kanal1] eq "on" and [?meinRolloModul] ne "drive-up") (set meinRolloModul extern open) DOELSEIF ([meinRollo_Kanal1] eq "off" and [?meinRolloModul] eq "drive-up") (set meinRolloModul extern stop)
define rollo_manuell_ab DOIF ([meinRollo_Kanal2] eq "on" and [?meinRolloModul] ne "drive-down") (set meinRolloModul extern closed) DOELSEIF ([meinRollo_Kanal2] eq "off" and [?meinRolloModul] eq "drive-down") (set meinRolloModul extern stop)

meinRollo_Kanal1 und meinRollo_Kanal2 sind die Hardwarekanäle die in dem Rollo-Modul zum hochfahren/runterfahren benutzt werden.
Das erste DOIF prüft ob das Rollo hoch fährt, ohne das das Rollo-Modul davon etwas weis. Ist dem so wird dem Rollo Modul mithilfe des set <extern> mitgeteilt das das Rollo bereits gestartet wurde. Das Modul fängt an die Zeit zu zählen und aktualisiert den Status der Oberfläche auf "fahre hoch".
IM DOELSEIF wird abgefragt ob das Rollo steht, obwohl das Modul denkt das Rollo würde noch fahren. Ist dem so wird wieder mithilfe des set <extern> dem Modul mitgeteilt das das Rollo gestoppt wurde. Das Modul berechnet nun aufgrund der gefahrenen Zeit die aktuelle Position und aktualisiert den Status der Oberfläche auf die Position.

Das gleiche wird dann im zweiten DOIF nochmal für das herunterfahren gemacht.

Man kann nun das Rollo sowohl über die Oberfläche als auch per Taster bedienen und fhem und der reale Ist-Status sind synchron. Auch eine gleichzeitige Bedienung ist möglich, Das Rollo startet z.B. aufgrund einer Automatisierung morgens zum hochfahren und man klickt schnell auf den Taster neben dem Bett und stoppt das ganze wieder.

== Links ==

Thread im {{Link2Forum|Topic=95832|LinkText=Forum}} seit das Modul Bestandteil der offiziellen FHEM Auslieferung ist

Thread im {{Link2Forum|Topic=47202|LinkText=Forum}} bevor das Modul Bestandteil von FHEM war

ROLLO

2020-09-05T08:05:40Z

Plaicy: Umlaute ersätzt

{{SEITENTITEL:ROLLO}}
{{Infobox Modul
|ModPurpose=Rollo-Steuerung zur einfachen Anzeige/Programmierung
|ModType=h
|ModFTopic=95832


|ModForumArea=Unterstützende Dienste
|ModTechName=44_ROLLO.pm
|ModOwner=KernSani}}
Das Modul [[ROLLO]] bietet eine einfache Möglichkeit, mit ein bis zwei Relais den Hoch-/Runterlauf eines Rolladen zu steuern und punktgenau anzuhalten. Außerdem wird die aktuelle Position in fhem abgebildet.
Über welche Hardware/Module die Ausgänge angesprochen werden ist dabei egal.
__TOC__
Das Modul unterstützt beliebige Konfigurationen welche Befehle ausgeführt werden müssen um die Hardware des Rollos zu steuern.

* Die Rollo-Position wird in 10%-Schritten von 0% (offen) bis 100% (geschlossen) zwischengespeichert um auf der Oberfläche für jede Position ein Icon festlegen zu können.

[[Datei:Rolladen Eintrag.PNG|right|thumb|400px|Verschiedene Ansichten des Rollo:offen, fährt gerade herunter, position 50, fährt gerade hoch, geschlossen]]
Vorteil dieses Moduls:

Ist ein Rollo mit diesem Modul definiert kann man auf der Oberfläche per Klick das Rollo hoch/runter oder auf eine bestimmte Position fahren. Der aktuelle Status des Rollo (fährt hoch/runter,offen,geschlossen,etc.) wird angezeigt.
Die Oberflächenicons werden per devStateIcon gesteuert, Icons und Farben können für jeden Status individuell formatiert werden, die Standard Kommandos auf der Oberfläche (hier: offen, geschlossen, schlitz, Position) können ebenfalls per Attribut angepasst werden. Das Status-Icon ist anklickbar.
Beim Anlegen des Moduls werden die Attribute zur Darstellung in fhem mit Standardwerten angelegt, so dass man sich einiges an Tipparbeit sparen kann, aber trotzdem die Möglichkeit hat die Darstellung individuell anzupassen.

== Voraussetzungen ==
Das eigentliche ansteuern des Rollo muss mit FHEM Befehlen ausführbar sein, diese Modul ist "nur" eine Oberfläche/Bedienmodul, kein Hardwaremodul.

Wenn ROLLO installiert wurde, bevor es Bestandteil von FHEM wurde und lange kein Update gemacht wurde, wirst du die "position" readings und das entsprechende set Kommando vermissen. "position" wurde durch "pct" ersetzt, um Kompatibilität mit anderen Modulen [https://fhem.de/commandref_DE.html#AutoShuttersControl Automatic Shutter Control - ASC] sicher zu stellen. Bitte passe deine NOTIFYs/DOIFs entsprechend an.

== Installation ==

{{Hinweis|Dieses Modul ist in der offiziellen FHEM-Auslieferung enthalten.}}

== Anwendung ==
=== Define ===
define <name> ROLLO

=== Attribute ===
{|class="wikitable"
|-
! Name !! Datentyp/ Wertebereich !! Default-Wert !! Beschreibung
|-
|rl_type ||attr <Rollo-Device> rl_type [normal|HomeKit] ||||Typunterscheidung zur unterstützung verschiedener Hardware. Abhängig vom gewählten Typ wird die Richtung von der die pct gerechnet wird festgelegt:

normal = pct 0 ist offen, pct 100 ist geschlossen
HomeKit = pct 100 ist offen, pct 0 ist geschlossen
|-
|rl_secondsDown||attr <Rollo-Device> rl_secondsDown <number> ||||Sekunden zum hochfahren
|-
|rl_secondsUp ||attr <Rollo-Device> rl_secondsUp <number> ||||Sekunden zum herunterfahren
|-
|rl_excessTop ||attr <Rollo-Device> rl_excessTop <number> ||||Zeit, die mein Rollo fahren muss, ohne dass sich die Rollo-pct ändert (bei mir fährt der Rollo noch in die Wand, ohne dass man es am Fenster sieht, die pct ist also schon bei 0%).
|-
|rl_excessBottom ||attr <Rollo-Device> rl_excessBottom <number> ||||(siehe excessTop)
|-
|rl_switchTime ||attr <Rollo-Device> rl_switchTime <number> ||||Zeit, die zwischen 2 gegensätzlichen Laufbefehlen pausiert werden soll, also wenn der Rollo z.B. gerade runter fährt und ich den Befehl gebe hoch zu fahren, dann soll 1 Sekunde gewartet werden bis der Motor wirklich zum stillstand kommt, bevor es wieder in die andere Richtung weiter geht. Dies ist die einzige Zeit, die nichts mit der eigentlichen Laufzeit des Motors zu tun hat, sondern ein Timer zwischen den Laufzeiten.
|-
|rl_resetTime ||attr <Rollo-Device> rl_resetTime <number> ||||Zeit, die beim Anfahren von Endpositionen (offen,geschlossen) der Motor zusätzlich an bleiben soll, um sicherzustellen, dass die Endposition wirklich angefahren wurde. Dadurch können Differenzen in der Positionsberechnung korrigiert werden.
|-
|rl_reactionTime ||attr <Rollo-Device> rl_reactionTime <number> ||||Zeit für den Motor zum reagieren
|-
|rl_autoStop ||attr <Rollo-Device> rl_autoStop [0|1] ||||Es muss kein Stop-Befehl ausgeführt werden, das Rollo stoppt von selbst.
|-
|rl_commandUp ||attr <Rollo-Device> rl_commandUp <string> ||||Es werden bis zu 3 beliebige Befehle zum hochfahren ausgeführt
|-
|rl_commandDown ||attr <Rollo-Device> rl_commandDown <string> ||||Es werden bis zu 3 beliebige Befehle zum runterfahren ausgeführt
|-
|rl_commandStop ||attr <Rollo-Device> rl_commandStop <string> ||||Befehl der zum Stoppen ausgeführt wird, sofern nicht commandStopDown bzw. commandStopUp definiert sind
|-
|rl_commandStopDown ||attr <Rollo-Device> rl_commandStopDown <string> ||||Befehl der zum stoppen ausgeführt wird, wenn der Rollo gerade herunterfährt. Wenn nicht definiert wird commandStop ausgeführt
|-
|rl_commandStopUp ||attr <Rollo-Device> rl_commandStopUp <string> ||||Befehl der zum Stoppen ausgeführt wird,wenn der Rollo gerade hochfährt. Wenn nicht definiert wird commandStop ausgeführt
|-
|rl_blockMode ||attr <Rollo-Device> rl_blockMode [blocked|force-open|force-closed|only-up|only-down|half-up|half-down|none] ||||wenn ich den Befehl blocked ausführe, dann wird aufgrund der blockMode-Art festgelegt wie mein Rollo reagieren soll:

blocked = Rollo lässt sich nicht mehr bewegen
force-open = bei einem beliebigen Fahrbefehl wird Rollo hochgefahren
force-closed = bei einem beliebigen Fahrbefehl wird Rollo runtergefahren
only-up = Befehle zum runterfahren werden ignoriert
only-down = Befehle zum hochfahren werden ignoriert
half-up = es werden nur die Positionen 50-100 angefahren, bei pct <50 wird pct 50% angefahren,
half-down = es werden nur die Positionen 0-50 angefahren, bei pct >50 wird pct 50 angefahren
none = block-Modus ist deaktiviert
|-
|automatic-enabled ||attr <Rollo-Device> automatic-enabled [on|off] ||||Wenn auf off gestellt, haben Befehle über Modul ROLLO_Automatic keine Auswirkungen auf diesen Rollo
|-
|automatic-delay ||attr <Rollo-Device> automatic-delay <number> ||||Dieses Attribut wird nur für die Modulerweiterung ROLLADEN_Automatic benötigt.
Hiermit kann einge Zeitverzögerung für den Rolladen eingestellt werden, werden die Rolladen per Automatic heruntergefahren, so wird dieser um die angegebenen Minuten später heruntergefahren.
|-
|rl_forceDrive ||attr <Rollo-Device> rl_forceDrive [0|1] ||||open/closed wird ausgeführt, auch wenn das ROLLO bereits in der Zielposition ist
|-
|rl_noSetPosBlocked ||attr <Rollo-Device> rl_noSetPosBlocked [0|1] ||||Wenn deaktiviert, können Positionsn (pct) auch gesetzt werden, wenn der ROLLO geblockt ist. Nach dem unblocken wird die entsprechende Position angefahren.
|-
|||disableattr <Rollo-Device> disable [0|1] ||||Wenn deaktiviert, können keine set oder get commandos für den ROLLO ausgeführt werden.
|-
|||||||
|-
|||||||
|-
|||||||
|}

=== Set ===

{|class="wikitable"
|-
!Name !!set Befehl !!Beschreibung
|-
|open ||set <Rollo-Device> open ||Fährt das Rollo komplett auf (pct 0)
|-
|closed ||set <Rollo-Device> closed||Fährt das Rollo komplett zu (pct 100)
|-
|up ||set <Rollo-Device> up ||Fährt das Rollo um 10 auf (pct +10)
|-
|down ||set <Rollo-Device> down ||Fährt das Rollo um 10 zu (pct -10)
|-
|half || set <Rollo-Device> half ||Fährt das Rollo zur Hälfte runter bzw. hoch (pct 50)
|-
|stop ||set <Rollo-Device> stop ||Stoppt das Rollo
|-
|drive ||set <Rollo-Device> drive up 5||Fährt das Rollo in die angegebene Richtung für die angegebene Zeit (in Sekunden)
|-
|blocked ||set <Rollo-Device> blocked ||wenn aktiviert, kann der ROLLO nur noch eingeschränkt gesteuert werden. Siehe Attribut block_mode für Details.
|-
|unblocked ||set <Rollo-Device> unblocked ||Aktiviert einen geblockten ROLLO wieder für die normale Benutzung
|-
|pct ||set <Rollo-Device> pct <value> ||Fährt das Rollo auf eine beliebige pct zwischen 0 (offen) - 100 (geschlossen)
|-
|reset ||set <Rollo-Device> reset <value> ||Sagt dem Modul in welcher pct sich der Rollo befindet
|-
|extern ||set <Rollo-Device> extern <value> ||Der Software mitteilen dass gerade Befehl X bereits ausgeführt wurde und nun z.B,. das berechnen der aktuellen pct gestartet werden soll
|}

=== Get ===

{|class="wikitable"
|-
!Name !!set Befehl !!Beschreibung
|-
|version ||get <Rollo-Device> version ||Gibt die version des Modul Rollos aus
|}

=== Readings ===
{|class="wikitable"
|-
!Name !!Wert !!Beschreibung
|-
|command||open,stop,closed||
|-
|desired_pct||0-100||Zielposition die angefahren werden soll (nur sinnvoll während das Rollo fährt)
|-
|drive-type||modul,extern||bei dem Befehl "set rollo extern .." wird dieses attribut auf "extern" gestellt, sonst immer "modul"
|-
|last_drive||drive-up,drive-down||die zuletzt benutzte Fahrtrichtung
|-
|pct||0-100||exakte Position des Rollo
|-
|state||open,closed,position-[0-100]||die Position gerundet auf ganze 10% Schritte, identisch mit dem Internal STATE
|}

== Anwendungsbeispiele ==
===Set===
set RolladenWohnzimmer pct 50
set RolladenWohnzimmer geschlossen
set RolladenWohnzimmer offen
Drei Beispiele das Rollo-Modul anzuweisen verschiedene Positionen anzufahren.

set RolladenWohnzimmer extern stop
Das Rollo-Modul wird angewiesen den status auf "nicht fahren" zu setzen, die aktuelle Rollo-Position zu berechnen und als neue Position abzuspeichern. Der eigentliche Rollo-Stop-Befehl wird dabei aber nicht gesendet.

set RolladenWohnzimmer reset closed
In der Oberfläche von fhem wird für das Rollo die Position "geschlossen" gespeichert, ohne Berechnungen durchzuführen oder Hardware zu steuern. Wird evtl. benötigt wenn der Ist-Status von den Soll-Werten aus fhem abweicht.

===Zusammenspiel mit externem Taster===
In einem Anwendungszenario hat ein Nutzer zusätzliche Taster an seinem Rollo-Motor über die er ihn ebenfalls steuern kann.
Die Taster selber senden keine Events an fhem, nur der Rollo-Motor.
Hier ein Beispiel wie das ganze für aussehen könnte und diese Taster in das ROLLO-Modul integriert werden:

define rollo_manuell_auf DOIF ([meinRollo_Kanal1] eq "on" and [?meinRolloModul] ne "drive-up") (set meinRolloModul extern open) DOELSEIF ([meinRollo_Kanal1] eq "off" and [?meinRolloModul] eq "drive-up") (set meinRolloModul extern stop)
define rollo_manuell_ab DOIF ([meinRollo_Kanal2] eq "on" and [?meinRolloModul] ne "drive-down") (set meinRolloModul extern closed) DOELSEIF ([meinRollo_Kanal2] eq "off" and [?meinRolloModul] eq "drive-down") (set meinRolloModul extern stop)

meinRollo_Kanal1 und meinRollo_Kanal2 sind die Hardwarekanäle die in dem Rollo-Modul zum hochfahren/runterfahren benutzt werden.
Das erste DOIF prüft ob das Rollo hoch fährt, ohne das das Rollo-Modul davon etwas weis. Ist dem so wird dem Rollo Modul mithilfe des set <extern> mitgeteilt das das Rollo bereits gestartet wurde. Das Modul fängt an die Zeit zu zählen und aktualisiert den Status der Oberfläche auf "fahre hoch".
IM DOELSEIF wird abgefragt ob das Rollo steht, obwohl das Modul denkt das Rollo würde noch fahren. Ist dem so wird wieder mithilfe des set <extern> dem Modul mitgeteilt das das Rollo gestoppt wurde. Das Modul berechnet nun aufgrund der gefahrenen Zeit die aktuelle Position und aktualisiert den Status der Oberfläche auf die Position.

Das gleiche wird dann im zweiten DOIF nochmal für das herunterfahren gemacht.

Man kann nun das Rollo sowohl über die Oberfläche als auch per Taster bedienen und fhem und der reale Ist-Status sind synchron. Ach eine gleichzeitige Bedienung ist möglich, Das Rollo startet z.B. aufgrund einer Automatisierung morgens zum hochfahren und man klickt schnell auf den Taster neben dem Bett und stoppt das ganze wieder.

== Links ==

Thread im {{Link2Forum|Topic=95832|LinkText=Forum}} seit das Modul Bestandteil der offiziellen FHEM Auslieferung ist

Thread im {{Link2Forum|Topic=47202|LinkText=Forum}} bevor das Modul Bestandteil von FHEM war

Diskussion:ROLLO

2020-09-05T07:58:54Z

Plaicy: Werte/Datenbereich ergänzt

= Werte/Datenbereich =

Irgendwie ist da bei "Datentyp/Wertebereich" etwas kaputt gegangen. Da steht teilweise nur ein Wert und es gibt nur eine schließende eckige Klammer und keine öffnende. War da irgendwas spezielles mit den eckigen Klammern angedacht? Wenn nicht versuche ich mal die Informationen aus https://wiki.fhem.de/w/index.php?title=ROLLO&direction=prev&oldid=29111 wieder herzustellen. Außerdem ist die Angabe mit attr leicht überflüssig, da man die ja bei allen Attributen machen muss.--[[Benutzer:Plaicy|Plaicy]] ([[Benutzer Diskussion:Plaicy|Diskussion]]) 09:56, 5. Sep. 2020 (CEST)

Diskussion:ROLLO

2020-09-05T07:56:26Z

Plaicy: Werte/Datenbereich

Irgendwie ist da bei "Datentyp/Wertebereich" etwas kaputt gegangen. Da steht teilweise nur ein Wert und es gibt nur eine schließende eckige Klammer und keine öffnende. War da irgendwas spezielles mit den eckigen Klammern angedacht? Wenn nicht versuche ich mal die Informationen aus https://wiki.fhem.de/w/index.php?title=ROLLO&direction=prev&oldid=29111 wieder herzustellen.--[[Benutzer:Plaicy|Plaicy]] ([[Benutzer Diskussion:Plaicy|Diskussion]]) 09:56, 5. Sep. 2020 (CEST)

Intertechno Code Berechnung

2020-09-04T19:03:37Z

Plaicy: Fix typo ("Dannn")

'''Intertechno''' Systemkomponenten sind kostengünstige und weit verbreitete Funkschalter/-dimmer im 433 MHz Bereich, die man in fast jedem Baumarkt unter den Markennamen Intertechno, düwi, KlikAanKlikUit usw. erhalten kann.

Es gibt eine Anzahl weiterer Hersteller/Handelsmarken mit ähnlicher Kodierung oder Einstellmöglichkeiten mit DIP Schaltern, die ebenfalls mit dem Intertechno Code geschaltet werden können. Dazu zählen von Usern bereits erfolgreich getestete Geräte von Elro AB440, FLS-100/m-e, Wetekom/Westfalia und weitere, theoretisch mögliche aber ungetestete Systeme wie Unitec oder Arctech Steckdosen (siehe [http://avr.börke.de/E-Funk.htm Börkes-HP])

== Voraussetzungen in FHEM ==
Schalten kann man die Intertechno Funkkomponenten in FHEM über verschiedene Wege. So z.B. über CUL/CUNO, Tellstick, [[AVR-NET-IO]].

Hier beschrieben ist die Ansteuerung über CUL/CUNO, dessen Firmware für Intertechno erweitert wurde (Danke an Olaf Droegehorn). Momentan ist in CUL/CUNO das SENDEN von Intertechno Funk implementiert. Die Firmware muss mindestens den Stand 1.44 haben (Kontrolle der Version in den FHEM Detaildaten zum [[CUL]]/[[CUNO]]). Die CUL433/CUNO433 haben dabei volle Reichweite, die Versionen CUL868/CUNO868 funktionieren ebenfalls, haben aufgrund der nicht optimalen Antennenlänge und falschen Abstimmung für den Frequenzbereich aber nur eine eingeschränkte Reichweite.

=== Definition ===
Die Definition des IT Gerätes in FHEM sieht für '''alte Geräte''' so aus:
<syntaxhighlight lang="text">
define myITSwitch IT <housecode><group_switch> <on-code> <off-code> [<dimup-code> <dimdown-code>]
attr myITSwitch IODev CUL_x (CUNO_x)
attr myITSwitch model itswitch
</syntaxhighlight>
Die weitere Anleitung soll die Bildung der Bitfolge für die Zusammensetzung des Schaltcodes erklären.
Wichtig zu wissen ist auch, dass es sich um einen 3state code handelt, d.h. jedes Bit kann '''0,1 oder F''' sein!

Die selbst '''lernenden''' neue '''Geräte''' definiert man in FHEM so:
<syntaxhighlight lang="text">
define <name> IT <26-Bit Adresse> <1-Bit Gruppen Bit> <4-Bit Gerät>
</syntaxhighlight>
Dabei kann man die 26-Bit Adresse frei wählen, so dass Kollisionen mit Nachbarn sehr unwahrscheinlich werden.
Einen GRR-3500 der über einen CUL gesteuert werden soll definiert man z.B. so
<syntaxhighlight lang="text">
define sw_it_outdoor IT 01010101010101010101010101 0 0000
attr myITSwitch IODev CUL_0
attr myITSwitch model itswitch
</syntaxhighlight>
Danach die {{Taste|CODE}}-Taste am Funkschalter betätigen (die LED blinkt) und über FHEM den Einschaltcode senden.

== Original Intertechno System ==

Durch Kombination von Hauscode und Geräetecode können maximal 256 Geräte verwendet werden. Dann würde allerdings alle Hauscodes belegt, was eventuell zu Störungen mit Nachbarinstallationen führen könnte.

=== Hauscode (die ersten vier Stellen (0-3) ===
Der Hauscode wird auf dem Drehschalter auf der Rückseite eingestellt und hat die Bezeichnung '''A-P'''

[[File:Img_3324_small.png|thumb|Intertechno Schalter]]
{| class="wikitable"
! Drehschalter !! Stelle 0-3
|-
| A || 0000
|-
| B || F000
|-
| C || 0F00
|-
| D || FF00
|-
| E || 00F0
|-
| F || F0F0
|-
| G || 0FF0
|-
| H || FFF0
|-
| I || 000F
|-
| J || F00F
|-
| K || 0F0F
|-
| L || FF0F
|-
| M || 00FF
|-
| N || F0FF
|-
| O || 0FFF
|-
| P || FFFF
|}

=== Gruppen-/Gerätecode (Stelle 4-7) ===
Der zweite Drehschalter ist mit den Zahlen von 1-16 beschriftet. Das ist eine Zusammensetzung von Gruppe und Gerätecode und ergibt die nächsten 4 Stellen. Die dritte Spalte in der Tabelle zeigt die Zuordnung einer Intertechno YCT-100 / ITS-150 Fernbedienung. Diese ist mit Drehschalter auf der Rückseite (A-P), einem Gruppenschalter (1-4) , und je vier ein-/aus-Tasten belegt.

[[File:Img_3325_small.png|right|thumb|Intertechno Fernbedienung]]

{| class="wikitable"
! Drehschalter !! Stelle 4-7 !! Fernbedienung Gruppe/Taste
|-
| 01 || 0000 || 1 - 1
|-
| 02 || F000 || 1 - 2
|-
| 03 || 0F00 || 1 - 3
|-
| 04 || FF00 || 1 - 4
|-
| 05 || 00F0 || 2 - 1
|-
| 06 || F0F0 || 2 - 2
|-
| 07 || 0FF0 || 2 - 3
|-
| 08 || FFF0 || 2 - 4
|-
| 09 || 000F || 3 - 1
|-
| 10 || F00F || 3 - 2
|-
| 11 || 0F0F || 3 - 3
|-
| 12 || FF0F || 3 - 4
|-
| 13 || 00FF || 4 - 1
|-
| 14 || F0FF || 4 - 2
|-
| 15 || 0FFF || 4 - 3
|-
| 16 || FFFF || 4 - 4
|}

=== Stellen 8-9 (Festwert 0F) ===
<nowiki>Die Positionen 8-9 sind immer fest auf '''0F'''zu stellen</nowiki>

=== Stellen 10-11 (Ein/Aus) ===
Bei den beiden letzten Stellen steht als Codierung für ON = FF und OFF = F0.

=== Beispiele ===
Drehschalter/Hauscode auf '''A'''
<nowiki> Schalter 1 -> 000000000F FF F0 (entspricht Fernbedienung Gruppe I und Schalter 1)
Schalter 2 -> 0000F0000F FF F0 (entspricht Fernbedienung Gruppe I und Schalter 2)
Schalter 3 -> 00000F000F FF F0 (entspricht Fernbedienung Gruppe I und Schalter 3)
Schalter 4 -> 0000FF000F FF F0 (entspricht Fernbedienung Gruppe I und Schalter 4)</nowiki>

Drehschalter/Hauscode auf '''L'''
<nowiki> Schalter 11 -> FF0F0F0F0F FF F0 (entspricht Fernbedienung Gruppe III und Schalter 3)
Schalter 16 -> FF0FFFFF0F FF F0 (entspricht Fernbedienung Gruppe IV und Schalter 4)</nowiki>
komplett für die fhem cfg also z.B. Hauscode A und Gruppe 1 Gerät/Schalter 1 und CUL Bezeichnung CUL1:

<nowiki> define schalter1 IT 000000000F FF F0
attr schalter1 IODev CUL1
attr schalter1 model itswitch</nowiki>

=== Selbstlernende Intertechno Funksteckdosen (z.B. ITR-1500) ===
Die selbst lernenden Intertechno Funksteckdosen haben ein neues erweitertes Protokoll bei dem ein 32-Bit Wort gesendet wird. Sie sind aber weiterhin kompatibel zum bisherigen 12-Bit Protokoll. In der culfw wird das alte Protokoll mit "Intertechno V1" und das neue mit "Intertechno V3" bezeichnet.

==== Mit altem Protokoll anlernen ====
{{Randnotiz|RNTyp=Fehl|RNText=Schon aus Gründen der Störsicherheit ist davon abzuraten bei neuen selbst lernenden Intertechno Geräten den alten 12-Bit Code zu verwenden. Dieser wird nur unterstützt um rückwärts kompatibel zu sein.}}
Zum Anlernen der selbst lernenden Funksteckdosen muss ein gültiger(!) ON-Befehl in den ersten fünf Sekunden nach dem Einstecken der Funksteckdose in eine normalen Steckdose gesendet werden. Die Funksteckdosen haben drei Speicherplätze, so dass man beispielsweise ein ITR-1500 Set zuerst mit der Fernbedienung anlernen und anschließend eigene Codes von FHEM senden lassen kann. Damit man einen gültigen Code sendet, sucht man sich einfach eine beliebige Kombination aus der obigen Tabelle aus (z.B. C-1, C-2 und C-3) und ergänzt entsprechend um die immer identischen Stellen 8 und 9 (0F) und den ON- und OFF-Code (FF/F0).
Das Senden der Codes von FHEM erfolgt am einfachsten, indem man sich die Steckdosen vorher in der Konfiguration so anlegt, wie man sie haben möchte und anschließend über die Weboberfläche den ON-Befehl gibt.

Mitunter funktioniert das reine Senden des ON Befehls aber nicht, da einige dieser Steckdosen einen längeren ON Befehl benötigen und die Sendedauer bei FHEM/CUL/CUNO nicht beeinflusst werden kann. In diesem Fall nimmt man eine YCT-100 oder ITS-150 Fernbedienung, an der die gewünschte Adresse eingestellt werden kann. Zum Anlernen drückt man nun etwas länger auf den passenden Einschaltknopf, danach kann die Dose von FHEM normal geschaltet werden.

==== Angelernten Code löschen ====
Hier gibt es zwei Möglichkeiten.
# Man sendet wie beim Anlernen innerhalb der ersten 5 Sekunden einen OFF-Befehl. Die Funksteckdosen quittiert diesen mit zweimaligem einschalten. Anschließend reagiert sie auf diesen Code nicht mehr.
# Manche neueren Intertechno Geräte (z.B. GRR-3500) haben eine {{Taste|CODE}}-Taste. Durch kurzes Drücken wird die Funksteckdose für 5 Sekunden in den Betrieb zum Anlernen gesetzt. Hält man diese Taste bis die LED hektisch blinkt, lässt sie dann los und drückt sie noch einmal kurz, so wird der gesamte Speicher für angelernte Codes gelöscht. Die Funksteckdose quittiert das wie üblich durch zweimaliges Einschalten.

==== Mit neuem Protokoll anlernen ====
Die neuen Funksteckdosen können laut Werbung ''"67 Millionen verschiedene Codes"'', das sind 26-Bits (2^26 = 67108864). Da hat die Werbung tatsächlich mal untertrieben. Tatsächlich arbeitet das neue Protokoll mit einem 32-Bit Wort. Jede neue Fernbedienung (z.B. ITT-1500) bekommt ab Werk einen fest einprogrammierten (und hoffentlich weltweit eindeutigen) ID-Code aus 26 Bits. Daran hängt sie ein 2-Bit Kommando und eine 4-Bit Geräte bzw. Tastenpaar Nummer:
{| class="wikitable" style="border-style:solid; border-width:4px"
|-
| style="border-style:solid; border-width:4px" | 26-Bit ID des steuernden Geräts (Fernbedienung)
| style="border-style:solid; border-width:4px" | 2-Bit Kommando
| style="border-style:solid; border-width:4px" | 4-Bit Kanal-ID (Tastenpaar)
|-
|}
Das 2-Bit Kommando ist ein ON oder OFF Befehl an ein einzelnes Gerät oder eine Gruppe.
{| class="wikitable"
|-
! Befehl !! Bedeutung
|-
| 0 0 || Ein Gerät einschalten
|-
| 0 1 || Ein Gerät ausschalten
|-
| 1 0 || Alle Geräte (dieser Gruppe) einschalten
|-
| 1 1 || Alle Geräte (dieser Gruppe) ausschalten
|-
|}
Die ITT-1500 hat zwar eine {{Taste|ALL OFF}}-Taste aber keine {{Taste|ALL ON}}.
Ob das Einschalten als Gruppe generell unterstützt wird ist nicht bekannt.
Einen gültiger Einschaltbefehl kann man am [[CUL]] z.B. mit diesem Kommando senden:
<syntaxhighlight lang="text">
is01010010101011101000000110010011
</syntaxhighlight>
Im Gegensatz zum alten Protokoll (Intertechno V1) wird das Binärwort hier nicht mit 0 und '''F''' sondern 0 und '''1''' gesendet.
{| class="wikitable" style="border-style:solid; border-width:4px"
|-
| style="border-style:solid; border-width:4px" | '''is''' ''(Sende Intertechno Kommando)''
| style="border-style:solid; border-width:4px" | '''01010010101011101000000110''' ''(Gerätecode Fernbedienung)''
| style="border-style:solid; border-width:4px" | '''01''' ''(Kommando ON)''
| style="border-style:solid; border-width:4px" | '''0011''' ''(Tastenpaar 4)''
|-
|}
Die culfw unterscheidet anhand der Kommandolänge ob es sich um einen alten (12 Zeichen) oder neuen (32 Zeichen) Intertechno Befehl handelt.
Genauso unterscheidet das IT-Modul in FHEM die beiden Formate:
define <name> IT <10-bit-housecode> <off-code> <on-code> [<dimup-code>] [<dimdown-code>]
und
define <name> IT <26 bit Address> <1 bit group bit> <4 bit unit>
und setzt das Reading <code>protocol</code> auf <code>V3</code>.

== FLS 100 ==
[[File:FLS100.jpg|right|thumb|FLS100 - konfiguriert auf IV/3]]

Beim FLS 100 von m-e.de gibt es nur 4 mögliche Einstellungen: '''I, II, III und IV'''. Dies entspricht der Gruppe auf der Fernbedienung.

{| class="wikitable"
! Drehschalter !! Stelle 0-3
|-
| I || 0FFF
|-
| II || F0FF
|-
| III || FF0F
|-
| IV || FFF0
|}

Die nächsten vier Stellen geben die Geräte ID an; diese ist identisch mit der Taste an der Fernbedienung.
{| class="wikitable"
! Drehschalter !! Stelle 4-7 !! Fernbedienung Taste
|-
| 1 || 0FFF || 1
|-
| 2 || F0FF || 2
|-
| 3 || FF0F || 3
|-
| 4 || FFF0 || 4
|}

Beim FLS 100 ist nur die letzte Stelle relevant, mit ON: F oder OFF: 0

== Renkforce RSL366R ==
Die Renkfoce (Typ RSL366R) Funksteckdosen sind baugleich der oben genannten FLS 100.
Bei Conrad auch im Set mit Artikel Nummer 1208454 zu finden. Stand 2017-12-03

Folgende Einstellungen haben sich bei mir als Funktionsfähig erwiesen:
(Achtung 0FFF0FFF muss auf die Einstellungen am Drehschalter siehe oben angepasst werden)
Erste 4 Stellen sind der FB Gruppe und die darauf folgenden 4 Stellen sind die Fernbedienungstaste

<nowiki> define Renkforce IT 0FFF0FFF FFFF 0000
attr model itswitch
attr ITrepetition 15</nowiki>

ITrepetition ist auszuprobieren, wann die Steckdose zuverlässig schaltet. Bei mir war es der Wert 15

Nachteil: Es sind maximal 16 Funksteckdosen dieses Typs einsetzbar.
Es gibt keinen Rückkanal.

== REV Telecontrol ==
[[File:Rev-funksteckdose-telecontrol-3500-w-008345.png|right|thumb|REV Telecontrol]]

Die REV Telecontrol haben einen Dreh-Wahlschalter auf der Rückseite, mit dem sich der Hauscode (A - D) und der Gerätecode (1 - 3) bestimmen lässt.

Die Codierung ist dabei:
{| class="wikitable"
! Hauscode !! Stelle 1-4
|-
| A || 1FFF
|-
| B || F1FF
|-
| C || FF1F
|-
| D || FFF1
|}

{| class="wikitable"
! Gerätecode !! Stelle 5-7
|-
| 1 || 1FF
|-
| 2 || F1F
|-
| 3 || FF1
|}

Dazu (Stelle 8+9+10) noch drei statische Werte: 0FF.

Der Code für '''An''' ist FF, für '''Aus''' 00.

Beispiel:
:<code>define My_Switch IT 1FFF1FF0FF FF 00 für A1</code>
Erfolgreich getestet mit CULfw V 1.49 CUL868.

== Elro AB440 ==
=== Möglichkeit 1: zu Intertechno-Codes umdippen ===
[[File:ELRO-AB440_Funkschalter.jpg|right|thumb|Élro AB440 Funkschalter]]

Günstige ELRO Funkschalter/Dimmer der Serie 440 lassen sich auch problemlos auf Intertechno Codierung "umdippen" und damit voll kompatibel mit allen möglichen A-P / 1-16 Intertechno Schaltcodes von FHEM aus nutzen. Dazu müssen die Dipschalter-Stellungen entsprechend Intertechno umgerechnet und gesetzt werden (1=ON, 0=OFF).

Beispiele:
{| class="wikitable"
! Intertechno !! Elro Hauscode 1234 !! Elro Gerätecode 5ABCDE
|-
| A1 || 1111 || 111110
|-
| A2 || 1111 || 011110
|-
| A3 || 1111 || 101110
|-
| A4 || 1111 || 001110
|-
| A5 || 1111 || 110110
|-
| A6 || 1111 || 010110
|-
| A7 || 1111 || 100110
|-
| A8 || 1111 || 000110
|-
| A9 || 1111 || 111010
|-
| A10 || 1111 || 011010
|-
| A16 || 1111 || 000010
|-
| C1 || 1011 || 111110
|-
| C2 || 1011 || 011110
|}

Weitere Erklärungen sind z.B. im [http://isn-systems.com/tools/it2elro Tool] der Fa. ISN-systems online verfügbar (berechnen lassen etc.).

Einziger Nachteil: Die originale Elro Fernbedienung funktioniert dann nicht mehr uneingeschränkt mit den Funkschaltern (eine Intertechno Fernbedienung funktioniert uneingeschränkt). Wenn man den Hauscode an der Fernbedienung einstellt, kann man durch Drücken von z.T. mehreren Tasten gleichzeitig auch Intertechno schalten. Das ist aber nur was für den Notfall oder für Handakrobaten.

<nowiki>15/16 -> D
13/14 -> A+D
11/12 -> B+D
09/10 -> A+B+D
07/08 -> C+D
05/06 -> A+C+D
03/04 -> B+C+D
01/02 -> A+B+C+D</nowiki>

=== Möglichkeit 2: aus der vorhanden DIP-Schalterstellung den entsprechenden 10-digit InterTechno Code bestimmen ===
Das ist prinzipiell ganz einfach. Hat man folgende DIP-Schalter-Stellung so muss man von links nach rechts einfach für jeden DIP gleich "ON" eine "0" und für "OFF" ein "F" definieren. Für die dargestellte DIP-Einstellung ergibt sich damit der darunterstehende InterTechno Code:

[[File:ELRO_0100101111.png]]

<code>0F00F0FFFF</code>

Analog dazu ergeben sich für den gleichen Hauscode (Schalter 1-5) folgende Codes für die Funksteckdosen B bis E, wobei die Dose E mit der Originalfernbedienung nicht adressierbar ist, sich mit FHEM aber wunderbar schalten lässt.

[[File:ELRO_0100110111.png]]

<code>0F00FF0FFF</code>

[[File:ELRO_0100111011.png]]

<code>0F00FFF0FF</code>

[[File:ELRO_0100111101.png]]

<code>0F00FFFF0F</code>

[[File:ELRO_0100111110.png]]

<code>0F00FFFFF0</code>

Dazu noch die Codes für AN = FF und AUS = F0 schaut eine vollständige Definition eines ELRO440 Funkschalters dann bsw. so aus:

<nowiki> define ELRO_10110_A IT 0F00F0FFFF FF F0
attr ELRO_10110_A IODev CUL_0
attr ELRO_10110_A alias Stehlampe
attr ELRO_10110_A fp_Grundriss 340,50,1,Stehlampe
attr ELRO_10110_A group Schalter
attr ELRO_10110_A model itswitch
attr ELRO_10110_A room Wohnzimmer</nowiki>

[[File:b1-Funksteckdose-von-Toom.jpg|right|thumb|b1 Funksteckdose von Toom]]
== b1 / Toom ==
Das "Funksteckdosen-Set" der Marke b1 aus dem Toom-Baumarkt (3 Funksteckdosen + 1 Fernbedienung mit 4x ein/aus) funktioniert exakt wie ELRO, auch die DIP-Schalter sind genauso belegt.

== Wetekom/Westfalia ==
[[File:Westfalia-Funksteckdose.jpg|right|thumb|Westfalia Funksteckdose ZTC-S316A.]]
Der eingestellte Hauscode ist F00F0FFF0F.

In den Westfalia-Baumärkten gibt es Funksteckdosen mit Westfalia-Branding. Auf der Bedienungsanleitung steht aber Wetekom.

Die Funksteckdosen selbst haben zehn DIP-Switches: 1234FEDCBA, während die Fernbedienung nur sechs hat: ABCDEF. Damit die Fernbedienung mit den Funksteckdosen funktioniert, darf man nur einen der DIP-Switches 1234 pro Funksteckdose auf ON schalten.

Die Schaltung der DIP-Switches ABCDEF4321 entspricht direkt und in dieser Reihenfolge (also andersrum als direkt an der Funksteckdose) dem Hauscode und zwar entspricht ein Switch auf OFF einem F im Hauscode und ein Switch auf ON einer 0 im Hauscode.

Die Steckdosen werden dann mit 01 ein- und mit 10 ausgeschaltet.

Beispiel:
define wf_steckdose IT F00F0FFF0F 01 10

== Pollin Funksteckdosen ==

Vom Aussehen sind die Steckdosen von Pollin (z.B. 3fach Set 550666) mit den Westfalia ZTC identisch, aber:

* die DIP Schalter sind beschriftet von 0 bis 10;
* der Adresscode entspricht dem invertierten ELRO 440 Code ->also (0=ON, 1=OFF)
* der Code für "An" ist 0F, für "Aus" F0

Beispiel für Adresse C2:

define IT_C2 IT 0F00F0000F 0F F0

== me micro-electric AS 73 ==

[[Datei:Me_AS_73.JPG|right|thumb|micro-electric Funksteckdose AS 73]]

Die micro-electric Funksteckdosen haben 10 DIP-Schalter: 123456ABCD.

Der Hauscode wird an Sender und Steckdose mit 1-6 eingestellt, der Empfängercode A-D entspricht den Kanälen auf dem Handsender.

DIP-Schalterstellung OFF entspricht F und ON entspricht 0.

Die Steckdosen werden mit F0 ein- und mit 0F ausgeschaltet.

Empfängercodes:
{| class="wikitable"
! Kanal !! Position 7-10
|-
| A || 0FFF
|-
| B || F0FF
|-
| C || FFF0 (Achtung: bei C und D sind die Codes vertauscht)
|-
| D || FF0F
|}

Beispiel:
:<code>define Schalter_ME_A IT 0F0F000FFF F0 0F</code>
:<code>attr Schalter_ME_A IODev CUL1</code>
:<code>attr Schalter_ME_A model itswitch</code>

== Conrad / McPower Funkschaltset 3+1 ==
Dieses Funkschaltset wird unter mehreren Namen in verschiedenen Bau- und Heimwerkermärkten sowie bei Conrad (Best Nr. 640475 - 62) vertrieben. Teilweise auch mit unterschiedlichen Schaltleistungen.
Die Konfiguration funktioniert genauso wie beim [[Intertechno_Code_Berechnung#FLS_100|FLS100]]

== CMI / OBI / LUX IP44-Funkschaltset 2+1 ==
[[File:RCS_14G_Funksteckdose_Obi_klein.png|right|thumb|Rückansicht der OBI / Lux Funksteckdose]]
Dieses Set wird u.a. bei OBI verkauft, als Hersteller wird die Emil Lux GmbH angegeben. Typennummer RCS-14G, Artikel Nummer 308555
Die Steckdosen sind IP44 geschützt und damit auch für den Außeneinsatz geeignet.
Die Steckdosen verfügen lediglich über einen Kanal-Schalter von 1-4. Diese Kanal-Nummern korrespondieren mit der folgenden Übersetzung:

{| class="wikitable"
! Kanal !! Code (Stelle 1-10)
|-
| 1 || 000FF0F0FF
|-
| 2 || 000FFF00FF
|-
| 3 || 000F0FF0FF
|-
| 4 || 0000FFF0FF
|}

Die Steckdosen werden dann mit FF ein- und mit F0 ausgeschaltet.

Beispiel:
:<code>define Schalter_OBI_Code_1 IT 000FF0F0FF FF F0</code>
:<code>attr Schalter_OBI_Code_1 IODev CUL1</code>
:<code>attr Schalter_OBI_Code_1 model itswitch</code>

== Noch nicht aufgeführte Geräte ==
Wer ein Intertechno-ähnliches Gerät besitzt, das in dieser Liste noch nicht aufgeführt ist, muss die Kodierung selbst bestimmen. Dazu gibt es verschiedene Möglichkeiten, die in diesem Abschnitt aufgeführt werden. Die Ergebnisse bitte hier eintragen, um Nachfolgern die Arbeit zu ersparen!

=== Audio-Eingang zur Messung ===
Hier wird die Fernbedienung oder der Empfänger mit einer entsprechenden Schaltung an den Mikrofon-Eingang eines Rechners angeschlossen und mit einem Audio-Programm werden die Signalverläufe aufgenommen. Diese Methode wird [http://avr.börke.de/E-Funk.htm hier] näher erläutert.

=== Platine analysieren ===
[[File:Westfalia-Funkfernbedienung-hinten.jpg|right|thumb|Platine der Westfalia Funkfernbedienung ZTC-TC von hinten.]]
[[File:Westfalia-Funkfernbedienung-vorne.jpg|right|thumb|Platine der Westfalia Funkfernbedienung ZTC-TC von vorne.]]

Platine der Fernbedienung oder des Empfängers betrachten und so die Beschaltung des Decoder/Encoder Chips ermitteln. Bei der Wetekom-Fernbedienung wird beispielsweise der Chip LP801b verwendet, der funktional identisch zum PT2262 ist. Im [http://www.escol.com.my/Datasheets_specs/pt2262_1.pdf Datenblatt des PT2262] kann man dann die Beschaltung nachsehen. Nun betrachtet man den Verlauf der Leiterbahnen auf der Platine, um die Beschaltung des Chips zu ermitteln. So kann man beispielsweise bei der Wetekom-Fernbedienung sehen, dass die DIP-Switches A bis F auf die Eingänge A0 bis A5 geschaltet sind. Außerdem sieht man, mit welchen Eingängen die einzelnen Taster verbunden sind.

Nun kann man messen, zwischen welchen Chip-Eingängen und Batteriepolen eine Spannung anliegt, bzw. (ohne Batterie) zwischen welchen Chip-Eingängen und Batteriepolen es einen Durchgang gibt, um zu ermitteln, wie die DIP-Switches schalten. Im Fall der Wetekom-Fernbedienung liegt keine Spannung zwischen den Eingängen und den beiden Batteriepolen an, wenn die DIP-Switches auf OFF stehen: Der Eingang liegt also auf F (Float). Wenn die DIP-Switches auf ON stehen, liegt nur eine Spannung zwischen dem Pluspol der Batterie und dem Eingang an, es gibt also einen Durchgang zwischen dem Minuspol und dem Eingang, so dass der Eingang auf V_SS liegt und damit 0 eingestellt ist.

Bei den Eingängen D0 und D1 sieht man, dass der Batterie-Pluspol immer über einen Widerstand mit dem Dateneingang verbunden ist, also normalerweise 1 anliegt. Ist aber ein Ein-Taster gedrückt, wird der Eingang D1 direkt mit dem Minuspol der Batterie verbunden, bei den Aus-Tastern der Eingang D0 (die Verbindung der Aus-Taster ist auf den Bildern nicht besonders gut zu erkennen). Durch diese Verbindung wird der Eingang auf V_SS heruntergezogen und damit ist 0 eingestellt.

=== Mit [[CUL]] im Debug-Modus Rohsignale empfangen und analysieren ===
* Wurde im {{Link2Forum|Topic=5599|LinkText=Forum}} diskutiert.
Ein 433MHz CUL kann mit dem Befehl <code>X67</code> Intertechno Kommandos mitlesen.
Allerdings funktioniert das bei der "üblichen" Firmware nur lückenhaft.
Dazu wurde bereits eine spezielle Variante der culfw entwickelt (siehe {{Link2Forum|Topic=24436|Message=105|LinkText=Forum}}).
Die Ausgaben sind aber dann als doppelt so langes Binärwort im Hex-Format.
Man muss quasi jedes zweite Bit streichen, da die einzelnen Bits als steigende bzw. fallende Flanken übertragen werden.
Man kann aber damit auch einer neuen ITT-1500 ihre Kommandos und vor allem ihre 26-Bit ID entlocken.

==== Mit CUL868 433MHz mitlesen ====
Man kann auch mit der 868MHz Version des CUL Fernbedienungen von Intertechno mitlesen.
Dazu die gewünschte Trägerfrequenz 433.92MHz * 2^16 / 26MHz = 1093745 = 0x10B071 als 24-Bit Teiler in die Register <code>FREQ[2-0]</code> schreiben und einen Reset ausführen.
W0F10
W10B0
W1171
B
Danach kann man mit <code>X67</code> auf der Frequenz mitlesen. Mit <code>e</code> kann der EEPROM wieder auf den Default 0x21656A, 868.30MHz gestellt werden.

[[Kategorie:Intertechno]]
[[Kategorie:HOWTOS]]
[[Kategorie:433MHz]]

FHT80b

2020-08-27T17:33:23Z

Plaicy: fix typo in Urlaub

{{Infobox Hardware
|Bild=FHT80b.jpg
|Bildbeschreibung=FHT80b
|HWProtocol=FHT
|HWType=Empfänger
|HWCategory=FHT
|HWComm=868,35 MHz
|HWChannels=1
|HWVoltage=3 V
|HWPowerConsumption=(ca. 2 Jahre)
|HWPoweredBy=2x AA
|HWSize=100 x 60 x 60 mm
|HWDeviceFHEM=11_FHT8V.pm
|HWManufacturer=ELV / eQ-3}}

Der [[FHT80b]] ist ein programmierbarer Raumthermostat, der bis zu 8 Stellantriebe [[FHT8v]] steuern kann.

'''Achtung: Dieses Gerät ist abgekündigt (wird nicht mehr hergestellt).'''{{Link2Forum|Topic=60219}}

== Features ==
Lokal programmierbare Tages- und Nachttemperatur, die pro Tag mit 4 Schaltpunkten programmiert werden kann.
Zusätzliche Anbindung eines Tür/Fensterkontaktes [[FHT80TF]] zur Absenkung der Temperatur auf separat einstellbaren Wert bei offenem Fenster (windowopen-temp).

== Readings ==
{| class="wikitable"
! Parameter
! Wertbeispiel
! Erklärung
|-
| actuator
| 0%
| Position des Stellantriebes in %
|-
| battery
| ok low
| Ladezustand der Batterien
|-
| mode
| auto manual holiday_short 
| Funktionsmodus (auto, manuell oder Urlaub/Party)
|-
| state
| measured-temp: 20.9
| Ist-Temperatur in ° (C oder F in FHT80B wählbar)
|-
| desired-temp
| 21.0
| Solltemperatur in ° (C oder F in FHT80B wählbar)
|-
| holiday1
| 126
| Endzeit der Urlaubs-/Partyfunktion. Uhrzeit in Minuten seit 00:00 geteilt 10 (im Beispiel 21:00 Uhr)
|-
| holiday2
| 31
| Tag im Monat an der die Urlaubs-/Partyfunktion endet
|-
| lowtemp
| ok warn
| Untertemperatur-Alarm: Im Raum wird der Temperatur-Sollwert nicht erreicht
|-
| manu-temp
|
| Solltemperatur bei Manuell-Modus
|-
| night-temp
|
| Solltemperatur bei Absenkung
|-
| warnings
| none Battery low Temperature too low Fault on window sensor
| Auflistung der Fehler
|-
| window
| closed open
| Statusmeldungen vom FHT80-TF
|-
| windowsensor
| ok fault
| fault, wenn ein angemeldeter Fenstermelder nicht erreicht werden kann.
|-
| windowopentemp
| 9.0
| Solltemperatur bei offenem Fenster
|-
| year 
month 
day 
hour 
minute
|
| Zeitangaben für interne Uhr
|-
| mon-from1 
mon-from2 
mon-to1 
mon-to2 
tue-from1 
tue-from2 
tue-to1 
tue-to2 
wed-from1 
wed-from2 
wed-to1 
wed-to2 
thu-from1 
thu-from2 
thu-to1 
thu-to2 
fri-from1 
fri-from2 
fri-to1 
fri-to2 
sat-from1 
sat-from2 
sat-to1 
sat-to2 
sun-from1 
sun-from2 
sun-to1 
sun-to2
| 06:00
| Angabe von Schaltzeiten im Format HH:MM
|}

== Hinweise zum Betrieb mit FHEM ==
Vor dem Einsatz muss der FHT80b mit der Zentrale (z.B. CUL) gepairt werden. Geschieht dies nicht, können nach einer Definition in FHEM zwar Daten des FHT80b empfangen werden (z. B. Raumtemperatur), es können jedoch keine Befehle gesendet werden. Zum pairen den FHT80b in Sonderfunktionen "cENT" auf "n/a" stellen, danach sofort einen Befehl (egal welchen) an die FHT80b senden. Wenn ca. zwei Minuten später Sonderfunktion cENT auf "ON" steht, war das Pairing erfolgreich.

Weitere Hinweise: [[FHT mit RFR CUL pairen]]

Außerdem muss das FHT per Hand oder Autocreate angelegt werden. Die Adresse des FHT wird beim Anlegen mit Autocreate in FHEM hexadezimal angegeben, im Gerät jedoch dezimal. Dabei muss die Adresse paarweise umgerechnet werden. Beispiel: FHEM habe ein FHT mit der Adresse 162c angelegt. Dies entspricht dann
hex 16 = 22 dez
hex 2c = 44 dez
dem FHT mit der am FHT eingestellten Adresse 2244.
Genauso gut kann man aber auch eine am FHT eingestellte Adresse nach der selben paarweisen Methode in Hex umrechnen und in FHEM das FHT dann per Hand anlegen.

Das FHT80b akzeptiert Befehle vom FHZ1X00 (oder CUL/CUN) nur alle 115+x Sekunden (x = 0.5*letztes Byte des FHT-Hauscodes (auch ''FHT-ID'' genannt), Beispiel: FHT-ID 1234, Sendeintervall = 115+0,5*4 = 117 Sekunden)
Praktisch ergeben sich so ca. zwei Minuten.
Wenn man also mit FHEM z.B. fünf desired-temp Wechsel sendet, so wird es selbst unter optimalen Bedingungen 9-10 Minuten dauern, bis der letzte ausgeführt wird.

Dies muss insbesondere beim Debuggen von Automationszenarien berücksichtigt werden. Nicht absetzbare Kommandos werden im einem Puffer der FHZ1x00/CUL/CUN gespeichert, obwohl sie im FHEM Log als abgesetzt erscheinen. Bei größeren Installationen kann auch der Puffer überlaufen ([[EOB]] Fehlermeldung im FHEM Log). Die Puffer sind unterschiedlich gross. Am kleinsten ist er bei den FHZ1x00 mit ca. 40 Byte, was für ca. acht FHT Befehle reicht. Am grössten ist er im CULv3 oder CUN mit 200 Bytes, das reicht für ca. 40 Befehle.

Bei zu kleinem Puffer bietet FHEM die Möglichkeit, einen Softpuffer (fhtsoftbuffer) zu konfigurieren (dieser wirkt jedoch nur bei FHZ1X00PC Zentralen). Insgesamt ist fhtsoftbuffer nur dann sinnvoll einsetzbar, wenn die Funklage an sich gut ist und der Puffer zügig abgearbeitet wird. Softbuffer sollte '''nicht''' eingesetzt werden, wenn die Übertragung der FHT Befehle gestört ist, da sich dann schnell sehr lange Befehlsketten im Puffer aufbauen können, deren Abarbeitung sehr viel Zeit in Anspruch nehmen kann. Dies kann dazu führen, dass Kommandos an FHTs erst Stunden später ausgeführt werden.

Um mehr Befehle an ein FHT80b senden zu können, können bis zu 8 Befehle zusammengefasst werden, diese belegen dann nur einen "Zeitslot"

Beispiele:
:<code>set heizung_wohn desired-temp 20.5 day-temp 19.0 night-temp 16.0</code>

:<code>set hzg_WC mon-from1 07:00 mon-to1 10:00 mon-from2 14:00 mon-to2 23:00</code>

Die Kommunikation des FHT80b mit den Stellantrieben und dem Türkontakt erfolgt ebenso in Zeitabständen von ca. zwei Minuten. In den Pausen sind die Sender und Empfänger von FHT80b und FHT8v abgeschaltet, um Batteriestrom zu sparen.

Die Übermittlung der aktuellen Temperaturdaten an die Zentrale (FHZ, [[CUN]]) erfolgt alle 15 Minuten.

Die Kommunikation mit der Zentrale ist bidirektional, d.h. die Funkzentrale sendet auch Daten an die FHT80b zurück (insbesondere Acknowledge Meldungen etc). Dies führt dazu, dass im Zusammenhang mit der Sendzeitbegrenzung die Anzahl der [[Maximal nutzbare Geräte|maximal nutzbaren Geräte]] begrenzt ist. Theoretisch lassen sich bis zu 17, in der Praxis eher nur ca. 10 FHT80b sinnvoll mit einer Zentrale steuern.

== Verschiedene Betriebsarten mit FHEM ==
Da das FHT80 selbst ein Heizprogramm speichern und daher eigentlich auch autark arbeiten kann, stellt sich die Frage, wie FHT80 am Besten in FHEM integriert werden sollte. Es gibt dazu drei wesentliche Szenarien:

* das FHT80 heizt nur über seine eigenen Heizprogramme, steht also im Automatik Modus. Diese werden jedoch nicht umständlich am FHT80 selber einprogrammiert sondern über FHEM gesetzt. Auch alle gewünschten Änderungen werden über eine Anpassung der im FHT gespeicherten Programme und Setzen von day-temp und night-temp realisiert. Vorteil: Volle Funktionalität auch ohne FHEM, daher ausfallsicher. Nachteil: Änderungen erzeugen hohe Funklast, da ganze Wochenprogramme übertragen werden müssen. Führt bei mehr als fünf bis sechs FHTs idR. zu [[EOB]] und [[LOVF]] Problemen. Außerdem: Beschränkung auf die FHT80 typisch geringe Zahl von Schaltpunkten (vier pro Tag), mehrstufige Temperaturänderungen sind umständlich. Abhängigkeiten in FHEM (Anwesenheitskontrolle, Bedingungen wie Nutzungserkennung durch Bewegungssensoren etc.) sind schwerer umsetzbar.

* das FHT80 heizt über seine eigenen Heizprogramme, steht also im Automatik Modus. Zusätzlich sendet FHEM z.B. desired-temp Meldungen und greift so in das Heizprofil ein. Vorteil: Grundfunktionalität auch ohne FHEM, daher ausfallsicher: Das Wochenprogramm des FHT80 wird als Grundprogramm und Fallback genutzt. Zusätzliche Heizpunkte oder höhere/niedrigere Temperaturen werden durch FHEM gesteuert. Geringere Funklast, sofern das Grundprogramm selten geändert wird. Beliebige Schaltpunkte, beliebige Temperaturänderungen leicht einstellbar. Nachteil: Komplex. Das Heizverhalten hängt sowohl vom lokalen Programm im FHT80 ab, als auch von Kommandos die FHEM sendet. Das macht die Steuerung unübersichtlich. Problematisch ist insbesondere, wenn lokale Schaltpunkte kurz vorher gesendete FHEM Kommandos negieren. Dies macht z.B. das Herunterfahren der Heizung bei ungeplanter Abwesenheit schwierig.

* das FHT80 wird in den manuellen Mode geschaltet und nur über FHEM mittels desired-temp Kommandos gesteuert. Vorteil: Da FHEM volle Kontrolle hat, einfache Umsetzung von Abhängigkeiten (Anwesenheitskontrolle, Bedingungen wie Nutzungserkennung durch Bewegungssensoren etc.). Beliebige Schaltpunkte, beliebige Temperaturänderungen leicht einstellbar. Unkomplex: Temperatur hängt nur vom letzt-gesendeten desired-temp Kommando ab. Nachteil: Bei Ausfall von FHEM wird das FHT80 quasi funktionslos und hält nur die letzte eingestellte Temperatur. Es könnten allerdings im FHT gespeicherte Heizprogramme durch manuelles Umschalten am FHT80 auf den Automatikmodus (Tastendruck) aktiviert werden.

Da das FHT80 auch per FHEM-Befehl zwischen manuellem und automatischem Modus umgestellt werden kann, sind auch Mischformen speziell zwischen den letzten beiden Varianten einsetzbar. Dies wird z.B. im Code Snippet [[FHT80b Automatik setzen]] genutzt.

== Log-Auszug ==
FHT80b sendet ca. alle zwei Minuten Steuerbefehle an ggf. angeschlossene Ventilstellantriebe. Der einzustellende Wert liegt zwischen 0% und 100% und wird von FHT80b auf Basis der am Gerät eingestellten Solltemperatur und der vom Gerät gemessenen Ist-Temperatur berechnet:

FHT <device-name> actuator: 0%

Außerdem sendet FHT80b ca. 4 mal pro Stunde folgenden Statusbericht:

FHT <device-name> actuator: 0%
FHT <device-name> measured-temp: 23.1 (Celsius)
FHT <device-name> battery: ok
FHT <device-name> lowtemp: ok
FHT <device-name> window: closed
FHT <device-name> windowsensor: ok
FHT <device-name> warnings: none

Die dazu nötige bidirektionale Kommunikation kann mit FHEM
mitprotokolliert werden ("set CUL raw X61" vorher nicht vergessen). Hier ein
beispielhafter Mitschnitt:

2008-09-28 13:04:18 FHT wz actuator: 0%
2008-09-28 13:04:18 FHT wz actuator: 0%
2008-09-28 13:04:18 FHT wz start-xmit: 17
2008-09-28 13:04:18 FHT wz FHZ:start-xmit: 17
2008-09-28 13:04:19 FHT wz measured-low: 21.9 (Celsius)
2008-09-28 13:04:19 FHT wz FHZ:measured-low: 21.9 (Celsius)
2008-09-28 13:04:19 FHT wz measured-high: 0
2008-09-28 13:04:19 FHT wz FHZ:measured-high: 0
2008-09-28 13:04:19 FHT wz ack: 0
2008-09-28 13:04:20 FHT wz FHZ:ack: 0
2008-09-28 13:04:20 FHT wz warnings: none
2008-09-28 13:04:20 FHT wz FHZ:warnings: none
2008-09-28 13:04:20 FHT wz ack: 0
2008-09-28 13:04:20 FHT wz FHZ:ack: 0
2008-09-28 13:04:20 FHT wz end-xmit: 0
2008-09-28 13:04:20 FHT wz FHZ:end-xmit: 0

Jede Zeile steht für ein Telegramm (und nicht für 3, wie beim FS20).

FHZ:xxx Telegramme wurden von der FHZ (oder CUN/CUL) gesendet, die anderen vom FHT.

FHEM fasst measured-low und measured-high zu measured-temp zusammen, es werden also im normalen log (telnet: inform timer) zwei Zeilen weniger gemeldet.

17 ist der Hauscode der protokollierten FHZ. Wenn die FHZ nicht mit dem richtigen Hauscode antwortet, dann geht die Kommunikation nicht weiter.

Wenn das FHT nicht an der FHZ angemeldet ist (d.h., das FHT hat nicht den Hauscode des FHZ gespeichert), werden keine Temperaturdaten übermittelt. Set Prog:Cent:N/A setzt den FHT Hauscode auf 100, dann sollte jede FHZ auf "start-xmit" antworten, und das FHT merkt den ersten. Noch besser ist es, dem FHT via FHEM etwas zu senden, dann muss nicht auf die nächste Temperaturmeldung (bis zu 15 Minuten) gewartet werden.

Mehr dazu auch hier: [[FHT mit RFR CUL pairen]]

Falls die Gegenseite nicht wie erwartet antwortet, wird nach einem Timeout das Telegramm einmal wiederholt. Falls immer noch keine korrekte Antwort vorliegt, wird nach 115+x Sekunden der ganze Vorgang einmal wiederholt.

Durch diese recht umfangreiche Kommunikation entsteht im Zusammenhang mit der Sendezeitbeschränkung die maximale Anzahl nutzbarer Geräte von ca. einem Dutzend.

== Bekannte Probleme ==
* Es gibt zwei weitere, gleich aussehende Geräte mit geringerem Funktionsumfang. Der [[FHT8b]] hat keine Verbindung zu Fensterkontakten. Der [[FHT8]] hat keinen bidirektionalen Funk und kann nicht mit einer Zentrale/FHEM verbunden werden.
* Die Sendefrequenzen einiger FHT80b sind nicht besonders genau auf den eigentlichen Wert von 868,35 MHz justiert und streuen bei verschiedenen Geräten. Die FHZ 1x00PC Geräte sind gegenüber leichten Abweichungen der Frequenz durch eine etwas höhere Empfangsbandbreite eher unempfindlich. Die [[CUL]] oder [[CUNO]] halten die eingestellte Frequenz dagegen trennschärfer ein, sodass es zu Empfangsproblemen kommen kann. Können Signale eines FHT nicht empfangen werden, kann es sinnvoll sein, probeweise die Frequenz des CUL zu ändern (in 0,05 MHz Schritten), oder die Bandbreite aufzuweiten, z.B. auf 464 kHz.
* In seltenen Fällen fehlerhafte Aktuator Meldungen, siehe [[Lime-Protection Bug]]
* FHTs hören in der Regel nach 5-10 Tagen auf, von sich aus Daten zur Zentrale zu senden, wenn sonst keine Kommunikation mit dem FHT stattfindet. Ein regelmäßiges z.B. wöchentliches Stellen der Uhrzeit oder wöchentliches Abfragen der wichtigsten Parameter (report2 = 255) vorteilhaft zu eher "funklastarmen" Zeiten schafft Abhilfe; z.B.: <code>define fht_reportZimmer1 at *04:00:00 {if ($wday == 1) { fhem("set hzg_Zimmer1 report2 255") } }</code>
* Die o.g. Situation bringt häufig auch die Actuator-Meldung "'''unknown_69'''" mit sich. Eine Beschreibung zur Behebung findet sich in {{Link2Forum|Topic=6755|Message=28860|LinkText=diesem Forums-Post}}.
* Der Betrieb von FHTs mit einen [[RFR CUL]] kann zu besonderen Problemen führen, siehe [[RFR CUL und FHT80]]

== Links ==
* [[Funk-Heizkörperregler_Kurz-Bedienungsanleitung_FHT|Kurz-Bedienungsanleitung]]
* Anleitung [http://www.eq-3.de/Downloads/eq3/downloads_produktkatalog/andere_produkte_bda/FHT80B_UM_G_080812.pdf hier (eQ-3)] oder {{DocLink|elv|/Assets/Produkte/8/856/85643/Downloads/85643_FHT80B_UM.pdf hier (ELV)}} als PDF
* Baugleich auch als Set ('''FHT80b''', [[FHT80TF]]) von Medion (bei Aldi oder ebay): [http://www.discounter-archiv.de/de/archiv/ALDI-Nord/2011-01-06/Automatische-Funk-Heizkoerpersteuerung/692135/ Lifetec MD12050]
* [[Kommunikationsprobleme mit FHT]]
* [[Was ist der Hauscode?]]

Eine Reihe von Code Snippets zum Thema FHT80b:
* [[FHT80b Einstellungen]]
* [[FHT80b Automatik setzen]]
* [[FHT: Datum und Zeit von FHEM setzen lassen]]

[[Kategorie:FHT Components]]
[[Kategorie:Heizungssteuerung]]
[[Kategorie:868MHz]]

AutoShuttersControl

2019-06-13T21:40:39Z

Plaicy: Fix typo

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

=== 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/ 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/ 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/ 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/ 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-05-03 Beta-User}}

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

[[Datei:RG AutoShuttersControl Homematic.png|600px|]]

<pre> 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 ===
<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.
 
Anderes {{Link2Forum|Topic=99980|Message=946357|LinkText=foren-Bespiel}} für eine RG zu Beschattung (für V. 0.6.x):
<pre>define rg_ASC_Shading readingsGroup <Gerät>,<Grad>,<Position>,<Mode>,<Links>,<Rechts>,<Wait>,<ShadeIn>,<ShadeOut>,,<Min_Elevation><Device>\
(br_rollo|sz_rollo|ds_rollo|bd_rollo|wz_rollo|wz_rollo_f):!?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_Min_Elevation,!?ASC_BrightnessSensor
attr rg_ASC_Shading commands {ASC_Shading_Direction => 'ASC_Shading_Direction:165,255,345',\
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,10000,1000,40000,0,lin',\
ASC_Shading_StateChange_Cloudy => 'ASC_Shading_StateChange_Cloudy:selectnumbers,10000,1000,40000,0,lin',\
ASC_Shading_Min_Elevation =>
'ASC_Shading_Min_Elevation:selectnumbers,0,1,40,0,lin'}
attr rg_ASC_Shading room ASC</pre>

=== 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]]

SIP-Client

2019-05-23T18:50:37Z

Plaicy: typos

{{Infobox Modul
|ModPurpose=SIP-Client für FHEM
|ModType=h
|ModCmdRef=SIP
|ModForumArea=Sonstiges
|ModTechName=96_SIP.pm
|ModOwner=Wzut ({{Link2FU|1172|Forum}} / [[Benutzer Diskussion:Wzut|Wiki]])}}

Das Modul '''SIP''' ermöglicht die Entgegennahme (DTMF-Töne interpretieren, kontrollierte Annahme) sowie die Durchführung (Audiofile abspielen, DTMF-Töne senden, Textansage) von Anrufen.

== Voraussetzungen ==
=== FHEM-Server ===
Für den Remote-Zugang muss das Modul Net::SIP installiert sein; auf einem Raspberry Pi oder unter Ubuntu z. B. mit dem Befehl
:<code>sudo cpan install Net::SIP</code>

oder auch

:<code>sudo apt-get install libnet-sip-perl</code>

Falls cpan nicht funktioniert, hilft vielleicht dieser Forumseintrag https://forum.fhem.de/index.php/topic,40219.msg421446.html#msg421446

'''Falls Ihr Text2Speech verwenden wollt'''

Vorbereitung
* SoX installieren
:<code>sudo apt-get install sox </code>
* mp3 Unterstützung für SoX installieren
:<code>sudo apt-get install libsox-fmt-mp3</code>
* Text2Speech als Server Device anlegen
:<code>define <name z.B myT2S> text2speech none</code>
* beim SIP Device dieses Server Device im Attribut T2S_Device eintragen

=== SIP-Server ===
Der SIP-Client muss sich an einem SIP-Server anmelden (Fritzbox, Asterisk, VoIP-Provider).
Auf dem SIP-Server, mit dem sich der Client verbinden soll, muss ein User-Account vorhanden sein bzw. angelegt werden.
In der Fritzbox muss z.B. ein neues Telefoniegerät vom Typ LAN/WLAN angelegt und ein Passwort (mind. 8 Stellen und Stufe 'gut') vergeben werden. Das erzeugt ein neues internes Device im internen Rufnummernbereich **62x, typischerweise die 620. Es sollte kontrolliert werden, ob bei den Anmeldeinformationen der Benutzername der Nebenstelle entspricht (z.B. 620) und ein Passwort eingetragen ist.

=== Hardware ===
Die verwendete Library Net::SIP fordert mehr Ressourcen als RaspberryPi, BananaPi & Co hergeben. Bitte testet, ob Eure Hardware Audofiles sauber abspielen sowie sicher DTMF-Töne empfangen kann und für Euren Einsatzzweck geeignet ist. Erste Tests mit einem Raspi3 lagen im akzeptablen Bereich.

== Installation ==
=== Erste Schritte ===
Spätestens nach einem 'update all' sollte das Modul '''96_SIP.pm''' verfügbar sein.

Nun ist der SIP-Client als Device in FHEM anzulegen:

:<code>define <name> SIP</code>

Anschließend sollten alle sip_Attribute geprüft und für die eigene Umgebung gesetzt werden. Ebenso ist das Passwort mittels set-Command zu speichern.

Siehe auch {{Link2CmdRef|Lang=de|Anker=SIP}}

=== Mögliche Fehlermeldungen ===
Sollte schon bei <code>define mySIP SIP</code> die Fehlermeldung kommen, dass dieses Modul nicht existiert, dann bitte 'update all' durchführen.

== Anwendung ==
=== Attribute ===

''Basics & Allgemeines''
* '''sip_from'''
: Meine SIP-Client-Info. Das Format ist <nowiki>sip:Benutzername@fritz.box</nowiki>, z.B. meinuser@fritz.box. "meinuser" ist der Benutzername, der bei der Einrichtung des neuen Benutzers in der Fritzbox angegeben wurde. Für Fritzboxen mit fritz!OS älter als 6.8 ist das Format abweichend noch <nowiki>sip:620@fritz.box</nowiki>. Dies ist der Default bei Anlage des SIP-Devices.
* '''sip_ip'''
: Die IP-Addresse meines FHEM-Servers.
* '''sip_port'''
: Port der für den SIP-Client genutzt wird. Default ist 5060 und wird automatisch um 10 erhöht wenn der Port nicht frei ist.
* '''sip_registrar'''
: Hostname oder IP-Addresse des SIP-Servers mit dem sich der Client verbindet. Default ist fritz.box.
* '''sip_user'''
: User Name des SIP-Clients. Default ist 620. Ab 6.8 ist der Benutzername aus sip_from anzugeben, z.B. meinuser.
: Anmerkung: Passwort wird über "set <device> password ''mypassword''" gesetzt.
* '''sip_listen'''
: Das Attribut bietet folgende Optionen
: - '''none''': keine Aktion ('listen' kann auch nicht manuell gestartet werden)
: - '''dtmf''': Beim FHEM-Start geht das Device automatisch in den Status listen und wartet auf DTMF-Anrufer (listen_dtmf). Alternativ kann der Prozess manuell via 'listen' gestartet werden.
: - '''wfp''': Beim FHEM-Start geht das Device automatisch in den Status listen wait-fetch-play (listen_wfp). Alternativ kann der Prozess manuell via 'listen' gestartet werden.
: - '''echo''': Spielt dem Anrufer nur sein eigenes Echo wider. Sonst nix (siehe auch Anwendungsfälle).
* '''sip_waittime'''
: Maximale Wartezeit bei listen_wfp bis das Gespräch automatisch angenommen wird.
* '''sip_ringtime'''
: listen: legt fest wie lange das Modul warten soll bis es den Anruf annimmt. Defaultwert ist 2, das entspricht ca. 1x klingeln.
* '''sip_force_interval'''
: Pause in Sekunden für nicht erfolgreiche "force"-Anrufe, bis der nächste Versuch gestartet wird.

* '''sip_filter'''
: ist eine Komma getrennte Liste von Rufnummern oder Rufnummernteilen die festlegen, ob der Client bei listen überhaupt abheben soll.
: Bsp.: attr mySIP sip_filter **61,123
: **61 = alle DECT Telefone der Fritzbox (610 -619 )
: 123 = alle Rufnummern in denen die Folge 123 enthalten ist.
: Wenn das Attribut sip_filter gelöscht ist werden alle Anrufe angenommen. Das Atrribut entspricht einer Whitelist der Rufnummern die akzepziert/angenommen werden. Anrufe von nicht gelisteten Rufnummern werden einfach ignoriert.

* Anmerkung zum '''Audioformat'''
: Für Net::SIP müssen die Audiofiles im alaw- oder ulaw-Format vorliegen und können mit folgendem Command erzeugt werden
: '''sox <file>.wav -t raw -r 8000 -c 1 -e a-law <file>.alaw'''
: da nur diese raw audio Formate unterstützt werden.
: Vom SIP-Modul unterstützte/erkannte Endungen sind .mp3, .alaw und .ulaw. mp3-Files werden automatisch in alaw umgewandelt (das setzt aber einen entsprechenden Konverter wie sox oder ffmpeg voraus). Bitte darauf achten, dass das audiofile und der komplette Pfad die passenden Permissions hat, damit der FHEM User das File auch lesen darf.

''DTMF empfangen''
* '''sip_dtmf_loop'''
: legt für den listen_dtmf-Modus fest wie oft ein DTMF Code eingeben werden soll ( once oder loop, default ist once ).
: Bei 'once' erwartet der SIP-Cleint die Eingabe eines Codes in der angegebenen Länge und beendet den Anruf.
: Bei 'loop' startet eine Endlosschleife aus Ansage->Code-Erfassung->Quittung->Loop bis der Anrufer irgendwann auflegt.
* '''sip_dtmf_size'''
: Die Anzahl der erwarteten DTMF-Töne im listen_dtmf-Modus (1 bis 4)
* '''sip_audiofile_dtmf'''
: Audiofile das dem Anrufer im listen_dtmf-Modus vorgespielt wird und ihn auffordert einen Code einzugeben. Ist kein File angegeben hört man ein Geräusch.
* '''sip_audiofile_ok'''
: Audiofile das dem Anrufer im listen_dtmf-Modus als Quittungston vorgespielt wird.
* '''sip_blocking'''
: Hier kann so etwas wie eine Blacklist von Rufnummern angegeben werden, die explizit weggedrückt werden. Jede Rufnummer die so behandelt werden soll muss zuerst erfolgreich durch den sip_filter durch und kann danach erst aktiv geblockt werden. Die Syntax ist die gleiche wie bei sip_filter, allerdings gibt es hier den Joker '''.*''' . Ist dieser gesetzt wird jede ankommende Rufnummer geblockt. Damit lassen sich begrenzt Aktionen auslösen (das Event 'ringing_*' wird nach wie vor ausgelöst und die Rufnummer wird als Reading gesetzt) ohne dass Verbindungskosten anfallen.

''Auf anruf warten und annehmen''
* '''sip_audiofile_wfp'''
: Audiofile das nach dem Command '''fetch''' abgespielt wird.
* '''sip_elbc'''
: erlaubte Werte: no | yes. elbc steht für 'End Listen Befor Call'. Bei Option 'yes' wird ein laufender Listen Prozess beendet falls parallel ein Call rausgehen soll. Danach wird der listen wieder neu gestartet.

''Anrufen und DTMF senden''
* '''sip_dtmf_send'''
: Bestimmt die Übertragungsart der angegebenen DTMF-Töne und bietet folgende Möglichkeiten:
: 'audio': Es werden Audiotöne übermittelt
: 'rfc2833': Es erfolgt eine Übertragung nach RFC2833 (für das menschliche Ohr weniger ansprechend)

''Anrufen und etwas senden''
* '''sip_audiofile_call'''
: Audiofile das dem angerufenen bei '''call''' vorgespielt wird.
* '''sip_call_audio_delay'''
: Damit wird festgelegt wie lange bei einem Call mit dem abspielen des Audiofiles gewartet werden soll nachdem man den Anruf angenommen hat. Gültige Werte sind 0 - 3 in 0.25 (1/4) Sekunden Schritten.

''Anrufen und etwas sagen''
* '''T2S_Device'''
: Name Eures in FHEM eingerichteten Text2Speech-Devices
* '''T2S_Timeout'''
: Timeout für die Text2Speech-Konvertierung (könnte ja sein, dass der TTS-Service im Internet überlastet ist)
* '''audio_converter'''
: Der für die Konvertierung zu verwendende (und vorab installierte) Audiokonverter. Auswahl: sox oder ffmpeg

''Ergänzungen ab Version 1.75'' 
alle Attribute die mit sip_audiofile_ beginnen dürfen einen Inhalt der folgenden Form haben: 
a. ein .alw oder .ulaw Filename inklusive Pfad 
b. ein .mp3 File + Pfad -> wird dann automatisch zu .ulaw gewandelt , Audio Konverter & Schreibrechte im Pfad sind Pflicht 
c. ein Text beginnend mit ! der von Text2Speach in eine .mp3 Datei gewandelt wird, diese wird danach behandelt wie unter Punkt b. 

wurde Punkt b. oder c. einmal erfolgreich durchlaufen wird beim nächsten Mal direkt die erzeugte .ulaw Datei verwendet.

Siehe auch {{Link2CmdRef|Lang=de|Anker=SIP}}

=== Set ===

Das Modul kennt derzeit folgende Commands

* set <name> '''password'''
: Passwort für den User sip_user hinterlegen.

* set <name> '''reset'''

: Stoppt laufende listen-Prozess und initalisiert das Device.

* set <name> '''call <nummer> [<maxtime>] [<nachricht>] [*nn] [&][nn]'''
: Startet einen Anruf an die angegebene Nummer.
: Optional kann die maxtime angegeben werden. Wird keine angegeben wird der Defaultwert von 30 verwendet.
: Optional kann eine Nachricht
: - in Form eines '''Audiofiles''' angegeben werden. Das File ist mit dem vollen Pfad oder dem relativen ab dem Verzeichnis mit fhem.pl anzugeben. Bitte darauf achten, dass das audiofile und der Pfad dort hin passende Permissions hat, damit FHEM das File auch lesen darf. Die maxtime ist in dem Fall nicht optional sondern zwingend.
: - als '''DTMF'''-Sequenz angegeben werden. Diese mit einem Prefix '-' versehen werden, also z.B. '''-'''#47.
: - als '''Text''' angegeben werden. Dieser mit einem Prefix '!' versehen werden, also z.B. '''!'''Hier spricht dein FHEM.
: Bitte hierfür unter 'Voraussetzungen' den Hinweis auf TTS beachten.
: Wird ein Wiederholungsfaktor in der Form '''*nn''' angegeben, wird der Anruf ausgeführt, die Nachricht einmal abgespielt und dann nn mal wiederholt.
: Wird als Wiederholungsfaktor ein negativer Wert angegeben (z.B. '''*-2'''), passiert folgendes: Die Nachricht wird zwar genau wie bei *2 dreimal abgespielt, allerdings erlaubt das - vor der 2 das die Nachricht nur einmal vollständig übertragen werden muß. Der call_state nach dem Call hätte dann z.B. den Wert "ok peer hangup".
: Wird der Call mit '''&''' (force) beendet signalisiert dies, dass er wichtig ist und unbedingt zugestellt werden muss. Der SIP-Client versucht es dann so lange, bis der Anrufer erreicht wird. WICHTIG: wählt die maxtime groß genug damit das Audiofile auch wirklich komplett abgespielt werden kann, bzw. hört's euch auch bis zum Ende an! Wenn ein priorisierter Anruf vorzeitig endet (quasi NOK) wird er nach 1 Minute wiederholt, und zwar so lange bis er erfolgreich war. Wollt Ihr den Ablauf stoppen bitte das von der Wiederholungsschleife gesetzte '''at''' löschen, es befindet sich im gleichen Raum wie euer SIP Device. Dabei gibt es folgende Möglichkeiten:
: set call **611 30 !Das ist ein Test & <-- wird im Fehlerfall nach 60 Sekunden wiederholt oder nach sip_force_interval wenn vorhanden.
: set call **611 30 !Das ist ein Test &300 <-- wiederholt im Fehlerfall nach 5 Minuten egal welchen Wert sip_force_interval hat.
: Werden mehrere Set Call unmittelbar hintereinander abgesetzt, werden diese intern gestackt und nacheinander abgearbeitet.

* set <name> '''listen'''
: Manueller Start des listen-Prozesses. Setzt voraus, dass die Variable sip_listen auf dtmf oder wfp gesetzt ist:
: '''dtmf''': Der SIP-Client wird in einen Status versetzt in dem er automatisch Anrufe annimmt. Bei einem Anruf wird im Reading 'caller' die Nummer bzw. Id des Anrufers angezeigt. Dem Anrufer wird der eigene Ton als Echo zurückgespielt. Über die Eingabe von '''#''' gefolgt von 2 Zahlen und anschließendem Auflegen kann eine Zahl an das Reading '''dtmf''' übergeben werden. Voraussetzung: Das anrufende Telefon ist auf Tonwahl gestellt (DTMF).
: '''wfp''': Der SIP-Client wird in einen Status versetzt in dem er auf Anrufe wartet (wfp steht für wait-fetch-play). Erfolgt ein Anruf an den Client, wechselt das Reading 'caller_state' zu 'ringing_*', im Reading 'caller' wird die Nummer bzw. Id des Anrufers angezeigt. Nun kann das Gespräch via set-Command 'fetch' angenommen oder der Anruf via 'reject' explizit abgelehnt werden. Das als sip_audiofile angegebene File wird abgespielt. Anschließend wechselt der Status wieder zu listen_wfp.

* set <name> '''fetch'''
: Anruf im listen_wfp-Modus annehmen.

* set <name> '''reject'''
: Anruf im listen_wfp-Modus ablehnen.

=== Readings ===

* '''call''': Die Rufnummer des ausgehenden Anrufs.
* '''call_state''': Status für ausgehende Anrufe.
* '''call_time''': Dauer des durchgeführten Anrufs in Sekunden
* '''call_success''': mögliche Werte 0 oder 1
: 0 = call_state ist ungleich ok , 1 = call_state ist gleich ok
: Auf Call mit Repeat übertragen bedeutet das:
: eine 0 wenn die Wiederholungszahl positiv ist und die tatsächliche Anzahl nicht erreicht wurde, aber
: eine 1 bei call_state "ok peer hangup"
* '''caller''': Die Rufnummer bzw. Info des aktuellen Anrufers.
* '''caller_state''': Status für eingehende Anrufe.
* '''caller_time''': Dauer des angenommenen Anrufs in Sekunden
* '''dtmf''': Die via Tonwahl (DTMF) eingegebenen Zahlen.
* '''state''': Der Status des Devices.

== Anwendungsbeispiele ==

=== Anruf tätigen und Sound abspielen ===
* Den Anruf initiieren
<code>set <device> call <nummer> [<dauer>] [<audiofile oder Textnachricht>]</code>
<code>set mySip call 081547111 30 ./tada.alaw</code>
<code>set mySip call 081547111 30 !Hier ist dein FHEM Server</code>
* Die Default-Dauer beträgt 30 Sekunden.
* Wird kein Audiofile angegeben, wird nur die Verbindung hergestellt und nach der Anrufdauer wieder unterbrochen.
* Anmerkung: Das Audiofile muss das Format PCM/8000 haben.
* Der Angerufene nimmt das Gespräch entgegen, das Audiofile wird abgespielt.

=== Anruf tätigen und DTMF-Töne senden ===
* Den Anruf initiieren
: <code>set <device> call <nummer> <dauer> <-tastenkombination></code>
* Die Tastenkombination muss mit einem vorangestellten Minus (-) nach der Zielnummer folgen, also z.B. **1 -#23
* Der Angerufene nimmt das Gespräch entgegen, die Tonfolge wird abgespielt.

=== Auf Anruf warten und DTMF-Töne empfangen ===
* Der SIP-Client wird in den Listen-Modus versetzt.
: Das Attribut sip_listen auf '''dtmf''' setzen und
: <code>set <device> listen</code>
* Die Nebenstelle des SIP-Clients wird von einem DTMF-fähigen Telefon aus angerufen.
* Wenn der SIP-Client das Gespräch angenommen hat, betätigt man '''#''', gefolgt von zwei Ziffern und legt dann wieder auf. Wichtig: Es müssen immer genau 3 Tasten betätigt werden (# und nm), damit das Reading dtmf gefüllt wird. n und m müssen zwei verschiedene Zahlen sein (0-9) oder ein Stern.
* Im Reading '''dtmf''' ist diese zweistellige Zahl zu sehen und kann ggf. mit einem notify ausgewertet werden.

=== Auf Anruf warten und kontrolliert annehmen ===
* Der SIP-Client wird in den Listen-Modus versetzt.
: Das Attribut sip_listen auf '''wfp''' setzen und
: <code>set <device> listen</code>
* Die Nebenstelle des SIP-Clients wird angerufen.
* Im Reading '''caller''' ist die Nummer bzw. die Info des Callers zu sehen, im '''caller_state''' erscheint 'ringing'.
* Soll der Anruf angenommen werden setze ich den Status des Devices mittels set auf '''fetch''':
: <code>set <device> fetch</code>
* Der SIP-Client nimmt den Anruf an und spielt das im Attribut sip_audiofile angegebene File ab.
* Der SIP-Client legt auf und geht wieder in den Status '''listen_wfp'''.

=== Auf Anruf warten und Aktion auslösen ===
* Der SIP-Client wird in den Listen-Modus versetzt.
: Das Attribut sip_listen auf '''wfp''' setzen und
: <code>set <device> listen</code>
* Die Nebenstelle des SIP-Clients wird angerufen.
* Im Reading '''caller''' ist die Nummer bzw. die Info des Callers zu sehen, im '''caller_state''' erscheint 'ringing'.
* FHEM kann auf Grund dieser Events eine Aktion durchführen.
* Der Anruf wird dann von FHEM abgebrochen. Dafür wird der Befehl '''reject''' genutzt:
: <code>set <device> reject</code>
* Der Anrufer weiß auf Grund der Ablehnung, dass FHEM aktiv war.
* Der SIP-Client legt auf und geht wieder in den Status '''listen_wfp'''.

=== Fritzbox + Doorline - Telefonklingeln beenden ===
Szenario: Als Türklingel ist eine Doorline im Einsatz die auf Direktannahme eingestellt ist. Klingelt jemand an der Tür, erfolgt ein 'Anruf' an die in der Rufgruppe definierten Telefone. Man kann den Anruf entgegennehmen, um zu hören wer an der Tür ist, bevor man die Tür öffnet. Geht man direkt zur Tür, klingeln die Telefone insgesamt 30 Sekunden lang bis sie verstummen. Hat man die Haustür mit einem Türkontakt versehen, hilft folgender Ansatz:
* Der SIP-Client wird in der Fritzbox in die Rufgruppe der Türklingel aufgenommen.
* Das Attribut 'sip_listen' wird auf 'wfp' gesetzt.
* Der SIP-Client wird in den Listen-Modus 'wait-fetch-play' versetzt (Die sip_waittime sollte größer als die Klingeldauer der Doorline sein).
: <code>set <device> listen</code>
* Klingelt jemand an der Tür, wird unter anderem die Nebenstelle des SIP-Clients angerufen.
* Über ein DOIF greift man die Kombination SIP-Client caller_state 'ringing' und Haustürkontakt closed->open ab und
* setzt den Status des Devices mittels set auf fetch:
: <code>set <device> fetch</code>
* Der SIP-Client nimmt den Anruf an und spielt das im Attribut sip_audiofile angegebene File ab.
* Die Telefone verstummen.

In FHEM sieht das dann z.B. so aus:

Es gibt ein Device '''HaustuerStatus''' das den Status des Türkontaktes abbildet: "closed" oder "open".

Es wird ein Dummy-Device '''HaustuerStatusVar''' für die Status des Automaten angelegt:

<code>define HaustuerStatusVar dummy</code>

Und ein DOIF '''TuerklingelAus''':

<pre>
define TuerklingelAus DOIF
(([HaustuerStatus:state] eq "closed") and ([FhemSipClient:caller_state] =~ "ringing") and ([FhemSipClient:caller] eq "Klingel sip:**12\@fritz.box"))
(set HaustuerStatusVar ringing;; set HM_4A4047_Mp3 playTone 001 1 10)
DOELSEIF
(([HaustuerStatus:state] eq "open") and ([HaustuerStatusVar:state] =~ "ringing"))
(set FhemSipClient fetch;; set HaustuerStatusVar on)
DOELSEIF
(([HaustuerStatus:state] eq "closed") and ([HaustuerStatusVar:state] ne "off"))
(set HaustuerStatusVar off)
</pre>

Der Caller "Klingel sip:**12\@fritz.box" setzt sich aus dem in der Fritzbox vergebenen Namen, der Nebenstelle (**12 ist eine Doorline mit einem Taster, bei zweien gilt es **11 und **12 zu beachten) sowie dem syntaktischen Drumherum sip:''nebenstelle''\@fritz.box zusammen. Achtet bitte auf den "\" vor dem "@", damit regex nicht mosert.

HM_4A4047_Mp3 ist übrigens mein mobiler MP3-Tür-/Funkgong der zur Unterstützung einen Gong abspielt.

=== Nervende Werbeanrufe ===
Ihr kennt das sicher: Unbekannte Rufnummer, man nimmt das Gespräch an und hat entweder irgendwas gewonnen, einen Werber oder ein "Umfrage" dran. Unterm Strich - man will Dir was verkaufen.

Phase 1: Fritzbox, Rufbehandlung, neue Rufnummernsperre, Nummer eintragen.

Phase 2: Derselbe Werber taucht unter einem ganzen Kontingent von Rufnummern auf. Blocken alleine reicht dir nicht mehr, du willst Rache.

Phase 3:
: Du definierst in FHEM den SIP-Client und startest ihn im listen-Modus '''echo'''.
: In der Fritzbox leitest du alle eingehenden Anrufe auch an den SIP-Client weiter.
: Dem SIP-Client gibst du über sip_filter die Werber-Rufnummer als Filterarguiment mit.
: Der SIP-Cleint ist schneller als die Familienmitglieder und nimmt den Anruf an.

Phase 4: Jetzt bin ich (der Autor dieses Anwendungsfalles) neugierig. Postet Eure Erfahrung mit diesem Modus gerne im Forums-Thread.

=== FHEM Statusberichte ===

Man sagt zwar "wer lesen kann ist eindeutig im Vorteil", dennoch gibt es Situationen in denen eine Sprachausgabe praktischer ist. Ein Beispiel findet Ihr im Forum unter [https://forum.fhem.de/index.php/topic,67443.msg742371.html#msg742371]. Das zugehörige Textbeispiel (als Appetithappen):

"Guten Abend Papa, hier ist Dein Speicherknecht mit dem Bericht von 18 Uhr37. Die Alarmanlage ist aus. Im Garten war jemand um 17 Uhr 45 und an der Haustür um 18 Uhr 16. Im Küche und OG1 ist das Licht an. Mama und Papa sind seit 18 Uhr 29 zu Hause. Die Heizung steht auf Normal Betrieb. Die Vorlaftemperatur beträgt 51 Grad. Der Gasverbrauch beträgt 8 Kubik bei einer Laufzeit von 182 Minuten. Das Wetter ist Schauer. Die Temperatur Aussen beträgt 8 Grad Celsius. Dabei war das Minimum 3 und das Maximum 8 und im Haus ist es 19 Grad warm. Papa, ich wünsche Dir noch einen geruhsamen Abend!"

== Bekannte Probleme / Fehlersuche ==
=== Fehler bei der Registrierung an der Fritzbox ===
'''Fritzbox'''
* Ist das Device für den SIP-Client in der Fritzbox unter Telefonie > Telefoniegräte gelistet?
* Geräteeinstellungen ändern: Ist für das Device unter 'Anmeldedaten' die Durchwahl als Benutzername angegeben?
* Ist der in dieser Ansicht angegebene 'Registrar' mit der im Attribut sip_registrar identisch? Im Zweifelsfalle die IP-Adresse statt 'fritz.box' verwenden.
* FitzOS ab 6.80: Wurde nach Definition des Gerätes an einem anderen bekannten Gerät der Bestätigungscode eingegeben?
* Wurde in der Fritzbox ein Passwort von mind. 8 Stellen und Sicherheitsstufe 'gut' vergeben? Andernfalls kann es zu einem Registrierungsfehler 404 kommen.
* FritzOS 6.90: Registrierungsfehler 404 konnte erst mit folgenden Angaben gelöst werden
sip_from = sip:mymyuser@fritz.box (wobei dies der mymyuser ist der beim Telefoniegrät als Benutzername angegeben wurde,
bitte die von der FritzBox geforderte Mindestlänge beachten)
sip_user = myuser (statt der Nebenstellennummer)

'''FHEM'''

Wurde das Passwort mittels set <mydevice> password <meinpasswort> gesetzt?

Attribute des Devices prüfen:
* Ist unter sip_from <nowiki>'sip:620@fritz.box'</nowiki> die von der Fritzbox vergebene Durchwahl angegeben? Ab Fritz!OS 6.8 gilt: Ist das Format <nowiki>sip:Benutzername@fritz.box</nowiki> eingehalten?
* Ist unter sip_user die von der Fritzbox vergebene Durchwahl angegeben?
* Ist unter sip_registrar die IP-Adresse der Fritzbox eingetragen ('fritz.box' wird manchmal nicht korrekt aufgelöst)?
* Ist unter sip_ip die IP-Adresse des FHEM-Servers eingetragen (z.B. 192.168.178.47 angeben, keine Adresse aus dem 127er-Segment)?
* Probleme mit dem Standard-Port 5060? Auf 5070 erhöhen.

=== Erzeugung eines passenden Audiofiles ===

Eine Alternative zu sox ist ffmpeg. Damit kann direkt von mp3 ins Zielformat konvertiert werden:

ffmpeg -i meinfile.mp3 -f alaw -ar 8000 meinfile.alaw

=== Keine korrekte DTMF-Erkennung auf einem Pi ===

Raspi, Raspi2 und BanaPi sind nicht leistungsstark genug für die Erkennung von DTMF-Tönen. Ab Raspi3 scheint's zu funktionieren.

Wer trotzdem auf einem "kleinen" Pi die DTMF-Erkennung gemäß RFC2833 nutzen möchte, kann in der DTMF.pm die Zeile 75

<code>###$sub{$type} = _dtmf_xtc_audio(%pargs);</code>

für die Audio-Erkennung auskommentieren. Zu finden ist DTMF.pm z.B. unter /usr/lib/perl5/site_perl/5.18.2/Net/SIP. Konsequenz: Moderne, RFC2833-unterstützende Geräte können genutzt werden, ältere Telefone mit Tonwahl nicht.

=== Docker ===

Achtet darauf, dass alle relevanten Ports sowie die für SIP wichtigen 5060 und ggf. 5070 außerhalb des Containers sichtbar sind:

<code>docker run -d -p 7072:7072 -p 8083:8083 -p 5060:5060 -p 5070:5070 fhem/fhem</code>

Bei der Definition des SIP-Devices wird automatisch die IP-Adresse des Containers als sip_ip eingetragen, z.B. die 172.17.0.2. Es ist wichtig, dass hier die interne Adresse des Containers eingetragen wird, da sonst der Bind beim Listen fehlschlägt.

== Links ==
* {{Link2Forum|Topic=40219|LinkText=Forenthread}} alter Forum-Thread zu FB_SIP.pm und SIP.pm
* {{Link2Forum|Topic=67443|LinkText=Forenthread}} Forum-Thread zu diesem Modul SIP
* [https://de.wikipedia.org/wiki/SIP-Status-Codes SIP-Status Codes]

[[Kategorie:Hilfsmodul]]


[[Kategorie:Akustische Ausgabe]]

DOIF/Einsteigerleitfaden, Grundfunktionen und Erläuterungen

2019-03-02T23:51:12Z

Plaicy: /* Erste Schritte mit DOIF: Zeit- und Ereignissteuerung */ typo

[[DOIF]], für FHEM-Einsteiger konzipiert, wurde über Benutzeranforderungen zu einem immer vielfältigeren Werkzeug weiter entwickelt. Damit orientiert sich die Weiterentwicklung des [[DOIF]] an praktischen Aufgabenstellungen. Im Ergebnis können einfache Probleme, sowie auch spezielle und komplexe Aufgaben in kompakter Weise gelöst werden. Damit nimmt jedoch auch die Zahl der Einstellungsmöglichkeiten über Attribute, Syntaxvarianten und deren Kombinationen zu. Das macht es für Einsteiger und Fortgeschrittene nicht leicht den Überblick zu behalten.

Hier soll der Blick auf die Teile des DOIF beschränkt werden, die für die Einfachheit des DOIF aus seiner Anfangszeit stehen und die ausreichen 80% der Aufgabenstellungen lösen.
{{Randnotiz|RNTyp=g|RNText='''Hinweis!'''

Die {{Link2CmdRef|Lang=de|Anker=DOIF|Label=deutschsprachige FHEM-Befehlsreferenz (Commandref)}} zum DOIF sollte bei Fragen immer das erste Nachschlagewerk sein. Sie ist aktueller, genauer und mit Beispielen versehen. Dieser Artikel ist eine geraffte Darstellung der Grundlagen des DOIF mit einigen Erläuterungen.}}

== Voraussetzung ==

Die FHEM-Begriffe [[Gerät]] ([[Device]]), State (Status), [[Readings]], [[Internals]], [[Attribute]], [[Event]] ([[Ereignis]]), Befehl (Command) und deren Funktion sollen bekannt sein.

== DOIF-Light für Einsteiger ==

Die meisten Verknüpfungsaufgaben können mit einem Verständnis der folgenden Abschnitte der {{Link2CmdRef|Lang=de|Anker=DOIF|Label=Hilfe zum DOIF (deutschsprachige Befehlsreferenz)}} gelöst werden.

* {{Link2CmdRef|Lang=de|Anker=DOIF|Label=Einleitung}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_Features|Label=Features}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_Lesbarkeit_der_Definitionen|Label=Lesbarkeit der Definitionen}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_Ereignissteuerung_ueber_Auswertung_von_Events|Label=Ereignissteuerung}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_Zeitsteuerung|Label=Zeitsteuerung}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_Wochentagsteuerung|Label=Wochentagsteuerung}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_Zeitsteuerung_mit_Zeitintervallen|Label=Zeitsteuerung mit Zeitintervallen}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_Indirekten_Zeitangaben|Label=Indirekte Zeitangaben}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_Nutzung_von_Readings_Stati_oder_Internals_im_Ausfuehrungsteil|Label=Angaben im Ausführungsteil}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_do_always|Label=do always}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_wait|Label=wait}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_do_resetwait|Label=do resetwait}}
* {{Link2CmdRef|Lang=de|Anker=DOIF_setList__readingList|Label=readingList, setList}} Frontendgestaltung
* {{Link2CmdRef|Lang=de|Anker=DOIF_Zu_beachten|Label=zu beachten}} zusätzliche Hinweise und Tipps
* {{Link2CmdRef|Lang=de|Anker=DOIF_Kurzreferenz|Label=Kurzreferenz}} als Überblick

== Struktur und Verhalten des DOIF ==

Der Aufbau des DOIF entspricht einer Baumstruktur mit Bedingungszweigen. {{Randnotiz|RNTyp=y|RNText='''Achtung!''' Der Begriff '''Ereignis''' wird in diesem Artikel erweitert verwendet und umfasst ablaufende Timer und [[Event|Ereignisse]]([[Event|Events]]). }}

[[Image:DOIF_Aufbau_Ablauf_nSVG.png|top|alt="DOIF_Aufbau_Ablauf"]]

=== Verhaltensweise ohne steuernde Attribute ===

==== Angaben im Bedingungsteil ====
Der Bedingungsteil besteht aus einer Perl-Ebene und einer Präprozessorebene.

{{Hinweis|'''('''''Perl-Ebene'' '''['''''DOIF-Präprozessor''''']''' ''Perl-Ebene'' '''['''''DOIF-Präprozessor''''']''' ...''')'''}}

Die erste Ebene der ersten runden Klammer nach den Schlüsselwörtern '''DOIF''' oder '''DOELSEIF''' umschliesst eine Bedingung.

Für Angaben in dieser Klammer (Perl-Ebene) gilt die Perl-Syntax (Operatoren, Operanden, wie Funktionen, Variablen), ausgenommen sind die Angaben in der ersten Ebene der eckigen Klammern, sie umschliessen die Ebene des DOIF-Präprozessors, dort gilt die Syntax des DOIF-Präprozessors.

In dieser Ebene der eckigen Klammern werden '''DOIF-Operanden''' angegeben. Die '''DOIF-Operanden''' beinhalten '''Auslöser'''.

'''Auslöser''' sind Zeitpunkte, Gerätenamen(bei checkReadingEvent 0, voreingestellt bis Version 16651 2018-04-23 06:28:53Z Damian) oder die Kombination von Gerätename:Reading(bei checkReadingEvent 1, voreingestellt nach Version 16651 2018-04-23 06:28:53Z Damian) und Reguläre Ausdrücke, die auf Gerätenamen oder das '''Ereignis''' passen.

'''Ereignisse''' sind für DOIF ablaufende Timer oder [[Event|Ereignisse]] ([[Event|Events]]) die durch [[Gerät|Geräte]] initiiert werden.

Der '''DOIF-Prozess''' wird gestartet wenn ein '''Ereignis''' eintrifft.

Passt ein '''Auslöser''' einer Bedingung zu dem '''Ereignis''' wird diese Bedingung geprüft.

Ist die Bedingung '''wahr''', werden die nach der Bedingung stehenden Befehle ausgeführt.

Nach der Befehlsausführung wird der '''Status''' des '''DOIF''' auf die Befehlsnummer gesetzt ('''cmd_x''') und DOIF wartet auf das nächste '''Ereignis'''.

Ist die Bedingung '''unwahr''' ('''falsch''') wird der nächste Zweig bearbeitet.

Ist '''DOELSE''' angegeben, es gab einen passenden '''Auslöser''' und alle geprüften Bedingungen waren '''unwahr''', dann werden die nach '''DOELSE''' angegebenen '''Befehle''' ausgeführt.

Die '''Befehle''' eines Zweiges werden ohne vorherigen '''Statuswechsel''' nur einmal ausgeführt.

Ein '''Statuswechsel''' findet statt nachdem ein anderer Bedingungszweig '''wahr''' wurde und die zugehörigen '''Befehle''' ausgeführt worden sind.

Ein DOIF mit nur einem Zweig enthält ein internes '''DOELSE''', d.h. bei '''unwahrer''' Bedingung und vorhandenem '''Auslöser''', findet ein '''Statuswechsel''' auf '''cmd_2''' statt.

==== Auslöser ====

Auslöser können durch direkte Angabe des Gerätenamen, [[Readings]], [[Internals]] usw. angegeben werden.

===== Readings und Internals =====

'''['''<''Gerätename''>''']''' oder '''['''<''Gerätename''>''':&STATE]''' bezieht sich auf das Internal '''STATE''' des Gerätes.

{{Link2CmdRef|Lang=de|Anker=DOIF_Ereignissteuerung}}

'''['''<''Gerätename''>''':'''<''Readingname''>''']''' bezieht sich auf das '''Reading''' des Gerätes.

{{Link2CmdRef|Lang=de|Anker=DOIF_Ereignissteuerung}}

'''['''<''Gerätename''>''':'''<''Readingname''>''':d]''' bezieht sich auf den '''ersten numerischen Teil''' des '''Reading-Wertes'''.

{{Link2CmdRef|Lang=de|Anker=DOIF_Filtern_nach_Zahlen}}

'''['''<''Gerätename''>''':'''<''Readingname''>''':d<Anzahl der gerundeten Stellen nach dem Dezimaltrenner>]''' bezieht sich auf den '''ersten numerischen Teil''' des '''Reading-Wertes''', der auf '''Anzahl''' Stellen gerundet ist.

{{Link2CmdRef|Lang=de|Anker=DOIF_Filtern_nach_Zahlen}}

'''['''<''Gerätename''>''':'''<''Readingname''>''':sec]''' bezieht sich auf das '''Alter des Zeitstempels''' in Sekunden.

{{Link2CmdRef|Lang=de|Anker=DOIF_Zeitspanne_eines_Readings_seit_der_letzten_Aenderung}}

'''['''<''Gerätename''>''':&'''<''Internalname''>''']''' bezieht sich auf das '''Internal''' des Gerätes.

{{Link2CmdRef|Lang=de|Anker=DOIF_Ereignissteuerung}}

'''['''<''Auslöserangabe''>''','''<''Vorgabewert''>''']''' nicht existierende '''Auslöser''' können mit einem '''Vorgabewert''' angegeben werden.

{{Link2CmdRef|Lang=de|Anker=DOIF_notexist}}

===== Zeitangaben =====

'''['''<''Zeitpunkt''>''']''' gibt einen Zeitpunkt an

{{Link2CmdRef|Lang=de|Anker=DOIF_Zeitsteuerung}}

'''['''<''Zeitpunkt Beginn''>'''-'''<''Zeitpunkt Ende''>'''|'''<''Wochentagangaben''>''']''' gibt eine Zeitspanne an, optionale Wochentagangabe

{{Link2CmdRef|Lang=de|Anker=DOIF_Zeitsteuerung_mit_Zeitintervallen}}

'''<nowiki>[[</nowiki>'''<''Auslöserangabe''>''']]''' gibt einen Zeitpunkt indirekt an.

{{Link2CmdRef|Lang=de|Anker=DOIF_Indirekten_Zeitangaben}}

Mit Zeitangaben kann gerechnet werden, Berechnungen erfolgen in runden Klammern.

Liefert eine Perl-Funktion HH:MM:SS muss sie in geschweifte Klammern eingeschlossen werden.

'''[{sunrise}]''' z.B. Angabe eines Zeitpunktes durch die Perl-Funktion '''sunrise'''.

{{Link2CmdRef|Lang=de|Anker=DOIF_Zeitsteuerung_mit_Zeitberechnung}}

==== Auslöser (erweitert) ====

'''Auslöser''' können auch allgemein formuliert werden, dazu ist die Fertigkeit erforderlich [[regulärer Ausdruck|'''Reguläre Ausdrücke''']] (Regex) formulieren zu können.

===== Readings und Internals =====

'''['''<''Auslöserangabe''>''':'''<''Regex Filter''>''','''<''Ausgabeformatierung''>''']''' '''Auslöser''' können mit einem Filter eränzt werden, die gefilterten Werte können in der Ausgabeformatierung weiterverarbeitet werden.

{{Link2CmdRef|Lang=de|Anker=DOIF_Ereignissteuerung_ueber_Auswertung_von_Events}}

===== Ereignisse =====

'''['''<''Gerätename''>''':"'''<''Regex Ereignisrest''>'''"]'''

{{Link2CmdRef|Lang=de|Anker=DOIF_Ereignissteuerung_ueber_Auswertung_von_Events}}

'''["'''<''Regex Gerätename''>''':'''<''Regex Ereignisrest''>'''"]'''

{{Link2CmdRef|Lang=de|Anker=DOIF_Ereignissteuerung_ueber_Auswertung_von_Events}}

'''["'''<''Regex Ereignis''>'''",'''<''Vorgabewert''>''']'''

{{Link2CmdRef|Lang=de|Anker=DOIF_Ereignissteuerung_ueber_Auswertung_von_Events}}

'''["'''<''Regex Ereignis''>'''":'''<''Regex Filter''>''','''<''Ausgabeformatierung''>''','''<''Vorgabewert''>''']''' optional: Filter und Formatierung, verpflichtend: Vorgabe

{{Link2CmdRef|Lang=de|Anker=DOIF_Ereignissteuerung_ueber_Auswertung_von_Events}} und {{Link2CmdRef|Lang=de|Anker=DOIF_Filtern_nach_Zahlen}}

===== Ereignisse mit Aggregation (Sammlung) von Werten =====

'''['''<''Funktion''>''':'''<''Format''>''':"'''<''Regex Gerätename''>''':'''<''Regex Ereignisrest''>'''":'''<''Reading''>''':'''<''Bedingung''>''','''<''Vorgabewert''>''']''' optional: Format, Reading, Bedingung und Vorgabewert

{{Link2CmdRef|Lang=de|Anker=DOIF_aggregation}}

===== Ereignisse mit vordefinierten Filtern (Durchschnitt, Median, Differenz, anteiliger Anstieg) =====

'''['''<''Gerätename''>''':'''<''Reading''>''':'''<''Filtername''><''Pufferlänge''>''']'''

{{Link2CmdRef|Lang=de|Anker=DOIF_Reading_Funktionen}}

==== Alle Auslöser ====

'''[?'''<''Auslöserangabe''>''']''' Auslöser, die mit Fragezeichen beginnen lösen nicht aus, sie werden nur abgefragt

{{Link2CmdRef|Lang=de|Anker=DOIF_Zeitintervalle_Readings_und_Status_ohne_Trigger}}

==== Angaben im Befehlsteil ====

'''Befehle''' stehen nach einer '''Bedingung''' oder nach '''DOELSE''' in runden Klammern (erste Klammerebene), das ist die FHEM-Ebene. Befehle können direkt angegeben werden.

{{Hinweis|'''('''<''FHEM-Befehle''>''')''', '''("'''<''Systembefehle''>'''")''' oder '''{'''<''Perl-Befehle''>'''}'''}}

Befehle können zu Sequenzen gruppiert werden durch mehrere runde Klammerpaare der ersten Ebene)

{{Hinweis|'''('''<''Befehle der Sequenz 1''>''')''' '''('''<''Befehle der Sequenz 2''>''')''' ... '''('''<''Befehle der Sequenz n''>''')'''}}

Trennzeichen für Befehle ist das Komma, daher ist keine Verdoppelung der Trennzeichen erforderlich.

{{Hinweis|'''('''<Befehl 1>''',''' <Befehl 2>''',''' ... <Befehl n>''')'''}}

Enthält ein Befehl ein Komma, dass kein Befehlstrennzeichen ist, dann ist der Befehl in zusätzliche runde Klammern einzuschliessen.

{{Hinweis|'''(('''<Befehlsteil 1a>''','''<Befehlsteil 1b>'''),''' <Befehl 2>''',''' ... <Befehl n>''')'''}}

Berechnungen erfolgen in geschweiften Klammern auf der Perl-Ebene und müssen unmittelbar mit einer runden Klammer beginnen.

Der Zugriff auf [[Readings]], [[Internals]] usw. erfolgt wie im DOIF üblich, über Angaben in eckigen Klammern inklusive Ausgabeformatierung und Präprozessorersatznamen, wie '''$SELF''', '''$DEVICE''', '''$EVENT''', '''$EVENTS''' (extended [[set magic]]).

=== Häufige Attribute ===

Attribute verändern das Standardverhalten des DOIF.

==== do always ====

Ohne '''do always''' gilt:Die Befehle eines Bedingungszweiges werden ohne vorherigen Statuswechsel nur einmal ausgeführt.

Das Attribut setzt diese Regel ausser Kraft. Befehle werden wiederholt im bestehenden Status ausgeführt.

Das interne DOELSE entfällt bei DOIF mit einem Zweig.

Wait-Timer werden bei wiederholtem Wahrwerden der Bedingung nicht abgebrochen.

==== wait ====

Das Attribut verzögert die Befehlsausführung, nach wahr werden einer Bedingung.

Laufende Wait-Timer werden bei einem eingeleiteten Statuswechsel des DOIF abgebrochen, daher werden die zu verzögernden Befehle nicht mehr ausgeführt.

==== do resetwait ====

Das Attribut beinhaltet '''do always,''' bricht aber die Wait-Timer bei wiederholtem Wahrwerden der Bedingung ab.

==== readingList, setList, webCmd, widgetOverride ====

Diese Attribute statten DOIF mit Dummy-Eigenschaften aus, so dass DOIF als erweitertes Eingabeelement im Frontend dienen kann.

== Erste Schritte mit DOIF: Zeit- und Ereignissteuerung ==
Die nachfolgenden Beispiele sind aus der Einleitung der Hilfe zum DOIF entnommen. Sie werden hier weiter erläutert.
===Beispiel A): Ereignissteuerung ===
{{Randnotiz|RNText=Hinweis: Verwendung von
* <code>[<Gerätename>:"<Ereignis>"]</code> zur Abfrage eines Ereignisses von einem [[Gerät]]
* '''DOELSE''' das Schlüsselwort leitet einen Befehlszweig ohne explizite Bedingung ein. Dieser Zweig wird ausgeführt, wenn keine geprüfte Bedingung wahr ist.
* '''devStateIcon''' zum direkten Ausführen eines Befehls im [[DOIF]] und zur Anzeige von Icons
}}
Aufgabenstellung:

Eine Fernbedienung soll einen Fernseher einschalten, der über eine Funksteckdose angeschlossen ist.

Das [[Gerät]] '''Fernbedienung''' wird durch den Dummy '''remotecontrol''' dargestellt. In der Realität könnte es die Definition eines Empfängers für eine Infrarot-Fernbedienung sein.

Das [[Gerät]] '''Funksteckdose TV''' wird durch den Dummy '''tv''' dargestellt. In der Realität könnte es die Definition einer Intertechno-Funkstekdose aus dem Baumarkt sein.

Die Signale von '''remotecontrol''' werden über das DOIF '''di_rc_tv''' alias '''Steuerlogik''' in einen Befehl für die Funksteckdose '''tv''' umgesetzt.

Das Signal ist als [[Ereignis]] im [[Event monitor|Eventmonitor]] sichtbar <code>2017-02-28 09:07:03 dummy tv on</code>

Das [[DOIF]] reagiert durch die Angabe von <code>[remotecontrol:"on"]</code> in der Schaltbedingung. Weil '''on''' als Wert in dem Ereignis enthalten ist, wird die Bedingung wahr. Das bewirkt das Ausführen des Befehls <code>set tv on</code>. Danach nimmt das [[DOIF]] den Status '''cmd_1''' an.

Falls '''off''' im Ereignis enthalten ist wird die Bedingung nicht wahr, daher wird der Befehl <code>set tv off</code> des DOELSE-Zweiges des [[DOIF]] ausgeführt und [[DOIF]] nimmt den Status '''cmd_2''' an.

Definition:
<pre>define di_rc_tv DOIF ([remotecontol:"on"]) (set tv on) DOELSE (set tv off)</pre>

Über das [[Attribute|Attribut]] '''devStateIcon''' können die Befehle des [[DOIF]] direkt ausgeführt werden.
<pre>attr di_rc_tv devStateIcon cmd_1:general_an:cmd_2 cmd_2|initialized:general_aus:cmd_1</pre>
Hinweis: In neueren Versionen ggf. '''initialized''' durch '''initialize''' ersetzen.

Das erste Tripel <code>cmd_1:general_an:cmd_2</code> hat die Bedeutung ''aktueller Status''''':'''''Icon-Name''''':'''''Status nach Betätigung des Icons''. Also, wenn der Status '''cmd_2''' ist, dann zeige das Icon '''general_an''' und wenn das Icon betätigt wird, dann führe den Befehl aus, der zu '''cmd_1''' gehört.

Das zweite Tripel hat die gleiche Funktion, jedoch wird in diesem Fall das Icon '''general_aus''' angezeigt, wenn der Status des [[DOIF]] '''cmd_1''' ist oder '''initialized''' .

Die nachstehende, komplette Definition für die Gruppe A) kann über '''[[Import von Code Snippets|Raw definition]]''' in [[FHEM]] importiert werden.
Hinweis: In neueren Versionen ggf. '''initialized''' durch '''initialize''' ersetzen.
<pre>
defmod di_rc_tv DOIF ([remotecontrol:"on"]) (set tv on) DOELSE (set tv off)
attr di_rc_tv alias Steuerlogik
attr di_rc_tv devStateIcon cmd_1:general_an:cmd_2 cmd_2|initialized:general_aus:cmd_1
attr di_rc_tv group A) Fernbedienung (Ereignissteuerung)
attr di_rc_tv icon helper_doif
attr di_rc_tv room Schulungsraum

defmod remotecontrol dummy
attr remotecontrol alias Fernbedienung
attr remotecontrol devStateIcon .*:noIcon
attr remotecontrol group A) Fernbedienung (Ereignissteuerung)
attr remotecontrol icon it_remote
attr remotecontrol room Schulungsraum
attr remotecontrol webCmd on:off

defmod tv dummy
attr tv alias Funksteckdose TV
attr tv devStateIcon on:it_television@red off:it_television@blue
attr tv group A) Fernbedienung (Ereignissteuerung)
attr tv icon it_television
attr tv room Schulungsraum
save
</pre>

=== Beispiel B): Zeitsteuerung ===
{{Randnotiz|RNText=Hinweis: Verwendung von
* <code><nowiki>[<Zeitpunkt>|<Wochentagangabe>]</nowiki></code> zur Angabe eines Zeitpunktes mit Wochentagbeschränkung. Die Zeiten gelten für die angegebenen Wochentage.
* '''DOELSEIF''' das Schlüsselwort leitet einen Bedingungszweig ein und muss eine Bedingung enthalten. Dieser Zweig wird ausgeführt, wenn eine Bedingung geprüft wird und sie wahr ist.
* '''devStateIcon''' zum direkten Ausführen eines Befehls im [[DOIF]] und zur Anzeige von Icons
}}
Aufgabenstellung:

Ein Radio soll werktags und am Wochenende zu unterschiedlichen Zeiten ein- u. ausgeschaltet werden.

Das [[Gerät]] '''Funksteckdose Radio''' wird durch den Dummy '''radio''' dargestellt. In der Realität könnte es die Definition einer Intertechno-Funkstekdose aus dem Baumarkt sein.

Wenn die Uhrzeit mit einem Schaltzeitpunkt übereinstimmt, wird die Zeitpunktangabe wahr. Wird dann auch die gesamte Bedingung wahr, dann wird der zu diesem Bedingungszweig gehörende Befehl ausgeführt. Das [[DOIF]] '''di_clock_radio''' alias '''Zeitschaltuhr''' setzt dann einen Befehl zum Schalten der Funksteckdose '''radio''' ab.

Das Zeitereignis ist im [[Event monitor|Eventmonitor]] nicht sichtbar.

Die Zeitpunkte eines Bedingungszweiges sind '''or'''(oder) verknüpft. Im ersten Bedingungszweig steht die Einschaltbedingung, im Zweiten (DOELSEIF) die Auschaltbedingung.

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

Über das [[Attribute|Attribut]] '''devStateIcon''' können die Befehle des [[DOIF]] über das WEB-Frontend unabhängig von den Schaltzeitpunkten ausgeführt werden.
<pre>attr ddi_clock_radio devStateIcon cmd_1:general_an:cmd_2 cmd_2|initialized:general_aus:cmd_1</pre>
Hinweis: In neueren Versionen ggf. '''initialized''' durch '''initialize''' ersetzen.

Die nachstehende, komplette Definition für die Gruppe B) kann über '''[[Import von Code Snippets|Raw definition]]''' in [[FHEM]] importiert werden.
<pre>
defmod di_clock_radio DOIF ([06:30|8] or [08:30|7]) (set radio on) DOELSEIF ([08:00|8] or [09:30|7]) (set radio off)
attr di_clock_radio alias Zeitschaltuhr
attr di_clock_radio devStateIcon cmd_1:general_an:cmd_2 cmd_2|initialized:general_aus:cmd_1
attr di_clock_radio group B) Zeitschaltuhr (Zeitsteuerung)
attr di_clock_radio icon helper_doif
attr di_clock_radio room Schulungsraum

defmod radio dummy
attr radio alias Funksteckdose Radio
attr radio devStateIcon on:it_radio@red off:it_radio@blue
attr radio group B) Zeitschaltuhr (Zeitsteuerung)
attr radio icon it_radio
attr radio room Schulungsraum
save
</pre>

=== Beispiel C): Kombinierte Ereignis- und Zeitsteuerung ===
{{Randnotiz|RNText=Hinweis: Verwendung von
* <code><nowiki>[<Beginzeitpunkt>-<Endzeitpunkt>]</nowiki></code> zur Angabe einer Zeitspanne.
* <code>[<Gerätename>:<Reading-Name>]</code> zur Abfrage eines Reading-Inhaltes.
* <code> < </code>, eines numerischen Vergleichsoperators und Vergleich mit einer Konstanten (40).
* '''DOELSE''' das Schlüsselwort leitet einen Befehlszweig ohne explizite Bedingung ein. Dieser Zweig wird ausgeführt, wenn keine geprüfte Bedingung wahr ist.
* '''devStateIcon''' zum direkten Ausführen eines Befehls im [[DOIF]] und zur Anzeige von Icons
* '''readingList''', '''setList''' und '''webCmd''' zur Erzeugung eines Eingabeelementes im Frontend
* '''stateFormat''' um einen benutzerdefinierten Status zu erzeugen.
}}
Aufgabenstellung:

Eine Lampe soll in einer Zeispanne eingeschaltet werden, wenn die Helligkeit einen bestimmten Wert unterschreitet.

Das [[Gerät]] '''Lampe''' wird durch den Dummy '''lamp''' dargestellt. In der Realität könnte es die Definition einer funkgesteuerten Lampenfassung sein.

Das [[Gerät]] '''Helligkeitssensor''' wird durch den Dummy '''sensor''' dargestellt. In der Realität könnte es die Definition eines Homematic Funk-Lichtsensor sein oder ein selbstgebauter Helligkeitssensor mit TSL2561-Chip.

Wenn die aktuelle Uhrzeit in der angegebenen Zeitspanne liegt, ist die Zeitspanne wahr. Wenn dann auch die Helligkeit unter 40 sinkt, wird die gesamte Bedingung wahr, weil Zeitspanne und Hellikeitsvergleich '''and'''(und) verknupft sind. Der zu diesem Bedingungszweig gehörende Befehl wird dann ausgeführt. Das [[DOIF]] '''di_lamp''' alias '''Lampenlogik''' setzt dann einen Befehl zum Schalten der Lampe '''lamp''' ab.
Der DOELSE-Zweig wird ausgeführt, wenn die Bedingung im ersten Zweig unwahr wird.

Definition:
<pre>define di_lamp DOIF ([06:00-19:00] and [sensor:brightness] < 40) (set lamp on) DOELSE (set lamp off)</pre>

Über das [[Attribute|Attribut]] '''devStateIcon''' können die Befehle des [[DOIF]] über das WEB-Frontend unabhängig von den Schaltzeitpunkten ausgeführt werden.
<pre>attr di_lamp devStateIcon cmd_1:general_an:cmd_2 cmd_2|initialized:general_aus:cmd_1</pre>
Hinweis: In neueren Versionen ggf. '''initialized''' durch '''initialize''' ersetzen.

Das [[Attribute|Attribut]] '''setList''' zusammen mit '''readingList''' und '''webCmd''' realisiert im [[Gerät]] '''sensor''' für das Reading '''brightness''' einen Schieberegler, mit dem eine Helligkeit zwischen 0 und 100 in in Schritten von 1 simuliert werden kann und der im Frontend angezeigt wird.
<pre>
attr sensor readingList brightness
attr sensor setList brightness:slider,0,1,100
attr sensor webCmd brightness
</pre>

Mit dem [[Attribute|Attribut]] '''stateFormat''' wird im [[Gerät]] '''sensor''' das Reading '''brightness''' in den Status geschrieben. Damit wird der Helligkeitswert auch im Frontend sichtbar.
<pre>
attr sensor stateFormat brightness</pre>

Die nachstehende, komplette Definition für die Gruppe C) kann über '''[[Import von Code Snippets|Raw definition]]''' in [[FHEM]] importiert werden.
Hinweis: In neueren Versionen ggf. '''initialized''' durch '''initialize''' ersetzen.
<pre>
defmod di_lamp DOIF ([06:00-19:00] and [sensor:brightness] < 40) (set lamp on) DOELSE (set lamp off)
attr di_lamp alias Lampenlogik
attr di_lamp devStateIcon cmd_1:general_an:cmd_2 cmd_2|initialized:general_aus:cmd_1
attr di_lamp group C) Kombinierte Ereignis- und Zeitsteuerung
attr di_lamp icon helper_doif
attr di_lamp room Schulungsraum

defmod lamp dummy
attr lamp alias Lampe
attr lamp group C) Kombinierte Ereignis- und Zeitsteuerung
attr lamp icon light_light
attr lamp room Schulungsraum

defmod sensor dummy
attr sensor alias Helligkeitssensor
attr sensor group C) Kombinierte Ereignis- und Zeitsteuerung
attr sensor icon message_light_intensity
attr sensor readingList brightness
attr sensor room Schulungsraum
attr sensor setList brightness:slider,0,1,100
attr sensor stateFormat brightness
attr sensor webCmd brightness
save
</pre>

=== Ansicht der Gruppen A) bis C) im Frontend ===

[[Datei:erste_schritte_DOIF.png|670px]]

==Links==
* [[DOIF]]
* [[DOIF/Tipps zur leichteren Bedienung]] Erstellung, Bearbeitung, Syntaxhervorhebung, Klammerprüfung, Suchen&Ersetzen, Zeilennummerierung, uvm. (nicht nur) von DOIF
* [[Regulärer_Ausdruck]]
* [[Event]] Ereignisse
* [[Readings]]
* [[Internals]]
* [[Attribute]]

* [http://perldoc.perl.org/perlop.html http://perldoc.perl.org/perlop.html] Perloperatoren
* [http://perldoc.perl.org/perlre.html http://perldoc.perl.org/perlre.html] Reguläre Ausdrücke

[[Kategorie:HOWTOS]]

Notify

2016-10-08T11:26:37Z

Plaicy: remove duplicate <code>trigger

{{SEITENTITEL:notify}}
{{Infobox Modul
|ModPurpose=Ausführung von Anweisung(en) als Reaktion auf Ereignisse
|ModType=h
|ModCmdRef=notify
|ModForumArea=Automatisierung
|ModTechName=91_notify.pm
|ModOwner=rudolfkoenig ({{Link2FU|8|Forum}} / [[Benutzer Diskussion:Rudolfkoenig|Wiki]])
}}
__TOC__
{{Todo|generelle Überarbeitung, Fehlerkontrolle, Formatierung}}
{{Randnotiz|RNTyp=[g|Info|RNText= Tipps
* Weitere grundlegende Informationen/Beispiele zu notify enthält [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung mit Fhem] "Um Ihren Perlcode zu testen, verwenden Sie das [http://fhem.de/commandref#trigger trigger-Kommando]. [...] Wenn Sie also z.B. ein <code>define Testcode notify Schalter1:on {Perlcode}</code> testen möchten, können Sie Ihren Code mit <code>trigger Schalter1 on</code> testen. trigger simuliert das Eintreten eines Ereignisses [...]" (Tipp von S. 38 der Version 4.0)
 }}
== Notify, das mächtige Tool ==
Die nachfolgenden Beispiele beziehen sich hauptsächlich auf [[EIB / KNX|KNX (EIB)]]. Sie sind aber auf alle anderen Systeme übertragbar.

Was ist notify?
Das Hilfsmodul notify dient dazu, Aktionen abhängig von einem anderen Ereignis/Event (siehe [[Event_monitor|Event monitor]]) auszulösen. Es ist damit möglich, Logikfunktionen im Fhem abzubilden.

Z.B.: das Licht in der Küche wird eingeschaltet ====> draus folgt, dass auch das Radio eingeschaltet wird.

=== Syntax von notify ===

define <name> notify <Suchmuster> <command>

Das [[Regulärer Ausdruck|Suchmuster (auch Regexp = regulärer Ausdruck)]] ist sehr wichtig. Es ist entweder der Name des auslösenden ("triggernden") Gerätes oder die Kombination aus Gerät und auslösendem Ereignis (Event) Gerätename:Event. Die Events kann man dem [[Event_monitor|Event-Monitor]] entnehmen. Wenn da z.B. Rollo1 steht, dann reagiert notify auf Rollo1 on und off und was es sonst noch alles gibt.

Wenn man mehrere Suchmuster möchte, kann man diese in Klammer schreiben (Rollo1|Rollo2|Steckdose5)
als Trenner wird dann Pipe (|) genutzt.

Man kann auch mit Platzhaltern arbeiten.

* Rollo. ==> das notify reagiert auf alles was mit Rollo und '''einem''' weiteren beliebigen Zeichen anfängt. Also auf Rollo1 wie auch auf RolloG, aber nicht auf Rollo_wischundweg
* Rollo.* ==> das notify reagiert auf alles das mit Rollo beginnt.
* .*isch ==>; Reagiere auf alles das mit isch aufhört (Tisch, Fisch)

Suchmuster/Regex kann man im Internet beispielsweise auf [http://regexpal.com/| http://regexpal.com/] testen.

=== Regexp wizard - FHEMWEB-unterstützte Anlage eines notify ===

Die Erstellung eines notify und insbesondere die korrekte Angabe des Suchmusters (Regex) führt gerade bei Einsteigern immer wieder zu Schwierigkeiten. Zur Fehlerminimierung empfiehlt es sich einmal die [[Konfiguration]] nicht direkt zu bearbeiten, sondern die "Befehl-Eingabezeile" und die "Objektdetails" zur Bearbeitung zu nutzen. Zudem enthält Fhem einen Regexp wizard mit dem Regex anhand der in Fhem vorhandenen Devices und deren Events aus einer Auswahlbox selektiert werden können. Voraussetzungen sind:
* Aktivierung des Hilfsmoduls [[eventTypes]] (bei allen Neuinstallationen Standard)
* das gesuchte Ereignis (Event) ist nach Aktivierung des Hilfsmoduls bereits mindestens einmal eingetreten

Schrittweise Darstellung der Nutzung des Regexp wizard zur Anlage eines "notify":

In das [[Konfiguration#Befehl-Eingabefeld|Befehls-Eingabefeld]] eingeben und mit {{Taste|Enter}} bestätigen:
define ntest notify a b
Als Beispiel wird ein notify mit <name> "ntest" angelegt. "a" und "b" sind beliebige Platzhalter für <Suchmuster> und <Command>, die bei der weiteren Bearbeitung mit dem endgültigen Werten ersetzt werden.
Der Regexp wizard öffnet sich:
[[Datei:Regexp wizard1.JPG|400px|thumb|center]]
Nun in der Auswahlbox das auslösende Event (Ereignis) auswählen; zunächst das Device und dann das gewünschte Regex. Hier soll das notify bei jeder Veränderung der Temperatur (temperature.*) des Device BTHR918N reagieren. Abschließend mit einem Mausklick auf {{Taste|set}} bestätigen. Wählt man mehrere Regex in dieser Weise aus, so wird das "notify" bei Eintritt jedes dieser Events ausgeführt:
[[Datei:Regexp wizard2.JPG|400px|thumb|center]]
Anschließend den Platzhalter "a" mit Klick auf den Link "removeRegexpPart" löschen:
[[Datei:Regexp wizard3.JPG|400px|thumb|center]]
Den Link "DEF" anklicken, damit sich der DEF-Editor öffnet:
[[Datei:Regexp wizard4.JPG|400px|thumb|center]]
Jetzt den auszuführenden Befehl im "DEF"-Bereich durch Überschreiben des Platzhalters "b" eintragen und mit Klick auf {{Taste|modify ntest}} abschließen:
[[Datei:Regexp wizard5.JPG|400px|thumb|center]]
Das fertige und sofort aktive "notify" sieht abschließend folgendermaßen aus:
[[Datei:Regexp wizard6.JPG|400px|thumb|center]]
Am Schluss das Speichern über {{Taste|Save config}} nicht vergessen.

=== Etwas schalten, wenn ein anderes Gerät geschaltet wird ===
Wenn man das obige mit KNX abbilden möchte, benötigt man auf der KNX Seite:

==== Vorbereitung ====
* Gruppenadresse (GA) für die Steckdose vom Radio (0/0/10)
* GA vom Licht (0/0/20)

Auf der Fhem Seite wird benötigt:

define RadioKueche EIB 0/0/10
define LichtKueche EIB 0/0/20

==== notify Befehl ====
define LichtamRadioan notify LichtKueche { fhem "set RadioKueche $EVENT" }
oder '''besser'''
define LichtamRadioan notify LichtKueche set RadioKueche $EVENT

==== Erklärung ====
* Der Begriff "LichtamRadioan" ist nur ein Platzhalter, damit das notify in Fhem verwaltet werden kann.
* "$EVENT" ist ein Platzhalter für den Zustand vom Pattern. $EVENT enthält ein "off" wenn das LichtKueche aus ist und ein "on" wenn das Licht eingeschaltet ist.
* "{ <perlcode> }" alles was zwischen {} steht ist Perl code. Perl kennt das Schlüsselwort Fhem. Das Schlüsselwort Fhem dient dazu, Fhem Befehle auszuführen. Es wird also der Fhem Befehl "set RadioKueche on/off" ausgeführt. on oder off ist abhängig vom Pattern. Der eigentliche Fhem Befehl muss in " " stehen.
* Warum ist die 2. Variante besser? In der 1. Variante wechselt man von Fhem-Ebene des notify mittels {} auf Perl-Ebene, wo man mit dem Schlüsselwort Fhem "" wieder einen Befehl auf Fhem-Ebene ausführt. In der 2. Variante werden diese unnötigen, resourcenverschwendenden Ebenen-Wechsel vermieden. Alles wird auf der Fhem-Ebene ausgeführt.

=== Einschalten von mehreren Geräten/Lampen, wenn das Licht eingeschaltet wird ===
==== Vorbereitung ====
KNX:
* 3 GAs für drei Geräten bzw Lampen (0/0/30 0/0/31 0/0/32)

Fhem:
define LichtWZ EIB 0/0/30
define Steckdose1 EIB 0/0/31
define Steckdose2 EIB 0/0/32

==== notify Befehl ====
define SteckdoseWZein notify LichtWZ { fhem "set Steckdose1 $EVENT;;set Steckdose2 $EVENT " }
oder '''besser'''
define SteckdoseWZein notify LichtWZ set Steckdose1,Steckdose2 $EVENT

==== Erklärung ====
Wenn das LichtWZ eingeschaltet wird, dann werden auch die Steckdosen (1 und 2) eingeschaltet.

=== Einfache ODER Funktion ===
Eine einfache ODER Funktion kann sehr einfach realisiert werden

==== Vorbereitung ====
KNX:
* 3x GAs der abzufragende Werte (0/0/40 0/0/41 0/0/42)

Fhem:
define Licht1 EIB 0/0/40
define Licht2 EIB 0/0/41
define Steckdose EIB 0/0/42

==== notify Befehl ====
define SteckdoseWZein notify (Licht1|Licht2) set Steckdose $EVENT
oder
define SteckdoseWZein notify (Licht.) set Steckdose $EVENT

==== Erklärung ====
Die Werte in der Klammer (wichtig ist das »|«) sind die Rückgabewerte. Alternativ kann in diesem Beispiel auch »Licht.« (zu beachten ist der Punkt) geschrieben werden. Der Punkt ist ein Platzhalter für (genau) ein beliebiges Zeichen.

Danach folgt der set Befehl.
Wenn also das Licht1 oder Licht2 den Wert "on" hat, dann hat auch die Steckdose den Wert "on"

Alternative: [[structure]]

=== Einfache UND Funktion ===
Ob man dieses Konstrukt noch als einfach bezeichnen kann, wage ich mal zu bezeifeln. In Fhem fehlen Loggingfunktionen, die man alle selber mit Perl Code erstellen kann (Danke an MAZ).
Dadurch ist Fhem zwar mächtig, wird aber für viele sehr kompliziert.

In diesem Beispiel soll - wenn drei Rollos geschlossen sind - am Taster eine LED eingeschaltet werden.

==== Vorbereitung ====
KNX:
* 3x GDs für die Rückgabewert Rollo geschlossen == 1 (0/0/50 0/0/51 0/0/52)
* GD LED am Lichtschalter (0/0/106)

Fhem:
define R1ZU EIB 0/0/50
attr R1ZU dummy 1
define R2ZU EIB 0/0/51
attr R1ZU dummy 1
define R3ZU EIB 0/0/52
attr R1ZU dummy 1
define LEDalleRolloZu EIB 0/0/106
Durch das Atribut dummy werden keine Schaltfunktion angeboten. Es kann nur Werte anzeigen.

==== notify Befehl ====
define nt.allerolloszu notify (R1ZU|R2ZU|R6ZU) {
my $r1 = Value("R1ZU");;
my $r2 = Value("R2ZU");;
my $r3 = Value("R6ZU");;
if ($r1 eq "on" && $r2 eq "on" && $r3 eq "on") {
fhem "set LEDalleRolloZu on"
} else {
fhem "set LEDalleRolloZu off"
}
}

==== Erklärung ====
Es werden die drei Rückgabewerte R1ZU, R2ZU und R3ZU ausgewertet. Danach folgt Perl Code, deswegen beginnt das ganze mit einer { und endet mit }

my $r1 => Variable $r1 definieren
= Value("R1ZU");; ==> weist den Rückgabewert (on oder off) von R1ZU der Variable $r1 zu

Der doppelte ;; ist ein Fhem Thema. Eigentlich würde für Perl ein ; reichen. Aber Fhem nutzt selbst das ; und daher wird ein ;; benötigt. Mit den ersten drei my Zeilen werden die Rückgabewerte den Variabeln zugewiesen.

Danach erfolgt ein normales "if then else" Konstrukt. Die Zeile »($r1 eq "on" && $r2 eq "on" && $r3 eq "on")« kann man so lesen: Wenn $r1 den Wert "on" und (&&) $r2 den Wert "on" und $r3 den Wert "on" dann schalte die LEDalleRolloZu ein {fhem("set LEDalleRolloZu on")}
ansonsten else schalte die LED aus. {fhem("set LEDalleRolloZu off")

Alternative: [[structure]]

=== Zeitverzögert schalten ===
{| class="wikitable"
| '''Aufgabe:''' || Zeitverzögert schalten
|-
| '''Beschreibung:''' || Mit einem Notify zeitverzögert eine Aktion auslösen.
|-
| '''Vorbereitung:''' || Gerät "Lampe" ist definiert und es gibt eine Situation, die ein Ereignis "Fernbedienung:.*" generiert.
|-
| '''Befehl:''' || <code>define ntfy1 notify Fernbedienung:.* sleep 7.5;; set Lampe $EVENT</code>
|-
| '''Erläuterungen:''' || Bei Eintreten eines Ereignisses "Fernbedienung*" wird nach einer Pause von siebeneinhalb Sekunden der Befehl <set Lampe ??> ausgeführt, wobei der eigentliche Befehl aus dem auslösenden Ereignis übernommen wird.
:''Quelle: [http://forum.fhem.de/index.php/topic,17161.0.html Fhem Forum]''
|}

=== Eine PV-Anlage (Solarstrom) zur Steuerung der Rollos nutzen (optional Zeit und Datums abhängig) ===
Hier ein kleines Beispiel, wie man mit Hilfe einer PV-Anlage die Sonneneinstrahlung auf der Südseite ermittelt und dies zur Rolladensteuerung nutzt.
Optional: Die Funktion soll allerdings nur zwischen 9:30 und 17:00 stattfinden. (zweites Beispiel)
Optional: Die Funktion soll nur zwischen dem 6. und 9. Monat funktioneren. (drittes Beispiel)

==== Vorbereitung ====
PV Anlage mit SolarView abfragen.
Per Hand ermitteln, ab wieviel erzeugtem Strom es sinnvoll ist die Rollos zu schließen.

==== notify Syntax ====
Fhem:

define sv SolarView solarview 15000 wr1 wr2 wr3 wr4 <----vier Wechselrichter
attr sv event-on-change-reading currentPower

define nt.sonnenlichtpersolar notify (sv:currentPower.*) {
if ($EVTPART1 < 3000 ) {
fhem('set Flur1 Auf');
}else {
if ($EVTPART1 > 5000 ) {
fhem('set Flur1 Ab');
}
}
}

Optional 1: Zeitabhängig

(sv:currentPower.*) {
my $hm = sprintf("%02d:%02d", $hour, $min);
if ( $hm gt "09:30" && $hm lt "17:00") {
if ($EVTPART1 < 5000 ) {
fhem('set Flur1 Auf');
}else {
if ($EVTPART1 > 8000 ) {
fhem('set Flur1 Ab');
}
}
}
}

Optional 2: Zeit und Datum

(sv:currentPower.*) {
my $hm = sprintf("%02d:%02d", $hour, $min);
if ($month >= 6 && $month <= 9) {
if ( $hm gt "09:30" && $hm lt "17:00") {
if ($EVTPART1 < 5000 ) {
fhem('set Flur1,RBUERO1,RBUERO2 Auf');
}else {
if ($EVTPART1 > 8000 ) {
fhem('set Flur1,Flur2,RBUERO1,RBUERO2 Ab');
}
}
}
}
}

==== Erklärung ====
* Das define wird in der Kommandozeile im Webbrowser eingegeben.
* Anschliessend wird im Webbrowser die DEF bearbeitet, das erspart uns Probleme mit Perl
* define sv SolarView ... <==== ist die Schnittstelle vom SolarView
* define nt.sonnenlichtpersolar notify (sv:currentPower.*) { <==== hier wird ein notify angelegt, der auf das "define sv" Wert "currentPower.*" (.* ist irgendwas) reagiert
if ($EVTPART1 < 3000 ) {
fhem('set Flur1 Auf');
}else {
if ($EVTPART1 > 5000 ) {
fhem('set Flur1 Ab');
}
}
}
Diese if-Funktion wertet den Rückgabewert von currentPower aus. Hierbei muss man wissen, dass $EVTPART1 das Splitergebnis vom Rückgabewert ist

Beispiel: Der Rückgabewert (wie im Beispiel) ist "currentPower: 6000".
Jetzt steht im "$EVTPART0 == currentPower:" und im "$EVTPART1 == 6000"
Das bedeutet, dass man sich nicht selbst den richtigen split (Perl Befehl) Aufruf ausdenken muss, dies übernimmt vielmehr Fhem.

Ergebnis:
Das Rollo wird abhängig von der erzeugten IST_Strommenge auf und zu gefahren.
Damit dies nicht dauernd hin und her pendelt, wurde der Auf Wert sehr klein und den Ab Wert sehr groß gewählt.

'''Optional 1:''' Der Block "my $hm = sprintf("%02d:%02d", $hour, $min);" erzeugt die String-Variable $hm mit dem Inhalt $hour:$min. %02d begrenzt die Ausgabe auf zwei Stellen.
Danach wird mit "if ( $hm gt "09:30" && $hm lt "17:00")" mit stringvergleichende Operatoren geprüft, ob die Uhrzeit zwischen 9:30 und 17:00 liegt (lt = kleiner als; gt = größer als). Es wäre auch ein le und ge möglich: le = kleiner/gleich als, ge = größer/gleich als.

'''Optional 2:'''if( $month >= 6 && $month <= 9) {

Hier wird die numerische Fhem-Standard-Variable $month (Monat) auf größer/gleich bzw kleiner/gleich mit den binären Operatoren überprüft.
Die Funktion arbeitet also nur zwischen dem 6. und dem 9. Monat und dann auch nur zwischen 9:31 und 16:59.

=== Hinweise ===
* Entsprechend zu $EVENT gibt es auch noch $NAME und $TYPE. $NAME und $TYPE enthalten den Namen bzw. Typ des Ereignis auslösenden Gerätes.
* Wird der Perl-Code in einem <code>notify</code> immer länger, lagere den Code wegen der Übersichtlichkeit in eine eigene Programmdatei aus, wie in [[99_myUtils anlegen]] beschrieben.
* Achtung! Wenn man das Skript für den notify-Befehl über mehrere Zeilen schreibt, muss man anscheinend darauf achten, dass keine abschliessende Leerzeile mitgespeichert wird. Sonst wird der notify-Befehl ignoriert.
* Dieser {{Link2Forum|Topic=38520|Message=307325}} enthält Vorschläge zur Vorgehensweise bei der Erstellung von komplexen ''notify'' Definitionen bzw. bei deren Fehlerbehebung.

== Weiterführende Links ==
* [[Escapen in Perlbefehlen]]
* [[Klammerebenen]]
* [[DOIF]] als Alternative vereinigt die Funktionalität des notify-, at-, watchdog-Befehls in Kombination mit logischen Abfragen unter einem Dach

[[Kategorie:HOWTOS]]
[[Kategorie:Hilfsmodul]]