Yowsup: Unterschied zwischen den Versionen

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!

Version vom 17. Juni 2015, 12:56 Uhr

Das Modul yowsup dient dazu, WhatsApp-Nachrichten zu empfangen und zu senden.

Voraussetzungen

Die Funktionalität ist vermutlich auf Linux/Unix Systeme beschränkt.
Nach der Erstinstallation/-einrichtung muss zwingend das cmd Attribut korrekt gesetzt werden.

Anwendung

Define

Fhem Device anlegen: define <name> yowsup
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

cmd
komplettes Kommando, um den yowsup Client zu starten. z.B.: attr WhatsApp cmd /opt/local/bin/yowsup-cli demos -c /root/config.yowsup --yowsup
accept_from
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.

allowedCommands should work as intended, but no guarantee can be given, that there is no way to circumvent it.

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.

Befehle

image -> Über diesen Befehl können Bilder gesendet 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.

@@ Zeile 3: / Zeile 3: @@
 |ModPurpose=Schnittstelle, um WhatsApp-Nachrichten empfangen und senden zu können.
 |ModType=d
-|ModComRef=yowsup
+|ModCmdRef=yowsup
 |ModFTopic=27543
 |ModForumArea=Unterstuetzende Dienste
@@ Zeile 13: / Zeile 13: @@
 == Voraussetzungen ==
-Die Funktionalität ist vermutlich auf Linux/Unix Systeme beschränkt.
+* Die Funktionalität ist vermutlich auf Linux/Unix Systeme beschränkt.
+* Nach der Erstinstallation/-einrichtung '''muss''' zwingend das ''cmd'' Attribut korrekt gesetzt werden.
 == Anwendung ==
 === Define ===
-* fhem device anlegen: <code> define <name> yowsup </code>
+* Fhem Device anlegen: <code> define <name> yowsup </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
+* zum Senden aus Fhem kann man das Kommando <code>set WhatsApp send <nummer> <text></code> verwenden
 === Attribute ===
@@ Zeile 26: / Zeile 27: @@
 * accept_from <br />kommagetrennte Liste von Kontakten (Nummern), von denen Nachrichten akzeptiert werden. Ist das Attribut nicht gesetzt, so werden die Nachrichten von jedem akzeptiert.
 * commandPrefix <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=Info|RNText='''allowedCommands''' should work as intended, but no guarantee can be given, that there is no way to circumvent it.}}
+{{Randnotiz|RNTyp=Warn|RNText='''allowedCommands''' should work as intended, but no guarantee can be given, that there is no way to circumvent it.}}
 * allowedCommands<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.
@@ Zeile 35: / Zeile 36: @@
 === 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.
+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.