mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 07:17:14 +00:00
Documentation for the Home Connect integration (#11336)
This commit is contained in:
parent
a6ef0d9a57
commit
ce76737535
59
source/_integrations/homeconnect.markdown
Normal file
59
source/_integrations/homeconnect.markdown
Normal file
@ -0,0 +1,59 @@
|
||||
---
|
||||
title: "Home Connect"
|
||||
description: "Instructions on how to set up the Home Connect integration within Home Assistant."
|
||||
logo: homeconnect.png
|
||||
ha_category:
|
||||
- Hub
|
||||
- Binary Sensor
|
||||
- Sensor
|
||||
- Switch
|
||||
ha_iot_class: Cloud Push
|
||||
ha_release: 0.110
|
||||
ha_domain: homeconnect
|
||||
---
|
||||
|
||||
The Home Connect integration will allow users to integrate their home appliances supporting the Home Connect standard using the [official API](https://developer.home-connect.com).
|
||||
|
||||
The integration will add one Home Assistant device for each connected home appliance which will have the following entities:
|
||||
|
||||
- A power switch containing additional information as state attributes.
|
||||
- If the device has programs, switches for the individual programs. Note that program options cannot be configured at present.
|
||||
- If the device has programs, sensors for remaining time, elapsed time, and progress in percent.
|
||||
|
||||
Note that it depends on the appliance and on API permissions which of the features are actually supported. A notable limitation is that oven programs cannot be started at present.
|
||||
|
||||
## Installation
|
||||
|
||||
### Installation using a developer account
|
||||
|
||||
1. Visit [https://developer.home-connect.com](https://developer.home-connect.com) and sign up for a developer accouunt.
|
||||
2. Under [Applications](https://developer.home-connect.com/applications), register a new App:
|
||||
|
||||
- Application ID: Home Assistant
|
||||
- OAuth Flow: Authorization Code Grant Flow
|
||||
- Redirect URI : `<YOUR_HOME_ASSISTANT_URL>/auth/external/callback`
|
||||
|
||||
3. Add the client ID and client secret to your `configuration.yaml` (see below).
|
||||
4. Once Home Assistant restarted, go to Configuration > Integrations.
|
||||
5. Select the Home Connect integration.
|
||||
|
||||
### Configuration
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
|
||||
homeconnect:
|
||||
client_id: CLIENT_ID
|
||||
client_secret: CLIENT_SECRET
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
client_id:
|
||||
description: Your Home Connect client ID.
|
||||
required: true
|
||||
type: string
|
||||
client_secret:
|
||||
description: Your Home Connect client secret.
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
BIN
source/images/supported_brands/homeconnect.png
Normal file
BIN
source/images/supported_brands/homeconnect.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 17 KiB |
Loading…
x
Reference in New Issue
Block a user