2019-08-02 17:56:08 +02:00
2019-08-05 12:54:14 +02:00
2019-07-31 21:45:55 +02:00
2019-07-31 17:40:15 +02:00
2019-07-31 21:55:13 +02:00
2019-07-31 21:45:55 +02:00
2019-03-31 14:00:40 +02:00
2019-06-19 22:57:30 +02:00
2019-08-01 13:07:19 +02:00
2019-08-01 20:49:51 +02:00
2019-07-24 19:38:09 +02:00
2019-07-31 17:40:15 +02:00
2019-08-05 12:54:14 +02:00
2019-08-05 12:54:14 +02:00
2019-08-05 12:54:14 +02:00

TeslaMate

Build Status Coverage Status Docker Version Dokcer Image Docker Pulls

A data logger for your Tesla.

  • Written in Elixir
  • Data is stored in PostgreSQL
  • Visualization and data analysis with Grafana
  • Current vehicle data is published to a local MQTT Broker (optional)

CHECK OUT THE CHANGELOG BEFORE UPGRADING TO V1.4

Features

Dashboards

  • Lifetime driving map
  • Trip and charging reports
  • Driving efficiency report
  • Consumption (net / gross)
  • Vampire drain
  • Projected 100% range (battery degradation)
  • SOC charging stats
  • Visited addresses
  • History of installed updates

General

  • Little to no additional vampire drain: the car will fall asleep after a certain idle time
  • Built-in API to manually suspend / resume sending requests to the Tesla API
  • Automatic address lookup
  • Supports multiple vehicles per Tesla Account

Screenshots

Trip Trips States Charging Charging History Vampire Drain

  1. Installation
  2. Configuration
  3. Upgrading
  4. Web Interface
  5. MQTT
  6. FAQ

Installation

The recommended way to install and run TeslaMate is to use Docker. Create a docker-compose.yml file and replace the necessary environment variables:

version: '3'
services:
  teslamate:
    image: teslamate/teslamate:latest
    restart: unless-stopped
    environment:
      - DATABASE_USER=teslamate
      - DATABASE_PASS=secret
      - DATABASE_NAME=teslamate
      - DATABASE_HOST=db
      - MQTT_HOST=mosquitto
      - VIRTUAL_HOST=localhost # if you're going to access the UI from another
                               # machine replace "localhost" with the hostname
                               # / IP address of the docker host
    ports:
      - 4000:4000
    cap_drop:
      - all

  db:
    image: postgres:11
    environment:
      - POSTGRES_USER=teslamate
      - POSTGRES_PASSWORD=secret
    volumes:
      - teslamate-db:/var/lib/postgresql/data

  grafana:
    image: teslamate/grafana:latest
    environment:
      - DATABASE_USER=teslamate
      - DATABASE_PASS=secret
      - DATABASE_NAME=teslamate
      - DATABASE_HOST=db
    ports:
      - 3000:3000
    volumes:
      - teslamate-grafana-data:/var/lib/grafana

  mosquitto:
    image: eclipse-mosquitto:1.6
    ports:
      - 1883:1883
      - 9001:9001
    volumes:
      - mosquitto-conf:/mosquitto/config
      - mosquitto-data:/mosquitto/data

volumes:
    teslamate-db:
    teslamate-grafana-data:
    mosquitto-conf:
    mosquitto-data:

Afterwards start everything with docker-compose up.

Open the web interface at http://ip-of-your-machine:4000 and sign in with your Tesla Account.

To access Grafana go to http://ip-of-your-machine:3000.

Optional: To switch to imperial measurements open the web interface, navigate to Settings and tick the checkbox.

Manual Installation (advanced)

To run TeslaMate without Docker follow this guide: Manual Installation

Configuration

TeslaMate uses environment variables for runtime configuration.

Environment Variables

Variable Name Description Default Value
DATABASE_USER Username (required) /
DATABASE_PASS User password (required) /
DATABASE_NAME The database to connect to (required) /
DATABASE_HOST Hostname of the database server (required) /
DATABASE_PORT Port of the database server 5432
DATABASE_POOL_SIZE Size of the database connection pool 5
VIRTUAL_HOST Host part used for generating URLs throughout the app localhost
PORT Port where the web interface is exposed 4000
DISABLE_MQTT Disables the MQTT feature if true false
MQTT_HOST Hostname of the broker (required unless DISABLE_MQTT is true) /
MQTT_USERNAME Username (optional) /
MQTT_PASSWORD Password (optional) /
ENABLE_LOGGER_TELEGRAM Enables a logger backend for telegram. If true error and crash reports are forwarded to the configured chat. Usually not needed for stable releases. false
CHAT_ID Telegram chat id (only required if ENABLE_LOGGER_TELEGRAM is true). See here for instructions. /
TOKEN Telegram bot token (only required if ENABLE_LOGGER_TELEGRAM is true). See here for instructions. /
LOCALE The default locale for the web interface. Currently available: en (default) and de en
SECRET_KEY_BASE Secret key used as a base to generate secrets for encrypting and signing data randomly generated at startup
SIGNING_SALT A salt used with secret_key_base to generate a key for signing/verifying a cookie (required by LiveView; Sessions are not used otherwise) randomly generated at startup

Upgrading

Check the Changelog before upgrading!

Docker

Run docker-compose pull and restart with docker-compose up.

Manually

See Manual Installation

Web Interface

There is a basic real-time web interface. Once the application is running locally, you can access it at localhost:4000.

Web Interface

MQTT

Unless the MQTT feature is disabled data is published to the following topics ($car_id usually starts at 1):

teslamate/cars/$car_id/display_name
teslamate/cars/$car_id/state
teslamate/cars/$car_id/battery_level
teslamate/cars/$car_id/ideal_battery_range_km
teslamate/cars/$car_id/charge_energy_added
teslamate/cars/$car_id/speed
teslamate/cars/$car_id/outside_temp
teslamate/cars/$car_id/inside_temp
teslamate/cars/$car_id/locked
teslamate/cars/$car_id/sentry_mode

FAQ

Sometimes the first few minutes of a trip are not recorded even though the car was online. Why?

Ideally, TeslaMate would frequently scrape the Tesla API 24/7. However, the vehicle cannot fall asleep as long as data is requested. Therefore TeslaMate suspends scraping for 21 minutes if the vehicle idles for 15 minutes, so that it can go into sleep mode. Consequently, if you start driving again during those 21 minutes nothing is logged.

Solution: To get around this you can use your smartphone to tell TeslaMate to start scraping again. In short, create a workflow with Tasker (Android) or Shortcuts (iOS) that listens for connected Bluetooth devices. If a connection to your Tesla is established send an HTTP PUT request to your publicly exposed TeslaMate instance.

(With iOS 12 and below workflows are quite limited but can be triggered manually. iOS 13 will probably fix that.)

PUT https://teslamate.your-domain.com/api/car/$car_id/logging/resume
PUT https://teslamate.your-domain.com/api/car/$car_id/logging/suspend

I strongly recommend to use a reverse-proxy with HTTPS and basic access authentication when exposing TeslaMate to the public internet. Additionally only permit access to /api/car/$car_id/logging/resume and/or /api/car/$car_id/logging/suspend.

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.

Credits

  • TeslaLogger was a big inspiration especially during early development. Thanks!
S
Description
⚠️ ARCHIVED: Original GitHub repository no longer exists. Preserved as backup on 2026-01-24T15:12:09.935Z
Readme MIT
103 MiB
Languages
Elixir 83.8%
HTML 6.1%
Nix 2.6%
MDX 2.2%
JavaScript 1.9%
Other 3.3%