Yowsup: Unterschied zwischen den Versionen

Aus FHEMWiki
K (Modultyp auf "offiziell" geändert; diverse Korrekturen)
Zeile 1: Zeile 1:
{{SEITENTITEL:yowsup}}
{{SEITENTITEL:yowsup}}
{{Infobox Modul
{{Infobox Modul
|ModPurpose=Schnittstelle um WhatsApp-Nachrichten empfangen und senden zu können.
|ModPurpose=Schnittstelle, um WhatsApp-Nachrichten empfangen und senden zu können.
|ModType=x
|ModType=d
|ModComRef=yowsup
|ModComRef=yowsup
|ModFTopic=27543
|ModFTopic=27543
|ModForumArea=Sonstiges
|ModForumArea=Unterstuetzende Dienste
|ModTechName=32_yowsup.pm
|ModTechName=32_yowsup.pm
|ModOwner=André / justme1968 ({{Link2FU|430|Forum}} / [[Benutzer Diskussion:justme|Wiki]])
|ModOwner=André / justme1968 ({{Link2FU|430|Forum}} / [[Benutzer Diskussion:justme|Wiki]])
}}
}}


Das Modul [[yowsup]] dient dem empfangen und senden von WhatsApp-Nachrichten.
Das Modul [[yowsup]] dient dazu, WhatsApp-Nachrichten zu empfangen und zu senden.


== Voraussetzungen ==
== Voraussetzungen ==
Die Funktionalität ist vermutlich auf Linux/Unix Systemen beschränkt.
Die Funktionalität ist vermutlich auf Linux/Unix Systeme beschränkt.


== Anwendung ==
== Anwendung ==
=== Define ===
=== 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.
* 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 das fhem online ist.
* 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 ===
=== Attribute ===
* cmd -> komplettes Kommando um den yowsup cli client zu starten. z.B.: <code>attr WhatsApp cmd /opt/local/bin/yowsup-cli demos -c /root/config.yowsup --yowsup</code>
* cmd <br />komplettes Kommando, um den yowsup Client zu starten. z.B.: <code>attr WhatsApp cmd /opt/local/bin/yowsup-cli demos -c /root/config.yowsup --yowsup</code>
* accept_from -> Kommagetrennte Liste von Kontakten (Nummern) von denen Nachrichten akzeptiert werden. Ist das Attribut nicht gesetzt, so werden die Nachrichten von jedem akzeptiert.
* 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-Befehle interprätiert.<br />alles andere -> Wenn die Nachricht mit diesem Prefix startet, dann wird alles weitere als Befehle interprätiert.
* 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.
* allowedCommands{{Randnotiz|RNTyp=Info|RNText='''allowedCommands''' should work as intended, but no guarantee can be given that there is no way to circumvent it.}}<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.
{{Randnotiz|RNTyp=Info|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.


=== Befehle ===
=== Befehle ===
* image -> Über diesen Befehl können Bilder gesendet werden.
* image -> Über diesen Befehl können Bilder gesendet werden.
== Anwendungsbeispiele ==
== Anwendungsbeispiele ==
=== Beispielnachricht ===
=== Beispielnachricht ===
Bei dem 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.
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 ein 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.

Version vom 17. Juni 2015, 10:01 Uhr


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.

Voraussetzungen

Die Funktionalität ist vermutlich auf Linux/Unix Systeme beschränkt.

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.
Info green.pngallowedCommands 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.