velbus-aio 2022.12.0__py3-none-any.whl → 2023.5.0__py3-none-any.whl

{velbus_aio-2022.12.0.dist-info → velbus_aio-2023.5.0.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: velbus-aio
-Version: 2022.12.0
-Summary: Python Library for the Velbus protocol based on asyncio
-Home-page: https://github.com/Cereal2nd/velbus-aio
-Author: Maikel Punie
-Author-email: maikel.punie@gmail.com
+Version: 2023.5.0
+Summary: Open-source home automation platform running on Python 3.
+Author-email: Maikel Punie <maikel.punie@gmail.com>
 License: MIT
+Project-URL: Source Code, https://github.com/Cereal2nd/velbus-aio
+Project-URL: Bug Reports, https://github.com/Cereal2nd/velbus-aio/issues
 Keywords: home,velbus,automation
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
@@ -21,7 +21,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Home Automation
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyserial (>=3.5.0)

{velbus_aio-2022.12.0.dist-info → velbus_aio-2023.5.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
 velbusaio/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-velbusaio/channels.py,sha256=mzWVpop2NfmTfioCSjLKhDDgukqxrGF3NntqaiHUhdE,20924
+velbusaio/channels.py,sha256=FH1UO3IFqpQ6cxlQ2QHcEGk4uNXKdaeskPWr-k_ypNE,22129
 velbusaio/command_registry.py,sha256=tC3Mbz_h5YzKqEP5L_rvfgVczharNHS7T-Sollb0Rgk,4430
 velbusaio/const.py,sha256=swJuogDiNX_oKZVcIO5Lac3KYfiTNGieGMRPTHvLJV4,1548
 velbusaio/controller.py,sha256=srmhnY3iK8qrffx_uA3IeTaQq-8NYetxEFBfGDVdm0Y,9254
 velbusaio/discovery.py,sha256=Px6qoZl4QhF17aMz6JxstCORBpLzZGWEK9h4Vyvg57o,1649
 velbusaio/exceptions.py,sha256=js5Pj-vl6OTGWZUoRGBguutVXbvz_fVmslkCcmT2gps,486
-velbusaio/handler.py,sha256=9H2Mxo90zasp61kL7W7HoZ59We5_rchxQJjuHZOavFY,8344
+velbusaio/handler.py,sha256=gI0Zma9SbcVEvAzYno4IJbqwtEYQk5Cp6zxVNtmox54,8342
 velbusaio/helpers.py,sha256=8PWyD13UA244ESk5YwPcRzvjK3OBAqmhwAwC6E9W4B4,2542
 velbusaio/message.py,sha256=ZFy0iup_DK_so_wZsr2F-3A4AJgQGxf5C3TXjK4BMW0,5047
-velbusaio/module.py,sha256=w1cRI6cmA-Wq6E1IJqI1wrqvHybzBml7Ps0Wx3wYq_I,34676
+velbusaio/module.py,sha256=-Qg5_vIVpmd2vLjcGGXLfEKZKI4AE2s5FSq3bZXcREI,34889
 velbusaio/protocol.py,sha256=sut7jf3IJiJRx59w1EJs0AX4Aa15vrPNgIWJrtQkMjc,8220
 velbusaio/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-velbusaio/raw_message.py,sha256=scAZMJN8edrq2hquxeUF_BVs9v4uYLD5teA3K6YNuGI,4517
-velbusaio/util.py,sha256=U_MHfrNw_D3bVMP50VxL4wJFVjlsO5g2h4x124m6U50,1278
-velbusaio/messages/__init__.py,sha256=wnU1vsvW9oIlCsw9TSO_3AcujC6MgOdKBT7DCSHBG8M,5793
+velbusaio/raw_message.py,sha256=5604X_0Itav6Ts89tXWvXs6sdx_KWRvPvSHjtFjXlMA,4613
+velbusaio/util.py,sha256=eCsGQJ9nuzk_B2skBlv3MsNaMaHDXo1a1qSPjObzXH4,1540
+velbusaio/messages/__init__.py,sha256=0q0h3gIls7xJ-zzgLgV_C9G7IGkDa1Tp1vQ4CFY7gEs,5860
 velbusaio/messages/blind_status.py,sha256=3K5JRRn34_N1oQRKNBCkNwWIwhaURYL1ZNZhQZWFnSU,3417
 velbusaio/messages/bus_active.py,sha256=7aSGEASI4WxWZV9HI6P1b_p6wU1UvbJYmT90Hz_I8ls,748
 velbusaio/messages/bus_error_counter_status.py,sha256=GYMAxyIHUZLzse-pzyUgegLMY75ptFLKNP5qADbuNFg,1177
@@ -35,7 +35,8 @@ velbusaio/messages/dali_device_settings_request.py,sha256=3IqaXOxqidJCJ1FxFMDofa
 velbusaio/messages/dali_dim_value_status.py,sha256=V2Fs8CZNihIi9ZxQs7Bxkt9qCInFXxMZnF6vKhIUCnQ,1044
 velbusaio/messages/dimmer_channel_status.py,sha256=nJ_83uVe0FIiwWmGt7XNXcRYu3ikNUwxOOg5nHzaOPw,2470
 velbusaio/messages/dimmer_status.py,sha256=OWaChsyloAvRoywn-LlNz8LeuZKj3k3eNzL5mH49pM4,2927
-velbusaio/messages/edge_set_custom_color.py,sha256=6hj1hj5w0oEnsOSQ_ih6yGGd0MfasLFrojbiN_80i2Q,1273
+velbusaio/messages/edge_set_color.py,sha256=enwPshhNrleAQQwc3RobPt5foZ1ynE_74SlBEuzd86w,3305
+velbusaio/messages/edge_set_custom_color.py,sha256=fw4hQTrTxNBb63XLTY9iLFtPYrNh0mAAE28DCxG9h1A,1337
 velbusaio/messages/fast_blinking_led.py,sha256=Q5scu34RQJZ43EDZCR1kJy63gULSWHN5bpKpqo_XOOc,908
 velbusaio/messages/forced_off.py,sha256=QQiwMbVUW6wegyTLrf1daJiS8KggPXZvepGsBU9_FUo,590
 velbusaio/messages/forced_on.py,sha256=tS7dUayO_0Grco5TfiOMWBUOc0CY44w_7FcpU-ZViJU,589
@@ -60,14 +61,14 @@ velbusaio/messages/realtime_clock_status_request.py,sha256=KEvcmWlgN4XbpHSA90fg3
 velbusaio/messages/receive_buffer_full.py,sha256=dgyzmZ8VxhQk8r4vUs2uWuojut2Akj4IMazkqfDa1e4,857
 velbusaio/messages/receive_ready.py,sha256=f1LdUVcUTG7rj71wCVHgF03zbkIx4CpJKG7zgXIERf4,686
 velbusaio/messages/relay_status.py,sha256=BBJHM54gzbOTAoQ_N8ls3IiJoOIklKFCvBU4odntXvM,2836
-velbusaio/messages/restore_dimmer.py,sha256=Uvf-y7znulDr2dXe6moB-jsYLzDzyXMxbnUakUDSJQQ,1656
+velbusaio/messages/restore_dimmer.py,sha256=W2SGCAMA91cDWd4359RInhB3z4tvnfJ6vPLW2Ycu3vU,1718
 velbusaio/messages/select_program.py,sha256=RHvOvWXC7w8wxMhco0NUDPIMK6r6Q2LCd87Kdnl7hxI,834
 velbusaio/messages/sensor_settings_request.py,sha256=njSYjNTxhNyRKJLP7wexaWHnYiSWbrSlOm_F7myuBdw,818
 velbusaio/messages/sensor_temp_request.py,sha256=R-VNtqqiDbgZjPNfj5nE0_bTuGLD74Zy-FUsrCcyXFI,598
 velbusaio/messages/sensor_temperature.py,sha256=Erh7pIrbxpmurg3x9_di6A6Os_2Sgpid7T6LgHuWQyA,1557
 velbusaio/messages/set_date.py,sha256=cHUmzLxji3WZisRQErX3m3EdnqwkdyQx3_1Ok6x6aYs,1426
 velbusaio/messages/set_daylight_saving.py,sha256=Ihnshq7C1u7-sRN5fKKt3ZlHmOz9-Kj8lbddwQ9Ya9I,1084
-velbusaio/messages/set_dimmer.py,sha256=AXnzyrgSlRtfJ6jNYuWzPnZaFDV17DNxusewvj5UtYw,1864
+velbusaio/messages/set_dimmer.py,sha256=BDIOqLO9KuPWfzn0Ox56VPquRxlwyIdkmCFphrbBZho,1926
 velbusaio/messages/set_led.py,sha256=hNmbmS2hXqTBVfXMWYhyf10-BOvd5ZwimMd74Cyj5PQ,899
 velbusaio/messages/set_realtime_clock.py,sha256=H89tNgxDH5uotjwGbCM05qDMe0ZWhs7dRyyS3n6OLzA,1275
 velbusaio/messages/set_temperature.py,sha256=PMs_uXWMhggIX0s2ikediwTJ4WSpvrXzahCJ0Ak_hks,958
@@ -95,8 +96,8 @@ velbusaio/messages/write_data_to_memory.py,sha256=2bC-vuv_RK3hGxvKeba1zR405ffj-C
 velbusaio/messages/write_memory_block.py,sha256=5pP4hCRV7tc5xYxHO_51t-uCYgNtVHiaPic_ZGG2Y9s,1031
 velbusaio/messages/write_module_address_and_serial_number.py,sha256=gU-yAHxICP6LPQX7BRj-WUfiVpTk0sV1CMlXeElAwl4,1596
 velbusaio/moduleprotocol/protocol.json,sha256=zChwegR8Ic_Msw5iVMV_W3kVmSyK5DwYof46wD7l9H8,883766
-velbus_aio-2022.12.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-velbus_aio-2022.12.0.dist-info/METADATA,sha256=MwN0xmCPRFZ8N9pltXRdUl54MlURCsCq8texDZN-eNU,2948
-velbus_aio-2022.12.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-velbus_aio-2022.12.0.dist-info/top_level.txt,sha256=BQcTbCbPrrHK3h13x0bfArirNX1_BLWJWNaZBS1B6Yo,10
-velbus_aio-2022.12.0.dist-info/RECORD,,
+velbus_aio-2023.5.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+velbus_aio-2023.5.0.dist-info/METADATA,sha256=KnnfurH3T9H8mUbGwaOQY7peciOj0t3zObPZ4L9PwoY,3033
+velbus_aio-2023.5.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+velbus_aio-2023.5.0.dist-info/top_level.txt,sha256=W0-lSOwD23mm8FqaIe9vY20fKicBMIdUVjF-zmfxRnY,15
+velbus_aio-2023.5.0.dist-info/RECORD,,

{velbus_aio-2022.12.0.dist-info → velbus_aio-2023.5.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.38.4)
+Generator: bdist_wheel (0.40.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

{velbus_aio-2022.12.0.dist-info → velbus_aio-2023.5.0.dist-info}/top_level.txt

@@ -1 +1,2 @@
+dist
 velbusaio

velbusaio/channels.py

@@ -18,6 +18,7 @@ from velbusaio.const import (
     VOLUME_LITERS_HOUR,
 )
 from velbusaio.message import Message
+from velbusaio.messages.edge_set_color import SetEdgeColorMessage, CustomColorPriority
 from velbusaio.messages.module_status import PROGRAM_SELECTION
 
 if TYPE_CHECKING:
@@ -275,6 +276,7 @@ class Button(Channel):
     _enabled = True
     _closed = False
     _led_state = None
+    _long = False
 
     def get_categories(self) -> list[str]:
         if self._enabled:
@@ -702,8 +704,42 @@ class EdgeLit(Channel):
     An EdgeLit channel
     """
 
-    # def get_categories(self):
-    #    return ["light"]
+    async def reset_color(self, left=True, top=True, right=True, bottom=True):
+        msg = SetEdgeColorMessage(self._address)
+        msg.apply_background_color = True
+        msg.color_idx = 0
+        msg.apply_to_left_edge = left
+        msg.apply_to_top_edge = top
+        msg.apply_to_right_edge = right
+        msg.apply_to_bottom_edge = bottom
+        msg.apply_to_all_pages = True
+        await self._writer(msg)
+
+    async def set_color(
+        self,
+        color_idx: int,
+        left=True,
+        top=True,
+        right=True,
+        bottom=True,
+        blinking=False,
+        priority=CustomColorPriority.LOW_PRIORITY,
+    ) -> None:
+        """
+        Send the turn off message
+        """
+
+        msg = SetEdgeColorMessage(self._address)
+        msg.apply_background_color = True
+        msg.background_blinking = blinking
+        msg.color_idx = color_idx
+        msg.apply_to_left_edge = left
+        msg.apply_to_top_edge = top
+        msg.apply_to_right_edge = right
+        msg.apply_to_bottom_edge = bottom
+        msg.apply_to_all_pages = True
+        msg.custom_color_priority = priority
+        await self._writer(msg)
 
 
 class Memo(Channel):
@@ -739,7 +775,7 @@ class SelectedProgram(Channel):
         return None
 
     def get_options(self) -> list:
-        return PROGRAM_SELECTION.values()
+        return list(PROGRAM_SELECTION.values())
 
     def get_selected_program(self) -> str:
         return self._selected_program_str

velbusaio/handler.py

@@ -101,7 +101,7 @@ class PacketHandler:
                 msg.populate(priority, address, rtr, data)
                 self._log.debug(f"Received {msg}")
                 # send the message to the modules
-                await (self._velbus.get_module(msg.address)).on_message(msg)
+                await self._velbus.get_module(msg.address).on_message(msg)
             else:
                 self._log.warning(
                     "NOT FOUND IN command_registry: addr={} cmd={} packet={}".format(

velbusaio/messages/__init__.py

@@ -66,6 +66,7 @@ from velbusaio.messages.receive_buffer_full import ReceiveBufferFullMessage
 from velbusaio.messages.receive_ready import ReceiveReadyMessage
 from velbusaio.messages.relay_status import RelayStatusMessage
 from velbusaio.messages.restore_dimmer import RestoreDimmerMessage
+from velbusaio.messages.select_program import SelectProgramMessage
 from velbusaio.messages.sensor_temp_request import SensorTempRequest
 from velbusaio.messages.sensor_temperature import SensorTemperatureMessage
 from velbusaio.messages.set_date import SetDate

velbusaio/messages/edge_set_color.py

@@ -0,0 +1,113 @@
+from __future__ import annotations
+
+from enum import IntEnum
+from velbusaio.command_registry import register
+from velbusaio.message import Message
+
+COMMAND_CODE = 0xD4
+
+
+class CustomColorPriority(IntEnum):
+    LOW_PRIORITY = 1
+    MID_PRIORITY = 2
+    HIGH_PRIORITY = 3
+
+
+@register(COMMAND_CODE, ["VMBEL1", "VMBEL2", "VMBEL4", "VMBELO"])
+class SetEdgeColorMessage(Message):
+    """
+    send by:
+    received by: VMBEL1, VMBEL2, VMBEL4, VMBELO
+    """
+
+    apply_background_color = False
+    apply_continuous_feedback_color = False
+    apply_slow_blinking_feedback_color = False
+    apply_fast_blinking_feedback_color = False
+    custom_color_palette = False
+
+    apply_to_left_edge = False
+    apply_to_top_edge = False
+    apply_to_right_edge = False
+    apply_to_bottom_edge = False
+
+    apply_to_page: int | None = None
+    apply_to_all_pages = False
+
+    background_blinking = False
+    custom_color_priority: CustomColorPriority | None = None
+
+    color_idx: int = 0
+
+    def populate(self, priority, address, rtr, data):
+        """
+        :return: None
+        """
+        self.needs_no_rtr(rtr)
+        self.set_attributes(priority, address, rtr)
+
+        self.apply_background_color = bool(data[0] & 0x01)
+        self.apply_continuous_feedback_color = bool(data[0] & 0x02)
+        self.apply_slow_blinking_feedback_color = bool(data[0] & 0x04)
+        self.apply_fast_blinking_feedback_color = bool(data[0] & 0x08)
+        self.custom_color_palette = bool(data[0] & 0x80)
+
+        self.apply_to_left_edge = bool(data[1] & 0x01)
+        self.apply_to_top_edge = bool(data[1] & 0x02)
+        self.apply_to_right_edge = bool(data[1] & 0x04)
+        self.apply_to_bottom_edge = bool(data[1] & 0x08)
+
+        page = (data[1] & 0b0111_0000) >> 4
+        if page > 0:
+            self.apply_to_page = page
+        self.apply_to_all_pages = bool(data[1] & 0x80)
+
+        self.background_blinking = bool(data[2] & 0x80)
+
+        custom_color_priority_value = data[2] & 0b0110_0000 >> 5
+        if custom_color_priority_value:
+            self.custom_color_priority = CustomColorPriority(
+                custom_color_priority_value
+            )
+
+        self.color_idx = data[2] & 0b0001_1111
+
+    def data_to_binary(self):
+        """
+        :return: bytes
+        """
+
+        byte_2 = (
+            self.apply_background_color * 0x01
+            + self.apply_continuous_feedback_color * 0x02
+            + self.apply_slow_blinking_feedback_color * 0x04
+            + self.apply_fast_blinking_feedback_color * 0x08
+            + self.custom_color_palette * 0x80
+        )
+
+        byte_3 = (
+            self.apply_to_left_edge * 0x01
+            + self.apply_to_top_edge * 0x02
+            + self.apply_to_right_edge * 0x04
+            + self.apply_to_bottom_edge * 0x08
+            + (((self.apply_to_page or 0) & 0xFFF) << 4)
+            + self.apply_to_all_pages * 0x80
+        )
+
+        byte_4 = (
+            (self.color_idx & 0xFFFF)
+            + (
+                (int(self.custom_color_priority) if self.custom_color_priority else 0)
+                << 5
+            )
+            + self.background_blinking * 0x80
+        )
+
+        return bytes(
+            [
+                COMMAND_CODE,
+                byte_2,
+                byte_3,
+                byte_4,
+            ]
+        )

velbusaio/messages/edge_set_custom_color.py

@@ -9,11 +9,11 @@ from velbusaio.message import Message
 COMMAND_CODE = 0xD4
 
 
-@register(COMMAND_CODE)
+@register(COMMAND_CODE, ["VMBEL1", "VMBEL2", "VMBEL4", "VMBELO"])
 class EdgeSetCustomColor(Message):
     """
     send by:
-    received by: VMB4RYLD
+    received by: VMBEL1, VMBEL2, VMBEL4, VMBELO
     """
 
     def __init__(self, address=None):

velbusaio/messages/restore_dimmer.py

@@ -59,5 +59,6 @@ class RestoreDimmerMessage2(RestoreDimmerMessage):
         return [byte]
 
     def channels_to_byte(self, channels: list[int]) -> int:
-        assert len(channels) == 1
+        if len(channels) != 1:
+            raise ValueError("We should have exact one channel")
         return channels[0]

velbusaio/messages/set_dimmer.py

@@ -67,5 +67,6 @@ class SetDimmerMessage2(SetDimmerMessage):
         return [byte]
 
     def channels_to_byte(self, channels) -> int:
-        assert len(channels) == 1
+        if len(channels) != 1:
+            raise ValueError("We should have exact one channel")
         return channels[0]

velbusaio/module.py

@@ -176,7 +176,7 @@ 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 == {}:
-            assert "No subaddresses defined"
+            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)):
@@ -372,8 +372,12 @@ class Module:
                     channel = self._translate_channel_name(channel_id + _channel_offset)
                     if channel_id in message.closed:
                         await self._update_channel(channel, {"closed": True})
+                    if channel_id in message.closed_long:
+                        await self._update_channel(channel, {"long": True})
                     if channel_id in message.opened:
-                        await self._update_channel(channel, {"closed": False})
+                        await self._update_channel(
+                            channel, {"closed": False, "long": False}
+                        )
         elif isinstance(message, (ModuleStatusMessage)):
             for channel_id in range(1, 9):
                 channel = self._translate_channel_name(channel_id + _channel_offset)

velbusaio/raw_message.py

@@ -78,10 +78,10 @@ class ParseError(Exception):
 
 
 def _parse(rawmessage: bytearray) -> Tuple[Optional[RawMessage], bytearray]:
-    assert (
-        MINIMUM_MESSAGE_SIZE <= len(rawmessage) <= MAXIMUM_MESSAGE_SIZE
-    ), "Received a raw message with an illegal length"
-    assert rawmessage[0] == START_BYTE
+    if len(rawmessage) < MINIMUM_MESSAGE_SIZE or len(rawmessage) > MAXIMUM_MESSAGE_SIZE:
+        raise ValueError("Received a raw message with an illegal lemgth")
+    if rawmessage[0] != START_BYTE:
+        raise ValueError("Received a raw message with the wrong startbyte")
 
     priority = rawmessage[1]
     if priority not in PRIORITIES:

velbusaio/util.py

@@ -6,8 +6,10 @@ from velbusaio.const import MAXIMUM_MESSAGE_SIZE, MINIMUM_MESSAGE_SIZE
 # Copyright (c) 2017 Thomas Delaet
 # Copied from python-velbus (https://github.com/thomasdelaet/python-velbus)
 def checksum(data: Union[bytes, bytearray]) -> int:
-    assert len(data) >= MINIMUM_MESSAGE_SIZE - 2
-    assert len(data) <= MAXIMUM_MESSAGE_SIZE - 2
+    if len(data) < MINIMUM_MESSAGE_SIZE - 2:
+        raise ValueError("The message is shorter then expected")
+    if len(data) > MAXIMUM_MESSAGE_SIZE - 2:
+        raise ValueError("The message is longer then expected")
     __checksum = 0
     for data_byte in data:
         __checksum += data_byte
@@ -35,12 +37,13 @@ class BitSet:
         self._value = value
 
     def __getitem__(self, idx: int) -> bool:
-        assert 0 <= idx < 8
+        if idx > 8 or idx <= 0:
+            raise ValueError("The bitSet id is not within expected range 0 < id < 8")
         return bool((1 << idx) & self._value)
 
     def __setitem__(self, idx: int, value: bool) -> None:
-        assert 0 <= idx < 8
-        assert isinstance(value, bool)
+        if idx > 8 or idx <= 0:
+            raise ValueError("The bitSet id is not within expected range 0 < id < 8")
         mask = (0xFF ^ (1 << idx)) & self._value
         self._value = mask & (value << idx)