Files
PX4-Autopilot/docs
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
..
2026-11-09 21:59:58 +00:00
…
…
…
…
…
…

PX4 User Guide

This repo contains the source code for the PX4 User Guide.

Note

Contributions and Translations to this guide are very welcome!