{{SEITENTITEL:yowsup}}
{{Infobox Modul
|ModPurpose=Schnittstelle, um WhatsApp-Nachrichten empfangen und senden zu können.
|ModType=d
|ModCmdRef=yowsup
|ModFTopic=27543
|ModForumArea=Unterstuetzende Dienste
|ModTechName=32_yowsup.pm
|ModOwner=André / justme1968 ({{Link2FU|430|Forum}} / [[Benutzer Diskussion:justme|Wiki]])
}}

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 {{Link2Forum|Topic=27543|Message=204426|LinkText=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 (Python 2.7) ===
Bevor man loslegt sollte man wie immer sicherstellen, dass Debian auf dem aktuellen Stand ist:<br>
<code>sudo apt-get update</code><br>
<code>sudo apt-get upgrade</code><br>
<code>sudo apt-get dist-upgrade</code><br>

Los gehts mit den Paketen:<br>
<code>sudo apt-get install python-soappy python-dateutil python-pip python-dev build-essential libssl-dev libffi-dev</code><br>

Nun erstmal pip updaten:<br>
<code>sudo pip install --upgrade pip</code><br>

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):<br>
<code>sudo pip uninstall six</code><br>
<code>sudo pip install six==1.10</code>

Und dann Axolotl, argparse, readline installieren (das dauert ne Weile):<br>
(eventuell wird auch noch appdirs benötigt)<br>
<code>sudo pip install argparse</code><br>
<code>sudo pip install readline</code><br>
<code>sudo pip install appdirs</code><br>
<code>sudo pip install python-axolotl</code><br>

Zudem wird neben den Python Modulen noch eine Lib's von tgalal benötigt:
<pre>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</pre>

<pre>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</pre>

<pre>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</pre>

Will man Bilder verarbeiten, so braucht man noch ein paar Pakete mehr:
* Paketinstallationen:
** Unter Debian Wheezy: <code>sudo apt-get install libtiff4-dev libjpeg8-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.5-dev tk8.5-dev python-tk</code>
** Unter Debian Jessie: <code>sudo apt-get install libtiff5-dev libjpeg-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.5-dev tk8.5-dev python-tk</code>
* PIP:<code>sudo pip install pillow</code>

Vor den weiteren Schritten sollte geprüft werden, ob dem User fhem eine Loginshell zugewiesen ist:
:<code>getent passwd fhem</code>
Wird hier am Ende /bin/false ausgegeben, so muss dies angepasst werden:
:<code>sudo chsh -s /bin/bash fhem</code>

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:
<pre>sudo su - fhem
echo $HOME
cd $HOME
logout</pre>
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:
<pre>
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
</pre>

Vor den weiteren Schritten sollte man nun erstmal die yowsup Verzeichnisse dem fhem-user zugängig machen:
<pre>sudo chown -R fhem:dialout /opt/yowsup-master /opt/yowsup-config</pre>

Für die folgenden Schritte würde ich auf den FHEM-Nutzer wechseln:
<pre>sudo su - fhem
cd /opt/yowsup-master</pre>

Nun erfolgt die Anmeldung am WhatsApp-Server. Dies kann man nun via <code>voice</code> oder <code>sms</code> 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.)<br>
<pre>yowsup-cli registration --requestcode sms --config-phone 49XXXXXXXX --config-cc 49</pre>

Die Rückmeldung ist nun entscheidend. Wenn man diese zurückbekommt:
<pre>de sms
status: fail
retry_after: 3600
reason: no_routes</pre>
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:
<pre>I 2019-04-24 15:05:22,368 yowsup.common.http.warequest - {"login":"49xxxxxxxxxx","status":"sent","length":6,"method":"sms","retry_after":65,"sms_wait":65,"voice_wait":65}

status: sent
voice_wait: 65
retry_after: 65
sms_wait: 65
length: 6
login: 49xxxxxxxxxx
method: sms</pre>

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.):<br>
<pre>python yowsup-cli registration --config-phone 49XXXXXXXX -R 123456</pre>

Dann kommt ein Text der etwa so aussehen sollte:
<pre>I 2019-04-24 15:15:09,118 yowsup.common.http.warequest - {"status":"ok","login":"49xxxxxxxxxx","type":"existing","edge_routing_info":"CAUIAg==","chat_dns_domain":"fb","security_code_set":false}

{
"__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"
}</pre><br>

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):
<pre>python yowsup-cli demos --config-phone 49XXXXXXXX -s 491751234567 "Das ist ein Test"</pre>

Hier seht ihr nun einen Status (die Anzahl prekeys wird hoch gezählt):
<pre>I 2019-04-24 15:33:58,647 yowsup.layers.network.layer - Connecting to e7.whatsapp.net:443
I 2019-04-24 15:33:59,230 yowsup.axolotl.manager - Generating 812 prekeys
I 2019-04-24 15:34:15,590 yowsup.axolotl.manager - Storing 812 prekeys
I 2019-04-24 15:35:03,100 yowsup.axolotl.manager - Loaded 812 unsent prekeys</pre>

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.

==== Yowsup Installation (Python 3.5) ====
Bevor man loslegt sollte man wie immer sicherstellen, dass Debian auf dem aktuellen Stand ist:<br>
<code>sudo apt-get update</code><br>
<code>sudo apt-get upgrade</code><br>
<code>sudo apt-get dist-upgrade</code><br>
sudo apt-get install python3-setuptools
sudo apt-get install python3-dev
sudo apt-get install python3-pip

Los gehts mit den Paketen:<br>
<code>sudo apt-get install python3-pip python3-dev python3-setuptools python-soappy python-dateutil build-essential libssl-dev libffi-dev</code><br>

Nun erstmal pip updaten:<br>
<code>sudo pip3 install --upgrade pip</code><br>

yowsup benötigt zwingend von six die Version 1.10 (unter /usr/local/lib/python3.5/dist-packages prüfen, ob eine andere Version von six installiert ist. Diese erst löschen):<br>
<code>sudo pip3 uninstall six</code><br>
<code>sudo pip3 install six==1.10</code>

Und dann Axolotl, argparse, readline installieren (das dauert ne Weile):<br>
(eventuell wird auch noch appdirs benötigt)<br>
<code>sudo pip3 install argparse</code><br>
<code>sudo pip3 install readline</code><br>
<code>sudo pip3 install appdirs</code><br>
<code>sudo pip3 install python-axolotl</code><br>

Zudem wird neben den Python Modulen noch Lib's von tgalal benötigt:
<pre>cd /opt/fhem/yowsup
sudo wget https://github.com/tgalal/python-axolotl/archive/master.zip
sudo unzip master.zip
cd python-axolotl-master
sudo python3 setup.py install
cd ..
rm master.zip</pre>

<pre>cd /opt/fhem/yowsup
sudo wget https://github.com/tgalal/dissononce/archive/master.zip
sudo unzip master.zip
cd dissononce-master
sudo python3 setup.py install
cd ..
rm master.zip</pre>

<pre>cd /opt/fhem/yowsup
sudo wget https://github.com/tgalal/consonance/archive/master.zip
sudo unzip master.zip
cd consonance-master
sudo python3 setup.py install
cd ..
rm master.zip</pre>

Desweiteren muss man nun yowsup installieren:
<pre>
cd /opt
sudo mkdir yowsup-config
sudo wget -N https://github.com/tgalal/yowsup/archive/master.zip
sudo unzip -o master.zip
cd yowsup-master
sudo python3 setup.py install
cd ..
rm master.zip
</pre>

Will man Bilder verarbeiten, so braucht man noch ein paar Pakete mehr:
* Paketinstallationen:
** Unter Debian Wheezy: <code>sudo apt-get install libtiff4-dev libjpeg8-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.5-dev tk8.5-dev python-tk</code>
** Unter Debian Jessie: <code>sudo apt-get install libtiff5-dev libjpeg-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.5-dev tk8.5-dev python-tk</code>
** Unter Debian Stretch: <code>sudo apt-get install libtiff5-dev libjpeg-dev zlib1g-dev libfreetype6-dev liblcms2-dev libwebp-dev tcl8.5-dev tk8.5-dev python-tk</code>
* PIP:<code>sudo pip3 install pillow</code>

==== Fhem vorbereiten ====
Vor den weiteren Schritten sollte geprüft werden, ob dem User fhem eine Loginshell zugewiesen ist:
:<code>getent passwd fhem</code>
Wird hier am Ende /bin/false ausgegeben, so muss dies angepasst werden:
:<code>sudo chsh -s /bin/bash fhem</code>

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:
<pre>sudo su - fhem
echo $HOME
cd $HOME
logout</pre>
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.

Vor den weiteren Schritten sollte man nun erstmal die yowsup Verzeichnisse dem fhem-user zugängig machen:
<pre>sudo chown -R fhem:dialout /opt/yowsup-master /opt/yowsup-config</pre>

Für die folgenden Schritte würde ich auf den FHEM-Nutzer wechseln:
<pre>sudo su - fhem
cd /opt/yowsup-master</pre>

==== WhatsApp einrichten ====
Nun erfolgt die Anmeldung am WhatsApp-Server. Dies kann man nun via <code>voice</code> oder <code>sms</code> 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.)<br>
<pre>python3 yowsup-cli registration --requestcode sms --config-phone 49XXXXXXXX --config-cc 49</pre>

Die Rückmeldung ist nun entscheidend. Wenn man diese zurückbekommt:
<pre>de sms
status: fail
retry_after: 3600
reason: no_routes</pre>
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:
<pre>I 2019-04-24 15:05:22,368 yowsup.common.http.warequest - {"login":"49xxxxxxxxxx","status":"sent","length":6,"method":"sms","retry_after":65,"sms_wait":65,"voice_wait":65}

status: sent
voice_wait: 65
retry_after: 65
sms_wait: 65
length: 6
login: 49xxxxxxxxxx
method: sms</pre>

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.):<br>
<pre>python3 yowsup-cli registration --config-phone 49XXXXXXXX -R 123456</pre>

Dann kommt ein Text der etwa so aussehen sollte:
<pre>I 2019-04-24 15:15:09,118 yowsup.common.http.warequest - {"status":"ok","login":"49xxxxxxxxxx","type":"existing","edge_routing_info":"CAUIAg==","chat_dns_domain":"fb","security_code_set":false}

{
"__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"
}</pre><br>

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):
<pre>python3 yowsup-cli demos --config-phone 49XXXXXXXX -s 491751234567 "Das ist ein Test"</pre>

Hier seht ihr nun einen Status (die Anzahl prekeys wird hoch gezählt):
<pre>I 2019-04-24 15:33:58,647 yowsup.layers.network.layer - Connecting to e7.whatsapp.net:443
I 2019-04-24 15:33:59,230 yowsup.axolotl.manager - Generating 812 prekeys
I 2019-04-24 15:34:15,590 yowsup.axolotl.manager - Storing 812 prekeys
I 2019-04-24 15:35:03,100 yowsup.axolotl.manager - Loaded 812 unsent prekeys</pre>

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: <code> define <name> yowsup</code>, also z.B. <code>define WhatsApp yowsup</code>
* Nun muss man den Pfad zu yowsup anpassen: <code>attr WhatsApp cmd /opt/yowsup-master/yowsup-cli demos --config-phone 49XXXXXXXX --yowsup</code>
* Und das Home directory mit dem Pfad zum Home des fhem users: <code>attr WhatsApp home PWD</code>
* 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 <code>set WhatsApp send <nummer> <text></code> verwenden

== Attribute ==
Bitte sieh immer in der {{Link2CmdRef|Anker=yowsup}} nach - diese hier könnten veraltet sein.

* <code>cmd</code><br />komplettes Kommando, um den yowsup Client zu starten. z.B.: <code>attr WhatsApp cmd /opt/yowsup-master/yowsup-cli demos -c /opt/yowsup-config/yowsup.config --yowsup</code>. Wenn die ab yowsup-Version 2.4 standartmässig aktivierte Verschlüsselung abgeschaltet werden muss weil die entsprechenden Libs nicht installiert sind: <code>attr WhatsApp cmd /opt/local/bin/yowsup-cli demos -c /root/yowsup-config --yowsup -M</code>.
* <code>acceptFrom</code><br />kommagetrennte Liste von Kontakten (Nummern), von denen Nachrichten akzeptiert werden. Ist das Attribut nicht gesetzt, so werden die Nachrichten von jedem akzeptiert.
* <code>commandPrefix</code><br />nicht gesetzt -> es werden keine Befehle akzeptiert.<br />0 -> es werden keine Befehle akzeptiert.<br />1 -> erlaubt Befehle, jede Nachricht wird als FHEM-Befehl interpretiert.<br />alles andere -> Wenn die Nachricht mit diesem Prefix startet, wird alles weitere als Befehle interpretiert.
{{Randnotiz|RNTyp=Warn|RNText='''allowedCommands''' should work as intended, but no guarantee can be given, that there is no way to circumvent it.}}
* <code>allowedCommands</code><br />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.
* <code>home</code><br />Setzt das Home-directory welches für yowsup verwendet werden soll.

== Befehle ==
* image -> Über diesen Befehl können Bilder gesendet werden.

* raw -> Status ändern :
<code>set WhatsApp raw /profile setStatus 'mein Status' <--- die ' ' müssen bleiben</code>

Name der angezeigt werden soll, wenn eine Nachricht z.B. ans iPhone geschickt wird:

<code>set WhatsApp raw /presence name <DeinNick></code>

Anzeige online :

<code>set WhatsApp raw /presence available</code>

Profilbild ändern :

<code>set WhatsApp raw /profile setPicture '/opt/fhem/fhem_logo.png'</code>
<--- 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:
<pre>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</pre>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:
:<code>set <device> send <text></code>,
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:

:<code>rename 49123456789 HandySeppel</code>

Danach kann ein ''notify'' angelegt werden:

<syntaxhighlight lang="perl">
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?"

}
}</syntaxhighlight>

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:
:<code>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!</code>
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:
:<code>rename 49123456789 HandySeppel</code>

== 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 ==
* {{Link2Forum|Topic=27543|LinkText=Forenthread}}, in dem die Whatsapp Anwendung beschrieben wird
* {{Link2Forum|Topic=27543|Message=299292|LinkText=Foreneintrag}}, ab dem das yowsup Modul beschrieben wird
* Die Python Whatsapp Library auf [https://github.com/tgalal/yowsup github]
* Imagehandling Bugfix [https://github.com/tgalal/yowsup/issues/901 github]

[[Kategorie:WhatsApp]]

Yowsup

2019-05-07T18:30:33Z

2016-10-28T15:46:04Z

JoWiemann: /* TH10 / TH16 weitere GPIO zugänglich machen */

'''sonoff Switch, dieser Artikel beschreibt die Ankopplung des kostengünstigen sonoff Switch an FHEM mit ESPEasy.'''

Seit einiger Zeit werden von der [https://www.itead.cc/sonoff-wifi-wireless-switch.html Fa. Itead] kostengünstige "sonoff" Produkte angeboten die glücklicherweise den [http://dl.itead.cc/IM151116002/0A-ESP8266_Specifications_v4.1.pdf ESP8266 Chip] On Board haben und somit die ideale Grundlage für [http://www.esp8266.nu/index.php/Main_Page ESPEasy] und für [https://forum.fhem.de/index.php/board,46.0.html Fhem] darstellen.

'''Nützliche Links zum Hersteller:'''

[https://www.itead.cc/blog/user-guide-for-sonoff-slampher User Manual von Itead]

[https://www.itead.cc/wiki/images/6/6b/Sonoff_schmatic.pdf Sonoff Schaltplan]
<div style="clear:both;"></div>

[[Datei:sonoff_sw_0.jpg|thumb|left|alt=sonoff Switch]]
<div style="clear:both;"></div>
Das sonoff Modul ist in einem zweckmäßigen und gefälligem Gehäuse verbaut!

[[Datei:sonoff_sw_15.jpg|thumb|left|alt=Warnung Netzspannung]]
<div style="clear:both;"></div>
'''Bitte unbedingt die elektrotechnischen Sicherheitsrichtlinien beachten und einhalten!'''
<div style="clear:both;"></div>

=Hardware=
==Platine==
[[Datei:sonoff_sw_1.jpg|thumb|left|alt=sonoff Switch von vorne]]

Die Platine ist sehr übersichtlich aufgebaut und der Hersteller hat auch alle Vorbereitungen zum Flashen einer alternativen Software vorgesehen (über serielle Schnittstelle via FTDI-Modul). Mit einer alternativen Software wie ESPEasy ist eine direkte Ankopplung des '''sonoff''' an FHEM somit ein leicht durchführbarer Vorgang.
<div style="clear:both;"></div>

[[Datei:sonoff_sw_3.jpg|thumb|left|alt=sonoff Switch von hinten]]
'''Achtung: An dem Modul liegt Netzspannung an die lebensgefährlich ist. Es dürfen nur entsprechend ausgebildete Personen dieses Modul in Betrieb nehmen. Zum Umbau und zur Softwareaktualisierung darf keine Netzspannung angeschlossen sein'''

Die stromführenden Leitungen wurden mit Lötzinn vom Hersteller verstärkt um die angegebenen Stromstärken mit geringer Hitzeentwicklung zu transportieren.

<div style="clear:both;"></div>
'''

==Vorbereitungen zum Flashen==
[[Datei:sonoff_sw_2.jpg|thumb|left|alt=serielle Schnittstelle]]

Hier auf der Platine sind die benötigten Signale für ein FTDI Modul schon vorhanden. Der quadratische Pin gleich über dem Taster ist die Spannungsversorgung zum Flashen vom FDTI von 3.3V Es muss daher unbedingt ein FTDI Modul genommen werden, dass nicht nur einen Jumper für 3.3V besitzt sondern auch die Spannung auf 3.3V herab setzt. Ist dies nicht der Fall, läuft man Gefahr das Modul unbrauchbar zu machen. Es ist daher zu empfehlen einen Spannungsteiler mit 2 Widerständen oder einen Pegelwandler zwischenschalten.
<div style="clear:both;"></div>

==Signale der Schnittstelle==
von oben nach unten auf der Steckerleiste des sonoff U4.

Pin5 = vorbereitet für GPIO
Pin4 = Masse
Pin3 = TxD
Pin2 = RxD
Pin1 = 3.3V

Siehe dazu auch den [https://forum.fhem.de/index.php/topic,55036.0.html Link aus dem Forum]:
<div style="clear:both;"></div>

==Platine mit Stiftleiste bestücken==
[[Datei:sonoff_sw_4.jpg|thumb|left|alt=Platine mit Stiftleiste bestücken]]
Der Hersteller hat zwar schon die Platine vorbereitet, jedoch muss sie noch mit einer Stiftleiste bestückt werden um das FTDI Modul bequem verbinden zu können. Nachdem einmal ESPEasy geflasht worden ist, kann es in Zukunft via WEB geflasht werden und die Stiftleiste ist dann nicht mehr erforderlich. Aufgrund der geringen Kosten fällt dies jedoch nicht ins Gewicht.
<div style="clear:both;"></div>''
'''''Achtung''': Bitte vor den Arbeiten kontrollieren, das an der Platine keine Netzspannung angeschlossen ist, LEBENSGEFAHR!
<div style="clear:both;"></div>''

==TH10 / TH16 weitere GPIO zugänglich machen==
[[Datei:Sonoff_TH_10A-16A_kleiner.jpg|thumb|left|alt=TH10 / TH16 weitere GPIO zugänglich machen]]
Der Hersteller hat zwar schon Platine für eine weitere Stiftleiste vorbereitet, jedoch muss diese noch bestückt werden und kann dann genutzt werden um verdeckte GPIO zugänglich zu machen. Die Verdrahtung kann dem Bild entnommen werden.
<div style="clear:both;"></div>''
'''''Achtung''': Bitte vor den Arbeiten kontrollieren, das an der Platine keine Netzspannung angeschlossen ist, LEBENSGEFAHR!
<div style="clear:both;"></div>''

=Software=
==ESPEasy flashen==
[[Datei:sonoff_sw_6.jpg|thumb|left|alt=sonoff mit angestecktem FDTI Adapter]]
Die Spannungsversorgung des sonoff Moduls wird hier vom FTDI Konverter mit 3.3V über die Verbindungskabel zum Pfostenstecker durchgeführt.

Der FTDI Adapter wird dann mit der USB Schnittstelle mit dem Computer verbunden.

<div style="clear:both;"></div>

===mit Arduino compilieren===
[[Datei:sonoff_sw_10.jpg|thumb|left|alt=Einstellung Arduino IDE]]
Wer selber mit der Arduino IDE compilieren will bitte folgende Einstellungen beachten. Die anschließenden Arbeiten sind dann gleich wie bei Abschnitt '''fertige Binary'''.

Unbedingt die neueste Arduino Json Library benutzen! Es gibt zwar keine Compilerfehler, aber es kommt anschließend zu Fehlfunktionen in der ESP Bridge!

<div style="clear:both;"></div>
Generic ESP8266 Module
Flash Mode: QIO
Flash Frequency: 40 MHz
CPU Frequency: 80 MHz
Flash Size: 1M (64K SPIFFS)
Debug Port: disabled
Debug Level: none
Reset Mode: ck
Upload Speed: 115200
<div style="clear:both;"></div>
===fertige Binary flashen===
[[Datei:sonoff_sw_7.jpg|thumb|left|alt=NodeMCU Firmware Flasher]]
Es empfiehlt sich eine fertige Binary von ESPEasy aufzuspielen. In diesem Wiki wurde R140 verwendet.

Siehe dazu auch den [http://www.esp8266.nu/index.php/Main_Page Link von ESPEasy] und das [https://learn.adafruit.com/building-and-running-micropython-on-the-esp8266/flash-firmware Handbuch] für den Flasher.
<div style="clear:both;"></div>
Netzspannung darf 'NICHT' angeschlossen sein!!!
Taster am Sonoff gedrückt halten
FTDI Adapter verbinden
Taster am Sonoff los lassen
Sketch übertragen
Sonoff vom FTDI trennen
<div style="clear:both;"></div>
Wenn einmal die Firmware auf das sonoff Modul geflasht worden ist, kann in Zukunft ESPEasy direkt unter Tools via HTTP dies durchführen. Es muss dazu kein FTDI Konverter mehr verwendet werden.

==ESPEasy==
[[Datei:sonoff_sw_11.jpg|thumb|left|alt=ESPEasy Devices]]
Wenn das Modul fertig geflasht ist und die Verbindung zum Modul hergestellt ist, können die Einstellungen in ESPEasy durchgeführt werden.
Dazu am Webinterface anmelden und zunächst die 2 Devices definieren.

Der Hersteller hat für das '''Relaise GPIO 12''' und für die '''grüne Led GPIO 13''' vorgesehen. Der '''Taster ist an GPIO 0''' angeschlossen.
<div style="clear:both;"></div>

===Device Schalter===
[[Datei:sonoff_sw_12.jpg|thumb|left|alt=Device Relais]]
Bei den Devices sollten die hier dargestellte Einstellungen beachtet werden. Der Switch (PUMP) sollte auf Input gestellt werden, sodass die anschließenden und benötigten Rules aktiviert werden können.

Da beide Devicenamen gleich benannt wurden (PUMP) wird in Fhem nur ein Device angelegt! Die dazugehörenden Valunames sind unterschiedlich (Relay, Key).

<div style="clear:both;"></div>

===Device Taster===
[[Datei:sonoff_sw_13.jpg|thumb|left|alt=Device Key]]
Der Taste muss natürlich nur konfiguriert werden, wenn auch händisch am sonoff geschaltet werden soll. Wird dies nicht benötigt, können auch die Rules geändert bzw. angepasst werden. Doch alleine zu Testzwecken ist es eine nützliche Sache.
<div style="clear:both;"></div>

===Rules===
[[Datei:sonoff_sw_14.jpg|thumb|left|alt=Rules]]
Da das sonoff Modul auch einen eingebauten Taster hat und somit auch lokal bedient werden kann, sollte man zunächst unter '''Tools / Advanced das Häckchen Rules''' aktivieren, erst dann wird der Tab sichtbar und es können Rules erstellt werden.
<div style="clear:both;"></div>

on PUMP#Key do
if [PUMP#Relay]=1
gpio,12,0
else
gpio,12,1
endif
endon
on PUMP#Relay do
if [PUMP#Relay]=1
gpio,13,0
else
gpio,13,1
endif
endon
Diese Rules ermöglichen, das bei lokaler Bedienung durch den Taster auch die '''Led''' richtig geschaltet wird.
Mit 'on PUMP#Key do' wird geprüft ob die Taste gedrückt ist und schaltet dann entsprechend die Led. Mit den Rules können auch Timer oder sonstige Spielereien realisiert werden. Siehe dazu das [http://www.esp8266.nu/index.php/Tutorial_Rules Tutorial] von ESPeasy.
<div style="clear:both;"></div>

==Fhem==
[[Datei:sonoff_sw_9.jpg|thumb|left|alt=Fhem Konfiguration]]
Dies ist eine einfache Darstellung wie Fhem automatisch den Device erstellt.

Damit Fhem mit ESPEasy und dem sonoff Modul kommunizieren kann, muss in der fhem.cfg vorerst nur die espBridge mit dem hier dargestellten Eintrag aktiviert werden.
<div style="clear:both;"></div>
define espBridge ESPEasy bridge 8383
Dies ist eigentlich die einzige Zeile die in fhem.cfg angelegt werden muss. Die restliche Konfiguration wird von Fhem automatisch generiert.

##########################################
### ESPEASY ####
##########################################

define ESPEasy_sonoff_1_PUMP ESPEasy 10.0.0.37 80 espBridge sonoff_1_PUMP
attr ESPEasy_sonoff_1_PUMP IODev espBridge
attr ESPEasy_sonoff_1_PUMP devStateIcon on:rc_GREEN:off off:rc_RED:on absent:rc_BLUE:off gpio:rc_YELLOW:off
attr ESPEasy_sonoff_1_PUMP eventMap /gpio 12 on:on/gpio 12 off:off/gpio 12 gpio:off/gpio 12 output:off/
attr ESPEasy_sonoff_1_PUMP group ESPEasy Device
attr ESPEasy_sonoff_1_PUMP icon hue_filled_outlet
attr ESPEasy_sonoff_1_PUMP room ESPEasy
attr ESPEasy_sonoff_1_PUMP setState 0
attr ESPEasy_sonoff_1_PUMP stateFormat {ReadingsVal($name,"presence","") eq "absent" ? "absent" : ReadingsVal($name,"Relay","")}
attr ESPEasy_sonoff_1_PUMP webCmd :

hier ein Beispiel wie es auch manuell leicht modifiziert werden kann.

[[Datei:sonoff_sw_8.jpg|thumb|left|alt=sonoff Readings]]

Die Readings werden durch die Bridge (Modul ESPEasy) automatisch angelegt.

Es besteht hier noch genug Spielraum um zB. auch noch Temperatursensoren an das Modul anzuschließen und ebenfalls in Fhem darzustellen.
<div style="clear:both;"></div>

[[Kategorie:Other Components]]
[[Kategorie:IP Components]]

Datei:Sonoff TH 10A-16A kleiner.jpg

2016-10-28T15:44:34Z

JoWiemann:

Sonoff

2016-10-28T15:43:25Z

JoWiemann:

'''sonoff Switch, dieser Artikel beschreibt die Ankopplung des kostengünstigen sonoff Switch an FHEM mit ESPEasy.'''

Seit einiger Zeit werden von der [https://www.itead.cc/sonoff-wifi-wireless-switch.html Fa. Itead] kostengünstige "sonoff" Produkte angeboten die glücklicherweise den [http://dl.itead.cc/IM151116002/0A-ESP8266_Specifications_v4.1.pdf ESP8266 Chip] On Board haben und somit die ideale Grundlage für [http://www.esp8266.nu/index.php/Main_Page ESPEasy] und für [https://forum.fhem.de/index.php/board,46.0.html Fhem] darstellen.

'''Nützliche Links zum Hersteller:'''

[https://www.itead.cc/blog/user-guide-for-sonoff-slampher User Manual von Itead]

[https://www.itead.cc/wiki/images/6/6b/Sonoff_schmatic.pdf Sonoff Schaltplan]
<div style="clear:both;"></div>

[[Datei:sonoff_sw_0.jpg|thumb|left|alt=sonoff Switch]]
<div style="clear:both;"></div>
Das sonoff Modul ist in einem zweckmäßigen und gefälligem Gehäuse verbaut!

[[Datei:sonoff_sw_15.jpg|thumb|left|alt=Warnung Netzspannung]]
<div style="clear:both;"></div>
'''Bitte unbedingt die elektrotechnischen Sicherheitsrichtlinien beachten und einhalten!'''
<div style="clear:both;"></div>

=Hardware=
==Platine==
[[Datei:sonoff_sw_1.jpg|thumb|left|alt=sonoff Switch von vorne]]

Die Platine ist sehr übersichtlich aufgebaut und der Hersteller hat auch alle Vorbereitungen zum Flashen einer alternativen Software vorgesehen (über serielle Schnittstelle via FTDI-Modul). Mit einer alternativen Software wie ESPEasy ist eine direkte Ankopplung des '''sonoff''' an FHEM somit ein leicht durchführbarer Vorgang.
<div style="clear:both;"></div>

[[Datei:sonoff_sw_3.jpg|thumb|left|alt=sonoff Switch von hinten]]
'''Achtung: An dem Modul liegt Netzspannung an die lebensgefährlich ist. Es dürfen nur entsprechend ausgebildete Personen dieses Modul in Betrieb nehmen. Zum Umbau und zur Softwareaktualisierung darf keine Netzspannung angeschlossen sein'''

Die stromführenden Leitungen wurden mit Lötzinn vom Hersteller verstärkt um die angegebenen Stromstärken mit geringer Hitzeentwicklung zu transportieren.

<div style="clear:both;"></div>
'''

==Vorbereitungen zum Flashen==
[[Datei:sonoff_sw_2.jpg|thumb|left|alt=serielle Schnittstelle]]

Hier auf der Platine sind die benötigten Signale für ein FTDI Modul schon vorhanden. Der quadratische Pin gleich über dem Taster ist die Spannungsversorgung zum Flashen vom FDTI von 3.3V Es muss daher unbedingt ein FTDI Modul genommen werden, dass nicht nur einen Jumper für 3.3V besitzt sondern auch die Spannung auf 3.3V herab setzt. Ist dies nicht der Fall, läuft man Gefahr das Modul unbrauchbar zu machen. Es ist daher zu empfehlen einen Spannungsteiler mit 2 Widerständen oder einen Pegelwandler zwischenschalten.
<div style="clear:both;"></div>

==Signale der Schnittstelle==
von oben nach unten auf der Steckerleiste des sonoff U4.

Pin5 = vorbereitet für GPIO
Pin4 = Masse
Pin3 = TxD
Pin2 = RxD
Pin1 = 3.3V

Siehe dazu auch den [https://forum.fhem.de/index.php/topic,55036.0.html Link aus dem Forum]:
<div style="clear:both;"></div>

==Platine mit Stiftleiste bestücken==
[[Datei:sonoff_sw_4.jpg|thumb|left|alt=Platine mit Stiftleiste bestücken]]
Der Hersteller hat zwar schon die Platine vorbereitet, jedoch muss sie noch mit einer Stiftleiste bestückt werden um das FTDI Modul bequem verbinden zu können. Nachdem einmal ESPEasy geflasht worden ist, kann es in Zukunft via WEB geflasht werden und die Stiftleiste ist dann nicht mehr erforderlich. Aufgrund der geringen Kosten fällt dies jedoch nicht ins Gewicht.
<div style="clear:both;"></div>''
'''''Achtung''': Bitte vor den Arbeiten kontrollieren, das an der Platine keine Netzspannung angeschlossen ist, LEBENSGEFAHR!
<div style="clear:both;"></div>''

==TH10 / TH16 weitere GPIO zugänglich machen==
[[Datei:sonoff_sw_4.jpg|thumb|left|alt=TH10 / TH16 weitere GPIO zugänglich machen]]
Der Hersteller hat zwar schon Platine für eine weitere Stiftleiste vorbereitet, jedoch muss diese noch bestückt werden und kann dann genutzt werden um verdeckte GPIO zugänglich zu machen. Die Verdrahtung kann dem Bild entnommen werden.
<div style="clear:both;"></div>''
'''''Achtung''': Bitte vor den Arbeiten kontrollieren, das an der Platine keine Netzspannung angeschlossen ist, LEBENSGEFAHR!
<div style="clear:both;"></div>''

=Software=
==ESPEasy flashen==
[[Datei:sonoff_sw_6.jpg|thumb|left|alt=sonoff mit angestecktem FDTI Adapter]]
Die Spannungsversorgung des sonoff Moduls wird hier vom FTDI Konverter mit 3.3V über die Verbindungskabel zum Pfostenstecker durchgeführt.

Der FTDI Adapter wird dann mit der USB Schnittstelle mit dem Computer verbunden.

<div style="clear:both;"></div>

===mit Arduino compilieren===
[[Datei:sonoff_sw_10.jpg|thumb|left|alt=Einstellung Arduino IDE]]
Wer selber mit der Arduino IDE compilieren will bitte folgende Einstellungen beachten. Die anschließenden Arbeiten sind dann gleich wie bei Abschnitt '''fertige Binary'''.

Unbedingt die neueste Arduino Json Library benutzen! Es gibt zwar keine Compilerfehler, aber es kommt anschließend zu Fehlfunktionen in der ESP Bridge!

<div style="clear:both;"></div>
Generic ESP8266 Module
Flash Mode: QIO
Flash Frequency: 40 MHz
CPU Frequency: 80 MHz
Flash Size: 1M (64K SPIFFS)
Debug Port: disabled
Debug Level: none
Reset Mode: ck
Upload Speed: 115200
<div style="clear:both;"></div>
===fertige Binary flashen===
[[Datei:sonoff_sw_7.jpg|thumb|left|alt=NodeMCU Firmware Flasher]]
Es empfiehlt sich eine fertige Binary von ESPEasy aufzuspielen. In diesem Wiki wurde R140 verwendet.

Siehe dazu auch den [http://www.esp8266.nu/index.php/Main_Page Link von ESPEasy] und das [https://learn.adafruit.com/building-and-running-micropython-on-the-esp8266/flash-firmware Handbuch] für den Flasher.
<div style="clear:both;"></div>
Netzspannung darf 'NICHT' angeschlossen sein!!!
Taster am Sonoff gedrückt halten
FTDI Adapter verbinden
Taster am Sonoff los lassen
Sketch übertragen
Sonoff vom FTDI trennen
<div style="clear:both;"></div>
Wenn einmal die Firmware auf das sonoff Modul geflasht worden ist, kann in Zukunft ESPEasy direkt unter Tools via HTTP dies durchführen. Es muss dazu kein FTDI Konverter mehr verwendet werden.

==ESPEasy==
[[Datei:sonoff_sw_11.jpg|thumb|left|alt=ESPEasy Devices]]
Wenn das Modul fertig geflasht ist und die Verbindung zum Modul hergestellt ist, können die Einstellungen in ESPEasy durchgeführt werden.
Dazu am Webinterface anmelden und zunächst die 2 Devices definieren.

Der Hersteller hat für das '''Relaise GPIO 12''' und für die '''grüne Led GPIO 13''' vorgesehen. Der '''Taster ist an GPIO 0''' angeschlossen.
<div style="clear:both;"></div>

===Device Schalter===
[[Datei:sonoff_sw_12.jpg|thumb|left|alt=Device Relais]]
Bei den Devices sollten die hier dargestellte Einstellungen beachtet werden. Der Switch (PUMP) sollte auf Input gestellt werden, sodass die anschließenden und benötigten Rules aktiviert werden können.

Da beide Devicenamen gleich benannt wurden (PUMP) wird in Fhem nur ein Device angelegt! Die dazugehörenden Valunames sind unterschiedlich (Relay, Key).

<div style="clear:both;"></div>

===Device Taster===
[[Datei:sonoff_sw_13.jpg|thumb|left|alt=Device Key]]
Der Taste muss natürlich nur konfiguriert werden, wenn auch händisch am sonoff geschaltet werden soll. Wird dies nicht benötigt, können auch die Rules geändert bzw. angepasst werden. Doch alleine zu Testzwecken ist es eine nützliche Sache.
<div style="clear:both;"></div>

===Rules===
[[Datei:sonoff_sw_14.jpg|thumb|left|alt=Rules]]
Da das sonoff Modul auch einen eingebauten Taster hat und somit auch lokal bedient werden kann, sollte man zunächst unter '''Tools / Advanced das Häckchen Rules''' aktivieren, erst dann wird der Tab sichtbar und es können Rules erstellt werden.
<div style="clear:both;"></div>

on PUMP#Key do
if [PUMP#Relay]=1
gpio,12,0
else
gpio,12,1
endif
endon
on PUMP#Relay do
if [PUMP#Relay]=1
gpio,13,0
else
gpio,13,1
endif
endon
Diese Rules ermöglichen, das bei lokaler Bedienung durch den Taster auch die '''Led''' richtig geschaltet wird.
Mit 'on PUMP#Key do' wird geprüft ob die Taste gedrückt ist und schaltet dann entsprechend die Led. Mit den Rules können auch Timer oder sonstige Spielereien realisiert werden. Siehe dazu das [http://www.esp8266.nu/index.php/Tutorial_Rules Tutorial] von ESPeasy.
<div style="clear:both;"></div>

==Fhem==
[[Datei:sonoff_sw_9.jpg|thumb|left|alt=Fhem Konfiguration]]
Dies ist eine einfache Darstellung wie Fhem automatisch den Device erstellt.

Damit Fhem mit ESPEasy und dem sonoff Modul kommunizieren kann, muss in der fhem.cfg vorerst nur die espBridge mit dem hier dargestellten Eintrag aktiviert werden.
<div style="clear:both;"></div>
define espBridge ESPEasy bridge 8383
Dies ist eigentlich die einzige Zeile die in fhem.cfg angelegt werden muss. Die restliche Konfiguration wird von Fhem automatisch generiert.

##########################################
### ESPEASY ####
##########################################

define ESPEasy_sonoff_1_PUMP ESPEasy 10.0.0.37 80 espBridge sonoff_1_PUMP
attr ESPEasy_sonoff_1_PUMP IODev espBridge
attr ESPEasy_sonoff_1_PUMP devStateIcon on:rc_GREEN:off off:rc_RED:on absent:rc_BLUE:off gpio:rc_YELLOW:off
attr ESPEasy_sonoff_1_PUMP eventMap /gpio 12 on:on/gpio 12 off:off/gpio 12 gpio:off/gpio 12 output:off/
attr ESPEasy_sonoff_1_PUMP group ESPEasy Device
attr ESPEasy_sonoff_1_PUMP icon hue_filled_outlet
attr ESPEasy_sonoff_1_PUMP room ESPEasy
attr ESPEasy_sonoff_1_PUMP setState 0
attr ESPEasy_sonoff_1_PUMP stateFormat {ReadingsVal($name,"presence","") eq "absent" ? "absent" : ReadingsVal($name,"Relay","")}
attr ESPEasy_sonoff_1_PUMP webCmd :

hier ein Beispiel wie es auch manuell leicht modifiziert werden kann.

[[Datei:sonoff_sw_8.jpg|thumb|left|alt=sonoff Readings]]

Die Readings werden durch die Bridge (Modul ESPEasy) automatisch angelegt.

Es besteht hier noch genug Spielraum um zB. auch noch Temperatursensoren an das Modul anzuschließen und ebenfalls in Fhem darzustellen.
<div style="clear:both;"></div>

[[Kategorie:Other Components]]
[[Kategorie:IP Components]]

E-Mail senden

2016-08-29T09:25:40Z

JoWiemann: /* Raspberry Pi */

Um aus FHEM heraus '''E-Mail senden''' zu können, sind abhängig von der verwendeten Platform unterschiedliche Vorgehensweisen erforderlich.

{{Randnotiz|RNTyp=y|RNText=Anleitung zur Einrichtung von Exim4 auf Debian mit GMX als Smarthost:[http://www.fhemwiki.de/w/images/f/f6/Anleitung_Exim4_Debian_GMX.pdf PDF]}}

== Linux ==
=== FritzBox 7170 (non-chroot) oder "reine" Linuxe ===
Datei 99_email.pm im Modul-Verzeichnis mit folgender Funktion anlegen (oder in bestehende 99_irgendwas.pm kopieren):

<nowiki>sub fb_mail {
my $rcpt = $_[0];
my $subject = $_[1];
my $text = $_[2];
system("/bin/echo \"$text\" | /usr/bin/mail send -i - -s \"$subject\" -t \"$rcpt\"");
}</nowiki>
Aufruf dann mittels
:<code>{ fb_mail('empfaenger@mail.de','Subject','text 123') }</code>
Darauf achten, dass der fhem-User Mails senden darf (in richtige Gruppe eintragen. Ggf. vorher einmal su fhem und probieren).

=== Fritz!Box 7390 ===
Auf der [[AVM Fritz!Box|FritzBox 7390]] ist diese Funktion seit 10/2012 Bestandteil der Fhem Standardauslieferung. Sie ist untergebracht in FritzBoxUtils.pm und heisst dort FB_mail($$$) (Groß-Kleinschreibung beachten).

Da der Dateiname von FritzBoxUtils.pm nicht mit 99_ beginnt, wird diese Programmdatei nicht automatisch beim Start von Fhem geladen. Fhem muss zum Laden dieser Programmdatei aufgefordert werden. Dazu (z. B. in 99_myUtils.pm) die Zeile ''use FritzBoxUtils;'' einfügen.

Mit dem Install von AVM.de wird fhem in einer chroot-Umgebung ausgeführt, die den Zugriff auf die Mailfunktion der Fritzbox nicht zulässt. Daher muss Fhem in der [http://fhem.de/fhem.html#Download Version von fhem.de] installiert sein. Sollte Ihre Fritzbox bisher mit dem install von AVM laufen, kann (nach einem backup!) das image von fhem.de einfach drüberinstalliert werden. Es sollten dabei alle Einstellungen erhalten bleiben.

<nowiki>sub fb_mail {
my $rcpt = $_[0];
my $subject = $_[1];
my $text = $_[2];
system("/bin/echo \"$text\" > /var/tmp/fhem_nachricht.txt");
system("/sbin/mailer send -i '/var/tmp/fhem_nachricht.txt' -s \"$subject\" -t \"$rcpt\"");
system("rm /var/tmp/fhem_nachricht.txt");
}</nowiki>

Aufruf dann mittels
:<code>{ fb_mail('empfaenger@mail.de','Subject','text 123') }</code>
bzw.
:<code>{ FB_mail('empfaenger@mail.de','Subject','text 123') }</code>

Dem Mailer können noch weitere Parameter hinzugefügt werden. Mehr dazu siehe: [http://www.wehavemorefun.de/fritzbox/Mailer Mailer]

=== OpenWRT ===
Die Anleitung wurde mit einer frühen Beta von Barrier Breaker (r391xx) mit einem TP_Lind WDR 4900 getestet. Da "sendEmail" nicht als Package vorliegt wird in dieser Anleitung "ssmtp" verwendet.
Die Installation erfolgt mittels:

<pre>
opkg update
opkg install ssmtp_2.64-4_mpc85xx.ipk
</pre>

Hierbei werden die Packete libopenssl und zlib mit installiert. Damit ssmtp funktioniert müssen die Dateien /etc/ssmtp/ssmtp.conf und /etc/ssmtp/revaliases angepasst werden.

/etc/ssmtp/ssmtp.conf
<nowiki>root=arnold@gmx.net
mailhub=mail.gmx.net:465
rewriteDomain=gmx.net
hostname=gmx.net
FromLineOverride=YES
UseTLS=YES
#UseSTARTTLS=YES
AuthUser=arnold@gmx.net
AuthPass=Passwort_von_arnold@gmx.net
</nowiki>

/etc/ssmtp/revaliases
<nowiki>
root:arnold@gmx.net:mail.gmx.net:465</nowiki>

In der [[99_myUtils_anlegen|99_myUtils]] folgende Unterroutine einfügen (von der RPi-Anleitung übernommen):

<nowiki>sub
OpenWRTMail
{
my $rcpt = shift;
my $subject = shift;
my $text = shift;
my $ret = "";
my $sender = "dockstar\@heye-tammo.de";
Log 1, "sendEmail RCP: $rcpt, Subject: $subject, Text: $text";
$ret .= qx(echo -e 'to:$rcpt\n from:$sender\nsubject:$subject\n$text\n' | ssmtp $rcpt);
$ret =~ s,[\r\n]*,,g; # remove CR from return-string
Log 1, "sendEmail returned: $ret";
}</nowiki>

Ab hier den entsprechenden Abschnitt unter "Raspberry Pi" lesen.

=== Synology DiskStation ===
Beim DSM 3.2 gab es keinen <code>sendmail</code>-Befehl, sondern nur eine Funktion für den Versand der System-Benachrichtigungen. Interessanterweise funktionierte aber der <code>php-mail</code>-Befehl, so dass man mittels folgendem Modul Mails frei versenden kann:

<nowiki>sub sendmail($$$) {
my($empf, $subj, $nachricht) = @_;
system("php -r 'mail(\"$empf\",\"$subj\",\"$nachricht\");'");
undef;
}</nowiki>

=== Raspberry Pi ===
In der weezy-Version, wie sie von busware zur Verfügung gestellt wird, muss auf einem [[Raspberry Pi]] noch sendEmail nachinstalliert werden. Diese Anleitung funktioniert auch unter '''Ubuntu'''.

<pre>
sudo apt-get update
sudo apt-get install sendEmail libio-socket-ssl-perl libnet-ssleay-perl perl
</pre>

in der [[99_myUtils_anlegen|99_myUtils]] folgende Unterroutine einfügen:

<nowiki>######## DebianMail Mail auf dem RPi versenden ############
sub
DebianMail
{
my $rcpt = shift;
my $subject = shift;
my $text = shift;
my $attach = shift;
my $ret = "";
my $sender = "absender\@account.de";
my $konto = "kontoname\@account.de";
my $passwrd = "passwrd";
my $provider = "smtp.provider.de:587";
Log 1, "sendEmail RCP: $rcpt";
Log 1, "sendEmail Subject: $subject";
Log 1, "sendEmail Text: $text";
Log 1, "sendEmail Anhang: $attach";;

$ret .= qx(sendEmail -f '$sender' -t '$rcpt' -u '$subject' -m '$text' -a $attach -s '$provider' -xu '$konto' -xp '$passwrd' -o tls=auto -o message-charset=utf-8);
$ret =~ s,[\r\n]*,,g; # remove CR from return-string
Log 1, "sendEmail returned: $ret";
}</nowiki>

Um die TLS Verschlüsselung (ehem. SSL) nicht zu nutzen, muss in der 4. letzten Zeile tls=no verwendet und der Port des Mailproviders auf 25 eigetragen werden. Sollte anschließend keine Mail verschickt werden, siehe Probleme.

Falls der Body-Text in einem (Android-)Mailer auf dem Handy nicht gezeigt wird, kann der Parameter '''-o message-content-type=html''' helfen.

Die Funktion kann beispielsweise folgendermaßen aufgerufen werden:

<nowiki>define Sonstiges notify Fenster:Window:.*,.*Low.Batt*. {\
DebianMail("email@email.domain","Subject","Text","'Anhang1' 'Anhang2' ...");;\
}</nowiki>

oder

<nowiki>define Sonstiges at *01:00:00 {\
DebianMail("email@email.domain","Subject","Text","'Anhang1' 'Anhang2' ...");;\
}</nowiki>

Es ist wichtig die Dateinamen mit ' ' zu klammern, da hierdurch auch Leerzeichen im Pfad/Dateinamen möglich sind.

=== BeagleBoard-xM ===
Auf einem [[:Kategorie:BeagleBoard-xM|BeagleBoard-xM]] mit einem [http://en.opensuse.org/HCL:BeagleBoard-xM OpenSUSE 12.2] kann man ebenfalls das Perl-Programm ''sendEmail'' wie beim RPi nutzen. Dies gibt es aber nicht in den Repositories von openSUSE, sondern man muss sich ''sendEmail'' als Source herunterladen. Das geht am einfachsten per ''wget'', welches man ebenfalls erst installieren muss (aber aus einem Repository).

<nowiki>$ zypper in wget
$ cd /opt
$ wget http://caspian.dotconf.net/menu/Software/SendEmail/sendEmail-v1.56.tar.gz
$ tar xvfz sendEmail-v1.56.tar.gz
$ cd sendEmail-v1.56
$ cp sendMail /usr/local/bin</nowiki>
Dann geht man weiter vor wie unter RPi beschrieben (anlegen der SUB-Routine in 99_myUtils usw.).

'''Hinweis:''' Die Version 1.56 von ''sendEmail'' ist Stand Januar 2013 die aktuelle. Da diese Programmversion von 2009 stammt, ist mit neuen Versionen selten zu rechnen. Vielleicht schauen Sie trotzdem vorher auf der [http://caspian.dotconf.net/menu/Software/SendEmail/ Homepage von sendEmail] nach.

== Windows ==
# Kopiere die Datei sendEmail.exe* in Dein FHEM Verzeichnis (hier c:\fhem-5.0\); Quelle: [http://caspian.dotconf.net/menu/Software/SendEmail/ http://caspian.dotconf.net/menu/Software/SendEmail/]
# Erstelle im FHEM Verzeichnis die Datei wmail.bat mit folgendem Inhalt (eine Zeile): <br><code>sendEmail -f absender@domain.de -u "%1" -m " " -s SMTP-SERVERAdresse -xu SMTP_USERNAME -xp SMTP_PASSWORT -t empfänger@domain.de -o message-header="X-Message-Flag: FHEM"</code>
# Beispiel fhem.cfg
## Mail wenn sich der Status von Heizung.* oder Hzg.* ändert <br><code>define Mail_Heizung notify Heizung.*|Hzg.* { system("wmail $NAME:$EVENT")}</code>
## Mail bei Signal Aussentemperatur (für dieses Beispiel wird [http://fhem.de/commandref.html#getstate http://fhem.de/commandref.html#getstate getstate] benötigt) <br><code>define Mail_Aussentemperatur notify Aussentemperatur {\</code><br><code>my ($val);;\</code><br><code>$val = fhem "getstate $NAME";;\</code><br><code>system("wmail \"$NAME: $val\"");;\</code><br><code>}</code>

== Probleme ==
=== sendEmail ===
Falls man keine E-Mails verschicken kann, kann man in einem ersten Test prüfen, ob sendEmail als solches funktioniert und die Konfiguration (Benutzer, Passwort, Server-Name usw.) des Mail-Kontos, über das die Mails abgesetzt werden sollen, richtig ist.

Hierzu setzt man in der FHEM-Befehlszeile die folgende Anweisung ab:
:<code>{ SUB-Routinen-Name('EMailAdresse@Mail.Domain','Test','Test-Text');; }</code>
und ersetzt ''SUB-Routinen-Name'' durch den Namen der in 99_myUtils erzeugten Prozedur. Statt ''EMailAdresse@Mail.Domain'' trägt man noch eine gültige E-Mail-Adresse ein und bestätigt den Befehl dann mittels <Enter> (nicht "save"). Empfangen Sie nicht kurzfristig eine entsprechende E-Mail, ist sehr wahrscheinlich an den Zugangsdaten etwas verkehrt.

Vor dem testen der Routine oben kann sendEmail auch über die Konsole (z. B. via Putty) getestet werden:
:<code>sendEmail -f 'fhemsystem@meinedomain.tld' -t 'ich@meinedomain.tld' -u 'subject' -m 'body' -s 'meinmailserver.meinedomain.de' -xu 'fhemmailer' -xp 'geheimespassword' -o tls=no</code>

=== Keine Mail mit TLS Verschlüsselung ===
Den Test über die Konsole durchführen. Erhält man folgende Fehlermeldung:
''invalid SSL_version specified at /usr/share/perl5/IO/Socket/SSL.pm line 332''
muss auf dem Raspberry folgende Datei angepasst werden: ''/usr/bin/sendEmail''.
In Zeile 1907 muss
if (! IO::Socket::SSL->start_SSL($SERVER, SSL_version => 'SSLv3 TLSv1')) {

in folgendes geändert werden
if (! IO::Socket::SSL->start_SSL($SERVER, SSL_version => 'SSLv23:!SSLv2')) {

Der frühere Tipp direkt in der SSL.pm Datei zu editieren führt zu Problemen wenn man auf FHEM per HTTPS zugreifen will und ist daher nicht zu empfehlen.

== Email laut Log gesendet aber nicht angekommen? ==
Dann bitte in der Fritzbox Oberfläche überpüfen, ob unter "System" -> "Push Service" selbiger eingerichtet und aktiviert wurde.

[[Kategorie:HOWTOS]]
[[Kategorie:FritzBox]]
[[Kategorie:BeagleBoard-xM]]
[[Kategorie:Raspberry Pi]]