diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..d47d68df9562d341202700d1fe3e394e475ee599 --- /dev/null +++ b/README.en.md @@ -0,0 +1,60 @@ + + +# Python Qt Serial Port Assistant + +## Project Introduction +This is a serial communication assistant tool developed using Python and Qt, supporting multiple protocol parsing and serial communication features. Key features include: +- Support for multiple protocol parsing (text protocol/Modbus protocol) +- Graphical user interface (GUI) operations +- Support for serial device connection, disconnection, and configuration +- Data processing module and logging functionality + +## Project Structure +``` +├── app/ # Application entry point +├── core/ # Core functionality module +│ ├── data_processor.py # Data processor +│ ├── protocol.py # Protocol parser +│ └── serial_driver.py # Serial driver +├── ui/ # User interface components +│ ├── console_widget.py # Console display component +│ ├── main_window.py # Main window +│ └── settings_dialog.py# Settings dialog +├── utils/ # Utility modules +│ ├── config.py # Configuration management +│ └── logger.py # Logging functionality +├── tests/ # Test cases +└── serial_assistant.log # Runtime log file +``` + +## Usage Instructions +1. Launch the application: Run `app/main.py` +2. Main features: + - Automatically detects available serial ports + - Supports serial port connection/disconnection + - Supports data parsing for different protocols + - Provides data sending and receiving functionality + - Supports serial communication configuration + +## Development Environment +- Python 3.10+ +- PyQt5 +- pySerial + +## Testing +Unit tests are located in the `tests/` directory, including: +- Protocol parsing tests +- Serial communication tests + +## License +This project does not explicitly declare a license agreement. Usage and distribution should comply with open-source software regulations, and it is recommended to contact the project maintainer for further information. + +## Contributing Guide +If you would like to contribute to this project: +1. Fork the project repository +2. Create a feature branch +3. Submit a Pull Request +4. Follow the project coding standards + +## Contact Information +For inquiries, please visit the project homepage: https://gitee.com/iNet-space/py-qt-serial-port-assistant \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..d0d27160847f3a65e4f3ac2af28f99c618eecc65 --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# Python Qt串口助手 + +## 项目简介 +这是一个基于Python和Qt开发的串口通信助手工具,支持多种协议解析和串口通信功能。主要特性包括: +- 支持多种协议解析(文本协议/Modbus协议) +- 提供图形化界面操作 +- 支持串口设备连接、断开、配置等功能 +- 包含数据处理模块和日志记录功能 + +## 项目结构 +``` +├── app/ # 应用程序入口 +├── core/ # 核心功能模块 +│ ├── data_processor.py # 数据处理器 +│ ├── protocol.py # 协议解析器 +│ └── serial_driver.py # 串口驱动 +├── ui/ # 用户界面组件 +│ ├── console_widget.py # 控制台显示组件 +│ ├── main_window.py # 主窗口 +│ └── settings_dialog.py# 设置对话框 +├── utils/ # 工具类模块 +│ ├── config.py # 配置管理 +│ └── logger.py # 日志记录 +├── tests/ # 测试用例 +└── serial_assistant.log # 运行日志文件 +``` + +## 使用说明 +1. 启动应用:运行 `app/main.py` +2. 主要功能: + - 自动检测可用串口端口 + - 支持串口连接/断开操作 + - 支持不同协议的数据解析 + - 提供数据发送和接收功能 + - 支持串口参数配置 + +## 开发环境 +- Python 3.10+ +- PyQt5 +- pySerial + +## 测试 +单元测试位于 `tests/` 目录,包含: +- 协议解析测试 +- 串口通信测试 + +## 许可证 +该项目未明确声明使用许可证协议。使用和分发应遵循开源软件的相关规定,并建议联系项目维护者获取更多信息。 + +## 贡献指南 +如果您希望为本项目做贡献,请: +1. Fork项目仓库 +2. 创建功能分支 +3. 提交Pull Request +4. 遵循项目代码规范 + +## 联系方式 +如需联系项目维护者,请访问项目主页:https://gitee.com/iNet-space/py-qt-serial-port-assistant \ No newline at end of file