FHEMWiki - Benutzerbeiträge [de]

Alexa-Fhem

2016-11-12T09:52:58Z

DennisN75:

'''Alexa-Fhem''' ist eine in JavaScript und auf NodeJS basierende Software, welche es ermöglicht, der digitalen Amazon Assistentin Alexa zusätzliche Skills für die Heimautomatisierung via FHEM beizubringen. Eine erste funktionierende Version wurde von [https://forum.fhem.de/index.php?action=profile;u=430 justme1968] im [https://forum.fhem.de/index.php/topic,60244.0.html Forum] veröffentlicht.
Das ist eine erste Version der Dokumentation zur Installation und Einrichtung, eine Erweiterung wird sicherlich in nächster Zeit noch folgen.
{{Infobox Modul
|ModPurpose=Anbindung von FHEM an Amazon Assistent Alexa
|ModType=x
|ModTechName=
|ModForumArea=Sonstige Systeme
|ModOwner=justme1968
}}

==Installation==

Grundvoraussetzung für alle folgenden Schritte ist, dass ein Amazon-Account vorhanden ist. Es wird davon ausgegangen, dass bereits für alle folgenden Amazon-Dienste vorab das Konto jeweils eingerichtet wurde, die Einrichtung dieser ist nicht Bestandteil dieser Anleitungen.

=== Voraussetzungen ===
Folgende grundlegende Voraussetzungen sollten erfüllt sein, bevor du mit der Einrichtung beginnst:
* Amazon Echo oder Amazon Dot
* node.js (vermutlich ab Version 0.12, getestet mit 4.2.6. Kann in Debian z.B. mit <source lang="bash" style="width:50%;">apt-get install nodejs-legacy</source> installiert werden)
* Weiterleitung von Port 3000 vom Router aus auf den Rechner, auf dem Alexa-Fhem läuft

=== Alexa-Fhem installieren ===
# Die tgz-Datei entpacken (Quelle: https://forum.fhem.de/index.php/topic,60244.0.html)
# Verzeichnis ''package'' in ''alexa-fhem'' umbenennen
# Durch <source lang="bash" style="width:50%;">cd alexa-fhem</source> in das Verzeichnis wechseln
# Mit <source lang="bash" style="width:50%;">npm install</source> alle Abhängigkeiten installieren
# SSL Zertifikat erzeugen durch Aufruf von <source lang="bash" style="width:50%;">./createKey.sh</source>. Hierbei beachten, dass ein Kennwort vergeben werden soll, das mindestens aus 4 Zeichen besteht.
# Die Datei ''config-sample.json'' nach ''~/.alexa/config.json'' kopieren und die Werte auf die eigene Umgebung hin anpassen. Der Filter funktioniert hierbei wie bei [http://www.fhemwiki.de/wiki/Homebridge_einrichten#Einstellungen_f.C3.BCr_homebridge homebridge-fhem], "oauthClientID": -> ''Client Id'' aus Punkt 1. '''Login with Amazon'''
# Durch Aufruf von <source lang="bash" style="width:50%;">bin/alexa</source> den Dienst starten

=== Alexa Smart Home Skill anlegen ===
Für folgende Schritte muss man unter der Adresse http://developer.amazon.com angemeldet sein
# Anmeldung auswählen [[Datei:Developer.amazon.com-01-login2.png|200px]]
# Anmeldedaten eingeben [[Datei:Developer.amazon.com-02-userpass2.png|200px]]

==== Apps & Services ====
# Klicke nach der Anmeldung auf ''APPS & SERVICES'' [[Datei:Developer.amazon.com-03-apps_and_services.png|200px]]
# Klicke anschließend auf ''Security Profiles'' [[Datei:Developer.amazon.com-05-apps_and_services_-_security_profiles.png|200px]]
# Wähle anschließend ''Create a New Security Profile'' aus [[Datei:Developer.amazon.com-06-apps_and_services_-_create_a_new_security_profile.png|200px]]
# Gebe dann ein Namen und eine Beschreibung für das Profil ein und bestätige die Eingaben durch anklicken von ''Save'' [[Datei:Developer.amazon.com-07-apps_and_services_-_security_profile_management.png|200px]]

==== Login with Amazon ====
{{Randnotiz|RNTyp=[g|Info]|RNText=Hier wird beschrieben, wo ''Client Id'' und ''Client Secret'' zu finden ist}}
# Nachdem du die vorherigen Schritte befolgt hast, siehst du im Browser das Profil dass du angelegt hast. Klicke jetzt oben rechts auf ''Login with Amazon'' [[Datei:Developer.amazon.com-08-login_with_amazon.png|200px]]
# Auf der neu geladenen Seite klickst du dann auf ''Sign up'' [[Datei:Developer.amazon.com-09-login_with_amazon_-_sign_up.png|200px]]
# Wähle anschließend im Dropdown Menü das vorher angelegte Profil aus und bestätige das anschließend mit ''Confirm'' [[Datei:Developer.amazon.com-10-login_with_amazon_-_create_new_profile.png|200px]] [[Datei:Developer.amazon.com-11-login_with_amazon_-_create_new_profile2.png|200px]]
# Im folgenden Fenster gibst du dann die Adresse [https://www.amazon.com/gp/help/customer/display.html?nodeId=468496 https://www.amazon.com/gp/help/customer/display.html?nodeId=468496] ein und bestätigst die Eingabe mit ''Save'' [[Datei:Developer.amazon.com-12-login_with_amazon_-_enter_consent_screen_information.png|200px]]
# Klicke dann bei dem neu angelegten Eintrag auf der rechten Seite auf das Zahnrad und wähle ''Web Settings'' aus [[Datei:Developer.amazon.com-13-login_with_amazon_-_web_settings.png|200px]]
# Im neu geladenen Fenster klickst du dann auf ''Edit'' [[Datei:Developer.amazon.com-14-login_with_amazon_-_edit.png|200px]]
# Füge zuletzt dann bei ''Allowed Return URLs'' die Adresse [https://layla.amazon.co.uk/api/skill/link/xxx https://layla.amazon.co.uk/api/skill/link/xxx], [https://pitangui.amazon.com/api/skill/link/xxx https://pitangui.amazon.com/api/skill/link/xxx], und [https://layla.amazon.com/api/skill/link/xxx https://layla.amazon.com/api/skill/link/xxx] hinzu. xxx muss hierbei durch den Wert ersetzt werden, der bei Punkt 6 '''Skill Kit einrichten''' unter '''Redirect Urls''' am Ende der URLs angezeigt wird. [[Datei:Developer.amazon.com-15-login_with_amazon_-_allowed_return_urls.png|200px]]

==== Skill Kit einrichten ====
# Wähle im Menü den Punkt ''Alexa'' aus [[Datei:Developer.amazon.com-03-apps_and_services.png|200px]]
# Klicke dann ''Get started'' beim Punkt ''Alexa Skills Kit'' an [[Datei:Developer.amazon.com-17-alexa_-_alex_skills_kit_-_get_started.png|200px]]
# Wähle dann auf der neu geladenen Seite oben rechts ''Add a New Skill'' aus [[Datei:Developer.amazon.com-18-alexa_-_alex_skills_kit_-_add_a_new_skill.png|200px]]
# Auf der folgenden Seite wählst du ''Smart Home Skill API'' sowie ''German'' als Sprache aus und gibst ein Name für den Skill ein was du dann mit ''Next'' bestätigst. [[Datei:Developer.amazon.com-19-alexa_-_alex_skills_kit_-_skill_information.png|200px]]
# Die folgende Seite klickst du mit ''Next'' dann weiter [[Datei:Developer.amazon.com-20-alexa_-_alex_skills_kit_-_interaction_model.png|200px]]
# Auf der Seite Configuration gibst du dann unter ''Authorization URL'' die Adresse [https://www.amazon.com/ap/oa https://www.amazon.com/ap/oa] an, bei Scope ''profile:user_id'' und bei ''Access Token URI'' [https://api.amazon.com/auth/o2/token https://api.amazon.com/auth/o2/token] sowie bei ''Privacy Policy URL'' die Adresse [https://www.amazon.com/gp/help/customer/display.html?nodeId=468496 https://www.amazon.com/gp/help/customer/display.html?nodeId=468496] Folgende Felder müssen individuell ausgefüllt werden: * ''Service Endpoint Type'' -> Europe auswählen und im Textfeld den Wert aus Punkt 12 '''AWS Lambda Funktion anlegen''' eintragen * ''Client Id'' -> ''Client Id'' aus Punkt 1. '''Login with Amazon''' * ''Client Secret'' -> ''Client Secret'' aus Punkt 1. '''Login with Amazon''' [[Datei:Developer.amazon.com-21-alexa_-_alex_skills_kit_-_configuration.png|200px]]
# [[Datei:Developer.amazon.com-22-alexa_-_alex_skills_kit_-_test.png|200px]]

{{Randnotiz|RNTyp=[g|Info]|RNText=Hier wird beschrieben, wo die ''Alexa Skill Id'' zu finden ist}}
Zur späteren Verwendung unter Punkt 7 '''AWS Lambda Funktion anlegen''' wird noch die Application Id benötigt. An diese kommt man wie folgt:
# Wähle im Menü den Punkt ''Alexa'' aus [[Datei:Developer.amazon.com-03-apps_and_services.png|200px]]
# Klicke dann ''Get started'' beim Punkt ''Alexa Skills Kit'' an [[Datei:Developer.amazon.com-17-alexa_-_alex_skills_kit_-_get_started.png|200px]]
# Beim vorher angelegten Eintrag auf ''Edit'' klicken [[Datei:Developer.amazon.com-23-alexa_-_alex_skills_kit_-_overview.png|200px]]
# Die Id, die nun oben angezeigt wird, ist die gesuchte [[Datei:Aws.amazon.com-06-configure_triggers2.png|200px]]

=== AWS Lambda Funktion anlegen ===
Für folgende Schritte muss man unter der Adresse http://aws.amazon.com angemeldet sein
# Anmeldung auswählen [[Datei:Aws.amazon.com-01-site.png|200px]]
# Anmeldedaten eingeben [[Datei:Aws.amazon.com-02-login.png|200px]]
# Den Punkt ''Lambda'' links auf der Startseite auswählen [[Datei:Aws.amazon.com-03-lambda.png|200px]]
# Anschließend den Punkt ''Get Started Now'' auswählen [[Datei:Aws.amazon.com-04-get_started_now.png|200px]]
# Den Blueprint ''Blank function'' auswählen [[Datei:Aws.amazon.com-05-select_blueprint.png|200px]]
# Im neuen Fenster dann auf den gestrichelten Kasten klicken und ''Alexa Smart Home'' auswählen und mit ''Next'' bestätigen [[Datei:Aws.amazon.com-06-configure_triggers1.png|200px]] ''Achtung! Es ist möglich, dass ihr hier '''Alexa Smart Home''' überhaupt nicht auswählen könnt. Dann solltet ihr ganz rechts oben in der Ecke mal schauen, welche Region bzw. welches Land ausgewählt ist. Ich empfehle hier '''Ireland''' auszuwählen. Dann erscheint bei den Funktionen auch '''Alexa Smart Home'''.''
# Bei ''Application Id'' den Wert eintragen, dessen Ermittlung unter '''Skill Kit einrichten''' in der zusätzlichen Beschreibung beschrieben wird, den Haken bei ''Enable trigger'' setzen und mit ''Next'' bestätigen [[Datei:Aws.amazon.com-06-configure_triggers3.png|200px]]
# Auf der Konfigurationsseite bei ''Name'' den Wert FHEM eingeben, bei ''Runtime'' Node.js 4.3. Bei ''Role'' den Wert ''Choose an existing role'' wählen und bei ''Existing role'' dann ''x'' wählen. Der Quellcode der Datei lambda.js aus dem Quellpaket wird dann an die Stelle des großen Textfeldes vollständig eingefügt. Dann noch den Hostname im Quellcode an den eigenen anpassen. Anschließend alles mit ''Next'' bestätigen. [[Datei:Aws.amazon.com-07-configure_function.png|200px]]
# Auf der Übersichtsseite dann ''Create function'' anklicken [[Datei:Aws.amazon.com-08-review.png|200px]]
# Klicke dann auf der Übersichtsseite oben links auf ''Function'' [[Datei:Aws.amazon.com-09-go_overview.png|200px]]
# Wähle dann die angelegte Funktion aus und klicke dann im Menü ''Action'' auf den Punkt ''Show ARN'' [[Datei:Aws.amazon.com-10-1-show_arn.png|200px]]
# Es wird nun eine ARN Adresse angezeigt, die für den Punkt 6 bei '''Skill Kit einrichten''' benötigt wird [[Datei:Aws.amazon.com-10-2-arn.png|200px]]

=== Alexa Skill einrichten ===
# Auf http://alexa.amazon.de anmelden
# Auf ''Skills'' klicken [[Datei:Alexa.amazon.de-01-startseite.png|200px]]
# Oben rechts ''Meine Skills'' auswählen [[Datei:Alexa.amazon.de-03-meine_skills.png|200px]]
# In der Liste der Skills sollte das angelegte FHEM Skill angezeigt werden. Dieses anklicken [[Datei:Alexa.amazon.de-02-liste_skills.png|200px]]
# Oben Rechts in den Details des Skills auf ''Skill aktivieren'' klicken [[Datei:Alexa.amazon.de-04-skill_details.png|200px]]
# In dem neu geöffneten Fenster die Authorisierung bestätigen [[Datei:Alexa.amazon.de-05-amazon_auth.png|200px]]
# Anschließend sollte die Verbindung erfolgreich aufgebaut worden sein [[Datei:Alexa.amazon.de-06-success.png|200px]]

=== Geräteeinrichtung ===
# Auf http://alexa.amazon.de anmelden
# Auf ''Smart Home'' klicken [[Datei:Alexa.amazon.de-01-startseite.png|200px]]
# Anschließend den Punkt ''Geräte suchen'' anklicken [[Datei:Alexa.amazon.de-07-Gerätesuche.png|200px]]
# Wurde soweit alles korrekt eingerichtet, werden nun die gefundenen Geräte angezeigt.

Tip: Es macht Sinn, unter ''Meine Gruppen'' Gruppen benannt nach den Räumen einzurichten. Hierdurch kann Alexa die Geräte besser auseinander halten, vor allem wenn die den gleichen Alias (z.B. "Licht") haben.

== Nutzung ==
=== Sprachkommandos ===
Nach erfolgreicher Einrichtung sollte Alexa mit den Befehlen
<pre style="width:50%;">
“alexa, schalte <gerät> ein”
“alexa, schalte <gerät> aus”
“alexa, stelle <gerät> auf <wert> prozent”
“alexa, stelle <gerät/raum> auf <anzahl> grad”
</pre>
nutzbar sein

=== Optimierung ===
Normalerweise wird von Alexa-Fhem der Wert im Feld ''NAME'' verwendet, mit dem ein Gerät angesprochen werden kann via Alexa. Ist ein anderer "Rufname" gewünscht, kann das Feld ''Alias'' gesetzt werden. Der hier gesetzte Wert wird dann als alternativer Name verwendet.

=== Troubleshooting ===
Besonders wichtig ist, dass man sich sehr genau an diese Anleitung hält. Ein häufiger Fehler ist, dass die einfachen Anführungszeichen in der Anleitung unter '''AWS Lambda Funktion anlegen''' Punkt 8 einfach weggelassen werden. Diese sind zwingend notwendig. Es darf auch nur der reine Hostname eingetragen werden. Also kein ''http://'' davor. Entweder eine feste IP Adresse oder den Hostnamen, um den Rechner zu erreichen, den ihr über den Port 3000 freigegeben habt. Das sollte dann so aussehen:
<pre style="width:50%;">
const PORT=3000;
const HOST='mein.host.name';
</pre>

Je nach Router gestaltet sich das Portforwarding bzw. die Portumleitung etwas schwieriger. Bei einem Speedport Router der Telekom beispielsweise, muss der Router komplett neu gestartet werden, wenn die Portfreigabe eingerichtet wurde. Bei der Fritzbox ist dies normalerweise nicht nötig.
Um die Portweiterleitung zu testen, solltet ihr euch auch nicht im gleichen Netz befinden. Viele Router blockieren den Netzaufruf aus dem gleichen Netz. Am besten testet ihr es, wenn ihr an eurem Mobiltelefon W-LAN deaktiviert und im Browser folgende Seite aufruft: ''https://mein.hostname:3000''. Wenn ihr im Browser dann einen Quellcode von Alexa seht, funktioniert die Portumleitung.

- Wenn ihr dann alexa-fhem über die Konsole startet und bekommt folgenden Fehler: ''NAT-PMP failed: Error: timeout'', lasst euch davon nicht irritieren. Das bedeutet lediglich, dass der Port nicht automatich freigegeben wurde.

'''Was ist zu tun, wenn alexa-fhem keine Geräte findet?''' 
Zunächst müssen die Geräte, die angesprochen werden wollen, unter FHEM ein neues Attribut zugewiesen bekommen. Dazu das Gerät in FHEM öffnen und das Attribut ''genericDeviceType switch'' hinzufügen, wenn es ein Schalter mit der Funktiona AN/AUS sein soll. Wenn man will, kann man dem Gerät jetzt noch über das Attribut ''alias'' eine besseren Namen geben, mit dem Alexa das Gerät dann auch finden kann.
Anschließend muss alexa-fhem neu gestartet werden und die definierten Geräte sollten nun gefunden werden.

'''Was ist zu tun, wenn Alexa zwar Geräte findet, diese aber nicht angesprochen werden können?''' 
Zunächst sollte man sich unter ''http://aws.amazon.com'' das Logfile seiner erstellten Funktion anschauen. Ist überhaupt ein Logfile vorhanden? Falls nicht, liegt es vermutlich am Trigger.
Den solltet ihr überprüfen. Scheinbar kommt es hin und wieder vor, dass dieser nicht gesetzt ist. Dazu einfach auf ''Triggers'' klicken und mit ''Add trigger'' erneut einen anlegen. Hier muss, wie in der Anleitung unter '''AWS Lambda Funktion anlegen''' Punkt 7, die ''Application Id'' stehen und der Haken bei ''Enable trigger'' gesetzt sein. Dann alexa-fhem neu starten.
Wenn ihr Änderugen gemacht habt und den alexa-fhem Dienst noch nicht neu gestartet habt, wäre jetzt der richtige Zeitpunkt.

Alexa-Fhem

2016-11-12T08:31:41Z

DennisN75: