GPS and Compass setup - iNavFlight/inav GitHub Wiki

In the 7.0 release and later. INAV only supports Ublox and Ublox7 protocols. In the 8.0 release and later INAV Ublox GPS units with Ublox Protocol version < 15.00 are deprecated and from INAV 9.0 will no longer be supported.

Recommended GNSS units are M8, M9 or M10 models for best navigation performance. While it is uncertain if there are M8 versions with Protocol version lower than 15.00, the majority of the units should be 15.00 or newer.

While older versions as M6N and M7N also work up to INAV 8.0. But later generation M8 and the newer M9/M10 versions are superior. Most GNSS modules have a built in magnetometer (compass), but there are also some available without e.g. Matek M10Q or Beitian BN-220 which are perfect for planes and flying wings.

Modules known to work reasonably well:

• Matek M10Q-5883 M10
• Beitian BE-880Q M10
• Beitian BK-880Q M9
• Beitian BN-880 M8

Note : Not all GNSS units are made equal. If you buy cheap, you are more likely to get cheap performance. Many GNSS units do not include a quality front end LNA and SAW filter. Without those components, the chances of poor performance is much greater if you have localized RF noise from a VTX or RX with telemetry.

Using default settings INAV will configure the GPS automatically, there is no need for configuring it manually using software like u-center. Nevertheless you have to configure your FC with INAV to receive the GPS signals.

For INAV before 1.9, it is also necessary to perform some manual configuration of UBLOX 3.01 firmware GPS to use Galileo satellites.

With INAV 7.0 and later, GPS, Galileo and BeiDou or Glonass can be enabled in the GPS configuration tab (the GPS constellation is enabled by default). Always enable as many constellation as your hardware will allow.

The magnetometer / compass is normally included as part of the GNSS (GPS) module. If you want to use an external magnetometer other than the one on your GNSS module, do not use both together. You can't use two identical chips/magnetometers on the same I2C bus.

If your flight controller has an internal magnetometer on the FC, using it will likely to have poor results due to magnetic interference (not recommended).

INAV 7.1 changes

From the release of INAV 7.1 the use of a compass is no longer mandatory for multirotor navigation as it once was. BUT it is still recommended for the best navigation performance, when it comes to maintaining a fixed position for an extended period of time, without heading drift. e.g. in Poshold. Or taking off and immediately starting a Waypoint mission.

• Compass-less navigation performance is heavily dependent on a clean build, that has minimal levels of Gyro/Acc noise. It will not work correctly if your multirotor is producing excessive vibrations, caused by unbalanced motors, propellers or frame resonance. Always enable the maximum number of GNSS constellations your hardware will allow. Poor EPV and EPH (Standard deviation of position error) will greatly effect navigation precision. Regardless of having a 3D fix, or what you consider an acceptable number of satellites.

If you decide to omit the use of a compass on a multirotor or VTOL platform, due to space limitations or magnetic interference that can not be overcome. Be mindful that none of the navigation modes (RTH, Failsafe, Poshold, Cruise or a Waypoint mission) will become operational until a GPS based heading is obtained. To accomplish this, start flying the copter in a straight line until -

• the OSD Home arrow appears, showing a valid home direction.
• both the OSD Heading and Course over Ground indicators show a valid heading.
• keeping both headings closely aligned for a short time.

As seen in this video

Only then can the IMU heading data be trusted for fixed position or slow speed navigation. Do not omit any of the above steps or your multirotor can experience toilet bowling, just as surely as it would with a poorly setup compass. Also conduct some tests to be sure everything is working correctly when you first setup a multirotor without a compass, just as you would with a compass.

• Note : Presently multirotor navigation flight modes (RTH, POSHOLD etc) are required to be set before the magnetometer is turned off in the Configuration tab. Otherwise the navigation modes will not appear in the modes tab. You can select magnetometer type FAKE if no device is installed. Then proceed to alter your navigation modes. Once done, set Magnetometer type back to NONE for compass-less navigation. This will be fixed in 7.1.1.. The same will apply if your flight controller doesn't have a barometer. In this case you will be required to enter inav_use_gps_no_baro = ON in the CLI, and select Barometer type FAKE. Then you can alter the navigation modes. Once done, set the barometer type back to NONE. Be aware. If you don't use a barometer as well as a magnetometer. And your satellite HDOP is greater than 1.3, the copters altitude and position accuracy will be greatly reduced.

INAV 7.1 will also offer better compass interference rejection. But this is not an excuse to be tardy on your install, or shortcut the calibration process.

INAV 7.1 and later will also benefit fixed-wing models by the use of a compass, in providing better heading estimation. While in previous releases a compass provided no extra benefit.

INAV GPS Configuration

INAV will attempt to provide GPS configuration. This is controlled by a number of CLI settings

• gps_auto_config
• gps_auto_baud

INAV only requires a few UBLOX messages and it is recommended that you leave auto-config enabled to ensure the GPS is configured to INAV's requirements.

In particular, if you enable messages that INAV does not require, it is possible to seriously downgrade or even disable GPS functionality. This is typically indicated by a high error count being reported. In this case, it is recommended that you use "u-center" to reset the GPS to factory settings and let INAV perform auto-configuration.

INAV runtime Configuration steps

When the GPS port is enabled, INAV will:

• Auto-baud if set, to the limit set by gps_auto_baud_max_supported. Do not set this too high on older models
• Disable "standard" NMEA periodic sentences
• Set UBLOX parameters
• Enable the required UBLOX periodic messages

Note that GPS is a push protocol; if your GPS has pre-configured messages enabled for transmission, then they will be sent; it is not practical for INAV to disable the whole of the large UBLOX message catalogue. If in doubt, perform a factory reset.

INAV Required Messages

INAV will enable UBLOX periodic messages according to the UBLOX version:

Class	Id	Usage	UBLOX Versions	INAV Version
0x01	0x02	UBX-NAV-POSLLH Geodetic Position Solution	5,6	< 9.0.0
0x01	0x03	UBX-NAV-STATUS Receiver Navigation status	5,6	< 9.0.0
0x01	0x12	UBX-NAV-VELNED Velocity Solution in NED	5,6	< 9.0.0
0x01	0x21	UBX-NAV-TIMEUTC GPS Time Solution	5,6	< 9.0.0
0x01	0x35	UBX-NAV-SAT Sattelite Infrmation	5,6,7	< 9.0.0
0x01	0x35	UBX-NAV-SAT Sattelite Infrmation	8
0x01	0x42	UBX-NAV-SIG Signal Information	9,10	>= 8.0.0
0x01	0x07	UBX-NAV-PVT Navigation Position Velocity Time Solution	7,8,9,10

As of July 2024 / INAV 8.0.0-dev.

Installing the GNSS unit - Antenna orientation

Ensure the ceramic antenna (light brown or beige in color) faces skywards. To provide the strongest signal and best hemispherical satellite coverage.

• Important : Be sure your GNSS module is mounted a minimum of 5cm away from any source of Radio Frequency or (Electro) Magnetic interference. e.g. A digital or analog video transmitter and its antenna. A radio receiver that has telemetry and its antenna. Or for the sake of the magnetometer, any source of magnetic fields. High current power wires, Motors or a Beeper.

Setting up the compass alignment

INAV's default Orientation Preset is CW270FLIP. This value is based on the orientation of the magnetometer chip on its PCB, chosen by the manufacturer. With respect to the Arrow direction they provide facing the front of the aircraft. Or the plug facing the rear of the aircraft.

• Circled in Red at the base of the GNSS unit. Is the QMC5883 magnetometer chip with its white DOT providing an axis magnetic bearing reference based on the internal coils.

• Circled in Orange is the orientation arrow showing the direction the compass should ideally be mounted, with that arrow facing the front of the model, and its direction of travel. Along with the Flight controllers arrow facing forward as well.

However, there are many manufactures that have released GNSS/compass modules onto the market without any thought of adding an orientation arrow to assist installation. In this case you maybe required to work out the orientation preset required for your hardware based on the magnetometer chips position, on your specific installation. This chart is a reference to help gauge the hardware Orientation Preset of your magnetometer, based on the chips Clockwise rotation. And the power plug being a reference marker for the rear, if no forward arrow is provided. The Orientation Preset must first be established, based on the hardware reference marker, before making any alignment changes with the align_mag_pitch, align_mag_roll, align_mag_yaw settings in the CLI or alignment tool sliders.

You may use the Alignment Tool in the configurator, for basic compass/flight controller orientations until after 7.1. But in future releases the alignment tool will cover more extensive hardware alignment. Alternatively, you may instead choose the impercial method, outlined below.

The image below is an example of a module that does not use the default orientation preset, nor has a mounting direction arrow from factory. The orange orientation arrow has been added to the image below to assist your installation if you have this unit. Its Orientation preset is CW180FLIP with the plug facing to the rear of the model. Beitian made the first GPS modules that included a compass for hobby use, back in 2014. And this is how we ended up the confusing default orientation preset of CW270 (flip)

NOTE : The compass must work in conjunction with the Flight controllers IMU. If you invert the flight controller or rotate it on the Yaw axis, this will effect the compass alignment settings. Before attempting to use any navigation modes, you should verify that the compass alignment is working in unity with the flight controllers alignment. By using the Configurator SETUP/STATUS Tab, and moving the model on all axis's with your hand, to ensure the graphical model moves identically to your motions, without any axis drift. So be mindful of the complexity involved in getting the correct orientation settings if you do deciding to mount the flight controller or GNSS/compass unit on an axis different from the manufacturer recommendation arrow.

Compass calibration and testing

The general rule behind compass calibration is to ensure the magnetometer reports the earths magnetic field strength equally on all axis's, regardless of weak localized magnetic perturbations. Therefore calibration of the compass should be done in the aircraft.

Ideally, its not good enough to rotate the compass or aircraft, so that each axis faces skyward or towards the ground. Because this can leave areas where complete calibration is missed. Which will provide poor results and navigation performance.

To acquire the best 3 axis calibration results, your arm and wrist should move the aircraft in a figure 8 or infinity ∞ symbol motion in the air, while ensuring every axis faces skywards in the process. Do this several times (not too quickly) within the allotted 30secs.

• Use a long USB extension lead if its done via connection to the configurator.

The end result should be the maggain_x maggain_y maggain_z calibrated settings should not be greater that 100 points of each other, and as close to 1500 as possible. While magzero_x magzero_y magzero_z can vary. But should never exceed +- 1000 on any axis. Any dramatic difference indicates a poor calibration. Or too much localized magnetic or electromagnetic interference. Note: A good calibration may take several attempts. So use the above information as a reference if you attempt to obtain a more precise calibration.

• Perform any tests away of sources of magnetic interference. Domestic appliances or even audio speakers can cause erroneous affects. Computer monitors may also interfere.
• Use an analogue compass in preference to a digital (mobile phone) compass. The compass in your phone is likely to be a similar chip to that on your aircraft, and is as susceptible to the same errors of interference and calibration
• Alternatively, if you know the orientation of surrounding landmarks (e.g. my house is pretty much N/S), then you can do static tests against land orientation.

Check your machine at cardinal points (North (0°), East (90°), South (180°), West (270°)). Degree perfect alignment is not necessary (and probably not measurable), but you should aim for +/- 5° of known magnetic direction.

• If the values are incorrect by a multiple of 90°, then the numeric alignment needs to be changed

• If the values are just randomly wrong across the cardinal points, then FLIP is probably wrong (as well).

• If external Compass module is mounted at 30 degree. For example at top of a Cam mount, free alignment is possible by Cli commands. Cli setting Align_mag must be set to Align_mag = default save

For example CW270flip, this value is to ADD manually. For free Alignment, all three axis need to set manually. A sensor flip is always to realize over the pitch axis. For example cw270flip:

set align_mag_pitch = 1800
set align_mag_roll = 0
set align_mag_yaw = 2700
save

• For 30 Degree Backwards tilted GPS/Compass Module, reduce align_mag_roll about 300

  set align_mag_roll = -300 save

• Because Magnetometer with CW270° has its roll axis in relation to the Pitch Axis of the FC

The terminology of the setting FLIP. Is based on the magnetometer chip being upside down, on the under side of the GNSS unit. If the chip could be mounted with it top facing the sky. FLIP would not be required. The only other exception is if your Flight Controller is mounted inverted in you model. Because the Compass and FC work together to provide the correct heading. FLIP is not required in that case.

Enhanced Explanation in #6232 How to Align and Check if your readings are Correct

Painless360 has done a video on this: (https://www.youtube.com/watch?v=kVVJ-DjUjsc)

There is an Alignment Tool built into the INAV configurator for INAV 5.0 and later.

Emperical Method of Determining Compass Alignment

Rather than using the alignment tool, it is sometimes easier to instead test the actual readings you are getting from your compass. The following procedure can be used.

If the compass is tilted at an odd angle, use a piece of tape or similar to temporarily hold it flat.

First ensure the FC alignment is correct. In the Setup tab it must move the correct direction in all three axis.

Point the aircraft north. Look at the heading in the Setup tab. Quickly turn the aircraft 90°, so it points east, and set it down. Watch the heading reading over the next five seconds. Does it remain stable, or does it slowly change, by more than 10°?

If the heading slowly catches up over a few seconds, the compass alignment is upside-down. If it remains stable, it's right-side up. If needed, add/subtract 180° to the roll to flip it.

Now that it's right-side up, we need to set which way is front by adjusting the yaw. Adjust the yaw in 90° increments so that the heading reads about 0°/360° when the aircraft is pointed north.

Confirm east, south, and west also read correctly. Save and reboot.

If you 3D-printed a mount to put the magnetometer at a weird angle, adjust for that now in the alignment tool.

That's it, you're done!

• If you have a tiny whoop board with the 45° angle mounting, you may need to adjust yaw in 45° increments.

Initial flight tests

Once you're content that the static configuration of the compass is correct, it's time to go flying. There is still no guarantee that the machine will not generate interference, so it's advisable to do some controlled testing before attempting more advanced navigation modes:

• In a clear space (no trees!) attempt a simple line of sight POSHOLD. If the craft fails to hold (toilet bowling, or ever increasing circles (in range and speed)), be prepared to disengage PH and take manual control.

To confirm magnetic interference, blackbox logging is most useful:

• Fly at a reasonable speed (> 5m/s) in straight lines, as close as possible to a 90° crossing paths, or a square / rectangular pattern.

• The blackbox can be analysed to compare the course over the ground (from GPS) with the compass readings (GPS_ground_course v. attitude[2]/10). Run blackbox_decode with the --merge-gps option to get GPS fields in the log.

• If you need help doing this, post the log in the INAV RC Groups forum (or Discord / Telegram channel) and ask for help. There are a number of users familiar with this type of analysis who can assist.

• It is necessary to fly at a reasonable speed in order to get useful GPS data. Just hovering is not useful as the GPS cannot detect direction without movement.

• If you use mwp as a ground station with telemetry, then mwp logs can also provide useful analysis, but blackbox is preferred, as there is more data and it is also possible to analyse throttle affects.

Only when you're content that the compass reads correctly for all throttle settings and directions should you progress to more advanced navigation feature (way points, return to home). The majority of navigation failures are due to poorly performing compasses.

Getting started with Ublox GPS

• Physically connect your GPS to your FC using UART (preferred) or softserial (not recommended). Connect RX from GPS to TX on FC, TX from GPS to RX on FC

• Activate GPS in the ports tab in INAV configurator and set it to 57600, 115200 using UART. Or 19200 using softserial (on your chosen port)

• The baud rate can be set to 230400 when using an M10 device. Which can be beneficial. BUT higher baud rates are also susceptible to interference if the GNSS UART leads run close to a source of RF/EM interference. If you choose to use a higher baud rate, be sure to twist the TX/RX/5v/G leads together. Especially if the cable length between the GNSS module and FC is more than 5cm or so.

• Activate GPS in the configuration tab, set it to Ublox7.

• Using external compass:

• Connect the magnetometer to I2C ports (SCL/SDA) Be aware that with SDA/SLC lines connected the flight battery must often be connected to access configurator and power up the magnetometer.

• Select your newly connected magnetometer by using mag_hardware CLI command. Example set mag_hardware = auto if you only have one magnetometer connected.

• Most built in magnetometers are on the underside and rotated 180 degrees, use example set align_mag = CW180FLIP. If compass is not working properly in all directions then either think and figure out the direction of your mag, or go through them all until it works as expected.

• INAV does provide an automatic declination setting, based on GNSS coordinates, which is enabled by default inav_auto_mag_decl = ON. But if you want to change magnetic declination manually set inav_auto_mag_decl = OFF. You have to set correct declination of your specific location, which can be found here: www.magnetic-declination.com. If your magnetic declination readings are e.g. +3° 34' , the value entered in the INAV configurator is 3.34 (3,34 in some locales). In the CLI, the same effect would be set mag_declination = 334. For west declination, use a minus value, e.g. for 1° 32' W, set mag_declination = -132. In all cases (both CLI and GUI), the least significant digits are minutes, not decimal degrees.

• Calibrate your compass according to compass calibration

Some FC boards may not provide 4.5V power on USB supply. In order to power the GPS it is necessary to connect the battery or use another power source (a 4.5V source may be powered by USB). The onboard 3.3V will be powered by USB, but may not provide adequate voltage, as the GPS regulator typically requires 3.6V minimum.

Once you have connected the GPS to your flight control board

• Open the INAV Configurator
• Enable GPS on your desired UART port
• Set the baud rate
• Press "Save & Reboot"
• Then go to the "Configuration" tab in the INAV Configurator
• Enable GPS
• Set the "Protocol" to UBLOX7
• Set the "Ground Assistance Type" to "Auto Detect"
• set MAG Alignment to CW270FLIP
• Press "Set & Reboot" You can confirm the GPS unit is working by going to the GPS tab in the INAV Configurator and if it is working you will see the "Total Messages" count on the left incrementing in numbers.

GNSS Ublox update rate

INAV 7.0 and later supports a higher GNSS update rate for Ublox receivers. gps_ublox_nav_hz. With M10 (now) supporting up to 25Hz. If you wish to increase navigation precision. And you have a low noise build, good fix and with EPH/EPV data being acceptable. You may wish to alter this setting. But only do so according to the table below. Note how the maximum update rate can only be achieved with lower concurrent constellations. And a trade off will also be noticed. The satellite count will generally be a little lower, the higher the update rate. But this isn't a draw back. Because higher precision can still be achieved.

If it is the first time you have connected the GNSS unit, then it can take several minutes for a satellite fix to be obtained. This is the time required to download the Almanac and Ephemeris data. This is perfectly normal. But if it takes longer than 10 minutes. You likely have GNSS RF band interference coming from a hardware source in your model.

Note: For the GPS unit to work & pick up satellites it needs an unobstructed view to the sky (so if using indoors, don't expect any satellites to be picked up!)

• Inav since 1.5 version and newer uses default automatic magnetic declination, if your on old verion or want to change magnetic declination manually you have to set correct declination of your specific location, which can be found here: www.magnetic-declination.com. If your magnetic declination readings are e.g. +3° 34' , the value entered in the INAV configurator is 3.34 (3,34 in some locales). In the CLI, the same effect would be set mag_declination = 334. For west declination, use a minus value, e.g. for 1° 32' W, set mag_declination = -132. In all cases (both CLI and GUI), the least significant digits are minutes, not decimal degrees.
• Calibrate your compass according to compass calibration

SBAS

When using a UBLOX GPS the SBAS mode can be configured using gps_sbas_mode.

The default is AUTO.

Value	Region
AUTO	Global
EGNOS	Europe
WAAS	North America
MSAS	Asia
GAGAN	India
SOUTHPAN	Australia NZ
NONE	NONE

If you use a regional specific setting you may achieve a faster GPS lock than using AUTO, but keep in mind to change it if you change your location for holidays etc.

This setting only works when gps_auto_config= ON

AssistNow Online/Offline

INAV 8.0 adds support for AssitNow Online and AssistNow Offline GPS assistance services, which is a proprietary A-GNSS service that can reduce Time To First Fix (TTFF) but requires access to the internet to fetch data. AssistNow Online data is valid for a few hours, while AssistNow Offline data can be valid for weeks. It can be specially beneficial for new GPS units and for units without flash or battery backed ram (BBR).

In order to use the service, you have to create a thingstream account and register applications to use AssistNow Online and Offline service. The process is described here: https://developer.thingstream.io/guides/location-services/assistnow-getting-started-guide

Once you have your AssitNow service token, you need to configure INAV Configurator to use it, by clicking on the gear cog on the top right of the Configurator window.

Once INAV Configurator has your token, you can use the buttons on the bottom of the GPS tab to upload AssistNow data to your GPS unit.

AssistNow Online data requires an active internet connection, while AssistNow Offline will cache the data for 3 days, and will not need internet connection, unless the data is expired.

If you have internet access, it is recommended to use both AssistNow Online and Offline services.

Issues

Troubleshooting no GPS fix

If you aren't seeing a fix, or have a "navigation is unsafe" message, you can check the following things:

• Check if the PPS light on the GPS module is flashing once per second. You may need to put it outdoors for at least 12.5 minutes the first time. This is so it can download the almanac and ephemerides. If the PPS isn't flashing, the GPS itself doesn't have a fix - this is a separate issue from how it's connected to the FC and how INAV is configured to use it.

• In the GPS tab, check whether the "messages" count is increasing. If not, you have a communication error between the GPS and the FC - check wiring and the port setting.

• Next check if the "errors" count is increasing on the same tab. If so, you have low frequency interference or an unreliable physical connection between the FC and GPS.

• Next, does the GPS tab say you have a good fix? If so, in CLI check that inav_max_eph_epv is set to 1000, not 1.000. You can run:

set inav_max_eph_epv = 1000

save

Other issues

• X! in the OSD GPS Satellites field indicates the flight controller isn't receiving a valid data signal from the GPS.
• No GPS lock: often due to electric noise from flight controller or other equipment such as 1.2ghz video TX. Try getting the GPS as far away as possible from electric noise emitting parts as the FC, ESCs or power cables. Placing the GPS on a mast is also a common way, you can further try shielding with aluminum or copper foil. Don´t place the GPS inside the frame.
• "Toilet bowling": in the beginning the copter holds its position and then starts to make bigger and bigger circles, you probably have your magnetometer not calibrated correctly or it’s interfered from the magnetic field of your power lines or the beeper. If you are using your FC onboard mag, try to place the the FC as far away as possible from the magnetic interference causing parts e.g. mounting it on/under the top plate on small racers.
• 3.3V GPS units, such as the GPS from 3DR should not be powered by the flight controller's 3.3V pin along with a Spektrum (or other DSM) receiver. The current draw can cause the Spektrum receiver to brownout. Instead use a 3.3V regulator and power the GPS from the BEC or separate battery.