From 3fde86da3569bcc7af8042572972764d41857e5f Mon Sep 17 00:00:00 2001 From: Frank <46161394+BraveChicken1@users.noreply.github.com> Date: Wed, 29 Jun 2022 12:59:56 +0200 Subject: [PATCH] Add HomeConnect services documentation (#20098) Co-authored-by: Franck Nijhof Co-authored-by: Franck Nijhof --- source/_integrations/home_connect.markdown | 77 ++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/source/_integrations/home_connect.markdown b/source/_integrations/home_connect.markdown index bea4698c844..7409602f79f 100644 --- a/source/_integrations/home_connect.markdown +++ b/source/_integrations/home_connect.markdown @@ -59,3 +59,80 @@ Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://hom {% include integrations/config_flow.md %} The integration configuration will ask for the *Client ID* and *Client Secret* created above. See [Application Credentials](/integrations/application_credentials) for more details. + +## Services + +The Home Connect integration makes various services available. +Available services: `set_option_active`, `set_option_selected`, `pause_program`, `resume_program`, `select_program`, `start_program` and `change_setting` + +### Service `home_connect.set_option_active` + +Sets an option for the active program. + +| Service data attribute | Optional | Description | +|---------------------------|----------|--------------------------------------------------| +| `device_id` | no | Id of a device associated with the home appliance. | +| `key` | no | Key of the option. | +| `value` | no | Value of the option. | +| `unit` | yes | Unit for the option. | + +### Service `home_connect.set_option_selected` + +Sets an option for the selected program. + +| Service data attribute | Optional | Description | +|---------------------------|----------|--------------------------------------------------| +| `device_id` | no | Id of a device associated with the home appliance. | +| `key` | no | Key of the option. | +| `value` | no | Value of the option. | +| `unit` | yes | Unit for the option. | + +### Service `home_connect.pause_program` + +Pauses the current running program. + +| Service data attribute | Optional | Description | +|---------------------------|----------|--------------------------------------------------| +| `device_id` | no | Id of a device associated with the home appliance. | + +### Service `home_connect.resume_program` + +Resumes a paused program. + +| Service data attribute | Optional | Description | +|---------------------------|----------|--------------------------------------------------| +| `device_id` | no | Id of a device associated with the home appliance. | + +### Service `home_connect.select_program` + +Selects a program without starting it. + +| Service data attribute | Optional | Description | +|---------------------------|----------|--------------------------------------------------| +| `device_id` | no | Id of a device associated with the home appliance. | +| `program` | no | Program to select. | +| `key` | yes | Key of the option. | +| `value` | yes | Value of the option. | +| `unit` | yes | Unit for the option. | + +### Service `home_connect.start_program` + +Selects a program and starts it. + +| Service data attribute | Optional | Description | +|---------------------------|----------|--------------------------------------------------| +| `device_id` | no | Id of a device associated with the home appliance. | +| `program` | no | Program to select. | +| `key` | yes | Key of the option. | +| `value` | yes | Value of the option. | +| `unit` | yes | Unit for the option. | + +### Service `home_connect.change_setting` + +Changes a setting. + +| Service data attribute | Optional | Description | +|---------------------------|----------|--------------------------------------------------| +| `device_id` | no | Id of a device associated with the home appliance. | +| `key` | no | Key of the setting. | +| `value` | no | Value of the setting. |