/opentx-docker-build

docker to build opentx/jumper firmware

Primary LanguagePython

opentx-docker-build

A Docker container for building OpenTX firmware.

The container contains a Debian Linux image pre-configured with the tools required to build OpenTX.
Running the container will compile the firmware from a local source tree and produce a compiled firmware image.

Instructions

Setup

  1. Install Docker

    • If installing on Windows choose Linux Containers when prompted

  2. Pull the container:

    docker pull vitass/opentx-fw-build

  3. Clone the OpenTX repository:

    git clone --recursive -b 2.3 https://github.com/opentx/opentx.git

Modify the Firmware

Use your tool of choice to make changes to the OpenTX source.

Board target name

You have to specify a board name as first env variable (BOARD_NAME), it is lowercase name like x10, t12, etc

Build the Firmware

  1. Run the container, specifying the path to the OpenTX source as a mount volume:

    docker run --rm -it -e "BOARD_NAME=board_name" -v [OpenTX Source Path]:/opentx vitass/opentx-fw-build

    example build jumper t16 formware:

    docker run --rm -it -e "BOARD_NAME=t16" -v "/home/vitas/github/opentx.git:/opentx" vitass/opentx-fw-build

The compiled firmware image will be placed in the root of the source directory when the build has finished.

The default output name is opentx-boardname-2.3.ver.bin but this will vary depending on any optional flags that may have been passed.

Changing the Build Flags

Build flags can be changed by passing a switch to the Docker container when it is run.

Default flags will be replaced by the new value, additional flags will be appended.

Examples

  1. Build from the source in /home/vitas/opentx.git for x10 and disable HELI:

    docker run --rm -it -v "/home/vitas/opentx.git:/opentx" -e "BOARD_NAME=x10" -e "CMAKE_FLAGS=HELI=NO" vitass/opentx-fw-build