Renault high-level API Reference

Session

Session provider for interaction with Renault servers.

class renault_api.renault_session.RenaultSession(websession, locale=None, country=None, locale_details=None, credential_store=None)

Renault session for interaction with Renault servers.

Parameters

  • websession (aiohttp.client.ClientSession) –

  • locale (Optional[str]) –

  • country (Optional[str]) –

  • locale_details (Optional[Dict[str, str]]) –

  • credential_store (Optional[renault_api.credential_store.CredentialStore]) –

Return type

None

async get_account_vehicles(account_id)

GET to /accounts/{account_id}/vehicles.

Parameters

account_id (str) –

Return type

renault_api.kamereon.models.KamereonVehiclesResponse

async get_person()

GET to /persons/{person_id}.

Return type

renault_api.kamereon.models.KamereonPersonResponse

async get_vehicle_contracts(account_id, vin)

GET to /v{endpoint_version}/cars/{vin}/contracts.

Parameters

  • account_id (str) –

  • vin (str) –

Return type

renault_api.kamereon.models.KamereonVehicleContractsResponse

async get_vehicle_data(account_id, vin, endpoint, params=None, *, adapter_type='kca')

GET to /v{endpoint_version}/cars/{vin}/{endpoint}.

Parameters

  • account_id (str) –

  • vin (str) –

  • endpoint (str) –

  • params (Optional[Dict[str, str]]) –

  • adapter_type (str) –

Return type

renault_api.kamereon.models.KamereonVehicleDataResponse

async get_vehicle_details(account_id, vin)

GET to /accounts/{account_id}/vehicles/{vin}/details.

Parameters

  • account_id (str) –

  • vin (str) –

Return type

renault_api.kamereon.models.KamereonVehicleDetailsResponse

async http_request(method, endpoint, json=None)

GET to specified endpoint.

Parameters

  • method (str) –

  • endpoint (str) –

  • json (Optional[Dict[str, Any]]) –

Return type

renault_api.kamereon.models.KamereonResponse

async login(login_id, password)

Attempt login on Gigya.

Parameters

  • login_id (str) –

  • password (str) –

Return type

None

async set_vehicle_action(account_id, vin, endpoint, attributes, *, adapter_type='kca')

POST to /v{endpoint_version}/cars/{vin}/{endpoint}.

Parameters

  • account_id (str) –

  • vin (str) –

  • endpoint (str) –

  • attributes (Dict[str, Any]) –

  • adapter_type (str) –

Return type

renault_api.kamereon.models.KamereonVehicleDataResponse

Client

Client for Renault API.

class renault_api.renault_client.RenaultClient(session=None, websession=None, locale=None, country=None, locale_details=None, credential_store=None)

Proxy to a Renault profile.

Parameters

  • session (Optional[renault_api.renault_session.RenaultSession]) –

  • websession (Optional[aiohttp.client.ClientSession]) –

  • locale (Optional[str]) –

  • country (Optional[str]) –

  • locale_details (Optional[Dict[str, str]]) –

  • credential_store (Optional[renault_api.credential_store.CredentialStore]) –

Return type

None

async get_api_account(account_id)

Get account proxy for specified account id.

Parameters

account_id (str) –

Return type

renault_api.renault_account.RenaultAccount

async get_api_accounts()

Get account proxies.

Return type

List[renault_api.renault_account.RenaultAccount]

async get_person()

GET to /persons/{person_id}.

Return type

renault_api.kamereon.models.KamereonPersonResponse

property session: renault_api.renault_session.RenaultSession

Get session provider.

Account

Client for Renault API.

class renault_api.renault_account.RenaultAccount(account_id, session=None, websession=None, locale=None, country=None, locale_details=None, credential_store=None)

Proxy to a Renault account.

Parameters

  • account_id (str) –

  • session (Optional[renault_api.renault_session.RenaultSession]) –

  • websession (Optional[aiohttp.client.ClientSession]) –

  • locale (Optional[str]) –

  • country (Optional[str]) –

  • locale_details (Optional[Dict[str, str]]) –

  • credential_store (Optional[renault_api.credential_store.CredentialStore]) –

Return type

None

property account_id: str

Get account id.

async get_api_vehicle(vin)

Get vehicle proxy for specified vin.

Parameters

vin (str) –

Return type

renault_api.renault_vehicle.RenaultVehicle

async get_api_vehicles()

Get vehicle proxies.

Return type

List[renault_api.renault_vehicle.RenaultVehicle]

async get_vehicles()

GET to /accounts/{account_id}/vehicles.

Return type

renault_api.kamereon.models.KamereonVehiclesResponse

property session: renault_api.renault_session.RenaultSession

Get session provider.

Vehicle

Client for Renault API.

class renault_api.renault_vehicle.RenaultVehicle(account_id, vin, *, session=None, websession=None, locale=None, country=None, locale_details=None, credential_store=None, vehicle_details=None, car_adapter=None)

Proxy to a Renault vehicle.

Parameters
Return type

None

property account_id: str

Get account id.

async get_battery_status()

Get vehicle battery status.

Return type

renault_api.kamereon.models.KamereonVehicleBatteryStatusData

async get_car_adapter()

Get vehicle car adapter details.

Return type

renault_api.kamereon.models.KamereonVehicleCarAdapterData

async get_charge_history(start, end, period)

Get vehicle charge history.

Parameters

  • start (datetime.datetime) –

  • end (datetime.datetime) –

  • period (str) –

Return type

renault_api.kamereon.models.KamereonVehicleChargeHistoryData

async get_charge_mode()

Get vehicle charge mode.

Return type

renault_api.kamereon.models.KamereonVehicleChargeModeData

async get_charges(start, end)

Get vehicle charges.

Parameters

  • start (datetime.datetime) –

  • end (datetime.datetime) –

Return type

renault_api.kamereon.models.KamereonVehicleChargesData

async get_charging_settings()

Get vehicle charging settings.

Return type

renault_api.kamereon.models.KamereonVehicleChargingSettingsData

async get_cockpit()

Get vehicle cockpit.

Return type

renault_api.kamereon.models.KamereonVehicleCockpitData

async get_contracts()

Get vehicle contracts.

Return type

List[renault_api.kamereon.models.KamereonVehicleContract]

async get_details()

Get vehicle details.

Return type

renault_api.kamereon.models.KamereonVehicleDetails

async get_hvac_history(start, end, period)

Get vehicle hvac history.

Parameters

  • start (datetime.datetime) –

  • end (datetime.datetime) –

  • period (str) –

Return type

renault_api.kamereon.models.KamereonVehicleHvacHistoryData

async get_hvac_sessions(start, end)

Get vehicle hvac sessions.

Parameters

  • start (datetime.datetime) –

  • end (datetime.datetime) –

Return type

renault_api.kamereon.models.KamereonVehicleHvacSessionsData

async get_hvac_settings()

Get vehicle hvac settings (schedule+mode).

Return type

renault_api.kamereon.models.KamereonVehicleHvacSettingsData

async get_hvac_status()

Get vehicle hvac status.

Return type

renault_api.kamereon.models.KamereonVehicleHvacStatusData

async get_location()

Get vehicle location.

Return type

renault_api.kamereon.models.KamereonVehicleLocationData

async get_lock_status()

Get vehicle lock status.

Return type

renault_api.kamereon.models.KamereonVehicleLockStatusData

async get_notification_settings()

Get vehicle notification settings.

Return type

renault_api.kamereon.models.KamereonVehicleNotificationSettingsData

async get_res_state()

Get vehicle res state.

Return type

renault_api.kamereon.models.KamereonVehicleResStateData

async has_contract_for_endpoint(endpoint)

Check if vehicle has contract for endpoint.

Parameters

endpoint (str) –

Return type

bool

property session: renault_api.renault_session.RenaultSession

Get session.

async set_ac_start(temperature, when=None)

Start vehicle ac.

Parameters

  • temperature (float) –

  • when (Optional[datetime.datetime]) –

Return type

renault_api.kamereon.models.KamereonVehicleHvacStartActionData

async set_ac_stop()

Stop vehicle ac.

Return type

renault_api.kamereon.models.KamereonVehicleHvacStartActionData

async set_charge_mode(charge_mode)

Set vehicle charge mode.

Parameters

charge_mode (str) –

Return type

renault_api.kamereon.models.KamereonVehicleChargeModeActionData

async set_charge_schedules(schedules)

Set vehicle charge schedules.

Parameters

schedules (List[renault_api.kamereon.models.ChargeSchedule]) –

Return type

renault_api.kamereon.models.KamereonVehicleChargeScheduleActionData

async set_charge_start()

Start vehicle charge.

Return type

renault_api.kamereon.models.KamereonVehicleChargingStartActionData

async set_charge_stop()

Start vehicle charge.

Return type

renault_api.kamereon.models.KamereonVehicleChargingStartActionData

async set_hvac_schedules(schedules)

Set vehicle charge schedules.

Parameters

schedules (List[renault_api.kamereon.models.HvacSchedule]) –

Return type

renault_api.kamereon.models.KamereonVehicleHvacScheduleActionData

async supports_endpoint(endpoint)

Check if vehicle supports endpoint.

Parameters

endpoint (str) –

Return type

bool

property vin: str

Get vin.

async warn_on_method(method)

Log a warning if the method requires it.

Parameters

method (str) –

Return type

None