mirror of
https://github.com/PX4/PX4-Autopilot.git
synced 2026-11-22 14:19:57 +08:00
* feat(msg): rename rover throttle setpoint to surface_vehicle_* The throttle setpoint was the last rover topic shared by rovers and boats without the surface_vehicle_* prefix decided in #29524. Rename RoverThrottleSetpoint to SurfaceVehicleThrottleSetpoint and the TYPE_ROVER_THROTTLE_* setpoint types to TYPE_SURFACE_VEHICLE_THROTTLE_*. The type values are unchanged. The topic rename breaks ROS 2 users anyway, so also shorten the fields of the throttle and speed setpoints to x and y: the message name already says what the value is and [@frame Body] states the frame. Assisted-by: Claude:claude-opus-5-5 Signed-off-by: Michael Fritsche <frimi999@gmail.com> * fix(zenoh): bring surface_vehicle rename to the zenoh dds topics * fix(concept): rename rover throttle setpoint to surface_vehicle_* in navigation terminology * fix(tools): update px4-ros2-interface-lib pin * docs(msg): describe sideways fields as omnidirectional, not mecanum The surface vehicle messages are shared by rovers and boats, and the lateral axis applies to any vehicle that can move sideways, not only mecanum rovers. Assisted-by: Claude:claude-opus-5-5 Signed-off-by: Michael Fritsche <frimi999@gmail.com> * docs(ros2): use the surface vehicle setpoint type names of the interface lib The pinned px4-ros2-interface-lib names the rover setpoint types SurfaceVehicle*SetpointType. The table and the example reference still used the old Rover*SetpointType class names, which do not exist in that version. Assisted-by: Claude:claude-opus-5-5 Signed-off-by: Michael Fritsche <frimi999@gmail.com> * feat(msg)!: rename surface vehicle throttle setpoint to thrust setpoint The setpoint is a normalized force command along the body x and y axes, which is a thrust, not a throttle. Throttle stays the name for the motor command the actuator control derives from it. surface_vehicle_throttle_setpoint is now surface_vehicle_thrust_setpoint (SurfaceVehicleThrustSetpoint), and SetpointConfig TYPE_SURFACE_VEHICLE_THROTTLE_* are now TYPE_SURFACE_VEHICLE_THRUST_* (same values). The px4-ros2-interface-lib pin follows the matching rename there. Assisted-by: Claude:claude-opus-5-5 Signed-off-by: Michael Fritsche <frimi999@gmail.com> * fix(tools): update px4-ros2-interface-lib pin * fix(commander): do not enable velocity control for surface vehicle thrust setpoints The SurfaceVehicleThrust* setpoint types enabled the velocity flag, taken over from the original interface lib configuration. Nothing in these types uses velocity, and offboard mode maps the same combinations without it. The flag kept the rover speed controller running: switching from a SurfaceVehicleSpeed* to a SurfaceVehicleThrust* type sets the same flags, so the controllers were not reset and a stale speed setpoint kept overriding the commanded thrust. It also made external modes that only command thrust require a local position estimate. Assisted-by: Claude:claude-opus-5-5 Signed-off-by: Michael Fritsche <frimi999@gmail.com> * docs(msg): apply review suggestions for the surface vehicle setpoints Add long descriptions to the thrust and speed setpoints and the speed status, name modules instead of C++ classes, and use single spaces before field comments. Rename the speed status PID integrals from pid_throttle_* to pid_thrust_*, since the speed controller drives the thrust setpoint. Update the docs and the rover control structure diagram for the thrust setpoint and omnidirectional vehicles, note the Rover*SetpointType names of PX4 v1.17 and v1.18, and add the ROS 2 release note. Assisted-by: Claude:claude-opus-5-5 Signed-off-by: Michael Fritsche <frimi999@gmail.com> --------- Signed-off-by: Michael Fritsche <frimi999@gmail.com>
24 KiB
24 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
Current Versions
- ActuatorMotors — Motor control message.
- ActuatorServos — Servo control message.
- AirspeedValidated — Validated airspeed.
- ArmingCheckReply — Arming check reply.
- ArmingCheckRequest — Arming check request.
- AuxGlobalPosition — Auxiliary global position.
- BatteryStatus — Battery status.
- ConfigOverrides — Configuration overrides from external modes or mode executors.
- Event — Events interface.
- FixedWingLateralSetpoint — Fixed Wing Lateral Setpoint message.
- FixedWingLongitudinalSetpoint — Fixed Wing Longitudinal Setpoint message.
- GotoSetpoint — Position and (optional) heading setpoints with corresponding speed constraints.
- HomePosition — GPS home position in WGS84 coordinates.
- LateralControlConfiguration — Fixed Wing Lateral Control Configuration message.
- LongitudinalControlConfiguration — Fixed Wing Longitudinal Control Configuration message.
- ManualControlSetpoint — Manual control input.
- 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).
- RaptorInput — Raptor Input.
- RaptorStatus — Raptor Status.
- RegisterExtComponentReply
- RegisterExtComponentRequest — Request to register an external component.
- SetpointConfig — Setpoint configuration message.
- SetpointConfigReply — Reply to SetpointConfig.
- 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 Acknowledgement uORB message.
- VehicleGlobalPosition — Fused global position in WGS84. This struct contains global position estimation. It is not the raw GPS. measurement (@see vehicle_gnss). 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.
- 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).
Historic Versions
- ActuatorServosV0 — Servo control message.
- AirspeedValidatedV0
- ArmingCheckReplyV0
- ArmingCheckRequestV0 — Arming check request.
- BatteryStatusV0 — Battery status.
- ConfigOverridesV0 — Configurable overrides by (external) modes or mode executors.
- EventV0 — this message is required here in the msg_old folder because other msg are depending on it. Events interface.
- HomePositionV0 — GPS home position in WGS84 coordinates.
- HomePositionV1 — GPS home position in WGS84 coordinates.
- ManualControlSetpointV0
- ManualControlSetpointV1 — Manual control input.
- RegisterExtComponentReplyV0
- RegisterExtComponentRequestV0 — Request to register an external component.
- RegisterExtComponentRequestV1 — Request to register an external component.
- VehicleAttitudeSetpointV0
- VehicleCommandAckV0 — Vehicle Command Ackonwledgement uORB message. Used for acknowledging the vehicle command being received. Follows the MAVLink COMMAND_ACK message definition.
- VehicleCommandAckV1 — Vehicle Command Acknowledgement uORB message.
- VehicleCommandV0 — Vehicle Command uORB message. Used for commanding a mission / action / etc. Follows the MAVLink COMMAND_INT / COMMAND_LONG definition.
- VehicleGlobalPositionV0 — 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.
- VehicleLocalPositionV0 — Fused local position in NED. The coordinate system origin is the vehicle position at the time when the EKF2-module was started.
- VehicleStatusV0 — Encodes the system state of the vehicle published by commander.
- VehicleStatusV1 — Encodes the system state of the vehicle published by commander.
- VehicleStatusV2 — Encodes the system state of the vehicle published by commander.
- VehicleStatusV3 — Encodes the system state of the vehicle published by commander.
- VehicleStatusV4 — Encodes the system state of the vehicle published by commander.
Unversioned Messages
- ActionRequest — Action request for the vehicle's main state.
- ActuatorArmed
- ActuatorControlsStatus
- ActuatorOutputs
- ActuatorServosTrim — Servo trims, added as offset to servo outputs.
- ActuatorTest
- AdcReport — ADC raw data.
- Airspeed — Airspeed data from sensors.
- AirspeedWind — Wind estimate (from airspeed_selector).
- AutotuneAttitudeControlStatus — Autotune attitude control status.
- BatteryInfo — Battery information.
- ButtonEvent
- CameraCapture
- CameraStatus
- CameraTrigger
- CanInterfaceStatus
- CellularStatus — Cellular status.
- CollisionConstraints — Local setpoint constraints in NED frame. setting something to NaN means that no limit is provided.
- ControlAllocatorStatus
- Cpuload
- DatamanRequest
- DatamanResponse
- DebugArray
- DebugKeyValue
- DebugValue
- DebugVect
- DetectAndAvoid — Detect-and-avoid conflict assessment for one traffic aircraft.
- DetectAndAvoidMostUrgent — Detect-and-avoid summary for the most urgent active conflict.
- DeviceInformation — Device information.
- DifferentialPressure — Differential-pressure (airspeed) sensor.
- DistanceSensor — DISTANCE_SENSOR message data.
- DistanceSensorModeChangeRequest
- DronecanNodeStatus
- Ekf2Timestamps — this message contains the (relative) timestamps of the sensor inputs used by EKF2. It can be used for reproducible replay.
- EscEepromRead
- EscEepromWrite
- EscReport
- EscStatus
- EstimatorAidSource1d
- EstimatorAidSource2d
- EstimatorAidSource3d
- EstimatorBias
- EstimatorBias3d
- EstimatorEventFlags
- EstimatorFusionControl
- EstimatorInnovations
- EstimatorSelectorStatus
- EstimatorSensorBias — Sensor readings and in-run biases in SI-unit form. Sensor readings are compensated for static offsets,. scale errors, in-run bias and thermal drift (if thermal compensation is enabled and available).
- EstimatorStates
- EstimatorStatus
- EstimatorStatusFlags
- ExternalGimbalManagerStatus — External gimbal manager status.
- FailsafeFlags — Input flags for the failsafe state machine set by the arming & health checks.
- FailureDetectorStatus
- FailureInjection — Failure injection configuration.
- FiducialMarkerPosReport — Relative position of a precision-landing target detected by a vision pipeline (e.g. an ArUco marker).
- FiducialMarkerYawReport — Yaw of a precision-landing target relative to the NED (North, East, Down) frame, reported by a vision pipeline.
- FigureEightStatus
- FixedWingLateralGuidanceStatus — Fixed Wing Lateral Guidance Status message. Published by fw_mode_manager module to report the resultant lateral setpoints and NPFG debug outputs.
- FixedWingLateralStatus — Fixed Wing Lateral Status message. Published by the fw_lateral_longitudinal_control module to report the resultant lateral setpoint.
- FixedWingRunwayControl — Auxiliary control fields for fixed-wing runway takeoff/landing.
- FixedWingTakeoffStatus — Status of a fixed-wing takeoff. Passes information from the FixedWingModeManager to the Navigator.
- FlightPhaseEstimation
- FollowTarget
- FollowTargetEstimator
- FollowTargetStatus
- FuelTankStatus
- GainCompression
- GeneratorStatus
- GeofenceResult
- GeofenceStatus
- GimbalControls
- GimbalDeviceAttitudeStatus
- GimbalDeviceInformation
- GimbalDeviceSetAttitude
- GimbalManagerInformation
- GimbalManagerSetAttitude
- GimbalManagerSetManualControl
- GimbalManagerSetPitchyaw — Gimbal manager pitch/yaw setpoint.
- GimbalManagerStatus
- GpioConfig — GPIO configuration.
- GpioIn — GPIO mask and state.
- GpioOut — GPIO mask and state.
- GpioRequest — Request GPIO mask to be read.
- GpsDump — This message is used to dump the raw gps communication to the log.
- Gripper — # Used to command an actuation in the gripper, which is mapped to a specific output in the control allocation module.
- HealthReport
- HeaterStatus
- HoverThrustEstimate
- InputRc
- InternalCombustionEngineControl — Internal combustion engine (ICE) actuator setpoints.
- InternalCombustionEngineStatus
- IridiumsbdStatus
- IrlockReport — IRLOCK_REPORT message data.
- LandingGear
- LandingGearWheel
- LandingTargetInnovations
- LandingTargetPose — Relative position of precision land target in navigation (body fixed, north aligned, NED) and inertial (world fixed, north aligned, NED) frames.
- LaunchDetectionStatus — Status of the launch detection state machine (fixed-wing only).
- LedControl — LED control: control a single or multiple LED's. These are the externally visible LED's, not the board LED's.
- LogMessage — A logging message, output with PX4_WARN, PX4_ERR, PX4_INFO.
- LoggerStatus
- MagWorkerData
- MagnetometerBiasEstimate
- ManualControlSwitches
- MavlinkLog
- MavlinkTunnel — MAV_TUNNEL_PAYLOAD_TYPE enum.
- MessageFormatRequest
- MessageFormatResponse
- Mission
- MissionResult
- MountOrientation
- NavigatorMissionItem
- NavigatorStatus — Current status of a Navigator mode. The possible values of nav_state are defined in the VehicleStatus msg.
- NeuralControl — Neural control.
- NfsUp
- NormalizedUnsignedSetpoint
- ObstacleDistance — Obstacle distances in front of the sensor.
- OffboardControlMode — Off-board control mode.
- OnboardComputerStatus — ONBOARD_COMPUTER_STATUS message data.
- OpenDroneIdArmStatus
- OpenDroneIdBasicId
- OpenDroneIdOperatorId
- OpenDroneIdSelfId
- OpenDroneIdSystem
- OrbTest
- OrbTestLarge
- OrbTestMedium
- OrbitStatus — Orbit status.
- ParameterResetRequest — ParameterResetRequest : Used by the primary to reset one or all parameter value(s) on the remote.
- ParameterSetUsedRequest — ParameterSetUsedRequest : Used by a remote to update the used flag for a parameter on the primary.
- ParameterSetValueRequest — ParameterSetValueRequest : Used by a remote or primary to update the value for a parameter at the other end.
- ParameterSetValueResponse — ParameterSetValueResponse : Response to a set value request by either primary or secondary.
- ParameterUpdate — This message is used to notify the system about one or more parameter changes.
- Ping
- PositionControllerLandingStatus
- PositionControllerStatus
- PositionSetpoint — this file is only used in the position_setpoint triple as a dependency.
- PositionSetpointTriplet — Global position setpoint triplet in WGS84 coordinates. This are the three next waypoints (or just the next two or one).
- PowerButtonState — power button state notification message.
- PowerMonitor — power monitor message.
- PpsCapture
- PrecLandStatus — Precision-landing runtime status: a single state captures both whether precision landing is active and which phase it is in.
- PrecTakeoffStatus — Precision takeoff status.
- PurePursuitStatus — Pure pursuit status.
- PwmInput
- Px4ioStatus
- QshellReq
- QshellRetval
- RadioStatus
- RangingBeacon — Ranging beacon measurement data (e.g. LoRa, UWB).
- RateCtrlStatus
- RcChannels
- RcParameterMap
- Rpm
- RtcmData — RTCM3 data exchanged with GNSS receivers.
- RtlStatus
- RtlTimeEstimate
- SatelliteInfo
- SensorAccel
- SensorAccelFifo
- SensorAirflow
- SensorBaro — Barometer sensor.
- SensorCombined — Sensor readings in SI-unit form. These fields are scaled and offset-compensated where possible and do not. change with board revisions and sensor updates.
- SensorCorrection — Sensor corrections in SI-unit form for the voted sensor.
- SensorGnss — GNSS receiver report, position in WGS84.
- SensorGnssRelative — GNSS relative positioning information in NED frame. The NED frame is defined as the local topological system at the reference station.
- SensorGnssRf — GNSS RF status.
- SensorGnssSpectrum — GNSS spectrum analysis.
- SensorGnssStatus — Gnss quality indicators.
- SensorGyro
- SensorGyroFft
- SensorGyroFifo
- SensorHygrometer
- SensorMag
- SensorOpticalFlow
- SensorPreflightMag — Pre-flight sensor check metrics. The topic will not be updated when the vehicle is armed.
- SensorSelection — Sensor ID's for the voted sensors output on the sensor_combined topic. Will be updated on startup of the sensor module and when sensor selection changes.
- SensorTemp
- SensorUwb — Ultra-wideband (UWB) distance sensor.
- SensorsStatus — Sensor check metrics. This will be zero for a sensor that's primary or unpopulated.
- SensorsStatusGnss — Per-receiver GNSS health and check diagnostics.
- SensorsStatusImu — Sensor check metrics. This will be zero for a sensor that's primary or unpopulated.
- SurfaceVehicleAttitudeSetpoint — Surface Vehicle Attitude Setpoint.
- SurfaceVehicleAttitudeStatus — Surface Vehicle Attitude Status.
- SurfaceVehicleCourseSetpoint — Surface Vehicle Course Setpoint.
- SurfaceVehiclePositionSetpoint — Surface Vehicle Position Setpoint.
- SurfaceVehicleRateSetpoint — Surface Vehicle Rate Setpoint.
- SurfaceVehicleRateStatus — Surface Vehicle Rate Status.
- SurfaceVehicleSpeedSetpoint — Surface Vehicle Speed Setpoint.
- SurfaceVehicleSpeedStatus — Surface Vehicle Speed Status.
- SurfaceVehicleSteeringSetpoint — Surface Vehicle Steering Setpoint.
- SurfaceVehicleThrustSetpoint — Surface Vehicle Thrust Setpoint.
- SystemPower
- TakeoffStatus — Status of the takeoff state machine currently just available for multicopters.
- TargetGnss — Landing target GNSS position in WGS84 coordinates, and optional NED velocity, from a target-mounted receiver.
- TaskStackInfo — stack information for a single running process.
- TecsStatus
- TelemetryStatus
- TiltrotorExtraControls
- TimesyncStatus
- TrajectorySetpoint6dof — Trajectory setpoint in NED frame. Input to position controller.
- TransponderReport — Transponder report.
- TuneControl — This message is used to control the tunes, when the tune_id is set to CUSTOM. then the frequency, duration are used otherwise those values are ignored.
- UavcanFirmwareUpdate
- UavcanParameterRequest — UAVCAN-MAVLink parameter bridge request type.
- UavcanParameterValue — UAVCAN-MAVLink parameter bridge response type.
- UlogStream — Message to stream ULog data from the logger. Corresponds to the LOGGING_DATA. mavlink message.
- UlogStreamAck — Ack a previously sent ulog_stream message that had. the NEED_ACK flag set.
- VehicleAcceleration
- VehicleAirData — Vehicle air data.
- VehicleConstraints — Local setpoint constraints in NED frame. setting something to NaN means that no limit is provided.
- VehicleControlMode — Defines which controllers should run.
- VehicleGnss — Selected GNSS solution.
- VehicleGnssHeading — GNSS heading from a dual-antenna or moving-baseline receiver.
- VehicleImu — IMU readings in SI-unit form.
- VehicleImuStatus
- VehicleLocalPositionSetpoint — Local position setpoint in NED frame. Telemetry of PID position controller to monitor tracking. NaN means the state was not controlled.
- VehicleMagnetometer
- VehicleOpticalFlow — Optical flow in XYZ body frame in SI units.
- VehicleOpticalFlowVel
- VehicleRoi — Vehicle Region Of Interest (ROI).
- VehicleThrustSetpoint — Vehicle thrust setpoint.
- VehicleTorqueSetpoint
- VelocityLimits — Velocity and yaw rate limits for a multicopter position slow mode only.
- VteAidSource1d — Vision Target Estimator 1D fusion aid-source diagnostics (e.g. yaw).
- VteAidSource3d — Vision Target Estimator 3D fusion aid-source diagnostics, one fusion_status per NED axis.
- VteBiasInitStatus — Diagnostics for the initial GNSS/vision bias averaging phase in the Vision Target Estimator.
- VteInput — Vehicle inputs fed into the Vision Target Estimator position prediction step, logged for tuning.
- VteOrientation — Vision Target Estimator orientation state, exposing the full yaw filter output with covariances for logging and tuning.
- VtePosition — Vision Target Estimator position state, exposing the full per-axis Kalman filter state with covariances for logging and tuning.
- Vtx
- WheelEncoders — Wheel encoder readings.
- YawEstimatorStatus