FHEMWiki - Benutzerbeiträge [de]

Talk2Fhem

2018-01-30T15:02:58Z

RoBra81:

{{Infobox Modul
|ModPurpose=Das Modul stellt eine Verbindung zwischen natürlicher Sprache und FHEM Befehlen her
|ModType=h]
|ModCmdRef=Talk2Fhem
|ModForumArea=Unterstützende Dienste
|ModTechName=39_Talk2Fhem.pm
|ModOwner=Oliver Georgi
}}

Diese Seite beschreibt die Funktionsweise und Konfiguration des Moduls 39_Talk2Fhem.pm

== Voraussetzungen ==
[[Datei:ModulTalk2FhemScreenshot.png|360px|thumb|right]]
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 [[Konfiguration#Syntaxhervorhebung|hier]] 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|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.

Es werden diverse [[Modul_Talk2Fhem#Zeitenerkennung|Zeit- und Datumsangaben]] erkannt. Außerdem ist es möglich [[Modul_Talk2Fhem#Eventenerkennung|Events zu formulieren]], welche die Befehle zu einem bestimmten Ereignis ausführen lassen. Bei der weiteren Verarbeitung der Sprachbefehle wird die Sprache mit selbst definierte Schlüsselwörter verglichen.

=== 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
# Zeit- und Eventgebundenes 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. [https://forum.fhem.de/index.php/topic,80960.0.html]

== 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''' oder '''set !''' an das Modul geleitet.
set talk Guten Morgen liebes Zuhause
''Wird kein Text angehängt, wird der letzte Sprachbefehl erneut ausgeführt.''

=== Readings ===

Im Reading '''set''' steht der letzte gesendete Sprachbefehl.
 Im Reading '''cmds''' steht das letzte ausgeführte FHEM-Kommando dessen Rückgabe in in das Reading '''fhem''' geschrieben wird.

Die Antworten und Modulinterne Fehler werden in den Readings '''answers''' und '''err''' ausgegben.

In '''ifs''' stehen die Bedingungen bei dem das letzte Kommando ausgeführt werden wird.

'''notifies''' enthält eine Auflistung der Devices die für die aktuell wartenden bedingten Kommandos relevant sind. Auf diesen Devices liegt ein internes notify.

Das Reading '''status''' wird jedes mal gesetzt und erhält Werte nach folgender Priorität.
{|class="wikitable"
|1.||'''response''' ||wenn das FHEM Kommando eine Meldung ausgegeben hat
|-
|2.||'''disabled''' ||wenn das Attribute disable auf 1 steht
|-
|3.||'''err''' ||wenn der Sprachbefehl einen Fehler zurückgegeben hat
|-
|4.||'''answer''' ||wenn der Sprachbefehl eine Antwort ausgegeben hat
|-
|5.||'''done''' ||wenn keines der oberen Fälle eingetreten ist, also alles gut verlaufen ist
|}

=== 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
<syntaxhighlight lang="perl">
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");
}

}
</syntaxhighlight>
Eine weitere Möglichkeit Talk2Fhem mit anderen Modulen zu verbinden, ist über das Reading '''status''' möglich.

Die folgenden Lösung hat den Vorteil das eine Standardantwort definiert werden kann.
'''!Achtung noch nicht getestet vom Author!'''
<syntaxhighlight lang="perl">
talk:status {
my $text = ReadingsVal("talk", $EVENT, "Komisch, hier sollte eigentlich etwas Text stehen.");

if ("$EVENT" eq "response") {
#FHEM gibt bei Erfolg eig. keine Rückmeldung, also ist vermutlich was schief gelaufen
$text = "Die Haussteuerung hat folgende Meldung gebracht. $text";

} elsif ("$EVENT" eq "err") {
$text = ["Das habe ich nicht verstanden!","Phuu das kann ich noch nicht!","Nein! Heute nicht.", "Wie bitte?"]->[rand(4)];

} elsif ("$EVENT" =~ /^answer/) {
$text = ReadingsVal("talk", "answers", "Ich habe nichts zu sagen.");

} elsif ("$EVENT" eq "err") {
#in $text steht schon der fehler drin

} elsif ("$EVENT" eq "done") {
$text = ["Ok.","Ja.","Gerne.", "Mach ich!"]->[rand(4)];

} else {
$text = "Oh, es gibt etwas neues, bitte schau mal im Forum bei Talk2Fhem vorbei.";
}

fhem('set speaker speak "$text"') if $text;
}
</syntaxhighlight>

=== 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'''
<syntaxhighlight lang='perl'>dusche\S?$ = (offset=>-3600, cmd=>'set d_log bad warm')</syntaxhighlight>
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

=== Eventkonfiguration ===

=== Ereigniswiederholung ===
Werden zwei Sätze über ein '''und''' miteinander verknüpft kann der zweite Satz mit dem Wort '''wieder''' das Ereignis wiederholen.

'''Beispiel'''
mach bitte die Garage auf und in 5 Minuten wieder zu
Man benötigt hier nicht erneut den kompletten ersten Satz zu wiederholen.

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

{{Randnotiz|RNText=Wichtig
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]] )

=== Import von Konfigurationen ===
Umfangreiche Konfigurationen können in Dateien ausgelagert und über @inlcude importtiert werden:

$include = FHEM/t2f.cfg

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

=== RegExp in unbekannter Reihenfolge ===
Wenn die Reihenfolge der Wörter nicht bekannt sind kann der <regexp>-Teil aufgeteilt (verUNDet) werden: <regexp> && <regexp> && ...

Licht && Wohnzimmer && schalte = ...

akzeptiert

Schalte das Licht im Wohnzimmer

Im Wohnzimmer das Licht schalten

Schalte im Wohnzimmer das licht

=== RegExp optional oder nicht vorhanden ===
Die einzelnen RegExp können zusätzlich mit ? und ! beeinflusst werden:

!<regexp> ist eine Verneinung. Sprich, nur wenn die <regexp> nicht vorkommt.
?<regexp> Optionale <regexp>

Beipiel:

Licht && ?Wohnzimmer && schalte && !aus = ...

akzeptiert

Schalte das Licht im Wohnzimmer ein

Schalte das Licht ein

aber nicht

Schalte das Licht im Wohnzimmer aus

Schalte das Licht aus

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

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
*'''float''' Wort enthält eine Gleitkommazahl
*'''/<regexp>/''' Wort entspricht der <regexp>
*'''word''' Wort enthält gleich oder mehr als 4 Zeichen
*'''empty''' Wort enthält eine Leere Zeichenkette
*'''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

==== Variante 2: nach Liste ====
<hr>

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 ]
 |------------------> 0 1 2 3
''(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
( @keywordlist )
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 an selber Position 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

''' Auswahl des Listenelements '''

Soll bei der Nutzung der Variable nicht der Wert aus dem Sprachbefehl, sondern der Wert der Liste genutzt werden, so wird an die Variable ein @ angehängt. So wird bei
blendet.* (Wohnzimmer|Esszimmer|Küche) = set act_$1@ 70

Die Sätze
es blendet im Esszimmer
es blendet im esszimmer
immer zu
set act_Esszimmer 70

führen, da die Liste das Esszimmer großgeschrieben enthält.

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

==== zusätzliche Variablen ====
Ergänzend zu den Listenvariablen stehen folgende Variablen zur Verfügung:

$& Enthält alle gefundenen Wörter
!$& Enthält den Rest der nicht von der RegExp eingeschlossen wurde
$DATE Enthält den Zeit und Datumstext des Sprachbefehls
$AGAIN Enthält das Wort wieder wenn es sich um ein wieder Kommando handelt (siehe Beispiele)

=== 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:
*cmd => 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 ====
<syntaxhighlight lang="perl">tu was = ( cmd => "set tue es" , answer => '"Erledigt"' )</syntaxhighlight>
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 ====
<syntaxhighlight lang="perl">wurde es getan = ( answer => 'Value("tue") eq "es" ? "Ja" : "Nein"')</syntaxhighlight>

==== Beispiel Temperaturabfragen ====
Eine einfache Temperaturabfrage könnte so aussehen.
<syntaxhighlight lang="perl">wie.*(kalt|warm|grad|temperatur) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("tempdev", "temperature", "Fehler")' )</syntaxhighlight>
Für eine Raumbezogene Temperaturabfrage, siehe [[Modul_Talk2Fhem#Anwendungsbeispiele_und_Vorlagen]]

== Attribute ==
Folgende Attribute werden zur Zeit unterstützt
=== T2F_keywordlist ===
<Name> = <kommaseparierte Liste mit RegExp>
'''Beispiele'''
rooms = haus|überall|wohnung , wohnzimmer , bad\S* , toilette|wc , büro , ...
names = Mama , Papa , Kevin , Jacqueline
channels = ard|das erste , zdf , rtl , sat 1 , vox , rtl2 , prosieben , kabel eins , arte
Man beachte hier die möglichkeit der RegExp 
Das Schlüsselwort '''haus''' löst das selbe aus wie '''überall''' und '''wohnung'''
 Genauso '''bad''' oder '''badezimmer''' oder '''badeirgendewas'''

=== T2F_modwordlist ===
<Name> = <kommaseparierte Liste mir RegExp>
Die Positionen der gewählten Geräte, ist eine Zuordnung zu den Listen in''T2F_keywordlist''
 Wenn Wohnzimmer in der keywordliste <rooms> an Position 2 steht muss der Rolladenaktor in der modworliste <roll> auch an Position 2 stehen.
roll = rollos_alle , d_rollo_wz , hm_roll_bad.* , hm_roll_wc , hm_roll_buero.* , ...
lights = alle_lichte , '''"sw_wz1,sw_wz2"''' , sw_bad.* , sw_wc
Sollen einem Schlüsselwort mehrere Aktoren zugeordnet werden, geht das über sogenannte "Quotes". (Anführungszeichen) Siehe <lights>.
"a,b" oder 'a,b' oder a\,b

=== T2F_disableumlautescaping ===

Deaktiviert das Konvertieren der Umlaute innnerhalb von regulären Ausdrücken in '''\S\S?'''

=== 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. Hierzu sind die entsprechenden Stellen rot markiert.
=== Keywordlist ===
Eine typische Keywordlist wäre eine Auflistung der benötigten Räume
rooms = haus|überall|wohnung,wohnzimmer,esszimmer,bad\S*,toilette|wc,
büro,schlafzimmer,ankleide|garderobe,kinderzimmer,spielzimmer,
flur|gang|diele,garage,garten,terrasse,balkon,
eg|erdgescho\S*,og|obergescho\S*,\S*auße\S*( haus)?|vor der tür

=== Einfaches schalten ===
licht (\S+) = set dev_light $1{ true => on, false => off }
=== Einfaches schalten mit eigenen Wörtern ===
Will man neben an/aus einen weiteren Zustand selbst definieren, kann das so geschehen.
garage (\S+) = set dev_gate $1{ /kurz/ => open-for-time 5, true => open, false => close }

=== Einfaches schalten mit Räumen ===
licht (\S+ ){0,2} (wohnzimmer|esszimmer|küche|terrasse) (\S+) = set $2[light_wz,light_ez,light_kitchen,light_outside] $3{ true => on, false => off }
Bei größeren Mengen an Räumen und Geräten bietet sich das anlegen von Keyword- und Modwordlisten an.
licht (\S+ ){0,2} (@rooms) (\S+) = set $2[@lights] $3{ true => on, false => off }

=== Rolladen fahren ===
Sind die Rollläden innerhalb von FHEM über das Attribut "room" den Räumen mit Klarnamen zugeordnet, lässt sich das ganze am einfachsten konfigurieren. 
'''1. nach Devicetyp'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=a:subType=blindActuator $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Wenn das Device vom subTyp "blindActuator" ist (HomeMatic Rolladenactor) und es im Raum $3 ist, wird dieses Device gefahren. Die Funktion ucfirst ist notwendig damit der erste Buchstabe groß geschrieben wird.

'''2. nach Devicenamen'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=rollo.* $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Gleiche wie oben, nur das alle Devices die mit rollo beginnen im Raum $3 gefahren werden. (rollo.*)

'''3. nach Benutzerdefinierten Räumen''' 
Ansonsten müssen wir dem Modul sagen in welchem Raum welches Device sitzt. Das hat dafür den Vorteil das die Räume als RegExp angegeben werden können. Wir erzeugen eine Modwordlist ''rollos'' in der wir alle Rollladen "Devices" auflisten. Die Reihenfolge ist an der Keywordlist "rooms" ([[Modul_Talk2Fhem#Keywordlist]]) anzupassen.
rollos = r_alle,r_wz,r_ez,,r_buero,...
 '''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

=== GoogleCast Befehle ===
Etwas bessere Lautstärkebefehle als die von Google.
Die Lautstärken müssten noch dem eigenen Geschmack angepasst werden
#GoogleCast Commandos
leise$ = set googlecastdevice volume 14
normale lautstärke = set googlecastdevice volume 20
laut$ = set googlecastdevice volume 30
(ein wenig|etwas|viel)? ?(lauter|leiser) = { fhem("set googlecastdevice volume ".(ReadingsVal("googlecastdevice","volume", 0)$2[+,-]$1[3,5,10,empty,7])) }
''' Beispielsätze '''
Mach leise
Mach lauter
Mach etwas leiser
Mach viel lauter

=== Talk Timer zurücksetzen ===
Sollen alle von Talk2Fhem angelegten Timer gelöscht werden.
(timer|kommandos) (löschen|zurücksetzen) = delete at_talk.*
'''Beispielsätze'''
bitte alle timer zurücksetzen
zukünftige kommandos löschen

=== Frage Antwort ===
==== Raumbezogene Temperaturansage ====
Wir erzeugen wieder unsere Modwordlist sagen wir @sens gefüllt mit den Temperaturfühler "Devices". Reihenfolge wie immer die der Keywordlist @rooms.
wie.*(kalt|warm|grad|temperatur).*(@rooms) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("$2[@sens]", "temperature", "unbekannt")." grad"' )
'''Beispielsätze'''
wie warm ist es im Wohnzimmer
wie ist die Temperatur in der Küche
wie kalt ist es draußen

==== Multiple Antworten ====
Hallo Haus = ( answer => '["Hallo auch!","Guten Tag!","Ahoi!"]->[rand(3)]' )
Wählt zufällig eine der drei Aussagen.

==== Ausgabe eines oder mehrerer Zustände ====
Angenommen man möchte wissen ob das Haus abgeschlossen ist. Und in FHEM existiert ein Dummy der diesen Zustand wiederspiegelt und im Reading text die offenen Fenster und Türen aufgelistet sind. Kann man folgendermaßen den Status erfragen
(alles|das haus) (zu|abgeschlossen) = (
answer => '(Value("d_schliessung") eq "zu")
? "Es ist alles zu"
: "Nein, offen sind: ".ReadingsVal("d_schliessung","text","")'

==== Zustandsabfrage anhand des Aliasnamen ====
Möchte man alle Geräte anhand seines Attribut "alias" ansprechen, um dessen Status zu erfragen, könnte das so erfolgen.
 '''Definition'''
(zustand|status) (\S+)* (\S+) = (answer=>'my $s=Value((grep { "$3" =~ /$attr{$_}{alias}/i } (keys %attr))[0]);; "Der Status ist ".$s if $s')
'''Beispielsätze'''
Wie ist der Zustand der Lüftung
sag mir den Status der Haustür
Es ist auch möglich ein eigenes Attribut zu kreieren, und dieses als Klarnamenattribut zu verwenden. Hierzu einfach im Device global ein userattr hinzufügen. z.B.
attr global userattr T2F_alias
Jetzt stehen in allen Devices das Attribut T2F_alias zur Verfügung. Vorteil ist das dann auch wieder RegExp verwendet werden können. Im oberen Beispiel müsste dann dass rot markierte "alias" durch "T2F_alias" ersetzt werden.

=== Konfiguration innerhalb der Geräte ===
Neben der Identifikation der Geräte über die vorhandenen FHEM-Attribute (z.B. room, alias, ...) kann eine alternative Konfiguration auch über eigens für Talk2Fhem angelegte Attribute erfolgen. Die hierfür notwendigen Grundlagen und einige Beispiele sollen im Folgenden beschrieben werden.

==== Grundlagen / Voraussetzungen ====
1. Anlegen der notwendigen userattr am global-Device:

Erweiterung des Attributes userattr des Gerätes global um folgende Einträge:
T2F_places:textField-long T2F_properties:textField-long T2F_rooms:textField-long T2F_types_color:textField-long T2F_types_heating:textField-long T2F_types_info:textField-long T2F_types_switch:textField-long

2. Optional: Hilfsfunktionen für das automatische Füllen der T2F_keywordlist im talk-Device bei Änderung eines T2F-Attributes eines Gerätes

2a. erstellen einer sub in der 99_myUtils.pm:

<syntaxhighlight lang="perl"> sub fill_T2F_keywordlist
{
my ($name, $t2f_device) = @_;
$name =~ s/T2F_//g;
if ($name eq 'userattr')
{
return;
}
Log 0, "List: ".$name;
my $currentAttr = AttrVal($t2f_device,"T2F_keywordlist","");
my @currentAttrParts = split(/$name = /, $currentAttr);
my $currentAttrBeg = @currentAttrParts[0];
$currentAttrBeg = substr($currentAttrBeg, 0, -1);
my @currentAttrEnd = split(/\n/, @currentAttrParts[1], 2);
my @array = devspec2array('a:T2F_'.$name.'=.+');
my @attributes = ();
if (@array > 0 and defined($defs{$array[0]}))
{
foreach (@array){
my @attrVals = split(/\n/,AttrVal($_, 'T2F_'.$name, ''));
foreach (@attrVals){
my $attrVal = $_;
$attrVal =~ s/ / /g;
$attrVal =~ s/ => /=>/g;
my @attrValParts = split(/=>/,$attrVal);
$attrVal = @attrValParts[0];
$attrVal =~ s/!//g;
$attrVal =~ s/, /,/g;
my @attr = split(/,/, $attrVal);
push(@attributes, @attr);
}
}
}
my %hash = map { $_ => 1 } @attributes;
my @unique = keys %hash;
my $result = $currentAttrBeg."\n".$name." = ".join(", ", @unique)."\n".@currentAttrEnd[1];
$result =~ s/\n\n/\n/g;
$result =~ s/ / /g;
fhem('attr '.$t2f_device.' T2F_keywordlist '.$result);
}</syntaxhighlight>

2b. Erstellen eines DOIFs zum Aufruf der sub:

defmod talk.DI.fillAttr DOIF ([global:"^ATTR.*T2F_.*"]) ({my $val = ReadingsVal("$SELF", "e_global_events", ""); $val =~ m/(\S*) (\S*) (\S*) (.*)/; if ($2 ne 'talk' && $2 ne 'global') { fill_T2F_keywordlist("$3", "talk");}})
attr talk.DI.fillAttr do always

3. Optional: Erlauben von Umlauten in den T2F-Attributen:

attr talk T2F_disableumlautescaping 1

Nun können die T2F-Attribute pro FHEM-Device definiert und dann in den Talk2Fhem-Befehlen benutzt werden. Wurde der Punkt 2 abgearbeitet, so werden mit dem Füllen der Attribute am Geräte auch die Keywordlisten am talk-Device gefüllt. Wie diese dann verwendet werden können, sollen die folgenden Beispiele zeigen.

==== Schalten von Geräten ====

Ausgangssituation: Es gibt drei Lampen Lampe1, Lampe2, Lampe3 und ein Nachtlicht mit einer Eule mit folgenden Attributen:

attr Lampe1 T2F_types_switch Lampe, !Licht
attr Lampe1 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe1 T2F_places Decke, Tür
attr Lampe1 T2F_properties hell,!

attr Lampe2 T2F_types_switch Lampe, !Licht
attr Lampe2 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe2 T2F_places Tisch, Esstisch
attr Lampe2 T2F_properties dunkel,schwach,!

attr Lampe3 T2F_types_switch Lampe, !Licht
attr Lampe3 T2F_rooms Haus, Obergeschoss, !Küche
attr Lampe3 T2F_places Besenschrank

attr Nachtlicht T2F_types_switch Lampe, !Licht, Eule, Nachtlicht
attr Nachtlicht T2F_rooms Haus, Obergeschoss, !Kinderschlafzimmer
attr Nachtlicht T2F_places Steckdose

Durch die in Punkt 2 der Voraussetzungen genannten Funktionen wurden folgende T2F-keywordlisten automatisch angelegt:

attr talk T2F_keywordlist rooms = Kinderschlafzimmer, Haus, Küche, Obergeschoss, Esszimmer
places = Tür, Steckdose, Tisch, Decke, Esstisch
properties = hell, dunkel, schwach
types_switch = Lampe, Licht, Eule

Die Definition für das T2F-Device lautet dann wie folgt:

# 1 2 3 4 5 6 7
?(bitte) && ?(@properties) && (@types_switch) && ?(@rooms) && ?(@places) && (\S+)(schalten|machen)?$ =
(cmd=>'set T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.* $6{true=>on, false=>off}',
answer=>'"$AGAIN" ? "dann $DATE wieder $6{true=>ein, false=>aus}" : "$1{/bitte/=>Gern, else=>Das heißt Bitte}, ich schalte $1{/bitte/=>, else=>trotzdem} folgende Geräte $6{true=>ein, false=>aus}: ".T2F_answer("T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.*","T2F_types_switch")')

Damit sind dann die folgenden Sprachbefehle möglich:

Schalte das Licht in der Küche ein => schaltet Lampe3 ein

Schalte die helle Lampe im Esszimmer an => schaltet Lampe1 ein

Schalte das Licht im Esszimmer über dem Esstisch ein => schaltet Lampe2 ein

Schalte die Eule ein => schaltet Nachtlicht ein

Schalte das Licht im Esszimmer aus} => schaltet Lampe1 und Lampe2 aus

Schalte das Licht aus => schaltet alle vier Lichter aus

Um in der Antwort die Liste der geschalteten Geräte genannt zu bekommen, wird die sub T2F_answer aus der 99_myUtils aufgerufen:

<syntaxhighlight lang="perl">
sub T2F_answer
{
my ($filter, $type) = @_;
my $answer = '';
my @devices = devspec2array($filter);
if (@devices > 0 and defined($defs{$devices[0]}))
{
foreach (@devices){
my $devAttr = AttrVal($_, $type, '');
if ($answer ne '')
{
$answer = $answer.", ";
}
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_properties', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_rooms', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_places', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}
}
}
return $answer."";
}
</syntaxhighlight>

Die Benennung der Geräte erfolgt auf Basis derer T2F-Attribute: Typ, Eigenschaft, Raum, Ort. Ist das jeweilige Attribut leer, ist es auch in der Antwort leer. Enthält die jeweilige Attributliste ein Ausrufezeichen (!), so wird der Eintrag nach dem Ausrufezeichen für die Antwort verwendet (z.B. Esszimmer als Raum). Steht das Ausrufezeichen am Ende, so wird der Eintrag in der Antwort leer gelassen (z.B. die Eigenschaft bei Lampe1). Ist kein Ausrufezeichen vorhanden, so wird der erste Eintrag verwendet.

==== Einstellen der Heizung ====

Das gleiche Prinzp wie bei den Lampen kann auch für die Einstellung der Heizung verwendet werden.

Ausgangssituation: In der Küche, im Kinderschlafzimmer und im Esszimmer gibt es jeweils eine Heizung (Homematic HM-CC-RT-DN) mit folgenden Attributen:

attr HeizungEsszimmer T2F_places Heizung,!
attr HeizungEsszimmer T2F_rooms Haus,Obergeschoss,Essbereich,!Esszimmer
attr HeizungEsszimmer T2F_types_heating Heizung,Temperatur,Esszimmer,Essbereich,!

attr HeizungKüche T2F_places Heizung,!
attr HeizungKüche T2F_rooms Haus,Obergeschoss,Essbereich,!Küche
attr HeizungKüche T2F_types_heating Heizung,Temperatur,Küche,Essbereich,!

attr HeizungKiSchla T2F_places Heizung,!
attr HeizungKiSchla T2F_rooms Haus,Obergeschoss,!Kinderschlafzimmer
attr HeizungKiSchla T2F_types_heating Heizung,Temperatur,Kinderschlafzimmer,!

Mit der T2F-Definition

# 1 2 3 4 5
?(bitte) && (@types_heating) && ?(@rooms) && (auf (\d+) grad|auto\S*)( stellen| setzen| einstellen| ein)?$ =
(cmd=>'set T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.* $5{integer=>desired-temp $5, else=>controlMode auto}',
answer=>'"$AGAIN" ? "dann $DATE wieder auf Automatik" : "Die Durchschnittstemperatur beträgt dort zur Zeit ".averageTemp("T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.*")." Grad\n$1{/bitte/=>Gern, else=>Das heißt Bitte}, ich stelle die Heizung in folgenden Räumen auf $5{integer=>$5 Grad, else=>Automatik}: ".T2F_answer("T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.*","T2F_types_heating")')

funktionieren folgende Sprachbefehle:

Bitte stell die Heizung im Esszimmer auf 21 Grad => Stellt die Heizung im Esszimmer auf 21 Grad

Bitte stell die Heizung im Essbereich auf 21 Grad => Stellt die Heizungen im Esszimmer und in der Küche auf 21 Grad

Bitte stell die Heizung im Obergeschoss auf Automatik => Stellt die drei Heizungen auf Automatik

Dadurch, dass im Attribut T2F_types_heating auch die Räume aufgeführt sind, sind auch Befehle in folgender Form möglich:

Bitte stell die Küche auf 21 Grad => Stellt die Heizung in der Küche auf 21 Grad

Auch kann in diesem (wie auch in den oben aufgeführten Schaltbefehlen) mit "wieder" gearbeitet werden:

Bitte stell die Heizung im Essbereich auf 21 Grad und in 2 Stunden wieder auf Automatik

Für die Generierung der Antwort wird neben der bei den Schaltbefehlen bereits gezeigten sub T2F_answer eine weiter Funktion verwende, welche die Durchschnittstemperatur im zu schaltenden Bereich ermittelt und ausgibt:

<syntaxhighlight lang="perl">
sub averageTemp($)
{
my ($filter) = @_;
my @tempDevices = devspec2array($filter);
my $count = 0;
my $measuredTemp = 0;
if (@tempDevices > 0 and defined($defs{$tempDevices[0]})){
foreach (@tempDevices){
$measuredTemp = $measuredTemp + ReadingsVal($_, "measured-temp", "");
$count = $count + 1;
}
return $measuredTemp / $count;
}
return 0;
}
</syntaxhighlight>

==== Einstellen der Farbe von Farbwechsellampen (Philips Hue, Wifilight, ...) ====

Für das Beispiel zum Einstellen der Lichtfarbe nehmen wir eine Farbwechsellampe LampeBunt an, welche den Befehl RGB unterstützt. Diese erhält folgende Attribute:

attr LampeBunt T2F_places Decke,Couch,Sofa
attr LampeBunt T2F_rooms Haus,Dachgeschoss,!Wohnzimmer
attr LampeBunt T2F_types_color Lampe,Licht
attr LampeBunt T2F_types_switch Lampe,Licht

Durch das Attribut T2F_types_switch lässt sich diese über die bereits beschriebene Schaltlogik ein und ausschalten. Durch die zusätzlich T2F-Definition

# 1 2 3 4 5 6
?(bitte) && (@types_color) && ?(@rooms) && ?(@places) && auf (@colors)( schalten| stellen)?$ =
(cmd=>'set T2F_types_color=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_places=.*$4@.* RGB $5[@rgb]',
answer=>'"Ich schalte folgende Geräte auf $5@: ".T2F_answer("T2F_types_color=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_places=.*$4@.*","T2F_types_color")')

und die entsprechenden Attribute am T2F-Device talk (HINWEIS: eigene Listen können Problemlos ergänzt werden, diese werden durch die Hilfsfunktionen NICHT überschrieben)

attr talk T2F_keywordlist colors = Aus, Schwarz, Dunkles Schiefergrau, Schiefergrau, Helles Schiefergrau, Helles Stahlblau, Mattes Grau, Grau, Dunkelgrau, Silber, Hellgrau, Gainsboro, Rauchiges Weiß, Geisterweiß, Weiß, Schneeweiß, Elfenbein, Blütenweiß, Muschel, Altgold, Leinenfarbe, Antikes Weiß, Mandelweiß, Cremiges Papaya, Beige, Mais, Helles Goldrutengelb, Hellgelb, Chiffongelb, Blasse Goldrutenfarbe, Khaki, Gelb, Gold, Orange, Dunkles Orange, Goldrute, dunkle Goldrutenfarbe, Peru, Schokolade, Sattelbraun, Ocker, Braun, Dunkelrot, Kastanienbraun, Ziegelfarbe, Indischrot, Karmesinrot, Rot, Orangenrot, Tomatenrot, Koralle, Lachs, Helles Korallenrot, Dunkle Lachsfarbe, Helle Lachsfarbe, Sandbraun, Rosiges Braun, Gelbbraun, Grobes Braun, Weizen, Pfirsich, Navajoweiß, Tomatencreme, Rosige Lavenderfarbe, Altrosa, Rosa, Hellrosa, Leuchtendes Rosa, Fuchsie, Magentarot, Tiefrosa, Mittleres Violettrot, Blasses Violettrot, Pflaume, Distel, Lavendelfarbe, Violett, Orchidee, Dunkles Magentarot, Violett, Indigo, Blauviolett, Dunkles Violett, Dunkle Orchideenfarbe, Mittleres Violett, Mittlere Orchideenfarbe, Mittleres Schieferblau, Schieferblau, Dunkles Schieferblau, Mitternachtsblau, Marineblau, Dunkelblau, Mittelblau, Blau, Königsblau, Stahlblau, Kornblumenblau, Dodger-Blau, Tiefes Himmelblau, Helles Himmelblau, Himmelblau, Hellblau, Zyanblau, Blaugrün, Taubenblau, Helles Cyanblau, Aliceblau, Himmelblau, Cremig Pfefferminz, Honigmelone, Aquamarinblau, Türkis, Blasses Türkis, Mittleres Türkis, Dunkles Türkis, Mittleres Aquamarinblau, Helles Seegrün, Dunkles Zyanblau, Entenbraun, Kadettblau, Mittleres Seegrün, Dunkles Seegrün, Hellgrün, Blassgrün, Mittleres Frühlingsgrün, Frühlingsgrün, Zitronengrün, Gelbgrün, Seegrün, Waldgrün, Grün, Dunkelgrün, Olivfarbiges Graubraun, Dunkles Olivgrün, Olivgrün, Dunkles Khaki, Gelbgrün, Hellgrün, Grüngelb

attr talk T2F_modwordlist rgb = 000000, 000000, 8FBC8F, 708090, 778899, B0C4DE, 696969, 808080, A9A9A9, C0C0C0, D3D3D3, DCDCDC, F5F5F5, F8F8FF, FFFFFF, FFFAFA, FFFFF0, FFFAF0, FFF5EE, FDF5E6, FAF0E6, FAEBD7, FFEBCD, FFEFD5, F5F5DC, FFF8DC, FAFAD2, FFFFE0, FFFACD, EEE8AA, F0E68C, FFFF00, FFD700, FFA500, FF8C00, DAA520, B8860B, CD853F, D2691E, 8B4513, A0522D, A52A2A, 8B0000, 800000, B22222, CD5C5C, DC143C, FF0000, FF4500, FF6347, FF7F50, FA8072, F08080, E9967A, FFA07A, F4A460, BC8F8F, D2B48C, DEB887, F5DEB3, FFDAB9, FFDEAD, FFE4C4, FFF0F5, FFE4E1, FFC0CB, FFB6C1, FF69B4, FF00FF, FF00FF, FF1493, C71585, DB7093, DDA0DD, D8BFD8, E6E6FA, EE82EE, DA70D6, 8B008B, 800080, 4B0082, 8A2BE2, 9400D3, 9932CC, 9370DB, BA55D3, 7B68EE, 6A5ACD, 483D8B, 191970, 000080, 00008B, 0000CD, 0000FF, 4169E1, 4682B4, 6495ED, 1E90FF, 00BFFF, 87CEFA, 87CEEB, ADD8E6, 00FFFF, 00FFFF, B0E0E6, E0FFFF, A0CE00, F0FFFF, F5FFFA, F0FFF0, 7FFFD4, 40E0D0, AFEEEE, 48D1CC, 00CED1, 66CDAA, 20B2AA, 008B8B, 008080, 5F9EA0, 3CB371, 8FBC8F, 90EE90, 98FB98, 00FA9A, 00FF7F, 00FF00, 32CD32, 2E8B57, 228B22, 008000, 006400, 6B8E23, 556B2F, 808000, BDB76B, 9ACD32, 7FFF00, ADFF2F

kann die Farbe nun auch über folgenden Sprachbefehle eingestellt werden:

Bitte schalte die Lampe im Wohnzimmer an der Couch auf Olivfarbiges Graubraun

Dadurch, das die Liste colors den Wert "Aus" mit dem entsprechenden Wert "000000" in der Liste rgb enthält, kann die Lampe über die gleiche Logik auch ausgeschaltet werden:

Bitte schalte das Licht im Wohnzimmer auf Pflaume und in einer Stunde wieder aus

==== Abfragen beliebiger Geräteinformationen ====

Das folgende Beispiel zeigt die Möglichkeit auf, die Antworten für Statusabfragen direkt am abgefragten Gerät zu definieren. Hierfür werden zunächst eine Definition am T2F-Device

# 1 2 3 4
Wie && ?(@properties)&& (@types_info) && ?(@rooms) && ?(@places) =
(answer=>'T2F_getInfo("T2F_types_info=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_properties=.*$1@.*:FILTER=T2F_places=.*$4@.*","$2@")')

und eine Funktion in der 99_myUtils

<syntaxhighlight lang="perl">
sub T2F_getInfo
{
my ($filter,$info) = @_;
my @devices = devspec2array($filter);
if (@devices > 0 and defined($defs{$devices[0]}))
{
my $answer = '';

foreach (@devices){
if ($answer ne '')
{
$answer = $answer.", ";
}
my $device = $_;
my @attrVals = split(/\n/,AttrVal($device, 'T2F_types_info', ''));
foreach (@attrVals){
my $attrVal = $_;
$attrVal =~ s/ / /g;
$attrVal =~ s/ => /=>/g;
my @attrValParts = split(/=>/,$attrVal);
if (@attrValParts[0] =~ /$info/)
{
my $cmd = "' ".@attrValParts[1]."'";
$cmd =~ s/=/\//g;
$cmd =~ s/\)$/\/r=~s\//g;
$cmd =~ s/$/\/r.'/g;
$cmd =~ s/#\(/', '')=~s\//g;
$cmd =~ s/ #/ '.ReadingsVal('$device', '/g;
$cmd =~ s/#/', '').'/g;
$cmd =~ s/T2F_answer/'.T2F_answer('$device', 'T2F_types_switch').'/g;
$answer = $answer.' '.eval($cmd);
}
}
}
return $answer;
}
}
</syntaxhighlight>

Die Konfiguration und Funktionsweise sind nun wie folgt: Das Gerät, dessen Status abgefragt werden sollen erhält neben den Oben bereits beschriebenen Attributen für Eigenschaft, Raum und Ort noch das Attribut T2F_types_info, welches Zeilenweise die abzufragenen Status in der folgenden Form enthält:

abfragewert => Das ist die Antwort von Gerät T2F_answer mit den Wert #reading#(suchen1=ersetzen1)...(suchenn=ersetzenn)

Mit der Form #reading#(suchen1=ersetzen1)...(suchenn=ersetzenn) können die Werte von Readings des abgefragten Device zum Zeitpunkt der Abfrage ermittelt werden und im Ergebnis Ersetzungen vorgenommen werden (z.B. (on=an)(off=aus)). T2F_answer wird mit der T2F-Konfiguration (siehe oben) ersetzt. Für das Beispiel einer Heizung im Esszimmer wäre das zum Beispiel wie folgt möglich:

attr HeizungEsszimmer T2F_places Heizung,!
attr HeizungEsszimmer T2F_rooms Haus,Obergeschoss,Essbereich,!Esszimmer
attr HeizungEsszimmer T2F_types_info warm,Temperatur => Die Temperatur T2F_answer beträgt #measured-temp# Grad und soll #desired-temp# Grad erreichen\
modus,Betriebsart => Die Betriebsart T2F_answer ist #controlMode#(auto=Automatik)(manu=Hand)\
Ventilstellung => Das Ventil T2F_answer ist #ValvePosition# Prozent geöffnet

Damit sind dann folgende Abfragen möglich:

Wie warm ist die Heizung im Esszimmer?

Wie ist die Temperatur der Heizung im Esszimmer?

Wie ist die Ventilstellung der Heizung im Esszimmer?

Wie warm sind die Heizungen?

== Häufig verwendete RegExp ==
Perl Regular Expression, also ein regulärer Ausdruck der Programmiersprache Perl, ist eine Werkzeug um Zeichenketten zu beschreiben. Hier wird ein kurzer Einblick auf die im Artikel häufig genutzten RegExp zu geben.

Eine Auflistung der Syntax kann hier eingesehen werden. [http://jkorpela.fi/perl/regexp.html]

{|class="wikitable"
! 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+){0,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 notify 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
<nowiki>https://user:password@dnsservice:54387/fhem?cmd.talk=set talk {{TextField}}&XHR=1</nowiki>
*Fertig

Jetzt wird der gesamte Text bei dem genannten Triggerworten an FHEM weitergeleitet.

== Ausgabemethoden ==

Siehe hierzu [[Modul_Talk2Fhem#Beispiel|Anwendungsbeispiel]]

[[Kategorie:Sprachsteuerung|Talk2FHEM]]

Talk2Fhem

2018-01-30T14:14:48Z

RoBra81:

{{Infobox Modul
|ModPurpose=Das Modul stellt eine Verbindung zwischen natürlicher Sprache und FHEM Befehlen her
|ModType=h]
|ModCmdRef=Talk2Fhem
|ModForumArea=Unterstützende Dienste
|ModTechName=39_Talk2Fhem.pm
|ModOwner=Oliver Georgi
}}

Diese Seite beschreibt die Funktionsweise und Konfiguration des Moduls 39_Talk2Fhem.pm

== Voraussetzungen ==
[[Datei:ModulTalk2FhemScreenshot.png|360px|thumb|right]]
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 [[Konfiguration#Syntaxhervorhebung|hier]] 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|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.

Es werden diverse [[Modul_Talk2Fhem#Zeitenerkennung|Zeit- und Datumsangaben]] erkannt. Außerdem ist es möglich [[Modul_Talk2Fhem#Eventenerkennung|Events zu formulieren]], welche die Befehle zu einem bestimmten Ereignis ausführen lassen. Bei der weiteren Verarbeitung der Sprachbefehle wird die Sprache mit selbst definierte Schlüsselwörter verglichen.

=== 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
# Zeit- und Eventgebundenes 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. [https://forum.fhem.de/index.php/topic,80960.0.html]

== 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''' oder '''set !''' an das Modul geleitet.
set talk Guten Morgen liebes Zuhause
''Wird kein Text angehängt, wird der letzte Sprachbefehl erneut ausgeführt.''

=== Readings ===

Im Reading '''set''' steht der letzte gesendete Sprachbefehl.
 Im Reading '''cmds''' steht das letzte ausgeführte FHEM-Kommando dessen Rückgabe in in das Reading '''fhem''' geschrieben wird.

Die Antworten und Modulinterne Fehler werden in den Readings '''answers''' und '''err''' ausgegben.

In '''ifs''' stehen die Bedingungen bei dem das letzte Kommando ausgeführt werden wird.

'''notifies''' enthält eine Auflistung der Devices die für die aktuell wartenden bedingten Kommandos relevant sind. Auf diesen Devices liegt ein internes notify.

Das Reading '''status''' wird jedes mal gesetzt und erhält Werte nach folgender Priorität.
{|class="wikitable"
|1.||'''response''' ||wenn das FHEM Kommando eine Meldung ausgegeben hat
|-
|2.||'''disabled''' ||wenn das Attribute disable auf 1 steht
|-
|3.||'''err''' ||wenn der Sprachbefehl einen Fehler zurückgegeben hat
|-
|4.||'''answer''' ||wenn der Sprachbefehl eine Antwort ausgegeben hat
|-
|5.||'''done''' ||wenn keines der oberen Fälle eingetreten ist, also alles gut verlaufen ist
|}

=== 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
<syntaxhighlight lang="perl">
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");
}

}
</syntaxhighlight>
Eine weitere Möglichkeit Talk2Fhem mit anderen Modulen zu verbinden, ist über das Reading '''status''' möglich.

Die folgenden Lösung hat den Vorteil das eine Standardantwort definiert werden kann.
'''!Achtung noch nicht getestet vom Author!'''
<syntaxhighlight lang="perl">
talk:status {
my $text = ReadingsVal("talk", $EVENT, "Komisch, hier sollte eigentlich etwas Text stehen.");

if ("$EVENT" eq "response") {
#FHEM gibt bei Erfolg eig. keine Rückmeldung, also ist vermutlich was schief gelaufen
$text = "Die Haussteuerung hat folgende Meldung gebracht. $text";

} elsif ("$EVENT" eq "err") {
$text = ["Das habe ich nicht verstanden!","Phuu das kann ich noch nicht!","Nein! Heute nicht.", "Wie bitte?"]->[rand(4)];

} elsif ("$EVENT" =~ /^answer/) {
$text = ReadingsVal("talk", "answers", "Ich habe nichts zu sagen.");

} elsif ("$EVENT" eq "err") {
#in $text steht schon der fehler drin

} elsif ("$EVENT" eq "done") {
$text = ["Ok.","Ja.","Gerne.", "Mach ich!"]->[rand(4)];

} else {
$text = "Oh, es gibt etwas neues, bitte schau mal im Forum bei Talk2Fhem vorbei.";
}

fhem('set speaker speak "$text"') if $text;
}
</syntaxhighlight>

=== 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'''
<syntaxhighlight lang='perl'>dusche\S?$ = (offset=>-3600, cmd=>'set d_log bad warm')</syntaxhighlight>
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

=== Eventkonfiguration ===

=== Ereigniswiederholung ===
Werden zwei Sätze über ein '''und''' miteinander verknüpft kann der zweite Satz mit dem Wort '''wieder''' das Ereignis wiederholen.

'''Beispiel'''
mach bitte die Garage auf und in 5 Minuten wieder zu
Man benötigt hier nicht erneut den kompletten ersten Satz zu wiederholen.

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

{{Randnotiz|RNText=Wichtig
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|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 ====
<hr>

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
*'''float''' Wort enthält eine Gleitkommazahl
*'''/<regexp>/''' Wort entspricht der <regexp>
*'''word''' Wort enthält gleich oder mehr als 4 Zeichen
*'''empty''' Wort enthält eine Leere Zeichenkette
*'''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

==== Variante 2: nach Liste ====
<hr>

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 ]
 |------------------> 0 1 2 3
''(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
( @keywordlist )
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 an selber Position 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

''' Auswahl des Listenelements '''

Soll bei der Nutzung der Variable nicht der Wert aus dem Sprachbefehl, sondern der Wert der Liste genutzt werden, so wird an die Variable ein @ angehängt. So wird bei
blendet.* (Wohnzimmer|Esszimmer|Küche) = set act_$1@ 70

Die Sätze
es blendet im Esszimmer
es blendet im esszimmer
immer zu
set act_Esszimmer 70

führen, da die Liste das Esszimmer großgeschrieben enthält.

===== 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:
*cmd => 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 ====
<syntaxhighlight lang="perl">tu was = ( cmd => "set tue es" , answer => '"Erledigt"' )</syntaxhighlight>
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 ====
<syntaxhighlight lang="perl">wurde es getan = ( answer => 'Value("tue") eq "es" ? "Ja" : "Nein"')</syntaxhighlight>

==== Beispiel Temperaturabfragen ====
Eine einfache Temperaturabfrage könnte so aussehen.
<syntaxhighlight lang="perl">wie.*(kalt|warm|grad|temperatur) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("tempdev", "temperature", "Fehler")' )</syntaxhighlight>
Für eine Raumbezogene Temperaturabfrage, siehe [[Modul_Talk2Fhem#Anwendungsbeispiele_und_Vorlagen]]

== Attribute ==
Folgende Attribute werden zur Zeit unterstützt
=== T2F_keywordlist ===
<Name> = <kommaseparierte Liste mit RegExp>
'''Beispiele'''
rooms = haus|überall|wohnung , wohnzimmer , bad\S* , toilette|wc , büro , ...
names = Mama , Papa , Kevin , Jacqueline
channels = ard|das erste , zdf , rtl , sat 1 , vox , rtl2 , prosieben , kabel eins , arte
Man beachte hier die möglichkeit der RegExp 
Das Schlüsselwort '''haus''' löst das selbe aus wie '''überall''' und '''wohnung'''
 Genauso '''bad''' oder '''badezimmer''' oder '''badeirgendewas'''

=== T2F_modwordlist ===
<Name> = <kommaseparierte Liste mir RegExp>
Die Positionen der gewählten Geräte, ist eine Zuordnung zu den Listen in''T2F_keywordlist''
 Wenn Wohnzimmer in der keywordliste <rooms> an Position 2 steht muss der Rolladenaktor in der modworliste <roll> auch an Position 2 stehen.
roll = rollos_alle , d_rollo_wz , hm_roll_bad.* , hm_roll_wc , hm_roll_buero.* , ...
lights = alle_lichte , '''"sw_wz1,sw_wz2"''' , sw_bad.* , sw_wc
Sollen einem Schlüsselwort mehrere Aktoren zugeordnet werden, geht das über sogenannte "Quotes". (Anführungszeichen) Siehe <lights>.
"a,b" oder 'a,b' oder a\,b

=== T2F_disableumlautescaping ===

Deaktiviert das Konvertieren der Umlaute innnerhalb von regulären Ausdrücken in '''\S\S?'''

=== 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. Hierzu sind die entsprechenden Stellen rot markiert.
=== Keywordlist ===
Eine typische Keywordlist wäre eine Auflistung der benötigten Räume
rooms = haus|überall|wohnung,wohnzimmer,esszimmer,bad\S*,toilette|wc,
büro,schlafzimmer,ankleide|garderobe,kinderzimmer,spielzimmer,
flur|gang|diele,garage,garten,terrasse,balkon,
eg|erdgescho\S*,og|obergescho\S*,\S*auße\S*( haus)?|vor der tür

=== Einfaches schalten ===
licht (\S+) = set dev_light $1{ true => on, false => off }
=== Einfaches schalten mit eigenen Wörtern ===
Will man neben an/aus einen weiteren Zustand selbst definieren, kann das so geschehen.
garage (\S+) = set dev_gate $1{ /kurz/ => open-for-time 5, true => open, false => close }

=== Einfaches schalten mit Räumen ===
licht (\S+ ){0,2} (wohnzimmer|esszimmer|küche|terrasse) (\S+) = set $2[light_wz,light_ez,light_kitchen,light_outside] $3{ true => on, false => off }
Bei größeren Mengen an Räumen und Geräten bietet sich das anlegen von Keyword- und Modwordlisten an.
licht (\S+ ){0,2} (@rooms) (\S+) = set $2[@lights] $3{ true => on, false => off }

=== Rolladen fahren ===
Sind die Rollläden innerhalb von FHEM über das Attribut "room" den Räumen mit Klarnamen zugeordnet, lässt sich das ganze am einfachsten konfigurieren. 
'''1. nach Devicetyp'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=a:subType=blindActuator $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Wenn das Device vom subTyp "blindActuator" ist (HomeMatic Rolladenactor) und es im Raum $3 ist, wird dieses Device gefahren. Die Funktion ucfirst ist notwendig damit der erste Buchstabe groß geschrieben wird.

'''2. nach Devicenamen'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=rollo.* $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Gleiche wie oben, nur das alle Devices die mit rollo beginnen im Raum $3 gefahren werden. (rollo.*)

'''3. nach Benutzerdefinierten Räumen''' 
Ansonsten müssen wir dem Modul sagen in welchem Raum welches Device sitzt. Das hat dafür den Vorteil das die Räume als RegExp angegeben werden können. Wir erzeugen eine Modwordlist ''rollos'' in der wir alle Rollladen "Devices" auflisten. Die Reihenfolge ist an der Keywordlist "rooms" ([[Modul_Talk2Fhem#Keywordlist]]) anzupassen.
rollos = r_alle,r_wz,r_ez,,r_buero,...
 '''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

=== GoogleCast Befehle ===
Etwas bessere Lautstärkebefehle als die von Google.
Die Lautstärken müssten noch dem eigenen Geschmack angepasst werden
#GoogleCast Commandos
leise$ = set googlecastdevice volume 14
normale lautstärke = set googlecastdevice volume 20
laut$ = set googlecastdevice volume 30
(ein wenig|etwas|viel)? ?(lauter|leiser) = { fhem("set googlecastdevice volume ".(ReadingsVal("googlecastdevice","volume", 0)$2[+,-]$1[3,5,10,empty,7])) }
''' Beispielsätze '''
Mach leise
Mach lauter
Mach etwas leiser
Mach viel lauter

=== Talk Timer zurücksetzen ===
Sollen alle von Talk2Fhem angelegten Timer gelöscht werden.
(timer|kommandos) (löschen|zurücksetzen) = delete at_talk.*
'''Beispielsätze'''
bitte alle timer zurücksetzen
zukünftige kommandos löschen

=== Frage Antwort ===
==== Raumbezogene Temperaturansage ====
Wir erzeugen wieder unsere Modwordlist sagen wir @sens gefüllt mit den Temperaturfühler "Devices". Reihenfolge wie immer die der Keywordlist @rooms.
wie.*(kalt|warm|grad|temperatur).*(@rooms) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("$2[@sens]", "temperature", "unbekannt")." grad"' )
'''Beispielsätze'''
wie warm ist es im Wohnzimmer
wie ist die Temperatur in der Küche
wie kalt ist es draußen

==== Multiple Antworten ====
Hallo Haus = ( answer => '["Hallo auch!","Guten Tag!","Ahoi!"]->[rand(3)]' )
Wählt zufällig eine der drei Aussagen.

==== Ausgabe eines oder mehrerer Zustände ====
Angenommen man möchte wissen ob das Haus abgeschlossen ist. Und in FHEM existiert ein Dummy der diesen Zustand wiederspiegelt und im Reading text die offenen Fenster und Türen aufgelistet sind. Kann man folgendermaßen den Status erfragen
(alles|das haus) (zu|abgeschlossen) = (
answer => '(Value("d_schliessung") eq "zu")
? "Es ist alles zu"
: "Nein, offen sind: ".ReadingsVal("d_schliessung","text","")'

==== Zustandsabfrage anhand des Aliasnamen ====
Möchte man alle Geräte anhand seines Attribut "alias" ansprechen, um dessen Status zu erfragen, könnte das so erfolgen.
 '''Definition'''
(zustand|status) (\S+)* (\S+) = (answer=>'my $s=Value((grep { "$3" =~ /$attr{$_}{alias}/i } (keys %attr))[0]);; "Der Status ist ".$s if $s')
'''Beispielsätze'''
Wie ist der Zustand der Lüftung
sag mir den Status der Haustür
Es ist auch möglich ein eigenes Attribut zu kreieren, und dieses als Klarnamenattribut zu verwenden. Hierzu einfach im Device global ein userattr hinzufügen. z.B.
attr global userattr T2F_alias
Jetzt stehen in allen Devices das Attribut T2F_alias zur Verfügung. Vorteil ist das dann auch wieder RegExp verwendet werden können. Im oberen Beispiel müsste dann dass rot markierte "alias" durch "T2F_alias" ersetzt werden.

=== Konfiguration innerhalb der Geräte ===
Neben der Identifikation der Geräte über die vorhandenen FHEM-Attribute (z.B. room, alias, ...) kann eine alternative Konfiguration auch über eigens für Talk2Fhem angelegte Attribute erfolgen. Die hierfür notwendigen Grundlagen und einige Beispiele sollen im Folgenden beschrieben werden.

==== Grundlagen / Voraussetzungen ====
1. Anlegen der notwendigen userattr am global-Device:

Erweiterung des Attributes userattr des Gerätes global um folgende Einträge:
T2F_places:textField-long T2F_properties:textField-long T2F_rooms:textField-long T2F_types_color:textField-long T2F_types_heating:textField-long T2F_types_info:textField-long T2F_types_switch:textField-long

2. Optional: Hilfsfunktionen für das automatische Füllen der T2F_keywordlist im talk-Device bei Änderung eines T2F-Attributes eines Gerätes

2a. erstellen einer sub in der 99_myUtils.pm:

<syntaxhighlight lang="perl"> sub fill_T2F_keywordlist
{
my ($name, $t2f_device) = @_;
$name =~ s/T2F_//g;
if ($name eq 'userattr')
{
return;
}
Log 0, "List: ".$name;
my $currentAttr = AttrVal($t2f_device,"T2F_keywordlist","");
my @currentAttrParts = split(/$name = /, $currentAttr);
my $currentAttrBeg = @currentAttrParts[0];
$currentAttrBeg = substr($currentAttrBeg, 0, -1);
my @currentAttrEnd = split(/\n/, @currentAttrParts[1], 2);
my @array = devspec2array('a:T2F_'.$name.'=.+');
my @attributes = ();
if (@array > 0 and defined($defs{$array[0]}))
{
foreach (@array){
my @attrVals = split(/\n/,AttrVal($_, 'T2F_'.$name, ''));
foreach (@attrVals){
my $attrVal = $_;
$attrVal =~ s/ / /g;
$attrVal =~ s/ => /=>/g;
my @attrValParts = split(/=>/,$attrVal);
$attrVal = @attrValParts[0];
$attrVal =~ s/!//g;
$attrVal =~ s/, /,/g;
my @attr = split(/,/, $attrVal);
push(@attributes, @attr);
}
}
}
my %hash = map { $_ => 1 } @attributes;
my @unique = keys %hash;
my $result = $currentAttrBeg."\n".$name." = ".join(", ", @unique)."\n".@currentAttrEnd[1];
$result =~ s/\n\n/\n/g;
$result =~ s/ / /g;
fhem('attr '.$t2f_device.' T2F_keywordlist '.$result);
}</syntaxhighlight>

2b. Erstellen eines DOIFs zum Aufruf der sub:

defmod talk.DI.fillAttr DOIF ([global:"^ATTR.*T2F_.*"]) ({my $val = ReadingsVal("$SELF", "e_global_events", ""); $val =~ m/(\S*) (\S*) (\S*) (.*)/; if ($2 ne 'talk' && $2 ne 'global') { fill_T2F_keywordlist("$3", "talk");}})
attr talk.DI.fillAttr do always

3. Optional: Erlauben von Umlauten in den T2F-Attributen:

attr talk T2F_disableumlautescaping 1

Nun können die T2F-Attribute pro FHEM-Device definiert und dann in den Talk2Fhem-Befehlen benutzt werden. Wurde der Punkt 2 abgearbeitet, so werden mit dem Füllen der Attribute am Geräte auch die Keywordlisten am talk-Device gefüllt. Wie diese dann verwendet werden können, sollen die folgenden Beispiele zeigen.

==== Schalten von Geräten ====

Ausgangssituation: Es gibt drei Lampen Lampe1, Lampe2, Lampe3 und ein Nachtlicht mit einer Eule mit folgenden Attributen:

attr Lampe1 T2F_types_switch Lampe, !Licht
attr Lampe1 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe1 T2F_places Decke, Tür
attr Lampe1 T2F_properties hell,!

attr Lampe2 T2F_types_switch Lampe, !Licht
attr Lampe2 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe2 T2F_places Tisch, Esstisch
attr Lampe2 T2F_properties dunkel,schwach,!

attr Lampe3 T2F_types_switch Lampe, !Licht
attr Lampe3 T2F_rooms Haus, Obergeschoss, !Küche
attr Lampe3 T2F_places Besenschrank

attr Nachtlicht T2F_types_switch Lampe, !Licht, Eule, Nachtlicht
attr Nachtlicht T2F_rooms Haus, Obergeschoss, !Kinderschlafzimmer
attr Nachtlicht T2F_places Steckdose

Durch die in Punkt 2 der Voraussetzungen genannten Funktionen wurden folgende T2F-keywordlisten automatisch angelegt:

attr talk T2F_keywordlist rooms = Kinderschlafzimmer, Haus, Küche, Obergeschoss, Esszimmer
places = Tür, Steckdose, Tisch, Decke, Esstisch
properties = hell, dunkel, schwach
types_switch = Lampe, Licht, Eule

Die Definition für das T2F-Device lautet dann wie folgt:

# 1 2 3 4 5 6 7
?(bitte) && ?(@properties) && (@types_switch) && ?(@rooms) && ?(@places) && (\S+)(schalten|machen)?$ =
(cmd=>'set T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.* $6{true=>on, false=>off}',
answer=>'"$AGAIN" ? "dann $DATE wieder $6{true=>ein, false=>aus}" : "$1{/bitte/=>Gern, else=>Das heißt Bitte}, ich schalte $1{/bitte/=>, else=>trotzdem} folgende Geräte $6{true=>ein, false=>aus}: ".T2F_answer("T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.*","T2F_types_switch")')

Damit sind dann die folgenden Sprachbefehle möglich:

Schalte das Licht in der Küche ein => schaltet Lampe3 ein

Schalte die helle Lampe im Esszimmer an => schaltet Lampe1 ein

Schalte das Licht im Esszimmer über dem Esstisch ein => schaltet Lampe2 ein

Schalte die Eule ein => schaltet Nachtlicht ein

Schalte das Licht im Esszimmer aus} => schaltet Lampe1 und Lampe2 aus

Schalte das Licht aus => schaltet alle vier Lichter aus

Um in der Antwort die Liste der geschalteten Geräte genannt zu bekommen, wird die sub T2F_answer aus der 99_myUtils aufgerufen:

<syntaxhighlight lang="perl">
sub T2F_answer
{
my ($filter, $type) = @_;
my $answer = '';
my @devices = devspec2array($filter);
if (@devices > 0 and defined($defs{$devices[0]}))
{
foreach (@devices){
my $devAttr = AttrVal($_, $type, '');
if ($answer ne '')
{
$answer = $answer.", ";
}
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_properties', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_rooms', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_places', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}
}
}
return $answer."";
}
</syntaxhighlight>

Die Benennung der Geräte erfolgt auf Basis derer T2F-Attribute: Typ, Eigenschaft, Raum, Ort. Ist das jeweilige Attribut leer, ist es auch in der Antwort leer. Enthält die jeweilige Attributliste ein Ausrufezeichen (!), so wird der Eintrag nach dem Ausrufezeichen für die Antwort verwendet (z.B. Esszimmer als Raum). Steht das Ausrufezeichen am Ende, so wird der Eintrag in der Antwort leer gelassen (z.B. die Eigenschaft bei Lampe1). Ist kein Ausrufezeichen vorhanden, so wird der erste Eintrag verwendet.

==== Einstellen der Heizung ====

Das gleiche Prinzp wie bei den Lampen kann auch für die Einstellung der Heizung verwendet werden.

Ausgangssituation: In der Küche, im Kinderschlafzimmer und im Esszimmer gibt es jeweils eine Heizung (Homematic HM-CC-RT-DN) mit folgenden Attributen:

attr HeizungEsszimmer T2F_places Heizung,!
attr HeizungEsszimmer T2F_rooms Haus,Obergeschoss,Essbereich,!Esszimmer
attr HeizungEsszimmer T2F_types_heating Heizung,Temperatur,Esszimmer,Essbereich,!

attr HeizungKüche T2F_places Heizung,!
attr HeizungKüche T2F_rooms Haus,Obergeschoss,Essbereich,!Küche
attr HeizungKüche T2F_types_heating Heizung,Temperatur,Küche,Essbereich,!

attr HeizungKiSchla T2F_places Heizung,!
attr HeizungKiSchla T2F_rooms Haus,Obergeschoss,!Kinderschlafzimmer
attr HeizungKiSchla T2F_types_heating Heizung,Temperatur,Kinderschlafzimmer,!

Mit der T2F-Definition

# 1 2 3 4 5
?(bitte) && (@types_heating) && ?(@rooms) && (auf (\d+) grad|auto\S*)( stellen| setzen| einstellen| ein)?$ =
(cmd=>'set T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.* $5{integer=>desired-temp $5, else=>controlMode auto}',
answer=>'"$AGAIN" ? "dann $DATE wieder auf Automatik" : "Die Durchschnittstemperatur beträgt dort zur Zeit ".averageTemp("T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.*")." Grad\n$1{/bitte/=>Gern, else=>Das heißt Bitte}, ich stelle die Heizung in folgenden Räumen auf $5{integer=>$5 Grad, else=>Automatik}: ".T2F_answer("T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.*","T2F_types_heating")')

funktionieren folgende Sprachbefehle:

Bitte stell die Heizung im Esszimmer auf 21 Grad => Stellt die Heizung im Esszimmer auf 21 Grad

Bitte stell die Heizung im Essbereich auf 21 Grad => Stellt die Heizungen im Esszimmer und in der Küche auf 21 Grad

Bitte stell die Heizung im Obergeschoss auf Automatik => Stellt die drei Heizungen auf Automatik

Dadurch, dass im Attribut T2F_types_heating auch die Räume aufgeführt sind, sind auch Befehle in folgender Form möglich:

Bitte stell die Küche auf 21 Grad => Stellt die Heizung in der Küche auf 21 Grad

Auch kann in diesem (wie auch in den oben aufgeführten Schaltbefehlen) mit "wieder" gearbeitet werden:

Bitte stell die Heizung im Essbereich auf 21 Grad und in 2 Stunden wieder auf Automatik

Für die Generierung der Antwort wird neben der bei den Schaltbefehlen bereits gezeigten sub T2F_answer eine weiter Funktion verwende, welche die Durchschnittstemperatur im zu schaltenden Bereich ermittelt und ausgibt:

<syntaxhighlight lang="perl">
sub averageTemp($)
{
my ($filter) = @_;
my @tempDevices = devspec2array($filter);
my $count = 0;
my $measuredTemp = 0;
if (@tempDevices > 0 and defined($defs{$tempDevices[0]})){
foreach (@tempDevices){
$measuredTemp = $measuredTemp + ReadingsVal($_, "measured-temp", "");
$count = $count + 1;
}
return $measuredTemp / $count;
}
return 0;
}
</syntaxhighlight>

==== Einstellen der Farbe von Farbwechsellampen (Philips Hue, Wifilight, ...) ====

Für das Beispiel zum Einstellen der Lichtfarbe nehmen wir eine Farbwechsellampe LampeBunt an, welche den Befehl RGB unterstützt. Diese erhält folgende Attribute:

attr LampeBunt T2F_places Decke,Couch,Sofa
attr LampeBunt T2F_rooms Haus,Dachgeschoss,!Wohnzimmer
attr LampeBunt T2F_types_color Lampe,Licht
attr LampeBunt T2F_types_switch Lampe,Licht

Durch das Attribut T2F_types_switch lässt sich diese über die bereits beschriebene Schaltlogik ein und ausschalten. Durch die zusätzlich T2F-Definition

# 1 2 3 4 5 6
?(bitte) && (@types_color) && ?(@rooms) && ?(@places) && auf (@colors)( schalten| stellen)?$ =
(cmd=>'set T2F_types_color=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_places=.*$4@.* RGB $5[@rgb]',
answer=>'"Ich schalte folgende Geräte auf $5@: ".T2F_answer("T2F_types_color=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_places=.*$4@.*","T2F_types_color")')

und die entsprechenden Attribute am T2F-Device talk (HINWEIS: eigene Listen können Problemlos ergänzt werden, diese werden durch die Hilfsfunktionen NICHT überschrieben)

attr talk T2F_keywordlist colors = Aus, Schwarz, Dunkles Schiefergrau, Schiefergrau, Helles Schiefergrau, Helles Stahlblau, Mattes Grau, Grau, Dunkelgrau, Silber, Hellgrau, Gainsboro, Rauchiges Weiß, Geisterweiß, Weiß, Schneeweiß, Elfenbein, Blütenweiß, Muschel, Altgold, Leinenfarbe, Antikes Weiß, Mandelweiß, Cremiges Papaya, Beige, Mais, Helles Goldrutengelb, Hellgelb, Chiffongelb, Blasse Goldrutenfarbe, Khaki, Gelb, Gold, Orange, Dunkles Orange, Goldrute, dunkle Goldrutenfarbe, Peru, Schokolade, Sattelbraun, Ocker, Braun, Dunkelrot, Kastanienbraun, Ziegelfarbe, Indischrot, Karmesinrot, Rot, Orangenrot, Tomatenrot, Koralle, Lachs, Helles Korallenrot, Dunkle Lachsfarbe, Helle Lachsfarbe, Sandbraun, Rosiges Braun, Gelbbraun, Grobes Braun, Weizen, Pfirsich, Navajoweiß, Tomatencreme, Rosige Lavenderfarbe, Altrosa, Rosa, Hellrosa, Leuchtendes Rosa, Fuchsie, Magentarot, Tiefrosa, Mittleres Violettrot, Blasses Violettrot, Pflaume, Distel, Lavendelfarbe, Violett, Orchidee, Dunkles Magentarot, Violett, Indigo, Blauviolett, Dunkles Violett, Dunkle Orchideenfarbe, Mittleres Violett, Mittlere Orchideenfarbe, Mittleres Schieferblau, Schieferblau, Dunkles Schieferblau, Mitternachtsblau, Marineblau, Dunkelblau, Mittelblau, Blau, Königsblau, Stahlblau, Kornblumenblau, Dodger-Blau, Tiefes Himmelblau, Helles Himmelblau, Himmelblau, Hellblau, Zyanblau, Blaugrün, Taubenblau, Helles Cyanblau, Aliceblau, Himmelblau, Cremig Pfefferminz, Honigmelone, Aquamarinblau, Türkis, Blasses Türkis, Mittleres Türkis, Dunkles Türkis, Mittleres Aquamarinblau, Helles Seegrün, Dunkles Zyanblau, Entenbraun, Kadettblau, Mittleres Seegrün, Dunkles Seegrün, Hellgrün, Blassgrün, Mittleres Frühlingsgrün, Frühlingsgrün, Zitronengrün, Gelbgrün, Seegrün, Waldgrün, Grün, Dunkelgrün, Olivfarbiges Graubraun, Dunkles Olivgrün, Olivgrün, Dunkles Khaki, Gelbgrün, Hellgrün, Grüngelb

attr talk T2F_modwordlist rgb = 000000, 000000, 8FBC8F, 708090, 778899, B0C4DE, 696969, 808080, A9A9A9, C0C0C0, D3D3D3, DCDCDC, F5F5F5, F8F8FF, FFFFFF, FFFAFA, FFFFF0, FFFAF0, FFF5EE, FDF5E6, FAF0E6, FAEBD7, FFEBCD, FFEFD5, F5F5DC, FFF8DC, FAFAD2, FFFFE0, FFFACD, EEE8AA, F0E68C, FFFF00, FFD700, FFA500, FF8C00, DAA520, B8860B, CD853F, D2691E, 8B4513, A0522D, A52A2A, 8B0000, 800000, B22222, CD5C5C, DC143C, FF0000, FF4500, FF6347, FF7F50, FA8072, F08080, E9967A, FFA07A, F4A460, BC8F8F, D2B48C, DEB887, F5DEB3, FFDAB9, FFDEAD, FFE4C4, FFF0F5, FFE4E1, FFC0CB, FFB6C1, FF69B4, FF00FF, FF00FF, FF1493, C71585, DB7093, DDA0DD, D8BFD8, E6E6FA, EE82EE, DA70D6, 8B008B, 800080, 4B0082, 8A2BE2, 9400D3, 9932CC, 9370DB, BA55D3, 7B68EE, 6A5ACD, 483D8B, 191970, 000080, 00008B, 0000CD, 0000FF, 4169E1, 4682B4, 6495ED, 1E90FF, 00BFFF, 87CEFA, 87CEEB, ADD8E6, 00FFFF, 00FFFF, B0E0E6, E0FFFF, A0CE00, F0FFFF, F5FFFA, F0FFF0, 7FFFD4, 40E0D0, AFEEEE, 48D1CC, 00CED1, 66CDAA, 20B2AA, 008B8B, 008080, 5F9EA0, 3CB371, 8FBC8F, 90EE90, 98FB98, 00FA9A, 00FF7F, 00FF00, 32CD32, 2E8B57, 228B22, 008000, 006400, 6B8E23, 556B2F, 808000, BDB76B, 9ACD32, 7FFF00, ADFF2F

kann die Farbe nun auch über folgenden Sprachbefehle eingestellt werden:

Bitte schalte die Lampe im Wohnzimmer an der Couch auf Olivfarbiges Graubraun

Dadurch, das die Liste colors den Wert "Aus" mit dem entsprechenden Wert "000000" in der Liste rgb enthält, kann die Lampe über die gleiche Logik auch ausgeschaltet werden:

Bitte schalte das Licht im Wohnzimmer auf Pflaume und in einer Stunde wieder aus

==== Abfragen beliebiger Geräteinformationen ====

Das folgende Beispiel zeigt die Möglichkeit auf, die Antworten für Statusabfragen direkt am abgefragten Gerät zu definieren. Hierfür werden zunächst eine Definition am T2F-Device

# 1 2 3 4
Wie && ?(@properties)&& (@types_info) && ?(@rooms) && ?(@places) =
(answer=>'T2F_getInfo("T2F_types_info=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_properties=.*$1@.*:FILTER=T2F_places=.*$4@.*","$2@")')

und eine Funktion in der 99_myUtils

<syntaxhighlight lang="perl">
sub T2F_getInfo
{
my ($filter,$info) = @_;
my @devices = devspec2array($filter);
if (@devices > 0 and defined($defs{$devices[0]}))
{
my $answer = '';

foreach (@devices){
if ($answer ne '')
{
$answer = $answer.", ";
}
my $device = $_;
my @attrVals = split(/\n/,AttrVal($device, 'T2F_types_info', ''));
foreach (@attrVals){
my $attrVal = $_;
$attrVal =~ s/ / /g;
$attrVal =~ s/ => /=>/g;
my @attrValParts = split(/=>/,$attrVal);
if (@attrValParts[0] =~ /$info/)
{
my $cmd = "' ".@attrValParts[1]."'";
$cmd =~ s/=/\//g;
$cmd =~ s/\)$/\/r=~s\//g;
$cmd =~ s/$/\/r.'/g;
$cmd =~ s/#\(/', '')=~s\//g;
$cmd =~ s/ #/ '.ReadingsVal('$device', '/g;
$cmd =~ s/#/', '').'/g;
$cmd =~ s/T2F_answer/'.T2F_answer('$device', 'T2F_types_switch').'/g;
$answer = $answer.' '.eval($cmd);
}
}
}
return $answer;
}
}
</syntaxhighlight>

Die Konfiguration und Funktionsweise sind nun wie folgt: Das Gerät, dessen Status abgefragt werden sollen erhält neben den Oben bereits beschriebenen Attributen für Eigenschaft, Raum und Ort noch das Attribut T2F_types_info, welches Zeilenweise die abzufragenen Status in der folgenden Form enthält:

abfragewert => Das ist die Antwort von Gerät T2F_answer mit den Wert #reading#(suchen1=ersetzen1)...(suchenn=ersetzenn)

Mit der Form #reading#(suchen1=ersetzen1)...(suchenn=ersetzenn) können die Werte von Readings des abgefragten Device zum Zeitpunkt der Abfrage ermittelt werden und im Ergebnis Ersetzungen vorgenommen werden (z.B. (on=an)(off=aus)). T2F_answer wird mit der T2F-Konfiguration (siehe oben) ersetzt. Für das Beispiel einer Heizung im Esszimmer wäre das zum Beispiel wie folgt möglich:

attr HeizungEsszimmer T2F_places Heizung,!
attr HeizungEsszimmer T2F_rooms Haus,Obergeschoss,Essbereich,!Esszimmer
attr HeizungEsszimmer T2F_types_info warm,Temperatur => Die Temperatur T2F_answer beträgt #measured-temp# Grad und soll #desired-temp# Grad erreichen\
modus,Betriebsart => Die Betriebsart T2F_answer ist #controlMode#(auto=Automatik)(manu=Hand)\
Ventilstellung => Das Ventil T2F_answer ist #ValvePosition# Prozent geöffnet

Damit sind dann folgende Abfragen möglich:

Wie warm ist die Heizung im Esszimmer?

Wie ist die Temperatur der Heizung im Esszimmer?

Wie ist die Ventilstellung der Heizung im Esszimmer?

Wie warm sind die Heizungen?

== Häufig verwendete RegExp ==
Perl Regular Expression, also ein regulärer Ausdruck der Programmiersprache Perl, ist eine Werkzeug um Zeichenketten zu beschreiben. Hier wird ein kurzer Einblick auf die im Artikel häufig genutzten RegExp zu geben.

Eine Auflistung der Syntax kann hier eingesehen werden. [http://jkorpela.fi/perl/regexp.html]

{|class="wikitable"
! 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+){0,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 notify 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
<nowiki>https://user:password@dnsservice:54387/fhem?cmd.talk=set talk {{TextField}}&XHR=1</nowiki>
*Fertig

Jetzt wird der gesamte Text bei dem genannten Triggerworten an FHEM weitergeleitet.

== Ausgabemethoden ==

Siehe hierzu [[Modul_Talk2Fhem#Beispiel|Anwendungsbeispiel]]

[[Kategorie:Sprachsteuerung|Talk2FHEM]]

Talk2Fhem

2018-01-30T13:26:01Z

RoBra81:

{{Infobox Modul
|ModPurpose=Das Modul stellt eine Verbindung zwischen natürlicher Sprache und FHEM Befehlen her
|ModType=h]
|ModCmdRef=Talk2Fhem
|ModForumArea=Unterstützende Dienste
|ModTechName=39_Talk2Fhem.pm
|ModOwner=Oliver Georgi
}}

Diese Seite beschreibt die Funktionsweise und Konfiguration des Moduls 39_Talk2Fhem.pm

== Voraussetzungen ==
[[Datei:ModulTalk2FhemScreenshot.png|360px|thumb|right]]
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 [[Konfiguration#Syntaxhervorhebung|hier]] 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|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.

Es werden diverse [[Modul_Talk2Fhem#Zeitenerkennung|Zeit- und Datumsangaben]] erkannt. Außerdem ist es möglich [[Modul_Talk2Fhem#Eventenerkennung|Events zu formulieren]], welche die Befehle zu einem bestimmten Ereignis ausführen lassen. Bei der weiteren Verarbeitung der Sprachbefehle wird die Sprache mit selbst definierte Schlüsselwörter verglichen.

=== 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
# Zeit- und Eventgebundenes 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. [https://forum.fhem.de/index.php/topic,80960.0.html]

== 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''' oder '''set !''' an das Modul geleitet.
set talk Guten Morgen liebes Zuhause
''Wird kein Text angehängt, wird der letzte Sprachbefehl erneut ausgeführt.''

=== Readings ===

Im Reading '''set''' steht der letzte gesendete Sprachbefehl.
 Im Reading '''cmds''' steht das letzte ausgeführte FHEM-Kommando dessen Rückgabe in in das Reading '''fhem''' geschrieben wird.

Die Antworten und Modulinterne Fehler werden in den Readings '''answers''' und '''err''' ausgegben.

In '''ifs''' stehen die Bedingungen bei dem das letzte Kommando ausgeführt werden wird.

'''notifies''' enthält eine Auflistung der Devices die für die aktuell wartenden bedingten Kommandos relevant sind. Auf diesen Devices liegt ein internes notify.

Das Reading '''status''' wird jedes mal gesetzt und erhält Werte nach folgender Priorität.
{|class="wikitable"
|1.||'''response''' ||wenn das FHEM Kommando eine Meldung ausgegeben hat
|-
|2.||'''disabled''' ||wenn das Attribute disable auf 1 steht
|-
|3.||'''err''' ||wenn der Sprachbefehl einen Fehler zurückgegeben hat
|-
|4.||'''answer''' ||wenn der Sprachbefehl eine Antwort ausgegeben hat
|-
|5.||'''done''' ||wenn keines der oberen Fälle eingetreten ist, also alles gut verlaufen ist
|}

=== 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
<syntaxhighlight lang="perl">
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");
}

}
</syntaxhighlight>
Eine weitere Möglichkeit Talk2Fhem mit anderen Modulen zu verbinden, ist über das Reading '''status''' möglich.

Die folgenden Lösung hat den Vorteil das eine Standardantwort definiert werden kann.
'''!Achtung noch nicht getestet vom Author!'''
<syntaxhighlight lang="perl">
talk:status {
my $text = ReadingsVal("talk", $EVENT, "Komisch, hier sollte eigentlich etwas Text stehen.");

if ("$EVENT" eq "response") {
#FHEM gibt bei Erfolg eig. keine Rückmeldung, also ist vermutlich was schief gelaufen
$text = "Die Haussteuerung hat folgende Meldung gebracht. $text";

} elsif ("$EVENT" eq "err") {
$text = ["Das habe ich nicht verstanden!","Phuu das kann ich noch nicht!","Nein! Heute nicht.", "Wie bitte?"]->[rand(4)];

} elsif ("$EVENT" =~ /^answer/) {
$text = ReadingsVal("talk", "answers", "Ich habe nichts zu sagen.");

} elsif ("$EVENT" eq "err") {
#in $text steht schon der fehler drin

} elsif ("$EVENT" eq "done") {
$text = ["Ok.","Ja.","Gerne.", "Mach ich!"]->[rand(4)];

} else {
$text = "Oh, es gibt etwas neues, bitte schau mal im Forum bei Talk2Fhem vorbei.";
}

fhem('set speaker speak "$text"') if $text;
}
</syntaxhighlight>

=== 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'''
<syntaxhighlight lang='perl'>dusche\S?$ = (offset=>-3600, cmd=>'set d_log bad warm')</syntaxhighlight>
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

=== Eventkonfiguration ===

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

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

{{Randnotiz|RNText=Wichtig
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|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 ====
<hr>

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
*'''float''' Wort enthält eine Gleitkommazahl
*'''/<regexp>/''' Wort entspricht der <regexp>
*'''word''' Wort enthält gleich oder mehr als 4 Zeichen
*'''empty''' Wort enthält eine Leere Zeichenkette
*'''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

==== Variante 2: nach Liste ====
<hr>

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 ]
 |------------------> 0 1 2 3
''(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
( @keywordlist )
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 an selber Position 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

''' Auswahl des Listenelements '''

Soll bei der Nutzung der Variable nicht der Wert aus dem Sprachbefehl, sondern der Wert der Liste genutzt werden, so wird an die Variable ein @ angehängt. So wird bei
blendet.* (Wohnzimmer|Esszimmer|Küche) = set act_$1@ 70

Die Sätze
es blendet im Esszimmer
es blendet im esszimmer
immer zu
set act_Esszimmer 70

führen, da die Liste das Esszimmer großgeschrieben enthält.

===== 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:
*cmd => 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 ====
<syntaxhighlight lang="perl">tu was = ( cmd => "set tue es" , answer => '"Erledigt"' )</syntaxhighlight>
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 ====
<syntaxhighlight lang="perl">wurde es getan = ( answer => 'Value("tue") eq "es" ? "Ja" : "Nein"')</syntaxhighlight>

==== Beispiel Temperaturabfragen ====
Eine einfache Temperaturabfrage könnte so aussehen.
<syntaxhighlight lang="perl">wie.*(kalt|warm|grad|temperatur) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("tempdev", "temperature", "Fehler")' )</syntaxhighlight>
Für eine Raumbezogene Temperaturabfrage, siehe [[Modul_Talk2Fhem#Anwendungsbeispiele_und_Vorlagen]]

== Attribute ==
Folgende Attribute werden zur Zeit unterstützt
=== T2F_keywordlist ===
<Name> = <kommaseparierte Liste mit RegExp>
'''Beispiele'''
rooms = haus|überall|wohnung , wohnzimmer , bad\S* , toilette|wc , büro , ...
names = Mama , Papa , Kevin , Jacqueline
channels = ard|das erste , zdf , rtl , sat 1 , vox , rtl2 , prosieben , kabel eins , arte
Man beachte hier die möglichkeit der RegExp 
Das Schlüsselwort '''haus''' löst das selbe aus wie '''überall''' und '''wohnung'''
 Genauso '''bad''' oder '''badezimmer''' oder '''badeirgendewas'''

=== T2F_modwordlist ===
<Name> = <kommaseparierte Liste mir RegExp>
Die Positionen der gewählten Geräte, ist eine Zuordnung zu den Listen in''T2F_keywordlist''
 Wenn Wohnzimmer in der keywordliste <rooms> an Position 2 steht muss der Rolladenaktor in der modworliste <roll> auch an Position 2 stehen.
roll = rollos_alle , d_rollo_wz , hm_roll_bad.* , hm_roll_wc , hm_roll_buero.* , ...
lights = alle_lichte , '''"sw_wz1,sw_wz2"''' , sw_bad.* , sw_wc
Sollen einem Schlüsselwort mehrere Aktoren zugeordnet werden, geht das über sogenannte "Quotes". (Anführungszeichen) Siehe <lights>.
"a,b" oder 'a,b' oder a\,b

=== T2F_disableumlautescaping ===

Deaktiviert das Konvertieren der Umlaute innnerhalb von regulären Ausdrücken in '''\S\S?'''

=== 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. Hierzu sind die entsprechenden Stellen rot markiert.
=== Keywordlist ===
Eine typische Keywordlist wäre eine Auflistung der benötigten Räume
rooms = haus|überall|wohnung,wohnzimmer,esszimmer,bad\S*,toilette|wc,
büro,schlafzimmer,ankleide|garderobe,kinderzimmer,spielzimmer,
flur|gang|diele,garage,garten,terrasse,balkon,
eg|erdgescho\S*,og|obergescho\S*,\S*auße\S*( haus)?|vor der tür

=== Einfaches schalten ===
licht (\S+) = set dev_light $1{ true => on, false => off }
=== Einfaches schalten mit eigenen Wörtern ===
Will man neben an/aus einen weiteren Zustand selbst definieren, kann das so geschehen.
garage (\S+) = set dev_gate $1{ /kurz/ => open-for-time 5, true => open, false => close }

=== Einfaches schalten mit Räumen ===
licht (\S+ ){0,2} (wohnzimmer|esszimmer|küche|terrasse) (\S+) = set $2[light_wz,light_ez,light_kitchen,light_outside] $3{ true => on, false => off }
Bei größeren Mengen an Räumen und Geräten bietet sich das anlegen von Keyword- und Modwordlisten an.
licht (\S+ ){0,2} (@rooms) (\S+) = set $2[@lights] $3{ true => on, false => off }

=== Rolladen fahren ===
Sind die Rollläden innerhalb von FHEM über das Attribut "room" den Räumen mit Klarnamen zugeordnet, lässt sich das ganze am einfachsten konfigurieren. 
'''1. nach Devicetyp'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=a:subType=blindActuator $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Wenn das Device vom subTyp "blindActuator" ist (HomeMatic Rolladenactor) und es im Raum $3 ist, wird dieses Device gefahren. Die Funktion ucfirst ist notwendig damit der erste Buchstabe groß geschrieben wird.

'''2. nach Devicenamen'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=rollo.* $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Gleiche wie oben, nur das alle Devices die mit rollo beginnen im Raum $3 gefahren werden. (rollo.*)

'''3. nach Benutzerdefinierten Räumen''' 
Ansonsten müssen wir dem Modul sagen in welchem Raum welches Device sitzt. Das hat dafür den Vorteil das die Räume als RegExp angegeben werden können. Wir erzeugen eine Modwordlist ''rollos'' in der wir alle Rollladen "Devices" auflisten. Die Reihenfolge ist an der Keywordlist "rooms" ([[Modul_Talk2Fhem#Keywordlist]]) anzupassen.
rollos = r_alle,r_wz,r_ez,,r_buero,...
 '''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

=== GoogleCast Befehle ===
Etwas bessere Lautstärkebefehle als die von Google.
Die Lautstärken müssten noch dem eigenen Geschmack angepasst werden
#GoogleCast Commandos
leise$ = set googlecastdevice volume 14
normale lautstärke = set googlecastdevice volume 20
laut$ = set googlecastdevice volume 30
(ein wenig|etwas|viel)? ?(lauter|leiser) = { fhem("set googlecastdevice volume ".(ReadingsVal("googlecastdevice","volume", 0)$2[+,-]$1[3,5,10,empty,7])) }
''' Beispielsätze '''
Mach leise
Mach lauter
Mach etwas leiser
Mach viel lauter

=== Talk Timer zurücksetzen ===
Sollen alle von Talk2Fhem angelegten Timer gelöscht werden.
(timer|kommandos) (löschen|zurücksetzen) = delete at_talk.*
'''Beispielsätze'''
bitte alle timer zurücksetzen
zukünftige kommandos löschen

=== Frage Antwort ===
==== Raumbezogene Temperaturansage ====
Wir erzeugen wieder unsere Modwordlist sagen wir @sens gefüllt mit den Temperaturfühler "Devices". Reihenfolge wie immer die der Keywordlist @rooms.
wie.*(kalt|warm|grad|temperatur).*(@rooms) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("$2[@sens]", "temperature", "unbekannt")." grad"' )
'''Beispielsätze'''
wie warm ist es im Wohnzimmer
wie ist die Temperatur in der Küche
wie kalt ist es draußen

==== Multiple Antworten ====
Hallo Haus = ( answer => '["Hallo auch!","Guten Tag!","Ahoi!"]->[rand(3)]' )
Wählt zufällig eine der drei Aussagen.

==== Ausgabe eines oder mehrerer Zustände ====
Angenommen man möchte wissen ob das Haus abgeschlossen ist. Und in FHEM existiert ein Dummy der diesen Zustand wiederspiegelt und im Reading text die offenen Fenster und Türen aufgelistet sind. Kann man folgendermaßen den Status erfragen
(alles|das haus) (zu|abgeschlossen) = (
answer => '(Value("d_schliessung") eq "zu")
? "Es ist alles zu"
: "Nein, offen sind: ".ReadingsVal("d_schliessung","text","")'

==== Zustandsabfrage anhand des Aliasnamen ====
Möchte man alle Geräte anhand seines Attribut "alias" ansprechen, um dessen Status zu erfragen, könnte das so erfolgen.
 '''Definition'''
(zustand|status) (\S+)* (\S+) = (answer=>'my $s=Value((grep { "$3" =~ /$attr{$_}{alias}/i } (keys %attr))[0]);; "Der Status ist ".$s if $s')
'''Beispielsätze'''
Wie ist der Zustand der Lüftung
sag mir den Status der Haustür
Es ist auch möglich ein eigenes Attribut zu kreieren, und dieses als Klarnamenattribut zu verwenden. Hierzu einfach im Device global ein userattr hinzufügen. z.B.
attr global userattr T2F_alias
Jetzt stehen in allen Devices das Attribut T2F_alias zur Verfügung. Vorteil ist das dann auch wieder RegExp verwendet werden können. Im oberen Beispiel müsste dann dass rot markierte "alias" durch "T2F_alias" ersetzt werden.

=== Konfiguration innerhalb der Geräte ===
Neben der Identifikation der Geräte über die vorhandenen FHEM-Attribute (z.B. room, alias, ...) kann eine alternative Konfiguration auch über eigens für Talk2Fhem angelegte Attribute erfolgen. Die hierfür notwendigen Grundlagen und einige Beispiele sollen im Folgenden beschrieben werden.

==== Grundlagen / Voraussetzungen ====
1. Anlegen der notwendigen userattr am global-Device:

Erweiterung des Attributes userattr des Gerätes global um folgende Einträge:
T2F_places:textField-long T2F_properties:textField-long T2F_rooms:textField-long T2F_types_color:textField-long T2F_types_heating:textField-long T2F_types_info:textField-long T2F_types_switch:textField-long

2. Optional: Hilfsfunktionen für das automatische Füllen der T2F_keywordlist im talk-Device bei Änderung eines T2F-Attributes eines Gerätes

2a. erstellen einer sub in der 99_myUtils.pm:

<syntaxhighlight lang="perl"> sub fill_T2F_keywordlist
{
my ($name, $t2f_device) = @_;
$name =~ s/T2F_//g;
if ($name eq 'userattr')
{
return;
}
Log 0, "List: ".$name;
my $currentAttr = AttrVal($t2f_device,"T2F_keywordlist","");
my @currentAttrParts = split(/$name = /, $currentAttr);
my $currentAttrBeg = @currentAttrParts[0];
$currentAttrBeg = substr($currentAttrBeg, 0, -1);
my @currentAttrEnd = split(/\n/, @currentAttrParts[1], 2);
my @array = devspec2array('a:T2F_'.$name.'=.+');
my @attributes = ();
if (@array > 0 and defined($defs{$array[0]}))
{
foreach (@array){
my @attrVals = split(/\n/,AttrVal($_, 'T2F_'.$name, ''));
foreach (@attrVals){
my $attrVal = $_;
$attrVal =~ s/ / /g;
$attrVal =~ s/ => /=>/g;
my @attrValParts = split(/=>/,$attrVal);
$attrVal = @attrValParts[0];
$attrVal =~ s/!//g;
$attrVal =~ s/, /,/g;
my @attr = split(/,/, $attrVal);
push(@attributes, @attr);
}
}
}
my %hash = map { $_ => 1 } @attributes;
my @unique = keys %hash;
my $result = $currentAttrBeg."\n".$name." = ".join(", ", @unique)."\n".@currentAttrEnd[1];
$result =~ s/\n\n/\n/g;
$result =~ s/ / /g;
fhem('attr '.$t2f_device.' T2F_keywordlist '.$result);
}</syntaxhighlight>

2b. Erstellen eines DOIFs zum Aufruf der sub:

defmod talk.DI.fillAttr DOIF ([global:"^ATTR.*T2F_.*"]) ({my $val = ReadingsVal("$SELF", "e_global_events", ""); $val =~ m/(\S*) (\S*) (\S*) (.*)/; if ($2 ne 'talk' && $2 ne 'global') { fill_T2F_keywordlist("$3", "talk");}})
attr talk.DI.fillAttr do always

3. Optional: Erlauben von Umlauten in den T2F-Attributen:

attr talk T2F_disableumlautescaping 1

Nun können die T2F-Attribute pro FHEM-Device definiert und dann in den Talk2Fhem-Befehlen benutzt werden. Wurde der Punkt 2 abgearbeitet, so werden mit dem Füllen der Attribute am Geräte auch die Keywordlisten am talk-Device gefüllt. Wie diese dann verwendet werden können, sollen die folgenden Beispiele zeigen.

==== Schalten von Geräten ====

Ausgangssituation: Es gibt drei Lampen Lampe1, Lampe2, Lampe3 und ein Nachtlicht mit einer Eule mit folgenden Attributen:

attr Lampe1 T2F_types_switch Lampe, !Licht
attr Lampe1 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe1 T2F_places Decke, Tür
attr Lampe1 T2F_properties hell,!

attr Lampe2 T2F_types_switch Lampe, !Licht
attr Lampe2 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe2 T2F_places Tisch, Esstisch
attr Lampe2 T2F_properties dunkel,schwach,!

attr Lampe3 T2F_types_switch Lampe, !Licht
attr Lampe3 T2F_rooms Haus, Obergeschoss, !Küche
attr Lampe3 T2F_places Besenschrank

attr Nachtlicht T2F_types_switch Lampe, !Licht, Eule, Nachtlicht
attr Nachtlicht T2F_rooms Haus, Obergeschoss, !Kinderschlafzimmer
attr Nachtlicht T2F_places Steckdose

Durch die in Punkt 2 der Voraussetzungen genannten Funktionen wurden folgende T2F-keywordlisten automatisch angelegt:

attr talk T2F_keywordlist rooms = Kinderschlafzimmer, Haus, Küche, Obergeschoss, Esszimmer
places = Tür, Steckdose, Tisch, Decke, Esstisch
properties = hell, dunkel, schwach
types_switch = Lampe, Licht, Eule

Die Definition für das T2F-Device lautet dann wie folgt:

# 1 2 3 4 5 6 7
?(bitte) && ?(@properties) && (@types_switch) && ?(@rooms) && ?(@places) && (\S+)(schalten|machen)?$ =
(cmd=>'set T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.* $6{true=>on, false=>off}',
answer=>'"$AGAIN" ? "dann $DATE wieder $6{true=>ein, false=>aus}" : "$1{/bitte/=>Gern, else=>Das heißt Bitte}, ich schalte $1{/bitte/=>, else=>trotzdem} folgende Geräte $6{true=>ein, false=>aus}: ".T2F_answer("T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.*","T2F_types_switch")')

Damit sind dann die folgenden Sprachbefehle möglich:

Schalte das Licht in der Küche ein => schaltet Lampe3 ein

Schalte die helle Lampe im Esszimmer an => schaltet Lampe1 ein

Schalte das Licht im Esszimmer über dem Esstisch ein => schaltet Lampe2 ein

Schalte die Eule ein => schaltet Nachtlicht ein

Schalte das Licht im Esszimmer aus} => schaltet Lampe1 und Lampe2 aus

Schalte das Licht aus => schaltet alle vier Lichter aus

Um in der Antwort die Liste der geschalteten Geräte genannt zu bekommen, wird die sub T2F_answer aus der 99_myUtils aufgerufen:

<syntaxhighlight lang="perl"> sub T2F_answer
{
my ($filter, $type) = @_;
my $answer;
my @devices = devspec2array($filter);
if (@devices > 0 and defined($defs{$devices[0]}))
{
#$answer = "Ich habe folgende Geräte ".$command.": ";
foreach (@devices){
$answer = $answer."\n";
my $devAttr = AttrVal($_, $type, '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_properties', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_rooms', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_places', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}
}
}
return $answer."\n";
}
</syntaxhighlight>
Die Benennung der Geräte erfolgt auf Basis derer T2F-Attribute: Typ, Eigenschaft, Raum, Ort. Ist das jeweilige Attribut leer, ist es auch in der Antwort leer. Enthält die jeweilige Attributliste ein Ausrufezeichen (!), so wird der Eintrag nach dem Ausrufezeichen für die Antwort verwendet (z.B. Esszimmer als Raum). Steht das Ausrufezeichen am Ende, so wird der Eintrag in der Antwort leer gelassen (z.B. die Eigenschaft bei Lampe1). Ist kein Ausrufezeichen vorhanden, so wird der erste Eintrag verwendet.

==== Einstellen der Heizung ====

Das gleiche Prinzp wie bei den Lampen kann auch für die Einstellung der Heizung verwendet werden.

Ausgangssituation: In der Küche, im Kinderschlafzimmer und im Esszimmer gibt es jeweils eine Heizung (Homematic HM-CC-RT-DN) mit folgenden Attributen:

attr HeizungEsszimmer T2F_places Heizung,!
attr HeizungEsszimmer T2F_rooms Haus,Obergeschoss,Essbereich,!Esszimmer
attr HeizungEsszimmer T2F_types_heating Heizung,Temperatur,Esszimmer,Essbereich,!

attr HeizungKüche T2F_places Heizung,!
attr HeizungKüche T2F_rooms Haus,Obergeschoss,Essbereich,!Küche
attr HeizungKüche T2F_types_heating Heizung,Temperatur,Küche,Essbereich,!

attr HeizungKiSchla T2F_places Heizung,!
attr HeizungKiSchla T2F_rooms Haus,Obergeschoss,!Kinderschlafzimmer
attr HeizungKiSchla T2F_types_heating Heizung,Temperatur,Kinderschlafzimmer,!

Mit der T2F-Definition

# 1 2 3 4 5
?(bitte) && (@types_heating) && ?(@rooms) && (auf (\d+) grad|auto\S*)( stellen| setzen| einstellen| ein)?$ =
(cmd=>'set T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.* $5{integer=>desired-temp $5, else=>controlMode auto}',
answer=>'"$AGAIN" ? "dann $DATE wieder auf Automatik" : "Die Durchschnittstemperatur beträgt dort zur Zeit ".averageTemp("T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.*")." Grad\n$1{/bitte/=>Gern, else=>Das heißt Bitte}, ich stelle die Heizung in folgenden Räumen auf $5{integer=>$5 Grad, else=>Automatik}: ".T2F_answer("T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.*","T2F_types_heating")')

funktionieren folgende Sprachbefehle:

Bitte stell die Heizung im Esszimmer auf 21 Grad => Stellt die Heizung im Esszimmer auf 21 Grad

Bitte stell die Heizung im Essbereich auf 21 Grad => Stellt die Heizungen im Esszimmer und in der Küche auf 21 Grad

Bitte stell die Heizung im Obergeschoss auf Automatik => Stellt die drei Heizungen auf Automatik

Dadurch, dass im Attribut T2F_types_heating auch die Räume aufgeführt sind, sind auch Befehle in folgender Form möglich:

Bitte stell die Küche auf 21 Grad => Stellt die Heizung in der Küche auf 21 Grad

Auch kann in diesem (wie auch in den oben aufgeführten Schaltbefehlen) mit "wieder" gearbeitet werden:

Bitte stell die Heizung im Essbereich auf 21 Grad und in 2 Stunden wieder auf Automatik

Für die Generierung der Antwort wird neben der bei den Schaltbefehlen bereits gezeigten sub T2F_answer eine weiter Funktion verwende, welche die Durchschnittstemperatur im zu schaltenden Bereich ermittelt und ausgibt:

<syntaxhighlight lang="perl">
sub averageTemp($)
{
my ($filter) = @_;
my @tempDevices = devspec2array($filter);
my $count = 0;
my $measuredTemp = 0;
if (@tempDevices > 0 and defined($defs{$tempDevices[0]})){
foreach (@tempDevices){
$measuredTemp = $measuredTemp + ReadingsVal($_, "measured-temp", "");
$count = $count + 1;
}
return $measuredTemp / $count;
}
return 0;
}
</syntaxhighlight>

==== Einstellen der Farbe von Farbwechsellampen (Philips Hue, Wifilight, ...) ====

Für das Beispiel zum Einstellen der Lichtfarbe nehmen wir eine Farbwechsellampe LampeBunt an, welche den Befehl RGB unterstützt. Diese erhält folgende Attribute:

attr LampeBunt T2F_places Decke,Couch,Sofa
attr LampeBunt T2F_rooms Haus,Dachgeschoss,!Wohnzimmer
attr LampeBunt T2F_types_color Lampe,Licht
attr LampeBunt T2F_types_switch Lampe,Licht

Durch das Attribut T2F_types_switch lässt sich diese über die bereits beschriebene Schaltlogik ein und ausschalten. Durch die zusätzlich T2F-Definition

# 1 2 3 4 5 6
?(bitte) && (@types_color) && ?(@rooms) && ?(@places) && auf (@colors)( schalten| stellen)?$ =
(cmd=>'set T2F_types_color=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_places=.*$4@.* RGB $5[@rgb]',
answer=>'"Ich schalte folgende Geräte auf $5@: ".T2F_answer("T2F_types_color=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_places=.*$4@.*","T2F_types_color")')

und die entsprechenden Attribute am T2F-Device talk (HINWEIS: eigene Listen können Problemlos ergänzt werden, diese werden durch die Hilfsfunktionen NICHT überschrieben)

attr talk T2F_keywordlist colors = Aus, Schwarz, Dunkles Schiefergrau, Schiefergrau, Helles Schiefergrau, Helles Stahlblau, Mattes Grau, Grau, Dunkelgrau, Silber, Hellgrau, Gainsboro, Rauchiges Weiß, Geisterweiß, Weiß, Schneeweiß, Elfenbein, Blütenweiß, Muschel, Altgold, Leinenfarbe, Antikes Weiß, Mandelweiß, Cremiges Papaya, Beige, Mais, Helles Goldrutengelb, Hellgelb, Chiffongelb, Blasse Goldrutenfarbe, Khaki, Gelb, Gold, Orange, Dunkles Orange, Goldrute, dunkle Goldrutenfarbe, Peru, Schokolade, Sattelbraun, Ocker, Braun, Dunkelrot, Kastanienbraun, Ziegelfarbe, Indischrot, Karmesinrot, Rot, Orangenrot, Tomatenrot, Koralle, Lachs, Helles Korallenrot, Dunkle Lachsfarbe, Helle Lachsfarbe, Sandbraun, Rosiges Braun, Gelbbraun, Grobes Braun, Weizen, Pfirsich, Navajoweiß, Tomatencreme, Rosige Lavenderfarbe, Altrosa, Rosa, Hellrosa, Leuchtendes Rosa, Fuchsie, Magentarot, Tiefrosa, Mittleres Violettrot, Blasses Violettrot, Pflaume, Distel, Lavendelfarbe, Violett, Orchidee, Dunkles Magentarot, Violett, Indigo, Blauviolett, Dunkles Violett, Dunkle Orchideenfarbe, Mittleres Violett, Mittlere Orchideenfarbe, Mittleres Schieferblau, Schieferblau, Dunkles Schieferblau, Mitternachtsblau, Marineblau, Dunkelblau, Mittelblau, Blau, Königsblau, Stahlblau, Kornblumenblau, Dodger-Blau, Tiefes Himmelblau, Helles Himmelblau, Himmelblau, Hellblau, Zyanblau, Blaugrün, Taubenblau, Helles Cyanblau, Aliceblau, Himmelblau, Cremig Pfefferminz, Honigmelone, Aquamarinblau, Türkis, Blasses Türkis, Mittleres Türkis, Dunkles Türkis, Mittleres Aquamarinblau, Helles Seegrün, Dunkles Zyanblau, Entenbraun, Kadettblau, Mittleres Seegrün, Dunkles Seegrün, Hellgrün, Blassgrün, Mittleres Frühlingsgrün, Frühlingsgrün, Zitronengrün, Gelbgrün, Seegrün, Waldgrün, Grün, Dunkelgrün, Olivfarbiges Graubraun, Dunkles Olivgrün, Olivgrün, Dunkles Khaki, Gelbgrün, Hellgrün, Grüngelb

attr talk T2F_modwordlist rgb = 000000, 000000, 8FBC8F, 708090, 778899, B0C4DE, 696969, 808080, A9A9A9, C0C0C0, D3D3D3, DCDCDC, F5F5F5, F8F8FF, FFFFFF, FFFAFA, FFFFF0, FFFAF0, FFF5EE, FDF5E6, FAF0E6, FAEBD7, FFEBCD, FFEFD5, F5F5DC, FFF8DC, FAFAD2, FFFFE0, FFFACD, EEE8AA, F0E68C, FFFF00, FFD700, FFA500, FF8C00, DAA520, B8860B, CD853F, D2691E, 8B4513, A0522D, A52A2A, 8B0000, 800000, B22222, CD5C5C, DC143C, FF0000, FF4500, FF6347, FF7F50, FA8072, F08080, E9967A, FFA07A, F4A460, BC8F8F, D2B48C, DEB887, F5DEB3, FFDAB9, FFDEAD, FFE4C4, FFF0F5, FFE4E1, FFC0CB, FFB6C1, FF69B4, FF00FF, FF00FF, FF1493, C71585, DB7093, DDA0DD, D8BFD8, E6E6FA, EE82EE, DA70D6, 8B008B, 800080, 4B0082, 8A2BE2, 9400D3, 9932CC, 9370DB, BA55D3, 7B68EE, 6A5ACD, 483D8B, 191970, 000080, 00008B, 0000CD, 0000FF, 4169E1, 4682B4, 6495ED, 1E90FF, 00BFFF, 87CEFA, 87CEEB, ADD8E6, 00FFFF, 00FFFF, B0E0E6, E0FFFF, A0CE00, F0FFFF, F5FFFA, F0FFF0, 7FFFD4, 40E0D0, AFEEEE, 48D1CC, 00CED1, 66CDAA, 20B2AA, 008B8B, 008080, 5F9EA0, 3CB371, 8FBC8F, 90EE90, 98FB98, 00FA9A, 00FF7F, 00FF00, 32CD32, 2E8B57, 228B22, 008000, 006400, 6B8E23, 556B2F, 808000, BDB76B, 9ACD32, 7FFF00, ADFF2F

kann die Farbe nun auch über folgenden Sprachbefehle eingestellt werden:

Bitte schalte die Lampe im Wohnzimmer an der Couch auf Olivfarbiges Graubraun

Dadurch, das die Liste colors den Wert "Aus" mit dem entsprechenden Wert "000000" in der Liste rgb enthält, kann die Lampe über die gleiche Logik auch ausgeschaltet werden:

Bitte schalte das Licht im Wohnzimmer auf Pflaume und in einer Stunde wieder aus

==== Abfragen beliebiger Geräteinformationen ====

Das folgende Beispiel zeigt die Möglichkeit auf, die Antworten für Statusabfragen direkt am abgefragten Gerät zu definieren. Hierfür werden zunächst eine Definition am T2F-Device

# 1 2 3 4
Wie && ?(@properties)&& (@types_info) && ?(@rooms) && ?(@places) =
(answer=>'T2F_getInfo("T2F_types_info=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_properties=.*$1@.*:FILTER=T2F_places=.*$4@.*","$2@")')

und eine Funktion in der 99_myUtils

<syntaxhighlight lang="perl">
sub T2F_getInfo
{
my ($filter,$info) = @_;
my @devices = devspec2array($filter);
if (@devices > 0 and defined($defs{$devices[0]}))
{
if (@devices > 1)
{
return "Ich habe mehr als ein Gerät gefunden, die Information kann nicht abgerufen werden.";
}

my $answer = "Die Abfrage von ".$info." für ";

my $devAttr = AttrVal($_, 'T2F_properties', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_rooms', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_places', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

my @attrVals = split(/\n/,AttrVal(@devices[0], 'T2F_types_info', ''));
foreach (@attrVals){
my $attrVal = $_;
$attrVal =~ s/ / /g;
$attrVal =~ s/ => /=>/g;
my @attrValParts = split(/=>/,$attrVal);
if (@attrValParts[0] =~ /$info/)
{
my $cmd = "'".@attrValParts[1]."'";
$cmd =~ s/ #/ '.ReadingsVal('@devices[0]', '/g;
$cmd =~ s/#/', '').'/g;
return eval($cmd);
}
}
}
}
</syntaxhighlight>

Die Konfiguration und Funktionsweise sind nun wie folgt: Das Gerät, dessen Status abgefragt werden sollen erhält neben den Oben bereits beschriebenen Attributen für Eigenschaft, Raum und Ort noch das Attribut T2F_types_info, welches Zeilenweise die abzufragenen Status in der folgenden Form enthält:

abfragewert => Das ist die Antwort mit den Wert #reading#

Mit der Form #reading# können die Werte von Readings des abgefragten Device zum Zeitpunkt der Abfrage ermittelt werden. Für das Beispiel einer Heizung im Esszimmer wäre das zum Beispiel wie folgt möglich:

attr HeizungEsszimmer T2F_places Heizung,!
attr HeizungEsszimmer T2F_rooms Haus,Obergeschoss,Essbereich,!Esszimmer
attr HeizungEsszimmer T2F_types_info warm,Temperatur => Die Temperatur beträgt #measured-temp# Grad und soll #desired-temp# Grad erreichen\
Ventilstellung => Das Ventil ist #ValvePosition# Prozent geöffnet

Damit sind dann folgende Abfragen möglich:

Wie warm ist die Heizung im Esszimmer?

Wie ist die Temperatur der Heizung im Esszimmer?

Wie ist die Ventilstellung der Heizung im Esszimmer?

Anders als bei den anderen Beispielen, wo alle gefundenen Geräte geschaltet werden, muss die Abfrage hier so detailliert sein, dass nur ein Gerät gefunden wird.

== Häufig verwendete RegExp ==
Perl Regular Expression, also ein regulärer Ausdruck der Programmiersprache Perl, ist eine Werkzeug um Zeichenketten zu beschreiben. Hier wird ein kurzer Einblick auf die im Artikel häufig genutzten RegExp zu geben.

Eine Auflistung der Syntax kann hier eingesehen werden. [http://jkorpela.fi/perl/regexp.html]

{|class="wikitable"
! 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+){0,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 notify 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
<nowiki>https://user:password@dnsservice:54387/fhem?cmd.talk=set talk {{TextField}}&XHR=1</nowiki>
*Fertig

Jetzt wird der gesamte Text bei dem genannten Triggerworten an FHEM weitergeleitet.

== Ausgabemethoden ==

Siehe hierzu [[Modul_Talk2Fhem#Beispiel|Anwendungsbeispiel]]

[[Kategorie:Sprachsteuerung|Talk2FHEM]]

Talk2Fhem

2018-01-28T12:40:15Z

RoBra81: Ergänzung von Beispielen

{{Infobox Modul
|ModPurpose=Das Modul stellt eine Verbindung zwischen natürlicher Sprache und FHEM Befehlen her
|ModType=h]
|ModCmdRef=Talk2Fhem
|ModForumArea=Unterstützende Dienste
|ModTechName=39_Talk2Fhem.pm
|ModOwner=Oliver Georgi
}}

Diese Seite beschreibt die Funktionsweise und Konfiguration des Moduls 39_Talk2Fhem.pm

== Voraussetzungen ==
[[Datei:ModulTalk2FhemScreenshot.png|360px|thumb|right]]
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 [[Konfiguration#Syntaxhervorhebung|hier]] 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|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. [https://forum.fhem.de/index.php/topic,80960.0.html]

== 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''' oder '''set !''' an das Modul geleitet.
set talk Guten Morgen liebes Zuhause
Wird kein Text angehängt, wird der letzte Sprachbefehl erneut ausgeführt.

=== Readings ===

Im Reading '''set''' steht der letzte gesendete Sprachbefehl.
 Im Reading '''cmds''' steht das letzte ausgeführte FHEM-Kommando dessen Rückgabe in in das Reading '''fhem''' geschrieben wird.

Die Antworten und Modulinterne Fehler werden in den Readings '''answers''' und '''err''' ausgegben.

Das Reading '''status''' wird jedes mal gesetzt und erhält Werte nach folgender Priorität.
{|class="wikitable"
|1.||'''response''' ||wenn das FHEM Kommando eine Meldung ausgegeben hat
|-
|2.||'''disabled''' ||wenn das Attribute disable auf 1 steht
|-
|3.||'''err''' ||wenn der Sprachbefehl einen Fehler zurückgegeben hat
|-
|4.||'''answer''' ||wenn der Sprachbefehl eine Antwort ausgegeben hat
|-
|5.||'''done''' ||wenn keines der oberen Fälle eingetreten ist, also alles gut verlaufen ist
|}

=== 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
<syntaxhighlight lang="perl">
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");
}

}
</syntaxhighlight>

=== 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'''
<syntaxhighlight lang='perl'>dusche\S?$ = (offset=>-3600, cmd=>'set d_log bad warm')</syntaxhighlight>
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.

{{Randnotiz|RNText=Wichtig
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|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 ====
<hr>

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>
*''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 ====
<hr>

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 ]
 |------------------> 0 1 2 3
''(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
( @keywordlist )
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 an selber Position 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:
*cmd => 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 ====
<syntaxhighlight lang="perl">tu was = ( cmd => "set tue es" , answer => '"Erledigt"' )</syntaxhighlight>
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 ====
<syntaxhighlight lang="perl">wurde es getan = ( answer => 'Value("tue") eq "es" ? "Ja" : "Nein"')</syntaxhighlight>

==== Beispiel Temperaturabfragen ====
Eine einfache Temperaturabfrage könnte so aussehen.
<syntaxhighlight lang="perl">wie.*(kalt|warm|grad|temperatur) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("tempdev", "temperature", "Fehler")' )</syntaxhighlight>
Für eine Raumbezogene Temperaturabfrage, siehe [[Modul_Talk2Fhem#Anwendungsbeispiele_und_Vorlagen]]

== Attribute ==
Folgende Attribute werden zur Zeit unterstützt
=== T2F_keywordlist ===
<Name> = <kommaseparierte Liste mit RegExp>
'''Beispiele'''
rooms = haus|überall|wohnung , wohnzimmer , bad\S* , toilette|wc , büro , ...
names = Mama , Papa , Kevin , Jacqueline
channels = ard|das erste , zdf , rtl , sat 1 , vox , rtl2 , prosieben , kabel eins , arte
Man beachte hier die möglichkeit der RegExp 
Das Schlüsselwort '''haus''' löst das selbe aus wie '''überall''' und '''wohnung'''
 Genauso '''bad''' oder '''badezimmer''' oder '''badeirgendewas'''

=== T2F_modwordlist ===
<Name> = <kommaseparierte Liste mir RegExp>
Die Positionen der gewählten Geräte, ist eine Zuordnung zu den Listen in''T2F_keywordlist''
 Wenn Wohnzimmer in der keywordliste <rooms> an Position 2 steht muss der Rolladenaktor in der modworliste <roll> auch an Position 2 stehen.
roll = rollos_alle , d_rollo_wz , hm_roll_bad.* , hm_roll_wc , hm_roll_buero.* , ...
lights = alle_lichte , '''"sw_wz1,sw_wz2"''' , sw_bad.* , sw_wc
Sollen einem Schlüsselwort mehrere Aktoren zugeordnet werden, geht das über sogenannte "Quotes". (Anführungszeichen) Siehe <lights>.
"a,b" oder 'a,b' oder a\,b

=== T2F_disableumlautescaping ===

Deaktiviert das Konvertieren der Umlaute innnerhalb von regulären Ausdrücken in '''\S\S?'''

=== 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. Hierzu sind die entsprechenden Stellen rot markiert.
=== Keywordlist ===
Eine typische Keywordlist wäre eine Auflistung der benötigten Räume
rooms = haus|überall|wohnung,wohnzimmer,esszimmer,bad\S*,toilette|wc,
büro,schlafzimmer,ankleide|garderobe,kinderzimmer,spielzimmer,
flur|gang|diele,garage,garten,terrasse,balkon,
eg|erdgescho\S*,og|obergescho\S*,\S*auße\S*( haus)?|vor der tür

=== Einfaches schalten ===
licht (\S+) = set dev_light $1{ true => on, false => off }
=== Einfaches schalten mit eigenen Wörtern ===
Will man neben an/aus einen weiteren Zustand selbst definieren, kann das so geschehen.
garage (\S+) = set dev_gate $1{ /kurz/ => open-for-time 5, true => open, false => close }

=== Einfaches schalten mit Räumen ===
licht (\S+ ){0,2} (wohnzimmer|esszimmer|küche|terrasse) (\S+) = set $2[light_wz,light_ez,light_kitchen,light_outside] $3{ true => on, false => off }
Bei größeren Mengen an Räumen und Geräten bietet sich das anlegen von Keyword- und Modwordlisten an.
licht (\S+ ){0,2} (@rooms) (\S+) = set $2[@lights] $3{ true => on, false => off }

=== Rolladen fahren ===
Sind die Rollläden innerhalb von FHEM über das Attribut "room" den Räumen mit Klarnamen zugeordnet, lässt sich das ganze am einfachsten konfigurieren. 
'''1. nach Devicetyp'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=a:subType=blindActuator $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Wenn das Device vom subTyp "blindActuator" ist (HomeMatic Rolladenactor) und es im Raum $3 ist, wird dieses Device gefahren. Die Funktion ucfirst ist notwendig damit der erste Buchstabe groß geschrieben wird.

'''2. nach Devicenamen'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=rollo.* $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Gleiche wie oben, nur das alle Devices die mit rollo beginnen im Raum $3 gefahren werden. (rollo.*)

'''3. nach Benutzerdefinierten Räumen''' 
Ansonsten müssen wir dem Modul sagen in welchem Raum welches Device sitzt. Das hat dafür den Vorteil das die Räume als RegExp angegeben werden können. Wir erzeugen eine Modwordlist ''rollos'' in der wir alle Rollladen "Devices" auflisten. Die Reihenfolge ist an der Keywordlist "rooms" ([[Modul_Talk2Fhem#Keywordlist]]) anzupassen.
rollos = r_alle,r_wz,r_ez,,r_buero,...
 '''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

=== GoogleCast Befehle ===
Etwas bessere Lautstärkebefehle als die von Google.
Die Lautstärken müssten noch dem eigenen Geschmack angepasst werden
#GoogleCast Commandos
leise$ = set googlecastdevice volume 14
normale lautstärke = set googlecastdevice volume 20
laut$ = set googlecastdevice volume 30
(ein wenig|etwas|viel)? ?(lauter|leiser) = { fhem("set googlecastdevice volume ".(ReadingsVal("googlecastdevice","volume", 0)$2[+,-]$1[3,5,10,empty,7])) }
''' Beispielsätze '''
Mach leise
Mach lauter
Mach etwas leiser
Mach viel lauter

=== Talk Timer zurücksetzen ===
Sollen alle von Talk2Fhem angelegten Timer gelöscht werden.
(timer|kommandos) (löschen|zurücksetzen) = delete at_talk.*
'''Beispielsätze'''
bitte alle timer zurücksetzen
zukünftige kommandos löschen

=== Frage Antwort ===
==== Raumbezogene Temperaturansage ====
Wir erzeugen wieder unsere Modwordlist sagen wir @sens gefüllt mit den Temperaturfühler "Devices". Reihenfolge wie immer die der Keywordlist @rooms.
wie.*(kalt|warm|grad|temperatur).*(@rooms) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("$2[@sens]", "temperature", "unbekannt")." grad"' )
'''Beispielsätze'''
wie warm ist es im Wohnzimmer
wie ist die Temperatur in der Küche
wie kalt ist es draußen

==== Multiple Antworten ====
Hallo Haus = ( answer => '["Hallo auch!","Guten Tag!","Ahoi!"]->[rand(3)]' )
Wählt zufällig eine der drei Aussagen.

==== Ausgabe eines oder mehrerer Zustände ====
Angenommen man möchte wissen ob das Haus abgeschlossen ist. Und in FHEM existiert ein Dummy der diesen Zustand wiederspiegelt und im Reading text die offenen Fenster und Türen aufgelistet sind. Kann man folgendermaßen den Status erfragen
(alles|das haus) (zu|abgeschlossen) = (
answer => '(Value("d_schliessung") eq "zu")
? "Es ist alles zu"
: "Nein, offen sind: ".ReadingsVal("d_schliessung","text","")'

==== Zustandsabfrage anhand des Aliasnamen ====
Möchte man alle Geräte anhand seines Attribut "alias" ansprechen, um dessen Status zu erfragen, könnte das so erfolgen.
 '''Definition'''
(zustand|status) (\S+)* (\S+) = (answer=>'my $s=Value((grep { "$3" =~ /$attr{$_}{alias}/i } (keys %attr))[0]);; "Der Status ist ".$s if $s')
'''Beispielsätze'''
Wie ist der Zustand der Lüftung
sag mir den Status der Haustür
Es ist auch möglich ein eigenes Attribut zu kreieren, und dieses als Klarnamenattribut zu verwenden. Hierzu einfach im Device global ein userattr hinzufügen. z.B.
attr global userattr T2F_alias
Jetzt stehen in allen Devices das Attribut T2F_alias zur Verfügung. Vorteil ist das dann auch wieder RegExp verwendet werden können. Im oberen Beispiel müsste dann dass rot markierte "alias" durch "T2F_alias" ersetzt werden.

=== Konfiguration innerhalb der Geräte ===
Neben der Identifikation der Geräte über die vorhandenen FHEM-Attribute (z.B. room, alias, ...) kann eine alternative Konfiguration auch über eigens für Talk2Fhem angelegte Attribute erfolgen. Die hierfür notwendigen Grundlagen und einige Beispiele sollen im Folgenden beschrieben werden.

==== Grundlagen / Voraussetzungen ====
1. Anlegen der notwendigen userattr am global-Device:

Erweiterung des Attributes userattr des Gerätes global um folgende Einträge:
T2F_places:textField-long T2F_properties:textField-long T2F_rooms:textField-long T2F_types_color:textField-long T2F_types_heating:textField-long T2F_types_info:textField-long T2F_types_switch:textField-long

2. Optional: Hilfsfunktionen für das automatische Füllen der T2F_keywordlist im talk-Device bei Änderung eines T2F-Attributes eines Gerätes

2a. erstellen einer sub in der 99_myUtils.pm:

<syntaxhighlight lang="perl"> sub fill_T2F_keywordlist
{
my ($name, $t2f_device) = @_;
$name =~ s/T2F_//g;
if ($name eq 'userattr')
{
return;
}
Log 0, "List: ".$name;
my $currentAttr = AttrVal($t2f_device,"T2F_keywordlist","");
my @currentAttrParts = split(/$name = /, $currentAttr);
my $currentAttrBeg = @currentAttrParts[0];
$currentAttrBeg = substr($currentAttrBeg, 0, -1);
my @currentAttrEnd = split(/\n/, @currentAttrParts[1], 2);
my @array = devspec2array('a:T2F_'.$name.'=.+');
my @attributes = ();
if (@array > 0 and defined($defs{$array[0]}))
{
foreach (@array){
my @attrVals = split(/\n/,AttrVal($_, 'T2F_'.$name, ''));
foreach (@attrVals){
my $attrVal = $_;
$attrVal =~ s/ / /g;
$attrVal =~ s/ => /=>/g;
my @attrValParts = split(/=>/,$attrVal);
$attrVal = @attrValParts[0];
$attrVal =~ s/!//g;
$attrVal =~ s/, /,/g;
my @attr = split(/,/, $attrVal);
push(@attributes, @attr);
}
}
}
my %hash = map { $_ => 1 } @attributes;
my @unique = keys %hash;
my $result = $currentAttrBeg."\n".$name." = ".join(", ", @unique)."\n".@currentAttrEnd[1];
$result =~ s/\n\n/\n/g;
$result =~ s/ / /g;
fhem('attr '.$t2f_device.' T2F_keywordlist '.$result);
}</syntaxhighlight>

2b. Erstellen eines DOIFs zum Aufruf der sub:

defmod talk.DI.fillAttr DOIF ([global:"^ATTR.*T2F_.*"]) ({my $val = ReadingsVal("$SELF", "e_global_events", ""); $val =~ m/(\S*) (\S*) (\S*) (.*)/; if ($2 ne 'talk' && $2 ne 'global') { fill_T2F_keywordlist("$3", "talk");}})
attr talk.DI.fillAttr do always

3. Optional: Erlauben von Umlauten in den T2F-Attributen:

attr talk T2F_disableumlautescaping 1

Nun können die T2F-Attribute pro FHEM-Device definiert und dann in den Talk2Fhem-Befehlen benutzt werden. Wurde der Punkt 2 abgearbeitet, so werden mit dem Füllen der Attribute am Geräte auch die Keywordlisten am talk-Device gefüllt. Wie diese dann verwendet werden können, sollen die folgenden Beispiele zeigen.

==== Schalten von Geräten ====

Ausgangssituation: Es gibt drei Lampen Lampe1, Lampe2, Lampe3 und ein Nachtlicht mit einer Eule mit folgenden Attributen:

attr Lampe1 T2F_types_switch Lampe, !Licht
attr Lampe1 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe1 T2F_places Decke, Tür
attr Lampe1 T2F_properties hell,!

attr Lampe2 T2F_types_switch Lampe, !Licht
attr Lampe2 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe2 T2F_places Tisch, Esstisch
attr Lampe2 T2F_properties dunkel,schwach,!

attr Lampe3 T2F_types_switch Lampe, !Licht
attr Lampe3 T2F_rooms Haus, Obergeschoss, !Küche
attr Lampe3 T2F_places Besenschrank

attr Nachtlicht T2F_types_switch Lampe, !Licht, Eule, Nachtlicht
attr Nachtlicht T2F_rooms Haus, Obergeschoss, !Kinderschlafzimmer
attr Nachtlicht T2F_places Steckdose

Durch die in Punkt 2 der Voraussetzungen genannten Funktionen wurden folgende T2F-keywordlisten automatisch angelegt:

attr talk T2F_keywordlist rooms = Kinderschlafzimmer, Haus, Küche, Obergeschoss, Esszimmer
places = Tür, Steckdose, Tisch, Decke, Esstisch
properties = hell, dunkel, schwach
types_switch = Lampe, Licht, Eule

Die Definition für das T2F-Device lautet dann wie folgt:

# 1 2 3 4 5 6 7
?(bitte) && ?(@properties) && (@types_switch) && ?(@rooms) && ?(@places) && (\S+)(schalten|machen)?$ =
(cmd=>'set T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.* $6{true=>on, false=>off}',
answer=>'"$AGAIN" ? "dann $DATE wieder $6{true=>ein, false=>aus}" : "$1{/bitte/=>Gern, else=>Das heißt Bitte}, ich schalte $1{/bitte/=>, else=>trotzdem} folgende Geräte $6{true=>ein, false=>aus}: ".T2F_answer("T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.*","T2F_types_switch")')

Damit sind dann die folgenden Sprachbefehle möglich:

Schalte das Licht in der Küche ein => schaltet Lampe3 ein

Schalte die helle Lampe im Esszimmer an => schaltet Lampe1 ein

Schalte das Licht im Esszimmer über dem Esstisch ein => schaltet Lampe2 ein

Schalte die Eule ein => schaltet Nachtlicht ein

Schalte das Licht im Esszimmer aus} => schaltet Lampe1 und Lampe2 aus

Schalte das Licht aus => schaltet alle vier Lichter aus

Um in der Antwort die Liste der geschalteten Geräte genannt zu bekommen, wird die sub T2F_answer aus der 99_myUtils aufgerufen:

<syntaxhighlight lang="perl"> sub T2F_answer
{
my ($filter, $type) = @_;
my $answer;
my @devices = devspec2array($filter);
if (@devices > 0 and defined($defs{$devices[0]}))
{
#$answer = "Ich habe folgende Geräte ".$command.": ";
foreach (@devices){
$answer = $answer."\n";
my $devAttr = AttrVal($_, $type, '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_properties', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_rooms', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_places', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}
}
}
return $answer."\n";
}
</syntaxhighlight>
Die Benennung der Geräte erfolgt auf Basis derer T2F-Attribute: Typ, Eigenschaft, Raum, Ort. Ist das jeweilige Attribut leer, ist es auch in der Antwort leer. Enthält die jeweilige Attributliste ein Ausrufezeichen (!), so wird der Eintrag nach dem Ausrufezeichen für die Antwort verwendet (z.B. Esszimmer als Raum). Steht das Ausrufezeichen am Ende, so wird der Eintrag in der Antwort leer gelassen (z.B. die Eigenschaft bei Lampe1). Ist kein Ausrufezeichen vorhanden, so wird der erste Eintrag verwendet.

==== Einstellen der Heizung ====

Das gleiche Prinzp wie bei den Lampen kann auch für die Einstellung der Heizung verwendet werden.

Ausgangssituation: In der Küche, im Kinderschlafzimmer und im Esszimmer gibt es jeweils eine Heizung (Homematic HM-CC-RT-DN) mit folgenden Attributen:

attr HeizungEsszimmer T2F_places Heizung,!
attr HeizungEsszimmer T2F_rooms Haus,Obergeschoss,Essbereich,!Esszimmer
attr HeizungEsszimmer T2F_types_heating Heizung,Temperatur,Esszimmer,Essbereich,!

attr HeizungKüche T2F_places Heizung,!
attr HeizungKüche T2F_rooms Haus,Obergeschoss,Essbereich,!Küche
attr HeizungKüche T2F_types_heating Heizung,Temperatur,Küche,Essbereich,!

attr HeizungKiSchla T2F_places Heizung,!
attr HeizungKiSchla T2F_rooms Haus,Obergeschoss,!Kinderschlafzimmer
attr HeizungKiSchla T2F_types_heating Heizung,Temperatur,Kinderschlafzimmer,!

Mit der T2F-Definition

# 1 2 3 4 5
?(bitte) && (@types_heating) && ?(@rooms) && (auf (\d+) grad|auto\S*)( stellen| setzen| einstellen| ein)?$ =
(cmd=>'set T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.* $5{integer=>desired-temp $5, else=>controlMode auto}',
answer=>'"$AGAIN" ? "dann $DATE wieder auf Automatik" : "Die Durchschnittstemperatur beträgt dort zur Zeit ".averageTemp("T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.*")." Grad\n$1{/bitte/=>Gern, else=>Das heißt Bitte}, ich stelle die Heizung in folgenden Räumen auf $5{integer=>$5 Grad, else=>Automatik}: ".T2F_answer("T2F_types_heating=.*$2{empty=>.+, else=>$2@}.*:FILTER=T2F_rooms=.*$3@.*","T2F_types_heating")')

funktionieren folgende Sprachbefehle:

Bitte stell die Heizung im Esszimmer auf 21 Grad => Stellt die Heizung im Esszimmer auf 21 Grad

Bitte stell die Heizung im Essbereich auf 21 Grad => Stellt die Heizungen im Esszimmer und in der Küche auf 21 Grad

Bitte stell die Heizung im Obergeschoss auf Automatik => Stellt die drei Heizungen auf Automatik

Dadurch, dass im Attribut T2F_types_heating auch die Räume aufgeführt sind, sind auch Befehle in folgender Form möglich:

Bitte stell die Küche auf 21 Grad => Stellt die Heizung in der Küche auf 21 Grad

Auch kann in diesem (wie auch in den oben aufgeführten Schaltbefehlen) mit "wieder" gearbeitet werden:

Bitte stell die Heizung im Essbereich auf 21 Grad und in 2 Stunden wieder auf Automatik

Für die Generierung der Antwort wird neben der bei den Schaltbefehlen bereits gezeigten sub T2F_answer eine weiter Funktion verwende, welche die Durchschnittstemperatur im zu schaltenden Bereich ermittelt und ausgibt:

<syntaxhighlight lang="perl">
sub averageTemp($)
{
my ($filter) = @_;
my @tempDevices = devspec2array($filter);
my $count = 0;
my $measuredTemp = 0;
if (@tempDevices > 0 and defined($defs{$tempDevices[0]})){
foreach (@tempDevices){
$measuredTemp = $measuredTemp + ReadingsVal($_, "measured-temp", "");
$count = $count + 1;
}
return $measuredTemp / $count;
}
return 0;
}
</syntaxhighlight>

==== Einstellen der Farbe von Farbwechsellampen (Philips Hue, Wifilight, ...) ====

Für das Beispiel zum Einstellen der Lichtfarbe nehmen wir eine Farbwechsellampe LampeBunt an, welche den Befehl RGB unterstützt. Diese erhält folgende Attribute:

attr LampeBunt T2F_places Decke,Couch,Sofa
attr LampeBunt T2F_rooms Haus,Dachgeschoss,!Wohnzimmer
attr LampeBunt T2F_types_color Lampe,Licht
attr LampeBunt T2F_types_switch Lampe,Licht

Durch das Attribut T2F_types_switch lässt sich diese über die bereits beschriebene Schaltlogik ein und ausschalten. Durch die zusätzlich T2F-Definition

# 1 2 3 4 5 6
?(bitte) && (@types_color) && ?(@rooms) && ?(@places) && auf (@colors)( schalten| stellen)?$ =
(cmd=>'set T2F_types_color=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_places=.*$4@.* RGB $5[@rgb]',
answer=>'"Ich schalte folgende Geräte auf $5@: ".T2F_answer("T2F_types_color=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_places=.*$4@.*","T2F_types_color")')

und die entsprechenden Attribute am T2F-Device talk (HINWEIS: eigene Listen können Problemlos ergänzt werden, diese werden durch die Hilfsfunktionen NICHT überschrieben)

attr talk T2F_keywordlist colors = Aus, Schwarz, Dunkles Schiefergrau, Schiefergrau, Helles Schiefergrau, Helles Stahlblau, Mattes Grau, Grau, Dunkelgrau, Silber, Hellgrau, Gainsboro, Rauchiges Weiß, Geisterweiß, Weiß, Schneeweiß, Elfenbein, Blütenweiß, Muschel, Altgold, Leinenfarbe, Antikes Weiß, Mandelweiß, Cremiges Papaya, Beige, Mais, Helles Goldrutengelb, Hellgelb, Chiffongelb, Blasse Goldrutenfarbe, Khaki, Gelb, Gold, Orange, Dunkles Orange, Goldrute, dunkle Goldrutenfarbe, Peru, Schokolade, Sattelbraun, Ocker, Braun, Dunkelrot, Kastanienbraun, Ziegelfarbe, Indischrot, Karmesinrot, Rot, Orangenrot, Tomatenrot, Koralle, Lachs, Helles Korallenrot, Dunkle Lachsfarbe, Helle Lachsfarbe, Sandbraun, Rosiges Braun, Gelbbraun, Grobes Braun, Weizen, Pfirsich, Navajoweiß, Tomatencreme, Rosige Lavenderfarbe, Altrosa, Rosa, Hellrosa, Leuchtendes Rosa, Fuchsie, Magentarot, Tiefrosa, Mittleres Violettrot, Blasses Violettrot, Pflaume, Distel, Lavendelfarbe, Violett, Orchidee, Dunkles Magentarot, Violett, Indigo, Blauviolett, Dunkles Violett, Dunkle Orchideenfarbe, Mittleres Violett, Mittlere Orchideenfarbe, Mittleres Schieferblau, Schieferblau, Dunkles Schieferblau, Mitternachtsblau, Marineblau, Dunkelblau, Mittelblau, Blau, Königsblau, Stahlblau, Kornblumenblau, Dodger-Blau, Tiefes Himmelblau, Helles Himmelblau, Himmelblau, Hellblau, Zyanblau, Blaugrün, Taubenblau, Helles Cyanblau, Aliceblau, Himmelblau, Cremig Pfefferminz, Honigmelone, Aquamarinblau, Türkis, Blasses Türkis, Mittleres Türkis, Dunkles Türkis, Mittleres Aquamarinblau, Helles Seegrün, Dunkles Zyanblau, Entenbraun, Kadettblau, Mittleres Seegrün, Dunkles Seegrün, Hellgrün, Blassgrün, Mittleres Frühlingsgrün, Frühlingsgrün, Zitronengrün, Gelbgrün, Seegrün, Waldgrün, Grün, Dunkelgrün, Olivfarbiges Graubraun, Dunkles Olivgrün, Olivgrün, Dunkles Khaki, Gelbgrün, Hellgrün, Grüngelb

attr talk T2F_modwordlist rgb = 000000, 000000, 8FBC8F, 708090, 778899, B0C4DE, 696969, 808080, A9A9A9, C0C0C0, D3D3D3, DCDCDC, F5F5F5, F8F8FF, FFFFFF, FFFAFA, FFFFF0, FFFAF0, FFF5EE, FDF5E6, FAF0E6, FAEBD7, FFEBCD, FFEFD5, F5F5DC, FFF8DC, FAFAD2, FFFFE0, FFFACD, EEE8AA, F0E68C, FFFF00, FFD700, FFA500, FF8C00, DAA520, B8860B, CD853F, D2691E, 8B4513, A0522D, A52A2A, 8B0000, 800000, B22222, CD5C5C, DC143C, FF0000, FF4500, FF6347, FF7F50, FA8072, F08080, E9967A, FFA07A, F4A460, BC8F8F, D2B48C, DEB887, F5DEB3, FFDAB9, FFDEAD, FFE4C4, FFF0F5, FFE4E1, FFC0CB, FFB6C1, FF69B4, FF00FF, FF00FF, FF1493, C71585, DB7093, DDA0DD, D8BFD8, E6E6FA, EE82EE, DA70D6, 8B008B, 800080, 4B0082, 8A2BE2, 9400D3, 9932CC, 9370DB, BA55D3, 7B68EE, 6A5ACD, 483D8B, 191970, 000080, 00008B, 0000CD, 0000FF, 4169E1, 4682B4, 6495ED, 1E90FF, 00BFFF, 87CEFA, 87CEEB, ADD8E6, 00FFFF, 00FFFF, B0E0E6, E0FFFF, A0CE00, F0FFFF, F5FFFA, F0FFF0, 7FFFD4, 40E0D0, AFEEEE, 48D1CC, 00CED1, 66CDAA, 20B2AA, 008B8B, 008080, 5F9EA0, 3CB371, 8FBC8F, 90EE90, 98FB98, 00FA9A, 00FF7F, 00FF00, 32CD32, 2E8B57, 228B22, 008000, 006400, 6B8E23, 556B2F, 808000, BDB76B, 9ACD32, 7FFF00, ADFF2F

kann die Farbe nun auch über folgenden Sprachbefehle eingestellt werden:

Bitte schalte die Lampe im Wohnzimmer an der Couch auf Olivfarbiges Graubraun

Dadurch, das die Liste colors den Wert "Aus" mit dem entsprechenden Wert "000000" in der Liste rgb enthält, kann die Lampe über die gleiche Logik auch ausgeschaltet werden:

Bitte schalte das Licht im Wohnzimmer auf Pflaume und in einer Stunde wieder aus

==== Abfragen beliebiger Geräteinformationen ====

Das folgende Beispiel zeigt die Möglichkeit auf, die Antworten für Statusabfragen direkt am abgefragten Gerät zu definieren. Hierfür werden zunächst eine Definition am T2F-Device

# 1 2 3 4
Wie && ?(@properties)&& (@types_info) && ?(@rooms) && ?(@places) =
(answer=>'T2F_getInfo("T2F_types_info=.*$2@.*:FILTER=T2F_rooms=.*$3@.*:FILTER=T2F_properties=.*$1@.*:FILTER=T2F_places=.*$4@.*","$2@")')

und eine Funktion in der 99_myUtils

<syntaxhighlight lang="perl">
sub T2F_getInfo
{
my ($filter,$info) = @_;
my @devices = devspec2array($filter);
if (@devices > 0 and defined($defs{$devices[0]}))
{
if (@devices > 1)
{
return "Ich habe mehr als ein Gerät gefunden, die Information kann nicht abgerufen werden.";
}

my $answer = "Die Abfrage von ".$info." für ";

my $devAttr = AttrVal($_, 'T2F_properties', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_rooms', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_places', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

my @attrVals = split(/\n/,AttrVal(@devices[0], 'T2F_types_info', ''));
foreach (@attrVals){
my $attrVal = $_;
$attrVal =~ s/ / /g;
$attrVal =~ s/ => /=>/g;
my @attrValParts = split(/=>/,$attrVal);
if (@attrValParts[0] =~ /$info/)
{
my $cmd = "'".@attrValParts[1]."'";
$cmd =~ s/ #/ '.ReadingsVal('@devices[0]', '/g;
$cmd =~ s/#/', '').'/g;
return eval($cmd);
}
}
}
}
</syntaxhighlight>

Die Konfiguration und Funktionsweise sind nun wie folgt: Das Gerät, dessen Status abgefragt werden sollen erhält neben den Oben bereits beschriebenen Attributen für Eigenschaft, Raum und Ort noch das Attribut T2F_types_info, welches Zeilenweise die abzufragenen Status in der folgenden Form enthält:

abfragewert => Das ist die Antwort mit den Wert #reading#

Mit der Form #reading# können die Werte von Readings des abgefragten Device zum Zeitpunkt der Abfrage ermittelt werden. Für das Beispiel einer Heizung im Esszimmer wäre das zum Beispiel wie folgt möglich:

attr HeizungEsszimmer T2F_places Heizung,!
attr HeizungEsszimmer T2F_rooms Haus,Obergeschoss,Essbereich,!Esszimmer
attr HeizungEsszimmer T2F_types_info warm,Temperatur => Die Temperatur beträgt #measured-temp# Grad und soll #desired-temp# Grad erreichen\
Ventilstellung => Das Ventil ist #ValvePosition# Prozent geöffnet

Damit sind dann folgende Abfragen möglich:

Wie warm ist die Heizung im Esszimmer?

Wie ist die Temperatur der Heizung im Esszimmer?

Wie ist die Ventilstellung der Heizung im Esszimmer?

Anders als bei den anderen Beispielen, wo alle gefundenen Geräte geschaltet werden, muss die Abfrage hier so detailliert sein, dass nur ein Gerät gefunden wird.

== Häufig verwendete RegExp ==
Perl Regular Expression, also ein regulärer Ausdruck der Programmiersprache Perl, ist eine Werkzeug um Zeichenketten zu beschreiben. Hier wird ein kurzer Einblick auf die im Artikel häufig genutzten RegExp zu geben.

Eine Auflistung der Syntax kann hier eingesehen werden. [http://jkorpela.fi/perl/regexp.html]

{|class="wikitable"
! 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+){0,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 notify 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
<nowiki>https://user:password@dnsservice:54387/fhem?cmd.talk=set talk {{TextField}}&XHR=1</nowiki>
*Fertig

Jetzt wird der gesamte Text bei dem genannten Triggerworten an FHEM weitergeleitet.

== Ausgabemethoden ==

Siehe hierzu [[Modul_Talk2Fhem#Beispiel|Anwendungsbeispiel]]

Talk2Fhem

2018-01-28T07:54:02Z

RoBra81: Neue Beispiele

{{Infobox Modul
|ModPurpose=Das Modul stellt eine Verbindung zwischen natürlicher Sprache und FHEM Befehlen her
|ModType=h]
|ModCmdRef=Talk2Fhem
|ModForumArea=Unterstützende Dienste
|ModTechName=39_Talk2Fhem.pm
|ModOwner=Oliver Georgi
}}

Diese Seite beschreibt die Funktionsweise und Konfiguration des Moduls 39_Talk2Fhem.pm

== Voraussetzungen ==
[[Datei:ModulTalk2FhemScreenshot.png|360px|thumb|right]]
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 [[Konfiguration#Syntaxhervorhebung|hier]] 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|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. [https://forum.fhem.de/index.php/topic,80960.0.html]

== 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 dessen Rückgabe in in das Reading '''fhem''' geschrieben wird.

Die Antworten und Modulinterne Fehler werden in den Readings '''answers''' und '''err''' ausgegben.

Das Reading '''status''' wird jedes mal gesetzt und erhält Werte nach folgender Priorität.
{|class="wikitable"
|1.||'''response''' ||wenn das FHEM Kommando eine Meldung ausgegeben hat
|-
|2.||'''disabled''' ||wenn das Attribute disable auf 1 steht
|-
|3.||'''err''' ||wenn der Sprachbefehl einen Fehler zurückgegeben hat
|-
|4.||'''answer''' ||wenn der Sprachbefehl eine Antwort ausgegeben hat
|-
|5.||'''done''' ||wenn keines der oberen Fälle eingetreten ist, also alles gut verlaufen ist
|}

=== 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
<syntaxhighlight lang="perl">
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");
}

}
</syntaxhighlight>

=== 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'''
<syntaxhighlight lang='perl'>dusche\S?$ = (offset=>-3600, cmd=>'set d_log bad warm')</syntaxhighlight>
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.

{{Randnotiz|RNText=Wichtig
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|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 ====
<hr>

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>
*''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 ====
<hr>

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 ]
 |------------------> 0 1 2 3
''(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
( @keywordlist )
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 an selber Position 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:
*cmd => 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 ====
<syntaxhighlight lang="perl">tu was = ( cmd => "set tue es" , answer => '"Erledigt"' )</syntaxhighlight>
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 ====
<syntaxhighlight lang="perl">wurde es getan = ( answer => 'Value("tue") eq "es" ? "Ja" : "Nein"')</syntaxhighlight>

==== Beispiel Temperaturabfragen ====
Eine einfache Temperaturabfrage könnte so aussehen.
<syntaxhighlight lang="perl">wie.*(kalt|warm|grad|temperatur) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("tempdev", "temperature", "Fehler")' )</syntaxhighlight>
Für eine Raumbezogene Temperaturabfrage, siehe [[Modul_Talk2Fhem#Anwendungsbeispiele_und_Vorlagen]]

== Attribute ==
Folgende Attribute werden zur Zeit unterstützt
=== T2F_keywordlist ===
<Name> = <kommaseparierte Liste mit RegExp>
'''Beispiele'''
rooms = haus|überall|wohnung , wohnzimmer , bad\S* , toilette|wc , büro , ...
names = Mama , Papa , Kevin , Jacqueline
channels = ard|das erste , zdf , rtl , sat 1 , vox , rtl2 , prosieben , kabel eins , arte
Man beachte hier die möglichkeit der RegExp 
Das Schlüsselwort '''haus''' löst das selbe aus wie '''überall''' und '''wohnung'''
 Genauso '''bad''' oder '''badezimmer''' oder '''badeirgendewas'''

=== T2F_modwordlist ===
<Name> = <kommaseparierte Liste mir RegExp>
Die Positionen der gewählten Geräte, ist eine Zuordnung zu den Listen in''T2F_keywordlist''
 Wenn Wohnzimmer in der keywordliste <rooms> an Position 2 steht muss der Rolladenaktor in der modworliste <roll> auch an Position 2 stehen.
roll = rollos_alle , d_rollo_wz , hm_roll_bad.* , hm_roll_wc , hm_roll_buero.* , ...
lights = alle_lichte , '''"sw_wz1,sw_wz2"''' , sw_bad.* , sw_wc
Sollen einem Schlüsselwort mehrere Aktoren zugeordnet werden, geht das über sogenannte "Quotes". (Anführungszeichen) Siehe <lights>.
"a,b" oder 'a,b' oder a\,b

=== T2F_disableumlautescaping ===

Deaktiviert das Konvertieren der Umlaute innnerhalb von regulären Ausdrücken in '''\S\S?'''

=== 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. Hierzu sind die entsprechenden Stellen rot markiert.
=== Keywordlist ===
Eine typische Keywordlist wäre eine Auflistung der benötigten Räume
rooms = haus|überall|wohnung,wohnzimmer,esszimmer,bad\S*,toilette|wc,
büro,schlafzimmer,ankleide|garderobe,kinderzimmer,spielzimmer,
flur|gang|diele,garage,garten,terrasse,balkon,
eg|erdgescho\S*,og|obergescho\S*,\S*auße\S*( haus)?|vor der tür

=== Einfaches schalten ===
licht (\S+) = set dev_light $1{ true => on, false => off }
=== Einfaches schalten mit eigenen Wörtern ===
Will man neben an/aus einen weiteren Zustand selbst definieren, kann das so geschehen.
garage (\S+) = set dev_gate $1{ /kurz/ => open-for-time 5, true => open, false => close }

=== Einfaches schalten mit Räumen ===
licht (\S+ ){0,2} (wohnzimmer|esszimmer|küche|terrasse) (\S+) = set $2[light_wz,light_ez,light_kitchen,light_outside] $3{ true => on, false => off }
Bei größeren Mengen an Räumen und Geräten bietet sich das anlegen von Keyword- und Modwordlisten an.
licht (\S+ ){0,2} (@rooms) (\S+) = set $2[@lights] $3{ true => on, false => off }

=== Rolladen fahren ===
Sind die Rollläden innerhalb von FHEM über das Attribut "room" den Räumen mit Klarnamen zugeordnet, lässt sich das ganze am einfachsten konfigurieren. 
'''1. nach Devicetyp'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=a:subType=blindActuator $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Wenn das Device vom subTyp "blindActuator" ist (HomeMatic Rolladenactor) und es im Raum $3 ist, wird dieses Device gefahren. Die Funktion ucfirst ist notwendig damit der erste Buchstabe groß geschrieben wird.

'''2. nach Devicenamen'''
rolll?(os?|\S\S?den) ?(\S+ ){0,2}(\S+) (auf )?(\S+) = {fhem('set room='.ucfirst('$3').':FILTER=rollo.* $5{true=>on, false=>off, integer=>'set_$5')}

'''Erklärung''' 
Gleiche wie oben, nur das alle Devices die mit rollo beginnen im Raum $3 gefahren werden. (rollo.*)

'''3. nach Benutzerdefinierten Räumen''' 
Ansonsten müssen wir dem Modul sagen in welchem Raum welches Device sitzt. Das hat dafür den Vorteil das die Räume als RegExp angegeben werden können. Wir erzeugen eine Modwordlist ''rollos'' in der wir alle Rollladen "Devices" auflisten. Die Reihenfolge ist an der Keywordlist "rooms" ([[Modul_Talk2Fhem#Keywordlist]]) anzupassen.
rollos = r_alle,r_wz,r_ez,,r_buero,...
 '''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

=== GoogleCast Befehle ===
Etwas bessere Lautstärkebefehle als die von Google.
Die Lautstärken müssten noch dem eigenen Geschmack angepasst werden
#GoogleCast Commandos
leise$ = set googlecastdevice volume 14
normale lautstärke = set googlecastdevice volume 20
laut$ = set googlecastdevice volume 30
(ein wenig|etwas|viel)? ?(lauter|leiser) = { fhem("set googlecastdevice volume ".(ReadingsVal("googlecastdevice","volume", 0)$2[+,-]$1[3,5,10,empty,7])) }
''' Beispielsätze '''
Mach leise
Mach lauter
Mach etwas leiser
Mach viel lauter

=== Talk Timer zurücksetzen ===
Sollen alle von Talk2Fhem angelegten Timer gelöscht werden.
(timer|kommandos) (löschen|zurücksetzen) = delete at_talk.*
'''Beispielsätze'''
bitte alle timer zurücksetzen
zukünftige kommandos löschen

=== Frage Antwort ===
==== Raumbezogene Temperaturansage ====
Wir erzeugen wieder unsere Modwordlist sagen wir @sens gefüllt mit den Temperaturfühler "Devices". Reihenfolge wie immer die der Keywordlist @rooms.
wie.*(kalt|warm|grad|temperatur).*(@rooms) = ( answer => '"Die Temperatur beträgt ".ReadingsVal("$2[@sens]", "temperature", "unbekannt")." grad"' )
'''Beispielsätze'''
wie warm ist es im Wohnzimmer
wie ist die Temperatur in der Küche
wie kalt ist es draußen

==== Multiple Antworten ====
Hallo Haus = ( answer => '["Hallo auch!","Guten Tag!","Ahoi!"]->[rand(3)]' )
Wählt zufällig eine der drei Aussagen.

==== Ausgabe eines oder mehrerer Zustände ====
Angenommen man möchte wissen ob das Haus abgeschlossen ist. Und in FHEM existiert ein Dummy der diesen Zustand wiederspiegelt und im Reading text die offenen Fenster und Türen aufgelistet sind. Kann man folgendermaßen den Status erfragen
(alles|das haus) (zu|abgeschlossen) = (
answer => '(Value("d_schliessung") eq "zu")
? "Es ist alles zu"
: "Nein, offen sind: ".ReadingsVal("d_schliessung","text","")'

==== Zustandsabfrage anhand des Aliasnamen ====
Möchte man alle Geräte anhand seines Attribut "alias" ansprechen, um dessen Status zu erfragen, könnte das so erfolgen.
 '''Definition'''
(zustand|status) (\S+)* (\S+) = (answer=>'my $s=Value((grep { "$3" =~ /$attr{$_}{alias}/i } (keys %attr))[0]);; "Der Status ist ".$s if $s')
'''Beispielsätze'''
Wie ist der Zustand der Lüftung
sag mir den Status der Haustür
Es ist auch möglich ein eigenes Attribut zu kreieren, und dieses als Klarnamenattribut zu verwenden. Hierzu einfach im Device global ein userattr hinzufügen. z.B.
attr global userattr T2F_alias
Jetzt stehen in allen Devices das Attribut T2F_alias zur Verfügung. Vorteil ist das dann auch wieder RegExp verwendet werden können. Im oberen Beispiel müsste dann dass rot markierte "alias" durch "T2F_alias" ersetzt werden.

=== Konfiguration innerhalb der Geräte ===
Neben der Identifikation der Geräte über die vorhandenen FHEM-Attribute (z.B. room, alias, ...) kann eine alternative Konfiguration auch über eigens für Talk2Fhem angelegte Attribute erfolgen. Die hierfür notwendigen Grundlagen und einige Beispiele sollen im Folgenden beschrieben werden.

==== Grundlagen / Voraussetzungen ====
1. Anlegen der notwendigen userattr am global-Device:

Erweiterung des Attributes userattr des Gerätes global um folgende Einträge:
T2F_places:textField-long T2F_properties:textField-long T2F_rooms:textField-long T2F_types_color:textField-long T2F_types_heating:textField-long T2F_types_info:textField-long T2F_types_switch:textField-long

2. Optional: Hilfsfunktionen für das automatische Füllen der T2F_keywordlist im talk-Device bei Änderung eines T2F-Attributes eines Gerätes

2a. erstellen einer sub in der 99_myUtils.pm:

sub fill_T2F_keywordlist
{
my ($name, $t2f_device) = @_;
$name =~ s/T2F_//g;
if ($name eq 'userattr')
{
return;
}
Log 0, "List: ".$name;
my $currentAttr = AttrVal($t2f_device,"T2F_keywordlist","");
my @currentAttrParts = split(/$name = /, $currentAttr);
my $currentAttrBeg = @currentAttrParts[0];
$currentAttrBeg = substr($currentAttrBeg, 0, -1);
my @currentAttrEnd = split(/\n/, @currentAttrParts[1], 2);
my @array = devspec2array('a:T2F_'.$name.'=.+');
my @attributes = ();
if (@array > 0 and defined($defs{$array[0]}))
{
foreach (@array){
my @attrVals = split(/\n/,AttrVal($_, 'T2F_'.$name, ''));
foreach (@attrVals){
my $attrVal = $_;
$attrVal =~ s/ / /g;
$attrVal =~ s/ => /=>/g;
my @attrValParts = split(/=>/,$attrVal);
$attrVal = @attrValParts[0];
$attrVal =~ s/!//g;
$attrVal =~ s/, /,/g;
my @attr = split(/,/, $attrVal);
push(@attributes, @attr);
}
}
}
my %hash = map { $_ => 1 } @attributes;
my @unique = keys %hash;
my $result = $currentAttrBeg."\n".$name." = ".join(", ", @unique)."\n".@currentAttrEnd[1];
$result =~ s/\n\n/\n/g;
$result =~ s/ / /g;
fhem('attr '.$t2f_device.' T2F_keywordlist '.$result);
}

2b. Erstellen eines DOIFs zum Aufruf der sub:

defmod talk.DI.fillAttr DOIF ([global:"^ATTR.*T2F_.*"]) ({my $val = ReadingsVal("$SELF", "e_global_events", ""); $val =~ m/(\S*) (\S*) (\S*) (.*)/; if ($2 ne 'talk' && $2 ne 'global') { fill_T2F_keywordlist("$3", "talk");}})
attr talk.DI.fillAttr do always

3. Optional: Erlauben von Umlauten in den T2F-Attributen:

attr talk T2F_disableumlautescaping 1

Nun können die T2F-Attribute pro FHEM-Device definiert und dann in den Talk2Fhem-Befehlen benutzt werden. Wurde der Punkt 2 abgearbeitet, so werden mit dem Füllen der Attribute am Geräte auch die Keywordlisten am talk-Device gefüllt. Wie diese dann verwendet werden können, sollen die folgenden Beispiele zeigen.

==== Schalten von Geräten ====

Ausgangssituation: Es gibt drei Lampen Lampe1, Lampe2, Lampe3 und ein Nachtlicht mit einer Eule mit folgenden Attributen:

attr Lampe1 T2F_types_switch Lampe, !Licht
attr Lampe1 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe1 T2F_places Decke, Tür
attr Lampe1 T2F_properties hell,!

attr Lampe2 T2F_types_switch Lampe, !Licht
attr Lampe2 T2F_rooms Haus, Obergeschoss, !Esszimmer
attr Lampe2 T2F_places Tisch, Esstisch
attr Lampe2 T2F_properties dunkel,schwach,!

attr Lampe3 T2F_types_switch Lampe, !Licht
attr Lampe3 T2F_rooms Haus, Obergeschoss, !Küche
attr Lampe3 T2F_places Besenschrank

attr Nachtlicht T2F_types_switch Lampe, !Licht, Eule, Nachtlicht
attr Nachtlicht T2F_rooms Haus, Obergeschoss, !Kinderschlafzimmer
attr Nachtlicht T2F_places Steckdose

Durch die in Punkt 2 der Voraussetzungen genannten Funktionen wurden folgende T2F-keywordlisten automatisch angelegt:

attr talk T2F_keywordlist rooms = Kinderschlafzimmer, Haus, Küche, Obergeschoss, Esszimmer
places = Tür, Steckdose, Tisch, Decke, Esstisch
properties = hell, dunkel, schwach
types_switch = Lampe, Licht, Eule

Die Definition für das T2F-Device lautet dann wie folgt:

# 1 2 3 4 5 6 7
?(bitte) && ?(@properties) && (@types_switch) && ?(@rooms) && ?(@places) && (\S+)(schalten|machen)?$ =
(cmd=>'set T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.* $6{true=>on, false=>off}',
answer=>'"$AGAIN" ? "dann $DATE wieder $6{true=>ein, false=>aus}" : "$1{/bitte/=>Gern, else=>Das heißt Bitte}, ich schalte $1{/bitte/=>, else=>trotzdem} folgende Geräte $6{true=>ein, false=>aus}: ".T2F_answer("T2F_types_switch=.*$3@.*:FILTER=T2F_rooms=.*$4@.*:FILTER=T2F_properties=.*$2@.*:FILTER=T2F_places=.*$5@.*","T2F_types_switch")')

Damit sind dann die folgenden Sprachbefehle möglich:

Schalte das Licht in der Küche ein => schaltet Lampe3 ein

Schalte die helle Lampe im Esszimmer an => schaltet Lampe1 ein

Schalte das Licht im Esszimmer über dem Esstisch ein => schaltet Lampe2 ein

Schalte die Eule ein => schaltet Nachtlicht ein

Schalte das Licht im Esszimmer aus} => schaltet Lampe1 und Lampe2 aus

Schalte das Licht aus => schaltet alle vier Lichter aus

Um in der Antwort die Liste der geschalteten Geräte genannt zu bekommen, wird die sub T2F_answer aus der 99_myUtils aufgerufen:

sub T2F_answer
{
my ($filter, $type) = @_;
my $answer;
my @devices = devspec2array($filter);
if (@devices > 0 and defined($defs{$devices[0]}))
{
#$answer = "Ich habe folgende Geräte ".$command.": ";
foreach (@devices){
$answer = $answer."\n";
my $devAttr = AttrVal($_, $type, '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_properties', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_rooms', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}

$devAttr = AttrVal($_, 'T2F_places', '');
if (substr($devAttr,-1) ne "!")
{
my @entries = split(/!/, $devAttr);
if (@entries < 2)
{
@entries = split(/,/, $entries[0]);
}
else
{
@entries = split(/,/, $entries[1]);
}
if (@entries[0] ne "")
{
$answer = $answer.@entries[0]." ";
}
}
}
}
return $answer."\n";
}

Die Benennung der Geräte erfolgt auf Basis derer T2F-Attribute: Typ, Eigenschaft, Raum, Ort. Ist das jeweilige Attribut leer, ist es auch in der Antwort leer. Enthält die jeweilige Attributliste ein Ausrufezeichen (!), so wird der Eintrag nach dem Ausrufezeichen für die Antwort verwendet (z.B. Esszimmer als Raum). Steht das Ausrufezeichen am Ende, so wird der Eintrag in der Antwort leer gelassen (z.B. die Eigenschaft bei Lampe1). Ist kein Ausrufezeichen vorhanden, so wird der erste Eintrag verwendet.

==== Einstellen der Heizung ====

==== Einstellen der Farbe von Farbwechsellampen (Philips Hue, Wifilight, ...) ====

==== Abfragen beliebiger Geräteinformationen ====

== Häufig verwendete RegExp ==
Perl Regular Expression, also ein regulärer Ausdruck der Programmiersprache Perl, ist eine Werkzeug um Zeichenketten zu beschreiben. Hier wird ein kurzer Einblick auf die im Artikel häufig genutzten RegExp zu geben.

Eine Auflistung der Syntax kann hier eingesehen werden. [http://jkorpela.fi/perl/regexp.html]

{|class="wikitable"
! 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+){0,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 notify 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
<nowiki>https://user:password@dnsservice:54387/fhem?cmd.talk=set talk {{TextField}}&XHR=1</nowiki>
*Fertig

Jetzt wird der gesamte Text bei dem genannten Triggerworten an FHEM weitergeleitet.

== Ausgabemethoden ==

Siehe hierzu [[Modul_Talk2Fhem#Beispiel|Anwendungsbeispiel]]

TALKTOME & TALKTOUSER - Sprachverarbeitung für Nutzerinteraktionen

2016-07-06T06:41:10Z

RoBra81:

<div style="float:right">{{Infobox Modul
|ModType=h
|ModPurpose=Anbindung von RiveScript an FHEM

|ModCmdRef=TALKTOME
|ModForumArea=Automatisierung
|ModTechName=42_TALKTOME.pm
|ModOwner=SirUli
}}
{{Infobox Modul
|Name=TALKTOUSER
|ModType=h
|ModPurpose=Nutzerverbindung zu TALKTOME

|ModCmdRef=TALKTOUSER
|ModForumArea=Automatisierung
|ModTechName=42_TALKTOUSER.pm
|ModOwner=SirUli
}}</div>

Mit Hilfe der Module TALKTOME & TALKTOUSER und der Sprache RiveScript ist es möglich, Chatbots - bekannt von Webseiten wie IKEA und co - für FHEM einzusetzen, um Frage-Antwort-Dialoge zu bauen.

== Features / Funktionen ==
Die Haupteigenschaften von XYZ sind
* Anbindung von RiveScript an fhem
* Abruf von Readings, ReadingTimestamps, Attributen
* Absetzen von fhem Befehlen oder Aufruf von perl Funktionen

== Hinweise zum Betrieb mit FHEM ==
=== Voraussetzungen ===
Die Einrichtung von msg - das macht mir das Antworten in die diversen Kanäle sehr viel einfacher.

Installation von RiveScript in der Version 2.0.1 (oder neuer, falls eine erscheinen sollte) via CPAN. ACHTUNG nicht via apt-get installieren, da die Version zu alt ist.

==== msg ====
Bei der ersten Verwendung des Befehls "msg" wird ein Device namens globalMsg angelegt, was man aber dem Modul vorweg nehmen kann:
<pre>
define globalMsg msgConfig
</pre>

Damit sind die Voraussetzungen schon geschaffen

==== Installation von RiveScript ====
Rufe cpan auf:
<source lang="bash">
cpan
</source>

Das sieht dann etwa so aus:
<source lang="bash">
sudo cpan
Loading internal null logger. Install Log::Log4perl for logging messages
Terminal does not support AddHistory.

cpan shell -- CPAN exploration and modules installation (v2.10)
Enter 'h' for help.

cpan[1]>
</source>

Installiere dann Rivescript mit Hilfe des folgenden Kommandos:
<source lang="bash">
install RiveScript
</source>

Falls Fragen aufkommen, ob man Abhängigkeiten folgen soll, dann bitte richtig beantworten (yes) ;)

=== Installation der Module ===
Geht wie immer:
<pre>
update all https://raw.githubusercontent.com/SirUli/FHEM-TALKTO/master/controls_talkto.txt
</pre>

Anschließend sollte man im Ordner FHEM drei zusätzliche Files (42_TALKTOME.pm, 42_TALKTOUSER.pm sowie TALKTOME.rive.template) finden. Letzteres benennt man nun um in TALKTOME.rive. An dieser Stelle darf man das File natürlich auch schon editieren - wenn man möchte und Rivescript versteht.

==== Definition ====
Dann geht es los mit der Definition des Chatbots an sich:
<pre>
define FHEMTALKTOME TALKTOME
</pre>

FHEMTALKTOME ist sozusagen nun der Bot, welcher zu Beginn noch deaktiviert ist. Bevor man diesen aktiviert, muss man den Pfad zum TALKTOME.rive File setzen. Ist dieses file im Ordner FHEM (sozusagen also wie Auslieferungszustand und oben beschrieben), so setzt man folgendes:

<pre>
attr FHEMTALKTOME rsbrainfile ./FHEM/TALKTOME.rive
</pre>

Dann kann man das Attribut "disable" entfernen. Für die Nutzerinteraktion kann man noch weitere Details eines Nutzer anlegen (derzeit nur den "richtigen" Namen), daher brauchen wir ein Benutzermodul, also z.B. für mich:

<pre>
define TALKTOUSER_ULI TALKTOUSER
</pre>

Bitte noch nicht wundern - derzeit ist das noch nicht voll ausgebaut, besser ihr legt erstmal nur ein Benutzergerät an.

Nun kommt der wichtigste Teil - die Einbindung einer Quelle. Bei mir ist das nun Telegram, welches nun zwei zusätzliche Attribute via userAttr bekommen muss:
<pre>
talktouserMonitorReading talktouserModSourceDev
</pre>

Was heissen die Attribute?

talktouserMonitorReading: Bezeichnet das Reading welches überwacht werden soll, im falle von Telegram ist dies auf "msgText" zu setzen
talktouserModSourceDev: Lässt eine Änderung des Quell Devices zu. So muss beispielsweise für Telegram, damit eine Antwort machbar ist, das Quelldevice verändert werden. Lokale Readings (also vom Quellverzeichnis) werden mit %%readingname%% angegeben, das device selbst ist %DEVICE%. Für Telegram muss beispielsweise %DEVICE%:@%%msgPeerId%% gesetzt werden, damit die Antworten ankommen

=== Wie legt man nun Dialoge an? ===
Dazu empfehle ich einmal durch das Tutorial ab den "First Steps" zu gehen und sich die Beispieldatei FHEM/TALKTOME.rive.template zu Gemüte zu führen. Diese bietet schon so kleinigkeiten wie "Wie heisst du" als Fragen oder die Frage nach dem Wetter (Geräte eben entsprechend austauschen!) oder den Raumtemperaturen.

Zusätzlich:
Readings lassen sich per <pre><call>readingsval BK_Wetter fc1_low_c Error</call></pre> auslesen

Readings Timestamps lassen sich per <pre><call>readingstimestamp LR_Wandthermostat temperature Error</call></pre> auslesen

Attribute lassen sich per <pre><call>attrval BK_Wetter fc1_low_c Error</call></pre> auslesen

FHEM Kommandos kann man so ausführen:<pre> <call>fhem set KU_SWITCH_COFFEE_Sw on</call></pre>

Perl Methoden/Funktionen kann man so ausführen: <pre><call>perl chatbot_beispielfunktion</call></pre>

=== Was ist derzeit noch ToDo? ===
* Unterscheidung von Messages aus verschiedenen Quellen mit den entsprechenden Usern (siehe oben) - derzeit geht alles über ein TALKTOUSER Gerät
* evtl. Integration mit ROOMMATE
* Überarbeitung der Dokumentation
* Unterstützung von audio als Rückkanal
* Angabe von Verzeichnissen anstelle einzelner rive-Datei

=== Umgesetzte Projekte ===

==== Beleuchtungssteuerung mit Telegram ====

===== Ziel =====

Über Telegram soll es möglich sein, die Beleuchtung im Haus ein und auszuschalten.

===== Ausgangssituation =====

Bei mir haben die meisten Geräte im FHEM das Namensschema

ET.ra.FU.Beschreibung

wobei

ET = Kürzel für Etage
ra = Kürzel für Raum
FU = Kürzel für Funktion

So ist zum Beispiel die Lampe im Esszimmer über dem Esstisch OG.ez.LI.Esstisch.

===== Umsetzung =====

Zunächst wird ein Menü gebaut, welches als Antwort auf die Nachricht "Hauptmenü" über Telegram gesendet wird:

.rive-Datei:
<pre>
! sub hauptmenü = hauptmenue

+ [*] (abbrechen|hauptmenue) [*]
- Hauptmenü:
^ /Licht_Aus
^ /Licht_An

+ leave
- Untermenü verlassen \n \s \n {@ hauptmenue}
</pre>

Die "/" vor den einzelnen Menüpunkten sorgen dafür, dass diese im Telegram direkt anklickbar sind.

Als nächstes werden zwei subs in der myUtils benötigt, um alle ein- bzw. ausgeschalteten Lampen zu ermitteln und als Antwort für Telegram zu formatieren:

99_myUtils.pm:
<source lang="perl">
sub
chatBot_getLightsOn
{
my @lights = devspec2array('.*\.LI\..*:FILTER=state!=off:FILTER=TYPE!=DOIF:FILTER=TYPE!=notify:FILTER=TYPE!=readingsProxy');;
my $msg = "Es sind folgende Lichter eingeschaltet:\n \n";;
my $room = "";

if (@lights > 0 and defined($defs{$lights[0]})){
foreach (@lights){
if ($room ne AttrVal($_, "room", $_))
{
if ($room ne "")
{
$msg .= " \n/".$room."_Aus \n";
}
$room = AttrVal($_, "room", $_);
$msg .= " \n".$room.": \n";
}
$_ =~ s/\./__/g;
$msg .= "/".$_." \n";
}
if ($room ne "")
{
$msg .= " \n/".$room."_Aus \n";
}
$msg .= " \n/Alle_Aus
\n \n/Hauptmenue
";;
}else{
$msg = "Es sind alle Lichter ausgeschaltet.";;
$msg .= "\n/Hauptmenue
";;
}
return $msg;
}

sub
chatBot_getLightsOff
{
my @lights = devspec2array('.*\.LI\..*:FILTER=state!=on:FILTER=TYPE!=DOIF:FILTER=TYPE!=notify:FILTER=TYPE!=readingsProxy');;
my $msg = "Es sind folgende Lichter ausgeschaltet:\n \n";;
my $room = "";

if (@lights > 0 and defined($defs{$lights[0]})){
foreach (@lights){
if ($room ne AttrVal($_, "room", $_))
{
if ($room ne "")
{
$msg .= " \n/".$room."_Ein \n";
}
$room = AttrVal($_, "room", $_);
$msg .= " \n".$room.": \n";
}
$_ =~ s/\./__/g;
$msg .= "/".$_." \n";
}
if ($room ne "")
{
$msg .= " \n/".$room."_Ein \n";
}
$msg .= " \n/Alle_Ein
\n \n/Hauptmenue
";;
}else{
$msg = "Es sind alle Lichter eingeschaltet.";;
$msg .= "\n/Hauptmenue
";;
}
return $msg;
}
</source>

Die Formatierung für Telegram erfolgt, indem die . durch __ ersetzt werden und ein / vorangestellt wird, damit es im Telegram anklickbar wird.

Nun folge die Logik für RiveScript. Zunächst die Abfrage für die Auflistung der ein- bzw. ausgeschalteten Lampen (inklusive notwendiger Definitionen):

.rive-Datei:
<pre>
! array levels = eg og dg au
! array rooms = ku ez ba fk sp ks wz bu sz
! array spacer = __ _

+ licht(@spacer)aus
- <call>perl chatBot_getLightsOn</call>{topic=licht_aus}

+ licht(@spacer)an
- <call>perl chatBot_getLightsOff</call>{topic=licht_an}
</pre>

Anschließend die Schaltfunktionen:

.rive-Datei:
<pre>
> topic licht_aus

+ [*] (abbrechen|hauptmenue) [*]
- {topic=random} {@ leave}

+ (@levels)(@spacer)(@rooms)(@spacer)li(@spacer)(*)(@spacer)(*)
- <set licht={uppercase}<star1>{/uppercase}.<star3>.LI.{formal}<star6>{/formal}_{formal}<star9>{/formal}>
^ Schalte Licht <get licht> aus \n
^ /Hauptmenue
^ <call>fhem set <get licht> off</call>

+ (@levels)(@spacer)(@rooms)(@spacer)li(@spacer)(*)
- <set licht={uppercase}<star1>{/uppercase}.<star3>.LI.{formal}<star6>{/formal}>
^ Schalte Licht <get licht> aus \n
^ /Hauptmenue
^ <call>fhem set <get licht> off</call>

+ alle(@spacer)aus
- Schalte alle Lichter aus \n
^ /Hauptmenue
^ <call>fhem set .*\.LI\..*:FILTER=state!=off:FILTER=TYPE!=DOIF:FILTER=TYPE!=notify:FILTER=TYPE!=readingsProxy off</call>

+ (*)(@spacer)(*)(@spacer)aus
- <set room={formal}<star1>{/formal}_{formal}<star4>{/formal}>
^ Schalte Licht in <get room> aus \n
^ /Hauptmenue
^ <call>fhem set .*\.LI\..*:FILTER=state!=off:FILTER=TYPE!=DOIF:FILTER=TYPE!=notify:FILTER=TYPE!=readingsProxy:FILTER=room=<get room> off</call>

+ (*)(@spacer)aus
- <set room={formal}<star1>{/formal}>
^ Schalte Licht in <get room> aus \n
^ /Hauptmenue
^ <call>fhem set .*\.LI\..*:FILTER=state!=off:FILTER=TYPE!=DOIF:FILTER=TYPE!=notify:FILTER=TYPE!=readingsProxy:FILTER=room=<get room> off</call>

< topic

> topic licht_an

+ [*] (abbrechen|hauptmenue) [*]
- {topic=random} {@ leave}

+ (@levels)(@spacer)(@rooms)(@spacer)li(@spacer)(*)(@spacer)(*)
- <set licht={uppercase}<star1>{/uppercase}.<star3>.LI.{formal}<star6>{/formal}_{formal}<star9>{/formal}>
^ Schalte Licht <get licht> ein \n
^ /Hauptmenue
^ <call>fhem set <get licht> on</call>

+ (@levels)(@spacer)(@rooms)(@spacer)li(@spacer)(*)
- <set licht={uppercase}<star1>{/uppercase}.<star3>.LI.{formal}<star6>{/formal}>
^ Schalte Licht <get licht> ein \n
^ /Hauptmenue
^ <call>fhem set <get licht> on</call>

+ alle(@spacer)ein
- Schalte alle Lichter ein \n
^ /Hauptmenue
^ <call>fhem set .*\.LI\..*:FILTER=state!=on:FILTER=TYPE!=DOIF:FILTER=TYPE!=notify:FILTER=TYPE!=readingsProxy on</call>

+ (*)(@spacer)(*)(@spacer)ein
- <set room={formal}<star1>{/formal}_{formal}<star4>{/formal}>
^ Schalte Licht in <get room> ein \n
^ /Hauptmenue
^ <call>fhem set .*\.LI\..*:FILTER=state!=on:FILTER=TYPE!=DOIF:FILTER=TYPE!=notify:FILTER=TYPE!=readingsProxy:FILTER=room=<get room> on</call>

+ (*)(@spacer)ein
- <set room={formal}<star1>{/formal}>
^ Schalte Licht in <get room> ein \n
^ /Hauptmenue
^ <call>fhem set .*\.LI\..*:FILTER=state!=on:FILTER=TYPE!=DOIF:FILTER=TYPE!=notify:FILTER=TYPE!=readingsProxy:FILTER=room=<get room> on</call>

< topic
</pre>

Ein möglicher Dialog mit FHEM sähe dann wie folgt aus:

Benutzer:
<pre>
Hauptmenü
</pre>

FHEM:
<pre>
Hauptmenü:
/Licht_Aus
/Licht_An
</pre>

Benutzer:
<pre>
/Licht_An
</pre>

FHEM:
<pre>
Es sind folgende Lichter ausgeschaltet:

Aussenwelt:
/AU__ho__LI__Markise
/AU__ho__LI__Terrasse

/Aussenwelt_Ein

Buero:
/DG__bu__LI__Flur
/DG__bu__LI__Schornstein
/DG__bu__LI__Schreibtisch

/Buero_Ein

Schlafzimmer:
/DG__sz__LI__Hinten_Halogen
/DG__sz__LI__Hinten_Led
/DG__sz__LI__Kleiderschrank
/DG__sz__LI__Vorn

/Schlafzimmer_Ein

Wohnzimmer:
/DG__wz__LI__Allgemein

/Wohnzimmer_Ein

Esszimmer:
/OG__ez__LI__Allgemein
/OG__ez__LI__Bogen
/OG__ez__LI__Esstisch
/OG__ez__LI__Vitrine

/Esszimmer_Ein

Flur_Kinder:
/OG__fk__LI__Allgemein

/Flur_Kinder_Ein

Hausflur:
/OG__hf__LI__Schuhschrank
/OG__hf__LI__Treppe

/Hausflur_Ein

Kinderschlafzimmer:
/OG__ks__LI__Allgemein
/OG__ks__LI__Bett
/OG__ks__LI__Sterne

/Kinderschlafzimmer_Ein

Kueche:
/OG__ku__LI__Besenschrank
/OG__ku__LI__Kuechenzeile
/OG__ku__LI__Kuehlschrank
/OG__ku__LI__Theke

/Kueche_Ein

Spielzimmer_Kinder:
/OG__sp__LI__Baggerheck_Schreibtisch
/OG__sp__LI__Baggerschaufel_Podest

/Spielzimmer_Kinder_Ein

Treppe:
/OG__tr__LI__Handlauf_Fenster

/Treppe_Ein

/Alle_Ein

/Hauptmenue</pre>

Benutzer:
<pre>
/OG__ku__LI__Kuechenzeile
</pre>

FHEM:
<pre>
Schalte Licht OG.ku.LI.Kuechenzeile ein
/Hauptmenue
</pre>

Benutzer:
<pre>
/OG__ku__LI__Kuechenschrank
</pre>

FHEM:
<pre>
Schalte Licht OG.ku.LI.Kuechenschrank ein
/Hauptmenue
</pre>

Benutzer:
<pre>
/Hauptmenue
</pre>

FHEM:
<pre>
Untermenü verlassen

Hauptmenü:
/Licht_Aus
/Licht_An
</pre>

Benutzer:
<pre>
/Licht_Aus
</pre>

FHEM:
<pre>
Es sind folgende Lichter eingeschaltet:

Kueche:
/OG__ku__LI__Kuechenschrank
/OG__ku__LI__Kuechenzeile

/Kueche_Aus

/Alle_Aus

/Hauptmenue
</pre>

Benutzer:
<pre>
/Kueche_Aus
</pre>

FHEM:
<pre>
Schalte Licht in Kueche aus
/Hauptmenue
</pre>

==== Beleuchtungssteuerung über Sprache ====

Die Module können nicht nur eingesetzt werden, um mittels Telegram zu kommunizieren. Ein weiteres Beispiel ist der Einsatz als Spracherkennung für gesprochene Befehle über z.B. [[AMAD]]. Hier ist allerdings zum jetzigen Zeitpunkt noch keine gesprochene Antwort möglich und das Zieldevice für die Antwort kann nur hardcodiert hinterlegt werden.

Zunächst müssen in der AMADCommBridge die notwendigen Attribute gesetzt werden:
<pre>
attr AMADCommBridge userattr talktouserMonitorReading talktouserModSourceDev
attr AMADCommBridge talktouserModSourceDev HandyRonny
attr AMADCommBridge talktouserMonitorReading receiveVoiceCommand
</pre>

Nun muss noch die Logik für RiveScript hinterlegt werden:
<pre>

// Aus den gesprochenen Räumen werden die Kürzel ermittelt
! person badezimmer = OG.ba.
! person buero = DG.bu.
! person esszimmer = OG.ez.
! person flur_kinder = OG.fk.
! person hausflur = OG.hf.
! person kinderschlafzimmer = OG.ks.
! person kueche = OG.ku.
! person schlafzimmer = DG.sz.
! person spielzimmer_kinder = OG.sp.
! person treppe = OG.tr.
! person unten_kueche = EG.uk.
! person unten_stube = EG.st.
! person waschhaus = EG.wh.
! person wohnzimmer = DG.wz.

// Aus den gesprochenen Befehlen werden die FHEM Befehle ermittelt
! person ein = on
! person an = on
! person aus = off

// einige Ersetzungen, um nicht immer den konkreten Begriff verwenden zu müssen
! sub büro = buero
! sub küche = kueche
! sub bad = badezimmer
! sub flur kinder = flur_kinder
! sub kinderflur = flur_kinder
! sub spielzimmer kinder = spielzimmer_kinder
! sub spielzimmer = spielzimmer_kinder
! sub kinderspielzimmer = spielzimmer_kinder
! sub kinderzimmer = spielzimmer_kinder
! sub kueche unten = unten_kueche
// Die Deckenlampe heißt meistens Allgemein
! sub decke = allgemein

// Ersetzungen, um einen anderen Satzbau zu erlauben
! sub einschalten = ein
! sub anschalten = an
! sub anmachen = an
! sub ausmachen = aus
! sub ausschalten = aus

/*****************************************************************************\
* Lichtsteuerung per Sprache *
\*****************************************************************************/
! array schaltenaliaseinschalten = an|ein
! array schaltenaliasausschalten = aus
! array schaltenaliashandlung = an|ein|aus
! array schaltenaliasartikel = der|die|das
! array schaltenaliasfuellwoerter = schalte|mach
! array schaltenaliasorte = in|am|auf|an|im|auf dem
! array schaltenaliashoeflich = bitte
! array roomsfull = badezimmer|buero|esszimmer|flur_kinder|hausflur|kinderschlafzimmer|kueche|schlafzimmer|spielzimmer_kinder|treppe|unten_kueche|unten_stube|waschhaus|wohnzimmer

// einzelnes Licht ein- bzw. ausschalten
// Bsp: [Bitte] schalte das Licht im Wohnzimmer an der Decke (ein|aus)
+ [@schaltenaliashoeflich] [@schaltenaliasfuellwoerter] [@schaltenaliashoeflich] [@schaltenaliasartikel] licht [@schaltenaliasorte] [@schaltenaliasartikel] (@roomsfull) [@schaltenaliasorte] [@schaltenaliasartikel] _ (@schaltenaliashandlung)
- <set lightroom={person}<star1>{/person}LI.>
^ <set lightname={formal}<star2>{/formal}>
^ Licht <get lightroom><get lightname> wird <star3>geschaltet
^ <call>fhem set <get lightroom>.*<get lightname>.* {person}<star3>{/person}</call>

// einzelnes Licht ein- bzw. ausschalten - anderer Satzbau
// Bsp: [Bitte] schalte das Licht an der Decke im Wohnzimmer (ein|aus)
+ [@schaltenaliashoeflich] [@schaltenaliasfuellwoerter] [@schaltenaliashoeflich] [@schaltenaliasartikel] licht [@schaltenaliasorte] [@schaltenaliasartikel] _ [@schaltenaliasorte] (@roomsfull) (@schaltenaliashandlung)
- <set lightroom={person}<star2>{/person}LI.>
^ <set lightname={formal}<star1>{/formal}>
^ Licht <get lightroom><get lightname> wird <star3>geschaltet
^ <call>fhem set <get lightroom>.*<get lightname>.* {person}<star3>{/person}</call>

// einzelnes Licht mit zweiteiligem Namen ein- bzw. ausschalten
// Bsp: [Bitte] schalte das Licht im Schlafzimmer hinten halogen (ein|aus)
+ [@schaltenaliashoeflich] [@schaltenaliasfuellwoerter] [@schaltenaliashoeflich] [@schaltenaliasartikel] licht [@schaltenaliasorte] [@schaltenaliasartikel] zwei worte _ _ [@schaltenaliasorte] (@roomsfull) (@schaltenaliashandlung)
- <set lightroom={person}<star3>{/person}LI.>
^ <set lightname={formal}<star1>{/formal}_{formal}<star2>{/formal}>
^ Licht <get lightroom><get lightname> wird <star4>geschaltet
^ <call>fhem set <get lightroom>.*<get lightname>.* {person}<star4>{/person}</call>

// Licht in einem Zimmer ein- bzw. ausschalten
// Bsp: [Bitte] schalte das Licht im Schlafzimmer (ein|aus)
+ [@schaltenaliashoeflich] [@schaltenaliasfuellwoerter] [@schaltenaliashoeflich] [@schaltenaliasartikel] licht [@schaltenaliasorte] [@schaltenaliasartikel] (@roomsfull) (@schaltenaliashandlung)
- <set light={person}<star1>{/person}LI.>
^ Licht {formal}<star1>{/formal} wird <star2>geschaltet
^ <call>fhem set <get light>.* {person}<star2>{/person}</call>
</pre>

Damit kann sind zum Beispiel für die Lampe am Küchenschrank folgende Sprachbefehle möglich (Begriffe in eckigen Klammen, wie z.B. [bitte] sind optional; durch | getrennte Begriffe in Klammern stellen Alternativen dar):
<pre>
[bitte] [schalte|mache] [das] Licht [in] [der] Küche [am] Küchenschrank (an|ein|aus)
[schalte|mache] [bitte] [das] Licht [in] [der] Küche [am] Küchenschrank (an|ein|aus)
[bitte] [schalte|mache] [das] Licht [am] Küchenschrank [in] [der] Küche (an|ein|aus)
[schalte|mache] [bitte] [das] Licht [am] Küchenschrank [in] [der] Küche (an|ein|aus)
[bitte] [das] Licht [am] Küchenschrank [in] [der] Küche (an|ein|aus)[schalten|machen]
[bitte] [das] Licht [in] [der] Küche [am] Küchenschrank (an|ein|aus)[schalten|machen]
</pre>

Wird die konkrete Lampe weggelassen, so wird das Licht im gesamten Raum ein-/ausgeschaltet:
<pre>
[bitte] [schalte|mache] [das] Licht [in] [der] Küche (an|ein|aus)
[schalte|mache] [bitte] [das] Licht [in] [der] Küche (an|ein|aus)
[bitte] [das] Licht [in] [der] Küche (an|ein|aus)[schalten|machen]
</pre>

Da ich auch Lampen habe, deren Beschreibung aus zwei durch _ getrennten Begriffen besteht (z.B. OG.sp.LI.Baggerschaufel_Podest ist die vordere Glühbirne einer Baggerlampe, welche ein Podest beleuchtet), habe ich zwei Möglichkeiten eingebaut, diese zu schalten:

1. Ankündigung, dass es sich um einen Begriff mit zwei Worten handelt:
<pre>
[bitte] [schalte|mache] [das] Licht [im] Küche [an] [der] zwei Worte Baggerschaufel Podest (an|ein|aus)
</pre>
(weitere Alternativen zum Satzbau wie oben)

2. Die Beschreibung wird beim schalten generell zwischen zwei ".*" gesetzt, so dass alle Devices geschaltet werden, auf welche die Beschreibung zutrifft. Dadurch führen auch die folgenden Befehle (in allen oben beschriebenen Satzbauvarianten) zum Erfolg:
<pre>
[bitte] [schalte|mache] [das] Licht [im] Küche [am] Podest (an|ein|aus)
[bitte] [schalte|mache] [das] Licht [im] Küche [an] [der] Baggerschaufel (an|ein|aus)
</pre>

Dadurch ist zu beachten, dass z.B. bei den beiden Lampen DG.sz.LI.Hinten_Led und DG.sz.LI.Hinten_Halogen mit
<pre>
[bitte] [schalte|mache] [das] Licht [im] Schlafzimmer hinten (an|ein|aus)
</pre>
beide Lampen geschaltet werden und mit
<pre>
[bitte] [schalte|mache] [das] Licht [im] Schlafzimmer Halogen (an|ein|aus)
</pre>
nur eine der beiden.

== Weblinks ==
* Forumsartikel [https://forum.fhem.de/index.php/topic,54863.0.html Module: TALKTOME & TALKTOUSER - Sprachverarbeitung für Nutzerinteraktionen]
* Forumsartikel [https://forum.fhem.de/index.php/topic,39983.0.html Neuer FHEM Befehl "msg" für Benachrichtigungen]
* RiveScript [https://www.rivescript.com/docs/tutorial#first-steps First steps]
* Modul [[AMAD]]

[[Category:Examples]]
[[Category:HOWTOS]]
[[Category:Code Snippets]]
[[Categorie:Interfaces]]

TALKTOME & TALKTOUSER - Sprachverarbeitung für Nutzerinteraktionen

2016-07-05T13:57:23Z

RoBra81: Die Seite wurde neu angelegt: „{{Infobox Modul|...}} Mit Hilfe der Module TALKTOME & TALKTOUSER und der Sprache RiveScript ist es möglich, Chatbots - bekannt von Webseiten wie IKEA und co -…“

{{Infobox Modul|...}}
Mit Hilfe der Module TALKTOME & TALKTOUSER und der Sprache RiveScript ist es möglich, Chatbots - bekannt von Webseiten wie IKEA und co - für FHEM einzusetzen, um Frage-Antwort-Dialoge zu bauen.

== Features / Funktionen ==
Die Haupteigenschaften von XYZ sind
* Anbindung von RiveScript an fhem
* Abruf von Readings, ReadingTimestamps, Attributen
* Absetzen von fhem Befehlen oder Aufruf von perl Funktionen

== Hinweise zum Betrieb mit FHEM ==
=== Voraussetzungen ===
Die Einrichtung von msg - das macht mir das Antworten in die diversen Kanäle sehr viel einfacher.

Installation von RiveScript in der Version 2.0.1 (oder neuer, falls eine erscheinen sollte) via CPAN. ACHTUNG nicht via apt-get installieren, da die Version zu alt ist.

==== msg ====
Bei der ersten Verwendung des Befehls "msg" wird ein Device namens globalMsg angelegt, was man aber dem Modul vorweg nehmen kann:
<pre>
define globalMsg msgConfig
</pre>

Damit sind die Voraussetzungen schon geschaffen

==== Installation von RiveScript ====
Rufe cpan auf:
<source lang="bash">
cpan
</source>

Das sieht dann etwa so aus:
<source lang="bash">
sudo cpan
Loading internal null logger. Install Log::Log4perl for logging messages
Terminal does not support AddHistory.

cpan shell -- CPAN exploration and modules installation (v2.10)
Enter 'h' for help.

cpan[1]>
</source>

Installiere dann Rivescript mit Hilfe des folgenden Kommandos:
<source lang="bash">
install RiveScript
</source>

Falls Fragen aufkommen, ob man Abhängigkeiten folgen soll, dann bitte richtig beantworten (yes) ;)

=== Installation der Module ===
Geht wie immer:
<pre>
update all https://raw.githubusercontent.com/SirUli/FHEM-TALKTO/master/controls_talkto.txt
</pre>

Anschließend sollte man im Ordner FHEM drei zusätzliche Files (42_TALKTOME.pm, 42_TALKTOUSER.pm sowie TALKTOME.rive.template) finden. Letzteres benennt man nun um in TALKTOME.rive. An dieser Stelle darf man das File natürlich auch schon editieren - wenn man möchte und Rivescript versteht.

==== Definition ====
Dann geht es los mit der Definition des Chatbots an sich:
<pre>
define FHEMTALKTOME TALKTOME
</pre>

FHEMTALKTOME ist sozusagen nun der Bot, welcher zu Beginn noch deaktiviert ist. Bevor man diesen aktiviert, muss man den Pfad zum TALKTOME.rive File setzen. Ist dieses file im Ordner FHEM (sozusagen also wie Auslieferungszustand und oben beschrieben), so setzt man folgendes:

<pre>
attr FHEMTALKTOME rsbrainfile ./FHEM/TALKTOME.rive
</pre>

Dann kann man das Attribut "disable" entfernen. Für die Nutzerinteraktion kann man noch weitere Details eines Nutzer anlegen (derzeit nur den "richtigen" Namen), daher brauchen wir ein Benutzermodul, also z.B. für mich:

<pre>
define TALKTOUSER_ULI TALKTOUSER
</pre>

Bitte noch nicht wundern - derzeit ist das noch nicht voll ausgebaut, besser ihr legt erstmal nur ein Benutzergerät an.

Nun kommt der wichtigste Teil - die Einbindung einer Quelle. Bei mir ist das nun Telegram, welches nun zwei zusätzliche Attribute via userAttr bekommen muss:
<pre>
talktouserMonitorReading talktouserModSourceDev
</pre>

Was heissen die Attribute?

talktouserMonitorReading: Bezeichnet das Reading welches überwacht werden soll, im falle von Telegram ist dies auf "msgText" zu setzen
talktouserModSourceDev: Lässt eine Änderung des Quell Devices zu. So muss beispielsweise für Telegram, damit eine Antwort machbar ist, das Quelldevice verändert werden. Lokale Readings (also vom Quellverzeichnis) werden mit %%readingname%% angegeben, das device selbst ist %DEVICE%. Für Telegram muss beispielsweise %DEVICE%:@%%msgPeerId%% gesetzt werden, damit die Antworten ankommen

=== Wie legt man nun Dialoge an? ===
Dazu empfehle ich einmal durch das Tutorial ab den "First Steps" zu gehen und sich die Beispieldatei FHEM/TALKTOME.rive.template zu Gemüte zu führen. Diese bietet schon so kleinigkeiten wie "Wie heisst du" als Fragen oder die Frage nach dem Wetter (Geräte eben entsprechend austauschen!) oder den Raumtemperaturen. 
Zusätzlich:
Readings lassen sich per <pre><call>readingsval BK_Wetter fc1_low_c Error</call></pre> auslesen 
Readings Timestamps lassen sich per <pre><call>readingstimestamp LR_Wandthermostat temperature Error</call></pre> auslesen 
Attribute lassen sich per <pre><call>attrval BK_Wetter fc1_low_c Error</call></pre> auslesen 
FHEM Kommandos kann man so ausführen:<pre> <call>fhem set KU_SWITCH_COFFEE_Sw on</call></pre> 
Perl Methoden/Funktionen kann man so ausführen: <pre><call>perl chatbot_beispielfunktion</call></pre> 

=== Was ist derzeit noch ToDo? ===
Unterscheidung von Messages aus verschiedenen Quellen mit den entsprechenden Usern (siehe oben) - derzeit geht alles über ein TALKTOUSER Gerät
evtl. Integration mit ROOMMATE
Überarbeitung der Dokumentation

=== Umgesetzte Projekte ===
Folgen zeitnah

== Weblinks ==
* Forumsartikel [https://forum.fhem.de/index.php/topic,54863.0.html Module: TALKTOME & TALKTOUSER - Sprachverarbeitung für Nutzerinteraktionen]
* Forumsartikel [https://forum.fhem.de/index.php/topic,39983.0.html Neuer FHEM Befehl "msg" für Benachrichtigungen]
* RiveScript [https://www.rivescript.com/docs/tutorial#first-steps First steps]

[[Kategorie:XYZ Gerät]]