pyg90alarm 2.3.0__py3-none-any.whl

pyg90alarm/callback.py

@@ -0,0 +1,146 @@
+# Copyright (c) 2021 Ilia Sotnikov
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Implements callbacks.
+"""
+from __future__ import annotations
+import asyncio
+from functools import (partial, wraps)
+from asyncio import Task
+from typing import (
+    Any, Callable, Coroutine, cast, Optional, Union, TypeVar, Generic
+)
+import logging
+
+Callback = Optional[
+    Union[
+        Callable[..., None],
+        Callable[..., Coroutine[None, None, None]],
+    ]
+]
+T = TypeVar('T', bound=Callback)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class G90Callback:
+    """
+    Implements callbacks.
+    """
+    @staticmethod
+    def invoke(
+        callback: Callback, *args: Any, **kwargs: Any
+    ) -> None:
+        """
+        Invokes the callback.
+        """
+        if not callback:
+            return
+
+        _LOGGER.debug('Attempting to invoke callback %s'
+                      ' (args: %s, kwargs: %s)',
+                      callback, args, kwargs)
+
+        if not asyncio.iscoroutinefunction(callback):
+            def async_wrapper(
+                func: Callable[..., None]
+            ) -> Callable[..., Coroutine[Any, Any, None]]:
+                """
+                Wraps the regular callback function into coroutine, so it could
+                later be created as async task.
+                """
+                @wraps(func)
+                async def wrapper(
+                    *args: Any, **kwds: Any
+                ) -> None:
+                    return func(*args, **kwds)
+
+                return cast(Callable[..., Coroutine[Any, Any, None]], wrapper)
+
+            task = asyncio.create_task(
+                async_wrapper(
+                    cast(Callable[..., None], callback)
+                )(*args, **kwargs)
+            )
+        else:
+            task = asyncio.create_task(callback(*args, **kwargs))
+
+        def reap_callback_exception(task: Task[Any]) -> None:
+            """
+            Reaps an exception (if any) from the task logging it, to prevent
+            `asyncio` reporting that task exception was never retrieved.
+            """
+            exc = task.exception()
+            if exc:
+                _LOGGER.error(
+                    "Got exception when invoking callback '%s(...)':",
+                    cast(
+                        Coroutine[Any, Any, None], task.get_coro()
+                    ).__qualname__,
+                    exc_info=exc, stack_info=False
+                )
+
+        task.add_done_callback(reap_callback_exception)
+
+    @staticmethod
+    def invoke_delayed(
+        delay: float, callback: Callable[..., None], *args: Any, **kwargs: Any
+    ) -> None:
+        """
+        Invokes the callback after a delay.
+        """
+        loop = asyncio.get_running_loop()
+        loop.call_later(delay, partial(callback, *args, **kwargs))
+
+
+class G90CallbackList(Generic[T]):
+    """
+    Implements a list of callbacks.
+    """
+    def __init__(self) -> None:
+        self._callbacks: list[T] = []
+
+    def add(self, callback: T) -> None:
+        """
+        Adds a callback to the list.
+        """
+        if callback and callback not in self._callbacks:
+            self._callbacks.append(callback)
+
+    def remove(self, callback: T) -> None:
+        """
+        Removes a callback from the list.
+        """
+        if callback in self._callbacks:
+            self._callbacks.remove(callback)
+
+    def clear(self) -> None:
+        """
+        Clears the list of callbacks.
+        """
+        self._callbacks.clear()
+
+    def invoke(self, *args: Any, **kwargs: Any) -> None:
+        """
+        Invokes all callbacks in the list.
+        """
+        for callback in self._callbacks:
+            G90Callback.invoke(callback, *args, **kwargs)

pyg90alarm/cloud/__init__.py

@@ -0,0 +1,31 @@
+# Copyright (c) 2025 Ilia Sotnikov
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Cloud communication implementation for G90 alarm systems.
+
+This module provides the necessary components to interact with G90 alarm
+systems through their cloud protocol (referred to as version 1.1).
+"""
+from .notifications import G90CloudNotifications  # noqa: F401
+
+__all__ = [
+    'G90CloudNotifications',
+]

pyg90alarm/cloud/const.py

@@ -0,0 +1,56 @@
+# Copyright (c) 2025 Ilia Sotnikov
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Constants used in the G90 cloud protocol implementation.
+
+This module defines the main enumerations for direction and command types
+used in the cloud protocol communication with G90 alarm systems.
+"""
+from enum import IntEnum
+
+
+class G90CloudDirection(IntEnum):
+    """
+    Defines the direction of G90 cloud protocol messages.
+
+    These values indicate whether messages are flowing from the cloud to the
+    device, from the device to the cloud, or are part of discovery processes.
+    """
+    UNSPECIFIED = 0
+    CLOUD = 32  # 0x20
+    DEVICE = 16  # 0x10
+    DEVICE_DISCOVERY = 48  # 0x30
+    CLOUD_DISCOVERY = 208  # 0xD0
+
+
+class G90CloudCommand(IntEnum):
+    """
+    Defines the command types used in G90 cloud protocol messages.
+
+    These values identify the purpose of each cloud protocol message,
+    such as hello messages, notifications, commands, and status updates.
+    """
+    HELLO = 0x01
+    HELLO_ACK = 0x41
+    NOTIFICATION = 0x22
+    STATUS_CHANGE = 0x21
+    HELLO_INFO = 0x63
+    COMMAND = 0x29