docs(sim): add Try PX4 quick-start and pre-built packages reference#26957
Conversation
|
/en/sim_sih/index.md
|
|
@farhangnaderi, could you put your academic hat on, forget everything you know about PX4 for a second, and try to go through the docs on this PR? It introduces a new SITL container (~30mb) that can run SITL. I'm being kinda bold here and promoting this feature as "try PX4 in 1 easy step." |
c55c60a to
3c8bfc8
Compare
… update - Add docs/en/dev_setup/try_px4.md: one-command quick start with Docker - Add docs/en/simulation/px4_sitl.md: reference for .deb packages and container images (replaces packaging/px4_sitl_deb.md) - Update README.md with "Try PX4" section and docker run one-liner - Update landing page, Getting Started, toolchain page, simulation index, and SUMMARY.md with links to new pages - All container references use :latest tag Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Document all container port mappings (QGC, MAVSDK, uXRCE-DDS, MAVSim Viewer) with a quick-reference table. Signed-off-by: Ramon Roche <mrpollo@gmail.com>
e2fcbe1 to
0f7eaf8
Compare
The Docker image previously published as px4io/px4-sitl-sih is renamed to px4io/px4-sitl. The Gazebo image remains px4io/px4-sitl-gazebo. Signed-off-by: Ramon Roche <mrpollo@gmail.com>
3843695 to
09b9154
Compare
💡 Commit messages could be improvedNot blocking, but these commit messages could use some cleanup.
See the commit message convention for details. This comment will be automatically removed once the issues are resolved. |
* origin/main: ci(apt): gate apt mirror swap on runs-on at the workflow level ci(apt): extract AWS apt mirror swap into shared script ci(ubuntu): use AWS regional mirror for apt in compile workflow ci(deb): publish SIH image as px4io/px4-sitl ci(deb): use AWS regional mirror for apt in deb build container fix(packaging): resolve host.docker.internal as IPv4 in SIH entrypoint ci(container): add build_ref input to allow dispatch against arbitrary refs # Conflicts: # .github/workflows/build_deb_package.yml
|
@hamishwillee, your edits make sense to me. I also merged my work and renamed the container image from px4-sitl-sh to px4-sitl, which makes it easier to remember too. Lastly, the IPv6 issue is already fixed. Let me know if you can try the instructions and if you succeed. |
hamishwillee
left a comment
There was a problem hiding this comment.
@mrpollo I cut back the quickstart now it is in the intro and the development stuff doesn't belong. The cut out information was already in the prebuilt package topic, so I see not loss. I've fixed up the other open questions.
I tried running the SIH container. It starts clean and fast. I couldn't connect to it, but the error looks like a local problem with the UDP port (I am hammering lots of things at the moment). I will try again tonight, but I am approving because I think this is good. Not merging because you might want to have other review or testing.
After this we do need to add the hawkeye stuff - ideally in that same container and ideally linked into the SIH start.
|
This is amaziiiiing 🏆 |
|
@mrpollo Sorry I wasnt notified by this. Thank you very much for your effort. I like this. As a new comer I tried running and these are what I experienced:
So maybe for the quickstart: PX4 Simulation QuickStartFirst install Docker (a free tool that runs containers). docker run --rm -it --network host px4io/px4-sitl:latestThat's it — open QGroundControl and fly! ::: warning Troubleshooting sudo usermod -aG docker $USER
newgrp dockerThen run the docker command again. ::: ::: tip -e PX4_SIM_MODEL=sihsim_airplane # Plane
-e PX4_SIM_MODEL=sihsim_standard_vtol # Standard VTOL
-e PX4_SIM_MODEL=sihsim_rover # Ackermann roverFor more information and options see Container Images (in Pre-built SITL Packages) and SIH Simulation. |
|
Thanks @farhangnaderi, regarding docker/containers, you right that we are expecting users to have docker already setup, and some hints as to how to troubleshoot might be nice, but maybe not in the quickstart page. On the --network host vs specifying ports, that was actually the first problem I ran into, it would have been super nice to just have the one liner, but the -p should have worked for everyone assuming no port conflicts. Maybe what we should do here is to have a tab component to keep the page clean. This way we only show one command by default, and hide the other in a tab, a tab for Linux and another for macOS/Windows, whoever I'm not sure we have such component in the docs |
|
This is really good. I've always thought we needed an easy way for no brainer testing and now we have it. I tried A tab might work. But probably a details twistie better. Say as little as possible. Link to docker debugging info elsewhere. |
Adds documentation for the SITL containers and .deb packages introduced in #26495. The containers are now live on Docker Hub:
px4io/px4-sitl:latestandpx4io/px4-sitl-gazebo:latest.The main addition is a Try PX4 Simulation page that leads with a single
docker runcommand 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
.debpackage reference has been moved frompackaging/px4_sitl_deb.mdtosimulation/px4_sitl.mdand expanded to cover both containers and.debpackages on one page. Sections are ordered by how people use them: what's available, install, configure, connect QGC/MAVSDK, connect ROS 2.Other changes:
index.md) reworked to lead with "Try PX4" before "For Developers"dev_env.md) gets a tip redirecting simulation-only users to pre-built packagesgetting_started.mdandSUMMARY.mdupdated with links to the new pages.debpackagesThe SIH container image is published as
px4io/px4-sitl(renamed frompx4io/px4-sitl-sih) so the default lightweight option carries the simplest name. The Gazebo image remainspx4io/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.