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

{python_bsblan-5.2.0 → 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.2.0 → 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.2.0 → 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.2.0 → 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.2.0 → 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.2.0 → 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.2.0 → 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.2.0 → 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.2.0 → python_bsblan-5.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-bsblan
-Version: 5.2.0
+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.2.0 → python_bsblan-5.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-bsblan"
-version = "5.2.0"
+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.2.0 → python_bsblan-5.2.1}/src/bsblan/bsblan.py

@@ -152,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
@@ -179,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
-
-                # 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
+                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:

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

@@ -326,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

{python_bsblan-5.2.0 → python_bsblan-5.2.1}/tests/test_circuit.py

@@ -13,7 +13,7 @@ import pytest
 from aresponses import Response, ResponsesMockServer
 
 from bsblan import BSBLAN, BSBLANConfig, State, StaticState
-from bsblan.constants import ErrorMsg, build_api_config
+from bsblan.constants import CircuitConfig, ErrorMsg, build_api_config
 from bsblan.exceptions import BSBLANError, BSBLANInvalidParameterError
 from bsblan.utility import APIValidator
 
@@ -544,26 +544,20 @@ async def test_get_available_circuits_two_circuits(
         # HC1 operating mode
         if param_id == "700":
             return {"700": {"value": "1", "unit": "", "desc": "Automatic"}}
-        # HC1 status - active
-        if param_id == "8000":
-            return {
-                "8000": {
-                    "value": "114",
-                    "desc": "Heating mode Comfort",
-                }
-            }
         # HC2 operating mode
         if param_id == "1000":
             return {"1000": {"value": "1", "unit": "", "desc": "Automatic"}}
-        # HC2 status - active
-        if param_id == "8001":
-            return {"8001": {"value": "114", "desc": "Heating mode Comfort"}}
-        return {}
+        msg = f"Unexpected parameter probe: {param_id}"
+        raise AssertionError(msg)
 
-    bsblan._request = AsyncMock(side_effect=mock_request)  # type: ignore[method-assign]
+    request_mock = AsyncMock(side_effect=mock_request)
+    bsblan._request = request_mock  # type: ignore[method-assign]
 
     circuits = await bsblan.get_available_circuits()
     assert circuits == [1, 2]
+    assert [
+        call.kwargs["params"]["Parameter"] for call in request_mock.await_args_list
+    ] == ["700", "1000"]
 
 
 @pytest.mark.asyncio
@@ -580,33 +574,27 @@ async def test_get_available_circuits_only_one(
         param_id = params.get("Parameter", "")
         if param_id == "700":
             return {"700": {"value": "3", "unit": "", "desc": "Comfort"}}
-        if param_id == "8000":
-            return {
-                "8000": {
-                    "value": "114",
-                    "desc": "Heating mode Comfort",
-                }
-            }
         # HC2 operating mode - return empty
         if param_id == "1000":
             return {param_id: {}}
-        return {}
+        msg = f"Unexpected parameter probe: {param_id}"
+        raise AssertionError(msg)
 
-    bsblan._request = AsyncMock(side_effect=mock_request)  # type: ignore[method-assign]
+    request_mock = AsyncMock(side_effect=mock_request)
+    bsblan._request = request_mock  # type: ignore[method-assign]
 
     circuits = await bsblan.get_available_circuits()
     assert circuits == [1]
+    assert [
+        call.kwargs["params"]["Parameter"] for call in request_mock.await_args_list
+    ] == ["700", "1000"]
 
 
 @pytest.mark.asyncio
-async def test_get_available_circuits_inactive_by_status(
+async def test_get_available_circuits_does_not_probe_status_params(
     mock_bsblan_circuit: BSBLAN,
 ) -> None:
-    """Test that circuits with status '---' are detected as inactive.
-
-    This is the real-world scenario: the device returns a valid operating
-    mode for all circuits, but status param shows '---' for HC2.
-    """
+    """Test discovery only queries probe params, not status params."""
     bsblan = mock_bsblan_circuit
 
     async def mock_request(
@@ -617,61 +605,20 @@ async def test_get_available_circuits_inactive_by_status(
         # All circuits return valid operating mode
         if param_id in {"700", "1000"}:
             return {param_id: {"value": "1", "unit": "", "desc": "Automatic"}}
-        # HC1 status - active
-        if param_id == "8000":
-            return {
-                "8000": {
-                    "value": "114",
-                    "desc": "Heating mode Comfort",
-                }
-            }
-        # HC2 status - inactive (value=0, desc=---)
-        if param_id == "8001":
-            return {"8001": {"value": "0", "desc": "---"}}
-        return {}
+        msg = f"Unexpected status parameter probe: {param_id}"
+        raise AssertionError(msg)
 
-    bsblan._request = AsyncMock(side_effect=mock_request)  # type: ignore[method-assign]
+    request_mock = AsyncMock(side_effect=mock_request)
+    bsblan._request = request_mock  # type: ignore[method-assign]
 
     circuits = await bsblan.get_available_circuits()
-    assert circuits == [1]
-
-
-@pytest.mark.asyncio
-async def test_get_available_circuits_inactive_empty_status(
-    mock_bsblan_circuit: BSBLAN,
-) -> None:
-    """Test that circuits with empty status response are inactive.
-
-    Some controllers return an empty dict for status params of circuits
-    that don't exist (e.g., HC2 status 8001 returns {}).
-    """
-    bsblan = mock_bsblan_circuit
-
-    async def mock_request(
-        **kwargs: Any,
-    ) -> dict[str, Any]:
-        params = kwargs.get("params", {})
-        param_id = params.get("Parameter", "")
-        # All circuits return valid operating mode
-        if param_id in {"700", "1000"}:
-            return {param_id: {"value": "1", "unit": "", "desc": "Automatic"}}
-        # HC1 status - active
-        if param_id == "8000":
-            return {
-                "8000": {
-                    "value": "114",
-                    "desc": "Heating mode Comfort",
-                }
-            }
-        # HC2 status - empty response (param not supported)
-        if param_id == "8001":
-            return {}
-        return {}
-
-    bsblan._request = AsyncMock(side_effect=mock_request)  # type: ignore[method-assign]
-
-    circuits = await bsblan.get_available_circuits()
-    assert circuits == [1]
+    assert circuits == [1, 2]
+    assert {
+        call.kwargs["params"]["Parameter"] for call in request_mock.await_args_list
+    } == {
+        "700",
+        "1000",
+    }
 
 
 @pytest.mark.asyncio
@@ -681,27 +628,19 @@ async def test_get_available_circuits_request_failure(
     """Test circuit detection when some requests fail."""
     bsblan = mock_bsblan_circuit
 
-    call_count = 0
-
     async def mock_request(
         **kwargs: Any,
     ) -> dict[str, Any]:
-        nonlocal call_count
-        call_count += 1
         params = kwargs.get("params", {})
         param_id = params.get("Parameter", "")
         if param_id == "700":
             return {"700": {"value": "1", "unit": "", "desc": "Automatic"}}
-        if param_id == "8000":
-            return {
-                "8000": {
-                    "value": "114",
-                    "desc": "Heating mode Comfort",
-                }
-            }
         # HC2 fail with connection error
-        msg = "Connection failed"
-        raise BSBLANError(msg)
+        if param_id == "1000":
+            msg = "Connection failed"
+            raise BSBLANError(msg)
+        msg = f"Unexpected parameter probe: {param_id}"
+        raise AssertionError(msg)
 
     bsblan._request = AsyncMock(side_effect=mock_request)  # type: ignore[method-assign]
 
@@ -723,15 +662,11 @@ async def test_get_available_circuits_param_not_in_response(
         param_id = params.get("Parameter", "")
         if param_id == "700":
             return {"700": {"value": "1", "unit": "", "desc": "Automatic"}}
-        if param_id == "8000":
-            return {
-                "8000": {
-                    "value": "114",
-                    "desc": "Heating mode Comfort",
-                }
-            }
         # Returns a response but without the expected param key
-        return {"other_key": {"value": "1"}}
+        if param_id == "1000":
+            return {"other_key": {"value": "1"}}
+        msg = f"Unexpected parameter probe: {param_id}"
+        raise AssertionError(msg)
 
     bsblan._request = AsyncMock(side_effect=mock_request)  # type: ignore[method-assign]
 
@@ -740,37 +675,31 @@ async def test_get_available_circuits_param_not_in_response(
 
 
 @pytest.mark.asyncio
-async def test_get_available_circuits_status_failure_excludes_circuit(
+async def test_get_available_circuits_all_probes_missing(
     mock_bsblan_circuit: BSBLAN,
 ) -> None:
-    """Test that a circuit is excluded if the status request fails.
-
-    If the operating mode returns valid data but the status request fails,
-    the circuit should be excluded (fail-safe).
-    """
+    """Test no circuits are detected when operating mode probes are missing."""
     bsblan = mock_bsblan_circuit
+    expected_params = list(CircuitConfig.PROBE_PARAMS.values())
 
     async def mock_request(
         **kwargs: Any,
     ) -> dict[str, Any]:
         params = kwargs.get("params", {})
         param_id = params.get("Parameter", "")
-        if param_id == "700":
-            return {"700": {"value": "1", "unit": "", "desc": "Automatic"}}
-        # Status request fails
-        if param_id == "8000":
-            msg = "Connection failed"
-            raise BSBLANError(msg)
-        # HC2 return empty
-        if param_id == "1000":
-            return {param_id: {}}
-        return {}
+        if param_id in expected_params:
+            return {}
+        msg = f"Unexpected parameter probe: {param_id}"
+        raise AssertionError(msg)
 
-    bsblan._request = AsyncMock(side_effect=mock_request)  # type: ignore[method-assign]
+    request_mock = AsyncMock(side_effect=mock_request)
+    bsblan._request = request_mock  # type: ignore[method-assign]
 
-    # HC1 status request fails -> entire circuit probe fails -> excluded
     circuits = await bsblan.get_available_circuits()
     assert circuits == []
+    assert [
+        call.kwargs["params"]["Parameter"] for call in request_mock.await_args_list
+    ] == expected_params
 
 
 @pytest.mark.asyncio

python_bsblan-5.2.0/.nvmrc

@@ -1 +0,0 @@
-24.14.1