Kerbl IoT

Async Python client for Kerbl IoT devices.

KerblIOTApi owns authentication, HTTP, token refresh, and Socket.IO transport. KerblIOT loads devices and dispatches their live updates. Device actions belong to their respective model classes.

import asyncio
import os

from kerbl_iot import KerblIOT, KerblIOTApi


async def main() -> None:
    async with KerblIOT(
        KerblIOTApi(
        email=os.environ["KERBL_EMAIL"],
        password=os.environ["KERBL_PASSWORD"],
        )
    ) as kerbl:
        await kerbl.connect_websocket()

        coop = kerbl.smart_coops[0]
        print(coop.name, coop.air_temperature, coop.door.state)
        await coop.light.turn_on()
        await coop.door.close()


asyncio.run(main())

Releasing to PyPI

Releases are published automatically by GitHub Actions when a GitHub Release is marked as published. Before the first release, configure PyPI Trusted Publishing for the derjoerg/kerbl-iot repository and the .github/workflows/publish.yml workflow, using the pypi environment.

To create a release, update the version in pyproject.toml, commit the change, create a matching tag such as v0.1.1, and publish a GitHub Release for that tag. The version must not already exist on PyPI.

Error reason reference

SmartCoopLog exposes the API's raw error_key and error_code. Applications should translate the key in their own presentation layer. The following table preserves the German translations previously included in this library for reference: