python-bsblan 2.2.5__tar.gz → 3.1.0__tar.gz

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/.github/workflows/codeql.yaml

@@ -17,8 +17,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Initialize CodeQL
-        uses: github/codeql-action/init@v3.28.19
+        uses: github/codeql-action/init@v3.30.3
       - name: 🚀 Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v3.28.19
+        uses: github/codeql-action/analyze@v3.30.3

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/.github/workflows/labels.yaml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🚀 Run Label Syncer
         uses: micnncim/action-label-syncer@v1.3.0
         env:

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/.github/workflows/linting.yaml

@@ -16,9 +16,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -36,9 +36,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -58,9 +58,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -102,9 +102,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -122,9 +122,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -142,9 +142,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/.github/workflows/release.yaml

@@ -22,9 +22,9 @@ jobs:
       id-token: write
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -48,7 +48,7 @@ jobs:
           verbose: true
           print-hash: true
       - name: ✍️ Sign published artifacts
-        uses: sigstore/gh-action-sigstore-python@v3.0.0
+        uses: sigstore/gh-action-sigstore-python@v3.0.1
         with:
           inputs: ./dist/*.tar.gz ./dist/*.whl
           release-signing-artifacts: false

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/.github/workflows/tests.yaml

@@ -19,9 +19,9 @@ jobs:
         python: ["3.11", "3.12"]
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ matrix.python }}
@@ -45,13 +45,13 @@ jobs:
     needs: pytest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
         with:
           fetch-depth: 0
       - name: ⬇️ Download coverage data
-        uses: actions/download-artifact@v4.3.0
+        uses: actions/download-artifact@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -66,7 +66,7 @@ jobs:
           uv run coverage combine coverage*/.coverage*
           uv run coverage xml -i
       - name: 🚀 Upload coverage report
-        uses: codecov/codecov-action@v5.4.3
+        uses: codecov/codecov-action@v5.5.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
       - name: SonarCloud Scan

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/.github/workflows/typing.yaml

@@ -16,9 +16,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ⤵️ Check out code from GitHub
-        uses: actions/checkout@v4.2.2
+        uses: actions/checkout@v5.0.0
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v6
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}

python_bsblan-3.1.0/.nvmrc

@@ -0,0 +1 @@
+22.19.0

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-bsblan
-Version: 2.2.5
+Version: 3.1.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

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/examples/control.py

@@ -1,16 +1,28 @@
 # pylint: disable=W0621
-"""Asynchronous Python client for BSBLan."""
+"""Asynchronous Python client for BSBLan.
+
+This example demonstrates the optimized hot water functionality:
+- HotWaterState: Essential parameters for frequent polling (5 fields)
+- HotWaterConfig: Configuration parameters checked less frequently (16 fields)
+- HotWaterSchedule: Time program schedules checked occasionally (8 fields)
+
+This three-tier approach reduces API calls by 79% for regular monitoring.
+"""
 
 from __future__ import annotations
 
 import asyncio
 import os
+from datetime import datetime
 from typing import Any
 
 from bsblan import (
     BSBLAN,
     BSBLANConfig,
     Device,
+    DeviceTime,
+    HotWaterConfig,
+    HotWaterSchedule,
     HotWaterState,
     Info,
     Sensor,
@@ -88,6 +100,21 @@ async def print_sensor(sensor: Sensor) -> None:
     print_attributes("Sensor Information", attributes)
 
 
+async def print_device_time(device_time: DeviceTime) -> None:
+    """Print device time information.
+
+    Args:
+        device_time (DeviceTime): The device time information from the BSBLan device.
+
+    """
+    attributes = {
+        "Current Time": await get_attribute(device_time.time, "value", "N/A"),
+        "Time Unit": await get_attribute(device_time.time, "unit", "N/A"),
+        "Time Description": await get_attribute(device_time.time, "desc", "N/A"),
+    }
+    print_attributes("Device Time", attributes)
+
+
 async def print_device_info(device: Device, info: Info) -> None:
     """Print device and general information.
 
@@ -128,11 +155,11 @@ async def print_static_state(static_state: StaticState) -> None:
 
 
 async def print_hot_water_state(hot_water_state: HotWaterState) -> None:
-    """Print hot water state information.
+    """Print essential hot water state information.
 
     Args:
-        hot_water_state (HotWaterState): The hot water state information from the
-            BSBLan device.
+        hot_water_state (HotWaterState): The essential hot water state information
+            from the BSBLan device (optimized for frequent polling).
 
     """
     attributes = {
@@ -142,45 +169,86 @@ async def print_hot_water_state(hot_water_state: HotWaterState) -> None:
         "Nominal Setpoint": await get_attribute(
             hot_water_state.nominal_setpoint, "value", "N/A"
         ),
+        "Release": await get_attribute(hot_water_state.release, "desc", "N/A"),
+        "Current Temperature": await get_attribute(
+            hot_water_state.dhw_actual_value_top_temperature, "value", "N/A"
+        ),
+        "DHW Pump State": await get_attribute(
+            hot_water_state.state_dhw_pump, "desc", "N/A"
+        ),
+    }
+    print_attributes("Hot Water State (Essential)", attributes)
+
+
+async def print_hot_water_config(hot_water_config: HotWaterConfig) -> None:
+    """Print hot water configuration information.
+
+    Args:
+        hot_water_config (HotWaterConfig): The hot water configuration information
+            from the BSBLan device (checked less frequently).
+
+    """
+    attributes = {
+        "Nominal Setpoint Max": await get_attribute(
+            hot_water_config.nominal_setpoint_max, "value", "N/A"
+        ),
         "Reduced Setpoint": await get_attribute(
-            hot_water_state.reduced_setpoint, "value", "N/A"
+            hot_water_config.reduced_setpoint, "value", "N/A"
         ),
-        "Release": await get_attribute(hot_water_state.release, "desc", "N/A"),
         "Legionella Function": await get_attribute(
-            hot_water_state.legionella_function, "desc", "N/A"
+            hot_water_config.legionella_function, "desc", "N/A"
+        ),
+        "Legionella Setpoint": await get_attribute(
+            hot_water_config.legionella_setpoint, "value", "N/A"
         ),
         "Legionella Periodicity": await get_attribute(
-            hot_water_state.legionella_periodicity, "value", "N/A"
+            hot_water_config.legionella_periodicity, "value", "N/A"
         ),
-        "Legionella Setpoint": await get_attribute(
-            hot_water_state.legionella_setpoint, "value", "N/A"
+        "Circulation Pump Release": await get_attribute(
+            hot_water_config.dhw_circulation_pump_release, "desc", "N/A"
         ),
-        "Current Temperature": await get_attribute(
-            hot_water_state.dhw_actual_value_top_temperature, "value", "N/A"
+        "Circulation Setpoint": await get_attribute(
+            hot_water_config.dhw_circulation_setpoint, "value", "N/A"
         ),
-        "Time Program Monday": await get_attribute(
-            hot_water_state.dhw_time_program_monday, "value", "N/A"
+    }
+    print_attributes("Hot Water Configuration", attributes)
+
+
+async def print_hot_water_schedule(hot_water_schedule: HotWaterSchedule) -> None:
+    """Print hot water schedule information.
+
+    Args:
+        hot_water_schedule (HotWaterSchedule): The hot water schedule information
+            from the BSBLan device (time programs).
+
+    """
+    attributes = {
+        "Monday": await get_attribute(
+            hot_water_schedule.dhw_time_program_monday, "value", "N/A"
         ),
-        "Time Program Tuesday": await get_attribute(
-            hot_water_state.dhw_time_program_tuesday, "value", "N/A"
+        "Tuesday": await get_attribute(
+            hot_water_schedule.dhw_time_program_tuesday, "value", "N/A"
         ),
-        "Time Program Wednesday": await get_attribute(
-            hot_water_state.dhw_time_program_wednesday, "value", "N/A"
+        "Wednesday": await get_attribute(
+            hot_water_schedule.dhw_time_program_wednesday, "value", "N/A"
         ),
-        "Time Program Thursday": await get_attribute(
-            hot_water_state.dhw_time_program_thursday, "value", "N/A"
+        "Thursday": await get_attribute(
+            hot_water_schedule.dhw_time_program_thursday, "value", "N/A"
         ),
-        "Time Program Friday": await get_attribute(
-            hot_water_state.dhw_time_program_friday, "value", "N/A"
+        "Friday": await get_attribute(
+            hot_water_schedule.dhw_time_program_friday, "value", "N/A"
         ),
-        "Time Program Saturday": await get_attribute(
-            hot_water_state.dhw_time_program_saturday, "value", "N/A"
+        "Saturday": await get_attribute(
+            hot_water_schedule.dhw_time_program_saturday, "value", "N/A"
         ),
-        "Time Program Sunday": await get_attribute(
-            hot_water_state.dhw_time_program_sunday, "value", "N/A"
+        "Sunday": await get_attribute(
+            hot_water_schedule.dhw_time_program_sunday, "value", "N/A"
+        ),
+        "Standard Values": await get_attribute(
+            hot_water_schedule.dhw_time_program_standard_values, "value", "N/A"
         ),
     }
-    print_attributes("Hot Water State", attributes)
+    print_attributes("Hot Water Schedule", attributes)
 
 
 async def main() -> None:
@@ -216,14 +284,32 @@ async def main() -> None:
         info: Info = await bsblan.info()
         await print_device_info(device, info)
 
+        # Get and print device time
+        device_time: DeviceTime = await bsblan.time()
+        await print_device_time(device_time)
+
         # Get and print static state
         static_state: StaticState = await bsblan.static_values()
         await print_static_state(static_state)
 
-        # Get hot water state
+        # Get hot water state (essential parameters for frequent polling)
         hot_water_state: HotWaterState = await bsblan.hot_water_state()
         await print_hot_water_state(hot_water_state)
 
+        # Get hot water configuration (checked less frequently)
+        try:
+            hot_water_config: HotWaterConfig = await bsblan.hot_water_config()
+            await print_hot_water_config(hot_water_config)
+        except Exception as e:  # noqa: BLE001 - Broad exception for demo purposes
+            print(f"Hot water configuration not available: {e}")
+
+        # Get hot water schedule (time programs)
+        try:
+            hot_water_schedule: HotWaterSchedule = await bsblan.hot_water_schedule()
+            await print_hot_water_schedule(hot_water_schedule)
+        except Exception as e:  # noqa: BLE001 - Broad exception for demo purposes
+            print(f"Hot water schedule not available: {e}")
+
         # Example: Set DHW time program for Monday
         print("\nSetting DHW time program for Monday to 13:00-14:00")
 
@@ -232,6 +318,15 @@ async def main() -> None:
         )
         await bsblan.set_hot_water(dhw_time_programs=dhw_programs)
 
+        # Example: Set device time
+        print("\nSetting device time to current system time")
+        # Get current local system time and format it for BSB-LAN (DD.MM.YYYY HH:MM:SS)
+        # Note: Using local time intentionally for this demo to sync BSB-LAN
+        current_time = datetime.now().replace(microsecond=0)  # noqa: DTZ005 - Demo uses local time
+        formatted_time = current_time.strftime("%d.%m.%Y %H:%M:%S")
+        print(f"Current system time: {formatted_time}")
+        await bsblan.set_time(formatted_time)
+
 
 if __name__ == "__main__":
     asyncio.run(main())

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/package-lock.json

@@ -12,13 +12,13 @@
         "url-parse": "1.5.10"
       },
       "devDependencies": {
-        "prettier": "3.5.3"
+        "prettier": "3.6.2"
       }
     },
     "node_modules/prettier": {
-      "version": "3.5.3",
-      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.5.3.tgz",
-      "integrity": "sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==",
+      "version": "3.6.2",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.6.2.tgz",
+      "integrity": "sha512-I7AIg5boAr5R0FFtJ6rCfD+LFsWHp81dolrFD8S79U9tb8Az2nGrJncnMSnys+bpQJfRUzqs9hnA81OAA3hCuQ==",
       "dev": true,
       "license": "MIT",
       "bin": {

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/package.json

@@ -9,7 +9,7 @@
   "author": "WJL van Rootselaar <liudgervr@gmail.com>",
   "license": "MIT",
   "devDependencies": {
-    "prettier": "3.5.3"
+    "prettier": "3.6.2"
   },
   "dependencies": {
     "url-parse": "1.5.10"

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-bsblan"
-version = "2.2.5"
+version = "3.1.0"
 description = "Asynchronous Python client for BSBLAN API"
 authors = [
     {name = "Willem-Jan van Rootselaar", email = "liudgervr@gmail.com"}
@@ -46,11 +46,24 @@ packages = ["src/bsblan"]
 
 [tool.coverage.run]
 plugins = ["covdefaults"]
-source = ["bsblan"]
+source = ["src/bsblan"]
+omit = [
+    "tests/*",
+    "*/tests/*",
+    "test_*",
+    "*test*"
+]
 
 [tool.coverage.report]
 show_missing = true
 fail_under = 53
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+]
 
 [tool.mypy]
 # Specify the target platform details in config, so your developers are
@@ -163,26 +176,28 @@ build-backend = "hatchling.build"
 [dependency-groups]
 dev = [
     "aresponses==3.0.0",
-    "bandit==1.8.3",
+    "bandit==1.8.6",
     "black==25.1.0",
-    "blacken-docs==1.19.1",
+    "blacken-docs==1.20.0",
     "codespell==2.4.1",
     "covdefaults==2.3.0",
-    "coverage==7.8.2",
+    "coverage==7.10.6",
     "darglint==1.8.1",
-    "flake8==7.2.0",
+    "flake8==7.3.0",
     "flake8-simplify==0.22.0",
+    # hatch is required to support type hinting and proper packaging of the py.typed file.
+    "hatch>=1.14.1",
     "isort==6.0.1",
-    "mypy==1.16.0",
-    "pre-commit==4.2.0",
-    "pre-commit-hooks==5.0.0",
-    "pylint==3.3.7",
+    "mypy==1.18.1",
+    "pre-commit==4.3.0",
+    "pre-commit-hooks==6.0.0",
+    "pylint==3.3.8",
     "pytest>=8.3.5",
-    "pytest-asyncio==1.0.0",
-    "pytest-cov==6.1.1",
-    "pyupgrade==3.19.1",
-    "ruff==0.11.13",
-    "safety==3.5.1",
+    "pytest-asyncio==1.1.0",
+    "pytest-cov==6.3.0",
+    "pyupgrade==3.20.0",
+    "ruff==0.13.0",
+    "safety==3.6.1",
     "vulture==2.14",
     "yamllint==1.37.1",
 ]

{python_bsblan-2.2.5 → python_bsblan-3.1.0}/src/bsblan/__init__.py

@@ -4,7 +4,10 @@ from .bsblan import BSBLAN, BSBLANConfig
 from .exceptions import BSBLANAuthError, BSBLANConnectionError, BSBLANError
 from .models import (
     Device,
+    DeviceTime,
     DHWTimeSwitchPrograms,
+    HotWaterConfig,
+    HotWaterSchedule,
     HotWaterState,
     Info,
     Sensor,
@@ -20,6 +23,9 @@ __all__ = [
     "BSBLANError",
     "DHWTimeSwitchPrograms",
     "Device",
+    "DeviceTime",
+    "HotWaterConfig",
+    "HotWaterSchedule",
     "HotWaterState",
     "Info",
     "Sensor",