Home automation with Telegram BOT

luca 13/10/2015 35

The project I’m going to describe today it’s a sort of proof of concept that will demonstrate the possibility to remote control sensors and actuators (for example a couple of relays) via Telegram.

Telegram is an instant messaging application, similar to the famous Whatsapp. Last June, the Telegram developers announced that a new set of APIs were available to develop bots.

A bot is a computer program that can (partially) act as a real user: receive/send messages, join group chats… bots for example have been and are still very used in IRC channels.

My idea was to develop a bot, running on my Raspberry Pi, that receives commands via Telegram chats. I connected to the Raspberry a temperature/humidity sensor and a module with two relays. Here’s a short video that describes the project:

How it works

The working of the bot is shown in the following diagram:

bot-0

The user, through the Telegram app installed on his smartphone, starts a chat with the “bot” account; the messages are delivered to the Telegram servers. The program running on the Raspberry can get the messages in two ways:

  • polling, every tot seconds the program verifies if there are new messages and fetches them
  • webhook, the program configures Telegram to dispatch the new messages to a web URL

The second solution requires a public IP address (static or a dyndns service) and some configuration (NAT) on your Internet router, I therefore chose to implement the simpler polling.

Let’s create the bot

The first step in developing your own bot, is to create it in Telegram. You create new bots or configure existing ones sending the right commands to a “built-in” bot, the BotFather:

telebot-1

Start the process to create a new bot sending to the BotFather the command /newbot. You’ll be prompted for the name (display name) of your new bot and for its username. If the process is successful, you’ll receive an authorization token, that is the “password” you must specify in your program to “impersonate” the bot:

telebot-2

Installation

My bot was developed in javascript to be run withing the Node.js server environment (please refer to the great tutorial from Adafruit to install it on your Raspberry). The program needs 3 libraries:

  • node-dht-sensor, to read the temperature and humidity values from a DHT11 sensor
  • onoff, to control the Raspberry digital PINs
  • node-telegram-bot, to use the Telegram APIs

The library installation is super simple thanks to the NPM (Node Package Manager). Create a new folder to save the bot code and, within that folder, type the following command:

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

Copy in the same folder the bot’s javascript code, available in my Github repository. The code has a lot of comments and should be easy to understand: for any dubts feel free to add a comment to this post!

Remember to change the token in the code, typing the one generated by the BotFather for your bot:

bot_token

To run the bot, type:

sudo node bot.js

bot_launch

Usage

The available commands are:

  • /getouts, shows the actual status of the two relays
  • /setout1 ON|OFF/setout2 ON|OFF, sets one of the two outputs to ON or OFF
  • /gettemp, shows the actual temperature
  • /gethum, shows the actual humidity

bot3

Security

Telegram bots are public, that means that every user can send messages to them. To be sure that my bot will answer only to me, I added in the code a check on the ID of the user that is sending commands to the bot:

bot_security

If you need to retrieve your Telegram ID, you can use a small bot, this too available on Github, that simply answer each message with the original one (echo) and the sender ID:

bot_security2 Electronics

In my example, I used a DHT11 temperature/humidity sensor and a module with two relays. I connected the two elements to the expansion PINs of my Raspberry (1 PIN for the sensor and 2 for the relays, in addition to the power supply):

bot1 bot2

In the program, I configured the correct PIN numbers:

bot_pins

What’s next

The goal of this project was to demonstrate how it was possible to develop a bot that can receive commands via Telegram: it’s a starting point.

Telegram APIs offer a lot of advanced featured to explore, for example the ability to list the available commands, to change the bot’s avatar or to customize the app keyboard: in my example, when the user sends the /setout1 command, the bot may ask the desired status (ON|OFF) for that output customizing the app to show a keyboard with only two buttons, for the two possible choices.

35 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.

Leave A Response »

This website uses cookies to ensure you get the best experience on our website 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