# [renault API (lite)](https://github.com/bkogler/renault-api-lite)
Lightweight Python API for querying status info for a variety of Renault vehicle models
# Features
Conveniently read status info for Renault vehicles (e.g. EVs), including:
* battery status (level, autonomy, plug status, temperature, ...)
* charging configuration / charge schedule
* fuel autonomy (for combustion vehicles)
* HVAC / pre-conditioning status
* GPS location
# Installation
`pip install renault-api-lite`
# Usage Examples
## Query battery status
````python
from renault import RenaultVehicleClient
car = RenaultVehicleClient(
login_id="Your E-Mail", password="Your password", # --> change to your credentials
account_locale="de_DE" # --> optional
)
# get battery status
status = car.get_status(car.STATUS_BATTERY_ONLY)
````
#### Hint: Pretty Print Status
````python
import json
print(json.dumps(status, indent=4))
````
````
{
"battery_status_data": {
"timestamp": "2022-08-145T07:24:12Z",
"battery_level": 90,
"battery_temperature": 25,
"battery_autonomy": 207,
"battery_capacity": 0,
"battery_available_energy": 20,
"plug_status": 0,
"charging_status": -1.1,
"charging_remaining_rime": 10,
"charging_instantaneous_power": 0.0
}
}
````
## Query custom data selection (battery and cockpit data)
````python
# get battery status, cockpit data
status = car.get_status((
car.StatusType.BATTERY,
car.StatusType.COCKPIT,
))
````
#### Hint: Pretty Print Status
````python
import json
print(json.dumps(status, indent=4))
````
````
{
"battery_status_data": {
"timestamp": "2022-08-145T07:24:12Z",
"battery_level": 90,
"battery_temperature": 25,
"battery_autonomy": 207,
"battery_capacity": 0,
"battery_available_energy": 20,
"plug_status": 0,
"charging_status": -1.1,
"charging_remaining_rime": 10,
"charging_instantaneous_power": 0.0
},
"cockpit_data": {
"fuel_autonomy": null,
"fuel_quantity": null,
"total_mileage": 1234.22
}
}
````
# Disclaimer
This project is not affiliated with, endorsed by, or connected to Renault. I accept no responsibility for any consequences, intended or accidental, as a result of interacting with Renault's API using this project.
# Credits
This project is based on [hacf-fr's renault-api](https://github.com/hacf-fr/renault-api) for Python
# Links
[renault-api-lite GitHub repository](https://github.com/bkogler/renault-api-lite)
[renault-api-lite on PyPi](https://pypi.org/project/renault-api-lite/)
[hacf-fr's renault-api](https://github.com/hacf-fr/renault-api)
Raw data
{
"_id": null,
"home_page": "https://github.com/bkogler/renault-api-lite",
"name": "renault-api-lite",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "Renault Z.E. ZOE Twingo Megane Kangoo Electric vehicle EV status API",
"author": "Bernhard Kogler",
"author_email": "bernhard.kogler@supersonnig.org",
"download_url": "https://files.pythonhosted.org/packages/8a/f8/6aa27060a81d0392e44e5fd606c8eb3418b6cb03c659612289ed9fa43996/renault-api-lite-0.8.2.tar.gz",
"platform": null,
"description": "# [renault API (lite)](https://github.com/bkogler/renault-api-lite)\nLightweight Python API for querying status info for a variety of Renault vehicle models\n\n# Features\nConveniently read status info for Renault vehicles (e.g. EVs), including:\n\n* battery status (level, autonomy, plug status, temperature, ...)\n* charging configuration / charge schedule\n* fuel autonomy (for combustion vehicles)\n* HVAC / pre-conditioning status\n* GPS location\n\n# Installation\n`pip install renault-api-lite`\n\n# Usage Examples\n\n## Query battery status\n````python\nfrom renault import RenaultVehicleClient\n\ncar = RenaultVehicleClient(\n login_id=\"Your E-Mail\", password=\"Your password\", # --> change to your credentials\n account_locale=\"de_DE\" # --> optional\n)\n\n# get battery status\nstatus = car.get_status(car.STATUS_BATTERY_ONLY)\n````\n#### Hint: Pretty Print Status\n````python\nimport json\n\nprint(json.dumps(status, indent=4))\n````\n````\n{\n \"battery_status_data\": {\n \"timestamp\": \"2022-08-145T07:24:12Z\",\n \"battery_level\": 90,\n \"battery_temperature\": 25,\n \"battery_autonomy\": 207,\n \"battery_capacity\": 0,\n \"battery_available_energy\": 20,\n \"plug_status\": 0,\n \"charging_status\": -1.1,\n \"charging_remaining_rime\": 10,\n \"charging_instantaneous_power\": 0.0\n }\n}\n````\n\n## Query custom data selection (battery and cockpit data)\n````python\n# get battery status, cockpit data\nstatus = car.get_status((\n car.StatusType.BATTERY,\n car.StatusType.COCKPIT,\n))\n````\n#### Hint: Pretty Print Status\n````python\nimport json\n\nprint(json.dumps(status, indent=4))\n````\n````\n{\n \"battery_status_data\": {\n \"timestamp\": \"2022-08-145T07:24:12Z\",\n \"battery_level\": 90,\n \"battery_temperature\": 25,\n \"battery_autonomy\": 207,\n \"battery_capacity\": 0,\n \"battery_available_energy\": 20,\n \"plug_status\": 0,\n \"charging_status\": -1.1,\n \"charging_remaining_rime\": 10,\n \"charging_instantaneous_power\": 0.0\n },\n \"cockpit_data\": {\n \"fuel_autonomy\": null,\n \"fuel_quantity\": null,\n \"total_mileage\": 1234.22\n }\n}\n````\n\n# Disclaimer\nThis project is not affiliated with, endorsed by, or connected to Renault. I accept no responsibility for any consequences, intended or accidental, as a result of interacting with Renault's API using this project.\n\n# Credits\nThis project is based on [hacf-fr's renault-api](https://github.com/hacf-fr/renault-api) for Python\n\n# Links\n[renault-api-lite GitHub repository](https://github.com/bkogler/renault-api-lite)\n\n[renault-api-lite on PyPi](https://pypi.org/project/renault-api-lite/)\n\n[hacf-fr's renault-api](https://github.com/hacf-fr/renault-api) \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Lightweight Python API for querying status info for a variety of Renault vehicle models",
"version": "0.8.2",
"project_urls": {
"Homepage": "https://github.com/bkogler/renault-api-lite"
},
"split_keywords": [
"renault",
"z.e.",
"zoe",
"twingo",
"megane",
"kangoo",
"electric",
"vehicle",
"ev",
"status",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e36fe56c7ead586b9b98ca3f00420491f4761080dea385ff25a7e31bd18e9af9",
"md5": "63849f27a0567b1e8e29abd241129ef7",
"sha256": "0f236b95f36080851b4ef2847407c29665f8d5b72bc6ca3973e7b88c54f06ef6"
},
"downloads": -1,
"filename": "renault_api_lite-0.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "63849f27a0567b1e8e29abd241129ef7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 8575,
"upload_time": "2023-05-06T11:14:15",
"upload_time_iso_8601": "2023-05-06T11:14:15.163869Z",
"url": "https://files.pythonhosted.org/packages/e3/6f/e56c7ead586b9b98ca3f00420491f4761080dea385ff25a7e31bd18e9af9/renault_api_lite-0.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8af86aa27060a81d0392e44e5fd606c8eb3418b6cb03c659612289ed9fa43996",
"md5": "cec87cc2f56c9ab4b1371a35773cc3d2",
"sha256": "702057c7e800e106a8a6fb68311188fc82d4ae44760e29895f5b5e46788ec3d6"
},
"downloads": -1,
"filename": "renault-api-lite-0.8.2.tar.gz",
"has_sig": false,
"md5_digest": "cec87cc2f56c9ab4b1371a35773cc3d2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 9084,
"upload_time": "2023-05-06T11:14:17",
"upload_time_iso_8601": "2023-05-06T11:14:17.023909Z",
"url": "https://files.pythonhosted.org/packages/8a/f8/6aa27060a81d0392e44e5fd606c8eb3418b6cb03c659612289ed9fa43996/renault-api-lite-0.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-06 11:14:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bkogler",
"github_project": "renault-api-lite",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "renault-api-lite"
}
JSON
