Talk2Fhem
Talk2Fhem | |
---|---|
Zweck / Funktion | |
Das Modul stellt eine Verbindung zwischen natürlicher Sprache und FHEM Befehlen her | |
Allgemein | |
Typ | undefiniert |
Details | |
Dokumentation | ModUndef |
Support (Forum) | Unterstützende Dienste |
Modulname | 39_Talk2Fhem.pm |
Ersteller | Oliver Georgi |
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref! |
An dieser Seite wird momentan noch gearbeitet. |
Diese Seite beschreibt die Funktionsweise und Konfiguration des Moduls 39_Talk2Fhem.pm
Voraussetzungen
Es ist sehr zu empfehlen, für die Konfiguration des Moduls, im Webfrontend von FHEM die Syntaxhervorhebung zu aktivieren. Die Aktivierung des erweiterten Editors ist hier Konfiguration#Syntaxhervorhebung beschrieben.
Kenntnisse im Bereich Regulärer Ausdrücke (RegExp) in Perl sind hilfreich, aber nicht zwingend erforderlich. Ein kurzer Einstieg kann hier eingesehen werden. Modul_Talk2Fhem#Häufig_verwendete_RegExp
Allgemeines
Das Modul Talk2Fhem stellt eine Verbindung zwischen natürlicher Sprache und FHEM Befehlen her. Es ist ein überaus flexibles und relativ einfach zu konfigurierendes Script mit dem man sehr natürlich kommunizieren kann. Die Konfiguration erfolgt dabei über das FHEM Webfrontend.
Bei der Verarbeitung der Sprachbefehle erfolgt keine grammatikalische Analyse, sondern es wird auf definierte Schlüsselwörter reagiert. Das Modul erkennt von sich aus diverse Zeit- und Datumsangaben und löst bei Bedarf zu diesen Zeiten die FHEM Kommandos aus.
Funktionsweise
Die Zerlegung des Sprachbefehls erfolgt in mehreren Schritten.
- Aufteilen des Sprachbefehls in einzelne Kommandos anhand des Wortes UND
- Erkennen von Zeit- und Datumsangaben und entfernen für die weitere Verarbeitung
- Entfernung unnötiger Wörter
- Vergleich mit den definierten Schlüsselwörtern
- Konvertieren in ein FHEM Kommando
- Zeitgebundenes auslösen des FHEM Kommandos
Installation
Solange das Modul noch nicht offiziell aufgenommen wurde, muss die Datei 39_Talk2Fhem.pm manuell in das Verzeichnis FHEM/ kopiert werden. Siehe Forumsbeitrag. [1]
Definition
define talk Talk2Fhem
Zum testen der Konfiguration ist es Ratsam vorerst das Attribut disable auf 1 zu setzen. Hierbei wird die Auslösung der FHEM Kommandos unterdrückt.
attr talk disable 1
Anwendung
Der Sprachbefehl wird über das Kommando "set" an das Modul geleitet.
set talk Guten Morgen liebes Zuhause
Readings
Im Reading set steht der letzte gesendete Sprachbefehl. Im Reading cmds steht das letzte ausgeführte FHEM-Kommando.
Die Antworten und Fehler werden in den Readings answers und err ausgegben. Diese können dann über ein notify weiterverarbeitet werden.
Beispiel
Die FHEM Befehle werden eigenständig ausgeführt, sie können aber zur Überprüfung auch weitergeleitet werden. Das Beispiel zeigt auch wie auf Fehler und Antworten von Talk2Fhem reragiert werden kann. Erstellen eines Notify
define n_talk notify talk:.* {}
Folgendes in der Definition von n_talk einfügen
talk:.* { # Sende die Antwort per Telegram und gebe es über das GoogleHome aus if ($EVENT =~ s/^answers: //) { fhem("set telegram _msg \@USER $EVENT"); fhem("set d_googlespeak $EVENT"); } # Schicke den Fehler per Telegram und sag am GoogleHome das es nicht geklappt hat. if ($EVENT =~ s/^err: //) { fhem("set telbot _msg \@Oliver $EVENT"); my @a = ("Das hat leider nicht geklappt", "Es gab leider einen Fehler", "Es tut mir leid. Das hat nicht funktioniert.", "Es ist leider zu einem Fehler gekommen","Könntest du das vielleicht nochmal anders sagen", "Mhhh, das kann ich so nicht verstehen"); fhem("set d_googlespeak $a[int(rand($#a))]"); } # Schick mir alle ausgeführten Befehle als Telegram if ($EVENT =~ s/^cmds: //) { fhem("set telbot _msg \@USER $EVENT"); } }
Zeitenerkennung
Die Zeit- und Datum Eingabe kann auf viele verschiedene Arten erfolgen.
Die Datumerkennung umfasst folgende Phrasen:
- morgen, übermorgen
- in ... Wochen, Monat, Jahr
- nächste Woche, Monat, Jahr
- Wochentage
- in ... Tagen
- am DATUM
Die Zeiterkennung umfasst folgende Phrasen:
- in,nach ... stunden,minuten,sekunden
- um ... (Uhr) (...)
- heute - entspricht 12:00
- früh - entspricht 9 Uhr
- abend - entspricht 18 Uhr
- nachmittag - entspricht 16 Uhr
- vormittag - entspricht 10:30 Uhr
- mittag - entspricht 12 Uhr
- gleich - entspricht 5 Minuten
- nachher - entspricht 30 Minuten
- später - entspricht 1 Stunde
- jetzt
- sofort
Datum und Zeitangaben können natürlich kombiniert werden.
Wird eine Zeit erfolgreich erkannt erfolgt die Ausführung des FHEM-Kommandos über das Modul at. Es wird ein at Eregnis angelegt welches den Namen at_<modulname>_<zeitindex> erhält.
Bei mehreren Kommandos über das Schlüsselwort UND wirkt sich der Zeitpunkt des ersten Kommandos auch auf das zweite und dritte ... aus.
Schalte die Heizung um 20 Uhr aus und mache die Rollläden runter
Beide Kommandos werden um 20 Uhr ausgelöst.
Hat das zweite Kommando ebenfalls eine Zeitphrase wird diese Zeit genommen.
schalte die Heizung heute Abend ab und mache die Rollläden jetzt runter
Zeitenmodifikation
Wie oben gesehen wird der Zeitpunkt des ersten Kommandos vor dem "und" auch für das zweite nach dem "und" gesetzt. Vorausgesetzt er wird beim 2. Kommando nicht durch eine eigenständige Zeit (hier "jetzt") ersetzt. Wenn man die Zeit des zweiten Kommandos, relativ zum ersten setzen möchte, kann dies mit den Schlüsselwörtern dann, danach oder wieder formuliert werden.
Fahre um 14 Uhr die Rollläden an der Terrasse runter und schalte dann in 2 Minuten die Bewässerung an
oder
Mach am Freitag um 5 Uhr die Heizung aus und in einer Woche wieder an
Manchmal ist es notwendig etwas vor der angegebenen Zeit auszuführen. Hier lässt sich ein Offset zu dem ermittelten Zeitpunkt hinzufügen, um ihn zu ändern.
Beispiel
dusche\S?$ = (offset=>-3600, cmd=>'set d_log bad warm')
Der Sprachbefehl
ich will um 18:30 Uhr duschen
Legt folgendes at Ergnis an
define at_assi_1513096200 at 2017-12-12T17:30:00 set d_log bad warm
Konfiguration
Die Konfiguration des Moduls wird hauptsächlich über die Definition (DEF) vorgenommen. Eine Konfiguration beginnt immer mit der Definition der gesuchten Schlüsselwörtern gefolgt von einem Gleichheitszeichen (siehe Randnotiz). Diese werden Anhand von Regulären Ausdrücken (RegExp) beschrieben. Also z.B.:
garage auf =
Das bededutet, sobald die Wörter in der Reihenfolge "garage" und "auf" erkannt werden, wird der Kommandoteil der Konfiguration ausgeführt. Groß- und Kleinschreibung wird grundsätzlich ignoriert.
Vor und nach dem Gleichheitszeichen muss mindestens ein Trennzeichen vorhanden sein
- Vor dem "=" mindestens ein Leer- oder Tabulatorzeichen
- Nach dem "=" können zusätzlich auch Zeilenumbrüche eingefügt werden
Der Kommandoteil folgt dem Gleichheitszeichen (siehe Randnotiz). Und kann auf folgende Arten vorliegen.
- FHEM Kommando
- { Perl Befehl }
- ( Modul_Talk2Fhem#erweiterte_Befehlskonfiguration )
Übersicht
<regexp> = <command>
Im ganzen könnte die Konfiguration dann so aussehen:
garage\S* auf = set dev_garage open
\S* Siehe hierzu Modul_Talk2Fhem#Häufig_verwendete_RegExp.
Bei dem vorherigen Beispiel, würde der FHEM Befehl "set garage open" bei allen folgenden Sprachbefehlen ausgeführt werden.
Mach bitte die Garage auf Das haus soll das Garagentor aufmachen Garagentür in 5 Minuten auf Die Garagen soll in einer Stunde aufgemacht werden
Klammerüberführung
Es ist nicht notwendig für jeden Zustand oder jedes Gerät eine eigene Konfigurationzeile zu erzeugen. Hierfür gibt es die Möglichkeit, wie bei Regulären Ausdrücken üblich, Klammern "( )" im <regex>-Teil zu erfassen. Dies erfolgt über die Standartvariablen $1, $2, ..., $n. "n" steht hier für die nte Klammer. Zusätzlich gibt es in Talk2Fhem die Möglichkeit die Klammern zu modifizieren.
Soll die Garage auf und zugemacht werden, lässt sich folgendermaßen beschreiben.
Beispiel:
garage\S* (\S+) = set dev_garage $1
Der Satz: "Mach die Garage auf" ergibt dann als FHEM Kommando
set dev_garage auf
Klammermodifikation
Da es in den meißten Fällen nicht gewünscht ist, nur das gefunde Wort in das FHEM Kommando zu überführen, lässt sich zusätzlich das gefundene Wort modifizieren.
Variante 1: nach Typ
Hier kann die Klammer auf ihren Typ hin modifiziert werden.
Definition
$n{ typ => modification, typ2 => mod2, ..., typn => modn }
typ kann eines der folgenden Wörtern enthalten:
- true sind alle Wörter die eine positive Richtung enthalten. Wie z.B. auf, ein, hoch, an, usw.
- false sind alle Wörter die eine negative Richtung enthalten. Wie z.B. ab, aus, runter, zu, usw.
- integer Wort enthält eine Zahl
- empty Wort enthält eine Leere Zeichenkette
- /<regexp>/ Wort entspricht der <regexp> ###TODO###
- else Falls keines der Fälle zutrifft
modification enthält das einzufügende Wort.
Beispiel
garage\S* (\S*) = set dev_garage $1{true=>open,false=>close}
Die Sätze:
mach die Garage auf bitte Garagentor schließen
würden hier folgende Befehle auslösen
set dev_garage open set dev_garage close
Befehlsumkehr
Ein zusätzlicher Vorteil dieser Methode ist, dass über das Schlüsselwort "wieder" ein Befehlsumkehr ausgelöst werden kann.
Beispiel
mach bitte die Garage auf und in 5 Minuten wieder zu
Variante 2: nach Liste
Hier kann die Klammer anhand einer oder zweier Listen selektiert werden.
Definition
$n[ wert1, wert2,,,,, wertn ]
oder
$n[ @liste ]
Innerhalb der Klammern [ ] wird eine Komma separierte Liste mit Namen erwartet die als Modifikatorliste dient. Die sogenannte Modwordlist. Die Werte sind immer optional und können leer gelassen werden. Über das Attribut T2F_modwordlist können diese Listen zur Übersicht und Wiederverwendbarkeit angelegt werden. Siehe Attribute. Auf diese Listen, lässt sich über den Namen der Liste, mit einem vorangestelltes '@' zugreifen.
Beispiel nach Position
Beim ersten Beispiel wird eine Zahl im regex-Teil erwartet (\d+). Diese Zahl entscheidet welche Position aus der Modwordlist ausgewählt werden soll.
ventilator auf (stufe )?(\d+) = set aircon $2[ off, level1, level2, level3 ]
(Stufe )? bedeutet: Das Wort Stufe kann, muss aber nicht.
Die Sätze:
Ventilator in 10 Minuten auf Stufe 0 Ventilator auf 3
würden hier folgende Befehle auslösen
set aircon off set aircon level3
Beispiel nach Vergleichsliste
Hier kommt eine weitere Liste ins Spiel. Die sogenannte Keywordlist ist im Eigentlichen eine RegExp "Ver-oder-ung".
(key1|key2|...|keyn)
oder
(@keylist)
Diese Liste mit Schlüsselwörtern wird im <regex>-Teil angegeben. Hier entscheidet nicht eine Zahl über die Position, sondern die Position die in der Keywordlist einen Treffer hat wird in der Modwordlist ausgewählt. Im Attribut T2F_keywordlist können vordefinierte Listen angelegt werden und mit @keylist ausgewählt werden
blendet.* (Wohnzimmer|Esszimmer|Küche) = set $1[act_lvgroom, act_dinroom, act_kitchen] 70
.* beliebig viele Zeichen
Die Sätze:
es blendet im Esszimmer ich sitze geblendet im Wohnzimmer die sonne blendet in der Küche
würden hier folgende Befehle auslösen
set act_dinroom 70 set act_lvgroom 70 set act_kitchen 70
Ergänzung
Ähnlich wie in Variante 1, könne auch hier auf die Schlüsselwörte
empty für leere Zeichenkette
und
else für alle anderen Fälle
zugegriffen werden. Hierbei wird der Modwordlist einfach empty oder else gefolgt von dem gewünschten Wert als nächstes Element angehängt.
$n[ wert1, wert2,,,, empty, wert3, else, wert4 ]
erweiterte Befehlskonfiguration
Um Talk2Fhem in den Konfigurationszeilen weitere Parameter zu übergeben, ist eine gesonderte Syntax zu verwenden.
<regexp> = ( option => 'value' , opt2 => 'value2' , ... optn => 'valuen' )
Es stehen folgende Optionen zur Verfügung:
- cmds => enthält das FHEM Kommando. Wie oben beschrieben.
- answer => Ein in Anführungszeichen (" oder ') gesetzter Perl-Befehl, dessen Rückgabe in das Reading answer geschrieben wird.
- offset => Ganzzahliger Wert in Sekunden der dem Zeitpunkt addiert wird. Siehe Modul_Talk2Fhem#Zeitenmodifikation
Antworten
In Talk2Fhem können Antworten, die das Modul ausgeben soll, definiert werden. Hier können Fragen verarbeitet werden oder auch den Erfolg eines Kommandos bestätigt werden.
Über die Modul_Talk2Fhem#erweiterte_Befehlskonfiguration, erhält der Parameter "answer" einen Perl Befehl, dessen Rückgabe die Antwort darstellt.
Beispiel Erfolgsmeldung
tu was = ( cmds => "set tue es" , answer => '"Erledigt"' )
Man beachte hier, dass die Parameter immer in Anführungszeichen gesetzt werden müssen. In diesem Fall der Perl Befehl. Ein Text in Perl wird ebenfalls in Anführungszeichen gesetzt, deswegen die doppelten Anführungszeichen!
Beispiel Zustandsabfrage
wurde es getan = ( answer => 'Value("tue") eq "es" ? "Ja" : "Nein"')
Beispiel Temperaturabfragen
Eine einfache Temperaturabfrage könnte so aussehen.
wie.*(grad|warm|temperatur) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("tempdev", "temperature", "Fehler")' )
Für eine Raumbezogene Temperaturabfrage, siehe Modul_Talk2Fhem#Anwendungsbeispiele_und_Vorlagen
Attribute
Folgende Attribute werden zur Zeit unterstützt
T2F_keywordlist
<Name> = <Liste>
Name: Name der Liste
Liste: Eine Kommaseparierte Liste mit RegExp
Beispiel
rooms = haus|..?berall,wohnung,wohnzimmer,esszimmer,bad\S*,toilette|wc,b..?ro,schlafzimmer,ankleide|garderobergescho\S* names = Mama,Papa,Kevin,Jacqueline channels = ard|das erste,zdf,rtl,sat 1,vox,rtl2,prosieben,kabel eins,arte
T2F_modwordlist
<Name> = <Liste>
siehe T2F_keywordlist
roll = rollos_alle,rollos_alle,d_rollo_wz,hm_roll_ess,hm_roll_bad.*,hm_roll_wc,hm_roll_buero.*,d_rollo_schlaf,hm_roll_umkleide gtags = gtag_green,gtag_red,gtag_blue,gtag_white
T2F_language
Legt die verwendete Sprache fest. Alternativ wird das Globale Attribut language verwendet werden.
disable
Deaktiviert das Ausführen des FHEM Kommandos
verbose
Anwendungsbeispiele und Vorlagen
Hier folgen diverse Vorlagen und Beispiele die jeweils an die eigenen Bedürfnisse angepassst werden sollten/müssen
Keywordlist
Der Hauptbestandteil einer Keywordlist sollte eine Auflistung der vorhandenen Räume sein
rooms = haus|\S\S?berall,wohnung,wohnzimmer,esszimmer,bad\S*,toilette|wc,b\S\S?ro,schlafzimmer,ankleide|garderobe,kinderzimmer,spielzimmer,flur|gang|diele,garage,garten,terrasse,balkon,eg|erdgescho\S*,og|obergescho\S*
Rolladen fahren
Wir erzeugen eine Modwordlist rollos indem wir alle Rollladen "devices" auflisten. Die Reihenfolge ist an der Keywordlist "rooms" anzupassen.
Rollos = r_alle,r_alle,r_wz,...
Definition
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(@rooms)? (auf )?(\S+) = set $3[@rollos, empty, rollos_alle] $5{true=>on, false=>off, integer=>"set_$5"}
Beispielsätze
Rollos auf Rolllos Überall schließen Rollo im Wohnzimmer hoch Rolladen im Esszimmer runter Rollläden in der Küche auf 50
Damit wäre eigentlich schon alles abgedeckt. Folgendes Beispiel ist aber auch noch nützlich. Definition
(blendet|schatte\S?) ?(\S+ ){0,2}(@rooms) = set $3[@rollos] set_70
Beispielsätze
es blendet im Esszimmer ich werde geblendet in der Küche die Sonne blendet mich im Badezimmer beschatte das Haus mach schatten im Erdgeschoss
Häufig verwendete RegExp
Perl Regular Expression, also ein regulärer Ausdruck der Programmiersprache Perl, ist eine Werkzeug um Zeichenketten zu beschreiben. Hier wird versucht kurz einen Einblick auf die hier häufig benutzten RegExp zu geben.
Eine kurze Übersicht der verwendeten Zeichen kann hier eingesehen werden. [2]
RegExp | Beschreibung |
---|---|
\S* | Beliebig viele (*) nicht Leerzeichen (\S). Für unbekannten und unwichtigen Wortendungen z.b. garage\S* ist bei Garage, Garagentor oder Garagentür erfolgreich |
\S+ | Mehr als ein Zeichen (+) welches kein Leerzeichen ist (\S) |
\S\S? | Ein oder zwei Zeichen die keine Leerzeichen sind. Das "?" wirkt hier nur auf das angrenzende "\S". Sollte für Umlaute verwendet werden, da bei manchen Eingabemethoden Probleme mit Umlauten auftreten können. |
(wort )? | Ein bestimmtes Wort oder nicht. |
(wort1|wort2) | Entweder wort1 oder Wort2 |
wort$ | Nur wenn das Wort am ende der Zeichenkette steht. |
(\S+){,2} | Keins, eins oder zwei Wörter. Kann für Artikel wie z.B. "(in der|in dem|im|auf der|...)?" eingesetzt werden |
Eingabemethoden
Die Herkunft der Sprachbefehle für das Modul sind vielfältig. Hier werden einige Methoden beschrieben wie der Sprachbefehl in das Modul gelangen kann.
Messenger Telegram
Ist ein TelegramBot telbot definiert, reicht ein einfaches "notify" um die Nachrichten an FHEM an Talk2Fhem weiterzuleiten.
define n_telbot telbot:msgText.* set talk $EVENT
Schon kann mit FHEM gechattet werden... ;)
Google Home Geräte
Momentan ist es leider noch notwendig über einen Umweg die Sprache von einem GoogleHome in FHEM zu bringen. Hierzu ist es notwendig einen funktionierenden DNS Service am laufen zu haben. Damit FHEM per Webadresse im Internet erreichbar ist.
- Ein FHEMWEB Device anlegen
define api FHEMWEB 8087 global attr api HTTPS 1 attr api allowfrom 1 attr api csrfToken None
- Ein allowed Device anlegen
define allowed_api allowed api attr allowed_api allowedCommands set attr allowed_api allowedDevices talk attr allowed_api basicAuth {"$user:$password" eq 'user:passwort'} attr allowed_api validFor api
- Mit Googlekono bei IFTTT.com anmelden
- New Applet
- +this GoogleAssistant -> Say a phrase with a text ingredient
- Die drei Triggertexte wählen z.b.
- das Haus $
- sag dem Haus $
- frag das Haus $
- Problem bei zu kurzen Texten hat GoogleHome keine anderen Anfragen mehr angenommen.
- Einen Antworttext überlegen z.B. OK und in "What do you want the Assistant to say in response?" eintragen
- Language Deutsch
- +that Webhooks
- URL wählen https://user:password@dnsservice:54387/fhem?cmd.talk=set talk Vorlage:TextField&XHR=1
- Fertig
Jetzt wird der gesamte Text bei dem genannten Triggerworten an FHEM weitergeleitet.
Ausgabemethoden
Ebenfalls