hid-usb-relay 25.0.0__py3-none-any.whl

hid_usb_relay/rest_api.py

@@ -0,0 +1,116 @@
+import socket
+import uvicorn
+import logging
+from fastapi import FastAPI, HTTPException
+from fastapi.responses import HTMLResponse
+
+from hid_usb_relay.usb_relay import (
+    set_relay_device_state,
+    set_relay_device_relay_state,
+    get_relay_device_state,
+    get_relay_device_relay_state,
+    set_default_relay_device_state,
+    set_default_relay_device_relay_state,
+    get_default_relay_device_state,
+    get_default_relay_device_relay_state,
+)
+
+app = FastAPI()
+
+logging.basicConfig(level=logging.INFO)
+
+helper_text = """
+<h1>YCR HID USB Relay Web API</h1>
+<h2>Endpoints</h2>
+<ul>
+    <li><b>/</b> ➖ This page</li>
+    <li><b>/relay/1/on</b> ➖ Turn ON Relay 1 of Default Relay Device</li>
+    <li><b>/relay/2/off</b> ➖ Turn OFF Relay 2 of Default Relay Device</li>
+    <li><b>/relay/all/on</b> ➖ Turn ON all Relays of Default Relay Device</li>
+    <li><b>/relay/all/off</b> ➖ Turn OFF all Relays of Default Relay Device</li>
+    <li><b>/relay/HURTM/1/on</b> ➖ Turn ON Relay 1 of Relay Id "HURTM"</li>
+    <li><b>/relay/HURTM/2/off</b> ➖ Turn OFF Relay 2 of Relay Id "HURTM"</li>
+    <li><b>/relay/HURTM/all/on</b> ➖ Turn ON all Relays of Relay Id "HURTM"</li>
+    <li><b>/relay/HURTM/all/off</b> ➖ Turn OFF all Relays of Relay Id "HURTM"</li>
+</ul>
+"""
+
+@app.get("/", response_class=HTMLResponse)
+def root_page_help() -> str:
+    """
+    Provides help text for the root page.
+
+    Returns:
+        str: The help text for the root page.
+    """
+    return helper_text
+
+@app.get("/relay/{relay_id}/{relay_number}/{relay_state}")
+def relay_control_by_id(relay_id: str, relay_number: str, relay_state: str) -> dict:
+    """
+    Controls the state of a relay by its ID and relay number.
+
+    Args:
+        relay_id (str): The ID of the relay device.
+        relay_number (str): The number of the relay to control. Use "all" to control all relays.
+        relay_state (str): The desired state of the relay (e.g., "on", "off").
+
+    Returns:
+        dict: A dictionary containing the status of the operation and the current state of the relay.
+
+    Raises:
+        HTTPException: If the relay state could not be set or if an internal server error occurs.
+    """
+    try:
+        if relay_number.lower() == "all":
+            ret_val = set_relay_device_state(relay_id, relay_state.upper())
+        else:
+            ret_val = set_relay_device_relay_state(relay_id, relay_number, relay_state.upper())
+
+        if ret_val:
+            if relay_number.lower() == "all":
+                response_text = get_relay_device_state(relay_id)
+            else:
+                response_text = get_relay_device_relay_state(relay_id, relay_number)
+            return {"status": "success", "relay_state": response_text}
+        else:
+            raise HTTPException(status_code=400, detail="Failed to set relay state. Check command.")
+    except Exception as e:
+        logging.error(f"Error in relay_control_by_id: {e}")
+        raise HTTPException(status_code=500, detail="Internal Server Error")
+
+@app.get("/relay/{relay_number}/{relay_state}")
+def default_relay_control(relay_number: str, relay_state: str) -> dict:
+    """
+    Controls the state of a relay or all relays on the default relay device.
+
+    Args:
+        relay_number (str): The relay number to control. Use "all" to control all relays.
+        relay_state (str): The desired state of the relay(s). Typically "on" or "off".
+
+    Returns:
+        dict: A dictionary containing the status of the operation and the current state of the relay(s).
+
+    Raises:
+        HTTPException: If the relay state could not be set or if an internal error occurs.
+    """
+    try:
+        if relay_number.lower() == "all":
+            ret_val = set_default_relay_device_state(relay_state.upper())
+        else:
+            ret_val = set_default_relay_device_relay_state(relay_number, relay_state.upper())
+
+        if ret_val:
+            if relay_number.lower() == "all":
+                response_text = get_default_relay_device_state()
+            else:
+                response_text = get_default_relay_device_relay_state(relay_number)
+            return {"status": "success", "relay_state": response_text}
+        else:
+            raise HTTPException(status_code=400, detail="Failed to set relay state. Check command.")
+    except Exception as e:
+        logging.error(f"Error in default_relay_control: {e}")
+        raise HTTPException(status_code=500, detail="Internal Server Error")
+
+if __name__ == "__main__":
+    uvicorn.run(app, host=socket.getfqdn(), port=9400)

hid_usb_relay/usb_relay.py

@@ -0,0 +1,197 @@
+"""
+This module provides functions to interact with a USB relay device using command-line commands.
+It allows users to get and set the state of the relay device, as well as retrieve information about the relay device's status.
+"""
+
+import os
+import platform
+import subprocess
+from typing import Optional, Tuple, List
+
+def get_platform_and_architecture() -> Tuple[str, str]:
+    """
+    Get the current system platform and architecture.
+
+    Returns:
+        tuple: (system, architecture), both lowercase strings.
+    """
+    return platform.system().lower(), platform.architecture()[0].lower()
+
+def get_bin_path() -> str:
+    """
+    Get the absolute path to the package's binary folder.
+
+    Returns:
+        str: Path to the binary folder.
+    """
+    return os.path.join(os.path.dirname(os.path.abspath(__file__)), 'hid_usb_relay_bin')
+
+def get_relay_path(file_name: str) -> str:
+    """
+    Build the path to a relay binary/library for the current platform and architecture.
+
+    Args:
+        file_name (str): Name of the binary/library file.
+
+    Returns:
+        str: Full path to the file.
+
+    Raises:
+        OSError: If the system platform is unsupported.
+    """
+    bin_dir = get_bin_path()
+    system, arch = get_platform_and_architecture()
+    if system not in ['windows', 'linux']:
+        raise OSError(f'Unsupported system platform: {system}')
+    return os.path.join(bin_dir, system, arch, file_name)
+
+def get_relay_executable() -> str:
+    """
+    Get the path to the relay command-line executable for the current platform.
+
+    Returns:
+        str: Full path to the relay executable.
+    """
+    exe_name = "hidusb-relay-cmd.exe" if platform.system().lower() == 'windows' else "hidusb-relay-cmd"
+    return get_relay_path(exe_name)
+
+def get_relay_library() -> str:
+    """
+    Get the path to the relay library for the current platform.
+
+    Returns:
+        str: Full path to the relay library.
+    """
+    lib_name = "USB_RELAY_DEVICE.dll" if platform.system().lower() == 'windows' else "usb_relay_device.so"
+    return get_relay_path(lib_name)
+
+def run_command(command: List[str]) -> Optional[str]:
+    """
+    Run a command using subprocess and return its output.
+
+    Args:
+        command (List[str]): Command and arguments as a list.
+
+    Returns:
+        Optional[str]: Output string if successful, None otherwise.
+    """
+    process = subprocess.run(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
+    if process.returncode == 0:
+        return process.stdout.strip()
+    print(f"Error executing command: {process.stderr}")
+    return None
+
+def get_default_relay_device_state() -> Optional[List[str]]:
+    """
+    Get the status of the default relay device.
+
+    Returns:
+        Optional[List[str]]: List of relay states, or None on error.
+    """
+    output = run_command([get_relay_executable(), "STATUS"])
+    return output.split(':')[-1].strip().split(' ') if output else None
+
+def set_default_relay_device_state(relay_state: str) -> bool:
+    """
+    Set all relays on the default device to a given state.
+
+    Args:
+        relay_state (str): "ON" or "OFF".
+
+    Returns:
+        bool: True if successful, False otherwise.
+    """
+    return run_command([get_relay_executable(), relay_state, "ALL"]) is not None
+
+def get_relay_device_state(relay_id: str) -> Optional[List[str]]:
+    """
+    Get the status of a specific relay device by ID.
+
+    Args:
+        relay_id (str): Relay device ID.
+
+    Returns:
+        Optional[List[str]]: List of relay states, or None on error.
+    """
+    output = run_command([get_relay_executable(), f"id={relay_id}", "STATUS"])
+    return output.split(':')[-1].strip().split(' ') if output else None
+
+def set_relay_device_state(relay_id: str, relay_state: str) -> bool:
+    """
+    Set all relays on a specific device to a given state.
+
+    Args:
+        relay_id (str): Relay device ID.
+        relay_state (str): "ON" or "OFF".
+
+    Returns:
+        bool: True if successful, False otherwise.
+    """
+    return run_command([get_relay_executable(), f"id={relay_id}", relay_state, "ALL"]) is not None
+
+def get_all_relay_device_state() -> Optional[str]:
+    """
+    Get the status of all connected relay devices.
+
+    Returns:
+        Optional[str]: Status string, or None on error.
+    """
+    return run_command([get_relay_executable(), "ENUM"])
+
+def get_relay_device_relay_state(relay_id: str, relay_number: str) -> Optional[str]:
+    """
+    Get the state of a specific relay on a specific device.
+
+    Args:
+        relay_id (str): Relay device ID.
+        relay_number (str): Relay number as string (e.g., "1").
+
+    Returns:
+        Optional[str]: State ("ON"/"OFF") or None on error.
+    """
+    states = get_relay_device_state(relay_id)
+    if states:
+        return states[int(relay_number) - 1].split('=')[-1]
+    return None
+
+def set_relay_device_relay_state(relay_id: str, relay_number: str, relay_state: str) -> bool:
+    """
+    Set the state of a specific relay on a specific device.
+
+    Args:
+        relay_id (str): Relay device ID.
+        relay_number (str): Relay number as string (e.g., "1").
+        relay_state (str): "ON" or "OFF".
+
+    Returns:
+        bool: True if successful, False otherwise.
+    """
+    return run_command([get_relay_executable(), f"id={relay_id}", relay_state, relay_number]) is not None
+
+def get_default_relay_device_relay_state(relay_number: str) -> Optional[str]:
+    """
+    Get the state of a specific relay on the default device.
+
+    Args:
+        relay_number (str): Relay number as string (e.g., "1").
+
+    Returns:
+        Optional[str]: State ("ON"/"OFF") or None on error.
+    """
+    states = get_default_relay_device_state()
+    if states:
+        return states[int(relay_number) - 1].split('=')[-1]
+    return None
+
+def set_default_relay_device_relay_state(relay_number: str, relay_state: str) -> bool:
+    """
+    Set the state of a specific relay on the default device.
+
+    Args:
+        relay_number (str): Relay number as string (e.g., "1").
+        relay_state (str): "ON" or "OFF".
+
+    Returns:
+        bool: True if successful, False otherwise.
+    """
+    return run_command([get_relay_executable(), relay_state, relay_number]) is not None

hid_usb_relay-25.0.0.dist-info/METADATA

@@ -0,0 +1,48 @@
+Metadata-Version: 2.3
+Name: hid-usb-relay
+Version: 25.0.0
+Summary: hid based usb relay package
+Keywords: Python,HID,USB,RELAY
+Author: chaitu-ycr
+Author-email: chaitu-ycr <chaitu.ycr@gmail.com>
+License: MIT License
+         
+         Copyright (c) 2025 chaitu-ycr
+         
+         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.
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Microsoft :: Windows
+Requires-Dist: gradio
+Requires-Dist: fastapi[standard]
+Requires-Python: >=3.10, <=3.14
+Project-URL: documentation, https://chaitu-ycr.github.io/automotive-test-kit/packages/hid_usb_relay
+Project-URL: homepage, https://github.com/chaitu-ycr/automotive-test-kit/tree/main/packages/hid_usb_relay
+Project-URL: repository, https://github.com/chaitu-ycr/automotive-test-kit
+Description-Content-Type: text/markdown
+
+# hid_usb_relay
+
+hid based usb relay package
+
+## [source manual](https://chaitu-ycr.github.io/automotive-test-kit/packages/hid_usb_relay/#source-manual)

hid_usb_relay-25.0.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+hid_usb_relay/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hid_usb_relay/hid_usb_relay_bin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hid_usb_relay/hid_usb_relay_bin/linux/32bit/hidusb-relay-cmd,sha256=kZpUbPucCsGzHXizusMupgSMhfJhj9-As1E5gzLFtX4,17051
+hid_usb_relay/hid_usb_relay_bin/linux/64bit/hidusb-relay-cmd,sha256=RvWPyw5o0TPBqLcjZfc3iCBHodM9k_l5NrstWDTnr90,18759
+hid_usb_relay/hid_usb_relay_bin/windows/32bit/GUIapp.exe,sha256=KYPvhXRzh8XcG2_T01a9F1rDTNZ2lSvF6alzbVu_INY,61440
+hid_usb_relay/hid_usb_relay_bin/windows/32bit/USB_RELAY_DEVICE.dll,sha256=O-WWBlxyNJzuvJswQ_rnFTkg6FeWR-LBqsLfPCBqNWU,52736
+hid_usb_relay/hid_usb_relay_bin/windows/32bit/hidusb-relay-cmd.exe,sha256=uhuw_pnRRmQAcbZHC9fwwTbL8fwfyN6jMfXsNHB_GAk,66048
+hid_usb_relay/hid_usb_relay_bin/windows/64bit/GUIapp.exe,sha256=HxUtZEguzAV41H3CQfAG6EbiOVChJxgjWj_0IHCaJvI,69632
+hid_usb_relay/hid_usb_relay_bin/windows/64bit/USB_RELAY_DEVICE.dll,sha256=vcbH-kbY6QCWRYGQ-EiRCIoXgIgZlckc0pHXoU9eJIE,86528
+hid_usb_relay/hid_usb_relay_bin/windows/64bit/hidusb-relay-cmd.exe,sha256=wknn0l05jSHsvmwKrFlit2p8gPMbQP3LkV_5gwjmWTs,92672
+hid_usb_relay/rest_api.py,sha256=5HzVPE5WAkVg2M_w7-0YFUvCnsGMTp8pDO91Vg2iI1o,4644
+hid_usb_relay/usb_relay.py,sha256=B5lnTDhMQjjhFzg9sIVeGC-08gy7CEUvm9tP5k4uFVg,6418
+hid_usb_relay-25.0.0.dist-info/WHEEL,sha256=5h_Q-_6zWQhhADpsAD_Xpw7gFbCRK5WjOOEq0nB806Q,79
+hid_usb_relay-25.0.0.dist-info/METADATA,sha256=fw-zZoVFpzMJELZcZsZqMe8W9mCb_Y9NymAgiwaYijE,2375
+hid_usb_relay-25.0.0.dist-info/RECORD,,

hid_usb_relay-25.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.8.18
+Root-Is-Purelib: true
+Tag: py3-none-any