Skip to content

Commit

Permalink
deploy: 1d3d458
Browse files Browse the repository at this point in the history
  • Loading branch information
elpiel committed Aug 23, 2022
1 parent 356e598 commit c082008
Show file tree
Hide file tree
Showing 7 changed files with 177 additions and 6 deletions.
Binary file added images/QGroundControl_Docker.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
117 changes: 117 additions & 0 deletions images/px4_sitl_overview.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,12 @@ <h1 class="menu-title">The Rust book for Drones</h1>
<main>
<h1 id="the-rust-book-for-drones"><a class="header" href="#the-rust-book-for-drones">The Rust book for Drones</a></h1>
<h2 id="by-the-aerorust-community"><a class="header" href="#by-the-aerorust-community">by the AeroRust community</a></h2>
<p>TODO: who this book is intended for? What will people find in this book? What will they learn?</p>
<h2 id="todo"><a class="header" href="#todo">TODO:</a></h2>
<ol>
<li>Who this book is intended for?</li>
<li>What will people find in this book</li>
<li>What will they learn?</li>
</ol>

</main>

Expand Down
31 changes: 29 additions & 2 deletions print.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,12 @@ <h1 class="menu-title">The Rust book for Drones</h1>
<main>
<h1 id="the-rust-book-for-drones"><a class="header" href="#the-rust-book-for-drones">The Rust book for Drones</a></h1>
<h2 id="by-the-aerorust-community"><a class="header" href="#by-the-aerorust-community">by the AeroRust community</a></h2>
<p>TODO: who this book is intended for? What will people find in this book? What will they learn?</p>
<h2 id="todo"><a class="header" href="#todo">TODO:</a></h2>
<ol>
<li>Who this book is intended for?</li>
<li>What will people find in this book</li>
<li>What will they learn?</li>
</ol>
<div style="break-before: page; page-break-before: always;"></div><h1 id="running-a-simulation"><a class="header" href="#running-a-simulation">Running a simulation</a></h1>
<p>This is the easiest way to get started without the need of additional hardware,
apart from you laptop.</p>
Expand All @@ -149,7 +154,8 @@ <h2 id="software-requirements"><a class="header" href="#software-requirements">S
<li>Rust for <code>cargo run</code> (Install the <a href="https://rustup.rs/">Rust</a> programming language)</li>
<li>Git</li>
<li><code>ssh</code> key set on your GitHub profile, see <a href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh">Connecting to GitHub with SSH</a></li>
<li>QGroundControl (optional)</li>
<li><a href="running_a_simulation.html#qgroundcontrol-docker">QGroundControl (optional)</a></li>
<li><code>protoc</code> for running the <code>mav-sdk</code> build script when using the examples, see <a href="https://github.com/protocolbuffers/protobuf#protocol-compiler-installation">Protocol Compiler Installation</a>. Since <code>prost</code> version <code>0.11</code>, <code>protoc</code> is no longer automatically installed on the host machine.</li>
</ul>
<ol>
<li>
Expand All @@ -169,6 +175,27 @@ <h2 id="software-requirements"><a class="header" href="#software-requirements">S
<li>Take it to the skies</li>
</ol>
<pre><code>cargo run -p mav-sdk --example takeoff
</code></pre>
<h3 id="qgroundcontrol-docker"><a class="header" href="#qgroundcontrol-docker">QGroundControl Docker</a></h3>
<blockquote>
<p>QGroundControl provides full flight control and mission planning for any MAVLink enabled drone. Its primary goal is ease of use for professional users and developers. All the code is open-source source, so you can contribute and evolve it as you want.</p>
</blockquote>
<ul>
<li><em><a href="http://qgroundcontrol.com">qgroundcontrol.com</a></em></li>
</ul>
<p>In order to connect to the PX4 running inside Docker, use this setup:</p>
<p><img src="images/QGroundControl_Docker.png" alt="The setup required to connect QGroundControl to the MAVLink running in Docker" /></p>
<h3 id="connecting-gazebo-gui-client-to-gazebo-server-in-docker"><a class="header" href="#connecting-gazebo-gui-client-to-gazebo-server-in-docker">Connecting Gazebo GUI (client) to Gazebo server (in Docker)</a></h3>
<p>The <code>Gazebo</code> simulation tool usually runs a server and a GUI on the host machine,
however, our setup is running in <code>Docker</code> with mode <code>headless</code> for <code>Gazebo</code>,
so we only have the server running in <code>Docker</code>.</p>
<p><strong>IMPORTANT:</strong> You must have installed the exact same <code>Gazebo</code> version locally as the one found in the Docker setup, otherwise you won't be able to connect</p>
<p>On Linux:</p>
<pre><code class="language-bash">source /usr/share/gazebo-11/setup.sh &amp;&amp; \
gzclient --verbose
</code></pre>
<p><code>/usr/share/gazebo-11/setup.sh</code> contains a few default environment variables that you don't need to pass, otherwise use:</p>
<pre><code>GAZEBO_MASTER_URI=127.0.0.1:11345 gzclient --verbose
</code></pre>

</main>
Expand Down
24 changes: 23 additions & 1 deletion running_a_simulation.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,8 @@ <h2 id="software-requirements"><a class="header" href="#software-requirements">S
<li>Rust for <code>cargo run</code> (Install the <a href="https://rustup.rs/">Rust</a> programming language)</li>
<li>Git</li>
<li><code>ssh</code> key set on your GitHub profile, see <a href="https://docs.github.com/en/authentication/connecting-to-github-with-ssh">Connecting to GitHub with SSH</a></li>
<li>QGroundControl (optional)</li>
<li><a href="#qgroundcontrol-docker">QGroundControl (optional)</a></li>
<li><code>protoc</code> for running the <code>mav-sdk</code> build script when using the examples, see <a href="https://github.com/protocolbuffers/protobuf#protocol-compiler-installation">Protocol Compiler Installation</a>. Since <code>prost</code> version <code>0.11</code>, <code>protoc</code> is no longer automatically installed on the host machine.</li>
</ul>
<ol>
<li>
Expand All @@ -165,6 +166,27 @@ <h2 id="software-requirements"><a class="header" href="#software-requirements">S
<li>Take it to the skies</li>
</ol>
<pre><code>cargo run -p mav-sdk --example takeoff
</code></pre>
<h3 id="qgroundcontrol-docker"><a class="header" href="#qgroundcontrol-docker">QGroundControl Docker</a></h3>
<blockquote>
<p>QGroundControl provides full flight control and mission planning for any MAVLink enabled drone. Its primary goal is ease of use for professional users and developers. All the code is open-source source, so you can contribute and evolve it as you want.</p>
</blockquote>
<ul>
<li><em><a href="http://qgroundcontrol.com">qgroundcontrol.com</a></em></li>
</ul>
<p>In order to connect to the PX4 running inside Docker, use this setup:</p>
<p><img src="images/QGroundControl_Docker.png" alt="The setup required to connect QGroundControl to the MAVLink running in Docker" /></p>
<h3 id="connecting-gazebo-gui-client-to-gazebo-server-in-docker"><a class="header" href="#connecting-gazebo-gui-client-to-gazebo-server-in-docker">Connecting Gazebo GUI (client) to Gazebo server (in Docker)</a></h3>
<p>The <code>Gazebo</code> simulation tool usually runs a server and a GUI on the host machine,
however, our setup is running in <code>Docker</code> with mode <code>headless</code> for <code>Gazebo</code>,
so we only have the server running in <code>Docker</code>.</p>
<p><strong>IMPORTANT:</strong> You must have installed the exact same <code>Gazebo</code> version locally as the one found in the Docker setup, otherwise you won't be able to connect</p>
<p>On Linux:</p>
<pre><code class="language-bash">source /usr/share/gazebo-11/setup.sh &amp;&amp; \
gzclient --verbose
</code></pre>
<p><code>/usr/share/gazebo-11/setup.sh</code> contains a few default environment variables that you don't need to pass, otherwise use:</p>
<pre><code>GAZEBO_MASTER_URI=127.0.0.1:11345 gzclient --verbose
</code></pre>

</main>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion searchindex.json

Large diffs are not rendered by default.

0 comments on commit c082008

Please sign in to comment.