carconnectivity-plugin-abrp


Namecarconnectivity-plugin-abrp JSON
Version 0.2.1 PyPI version JSON
download
home_pageNone
SummaryCarConnectivity plugin for publishing data to ABRP (https://abetterrouteplanner.com)
upload_time2025-02-20 15:39:50
maintainerNone
docs_urlNone
authorTill Steinbach
requires_python>=3.9
licenseMIT License Copyright (c) 2021 Till Steinbach Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            

# 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
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "carconnectivity-plugin-abrp",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Till Steinbach",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/cb/82/539469cd617238f820826b1fd3a746f1c7d60e4a586c4ebff241e2425108/carconnectivity_plugin_abrp-0.2.1.tar.gz",
    "platform": null,
    "description": "\n\n# CarConnectivity Plugin for ABRP - A Better Routeplanner\n[![GitHub sourcecode](https://img.shields.io/badge/Source-GitHub-green)](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp/)\n[![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)\n[![GitHub](https://img.shields.io/github/license/tillsteinbach/CarConnectivity-plugin-abrp)](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp/blob/master/LICENSE)\n[![GitHub issues](https://img.shields.io/github/issues/tillsteinbach/CarConnectivity-plugin-abrp)](https://github.com/tillsteinbach/CarConnectivity-plugin-abrp/issues)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/carconnectivity-plugin-abrp?label=PyPI%20Downloads)](https://pypi.org/project/carconnectivity-plugin-abrp/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/carconnectivity-plugin-abrp)](https://pypi.org/project/carconnectivity-plugin-abrp/)\n[![Donate at PayPal](https://img.shields.io/badge/Donate-PayPal-2997d8)](https://www.paypal.com/donate?hosted_button_id=2BVFF5GJ9SXAJ)\n[![Sponsor at Github](https://img.shields.io/badge/Sponsor-GitHub-28a745)](https://github.com/sponsors/tillsteinbach)\n\n[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.\n\n### Install using PIP\nIf 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:\n```bash\npip3 install carconnectivity-plugin-abrp\n```\nafter you installed CarConnectivity\n\n## Configuration\nIn 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).\n```\n{\n    \"carConnectivity\": {\n        \"connectors\": [\n            ...\n        ]\n        \"plugins\": [\n            {\n                \"type\": \"abrp\",\n                \"config\": {\n                    \"tokens\": {\n                        \"TMBLJ9NY8SF000000\": \"1623fdc3-4aaf-49f5-b51a-1e55435435da2\",\n                        \"TMLLJ9NY23F000000\": \"12afe123-59d4-8a3d-b9ef-29367de7f8749\"\n                    }\n                }\n            }\n        ]\n    }\n}\n```\nTo 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)\n\n## Updates\nIf you want to update, the easiest way is:\n```bash\npip3 install carconnectivity-plugin-abrp --upgrade\n```\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2021 Till Steinbach\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "CarConnectivity plugin for publishing data to ABRP (https://abetterrouteplanner.com)",
    "version": "0.2.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "10763d3ec48ded7b08ac144b06be19bc9529f7b315a507b473abd35384ee917f",
                "md5": "f4baea5b3aa0fe71882a2b9c46196bc5",
                "sha256": "2e156c42cd42b694956c5117771d9122adfeb90b63619bf735821e88d7a99d4c"
            },
            "downloads": -1,
            "filename": "carconnectivity_plugin_abrp-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f4baea5b3aa0fe71882a2b9c46196bc5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 11444,
            "upload_time": "2025-02-20T15:39:49",
            "upload_time_iso_8601": "2025-02-20T15:39:49.714704Z",
            "url": "https://files.pythonhosted.org/packages/10/76/3d3ec48ded7b08ac144b06be19bc9529f7b315a507b473abd35384ee917f/carconnectivity_plugin_abrp-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cb82539469cd617238f820826b1fd3a746f1c7d60e4a586c4ebff241e2425108",
                "md5": "6ebc77abb3b3158232e6df4d7faa6f6e",
                "sha256": "9232bd3e152fe8d270cf56fefcb1ea64bc951254d258b7fd99b457626c2c4568"
            },
            "downloads": -1,
            "filename": "carconnectivity_plugin_abrp-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6ebc77abb3b3158232e6df4d7faa6f6e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 14867,
            "upload_time": "2025-02-20T15:39:50",
            "upload_time_iso_8601": "2025-02-20T15:39:50.971443Z",
            "url": "https://files.pythonhosted.org/packages/cb/82/539469cd617238f820826b1fd3a746f1c7d60e4a586c4ebff241e2425108/carconnectivity_plugin_abrp-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-20 15:39:50",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "carconnectivity-plugin-abrp"
}
        
Elapsed time: 1.74806s