aiohomematic 2025.9.1__py3-none-any.whl → 2025.9.2__py3-none-any.whl

aiohomematic/caches/dynamic.py

@@ -27,13 +27,11 @@ from collections.abc import Mapping
 from datetime import datetime
 import logging
 from typing import Any, Final, cast
-from urllib.parse import unquote
 
 from aiohomematic import central as hmcu
 from aiohomematic.const import (
     DP_KEY_VALUE,
     INIT_DATETIME,
-    ISO_8859_1,
     LAST_COMMAND_SEND_STORE_TIMEOUT,
     MAX_CACHE_AGE,
     NO_CACHE_ENTRY,
@@ -312,10 +310,7 @@ class CentralDataCache:
 
     def add_data(self, interface: Interface, all_device_data: Mapping[str, Any]) -> None:
         """Add data to cache."""
-        self._value_cache[interface] = {
-            unquote(string=k, encoding=ISO_8859_1): unquote(string=v, encoding=ISO_8859_1) if isinstance(v, str) else v
-            for k, v in all_device_data.items()
-        }
+        self._value_cache[interface] = all_device_data
         self._refreshed_at[interface] = datetime.now()
 
     def get_data(

aiohomematic/central/__init__.py

@@ -149,7 +149,6 @@ from aiohomematic.exceptions import (
 from aiohomematic.model import create_data_points_and_events
 from aiohomematic.model.custom import CustomDataPoint, create_custom_data_points
 from aiohomematic.model.data_point import BaseParameterDataPoint, CallbackDataPoint
-from aiohomematic.model.decorators import info_property
 from aiohomematic.model.device import Channel, Device
 from aiohomematic.model.event import GenericEvent
 from aiohomematic.model.generic import GenericDataPoint
@@ -160,8 +159,16 @@ from aiohomematic.model.hub import (
     Hub,
     ProgramDpType,
 )
-from aiohomematic.model.support import PayloadMixin
-from aiohomematic.support import check_config, extract_exc_args, get_channel_no, get_device_address, get_ip_addr
+from aiohomematic.property_decorators import info_property
+from aiohomematic.support import (
+    LogContextMixin,
+    PayloadMixin,
+    check_config,
+    extract_exc_args,
+    get_channel_no,
+    get_device_address,
+    get_ip_addr,
+)
 
 __all__ = ["CentralConfig", "CentralUnit", "INTERFACE_EVENT_SCHEMA"]
 
@@ -183,7 +190,7 @@ INTERFACE_EVENT_SCHEMA = vol.Schema(
 )
 
 
-class CentralUnit(PayloadMixin):
+class CentralUnit(LogContextMixin, PayloadMixin):
     """Central unit that collects everything to handle communication from/to CCU/Homegear."""
 
     def __init__(self, central_config: CentralConfig) -> None:
@@ -212,7 +219,7 @@ class CentralUnit(PayloadMixin):
         # {interface_id, client}
         self._clients: Final[dict[str, hmcl.Client]] = {}
         self._data_point_key_event_subscriptions: Final[
-            dict[DataPointKey, list[Callable[[Any], Coroutine[Any, Any, None]]]]
+            dict[DataPointKey, list[Callable[[Any, datetime], Coroutine[Any, Any, None]]]]
         ] = {}
         self._data_point_path_event_subscriptions: Final[dict[str, DataPointKey]] = {}
         self._sysvar_data_point_event_subscriptions: Final[dict[str, Callable]] = {}
@@ -237,7 +244,7 @@ class CentralUnit(PayloadMixin):
         self._hub: Hub = Hub(central=self)
         self._version: str | None = None
         # store last event received datetime by interface_id
-        self._last_events: Final[dict[str, datetime]] = {}
+        self._last_event_seen_for_interface: Final[dict[str, datetime]] = {}
         self._xml_rpc_callback_ip: str = IP_ANY_V4
         self._listen_ip_addr: str = IP_ANY_V4
         self._listen_port: int = PORT_ANY
@@ -252,7 +259,7 @@ class CentralUnit(PayloadMixin):
         """Return the xml rpc server callback ip address."""
         return self._xml_rpc_callback_ip
 
-    @info_property
+    @info_property(log_context=True)
     def url(self) -> str:
         """Return the central url."""
         return self._url
@@ -362,14 +369,14 @@ class CentralUnit(PayloadMixin):
         """Return the loop support."""
         return self._looper
 
-    @info_property
+    @info_property(log_context=True)
     def model(self) -> str | None:
         """Return the model of the backend."""
         if not self._model and (client := self.primary_client):
             self._model = client.model
         return self._model
 
-    @info_property
+    @info_property(log_context=True)
     def name(self) -> str:
         """Return the name of the backend."""
         return self._config.name
@@ -1109,7 +1116,7 @@ class CentralUnit(PayloadMixin):
         if not self.has_client(interface_id=interface_id):
             return
 
-        self.set_last_event_dt(interface_id=interface_id)
+        self.set_last_event_seen_for_interface(interface_id=interface_id)
         # No need to check the response of a XmlRPC-PING
         if parameter == Parameter.PONG:
             if "#" in value:
@@ -1133,9 +1140,10 @@ class CentralUnit(PayloadMixin):
 
         if dpk in self._data_point_key_event_subscriptions:
             try:
+                received_at = datetime.now()
                 for callback_handler in self._data_point_key_event_subscriptions[dpk]:
                     if callable(callback_handler):
-                        await callback_handler(value)
+                        await callback_handler(value, received_at)
             except RuntimeError as rterr:  # pragma: no cover
                 _LOGGER_EVENT.debug(
                     "EVENT: RuntimeError [%s]. Failed to call callback for: %s, %s, %s",
@@ -1184,7 +1192,10 @@ class CentralUnit(PayloadMixin):
             try:
                 callback_handler = self._sysvar_data_point_event_subscriptions[state_path]
                 if callable(callback_handler):
-                    self._looper.create_task(callback_handler(value), name=f"sysvar-data-point-event-{state_path}")
+                    received_at = datetime.now()
+                    self._looper.create_task(
+                        callback_handler(value, received_at), name=f"sysvar-data-point-event-{state_path}"
+                    )
             except RuntimeError as rterr:  # pragma: no cover
                 _LOGGER_EVENT.debug(
                     "EVENT: RuntimeError [%s]. Failed to call callback for: %s",
@@ -1207,7 +1218,7 @@ class CentralUnit(PayloadMixin):
 
     def add_event_subscription(self, data_point: BaseParameterDataPoint) -> None:
         """Add data_point to central event subscription."""
-        if isinstance(data_point, (GenericDataPoint, GenericEvent)) and (
+        if isinstance(data_point, GenericDataPoint | GenericEvent) and (
             data_point.is_readable or data_point.supports_events
         ):
             if data_point.dpk not in self._data_point_key_event_subscriptions:
@@ -1219,13 +1230,13 @@ class CentralUnit(PayloadMixin):
             ):
                 self._data_point_path_event_subscriptions[data_point.state_path] = data_point.dpk
 
-    @inspector()
+    @inspector
     async def create_central_links(self) -> None:
         """Create a central links to support press events on all channels with click events."""
         for device in self.devices:
             await device.create_central_links()
 
-    @inspector()
+    @inspector
     async def remove_central_links(self) -> None:
         """Remove central links."""
         for device in self.devices:
@@ -1248,19 +1259,19 @@ class CentralUnit(PayloadMixin):
 
     def remove_event_subscription(self, data_point: BaseParameterDataPoint) -> None:
         """Remove event subscription from central collections."""
-        if isinstance(data_point, (GenericDataPoint, GenericEvent)) and data_point.supports_events:
+        if isinstance(data_point, GenericDataPoint | GenericEvent) and data_point.supports_events:
             if data_point.dpk in self._data_point_key_event_subscriptions:
                 del self._data_point_key_event_subscriptions[data_point.dpk]
             if data_point.state_path in self._data_point_path_event_subscriptions:
                 del self._data_point_path_event_subscriptions[data_point.state_path]
 
-    def get_last_event_dt(self, interface_id: str) -> datetime | None:
-        """Return the last event dt."""
-        return self._last_events.get(interface_id)
+    def get_last_event_seen_for_interface(self, interface_id: str) -> datetime | None:
+        """Return the last event seen for an interface."""
+        return self._last_event_seen_for_interface.get(interface_id)
 
-    def set_last_event_dt(self, interface_id: str) -> None:
-        """Set the last event dt."""
-        self._last_events[interface_id] = datetime.now()
+    def set_last_event_seen_for_interface(self, interface_id: str) -> None:
+        """Set the last event seen for an interface."""
+        self._last_event_seen_for_interface[interface_id] = datetime.now()
 
     async def execute_program(self, pid: str) -> bool:
         """Execute a program on CCU / Homegear."""
@@ -1703,7 +1714,7 @@ class _Scheduler(threading.Thread):
             _LOGGER.debug("REFRESH_CLIENT_DATA: Loading data for %s", self._central.name)
             for client in poll_clients:
                 await self._central.load_and_refresh_data_point_data(interface=client.interface)
-                self._central.set_last_event_dt(interface_id=client.interface_id)
+                self._central.set_last_event_seen_for_interface(interface_id=client.interface_id)
 
     @inspector(re_raise=False)
     async def _refresh_sysvar_data(self) -> None:

aiohomematic/central/xml_rpc_server.py

@@ -57,7 +57,7 @@ class RPCFunctions:
                 action="error",
                 err=err,
                 level=logging.WARNING,
-                context={"interface_id": interface_id, "error_code": int(error_code)},
+                log_context={"interface_id": interface_id, "error_code": int(error_code)},
             )
         _LOGGER.warning(
             "ERROR failed: interface_id = %s, error_code = %i, message = %s",

aiohomematic/client/__init__.py

@@ -93,7 +93,9 @@ from aiohomematic.decorators import inspector, measure_execution_time
 from aiohomematic.exceptions import BaseHomematicException, ClientException, NoConnectionException
 from aiohomematic.model.device import Device
 from aiohomematic.model.support import convert_value
+from aiohomematic.property_decorators import info_property
 from aiohomematic.support import (
+    LogContextMixin,
     build_xml_rpc_headers,
     build_xml_rpc_uri,
     extract_exc_args,
@@ -124,7 +126,7 @@ _CCU_JSON_VALUE_TYPE: Final = {
 }
 
 
-class Client(ABC):
+class Client(ABC, LogContextMixin):
     """Client object to access the backends via XML-RPC or JSON-RPC."""
 
     def __init__(self, client_config: _ClientConfig) -> None:
@@ -144,6 +146,7 @@ class Client(ABC):
         self._system_information: SystemInformation
         self.modified_at: datetime = INIT_DATETIME
 
+    @inspector
     async def init_client(self) -> None:
         """Init the client."""
         self._system_information = await self._get_system_information()
@@ -168,7 +171,7 @@ class Client(ABC):
         """Return the interface of the client."""
         return self._config.interface
 
-    @property
+    @info_property(log_context=True)
     def interface_id(self) -> str:
         """Return the interface id of the client."""
         return self._config.interface_id
@@ -384,7 +387,9 @@ class Client(ABC):
         """Return if XmlRPC-Server is alive based on received events for this client."""
         if not self.supports_ping_pong:
             return True
-        if (last_events_dt := self.central.get_last_event_dt(interface_id=self.interface_id)) is not None:
+        if (
+            last_events_dt := self.central.get_last_event_seen_for_interface(interface_id=self.interface_id)
+        ) is not None:
             if (seconds_since_last_event := (datetime.now() - last_events_dt).total_seconds()) > CALLBACK_WARN_INTERVAL:
                 if self._is_callback_alive:
                     self.central.fire_interface_event(
@@ -418,12 +423,12 @@ class Client(ABC):
         """Send ping to CCU to generate PONG event."""
 
     @abstractmethod
-    @inspector()
+    @inspector
     async def execute_program(self, pid: str) -> bool:
         """Execute a program on CCU / Homegear."""
 
     @abstractmethod
-    @inspector()
+    @inspector
     async def set_program_state(self, pid: str, state: bool) -> bool:
         """Set the program state on CCU / Homegear."""
 
@@ -433,12 +438,12 @@ class Client(ABC):
         """Set a system variable on CCU / Homegear."""
 
     @abstractmethod
-    @inspector()
+    @inspector
     async def delete_system_variable(self, name: str) -> bool:
         """Delete a system variable from CCU / Homegear."""
 
     @abstractmethod
-    @inspector()
+    @inspector
     async def get_system_variable(self, name: str) -> Any:
         """Get single system variable from CCU / Homegear."""
 
@@ -489,7 +494,7 @@ class Client(ABC):
             _LOGGER.warning("GET_DEVICE_DESCRIPTIONS failed: %s [%s]", bhexc.name, extract_exc_args(exc=bhexc))
         return None
 
-    @inspector()
+    @inspector
     async def add_link(self, sender_address: str, receiver_address: str, name: str, description: str) -> None:
         """Return a list of links."""
         try:
@@ -499,7 +504,7 @@ class Client(ABC):
                 f"ADD_LINK failed with for: {sender_address}/{receiver_address}/{name}/{description}: {extract_exc_args(exc=bhexc)}"
             ) from bhexc
 
-    @inspector()
+    @inspector
     async def remove_link(self, sender_address: str, receiver_address: str) -> None:
         """Return a list of links."""
         try:
@@ -509,7 +514,7 @@ class Client(ABC):
                 f"REMOVE_LINK failed with for: {sender_address}/{receiver_address}: {extract_exc_args(exc=bhexc)}"
             ) from bhexc
 
-    @inspector()
+    @inspector
     async def get_link_peers(self, address: str) -> tuple[str, ...] | None:
         """Return a list of link pers."""
         try:
@@ -519,7 +524,7 @@ class Client(ABC):
                 f"GET_LINK_PEERS failed with for: {address}: {extract_exc_args(exc=bhexc)}"
             ) from bhexc
 
-    @inspector()
+    @inspector
     async def get_links(self, address: str, flags: int) -> dict[str, Any]:
         """Return a list of links."""
         try:
@@ -527,7 +532,7 @@ class Client(ABC):
         except BaseHomematicException as bhexc:
             raise ClientException(f"GET_LINKS failed with for: {address}: {extract_exc_args(exc=bhexc)}") from bhexc
 
-    @inspector()
+    @inspector
     async def get_metadata(self, address: str, data_id: str) -> dict[str, Any]:
         """Return the metadata for an object."""
         try:
@@ -537,7 +542,7 @@ class Client(ABC):
                 f"GET_METADATA failed with for: {address}/{data_id}: {extract_exc_args(exc=bhexc)}"
             ) from bhexc
 
-    @inspector()
+    @inspector
     async def set_metadata(self, address: str, data_id: str, value: dict[str, Any]) -> dict[str, Any]:
         """Write the metadata for an object."""
         try:
@@ -694,7 +699,7 @@ class Client(ABC):
             check_against_pd=check_against_pd,
         )
 
-    @inspector()
+    @inspector
     async def get_paramset(
         self,
         address: str,
@@ -957,7 +962,7 @@ class Client(ABC):
             )
         return None
 
-    @inspector()
+    @inspector
     async def get_all_paramset_descriptions(
         self, device_descriptions: tuple[DeviceDescription, ...]
     ) -> dict[str, dict[ParamsetKey, dict[str, ParameterData]]]:
@@ -967,7 +972,7 @@ class Client(ABC):
             all_paramsets.update(await self.get_paramset_descriptions(device_description=device_description))
         return all_paramsets
 
-    @inspector()
+    @inspector
     async def has_program_ids(self, channel_hmid: str) -> bool:
         """Return if a channel has program ids."""
         return False
@@ -985,12 +990,12 @@ class Client(ABC):
             )
         return None
 
-    @inspector()
+    @inspector
     async def report_value_usage(self, address: str, value_id: str, ref_counter: int) -> bool:
         """Report value usage."""
         return False
 
-    @inspector()
+    @inspector
     async def update_device_firmware(self, device_address: str) -> bool:
         """Update the firmware of a homematic device."""
         if device := self.central.get_device(address=device_address):
@@ -1133,22 +1138,22 @@ class ClientCCU(Client):
         self.modified_at = INIT_DATETIME
         return False
 
-    @inspector()
+    @inspector
     async def execute_program(self, pid: str) -> bool:
         """Execute a program on CCU."""
         return await self._json_rpc_client.execute_program(pid=pid)
 
-    @inspector()
+    @inspector
     async def set_program_state(self, pid: str, state: bool) -> bool:
         """Set the program state on CCU."""
         return await self._json_rpc_client.set_program_state(pid=pid, state=state)
 
-    @inspector()
+    @inspector
     async def has_program_ids(self, channel_hmid: str) -> bool:
         """Return if a channel has program ids."""
         return await self._json_rpc_client.has_program_ids(channel_hmid=channel_hmid)
 
-    @inspector()
+    @inspector
     async def report_value_usage(self, address: str, value_id: str, ref_counter: int) -> bool:
         """Report value usage."""
         try:
@@ -1163,12 +1168,12 @@ class ClientCCU(Client):
         """Set a system variable on CCU / Homegear."""
         return await self._json_rpc_client.set_system_variable(legacy_name=legacy_name, value=value)
 
-    @inspector()
+    @inspector
     async def delete_system_variable(self, name: str) -> bool:
         """Delete a system variable from CCU / Homegear."""
         return await self._json_rpc_client.delete_system_variable(name=name)
 
-    @inspector()
+    @inspector
     async def get_system_variable(self, name: str) -> Any:
         """Get single system variable from CCU / Homegear."""
         return await self._json_rpc_client.get_system_variable(name=name)
@@ -1217,6 +1222,7 @@ class ClientCCU(Client):
 class ClientJsonCCU(ClientCCU):
     """Client implementation for CCU backend."""
 
+    @inspector
     async def init_client(self) -> None:
         """Init the client."""
         self._system_information = await self._get_system_information()
@@ -1243,7 +1249,7 @@ class ClientJsonCCU(ClientCCU):
             _LOGGER.warning("GET_DEVICE_DESCRIPTIONS failed: %s [%s]", bhexc.name, extract_exc_args(exc=bhexc))
         return None
 
-    @inspector()
+    @inspector
     async def get_paramset(
         self,
         address: str,
@@ -1473,12 +1479,12 @@ class ClientHomegear(Client):
         self.modified_at = INIT_DATETIME
         return False
 
-    @inspector()
+    @inspector
     async def execute_program(self, pid: str) -> bool:
         """Execute a program on Homegear."""
         return True
 
-    @inspector()
+    @inspector
     async def set_program_state(self, pid: str, state: bool) -> bool:
         """Set the program state on Homegear."""
         return True
@@ -1489,13 +1495,13 @@ class ClientHomegear(Client):
         await self._proxy.setSystemVariable(legacy_name, value)
         return True
 
-    @inspector()
+    @inspector
     async def delete_system_variable(self, name: str) -> bool:
         """Delete a system variable from CCU / Homegear."""
         await self._proxy.deleteSystemVariable(name)
         return True
 
-    @inspector()
+    @inspector
     async def get_system_variable(self, name: str) -> Any:
         """Get single system variable from CCU / Homegear."""
         return await self._proxy.getSystemVariable(name)

aiohomematic/client/json_rpc.py

@@ -47,10 +47,12 @@ from urllib.parse import unquote
 
 from aiohttp import (
     ClientConnectorCertificateError,
+    ClientConnectorError,
     ClientError,
     ClientResponse,
     ClientSession,
     ClientTimeout,
+    ContentTypeError,
     TCPConnector,
 )
 import orjson
@@ -89,7 +91,9 @@ from aiohomematic.exceptions import (
     UnsupportedException,
 )
 from aiohomematic.model.support import convert_value
+from aiohomematic.property_decorators import info_property
 from aiohomematic.support import (
+    LogContextMixin,
     cleanup_text_from_html_tags,
     element_matches_key,
     extract_exc_args,
@@ -175,7 +179,7 @@ _PARALLEL_EXECUTION_LIMITED_JSONRPC_METHODS: Final = (
 )
 
 
-class JsonRpcAioHttpClient:
+class JsonRpcAioHttpClient(LogContextMixin):
     """Connection to CCU JSON-RPC Server."""
 
     def __init__(
@@ -213,6 +217,16 @@ class JsonRpcAioHttpClient:
         """If session exists, then it is activated."""
         return self._session_id is not None
 
+    @info_property(log_context=True)
+    def url(self) -> str | None:
+        """Return url."""
+        return self._url
+
+    @info_property(log_context=True)
+    def tls(self) -> bool:
+        """Return tls."""
+        return self._tls
+
     async def _login_or_renew(self) -> bool:
         """Renew JSON-RPC session or perform login."""
         if not self.is_activated:
@@ -425,7 +439,7 @@ class JsonRpcAioHttpClient:
                         action=str(method),
                         err=exc,
                         level=logging.WARNING,
-                        context={"url": self._url},
+                        log_context=self.log_context,
                     )
                     _LOGGER.debug("POST: %s", exc)
                     raise exc
@@ -443,7 +457,7 @@ class JsonRpcAioHttpClient:
                     action=str(method),
                     err=exc,
                     level=logging.WARNING,
-                    context={"url": self._url, "status": response.status},
+                    log_context=dict(self.log_context) | {"status": response.status},
                 )
                 raise exc
             raise ClientException(message)
@@ -457,9 +471,22 @@ class JsonRpcAioHttpClient:
                 action=str(method),
                 err=bhe,
                 level=logging.WARNING,
-                context={"url": self._url},
+                log_context=self.log_context,
             )
             raise
+
+        except ClientConnectorError as cceerr:
+            self.clear_session()
+            message = f"ClientConnectorError[{cceerr}]"
+            log_boundary_error(
+                logger=_LOGGER,
+                boundary="json-rpc",
+                action=str(method),
+                err=cceerr,
+                level=logging.ERROR,
+                log_context=self.log_context,
+            )
+            raise ClientException(message) from cceerr
         except ClientConnectorCertificateError as cccerr:
             self.clear_session()
             message = f"ClientConnectorCertificateError[{cccerr}]"
@@ -474,7 +501,7 @@ class JsonRpcAioHttpClient:
                 action=str(method),
                 err=cccerr,
                 level=logging.ERROR,
-                context={"url": self._url},
+                log_context=self.log_context,
             )
             raise ClientException(message) from cccerr
         except (ClientError, OSError) as err:
@@ -485,7 +512,7 @@ class JsonRpcAioHttpClient:
                 action=str(method),
                 err=err,
                 level=logging.ERROR,
-                context={"url": self._url},
+                log_context=self.log_context,
             )
             raise NoConnectionException(err) from err
         except (TypeError, Exception) as exc:
@@ -496,7 +523,7 @@ class JsonRpcAioHttpClient:
                 action=str(method),
                 err=exc,
                 level=logging.ERROR,
-                context={"url": self._url},
+                log_context=self.log_context,
             )
             raise ClientException(exc) from exc
 
@@ -1014,7 +1041,7 @@ class JsonRpcAioHttpClient:
 
     async def get_all_device_data(self, interface: Interface) -> Mapping[str, Any]:
         """Get the all device data of the backend."""
-        all_device_data: dict[str, dict[str, dict[str, Any]]] = {}
+        all_device_data: dict[str, Any] = {}
         params = {
             _JsonKey.INTERFACE: interface,
         }
@@ -1023,12 +1050,17 @@ class JsonRpcAioHttpClient:
 
             _LOGGER.debug("GET_ALL_DEVICE_DATA: Getting all device data for interface %s", interface)
             if json_result := response[_JsonKey.RESULT]:
-                all_device_data = json_result
-
-        except JSONDecodeError as jderr:
+                all_device_data = {
+                    unquote(string=k, encoding=ISO_8859_1): unquote(string=v, encoding=ISO_8859_1)
+                    if isinstance(v, str)
+                    else v
+                    for k, v in json_result.items()
+                }
+
+        except (ContentTypeError, JSONDecodeError) as cerr:
             raise ClientException(
                 f"GET_ALL_DEVICE_DATA failed: Unable to fetch device data for interface {interface}"
-            ) from jderr
+            ) from cerr
 
         return all_device_data