Use uint32_t in sortSerialTxBytesFree when calculating the bytes used.
[inav.git] / docs / Installation.md
blob38e9470fd81dc6b26965f8407deca3d3708f7258
1 # Installation
3 ## Using the configurator
4 This is a generic procedure to flash a board using the configurator. The configurator does not yet support all boards, so please check the documentation corresponding to your board before proceeding.
6 Make sure you have the [INAV Configurator](https://github.com/iNavFlight/inav-configurator) installed, then:
8 * Connect the flight controller to the PC.
9 * Start the INAV Configurator.
10 * Click on "Disconnect" if the configurator connected to the board automatically.
11 * Click on the "Firmware Flasher" tab.
12 * Make sure you have internet connectivity and click on the "Load Firmware [Online]" button.
13 * Click on the "Choose a Firmware / Board" dropdown menu, and select the latest stable version for your flight controller.
14 * IMPORTANT: Read and understand the release notes that are displayed.  When upgrading review all release notes since your current firmware.
15 * If this is the first time INAV is flashed to the board, tick the "Full Chip Erase" checkbox.
16 * Connect the flight controller board to the PC.  Ensure the correct serial port is selected.
17 * Click on the "Flash Firmware" button and hold still (do not breathe, too).
18 * When the progress bar becomes green and reads "Programming: SUCCESSFUL" you are done!
20 ## Manually
22 See the board specific flashing instructions.
24 # Upgrading
26 When upgrading be sure to backup / dump your existing settings.  Some firmware releases are not backwards compatible and default settings are restored when the FC detects an out of date configuration.
28 ## Backup/Restore process
30 See the CLI section of the docs for details on how to backup and restore your configuration via the CLI.