Commit Graph
23 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 FritscheandHamish Willee e4212fe915 docs(concept): add navigation terminology page (#29347)
* docs(concept): add navigation terminology page

Heading, course, track, bearing and drift have caused friction because
aviation and marine navigation use the same words with different
meanings, and PX4 code mixes both. Collect the official ICAO, FAA,
Bowditch, IHO and NMEA definitions in one place, together with the
reference frames, a precedence rule for conflicting terms, and a
separate section for where PX4 represents things differently (radians,
local map projection, signed cross-track error, wind vectors, deviating
field names), so that new code sticks to the official terminology.

Graphics are placeholders for now.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* docs(concept): add ground vehicle terms to navigation terminology

ISO 8855 and SAE J670 reuse navigation words with different meanings:
the course angle is the actual direction of motion, and the vehicle
sideslip angle is ground-referenced, unlike the aerodynamic one. Add
the ground vehicle standards as a source, extend the precedence rule
and conflicts table, cover the z-up vehicle frames, and list the rover
names that use "bearing" for a course setpoint.

Also tone down the boat statement in the intro, as boat support is
still minimal.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* Add ground vehicle references

* fix(docs): add navigation nomenclature overview

* fix(docs): hide not yet used nomenclature

* feat(docs): navigation docs update overview image

* feat(docs): split navigation terminology doc into main and advanced page

* feat(docs): navigation terminology update overview image

* fix(docs): navigation terminology clarify heading and desired track definitions

* fix(docs): clean up navigation terminology tab

* fix(docs): clean up navigation_terminology.md

* fix(docs): clean up navigation_terminology_advanced.md

* fix(docs): correct navigation terminology field and range claims

position_controller_status.nav_bearing and xtrack_error have had no
producer since the fixed-wing position controller rework, so
NAV_CONTROLLER_OUTPUT forwards zeros; say so instead of describing
them as live values. Not all uORB angles are wrapped to [-pi, pi]
(transponder_report.heading is [0, 2pi]), Ackermann and differential
rovers use bearing_setpoint as a heading setpoint, and
estimator_innovations.beta is an innovation, not the sideslip angle.

Drop the FLU to FRD conversion note, which was wrong for ROS yaw and
does not belong on a terminology page, replace the caption of the
missing track frame figure with a TODO, and apply prettier.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* docs(concept): update navigation_terminology page

* docs(concept): navigation terminology add course / course setpoint distinction vs course / course over ground

* docs(concept): navigation terminology - add detail images

* docs(concept): fix navigation terminology review findings

Fix issues found in review of the navigation terminology pages:

- Figures: make the SVGs visible in dark mode, draw the course setpoint
  pointing back towards the desired track (as NPFG commands it) rather
  than along it, match the track's end direction to the course, add an
  illustrative future track, and fix clipped and mis-spaced labels.
- Links: avoid in-page links into the collapsed details block, link the
  summary table fields and first uses of estimator, NPFG, pure pursuit
  and mecanum rovers.
- Accuracy: MAVLink headings are in centidegrees, the bearing example is
  the current (not next) waypoint, magnetometer calibration is applied
  by the sensors module, and only Ackermann/mecanum use bearing_setpoint.
- Style: rename "the norms" to "official definitions", remove casual
  bold emphasis, fix heading levels, British spelling, and one sentence
  per line.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>

* docs(concept): apply suggestion on px4 path follow computation

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>

* docs(concept): pull user-facing notes from advanced navigation terminology

Readers operating, tuning or reading logs should not need the advanced
page, so add the rover reversing case, the sideslip/drift naming hint,
and the user-facing names that don't match the terminology.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* docs(concept): split local frame into tangent-plane and navigation frames

Local positions are a projection in the tangent-plane frame at the
estimator origin, while velocities and attitude are relative to the
north-east-down frame at the vehicle. Describe both, keeping the main
page short and the details on the advanced page.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* docs(agents): point to navigation terminology before naming nav fields

Keep new code, uORB fields, parameters and docs from drifting away from
the agreed heading/course/track/bearing definitions again.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Michael Fritsche <frimi999@gmail.com>

* docs(concept): address review comments by mbjd

---------

Signed-off-by: Michael Fritsche <frimi999@gmail.com>
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-11-10 10:12:17 +01:00
Andrea Bernasconi b38dcb1f6c fix(navigator): use "Return" instead of "RTL" in user-facing text (#28543) 2026-09-26 12:40:56 +10:00
Beniamino Pozzan 92d54bce01 docs(ros2): global rename of "ROS2" into "ROS 2" (#28358)
Signed-off-by: Beniamino Pozzan <beniamino.pozzan@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-08-26 16:32:29 +10:00
jonas 6b03d30fb7 refactor(navigator): split mission_route_cache into its own PR 2026-07-27 08:28:45 +02:00
jonas 62c644465b feat(navigator): create the infrastructure for smart mission join and route-following RTL 2026-07-27 08:28:45 +02:00
Hamish Willee 96e760a782 docs(docs): Fix almost all broken external links (#27790)
* docs(docs): Add missing uorb topics sidebar
* docs(docs): discontinue cuav v5 plus/nano
* docs(docs): Fix 404 and 303 status HTTP links
* docs(docs): more link fixes
* update(drivers): Docs fix to fix up link
* docs(docs): Fix up all remaining  broken links and add exclusions
2026-07-02 16:58:40 +10:00
Aditya BidwaiandHamish Willee 0861ba0088 fix(docs): invert vectorized diagram SVGs in dark mode (#27574)
* fix(docs): invert vectorized diagram SVGs in dark mode

* docs(docs): Apply fix as a class

* Add yarn lock to fix CI

---------

Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-06-24 14:20:57 +10:00
Silvan Fuhrer cd89fe9967 docs(docs): MC remove mention of removed smoothVel POS_MODE (#25913) 2026-05-27 20:34:51 +10:00
Hamish Willee b37733459d docs: Codespell check on English sources + swd fixes (#26657) 2026-03-05 12:50:59 +11:00
Hamish Willee c0af8b9952 docs: Link fixes such as 301 redirects (#26586) 2026-02-26 18:33:37 +11:00
Hamish Willee 539b1def78 docs: Numerous spelling and grammer fixes in flight controller section (#26582) 2026-02-26 11:53:44 +11:00
PX4BuildBot 36b5e1e1bb docs: auto-sync metadata [skip ci]
Co-Authored-By: PX4 BuildBot <bot@px4.io>
2026-02-11 22:43:01 +00:00
Connor Denihan 9a6e4b5ace docs: Fix capitalization of macOS (#25744)
* Fix formatting and capitalization in dev_env_mac.md

Updated formatting and capitalization for consistency in the macOS development environment documentation.

* Correct 'Mac OS' to 'macOS' in documentation

* Fix capitalization of 'macOS' in documentation
2025-10-11 14:23:55 -08:00
Hamish Willee d1da30911e Update metadata and tidy a few docs (#25547)
* Fix up metadata except for uorb graphs

* Additional customization of startup tidy
2025-09-11 16:06:51 +10:00
Alexander Lerach 138427b3a8 config: add dynamic init file
* config: add dynamic init file

* added review feedback

* added docs
2025-08-21 16:46:06 +02: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 5d5e23bcfa [Docs] Fix links and tidy config (#25184)
* Fix links and tidy config

* Add updated lock files
2025-07-10 16:11:58 +10:00
Hamish Willee 2c31e2bad5 Fix all possible HTTP to HTTPS docs links (#25153) 2025-07-03 18:09:58 +10:00
Hamish Willee 375f421c61 Link fixes galore (#25151) 2025-07-03 14:53:12 +10:00
Hamish Willee 3a54b482d2 Fix up cross links 2025-06-25 13:03:46 +10:00
Matthias Grob df65e5bced docs events_interface: fix entire paragraph being declared code by accident (#24860) 2025-05-16 08:40:21 +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