# =============================================================================
# devices/sim/gazebo/manifest.yaml
#
# Gazebo 仿真平台清单。
#
# 重要：本项目的 Gazebo 目前【尚未接线】。详见本目录 README.md。
# 这份清单声明的是「接线完成之后」应有的配置项，并把 world 设为非必填，
# 这样在仿真还没搭建好时不会阻塞 device_check。
# =============================================================================

id: gazebo
label: Gazebo 仿真
kind: sim
vendor: openrobotics
version: "待填 —— 接线后记录 Gazebo 版本"

description: >
  物理仿真平台。当前项目的「仿真」实际是 mock 驱动（假数据），Gazebo 尚未接线：
  arm.gazebo.xacro 零引用、stack.launch.py 的 isaac 分支只有日志、没有 world 文件。
  接线步骤见本目录 README.md 的第一部分。
  注意：Orisys 视触觉没有现成 Gazebo 插件，自定义插件做出来之前，
  仿真里无法验证通止规装配的 S07 接触与 S08 拧紧力判据。

# --- 物料放置要求 ----------------------------------------------------------
assets:
  - path: worlds
    required: false
    what: Gazebo 世界文件（.world / .sdf）
    format: Gazebo 原生格式
    naming: 场景名.world，如 assembly.world
    where_used: 由 site.yaml 的 sim.world 指向

  - path: models
    required: false
    what: 工件 / 夹具 / 通止规模型
    format: 每个模型一个子目录，内含 <模型名>.sdf 与 meshes/
    naming: >
      模型名必须与推理用的类别名一致（如 workpiece），否则仿真里算出的坐标
      与推理结果对不上。网格单位必须是米，用毫米建模的必须先缩放。
    where_used: Gazebo 场景加载

  - path: urdf
    required: false
    what: 仿真版机器人描述
    format: .urdf / .xacro，需含 gazebo 与 ros2_control 标签
    naming: 关节前缀必须以 sim_ 开头，与真实臂（Rizon4-xxxxxx_）区分
    where_used: 仿真机器人加载

  - path: sensor_plugins
    required: false
    what: 传感器插件（含 Orisys 触觉自定义插件）
    format: 插件源码 + CMakeLists.txt
    naming: 插件类名以 Orisys 开头
    where_used: 仿真传感器数据发布

# --- 适配器 ----------------------------------------------------------------
driver:
  package: arm_sim_gazebo
  executable: gazebo_sim_launcher
  build: colcon
  notes: >
    当前尚未实现。接线前 run_sim.sh 走的是 arm_bringup 的 mock 驱动路径。

# --- 配置项声明 ------------------------------------------------------------
# 设计约束：仿真与真机共用同一套 site.yaml 参数（servo.* / hole_detect.stage2.*），
# 避免「仿真调好的值搬到真机不生效」。只有物理引擎自身的参数放在 sim.* 下。
config_schema:
  - key: world
    site_path: sim.world
    type: str
    required: false
    default: ""
    doc: >
      仿真世界文件路径。留空表示使用 Gazebo 默认空场景。
      Gazebo 接线完成后填真实路径，如 devices/sim/gazebo/worlds/assembly.world。

  - key: physics_enable
    site_path: sim.physics_enable
    type: bool
    required: false
    default: true
    doc: 是否启用物理引擎。关闭可用于纯运动学验证。

  - key: joint_prefix
    site_path: sim.joint_prefix
    type: str
    required: false
    default: sim_
    doc: >
      仿真关节名前缀。必须与真实臂的前缀（Rizon4-xxxxxx_）不同，
      否则仿真与真机的 TF 会互相污染。