python-bsblan 4.2.0__tar.gz → 5.0.0__tar.gz

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/.github/copilot-instructions.md

@@ -16,15 +16,14 @@ This repository contains the `python-bsblan` library, an asynchronous Python cli
 Always run these commands after making changes:
 
 ```bash
-# Run all pre-commit hooks (ruff, mypy, pylint, pytest)
-uv run pre-commit run --all-files
+# Run all prek hooks (ruff, mypy, pylint)
+uv run prek run --all-files
 ```
 
-### Pre-commit Includes
+### Prek Includes
 - **Ruff**: Linting and formatting (88 char line limit)
 - **MyPy**: Static type checking
 - **Pylint**: Code analysis
-- **Pytest**: Test execution with coverage
 
 ### Coverage Requirements
 - Maintain **95%+ total test coverage**
@@ -77,9 +76,8 @@ Parameters are identified by numeric IDs and mapped to readable names in `consta
 
 2. **Add to model in `models.py`**:
    ```python
-   @dataclass
-   class HotWaterConfig(DataClassORJSONMixin):
-       legionella_function_setpoint: ParameterValue | None = None
+   class HotWaterConfig(BaseModel):
+       legionella_function_setpoint: EntityInfo[float] | None = None
    ```
 
 3. **Update method in `bsblan.py`** if the parameter is settable:
@@ -129,25 +127,23 @@ Defined in `constants.py`:
 ## Data Models
 
 ### Model Pattern
-All models use `mashumaro` for JSON serialization:
+All models use `pydantic` `BaseModel` for validation and serialization:
 
 ```python
-from dataclasses import dataclass
-from mashumaro.mixins.orjson import DataClassORJSONMixin
+from pydantic import BaseModel
 
-@dataclass
-class HotWaterConfig(DataClassORJSONMixin):
+class HotWaterConfig(BaseModel):
     """Hot water configuration parameters."""
-    operating_mode: ParameterValue | None = None
-    nominal_setpoint: ParameterValue | None = None
+    operating_mode: EntityInfo[int] | None = None
+    nominal_setpoint: EntityInfo[float] | None = None
 ```
 
-### ParameterValue Structure
-Each parameter returns a `ParameterValue` with:
-- `value`: The actual value
+### EntityInfo Structure
+Each parameter returns an `EntityInfo[T]` (generic `BaseModel`) with:
+- `value`: The actual value (typed via generic `T`)
 - `unit`: Unit of measurement
 - `desc`: Human-readable description
-- `dataType`: Data type information
+- `data_type`: Data type information
 
 ## Async Patterns
 
@@ -223,7 +219,7 @@ Test fixtures (JSON responses) are in `tests/fixtures/`
 4. Update docstring with parameter description
 5. Add state preparation logic in `_prepare_*_state()` method
 6. Add tests for the new parameter
-7. Run `uv run pre-commit run --all-files`
+7. Run `uv run prek run --all-files`
 
 ### Renaming a Parameter
 
@@ -233,7 +229,7 @@ When renaming parameters for consistency:
 3. Update `bsblan.py` - method parameters and state handling
 4. Update `tests/` - all test files using the parameter
 5. Update `examples/` - any example code
-6. Run `uv run pre-commit run --all-files`
+6. Run `uv run prek run --all-files`
 
 ## API Versions
 
@@ -245,7 +241,7 @@ Version-specific parameters are handled in `constants.py` with extension diction
 
 ## Don't Forget
 
-- ✅ Run `uv run pre-commit run --all-files` after every change
+- ✅ Run `uv run prek run --all-files` after every change
 - ✅ Maintain 95%+ test coverage
 - ✅ Use type hints on all functions
 - ✅ Add docstrings to public methods

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/.github/prompts/add-parameter.prompt.md

@@ -26,7 +26,7 @@ Add a new parameter to the python-bsblan library following the established patte
 
 After changes, run:
 ```bash
-uv run pre-commit run --all-files
+uv run prek run --all-files
 ```
 
 Coverage must be 95%+ total and 100% for new code.

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/.github/prompts/code-review.prompt.md

@@ -21,12 +21,12 @@ Review the changes against the python-bsblan coding standards.
 - [ ] Patch coverage 100%
 
 ### Patterns
-- [ ] Uses `mashumaro` for JSON serialization
+- [ ] Uses `pydantic` `BaseModel` for validation and serialization
 - [ ] Uses `aiohttp` for async HTTP
 - [ ] Follows existing parameter naming conventions
 - [ ] Error handling uses custom exceptions (`BSBLANError`, `BSBLANConnectionError`)
 
-### Pre-commit
+### Prek
 - [ ] Ruff passes (linting + formatting)
 - [ ] MyPy passes (type checking)
 - [ ] Pylint passes (code analysis)
@@ -35,6 +35,6 @@ Review the changes against the python-bsblan coding standards.
 ## Run Validation
 
 ```bash
-uv run pre-commit run --all-files
+uv run prek run --all-files
 uv run pytest --cov=src/bsblan --cov-report=term-missing
 ```

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/.github/skills/bsblan-parameters/SKILL.md

@@ -28,12 +28,11 @@ BASE_HOT_WATER_PARAMS: Final[dict[str, str]] = {
 
 ### 2. Add to Model in `models.py`
 
-Add the field to the appropriate dataclass:
+Add the field to the appropriate model:
 
 ```python
-@dataclass
-class HotWaterConfig(DataClassORJSONMixin):
-    legionella_function_setpoint: ParameterValue | None = None
+class HotWaterConfig(BaseModel):
+    legionella_function_setpoint: EntityInfo[float] | None = None
 ```
 
 ### 3. Update Method in `bsblan.py` (if settable)
@@ -100,7 +99,7 @@ When adding new sections or groups, the lock is created automatically on first a
 Always run after changes:
 
 ```bash
-uv run pre-commit run --all-files
+uv run prek run --all-files
 uv run pytest --cov=src/bsblan --cov-report=term-missing
 ```
 

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/.github/skills/bsblan-testing/SKILL.md

@@ -101,12 +101,12 @@ uv run pytest -v
 uv run pytest tests/test_bsblan.py::test_function_name
 ```
 
-## Pre-commit Hooks
+## Prek Hooks
 
 Always run before committing:
 
 ```bash
-uv run pre-commit run --all-files
+uv run prek run --all-files
 ```
 
 This runs:
@@ -114,7 +114,6 @@ This runs:
 - **Ruff**: Linting and formatting (88 char line limit)
 - **MyPy**: Static type checking
 - **Pylint**: Code analysis
-- **Pytest**: Test execution with coverage
 
 ## Mock Patterns
 

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/.github/workflows/codeql.yaml

@@ -24,6 +24,6 @@ jobs:
       - name: ⤵️ Check out code from GitHub
         uses: actions/checkout@v6.0.2
       - name: 🏗 Initialize CodeQL
-        uses: github/codeql-action/init@v4.32.2
+        uses: github/codeql-action/init@v4.32.4
       - name: 🚀 Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v4.32.2
+        uses: github/codeql-action/analyze@v4.32.4

python_bsblan-5.0.0/.github/workflows/linting.yaml

@@ -0,0 +1,66 @@
+---
+name: Linting
+
+# yamllint disable-line rule:truthy
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  DEFAULT_PYTHON: "3.13"
+
+jobs:
+  lint:
+    name: Prek hooks
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v6.0.2
+      - name: 🏗 Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+      - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
+        id: python
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+      - name: 🏗 Install Python dependencies
+        run: uv sync --dev
+      - name: 🚀 Run all prek hooks
+        env:
+          SKIP: no-commit-to-branch
+        run: uv run prek run --all-files
+
+  prettier:
+    name: Prettier
+    runs-on: ubuntu-latest
+    steps:
+      - name: ⤵️ Check out code from GitHub
+        uses: actions/checkout@v6.0.2
+      - name: 🏗 Set up uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+      - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
+        id: python
+        uses: actions/setup-python@v6.2.0
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+      - name: 🏗 Install Python dependencies
+        run: uv sync --dev
+      - name: 🏗 Set up Node.js
+        uses: actions/setup-node@v6.2.0
+        with:
+          node-version-file: ".nvmrc"
+          cache: "npm"
+      - name: 🏗 Install NPM dependencies
+        run: npm install
+      - name: 🚀 Run prettier
+        run: uv run prek run prettier --all-files

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/.github/workflows/stale.yaml

@@ -17,7 +17,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 🚀 Run stale
-        uses: actions/stale@v10.1.1
+        uses: actions/stale@v10.2.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
           days-before-stale: 30

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/.pre-commit-config.yaml

@@ -109,12 +109,6 @@ repos:
         language: system
         types: [python]
         entry: uv run pylint --exit-zero
-      - id: pytest
-        name: 🧪 Running tests and test coverage with pytest
-        language: system
-        types: [python]
-        entry: uv run pytest
-        pass_filenames: false
       - id: trailing-whitespace
         name: ✄  Trim Trailing Whitespace
         language: system

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-bsblan
-Version: 4.2.0
+Version: 5.0.0
 Summary: Asynchronous Python client for BSBLAN API
 Project-URL: Homepage, https://github.com/liudger/python-bsblan
 Project-URL: Repository, https://github.com/liudger/python-bsblan
@@ -25,9 +25,8 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.12
 Requires-Dist: aiohttp>=3.8.1
 Requires-Dist: backoff>=2.2.1
-Requires-Dist: mashumaro>=3.13.1
-Requires-Dist: orjson>=3.9.10
 Requires-Dist: packaging>=21.3
+Requires-Dist: pydantic>=2.0
 Requires-Dist: yarl>=1.7.2
 Description-Content-Type: text/markdown
 
@@ -186,12 +185,12 @@ npm install
 uv sync --dev
 ```
 
-As this repository uses the [pre-commit][pre-commit] framework, all changes
-are linted and tested with each commit. You can run all checks and tests
-manually, using the following command:
+As this repository uses [prek][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:
 
 ```bash
-uv run pre-commit run --all-files
+uv run prek run --all-files
 ```
 
 To run just the Python tests:
@@ -247,7 +246,7 @@ SOFTWARE.
 [maintenance-shield]: https://img.shields.io/maintenance/yes/2026.svg
 [uv]: https://docs.astral.sh/uv/
 [uv-install]: https://docs.astral.sh/uv/getting-started/installation/
-[pre-commit]: https://pre-commit.com/
+[prek]: https://github.com/j178/prek
 [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
 [pypi]: https://pypi.org/project/python-bsblan/
 [python-versions-shield]: https://img.shields.io/pypi/pyversions/python-bsblan

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/README.md

@@ -153,12 +153,12 @@ npm install
 uv sync --dev
 ```
 
-As this repository uses the [pre-commit][pre-commit] framework, all changes
-are linted and tested with each commit. You can run all checks and tests
-manually, using the following command:
+As this repository uses [prek][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:
 
 ```bash
-uv run pre-commit run --all-files
+uv run prek run --all-files
 ```
 
 To run just the Python tests:
@@ -214,7 +214,7 @@ SOFTWARE.
 [maintenance-shield]: https://img.shields.io/maintenance/yes/2026.svg
 [uv]: https://docs.astral.sh/uv/
 [uv-install]: https://docs.astral.sh/uv/getting-started/installation/
-[pre-commit]: https://pre-commit.com/
+[prek]: https://github.com/j178/prek
 [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
 [pypi]: https://pypi.org/project/python-bsblan/
 [python-versions-shield]: https://img.shields.io/pypi/pyversions/python-bsblan

python_bsblan-5.0.0/examples/fetch_param.py

@@ -0,0 +1,67 @@
+"""Fetch one or more BSB-LAN parameters and print the raw API response.
+
+Usage:
+    export BSBLAN_HOST=10.0.2.60
+    export BSBLAN_PASSKEY=your_passkey  # if needed
+
+    # Single parameter
+    cd examples && python fetch_param.py 3113
+
+    # Multiple parameters
+    cd examples && python fetch_param.py 3113 8700 8740
+"""
+
+from __future__ import annotations
+
+import argparse
+import asyncio
+import json
+
+from bsblan import BSBLAN, BSBLANConfig
+from discovery import get_bsblan_host, get_config_from_env
+
+
+async def fetch_parameters(param_ids: list[str]) -> None:
+    """Fetch and print raw API response for the given parameter IDs.
+
+    Args:
+        param_ids: List of BSB-LAN parameter IDs to fetch.
+
+    """
+    host, port = await get_bsblan_host()
+    env = get_config_from_env()
+
+    config = BSBLANConfig(
+        host=host,
+        port=port,
+        passkey=str(env["passkey"]) if env.get("passkey") else None,
+        username=str(env["username"]) if env.get("username") else None,
+        password=str(env["password"]) if env.get("password") else None,
+    )
+
+    params_string = ",".join(param_ids)
+
+    async with BSBLAN(config) as client:
+        result = await client._request(  # noqa: SLF001
+            params={"Parameter": params_string},
+        )
+        print(f"Raw API response for parameter(s) {params_string}:")
+        print(json.dumps(result, indent=2, ensure_ascii=False))
+
+
+def main() -> None:
+    """Parse arguments and run the fetch."""
+    parser = argparse.ArgumentParser(
+        description="Fetch BSB-LAN parameters and print raw JSON response.",
+    )
+    parser.add_argument(
+        "params",
+        nargs="+",
+        help="One or more BSB-LAN parameter IDs (e.g. 3113 8700)",
+    )
+    args = parser.parse_args()
+    asyncio.run(fetch_parameters(args.params))
+
+
+if __name__ == "__main__":
+    main()

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-bsblan"
-version = "4.2.0"
+version = "5.0.0"
 description = "Asynchronous Python client for BSBLAN API"
 authors = [
     {name = "Willem-Jan van Rootselaar", email = "liudgervr@gmail.com"}
@@ -29,8 +29,7 @@ dependencies = [
     "yarl>=1.7.2",
     "packaging>=21.3",
     "backoff>=2.2.1",
-    "mashumaro>=3.13.1",
-    "orjson>=3.9.10",
+    "pydantic>=2.0",
 ]
 
 [project.urls]
@@ -148,7 +147,7 @@ ignore = [
   "D213", # Conflicts with other rules
   "D417", # False positives in some occasions
   "PLR2004", # Just annoying, not really useful
-
+  "UP046", # Pydantic v2 does not support PEP 695 type parameter syntax
   # Conflicts with the Ruff formatter
   "COM812",
   "ISC001",
@@ -162,7 +161,7 @@ fixture-parentheses = false
 known-first-party = ["bsblan"]
 
 [tool.ruff.lint.flake8-type-checking]
-runtime-evaluated-base-classes = ["mashumaro.mixins.orjson.DataClassORJSONMixin"]
+runtime-evaluated-base-classes = ["pydantic.BaseModel"]
 
 [tool.ruff.lint.mccabe]
 max-complexity = 25
@@ -189,16 +188,16 @@ dev = [
     # hatch is required to support type hinting and proper packaging of the py.typed file.
     "hatch>=1.14.1",
     "isort==7.0.0",
-    "ty==0.0.16",
-    "pre-commit==4.5.1",
+    "ty==0.0.18",
+    "prek>=0.3.3",
     "pre-commit-hooks==6.0.0",
-    "pylint==4.0.4",
+    "pylint==4.0.5",
     "pytest>=8.3.5",
     "pytest-asyncio==1.3.0",
     "pytest-cov==7.0.0",
     "pytest-xdist>=3.8.0",
     "pyupgrade==3.21.2",
-    "ruff==0.15.0",
+    "ruff==0.15.2",
     "safety==3.7.0",
     "vulture==2.14",
     "yamllint==1.38.0",

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/src/bsblan/__init__.py

@@ -16,6 +16,7 @@ from .models import (
     DHWSchedule,
     DHWTimeSwitchPrograms,
     EntityInfo,
+    EntityValue,
     HotWaterConfig,
     HotWaterSchedule,
     HotWaterState,
@@ -41,6 +42,7 @@ __all__ = [
     "Device",
     "DeviceTime",
     "EntityInfo",
+    "EntityValue",
     "HVACActionCategory",
     "HeatingCircuitStatus",
     "HotWaterConfig",

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/src/bsblan/bsblan.py

@@ -524,8 +524,8 @@ class BSBLAN:
             try:
                 static_values = await self.static_values()
                 if static_values.min_temp is not None:
-                    self._min_temp = float(static_values.min_temp.value)
-                    logger.debug("Min temperature initialized: %f", self._min_temp)
+                    self._min_temp = static_values.min_temp.value
+                    logger.debug("Min temperature initialized: %s", self._min_temp)
                 else:
                     logger.warning(
                         "min_temp not available from device, "
@@ -533,8 +533,8 @@ class BSBLAN:
                     )
 
                 if static_values.max_temp is not None:
-                    self._max_temp = float(static_values.max_temp.value)
-                    logger.debug("Max temperature initialized: %f", self._max_temp)
+                    self._max_temp = static_values.max_temp.value
+                    logger.debug("Max temperature initialized: %s", self._max_temp)
                 else:
                     logger.warning(
                         "max_temp not available from device, "
@@ -841,7 +841,7 @@ class BSBLAN:
         params = await self._extract_params_summary(section_params)
         data = await self._request(params={"Parameter": params["string_par"]})
         data = dict(zip(params["list"], list(data.values()), strict=True))
-        return model_class.from_dict(data)
+        return model_class.model_validate(data)
 
     async def state(self, include: list[str] | None = None) -> State:
         """Get the current state from BSBLAN device.
@@ -911,7 +911,7 @@ class BSBLAN:
 
         """
         device_info = await self._request(base_path="/JI")
-        return Device.from_dict(device_info)
+        return Device.model_validate(device_info)
 
     async def info(self, include: list[str] | None = None) -> Info:
         """Get information about the current heating system config.
@@ -942,7 +942,7 @@ class BSBLAN:
         data = await self._request(params={"Parameter": "0"})
         # Create the data dictionary in the expected format
         time_data = {"time": data["0"]}
-        return DeviceTime.from_dict(time_data)
+        return DeviceTime.model_validate(time_data)
 
     async def set_time(self, time_value: str) -> None:
         """Set the time on the BSB-LAN device.
@@ -1146,7 +1146,7 @@ class BSBLAN:
         params = await self._extract_params_summary(filtered_params)
         data = await self._request(params={"Parameter": params["string_par"]})
         data = dict(zip(params["list"], list(data.values()), strict=True))
-        return model_class.from_dict(data)
+        return model_class.model_validate(data)
 
     async def hot_water_state(self, include: list[str] | None = None) -> HotWaterState:
         """Get essential hot water state for frequent polling.
@@ -1436,7 +1436,7 @@ class BSBLAN:
             if param_id in response_data:
                 param_data = response_data[param_id]
                 if param_data and isinstance(param_data, dict):
-                    result[param_id] = EntityInfo.from_dict(param_data)
+                    result[param_id] = EntityInfo.model_validate(param_data)
 
         return result
 

{python_bsblan-4.2.0 → python_bsblan-5.0.0}/src/bsblan/constants.py

@@ -41,6 +41,7 @@ BASE_DEVICE_PARAMS: Final[dict[str, str]] = {
 BASE_SENSOR_PARAMS: Final[dict[str, str]] = {
     "8700": "outside_temperature",
     "8740": "current_temperature",
+    "3113": "total_energy",
 }
 
 BASE_HOT_WATER_PARAMS: Final[dict[str, str]] = {