jakoblichterfeld / teslamate-telegram-bot Goto Github PK

A telegram bot which sends a message if an update for your Tesla is available (use TeslaMate MQTT)

License: MIT License

Python 93.28% Dockerfile 6.72%

tesla telegram-bot mqtt-connector mqtt mqtt-client teslamate-mqtt-topic python paho-mqtt

teslamate-telegram-bot's Introduction

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 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.

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

   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
       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.

teslamate-telegram-bot's People

Contributors

Stargazers

Watchers

Forkers

mirrdhyn nanishin dobetter josefwells

teslamate-telegram-bot's Issues

Impossible to provide MQTT credentials

I use a separate MQTT broker with simple authentication.
MQTT_BROKER_USERNAME and MQTT_BROKER_PASSWORD are not implemented.

Python implementation

The proof of conecpt (#1) shows it works, perfect.
Let us implement it in python, as there are libraries for mqtt and telegram bot available for cool features in the future.

Enable dependabot for GitHub Actions

For convenient it would be great to have the dependabot enabled for the GitHub actions

deployment-as-docker-on-docker-hub

It would be great to have it automatically deployed on docker-hub for multiple platforms

Proof of Concept

As a user I want to be informed when an update is available for my Tesla car. This can be done by messaging service to my mobile.

I do not want do have a full weight automation such as Openhab2, HomeAssist, NodeRed, ... running.

Enable dependabot for pip requirements

For convenient it would be great to have the dependabot enabled for the pip requirements

If environment variable validation fails, CPU usage is very high

Today after updating to version 0.7.2 and 0.7.3, which caused issues #33 and #35, my server CPU usage was constantly at >90%. Probably there is an endless loop running trying to validate the config again and again.
After I stopped the (broken) teslamatetelegrambot container, CPU usage returned to normal:

Docker-Action: use official docker buildx

This action is ARCHIVED and will not receive any updates, update your workflows to use the official Docker action docker/setup-buildx-action@v1

see: https://github.com/marketplace/actions/docker-setup-buildx

MQTT namespace variable

Its possible to define a mqtt namespace variable in teslamate.

MQTT_NAMESPACE=

If it is defined, the telegram bot won't notify the update, because its looking in a wrong topic.

teslamate/$namespace/cars/2/inside_temp

would work then.

Specify which SW update is available

Use MQTT topic teslamate/cars/$car_id/update_version to specify which sw update is available

How to add the charging record which before the teslamate has installed?

Cache pip requirements for docker build

It would be great if the pip requirements were cached for docker builds, see: https://github.com/actions/cache/blob/main/examples.md#python---pip

UnboundLocalError: cannot access local variable 'message_text' where it is not associated with a value

v0.7.3 runs on test system, fails on production with:

teslamatetelegrambot | Traceback (most recent call last):
teslamatetelegrambot | File "/app/./src/teslamate_telegram_bot.py", line 227, in
teslamatetelegrambot | asyncio.run(main())
teslamatetelegrambot | File "/usr/local/lib/python3.12/asyncio/runners.py", line 194, in run
teslamatetelegrambot | return runner.run(main)
teslamatetelegrambot | ^^^^^^^^^^^^^^^^
teslamatetelegrambot | File "/usr/local/lib/python3.12/asyncio/runners.py", line 118, in run
teslamatetelegrambot | return self._loop.run_until_complete(task)
teslamatetelegrambot | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
teslamatetelegrambot | File "/usr/local/lib/python3.12/asyncio/base_events.py", line 685, in run_until_complete
teslamatetelegrambot | return future.result()
teslamatetelegrambot | ^^^^^^^^^^^^^^^
teslamatetelegrambot | File "/app/./src/teslamate_telegram_bot.py", line 205, in main
teslamatetelegrambot | await check_state_and_send_messages(bot, chat_id)
teslamatetelegrambot | File "/app/./src/teslamate_telegram_bot.py", line 172, in check_state_and_send_messages
teslamatetelegrambot | await send_telegram_message_to_chat_id(bot, chat_id, message_text)
teslamatetelegrambot | ^^^^^^^^^^^^
teslamatetelegrambot | UnboundLocalError: cannot access local variable 'message_text' where it is not associated with a value
teslamatetelegrambot exited with code 0

feat: allow negative chat_id, which means group chats

After upgrading to v0.7.3 I am now getting this error:

ERROR - Error: Please set the environment variable TELEGRAM_BOT_CHAT_ID to a valid number and try again.

My env variable:

TELEGRAM_BOT_CHAT_ID=-410996XXX

XXX are more digits, removed for privacy. I guess the issue is that it is a negative number. Also doesn't work if I wrap it in double quotes.

teslamate-teslamatetelegrambot-1  | Traceback (most recent call last):
teslamate-teslamatetelegrambot-1  |   File "/app/./src/teslamte_telegram_bot.py", line 64, in <module>
teslamate-teslamatetelegrambot-1  |     if not car_id.isdigit() or int(car_id) < 1:
teslamate-teslamatetelegrambot-1  |            ^^^^^^^^^^^^^^
teslamate-teslamatetelegrambot-1  | AttributeError: 'int' object has no attribute 'isdigit'
teslamate-teslamatetelegrambot-1  | Traceback (most recent call last):
teslamate-teslamatetelegrambot-1  |   File "/app/./src/teslamte_telegram_bot.py", line 64, in <module>
teslamate-teslamatetelegrambot-1  |     if not car_id.isdigit() or int(car_id) < 1:
teslamate-teslamatetelegrambot-1  |            ^^^^^^^^^^^^^^
teslamate-teslamatetelegrambot-1  | AttributeError: 'int' object has no attribute 'isdigit'
teslamate-teslamatetelegrambot-1  | Traceback (most recent call last):
teslamate-teslamatetelegrambot-1  |   File "/app/./src/teslamte_telegram_bot.py", line 64, in <module>
teslamate-teslamatetelegrambot-1  |     if not car_id.isdigit() or int(car_id) < 1:
teslamate-teslamatetelegrambot-1  |            ^^^^^^^^^^^^^^
teslamate-teslamatetelegrambot-1  | AttributeError: 'int' object has no attribute 'isdigit'
teslamate-teslamatetelegrambot-1  | Traceback (most recent call last):
teslamate-teslamatetelegrambot-1  |   File "/app/./src/teslamte_telegram_bot.py", line 64, in <module>
teslamate-teslamatetelegrambot-1  |     if not car_id.isdigit() or int(car_id) < 1:
teslamate-teslamatetelegrambot-1  |            ^^^^^^^^^^^^^^
teslamate-teslamatetelegrambot-1  | AttributeError: 'int' object has no attribute 'isdigit'
teslamate-teslamatetelegrambot-1  | Traceback (most recent call last):
teslamate-teslamatetelegrambot-1  |   File "/app/./src/teslamte_telegram_bot.py", line 64, in <module>
teslamate-teslamatetelegrambot-1  |     if not car_id.isdigit() or int(car_id) < 1:
teslamate-teslamatetelegrambot-1  |            ^^^^^^^^^^^^^^
teslamate-teslamatetelegrambot-1  | AttributeError: 'int' object has no attribute 'isdigit'
teslamate-teslamatetelegrambot-1  | Traceback (most recent call last):
teslamate-teslamatetelegrambot-1  |   File "/app/./src/teslamte_telegram_bot.py", line 64, in <module>
teslamate-teslamatetelegrambot-1  |     if not car_id.isdigit() or int(car_id) < 1:
teslamate-teslamatetelegrambot-1  |            ^^^^^^^^^^^^^^
teslamate-teslamatetelegrambot-1  | AttributeError: 'int' object has no attribute 'isdigit'

Btw: there is a typo in the filename teslamte_telegram_bot.py