velbus-aio 2023.10.2__tar.gz → 2023.12.0__tar.gz

{velbus-aio-2023.10.2/velbus_aio.egg-info → velbus-aio-2023.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: velbus-aio
-Version: 2023.10.2
+Version: 2023.12.0
 Summary: Open-source home automation platform running on Python 3.
 Author-email: Maikel Punie <maikel.punie@gmail.com>
 License: MIT
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Home Automation
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/pyproject.toml

@@ -4,7 +4,7 @@ requires = ["setuptools", "wheel"]
 [project]
 name = "velbus-aio"
 license = {text = "MIT"}
-version = "2023.10.2"
+version = "2023.12.0"
 description = "Open-source home automation platform running on Python 3."
 readme = "README.md"
 authors = [
@@ -22,6 +22,7 @@ classifiers = [
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Home Automation",
     "Topic :: Software Development :: Libraries",
     "Topic :: Software Development :: Libraries :: Python Modules",
@@ -50,7 +51,7 @@ exclude_dirs = ["tests"]
 skips = ["B301", "B403", "B323", "B104", "B110"]
 
 [tool.bumpver]
-current_version = "2023.10.2"
+current_version = "2023.12.0"
 version_pattern = "YYYY.MM.INC0"
 commit_message = "bump version {old_version} -> {new_version}"
 commit = true

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0/velbus_aio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: velbus-aio
-Version: 2023.10.2
+Version: 2023.12.0
 Summary: Open-source home automation platform running on Python 3.
 Author-email: Maikel Punie <maikel.punie@gmail.com>
 License: MIT
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Home Automation
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/channels.py

@@ -135,6 +135,18 @@ class Channel:
             if k != "_writer" and k != "_on_status_update" and k != "_name_parts"
         }
 
+    def to_json(self) -> dict:
+        d = self.__dict__
+        return {
+            k: d[k]
+            for k in d
+            if k != "_writer"
+            and k != "_on_status_update"
+            and k != "_name_parts"
+            and k != "_module"
+            and k != "__name__"
+        }
+
     def __setstate__(self, state):
         self.__dict__.update(state)
         self._on_status_update = []
@@ -191,6 +203,9 @@ class Channel:
     def get_min(self) -> int:
         raise NotImplementedError()
 
+    def is_water(self) -> bool:
+        return False
+
     async def press(self) -> None:
         raise NotImplementedError()
 
@@ -395,6 +410,11 @@ class ButtonCounter(Button):
     def get_counter_unit(self) -> str:
         return self._Unit
 
+    def is_water(self) -> bool:
+        if self._counter and self._Unit == VOLUME_LITERS_HOUR:
+            return True
+        return False
+
 
 class Sensor(Button):
     """
@@ -529,6 +549,9 @@ class Temperature(Channel):
     def get_climate_mode(self) -> str:
         return self._cstatus
 
+    def get_cool_mode(self) -> str:
+        return self._cool_mode
+
     async def set_temp(self, temp: float) -> None:
         cls = commandRegistry.get_command(0xE4, self._module.get_type())
         msg = cls(self._address)

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/command_registry.py

@@ -65,6 +65,21 @@ MODULE_DIRECTORY = {
     0x43: "VMBIN",
     0x44: "VMB4PB",
     0x45: "VMBDALI",
+    0x48: "VMB4RYLD-10",
+    0x49: "VMB4RYNO-10",
+    0x4A: "VMB2BLE-10",
+    0x4C: "VMB6PB-20",
+    0x4F: "VMBEL1-20",
+    0x50: "VMBEL2-20",
+    0x51: "VMBEL4-20",
+    0x52: "VMBELO-20",
+    0x53: "VMBGP1-20",
+    0x54: "VMBGP2-20",
+    0x55: "VMBGP4-20",
+    0x56: "VMBGPO-20",
+    0x5A: "VMBDALI-20",
+    0x5C: "VMBEL4PIR-20",
+    0x5F: "VMBGP4PIR-20",
 }
 
 

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/const.py

@@ -43,8 +43,8 @@ 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
 

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/controller.py

@@ -200,7 +200,6 @@ class Velbus:
                 raise VelbusConnectionFailed() from err
         if test_connect:
             return
-
         # if auth is required send the auth key
         if auth:
             await self._protocol.write_auth_key(auth)

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/exceptions.py

@@ -4,7 +4,7 @@
 class VelbusException(Exception):
     """Velbus Exception."""
 
-    def __init__(self, value):
+    def __init__(self, value: str) -> None:
         Exception.__init__(self)
         self.value = value
 
@@ -13,10 +13,10 @@ class VelbusException(Exception):
 
 
 class VelbusConnectionFailed(VelbusException):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__("Connection setup failed")
 
 
 class VelbusConnectionTerminated(VelbusException):
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__("Connection terminated")

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/messages/__init__.py

@@ -54,7 +54,7 @@ from velbusaio.messages.raw import MeteoRawMessage, SensorRawMessage
 from velbusaio.messages.module_status import ModuleStatusMessage, ModuleStatusMessage2
 from velbusaio.messages.module_status_request import ModuleStatusRequestMessage
 from velbusaio.messages.module_subtype import ModuleSubTypeMessage
-from velbusaio.messages.module_type import ModuleTypeMessage
+from velbusaio.messages.module_type import ModuleTypeMessage, ModuleType2Message
 from velbusaio.messages.module_type_request import ModuleTypeRequestMessage
 from velbusaio.messages.push_button_status import PushButtonStatusMessage
 from velbusaio.messages.read_data_block_from_memory import (

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/messages/dimmer_status.py

@@ -24,7 +24,7 @@ LED_FAST_BLINKING = 1 << 5
 LED_VERY_FAST_BLINKING = 1 << 4
 
 
-@register(COMMAND_CODE, ["VMBDME", "VMB1LED"])
+@register(COMMAND_CODE, ["VMB1DM", "VMBDME", "VMB1LED"])
 class DimmerStatusMessage(Message):
     """
     sent by: VMBDME

velbus-aio-2023.12.0/velbusaio/messages/module_type.py

@@ -0,0 +1,185 @@
+"""
+:author: Thomas Delaet <thomas@delaet.org>
+"""
+from __future__ import annotations
+
+import struct
+
+from velbusaio.command_registry import register
+from velbusaio.message import Message
+
+COMMAND_CODE = 0xFF
+MODULES_WITHOUT_SERIAL = {
+    0x01: "VMB8PB",
+    0x02: "VMB1RY",
+    0x03: "VMB1BL",
+    0x05: "VMB6IN",
+    0x07: "VMB1DM",
+    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
+    received by:
+    """
+
+    # pylint: disable-msg=R0902
+
+    def __init__(self, address=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.set_defaults(address)
+
+    def module_name(self):
+        """
+        :return: str
+        """
+        return "Unknown"
+
+    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[-2]
+        self.build_week = data[-1]
+
+
+@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",
+    ],
+)
+class ModuleType2Message(Message):
+    def __init__(self, address=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):
+        """
+        :return: str
+        """
+        return "Unknown"
+
+    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]

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/messages/restore_dimmer.py

@@ -9,7 +9,7 @@ from velbusaio.message import Message
 COMMAND_CODE = 0x11
 
 
-@register(COMMAND_CODE)
+@register(COMMAND_CODE, ["VMB1DM", "VMBDME", "VMBDMI-R", "VMBDMI", "VMB1LED", "VMB4DC"])
 class RestoreDimmerMessage(Message):
     """
     send by:

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/messages/set_date.py

@@ -17,14 +17,14 @@ class SetDate(Message):
     received by all modules
     """
 
-    def __init__(self, address=0x00):
+    def __init__(self, address=0x00) -> None:
         Message.__init__(self)
         self._day = None
         self._mon = None
         self._year = None
         self.set_defaults(address)
 
-    def set_defaults(self, address):
+    def set_defaults(self, address) -> None:
         if address is not None:
             self.set_address(address)
         self.set_low_priority()
@@ -34,7 +34,7 @@ class SetDate(Message):
         self._mon = lclt[1]
         self._year = lclt[0]
 
-    def populate(self, priority, address, rtr, data):
+    def populate(self, priority, address, rtr, data) -> None:
         """
         :return: None
         """
@@ -46,7 +46,7 @@ class SetDate(Message):
         self._mon = data[1]
         self._year = (data[2] << 8) + data[3]
 
-    def data_to_binary(self):
+    def data_to_binary(self) -> bytes:
         """
         :return: bytes
         """

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/messages/set_daylight_saving.py

@@ -17,12 +17,12 @@ class SetDaylightSaving(Message):
     received by all modules
     """
 
-    def __init__(self, address=0x00):
+    def __init__(self, address=0x00) -> None:
         Message.__init__(self)
         self._ds = None
         self.set_defaults(address)
 
-    def set_defaults(self, address):
+    def set_defaults(self, address) -> None:
         if address is not None:
             self.set_address(address)
         self.set_low_priority()
@@ -30,7 +30,7 @@ class SetDaylightSaving(Message):
         lclt = time.localtime()
         self._ds = not lclt[8]
 
-    def populate(self, priority, address, rtr, data):
+    def populate(self, priority, address, rtr, data) -> None:
         """
         :return: None
         """
@@ -40,7 +40,7 @@ class SetDaylightSaving(Message):
         self.set_attributes(priority, address, rtr)
         self._ds = data[0]
 
-    def data_to_binary(self):
+    def data_to_binary(self) -> bytes:
         """
         :return: bytes
         """

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/messages/set_dimmer.py

@@ -9,7 +9,7 @@ from velbusaio.message import Message
 COMMAND_CODE = 0x07
 
 
-@register(COMMAND_CODE, ["VMBDME", "VMB4DC", "VMBDMI", "VMBDMI-R", "VMB1LED"])
+@register(COMMAND_CODE, ["VMB1DM", "VMBDME", "VMB4DC", "VMBDMI", "VMBDMI-R", "VMB1LED"])
 class SetDimmerMessage(Message):
     """
     send by:

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/messages/set_realtime_clock.py

@@ -17,14 +17,14 @@ class SetRealtimeClock(Message):
     received by all modules
     """
 
-    def __init__(self, address=0x00):
+    def __init__(self, address=0x00) -> None:
         Message.__init__(self)
         self._wday = None
         self._hour = None
         self._min = None
         self.set_defaults(address)
 
-    def set_defaults(self, address):
+    def set_defaults(self, address) -> None:
         if address is not None:
             self.set_address(address)
         self.set_low_priority()
@@ -34,7 +34,7 @@ class SetRealtimeClock(Message):
         self._hour = lclt[3]
         self._min = lclt[4]
 
-    def populate(self, priority, address, rtr, data):
+    def populate(self, priority, address, rtr, data) -> None:
         """
         :return: None
         """
@@ -46,7 +46,7 @@ class SetRealtimeClock(Message):
         self._hour = data[1]
         self._min = data[2]
 
-    def data_to_binary(self):
+    def data_to_binary(self) -> bytes:
         """
         :return: bytes
         """

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/messages/slider_status.py

@@ -9,7 +9,7 @@ from velbusaio.message import Message
 COMMAND_CODE = 0x0F
 
 
-@register(COMMAND_CODE, ["VMBDME", "VMB4DC", "VMBDMI", "VMBDMI-R", "VMB1LED"])
+@register(COMMAND_CODE, ["VMB1DM", "VMBDME", "VMB4DC", "VMBDMI", "VMBDMI-R", "VMB1LED"])
 class SliderStatusMessage(Message):
     """
     sent by: VMBDME

{velbus-aio-2023.10.2 → velbus-aio-2023.12.0}/velbusaio/module.py

@@ -81,7 +81,7 @@ from velbusaio.messages.module_status import (
 )
 from velbusaio.messages.module_status_request import ModuleStatusRequestMessage
 from velbusaio.messages.module_subtype import ModuleSubTypeMessage
-from velbusaio.messages.module_type import ModuleTypeMessage
+from velbusaio.messages.module_type import ModuleTypeMessage, ModuleType2Message
 from velbusaio.messages.push_button_status import PushButtonStatusMessage
 from velbusaio.messages.read_data_from_memory import ReadDataFromMemoryMessage
 from velbusaio.messages.relay_status import RelayStatusMessage, RelayStatusMessage2
@@ -91,6 +91,7 @@ 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:
@@ -175,12 +176,14 @@ class Module:
         #
         # The solution would be that this functions knows were the temperature channels are located
         # and/or what the max number of subaddresses are for each module.
-        if self._sub_address == {} and self.loaded:
-            raise Exception("No subaddresses defined")
+        # if self._sub_address == {} and self.loaded:
+        #   raise Exception("No subaddresses defined")
         for sub in range(1, 4):
             if sub not in self._sub_address:
                 for i in range(((sub * 8) + 1), (((sub + 1) * 8) + 1)):
-                    if i in self._channels:
+                    if i in self._channels and not isinstance(
+                        self._channels[i], TemperatureChannelType
+                    ):
                         del self._channels[i]
 
     def _cache(self) -> None:
@@ -321,6 +324,7 @@ class Module:
                         "cmode": message.mode_str,
                         "cstatus": message.status_str,
                         "sleep_timer": message.sleep_timer,
+                        "cool_mode": message.cool_mode,
                     },
                 )
                 await self._channels[chan].maybe_update_temperature(
@@ -445,7 +449,7 @@ class Module:
                 await self._update_channel(
                     channel, {"closed": channel_id in message.closed}
                 )
-                if type(self._channels[channel]) == Button:
+                if type(self._channels[channel]) is Button:
                     # only treat 'enabled' if the channel is a Button
                     await self._update_channel(
                         channel, {"enabled": channel_id in message.enabled}

velbus-aio-2023.10.2/velbusaio/messages/module_type.py

@@ -1,83 +0,0 @@
-"""
-:author: Thomas Delaet <thomas@delaet.org>
-"""
-from __future__ import annotations
-
-import struct
-
-from velbusaio.command_registry import register
-from velbusaio.message import Message
-
-COMMAND_CODE = 0xFF
-MODULES_WITHOUT_SERIAL = {
-    0x01: "VMB8PB",
-    0x02: "VMB1RY",
-    0x03: "VMB1BL",
-    0x05: "VMB6IN",
-    0x07: "VMB1DM",
-    0x08: "VMB4RY",
-    0x09: "VMB2BL",
-    0x0C: "VMB1TS",
-    0x0D: "VMB1TH",
-    0x0E: "VMB1TC",
-    0x0F: "VMB1LED",
-    0x14: "VMBDME",
-}
-
-
-@register(COMMAND_CODE)
-class ModuleTypeMessage(Message):
-    """
-    send by: VMB6IN, VMB4RYLD
-    received by:
-    """
-
-    # pylint: disable-msg=R0902
-
-    def __init__(self, address=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.set_defaults(address)
-
-    def module_name(self):
-        """
-        :return: str
-        """
-        return "Unknown"
-
-    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[-2]
-        self.build_week = data[-1]
-
-    def data_to_binary(self):
-        """
-        :return: bytes
-        """
-        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,
-            ]
-        )