luxonis/depthai-ros

Depthai-ros build Docker镜像文档

1. 镜像概述

Depthai-ros build Docker镜像是一个预配置的构建环境，专为Depthai嵌入式视觉平台与ROS（机器人操作系统）的集成项目设计。该镜像基于Ubuntu系统，整合了Depthai SDK、ROS核心组件、编译工具链（如CMake、catkin）及依赖库，旨在提供标准化、一致的构建环境，消除因本地开发环境差异导致的编译问题，帮助开发者高效完成Depthai-ROS应用的编译、测试与部署。

2. 核心功能

• 预配置环境：内置Depthai SDK、ROS核心依赖（如roscpp、rospy）、catkin构建系统及常用编译工具，无需手动安装依赖。
• 多版本兼容：支持主流ROS发行版（如Noetic、Melodic）及Depthai SDK版本，可通过环境变量灵活指定。
• 标准化流程：统一编译环境，确保不同开发者/设备上的构建结果一致性，降低协作成本。
• 轻量高效：基于精简基础镜像，优化工具链体积，平衡功能完整性与资源占用。

3. 使用场景

• Depthai-ROS项目开发：开发者本地编译Depthai-ROS节点、功能包或应用程序。
• CI/CD集成：作为自动化构建环节的基础环境，用于Depthai-ROS项目的持续集成与测试。
• 跨平台构建：在Windows、macOS等非Linux系统上，通过Docker实现Linux/ROS环境下的Depthai项目编译。
• 新手入门：简化Depthai与ROS集成的环境配置步骤，降低新手入门门槛。

4. 使用方法

4.1 拉取镜像

从镜像仓库拉取最新版本（具体仓库地址需替换为实际地址）：

bash
docker pull docker.xuanyuan.run/[镜像仓库地址]/depthai-ros-build:latest

4.2 基本构建流程

1. 挂载项目目录：将本地Depthai-ROS项目目录挂载到容器内的工作区（如/workspace）：

bash
docker run -it --rm \
  -v /本地项目路径:/workspace \
  docker.xuanyuan.run/[镜像仓库地址]/depthai-ros-build:latest

2. 执行编译命令：进入容器后，在项目目录中执行ROS构建命令：

bash
cd /workspace
# 初始化catkin工作空间（首次使用时）
catkin_init_workspace src
# 编译项目
catkin_make

3. 获取编译结果：编译生成的文件（如可执行文件、ROS包）将保存在本地挂载目录中，可直接用于部署。

4.3 自定义构建配置

通过环境变量指定ROS版本、编译类型等参数（示例：指定ROS Noetic和Release编译）：

bash
docker run -it --rm \
  -v /本地项目路径:/workspace \
  -e ROS_DISTRO=noetic \
  -e BUILD_TYPE=Release \
  docker.xuanyuan.run/[镜像仓库地址]/depthai-ros-build:latest

5. 配置说明

5.1 环境变量

5.2 依赖说明

镜像已预安装以下核心依赖，无需额外配置：

• Depthai SDK（含API及设备驱动）
• ROS核心组件（roscpp、rospy、std_msgs等）
• 编译工具（CMake、gcc、g++、catkin）
• 常用库（OpenCV、Eigen、Boost）

6. 注意事项

• 设备权限：若需在容器内直接连接Depthai设备进行测试，需添加--device参数映射USB设备（如--device /dev/bus/usb）。
• 网络配置：如需访问外部依赖库（如GitHub），确保容器网络通畅（默认使用主机网络或桥接模式）。
• 版本兼容性：指定ROS_DISTRO时，需确保项目代码与目标ROS版本兼容。