py-bragerone 2026.4.1

Async client for BragerOne: REST + Socket.IO, EventBus, ParamStore (dual-mode), HA-ready

---

Status: Alpha | Python 3.13.2+ required

Python library for integrating with BragerOne-compatible cloud and realtime APIs.

Supported platforms:

• BragerOne (default): one.brager.pl / io.brager.pl

• TiSConnect: www.tisconnect.info / io.tisconnect.info

Features: - Async REST client (httpx, not aiohttp) - Realtime updates (python-socketio, namespace /ws) - Event bus for updates - ParamStore (lightweight, key→value with optional rich metadata via LiveAssetsCatalog) - CLI for diagnostics - Home Assistant ready

Installation

Stable (PyPI):

pip install pybragerone

Pre-release (TestPyPI):

pip install -i https://test.pypi.org/simple/ pybragerone

Optional extras:

pip install "pybragerone[cli]"      # CLI with typer, rich, aiofiles
pip install "pybragerone[keyring]"  # Secure token storage with keyring

Development Dependencies

For building documentation with architectural diagrams:

# Ubuntu/Debian
sudo apt-get install graphviz

# macOS
brew install graphviz

# Windows (via Chocolatey)
choco install graphviz

CLI usage

Run the CLI for guided login and WS session:

pybragerone-cli --email [e-mail] --password "***"

Select platform (useful for TiSConnect installations):

pybragerone-cli --platform tisconnect --email [e-mail] --password "***"

Examples

Basic login and device listing

Minimal async example showing login and listing objects/modules:

import asyncio
import os
from pybragerone.api import BragerOneApiClient

async def main() -> None:
    email = os.getenv("PYBO_EMAIL", "[e-mail]")
    password = os.getenv("PYBO_PASSWORD", "password")
    client = BragerOneApiClient()
    try:
        print(f"Logging in as {email}...")
        await client.ensure_auth(email, password)
        print("✓ Login successful")

        objects = await client.get_objects()
        print(f"Found {len(objects)} heating system(s)")
        for obj in objects:
            print(f"- {obj.name} (id={obj.id})")
            modules = await client.get_modules(obj.id)
            for m in modules:
                devid = m.devid or f"id:{m.id}"
                version = m.moduleVersion or (m.gateway.version if m.gateway else "unknown")
                print(f"  • {m.name} (devid={devid}, version={version})")
    finally:
        await client.close()

if __name__ == "__main__":
    asyncio.run(main())

Real-time parameter monitoring

Subscribing to updates via BragerOneGateway and printing changes:

import asyncio
import os
from contextlib import suppress
from pybragerone import BragerOneGateway

async def main() -> None:
    email = os.getenv("PYBO_EMAIL")
    password = os.getenv("PYBO_PASSWORD")
    object_id = int(os.getenv("PYBO_OBJECT_ID", "0"))
    modules = [m.strip() for m in os.getenv("PYBO_MODULES", "").split(",") if m.strip()]

    if not (email and password and object_id and modules):
        print("Set PYBO_EMAIL, PYBO_PASSWORD, PYBO_OBJECT_ID, PYBO_MODULES")
        return

       gateway = await BragerOneGateway.from_credentials(
             email=email,
             password=password,
             object_id=object_id,
             modules=modules,
       )

    async def monitor() -> None:
        async for ev in gateway.bus.subscribe():
            if ev.value is None:
                continue
            key = f"{ev.pool}.{ev.chan}{ev.idx}"
            print(f"{ev.devid:12} {key:15} = {ev.value}")

      task: asyncio.Task[None] | None = None
      try:
         await gateway.start()
         task = asyncio.create_task(monitor())
         await asyncio.sleep(10)   # demo run
      finally:
         if task is not None:
            task.cancel()
            with suppress(asyncio.CancelledError):
               await task
         await gateway.stop()

if __name__ == "__main__":
    asyncio.run(main())

ParamStore lightweight mode

Attaching ParamStore to the EventBus and reading values:

import asyncio
import os
from contextlib import suppress
from pybragerone import BragerOneGateway
from pybragerone.models.param import ParamStore

async def main() -> None:
    email = os.getenv("PYBO_EMAIL")
    password = os.getenv("PYBO_PASSWORD")
    object_id = int(os.getenv("PYBO_OBJECT_ID", "0"))
    modules = [m.strip() for m in os.getenv("PYBO_MODULES", "").split(",") if m.strip()]

    if not (email and password and object_id and modules):
        print("Set PYBO_EMAIL, PYBO_PASSWORD, PYBO_OBJECT_ID, PYBO_MODULES")
        return

      gateway = await BragerOneGateway.from_credentials(
         email=email,
         password=password,
         object_id=object_id,
         modules=modules,
      )
    store = ParamStore()

    task = asyncio.create_task(store.run_with_bus(gateway.bus))
    try:
        await gateway.start()
        await asyncio.sleep(2)
        params = store.flatten()
        print(f"Total params: {len(params)}")
        for k, v in list(params.items())[:10]:
            print(f"{k:20} = {v}")
    finally:
        task.cancel()
        with suppress(asyncio.CancelledError):
            await task
        await gateway.stop()

if __name__ == "__main__":
    asyncio.run(main())

Documentation

Full documentation: https://marpi82.github.io/py-bragerone

Security

For information about security policies, vulnerability reporting, and known security exceptions, see SECURITY.md.