Files
PX4-Autopilot/docs/en/modules/modules_estimator.md
T
Alex E 59fa7a4a7d docs(modules): add auto-generated disclaimer to every module reference page (#29673)
Only modules_main.md told readers that the module reference is generated
from source. The per-category pages (modules_driver.md, modules_system.md,
...) and the per-subcategory pages (modules_driver_imu.md, ...) had no such
note, so contributors kept fixing typos directly in docs/en/modules/ and
the next metadata sync silently reverted them (see #29614).

Emit a `::: info` block right under the H1 of every category and
subcategory page. The wording follows the existing disclaimers on the
airframe reference and the uORB message index: it links to the generator
script and names the `make module_documentation` target.

docs/en/modules/*.md are regenerated with the updated generator and run
through Prettier, mirroring what the docs-orchestrator metadata sync does
on main, so the diff is only the new note.

Fixes #29624

Assisted-by: Claude:claude-fable-5-1

Signed-off-by: Alex E <aelejandro9@gmail.com>
2026-11-10 08:51:33 +11:00

3.1 KiB

Modules Reference: Estimator

::: info This page is auto-generated from the source code using the build command: make module_documentation. Do not edit it directly; fix the module documentation in the PX4-Autopilot source instead. :::

AttitudeEstimatorQ

Source: modules/attitude_estimator_q

Description

Attitude estimator q.

Usage

AttitudeEstimatorQ <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

airspeed_estimator

Source: modules/airspeed_selector

Description

This module provides a single airspeed_validated topic, containing indicated (IAS), calibrated (CAS), true airspeed (TAS) and the information if the estimation currently is invalid and if based sensor readings or on groundspeed minus windspeed. Supporting the input of multiple "raw" airspeed inputs, this module automatically switches to a valid sensor in case of failure detection. For failure detection as well as for the estimation of a scale factor from IAS to CAS, it runs several wind estimators and also publishes those.

Usage

airspeed_estimator <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

ekf2

Source: modules/ekf2

Description

Attitude and position estimator using an Extended Kalman Filter. It is used for Multirotors and Fixed-Wing.

The documentation can be found on the ECL/EKF Overview & Tuning page.

ekf2 can be started in replay mode (-r): in this mode, it does not access the system time, but only uses the timestamps from the sensor topics.

Usage

ekf2 <command> [arguments...]
 Commands:
   start
     [-r]        Enable replay mode

   stop

   status        print status info
     [-v]        verbose (print all states and full covariance matrix)

   select_instance Request switch to new estimator instance
     <instance>  Specify desired estimator instance

local_position_estimator

Source: modules/local_position_estimator

Description

Attitude and position estimator using an Extended Kalman Filter.

Usage

local_position_estimator <command> [arguments...]
 Commands:
   start

   stop

   status        print status info

mc_hover_thrust_estimator

Source: modules/mc_hover_thrust_estimator

Description

Usage

mc_hover_thrust_estimator <command> [arguments...]
 Commands:
   start

   stop

   status        print status info