Giter Site home page Giter Site logo

bgewehr / volkswagen-tracker Goto Github PK

View Code? Open in Web Editor NEW

This project forked from fritzjo/volkswagen-tracker

0.0 1.0 0.0 226 KB

Track various details about your VW in a database

License: GNU General Public License v3.0

Dockerfile 1.38% Python 98.62%

volkswagen-tracker's Introduction

dashboard example

Volkswagen-Tracker

License: GPL v3 Codacy Badge

Volkswagen-Tracker is a Python script to gather information about your Volkswagen. I initially created this tool to measure the mileage of my car in a Grafana dashboard, but decided to expand the project to cover other data as well.

It uses the unofficial API of the Volkswagen We-Connect (new Car-Net) Website, which means this application only works with We-Connect-enabled vehicles. All the data collected is stored in a database.

The API interaction itself is mainly based on the work of reneboer.

Features

  • Collecting:
    • Mileage
    • Range
    • Charging status
    • Battery percentage
  • Writing the gathered data to a database
  • Supported database types
    • InfluxDB
    • SQLite
    • Local / CSV
  • Docker integration

Roadmap

  • Collect more information from We-Connect
  • Guides for Grafana intergration

How-To

Docker

git clone https://github.com/FritzJo/volkswagen-tracker.git
cd volkswagen-tracker
docker build -t volkswagen-tracker .
docker run -e VW_USERNAME= \
           -e VW_PASSWORD= \
           -e VW_DATABASE_TYPE= \
           -e VW_DATABASE_HOST= \
           -e VW_DATABASE_PORT= \
           -e VW_DATABASE_USER=\
           -e VW_DATABASE_PASS= \
           -e VW_UPDATE_INTERVAL= \
           volkswagen-tracker

Alternatively use the docker-compose file that is provided with this repository. Simply edit the yml file, fill in your credentials and run the following command to start the application with a InfluxDB. The database will be exposed to port 8086 by default.

If you look for a complete solution (including Grafana), you can use the docker-compose.yml.grafana file to deploy everything at once.

docker-compose up -d --build

Parameters

Parameter Description
VW_USERNAME Your We-Connect Email.
VW_PASSWORD Your We-Connect Password.
VW_DATABASE_TYPE Select the database backend (influx, sqlite or local)
VW_DATABASE_HOST The database host address. If you use Docker, this is the name of the database container.
VW_DATABASE_PORT Database port (default is 8086 for InfluxDB).
VW_DATABASE_USER Database user.
VW_DATABASE_PASS The password for the database user.
VW_UPDATE_INTERVAL Wait time between updates (hours).

volkswagen-tracker's People

Contributors

fritzjo avatar

Watchers

James Cloos avatar

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.