FHEMWiki - Benutzerbeiträge [de]

Diskussion:Erste Schritte in FHEM

2017-03-04T13:18:39Z

Uli:

== Die Sache mit dem doppelten Semikolon ==

Gerade für den Anfänger an den sich dieses Dokument richtet, wäre es sehr wichtig zu verstehen, warum das Semikolon verdoppelt werden muss und was damit geschieht (''es wird nur einfach in DEF gespeichert''). Das wird hier nur anhand des daraus resultierenden Symptoms erklärt: "Sofort ausführen oder später". Aber das warum wäre m.E. gerade hier für das Verständnis beim Einstieg wichtig. Ansonsten ist es auch schwer nachzuvollziehen, warum man den gleichen Befehl den <code>notify</code> ausführen soll auf der Kommandozeile mit verdoppeltem Semikolon und beim editieren des Internals DEF dann wieder ohne Verdoppelung schreiben muss. Drei Überlegungen dazu:
# Könnte man das Beispiel mit der Verdoppelung noch um das Editieren des Internals DEF erweitern und dabei genau das erläutern. Ohne diese Erkenntnis ist die Tücke dieses Konstrukts schwer verständlich und der Anfänger wundert sich warum seine Lampe auf den Status <code>on; define a1 at +00:01 set myLampe1,myLampe2 off</code> o.Ä. gesetzt wird.
# Gibt es überhaupt sinnvolle Fälle, in denen ein verdoppeltes Semikolon im DEF benötigt wird. Spätestens bei dem hier benötigten vierfach Semikolon sollte man wissen was damit wann geschieht.
# Gibt es sinnvolle Zustände die ein Semikolon enthalten? Wäre da eine Warnung möglich?
Viele Grüße --[[Benutzer:MGu|MGu]] ([[Benutzer Diskussion:MGu|Diskussion]]) 18:10, 17. Apr. 2016 (CEST)

== Falsche und indirekte negative Darstellung von notify/at im Vergleich zu DOIF ==

Hallo!

Die bewertende Aussage "Bei der Kombination von Ereignis (Bewegungsmelder meldet eine Bewegung) und Zeitangaben werden die stärken des DOIF deutlich. Es ist nur eine Definition (Gerät) notwendig. Wollte man dies durch die Verwendung von at und notify lösen, wären mehrere Definitionen notwendig oder ausreichende Perl-Kenntnisse." insbesondere im Zusammenhang mit dem Beispiel halte ich für falsch und bringt Einsteiger auf eine vollkommen falsche Spur/Sichtweise.

Die nur zeitweise Ausführung eines notify bzw. at erreicht man durch Setzen des Attributes <code>disabledForIntervals</code>. Damit muss man für die Umsetzung des Beispiels beim notify nur das passende Zeitintervall im genannten Attribut setzen. Es sind keine weiteren Definitionen notwendig.

Wenn der DOIF-Abschnitt erhalten bleiben soll und meine Aussage richtig ist, dann bitte ich um kurzfristige Entfernung der Wertung und auch Darstellung der Lösung des erweiterten Beispiels mit einem notify und dem Attribut disabledForIntervals. Das Wiki sollte nach Möglichkeit eine neutrale Sichtweise vermitteln, wenn es nicht eindeutige Vor- oder Nachteile gibt, die ich hier nicht erkenne.

Da es sich um einen wichtigen Artikel handelt, werde ich spätestens morgen selbst Änderungen vornehmen, um nicht Einsteigern falsche Sichtweisen zu vermitteln.

Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 09:43, 12. Feb. 2017 (CET)
<hr />
:Bin auch für "rückgängig machen", insbesondere auch, da diese Seite auf dem Einsteigerdokument von Uli Maass basiert und nur mit seinem Einverständnis ins Wiki übernommen wurde. Darüber hinaus ist die DOIF-Ergänzung sicherlich als redaktionelle Erweiterung anzusehen und allein aus diesem Gesichtspunkt schon mit Uli abzustimmen. --[[Benutzer:Ph1959de|Peter]] ([[Benutzer Diskussion:Ph1959de|Diskussion]]) 09:20, 13. Feb. 2017 (CET)
<hr>
::Jep, war auch mein erster Gedanke --[[Benutzer:Drhirn|Drhirn]] ([[Benutzer Diskussion:Drhirn|Diskussion]]) 09:27, 13. Feb. 2017 (CET)
<hr>
:::Habe die Änderungen komplett zurückgesetzt.
:::Begründung:
:::* die vergleichenden Aussagen sind falsch
:::* ein Einverständnis der redaktionellen Änderung liegt afaik nicht vor und die Änderung wurde hier nicht vorab diskutiert. (den Hinweis darauf im Vorspann des Artikels hatte ich zuvor übersehen)
:::Wiedereinbau ist nach Abstimmung mit Uli und mit korrekter Darstellung nach Review grundsätzlich möglich. Dazu Änderungsvorschläge hier auf der Diskussionsseite einstellen.
:::--[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 09:48, 13. Feb. 2017 (CET)
Ist der Abstimmungsvorbehalt nicht unzulässig? Oder gilt der Hinweis über dem Speichern-Button nicht für Alle Wiki-Benutzer "Falls du nicht möchtest, dass deine Arbeit hier von anderen verändert und verbreitet wird, dann klicke nicht auf „Seite speichern“."

Die vergleichenden Passagen werde ich ändern.

--[[Benutzer:Trelle|Trelle]] ([[Benutzer Diskussion:Trelle|Diskussion]]) 12:10, 13. Feb. 2017 (CET)
<hr>
:Hmm, diese Seite ist einfach ein Sonderfall. Uli Maas hat da ursprünglich ein PDF-Dokument erstellt, das lange als Einstiegslektüre zu FHEM gehandelt wurde. Ich habe nur damals nach Rücksprache mit ihm die Erlaubnis bekommen, das PDF ins Wiki zu übernehmen. Die "Rechte" liegen aber sozusagen immer noch bei Uli. Deswegen habe ich das extra in der Einleitung erwähnt. Sowie auch diesen Punkt: "Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen."
:Wie gesagt, ein Sonderfall. Bitte nicht persönlich nehmen.
:--[[Benutzer:Drhirn|Drhirn]] ([[Benutzer Diskussion:Drhirn|Diskussion]]) 12:52, 13. Feb. 2017 (CET)
<hr>
:
:Hallo!
:Abstimmungsvorbehalt liest sich hart :-) . Es ist eine Bitte, die Du wahrscheinlich übersehen hast, und die in diesem Fall (Artikel) ihre Begründung hat. Das ist ein wichtiger Grundlagenartikel der überall verlinkt wird und darum richtig und objektiv sein soll. Der Inhalt wurde zuvor von mehreren Personen reviewed. Änderungen sollten daher vorher abgesprochen und besprochen werden, damit sie auch richtig sind.
:Hätte ich den Artikel nicht auf der oberen Beobachtungsprioriät, wäre vielleicht falsches Wissen verbreitet worden und das ist für niemanden sinnvoll. Genau darum habe ich auch die schnelle Reaktion angekündigt und umgesetzt.
:Das Problem der Änderung durch jedermann ist auch ein Aspekt, warum das Einsteiger-PDF nicht im Wiki steht.
:Ich persönlich denke, dass man gewisse Bitten respektieren sollte. Genauso habe ich damals Damians Bitte respektiert, dass im Wiki die Anwendungsbeispiele zu [[DOIF]] entfernt werden und das umgesetzt. Er stand DOIF-Artikeln im Wiki insgesamt kritisch gegenüber. Deine Artikel zu DOIF wurden auch intern beratschlagt, ob sie im Sinne von Damian "zulässig" sind. Angesichts der sehr guten Qualität und auch Eurer engen Zusammenarbeit bei der Fortentwicklung von DOIF haben wir das als gegeben hingenommen.
:Insgesamt setzen wir im Wiki auf einen großzügiges Rechtesystem ohne Review vor Freigabe. Zudem darf jeder fast jede Seite ändern und anpassen. Bei Besonderheiten -wie hier- werden bisher entsprechende Bitten/Hinweise ausgesprochen, die man einhalten sollte.
:Gruß, --[[Benutzer:Krikan|Christian]] ([[Benutzer Diskussion:Krikan|Diskussion]]) 13:49, 13. Feb. 2017 (CET)

Hallo,
ich bin gerne bereit hier einen Entwurf zum Review einzustellen, damit die Qualität des Artikels gewährleistet bleibt.
DOIF gehört als grundlegendes Automatisierungselement in ein Einstiegsdokument, da stimmst Du mir sicherlich zu.

Wenn Abweichungen zu den Wiki-Lizenzbedingungen mit einzelnen Autoren von euch vereinbart werden, solltet Ihr nicht deren Klärung, Abstimmung u. Einhaltung auf die Benutzer abwälzen, sondern nach dem Verursacherprinzip selbst durchführen. Zumal dem Benutzer nicht ohne Weiteres bekannt ist, unter welchem Avatar er den Autor findet.

Diese Forderung: "und auch Darstellung der Lösung des erweiterten Beispiels mit einem notify und dem Attribut disabledForIntervals." halte ich für pure Willkür, denn das gilt ja nur für mich, solange die anderen Beispiele nicht mit DOIF-Beispielen ergänzt werden. Sie ist sicherlich ähnlich entstanden, wie meine vergleichenden Textpassagen.

Den Absimmungsvorbehalt habe ich so verstanden, als Vorbehalt und ich habe ihn nicht über sehen, sondern ignoriert. Aber nicht ohne auf die Seite von Uli zu schauen, wo Du seit 16:26, 2. Okt. 2015 auf eine Antwort wartest.

'''Hier mein Vorschlag zum Review:'''

== Zeit- und Eventsteuerung, DOIF vereint at und notify ==
<u>Aufgabenstellung</u>: Ein Treppenhauslicht soll durch einen Bewegungsmelder eingeschaltet werden, aber nur zwischen 18 Uhr und 8 Uhr.

Bei der Kombination von [[Event|Ereignis]] (Bewegungsmelder meldet eine Bewegung) und Zeitangaben werden die Stärken des [[DOIF]] deutlich.

Zeitangaben erfolgen im [[DOIF]] in eckigen Klammern <code>[HH:MM]</code> für einen Zeitpunkt und <code>[HH:MM-HH:MM]</code> für eine Zeitspanne.

Hier ist vorausgesetzt, dass der Bewegungsmelder als Gerät mit dem Namen ''BM'' definiert wurde und er ein [[Readings|Reading]] mit dem Namen ''motion'' besitzt. Das [[Readings|Reading]] ''motion'' nimmt bei erkannter Bewegung den Wert ''on'' an und nach Verschwinden der Bewegung den Wert ''off''.
Auf die Statusänderung des Bewegungsmelders wird auch wieder über Angaben in eckigen Klammern <code>[gerätename:readingname]</code> zugegriffen.

Bei erkannter Bewegung soll geschaltet werden, also wenn der Status des BM auf ''on'' wechselt. Dies wird geprüft durch einen vergleichenden [https://de.wikipedia.org/wiki/Operator_(Mathematik) Operator] ''eq'' (equal). Die Zeitangaben und der Ereignisvergleich werden durch den logischen [https://de.wikipedia.org/wiki/Operator_(Mathematik) Operator] ''and'' verknüpft. Der set-Befehl wird ausgeführt, wenn die ganze Bedingung logisch wahr wird, das ist nur der Fall, wenn zwischen 18 Uhr und 8 Uhr eine Bewegung erkannt wird.

Die Definition des [[DOIF]] ist einfach:
<pre>define treppenhaus_di DOIF ([18:00-08:00] and [BM:motion] eq "on") (set th_Licht on-for-timer 60)</pre>
Es sind natürlich auch flexible Zeitangaben möglich, die sich auf den Sonnenauf u. -untergang beziehen.
<pre>define treppenhaus_di DOIF ([{sunset}-{sunrise}] and [BM:motion] eq "on") (set th_Licht on-for-timer 60)</pre>
Es können auch Zeiten angegeben werden, die in [[Readings]] des DOIF-Gerätes selbst stehen und über das WEB-Frontend verändert werden können.
<pre>define treppenhaus_di DOIF ([[$SELF:Beginn]-[$SELF:Ende]] and [BM:motion] eq "on") (set th_Licht on-for-timer [$SELF:Dauer])</pre>
[[Datei:ErsteSchritte DOIF.png]]

Weitere Ausführungen zum DOIF würden den Rahmen der ''ersten Schritte'' sprengen.
Wenn das Interesse an [[DOIF]] geweckt wurde, gibt es im [[DOIF/Labor_-_ausführbare,_praxisnahe_Beispiele_als_Problemlösung_zum_Experimentieren|DOIF Labor]] ausführbare Beispiele zum Importieren über [[Import_von_Code_Snippets|Raw definition]].

'''und die Ergänzung in: ''Sie haben nun kennengelernt:'' '''
* [[DOIF]]: Zusammenfassen von Ereignissteuerung ([[notify]]) und Zeitsteuerung ([[at]])

--[[Benutzer:Trelle|Trelle]] ([[Benutzer Diskussion:Trelle|Diskussion]]) 16:39, 13. Feb. 2017 (CET)

Ich habe eine Selbstrevision durchgeführt und den obigen Text überarbeitet.

--[[Benutzer:Trelle|Trelle]] ([[Benutzer Diskussion:Trelle|Diskussion]]) 18:30, 13. Feb. 2017 (CET)
<hr>
:Hallo allerseits,
:vielen Dank für die rege Diskussion zu diesem Artikel.
:In der Tat wär's mir wie geschrieben lieb, wenn redaktionelle Änderungen vor dem Einfügen mit mir abgesprochen würden.
:Bezgl. DOIF: ich kenne das Modul aus Posts und Diskussionen im Forum, nutze es aber selbst nicht und konnte/kann deshalb auch nix dazu schreiben. Insofern vielen Dank für die Zulieferung eines neuen Abschnitts.
:Da diese Anleitung sich speziell an den Einsteiger wendet, der vielleicht das erste mal nen Blick auf FHEM wirft, hab ich mit dem Einbinden des DOIF-Beispiels 2 Sorten Bauchschmerzen:
:1. es zeigt dem Neuling gleich beim allerersten Kontakt mit FHEM mehrere Alternativen für denselben Sachverhalt auf, das hallte ich für verwirrend.
:2. DOIF verwendet eine proprietäre Syntax in regexp - auch diese hat zumindest in der Anfangszeit das Potential, den Neuling zu verwirren.
:Mein Ansatz ist "Einfachheit durch weglassen" - das würde möchte ich auch auf diese Diskussion und mithin DOIF anwenden.
:Vorschlag: aus diesem Artikel rauslassen, aber in die nächste Version des Einsteiger-pdf aufnehmen - das ist ja wesentlich umfangreicher und versucht, möglichst viele hilfreiche Module vorzustellen und z.T. auch zu erklären - dort wäre so ein DOIF-Artikel m.E. wesentlich besser aufgehoben.
:Wenn ich endlich mal zur besagten nächsten Version komme, melde ich mich wieder mit der Bitte um input.
: Gruß und schönen Tag allerseits, Uli
:--[[Benutzer:Uli|Uli]] ([[Benutzer Diskussion:Uli|Diskussion]]) 09:12, 19. Feb. 2017 (CET)

<hr>
::Hallo Uli,
::ich habe die Bedenken hinsichtlich einer Ergänzung des Einsteigerartikels in meiner Naivität unterschätzt.
::Gegen die Abstimmung einer Ergänzung habe ich selbstverständlich nichts einzuwenden.
::Ich stehe voll hinter Deinem Ansatz "Einfachheit durch weglassen". Deshalb schlage ich vor, die Beispiele, die at und notify verwenden durch DOIF zu ersetzen, dann wird dem Einsteiger nur ein Modul zugemutet. Das ist möglich, weil durch DOIF die Angabe generischer Auslöser vereinfacht und harmonisiert wurde. DOIF funktioniert ohne Kenntnis "regulärer Ausdrücke".
::* Angabe eines Auslösers: <code>[<name>:<reading>] vs. <name>:<reading>.*</code>, eine einfache Readingsangabe reicht im DOIF
::* Angabe eines Zeitpunktes: <code>[HH:MM:SS] vs. *HH:MM:SS</code>,
::* und Angabe einer Zeitspanne, die einen Neustart überlebt: <code>[HH:MM:SS-HH:MM:SS] vs. *HH:MM:SS ...;;define at *HH:MM:SS ...</code>

::Diese wegweisende, von Dir als properitär bezeichnete Syntax, hat den Set-Befehl beeinflusst, bekannt als ''set magic'' <code>set <name> [<gerät>:<reading>]</code>.

::Wenn Du die Regexp-Syntax im DOIF als properitär bezeichnest, dann trifft das vielmehr auch auf die Syntax von at und notify zu, beim notify werden z.B. intern die Begrenzungszeichen ^ und $ gesetzt, ohne es in der Befehlereferenz zu erwähnen.
::<u>Beispiel</u>
::Ausgehend von den Events
<pre>
2017-02-21 19:25:09 dummy du3 B: off
2017-02-21 19:25:10 dummy du3 B: on
</pre>
::würde ich eine exakte Regexp so formulieren <code>^du3$:^B: (on|off)$</code>. Das funktioniert im notify nicht, im DOIF schon, also nur mal zum Thema "properitäre Syntax".

::Hier mein Gegenvorschlag: DOIF statt at und notify in die "ersten Schritte" aufnehmen.

::Dieser Vorschlag folgt Deinem Ansatz "Einfachheit durch weglassen" zielführend, daher bitte ich Dich diesen Vorschlag anzunehmen.

::DOIF ins Einsteiger-pdf aufzunehmen ist eine gute Idee, aber das kann ja noch dauern, wie Du selbst andeutest.

::LG Trelle

::--[[Benutzer:Trelle|Trelle]] ([[Benutzer Diskussion:Trelle|Diskussion]]) 20:22, 21. Feb. 2017 (CET)

Hallo an alle Beteiligten der Disskussion Erste Schritte,

die Antwortzeiten sind hier ja recht lang, da hatte ich Gelegenheit meinen Vorschlag für die Erweiterung der "Ersten Schritte" noch einmal gründlich zu überarbeiten. Es sollte jetzt keine Formulierungen mehr geben, die den Verdacht aufkeimen lassen könnten, dass at und notify nicht gleichberechtigte Partner-Module zu DOIF sein könnten. Damit sind dann auch [[DOIF]], die Befehlsreferenz und dieser Vorschlag harmonisiert.

'''Hier nun der überarbeitete Vorschlag:'''

== Zeit- und Ereignissteuerung mit DOIF ==
'''[[DOIF]]''' (ausgeprochen: du if, übersetzt: tue wenn) ist ein universelles Modul, welches [[Event|ereignis-]] und zeitgesteuert in Abhängigkeit definierter Bedingungen Anweisungen ausführt.

In einer Hausautomatisation geht es immer wieder um die Ausführung von Befehlen abhängig von einem [[Ereignis]]. Oft reicht aber eine einfache Abfrage der Art: "wenn [[Ereignis]] eintritt, dann Befehl ausführen" nicht aus. Ebenso häufig möchte man eine Aktion nicht nur von einem einzelnen [[Ereignis]] abhängig ausführen, sondern abhängig von mehreren Bedingungen, z. B. "schalte Außenlicht ein, wenn es dunkel wird, aber nicht vor 18:00 Uhr" oder "schalte die Warmwasserzirkulation ein, wenn die Rücklauftemperatur unter 38 Grad fällt und jemand zuhause ist". In solchen Fällen muss man mehrere Bedingung logisch miteinander verknüpfen. Ebenso muss sowohl auf Ereignisse wie auch auf Zeittrigger gleichermaßen reagiert werden.

An dieser Stelle setzt das Modul [[DOIF]] an. Es stellt eine eigene Benutzer-Schnittstelle zur Verfügung ohne Programmierkenntnisse in [https://de.wikipedia.org/wiki/Perl_(Programmiersprache) Perl] unmittelbar vorauszusetzen. Mit diesem Modul ist es möglich, sowohl [[Ereignis]]- als auch Zeitsteuerung mit Hilfe logischer Abfragen miteinander zu kombinieren. Damit können komplexere Problemstellungen innerhalb eines [[DOIF]]-Moduls gelöst werden, ohne Perlcode in Kombination mit anderen Modulen programmieren zu müssen.

Das [[DOIF]]-Modul bedient sich selbst des Perlinterpreters, damit sind beliebige logische Abfragen möglich. Logische Abfragen werden in DOIF/DOELSEIF-Bedingungen vornehmlich mit Hilfe von and/or-[https://wiki.selfhtml.org/wiki/Perl/Operatoren Operatoren] erstellt. Diese werden mit Angaben von Stati, [[Readings]], [[Internals]], [[Event|Events]] oder Zeiten kombiniert. Sie werden grundsätzlich in eckigen Klammern angegeben und führen zur Triggerung des Moduls und damit zur Auswertung der dazugehörigen Bedingung. Zusätzlich können in einer Bedingung Perl-Funktionen angegeben werden, die in [[FHEM]] definiert sind. Wenn eine Bedingung wahr wird, so werden die dazugehörigen Befehle ausgeführt.

Die vollständige Dokumentation mit zahlreichen Beispielen ist in der [https://fhem.de/commandref_DE.html deutschsprachigen Befehlsreferenz zum DOIF] zu finden.

Zusätzliche, ausführbare Beispiele zum [[Import von Code Snippets|Import]] in [[FHEM]], gibt es im [[DOIF/Labor - ausführbare, praxisnahe Beispiele als Problemlösung zum Experimentieren|DOIF Labor]]
=== 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
}}
<u>Aufgabenstellung:</u> Eine Fernbedienung soll einen Fernseher einschalten, der über eine Funkstekdose 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|Event-Monitor]] 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.

<u>Definition:</u>
<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>

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.
<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>
=== Zeitsteuerung ===
{{Randnotiz|RNText=Hinweis: Verwendung von
* <code><nowiki>[<Zeitpunkt>|<Wochentagangabe>]</nowiki></code> zur Angabe eines Zeitpunktes mit Wochentagbeschränkung (8 ≙ werktags, 7 ≙ Wochenende).
* '''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
}}
<u>Aufgabenstellung:</u> 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|Event-Monitor]] nicht sichtbar.

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

<u>Definition:</u>
<pre>define 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)</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>

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>

=== 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.
}}
<u>Aufgabenstellung:</u> 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.

<u>Definition:</u>
<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>

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

'''und die Ergänzung in: Sie haben nun kennengelernt:'''

* DOIF: Ereignis-und Zeitsteuerung

LG --[[Benutzer:Trelle|Trelle]] ([[Benutzer Diskussion:Trelle|Diskussion]]) 19:16, 1. Mär. 2017 (CET)

<hr>
:Hi Trelle,
:die langen Antwortzeiten liegen im Wesentlichen daran, dass ich keine Mailbenachrichtigung kriege, wenn hier was geschrieben wird. (vielen Dank an Christian für den Hinweis)
:Mach doch aus der DOIF-Ausarbeitung eine separate Wiki-Seite. Am Ende der Erste-Schritte-Abschnitte zu notify und at können wir dann nen Hinweis einfügen à la: "Hinweis: Als Alternative zu den Befehlen <at|notify> gibt es auch das Modul DOIF, mit dem vor allem komplexere Bedingungen einfacher abzubilden sind."
: Gruß und schönen Tag, Uli
:--[[Benutzer:Uli|Uli]] ([[Benutzer Diskussion:Uli|Diskussion]]) 09:12, 19. Feb. 2017 (CET)

{{Anker|neue_Antwort}}
::Hallo Uli,

::Es geht nicht darum, dass im Wiki etwas über DOIF geschrieben wird, da gibt es schon eine Menge.

::Es geht darum, Einsteigern beim Erstkontakt über die "Ersten Schritte ..." eine ernstzunehmende Möglichkeit der Zeit- und Eventverarbeitung nicht vorzuenthalten, sondern Sie auf Augenhöhe anzubieten.

::Das Verschweigen dieser Möglichkeit lässt Einsteiger nicht Ihren besten Weg finden und kommt einer Bevormundung gleich.

::Die Disskussion um at, notify und DOIF lässt 3 Gruppierungen erkennen at/notify bzw. DOIF Puristen und die Mischer. Es gibt keinen Grund anzunehmen, dass diese Vorlieben nicht auch bei Einsteigern angelegt sind.

::Gerade als Marketing Verantwortlicher des Vereins solltest Du ein Interesse haben, allen Gruppen einen leichten Einstieg zu ermöglichen, auch mit Blick auf die sich ankündigende Verbreitungsoffensive (FHEM-Livesystem und Showcases, usw.)

::Du kennst DOIF, nicht hast Du erwähnt, dass sollte Dich nicht abhalten es dennoch ernstzunehmen und von eigenen Vorlieben unabhängig zu betrachten, um den Mehrwert für FHEM erkennen zu können.

::Zur Verkürzung der Antwortzeiten könnten wir die Disskussion auch ins Forum verlagern. Was hältst Du davon?

::LG --[[Benutzer:Trelle|Trelle]] ([[Benutzer Diskussion:Trelle|Diskussion]]) 12:27, 4. Mär. 2017 (CET)
{{Anker|neue_Antwort}}
:::Hallo Trelle,
:::offengestanden hab ich gar keine Lust auf diese Diskussion.
:::Offenbar haben wir hier unterschiedliche Ansichten. Ich respektiere Deine, respektiere Du bitte meine.
:::Einen Link auf eine DOIF-Seite können wir wie oben vorgeschlagen gerne einbauen, mehr Veränderung möchte ich an diesem Artikel nicht vornehmen.
:::Gruß, Uli
:::PS: Mit meiner Rolle im Verein hat das nix zu tun, es geht ja nicht um ein Vereinsthema.
:::--[[Benutzer:Uli|Uli]] ([[Benutzer Diskussion:Uli|Diskussion]]) 09:12, 19. Feb. 2017 (CET)

Diskussion:Erste Schritte in FHEM

2017-03-04T09:58:55Z

Uli:

Diskussion:Erste Schritte in FHEM

2017-02-19T08:15:46Z

Uli:

HM-RC-4-2 Funkfernbedienung 4 Tasten

2016-01-29T14:00:35Z

Uli: /* Hinweis zum Anlegen der Channles bei der baugleichen ROTO_ZEL-STG-RM-HS-4 */

HomeMatic Fernbedienung mit 4 Tasten in Form eines Schlüsselanhängers
==Features==
HomeMatic Fernbedienung mit 4 Tasten in Form eines Schlüsselanhängers, mitStatus-LED, die in den Farben Grün, Rot und Orange leuchten bzw. blinken kann.
Robuster Aufbau, Batterie ist eine normale Microzelle (AAA), Nachkauf daher günstiger als bei Sendern mit Knopfzellen, allerdings bedingt die Microzelle auch eine grösseres Gehäuse.

==Hinweise zum Betrieb mit FHEM==

=== Anbindung der Fernbedienung an fhem ===
Wie alle HomeMatic-Komponenten wird die Fernbedienung durch das Modul CUL_HM angebunden. Die Funkverbindung ist mittels einer HomeMatic-CCU, eines [[HMLAN Konfigurator]] oder eines CUL/CUNx/COC etc. im HM-Mode möglich.

=== Anlernen der Fernbedienung an fhem ===
wie unter [[HomeMatic_Devices_pairen]] beschrieben.

Nach erfolgreichem Pairen sollte in etwa folgendes in der cfg stehen:

define CUL_HM_HM_RC_4_2_227C77 CUL_HM 227C77
attr CUL_HM_HM_RC_4_2_227C23 .devInfo 040000
attr CUL_HM_HM_RC_4_2_227C77 .stc 40
attr CUL_HM_HM_RC_4_2_227C77 firmware 1.1
attr CUL_HM_HM_RC_4_2_227C77 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77 room CUL_HM
attr CUL_HM_HM_RC_4_2_227C77 serialNr KEQ0456756
attr CUL_HM_HM_RC_4_2_227C77 subType remote
define CUL_HM_HM_RC_4_2_227C77_Btn_01 CUL_HM 227C7701
attr CUL_HM_HM_RC_4_2_227C77_Btn_01 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77_Btn_01 peerIDs
attr CUL_HM_HM_RC_4_2_227C77_Btn_01 room CUL_HM
define CUL_HM_HM_RC_4_2_227C77_Btn_02 CUL_HM 227C7702
attr CUL_HM_HM_RC_4_2_227C77_Btn_02 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77_Btn_02 room CUL_HM
define CUL_HM_HM_RC_4_2_227C77_Btn_03 CUL_HM 227C7703
attr CUL_HM_HM_RC_4_2_227C77_Btn_03 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77_Btn_03 room CUL_HM
define CUL_HM_HM_RC_4_2_227C77_Btn_04 CUL_HM 227C7704
attr CUL_HM_HM_RC_4_2_227C77_Btn_04 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77_Btn_04 room CUL_HM

=== Auswertung===
Das Betätigen des Senders löst in der Regel zwei Events aus, da auch der Batteriestatus bei jeder Tastenbetätigung mit übermittelt wird.

Eine unspezifische Abfrage der Art:

define act_on_Taste4 notify CUL_HM_HM_RC_4_2_227C77_Btn_04 set Aktor1 on

wird also den Befehl "set Aktor1 on" 2x senden. Es ist daher in der Regel sinnvoll, das Button-Event explizit abzufragen, z.b. so:

define act_on_Taste4 notify CUL_HM_HM_RC_4_2_227C77_Btn_04:Short.* set Aktor1 on

(Fängt kurze Tastendrücke ab, die Events der Form Short_100 generieren. 100 hiesse, dass die Taste 100 ms gedrückt wurde.)

=== Hinweis zum Anlegen der Channels bei der baugleichen ROTO_ZEL-STG-RM-HS-4 ===
Bei der baugleichen ROTO_ZEL-STG-RM-HS-4 wird mit Stand Januar 2016 von autocreate zwar das device selbst automatisch angelegt, jedoch nicht die 4 Kanäle für die 4 Tasten.
Die Kanäle müssen manuell angelegt werden. Startpunkt ist die HMID des device, z.B.
1907C9
Die Kanäle werden dann angelegt mit der HMID, an die die Kanalnummer 01...04 angehängt werden, also
1907C901
1907C902
1907C903
1907C904

Verwendet wird der reguläre define-Befehl, also
define <Kanalname> CUL_HM 1907C901
usw.
Die Channels werden danach regulär unter dem device angezeigt und können bei Bedarf regulär ge'''peer'''t werden.

[[Kategorie:HomeMatic Components]]
[[Kategorie:Schalter (Sender)]]

HM-RC-4-2 Funkfernbedienung 4 Tasten

2016-01-29T13:58:31Z

Uli: HM: Anleitung zum Anlegen der Channels für ROTO_ZEL-STG-RM-HS-4

HomeMatic Fernbedienung mit 4 Tasten in Form eines Schlüsselanhängers
==Features==
HomeMatic Fernbedienung mit 4 Tasten in Form eines Schlüsselanhängers, mitStatus-LED, die in den Farben Grün, Rot und Orange leuchten bzw. blinken kann.
Robuster Aufbau, Batterie ist eine normale Microzelle (AAA), Nachkauf daher günstiger als bei Sendern mit Knopfzellen, allerdings bedingt die Microzelle auch eine grösseres Gehäuse.

==Hinweise zum Betrieb mit FHEM==

=== Anbindung der Fernbedienung an fhem ===
Wie alle HomeMatic-Komponenten wird die Fernbedienung durch das Modul CUL_HM angebunden. Die Funkverbindung ist mittels einer HomeMatic-CCU, eines [[HMLAN Konfigurator]] oder eines CUL/CUNx/COC etc. im HM-Mode möglich.

=== Anlernen der Fernbedienung an fhem ===
wie unter [[HomeMatic_Devices_pairen]] beschrieben.

Nach erfolgreichem Pairen sollte in etwa folgendes in der cfg stehen:

define CUL_HM_HM_RC_4_2_227C77 CUL_HM 227C77
attr CUL_HM_HM_RC_4_2_227C23 .devInfo 040000
attr CUL_HM_HM_RC_4_2_227C77 .stc 40
attr CUL_HM_HM_RC_4_2_227C77 firmware 1.1
attr CUL_HM_HM_RC_4_2_227C77 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77 room CUL_HM
attr CUL_HM_HM_RC_4_2_227C77 serialNr KEQ0456756
attr CUL_HM_HM_RC_4_2_227C77 subType remote
define CUL_HM_HM_RC_4_2_227C77_Btn_01 CUL_HM 227C7701
attr CUL_HM_HM_RC_4_2_227C77_Btn_01 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77_Btn_01 peerIDs
attr CUL_HM_HM_RC_4_2_227C77_Btn_01 room CUL_HM
define CUL_HM_HM_RC_4_2_227C77_Btn_02 CUL_HM 227C7702
attr CUL_HM_HM_RC_4_2_227C77_Btn_02 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77_Btn_02 room CUL_HM
define CUL_HM_HM_RC_4_2_227C77_Btn_03 CUL_HM 227C7703
attr CUL_HM_HM_RC_4_2_227C77_Btn_03 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77_Btn_03 room CUL_HM
define CUL_HM_HM_RC_4_2_227C77_Btn_04 CUL_HM 227C7704
attr CUL_HM_HM_RC_4_2_227C77_Btn_04 model HM-RC-4-2
attr CUL_HM_HM_RC_4_2_227C77_Btn_04 room CUL_HM

=== Auswertung===
Das Betätigen des Senders löst in der Regel zwei Events aus, da auch der Batteriestatus bei jeder Tastenbetätigung mit übermittelt wird.

Eine unspezifische Abfrage der Art:

define act_on_Taste4 notify CUL_HM_HM_RC_4_2_227C77_Btn_04 set Aktor1 on

wird also den Befehl "set Aktor1 on" 2x senden. Es ist daher in der Regel sinnvoll, das Button-Event explizit abzufragen, z.b. so:

define act_on_Taste4 notify CUL_HM_HM_RC_4_2_227C77_Btn_04:Short.* set Aktor1 on

(Fängt kurze Tastendrücke ab, die Events der Form Short_100 generieren. 100 hiesse, dass die Taste 100 ms gedrückt wurde.)

=== Hinweis zum Anlegen der Channles bei der baugleichen ROTO_ZEL-STG-RM-HS-4 ===
Bei der baugleichen ROTO_ZEL-STG-RM-HS-4 wird von autocreate zwar das device selbst, jedoch nicht die 4 Kanäle für die 4 Tasten automatisch angelegt.
Die Kanäle müssen manuell angelegt werden. Startpunkt ist die HMID des device, z.B.
1907C9
Die Kanäle werden dann angelegt mit der HMID, an die die Kanalnummer 01...04 angehängt werden, also
1907C901
1907C902
1907C903
1907C904

Verwendet wird der reguläre define-Befehl, also
define <Kanalname> CULHM 1907C901
usw.
Die Channels werden danach regulär unter dem device angezeigt und können bei Bedarf regulär ge'''peer'''t werden.

[[Kategorie:HomeMatic Components]]
[[Kategorie:Schalter (Sender)]]

Raspberry Pi

2015-11-19T17:25:54Z

Uli: /* Nützliche Zusatzpakete */

Beim '''Raspberry Pi''' handelt es sich um einen postkartengroßen Einplatinen-Computer, der von der Raspberry Pi Foundation entwickelt wird. Die Hardware basiert auf dem BCM 283x SoC (System-on-Chip) von Broadcom, einem ARM-Prozessor. Zu Hardwaredetails und den verschiedenen Modellen sowie Produktentwicklungen siehe [http://de.wikipedia.org/wiki/Raspberry_Pi#Hardware Wikipedia].
Dank der kleinen Abmessungen, dem recht geringen Energieverbrauch (bis ca. 4 Watt) sowie der günstigen Anschaffungskosten (ca. 30€) ist der Raspberry Pi eine attraktive Hardware für die Heimautomatisierung mit Fhem. Er ist dank dem Linux-Betriebssystem vollständig kompatibel zur aktuell vorhandenen und von FHEM unterstützen Hardware. Das derzeit empfohlene Standard-Image zum Betrieb des Raspberry Pi ist die auf Debian 7.0 Wheezy basierende Raspbian Distribution.

== Installation / Setup ==
=== Betriebssystem ===
Das Betriebssystem sollte direkt bei Raspberry unter dem Link [http://www.raspberrypi.org/downloads http://www.raspberrypi.org/downloads] ([http://downloads.raspberrypi.org/raspbian_latest Raspbian]) geholt werden.

Nach dem Herunterladen des entsprechenden Archivs muss das Image entpackt und auf die Speicherkarte (SD-Karte bis Modell B / MicroSD ab Modell B+) geschrieben werden. Detaillierte englische Anleitungen zum Vorgehen für verschiedene Betriebssysteme stellt Raspberry [http://www.raspberrypi.org/documentation/installation/installing-images/README.md hier] zur Verfügung.

Unter '''Unix/Linux''' erfolgt dies via dd-Befehl. Zum Beispiel:
:<code>sudo dd bs=1M if=2012-08-16-wheezy-raspbian.img of=/dev/sdz</code>

'''Achtung:''' Bei Angabe eines falschen Device hinter of= kann der Anfang der eigenen Festplatte überschrieben werden. (Datenverlust!)

Je nach System/Distribution und vorhandenen Festplatten variiert das Device, z.B. /dev/mmcblk0 (Ubuntu), /dev/sdb, /dev/sdc oder /dev/rdisk1 (OSX). Folgende Möglichkeiten können helfen, das richtige Device zu ermitteln:
* Mit dem Befehl <code>df</code> erhält kann eine Übersicht aller angeschlossenen und gemounteten(!) Speichermedien.
* Beim Einstecken der Speicherkarte in den PC wird in die Log-Datei <code>/var/log/messages</code> ein Eintrag gemacht. Beispiel: <code>kernel: [2077612.776470] sd 14:0:0:0: ['''sdb'''] 7954432 512-byte logical blocks: ('''4.07 GB'''/3.79 GiB)</code>
* Mit dem Befehl fdisk kann die Größe eines bestimmten Devices geprüft werden: <code>fdisk -l /dev/sdb</code> Beispielausgabe: <code>Platte /dev/sdb: 4072 MByte, 4072669184 Byte</code>

Unter '''Windows''' kann das Tool [https://launchpad.net/win32-image-writer Win32DiskImager] genutzt werden.

Nach der Installation des Images sollte der Raspberry Pi von der Speicherkarte booten.

Um eventuell eine größere Speicherkarte komplett zu nutzen, kann dies per folgendem Menu erledigt werden:
:<code>sudo raspi-config</code>

Stand 08/14 grundsätzlich nicht mehr notwendig: Es kann erforderlich sein, einen KernelUpdate einzuspielen, um einen USB-Bug zu beheben. Dieses Update ist zu finden auf [https://github.com/Hexxeh/rpi-update github].

=== Fhem ===
Die Installation auf dem Raspberry Pi kann nach der Installation des Betriebssystems über das Debian-Repository von Fhem, automatisiert per Skript oder auch manuell vorgenommen werden.

==== Debian-Repository ====
Seit Oktober 2014 ({{Link2Forum|Topic=27679}}) kann Fhem auf Debian-basierten Systemen, wozu auch Raspian OS zählt, aus einem Debian-Repository installiert werden. Dabei werden neben Fhem selbst alle für den Betrieb von Fhem unabdingbaren Pakete automatisch mit installiert und eine Reihe weiterer Pakete für die Installation vorgeschlagen. Details zur Vorgehensweise finden sich direkt auf [https://debian.fhem.de https://debian.fhem.de].

'''Hinweis:''' Bei manchen Distributionen ist es erforderlich die apt-Methode HTTPS nachzuinstallieren. Der folgende Befehl installiert die Methode:
<pre>sudo apt-get install apt-transport-https</pre>

==== Skript-basiert ====
Durch Ausführung des in diesem {{Link2Forum|Topic=15848|Message=103268}} dargestellten Skriptes nach Installation eines "nackten" Raspian OS wird automatisiert ein funktionsfähiges Fhem (inkl. korrekter Rechtevergabe) auf dem Raspberry Pi installiert.

'''Hinweis:''' Bei dieser Installationsweise erfolgt kein automatischer Start von fhem. Um das zu erreichen, verwenden Sie die folgende "manuelle" Methode.

==== Manuell ====
Die Installation von FHEM auf dem Raspberry Pi kann mit dem fertigen debian-package erledigt werden. Lediglich das Perl-Modul "Serialport" wird benötigt - Perl ist in der Regel bereits installiert, kann aber sicherheitshalber einfach mit dem apt-get-Befehl zugefügt werden:

sudo apt-get install perl libdevice-serialport-perl
sudo apt-get install libio-socket-ssl-perl
# fhem-X.Y.deb bitte mit der [http://fhem.de/fhem.html#Download aktuellsten, stabilen Version] ersetzen
wget [http://fhem.de/fhem-X.Y.deb http://fhem.de/fhem-X.Y.deb]
sudo dpkg -i fhem-X.Y.deb

Möglicherweise ist es noch nötig, fehlende Abhängigkeiten aufzulösen. Das kann mit folgendem Befehl erledigt werden:
:<code>sudo apt-get install -f</code>

Eine etwas ausführlichere Anleitung gibt es auch [http://www.fhemwiki.de/wiki/FHEM_auf_Raspberry_PI_mit_COC_betreiben#FHEM_Installieren hier]

=== Nützliche Zusatzpakete ===
Nachdem der Rpi eingerichtet ist, können weitere Pakete installiert werden. Keines davon ist zwingend erforderlich, um fhem grundsätzlich betreiben zu können. Einige Pakete erhöhen aber den Bedienungskomfort oder sind zur Nutzung bestimmter fhem-Module erforderlich. Hier eine Übersicht.
{| class="wikitable"
! style="width:10%" | Beschreibung
! style="width:10%" | Paketname
! style="width:50%" | Kontext
! style="width:30%" | Installieren
|-
|fhem
|fhem
|Installiert eine komplett lauffähige fhem-Installation.
Details siehe auf [https://debian.fhem.de/ Stable build using aptitude], für Optionen siehe diesen [http://forum.fhem.de/index.php/topic,27679.0.html Forumsartikel]
Achtung: In der Befehlsliste rechts erstreckt sich der erste Befehl über 2 Zeilen!
| <code>sudo wget -qO - https://debian.fhem.de/archive.key <nowiki>|</nowiki> apt-key add -</code>
<code>sudo deb https://debian.fhem.de/stable ./</code>
<code>sudo apt-get update</code><br>
<code>sudo apt-get install fhem</code>
|-
|Zeitserver
|ntpdate
|Setzt die Systemzeit bei Start des RPi. Wird für fhem benötigt, da es sonst nicht startet.
|<code>sudo apt-get install ntpdate
sudo ntpdate -u de.pool.ntp.org</code>
|-
|Perl JSON
|JSON
|Wird von einigen Modulen benötigt, z.B. harmony, iTunes
|<code>apt-get install libjson-perl</code>
|-
|Samba-Server
|samba
|Mittels Samba kann man z.B. den Ordner /opt/fhem als Share freigeben. Dieser Share kann z.B. im Windows-Explorer als Laufwerk verbunden werden, so dass die Bearbeitung von config- und Programmdateien bequem möglich ist. Hier eine hilfreiche [https://chirale.wordpress.com/2012/08/31/turn-raspberry-into-a-small-nas-with-samba/ Kurzanleitung] aus der (wenn man auf einen speziellen user verzichtet) nur die Einträge für smb.conf gesetzt werden müssen.
|<code>sudo apt-get install samba cifs-utils</code>
Danach muss der share definiert werden mittels

<code>sudo nano /etc/samba/smb.conf</code>
|-
|Mailversand
|sendEmail
|Wird benötigt, um Mails versenden zu können, bspw. für Alarm-Benachrichtigungen.
Nach Installation des Paketes benötigt man noch eine Routine in fhem gemäß [http://www.fhemwiki.de/wiki/E-Mail_senden#Raspberry_Pi diesem Forumsartikel]
|<code>sudo apt-get install sendEmail</code>
|-
|Wake-on-LAN
|etherwake
|Wird z.B. für das Modul WOL benötigt.
|<code>sudo apt-get install etherwake</code>
|-
|Perl Telnet
|telnet
|Wird z.B. für das Modul FRITZBOX benötigt, da es eine im Netzwerk vorhandene Fritzbox über deren Telnet-Port anspricht.
|<code>sudo apt-get install libnet-telnet-perl</code>
|-
|Socat
|socat
|Kann verwendet werden, um auf anderen Rechnern im Netzwerk Linux-Befehle oder Skripts auszuführen. Auch können auf Slave-fhem-Installationen Befehl ausgeführt werden, z.B. mit

<code><nowiki>system("echo 'set lampe on' | /usr/bin/socat - TCP:1.2.3.4:7072");</nowiki></code>

1.2.3.4 muss natürlich durch die IP-Adresse des Zielrechners ersetzt werden.
|<code>sudo apt-get install socat</code>
|-
|Libcrypt
|Libcrypt
|Perl libcrypt, erforderlich falls Homematic-devices mit AES verwendet werden sollen.
|<code>sudo apt-get install libcrypt-rijndael-perl</code>
|-
|libdatetime
|libdatetime
|Perl libdatetime, erforderlich für das Weather-Modul.
|<code>sudo apt-get install libdatetime-format-strptime-perl</code>
|}

== Bekannte Probleme ==
=== Netzteil ===
Der RPi verwendet ein USB Netzteil als Spannungsversorgung. Gemessen kann der RPi allein bereits um die 900mA Strom fordern. Das bringt kleine Netzteile, besonders wenn noch CULs oder WLAN Sticks an USB hängen schnell an die Grenze. Die Fehler die daraus resultieren sind Abstürze, Netzwerkprobleme uvm. Daher bitte ein ausreichend starkes Netzteil mit mind. 2000mA oder einen aktiven USB-HUB für die Periperie verwenden.

=== Echtzeituhr ===
Der RPi hat keine [http://de.wikipedia.org/wiki/Echtzeituhr Real-Time-Clock] (RTC), das heißt, dass er nach einem Neustart keine gültige (im Sinne von aktuell) Systemzeit hat, sondern ein Datum in der Vergangenheit. Dieses Problem wird sinnvollerweise mit einer [http://de.wikipedia.org/wiki/Network_Time_Protocol NTP-Konfiguration] umgangen.

Dabei muss Sorge getragen werden, dass der [http://wiki.debian.org/NTP ntpd] schon einen Datums-/Zeitabgleich gemacht hat, bevor FHEM gestartet wird. Geschieht der Abgleich nicht vorher, sondern erst nachdem FHEM schon läuft, stellt FHEM die Logs zwar auf das nun aktuelle Datum um (die "alten" Logs mit dem eigentlich ungültigen Datum werden natürlich behalten), aber irgendetwas scheint FHEM dabei so zu belasten, dass es eine Last von über 0.8 bis 0.9 erzeugt. Diese Last besteht auf Dauer und verschwindet erst, wenn man das Ganze sauber durchkonfiguriert und FHEM neu gestartet hat. Die hohe Systemauslastung zeigt sich auch in einem sehr trägen Laden der FHEM-Webseiten in einem beliebigen Browser.

=== Last durch Backup (während update) ===
Bei einen Update von FHEM durch den Befehl <code>update</code> kann ein Backup durchgeführt werden. Die (ggf. großen) Log-Dateien werden dabei ebenfalls archiviert. Während der Archivierung ist FHEM blockiert. Durch die beschränkte Leistungsfähigkeit des Raspberry Pi kann das Backup lange dauern. Durch Setzen des Attributs "<code>attr global backup_before_update 1</code>" wird beim Update ein Backup erstellt. Dies war bis 18.08.2014 die Standardeinstellung, seitdem ist es standardmäßig ausgeschaltet und es gibt weitere Neuerungen (siehe [[FHEM_Command_Beispiele#update_...|update]]). Durch ein "<code>attr global updateInBackground 1</code>" wird ein Backup im Hintergrund ausgeführt (Quelle: {{Link2Forum|Topic=15729}}).

Alternative Möglichkeiten:
* Backup ausschalten und manuell durchführen
* Backup-Befehl anpassen und so große Dateien bzw. Verzeichnisse (log/) nicht archivieren

== Watchdog einrichten ==
Vor allem wenn das Netzteil nicht stark genug ist, schmiert fhem gelegentlich ab (siehe oben - Netzteil). Man kann den RPi alle halbe Stunde prüfen lassen, ob fhem noch läuft, und ggf. einen Neustart durchführen lassen.
Wie man das einrichtet steht hier: [http://forum.fhem.de/index.php/topic,20553.0.html Einrichten eines Watchdog]

== Interne Links ==
* Erste Schritte: [[FHEM auf Raspberry PI mit COC betreiben]]
* [[CUL am Raspberry Pi flashen]]
* [[Raspberry Pi und 1-Wire]]

== Externe Links ==
* {{Link2Forum|Topic=33460|Message=264679}} zum Umzug von Raspberry B auf Raspberry Pi 2
* [http://www.raspberrypi.org/ Offizielle Webseite der Raspberry Pi Foundation]
* [http://www.raspberrypi.org/downloads Offizielle Downloads der Raspberry Pi Foundation]
* Blog mit dem Thema [http://www.meintechblog.de/2013/05/fhem-server-auf-dem-raspberry-pi-in-einer-stunde-einrichten/ FHEM-Server auf RaspBerry Pi in einer Stunde einrichten]

[[Kategorie:Raspberry Pi]]
[[Kategorie:HOWTOS]]

FHTTK: Benachrichtigung bei offenem Fenster

2015-11-15T17:29:58Z

Uli: Beispiel-confi-Auszug umgestellt von @/% auf $NAME/$EVENT

Wer wird nicht gerne per Mail benachrichtigt, wenn ein Fenster auf- oder zugemacht wird? Richtig komfortabel ist es, wenn man dann auch noch gleich eine Liste aller FHTTK-devices mitgeliefert bekommt, die den Status "Window: Open" haben:

in 99_marte.pm

<nowiki>sub FHTTK_status {
my @fhttks = devspec2array("TYPE=CUL_FHTTK");
my @wopen = ();
foreach(@fhttks) {
my $fhttk_window = ReadingsVal($_, "Window", "nA");
push (@wopen,$_) if ($fhttk_window eq "Open" );
}
my $num_wopen = @wopen;
my $resultstring='';
if ( $num_wopen gt 0 ) {
$resultstring="folgende Fenster sind noch offen:\n\n";
foreach(@wopen) {
$resultstring.="- ".$_."\n";
Log 4, "FHTTK_status: ". $_. "noch offen";
}
} else {
$resultstring="alle Fenster sind derzeit geschlossen.";
}
return $resultstring;
}</nowiki>
in die Config

<nowiki>define n_Fenster notify .*:Window.*(Open|Closed) { \
my $window_state=ReadingsVal("$NAME", "Window", "nA");;\
my $deftype=$defs{$NAME}{TYPE};;\
return if ( $deftype ne "CUL_FHTTK" );;\
if ( $defs{$NAME}{PREVSTATE} ne $window_state ) { \
my $fhttk_status=FHTTK_status;;\
my $subject="FHEM: Fenster $NAME ".$window_state;; \
fb_mail('xxx@@xxx.de',$subject,$fhttk_status);;\
Log 3, "$NAME: Window ".$window_state;;\
}\
}</nowiki>
Achtung: Hier wird fb_mail als Mailer benutzt (siehe auch [[E-Mail senden]]) - je nach *nix-Version muss u.U. der Pfad angepasst sowie die entsprechenden Codezeilen in die .pm-Datei übernommen werden.

Randbemerkung zum Config-Code: Ein "notify <sensor>:Open" alleine reicht nicht. Da der Sensor in alle 2 Minuten seinen Status sendet, muss zudem der vorherige Status abgefragt werden, um nur bei Statusänderungen zu reagieren.
[[Kategorie:Code Snippets]]

Wakeuplight

2015-10-18T13:37:10Z

Uli: /* Code */

Set up a wakeup light which will slowly dim-up a lamp, e.g. at your bedside, and will switch it off again after a certain time.
The solution requires a dimmer hardware device, e.g. FS20-di. In the example below the dimmer is named Lamp1.

== Code ==
For FS20:
define wakeup at *07:00:00 {\
if (!$we) {\
fhem "set Lamp1 dim100% 1280";;\
fhem "define wakeupOff at +00:40:00 set Lamp1 off";;\
}\
}

For Homematic:
define wakeup at *07:00:00 {\
if (!$we) {\
fhem "set Lamp1 95 3600 1200";;\
}\
}

Explanation:

The time indicated for wakeup (here: 7am) is the starting-time of the dim-procedure. The asterisk indicates this procedure shall be executed every day.

The program uses the variable $we (weekend), so your wakeuplight will only turn on on weekdays. If you implement [http://fhem.de/commandref.html#holiday2we holiday2we], the wakeuplight will also remain off on holidays.

For FS20, the set-command ''set sz_Nachtischlampe dim100% 1280'' will dim the lamp to 100% over a timespan of 1280 seconds, i.e. 21 minutes. Finally, the off-command is scheduled for 40 minutes from wakeuptime.

For Homematic ''set Lamp1 95 3600 1200'' will dim the lamp slowly up to 95% over a timespan if 1200sec (20 min) and switch it off after 3600sec (1h).

== Change of wakeuptime ==
To change the wakeuptime to e.g. 8am, type the following into the input-field on the fhem-frontend:

<nowiki>modify wakeup *08:00:00</nowiki>

== Change of wakeuptime using sliders ==
Setting the wakeuptime using the "modify wakeup" command is inconvenient. Especially forgetting to set the asterisk (*) is a pain, as the wakeup-definition will disappear after next execution.
To avoid this pitfall, there is an option to add an additional pseudo-device which offers sliders to set the wakeup time:

<nowiki>define wakeupChange dummy
attr wakeupChange setList state:time
attr wakeupChange webCmd state
define n_wakeupChange notify wakeupChange {fhem("modify wakeup *%");;}</nowiki>

Explanation: A dummy device wakeupChange is defined. It carries sliders to select the wakeuptime. Subsequently, a notify is defined, which gets triggered whenever a time is selected using the sliders. This chosen time is then used to execute the 'modify wakeup'-command for the actual wakeup-device.

== Save the time even after a restart or rereadcfg ==
Because you don't want (to remember) to adjust the modified time after even restart or rereadcfg it is also possible to reread it from the ReadingsVal:

<nowiki>define n_wakeupChange notify (wakeupChange|global:INITIALIZED|global:REREADCFG).* \
modify wakeup *{ReadingsVal("wakeupChange","state","05:30")}</nowiki>

Explanation: We modify the previousley created dummy device wakeupChange so the notify is not just triggered when calling wakeupChange but also when we restart (global:INITIALIZED) or reread the configuration (global:REREADCFG). At last you should enter a fallback value in the modify, in case the given value isn't valid.

== A small enhancement ==
Sometimes it happen, that you don't want to use your WakeUp-Function every day. So you can add a button to use it eg just on weekdays or on weekend. For that, we have to add a dummy:

<nowiki>define wakeUpStatus dummy
attr wakeUpStatus alias WeckerStatus
attr wakeUpStatus setList state:off,oneTime,daily,weekdays,weekend
attr wakeUpStatus webCmd state
</nowiki>

After that we have to change the defined wakeUp-at with:
<nowiki>define wakeUp at *{ReadingsVal("wakeUpChange","state","05:30")} { \
if ( ( Value("wakeUpStatus") eq "weekdays" && !$we ) || ( Value("wakeUpStatus") eq "weekend" && $we ) || \
( Value("wakeUpStatus") eq "daily" ) || ( Value("wakeUpStatus") eq "oneTime" ) ) { \
{ fhem ("set Lamp1 dim100% 1280") } \
{ fhem ("define wakeupOff at +00:40:00 set Lamp1 off") } \
if ( Value("wakeUpStatus") eq "oneTime" ) { fhem ("set wakeUpStatus off") } \
} \
}</nowiki>

From now on you can choose between daily, weekdays, weekend, one time and off.

[[Kategorie:Code Snippets]]

HM-Sec-MDIR Funk-Bewegungsmelder innen

2015-10-14T19:04:42Z

Uli: /* Timer hinterlegen */

Homematic Bewegungsmelder für Innen
== Features ==
Infrarotbewegungsmelder für den Innenbereich im drehbaren Gehäuse, Betrieb mit 4 Mignon Zellen, sendet neben Auslösung auch Helligkeitswerte, Batteriezustand und Zustand des Gehäuses (Cover closed or open). Programmierung über Register per Funk.

== Hinweise zum Betrieb mit FHEM ==
Das Pairing sollte wie in [[HomeMatic Devices pairen]] beschrieben durchgeführt werden. Der Sensor muss hierfür geöffnet und die Anlerntastebetätigt werden. Hierbei gibt es zwei Konfigurationsmöglichkeiten:

* Anlerntaste kurz betätigen, um den Bewegungsmelder ohne Helligkeitsschwelle anzulernen
* Anlernen mit Helligkeitsschwelle. Siehe Bedienungsanleitung S. 14f.

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der fhem.cfg:

<nowiki>define EG_Bewegungsmelder CUL_HM 19xxxx
attr EG_Bewegungsmelder .devInfo 810100
attr EG_Bewegungsmelder .stc 81
attr EG_Bewegungsmelder actCycle 000:10
attr EG_Bewegungsmelder actStatus alive
attr EG_Bewegungsmelder expert 2_full
attr EG_Bewegungsmelder firmware 1.0
attr EG_Bewegungsmelder model HM-SEC-MDIR
attr EG_Bewegungsmelder peerIDs
attr EG_Bewegungsmelder room Z_Alarm
attr EG_Bewegungsmelder serialNr JEQ00xxxxx
attr EG_Bewegungsmelder subType motionDetector</nowiki>
=== Konfiguration über Register ===
==== Anzeige aller dekodierten Register ====
<nowiki>get <name> regList</nowiki>
zeigt alle moeglichen 'dekodierten' Register an. Fuer mdir sind dies alle, sollte also komplett sein. Hier findet man sowohl den Wertebereich alsauch eine (sehr) kleine Beschreibung.
Ausgabe:

<nowiki>
list: register | range | peer |exp| description
0: intKeyVisib | - to - | |exp| visibility of internal channel options:visib,invisib
0: pairCentral | 0 to 16777215 | | | pairing to central
0: sabotageMsg | - to - | | | enable sabotage message options:on,off
1: brightFilter | 0 to 7 | | | brightness filter - ignore light at night
1: captInInterval | - to - | | | capture within interval options:on,off
1: evtFltrNum | 1 to 15 | | | sensitivity - read sach n-th puls
1: evtFltrPeriod | 0.5 to 7.5s | | | event filter period
1: ledOnTime | 0 to 1.275s | |exp| LED ontime
1: minInterval | - to - | | | minimum interval in sec options:240,60,120,30,15
4: peerNeedsBurst | - to - | required | | peer expects burst options:on,off
</nowiki>
==== Auslesen der register aus dem device ====
<nowiki>set <name> getConfig</nowiki>
Einige Register werden direkt in den Readings angezeigt, das sind die Wichtigsten. Bei Anwendung auf ein "device" werden auch die Kanaele ausgelesen, bei Kanal nur der Kanal.
Die Anzeige der Register in den Readings ist R-<regname>. Der "R-" prefix dient zur Sortierung und auch zur einfacheren Identifizierung, dass es ein Register ist.

==== Editieren von Registerwerten ====

Um z.B. das Meldeintervall von standardmäßig 240sek. auf 60sek. herabzusetzen:

<pre>get EG_Bewegungsmelder regList
set EG_Bewegungsmelder getConfig</pre>
Anlernen drücken
<pre>get EG_Bewegungsmelder reg all
set EG_Bewegungsmelder regSet minInterval 60</pre>

Dann wieder kurz anlernen drücken um die Daten auf den Sensor zu übertragen und mit
<pre>set EG_Bewegungsmelder getConfig</pre>
Daten wieder auslesen, ob alles geklappt hat und mit
<pre>get EG_Bewegungsmelder reg all</pre>
anzeigen lassen. Wenn noch vor den Werten ein set_ steht, z.B. set_60 wurde der Befehl noch nicht übertragen. Erstmal eine Minute abwarten, dann einfach nochmal kurz anlernen drücken und die letzten beiden Schritte wiederholen.
Die Einstellungen können mit
<pre>get EG_Bewegungsmelder saveConfig EG_Bewegungsmelder.bak</pre>
gespeichert werden. Dann wird eine Datei namens EG_Bewegungsmelder.bak in eurem fhem-root Verzeichnis mit den Einstellungen abgelegt.

== Mögliche Zustände ==
=== Log-Auszug ===
In FHEM sind folgende Zustände des HM-Sec-MDIR im Log zu sehen:

<nowiki>2012-05-30_16:17:26 EG_Bewegungsmelder motion
2012-05-30_16:17:26 EG_Bewegungsmelder motion: on (to broadcast)
2012-05-30_16:18:34 EG_Bewegungsmelder brightness: 43
2012-05-30_16:18:34 EG_Bewegungsmelder alive
2012-05-30_16:18:34 EG_Bewegungsmelder cover: closed</nowiki>

== Spezielle Konfigurationen ==
=== Timer hinterlegen ===
Hier ein kommentiertes Beispiel aus dem Forum, um eine Lampe durch einen Bewegungsmelder einschalten zu lassen - allerdings nicht dauerhaft, sondern für einen konfigurierbaren Zeitraum:
set Kueche_Bewegungsmelder peerChan 0 Kueche_Lampe single
#Peeren der Geräte Bewegungsmelder und Steckdose

set Kueche_Bewegungsmelder regSet minInterval 120
# Bewegungsmelder so einstellen, dass er frühstens nach 120 Sec einen neuen Motion Befehl sendet

set Kueche_Lampe regSet shOnTime 180 Kueche_Bewegungsmelder
# Setzt den on-for-Timer auf 180 Sec

set Kueche_Lampe regSet shSwJtOn on Kueche_Bewegungsmelder
# sorgt dafür, dass der Aktor nicht beim zweiten Impuls des Bewegungsmelders wieder aus-, sondern immer wieder eingeschaltet wird (Zeitverlängerung)

set Kueche_Lampe regSet shCtValLo 0 Kueche_Bewegungsmelder
# Legt fest, ab welcher "Dunkelheit" der Schaltaktor schalten soll

Mit shCtValHi kann man dann ab einer gewissen Helligkeit das Schalten verhindern (z.B. am Tag)

== Bekannte Probleme ==
Im Gegensatz zu identisch aussehenden FS20 Bewegungsmeldern leuchtet die LED bei Bewegung im Auslieferungszustand nicht auf. Dies ist aber kein Defekt, sondern im Register so eingestellt. Im Auslieferungszustand ist
ledOnTime :0 s
Dies ist (auf Kosten der Batterielebensdauer) wie oben unter '''Konfiguration über Register''' beschrieben änderbar.

Wie bei allen Bewegungsmelder ist Vorsicht angebracht, wenn die Meldeintervalle verkürzt werden. Standard ist alle 240 sek. Bei kürzeren Intervallen wird das Sendekontingent schneller aufgebraucht. Zwar ist bei HM die Datenaussendung wegen der hohen Übertragungsrate recht kurz, sodass keine unmittelbare Gefahr besteht, wenn jedoch über dem HM Bewegungsmelder mittels FHEM SlowRF Komponenten (FS20, FHT) gesteuert werden, kann es je nach Auslegung der Konfiguration zu häufigen Auslösungen und schnellem Kontingentverbrauch kommen.

== Links ==
Anleitung [http://www.elv-downloads.de/service/manuals/76675_HM_Sec_MDIR_GE_V1_0.pdf] PDF

[[Kategorie:HomeMatic Components]]
[[Kategorie:Bewegungs- und Anwesenheitsmelder]]

HM-Sec-MDIR Funk-Bewegungsmelder innen

2015-10-14T19:03:28Z

Uli: Beispielkonfiguration für Timer hinzugefügt

Homematic Bewegungsmelder für Innen
== Features ==
Infrarotbewegungsmelder für den Innenbereich im drehbaren Gehäuse, Betrieb mit 4 Mignon Zellen, sendet neben Auslösung auch Helligkeitswerte, Batteriezustand und Zustand des Gehäuses (Cover closed or open). Programmierung über Register per Funk.

== Hinweise zum Betrieb mit FHEM ==
Das Pairing sollte wie in [[HomeMatic Devices pairen]] beschrieben durchgeführt werden. Der Sensor muss hierfür geöffnet und die Anlerntastebetätigt werden. Hierbei gibt es zwei Konfigurationsmöglichkeiten:

* Anlerntaste kurz betätigen, um den Bewegungsmelder ohne Helligkeitsschwelle anzulernen
* Anlernen mit Helligkeitsschwelle. Siehe Bedienungsanleitung S. 14f.

=== FHEM Config-Auszug ===
Ein exemplarischer Auszug aus der fhem.cfg:

<nowiki>define EG_Bewegungsmelder CUL_HM 19xxxx
attr EG_Bewegungsmelder .devInfo 810100
attr EG_Bewegungsmelder .stc 81
attr EG_Bewegungsmelder actCycle 000:10
attr EG_Bewegungsmelder actStatus alive
attr EG_Bewegungsmelder expert 2_full
attr EG_Bewegungsmelder firmware 1.0
attr EG_Bewegungsmelder model HM-SEC-MDIR
attr EG_Bewegungsmelder peerIDs
attr EG_Bewegungsmelder room Z_Alarm
attr EG_Bewegungsmelder serialNr JEQ00xxxxx
attr EG_Bewegungsmelder subType motionDetector</nowiki>
=== Konfiguration über Register ===
==== Anzeige aller dekodierten Register ====
<nowiki>get <name> regList</nowiki>
zeigt alle moeglichen 'dekodierten' Register an. Fuer mdir sind dies alle, sollte also komplett sein. Hier findet man sowohl den Wertebereich alsauch eine (sehr) kleine Beschreibung.
Ausgabe:

<nowiki>
list: register | range | peer |exp| description
0: intKeyVisib | - to - | |exp| visibility of internal channel options:visib,invisib
0: pairCentral | 0 to 16777215 | | | pairing to central
0: sabotageMsg | - to - | | | enable sabotage message options:on,off
1: brightFilter | 0 to 7 | | | brightness filter - ignore light at night
1: captInInterval | - to - | | | capture within interval options:on,off
1: evtFltrNum | 1 to 15 | | | sensitivity - read sach n-th puls
1: evtFltrPeriod | 0.5 to 7.5s | | | event filter period
1: ledOnTime | 0 to 1.275s | |exp| LED ontime
1: minInterval | - to - | | | minimum interval in sec options:240,60,120,30,15
4: peerNeedsBurst | - to - | required | | peer expects burst options:on,off
</nowiki>
==== Auslesen der register aus dem device ====
<nowiki>set <name> getConfig</nowiki>
Einige Register werden direkt in den Readings angezeigt, das sind die Wichtigsten. Bei Anwendung auf ein "device" werden auch die Kanaele ausgelesen, bei Kanal nur der Kanal.
Die Anzeige der Register in den Readings ist R-<regname>. Der "R-" prefix dient zur Sortierung und auch zur einfacheren Identifizierung, dass es ein Register ist.

==== Editieren von Registerwerten ====

Um z.B. das Meldeintervall von standardmäßig 240sek. auf 60sek. herabzusetzen:

<pre>get EG_Bewegungsmelder regList
set EG_Bewegungsmelder getConfig</pre>
Anlernen drücken
<pre>get EG_Bewegungsmelder reg all
set EG_Bewegungsmelder regSet minInterval 60</pre>

Dann wieder kurz anlernen drücken um die Daten auf den Sensor zu übertragen und mit
<pre>set EG_Bewegungsmelder getConfig</pre>
Daten wieder auslesen, ob alles geklappt hat und mit
<pre>get EG_Bewegungsmelder reg all</pre>
anzeigen lassen. Wenn noch vor den Werten ein set_ steht, z.B. set_60 wurde der Befehl noch nicht übertragen. Erstmal eine Minute abwarten, dann einfach nochmal kurz anlernen drücken und die letzten beiden Schritte wiederholen.
Die Einstellungen können mit
<pre>get EG_Bewegungsmelder saveConfig EG_Bewegungsmelder.bak</pre>
gespeichert werden. Dann wird eine Datei namens EG_Bewegungsmelder.bak in eurem fhem-root Verzeichnis mit den Einstellungen abgelegt.

== Mögliche Zustände ==
=== Log-Auszug ===
In FHEM sind folgende Zustände des HM-Sec-MDIR im Log zu sehen:

<nowiki>2012-05-30_16:17:26 EG_Bewegungsmelder motion
2012-05-30_16:17:26 EG_Bewegungsmelder motion: on (to broadcast)
2012-05-30_16:18:34 EG_Bewegungsmelder brightness: 43
2012-05-30_16:18:34 EG_Bewegungsmelder alive
2012-05-30_16:18:34 EG_Bewegungsmelder cover: closed</nowiki>

== Spezielle Konfigurationen ==
=== Timer hinterlegen ===
Hier ein kommentiertes Beispiel aus dem Forum, eum in der Kueche eine Lampe durch einen Bewegungsmelder einschalten zu lassen - allerdings nicht dauerhaft, sondern für einen konfiguruerbaren Zeitraum:
set Kueche_Bewegungsmelder peerChan 0 Kueche_Lampe single
#Peeren der Geräte Bewegungsmelder und Steckdose

set Kueche_Bewegungsmelder regSet minInterval 120
# Bewegungsmelder so einstellen, dass er frühstens nach 120 Sec einen neuen Motion Befehl sendet

set Kueche_Lampe regSet shOnTime 180 Kueche_Bewegungsmelder
# Setzt den on-for-Timer auf 180 Sec

set Kueche_Lampe regSet shSwJtOn on Kueche_Bewegungsmelder
# sorgt dafür, dass der Aktor nicht beim zweiten Impuls des Bewegungsmelders wieder aus-, sondern immer wieder eingeschaltet wird (Zeitverlängerung)

set Kueche_Lampe regSet shCtValLo 0 Kueche_Bewegungsmelder
# Legt fest, ab welcher "Dunkelheit" der Schaltaktor schalten soll

Mit shCtValHi kann man dann ab einer gewissen Helligkeit das Schalten verhindern (z.B. am Tag)

== Bekannte Probleme ==
Im Gegensatz zu identisch aussehenden FS20 Bewegungsmeldern leuchtet die LED bei Bewegung im Auslieferungszustand nicht auf. Dies ist aber kein Defekt, sondern im Register so eingestellt. Im Auslieferungszustand ist
ledOnTime :0 s
Dies ist (auf Kosten der Batterielebensdauer) wie oben unter '''Konfiguration über Register''' beschrieben änderbar.

Wie bei allen Bewegungsmelder ist Vorsicht angebracht, wenn die Meldeintervalle verkürzt werden. Standard ist alle 240 sek. Bei kürzeren Intervallen wird das Sendekontingent schneller aufgebraucht. Zwar ist bei HM die Datenaussendung wegen der hohen Übertragungsrate recht kurz, sodass keine unmittelbare Gefahr besteht, wenn jedoch über dem HM Bewegungsmelder mittels FHEM SlowRF Komponenten (FS20, FHT) gesteuert werden, kann es je nach Auslegung der Konfiguration zu häufigen Auslösungen und schnellem Kontingentverbrauch kommen.

== Links ==
Anleitung [http://www.elv-downloads.de/service/manuals/76675_HM_Sec_MDIR_GE_V1_0.pdf] PDF

[[Kategorie:HomeMatic Components]]
[[Kategorie:Bewegungs- und Anwesenheitsmelder]]

Erste Schritte in FHEM

2015-10-03T18:09:47Z

Uli: /* Devices löschen oder deaktivieren – delete, disable */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button {{Taste|attr}} klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.
{{Hinweis|Im Block '''''Probably associated with'''''' werden alle fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.}}

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf ''Schulungsraum'' klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify keinem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' und den Wert ''1'' auswählen, dann {{Taste|attr}} klicken), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also {{Taste|modify n_mySchalter1}}. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.

[[Datei:ErsteSchritteInFhem14B.png]]

Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Über den Link '''''Device specific help''''' können Sie sich übrigens den gesamten Hilfe-Text zu Ihrem device-Typ aus der commandref anschauen, hier also den Hilfetext zu ''notify''. Dieser Link ist gerade zu Beginn häufig hilfreich.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

Im Detailscreen eines ''at'' wird übrigens im ''STATE'' der Zeitpunkt der nächsten Ausführung angezeigt.

Diese Info erscheint auch in der Raum-Ansicht, falls Sie das ''at'' dort anzeigen lassen:

[[Datei:ErsteSchritteInFhem18B.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-03T18:06:52Z

Uli: /* Bei Event ausführen - notify */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button {{Taste|attr}} klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.
{{Hinweis|Im Block '''''Probably associated with'''''' werden alle fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.}}

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf ''Schulungsraum'' klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify keinem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also {{Taste|modify n_mySchalter1}}. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.

[[Datei:ErsteSchritteInFhem14B.png]]

Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Über den Link '''''Device specific help''''' können Sie sich übrigens den gesamten Hilfe-Text zu Ihrem device-Typ aus der commandref anschauen, hier also den Hilfetext zu ''notify''. Dieser Link ist gerade zu Beginn häufig hilfreich.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

Im Detailscreen eines ''at'' wird übrigens im ''STATE'' der Zeitpunkt der nächsten Ausführung angezeigt.

Diese Info erscheint auch in der Raum-Ansicht, falls Sie das ''at'' dort anzeigen lassen:

[[Datei:ErsteSchritteInFhem18B.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-03T18:03:23Z

Uli: /* Bei Event ausführen - notify */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button {{Taste|attr}} klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.
{{Hinweis|Im Block '''''Probably associated with'''''' werden alle fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.}}

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also {{Taste|modify n_mySchalter1}}. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.

[[Datei:ErsteSchritteInFhem14B.png]]

Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Über den Link '''''Device specific help''''' können Sie sich übrigens den gesamten Hilfe-Text zu Ihrem device-Typ aus der commandref anschauen, hier also den Hilfetext zu ''notify''. Dieser Link ist gerade zu Beginn häufig hilfreich.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

Im Detailscreen eines ''at'' wird übrigens im ''STATE'' der Zeitpunkt der nächsten Ausführung angezeigt.

Diese Info erscheint auch in der Raum-Ansicht, falls Sie das ''at'' dort anzeigen lassen:

[[Datei:ErsteSchritteInFhem18B.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-03T18:02:44Z

Uli: /* Schalten von Geräten - set */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button {{Taste|attr}} klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.
{{Hinweis|Im Block '''''Probably associated with'''''' die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.}}

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also {{Taste|modify n_mySchalter1}}. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.

[[Datei:ErsteSchritteInFhem14B.png]]

Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Über den Link '''''Device specific help''''' können Sie sich übrigens den gesamten Hilfe-Text zu Ihrem device-Typ aus der commandref anschauen, hier also den Hilfetext zu ''notify''. Dieser Link ist gerade zu Beginn häufig hilfreich.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

Im Detailscreen eines ''at'' wird übrigens im ''STATE'' der Zeitpunkt der nächsten Ausführung angezeigt.

Diese Info erscheint auch in der Raum-Ansicht, falls Sie das ''at'' dort anzeigen lassen:

[[Datei:ErsteSchritteInFhem18B.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

FLOORPLAN

2015-10-03T15:19:12Z

Uli:

{{Infobox Modul
|ModPurpose=Darstellung von Fhem-Objekten auf einem Hintergrundbild
|ModType=h



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

[[FLOORPLAN]] ist eine Erweiterung, mit deren Hilfe Geräte bzw. deren mögliche Aktionen und Attribute auf einem selbsterstellten Hintergrundbild dargestellt werden können. Die Einbindung von FLOORPLAN erzeugt den zusätzlichen Menüeintrag ''Floorplans''. Wird dieser Menüpunkt ausgewählt, wird in der Menüleiste links nur noch eine Liste der verfügbaren Floorplans und die "Rückkehrmöglichkeit" zum Standard-Fhem Menü angezeigt.

Eine vom Modul-Autor verfasste ausführliche Schritt-für-Schritt Anleitung ist in einer [http://www.fhemwiki.de/wiki/Floorplan_Installations-Leitfaden deutschen] und einer [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/docs/fhem-floorplan-installation-guide.pdf?format=raw englischen] Version verfügbar.
<br clear=all>
{{Randnotiz|RNTyp=y|RNText=Bevor sinnvoll mit der Floorplan- Einrichtung begonnen werden kann, sollten zumindest die [[Systemübersicht]], das [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Einsteigerdokument] und das [http://www.fhemwiki.de/wiki/Floorplan_Installations-Leitfaden Floorplan- Manual] gelesen und verstanden worden sein!}}

== Voraussetzungen ==
Keine.

== Anwendung ==
=== Define ===
:<code>define <name> FLOORPLAN</code>

=== Attribute ===
:<code>userattr fp_<name> <top>,<left>[,<style>[,<description>]]</code>
wird automatisch für den FLOORPLAN angelegt, sofern es noch nicht existiert...

== Anwendungsbeispiele ==
* Aktuelle Uhrzeit auf einem FLOORPLAN anzeigen: {{Link2Forum|Topic=23629|Message=169082}}
* Animierte SVG-Icons für responsiven Floorplan: {{Link2Forum|Topic=26673|Message=196337}}
* [[Floorplan FHT Temperatur]]
* [[Remotecontrol]]
* [[Browsersteuerung, Seiten per JS autom. aufrufen]]



== Bekannte Probleme ==
=== Größe von (WebLink) Icons ===
Sollten im Floorplan Icons in der falschen Größe angezeigt werden, kann das über Einstellungen im entsprechenden Stylesheet (.css) korrigiert / geändert werden. Beispiele (Screenshot) sowie Korrekturmöglichkeiten sind in {{Link2Forum|Topic=34898|LinkText=diesem Forenthread}} beschrieben.

== Links ==
*[[Floorplan_Installations-Leitfaden|Schritt-für-Schritt-Anleitung im Wiki]]
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/docs/fhem-floorplan-installation-guide_de.pdf?format=raw Schritt-für-Schritt-Anleitung] ([http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/docs/fhem-floorplan-installation-guide.pdf?format=raw Englische Version])
* [http://forum.fhem.de/index.php/topic,25778.0.html Diskussion] im Forum über die Verwendung von [http://www.sweethome3d.com/de/ Sweet Home 3D] zur Erstellung von Hintergrundbildern für FLOORPLAN

[[Kategorie:FHEM Frontends]]

FLOORPLAN

2015-10-03T15:16:12Z

Uli: Verlinkung Installationsleitfaden deutsch geändert von pdf nach Wiki

{{Infobox Modul
|ModPurpose=Darstellung von Fhem-Objekten auf einem Hintergrundbild
|ModType=h



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

[[FLOORPLAN]] ist eine Erweiterung, mit deren Hilfe Geräte bzw. deren mögliche Aktionen und Attribute auf einem selbsterstellten Hintergrundbild dargestellt werden können. Die Einbindung von FLOORPLAN erzeugt den zusätzlichen Menüeintrag ''Floorplans''. Wird dieser Menüpunkt ausgewählt, wird in der Menüleiste links nur noch eine Liste der verfügbaren Floorplans und die "Rückkehrmöglichkeit" zum Standard-Fhem Menü angezeigt.

Eine vom Modul-Autor verfasste ausführliche Schritt-für-Schritt Anleitung ist in einer [[http://www.fhemwiki.de/wiki/Floorplan_Installations-Leitfaden deutschen]] und einer [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/docs/fhem-floorplan-installation-guide.pdf?format=raw englischen] Version verfügbar.
<br clear=all>
{{Randnotiz|RNTyp=y|RNText=Bevor sinnvoll mit der Floorplan- Einrichtung begonnen werden kann, sollten zumindest die [[Systemübersicht]], das [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Einsteigerdokument] und das [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/docs/fhem-floorplan-installation-guide_de.pdf?format=raw Floorplan- Manual] gelesen und verstanden worden sein!}}

== Voraussetzungen ==
Keine.

== Anwendung ==
=== Define ===
:<code>define <name> FLOORPLAN</code>

=== Attribute ===
:<code>userattr fp_<name> <top>,<left>[,<style>[,<description>]]</code>
wird automatisch für den FLOORPLAN angelegt, sofern es noch nicht existiert...

== Anwendungsbeispiele ==
* Aktuelle Uhrzeit auf einem FLOORPLAN anzeigen: {{Link2Forum|Topic=23629|Message=169082}}
* Animierte SVG-Icons für responsiven Floorplan: {{Link2Forum|Topic=26673|Message=196337}}
* [[Floorplan FHT Temperatur]]
* [[Remotecontrol]]
* [[Browsersteuerung, Seiten per JS autom. aufrufen]]



== Bekannte Probleme ==
=== Größe von (WebLink) Icons ===
Sollten im Floorplan Icons in der falschen Größe angezeigt werden, kann das über Einstellungen im entsprechenden Stylesheet (.css) korrigiert / geändert werden. Beispiele (Screenshot) sowie Korrekturmöglichkeiten sind in {{Link2Forum|Topic=34898|LinkText=diesem Forenthread}} beschrieben.

== Links ==
*[[Floorplan_Installations-Leitfaden|Schritt-für-Schritt-Anleitung im Wiki]]
* [http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/docs/fhem-floorplan-installation-guide_de.pdf?format=raw Schritt-für-Schritt-Anleitung] ([http://sourceforge.net/p/fhem/code/HEAD/tree/trunk/fhem/docs/fhem-floorplan-installation-guide.pdf?format=raw Englische Version])
* [http://forum.fhem.de/index.php/topic,25778.0.html Diskussion] im Forum über die Verwendung von [http://www.sweethome3d.com/de/ Sweet Home 3D] zur Erstellung von Hintergrundbildern für FLOORPLAN

[[Kategorie:FHEM Frontends]]

Floorplan Installations-Leitfaden

2015-10-03T15:14:00Z

Uli: /* Einführung */ Kurzübersicht eingefügt.

Dies ist ein Schritt-für-Schritt Einrichtungsleitfaden zur Erstellung eines floorplans mit fhem. Ein Implementierungsbeispiel demonstriert die Möglichkeiten.

Dieser Leitfaden wurde ursprünglich von Ulrich Maass erstellt, der die Erlaubnis erteilt hat, ihn auch im Wiki zu veröffentlichen.


==Einführung==
Dieses Beispiel erzeugt einen floorplan namens ''Grundriss'', der z.B. so aussehen kann:
[[File:FloorplanInstallationGuide02.png|none]]

Einige weitere Beispiel-Screenshots von mehreren Anwendern finden Sie in [https://groups.google.com/d/msg/fhem-users/4inexYPdtfw/Utr24BN0AlwJ diesem] und [https://groups.google.com/d/msg/fhem-users/dNP7TLalbhY/ehBGolJbaF0J diesem] Post. Scrollen Sie dort auch ein wenig nach unten, um weitere Screenshots zu sehen.

Die Einrichtung eines solchen FLOORPLANS ist im Folgenden detailliert beschrieben.

'''Kurz-Überblick:'''
# In fhem {{Taste|define <myNAME> FLOORPLAN}} eingeben, also z.B. {{Taste|define Grundriss FLOORPLAN}}. Dadurch gibt's nen neuen Menüpunkt ''Floorplans'' oberhalb der Raum-Liste.
# Hintergrundbild erstellen, als '''.png''' speichern unter www/images/default.
# In fhem {{Taste|set WEB rereadicons}} ausführen - sonst erscheint das Hintergrundbild nicht!
# Zum Hinzufügen/Anpassen von devices muss das Attribut ''fp_arrange'' gesetzt werden mit {{Taste|attr <myNAME> fp_arrange 1}}. Dadurch erscheint im FLOORPLAN das Arrange-Menü im unteren Bildschirmbereich.
# Im Arrange-Menü aus der oberen Liste neue devices auswählen und {{Taste|add}} klicken, dann mit der Maus an die geünschte Stelle schieben.
# Im Arrange-Menü aus der unteren Liste ein device auswählen, dessen Darstellung geändert werden soll, dann {{Taste|select}} klicken. Anschließend aus der dropdown-Liste den Style auswählen und {{Taste|attr}} klicken.
# Zum Schluss den Arrange-Mode deaktivieren mit {{Taste|attr <myNAME> fp_arrange 0}} und in fhem die config speichern mit {{Taste|save}}, sonst ist nach dem nächsten restart alles wieder weg.

Nun also die detailllierte Beschreibung.

==Vorbereitungen==

===Einen floorplan definieren===
Als ersten Schritt definieren Sie einen neuen floorplan:
define <name> FLOORPLAN
Beispiel:
define Grundriss FLOORPLAN
Sie können mehrere floorplans anlegen, z.B. Haus, Keller, Erdgeschoss, Obergeschoss, Dach.
Oder Sie erstellen einen angepassten floorplan pro Person in Ihrem Haushalt.

===Öffnen Sie den floorplan zum ersten Mal===
Aus Ihrem fhem Start-Bildschirm wählen Sie den neuen Menüpunkt ''Floorplans'', dann klicken Sie Ihren floorplan an.

====Das floorplan user-attribute====
Sie werden nun lediglich einen leeren Bildschirm sehen mit dem fhem-icon und einem Menü auf der linken Seite.
Im Hintergrund wurde jedoch das userattribute ''userattr fp_<name>'' in fhem.cfg zu Ihrer Liste der userattributes hinzugefügt:
attr global userattr fm_fav fm_groups fm_name fm_order room structexclude webCmd fp_Grundriss
Dieses Attribut steuert, welche Geräte an welcher Stelle auf dem Bildschirm wie angezeigt werden sollen.

===Zuweisen eines Hintergrundbilds===

Speichern Sie das Hintergrundbild für Ihren floorplan. Sichern Sie dazu ein Bild im Format PNG mit dem Prefix ''fp_'' und dem Namen Ihres floorplans unterhalb Ihres fhem-Verzeichnisses im Ordner ''www/images/default''.

Heißt Ihr floorplan also "Grundriss", speichern Sie die Datei '''''fp_Grundriss.png''''' im Ordner '''''www/images/default'''''.

Bitte beachten Sie bei der Benennung der Hintergundbild-Datei die Groß- und Kleinschreibung. Bedenken Sie auch, dass nur das Format '''.PNG''' verwendet werden kann. Soll eine SVG-Datei verwendet werden, muss diese über die CSS-Datei des floorplans eingebunden werden (siehe z.B. [[Floorplan_im_LCARS_Design#Einbinden des Hintergrundbildes|hier]]).

Das Hintergrundbild im Beispiel-Screenshot wurde mit MS PowerPoint erstellt. Sie können zur Erstellung von 2D- oder 3D-Grundrissen auch [http://www.sweethome3d.com SweetHome3D] oder [http://www.imsidesign.com/Products/TurboFLOORPLAN TurboFloorplan 3D] verwenden.

Selbstverständlich muss Ihr Hintergrundbild keinen Grundriss zeigen. Sie können jedes beliebige Bild verwenden und dann z.B. Messwerte darauf anzeigen, beispielsweise für einen digitalen Bilderrahmen.

Die beste Bildauflösung hängt vom verwendeten Anzeigegerät ab: Für iPads verwenden Sie z.B. 1024*768 (oder ein wenig darunter). Wenn Sie Ihren floorplan nur am Monitor verwenden wollen, möchten Sie vielleicht den gesamten Bildschirm füllen – dann hängt die Bildgröße von Ihrer Monitor-Auflösung ab. Das Hintergrundbild im Beipiel hat 1000x750px.

Wenn Sie Ihren floorplan nun wieder im Browser öffnen, wird auch das Hintergrundbild angezeigt (evtl. müssen Sie die Seite einmal neu laden). Wird das Hintergrundbild nicht angezeigt, prüfen Sie Pfad und Groß-/Kleinschreibung des Dateinamens.

Die Position Ihres Hintergrundbilds auf dem Bildschirm kann in der verwendeten css-Datei (''floorplanstyle.css'' oder ''darkfloorplanstyle.css'') eingestellt werden.
Verändern Sie dazu die Werte des css-Parameters '''''backimg''''', also z.B.
#backimg {position:absolute; top:15px; left:190px;}
Details finden Sie im Abschnitt [[#Spezielle Formate für Ihren floorplan - floorplanstyle.css]]

{{Hinweis|fhem liest die Liste aller Bild-Dateien nur einmalig beim Start ein. Wenn Sie eine neue Datei hinzufügen, müssen Sie ein erneutes Einlesen anstossen. Geben Sie dazu im fhem-Kommandofeld <code>set WEB rereadicons</code> ein. Ersetzen Sie ggf. ''WEB'' durch den Namen Ihrer Webinstanz.}}

==Anordnen der Geräte==
===Wie Geräte dargestellt werden===
Hier erhalten Sie zunächst einen Überblick, wie Ihre Geräte dargestellt werden können. Im nächsten Abschnitt wird dann erklärt, welche Einstellungen dafür vorgenommen werden müssen.

Jedes Gerät wird in einer (normalerweise unsichtbaren) Tabelle dargestellt. Die Anzahl der Tabellenzeilen hängt von der gewählten Darstellungsvariante ab.

'''Stil 0 - nur Symbol (devicestate)'''

Dies ist wohl die am Häufigsten verwendete Darstellung. Das Symbol kann angeklickt werden und schaltet das zugehörige Gerät. Statt auch den Gerätenamen anzuzeigen, platzieren Sie das Symbol einfach an der "richtigen" Stelle auf Ihrem Grundriss.
[[File:FloorplanInstallationGuide03.png|none]]

'''Stil 1 - Name und Symbol/Status (devicename und devicestate)'''

Wenn der Name über dem Symbol angezeigt werden soll (oder über dem Status des Geräts), wählen Sie Stil 1. Angezeigt wird die Beschreibung in floorplan (siehe unten), der Alias oder der Gerätename wie in der fhem.cfg definiert.
<br clear=all>
[[File:FloorplanInstallationGuide04.png]]
[[File:FloorplanInstallationGuide05.png]]

'''Stil 2 - Name, Symbol/Status und Befehle (devicename, devicestate und devicecommands)'''

Stil 2 zeigt den Namen, das Symbol bzw. den Status sowie alle für das Gerät verfügbaren Befehle an. Verwenden Sie ''webCmd'' und ''eventmap'' um die Befehlsliste Ihren Bedürfnissen anzupassen. Für einen Dimmer möchsten Sie also z.B. auch eine 50%-Stufe vorsehen.
Für Geräte mit einstellbaren Werten (z.B. Sollwerttemperatur bei einem Heizungsthermostat) zeigt Stil 2 auch das Feld für die Einstellung des Wertes und den Set-Schalter an. Auch Devices mit setList erhalten das Dropdown und einen Set-Button. Slider und Time sind mit Stil 2 in floorplan ebenfalls nutzbar.
<br clear=all>
[[File:FloorplanInstallationGuide06.png]]
[[File:FloorplanInstallationGuide07.png]]

'''Stil 3 – Geräte-Messwert und optional Name (devicename und reading)'''

Stil 3 zeigt einen beliebigen Messwert (device-reading) an, optional mit einer Beschreibung. Nützlich um z.B. nur die Temperatur eines S300TH anzuzeigen. Beachten Sie das Beispiel im Abschnitt [[#Device-Reading]].
[[File:FloorplanInstallationGuide08.png|none]]

'''Stil 4 – S300TH Temperatur & Feuchtigkeit'''

Stil 4 ist speziell für S300TH Sensoren bereitgestellt. Diese liefern Messwerte zu Temperatur und Feuchtigkeit. Bitte beachten Sie das Beispiel im Abschnitt [[#Temperatur & Feuchtgkeit]]
[[File:FloorplanInstallationGuide09.png|none]]

'''Stil 5 – Symbol/Status und Befehle'''

Stil 5 stellt Geräte wie Stil 2 dar, jedoch ohne Gerätenamen.
<br clear=all>
[[File:FloorplanInstallationGuide31.png]]
[[File:FloorplanInstallationGuide32.png]]

'''Stil 6 – Geräte-Messwert inkl. Zeitstempel und optional Name

Stil 6 stellt Geräte wie Stil 3 dar, zusätzlich wird der Zeitstempel des ausgewählten Readings angezeigt.
[[File:FloorplanInstallationGuide10.png|none]]

'''Stil 7 – Nur Kommandos'''

Stil 7 stellt Geräte ausschließlich mit ihren Kommandos dar, also ohne Name oder Staus/Icon. Dies kann z.B. verwendet werden, um für ein Thermostat ausschließlich das Dropdown für die Solltemperatur darzustellen.
[[File:FloorplanInstallationGuide11.png|none]]

Eine ausführlichere Liste von Beipielen finden Sie im Abschnitt [[#Beispiele: Screenshot & Definition]].

===Geräte anordnen===

Um Geräte auf Ihrem floorplan anzuordnen, gibt es den '''''Arrange Mode''''', der es Ihnen gestattet, ihren floorplan einzurichten. Um diesen Modus zu aktivieren, setzen Sie einfach das Attribut
attr <floorplan> fp_arrange 1
Dieses Attribut aktiviert oder deaktiviert den ''Arrange-Mode''. Die Liste wird im Format ''Gerätename (Raumname) Typ [(Alias)]'' angezeigt.

Wenn Ihr floorplan auch ein fhem-Kommandozeilen-Feld haben soll, setzen Sie außerdem:
attr <floorplan> commandfield 1

Navigieren Sie nun wieder zu Ihrem floorplan (fhem Hauptmenü -> ''Floorplans'' -> <Ihr-floorplan>).

Im Arrange-Mode sehen Sie nun zwei Auswahlfelder am unteren Bildschirmrand:
[[File:FloorplanInstallationGuide12.png|none]]

Wählen Sie zum Hinzufügen ein Gerät aus der oberen Liste, dann klicken Sie '''''add'''''.
[[File:FloorplanInstallationGuide13.png|none]]

Ihr Gerät wird nun an der Standard-Startposition 50 Pixel von oben (top), 200 Pixel von links (left) angezeigt.

Alle Geräte auf dem Bildschirm können mit der Maus per Drag&Drop positioniert werden. Sobald Sie die Maustaste loslassen, wird Ihrer Konfiguration ein Attribut hnzugefügt. Details siehe unten.

Außerdem erscheinen alle Geräte, die diesem floorplan hinzugefügt wurden, nun in der unteren Liste. Wählen Sie es dort aus und klicken Sie dann '''''select''''' um in die folgende Ansicht zu gelangen:
[[File:FloorplanInstallationGuide14.png|none]]

Die unteren Felder sind Stil und Text (siehe unten). Setzen Sie die Werte wie gewünscht. Sobald Sie den '''''attr'''''-Schalter drücken, wird in Ihrer Konfiguration das folgende Attribut aktualisiert:
attr <device> fp_<name> <top>,<left>[,<style>[,<description>]]
*'''''<top>''''' ist die y-Position in Pixel vom oberen Bildschirmrand wie per Drag&Drop gesetzt
*'''''<left>''''' ist die x-Position in Pixel vom linken Bildschirmrand wie per Drag&Drop gesetzt.
*'''''<style>''''' ist ein Stil aus der im vorigen Kapitel erläuterten Auswahl
*'''''<description>''''' ist die Beschreibung zur Anzeige im floorpan. Sie ist optional, kann also leer bleiben.

Einige Beispiele:
attr ez_Schreibtisch fp_Grundriss 285,430
attr HomeStatus fp_Grundriss 110,75,1
attr ez_DruckerScanner fp_Grundriss 190,405,2,DruckerScanner

Diese Attribute können verändert werden durch:
*Drag&Drop (top & left)
*Eingaben im Arrange-Mode-Popup (Style und Description)
*manuelle Eingabe des Attributs in das Kommandozeilen-Feld
*Änderung in der Detail-Ansicht des Gerätes

Um ein Gerät aus einem floorplan zu entfernen, wählen Sie es mittels '''''select''''' aus und klicken dann '''''deleteattr'''''.

{{Hinweis|Erst durch Ausführen des Befehls '''''save''''' werden die Attribute dauerhaft in die Konfigurationsdatei fhem.cfg geschrieben}}

Hier ist die Liste der Attribute zur Erstellung des floorplan wie im Screenshot am Dokument-Anfang.
Dabei
*wurden WLAN.on.png und WLAN.off.png im Ordner fhem/images/default gespeichert
*wird für die Rolladensteuerung [[eventMap]] verwendet, um die on/off-Befehle als down/up anzuzeigen
*wird ein [[#iFrames, z.B. Wettervorhersage|iFrame]] zur Anzeige des Wetterberichts verwendet
*kann bei Stil 3 die Beschreibung aus den Teilen Reading-ID und Beschreibung bestehen.
*schaltet der Play/Pause-Schalter ein [[FS20_IRF_Infrarot-Fernbedienung|FS20-IRF]], welches Play/Pause an das Wiedergabegerät sendet

attr HomeStatus fp_Grundriss 110,75,1
attr ez_Schreibtisch fp_Grundriss 285,430
attr ez_LichtRegal fp_Grundriss 220,230,0
attr ez_DruckerScanner fp_Grundriss 190,405,2,DruckerScanner
attr sz_Leselampe fp_Grundriss 460,900,2
attr sz_Stehlampe fp_Grundriss 650,940,0
attr sz_LichtRegal fp_Grundriss 550,730,0
attr wz_Licht fp_Grundriss 160,940
attr wz_LampeKlein fp_Grundriss 290,880
attr wz_Wandbeleuchtung fp_Grundriss 30,920
attr whg_WLAN fp_Grundriss 180,75,1,WLAN
attr ez_FHT fp_Grundriss 330,75,2,Innen
attr ku_Downlight fp_Grundriss 620,520
attr ko_LichtKorridor fp_Grundriss 330,560
attr sz_Rollo fp_Grundriss 665,850,2,Rollo
attr sz_Rollo eventMap on:Down off:Up
define Wetter weblink iframe http://www.wetteronline.de/cgi-bin/hpweather?PLZ=80331
attr Wetter htmlattr width="220" height="330" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter fp_Grundriss 420,25
attr ez_Aussensensor fp_Grundriss 260,75,3,temperature,Aussen
attr wakeup fp_Grundriss 560,900,1,Wakeuptime
attr wz_IRmacminiPlayPause fp_Grundriss 150,740

===Anzeige der floorplan-Konfiguration===

Wenn Sie den Detail-Bildschirm Ihres floorplan-device anzeigen, sehen Sie dort eine Übersicht aller zugordneten Geräte wie in der oberhalb dargestellten Liste.

===Include statt "save"===

Falls Sie sich angewöhnt haben, Ihre fhem-Konfiguration nicht über das Webfrontend [[FHEMWEB]] zu bearbeiten, sondern direkt in der Datei fhem.cfg, können Sie die Konfiguration Ihres floorplan anzeigen und den Inhalt in eine include-Datei übernehmen. Die Verwendung des Befehls ''save'' ist dann nicht erforderlich.
get <name> config
Beispiel:
get Grundriss config

===Arrange-Mode nur für einzelne Ports===

Der Arrange-Mode ist für den floorplan, auf dem das Attribut gesetzt ist, ausschließlich auf dem angegebenen Web-Device (also z.B. WEB) aktiviert. Das ist nützlich, wenn Sie als Entwickler immer WEB (=8083) nutzen, für Ihre Familie aber z.B. nur WEBP (=8085) "freigegeben" haben. So wird der arrange-Mode nur für Sie als Entwickler sichtbar.
Geben Sie als Attributwert den Namen des FHEMWEB-Devices an:
attr <floorplan> fp_arrange WEB

==Spezielle Formate für Ihren floorplan - floorplanstyle.css==

Das Standard-Stylesheet für floorplans ist ''floorplan.css''. Sie können aber auch den Parameter ''stylesheet'' verwenden, siehe nächstes Kapitel.

[[File:FloorplanInstallationGuide15.png]]

Hierfür gibt es eine spezielle css-Datei.
Navigieren Sie im fhem-Web-Frontend nach ''Edit Files'', dann klicken Sie auf floorplanstyle.css.

Die css-Datei gestattet Ihnen das Gestalten für ganze Gruppen und/oder einzelne Geräte:
*'''''class''''' besteht aus Gerätetyp und fp_<name>
*'''''id''''' besteht aus dem Original-Gerätenamen wie im define angegeben.

Hier die css-Einstellungen, die für den Screenshot am Beginn dieses Artikels verwendet wurden:
<pre>
body { background-color: #F0F0F0;
font-family:Arial, sans-serif;
font-size:9px; background-image:url(Grundriss.bak.png);
background-repeat:no-repeat; }
#menu.fp-list { position:absolute; top:120px;left:20px; width:140px; font-size:11px; }
#logo { position:absolute; top: 10px; left: 10px;
width:64px; height:67px; background-image:url(fhem_smallscreen.png); }
#menu { position:absolute; top:120px; left:20px; width:140px; }
#menu.floorplan { position:absolute; top:120px; left:20px; width:140px; font-size:11px; }
#fpmenu.fp_arrange { position:absolute; bottom:20px; left:20px; width:310px; font-size:9px; border:1px solid gray;}
#hdr { position:absolute; top:10px; left:180px; }
#content { position:absolute; top:50px; left:180px; bottom:10px; right:10px; text-align:center}
#backimg {position:absolute; top:15px; left:190px;}

a { color: #278727; }
img { border-style: none; }
table { -moz-border-radius:8px; border-radius:8px; }

.fp_Grundriss {border:0px solid gray;}

.devicename {font-size: 11px; text-align:center; }
.devicestate {text-align:center; }
.devicecommands {font-size:14px; text-align:center; }

#sz_Rollo.devicename {font-size:14px;}
#sz_Rollo.devicecommands {font-size:12px; text-align:center; }
#ez_Aussensensor.devicestate {color:green; font-size:30px; }
#HomeStatus.devicestate {color:green; font-size:30px; }
table.dummy {width:100px; }
table.FHT {width:100px; }
#wakeup.devicestate {color:green; font-size:11px; }
#ez_FHT.devicestate {color:green; font-size:30px; }
#Home.fp_Grundriss {font-size:14px; width:100px; }
#Home.fp_Media {font-size:14px; text-align:left; }
#Media {font-size:14px; }
#Grundriss {font-size:14px; text-align:left; }

h2,h3,h4 { color:#52865D; line-height:1.3;
margin-top:1.5em; font-family:Arial,Sans-serif; }
</pre>

Die wichtigsten Einstelllungen sind:
*'''''.fp_<name>''''' legt das default-Format für die gesamte Ausgabe fest.
*'''''.devicename''''' formatiert alle Gerätenamen sofern nicht je Gerät abweichend festgelegt
*'''''.devicestate''''' formatiert alle Gerätestatus bei Ausgabe als Text (nicht als Symbol)
*'''''.devicecommands''''' formatiert alle Befehle, die unterhalb des Geräts/Symbols angezeigt werden
*'''''#backimg''''' legt die Bildschirmposition Ihres Hintergrundbilds fest

{{Hinweis|In der Test- und Einrichtungsphase können Sie einen Tabellen-Rahmen um ihre Geräte anzeigen lassen um das Positionieren zu vereinfachen. Dazu fügen Sie der floorplanstyle.css einfach folgenden Eintrag hinzu:
.fp_Grundriss {border:1px solid gray;}
}}

===Verwenden anderer Stylesheets===

Das Standard-Stylesheet für floorplans ist ''floorplan.css''. Sie können aber auch das Attribut ''stylesheet'' verwenden, das Ihnen die Verwendung eigener css-Stylesheets erlaubt. Sogar ein eigenes für jeden floorplan. Durch Anlegen eines eigenen Stylesheets (z.B. beginnend mit einer Kopie von floorplanstyle.css oder darkfloorplanstyle.css) können Sie Formatierungen für Ihre eigenen Devices hinterlegen, die später nicht überschrieben werden, sollte ein Update für fhem durchgeführt werden.

attr <floorplan> stylesheet myfloorplanstylesheet.css

{{Hinweis|Die Auswahl eines floorplan-Stylesheets erfolgt nicht in der fhem-Oberfläche unter ''Select Style''!}}

==Verwendung besonderer Icons==

===Andere Symbole (Icons) verwenden===

fhem gestattet die Verwendung eigener Symbole (Icons). Dazu wird eine Icon-Bilddatei in den Formaten '''jpg''', '''png''' oder '''gif''' erstellt. Der Dateiname muss dabei nach dem Muster ''<devicename>.<state>.[jpg|png|gif]'' aufgebaut sein und im Ordner ''www/images/default'' abgelegt werden.
Um eine konsistente Darstellung zu erreichen, sollte die selbe Bildgröße wie die der Standard-Icons verwendet werden. Eine Möglichkeit dafür ist, eine bereits vorhandene Datei zu kopieren (z.B. FS20.on.jpg), richtig zu benennen und anschließend zu bearbeiten ohne die Größe zu ändern.

Beispiel: '''''sz_Rollo.on.jpg''''', '''''sz_Rollo.off.jpg'''''
{{Hinweis|Werden die zugeordneten Dateien nicht gefunden, verwendet fhem die Standard-Icons ''<type>.<state>.[jpg{{!}}jpg{{!}}gif]'', also z.B. ''FS20.on.jpg'', ''FS20.off.jpg'', ...}}

===Andere Symbole (Icons) im floorplan als im fhem Web-Frontend===

Um in einem floorplan andere Icons zu verwenden, als im fhem Standard-Web-Frontend (z.B. größere oder animierte Icons), werden diese einfach in einem Ordner abgelegt, der denselben Namen trägt, wie der floorplan selbst.

Beispiel:
Es existiert bereits ein floorplan namens ''PlotsPage'', darin ein Device namens ''ez_Schreibtisch''
define PlotsPage FLOORPLAN
define ez_Schreibtisch FS20 …
attr ez_Schreibtisch fp_PlotsPage 100,100,1
Die zugrundeliegende fhemweb-Instanz heißt ''WEB'' und hat die Attribute ''longpoll 1'' sowie ''iconPath default:openautomation''.
define WEB FHEMWEB global
attr WEB longpoll 1
attr WEB iconPath default:openautomation
Für die Anzeige des Device ''ez_Schreibtisch'' werden also die "ganz normalen" Icons aus dem Ordner ''www/images/default'' verwendet.

Um für dieses Device nun ein eigenes Icon zu verwenden, erzeugen Sie den entsprechenden Ordner '''''www/images/PlotsPage'''''. Darin legen Sie die Icons '''''ez_Schreibtisch.on.png''''' und '''''ez_Schreibtisch.off.png''''' ab. Anschließend rufen Sie zur Aktualisierung der Bild-Bibliothek einmal <code>set WEB rereadicons</code> auf.

Bei Anzeige des floorplans ''PlotsPage'' wird nun das Device ''ez_Schreibtisch'' mit den speziellen Icons angezeigt.
In anderen floorplans wie auch in fhemweb wird für dasselbe Device weiterhin das Icon aus dem Ordner "default" verwendet.

==Relevante Web-Instanz-Attribute==

Bitte beachten Sie, dass die folgenden Attribute des zugrundeliegenden Web-Device [[FHEMWEB]] auch für floorplans berücksichtigt werden:
{|
|style="vertical-align:top;"|'''smallscreen'''
|Der Apple Vollbildmodus wird ermöglicht: Klicken Sie in Safari auf ''Zum Homescreen hinzufügen'' um ein Icon zu erhalten, mit dem Sie fhem bzw. Ihren floorplan im Vollbildmodus - also ohne URL-Leiste - öffnen. Dadurch wirkt Ihr floorplan wie eine eigenständige App.
Außerdem wird die Bildschirmdarstellung für kleine Displays optimiert.
|-
|style="vertical-align:top;"|'''touchpad'''
|Wie smallscreen, optimiert für die Darstellung auf Tablet-PCs.
|-
|style="vertical-align:top;"|'''refresh'''
|Aktualisiert die angezeigte Browser-Seite regelmäßig.
|-
|style="vertical-align:top;"|'''plotmode'''
|Für Plots (Graphen) kann der plotmode geändert werden. Default ist SVG.
|-
|style="vertical-align:top;"|'''plotsize'''
|Für Plots (Graphen) kann die Darstellungsgröße geändert werden. Diese wird automatisch durch die Attribute ''smallscreen'' und ''touchpad'' gesetzt.
|-
|style="vertical-align:top;"|'''webname'''
|ändert die URL (default: /fhem)
|-
|style="vertical-align:top;"|'''redirectCmd'''
|Wenn Sie die Schaltbefehle für ein Gerät in der URL zum Lernen betrachten möchten, setzen Sie dieses Attribut auf 0. Es wird dann die gesamte ausgewertete URL angezeigt. Default ist 1.
|-
|style="vertical-align:top;"|'''longpoll'''
|Wenn Sie den Wert dieses Attributs auf 1 setzen (das ist auch der default), werden alle durch Icons dargestellten Schaltzustände einer bereits angezeigten Seite auch ohne ein "refresh" im Browser aktualisiert.
Dieses Attribut wirkt auch für alle floorplans, die unter dieser Webinstanz angezeigt werden.
|}

==Verwendung mehrerer floorplans==

Wenn Sie mehrere floorplans verwenden, für die Sie underschiedliche css-Stylesheets verwenden möchten, verwenden Sie das Attribut <code>stylesheet</code>.
Wenn nur wenige Formatierungen abweichen sollen, folgen Sie dem u.g. Beipiel. Für gewöhnlich müssen Sie lediglich die class ''fp_<name>'' hinzufügen, wie bei '''''.devicecommands''''' unten:

<pre>
body[id~=Grundriss] { background-color: #F0F0F0;
font-family:Arial, sans-serif;
font-size:9px;
background-image:url(Grundriss.png);
background-repeat:no-repeat; }
#logo { position:fixed; top:10px; left:20px;
width:100px; height:105px; background-image:url(fhem.png); }
#content { position:absolute; top:10px; left:10px; bottom:10px; right:10px; text-align:center}

a { color: #278727; }
img { border-style: none; }
table { -moz-border-radius:8px; border-radius:8px; }

.fp_Grundriss {border:0px solid gray;}

.devicename.fp_Grundriss {font-size: 11px; text-align:center; }
.devicestate.fp_Grundriss {text-align:center; }
.devicecommands.fp_Grundriss {font-size:14px; text-align:center; }
.devicecommands.fp_FirstFloor {font-size:8px; color:grey; text-align:center; }

#sz_Rollo.devicename.fp_Grundriss {font-size:14px;}
#sz_Rollo.devicecommands.fp_Grundriss {font-size:12px; text-align:center; }
#ez_Aussensensor.devicestate.fp_Grundriss {color:green; font-size:30px; }
#HomeStatus.devicestate.fp_Grundriss {color:green; font-size:30px; }
table.dummy.fp_Grundriss {width:100px; }
table.FHT.fp_Grundriss {width:100px; }
#wakeup.devicestate.fp_Grundriss {color:green; font-size:11px; }
#ez_FHT.devicestate.fp_Grundriss {color:green; font-size:30px; }
#Home {font-size:14px; width:100px; }
</pre>

==Standardmäßig angezeigter floorplan==

Um nach dem Klick auf ''Floorplans'' auf der fhem Startseite unter Umgehung der floorplan-Auswahl direkt in einen floorplan zu springen, ordnen Sie das ''fp_default''-Attribut einem Ihrer floorplans zu. So gelangen Sie direkt in Ihren default-floorplan, in dem Sie über das Menü auf der linken Seite in andere floorplans weiterspringen können.
attr <floorplan-name> fp_default 1
Sie können dieses Attribut einfach in der Detail-Ansicht Ihres floorplans anlegen:
[[File:FloorplanInstallationGuide17.png]]

==Floorplan ohne Menü==
Um einen Floorplan ohne Navigations-Menü zu erhalten, kann das Attribut ''fp_noMenu'' verwendet werden.
attr Grundriss fp_noMenu 1

Alternativ können eigene "Menüpunkte" eingefügt werden wie in [[#Weblinks]] und [[#Weblink mit Bild]] beschrieben.

{{Hinweis|Bedenken Sie, dass sie Ihren floorplan nicht mehr über das Menü verlassen können. Möglicherweise müssen Sie die URL in Ihrem Browser ändern, um ihn zu verlassen.}}

==Anderes Hintergrundbild==

Wenn der Name Ihres Hintergrundbilds unabhängig sein soll vom Namen des floorplan, verwenden Sie das Attribut ''fp_backgroundimg''.
attr Grundriss fp_backgroundimg dateiname.png

'''Tipp:''' Sie können z.B. nachts ein anderes Hintergrundbild verwenden, als tagsüber:
define a_fpbackimg at +*01:00 { \
if ( isday() ) {fhem "attr Grundriss fp_backgroundimg Tag.png"} \
else {fhem "attr Grundriss fp_backgroundimg Nacht.png"} }

==Beispiele: Screenshot & Definition==
Es folgen einige Beispiele mit einem Screenshot, den zugehörigen Attributen und relevanten Einträgen in der css-Datei.
===Nur Symbol===
[[File:FloorplanInstallationGuide18.png]]
define ez_LichtRegal FS20 6969 01
attr ez_LichtRegal fp_Grundriss 220,230,0
attr ez_LichtRegal model fs20st
attr ez_LichtRegal room Esszimmer

===Beschreibung und Symbol===
[[File:FloorplanInstallationGuide19.png]]
define ku_Downlight FS20 696e 00
attr ku_Downlight fp_Grundriss 620,520,1
attr ku_Downlight model fs20st
attr ku_Downlight room Kueche

===Beschreibung, Symbol und Befehle===
[[File:FloorplanInstallationGuide20.png]]
define sz_Leselampe FS20 696b 00
attr sz_Leselampe fp_Grundriss 460,900,2,Leselampe
attr sz_Leselampe webCmd on:dim50%:off
attr sz_Leselampe eventMap on:on dim50%:half off:off
attr sz_Leselampe model fs20di
attr sz_Leselampe room Schlafzimmer

===Beschreibung und State===
[[File:FloorplanInstallationGuide21.png]]
define HomeStatus dummy
attr HomeStatus fp_Grundriss 110,75,1

#HomeStatus.devicestate {color:green; font-size:30px; }

===FHT-Temperatur===
[[File:FloorplanInstallationGuide22.png]]
define ez_FHT FHT 5151
attr ez_FHT fp_Grundriss 330,75,1,Innen
attr ez_FHT retrycount 3
attr ez_FHT room Wohnung,Esszimmer

#ez_FHT.devicestate {color:green; font-size:30px; }

===Device-Reading===
[[File:FloorplanInstallationGuide23.png|none]]
Z.B. können einzelne S300TH-Readings direkt angezeigt werden, wenn sie die Darstellung mit T: x H:y vermeiden möchten. Verwenden Sie dafür Stil 3. Verwenden Sie die Reading-ID (Groß-/Kleinschreibung beachten) als Beschreibung.
Besonderheit an diesem Stil: Die Beschreibung kann entweder nur die Reading-ID enthalten oder die Reading-ID gefolgt von der Anzeige-Beschreibung, leerstellenfrei getrennt durch ein Komma.

Beispiele:

[[File:FloorplanInstallationGuide24.png]]
ergibt
[[File:FloorplanInstallationGuide23.png]]

[[File:FloorplanInstallationGuide25.png]]
ergibt
[[File:FloorplanInstallationGuide26.png]]

define ez_Aussensensor CUL_WS 1
attr ez_Aussensensor fp_Grundriss 260,75,3,temperature,Aussen
attr ez_Aussensensor model S300
attr ez_Aussensensor room Wohnung,Esszimmer

#ez_Aussensensor.devicestate {color:green; font-size:30px; }

===Temperatur & Feuchtigkeit===

[[File:FloorplanInstallationGuide09.png|none]]
S300TH-Sensoren liefern Messwerte zu Temperatur und Feuchtigkeit. Wollen Sie beide anzeigen, verwenden Sie Stil 4.

define ez_Aussensensor CUL_WS 1
attr ez_Aussensensor fp_PlotsPage 100,600,4,Außen
attr ez_Aussensensor model S300
attr ez_Aussensensor room Wohnung,Esszimmer

.fp_tempvalue {color:red; font-size:20px; }
.fp_humvalue {color:blue; font-size:20px; }
{{Hinweis|Um die Beschreibung auszublenden, geben Sie im Beschreibungsfeld '''''&nbsp''''' ein.}}

===Weblinks===
[[File:FloorplanInstallationGuide27.png]]
<pre>
define Home weblink link http://fritz.box:8083/fhem
attr Home fp_Grundriss 50,75,0,Home
</pre>

#Home {font-size:14px; width:100px; }

{{Hinweis|Da jeder floorplan eine eigene URL hatt, können auch eigene Links auf andere floorplans verwenden werden.}}

===Weblink mit Bild===
Wie im vorhergehenden Beispiel gezeigt, können Sie '''''weblink link''''' verwenden, um einen Text-Anchor zum Wechsel zu anderen URLs zu verwenden. Da floorplans eine eigene URL haben, können Sie so auch zwischen floorplans wechseln.

Wenn Sie als Link statt eines Texts ein Bild verwenden möchten, verwenden Sie dieses Beispiel:
<pre>define ImageAnchor weblink htmlCode { '<a href="http://<ip>:<port>/fhem/floorplan/Grundriss2"><img src="/icons/pic.png"></a>' }</pre>
*'''href''' gibt die URL an, zu der Sie springen möchten, z.B. ein anderer floorplan.
*'''img''' gibt den Pfad der Bilddatei an
Nachdem Sie diesen ''weblink htmlCode'' definiert haben, können Sie ihn zu ihrem floorplan hinzufügen.

===Bilddatei einfügen===
Um eine Bilddatei ohne Link einzufügen, verwenden Sie statt ''weblink htmlcode'' einfach '''''weblink image''''', Details siehe [http://fhem.de/commandref.html#weblink commandref].

===Eigene Readings-Listen anzeigen===

Das Einbinden beliebiger Listen von Device-Readings lässt sich ebenfalls mit ''weblink htmlCode'' erreichen.
#Laden Sie dazu aus [http://fhem.svn.sourceforge.net/viewvc/fhem/trunk/fhem/contrib/95_FLOORPLAN/?sortby=file diesem] SVN-Ordner die Datei '''''99_myFloorplanList.pm''''' herunter.
#Passen Sie die Zeilen im Abschnitt '''''## Change this list as needed''''' auf Ihre Bedürfnisse an. Sie können in diesem Abschnitt ggf. Zeilen löschen oder auch hinzufügen.
#Laden Sie mit dem fhem-Befehl '''''reload 99_myFloorplanList.pm''''' neu - ebenso nach jeder weiteren Programmänderung. Achten Sie nach jedem reload auf eventuelle Fehlermeldungen im Log.
#Binden Sie die Routine in das webfrontend ein mit <code>define w_WertListe1 weblink htmlCode {doWertListe1()}</code>
#Dieser Weblink kann nun auf Ihrem floorplan hinzugefügt werden [[File:FloorplanInstallationGuide28.png|none]]

Das Ergebnis sieht dann z.B. so aus:
[[File:FloorplanInstallationGuide29.png|none]]

===iFrames, z.B. Wettervorhersage===
[[File:FloorplanInstallationGuide30.png|none]]
<pre>
define Wetter weblink iframe http://www.wetteronline.de/cgi-bin/hpweather?PLZ=80331
attr Wetter fp_Grundriss 420,25
attr Wetter htmlattr width="220" height="330" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter room Plots
</pre>

==Anwendungsbeispiele==
* Aktuelle Uhrzeit auf einem FLOORPLAN anzeigen: {{Link2Forum|Topic=23629|Message=169082}}
* Animierte SVG-Icons für responsiven Floorplan: {{Link2Forum|Topic=26673|Message=196337}}
* [[Floorplan FHT Temperatur]]
* [[Remotecontrol]]
* [[Browsersteuerung, Seiten per JS autom. aufrufen]]
[[Kategorie:HOWTOS]]

Floorplan Installations-Leitfaden

2015-10-03T14:50:39Z

Uli: /* Einführung */

Dies ist ein Schritt-für-Schritt Einrichtungsleitfaden zur Erstellung eines floorplans mit fhem. Ein Implementierungsbeispiel demonstriert die Möglichkeiten.

Dieser Leitfaden wurde ursprünglich von Ulrich Maass erstellt, der die Erlaubnis erteilt hat, ihn auch im Wiki zu veröffentlichen.


==Einführung==
Dieses Beispiel erzeugt einen floorplan namens ''Grundriss'', der z.B. so aussehen kann:
[[File:FloorplanInstallationGuide02.png|none]]

Einige weitere Beispiel-Screenshots von mehreren Anwendern finden Sie in [https://groups.google.com/d/msg/fhem-users/4inexYPdtfw/Utr24BN0AlwJ diesem] und [https://groups.google.com/d/msg/fhem-users/dNP7TLalbhY/ehBGolJbaF0J diesem] Post. Scrollen Sie dort auch ein wenig nach unten, um weitere Screenshots zu sehen.

Die Einrichtung eines solchen FLOORPLANS ist im Folgenden detailliert beschrieben.

'''Kurz-Überblick:'''
* Hintergrundbild erstellen als '''.png''', speichern unter www/images/default. Details siehe [[#Zuweisen_eines_Hintergrundbilds]]
* In fhem {{Taste|set WEB rereadicons}} ausführen - sonst erscheint das Hintergrundbild nicht!
* In fhem {{Taste|define <NAME> FLOORPLAN}} eingeben. Dadurch gibt's nen neuen Menüpunkt ''Floorplans'' oberhalb der Raum-Liste.
* Zum Hinzufügen/Anpassen von devices auf dem FLOORPLAN muss das Attribut ''fp_arrange'' gesetzt werden mit {{Taste|attr <NAME> fp_arrange 1}}. Dadurch erscheint im FLOORPLAN das Arrange-Menü im unteren Bildschirmbereich.
* Im Arrange-Menü aus der oberen Liste neue devices auswählen und {{Taste|Select}} klicken, dann mit der Maus an die geünschte Stelle schieben.
* Im Arrange-Menü aus der unteren Liste device auswählen, dessen Darstellung geändert werden soll, dann {{Taste||select}} klicken. Anschließend aus der dropdown-Liste den Style auswählen und {{Taste|attr}} klicken.

Nun also die detailllierte Beschreibung.

==Vorbereitungen==

===Einen floorplan definieren===
Als ersten Schritt definieren Sie einen neuen floorplan:
define <name> FLOORPLAN
Beispiel:
define Grundriss FLOORPLAN
Sie können mehrere floorplans anlegen, z.B. Haus, Keller, Erdgeschoss, Obergeschoss, Dach.
Oder Sie erstellen einen angepassten floorplan pro Person in Ihrem Haushalt.

===Öffnen Sie den floorplan zum ersten Mal===
Aus Ihrem fhem Start-Bildschirm wählen Sie den neuen Menüpunkt ''Floorplans'', dann klicken Sie Ihren floorplan an.

====Das floorplan user-attribute====
Sie werden nun lediglich einen leeren Bildschirm sehen mit dem fhem-icon und einem Menü auf der linken Seite.
Im Hintergrund wurde jedoch das userattribute ''userattr fp_<name>'' in fhem.cfg zu Ihrer Liste der userattributes hinzugefügt:
attr global userattr fm_fav fm_groups fm_name fm_order room structexclude webCmd fp_Grundriss
Dieses Attribut steuert, welche Geräte an welcher Stelle auf dem Bildschirm wie angezeigt werden sollen.

===Zuweisen eines Hintergrundbilds===

Speichern Sie das Hintergrundbild für Ihren floorplan. Sichern Sie dazu ein Bild im Format PNG mit dem Prefix ''fp_'' und dem Namen Ihres floorplans unterhalb Ihres fhem-Verzeichnisses im Ordner ''www/images/default''.

Heißt Ihr floorplan also "Grundriss", speichern Sie die Datei '''''fp_Grundriss.png''''' im Ordner '''''www/images/default'''''.

Bitte beachten Sie bei der Benennung der Hintergundbild-Datei die Groß- und Kleinschreibung. Bedenken Sie auch, dass nur das Format '''.PNG''' verwendet werden kann. Soll eine SVG-Datei verwendet werden, muss diese über die CSS-Datei des floorplans eingebunden werden (siehe z.B. [[Floorplan_im_LCARS_Design#Einbinden des Hintergrundbildes|hier]]).

Das Hintergrundbild im Beispiel-Screenshot wurde mit MS PowerPoint erstellt. Sie können zur Erstellung von 2D- oder 3D-Grundrissen auch [http://www.sweethome3d.com SweetHome3D] oder [http://www.imsidesign.com/Products/TurboFLOORPLAN TurboFloorplan 3D] verwenden.

Selbstverständlich muss Ihr Hintergrundbild keinen Grundriss zeigen. Sie können jedes beliebige Bild verwenden und dann z.B. Messwerte darauf anzeigen, beispielsweise für einen digitalen Bilderrahmen.

Die beste Bildauflösung hängt vom verwendeten Anzeigegerät ab: Für iPads verwenden Sie z.B. 1024*768 (oder ein wenig darunter). Wenn Sie Ihren floorplan nur am Monitor verwenden wollen, möchten Sie vielleicht den gesamten Bildschirm füllen – dann hängt die Bildgröße von Ihrer Monitor-Auflösung ab. Das Hintergrundbild im Beipiel hat 1000x750px.

Wenn Sie Ihren floorplan nun wieder im Browser öffnen, wird auch das Hintergrundbild angezeigt (evtl. müssen Sie die Seite einmal neu laden). Wird das Hintergrundbild nicht angezeigt, prüfen Sie Pfad und Groß-/Kleinschreibung des Dateinamens.

Die Position Ihres Hintergrundbilds auf dem Bildschirm kann in der verwendeten css-Datei (''floorplanstyle.css'' oder ''darkfloorplanstyle.css'') eingestellt werden.
Verändern Sie dazu die Werte des css-Parameters '''''backimg''''', also z.B.
#backimg {position:absolute; top:15px; left:190px;}
Details finden Sie im Abschnitt [[#Spezielle Formate für Ihren floorplan - floorplanstyle.css]]

{{Hinweis|fhem liest die Liste aller Bild-Dateien nur einmalig beim Start ein. Wenn Sie eine neue Datei hinzufügen, müssen Sie ein erneutes Einlesen anstossen. Geben Sie dazu im fhem-Kommandofeld <code>set WEB rereadicons</code> ein. Ersetzen Sie ggf. ''WEB'' durch den Namen Ihrer Webinstanz.}}

==Anordnen der Geräte==
===Wie Geräte dargestellt werden===
Hier erhalten Sie zunächst einen Überblick, wie Ihre Geräte dargestellt werden können. Im nächsten Abschnitt wird dann erklärt, welche Einstellungen dafür vorgenommen werden müssen.

Jedes Gerät wird in einer (normalerweise unsichtbaren) Tabelle dargestellt. Die Anzahl der Tabellenzeilen hängt von der gewählten Darstellungsvariante ab.

'''Stil 0 - nur Symbol (devicestate)'''

Dies ist wohl die am Häufigsten verwendete Darstellung. Das Symbol kann angeklickt werden und schaltet das zugehörige Gerät. Statt auch den Gerätenamen anzuzeigen, platzieren Sie das Symbol einfach an der "richtigen" Stelle auf Ihrem Grundriss.
[[File:FloorplanInstallationGuide03.png|none]]

'''Stil 1 - Name und Symbol/Status (devicename und devicestate)'''

Wenn der Name über dem Symbol angezeigt werden soll (oder über dem Status des Geräts), wählen Sie Stil 1. Angezeigt wird die Beschreibung in floorplan (siehe unten), der Alias oder der Gerätename wie in der fhem.cfg definiert.
<br clear=all>
[[File:FloorplanInstallationGuide04.png]]
[[File:FloorplanInstallationGuide05.png]]

'''Stil 2 - Name, Symbol/Status und Befehle (devicename, devicestate und devicecommands)'''

Stil 2 zeigt den Namen, das Symbol bzw. den Status sowie alle für das Gerät verfügbaren Befehle an. Verwenden Sie ''webCmd'' und ''eventmap'' um die Befehlsliste Ihren Bedürfnissen anzupassen. Für einen Dimmer möchsten Sie also z.B. auch eine 50%-Stufe vorsehen.
Für Geräte mit einstellbaren Werten (z.B. Sollwerttemperatur bei einem Heizungsthermostat) zeigt Stil 2 auch das Feld für die Einstellung des Wertes und den Set-Schalter an. Auch Devices mit setList erhalten das Dropdown und einen Set-Button. Slider und Time sind mit Stil 2 in floorplan ebenfalls nutzbar.
<br clear=all>
[[File:FloorplanInstallationGuide06.png]]
[[File:FloorplanInstallationGuide07.png]]

'''Stil 3 – Geräte-Messwert und optional Name (devicename und reading)'''

Stil 3 zeigt einen beliebigen Messwert (device-reading) an, optional mit einer Beschreibung. Nützlich um z.B. nur die Temperatur eines S300TH anzuzeigen. Beachten Sie das Beispiel im Abschnitt [[#Device-Reading]].
[[File:FloorplanInstallationGuide08.png|none]]

'''Stil 4 – S300TH Temperatur & Feuchtigkeit'''

Stil 4 ist speziell für S300TH Sensoren bereitgestellt. Diese liefern Messwerte zu Temperatur und Feuchtigkeit. Bitte beachten Sie das Beispiel im Abschnitt [[#Temperatur & Feuchtgkeit]]
[[File:FloorplanInstallationGuide09.png|none]]

'''Stil 5 – Symbol/Status und Befehle'''

Stil 5 stellt Geräte wie Stil 2 dar, jedoch ohne Gerätenamen.
<br clear=all>
[[File:FloorplanInstallationGuide31.png]]
[[File:FloorplanInstallationGuide32.png]]

'''Stil 6 – Geräte-Messwert inkl. Zeitstempel und optional Name

Stil 6 stellt Geräte wie Stil 3 dar, zusätzlich wird der Zeitstempel des ausgewählten Readings angezeigt.
[[File:FloorplanInstallationGuide10.png|none]]

'''Stil 7 – Nur Kommandos'''

Stil 7 stellt Geräte ausschließlich mit ihren Kommandos dar, also ohne Name oder Staus/Icon. Dies kann z.B. verwendet werden, um für ein Thermostat ausschließlich das Dropdown für die Solltemperatur darzustellen.
[[File:FloorplanInstallationGuide11.png|none]]

Eine ausführlichere Liste von Beipielen finden Sie im Abschnitt [[#Beispiele: Screenshot & Definition]].

===Geräte anordnen===

Um Geräte auf Ihrem floorplan anzuordnen, gibt es den '''''Arrange Mode''''', der es Ihnen gestattet, ihren floorplan einzurichten. Um diesen Modus zu aktivieren, setzen Sie einfach das Attribut
attr <floorplan> fp_arrange 1
Dieses Attribut aktiviert oder deaktiviert den ''Arrange-Mode''. Die Liste wird im Format ''Gerätename (Raumname) Typ [(Alias)]'' angezeigt.

Wenn Ihr floorplan auch ein fhem-Kommandozeilen-Feld haben soll, setzen Sie außerdem:
attr <floorplan> commandfield 1

Navigieren Sie nun wieder zu Ihrem floorplan (fhem Hauptmenü -> ''Floorplans'' -> <Ihr-floorplan>).

Im Arrange-Mode sehen Sie nun zwei Auswahlfelder am unteren Bildschirmrand:
[[File:FloorplanInstallationGuide12.png|none]]

Wählen Sie zum Hinzufügen ein Gerät aus der oberen Liste, dann klicken Sie '''''add'''''.
[[File:FloorplanInstallationGuide13.png|none]]

Ihr Gerät wird nun an der Standard-Startposition 50 Pixel von oben (top), 200 Pixel von links (left) angezeigt.

Alle Geräte auf dem Bildschirm können mit der Maus per Drag&Drop positioniert werden. Sobald Sie die Maustaste loslassen, wird Ihrer Konfiguration ein Attribut hnzugefügt. Details siehe unten.

Außerdem erscheinen alle Geräte, die diesem floorplan hinzugefügt wurden, nun in der unteren Liste. Wählen Sie es dort aus und klicken Sie dann '''''select''''' um in die folgende Ansicht zu gelangen:
[[File:FloorplanInstallationGuide14.png|none]]

Die unteren Felder sind Stil und Text (siehe unten). Setzen Sie die Werte wie gewünscht. Sobald Sie den '''''attr'''''-Schalter drücken, wird in Ihrer Konfiguration das folgende Attribut aktualisiert:
attr <device> fp_<name> <top>,<left>[,<style>[,<description>]]
*'''''<top>''''' ist die y-Position in Pixel vom oberen Bildschirmrand wie per Drag&Drop gesetzt
*'''''<left>''''' ist die x-Position in Pixel vom linken Bildschirmrand wie per Drag&Drop gesetzt.
*'''''<style>''''' ist ein Stil aus der im vorigen Kapitel erläuterten Auswahl
*'''''<description>''''' ist die Beschreibung zur Anzeige im floorpan. Sie ist optional, kann also leer bleiben.

Einige Beispiele:
attr ez_Schreibtisch fp_Grundriss 285,430
attr HomeStatus fp_Grundriss 110,75,1
attr ez_DruckerScanner fp_Grundriss 190,405,2,DruckerScanner

Diese Attribute können verändert werden durch:
*Drag&Drop (top & left)
*Eingaben im Arrange-Mode-Popup (Style und Description)
*manuelle Eingabe des Attributs in das Kommandozeilen-Feld
*Änderung in der Detail-Ansicht des Gerätes

Um ein Gerät aus einem floorplan zu entfernen, wählen Sie es mittels '''''select''''' aus und klicken dann '''''deleteattr'''''.

{{Hinweis|Erst durch Ausführen des Befehls '''''save''''' werden die Attribute dauerhaft in die Konfigurationsdatei fhem.cfg geschrieben}}

Hier ist die Liste der Attribute zur Erstellung des floorplan wie im Screenshot am Dokument-Anfang.
Dabei
*wurden WLAN.on.png und WLAN.off.png im Ordner fhem/images/default gespeichert
*wird für die Rolladensteuerung [[eventMap]] verwendet, um die on/off-Befehle als down/up anzuzeigen
*wird ein [[#iFrames, z.B. Wettervorhersage|iFrame]] zur Anzeige des Wetterberichts verwendet
*kann bei Stil 3 die Beschreibung aus den Teilen Reading-ID und Beschreibung bestehen.
*schaltet der Play/Pause-Schalter ein [[FS20_IRF_Infrarot-Fernbedienung|FS20-IRF]], welches Play/Pause an das Wiedergabegerät sendet

attr HomeStatus fp_Grundriss 110,75,1
attr ez_Schreibtisch fp_Grundriss 285,430
attr ez_LichtRegal fp_Grundriss 220,230,0
attr ez_DruckerScanner fp_Grundriss 190,405,2,DruckerScanner
attr sz_Leselampe fp_Grundriss 460,900,2
attr sz_Stehlampe fp_Grundriss 650,940,0
attr sz_LichtRegal fp_Grundriss 550,730,0
attr wz_Licht fp_Grundriss 160,940
attr wz_LampeKlein fp_Grundriss 290,880
attr wz_Wandbeleuchtung fp_Grundriss 30,920
attr whg_WLAN fp_Grundriss 180,75,1,WLAN
attr ez_FHT fp_Grundriss 330,75,2,Innen
attr ku_Downlight fp_Grundriss 620,520
attr ko_LichtKorridor fp_Grundriss 330,560
attr sz_Rollo fp_Grundriss 665,850,2,Rollo
attr sz_Rollo eventMap on:Down off:Up
define Wetter weblink iframe http://www.wetteronline.de/cgi-bin/hpweather?PLZ=80331
attr Wetter htmlattr width="220" height="330" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter fp_Grundriss 420,25
attr ez_Aussensensor fp_Grundriss 260,75,3,temperature,Aussen
attr wakeup fp_Grundriss 560,900,1,Wakeuptime
attr wz_IRmacminiPlayPause fp_Grundriss 150,740

===Anzeige der floorplan-Konfiguration===

Wenn Sie den Detail-Bildschirm Ihres floorplan-device anzeigen, sehen Sie dort eine Übersicht aller zugordneten Geräte wie in der oberhalb dargestellten Liste.

===Include statt "save"===

Falls Sie sich angewöhnt haben, Ihre fhem-Konfiguration nicht über das Webfrontend [[FHEMWEB]] zu bearbeiten, sondern direkt in der Datei fhem.cfg, können Sie die Konfiguration Ihres floorplan anzeigen und den Inhalt in eine include-Datei übernehmen. Die Verwendung des Befehls ''save'' ist dann nicht erforderlich.
get <name> config
Beispiel:
get Grundriss config

===Arrange-Mode nur für einzelne Ports===

Der Arrange-Mode ist für den floorplan, auf dem das Attribut gesetzt ist, ausschließlich auf dem angegebenen Web-Device (also z.B. WEB) aktiviert. Das ist nützlich, wenn Sie als Entwickler immer WEB (=8083) nutzen, für Ihre Familie aber z.B. nur WEBP (=8085) "freigegeben" haben. So wird der arrange-Mode nur für Sie als Entwickler sichtbar.
Geben Sie als Attributwert den Namen des FHEMWEB-Devices an:
attr <floorplan> fp_arrange WEB

==Spezielle Formate für Ihren floorplan - floorplanstyle.css==

Das Standard-Stylesheet für floorplans ist ''floorplan.css''. Sie können aber auch den Parameter ''stylesheet'' verwenden, siehe nächstes Kapitel.

[[File:FloorplanInstallationGuide15.png]]

Hierfür gibt es eine spezielle css-Datei.
Navigieren Sie im fhem-Web-Frontend nach ''Edit Files'', dann klicken Sie auf floorplanstyle.css.

Die css-Datei gestattet Ihnen das Gestalten für ganze Gruppen und/oder einzelne Geräte:
*'''''class''''' besteht aus Gerätetyp und fp_<name>
*'''''id''''' besteht aus dem Original-Gerätenamen wie im define angegeben.

Hier die css-Einstellungen, die für den Screenshot am Beginn dieses Artikels verwendet wurden:
<pre>
body { background-color: #F0F0F0;
font-family:Arial, sans-serif;
font-size:9px; background-image:url(Grundriss.bak.png);
background-repeat:no-repeat; }
#menu.fp-list { position:absolute; top:120px;left:20px; width:140px; font-size:11px; }
#logo { position:absolute; top: 10px; left: 10px;
width:64px; height:67px; background-image:url(fhem_smallscreen.png); }
#menu { position:absolute; top:120px; left:20px; width:140px; }
#menu.floorplan { position:absolute; top:120px; left:20px; width:140px; font-size:11px; }
#fpmenu.fp_arrange { position:absolute; bottom:20px; left:20px; width:310px; font-size:9px; border:1px solid gray;}
#hdr { position:absolute; top:10px; left:180px; }
#content { position:absolute; top:50px; left:180px; bottom:10px; right:10px; text-align:center}
#backimg {position:absolute; top:15px; left:190px;}

a { color: #278727; }
img { border-style: none; }
table { -moz-border-radius:8px; border-radius:8px; }

.fp_Grundriss {border:0px solid gray;}

.devicename {font-size: 11px; text-align:center; }
.devicestate {text-align:center; }
.devicecommands {font-size:14px; text-align:center; }

#sz_Rollo.devicename {font-size:14px;}
#sz_Rollo.devicecommands {font-size:12px; text-align:center; }
#ez_Aussensensor.devicestate {color:green; font-size:30px; }
#HomeStatus.devicestate {color:green; font-size:30px; }
table.dummy {width:100px; }
table.FHT {width:100px; }
#wakeup.devicestate {color:green; font-size:11px; }
#ez_FHT.devicestate {color:green; font-size:30px; }
#Home.fp_Grundriss {font-size:14px; width:100px; }
#Home.fp_Media {font-size:14px; text-align:left; }
#Media {font-size:14px; }
#Grundriss {font-size:14px; text-align:left; }

h2,h3,h4 { color:#52865D; line-height:1.3;
margin-top:1.5em; font-family:Arial,Sans-serif; }
</pre>

Die wichtigsten Einstelllungen sind:
*'''''.fp_<name>''''' legt das default-Format für die gesamte Ausgabe fest.
*'''''.devicename''''' formatiert alle Gerätenamen sofern nicht je Gerät abweichend festgelegt
*'''''.devicestate''''' formatiert alle Gerätestatus bei Ausgabe als Text (nicht als Symbol)
*'''''.devicecommands''''' formatiert alle Befehle, die unterhalb des Geräts/Symbols angezeigt werden
*'''''#backimg''''' legt die Bildschirmposition Ihres Hintergrundbilds fest

{{Hinweis|In der Test- und Einrichtungsphase können Sie einen Tabellen-Rahmen um ihre Geräte anzeigen lassen um das Positionieren zu vereinfachen. Dazu fügen Sie der floorplanstyle.css einfach folgenden Eintrag hinzu:
.fp_Grundriss {border:1px solid gray;}
}}

===Verwenden anderer Stylesheets===

Das Standard-Stylesheet für floorplans ist ''floorplan.css''. Sie können aber auch das Attribut ''stylesheet'' verwenden, das Ihnen die Verwendung eigener css-Stylesheets erlaubt. Sogar ein eigenes für jeden floorplan. Durch Anlegen eines eigenen Stylesheets (z.B. beginnend mit einer Kopie von floorplanstyle.css oder darkfloorplanstyle.css) können Sie Formatierungen für Ihre eigenen Devices hinterlegen, die später nicht überschrieben werden, sollte ein Update für fhem durchgeführt werden.

attr <floorplan> stylesheet myfloorplanstylesheet.css

{{Hinweis|Die Auswahl eines floorplan-Stylesheets erfolgt nicht in der fhem-Oberfläche unter ''Select Style''!}}

==Verwendung besonderer Icons==

===Andere Symbole (Icons) verwenden===

fhem gestattet die Verwendung eigener Symbole (Icons). Dazu wird eine Icon-Bilddatei in den Formaten '''jpg''', '''png''' oder '''gif''' erstellt. Der Dateiname muss dabei nach dem Muster ''<devicename>.<state>.[jpg|png|gif]'' aufgebaut sein und im Ordner ''www/images/default'' abgelegt werden.
Um eine konsistente Darstellung zu erreichen, sollte die selbe Bildgröße wie die der Standard-Icons verwendet werden. Eine Möglichkeit dafür ist, eine bereits vorhandene Datei zu kopieren (z.B. FS20.on.jpg), richtig zu benennen und anschließend zu bearbeiten ohne die Größe zu ändern.

Beispiel: '''''sz_Rollo.on.jpg''''', '''''sz_Rollo.off.jpg'''''
{{Hinweis|Werden die zugeordneten Dateien nicht gefunden, verwendet fhem die Standard-Icons ''<type>.<state>.[jpg{{!}}jpg{{!}}gif]'', also z.B. ''FS20.on.jpg'', ''FS20.off.jpg'', ...}}

===Andere Symbole (Icons) im floorplan als im fhem Web-Frontend===

Um in einem floorplan andere Icons zu verwenden, als im fhem Standard-Web-Frontend (z.B. größere oder animierte Icons), werden diese einfach in einem Ordner abgelegt, der denselben Namen trägt, wie der floorplan selbst.

Beispiel:
Es existiert bereits ein floorplan namens ''PlotsPage'', darin ein Device namens ''ez_Schreibtisch''
define PlotsPage FLOORPLAN
define ez_Schreibtisch FS20 …
attr ez_Schreibtisch fp_PlotsPage 100,100,1
Die zugrundeliegende fhemweb-Instanz heißt ''WEB'' und hat die Attribute ''longpoll 1'' sowie ''iconPath default:openautomation''.
define WEB FHEMWEB global
attr WEB longpoll 1
attr WEB iconPath default:openautomation
Für die Anzeige des Device ''ez_Schreibtisch'' werden also die "ganz normalen" Icons aus dem Ordner ''www/images/default'' verwendet.

Um für dieses Device nun ein eigenes Icon zu verwenden, erzeugen Sie den entsprechenden Ordner '''''www/images/PlotsPage'''''. Darin legen Sie die Icons '''''ez_Schreibtisch.on.png''''' und '''''ez_Schreibtisch.off.png''''' ab. Anschließend rufen Sie zur Aktualisierung der Bild-Bibliothek einmal <code>set WEB rereadicons</code> auf.

Bei Anzeige des floorplans ''PlotsPage'' wird nun das Device ''ez_Schreibtisch'' mit den speziellen Icons angezeigt.
In anderen floorplans wie auch in fhemweb wird für dasselbe Device weiterhin das Icon aus dem Ordner "default" verwendet.

==Relevante Web-Instanz-Attribute==

Bitte beachten Sie, dass die folgenden Attribute des zugrundeliegenden Web-Device [[FHEMWEB]] auch für floorplans berücksichtigt werden:
{|
|style="vertical-align:top;"|'''smallscreen'''
|Der Apple Vollbildmodus wird ermöglicht: Klicken Sie in Safari auf ''Zum Homescreen hinzufügen'' um ein Icon zu erhalten, mit dem Sie fhem bzw. Ihren floorplan im Vollbildmodus - also ohne URL-Leiste - öffnen. Dadurch wirkt Ihr floorplan wie eine eigenständige App.
Außerdem wird die Bildschirmdarstellung für kleine Displays optimiert.
|-
|style="vertical-align:top;"|'''touchpad'''
|Wie smallscreen, optimiert für die Darstellung auf Tablet-PCs.
|-
|style="vertical-align:top;"|'''refresh'''
|Aktualisiert die angezeigte Browser-Seite regelmäßig.
|-
|style="vertical-align:top;"|'''plotmode'''
|Für Plots (Graphen) kann der plotmode geändert werden. Default ist SVG.
|-
|style="vertical-align:top;"|'''plotsize'''
|Für Plots (Graphen) kann die Darstellungsgröße geändert werden. Diese wird automatisch durch die Attribute ''smallscreen'' und ''touchpad'' gesetzt.
|-
|style="vertical-align:top;"|'''webname'''
|ändert die URL (default: /fhem)
|-
|style="vertical-align:top;"|'''redirectCmd'''
|Wenn Sie die Schaltbefehle für ein Gerät in der URL zum Lernen betrachten möchten, setzen Sie dieses Attribut auf 0. Es wird dann die gesamte ausgewertete URL angezeigt. Default ist 1.
|-
|style="vertical-align:top;"|'''longpoll'''
|Wenn Sie den Wert dieses Attributs auf 1 setzen (das ist auch der default), werden alle durch Icons dargestellten Schaltzustände einer bereits angezeigten Seite auch ohne ein "refresh" im Browser aktualisiert.
Dieses Attribut wirkt auch für alle floorplans, die unter dieser Webinstanz angezeigt werden.
|}

==Verwendung mehrerer floorplans==

Wenn Sie mehrere floorplans verwenden, für die Sie underschiedliche css-Stylesheets verwenden möchten, verwenden Sie das Attribut <code>stylesheet</code>.
Wenn nur wenige Formatierungen abweichen sollen, folgen Sie dem u.g. Beipiel. Für gewöhnlich müssen Sie lediglich die class ''fp_<name>'' hinzufügen, wie bei '''''.devicecommands''''' unten:

<pre>
body[id~=Grundriss] { background-color: #F0F0F0;
font-family:Arial, sans-serif;
font-size:9px;
background-image:url(Grundriss.png);
background-repeat:no-repeat; }
#logo { position:fixed; top:10px; left:20px;
width:100px; height:105px; background-image:url(fhem.png); }
#content { position:absolute; top:10px; left:10px; bottom:10px; right:10px; text-align:center}

a { color: #278727; }
img { border-style: none; }
table { -moz-border-radius:8px; border-radius:8px; }

.fp_Grundriss {border:0px solid gray;}

.devicename.fp_Grundriss {font-size: 11px; text-align:center; }
.devicestate.fp_Grundriss {text-align:center; }
.devicecommands.fp_Grundriss {font-size:14px; text-align:center; }
.devicecommands.fp_FirstFloor {font-size:8px; color:grey; text-align:center; }

#sz_Rollo.devicename.fp_Grundriss {font-size:14px;}
#sz_Rollo.devicecommands.fp_Grundriss {font-size:12px; text-align:center; }
#ez_Aussensensor.devicestate.fp_Grundriss {color:green; font-size:30px; }
#HomeStatus.devicestate.fp_Grundriss {color:green; font-size:30px; }
table.dummy.fp_Grundriss {width:100px; }
table.FHT.fp_Grundriss {width:100px; }
#wakeup.devicestate.fp_Grundriss {color:green; font-size:11px; }
#ez_FHT.devicestate.fp_Grundriss {color:green; font-size:30px; }
#Home {font-size:14px; width:100px; }
</pre>

==Standardmäßig angezeigter floorplan==

Um nach dem Klick auf ''Floorplans'' auf der fhem Startseite unter Umgehung der floorplan-Auswahl direkt in einen floorplan zu springen, ordnen Sie das ''fp_default''-Attribut einem Ihrer floorplans zu. So gelangen Sie direkt in Ihren default-floorplan, in dem Sie über das Menü auf der linken Seite in andere floorplans weiterspringen können.
attr <floorplan-name> fp_default 1
Sie können dieses Attribut einfach in der Detail-Ansicht Ihres floorplans anlegen:
[[File:FloorplanInstallationGuide17.png]]

==Floorplan ohne Menü==
Um einen Floorplan ohne Navigations-Menü zu erhalten, kann das Attribut ''fp_noMenu'' verwendet werden.
attr Grundriss fp_noMenu 1

Alternativ können eigene "Menüpunkte" eingefügt werden wie in [[#Weblinks]] und [[#Weblink mit Bild]] beschrieben.

{{Hinweis|Bedenken Sie, dass sie Ihren floorplan nicht mehr über das Menü verlassen können. Möglicherweise müssen Sie die URL in Ihrem Browser ändern, um ihn zu verlassen.}}

==Anderes Hintergrundbild==

Wenn der Name Ihres Hintergrundbilds unabhängig sein soll vom Namen des floorplan, verwenden Sie das Attribut ''fp_backgroundimg''.
attr Grundriss fp_backgroundimg dateiname.png

'''Tipp:''' Sie können z.B. nachts ein anderes Hintergrundbild verwenden, als tagsüber:
define a_fpbackimg at +*01:00 { \
if ( isday() ) {fhem "attr Grundriss fp_backgroundimg Tag.png"} \
else {fhem "attr Grundriss fp_backgroundimg Nacht.png"} }

==Beispiele: Screenshot & Definition==
Es folgen einige Beispiele mit einem Screenshot, den zugehörigen Attributen und relevanten Einträgen in der css-Datei.
===Nur Symbol===
[[File:FloorplanInstallationGuide18.png]]
define ez_LichtRegal FS20 6969 01
attr ez_LichtRegal fp_Grundriss 220,230,0
attr ez_LichtRegal model fs20st
attr ez_LichtRegal room Esszimmer

===Beschreibung und Symbol===
[[File:FloorplanInstallationGuide19.png]]
define ku_Downlight FS20 696e 00
attr ku_Downlight fp_Grundriss 620,520,1
attr ku_Downlight model fs20st
attr ku_Downlight room Kueche

===Beschreibung, Symbol und Befehle===
[[File:FloorplanInstallationGuide20.png]]
define sz_Leselampe FS20 696b 00
attr sz_Leselampe fp_Grundriss 460,900,2,Leselampe
attr sz_Leselampe webCmd on:dim50%:off
attr sz_Leselampe eventMap on:on dim50%:half off:off
attr sz_Leselampe model fs20di
attr sz_Leselampe room Schlafzimmer

===Beschreibung und State===
[[File:FloorplanInstallationGuide21.png]]
define HomeStatus dummy
attr HomeStatus fp_Grundriss 110,75,1

#HomeStatus.devicestate {color:green; font-size:30px; }

===FHT-Temperatur===
[[File:FloorplanInstallationGuide22.png]]
define ez_FHT FHT 5151
attr ez_FHT fp_Grundriss 330,75,1,Innen
attr ez_FHT retrycount 3
attr ez_FHT room Wohnung,Esszimmer

#ez_FHT.devicestate {color:green; font-size:30px; }

===Device-Reading===
[[File:FloorplanInstallationGuide23.png|none]]
Z.B. können einzelne S300TH-Readings direkt angezeigt werden, wenn sie die Darstellung mit T: x H:y vermeiden möchten. Verwenden Sie dafür Stil 3. Verwenden Sie die Reading-ID (Groß-/Kleinschreibung beachten) als Beschreibung.
Besonderheit an diesem Stil: Die Beschreibung kann entweder nur die Reading-ID enthalten oder die Reading-ID gefolgt von der Anzeige-Beschreibung, leerstellenfrei getrennt durch ein Komma.

Beispiele:

[[File:FloorplanInstallationGuide24.png]]
ergibt
[[File:FloorplanInstallationGuide23.png]]

[[File:FloorplanInstallationGuide25.png]]
ergibt
[[File:FloorplanInstallationGuide26.png]]

define ez_Aussensensor CUL_WS 1
attr ez_Aussensensor fp_Grundriss 260,75,3,temperature,Aussen
attr ez_Aussensensor model S300
attr ez_Aussensensor room Wohnung,Esszimmer

#ez_Aussensensor.devicestate {color:green; font-size:30px; }

===Temperatur & Feuchtigkeit===

[[File:FloorplanInstallationGuide09.png|none]]
S300TH-Sensoren liefern Messwerte zu Temperatur und Feuchtigkeit. Wollen Sie beide anzeigen, verwenden Sie Stil 4.

define ez_Aussensensor CUL_WS 1
attr ez_Aussensensor fp_PlotsPage 100,600,4,Außen
attr ez_Aussensensor model S300
attr ez_Aussensensor room Wohnung,Esszimmer

.fp_tempvalue {color:red; font-size:20px; }
.fp_humvalue {color:blue; font-size:20px; }
{{Hinweis|Um die Beschreibung auszublenden, geben Sie im Beschreibungsfeld '''''&nbsp''''' ein.}}

===Weblinks===
[[File:FloorplanInstallationGuide27.png]]
<pre>
define Home weblink link http://fritz.box:8083/fhem
attr Home fp_Grundriss 50,75,0,Home
</pre>

#Home {font-size:14px; width:100px; }

{{Hinweis|Da jeder floorplan eine eigene URL hatt, können auch eigene Links auf andere floorplans verwenden werden.}}

===Weblink mit Bild===
Wie im vorhergehenden Beispiel gezeigt, können Sie '''''weblink link''''' verwenden, um einen Text-Anchor zum Wechsel zu anderen URLs zu verwenden. Da floorplans eine eigene URL haben, können Sie so auch zwischen floorplans wechseln.

Wenn Sie als Link statt eines Texts ein Bild verwenden möchten, verwenden Sie dieses Beispiel:
<pre>define ImageAnchor weblink htmlCode { '<a href="http://<ip>:<port>/fhem/floorplan/Grundriss2"><img src="/icons/pic.png"></a>' }</pre>
*'''href''' gibt die URL an, zu der Sie springen möchten, z.B. ein anderer floorplan.
*'''img''' gibt den Pfad der Bilddatei an
Nachdem Sie diesen ''weblink htmlCode'' definiert haben, können Sie ihn zu ihrem floorplan hinzufügen.

===Bilddatei einfügen===
Um eine Bilddatei ohne Link einzufügen, verwenden Sie statt ''weblink htmlcode'' einfach '''''weblink image''''', Details siehe [http://fhem.de/commandref.html#weblink commandref].

===Eigene Readings-Listen anzeigen===

Das Einbinden beliebiger Listen von Device-Readings lässt sich ebenfalls mit ''weblink htmlCode'' erreichen.
#Laden Sie dazu aus [http://fhem.svn.sourceforge.net/viewvc/fhem/trunk/fhem/contrib/95_FLOORPLAN/?sortby=file diesem] SVN-Ordner die Datei '''''99_myFloorplanList.pm''''' herunter.
#Passen Sie die Zeilen im Abschnitt '''''## Change this list as needed''''' auf Ihre Bedürfnisse an. Sie können in diesem Abschnitt ggf. Zeilen löschen oder auch hinzufügen.
#Laden Sie mit dem fhem-Befehl '''''reload 99_myFloorplanList.pm''''' neu - ebenso nach jeder weiteren Programmänderung. Achten Sie nach jedem reload auf eventuelle Fehlermeldungen im Log.
#Binden Sie die Routine in das webfrontend ein mit <code>define w_WertListe1 weblink htmlCode {doWertListe1()}</code>
#Dieser Weblink kann nun auf Ihrem floorplan hinzugefügt werden [[File:FloorplanInstallationGuide28.png|none]]

Das Ergebnis sieht dann z.B. so aus:
[[File:FloorplanInstallationGuide29.png|none]]

===iFrames, z.B. Wettervorhersage===
[[File:FloorplanInstallationGuide30.png|none]]
<pre>
define Wetter weblink iframe http://www.wetteronline.de/cgi-bin/hpweather?PLZ=80331
attr Wetter fp_Grundriss 420,25
attr Wetter htmlattr width="220" height="330" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter room Plots
</pre>

==Anwendungsbeispiele==
* Aktuelle Uhrzeit auf einem FLOORPLAN anzeigen: {{Link2Forum|Topic=23629|Message=169082}}
* Animierte SVG-Icons für responsiven Floorplan: {{Link2Forum|Topic=26673|Message=196337}}
* [[Floorplan FHT Temperatur]]
* [[Remotecontrol]]
* [[Browsersteuerung, Seiten per JS autom. aufrufen]]
[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-03T06:25:03Z

Uli: /* Zeitgesteuert schalten - at */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.
{{Hinweis|Im Block '''''Probably associated with'''''' die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.}}

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also {{Taste|modify n_mySchalter1}}. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.

[[Datei:ErsteSchritteInFhem14B.png]]

Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Über den Link '''''Device specific help''''' können Sie sich übrigens den gesamten Hilfe-Text zu Ihrem device-Typ aus der commandref anschauen, hier also den Hilfetext zu ''notify''. Dieser Link ist gerade zu Beginn häufig hilfreich.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

Im Detailscreen eines ''at'' wird übrigens im ''STATE'' der Zeitpunkt der nächsten Ausführung angezeigt.

Diese Info erscheint auch in der Raum-Ansicht, falls Sie das ''at'' dort anzeigen lassen:

[[Datei:ErsteSchritteInFhem18B.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Datei:ErsteSchritteInFhem18B.png

2015-10-03T06:23:59Z

Uli:

Erste Schritte in FHEM

2015-10-03T06:14:09Z

Uli: /* Bestehende Devices verändern – modify */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.
{{Hinweis|Im Block '''''Probably associated with'''''' die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.}}

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also {{Taste|modify n_mySchalter1}}. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.

[[Datei:ErsteSchritteInFhem14B.png]]

Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Über den Link '''''Device specific help''''' können Sie sich übrigens den gesamten Hilfe-Text zu Ihrem device-Typ aus der commandref anschauen, hier also den Hilfetext zu ''notify''. Dieser Link ist gerade zu Beginn häufig hilfreich.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Datei:ErsteSchritteInFhem14B.png

2015-10-03T06:09:37Z

Uli:

Datei:ErsteSchritteInFhem15.png

2015-10-03T06:06:24Z

Uli: Uli lud eine neue Version von Datei:ErsteSchritteInFhem15.png hoch

Datei:ErsteSchritteInFhem15.png

2015-10-03T06:04:47Z

Uli: Uli lud eine neue Version von Datei:ErsteSchritteInFhem15.png hoch

Erste Schritte in FHEM

2015-10-03T06:00:39Z

Uli: /* Bei Event ausführen - notify */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.
{{Hinweis|Im Block '''''Probably associated with'''''' die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.}}

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also {{Taste|modify n_mySchalter1}}. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-03T05:56:57Z

Uli: /* Bei Event ausführen - notify */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden im Block '''''Probably associated with'''''' die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also {{Taste|modify n_mySchalter1}}. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-03T05:46:00Z

Uli: /* Bestehende Devices verändern – modify */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also {{Taste|modify n_mySchalter1}}. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T18:16:33Z

Uli: /* Schaltbefehle definieren */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt vom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T18:14:55Z

Uli: /* Schaltbefehle definieren */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt fom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T18:13:17Z

Uli: /* Schaltbefehle definieren */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.
{{Hinweis|'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.}}

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block:
{{Hinweis|'''''Readings''''' zeigen Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt. Welche Readings angezeigt werden, hängt fom device-TYPE ab.}}

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T18:10:09Z

Uli: /* Device anlegen - define */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

{{Hinweis|Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.}}

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block '''''Readings'''''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T18:08:34Z

Uli: /* Schaltbefehle definieren */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

'''''Attribute''''' können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Welche Attribute verfügbar sind, hängt vom device-TYPE ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block '''''Readings'''''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T18:04:11Z

Uli: /* Device anlegen - define */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block '''''Readings'''''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T18:03:19Z

Uli: /* Device anlegen - define */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

Darunter folgt ein Block mit '''''Attributen'''''. Attribute können vom Anwender gesetzt und geändert werden. Sie beeinflussen das Erscheinungsbild und die Funktion eines bereits bestehenden fhem-device. Also machen wir gleich mit der Bearbeitung von Attributen weiter:

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block '''''Readings'''''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T17:59:52Z

Uli: /* Schaltbefehle definieren */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button {{Taste|attr}} ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block '''''Readings'''''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-Devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von Devices mit '''set'''
* Verändern von Devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attributen'''
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' Zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-Devices grundsätzlich genau so aussehen, wie die dummy-Devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass Sie die verfügbaren Befehle nicht mehr selbst mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-Device vorgegeben sind. Und Events werden nicht nur ausgelöst, wenn Sie im fhem-Webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslöst.

Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Erfolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T14:11:26Z

Uli: /* Wie geht es weiter? */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-devices mit '''define'''
* '''Events''' und den Event-Monitor
* Schalten von devices mit '''set'''
* Verändern von devices mit '''modify''', '''rename''' und '''delete'''
* Das Setzen und Bearbeiten von '''Attribute'''n
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-devices grundsätzlich ebenso aussehen, wie die dummy-devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass 1. Sie i.A. nicht mehr selbst die verfügbaren Befehle mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-device vorgegeben sind, und 2. events nicht nur ausgelöst werden, wenn Sie im fhem-webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslösen. Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Ergolg mit fhem !

[[Kategorie:HOWTOS]]

Hauptseite

2015-10-02T14:00:00Z

Uli:

{{DISPLAYTITLE:FHEMWiki - Informationsportal zum FHEM Hausautomationsserver}}
{| width="100%"
|-
|style="vertical-align:top" |

<div style="margin: 0; margin-right:10px; border: 1px solid #dfdfdf; border-radius: 8px; padding: 0 1em 1em 1em; background-color:#cce5ff;">

'''Was ist FHEM?'''

'''FHEM''' ist ein Hausautomations-Server von Rudolf Koenig et al. in Perl geschrieben, um diverse per Funk und Kabel angebundene [[:Kategorie:Hardware|Komponenten]] aus dem Bereich der Hausautomation zu steuern. Er ist lizensiert unter der GPL v2. Das FHEMWiki stellt neben dem [http://forum.fhem.de/ Forum] und der [http://www.fhem.de Fhem] Seite die zentrale Informationsquelle rund um FHEM dar.

{{NUMBEROFUSERS}} [[Special:Listusers|Benutzer]] haben sich seit Mai 2013 registriert und {{NUMBEROFARTICLES}} Artikel geschrieben. ({{NUMBEROFEDITS}} Seitenänderungen bislang).

Bitte [[FHEMWiki:Support | unterstütze uns]] und hilf, [[:Kategorie:NeedsEditing| das Wiki zu erweitern]]. Vielen Dank!

<div align="right"><small>'''Mehr [[FHEMWiki:Über_FHEMWiki|über FHEMWiki]]'''</small></div>
</div>

<div style="margin: 0; margin-top:10px; margin-right:10px; border: 1px solid #dfdfdf; border-radius: 8px; padding: 0em 1em 1em 1em; background-color:#efefef;">
'''Wie fange ich an?'''
* [[Datei:Info_green.png|20px]][http://fhem.de/Heimautomatisierung-mit-fhem.pdf FHEM-Übersicht für Anfänger][[Datei:Info_green.png|20px]]<br />DER Startpunkt. '''Pflichtlektüre!'''<br />
* Ein kleiner fhem-Kurs, benötigt keine Hardware: [http://www.fhemwiki.de/wiki/Erste_Schritte_in_fhem Erste Schritte in fhem]
* [[Systemübersicht]]
* Phasen eines Fhem-Projekts:
** [[Planung]]
** [[Umsetzung]] (Implementierung)
** [[Betrieb]] ("Produktion")
* [[:Kategorie:Glossary|Glossar]] (Erklärung für bestimmte Begriffe)<br />
* [[:Kategorie:HOWTOS|Verschiedene HowTos]]<br />
* [[:Kategorie:FAQ|Frequently asked Questions - Häufig gestellte Fragen mit Antworten]]<br />

</div>

<div style="margin: 0; margin-top:10px; margin-right:10px; border: 1px solid #dfdfdf; border-radius: 8px; padding: 0 1em 1em 1em; background-color:#fff0e0;">
'''Unterstützte Hardware'''

* [[:Kategorie:Hardware Typen|Hardware Typen]] - Funktionsbezogene Übersicht (z.B. [[:Kategorie:Unterhaltungselektronik|Unterhaltungselektronik / Multimedia]], [[:Kategorie:Heizungssteuerung|Heizungssteuerung]], [[:Kategorie:Energieverbrauchsmessung|Energieverbrauchsmessung]], etc.)
* [[:Kategorie:Server Hardware|Server Hardware]] - Hardware, auf der FHEM installiert werden kann
* [[:Kategorie:FS20 Components|FS20 Komponenten]]
* [[:Kategorie:panStamp|panStamp Komponenten]]
* [[:Kategorie:HMS Components|HMS Komponenten]]
* [[:Kategorie:EMS Components|EMS Komponenten]]
* [[:Kategorie:FHT Components|FHT Komponenten]]
* [[:Kategorie:1-Wire|1-Wire System]]
* [[:Kategorie:EIB/KNX|EIB/KNX Komponenten]]
* [[:Kategorie:EnOcean Components|EnOcean Komponenten]]
* [[:Kategorie:HomeMatic Components|HomeMatic Komponenten]]
* [[:Kategorie:MAX|MAX! Komponenten]]
* [[:Kategorie:Z-Wave Components|Z-Wave Komponenten]]
* [[:Kategorie:IP Components|Geräte mit Webinterface ("IP")]]
* [[:Kategorie:Other Components|Andere Komponenten / Sonstige Systeme]]

<div align="right"><small>'''[[:Kategorie:Hardware|Alle Hardware-Kategorien]]'''</small></div>
</div>

<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#F8F8FF;">
'''Ideen und Lösungen'''

* [[:Kategorie:Code_Snippets|Verschiedene kommentierte Lösungen und Code-Schnippsel]]
* [[:Kategorie:Examples|Beispielanwendungen - Hardwarelösungen - Fremdsystemanbindungen]]
* [[Anwendungsszenarien]]
* [[Trick der Woche|Tipp der Woche]]
* [[Wie kann ich...]]?

<div align="right"><small>'''[[:Kategorie:FHEM|Fhem-Haupt-Kategorien]]'''</small></div>
</div>

<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#FFFFE7;">
'''Developers Corner'''

* [[:DevelopmentModuleIntro|Development Module Introduction]]
* [[:DevelopmentGuidelinesAV|Development Guidelines AV-Module]]
* [[:How_to_write_a_patch|How to write a patch]]

<div align="right"><small>'''[[:Kategorie:Development|Alle Artikel zu Development]]'''</small></div>
</div>

| width="55%" style="vertical-align:top" |
<div style="margin:0; border:1px solid #888888; border-radius: 8px; padding: 0em 1em 1em 1em; background-color:#d7ffff;height:14em;">
'''FHEMWiki News'''
<div style="font-size:small;height:10em;overflow:scroll;overflow-x:hidden;"><small>{{FHEMWiki_News}}</small></div>
<div align="right"><small>'''Mehr [[FHEMWiki:News|News]]'''</small></div>
</div>

<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#F8F8FF;">
'''Letzte Änderungen'''
<div style="font-size:small;color:black;"><small>{{Special:Recentchanges/5}}</small></div>
<div align="right"><small>'''Mehr [[Special:Recentchanges|Änderungen]]'''</small></div>
</div>


<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#FFFFAA;">
'''Die letzten fünf neuen Seiten'''
<small>{{Special:NewPages/5}}</small>
<div align="right"><small>'''Mehr [[Special:NewPages|Neue Seiten]]'''</small></div>
</div>


<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#DDD68F;">
'''Administratives zum Wiki'''

''Allgemeine Aktivitäten:''
* Registrierung zur Mitarbeit: wende Dich bitte an einen [[FHEMWiki:Administratoren|Administrator]]
* Basiswissen über die Mitarbeit an einem Wiki erarbeiten ([http://de.wikipedia.org/wiki/Wikipedia:Beteiligen z.B. Wikipedia])
* Erweiterung und Korrektur von Artikeln, wo immer nötig
* Ein(ig)e der [[Spezial:Gewünschte Seiten|gewünschten Seiten]] erstellen
* Ideen aus dem [http://forum.fhem.de Forum] in bestehende oder neue Artikel einarbeiten
* [[Spezial:Verwaiste Seiten|verwaiste Seiten]] in sinnvoller Weise verlinken
* [[Spezial:Sackgassenseiten|Sackgassenseiten]] wikifizieren (Links auf andere Seiten einfügen)
* [[Datei:Info_red.png|20px]] '''Tips / Regeln / Hinweise auf "[[FHEMWiki:Über FHEMWiki|Über FHEMWiki]]" beachten!''' [[Datei:Info_red.png|20px]]


''Aktivitäten für Administratoren:''
* Sichten / Löschen von [[:Kategorie:Löschkandidaten|Löschkandidaten]]
* Vorschlag: Einrichten einer Seite, auf der Anfragen an Benutzer mit Admin-Rechten eingetragen werden können
* Beobachten der "Letzten Änderungen"

''Sonstiges:''
* Zum Ausprobieren bitte die [[FHEMWiki:Sandbox]] benutzen
* [//meta.wikimedia.org/wiki/Help:Contents Wiki Benutzerhandbuch].
* [//www.mediawiki.org/wiki/Manual:Configuration_settings Liste der Wiki-Konfigurationsvariablen]
* [//www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
* [[FHEMWiki:Interna|Internes zu diesem Wiki]]
</div>

|}

[[Kategorie:FHEM]]

Hauptseite

2015-10-02T13:58:56Z

Uli: Auf Startseite Hinweis auf fhem-Kurs "Erste Schritte in fhem" eingebaut

{{DISPLAYTITLE:FHEMWiki - Informationsportal zum FHEM Hausautomationsserver}}
{| width="100%"
|-
|style="vertical-align:top" |

<div style="margin: 0; margin-right:10px; border: 1px solid #dfdfdf; border-radius: 8px; padding: 0 1em 1em 1em; background-color:#cce5ff;">

'''Was ist FHEM?'''

'''FHEM''' ist ein Hausautomations-Server von Rudolf Koenig et al. in Perl geschrieben, um diverse per Funk und Kabel angebundene [[:Kategorie:Hardware|Komponenten]] aus dem Bereich der Hausautomation zu steuern. Er ist lizensiert unter der GPL v2. Das FHEMWiki stellt neben dem [http://forum.fhem.de/ Forum] und der [http://www.fhem.de Fhem] Seite die zentrale Informationsquelle rund um FHEM dar.

{{NUMBEROFUSERS}} [[Special:Listusers|Benutzer]] haben sich seit Mai 2013 registriert und {{NUMBEROFARTICLES}} Artikel geschrieben. ({{NUMBEROFEDITS}} Seitenänderungen bislang).

Bitte [[FHEMWiki:Support | unterstütze uns]] und hilf, [[:Kategorie:NeedsEditing| das Wiki zu erweitern]]. Vielen Dank!

<div align="right"><small>'''Mehr [[FHEMWiki:Über_FHEMWiki|über FHEMWiki]]'''</small></div>
</div>

<div style="margin: 0; margin-top:10px; margin-right:10px; border: 1px solid #dfdfdf; border-radius: 8px; padding: 0em 1em 1em 1em; background-color:#efefef;">
'''Wie fange ich an?'''
* [[Datei:Info_green.png|20px]][http://fhem.de/Heimautomatisierung-mit-fhem.pdf FHEM-Übersicht für Anfänger][[Datei:Info_green.png|20px]]<br />DER Startpunkt. '''Pflichtlektüre!'''<br />
* Ein kleiner fhem-Kurs, benötigt keine Hardware [http://www.fhemwiki.de/wiki/Erste_Schritte_in_fhem Erste Schritte in fhem]
* [[Systemübersicht]]
* Phasen eines Fhem-Projekts:
** [[Planung]]
** [[Umsetzung]] (Implementierung)
** [[Betrieb]] ("Produktion")
* [[:Kategorie:Glossary|Glossar]] (Erklärung für bestimmte Begriffe)<br />
* [[:Kategorie:HOWTOS|Verschiedene HowTos]]<br />
* [[:Kategorie:FAQ|Frequently asked Questions - Häufig gestellte Fragen mit Antworten]]<br />

</div>

<div style="margin: 0; margin-top:10px; margin-right:10px; border: 1px solid #dfdfdf; border-radius: 8px; padding: 0 1em 1em 1em; background-color:#fff0e0;">
'''Unterstützte Hardware'''

* [[:Kategorie:Hardware Typen|Hardware Typen]] - Funktionsbezogene Übersicht (z.B. [[:Kategorie:Unterhaltungselektronik|Unterhaltungselektronik / Multimedia]], [[:Kategorie:Heizungssteuerung|Heizungssteuerung]], [[:Kategorie:Energieverbrauchsmessung|Energieverbrauchsmessung]], etc.)
* [[:Kategorie:Server Hardware|Server Hardware]] - Hardware, auf der FHEM installiert werden kann
* [[:Kategorie:FS20 Components|FS20 Komponenten]]
* [[:Kategorie:panStamp|panStamp Komponenten]]
* [[:Kategorie:HMS Components|HMS Komponenten]]
* [[:Kategorie:EMS Components|EMS Komponenten]]
* [[:Kategorie:FHT Components|FHT Komponenten]]
* [[:Kategorie:1-Wire|1-Wire System]]
* [[:Kategorie:EIB/KNX|EIB/KNX Komponenten]]
* [[:Kategorie:EnOcean Components|EnOcean Komponenten]]
* [[:Kategorie:HomeMatic Components|HomeMatic Komponenten]]
* [[:Kategorie:MAX|MAX! Komponenten]]
* [[:Kategorie:Z-Wave Components|Z-Wave Komponenten]]
* [[:Kategorie:IP Components|Geräte mit Webinterface ("IP")]]
* [[:Kategorie:Other Components|Andere Komponenten / Sonstige Systeme]]

<div align="right"><small>'''[[:Kategorie:Hardware|Alle Hardware-Kategorien]]'''</small></div>
</div>

<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#F8F8FF;">
'''Ideen und Lösungen'''

* [[:Kategorie:Code_Snippets|Verschiedene kommentierte Lösungen und Code-Schnippsel]]
* [[:Kategorie:Examples|Beispielanwendungen - Hardwarelösungen - Fremdsystemanbindungen]]
* [[Anwendungsszenarien]]
* [[Trick der Woche|Tipp der Woche]]
* [[Wie kann ich...]]?

<div align="right"><small>'''[[:Kategorie:FHEM|Fhem-Haupt-Kategorien]]'''</small></div>
</div>

<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#FFFFE7;">
'''Developers Corner'''

* [[:DevelopmentModuleIntro|Development Module Introduction]]
* [[:DevelopmentGuidelinesAV|Development Guidelines AV-Module]]
* [[:How_to_write_a_patch|How to write a patch]]

<div align="right"><small>'''[[:Kategorie:Development|Alle Artikel zu Development]]'''</small></div>
</div>

| width="55%" style="vertical-align:top" |
<div style="margin:0; border:1px solid #888888; border-radius: 8px; padding: 0em 1em 1em 1em; background-color:#d7ffff;height:14em;">
'''FHEMWiki News'''
<div style="font-size:small;height:10em;overflow:scroll;overflow-x:hidden;"><small>{{FHEMWiki_News}}</small></div>
<div align="right"><small>'''Mehr [[FHEMWiki:News|News]]'''</small></div>
</div>

<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#F8F8FF;">
'''Letzte Änderungen'''
<div style="font-size:small;color:black;"><small>{{Special:Recentchanges/5}}</small></div>
<div align="right"><small>'''Mehr [[Special:Recentchanges|Änderungen]]'''</small></div>
</div>


<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#FFFFAA;">
'''Die letzten fünf neuen Seiten'''
<small>{{Special:NewPages/5}}</small>
<div align="right"><small>'''Mehr [[Special:NewPages|Neue Seiten]]'''</small></div>
</div>


<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; border-radius: 8px; padding:0 1em 1em 1em; background-color:#DDD68F;">
'''Administratives zum Wiki'''

''Allgemeine Aktivitäten:''
* Registrierung zur Mitarbeit: wende Dich bitte an einen [[FHEMWiki:Administratoren|Administrator]]
* Basiswissen über die Mitarbeit an einem Wiki erarbeiten ([http://de.wikipedia.org/wiki/Wikipedia:Beteiligen z.B. Wikipedia])
* Erweiterung und Korrektur von Artikeln, wo immer nötig
* Ein(ig)e der [[Spezial:Gewünschte Seiten|gewünschten Seiten]] erstellen
* Ideen aus dem [http://forum.fhem.de Forum] in bestehende oder neue Artikel einarbeiten
* [[Spezial:Verwaiste Seiten|verwaiste Seiten]] in sinnvoller Weise verlinken
* [[Spezial:Sackgassenseiten|Sackgassenseiten]] wikifizieren (Links auf andere Seiten einfügen)
* [[Datei:Info_red.png|20px]] '''Tips / Regeln / Hinweise auf "[[FHEMWiki:Über FHEMWiki|Über FHEMWiki]]" beachten!''' [[Datei:Info_red.png|20px]]


''Aktivitäten für Administratoren:''
* Sichten / Löschen von [[:Kategorie:Löschkandidaten|Löschkandidaten]]
* Vorschlag: Einrichten einer Seite, auf der Anfragen an Benutzer mit Admin-Rechten eingetragen werden können
* Beobachten der "Letzten Änderungen"

''Sonstiges:''
* Zum Ausprobieren bitte die [[FHEMWiki:Sandbox]] benutzen
* [//meta.wikimedia.org/wiki/Help:Contents Wiki Benutzerhandbuch].
* [//www.mediawiki.org/wiki/Manual:Configuration_settings Liste der Wiki-Konfigurationsvariablen]
* [//www.mediawiki.org/wiki/Manual:FAQ MediaWiki FAQ]
* [[FHEMWiki:Interna|Internes zu diesem Wiki]]
</div>

|}

[[Kategorie:FHEM]]

Erste Schritte in FHEM

2015-10-02T13:49:19Z

Uli: /* Wie geht es weiter? */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-devices mit '''define'''
* '''Events''' und den Event-Monitor
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [http://fhem.de/commandref.html commandref]

'''Tipp:''' zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben links auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-devices grundsätzlich ebenso aussehen, wie die dummy-devices, die Sie hier bereits kennengelernt haben. Der wesentliche Unterschied ist, dass 1. Sie i.A. nicht mehr selbst die verfügbaren Befehle mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-device vorgegeben sind, und 2. events nicht nur ausgelöst werden, wenn Sie im fhem-webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssensor oder der Lichtschalter an der Wand) auslösen. Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [http://fhem.de/Heimautomatisierung-mit-fhem.pdf Heimautomatisierung-mit-fhem]

Viel Spaß und Ergolg mit fhem !

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T13:46:12Z

Uli:

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

==Wie geht es weiter?==

Sie haben nun kennengelernt:
* Das Anlegen von fhem-devices mit '''define'''
* '''Events''' und den Event-Monitor
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [commandref http://fhem.de/commandref.html]

'''Tipp:''' zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben link auf den Link "DE".

In der commandref finden Sie neben der Beschreibung aller fhem-Befehle auch die Liste aller Gerätetypen, die in fhem eingebunden werden können.

Sie werden feststellen, dass "echte" fhem-devices grundsätzlich ebenso aussehen, wie die dummy-devices, die Sie hier bereits kennengelernt haben. Der Wesentliche Unterschied ist, dass 1. Sie i.A. nicht mehr selbst die verfügbaren Befehle mittels ''attr webCmd'' festlegen müssen, da diese bereits durch das fhem-device vorgegeben sind, und 2. events nicht nur ausgelöst werden, wenn Sie im fhem-webfrontend klicken, sondern auch, wenn das physische Gerät (also der Bewegungssesnor oder der Lichtschalter an der Wand) auslösen. Sobald Sie ihre ersten Geräte an fhem gekoppelt haben, schauen Sie sich den Event-Monitor an, um zu sehen, wann welche Events ausgelöst werden.

Einen umfangreicheren Einstieg in fhem finden Sie im Dokument [Heimautomatisierung-mit-fhem http://fhem.de/Heimautomatisierung-mit-fhem.pdf]

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T13:40:03Z

Uli: /* Timer bei einem Event starten - notify und at */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

---Wie geht es weiter?---

Sie haben nun kennengelernt:
* Das Anlegen von fhem-devices mit '''define'''
* '''Events''' und den Event-Monitor
* Event-getriebene Aktionen durch '''notify'''
* Zeitgesteuertes Schalten mit '''at'''

Damit kennen Sie die grundlegendsten Mechanismen von fhem. Details zu diesen Befehlen finden Sie in der fhem Befehlsreferenz [commandref http://fhem.de/commandref.html]

'''Tipp:''' zu vielen fhem-Befehlen und Gerätetypen gibt es auch eine deutschsprachige Beschreibung. Klicken Sie dazu in der commandref oben link auf den Link "DE".

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-02T13:34:56Z

Uli: /* Timer bei einem Event starten - notify und at */

Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem Installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.

Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bitte mit dem Autor (z.B. auf der zugehörigen Diskussionsseite) abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

{{Hinweis|Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.}}

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

[[Datei:ErsteSchritteInFhem13.png]]

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

{{Hinweis|Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.}}

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

[[Datei:ErsteSchritteInFhem14.png]]

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

[[Datei:ErsteSchritteInFhem15.png]]

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

[[Datei:ErsteSchritteInFhem16.png]]

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

{{Hinweis|Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.}}

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

[[Datei:ErsteSchritteInFhem17.png]]

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

[[Datei:ErsteSchritteInFhem18.png]]

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

[[Datei:ErsteSchritteInFhem19.png]]

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;;sleep 60;;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

[[Kategorie:HOWTOS]]

Floorplan Installations-Leitfaden

2015-10-02T09:11:27Z

Uli: /* Wie Geräte dargestellt werden */

Dies ist ein Schritt-für-Schritt Einrichtungsleitfaden zur Erstellung eines floorplans mit fhem. Ein Implementierungsbeispiel demonstriert die Möglichkeiten.

Dieser Leitfaden wurde ursprünglich von Ulrich Maass erstellt, der die Erlaubnis erteilt hat, ihn auch im Wiki zu veröffentlichen.


==Einführung==
Dieses Beispiel erzeugt einen floorplan namens ''Grundriss'', der z.B. so aussehen kann:
[[File:FloorplanInstallationGuide02.png|none]]

Einige weitere Beispiel-Screenshots von mehreren Anwendern finden Sie in [https://groups.google.com/d/msg/fhem-users/4inexYPdtfw/Utr24BN0AlwJ diesem] und [https://groups.google.com/d/msg/fhem-users/dNP7TLalbhY/ehBGolJbaF0J diesem] Post. Scrollen Sie dort auch ein wenig nach unten, um weitere Screenshots zu sehen.

==Vorbereitungen==

===Einen floorplan definieren===
Als ersten Schritt definieren Sie einen neuen floorplan:
define <name> FLOORPLAN
Beispiel:
define Grundriss FLOORPLAN
Sie können mehrere floorplans anlegen, z.B. Haus, Keller, Erdgeschoss, Obergeschoss, Dach.
Oder Sie erstellen einen angepassten floorplan pro Person in Ihrem Haushalt.

===Öffnen Sie den floorplan zum ersten Mal===
Aus Ihrem fhem Start-Bildschirm wählen Sie den neuen Menüpunkt ''Floorplans'', dann klicken Sie Ihren floorplan an.

====Das floorplan user-attribute====
Sie werden nun lediglich einen leeren Bildschirm sehen mit dem fhem-icon und einem Menü auf der linken Seite.
Im Hintergrund wurde jedoch das userattribute ''userattr fp_<name>'' in fhem.cfg zu Ihrer Liste der userattributes hinzugefügt:
attr global userattr fm_fav fm_groups fm_name fm_order room structexclude webCmd fp_Grundriss
Dieses Attribut steuert, welche Geräte an welcher Stelle auf dem Bildschirm wie angezeigt werden sollen.

===Zuweisen eines Hintergrundbilds===
Speichern Sie das Hintergrundbild für Ihren floorplan. Sichern Sie dazu ein Bild im Format PNG mit dem Prefix ''fp_'' und dem Namen Ihres floorplans unterhalb Ihres fhem-Verzeichnisses im Ordner ''www/images/default''.

'''Hinweis:''' fhem liest die Liste aller Bild-Dateien nur einmalig beim Start ein. Wenn Sie eine neue Datei hinzufügen, müssen Sie ein erneutes Einlesen anstossen. Geben Sie dazu im fhem-Kommandofeld <code>set WEB rereadicons</code> ein. Ersetzen Sie ggf. ''WEB'' durch den Namen Ihrer Webinstanz.

Heißt Ihr floorplan also "Grundriss", speichern Sie die Datei '''''fp_Grundriss.png''''' im Ordner '''''www/images/default'''''.

Bitte beachten Sie bei der Benennung der Hintergundbild-Datei die Groß- und Kleinschreibung. Bedenken Sie auch, dass nur das Format '''.PNG''' verwendet werden kann.

Das Hintergrundbild im Beispiel-Screenshot wurde mit MS PowerPoint erstellt. Sie können zur Erstellung von 2D- oder 3D-Grundrissen auch [http://www.sweethome3d.com SweetHome3D] oder [http://www.imsidesign.com/Products/TurboFLOORPLAN TurboFloorplan 3D] verwenden.

Selbstverständlich muss Ihr Hintergrundbild keinen Grundriss zeigen. Sie können jedes beliebige Bild verwenden und dann z.B. Messwerte darauf anzeigen, beispielsweise für einen digitalen Bilderrahmen.

Die beste Bildauflösung hängt vom verwendeten Anzeigegerät ab: Für iPads verwenden Sie z.B. 1024*768 (oder ein wenig darunter). Wenn Sie Ihren floorplan nur am Monitor verwenden wollen, möchten Sie vielleicht den gesamten Bildschirm füllen – dann hängt die Bildgröße von Ihrer Monitor-Auflösung ab. Das Hintergrundbild im Beipiel hat 1000x750px.

Wenn Sie Ihren floorplan nun wieder im Browser öffnen, wird auch das Hintergrundbild angezeigt (evtl. müssen Sie die Seite einmal neu laden). Wird das Hintergrundbild nicht angezeigt, prüfen Sie Pfad und Groß-/Kleinschreibung des Dateinamens.

Die Position Ihres Hintergrundbilds auf dem Bildschirm kann in der verwendeten css-Datei (''floorplanstyle.css'' oder ''darkfloorplanstyle.css'') eingestellt werden.
Verändern Sie dazu die Werte des css-Parameters '''''backimg''''', also z.B.
#backimg {position:absolute; top:15px; left:190px;}
Details finden Sie im Abschnitt [[#Spezielle Formate für Ihren floorplan - floorplanstyle.css]]

==Anordnen der Geräte==
===Wie Geräte dargestellt werden===
Hier erhalten Sie zunächst einen Überblick, wie Ihre Geräte dargestellt werden können. Im nächsten Abschnitt wird dann erklärt, welche Einstellungen dafür vorgenommen werden müssen.

Jedes Gerät wird in einer (normalerweise unsichtbaren) Tabelle dargestellt. Die Anzahl der Tabellenzeilen hängt von der gewählten Darstellungsvariante ab.

'''Stil 0 - nur Symbol (devicestate)'''

[[File:FloorplanInstallationGuide03.png|none]]
Dies ist wohl die am Häufigsten verwendete Darstellung. Das Symbol kann angeklickt werden und schaltet das zugehörige Gerät. Statt auch den Gerätenamen anzuzeigen, platzieren Sie das Symbol einfach an der "richtigen" Stelle auf Ihrem Grundriss.

'''Stil 1 - Name und Symbol/Status (devicename und devicestate)'''

[[File:FloorplanInstallationGuide04.png]]
[[File:FloorplanInstallationGuide05.png]]<br/>
Wenn der Name über dem Symbol angezeigt werden soll (oder über dem Status des Geräts), wählen Sie Stil 1. Angezeigt wird die Beschreibung in floorplan (siehe unten), der Alias oder der Gerätename wie in der fhem.cfg definiert.

'''Stil 2 - Name, Symbol/Status und Befehle (devicename, devicestate und devicecommands)'''

[[File:FloorplanInstallationGuide06.png]]
[[File:FloorplanInstallationGuide07.png]]<br/>
Stil 2 zeigt den Namen, das Symbol bzw. den Status sowie alle für das Gerät verfügbaren Befehle an. Verwenden Sie ''webCmd'' und ''eventmap'' um die Befehlsliste Ihren Bedürfnissen anzupassen. Für einen Dimmer möchsten Sie also z.B. auch eine 50%-Stufe vorsehen.
Für Geräte mit einstellbaren Werten (z.B. Sollwerttemperatur bei einem Heizungsthermostat) zeigt Stil 2 auch das Feld für die Einstellung des Wertes und den Set-Schalter an. Auch Devices mit setList erhalten das Dropdown und einen Set-Button. Slider und Time sind mit Stil 2 in floorplan ebenfalls nutzbar.

'''Stil 3 – Geräte-Messwert und optional Name (devicename und reading)'''

[[File:FloorplanInstallationGuide08.png|none]]
Stil 3 zeigt einen beliebigen Messwert (device-reading) an, optional mit einer Beschreibung. Nützlich um z.B. nur die Temperatur eines S300TH anzuzeigen. Beachten Sie das Beispiel im Abschnitt [[#Device-Reading]].

'''Stil 4 – S300TH Temperatur & Feuchtigkeit'''

[[File:FloorplanInstallationGuide09.png|none]]
Stil 4 ist speziell für S300TH Sensoren bereitgestellt. Diese liefern Messwerte zu Temperatur und Feuchtigkeit. Bitte beachten Sie das Beispiel im Abschnitt [[#Temperatur & Feuchtgkeit]]

'''Stil 5 – Symbol/Status und Befehle'''

[[File:FloorplanInstallationGuide31.png]]
[[File:FloorplanInstallationGuide32.png]]<br/>
Stil 5 stellt Geräte wie Stil 2 dar, jedoch ohne Gerätenamen.

'''Stil 6 – Geräte-Messwert inkl. Zeitstempel und optional Name

[[File:FloorplanInstallationGuide10.png|none]]
Stil 6 stellt Geräte wie Stil 3 dar, zusätzlich wird der Zeitstempel des ausgewählten Readings angezeigt.

'''Stil 7 – Nur Kommandos'''

[[File:FloorplanInstallationGuide11.png|none]]
Stil 7 stellt Geräte ausschließlich mit ihren Kommandos dar, also ohne Name oder Staus/Icon. Dies kann z.B. verwendet werden, um für ein Thermostat ausschließlich das Dropdown für die Solltemperatur darzustellen.

Eine ausführlichere Liste von Beipielen finden Sie im Abschnitt [[#Beispiele: Screenshot & Definition]].

===Geräte anordnen===

Um Geräte auf Ihrem floorplan anzuordnen, gibt es den '''''Arrange Mode''''', der es Ihnen gestattet, ihren floorplan einzurichten. Um diesen Modus zu aktivieren, setzen Sie einfach das Attribut
attr <floorplan> fp_arrange 1
Dieses Attribut aktiviert oder deaktiviert den ''Arrange-Mode''. Die Liste wird im Format ''Gerätename (Raumname) Typ [(Alias)]'' angezeigt.

Wenn Ihr floorplan auch ein fhem-Kommandozeilen-Feld haben soll, setzen Sie außerdem:
attr <floorplan> commandfield 1

Navigieren Sie nun wieder zu Ihrem floorplan (fhem Hauptmenü -> ''Floorplans'' -> <Ihr-floorplan>).

Im Arrange-Mode sehen Sie nun zwei Auswahlfelder am unteren Bildschirmrand:
[[File:FloorplanInstallationGuide12.png|none]]

Wählen Sie zum Hinzufügen ein Gerät aus der oberen Liste, dann klicken Sie '''''add'''''.
[[File:FloorplanInstallationGuide13.png|none]]

Ihr Gerät wird nun an der Standard-Startposition 50 Pixel von oben (top), 200 Pixel von links (left) angezeigt.

Alle Geräte auf dem Bildschirm können mit der Maus per Drag&Drop positioniert werden. Sobald Sie die Maustaste loslassen, wird Ihrer Konfiguration ein Attribut hnzugefügt. Details siehe unten.

Außerdem erscheinen alle Geräte, die diesem floorplan hinzugefügt wurden, nun in der unteren Liste. Wählen Sie es dort aus und klicken Sie dann '''''select''''' um in die folgende Ansicht zu gelangen:
[[File:FloorplanInstallationGuide14.png|none]]

Die unteren Felder sind Stil und Text (siehe unten). Setzen Sie die Werte wie gewünscht. Sobald Sie den '''''attr'''''-Schalter drücken, wird in Ihrer Konfiguration das folgende Attribut aktualisiert:
attr <device> fp_<name> <top>,<left>[,<style>[,<description>]]
*'''''<top>''''' ist die y-Position in Pixel vom oberen Bildschirmrand wie per Drag&Drop gesetzt
*'''''<left>''''' ist die x-Position in Pixel vom linken Bildschirmrand wie per Drag&Drop gesetzt.
*'''''<style>''''' ist ein Stil aus der im vorigen Kapitel erläuterten Auswahl
*'''''<description>''''' ist die Beschreibung zur Anzeige im floorpan. Sie ist optional, kann also leer bleiben.

Einige Beispiele:
attr ez_Schreibtisch fp_Grundriss 285,430
attr HomeStatus fp_Grundriss 110,75,1
attr ez_DruckerScanner fp_Grundriss 190,405,2,DruckerScanner

Diese Attribute können verändert werden durch:
*Drag&Drop (top & left)
*Eingaben im Arrange-Mode-Popup (Style und Description)
*manuelle Eingabe des Attributs in das Kommandozeilen-Feld
*Änderung in der Detail-Ansicht des Gerätes

Um ein Gerät aus einem floorplan zu entfernen, wählen Sie es mittels '''''select''''' aus und klicken dann '''''deleteattr'''''.

'''Hinweis:''' Erst durch Ausführen des Befehls '''''save''''' werden die Attribute dauerhaft in die Konfigurationsdatei fhem.cfg geschrieben.

Hier ist die Liste der Attribute zur Erstellung des floorplan wie im Screenshot am Dokument-Anfang.
Dabei
*wurden WLAN.on.png und WLAN.off.png im Ordner fhem/images/default gespeichert
*wird für die Rolladensteuerung [[eventMap]] verwendet, um die on/off-Befehle als down/up anzuzeigen
*wird ein [[#iFrames, z.B. Wettervorhersage|iFrame]] zur Anzeige des Wetterberichts verwendet
*kann bei Stil 3 die Beschreibung aus den Teilen Reading-ID und Beschreibung bestehen.
*schaltet der Play/Pause-Schalter ein [[FS20_IRF_Infrarot-Fernbedienung|FS20-IRF]], welches Play/Pause an das Wiedergabegerät sendet

attr HomeStatus fp_Grundriss 110,75,1
attr ez_Schreibtisch fp_Grundriss 285,430
attr ez_LichtRegal fp_Grundriss 220,230,0
attr ez_DruckerScanner fp_Grundriss 190,405,2,DruckerScanner
attr sz_Leselampe fp_Grundriss 460,900,2
attr sz_Stehlampe fp_Grundriss 650,940,0
attr sz_LichtRegal fp_Grundriss 550,730,0
attr wz_Licht fp_Grundriss 160,940
attr wz_LampeKlein fp_Grundriss 290,880
attr wz_Wandbeleuchtung fp_Grundriss 30,920
attr whg_WLAN fp_Grundriss 180,75,1,WLAN
attr ez_FHT fp_Grundriss 330,75,2,Innen
attr ku_Downlight fp_Grundriss 620,520
attr ko_LichtKorridor fp_Grundriss 330,560
attr sz_Rollo fp_Grundriss 665,850,2,Rollo
attr sz_Rollo eventMap on:Down off:Up
define Wetter weblink iframe http://www.wetteronline.de/cgi-bin/hpweather?PLZ=80331
attr Wetter htmlattr width="220" height="330" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter fp_Grundriss 420,25
attr ez_Aussensensor fp_Grundriss 260,75,3,temperature,Aussen
attr wakeup fp_Grundriss 560,900,1,Wakeuptime
attr wz_IRmacminiPlayPause fp_Grundriss 150,740

===Anzeige der floorplan-Konfiguration===

Wenn Sie den Detail-Bildschirm Ihres floorplan-device anzeigen, sehen Sie dort eine Übersicht aller zugordneten Geräte wie in der oberhalb dargestellten Liste.

===Include statt "save"===

Falls Sie sich angewöhnt haben, Ihre fhem-Konfiguration nicht über das Webfrontend [[FHEMWEB]] zu bearbeiten, sondern direkt in der Datei fhem.cfg, können Sie die Konfiguration Ihres floorplan anzeigen und den Inhalt in eine include-Datei übernehmen. Die Verwendung des Befehls ''save'' ist dann nicht erforderlich.
get <name> config
Beispiel:
get Grundriss config

===Arrange-Mode nur für einzelne Ports===

Der Arrange-Mode ist für den floorplan, auf dem das Attribut gesetzt ist, ausschließlich auf dem angegebenen Web-Device (also z.B. WEB) aktiviert. Das ist nützlich, wenn Sie als Entwickler immer WEB (=8083) nutzen, für Ihre Familie aber z.B. nur WEBP (=8085) "freigegeben" haben. So wird der arrange-Mode nur für Sie als Entwickler sichtbar.
Geben Sie als Attributwert den Namen des FHEMWEB-Devices an:
attr <floorplan> fp_arrange WEB

==Spezielle Formate für Ihren floorplan - floorplanstyle.css==

Das Standard-Stylesheet für floorplans ist ''floorplan.css''. Sie können aber auch den Parameter ''stylesheet'' verwenden, siehe nächstes Kapitel.

[[File:FloorplanInstallationGuide15.png]]

Hierfür gibt es eine spezielle css-Datei.
Navigieren Sie im fhem-Web-Frontend nach ''Edit Files'', dann klicken Sie auf floorplanstyle.css.

'''Hinweis:''' In der Test- und Einrichtungsphase können Sie einen Tabellen-Rahmen um ihre Geräte anzeigen lassen um das Positionieren zu vereinfachen. Dazu fügen Sie der floorplanstyle.css einfach folgenden Eintrag hinzu:
.fp_Grundriss {border:1px solid gray;}
[[File:FloorplanInstallationGuide16.png]]

Die css-Datei gestattet Ihnen das Gestalten für ganze Gruppen und/oder einzelne Geräte:
*'''''class''''' besteht aus Gerätetyp und fp_<name>
*'''''id''''' besteht aus dem Original-Gerätenamen wie im define angegeben.

Hier die css-Einstellungen, die für den Screenshot am Beginn dieses Artikels verwendet wurden:
<pre>
body { background-color: #F0F0F0;
font-family:Arial, sans-serif;
font-size:9px; background-image:url(Grundriss.bak.png);
background-repeat:no-repeat; }
#menu.fp-list { position:absolute; top:120px;left:20px; width:140px; font-size:11px; }
#logo { position:absolute; top: 10px; left: 10px;
width:64px; height:67px; background-image:url(fhem_smallscreen.png); }
#menu { position:absolute; top:120px; left:20px; width:140px; }
#menu.floorplan { position:absolute; top:120px; left:20px; width:140px; font-size:11px; }
#fpmenu.fp_arrange { position:absolute; bottom:20px; left:20px; width:310px; font-size:9px; border:1px solid gray;}
#hdr { position:absolute; top:10px; left:180px; }
#content { position:absolute; top:50px; left:180px; bottom:10px; right:10px; text-align:center}
#backimg {position:absolute; top:15px; left:190px;}

a { color: #278727; }
img { border-style: none; }
table { -moz-border-radius:8px; border-radius:8px; }

.fp_Grundriss {border:0px solid gray;}

.devicename {font-size: 11px; text-align:center; }
.devicestate {text-align:center; }
.devicecommands {font-size:14px; text-align:center; }

#sz_Rollo.devicename {font-size:14px;}
#sz_Rollo.devicecommands {font-size:12px; text-align:center; }
#ez_Aussensensor.devicestate {color:green; font-size:30px; }
#HomeStatus.devicestate {color:green; font-size:30px; }
table.dummy {width:100px; }
table.FHT {width:100px; }
#wakeup.devicestate {color:green; font-size:11px; }
#ez_FHT.devicestate {color:green; font-size:30px; }
#Home.fp_Grundriss {font-size:14px; width:100px; }
#Home.fp_Media {font-size:14px; text-align:left; }
#Media {font-size:14px; }
#Grundriss {font-size:14px; text-align:left; }

h2,h3,h4 { color:#52865D; line-height:1.3;
margin-top:1.5em; font-family:Arial,Sans-serif; }
</pre>

Die wichtigsten Einstelllungen sind:
*'''''.fp_<name>''''' legt das default-Format für die gesamte Ausgabe fest.
*'''''.devicename''''' formatiert alle Gerätenamen sofern nicht je Gerät abweichend festgelegt
*'''''.devicestate''''' formatiert alle Gerätestatus bei Ausgabe als Text (nicht als Symbol)
*'''''.devicecommands''''' formatiert alle Befehle, die unterhalb des Geräts/Symbols angezeigt werden
*'''''#backimg''''' legt die Bildschirmposition Ihres Hintergrundbilds fest

===Verwenden anderer Stylesheets===

Das Standard-Stylesheet für floorplans ist ''floorplan.css''. Sie können aber auch das Attribut ''stylesheet'' verwenden, das Ihnen die Verwendung eigener css-Stylesheets erlaubt. Sogar ein eigenes für jeden floorplan. Durch Anlegen eines eigenen Stylesheets (z.B. beginnend mit einer Kopie von floorplanstyle.css oder darkfloorplanstyle.css) können Sie Formatierungen für Ihre eigenen Devices hinterlegen, die später nicht überschrieben werden, sollte ein Update für fhem durchgeführt werden.

attr <floorplan> stylesheet myfloorplanstylesheet.css

'''Hinweis:''' Die Auswahl eines floorplan-Stylesheets erfolgt nicht in der fhem-Oberfläche unter ''Select Style''! Wählen Sie dort nur default oder dark aus!

==Verwendung besonderer Icons==

===Andere Symbole (Icons) verwenden===

fhem gestattet die Verwendung eigener Symbole (Icons). Das geht ganz einfach:

'''1.''' Icon-Bilddatei speichern (Ablageort siehe Abschnitt [[#Zuweisen eines Hintergrundbilds]])

'''2.''' Der Dateiname ist folgendermaßen aufgebaut: ''<devicename>.<state>.[jpg|png|gif]''

Beispiel: '''''sz_Rollo.on.jpg''''', '''''sz_Rollo.off.jpg'''''

Werden diese Dateien nicht gefunden, verwendet fhem die Standard-icons ''<type>.<state>.[jpg|jpg|gif]'' , also z.B. ''FS20.on.jpg'', ''FS20.off.jpg'', ...

'''3.''' Um eine konsistente Darstellung zu erreichen, verwenden Sie dieselbe Bildgröße wie die Standard-Icons, z.B. indem Sie ''FS20.on.jpg'' auf Ihren zukünftigen Icon-Namen kopieren und diese Datei dann bearbeiten, ohne die Größe zu ändern.

===Andere Symbole (Icons) im floorplan als im fhem Web-Frontend===

Um in einem floorplan andere Icons zu verwenden, als im fhem Standard-Web-Frontend (z.B. größere oder animierte Icons), werden diese einfach in einem Ordner abgelegt, der denselben Namen trägt, wie der floorplan selbst.

Beispiel:
Es existiert bereits ein floorplan namens ''PlotsPage'', darin ein Device namens ''ez_Schreibtisch''
define PlotsPage FLOORPLAN
define ez_Schreibtisch FS20 …
attr ez_Schreibtisch fp_PlotsPage 100,100,1
Die zugrundeliegende fhemweb-Instanz heißt ''WEB'' und hat die Attribute ''longpoll 1'' sowie ''iconPath default:openautomation''.
define WEB FHEMWEB global
attr WEB longpoll 1
attr WEB iconPath default:openautomation
Für die Anzeige des Device ''ez_Schreibtisch'' werden also die "ganz normalen" Icons aus dem Ordner ''www/images/default'' verwendet.

Um für dieses Device nun ein eigenes Icon zu verwenden, erzeugen Sie den entsprechenden Ordner '''''www/images/PlotsPage'''''. Darin legen Sie die Icons '''''ez_Schreibtisch.on.png''''' und '''''ez_Schreibtisch.off.png''''' ab. Anschließend rufen Sie zur Aktualisierung der Bild-Bibliothek einmal
set WEB rereadicons
auf.

Bei Anzeige des floorplans ''PlotsPage'' wird nun das Device ''ez_Schreibtisch'' mit den speziellen Icons angezeigt.
In anderen floorplans wie auch in fhemweb wird für dasselbe Device weiterhin das Icon aus dem Ordner "default" verwendet.

==Relevante Web-Instanz-Attribute==

Bitte beachten Sie, dass die folgenden Attribute des zugrundeliegenden Web-Device [[FHEMWEB]] auch für floorplans berücksichtigt werden:
{|
|style="vertical-align:top;"|'''smallscreen'''
|Der Apple Vollbildmodus wird ermöglicht: Klicken Sie in Safari auf ''Zum Homescreen hinzufügen'' um ein Icon zu erhalten, mit dem Sie fhem bzw. Ihren floorplan im Vollbildmodus - also ohne URL-Leiste - öffnen. Dadurch wirkt Ihr floorplan wie eine eigenständige App.
Außerdem wird die Bildschirmdarstellung für kleine Displays optimiert.
|-
|style="vertical-align:top;"|'''touchpad'''
|Wie smallscreen, optimiert für die Darstellung auf Tablet-PCs.
|-
|style="vertical-align:top;"|'''refresh'''
|Aktualisiert die angezeigte Browser-Seite regelmäßig.
|-
|style="vertical-align:top;"|'''plotmode'''
|Für Plots (Graphen) kann der plotmode geändert werden. Default ist SVG.
|-
|style="vertical-align:top;"|'''plotsize'''
|Für Plots (Graphen) kann die Darstellungsgröße geändert werden. Diese wird automatisch durch die Attribute ''smallscreen'' und ''touchpad'' gesetzt.
|-
|style="vertical-align:top;"|'''webname'''
|ändert die URL (default: /fhem)
|-
|style="vertical-align:top;"|'''redirectCmd'''
|Wenn Sie die Schaltbefehle für ein Gerät in der URL zum Lernen betrachten möchten, setzen Sie dieses Attribut auf 0. Es wird dann die gesamte ausgewertete URL angezeigt. Default ist 1.
|-
|style="vertical-align:top;"|'''longpoll'''
|Wenn Sie den Wert dieses Attributs auf 1 setzen (das ist auch der default), werden alle durch Icons dargestellten Schaltzustände einer bereits angezeigten Seite auch ohne ein "refresh" im Browser aktualisiert.
Dieses Attribut wirkt auch für alle floorplans, die unter dieser Webinstanz angezeigt werden.
|}

==Verwendung mehrerer floorplans==

Wenn Sie mehrere floorplans verwenden, für die Sie underschiedliche css-Stylesheets verwenden möchten, verwenden Sie das Attribut <code>stylesheet</code>.
Wenn nur wenige Formatierungen abweichen sollen, folgen Sie dem u.g. Beipiel. Für gewöhnlich müssen Sie lediglich die class ''fp_<name>'' hinzufügen, wie bei '''''.devicecommands''''' unten:

<pre>
body[id~=Grundriss] { background-color: #F0F0F0;
font-family:Arial, sans-serif;
font-size:9px;
background-image:url(Grundriss.png);
background-repeat:no-repeat; }
#logo { position:fixed; top:10px; left:20px;
width:100px; height:105px; background-image:url(fhem.png); }
#content { position:absolute; top:10px; left:10px; bottom:10px; right:10px; text-align:center}

a { color: #278727; }
img { border-style: none; }
table { -moz-border-radius:8px; border-radius:8px; }

.fp_Grundriss {border:0px solid gray;}

.devicename.fp_Grundriss {font-size: 11px; text-align:center; }
.devicestate.fp_Grundriss {text-align:center; }
.devicecommands.fp_Grundriss {font-size:14px; text-align:center; }
.devicecommands.fp_FirstFloor {font-size:8px; color:grey; text-align:center; }

#sz_Rollo.devicename.fp_Grundriss {font-size:14px;}
#sz_Rollo.devicecommands.fp_Grundriss {font-size:12px; text-align:center; }
#ez_Aussensensor.devicestate.fp_Grundriss {color:green; font-size:30px; }
#HomeStatus.devicestate.fp_Grundriss {color:green; font-size:30px; }
table.dummy.fp_Grundriss {width:100px; }
table.FHT.fp_Grundriss {width:100px; }
#wakeup.devicestate.fp_Grundriss {color:green; font-size:11px; }
#ez_FHT.devicestate.fp_Grundriss {color:green; font-size:30px; }
#Home {font-size:14px; width:100px; }
</pre>

==Standardmäßig angezeigter floorplan==

Um nach dem Klick auf ''Floorplans'' auf der fhem Startseite unter Umgehung der floorplan-Auswahl direkt in einen floorplan zu springen, ordnen Sie das ''fp_default''-Attribut einem Ihrer floorplans zu. So gelangen Sie direkt in Ihren default-floorplan, in dem Sie über das Menü auf der linken Seite in andere floorplans weiterspringen können.
attr <floorplan-name> fp_default 1
Sie können dieses Attribut einfach in der Detail-Ansicht Ihres floorplans anlegen:
[[File:FloorplanInstallationGuide17.png]]

==Ohne Menü==
Um einen völlig leeren floorplan – auch ohne Menü - zu erhalten, verwenden Sie das Attribut ''fp_noMenu''.
attr Grundriss fp_noMenu 1

'''Hinweis:''' Bedenken Sie, dass sie Ihren floorplan nicht mehr über das Menü verlassen können. Möglicherweise müssen Sie die URL in Ihrem Browser ändern, um den floorplan zu verlassen.

Alternativ können Sie eigene "Menüpunkte" einfügen wie in [[#Weblinks]] und [[#Weblink mit Bild]] beschrieben.

==Anderes Hintergrundbild==

Wenn der Name Ihres Hintergrundbilds unabhängig sein soll vom Namen des floorplan, verwenden Sie das Attribut ''fp_backgroundimg''.
attr Grundriss fp_backgroundimg dateiname.png

'''Tipp:''' Sie können z.B. nachts ein anderes Hintergrundbild verwenden, als tagsüber:
define a_fpbackimg at +*01:00 { \
if ( isday() ) {fhem "attr Grundriss fp_backgroundimg Tag.png"} \
else {fhem "attr Grundriss fp_backgroundimg Nacht.png"} }

==Beispiele: Screenshot & Definition==
Es folgen einige Beispiele mit einem Screenshot, den zugehörigen Attributen und relevanten Einträgen in der css-Datei.
===Nur Symbol===
[[File:FloorplanInstallationGuide18.png]]
define ez_LichtRegal FS20 6969 01
attr ez_LichtRegal fp_Grundriss 220,230,0
attr ez_LichtRegal model fs20st
attr ez_LichtRegal room Esszimmer

===Beschreibung und Symbol===
[[File:FloorplanInstallationGuide19.png]]
define ku_Downlight FS20 696e 00
attr ku_Downlight fp_Grundriss 620,520,1
attr ku_Downlight model fs20st
attr ku_Downlight room Kueche

===Beschreibung, Symbol und Befehle===
[[File:FloorplanInstallationGuide20.png]]
define sz_Leselampe FS20 696b 00
attr sz_Leselampe fp_Grundriss 460,900,2,Leselampe
attr sz_Leselampe webCmd on:dim50%:off
attr sz_Leselampe eventMap on:on dim50%:half off:off
attr sz_Leselampe model fs20di
attr sz_Leselampe room Schlafzimmer

===Beschreibung und State===
[[File:FloorplanInstallationGuide21.png]]
define HomeStatus dummy
attr HomeStatus fp_Grundriss 110,75,1

#HomeStatus.devicestate {color:green; font-size:30px; }

===FHT-Temperatur===
[[File:FloorplanInstallationGuide22.png]]
define ez_FHT FHT 5151
attr ez_FHT fp_Grundriss 330,75,1,Innen
attr ez_FHT retrycount 3
attr ez_FHT room Wohnung,Esszimmer

#ez_FHT.devicestate {color:green; font-size:30px; }

===Device-Reading===
[[File:FloorplanInstallationGuide23.png|none]]
Z.B. können einzelne S300TH-Readings direkt angezeigt werden, wenn sie die Darstellung mit T: x H:y vermeiden möchten. Verwenden Sie dafür Stil 3. Verwenden Sie die Reading-ID (Groß-/Kleinschreibung beachten) als Beschreibung.
Besonderheit an diesem Stil: Die Beschreibung kann entweder nur die Reading-ID enthalten oder die Reading-ID gefolgt von der Anzeige-Beschreibung, leerstellenfrei getrennt durch ein Komma.

Beispiele:

[[File:FloorplanInstallationGuide24.png]]
ergibt
[[File:FloorplanInstallationGuide23.png]]

[[File:FloorplanInstallationGuide25.png]]
ergibt
[[File:FloorplanInstallationGuide26.png]]

define ez_Aussensensor CUL_WS 1
attr ez_Aussensensor fp_Grundriss 260,75,3,temperature,Aussen
attr ez_Aussensensor model S300
attr ez_Aussensensor room Wohnung,Esszimmer

#ez_Aussensensor.devicestate {color:green; font-size:30px; }

===Temperatur & Feuchtigkeit===

[[File:FloorplanInstallationGuide09.png|none]]
S300TH-Sensoren liefern Messwerte zu Temperatur und Feuchtigkeit. Wollen Sie beide anzeigen, verwenden Sie Stil 4.

'''Hinweis:''' Um die Beschreibung auszublenden, geben Sie im Beschreibungsfeld '''''&nbsp''''' ein.

define ez_Aussensensor CUL_WS 1
attr ez_Aussensensor fp_PlotsPage 100,600,4,Außen
attr ez_Aussensensor model S300
attr ez_Aussensensor room Wohnung,Esszimmer

.fp_tempvalue {color:red; font-size:20px; }
.fp_humvalue {color:blue; font-size:20px; }

===Weblinks===
[[File:FloorplanInstallationGuide27.png]]
<pre>
define Home weblink link http://fritz.box:8083/fhem
attr Home fp_Grundriss 50,75,0,Home
</pre>

#Home {font-size:14px; width:100px; }

'''Hinweis:''' Da floorplans eine eigene URL haben, können Sie auch eigene links auf andere floorplans verwenden.

===Weblink mit Bild===
Wie im vorhergehenden Beispiel gezeigt, können Sie '''''weblink link''''' verwenden, um einen Text-Anchor zum Wechsel zu anderen URLs zu verwenden. Da floorplans eine eigene URL haben, können Sie so auch zwischen floorplans wechseln.

Wenn Sie als Link statt eines Texts ein Bild verwenden möchten, verwenden Sie dieses Beispiel:
<pre>define ImageAnchor weblink htmlCode { '<a href="http://<ip>:<port>/fhem/floorplan/Grundriss2"><img src="/icons/pic.png"></a>' }</pre>
*'''href''' gibt die URL an, zu der Sie springen möchten, z.B. ein anderer floorplan.
*'''img''' gibt den Pfad der Bilddatei an
Nachdem Sie diesen ''weblink htmlCode'' definiert haben, können Sie ihn zu ihrem floorplan hinzufügen.

===Bilddatei einfügen===
Um eine Bilddatei ohne Link einzufügen, verwenden Sie statt ''weblink htmlcode'' einfach '''''weblink image''''', Details siehe [http://fhem.de/commandref.html#weblink commandref].

===Eigene Readings-Listen anzeigen===

Das Einbinden beliebiger Listen von Device-Readings lässt sich ebenfalls mit ''weblink htmlCode'' erreichen.
#Laden Sie dazu aus [http://fhem.svn.sourceforge.net/viewvc/fhem/trunk/fhem/contrib/95_FLOORPLAN/?sortby=file diesem] SVN-Ordner die Datei '''''99_myFloorplanList.pm''''' herunter.
#Passen Sie die Zeilen im Abschnitt '''''## Change this list as needed''''' auf Ihre Bedürfnisse an. Sie können in diesem Abschnitt ggf. Zeilen löschen oder auch hinzufügen.
#Laden Sie mit dem fhem-Befehl '''''reload 99_myFloorplanList.pm''''' neu - ebenso nach jeder weiteren Programmänderung. Achten Sie nach jedem reload auf eventuelle Fehlermeldungen im Log.
#Binden Sie die Routine in das webfrontend ein mit <code>define w_WertListe1 weblink htmlCode {doWertListe1()}</code>
#Dieser Weblink kann nun auf Ihrem floorplan hinzugefügt werden [[File:FloorplanInstallationGuide28.png|none]]

Das Ergebnis sieht dann z.B. so aus:
[[File:FloorplanInstallationGuide29.png|none]]

===iFrames, z.B. Wettervorhersage===
[[File:FloorplanInstallationGuide30.png|none]]
<pre>
define Wetter weblink iframe http://www.wetteronline.de/cgi-bin/hpweather?PLZ=80331
attr Wetter fp_Grundriss 420,25
attr Wetter htmlattr width="220" height="330" frameborder="0" marginheight="0" marginwidth="0"
attr Wetter room Plots
</pre>

==Anwendungsbeispiele==
* Aktuelle Uhrzeit auf einem FLOORPLAN anzeigen: {{Link2Forum|Topic=23629|Message=169082}}
* Animierte SVG-Icons für responsiven Floorplan: {{Link2Forum|Topic=26673|Message=196337}}
* [[Floorplan FHT Temperatur]]
* [[Remotecontrol]]
* [[Browsersteuerung, Seiten per JS autom. aufrufen]]
[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-01T09:51:15Z

Uli: /* Mehrere Devices schalten */

{{Baustelle}}
Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.
Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bittte mit dem Autor abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

'''Hinweis:''' Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

'''Hinweis:''' Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 off
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 off''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 off'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 off;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort schalten, aber erst nach dem Event von mySchalter1 schalten myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

'''Hinweis:''' Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;sleep 60;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-01T09:47:57Z

Uli: /* Mehrere Devices schalten */

{{Baustelle}}
Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.
Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bittte mit dem Autor abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

'''Hinweis:''' Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

'''Hinweis:''' Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhalb eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 on
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 on''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 on'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 on

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 on;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort einschalten, und erst nach dem Event von maSchalter1 auch myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

'''Hinweis:''' Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;sleep 60;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-01T09:44:33Z

Uli:

{{Baustelle}}
Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.
Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bittte mit dem Autor abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

'''Hinweis:''' Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

'''Hinweis:''' Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

Auch innerhlab eines notify (oder anderen fhem-Befehlen) kann man mehrere Befehle auflisten, jedoch ist hier eines zu beachten:
define n1 notify mySchalter1:on set myLampe1 on;set myLampe2 on
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das notify schaltet myLampe1 wann immer mySchalter1 den Event on sendet. Der nächste Befehl in dieser Zeile ist ''set myLampe2 on''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst nach dem Event von mySchalter1.

Soll auch der zweite Befehl ''set myLampe2 on'' erst nach dem Event ausgeführt werden, muss ein doppeltes Semikolon genutzt werden:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 on

Die kombinierte Variante könnte so aussehen:
define n1 notify mySchalter1:on set myLampe1 on;;set myLampe2 on;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort einschalten, und erst nach dem Event von maSchalter1 auch myLampe1 und myLampe2.

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

'''Hinweis:''' Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;sleep 60;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-01T09:36:08Z

Uli: /* at mit mehreren Befehlen */

{{Baustelle}}
Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.
Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bittte mit dem Autor abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

'''Hinweis:''' Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

'''Hinweis:''' Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

'''Hinweis:''' Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

==at mit mehreren Befehlen==

Wie wir zuvor gesehen haben, kann man mehrere fhem-Befehle in einer Zeile durch Semikolon-getrennte Auflistung kombinieren, z.B.
set myLampe1 on;set myLampe2 on
Das geht auch bei einem at, jedoch ist hier eines zu beachten:
define a4 at *12:00 set myLampe1 on;set myLampe2 on
Die Befehle sind durch ein Semikolon getrennt. Effekt ist: das at wird um 12:00 ausgeführt und schaltet myLampe1. Der nächste Befehl in dieser Zeile ist ''set myLampe2 on''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet. Es schaltet also myLampe2 sofort, myLampe1 erst um 12:00 .

Soll auch der zweite Befehl ''set myLampe2 on'' erst um 12:00 ausgeführt werden, muss man ein doppeltes Semikolon nutzen:
define a4 at *12:00 set myLampe1 on;;set myLampe2 on

Die kombinierte Variante könnte so aussehen:
define a5 at *12:00 set myLampe1 on;;set myLampe2 on;set myLampe3 on
Diese Befehlszeile würde also myLampe3 sofort einschalten, und erst um 12:00 auch myLampe1 und myLampe2.

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;sleep 60;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-10-01T09:33:07Z

Uli: Kapitel "at mit mehreren Befehlen" hinzugefügt

{{Baustelle}}
Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.
Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bittte mit dem Autor abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

'''Hinweis:''' Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

'''Hinweis:''' Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

'''Hinweis:''' Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

==at mit mehreren Befehlen==

Wie wir zuvor gesehen haben, kann man mehrere fhem-Befehle in einer Zeile durch Semikolon-getrennte Auflistung kombinieren, z.B.
set myLampe1 on;set myLampe2 on
Das geht auch bei einem at, jedoch ist hier eines zu beachten:
define a4 at *12:00 set myLampe1 on;set myLampe2 on
Die Befehle sind mit einem smikolon getrennt. Effekt ist; das at wird um 12:00 ausgeführt und schaltet myLampe1. Der nächste Befehl in dieser Zeile ist ''set myLampe2 on''. Dieser wird '''sofort''' bei der Eingabe der o.g. Befehlszeile abgearbeitet.
Soll auch der zweite Befehl ''set myLampe2 on'' erst um 12:00 ausgeführt werden, muss man ein doppeltes Semikolon nutzen:
define a4 at *12:00 set myLampe1 on;;set myLampe2 on

define a5 at *12:00 set myLampe1 on;;set myLampe2 on; set myLampe3 on
Dieses define würde also myLampe3 sofort einschalten, und erst um 12:00 auch myLampe1 und myLampe2.

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;sleep 60;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-09-30T19:55:50Z

Uli:

{{Baustelle}}
Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und nach dem installieren der fhem-Software sofort loslegen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.
Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bittte mit dem Autor abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

'''Hinweis:''' Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

'''Hinweis:''' Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

'''Hinweis:''' Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;sleep 60;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

[[Kategorie:HOWTOS]]

Erste Schritte in FHEM

2015-09-30T19:55:04Z

Uli:

{{Baustelle}}
Für alle, die das erste mal mit fhem arbeiten, hier ein kleiner Kurs zum Einstieg.
Dieser ist so aufgebaut, dass man noch keine Hardware benötigt und erst einmal testen kann.

Diese Anleitung wurde ursprünglich von Ulrich Maass publiziert, der die Genehmigung erteilt hat, sie auch im Wiki zu veröffentlichen.
Anmerkung zur Bearbeitung: Korrekturen von Tippfehlern kann jeder machen. Redaktionelle Änderungen und Erweiterungen aber bittte mit dem Autor abstimmen.

==Der erste Einstieg==
Um fhem zum ersten Mal aufzurufen, geben Sie im Browser ein:
<nowiki>http://<ip-Adresse>:8083</nowiki>
also z.B. <nowiki>http://192.168.1.1:8083</nowiki>.
Sie gelangen auf den Startbildschirm:

[[Datei:ErsteSchritteInFhem01.png]]

*Am oberen Bildschirmrand sehen Sie das weiße ''Kommandofeld'', in das Sie Befehle tippen können.
*Als ersten Menüpunkt sehen Sie die Schaltfläche ''Save config'', mit der Änderungen so gespeichert werden, dass sie auch nach einem Neustart noch vorhanden sind.
*Außerdem gibt es bereits die Räume ''Unsorted'' und ''Everything'', die wir bald kennenlernen.
*Im unteren Block befinden sich weitere Links, auf die wir später ebenfalls eingehen.

Der Hinweis ''Security Check'' besagt, dass Sie noch kein Passwort für fhem eingerichtet haben. Wie man einen Passwortschutz einrichten kann, steht in der fhem-Befehlsreferenz [http://fhem.de/commandref_DE.html commandref], in der es übrigens eine Beschreibung zu allen Funktionen und Modulen von fhem gibt. Um diese Meldung erst einmal zu unterdrücken, geben Sie in das Kommandofeld ein:
attr global motd none
und bestätigen Ihre Eingabe mit der {{Taste|Enter}}-Taste.

[[Datei:ErsteSchritteInFhem02.png]]

==Device anlegen - define==

Um fhem kennenzulernen, legen wir erst einmal einige "Dummy"-Devices an. So können Sie diese Tests auch ohne ein Hardware-System durchführen bzw. kann hier eine allgemeine Einführung erfolgen, ohne auf die Unterschiede der einzelnen Hardwaresysteme einzugehen. Ein Dummy-Device sieht auf der fhem-Oberfläche im Allgemeinen genau so aus, wie ein fhem-Device zu einem "echten" Gerät Ihres Hardwaresystems.

Zunächst legen wir einen Schalter an. Dieser soll einen Lichtschalter an der Wand simulieren. Geben Sie dazu folgenden Befehl in das Kommandofeld ein:
define mySchalter1 dummy
Nach drücken der {{Taste|Enter}}-Taste wird die Detail-Ansicht des neuen fhem-Device ''mySchalter1'' angezeigt.

[[Datei:ErsteSchritteInFhem03.png]]

Der Block '''''Internals''''' zeigt immer die grundlegende Ausprägung eines fhem-device an:
*'''''NAME''''' ist der von Ihnen vergebene Name.
*'''''TYPE''''' ist der Typ des fhem-device, hier dummy.
*'''''STATE''''' ist der in allen Übersichten angezeigte Status des Geräts. Da noch keine Zuordnung stattgefunden hat, ist dieser zunächst '''''???'''''.

==Räume definieren==
In Räumen können Sie Geräte gruppieren, die sich auch physisch in einem Raum (Wohnzimmer, Schlafzimmer, etc.) befinden.

Um ein Device einem Raum zuzuordnen (der Raum muss zu diesem Zeitpunkt noch nicht existieren), verwenden Sie folgenden Befehl:
attr mySchalter1 room Schulungsraum

Nach Eingabe dieses Befehls in das Kommandofeld und Abschließen der Eingabe mit {{Taste|Enter}} ist das Device dem Raum ''Schulungsraum'' zugeordnet. Durch diese Zuordnung ist dieser Raum in der Navigationsleiste links zur Liste der Räume hinzugefügt worden.

Klicken Sie einmal auf den Raum ''Schulungsraum''.

[[Datei:ErsteSchritteInFhem04.png]]

Es werden nun alle Geräte angezeigt, die diesem Raum zugeordnet wurden. Bisher haben wir hier nur ein Gerät: ''mySchalter1''. Es wird in einem Block mit der Typbezeichnung ''dummy'' dargestellt.
Neben dem Device-Namen wird immer der Status des Device angezeigt, hier noch ''???''.
Wenn Sie auf den Namen ''mySchalter1'' klicken, gelangen Sie wieder in dessen Detailansicht.

==Schaltbefehle definieren==
Nun soll unser ''mySchalter1'' Schalterflächen für ''on'' und ''off'' bekommen.
attr mySchalter1 webCmd on:off

Statt den o.g. Befehl in das Kommandofeld einzugeben, können Sie auch im unteren Bereich der Detailansicht das gewünschte Attribut (hier: '''''webCmd''''') auswählen und in dem Textfeld rechts daneben die gewünschten Werte eintragen, hier '''''on:off'''''. Schließen Sie Ihre Eingabe durch Klick auf den Button '''''attr''''' ab.

[[Datei:ErsteSchritteInFhem05.png]]

Klicken Sie nun wieder links auf den ''Schulungsraum''.

Sie sehen, dass durch die Attribut-Angabe im vorhergehenden Schritt, nun in der Raumansicht die Schaltflächen für ''on'' und ''off'' hinzugekommen sind.

[[Datei:ErsteSchritteInFhem06.png]]

Klicken Sie versuchsweise auf ''on'' und ''off'': Statt der bisher angezeigten ''???'' erscheint nun ein Glühbirnensymbol, das den aktuellen Status darstellt.

Wenn Sie durch Klicken auf den Device-Namen ''mySchalter1'' wieder in die Detailansicht wechseln, sehen Sie, dass im Block ''Internals'' nun auch der aktuelle Zustand ''STATE'' angezeigt wird. Dieser wird in der Raumansicht als Icon (Glühbirne) dargestellt.

[[Datei:ErsteSchritteInFhem07.png]]

Auch sehen Sie im Detail-Bildschirm einen neuen Block ''Readings''. Dieser zeigt Informationen an, die - anders als Attribute - nicht direkt vom Anwender geändert werden können. Unter anderem werden hier Datum und Uhrzeit der letzten Zustandsänderung angezeigt.

Schalten Sie ''mySchalter1'' noch einmal aus und prüfen Sie, ob das Reading ''STATE'' incl. seines Zeitstempels aktualisiert wurde.

==Event Monitor==

Öffnen Sie nun in Ihrem Browser ein zusätzliches Fenster, in dem Sie ebenfalls fhem und darin den '''Event Monitor''' anzeigen. Am Schnellsten geht das, indem Sie mit der rechten Maustaste auf ''Event Monitor'' klicken und aus dem Kontextmenü des Browsers ''Öffnen in neuem Fenster'' auswählen. Legen Sie die Fenster so übereinander, dass Sie gleichzeitig den Event Monitor sehen und Ihren ''mySchalter1'' bedienen können. Unter Windows ab Version 7 geht das am Einfachsten, wenn Sie zuerst das eine Fenster aktivieren und {{Taste|Windows}}+{{Taste|Pfeil rechts}} drücken, anschließend das selbe mit dem anderen Fenster und {{Taste|Windows}}+{{Taste|Pfeil links}} wiederholen.

[[Datei:ErsteSchritteInFhem08.png]]

Bei jedem Schalten von ''mySchalter1'' wird in fhem ein Ereignis, englisch event, ausgelöst. Bei jeder Betätigung des Schalters erscheint ein neuer Event im ''Event Monitor''. Probieren Sie auch, was passiert, wenn Sie zweimal hintereinander auf ''on'' klicken.

Ein Event besteht immer aus dem Zeitstempel, gefolgt vom Typ des auslösenden Gerätes (hier ''dummy''), dem auslösenden Device-Namen (hier ''mySchalter1''), sowie dem ausgelösten Befehl (hier ''on'' oder ''off'').

Auch "echte" sendende fhem-Geräte, also z.B. eine Fernbedienung oder ein Funkschalter an der Wand, lösen bei jedem Tastendruck auf dieses Gerät oder bei Klick auf das zugehörige fhem-Device einen Event aus. Das Verständnis von Events und wie sie aufgebaut sind ist also elementar, wir werden sie noch oft benötigen. Probieren Sie ein wenig damit herum.

==Schalten von Geräten - set==
''mySchalter1'' kann also über Klicken auf ''on'' oder ''off'' geschaltet werden. Alternativ geht das auch über die Eingabe eines Befehls in das Kommandofeld.

Geben Sie dazu in das Kommandofeld <code>set mySchalter1 on</code> oder <code>set mySchalter1 off</code> ein und bestätigen jeweils mit der {{Taste|Enter}}-Taste. Auch hierbei ändert sich der Schaltzustand und ein Event wird ausgelöst. Den ''set''-Befehl werden wir ebenfalls noch häufig verwenden.

Für weitere Tests legen wir nun ein neues Device '''''myLampe1''''' an. Diese wollen wir später mit '''''mySchalter1''''' bedienen.
define myLampe1 dummy
Da dies eine Lampe, also einen Aktor darstellen soll, werden wir der Lampe selbst keine Buttons für ''on'' oder ''off'' geben.

Die Lampe soll im Schulungsraum stehen. Diese Zuordnung könnten Sie wie zuvor über die Kommandozeile erreichen. Diesmal sind wir aber tippfaul und möchten die Zuordnung durch Klicken vornehmen.

Da ''myLampe1'' noch keinem Raum zugeordnet ist, erscheint sie im Raum ''Unsorted''. Wechseln Sie in diesen Raum und klicken Sie auf den Namen von ''myLampe1'', um in die Detailansicht zu gelangen.

[[Datei:ErsteSchritteInFhem09.png]]

Im unteren Bereich können wir wieder die Attributzuordnung vornehmen.

Praktischerweise ist das Attribut ''room'' bereits ausgewählt, auch der Raum ''Schulungsraum'' ist bereits voreingestellt. Sie müssen also nur noch auf den Button '''''attr''''' klicken.

Wechseln Sie nun wieder in den Raum ''Schulungsraum''. Es werden beide Geräte angezeigt.

[[Datei:ErsteSchritteInFhem10.png]]

==Bei Event ausführen - notify==

Im nächsten Schritt werden wir fhem beibringen, auf einen Event von ''mySchalter1'' zu reagieren. Immer dann, wenn ''mySchalter1'' einen Event mit dem Befehl ''on'' auslöst, soll ''myLampe1'' eingeschaltet werden.
Dazu wird in fhem ein "notify" verwendet. Die Befehlsstruktur ist
define <NAME> notify <REGEXP> <command>

*Der Name '''<name>''' dient später dazu, dieses fhem-Device anzeigen und wiederfinden zu können. Als Name verwende ich hier ''n_mySchalter1_on'', also ''n_'' um es als Notify kenntlich zu machen, dann das auslösende Gerät ''mySchalter1'' und den auslösenden Event ''on''. Dieser Name scheint jetzt kompliziert, ist aber hilfreich, wenn Sie später mehrere Notify angelegt haben. Sie können es ganz nach Gusto auch ''n1'' nennen oder ''Karlheinz''. Device-Namen dürfen aus den Zeichen '''a-z''', '''A-Z''', '''0-9''', Unterstrich '''_''' und Punkt '''.''' bestehen, wobei ein Punkt nicht an erster Stelle stehen darf. Sie werden später sehen, dass der Punkt in perl und damit fhem eine besondere Bedeutung hat, wenn möglich sollten Sie daher auf seine Verwendung in Device-Namen verzichten.
*'''<regex>''' steht für "Regular Expression" und ist die Bedingung, unter der das Notify ausgeführt werden soll. Wann immer in fhem ein Event auftritt, wird für alle vorhandenen Notify geprüft, ob die angegebene Regex zutrifft. Der auslösende Event ist in unserem Fall, dass ''mySchalter1'' ein Event mit dem Befehl ''on'' erzeugt. Dafür wird für die Regular Expression die Schreibweise <code>mySchalter1:on</code> verwendet. Regular Expressions werden in perl und fhem häufig verwendet, Sie werden sich damit später detaillierter auseinandersetzen dürfen :)
*'''<command>''' definiert, was denn eigentlich ausgeführt werden soll. In unserem Beispiel soll das <code>set myLampe1 on</code> sein.

Unser Notify wird also erstellt mit
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on

Nach Eingabe dieses Befehls in das Kommandofeld, abgeschlossen durch {{Taste|Enter}}, sehen Sie wieder die Detailansicht des neuen fhem-Device, also des Notify (siehe TYPE).

[[Datei:ErsteSchritteInFhem11.png]]

Im Block ''Internals'' sehen Sie hier die Definition '''DEF'''. Angezeigt wird hier alles, was bei der Definition nach dem Wort "notify", also nach dem Gerätetyp angegeben wurde. Es erscheinen also ''<regexp>'' und ''<command>''.

Im unteren Bereich werden die fhem-Devices angezeigt, die mit dem Notify verbunden sind. Die Geräte werden als klickbare Device-Namen angezeigt. Das ist praktisch, da man so mit einem Klick zur Detailansicht des jeweiligen Geräts springen kann.

Ordnen Sie auch das Notify unserem Schulungsraum zu (im unteren Bereich das Attribut ''room'' und den passenden Raum auswählen und dann auf ''attr'' klicken).

Wenn Sie nun im fhem-Menü auf Schulungsraum klicken, werden unsere drei fhem-Devices angezeigt.

[[Datei:ErsteSchritteInFhem12.png]]

'''Hinweis:''' Üblicherweise würde man das Notify nicht dem Raum zuordnen, da es später für den Benutzer gar nicht sichtbar sein soll. Für unsere Testdurchläufe ist es aber praktischer.

Wenn Sie nun ''mySchalter1'' auf ''on'' schalten, wird auch ''myLampe1'' auf ''on'' geschaltet. Das funktioniert scheinbar nur beim ersten Mal – wenn Sie aber den Event Monitor prüfen oder in der Detailansicht von ''myLampe1'' auf den Zeitstempel der letzten Statusänderung schauen, werden Sie sehen, dass es jedes Mal ausgeführt wird.

Damit das Ganze auch beim Ausschalten funktioniert, legen Sie ein zweites notify an:
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
Funktioniert es wie erwartet?

Natürlich möchte man nicht für jeden Befehl, den ein Device auslöst, ein eigenes Notify anlegen. Es geht auch einfacher.
Statt
define n_mySchalter1_on notify mySchalter1:on set myLampe1 on
define n_mySchalter1_off notify mySchalter1:off set myLampe1 off
definieren wir nun
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
Wir sehen, dass die Regex nun nicht mehr unterscheidet, ob ''mySchalter1'' den Event ''on'' oder ''off'' sendet. Lassen wir diese Angabe weg, löst dieses Notify bei jedem Event von ''mySchalter1'' aus, egal mit welchem Kommando. Im auszuführenden ''set''-Befehl verwenden wir nun die fhem-Variable '''$EVENT''' (Groß/Kleinschreibung beachten!). Dies ist ein Platzhalter für den Befehl, der vom auslösenden Event übernommen wird. Wenn also ''mySchalter1'' ein ''on'' auslöst, nimmt '''$EVENT''' den Wert ''on'' an. Entsprechend für ''off'' oder jeden anderen Befehl.

==Devices löschen oder deaktivieren – delete, disable==
Wenn Sie den Event Monitor beachten, werden Sie sehen, dass nach jeder Betätigung von ''mySchalter1'' der Befehl für ''myLampe1'' nun zweimal ausgeführt wird. Das liegt daran, dass auf jeden Event von ''mySchalter1'' zwei Notify reagieren – sowohl die "alten" Notify wie auch das Neue. Um dies zu umgehen, müssen wir die alten Notify loswerden. Dazu gibt es zwei Möglichkeiten.

#Löschen Sie ein Notify mit dem Befehl <code>delete <name></code>, z.B. mit <code>delete n_mySchalter1_on</code>. Der <code>delete</code> Befehl funktioniert übrigens für jedes Objekt in fhem. Sie können damit also auch "echte" Devices löschen.
#Deaktivieren Sie ein Notify, indem Sie das Attribut ''disable'' verwenden. Das können Sie wieder über die Detailansicht des Notify setzen (im unteren Bereich das Attribut ''disable'' auswählen und den Wert ''1'' auswählen), oder in der Kommandozeile <code>attr n_mySchalter1_off disable 1</code> eingeben.

==Save Config==

Wann immer Sie mit dem aktuellen Zustand Ihrer fhem-Konfiguration zufrieden sind, klicken Sie im fhem-Menü oben links einmal auf '''''Save config''''' oder geben Sie in das Kommandofeld den Befehl <code>save</code> ein. Ihre Konfiguration wird nun gespeichert. Tun Sie das nicht, sind alle Änderungen nach dem nächsten fhem-Neustart '''verloren'''.

==Bestehende Devices verändern – modify==

Wir legen nun eine zweite Lampe an, die ebenfalls durch unseren ''mySchalter1'' und unser Notify geschaltet werden soll.
Die neue Lampe wird durch folgende Eingabe in das Kommandofeld erzeugt:
define myLampe2 dummy

Durch "Zusammenklicken" im Detail-Bildschirm von ''myLampe2'' ordnen Sie diese ebenfalls dem Raum ''Schulungsraum'' zu und weisen ihr über das Attribut ''webCmd'' Schaltflächen für ''on'' und ''off'' zu.

Nun passen wir das Notify ''n_mySchalter1'' an. Dazu navigieren Sie auf den Detail-Bildschirm des Notify: Wechseln Sie in den Raum ''Schulungsraum'' und klicken Sie auf den Namen von ''n_mySchalter1''.

Im Detail-Bildschirm befindet sich die Zeile ''DEF'', die wir uns vorhin schon einmal angeschaut haben. Wenn Sie auf das Wort ''DEF'' klicken, können Sie die Definition eines fhem-Objekts bearbeiten.

'''Hinweis:''' Im Feld ''DEF'' wird nur der Teil der Definition angezeigt, der beim Anlegen dieses Notify nach dem Objekttyp, also ''notify'' folgt. Sie finden hier also zunächst die Regex auf die das Notify reagiert, dann nach einer Leerstelle den auszuführenden Befehl.
Der Lesbarkeit halber ist im Folgenden immer das gesamte define-Statement dargestellt, auch wenn man es im Feld ''DEF'' nicht vollständig sieht.

Wir ändern hier also von
define n_mySchalter1 notify mySchalter1 set myLampe1 $EVENT
zu
define n_mySchalter1 notify mySchalter1 set myLampe1,myLampe2 $EVENT

Zum Beenden der Bearbeitung klicken Sie auf die Schaltfläche '''''modify <name>''''', hier also '''''modify n_mySchalter1'''''. Wenn Sie die Angaben im Detail-Bildschirm prüfen, sehen Sie, dass die ''DEF''inition des Notify angepasst wurde.
Beachten Sie auch hier wieder, dass im Detailscreen im unteren Bereich unter ''Probably associated with'' die geschalteten Lampen erscheinen – das wird noch oft nützlich sein.

Nun können Sie testen, ob ein Klick auf ''mySchalter1'' auch wirklich beide Lampen schaltet. Schauen Sie sich dabei auch wieder in einem separaten Fenster mit dem Event Monitor die entstehenden Events an.

==Mehrere Devices schalten==

Zum Schalten mehrerer Devices kann also verwendet werden
set <device1>,<device2> on

Eine alternative Schreibweise dafür ist
set <device1> on; set <device2> on

Auch eine Kombination ist möglich:
set <device1>,<device2> on; set <device3> off

==Devices umbenennen==

Schließlich wollen wir (zur Übung) noch ein Device umbenennen: Aus '''''myLampe2''''' soll '''''myStehlampe''''' werden. Dafür verwenden wir
rename <alterName> <neuerName>

Hierbei ist zu beachten, dass zugehörige notify-Anweisungen '''nicht''' automatisch aktualisiert werden. Beachten Sie also vor dem Umbenennen im unteren Bereich des Detail-Bildschirms die Liste ''Probably associated with'', damit Sie bei der folgenden Anpassung keines Ihrer Notify vergessen.

Geben Sie also in das Kommandofeld ein
rename myLampe1 myStehlampe
und passen Sie anschließend ''n_mySchalter1'' an, indem Sie auf dessen Detail-Bildschirm im Bereich ''DEF'' die Definition anpassen.

Nach der Änderung muss das Notify lauten
define n_mySchalter1 notify mySchalter1 set myLampe1,myStehlampe $EVENT

==Zeitgesteuert schalten - at==

Im nächsten Schritt soll eine Zeitsteuerung eingerichtet werden.
Zunächst möchten wir erreichen, dass ''myLampe1'' nach einer Minute ausgeschaltet wird wie z.B. ein Treppenhauslicht.

'''Hinweis:''' Damit Sie den Effekt sehen können, schalten Sie ''myLampe1'' vorher auf ''on''.

Für Zeitsteuerungen gibt es den fhem-Device-Typ ''at''. Die Befehlsstruktur ist
define <name> at <timespec> <command>
'''<name>''' und '''<command>''' haben hier dieselbe Funktion wie bei notify. Neu ist hier lediglich '''<timespec>''' (time specification), also die Zeitangabe. Diese erfolgt in der Schreibweise ''HH:MM:SS'' oder ''HH:MM''.

Um '''''myLampe1''''' also '''in einer Minute auszuschalten''', erzeugen Sie folgendes ''at'':
define a_myLampe1 at +00:01:00 set myLampe1 off

Probieren Sie es aus.
Wird ''myLampe1'' nach einer Minute ausgeschaltet?
Wird dabei ein Event erzeugt?

Wenn Sie sich die Detailansicht des ''at'' anschauen möchten, müssen Sie sich übrigens beeilen: Nach der einmaligen Ausführung wird das ''at'' automatisch gelöscht. Falls fhem schneller war, können Sie es ja noch einmal anlegen und ggf. eine längere Zeitspanne angeben :-)

Bei <timespec> kann man die Sekunden auch weglassen und einfach nur HH:MM schreiben. Außerdem gibt es mehrere Varianten:
{|class="wikitable"
|+Varianten von Zeitangaben für ''at''
|-
!Notation
!Erklärung
|-
|style="text-align: right;"|+00:02:00
|In zwei Minuten; einmalige Ausführung
|-
|style="text-align: right;"|00:02:00
|Um zwei Minuten nach Mitternacht, also um 00:02 Uhr und 0 Sekunden; einmalige Ausführung
|-
|style="text-align: right;"|*00:02:00
|Täglich um 00:02 Uhr
|-
|style="text-align: right;"|+*00:02:00
|Alle 2 Minuten
|-
|style="text-align: right;"|+*{3}00:02
|Dreimal, alle zwei Minuten
|-
|style="text-align: right;"|*{3}00:02
|Dreimal um 00:02 Uhr
|-
|style="text-align: right;"|*{sunset_rel()}
|Täglich zu Sonnenuntergang
|-
|style="text-align: right;"|*{sunrise(+120)}
|Täglich 2 Minuten (120 Sekunden) nach Sonnenaufgang
|}
*Durch die Angabe von '''*''' wird also eine dauerhafte Wiederholung definiert. Die Wiederholungen laufen so lange, bis das ''at'' gelöscht oder disabled wird.
*Durch die Angabe von '''+''' wird die angegebene Zeit nicht mehr als absolute Uhrzeit interpretiert, sondern als Timer, nach wie vielen Stunden:Minuten:Sekunden der Befehl ausgeführt wird.
*Durch die Angabe von '''''{n}''''' wird das ''at'' nur n-mal durchlaufen.
*Die Funktionen '''''{sunset_rel()}''''' und '''''{sunrise()}''''' liefern die passende Uhrzeit zurück. Durch Angabe von '''''*''''' wird dies täglich wiederholt.

Um bspw. täglich zu Sonnenaufgang die Gartenbeleuchtung auszuschalten, definieren Sie so etwas wie
define a_GartenLicht_morgens_off at *{sunrise()} set GartenLicht off

==Timer bei einem Event starten - notify und at==

Als letzte Übung wollen wir ein ''notify'' und ein ''at'' verbinden. Der Timer soll nun nicht starten, wenn Sie den Befehl in das Kommandofeld eingeben, sondern wenn ein Event eintritt.

Dazu basteln wir uns ein Treppenhaus: Legen Sie dafür die Dummy-Devices ''th_Schalter'' und ''th_Licht'' im Raum ''Treppenhaus'' an. Zum Anlegen des Raums ''Treppenhaus'' ordnen Sie dem ersten Device den Raum über das Kommandofeld zu, alle weiteren Attribute dann durch Klicken im Detail-Bildschirm:
define th_Schalter dummy
attr th_Schalter room Treppenhaus
attr th_Schalter webCmd on
define th_Licht dummy
attr th_Licht room Treppenhaus

Nun fehlt noch das Notify, welches auf ''th_Schalter:on'' reagiert und daraufhin zwei Befehle ausführt:
*Einschalten des Treppenhauslichts mit <code>set th_Licht on</code>
*Einen Timer starten, der es nach einer Minute wieder ausschaltet. Also <code>define a1 at +00:01 set th_Licht off</code>.

Das sieht dann so aus (und muss ins Kommandofeld als '''eine''' Zeile eingegeben werden):
define n_th_Schalter_on notify th_Schalter:on
set th_Licht on;define a1 at +00:01 set th_Licht off
Beim Auslösen des Notify wird also als Kommando das Einschalten des Treppenhauslichts ausgelöst, wie auch das Definieren eines Timers, der es eine Minute später wieder ausschaltet.
Funktioniert es?

Da das ja doch recht sperrig ist, gibt es noch eine etwas einfachere Alternative:
define n_th_Schalter_on notify th_Schalter:on set th_Licht on;sleep 60;set th_Licht off

Manche Hardwaresysteme bieten auch den Befehl ''on-for-timer'', mit dem man alternativ schreiben kann
define n_th_Schalter_on notify th_Schalter:on set th_Licht on-for-timer 60

[[Kategorie:HOWTOS]]