mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-04-14 10:07:39 +08:00
9adda29da2
Adds documentation for the SITL containers and .deb packages introduced in #26495. The containers are now live on Docker Hub: [`px4io/px4-sitl:latest`](https://hub.docker.com/r/px4io/px4-sitl) and [`px4io/px4-sitl-gazebo:latest`](https://hub.docker.com/r/px4io/px4-sitl-gazebo). The main addition is a [Try PX4 Simulation](https://docs.px4.io/main/en/dev_setup/try_px4) page that leads with a single `docker run` command and gets someone flying in under a minute. It lives in Getting Started, right after Recommended Hardware/Setup, so it's one of the first things new users see. The existing `.deb` package reference has been moved from `packaging/px4_sitl_deb.md` to `simulation/px4_sitl.md` and expanded to cover both containers and `.deb` packages on one page. Sections are ordered by how people use them: what's available, install, configure, connect QGC/MAVSDK, connect ROS 2. Other changes: - README now has a "Try PX4" section with the docker one-liner above "Build from Source" - Landing page (`index.md`) reworked to lead with "Try PX4" before "For Developers" - Toolchain page (`dev_env.md`) gets a tip redirecting simulation-only users to pre-built packages - `getting_started.md` and `SUMMARY.md` updated with links to the new pages - Simulation index tip updated to mention containers alongside `.deb` packages The SIH container image is published as `px4io/px4-sitl` (renamed from `px4io/px4-sitl-sih`) so the default lightweight option carries the simplest name. The Gazebo image remains `px4io/px4-sitl-gazebo`. Also upgrades all GitHub Actions in the SITL workflow to Node.js 24 compatible versions (`actions/checkout@v6`, `actions/cache@v5`, `actions/upload-artifact@v7`, `actions/download-artifact@v8`, `docker/setup-buildx-action@v4`, `docker/build-push-action@v7`) to fix the Node.js 20 deprecation warning ahead of the June 2026 deadline. --------- Signed-off-by: Ramon Roche <mrpollo@gmail.com> Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2.5 KiB
2.5 KiB
Setting up a Developer Environment (Toolchain)
::: tip You only need a toolchain if you want to modify and build PX4 from source. If you just want to run PX4 simulation without changing the code, use a pre-built Docker container or .deb package instead. :::
The supported platforms for PX4 development are:
- Ubuntu Linux (24.04/22.04)
- Windows (10/11) — via WSL2
- macOS
Supported Targets
The table below shows what PX4 targets you can build on each OS.
| Target | Linux (Ubuntu) | macOS | Windows |
|---|---|---|---|
| NuttX based hardware: Pixhawk Series, Crazyflie | ✓ | ✓ | ✓ |
| Linux-based hardware: Raspberry Pi 2/3 | ✓ | ||
| Simulation: Gazebo SITL | ✓ | ✓ | ✓ |
| Simulation: ROS 2 with Gazebo | ✓ | ✓ | |
| Simulation: Gazebo Classic SITL | ✓ | ✓ | |
| Simulation: ROS with Gazebo Classic | ✓ |
Experienced Docker users can also build with the containers used by our continuous integration system: Docker Containers
Next Steps
Once you have finished setting up one of the command-line toolchains above:
- Install VSCode (if you prefer using an IDE to the command line).
- Install the QGroundControl Daily Build
- Continue to Building PX4 Software.