Files
PX4-Autopilot/docs/en/msg_docs/SurfaceVehicleSpeedStatus.md
Michael Fritsche e8b3274ab0 feat(msg): rename rover throttle setpoint to surface_vehicle_thrust_setpoint (#29777)
* 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>
2026-11-13 10:05:26 +01:00

4.7 KiB

pageClass
pageClass
is-wide-page

SurfaceVehicleSpeedStatus (UORB message)

Surface Vehicle Speed Status.

Status of the speed controller of surface vehicles, on land or on water (rovers, boats). Published by the speed controllers of rover_ackermann, rover_differential and rover_mecanum while they track surface_vehicle_speed_setpoint, for logging and tuning. Not consumed by other modules.

TOPICS: surface_vehicle_speed_status

Fields

Name Type Unit [Frame] Range/Enum Description
timestamp uint64 us Time since system start
measured_speed_body_x float32 m/s [Body] [-inf (Backwards) : inf (Forwards)] Measured speed along the body X axis
adjusted_speed_body_x_setpoint float32 m/s [Body] [-inf (Backwards) : inf (Forwards)] Speed setpoint along the body X axis that is being tracked (Applied slew rates)
pid_thrust_body_x_integral float32 [-1 : 1] Integral of the PID for the closed loop controller of the speed along the body X axis
measured_speed_body_y float32 m/s [Body] [-inf (Left) : inf (Right)] Omnidirectional vehicles only: Measured speed along the body Y axis (Invalid: NaN If not omnidirectional)
adjusted_speed_body_y_setpoint float32 m/s [Body] [-inf (Left) : inf (Right)] Omnidirectional vehicles only: Speed setpoint along the body Y axis that is being tracked (Applied slew rates) (Invalid: NaN If not omnidirectional)
pid_thrust_body_y_integral float32 [-1 : 1] Omnidirectional vehicles only: Integral of the PID for the closed loop controller of the speed along the body Y axis (Invalid: NaN If not omnidirectional)

Source Message

Source file (GitHub)

::: details Click here to see original file

# Surface Vehicle Speed Status
#
# Status of the speed controller of surface vehicles, on land or on water (rovers, boats).
# Published by the speed controllers of rover_ackermann, rover_differential and rover_mecanum
# while they track surface_vehicle_speed_setpoint, for logging and tuning.
# Not consumed by other modules.

uint64 timestamp # [us] Time since system start
float32 measured_speed_body_x # [m/s] [@range -inf (Backwards), inf (Forwards)] [@frame Body] Measured speed along the body X axis
float32 adjusted_speed_body_x_setpoint # [m/s] [@range -inf (Backwards), inf (Forwards)] [@frame Body] Speed setpoint along the body X axis that is being tracked (Applied slew rates)
float32 pid_thrust_body_x_integral # [-] [@range -1, 1] Integral of the PID for the closed loop controller of the speed along the body X axis
float32 measured_speed_body_y # [m/s] [@range -inf (Left), inf (Right)] [@frame Body] [@invalid NaN If not omnidirectional] Omnidirectional vehicles only: Measured speed along the body Y axis
float32 adjusted_speed_body_y_setpoint # [m/s] [@range -inf (Left), inf (Right)] [@frame Body] [@invalid NaN If not omnidirectional] Omnidirectional vehicles only: Speed setpoint along the body Y axis that is being tracked (Applied slew rates)
float32 pid_thrust_body_y_integral # [-] [@range -1, 1] [@invalid NaN If not omnidirectional] Omnidirectional vehicles only: Integral of the PID for the closed loop controller of the speed along the body Y axis

:::