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

velbusaio/messages/forced_on.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 = 0x14
 
 
+@register(COMMAND_CODE)
 class ForcedOn(Message):
     def populate(self, priority, address, rtr, data):
         """
@@ -23,6 +25,3 @@ class ForcedOn(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE])
-
-
-register_command(COMMAND_CODE, ForcedOn)

velbusaio/messages/interface_status_request.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 = 0x0E
 
 
+@register(COMMAND_CODE)
 class InterfaceStatusRequestMessage(Message):
     """
     send by: VMB1USB
@@ -29,6 +31,3 @@ class InterfaceStatusRequestMessage(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE])
-
-
-register_command(COMMAND_CODE, InterfaceStatusRequestMessage)

velbusaio/messages/ir_receiver_status.py

@@ -0,0 +1,18 @@
+"""
+:author: David Danssaert <david.danssaert@gmail.com>
+"""
+
+from __future__ import annotations
+
+from velbusaio.command_registry import register
+from velbusaio.messages.module_status import ModuleStatusMessage
+
+COMMAND_CODE = 0xEB
+
+
+@register(COMMAND_CODE, ["VMB8IR"])
+class IRReceiverStatusMessage(ModuleStatusMessage):
+    """
+    send by: VMB8IR
+    received by:
+    """

velbusaio/messages/kwh_status.py

@@ -1,16 +1,16 @@
 """
 :author: Maikel Punie <maikel.punie@gmail.com>
 """
-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 = 0xBE
 
 
+@register(COMMAND_CODE)
 class KwhStatusMessage(Message):
     """
     send by: VMB7IN
@@ -46,24 +46,8 @@ class KwhStatusMessage(Message):
         if self.watt < 55:
             self.watt = 0
 
-    def to_json(self):
-        """
-        :return: str
-        """
-        json_dict = self.to_json_basic()
-        json_dict["pulses"] = self.pulses
-        json_dict["counter"] = self.counter
-        json_dict["kwh"] = self.kwh
-        json_dict["delay"] = self.delay
-        json_dict["watt"] = self.watt
-        json_dict["channel"] = self.channel
-        return json.dumps(json_dict)
-
     def get_channels(self):
         """
         :return: list
         """
         return self.channel
-
-
-register_command(COMMAND_CODE, KwhStatusMessage)

velbusaio/messages/light_value_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 = 0xAA
 
 
+@register(COMMAND_CODE)
 class LightValueRequest(Message):
     def populate(self, priority, address, rtr, data):
         """
@@ -23,6 +25,3 @@ class LightValueRequest(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE])
-
-
-register_command(COMMAND_CODE, LightValueRequest)

velbusaio/messages/memo_text.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 = 0xAC
 
 
+@register(COMMAND_CODE)
 class MemoTextMessage(Message):
     """
     send by:
@@ -27,7 +29,6 @@ class MemoTextMessage(Message):
         """
         self.needs_low_priority(priority)
         self.needs_no_rtr(rtr)
-        self.needs_data(data, 7)
         self.set_attributes(priority, address, rtr)
         self.start = data[1]
         self.name = "".join([chr(x) for x in data[2:]])
@@ -39,6 +40,3 @@ class MemoTextMessage(Message):
         while len(self.memo_text) < 5:
             self.memo_text += chr(0)
         return bytes([COMMAND_CODE, 0x00, self.start]) + bytes(self.memo_text, "utf-8")
-
-
-register_command(COMMAND_CODE, MemoTextMessage)

velbusaio/messages/memory_data.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 = 0xFE
 
 
+@register(COMMAND_CODE)
 class MemoryDataMessage(Message):
     """
     send by: VMB6IN, VMB4RYLD
@@ -41,16 +41,3 @@ class MemoryDataMessage(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE, self.high_address, self.low_address, self.data])
-
-    def to_json(self):
-        """
-        :return: str
-        """
-        json_dict = self.to_json_basic()
-        json_dict["high_add"] = self.high_address
-        json_dict["low_addr"] = self.low_address
-        json_dict["data"] = self.data
-        return json.dumps(json_dict)
-
-
-register_command(COMMAND_CODE, MemoryDataMessage)

velbusaio/messages/memory_data_block.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 = 0xCC
 
 
+@register(COMMAND_CODE)
 class MemoryDataBlockMessage(Message):
     """
     send by: VMB6IN, VMB4RYLD
@@ -39,6 +41,3 @@ class MemoryDataBlockMessage(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE, self.high_address, self.low_address]) + self.data
-
-
-register_command(COMMAND_CODE, MemoryDataBlockMessage)

velbusaio/messages/memory_dump_request.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 = 0xCB
 
 
+@register(COMMAND_CODE)
 class MemoryDumpRequestMessage(Message):
     """
     send by:
@@ -29,6 +31,3 @@ class MemoryDumpRequestMessage(Message):
         :return: bytes
         """
         return bytes([COMMAND_CODE])
-
-
-register_command(COMMAND_CODE, MemoryDumpRequestMessage)

velbusaio/messages/module_status.py

@@ -1,16 +1,18 @@
 """
 :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 = 0xED
 
+PROGRAM_SELECTION = {0: "none", 1: "summer", 2: "winter", 3: "holiday"}
 
+
+@register(COMMAND_CODE)
 class ModuleStatusMessage(Message):
     """
     send by: VMB6IN
@@ -53,6 +55,41 @@ class ModuleStatusMessage(Message):
         )
 
 
+@register(
+    COMMAND_CODE,
+    [
+        "VMB8PBU",
+        "VMB6PBN",
+        "VMB2PBN",
+        "VMB6PBB",
+        "VMBGP1",
+        "VMBEL1",
+        "VMBGP1-2",
+        "VMBGP2",
+        "VMBEL2",
+        "VMBGP2-2",
+        "VMBGP4",
+        "VMBEL4",
+        "VMBGP4-2",
+        "VMBGPO",
+        "VMBGPOD",
+        "VMBGPOD-2",
+        "VMBELO",
+        "VMB7IN",
+        "VMB6PB-20",
+        "VMBEL1-20",
+        "VMBEL2-20",
+        "VMBEL4-20",
+        "VMBELO-20",
+        "VMBGP1-20",
+        "VMBGP2-20",
+        "VMBGP4-20",
+        "VMBGPO-20",
+        "VMBEL4PIR-20",
+        "VMBGP4PIR-20",
+        "VMBPSUMNGR-20",
+    ],
+)
 class ModuleStatusMessage2(Message):
     def __init__(self, address=None):
         Message.__init__(self)
@@ -61,6 +98,8 @@ class ModuleStatusMessage2(Message):
         self.normal = []
         self.locked = []
         self.programenabled = []
+        self.selected_program = 0
+        self.selected_program_str = PROGRAM_SELECTION[self.selected_program]
 
     def populate(self, priority, address, rtr, data):
         self.needs_low_priority(priority)
@@ -72,6 +111,8 @@ class ModuleStatusMessage2(Message):
         self.normal = self.byte_to_channels(data[2])
         self.locked = self.byte_to_channels(data[3])
         self.programenabled = self.byte_to_channels(data[4])
+        self.selected_program = data[5] & 0x03
+        self.selected_program_str = PROGRAM_SELECTION[self.selected_program]
 
     def data_to_binary(self):
         """
@@ -87,47 +128,42 @@ class ModuleStatusMessage2(Message):
             ]
         )
 
-    def to_json(self):
-        """
-        :return: str
-        """
-        json_dict = self.to_json_basic()
-        json_dict["closed"] = self.closed
-        json_dict["enabled"] = self.enabled
-        json_dict["normal"] = self.normal
-        json_dict["locked"] = self.locked
-        return json.dumps(json_dict)
-
 
+@register(COMMAND_CODE, ["VMBPIRO", "VMBPIRM", "VMBPIRC", "VMBELPIR"])
 class ModuleStatusPirMessage(Message):
     def __init__(self, address=None):
         Message.__init__(self)
         # in data[0]
-        self.dark = False  # bit 1
-        self.light = False  # bit 2
-        self.motion1 = False  # bit 3
-        self.light_motion1 = False  # bit 4
-        self.motion2 = False  # bit 5
-        self.light_motion2 = False  # bit 6
-        self.low_temp_alarm = False  # bit 7
-        self.high_temp_alarm = False  # bit 8
+        self.dark: bool = False  # bit 1
+        self.light: bool = False  # bit 2
+        self.motion1: bool = False  # bit 3
+        self.light_motion1: bool = False  # bit 4
+        self.motion2: bool = False  # bit 5
+        self.light_motion2: bool = False  # bit 6
+        self.low_temp_alarm: bool = False  # bit 7
+        self.high_temp_alarm: bool = False  # bit 8
         # in data[1] and data[2]
-        self.light_value = 0
+        self.light_value: int = 0
+        # in data[5]
+        self.selected_program = 0
+        self.selected_program_str = PROGRAM_SELECTION[self.selected_program]
 
     def populate(self, priority, address, rtr, data):
         self.needs_low_priority(priority)
         self.needs_no_rtr(rtr)
         self.needs_data(data, 7)
         self.set_attributes(priority, address, rtr)
-        self.dark = 0x01 & data[0]
-        self.light = 0x02 & data[0]
-        self.motion1 = 0x04 & data[0]
-        self.light_motion1 = 0x08 & data[0]
-        self.motion2 = 0x10 & data[0]
-        self.light_motion2 = 0x20 & data[0]
-        self.low_temp_alarm = 0x40 & data[0]
-        self.high_temp_alarm = 0x80 & data[0]
+        self.dark = bool(data[0] & (1 << 0))
+        self.light = bool(data[0] & (1 << 1))
+        self.motion1 = bool(data[0] & (1 << 2))
+        self.light_motion1 = bool(data[0] & (1 << 3))
+        self.motion2 = bool(data[0] & (1 << 4))
+        self.light_motion2 = bool(data[0] & (1 << 5))
+        self.low_temp_alarm = bool(data[0] & (1 << 6))
+        self.high_temp_alarm = bool(data[0] & (1 << 7))
         self.light_value = (data[1] << 8) + data[2]
+        self.selected_program = data[5] & 0x03
+        self.selected_program_str = PROGRAM_SELECTION[self.selected_program]
 
     def data_to_binary(self):
         """
@@ -136,27 +172,43 @@ class ModuleStatusPirMessage(Message):
         raise NotImplementedError
 
 
-register_command(COMMAND_CODE, ModuleStatusMessage)
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMB8PBU")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMB6PBN")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMB2PBN")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMB6PBB")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBGP1")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBEL1")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBGP1-2")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBGP2")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBEL2")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBGP2-2")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBGP4")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBEL4")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBGP4-2")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBGPO")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBGPOD")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBELO")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMB7IN")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMB4DC")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBDMI")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBDMI-R")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMBDME")
-register_command(COMMAND_CODE, ModuleStatusMessage2, "VMB1RYS")
-register_command(COMMAND_CODE, ModuleStatusPirMessage, "VMBIRO")
+@register(COMMAND_CODE, ["VMBGP4PIR", "VMBGP4PIR-2"])
+class ModuleStatusGP4PirMessage(Message):
+    def __init__(self, address=None):
+        Message.__init__(self)
+        # in data[0]
+        self.closed = []
+        self.enabled = []  # only 4 bits
+        # self.normal = []
+        self.locked = []
+        self.programenabled = []
+        self.selected_program = 0
+        self.selected_program_str = PROGRAM_SELECTION[self.selected_program]
+
+        # in data[1] and data[2]
+        self.light_value: int = 0
+        # in data[5]
+        self.selected_program = 0
+        self.selected_program_str = PROGRAM_SELECTION[self.selected_program]
+        # in data[6]
+        self.light_value_send_interval = 0
+
+    def populate(self, priority, address, rtr, data):
+        self.needs_low_priority(priority)
+        self.needs_no_rtr(rtr)
+        self.needs_data(data, 7)
+        self.set_attributes(priority, address, rtr)
+        self.closed = self.byte_to_channels(data[0])
+        self.enabled = self.byte_to_channels(data[1])
+        self.locked = self.byte_to_channels(data[3])
+        self.light_value = ((data[1] & 0x30) << 4) + data[2]
+        self.programenabled = self.byte_to_channels(data[4])
+        self.selected_program = data[5] & 0x03
+        self.selected_program_str = PROGRAM_SELECTION[self.selected_program]
+        self.light_value_send_interval = data[6]
+
+    def data_to_binary(self):
+        """
+        :return: bytes
+        """
+        raise NotImplementedError

velbusaio/messages/module_status_request.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 = 0xFA
 
 
+@register(COMMAND_CODE)
 class ModuleStatusRequestMessage(Message):
     """
     send by:
@@ -17,7 +19,7 @@ class ModuleStatusRequestMessage(Message):
 
     def __init__(self, address=None):
         Message.__init__(self)
-        self.channels = []
+        self.channels: list | str = []
         self.wait_after_send = 500
         self.set_defaults(address)
 
@@ -35,7 +37,6 @@ class ModuleStatusRequestMessage(Message):
         """
         :return: bytes
         """
-        return bytes([COMMAND_CODE, self.channels_to_byte(self.channels)])
-
-
-register_command(COMMAND_CODE, ModuleStatusRequestMessage)
+        if isinstance(self.channels, list):
+            return bytes([COMMAND_CODE, self.channels_to_byte(self.channels)])
+        return bytes([COMMAND_CODE, int(self.channels, 16)])

velbusaio/messages/module_subtype.py

@@ -1,17 +1,22 @@
 """
 :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 = 0xB0
+COMMAND_CODE_2 = 0xA7
+COMMAND_CODE_3 = 0xA6
 
 
+@register(COMMAND_CODE)
+@register(COMMAND_CODE_2)
+@register(COMMAND_CODE_3)
 class ModuleSubTypeMessage(Message):
     """
     send by: VMB6IN, VMB4RYLD
@@ -20,7 +25,7 @@ class ModuleSubTypeMessage(Message):
 
     # pylint: disable-msg=R0902
 
-    def __init__(self, address=None):
+    def __init__(self, address=None, sub_address_offset: int = 0) -> None:
         Message.__init__(self)
         self.module_type = 0x00
         self.sub_address_1 = 0xFF
@@ -29,14 +34,15 @@ class ModuleSubTypeMessage(Message):
         self.sub_address_4 = 0xFF
         self.set_defaults(address)
         self.serial = 0
+        self.sub_address_offset = sub_address_offset
 
-    def module_name(self):
+    def module_name(self) -> str:
         """
         :return: str
         """
         return "Unknown"
 
-    def populate(self, priority, address, rtr, data):
+    def populate(self, priority, address, rtr, data) -> None:
         """
         :return: None
         """
@@ -50,17 +56,3 @@ class ModuleSubTypeMessage(Message):
         self.sub_address_2 = data[4]
         self.sub_address_3 = data[5]
         self.sub_address_4 = data[6]
-
-    def to_json(self):
-        """
-        :return: str
-        """
-        json_dict = self.to_json_basic()
-        json_dict["sub_1"] = self.sub_address_1
-        json_dict["sub_2"] = self.sub_address_2
-        json_dict["sub_3"] = self.sub_address_3
-        json_dict["sub_4"] = self.sub_address_4
-        return json.dumps(json_dict)
-
-
-register_command(COMMAND_CODE, ModuleSubTypeMessage)