livisi 0.0.1__py3-none-any.whl → 0.0.20__py3-none-any.whl

livisi/livisi_errors.py

@@ -1,124 +0,0 @@
-"""Errors for the Livisi Smart Home component."""
-
-# Taken from https://developer.services-smarthome.de/api_reference/errorcodes/
-ERROR_CODES = {
-    # General Errors
-    1000: "An unknown error has occurred.",
-    1001: "Service unavailable.",
-    1002: "Service timeout.",
-    1003: "Internal API error.",
-    1004: "SHC invalid operation.",
-    1005: "Missing argument or wrong value.",
-    1006: "Service too busy.",
-    1007: "Unsupported request.",
-    1008: "Precondition failed.",
-    # Authentication and Authorization Errors
-    2000: "An unknown error has occurred during Authentication or Authorization process.",
-    2001: "Access not allowed.",
-    2002: "Invalid token request.",
-    2003: "Invalid client credentials.",
-    2004: "The token signature is invalid.",
-    2005: "Failed to initialize user session.",
-    2006: "A connection already exists for the current session.",
-    2007: "The lifetime of the token has expired.",
-    2008: "Login attempted from a different client provider.",
-    2009: "Invalid user credentials.",
-    2010: "Controller access not allowed.",
-    2011: "Insufficient permissions.",
-    2012: "Session not found.",
-    2013: "Account temporary locked.",
-    # Entities Errors
-    3000: "The requested entity does not exist.",
-    3001: "The provided request content is invalid and can't be parsed.",
-    3002: "No change performed.",
-    3003: "The provided entity already exists.",
-    3004: "The provided interaction is not valid.",
-    3005: "Too many entities of this type.",
-    # Products Errors
-    3500: "Premium Services can't be directly enabled.",
-    3501: "Cannot remove a product that was paid.",
-    # Actions Errors
-    4000: "The triggered action is invalid.",
-    4001: "Invalid parameter.",
-    4002: "Permission to trigger action not allowed.",
-    4003: "Unsupported action type.",
-    # Configuration Errors
-    5000: "The configuration could not be updated.",
-    5001: "Could not obtain exclusive access on the configuration.",
-    5002: "Communication with the SHC failed.",
-    5003: "The owner did not accept the TaC latest version.",
-    5004: "One SHC already registered.",
-    5005: "The user has no SHC.",
-    5006: "Controller offline.",
-    5009: "Registration failure.",
-    # SmartCodes Errors
-    6000: "SmartCode request not allowed.",
-    6001: "The SmartCode cannot be redeemed.",
-    6002: "Restricted access.",
-}
-
-
-class LivisiException(Exception):
-    """Base class for Livisi exceptions."""
-
-    def __init__(self, message: str = "", *args: object) -> None:
-        """Initialize the exception with a message."""
-        self.message = message
-        super().__init__(message, *args)
-
-
-class ShcUnreachableException(LivisiException):
-    """Unable to connect to the Smart Home Controller."""
-
-    def __init__(
-        self,
-        message: str = "Unable to connect to the Smart Home Controller.",
-        *args: object,
-    ) -> None:
-        """Generate error with default message."""
-        super().__init__(message, *args)
-
-
-class WrongCredentialException(LivisiException):
-    """The user credentials were wrong."""
-
-    def __init__(
-        self, message: str = "The user credentials are wrong.", *args: object
-    ) -> None:
-        """Generate error with default message."""
-        super().__init__(message, *args)
-
-
-class IncorrectIpAddressException(LivisiException):
-    """The IP address provided by the user is incorrect."""
-
-    def __init__(
-        self,
-        message: str = "The IP address provided by the user is incorrect.",
-        *args: object,
-    ) -> None:
-        """Generate error with default message."""
-        super().__init__(message, *args)
-
-
-class TokenExpiredException(LivisiException):
-    """The authentication token is expired."""
-
-    def __init__(
-        self, message: str = "The authentication token is expired.", *args: object
-    ) -> None:
-        """Generate error with default message."""
-        super().__init__(message, *args)
-
-
-class ErrorCodeException(LivisiException):
-    """The request sent an errorcode (other than token expired) as response."""
-
-    def __init__(self, error_code: int, message: str = None, *args: object) -> None:
-        """Generate error with code."""
-        self.error_code = error_code
-        if (message is None) and (error_code in ERROR_CODES):
-            message = ERROR_CODES[error_code]
-        elif message is None:
-            message = f"Unknown error code from shc: {error_code}"
-        super().__init__(message, *args)

livisi/livisi_json_util.py

@@ -1,23 +0,0 @@
-"""Helper code to parse json to python dataclass (simple and non recursive)."""
-from dataclasses import fields
-import json
-import re
-
-
-def parse_dataclass(jsondata, clazz):
-    """Convert keys to snake_case and parse to dataclass."""
-
-    if isinstance(jsondata, str | bytes | bytearray):
-        parsed_json = json.loads(jsondata)
-    elif isinstance(jsondata, dict):
-        parsed_json = jsondata
-    else:
-        parsed_json = {}
-
-    # Convert keys to snake_case
-    parsed_json = {
-        re.sub("([A-Z])", r"_\1", k).lower(): v for k, v in parsed_json.items()
-    }
-    # Only include keys that are fields in the dataclass
-    data_dict = {f.name: parsed_json.get(f.name) for f in fields(clazz)}
-    return clazz(**data_dict)

livisi/livisi_websocket.py

@@ -1,86 +0,0 @@
-"""Code for communication with the Livisi application websocket."""
-
-from collections.abc import Callable
-import urllib.parse
-
-from json import JSONDecodeError
-import websockets.client
-
-from .livisi_json_util import parse_dataclass
-from .livisi_const import CLASSIC_WEBSOCKET_PORT, V2_WEBSOCKET_PORT, LOGGER
-from .livisi_websocket_event import LivisiWebsocketEvent
-
-
-class LivisiWebsocket:
-    """Represents the websocket class."""
-
-    def __init__(self, aiolivisi) -> None:
-        """Initialize the websocket."""
-        self.aiolivisi = aiolivisi
-        self.connection_url: str = None
-        self._websocket = None
-        self._disconnecting = False
-
-    def is_connected(self):
-        """Return whether the webservice is currently connected."""
-        return self._websocket is not None
-
-    async def connect(self, on_data, on_close) -> None:
-        """Connect to the socket."""
-        if self.aiolivisi.controller.is_v2:
-            port = V2_WEBSOCKET_PORT
-            token = urllib.parse.quote(self.aiolivisi.token)
-        else:
-            port = CLASSIC_WEBSOCKET_PORT
-            token = self.aiolivisi.token
-        ip_address = self.aiolivisi.host
-        self.connection_url = f"ws://{ip_address}:{port}/events?token={token}"
-
-        while not self._disconnecting:
-            try:
-                async with websockets.client.connect(
-                    self.connection_url, ping_interval=10, ping_timeout=10
-                ) as websocket:
-                    LOGGER.info("WebSocket connection established.")
-                    self._websocket = websocket
-                    await self.consumer_handler(websocket, on_data)
-            except Exception as e:
-                LOGGER.exception("Error handling websocket connection", exc_info=e)
-                if not self._disconnecting:
-                    LOGGER.warning("WebSocket disconnected unexpectedly, retrying...")
-                    await on_close()
-            finally:
-                self._websocket = None
-
-    async def disconnect(self) -> None:
-        """Close the websocket."""
-        self._disconnecting = True
-        if self._websocket is not None:
-            await self._websocket.close(code=1000, reason="Handle disconnect request")
-            LOGGER.info("WebSocket connection closed.")
-            self._websocket = None
-        self._disconnecting = False
-
-    async def consumer_handler(self, websocket, on_data: Callable):
-        """Parse data transmitted via the websocket."""
-        try:
-            async for message in websocket:
-                LOGGER.debug("Received WebSocket message: %s", message)
-
-                try:
-                    event_data = parse_dataclass(message, LivisiWebsocketEvent)
-                except JSONDecodeError:
-                    LOGGER.warning("Cannot decode WebSocket message", exc_info=True)
-                    continue
-
-                if event_data.properties is None or event_data.properties == {}:
-                    LOGGER.warning("Received event with no properties, skipping.")
-                    continue
-
-                # Remove the URL prefix and use just the ID (which is unique)
-                event_data.source = event_data.source.removeprefix("/device/")
-                event_data.source = event_data.source.removeprefix("/capability/")
-
-                on_data(event_data)
-        except Exception as e:
-            LOGGER.error("Unhandled error in WebSocket consumer handler", exc_info=e)

livisi/livisi_websocket_event.py

@@ -1,13 +0,0 @@
-"""LivisiWebsocketEvent."""
-from dataclasses import dataclass
-
-
-@dataclass
-class LivisiWebsocketEvent:
-    """Encapuses a livisi event sent via the websocket."""
-
-    namespace: str
-    type: str | None
-    source: str
-    timestamp: str | None
-    properties: dict | None

livisi-0.0.1.dist-info/METADATA

@@ -1,20 +0,0 @@
-Metadata-Version: 2.1
-Name: livisi
-Version: 0.0.1
-Summary: Connection library for the abandoned Livisi Smart Home system
-Author-email: Felix Rotthowe <felix@planbnet.org>
-Project-URL: Source, https://github.com/planbnet/livisi
-Project-URL: Tracker, https://github.com/planbnet/livisi/issues
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: colorlog==6.8.2
-Requires-Dist: aiohttp>=3.8.5
-Requires-Dist: websockets>=11.0.3
-
-Livisi smart home connection library
-
-Readme will be created when everything works as expected

livisi-0.0.1.dist-info/RECORD

@@ -1,14 +0,0 @@
-livisi/__init__.py,sha256=Dh8B_PRVSmch_ClhFCVyV7O2doRCfREHvKGob6MYuRk,2225
-livisi/livisi_connector.py,sha256=VagZFl46y49d3gqrr9iv0YSKLviHRLvAAxcMW4IO734,18095
-livisi/livisi_const.py,sha256=6YqoPdlKX7ogfC_E_ea8opA0JeYIweXRRfpfu-QXTqc,779
-livisi/livisi_controller.py,sha256=XyJ58XMXIxw5anIwHJ5MRVlNUBZyi3RjP8AO8HnYcXo,296
-livisi/livisi_device.py,sha256=Qeh8kdVWY57S1aS5S4ATfi8t2a2k0Bx6njScRC0XKek,1230
-livisi/livisi_errors.py,sha256=N-xEF42KfsCVUghdJYuM8yvpUiI_op1i1mpBiKcrM5Y,4511
-livisi/livisi_json_util.py,sha256=6sQk8ycMUIAKL_8rD3dW_uHWRNa6QMcky-PvcEnM_88,735
-livisi/livisi_websocket.py,sha256=KFY_n7w0grwnczjUDrdijK4RQi-8MOX81uLe6Nw-mSM,3465
-livisi/livisi_websocket_event.py,sha256=pbjyiKid9gOWMcWiw5jq0dbo2DQ7dAQnxM0D_UJBltw,273
-livisi-0.0.1.dist-info/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-livisi-0.0.1.dist-info/METADATA,sha256=35qxzesQNHTTJmVs2eaTujj-LqP_0H96AmpcLwdiHqc,714
-livisi-0.0.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-livisi-0.0.1.dist-info/top_level.txt,sha256=ctiU5MMpBSwoQR7mJWIuyB1ND1_g004Xa3vNmMsSiCs,7
-livisi-0.0.1.dist-info/RECORD,,