HomeConnect Websocket
Control HomeConnect Appliances through a local Websocket connection.
Authentication and Device Description
To connect to an Appliance, you need its encryption keys and the description of its features and options. The Appliance uses either TLS PSK or AES encryption, AES requiring an additional Initialization Vector (IV). Both Key and IV are send to Home Connect cloud servers on setup. To get the keys and description from the cloud use the Home Connect Profile Downloader tool.
For each registered Appliance, the downloaded zip-file contains three files named with the Appliance serial number:
[serialNumber].json: Contains information about the Appliance including encryption keys. TheconnectionTypefield indicates if the Appliance uses PSK or AES encryption. When the connection type is "AES" the Appliance uses AES Encryption and requires the IV.[serialNumber]_DeviceDescription.xmland[serialNumber]_FeatureMapping.xml: Contains the Device Description, see below
Parsing Device Description
import json
from pathlib import Path
from homeconnect_websocket import parse_device_description
# Load Description from File
with Path("[serialNumber]_DeviceDescription.xml").open() as file:
DeviceDescription = file.read()
with Path("[serialNumber]_FeatureMapping.xml").open() as file:
FeatureMapping = file.read()
description = parse_device_description(DeviceDescription, FeatureMapping)
# Save Description to File for later use
with Path("DeviceDescription.json").open(mode='w') as file:
json.dump(description, file)
Its best to save the parsed description as a json File to reuse later.
Connecting
import asyncio
import json
from homeconnect_websocket import DeviceDescription, HomeAppliance
async def main(description: DeviceDescription) -> None:
app_name = "Example App" # Name of your App, can be anything
app_id = "d50661eca7e45a" # ID of your App, can be anything
psk64 = "whZJhkPa3a1hkuDdI3twHdqi1qhTxjnKE8954_zyY_E=" # PSK Key
# iv64 = "ofi7M1WB98sJeM2H1Ew3XA==" # IV for Appliances with AES Encryption
appliance = HomeAppliance(
description,
"192.168.1.2",
app_name,
app_id,
psk64=psk64,
# iv64=iv64
)
# Connect to Appliances
await appliance.connect()
# Set PowerState to On
await appliance.settings["BSH.Common.Setting.PowerState"].set_value("On")
if __name__ == "__main__":
# Load DeviceDescription from File
with open("DeviceDescription.json", "r") as f:
description = json.load(f)
asyncio.run(main(description))
1 maintainer
Release files for homeconnect-websocket 1.5.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| homeconnect_websocket-1.5.4.tar.gz | 31.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| homeconnect_websocket-1.5.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 59.1 kB
Release files / homeconnect_websocket-1.5.4.tar.gz
| Download URL | homeconnect_websocket-1.5.4.tar.gz |
|---|---|
| Size | 31.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
34174355c20327e0173c6db7057e4a9e0939e0c45e3d537f2e19cf389f78f223
|
|
BLAKE2b-256 checksum How to use checksums |
eb1c07644136d9d7db5c47ff06f2637b930479074b1d2d89c5db3a76458b56be
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 24, 2026.
Transparency logRelease files / homeconnect_websocket-1.5.4-py3-none-any.whl
| Download URL | homeconnect_websocket-1.5.4-py3-none-any.whl |
|---|---|
| Size | 28.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ac5e599f66537458b4d92c1dcc85382ce757e60d884e545be56617e6439a25a1
|
|
BLAKE2b-256 checksum How to use checksums |
3bdd9ce23057a2721de96f4e69415af976bd9fba1bc267a75e2356cbca633f39
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 24, 2026.
Transparency log
