python-bsblan 0.6.0__tar.gz → 0.6.2__tar.gz

{python_bsblan-0.6.0 → python_bsblan-0.6.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-bsblan
-Version: 0.6.0
+Version: 0.6.2
 Summary: Asynchronous Python client for BSBLAN
 Home-page: https://github.com/liudger/python-bsblan
 License: MIT
@@ -66,11 +66,37 @@ pip install python-bsblan
 """Asynchronous Python client for BSBLan."""
 
 import asyncio
+import os
 
-from bsblan import BSBLan, Info, State
+from bsblan import BSBLAN, BSBLANConfig, Device, Info, Sensor, State, StaticState
 
 
-async def main(loop):
+async def print_state(state: State) -> None:
+    """Print the current state of the BSBLan device."""
+    print(f"HVAC Action: {state.hvac_action.desc}")
+    print(f"HVAC Mode: {state.hvac_mode.desc}")
+    print(f"Current Temperature: {state.current_temperature.value}")
+
+
+async def print_sensor(sensor: Sensor) -> None:
+    """Print sensor information from the BSBLan device."""
+    print(f"Outside Temperature: {sensor.outside_temperature.value}")
+
+
+async def print_device_info(device: Device, info: Info) -> None:
+    """Print device and general information."""
+    print(f"Device Name: {device.name}")
+    print(f"Version: {device.version}")
+    print(f"Device Identification: {info.device_identification.value}")
+
+
+async def print_static_state(static_state: StaticState) -> None:
+    """Print static state information."""
+    print(f"Min Temperature: {static_state.min_temp.value}")
+    print(f"Max Temperature: {static_state.max_temp.value}")
+
+
+async def main() -> None:
     """Show example on controlling your BSBLan device.
 
     Options:
@@ -78,35 +104,44 @@ async def main(loop):
     - username and password if your device is setup for username/password authentication
 
     """
-    async with BSBLan(
-        host="10.0.1.60", passkey=None, username=None, password=None, loop=loop
-    ) as bsblan:
-        # get state from bsblan device
+    # Create a configuration object
+    config = BSBLANConfig(
+        host="10.0.2.60",
+        passkey=None,
+        username=os.getenv("USERNAME"),  # Compliant
+        password=os.getenv("PASSWORD"),  # Compliant
+    )
+
+    # Initialize BSBLAN with the configuration object
+    async with BSBLAN(config) as bsblan:
+        # Get and print state
         state: State = await bsblan.state()
-        print(state)
+        await print_state(state)
 
-        # set temp thermostat
-        await bsblan.thermostat(target_temperature=19.0)
+        # Set thermostat temperature
+        print("\nSetting temperature to 18°C")
+        await bsblan.thermostat(target_temperature="18")
 
-        # set hvac_mode (0-3) (protection,auto,reduced,comfort)
-        await bsblan.thermostat(hvac_mode=3)
+        # Set HVAC mode
+        print("Setting HVAC mode to heat")
+        await bsblan.thermostat(hvac_mode="heat")
 
-        # get some generic info from the heater
-        info: Info = await bsblan.info()
-        print(info)
+        # Get and print sensor information
+        sensor: Sensor = await bsblan.sensor()
+        await print_sensor(sensor)
 
-        # get device info
+        # Get and print device and general info
         device: Device = await bsblan.device()
-        print(device)
+        info: Info = await bsblan.info()
+        await print_device_info(device, info)
 
-        # get sensor from bsblan device
-        sensor: Sensor = await bsblan.sensor()
-        print(f"outside temperature: {sensor.outside_temperature.value}")
+        # Get and print static state
+        static_state: StaticState = await bsblan.static_values()
+        await print_static_state(static_state)
 
 
 if __name__ == "__main__":
-    loop = asyncio.get_event_loop_policy().get_event_loop()
-    loop.run_until_complete(main())
+    asyncio.run(main())
 ```
 
 ## Changelog & Releases
@@ -139,7 +174,7 @@ This Python project is fully managed using the [Poetry][poetry] dependency manag
 
 You need at least:
 
-- Python 3.10+
+- Python 3.12+
 - [Poetry][poetry-install]
 - NodeJS 16+ (including NPM)
 

{python_bsblan-0.6.0 → python_bsblan-0.6.2}/README.md

@@ -33,11 +33,37 @@ pip install python-bsblan
 """Asynchronous Python client for BSBLan."""
 
 import asyncio
+import os
 
-from bsblan import BSBLan, Info, State
+from bsblan import BSBLAN, BSBLANConfig, Device, Info, Sensor, State, StaticState
 
 
-async def main(loop):
+async def print_state(state: State) -> None:
+    """Print the current state of the BSBLan device."""
+    print(f"HVAC Action: {state.hvac_action.desc}")
+    print(f"HVAC Mode: {state.hvac_mode.desc}")
+    print(f"Current Temperature: {state.current_temperature.value}")
+
+
+async def print_sensor(sensor: Sensor) -> None:
+    """Print sensor information from the BSBLan device."""
+    print(f"Outside Temperature: {sensor.outside_temperature.value}")
+
+
+async def print_device_info(device: Device, info: Info) -> None:
+    """Print device and general information."""
+    print(f"Device Name: {device.name}")
+    print(f"Version: {device.version}")
+    print(f"Device Identification: {info.device_identification.value}")
+
+
+async def print_static_state(static_state: StaticState) -> None:
+    """Print static state information."""
+    print(f"Min Temperature: {static_state.min_temp.value}")
+    print(f"Max Temperature: {static_state.max_temp.value}")
+
+
+async def main() -> None:
     """Show example on controlling your BSBLan device.
 
     Options:
@@ -45,35 +71,44 @@ async def main(loop):
     - username and password if your device is setup for username/password authentication
 
     """
-    async with BSBLan(
-        host="10.0.1.60", passkey=None, username=None, password=None, loop=loop
-    ) as bsblan:
-        # get state from bsblan device
+    # Create a configuration object
+    config = BSBLANConfig(
+        host="10.0.2.60",
+        passkey=None,
+        username=os.getenv("USERNAME"),  # Compliant
+        password=os.getenv("PASSWORD"),  # Compliant
+    )
+
+    # Initialize BSBLAN with the configuration object
+    async with BSBLAN(config) as bsblan:
+        # Get and print state
         state: State = await bsblan.state()
-        print(state)
+        await print_state(state)
 
-        # set temp thermostat
-        await bsblan.thermostat(target_temperature=19.0)
+        # Set thermostat temperature
+        print("\nSetting temperature to 18°C")
+        await bsblan.thermostat(target_temperature="18")
 
-        # set hvac_mode (0-3) (protection,auto,reduced,comfort)
-        await bsblan.thermostat(hvac_mode=3)
+        # Set HVAC mode
+        print("Setting HVAC mode to heat")
+        await bsblan.thermostat(hvac_mode="heat")
 
-        # get some generic info from the heater
-        info: Info = await bsblan.info()
-        print(info)
+        # Get and print sensor information
+        sensor: Sensor = await bsblan.sensor()
+        await print_sensor(sensor)
 
-        # get device info
+        # Get and print device and general info
         device: Device = await bsblan.device()
-        print(device)
+        info: Info = await bsblan.info()
+        await print_device_info(device, info)
 
-        # get sensor from bsblan device
-        sensor: Sensor = await bsblan.sensor()
-        print(f"outside temperature: {sensor.outside_temperature.value}")
+        # Get and print static state
+        static_state: StaticState = await bsblan.static_values()
+        await print_static_state(static_state)
 
 
 if __name__ == "__main__":
-    loop = asyncio.get_event_loop_policy().get_event_loop()
-    loop.run_until_complete(main())
+    asyncio.run(main())
 ```
 
 ## Changelog & Releases
@@ -106,7 +141,7 @@ This Python project is fully managed using the [Poetry][poetry] dependency manag
 
 You need at least:
 
-- Python 3.10+
+- Python 3.12+
 - [Poetry][poetry-install]
 - NodeJS 16+ (including NPM)
 

{python_bsblan-0.6.0 → python_bsblan-0.6.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-bsblan"
-version = "0.6.00"
+version = "0.6.2"
 description = "Asynchronous Python client for BSBLAN"
 authors = ["Willem-Jan van Rootselaar <liudgervr@gmail.com>"]
 maintainers = ["Willem-Jan van Rootselaar <liudgervr@gmail.com>"]

{python_bsblan-0.6.0 → python_bsblan-0.6.2}/src/bsblan/bsblan.py

@@ -6,12 +6,12 @@ import asyncio
 import logging
 from asyncio.log import logger
 from dataclasses import dataclass, field
-from importlib import metadata
-from typing import TYPE_CHECKING, Any, Mapping, TypedDict, cast
+from typing import Any, Mapping, TypedDict, cast
 
 import aiohttp
 from aiohttp.client import ClientSession
 from aiohttp.hdrs import METH_POST
+from aiohttp.helpers import BasicAuth
 from packaging import version as pkg_version
 from typing_extensions import Self
 from yarl import URL
@@ -39,9 +39,6 @@ from .exceptions import (
 )
 from .models import Device, Info, Sensor, State, StaticState
 
-if TYPE_CHECKING:
-    from aiohttp.helpers import BasicAuth
-
 logging.basicConfig(level=logging.DEBUG)
 
 
@@ -61,7 +58,6 @@ class BSBLANConfig:
 class BSBLAN:
     """Main class for handling connections with BSBLAN."""
 
-    _version: str = ""
     _heating_params: list[str] | None = None
     _string_circuit1: str | None = None
     _sensor_params: list[str] | None = None
@@ -75,17 +71,30 @@ class BSBLAN:
     _auth: BasicAuth | None = None
     _close_session: bool = False
 
-    def __init__(self, config: BSBLANConfig) -> None:
+    def __init__(
+        self,
+        config: BSBLANConfig,
+        session: ClientSession | None = None,
+    ) -> None:
         """Initialize the BSBLAN object.
 
         Args:
         ----
             config: Configuration for the BSBLAN object.
+            session: The aiohttp session to use for the connection.
 
         """
         self.config = config
-        self.session: ClientSession | None = None
-        self._close_session = False
+        self.session = session
+        self._close_session = session is None
+        self._firmware_version: str | None = None
+
+    async def _fetch_firmware_version(self) -> None:
+        """Fetch the firmware version if not already available."""
+        if self._firmware_version is None:
+            device = await self.device()
+            self._firmware_version = device.version
+            logger.debug("BSBLAN version: %s", self._firmware_version)
 
     async def __aenter__(self) -> Self:
         """Enter method for the context manager.
@@ -145,11 +154,6 @@ class BSBLAN:
                 response.
 
         """
-        try:
-            version = metadata.version(__package__ or __name__)
-        except metadata.PackageNotFoundError:
-            version = "0.0.0"
-
         # retrieve passkey for custom url
         if self.config.passkey:
             base_path = f"/{self.config.passkey}{base_path}"
@@ -163,10 +167,10 @@ class BSBLAN:
 
         auth = None
         if self.config.username and self.config.password:
-            auth = aiohttp.BasicAuth(self.config.username, self.config.password)
+            auth = BasicAuth(self.config.username, self.config.password)
 
         headers = {
-            "User-Agent": f"PythonBSBLAN/{version}",
+            "User-Agent": f"PythonBSBLAN/{self._firmware_version}",
             "Accept": "application/json, */*",
         }
 
@@ -265,18 +269,20 @@ class BSBLAN:
             A dictionary with dicts
 
         """
-        if not self._version:
-            device = await self.device()
-            self._version = device.version
-            logger.debug("BSBLAN version: %s", self._version)
-        if pkg_version.parse(self._version) < pkg_version.parse("1.2.0"):
+        await self._fetch_firmware_version()
+
+        if self._firmware_version is None:
+            msg = "Unable to fetch firmware version"
+            raise BSBLANError(msg)
+
+        if pkg_version.parse(self._firmware_version) < pkg_version.parse("1.2.0"):
             return {
                 "heating": HEATING_CIRCUIT1_API_V1,
                 "staticValues": STATIC_VALUES_API_V1,
                 "device": DEVICE_INFO_API_V1,
                 "sensor": SENSORS_API_V1,
             }
-        if pkg_version.parse(self._version) > pkg_version.parse("3.0.0"):
+        if pkg_version.parse(self._firmware_version) > pkg_version.parse("3.0.0"):
             return {
                 "heating": HEATING_CIRCUIT1_API_V3,
                 "staticValues": STATIC_VALUES_API_V3,