Skip to content

Latest commit

 

History

History
113 lines (88 loc) · 5.64 KB

README.md

File metadata and controls

113 lines (88 loc) · 5.64 KB
Raw

Telegram2Mqtt

Bidirectional Telegram to MQTT gateway

mqtt-smarthome CodeQL Go Report Card

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

Installation

Telegram2Mqtt can be used in a Go environment or as a Docker container:

$ 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:

    mqtt:
      url: "tcp://<MQTT SERVER>:1883"
      username: <MQTT USERNAME>
      password: <MQTT PASSWORD>
      qos: 0
      retain: false

    telegram:
      api_key: <Botfather Token>
      chat_id: <CHATID, get with telegram command /info>
    
    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

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