diff --git a/source/_integrations/renault.markdown b/source/_integrations/renault.markdown index 84e7d51731b..138f4b0d56a 100644 --- a/source/_integrations/renault.markdown +++ b/source/_integrations/renault.markdown @@ -58,6 +58,37 @@ Cancel A/C on vehicle. | ---------------------- | -------- | ----------- | | `vehicle`| yes | device_id of the vehicle | +### Action `renault.ac_set_schedules` + +Update AC schedule on vehicle. + + | 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](#ac_schedule_example) | + +Notes: + +- `schedules` can contain one or more schedules which are set 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 contain the key `readyAtTime` (in UTC format). + +Example: + +```yaml +- id: 1 + activated: true + monday: + readyAtTime: 'T12:00Z' +- id: 2 + activated: false + monday: + readyAtTime: 'T12:00Z' + tuesday: + readyAtTime: 'T12:00Z' +``` + ### Action `renault.charge_set_schedules` Update charge schedule on vehicle. @@ -69,24 +100,22 @@ Update charge schedule on vehicle. 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 +- `schedules` can contain one or more schedules which are set 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. +- 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 contain the keys `startTime` (in UTC format) and `duration` (in minutes). Example: ```yaml -[ - { - 'id': 1, - 'activated': true, - 'monday': {'startTime':'T12:00Z', 'duration':15} - }, - { - 'id': 2, - 'activated': false, - 'monday': {'startTime':'T12:00Z', 'duration':240} - }, -] +- id: 1 + activated: true + monday: + startTime: 'T12:00Z' + duration: 15 +- id: 1 + activated: false + monday: + startTime: 'T12:00Z' + duration: 15 ```