From 1a0488873eb61ee50a5f025e76710e6d6bcd9ddc Mon Sep 17 00:00:00 2001 From: Jonas Vautherin Date: Wed, 27 Sep 2023 20:29:39 +0200 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a8f3861..05f6dca 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![GitHub Actions Status](https://github.com/jonasvautherin/px4-gazebo-headless/workflows/Publish%20Docker/badge.svg?branch=master)](https://github.com/jonasvautherin/px4-gazebo-headless)[![Docker pulls](https://img.shields.io/docker/pulls/jonasvautherin/px4-gazebo-headless)](https://hub.docker.com/r/jonasvautherin/px4-gazebo-headless/)[![DockerHub version](https://img.shields.io/docker/v/jonasvautherin/px4-gazebo-headless/1.13.2)](https://hub.docker.com/r/jonasvautherin/px4-gazebo-headless/) +[![GitHub Actions Status](https://github.com/jonasvautherin/px4-gazebo-headless/workflows/Publish%20Docker/badge.svg?branch=master)](https://github.com/jonasvautherin/px4-gazebo-headless)[![Docker pulls](https://img.shields.io/docker/pulls/jonasvautherin/px4-gazebo-headless)](https://hub.docker.com/r/jonasvautherin/px4-gazebo-headless/)[![DockerHub version](https://img.shields.io/docker/v/jonasvautherin/px4-gazebo-headless/1.13.3)](https://hub.docker.com/r/jonasvautherin/px4-gazebo-headless/) # PX4-Gazebo simulator (headless) @@ -7,14 +7,14 @@ The Docker images resulting from this repo are available on [Docker Hub](https://hub.docker.com/r/jonasvautherin/px4-gazebo-headless/). -Note that the following commands are referring to the latest supported release of PX4, which is currently v1.13.2. +Note that the following commands are referring to the latest supported release of PX4, which is currently v1.13.3. ### Run in BROADCAST mode: In this mode, the simulator will be available from your host (e.g. run the following command, and QGroundControl running on your computer will connect automatically). ``` -docker run --rm -it jonasvautherin/px4-gazebo-headless:1.13.2 +docker run --rm -it jonasvautherin/px4-gazebo-headless:1.13.3 ``` In this configuration, the container will send MAVLink to the host on ports 14550 (for QGC) and 14540 (for e.g. MAVSDK). @@ -24,7 +24,7 @@ In this configuration, the container will send MAVLink to the host on ports 1455 This mode is useful for running QGroundControl on the computer running docker, and the offboard app (e.g. using MAVSDK) on another device (e.g. a phone). ``` -docker run --rm -it jonasvautherin/px4-gazebo-headless:1.13.2 192.168.0.12 +docker run --rm -it jonasvautherin/px4-gazebo-headless:1.13.3 192.168.0.12 ``` where `192.168.0.12` should be replaced by the IP listening on the API port 14540 (e.g. MAVSDK or MAVROS). @@ -34,7 +34,7 @@ where `192.168.0.12` should be replaced by the IP listening on the API port 1454 This mode is useful for running both QGroundControl and the offboard app (e.g. using MAVSDK) on another device than the one running docker. ``` -docker run --rm -it jonasvautherin/px4-gazebo-headless:1.13.2 192.168.0.10 10.0.0.12 +docker run --rm -it jonasvautherin/px4-gazebo-headless:1.13.3 192.168.0.10 10.0.0.12 ``` where `192.168.0.10` should be replaced by the IP listening on the QGC port 14550 (e.g. QGroundControl) and `10.0.0.12` should be replaced by the IP listening on the API port 14540 (e.g. MAVSDK or MAVROS). @@ -44,7 +44,7 @@ where `192.168.0.10` should be replaced by the IP listening on the QGC port 1455 When running with the Typhoon H480 vehicle (with `-v typhoon_h480`), a video stream will be available. Expose it with e.g. `-p 8554:8554`, like so: ``` -docker run --rm -it -p 8554:8554 jonasvautherin/px4-gazebo-headless:1.13.2 -v typhoon_h480 +docker run --rm -it -p 8554:8554 jonasvautherin/px4-gazebo-headless:1.13.3 -v typhoon_h480 ``` ### Run with another start location @@ -58,12 +58,12 @@ The start location can be set when running the container by setting the followin For instance: ``` -docker run --rm -it --env PX4_HOME_LAT=47.397742 --env PX4_HOME_LON=8.545594 --env PX4_HOME_ALT=488.0 jonasvautherin/px4-gazebo-headless:1.13.2 +docker run --rm -it --env PX4_HOME_LAT=47.397742 --env PX4_HOME_LON=8.545594 --env PX4_HOME_ALT=488.0 jonasvautherin/px4-gazebo-headless:1.13.3 ``` ## Manual build -Note that a clean build from the `master` branch will pull the latest upstream from the PX4 repository (as can be seen [here](https://github.com/JonasVautherin/px4-gazebo-headless/blob/master/Dockerfile#L26)). In order to build a stable version, change `master` for a tag (e.g. `v1.13.2`) in the following commands. +Note that a clean build from the `master` branch will pull the latest upstream from the PX4 repository (as can be seen [here](https://github.com/JonasVautherin/px4-gazebo-headless/blob/master/Dockerfile#L26)). In order to build a stable version, change `master` for a tag (e.g. `v1.13.3`) in the following commands. ### Build the image from this git repository: @@ -115,7 +115,7 @@ __Solution:__ The container automatically detects if it is running inside Docker for Windows/Mac, but not if it is inside Docker Toolbox (let me know if you have a way to detect this). However, it seems that in Docker Toolbox, the host is assigned 10.0.2.2 by default (I am guessing this default is coming from VirtualBox). Therefore it works to redirect to this IP, as described above. For instance: ``` -docker run --rm -it jonasvautherin/px4-gazebo-headless:1.13.2 10.0.2.2 10.0.2.2 +docker run --rm -it jonasvautherin/px4-gazebo-headless:1.13.3 10.0.2.2 10.0.2.2 ``` ### It doesn't connect with Podman @@ -129,5 +129,5 @@ __Solution:__ Try to use the "host network" mode and set the MAVLink interfaces for both interfaces. ``` -podman run --rm --network host -it jonasvautherin/px4-gazebo-headless:1.13.2 127.0.0.1 127.0.0.1 +podman run --rm --network host -it jonasvautherin/px4-gazebo-headless:1.13.3 127.0.0.1 127.0.0.1 ```