benlye / Multi4in1-Build

A Docker container for building DIY Multiprotocol TX Module firmware

Multi4in1-Build

A Docker container for building the firmware for the Multiprotocol TX Module.

The container contains a Debian Linux image pre-configured with the tools required to build the Multiprotocol TX Module firmware. 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 benlye/multi4in1-build

3. Clone the Multiprotocol TX Module GitHub repository (or download and unzip the source as .zip file):

   git clone https://github.com/pascallanger/DIY-Multiprotocol-TX-Module.git

Modify the Firmware

Use your tool of choice to make changes to the Multiprotocol Module firmware source. Visual Studio Code is a good option.

Build the Firmware

1. Run the container, specifying the path to the Multiprotocol firmware source as a mount volume and the board type as an enviroment variable:

   docker run --rm -it -v [Firmware Source Path]:/multi -e "BOARD=[board]" [-e "FWBINNAME=[output file name]"] benlye/multi4in1-build

   For example (Windows):

   docker run --rm -it -v "C:\Users\benlye\Github\DIY-Multiprotocol-TX-Module:/multi" -e "BOARD=stm32" benlye/multi4in1-build

   Or (Linux):

   docker run --rm -it -v "/home/benlye/github/DIY-Multiprotocol-TX-Module:/multi" -e "BOARD=stm32" benlye/multi4in1-build

The compiled firmware image will be placed in the root of the source directory when the build has finished (same location as the Multiprotocol.ino file).

Boards

Board names and aliases are case sensitive.

Board options are:

Board Type	Alias	FQBN	Equivalent IDE Option
AVR	avr	multi4in1:avr:multiatmega328p	Bootloader => None
AVR	avr-optiboot	multi4in1:avr:multiatmega328p:bootloader=optiboot	Bootloader => Optiboot
STM32 128KB	stm32	multi4in1:STM32F1:multistm32f103cb	Debug Option => None
STM32 128KB	stm32-usbdebug	multi4in1:STM32F1:multistm32f103cb:debug_option=native	Debug Option => Native USB Debugging
STM32 128KB	stm32-ftdidebug	multi4in1:STM32F1:multistm32f103cb:debug_option=ftdi	Debug Option => FTDI Debugging
STM32 64KB	stm32-64	multi4in1:STM32F1:multistm32f103c8
T18 5in1	t18-5in1	multi4in1:STM32F1:multi5in1t18int
OrangeRX	orx	multi4in1:avr:multixmega32d4

'Devel' boards can be specified by appending '-devel' to the alias, or substituting 'multi4in1' with 'multi4in1-devel' in the FQBN.

Output File Name

The FWBINNAME variable can be used to specify a custom name for the compiled firmware file. If the option is omitted or blank, the default naming is used.

The custom output file name can include the text {VERSION} which will be automatically replaced by the firmware version number.

For example (Windows):

docker run --rm -it -v "C:\Users\benlye\Github\DIY-Multiprotocol-TX-Module:/multi" -e "BOARD=stm32" -e "FWBINNAME=myfw-v{VERSION}" benlye/multi4in1-build

Or (Linux):

docker run --rm -it -v "/home/benlye/github/DIY-Multiprotocol-TX-Module:/multi" -e "BOARD=stm32" -e "FWBINNAME=myfw-v{VERSION}" benlye/multi4in1-build

Will create a firmware file named myfw-v1.3.3.20.bin.