注释与提示信息全面中文化：源码 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>
This commit is contained in:
arm_dev
+27
-27
@@ -1,10 +1,10 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Control Studio device GripperDahuan / GripperDahuanModbus via Flexiv RDK.
|
||||
"""通过 Flexiv RDK 控制 Studio 设备 GripperDahuan / GripperDahuanModbus。
|
||||
|
||||
Must run under RDK Python (rdk_py310). Uses a *lite* RDK instance so it can
|
||||
share the robot with run_real.sh (ros2_control holds the normal RDK).
|
||||
必须在 RDK 的 Python（rdk_py310）下运行。使用 *lite*（轻量）RDK 实例，
|
||||
以便和 run_real.sh 共用机器人（常规 RDK 被 ros2_control 占用）。
|
||||
|
||||
The controller talks RS485 itself (its own /dev/ttyUSB0), not the IPC serial.
|
||||
控制器自己走 RS485（用自带的 /dev/ttyUSB0），不走工控机的串口。
|
||||
|
||||
/home/cc/rdk_py310/bin/python ~/ros2/scripts/rdk_gripper.py --list
|
||||
/home/cc/rdk_py310/bin/python ~/ros2/scripts/rdk_gripper.py status
|
||||
@@ -65,28 +65,28 @@ def _move(grip, params, width: float, vel: float, force: float) -> None:
|
||||
vmax = float(params.max_vel)
|
||||
if vmax <= 0:
|
||||
vmax = 0.05
|
||||
# Move velocity cannot be 0 (RDK).
|
||||
# 移动速度不能为 0（RDK 限制）。
|
||||
vel = _clamp(vel, max(vmin, 1e-4), vmax)
|
||||
force = _clamp(force, float(params.min_force), float(params.max_force))
|
||||
width = _clamp(width, float(params.min_width), float(params.max_width))
|
||||
print(f"Move width={width:.4f} m vel={vel:.4f} m/s force={force:.1f} N")
|
||||
print(f"移动 width={width:.4f} m vel={vel:.4f} m/s force={force:.1f} N")
|
||||
grip.Move(width, vel, force)
|
||||
|
||||
|
||||
def main() -> int:
|
||||
ap = argparse.ArgumentParser(description="Flexiv RDK gripper (GripperDahuanModbus)")
|
||||
ap = argparse.ArgumentParser(description="Flexiv RDK 夹爪（GripperDahuanModbus）")
|
||||
ap.add_argument("--sn", default="")
|
||||
ap.add_argument("--iface", default="")
|
||||
ap.add_argument("--device", default="", help="Studio Device name")
|
||||
ap.add_argument("--force-n", type=float, default=0.0, help="force limit [N]; 0=mid")
|
||||
ap.add_argument("--vel", type=float, default=0.0, help="speed [m/s]; 0=half max")
|
||||
ap.add_argument("--device", default="", help="Studio 设备名")
|
||||
ap.add_argument("--force-n", type=float, default=0.0, help="力上限 [N]；0=取中值")
|
||||
ap.add_argument("--vel", type=float, default=0.0, help="速度 [m/s]；0=最大速度的一半")
|
||||
ap.add_argument(
|
||||
"cmd",
|
||||
nargs="?",
|
||||
default="status",
|
||||
choices=["list", "status", "init", "open", "close", "pos", "enable"],
|
||||
)
|
||||
ap.add_argument("value", nargs="?", default="", help="pos: meters or 0–1000")
|
||||
ap.add_argument("value", nargs="?", default="", help="pos: 米，或 0–1000")
|
||||
args = ap.parse_args()
|
||||
|
||||
sys.path.insert(0, str(ROOT / "scripts" / "lib"))
|
||||
@@ -99,18 +99,18 @@ def main() -> int:
|
||||
iface = (args.iface or robot_cfg.get("iface") or "").strip()
|
||||
device = (args.device or g.get("device_name") or "GripperDahuanModbus").strip()
|
||||
if not sn:
|
||||
print("ERROR: robot SN missing", file=sys.stderr)
|
||||
print("错误：没拿到机械臂序列号（SN）", file=sys.stderr)
|
||||
return 2
|
||||
|
||||
import flexivrdk
|
||||
|
||||
print(f"=== RDK lite gripper SN={sn} device={device} iface={iface or 'auto'} ===")
|
||||
print(f"=== RDK lite 夹爪 SN={sn} device={device} iface={iface or 'auto'} ===")
|
||||
robot = connect_lite(sn, iface)
|
||||
dev = flexivrdk.Device(robot)
|
||||
names = list(dev.list() or [])
|
||||
|
||||
if args.cmd == "list":
|
||||
print("Studio devices:")
|
||||
print("Studio 设备列表:")
|
||||
for n in names:
|
||||
try:
|
||||
en = dev.enabled(n)
|
||||
@@ -123,7 +123,7 @@ def main() -> int:
|
||||
|
||||
if device not in names:
|
||||
print(
|
||||
f"ERROR: device {device!r} not in Studio pool.\n available: {', '.join(names)}",
|
||||
f"错误：设备 {device!r} 不在 Studio 设备池里。\n 可用: {', '.join(names)}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
return 1
|
||||
@@ -133,7 +133,7 @@ def main() -> int:
|
||||
)
|
||||
if not dev.connected(device):
|
||||
print(
|
||||
"WARN: connected=False — 控制器自己的 /dev/ttyUSB0 没接到爪。\n"
|
||||
"警告：connected=False —— 控制器自己的 /dev/ttyUSB0 没接到夹爪。\n"
|
||||
" USB–RS485 要插 Flexiv 机箱 USB（不是工控机），A/B + 24V 到 PGEA。\n"
|
||||
" 或用法兰工具口 485（腕部白绿+/绿-）。"
|
||||
)
|
||||
@@ -142,14 +142,14 @@ def main() -> int:
|
||||
if args.cmd in ("enable", "status", "init", "open", "close", "pos"):
|
||||
try:
|
||||
grip.Enable(device)
|
||||
print(f"Enable [{device}] OK")
|
||||
print(f"使能 [{device}] 成功")
|
||||
except Exception as exc:
|
||||
print(f"ERROR: Enable failed: {exc}", file=sys.stderr)
|
||||
print(f"错误：使能失败: {exc}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
params = grip.params()
|
||||
print(" params:", _fmt_params(params))
|
||||
print(" states:", _fmt_states(grip.states()))
|
||||
print(" 参数:", _fmt_params(params))
|
||||
print(" 状态:", _fmt_states(grip.states()))
|
||||
|
||||
force = float(args.force_n or g.get("force_n") or 0.0)
|
||||
if force <= 0:
|
||||
@@ -164,27 +164,27 @@ def main() -> int:
|
||||
return 0
|
||||
|
||||
if args.cmd == "init":
|
||||
print("Init (fingers home, ~10 s) …")
|
||||
print("初始化（手指回零，约 10 秒）…")
|
||||
grip.Init()
|
||||
time.sleep(2.0)
|
||||
print(" states:", _fmt_states(grip.states()))
|
||||
print(" 状态:", _fmt_states(grip.states()))
|
||||
return 0
|
||||
|
||||
if args.cmd == "open":
|
||||
_move(grip, params, float(params.max_width), vel, force)
|
||||
time.sleep(0.4)
|
||||
print(" states:", _fmt_states(grip.states()))
|
||||
print(" 状态:", _fmt_states(grip.states()))
|
||||
return 0
|
||||
|
||||
if args.cmd == "close":
|
||||
_move(grip, params, float(params.min_width), vel, force)
|
||||
time.sleep(0.4)
|
||||
print(" states:", _fmt_states(grip.states()))
|
||||
print(" 状态:", _fmt_states(grip.states()))
|
||||
return 0
|
||||
|
||||
if args.cmd == "pos":
|
||||
if args.value == "":
|
||||
print("usage: pos <meters|0-1000>", file=sys.stderr)
|
||||
print("用法: pos <米|0-1000>", file=sys.stderr)
|
||||
return 2
|
||||
raw = float(args.value)
|
||||
if raw > 1.5:
|
||||
@@ -194,7 +194,7 @@ def main() -> int:
|
||||
width = raw
|
||||
_move(grip, params, width, vel, force)
|
||||
time.sleep(0.4)
|
||||
print(" states:", _fmt_states(grip.states()))
|
||||
print(" 状态:", _fmt_states(grip.states()))
|
||||
return 0
|
||||
return 0
|
||||
|
||||
@@ -203,5 +203,5 @@ if __name__ == "__main__":
|
||||
try:
|
||||
raise SystemExit(main())
|
||||
except Exception as exc:
|
||||
print(f"ERROR: {exc}", file=sys.stderr)
|
||||
print(f"错误：{exc}", file=sys.stderr)
|
||||
raise SystemExit(1)
|
||||
|
||||
Reference in New Issue
Block a user