PX4-Autopilot/docs/en/msg_docs/GotoSetpoint.md

pageClass

pageClass
is-wide-page

GotoSetpoint (UORB message)

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.

TOPICS: goto_setpoint

Fields

Name	Type	Unit [Frame]	Range/Enum	Description
timestamp	uint64	us		Time since system start
position	float32[3]	m [NED]		NED local world frame
flag_control_heading	bool			true if heading is to be controlled
heading	float32			(optional) [rad] [-pi,pi] from North
flag_set_max_horizontal_speed	bool			true if setting a non-default horizontal speed limit
max_horizontal_speed	float32	m/s		(optional) Maximum speed (absolute) in the NE-plane
flag_set_max_vertical_speed	bool			true if setting a non-default vertical speed limit
max_vertical_speed	float32	m/s		(optional) Maximum speed (absolute) in the D-axis
flag_set_max_heading_rate	bool			true if setting a non-default heading rate limit
max_heading_rate	float32	rad/s		(optional) Maximum heading rate (absolute)

Constants

Name	Type	Value	Description
MESSAGE_VERSION	uint32	0

Source Message

Source file (GitHub)

::: details Click here to see original file

# 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.

uint32 MESSAGE_VERSION = 0

uint64 timestamp # [us] Time since system start

# setpoints
float32[3] position # [m] [@frame NED] NED local world frame

bool flag_control_heading # true if heading is to be controlled
float32 heading # (optional) [rad] [-pi,pi] from North

# constraints
bool flag_set_max_horizontal_speed # true if setting a non-default horizontal speed limit
float32 max_horizontal_speed # [m/s] (optional) Maximum speed (absolute) in the NE-plane

bool flag_set_max_vertical_speed # true if setting a non-default vertical speed limit
float32 max_vertical_speed # [m/s] (optional) Maximum speed (absolute) in the D-axis

bool flag_set_max_heading_rate # true if setting a non-default heading rate limit
float32 max_heading_rate # [rad/s] (optional) Maximum heading rate (absolute)

:::