Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jordiprats/micropython-utelegram
Telegram API wrapper for microPython
https://github.com/jordiprats/micropython-utelegram
esp32 micropython telegram-bot-api
Last synced: 3 months ago
JSON representation
Telegram API wrapper for microPython
- Host: GitHub
- URL: https://github.com/jordiprats/micropython-utelegram
- Owner: jordiprats
- License: apache-2.0
- Created: 2020-09-07T10:01:59.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-06T16:48:04.000Z (about 1 year ago)
- Last Synced: 2024-05-09T22:39:05.639Z (6 months ago)
- Topics: esp32, micropython, telegram-bot-api
- Language: Python
- Homepage:
- Size: 29.3 KB
- Stars: 77
- Watchers: 5
- Forks: 15
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-micropython - micropython-utelegram - Telegram API wrapper for MicroPython. (Libraries / Communications)
README
# micropython-utelegram
This library provides a **microPython** interface for for a subset of the **Telegram Bot API**. Have been tested on an **ESP32** but should work just fine on an **ESP8266**. Further tests have been done on **RP2040** with successful results.
## Your first bot
On the demo folder you will find an example bot.
First you'll need to create a new bot using the **BotFather** to get a token for your bot. Once you have it rename the **config.py-demo** and set the variables (WiFI SID/password and your bot token):
```python
wifi_config = {
'ssid':'DEMO',
'password':'PASSW0RD'
}
utelegram_config = {
'token': 'TOKEN'
}
```
If you have your **ESP32** connected as **/dev/ttyUSB0** you can use the upload.sh script to upload the bot code to your **micropython enabled ESP32**:
```bash
./upload.sh
```
### Example bot code
#### Initialize bot
To create a new bot you just need to create a ubot object passing the token the **BotFather** have provided:
```python
bot = utelegram.ubot(utelegram_config['token'])
```
#### Register handlers
Handlers will receive the raw message as a parameter:
```python
def reply_ping(message):
bot.send(message['message']['chat']['id'], 'pong')
```
Messages will be in the following format:
```python
{
"update_id":302445393,
"message":{
"message_id":1492,
"from":{
"id":123456789,
"is_bot":False,
"language_code":"en",
"first_name":"Jordi"
},
"text":"/ping",
"date":1599563930,
"entities":[
{
"offset":0,
"length":5,
"type":"bot_command"
}
],
"chat":{
"id":123456789,
"type":"private",
"first_name":"Jordi"
}
}
}
```
You can register handlers using the **register** method:
```python
bot.register('/ping', reply_ping)
```
And optionally set a **default handler** for any other message:
```python
bot.set_default_handler(get_message)
```
### Reply to messages
Using the send function we can reply to messages, the parameters are:
* **chat ID**: chat ID is the same as the user ID except for group chats
* **message**: text to send
For example, we can use the incoming message to get the **chat_id** to reply to:
```python
bot.send(message['message']['chat']['id'], 'pong')
```
### Bot loop
We can either let the bot loop but itself to reply to messages:
```python
bot.listen()
```
Or we can loop manually using the **read_once()** function:
```python
bot.read_once()
```
Using this method you should add a sleep between each time we poll the Telegram API
## Other examples
* [Telegram integrated countdown timer](https://github.com/jordiprats/micropython-remainigdays)