Pre-release

This release is a pre-release and may not be stable for production use.

Latest Tag PyPI Version Python Versions License CI Status Codecov CodeQL Status OpenSSF Best Practices OpenSSF Baseline Docs Status Documentation Renovate Code Style: Ruff Type Checked: mypy Security: Bandit Release Status Last Commit Repo Size PyPI Downloads

Status: Stable | 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 py-bragerone

Pre-release (PyPI, exact pin):

pip install "py-bragerone==2026.8.9rc1"

Optional extras:

pip install "py-bragerone[cli]"      # CLI with typer, rich, aiofiles
pip install "py-bragerone[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 (the password is prompted securely when omitted):

pybragerone-cli --email YOU@example.com

Select platform (useful for TiSConnect installations):

pybragerone-cli --platform tisconnect --email YOU@example.com

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", "user@example.com")
    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.

This project uses property-based testing (Hypothesis) and an optional Atheris fuzz harness under fuzz/ for parser resilience.

Project links

Data verified by PyPI on Sep 10, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2026.9.2)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for marpi82 from gravatar.com marpi82

Credits

Author/Maintainer: MarPi82

GitHub Statistics

Data verified by PyPI on Sep 10, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python <3.15, >=3.13.2

Provides Extra

cli keyring

Tags

automation brager bragerone home home-assistant httpx pydantic socket.io websocket

Classifiers

Report project as malware

Download files

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

Source Distribution

py_bragerone-2026.9.2rc4.tar.gz (146.2 kB view details)

Uploaded Source

Built Distribution

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

py_bragerone-2026.9.2rc4-py3-none-any.whl (158.0 kB view details)

Uploaded Python 3

File details

Details for the file py_bragerone-2026.9.2rc4.tar.gz.

File metadata

  • Download URL: py_bragerone-2026.9.2rc4.tar.gz
  • Upload date:
  • Size: 146.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for py_bragerone-2026.9.2rc4.tar.gz
Algorithm Hash digest
SHA256 97a4931c789344ab7ff4745e588ec691b620302fa05f0e346ba0d52c0f275193
MD5 4ee268358710f797895f3f8fe7cd1c60
BLAKE2b-256 81a2c69ceafe37b974c1fa4116d6a5f3ee43d2e44158126cf220a31b07364fad

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_bragerone-2026.9.2rc4.tar.gz:

Publisher: release.yml on marpi82/py-bragerone

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

File details

Details for the file py_bragerone-2026.9.2rc4-py3-none-any.whl.

File metadata

File hashes

Hashes for py_bragerone-2026.9.2rc4-py3-none-any.whl
Algorithm Hash digest
SHA256 2468bbf0f34fd691b1a8b510c9a450b1575c096401d63667446cd95f6903a7c6
MD5 a0a90ff8e958b299e8a3cdc41b23b03f
BLAKE2b-256 b941d55aaef2abfaf5f0a01a869f80b112ccdad774d8dc2ddd8ee3a75bc43176

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_bragerone-2026.9.2rc4-py3-none-any.whl:

Publisher: release.yml on marpi82/py-bragerone

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page