From 358d9df81bdfe842a877ef3eeda0edf3a7e883e3 Mon Sep 17 00:00:00 2001 From: PX4BuildBot Date: Wed, 30 Sep 2026 18:09:05 +0000 Subject: [PATCH] docs: auto-sync metadata [skip ci] Co-Authored-By: PX4 BuildBot --- docs/en/msg_docs/FailsafeFlags.md | 78 +++++++++++++------------- docs/en/msg_docs/PpsCapture.md | 12 ++-- docs/en/msg_docs/RtcmData.md | 6 +- docs/en/msg_docs/SensorGnssSpectrum.md | 6 +- docs/en/msg_docs/VehicleGnssHeading.md | 10 ++-- docs/en/msg_docs/index.md | 2 +- 6 files changed, 56 insertions(+), 58 deletions(-) diff --git a/docs/en/msg_docs/FailsafeFlags.md b/docs/en/msg_docs/FailsafeFlags.md index f97e81b374c..408f7e362d5 100644 --- a/docs/en/msg_docs/FailsafeFlags.md +++ b/docs/en/msg_docs/FailsafeFlags.md @@ -13,9 +13,9 @@ The flag comments are used as label for the failsafe state machine simulation ## Fields -| Name | Type | Unit [Frame] | Range/Enum | Description | -| ------------------------------------------------------------------------------------------------- | -------- | ------------ | ---------- | ------------------------------------------------------------------------------------------------ | -| timestamp | `uint64` | | | time since system start (microseconds) | +| Name | Type | Unit [Frame] | Range/Enum | Description | +| ------------------------------------------------------------------------------------------------- | -------- | ------------ | ---------- | ---------------------------------------------------------------------------------------------- | +| timestamp | `uint64` | | | time since system start (microseconds) | | mode_req_angular_velocity | `uint32` | | | | mode_req_attitude | `uint32` | | | | mode_req_local_alt | `uint32` | | | @@ -26,42 +26,42 @@ The flag comments are used as label for the failsafe state machine simulation | mode_req_mission | `uint32` | | | | mode_req_offboard_signal | `uint32` | | | | mode_req_home_position | `uint32` | | | -| mode_req_wind_and_flight_time_compliance | `uint32` | | | if set, mode cannot be entered if wind or flight time limit exceeded | -| mode_req_prevent_arming | `uint32` | | | if set, cannot arm while in this mode | +| mode_req_wind_and_flight_time_compliance | `uint32` | | | if set, mode cannot be entered if wind or flight time limit exceeded | +| mode_req_prevent_arming | `uint32` | | | if set, cannot arm while in this mode | | mode_req_manual_control | `uint32` | | | -| mode_req_other | `uint32` | | | other requirements, not covered above (for external modes) | -| angular_velocity_invalid | `bool` | | | Angular velocity invalid | -| attitude_invalid | `bool` | | | Attitude invalid | -| local_altitude_invalid | `bool` | | | Local altitude invalid | -| local_position_invalid | `bool` | | | Local position estimate invalid | -| local_position_invalid_relaxed | `bool` | | | Local position with reduced accuracy requirements invalid (e.g. flying with optical flow) | -| local_velocity_invalid | `bool` | | | Local velocity estimate invalid | -| global_position_invalid | `bool` | | | Global position estimate invalid | -| global_position_invalid_relaxed | `bool` | | | Global position estimate invalid with relaxed accuracy requirements | -| auto_mission_missing | `bool` | | | No mission available | -| offboard_control_signal_lost | `bool` | | | Offboard signal lost | -| home_position_invalid | `bool` | | | No home position available | -| manual_control_signal_lost | `bool` | | | Manual control (RC) signal lost | -| gcs_connection_lost | `bool` | | | GCS connection lost | -| battery_warning | `uint8` | | | Battery warning level (see BatteryStatus.msg) | -| battery_low_remaining_time | `bool` | | | Low battery based on remaining flight time | -| battery_unhealthy | `bool` | | | Battery unhealthy | -| fd_critical_failure | `bool` | | | Critical failure (attitude limit exceeded, or external ATS) | -| fd_esc_arming_failure | `bool` | | | ESC failed to arm | -| fd_imbalanced_prop | `bool` | | | Imbalanced propeller detected | -| fd_motor_failure | `bool` | | | Motor failure | -| fd_alt_loss | `bool` | | | Uncommanded altitude loss (rotary-wing, altitude-controlled flight) | -| geofence_breached | `bool` | | | Geofence breached (one or multiple) | -| mission_failure | `bool` | | | Mission failure | -| vtol_fixed_wing_system_failure | `bool` | | | vehicle in fixed-wing system failure failsafe mode (after quad-chute) | -| wind_limit_exceeded | `bool` | | | Wind limit exceeded | -| flight_time_limit_exceeded | `bool` | | | Maximum flight time exceeded | -| position_accuracy_low | `bool` | | | Position estimate has dropped below threshold, but is currently still declared valid | -| navigator_failure | `bool` | | | Navigator failed to execute a mode | -| parachute_unhealthy | `bool` | | | Parachute system missing or unhealthy | -| traffic_avoidance_unhealthy | `bool` | | | Traffic avoidance (ADS-B/FLARM) system missing or unhealthy | -| remote_id_unhealthy | `bool` | | | Remote ID (Open Drone ID) system missing or unhealthy | -| gnss_lost | `bool` | | | Active GNSS count dropped below SYS_HAS_NUM_GNSS, or two receivers report inconsistent positions | +| mode_req_other | `uint32` | | | other requirements, not covered above (for external modes) | +| angular_velocity_invalid | `bool` | | | Angular velocity invalid | +| attitude_invalid | `bool` | | | Attitude invalid | +| local_altitude_invalid | `bool` | | | Local altitude invalid | +| local_position_invalid | `bool` | | | Local position estimate invalid | +| local_position_invalid_relaxed | `bool` | | | Local position with reduced accuracy requirements invalid (e.g. flying with optical flow) | +| local_velocity_invalid | `bool` | | | Local velocity estimate invalid | +| global_position_invalid | `bool` | | | Global position estimate invalid | +| global_position_invalid_relaxed | `bool` | | | Global position estimate invalid with relaxed accuracy requirements | +| auto_mission_missing | `bool` | | | No mission available | +| offboard_control_signal_lost | `bool` | | | Offboard signal lost | +| home_position_invalid | `bool` | | | No home position available | +| manual_control_signal_lost | `bool` | | | Manual control (RC) signal lost | +| gcs_connection_lost | `bool` | | | GCS connection lost | +| battery_warning | `uint8` | | | Battery warning level (see BatteryStatus.msg) | +| battery_low_remaining_time | `bool` | | | Low battery based on remaining flight time | +| battery_unhealthy | `bool` | | | Battery unhealthy | +| fd_critical_failure | `bool` | | | Critical failure (attitude limit exceeded, or external ATS) | +| fd_esc_arming_failure | `bool` | | | ESC failed to arm | +| fd_imbalanced_prop | `bool` | | | Imbalanced propeller detected | +| fd_motor_failure | `bool` | | | Motor failure | +| fd_alt_loss | `bool` | | | Uncommanded altitude loss (rotary-wing, altitude-controlled flight) | +| geofence_breached | `bool` | | | Geofence breached (one or multiple) | +| mission_failure | `bool` | | | Mission failure | +| vtol_fixed_wing_system_failure | `bool` | | | vehicle in fixed-wing system failure failsafe mode (after quad-chute) | +| wind_limit_exceeded | `bool` | | | Wind limit exceeded | +| flight_time_limit_exceeded | `bool` | | | Maximum flight time exceeded | +| position_accuracy_low | `bool` | | | Position estimate has dropped below threshold, but is currently still declared valid | +| navigator_failure | `bool` | | | Navigator failed to execute a mode | +| parachute_unhealthy | `bool` | | | Parachute system missing or unhealthy | +| traffic_avoidance_unhealthy | `bool` | | | Traffic avoidance (ADS-B/FLARM) system missing or unhealthy | +| remote_id_unhealthy | `bool` | | | Remote ID (Open Drone ID) system missing or unhealthy | +| gnss_lost | `bool` | | | Fewer GNSS receivers are healthy than required, or two receivers report inconsistent positions | ## Source Message @@ -134,7 +134,7 @@ bool navigator_failure # Navigator failed to execute a mode bool parachute_unhealthy # Parachute system missing or unhealthy bool traffic_avoidance_unhealthy # Traffic avoidance (ADS-B/FLARM) system missing or unhealthy bool remote_id_unhealthy # Remote ID (Open Drone ID) system missing or unhealthy -bool gnss_lost # Active GNSS count dropped below SYS_HAS_NUM_GNSS, or two receivers report inconsistent positions +bool gnss_lost # Fewer GNSS receivers are healthy than required, or two receivers report inconsistent positions ``` ::: diff --git a/docs/en/msg_docs/PpsCapture.md b/docs/en/msg_docs/PpsCapture.md index 68788964528..1657d870e7c 100644 --- a/docs/en/msg_docs/PpsCapture.md +++ b/docs/en/msg_docs/PpsCapture.md @@ -8,11 +8,11 @@ pageClass: is-wide-page ## Fields -| Name | Type | Unit [Frame] | Range/Enum | Description | -| ------------------------------------------- | -------- | ------------ | ---------- | ----------------------------------------------------------- | -| timestamp | `uint64` | | | time since system start (microseconds) at PPS capture event | -| rtc_timestamp | `uint64` | | | Corrected GPS UTC timestamp at PPS capture event | -| | `uint8` | | | Increments when PPS dt < 50ms | +| Name | Type | Unit [Frame] | Range/Enum | Description | +| ------------------------------------------- | -------- | ------------ | ---------- | ---------------------------------------------------------------- | +| timestamp | `uint64` | | | time since system start (microseconds) at PPS capture event | +| rtc_timestamp | `uint64` | | | Corrected GPS UTC timestamp at PPS capture event | +| | `uint8` | | | Count of PPS pulses that arrived too soon after the previous one | ## Source Message @@ -23,7 +23,7 @@ pageClass: is-wide-page ```c uint64 timestamp # time since system start (microseconds) at PPS capture event uint64 rtc_timestamp # Corrected GPS UTC timestamp at PPS capture event -uint8 pps_rate_exceeded_counter # Increments when PPS dt < 50ms +uint8 pps_rate_exceeded_counter # Count of PPS pulses that arrived too soon after the previous one ``` ::: diff --git a/docs/en/msg_docs/RtcmData.md b/docs/en/msg_docs/RtcmData.md index 294a424f356..8aa91ee016c 100644 --- a/docs/en/msg_docs/RtcmData.md +++ b/docs/en/msg_docs/RtcmData.md @@ -10,8 +10,7 @@ Published under two topic names that share this definition (see TOPICS below): rtcm_corrections - external fixed-base corrections fed into the vehicle (MAVLink GPS_RTCM_DATA, UAVCAN RTCMStream, GPS drivers in dump mode). Multiple -sources are allowed, one uORB instance each; consumers select an instance -via their stale-link logic. +sources are allowed, one uORB instance each; consumers select one instance. rtcm_moving_baseline - moving-base GPS output (RTCM 4072 or equivalent) intended for a rover. Single publisher per vehicle (on-board moving base, or a CANnode @@ -49,8 +48,7 @@ forwarding MovingBaselineData); consumers only read instance 0. # # rtcm_corrections - external fixed-base corrections fed into the vehicle (MAVLink # GPS_RTCM_DATA, UAVCAN RTCMStream, GPS drivers in dump mode). Multiple -# sources are allowed, one uORB instance each; consumers select an instance -# via their stale-link logic. +# sources are allowed, one uORB instance each; consumers select one instance. # # rtcm_moving_baseline - moving-base GPS output (RTCM 4072 or equivalent) intended for a rover. # Single publisher per vehicle (on-board moving base, or a CANnode diff --git a/docs/en/msg_docs/SensorGnssSpectrum.md b/docs/en/msg_docs/SensorGnssSpectrum.md index f71a0cc587a..ff107740719 100644 --- a/docs/en/msg_docs/SensorGnssSpectrum.md +++ b/docs/en/msg_docs/SensorGnssSpectrum.md @@ -6,8 +6,7 @@ pageClass: is-wide-page GNSS spectrum analysis. -Reports a basic RF spectrum analysis for a GNSS receiver, decoded from the u-blox UBX-MON-SPAN -message (enabled via the GPS_UBX_SPECTRUM parameter). +Reports a basic RF spectrum analysis for a GNSS receiver, decoded from the u-blox UBX-MON-SPAN message. Published by the `gps` driver (UBX protocol only), once per RF block, via the block-specific topics below. The center frequency of bin i is: f(i) = center_frequency + spectrum_span \* (i - 127) / 256 @@ -36,8 +35,7 @@ The center frequency of bin i is: f(i) = center_frequency + spectrum_span \* (i ```c # GNSS spectrum analysis # -# Reports a basic RF spectrum analysis for a GNSS receiver, decoded from the u-blox UBX-MON-SPAN -# message (enabled via the GPS_UBX_SPECTRUM parameter). +# Reports a basic RF spectrum analysis for a GNSS receiver, decoded from the u-blox UBX-MON-SPAN message. # Published by the `gps` driver (UBX protocol only), once per RF block, via the block-specific topics below. # The center frequency of bin i is: f(i) = center_frequency + spectrum_span * (i - 127) / 256 diff --git a/docs/en/msg_docs/VehicleGnssHeading.md b/docs/en/msg_docs/VehicleGnssHeading.md index 1b0f51feddc..9800adb7adf 100644 --- a/docs/en/msg_docs/VehicleGnssHeading.md +++ b/docs/en/msg_docs/VehicleGnssHeading.md @@ -4,7 +4,9 @@ pageClass: is-wide-page # VehicleGnssHeading (UORB message) -GNSS heading from a dual-antenna or moving-baseline receiver, published by the sensors module from sensor_gnss_relative. Only headings whose reported baseline matches the configured SENS_GNSSn_HDG baseline are published. Consumed by EKF2. independently from position/velocity. +GNSS heading from a dual-antenna or moving-baseline receiver. + +Published by the sensors module from sensor_gnss_relative. Consumed by EKF2 independently from position and velocity. **TOPICS:** vehicle_gnss_heading @@ -29,9 +31,9 @@ GNSS heading from a dual-antenna or moving-baseline receiver, published by the s ::: details Click here to see original file ```c -# GNSS heading from a dual-antenna or moving-baseline receiver, published by the sensors module from sensor_gnss_relative. -# Only headings whose reported baseline matches the configured SENS_GNSSn_HDG baseline are published. Consumed by EKF2 -# independently from position/velocity. +# GNSS heading from a dual-antenna or moving-baseline receiver +# +# Published by the sensors module from sensor_gnss_relative. Consumed by EKF2 independently from position and velocity. uint64 timestamp # time since system start (microseconds) uint64 timestamp_sample # time since system start (microseconds) - actual measurement time diff --git a/docs/en/msg_docs/index.md b/docs/en/msg_docs/index.md index 6881abbf1ff..64318073b35 100644 --- a/docs/en/msg_docs/index.md +++ b/docs/en/msg_docs/index.md @@ -293,7 +293,7 @@ Graphs showing how these are used [can be found here](../middleware/uorb_graph.m - [VehicleConstraints](VehicleConstraints.md) — Local setpoint constraints in NED frame. setting something to NaN means that no limit is provided. - [VehicleControlMode](VehicleControlMode.md) — Defines which controllers should run. - [VehicleGnss](VehicleGnss.md) — Selected GNSS solution. -- [VehicleGnssHeading](VehicleGnssHeading.md) — GNSS heading from a dual-antenna or moving-baseline receiver, published by the sensors module from sensor_gnss_relative. Only headings whose reported baseline matches the configured SENS_GNSSn_HDG baseline are published. Consumed by EKF2. independently from position/velocity. +- [VehicleGnssHeading](VehicleGnssHeading.md) — GNSS heading from a dual-antenna or moving-baseline receiver. - [VehicleImu](VehicleImu.md) — IMU readings in SI-unit form. - [VehicleImuStatus](VehicleImuStatus.md) - [VehicleLocalPositionSetpoint](VehicleLocalPositionSetpoint.md) — Local position setpoint in NED frame. Telemetry of PID position controller to monitor tracking. NaN means the state was not controlled.