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>
117 lines
4.3 KiB
Bash
Executable File
117 lines
4.3 KiB
Bash
Executable File
#!/usr/bin/env bash
|
||
# 克隆 Flexiv 官方 ROS 2 栈(Rizon 用,RDK v1.x → humble-v1 分支)。
|
||
set -euo pipefail
|
||
|
||
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||
SRC="${ROOT}/src"
|
||
BRANCH="${FLEXIV_ROS2_BRANCH:-humble-v1}"
|
||
|
||
mkdir -p "${SRC}"
|
||
cd "${SRC}"
|
||
|
||
# 无论如何都要保证官方 URDF 包存在(mesh + xacro)
|
||
if [[ ! -d flexiv_description ]]; then
|
||
echo "Fetching flexiv_description (${BRANCH})..."
|
||
if ! git clone --depth 1 -b "${BRANCH}" https://github.com/flexivrobotics/flexiv_description.git; then
|
||
echo "git clone slow/failed — downloading zip..."
|
||
python3 - <<PY
|
||
import urllib.request, socket, zipfile, io, shutil, os
|
||
url = "https://codeload.github.com/flexivrobotics/flexiv_description/zip/refs/heads/${BRANCH}"
|
||
old = socket.getaddrinfo
|
||
socket.getaddrinfo = lambda h, p, f=0, t=0, pr=0, fl=0: [ai for ai in old(h, p, socket.AF_INET, t, pr, fl)]
|
||
data = urllib.request.urlopen(urllib.request.Request(url, headers={"User-Agent": "Mozilla/5.0"}), timeout=300).read()
|
||
dest = "${SRC}/flexiv_description"
|
||
with zipfile.ZipFile(io.BytesIO(data)) as z:
|
||
z.extractall("/tmp")
|
||
shutil.rmtree(dest, ignore_errors=True)
|
||
shutil.move("/tmp/flexiv_description-${BRANCH}", dest)
|
||
print("flexiv_description ready at", dest)
|
||
PY
|
||
fi
|
||
else
|
||
echo "flexiv_description already present"
|
||
fi
|
||
|
||
if [[ ! -d flexiv_ros2 ]]; then
|
||
echo "Cloning flexiv_ros2 (${BRANCH})..."
|
||
git clone https://github.com/flexivrobotics/flexiv_ros2.git -b "${BRANCH}"
|
||
else
|
||
echo "flexiv_ros2 already present — pull if needed: git -C flexiv_ros2 pull"
|
||
fi
|
||
|
||
REPOS_FILE=""
|
||
for candidate in flexiv_ros2/flexiv.humble.repos flexiv_ros2/flexiv.repos; do
|
||
if [[ -f "${candidate}" ]]; then
|
||
REPOS_FILE="${candidate}"
|
||
break
|
||
fi
|
||
done
|
||
|
||
if [[ -z "${REPOS_FILE}" ]]; then
|
||
echo "ERROR: no .repos file found under flexiv_ros2"
|
||
exit 1
|
||
fi
|
||
|
||
echo "Importing dependencies from ${REPOS_FILE}..."
|
||
if ! command -v vcs >/dev/null 2>&1; then
|
||
echo "Please install: sudo apt install python3-vcstool"
|
||
exit 1
|
||
fi
|
||
|
||
# 优先用本地 Flexiv_Rizon4 里的 RDK(有本地副本时就不去 GitHub 克隆)
|
||
LOCAL_FLEXIV="${LOCAL_FLEXIV:-$HOME/文档/Flexiv_Rizon4}"
|
||
if [[ -d "${LOCAL_FLEXIV}/flexiv_rdk" ]]; then
|
||
echo "Using local RDK: ${LOCAL_FLEXIV}/flexiv_rdk"
|
||
bash "${ROOT}/scripts/use_local_flexiv.sh"
|
||
elif [[ -d flexiv_rdk ]]; then
|
||
touch flexiv_rdk/COLCON_IGNORE
|
||
else
|
||
echo "Importing flexiv_rdk from ${REPOS_FILE}..."
|
||
vcs import "${SRC}" < "${REPOS_FILE}" --recursive --skip-existing
|
||
if [[ -d flexiv_rdk ]]; then
|
||
touch flexiv_rdk/COLCON_IGNORE
|
||
fi
|
||
fi
|
||
|
||
# 其余依赖一律从 .repos 导入(description 已单独处理;skip-existing 跳过已有)
|
||
vcs import "${SRC}" < "${REPOS_FILE}" --recursive --skip-existing || true
|
||
|
||
cat <<EOF
|
||
|
||
Done. Next steps (Ubuntu 22.04 / Humble + Rizon):
|
||
|
||
Local RDK wired via: scripts/use_local_flexiv.sh
|
||
src/flexiv_rdk -> ${LOCAL_FLEXIV}/flexiv_rdk (your copy, often RDK 2.x)
|
||
src/flexiv_rdk_v1 -> RDK 1.9.1 for flexiv_ros2 humble-v1 (if present)
|
||
|
||
1) Install ROS deps:
|
||
sudo apt install -y python3-colcon-common-extensions python3-vcstool \\
|
||
ros-humble-ros2-control ros-humble-ros2-controllers \\
|
||
ros-humble-moveit ros-humble-xacro ros-humble-joint-state-publisher-gui
|
||
|
||
2) Build & install RDK **v1.9.1** into ~/flexiv_install (for flexiv_hardware):
|
||
RDK_SRC=${SRC}/flexiv_rdk_v1
|
||
# fallback if only one tree: RDK_SRC=${SRC}/flexiv_rdk
|
||
cd \${RDK_SRC}/thirdparty
|
||
source /opt/ros/humble/setup.bash # or: conda activate ros_flexiv
|
||
bash build_and_install_dependencies_not_in_ros2.sh ~/flexiv_install
|
||
cd \${RDK_SRC} && rm -rf build && mkdir build && cd build
|
||
cmake .. -DCMAKE_INSTALL_PREFIX=~/flexiv_install -DCMAKE_PREFIX_PATH=~/flexiv_install
|
||
cmake --build . --target install --config Release
|
||
|
||
3) Build this workspace:
|
||
cd ${ROOT}
|
||
source /opt/ros/humble/setup.bash
|
||
colcon build --symlink-install --cmake-args -DCMAKE_PREFIX_PATH=~/flexiv_install
|
||
source install/setup.bash
|
||
|
||
4) Real robot (site SN, no gripper yet):
|
||
ros2 launch arm_bringup real.launch.py
|
||
# or explicitly:
|
||
ros2 launch arm_bringup real.launch.py robot_sn:=Rizon4-063989 load_gripper:=false
|
||
|
||
Official fake hardware:
|
||
ros2 launch flexiv_bringup rizon.launch.py robot_sn:=Rizon4-063989 use_fake_hardware:=true load_gripper:=false
|
||
|
||
EOF
|