arm_dev
72353f3773
背景：现场读代码的人只读中文。此前代码里的 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>
47 lines
1.4 KiB
Bash
Executable File
47 lines
1.4 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# 把 Flexiv Isaac Sim 集成仓库克隆到 thirdparty/
|
|
set -euo pipefail
|
|
|
|
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
|
TP="${ROOT}/thirdparty"
|
|
mkdir -p "${TP}"
|
|
cd "${TP}"
|
|
|
|
clone_or_update() {
|
|
local url="$1"
|
|
local dir="$2"
|
|
if [[ -d "${dir}/.git" ]]; then
|
|
echo "Updating ${dir}..."
|
|
git -C "${dir}" pull --ff-only || true
|
|
else
|
|
echo "Cloning ${dir}..."
|
|
git clone --depth 1 "${url}" "${dir}"
|
|
fi
|
|
}
|
|
|
|
clone_or_update https://github.com/flexivrobotics/flexiv_sim_plugin.git flexiv_sim_plugin
|
|
clone_or_update https://github.com/flexivrobotics/isaac_sim_ws.git isaac_sim_ws
|
|
clone_or_update https://github.com/flexivrobotics/flexiv_description.git flexiv_description
|
|
|
|
# 可选：在仿真目录旁放一份 RDK 源码（如果 src/ 下还没有）
|
|
if [[ ! -d "${ROOT}/src/flexiv_rdk" ]]; then
|
|
clone_or_update https://github.com/flexivrobotics/flexiv_rdk.git flexiv_rdk
|
|
fi
|
|
|
|
cat <<EOF
|
|
|
|
Isaac / description repos are under: ${TP}
|
|
|
|
Next (Isaac path):
|
|
1) Install NVIDIA Isaac Sim
|
|
2) Follow flexiv_sim_plugin README (Elements Studio → External / Isaac)
|
|
3) cd ${TP}/isaac_sim_ws && bash install_ws.sh <isaac_sim_root>
|
|
4) Configure robot instance for Rizon4-063989 in app_config.yaml
|
|
5) Primitive docs: https://primitive.flexiv.cn/primitives/zh-CN/3.10/rizon4/index.html
|
|
6) RDK manual (CN): https://flexiv.cn/software/rdk/manual/index.html
|
|
|
|
ROS 2 path (separate):
|
|
${ROOT}/scripts/fetch_flexiv.sh
|
|
|
|
EOF
|