Asynchronous Python client for BSBLan.
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.
pip install python-bsblanimport 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.
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.
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! 😍
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 setupA 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-filesTo run just the Python tests:
uv run pytestThe 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.
MIT License
Copyright (c) 2023-2026 WJ van Rootselaar
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.
