velbus-aio 2024.7.6__py3-none-any.whl → 2024.10.0__py3-none-any.whl

velbusaio/module.py

@@ -4,14 +4,17 @@ This represents a velbus module
 
 from __future__ import annotations
 
+import json
 import logging
+import os
 import pathlib
 import struct
 import sys
-import json
-import os
 from typing import Awaitable, Callable
 
+import pkg_resources
+from aiofile import async_open
+
 from velbusaio.channels import (
     Blind,
     Button,
@@ -25,19 +28,20 @@ from velbusaio.channels import (
     SelectedProgram,
     Sensor,
     SensorNumber,
-    Temperature,
-    ThermostatChannel,
 )
+from velbusaio.channels import Temperature
+from velbusaio.channels import Temperature as TemperatureChannelType
+from velbusaio.channels import ThermostatChannel
 from velbusaio.command_registry import commandRegistry
 from velbusaio.const import (
     CHANNEL_LIGHT_VALUE,
     CHANNEL_MEMO_TEXT,
     CHANNEL_SELECTED_PROGRAM,
     PRIORITY_LOW,
+    SCAN_MODULEINFO_TIMEOUT_INITIAL,
 )
-from velbusaio.helpers import handle_match, keys_exists
+from velbusaio.helpers import h2, handle_match, keys_exists
 from velbusaio.message import Message
-from velbusaio.messages.dali_device_settings import DaliDeviceSettingMsg
 from velbusaio.messages.blind_status import BlindStatusMessage, BlindStatusNgMessage
 from velbusaio.messages.channel_name_part1 import (
     ChannelNamePart1Message,
@@ -61,6 +65,7 @@ from velbusaio.messages.channel_name_request import ChannelNameRequestMessage
 from velbusaio.messages.clear_led import ClearLedMessage
 from velbusaio.messages.counter_status import CounterStatusMessage
 from velbusaio.messages.counter_status_request import CounterStatusRequestMessage
+from velbusaio.messages.dali_device_settings import DaliDeviceSettingMsg
 from velbusaio.messages.dali_device_settings import DeviceType as DaliDeviceType
 from velbusaio.messages.dali_device_settings import DeviceTypeMsg as DaliDeviceTypeMsg
 from velbusaio.messages.dali_device_settings import MemberOfGroupMsg
@@ -73,7 +78,6 @@ from velbusaio.messages.dimmer_channel_status import DimmerChannelStatusMessage
 from velbusaio.messages.dimmer_status import DimmerStatusMessage
 from velbusaio.messages.fast_blinking_led import FastBlinkingLedMessage
 from velbusaio.messages.memory_data import MemoryDataMessage
-from velbusaio.messages.raw import MeteoRawMessage, SensorRawMessage
 from velbusaio.messages.module_status import (
     ModuleStatusGP4PirMessage,
     ModuleStatusMessage,
@@ -82,6 +86,7 @@ from velbusaio.messages.module_status import (
 )
 from velbusaio.messages.module_status_request import ModuleStatusRequestMessage
 from velbusaio.messages.push_button_status import PushButtonStatusMessage
+from velbusaio.messages.raw import MeteoRawMessage, SensorRawMessage
 from velbusaio.messages.read_data_from_memory import ReadDataFromMemoryMessage
 from velbusaio.messages.relay_status import RelayStatusMessage, RelayStatusMessage2
 from velbusaio.messages.sensor_temperature import SensorTemperatureMessage
@@ -90,7 +95,6 @@ from velbusaio.messages.slider_status import SliderStatusMessage
 from velbusaio.messages.slow_blinking_led import SlowBlinkingLedMessage
 from velbusaio.messages.temp_sensor_status import TempSensorStatusMessage
 from velbusaio.messages.update_led_status import UpdateLedStatusMessage
-from velbusaio.channels import Temperature as TemperatureChannelType
 
 
 class Module:
@@ -103,7 +107,6 @@ class Module:
         cls,
         module_address: int,
         module_type: int,
-        module_data: dict,
         serial: int | None = None,
         memorymap: int | None = None,
         build_year: int | None = None,
@@ -114,7 +117,6 @@ class Module:
             return VmbDali(
                 module_address,
                 module_type,
-                module_data,
                 serial,
                 memorymap,
                 build_year,
@@ -125,7 +127,6 @@ class Module:
         return Module(
             module_address,
             module_type,
-            module_data,
             serial,
             memorymap,
             build_year,
@@ -137,7 +138,6 @@ class Module:
         self,
         module_address: int,
         module_type: int,
-        module_data: dict,
         serial: int | None = None,
         memorymap: int | None = None,
         build_year: int | None = None,
@@ -145,8 +145,8 @@ class Module:
         cache_dir: str | None = None,
     ) -> None:
         self._address = module_address
-        self._type = module_type
-        self._data = module_data
+        self._type = int(module_type)
+        self._data = {}
 
         self._name = {}
         self._sub_address = {}
@@ -159,8 +159,25 @@ class Module:
         self._channels = {}
         self.loaded = False
 
-    def initialize(self, writer: Callable[[Message], Awaitable[None]]) -> None:
+    def get_initial_timeout(self) -> int:
+        return SCAN_MODULEINFO_TIMEOUT_INITIAL
+
+    async def initialize(self, writer: Callable[[Message], Awaitable[None]]) -> None:
         self._log = logging.getLogger("velbus-module")
+        # load the protocol data
+        try:
+            async with async_open(
+                pkg_resources.resource_filename(
+                    __name__, f"module_spec/{h2(self._type)}.json"
+                )
+            ) as protocol_file:
+                self._data = json.loads(await protocol_file.read())
+            self._log.debug(f"Module spec {h2(self._type)} loaded")
+        except FileNotFoundError:
+            self._log.warning(f"No module spec for {h2(self._type)}")
+            self._data = {}
+
+        # set some params from the velbus controller
         self._writer = writer
         for chan in self._channels.values():
             chan._writer = writer
@@ -185,9 +202,9 @@ class Module:
                     ):
                         del self._channels[i]
 
-    def _cache(self) -> None:
+    async def _cache(self) -> None:
         cfile = pathlib.Path(f"{self._cache_dir}/{self._address}.json")
-        with cfile.open("w") as fl:
+        with open(cfile, "w") as fl:
             json.dump(self.to_cache(), fl, indent=4)
 
     def __getstate__(self) -> dict:
@@ -265,6 +282,7 @@ class Module:
             ),
         ):
             self._process_channel_name_message(1, message)
+            await self._cache()
         elif isinstance(
             message,
             (
@@ -274,6 +292,7 @@ class Module:
             ),
         ):
             self._process_channel_name_message(2, message)
+            await self._cache()
         elif isinstance(
             message,
             (
@@ -283,6 +302,7 @@ class Module:
             ),
         ):
             self._process_channel_name_message(3, message)
+            await self._cache()
         elif isinstance(message, MemoryDataMessage):
             await self._process_memory_data_message(message)
         elif isinstance(message, (RelayStatusMessage, RelayStatusMessage2)):
@@ -511,8 +531,6 @@ class Module:
                 message.sensor, {"cur": message.value, "unit": message.unit}
             )
 
-        self._cache()
-
     async def _update_channel(self, channel: int, updates: dict):
         try:
             await self._channels[channel].update(updates)
@@ -533,8 +551,8 @@ class Module:
         # see if we have a cache
         try:
             cfile = pathlib.Path(f"{self._cache_dir}/{self._address}.json")
-            with cfile.open("r") as fl:
-                cache = json.load(fl)
+            async with async_open(cfile, "r") as fl:
+                cache = json.loads(await fl.read())
         except OSError:
             cache = {}
         # load default channels
@@ -640,7 +658,7 @@ class Module:
             )
         return int(channel)
 
-    def is_loaded(self) -> bool:
+    async def is_loaded(self) -> bool:
         """
         Check if all name messages have been received
         """
@@ -658,7 +676,7 @@ class Module:
                 return False
         # set that  we finished the module loading
         self.loaded = True
-        self._cache()
+        await self._cache()
         return True
 
     async def _request_module_status(self) -> None:
@@ -751,7 +769,6 @@ class VmbDali(Module):
         self,
         module_address: int,
         module_type: int,
-        module_data: dict,
         serial: int | None = None,
         memorymap: int | None = None,
         build_year: int | None = None,
@@ -761,7 +778,6 @@ class VmbDali(Module):
         super().__init__(
             module_address,
             module_type,
-            module_data,
             serial,
             memorymap,
             build_year,
@@ -770,6 +786,9 @@ class VmbDali(Module):
         )
         self.group_members: dict[int, set[int]] = {}
 
+    def get_initial_timeout(self) -> int:
+        return 100000
+
     async def _load_default_channels(self) -> None:
         for chan in range(1, 64 + 1):
             self._channels[chan] = Channel(
@@ -853,7 +872,7 @@ class VmbDali(Module):
         else:
             return await super().on_message(message)
 
-        self._cache()
+        await self._cache()
 
     async def _request_channel_name(self) -> None:
         # Channel names are requested after channel scan

velbusaio/module_spec/01.json

@@ -0,0 +1,50 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Push button 1",
+      "Type": "Button"
+    },
+    "02": {
+      "Editable": "yes",
+      "Name": "Push button 2",
+      "Type": "Button"
+    },
+    "03": {
+      "Editable": "yes",
+      "Name": "Push button 3",
+      "Type": "Button"
+    },
+    "04": {
+      "Editable": "yes",
+      "Name": "Push button 4",
+      "Type": "Button"
+    },
+    "05": {
+      "Editable": "yes",
+      "Name": "Push button 5",
+      "Type": "Button"
+    },
+    "06": {
+      "Editable": "yes",
+      "Name": "Push button 6",
+      "Type": "Button"
+    },
+    "07": {
+      "Editable": "yes",
+      "Name": "Push button 7",
+      "Type": "Button"
+    },
+    "08": {
+      "Editable": "yes",
+      "Name": "Push button 8",
+      "Type": "Button"
+    },
+    "96": {
+      "Name": "SelectedProgram",
+      "Type": "SelectedProgram"
+    }
+  },
+  "Info": "8-Channel Push Button Module",
+  "Type": "VMB8PB"
+}

velbusaio/module_spec/02.json

@@ -0,0 +1,11 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Relay",
+      "Type": "Relay"
+    }
+  },
+  "Info": "Relay Module",
+  "Type": "VMB1RY"
+}

velbusaio/module_spec/03.json

@@ -0,0 +1,18 @@
+{
+  "ChannelNumbers": {
+    "Name": {
+      "Map": {
+        "03": "01"
+      }
+    }
+  },
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Blind",
+      "Type": "Blind"
+    }
+  },
+  "Info": "Blind Control Module",
+  "Type": "VMB1BL"
+}

velbusaio/module_spec/05.json

@@ -0,0 +1,36 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Push button 1",
+      "Type": "Button"
+    },
+    "02": {
+      "Editable": "yes",
+      "Name": "Push button 2",
+      "Type": "Button"
+    },
+    "03": {
+      "Editable": "yes",
+      "Name": "Push button 3",
+      "Type": "Button"
+    },
+    "04": {
+      "Editable": "yes",
+      "Name": "Push button 4",
+      "Type": "Button"
+    },
+    "05": {
+      "Editable": "yes",
+      "Name": "Push button 5",
+      "Type": "Button"
+    },
+    "06": {
+      "Editable": "yes",
+      "Name": "Push button 6",
+      "Type": "Button"
+    }
+  },
+  "Info": "6-Channel Input Module",
+  "Type": "VMB6IN"
+}

velbusaio/module_spec/06.json

@@ -0,0 +1,101 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Dimmer 1",
+      "Type": "Dimmer"
+    },
+    "02": {
+      "Editable": "yes",
+      "Name": "Dimmer 2",
+      "Type": "Dimmer"
+    },
+    "03": {
+      "Editable": "yes",
+      "Name": "Dimmer 3",
+      "Type": "Dimmer"
+    },
+    "04": {
+      "Editable": "yes",
+      "Name": "Dimmer 4",
+      "Type": "Dimmer"
+    },
+    "96": {
+      "Name": "SelectedProgram",
+      "Type": "SelectedProgram"
+    }
+  },
+  "Memory": {
+    "Address": {
+      "062C": { "ModuleName": "0:Start" },
+      "062D": { "ModuleName": "1" },
+      "062E": { "ModuleName": "2" },
+      "062F": { "ModuleName": "3" },
+      "0630": { "ModuleName": "4" },
+      "0631": { "ModuleName": "5" },
+      "0632": { "ModuleName": "6" },
+      "0633": { "ModuleName": "7" },
+      "0634": { "ModuleName": "8" },
+      "0635": { "ModuleName": "9" },
+      "0636": { "ModuleName": "10" },
+      "0637": { "ModuleName": "11" },
+      "0638": { "ModuleName": "12" },
+      "0639": { "ModuleName": "13" },
+      "063A": { "ModuleName": "14" },
+      "063B": { "ModuleName": "15" },
+      "063C": { "ModuleName": "16" },
+      "063D": { "ModuleName": "17" },
+      "063E": { "ModuleName": "18" },
+      "063F": { "ModuleName": "19" },
+      "0640": { "ModuleName": "20" },
+      "0641": { "ModuleName": "21" },
+      "0642": { "ModuleName": "22" },
+      "0643": { "ModuleName": "23" },
+      "0644": { "ModuleName": "24" },
+      "0645": { "ModuleName": "25" },
+      "0646": { "ModuleName": "26" },
+      "0647": { "ModuleName": "27" },
+      "0648": { "ModuleName": "28" },
+      "0649": { "ModuleName": "29" },
+      "064A": { "ModuleName": "30" },
+      "064B": { "ModuleName": "31" },
+      "064C": { "ModuleName": "32" },
+      "064D": { "ModuleName": "33" },
+      "064E": { "ModuleName": "34" },
+      "064F": { "ModuleName": "35" },
+      "0650": { "ModuleName": "36" },
+      "0651": { "ModuleName": "37" },
+      "0652": { "ModuleName": "38" },
+      "0653": { "ModuleName": "39" },
+      "0654": { "ModuleName": "40" },
+      "0655": { "ModuleName": "41" },
+      "0656": { "ModuleName": "42" },
+      "0657": { "ModuleName": "43" },
+      "0658": { "ModuleName": "44" },
+      "0659": { "ModuleName": "45" },
+      "065A": { "ModuleName": "46" },
+      "065B": { "ModuleName": "47" },
+      "065C": { "ModuleName": "48" },
+      "065D": { "ModuleName": "49" },
+      "065E": { "ModuleName": "50" },
+      "065F": { "ModuleName": "51" },
+      "0660": { "ModuleName": "52" },
+      "0661": { "ModuleName": "53" },
+      "0662": { "ModuleName": "54" },
+      "0663": { "ModuleName": "55" },
+      "0664": { "ModuleName": "55" },
+      "0665": { "ModuleName": "56" },
+      "0666": { "ModuleName": "57" },
+      "0667": { "ModuleName": "58" },
+      "0668": { "ModuleName": "59" },
+      "0669": { "ModuleName": "60" },
+      "066A": { "ModuleName": "61" },
+      "066B": { "ModuleName": "62" },
+      "066C": { "ModuleName": "63" },
+      "066D": { "ModuleName": "64:save" }
+    },
+    "ModuleName": "062C-32;064D-32"
+  },
+  "Info": "4 channel led PWM dimmer module",
+  "Type": "VMB4LEDPWM-20"
+}

velbusaio/module_spec/07.json

@@ -0,0 +1,11 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Dimmer",
+      "Type": "Dimmer"
+    }
+  },
+  "Info": "Dimmer module",
+  "Type": "VMB1DM"
+}

velbusaio/module_spec/08.json

@@ -0,0 +1,26 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Relay 1",
+      "Type": "Relay"
+    },
+    "02": {
+      "Editable": "yes",
+      "Name": "Relay 2",
+      "Type": "Relay"
+    },
+    "03": {
+      "Editable": "yes",
+      "Name": "Relay 3",
+      "Type": "Relay"
+    },
+    "04": {
+      "Editable": "yes",
+      "Name": "Relay 4",
+      "Type": "Relay"
+    }
+  },
+  "Info": "4 channel relay module",
+  "Type": "VMB4RY"
+}

velbusaio/module_spec/09.json

@@ -0,0 +1,24 @@
+{
+  "ChannelNumbers": {
+    "Name": {
+      "Map": {
+        "03": "01",
+        "0C": "02"
+      }
+    }
+  },
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Blind 1",
+      "Type": "Blind"
+    },
+    "02": {
+      "Editable": "yes",
+      "Name": "Blind 2",
+      "Type": "Blind"
+    }
+  },
+  "Info": "2-channel Blind Control Module",
+  "Type": "VMB2BL"
+}

velbusaio/module_spec/0A.json

@@ -0,0 +1,46 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Push button 1",
+      "Type": "Button"
+    },
+    "02": {
+      "Editable": "yes",
+      "Name": "Push button 2",
+      "Type": "Button"
+    },
+    "03": {
+      "Editable": "yes",
+      "Name": "Push button 3",
+      "Type": "Button"
+    },
+    "04": {
+      "Editable": "yes",
+      "Name": "Push button 4",
+      "Type": "Button"
+    },
+    "05": {
+      "Editable": "yes",
+      "Name": "Push button 5",
+      "Type": "Button"
+    },
+    "06": {
+      "Editable": "yes",
+      "Name": "Push button 6",
+      "Type": "Button"
+    },
+    "07": {
+      "Editable": "yes",
+      "Name": "Push button 7",
+      "Type": "Button"
+    },
+    "08": {
+      "Editable": "yes",
+      "Name": "Push button 8",
+      "Type": "Button"
+    }
+  },
+  "Info": "Infrared remote control receiver module",
+  "Type": "VMB8IR"
+}

velbusaio/module_spec/0B.json

@@ -0,0 +1,46 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Push button 1",
+      "Type": "Button"
+    },
+    "02": {
+      "Editable": "yes",
+      "Name": "Push button 2",
+      "Type": "Button"
+    },
+    "03": {
+      "Editable": "yes",
+      "Name": "Push button 3",
+      "Type": "Button"
+    },
+    "04": {
+      "Editable": "yes",
+      "Name": "Push button 4",
+      "Type": "Button"
+    },
+    "05": {
+      "Editable": "yes",
+      "Name": "Push button 5",
+      "Type": "Button"
+    },
+    "06": {
+      "Editable": "yes",
+      "Name": "Push button 6",
+      "Type": "Button"
+    },
+    "07": {
+      "Editable": "yes",
+      "Name": "Push button 7",
+      "Type": "Button"
+    },
+    "08": {
+      "Editable": "yes",
+      "Name": "Push button 8",
+      "Type": "Button"
+    }
+  },
+  "Info": "PUSH BUTTON AND TIMER PANEL",
+  "Type": "VMB4PD"
+}

velbusaio/module_spec/0C.json

@@ -0,0 +1,13 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Temperature",
+      "Type": "Temperature"
+    }
+  },
+  "Info": "Temperature Sensor Module",
+  "TemperatureChannel": "01",
+  "Thermostat": "yes",
+  "Type": "VMB1TS"
+}

velbusaio/module_spec/0E.json

@@ -0,0 +1,25 @@
+{
+  "Info": "TemperatureController Module",
+  "Memory": {
+    "Address": {
+      "00F0": { "ModuleName": "0:Start" },
+      "00F1": { "ModuleName": "1" },
+      "00F2": { "ModuleName": "2" },
+      "00F3": { "ModuleName": "3" },
+      "00F4": { "ModuleName": "4" },
+      "00F5": { "ModuleName": "5" },
+      "00F6": { "ModuleName": "6" },
+      "00F7": { "ModuleName": "7" },
+      "00F8": { "ModuleName": "8" },
+      "00F9": { "ModuleName": "9" },
+      "00FA": { "ModuleName": "10" },
+      "00FB": { "ModuleName": "11" },
+      "00FC": { "ModuleName": "12" },
+      "00FD": { "ModuleName": "13" },
+      "00FE": { "ModuleName": "14" },
+      "00FF": { "ModuleName": "16:Save" }
+    },
+    "ModuleName": "00F0-16"
+  },
+  "Type": "VMB1TC"
+}

velbusaio/module_spec/0F.json

@@ -0,0 +1,11 @@
+{
+  "Channels": {
+    "01": {
+      "Editable": "yes",
+      "Name": "Dimmer",
+      "Type": "Dimmer"
+    }
+  },
+  "Info": "PWM LED strip dimmer module",
+  "Type": "VMB1LED"
+}