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-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add services to Renault integration (#18981)

Browse Source 
* 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
This commit is contained in:
epenet 2021-09-01 22:32:01 +02:00 committed by GitHub
parent bacf0172f8
commit d206045669
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 62 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
source/_integrations/renault.markdown
View File

@ -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.
<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}
},
]
```
### Service `renault.charge_start`
Start charge on vehicle.
| Service data attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `vehicle`| yes | device_id of the vehicle |