velbus-aio 2022.12.0__tar.gz → 2023.5.0__tar.gz

{velbus-aio-2022.12.0/velbus_aio.egg-info → velbus-aio-2023.5.0}/PKG-INFO

@@ -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
 

velbus-aio-2023.5.0/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+
+[project]
+name        = "velbus-aio"
+license     = {text = "MIT"}
+version     = "2023.5.0"
+description = "Open-source home automation platform running on Python 3."
+readme      = "README.md"
+authors     = [
+    {name = "Maikel Punie", email = "maikel.punie@gmail.com"}
+]
+keywords    = ["home", "velbus", "automation"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Topic :: Home Automation",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.8.0"
+dependencies    = [
+    "pyserial>=3.5.0",
+    "pyserial-asyncio>=0.5",
+    "backoff>=1.10.0",
+]
+
+[project.urls]
+"Source Code" = "https://github.com/Cereal2nd/velbus-aio"
+"Bug Reports" = "https://github.com/Cereal2nd/velbus-aio/issues"
+
+[tool.setuptools]
+platforms = ["any"]
+zip-safe  = false
+include-package-data = true
+
+[tool.setuptools.packages.find]
+exclude = ["tests", "tests.*", "examples"]
+
+[tool.bumpver]
+current_version = "2023.5.0"
+version_pattern = "YYYY.MM.INC0"
+commit_message = "bump version {old_version} -> {new_version}"
+commit = true
+tag = true
+push = true
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = [
+    'version = "{version}"',
+    'current_version = "{version}"',
+]
+"setup.py" = [
+    "{version}",
+    "{pep440_version}",
+]
+"README.md" = [
+    "{version}",
+    "{pep440_version}",
+]

velbus-aio-2023.5.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

velbus-aio-2023.5.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0/velbus_aio.egg-info}/PKG-INFO

@@ -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
 

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0}/velbus_aio.egg-info/SOURCES.txt

@@ -1,12 +1,13 @@
 LICENSE
 MANIFEST.in
 README.md
+pyproject.toml
 requirements.txt
-setup.cfg
 setup.py
 velbus_aio.egg-info/PKG-INFO
 velbus_aio.egg-info/SOURCES.txt
 velbus_aio.egg-info/dependency_links.txt
+velbus_aio.egg-info/not-zip-safe
 velbus_aio.egg-info/requires.txt
 velbus_aio.egg-info/top_level.txt
 velbusaio/__init__.py
@@ -46,6 +47,7 @@ velbusaio/messages/dali_device_settings_request.py
 velbusaio/messages/dali_dim_value_status.py
 velbusaio/messages/dimmer_channel_status.py
 velbusaio/messages/dimmer_status.py
+velbusaio/messages/edge_set_color.py
 velbusaio/messages/edge_set_custom_color.py
 velbusaio/messages/fast_blinking_led.py
 velbusaio/messages/forced_off.py

velbus-aio-2023.5.0/velbus_aio.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0}/velbus_aio.egg-info/top_level.txt

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

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0}/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

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0}/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(

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0}/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

velbus-aio-2023.5.0/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,
+            ]
+        )

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0}/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):

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0}/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]

{velbus-aio-2022.12.0 → velbus-aio-2023.5.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]

{velbus-aio-2022.12.0 → velbus-aio-2023.5.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)

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0}/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:

{velbus-aio-2022.12.0 → velbus-aio-2023.5.0}/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)
 

velbus-aio-2022.12.0/setup.cfg

@@ -1,27 +0,0 @@
-[metadata]
-license = MIT
-license_file = LICENSE
-platforms = any
-description = Python Library for the Velbus protocol based on asyncio
-long_description = file: README.md
-long_description_content_type = text/markdown
-keywords = home, velbus, automation
-classifier = 
-	Development Status :: 5 - Production/Stable
-	Intended Audience :: Developers
-	License :: OSI Approved :: MIT License
-	Natural Language :: English
-	Operating System :: OS Independent
-	Programming Language :: Python
-	Programming Language :: Python :: 3.8
-	Programming Language :: Python :: 3.9
-	Programming Language :: Python :: 3.10
-	Programming Language :: Python :: 3.11
-	Topic :: Home Automation
-	Topic :: Software Development :: Libraries
-	Topic :: Software Development :: Libraries :: Python Modules
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

velbus-aio-2022.12.0/setup.py

@@ -1,22 +0,0 @@
-from setuptools import find_packages, setup
-
-PACKAGES = find_packages(exclude=["tests", "tests.*"])
-
-setup(
-    name="velbus-aio",
-    version="2022.12.0",
-    url="https://github.com/Cereal2nd/velbus-aio",
-    license="MIT",
-    author="Maikel Punie",
-    install_requires=[
-        "pyserial>=3.5.0",
-        "pyserial-asyncio>=0.5",
-        "backoff>=1.10.0",
-    ],
-    author_email="maikel.punie@gmail.com",
-    packages=PACKAGES,
-    include_package_data=True,
-    platforms="any",
-    python_requires=">=3.8",
-    test_suite="tests",
-)