TeslaMate Telegram Bot

This is a telegram bot written in Python to notify by Telegram message when a new SW update for your Tesla is available. It uses the MQTT topic which TeslaMate offers.

Screenshots

TeslaMate Telegram Bot

Features

Sends a telegram message to you if an update for your tesla is available

Requirements

A Machine that's always on and runs TeslaMate
Docker (if you are new to Docker, see Installing Docker and Docker Compose)
External internet access, to send telegram messages.
A mobile with Telegram client installed
your own Telegram Bot, see Creating a new telegram bot
your own Telegram chat id, see get your telegram chat id

Installation

Make sure you fulfill the Requirements.

It is recommended to backup your data first.

This document provides the necessary steps for installation of TeslaMate Telegram Bot on a any system that runs Docker.

This setup is recommended only if you are running TeslaMate Telegram Bot on your home network, as otherwise your telegram API tokens might be at risk.

Create a file called docker-compose.yml with the following content (adopt with your own values):

   version: "3"

   services:
     teslamatetelegrambot:
       image: teslamatetelegrambot/teslamatetelegrambot:latest
       restart: unless-stopped
       environment:
         - MQTT_BROKER_HOST=IP_Adress
         - MQTT_BROKER_PORT=1883 #optional, default 1883
         - MQTT_BROKER_USERNAME=username #optional, only needed when broker has authentication enabled
         - MQTT_BROKER_PASSWORD=password #optional, only needed when broker has authentication enabled
         - TELEGRAM_BOT_API_KEY=secret_api_key
         - TELEGRAM_BOT_CHAT_ID=secret_chat_id
       ports:
         - 1883
       build:
         context: .
         dockerfile: Dockerfile

Build and start the docker container with docker-compose up. To run the containers in the background add the -d flag:
```
docker-compose up -d
```

Update

Check out the release notes before upgrading!

Pull the new images:

docker-compose pull

and restart the stack with docker-compose up. To run the containers in the background add the -d flag:

docker-compose up -d

Contributing

All contributions are welcome and greatly appreciated!

Donation

Maintaining this project isn't effortless, or free. If you would like to kick in and help me cover those costs, that would be awesome. If you don't, no problem; just share your love and show your support.

Disclaimer

Please note that the use of the Tesla API in general and this software in particular is not endorsed by Tesla. Use at your own risk.

nanishin/TeslaMate_Telegram_Bot