|
|
@@ -1,3 +1,28 @@
|
|
|
+# About this repo
|
|
|
+First of all, I love Ardupilot. I use it on countless projects and encourage the others to use it, explaining its functionalities and why it is simply better. But since I am often building UAVs on inexpensive hardware (such as the F405 microcontroller) which are not capable of running the full Ardupilot.
|
|
|
+Therefore, I was often using [custom.ardupilot.org](https://custom.ardupilot.org) to build the firmware I needed. Ardupilot Devs did a great job in selecting the default feature for each boards however there were times when I needed to customise the feature in a more granular way (for instance, change the only VTX font the F405 can visualise replacing font0.bin - or the VTX table that in better Flight Controllers, is handled by a LUA Script.
|
|
|
+I then decided to clone the original repository and create this application.
|
|
|
+This version differs from the original upstream ArduPilot Custom Firmware Builder by introducing a dedicated Custom Overlay Manager, and features a lightweight, sidecar web application that allows developers to easily upload, create, and manage custom C files, hardware definitions, and folder structures directly from their browser.
|
|
|
+To support this, the core firmware builder script has been modified to automatically seek out these custom files and seamlessly inject them into the cloned ArduPilot source tree right before the compilation step begins.
|
|
|
+This should allow to test and build modified firmware without ever needing to manually fork or alter the base ArduPilot repository.
|
|
|
+
|
|
|
+The techical choice of adding a sidecar container is dictated by the need to keep this code as close as possible to the official repository. This makes importing the official upstream changes into this easily. So, the only modification done to this code specifically are in the `builder.py` and `index.html` template.
|
|
|
+
|
|
|
+### What's New in this Version
|
|
|
+
|
|
|
+This version differs from the original upstream ArduPilot Custom Firmware Builder by introducing a dedicated **Custom Overlay Manager**.
|
|
|
+
|
|
|
+**Key Enhancements:**
|
|
|
+- **Sidecar Web Application:** A lightweight interface that allows developers to easily upload, create, and manage custom C files, hardware definitions, and folder structures directly from their browser.
|
|
|
+- **Automated Source Injection:** The core firmware builder script has been modified to automatically seek out these custom files and seamlessly inject them into the cloned ArduPilot source tree right before the compilation step begins.
|
|
|
+
|
|
|
+### How to run this code
|
|
|
+
|
|
|
+Simply clone this repository and launch the docker container as explained in the official documentation, that I have copied below this paragraph...
|
|
|
+
|
|
|
+Safe flying!
|
|
|
+
|
|
|
+
|
|
|
# ArduPilot Custom Firmware Builder
|
|
|
|
|
|
## Table of Contents
|
Nicole Portas