Code Monkey home page Code Monkey logo

teslamate-telegram-bot's Introduction

TeslaMate Telegram Bot

CI version docker pulls image size Donate

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

Telegram Message: SW Update available

Table of contents

Features

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

Requirements

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.

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

Donate with PayPal

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.