2025.2.5
Home ▸ Integrations ▸

Home Connect

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.

Use cases

  • Monitor the multiple sensors of the appliance and trigger automations based on these sensors.
  • Start programs on your appliances from your dashboard.
  • Monitor the program status of the appliances.
  • Control the light of your appliances.
  • 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 that it depends on the appliance and on API permissions which of the features are supported.

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 for more information.

Supported devices

You can find information about supported devices on the Home Connect website.

Prerequisites

  1. Visit https://developer.home-connect.com and sign up for a developer account.
  2. Enter the email of your login for the original Home Connect App from Bosch/Siemens under “Default Home Connect User Account for Testing” in the sign up process.
  3. Go to the Applications page and select Register Application:
  • Application ID: Home Assistant (or whatever name makes sense to you)
  • OAuth Flow: Authorization Code Grant Flow
  • Redirect URI: https://my.home-assistant.io/redirect/oauth
  • Go to https://my.home-assistant.io/ and make sure that your Home Assistant URL is set there. For example: http://homeassistant:8123/ or http://homeassistant.local:8123
  1. On success, you will be redirected to the Applications page. Select Details for your app. Make note of the client ID and secret - you will need it for the next step. Log out of the Home Connect developer portal.
  2. In Home Assistant, find the Home Connect integration and launch it. You will be prompted to create an Application Credential. You will need to provide a name (it’s arbitrary) in addition to the Client ID and Secret from the previous step. Then, follow the steps in the UI to complete setup.

Important

  • Power on all your appliances during the integration configuration process; otherwise, appliance programs list will be empty.

  • To update the appliance programs list, you can reload the Home Connect integration when an appliance is turned on. If the re-initialization process is not triggered by reload, restart the Home Assistant when an appliance is turned on.

  • After performing the steps above, log out of your Home Connect Developer account. If you don’t do this, the configuration steps below will fail during OAuth authentication with the message “error”: “unauthorized_client”.

  • The provided Home Connect User Account email address must be all lowercase; otherwise, it will result in authentication failures.

  • All changes in the developer portal take 15 minutes before the change is implemented.

I have manually disabled My Home Assistant

If you don’t have My Home Assistant on your installation, you can use <HOME_ASSISTANT_URL>/auth/external/callback as the redirect URI instead.

The <HOME_ASSISTANT_URL> must be the same as used during the configuration/ authentication process.

Internal examples: http://192.168.0.2:8123/auth/external/callback, http://homeassistant.local:8123/auth/external/callback.”

Configuration

To add the Home Connect integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Home Connect.

  • Follow the instructions on screen to complete the setup.

The integration configuration will ask for the Client ID and Client Secret created above. See Application Credentials for more details.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. From the list of devices, select the integration instance you want to remove.
  3. Next to the entry, select the three-dot menu. Then, select Delete.

After deleting the integration, go to your applications at the Home Connect Developer portal, find the application that you were using for Home Assistant, click on details and click on “Delete Application”.

Actions

The Home Connect integration makes various actions available. Available actions: set_option_active, set_option_selected, pause_program, resume_program, select_program, start_program and change_setting

Action home_connect.set_option_active

Sets an option for the active program.

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.

Action home_connect.set_option_selected

Sets an option for the selected program.

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.

Action home_connect.pause_program

Pauses the current running program.

Data attribute Optional Description
device_id no Id of a device associated with the home appliance.

Action home_connect.resume_program

Resumes a paused program.

Data attribute Optional Description
device_id no Id of a device associated with the home appliance.

Action home_connect.select_program

Selects a program without starting it.

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.

Action home_connect.start_program

Selects a program and starts it.

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.

Action home_connect.change_setting

Changes a setting.

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.

Troubleshooting

I could not configure the Home Connect integration

Symptom: I tried to configure the Home Connect integration, but it failed with the message Error while obtaining access token.

Description

This problem might occur when the application credentials are not correctly configured.

Solution

To solve the above issue, follow these steps:

  1. Go to Settings > Devices & services.

  2. In the top right corner, select the three dots menu and select Application credentials.

    Devices and services overflow menu

    Application credential list

  3. Select the three dots menu from the application credentials you created for the Home Connect integration and select Delete.

  4. Add the Home Connect integration again under Settings > Devices & services

Unavailable entities for a device

Symptom: “The entities related to an appliance were available but no longer are”

After reloading the Home Connect integration, the entities related to an appliance that used to be available are no longer available. Also, when downloading the diagnostics data from the device entry, the following data is obtained:

{
  "data": {
    "connected": false,
    "status": {},
    "programs": null
  }
}
Description

Unavailable entities can have multiple causes:

  • The appliance is turned off. When it is turned off, the appliance is disconnected and the API does not retrieve information about the appliance.
  • The appliance is experiencing a network issue.
  • The Home Connect API is experiencing issues.
Solution

To try to solve the above issues, follow these steps:

  1. Turn on the appliance and reload the Home Connect integration.
  2. If the appliance is turned on and the issue persists, check the network connection of the appliance and perform a soft reset on the appliance.
  3. If the issue persists, check the connection of the appliance with the Home Connect API by checking it in the Home Connect app.
    1. Open the Home Connect app.
    2. Go to the appliance that is experiencing the issue.
    3. At the bottom of the screen, open the settings menu.
    4. Go to the Network section.
    5. Verify if the appliance is connected to the cloud:
      • If the line between the appliance and the cloud is red and with a red warning icon , the appliance is not connected to the Home Connect API.
      • If the line between the appliance and the cloud is green, the appliance is connected to the cloud.
  4. If everything is correct and the issue persists, contact Home Connect support.

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.