Python脚本-jtag_client

2024-12-24
利用Python灵活地从命令行传递主机、端口和命令，方便与 JTAG 服务器进行通信
# -*- coding: utf-8 -*-
#
# Author: ZLin
# Description: JTAG Client for connecting to a JTAG server over TCP.
# Usage: python jtag_client.py -H <host> -p <port> -c <command>
#        -H, --host      : The host where the JTAG server is running (default: localhost).
#        -p, --port      : The port to connect to on the JTAG server (default: 12345).
#        -c, --command   : The JTAG command to send to the server (required).
#
# Example:
#   python jtag_client.py -H localhost -p 12345 -c "READ_REGISTER"
#   python jtag_client.py -c "WRITE_REGISTER"
#


import socket
import argparse

class JTAGClient:
    """
    A client class for connecting to a JTAG server using TCP.

    Attributes:
        host (str): The host where the JTAG server is running.
        port (int): The port to connect to on the JTAG server.
        client_socket (socket.socket): The socket object used to connect to the server.

    Methods:
        connect(): Connects to the JTAG server.
        send_command(command): Sends a JTAG command to the server.
        receive_response(): Receives and prints the server's response.
        close_connection(): Closes the connection to the JTAG server.
    """

    def __init__(self, host='localhost', port=12345):
        """
        Initializes the JTAGClient object with host and port.

        Args:
            host (str): The host where the JTAG server is running. Default is 'localhost'.
            port (int): The port to connect to. Default is 12345.
        """
        self.host = host
        self.port = port
        self.client_socket = None

    def connect(self):
        """Establishes a TCP connection to the JTAG server."""
        self.client_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        try:
            # Try to connect to the JTAG server
            self.client_socket.connect((self.host, self.port))
            print(f"Connected to JTAG server at {self.host}:{self.port}")
        except Exception as e:
            print(f"Error connecting to server: {e}")
            self.close_connection()

    def send_command(self, command):
        """
        Sends a JTAG command to the server.

        Args:
            command (str): The command to send to the server.
        """
        if self.client_socket:
            try:
                # Send the command to the server
                self.client_socket.sendall(command.encode())
                print(f"Sent command: {command}")
            except Exception as e:
                print(f"Error sending command: {e}")
                self.close_connection()

    def receive_response(self):
        """
        Receives and prints the response from the JTAG server.

        Returns:
            str: The server's response.
        """
        if self.client_socket:
            try:
                # Receive the response from the server
                response = self.client_socket.recv(1024).decode()
                print(f"Received response: {response}")
                return response
            except Exception as e:
                print(f"Error receiving response: {e}")
                self.close_connection()

    def close_connection(self):
        """Closes the connection to the JTAG server."""
        if self.client_socket:
            self.client_socket.close()
            print("Connection closed.")


def parse_arguments():
    """
    Parse command-line arguments for host, port, and command.

    Returns:
        tuple: The host, port, and command specified in the command-line arguments.
    """
    parser = argparse.ArgumentParser(description="JTAG Client to connect to a JTAG server.")
    parser.add_argument("-H", "--host", type=str, default="localhost", help="The host to connect to (default: localhost).")
    parser.add_argument("-p", "--port", type=int, default=12345, help="The port to connect to (default: 12345).")
    parser.add_argument("-c", "--command", type=str, required=True, help="The JTAG command to send to the server.")
    
    args = parser.parse_args()
    return args.host, args.port, args.command


if __name__ == "__main__":
    # Parse command-line arguments
    host, port, command = parse_arguments()

    # Create the JTAGClient instance with host, port, and command from command-line arguments
    jtag_client = JTAGClient(host=host, port=port)

    # Connect to the server
    jtag_client.connect()

    # Send the command to the JTAG server
    jtag_client.send_command(command)

    # Receive and print the response
    jtag_client.receive_response()

    # Close the connection
    jtag_client.close_connection()
本文作者： ICXNM-ZLin
本文链接： https://talent-tudou.github.io/2024/12/24/Programming/Python脚本-jtag_client/
版权声明： 本作品采用 CC BY-NC-SA 4.0 进行许可。转载请注明出处！