Docker PlatformIO Container

This is a Dockerfile packaging PlatformIO. The image contains the PlatformIO Command Line Interface (PlatformIO Core) for developing software for embedded devices and IoT projects.

Continuous Integration

Github Actions

It is very easy to have CI features for your project using GitHub Actions and this Docker image. To set this up, create a file called build.yml in the folder .github/workflows and add the following content:

name: Build

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2
      - uses: docker://ghcr.io/fabricaio/docker-platformio-container:master
        with:
          args: run

This will trigger a build with platformio on every push in every branch.

Jenkins Pipeline

Here is a very simple Jenkins pipeline example:

pipeline {
    agent any
    triggers { cron('H 4/* 0 0 1-5') }

    stages {
        stage('Build') {
            steps {
                git 'https://github.com/platformio/platformio-examples.git'

                sh 'docker run --rm \
                    -v <PROJECT_DIR>:/workspace \
                    -u `id -u $USER`:`id -g $USER` \
                    ghcr.io/fabricaio/docker-platformio-container:master \
                    run'
            }
        }
    }
}

Jenkins will periodically poll the SCM repository for changes and trigger a build with platformio-core.

Step By Step

Pull the image

docker pull ghcr.io/fabricaio/docker-platformio-container:master

Run a Docker container

docker run --rm \
    -v <PROJECT_DIR>:/workspace \
    -u `id -u $USER`:`id -g $USER` \
    --device=/dev/ttyUSB0 \
    ghcr.io/fabricaio/docker-platformio-container:master \

With <PROJECT_DIR> as the directory containing your work, e.g. ~/Workspace/myproject/.

Examples

With this Docker image you can for example, create a new project:

docker run --rm \
    -v <PROJECT_DIR>:/workspace \
    -u `id -u $USER`:`id -g $USER` \
    ghcr.io/fabricaio/docker-platformio-container:master \
    init --board uno

Compile a project:

docker run --rm \
    -v <PROJECT_DIR>:/workspace \
    -u `id -u $USER`:`id -g $USER` \
    ghcr.io/fabricaio/docker-platformio-container:master \
    run

Or upload your project to a board connected to the PC:

docker run --rm \
    -v <PROJECT_DIR>:/workspace \
    -u `id -u $USER`:`id -g $USER` \
    --device=/dev/ttyUSB0 \
    ghcr.io/fabricaio/docker-platformio-container:master \
    run -t upload

Replace /dev/ttyUSB0 with the appropriate serial interface for your device.

Keep Configuration

If you want to keep the downloaded packages, etc. you can save the PlatformIO configuration outside of the container. You can do this by adding the following line to the docker run call:

-v <PACKAGES_DIR>:/.platformio

Where <PACKAGES_DIR> is the directory you want to use to store the configuration

Caution

Binding to the .platformio folder seems to dramatically slow down the build process for some reason

Alternatively you could use a data volume container to save the PlatformIO configuration. First create the data volume container

docker run --name vc_platformio ghcr.io/fabricaio/docker-platformio-container:master

Then add the following line to the docker run call:

--volumes-from=vc_platformio