配置:消灭代码里的硬编码臂 SN,并给"换臂漏改"加一把尺子
## 为什么
"设备 ID 全部可配置"这条要求在代码里只做了一半:site.yaml 能配,
但**代码和静态配置里到处躺着 Rizon4-063989 当兜底**。这类兜底的危害
不是"改起来麻烦",而是它把"配置没生效"伪装成"配置生效了":
* `robot_sn` 默认 `Rizon4-063989` → 换臂后节点去订**上一台臂**的关节话题,
节点起来了、不报错、什么都不动;
* launch 里用 `ee_frame == "Rizon4-063989_flange"` 当"用户没指定"的哨兵 →
换个站点这个判断永远不成立,于是 site.yaml 里的 ee_frame 再也不会被用上,
静态 TF 挂错坐标系、点还照样查得到;
* `if SN == "Rizon4-063989"` 决定要不要拉触觉服务 → 换臂后触觉静默消失。
## 改了什么
1. **删掉所有"兜底成某台臂"的默认值**(15 处脚本 + 6 个 launch + 6 个节点)。
没配就为空 / 直接 `:?` 报错,宁可起不来也不要连错机器:
- `scripts/lib/export_site_env.py`:别名解析改为从 `robots[]` 现算
(`arm_short_id` / `resolve_robot_sn` / `describe_arms`),选不出臂时
抛 `ValueError`;`main()` 捕获后打人话 + 退出码 2(供 shell `eval`);
- 手眼文件/路点/工作目录由当前臂 short id 派生,不再写死 `89_*`;
- `ROBOT_HAS_TACTILE` 改为读 site.yaml 的 `robots[].tactile`;
- `arm_application/site_io.py` 新增 `joint_prefix_default()` /
`base_frame_default()` / `ee_frame_default()`:优先读 `SITE_*`,
退而由 `SITE_ROBOT_SN` 现算,**不写死 SN**;
- `arm.urdf.xacro` 的 `robot_sn` 默认值改成明显的占位符 `UNSET_ARM_SN`
(关节名会带出来,报错信息自解释);
- `ros2_control.launch.py` / `move_group.launch.py` **原先根本不传
robot_sn**,靠 xacro 写死默认值"蒙对"本机,现在都从环境取。
2. **新增 `scripts/check_arm_prefixes.py`**:Flexiv 把 SN 编进关节名,
所以有一批一级配置(SRDF/controllers/joint_names/bringup/servo/...)
必须跟着当前臂走。漏改的症状是"MoveIt 规划成功但机械臂不动",很难查。
这个脚本逐文件逐行列出对不上的地方,并直接给出修法。
`--list` 还会说明 SN 来自 site.yaml 还是被 `ROBOT_SN` 覆盖。
3. **文档**:`FRAMEWORK_RULES.md` 新增 R1.1.1(两类含臂名文件怎么分、
换臂四步)+ 检查清单第 12 条 + 反例 2 条;`HANDBOOK.md` 新增 3.6.1
与症状表 2 行。
4. **顺带修掉的真 bug**(都是这次改动带出来、被 pyflakes + 真跑抓住的):
- `convert_flexiv_traj.py` / `rdk_drag_bridge.py` 用了 `os` 但没 import
→ `--help` 直接 NameError;
- `check_arm_prefixes.py` 第一版正则用 `\b` 收尾,而关节名是
`Rizon4-063989_joint1`(`_` 属于 \w,`\b` 不成立)→ SRDF 里 24 处
硬编码**一处都没报**,还打印 OK。已加负向测试钉住;
- 删掉若干死代码/死 import(`pos_line`/`flat`/`names`、`IfCondition` 等)。
## 验收(都真跑过)
- `python3 -m pyflakes <全部改过的 py>` → 干净
- 逐包 pytest:233 + 69 + 78 + 24 + 236 = **640 passed**
- `env -u ROBOT_SN python3 scripts/check_arm_prefixes.py` → OK(8 文件)
- 换成 SN=Rizon4-777001 的临时 site.yaml → 报出**8 个**文件不一致并给修法(退出码 1)
- 故意不给 SITE_* → 各 launch 的 `robot_sn` / `ee_frame` / `handeye_file`
默认值为 `''`,不再悄悄指向上一台臂
- `ros2 launch ... --show-args` 对 stack/sim/ros2_control/mock_control/
move_group/display/visual_servo **全部通过**
- `convert_flexiv_traj.py --help` 正常;拿 `xunhuan.traj` 真转 5 个路点,
输出 `joint_prefix: "Rizon4-063989_"` 来自 site.yaml
Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -61,6 +61,44 @@
|
||||
**禁止**在代码里硬编码站点值。真实反例:15 处硬编码的 `Rizon4-063989`
|
||||
(见 `R8` 的清单),换一台臂就会静默连错机器。
|
||||
|
||||
#### R1.1.1 含臂名的一级配置分两类,别混
|
||||
|
||||
Flexiv 官方把 SN 编进了关节名(`Rizon4-063989_joint1`),所以"含 SN 的文件"
|
||||
天然分成两类。**新增文件时必须先归类**,归错类就是下一颗哑弹:
|
||||
|
||||
| 类 | 特征 | 换臂时 | 例子 |
|
||||
|----|------|--------|------|
|
||||
| **跟随当前臂** | 描述"这台臂的接口/结构",只可能有一个正确值 | **必须改**,否则控制器报关节不存在 | `arm_control/config/controllers.yaml`、`named_poses.yaml`、`arm_moveit_config/config/moveit_controllers.yaml`、`arm_moveit_config/srdf/arm.srdf`、`arm_bringup/config/bringup.yaml`、`arm_description/config/joint_names.yaml`、`arm_application/config/servo.yaml`、`xunhuan_trajectory.yaml` |
|
||||
| **按臂各留一份** | 记录某台臂的**实测结果**,多台共存是对的 | 不用改,该**新增**一份(如 `named_poses_91.yaml`) | `config/site.yaml`、`named_poses_89/91.yaml`、`arm_application/config/dual_grippers.yaml`、`handeye/waypoints.yaml` |
|
||||
|
||||
第一类**一定要显式检查**,因为漏改的症状有两种,而且都能伪装成别的问题:
|
||||
|
||||
- 控制器起不来 → `Joint 'Rizon4-063989_joint1' not found`(这条还算好查);
|
||||
- URDF 换了名字、SRDF 没换 → MoveIt 规划成功但**机械臂不动**(难查得多)。
|
||||
|
||||
所以有一把专用尺子:
|
||||
|
||||
```bash
|
||||
python3 scripts/check_arm_prefixes.py # 一致则 0,不一致逐条列出 file:line + 修法
|
||||
python3 scripts/check_arm_prefixes.py --list # 只看当前臂的应然前缀,以及它来自哪儿
|
||||
```
|
||||
|
||||
**换臂的完整动作**(少一步就会出上面那种症状):
|
||||
|
||||
1. 改 `config/site.yaml`(`robot.sn` + `robot.robots[]`);
|
||||
2. `source scripts/env.sh --arm <新臂>`;
|
||||
3. `python3 scripts/check_arm_prefixes.py` —— **必须输出 OK**;
|
||||
4. `bash scripts/build.sh`(让 `install/` 同步)。
|
||||
|
||||
> ⚠️ 第 3 步为什么不能省:这个脚本的 `_SN_TOKEN` 正则第一版写成
|
||||
> `\bRizon\d+-\d{6}\b`,结果 SRDF 里 24 处硬编码**一个都没报**(`_joint1` 的
|
||||
> 下划线属于 `\w`,`\b` 不成立)。检查器的漏洞和配置的漏洞长得一模一样,
|
||||
> 所以它自己也必须有负向测试(见 R5.2)。
|
||||
|
||||
> ⚠️ `ROBOT_SN` / `ROBOT_ARM` 环境变量会**覆盖** `site.yaml` 的 `robot.sn`
|
||||
> (为了支持"这个终端临时用另一台臂")。排查"明明改了配置却没生效"时,
|
||||
> 先 `echo $ROBOT_SN` —— `check_arm_prefixes.py --list` 会直接告诉你值从哪来。
|
||||
|
||||
### R1.2 新增 `site.yaml` 键必须二选一:**接线** 或 **明确告警**
|
||||
|
||||
声明了却没接线的键是最难查的一类问题:用户按文档改了 `site.yaml`,行为毫无变化,
|
||||
@@ -454,6 +492,7 @@ grep -l ros_gz_sim install/*/lib/*/* | wc -l # 应当变成 0
|
||||
| 9 | 提交信息里有"为什么"和实测数据吗? | R6.4 |
|
||||
| 10 | 我写进文档的命令,自己跑过一遍吗? | R6.7 |
|
||||
| 11 | 这次构建是在**目标环境**里做的吗?(`head -1 install/*/lib/*/*`) | R6.8、R5.7 |
|
||||
| 12 | 我碰的文件属于"跟随当前臂"还是"按臂各留一份"?改完跑 `check_arm_prefixes.py` 了吗? | R1.1.1 |
|
||||
|
||||
---
|
||||
|
||||
@@ -485,6 +524,8 @@ grep -l ros_gz_sim install/*/lib/*/* | wc -l # 应当变成 0
|
||||
| 脚本说"已停止",进程还在跑 | 进程模式表漏项(漏过 `robot_state_publisher`) | M1、R4.10 |
|
||||
| `pkill -f gz` 秒返回、什么都没停 | 它先匹配到调用它的 shell | R4.10 |
|
||||
| 换了台臂却连错机器 | 硬编码的 `Rizon4-063989` 默认值 | R1.1 |
|
||||
| 换了台臂,MoveIt 说规划成功、机械臂不动 | SRDF/controllers 还是旧 SN 的关节名(跟随臂的一级配置漏改) | R1.1.1 |
|
||||
| 前缀检查器"全部通过",其实一处都没查 | 正则用 `\b` 收尾,而关节名是 `Rizon4-063989_joint1` | R5.2、R1.1.1 |
|
||||
| `assets_root()` 指向从未存在的 `assets/` | 零调用者的死代码,没人发现 | R5.5 |
|
||||
| 脚本报 `$'\r': 未找到命令`、`set: pipefail: 无效的选项名` | 脚本是 CRLF 行尾,`\r` 被当成标识符的一部分 | R6.6 |
|
||||
| `bash -n` 说没问题,真跑立刻死 | `bash -n` 对 CRLF 会漏报 —— 静态检查≠能用 | R6.6 |
|
||||
|
||||
@@ -254,6 +254,36 @@ ros2 run arm_interfaces device_check --list-brands # 看每类现在有哪
|
||||
改完不算清楚,孔检测在仿真里会"根本不可能通过",而看起来像算法不行。
|
||||
详见[仿真手册 §4.3](../devices/sim/gazebo/README.md)。
|
||||
|
||||
### 3.6.1 换一台机械臂(最容易漏改,而且很难查)
|
||||
|
||||
`site.yaml` 里写的是**哪台臂**,但有一批一级配置文件里写死了**臂的关节名**
|
||||
(Flexiv 官方把 SN 编进关节名:`Rizon4-063989_joint1`)。这些文件必须跟着改:
|
||||
|
||||
```bash
|
||||
python3 scripts/check_arm_prefixes.py # 逐条列出哪个文件哪一行对不上,并给修法
|
||||
python3 scripts/check_arm_prefixes.py --list # 只看当前臂的应然前缀
|
||||
```
|
||||
|
||||
漏改的症状有两种,**都不像"配置错了"**:
|
||||
|
||||
- 控制器报 `Joint 'Rizon4-063989_joint1' not found`(这条还算好查);
|
||||
- URDF 换了名字、`srdf/arm.srdf` 没换 → MoveIt **规划成功但机械臂不动**。
|
||||
|
||||
换臂四步(少一步就出上面那种症状):
|
||||
|
||||
```bash
|
||||
vim config/site.yaml # 1. robot.sn + robot.robots[]
|
||||
source scripts/env.sh --arm 新臂 # 2. 选定当前臂
|
||||
python3 scripts/check_arm_prefixes.py # 3. 必须输出 OK
|
||||
bash scripts/build.sh # 4. 让 install/ 同步
|
||||
```
|
||||
|
||||
哪些文件该跟着改、哪些是"按臂各留一份"的现场资产,
|
||||
见 [`FRAMEWORK_RULES.md`](FRAMEWORK_RULES.md) 的 R1.1.1 表。
|
||||
|
||||
> 排查提示:`ROBOT_SN` / `ROBOT_ARM` 环境变量会**覆盖** `site.yaml` 的 `robot.sn`。
|
||||
> "明明改了配置却没生效"时先 `echo $ROBOT_SN`,或看 `--list` 打印的"来源"。
|
||||
|
||||
### 3.7 改完必须做的一件事
|
||||
|
||||
**问自己:我故意弄坏它,哪个检查会红?**
|
||||
@@ -289,6 +319,7 @@ source scripts/sim_env.sh # 仿真环境(独立 con
|
||||
# —— 设备与配置 ——
|
||||
ros2 run arm_interfaces device_check # 设备契约 + site.yaml 必填项
|
||||
bash scripts/show_site_config.sh # site.yaml 解析结果
|
||||
python3 scripts/check_arm_prefixes.py # 含臂名的配置是否跟着当前臂(换臂必跑)
|
||||
|
||||
# —— 仿真验收(★ 必做,别靠肉眼)——
|
||||
python3 scripts/check_sim_cameras.py # 深度反投影命中已知平面才算过
|
||||
@@ -376,6 +407,8 @@ python3 -m pytest src/arm_sim_gazebo/test -q
|
||||
| 校验代码永远通过 | `sdformat` 用 `__default__` / `__default_topic__` 假值填了缺失字段 | 仿真手册坑 9 |
|
||||
| 脚本报 `$'\r': 未找到命令` | 脚本是 CRLF 行尾 | R6.6 |
|
||||
| 改了参数不生效 | 改的是包内 yaml,被 `site.yaml` 覆盖了 | 3.2 |
|
||||
| MoveIt 说规划成功、机械臂不动 | SRDF / controllers 里还是**旧臂**的关节名 | 3.6.1、R1.1.1 |
|
||||
| 控制器报 `Joint 'Rizon4-xxxxxx_joint1' not found` | 换了臂但一级配置没跟着改(或改了两处漏一处) | 3.6.1 |
|
||||
| 仿真镜头位置不对、只看得见地面 | 相机 `rpy` 复合顺序 | 仿真手册坑 5 |
|
||||
| 脚本说"已停止",进程还在 | 进程模式表漏项 | R4.10 |
|
||||
| 孔检测在仿真里怎么都不过 | 图幅与真机不同,像素门槛失效 | 仿真手册 §4.3 |
|
||||
|
||||
Reference in New Issue
Block a user