Merge pull request #237 from plugwise/async-sq-fixes

Various fixes for SQ-reports

Author: bouwew

plugwise_usb/connection/__init__.py

@@ -156,9 +156,8 @@ async def _handle_stick_event(self, event: StickEvent) -> None:
             if not self._queue.is_running:
                 self._queue.start(self._manager)
                 await self.initialize_stick()
-        elif event == StickEvent.DISCONNECTED:
-            if self._queue.is_running:
-                await self._queue.stop()
+        elif event == StickEvent.DISCONNECTED and self._queue.is_running:
+            await self._queue.stop()
 
     async def initialize_stick(self) -> None:
         """Initialize connection to the USB-stick."""

plugwise_usb/messages/requests.py

@@ -283,27 +283,34 @@ async def process_node_response(self, response: PlugwiseResponse) -> bool:
 
     async def _process_stick_response(self, stick_response: StickResponse) -> None:
         """Process incoming stick response."""
-        if self._response_future.done():
+        if (
+            self._response_future.done()
+            or self._seq_id is None
+            or self._seq_id != stick_response.seq_id
+        ):
             return
-        if self._seq_id is None or self._seq_id != stick_response.seq_id:
+
+        if stick_response.ack_id == StickResponseType.ACCEPT:
             return
+
         if stick_response.ack_id == StickResponseType.TIMEOUT:
             self._response_timeout_expired(stick_timeout=True)
-        elif stick_response.ack_id == StickResponseType.FAILED:
+            return
+
+        if stick_response.ack_id == StickResponseType.FAILED:
             self._unsubscribe_from_node()
             self._seq_id = None
             self._response_future.set_exception(
                 NodeError(f"Stick failed request {self._seq_id}")
             )
-        elif stick_response.ack_id == StickResponseType.ACCEPT:
-            pass
-        else:
-            _LOGGER.debug(
-                "Unknown StickResponseType %s at %s for request %s",
-                str(stick_response.ack_id),
-                stick_response,
-                self,
-            )
+            return
+
+        _LOGGER.debug(
+            "Unknown StickResponseType %s at %s for request %s",
+            str(stick_response.ack_id),
+            stick_response,
+            self,
+        )
 
     async def _send_request(self, suppress_node_errors=False) -> PlugwiseResponse | None:
         """Send request."""
@@ -1287,11 +1294,11 @@ def __init__(
         self,
         send_fn: Callable[[PlugwiseRequest, bool], Awaitable[PlugwiseResponse | None]],
         mac: bytes,
-        taskId: int,
+        task_id: int,
     ) -> None:
         """Initialize NodeClearGroupMacRequest message object."""
         super().__init__(send_fn, mac)
-        self._args.append(Int(taskId, length=2))
+        self._args.append(Int(task_id, length=2))
 
 
 class CircleSetScheduleValueRequest(PlugwiseRequest):

plugwise_usb/messages/responses.py

@@ -590,25 +590,17 @@ def __init__(self, protocol_version: str = "2.0") -> None:
         """Initialize NodeInfoResponse message object."""
         super().__init__(b"0024")
 
+        self.datetime = DateTime()
         self._logaddress_pointer = LogAddr(0, length=8)
-        if protocol_version == "1.0":
-            # FIXME: Define "absoluteHour" variable
-            self.datetime = DateTime()
+        if protocol_version in ("1.0", "2.0"):
+            # FIXME 1.0: Define "absoluteHour" variable
             self._relay_state = Int(0, length=2)
             self._params += [
                 self.datetime,
                 self._logaddress_pointer,
                 self._relay_state,
             ]
-        elif protocol_version == "2.0":
-            self.datetime = DateTime()
-            self._relay_state = Int(0, length=2)
-            self._params += [
-                self.datetime,
-                self._logaddress_pointer,
-                self._relay_state,
-            ]
-        elif protocol_version == "2.3":
+        if protocol_version == "2.3":
             # FIXME: Define "State_mask" variable
             self.state_mask = Int(0, length=2)
             self._params += [

plugwise_usb/network/__init__.py

@@ -208,30 +208,34 @@ async def _handle_stick_event(self, event: StickEvent) -> None:
             await gather(*[node.disconnect() for node in self._nodes.values()])
             self._is_running = False
 
-    async def node_awake_message(self, response: PlugwiseResponse) -> bool:
+    async def node_awake_message(self, response: PlugwiseResponse) -> None:
         """Handle NodeAwakeResponse message."""
         if not isinstance(response, NodeAwakeResponse):
             raise MessageError(
                 f"Invalid response message type ({response.__class__.__name__}) received, expected NodeAwakeResponse"
             )
+
         mac = response.mac_decoded
         if self._awake_discovery.get(mac) is None:
             self._awake_discovery[mac] = response.timestamp - timedelta(seconds=15)
+
         if mac in self._nodes:
             if self._awake_discovery[mac] < (
                 response.timestamp - timedelta(seconds=10)
             ):
                 await self._notify_node_event_subscribers(NodeEvent.AWAKE, mac)
             self._awake_discovery[mac] = response.timestamp
-            return True
+            return
+
         if (address := self._register.network_address(mac)) is None:
             if self._register.scan_completed:
-                return True
+                return
+
             _LOGGER.debug(
                 "Skip node awake message for %s because network registry address is unknown",
                 mac,
             )
-            return True
+            return
 
         if self._nodes.get(mac) is None:
             if (
@@ -243,7 +247,6 @@ async def node_awake_message(self, response: PlugwiseResponse) -> bool:
                 )
             else:
                 _LOGGER.debug("duplicate maintenance awake discovery for %s", mac)
-        return True
 
     async def node_join_available_message(self, response: PlugwiseResponse) -> bool:
         """Handle NodeJoinAvailableResponse messages."""
@@ -275,11 +278,8 @@ async def node_rejoin_message(self, response: PlugwiseResponse) -> bool:
                 raise NodeError(f"Failed to obtain address for node {mac}")
 
         if self._nodes.get(mac) is None:
-            if self._discover_sed_tasks.get(mac) is None:
-                self._discover_sed_tasks[mac] = create_task(
-                    self._discover_battery_powered_node(address, mac)
-                )
-            elif self._discover_sed_tasks[mac].done():
+            task = self._discover_sed_tasks.get(mac)
+            if task is None or task.done():
                 self._discover_sed_tasks[mac] = create_task(
                     self._discover_battery_powered_node(address, mac)
                 )

plugwise_usb/network/registry.py

@@ -145,7 +145,6 @@ async def retrieve_network_registration(
                 return await self.retrieve_network_registration(address, retry=False)
             return None
         address = response.network_address
-        mac_of_node = response.registered_mac
         if (mac_of_node := response.registered_mac) == "FFFFFFFFFFFFFFFF":
             mac_of_node = ""
         return (address, mac_of_node)

plugwise_usb/nodes/celsius.py

@@ -27,22 +27,22 @@ async def load(self) -> bool:
         """Load and activate node features."""
         if self._loaded:
             return True
-        self._node_info.is_battery_powered = True
 
+        self._node_info.is_battery_powered = True
+        mac = self._node_info.mac
         if self._cache_enabled:
-            _LOGGER.debug(
-                "Load Celsius node %s from cache", self._node_info.mac
-            )
-            if await self._load_from_cache():
-                pass
+            _LOGGER.debug("Loading Celsius node %s from cache", mac)
+            if not await self._load_from_cache():
+                _LOGGER.debug("Loading Celsius node %s from cache failed", mac)
 
         self._loaded = True
         self._setup_protocol(
             CELSIUS_FIRMWARE_SUPPORT,
             (NodeFeature.INFO, NodeFeature.TEMPERATURE),
         )
         if await self.initialize():
-            await self._loaded_callback(NodeEvent.LOADED, self.mac)
+            await self._loaded_callback(NodeEvent.LOADED, mac)
             return True
-        _LOGGER.debug("Load of Celsius node %s failed", self._node_info.mac)
+
+        _LOGGER.debug("Loading of Celsius node %s failed", mac)
         return False

plugwise_usb/nodes/circle.py

@@ -38,7 +38,7 @@
     EnergyCalibrationRequest,
     NodeInfoRequest,
 )
-from ..messages.responses import NodeInfoResponse, NodeResponse, NodeResponseType
+from ..messages.responses import NodeInfoResponse, NodeResponseType
 from .helpers import EnergyCalibration, raise_not_loaded
 from .helpers.counter import EnergyCounters
 from .helpers.firmware import CIRCLE_FIRMWARE_SUPPORT
@@ -532,7 +532,6 @@ async def energy_log_update(self, address: int | None) -> bool:
 
     async def _energy_log_records_load_from_cache(self) -> bool:
         """Load energy_log_record from cache."""
-        cache_data = self._get_cache(CACHE_ENERGY_COLLECTION)
         if (cache_data := self._get_cache(CACHE_ENERGY_COLLECTION)) is None:
             _LOGGER.warning(
                 "Failed to restore energy log records from cache for node %s", self.name
@@ -733,7 +732,6 @@ async def clock_synchronize(self) -> bool:
             datetime.now(tz=UTC),
             self._node_protocols.max,
         )
-        node_response: NodeResponse | None = await set_clock_request.send()
         if (node_response := await set_clock_request.send()) is None:
             _LOGGER.warning(
                 "Failed to (re)set the internal clock of %s",
@@ -849,12 +847,14 @@ async def initialize(self) -> bool:
             )
             self._initialized = False
             return False
+
         if not self._calibration and not await self.calibration_update():
             _LOGGER.debug(
                 "Failed to initialized node %s, no calibration", self._mac_in_str
             )
             self._initialized = False
             return False
+
         if (
             self.skip_update(self._node_info, 30)
             and await self.node_info_update() is None
@@ -869,7 +869,9 @@ async def initialize(self) -> bool:
                 )
                 self._initialized = False
                 return False
-        return await super().initialize()
+
+        await super().initialize()
+        return True
 
     async def node_info_update(
         self, node_info: NodeInfoResponse | None = None
@@ -1083,15 +1085,14 @@ def _correct_power_pulses(self, pulses: int, offset: int) -> float:
     async def get_state(self, features: tuple[NodeFeature]) -> dict[NodeFeature, Any]:
         """Update latest state for given feature."""
         states: dict[NodeFeature, Any] = {}
-        if not self._available:
-            if not await self.is_online():
-                _LOGGER.debug(
-                    "Node %s did not respond, unable to update state", self._mac_in_str
-                )
-                for feature in features:
-                    states[feature] = None
-                states[NodeFeature.AVAILABLE] = self.available_state
-                return states
+        if not self._available and not await self.is_online():
+            _LOGGER.debug(
+                "Node %s did not respond, unable to update state", self._mac_in_str
+            )
+            for feature in features:
+                states[feature] = None
+            states[NodeFeature.AVAILABLE] = self.available_state
+            return states
 
         for feature in features:
             if feature not in self._features:

plugwise_usb/nodes/helpers/counter.py

@@ -82,9 +82,8 @@ def add_pulse_log(  # pylint: disable=too-many-arguments
         """Add pulse log."""
         if self._pulse_collection.add_log(
             address, slot, timestamp, pulses, import_only
-        ):
-            if not import_only:
-                self.update()
+        ) and not import_only:
+            self.update()
 
     def get_pulse_logs(self) -> dict[int, dict[int, PulseLogRecord]]:
         """Return currently collected pulse logs."""

plugwise_usb/nodes/helpers/pulses.py

@@ -935,8 +935,6 @@ def _missing_addresses_before(
         ):
             # Use consumption interval
             calc_interval_cons = timedelta(minutes=self._log_interval_consumption)
-            if self._log_interval_consumption == 0:
-                pass
 
         if not self._log_production:
             expected_timestamp = (

plugwise_usb/nodes/node.py

@@ -337,14 +337,14 @@ def _setup_protocol(
         for feature in node_features:
             if (
                 required_version := FEATURE_SUPPORTED_AT_FIRMWARE.get(feature)
-            ) is not None:
-                if (
-                    self._node_protocols.min
-                    <= required_version
-                    <= self._node_protocols.max
-                    and feature not in self._features
-                ):
-                    self._features += (feature,)
+            ) is not None and (
+                self._node_protocols.min
+                <= required_version
+                <= self._node_protocols.max
+                and feature not in self._features
+            ):
+                self._features += (feature,)
+
         self._node_info.features = self._features
 
     async def reconnect(self) -> None:
@@ -398,15 +398,15 @@ async def _load_from_cache(self) -> bool:
             return False
         return True
 
-    async def initialize(self) -> bool:
+    async def initialize(self) -> None:
         """Initialize node configuration."""
         if self._initialized:
-            return True
+            return
+
         self._initialization_delay_expired = datetime.now(tz=UTC) + timedelta(
             minutes=SUPPRESS_INITIALIZATION_WARNINGS
         )
         self._initialized = True
-        return True
 
     async def _available_update_state(
         self, available: bool, timestamp: datetime | None = None