Files
PX4-Autopilot/docs/en/msg_docs/VehicleGnss.md
T
2026-11-17 09:46:03 +00:00

118 lines
11 KiB
Markdown

---
pageClass: is-wide-page
---
# VehicleGnss (UORB message)
Selected GNSS solution.
Published by the sensors module for every sample of the selected receiver, usable or not, with the selection state and the check result for that sample.
Heading is on vehicle_gnss_heading.
**TOPICS:** vehicle_gnss
## Fields
| Name | Type | Unit [Frame] | Range/Enum | Description |
| ----------------------------------------------------------- | ------------ | ------------ | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="fld_timestamp"></a>timestamp | `uint64` | us | | Time since system start |
| <a id="fld_timestamp_sample"></a>timestamp_sample | `uint64` | us | | Measurement time, delay corrected. Use this rather than receiver.timestamp_sample, which holds the same value |
| <a id="fld_receiver"></a>receiver | `SensorGnss` | | | The selected receiver's sensor_gnss sample with the corrected timestamp_sample |
| <a id="fld_antenna_offset"></a>antenna_offset | `float32[3]` | m [FRD] | | Antenna position of the selected receiver |
| <a id="fld_selected_instance"></a>selected_instance | `uint8` | | | sensor_gnss instance of the selected receiver |
| <a id="fld_selection_count"></a>selection_count | `uint8` | | | Increments when the selected receiver changes |
| <a id="fld_selection_reason"></a>selection_reason | `uint8` | | [SELECTION](#SELECTION) | Why this receiver is selected |
| <a id="fld_usable"></a>usable | `bool` | | | Sample may be used: the checks that decide it have passed without a failure for long enough |
| <a id="fld_strict"></a>strict | `bool` | | | The strict checks decide usable: they haven't passed since the vehicle was disarmed on the ground, or they pass. Otherwise the relaxed checks decide |
| <a id="fld_failed_strict_checks"></a>failed_strict_checks | `uint16` | | [CHECK](#CHECK) | Enabled checks this sample fails at the strict thresholds, evaluated on every sample |
| <a id="fld_failed_relaxed_checks"></a>failed_relaxed_checks | `uint16` | | [CHECK](#CHECK) | Enabled checks this sample fails at the relaxed thresholds, evaluated on every sample |
## Enums
### SELECTION {#SELECTION}
Used in field(s): [selection_reason](#fld_selection_reason)
| Name | Type | Value | Description |
| ----------------------------------------------------- | ------- | ----- | -------------------------------------------------------------------------------------------------------------------- |
| <a id="#SELECTION_PREFERRED"></a> SELECTION_PREFERRED | `uint8` | 0 | The preferred receiver |
| <a id="#SELECTION_ONLY"></a> SELECTION_ONLY | `uint8` | 1 | No other receiver has published |
| <a id="#SELECTION_RANKED"></a> SELECTION_RANKED | `uint8` | 2 | No receiver is preferred, and no other one ranks higher |
| <a id="#SELECTION_TIMEOUT"></a> SELECTION_TIMEOUT | `uint8` | 3 | The previously selected or the preferred receiver stopped publishing |
| <a id="#SELECTION_UNHEALTHY"></a> SELECTION_UNHEALTHY | `uint8` | 4 | The previously selected or the preferred receiver failed its checks or delivered samples late, continuously or often |
| <a id="#SELECTION_STRICT"></a> SELECTION_STRICT | `uint8` | 5 | Passes the strict checks, which the previously selected receiver didn't |
| <a id="#SELECTION_RTK_FIXED"></a> SELECTION_RTK_FIXED | `uint8` | 6 | Passes the strict checks with an RTK fixed solution, and the previously selected receiver ranked lower |
### CHECK {#CHECK}
Used in field(s): [failed_strict_checks](#fld_failed_strict_checks), [failed_relaxed_checks](#fld_failed_relaxed_checks)
| Name | Type | Value | Description |
| ----------------------------------------- | -------- | ----- | ----------------------------------------------------- |
| <a id="#CHECK_NSATS"></a> CHECK_NSATS | `uint16` | 1 | Too few satellites |
| <a id="#CHECK_PDOP"></a> CHECK_PDOP | `uint16` | 2 | Position dilution of precision too high |
| <a id="#CHECK_EPH"></a> CHECK_EPH | `uint16` | 4 | Horizontal position accuracy too low |
| <a id="#CHECK_EPV"></a> CHECK_EPV | `uint16` | 8 | Vertical position accuracy too low |
| <a id="#CHECK_SACC"></a> CHECK_SACC | `uint16` | 16 | Speed accuracy too low |
| <a id="#CHECK_HDRIFT"></a> CHECK_HDRIFT | `uint16` | 32 | Horizontal position drift at rest too high |
| <a id="#CHECK_VDRIFT"></a> CHECK_VDRIFT | `uint16` | 64 | Vertical position drift at rest too high |
| <a id="#CHECK_HSPEED"></a> CHECK_HSPEED | `uint16` | 128 | Horizontal speed at rest too high |
| <a id="#CHECK_VSPEED"></a> CHECK_VSPEED | `uint16` | 256 | Vertical speed at rest too high |
| <a id="#CHECK_SPOOFED"></a> CHECK_SPOOFED | `uint16` | 512 | Receiver reports spoofing |
| <a id="#CHECK_FIX"></a> CHECK_FIX | `uint16` | 1024 | Fix type too low |
| <a id="#CHECK_JAMMED"></a> CHECK_JAMMED | `uint16` | 2048 | Receiver reports jamming |
| <a id="#CHECK_HKIN"></a> CHECK_HKIN | `uint16` | 4096 | Horizontal position change inconsistent with velocity |
## Source Message
[Source file (GitHub)](https://github.com/PX4/PX4-Autopilot/blob/main/msg/VehicleGnss.msg)
::: details Click here to see original file
```c
# Selected GNSS solution
#
# Published by the sensors module for every sample of the selected receiver, usable or not, with the selection state and the check result for that sample.
# Heading is on vehicle_gnss_heading.
uint64 timestamp # [us] Time since system start
uint64 timestamp_sample # [us] Measurement time, delay corrected. Use this rather than receiver.timestamp_sample, which holds the same value
SensorGnss receiver # The selected receiver's sensor_gnss sample with the corrected timestamp_sample
float32[3] antenna_offset # [m] [@frame FRD] Antenna position of the selected receiver
# Selection state
uint8 selected_instance # [-] sensor_gnss instance of the selected receiver
uint8 selection_count # [-] Increments when the selected receiver changes
uint8 selection_reason # [@enum SELECTION] Why this receiver is selected
uint8 SELECTION_PREFERRED = 0 # The preferred receiver
uint8 SELECTION_ONLY = 1 # No other receiver has published
uint8 SELECTION_RANKED = 2 # No receiver is preferred, and no other one ranks higher
uint8 SELECTION_TIMEOUT = 3 # The previously selected or the preferred receiver stopped publishing
uint8 SELECTION_UNHEALTHY = 4 # The previously selected or the preferred receiver failed its checks or delivered samples late, continuously or often
uint8 SELECTION_STRICT = 5 # Passes the strict checks, which the previously selected receiver didn't
uint8 SELECTION_RTK_FIXED = 6 # Passes the strict checks with an RTK fixed solution, and the previously selected receiver ranked lower
# Check result for this sample. The strict checks are the GNSS_REQ_* thresholds, satellite count, PDOP and drift at rest on the ground; the relaxed checks are fixed, looser limits on fix type, accuracy, spoofing and jamming.
bool usable # Sample may be used: the checks that decide it have passed without a failure for long enough
bool strict # The strict checks decide usable: they haven't passed since the vehicle was disarmed on the ground, or they pass. Otherwise the relaxed checks decide
uint16 failed_strict_checks # [@enum CHECK] Enabled checks this sample fails at the strict thresholds, evaluated on every sample
uint16 failed_relaxed_checks # [@enum CHECK] Enabled checks this sample fails at the relaxed thresholds, evaluated on every sample
uint16 CHECK_NSATS = 1 # Too few satellites
uint16 CHECK_PDOP = 2 # Position dilution of precision too high
uint16 CHECK_EPH = 4 # Horizontal position accuracy too low
uint16 CHECK_EPV = 8 # Vertical position accuracy too low
uint16 CHECK_SACC = 16 # Speed accuracy too low
uint16 CHECK_HDRIFT = 32 # Horizontal position drift at rest too high
uint16 CHECK_VDRIFT = 64 # Vertical position drift at rest too high
uint16 CHECK_HSPEED = 128 # Horizontal speed at rest too high
uint16 CHECK_VSPEED = 256 # Vertical speed at rest too high
uint16 CHECK_SPOOFED = 512 # Receiver reports spoofing
uint16 CHECK_FIX = 1024 # Fix type too low
uint16 CHECK_JAMMED = 2048 # Receiver reports jamming
uint16 CHECK_HKIN = 4096 # Horizontal position change inconsistent with velocity
```
:::