Skip to content

Commit d83b657

Browse files
hamishwilleemrpollo
authored andcommitted
docs(sim): prettier formatting and copy fixes for Try PX4 and SITL pages
1 parent 0f7eaf8 commit d83b657

4 files changed

Lines changed: 102 additions & 72 deletions

File tree

docs/en/dev_setup/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
This section contains topics about getting started with PX4 development:
44

5+
- [PX4 Simulation](../dev_setup/try_px4.md) — Try PX4 in simulation without a build environment!
56
- [Initial Setup](../dev_setup/config_initial.md)
6-
- [Try PX4 Simulation](../dev_setup/try_px4.md) -- run PX4 in simulation without a build environment
77
- [Toolchain Installation](../dev_setup/dev_env.md)
88
- [Building the Code](../dev_setup/building_px4.md)
99
- [Writing an Application](../modules/hello_sky.md)

docs/en/dev_setup/try_px4.md

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,54 @@
33
PX4 runs a full autopilot in simulation, on your laptop, with nothing to install besides Docker.
44
One command and you have a flying vehicle ready for QGroundControl, MAVSDK, or ROS 2.
55

6-
```bash
6+
```sh
77
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl-sih:latest
88
```
99

10-
That's it. PX4 is running. Open [QGroundControl](https://qgroundcontrol.com) and fly.
10+
That's it.
11+
PX4 is running.
12+
Open [QGroundControl](https://qgroundcontrol.com) and fly.
1113

12-
No hardware, no build environment, no dependencies beyond [Docker](https://docs.docker.com/get-docker/). Read on for more options.
14+
No hardware, no build environment, no dependencies beyond [Docker](https://docs.docker.com/get-docker/).
15+
Read on for more options.
1316

1417
## What This Runs
1518

16-
The command above starts a **lightweight simulation** where the physics run inside PX4 itself. It starts instantly and works everywhere, but it is headless (no 3D window). You can still monitor the vehicle in QGroundControl, and there are [additional visualization options](../sim_sih/index.md) if you need them.
19+
The command above starts a **lightweight simulation** where the physics run inside PX4 itself.
20+
It starts instantly and works everywhere, but it is headless (no 3D window).
21+
You can still monitor the vehicle in QGroundControl, and there are [additional visualization options](../sim_sih/index.md#sitl-visualization) if you need them.
1722

18-
If you need a **3D environment** with cameras, LiDAR, and custom worlds, PX4 also supports [Gazebo](../sim_gazebo_gz/index.md). Gazebo requires more setup (graphics forwarding, GPU access) so it is better suited as a [native install](../simulation/px4_sitl.md) or [built from source](building_px4.md). See the [simulator comparison table](../simulation/index.md#simulator-comparison) for a full feature breakdown.
23+
If you need a **3D environment** with cameras, LiDAR, and custom worlds, PX4 also supports [Gazebo](../sim_gazebo_gz/index.md).
24+
Gazebo requires more setup (graphics forwarding, GPU access), so it is better suited as a [native install](../simulation/px4_sitl.md) or [built from source](building_px4.md).
25+
See the [simulator comparison table](../simulation/index.md#simulator-comparison) for a full feature breakdown.
1926

2027
## Container (any OS)
2128

22-
Containers package PX4 and all its dependencies into a single download so you don't have to install anything on your system. Just install [Docker](https://docs.docker.com/get-docker/) (a free tool that runs containers) and you're ready to go. Works on Linux, macOS, and Windows.
29+
Containers package PX4 and all its dependencies into a single download so you don't have to install anything on your system.
30+
Just install [Docker](https://docs.docker.com/get-docker/) (a free tool that runs containers) and you're ready to go.
2331

24-
```bash
32+
This command then works on Linux, macOS, and Windows:
33+
34+
```sh
2535
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl-sih:latest
2636
```
2737

28-
PX4 starts a simulated quadcopter. You land in the PX4 shell (`pxh>`).
38+
PX4 starts a simulated quadcopter.
39+
You land in the PX4 shell (`pxh>`).
2940
Open [QGroundControl](https://qgroundcontrol.com) and it auto-connects on UDP port 14550.
3041

3142
For other vehicle types, environment variables, and configuration, see the full [SIH Simulation](../sim_sih/index.md) guide.
3243

3344
## Native Install (Ubuntu)
3445

35-
If you're on Ubuntu and prefer to install PX4 simulation (SITL) directly on your system instead of using a container, download a `.deb` package. This installs PX4 SITL as a regular application, no Docker required. Both lightweight and Gazebo 3D packages are available.
46+
If you're on Ubuntu and prefer to install PX4 simulation (SITL) directly on your system instead of using a container, you can download a `.deb` package.
47+
This installs PX4 SITL as a regular application — no Docker required.
48+
Both lightweight and Gazebo 3D packages are available.
3649

37-
Available for Ubuntu 22.04 and 24.04. Download from the [PX4 Releases](https://github.com/PX4/PX4-Autopilot/releases) page, then:
50+
Available for Ubuntu 22.04 and 24.04.
51+
Download from the [PX4 Releases](https://github.com/PX4/PX4-Autopilot/releases) page, then:
3852

39-
```bash
53+
```sh
4054
sudo apt install ./px4_*.deb
4155
PX4_SIM_MODEL=sihsim_quadx px4
4256
```
@@ -45,9 +59,17 @@ For Gazebo packages, multi-instance, ROS 2 integration, and all configuration op
4559

4660
## Now What?
4761

48-
PX4 is running. Here's what to try next:
49-
50-
1. **Fly around.** Open [QGroundControl](https://qgroundcontrol.com), it connects automatically. Arm the vehicle, take off, and explore the flight modes.
51-
2. **Control it with code.** Use [MAVSDK](https://mavsdk.mavlink.io/) to write a program that commands the vehicle: takeoff, fly a mission, land. Works in any language with a MAVLink connection.
52-
3. **Connect ROS 2.** PX4 publishes vehicle state and accepts commands over [uXRCE-DDS](../ros2/user_guide.md). If ROS 2 is your stack, you can subscribe to topics and send setpoints from ROS nodes.
53-
4. **Go deeper.** Ready to modify PX4 itself? Head to the next page to set up a development environment and build from source.
62+
PX4 is running.
63+
Here's what to try next:
64+
65+
1. **Fly around.**
66+
Open [QGroundControl](https://qgroundcontrol.com) — it connects automatically.
67+
Arm the vehicle, take off, and explore the flight modes.
68+
2. **Control it with code.**
69+
Use [MAVSDK](https://mavsdk.mavlink.io/) to write a program that commands the vehicle: takeoff, fly a mission, land.
70+
This supports many programming languages (it uses the MAVLink protocol for the underlying connection).
71+
3. **Connect ROS 2.**
72+
PX4 publishes vehicle state and accepts commands over [uXRCE-DDS](../ros2/user_guide.md).
73+
If ROS 2 is your stack, you can subscribe to topics and send setpoints from ROS nodes.
74+
4. **Go deeper.**
75+
Ready to modify PX4 itself? Head to the next page to set up a development environment and build from source.

docs/en/simulation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ See [PX4-Autopilot#23602](https://github.com/PX4/PX4-Autopilot/issues/23602) for
2727
| Simulator | Description |
2828
| ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2929
| [Gazebo](../sim_gazebo_gz/index.md) | Gazebo supersedes [Gazebo Classic](../sim_gazebo_classic/index.md), featuring more advanced rendering, physics and sensor models. It is the only version of Gazebo available from Ubuntu Linux 22.04<br><br>A powerful 3D simulation environment that is particularly suitable for testing object-avoidance and computer vision. It can also be used for [multi-vehicle simulation](../simulation/multi-vehicle-simulation.md) and is commonly used with [ROS](../simulation/ros_interface.md), a collection of tools for automating vehicle control. <br><br><strong>Supported Vehicles:</strong> Quad, VTOL (Standard, Tailsitter, Tiltroter), Plane, Rovers |
30-
| [Gazebo Classic](../sim_gazebo_classic/index.md) | A powerful 3D simulation environment that is particularly suitable for testing object-avoidance and computer vision. It can also be used for [multi-vehicle simulation](../simulation/multi-vehicle-simulation.md) and is commonly used with [ROS](../simulation/ros_interface.md), a collection of tools for automating vehicle control.<br><br>**Supported Vehicles:** Quad ([Iris](../airframes/airframe_reference.md#copter_quadrotor_x_generic_quadcopter)), Hex (Typhoon H480), [Generic Standard VTOL (QuadPlane)](../airframes/airframe_reference.md#vtol_standard_vtol_generic_standard_vtol), Tailsitter, Plane, Rover, Submarine |
3130
| [SIH](../sim_sih/index.md) | A lightweight, headless simulator that runs physics directly inside PX4 as a C++ module (no external dependencies). Headless by default for fastest iteration. Supports ROS 2 via uXRCE-DDS. Can also run on flight controller hardware (`SYS_HITL=2`).<br><br>**Supported Vehicles:** Quad, Hex, Plane, Tailsitter, Standard VTOL, Rover |
31+
| [Gazebo Classic](../sim_gazebo_classic/index.md) | A powerful 3D simulation environment that is particularly suitable for testing object-avoidance and computer vision. It can also be used for [multi-vehicle simulation](../simulation/multi-vehicle-simulation.md) and is commonly used with [ROS](../simulation/ros_interface.md), a collection of tools for automating vehicle control.<br><br>**Supported Vehicles:** Quad ([Iris](../airframes/airframe_reference.md#copter_quadrotor_x_generic_quadcopter)), Hex (Typhoon H480), [Generic Standard VTOL (QuadPlane)](../airframes/airframe_reference.md#vtol_standard_vtol_generic_standard_vtol), Tailsitter, Plane, Rover, Submarine |
3232

3333
There are also a number of [Community Supported Simulators](../simulation/community_supported_simulators.md).
3434

0 commit comments

Comments
 (0)