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>
2026-10-03 14:08:52 +08:00 · 2025-03-13 16:08:27 +11:00
parent 8e6d2ebe4a
commit 88d623bedb
5176 changed files with 558771 additions and 2 deletions
@@ -0,0 +1,47 @@
+# Sensor Hardware & Setup
+
+This section describes the mandatory and optional sensors and their setup/configuration.
+
+## Overview
+
+PX4-based systems use sensors to estimate vehicle state, which is needed for stabilization and to enable autonomous control.
+Vehicle state information includes: position/altitude, heading, speed, airspeed, orientation (attitude), rates of rotation in different directions, battery level, and so on.
+
+PX4 _minimally requires_ a gyroscope, accelerometer, magnetometer (compass), and barometer to measure the above states.
+Fixed-wing and VTOL-vehicles _should_ also include an airspeed sensor.
+A GPS or other positioning system is needed to enable all automatic modes, and some manual/assisted modes.
+
+[Pixhawk Series](../flight_controller/pixhawk_series.md) flight controllers already have the minimum set of sensors (other controller platforms often do too).
+Additional/external sensors can be attached to the controller — an external GPS and compass are recommended, along with an airspeed sensor for VTOL and Fixed wing vehicles.
+
+## Sensor Topics
+
+Mandatory (included in Pixhawk series FCs):
+
+- [Accelerometer](../sensor/accelerometer.md) — Measures changing acceleration.
+- [Gyroscope](../sensor/gyroscope.md) — Measures orientation.
+- [Magnetometer (Compass)](../gps_compass/magnetometer.md) — Measures heading/direction.
+  External compass recommended!
+- [Barometers](../sensor/barometer.md) — Measures altitude (via air pressure).
+
+Recommended:
+
+- [Airspeed Sensors](../sensor/airspeed.md) — Measures airspeed.
+  Highly recommended for VTOL and Fixed-wing as they are the only mechanism to detect stall.
+- [GNSS (GPS)](../gps_compass/index.md) — Measures global position.
+  Needed for missions, and some other automatic and manual/assisted modes.
+- [RTK GNSS (GPS)](../gps_compass/rtk_gps.md) — GNSS with centimetre-level accuracy.
+  Some setups also allow heading to be determine from GNSS rather than a magnetometer.
+
+Optional:
+
+- [Distance Sensors (Rangefinders)](../sensor/rangefinders.md) — Measures distance to target.
+  Aids landing, object avoidance, and terrain following.
+- [Optical Flow](../sensor/optical_flow.md) — Estimates velocity using a downward facing camera and a downward facing distance sensor.
+  Enables a more accurate position lock than GPS alone, and can be used indoors when no GPS signal is available.
+- [Tachometers (Revolution Counters)](../sensor/tachometers.md) — Only used for logging.
+
+Other optional:
+
+- [IMU/Compass Factory Calibration](../advanced_config/imu_factory_calibration.md) — Save calibration settings to persistent storage.
+- [Sensor Thermal Compensation](../advanced_config/sensor_thermal_calibration.md) — Compensate sensors for temperature variations.