velbus-aio 2021.8.7__py3-none-any.whl → 2025.11.0__py3-none-any.whl

velbusaio/handler.py

@@ -2,184 +2,350 @@
 Velbus packet handler
 :Author maikel punie <maikel.punie@gmail.com>
 """
+
 from __future__ import annotations
 
+import asyncio
+import importlib.resources
 import json
 import logging
-import re
+import os
+import pathlib
+import sys
+import time
+from typing import TYPE_CHECKING
 
-import pkg_resources
+from aiofile import async_open
 
 from velbusaio.command_registry import commandRegistry
-from velbusaio.const import RTR
-from velbusaio.helpers import h2, keys_exists
-from velbusaio.message import Message
+from velbusaio.const import (
+    SCAN_MODULEINFO_TIMEOUT_INITIAL,
+    SCAN_MODULEINFO_TIMEOUT_INTERVAL,
+    SCAN_MODULETYPE_TIMEOUT,
+)
 from velbusaio.messages.module_subtype import ModuleSubTypeMessage
-from velbusaio.messages.module_type import ModuleTypeMessage
+from velbusaio.messages.module_type import ModuleType2Message, ModuleTypeMessage
+from velbusaio.module import Module
+from velbusaio.raw_message import RawMessage
+
+if TYPE_CHECKING:
+    from velbusaio.controller import Velbus
 
 
 class PacketHandler:
     """
-    The packetHandler class
+    The PacketHandler class
     """
 
-    def __init__(self, writer, velbus) -> None:
-        self._log = logging.getLogger("velbus-packet")
+    def __init__(
+        self,
+        velbus: Velbus,
+        one_address: int | None = None,
+    ) -> None:
+        self._log = logging.getLogger("velbus-handler")
         self._log.setLevel(logging.DEBUG)
-        self._writer = writer
         self._velbus = velbus
+        self._one_address = one_address
+        self._typeResponseReceived = asyncio.Event()
+        self._scanLock = asyncio.Lock()
+        self._fullScanLock = asyncio.Lock()
+        self._modulescan_address = 0
         self._scan_complete = False
-        with open(
-            pkg_resources.resource_filename(__name__, "moduleprotocol/protocol.json")
-        ) as protocol_file:
-            self.pdata = json.load(protocol_file)
+        self._scan_delay_msec = 0
+        self.__scan_found_addresses: dict[int, ModuleTypeMessage | None] | None = None
 
-    def scan_finished(self) -> None:
-        self._scan_complete = True
+    async def read_protocol_data(self):
+        if sys.version_info >= (3, 13):
+            with importlib.resources.path(
+                __name__, "module_spec/broadcast.json"
+            ) as fspath:
+                async with async_open(fspath) as protocol_file:
+                    self.broadcast = json.loads(await protocol_file.read())
+            with importlib.resources.path(
+                __name__, "module_spec/ignore.json"
+            ) as fspath:
+                async with async_open(fspath) as protocol_file:
+                    self.ignore = json.loads(await protocol_file.read())
+        else:
+            async with async_open(
+                str(
+                    importlib.resources.files(__name__.split(".")[0]).joinpath(
+                        "module_spec/broadcast.json"
+                    )
+                )
+            ) as protocol_file:
+                self.broadcast = json.loads(await protocol_file.read())
+            async with async_open(
+                str(
+                    importlib.resources.files(__name__.split(".")[0]).joinpath(
+                        "module_spec/ignore.json"
+                    )
+                )
+            ) as protocol_file:
+                self.ignore = json.loads(await protocol_file.read())
 
-    def scan_started(self) -> None:
-        self._scan_complete = False
+    def empty_cache(self) -> bool:
+        if (
+            len(
+                [
+                    name
+                    for name in os.listdir(f"{self._velbus.get_cache_dir()}")
+                    if os.path.isfile(f"{self._velbus.get_cache_dir()}/{name}")
+                ]
+            )
+            == 0
+        ):
+            return True
+        return False
+
+    async def scan(self, reload_cache: bool = False) -> None:
+        start_address = 1
+        max_address = 254 + 1
+        if self._one_address is not None:
+            start_address = self._one_address
+            max_address = self._one_address + 1
+            self._log.info(
+                f"Scanning only one address {self._one_address} ({self._one_address:#02x})"
+            )
+
+        self._log.info("Start module scan")
+        async with self._fullScanLock:
+            start_time = time.perf_counter()
+            self._scan_complete = False
+
+            self._log.debug("Waiting for Velbus bus to be ready to scan...")
+            await self._velbus.wait_on_all_messages_sent_async()  # don't start a scan while messages are still in the queue
+            self._log.debug("Velbus bus is ready to scan!")
+
+            self._log.info("Sending scan type requests to all addresses...")
+            start_scan_time = time.perf_counter()
+            self.__scan_found_addresses = {}
+            for address in range(start_address, max_address):
+                cfile = pathlib.Path(f"{self._velbus.get_cache_dir()}/{address}.json")
+                if reload_cache and os.path.isfile(cfile):
+                    self._log.info(
+                        f"Reloading cache for address {address} ({address:#02x})"
+                    )
+                    os.remove(cfile)
+
+                self.__scan_found_addresses[address] = None
+                async with self._scanLock:
+                    await self._velbus.sendTypeRequestMessage(address)
+
+            await self._velbus.wait_on_all_messages_sent_async()
+            scan_time = time.perf_counter() - start_scan_time
+            self._log.info(
+                f"Sent scan type requests to all addresses in {scan_time:.2f}. Going to wait for responses..."
+            )
+
+            await asyncio.sleep(SCAN_MODULETYPE_TIMEOUT / 1000)  # wait for responses
+
+            self._log.info(
+                "Waiting for responses done. Going to check for responses..."
+            )
+            for address in range(start_address, max_address):
+                start_module_scan = time.perf_counter()
+                module_type_message: ModuleTypeMessage | None = (
+                    self.__scan_found_addresses[address]
+                )
+                module: Module | None = None
+                if module_type_message is None:
+                    self._log.debug(
+                        f"No module found at address {address} ({address:#02x}). Skipping it."
+                    )
+                    continue
+
+                self._log.info(
+                    f"Found module at address {address} ({address:#02x}): {module_type_message.module_type_name()}"
+                )
+                # cache_file = pathlib.Path(f"{self._velbus.get_cache_dir()}/{address}.json")
+                # TODO: check if cached file module type is the same?
+                await self._handle_module_type(module_type_message)
+                async with self._scanLock:
+                    module = self._velbus.get_module(address)
+
+                if module is None:
+                    self._log.info(
+                        f"Module at address {address} ({address:#02x}) could not be loaded. Skipping it."
+                    )
+                    continue
+
+                try:
+                    self._log.debug(
+                        f"Module {module.get_address()} ({module.get_address():#02x}) detected: start loading"
+                    )
+                    await asyncio.wait_for(
+                        module.load(from_cache=True),
+                        SCAN_MODULEINFO_TIMEOUT_INITIAL / 1000.0,
+                    )
+                    self._scan_delay_msec = module.get_initial_timeout()
+                    while self._scan_delay_msec > 50 and not await module.is_loaded():
+                        # self._log.debug(
+                        #    f"\t... waiting {self._scan_delay_msec} is_loaded={await module.is_loaded()}"
+                        # )
+                        self._scan_delay_msec = self._scan_delay_msec - 50
+                        await asyncio.sleep(0.05)
+                    module_scan_time = time.perf_counter() - start_module_scan
+                    self._log.info(
+                        f"Scan module {address} ({address:#02x}, {module.get_type_name()}) completed in {module_scan_time:.2f}, module loaded={await module.is_loaded()}"
+                    )
+                    await module.wait_for_status_messages()
+                except asyncio.TimeoutError:
+                    self._log.error(
+                        f"Module {address} ({address:#02x}) did not respond to info requests after successful type request"
+                    )
+
+            self._scan_complete = True
+            total_time = time.perf_counter() - start_time
+            self._log.info(f"Module scan completed in {total_time:.2f} seconds")
 
-    async def handle(self, data: str) -> None:
+    async def __handle_module_type_response_async(self, rawmsg: RawMessage) -> None:
         """
-        Handle a recievd packet
+        Handle a received module type response packet
         """
-        priority = data[1]
-        address = int(data[2])
-        rtr = data[3] & RTR == RTR
-        data_size = data[3] & 0x0F
-        command_value = data[4]
-        if data_size < 1:
+        address = rawmsg.address
+
+        if self.__scan_found_addresses is None:
+            self._log.warning(
+                f"Received module type response for address {address} ({address:#02x}) but no scan in progress"
+            )
+            return
+
+        tmsg: ModuleTypeMessage = ModuleTypeMessage()
+        tmsg.populate(rawmsg.priority, address, rawmsg.rtr, rawmsg.data_only)
+        self._log.debug(
+            f"A '{tmsg.module_type_name()}' ({tmsg.module_type:#02x}) lives on address {address} ({address:#02x})"
+        )
+        self.__scan_found_addresses[address] = tmsg
+
+    async def handle(self, rawmsg: RawMessage) -> None:
+        """
+        Handle a received packet
+        """
+        if rawmsg.address < 1 or rawmsg.address > 254:
             return
-        if address < 1 or address > 254:
+        if rawmsg.command is None:
             return
-        if command_value == 0xFF and not self._scan_complete:
-            msg = ModuleTypeMessage()
-            msg.populate(priority, address, rtr, data[5:-2])
-            self._log.debug(f"Received {msg}")
-            await self._handle_module_type(msg)
-        elif command_value == 0xB0 and not self._scan_complete:
-            msg = ModuleSubTypeMessage()
-            msg.populate(priority, address, rtr, data[5:-2])
-            self._log.debug(f"Received {msg}")
-            await self._handle_module_subtype(msg)
-        elif command_value in self.pdata["MessagesBroadCast"]:
+
+        priority = rawmsg.priority
+        address = rawmsg.address
+        rtr = rawmsg.rtr
+        command_value = rawmsg.command
+        data = rawmsg.data_only
+
+        # handle module type response message
+        if command_value == 0xFF:
+            await self.__handle_module_type_response_async(rawmsg)
+
+        # handle module subtype response message
+        elif command_value in (0xB0, 0xA7, 0xA6) and not self._scan_complete:
+            msg: ModuleSubTypeMessage = ModuleSubTypeMessage()
+            msg.populate(priority, address, rtr, data)
+            if command_value == 0xB0:
+                msg.sub_address_offset = 0
+            elif command_value == 0xA7:
+                msg.sub_address_offset = 4
+            elif command_value == 0xA6:
+                msg.sub_address_offset = 8
+            async with self._scanLock:
+                self._scan_delay_msec += SCAN_MODULEINFO_TIMEOUT_INTERVAL
+                self._handle_module_subtype(msg)
+
+        # ignore broadcast
+        elif command_value in self.broadcast:
             self._log.debug(
                 "Received broadcast message {} from {}, ignoring".format(
-                    self.pdata["MessageBroadCast"][command_value.upper()], address
+                    self.broadcast[str(command_value).upper()], address
                 )
             )
-        elif address in self._velbus.get_modules().keys():
-            module_type = self._velbus.get_module(address).get_type()
-            if commandRegistry.has_command(int(command_value), module_type):
-                command = commandRegistry.get_command(command_value, module_type)
-                msg = command()
-                msg.populate(priority, address, rtr, data[5:-2])
-                self._log.debug(f"Received {msg}")
-                # send the message to the modules
-                await (self._velbus.get_module(msg.address)).on_message(msg)
-            else:
-                self._log.warning(
-                    "NOT FOUND IN command_registry: addr={} cmd={} packet={}".format(
-                        address, command_value, ":".join(format(x, "02x") for x in data)
-                    )
-                )
-        elif self._scan_complete:
-            # this should only happen once the scan is complete, of its not complete susppend the error message
-            self._log.warning(
-                "UNKNOWN module, you should iniitalize a full new velbus scan: packet={}, address={}, modules={}".format(
-                    ":".join(format(x, "02x") for x in data),
-                    address,
-                    self._velbus.get_modules().keys(),
+
+        # ignore messages
+        elif command_value in self.ignore:
+            self._log.debug(
+                "Received ignored message {} from {}, ignoring".format(
+                    self.ignore[str(command_value).upper()], address
                 )
             )
 
-    def _per_byte(self, cmsg, msg) -> dict:
-        result = {}
-        for num, byte in enumerate(msg.data):
-            num = str(num)
-            # only do something if its defined
-            if num not in cmsg:
-                continue
-            # check if we can do a binary match
-            for mat in cmsg[num]["Match"]:
-                if (
-                    (mat.startswith("%") and re.match(mat[1:], f"{byte:08b}"))
-                    or mat == f"{byte:08b}"
-                    or mat == f"{byte:02x}"
-                ):
-                    result = self._per_byte_handle(
-                        result, cmsg[num]["Match"][mat], byte
-                    )
-        return result
-
-    def _per_byte_handle(self, result: dict, todo: dict, byte: int) -> dict:
-        if "Channel" in todo:
-            result["Channel"] = todo["Channel"]
-        if "Value" in todo:
-            result["Value"] = todo["Value"]
-        if "Convert" in todo:
-            result["ValueList"] = []
-            if todo["Convert"] == "Decimal":
-                result["ValueList"].append(int(byte))
-            elif todo["Convert"] == "Counter":
-                result["ValueList"].append(f"{byte:02x}")
-            elif todo["Convert"] == "Temperature":
-                print("CONVERT temperature")
-            elif todo["Convert"] == "Divider":
-                bin_str = f"{byte:08b}"
-                chan = bin_str[6:]
-                val = bin_str[:5]
-                print(f"CONVERT Divider {chan} {val}")
-            elif todo["Convert"] == "Channel":
-                print("CONVERT Channel")
-            elif todo["Convert"] == "ChannelBit":
-                print("CONVERT ChannelBit")
-            elif todo["Convert"].startswith("ChannelBitStatus"):
-                print("CONVERT ChannelBitStatus")
-            else:
-                self._log.error("UNKNOWN convert requested: {}".format(todo["Convert"]))
-        return result
+        # handle other messages for modules that are already scanned
+        else:
+            module = None
+            async with self._scanLock:
+                module = self._velbus.get_module(address)
+            if module is not None:
+                module_type = module.get_type()
+                if commandRegistry.has_command(int(command_value), module_type):
+                    command = commandRegistry.get_command(command_value, module_type)
+                    if not command:
+                        return
+                    msg = command()
+                    msg.populate(priority, address, rtr, data)
+                    # restart the info completion time when info message received
+                    if command_value in (
+                        0xF0,
+                        0xF1,
+                        0xF2,
+                        0xFB,
+                        0xFE,
+                        0xCC,
+                    ):  # names, memory data, memory block
+                        self._scan_delay_msec += SCAN_MODULEINFO_TIMEOUT_INTERVAL
+                        # self._log.debug(f"Restart timeout {msg}")
+                    # send the message to the modules
+                    await module.on_message(msg)
+                else:
+                    self._log.warning(f"NOT FOUND IN command_registry: {rawmsg}")
 
-    async def _handle_module_type(self, msg: Message) -> None:
+    async def _handle_module_type(
+        self, msg: ModuleTypeMessage | ModuleType2Message
+    ) -> None:
         """
         load the module data
         """
-        data = keys_exists(self.pdata, "ModuleTypes", h2(msg.module_type))
-        if not data:
-            self._log.warning(f"Module not recognized: {msg.module_type}")
-            return
-        # create the module
-        await self._velbus.add_module(
-            msg.address,
-            msg.module_type,
-            data,
-            memorymap=msg.memory_map_version,
-            build_year=msg.build_year,
-            build_week=msg.build_week,
-            serial=msg.serial,
-        )
+        if msg is not None:
+            module = self._velbus.get_module(msg.address)
+            if module is None:
+                # data = keys_exists(self.pdata, "ModuleTypes", h2(msg.module_type))
+                # if not data:
+                #    self._log.warning(f"Module not recognized: {msg.module_type}")
+                #    return
+                await self._velbus.add_module(
+                    msg.address,
+                    msg.module_type,
+                    memorymap=msg.memory_map_version,
+                    build_year=msg.build_year,
+                    build_week=msg.build_week,
+                    serial=msg.serial,
+                )
+            else:
+                self._log.debug(
+                    f"***Module already exists scanAddr={self._modulescan_address} addr={msg.address} {msg}"
+                )
 
-    async def _handle_module_subtype(self, msg: Message) -> None:
-        if msg.address not in self._velbus.get_modules():
-            return
-        addrList = {
-            1: msg.sub_address_1,
-            2: msg.sub_address_2,
-            3: msg.sub_address_3,
-            4: msg.sub_address_4,
-        }
-        await self._velbus.add_submodules(msg.address, addrList)
-
-    def _channel_convert(self, module: str, channel: str, ctype: str) -> None | int:
-        data = keys_exists(
-            self.pdata, "ModuleTypes", h2(module), "ChannelNumbers", ctype
-        )
-        if data and "Map" in data and h2(channel) in data["Map"]:
-            return data["Map"][h2(channel)]
-        if data and "Convert" in data:
-            return int(channel)
-        for offset in range(0, 8):
-            if channel & (1 << offset):
-                return offset + 1
-        return None
+        # else:
+        #    self._log.debug("*** handle_module_type called without response message")
+
+    def _handle_module_subtype(self, msg: ModuleSubTypeMessage) -> None:
+        module = self._velbus.get_module(msg.address)
+        if module is not None:
+            addrList = {
+                (msg.sub_address_offset + 1): msg.sub_address_1,
+                (msg.sub_address_offset + 2): msg.sub_address_2,
+                (msg.sub_address_offset + 3): msg.sub_address_3,
+                (msg.sub_address_offset + 4): msg.sub_address_4,
+            }
+            self._velbus.add_submodules(module, addrList)
+
+
+#    def _channel_convert(self, module: str, channel: str, ctype: str) -> None | int:
+#        data = keys_exists(
+#            self.pdata, "ModuleTypes", h2(module), "ChannelNumbers", ctype
+#        )
+#        if data and "Map" in data and h2(channel) in data["Map"]:
+#            return data["Map"][h2(channel)]
+#        if data and "Convert" in data:
+#            return int(channel)
+#        for offset in range(0, 8):
+#            if channel & (1 << offset):
+#                return offset + 1
+#        return None

velbusaio/helpers.py

@@ -1,15 +1,17 @@
 """
 Helper functions
 """
+
 from __future__ import annotations
 
 import os
 import re
+from typing import Any
 
 from velbusaio.const import CACHEDIR
 
 
-def keys_exists(element, *keys) -> dict:
+def keys_exists(element: dict[str, Any], *keys) -> dict:
     """
     Check if *keys (nested) exists in `element` (dict).
     """
@@ -27,28 +29,14 @@ def keys_exists(element, *keys) -> dict:
     return _element
 
 
-def checksum(arr) -> int:
-    """
-    Calculate checksum of the given array.
-    The checksum is calculated by summing all values in an array, then performing the two's complement.
-    :param arr: The array of bytes of which the checksum has to be calculated of.
-    :return: The checksum of the given array.
-    """
-    crc = sum(arr)
-    crc = crc ^ 255
-    crc = crc + 1
-    crc = crc & 255
-    return crc
-
-
-def h2(inp) -> str:
+def h2(inp: int) -> str:
     """
-    Format as hex upercase
+    Format as hex uppercase
     """
     return format(inp, "02x").upper()
 
 
-def handle_match(match_dict, data) -> dict:
+def handle_match(match_dict: dict[str, dict[str, dict[str, str]]], data: int) -> dict:
     """
     Handle memory match from the module data
     """