From d206045669b2ec7d29ac6da441d3d178820fae58 Mon Sep 17 00:00:00 2001 From: epenet <6771947+epenet@users.noreply.github.com> Date: Wed, 1 Sep 2021 22:32:01 +0200 Subject: [PATCH] Add services to Renault integration (#18981) * Add services to Renault integration * Drop charge_set_mode, and replace vin with vehicle to match parent PR * Add examples and notes * Move schedule example out of table --- source/_integrations/renault.markdown | 62 +++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) diff --git a/source/_integrations/renault.markdown b/source/_integrations/renault.markdown index 00961c31b57..649d5828d23 100644 --- a/source/_integrations/renault.markdown +++ b/source/_integrations/renault.markdown @@ -36,3 +36,65 @@ You need two API keys: one for Gigya and one for Kamereon and they shouldn't be {% include integrations/config_flow.md %} All vehicles linked to the account should then get added as devices, with sensors added as linked entity. + +## Services + +### Service `renault.ac_start` + +Start A/C on vehicle. + + | Service data attribute | Required | Description | Example | + | ---------------------- | -------- | ----------- | ------- | + | `vehicle`| yes | device_id of the vehicle | | + | `temperature` | yes | Target A/C temperature in °C | | + | `when` | no | Timestamp for the start of the A/C (optional - defaults to now) | `2020-05-01T17:45:00` | + +### Service `renault.ac_cancel` + +Cancel A/C on vehicle. + + | Service data attribute | Required | Description | + | ---------------------- | -------- | ----------- | + | `vehicle`| yes | device_id of the vehicle | + +### Service `renault.charge_set_schedules` + +Update charge schedule on vehicle. + + | Service data attribute | Required | Description | Example | + | ---------------------- | -------- | ----------- | ------- | + | `vehicle`| yes | device_id of the vehicle | + | `schedules` | yes | Schedule details. Can be a single schedule or a list of schedules | see [example below](#schedule_example) | + +Notes: + +- `schedules` can be in the form `{'id':1,...}` when updating a single schedules, or in the form `[{'id':1,...},{'id':2,...},...]` when updating multiple schedules within the same call +- the `id` is compulsory on each `schedule` (should be 1 to 5 depending on the vehicle) +- the `activated` flag is an optional boolean. If it is not provided, then the existing flag will be kept as is. +- the `monday` to `sunday` elements are optional. If they are not provided, then the existing settings will be kept for each day. If they are provided as None, then the existing setting will be cleared. If a value is provided, it must conform to this format `{'startTime':'T12:00Z','duration':15}` where start time is in UTC format and the duration is in minutes. + +Example: + +```yaml +[ + { + 'id': 1, + 'activated': true, + 'monday': {'startTime':'T12:00Z', 'duration':15} + }, + { + 'id': 2, + 'activated': false, + 'monday': {'startTime':'T12:00Z', 'duration':240} + }, +] +``` + +### Service `renault.charge_start` + +Start charge on vehicle. + + | Service data attribute | Required | Description | + | ---------------------- | -------- | ----------- | + | `vehicle`| yes | device_id of the vehicle | +