https://github.com/thedevstone/telegram-home-control-bot
https://github.com/thedevstone/telegram-home-control-bot
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/thedevstone/telegram-home-control-bot
- Owner: thedevstone
- Created: 2020-07-21T13:18:53.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-16T17:10:27.000Z (about 3 years ago)
- Last Synced: 2025-01-23T03:14:40.472Z (5 months ago)
- Language: Python
- Size: 1.94 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# YI Hack Telegram Bot - MQTT notifications and Web Services
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Bot creation](#bot-creation)
- [Installation](#installation)
- [Performance](#performance)
- [Supported devices](#devices)
- [Donation](#donation)
## Features
- **Authentication**
- User Authentication based on telegram unique username
- Administrator access logs push
- **Authorization**
- Access Control List on single cameras for single user
- **MQTT**
- Notifications
- Realtime motion detection images from MQTT
- Realtime sound detection
- Status notification
- Baby crying notification
- Switch MQTT messages on and off
- **Snapshot**
- Ask for last snapshot from cameras
- **Video**
- Ask for n-th last video from cameras
- **Audio**
- Text to Speech to cameras
- Send Audio to cameras
- **Switch**
- Switch entities, like shelly relays
### Features screenshots
- **Authentication**
- **Authorization**
- **MQTT**
- **Snapshot**
- **Video**
- **Audio**
### YI Cameras (Optional)
Install correct **YI-Hack** firmware for your camera:
- [YI-Hack-Allwinner](https://github.com/roleoroleo/yi-hack-Allwinner/)
- [YI-Hack-Allwinner-v2](https://github.com/roleoroleo/yi-hack-Allwinner-v2/)
- [YI-Hack-MStar](https://github.com/roleoroleo/yi-hack-MStar/)
- [YI-Hack-v4](https://github.com/TheCrypt0/yi-hack-v4)
- [YI-Hack-v5](https://github.com/alienatedsec/yi-hack-v5)
### Docker (Optional)
Install:
- Docker
- Docker compose
### Broker MQTT (Optional)
- Needed for motion detection images and messages
1. Create a Telegram Bot with **BotFather**
2. Write down **Token**
3. Copy commands from `botCommands.txt` and paste on **BotFather** commands for your bot
### Preparing configuration
- Create a **config.yaml**. See `config-example.yaml`
- Bot mode of operation, choose one of:
- **(DEFAULT) Polling bot**:
The bot will ask to Telegram servers if there are new updates. No port to open
- **WebHook**:
The bot act in a passive way, very performant, but need to open port and generate certificates
- uncomment `telegram_bot.start_web_hook()` in `main.py`
- open port **88** on router.
- Create a `cert.pem` and `private.key` with openssl. Place them in top folder. See [**WebHook
guide**](https://github.com/python-telegram-bot/python-telegram-bot/wiki/Webhooks)
### Docker Install (Recommended)
Very simple
```shell
docker-compose up -d --build
```
### Manual python Install
1. Install python
2. Create a virtual environment
3. Install python modules
```shell
pip3 install -r requirements.txt
```
4. Run main.py
```shell
(venv) python main.py
```
## Performance
Bot performance depends on camera availability and MQTT delay.
## Supported Devices
### Services
- **MQTT**: all devices with MQTT support
- **REST API**: all devices with REST API support
### Supported Cameras
All **MQTT** and **REST API** cameras.
#### Tested Models
- **YIHacks**: cameras supported by **Yi-Hack** projects
- **Reolink**: cameras with Rest API by Reolink
### Supported Switches
All **MQTT** and **REST API** switches.
#### Tested Models
- **Shelly**: relays
## Donation
[**Donation**](https://www.paypal.me/LucaGiulianini)