arm_dev 72353f3773 注释与提示信息全面中文化:源码 66 个 .py + 脚本/配置 45 个文件
背景:现场读代码的人只读中文。此前代码里的 docstring 是英文、行内注释是中文,
一半英文一半中文反而更难看懂 —— 新手打开一个 .py 不知道这个模块为什么存在。

范围(本仓库自己的代码,厂商上游不动)
  src/arm_application/**   37 个文件:servo_node / perception_node / handeye_* / dh_pgea /
                           yolo_detector / kalman_filter / goto_ee_plane / dual_gripper …
  src/arm_interfaces/**    11 个文件:paths / manifest / loader / config_guard / errors …
  src/arm_control/**        5 个文件
  src/arm_bringup/**        3 个 launch
  scripts/**                6 个 .py + 29 个 .sh(scripts/ 是"唯一操作入口",用户屏幕上
                           看到的就是这些提示,所以提示信息也一并中文化)
  config/ handeye/ devices/ src/arm_*/config/   17 个 .yaml/.xml/.xacro/.cfg

口径(写进 docs/FRAMEWORK_RULES.md 新增的 R6.5,作为长期约束)
  注释、docstring、print/日志/异常里给人看的句子 = 中文;
  标识符、API 名、话题名、参数名、字段名、命令名 = 保留英文原文(用 `` `` 包起来);
  单位、十六进制、协议报文、CRC 值、命令示例 = 原样保留;
  src/flexiv_*/ = 厂商上游代码,不许改也不许翻译(R4.4)。
  翻译保原意与原有详细程度:那些"为什么不能用另一种做法""踩过什么坑"的说明
  全部完整保留 —— 它们才是这份代码里最贵的部分。

新增 scripts/check_text_only.py:只改文字时的自证工具
  人工 review 靠不住(115 个文件、3000 多行 diff)。这个脚本把改动前后的源码解析成
  语法树,删掉 docstring、抹平字符串常量、把 f-string 只留"插值了几次 + 插值是什么",
  再比对:完全相同 = 改动范围内没有逻辑变化。
  留了一个口子:f-string 的插值按内容排序后再比 —— 因为中文语序常常要和英文反着来
  (f"on {port} read {idx} failed" → f"在 {port} 上读 {idx} 失败"),只换显示顺序不该判失败;
  但多插一个、少插一个、换掉被插入的表达式,立刻会报出来。
  本次 66 个 .py 全部通过该闸门。

验收
  改动的 66 个 .py:scripts/check_text_only.py 全部通过(零逻辑变化)
  45 个非 .py 文件:去注释后与 HEAD 逐字节相同(零配置变化)
  docstring 总数:没有一个文件减少(不存在"翻译时顺手删了说明")
  单测:arm_application 233 / arm_driver_flexiv 69 / arm_interfaces 46 /
        arm_kinematics 24 / arm_sim_gazebo 236 = 608 passed,与改动前一致
  全部 .sh:bash -n 通过;并额外实际执行了 --help 验证(见下一个提交:
        bash -n 对 CRLF 脚本会漏报,只有真跑才暴露)

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-09-23 17:40:55 +08:00

Flexiv Rizon 视觉伺服(~/ros2)

独立工作空间:腕部 D405 眼在手上、手眼标定、YOLO 找工件、法兰悬停跟踪、DH 夹爪、入孔检测。
一份仓库即可跑完整跟踪与检测,不依赖 camera_test 或装配 HMI。

工作目录必须是 ASCII 路径(推荐克隆到 ~/ros2)。

项 值
配置 config/site.yaml(从 example 复制,不进 git)
操作 scripts/
目录说明 docs/WORKSPACE.md(每个文件夹做什么)
Conda ros_flexiv
ROS Humble

克隆后

cd ~/ros2
cp config/site.example.yaml config/site.yaml
# 编辑 site.yaml:robot.sn / robots[].ip / camera.serial / paths.yolo_weights
# 权重文件放到 models/<分组>/(二进制不在 git 里;布局与标签见 models/README.md)

conda activate ros_flexiv
source scripts/env.sh
./scripts/build_all.sh
source scripts/env.sh

示教器:AUTO + Remote Ethernet,关掉 Flexiv Studio(RDK 独占)。

# 三个终端必须带同一个 --arm(89=左  91=右)
bash ~/ros2/scripts/run_real.sh --arm 89
bash ~/ros2/scripts/run_camera_d405.sh --arm 89 --preview
bash ~/ros2/scripts/run_visual_servo_rt.sh --arm 89 --control

改 site.yaml:锁高 / YOLO / 伺服 → 重启第三终端;分辨率 / 曝光 → 重启相机。

功能入口

功能 命令
实机 scripts/run_real.sh --arm 89|91
腕部相机 scripts/run_camera_d405.sh --arm … --preview
顶视 D435 scripts/run_camera_d435.sh --preview
列出相机 scripts/list_realsense.sh
跟踪 scripts/run_visual_servo_rt.sh --arm … [--control]
回 home scripts/go_home.sh --arm …
手眼 scripts/run_handeye.sh --arm … teach → merge → calibrate
PGEA / RGI 夹爪 scripts/run_gripper.sh --arm 89|91 --cli …
双爪 ROS scripts/run_dual_gripper.sh
入孔检测 scripts/run_hole_detect.sh --arm … --preview
Orisys 触觉 scripts/run_tactile.sh [--cli]
Gazebo 仿真 scripts/run_sim_gz.sh [--gui](停:scripts/stop_sim_gz.sh)
看配置 scripts/show_site_config.sh

89 与 91 各有 手眼、相机序列号、锁高、named poses,禁止混用。

文档

文档 内容
docs/FRAMEWORK_RULES.md 框架规则(改代码前先读;含历史反例的症状表)
docs/WORKSPACE.md 每个目录 / 脚本 / 包
docs/QUICKSTART.md 环境与第一次跑通
docs/ARCHITECTURE.md 进程与几何
docs/SITE_CONFIG.md site.yaml 字段
docs/HANDEYE.md 手眼标定
docs/TRACKING.md 视觉伺服
docs/GRIPPER.md PGEA + RGI
docs/HOLE_DETECT.md 入孔检测
docs/TACTILE.md Orisys 视触觉
devices/sim/gazebo/README.md Gazebo 仿真手册(使用方法 / 建模要求 / 导入格式 / 配置方式 / 避坑清单)
docs/INTERFACES.md ROS / 脚本接口
docs/TRAJECTORIES.md 轨迹回放

上传 git 时

  • 要提交:src/ scripts/ docs/ devices/ config/site.example.yaml models/README.md models/**/*.labels.yaml handeye/
  • 不要提交:config/site.yaml(含本机 IP/序列号)、handeye/tmp/(临时产物)、build/ install/ log/、YOLO .pt/.onnx/.engine、thirdparty/ vendor/
  • 规则已写在 .gitignore

handeye/ 是个例外,说明一下

handeye/poses/(示教点)与 handeye/results/(标定结果)是入库的, 尽管它们属于某台现场的数据。理由是:手眼标定要用真机示教十几分钟, 是费了真机时间换来的资产,入库才有一份可回滚的备份;一旦没入库, 一次误删就得重新上真机采点。所以这两类文件按"资产"对待,而不是按"配置"。

因此别人克隆后必须重新标定,并把结果覆盖到 handeye/results/<臂号>_<模式>.yaml。 不要直接用仓库里现成的 T_4x4 —— 那是属于另一台机器、另一个相机安装位的, 用错的表现是跟踪始终差几厘米,且很难怀疑到标定值上。 示教点同理:handeye/poses/ 里的关节角只在对应的那台臂上有意义。

(注:config/site.yaml 不入库、而 handeye/ 入库,看似矛盾,其实是 "配置属于站点、不入库;标定成果属于资产、入库"这条区分。早期这两类的 边界没写清,导致 README 的说明和仓库实际状态不一致。)

S
Description
No description provided
Readme 193 MiB
Languages
Makefile 34.3%
Python 24.2%
C 20%
C++ 14.6%
CMake 5.2%
Other 1.7%