python-bsblan 5.1.5__tar.gz → 5.2.1__tar.gz

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/.github/workflows/codeql.yaml

@@ -27,6 +27,6 @@ jobs:
         with:
           persist-credentials: false
       - name: 🏗 Initialize CodeQL
-        uses: github/codeql-action/init@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4.35.2
+        uses: github/codeql-action/init@e46ed2cbd01164d986452f91f178727624ae40d7 # v4.35.3
       - name: 🚀 Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4.35.2
+        uses: github/codeql-action/analyze@e46ed2cbd01164d986452f91f178727624ae40d7 # v4.35.3

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/.github/workflows/docs.yaml

@@ -27,7 +27,7 @@ jobs:
         with:
           persist-credentials: false
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/.github/workflows/linting.yaml

@@ -25,7 +25,7 @@ jobs:
         with:
           persist-credentials: false
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -49,7 +49,7 @@ jobs:
         with:
           persist-credentials: false
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/.github/workflows/release-drafter.yaml

@@ -36,7 +36,7 @@ jobs:
     steps:
       - name: 🚀 Run Release Drafter
         # yamllint disable-line rule:line-length
-        uses: release-drafter/release-drafter@5de93583980a40bd78603b6dfdcda5b4df377b32 # v7.2.0
+        uses: release-drafter/release-drafter@563bf132657a13ded0b01fcb723c5a58cdd824e2 # v7.2.1
         with:
           prerelease: ${{ github.event.inputs.prerelease == 'true' }}
           prerelease-identifier: ${{ github.event.inputs.prerelease_identifier }}

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/.github/workflows/release.yaml

@@ -29,7 +29,7 @@ jobs:
         with:
           persist-credentials: false
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
           enable-cache: false
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/.github/workflows/scorecard.yml

@@ -66,6 +66,6 @@ jobs:
       # Upload the results to GitHub's code scanning dashboard (optional).
       - name: "Upload to code-scanning"
         # yamllint disable-line rule:line-length
-        uses: github/codeql-action/upload-sarif@95e58e9a2cdfd71adc6e0353d5c52f41a045d225 # v4.35.2
+        uses: github/codeql-action/upload-sarif@e46ed2cbd01164d986452f91f178727624ae40d7 # v4.35.3
         with:
           sarif_file: results.sarif

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/.github/workflows/tests.yaml

@@ -33,7 +33,7 @@ jobs:
         with:
           persist-credentials: false
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ matrix.python }}
@@ -68,7 +68,7 @@ jobs:
       - name: ⬇️ Download coverage data
         uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
       - name: 🏗 Set up uv
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -93,7 +93,7 @@ jobs:
       - name: SonarQube Cloud Scan
         if: env.HAS_SONAR_TOKEN == 'true' && (github.event_name != 'pull_request' || !github.event.pull_request.head.repo.fork)
         # yamllint disable-line rule:line-length
-        uses: SonarSource/sonarqube-scan-action@299e4b793aaa83bf2aba7c9c14bedbb485688ec4 # v7.1.0
+        uses: SonarSource/sonarqube-scan-action@59db25f34e16620e48ab4bb9e4a5dce155cb5432 # v8.0
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/.github/workflows/typing.yaml

@@ -27,7 +27,7 @@ jobs:
           persist-credentials: false
       - name: 🏗 Set up uv
         # yamllint disable-line rule:line-length
-        uses: astral-sh/setup-uv@37802adc94f370d6bfd71619e3f0bf239e1f3b78 # v7
+        uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b # v8.1.0
         with:
           enable-cache: true
       - name: 🏗 Set up Python ${{ env.DEFAULT_PYTHON }}

python_bsblan-5.2.1/.nvmrc

@@ -0,0 +1 @@
+24.15.0

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-bsblan
-Version: 5.1.5
+Version: 5.2.1
 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-5.1.5 → python_bsblan-5.2.1}/docs/api/client.md

@@ -19,6 +19,8 @@ The main entry point for interacting with BSB-LAN devices.
         - time
         - set_time
         - thermostat
+        - heating_schedule
+        - set_heating_schedule
         - hot_water_state
         - hot_water_config
         - hot_water_schedule

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/docs/api/models.md

@@ -26,6 +26,10 @@ Data models for BSB-LAN API responses.
 
 ::: bsblan.Sensor
 
+### HeatingTimeSwitchPrograms
+
+::: bsblan.HeatingTimeSwitchPrograms
+
 ## Hot water
 
 ### HotWaterState
@@ -46,6 +50,10 @@ Data models for BSB-LAN API responses.
 
 ## Schedules
 
+### HeatingSchedule
+
+::: bsblan.HeatingSchedule
+
 ### DHWSchedule
 
 ::: bsblan.DHWSchedule

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-bsblan"
-version = "5.1.5"
+version = "5.2.1"
 description = "Asynchronous Python client for BSBLAN API"
 authors = [
     {name = "Willem-Jan van Rootselaar", email = "liudgervr@gmail.com"}
@@ -196,7 +196,7 @@ dev = [
     # hatch is required to support type hinting and proper packaging of the py.typed file.
     "hatch>=1.14.1",
     "isort==8.0.1",
-    "ty==0.0.32",
+    "ty==0.0.34",
     "prek>=0.3.3",
     "pre-commit-hooks==6.0.0",
     "pylint==4.0.5",
@@ -205,7 +205,7 @@ dev = [
     "pytest-cov==7.1.0",
     "pytest-xdist>=3.8.0",
     "pyupgrade==3.21.2",
-    "ruff==0.15.11",
+    "ruff==0.15.12",
     "safety==3.7.0",
     "vulture==2.16",
     "yamllint==1.38.0",

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/src/bsblan/__init__.py

@@ -17,6 +17,8 @@ from .models import (
     DHWTimeSwitchPrograms,
     EntityInfo,
     EntityValue,
+    HeatingSchedule,
+    HeatingTimeSwitchPrograms,
     HotWaterConfig,
     HotWaterSchedule,
     HotWaterState,
@@ -45,6 +47,8 @@ __all__ = [
     "EntityValue",
     "HVACActionCategory",
     "HeatingCircuitStatus",
+    "HeatingSchedule",
+    "HeatingTimeSwitchPrograms",
     "HotWaterConfig",
     "HotWaterSchedule",
     "HotWaterState",

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/src/bsblan/bsblan.py

@@ -22,6 +22,7 @@ from .constants import (
     APIConfig,
     CircuitConfig,
     ErrorMsg,
+    HeatingScheduleParams,
     HotWaterParams,
     Validation,
 )
@@ -38,6 +39,8 @@ from .models import (
     DeviceTime,
     DHWSchedule,
     EntityInfo,
+    HeatingSchedule,
+    HeatingTimeSwitchPrograms,
     HotWaterConfig,
     HotWaterSchedule,
     HotWaterState,
@@ -149,13 +152,10 @@ class BSBLAN:
     async def get_available_circuits(self) -> list[int]:
         """Detect which heating circuits are available on the device.
 
-        Uses a two-step probe for each circuit (1, 2):
-        1. Query the operating mode parameter — the response must be
-           non-empty and contain actual data.
-        2. Query the status parameter (8000/8001) — an inactive
-           circuit returns ``value="0"`` with ``desc="---"``.
-
-        A circuit is only considered available when both checks pass.
+        Uses the configured operating mode probe parameters from
+        CircuitConfig.PROBE_PARAMS as the only discovery signal. Status
+        parameters are not queried during discovery to keep setup lightweight
+        and avoid excluding valid circuits when status data is unavailable.
 
         This is useful for integration setup flows (e.g., Home Assistant
         config flow) to discover how many circuits the user's controller
@@ -176,46 +176,23 @@ class BSBLAN:
                 response = await self._request(
                     params={"Parameter": param_id},
                 )
-                # A circuit exists if the response contains the param_id key
-                # with actual data (not an empty dict)
-                if not response.get(param_id):
-                    continue
-
-                # Secondary check: query the status parameter.
-                # Inactive circuits either:
-                # - return value="0" and desc="---"
-                # - return an empty dict {} (param not supported)
-                status_id = CircuitConfig.STATUS_PARAMS[circuit]
-                status_resp = await self._request(
-                    params={"Parameter": status_id},
+            except BSBLANError:
+                logger.debug(
+                    "Circuit %d not available (operating mode request failed)",
+                    circuit,
                 )
-                status_data = status_resp.get(status_id, {})
-
-                # Empty response means the parameter doesn't exist
-                if not status_data or not isinstance(status_data, dict):
-                    logger.debug(
-                        "Circuit %d has no status data (not supported)",
-                        circuit,
-                    )
-                    continue
+                continue
 
-                # value="0" + desc="---" means inactive
-                if (
-                    status_data.get("desc") == CircuitConfig.INACTIVE_MARKER
-                    and str(status_data.get("value", "")) == "0"
-                ):
-                    logger.debug(
-                        "Circuit %d has status '---' (inactive)",
-                        circuit,
-                    )
-                    continue
-
-                available.append(circuit)
-            except BSBLANError:
+            # A circuit exists if the response contains the operating mode key
+            # with actual data (not an empty dict).
+            if not response.get(param_id):
                 logger.debug(
-                    "Circuit %d not available (request failed)",
+                    "Circuit %d has no operating mode data (not supported)",
                     circuit,
                 )
+                continue
+
+            available.append(circuit)
         return sorted(available)
 
     async def _setup_api_validator(self) -> None:
@@ -1380,6 +1357,91 @@ class BSBLAN:
             include=include,
         )
 
+    async def heating_schedule(
+        self,
+        include: list[str] | None = None,
+        circuit: int = 1,
+    ) -> HeatingTimeSwitchPrograms:
+        """Get heating time switch programs for a specific circuit.
+
+        Args:
+            include: Optional list of day names to fetch. If None,
+                fetches all schedule parameters. Valid names include:
+                monday, tuesday, wednesday, thursday,
+                friday, saturday, sunday, standard_values.
+            circuit: The heating circuit number (1 or 2). Defaults to 1.
+
+        Returns:
+            HeatingTimeSwitchPrograms: Heating schedule information.
+
+        """
+        self._validate_circuit(circuit)
+        time_program_params = HeatingScheduleParams.TIME_PROGRAMS[circuit]
+
+        filtered_params = time_program_params
+        if include is not None:
+            if not include:
+                raise BSBLANError(ErrorMsg.EMPTY_INCLUDE_LIST)
+            filtered_params = {
+                param_id: name
+                for param_id, name in time_program_params.items()
+                if name in include
+            }
+            if not filtered_params:
+                raise BSBLANError(ErrorMsg.INVALID_INCLUDE_PARAMS)
+
+        params = self._extract_params_summary(filtered_params)
+        data = await self._request(params={"Parameter": params["string_par"]})
+        mapped_data = {
+            name: data[param_id]
+            for param_id, name in filtered_params.items()
+            if param_id in data
+        }
+
+        if not mapped_data:
+            raise BSBLANError(ErrorMsg.NO_HEATING_SCHEDULE_PARAMS)
+
+        return HeatingTimeSwitchPrograms.model_validate(mapped_data)
+
+    async def set_heating_schedule(
+        self,
+        schedule: HeatingSchedule,
+        circuit: int = 1,
+    ) -> None:
+        """Set heating time switch programs for a specific circuit.
+
+        This method allows setting weekly heating schedules using a type-safe
+        interface with TimeSlot and DaySchedule objects.
+
+        Args:
+            schedule: HeatingSchedule object containing the weekly schedule.
+            circuit: The heating circuit number (1 or 2). Defaults to 1.
+
+        Raises:
+            BSBLANError: If no schedule is provided.
+
+        """
+        self._validate_circuit(circuit)
+
+        if not schedule.has_any_schedule():
+            raise BSBLANError(ErrorMsg.NO_SCHEDULE)
+
+        day_param_map = {
+            v: k
+            for k, v in HeatingScheduleParams.TIME_PROGRAMS[circuit].items()
+            if v != "standard_values"
+        }
+
+        for day_name, param_id in day_param_map.items():
+            day_schedule: DaySchedule | None = getattr(schedule, day_name)
+            if day_schedule is not None:
+                state = {
+                    "Parameter": param_id,
+                    "Value": day_schedule.to_bsblan_format(),
+                    "Type": "1",
+                }
+                await self._set_device_state(state)
+
     async def set_hot_water(self, params: SetHotWaterParam) -> None:
         """Change the state of the hot water system through BSB-Lan.
 

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/src/bsblan/constants.py

@@ -491,6 +491,7 @@ class ErrorMsg:
     EMPTY_INCLUDE_LIST = (
         "Empty include list provided. Use None to fetch all parameters."
     )
+    NO_HEATING_SCHEDULE_PARAMS = "No heating schedule parameters available"
 
 
 # Handle both ASCII and Unicode degree symbols
@@ -655,3 +656,30 @@ class HotWaterParams:
         "567": "sunday",
         "576": "standard_values",
     }
+
+
+class HeatingScheduleParams:
+    """Heating schedule parameter mappings per circuit."""
+
+    TIME_PROGRAMS: Final[dict[int, dict[str, str]]] = {
+        1: {
+            "501": "monday",
+            "502": "tuesday",
+            "503": "wednesday",
+            "504": "thursday",
+            "505": "friday",
+            "506": "saturday",
+            "507": "sunday",
+            "516": "standard_values",
+        },
+        2: {
+            "521": "monday",
+            "522": "tuesday",
+            "523": "wednesday",
+            "524": "thursday",
+            "525": "friday",
+            "526": "saturday",
+            "527": "sunday",
+            "536": "standard_values",
+        },
+    }

{python_bsblan-5.1.5 → python_bsblan-5.2.1}/src/bsblan/models.py

@@ -141,23 +141,10 @@ class DaySchedule:
 
 
 @dataclass
-class DHWSchedule:
-    """Weekly hot water schedule for setting time programs.
+class WeeklySchedule:
+    """Base weekly schedule with optional day schedules.
 
-    Use this dataclass to set DHW time programs via set_hot_water_schedule().
-    Each day can have up to 3 time slots.
-
-    Example:
-        >>> schedule = DHWSchedule(
-        ...     monday=DaySchedule(slots=[
-        ...         TimeSlot(time(6, 0), time(8, 0)),
-        ...         TimeSlot(time(17, 0), time(21, 0)),
-        ...     ]),
-        ...     tuesday=DaySchedule(slots=[
-        ...         TimeSlot(time(6, 0), time(8, 0)),
-        ...     ])
-        ... )
-        >>> await client.set_hot_water_schedule(schedule)
+    Each day can have up to 3 time slots (validated by DaySchedule).
 
     """
 
@@ -190,6 +177,38 @@ class DHWSchedule:
         )
 
 
+@dataclass
+class DHWSchedule(WeeklySchedule):
+    """Weekly hot water schedule for setting time programs.
+
+    Use this dataclass to set DHW time programs via set_hot_water_schedule().
+    Each day can have up to 3 time slots.
+
+    Example:
+        >>> schedule = DHWSchedule(
+        ...     monday=DaySchedule(slots=[
+        ...         TimeSlot(time(6, 0), time(8, 0)),
+        ...         TimeSlot(time(17, 0), time(21, 0)),
+        ...     ]),
+        ...     tuesday=DaySchedule(slots=[
+        ...         TimeSlot(time(6, 0), time(8, 0)),
+        ...     ])
+        ... )
+        >>> await client.set_hot_water_schedule(schedule)
+
+    """
+
+
+@dataclass
+class HeatingSchedule(WeeklySchedule):
+    """Weekly heating schedule for setting time programs.
+
+    Use this dataclass to set heating time programs via set_heating_schedule().
+    Each day can have up to 3 time slots.
+
+    """
+
+
 @dataclass
 class DHWTimeSwitchPrograms:
     """Dataclass for DHW time switch programs."""
@@ -307,13 +326,13 @@ class EntityInfo(BaseModel, Generic[T]):
     unit: str
     desc: str
     value: T | None = None
-    data_type: int = Field(alias="dataType", default=0)
+    data_type: int = Field(validation_alias="dataType", default=0)
     error: int = 0
     readonly: int = 0
     readwrite: int = 0
     precision: float | None = None
-    data_type_name: str = Field(default="", alias="dataType_name")
-    data_type_family: str = Field(default="", alias="dataType_family")
+    data_type_name: str = Field(default="", validation_alias="dataType_name")
+    data_type_family: str = Field(default="", validation_alias="dataType_family")
 
     @model_validator(mode="before")
     @classmethod
@@ -554,6 +573,29 @@ class HotWaterSchedule(BaseModel):
     dhw_time_program_standard_values: EntityInfo[int] | None = None
 
 
+class HeatingTimeSwitchPrograms(BaseModel):
+    """Heating time switch programs for a specific heating circuit (READ).
+
+    The daily time programs (Monday-Sunday) use BSB-LAN dataType 9
+    (TIMEPROG) and return schedule strings like
+    ``"13:00-15:00 ##:##-##:## ##:##-##:##"`` where ``##:##`` marks
+    unused time slots.
+
+    ``standard_values`` is a YESNO enum (0=No, 1=Yes) that resets
+    all daily schedules back to the controller's factory defaults.
+
+    """
+
+    monday: EntityInfo[str | int] | None = None
+    tuesday: EntityInfo[str | int] | None = None
+    wednesday: EntityInfo[str | int] | None = None
+    thursday: EntityInfo[str | int] | None = None
+    friday: EntityInfo[str | int] | None = None
+    saturday: EntityInfo[str | int] | None = None
+    sunday: EntityInfo[str | int] | None = None
+    standard_values: EntityInfo[int] | None = None
+
+
 class DeviceTime(BaseModel):
     """Object holds device time information."""