Signalbot
| Signalbot | |
|---|---|
| Zweck / Funktion | |
| Senden und Empfangen von Nachrichten (Text und Fotos) mit dem freien Messenger Signal | |
| Allgemein | |
| Typ | Inoffiziell |
| Details | |
| Dokumentation | Thema |
| Support (Forum) | Codeschnipsel |
| Modulname | 50_Signalbot.pm |
| Ersteller | Adimarantis (Forum /Wiki) |
| Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref! | |
Das Modul Signalbot ermöglicht den Versand von Nachrichten über den Instant-Messaging-Dienst Signal aus FHEM heraus.
Beschreibung
Beschreibung in Kurzform:
Signalbot stellt eine Schnittstelle von FHEM zum Signal Messenger unter Linux zur Verfügung. Dazu wird das Tool signal-cli im DBus-Daemon Modus verwendet, welches dann letztendlich mit Signal kommuniziert.
Da sich signal-cli noch in der Entwicklung befindet (aktuelle Version 0.7.4) steht leider noch nicht die volle Funktionalität über DBus zur Verfügung, wodurch sich auch Einschränkungen für FHEM ergeben.
Aktuell unterstütze Funktionen aus FHEM:
- Senden und Empfangen von Nachrichten an Gruppen oder Einzelempfänger
- Versenden von einem oder mehreren Attachments (Bilder)
- Einlesen, Speichern und Übersetzen von Gruppennamen (statt base64 Strings)
- Setzen, Empfangen und Übersetzen von Kontaktnamen (statt Telefonnummern)
- Einschränken von Gruppen oder Kontakten auf die FHEM reagieren soll
- Direkte Verknüpfung mit dem Babble Modul zur Interpretation von Befehlen
Die Installation von signal-cli ist aktuell je nach Linux Kenntnissen durchaus anspruchsvoll. Daher gibt es ein Installationsscript welches aktuell für aktuelle Ubuntu und Raspian Distributionen getestet ist (höchstwahrscheinlich aber auch für andere Debian basierte Distributionen funktioniert)
Signalbot ist weitgehend kompatibel mit SiSi, verfolgt aber technisch ein paar andere Ansätze und stellt zusätzliche Funktionalitäten zur Verfügung:
- Signalbot erzeugt keinen eigenen Prozess sondern integriert sich voll in die laufende FHEM Instanz (ist dadurch hoffentlich stabiler und verbraucht auch weniger Speicher)
- Gruppen werden grundsätzlich mit ihren Klarnamen verwendet und können auch nur mit einem vorangestellten "#" (statt "@#") gekennzeichnet werden.
- Kontakte werden soweit möglich auch mit Klarnamen (statt +49....) unterstützt. Diese kommen aus dem internen Adressbuch und können über "setContact" definiert werden, bzw. kommen bei verlinkten Accounts aus dem Adressbuch des Hauptgeräts. Sie können aktuell leider nur über empfangene Nachrichten entschlüsselt werden, da signal-cli die entsprechende Schnittstelle (noch) nicht zur Verfügung stellt. Signalbot lernt diese aber mit der Zeit und kann sie bei Bedarf auch so abspeichern, dass sie auch nach einem FHEM Neustart wieder verfügbar sind
- Die Möglichkeit von Telegrambot in den "send" Befehl eingebetteten Code auszuführen und damit z.B. einen SVG Plot zu erstellen und mit zu verschicken ist verfügbar. Dazu muss der Befehl in runde Klammern eingebettet werden (Beispiele folgen unten).
- Wurde mit und für die aktuelle Version 0.7.4 von signal-cli entwickelt, die auch die neuen "V2" Gruppen unterstützt, ebenso wird die neuste Version (1.2.0) vom Perl Modul Net::DBus benötigt
- Wird aktuell (Jan 2021) noch gewartet (letztes Update für SiSi auf github ist aktuell von August 2018)
Funktionen im Detail
send [@<Recipient1> ... @<RecipientN>] [#<Group1> ... #<GroupN>] [&<Attachment1>; ... &<AttachmentN>] [<Text>]
- Recipient: Nummer mit Ländervorwahl (+49....) oder Kontaktname aus dem internen Adressbuch
- Group: Gruppenname, wie in Signal definiert im Klartext
- Attachment: Dateiname (Pfad muss für den signal-cli user lesbar sein) oder Stream einer Bilddatei (z.B.)SVG
- Bitte beachten: Als Dateinamen absolute Pfade (z.B. /opt/fhem/bild.png) verwenden, da sie signal-cli sonst nicht findet. Dateien die ständig neu erstellt werden (z.B. IPCAM Snapshots vorher in eine neue Datei kopieren, da signal-cli mit "unvollständigen" Dateien nicht zurechtkommt. (Todo: Signalbot könnte die Datei nach /tmp umkopieren und diese Datei senden, dann würden beide Einschränkungen wegfallen)
- Text: Die eigentlich Textnachricht, kann Leerzeichen enthalten
- Sofern ein Recipient, Group oder Attachment Leerzeichen enthält, den ganzen Teilstring in Anführungszeichen setzen: z.B. "@Max Mustermann"
- Wenn ein FHEM Befehl ausgeführt werden soll, dann diesen in runde Klammern setzen z.B. &({plotAsPng('SVG_Aussentemperatur')})
Ein paar Beispiele
send @+498514711 Hallo Signal
send #FHEM &/tmp/foto.jpg Ein Bild schicken
send "@Mein Freund" Leerzeichen durch Anführungszeichen um den ganzen Teilbefehl
send @Joerg #FHEM #Familie Jeder Empfänger, jede Gruppe und Attachments können mehrfach vorkommen
send "@({my $var=\"Joerg\";; return $var;;})" Perl Code mit Leerzeichen ausführen
send @(define dummy1 dummy) FHEM Befehl ausführen, wird aber nicht gesendet, da kein gültiger Empfänger zurück geliefert wird
send @Joerg &({plotAsPng('SVG_Aussentemperatur')}) Einen FHEM SVG Plot verschicken
send @Joerg Die Aussentemperatur ist [out_temp:temperature] Grad
refreshGroups
Fragt die List der aktuellen Gruppen ab, denen der verknüpfte Account beigetreten ist. Die Liste wird im u.a. Reading joinedGroups sichtbar gemacht.
setContact <Number> <Contactname>
Definiert einen Kontakteintrag im internen Adressbuch. Es kann beim send Befehl dann der ContactName statt der Nummer verwendet werden.
saveContacts
Speichert die interne Kontaktliste in das Reading contactList welches beim Speichern der FHEM Config in fhem.save abgelegt wird und nach einem Neustart wieder zur Verfügung steht (zur Diskussion: immer automatisch so machen wenn neue Kontakte festgelegt werden?)
reinit
Verbindung zum DBus wiederherstellen. Dies sollte nicht nötig sein, außer der signal-cli Service funktionierte nicht richtig und wurde korrigiert. Ich rate hier aber eher zu einem FHEM Neustart.
Attribute im Detail
defaultPeer
Gruppe, Kontaktname oder Nummer an die send eine Nachricht schicken soll, wenn kein Empfänger mit @ oder # definiert wurde.
allowedPeer
Gruppe, Kontaktname oder Nummer auf die Signalbot reagieren soll (also bei empfangenen Nachrichten Readings aktualisiert). Aktuell ist dies nur ein einzelner Sender. Todo: das sollte wahrscheinlich besser eine Liste sein
babblePeer
Gruppe, Kontaktname oder Nummer auf die Signalbot reagieren soll indem es die Nachricht an das über babbleDev (nicht zu verwechseln mit babbleDevice) definierte Babble Modul schickt.
babbleDev
Name des definierten Babble Device. Todo: das könnte Signalbot auch selber finden, da es üblicherweise wohl nur ein Modul geben sollte
Readings im Detail
| contactList | Liste der gespeicherten Kontakt im Format Nummer1=Kontakt1,Nummer2=Kontakt2,... |
| joinedGroups | Liste der beigetretenen Gruppen getrennt mit Leerzeichen |
| msgAttachment | Attachments (Dateinamen im signal-cli repository) der zuletzt empfangenen Attachments |
| msgGroupName | Gruppenname aus der zuletzt eine Nachricht empfangen wurde - leer wenn es eine persönlich Nachricht war |
| msgSender | Absender der letzten Nachricht als Nummer oder wenn bekannt als Name |
| msgText | Empfangenen Nachricht |
| msgTimestamp | Zeitstempel der Nachricht |
| prevMsgAttachment | Wie oben, nur enthalten diese Readings die Daten der zuvor empfangenen Nachricht (n-1) |
| prevMsgGroupName | |
| prevMsgSender | |
| prevMsgText | |
| prevMsgTimestamp | |
| sentMsg | Zuletzt gesendete Nachricht |
| sentMsgRecipient | Empfänger der zuletzt gesendeten Nachricht. Enthält zumeist den Namen aus der Empfangsbestätigung und somit bei vielen Empfängern den zuletzt bestätigten Empfang.
Dies muss nicht zwingend auf die zuletzt gesendete Nachricht (sendMsg) passen, wenn mehrere Nachrichten versendet wurden. |
| sentMsgTimestamp | Zeitstempel des Empfangs oder "pending" wenn noch keine Bestätigung vorliegt |
Installation
Zur Installation steht das Script "signal_install.sh" zur Verfügung. Dieses befindet sich noch in der Entwicklung und funktioniert nicht zwangsweise in jeder Umgebung. Daher erst einmal ein paar Referenzen zur manuellen Installation von signal-cli :
- Die Wikiseite des Vorgängermoduls SiSi welches grundsätzlich die selben Anforderungen hat
- Quickstart (englisch) für signal-cli
- Anleitung zum "linken" einer Nummer mit signal-cli
- Anleitung zum Übersetzen und Installieren der Libraries für armv7 (Raspberry) da die Distribution nur x86 libraries enthält
- CPAN Seite des Perl Moduls zur DBus Kommunikation
Das Modul und Install Script wird aktuell nicht über "fhem update" verbreitet und muss vom ersten Post der Forum Threads geholt werden.
Vorbereitung:
Modul 50_Signalbot.pm wie üblich ins Verzeichnis "FHEM" der FHEM Installation kopieren.
Das Script "signal_install.sh" ins home Verzeichnis eines beliebigen "sudo"-fähigen Users kopieren.
Am Anfang des Moduls sind einige Informationen und Pfade definiert. Mindestvorrausetzung ist eine Telefonnummer. Es kann eine Festnetznummer oder Mobilfunknummer verwendet werden. Wird Signal schon am Handy benutzt lässt sich die Nummer verknüpfen, was aber den unangenehmen Nebeneffekt hat, dass man dort alle FHEM Nachrichten mitbekommt.
Kontrolliert also bitte vor dem Start des Scripts diese Angaben. Außer bei PHONE=+49xxxxx sollte aber üblicherweise keine Änderung nötig sein.
Das Script hat mehrere Optionen um Teilfunktionen direkt auszuführen, diese sind:
| Argument | Bedeutung |
|---|---|
| system | System für die signal-cli Installation vorbereiten. Es werden per "apt install" fehlende Pakete installiert und Verzeichnisse erstellt.
Muss mindestens einmal erfolgreich gelaufen sein, damit die restliche Installation funktioniert |
| install | Installiert signal-cli als System Service. Automatischer Download, Installation und Konfiguration (dbus, systemd) |
| register | Registriert die definierte Telefonnummer bei Signal. Dieser Prozess hat seine Tücken und wird unten nochmal eingehend beschrieben |
| link | Verknüpfen einer bestehenden Telefonnummer. Dazu muss in Signal über Settings -> Linked Devices -> "plus" ein QR Code abfotografiert werden.
Dieser wird von dieser Routine als Datei in /tmp/qrcode.png abgelegt. D.h. vorher sicherstellen, dass man mit einem Bildbetrachter an diese Datei kommt |
| test | Versendet eine Testnachricht auf zwei Arten - direkt mit dem Client (klappt das, ist die Grundregistrierung schon mal erfolgreich) und über Dbus (dann ist auch der System Service korrekt eingerichtet) |
| remove | Löscht alle durch "install" installierten Verzeichnisse und Dateien (aber nicht die Pakete die durch "system" installiert wurden) |
| join | Ermöglicht einer Gruppe mithilfe eines Einladungslinks beizutreten |
| name | Definieren des eigenen Namens und Avatar Bildes |
Das Script muss unter root Rechten, also mit
sudo ./signal_install.sh
aufgerufen werden. Wenn kein Argument übergeben wird, dann wird automatisch der Ablauf system -> install -> register -> test durchlaufen.
Das Script fragt üblicherweise nach wenn es etwas tut und führt nur notwendige Aktionen durch (kann also bei teilweisen Fehlern problemlos erneut durchlaufen werden).
Es prüft außerdem ab ob es im Container läuft (aktuell führt das zum Abbruch - mehr dazu unten) und prüft auf Betriebssystem und CPU Architektur. Gegebenenfalls bricht es ab, wenn es sich um keine unterstützte Kombination handelt.
Zum Thema Container gibt es aktuell Entwicklungen im Thread und es wird ggf. dazu auch Hilfestellungen geben. In einer VM funktioniert die Installation üblicherweise problemlos.
Bitte genau auf die Bildschirmausgaben und Fragen achten. Fehlermeldungen im Thread melden damit das Script weiter verbessert werden kann.
Registrierung
Wenn die Systeminstallation erfolgreich abgeschlossen ist, folgt die Registrierung der Nummer. Hier gibt es zwei Optionen:
SMS oder Voice.
Je nachdem wird ein 6-stelliger Aktivierungscode per SMS geschickt oder über einen Telefonanruf (sogar auf Deutsch) diktiert.
Captcha
Signal versucht sich gegen unberechtigte Nutzung des Service (man könnte ja damit quasi SMS/Telefonterror betreiben) zu schützen. Nach gewissen Kriterien (soweit bekannt z.B. Registrierung aus einer VM oder über VPN) wird daher ein Captcha verlangt.
Nur wie funktioniert sowas in der Kommandozeile?
Das Script erkennt diese Abfrage und fragt nach einem Captcha Code. Diesen erlangt man wie folgt:
- Captcha Seite von Signal aufrufen. Dabei ist es wahrscheinlich unerheblich von wo (hab es erfolgreich aus meinem Windows Host gemacht und in meinen Linux VM Guest eingetragen) - schätzungsweise ist es einfach zeitlich begrenzt gültig.
- Im Developermode (F12) und nach erfolgreichem Lösen des Captchas (wenn der Bildschirm leer bleibt, ist es auch erfolgreich gelöst) macht der Browser ein redirect auf signalcaptcha://. Das versteht der Browser aber nicht und macht gar nichts.
- Der String steht aber bei Firefox in der Console (recht einfach zu finden), beim Chrome muss man auf Network gehen, mit Ctrl+R refreshen und dann in der Spalte "Name" nach einem kryptischen String suchen. Das dieser mit signalcaptcha anfängt sieht man erst im Tooltip da der Anfang abgeschnitten wird.
- Diesen String (ohne signalcaptcha://) dann in die Eingabezeile des Scripts einfügen und Return drücken. Jetzt sollte die Registrierung erfolgreich abschließen.
Anbei Screenshots von Firefox und Chrome zum besseren Verständnis.
Unterstützung gesucht: Das Holen des Captchas ist ziemlich umständlich. Suche jemanden der sich mit z.B. mit der Erstellung von Protokoll plugins in Chrome (Abfangen von signalcaptcha:// und Darstellen des Texts in einem Fenster - evtl. mit "Copy" Button) auskennt - oder vielleicht geht sowas ja auch als FHEM Modul?
Einrichtung des Moduls
Siehe Forenthema Neues Modul: Signalbot.
Nachdem alles sauber eingerichtet ist und das Modul im FHEM Directory abgelegt wurde, entweder ein "reload 50_Signalbot" oder besser ein "shutdown restart" von FHEM machen.
Das Modul dann einfach mit
define <name> Signalbot
definiert.
Weitere Attribute sind optional (siehe oben)
Installation im Docker Container
Dazu bitte aktuell die Diskussion im Forenthread beachten.
Grundsätzlich: Es ist möglich, erfordert aber einen leicht anderen Installationsansatz als bei der Verwendung als systemd service und es gibt dazu (noch) keine Installationscripts.
Links
- Thread Neues Modul: Signalbot