Files
PX4-Autopilot/docs/en/msg_docs/index.md
Hamish Willee 5415aeb9fe
Some checks failed
Container build / Set Tags and Variables (push) Has been cancelled
Container build / Build Container (amd64) (push) Has been cancelled
Container build / Build Container (arm64) (push) Has been cancelled
Container build / Deploy To Registry (push) Has been cancelled
Docs - Crowdin - Upload Guide sources (en) / upload-to-crowdin (push) Has been cancelled
Docs - Deploy PX4 User Guide / build (push) Has been cancelled
Docs - Deploy PX4 User Guide / deploy (push) Has been cancelled
Handle stale issues and PRs / stale (push) Has been cancelled
Build all targets / Scan for Board Targets (push) Has been cancelled
Build all targets / Build Group [${{ matrix.group }}][${{ matrix.arch == 'nuttx' && 'x86' || 'arm64' }}] (push) Has been cancelled
Build all targets / Upload Artifacts to S3 (push) Has been cancelled
Build all targets / Create Release and Upload Artifacts (push) Has been cancelled
Checks / build (NO_NINJA_BUILD=1 px4_fmu-v5_default) (push) Has been cancelled
Checks / build (NO_NINJA_BUILD=1 px4_sitl_default) (push) Has been cancelled
Checks / build (check_format) (push) Has been cancelled
Checks / build (check_newlines) (push) Has been cancelled
Checks / build (module_documentation) (push) Has been cancelled
Checks / build (px4_fmu-v2_default stack_check) (push) Has been cancelled
Checks / build (px4_sitl_allyes) (push) Has been cancelled
Checks / build (shellcheck_all) (push) Has been cancelled
Checks / build (tests) (push) Has been cancelled
Checks / build (tests_coverage) (push) Has been cancelled
Checks / build (validate_module_configs) (push) Has been cancelled
Clang Tidy / build (push) Has been cancelled
MacOS build / build (px4_fmu-v5_default) (push) Has been cancelled
MacOS build / build (px4_sitl) (push) Has been cancelled
Ubuntu environment build / Build and Test (ubuntu:22.04) (push) Has been cancelled
Ubuntu environment build / Build and Test (ubuntu:24.04) (push) Has been cancelled
EKF Update Change Indicator / unit_tests (push) Has been cancelled
Failsafe Simulator Build / build (failsafe_web) (push) Has been cancelled
FLASH usage analysis / Analyzing px4_fmu-v5x (push) Has been cancelled
FLASH usage analysis / Analyzing px4_fmu-v6x (push) Has been cancelled
FLASH usage analysis / Publish Results (push) Has been cancelled
ITCM check / Checking nxp_tropic-community (push) Has been cancelled
ITCM check / Checking px4_fmu-v5x (push) Has been cancelled
ITCM check / Checking px4_fmu-v6xrt (push) Has been cancelled
MAVROS Mission Tests / build (map[mission:MC_mission_box vehicle:iris]) (push) Has been cancelled
MAVROS Offboard Tests / build (map[test_file:mavros_posix_tests_offboard_posctl.test vehicle:iris]) (push) Has been cancelled
Nuttx Target with extra env config / build (px4_fmu-v5_default) (push) Has been cancelled
Python CI Checks / build (push) Has been cancelled
ROS Integration Tests / build (push) Has been cancelled
ROS Translation Node Tests / Build and test (map[ros_version:humble ubuntu:jammy]) (push) Has been cancelled
ROS Translation Node Tests / Build and test (map[ros_version:jazzy ubuntu:noble]) (push) Has been cancelled
SITL Tests / Testing PX4 tailsitter (push) Has been cancelled
SITL Tests / Testing PX4 iris (push) Has been cancelled
SITL Tests / Testing PX4 standard_vtol (push) Has been cancelled
Fuzzing / Fuzzing (push) Has been cancelled
Metadata update and fixes to internallinkerrors
2025-08-07 09:47:51 +10:00

19 KiB

uORB Message Reference

::: info This list is auto-generated from the source code. :::

This topic lists the UORB messages available in PX4 (some of which may be may be shared by the PX4-ROS 2 Bridge).

Versioned messages track changes to their definitions, with each modification resulting in a version increment. These messages are most likely shared through the PX4-ROS 2 Bridge.

Graphs showing how these are used can be found here.

Versioned Messages

  • ActuatorMotors — Motor control message
  • ActuatorServos — Servo control message
  • AirspeedValidated
  • ArmingCheckReply — Arming check reply.
  • ArmingCheckRequest — Arming check request.
  • BatteryStatus — Battery status
  • ConfigOverrides — Configurable overrides by (external) modes or mode executors
  • Event — Events interface
  • FixedWingLateralSetpoint — Fixed Wing Lateral Setpoint message Used by the fw_lateral_longitudinal_control module At least one of course, airspeed_direction, or lateral_acceleration must be finite.
  • FixedWingLongitudinalSetpoint — Fixed Wing Longitudinal Setpoint message Used by the fw_lateral_longitudinal_control module If pitch_direct and throttle_direct are not both finite, then the controller relies on altitude/height_rate and equivalent_airspeed to control vertical motion. If both altitude and height_rate are NAN, the controller maintains the current altitude.
  • GotoSetpoint — Position and (optional) heading setpoints with corresponding speed constraints Setpoints are intended as inputs to position and heading smoothers, respectively Setpoints do not need to be kinematically consistent Optional heading setpoints may be specified as controlled by the respective flag Unset optional setpoints are not controlled Unset optional constraints default to vehicle specifications
  • HomePosition — GPS home position in WGS84 coordinates.
  • LateralControlConfiguration — Fixed Wing Lateral Control Configuration message Used by the fw_lateral_longitudinal_control module to constrain FixedWingLateralSetpoint messages.
  • LongitudinalControlConfiguration — Fixed Wing Longitudinal Control Configuration message Used by the fw_lateral_longitudinal_control module and TECS to constrain FixedWingLongitudinalSetpoint messages and configure the resultant setpoints.
  • ManualControlSetpoint
  • ModeCompleted — Mode completion result, published by an active mode. The possible values of nav_state are defined in the VehicleStatus msg. Note that this is not always published (e.g. when a user switches modes or on failsafe activation)
  • RegisterExtComponentReply
  • RegisterExtComponentRequest — Request to register an external component
  • TrajectorySetpoint — Trajectory setpoint in NED frame Input to PID position controller. Needs to be kinematically consistent and feasible for smooth flight. setting a value to NaN means the state should not be controlled
  • UnregisterExtComponent
  • VehicleAngularVelocity
  • VehicleAttitude — This is similar to the mavlink message ATTITUDE_QUATERNION, but for onboard use The quaternion uses the Hamilton convention, and the order is q(w, x, y, z)
  • VehicleAttitudeSetpoint
  • VehicleCommand — Vehicle Command uORB message. Used for commanding a mission / action / etc. Follows the MAVLink COMMAND_INT / COMMAND_LONG definition
  • VehicleCommandAck — Vehicle Command Ackonwledgement uORB message. Used for acknowledging the vehicle command being received. Follows the MAVLink COMMAND_ACK message definition
  • VehicleControlMode
  • VehicleGlobalPosition — Fused global position in WGS84. This struct contains global position estimation. It is not the raw GPS measurement (@see vehicle_gps_position). This topic is usually published by the position estimator, which will take more sources of information into account than just GPS, e.g. control inputs of the vehicle in a Kalman-filter implementation.
  • VehicleLandDetected
  • VehicleLocalPosition — Fused local position in NED. The coordinate system origin is the vehicle position at the time when the EKF2-module was started.
  • VehicleOdometry — Vehicle odometry data. Fits ROS REP 147 for aerial vehicles
  • VehicleRatesSetpoint
  • VehicleStatus — Encodes the system state of the vehicle published by commander
  • VtolVehicleStatus — VEHICLE_VTOL_STATE, should match 1:1 MAVLinks's MAV_VTOL_STATE
  • Wind — Wind estimate (from EKF2)

Unversioned Messages