Files
PX4-Autopilot/docs/en/msg_docs/SetpointConfig.md
T

7.9 KiB

pageClass
pageClass
is-wide-page

SetpointConfig (UORB message)

Setpoint configuration message.

Published by external modes and PX4 will respond with SetpointConfigReply.

TOPICS: setpoint_config

Fields

Name Type Unit [Frame] Range/Enum Description
timestamp uint64 us Time since system start
type uint16 TYPE setpoint type (corresponding to one or more setpoint messages)
source_id uint8 nav_state of the mode
should_apply bool if true: apply as current setpoint configuration (mode should be active). If false: setpoint configuration is not changed (can be used to check if a setpoint can be used with the current vehicle configuration).
timeout_ms uint16 Configure setpoint timeout. If no setpoint received for this time, PX4 triggers a failsafe. 0 disables the timeout (unresponsive modes still trigger a timeout through arming checks).

Enums

TYPE

Used in field(s): type

Name Type Value Description
TYPE_INVALID uint16 0
TYPE_DIRECT_ACTUATORS uint16 1 ActuatorMotors and ActuatorServos
TYPE_MULTICOPTER_GOTO uint16 2 GotoSetpoint
TYPE_FIXEDWING_LATERAL_LONGITUDINAL uint16 3 FixedWingLateralSetpoint and FixedWingLongitudinalSetpoint
TYPE_TRAJECTORY uint16 4 TrajectorySetpoint
TYPE_RATES uint16 5 VehicleRatesSetpoint
TYPE_ATTITUDE uint16 6 VehicleAttitudeSetpoint
TYPE_SURFACE_VEHICLE_POSITION uint16 7 SurfaceVehiclePositionSetpoint
TYPE_SURFACE_VEHICLE_SPEED_ATTITUDE uint16 8 SurfaceVehicleSpeedSetpoint and SurfaceVehicleAttitudeSetpoint
TYPE_SURFACE_VEHICLE_SPEED_RATE uint16 9 SurfaceVehicleSpeedSetpoint and SurfaceVehicleRateSetpoint
TYPE_SURFACE_VEHICLE_SPEED_STEERING uint16 10 SurfaceVehicleSpeedSetpoint and SurfaceVehicleSteeringSetpoint
TYPE_ROVER_THROTTLE_ATTITUDE uint16 11 RoverThrottleSetpoint and SurfaceVehicleAttitudeSetpoint
TYPE_ROVER_THROTTLE_RATE uint16 12 RoverThrottleSetpoint and SurfaceVehicleRateSetpoint
TYPE_ROVER_THROTTLE_STEERING uint16 13 RoverThrottleSetpoint and SurfaceVehicleSteeringSetpoint
TYPE_TRAJECTORY_6DOF uint16 14 TrajectorySetpoint6dof
TYPE_THRUST_AND_TORQUE uint16 15 VehicleThrustSetpoint and VehicleTorqueSetpoint
TYPE_POSITION_TRIPLET uint16 16 PositionSetpointTriplet

Constants

Name Type Value Description
MESSAGE_VERSION uint32 0

Source Message

Source file (GitHub)

::: details Click here to see original file

# Setpoint configuration message
#
# Published by external modes and PX4 will respond with SetpointConfigReply.

uint32 MESSAGE_VERSION = 0

uint64 timestamp # [us] Time since system start

uint16 TYPE_INVALID = 0
uint16 TYPE_DIRECT_ACTUATORS = 1 # ActuatorMotors and ActuatorServos
uint16 TYPE_MULTICOPTER_GOTO = 2 # GotoSetpoint
uint16 TYPE_FIXEDWING_LATERAL_LONGITUDINAL = 3 # FixedWingLateralSetpoint and FixedWingLongitudinalSetpoint
uint16 TYPE_TRAJECTORY = 4 # TrajectorySetpoint
uint16 TYPE_RATES = 5 # VehicleRatesSetpoint
uint16 TYPE_ATTITUDE = 6 # VehicleAttitudeSetpoint
uint16 TYPE_SURFACE_VEHICLE_POSITION = 7 # SurfaceVehiclePositionSetpoint
uint16 TYPE_SURFACE_VEHICLE_SPEED_ATTITUDE = 8 # SurfaceVehicleSpeedSetpoint and SurfaceVehicleAttitudeSetpoint
uint16 TYPE_SURFACE_VEHICLE_SPEED_RATE = 9 # SurfaceVehicleSpeedSetpoint and SurfaceVehicleRateSetpoint
uint16 TYPE_SURFACE_VEHICLE_SPEED_STEERING = 10 # SurfaceVehicleSpeedSetpoint and SurfaceVehicleSteeringSetpoint
uint16 TYPE_ROVER_THROTTLE_ATTITUDE = 11 # RoverThrottleSetpoint and SurfaceVehicleAttitudeSetpoint
uint16 TYPE_ROVER_THROTTLE_RATE = 12 # RoverThrottleSetpoint and SurfaceVehicleRateSetpoint
uint16 TYPE_ROVER_THROTTLE_STEERING = 13 # RoverThrottleSetpoint and SurfaceVehicleSteeringSetpoint
uint16 TYPE_TRAJECTORY_6DOF = 14 # TrajectorySetpoint6dof
uint16 TYPE_THRUST_AND_TORQUE = 15 # VehicleThrustSetpoint and VehicleTorqueSetpoint
uint16 TYPE_POSITION_TRIPLET = 16 # PositionSetpointTriplet

uint16 type # [@enum TYPE] setpoint type (corresponding to one or more setpoint messages)

uint8 source_id # nav_state of the mode

bool should_apply # if true: apply as current setpoint configuration (mode should be active). If false: setpoint configuration is not changed (can be used to check if a setpoint can be used with the current vehicle configuration).

uint16 timeout_ms # Configure setpoint timeout. If no setpoint received for this time, PX4 triggers a failsafe. 0 disables the timeout (unresponsive modes still trigger a timeout through arming checks).

:::