Skip to content

armgit / flix

Public Imported from GitHub
0

Making an ESP32-based quadcopter from scratch

Add a readme to gazebo directory

Oleg Kalachev4850b95029cb
diff --git a/gazebo/README.md b/gazebo/README.md
new file mode 100644
index 0000000..3eef4ba
--- /dev/null
+++ b/gazebo/README.md
@@ -0,0 +1,15 @@
+# Gazebo Simulation
+
+<img src="../docs/img/simulator.png" width=500 alt="Flix simulator">
+
+## Building and running
+
+See [building and running instructions](../docs/build.md#simulation).
+
+## Code structure
+
+Flix simulator is based on [Gazebo Classic](https://classic.gazebosim.org) and consists of the following components:
+
+* Physical model of the drone: [`models/flix/flix.sdf`](models/flix/flix.sdf).
+* Plugin for Gazebo: [`simulator.cpp`](simulator.cpp). The plugin is attached to the physical model. It receives stick positions from the controller, gets the data from the virtual sensors, and then passes this data to the Arduino code.
+* Arduino imitation: [`Arduino.h`](Arduino.h). This file contains partial implementation of the Arduino API, that is working within Gazebo plugin environment.