Telegram Bot

Der letzte Blogeintrag ist bereits ein paar Wochen her. Warum? Zur Zeit arbeite ich an zwei sehr großen Projekten, die ich, sobald ich sie abgeschlossen habe, hier vorstellen werde. Das eine Projekt hat wieder mit einer Kamera zu tun (nein, diesmal keine Tropfenfotografie). Das andere, welches ich gemeinsam mit ralph mache, hat wieder mit dem ESP-Controller zu tun. Stay tuned.

So viel sei gesagt, hier folgt ein Lückenfüller. Es kommt nichts sonderlich neues, aber wem fad ist, der darf gerne bleiben. Der Titel verrät es schon, es geht um den Raspberry Pi und um Telegram. Das Vorhaben ist, dass man Statusnachrichten vom Pi direkt aufs Smartphone bekommt. Ich finde das immer recht praktisch, weil ich dann nicht erst meinen PC starten muss um dann via Terminal mit dem Pi kommunizieren zu können.

Get Telegram

Das Prozedere, um einen Bot aufzusetzen, habe ich hier schon gezeigt. Folgt einfach den Anweisungen des BotFathers, dann kann nichts mehr schief gehen.

Der Code

Diesmal nicht auf GitHub, sondern auf meiner Website. Es sind nicht einmal 100 Zeilen Code, das geht sich also dort gut aus.

Das Python-Script lege ich am Raspberry im Verzeichnis ~/Python/Telegram_Bot/Telegram_Bot.py ab. Wie ihr das macht bleibt euch überlassen, aber das Verzeichnis ist später noch wichtig.

Das Script sollte für all‘ jene, die Python verstehen nachvollziehbar sein, auch wenn ich mich nicht immer an die Community-Konventionen halte. Alle, die es (noch) nicht können: Ihr könnt mich gerne dazu fragen!

Was macht das Script? Sobald der Bot läuft bekommt ihr eine Nachricht von ihm. So wisst ihr, dass der Raspberry Pi online ist, sofern ihr das Script im Autostart ausführen lässt. Danach kann eine Konversation so aussehen:

conversation.jpg

Das tolle „neue“ Feature des BotFathers ist es, dass ihr jetzt eure Commands definieren könnt. So fällt das lästige Eintippen weg. Die Commands werden einfach per Klick gesetzt.

Autostart

Startet am Pi den nano-Editor im Verzeichnis

sudo nano /etc/rc.local

und ergänzt ihn um die Zeile

/home/pi/startup.sh

rc_local.jpg

Speichert und schließt die rc.local und erstellt oder öffnet die startup.sh mit

sudo nano /home/pi/startup.sh

und ergänzt sie mit dem Eintrag

/bin/sleep 15 && cd /home/pi/Python/Telegram_Bot/ && sudo python Telegram_Bot.py

startup_sh.jpg

Speichern. Schließen. Schon liegt das Script im Autostart. Die 15 Sekunden Wartezeit sind natürlich keine saubere Art das zu machen, aber ich habe auch nach (kurzer) Suche im Web keine andere, saubere Lösung gefunden.

Bei Fragen (oder der Lösung zum 15 sec Problem) schreibt mir einfach einen Kommentar!

Advertisements

ESP8266 & Telegram

Einen Mikrocontroller per Messenger Befehle senden oder Daten erhalten? Ja das geht, und es ist auch genau so cool wie es sich anhört!

An dieser Stelle sollte eigentlich ein kurzes Video folgen, da man dazu jedoch einen Premium-Tarif benötigt, und das neben meiner Website etwas unnötig wäre, gibt es stattdessen den Link zur genannten Website: 

http://deloarts.com/de/arduino/esp8266_telegram/

Dank der entsprechenden Lib (folgt später im Eintrag) erspart man sich viel Schreibarbeit und kann gleich loslegen. Wenn man sich die Bibliothek genauer anschaut merkt man die Ähnlichkeit zur Python API, es ist lediglich stark abgespeckt, was für die Nutzung auf dem ESP nur Hilfreich ist.

Telegram

Zuerst muss man Telegram als Messenger nutzen, entweder auf dem Smartphone, Tablet oder dem PC. Danach kann man schon damit beginnen, einen Bot zu erstellen. Der Übersicht zu Liebe folgt ein Copy/Paste-Inhalt aus dem Raspberry-Tutorial.

Startet damit in das Suchen-Feld den Namen BotFather einzugeben. Dies ist der Manager aller Bots auf Telegram. Bei ihm sucht man um einen neuen Bot an.

Search_Botfather

Sendet ihm den Befehl /newbot, wählt einen Namen und einen Benutzernamen. Der Benutzername ist öffentlich sichtbar und auffindbar, durch geschickte Programmierung redet der Bot aber nur mit ausgewählten Nutzern. Als Namen vergebe ich gerne einen projektbezogenen, in diesem Fall wäre ‚Doorbell‘ recht passend.

Talk_To_BotFather

Ist der Vorgang abgeschlossen, so erhält man einen eindeutigen Token. Dieser ist später im Programm wichtig!

Das Programm

Zu finden wie immer auf GitHub. Wer neu ist, und das ESP noch nicht so gut kennt, dem empfehle ich das Setup-Tutorial zum Board.

Oben im Beitrag habe ich die Lib erwähnt, welche für die Nutzung der Telegram API benötigt wird. Die habe ich sie in das GitHub-Verzeichnis von mir kopiert, um immer die passende Version zu haben.

Bevor ihr beginnen könnt, gebt die WLAN-Daten eures Netzwerks ein.

static char SSID[] = "your network name";
static char password[] = "your password";
static char hostname[] = "Doorbell";

Weiter geht’s mit den Definitionen des Programms, dazu muss man den Botnamen, seinen Usernamen, den Token und die ID angeben, an welche die Nachrichten geschickt werden sollen.

#define botName "Doorbell"
#define botUserName "something that ends with bot"
#define botToken "your:token"
#define adminID "yourID"

Die adminID ist demzufolge die ID eures persönlichen Telegram-Accounts. Um diese herauszufinden, ladet das Script auf den ESP, gebt aber zuvor in den Programmdefinitionen eure Daten ein (Username & Token). Über das Suchen-Feld in Telegram könnt ihr über den Usernamen euren Bot finden. Sendet danach dem Bot über Telegram eine Nachricht, dieser wird euch sodann eure ID zurücksenden.

String senderID = bot.message[i][4];
bot.sendMessage(bot.message[i][4], "Access denied. Your ID: " + senderID, "");

Ein anderer Weg ist der serielle Monitor. Die Chat ID wird bei jedem Zugriff angezeigt.

Tragt danach die ID einfach an der entsprechenden Stelle im Programm ein, und voilà, der Bot hört auf euch.

Am Beginn sollte man den ESP via USB mit dem PC verbinden (auf die Baudrate achten), um die Debuginformation zu erhalten. So lässt sich leicht ein möglicher Fehler entdecken, etwa falsche WLAN-Zugangsdaten oder ein falscher Token.

Zurück zum eigentlichen Programm.

Im setup() werden alle Routinen gestartet, das Programm ist (hoffentlich) gut auskommentiert.

In der loop() ist es schon etwas interessanter. Grundsätzlich wäre dem Zweck Genüge getan, wenn der Controller auf das Betätigen des Tasters wartet, und dann eine Nachricht an die AdminID sendet.

if (!digitalRead(inputPin))
{
    bot.sendMessage(adminID, "Ding Dong", "");
}

Ich möchte aber auch zeigen, wie man dem ESP über Telegram Befehle senden kann, weshalb das Programm noch etwas weiter geht. So könnte man etwa ein Relais ansteuern, oder Daten eines Sensors abgreifen. Um das tun zu können, muss man wissen, wo die Daten gespeichert werden.

Grundsätzlich werden die Telegram-Daten beim Empfangen in einem zweidimensionalen Array gespeichert: bot.message[i][j]. Ist i gleich 0, so werden Sonderfälle behandelt:

  • bot.message[0][0]: Anzahl der anstehenden Nachrichten.
  • bot.message[0][1]: ID der letzten Nachricht.

Ansonsten ist i der Index der eingegangenen Nachrichten. j beinhaltet die Daten, welche zu i gehören.

  • bot.message[i][0]: Update ID
  • bot.message[i][1]: User ID
  • bot.message[i][2]: Vorname
  • bot.message[i][3]: Nachname
  • bot.message[i][4]: User ID
  • bot.message[i][5]: Nachricht

Zuerst prüfen wir, ob Updates, also neue Nachrichten zur Verfügung stehen. Diese werfen wir dazu in das Array um sie später zur Verfügung zu haben.

bot.getUpdates(bot.message[0][1]);

Danach arbeiten wir uns Schritt für Schritt durch die Daten durch, und prüfen zugleich, ob die empfangene Nachricht einem Befehl entspricht.

for (int i = 1; i < bot.message[0][0].toInt() + 1; i++)
{
    if (bot.message[i][4] == adminID)
    {
        bot.message[i][5] = bot.message[i][5].substring(1, bot.message[i][5].length());
        if (bot.message[i][5] == "info")
        {
            bot.sendMessage(bot.message[i][4], "Hello.", "");
            bot.sendMessage(bot.message[i][4], "I am your doorbell.", "");
        }

        ...

    }
}

i entspricht, wie wir wissen, dem Index der IDs, welche dem Bot eine Nachricht gesendet haben. Bevor wir also auf eine Nachricht antworten, prüfen wir ob der Absender auch berechtigt ist, eine Antwort vom Bot zu bekommen. Ist er das nicht, bekommt er eine entsprechende Rückmeldung.

bot.sendMessage(bot.message[i][4], "Access denied.", "");

So viel zum Programm. Man sieht, es steckt nicht viel dahinter (also, eigentlich schon, aber das Interface ist einfach).

Der elektrische Aufbau

Zum Testen des Programms reicht die Lochrasterplatine vom Setup-Tutorial und ein Taster, wie es im Video am Beginn gezeigt wird.

Ich möchte die bestehende Türklingel nicht durch die WIFI-Klingel ersetzen, sondern beide parallel bestehen haben. Deshalb setze ich ein Relais in die Leitung der vorhandenen Glocke, welches das Signal an den Controller gibt, sobald die Taste betätigt wird. Hierfür muss man das Relais entsprechend der verbauten Klingel auswählen. Meine arbeitet mit 12VDC, weshalb ich auch ein Relais nutze, das bei 12V schließt. Dabei ist darauf zu achten, dass das Netzteil für die Klingel genügend Strom für die Klingel selbst, als auch für das Relais liefert.

shematic.jpg

Im Schaltplan erkennt man unter anderem, dass das Relais ohne Pull-Down-Widerstand (im Normalfall 10kΩ) an den Controller angeschlossen wird. Der Grund ist der gleiche, wie der im Setup-Tutorial beschriebene: Ist einer der beiden GPIO-Pins beim Booten nicht logisch HIGH (oder in einem Zwischenzustand), so startet der ESP nicht das Programm, sondern erwartet den Upload eines Programms. Deshalb starte ich den ESP mit offenem Relais (es ist doch sehr unwahrscheinlich, dass jemand anleutet wenn der Controller gerade bootet).

Der zweite Punkt, welcher auffällig ist, ist dass der GPIO-Pin über das Relais nicht mit +3V3 verbunden ist, sondern mit der Groundleitung. Dazu bedarf es einer Erklärung des …

INPUT_PULLUP

Von den Schaltungen eines Arduinos ist man es gewohnt, einen Taster mit VCC und dem Pin zu verbinden. Vom Pin ausgehend schließt man einen hochohmigen Widerstand auf Ground um Störsignale oder Signalschwankungen zu filtern.

input

Würde man den Pull-Down-Widerstand weglassen, so wäre der Pin bei offenem Taster in einem Zwischenzutand (floating). Es ist also nicht eindeutig festgelegt, ob der Taster nun offen ist. Auf diese Weise können Signale der Umgebung, elektromagnetische oder magnetische Felder, den Pin beeinflussen. Das kann man sich sehr gut veranschaulichen, indem man sich über den seriellen Monitor eines blanken Arduinos den Wert eines Analogpins ausgeben lässt. Bewegt man das Board oder hält ein elektrisches Gerät in seine Nähe, so ändert sich der Wert.

/* Button an Pin 12,
   LED an Pin 13
*/
pinMode(12, INPUT);
pinMode(13, OUTPUT);
digitalWrite(13, digitalRead(12));

Das Programm sieht daher so aus wie immer, wird der Taster betätigt, so leuchtet die LED. Das ganze kann man aber auch umgekehrt lösen, indem man einen Pull-Up-Widerstand nutzt. Dieser wird zwischen VCC und dem Pin eingesetzt.

input_pullup

Ist der Taster offen, so bleibt die Spannung am Widerstand gleich – 5V, 3V3, … was auch immer die Versorgungsspannung ist. Das bedeutet, dass am Pin immer 5V, 3V3, … anliegen. Wird der Taster gedrückt, so fällt die Spannung auf Null ab. Durch den hochohmigen Widerstand verhindert man zudem ein Kurzschließen des Schaltkreises. Man sollte allerdings keinen allzu großen Widerstand wählen, da ansonsten das Rauschen wieder zurückkehrt (Luft ist ja auch ein Widerstand) – 10kΩ sind die Faustregel bei Controllern bis +5V Betriebsspannung.

/* Button an Pin 12,
   LED an Pin 13
*/
pinMode(12, INPUT);
pinMode(13, OUTPUT);
digitalWrite(13, !digitalRead(12));

Im Programm hat man nur eine kleine Änderung zu machen: Den Input mit dem Rufzeichen zu negieren. Ist der Taster nicht gedrückt gibt digitalRead(pin); true zurück und vice versa.

Nun könnten wir das bereits nutzen, um den Button am ESP anzuschließen. Der Pin wäre ohne Interaktion immer logisch HIGH, wodurch der Controller problemlos booten kann. Allerdings hat der Controller die nette Eigenschaft, einen hochohmigen Widerstand hinter seinen GPIO-Pins verbaut zu haben. Das bedeutet, dass wir uns darum nicht mehr kümmern müssen und der Aufbau sich vereinfacht:

input_internal

Gut, etwas muss man schon beachten: Der interne Widerstand muss aktiviert werden. Dies erledigt man, indem man den Input nicht mit pinMode(PIN, INPUT);, sondern mit pinMode(PIN, INPUT_PULLUP); festlegt.

/* Button an Pin 12,
   LED an Pin 13
*/
pinMode(12, INPUT_PULLUP);
pinMode(13, OUTPUT);
digitalWrite(13, !digitalRead(12));

Das lässt sich übrigens auch am Arduino anwenden. Wer also gerade keinen Widerstand zur Hand, oder nicht genug Platz für einen hat, muss nicht verzweifeln: einfach INPUT_PULLUP nutzen!

Weiters sind, auf das Arduino Nano bezogen, auch die analogen Pins A0-A5 (oder 14-19) als digitaler Input nutzbar, und sie haben ebenso einen Pull-Up-Widerstand verbaut. Lediglich die beiden letzten analogen Inputs (A6 und A7 [oder 20 und 21]) haben keinerlei Schaltung und dienen ausschließlich als analoger Input.

Und weil wir bereits beim Arduino sind: Der digitale Pin 13 kann nicht als Pull-Up-Input genutzt werden, da auf den Arduino Boards eine LED mit einem 330Ω Widerstand verbaut ist. Diese verhindert die Funktion, da sie den Pin dauerhaft mit GND verbindet und somit der Pin immer geschalten werden würde.

Zurück zum Thema: Für den Aufbau habe ich die folgenden Bauteile genutzt:

.

Stk. Komponente Ausführung Beschreibung
1 ESP8266 ESP-01
1 Widerstand 10kΩ
1 Spannungsregler LD33V 12VDC -> 3V3DC
2 Elektrolytkondensator 10µF
1 Kermaikkondensator 0.1µF
1 Relais 12VDC Passend zur Klingel

.

Die Kondensatoren dienen zur Glättung der Spannung, ohne diese würde der Spannungswandler instabil werden und die Spannung am Ausgang würde stark schwanken – schlecht für den ESP. Das passiert, weil der verwendete Spannungswandler von seinem Aufbau her ein rückgekoppelter Verstärker ist.

setup

Eine weitere Möglichkeit, neben dem Taster, wäre die Nutzung eines Infrarot-Bewegungsmelders. Diesen könnte man sogar an den verbeleibenden Pin des ESP anschließen (auf die galvanische Trennung beim Booten sollte man achten).

Fragen? Kommentar!