Magnetometer (Compass) Hardware & Setup
PX4 uses a magnetometer (compass) for determining the yaw and heading of the vehicle relative to the earth's magnetic field.
Pixhawk series flight controllers, and many others, include an internal compass. On small vehicles the performance of the internal compass is almost always poor, because the flight controller has to be mounted close to motor/ESC power lines and other sources of electromagnetic interference. The internal compass may be useful on larger vehicles (e.g. VTOL) where it is possible to reduce electromagnetic interference by mounting the flight controller a long way from power supply lines.
On most vehicles, and in particular on small vehicles, we recommend using a combined GPS + Compass mounted as far away from the motor/ESC power supply lines as possible - typically on a pedestal or wing (for fixed-wing). While you can use a stand-alone external compass (as listed below) it is far more common to use a combined GPS/Compass module.
Magnetometers support connection to either the I2C/SPI-bus (Pixhawk GPS1 or GPS2 ports) or to the CAN bus. If a module doesn't include "CAN" in its product name then it is probably an I2C/SPI compass.
Up to 4 internal or external magnetometers can be connected, though only one will actually be used as a heading source. The system automatically chooses the best available compass based on their priority (external magnetometers have a higher priority than internal magnetometers). If the primary compass fails in-flight, it will failover to the next one. If it fails before flight, arming will be denied.
Supported Compasses
Compass Parts
PX4 can be used with many magnetometer parts, including: Bosch BMM 150 MEMS (via I2C bus), HMC5883 / HMC5983 (I2C or SPI), IST8310 (I2C), LIS3MDL (I2C or SPI), RM3100, and more. Other supported magnetometer parts and their busses can be inferred from the drivers listed in Modules Reference: Magnetometer (Driver).
These parts are included in stand alone compass modules, combined compass/GNSS modules, and also in many flight controllers,
Combined GNSS/Compass Modules
See Global Navigation Satellite Systems (GNSS) for a list of appropriate modules.
INFO
If GNSS is required, then a combined GNSS/Compass module will be preferred over the stand-alone modules below.
Stand-Alone Compass Modules
This list contains stand-alone magnetometer modules (without GNSS).
| Device | Compass | DroneCan |
|---|---|---|
| Avionics Anonymous UAVCAN Magnetometer | ? | |
| Holybro DroneCAN RM3100 Compass/Magnetometer | RM3100 | ✓ |
| RaccoonLab DroneCAN/Cyphal Magnetometer RM3100 | RM3100 | ✓ |
Note:
- ✓ or a specific part number indicate that a features is supported, while ✗ or empty show that the feature is not supported. "?" indicates "unknown".
- A compass that is not "DroneCAN" can be assumed to be SPI or I2C.
Mounting
Mounting the Compass explains how to mount a compass or GPS/Compass module.
I2C/SPI Compass Setup
On Pixhawk Series flight controllers you can connect to either the GPS1 or GPS2 ports (which have pins for I2C/SPI). No further configuration is required.
CAN Compass Setup
DroneCAN covers the setup for DroneCAN peripherals, including compasses.
You will need to connect the compass to the CAN bus, enable DroneCAN, and specifically enable magnetometers (search for UAVCAN_SUB_MAG).
Calibration
Compass Calibration explains how to calibrate all compasses on the vehicle.
The process is straightforward and will autodetect, set default rotations, calibrate, and prioritise, all connected magnetometers.