Skip to main content

Homematic interface for Home Assistant running on Python 3.

Project description

Release License Python GitHub Sponsors

aiohomematic

A modern, async Python library for controlling and monitoring Homematic and HomematicIP devices. Powers the Home Assistant integration "Homematic(IP) Local".

This project is the modern successor to pyhomematic, focusing on automatic entity creation, fewer manual device definitions, and faster startups.

Key Features

  • Automatic entity discovery from device/channel parameters
  • Extensible via custom entity classes for complex devices (thermostats, lights, covers, locks, sirens)
  • Fast startups through caching of paramsets
  • Robust operation with automatic reconnection after CCU restarts
  • Fully typed with strict mypy compliance
  • Async/await based on asyncio

Documentation

Full documentation: sukramj.github.io/aiohomematic

Section Description
Getting Started Installation and first steps
User Guide Home Assistant integration guide
Developer Guide API reference for integrations
Architecture System design overview
Glossary Terminology reference

How It Works

┌─────────────────────────────────────────────────────────┐
│                    Home Assistant                       │
│                                                         │
│  ┌────────────────────────────────────────────────────┐ │
│  │           Homematic(IP) Local Integration          │ │
│  │                                                    │ │
│  │  • Home Assistant entities (climate, light, etc.)  │ │
│  │  • UI configuration flows                          │ │
│  │  • Services and automations                        │ │
│  │  • Device/entity registry integration              │ │
│  └────────────────────────┬───────────────────────────┘ │
└───────────────────────────┼─────────────────────────────┘
                            │
                            │ uses
                            ▼
┌───────────────────────────────────────────────────────────┐
│                      aiohomematic                         │
│                                                           │
│  • Protocol implementation (XML-RPC, JSON-RPC)            │
│  • Device model and data point abstraction                │
│  • Connection management and reconnection                 │
│  • Event handling and callbacks                           │
│  • Caching for fast startups                              │
└───────────────────────────────────────────────────────────┘
                            │
                            │ communicates with
                            ▼
┌───────────────────────────────────────────────────────────┐
│              CCU3 / OpenCCU / Homegear                    │
└───────────────────────────────────────────────────────────┘

Why Two Projects?

Aspect aiohomematic Homematic(IP) Local
Purpose Python library for Homematic protocol Home Assistant integration
Scope Protocol, devices, data points HA entities, UI, services
Dependencies Standalone (aiohttp, orjson) Requires Home Assistant
Reusability Any Python project Home Assistant only
Repository aiohomematic homematicip_local

Benefits of this separation:

  • Reusability: aiohomematic can be used in any Python project, not just Home Assistant
  • Testability: The library can be tested independently without Home Assistant
  • Maintainability: Protocol changes don't affect HA-specific code and vice versa
  • Clear boundaries: Each project has a focused responsibility

How They Work Together

  1. Homematic(IP) Local creates a CentralUnit via aiohomematic's API
  2. aiohomematic connects to the CCU/Homegear and discovers devices
  3. aiohomematic creates Device, Channel, and DataPoint objects
  4. Homematic(IP) Local wraps these in Home Assistant entities
  5. aiohomematic receives events from the CCU and notifies subscribers
  6. Homematic(IP) Local translates events into Home Assistant state updates

For Home Assistant Users

Use the Home Assistant custom integration Homematic(IP) Local:

  1. Add the custom repository: https://github.com/sukramj/homematicip_local
  2. Install via HACS
  3. Configure via SettingsDevices & ServicesAdd Integration

See the Integration Guide for detailed instructions.

For Developers

pip install aiohomematic

Quick Start

from aiohomematic.central import CentralConfig
from aiohomematic.client import InterfaceConfig
from aiohomematic.const import Interface

config = CentralConfig(
    name="ccu-main",
    host="ccu.local",
    username="admin",
    password="secret",
    default_callback_port_xml_rpc=43439,
    interface_configs={
        InterfaceConfig(central_name="ccu-main", interface=Interface.HMIP_RF, port=2010)
    },
)

central = await config.create_central()
await central.start()

for device in central.devices:
    print(f"{device.name}: {device.address}")

await central.stop()

See Getting Started for more examples.

Requirements

  • Python: 3.14+
  • CCU Firmware: CCU2 ≥2.61.x, CCU3 ≥3.61.x
  • There is not active testing to identify the minimum required firmware versions.

Important Notes on Backend Support

Actively tested backends:

  • OpenCCU with current firmware

Not actively tested:

  • CCU2
  • Homegear

Running outdated firmware versions or using untested backends (CCU2, Homegear) is at your own risk.

Recommendation: Keep your CCU firmware up to date. Outdated versions may lack bug fixes, security patches, and compatibility improvements that this library depends on.

Related Projects

Project Description
Homematic(IP) Local Home Assistant integration
aiohomematic Documentation Full documentation

Contributing

Contributions are welcome! See the Contributing Guide for details.

License

MIT License - see LICENSE for details.

Support

GitHub Sponsors

If you find this project useful, consider sponsoring the development.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiohomematic-2026.4.16.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiohomematic-2026.4.16-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file aiohomematic-2026.4.16.tar.gz.

File metadata

  • Download URL: aiohomematic-2026.4.16.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for aiohomematic-2026.4.16.tar.gz
Algorithm Hash digest
SHA256 ee4884d9a62a00fe71ad7210e3cc31a1f4acc920b29ddcd16957f7c762681431
MD5 d916a8322dae39d0a2f73f2efcd2bf71
BLAKE2b-256 4c692b0b2de21a5bad8809327b503afc0e8e04ca2a78aa12fcc597e82756a091

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiohomematic-2026.4.16.tar.gz:

Publisher: python-publish.yml on SukramJ/aiohomematic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiohomematic-2026.4.16-py3-none-any.whl.

File metadata

File hashes

Hashes for aiohomematic-2026.4.16-py3-none-any.whl
Algorithm Hash digest
SHA256 776e30f6a413deae419f323316760d7e8b1ad95832b50c570bef5309a6d2bff9
MD5 930770c4b2a3e5b4bed23602c5db972a
BLAKE2b-256 d085eddeb7ff73bac7b3181692270cccb187a0c4c9863c027aece7a2d3bc8147

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiohomematic-2026.4.16-py3-none-any.whl:

Publisher: python-publish.yml on SukramJ/aiohomematic

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page