Skip to main content

dorfwash

PyPI License

dorfwash lets you monitor your Miele washing machines via the Miele Professional IP Profile API.

dorfwash uses washpy to communicate with the Miele washing machines.

Usage

There are multiple options on how to run dorfwash.

poetry

run

poetry run python dorfwash config.json

See config.json for an example configuration.

Device Setup

If you have a new washing machine and want to set it up for use with dorfwash, you can use the setup_new_device.py:

poetry run python setup_new_device.py

The script will discover a device URL four you, given that you provide it with an IP address or a hostname of the washing machine / XKM module. Use that device URL in the config.json.

Note: You will need to discover the IP address or hostname of the machine on your own. I found arp-scan to be a helpful tool for that.

Then, the script will initialize the admin user. You have to choose an admin password. Then, it will set up a non-admin user with a name and password of you liking.

Be aware, that the Miele IP Profile API may require you to choose a strong enough password (e.g. at least 8 characters, use of upper case, lower case, digits, special characters).

docker

dorfwash provides a small Dockerfile, so you can build your own dorfwash docker container.

docker build -t dorfwash .

You need to mount a valid config.json file at /config/config.json in the container to run it.

Also, in docker-compose is an example docker-compose.yml. This way, you can just run

docker compose up

to build, mount the config, and run the server.

Miele IP Profie API

For further information see washpy

Release files for dorfwash 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dorfwash 0.3.0
File Size Uploaded
dorfwash-0.3.0.tar.gz 17.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for dorfwash 0.3.0
File Interpreter ABI Platform
dorfwash-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 35.7 kB

Release files / dorfwash-0.3.0.tar.gz

Download URL dorfwash-0.3.0.tar.gz
Size 17.4 kB
Tags Source
SHA-256 checksum
How to use checksums
71449cccdd662f8075235b1a231082007215f52f20787da57fbc20404609ccf7
BLAKE2b-256 checksum
How to use checksums
2f21d56fc24137d09f7d687be6b93241aaa5308a89ef25f2691fea99cb46398b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.4 CPython/3.12.7 Linux/6.11.5-arch1-1

Release files / dorfwash-0.3.0-py3-none-any.whl

Download URL dorfwash-0.3.0-py3-none-any.whl
Size 18.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ecc5d047b663482b54653e937d4edd5f9af075297471606cdd383eb4ecb7ed48
BLAKE2b-256 checksum
How to use checksums
69c5c995c3195b04d61a9c69047d5b41a63da1049956f3ec62f36316af3299ed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.4 CPython/3.12.7 Linux/6.11.5-arch1-1

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.0

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page