Python: BSBLan API Client

Project Stage Project Maintenance

Asynchronous Python client for BSBLan.

About

This package allows you to control and monitor a BSBLan device programmatically. It is mainly created to allow third-party programs to automate the behavior of BSBLan.

Full documentation

Installation

pip install python-bsblan

Quick start

import asyncio
from bsblan import BSBLAN, BSBLANConfig

async def main() -> None:
    config = BSBLANConfig(host="192.168.1.100")
    async with BSBLAN(config) as client:
        # Read current state
        state = await client.state()
        print(f"Current temperature: {state.current_temperature.value}")

        # Set thermostat temperature
        await client.thermostat(target_temperature="21.5")

asyncio.run(main())

For more examples, including hot water control, multi-circuit support, and authentication setup, see the Getting Started guide.

Compatibility

The client automatically detects the device's capabilities during initialize() and selects a matching configuration based on the BSB-LAN JSON-API version reported by the /JV endpoint:

Full configuration — JSON-API version 2.0 or newer. All features are available: multiple heating circuits, hot water control, schedules, sensors, and cooling setpoints and operating mode.
Basic configuration — JSON-API version 1.x. A reduced, single-circuit configuration covering essential heating, hot water, and sensor parameters.

The JSON-API version is the documented, firmware-independent compatibility signal. The adapter firmware version (from /JI) is still retrieved and exposed via device_info, but it is not used to determine support. A device that does not expose /JV, or reports a JSON-API version below 1.0, is not supported and raises BSBLANVersionError during initialize().

Note: basic (JSON-API 1.x) support is best-effort and may not cover every parameter your heating system exposes.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

MAJOR: Incompatible or major changes.
MINOR: Backwards-compatible new features and enhancements.
PATCH: Backwards-compatible bugfixes and package updates.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! :heart_eyes:

Setting up development environment

This Python project is fully managed using the uv dependency manager. But also relies on the use of NodeJS for certain checks during development.

You need at least:

Python 3.12+
uv
NodeJS 22.14.0+ (including NPM)

To install all packages, including all development requirements:

npm install
make setup

Makefile Targets

A Makefile is provided for common development tasks. Run make help to see all available targets:

Command	Description
`make setup`	Install dev dependencies & git hooks
`make lint`	Run all pre-commit hooks
`make test`	Run tests
`make coverage`	Run tests with coverage report
`make docs`	Build documentation
`make docs-serve`	Serve documentation locally

As this repository uses prek (a faster, Rust-based drop-in replacement for pre-commit), all changes are linted and tested with each commit. You can run all checks and tests manually, using the following command:

uv run prek run --all-files

To run just the Python tests:

uv run pytest

Authors & contributors

The template is from the repository 'elgato' by Franck Nijhof. The setup of this repository is by Willem-Jan van Rootselaar.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Metadata

Release files for python-bsblan 6.1.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-bsblan 6.1.8
File	Size	Uploaded
python_bsblan-6.1.8.tar.gz	177.7 kB	Aug 5, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for python-bsblan 6.1.8
File	Interpreter	ABI	Platform	Reset
python_bsblan-6.1.8-py3-none-any.whl 51.5 kB Aug 5, 2026	Python 3	none	any	Details

Total release size: 229.2 kB

Release files / python_bsblan-6.1.8.tar.gz

Download URL	python_bsblan-6.1.8.tar.gz
Size	177.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`50a46a5bf1732d94a82e0c993b79fdd0be0ebcbea9063862ad0c01b2a052cebf`
BLAKE2b-256 checksum How to use checksums	`3cfc3076684ecce9946894e388997d75cd3dc3101873043dda5c90210940194a`
Upload date	Aug 5, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/liudger/python-bsblan
Publishing commit: github.com/liudger/python-bsblan/tree/e76d1a3fe2c1261f61ae40dc865f0f27d3842b1f

Workflow

Publishing configuration: github.com/liudger/python-bsblan/blob/e76d1a3fe2c1261f61ae40dc865f0f27d3842b1f/.github/workflows/release.yaml
Publishing logs: github.com/liudger/python-bsblan/actions/runs/30999932256/attempts/1

Artifact

Subject: python_bsblan-6.1.8.tar.gz
SHA-256 checksum: 50a46a5bf1732d94a82e0c993b79fdd0be0ebcbea9063862ad0c01b2a052cebf Verifying attestations

Release files / python_bsblan-6.1.8-py3-none-any.whl

Download URL	python_bsblan-6.1.8-py3-none-any.whl
Size	51.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`484316bdee44c2c1d5b87ba2df28e2c6ae613c786058bc3247c59fe10984be9c`
BLAKE2b-256 checksum How to use checksums	`251ee0d2bcc1a67fc77ecebe5595f0c2cfe4b0e80041227a3d6cc11ba9ffd585`
Upload date	Aug 5, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/liudger/python-bsblan
Publishing commit: github.com/liudger/python-bsblan/tree/e76d1a3fe2c1261f61ae40dc865f0f27d3842b1f

Workflow

Publishing configuration: github.com/liudger/python-bsblan/blob/e76d1a3fe2c1261f61ae40dc865f0f27d3842b1f/.github/workflows/release.yaml
Publishing logs: github.com/liudger/python-bsblan/actions/runs/30999932256/attempts/1

Artifact

Subject: python_bsblan-6.1.8-py3-none-any.whl
SHA-256 checksum: 484316bdee44c2c1d5b87ba2df28e2c6ae613c786058bc3247c59fe10984be9c Verifying attestations