devrt/ros-devcontainer-vscode

ROS开发容器（VSCode专用）

镜像概述和主要用途

该Docker镜像为ROS开发提供预配置环境，专为VSCode设计，支持跨平台（Windows/Mac）使用。集成浏览器可访问的X11服务器，实现Gazebo、RViz、Rqt等图形界面显示；提供代码补全、任务定义及多种预配置模拟环境，同时包含Theia WebIDE，满足本地及远程ROS开发需求。

!VSCode和devcontainer在Mac上运行

!WebIDE（Theia）在远程服务器运行时通过本地浏览器访问

核心功能和特性

• 预配置ROS开发环境：无需手动配置ROS环境，开箱即用
• 跨平台X11服务器：通过浏览器访问，支持在Windows/Mac上显示Gazebo、RViz、Rqt等图形界面
• 任务定义：内置catkin_make、roscore、rviz等常用命令的任务配置
• 多语言代码补全：支持C++、Python及XML（package.xml、launch文件、URDF、SDF）
• 预配置模拟环境：包含Flatland、TurtleBot3、ARIAC、Virtual RobotX、UUV
• WebIDE支持：集成Theia WebIDE，提供与VSCode相当的功能，支持C++/Python/XML补全

使用场景和适用范围

• ROS开发者在Windows或Mac系统上进行ROS开发
• 需要快速搭建标准化ROS开发环境的团队或个人
• 学生、研究人员学习ROS及机器人仿真
• 远程服务器上部署ROS开发环境，通过浏览器访问

使用方法和配置说明

选择模拟环境

可将预配置的模拟环境作为Docker侧边容器运行，执行以下命令选择模拟器：

shell
$ ./select-simulator.sh

当前支持的模拟环境包括：Flatland、TurtleBot3、ARIAC、Virtual RobotX、UUV。完整模拟器列表参见：
https://github.com/devrt/simulator-index/blob/master/index.yaml

如需其他模拟器，可通过以下链接提交需求：
https://github.com/devrt/simulator-index/issues

使用WebIDE（推荐）

目前VSCode的docker-compose支持在部分平台不够稳定，推荐使用Theia WebIDE（1.0版本后支持完整VSCode功能）：

1. 克隆仓库：

shell
$ git clone https://github.com/devrt/ros-devcontainer-vscode.git

2. 进入项目目录并启动容器：

shell
$ cd ros-devcontainer-vscode
$ docker-compose up

3. 使用浏览器访问：http://localhost:3001/

也可在远程服务器部署，执行docker-compose up后通过http://[远程服务器IP]:3001访问。

与VSCode一起使用

前提条件

安装以下软件：

• VSCode
• Docker for Mac 或 Docker for Windows

操作步骤

1. 在VSCode中安装"Remote Development"扩展
2. 克隆仓库：git clone https://github.com/devrt/ros-devcontainer-vscode.git
3. 点击VSCode左下角的绿色快速操作状态栏图标
4. 从命令列表中选择"Remote-Containers: Open Folder in Container..."，打开克隆项目的根目录
5. 等待容器启动（首次启动需较长时间）

详细说明参见：[***]

代理环境配置

如在代理环境下使用，需进行以下两项配置：

1. Docker服务器代理设置

点击Docker桌面任务栏图标 > 选择"偏好设置"，配置代理：

!docker-proxy-settings

通常"系统代理"选项可正常工作，若下载镜像失败，尝试"手动代理配置"。

2. Devcontainer代理设置

该设置允许在容器内使用apt-get等网络命令：

1. 打开项目根目录下的.env.sample文件，根据环境编辑代理设置，保存为.env
2. 打开docker-compose.yml，取消以下行的注释：

yaml
  workspace:
    env_file:
      - .env

重置或更新容器

重置容器

关闭VSCode后，在项目目录执行：

shell
$ docker-compose down

更新环境至最新版本

在项目目录执行：

shell
$ git pull origin master
$ docker-compose pull

注意：docker-compose down会重置环境（包括已安装的.deb包）。若正确编写package.xml，可通过以下命令重新安装依赖：

shell
$ rosdep update
$ rosdep install --from-paths src --ignore-src -r -y

打开X11服务器屏幕

1. 等待容器启动完成
2. 使用浏览器访问：http://localhost:3000/

若使用Docker Toolbox，访问：http://192.168.99.100:3000/

如需在VSCode中集成浏览器窗口，可安装Browser Preview for VS Code扩展。

创建者

Yosuke Matsusaka（MID Academic Promotions, Inc.）

许可证

本仓库代码（Dockerfile、工具脚本等）采用Apache 2.0许可证分发。

包含组件的许可证：

• Theia IDE：EPL或GPL
• Jupyter notebook：BSD