Automazione con BOT Telegram

luca 13/10/2015 39

Il progetto che oggi vi presento è una sorta di proof of concept che vuole dimostrare la possibilità di controllare da remoto sensori ed attuatori (ad esempio dei relay) tramite Telegram.

Telegram è una applicazione di messaggistica, simile al più famoso Whatsapp. A giugno, gli sviluppatori di Telegram hanno annunciato la disponibilità  di API per sviluppare dei bot.

Un bot è un programma che può agire (parzialmente) come un utente reale: ricevere/inviare messaggi, partecipare alle chat di gruppo… i bot ad esempio sono molto utilizzati nei canali IRC.

La mia idea è stata quindi sviluppare un bot, in esecuzione su un Raspberry Pi, che riceva comandi tramite una chat Telegram. Alla scheda Rasbperry ho collegato un sensore di temperatura / umidità e un modulo con due relay. Ecco un breve filmato che illustra il progetto (sottotitoli italiani disponibili!):

Funzionamento

Il funzionamento del bot è riassunto nello schema seguente:

bot-0

L’utente, tramite l’app Telegram installata sul proprio smartphone, inizia una chat con l’utente “bot”; i messaggi vengono inviati ai server di Telegram. Il programma in esecuzione sulla Raspberry può ricevere i messaggi in due modi:

  • polling, ogni tot secondi il programma verifica se vi sono nuovi messaggi e li scarica
  • webhook, il programma comunica a Telegram un indirizzo web a cui notificare i nuovi messaggi

La seconda soluzione richiede la disponibilità di un indirizzo IP pubblico e configurazioni (NAT) sul router di collegamento ad Internet, per questo ho optato per il più semplice polling.

Creiamo il bot

Il primo passo per sviluppare un bot è crearlo all’interno di Telegram. Esiste un apposito bot a cui inviare tutti i comandi di creazione e configurazione: BotFather:

telebot-1

Iniziamo la creazione di un nuovo bot inviando al BotFather il comando /newbot. Ci verrà chiesto il nome (display name) del nuovo bot e il suo username. Se la creazione del bot ha successo, ci verrà restituito un authorization token che dovremo inserire nel nostro programma:

telebot-2

Installazione

Ho sviluppato il bot in linguaggio javascript, utilizzando Node.js come environment per eseguirlo (per l’installazione di Node.js su Raspberry vi rimando all’ottima guida di Adafruit). Il programma utilizza 3 librerie:

  • node-dht-sensor, per la lettura dei dati di umidità e temperatura dal sensore DHT11
  • onoff, per il controllo dei PIN digitali di Raspberry
  • node-telegram-bot, per il collegamento alle API Telegram

L’installazione delle librerie è semplicissima grazie a NPM (Node Package Manager). Create una nuova cartella che conterrà il codice del bot e le sue librerie; entrate in tale cartella e digitate il comando:

npm install node-dht-sensor onoff node-telegram-bot

All’interno della cartella copiate quindi il sorgente javascript del bot, disponibile nel mio repository su Github. Il codice è commentato e dovrebbe essere di facile lettura: per qualsiasi dubbio scrivete un commento a questo articolo!

Ricordatevi di modificare il token del bot inserendo quello che vi avrà restituito BotFather:

bot_token

Per lanciare il bot, sarà sufficiente digitare:

sudo node bot.js

bot_launch

Utilizzo

I comandi disponibili sono:

  • /getouts, visualizza lo stato dei due relay
  • /setout1 ON|OFF/setout2 ON|OFF, imposta una delle due uscite a ON o OFF
  • /gettemp, visualizza la temperatura attuale
  • /gethum, visualizza l’umidità attuale

bot3

Sicurezza

I bot di Telegram sono pubblici, quindi qualsiasi utente può inviare loro dei comandi. Per fare in modo che il bot sia utilizzabile solo dal mio utente, ho aggiunto nel codice un controllo sull’ID dell’utente che invia i messaggi:

bot_security

Per conoscere il proprio ID, è possibile utilizzare un piccolo bot, sempre su Github, che risponde ad ogni messaggio con il messaggio originale (echo) e l’ID del mittente:

bot_security2 Elettronica

Il setup del mio esempio prevede un sensore temperatura/umidità DHT11 e un modulo con due relay. Ho collegato i due moduli ai PIN di espansione (1 per il sensore, 2 per i relay, oltre all’alimentazione) di Raspberry Pi:

bot1 bot2

Nel programma ho definito i corretti PINs:

bot_pins

What’s next

Questo progetto vuole essere un punto di inizio, che dimostra come sia possibile sviluppare un bot per inviare comandi tramite Telegram.

Le API di Telegram offrono diverse funzioni avanzate, come ad esempio la possibilità di elencare i comandi possibili, di cambiare l’immagine di avatar del bot o quella di personalizzare la tastiera dell’app: nel nostro esempio all’invio del comando /setout1 si potrebbe richiedere all’utente lo stato (ON|OFF) di tale uscita, visualizzando sull’app i due pulsanti di scelta.

39 Comments »

  1. haxon 15/10/2015 at 16:22 - Reply

    Did you know that Openhab has this functionality as well? Someone made an addon for telegram interaction.

    It might be not as much fun as doing it yourself, but you could give it a shot ;)

    • luca 16/10/2015 at 07:44 - Reply

      Hi, thanks I didn’t know the OpenHab project, very interesting!

  2. sparviero 21/10/2015 at 09:16 - Reply

    for(i = 0; i < authorized_users.length; iè++)

    nel tuo bog.js c'e' un errore alla linea 112, capita anche a me di premere 20 tasti consecutivamente con le ditone che mi ritrovo ;o)

    • luca 21/10/2015 at 10:59 - Reply

      grazie mille! lo sistemo subito ;)

  3. Beppe 12/11/2015 at 14:00 - Reply

    Ciao Luca.
    non ho capito se per installare telegram sul raspberry serve un altro numero di telefono, e se la creazione della bot va fatta sul raspberry.
    puoi spiegarmi in stampatello per favore.
    sono un po lento….
    grazie.

    • luca 13/11/2015 at 08:27 - Reply

      Ciao Beppe, il bot “gira” su Raspberry: è un programmino che lanci (volendo puoi farlo partire non appena dai corrente al Raspberry). Per funzionare non ti serve un altro numero di telefono ma devi “registrare” il tuo bot come spiegato nell’articolo per ottenere da Telegram un “token” (un codice identificativo) che è simile al numero di telefono per gli utenti “veri”.

  4. Claudio Mussoni 28/12/2015 at 09:47 - Reply

    Ciao Luca, ho un po’ di confusione sulle librerie. Le hai scritte tu oppure fanno parte di un progetto che hai trovato per il Raspberry ? Dove le posso trovare ?
    Mille grazie

  5. Claudio Mussoni 28/12/2015 at 15:13 - Reply

    Gentilissimo, grazie.
    Claudio

  6. lxs 20/01/2016 at 14:12 - Reply

    Ciao luca, quando provo ad installare le librerie mi da questi errori dove sbaglio?

    npm install node-dht-sensor onoff node-telegram-bot \
    > node-dht-sensor@0.0.8 install /home/pi/TelegramBot/node/node_modules/node-dht-sensor
    > ./check-bcm2835

    —————————————————————————-
    Library BCM2835 not found!
    Make sure you follow instructions at http://www.airspayce.com/mikem/bcm2835/
    to install the BCM2835 library on your system.
    —————————————————————————-
    |[…]

    • luca 23/01/2016 at 09:39 - Reply

      Ciao! Come ti dice l’errore, ti mancano le librerie BCM2835 per Node, segui le istruzioni al link indicato

  7. Juan Bracamonte 21/01/2016 at 14:03 - Reply

    Ciao Luca, quando si tenta di installare la linea di NPM me il seguente errore mio raspbian getta, può essere? Sono bloccato qui per giorni

    gyp ERR! stack Error: ENOSPC, mkdir ‘/home/pi/node_modules/node-dht-sensor/.node-gyp’
    […]

    • luca 23/01/2016 at 09:38 - Reply

      ciao! sembra un problema di permessi… davvero strano se lo lanci da root: puoi provare a partire con una immagine Raspbian “pulita”?

  8. Stefano 24/01/2016 at 15:34 - Reply

    Consigli su qualche tutorial per imparare ad usare NODE.js ?
    Grazie !

  9. Luigi 27/01/2016 at 13:32 - Reply

    Ok, facendo qualche ricerca ho capito che ciò che hai scritto è per un comando seguito da on oppure off, ho capito come implementare il cambiamento di tastiera, si trova in send messagge quindi oltre chat id e text andrebbe scritto reply_markup:
    e come argomento ci va direttamente un array di array contenente [[‘ON’][‘OFF’]]?

    case message.text == “/testonoff”:
    bot.sendMessage({
    chat_id: message.chat.id,
    text: ‘on o off?’, //test per tastiera
    reply_markup: [[“ON”,”OFF”]],
    });
    break;
    se è giusto, come riesco a indicare la condizione ad esempio if(replay_markup == ‘ON’) then ?
    Grazie della disponibilità, mi saresti di grandissimo aiuto

    • luca 31/01/2016 at 13:32 - Reply

      Ciao Luigi, la tastiera personalizzata è solo lato “client”, quello che tu leggi in risposta è comunque il testo “ON” o “OFF”, il confronto va sempre fatto sulla variabile message.text

  10. daniele 16/02/2016 at 14:31 - Reply

    ciao Luca,complimenti per l ottima guida che hai scritto,trovo davvero molto interessante l utilizzo di telegram per comunicare con il piccolo raspberry.
    Sono riuscito a far funzionare tutto subito grazie alle spiegazioni semplici ed efficaci …sono riuscito ad aggiungere al tuo bot(modificandolo) altre uscite per collegare dei relè aggiuntivi ….sarebbe interessante aggiungere la possibilita di ricevere in chat tramite un comando anche una foto scattata da una webcam o magari da un ip cam…. è da molto che sto cercando su internet qualche tutorial ma …zero.(nn sono un esperto in progr)
    magari vista la tua esperienza potresti implementarlo in questo progetto …
    Grazie ciao ciao

    • luca 17/02/2016 at 08:56 - Reply

      Ciao Daniele! ottimo suggerimento, mi metto al lavoro ;)

      • daniele 17/02/2016 at 10:36 - Reply

        …Grande !!!

  11. Davide 20/02/2016 at 12:23 - Reply

    Ciao, complimenti per la guida!
    Volevo chiederti se era possibile fare la stessa cosa con un sensore di temperatura differente, il DS18B20?

    Per caso conosci qualche guida?

    Grazie

    • luca 20/02/2016 at 12:53 - Reply

      Ciao! Assolutamente sì, devi solo cambiare il “modulo” che si interfaccia al sensore… ecco un tutorial

      • Davide 23/02/2016 at 08:32 - Reply

        Grazie mille! ti faccio ancora una domanda: ho provato il tuo sorgente javascript sul mio raspberry e funziona perfettamente ma il problema è che dopo molte ore non risponde più ai comandi su telegram e sono costretto a riavviarlo. Secondo te quale potrebbe essere il problema?
        Grazie

        • luca 25/02/2016 at 20:11 - Reply

          ma il bot resta attivo o si chiude/crasha?

          • Davide 26/02/2016 at 17:24 -

            Penso di aver capito il problema ma non so come risolverlo. Capita che la connessione internet cada per un tempo limitato e penso sia questo quello che faccia saltare tutto

  12. Vinicius Fernandes Affonso 04/03/2016 at 18:35 - Reply

    i have problem with 1 line bot.js

    pi@raspberrypi:~ $ sudo python ~/bot/bot.js
    File “/home/pi/bot/bot.js”, line 1
    // Authorized users, replace with your real IDs
    ^
    SyntaxError: invalid syntax

    • luca 04/03/2016 at 20:10 - Reply

      Hi! you’re using the python interpreter while the code runs on node.js

      • Vinicius Fernandes Affonso 04/03/2016 at 21:06 - Reply

        now its work ;)

  13. haerul nurdiana 02/04/2016 at 17:18 - Reply

    Hi Luca, I have problem
    where i can get authorized user ?

    • luca 04/04/2016 at 07:51 - Reply

      Hi! Run the “userid.js” bot, you can download it from Github. When you write a command to the bot, it outputs on the console your user ID

  14. jose 20/04/2016 at 18:12 - Reply

    Luca, Thanks for the tutorial. I am confused on the polling or webhook. Where is the loop or event polling the telegram server every 2 seconds in the bot.js listing? Or how this works?
    Please let me know where can I find details . Thanks in advance !

    • luca 21/04/2016 at 16:02 - Reply

      Hi Jose, all the interaction between your bot and telegram is performed by the Bot library I’m using, no external code is required.

  15. jose 22/04/2016 at 19:23 - Reply

    Luca Thanks a lot again. I’ve installed on RPI running ArchLinux and works perfect. Only problem the DHT module was not possible to install I’ve tried several times and on the middle of the install the RPI gets extremely slow and almost hungs and I must do hard reset. This is not an issue for me as I do not have that sensor, I will try using the npm for the DS18b20.
    Concerning my previous question, then the polling seems to be the default as the script never mentioned it right ?

  16. willy 28/04/2016 at 19:40 - Reply

    Salve trovo molto interessante il suo progetto.
    Avrei una domanda, io non sono esperto, sarebbe possibile col bot BotFather, eseguire una operazione di conferma (positiva o negativa), ad una richiesta che arriva su un canale telegram, in cui si chiede di cliccare su SI o NO?
    E fare eseguire tale operazione più volte al giorno, e solo quando in quel canale viene richiesta la conferma? In quanto dopo la conferma ritorna sempre un messaggio di sistema di accettazione avvenuta.

    • luca 02/05/2016 at 07:49 - Reply

      Salve Willy… dipende: se la richiesta è diretta ad un particolare utente no, un BOT non può sostituirsi all’utente. Se invece si tratta di inviare in un canale – a cui il bot è collegato – un messaggio in maniera periodica sì, è possibile.

  17. Nicola 10/12/2016 at 00:36 - Reply

    Progetto molto interessante, non sono molto esperto ma ho visto che comandare 4 relè è molto semplice editando leggeremente il file. Volevo estendere il controllo a due sensori uno interno DHT 11 e uno esterno DHT 22 è possibile?
    Grazie mille.

    • luca 11/12/2016 at 17:40 - Reply

      Ciao! Assolutamente sì, ti basta definire due variabili tipo SensorLib e inizializzarle correttamente (indicando il PIN a cui hai collegato i due sensori e il “modello”, quindi 11 e 22)

  18. Luis M 25/12/2016 at 05:24 - Reply

    Hi, I was testing your code, it was working fine but then I don’t understand why I get this message everytime

    home/pi/relaybot/node_modules/node-telegram-bot/lib/Bot.js:221
    if (msg.message.text && msg.message.text.charAt(0) === ‘/’) {

    • luca 27/12/2016 at 08:51 - Reply

      hi, do you mean that you get an error/warning message on that line?

Leave A Response »

Questo sito usa i cookie per poterti offrire una migliore esperienza di navigazione maggiori informazioni

Questo sito utilizza i cookie per fonire la migliore esperienza di navigazione possibile. Continuando a utilizzare questo sito senza modificare le impostazioni dei cookie o clicchi su "Accetta" permetti al loro utilizzo.

Chiudi