Kamereon low-level API Reference

Core

Kamereon API.

renault_api.kamereon.get_account_url(root_url, account_id)

Get the url to the account.

Parameters:

  • root_url (str)

  • account_id (str)

Return type:

str

async renault_api.kamereon.get_account_vehicles(websession, root_url, api_key, gigya_jwt, country, account_id)

GET to /accounts/{account_id}/vehicles.

Parameters:

  • websession (ClientSession)

  • root_url (str)

  • api_key (str)

  • gigya_jwt (str)

  • country (str)

  • account_id (str)

Return type:

KamereonVehiclesResponse

renault_api.kamereon.get_car_adapter_url(root_url, account_id, version, vin, *, adapter_type='kca')

Get the url to the car adapter.

Parameters:

  • root_url (str)

  • account_id (str)

  • version (int)

  • vin (str)

  • adapter_type (str)

Return type:

str

renault_api.kamereon.get_commerce_url(root_url)

Get the Kamereon base commerce url.

Parameters:

root_url (str)

Return type:

str

renault_api.kamereon.get_contracts_url(root_url, account_id, vin)

Get the url to the car contracts.

Parameters:

  • root_url (str)

  • account_id (str)

  • vin (str)

Return type:

str

async renault_api.kamereon.get_person(websession, root_url, api_key, gigya_jwt, country, person_id)

GET to /persons/{person_id}.

Parameters:

  • websession (ClientSession)

  • root_url (str)

  • api_key (str)

  • gigya_jwt (str)

  • country (str)

  • person_id (str)

Return type:

KamereonPersonResponse

renault_api.kamereon.get_person_url(root_url, person_id)

Get the url to the person.

Parameters:

  • root_url (str)

  • person_id (str)

Return type:

str

async renault_api.kamereon.get_vehicle_contracts(websession, root_url, api_key, gigya_jwt, country, locale, account_id, vin)

GET to /accounts/{accountId}/vehicles/{vin}/contracts.

Parameters:

  • websession (ClientSession)

  • root_url (str)

  • api_key (str)

  • gigya_jwt (str)

  • country (str)

  • locale (str)

  • account_id (str)

  • vin (str)

Return type:

KamereonVehicleContractsResponse

async renault_api.kamereon.get_vehicle_data(websession, root_url, api_key, gigya_jwt, country, account_id, vin, endpoint, endpoint_version=None, params=None, *, adapter_type='kca')

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

Parameters:

  • websession (ClientSession)

  • root_url (str)

  • api_key (str)

  • gigya_jwt (str)

  • country (str)

  • account_id (str)

  • vin (str)

  • endpoint (str)

  • endpoint_version (int | None)

  • params (dict[str, str] | None)

  • adapter_type (str)

Return type:

KamereonVehicleDataResponse

async renault_api.kamereon.get_vehicle_details(websession, root_url, api_key, gigya_jwt, country, account_id, vin)

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

Parameters:

  • websession (ClientSession)

  • root_url (str)

  • api_key (str)

  • gigya_jwt (str)

  • country (str)

  • account_id (str)

  • vin (str)

Return type:

KamereonVehicleDetailsResponse

async renault_api.kamereon.request(websession, method, url, api_key, gigya_jwt, params, json=None, schema=None, *, wrap_array_in=None)

Process Kamereon HTTP request.

Parameters:

  • websession (ClientSession)

  • method (str)

  • url (str)

  • api_key (str)

  • gigya_jwt (str)

  • params (dict[str, str])

  • json (dict[str, Any] | None)

  • schema (Schema | None)

  • wrap_array_in (str | None)

Return type:

KamereonResponse

async renault_api.kamereon.set_vehicle_action(websession, root_url, api_key, gigya_jwt, country, account_id, vin, endpoint, attributes, endpoint_version=None, data_type=None, *, adapter_type='kca')

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

Parameters:

  • websession (ClientSession)

  • root_url (str)

  • api_key (str)

  • gigya_jwt (str)

  • country (str)

  • account_id (str)

  • vin (str)

  • endpoint (str)

  • attributes (dict[str, Any])

  • endpoint_version (int | None)

  • data_type (dict[str, Any] | None)

  • adapter_type (str)

Return type:

KamereonVehicleDataResponse

Data models

Kamereon models.

class renault_api.kamereon.models.ChargeDaySchedule(raw_data, startTime, duration)

Kamereon vehicle charge schedule for day.

Parameters:

  • raw_data (dict[str, Any])

  • startTime (str | None)

  • duration (int | None)

for_json()

Create dict for json.

Return type:

dict[str, Any]

get_end_time()

Get end time.

Return type:

str | None

class renault_api.kamereon.models.ChargeSchedule(raw_data, id, activated, monday, tuesday, wednesday, thursday, friday, saturday, sunday)

Kamereon vehicle charge schedule for week.

Parameters:
for_json()

Create dict for json.

Return type:

dict[str, Any]

class renault_api.kamereon.models.EndpointDefinition(endpoint: str, mode: str = 'default')
Parameters:

  • endpoint (str)

  • mode (str)

class renault_api.kamereon.models.HvacDaySchedule(raw_data, readyAtTime)

Kamereon vehicle hvac schedule for day.

Parameters:

  • raw_data (dict[str, Any])

  • readyAtTime (str | None)

for_json()

Create dict for json.

Return type:

dict[str, str | None]

class renault_api.kamereon.models.HvacSchedule(raw_data, id, activated, monday, tuesday, wednesday, thursday, friday, saturday, sunday)

Kamereon vehicle hvac schedule for week.

Parameters:
for_json()

Create dict for json.

Return type:

dict[str, Any]

class renault_api.kamereon.models.KamereonPersonAccount(raw_data, accountId, accountType, accountStatus)

Kamereon person account data.

Parameters:

  • raw_data (dict[str, Any])

  • accountId (str | None)

  • accountType (str | None)

  • accountStatus (str | None)

class renault_api.kamereon.models.KamereonPersonResponse(raw_data, errors, accounts)

Kamereon response to GET on /persons/{gigya_person_id}.

Parameters:
class renault_api.kamereon.models.KamereonResponse(raw_data, errors)

Kamereon response.

Parameters:
raise_for_error_code()

Raise exception if errors found in the response.

Return type:

None

class renault_api.kamereon.models.KamereonResponseError(raw_data, errorCode, errorMessage)

Kamereon response error.

Parameters:

  • raw_data (dict[str, Any])

  • errorCode (str | None)

  • errorMessage (str | None)

get_error_details()

Extract the error details sometimes hidden inside nested JSON.

Return type:

str | None

raise_for_error_code()

Raise exception from response error.

Return type:

None

class renault_api.kamereon.models.KamereonVehicleBatterySocActionData(raw_data)

Kamereon vehicle action data soc attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleBatterySocData(raw_data, lastEnergyUpdateTimestamp, socMin, socTarget)

Kamereon vehicle battery state of charge limits data.

Parameters:

  • raw_data (dict[str, Any])

  • lastEnergyUpdateTimestamp (str | None)

  • socMin (int | None)

  • socTarget (int | None)

class renault_api.kamereon.models.KamereonVehicleBatteryStatusData(raw_data, timestamp, batteryLevel, batteryTemperature, batteryAutonomy, batteryCapacity, batteryAvailableEnergy, plugStatus, chargingStatus, chargingRemainingTime, chargingInstantaneousPower, chargingRemainingTimeLastUpdateDateTime, V2L_SystemStatusDisplay)

Kamereon vehicle battery-status data.

Parameters:

  • raw_data (dict[str, Any])

  • timestamp (str | None)

  • batteryLevel (int | None)

  • batteryTemperature (int | None)

  • batteryAutonomy (int | None)

  • batteryCapacity (int | None)

  • batteryAvailableEnergy (int | None)

  • plugStatus (int | None)

  • chargingStatus (float | None)

  • chargingRemainingTime (int | None)

  • chargingInstantaneousPower (float | None)

  • chargingRemainingTimeLastUpdateDateTime (str | None)

  • V2L_SystemStatusDisplay (int | None)

get_charging_status()

Return charging status.

Return type:

ChargeState | None

get_plug_status()

Return plug status.

Return type:

PlugState | None

class renault_api.kamereon.models.KamereonVehicleCarAdapterData(raw_data, vin, vehicleId, batteryCode, brand, canGeneration, carGateway, deliveryCountry, deliveryDate, energy, engineType, familyCode, firstRegistrationDate, gearbox, modelCode, modelCodeDetail, modelName, radioType, region, registrationCountry, registrationNumber, tcuCode, versionCode, privacyMode, privacyModeUpdateDate, svtFlag, svtBlockFlag)

Kamereon vehicle data hvac-status attributes.

Parameters:

  • raw_data (dict[str, Any])

  • vin (str | None)

  • vehicleId (int | None)

  • batteryCode (str | None)

  • brand (str | None)

  • canGeneration (str | None)

  • carGateway (str | None)

  • deliveryCountry (str | None)

  • deliveryDate (str | None)

  • energy (str | None)

  • engineType (str | None)

  • familyCode (str | None)

  • firstRegistrationDate (str | None)

  • gearbox (str | None)

  • modelCode (str | None)

  • modelCodeDetail (str | None)

  • modelName (str | None)

  • radioType (str | None)

  • region (str | None)

  • registrationCountry (str | None)

  • registrationNumber (str | None)

  • tcuCode (str | None)

  • versionCode (str | None)

  • privacyMode (str | None)

  • privacyModeUpdateDate (str | None)

  • svtFlag (bool | None)

  • svtBlockFlag (bool | None)

controls_action_via_kcm(action)

Return True if model uses endpoint via kcm.

Parameters:

action (str)

Return type:

bool

reports_charging_power_in_watts()

Return True if model reports chargingInstantaneousPower in watts.

Return type:

bool

uses_electricity()

Return True if model uses electricity.

Return type:

bool

uses_fuel()

Return True if model uses fuel.

Return type:

bool

class renault_api.kamereon.models.KamereonVehicleChargeHistoryData(raw_data)

Kamereon vehicle data charge-history attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleChargeModeActionData(raw_data)

Kamereon vehicle action data charge-mode attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleChargeModeData(raw_data, chargeMode)

Kamereon vehicle data charge-mode attributes.

Parameters:

  • raw_data (dict[str, Any])

  • chargeMode (str | None)

class renault_api.kamereon.models.KamereonVehicleChargeScheduleActionData(raw_data)

Kamereon vehicle action data charge-schedule attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleChargesData(raw_data)

Kamereon vehicle data charges attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleChargingSettingsData(raw_data, mode, schedules, startDateTime, dateTime, delay)

Kamereon vehicle data charging-settings attributes.

Parameters:

  • raw_data (dict[str, Any])

  • mode (str | None)

  • schedules (list[ChargeSchedule] | None)

  • startDateTime (str | None)

  • dateTime (str | None)

  • delay (int | None)

update(args)

Update schedule.

Parameters:

args (dict[str, Any])

Return type:

None

class renault_api.kamereon.models.KamereonVehicleChargingStartActionData(raw_data)

Kamereon vehicle action data charging-start attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleCockpitData(raw_data, fuelAutonomy, fuelQuantity, totalMileage)

Kamereon vehicle data cockpit attributes.

Parameters:

  • raw_data (dict[str, Any])

  • fuelAutonomy (float | None)

  • fuelQuantity (float | None)

  • totalMileage (float | None)

class renault_api.kamereon.models.KamereonVehicleContract(raw_data, type, contractId, code, group, durationMonths, startDate, endDate, status, statusLabel, description)

Kamereon vehicle contract.

Parameters:

  • raw_data (dict[str, Any])

  • type (str | None)

  • contractId (str | None)

  • code (str | None)

  • group (str | None)

  • durationMonths (int | None)

  • startDate (str | None)

  • endDate (str | None)

  • status (str | None)

  • statusLabel (str | None)

  • description (str | None)

class renault_api.kamereon.models.KamereonVehicleContractsResponse(raw_data, errors, contractList)

Kamereon response to GET on /accounts/{accountId}/vehicles/{vin}/contracts.

Parameters:
class renault_api.kamereon.models.KamereonVehicleData(raw_data, type, id, attributes)

Kamereon vehicle data.

Parameters:

  • raw_data (dict[str, Any])

  • type (str | None)

  • id (str | None)

  • attributes (dict[str, Any] | None)

class renault_api.kamereon.models.KamereonVehicleDataAttributes(raw_data)

Kamereon vehicle data attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleDataResponse(raw_data, errors, data)

Kamereon response to GET/POST on …/cars/{vin}/{type}.

Parameters:
get_attributes(schema)

Return jwt token.

Parameters:

schema (Schema)

Return type:

KamereonVehicleDataAttributes

class renault_api.kamereon.models.KamereonVehicleDetails(raw_data, vin, registrationNumber, radioCode, brand, model, energy, engineEnergyType, assets)

Kamereon vehicle details.

Parameters:
controls_action_via_kcm(action)

Return True if model uses endpoint via kcm.

Parameters:

action (str)

Return type:

bool

get_asset(asset_type)

Return asset.

Parameters:

asset_type (str)

Return type:

dict[str, Any] | None

get_brand_label()

Return vehicle model label.

Return type:

str | None

get_endpoint(endpoint)

Return model endpoint

Parameters:

endpoint (str)

Return type:

EndpointDefinition | None

get_endpoints()

Return model endpoints.

Return type:

Mapping[str, EndpointDefinition | None]

get_energy_code()

Return vehicle energy code.

Return type:

str | None

get_model_code()

Return vehicle model code.

Return type:

str | None

get_model_label()

Return vehicle model label.

Return type:

str | None

get_picture(size=AssetPictureSize.LARGE)

Return vehicle picture.

Parameters:

size (AssetPictureSize)

Return type:

str | None

reports_charge_session_durations_in_minutes()

Return True if model reports history durations in minutes.

Return type:

bool

reports_charging_power_in_watts()

Return True if model reports chargingInstantaneousPower in watts.

Return type:

bool

supports_endpoint(endpoint)

Return True if model supports specified endpoint.

Parameters:

endpoint (str)

Return type:

bool

uses_electricity()

Return True if model uses electricity.

Return type:

bool

uses_fuel()

Return True if model uses fuel.

Return type:

bool

class renault_api.kamereon.models.KamereonVehicleDetailsGroup(raw_data, code, label, group)

Kamereon vehicle details group data.

Parameters:

  • raw_data (dict[str, Any])

  • code (str | None)

  • label (str | None)

  • group (str | None)

class renault_api.kamereon.models.KamereonVehicleDetailsResponse(raw_data, vin, registrationNumber, radioCode, brand, model, energy, engineEnergyType, assets, errors)

Kamereon response to GET on /accounts/{account_id}/vehicles/{vin}/details.

Parameters:
class renault_api.kamereon.models.KamereonVehicleHvacHistoryData(raw_data)

Kamereon vehicle data hvac-history attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleHvacModeActionData(raw_data)

Kamereon vehicle action data hvac-mode attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleHvacScheduleActionData(raw_data)

Kamereon vehicle action data hvac-schedule attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleHvacSessionsData(raw_data)

Kamereon vehicle data hvac-sessions attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleHvacSettingsData(raw_data, mode, schedules)

Kamereon vehicle data hvac-settings (mode+schedules) attributes.

Parameters:

  • raw_data (dict[str, Any])

  • mode (str | None)

  • schedules (list[HvacSchedule] | None)

update(args)

Update schedule.

Parameters:

args (dict[str, Any])

Return type:

None

class renault_api.kamereon.models.KamereonVehicleHvacStartActionData(raw_data)

Kamereon vehicle action data hvac-start attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleHvacStatusData(raw_data, lastUpdateTime, externalTemperature, internalTemperature, hvacStatus, nextHvacStartDate, socThreshold)

Kamereon vehicle data hvac-status attributes.

Parameters:

  • raw_data (dict[str, Any])

  • lastUpdateTime (str | None)

  • externalTemperature (float | None)

  • internalTemperature (float | None)

  • hvacStatus (str | None)

  • nextHvacStartDate (str | None)

  • socThreshold (float | None)

class renault_api.kamereon.models.KamereonVehicleLocationData(raw_data, lastUpdateTime, gpsLatitude, gpsLongitude)

Kamereon vehicle data location attributes.

Parameters:

  • raw_data (dict[str, Any])

  • lastUpdateTime (str | None)

  • gpsLatitude (float | None)

  • gpsLongitude (float | None)

class renault_api.kamereon.models.KamereonVehicleLockStatusData(raw_data, lockStatus, doorStatusRearLeft, doorStatusRearRight, doorStatusDriver, doorStatusPassenger, hatchStatus, lastUpdateTime)

Kamereon vehicle data lock-status attributes.

Parameters:

  • raw_data (dict[str, Any])

  • lockStatus (str | None)

  • doorStatusRearLeft (str | None)

  • doorStatusRearRight (str | None)

  • doorStatusDriver (str | None)

  • doorStatusPassenger (str | None)

  • hatchStatus (str | None)

  • lastUpdateTime (str | None)

class renault_api.kamereon.models.KamereonVehicleNotificationSettingsData(raw_data)

Kamereon vehicle data notification-settings attributes.

Parameters:

raw_data (dict[str, Any])

class renault_api.kamereon.models.KamereonVehicleResStateData(raw_data, details, code)

Kamereon vehicle data res-set attributes.

Parameters:

  • raw_data (dict[str, Any])

  • details (str | None)

  • code (str | None)

class renault_api.kamereon.models.KamereonVehicleTyrePressureData(raw_data, flPressure, frPressure, rlPressure, rrPressure, flStatus, frStatus, rlStatus, rrStatus)

Kamereon vehicle tyre-pressure data.

Parameters:

  • raw_data (dict[str, Any])

  • flPressure (int | None)

  • frPressure (int | None)

  • rlPressure (int | None)

  • rrPressure (int | None)

  • flStatus (int | None)

  • frStatus (int | None)

  • rlStatus (int | None)

  • rrStatus (int | None)

Kamereon vehicles link data.

Parameters:
class renault_api.kamereon.models.KamereonVehiclesResponse(raw_data, errors, accountId, country, vehicleLinks)

Kamereon response to GET on /accounts/{account_id}/vehicles.

Parameters:
renault_api.kamereon.models.get_model_endpoint(model_code, endpoint)

Return model endpoint

Parameters:

  • model_code (str | None)

  • endpoint (str)

Return type:

EndpointDefinition | None

renault_api.kamereon.models.get_model_endpoints(model_code)

Return model endpoints.

Parameters:

model_code (str | None)

Return type:

Mapping[str, EndpointDefinition | None]