Better SITL
Table of contents:
| Categories | What's shown? |
|---|---|
| Overview | Project Overview. |
| Setup | Setup/Installation instructions. |
| Usage | How to use this program. |
| Used Resources | All resources used in this repo. |
Overview
In Aero, we use drone simulations a lot; especially with PX4. However, simulations are encumbersome to setup, and even more difficult to manage. PX4 makes docker images for their simulation environments, which does make things easier, but even their scripts to run them easily aren't very robust. As a solution, we at Aero developed a convenient CLI that makes things far easier to manage.
Setup
Prerequisites
- Docker Desktop or Docker Engine
- Active Docker Daemon
- Sudo privileges (Linux and MacOS)
How To Install Docker
All docker installation directions can be found here. However, there are some important things to note.
brew install colima
colima start
Installation
- Clone this repository
git clone https://github.com/TCHS-aero/better-sitl.git
- Install with pip
pip install better-sitl
Usage
Manage PX4 Docker images with sitl image
Usage: sitl image [OPTIONS] COMMAND [ARGS]...
Handle installed Docker images.
Options:
--help Show this message and exit.
Commands:
list List installed PX4 Docker images.
remove Remove installed PX4 docker images.
Run PX4 Docker images; either Gazebo or SIH.
Usage: sitl run gazebo [OPTIONS]
Launch PX4 SITL using Gazebo.
Options:
--world [default|aruco|baylands|lawn|ridge|rover|walls|windy|moving_platform]
World to load. [required]
--env KEY=VALUE Pass an extra environment variable. Repeat
to add more.
--model [TEXT] Vehicle model to load. [required]
--help Show this message and exit.
Gazebo and SIH have different models that can be ran through the simulation.
Gazebo:
- gz_x500
- gz_x500_vision
- gz_x500_depth
- gz_x500_mono_cam
- gz_x500_mono_cam_down
- gz_x500_mono_lidar_down
- gz_x500_mono_lidar_front
- gz_x500_mono_lidar_2d
- gz_x500_gimbal
- gz_rc_cessna
- gz_advanced_plane
- gz_standard_vtol
- gz_quadtailsitter
- gz_tiltrotor
- gz_rover_differential
- gz_rover_ackerman
- gz_rover_mecanum
SIH:
- sihsim_quadx
- sihsim_hex
- sihsim_airplane
- sihsim_xvert
- sihsim_standard_vtol
- sihsim_rover_ackermann
Resources
Metadata
Release files for better-sitl 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| better_sitl-1.0.0.tar.gz | 5.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| better_sitl-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.3 kB
Release files / better_sitl-1.0.0.tar.gz
| Download URL | better_sitl-1.0.0.tar.gz |
|---|---|
| Size | 5.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
37cc62c7f6d2af46d8bc49f16a7aa1b8c5bb000d4cd9827b4193c75637b7efa2
|
|
BLAKE2b-256 checksum How to use checksums |
e99e5b9106e6d937ab6dd151501221d6b975825ab17933f020f6d58e812c5a71
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / better_sitl-1.0.0-py3-none-any.whl
| Download URL | better_sitl-1.0.0-py3-none-any.whl |
|---|---|
| Size | 6.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0a84a6460c99c807851a63df51d3a0dcee2811269bcf744725654ec4b58df75c
|
|
BLAKE2b-256 checksum How to use checksums |
f67b4ee7e14d79268ed5347837148cc25c428e5e1fcf2c1ab640b180658197ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for better-sitl 1.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.