You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/dev_setup/try_px4.md
+39-17Lines changed: 39 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,40 +3,54 @@
3
3
PX4 runs a full autopilot in simulation, on your laptop, with nothing to install besides Docker.
4
4
One command and you have a flying vehicle ready for QGroundControl, MAVSDK, or ROS 2.
5
5
6
-
```bash
6
+
```sh
7
7
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl-sih:latest
8
8
```
9
9
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.
11
13
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.
13
16
14
17
## What This Runs
15
18
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.
17
22
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.
19
26
20
27
## Container (any OS)
21
28
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.
23
31
24
-
```bash
32
+
This command then works on Linux, macOS, and Windows:
33
+
34
+
```sh
25
35
docker run --rm -it -p 14550:14550/udp px4io/px4-sitl-sih:latest
26
36
```
27
37
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>`).
29
40
Open [QGroundControl](https://qgroundcontrol.com) and it auto-connects on UDP port 14550.
30
41
31
42
For other vehicle types, environment variables, and configuration, see the full [SIH Simulation](../sim_sih/index.md) guide.
32
43
33
44
## Native Install (Ubuntu)
34
45
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.
36
49
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:
38
52
39
-
```bash
53
+
```sh
40
54
sudo apt install ./px4_*.deb
41
55
PX4_SIM_MODEL=sihsim_quadx px4
42
56
```
@@ -45,9 +59,17 @@ For Gazebo packages, multi-instance, ROS 2 integration, and all configuration op
45
59
46
60
## Now What?
47
61
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.
|[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 |
31
30
|[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 |
32
32
33
33
There are also a number of [Community Supported Simulators](../simulation/community_supported_simulators.md).
0 commit comments