htd-client-ha 0.1.2__py3-none-any.whl

htd_client/__init__.py

@@ -0,0 +1,107 @@
+"""
+.. code-block:: python
+
+    # import the client
+    from htd_client import HtdClient
+
+    # Call its only function
+    client = HtdClient("192.168.1.2")
+
+    model_info = client.get_model_info()
+    zone_info = client.query_zone(1)
+    updated_zone_info = client.volume_up(1)
+"""
+import asyncio
+import logging
+from typing import Tuple
+
+import htd_client.utils
+from .base_client import BaseClient
+from .constants import HtdCommonCommands, HtdModelInfo, HtdDeviceKind, HtdConstants
+from .lync_client import HtdLyncClient
+from .mca_client import HtdMcaClient
+
+_LOGGER = logging.getLogger(__name__)
+
+
+async def async_get_client(
+    serial_address: str = None,
+    network_address: Tuple[str, int] = None,
+    loop: asyncio.AbstractEventLoop = None,
+    retry_attempts: int = HtdConstants.DEFAULT_RETRY_ATTEMPTS,
+) -> BaseClient:
+    """
+    Create a new client object.
+
+    Args:
+        network_address (str): The address to communicate with over TCP.
+        serial_address (str): The location of the serial port.
+        loop (asyncio.AbstractEventLoop): The event loop to use.
+        retry_attempts (int): Number of times to retry a command before failing.
+
+    Returns:
+        HtdClient: The new client object.
+    """
+
+    model_info = await async_get_model_info(
+        loop if loop is not None else asyncio.get_running_loop(),
+        network_address=network_address,
+        serial_address=serial_address
+    )
+
+    if model_info["kind"] == HtdDeviceKind.mca:
+        client = HtdMcaClient(
+            loop if loop is not None else asyncio.get_running_loop(),
+            model_info,
+            network_address=network_address,
+            serial_address=serial_address,
+            retry_attempts=retry_attempts,
+        )
+
+    elif model_info["kind"] == HtdDeviceKind.lync:
+        client = HtdLyncClient(
+            loop if loop is not None else asyncio.get_running_loop(),
+            model_info,
+            network_address=network_address,
+            serial_address=serial_address,
+            retry_attempts=retry_attempts,
+        )
+
+    else:
+        raise ValueError(f"Unknown Device Kind: {model_info['kind']}")
+
+    await client.async_connect()
+
+    return client
+
+
+async def async_get_model_info(
+    loop: asyncio.AbstractEventLoop = None,
+    network_address: Tuple[str, int] = None,
+    serial_address:str=None,
+) -> HtdModelInfo | None:
+    """
+    Get the model information from the gateway.
+
+    Returns:
+         (str, str): the raw model name from the gateway and the friendly
+         name, in a Tuple.
+    """
+
+    cmd = htd_client.utils.build_command(
+        1, HtdCommonCommands.MODEL_QUERY_COMMAND_CODE, 0
+    )
+
+    model_id = await htd_client.utils.async_send_command(
+        loop if loop is not None else asyncio.get_running_loop(),
+        cmd,
+        network_address=network_address,
+        serial_address=serial_address
+    )
+
+    for model_name in HtdConstants.SUPPORTED_MODELS:
+        model = HtdConstants.SUPPORTED_MODELS[model_name]
+        if model["identifier"] in model_id:
+            return model
+
+    return None