pyoverkiz

What it is and what it does

pyoverkiz is a fully asynchronous Python client for the OverKiz API, designed to control smart devices connected to OverKiz-compatible hubs. It abstracts the complexity of cloud and local API communication, supporting multiple vendors including Somfy (TaHoma, Connexoon), Atlantic Cozytouch, Rexel Energeasy Connect, and others. The package is built on aiohttp for async HTTP operations and uses attrs and cattrs for data modeling and serialization.

The client handles authentication (username/password or OAuth), device discovery, command execution, and event listening. It is primarily used by Home Assistant's Overkiz integration but can be used standalone for custom automation projects. The package requires Python 3.12+ and is actively maintained with no known security vulnerabilities.

Use it for:

• Build a Home Assistant custom component or integration to control Somfy TaHoma or Atlantic Cozytouch devices.
• Create a command-line tool or automation script to query and control OverKiz-compatible smart home devices.
• Bridge OverKiz devices to MQTT or other protocols for cross-platform home automation.
• Develop a local-first smart home controller using the local API for devices that support it.
• Monitor device state changes and react to events from OverKiz hubs in real-time.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

An asynchronous Python client for the OverKiz API that enables interaction with smart devices connected to OverKiz-compatible hubs from vendors like Somfy TaHoma and Atlantic Cozytouch.

Yes. The package is actively maintained, has no known vulnerabilities, low install friction, and a permissive MIT license. It is well-suited for anyone building Home Assistant integrations or custom automation around OverKiz-compatible smart home hubs. The requirement for Python 3.12+ is a minor constraint but reasonable for new projects.

Install

pyoverkiz on PyPI

pip install pyoverkiz

uv add pyoverkiz

poetry add pyoverkiz

Installing pyoverkiz

Before you install

Low install friction with a pure-Python wheel and four lightweight runtime dependencies (aiohttp, attrs, backoff, cattrs). Actively maintained with a release within the last 2 days and no known vulnerabilities.

License in practice

MIT license permits free use, modification, and distribution with minimal restrictions—suitable for both open-source and commercial projects.

Quickstart

pip install pyoverkiz

import asyncio
from pyoverkiz.auth.credentials import UsernamePasswordCredentials
from pyoverkiz.client import OverkizClient
from pyoverkiz.enums import Server

async def main():
    async with OverkizClient(
        server=Server.SOMFY_EUROPE,
        credentials=UsernamePasswordCredentials("username", "password"),
    ) as client:
        await client.login()
        devices = await client.get_devices()
        for device in devices:
            print(f"{device.label} - {device.controllable_name}")

asyncio.run(main())

Requires Python 3.12 or later; OverKiz account credentials and network access to OverKiz servers or a local gateway.

Verify before relying

• Whether local API support is available for all listed vendors or only specific gateway models.
• Performance characteristics when managing large numbers of devices or frequent command execution.
• Real-world latency and reliability of cloud vs. local API connections.

Package facts

Evidence: pyoverkiz-2.1.1-py3-none-any.whl

Tags

More Internet packages