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

velbusaio/messages/module_type.py

@@ -1,11 +1,12 @@
 """
 :author: Thomas Delaet <thomas@delaet.org>
 """
+
 from __future__ import annotations
 
 import struct
 
-from velbusaio.command_registry import register_command
+from velbusaio.command_registry import MODULE_DIRECTORY, register
 from velbusaio.message import Message
 
 COMMAND_CODE = 0xFF
@@ -18,11 +19,77 @@ MODULES_WITHOUT_SERIAL = {
     0x08: "VMB4RY",
     0x09: "VMB2BL",
     0x0C: "VMB1TS",
+    0x0D: "VMB1TH",
+    0x0E: "VMB1TC",
     0x0F: "VMB1LED",
     0x14: "VMBDME",
 }
 
 
+@register(
+    COMMAND_CODE,
+    [
+        "VMB1BL",
+        "VMB6IN",
+        "VMB1DM",
+        "VMB4RY",
+        "VMB2BL",
+        "VMB8IR",
+        "VMB4PD",
+        "VMB1TS",
+        "VMB1TH",
+        "VMB1TC",
+        "VMB1LED",
+        "VMB4RYLD",
+        "VMB4RYNO",
+        "VMB4DC",
+        "VMBLCDWB",
+        "VMBDME",
+        "VMBDMI",
+        "VMB8PBU",
+        "VMB6PBN",
+        "VMB2PBN",
+        "VMB6PBB",
+        "VMB4RF",
+        "VMB1RYNO",
+        "VMB1BLE",
+        "VMB2BLE",
+        "VMBGP1",
+        "VMBGP2",
+        "VMBGP4",
+        "VMBGPO",
+        "VMB7IN",
+        "VMBGPOD",
+        "VMB1RYNOS",
+        "VMBPIRM",
+        "VMBPIRC",
+        "VMBPIRO",
+        "VMBGP4PIR",
+        "VMB1BLS",
+        "VMBDMI-R",
+        "VMBMETEO",
+        "VMB4AN",
+        "VMBVP01",
+        "VMBEL1",
+        "VMBEL2",
+        "VMBEL4",
+        "VMBELO",
+        "VMBELPIR",
+        "VMBSIG",
+        "VMBGP1-2",
+        "VMBGP2-2",
+        "VMBGP4-2",
+        "VMBGPOD-2",
+        "VMBGP4PIR-2",
+        "VMCM3",
+        "VMBUSBIP",
+        "VMB1RYS",
+        "VMBKP",
+        "VMBIN",
+        "VMB4PB",
+        "VMBDALI",
+    ],
+)
 class ModuleTypeMessage(Message):
     """
     send by: VMB6IN, VMB4RYLD
@@ -31,7 +98,7 @@ class ModuleTypeMessage(Message):
 
     # pylint: disable-msg=R0902
 
-    def __init__(self, address=None):
+    def __init__(self, address=None) -> None:
         Message.__init__(self)
         self.module_type = 0x00
         self.led_on = []
@@ -43,19 +110,23 @@ class ModuleTypeMessage(Message):
         self.build_week = 0
         self.set_defaults(address)
 
-    def module_name(self):
+    def module_type_name(self) -> str:
         """
         :return: str
         """
-        return "Unknown"
 
-    def populate(self, priority, address, rtr, data):
+        return (
+            MODULE_DIRECTORY[self.module_type]
+            if self.module_type in MODULE_DIRECTORY
+            else "Unknown"
+        )
+
+    def populate(self, priority, address, rtr, data) -> None:
         """
         :return: None
         """
         self.needs_low_priority(priority)
         self.needs_no_rtr(rtr)
-        self.needs_data(data, 4)
         self.set_attributes(priority, address, rtr)
         self.module_type = data[0]
         if data[0] not in MODULES_WITHOUT_SERIAL:
@@ -64,21 +135,61 @@ class ModuleTypeMessage(Message):
         self.build_year = data[-2]
         self.build_week = data[-1]
 
-    def data_to_binary(self):
+
+@register(
+    COMMAND_CODE,
+    [
+        "VMB4RYLD-10",
+        "VMB4RYNO-10",
+        "VMB2BLE-10",
+        "VMB6PB-20",
+        "VMBEL1-20",
+        "VMBEL2-20",
+        "VMBEL4-20",
+        "VMBELO-20",
+        "VMBGP1-20",
+        "VMBGP2-20",
+        "VMBGP4-20",
+        "VMBGPO-20",
+        "VMBEL4PIR-20",
+        "VMBGP4PIR-20",
+        "VMB4LEDPWM-20",
+        "VMB8IN-20",
+        "VMB8DC-20",
+        "VMB2DC-20",
+    ],
+)
+class ModuleType2Message(Message):
+    def __init__(self, address=None) -> None:
+        Message.__init__(self)
+        self.module_type = 0x00
+        self.led_on = []
+        self.led_slow_blinking = []
+        self.led_fast_blinking = []
+        self.serial = 0
+        self.memory_map_version = 0
+        self.build_year = 0
+        self.build_week = 0
+        self.term = 0
+        self.set_defaults(address)
+
+    def module_name(self) -> str:
         """
-        :return: bytes
+        :return: str
         """
-        return bytes(
-            [
-                COMMAND_CODE,
-                self.module_type,
-                self.channels_to_byte(self.led_on),
-                self.channels_to_byte(self.led_slow_blinking),
-                self.channels_to_byte(self.led_fast_blinking),
-                self.build_year,
-                self.build_week,
-            ]
-        )
-
+        return "Unknown"
 
-register_command(COMMAND_CODE, ModuleTypeMessage)
+    def populate(self, priority, address, rtr, data):
+        """
+        :return: None
+        """
+        self.needs_low_priority(priority)
+        self.needs_no_rtr(rtr)
+        self.set_attributes(priority, address, rtr)
+        self.module_type = data[0]
+        if data[0] not in MODULES_WITHOUT_SERIAL:
+            (self.serial,) = struct.unpack(">L", bytes([0, 0, data[1], data[2]]))
+            self.memory_map_version = data[3]
+        self.build_year = data[-3]
+        self.build_week = data[-2]
+        self.term = data[-1]

velbusaio/messages/module_type_request.py

@@ -1,6 +1,7 @@
 """
 :author: Thomas Delaet <thomas@delaet.org>
 """
+
 from __future__ import annotations
 
 from velbusaio.message import Message

velbusaio/messages/psu_load.py

@@ -0,0 +1,56 @@
+"""
+:author: Maikel Punie
+"""
+
+from __future__ import annotations
+
+import struct
+
+from velbusaio.command_registry import register
+from velbusaio.message import Message
+
+COMMAND_CODE = 0xA2
+BALANCED = 0x01
+BOOST = 0x02
+BACKUP = 0x03
+
+
+@register(COMMAND_CODE, ["VMBPSUMNGR-20"])
+class PsuLoadMessage(Message):
+
+    def __init__(self, address=None):
+        Message.__init__(self)
+        self.mode = 0
+        self.load_1 = 0
+        self.load_2 = 0
+        self.out = 0
+
+    def populate(self, priority, address, rtr, data):
+        """
+        :return: None
+        """
+        self.needs_low_priority(priority)
+        self.needs_no_rtr(rtr)
+        self.needs_data(data, 3)
+        self.set_attributes(priority, address, rtr)
+        self.mode = data[0]
+        self.load_1 = data[1]
+        self.load_2 = data[2]
+        self.out = data[3]
+
+    def data_to_binary(self):
+        """
+        :return: bytes
+        """
+        return (
+            bytes(
+                [
+                    COMMAND_CODE,
+                    self.mode,
+                    self.load_1,
+                    self.load_2,
+                    self.out,
+                ]
+            )
+            + struct.pack(">L", self.delay_time)[-3:]
+        )

velbusaio/messages/psu_values.py

@@ -0,0 +1,53 @@
+"""
+:author: Maikel Punie
+"""
+
+from __future__ import annotations
+
+import struct
+
+from velbusaio.command_registry import register
+from velbusaio.message import Message
+
+COMMAND_CODE = 0xA3
+
+
+@register(COMMAND_CODE, ["VMBPSUMNGR-20"])
+class PsuValuesMessage(Message):
+
+    def __init__(self, address=None):
+        Message.__init__(self)
+        self.channel = 0
+        self.watt = 0
+        self.volt = 0
+        self.amp = 0
+
+    def populate(self, priority, address, rtr, data):
+        """
+        :return: None
+        """
+        self.needs_low_priority(priority)
+        self.needs_no_rtr(rtr)
+        self.needs_data(data, 3)
+        self.set_attributes(priority, address, rtr)
+        self.channel = (data[0] & 0xF0) >> 4
+        self.watt = ((data[0] & 0x0F) << 16 | data[1] << 8 | data[2]) / 1000
+        self.volt = (data[3] << 8 | data[4]) / 1000
+        self.amp = (data[5] << 8 | data[6]) / 1000
+
+    def data_to_binary(self):
+        """
+        :return: bytes
+        """
+        return (
+            bytes(
+                [
+                    COMMAND_CODE,
+                    self.mode,
+                    self.load_1,
+                    self.load_2,
+                    self.out,
+                ]
+            )
+            + struct.pack(">L", self.delay_time)[-3:]
+        )

velbusaio/messages/push_button_status.py

@@ -1,16 +1,16 @@
 """
 :author: Thomas Delaet <thomas@delaet.org>
 """
-from __future__ import annotations
 
-import json
+from __future__ import annotations
 
-from velbusaio.command_registry import register_command
+from velbusaio.command_registry import register
 from velbusaio.message import Message
 
 COMMAND_CODE = 0x00
 
 
+@register(COMMAND_CODE)
 class PushButtonStatusMessage(Message):
     """
     send by: VMB6IN, VMB4RYLD
@@ -42,16 +42,6 @@ class PushButtonStatusMessage(Message):
         self.set_high_priority()
         self.set_no_rtr()
 
-    def to_json(self):
-        """
-        :return: str
-        """
-        json_dict = self.to_json_basic()
-        json_dict["closed_channels"] = self.closed
-        json_dict["opened_channels"] = self.opened
-        json_dict["closed_long_channels"] = self.closed_long
-        return json.dumps(json_dict)
-
     def get_channels(self):
         """
         :return: list
@@ -70,6 +60,3 @@ class PushButtonStatusMessage(Message):
                 self.channels_to_byte(self.closed_long),
             ]
         )
-
-
-register_command(COMMAND_CODE, PushButtonStatusMessage)

velbusaio/messages/raw.py

@@ -0,0 +1,74 @@
+"""
+:author: Maikel Punie <maikel.punie@gmail.com>
+"""
+
+from __future__ import annotations
+
+from velbusaio.command_registry import register
+from velbusaio.message import Message
+
+COMMAND_CODE = 0xA9
+
+
+@register(COMMAND_CODE, ["VMBMETEO"])
+class MeteoRawMessage(Message):
+    """
+    send by: VMBMETEO
+    received by:
+    """
+
+    def __init__(self, address=None):
+        Message.__init__(self)
+        self.rain = 0
+        self.light = 0
+        self.wind = 0
+
+    def populate(self, priority, address, rtr, data):
+        """
+        data bytes (high + low)
+            1 + 2   = current temp
+            3 + 4   = min temp
+            5 + 6   = max temp
+        :return: None
+        """
+        self.needs_no_rtr(rtr)
+        self.needs_data(data, 6)
+        self.set_attributes(priority, address, rtr)
+        self.rain = (((data[0] << 8) | data[1]) / 32) * 0.1
+        self.light = ((data[2] << 8) | data[3]) / 32
+        self.wind = (((data[4] << 8) | data[5]) / 32) * 0.1
+
+
+@register(COMMAND_CODE, ["VMB4AN"])
+class SensorRawMessage(Message):
+    """
+    send by: VMB4AN
+    received by:
+    """
+
+    def __init__(self, address=None):
+        Message.__init__(self)
+        self.sensor = 0
+        self.mode = 0
+        self.value = 0
+        self.unit = None
+
+    def populate(self, priority, address, rtr, data):
+        self.needs_no_rtr(rtr)
+        self.needs_data(data, 5)
+        self.set_attributes(priority, address, rtr)
+        self.sensor = data[0]
+        self.mode = data[1]
+        self.value = (data[2] << 16) | (data[3] << 8) | data[4]
+        if self.mode == 0:
+            self.value = self.value * 0.25
+            self.unit = "mV"
+        elif self.mode == 1:
+            self.value = self.value * 5
+            self.unit = "µA"
+        elif self.mode == 2:
+            self.value = self.value * 0.25
+            self.unit = "ohm"
+        elif self.mode == 3:
+            self.value = self.value * 0.5
+            self.unit = "µS"

velbusaio/messages/read_data_block_from_memory.py

@@ -1,14 +1,16 @@
 """
 :author: Thomas Delaet <thomas@delaet.org>
 """
+
 from __future__ import annotations
 
-from velbusaio.command_registry import register_command
+from velbusaio.command_registry import register
 from velbusaio.message import Message
 
 COMMAND_CODE = 0xC9
 
 
+@register(COMMAND_CODE)
 class ReadDataBlockFromMemoryMessage(Message):
     """
     send by:
@@ -37,6 +39,3 @@ class ReadDataBlockFromMemoryMessage(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE, self.high_address, self.low_address])
-
-
-register_command(COMMAND_CODE, ReadDataBlockFromMemoryMessage)

velbusaio/messages/read_data_from_memory.py

@@ -1,14 +1,16 @@
 """
 :author: Thomas Delaet <thomas@delaet.org>
 """
+
 from __future__ import annotations
 
-from velbusaio.command_registry import register_command
+from velbusaio.command_registry import register
 from velbusaio.message import Message
 
 COMMAND_CODE = 0xFD
 
 
+@register(COMMAND_CODE)
 class ReadDataFromMemoryMessage(Message):
     """
     send by:
@@ -37,6 +39,3 @@ class ReadDataFromMemoryMessage(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE, self.high_address, self.low_address])
-
-
-register_command(COMMAND_CODE, ReadDataFromMemoryMessage)

velbusaio/messages/realtime_clock_status_request.py

@@ -1,14 +1,16 @@
 """
 :author: Maikel Punie <maikel.punie@gmail.com>
 """
+
 from __future__ import annotations
 
-from velbusaio.command_registry import register_command
+from velbusaio.command_registry import register
 from velbusaio.message import Message
 
 COMMAND_CODE = 0xD7
 
 
+@register(COMMAND_CODE)
 class RealtimeClockStatusRequest(Message):
     def populate(self, priority, address, rtr, data):
         """
@@ -23,6 +25,3 @@ class RealtimeClockStatusRequest(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE])
-
-
-register_command(COMMAND_CODE, RealtimeClockStatusRequest)

velbusaio/messages/receive_buffer_full.py

@@ -1,14 +1,16 @@
 """
 :author: Thomas Delaet <thomas@delaet.org>
 """
+
 from __future__ import annotations
 
-from velbusaio.command_registry import register_command
+from velbusaio.command_registry import register
 from velbusaio.message import Message
 
 COMMAND_CODE = 0x0B
 
 
+@register(COMMAND_CODE)
 class ReceiveBufferFullMessage(Message):
     """
     send by:
@@ -35,6 +37,3 @@ class ReceiveBufferFullMessage(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE])
-
-
-register_command(COMMAND_CODE, ReceiveBufferFullMessage)

velbusaio/messages/receive_ready.py

@@ -1,14 +1,16 @@
 """
 :author: Thomas Delaet <thomas@delaet.org>
 """
+
 from __future__ import annotations
 
-from velbusaio.command_registry import register_command
+from velbusaio.command_registry import register
 from velbusaio.message import Message
 
 COMMAND_CODE = 0x0C
 
 
+@register(COMMAND_CODE)
 class ReceiveReadyMessage(Message):
     """
     send by:
@@ -29,6 +31,3 @@ class ReceiveReadyMessage(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE])
-
-
-register_command(COMMAND_CODE, ReceiveReadyMessage)

velbusaio/messages/relay_status.py

@@ -1,41 +1,30 @@
 """
 :author: Thomas Delaet <thomas@delaet.org>
 """
+
 from __future__ import annotations
 
-import json
 import struct
 
-from velbusaio.command_registry import register_command
+from velbusaio.command_registry import register
 from velbusaio.message import Message
 
 COMMAND_CODE = 0xFB
-
 CHANNEL_NORMAL = 0x00
-
 CHANNEL_INHIBITED = 0x01
-
 CHANNEL_FORCED_ON = 0x02
-
 CHANNEL_DISABLED = 0x03
-
 RELAY_ON = 0x01
-
 RELAY_OFF = 0x00
-
 INTERVAL_TIMER_ON = 0x03
-
 LED_OFF = 0
-
 LED_ON = 1 << 7
-
 LED_SLOW_BLINKING = 1 << 6
-
 LED_FAST_BLINKING = 1 << 5
-
 LED_VERY_FAST_BLINKING = 1 << 4
 
 
+@register(COMMAND_CODE)
 class RelayStatusMessage(Message):
     """
     send by: VMB4RYLD
@@ -65,18 +54,6 @@ class RelayStatusMessage(Message):
         self.led_status = data[3]
         (self.delay_time,) = struct.unpack(">L", bytes([0]) + data[4:])
 
-    def to_json(self):
-        """
-        :return: str
-        """
-        json_dict = self.to_json_basic()
-        json_dict["channel"] = self.channel
-        json_dict["disable_inhibit_forced"] = self.disable_inhibit_forced
-        json_dict["status"] = self.status
-        json_dict["led_status"] = self.led_status
-        json_dict["delay_time"] = self.delay_time
-        return json.dumps(json_dict)
-
     def is_normal(self):
         """
         :return: bool
@@ -107,21 +84,6 @@ class RelayStatusMessage(Message):
         """
         return self.status == RELAY_ON
 
-    def is_off(self):
-        """
-        :return: bool
-        """
-        return self.status == RELAY_OFF
-
-    def channel_is_on(self):
-        """
-        :return: bool
-        """
-        if (self.status >> (self.channel - 1)) & 1 != 0:
-            return True
-        else:
-            return False
-
     def has_interval_timer_on(self):
         """
         :return: bool
@@ -146,4 +108,13 @@ class RelayStatusMessage(Message):
         )
 
 
-register_command(COMMAND_CODE, RelayStatusMessage)
+@register(COMMAND_CODE, ["VMB4RY"])
+class RelayStatusMessage2(RelayStatusMessage):
+    def is_on(self):
+        """
+        :return: bool
+        """
+        if (self.status >> (self.channel - 1)) & 1 != 0:
+            return True
+        else:
+            return False