yowsup
yowsup | |
---|---|
Zweck / Funktion | |
Schnittstelle, um WhatsApp-Nachrichten empfangen und senden zu können. | |
Allgemein | |
Typ | Gerätemodul |
Details | |
Dokumentation | EN / DE Thema |
Support (Forum) | Unterstuetzende Dienste |
Modulname | 32_yowsup.pm |
Ersteller | André / justme1968 (Forum / Wiki) |
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref! |
Das Modul yowsup dient dazu, WhatsApp-Nachrichten zu empfangen und zu senden. Nachrichten können sein:
- Text: senden und empfangen, z.b.: Infonachrichten senden, FHEM-Kommandos empfangen
- Bilder: senden und empfangen, z.b.: Webcambilder nach Bewegungserkennung versenden
- Audio: empfangen, z.b.: Sprachdurchsagen empfangen und über SONOS abspielen
Voraussetzungen
- Die Funktionalität ist vermutlich auf Linux/Unix Systeme beschränkt.
- Nach der Erstinstallation/-einrichtung muss zwingend das cmd Attribut korrekt gesetzt werden.
Installation
Die ursprüngliche Einrichtung wurde hier beschrieben, jedoch sind noch einige wichtige Dinge zu setzen. Mit der Version 3.0.0 vom 24. April 2019 hat sich einiges in der Kommunikation mit WhatsApp geändert. Diese Änderungen führen dazu, dass alles komplett neu installiert und registriert werden muss.
Yowsup Installation
Bevor man loslegt sollte man wie immer sicherstellen, dass Debian auf dem aktuellen Stand ist:
sudo apt-get update
sudo apt-get upgrade
sudo apt-get dist-upgrade
Los gehts mit den Paketen:
sudo apt-get install python-soappy python-dateutil python-pip python-dev build-essential libssl-dev libffi-dev
Nun erstmal pip updaten:
sudo pip install --upgrade pip
yowsup benötigt zwingend von six die Version 1.10 (unter /usr/local/lib/python2.7/dist-packages prüfen, ob eine andere Version von six installiert ist. Diese erst löschen):
sudo pip uninstall six
sudo pip install six==1.10
Und dann Axolotl, argparse, readline installieren (das dauert ne Weile):
(eventuell wird auch noch appdirs benötigt)
sudo pip install argparse
sudo pip install readline
sudo pip install appdirs
sudo pip install python-axolotl
Zudem wird neben den Python Modulen noch eine Lib's von tgalal benötigt:
cd /opt/fhem/yowsup sudo wget https://github.com/tgalal/python-axolotl/archive/master.zip sudo unzip master.zip cd python-axolotl-master sudo python setup.py install cd .. rm master.zip
cd /opt/fhem/yowsup sudo wget https://github.com/tgalal/dissononce/archive/master.zip sudo unzip master.zip cd dissononce-master sudo python setup.py install cd .. rm master.zip
cd /opt/fhem/yowsup sudo wget https://github.com/tgalal/consonance/archive/master.zip sudo unzip master.zip cd consonance-master sudo python setup.py install cd .. rm master.zip
Will man Bilder verarbeiten, so braucht man noch ein paar Pakete mehr:
- Paketinstallationen:
- Unter Debian Wheezy:
sudo apt-get install libtiff4-dev libjpeg8-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.5-dev tk8.5-dev python-tk
- Unter Debian Jessie:
sudo apt-get install libtiff5-dev libjpeg-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.5-dev tk8.5-dev python-tk
- Unter Debian Wheezy:
- PIP:
sudo pip install pillow
Vor den weiteren Schritten sollte geprüft werden, ob dem User fhem eine Loginshell zugewiesen ist:
getent passwd fhem
Wird hier am Ende /bin/false ausgegeben, so muss dies angepasst werden:
sudo chsh -s /bin/bash fhem
Mittels getent passwd fhem kann auch bereits das Home-Verzeichnis ausgelesen werden, dies steht in der ausgegebenen Doppelpunkt-separierten Liste an vorletzter Stelle.
Nun loggt man sich unter dem User ein, unter dem fhem läuft (in den folgenden Beispielen werden die vom fhem-Setup-Script generierten Defaults verwendet: User=fhem , home=/opt/fhem Gruppe=dialout) und liest dort die $HOME-Variable aus und prüft das Home-Verzeichnis:
sudo su - fhem echo $HOME cd $HOME logout
Diesen Wert braucht man später - gut merken. Sollte hier ein Fehler auftreten (z.B. das home nicht vorhanden), so muss dies zuerst korrigiert werden.
Desweiteren muss man nun yowsup installieren:
cd /opt sudo mkdir yowsup-config sudo wget -N https://github.com/tgalal/yowsup/archive/master.zip sudo unzip -o master.zip rm master.zip
Vor den weiteren Schritten sollte man nun erstmal die yowsup Verzeichnisse dem fhem-user zugängig machen:
sudo chown -R fhem:dialout /opt/yowsup-master /opt/yowsup-config
Für die folgenden Schritte würde ich auf den FHEM-Nutzer wechseln:
sudo su - fhem cd /opt/yowsup-master
Nun erfolgt die Anmeldung am WhatsApp-Server. Dies kann man nun via voice
oder sms
machen. Bei einem Handy bietet sich SMS an, bei Festnetzanschlüssen sollte voice gewählt werden, wenn man sich nicht sicher ist, dass der Anschluss die Funktion 'SMS im Festnetz' unterstützt. Dann wird der Bestätigungscode zwar auf Englisch vorgelesen, dafür ist die Zuverlässigkeit des Registrierungsvorganges zuverlässiger. Bei Festnetznummern sollte man unbedingt etwas zum Schreiben bereit halten! (49XXXXXXXX durch Eure Telefonnummer ersetzen.)
yowsup-cli registration --requestcode sms --config-phone 49XXXXXXXX --config-cc 49
Die Rückmeldung ist nun entscheidend. Wenn man diese zurückbekommt:
de sms status: fail retry_after: 3600 reason: no_routes
Dann ist die Nummer so nicht kompatibel. Was man dann noch probieren kann, ist die registration via voice - meistens ist das aber vergebene Liebesmüh'.
Wenn man folgende Rückmeldung bekommt:
Detected cc: 49 status: sent retry_after: 1805 length: 6 method: sms
So ist alles gut gelaufen und man sollte kurz später eine SMS bekommen. Darin ist ein Text, der am Ende z.B. 123-456 lautet. Diesen fügt man ohne Bindestrich am Ende des folgenden Befehls ein (49XXXXXXXX durch Eure Telefonnummer ersetzen.):
python yowsup-cli registration --config-phone 49XXXXXXXX -R 123456
Dann kommt ein Text der etwa so aussehen sollte:
{ "__version__": 1, "cc": "49", "client_static_keypair": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "expid": "xxxxxxxxxxxxxxxxxxxxxxxx", "fdid": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxx", "mcc": "000", "mnc": "000", "phone": "49xxxxxxxxxx", "sim_mcc": "000", "sim_mnc": "000" }
Yowsup legt eine neue Konfigurationsdatei im unter $HOME/.config/49xxxxxxxxxx/. Diese wird automatisch herangezogen, wenn die entsprechende Telefonnummer mit --config-phone 49XXXXXXXX angegeben wird.
Nun mal ein schneller Test an die eigene Nummer (im Beispiel 491751234567):
python yowsup-cli demos --config-phone 49XXXXXXXX -s 491751234567 "Das ist ein Test"
Das sollte dir eine Nachricht einbringen. Wenn du darauf antwortest, kommt diese allerdings noch nicht an - der Client hat sich nach dem Befehl sofort beendet. Damit dieser dauerhaft im Hintergrund läuft legen wir nun in FHEM ein Gerät an, welches dies steuert.
FHEM Define
- FHEM Device anlegen:
define <name> yowsup
, also z.B.define WhatsApp yowsup
- Nun muss man den Pfad zu yowsup anpassen:
attr WhatsApp cmd /opt/yowsup-master/yowsup-cli demos -c /opt/yowsup-config/yowsup.config --yowsup
- Und das Home directory mit dem Pfad zum Home des fhem users:
attr WhatsApp home PWD
- Wenn alles gut geht, gibt es danach im Device ein internal PID und das Reading state
- Im Whatsapp Client auf dem Handy sollte man sehen, dass FHEM online ist
- Zum Senden aus FHEM kann man das Kommando
set WhatsApp send <nummer> <text>
verwenden
Attribute
Bitte sieh immer in der commandref/yowsup nach - diese hier könnten veraltet sein.
cmd
komplettes Kommando, um den yowsup Client zu starten. z.B.:attr WhatsApp cmd /opt/yowsup-master/yowsup-cli demos -c /opt/yowsup-config/yowsup.config --yowsup
. Wenn die ab yowsup-Version 2.4 standartmässig aktivierte Verschlüsselung abgeschaltet werden muss weil die entsprechenden Libs nicht installiert sind:attr WhatsApp cmd /opt/local/bin/yowsup-cli demos -c /root/yowsup-config --yowsup -M
.acceptFrom
kommagetrennte Liste von Kontakten (Nummern), von denen Nachrichten akzeptiert werden. Ist das Attribut nicht gesetzt, so werden die Nachrichten von jedem akzeptiert.commandPrefix
nicht gesetzt -> es werden keine Befehle akzeptiert.
0 -> es werden keine Befehle akzeptiert.
1 -> erlaubt Befehle, jede Nachricht wird als FHEM-Befehl interpretiert.
alles andere -> Wenn die Nachricht mit diesem Prefix startet, wird alles weitere als Befehle interpretiert.
![Emblem-question-yellow.svg](/w/images/thumb/a/aa/Emblem-question-yellow.svg/20px-Emblem-question-yellow.svg.png)
allowedCommands
Eine Komma-getrennte Liste von zulässigen Befehlen für diesen Kontakt. Wenn die Liste leer ist (z.B. nur ein Komma), dann werden keine Befehle akzeptiert.home
Setzt das Home-directory welches für yowsup verwendet werden soll.
Befehle
- image -> Über diesen Befehl können Bilder gesendet werden.
- raw -> Status ändern :
set WhatsApp raw /profile setStatus 'mein Status' <--- die ' ' müssen bleiben
Name der angezeigt werden soll, wenn eine Nachricht z.B. ans iPhone geschickt wird:
set WhatsApp raw /presence name <DeinNick>
Anzeige online :
set WhatsApp raw /presence available
Profilbild ändern :
set WhatsApp raw /profile setPicture '/opt/fhem/fhem_logo.png'
<--- der gesamte Pfad zum Bild muss angegeben werden und Rechte müssen ggfs. bei fhem liegen
Falls es nicht funktioniert disconnect/connect probieren.
Update
Da am WhatsApp ständig geschraubt wird, bedarf es eines Updates des Yowsup, wenn keine Funktion mehr gegeben ist:
cd /opt sudo rm master.zip sudo mv yowsup-master yowsup-master-alt sudo wget -N https://github.com/tgalal/yowsup/archive/master.zip #alternativ sudo wget https://github.com/jlguardi/yowsup/archive/master.zip (Stand März 2016 aktueller) sudo unzip master.zip sudo chown fhem yowsup-master -R sudo chgrp dialout yowsup-master -R
Danach muss FHEM mittels 'shutdown restart' neu gestartet werden.
Anwendungsbeispiele
Beispielnachricht
Beim Empfang einer Nachricht wird automatisch ein FHEM Device für diesen Kontakt angelegt. In diesem Device gibt es das Reading message für die empfangene Nachricht und ab der ersten Nachricht auch das Reading chatstate, in dem zu sehen ist, ob gerade getippt wird. Nachdem ein Device für einen Kontakt angelegt ist, lässt sich auch direkt dieses Device zum Senden verwenden:
set <device> send <text>
,
d.h., man spart sich die Angabe der Nummer.
Gruppen
Gruppen müssen über die App (Smartphone / Tablet) angelegt werden. Nach dem Empfang einer entsprechenden Nachricht werden Gruppen genauso behandelt, wie einfache Teilnehmer.
Broadcast
Beim Senden über das Masterdevice lassen sich mehrere Empfänger mit Komma (und ohne Leerzeichen) getrennt angeben. Die entsprechenden Nachrichten werden dann per Broadcast an alle Teilnehmer gesendet. Die Broadcastempfänger müssen zuvor mindestens eine normale Nachricht erhalten haben.
Komponenten steuern
Um ein notify anlegen zu können, müssen wir zuerst eine Nachricht vom Handy an FHEM senden. Dadurch wird ein Device mit der Nummer als Namen angelegt. Danach sollte das Device umbenannt werden, da einige Befehle einen Namen ausschließlich aus Ziffern nicht akzeptieren. Dies geschieht wie folgt:
rename 49123456789 HandySeppel
Danach kann ein notify angelegt werden:
define notifySeppelLicht notify HandySeppel:message.* {
if( $EVENT eq 'message: Licht an' ) {
fhem "set HandySeppel send Licht ist nun an...";
fhem "set FS20_a5d800 dim100%";
} elsif( $EVENT eq 'message: Licht aus' ) {
fhem "set HandySeppel send Licht ist nun aus...";
fhem "set FS20_a5d800 dim0%";
} else {
fhem "set HandySeppel send Wie bitte?"
}
}
Natürlich ist dieses notify noch auf die eigenen Wünsche anzupassen.
Autoresponder
Nachdem man nun seine Festnetznummer bei WhatsApp registriert hat, wird auch diese natürlich als erreichbares Ziel auf jedem Gerät angezeigt, auf dem sie gespeichert ist. So kann es passieren, dass WhatsApp-Nachrichten nicht gelesen werden. Hier schafft ein Autoresponder Abhilfe:
define not_WhatsApp_Autoresponder notify 491.*:message.* set $NAME send Hallo, Du hast eine Nachricht an unsere Festnetznummer geschickt. Da ist aber nur ein kleiner Computer auf Empfang, der Dir nur diese Antwort schicken kann. Bitte benutze unsere Mobilnummern, wenn Du willst, dass Deine Nachricht auch gelesen wird!
Das Problem hierbei ist, dass noch nicht bekannt ist, wer etwas sendet und so der Kontakt u.U. noch nicht angelegt ist. Daher wird im obigen Beispiel auf 491*:message.* reagiert. So bekommen nur deutsche Mobilrufnummern die Antwort. Um das noch globaler zu fassen, könnte z.B. auf \d*.*:message.* reagiert werden, was aber voraussetzt, dass keine weiteren Modulnamen (die das Reading message haben) mit einer Ziffer beginnen. Alle Kontakte, welche nicht den Autoresponder erhalten sollen, müssen wie oben beschrieben entspr. umbenannt werden:
rename 49123456789 HandySeppel
Probleme und Lösungen
Immer wieder offline
Das WhatsApp Device geht immer wieder offline und im Log wird folgendes protokolliert:
... yowsup.layers.axolotl.layer_receive:invalidmessage or keyid for ...
Lösung:
Verzeichnis .yowsup in /root löschen. Das Verzeichnis entsteht durch das Testen auf der Konsole und verträgt sich dann nicht mit dem im Attribut home hinterlegten Verzeichnis.
UTF-8 Fehler
Lösung: https://forum.fhem.de/index.php/topic,27543.msg773746.html#msg773746
Links
- Forenthread, in dem die Whatsapp Anwendung beschrieben wird
- Foreneintrag, ab dem das yowsup Modul beschrieben wird
- Die Python Whatsapp Library auf github
- Imagehandling Bugfix github