Small fixes for Home Connect documentation (#37829)

* Remove duplicated information about entities

* Change doc structure to follow the basic structure

* Small fix

* Delete sentence
This commit is contained in:
J. Diego Rodríguez Royo 2025-03-06 10:26:31 +01:00 committed by GitHub
parent a283476ca3
commit b05396c331
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -42,31 +42,10 @@ The Home Connect integration allows users to integrate their home appliances sup
- Control the light of your appliances. - Control the light of your appliances.
- Adjust the appliance settings. - Adjust the appliance settings.
The integration will add one Home Assistant device for each connected home appliance which will have the following entities:
- A power switch
- If the device has programs:
- Two select entities that will allow you to select and start a program between the available ones.
- A timestamp sensor for remaining time and a numeric sensor for the progress percentage.
- Light:
- Hoods:
- Functional light: on/off and brightness
- Ambient light: on/off, brightness, HSV and RGB
- Dishwasher: on/off, brightness, HS and RGB
- Cooling appliances: Both, external and internal lights, on/off and brightness
- Numbers that set the temperature of cooling appliances.
- Time for alarm clock for cooktops and ovens.
- Multiple sensors that report the different states and events reported by the appliance.
- Binary sensors that show binary states of the appliance.
{% note %} {% note %}
Note that it depends on the appliance and on API permissions which of the features are supported. Note that it depends on the appliance and on API permissions which of the features are supported.
{% endnote %} {% endnote %}
{% note %}
Some devices only have the state `on` and turn off is not supported by the appliance, check [power state availability at Home Connect API documentation](https://api-docs.home-connect.com/settings/#power-state) for more information.
{% endnote %}
## Supported devices ## Supported devices
You can find information about supported devices on the [Home Connect website](https://www.home-connect.com/global/smart-home-appliances). You can find information about supported devices on the [Home Connect website](https://www.home-connect.com/global/smart-home-appliances).
@ -111,14 +90,6 @@ Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://hom
The integration configuration will ask for the *Client ID* and *Client Secret* created above. See [Application Credentials](/integrations/application_credentials) for more details. The integration configuration will ask for the *Client ID* and *Client Secret* created above. See [Application Credentials](/integrations/application_credentials) for more details.
## Removing the integration
This integration follows standard integration removal. No extra steps are required.
{% include integrations/remove_device_service.md %}
After deleting the integration, go to [your applications at the Home Connect Developer portal](https://developer.home-connect.com/applications), find the application that you were using for Home Assistant, click on details and click on "Delete Application".
## Supported functionality ## Supported functionality
{% note %} {% note %}
@ -1003,7 +974,6 @@ Changes a setting.
| `key` | no | Key of the setting. | | `key` | no | Key of the setting. |
| `value` | no | Value of the setting. | | `value` | no | Value of the setting. |
## Automation examples ## Automation examples
Get started with these automation examples Get started with these automation examples
@ -1078,6 +1048,12 @@ actions:
This integration uses server-sent events from the Home Connect API to receive live updates from the appliances. This integration uses server-sent events from the Home Connect API to receive live updates from the appliances.
When the configuration entry is loaded or after a streaming error (for example after disconnection), the integration will request all data (such as appliance info, available commands, programs, settings, and status) for all appliances. When the configuration entry is loaded or after a streaming error (for example after disconnection), the integration will request all data (such as appliance info, available commands, programs, settings, and status) for all appliances.
If a new appliance is added to the account, the integration will request data for the new appliance and expose the related entities automatically. If a new appliance is added to the account, the integration will request data for the new appliance and expose the related entities automatically.
## Known limitations
- The Home Connect API does not fully match the Home Connect app. Some programs, options, or settings available in the app may not be accessible or usable via the API.
- This integration supports only one integration entry, as the Home Connect API does not allow for the unique identification of an account.
## Troubleshooting ## Troubleshooting
### I could not configure the Home Connect integration ### I could not configure the Home Connect integration
@ -1144,7 +1120,10 @@ To try to solve the above issues, follow these steps:
- [Home Connect service and contact](https://www.home-connect.com/us/en/support/contact-and-service) - [Home Connect service and contact](https://www.home-connect.com/us/en/support/contact-and-service)
- [Home Connect developer Help & Support](https://developer.home-connect.com/support) - [Home Connect developer Help & Support](https://developer.home-connect.com/support)
## Known limitations ## Removing the integration
- The Home Connect API does not fully match the Home Connect app. Some programs, options, or settings available in the app may not be accessible or usable via the API. This integration follows standard integration removal. No extra steps are required.
- This integration supports only one integration entry, as the Home Connect API does not allow for the unique identification of an account.
{% include integrations/remove_device_service.md %}
After deleting the integration, go to [your applications at the Home Connect Developer portal](https://developer.home-connect.com/applications), find the application that you were using for Home Assistant, click on details and click on "Delete Application".