Skip to main content

Lightweight Python API for querying status info for a variety of Renault vehicle models

Project description

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

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

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": 10,
        "plug_status": 0,
        "charging_status": -1.1,
        "charging_remaining_rime": 10,
        "charging_instantaneous_power": 0.0
    }
}

Query custom data selection (battery and cockpit data)

# get battery status, cockpit data
status = car.get_status((
    car.StatusType.BATTERY,
    car.StatusType.COCKPIT,
))

Hint: Pretty Print Status

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": 10,
        "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 for Python

Links

renault-api-lite repository

hacf-fr's renault-api

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

renault-api-lite-0.8.1.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

renault_api_lite-0.8.1-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file renault-api-lite-0.8.1.tar.gz.

File metadata

  • Download URL: renault-api-lite-0.8.1.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for renault-api-lite-0.8.1.tar.gz
Algorithm Hash digest
SHA256 dae5f086b5971fd1ac5a3b8aedcf5172905a3149ec1f3f2a7eb01bed3b686595
MD5 b27d87d14043d30182e2b813de9b87a3
BLAKE2b-256 990f47f7451946892188e56437ec79a743d7d51781f59ad81e2c67efbab97b29

See more details on using hashes here.

Provenance

File details

Details for the file renault_api_lite-0.8.1-py3-none-any.whl.

File metadata

File hashes

Hashes for renault_api_lite-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3bfdb25a318621bdf659f7922de9f438f259dcaaf72953a7f3c34c6d4cb0aea7
MD5 99682bb65d56cf76066f1a2f2e13eed9
BLAKE2b-256 6b17d9ba7206ca48d25147726ae76f629dbfeafca70ab821e2c3a02ba0f60f71

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page