Miele Integration for Home Assistant

The capabilities are based on Miele API version 1.0.5. The official capability overview is here https://www.miele.com/developer/assets/API_V1.x.x_capabilities_by_device.pdf . Note that this matrix is not entirely correct. Some devices lack support and some devices support features that are not marked.

All supported appliances will show a status sensor, some appliances will show more sensors, however only freezers, refridgerators, dishwashers and washer/dryers will have a more complete support. Changes on the appliances will be pushed to HA and displayed immediately. As a backup the status is read from the cloud every 60 seconds.

Read more on design philosophy etc in the Wiki

Installation

Make sure you have the credentials available for your account with Miele cloud. You have to register on https://www.miele.com/developer/ If you have an existing integration with the name "miele" you are recommended to remove it before attemping to install this one.

Preferred download method

Use HACS, add this repo as a custom repository and install Miele integration.
Restart Home Assistant

Manual download method

Copy all files from custom_components/miele in this repo to your config custom_components/miele
Restart Home Assistant

Setup

Request a client_id and client_secret from the manufacturer and enter following lines to configuration.yaml

miele:
  client_id: your_client_id
  client_secret: your_client_secret

Goto Integrations->Add and select Miele

Follow instructions to authenticate with Miele cloud server. Allow full access for Home Assistant client.

Wiki - Documentation

Documentation (at least some...) can be found in the wiki

Development

There are many ways to setup a development environment. Following procedure works fine in the hands of the maintainer developing with VS Code on WSL2/Windows.

Make sure you have python3.9 installed on your WSL.
Create a fork on github

$ git clone https://github.com/{your_user}/miele
$ cd miele
$ make install_dev

Home Assistant has defined a code style. Run make lint before pushing your changes to align with the peferred style.

There are many ways to test the integration, two examples are:

copy all files in custom_comonents/miele to custom_components/miele in your HA configuration directory
mount custom_components/miele into a HA development container

Debugging and filing issues

If you find bugs or other issues please download diagnostic information from the Miele integration card or from the device page and attach the file to your issue report. One recurring issue is the translation of Program name and phases. This is due to sparse, if any, documentation from Miele. One way to assist with the fact collection is to install a blueprint automation that will log states from the selected sensor with some additional information to the Home Assistant log. Create one automation for each sensor you want to monitor

The blueprint can be found here https://gist.github.com/astrandb/5ec47d6979b590639d23144142ae3100

Disclaimer

The package and its author are not affiliated with Miele. Use at your own risk.

License

The package is released under the MIT license.

vk496/miele