🤖 roboto_origin_03 Wiki
首页 / 固件 / 上位机工具开发

上位机工具是 roboto_usb2can 适配器在 Windows 及 Linux 桌面环境下的配套调试与数据分析程序。它基于 Python 与 tkinter 构建跨平台 GUI,通过 libusb 直接与设备通信,实现多设备并发管理、CAN 报文实时收发、周期性发送与 ID 过滤等核心功能。本文从协议对齐、架构设计、线程模型、打包发布四个维度,系统解析上位机工具的开发要点与实现原理,帮助开发者在现有基础上进行二次扩展或集成到更大的调试平台中。

Sources: roboto_usb2can_tool.py

协议层:gs_usb 控制传输与批量传输的对齐

上位机与固件之间的通信严格遵循 candleLight 兼容的 gs_usb 协议。协议分为两部分:控制传输用于设备配置,批量传输用于 CAN 帧数据交换。Python 端使用 pyusb 库直接操作 USB 设备,绕过操作系统驱动层,实现跨平台一致性。

控制传输的请求码与固件端完全对齐。RobopartyCAN 类封装了所有控制传输调用:请求码 0 用于主机格式协商,1 用于位时间配置,2 用于通道启停,5 用于读取位时间常量,9 用于读取设备配置。其中位时间配置直接决定了 CAN 总线波特率,工具预置了 1Mbps 的标准参数(prop_seg=15, phase_seg1=15, phase_seg2=16, sjw=1, brp=4),并在 GUI 中提供 125K/250K/500K/1M 四档下拉选择。

批量传输端,CAN 帧的内存布局必须与固件 gs_host_frame 结构体逐字节对齐。CANFrame 类使用 struct.pack('<IIBBBB')echo_idcan_idcan_dlcchannelflagsreserved 六个字段打包为 12 字节头部,随后拼接最长 64 字节的载荷与补零填充。接收方向则通过 struct.unpack 反向解析,任何长度不足或格式错误的数据包都会被丢弃,避免异常帧破坏后续解析状态。

Sources: roboto_usb2can_tool.py

架构概览:双层模型与数据流

上位机工具采用典型的 "通信引擎 + GUI 壳层" 双层架构。底层 RobopartyCAN 负责 USB 设备生命周期管理与协议交互,上层 CANToolGUI 负责界面渲染与用户事件分发。两者通过回调函数与线程安全队列解耦,确保 USB 阻塞读取不会冻结主界面。

下图展示了从用户操作到 CAN 总线报文的完整数据流。当用户点击 Connect All 时,GUI 层遍历 usb.core.find() 返回的设备列表,为每个设备实例化独立的 RobopartyCAN 对象;每个对象启动独立的 _rx_loop 守护线程,在 ep_in 端点上执行阻塞读取;收到有效帧后,通过闭包回调将帧对象写入 rx_queue;GUI 层通过 root.after(50, ...) 以 50ms 周期轮询队列,批量刷新日志视图。

flowchart TD
    subgraph GUI["CANToolGUI (主线程)"]
        A[用户点击 Connect All] --> B[usb.core.find 扫描设备]
        B --> C[为每个设备创建 RobopartyCAN]
        C --> D[启动独立 RX 线程]
        E[root.after 50ms 轮询] --> F[从 rx_queue 取帧]
        F --> G[刷新 ScrolledText 日志]
        H[用户点击 Send] --> I[遍历目标设备列表]
        I --> J[调用 dev.write 发送]
    end

    subgraph Engine["RobopartyCAN (每设备独立)"]
        K[_rx_loop 守护线程] --> L[dev.read ep_in 阻塞]
        L --> M[CANFrame.from_bytes 解析]
        M --> N[rx_callback 闭包入队]
        O[send_frame] --> P[CANFrame.to_bytes 打包]
        P --> Q[dev.write ep_out]
    end

    subgraph USB["USB 总线"]
        Q --> R[Bulk OUT → 固件]
        R --> S[固件 gs_usb 栈]
        S --> T[CAN 控制器]
        T --> U[CAN 总线]
        U --> V[CAN 控制器]
        V --> W[固件打包回复帧]
        W --> X[Bulk IN → 上位机]
        X --> L
    end

    D --> K
    J --> O

多设备场景是本工具的设计重点。connected_cans 列表维护所有已连接实例,每个实例持有独立的 ep_in/ep_out 端点引用。发送时通过 target_combo 选择 "All" 或指定 "Device N",GUI 层据此筛选目标列表并逐一下发。接收端则在回调闭包中注入设备索引 dev_idx,使日志能够标注 [Dev 0][Dev 1] 等来源标识,方便在 USB Hub 挂载多节点时定位数据归属。

Sources: roboto_usb2can_tool.py, roboto_usb2can_tool.py

线程模型:守护线程与队列解耦

为了避免 USB 同步读取阻塞主事件循环,工具实现了生产者-消费者并发模型。每个已连接设备对应一个 threading.Thread(daemon=True) 接收线程,在 _rx_loop 中以 100ms 超时轮询 dev.read()。超时仅产生 USBTimeoutError,线程继续循环;收到有效帧则立即通过 rx_callback 入队。

GUI 消费侧采用 tkinter 的 after 机制而非独立线程,这是因为 tkinter 的控件不是线程安全的,所有界面更新必须在主线程完成。_update_rx_display 每 50ms 执行一次,批量消费 rx_queue 中的数据,同时进行三项后处理:ID 过滤(匹配 filter_var 十六进制输入)、空帧过滤(跳过 can_id == 0 && can_dlc == 0 的心跳/占位帧)、日志截断(超过 2000 行时删除前 100 行防止内存膨胀)。这种设计兼顾了实时性与界面响应度,在 1Mbps 高负载下仍能保持流畅。

周期性发送功能同样基于独立守护线程。_periodic_loop 在启用后按用户设定的毫秒间隔循环调用 send_frame(),与接收线程互不干扰。停止时通过 periodic_running 标志位与 join(timeout=1) 实现优雅退出,避免强制终止导致 USB 写操作半包。

Sources: roboto_usb2can_tool.py, roboto_usb2can_tool.py

跨平台支持:Windows 免驱与 Linux 权限

Windows 端设备通过固件内置的 MSOS 2.0 描述符自动绑定 WinUSB 驱动,无需手动安装 INF。上位机仅需确保 libusb-1.0.dll 位于脚本同级目录或系统 PATH 中,即可由 pyusb 后端直接加载。GUI 图标通过 sys._MEIPASS 检测 PyInstaller 单文件打包环境,运行时自动解析临时目录中的 icon.ico,保证打包后图标正常显示。

Linux 端则面临权限问题。普通用户默认无法直接访问原始 USB 设备节点,因此项目提供了 99-roboto-usb2can.rules udev 规则,将 VID 1d50 / PID 606f 的设备权限设为 MODE="0666" 并归属 plugdev 组。安装后重新插拔设备即可免 sudo 运行上位机工具。需要注意的是,Linux 用户除了使用本 Python 工具外,更常见的做法是利用内核原生 gs_usb 驱动将设备映射为 can0 接口,配合 can-utils 工具链工作;本上位机工具主要服务于需要图形化调试或多设备统一管理的不场景。

Sources: 99-roboto-usb2can.rules, roboto_usb2can_tool.py

打包发布:PyInstaller 与 GitHub Actions 自动化

为了让无 Python 环境的用户也能运行,项目使用 PyInstaller 将脚本打包为单文件 Windows EXE。requirements.txt 中声明了 pyusb>=1.2.1pyinstaller>=6.0 两个核心依赖。打包命令采用 --onefile --windowed --clean 参数,将 icon.ico 作为附加数据文件嵌入,最终生成独立可执行文件。

CI/CD 流程由 .github/workflows/build-tool-exe.yml 驱动。触发条件限定为 scripts/roboto_usb2can_tool.py 的变更,避免无关提交消耗资源。工作流在 windows-latest 运行器上执行:安装 Python 3.11、缓存 pip 依赖、运行 PyInstaller、上传 Artifact 并保留 30 天。当推送标签时,工作流还会自动创建 GitHub Release,将 EXE 作为附件发布,实现"代码提交 → 自动构建 → 版本发布"的完整闭环。

Sources: requirements.txt, build-tool-exe.yml

Linux 压力测试:SocketCAN 脚本

虽然上位机工具提供了图形化收发能力,但在 Linux 环境下进行高负载稳定性验证时,命令行脚本更为高效。test_roboto_usb2can.sh 是针对 SocketCAN 接口的自动化压力测试脚本,支持多接口并发、速率监控与错误统计。脚本核心逻辑分为三步:初始化接口(设置波特率、MTU 16、重启延迟 100ms、发送队列长度 2000)、启动 cangen 后台流量生成器、每秒轮询 /sys/class/net/*/statistics/ 刷新仪表盘。

其中 MTU 强制设为 16 字节是为了抑制 USB 传输层的零填充问题;restart-ms 100 则保证总线进入 Bus-Off 后自动恢复,避免人工干预。流量生成使用 -I R 随机 ID 策略,防止固定小 ID 在高负载下长期抢占总线优先级,导致多设备测试时某些节点被"饿死"。脚本输出的仪表盘包含每秒收发速率、累计包数、错误计数、CAN 状态及硬件 TEC/REC 计数器,是验证固件可靠性的重要辅助工具。

Sources: test_roboto_usb2can.sh

扩展建议与阅读路径

上位机工具的当前实现已经覆盖了调试场景的核心需求,但在以下方向仍具备扩展空间:基于 python-can 库集成统一的 CAN 抽象层,使工具同时支持 SocketCAN、PCAN、Vector 等多种后端;引入 DBC 文件解析,将原始十六进制数据转换为物理量显示;增加报文录制与回放功能,支持 .asc.blf 格式导出。

如果你希望深入理解底层通信协议的实现,建议继续阅读 Zephyr RTOS 与 USB 协议栈;若关注固件端的错误保护与 LED 状态映射逻辑,可参考 CAN 总线监控与错误保护机制状态指示与 LED 控制系统。对于首次接触本项目的开发者,建议先从 USB2CAN 适配器使用指南 了解端到端的操作流程,再回到本文进行代码级分析。