micro-ROS Docker镜像

本仓库包含Docker相关材料，旨在设置、配置和开发基于micro-ROS的应用。

这套Dockerfile提供即用型环境，可轻松在主机上执行micro-ROS示例，以及使用独立的micro-ROS构建系统。此外，还提供两个镜像，允许将micro-ROS用作外部库，分别适用于ESP-IDF和Arduino IDE。

Docker镜像可在dockerhub获取。

可用镜像列表

![]([***]

依赖条件

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

使用方法

获取镜像

使用docker pull命令获取镜像：

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

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

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

运行容器

获取本地镜像后，使用docker run启动容器。通常建议使用--rm和--net=host标志启动容器：

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

• --rm：容器退出后自动删除
• --net=host：使容器与主机共享网络
• -it：分配伪终端并保持标准输入监听
• -v：映射本地文件到容器（用于从容器内烧录开发板时）

各镜像详细说明

base镜像

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

micro-ros-agent

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

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

micro-ros-demos

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

# 示例：进入micro-ros-demos容器的bash终端
docker run -it --net=host microros/micro-ros-demos bash

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

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

包含适用于Olimex-STM32-E407开发板的可直接烧录固件（含演示程序）。需映射设备到容器以进行烧录：

# 示例：运行并映射USB设备
docker run -it --privileged -v /dev/bus/usb:/dev/bus/usb microros/micro-ros-olimex-nuttx:foxy

进入容器后，在firmware/NuttX目录执行scripts/flash.sh烧录开发板。示例包含发布者和订阅者，通过串口传输与micro-ROS Agent通信，需启动相同传输方式的Agent（可使用micro-ros-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
idf.py build
idf.py flash
idf.py monitor

自动构建

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

构建触发源

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

项目目的

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

许可证

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

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

已知问题/限制

无已知限制。如发现问题，请报告。