velbus-aio 2024.4.0__tar.gz → 2024.5.1__tar.gz

{velbus-aio-2024.4.0/velbus_aio.egg-info → velbus_aio-2024.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: velbus-aio
-Version: 2024.4.0
+Version: 2024.5.1
 Summary: Open-source home automation platform running on Python 3.
 Author-email: Maikel Punie <maikel.punie@gmail.com>
 License: MIT
@@ -26,7 +26,7 @@ Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyserial>=3.5.0
-Requires-Dist: pyserial-asyncio>=0.5
+Requires-Dist: pyserial-asyncio_fast>=0.11
 Requires-Dist: backoff>=1.10.0
 
 ![CI](https://github.com/Cereal2nd/velbus-aio/actions/workflows/main.yml/badge.svg)

velbus_aio-2024.5.1/pyproject.toml

@@ -0,0 +1,204 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+
+[project]
+name = "velbus-aio"
+license = {text = "MIT"}
+version = "2024.5.1"
+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",
+    "Programming Language :: Python :: 3.12",
+    "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_fast>=0.11",
+    "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.bandit]
+exclude_dirs = ["tests"]
+skips = ["B301", "B403", "B323", "B104", "B110"]
+
+[tool.bumpver]
+current_version = "2024.5.1"
+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}"',
+]
+
+[tool.ruff]
+required-version = ">=0.3.4"
+
+[tool.ruff.lint]
+select = [
+    "B002", # Python does not support the unary prefix increment
+    "B005", # Using .strip() with multi-character strings is misleading
+    "B007", # Loop control variable {name} not used within loop body
+    "B014", # Exception handler with duplicate exception
+    "B015", # Pointless comparison. Did you mean to assign a value? Otherwise, prepend assert or remove it.
+    "B018", # Found useless attribute access. Either assign it to a variable or remove it.
+    "B023", # Function definition does not bind loop variable {name}
+    "B026", # Star-arg unpacking after a keyword argument is strongly discouraged
+    "B032", # Possible unintentional type annotation (using :). Did you mean to assign (using =)?
+    "B904", # Use raise from to specify exception cause
+    "C", # complexity
+    "COM818", # Trailing comma on bare tuple prohibited
+    "D", # docstrings
+    "DTZ003", # Use datetime.now(tz=) instead of datetime.utcnow()
+    "DTZ004", # Use datetime.fromtimestamp(ts, tz=) instead of datetime.utcfromtimestamp(ts)
+    "E", # pycodestyle
+    "F", # pyflakes/autoflake
+    "G", # flake8-logging-format
+    "I", # isort
+    "ISC", # flake8-implicit-str-concat
+    "ICN001", # import concentions; {name} should be imported as {asname}
+    "LOG", # flake8-logging
+    "N804", # First argument of a class method should be named cls
+    "N805", # First argument of a method should be named self
+    "N815", # Variable {name} in class scope should not be mixedCase
+    "PERF", # Perflint
+    "PGH004", # Use specific rule codes when using noqa
+    "PIE", # flake8-pie
+    "PL", # pylint
+    "PT", # flake8-pytest-style
+    "RET", # flake8-return
+    "RSE", # flake8-raise
+    "RUF005", # Consider iterable unpacking instead of concatenation
+    "RUF006", # Store a reference to the return value of asyncio.create_task
+    # "RUF100", # Unused `noqa` directive; temporarily every now and then to clean them up
+    "S102", # Use of exec detected
+    "S103", # bad-file-permissions
+    "S108", # hardcoded-temp-file
+    "S306", # suspicious-mktemp-usage
+    "S307", # suspicious-eval-usage
+    "S313", # suspicious-xmlc-element-tree-usage
+    "S314", # suspicious-xml-element-tree-usage
+    "S315", # suspicious-xml-expat-reader-usage
+    "S316", # suspicious-xml-expat-builder-usage
+    "S317", # suspicious-xml-sax-usage
+    "S318", # suspicious-xml-mini-dom-usage
+    "S319", # suspicious-xml-pull-dom-usage
+    "S320", # suspicious-xmle-tree-usage
+    "S601", # paramiko-call
+    "S602", # subprocess-popen-with-shell-equals-true
+    "S604", # call-with-shell-equals-true
+    "S608", # hardcoded-sql-expression
+    "S609", # unix-command-wildcard-injection
+    "SIM", # flake8-simplify
+    "T100", # Trace found: {name} used
+    "T20", # flake8-print
+    "TID251", # Banned imports
+    "TRY", # tryceratops
+    "UP", # pyupgrade
+    "W", # pycodestyle
+]
+ignore = [
+    "D202", # No blank lines allowed after function docstring
+    "D203", # 1 blank line required before class docstring
+    "D213", # Multi-line docstring summary should start at the second line
+    "D406", # Section name should end with a newline
+    "D407", # Section name underlining
+    "E501", # line too long
+    "E731", # do not assign a lambda expression, use a def
+
+    "PLC1901", # {existing} can be simplified to {replacement} as an empty string is falsey; too many false positives
+    "PLR0911", # Too many return statements ({returns} > {max_returns})
+    "PLR0912", # Too many branches ({branches} > {max_branches})
+    "PLR0913", # Too many arguments to function call ({c_args} > {max_args})
+    "PLR0915", # Too many statements ({statements} > {max_statements})
+    "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
+    "PLW2901", # Outer {outer_kind} variable {name} overwritten by inner {inner_kind} target
+    "PT004", # Fixture {fixture} does not return anything, add leading underscore
+    "PT011", # pytest.raises({exception}) is too broad, set the `match` parameter or use a more specific exception
+    "PT012", # `pytest.raises()` block should contain a single simple statement
+    "PT018", # Assertion should be broken down into multiple parts
+    "SIM102", # Use a single if statement instead of nested if statements
+    "SIM108", # Use ternary operator {contents} instead of if-else-block
+    "SIM115", # Use context handler for opening files
+    "TRY003", # Avoid specifying long messages outside the exception class
+    "TRY400", # Use `logging.exception` instead of `logging.error`
+    "UP006", # keep type annotation style as is
+    "UP007", # keep type annotation style as is
+    # Ignored due to performance: https://github.com/charliermarsh/ruff/issues/2923
+    "UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
+    # Ignored due to incompatible with mypy: https://github.com/python/mypy/issues/15238
+    "UP040", # Checks for use of TypeAlias annotation for declaring type aliases.
+
+    # May conflict with the formatter, https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
+    "W191",
+    "E111",
+    "E114",
+    "E117",
+    "D206",
+    "D300",
+    "Q",
+    "COM812",
+    "COM819",
+    "ISC001",
+
+    # Disabled because ruff does not understand type of __all__ generated by a function
+    "PLE0605",
+
+    # temporarily disabled
+    "PT019",
+    "RET504",
+    "RET503",
+    "RET502",
+    "RET501",
+    "TRY002",
+    "TRY301"
+]
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false
+
+[tool.ruff.lint.flake8-tidy-imports.banned-api]
+"async_timeout".msg = "use asyncio.timeout instead"
+"pytz".msg = "use zoneinfo instead"
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+combine-as-imports = true
+split-on-trailing-comma = false
+
+[tool.ruff.lint.mccabe]
+max-complexity = 25

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/requirements.txt

@@ -1,3 +1,3 @@
 backoff>=1.10.0
 pyserial>=3.5.0
-pyserial-asyncio>=0.5
+pyserial-asyncio-fast>=0.11

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1/velbus_aio.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: velbus-aio
-Version: 2024.4.0
+Version: 2024.5.1
 Summary: Open-source home automation platform running on Python 3.
 Author-email: Maikel Punie <maikel.punie@gmail.com>
 License: MIT
@@ -26,7 +26,7 @@ Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyserial>=3.5.0
-Requires-Dist: pyserial-asyncio>=0.5
+Requires-Dist: pyserial-asyncio_fast>=0.11
 Requires-Dist: backoff>=1.10.0
 
 ![CI](https://github.com/Cereal2nd/velbus-aio/actions/workflows/main.yml/badge.svg)

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbus_aio.egg-info/requires.txt

@@ -1,3 +1,3 @@
 pyserial>=3.5.0
-pyserial-asyncio>=0.5
+pyserial-asyncio_fast>=0.11
 backoff>=1.10.0

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbusaio/channels.py

@@ -136,17 +136,11 @@ 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 to_cache(self) -> dict:
+        dst = {"name": self._name, "type": type(self).__name__}
+        if hasattr(self, "_Unit"):
+            dst["Unit"] = self._Unit
+        return dst
 
     def __setstate__(self, state):
         self.__dict__.update(state)

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbusaio/command_registry.py

@@ -1,4 +1,5 @@
-"""
+"""Command registry.
+
 :author: Maikel Punie <maikel.punie@gmail.com> and Thomas Delaet <thomas@delaet.org>
 """
 
@@ -87,7 +88,10 @@ MODULE_DIRECTORY = {
 
 
 class CommandRegistry:
+    """Command registry class."""
+
     def __init__(self, module_directory: dict) -> None:
+        """Init method."""
         self._module_directory = module_directory
         self._default_commands = {}
         self._overrides = {}
@@ -95,6 +99,7 @@ class CommandRegistry:
     def register_command(
         self, command_value: int, command_class: type, module_name: str | None = None
     ) -> None:
+        """Register a command."""
         if command_value < 0 or command_value > 255:
             raise ValueError("Command_value should be >=0 and <=255")
         if module_name and module_name not in self._module_directory.values():
@@ -115,6 +120,7 @@ class CommandRegistry:
     def _register_override(
         self, command_value: int, command_class: type, module_type: str
     ) -> None:
+        """Register and override."""
         if module_type not in self._overrides:
             self._overrides[module_type] = {}
         if command_value not in self._overrides[module_type]:
@@ -125,12 +131,14 @@ class CommandRegistry:
             )
 
     def _register_default(self, command_value: int, command_class: type) -> None:
+        """Register a default command."""
         if command_value not in self._default_commands:
             self._default_commands[command_value] = command_class
         else:
             raise Exception("double registration in command registry")
 
     def has_command(self, command_value: int, module_type: int = 0) -> bool:
+        """Find a command."""
         if module_type in self._overrides:
             if command_value in self._overrides[module_type]:
                 return True
@@ -139,6 +147,7 @@ class CommandRegistry:
         return False
 
     def get_command(self, command_value: int, module_type: int = 0) -> None | type:
+        """Search a command in the registry."""
         if module_type in self._overrides:
             if command_value in self._overrides[module_type]:
                 return self._overrides[module_type][command_value]
@@ -151,6 +160,8 @@ commandRegistry = CommandRegistry(MODULE_DIRECTORY)
 
 
 def register(command_value: int, module_types: list[str] | None = None):
+    """Register decorator."""
+
     def inner_register(command_class):
         if module_types:
             for module_type in module_types:

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbusaio/const.py

@@ -1,4 +1,5 @@
-"""
+"""Constant for velbusaio.
+
 Author: Maikel Punie <maikel.punie@gmail.com>
 """
 

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbusaio/controller.py

@@ -1,19 +1,17 @@
-"""
-Main interface for the velbusaio lib
-"""
+"""Main interface for the velbusaio lib."""
 
 from __future__ import annotations
 
 import asyncio
 import logging
 import pathlib
-import pickle
 import re
 import ssl
+import time
 from urllib.parse import urlparse
 
 import serial
-import serial_asyncio
+import serial_asyncio_fast
 
 from velbusaio.channels import Channel
 from velbusaio.const import LOAD_TIMEOUT
@@ -31,15 +29,14 @@ from velbusaio.raw_message import RawMessage
 
 
 class Velbus:
-    """
-    A velbus controller
-    """
+    """A velbus controller."""
 
     def __init__(
         self,
         dsn: str,
         cache_dir: str = get_cache_dir(),
     ) -> None:
+        """Init the Velbus controller."""
         self._log = logging.getLogger("velbus")
 
         self._protocol = VelbusProtocol(
@@ -60,6 +57,7 @@ class Velbus:
         pathlib.Path(self._cache_dir).mkdir(parents=True, exist_ok=True)
 
     async def _on_message_received(self, msg: RawMessage) -> None:
+        """On message received function."""
         await self._handler.handle(msg)
 
     def _on_connection_lost(self, exc: Exception) -> None:
@@ -69,6 +67,7 @@ class Velbus:
             asyncio.ensure_future(self.connect())
 
     def _on_end_of_scan(self) -> None:
+        """Notify the scan failure."""
         self._handler.scan_finished()
 
     async def add_module(
@@ -81,31 +80,23 @@ class Velbus:
         build_year: int | None = None,
         build_week: int | None = None,
     ) -> None:
-        """
-        Add a found module to the module cache
-        """
-        mod = self._load_module_from_cache(self._cache_dir, addr)
-        if mod is not None:
-            self._log.info(f"Load module from CACHE: {addr}")
-            self._modules[addr] = mod
-            self._modules[addr].initialize(self.send)
-            await self._modules[addr].load(True)
-        else:
-            self._log.info(f"Load NEW module: {typ} @ {addr}")
-            self._modules[addr] = Module.factory(
-                addr,
-                typ,
-                data,
-                serial=serial,
-                build_year=build_year,
-                build_week=build_week,
-                memorymap=memorymap,
-                cache_dir=self._cache_dir,
-            )
-            self._modules[addr].initialize(self.send)
-            await self._modules[addr].load()
+        """Add a found module to the module cache."""
+        self._log.info(f"Found module: type:{typ} address:{addr}")
+        self._modules[addr] = Module.factory(
+            addr,
+            typ,
+            data,
+            serial=serial,
+            build_year=build_year,
+            build_week=build_week,
+            memorymap=memorymap,
+            cache_dir=self._cache_dir,
+        )
+        self._modules[addr].initialize(self.send)
+        await self._modules[addr].load()
 
     async def add_submodules(self, addr: int, subList: dict[int, int]) -> None:
+        """Add submodules address to module."""
         for sub_num, sub_addr in subList.items():
             if sub_addr == 0xFF:
                 continue
@@ -114,48 +105,30 @@ class Velbus:
             self._modules[sub_addr] = self._modules[addr]
         self._modules[addr].cleanupSubChannels()
 
-    def _load_module_from_cache(self, cache_dir: str, address: int) -> None | Module:
-        try:
-            cfile = pathlib.Path(f"{cache_dir}/{address}.p")
-            with cfile.open("rb") as fl:
-                o = pickle.load(fl)
-                if isinstance(o, Module):
-                    return o
-        except OSError:
-            pass
-        return None
-
     def get_modules(self) -> dict:
-        """
-        Return the module cache
-        """
+        """Return the module cache."""
         return self._modules
 
     def get_module(self, addr: str) -> None | Module:
-        """
-        Get a module on an address
-        """
-        if addr in self._modules.keys():
+        """Get a module on an address."""
+        if addr in self._modules:
             return self._modules[addr]
         return None
 
     def get_channels(self, addr: str) -> None | dict:
-        """
-        Get the channels for an address
-        """
+        """Get the channels for an address."""
         if addr in self._modules:
             return (self._modules[addr]).get_channels()
         return None
 
     async def stop(self) -> None:
+        """Stop the controller."""
         self._closing = True
         self._auto_reconnect = False
         self._protocol.close()
 
     async def connect(self, test_connect: bool = False) -> None:
-        """
-        Connect to the bus and load all the data
-        """
+        """Connect to the bus and load all the data."""
         auth = None
         # connect to the bus
         if ":" in self._dsn:
@@ -182,23 +155,25 @@ class Velbus:
                 )
 
             except (ConnectionRefusedError, OSError) as err:
-                raise VelbusConnectionFailed() from err
+                raise VelbusConnectionFailed from err
         else:
             # serial port
             try:
-                _transport, _protocol = await serial_asyncio.create_serial_connection(
-                    asyncio.get_event_loop(),
-                    lambda: self._protocol,
-                    url=self._dsn,
-                    baudrate=38400,
-                    bytesize=serial.EIGHTBITS,
-                    parity=serial.PARITY_NONE,
-                    stopbits=serial.STOPBITS_ONE,
-                    xonxoff=0,
-                    rtscts=1,
+                _transport, _protocol = (
+                    await serial_asyncio_fast.create_serial_connection(
+                        asyncio.get_event_loop(),
+                        lambda: self._protocol,
+                        url=self._dsn,
+                        baudrate=38400,
+                        bytesize=serial.EIGHTBITS,
+                        parity=serial.PARITY_NONE,
+                        stopbits=serial.STOPBITS_ONE,
+                        xonxoff=0,
+                        rtscts=1,
+                    )
                 )
             except (FileNotFoundError, serial.SerialException) as err:
-                raise VelbusConnectionFailed() from err
+                raise VelbusConnectionFailed from err
         if test_connect:
             return
         # if auth is required send the auth key
@@ -209,6 +184,7 @@ class Velbus:
         await self.scan()
 
     async def scan(self) -> None:
+        """Scan the bus."""
         self._handler.scan_started()
         for addr in range(1, 256):
             msg = ModuleTypeRequestMessage(addr)
@@ -230,9 +206,7 @@ class Velbus:
             )
 
     async def _check_if_modules_are_loaded(self) -> None:
-        """
-        Task to wait until modules are loaded
-        """
+        """Task to wait until modules are loaded."""
         while True:
             mods_loaded = 0
             for mod in (self.get_modules()).values():
@@ -247,9 +221,7 @@ class Velbus:
             await asyncio.sleep(15)
 
     async def send(self, msg: Message) -> None:
-        """
-        Send a packet
-        """
+        """Send a packet."""
         await self._protocol.send_message(
             RawMessage(
                 priority=msg.priority,
@@ -260,6 +232,7 @@ class Velbus:
         )
 
     def get_all(self, class_name: str) -> list[Channel]:
+        """Get all channels."""
         lst = []
         for addr, mod in (self.get_modules()).items():
             if addr in self._submodules:
@@ -270,9 +243,8 @@ class Velbus:
         return lst
 
     async def sync_clock(self) -> None:
-        """
-        This will send all the needed messages to sync the clock
-        """
-        await self.send(SetRealtimeClock())
-        await self.send(SetDate())
-        await self.send(SetDaylightSaving())
+        """Will send all the needed messages to sync the clock."""
+        lclt = time.localtime()
+        await self.send(SetRealtimeClock(wday=lclt[6], hour=lclt[3], min=lclt[4]))
+        await self.send(SetDate(day=lclt[2], mon=lclt[1], year=lclt[0]))
+        await self.send(SetDaylightSaving(ds=not lclt[8]))

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbusaio/handler.py

@@ -8,7 +8,6 @@ from __future__ import annotations
 import asyncio
 import json
 import logging
-import re
 from typing import TYPE_CHECKING, Awaitable, Callable
 import pkg_resources
 
@@ -105,7 +104,9 @@ class PacketHandler:
             else:
                 self._log.warning(
                     "NOT FOUND IN command_registry: addr={} cmd={} packet={}".format(
-                        address, command_value, ":".join(format(x, "02x") for x in data)
+                        address,
+                        command_value,
+                        ":".join(format(x, "02x") for x in data),
                     )
                 )
         elif self._scan_complete:

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbusaio/helpers.py

@@ -6,7 +6,7 @@ from __future__ import annotations
 
 import os
 import re
-from typing import Any, Dict
+from typing import Any
 
 from velbusaio.const import CACHEDIR
 

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbusaio/message.py

@@ -5,7 +5,6 @@ The velbus abstract message class
 from __future__ import annotations
 
 import json
-from typing import Optional
 
 from velbusaio.const import PRIORITY_FIRMWARE, PRIORITY_HIGH, PRIORITY_LOW
 

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbusaio/messages/cover_off.py

@@ -4,8 +4,6 @@
 
 from __future__ import annotations
 
-import struct
-
 from velbusaio.command_registry import register
 from velbusaio.message import Message
 

{velbus-aio-2024.4.0 → velbus_aio-2024.5.1}/velbusaio/messages/cover_position.py

@@ -4,8 +4,6 @@
 
 from __future__ import annotations
 
-import struct
-
 from velbusaio.command_registry import register
 from velbusaio.message import Message