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". Some third-party devices/gateways (e.g., Bosch, Intertechno) may be supported as well.

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

How It Works

Unlike pyhomematic, which required manual device mappings, aiohomematic automatically creates entities for each relevant parameter on every device channel (unless blacklisted). To achieve this it:

  • Fetches and caches device paramsets (VALUES) for fast successive startups
  • Provides hooks for custom entity classes where complex behavior is needed
  • Includes helpers for robust operation, such as automatic reconnection after CCU restarts

Requirements

Python

  • Python 3.13 or higher

CCU Firmware

Due to a bug in earlier CCU2/CCU3 firmware, aiohomematic requires at least the following versions when used with HomematicIP devices:

Platform Minimum Version
CCU2 2.53.27
CCU3 3.53.26

See details: OpenCCU Issue #843

Installation

For Home Assistant Users

Use the Home Assistant custom integration "Homematic(IP) Local", which is powered by aiohomematic:

  1. Prerequisites

    • Latest version of Home Assistant
    • A CCU3, OpenCCU, or Homegear instance reachable from Home Assistant
    • For HomematicIP devices, ensure CCU firmware meets the minimum versions listed above
  2. Install the integration

  3. Configure via Home Assistant UI

    • Settings → Devices & Services → Add Integration → "Homematic(IP) Local"
    • Enter CCU/Homegear host (IP or hostname)
    • Enable TLS if using HTTPS (skip verification for self-signed certificates)
    • Enter credentials
    • Choose interfaces: HM (2001), HmIP (2010), Virtual (9292)
  4. Network callbacks

    • Ensure Home Assistant is reachable from the CCU (no NAT/firewall blocking)

New to Homematic? See the Glossary for definitions of terms like Backend, Interface, Device, Channel.

For Developers

pip install aiohomematic

Or install from source:

git clone https://github.com/sukramj/aiohomematic.git
cd aiohomematic
pip install -r requirements.txt

Quick Start

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

config = CentralConfig(
    central_id="ccu-main",
    host="ccu.local",
    username="admin",
    password="secret",
    default_callback_port=43439,
    interface_configs={
        InterfaceConfig(interface=Interface.HMIP, port=2010, enabled=True)
    },
)

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

# Access devices
for device in central.devices:
    print(f"{device.name}: {device.device_address}")

await central.stop()

Public API

The public API is explicitly defined via __all__ in each module:

Module Contents
aiohomematic.central CentralUnit, CentralConfig and related schemas
aiohomematic.client Client, InterfaceConfig, Interface
aiohomematic.model Device/channel/data point abstractions
aiohomematic.exceptions Library exception types
aiohomematic.const Constants and enums

Import from specific submodules for stable imports:

from aiohomematic.central import CentralConfig, CentralUnit
from aiohomematic.client import InterfaceConfig, Interface
from aiohomematic.exceptions import ClientException

Documentation

For Users

For Developers

Contributing

Contributions are welcome! Please read our Contributing Guide for details on:

  • Development environment setup
  • Code standards and type annotations
  • Pull request process
  • Testing guidelines

See CLAUDE.md for comprehensive development guidelines.

Related Projects

License

This project is licensed under the MIT License - see the LICENSE file 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.1.7.tar.gz (454.5 kB view details)

Uploaded Source

Built Distribution

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

aiohomematic-2026.1.7-py3-none-any.whl (545.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiohomematic-2026.1.7.tar.gz
  • Upload date:
  • Size: 454.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aiohomematic-2026.1.7.tar.gz
Algorithm Hash digest
SHA256 216e3aa6df9f27cc5076993e85162da7206ae0cce118a5fa7f9408f588f9efa7
MD5 c5fcdf3e014f6fd4022d235a07e83a0c
BLAKE2b-256 baeb2776f46fa3be1109782c4757da167879bd39ef1bdccaadca47685b8754da

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiohomematic-2026.1.7.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.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for aiohomematic-2026.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 c6d0602795af7daaf5dd5ff8b721fa12102b3fc2adb75895b7f53942102c174d
MD5 b7718048d0e9e70f776af5de986441ca
BLAKE2b-256 1f29210bcd0224255da753bd6f24e93cd4fc4befaeb2cfb5d39c795adaf93655

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiohomematic-2026.1.7-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