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

安装 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 Daemon:

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
cd ws
mkdir src

现在在工作区的根目录中创建一个 .devcontainer 文件夹,并将 devcontainer.jsonDockerfile 添加到此 .devcontainer 文件夹中。 工作区结构应如下所示:

ws
├── .devcontainer
│   ├── devcontainer.json
│   └── Dockerfile
├── src
    ├── package1
    └── package2

使用“文件->打开文件夹…”或“Ctrl+K Ctrl+O”,在 VS Code 中打开工作区的“ws”文件夹。

编辑适合您的环境的“devcontainer.json”

为了使 Dev Container 正常运行,我们必须使用正确的用户构建它。 因此,将以下内容添加到“.devcontainer/devcontainer.json”:

{
    "name": "ROS 2 Development Container",
    "privileged": true,
    "remoteUser": "YOUR_USERNAME",
    "build": {
        "dockerfile": "Dockerfile",
        "args": {
            "USERNAME": "YOUR_USERNAME"
        }
    },
    "workspaceFolder": "/home/ws",
    "workspaceMount": "source=${localWorkspaceFolder},target=/home/ws,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_AUTOMATIC_DISCOVERY_RANGE": "LOCALHOST",
        "ROS_DOMAIN_ID": "42"
    },
    "runArgs": [
        "--net=host",
        "--pid=host",
        "--ipc=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"
    ],
    "postCreateCommand": "sudo rosdep update && sudo rosdep install --from-paths src --ignore-src -y && sudo chown -R $(whoami) /home/ws/"
}

使用``Ctrl+F``打开搜索和替换菜单。 搜索``YOUR_USERNAME``并将其替换为您的``Linux 用户名``。 如果您不知道您的用户名,您可以在终端中运行``echo $USERNAME``来找到它。

编辑``Dockerfile``

打开 Dockerfile 并添加以下内容:

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

# Delete user if it exists in container (e.g Ubuntu Noble: ubuntu)
RUN if id -u $USER_UID ; then userdel `id -un $USER_UID` ; fi

# 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"]

将“ROS_DISTRO”替换为您希望用作上述基础映像的 ROS 2 发行版,例如“rolling”。

打开并构建开发容器

使用“View->Command Palette…”或“Ctrl+Shift+P”打开命令面板。 搜索命令“Dev Containers: Reopen in Container”并执行它。 这将为您构建开发 docker 容器。这需要一段时间 - 坐下来或去喝杯咖啡。

测试容器

要测试一切是否正常,请使用 VS Code 中的“View->Terminal”或“Ctrl+Shift+”和“New Terminal”在容器中打开一个终端。 在终端内执行以下操作:

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

Note

There might be a problem with displaying RVIZ. Please make sure to allow the user to access X window system with xhost +local:<USERNAME>. If no window still pops up, then check the value of echo $DISPLAY - if the output is 1, you can fix this problem with echo "export DISPLAY=unix:1" >> /etc/bash.bashrc and then test it again. You can also change the DISPLAY value in the devcontainer.json and rebuild it.