Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakoblichterfeld/teslamate-telegram-bot
A telegram bot which sends a message if an update for your Tesla is available (use TeslaMate MQTT)
https://github.com/jakoblichterfeld/teslamate-telegram-bot
mqtt mqtt-client mqtt-connector paho-mqtt python telegram-bot tesla teslamate-mqtt-topic
Last synced: 2 months ago
JSON representation
A telegram bot which sends a message if an update for your Tesla is available (use TeslaMate MQTT)
- Host: GitHub
- URL: https://github.com/jakoblichterfeld/teslamate-telegram-bot
- Owner: JakobLichterfeld
- License: mit
- Created: 2020-09-02T19:51:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-01T11:31:22.000Z (3 months ago)
- Last Synced: 2024-10-11T14:10:49.555Z (3 months ago)
- Topics: mqtt, mqtt-client, mqtt-connector, paho-mqtt, python, telegram-bot, tesla, teslamate-mqtt-topic
- Language: Python
- Homepage:
- Size: 808 KB
- Stars: 25
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# TeslaMate Telegram Bot
[](https://github.com/JakobLichterfeld/TeslaMate-Telegram-Bot/actions/workflows/buildx.yml)
[](https://hub.docker.com/r/teslamatetelegrambot/teslamatetelegrambot)
[](https://hub.docker.com/r/teslamatetelegrambot/teslamatetelegrambot)
[](https://hub.docker.com/r/teslamatetelegrambot/teslamatetelegrambot)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZE9EHN48GYWMN&source=url)
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](https://github.com/adriankumpf/teslamate) offers.
## Screenshots
## Table of contents
- [TeslaMate Telegram Bot](#teslamate-telegram-bot)
- [Screenshots](#screenshots)
- [Table of contents](#table-of-contents)
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Update](#update)
- [Contributing](#contributing)
- [Donation](#donation)
- [Disclaimer](#disclaimer)
## Features
- [x] Sends a telegram message to you if an update for your tesla is available
## Requirements
- A Machine that's always on and runs [TeslaMate](https://github.com/adriankumpf/teslamate)
- Docker _(if you are new to Docker, see [Installing Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/linux/))_
- External internet access, to send telegram messages.
- A mobile with [Telegram](https://telegram.org/) client installed
- your own Telegram Bot, see [Creating a new telegram bot](https://core.telegram.org/bots#6-botfather)
- your own Telegram chat ID, see [get your telegram chat ID](https://docs.influxdata.com/kapacitor/v1.5/event_handlers/telegram/#get-your-telegram-chat-id)
## Installation
Make sure you fulfill the [Requirements](#requirements).
It is recommended to backup your data first.
This document provides the necessary steps for installation of TeslaMate Telegram Bot on an 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.
1. Create a file called `docker-compose.yml` with the following content (adopt with your own values):
```yml title="docker-compose.yml"
services:
teslamatetelegrambot:
image: teslamatetelegrambot/teslamatetelegrambot:latest
restart: unless-stopped
environment:
# - CAR_ID=1 # optional, defaults to 1
- MQTT_BROKER_HOST=IP_Address # defaults to 127.0.0.1
# - MQTT_BROKER_PORT=1883 #optional, defaults to 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
# - MQTT_NAMESPACE=namespace # optional, only needed when you specified MQTT_NAMESPACE on your TeslaMate installation
- TELEGRAM_BOT_API_KEY=secret_api_key
- TELEGRAM_BOT_CHAT_ID=secret_chat_id
ports:
- 1883
```
2. Build and start the docker container with `docker compose up`. To run the containers in the background add the `-d` flag:
```bash
docker compose up -d
```
## Update
Check out the [release notes](https://github.com/JakobLichterfeld/TeslaMate_Telegram_Bot/releases) before upgrading!
Pull the new images:
```bash
docker compose pull
```
and restart the stack with `docker compose up`. To run the containers in the background add the `-d` flag:
```bash
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.