home-assistant.io/source/_integrations/home_connect.markdown
tubalainen 2a97ebaa5a
Clarification on internal_url (#13939)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2020-07-08 13:34:44 +02:00

2.3 KiB

title, description, logo, ha_category, ha_iot_class, ha_release, ha_domain, ha_codeowners, ha_config_flow
title description logo ha_category ha_iot_class ha_release ha_domain ha_codeowners ha_config_flow
Home Connect Instructions on how to set up the Home Connect integration within Home Assistant. homeconnect.png
Hub
Binary Sensor
Sensor
Switch
Cloud Push 0.110 home_connect
@DavidMStraub
true

The Home Connect integration allows users to integrate their home appliances supporting the Home Connect standard for Bosch and Siemens using the official cloud API.

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, switches for each of the individual programs will be added. Note that program options cannot be configured currently.
  • If the device has programs, a timestamp sensor for remaining time and a numeric sensor for the progress percentage.

Note that it depends on the appliance and on API permissions which of the features are supported. A notable limitation is that oven programs cannot be started currently.

Installation

Installation using a developer account

  1. Visit https://developer.home-connect.com and sign up for a developer account.
  2. Under Applications, register a new App:
  • Application ID: Home Assistant (or whatever name makes sense to you)
  • OAuth Flow: Authorization Code Grant Flow
  • Redirect URI: "<INTERNAL_HOME_ASSISTANT_URL>/auth/external/callback Use your internal Home Assistant URL, if you didn't configure one manually, use your local IP address. Examples: http://192.168.0.2:8123/auth/external/callback, http://homeassistant.local:8123/auth/external/callback."
  1. Add the client ID and client secret to your configuration.yaml (see below).
  2. Once Home Assistant has restarted, go to Configuration > Integrations.
  3. Select the Home Connect integration.

Configuration

# Example configuration.yaml entry

home_connect:
  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 %}