Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/legobas/telegram2mqtt

Bidirectional Telegram to MQTT gateway
https://github.com/legobas/telegram2mqtt

home-automation iot mqtt mqtt-smarthome smarthome telegram telegram-bot telegram-userbot telegrambot

Last synced: about 4 hours ago
JSON representation

Bidirectional Telegram to MQTT gateway

Host: GitHub
URL: https://github.com/legobas/telegram2mqtt
Owner: Legobas
License: apache-2.0
Created: 2023-11-26T12:49:30.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-05-08T20:38:30.000Z (6 months ago)
Last Synced: 2024-06-21T14:28:35.969Z (5 months ago)
Topics: home-automation, iot, mqtt, mqtt-smarthome, smarthome, telegram, telegram-bot, telegram-userbot, telegrambot
Language: Go
Homepage:
Size: 1 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Telegram2Mqtt

Bidirectional Telegram to MQTT gateway

[![mqtt-smarthome](https://img.shields.io/badge/mqtt-smarthome-blue.svg?style=flat-square)](https://github.com/mqtt-smarthome/mqtt-smarthome)
[![CodeQL](https://github.com/Legobas/telegram2mqtt/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/Legobas/telegram2mqtt/actions/workflows/github-code-scanning/codeql)
[![Go Report Card](https://goreportcard.com/badge/github.com/Legobas/telegram2mqtt)](https://goreportcard.com/report/github.com/legobas/telegram2mqtt)

Telegram2mqtt is a service that allows you to connect your Telegram account to an MQTT broker, enabling you to send and receive messages from your MQTT-enabled devices using the Telegram app. With this service, you can easily integrate your Telegram account with your home automation system, IoT devices, and other MQTT-enabled applications. By using Telegram2mqtt, you can receive notifications, control your devices, and monitor your home automation system from anywhere in the world using your smartphone or tablet.

This is an Alpha version and may be buggy...

## Architecture

![Architecture](architecture.png)

## Installation

Telegram2Mqtt can be used in a [Go](https://go.dev) environment or as a [Docker container](#docker):

```bash
$ go get -u github.com/Legobas/telegram2mqtt
```

## Environment variables

Supported environment variables:

```
LOGLEVEL = INFO/DEBUG/ERROR
```

# Configuration

Telegram2Mqtt can be configured with the `telegram2mqtt.yml` yaml configuration file.
The `telegram2mqtt.yml` file has to exist in one of the following locations:

* A `config` directory in de filesystem root: `/config/telegram2mqtt.yml`
* A `.config` directory in the user home directory `~/.config/telegram2mqtt.yml`
* The current working directory

## Configuration options

| Config item | | Description |
| ------------------------- | ------------- | ------------------------------------------------------------------------ |
| **mqtt** | | |
| url | | MQTT Server URL |
| username/password | | MQTT Server Credentials |
| qos | | MQTT Server Quality Of Service |
| retain | | MQTT Server Retain messages |
| **telegram** | | |
| api_key | | Botfather Token |
| chat_id | | CHATID, get with telegram command /info |
| **commands** | | |
| command | | Telegram command, like /start or /test |
| mqtt-topic | | MQTT Topic to which the message will be sent |
| mqtt-message | | The MQTT message |
| keyboard-title | | Message on top of Telegram keyboard |
| **keyboard** | | |
| | id | unique ID |
| | title | Keyboard button text |
| | mqtt-topic | MQTT Topic for this button |
| | mqtt-message | The MQTT message for this button |

Example telegram2mqtt.yml:

```yml
mqtt:
url: "tcp://:1883"
username:
password:
qos: 0
retain: false

telegram:
api_key:
chat_id:

commands:
- command: /light1
mqtt-topic: rfxcom2mqtt/command/Switch1
- command: /light2on
mqtt-topic: rfxcom2mqtt/command/Switch2
mqtt-message: on
- command: /light2off
mqtt-topic: rfxcom2mqtt/command/Switch2
mqtt-message: off
- command: /lights
keyboard-title: Select Light
keyboard:
- id: light_1_on
title: Light1 on
mqtt-topic: zigbee2mqtt/switch_1/set/state
mqtt-message: ON
- id: light_1_off
title: Light1 off
mqtt-topic: zigbee2mqtt/switch_1/set/state
mqtt-message: OFF
```
See also: [Example telegram2mqtt.yml](./telegram2mqtt.yml)

## Setup

If no chat_id is found in the configuration the service will only log the received messages.
Enter /info in the Telegram app to get the Chat ID for the configuration.
Add your chat_id to the telegram2mqtt.yml configuration file and restart the service.

## Credits

* [Paho Mqtt Client](https://github.com/eclipse/paho.mqtt.golang)
* [Go-Telegram](https://github.com/go-telegram/bot)
* [ZeroLog](https://github.com/rs/zerolog)
* [D2](https://d2lang.com)