# Travis CI

Travis CI officially supports PlatformIO for Embedded Builds.

Travis CI is an open-source hosted, distributed continuous integration service used to build and test projects hosted at GitHub.

Travis CI is configured by adding a file named `.travis.yml`, which is a YAML format text file, to the root directory of the GitHub repository.

Travis CI automatically detects when a commit has been made and pushed to a repository that is using Travis CI, and each time this happens, it will try to build the project using platformio ci command. This includes commits to all branches, not just to the master branch. Travis CI will also build and run pull requests. When that process has completed, it will notify a developer in the way it has been configured to do so — for example, by sending an email containing the build results (showing success or failure), or by posting a message on an IRC channel. It can be configured to build project on a range of different Development Platforms.

Contents

- Travis CI

  - Integration

    - Using platformio run command

    - Using platformio ci command

  - Library dependencies

    - Install dependent library using Library Manager

    - Manually download dependent library and include in build process via `--lib` option

  - Custom Build Flags

  - Advanced configuration

  - Unit Testing

  - Examples

## Integration

Please make sure to read Travis CI Getting Started and general build configuration guides first.

Note

If you are going to use PlatformIO PIO Unit Testing or PIO Remote you will need to define `PLATFORMIO_AUTH_TOKEN` environment variable in project settings. See Defining Variables in Repository Settings guide.

PlatformIO is written in Python and is recommended to be run within Travis CI Python isolated environment. There are two possible ways of running PlatformIO in CI services:

### Using platformio run command

This variant is default choice for native PlatformIO projects:

    language: python
    python:
        - "2.7"

    # Cache PlatformIO packages using Travis CI container-based infrastructure
    sudo: false
    cache:
        directories:
            - "~/.platformio"

    install:
        - pip install -U platformio
        - platformio update

    script:
        - platformio run /path/to/project/dir -e <ID_1> -e <ID_2> -e <ID_N>

### Using platformio ci command

This variant is more convenient when project is written as a library (when there are examples or testing code) as it has additional options for specifying extra libraries and boards from command line interface:

    language: python
    python:
        - "2.7"

    # Cache PlatformIO packages using Travis CI container-based infrastructure
    sudo: false
    cache:
        directories:
            - "~/.platformio"

    env:
        - PLATFORMIO_CI_SRC=path/to/test/file.c
        - PLATFORMIO_CI_SRC=examples/file.ino
        - PLATFORMIO_CI_SRC=path/to/test/directory

    install:
        - pip install -U platformio
        - platformio update

    script:
        - platformio ci --board=<ID_1> --board=<ID_2> --board=<ID_N>

Then perform steps 1, 2 and 4 from http://docs.travis-ci.com/user/getting-started/

## Library dependencies

There 2 options to test source code with dependent libraries:

### Install dependent library using Library Manager

    install:
        - pip install -U platformio

        #
        # Libraries from PlatformIO Library Registry:
        #
        # https://platformio.org/lib/show/1/OneWire
        - platformio lib -g install 1

### Manually download dependent library and include in build process via `--lib` option

    install:
        - pip install -U platformio

        # download library to the temporary directory
        - wget https://github.com/PaulStoffregen/OneWire/archive/master.zip -O /tmp/onewire_source.zip
        - unzip /tmp/onewire_source.zip -d /tmp/

    script:
        - platformio ci --lib="/tmp/OneWire-master" --board=<ID_1> --board=<ID_2> --board=<ID_N>

## Custom Build Flags

PlatformIO allows one to specify own build flags using `PLATFORMIO_BUILD_FLAGS` environment

    env:
        - PLATFORMIO_CI_SRC=path/to/test/file.c PLATFORMIO_BUILD_FLAGS="-D SPECIFIC_MACROS_PER_TEST_ENV -I/extra/inc"
        - PLATFORMIO_CI_SRC=examples/file.ino
        - PLATFORMIO_CI_SRC=path/to/test/directory

    install:
        - pip install -U platformio
        - export PLATFORMIO_BUILD_FLAGS="-D GLOBAL_MACROS_FOR_ALL_TEST_ENV"

For the more details, please follow to available build flags/options.

## Advanced configuration

PlatformIO allows one to configure multiple build environments for the single source code using “platformio.ini” (Project Configuration File).

Instead of `--board` option, please use `platformio ci --project-conf`

    script:
        - platformio ci --project-conf=/path/to/platoformio.ini

## Unit Testing

See PlatformIO Remote Unit Testing Example.

## Examples

1. Custom build flags

    language: python
    python:
        - "2.7"

    # Cache PlatformIO packages using Travis CI container-based infrastructure
    sudo: false
    cache:
        directories:
            - "~/.platformio"

    env:
        - PLATFORMIO_CI_SRC=examples/acm/acm_terminal
        - PLATFORMIO_CI_SRC=examples/Bluetooth/WiiIRCamera PLATFORMIO_BUILD_FLAGS="-DWIICAMERA"
        - PLATFORMIO_CI_SRC=examples/ftdi/USBFTDILoopback
        - PLATFORMIO_CI_SRC=examples/Xbox/XBOXUSB
        # - ...

    install:
        - pip install -U platformio
        - platformio update

        #
        # Libraries from PlatformIO Library Registry:
        #
        # https://platformio.org/lib/show/416/TinyGPS
        # https://platformio.org/lib/show/417/SPI4Teensy3
        - platformio lib -g install 416 417

    script:
        - platformio ci --board=uno --board=teensy31 --board=due --lib="."

- Configuration file: https://github.com/felis/USB_Host_Shield_2.0/blob/master/.travis.yml

- Build History: https://travis-ci.org/felis/USB_Host_Shield_2.0

2. Dependency on external libraries

    language: python
    python:
        - "2.7"

    # Cache PlatformIO packages using Travis CI container-based infrastructure
    sudo: false
    cache:
        directories:
            - "~/.platformio"

    env:
        - PLATFORMIO_CI_SRC=examples/backSoon/backSoon.ino
        - PLATFORMIO_CI_SRC=examples/etherNode/etherNode.ino
        # -

    install:
        - pip install -U platformio
        - platformio update

        - wget https://github.com/jcw/jeelib/archive/master.zip -O /tmp/jeelib.zip
        - unzip /tmp/jeelib.zip -d /tmp

        - wget https://github.com/Rodot/Gamebuino/archive/master.zip  -O /tmp/gamebuino.zip
        - unzip /tmp/gamebuino.zip -d /tmp

    script:
        - platformio ci --lib="." --lib="/tmp/jeelib-master" --lib="/tmp/Gamebuino-master/libraries/tinyFAT" --board=uno --board=megaatmega2560

- Configuration file: https://github.com/jcw/ethercard/blob/master/.travis.yml

- Build History: https://travis-ci.org/jcw/ethercard

3. Dynamic testing of the boards

    language: python
    python:
        - "2.7"

    # Cache PlatformIO packages using Travis CI container-based infrastructure
    sudo: false
    cache:
        directories:
            - "~/.platformio"

    env:
        - PLATFORMIO_CI_SRC=examples/TimeArduinoDue PLATFORMIO_CI_EXTRA_ARGS="--board=due"
        - PLATFORMIO_CI_SRC=examples/TimeGPS
        - PLATFORMIO_CI_SRC=examples/TimeNTP
        - PLATFORMIO_CI_SRC=examples/TimeTeensy3 PLATFORMIO_CI_EXTRA_ARGS="--board=teensy31"
        # - ...

    install:
        - pip install -U platformio
        - platformio update
        - rm -rf ./linux

        #
        # Libraries from PlatformIO Library Registry:
        #
        # https://platformio.org/lib/show/416/TinyGPS
        - platformio lib -g install 416 421 422

    script:
        - platformio ci --lib="." --board=uno --board=teensy20pp $PLATFORMIO_CI_EXTRA_ARGS

- Configuration file: https://github.com/ivankravets/Time/blob/master/.travis.yml

- Build History: https://travis-ci.org/ivankravets/Time

4. Advanced configuration with extra project options and libraries

    language: python
    python:
        - "2.7"

    # Cache PlatformIO packages using Travis CI container-based infrastructure
    sudo: false
    cache:
        directories:
            - "~/.platformio"

    env:
        - PLATFORMIO_CI_SRC=examples/Boards_Bluetooth/Adafruit_Bluefruit_LE
        - PLATFORMIO_CI_SRC=examples/Boards_Bluetooth/Arduino_101_BLE PLATFORMIO_CI_EXTRA_ARGS="--board=genuino101"
        - PLATFORMIO_CI_SRC=examples/Boards_USB_Serial/Blue_Pill_STM32F103C PLATFORMIO_CI_EXTRA_ARGS="--board=bluepill_f103c8 --project-option='framework=arduino'"
        - PLATFORMIO_CI_SRC=examples/Export_Demo/myPlant_ESP8266 PLATFORMIO_CI_EXTRA_ARGS="--board=nodemcuv2 --project-option='lib_ignore=WiFi101'"
        # - ...

    install:
        - pip install -U platformio
        - platformio update

        #
        # Libraries from PlatformIO Library Registry:
        #
        # https://platformio.org/lib/show/44/Time
        # https://platformio.org/lib/show/419/SimpleTimer
        #
        # https://platformio.org/lib/show/17/Adafruit-CC3000
        # https://platformio.org/lib/show/28/SPI4Teensy3
        # https://platformio.org/lib/show/91/UIPEthernet
        # https://platformio.org/lib/show/418/WildFireCore
        # https://platformio.org/lib/show/420/WildFire-CC3000
        # https://platformio.org/lib/show/65/WiFlyHQ
        # https://platformio.org/lib/show/19/Adafruit-DHT
        # https://platformio.org/lib/show/299/WiFi101
        # https://platformio.org/lib/show/259/BLEPeripheral
        # https://platformio.org/lib/show/177/Adafruit_BluefruitLE_nRF51

        - platformio lib -g install 17 28 91 418 419 420 65 44 19 299 259 177 https://github.com/vshymanskyy/BlynkESP8266.git https://github.com/cmaglie/FlashStorage.git https://github.com/michael71/Timer5.git

    script:
        - make travis-build

- Configuration file: https://github.com/blynkkk/blynk-library/blob/master/.travis.yml

- Build History: https://travis-ci.org/blynkkk/blynk-library