docs/Compiling_OrangeTx.md

   1 # Compiling and Programming (OrangeRX)
   2
   3 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.
   4
   5 **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](Compiling.md) or [STM32](Compiling_STM32.md) page.
   6
   7 ## Index
   8 1. [Tools Required](#tools-required)
   9 1. [Preparation](#preparation)
  10    1. [Install the Arduino IDE](#install-the-arduino-ide)
  11    1. [Download the Multiprotocol source and open the project](#download-the-multiprotocol-source-and-open-the-project)
  12    1. [Install the Multi 4-in-1 board](#install-the-multi-4-in-1-board)
  13    1. [Configure the Arduino IDE](#configure-the-arduino-ide)
  14 1. [Configure the firmware](#configure-the-firmware)
  15    1. [Customize the firmware to match your hardware and your needs](#customize-the-firmware-to-match-your-hardware-and-your-needs)
  16    1. [Verify the firmware](#verify-the-firmware)
  17 1. [Compiling and uploading the firmware](#compiling-and-uploading-the-firmware)
  18    1. [Upload the firmware](#upload-the-firmware)
  19       1. [Flash from TX](#flash-from-tx)
  20 1. [Troubleshooting](#troubleshooting)
  21
  22 ## Tools required
  23 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.
  24
  25 Flashing the bootloader is outside the scope of this documentation.  Full instructions are available [here](http://openrcforums.com/forum/viewtopic.php?f=40&t=8753&sid=bbd74327cc518303e1c7f9e2ace04339#p114549).
  26
  27 ## Preparation
  28 ### Install the Arduino IDE
  29 1. Download and install the Arduino IDE. The currently supported Arduino version is 1.8.5, available for [Windows]( https://www.arduino.cc/download_handler.php?f=/arduino-1.8.5-windows.exe) and [Mac OSX](https://www.arduino.cc/download_handler.php?f=/arduino-1.8.5-macosx.zip)
  30 1. It is recommended to upgrade Java to the [latest version](https://www.java.com/en/download/)
  31
  32 ### Download the Multiprotocol source and open the project
  33 1. Either
  34    1. Download the zip file with the Multiprotocol module source code from [here](https://github.com/pascallanger/DIY-Multiprotocol-TX-Module/archive/master.zip) and unzip and copy the source code folder **Multiprotocol** to a location of your choosing, or
  35    1. Clone the project using Git or Github Desktop, then
  36 1. Double-click the **Multiprotocol.ino** file in the **Multiprotocol** folder to open the project in the Arduino IDE
  37
  38 ### Install the Multi 4-in-1 board
  39 1. Follow [these instructions](Arduino_IDE_Boards.md) to install the **Multi 4-in-1 OrangeRX Board** in the Arduino IDE
  40
  41 ### Configure the Arduino IDE
  42 1. Under **Tools -> Board** select **'Multi 4-in-1 (OrangeRX)'**
  43
  44 ## Configure the firmware
  45 ### Customize the firmware to match your hardware and your needs
  46 All customization is done by editing the ```_Config.h  ``` file in the Multiprotocol Arduino project.
  47
  48 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.
  49
  50 You can still disable protocols if you wish, and you may also enable or disable other optional Multiprotocol features.
  51
  52 ### Verify the firmware
  53 To check that the program will compile correctly and fit in the Atmega click **Sketch -> Verify/Compile**, or press **Ctrl+R**.
  54
  55 If there are no errors and you see output like this:
  56 ```
  57 Sketch uses 31874 bytes (97%) of program storage space. Maximum is 32768 bytes.
  58 Global variables use 1083 bytes (52%) of dynamic memory, leaving 965 bytes for local variables. Maximum is 2048 bytes.
  59 ```
  60 You can proceed to the next step.
  61
  62 ## Compiling and uploading the firmware
  63
  64 ### Upload the firmware
  65 You are now ready to upload the firmware to the multiprotocol module.  Uploading is done via the 'Flash-from-TX' method.
  66
  67 **Note:** 'Flash from TX' is only available with radios running ersky9x r221e2 or newer.
  68
  69 #### Flash from TX
  70 1. In the Arduino IDE click **Sketch -> Export compiled Binary**, or press **Ctrl+Alt+S**
  71 1. Locate the file named **multi-orx-[version].hex** in the **Multiprotocol** folder
  72 1. Follow the instructions [here](/docs/Flash_from_Tx.md) to upload the firmware using your radio
  73