mirror of
https://github.com/okalachev/flix.git
synced 2025-07-27 09:39:33 +00:00
Updates to readme and documentation
This commit is contained in:
parent
4e0a1fcdab
commit
d1d10c4c6c
37
README.md
37
README.md
@ -15,18 +15,15 @@
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Simple and clean Arduino based source code.
|
* Dedicated for education and research.
|
||||||
* Acro and Stabilized flight using remote control.
|
* Made from general-purpose components.
|
||||||
* Precise simulation using Gazebo.
|
* Simple and clean source code in Arduino.
|
||||||
* [In-RAM logging](docs/log.md).
|
* Control using remote control or smartphone.
|
||||||
* Command line interface through USB port.
|
* Precise simulation with Gazebo.
|
||||||
* Wi-Fi support.
|
* Wi-Fi and MAVLink support.
|
||||||
* MAVLink support.
|
* Wireless command line interface and analyzing.
|
||||||
* Control using mobile phone (with QGroundControl app).
|
* Textbook on flight control theory and practice ([in development](https://quadcopter.dev)).
|
||||||
* Completely 3D-printed frame.
|
* *Position control (using external camera) and autonomous flights¹*.
|
||||||
* Textbook for students on writing a flight controller ([in development](https://quadcopter.dev)).
|
|
||||||
* *Position control and autonomous flights using external camera¹*.
|
|
||||||
* [Building and running instructions](docs/build.md).
|
|
||||||
|
|
||||||
*¹ — planned.*
|
*¹ — planned.*
|
||||||
|
|
||||||
@ -42,7 +39,7 @@ Version 0 demo video: https://youtu.be/8GzzIQ3C6DQ.
|
|||||||
|
|
||||||
See the [user builds gallery](docs/user.md).
|
See the [user builds gallery](docs/user.md).
|
||||||
|
|
||||||
<a href="docs/user.md"><img src="docs/img/user/user.jpg" width=400></a>
|
<a href="docs/user.md"><img src="docs/img/user/user.jpg" width=500></a>
|
||||||
|
|
||||||
## Simulation
|
## Simulation
|
||||||
|
|
||||||
@ -50,14 +47,22 @@ The simulator is implemented using Gazebo and runs the original Arduino code:
|
|||||||
|
|
||||||
<img src="docs/img/simulator1.png" width=500 alt="Flix simulator">
|
<img src="docs/img/simulator1.png" width=500 alt="Flix simulator">
|
||||||
|
|
||||||
See [instructions on running the simulation](docs/build.md).
|
## Articles
|
||||||
|
|
||||||
## Components (version 1)
|
* [Assembly instructions](docs/assembly.md).
|
||||||
|
* [Building and running the code](docs/build.md).
|
||||||
|
* [Troubleshooting](docs/troubleshooting.md).
|
||||||
|
* [Firmware architecture overview](docs/firmware.md).
|
||||||
|
* [Log analysis](docs/log.md).
|
||||||
|
* [User builds gallery](docs/user.md).
|
||||||
|
|
||||||
|
## Components
|
||||||
|
|
||||||
|Type|Part|Image|Quantity|
|
|Type|Part|Image|Quantity|
|
||||||
|-|-|:-:|:-:|
|
|-|-|:-:|:-:|
|
||||||
|Microcontroller board|ESP32 Mini|<img src="docs/img/esp32.jpg" width=100>|1|
|
|Microcontroller board|ESP32 Mini|<img src="docs/img/esp32.jpg" width=100>|1|
|
||||||
|IMU (and barometer²) board|GY‑91, MPU-9265 (or other MPU‑9250/MPU‑6500 board), ICM‑20948³|<img src="docs/img/gy-91.jpg" width=90 align=center><img src="docs/img/icm-20948.jpg" width=100>|1|
|
|IMU (and barometer²) board|GY‑91, MPU-9265 (or other MPU‑9250/MPU‑6500 board), ICM‑20948³|<img src="docs/img/gy-91.jpg" width=90 align=center><img src="docs/img/icm-20948.jpg" width=100>|1|
|
||||||
|
|<span style="background:yellow">(Recommended) Buck-boost converter</span>|To be determined, output 5V or 3.3V, see [user-contributed schematics](https://miro.com/app/board/uXjVN-dTjoo=/?moveToWidget=3458764612179508274&cot=14)|<img src="docs/img/buck-boost.jpg" width=100>|1|
|
||||||
|Motor|8520 3.7V brushed motor (shaft 0.8mm).<br>Motor with exact 3.7V voltage is needed, not ranged working voltage (3.7V — 6V).|<img src="docs/img/motor.jpeg" width=100>|4|
|
|Motor|8520 3.7V brushed motor (shaft 0.8mm).<br>Motor with exact 3.7V voltage is needed, not ranged working voltage (3.7V — 6V).|<img src="docs/img/motor.jpeg" width=100>|4|
|
||||||
|Propeller|Hubsan 55 mm|<img src="docs/img/prop.jpg" width=100>|4|
|
|Propeller|Hubsan 55 mm|<img src="docs/img/prop.jpg" width=100>|4|
|
||||||
|MOSFET (transistor)|100N03A or [analog](https://t.me/opensourcequadcopter/33)|<img src="docs/img/100n03a.jpg" width=100>|4|
|
|MOSFET (transistor)|100N03A or [analog](https://t.me/opensourcequadcopter/33)|<img src="docs/img/100n03a.jpg" width=100>|4|
|
||||||
@ -90,7 +95,7 @@ Tools required for assembly:
|
|||||||
|
|
||||||
Feel free to modify the design and or code, and create your own improved versions of Flix! Send your results to the [official Telegram chat](https://t.me/opensourcequadcopterchat), or directly to the author ([E-mail](mailto:okalachev@gmail.com), [Telegram](https://t.me/okalachev)).
|
Feel free to modify the design and or code, and create your own improved versions of Flix! Send your results to the [official Telegram chat](https://t.me/opensourcequadcopterchat), or directly to the author ([E-mail](mailto:okalachev@gmail.com), [Telegram](https://t.me/okalachev)).
|
||||||
|
|
||||||
## Schematics (version 1)
|
## Schematics
|
||||||
|
|
||||||
### Simplified connection diagram
|
### Simplified connection diagram
|
||||||
|
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
# Firmware overview
|
# Firmware overview
|
||||||
|
|
||||||
|
The firmware is a regular Arduino sketch, and follows the classic Arduino one-threaded design. The initialization code is in the `setup()` function, and the main loop is in the `loop()` function. The sketch includes multiple files, each responsible for a specific part of the system.
|
||||||
|
|
||||||
## Dataflow
|
## Dataflow
|
||||||
|
|
||||||
<img src="img/dataflow.svg" width=800 alt="Firmware dataflow diagram">
|
<img src="img/dataflow.svg" width=800 alt="Firmware dataflow diagram">
|
||||||
|
BIN
docs/img/buck-boost.jpg
Normal file
BIN
docs/img/buck-boost.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 33 KiB |
Loading…
x
Reference in New Issue
Block a user