micro-ROS Docker镜像

概述

本仓库包含用于设置、配置和开发基于micro-ROS应用的Docker相关材料。这套Dockerfile提供了现成的环境，可轻松在主机上执行micro-ROS示例，以及使用独立的micro-ROS构建系统。此外，还提供了两个镜像，允许将micro-ROS用作外部库，分别适用于ESP-IDF和Arduino IDE。

Docker镜像可在Docker Hub获取。

可用镜像

![]([***]

前提条件

系统中需安装Docker。有关Docker的安装，请参考官方文档：[***]

使用方法

获取镜像

使用docker pull命令获取镜像：

docker pull microros/base  # 示例：拉取base镜像

可通过在镜像名称后添加:tag选择特定标签：

docker pull microros/base:foxy  # 示例：拉取foxy标签的base镜像

运行容器

获取本地镜像后，使用docker run启动容器。通常建议使用--rm（退出后删除容器）和--net=host（共享主机网络）标志：

docker run -it --rm --net=host microros/micro-ros-agent:foxy  # 示例：运行micro-ros-agent容器

• --rm：确保退出后删除容器
• --net=host：使容器拥有与主机相同的网络访问权限
• -it：分配伪终端并保持标准输入监听
• -v：映射本地文件到容器（用于从容器内烧录开发板时有用）

各镜像具体使用

base镜像

作为其他容器的基础，包含必要的micro-ROS设置工具和依赖。可基于此镜像开始任何micro-ROS开发。

micro-ros-agent

作为独立应用使用，包含所选标签对应的ROS 2版本和micro-ROS Agent。镜像的入口点直接是micro-ROS Agent，执行docker run后将进入Agent命令行输入。例如：

docker run -it --net=host microros/micro-ros-agent:foxy udp4 -p 9999  # 启动UDP4监听端口9999的Agent

micro-ros-demos

示例镜像，可启动基于Linux机器编译的micro-ROS示例应用。镜像入口点已配置包含micro-ROS示例的ROS 2环境，可使用常规ROS 2工具启动示例：

docker run -it --net=host microros/micro-ros-demos bash  # 进入容器并使用bash

当前可用示例列表见此处。

micro-ros-olimex-nuttx（未维护）

提供适用于Olimex-STM32-E407开发板的可直接烧录固件。需映射设备到容器以进行烧录：

docker run -it --privileged -v /dev/bus/usb:/dev/bus/usb microros/micro-ros-olimex-nuttx:foxy  # 映射USB设备

进入容器后，在firmware/NuttX目录运行scripts/flash.sh烧录开发板。示例包含发布者和订阅者，使用串口传输与micro-ROS Agent通信，需启动对应传输的Agent。

micro_ros_arduino_builder

提供预编译的micro-ROS库，用于通过Arduino IDE开发应用。实例化容器命令：

docker run -it -v $(pwd):/arduino_project --net=host microros/micro_ros_arduino_builder:foxy

extras/library_generation/extra_packages目录中的文件和extras/library_generation/extra_packages/extra_packages.repos中的条目将被构建系统考虑。

esp-idf-microros

允许将micro-ROS用作ESP-IDF构建系统的组件。使用命令：

docker run -it --user espidf --volume="/etc/timezone:/etc/timezone:ro" -v $(pwd):/micro_ros_espidf_component -v /dev:/dev --privileged --workdir /micro_ros_espidf_component microros/esp-idf-microros:latest /bin/bash

进入容器后，可导航到示例应用目录，使用ESP-IDF构建工具脚本idf.py进行配置、构建、烧录或监控：idf.py menuconfig/build/flash/monitor。

自动构建

这些Dockerfile用于在Docker Hub上自动创建镜像，标签对应兼容的ROS 2版本（如dashing、foxy），latest标签对应最新ROS 2版本。

自动构建与micro-ROS仓库内容直接关联，触发条件如下表：

除GitHub仓库变更外，当Docker Hub上的基础镜像（Dockerfile中FROM:指令指定）更新时也会触发构建。

项目目的

本软件尚未准备好用于生产环境，未针对特定用例开发或测试。但根据适用开源许可证，您可根据需求调整软件。在安全相关场景使用前，请确保软件满足需求并根据适用安全标准（如ISO 26262）进行调整。

许可证

本仓库采用Apache-2.0许可证开源。详见LICENSE文件。

有关本仓库包含的其他开源组件列表，详见3rd-party-licenses.txt文件。

已知问题/限制

无已知限制。

如发现问题，请报告。