Files
ros_contorl/scripts/README.md
T
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

4.4 KiB
Raw Blame History

scripts — 唯一操作入口

实现细节在 docs/WORKSPACE.md 和 docs/。

每天: run_real.sh · run_camera_d405.sh · run_visual_servo_rt.sh · go_home.sh
三阶段串联: run_all.sh --arm 89 [--hole k2] [--skip-stage1](run_pipeline.sh 是它的旧名别名)
手眼: run_handeye.sh(teach / merge / calibrate / show)
夹爪: run_gripper.sh --arm 89|91 · run_dual_gripper.sh
入孔: run_hole_detect.sh --arm … [--preview]
触觉: run_tactile.sh [--cli]
权重: weights.sh(list / labels / convert / doctor / show)

  • 转换:weights.sh convert <文件> --name <模型名> —— PT→ONNX→TensorRT,自动改名归位 + 固化标签
  • 标签:weights.sh labels <模型名> 看,--set "工件,通止规" 改
  • 体检:weights.sh doctor --check-engines(能查出 engine 与 TensorRT 版本不匹配这类静默失效)
  • 规则写在 models/README.md。export_yolo_trt.sh 现在是它的兼容转发壳。 配置: show_site_config.sh · lib/export_site_env.py
    仿真: run_sim_gz.sh(Gazebo 物理仿真,唯一能做接触/力控验证的入口) 停:stop_sim_gz.sh(别敲 pkill -f gz —— 会杀掉调用它的 shell,见脚本文件头)
  • 环境是独立 conda 环境 ros_gz_sim(install_sim_env.sh 装、sim_env.sh 激活),与真机环境隔离
  • 相机验收:python3 scripts/check_sim_cameras.py —— 别用 ros2 topic hz 或肉眼看图验收相机, 仿真相机的错误几乎全是静默的(深度单位、frame_id、内参、位姿方向),都能出图却是错的。 这条命令把深度反投影到 world,要求命中已知平面(地面/台面)才算通过。
  • 场景验收:python3 scripts/check_sim_scene.py —— 同样别靠肉眼。它管四件事: 物体的摆放(悬空/穿模/出界/互相嵌入)、场景里的像素门槛与真机生效值是否漂移、 孔检测的成像几何(亮环/孔间距换算成像素后够不够门槛)、以及粗定位用的手外相机 能不能完整看见工件。第二条尤其重要:门槛抄了两份,不一致时仿真会"通过"而真机不认。
  • 注意 run_sim.sh 不是 Gazebo,它走 mock 驱动(假数据 + RViz),永远不会产生接触力 环境: env.sh · build_all.sh
    RDK: test_rdk_python.sh · rdk_switch_tool.sh · rdk_drag_bridge.py
    改注释/写文档后自检: python3 scripts/check_text_only.py
  • 用途:证明这次改动只动了文字(注释、docstring、提示信息),没碰逻辑。 它把改动前后的源码解析成语法树,删掉 docstring、抹平字符串常量后比对; "翻译 f-string 时漏掉一个 {} 插值""顺手改了个变量名"这类问题会被抓出来。
  • python3 scripts/check_text_only.py 查所有改过的 .py;也可以直接跟文件名。 基准是 git HEAD,所以要在提交之前跑。老手滑手滑的代价比跑一条命令高得多。
  • 规矩写在 docs/FRAMEWORK_RULES.md 的 R6.5。 一句话:注释/docstring/提示信息用中文;标识符、话题名、字段名保留英文 (但 src/flexiv_*/ 是厂商上游代码,不许翻译,见 R4.4)。 搁置未用: fetch_isaac_flexiv.sh(拉 Flexiv 的 Isaac Sim / RDK 源码到 thirdparty/;Isaac 路线目前搁置,Gazebo 是选定平台)

lib/parse_arm_args.sh 解析 --arm 89|91。
lib/load_site_config.sh 把 config/site.yaml 变成 SITE_*。

排查脚本卡住时的常识

几个脚本开头会等外部条件(控制器 ACTIVE、相机出图、触觉就绪)。正确的判活顺序是 先 ros2 service list / ros2 topic list 看目标在不在,再去 call / echo:

# 对:服务不存在时立刻返回
timeout 3 ros2 service list | grep -q '^/controller_manager/list_controllers$' || exit 1
timeout 3 ros2 service call /controller_manager/list_controllers ...

# 错:服务不存在时每次 call 都要耗满超时才返回,
#     30 次循环 = 白等两三分钟(实测 63s),看起来就像脚本卡死了
for _i in $(seq 1 30); do timeout 5 ros2 service call ... ; done

run_all.sh / run_stage2_locate.sh / run_stage3_search.sh 已按正确顺序改过; run_handeye.sh 一开始就是对的。