GPS parameters¶
30 parameters in the GPS family. ArduCopter 4.7 only — other vehicles share many of these names but not always the same ranges or meanings.
GPS_AUTO_CONFIG¶
Automatic GPS configuration
Controls if the autopilot should automatically configure the GPS based on the parameters and default settings
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
Disables automatic configuration |
|
Enable automatic configuration for Serial GPSes only |
|
Enable automatic configuration for DroneCAN as well |
|
Clear all configurations not set by ardupilot (UBlox only) |
GPS_AUTO_SWITCH¶
Automatic Switchover Setting
Automatic switchover to GPS reporting best lock, 1:UseBest selects the GPS with highest status, if both are equal the GPS with highest satellite count is used 4:Use primary if 3D fix or better, will revert to ‘UseBest’ behaviour if 3D fix is lost on primary
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
Use primary |
|
UseBest |
|
Blend |
|
Use primary if 3D fix or better |
GPS_BLEND_MASK¶
Multi GPS Blending Mask
Determines which of the accuracy measures Horizontal position, Vertical Position and Speed are used to calculate the weighting on each GPS receiver when soft switching has been selected by setting GPS_AUTO_SWITCH to 2(Blend)
User level |
Advanced |
Bitmask¶
Value |
Meaning |
|---|---|
|
Horiz Pos |
|
Vert Pos |
|
Speed |
GPS_CAN_NODEID1¶
GPS Node ID 1
GPS Node id for first-discovered GPS.Renamed in 4.6 and later to GPS1_CAN_NODEID.
Read only |
Yes |
User level |
Advanced |
GPS_CAN_NODEID2¶
GPS Node ID 2
GPS Node id for second-discovered GPS.Renamed in 4.6 and later to GPS2_CAN_NODEID.
Read only |
Yes |
User level |
Advanced |
GPS_COM_PORT¶
GPS physical COM port
The physical COM port on the connected device, currently only applies to SBF and GSOF GPS,Renamed in 4.6 and later to GPS1_COM_PORT.
Range |
|
Increment |
|
Reboot required |
Yes — the change takes effect after a reboot. |
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
COM1(RS232) on GSOF |
|
COM2(TTL) on GSOF |
GPS_COM_PORT2¶
GPS physical COM port
The physical COM port on the connected device, currently only applies to SBF and GSOF GPS.Renamed in 4.6 and later to GPS1_COM_PORT.
Range |
|
Increment |
|
Reboot required |
Yes — the change takes effect after a reboot. |
User level |
Advanced |
GPS_DELAY_MS¶
GPS delay in milliseconds
Controls the amount of GPS measurement delay that the autopilot compensates for. Set to zero to use the default delay for the detected GPS type.Renamed in 4.6 and later to GPS1_DELAY_MS.
Units |
|
Range |
|
Reboot required |
Yes — the change takes effect after a reboot. |
User level |
Advanced |
GPS_DELAY_MS2¶
GPS 2 delay in milliseconds
Controls the amount of GPS measurement delay that the autopilot compensates for. Set to zero to use the default delay for the detected GPS type.Renamed in 4.6 and later to GPS2_DELAY_MS.
Units |
|
Range |
|
Reboot required |
Yes — the change takes effect after a reboot. |
User level |
Advanced |
GPS_DRV_OPTIONS¶
driver options
Additional backend specific options
User level |
Advanced |
Bitmask¶
Value |
Meaning |
|---|---|
|
Use UART2 for moving baseline on ublox |
|
Use base station for GPS yaw on SBF |
|
Use baudrate 115200 on ublox |
|
Use dedicated CAN port b/w GPSes for moving baseline |
|
Use ellipsoid height instead of AMSL |
|
Override GPS satellite health of L5 band from L1 health |
|
Enable RTCM full parse even for a single channel |
|
Disable automatic full RTCM parsing when RTCM seen on more than one channel |
|
Force UBlox Config Get/Set for configuration then automatic configuration for Serial GPSes only |
GPS_GNSS_MODE¶
GNSS system configuration
Bitmask for what GNSS system to use on the first GPS (all unchecked or zero to leave GPS as configured).Renamed in 4.6 and later to GPS1_GNSS_MODE.
User level |
Advanced |
Bitmask¶
Value |
Meaning |
|---|---|
|
GPS |
|
SBAS |
|
Galileo |
|
Beidou |
|
IMES |
|
QZSS |
|
GLONASS |
GPS_GNSS_MODE2¶
GNSS system configuration.
Bitmask for what GNSS system to use on the second GPS (all unchecked or zero to leave GPS as configured). Renamed in 4.6 and later to GPS2_GNSS_MODE
User level |
Advanced |
Bitmask¶
Value |
Meaning |
|---|---|
|
GPS |
|
SBAS |
|
Galileo |
|
Beidou |
|
IMES |
|
QZSS |
|
GLONASS |
GPS_INJECT_TO¶
Destination for GPS_INJECT_DATA MAVLink packets
The GGS can send raw serial packets to inject data to multiple GPSes.
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
send to first GPS |
|
send to 2nd GPS |
|
send to all |
GPS_MIN_ELEV¶
Minimum elevation
This sets the minimum elevation of satellites above the horizon for them to be used for navigation. Setting this to -100 leaves the minimum elevation set to the GPS modules default.
Units |
|
Range |
|
User level |
Advanced |
GPS_POS1_X¶
Antenna X position offset
X position of the first GPS antenna in body frame. Positive X is forward of the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS1_POS_X.
Units |
|
Range |
|
Increment |
|
User level |
Advanced |
GPS_POS1_Y¶
Antenna Y position offset
Y position of the first GPS antenna in body frame. Positive Y is to the right of the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS1_POS_Y.
Units |
|
Range |
|
Increment |
|
User level |
Advanced |
GPS_POS1_Z¶
Antenna Z position offset
Z position of the first GPS antenna in body frame. Positive Z is down from the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS1_POS_Z.
Units |
|
Range |
|
Increment |
|
User level |
Advanced |
GPS_POS2_X¶
Antenna X position offset
X position of the second GPS antenna in body frame. Positive X is forward of the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS2_POS_X.
Units |
|
Range |
|
Increment |
|
User level |
Advanced |
GPS_POS2_Y¶
Antenna Y position offset
Y position of the second GPS antenna in body frame. Positive Y is to the right of the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS2_POS_Y.
Units |
|
Range |
|
Increment |
|
User level |
Advanced |
GPS_POS2_Z¶
Antenna Z position offset
Z position of the second GPS antenna in body frame. Positive Z is down from the origin. Use antenna phase centroid location if provided by the manufacturer.Renamed in 4.6 and later to GPS2_POS_Z.
Units |
|
Range |
|
Increment |
|
User level |
Advanced |
GPS_PRIMARY¶
Primary GPS
This GPS will be used when GPS_AUTO_SWITCH is 0 and used preferentially with GPS_AUTO_SWITCH = 4.
Increment |
|
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
FirstGPS |
|
SecondGPS |
GPS_RATE_MS¶
GPS update rate in milliseconds
Controls how often the GPS should provide a position update. Lowering below 5Hz(default) is not allowed. Raising the rate above 5Hz usually provides little benefit and for some GPS (eg Ublox M9N) can severely impact performance.Renamed in 4.6 and later to GPS1_RATE_MS
Units |
|
Range |
|
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
10Hz |
|
8Hz |
|
5Hz |
GPS_RATE_MS2¶
GPS 2 update rate in milliseconds
Controls how often the GPS should provide a position update. Lowering below 5Hz(default) is not allowed. Raising the rate above 5Hz usually provides little benefit and for some GPS (eg Ublox M9N) can severely impact performance.Renamed in 4.6 and later to GPS2_RATE_MS
Units |
|
Range |
|
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
10Hz |
|
8Hz |
|
5Hz |
GPS_RAW_DATA¶
Raw data logging
Handles logging raw data; on uBlox chips that support raw data this will log RXM messages into logger; on Septentrio this will log on the equipment’s SD card and when set to 2, the autopilot will try to stop logging after disarming and restart after arming
Reboot required |
Yes — the change takes effect after a reboot. |
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
Ignore |
|
Always log |
|
Stop logging when disarmed (SBF only) |
|
Only log every five samples (uBlox only) |
GPS_SAVE_CFG¶
Save GPS configuration
Determines whether the configuration for this GPS should be written to non-volatile memory on the GPS. Currently working for UBlox 6 series and above.
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
Do not save config |
|
Save config |
|
Save only when needed |
GPS_SBAS_MODE¶
SBAS Mode
This sets the SBAS (satellite based augmentation system) mode if available on this GPS. If set to 2 then the SBAS mode is not changed in the GPS. Otherwise the GPS will be reconfigured to enable/disable SBAS. Disabling SBAS may be worthwhile in some parts of the world where an SBAS signal is available but the baseline is too long to be useful.
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
Disabled |
|
Enabled |
|
NoChange |
GPS_SBP_LOGMASK¶
Swift Binary Protocol Logging Mask
Masked with the SBP msg_type field to determine whether SBR1/SBR2 data is logged
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
External only (0xFF00) |
|
All (0xFFFF) |
|
None (0x0000) |
GPS_TYPE¶
1st GPS type
GPS type of 1st GPS.Renamed in 4.6 and later to GPS1_TYPE
Reboot required |
Yes — the change takes effect after a reboot. |
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
None |
|
AUTO |
|
uBlox |
|
NMEA |
|
SiRF |
|
HIL |
|
SwiftNav |
|
DroneCAN |
|
SBF |
|
GSOF |
|
ERB |
|
MAV |
|
NOVA |
|
HemisphereNMEA |
|
uBlox-MovingBaseline-Base |
|
uBlox-MovingBaseline-Rover |
|
MSP |
|
AllyStar |
|
ExternalAHRS |
|
DroneCAN-MovingBaseline-Base |
|
DroneCAN-MovingBaseline-Rover |
|
UnicoreNMEA |
|
UnicoreMovingBaselineNMEA |
|
SBF-DualAntenna |
GPS_TYPE2¶
2nd GPS type.Renamed in 4.6 to GPS2_TYPE
GPS type of 2nd GPS
Reboot required |
Yes — the change takes effect after a reboot. |
User level |
Advanced |
Values¶
Value |
Meaning |
|---|---|
|
None |
|
AUTO |
|
uBlox |
|
NMEA |
|
SiRF |
|
HIL |
|
SwiftNav |
|
DroneCAN |
|
SBF |
|
GSOF |
|
ERB |
|
MAV |
|
NOVA |
|
HemisphereNMEA |
|
uBlox-MovingBaseline-Base |
|
uBlox-MovingBaseline-Rover |
|
MSP |
|
AllyStar |
|
ExternalAHRS |
|
DroneCAN-MovingBaseline-Base |
|
DroneCAN-MovingBaseline-Rover |
|
UnicoreNMEA |
|
UnicoreMovingBaselineNMEA |
|
SBF-DualAntenna |