Commit Graph
17 Commits
Author SHA1 Message Date
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
Michael Fritsche ec454b9a9b feat(msg): rename shared rover topics to surface_vehicle_* (#29524)
Signed-off-by: Michael Fritsche <frimi999@gmail.com>
2026-11-04 15:21:37 +01:00
Isak Åslund 7902349f7a fix(mc_att_control): reject invalid attitude setpoints (#29008)
* fix(mc_att_control): ignore invalid attitude setpoints in the reference model

Since the reference model (2a0e048171, PR #27255) the controller tracks _q_ref,
which is integrated from its previous value and only snapped to the setpoint on
the first call. A single attitude setpoint with a zero or non-finite quaternion
(normalizing a zero quaternion gives NaN) therefore makes _q_ref NaN for the rest
of the boot: every later setpoint is ignored, the rate setpoint stays NaN and the
vehicle has no attitude control, even after a mode switch. Before the reference
model the controller used q_d directly, so a bad sample only lasted one cycle.

One MAVLink SET_ATTITUDE_TARGET with q = [0, 0, 0, 0] in Offboard reproduces it
in SIH: vehicle_rates_setpoint stays NaN and the vehicle no longer responds to
the sticks after switching to Position mode.

Ignore setpoints and heading-reset deltas that are zero or non-finite, keeping
the last valid reference, and snap the reference to the next valid setpoint if
it ever becomes non-finite.

Signed-off-by: Isak Åslund <isak.aslund@airolit.com>

* fix(mc_att_control): drop the whole attitude setpoint when its quaternion is invalid

When the controller rejects an invalid quaternion, the thrust and timestamp
from the same message were still applied. The vehicle then flew the last
valid attitude with thrust from a message that cannot be trusted.

setAttitudeSetpoint() now returns whether the setpoint was accepted. The
thrust and the setpoint timestamp are only updated when it was. Keeping the
timestamp also gives the next valid setpoint the true dt since the last
accepted one.

Signed-off-by: Isak Åslund <isak.aslund@airolit.com>

* fix(mc_att_control): reject overflowing quaternions and drop invalid SET_ATTITUDE_TARGET

Review follow-ups:
- Validate the setpoint through its norm. A quaternion with a finite component
  above ~1.8e19 (e.g. q = (1e20, 0, 0, 0)) passed isAllFinite(), its norm
  overflowed to inf and normalizing it gave a zero quaternion. As the first
  setpoint this made the reference NaN for the next setpoint. One finite norm
  check rejects NaN, inf, zero and overflow.
- Drop the ref_valid / dt finiteness recovery branch: with every input of the
  reference model validated it cannot be reached, and it costs flash.
- Drop the adaptAttitudeSetpoint() guard: no estimator publishes an invalid
  delta with a changed reset counter, and it only protected the reference,
  not the yaw setpoint and StickYaw that use the same delta.
- MAVLink SET_ATTITUDE_TARGET: drop a message with an unusable q before
  publishing offboard_control_mode. Otherwise a companion streaming only
  invalid quaternions keeps the offboard heartbeat alive and the vehicle holds
  the last valid tilt and thrust indefinitely without triggering
  COM_OF_LOSS_T.

Signed-off-by: Isak Åslund <isak.aslund@airolit.com>

* docs(offboard): note that SET_ATTITUDE_TARGET with an invalid q is dropped

Since the previous commit, such a message no longer counts as the offboard
signal, which is a behavior change MAVLink users can see. Also name the 1e-3
norm threshold in the setAttitudeSetpoint() doc, and point the MAVLink and
controller checks at each other: if the MAVLink threshold were lowered below
the controller's, messages the controller drops would keep offboard alive.

Signed-off-by: Isak Åslund <isak.aslund@airolit.com>

---------

Signed-off-by: Isak Åslund <isak.aslund@airolit.com>
2026-10-09 16:25:05 -06:00
Ramon Roche 5062756be4 docs(offboard): correct fixed-wing velocity and BODY_NED support
Velocity setpoints are not ignored on fixed-wing. When combined with a
position setpoint, FixedWingModeManager selects FW_POSCTRL_MODE_AUTO_PATH
and follows a path through the position tangent to the horizontal
velocity direction, with the acceleration component normal to the
velocity used as path curvature.

Velocity-only setpoints are not supported: offboard without a position
setpoint clears flag_control_position_enabled, so set_control_mode_current
falls through to FW_POSCTRL_MODE_OTHER and no new lateral/longitudinal
setpoints are published. Since MAV_FRAME_BODY_NED always discards the
position, it cannot be used for fixed-wing.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-09-28 11:47:03 -07:00
Ramon Roche 6152abde11 docs(offboard): clarify BODY_NED applies to velocity and acceleration setpoints only
BODY_NED position setpoints have never been supported: the receiver
rotates velocity and acceleration into the local frame and sets
position to NAN, and for fixed-wing (position setpoints only) the
frame cannot be used at all. The docs listed input combinations and
coordinate frames as independent lists, implying every combination
works in every frame, which misled users into filing #27617.

Also update stale code links still pointing at FlightTaskOffboard.cpp,
removed in the v1.12 offboard rework (#16739).

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-09-28 11:47:03 -07:00
Hamish Willee 0eb7984e17 docs(tools): Mode Requirements detailed docs (#26084) 2026-08-06 16:03:39 +10:00
PX4BuildBot f0c127e5f7 docs: auto-sync metadata [skip ci]
Co-Authored-By: PX4 BuildBot <bot@px4.io>
2026-07-01 13:06:45 +00:00
Gennaro GuidoneandMatthias Grob b8c5f66af0 feat(manual_control): replace stick override threshold with double-flick gesture (#27041)
* feat(manual_control): trigger RC override on stick velocity

COM_RC_STICK_OV is now a velocity threshold (1/s) instead of a deflection percentage.
Default 3.0, range [1.0, 10.0]. A stick held statically cannot trigger override.

* docs(manual_control): update COM_RC_STICK_OV description for velocity-based override

* feat(manual_control): gate RC override with sign-consistency check

* fix(ManualControl): lower threshold and filter constant for RC override, add tests for MovingDiff

* refactor(commander): merge RC override params into COM_RC_OVR_SPEED

Replace the COM_RC_OVERRIDE bitmask + COM_RC_STICK_OV threshold with a
single float COM_RC_OVR_SPEED (stick override velocity, 0 = disabled).
Override now applies uniformly in auto and offboard modes.

- ManualControl: rename param, treat 0 as disabled (FLT_EPSILON guard)
- Commander: drop the per-mode bitmask gate and the RcOverrideBits enum
- param_translation: migrate COM_RC_OVERRIDE on import (enabled -> 1.0,
  disabled -> 0.0) and drop the unit-incompatible COM_RC_STICK_OV value
- docs: collapse the two params into one across the mode pages

* fix(manual_override): Move configuration to manual_control module

with MAN_OVERRIDE_SPD parameter and a negative value disabling the feature. All other logic stays in Commander.

* docs(releases): add release note for RC override rework (MAN_OVERRIDE_SPD)

---------

Co-authored-by: Matthias Grob <maetugr@gmail.com>
2026-07-01 14:59:52 +02:00
Sijia d018063b19 docs(failsafe): clarify Offboard proof-of-life and COM_OBL_RC_ACT docs (#27636) 2026-06-11 15:15:37 +10:00
Hamish Willee 323c623e34 docs(docs):Fixes that prettier does not handle well (#27212) 2026-04-26 14:30:02 +10:00
Beniamino Pozzan 0831782d3a docs(offboard): highlight ROS 2 offboard control risks (#26762) 2026-04-08 15:20:23 +10:00
Hamish Willee 4226b7d4ec docs: Manual control updates to reflect prioritised selection (#25835) 2026-02-25 10:43:19 +11:00
fakerrorandHamish Willee 4117912506 docs: clarify rover MAVLink offboard support (#26411)
* docs: clarify rover MAVLink offboard support

* Apply suggestion from @hamishwillee

---------

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-02-12 16:25:12 +11:00
chfriedrich98andHamish Willee 66b07d8219 Docs: Rover API (#25499)
* docs: add RoverSetpointTypes

* docs: add rover api

* docs: remove rover offboard mavlink support

* docs: fix broken links

* Apply suggestion from @hamishwillee

---------

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2025-09-26 10:33:35 +10:00
Hamish Willee 8e0f223b3a Link fixes and removal of dead docs (#25239)
* Remove Zubax Orel - not available and no other presence

* Fix up zubax product links

* Snapdragon flight - delete as no longer relevant hardware

* Delete intel aero docs

* Brushless whoop - remove docs except for link to old version

* Many link fixes
2025-07-17 15:30:56 +10:00
Hamish Willee 2c31e2bad5 Fix all possible HTTP to HTTPS docs links (#25153) 2025-07-03 18:09:58 +10:00
Hamish WilleeandRamon Roche 88d623bedb Move PX4 Guide source into /docs (#24490)
* Add vitepress tree

* Update existing workflows so they dont trigger on changes in the docs path

* Add nojekyll, package.json, LICENCE etc

* Add crowdin docs upload/download scripts

* Add docs flaw checker workflows

* Used docs prefix for docs workflows

* Crowdin obvious fixes

* ci: docs move to self hosted runner

runs on a beefy server for faster builds

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: don't run build action for docs or ci changes

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: update runners

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* Add docs/en

* Add docs assets and scripts

* Fix up editlinks to point to PX4 sources

* Download just the translations that are supported

* Add translation sources for zh, uk, ko

* Update latest tranlsation and uorb graphs

* update vitepress to latest

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Ramon Roche <mrpollo@gmail.com>
2025-03-13 16:08:27 +11:00