Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 4.24 KB

Compiling_OrangeTx.md

File metadata and controls

73 lines (54 loc) · 4.24 KB
Raw

Compiling and Programming (OrangeRX)

Multiprotocol firmware is compiled using the Arduino IDE. The guide below will walk you through all the steps to compile and upload your customized firmware.

These instructions are for the OrangeRX version of the Multiprotocol module. If you are compling for a different module please go to the dedicated page Atmega328p or STM32 page.

Index

  1. Tools Required
  2. Preparation
    1. Install the Arduino IDE
    2. Download the Multiprotocol source and open the project
    3. Install the Multi 4-in-1 board
    4. Configure the Arduino IDE
  3. Configure the firmware
    1. Customize the firmware to match your hardware and your needs
    2. Verify the firmware
  4. Compiling and uploading the firmware
    1. Upload the firmware
      1. Flash from TX
  5. Troubleshooting

Tools required

Flashing the bootloader to the OrangeRX module requires either a PPI-capable programmer or an Arduino Pro Mini programmed with a sketch which can program the bootloader.

Flashing the bootloader is outside the scope of this documentation. Full instructions are available here.

Preparation

Install the Arduino IDE

  1. Download and install the Arduino IDE. The currently supported Arduino version is 1.8.5, available for Windows and Mac OSX
  2. It is recommended to upgrade Java to the latest version

Download the Multiprotocol source and open the project

  1. Either
    1. Download the zip file with the Multiprotocol module source code from here and unzip and copy the source code folder Multiprotocol to a location of your choosing, or
    2. Clone the project using Git or Github Desktop, then
  2. Double-click the Multiprotocol.ino file in the Multiprotocol folder to open the project in the Arduino IDE

Install the Multi 4-in-1 board

  1. Follow these instructions to install the Multi 4-in-1 OrangeRX Board in the Arduino IDE

Configure the Arduino IDE

  1. Under Tools -> Board select 'Multi 4-in-1 (OrangeRX)'

Configure the firmware

Customize the firmware to match your hardware and your needs

All customization is done by editing the _Config.h file in the Multiprotocol Arduino project.

The OrangeRX module has more than enough flash space for all the compatible protocols so, unlike the Atmega328p-based module, it is not necessary to disable unused protocols.

You can still disable protocols if you wish, and you may also enable or disable other optional Multiprotocol features.

Verify the firmware

To check that the program will compile correctly and fit in the Atmega click Sketch -> Verify/Compile, or press Ctrl+R.

If there are no errors and you see output like this:

Sketch uses 31874 bytes (97%) of program storage space. Maximum is 32768 bytes.
Global variables use 1083 bytes (52%) of dynamic memory, leaving 965 bytes for local variables. Maximum is 2048 bytes.

You can proceed to the next step.

Compiling and uploading the firmware

Upload the firmware

You are now ready to upload the firmware to the multiprotocol module. Uploading is done via the 'Flash-from-TX' method.

Note: 'Flash from TX' is only available with radios running ersky9x r221e2 or newer.

Flash from TX

  1. In the Arduino IDE click Sketch -> Export compiled Binary, or press Ctrl+Alt+S
  2. Locate the file named multi-orx-[version].hex in the Multiprotocol folder
  3. Follow the instructions here to upload the firmware using your radio