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

velbusaio/command_registry.py

@@ -1,22 +1,122 @@
-"""
+"""Command registry.
+
 :author: Maikel Punie <maikel.punie@gmail.com> and Thomas Delaet <thomas@delaet.org>
 """
+
 from __future__ import annotations
 
-from velbusaio.module_registry import MODULE_DIRECTORY
+MODULE_DIRECTORY = {
+    0x01: "VMB8PB",
+    0x02: "VMB1RY",
+    0x03: "VMB1BL",
+    0x04: "VMBPSUMNGR-20",
+    0x05: "VMB6IN",
+    0x06: "VMB4LEDPWM-20",
+    0x07: "VMB1DM",
+    0x08: "VMB4RY",
+    0x09: "VMB2BL",
+    0x0A: "VMB8IR",
+    0x0B: "VMB4PD",
+    0x0C: "VMB1TS",
+    0x0D: "VMB1TH",
+    0x0E: "VMB1TC",
+    0x0F: "VMB1LED",
+    0x10: "VMB4RYLD",
+    0x11: "VMB4RYNO",
+    0x12: "VMB4DC",
+    0x13: "VMBLCDWB",
+    0x14: "VMBDME",
+    0x15: "VMBDMI",
+    0x16: "VMB8PBU",
+    0x17: "VMB6PBN",
+    0x18: "VMB2PBN",
+    0x19: "VMB6PBB",
+    0x1A: "VMB4RF",
+    0x1B: "VMB1RYNO",
+    0x1C: "VMB1BLE",
+    0x1D: "VMB2BLE",
+    0x1E: "VMBGP1",
+    0x1F: "VMBGP2",
+    0x20: "VMBGP4",
+    0x21: "VMBGPO",
+    0x22: "VMB7IN",
+    0x23: "VMBPIRO-10",
+    0x24: "VMB2DC-20",
+    0x25: "VMBGPTC",
+    0x26: "VMB4RYLD-20",
+    0x27: "VMB4RYNO-20",
+    0x28: "VMBGPOD",
+    0x29: "VMB1RYNOS",
+    0x2A: "VMBPIRM",
+    0x2B: "VMBPIRC",
+    0x2C: "VMBPIRO",
+    0x2D: "VMBGP4PIR",
+    0x2E: "VMB1BLS",
+    0x2F: "VMBDMI-R",
+    0x30: "VMBRFR8S",
+    0x31: "VMBMETEO",
+    0x32: "VMB4AN",
+    0x33: "VMBVP01",
+    0x34: "VMBEL1",
+    0x35: "VMBEL2",
+    0x36: "VMBEL4",
+    0x37: "VMBELO",
+    0x38: "VMBELPIR",
+    0x39: "VMBSIG",
+    0x3A: "VMBGP1-2",
+    0x3B: "VMBGP2-2",
+    0x3C: "VMBGP4-2",
+    0x3D: "VMBGPOD-2",
+    0x3E: "VMBGP4PIR-2",
+    0x3F: "VMCM3",
+    0x40: "VMBUSBIP",
+    0x41: "VMB1RYS",
+    0x42: "VMBKP",
+    0x43: "VMBIN",
+    0x44: "VMB4PB",
+    0x45: "VMBDALI",
+    0x48: "VMB4RYLD-10",
+    0x49: "VMB4RYNO-10",
+    0x4A: "VMB2BLE-10",
+    0x4B: "VMB8DC-20",
+    0x4C: "VMB6PB-20",
+    0x4D: "VMBPIR-20",
+    0x4E: "VMB8IN-20",
+    0x4F: "VMBEL1-20",
+    0x50: "VMBEL2-20",
+    0x51: "VMBEL4-20",
+    0x52: "VMBELO-20",
+    0x54: "VMBGP1-20",
+    0x55: "VMBGP2-20",
+    0x56: "VMBGP4-20",
+    0x57: "VMBGPO-20",
+    0x59: "VMBPIRO-20",
+    0x5A: "VMBDALI-20",
+    0x5B: "VMBSIG-20",
+    0x5C: "VMBEL4PIR-20",
+    0x5F: "VMBGP4PIR-20",
+    0x60: "VMBSIG-21",
+    0x61: "VMB2BLE-20",
+}
 
 
 class CommandRegistry:
+    """Command registry class."""
+
     def __init__(self, module_directory: dict) -> None:
+        """Init method."""
         self._module_directory = module_directory
         self._default_commands = {}
         self._overrides = {}
 
     def register_command(
-        self, command_value: int, command_class: type, module_name: str = 0
+        self, command_value: int, command_class: type, module_name: str | None = None
     ) -> None:
-        assert command_value >= 0 and command_value <= 255
-        assert module_name in self._module_directory.values() or module_name == 0
+        """Register a command."""
+        if command_value < 0 or command_value > 255:
+            raise ValueError("Command_value should be >=0 and <=255")
+        if module_name and module_name not in self._module_directory.values():
+            raise Exception(f"Module name {module_name} not known")
         if module_name:
             module_type = next(
                 (
@@ -33,20 +133,25 @@ class CommandRegistry:
     def _register_override(
         self, command_value: int, command_class: type, module_type: str
     ) -> None:
+        """Register and override."""
         if module_type not in self._overrides:
             self._overrides[module_type] = {}
         if command_value not in self._overrides[module_type]:
             self._overrides[module_type][command_value] = command_class
         else:
-            raise Exception("double registration in command registry")
+            raise Exception(
+                f"double registration in command registry {command_value} {command_class}"
+            )
 
     def _register_default(self, command_value: int, command_class: type) -> None:
+        """Register a default command."""
         if command_value not in self._default_commands:
             self._default_commands[command_value] = command_class
         else:
             raise Exception("double registration in command registry")
 
     def has_command(self, command_value: int, module_type: int = 0) -> bool:
+        """Find a command."""
         if module_type in self._overrides:
             if command_value in self._overrides[module_type]:
                 return True
@@ -55,6 +160,7 @@ class CommandRegistry:
         return False
 
     def get_command(self, command_value: int, module_type: int = 0) -> None | type:
+        """Search a command in the registry."""
         if module_type in self._overrides:
             if command_value in self._overrides[module_type]:
                 return self._overrides[module_type][command_value]
@@ -66,10 +172,17 @@ class CommandRegistry:
 commandRegistry = CommandRegistry(MODULE_DIRECTORY)
 
 
-def register_command(
-    command_value: int, command_class: type, module_type: str = 0
-) -> None:
-    """
-    :return: None
-    """
-    commandRegistry.register_command(command_value, command_class, module_type)
+def register(command_value: int, module_types: list[str] | None = None):
+    """Register decorator."""
+
+    def inner_register(command_class):
+        if module_types:
+            for module_type in module_types:
+                commandRegistry.register_command(
+                    command_value, command_class, module_type
+                )
+        else:
+            commandRegistry.register_command(command_value, command_class)
+        return command_class
+
+    return inner_register

velbusaio/const.py

@@ -1,6 +1,8 @@
-"""
+"""Constant for velbusaio.
+
 Author: Maikel Punie <maikel.punie@gmail.com>
 """
+
 from __future__ import annotations
 
 from typing import Final
@@ -15,26 +17,48 @@ PRIORITIES: Final = [
     PRIORITY_LOW,
     PRIORITY_THIRDPARTY,
 ]
-STX: Final = 0x0F
-ETX: Final = 0x04
+
+
+HEADER_LENGTH: Final = 4  # Header: [Start Byte, priority, address, RTR+data length]
+TAIL_LENGTH: Final = 2  # Tail: [CRC, End Byte]
+MAX_BODY_SIZE: Final = 8  # Maximum amount of data bytes in a packet
+
+MINIMUM_MESSAGE_SIZE: Final = (
+    HEADER_LENGTH + TAIL_LENGTH
+)  # Smallest possible packet: [Start Byte, priority, address, RTR+data length, CRC, End Byte]
+MAXIMUM_MESSAGE_SIZE: Final = MINIMUM_MESSAGE_SIZE + MAX_BODY_SIZE
+
+START_BYTE: Final = 0x0F
+END_BYTE: Final = 0x04
+
+
 LENGTH_MASK: Final = 0x0F
-HEADER_LENGTH: Final = 4  # Header: [STX, priority, address, RTR+data length]
-MAX_DATA_AMOUNT: Final = 8  # Maximum amount of data bytes in a packet
-MIN_PACKET_LENGTH: Final = (
-    6  # Smallest possible packet: [STX, priority, address, RTR+data length, CRC, ETC]
-)
-MAX_PACKET_LENGTH: Final = MIN_PACKET_LENGTH + MAX_DATA_AMOUNT
+
 RTR: Final = 0x40
 NO_RTR: Final = 0x00
+
 CACHEDIR: Final = ".velbuscache"
-LOAD_TIMEOUT: Final = 600
+
+# Module scan timeout values (in mSec)
+SCAN_MODULETYPE_TIMEOUT: Final = 3000  # time to wait for ModuleTypeRequest
+SCAN_MODULEINFO_TIMEOUT_INITIAL: Final = 1000  # time to wait for first info (status)
+SCAN_MODULEINFO_TIMEOUT_INTERVAL: Final = (
+    150  # time to wait for info interval (between next message)
+)
 
 DEVICE_CLASS_ILLUMINANCE: Final = "illuminance"
 DEVICE_CLASS_TEMPERATURE: Final = "temperature"
 TEMP_CELSIUS: Final = "°C"
 ENERGY_KILO_WATT_HOUR: Final = "kWh"
 ENERGY_WATT_HOUR: Final = "Wh"
-VOLUME_CUBIC_METER: Final = "m3"  # Not an official constant at HA yet
-VOLUME_CUBIC_METER_HOUR: Final = "m3/h"  # Not an official constant at HA yet
+VOLUME_CUBIC_METER: Final = "m³"  # Not an official constant at HA yet
+VOLUME_CUBIC_METER_HOUR: Final = "m³/h"  # Not an official constant at HA yet
 VOLUME_LITERS: Final = "L"
 VOLUME_LITERS_HOUR: Final = "L/h"  # Not an official constant at HA yet
+
+CHANNEL_SELECTED_PROGRAM: Final = 96
+CHANNEL_EDGE_LIT: Final = 97
+CHANNEL_MEMO_TEXT: Final = 98
+CHANNEL_LIGHT_VALUE: Final = 99
+
+SLEEP_TIME = 60 / 1000