Metadata-Version: 2.4
Name: carconnectivity-plugin-abrp
Version: 0.8
Summary: CarConnectivity plugin for publishing data to ABRP (https://abetterrouteplanner.com)
Author: Till Steinbach
License-Expression: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Utilities
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: Home Automation
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: carconnectivity>=0.11
Requires-Dist: requests~=2.32.5
Dynamic: license-file



# CarConnectivity Plugin for ABRP - A Better Routeplanner
[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp/)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tillsteinbach/CarConnectivity-plugin-abrp)](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp/releases/latest)
[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-plugin-abrp)](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-plugin-abrp)](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp/issues)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-plugin-abrp?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-plugin-abrp/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-plugin-abrp)](https://pypi.org/project/carconnectivity-plugin-abrp/)
[![Donate at PayPal](https://img.shields.io/badge/Donate-PayPal-2997d8)](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)
[![Sponsor at Github](https://img.shields.io/badge/Sponsor-GitHub-28a745)](https://github.com/sponsors/tillsteinbach)

[CarConnectivity](https://github.com/tillsteinbach/CarConnectivity) is a python API to connect to various car services. If you want to automatically forward the data collected from your vehicle to [A Better Routeplanner (ABRP)](https://abetterrouteplanner.com) this plugin will help you.

### Install using PIP
If you want to use the CarConnectivity Plugin for ABRP, the easiest way is to obtain it from [PyPI](https://pypi.org/project/carconnectivity-plugin-abrp/). Just install it using:
```bash
pip3 install carconnectivity-plugin-abrp
```
after you installed CarConnectivity

## Configuration
In your carconnectivity.json configuration add a section for the abrp plugin like this. A documentation of all possible config options can be found [here](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp/tree/main/doc/Config.md).
```
{
    "carConnectivity": {
        "connectors": [
            ...
        ]
        "plugins": [
            {
                "type": "abrp",
                "config": {
                    "tokens": {
                        "TMBLJ9NY8SF000000": "1623fdc3-4aaf-49f5-b51a-1e55435435da2",
                        "TMLLJ9NY23F000000": "12afe123-59d4-8a3d-b9ef-29367de7f8749"
                    }
                }
            }
        ]
    }
}
```
To retrieve your token go to your vehicle on [A Better Routeplanner (ABRP)](https://abetterrouteplanner.com) select "Live Data" and then link your vehicle using the "Generic" section. It will display you the token to paste in the configuration. You need to configure a mapping between the VIN and the token for each vehicle you want to connect to [ABRP](https://abetterrouteplanner.com)

## Updates
If you want to update, the easiest way is:
```bash
pip3 install carconnectivity-plugin-abrp --upgrade
```
