htd-client-ha 0.1.2__tar.gz

htd_client_ha-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024
+
+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.

htd_client_ha-0.1.2/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: htd-client-ha
+Version: 0.1.2
+Summary: A client supporting Home Theater Direct's gateway device.
+License: MIT
+License-File: LICENSE
+Author: Adam Kirschner
+Author-email: accounts@adamskirschner.com
+Requires-Python: >=3.13,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: pyserial-asyncio (>=0.6,<0.7)
+Project-URL: Issues, https://github.com/theharshl/python-htd/issues
+Project-URL: Repository, https://github.com/theharshl/python-htd
+Description-Content-Type: text/markdown
+
+# htd_client
+
+This library contains a client to communicate with the HTD MC/MCA66 gateway. Future support
+for the Lync system is planned.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+Use pip to install this package
+
+```bash
+pip install htd_client
+```
+
+## Usage
+
+Here's a basic example.
+
+```python
+
+import HtdClient
+from base_client
+
+client = HtdClient("192.168.1.2")
+model_info = client.get_model_info()
+client.async_volume_up()
+client.async_volume_down()
+
+```
+
+## Contributing
+
+[Poetry](https://python-poetry.org/docs/#installation) is used to manage dependencies, run tests, and publish.
+
+Run unit tests
+
+```bash
+$ poetry run pytest
+```
+
+Generate documentation
+
+```bash
+$ poetry run sphinx-build -b html docs docs/_build 
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+

htd_client_ha-0.1.2/README.md

@@ -0,0 +1,55 @@
+# htd_client
+
+This library contains a client to communicate with the HTD MC/MCA66 gateway. Future support
+for the Lync system is planned.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Installation
+
+Use pip to install this package
+
+```bash
+pip install htd_client
+```
+
+## Usage
+
+Here's a basic example.
+
+```python
+
+import HtdClient
+from base_client
+
+client = HtdClient("192.168.1.2")
+model_info = client.get_model_info()
+client.async_volume_up()
+client.async_volume_down()
+
+```
+
+## Contributing
+
+[Poetry](https://python-poetry.org/docs/#installation) is used to manage dependencies, run tests, and publish.
+
+Run unit tests
+
+```bash
+$ poetry run pytest
+```
+
+Generate documentation
+
+```bash
+$ poetry run sphinx-build -b html docs docs/_build 
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

htd_client_ha-0.1.2/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