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": 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)

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

Links

renault-api-lite GitHub repository

renault-api-lite on PyPi

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.2.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

renault_api_lite-0.8.2-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: renault-api-lite-0.8.2.tar.gz
  • Upload date:
  • Size: 9.1 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.2.tar.gz
Algorithm Hash digest
SHA256 702057c7e800e106a8a6fb68311188fc82d4ae44760e29895f5b5e46788ec3d6
MD5 cec87cc2f56c9ab4b1371a35773cc3d2
BLAKE2b-256 8af86aa27060a81d0392e44e5fd606c8eb3418b6cb03c659612289ed9fa43996

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for renault_api_lite-0.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f236b95f36080851b4ef2847407c29665f8d5b72bc6ca3973e7b88c54f06ef6
MD5 63849f27a0567b1e8e29abd241129ef7
BLAKE2b-256 e36fe56c7ead586b9b98ca3f00420491f4761080dea385ff25a7e31bd18e9af9

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