azhi-serial 0.1.0__tar.gz

azhi_serial-0.1.0/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.4
+Name: azhi-serial
+Version: 0.1.0
+Summary: Add your description here
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: pyreadline3>=3.5.4
+Requires-Dist: pyserial>=3.5
+
+"C:\Users\azhi_\AppData\Roaming\uv\uv.toml"
+```bash
+[[index]]
+url = "https://pypi.tuna.tsinghua.edu.cn/simple"
+default = true
+```
+```bash
+uv init
+uv add pyserial
+uv add readline3
+uv run python main.py
+```
+```bash
+uv venv
+uv sync
+uv build
+pip install .\dist\azhi_serial-0.1.0-py3-none-any.whl
+azhi-serial --help
+uv publish
+```
+```bash
+pyinstaller -F -i "E:\ziyuan\banner\z_1997.ico" main.py
+```

azhi_serial-0.1.0/README.md

@@ -0,0 +1,23 @@
+"C:\Users\azhi_\AppData\Roaming\uv\uv.toml"
+```bash
+[[index]]
+url = "https://pypi.tuna.tsinghua.edu.cn/simple"
+default = true
+```
+```bash
+uv init
+uv add pyserial
+uv add readline3
+uv run python main.py
+```
+```bash
+uv venv
+uv sync
+uv build
+pip install .\dist\azhi_serial-0.1.0-py3-none-any.whl
+azhi-serial --help
+uv publish
+```
+```bash
+pyinstaller -F -i "E:\ziyuan\banner\z_1997.ico" main.py
+```

azhi_serial-0.1.0/azhi_serial.egg-info/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.4
+Name: azhi-serial
+Version: 0.1.0
+Summary: Add your description here
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+Requires-Dist: pyreadline3>=3.5.4
+Requires-Dist: pyserial>=3.5
+
+"C:\Users\azhi_\AppData\Roaming\uv\uv.toml"
+```bash
+[[index]]
+url = "https://pypi.tuna.tsinghua.edu.cn/simple"
+default = true
+```
+```bash
+uv init
+uv add pyserial
+uv add readline3
+uv run python main.py
+```
+```bash
+uv venv
+uv sync
+uv build
+pip install .\dist\azhi_serial-0.1.0-py3-none-any.whl
+azhi-serial --help
+uv publish
+```
+```bash
+pyinstaller -F -i "E:\ziyuan\banner\z_1997.ico" main.py
+```

azhi_serial-0.1.0/azhi_serial.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+README.md
+comtool.py
+main.py
+pyproject.toml
+azhi_serial.egg-info/PKG-INFO
+azhi_serial.egg-info/SOURCES.txt
+azhi_serial.egg-info/dependency_links.txt
+azhi_serial.egg-info/entry_points.txt
+azhi_serial.egg-info/requires.txt
+azhi_serial.egg-info/top_level.txt
+util/ChecksumHelper.py
+util/Color.py
+util/ConsoleUI.py
+util/LocalSender.py
+util/SerialManager.py
+util/__init__.py
+util/readline3.py

azhi_serial-0.1.0/azhi_serial.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

azhi_serial-0.1.0/azhi_serial.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+azhi-serial = main:main

azhi_serial-0.1.0/azhi_serial.egg-info/requires.txt

@@ -0,0 +1,2 @@
+pyreadline3>=3.5.4
+pyserial>=3.5

azhi_serial-0.1.0/azhi_serial.egg-info/top_level.txt

@@ -0,0 +1,3 @@
+comtool
+main
+util

azhi_serial-0.1.0/comtool.py

@@ -0,0 +1,59 @@
+"""
+串口调试工具
+只依赖pyserial，支持自动检测串口、循环发送、HEX模式和校验功能
+"""
+
+import argparse
+import sys
+import util.readline3 as readline3
+from util.SerialManager import SerialManager
+from util.LocalSender import LoopSender
+from util.ConsoleUI import ConsoleUI
+from util.Color import cprint, Color
+# -------------------------- 主程序入口 --------------------------
+def main():
+    parser = argparse.ArgumentParser(description="串口调试助手 - 优雅的串口调试工具，支持自动检测、循环发送、HEX模式和校验功能")
+    parser.add_argument("-P", "--port", type=str, default=None, help="串口名称 (默认自动检测)")
+    parser.add_argument("-b", "--baud", type=int, default=9600, help="波特率")
+    parser.add_argument("-p", "--parity", choices=["N", "E", "O"], default="N", help="校验位")
+    parser.add_argument("--hex", action="store_true", help="HEX模式")
+    parser.add_argument("-c", "--choice", type=str, default="n", choices=["n", "s", "m"], 
+                        help="校验方式: n=无, s=Checksum8, m=CRC16")
+    parser.add_argument("--loop-period", type=float, default=3.0, help="循环发送间隔时间(秒)")
+    parser.add_argument("-t", "--timeout", type=float, default=0.5, help="串口读取超时时间(秒)")
+    
+    args = parser.parse_args()
+
+    # 1. 初始化串口管理器
+    serial_mgr = SerialManager(args.port, args.baud, args.parity, timeout=args.timeout)
+    try:
+        serial_mgr.open()
+    except Exception as e:
+        # 启动失败为红色
+        cprint(str(e), Color.RED)
+        sys.exit(1)
+
+    # 2. 初始化循环发送器
+    loop_sender = LoopSender(serial_mgr, loop_period=args.loop_period)
+
+    # 3. 初始化 UI 并启动
+    ui = ConsoleUI(serial_mgr, loop_sender, args.hex, args.choice)
+    
+    print("=" * 50)
+    cprint(f"端口: {serial_mgr.port} | 波特: {args.baud} | HEX: {args.hex}", Color.BOLD)
+    cprint(f"校验: {args.choice} (n:无, s:CS8+0x16, m:CRC16)", Color.BOLD)
+    cprint(f"循环间隔: {args.loop_period}s | 超时: {args.timeout}s", Color.BOLD)
+    print("命令: 'loop' 启停循环发送 | Ctrl+C 退出")
+    print("=" * 50)
+
+    ui.start_recv_thread()
+    # ui.run_interactive_loop() # 启动交互(单机版)
+
+    readline3.run_interactive_shell(ui.run_interactive_loop) # 启动交互(使用 readline3)
+    # 清理资源
+    loop_sender.stop_loop()
+    serial_mgr.close()
+    cprint("\n程序已退出", Color.GREEN)
+
+if __name__ == "__main__":
+    main()

azhi_serial-0.1.0/main.py

@@ -0,0 +1,9 @@
+import comtool
+def main():
+    print("Hello from azhi-serial!")
+    print("=" * 50)
+    comtool.main()
+
+
+if __name__ == "__main__":
+    main()

azhi_serial-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "azhi-serial"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "pyreadline3>=3.5.4",
+    "pyserial>=3.5",
+]
+
+# 新增: 定义命令行脚本入口
+[project.scripts]
+azhi-serial = "main:main"
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+# 明确指定顶层模块
+py-modules = ["main", "comtool"]
+# 明确指定子包
+packages = ["util"]

azhi_serial-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

azhi_serial-0.1.0/util/ChecksumHelper.py

@@ -0,0 +1,34 @@
+# -------------------------- 工具类：校验和 helper --------------------------
+class ChecksumHelper:
+    @staticmethod
+    def modbus_crc16(data: bytes) -> int:
+        crc = 0xFFFF
+        for b in data:
+            crc ^= b
+            for _ in range(8):
+                if crc & 1:
+                    crc = (crc >> 1) ^ 0xA001
+                else:
+                    crc >>= 1
+        return crc
+
+    @staticmethod
+    def checksum8(data: bytes) -> int:
+        return sum(data) & 0xFF
+
+    @staticmethod
+    def apply_checksum(tx_buf: bytes, mode: str) -> bytes:
+        """
+        根据模式追加校验和
+        mode: 'n' (无), 's' (Checksum8 + 0x16), 'm' (Modbus CRC16)
+        """
+        if mode == 's':
+            cs = ChecksumHelper.checksum8(tx_buf)
+            return tx_buf + bytes([cs, 0x16])
+        elif mode == 'm':
+            crc = ChecksumHelper.modbus_crc16(tx_buf)
+            low = crc & 0xFF
+            high = (crc >> 8) & 0xFF
+            return tx_buf + bytes([low, high])
+        else:
+            return tx_buf

azhi_serial-0.1.0/util/Color.py

@@ -0,0 +1,13 @@
+# -------------------------- 颜色与工具类 --------------------------
+class Color:
+    """ANSI 颜色代码"""
+    RED = '\033[91m'
+    GREEN = '\033[92m'
+    BLUE = '\033[94m'
+    YELLOW = '\033[93m'
+    RESET = '\033[0m'
+    BOLD = '\033[1m'
+
+def cprint(text: str, color: str = Color.RESET):
+    """彩色打印辅助函数"""
+    print(f"{color}{text}{Color.RESET}")

azhi_serial-0.1.0/util/ConsoleUI.py

@@ -0,0 +1,110 @@
+# -------------------------- UI 类：控制台交互 --------------------------
+import threading
+import sys
+import time
+from util.Color import cprint, Color
+from util.ChecksumHelper import ChecksumHelper
+from util.SerialManager import SerialManager
+from util.LocalSender import LoopSender
+
+
+class ConsoleUI:
+    def __init__(self, serial_mgr: SerialManager, loop_sender: LoopSender, hex_mode: bool, checksum_mode: str):
+        self.serial_mgr = serial_mgr
+        self.loop_sender = loop_sender
+        self.hex_mode = hex_mode
+        self.checksum_mode = checksum_mode.lower()
+        self.console_lock = threading.Lock()
+
+    def start_recv_thread(self):
+        t = threading.Thread(target=self._recv_loop, daemon=True)
+        t.start()
+
+    def _recv_loop(self):
+        while self.serial_mgr.is_open:
+            try:
+                data = self.serial_mgr.read(1024)
+                if not data:
+                    continue
+                
+                with self.console_lock:
+                    # sys.stdout.write('\r\033[K')  # 清除当前行
+                    
+                    if self.hex_mode:
+                        msg = f"[RX HEX] {self._bytes2hex(data)}"
+                    else:
+                        try:
+                            msg = f"[RX TXT] {data.decode('utf-8')}"
+                        except UnicodeDecodeError:
+                            msg = f"[RX HEX] {self._bytes2hex(data)}"
+                    
+                    # RX 均为绿色
+                    sys.stdout.write(f"{Color.GREEN}{msg}{Color.RESET}\n")
+                    # sys.stdout.write(">> ")
+                    sys.stdout.flush()
+            except Exception:
+                break
+
+    def run_interactive_loop(self):
+        try:
+            while True:
+                try:
+                    time.sleep(self.serial_mgr.timeout+0.2) # 避免CPU双线程竞争，input()会阻塞线程，自带\r,清除打印行
+                    user_text = input(">> ")
+                except EOFError:
+                    break
+                
+                if not user_text.strip():
+                    continue
+
+                # 命令处理
+                if user_text.strip().lower() == 'loop':
+                    if self.loop_sender.loop_flag:
+                        self.loop_sender.stop_loop()
+                    else:
+                        self.loop_sender.start_loop()
+                    continue
+
+                # 数据发送处理
+                self._handle_send(user_text)
+
+        except KeyboardInterrupt:
+            pass
+
+    def _handle_send(self, user_text: str):
+        try:
+            if self.hex_mode:
+                tx_buf = bytes.fromhex(user_text.strip().replace(" ", ""))
+            else:
+                tx_buf = user_text.encode("utf-8")
+        except Exception as e:
+            # 错误为红色
+            cprint(f"[错误] 输入格式无效: {e}", Color.RED)
+            return
+
+        # 应用校验
+        final_buf = ChecksumHelper.apply_checksum(tx_buf, self.checksum_mode)
+        
+        # 打印校验信息（Info 为绿色）
+        if self.checksum_mode == 's':
+            cs = ChecksumHelper.checksum8(tx_buf)
+            cprint(f"[Info] 自动追加 Checksum8: {cs:02X} 16", Color.GREEN)
+        elif self.checksum_mode == 'm':
+            crc = ChecksumHelper.modbus_crc16(tx_buf)
+            cprint(f"[Info] 自动追加 Modbus CRC16: {crc & 0xFF:02X} {(crc >> 8) & 0xFF:02X}", Color.GREEN)
+
+        # 发送
+        try:
+            self.serial_mgr.write(final_buf)
+            with self.console_lock:
+                # TX 为蓝色
+                cprint(f"[TX] {self._bytes2hex(final_buf)}", Color.BLUE)
+            
+            self.loop_sender.update_last_data(final_buf)
+        except Exception as e:
+            # 发送错误为红色
+            cprint(f"[发送错误] {e}", Color.RED)
+
+    @staticmethod
+    def _bytes2hex(data: bytes) -> str:
+        return " ".join(f"{b:02X}" for b in data)

azhi_serial-0.1.0/util/LocalSender.py

@@ -0,0 +1,62 @@
+# -------------------------- 业务类：循环发送 --------------------------
+import threading
+import time
+from typing import Optional
+from util.Color import cprint, Color
+from util.SerialManager import SerialManager
+class LoopSender:
+    def __init__(self, serial_mgr: SerialManager, loop_period: float = 3.0):
+        self.serial_mgr = serial_mgr
+        self.loop_period = loop_period
+        self.loop_flag = False
+        self.last_tx_data = b""
+        self.thread: Optional[threading.Thread] = None
+        self._lock = threading.Lock()
+
+    def start_loop(self):
+        with self._lock:
+            if not self.last_tx_data:
+                cprint("[警告] 暂无发送记录，无法开启循环发送", Color.RED)
+                return
+            if self.loop_flag:
+                cprint("[提示] 循环发送已在运行中", Color.GREEN)
+                return
+            
+            self.loop_flag = True
+            self.thread = threading.Thread(target=self._worker, daemon=True)
+            self.thread.start()
+            cprint(f"[状态] 已开启{self.loop_period}秒循环发送", Color.GREEN)
+
+    def stop_loop(self):
+        with self._lock:
+            if self.loop_flag:
+                self.loop_flag = False
+                if self.thread:
+                    self.thread.join(timeout=1)
+                cprint("[状态] 已停止循环发送", Color.GREEN)
+            else:
+                cprint("[提示] 循环发送未运行", Color.GREEN)
+
+    def _worker(self):
+        while True:
+            with self._lock:
+                if not self.loop_flag or not self.serial_mgr.is_open:
+                    break
+                data_to_send = self.last_tx_data
+            
+            if data_to_send:
+                try:
+                    self.serial_mgr.write(data_to_send)
+                    # TX 均为蓝色
+                    cprint(f"\n[循环TX] {self._bytes2hex(data_to_send)}", Color.BLUE)
+                except Exception:
+                    break
+            time.sleep(self.loop_period)
+
+    def update_last_data(self, data: bytes):
+        with self._lock:
+            self.last_tx_data = data
+
+    @staticmethod
+    def _bytes2hex(data: bytes) -> str:
+        return " ".join(f"{b:02X}" for b in data)

azhi_serial-0.1.0/util/SerialManager.py

@@ -0,0 +1,74 @@
+# -------------------------- 工具类：串口管理 --------------------------
+import serial
+import serial.tools.list_ports
+from typing import Optional
+from util.Color import cprint, Color
+class SerialManager:
+    def __init__(self, port: Optional[str], baudrate: int, parity: str, timeout: float = 0.5):
+        self.port = port
+        self.baudrate = baudrate
+        self.parity = parity
+        self.timeout = timeout
+        self.ser: Optional[serial.Serial] = None
+
+    def auto_detect_port(self) -> str:
+        """自动检测端口，如果只有一个则直接使用"""
+        ports = list(serial.tools.list_ports.comports())
+        if not ports:
+            raise Exception("未检测到任何可用串口")
+        
+        if len(ports) == 1:
+            detected_port = ports[0].device
+            cprint(f"[自动检测] 发现唯一串口: {detected_port} ({ports[0].description})", Color.GREEN)
+            return detected_port
+        
+        # 多个端口时，列出并建议用户指定，默认返回第一个
+        cprint("[警告] 检测到多个串口:", Color.GREEN)
+        for p in ports:
+            print(f"  - {p.device}: {p.description}")
+        default_port = ports[0].device
+        cprint(f"[提示] 未指定端口，默认使用: {default_port}", Color.GREEN)
+        return default_port
+
+    def open(self):
+        if not self.port:
+            self.port = self.auto_detect_port()
+
+        parity_map = {
+            "N": serial.PARITY_NONE,
+            "E": serial.PARITY_EVEN,
+            "O": serial.PARITY_ODD,
+        }
+        
+        try:
+            self.ser = serial.Serial(
+                port=self.port,
+                baudrate=self.baudrate,
+                parity=parity_map.get(self.parity, serial.PARITY_NONE),
+                stopbits=serial.STOPBITS_ONE,
+                bytesize=serial.EIGHTBITS,
+                timeout=self.timeout
+            )
+            cprint(f"[成功] 串口已打开: {self.port} @ {self.baudrate}，校验位: {self.parity}", Color.GREEN)
+        except Exception as e:
+            raise Exception(f"串口打开失败: {e}")
+
+    def close(self):
+        if self.ser and self.ser.is_open:
+            self.ser.close()
+            cprint("[信息] 串口已关闭", Color.GREEN)
+
+    def write(self, data: bytes):
+        if self.ser and self.ser.is_open:
+            self.ser.write(data)
+        else:
+            raise Exception("串口未打开")
+
+    def read(self, size: int = 1024) -> bytes:
+        if self.ser and self.ser.is_open:
+            return self.ser.read(size)
+        return b""
+
+    @property
+    def is_open(self):
+        return self.ser.is_open if self.ser else False

azhi_serial-0.1.0/util/readline3.py

@@ -0,0 +1,37 @@
+"""
+交互式命令行shell,支持历史记录和Tab补全。
+只依赖pyreadline3库，适用于Python 3.x版本。
+"""
+import readline
+
+def callable():
+    while True:
+        cmd = input(">>")
+        if cmd.lower() in ["q", "exit"]:
+            break
+        print(f"执行：{cmd}")
+def run_interactive_shell(callable, history_file=".his.txt", history_length=500):
+    """
+    运行一个交互式命令行 shell，支持历史记录和 Tab 补全。
+    
+    Args:
+        history_file (str): 历史记录文件路径。
+        history_length (int): 最大历史记录条数。
+    """
+    readline.parse_and_bind("tab: history-search-backward")
+    readline.set_history_length(history_length)
+
+    try:
+        readline.read_history_file(history_file)
+        callable()
+    except FileNotFoundError:
+        pass
+    except KeyboardInterrupt:
+        print("\n用户已手动中断程序运行。")
+    except Exception as e:
+        print(f"发生错误: {e}")
+    finally:
+        readline.write_history_file(history_file)
+
+if __name__ == "__main__":
+    run_interactive_shell(callable)