Files
ros_contorl/scripts/install_rdk_offline.sh
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

105 lines
3.3 KiB
Bash
Executable File

#!/usr/bin/env bash
# 面向离线场景的 Flexiv RDK v1.9.1 安装脚本(供 ROS 的 humble-v1 / `flexiv_hardware` 使用)。
# CMakeLists 已经支持 `FLEXIV_RDK_OFFLINE_LIB` / `vendor/rdk_libs/`。
set -euo pipefail
ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
RDK_SRC="${RDK_SRC:-$ROOT/src/flexiv_rdk_v1}"
PREFIX="${PREFIX:-$HOME/flexiv_install}"
LIB_NAME="libflexiv_rdk.x86_64-linux-gnu.a"
EXPECTED_HASH="$(tr -d '[:space:]' < "${RDK_SRC}/lib/${LIB_NAME}.sha256")"
VENDOR_LIB="${ROOT}/vendor/rdk_libs/${LIB_NAME}"
JOBS="${JOBS:-$(nproc)}"
# 优先用 conda 的 ros_flexiv 工具链(cmake/g++ 往往只在那里有)
if ! command -v cmake >/dev/null 2>&1; then
# shellcheck disable=SC1091
source "${HOME}/anaconda3/etc/profile.d/conda.sh" 2>/dev/null \
|| source "${HOME}/miniconda3/etc/profile.d/conda.sh" 2>/dev/null \
|| true
conda activate "${CONDA_ENV:-ros_flexiv}" 2>/dev/null || true
fi
if ! command -v cmake >/dev/null 2>&1; then
echo "ERROR: cmake not found. Activate ros_flexiv (or install cmake) first."
exit 1
fi
echo "Using cmake: $(command -v cmake) ($(cmake --version | head -1))"
mkdir -p "${ROOT}/vendor/rdk_libs" "${PREFIX}"
if [[ -f "${VENDOR_LIB}" ]] && [[ "$(sha256sum "${VENDOR_LIB}" | awk '{print $1}')" == "${EXPECTED_HASH}" ]]; then
echo "OK: ${VENDOR_LIB}"
else
echo "Need ${LIB_NAME} (SHA256 ${EXPECTED_HASH})"
base="https://github.com/flexivrobotics/flexiv_rdk/releases/download/v1.9.1/${LIB_NAME}"
ok=0
for url in \
"${base}" \
"https://ghproxy.net/${base}" \
"https://gh.ddlc.top/${base}" \
"https://hub.gitmirror.com/${base}" \
"https://cf.ghproxy.cc/${base}"
do
echo "TRY ${url}"
if curl -fL --connect-timeout 15 --max-time 120 -o "${VENDOR_LIB}.part" "${url}" \
&& [[ "$(sha256sum "${VENDOR_LIB}.part" | awk '{print $1}')" == "${EXPECTED_HASH}" ]]; then
mv "${VENDOR_LIB}.part" "${VENDOR_LIB}"
ok=1
break
fi
rm -f "${VENDOR_LIB}.part"
done
if [[ "${ok}" -ne 1 ]]; then
cat <<EOF
FAILED to download ${LIB_NAME}.
Manual (any PC with GitHub access):
wget -O ${LIB_NAME} '${base}'
sha256sum ${LIB_NAME} # must be ${EXPECTED_HASH}
scp ${LIB_NAME} $(hostname):${VENDOR_LIB}
Then re-run: $0
EOF
exit 1
fi
fi
export FLEXIV_RDK_OFFLINE_LIB="${VENDOR_LIB}"
echo "Install deps into ${PREFIX} (may still need git mirrors)..."
DEP_SCRIPT=""
for s in \
"${RDK_SRC}/thirdparty/build_and_install_dependencies_not_in_ros2.sh" \
"${RDK_SRC}/thirdparty/build_and_install_dependencies.sh"
do
[[ -f "$s" ]] && DEP_SCRIPT="$s" && break
done
if [[ -n "${DEP_SCRIPT}" ]]; then
bash "${DEP_SCRIPT}" "${PREFIX}" "${JOBS}" || {
echo "WARN: deps script failed. If Eigen/spdlog/Fast-DDS/RBDyn already in ${PREFIX}, continue."
}
else
echo "WARN: no dependency script found"
fi
rm -rf "${RDK_SRC}/build"
mkdir -p "${RDK_SRC}/build" && cd "${RDK_SRC}/build"
cmake .. -DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_PREFIX="${PREFIX}" \
-DCMAKE_PREFIX_PATH="${PREFIX}"
cmake --build . --target install -j "${JOBS}"
cat <<EOF
RDK installed to ${PREFIX}
Next:
conda activate ros_flexiv
cd ${ROOT}
colcon build --symlink-install --cmake-args -DCMAKE_PREFIX_PATH=${PREFIX} \\
--packages-up-to flexiv_bringup flexiv_hardware arm_bringup
Python (already ready, no GitHub):
/home/cc/rdk_py310/bin/python
bash ${ROOT}/scripts/test_rdk_python.sh
EOF