Use Telegram on your Arduino (ESP8266 or Wifi-101 boards)
Clone or download

README.md

Universal Telegram Bot Library

An Arduino IDE library for using Telegram Bot API. It's designed to be used with multiple Arduino architectures.

Join the Arduino Telegram Library Group Chat if you have any questions/feedback or would just like to be kept up to date with the library's progress.

Introduction

This library provides an interface for Telegram Bot API.

Telegram is an instant messaging service that allows for the creation of bots. Bots can be configured to send and receive messages. This is useful for Arduino projects as you can receive updates from your project or issue it commands via your Telegram app from anywhere.

This is a library forked from one library and inspired by another

Each library only supported a single type of Arduino and had different features implemented. The only thing that needs to be different for each board is the actual sending of requests to Telegram so I thought a library that additional architectures or boards could be configured easily would be useful, although this springs to mind:

alt text

Installing

The downloaded code can be included as a new library into the IDE selecting the menu:

 Sketch / include Library / Add .Zip library

You also have to install the ArduinoJson library written by Benoît Blanchon. Search for it on the Arduino Library manager or get it from here.

Getting Started

To generate your new Bot, you need an Access Token. Talk to BotFather and follow a few simple steps described here.

Include UniversalTelegramBot in your project:

#include <UniversalTelegramBot.h>

and pass it a Bot token and a SSL Client (See the examples for more details)

#define BOTtoken "XXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
// WiFiSSLClient client; //For 101 boards
WiFiClientSecure client; //For ESP8266 boards
UniversalTelegramBot bot(BOTtoken, client);

NOTE: This library has not been tested with the 101 boards as I do not have a compatible board. If you can help please let us know!

Features

Here is a list of features that this library covers. (Note: The examples link to the ESP8266 versions)

Feature Description Usage Example
Receiving Messages Your bot can read messages that are sent to it. This is useful for sending commands to your arduino such as toggle and LED int getUpdates(long offset)

Gets any pending messages from Telegram and stores them in bot.messages . Offset should be set to bot.last_message_received + 1. Returns the numbers new messages received.
FlashLED or any other example
Sending messages Your bot can send messages to any Telegram or group. This can be useful to get the arduino to notify you of an event e.g. Button pressed etc (Note: bots can only message you if you messaged them first) bool sendMessage(String chat_id, String text, String parse_mode = "")

Sends the message to the chat_id. Returns if the message sent or not.
EchoBot or any other example
Reply Keyboards Your bot can send reply keyboards that can be used as a type of menu. bool sendMessageWithReplyKeyboard(String chat_id, String text, String parse_mode, String keyboard, bool resize = false, bool oneTime = false, bool selective = false)

Send a keyboard to the specified chat_id. parse_mode can be left blank. Will return true if the message sends successfully.
ReplyKeyboard
Inline Keyboards Your bot can send inline keyboards.

Note: URLS & callbacks are supported currently
bool sendMessageWithInlineKeyboard(String chat_id, String text, String parse_mode, String keyboard)

Send a keyboard to the specified chat_id. parse_mode can be left blank. Will return true if the message sends successfully.
InlineKeyboard
Send Photos It is possible to send phtos from your bot. You can send images from the web or from the arduino directly (Only sending from an SD card has been tested, but it should be able to send from a camera module) Check the examples for more info From URL

Binary from SD

From File Id
Chat Actions Your bot can send chat actions, such as typing or sending photo to let the user know that the bot is doing something. bool sendChatAction(String chat_id, String chat_action)

Send a the chat action to the specified chat_id. There is a set list of chat actions that Telegram support, see the example for details. Will return true if the chat actions sends successfully.
Location Your bot can receive location data, either from a single location data point or live location data. Check the example. Location
Channel Post Reads posts from channels. Check the example. ChannelPost
Long Poll Set how long the bot will wait checking for a new message before returning now messages.

This will decrease the amount of requests and data used by the bot, but it will tie up the arduino while it waits for messages
bot.longPoll = 60;

Where 60 is the amount of seconds it should wait
LongPoll

The full Telegram Bot API documentation can be read here. If there is a feature you would like added to the library please either raise a Github issue or please feel free to raise a Pull Request.

Other Examples

Some other examples are included you may find useful:

  • BulkMessages : sends messages to multiple subscribers (ESP8266 only).

  • UsingWifiManager : Same as FlashLedBot but also uses WiFiManager library to configure WiFi (ESP8266 only).

License

You may copy, distribute and modify the software provided that modifications are described and licensed for free under LGPL-3. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be.