[Docs] Fix links and tidy config (#25184)

* Fix links and tidy config

* Add updated lock files
This commit is contained in:
Hamish Willee 2025-07-10 16:11:58 +10:00 committed by GitHub
parent 6855aa57c4
commit 5d5e23bcfa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
50 changed files with 1261 additions and 1084 deletions

View File

@ -211,7 +211,7 @@ export default defineConfig({
],
},
async transformHead({ page, siteData, pageData, title }) {
async transformHead({ pageData }) {
// Start with an empty array to accumulate all head tags
const head = [];

View File

@ -179,8 +179,6 @@
- [Wiring Quickstart](assembly/quick_start_durandal.md)
- [Holybro Pix32 v5](flight_controller/holybro_pix32_v5.md)
- [Wiring Quickstart](assembly/quick_start_holybro_pix32_v5.md)
- [ModalAI Flight Core v1](flight_controller/modalai_fc_v1.md)
- [ModalAI VOXL Flight](flight_controller/modalai_voxl_flight.md)
- [ModalAI VOXL 2](flight_controller/modalai_voxl_2.md)
- [mRo Control Zero F7](flight_controller/mro_control_zero_f7.md)
- [Sky-Drones AIRLink](flight_controller/airlink.md)
@ -205,6 +203,8 @@
- [Holybro Kakute F7](flight_controller/kakutef7.md)
- [Holybro Pixfalcon](flight_controller/pixfalcon.md)
- [Holybro pix32 (FMUv2)](flight_controller/holybro_pix32.md)
- [ModalAI Flight Core v1](flight_controller/modalai_fc_v1.md)
- [ModalAI VOXL Flight](flight_controller/modalai_voxl_flight.md)
- [mRo X2.1 (FMUv2)](flight_controller/mro_x2.1.md)
- [mRo AUAV-X2](flight_controller/auav_x2.md)
- [NXP RDDRONE-FMUK66 FMU](flight_controller/nxp_rddrone_fmuk66.md)

View File

@ -245,7 +245,7 @@ Note that Pic2Map is limited to only 40 images.
### Reconstruction
We use [Pix4D](https://pix4d.com/) for 3D reconstruction.
We use [Pix4D](https://www.pix4d.com/) for 3D reconstruction.
![GeoTag](../../assets/camera/geotag.jpg)

View File

@ -20,7 +20,7 @@ This guide walks through the process of setting up the board and connecting to P
You will temporarily need the following hardware in order to log into your Jetson and get its IP address, after which you will be able to log in via SSH:
- External display.
If your display doesn't have a mini HDMI connector you will also need a [Mini HDMI to HDMI converter](https://a.co/d/6N815N9) if your external display has HDMI input
If your display doesn't have a mini HDMI connector you will also need a [Mini HDMI to HDMI converter](https://www.amazon.com/dp/B014I8UEGY/) if your external display has HDMI input
- Ethernet cable
- Mouse and keyboard (the baseboard has 4 USB ports exposed from Jetson, two of which are USB 3.0)

View File

@ -35,7 +35,7 @@ The main hardware documentation is here: https://wiki.bitcraze.io/projects:crazy
## Where to Buy
- [Crazyflie 2.0](https://store.bitcraze.io/collections/kits/products/crazyflie-2-0).
- [Crazyradio PA 2.4 GHz USB dongle](https://store.bitcraze.io/collections/kits/products/crazyradio-pa): used for wireless communication between _QGroundControl_ and Crazyflie 2.0.
- [Crazyradio PA 2.4 GHz USB dongle](https://store.bitcraze.io/products/crazyradio-pa): used for wireless communication between _QGroundControl_ and Crazyflie 2.0.
- [Breakout deck](https://store.bitcraze.io/collections/decks/products/breakout-deck): breakout expansion board for connecting new peripherals.
- [Flow deck](https://store.bitcraze.io/collections/decks/products/flow-deck): contains an optical flow sensor to measure movements of the ground and a distance sensor to measure the distance to the ground.
This will be useful for precise altitude and position control.
@ -194,7 +194,7 @@ python cfbridge.py
::: info
_Cfbridge_ by default tries to initiate the radio link communication on channel 80 and with crazyflie address 0xE7E7E7E7E7.
If you are using [multiple crazyflies and/or crazyradios](https://github.com/dennisss/cfbridge/blob/master/index.md#advanced-swarming) in the same room and want to use a different channel and/or address for each, first connect the crazyflie with QGroundControl via a USB cable and change the syslink parameters (channel, address) in QGroundControl.
If you are using [multiple crazyflies and/or crazyradios](https://github.com/dennisss/cfbridge/blob/master/README.md#advanced-swarming) in the same room and want to use a different channel and/or address for each, first connect the crazyflie with QGroundControl via a USB cable and change the syslink parameters (channel, address) in QGroundControl.
Next, launch the cfbridge by giving the same channel and address as the first and second arguments respectively, e.g: `python cfbridge.py 90 0x0202020202`
:::

View File

@ -40,7 +40,7 @@ The vehicle can be purchased here: [Crazyflie 2.1](https://store.bitcraze.io/pro
Useful peripheral hardware includes:
- [Crazyradio PA 2.4 GHz USB dongle](https://store.bitcraze.io/collections/kits/products/crazyradio-pa): Wireless communication between _QGroundControl_ and Crazyflie 2.0
- [Crazyradio PA 2.4 GHz USB dongle](https://store.bitcraze.io/products/crazyradio-pa): Wireless communication between _QGroundControl_ and Crazyflie 2.0
- [Breakout deck](https://store.bitcraze.io/collections/decks/products/breakout-deck): Breakout expansion board for connecting new peripherals.
- [Flow deck v2](https://store.bitcraze.io/collections/decks/products/flow-deck-v2): Optical flow sensor and a distance sensor for altitude and position control.
- [Z-ranger deck v2](https://store.bitcraze.io/collections/decks/products/z-ranger-deck-v2): Distance sensor for altitude control (same sensor as the Flow deck).
@ -210,7 +210,7 @@ To connect Crazyflie 2.1 with crazyradio, **launch cfbridge** by following these
::: info
_Cfbridge_ by default tries to initiate the radio link communication on channel 80 and with crazyflie address 0xE7E7E7E7E7.
If you are using [multiple crazyflies and/or crazyradios](https://github.com/dennisss/cfbridge/blob/master/index.md#advanced-swarming) in the same room and want to use a different channel and/or address for each, first connect the crazyflie with QGroundControl via a USB cable and change the syslink parameters (channel, address) in QGroundControl.
If you are using [multiple crazyflies and/or crazyradios](https://github.com/dennisss/cfbridge/blob/master/README.md#advanced-swarming) in the same room and want to use a different channel and/or address for each, first connect the crazyflie with QGroundControl via a USB cable and change the syslink parameters (channel, address) in QGroundControl.
Next, launch the cfbridge by giving the same channel and address as the first and second arguments respectively, e.g: `python cfbridge.py 90 0x0202020202`
:::

View File

@ -12,19 +12,16 @@ You can find others on [px4.io](https://px4.io/ecosystem/commercial-systems/) an
This section lists drone kits that are intended as platforms for further development.
They may come either fully assembled or in parts.
- [ModalAI VOXL 2 Starling PX4 Development Drone](../complete_vehicles_mc/modalai_starling.md) - SLAM development drone supercharged by VOXL 2 and PX4.
- [PX4 Vision DevKit](../complete_vehicles_mc/px4_vision_kit.md) - Multicopter used for PX4 computer vision development
- ~[ModalAI VOXL 2 Starling PX4 Development Drone](../complete_vehicles_mc/modalai_starling.md)~ (Discontinued/superseded) - SLAM development drone supercharged by VOXL 2 and PX4.
## PX4 Preinstalled
This section lists vehicles that are sold fully assembled and ready to fly (RTF), with PX4 installed.
- [ModalAI Starling](../complete_vehicles_mc/modalai_starling.md)
- [ModalAI Sentinel](https://www.modalai.com/sentinel)
- [MindRacer 210](../complete_vehicles_mc/mindracer210.md)
- [NanoMind 110](../complete_vehicles_mc/nanomind110.md)
- [Amovlab F410](../complete_vehicles_mc/amov_F410_drone.md)
- [Teal One](https://px4.io/project/teal-one/) ([superseded](https://tealdrones.com/solutions/teal-2/))
## PX4 Compatible
@ -32,7 +29,6 @@ This section lists vehicles where you can update the software to run PX4.
- [Holybro Kopis 2](../complete_vehicles_mc/holybro_kopis2.md)
- [Bitcraze Crazyflie 2.1](../complete_vehicles_mc/crazyflie21.md)
- [BetaFPV Beta75X 2S Brushless Whoop](../complete_vehicles_mc/betafpv_beta75x.md) (discontinued)
## Custom PX4
@ -40,8 +36,8 @@ This section contains consumer vehicles that run a _custom_ version of PX4 (supp
These may or may not be updatable to run "vanilla" PX4.
- [Yuneec Typhoon H Plus](https://us.yuneec.com/typhoon-h-plus/)
- [Yuneec Mantis Q](https://px4.io/portfolio/yuneec-mantis-q/)
- [Yuneec H520](https://px4.io/portfolio/yuneec-h520-hexacopter/)
- [Yuneec Mantis Q](https://px4.io/project/yuneec-mantis-q/)
- [Yuneec H520](https://px4.io/project/yuneec-h520-hexacopter/)
- [AeroSense Aerobo (AS-MC02-P)](https://px4.io/project/aerosense-aerobo/)
## See Also

View File

@ -381,7 +381,7 @@ The carrier board pinouts and other information are in the [downloads section](h
## Other Development Resources
- [_UP Core_ Wiki](https://github.com/up-board/up-community/wiki/Ubuntu) - _Up Core_ companion computer technical information
- [Occipital Developer Forum](https://structure.io/developers) - _Structure Core_ camera information
- [Occipital Developer Forum](https://structure.io/developers/) - _Structure Core_ camera information
- [Pixhawk 4 Overview](../flight_controller/pixhawk4.md)
- [Pixhawk 6C Overview](../flight_controller/pixhawk6c.md)

View File

@ -4,7 +4,7 @@
The [Aion R1](https://www.aionrobotics.com/) vehicle was chosen to test and improve the differential drive support for PX4, and to improve driver support for Roboclaw Motor Controllers, such as the [RoboClaw 2x15A](https://www.basicmicro.com/RoboClaw-2x15A-Motor-Controller_p_10.html).
The documentation and driver information here should also make it easier to work with Roboclaw controllers on other vehicles, and to work with vehicles like the [Aion R6](https://www.aionrobotics.com/r6).
The documentation and driver information here should also make it easier to work with Roboclaw controllers on other vehicle.
Currently, PX4 supports MANUAL mode for this setup.
@ -12,8 +12,7 @@ Currently, PX4 supports MANUAL mode for this setup.
## Parts List
- [Aion R1 (Discontinued)](https://www.aionrobotics.com/)
- [Documentation](https://github-docs.readthedocs.io/en/latest/r1-ugv.html)
- Aion R1 (Discontinued)
- [RoboClaw 2x15A](https://www.basicmicro.com/RoboClaw-2x15A-Motor-Controller_p_10.html)
- [R1 Roboclaw specifications](https://resources.basicmicro.com/aion-robotics-r1-autonomous-robot/)
- [Auterion Skynode](../companion_computer/auterion_skynode.md)
@ -50,7 +49,6 @@ Use _QGroundControl_ for rover configuration:
First configure the serial connection:
1. Navigate to the [Parameters](../advanced_config/parameters.md) section in QGroundControl.
- Set the [RBCLW_SER_CFG](../advanced_config/parameter_reference.md#RBCLW_SER_CFG) parameter to the serial port to which the RoboClaw is connected (such as `GPS2`).
- [RBCLW_COUNTS_REV](../advanced_config/parameter_reference.md#RBCLW_COUNTS_REV) specifies the number of encoder counts required for one wheel revolution.
This value should be left at `1200` for the tested `RoboClaw 2x15A Motor Controller`.

View File

@ -18,7 +18,7 @@ They may come either fully assembled or in parts.
This section lists VTOL vehicles that are sold fully assembled and ready to fly (RTF), with PX4 installed.
- [Vertical Technologies DeltaQuad](https://px4.io/portfolio/deltaquad-vtol/)
- [Vertical Technologies DeltaQuad](https://px4.io/project/deltaquad-vtol/)
<!-- ## PX4 Compatible -->
@ -27,8 +27,8 @@ This section lists VTOL vehicles that are sold fully assembled and ready to fly
This section contains consumer vehicles that run a _custom_ version of PX4 (supported by their vendors).
These may or may not be updatable to run "vanilla" PX4.
- [WingtraOne Tailsitter VTOL](https://px4.io/portfolio/wingtraone-tailsitter-vtol/)
- [Flightwave Edge](https://px4.io/portfolio/flywave-edge/)
- [WingtraOne Tailsitter VTOL](https://px4.io/project/wingtraone-tailsitter-vtol/)
- [Flightwave Edge](https://px4.io/project/flywave-edge/)
## See Also

View File

@ -42,11 +42,11 @@ Notes:
- publishes the servo trims separately so they can be added as an offset when [testing actuators](../config/actuators.md#actuator-testing) (using the test sliders).
- the output drivers:
- handle the hardware initialization and update
- use a shared library [src/libs/mixer_module](https://github.com/PX4/PX4-Autopilot/blob/main/src/lib/mixer_module).
- use a shared library [src/libs/mixer_module](https://github.com/PX4/PX4-Autopilot/tree/main/src/lib/mixer_module).
The driver defines a parameter prefix, e.g. `PWM_MAIN` that the library then uses for configuration.
Its main task is to select from the input topics and assign the right data to the outputs based on the user set `<param_prefix>_FUNCx` parameter values.
For example if `PWM_MAIN_FUNC3` is set to **Motor 2**, the 3rd output is set to the 2nd motor from `actuator_motors`.
- output functions are defined under [src/lib/mixer_module/output_functions.yaml](https://github.com/PX4/PX4-Autopilot/blob/main/src/lib/mixer_module/output_functions.yaml).
- output functions are defined under [src/lib/mixer_module/output_functions.yaml](https://github.com/PX4/PX4-Autopilot/tree/main/src/lib/mixer_module/output_functions.yaml).
- if you want to control an output from MAVLink, set the relevant output function to **Offboard Actuator Set x**, and then send the [MAV_CMD_DO_SET_ACTUATOR](https://mavlink.io/en/messages/common.html#MAV_CMD_DO_SET_ACTUATOR) MAVLink command.
## Adding a new Geometry or Output Function

View File

@ -377,7 +377,7 @@ The following functions can only be applied to FMU outputs:
Enabled when [`PPS_CAP_ENABLE==0`](../advanced_config/parameter_reference.md#PPS_CAP_ENABLE)
::: info
The functions are defined in source at [/src/lib/mixer_module/output_functions.yaml](https://github.com/PX4/PX4-Autopilot/blob/main/src/lib/mixer_module/output_functions.yaml).
The functions are defined in source at [/src/lib/mixer_module/output_functions.yaml](https://github.com/PX4/PX4-Autopilot/tree/main/src/lib/mixer_module/output_functions.yaml).
This list is correct at PX4 v1.15.
:::
@ -501,7 +501,6 @@ For each motor:
- If the motor spins, reduce the corresponding PWM `disarmed` value in the [Actuator Outputs](#actuator-outputs) section to below the level at which it still spins.
2. Slowly move the slider up until it snaps to the _minimum_ position.
In this position the motor is set to the outputs `minimum` value.
- Verify that the motor is spinning very slowly in this position.
- If the motor is not spinning, or spinning too fast you will need to adjust the corresponding PWM `minimum` value in the [Actuator Outputs](#actuator-outputs) such that the motors barely spin.
@ -511,7 +510,6 @@ For each motor:
:::
3. Increase the slider value to a level where you can verify that the motor is spinning in the correct direction and that it would give a positive thrust in the expected direction.
- The expected thrust direction can vary by vehicle type.
For example in multicopters the thrust should always point upwards, while in a fixed-wing vehicle the thrust will push the vehicle forwards.
- For VTOL, thrust should point upwards when the Tilt Servo is at 0 degrees as defined the [Tilt Servo Convention](#tilt-servo-coordinate-system).
@ -549,7 +547,6 @@ To set these up:
![Control Surface Disarmed 1500 Setting](../../assets/config/actuators/control_surface_aileron_setup.png)
2. Move the slider for the surface upwards (positive command) and verify that it moves in the direction defined in the [Control Surface Convention](#control-surface-deflection-convention).
- Ailerons, elevons, V-Tails, A-Tails, and other horizontal surfaces should move up.
- Rudders and other "purely vertical" surfaces should move right.
@ -560,7 +557,6 @@ To set these up:
If the control surface moves in the opposite direction, click on the `Rev Range` checkbox to reverse the range.
3. Move the slider again to the middle and check if the Control Surfaces are aligned in the neutral position of the wing.
- If it is not aligned, you can set the **Trim** value for the control surface.
::: info

View File

@ -7,7 +7,7 @@ Most other steps can be done out of order, except for [tuning](#tuning), which m
## Preconditions
Before starting you should [Download QGroundControl](https://qgroundcontrol.com/downloads/) and install it on your **desktop** computer.
Before starting you should [Download QGroundControl](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) and install it on your **desktop** computer.
Then open the QGC application menu ("Q" icon in the top-left corner) and choose **Vehicle Setup** in the _Select Tool_ popup:
![QGC Main Menu Popup: highlighting Vehicle Setup](../../assets/qgc/setup/menu_setup.png)

View File

@ -2,7 +2,7 @@
A [computer joystick](https://en.wikipedia.org/wiki/Joystick) or gamepad connected through _QGroundControl_ can be used to manually control the vehicle (_instead_ of using an [RC Transmitter](../config/radio.md)).
This approach may be used by manual control units that have an integrated ground control station (like the _UAVComponents_ [MicroNav](https://uxvtechnologies.com/ground-control-stations/micronav/) shown below).
This approach may be used by manual control units that have an integrated ground control station (like the _UAVComponents_ [MicroNav](https://www.uxvtechnologies.com/ground-control-stations/micronav) shown below).
Joysticks are also commonly used to allow developers to fly the vehicle in simulation.
![Joystick MicroNav](../../assets/peripherals/joystick/micronav.jpg)

View File

@ -193,15 +193,16 @@ The sections below cover first the trigger and then the failsafe action taken by
### Position Loss Failsafe Trigger
There are basically two mechanisms in PX4 to trigger position failsafes:
- A timeout since the last sensor data was fused that provides direct speed or horizontal position measurements. Sensors that fall into that category are: GNSS, optical flow, airspeed, VIO, auxiliary global position.
- The estimated horizontal position accuracy exceeds a certain threshold. This check is only done on hovering systems (rotary wing vehicles or VTOLs in hover phase).
The relevant parameters shown below.
| Parameter | Description |
| -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| Parameter | Description |
| -------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <a id="EKF2_NOAID_TOUT"></a>[EKF2_NOAID_TOUT](../advanced_config/parameter_reference.md#EKF2_NOAID_TOUT) | Maximum inertial dead-reckoning time, so the time after the last data sample was received of any sensor that constrains the velocity drift [microseconds]. |
| <a id="COM_POS_FS_EPH"></a>[COM_POS_FS_EPH](../advanced_config/parameter_reference.md#COM_POS_FS_EPH) | Horizontal position error threshold for hovering vehicles (Multicopters and VTOLs in hover). Fixed-wing vehicles have this value set to infinity.|
| <a id="COM_POS_FS_EPH"></a>[COM_POS_FS_EPH](../advanced_config/parameter_reference.md#COM_POS_FS_EPH) | Horizontal position error threshold for hovering vehicles (Multicopters and VTOLs in hover). Fixed-wing vehicles have this value set to infinity. |
### Position Loss Failsafe Action
@ -318,8 +319,8 @@ The [failure detector](#failure-detector), if [enabled](#CBRK_FLIGHTTERM), can a
The external trigger system must be connected to flight controller port AUX5 (or MAIN5 on boards that do not have AUX ports), and is configured using the parameters below.
::: info
External ATS is required by [ASTM F3322-18](https://webstore.ansi.org/Standards/ASTM/ASTMF332218).
One example of an ATS device is the [FruityChutes Sentinel Automatic Trigger System](https://fruitychutes.com/uav_rpv_drone_recovery_parachutes/sentinel-automatic-trigger-system.htm).
External ATS is required by [ASTM F3322-18](https://webstore.ansi.org/standards/astm/ASTMF332218).
One example of an ATS device is the [FruityChutes Sentinel Automatic Trigger System (SATS-MINI)](https://fruitychutes.com/uav_rpv_drone_recovery_parachutes/sentinel-automatic-trigger-system).
:::
| Parameter | Description |

View File

@ -84,12 +84,14 @@ It is critical that you have properly calibrated your airspeed sensor.
It is also important that you pick an airspeed that is comfortably above your airframes stall speed (check `FW_AIRSPD_MIN`) as this is currently not checked.
#### Openloop Transition Time
Parameter: [VT_F_TR_OL_TM](../advanced_config/parameter_reference.md#VT_F_TR_OL_TM)
This specifies the duration of the front transition in seconds when no airspeed feedback is available (e.g. no airspeed sensor present).
It should be set to a value which ensures that the vehicle reaches a high enough airspeed to complete the transition, e.g. airspeed should exceed [VT_ARSP_TRANS](../advanced_config/parameter_reference.md#VT_ARSP_TRANS).
#### Transition Timeout
[VT_TRANS_TIMEOUT](../advanced_config/parameter_reference.md#VT_TRANS_TIMEOUT)
This specifies the upper limit for the duration of the front transition. If the vehicle has not reached the transition airspeed after this time, then the transition will be aborted and a [Quadchute](../config/safety.md#quad-chute-failsafe) event will be triggered.
@ -152,7 +154,3 @@ When transitioning from **multirotor to fixed-wing** (transition switch is on/fi
When transitioning from **fixed-wing to multirotor** for this type of VTOL the switch is immediate so there isnt really a backing out option here, unlike for tilt rotor VTOLs.
If you want it to go back into fixed-wing you will need to go through the full transition.
If its still travelling fast this should happen quickly.
### Support
If you have any questions regarding your VTOL conversion or configuration please see [discuss.px4.io/c/px4/vtol](https://discuss.px4.io/c/px4/vtol).

View File

@ -8,10 +8,10 @@ The PX4 project uses a three-branch Git branching model:
- [beta](https://github.com/PX4/PX4-Autopilot/tree/beta) has been thoroughly tested. It's intended for flight testers.
- [stable](https://github.com/PX4/PX4-Autopilot/tree/stable) points to the last release.
We try to retain a [linear history through rebases](https://www.atlassian.com/git/tutorials/rewriting-history) and avoid the [Github flow](https://docs.github.com/en/get-started/quickstart/github-flow).
We try to retain a [linear history through rebases](https://www.atlassian.com/git/tutorials/rewriting-history) and avoid the [Github flow](https://docs.github.com/en/get-started/using-github/github-flow).
However, due to the global team and fast moving development we might resort to merges at times.
To contribute new functionality, [sign up for Github](https://docs.github.com/en/get-started/signing-up-for-github/signing-up-for-a-new-github-account), then [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository, [create a new branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository), add your [changes as commits](#commits-and-commit-messages), and finally [send a pull request](#pull-requests).
To contribute new functionality, [sign up for Github](https://docs.github.com/en/get-started/using-github/github-flow), then [fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo) the repository, [create a new branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository), add your [changes as commits](#commits-and-commit-messages), and finally [send a pull request](#pull-requests).
Changes will be merged when they pass our [continuous integration](https://en.wikipedia.org/wiki/Continuous_integration) tests.
All code contributions have to be under the permissive [BSD 3-clause license](https://opensource.org/license/BSD-3-Clause) and all code must not impose any further constraints on the use.

View File

@ -56,7 +56,7 @@ The instructions below explain how to get git and use it on your local computer.
1. Download git for your computer from [https://git-scm.com/downloads](https://git-scm.com/downloads)
1. [Sign up](https://github.com/signup) for Github if you haven't already
1. Create a copy (Fork) of the [PX4-Autopilot repo](https://github.com/PX4/PX4-Autopilot) on Github ([instructions here](https://docs.github.com/en/get-started/quickstart/fork-a-repo)).
1. Create a copy (Fork) of the [PX4-Autopilot repo](https://github.com/PX4/PX4-Autopilot) on Github ([instructions here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)).
1. Clone (copy) your forked repository to your local computer:
```sh

View File

@ -7,7 +7,7 @@
Adding a feature to PX4 follows a defined workflow. In order to share your contributions on PX4, you can follow this example.
- [Sign up](https://github.com/signup) for github if you haven't already
- Fork the PX4-Autopilot repo (see [here](https://docs.github.com/en/get-started/quickstart/fork-a-repo))
- Fork the PX4-Autopilot repo (see [here](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo))
- Clone your forked repository to your local computer
```sh

View File

@ -1,7 +1,7 @@
# Maintainer Role
Dronecode maintainers have technical leadership and responsibility for specific areas of PX4, and for other ecosystem components such as MAVLink, MAVSDK, QGroundControl, and others.
The maintainer role is defined by the community with help and supervision from the [Dronecode Foundation](https://www.dronecode.org/).
The maintainer role is defined by the community with help and supervision from the [Dronecode Foundation](https://dronecode.org/).
To find the most up-to-date maintainers list, visit [PX4-Autopilot README](https://github.com/PX4/PX4-Autopilot#maintenance-team).
@ -22,7 +22,7 @@ Once accepted every maintainers will go through the following process:
1. **Discord** server admin will grant you the `dev team` role, which gives you:
1. Basic admin privileges on discord.
2. Access to the `#maintainers` channel.
2. You will be given access to the GitHub team: "[`Dev Team`](https://github.com/orgs/PX4/teams/dev-team)" which grants you:
2. You will be given access to the GitHub team: "[`Dev Team`](https://github.com/orgs/PX4/teams/dev-team)" which grants you:
1. Permission to merge the PR of any of PX4 workspace repositories after it's approved
2. Permission to trigger GitHub actions when a new contributor opens a PR.
3. Permission to edit Issue/PR contents.

View File

@ -29,7 +29,7 @@ The Discuss Forum is much preferred because it is indexed by search engines and
If you are unsure what the problem is and you need help diagnosing
- Upload logs to [Flight Log Review](https://logs.px4.io/)
- Open a discussion on [PX4 Discuss](https://discuss.px4.io/c/flight-testing/) with a flight report and links to logs.
- Open a discussion on [PX4 Discuss](https://discuss.px4.io/c/flight-testing/10) with a flight report and links to logs.
- The dev team may prompt you to [raise an issue](#issue-bug-reporting) if the problem is caused by a bug.
## Issue & Bug Reporting

View File

@ -8,7 +8,7 @@ This can help analyse changes that (may) cause `px4_fmu-v2_default` to hit the 1
:::
_Bloaty_ must be in your path and found at _cmake_ configure time.
The PX4 [docker files](https://github.com/PX4/containers/blob/master/docker/Dockerfile_nuttx-bionic) install _bloaty_ as shown:
The PX4 [docker files](https://github.com/PX4/PX4-containers/blob/master/docker/Dockerfile_nuttx-bionic) install _bloaty_ as shown:
```sh
git clone --recursive https://github.com/google/bloaty.git /tmp/bloaty \

View File

@ -21,7 +21,7 @@ Setup PX4 by following the normal guidelines:
To install _Eclipse_:
1. Download [Eclipse CDT for C/C++ Developers](https://github.com/gnu-mcu-eclipse/org.eclipse.epp.packages/releases/) (MCU GitHub).
1. Download [Eclipse CDT for C/C++ Developers](https://github.com/eclipse-embed-cdt/org.eclipse.epp.packages/releases) (MCU GitHub).
1. Extract the Eclipse folder and copy it anywhere (there is no need to run any install scripts).
1. Run _Eclipse_ and choose a location for your initial workbench.

View File

@ -21,7 +21,7 @@ The _6-pos DF13_ connector that comes with the probe cannot be used for SWD debu
::: info
To debug STM32F7 or later (FMUv5 and newer) the Zubax BugFace BF1 / Blackmagic probe likely requires a firmware update.
You can find how to update the [blackmagic probe here](https://github.com/blacksphere/blackmagic/wiki/Upgrading-Firmware).
You can find how to update the [blackmagic probe here](https://black-magic.org/upgrade.html).
:::
To use a Zubax BugFace BF1 with GDB, start GDB with the exact ELF file that is currently flashed on the autopilot:

View File

@ -47,7 +47,7 @@ See the [Embedded Debug Tools][emdbg] for more advanced debug options.
### Segger JLink EDU Mini Debug Probe
The [Segger JLink EDU Mini](https://www.segger.com/products/debug-probes/j-link/models/j-link-edu-mini/) is an inexpensive and popular SWD debug probe.
The probe's connector pinout looks like the image below (connect to this using an ARM 10-pin mini connector like [FTSH-105-01-F-DV-K](https://www.digikey.com/products/en?keywords=SAM8796-ND)).
The probe's connector pinout looks like the image below (connect to this using an ARM 10-pin mini connector like [FTSH-105-01-F-DV-K](https://www.digikey.com/en/products/detail/samtec-inc/FTSH-105-01-F-DV-K/2649974)).
![connector_jlink_mini.png](../../assets/debug/connector_jlink_mini.png)

View File

@ -17,6 +17,8 @@ They are listed because you may be using them in an existing drone, and because
- [Holybro Pixhawk Mini](../flight_controller/pixhawk_mini.md) (FMUv3)
- [Holybro Pixfalcon](../flight_controller/pixfalcon.md) (Pixhawk FMUv2)
- [Holybro Pix32](../flight_controller/holybro_pix32.md) (FMUv2)
- [ModalAI VOXL Flight](../flight_controller/modalai_voxl_flight.md)
- [ModalAI Flight Core v1](../flight_controller/modalai_fc_v1.md)
- [mRobotics-X2.1](../flight_controller/mro_x2.1.md) (FMUv2)
- [mRo AUAV-X2](../flight_controller/auav_x2.md) (Pixhawk FMUv2)
- [NXP FMUK66](../flight_controller/nxp_rddrone_fmuk66.md) (Discontinued)

View File

@ -25,12 +25,9 @@ The boards in this category are:
- [CubePilot Cube Yellow](../flight_controller/cubepilot_cube_yellow.md)
- [Holybro Kakute H7v2](../flight_controller/kakuteh7v2.md)
- [Holybro Kakute H7mini](../flight_controller/kakuteh7mini.md)
- [Holybro Kakute F7](../flight_controller/kakutef7.md) - Discontinued
- [Holybro Kakute H7](../flight_controller/kakuteh7.md)
- [Holybro Durandal](../flight_controller/durandal.md)
- [Holybro Pix32 v5](../flight_controller/holybro_pix32_v5.md)
- [ModalAI Flight Core v1](../flight_controller/modalai_fc_v1.md)
- [ModalAI VOXL Flight](../flight_controller/modalai_voxl_flight.md)
- [ModalAI VOXL 2](../flight_controller/modalai_voxl_2.md)
- [mRo Control Zero](../flight_controller/mro_control_zero_f7.md)
- [Sky-Drones AIRLink](../flight_controller/airlink.md)

View File

@ -2,6 +2,10 @@
<Badge type="info" text="Discontinued" />
:::warning
This frame has been [discontinued](../flight_controller/autopilot_experimental.md) and is no longer commercially available.
:::
:::warning
PX4 does not manufacture this (or any) autopilot.
Contact the [manufacturer](https://holybro.com/) for hardware support or compliance issues.

View File

@ -1,6 +1,10 @@
# ModalAI Flight Core v1
<Badge type="tip" text="PX4 v1.11" />
<Badge type="info" text="Discontinued" /> <Badge type="tip" text="PX4 v1.11" />
:::warning
This frame has been [discontinued](../flight_controller/autopilot_experimental.md) and is no longer commercially available.
:::
:::warning
PX4 does not manufacture this (or any) autopilot.
@ -50,6 +54,7 @@ More detailed hardware documentation can be found [here](https://docs.modalai.co
:::
<!-- reference links for table above (improve layout) -->
[stm32f765ii]: https://www.st.com/en/microcontrollers-microprocessors/stm32f765ii.html
[bmp388]: https://www.bosch-sensortec.com/products/environmental-sensors/pressure-sensors/bmp388/
[icm-20602]: https://www.invensense.com/products/motion-tracking/6-axis/icm-20602/

View File

@ -1,6 +1,10 @@
# ModalAI VOXL Flight
<Badge type="tip" text="PX4 v1.11" />
<Badge type="info" text="Discontinued" /> <Badge type="tip" text="PX4 v1.11" />
:::warning
This frame has been [discontinued](../flight_controller/autopilot_experimental.md) and is no longer commercially available.
:::
:::warning
PX4 does not manufacture this (or any) autopilot.

View File

@ -162,7 +162,7 @@ The final build is shown below:
## PX4 Configuration
_QGroundControl_ is used to install the PX4 autopilot and configure/tune it for the frame.
[Download and install](https://qgroundcontrol.com/downloads/) _QGroundControl_ for your platform.
[Download and install](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) _QGroundControl_ for your platform.
:::tip
Full instructions for installing and configuring PX4 can be found in [Basic Configuration](../config/index.md).

View File

@ -164,7 +164,7 @@ The final build is shown below:
## PX4 Configuration
_QGroundControl_ is used to install the PX4 autopilot and configure/tune it for the frame.
[Download and install](https://qgroundcontrol.com/downloads/)
[Download and install](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html)
_QGroundControl_ for your platform.
:::tip

View File

@ -200,7 +200,7 @@ If you have to wire the system yourself, the diagram below shows all the connect
## PX4 Configuration
_QGroundControl_ is used to install the PX4 autopilot and configure/tune it for the QAV250 frame.
[Download and install](https://qgroundcontrol.com/downloads/) _QGroundControl_ for your platform.
[Download and install](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) _QGroundControl_ for your platform.
:::tip
Full instructions for installing and configuring PX4 can be found in [Basic Configuration](../config/index.md).

View File

@ -268,7 +268,7 @@ Fully assembled, the kit looks as shown below:
## PX4 Configuration
_QGroundControl_ is used to install the PX4 autopilot and configure/tune it for the QAV250 frame.
[Download and install](https://qgroundcontrol.com/downloads/) _QGroundControl_ for your platform.
[Download and install](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) _QGroundControl_ for your platform.
:::tip
Full instructions for installing and configuring PX4 can be found in [Basic Configuration](../config/index.md).

View File

@ -196,7 +196,7 @@ Full instructions for installing and configuring PX4 can be found in [Basic Conf
:::
_QGroundControl_ is used to install the PX4 autopilot and configure/tune it for the X500 frame.
[Download and install](https://qgroundcontrol.com/downloads/) _QGroundControl_ for your platform.
[Download and install](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) _QGroundControl_ for your platform.
First update the firmware, airframe, and actuator mappings:

View File

@ -215,7 +215,7 @@ Full instructions for installing and configuring PX4 can be found in [Basic Conf
:::
_QGroundControl_ is used to install the PX4 autopilot and configure/tune it for the X500 frame.
[Download and install](https://qgroundcontrol.com/downloads/) _QGroundControl_ for your platform.
[Download and install](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) _QGroundControl_ for your platform.
First update the firmware, airframe, and actuator mappings:

View File

@ -167,7 +167,7 @@ Full instructions for installing and configuring PX4 can be found in [Basic Conf
:::
_QGroundControl_ is used to install the PX4 autopilot and configure/tune it for the X500 frame.
[Download and install](https://qgroundcontrol.com/downloads/) _QGroundControl_ for your platform.
[Download and install](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) _QGroundControl_ for your platform.
First update the firmware, airframe, and actuator mappings:

View File

@ -225,7 +225,7 @@ I mounted it like you can see in the next picture. The two screws and nuts to lo
## PX4 Configuration
_QGroundControl_ is used to install the PX4 autopilot and configure/tune it for the frame.
[Download and install](https://qgroundcontrol.com/downloads/) _QGroundControl_ for your platform.
[Download and install](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) _QGroundControl_ for your platform.
:::tip
Full instructions for installing and configuring PX4 can be found in [Basic Configuration](../config/index.md).

View File

@ -279,7 +279,3 @@ After you finish calibration the VTOL is ready to fly.
## Video
<lite-youtube videoid="h7OHTigtU0s" title="PX4 Vtol test"/>
## Support
If you have any questions regarding your VTOL conversion or configuration please visit <https://discuss.px4.io/c/px4/vtol>.

View File

@ -13,7 +13,6 @@ Unmodified, the Fun Cub is a relatively affordable plane and relatively easy to
After the conversion the plane is significantly heavier and less aerodynamic.
It still flies quite well but needs around 75% throttle in forward flight.
## Bill of Materials
The actual plane looks roughly like as shown in the image above (other similar models will work
@ -32,7 +31,6 @@ The minimal equipment required is:
- Aluminum frame for mounting the quad motors (10x10mm square tube, 1mm wall thickness)
- TOW is ~2.3kg with a 4200mAh 4S battery
## Structure
The structure is made out of aluminum booms as shown below.
@ -47,25 +45,24 @@ The geometry and output assignment can be configured in the [Actuators Configura
For example, you might wire it up like this example (orientation as if "sitting in the plane"):
Port | Connection
--- | ---
MAIN 1 | Front right motor (CCW)
MAIN 2 | Back left motor (CCW)
MAIN 3 | Front left motor (CW)
MAIN 4 | Back right motor (CW)
AUX 1 | Left aileron TODO
AUX 2 | Right aileron
AUX 3 | Elevator
AUX 4 | Rudder
AUX 5 | Throttle
| Port | Connection |
| ------ | ----------------------- |
| MAIN 1 | Front right motor (CCW) |
| MAIN 2 | Back left motor (CCW) |
| MAIN 3 | Front left motor (CW) |
| MAIN 4 | Back right motor (CW) |
| AUX 1 | Left aileron TODO |
| AUX 2 | Right aileron |
| AUX 3 | Elevator |
| AUX 4 | Rudder |
| AUX 5 | Throttle |
For further instructions on wiring and configurations please see:
[Standard VTOL Wiring and Configuration](../config_vtol/vtol_quad_configuration.md). <!-- replace with Pixhawk Wiring Quickstart -->
## Airframe Configuration
1. For [Airframe](../config/airframe.md) select the vehicle group/type as *Standard VTOL* and the specific vehicle as [Generic Standard VTOL](../airframes/airframe_reference.md#vtol_standard_vtol_generic_standard_vtol) as shown below (do not forget to click **Apply and Restart** in the top).
1. For [Airframe](../config/airframe.md) select the vehicle group/type as _Standard VTOL_ and the specific vehicle as [Generic Standard VTOL](../airframes/airframe_reference.md#vtol_standard_vtol_generic_standard_vtol) as shown below (do not forget to click **Apply and Restart** in the top).
![QCG - Select Generic Standard VTOL](../../assets/qgc/setup/airframe/px4_frame_generic_standard_vtol.png)
@ -74,11 +71,6 @@ For further instructions on wiring and configurations please see:
After you finish calibration the VTOL is ready to fly.
## Video
<lite-youtube videoid="4K8yaa6A0ks" title="Fun Cub PX4 VTOL Maiden"/>
## Support
If you have any questions regarding your VTOL conversion or configuration please visit <https://discuss.px4.io/c/px4/vtol>.

View File

@ -7,7 +7,7 @@ The plasic fuselage and 2 meter EPO wing makes it a rugged airframe with a lot o
Key information:
- **Frame:** Volantex Ranger-Ex or *Quanum Observer*
- **Frame:** Volantex Ranger-Ex or _Quanum Observer_
- **Flight controller:** Pixhawk
![QuadRanger](../../assets/airframes/vtol/quadranger_rangerex_pixhawk/quadranger_vtol_complete_build.jpg)
@ -19,7 +19,6 @@ This leaves enough payload capacity for payloads like FPV gear and cameras.
The conversion is designed to minimize impact on the aerodynamics and provide additional strength minimize wing flexing.
## Bill of Materials
- Volantex Ranger-Ex or Quanum Observer
@ -30,11 +29,11 @@ The conversion is designed to minimize impact on the aerodynamics and provide ad
## Conversion kit
- The basic parts required are;
- Pixhawk or compatible
- Digital airspeed sensor
- 3DR Power module or compatible
- GPS
- The basic parts required are;
- Pixhawk or compatible
- Digital airspeed sensor
- 3DR Power module or compatible
- GPS
For a full parts list with links to Hobbyking EU and International warehouse see:
[QuadRanger-VTOL-partslist](https://px4.io/wp-content/uploads/2016/01/QuadRanger-VTOL-partslist-1.xlsx)
@ -43,15 +42,14 @@ The image below depicts the parts required for one wing.
![QuadRanger Parts](../../assets/airframes/vtol/quadranger_rangerex_pixhawk/quadranger_vtol_parts_for_one_wing.jpg)
The tools required for the conversion are;
- A Dremel or similar rotary tool
- A hobby knife
- UHU POR glue
- CA glue
- Tape-line
- Tape
- A Dremel or similar rotary tool
- A hobby knife
- UHU POR glue
- CA glue
- Tape-line
- Tape
![QuadRanger conversion tools](../../assets/airframes/vtol/quadranger_rangerex_pixhawk/quadranger_vtol_conversion_tools.jpg)
@ -92,33 +90,26 @@ When using the Afro ESC be sure to connect at least signal and ground wire.
The outputs of Pixhawk should be wired like this (orientation as seen
like "sitting in the plane").
Port | Connection
--- | ---
MAIN 1 | Front right motor, CCW
MAIN 2 | Back left motor, CCW
MAIN 3 | Front left motor, CW
MAIN 4 | Back right motor, CW
AUX 1 | Left aileron
AUX 2 | Right aileron
AUX 3 | Elevator
AUX 4 | Rudder
AUX 5 | Throttle
| Port | Connection |
| ------ | ---------------------- |
| MAIN 1 | Front right motor, CCW |
| MAIN 2 | Back left motor, CCW |
| MAIN 3 | Front left motor, CW |
| MAIN 4 | Back right motor, CW |
| AUX 1 | Left aileron |
| AUX 2 | Right aileron |
| AUX 3 | Elevator |
| AUX 4 | Rudder |
| AUX 5 | Throttle |
::: info
The servo direction can be reversed using the PWM\_REV parameters in the PWM\_OUTPUT group of QGroundControl (cogwheel tab, last item in the left menu)
The servo direction can be reversed using the PWM_REV parameters in the PWM_OUTPUT group of QGroundControl (cogwheel tab, last item in the left menu)
:::
For further instructions on wiring and configurations please see: [Standard VTOL Wiring and Configuration](../config_vtol/vtol_quad_configuration.md)
## Configuration
Configure the frame as shown in QGroundControl below (do not forget to click **Apply and Restart** in the top).
![QGC - select firmware for standard VTOL](../../assets/airframes/vtol/funcub_pixhawk/qgc_firmware_standard_vtol_fun_cub_quad.png)
## Support
If you have any questions regarding your VTOL conversion or configuration please visit <https://discuss.px4.io/c/px4/vtol>.

View File

@ -65,7 +65,7 @@ Some of PX4's key features are:
- Robust and deep integration with [companion computers](#offboard-companion-computer) and [robotics APIs](../robotics/index.md) such as [ROS 2](../ros2/user_guide.md) and [MAVSDK](https://mavsdk.mavlink.io/main/en/index.html).
PX4 is a core part of a broader drone platform that includes the [QGroundControl](#qgc) ground station, [Pixhawk hardware](https://pixhawk.org/), and [MAVSDK](https://mavsdk.mavlink.io/main/en/index.html) for integration with companion computers, cameras and other hardware using the MAVLink protocol.
PX4 is supported by the [Dronecode Project](https://www.dronecode.org/).
PX4 is supported by the [Dronecode Project](https://dronecode.org/).
## Ground Control Stations
@ -76,7 +76,7 @@ A subset of the products that are known to work with PX4 are listed below.
The Dronecode GCS software is called [QGroundControl](https://qgroundcontrol.com/) ("QGC").
It runs on Windows, Android, MacOS or Linux hardware, and supports a wide range of screen form factors.
You can download it (for free) from [here](https://qgroundcontrol.com/downloads/).
You can download it (for free) from [here](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html).
![QGC Main Screen](../../assets/concepts/qgc_fly_view.png)

View File

@ -131,9 +131,9 @@ The following icons used in this library are licensed separately (as shown below
## Governance
The PX4 flight stack is hosted under the governance of the [Dronecode Project](https://www.dronecode.org/).
The PX4 flight stack is hosted under the governance of the [Dronecode Project](https://dronecode.org/).
<a href="https://www.dronecode.org/" style="padding:20px" ><img src="../assets/site/logo_dronecode.png" alt="Dronecode Logo" width="110px"/></a>
<a href="https://dronecode.org/" style="padding:20px" ><img src="../assets/site/logo_dronecode.png" alt="Dronecode Logo" width="110px"/></a>
<a href="https://www.linuxfoundation.org/projects" style="padding:20px;"><img src="../assets/site/logo_linux_foundation.png" alt="Linux Foundation Logo" width="80px" /></a>
<div style="padding:10px">&nbsp;</div>

View File

@ -16,8 +16,7 @@ Most modules support 3.3 V input (only), while some flight controllers (e.g. Pix
Modules that accept 3.3V supply:
- [WRL-17146](https://www.sparkfun.com/products/13678) (Sparkfun)
- [AI Cloud](https://us.gearbest.com/boards-shields/pp_009604906563.html) - discontinued (GearBeast)
- [WRL-17146](https://www.sparkfun.com/wifi-module-esp8266-4mb-flash.html) (Sparkfun)
Modules that accept 5.0V supply:

View File

@ -20,4 +20,4 @@ There are a number of versions available:
- [store.rfdesign.com.au](https://store.rfdesign.com.au/radio-modems/):
- [RFD 900+ Modem](https://store.rfdesign.com.au/rfd-900p-modem/)
- [RFD 868x Modem (EU)](https://store.rfdesign.com.au/rfd868x-eu-hs-8517-62-00-90/)
- [RFD900x](https://store.rfdesign.com.au/rfd-900x-modem-hs-8517-62-00-90/)
- [RFD900x](https://store.rfdesign.com.au/rfd-900x-modem/)

View File

@ -10,7 +10,7 @@ The modem is plug-and-play with flight controllers using a JST-GH UART interface
## Where to Buy
- [TFSIK01A on Tindie](https://www.tindie.com/products/34682/)
- [TFSIK01A on Tindie](https://www.tindie.com/products/thunderfly/tfsik01-high-performance-uav-telemetry-modem/)
- Directly from [ThunderFly](https://www.thunderfly.cz/contact-us.html) ([sale@thunderfly.cz](mailto:sale@thunderfly.cz))
## Features

View File

@ -16,16 +16,16 @@ PX4 containers are currently only supported on Linux (if you don't have Linux yo
Do not use `boot2docker` with the default Linux image because it contains no X-Server.
:::
[Install Docker](https://docs.docker.com/installation/) for your Linux computer, preferably using one of the Docker-maintained package repositories to get the latest stable version. You can use either the _Enterprise Edition_ or (free) _Community Edition_.
[Install Docker](https://docs.docker.com/get-started/get-docker/) for your Linux computer, preferably using one of the Docker-maintained package repositories to get the latest stable version. You can use either the _Enterprise Edition_ or (free) _Community Edition_.
For local installation of non-production setups on _Ubuntu_, the quickest and easiest way to install Docker is to use the [convenience script](https://docs.docker.com/install/linux/docker-ce/ubuntu/#install-using-the-convenience-script) as shown below (alternative installation methods are found on the same page):
For local installation of non-production setups on _Ubuntu_, the quickest and easiest way to install Docker is to use the [convenience script](https://docs.docker.com/engine/install/ubuntu/#install-using-the-convenience-script) as shown below (alternative installation methods are found on the same page):
```sh
curl -fsSL get.docker.com -o get-docker.sh
sudo sh get-docker.sh
```
The default installation requires that you invoke _Docker_ as the root user (i.e. using `sudo`). However, for building the PX4 firmware we suggest to [use docker as a non-root user](https://docs.docker.com/install/linux/linux-postinstall/#manage-docker-as-a-non-root-user). That way, your build folder won't be owned by root after using docker.
The default installation requires that you invoke _Docker_ as the root user (i.e. using `sudo`). However, for building the PX4 firmware we suggest to [use docker as a non-root user](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user). That way, your build folder won't be owned by root after using docker.
```sh
# Create docker group (may not be required)

877
docs/package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -6,7 +6,7 @@
"scripts": {
"docs:dev": "vitepress dev .",
"docs:build": "yarn docs:build_ubuntu",
"docs:buildwin": "set NODE_OPTIONS=--max_old_space_size=8192 && vitepress build .",
"docs:buildwin": "set NODE_OPTIONS=--max_old_space_size=8192 && set CI=true && vitepress build .",
"docs:build_ubuntu": "NODE_OPTIONS='--max-old-space-size=8192' vitepress build .",
"docs:preview": "vitepress preview .",
"docs:sitemap": "python3 ./scripts/gen_sitemap.py",
@ -16,8 +16,8 @@
"linkcheck": "markdown_link_checker_sc -r .. -d docs -e en -i assets"
},
"dependencies": {
"@red-asuka/vitepress-plugin-tabs": "^0.0.3",
"lite-youtube-embed": "^0.3.2",
"@red-asuka/vitepress-plugin-tabs": "0.0.4",
"lite-youtube-embed": "^0.3.3",
"markdown-it-mathjax3": "^4.3.2",
"medium-zoom": "^1.1.0",
"open-editor": "^5.0.0",

File diff suppressed because it is too large Load Diff