使用VSCode和Docker设置ROS 2 [社区贡献]

内容

安装VS Code和Docker
配置Docker和VS Code工作区
打开并构建开发容器
- 测试容器

安装VS Code和Docker 

使用Visual Studio Code和Docker容器，您可以在无需更改操作系统或使用虚拟机的情况下运行您喜爱的ROS 2发行版。通过本教程，您可以设置一个Docker容器，用于您未来的ROS 2项目。

安装Docker 

要安装Docker并设置正确的用户权限，请使用以下命令。

sudo apt install docker.io git python3-pip
pip3 install vcstool
echo export PATH=$HOME/.local/bin:$PATH >> ~/.bashrc
source ~/.bashrc
sudo groupadd docker
sudo usermod -aG docker $USER
newgrp docker

现在，您可以通过运行以下命令来检查安装是否成功：

docker run hello-world

如果您无法直接运行 hello-world，请先启动 Docker 守护进程：

sudo systemctl start docker

安装 VS Code 

请使用以下命令安装 VS Code：

sudo apt update
sudo apt install software-properties-common apt-transport-https wget -y
wget -q https://packages.microsoft.com/keys/microsoft.asc -O- | sudo apt-key add -
sudo add-apt-repository "deb [arch=amd64] https://packages.microsoft.com/repos/vscode stable main"
sudo apt install code

您可以在终端中输入“code”来运行 VS Code。

安装远程开发扩展 

在VS Code中搜索扩展（CTRL+SHIFT+X），找到“远程开发”扩展并安装它。

配置Docker和VS Code工作区 

添加你的ROS 2工作区 

添加一个工作空间以便在容器中构建和打开它们，例如：

cd ~/
mkdir ws_[project]
cd ws_[project]
mkdir src

现在在工作空间的根目录下创建一个 .devcontainer 文件夹，并在该文件夹中添加 devcontainer.json 和 Dockerfile。此外，您需要创建一个缓存文件夹，用于缓存不同的 ROS 2 发行版的构建和安装文件夹。工作空间的结构应该如下所示：

ws_[project]
├── cache
|   ├── [ROS2_DISTRO]
|   |   ├── build
|   |   ├── install
|   |   └── log
|   └── ...
|
├── src
    ├── .devcontainer
    │   ├── devcontainer.json
    │   └── Dockerfile
    ├── package1
    └── package2

使用 文件->打开文件夹... 或 Ctrl+K Ctrl+O，在 VS Code 中打开您的工作空间的 src 文件夹。

根据您的环境编辑 devcontainer.json 

为了使开发容器正常运行，我们必须使用正确的用户构建它。因此，请在 .devcontainer/devcontainer.json 中添加以下内容：

{
    "name": "ROS 2 Development Container",
    "privileged": true,
    "remoteUser": "USERNAME",
    "build": {
        "dockerfile": "Dockerfile",
        "args": {
            "USERNAME": "USERNAME"
        }
    },
    "workspaceFolder": "/home/ws",
    "workspaceMount": "source=${localWorkspaceFolder},target=/home/ws/src,type=bind",
    "customizations": {
        "vscode": {
            "extensions":[
                "ms-vscode.cpptools",
                "ms-vscode.cpptools-themes",
                "twxs.cmake",
                "donjayamanne.python-extension-pack",
                "eamodio.gitlens",
                "ms-iot.vscode-ros"
            ]
        }
    },
    "containerEnv": {
        "DISPLAY": "unix:0",
        "ROS_LOCALHOST_ONLY": "1",
        "ROS_DOMAIN_ID": "42"
    },
    "runArgs": [
        "--net=host",
        "-e", "DISPLAY=${env:DISPLAY}"
    ],
    "mounts": [
       "source=/tmp/.X11-unix,target=/tmp/.X11-unix,type=bind,consistency=cached",
        "source=/dev/dri,target=/dev/dri,type=bind,consistency=cached",
        "source=${localWorkspaceFolder}/../cache/ROS_DISTRO/build,target=/home/ws/build,type=bind",
        "source=${localWorkspaceFolder}/../cache/ROS_DISTRO/install,target=/home/ws/install,type=bind",
        "source=${localWorkspaceFolder}/../cache/ROS_DISTRO/log,target=/home/ws/log,type=bind"
    ],
    "postCreateCommand": "sudo rosdep update && sudo rosdep install --from-paths src --ignore-src -y && sudo chown -R USERNAME /home/ws/"
}

使用 Ctrl+F 打开搜索和替换菜单。搜索 USERNAME 并用您的 Linux 用户名 进行替换。如果您不知道您的用户名，可以在终端中运行 echo $USERNAME 来找到它。同时用您想要使用并且已经添加到缓存中的 ROS 2 发行版替换 ROS_DISTRO，例如 "humble" 或 "foxy"。

编辑 Dockerfile 

打开 Dockerfile 并添加以下内容：

FROM ros:ROS_DISTRO
ARG USERNAME=USERNAME
ARG USER_UID=1000
ARG USER_GID=$USER_UID

# Create the user
RUN groupadd --gid $USER_GID $USERNAME \
    && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME \
    #
    # [Optional] Add sudo support. Omit if you don't need to install software after connecting.
    && apt-get update \
    && apt-get install -y sudo \
    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
    && chmod 0440 /etc/sudoers.d/$USERNAME
RUN apt-get update && apt-get upgrade -y
RUN apt-get install -y python3-pip
ENV SHELL /bin/bash

# ********************************************************
# * Anything else you want to do like clean up goes here *
# ********************************************************

# [Optional] Set the default user. Omit if you want to keep the default as root.
USER $USERNAME
CMD ["/bin/bash"]

在此处搜索``USERNAME``并用您的``Linux用户名``替换，将``ROS_DISTRO``替换为您希望使用的ROS 2发行版，并将其添加到之前的缓存中。

打开并构建开发容器 

使用``View->Command Palette...``或``Ctrl+Shift+P``打开命令面板。搜索命令``Dev Containers: (Re-)build and Reopen in Container``并执行它。这将为您构建开发 Docker 容器。这需要一些时间，请坐下或去喝杯咖啡。

测试容器 

为了测试是否一切正常工作，请在容器中打开一个终端，使用 查看->终端 或者在VS Code中使用 Ctrl+Shift+` `` 并选择 ``新终端。在终端内执行以下操作：

sudo apt install ros-$ROS_DISTRO-rviz2 -y
source /opt/ros/$ROS_DISTRO/setup.bash
rviz2

注解

可能存在显示RVIZ的问题。如果没有弹出窗口，请检查 echo $DISPLAY 的值——如果输出为1，您可以通过 echo "export DISPLAY=unix:1" >> /etc/bash.bashrc 来解决此问题，然后再次进行测试。您还可以在 devcontainer.json 中更改 DISPLAY 的值并重新构建。