jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for renault.ac set schedules (#34636)

Browse Source 
* Add documentation for renault.ac_set_schedules

(cherry picked from commit 7751d4dc5424dd0568f3004c1ef4983d961a8c30)

* Tiny style tweaks

(cherry picked from commit 62b8bd7ba8488e10878e8df5d1b334cd3e17e5de)

* Remove JSON examples and replace with YAML

* tiny tweaks

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
vhkristof 2024-09-23 09:43:47 +02:00 committed by GitHub
parent f5c293f30d
commit 059b3eb1e3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 43 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
source/_integrations/renault.markdown
View File

@ -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).
<a name="ac_schedule_example">Example</a>:
```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).
<a name="schedule_example">Example</a>:
```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
```