Skip to main content

INAV Configurator

Tabs Explained​

The Configurator contains a number of tabs that allow you to configure different aspects of the firmware for your use case. There are two main parts of the configurator: Home View and Configuration View.

  • Home View: Opens with the Welcome Page and consists of a small set of tabs when INAV Configurator is first opened.
  • Configuration View: Is what appears when connected to a flight controller. Here is where all the settings for a particular aircraft are made and programmed.

The tabs for each view are outlined in the tables below with brief explainations of what each tab contains.

Home View​

TabDescription
WelcomeThe home page that greets you to INAV
Documentation & SupportLinks to the official docs website
Mission ControlAllows for the creation of waypoint missions
Firmware FlasherFlash firmware onto a flight controller
SITLSoftware In The Loop mode for simulating an INAV device

Configuration View​

Detailed explainations are found in the linked section in the Modules section.

TabDescriptionApplicable Modules
StatusDisplays a 3D model of hte vehicle that reacts to changes in the FC's orientation. The columns on the left show sensor, battery, and GNSS/GPS information
CalibrationWhere accelerometer, compass, and optical flow/rangefinder sensors are calibrated. This is mandatory for setup.
MixerSet mixer rules to determine how servos and motors react to user and FC inputs.
Outputs
Ports
Configuration
Failsafe
Tuning
Advanced Tuning
Programming
Receiver
Modes
Adjustements
GPS
Alignment Tool
Mission Control
OSDSet how flight data is overlayed the video stream
LED StripConfigure user addressable LED strips such as the WS2811 and WS2812
SensorsView real time data captured from connected sensors
Tethered Logging
BlackboxSet what FC parameters to record
CLICommand line interface for modifying INAV's parametersCLI
Search

Different map providers​

INAV Configurator 2.1 allows you to choose between OpenStreetMap, Bing Maps (Aerial View), and MapProxy map providers. INAV Configurator is shipped WITHOUT API key for Bing Maps. That means: every user who wants to use Bing Maps has to create their own account, agree to all Terms and Conditions required by Bing Maps, and configure INAV Configurator by himself.

How to choose a Map provider​

  1. Click Settings icon in the top-right corner of INAV Configurator
  2. Choose a provider: OpenStreetMap, Bing, or MapProxy
  3. In the case of Bing Maps, you have to provide your own, personal, generated by you, Bing Maps API key
  4. For MapProxy, you need to provide a server URL and layer name to be used

How to get the Bing Maps API key​

On May 21, 2024 Microsoft announced that Bing Maps for Enterprise is deprecated and will be retired. Starting from that date new users are unable to get api keys in Bing Maps Dev Center.

Enterprise account customers can continue to use Bing Maps for Enterprise services until June 30th, 2028.

Free (Basic) account customers can continue to use Bing Maps for Enterprise services until June 30th, 2025.

  1. Go to the Bing Maps Dev Center at https://www.bingmapsportal.com/.
    • If you have a Bing Maps account, sign in with the Microsoft account that you used to create the account or create a new one. For new accounts, follow the instructions in Creating a Bing Maps Account.
  2. Select My keys under My Account.
  3. Select the option to create a new key.
  4. Provide the following information to create a key:
    1. Application name: Required. The name of the application.
    2. Application URL: The URL of the application. This is an optional field that is useful in helping you remember the purpose of that key in the future.
    3. Key type: Required. Select the key type that you want to create. You can find descriptions of key and application types here.
    4. Application type: Required. Select the application type that best represents the application that will use this key. You can find descriptions of key and application types here.
  5. Click the Create button. The new key is displayed in the list of available keys. Use this key to authenticate your Bing Maps application as described in the documentation for the Bing Maps API you are using.

How to set up a MapProxy server for offline caching and mission planning​

  1. Follow the process described in MAPPROXY.md
  2. Test your MapProxy server in a web browser, eg: http://192.168.145.20/inavmapproxy/
  3. Once you have a working MapProxy server choose MapProxy as your map provider
    1. Enter MapProxy service URL, eg: http://192.168.145.20/inavmapproxy/service?
    2. Enter MapProxy service layer (inav_layer if configured from MAPPROXY.md)
  4. Once completed, you can zoom in on the area you will be flying in while connected to the internet in either the GPS or Mission Control tab to save the cache for offline use

Font Customisation​

INAV provides the font images so that custom fonts can be created for your personal preference. This is the case for both analogue and digital fonts. The resources can be found in the OSD folder. Within the analogue and digital subfolders, you will find information on compiling your own fonts. There is also an inav character map document. This contains previews of all the character images in the fonts and the appropriate variable names within the firmware and Configurator. There are tools for compiling the analogue and digital fonts. New font submissions via pull requests are welcome.

Notes​

WebGL​

Make sure Settings -> System -> "User hardware acceleration when available" is checked to achieve the best performance

Issue trackers​

For INAV configurator issues raise them here

https://github.com/iNavFlight/inav-configurator/issues

For INAV firmware issues, raise them here

https://github.com/iNavFlight/inav/issues

Developers​

We accept clean and reasonable patches, submit them!