模拟器的 ROS 文档

欢迎使用 OpenHUTB 的 ROS 文档 1。

提交项目之前,请按以下指引自查,并阅读仓库提交约定。PR 模板只列常见检查项;具体任务、模拟器和验收要求以老师及维护者说明为准。

展开项目提交与复现指引
  1. 确认提交范围。 在 Files changed 中逐个检查新增、修改和删除。不要提交 build、install、log 等无关生成目录、备份或重复文件,不用个人项目内容覆盖仓库首页及公共配置。需要修改公共内容时说明原因与影响。
  2. 整理模块与启动入口。 源码放在 src 对应模块,教程放在 docs 对应模块,文件使用英文下划线命名。提供 main.* 和 launch,核对包名、可执行名、依赖、模型路径及安装规则,完善实际包描述、维护信息和许可证。
  3. 按文档完整运行。 README 写清实际验证的系统、ROS、Python、模拟器和关键依赖版本,以及获取源码、安装、构建、加载环境、启动和停止步骤,注明执行目录。建议从新终端操作,检查键盘输入、运动方向、状态切换、退出停车和异常清理。
  4. 准确说明验证范围。 区分节点启动、话题通信、可视化演示与完整仿真效果。固定速度发布不等于轨迹跟踪,离线测试不等于在线闭环验证。指标注明定义、单位、场景与测量方法,保留必要日志;未验证的内容和简化假设如实说明。
  5. 检查网页与配图。 新模块在本首页和 mkdocs.yml 增加入口,运行 mkdocs serve --livereload 检查相关页面、链接、公式和流程图。使用真实运行截图而非拍照,示意图明确标注;PNG 小于 3 MB、GIF 小于 10 MB,大量数据提供持久下载链接。
  6. 完成说明与复核。 PR 标题和提交信息说明修改目的,使用大模型时声明具体工具并对内容负责。合并前至少一名其他人在另一台机器测试并同意,不能用作者自测替代。纯文档或局部修复按实际影响检查,不要求新增无关模块。

以上结合仓库要求和复现建议整理,不作为新增评分标准。也可参阅文档撰写约定和贡献指南。


1. 入门

ROS 相关资料(网盘下载地址):

下载并安装好 ROS 的虚拟机。此虚拟机基于 Linux (Ubuntu 20.04 lsb_release -a)操作系统,并已预先配置为支持使用 ROS (ROS 1 Noetic 和 ROS 2 Humble) 构建的应用程序。

ROS每章节运行代码:

ROS 2 话题发布订阅基础实验(talker/listener):chap2/ros2_pubsub_py

2. 人形机器人

3. 肌肉骨骼人

4. 地面载具

5. 空域载具

6. 水域载具


如果对文档中的任何问题可以在 本文档的源码仓库 中的 问题 页面讨论或者提交 拉取请求 直接修改文档。


参考文献


  1. Macenski, S., Foote, T., Gerkey, B., Lalancette, C. & Woodall, W. Robot operating system 2: Design, architecture, and uses in the wild. Science robotics 7, eabm6074 (2022). ↩