[docs] 全面校准项目说明与跨平台资源边界

2026-07-27 19:17:19 +08:00
parent 117b02bec7
commit fbb396708c
37 changed files with 131 additions and 103 deletions
@@ -1,6 +1,6 @@
-# ROS2 C++ Sim2Real 运动控制栈 - 部署指南
+# ROS 2/C++ Sim2Real 初版部署指南

-本工作区提供了一个自包含、独立的 C++ ROS2 Humble 实现，用于在 Jetson Orin 目标机上部署轮腿四足机器人控制策略。
+本工作区保存 `v0.10.0` 的 ROS 2 Humble/C++ 初版。控制栈主体源码已归档，但 Odin 驱动源码在该快照中缺失，因此不是自包含部署包；完成真实传感器闭环前必须补充兼容驱动。

 ---

@@ -1,6 +1,6 @@
 # ROS 2/C++ Sim2Real 初版

-本目录归档 `real/sim2real_ros2`，对应重排主线的 `v0.10.0`。这是轮腿机器人 Sim2Real 部署栈从 Python 运行时迁移到 ROS 2 + C++ 的第一版系统工程。
+本目录归档 `real/sim2real_ros2`，对应 `v0.10.0`。这是轮腿机器人 Sim2Real 部署栈从 Python 运行时迁移到 ROS 2 + C++ 的第一版系统工程。

 本工程保留当前 `sim2real` 已验证的部署契约，同时将运行时热路径迁移到 C++：

@@ -26,7 +26,7 @@
 - `src/sim2real_bringup`
  统一启动文件与运行时参数配置。
 - `src/odin_ros_driver`
-  Odin 传感器 ROS 2 驱动（含 IMU、点云、里程计发布）。
+  仅保留依赖边界说明；原始 `v0.10.0` 快照没有归档 Odin 驱动源码，不能独立提供 IMU、点云和里程计发布。
 - `docs`
  架构说明与迁移计划。

@@ -58,11 +58,11 @@ Nav2 / cmd_vel  ------------------------------>  sim2real_runtime

 迁移过程中以下文件被视为真值源：

- `sim2real/deployment_manifest.yaml`
- `sim2real/interface/motor_mapping.py`
- `sim2real/interface/real_io.py`
- `sim2real/policy/policy_runner.py`
- `sim2real/web/session.py`
+- `../sim2real/deployment_manifest.yaml`
+- `../sim2real/interface/motor_mapping.py`
+- `../sim2real/interface/real_io.py`
+- `../sim2real/policy/policy_runner.py`
+- `../sim2real/web/session.py`

 ## 注意事项

@@ -1,5 +1,7 @@
 # 迁移计划

+> 版本范围：ROS 2/C++ 初版（`v0.10.0`）。这是历史迁移记录，不是最终比赛版验收报告；本快照未归档 Odin 驱动源码。
+
 ## Phase 1: 硬件核心迁移 ✅ 已完成

 将当前高频热路径从 Python 迁出。
@@ -39,11 +41,7 @@

 ## Phase 3: ROS 2 系统集成 ✅ 已完成

-参考的源项目：
-
- `00_ reference/odin_ros_driver`
- `00_ reference/EDULITE_A3/el_a3_ros`
- `00_ reference/rl_sar`
+参考过的外部项目包括 Odin ROS 驱动、EDULITE A3 ROS 工程和 RL-SAR；这些外部参考目录不属于本仓库公开内容。

 交付物：

@@ -76,5 +74,5 @@
 | 策略运行时 | `sim2real_runtime_node` | 50Hz ONNX 推理 + 53D 观测 + raw_action clip |
 | 里程计中继 | `odom_relay_node` | /odin1/odometry → /odom + odom→base_link TF |
 | 导航栈 | Nav2 全套节点 | AMCL + costmap + DWB + Navfn + BT + lifecycle |
-| 传感器驱动 | `odin_ros_driver` | IMU + 点云 + 里程计原始发布 |
-| 点云转换 | `pointcloud_to_laserscan` | /odin1/cloud_slam → /scan (供 AMCL 使用) |
+| 传感器驱动 | 外部 Odin 驱动 | 本快照未归档源码，不能视为自包含组件 |
+| 点云转换 | `pointcloud_to_laserscan` | 外部 ROS 包；/odin1/cloud_slam → /scan（供 AMCL 使用） |