Overview Home Connect / BSH



This function block integrates home appliances from Bosch, Siemens, NEFF and Gaggenau via the Home Connect cloud API (washing machine, dryer, dishwasher, oven, coffee machine, refrigerator, extractor hood and others).

The connection runs exclusively via the Home Connect cloud (HTTPS); a local connection to the appliances is not provided by the manufacturer. The controller therefore requires an internet connection. One block represents one Home Connect account; the appliances of the account are generated as addresses.

Prerequisite: The customer has a Home Connect account (created in the Home Connect app) and their appliances are registered in that account. The controller must be connected to the internet and the Studio must be connected to the controller.

Login and linking the customer account — step by step:
  1. Insert the block and open its properties. Click the Login / search appliances button — the login dialog opens.
  2. In the dialog, click Login. The controller requests a login code from Home Connect; after a few seconds a web address (link) and a code appear in the dialog.
  3. Click the link (it opens the browser) — or open the address on the customer's phone/PC. Use Copy code to copy the code to the clipboard.
  4. In the browser, sign in with the customer's Home Connect account (the customer's e-mail and password).
  5. Enter the code shown (if not already pre-filled) and confirm/allow the access.
  6. Once the confirmation in the browser is complete, the dialog automatically switches to Logged in and starts the appliance search. The code is valid for a limited time; if it expires, simply click Login again.
  7. The appliances found are shown in the list. With Apply they are stored in the block and the addresses are generated automatically.
The login is stored permanently in the controller (also after a restart) — so the procedure only has to be done once. Logout in the dialog resets the link; a new login is then required.

No customer PC/phone at hand? The link with the code can be opened on any device — the only thing that matters is signing in there with the customer's Home Connect account.

The following addresses are created per appliance:
  • On/Off (input): switches the appliance on or off. The matching off value (off or standby) is determined automatically. Some appliances (e.g. washer, dryer) cannot be switched off via the API at all — only directly at the appliance.
  • Program start/stop (input): 1 starts the program selected on the appliance, 0 stops the running program.
  • Operation state (output): 0=inactive, 1=ready, 2=delayed start, 3=running, 4=pause, 5=action required, 6=finished, 7=error, 8=aborting.
  • Door state (output): 0=closed, 1=open, 2=locked.
  • Remaining time (output): remaining program time in seconds.
  • Progress (output, 0..100 %): program progress.
  • Connected (output): appliance is connected to the cloud.
Important: To start a program, remote start must be enabled on the appliance and a program must be selected on the appliance. The Home Connect terms of use require that the user is informed about automatically started programs.

Note: Status changes are received via a permanent event stream from the cloud and are available immediately without cyclic polling. For testing, simulator.home-connect.com can be used as server with a developer account; the login is performed automatically there without entering a code.

Outputs
ER
 Error counter
 Number of communication errors (-1 = software compiled without SSL support)
ST
 Status
 0 = not logged in, 1 = logged in, 2 = logged in and event stream active

Parameters
Server
 Home Connect server (default: api.home-connect.com; for testing: simulator.home-connect.com)
Client ID / client secret
 Credentials of the API application. Leave empty = use the built-in uni-PRO credentials; only fill in for your own developer accounts (e.g. simulator).
Timeout (ms)
 Connection timeout in milliseconds
Number of appliances
 Number of integrated appliances (determines the number of generated addresses)
Appliance list
 Assignment of the appliances (appliance ID/name/type). Filled automatically by the search.
Debug
 Additional diagnostic output in the error log

See also the common parameters of all function blocks.