velbus-aio 2025.5.0__tar.gz → 2025.8.0__tar.gz

{velbus_aio-2025.5.0/velbus_aio.egg-info → velbus_aio-2025.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: velbus-aio
-Version: 2025.5.0
+Version: 2025.8.0
 Summary: Open-source home automation platform running on Python 3.
 Author-email: Maikel Punie <maikel.punie@gmail.com>
 License: MIT

{velbus_aio-2025.5.0 → velbus_aio-2025.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ requires = ["setuptools", "wheel"]
 [project]
 name = "velbus-aio"
 license = {text = "MIT"}
-version = "2025.5.0"
+version = "2025.8.0"
 description = "Open-source home automation platform running on Python 3."
 readme = "README.md"
 authors = [
@@ -52,7 +52,7 @@ exclude_dirs = ["tests"]
 skips = ["B301", "B403", "B323", "B104", "B110"]
 
 [tool.bumpver]
-current_version = "2025.5.0"
+current_version = "2025.8.0"
 version_pattern = "YYYY.MM.INC0"
 commit_message = "bump version {old_version} -> {new_version}"
 commit = true

{velbus_aio-2025.5.0 → velbus_aio-2025.8.0/velbus_aio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: velbus-aio
-Version: 2025.5.0
+Version: 2025.8.0
 Summary: Open-source home automation platform running on Python 3.
 Author-email: Maikel Punie <maikel.punie@gmail.com>
 License: MIT

{velbus_aio-2025.5.0 → velbus_aio-2025.8.0}/velbusaio/controller.py

@@ -17,7 +17,6 @@ from velbusaio.channels import (
     Blind,
     Button,
     ButtonCounter,
-    Channel,
     Dimmer,
     EdgeLit,
     LightSensor,
@@ -61,7 +60,7 @@ class Velbus:
         self._closing = False
         self._auto_reconnect = True
 
-        self._dsn = dsn
+        self._destination = dsn
         self._handler = PacketHandler(self, one_address)
         self._modules: dict[int, Module] = {}
         self._submodules: list[int] = []
@@ -146,12 +145,12 @@ class Velbus:
         """Connect to the bus and load all the data."""
         await self._handler.read_protocol_data()
         # connect to the bus
-        if ":" in self._dsn:
+        if ":" in self._destination:
             # tcp/ip combination
-            if not re.search(r"^[A-Za-z0-9+.\-]+://", self._dsn):
+            if not re.search(r"^[A-Za-z0-9+.\-]+://", self._destination):
                 # if no scheme, then add the tcp://
-                self._dsn = f"tcp://{self._dsn}"
-            parts = urlparse(self._dsn)
+                self._destination = f"tcp://{self._destination}"
+            parts = urlparse(self._destination)
             if parts.scheme == "tls":
                 ctx = ssl._create_unverified_context()
             else:
@@ -176,7 +175,7 @@ class Velbus:
                     await serial_asyncio_fast.create_serial_connection(
                         asyncio.get_event_loop(),
                         lambda: self._protocol,
-                        url=self._dsn,
+                        url=self._destination,
                         baudrate=38400,
                         bytesize=serial.EIGHTBITS,
                         parity=serial.PARITY_NONE,
@@ -190,7 +189,7 @@ class Velbus:
 
     async def start(self) -> None:
         # if auth is required send the auth key
-        parts = urlparse(self._dsn)
+        parts = urlparse(self._destination)
         if parts.username:
             await self._protocol.write_auth_key(parts.username)
         # scan the bus
@@ -277,3 +276,7 @@ class Velbus:
         await self.send(SetRealtimeClock(wday=lclt[6], hour=lclt[3], min=lclt[4]))
         await self.send(SetDate(day=lclt[2], mon=lclt[1], year=lclt[0]))
         await self.send(SetDaylightSaving(ds=not lclt[8]))
+
+    async def wait_on_all_messages_sent_async(self) -> None:
+        """Wait for all messages to be sent."""
+        await self._protocol.wait_on_all_messages_sent_async()

{velbus_aio-2025.5.0 → velbus_aio-2025.8.0}/velbusaio/handler.py

@@ -11,9 +11,9 @@ import json
 import logging
 import os
 import pathlib
-import pprint
 import sys
-from typing import TYPE_CHECKING, Awaitable, Callable
+import time
+from typing import TYPE_CHECKING
 
 from aiofile import async_open
 
@@ -23,10 +23,9 @@ from velbusaio.const import (
     SCAN_MODULEINFO_TIMEOUT_INTERVAL,
     SCAN_MODULETYPE_TIMEOUT,
 )
-from velbusaio.helpers import h2, keys_exists
-from velbusaio.message import Message
 from velbusaio.messages.module_subtype import ModuleSubTypeMessage
 from velbusaio.messages.module_type import ModuleType2Message, ModuleTypeMessage
+from velbusaio.module import Module
 from velbusaio.raw_message import RawMessage
 
 if TYPE_CHECKING:
@@ -35,7 +34,7 @@ if TYPE_CHECKING:
 
 class PacketHandler:
     """
-    The packetHandler class
+    The PacketHandler class
     """
 
     def __init__(
@@ -49,9 +48,11 @@ class PacketHandler:
         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
         self._scan_delay_msec = 0
+        self.__scan_found_addresses: dict[int, ModuleTypeMessage | None] | None = None
 
     async def read_protocol_data(self):
         if sys.version_info >= (3, 13):
@@ -85,84 +86,123 @@ class PacketHandler:
         return False
 
     async def scan(self, reload_cache: bool = False) -> None:
-        if reload_cache:
-            self._modulescan_address = 0
-            self._scan_complete = False
-        # non-blocking check to see if the cache_dir is empty
-        loop = asyncio.get_running_loop()
-        if not reload_cache and await loop.run_in_executor(None, self.empty_cache):
-            self._log.info("No cache yet, so forcing a bus scan")
-            reload_cache = True
+        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")
-        while self._modulescan_address < 254:
-            address = 0
-            module = None
-            async with self._scanLock:
-                self._modulescan_address = self._modulescan_address + 1
-                address = self._modulescan_address
-                if self._velbus.addr_is_submodule(address):
+        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"Skipping submodule address {address}, already handled"
+                        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"Starting handling scan {address}")
-                module = self._velbus.get_module(address)
 
-            if self._one_address is not None and address != int(self._one_address):
                 self._log.info(
-                    f"Skipping address {address} as we requested to only scan one address {self._one_address}"
+                    f"Found module at address {address} ({address:#02x}): {module_type_message.module_type_name()}"
                 )
-                continue
-
-            cfile = pathlib.Path(f"{self._velbus.get_cache_dir()}/{address}.json")
-            # cleanup the old module cache if needed
-            scanModule = reload_cache
-            if scanModule and os.path.isfile(cfile):
-                os.remove(cfile)
-            elif os.path.isfile(cfile):
-                scanModule = os.path.isfile(cfile)
-            if scanModule:
+                # 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.info(f"Starting scan {address}")
-                    self._typeResponseReceived.clear()
-                    await self._velbus.sendTypeRequestMessage(address)
+                    self._log.debug(
+                        f"Module {module.get_address()} ({module.get_address():#02x}) detected: start loading"
+                    )
                     await asyncio.wait_for(
-                        self._typeResponseReceived.wait(),
-                        SCAN_MODULETYPE_TIMEOUT / 1000.0,
+                        module.load(from_cache=True),
+                        SCAN_MODULEINFO_TIMEOUT_INITIAL / 1000.0,
                     )
-                    async with self._scanLock:
-                        module = self._velbus.get_module(address)
-                except asyncio.TimeoutError:
+                    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} failed: not present or unavailable"
+                        f"Scan module {address} ({address:#02x}, {module.get_type_name()}) completed in {module_scan_time:.2f}, module loaded={await module.is_loaded()}"
                     )
-                if module is not None:
-                    try:
-                        self._log.debug(
-                            f"Module {module.get_address()} 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)
-                        self._log.info(
-                            f"Scan module {address} completed, module loaded={await module.is_loaded()}"
-                        )
-                    except asyncio.TimeoutError:
-                        self._log.error(
-                            f"Module {address} did not respond to info requests after successful type request"
-                        )
-        self._scan_complete = True
-        self._log.info("Module scan completed")
+                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_module_type_response_async(self, rawmsg: RawMessage) -> None:
+        """
+        Handle a received module type response packet
+        """
+        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:
         """
@@ -180,20 +220,8 @@ class PacketHandler:
         data = rawmsg.data_only
 
         # handle module type response message
-        if command_value == 0xFF and not self._scan_complete:
-            tmsg: ModuleTypeMessage = ModuleTypeMessage()
-            tmsg.populate(priority, address, rtr, data)
-            async with self._scanLock:
-                await self._handle_module_type(tmsg)
-                if address == self._modulescan_address:
-                    self._typeResponseReceived.set()
-                else:
-                    self._log.debug(
-                        f"Unexpected module type message module address {address}, Velbuslink scan?"
-                    )
-                    self._modulescan_address = address - 1
-
-            self._typeResponseReceived.set()
+        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:

{velbus_aio-2025.5.0 → velbus_aio-2025.8.0}/velbusaio/message.py

@@ -4,6 +4,7 @@ The velbus abstract message class
 
 from __future__ import annotations
 
+import enum
 import json
 
 from velbusaio.const import PRIORITY_FIRMWARE, PRIORITY_HIGH, PRIORITY_LOW
@@ -65,8 +66,13 @@ class Message:
                 continue
             if callable(getattr(self, key)) or key.startswith("__"):
                 del me[key]
-            if isinstance(me[key], (bytes, bytearray)):
+            if isinstance(me[key], (bytes, bytearray, enum.Enum)):
                 me[key] = str(me[key])
+            else:
+                try:
+                    json.dumps(me[key])  # Test if the value is JSON serializable
+                except (TypeError, ValueError):
+                    me[key] = str(me[key])  # Convert non-serializable objects to string
         return me
 
     def to_json(self) -> str:

{velbus_aio-2025.5.0 → velbus_aio-2025.8.0}/velbusaio/messages/module_type.py

@@ -114,6 +114,7 @@ class ModuleTypeMessage(Message):
         """
         :return: str
         """
+
         return (
             MODULE_DIRECTORY[self.module_type]
             if self.module_type in MODULE_DIRECTORY

{velbus_aio-2025.5.0 → velbus_aio-2025.8.0}/velbusaio/module.py

@@ -165,6 +165,7 @@ class Module:
         self._is_loading = False
         self._channels = {}
         self.loaded = False
+        self._loaded_cache = {}
 
     def get_initial_timeout(self) -> int:
         return SCAN_MODULEINFO_TIMEOUT_INITIAL
@@ -576,12 +577,8 @@ class Module:
         # start the loading
         self._is_loading = True
         # see if we have a cache
-        try:
-            cfile = pathlib.Path(f"{self._cache_dir}/{self._address}.json")
-            async with async_open(cfile, "r") as fl:
-                cache = json.loads(await fl.read())
-        except OSError:
-            cache = {}
+        cache = await self._get_cache()
+        self._loaded_cache = cache
         # load default channels
         await self._load_default_channels()
 
@@ -596,8 +593,8 @@ class Module:
         if "channels" in cache:
             for num, chan in cache["channels"].items():
                 self._channels[int(num)]._name = chan["name"]
-                if "sub_device" in chan:
-                    self._channels[int(num)]._sub_device = chan["sub_device"]
+                if "subdevice" in chan:
+                    self._channels[int(num)]._sub_device = chan["subdevice"]
                 else:
                     self._channels[int(num)]._sub_device = False
                 if "Unit" in chan:
@@ -611,6 +608,15 @@ class Module:
         self._is_loading = False
         await self._request_module_status()
 
+    async def _get_cache(self):
+        try:
+            cfile = pathlib.Path(f"{self._cache_dir}/{self._address}.json")
+            async with async_open(cfile, "r") as fl:
+                cache = json.loads(await fl.read())
+        except OSError:
+            cache = {}
+        return cache
+
     def _load(self) -> None:
         """
         Method for per module type loading
@@ -864,7 +870,25 @@ class VmbDali(Module):
                     if message.channel in self._channels:
                         del self._channels[message.channel]
                 elif message.data.device_type == DaliDeviceType.LedModule:
-                    if self._channels.get(message.channel).__class__ != Dimmer:
+                    cache = self._loaded_cache
+                    if (
+                        "channels" in cache
+                        and str(message.channel) in cache["channels"]
+                        and cache["channels"][str(message.channel)]["type"] == "Dimmer"
+                    ):
+                        # If we have a cached dimmer channel, use that name
+                        name = cache["channels"][str(message.channel)]["name"]
+                        self._channels[message.channel] = Dimmer(
+                            self,
+                            message.channel,
+                            name,
+                            False,  # set False to enable an already loaded Dimmer
+                            True,
+                            self._writer,
+                            self._address,
+                            slider_scale=254,
+                        )
+                    elif self._channels.get(message.channel).__class__ != Dimmer:
                         # New or changed type, replace channel:
                         self._channels[message.channel] = Dimmer(
                             self,
@@ -921,8 +945,6 @@ class VmbDali(Module):
         else:
             return await super().on_message(message)
 
-        await self._cache()
-
     async def _request_channel_name(self) -> None:
         # Channel names are requested after channel scan
         # don't do them here (at initialization time)

{velbus_aio-2025.5.0 → velbus_aio-2025.8.0}/velbusaio/protocol.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import asyncio
 import binascii
 import logging
+import time
 import typing as t
 from asyncio import transports
 
@@ -180,20 +181,22 @@ class VelbusProtocol(asyncio.BufferedProtocol):
         await self._write_transport_lock.acquire()
         while self._restart_writer:
             # wait for an item from the queue
-            msg_info = await self._send_queue.get()
+            msg_info: RawMessage | None = await self._send_queue.get()
             if msg_info is None:
                 self._restart_writer = False
                 return
             message_sent = False
             try:
+                start_time = time.perf_counter()
                 while not message_sent:
                     message_sent = await self._write_message(msg_info)
-                if msg_info.command == 0xEF:
-                    # 'channel name request' command provokes in worst case 99 answer packets from VMBGPOD
-                    queue_sleep_time = SLEEP_TIME * 33
-                else:
-                    queue_sleep_time = SLEEP_TIME
+                send_time = time.perf_counter() - start_time
+
+                self._send_queue.task_done()  # indicate that the item of the queue has been processed
+
+                queue_sleep_time = self._calculate_queue_sleep_time(msg_info, send_time)
                 await asyncio.sleep(queue_sleep_time)
+
             except (asyncio.CancelledError, GeneratorExit) as exc:
                 if not self._closing:
                     self._log.error(f"Stopping Velbus writer due to {exc!r}")
@@ -205,6 +208,22 @@ class VelbusProtocol(asyncio.BufferedProtocol):
             self._write_transport_lock.release()
         self._log.debug("Ending Velbus write message from send queue")
 
+    @staticmethod
+    def _calculate_queue_sleep_time(msg_info, send_time):
+        sleep_time = SLEEP_TIME
+
+        if msg_info.rtr:
+            sleep_time = SLEEP_TIME  # this is a scan command. We could be quicker?
+
+        if msg_info.command == 0xEF:
+            # 'channel name request' command provokes in worst case 99 answer packets from VMBGPOD
+            sleep_time = SLEEP_TIME * 33  # TODO make this adaptable on module_type
+
+        if send_time > sleep_time:
+            return 0  # no need to wait, we are already late
+        else:
+            return sleep_time - send_time
+
     @backoff.on_predicate(
         backoff.expo,
         lambda is_sent: not is_sent,
@@ -218,3 +237,7 @@ class VelbusProtocol(asyncio.BufferedProtocol):
             return True
         else:
             return False
+
+    async def wait_on_all_messages_sent_async(self) -> None:
+        self._log.debug("Waiting on all messages sent")
+        await self._send_queue.join()