ardupilot/ardupilot-dev-periph

ArduPilot Docker镜像文档

1. 镜像概述与主要用途

ArduPilot是一款先进、功能全面且可靠的开源自动驾驶软件，自2010年起由专业工程师、计算机科学家及社区贡献者共同开发，支持控制多种车辆系统（如固定翼飞机、多旋翼、直升机、地面车辆、船只、潜艇等）。

本Docker镜像是ArduPilot的CI（持续集成）专用镜像，主要用途为构建AP_Periph组件。AP_Periph是ArduPilot生态中的外围设备支持库，负责传感器、执行器等外围硬件的驱动与通信功能。该镜像旨在为AP_Periph的构建提供标准化、一致的环境，确保持续集成流程中的构建稳定性与可重复性。

2. 核心功能与特性

2.1 持续集成适配

专为CI流程设计，支持与主流CI/CD平台（如GitHub Actions、Jenkins、GitLab CI等）无缝集成，自动化AP_Periph的构建流程。

2.2 一致的构建环境

预配置了构建AP_Periph所需的依赖工具链（如编译器、链接器、库文件等），避免因环境差异导致的构建失败，确保跨平台、跨节点的构建一致性。

2.3 AP_Periph构建支持

针对AP_Periph的源码结构与构建需求优化，可直接执行构建命令生成目标文件（如库文件、固件镜像），支持多架构编译（视配置而定）。

2.4 开源与可扩展

基于ArduPilot开源项目，镜像构建脚本（Dockerfile）完全公开，支持用户根据需求自定义扩展（如添加额外依赖、调整编译参数）。

3. 使用场景与适用范围

3.1 AP_Periph开发团队

供开发人员在本地或CI环境中快速构建AP_Periph，验证代码修改后的编译正确性。

3.2 CI/CD流程集成

作为持续集成流水线的核心构建环境，在代码提交、PR创建等触发条件下自动执行AP_Periph构建，确保代码质量。

3.3 自动化构建验证

用于夜间构建、版本发布等场景，批量生成AP_Periph的不同版本（如调试版、发布版）。

4. 使用方法

4.1 拉取镜像

从Docker仓库拉取最新版本镜像（具体仓库地址需参考官方源，以下为示例命令）：

bash
docker pull ardupilot/ardupilot-ci:latest

4.2 运行构建命令

在CI流程或本地环境中，通过docker run执行AP_Periph构建。示例：

bash
docker run --rm -v $(pwd):/ardupilot ardupilot/ardupilot-ci:latest \
  /bin/bash -c "cd /ardupilot/AP_Periph && make clean && make"

• --rm：构建完成后自动删除容器
• -v $(pwd):/ardupilot：将本地ArduPilot源码目录挂载到容器内/ardupilot路径
• 命令序列：进入AP_Periph目录，清理旧构建文件，执行编译

4.3 CI配置示例（GitHub Actions）

在.github/workflows/build-ap-periph.yml中集成：

yaml
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Pull ArduPilot CI image
        run: docker pull ardupilot/ardupilot-ci:latest
      - name: Build AP_Periph
        run: |
          docker run --rm -v $(pwd):/ardupilot ardupilot/ardupilot-ci:latest \
            /bin/bash -c "cd /ardupilot/AP_Periph && make"

5. 配置说明

5.1 环境变量

该镜像主要用于CI流程，通常通过挂载源码目录和执行命令参数控制构建行为，常见环境变量（视具体版本支持）：

• BUILD_TARGET：指定构建目标（如debug、release），默认值可能为release
• BRANCH：指定构建的代码分支，需配合源码挂载路径使用
• MAKE_FLAGS：传递额外的make参数（如-j4启用并行编译）

5.2 配置建议

• 挂载源码时确保本地目录权限正确，避免容器内写入权限不足
• 对于大规模构建，通过MAKE_FLAGS="-j$(nproc)"启用多线程编译加速
• 构建结果（如.bin、.a文件）会输出到挂载目录的AP_Periph/build下，可通过容器外路径访问

6. 相关资源

• ArduPilot源码仓库：https://github.com/ArduPilot/ardupilot
• Dockerfile地址：https://github.com/ArduPilot/ardupilot_dev_docker
• 贡献指南：[***]