Test simulation run

Now bool parameters also may be used.

.github/workflows/build.yml

@@ -10,28 +10,38 @@ on:
 jobs:
   build_linux:
     runs-on: ubuntu-latest
+    env:
+        ARDUINO_SKETCH_ALWAYS_EXPORT_BINARIES: 1
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Install Arduino CLI
       run: curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=/usr/local/bin sh
-    - name: Build firmware
+    - name: Build firmware for ESP32
-      env:
-        ARDUINO_SKETCH_ALWAYS_EXPORT_BINARIES: 1
       run: make
+    - name: Build firmware for ESP32-C3
+      run: make BOARD=esp32:esp32:esp32c3
+    - name: Build firmware for ESP32-S3
+      run: make BOARD=esp32:esp32:esp32s3:CDCOnBoot=cdc
+    - name: Build firmware for ESP32-S3 with QSPI PSRAM
+      run: make BOARD=esp32:esp32:esp32s3:CDCOnBoot=cdc,PSRAM=enabled EXTRA=--output-dir=flix/build/esp32.esp32.esp32s3.qspi
+    - name: Build firmware for ESP32-S3 with OPI PSRAM
+      run: make BOARD=esp32:esp32:esp32s3:CDCOnBoot=cdc,PSRAM=opi EXTRA=--output-dir=flix/build/esp32.esp32.esp32s3.opi
+    - name: Build firmware for Flix2
+      run: make BOARD=esp32:esp32:esp32s3:FlashSize=4M,CDCOnBoot=cdc,PSRAM=opi FLAGS=-DFLIX2 EXTRA=--output-dir=flix/build/esp32.esp32.flix2
     - name: Upload binaries
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v7
       with:
         name: firmware-binary
         path: flix/build
-    - name: Build firmware without Wi-Fi
+    - name: Build espnow-proxy
-      run: sed -i 's/^#define WIFI_ENABLED 1$/#define WIFI_ENABLED 0/' flix/flix.ino && make
+      run: arduino-cli compile --fqbn esp32:esp32:esp32 tools/espnow-proxy
     - name: Check c_cpp_properties.json
       run: tools/check_c_cpp_properties.py
 
   build_macos:
     runs-on: macos-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Install Arduino CLI
       run: brew install arduino-cli
     - name: Build firmware
@@ -42,7 +52,7 @@ jobs:
   build_windows:
     runs-on: windows-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Install Arduino CLI
       run: choco install arduino-cli
     - name: Install Make
@@ -53,18 +63,37 @@ jobs:
       run: python3 tools/check_c_cpp_properties.py
 
   build_simulator:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
+    container:
+      image: ubuntu:20.04
     steps:
+    - name: Install dependencies
+      run: |
+        apt-get update
+        DEBIAN_FRONTEND=noninteractive apt-get install -y curl wget build-essential cmake g++ pkg-config gnupg2 lsb-release sudo
     - name: Install Arduino CLI
-      uses: arduino/setup-arduino-cli@v1.1.1
+      run: curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=/usr/local/bin sh
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Install Gazebo
-      run: curl -sSL http://get.gazebosim.org | sh
+      run: |
+        sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list'
+        wget https://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -
+        sudo apt-get update
+        sudo apt-get install -y gazebo11 libgazebo11-dev
     - name: Install SDL2
-      run: sudo apt-get install libsdl2-dev
+      run: sudo apt-get install -y libsdl2-dev
     - name: Build simulator
       run: make build_simulator
-    - uses: actions/upload-artifact@v4
+    - name: Run simulator
+      env:
+        GAZEBO_MODEL_PATH: ${{ github.workspace }}/gazebo/models
+        GAZEBO_PLUGIN_PATH: ${{ github.workspace }}/gazebo/build
+      run: |
+        OUT=$(timeout -k 10s 120s gzserver --verbose gazebo/flix.world 2>&1 | tee /dev/stderr)
+        if echo "$OUT" | grep -Pq "\[Err\](?! \[RenderEngine)"; then
+          exit 1
+        fi
+    - uses: actions/upload-artifact@v7
       with:
         name: gazebo-plugin-binary
         path: gazebo/build/*.so
@@ -76,7 +105,7 @@ jobs:
     steps:
     - name: Install Arduino CLI
       run: brew install arduino-cli
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Clean up python binaries # Workaround for https://github.com/actions/setup-python/issues/577
       run: |
         rm -f /usr/local/bin/2to3*

.github/workflows/docs.yml

@@ -8,6 +8,7 @@ on:
 
 permissions:
   contents: read
+  actions: read
   pages: write
   id-token: write
 
@@ -15,7 +16,7 @@ jobs:
   markdownlint:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Install markdownlint
       run: npm install -g markdownlint-cli2
     - name: Run markdownlint
@@ -24,19 +25,57 @@ jobs:
   build_book:
     runs-on: ubuntu-latest
     needs: markdownlint
+    env:
+      BINARIES: ${{ github.event_name == 'push' && (github.ref_name == 'master' || github.ref_name == 'dev') && github.repository == 'okalachev/flix' }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Install mdBook
       run: cargo install mdbook --vers 0.4.43 --locked
     - name: Build book
       run: cd docs && mdbook build
+    - name: Wait for Build to complete
+      if: ${{ env.BINARIES }}
+      uses: lewagon/wait-on-check-action@v1.9.1
+      with:
+        ref: ${{ github.sha }}
+        check-name: build_linux
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        wait-interval: 30
+    - name: Find firmware binaries
+      if: ${{ env.BINARIES }}
+      id: build_run
+      run: |
+        RUN_ID=$(gh api "repos/${{ github.repository }}/actions/workflows/build.yml/runs?head_sha=${{ github.sha }}&per_page=1" --jq '.workflow_runs[0].id')
+        echo "id=$RUN_ID" >> $GITHUB_OUTPUT
+      env:
+        GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Download firmware binaries
+      if: ${{ env.BINARIES }}
+      uses: actions/download-artifact@v7
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        repository: ${{ github.repository }}
+        run-id: ${{ steps.build_run.outputs.id }}
+        name: firmware-binary
+        path: docs/build
+    - name: Create shortcuts for firmware binaries
+      if: ${{ env.BINARIES }}
+      working-directory: docs/build
+      run: |
+        for FQBN in esp32.esp32.*; do
+          zip -r $FQBN.zip $FQBN
+          BOARD="${FQBN#esp32.esp32.}"
+          ln -s "$FQBN/flix.ino.merged.bin" "flix.$BOARD.merged.bin"
+          ln -s "$FQBN/flix.ino.bin" "flix.$BOARD.bin"
+          ln -s "$FQBN/flix.ino.bootloader.bin" "flix.$BOARD.bootloader.bin"
+        done
     - name: Upload artifact
-      uses: actions/upload-pages-artifact@v3
+      uses: actions/upload-pages-artifact@v5
       with:
         path: docs/build
 
   deploy:
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+    if: ${{ github.event_name == 'push' && github.ref_name == 'master' }}
     concurrency:
       group: "pages"
       cancel-in-progress: true
@@ -48,4 +87,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@v5

.github/workflows/tools.yml

@@ -10,7 +10,7 @@ jobs:
   csv_to_ulog:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Build csv_to_ulog
       run: cd tools/csv_to_ulog && mkdir build && cd build && cmake .. && make
     - name: Test csv_to_ulog
@@ -22,13 +22,13 @@ jobs:
   pyflix:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Install Python build tools
       run: pip install build
     - name: Build pyflix
       run: python3 -m build tools
     - name: Upload artifacts
-      uses: actions/upload-artifact@v4
+      uses: actions/upload-artifact@v7
       with:
         name: pyflix
         path: |
@@ -37,7 +37,7 @@ jobs:
   python_tools:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - name: Install Python dependencies
       run: pip install -r tools/requirements.txt
     - name: Test csv_to_mcap tool
@@ -46,3 +46,23 @@ jobs:
         echo -e "t,x,y,z\n0,1,2,3\n1,4,5,6" > log.csv
         ./csv_to_mcap.py log.csv
         test $(stat -c %s log.mcap) -eq 883
+  sloc:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v7
+    - run: sudo apt-get install -y cloc jq
+    - name: Print source lines of code
+      run: cloc --by-file-by-lang flix
+    - name: Checkout previous revision
+      uses: actions/checkout@v7
+      with:
+        ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.base.sha || github.event.before }}
+        path: prev
+    - name: Annotate total source lines
+      run: |
+        SLOC_CURR=$(cloc flix --json | jq -r '.SUM.code')
+        SLOC_PREV=$(cloc prev/flix --json | jq -r '.SUM.code')
+        DIFF=$(printf '%+d' "$((SLOC_CURR - SLOC_PREV))")
+        echo "* Current SLOC: $SLOC_CURR" >> $GITHUB_STEP_SUMMARY
+        echo "* Previous SLOC: $SLOC_PREV" >> $GITHUB_STEP_SUMMARY
+        echo "* Diff: $DIFF" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -4,9 +4,10 @@ build/
 tools/log/
 tools/dist/
 *.egg-info/
-.dependencies
+.core
+.libs
 .vscode/*
-!.vscode/settings.json
+!.vscode/settings.default.json
 !.vscode/c_cpp_properties.json
 !.vscode/tasks.json
 !.vscode/launch.json

.markdownlint.json

@@ -7,6 +7,8 @@
 	"MD024": false,
 	"MD033": false,
 	"MD034": false,
+	"MD040": false,
+	"MD059": false,
 	"MD044": {
 		"html_elements": false,
 		"code_blocks": false,
@@ -64,5 +66,6 @@
 			"PX4"
 		]
 	},
-	"MD045": false
+	"MD045": false,
+	"MD060": false
 }

.vscode/c_cpp_properties.json

@@ -5,18 +5,19 @@
 			"includePath": [
 				"${workspaceFolder}/flix",
 				"${workspaceFolder}/gazebo",
-				"~/.arduino15/packages/esp32/hardware/esp32/3.2.0/cores/esp32",
+				"${workspaceFolder}/tools/**",
-				"~/.arduino15/packages/esp32/hardware/esp32/3.2.0/libraries/**",
+				"~/.arduino15/packages/esp32/hardware/esp32/3.3.10/cores/esp32",
-				"~/.arduino15/packages/esp32/hardware/esp32/3.2.0/variants/d1_mini32",
+				"~/.arduino15/packages/esp32/hardware/esp32/3.3.10/libraries/**",
-				"~/.arduino15/packages/esp32/tools/esp32-arduino-libs/idf-release_v5.4-2f7dcd86-v1/esp32/**",
+				"~/.arduino15/packages/esp32/hardware/esp32/3.3.10/variants/d1_mini32",
-				"~/.arduino15/packages/esp32/tools/esp32-arduino-libs/idf-release_v5.4-2f7dcd86-v1/esp32/dio_qspi/include",
+				"~/.arduino15/packages/esp32/tools/esp32-libs/3.3.10/include/**",
 				"~/Arduino/libraries/**",
-				"/usr/include/**"
+				"/usr/include/gazebo-11/",
+				"/usr/include/ignition/math6/"
 			],
 			"forcedInclude": [
 				"${workspaceFolder}/.vscode/intellisense.h",
-				"~/.arduino15/packages/esp32/hardware/esp32/3.2.0/cores/esp32/Arduino.h",
+				"~/.arduino15/packages/esp32/hardware/esp32/3.3.10/cores/esp32/Arduino.h",
-				"~/.arduino15/packages/esp32/hardware/esp32/3.2.0/variants/d1_mini32/pins_arduino.h",
+				"~/.arduino15/packages/esp32/hardware/esp32/3.3.10/variants/d1_mini32/pins_arduino.h",
 				"${workspaceFolder}/flix/cli.ino",
 				"${workspaceFolder}/flix/control.ino",
 				"${workspaceFolder}/flix/estimate.ino",
@@ -29,9 +30,10 @@
 				"${workspaceFolder}/flix/rc.ino",
 				"${workspaceFolder}/flix/time.ino",
 				"${workspaceFolder}/flix/wifi.ino",
-				"${workspaceFolder}/flix/parameters.ino"
+				"${workspaceFolder}/flix/parameters.ino",
+				"${workspaceFolder}/flix/safety.ino"
 			],
-			"compilerPath": "~/.arduino15/packages/esp32/tools/esp-x32/2411/bin/xtensa-esp32-elf-g++",
+			"compilerPath": "~/.arduino15/packages/esp32/tools/esp-x32/2601/bin/xtensa-esp32-elf-g++",
 			"cStandard": "c11",
 			"cppStandard": "c++17",
 			"defines": [
@@ -51,19 +53,18 @@
 			"name": "Mac",
 			"includePath": [
 				"${workspaceFolder}/flix",
-				// "${workspaceFolder}/gazebo",
+				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.3.10/cores/esp32",
-				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.2.0/cores/esp32",
+				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.3.10/libraries/**",
-				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.2.0/libraries/**",
+				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.3.10/variants/d1_mini32",
-				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.2.0/variants/d1_mini32",
+				"~/Library/Arduino15/packages/esp32/tools/esp32-libs/3.3.10/include/**",
-				"~/Library/Arduino15/packages/esp32/tools/esp32-arduino-libs/idf-release_v5.4-2f7dcd86-v1/esp32/include/**",
-				"~/Library/Arduino15/packages/esp32/tools/esp32-arduino-libs/idf-release_v5.4-2f7dcd86-v1/esp32/dio_qspi/include",
 				"~/Documents/Arduino/libraries/**",
-				"/opt/homebrew/include/**"
+				"/opt/homebrew/include/gazebo-11/",
+				"/opt/homebrew/include/ignition/math6/"
 			],
 			"forcedInclude": [
 				"${workspaceFolder}/.vscode/intellisense.h",
-				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.2.0/cores/esp32/Arduino.h",
+				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.3.10/cores/esp32/Arduino.h",
-				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.2.0/variants/d1_mini32/pins_arduino.h",
+				"~/Library/Arduino15/packages/esp32/hardware/esp32/3.3.10/variants/d1_mini32/pins_arduino.h",
 				"${workspaceFolder}/flix/flix.ino",
 				"${workspaceFolder}/flix/cli.ino",
 				"${workspaceFolder}/flix/control.ino",
@@ -76,9 +77,10 @@
 				"${workspaceFolder}/flix/rc.ino",
 				"${workspaceFolder}/flix/time.ino",
 				"${workspaceFolder}/flix/wifi.ino",
-				"${workspaceFolder}/flix/parameters.ino"
+				"${workspaceFolder}/flix/parameters.ino",
+				"${workspaceFolder}/flix/safety.ino"
 			],
-			"compilerPath": "~/Library/Arduino15/packages/esp32/tools/esp-x32/2411/bin/xtensa-esp32-elf-g++",
+			"compilerPath": "~/Library/Arduino15/packages/esp32/tools/esp-x32/2601/bin/xtensa-esp32-elf-g++",
 			"cStandard": "c11",
 			"cppStandard": "c++17",
 			"defines": [
@@ -100,17 +102,17 @@
 			"includePath": [
 				"${workspaceFolder}/flix",
 				"${workspaceFolder}/gazebo",
-				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.2.0/cores/esp32",
+				"${workspaceFolder}/tools/**",
-				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.2.0/libraries/**",
+				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.3.10/cores/esp32",
-				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.2.0/variants/d1_mini32",
+				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.3.10/libraries/**",
-				"~/AppData/Local/Arduino15/packages/esp32/tools/esp32-arduino-libs/idf-release_v5.4-2f7dcd86-v1/esp32/**",
+				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.3.10/variants/d1_mini32",
-				"~/AppData/Local/Arduino15/packages/esp32/tools/esp32-arduino-libs/idf-release_v5.4-2f7dcd86-v1/esp32/dio_qspi/include",
+				"~/AppData/Local/Arduino15/packages/esp32/tools/esp32-libs/3.3.10/include/**",
 				"~/Documents/Arduino/libraries/**"
 			],
 			"forcedInclude": [
 				"${workspaceFolder}/.vscode/intellisense.h",
-				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.2.0/cores/esp32/Arduino.h",
+				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.3.10/cores/esp32/Arduino.h",
-				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.2.0/variants/d1_mini32/pins_arduino.h",
+				"~/AppData/Local/Arduino15/packages/esp32/hardware/esp32/3.3.10/variants/d1_mini32/pins_arduino.h",
 				"${workspaceFolder}/flix/cli.ino",
 				"${workspaceFolder}/flix/control.ino",
 				"${workspaceFolder}/flix/estimate.ino",
@@ -123,9 +125,10 @@
 				"${workspaceFolder}/flix/rc.ino",
 				"${workspaceFolder}/flix/time.ino",
 				"${workspaceFolder}/flix/wifi.ino",
-				"${workspaceFolder}/flix/parameters.ino"
+				"${workspaceFolder}/flix/parameters.ino",
+				"${workspaceFolder}/flix/safety.ino"
 			],
-			"compilerPath": "~/AppData/Local/Arduino15/packages/esp32/tools/esp-x32/2411/bin/xtensa-esp32-elf-g++.exe",
+			"compilerPath": "~/AppData/Local/Arduino15/packages/esp32/tools/esp-x32/2601/bin/xtensa-esp32-elf-g++.exe",
 			"cStandard": "c11",
 			"cppStandard": "c++17",
 			"defines": [

.vscode/extensions.json

@@ -1,6 +1,7 @@
 {
 	// See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
 	"recommendations": [
+		"dangmai.workspace-default-settings",
 		"ms-vscode.cpptools",
 		"ms-vscode.cmake-tools",
 		"ms-python.python"

.vscode/settings.default.json

@@ -1,5 +1,6 @@
 {
 	"C_Cpp.intelliSenseEngineFallback": "enabled",
+	"C_Cpp.errorSquiggles": "disabled",
 	"files.associations": {
 		"*.sdf": "xml",
 		"*.ino": "cpp",

Makefile

@@ -1,29 +1,44 @@
-BOARD = esp32:esp32:d1_mini32
+BOARD = esp32:esp32:esp32
-PORT := $(wildcard /dev/serial/by-id/usb-Silicon_Labs_CP21* /dev/serial/by-id/usb-1a86_USB_Single_Serial_* /dev/cu.usbserial-*)
+PORT := $(strip $(wildcard /dev/serial/by-id/usb-Silicon_Labs_CP21* /dev/serial/by-id/usb-1a86_USB_Single_Serial_* /dev/cu.usbserial-* /dev/cu.usbmodem*))
-PORT := $(strip $(PORT))
+VERSION = $(shell git describe --always --dirty)
 
-build: .dependencies
+export ARDUINO_NETWORK_CONNECTION_TIMEOUT := 1h
-	arduino-cli compile --fqbn $(BOARD) flix
+
+build: .core .libs
+	arduino-cli compile flix \
+		--fqbn $(BOARD) \
+		--build-property "build.core_debug_level=1" \
+		--build-property "compiler.cpp.extra_flags=-DVERSION=$(VERSION) $(FLAGS)" $(EXTRA)
 
 upload: build
-	arduino-cli upload --fqbn $(BOARD) -p "$(PORT)" flix
+	arduino-cli upload flix --fqbn $(BOARD) -p "$(PORT)"
+
+erase:
+	arduino-cli burn-bootloader --fqbn $(BOARD) -p "$(PORT)" -P esptool
 
 monitor:
 	arduino-cli monitor -p "$(PORT)" -c baudrate=115200
 
-dependencies .dependencies:
+core .core:
-	arduino-cli core update-index --config-file arduino-cli.yaml
+	arduino-cli core update-index --additional-urls https://espressif.github.io/arduino-esp32/package_esp32_index.json
-	arduino-cli core install esp32:esp32@3.2.0 --config-file arduino-cli.yaml
+	arduino-cli core install esp32:esp32@3.3.10 --additional-urls https://espressif.github.io/arduino-esp32/package_esp32_index.json
+	touch .core
+
+libs .libs:
 	arduino-cli lib update-index
-	arduino-cli lib install "FlixPeriph"
+	ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=1 arduino-cli lib install --git-url 'https://github.com/okalachev/flixperiph.git#dev'
-	arduino-cli lib install "MAVLink"@2.0.16
+	arduino-cli lib install "MAVLink"@2.0.25
-	touch .dependencies
+	touch .libs
+
+upload_proxy: .core .libs
+	arduino-cli compile tools/espnow-proxy --fqbn $(BOARD)
+	arduino-cli upload tools/espnow-proxy --fqbn $(BOARD) -p "$(PORT)"
 
 gazebo/build cmake: gazebo/CMakeLists.txt
 	mkdir -p gazebo/build
 	cd gazebo/build && cmake ..
 
-build_simulator: .dependencies gazebo/build
+build_simulator: .libs gazebo/build
 	make -C gazebo/build
 
 simulator: build_simulator
@@ -32,12 +47,12 @@ simulator: build_simulator
 	gazebo --verbose ${CURDIR}/gazebo/flix.world
 
 log:
-	PORT=$(PORT) tools/grab_log.py
+	tools/log.py
 
 plot:
 	plotjuggler -d $(shell ls -t tools/log/*.csv | head -n1)
 
 clean:
-	rm -rf gazebo/build flix/build flix/cache .dependencies
+	rm -rf gazebo/build flix/build flix/cache .core .libs
 
-.PHONY: build upload monitor dependencies cmake build_simulator simulator log clean
+.PHONY: build upload monitor core libs cmake build_simulator simulator log clean

README.md

@@ -1,6 +1,9 @@
-# Flix
+<!-- markdownlint-disable MD041 -->
 
-**Flix** (*flight + X*) — making an open source ESP32-based quadcopter from scratch.
+<p align="center">
+  <img src="docs/img/flix.svg" width=180 alt="Flix logo"><br>
+  <b>Flix</b> (<i>flight + X</i>) — open source ESP32-based quadcopter made from scratch.
+</p>
 
 <table>
   <tr>
@@ -17,16 +20,14 @@
 
 * Dedicated for education and research.
 * Made from general-purpose components.
-* Simple and clean source code in Arduino.
+* Simple and clean source code in Arduino (<2k lines firmware).
-* Control using remote control or smartphone.
+* Communication using MAVLink protocol over Wi-Fi or ESP-NOW.
-* Precise simulation with Gazebo.
+* Control with USB gamepad, remote control or smartphone.
-* Wi-Fi and MAVLink support.
 * Wireless command line interface and analyzing.
-* Python library.
+* Precise simulation with Gazebo.
+* Python library for scripting and automatic flights.
 * Textbook on flight control theory and practice ([in development](https://quadcopter.dev)).
-* *Position control (using external camera) and autonomous flights¹*.
+* *Position control (planned)*.
-
-*¹ — planned.*
 
 ## It actually flies
 
@@ -38,55 +39,75 @@ Version 0 demo video: https://youtu.be/8GzzIQ3C6DQ.
 
 <a href="https://youtu.be/8GzzIQ3C6DQ"><img width=500 src="https://i3.ytimg.com/vi/8GzzIQ3C6DQ/maxresdefault.jpg"></a>
 
-See the [user builds gallery](docs/user.md).
+Usage in education (RoboCamp): https://youtu.be/Wd3yaorjTx0.
+
+<a href="https://youtu.be/Wd3yaorjTx0"><img width=500 src="https://i3.ytimg.com/vi/Wd3yaorjTx0/sddefault.jpg"></a>
+
+See the [user builds gallery](docs/user.md):
 
 <a href="docs/user.md"><img src="docs/img/user/user.jpg" width=500></a>
 
+### PCB
+
+The official PCB *(Flix2)* is in development now. Follow the [project's channel](https://t.me/opensourcequadcopter) to track the progress.
+
+Outdoor flights demo video of the current prototype:
+
+<a href="https://youtu.be/KXlNmvUTi4g"><img width=300 src="https://i3.ytimg.com/vi/KXlNmvUTi4g/maxresdefault.jpg"></a>
+
+### Position control
+
+The position control feature is in development. RoboCamp 2026 demo (using an overhead camera, [sources](https://github.com/xTimop/flix-poscontrol/compare/robolager2026...xTimop:flix-poscontrol:poscontrol)):
+
+<a href="https://youtu.be/369Xowm4HcU"><img width=300 src="https://i3.ytimg.com/vi/369Xowm4HcU/maxresdefault.jpg"></a>
+
 ## Simulation
 
 The simulator is implemented using Gazebo and runs the original Arduino code:
 
 <img src="docs/img/simulator1.png" width=500 alt="Flix simulator">
 
-## Articles
+## Documentation articles
+
+1. [Assembly instructions](docs/assembly.md).
+2. [Usage: build, setup and flight](docs/usage.md).
+3. [Simulation](gazebo/README.md).
+4. [Python library](tools/pyflix/README.md).
+
+Additional articles:
 
-* [Assembly instructions](docs/assembly.md).
-* [Building and running the code](docs/build.md).
-* [Troubleshooting](docs/troubleshooting.md).
-* [Firmware architecture overview](docs/firmware.md).
-* [Python library tutorial](tools/pyflix/README.md).
-* [Log analysis](docs/log.md).
 * [User builds gallery](docs/user.md).
+* [Firmware architectural overview](docs/firmware.md).
+* [Troubleshooting](docs/troubleshooting.md).
+* [Log analysis](docs/log.md).
 
 ## Components
 
 |Type|Part|Image|Quantity|
 |-|-|:-:|:-:|
-|Microcontroller board|ESP32 Mini|<img src="docs/img/esp32.jpg" width=100>|1|
+|Microcontroller board|ESP32 Mini.<br>ESP32-S3/ESP32-C3 boards are also supported.|<img src="docs/img/esp32.jpg" width=100>|1|
-|IMU (and barometer²) board|GY‑91, MPU-9265 (or other MPU‑9250/MPU‑6500 board)<br>ICM‑20948³<br>GY-521 (MPU-6050)³⁻¹|<img src="docs/img/gy-91.jpg" width=90 align=center><br><img src="docs/img/icm-20948.jpg" width=100><br><img src="docs/img/gy-521.jpg" width=100>|1|
+|IMU (and barometer¹) board|GY‑91, MPU-9265 (or other MPU‑9250/MPU‑6500 board)<br>ICM20948V2 (ICM‑20948)<br>GY-521 (MPU-6050)|<img src="docs/img/gy-91.jpg" width=90 align=center><br><img src="docs/img/icm-20948.jpg" width=100><br><img src="docs/img/gy-521.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|
+|*Boost converter (optional, for more stable power supply)*|*5V output*|<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.<br>Motor with exact 3.7V voltage is needed, not ranged working voltage (3.7V — 6V).<br>Make sure the motor shaft diameter and propeller hole diameter match!|<img src="docs/img/motor.jpeg" width=100>|4|
-|Propeller|Hubsan 55 mm|<img src="docs/img/prop.jpg" width=100>|4|
+|Propeller|55 mm or 65 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)|UMW 100N03A or [analog](https://t.me/opensourcequadcopter/33).<br>Warning: don't use KIA 100N03A or other manufacturers, they might not work!|<img src="docs/img/100n03a.jpg" width=100>|4|
-|Pull-down resistor|10 kΩ|<img src="docs/img/resistor10k.jpg" width=100>|4|
+|Pull-down resistor<br>Voltage measurement resistor|10 kΩ|<img src="docs/img/resistor10k.jpg" width=100>|6|
-|3.7V Li-Po battery|LW 952540 (or any compatible by the size)|<img src="docs/img/battery.jpg" width=100>|1|
+|3.7V Li-Po battery|LW 952540 (or any compatible by the size).<br>Make sure the battery has enough discharge rate — 25C or more!|<img src="docs/img/battery.jpg" width=100>|1|
 |Battery connector cable|MX2.0 2P female|<img src="docs/img/mx.png" width=100>|1|
 |Li-Po Battery charger|Any|<img src="docs/img/charger.jpg" width=100>|1|
 |Screws for IMU board mounting|M3x5|<img src="docs/img/screw-m3.jpg" width=100>|2|
 |Screws for frame assembly|M1.4x5|<img src="docs/img/screw-m1.4.jpg" height=30 align=center>|4|
-|Frame main part|3D printed⁴:<br>[`flix-frame-1.1.stl`](docs/assets/flix-frame-1.1.stl) [`flix-frame-1.1.step`](docs/assets/flix-frame-1.1.step)<br>Recommended settings: layer 0.2 mm, line 0.4 mm, infill 100%.|<img src="docs/img/frame1.jpg" width=100>|1|
+|Frame main part|3D printed²: [`stl`](docs/assets/flix-frame-1.1.stl) [`step`](docs/assets/flix-frame-1.1.step)<br>Recommended settings: layer 0.2 mm, line 0.4 mm, infill 100%.|<img src="docs/img/frame1.jpg" width=100>|1|
-|Frame top part|3D printed:<br>[`esp32-holder.stl`](docs/assets/esp32-holder.stl) [`esp32-holder.step`](docs/assets/esp32-holder.step)|<img src="docs/img/esp32-holder.jpg" width=100>|1|
+|Frame top part|3D printed: [`stl`](docs/assets/esp32-holder.stl) [`step`](docs/assets/esp32-holder.step)|<img src="docs/img/esp32-holder.jpg" width=100>|1|
-|Washer for IMU board mounting|3D printed:<br>[`washer-m3.stl`](docs/assets/washer-m3.stl) [`washer-m3.step`](docs/assets/washer-m3.step)|<img src="docs/img/washer-m3.jpg" width=100>|2|
+|Washer for IMU board mounting|3D printed: [`stl`](docs/assets/washer-m3.stl) [`step`](docs/assets/washer-m3.step)|<img src="docs/img/washer-m3.jpg" width=100>|2|
-|*RC transmitter (optional)*|*KINGKONG TINY X8 (warning: lacks USB support) or other⁵*|<img src="docs/img/tx.jpg" width=100>|1|
+|Controller (recommended)|CC2500 transmitter, like BetaFPV LiteRadio CC2500 (RC receiver/Wi-Fi).<br>Two-sticks gamepad (Wi-Fi only) — see [recommended gamepads](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/setup_view/joystick.html#supported-joysticks).<br>Other⁵|<img src="docs/img/betafpv.jpg" width=100><img src="docs/img/logitech.jpg" width=80>|1|
-|*RC receiver (optional)*|*DF500 or other⁵*|<img src="docs/img/rx.jpg" width=100>|1|
+|*RC receiver (optional)*|*DF500 or other³*|<img src="docs/img/rx.jpg" width=100>|1|
 |Wires|28 AWG recommended|<img src="docs/img/wire-28awg.jpg" width=100>||
 |Tape, double-sided tape||||
 
-*² — barometer is not used for now.*<br>
+*¹ — barometer is not used for now.*<br>
-*³ — change `MPU9250` to `ICM20948` in `imu.ino` file if using ICM-20948 board.*<br>
+*² — this frame is optimized for GY-91 board, if using other, the board mount holes positions should be modified.*<br>
-*³⁻¹ — MPU-6050 supports I²C interface only (not recommended). To use it change IMU declaration to `MPU6050 IMU(Wire)`.*<br>
+*³ — you also may use any transmitter-receiver pair with SBUS interface.*
-*⁴ — this frame is optimized for GY-91 board, if using other, the board mount holes positions should be modified.*<br>
-*⁵ — you may use any transmitter-receiver pair with SBUS interface.*
 
 Tools required for assembly:
 
@@ -96,13 +117,15 @@ Tools required for assembly:
 * Screwdrivers.
 * Multimeter.
 
-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. 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
 
 ### Simplified connection diagram
 
-<img src="docs/img/schematics1.svg" width=800 alt="Flix version 1 schematics">
+<img src="docs/img/schematics1.svg" width=700 alt="Flix version 1 schematics">
+
+*(Dashed elements are optional).*
 
 Motor connection scheme:
 
@@ -110,8 +133,6 @@ Motor connection scheme:
 
 You can see a user-contributed [variant of complete circuit diagram](https://miro.com/app/board/uXjVN-dTjoo=/?moveToWidget=3458764612338222067&cot=14) of the drone.
 
-See [assembly guide](docs/assembly.md) for instructions on assembling the drone.
-
 ### Notes
 
 * Power ESP32 Mini with Li-Po battery using VCC (+) and GND (-) pins.
@@ -129,14 +150,15 @@ See [assembly guide](docs/assembly.md) for instructions on assembling the drone.
 * Solder pull-down resistors to the MOSFETs.
 * Connect the motors to the ESP32 Mini using MOSFETs, by following scheme:
 
-  |Motor|Position|Direction|Wires|GPIO|
+  |Motor|Position|Direction|Prop type|Motor wires|GPIO|
-  |-|-|-|-|-|
+  |-|-|-|-|-|-|
-  |Motor 0|Rear left|Counter-clockwise|Black & White|GPIO12 (*TDI*)|
+  |Motor 0|Rear left|Counter-clockwise|B|Black & White|GPIO12 *(TDI)*|
-  |Motor 1|Rear right|Clockwise|Blue & Red|GPIO13 (*TCK*)|
+  |Motor 1|Rear right|Clockwise|A|Blue & Red|GPIO13 *(TCK)*|
-  |Motor 2|Front right|Counter-clockwise|Black & White|GPIO14 (*TMS*)|
+  |Motor 2|Front right|Counter-clockwise|B|Black & White|GPIO14 *(TMS)*|
-  |Motor 3|Front left|Clockwise|Blue & Red|GPIO15 (*TD0*)|
+  |Motor 3|Front left|Clockwise|A|Blue & Red|GPIO15 *(TD0)*|
 
-  Counter-clockwise motors have black and white wires and clockwise motors have blue and red wires.
+  Clockwise motors have blue & red wires and correspond to propeller type A (marked on the propeller).
+  Counter-clockwise motors have black & white wires correspond to propeller type B.
 
 * Optionally connect the RC receiver to the ESP32's UART2:
 
@@ -144,32 +166,20 @@ See [assembly guide](docs/assembly.md) for instructions on assembling the drone.
   |-|-|
   |GND|GND|
   |VIN|VCC (or 3.3V depending on the receiver)|
-  |Signal (TX)|GPIO4⁶|
+  |Signal (TX)|GPIO4|
 
-*⁶ — UART2 RX pin was [changed](https://docs.espressif.com/projects/arduino-esp32/en/latest/migration_guides/2.x_to_3.0.html#id14) to GPIO4 in Arduino ESP32 core 3.0.*
+* Optionally connect the battery voltage divider for voltage monitoring to any ADC1 pin (e. g. *GPIO32* on ESP32, *GPIO3* on ESP32-S3).
 
-### IMU placement
+  ESP32 and ESP32-S3 [can measure](https://docs.espressif.com/projects/arduino-esp32/en/latest/api/adc.html#analogsetattenuation) up to 3.1 V and ESP32-S3/ESP32-C3 can measure up to 2.5 V, so choose the voltage divider resistors accordingly.
 
-Default IMU orientation in the code is **LFD** (Left-Forward-Down):
+## Resources
 
-<img src="docs/img/gy91-lfd.svg" width=400 alt="GY-91 axes">
+* Telegram channel on developing the drone and the flight controller (in Russian): https://t.me/opensourcequadcopter.
-
+* Official Telegram chat: https://t.me/opensourcequadcopterchat (English / Russian).
-In case of using other IMU orientation, modify the `rotateIMU` function in the `imu.ino` file.
+* Detailed article on Habr.com about the development of the drone (in Russian): https://habr.com/ru/articles/814127/.
-
-See [FlixPeriph documentation](https://github.com/okalachev/flixperiph?tab=readme-ov-file#imu-axes-orientation) to learn axis orientation of other IMU boards.
-
-## Materials
-
-Subscribe to the Telegram channel on developing the drone and the flight controller (in Russian): https://t.me/opensourcequadcopter.
-
-Join the official Telegram chat: https://t.me/opensourcequadcopterchat.
-
-Detailed article on Habr.com about the development of the drone (in Russian): https://habr.com/ru/articles/814127/.
-
-See the information on the obsolete version 0 in the [corresponding article](docs/version0.md).
 
 ## Disclaimer
 
-This is a fun DIY project, and I hope you find it interesting and useful. However, it's not easy to assemble and set up, and it's provided "as is" without any warranties. There’s no guarantee that it will work perfectly — or even work at all.
+This is a DIY project, and I hope you find it interesting and useful. However, it's not easy to assemble and set up, and it's provided "as is" without any warranties. There's no guarantee that it will work perfectly, or even work at all.
 
 ⚠️ The author is not responsible for any damage, injury, or loss resulting from the use of this project. Use at your own risk!

arduino-cli.yaml

@@ -1,5 +0,0 @@
-board_manager:
-  additional_urls:
-    - https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
-network:
-  connection_timeout: 1h

docs/assembly.md

@@ -27,3 +27,29 @@ Soldered components ([schematics variant](https://miro.com/app/board/uXjVN-dTjoo
 <br>Assembled drone:
 
 <img src="img/assembly/7.jpg" width=600>
+
+See an alternative assembly process photos here: https://drive.google.com/drive/folders/1FG5BH9RCzdf1XmJcC70PymiRMXcz6Fx7?usp=sharing.
+
+## Motor directions
+
+> [!WARNING]
+> The drone above is an early build, and it has **inversed** motor directions scheme. The photos only illustrate the assembly process in general.
+
+Use standard motor directions scheme:
+
+<img src="img/motors.svg" width=200>
+
+Motors connection table:
+
+|Motor|Position|Direction|Prop type|Motor wires|GPIO|
+|-|-|-|-|-|-|
+|Motor 0|Rear left|Counter-clockwise|B|Black & White|GPIO12 *(TDI)*|
+|Motor 1|Rear right|Clockwise|A|Blue & Red|GPIO13 *(TCK)*|
+|Motor 2|Front right|Counter-clockwise|B|Black & White|GPIO14 *(TMS)*|
+|Motor 3|Front left|Clockwise|A|Blue & Red|GPIO15 *(TD0)*|
+
+## Motors tightening
+
+Motors should be installed very tightly — any vibration may lead to bad attitude estimation and unstable flight. If motors are loose, use tiny tape pieces to fix them tightly as shown below:
+
+<img src="img/motor-tape.jpg" width=600>

docs/book/firmware.md

@@ -1,8 +1,10 @@
 # Архитектура прошивки
 
-<img src="img/dataflow.svg" width=800 alt="Firmware dataflow diagram">
+Прошивка Flix это обычный скетч Arduino, реализованный в однопоточном стиле. Код инициализации находится в функции `setup()`, а главный цикл — в функции `loop()`. Скетч состоит из нескольких файлов, каждый из которых отвечает за определенную подсистему.
 
-Главный цикл работает на частоте 1000 Гц. Передача данных между подсистемами происходит через глобальные переменные:
+<img src="img/dataflow.svg" width=600 alt="Firmware dataflow diagram">
+
+Главный цикл `loop()` работает на частоте 1000 Гц. Передача данных между подсистемами происходит через глобальные переменные:
 
 * `t` *(float)* — текущее время шага, *с*.
 * `dt` *(float)* — дельта времени между текущим и предыдущим шагами, *с*.
@@ -10,23 +12,39 @@
 * `acc` *(Vector)* — данные с акселерометра, *м/с<sup>2</sup>*.
 * `rates` *(Vector)* — отфильтрованные угловые скорости, *рад/с*.
 * `attitude` *(Quaternion)* — оценка ориентации (положения) дрона.
-* `controlRoll`, `controlPitch`, ... *(float[])* — команды управления от пилота, в диапазоне [-1, 1].
+* `controlRoll`, `controlPitch`, `controlYaw`, `controlThrottle`, `controlMode` *(float)* — команды управления от пилота, в диапазоне [-1, 1].
-* `motors` *(float[])* — выходные сигналы на моторы, в диапазоне [0, 1].
+* `motors` *(float[4])* — выходные сигналы на моторы, в диапазоне [0, 1].
 
 ## Исходные файлы
 
-Исходные файлы прошивки находятся в директории `flix`. Ключевые файлы:
+Исходные файлы прошивки находятся в директории `flix`. Основные файлы:
 
-* [`flix.ino`](https://github.com/okalachev/flix/blob/canonical/flix/flix.ino) — основной входной файл, скетч Arduino. Включает определение глобальных переменных и главный цикл.
+* [`flix.ino`](https://github.com/okalachev/flix/blob/master/flix/flix.ino) — основной файл Arduino-скетча. Определяет некоторые глобальные переменные и главный цикл.
-* [`imu.ino`](https://github.com/okalachev/flix/blob/canonical/flix/imu.ino) — чтение данных с датчика IMU (гироскоп и акселерометр), калибровка IMU.
+* [`imu.ino`](https://github.com/okalachev/flix/blob/master/flix/imu.ino) — чтение данных с датчика IMU (гироскоп и акселерометр), калибровка IMU.
-* [`rc.ino`](https://github.com/okalachev/flix/blob/canonical/flix/rc.ino) — чтение данных с RC-приемника, калибровка RC.
+* [`rc.ino`](https://github.com/okalachev/flix/blob/master/flix/rc.ino) — чтение данных с RC-приемника, калибровка RC.
-* [`mavlink.ino`](https://github.com/okalachev/flix/blob/canonical/flix/mavlink.ino) — взаимодействие с QGroundControl через MAVLink.
+* [`estimate.ino`](https://github.com/okalachev/flix/blob/master/flix/estimate.ino) — оценка ориентации дрона, комплементарный фильтр.
-* [`estimate.ino`](https://github.com/okalachev/flix/blob/canonical/flix/estimate.ino) — оценка ориентации дрона, комплементарный фильтр.
+* [`control.ino`](https://github.com/okalachev/flix/blob/master/flix/control.ino) — подсистема управления, трехмерный двухуровневый каскадный ПИД-регулятор.
-* [`control.ino`](https://github.com/okalachev/flix/blob/canonical/flix/control.ino) — управление ориентацией и угловыми скоростями дрона, трехмерный двухуровневый каскадный PID-регулятор.
+* [`motors.ino`](https://github.com/okalachev/flix/blob/master/flix/motors.ino) — выход PWM на моторы.
-* [`motors.ino`](https://github.com/okalachev/flix/blob/canonical/flix/motors.ino) — управление выходными сигналами на моторы через ШИМ.
+* [`mavlink.ino`](https://github.com/okalachev/flix/blob/master/flix/mavlink.ino) — взаимодействие с QGroundControl или [pyflix](https://github.com/okalachev/flix/tree/master/tools/pyflix) через протокол MAVLink.
 
-Вспомогательные файлы включают:
+Вспомогательные файлы:
 
-* [`vector.h`](https://github.com/okalachev/flix/blob/canonical/flix/vector.h), [`quaternion.h`](https://github.com/okalachev/flix/blob/canonical/flix/quaternion.h) — реализация библиотек векторов и кватернионов проекта.
+* [`vector.h`](https://github.com/okalachev/flix/blob/master/flix/vector.h), [`quaternion.h`](https://github.com/okalachev/flix/blob/master/flix/quaternion.h) — библиотеки векторов и кватернионов.
-* [`pid.h`](https://github.com/okalachev/flix/blob/canonical/flix/pid.h) — реализация общего ПИД-регулятора.
+* [`pid.h`](https://github.com/okalachev/flix/blob/master/flix/pid.h) — ПИД-регулятор.
-* [`lpf.h`](https://github.com/okalachev/flix/blob/canonical/flix/lpf.h) — реализация общего фильтра нижних частот.
+* [`lpf.h`](https://github.com/okalachev/flix/blob/master/flix/lpf.h) — фильтр нижних частот.
+
+### Подсистема управления
+
+Состояние органов управления обрабатывается в функции `interpretControls()` и преобразуется в **команду управления**, которая включает следующее:
+
+* `attitudeTarget` *(Quaternion)* — целевая ориентация дрона.
+* `ratesTarget` *(Vector)* — целевые угловые скорости, *рад/с*.
+* `ratesExtra` *(Vector)* — дополнительные (feed-forward) угловые скорости, для управления рысканием в режиме STAB, *рад/с*.
+* `torqueTarget` *(Vector)* — целевой крутящий момент, диапазон [-1, 1].
+* `thrustTarget` *(float)* — целевая общая тяга, диапазон [0, 1].
+
+Команда управления обрабатывается в функциях `controlAttitude()`, `controlRates()`, `controlTorque()`. Если значение одной из переменных установлено в `NAN`, то соответствующая функция пропускается.
+
+<img src="img/control.svg" width=300 alt="Control subsystem diagram">
+
+Состояние *armed* хранится в переменной `armed`, а текущий режим — в переменной `mode`.

docs/book/geometry.md

@@ -110,7 +110,7 @@ float angle = Vector::angleBetween(a, b); // 1.57 (90 градусов)
 
 #### Скалярное произведение
 
-Скалярное произведение векторов (*dot product*) — это произведение длин двух векторов на косинус угла между ними. В математике оно обозначается знаком `·` или слитным написанием векторов. Интуитивно, результат скалярного произведения показывает, насколько два вектора *сонаправлены*.
+Скалярное произведение векторов *(dot product)* — это произведение длин двух векторов на косинус угла между ними. В математике оно обозначается знаком `·` или слитным написанием векторов. Интуитивно, результат скалярного произведения показывает, насколько два вектора *сонаправлены*.
 
 В Flix используется статический метод `Vector::dot()`:
 
@@ -124,7 +124,7 @@ float dotProduct = Vector::dot(a, b); // 32
 
 #### Векторное произведение
 
-Векторное произведение (*cross product*) позволяет найти вектор, перпендикулярный двум другим векторам. В математике оно обозначается знаком `×`, а в прошивке используется статический метод `Vector::cross()`:
+Векторное произведение *(cross product)* позволяет найти вектор, перпендикулярный двум другим векторам. В математике оно обозначается знаком `×`, а в прошивке используется статический метод `Vector::cross()`:
 
 ```cpp
 Vector a(1, 2, 3);
@@ -144,9 +144,9 @@ Vector crossProduct = Vector::cross(a, b); // -3, 6, -3
 
 В прошивке углы Эйлера сохраняются в обычный объект `Vector` (хоть и, строго говоря, не являются вектором):
 
-* Угол по крену (*roll*) — `vector.x`.
+* Угол по крену *(roll)* — `vector.x`.
-* Угол по тангажу (*pitch*) — `vector.y`.
+* Угол по тангажу *(pitch)* — `vector.y`.
-* Угол по рысканию (*yaw*) — `vector.z`.
+* Угол по рысканию *(yaw)* — `vector.z`.
 
 Особенности углов Эйлера:
 
@@ -162,8 +162,8 @@ Vector crossProduct = Vector::cross(a, b); // -3, 6, -3
 
 Помимо углов Эйлера, любую ориентацию в трехмерном пространстве можно представить в виде вращения вокруг некоторой оси на некоторый угол. В геометрии это доказывается, как **теорема вращения Эйлера**. В таком представлении ориентация задается двумя величинами:
 
-* **Ось вращения** (*axis*) — единичный вектор, определяющий ось вращения.
+* **Ось вращения** *(axis)* — единичный вектор, определяющий ось вращения.
-* **Угол поворота** (*angle* или *θ*) — угол, на который нужно повернуть объект вокруг этой оси.
+* **Угол поворота** *(angle* или *θ)* — угол, на который нужно повернуть объект вокруг этой оси.
 
 В Flix ось вращения задается объектом `Vector`, а угол поворота — числом типа `float` в радианах:
 
@@ -177,7 +177,7 @@ float angle = radians(45);
 
 ### Вектор вращения
 
-Если умножить вектор *axis* на угол поворота *θ*, то получится **вектор вращения** (*rotation vector*). Этот вектор играет важную роль в алгоритмах управления ориентацией летательного аппарата.
+Если умножить вектор *axis* на угол поворота *θ*, то получится **вектор вращения** *(rotation vector)*. Этот вектор играет важную роль в алгоритмах управления ориентацией летательного аппарата.
 
 Вектор вращения обладает замечательным свойством: если угловые скорости объекта (в собственной системе координат) в каждый момент времени совпадают с компонентами этого вектора, то за единичное время объект придет к заданной этим вектором ориентации. Это свойство позволяет использовать вектор вращения для управления ориентацией объекта посредством управления угловыми скоростями.
 
@@ -198,7 +198,7 @@ Vector rotation = radians(45) * Vector(1, 2, 3);
 	<a href="https://github.com/okalachev/flix/blob/master/flix/quaternion.h"><code>quaternion.h</code></a>.<br>
 </div>
 
-Вектор вращения удобен, но еще удобнее использовать **кватернион**. В Flix кватернионы задаются объектами `Quaternion` из библиотеки `quaternion.h`. Кватернион состоит из четырех значений: *w*, *x*, *y*, *z* и рассчитывается из вектора оси вращения (*axis*) и угла поворота (*θ*) по формуле:
+Вектор вращения удобен, но еще удобнее использовать **кватернион**. В Flix кватернионы задаются объектами `Quaternion` из библиотеки `quaternion.h`. Кватернион состоит из четырех значений: *w*, *x*, *y*, *z* и рассчитывается из вектора оси вращения *(axis)* и угла поворота *(θ)* по формуле:
 
 \\[ q = \left( \begin{array}{c} w \\\\ x \\\\ y \\\\ z \end{array} \right) = \left( \begin{array}{c} \cos\left(\frac{\theta}{2}\right) \\\\ axis\_x \cdot \sin\left(\frac{\theta}{2}\right) \\\\ axis\_y \cdot \sin\left(\frac{\theta}{2}\right) \\\\ axis\_z \cdot \sin\left(\frac{\theta}{2}\right) \end{array} \right) \\]
 

docs/book/gyro.md

@@ -87,13 +87,13 @@ Flix поддерживает следующие модели IMU:
 #include <FlixPeriph.h>
 #include <SPI.h>
 
-MPU9250 IMU(SPI);
+MPU9250 imu(SPI);
 
 void setup() {
 	Serial.begin(115200);
-	bool success = IMU.begin();
+	bool success = imu.begin();
 	if (!success) {
-		Serial.println("Failed to initialize IMU");
+		Serial.println("Failed to initialize the IMU");
 	}
 }
 ```
@@ -108,21 +108,21 @@ void setup() {
 #include <FlixPeriph.h>
 #include <SPI.h>
 
-MPU9250 IMU(SPI);
+MPU9250 imu(SPI);
 
 void setup() {
 	Serial.begin(115200);
-	bool success = IMU.begin();
+	bool success = imu.begin();
 	if (!success) {
-		Serial.println("Failed to initialize IMU");
+		Serial.println("Failed to initialize the IMU");
 	}
 }
 
 void loop() {
-	IMU.waitForData();
+	imu.waitForData();
 
 	float gx, gy, gz;
-	IMU.getGyro(gx, gy, gz);
+	imu.getGyro(gx, gy, gz);
 
 	Serial.printf("gx:%f gy:%f gz:%f\n", gx, gy, gz);
 	delay(50); // замедление вывода
@@ -135,36 +135,36 @@ void loop() {
 
 ## Конфигурация гироскопа
 
-В коде Flix настройка IMU происходит в функции `configureIMU`. В этой функции настраиваются три основных параметра гироскопа: диапазон измерений, частота сэмплов и частота LPF-фильтра.
+В коде Flix настройка IMU происходит в функции `configureIMU`. В этой функции настраиваются три основных параметра гироскопа: диапазон измерений, частота сэмплирования и частота LPF-фильтра.
 
-### Частота сэмплов
+### Частота сэмплирования
 
-Большинство IMU могут обновлять данные с разной частотой. В полетных контроллерах обычно используется частота обновления от 500 Гц до 8 кГц. Чем выше частота сэмплов, тем выше точность управления полетом, но и больше нагрузка на микроконтроллер.
+Большинство IMU могут обновлять данные с разной частотой. В полетных контроллерах обычно используется частота обновления от 500 Гц до 8 кГц. Чем выше частота, тем выше точность управления полетом, но и тем больше нагрузка на микроконтроллер.
 
-Частота сэмплов устанавливается методом `setSampleRate()`. В Flix используется частота 1 кГц:
+Частота сэмплирования устанавливается методом `setSampleRate()`. В Flix используется частота 1 кГц:
 
 ```cpp
 IMU.setRate(IMU.RATE_1KHZ_APPROX);
 ```
 
-Поскольку не все поддерживаемые IMU могут работать строго на частоте 1 кГц, в библиотеке FlixPeriph существует возможность приближенной настройки частоты сэмплов. Например, у IMU ICM-20948 при такой настройке реальная частота сэмплирования будет равна 1125 Гц.
+Поскольку не все поддерживаемые IMU могут работать строго на частоте 1 кГц, в библиотеке FlixPeriph существует возможность приближенной настройки частоты сэмплирования. Например, у IMU ICM-20948 при такой настройке реальная частота сэмплирования будет равна 1125 Гц.
 
 Другие доступные для установки в библиотеке FlixPeriph частоты сэмплирования:
 
-* `RATE_MIN` — минимальная частота сэмплов для конкретного IMU.
+* `RATE_MIN` — минимальная частота для конкретного IMU.
 * `RATE_50HZ_APPROX` — значение, близкое к 50 Гц.
 * `RATE_1KHZ_APPROX` — значение, близкое к 1 кГц.
 * `RATE_8KHZ_APPROX` — значение, близкое к 8 кГц.
-* `RATE_MAX` — максимальная частота сэмплов для конкретного IMU.
+* `RATE_MAX` — максимальная частота для конкретного IMU.
 
 #### Диапазон измерений
 
-Большинство MEMS-гироскопов поддерживают несколько диапазонов измерений угловой скорости. Главное преимущество выбора меньшего диапазона — бо́льшая чувствительность. В полетных контроллерах обычно выбирается максимальный диапазон измерений от –2000 до 2000 градусов в секунду, чтобы обеспечить возможность динамичных маневров.
+Большинство MEMS-гироскопов поддерживают несколько диапазонов измерений угловой скорости. Главное преимущество выбора меньшего диапазона — бо́льшая чувствительность. В полетных контроллерах обычно выбирается максимальный диапазон измерений от –2000 до 2000 градусов в секунду, чтобы обеспечить возможность быстрых маневров.
 
 В библиотеке FlixPeriph диапазон измерений гироскопа устанавливается методом `setGyroRange()`:
 
 ```cpp
-IMU.setGyroRange(IMU.GYRO_RANGE_2000DPS);
+imu.setGyroRange(imu.GYRO_RANGE_2000DPS);
 ```
 
 ### LPF-фильтр
@@ -172,16 +172,16 @@ IMU.setGyroRange(IMU.GYRO_RANGE_2000DPS);
 IMU InvenSense могут фильтровать измерения на аппаратном уровне при помощи фильтра нижних частот (LPF). Flix реализует собственный фильтр для гироскопа, чтобы иметь больше гибкости при поддержке разных IMU. Поэтому для встроенного LPF устанавливается максимальная частота среза:
 
 ```cpp
-IMU.setDLPF(IMU.DLPF_MAX);
+imu.setDLPF(imu.DLPF_MAX);
 ```
 
 ## Калибровка гироскопа
 
-Как и любое измерительное устройство, гироскоп вносит искажения в измерения. Наиболее простая модель этих искажений делит их на статические смещения (*bias*) и случайный шум (*noise*):
+Как и любое измерительное устройство, гироскоп вносит искажения в измерения. Наиболее простая модель этих искажений делит их на статические смещения *(bias)* и случайный шум *(noise)*:
 
 \\[ gyro_{xyz}=rates_{xyz}+bias_{xyz}+noise \\]
 
-Для качественной работы подсистемы оценки ориентации и управления дроном необходимо оценить *bias* гироскопа и учесть его в вычислениях. Для этого при запуске программы производится калибровка гироскопа, которая реализована в функции `calibrateGyro()`. Эта функция считывает данные с гироскопа в состоянии покоя 1000 раз и усредняет их. Полученные значения считаются *bias* гироскопа и в дальнейшем вычитаются из измерений.
+Для точной работы подсистемы оценки ориентации и управления дроном необходимо оценить *bias* гироскопа и учесть его в вычислениях. Для этого при запуске программы производится калибровка гироскопа, которая реализована в функции `calibrateGyro()`. Эта функция считывает данные с гироскопа в состоянии покоя 1000 раз и усредняет их. Полученные значения считаются *bias* гироскопа и в дальнейшем вычитаются из измерений.
 
 Программа для вывода данных с гироскопа с калибровкой:
 
@@ -189,23 +189,23 @@ IMU.setDLPF(IMU.DLPF_MAX);
 #include <FlixPeriph.h>
 #include <SPI.h>
 
-MPU9250 IMU(SPI);
+MPU9250 imu(SPI);
 
 float gyroBiasX, gyroBiasY, gyroBiasZ; // bias гироскопа
 
 void setup() {
 	Serial.begin(115200);
-	bool success = IMU.begin();
+	bool success = imu.begin();
 	if (!success) {
-		Serial.println("Failed to initialize IMU");
+		Serial.println("Failed to initialize the IMU");
 	}
 	calibrateGyro();
 }
 
 void loop() {
 	float gx, gy, gz;
-	IMU.waitForData();
+	imu.waitForData();
-	IMU.getGyro(gx, gy, gz);
+	imu.getGyro(gx, gy, gz);
 
 	// Устранение bias гироскопа
 	gx -= gyroBiasX;
@@ -226,9 +226,9 @@ void calibrateGyro() {
 
 	// Получение 1000 измерений гироскопа
 	for (int i = 0; i < samples; i++) {
-		IMU.waitForData();
+		imu.waitForData();
 		float gx, gy, gz;
-		IMU.getGyro(gx, gy, gz);
+		imu.getGyro(gx, gy, gz);
 		gyroBiasX += gx;
 		gyroBiasY += gy;
 		gyroBiasZ += gz;

docs/build.md

@@ -1,205 +1,2 @@
-# Building and running
+<!-- markdownlint-disable MD041 -->
-
+Build instructions are moved to [usage article](usage.md).
-To build the firmware or the simulator, you need to clone the repository using git:
-
-```bash
-git clone https://github.com/okalachev/flix.git
-cd flix
-```
-
-## Simulation
-
-### Ubuntu
-
-The latest version of Ubuntu supported by Gazebo 11 simulator is 22.04. If you have a newer version, consider using a virtual machine.
-
-1. Install Arduino CLI:
-
-   ```bash
-   curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/.local/bin sh
-   ```
-
-2. Install Gazebo 11:
-
-   ```bash
-   curl -sSL http://get.gazebosim.org | sh
-   ```
-
-   Set up your Gazebo environment variables:
-
-   ```bash
-   echo "source /usr/share/gazebo/setup.sh" >> ~/.bashrc
-   source ~/.bashrc
-   ```
-
-3. Install SDL2 and other dependencies:
-
-   ```bash
-   sudo apt-get update && sudo apt-get install build-essential libsdl2-dev
-   ```
-
-4. Add your user to the `input` group to enable joystick support (you need to re-login after this command):
-
-   ```bash
-   sudo usermod -a -G input $USER
-   ```
-
-5. Run the simulation:
-
-   ```bash
-   make simulator
-   ```
-
-### macOS
-
-1. Install Homebrew package manager, if you don't have it installed:
-
-   ```bash
-   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
-   ```
-
-2. Install Arduino CLI, Gazebo 11 and SDL2:
-
-   ```bash
-   brew tap osrf/simulation
-   brew install arduino-cli
-   brew install gazebo11
-   brew install sdl2
-   ```
-
-   Set up your Gazebo environment variables:
-
-   ```bash
-   echo "source /opt/homebrew/share/gazebo/setup.sh" >> ~/.zshrc
-   source ~/.zshrc
-   ```
-
-3. Run the simulation:
-
-   ```bash
-   make simulator
-   ```
-
-### Setup and flight
-
-#### Control with smartphone
-
-1. Install [QGroundControl mobile app](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html#android) on your smartphone. For **iOS**, use [QGroundControl build from TAJISOFT](https://apps.apple.com/ru/app/qgc-from-tajisoft/id1618653051).
-2. Connect your smartphone to the same Wi-Fi network as the machine running the simulator.
-3. If you're using a virtual machine, make sure that its network is set to the **bridged** mode with Wi-Fi adapter selected.
-4. Run the simulation.
-5. Open QGroundControl app. It should connect and begin showing the virtual drone's telemetry automatically.
-6. Go to the settings and enable *Virtual Joystick*. *Auto-Center Throttle* setting **should be disabled**.
-7. Use the virtual joystick to fly the drone!
-
-#### Control with USB remote control
-
-1. Connect your USB remote control to the machine running the simulator.
-2. Run the simulation.
-3. Calibrate the RC using `cr` command in the command line interface.
-4. Run the simulation again.
-5. Use the USB remote control to fly the drone!
-
-## Firmware
-
-### Arduino IDE (Windows, Linux, macOS)
-
-1. Install [Arduino IDE](https://www.arduino.cc/en/software) (version 2 is recommended).
-2. Windows users might need to install [USB to UART bridge driver from Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).
-3. Install ESP32 core, version 3.2.0. See the [official Espressif's instructions](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-arduino-ide) on installing ESP32 Core in Arduino IDE.
-4. Install the following libraries using [Library Manager](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-installing-a-library):
-   * `FlixPeriph`, the latest version.
-   * `MAVLink`, version 2.0.16.
-5. Clone the project using git or [download the source code as a ZIP archive](https://codeload.github.com/okalachev/flix/zip/refs/heads/master).
-6. Open the downloaded Arduino sketch `flix/flix.ino` in Arduino IDE.
-7. Connect your ESP32 board to the computer and choose correct board type in Arduino IDE (*WEMOS D1 MINI ESP32* for ESP32 Mini) and the port.
-8. [Build and upload](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-uploading-a-sketch) the firmware using Arduino IDE.
-
-### Command line (Windows, Linux, macOS)
-
-1. [Install Arduino CLI](https://arduino.github.io/arduino-cli/installation/).
-
-   On Linux, use:
-
-   ```bash
-   curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/.local/bin sh
-   ```
-
-2. Windows users might need to install [USB to UART bridge driver from Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).
-3. Compile the firmware using `make`. Arduino dependencies will be installed automatically:
-
-   ```bash
-   make
-   ```
-
-   You can flash the firmware to the board using command:
-
-   ```bash
-   make upload
-   ```
-
-   You can also compile the firmware, upload it and start serial port monitoring using command:
-
-   ```bash
-   make upload monitor
-   ```
-
-See other available Make commands in the [Makefile](../Makefile).
-
-> [!TIP]
-> You can test the firmware on a bare ESP32 board without connecting IMU and other peripherals. The Wi-Fi network `flix` should appear and all the basic functionality including CLI and QGroundControl connection should work.
-
-### Setup and flight
-
-Before flight you need to calibrate the accelerometer:
-
-1. Open Serial Monitor in Arduino IDE (or use `make monitor` command in the command line).
-2. Type `ca` command there and follow the instructions.
-
-#### Control with smartphone
-
-1. Install [QGroundControl mobile app](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html#android) on your smartphone.
-2. Power the drone using the battery.
-3. Connect your smartphone to the appeared `flix` Wi-Fi network (password: `flixwifi`).
-4. Open QGroundControl app. It should connect and begin showing the drone's telemetry automatically.
-5. Go to the settings and enable *Virtual Joystick*. *Auto-Center Throttle* setting **should be disabled**.
-6. Use the virtual joystick to fly the drone!
-
-#### Control with remote control
-
-Before flight using remote control, you need to calibrate it:
-
-1. Open Serial Monitor in Arduino IDE (or use `make monitor` command in the command line).
-2. Type `cr` command there and follow the instructions.
-3. Use the remote control to fly the drone!
-
-#### Control with USB remote control
-
-If your drone doesn't have RC receiver installed, you can use USB remote control and QGroundControl app to fly it.
-
-1. Install [QGroundControl](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) app on your computer.
-2. Connect your USB remote control to the computer.
-3. Power up the drone.
-4. Connect your computer to the appeared `flix` Wi-Fi network (password: `flixwifi`).
-5. Launch QGroundControl app. It should connect and begin showing the drone's telemetry automatically.
-6. Go the the QGroundControl menu ⇒ *Vehicle Setup* ⇒ *Joystick*. Calibrate you USB remote control there.
-7. Use the USB remote control to fly the drone!
-
-#### Adjusting parameters
-
-You can adjust some of the drone's parameters (include PID coefficients) in QGroundControl app. In order to do that, go to the QGroundControl menu ⇒ *Vehicle Setup* ⇒ *Parameters*.
-
-<img src="img/parameters.png" width="400">
-
-#### CLI access
-
-In addition to accessing the drone's command line interface (CLI) using the serial port, you can also access it with QGroundControl using Wi-Fi connection. To do that, go to the QGroundControl menu ⇒ *Vehicle Setup* ⇒ *Analyze Tools* ⇒ *MAVLink Console*.
-
-<img src="img/cli.png" width="400">
-
-> [!NOTE]
-> If something goes wrong, go to the [Troubleshooting](troubleshooting.md) article.
-
-### Firmware code structure
-
-See [firmware overview](firmware.md) for more details.

docs/firmware.md

@@ -1,39 +1,104 @@
 # 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.
+The firmware is a regular Arduino sketch, and it 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 several files, each responsible for a specific subsystem.
 
 ## Dataflow
 
-<img src="img/dataflow.svg" width=800 alt="Firmware dataflow diagram">
+<img src="img/dataflow.svg" width=600 alt="Firmware dataflow diagram">
 
-The main loop is running at 1000 Hz. All the dataflow is happening through global variables (for simplicity):
+The main loop is running at 1000 Hz. The dataflow goes through global variables, including:
 
-* `t` *(double)* — current step time, *s*.
+* `t` *(float)* — current step time, *s*.
 * `dt` *(float)* — time delta between the current and previous steps, *s*.
 * `gyro` *(Vector)* — data from the gyroscope, *rad/s*.
 * `acc` *(Vector)* — acceleration data from the accelerometer, *m/s<sup>2</sup>*.
 * `rates` *(Vector)* — filtered angular rates, *rad/s*.
 * `attitude` *(Quaternion)* — estimated attitude (orientation) of drone.
-* `controlRoll`, `controlPitch`, ... *(float[])* — pilot's control inputs, range [-1, 1].
+* `controlRoll`, `controlPitch`, `controlYaw`, `controlThrottle`, `controlMode` *(float)* — pilot control inputs, range [-1, 1].
-* `motors` *(float[])* — motor outputs, range [0, 1].
+* `motors` *(float[4])* — motor outputs, range [0, 1].
 
 ## Source files
 
-Firmware source files are located in `flix` directory. The key files are:
+Firmware source files are located in `flix` directory.
 
-* [`flix.ino`](../flix/flix.ino) — main entry point, Arduino sketch. Includes global variables definition and the main loop.
+* [`flix.ino`](../flix/flix.ino) — Arduino sketch main file, entry point.Includes some global variable definitions and the main loop.
 * [`imu.ino`](../flix/imu.ino) — reading data from the IMU sensor (gyroscope and accelerometer), IMU calibration.
 * [`rc.ino`](../flix/rc.ino) — reading data from the RC receiver, RC calibration.
-* [`estimate.ino`](../flix/estimate.ino) — drone's attitude estimation, complementary filter.
+* [`estimate.ino`](../flix/estimate.ino) — attitude estimation, complementary filter.
-* [`control.ino`](../flix/control.ino) — drone's attitude and rates control, three-dimensional two-level cascade PID controller.
+* [`control.ino`](../flix/control.ino) — control subsystem, three-dimensional two-level cascade PID controller.
-* [`motors.ino`](../flix/motors.ino) — PWM motor outputs control.
+* [`motors.ino`](../flix/motors.ino) — PWM motor output control.
+* [`mavlink.ino`](../flix/mavlink.ino) — interaction with QGroundControl or [pyflix](../tools/pyflix) via MAVLink protocol.
+* [`cli.ino`](../flix/cli.ino) — serial and MAVLink console.
 
-Utility files include:
+Utility files:
 
-* [`vector.h`](../flix/vector.h), [`quaternion.h`](../flix/quaternion.h) — project's vector and quaternion libraries implementation.
+* [`vector.h`](../flix/vector.h), [`quaternion.h`](../flix/quaternion.h) — vector and quaternion libraries.
-* [`pid.h`](../flix/pid.h) — generic PID controller implementation.
+* [`pid.h`](../flix/pid.h) — generic PID controller.
-* [`lpf.h`](../flix/lpf.h) — generic low-pass filter implementation.
+* [`lpf.h`](../flix/lpf.h) — generic low-pass filter.
 
-## Building
+### Control subsystem
 
-See build instructions in [build.md](build.md).
+Pilot inputs are interpreted in `interpretControls()`, and then converted to the **control command**, which consists of the following:
+
+* `attitudeTarget` *(Quaternion)* — target attitude of the drone.
+* `ratesTarget` *(Vector)* — target angular rates, *rad/s*.
+* `ratesExtra` *(Vector)* — additional (feed-forward) angular rates, used for yaw rate control in STAB mode, *rad/s*.
+* `torqueTarget` *(Vector)* — target torque, range [-1, 1].
+* `thrustTarget` *(float)* — collective motor thrust target, range [0, 1].
+
+Control command is handled in `controlAttitude()`, `controlRates()`, `controlTorque()` functions. Each function may be skipped if the corresponding control target is set to `NAN`.
+
+<img src="img/control.svg" width=300 alt="Control subsystem diagram">
+
+Armed state is stored in `armed` variable, and current mode is stored in `mode` variable.
+
+### Console
+
+To write into the console, `print()` function is used. This function sends data both to the Serial console and to the MAVLink console (which can be accessed wirelessly in QGroundControl). The function supports formatting:
+
+```cpp
+print("Test value: %.2f\n", testValue);
+```
+
+In order to add a console command, modify the `doCommand()` function in `cli.ino` file.
+
+> [!IMPORTANT]
+> Avoid using delays in in-flight commands, it will **crash** the drone! (The design is one-threaded.)
+>
+> For on-the-ground commands, use `pause()` function, instead of `delay()`. This function allows to pause in a way that MAVLink connection will continue working.
+
+### Parameter subsystem
+
+Parameters subsystem (`parameters.ino`) uses standard [Preferences.h](https://docs.espressif.com/projects/arduino-esp32/en/latest/tutorials/preferences.html) ESP32 library to store parameters in non-volatile memory. Each parameter is a regular global variable, which is registered in the `parameters` array.
+
+To add a new parameter:
+
+1. Define a global variable for the parameter, three types are supported: `float`, `int`, and `bool`.
+2. Add an entry to the `parameters` array, with the parameter name, a pointer to the variable, and optionally a callback function to call when the parameter is changed.
+3. Everything else will be handled automatically.
+
+See examples of adding new parameters in commits: [c434107](https://github.com/okalachev/flix/commit/c434107), [a687303](https://github.com/okalachev/flix/commit/a687303).
+
+> [!NOTE]
+> Since all the parameters are internally stored and passed as floats, the safe range for `int` parameters is -16777216 to 16777215.
+
+## Adding a subsystem
+
+To add a new subsystem:
+
+1. Create a new `*.ino` file for your subsystem.
+2. Define setup and loop functions for the subsystem, for example `setupMySubsystem()` and `loopMySubsystem()`.
+3. Use `Rate` class if you need to limit the loop frequency, for example:
+
+    ```cpp
+    Rate mySubsystemRate(100); // 100 Hz
+
+    void loopMySubsystem() {
+    	if (!mySubsystemRate) return;
+    	// Do something...
+    }
+4. Add setup and loop calls in to `setup()` and `loop()` functions in `flix.ino`.
+
+## Building the firmware
+
+See build instructions in [usage.md](usage.md).

docs/img/arming.svg

@@ -0,0 +1,22 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 340.21 211.28">
+  <defs>
+    <style>
+      .a {
+        fill: #d5d5d5;
+      }
+
+      .b {
+        fill: #fff;
+      }
+
+      .c {
+        fill: #636363;
+      }
+    </style>
+  </defs>
+  <path class="a" d="M340,159.31c-4.74-86-35.9-128.7-35.9-128.7C288.3,9.53,269.17,2.91,251.87.39s-22.31,7.87-22.31,7.87C201.7,4,170.11,4.19,170.11,4.19S138.51,4,110.65,8.26c0,0-5-10.38-22.3-7.87S51.91,9.53,36.14,30.61c0,0-31.16,42.67-35.9,128.7-2.82,51.08,19.68,55.36,38.43,50.4a60.08,60.08,0,0,0,30.55-19.66c7.51-9,19.64-25.32,34-28,17.28-3.26,33.14-4.77,45.09-4.78l21.82,0,21.81,0c12,0,27.82,1.52,45.09,4.78,14.34,2.71,26.47,19,34,28a60.06,60.06,0,0,0,30.56,19.66C320.29,214.67,342.79,210.39,340,159.31Z"/>
+  <circle class="b" cx="88.54" cy="85.75" r="45.22"/>
+  <circle class="b" cx="251.67" cy="85.75" r="45.22"/>
+  <circle class="c" cx="251.67" cy="85.75" r="13.8"/>
+  <circle class="c" cx="103.8" cy="112.12" r="13.8"/>
+</svg>

docs/img/controls.svg

@@ -0,0 +1,123 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 464.2 249.05">
+  <defs>
+    <style>
+      .a {
+        fill: #d5d5d5;
+      }
+
+      .b {
+        fill: #fff;
+      }
+
+      .c {
+        fill: #636363;
+      }
+
+      .d {
+        opacity: 0.7;
+      }
+
+      .e {
+        fill: none;
+        stroke: #0076ba;
+        stroke-linecap: round;
+        stroke-miterlimit: 10;
+        stroke-width: 13px;
+      }
+
+      .f {
+        fill: #0076ba;
+      }
+
+      .g {
+        font-size: 30px;
+        font-family: Tahoma;
+      }
+
+      .h {
+        letter-spacing: 0em;
+      }
+
+      .i {
+        letter-spacing: -0.01em;
+      }
+
+      .j {
+        letter-spacing: -0.06em;
+      }
+
+      .k {
+        letter-spacing: 0em;
+      }
+
+      .l {
+        letter-spacing: -0.02em;
+      }
+
+      .m {
+        letter-spacing: 0em;
+      }
+
+      .n {
+        opacity: 0.6;
+      }
+    </style>
+  </defs>
+  <path class="a" d="M408.84,197.08c-4.74-86-35.9-128.7-35.9-128.7C357.17,47.3,338,40.68,320.73,38.17S298.43,46,298.43,46C270.57,41.81,239,42,239,42s-31.59-.15-59.45,4.07c0,0-5-10.38-22.31-7.86S120.78,47.3,105,68.38c0,0-31.16,42.68-35.9,128.7-2.82,51.08,19.68,55.36,38.42,50.4a60.06,60.06,0,0,0,30.56-19.66c7.51-9,19.64-25.32,34-28,17.27-3.26,33.14-4.77,45.09-4.78L239,195l21.82,0c11.95,0,27.81,1.52,45.09,4.78,14.34,2.71,26.47,19,34,28a60.08,60.08,0,0,0,30.55,19.66C389.16,252.44,411.66,248.16,408.84,197.08Z"/>
+  <circle class="b" cx="157.41" cy="123.52" r="45.22"/>
+  <circle class="b" cx="320.54" cy="123.52" r="45.22"/>
+  <circle class="c" cx="320.54" cy="123.52" r="13.8"/>
+  <circle class="c" cx="157.41" cy="149.89" r="13.8"/>
+  <g class="d">
+    <g>
+      <line class="e" x1="157.41" y1="149.89" x2="157.41" y2="49.87"/>
+      <polygon class="f" points="180.74 56.7 157.41 16.29 134.07 56.7 180.74 56.7"/>
+    </g>
+  </g>
+  <text class="g" transform="translate(38.38 25.91)">Th<tspan class="h" x="34.25" y="0">r</tspan><tspan x="44.91" y="0">o</tspan><tspan class="i" x="61.2" y="0">t</tspan><tspan x="71" y="0">tle</tspan></text>
+  <g class="d">
+    <g>
+      <line class="e" x1="157.41" y1="149.89" x2="82.41" y2="149.89"/>
+      <polygon class="f" points="89.24 126.56 48.82 149.89 89.24 173.23 89.24 126.56"/>
+    </g>
+  </g>
+  <text class="g" transform="translate(0.18 176.36)"><tspan class="j">Y</tspan><tspan class="h" x="15.37" y="0">a</tspan><tspan x="30.97" y="0">w</tspan></text>
+  <g class="d">
+    <g>
+      <line class="e" x1="320.54" y1="123.52" x2="320.54" y2="50.32"/>
+      <polygon class="f" points="343.88 57.15 320.54 16.74 297.2 57.15 343.88 57.15"/>
+    </g>
+  </g>
+  <text class="g" transform="translate(336.56 26.36)">P<tspan class="k" x="16.54" y="0">i</tspan><tspan x="23.45" y="0">tch</tspan></text>
+  <g class="d">
+    <g>
+      <line class="e" x1="320.54" y1="123.52" x2="395.54" y2="123.52"/>
+      <polygon class="f" points="388.71 146.86 429.12 123.52 388.71 100.19 388.71 146.86"/>
+    </g>
+  </g>
+  <text class="g" transform="translate(416.03 160.01)"><tspan class="l">R</tspan><tspan x="18.08" y="0">o</tspan><tspan class="m" x="34.37" y="0">l</tspan><tspan x="41.31" y="0">l</tspan></text>
+  <g class="d">
+    <g>
+      <line class="e" x1="157.41" y1="149.89" x2="213.73" y2="149.89"/>
+      <polygon class="f" points="206.9 173.23 247.32 149.89 206.9 126.56 206.9 173.23"/>
+    </g>
+  </g>
+  <g class="d">
+    <g>
+      <line class="e" x1="320.54" y1="124.52" x2="320.54" y2="197.73"/>
+      <polygon class="f" points="297.2 190.9 320.54 231.31 343.88 190.9 297.2 190.9"/>
+    </g>
+  </g>
+  <g class="n">
+    <g>
+      <line class="e" x1="318.03" y1="123.52" x2="262.32" y2="123.52"/>
+      <polygon class="f" points="269.14 100.19 228.73 123.52 269.14 146.86 269.14 100.19"/>
+    </g>
+  </g>
+  <g class="d">
+    <g>
+      <line class="e" x1="157.41" y1="151.66" x2="157.41" y2="197.73"/>
+      <polygon class="f" points="134.07 190.9 157.41 231.31 180.74 190.9 134.07 190.9"/>
+    </g>
+  </g>
+</svg>

docs/img/disarming.svg

@@ -0,0 +1,22 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 340.21 211.28">
+  <defs>
+    <style>
+      .a {
+        fill: #d5d5d5;
+      }
+
+      .b {
+        fill: #fff;
+      }
+
+      .c {
+        fill: #636363;
+      }
+    </style>
+  </defs>
+  <path class="a" d="M340,159.31c-4.74-86-35.9-128.7-35.9-128.7C288.3,9.53,269.17,2.91,251.87.39s-22.31,7.87-22.31,7.87C201.7,4,170.11,4.19,170.11,4.19S138.51,4,110.65,8.26c0,0-5-10.38-22.3-7.87S51.91,9.53,36.14,30.61c0,0-31.16,42.67-35.9,128.7-2.82,51.08,19.68,55.36,38.43,50.4a60.08,60.08,0,0,0,30.55-19.66c7.51-9,19.64-25.32,34-28,17.28-3.26,33.14-4.77,45.09-4.78l21.82,0,21.81,0c12,0,27.82,1.52,45.09,4.78,14.34,2.71,26.47,19,34,28a60.06,60.06,0,0,0,30.56,19.66C320.29,214.67,342.79,210.39,340,159.31Z"/>
+  <circle class="b" cx="88.54" cy="85.75" r="45.22"/>
+  <circle class="b" cx="251.67" cy="85.75" r="45.22"/>
+  <circle class="c" cx="251.67" cy="85.75" r="13.8"/>
+  <circle class="c" cx="73.28" cy="112.12" r="13.8"/>
+</svg>

docs/img/drone-axes-rotate.svg

@@ -0,0 +1,136 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 813.79 508.65">
+  <defs>
+    <style>
+      .a, .d, .f, .j, .p {
+        fill: none;
+      }
+
+      .a {
+        stroke: #d5d5d5;
+        stroke-width: 31px;
+      }
+
+      .a, .p {
+        stroke-miterlimit: 10;
+      }
+
+      .b {
+        fill: #ff9400;
+      }
+
+      .c {
+        opacity: 0.8;
+      }
+
+      .d {
+        stroke: #d80100;
+      }
+
+      .d, .f, .j {
+        stroke-linejoin: bevel;
+        stroke-width: 13px;
+      }
+
+      .e {
+        fill: #d80100;
+      }
+
+      .f {
+        stroke: #57ed00;
+      }
+
+      .g {
+        fill: #57ed00;
+      }
+
+      .h {
+        fill: #c1c1c1;
+      }
+
+      .i {
+        opacity: 0.12;
+      }
+
+      .j {
+        stroke: #0076ba;
+      }
+
+      .k {
+        fill: #0076ba;
+      }
+
+      .l {
+        font-size: 50px;
+        font-family: Tahoma;
+      }
+
+      .m {
+        letter-spacing: -0.01em;
+      }
+
+      .n {
+        letter-spacing: -0.01em;
+      }
+
+      .o {
+        letter-spacing: 0em;
+      }
+
+      .p {
+        stroke: #000;
+        stroke-width: 10px;
+      }
+    </style>
+  </defs>
+  <g>
+    <g>
+      <line class="a" x1="259.14" y1="432.84" x2="532.46" y2="340.23"/>
+      <line class="a" x1="311.69" y1="313.16" x2="481.62" y2="461.39"/>
+      <ellipse class="b" cx="311.35" cy="312.8" rx="88.68" ry="47.94"/>
+      <ellipse class="b" cx="532.53" cy="340.42" rx="88.68" ry="47.94"/>
+      <ellipse class="b" cx="479.72" cy="460.7" rx="88.68" ry="47.94"/>
+      <ellipse class="b" cx="259.21" cy="433.03" rx="88.68" ry="47.94"/>
+    </g>
+    <g class="c">
+      <g>
+        <line class="d" x1="396.65" y1="386.83" x2="564.66" y2="35.72"/>
+        <polygon class="e" points="582.76 51.95 579.15 5.42 540.66 31.8 582.76 51.95"/>
+      </g>
+    </g>
+    <g class="c">
+      <g>
+        <line class="f" x1="396.77" y1="387.06" x2="69.41" y2="341.09"/>
+        <polygon class="g" points="79.42 318.93 36.15 336.42 72.93 365.15 79.42 318.93"/>
+      </g>
+    </g>
+    <ellipse class="h" cx="396.36" cy="386.61" rx="47.21" ry="25.52"/>
+    <path class="i" d="M398,375.67l-14.42,12.95a4.32,4.32,0,0,0,2.35,7.5l16.81,2.11a4.33,4.33,0,0,0,4.8-5l-2.39-15.06A4.32,4.32,0,0,0,398,375.67Z"/>
+    <g class="c">
+      <g>
+        <line class="j" x1="396.77" y1="385.56" x2="396.77" y2="92.64"/>
+        <polygon class="k" points="420.1 99.47 396.77 59.06 373.43 99.47 420.1 99.47"/>
+      </g>
+    </g>
+    <text class="l" transform="translate(0 292.27)">y/left</text>
+    <text class="l" transform="translate(268.4 81.58)">z/up</text>
+    <text class="l" transform="translate(600.99 43.18)">x/<tspan class="m" x="43.87" y="0">f</tspan><tspan x="59.3" y="0">or</tspan><tspan class="n" x="104.47" y="0">w</tspan><tspan x="141.14" y="0">a</tspan><tspan class="o" x="167.38" y="0">r</tspan><tspan x="185.16" y="0">d</tspan></text>
+    <g class="c">
+      <g>
+        <path class="p" d="M470.35,114a52.71,52.71,0,0,1,103.57-2.31,51.67,51.67,0,0,1-1.33,25.92"/>
+        <polygon points="562.15 128.29 563.93 154.16 585.44 139.69 562.15 128.29"/>
+      </g>
+    </g>
+    <g class="c">
+      <g>
+        <path class="p" d="M344.16,164.77a52.66,52.66,0,1,0,103.78,16.31"/>
+        <polygon points="460.61 184.04 446.18 162.5 434.74 185.76 460.61 184.04"/>
+      </g>
+    </g>
+    <g class="c">
+      <g>
+        <path class="p" d="M138.4,411.11a52.71,52.71,0,0,1,18.43-101.94A51.68,51.68,0,0,1,182,315.65"/>
+        <polygon points="170.73 324.01 196.43 327.44 186.55 303.47 170.73 324.01"/>
+      </g>
+    </g>
+  </g>
+</svg>

docs/img/drone-axes.svg

@@ -0,0 +1,110 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 664.49 478.47">
+  <defs>
+    <style>
+      .a, .d, .f, .j {
+        fill: none;
+      }
+
+      .a {
+        stroke: #d5d5d5;
+        stroke-miterlimit: 10;
+        stroke-width: 31px;
+      }
+
+      .b {
+        fill: #ff9400;
+      }
+
+      .c {
+        opacity: 0.8;
+      }
+
+      .d {
+        stroke: #d80100;
+      }
+
+      .d, .f, .j {
+        stroke-linejoin: bevel;
+        stroke-width: 13px;
+      }
+
+      .e {
+        fill: #d80100;
+      }
+
+      .f {
+        stroke: #57ed00;
+      }
+
+      .g {
+        fill: #57ed00;
+      }
+
+      .h {
+        fill: #c1c1c1;
+      }
+
+      .i {
+        opacity: 0.12;
+      }
+
+      .j {
+        stroke: #0076ba;
+      }
+
+      .k {
+        fill: #0076ba;
+      }
+
+      .l {
+        font-size: 50px;
+        font-family: Tahoma;
+      }
+
+      .m {
+        letter-spacing: -0.01em;
+      }
+
+      .n {
+        letter-spacing: -0.01em;
+      }
+
+      .o {
+        letter-spacing: 0em;
+      }
+    </style>
+  </defs>
+  <g>
+    <g>
+      <line class="a" x1="207.39" y1="402.28" x2="480.71" y2="309.67"/>
+      <line class="a" x1="259.93" y1="282.6" x2="429.86" y2="430.83"/>
+      <ellipse class="b" cx="259.59" cy="282.24" rx="88.68" ry="47.94"/>
+      <ellipse class="b" cx="480.77" cy="309.86" rx="88.68" ry="47.94"/>
+      <ellipse class="b" cx="427.96" cy="430.14" rx="88.68" ry="47.94"/>
+      <ellipse class="b" cx="207.45" cy="402.47" rx="88.68" ry="47.94"/>
+    </g>
+    <g class="c">
+      <g>
+        <line class="d" x1="344.89" y1="356.27" x2="422.02" y2="172.47"/>
+        <polygon class="e" points="440.89 187.79 435.01 141.5 397.86 169.74 440.89 187.79"/>
+      </g>
+    </g>
+    <g class="c">
+      <g>
+        <line class="f" x1="345.01" y1="356.5" x2="79.27" y2="319.17"/>
+        <polygon class="g" points="89.28 297.01 46.01 314.5 82.78 343.23 89.28 297.01"/>
+      </g>
+    </g>
+    <ellipse class="h" cx="344.6" cy="356.05" rx="47.21" ry="25.52"/>
+    <path class="i" d="M346.25,345.11l-14.41,12.95a4.32,4.32,0,0,0,2.34,7.5L351,367.67a4.33,4.33,0,0,0,4.8-5l-2.39-15.06A4.31,4.31,0,0,0,346.25,345.11Z"/>
+    <g class="c">
+      <g>
+        <line class="j" x1="345.01" y1="355" x2="345.01" y2="62.08"/>
+        <polygon class="k" points="368.35 68.91 345.01 28.5 321.67 68.91 368.35 68.91"/>
+      </g>
+    </g>
+    <text class="l" transform="translate(-0.76 281.71)">y/left</text>
+    <text class="l" transform="translate(371.65 38.02)">z/up</text>
+    <text class="l" transform="translate(455.23 152.62)">x/<tspan class="m" x="43.87" y="0">f</tspan><tspan x="59.3" y="0">or</tspan><tspan class="n" x="104.47" y="0">w</tspan><tspan x="141.14" y="0">a</tspan><tspan class="o" x="167.38" y="0">r</tspan><tspan x="185.16" y="0">d</tspan></text>
+  </g>
+</svg>

docs/img/flix.svg

@@ -0,0 +1,38 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 734.86 378.46">
+  <defs>
+    <style>
+      .a {
+        fill: none;
+        stroke: #d5d5d5;
+        stroke-miterlimit: 10;
+        stroke-width: 31px;
+      }
+
+      .b {
+        fill: #c1c1c1;
+      }
+
+      .c {
+        fill: #ff9400;
+      }
+
+      .d {
+        fill: #d5d5d5;
+      }
+    </style>
+  </defs>
+  <g>
+    <g>
+      <line class="a" x1="448.78" y1="294.23" x2="648.77" y2="93.24"/>
+      <line class="a" x1="449.78" y1="94.24" x2="649.77" y2="295.23"/>
+      <circle class="b" cx="549.27" cy="193.73" r="41.5"/>
+      <circle class="c" cx="449.35" cy="93.74" r="77.95"/>
+      <circle class="c" cx="648.89" cy="93.53" r="77.95"/>
+      <circle class="c" cx="647.89" cy="294.51" r="77.95"/>
+      <circle class="c" cx="448.9" cy="294.51" r="77.95"/>
+    </g>
+    <path class="d" d="M8,161.93q0-17.85,22.36-17.85h4.81V100.57Q35.17,8.49,131.23,8h1q36.87,0,47.31,7.48L181,17.41l1,2.41V50q0,12.32-5.82,12.31-2.43,0-7.4-4.64t-14.19-9a48.63,48.63,0,0,0-21.22-4.41q-12,0-19.17,3.5a18.85,18.85,0,0,0-9.82,10.62,67.35,67.35,0,0,0-3.52,12.06,82.52,82.52,0,0,0-.85,13.39v60.32h27.28q10.86,0,16.05,5.43a17.52,17.52,0,0,1,5.19,12.42,22.5,22.5,0,0,1-1.21,7.36q-1.22,3.51-6.64,7.24t-14.36,3.74H101.64V344.82a56,56,0,0,1-.61,9.65,37.8,37.8,0,0,1-2.56,7.6,11.83,11.83,0,0,1-6.94,6.4q-5,1.93-13.51,1.93H57.08q-10.47,0-15.7-4.71t-5.73-8.44a77.31,77.31,0,0,1-.48-9.53V180.27H29.4Q8,180.27,8,161.93Z"/>
+    <path class="d" d="M201.21,348.2V37q0-23.16,20.86-23.4h22.81q22.8,0,22.8,22.44V346.27a68.92,68.92,0,0,1-.49,9.41,22.59,22.59,0,0,1-2.42,7.12,11.48,11.48,0,0,1-6.67,5.43,47.78,47.78,0,0,1-12.74,2.17H225q-11.4,0-17.58-4.47T201.21,348.2Z"/>
+    <path class="d" d="M284.9,61.08V36.47a40.39,40.39,0,0,1,1.7-12.91,11.36,11.36,0,0,1,6.18-7,25.27,25.27,0,0,1,6.68-2.3c1.45-.15,4-.4,7.76-.72h25.23q10.43,0,16.73,4.7t6.31,18.22V62.05a27.94,27.94,0,0,1-.85,7.11,23,23,0,0,1-2.06,5.43,20,20,0,0,1-2.91,4,10,10,0,0,1-3.52,2.54c-1.21.48-2.54,1-4,1.44a11.53,11.53,0,0,1-3.4.73,13.71,13.71,0,0,0-3.15.48H307.7q-10.43,0-16.61-4.7T284.9,61.08Zm1.94,284.71V166.28q0-22.2,21.83-22.2h20.38q10.92,0,16.62,4t6.67,8.45a60.47,60.47,0,0,1,1,12.18V348.2q0,22.2-21.83,22.2H308.67q-10.43,0-15.64-4.95t-5.7-8.81A90.93,90.93,0,0,1,286.84,345.79Z"/>
+  </g>
+</svg>

docs/img/motors.svg

@@ -0,0 +1,89 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 356.79 357.11">
+  <defs>
+    <style>
+      .a, .e {
+        fill: none;
+        stroke-miterlimit: 10;
+      }
+
+      .a {
+        stroke: #d5d5d5;
+        stroke-width: 31px;
+      }
+
+      .b {
+        fill: #c1c1c1;
+      }
+
+      .c {
+        fill: #ff9400;
+      }
+
+      .d {
+        opacity: 0.12;
+      }
+
+      .e {
+        stroke: #cc5200;
+        stroke-width: 8px;
+      }
+
+      .f {
+        fill: #cc5200;
+      }
+
+      .g {
+        font-size: 50px;
+        fill: #fff;
+      }
+
+      .g, .h {
+        font-family: Tahoma;
+      }
+
+      .h {
+        font-size: 20px;
+      }
+
+      .i {
+        letter-spacing: 0em;
+      }
+    </style>
+  </defs>
+  <g>
+    <g>
+      <line class="a" x1="77.4" y1="278.67" x2="277.4" y2="77.67"/>
+      <line class="a" x1="78.4" y1="78.67" x2="278.4" y2="279.67"/>
+      <circle class="b" cx="177.9" cy="178.17" r="41.5"/>
+      <circle class="c" cx="77.97" cy="78.17" r="77.95"/>
+      <circle class="c" cx="277.52" cy="77.95" r="77.95"/>
+    </g>
+    <path class="d" d="M174.29,163.6l-8.45,26.05A4.32,4.32,0,0,0,170,195.3h16.9a4.32,4.32,0,0,0,4.11-5.65l-8.45-26.05A4.32,4.32,0,0,0,174.29,163.6Z"/>
+    <g>
+      <path class="e" d="M307.47,122.53a52.66,52.66,0,1,0-72.08-76"/>
+      <polygon class="f" points="228.68 38.51 227.44 59.21 245.99 49.94 228.68 38.51"/>
+    </g>
+    <g>
+      <path class="e" d="M48.11,122.22a52.66,52.66,0,1,1,72.08-75.95"/>
+      <polygon class="f" points="109.59 49.63 128.14 58.91 126.9 38.2 109.59 49.63"/>
+    </g>
+    <text class="g" transform="translate(64.89 98.77)">3</text>
+    <text class="g" transform="translate(260.92 98.8)">2</text>
+    <text class="h" transform="translate(66.06 129.25)">p<tspan class="i" x="11.05" y="0">r</tspan><tspan x="18.16" y="0">op A</tspan></text>
+    <text class="h" transform="translate(232.55 128.95)">p<tspan class="i" x="11.05" y="0">r</tspan><tspan x="18.16" y="0">op B</tspan></text>
+    <circle class="c" cx="278.83" cy="277.92" r="77.95"/>
+    <g>
+      <path class="e" d="M249,322a52.66,52.66,0,1,1,72.09-76"/>
+      <polygon class="f" points="310.45 249.38 329 258.66 327.76 237.95 310.45 249.38"/>
+    </g>
+    <text class="g" transform="translate(265.76 298.52)">1</text>
+    <text class="h" transform="translate(266.92 329.01)">p<tspan class="i" x="11.05" y="0">r</tspan><tspan x="18.16" y="0">op A</tspan></text>
+    <circle class="c" cx="77.95" cy="277.92" r="77.95"/>
+    <g>
+      <path class="e" d="M107.9,322.49a52.66,52.66,0,1,0-72.08-76"/>
+      <polygon class="f" points="29.11 238.47 27.87 259.18 46.42 249.91 29.11 238.47"/>
+    </g>
+    <text class="g" transform="translate(61.35 298.76)">0</text>
+    <text class="h" transform="translate(32.98 328.92)">p<tspan class="i" x="11.05" y="0">r</tspan><tspan x="18.16" y="0">op B</tspan></text>
+  </g>
+</svg>

docs/log.md

@@ -2,11 +2,7 @@
 
 Flix quadcopter uses RAM to store flight log data. The default log capacity is 10 seconds at 100 Hz. This configuration can be adjusted in the `log.ino` file.
 
-To perform log analysis, you need to download the log right after the flight without powering off the drone. Then you can use several tools to analyze the log data.
+To perform log analysis, you need to download the flight log. To to that, ensure you're connected to the drone using Wi-Fi and run the following command:
-
-## Log download
-
-To download the log, connect the ESP32 using USB right after the flight and run the following command:
 
 ```bash
 make log

docs/troubleshooting.md

@@ -4,34 +4,44 @@
 
 Do the following:
 
-* **Check ESP32 core is installed**. Check if the version matches the one used in the [tutorial](build.md#firmware).
+* **Check ESP32 core is installed**. Check if the version matches the one used in the [tutorial](usage.md#building-the-firmware).
-* **Check libraries**. Install all the required libraries from the tutorial. Make sure there are no MPU9250 or other peripherals libraries that may conflict with the ones used in the tutorial.
+* **Check libraries**. Install all the required libraries from the tutorial. Make sure there are no MPU-9250 or other peripherals libraries that may conflict with the ones used in the tutorial.
+* **Check the chosen board**. The correct board to choose in Arduino IDE for ESP32 Mini is *WEMOS D1 MINI ESP32*.
 
 ## The drone doesn't fly
 
 Do the following:
 
-* **Check the battery voltage**. Use a multimeter to measure the battery voltage. It should be in range of 3.7-4.2 V.
+* **Check the battery voltage**. Use a multimeter to measure the battery voltage. The fully charged battery should have about 4.2V.
-* **Check if there are some startup errors**. Connect the ESP32 to the computer and check the Serial Monitor output. Use the Reset button to make sure you see the whole ESP32 output.
+* **Check the battery you use has enough discharge current**. The battery should be able to provide 15A of current. So the C-rating for a 1000 mAh battery should be at least 15C (higher is better).
+* **Check if there are some startup errors**. Connect the ESP32 to the computer and check the Serial Monitor output. Use the Reset button or `reboot` command to see the whole startup output.
 * **Check the baudrate is correct**. If you see garbage characters in the Serial Monitor, make sure the baudrate is set to 115200.
-* **Make sure correct IMU model is chosen**. If using ICM-20948 board, change `MPU9250` to `ICM20948` everywhere in the `imu.ino` file.
+* **Check if the console is working**. Perform `help` command in Serial Monitor. You should see the list of available commands. You can also access the console using QGroundControl *(Vehicle Setup* ⇒ *Analyze Tools* ⇒ *MAVLink Console)*.
-* **Check if the CLI is working**. Perform `help` command in Serial Monitor. You should see the list of available commands. You can also access the CLI using QGroundControl (*Vehicle Setup* ⇒ *Analyze Tools* ⇒ *MAVLink Console*).
 * **Configure QGroundControl correctly before connecting to the drone** if you use it to control the drone. Go to the settings and enable *Virtual Joystick*. *Auto-Center Throttle* setting **should be disabled**.
 * **If QGroundControl doesn't connect**, you might need to disable the firewall and/or VPN on your computer.
+* **Make sure correct IMU model is chosen**. If using ICM-20948/MPU-6050 board, change `MPU9250` to `ICM20948`/`MPU6050` in the `imu.ino` file.
 * **Check the IMU is working**. Perform `imu` command and check its output:
   * The `status` field should be `OK`.
   * The `rate` field should be about 1000 (Hz).
   * The `accel` and `gyro` fields should change as you move the drone.
+* **Check the IMU orientation is set correctly**. If the attitude estimation is rotated, set the correct IMU orientation as described in the [tutorial](usage.md#define-imu-orientation).
 * **Calibrate the accelerometer.** if is wasn't done before. Type `ca` command in Serial Monitor and follow the instructions.
-* **Check the attitude estimation**. Connect to the drone using QGroundControl. Rotate the drone in different orientations and check if the attitude estimation shown in QGroundControl is correct.
+* **Check the attitude estimation**. Connect to the drone using QGroundControl. Rotate the drone in different orientations and check if the attitude estimation is shown exactly as on the video below:
-* **Check the IMU orientation is set correctly**. If the attitude estimation is rotated, make sure `rotateIMU` function is defined correctly in `imu.ino` file.
+
+  <a href="https://youtu.be/yVRN23-GISU"><img width=200 src="https://i3.ytimg.com/vi/yVRN23-GISU/maxresdefault.jpg"></a>
+
+* **Check the IMU output**. Connect to the drone using QGroundControl on your computer. Go to the *Analyze* tab, *MAVLINK Inspector*. Plot the data from the `SCALED_IMU` message. The gyroscope and accelerometer data should change according to the drone movement.
 * **Check the motors type**. Motors with exact 3.7V voltage are needed, not ranged working voltage (3.7V — 6V).
 * **Check the motors**. Perform the following commands using Serial Monitor:
   * `mfr` — should rotate front right motor (counter-clockwise).
   * `mfl` — should rotate front left motor (clockwise).
   * `mrl` — should rotate rear left motor (counter-clockwise).
   * `mrr` — should rotate rear right motor (clockwise).
-* **Calibrate the RC** if you use it. Type `cr` command in Serial Monitor and follow the instructions.
+* **Check the propeller directions are correct**. Make sure your propeller types (A or B) are installed as on the picture:
-* **Check the RC data** if you use it. Use `rc` command, `Control` should show correct values between -1 and 1, and between 0 and 1 for the throttle.
+
-* **Check the IMU output using QGroundControl**. Connect to the drone using QGroundControl on your computer. Go to the *Analyze* tab, *MAVLINK Inspector*. Plot the data from the `SCALED_IMU` message. The gyroscope and accelerometer data should change according to the drone movement.
+  <img src="img/user/peter_ukhov-2/1.jpg" width="200">
-* **Check the gyroscope only attitude estimation**. Comment out `applyAcc();` line in `estimate.ino` and check if the attitude estimation in QGroundControl. It should be stable, but only drift very slowly.
+
+* **If using an SBUS receiver**:
+  * **Define the used GPIO pin** in `RC_RX_PIN` parameter.
+  * **Calibrate the RC** using `cr` command in the console.
+  * **Check the controls** using `rc` command. All the controls should change between -1 and 1, and the throttle between 0 and 1.

docs/usage.md

@@ -0,0 +1,398 @@
+# Usage: build, setup and flight
+
+To fly Flix quadcopter, you need to upload the firmware to the ESP32 board, and set up the drone for flight.
+
+## Uploading the firmware
+
+You can either use the **prebuilt binaries** or **build the firmware** from sources — this will let you modify the firmware and add new features.
+
+### Prebuilt binaries (the easiest way)
+
+1. Download the latest firmware file using the following links:
+
+   <!-- markdownlint-disable MD044 -->
+   |Type|Boards|Link|
+   |-|-|-|
+   |ESP32|DevKit, D1 Mini|[`quadcopter.dev/flix.esp32.merged.bin`](https://quadcopter.dev/flix.esp32.merged.bin)|
+   |ESP32-S3|Most S3 based|[`quadcopter.dev/flix.esp32s3.merged.bin`](https://quadcopter.dev/flix.esp32s3.merged.bin)|
+   |ESP32-S3 (2MB PSRAM)|S3 Super Mini, S3 Zero (2MB PSRAM)|[`quadcopter.dev/flix.esp32s3.qspi.merged.bin`](https://quadcopter.dev/flix.esp32s3.qspi.merged.bin)|
+   |ESP32-S3 (8/16MB PSRAM)|S3 Zero (8MB PSRAM)|[`quadcopter.dev/flix.esp32s3.opi.merged.bin`](https://quadcopter.dev/flix.esp32s3.opi.merged.bin)|
+   |ESP32-C3|C3 Super Mini|[`quadcopter.dev/flix.esp32c3.merged.bin`](https://quadcopter.dev/flix.esp32c3.merged.bin)|
+   |Flix2|Flix2 board|[`quadcopter.dev/flix.flix2.merged.bin`](https://quadcopter.dev/flix.flix2.merged.bin)|
+   <!-- markdownlint-enable MD044 -->
+
+2. Flash your ESP32 board using [ESP32 Web Flasher](https://www.espboards.dev/tools/program/):
+
+   <img src="img/web-flasher.png" width="400">
+
+   * Connect the board to your computer, press *Connect to ESP*, choose the serial port.
+   * Go to the *Flash* tab.
+   * Choose the downloaded firmware file, set *Flash address* to *0* (important).
+   * Click *Program* button and wait until the process is finished.
+
+### Building from sources (flexible)
+
+You can build and upload the firmware using either **Arduino IDE** (easier for beginners) or **command line**.
+
+Get the sources using git:
+
+```bash
+git clone https://github.com/okalachev/flix.git && cd flix
+```
+
+Beginners can [download the sources as a ZIP archive](https://github.com/okalachev/flix/archive/refs/heads/master.zip).
+
+#### Arduino IDE (Windows, Linux, macOS)
+
+<img src="img/arduino-ide.png" width="400" alt="Flix firmware open in Arduino IDE">
+
+1. Install [Arduino IDE](https://www.arduino.cc/en/software) (version 2 is recommended).
+2. *Windows users might need to install [USB to UART bridge driver from Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).*
+3. Install ESP32 core, version 3.3.10. See the [official Espressif's instructions](https://docs.espressif.com/projects/arduino-esp32/en/latest/installing.html#installing-using-arduino-ide) on installing ESP32 Core in Arduino IDE.
+4. Install the following libraries using [Library Manager](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-installing-a-library):
+   * `FlixPeriph`, the latest version.
+   * `MAVLink`, version 2.0.25.
+5. Open the `flix/flix.ino` sketch from downloaded firmware sources in Arduino IDE.
+6. Connect your ESP32 board to the computer and choose correct board type in Arduino IDE (*WEMOS D1 MINI ESP32* for ESP32 Mini, *ESP32S3 Dev Module* for ESP32-S3 Super Mini) and the port.
+7. Set *Tools* ⇒ *Core Debug Level* to *Error* to see the errors in the serial console. Set *Tools* ⇒ *USB CDC on Boot* to *Enabled* for ESP32-S3/ESP32-C3 boards.
+8. [Build and upload](https://docs.arduino.cc/software/ide-v2/tutorials/getting-started/ide-v2-uploading-a-sketch) the firmware using Arduino IDE.
+
+#### Command line (Windows, Linux, macOS)
+
+1. [Install Arduino CLI](https://arduino.github.io/arduino-cli/installation/).
+
+   On Linux, install it like this:
+
+   ```bash
+   curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/.local/bin sh
+   ```
+
+2. Windows users might need to install [USB to UART bridge driver from Silicon Labs](https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers).
+3. Compile the firmware using `make`. Arduino dependencies will be installed automatically:
+
+   ```bash
+   make
+   ```
+
+   You can flash the firmware to the board using command:
+
+   ```bash
+   make upload
+   ```
+
+   You can also compile the firmware, upload it and start serial port monitoring using command:
+
+   ```bash
+   make upload monitor
+   ```
+
+   For ESP32-S3/ESP32-C3 boards, set the appropriate [FQBN](https://docs.arduino.cc/arduino-cli/FAQ/#whats-the-fqbn-string) using `BOARD` parameter:
+
+   ```bash
+   make BOARD=esp32:esp32:esp32s3:FlashSize=4M,CDCOnBoot=cdc upload
+   ```
+
+See other available Make commands in [Makefile](../Makefile).
+
+> [!TIP]
+> You can test the firmware on a bare ESP32 board without connecting IMU and other peripherals. The Wi-Fi network `flix` should appear and all the basic functionality including console and QGroundControl connection should work.
+
+## Before first flight
+
+### Connect using QGroundControl
+
+QGroundControl is a ground control station software that can be used to monitor and control the drone.
+
+1. Install mobile or desktop version of [QGroundControl](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html).
+2. Power up the drone.
+3. Connect your computer or smartphone to the appeared `flix` Wi-Fi network (password: `flixwifi`).
+4. Launch QGroundControl app. It should connect and begin showing the drone's telemetry automatically.
+
+> [!TIP]
+> If QGroundControl doesn't connect, try to disable the firewall and/or VPN on your computer, as they may block the connection.
+
+### Access console
+
+The console is a command line interface (CLI) that allows to interact with the drone, change parameters, and perform various actions. There are two ways of accessing the console: using **serial port** or using **QGroundControl (wirelessly)**.
+
+To access the console using serial port:
+
+1. Connect the ESP32 board to the computer using USB cable.
+2. Open Serial Monitor in Arduino IDE (or use `make monitor` in the command line).
+3. In Arduino IDE, make sure the baudrate is set to 115200.
+
+To access the console using QGroundControl:
+
+1. Connect to the drone using QGroundControl app.
+2. Go to the QGroundControl menu ⇒ *Analyze Tools* ⇒ *MAVLink Console*.
+
+<img src="img/cli.png" width="400">
+
+> [!TIP]
+> Use `help` command to see the list of available commands.
+
+### Access parameters
+
+The drone is configured using parameters. To access and modify them, go to the QGroundControl menu ⇒ *Vehicle Setup* ⇒ *Parameters*:
+
+<img src="img/parameters.png" width="400">
+
+You can also work with parameters using `p` command in the console. Parameter names are case-insensitive.
+
+### Configure the IMU
+
+1. Configure the following parameters for the IMU:
+   * `IMU_MODEL` — IMU model (1 for MPU-9250/MPU-6500, 2 for ICM-20948, 3 for MPU-6050, 4 for ICM-40609-D).
+   * `IMU_BUS` — communication bus (0 for SPI, 1 for I²C).
+   * `IMU_PIN_SCK`, `IMU_PIN_MISO`, `IMU_PIN_MOSI`, `IMU_PIN_CS` — SPI pin numbers.
+   * `IMU_PIN_SCL`, `IMU_PIN_SDA` — I²C pin numbers.
+   * `IMU_PIN_INT` — IMU data ready pin number (-1 if not used).
+2. Reboot the drone.
+3. Check the IMU is working using `imu` command in the console (should print `status: OK`).
+
+### Define IMU orientation
+
+The IMU orientation (relative to the drone's axes) is defined using the parameters: `IMU_ROT_ROLL`, `IMU_ROT_PITCH`, and `IMU_ROT_YAW`.
+
+The drone has *X* axis pointing forward, *Y* axis pointing left, and *Z* axis pointing up, and the supported IMU boards have *X* axis pointing to the mounting holes side and *Z* axis pointing up from the component side:
+
+<img src="img/imu-axes.png" width="200">
+
+Use the following table to set the parameters for common IMU orientations:
+
+|Orientation|Parameters|Orientation|Parameters|
+|:-:|-|-|-|
+|<img src="img/imu-rot-3.png" width="180">|`IMU_ROT_ROLL` = 0<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 0    |<img src="img/imu-rot-7.png" width="180">|`IMU_ROT_ROLL` = 3.142<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 0|
+|<img src="img/imu-rot-2.png" width="180">|`IMU_ROT_ROLL` = 0<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = -1.571|<img src="img/imu-rot-6.png" width="180">|`IMU_ROT_ROLL` = 3.142<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = -1.571|
+|<img src="img/imu-rot-1.png" width="180">|`IMU_ROT_ROLL` = 0<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 3.142|<img src="img/imu-rot-5.png" width="180">|`IMU_ROT_ROLL` = 3.142<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 3.142|
+|<img src="img/imu-rot-4.png" width="180"><br>☑️ **Default**|<br>`IMU_ROT_ROLL` = 0<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 1.571|<img src="img/imu-rot-8.png" width="180">|`IMU_ROT_ROLL` = 3.142<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 1.571|
+
+### Calibrate accelerometer
+
+Before flight you need to calibrate the accelerometer:
+
+1. Access the console using QGroundControl (recommended) or Serial Monitor.
+2. Type `ca` command there and follow the instructions.
+
+### Setup motors
+
+If using non-default motor pins, set the pin numbers using the parameters: `MOTOR_PIN_FL`, `MOTOR_PIN_FR`, `MOTOR_PIN_RL`, `MOTOR_PIN_RR` (front-left, front-right, rear-left, rear-right respectively).
+
+#### Brushless motors
+
+If using brushless motors with ESCs:
+
+1. Set the appropriate PWM using the parameters: `MOT_PWM_STOP`, `MOT_PWM_MIN`, and `MOT_PWM_MAX` (1000, 1000, and 2000 is typical).
+2. Decrease the PWM frequency using the `MOT_PWM_FREQ` parameter (400 is typical).
+
+> [!CAUTION]
+> **Remove the props when configuring the motors!** If improperly configured, you may not be able to stop them.
+
+### Battery voltage monitoring (optional)
+
+ESP32 ADC can measure only up to 3.3 V, so you need to use a voltage divider to monitor the battery voltage. To enable voltage measurement, set the following parameters:
+
+1. `PWR_VOLT_PIN` — GPIO pin number where the voltage divider is connected (*-1* to disable).
+2. `PWR_VOLT_SCALE` — voltage divider coefficient (*2* for two equal resistors).
+
+After this setup, you should see the battery voltage in QGroundControl top panel or using `pw` command in the console.
+
+### Important: check everything works
+
+1. Check the IMU is working: perform `imu` command in the console and check the output:
+
+   * The `status` field should be `OK`.
+   * The `rate` field should be about 1000 (Hz).
+   * The `accel` and `gyro` fields should change as you move the drone.
+   * The `accel bias` and `accel scale` fields should contain calibration parameters (not zeros and ones).
+   * The `gyro bias` field should contain estimated gyro bias (not zeros).
+   * The `landed` field should be `1` when the drone is still on the ground and `0` when you lift it up.
+
+2. Check the attitude estimation: connect to the drone using QGroundControl, rotate the drone in different orientations and check if the attitude estimation shown in QGroundControl is correct. Compare your attitude indicator (in the *large vertical* mode) to the video:
+
+   <a href="https://youtu.be/yVRN23-GISU"><img width=300 src="https://i3.ytimg.com/vi/yVRN23-GISU/maxresdefault.jpg"></a>
+
+3. Perform motor tests. Use the following commands **— remove the propellers before running the tests!**
+
+   * `mfr` — rotate front right motor (counter-clockwise).
+   * `mfl` — rotate front left motor (clockwise).
+   * `mrl` — rotate rear left motor (counter-clockwise).
+   * `mrr` — rotate rear right motor (clockwise).
+
+   Make sure rotation directions and propeller types match the following diagram:
+
+   <img src="img/motors.svg" width=200>
+
+> [!WARNING]
+> Never run the motors when powering the drone from USB, always use the battery for that.
+
+## Setup remote control
+
+There are several ways to control the drone's flight: using **smartphone** (Wi-Fi), using **SBUS remote control**, or using **USB remote control** (Wi-Fi/ESP-NOW).
+
+### Control with a smartphone
+
+#### Using Mavlink Joystick app (Android)
+
+<img src="https://github.com/goldarte/mavlink-joystick/blob/master/app_screen.png?raw=true" width="400">
+
+1. Download and install [Mavlink Joystick app](https://github.com/goldarte/mavlink-joystick/releases/latest).
+2. Power the drone using the battery.
+3. Connect your smartphone to the appeared `flix` Wi-Fi network (password: `flixwifi`).
+4. Open Mavlink Joystick app. It should connect and begin showing the drone's telemetry automatically.
+5. Use the virtual joystick to fly the drone!
+
+#### Using QGroundControl app
+
+1. Install [QGroundControl mobile app](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html#android) on your smartphone.
+2. Power the drone using the battery.
+3. Connect your smartphone to the appeared `flix` Wi-Fi network (password: `flixwifi`).
+4. Open QGroundControl app. It should connect and begin showing the drone's telemetry automatically.
+5. Go to the settings and enable *Virtual Joystick*. *Auto-Center Throttle* setting **should be disabled**.
+6. Use the virtual joystick to fly the drone!
+
+> [!TIP]
+> Decrease `CTL_TILT_MAX` parameter when flying using the smartphone to make the controls less sensitive.
+
+### Control with a remote control
+
+If using SBUS-connected remote control you need to enable SBUS and calibrate it:
+
+1. Connect to the drone using QGroundControl.
+2. In parameters, set the `RC_RX_PIN` parameter to the GPIO pin number where the SBUS signal is connected, for example: 4. Negative value disables SBUS.
+3. Check if the receiver is working using `rc` command in the console.
+4. Open the console, type `cr` command and follow the instructions to calibrate the remote control.
+5. Use the remote control to fly the drone!
+
+### Control with a USB remote control
+
+If your drone doesn't have RC receiver installed, you can use USB remote control and QGroundControl app to fly it.
+
+1. Install [QGroundControl](https://docs.qgroundcontrol.com/master/en/qgc-user-guide/getting_started/download_and_install.html) app on your computer.
+2. Connect your USB remote control to the computer.
+3. Power up the drone.
+4. Connect your computer to the appeared `flix` Wi-Fi network (password: `flixwifi`).
+5. Launch QGroundControl app. It should connect and begin showing the drone's telemetry automatically.
+6. Go to the QGroundControl menu ⇒ *Vehicle Setup* ⇒ *Joystick*. Calibrate your USB remote control there.
+7. Use the USB remote control to fly the drone!
+
+## Flight
+
+For both virtual sticks and a physical joystick, the default control scheme is left stick for throttle and yaw and right stick for pitch and roll:
+
+<img src="img/controls.svg" width="300">
+
+### Arming and disarming
+
+To start the motors, you should **arm** the drone. To do that, move the left stick to the bottom right corner:
+
+<img src="img/arming.svg" width="150">
+
+After that, the motors **will start spinning** at low speed, indicating that the drone is armed and ready to fly.
+
+When finished flying, **disarm** the drone, moving the left stick to the bottom left corner:
+
+<img src="img/disarming.svg" width="150">
+
+> [!NOTE]
+> If something goes wrong, go to the [Troubleshooting](troubleshooting.md) article.
+
+### Flight modes
+
+Flight mode is changed using mode switch on the remote control (if configured) or using the console commands. The main flight mode is *STAB*. In order to change modes using SBUS remote control, set the parameters: `CTL_FLT_MODE_0`, `CTL_FLT_MODE_1`, and `CTL_FLT_MODE_2` to required mode numbers (0 for *RAW*, 1 for *ACRO*, 2 for *STAB*, 3 for *AUTO*).
+
+#### STAB
+
+In this mode, the drone stabilizes its attitude (orientation). The left stick controls throttle and yaw rate, the right stick controls pitch and roll angles.
+
+> [!IMPORTANT]
+> The drone doesn't stabilize its position, so slight drift is possible. The pilot should compensate it manually.
+
+#### ACRO
+
+In this mode, the pilot controls the angular rates. This control method is difficult to fly and mostly used in FPV racing.
+
+#### RAW
+
+*RAW* mode disables all the stabilization, and the pilot inputs are mixed directly to the motors. The IMU sensor is not involved. This mode is intended for testing and demonstration purposes only, and basically the drone **cannot fly in this mode**.
+
+#### AUTO
+
+In this mode, the pilot inputs are ignored (except the mode switch). The drone can be controlled using [pyflix](../tools/pyflix/) Python library, or by modifying the firmware to implement the needed behavior.
+
+If the pilot moves the control sticks and mode switch is not configured, the drone will switch back to *STAB* mode.
+
+## Wi-Fi configuration
+
+You can configure the Wi-Fi using parameters and console commands.
+
+The Wi-Fi mode is chosen using `WIFI_MODE` parameter in QGroundControl or in the console:
+
+* `0` — Wi-Fi is disabled.
+* `1` — Access Point mode *(AP)* — the drone creates a Wi-Fi network.
+* `2` — Client mode *(STA)* — the drone connects to an existing Wi-Fi network (may cause additional delays, so generally not recommended).
+* `3` — ESP-NOW mode — the drone uses ESP-NOW protocol for communication.
+
+The SSID and password are configured using the `ap` and `sta` console commands:
+
+```
+ap <ssid> <password>
+sta <ssid> <password>
+```
+
+Example of configuring the Access Point mode:
+
+```
+ap my-flix-ssid mypassword123
+p WIFI_MODE 1
+```
+
+Disabling Wi-Fi:
+
+```
+p WIFI_MODE 0
+```
+
+### Using ESP-NOW
+
+[ESP-NOW](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/network/esp_now.html) is a low level wireless communication protocol. It can provide lower latency, better reliability, and longer range than Wi-Fi. However, it requires a second ESP32 board to be used as a proxy for the computer.
+
+<img src="img/espnow-connection.jpg" width="600">
+
+To setup ESP-NOW communication:
+
+1. Flash the second ESP32 board with ESP-NOW proxy sketch: [`tools/espnow-proxy/espnow-proxy.ino`](../tools/espnow-proxy/espnow-proxy.ino). Use Arduino IDE or command line: `make upload_proxy`.
+
+2. Open Serial Monitor in Arduino IDE or use `make monitor` command. The ESP32 will print its MAC address and generated encryption key, for example:
+
+   ```
+   espnow 7a:c8:e3:eb:bf:e9 &PiuSysxP9+$L&5E
+   ```
+
+   Run this line as a console command on each drone you want to bind to this proxy board. [The maximum number](https://github.com/espressif/esp-idf/blob/e95cab4be8fd293e3f3323181e7a2280874da6f7/components/esp_wifi/include/esp_now.h#L32-L33) of simultaneously connected drones is 20 (unencrypted) or 6 (encrypted).
+
+3. Set the `WIFI_MODE` parameter to `3` on the drone:
+
+   ```
+   p WIFI_MODE 3
+   ```
+
+4. Go to the QGroundControl menu ⇒ *Application Settings* ⇒ *Comm Links*, add new link with the following settings:
+   * Name: ESP32.
+   * Type: Serial.
+   * Serial Port: choose the port of the proxy ESP32 board, e. g. `/dev/cu.usbserial-0001`.
+   * Baud Rate: 115200.
+5. Click *Save*, click *Connect*. QGroundControl should connect to the drone using ESP-NOW and begin showing the telemetry.
+
+> [!TIP]
+> Make sure Arduino IDE is not running when using ESP-NOW proxy board, as it may block the serial port.
+
+## Flight log
+
+After the flight, you can download the flight log wirelessly for analysis. Use the following command on your computer for that:
+
+```bash
+make log
+```
+
+See more details about log analysis in the [log analysis](log.md) article.

docs/user.md

@@ -4,6 +4,183 @@ This page contains user-built drones based on the Flix project. Publish your pro
 
 ---
 
+Author: [Oleg1405](https://t.me/Oleg1405).<br>
+Description: ESP32 Mini, MPU-6500 IMU, boost converter, BT2.0 power connector, 65 mm props, BetaFPV ELRS Lite Receiver, Radiomaster Pocket + Mavlink Joystick (Android) control.
+
+<img src="img/user/oleg1405/1.jpg" height=300>
+
+[Flight video](https://www.youtube.com/shorts/rbXV4sHbpso).
+
+---
+
+Author: Alican Erüst.<br>
+Description: QX95 mm frame, 55 mm propellers, 3.7 V 25C 1050 mAh LiPo battery, MPU6050 IMU, Logitech F310 gamepad controller, with a total quadcopter weight of 66 g.
+
+<img src="img/user/alicanerus/1.jpg" height=200> <img src="img/user/alicanerus/2.jpg" height=200> <img src="img/user/alicanerus/3.jpg" height=200>
+
+[Flight video](https://drive.google.com/file/d/1k0WeWTKnCAfaugkX7LcmNxsUuq79RL8Z/view?usp=sharing).
+
+---
+
+Author: [Неруш Михаил](https://t.me/NerushMV).<br>
+Description: custom frame made of 4 mm plywood, 8520 brushed motors, 75 mm propellers, MPU-6500. FlySky FS-i6X with ESP32-based adapter for ESP-NOW communication (using PPM output).<br>
+Sources and materials: [link](https://drive.google.com/drive/folders/1uWiDcuorLrtVs_IIR7Y13omij-7Q1nx8).
+
+<img src="img/user/nerush/1.jpg" height=200> <img src="img/user/nerush/2.jpg" height=200>
+
+[Flight video](https://drive.google.com/file/d/1jRXeGx34lJpUfw0GKLQeIzkWZvooQJSE/view?usp=sharing).
+
+---
+
+Author: [Konstantinos Paraskevas](https://github.com/Frapais).<br>
+Description: drone with a custom single-boarded airframe, extending the [Sprig-C3 module](https://github.com/Frapais/Sprig-C3).
+ESP32-C3 microcontroller, ICM-20948 IMU, on-board fuel-gauge, status LED indicator.<br>
+Repository with all the code and PCB sources: https://github.com/Frapais/Sprig-Drone.
+
+<img src="img/user/kostas/1.jpg" height=150> <img src="img/user/kostas/2.jpg" height=150>
+
+Detailed video about making the drone:
+
+<a href="https://youtu.be/82Q-uBq6s48"><img width=400 src="https://i3.ytimg.com/vi/82Q-uBq6s48/maxresdefault.jpg"></a>
+
+---
+
+Author: [Awab Anas](http://t.me/AW_VENOM).<br>
+Description: ESP32 D1 Mini, MPU-6050, 8520 3.7V brushed motors, 55 mm propellers, battery li-po 1200 mAh, controlling via [Mavlink Joystick app](https://github.com/goldarte/mavlink-joystick/releases/latest).<br>
+[Flight validation](https://drive.google.com/file/d/12z0jfctZDBA6b5UKCG0Uje5rAxj6DhF-/view?usp=sharing).
+
+<img src="img/user/aw_venom/1.jpg" height=200>
+
+---
+
+Author: [Ina Tix](https://t.me/ina_tix).<br>
+Description: XR2981 based DC-DC converter, ELRS MINI 2.4GHz RX SX1280 receiver (SBUS interface), Radiomaster TX12 remote control.<br>
+[Flight validation](https://drive.google.com/file/d/1yqkKNuz4R_yxGqUNQxVpixJbXqEEcUSj/view?usp=share_link).
+
+<img src="img/user/ina_tix/1.jpg" height=200> <img src="img/user/ina_tix/2.jpg" height=200> <img src="img/user/ina_tix/3.jpg" height=200>
+
+---
+
+Author: Oleg Kalachev.<br>
+Description: the first attempt on making an official PCB based Flix drone (Flix2 board). The IMU is not working on this version, so an external MPU-6050 board was used, therefore considered as **Flix version 1.5**.<br>
+[Flight video](https://drive.google.com/file/d/1R7tuUsFmPY0CGcOCFfMFaCp9kR49K3bl/view?usp=sharing).
+
+<img src="img/flix1.5.jpg" width=300>
+
+---
+
+Author: [FanBy0ru](https://https://github.com/FanBy0ru).<br>
+Description: custom 3D-printed frame.<br>
+Frame STLs and flight validation: https://cults3d.com/en/3d-model/gadget/armature-pour-flix-drone.
+
+<img src="img/user/fanby0ru/1.jpg" height=200> <img src="img/user/fanby0ru/2.jpg" height=200>
+
+---
+
+Author: Ivan44 Phalko.<br>
+Description: custom PCB, cusom test bench.<br>
+[Flight validation](https://drive.google.com/file/d/17DNDJ1gPmCmDRAwjedCbJ9RXAyqMqqcX/view?usp=sharing).
+
+<img src="img/user/phalko/1.jpg" height=200> <img src="img/user/phalko/2.jpg" height=200> <img src="img/user/phalko/3.jpg" height=200>
+
+---
+
+Author: **Arkadiy "Arky" Matsekh**, Foucault Dynamics, Gold Coast, Australia.<br>
+The drone was built for the University of Queensland industry-led Master's capstone project.
+
+**Flight video:**
+
+<a href="https://drive.google.com/file/d/1NNYSVXBY-w0JjCo07D8-PgnVq3ca9plj/view?usp=sharing"><img height=300 src="img/user/arkymatsekh/video.jpg"></a>
+
+<img src="img/user/arkymatsekh/1.jpg" height=150> <img src="img/user/arkymatsekh/2.jpg" height=150> <img src="img/user/arkymatsekh/3.jpg" height=150>
+
+---
+
+Author: [goldarte](https://t.me/goldarte).<br>
+
+<img src="img/user/goldarte/1.jpg" height=150> <img src="img/user/goldarte/2.jpg" height=150>
+
+**Flight video:**
+
+<a href="https://drive.google.com/file/d/1nQtFjEcGGLx-l4xkL5ko9ZpOTVU-WDjL/view?usp=sharing"><img height=200 src="img/user/goldarte/video.jpg"></a>
+
+---
+
+Author: [malagis](https://oshwhub.com/malagis).<br>
+
+A Chinese custom PCB version of Flix with a big community of users, lots of materials and modifications.
+
+Main project's page: https://oshwhub.com/malagis/esp32-mini-plane.<br>
+Video about the project: https://www.bilibili.com/video/BV14vyqBFEJn/.
+
+<img src="img/user/malagis/1.jpg" height=200> <img src="img/user/malagis/2.jpg" height=200> <img src="img/user/malagis/3.jpg" height=200>
+
+---
+
+## School 548 course
+
+Special course on quadcopter design and engineering took place in october-november 2025 in School 548, Moscow. The course included UAV control theory, electronics, drone assembly and setup practice, using the Flix project.
+
+<img height=200 src="img/user/school548/1.jpg"> <img height=200 src="img/user/school548/2.jpg"> <img height=200 src="img/user/school548/3.jpg">
+
+STL files and other materials: see [here](https://drive.google.com/drive/folders/1wTUzj087LjKQQl3Lz5CjHCuobxoykhyp?usp=share_link).
+
+### Selected works
+
+Author: [KiraFlux](https://t.me/@kiraflux_0XC0000005).<br>
+Description: **custom ESPNOW remote control** was implemented, modified firmware to support ESPNOW protocol.<br>
+Telegram posts: [1](https://t.me/opensourcequadcopter/106), [2](https://t.me/opensourcequadcopter/114).<br>
+Modified Flix firmware: https://github.com/KiraFlux/flix/tree/klyax.<br>
+Remote control project: https://github.com/KiraFlux/ESP32-DJC.<br>
+Drone design: https://github.com/KiraFlux/Klyax.<br>
+
+<img src="img/user/school548/kiraflux1.jpg" height=150> <img src="img/user/school548/kiraflux2.jpg" height=150>
+
+**ESPNOW remote control demonstration**:
+
+<img height=200 src="img/user/school548/kiraflux-video.jpg"><a href="https://drive.google.com/file/d/1soHDAeHQWnm97Y4dg4nWevJuMiTdJJXW/view?usp=sharing"></a>
+
+Author: [tolyan4krut](https://t.me/tolyan4krut).<br>
+Description: the first drone based on ESP32-S3-CAM board **with a camera**, implementing Wi-Fi video streaming. Runs HTTP server and HTTP video stream.<br>
+Modified Flix firmware: https://github.com/CatRey/Flix-Camera-Streaming.<br>
+[Telegram post](https://t.me/opensourcequadcopter/117).
+
+<img src="img/user/school548/tolyan4krut.jpg" height=150>
+
+**Video streaming and flight demonstration**:
+
+<a href="https://drive.google.com/file/d/1KuOBsujLsk7q8FoqKD8u7uoq4ptS5onp/view?usp=sharing"><img height=200 src="img/user/school548/tolyan4krut-video.jpg"></a>
+
+Author: [Vlad Tolshinov](https://t.me/Vlad_Tolshinov).<br>
+Description: custom frame with enlarged arm length, which provides very high flight stability, 65 mm props.
+
+<img src="img/user/school548/vlad_tolshinov1.jpg" height=150> <img src="img/user/school548/vlad_tolshinov2.jpg" height=150>
+
+**Flight video**:
+
+<a href="https://drive.google.com/file/d/1zu00DZxhC7DJ9Z2mYjtxdNQqOOLAyYbp/view?usp=sharing"><img height=200 src="img/user/school548/vlad_tolshinov-video.jpg"></a>
+
+---
+
+## RoboCamp
+
+Author: RoboCamp participants.<br>
+Description: 3D-printed and wooden frames, ESP32 Mini, DC-DC buck-boost converters. BetaFPV LiteRadio 3 to control the drones via Wi-Fi connection.<br>
+Features: altitude hold, obstacle avoidance, autonomous flight elements.<br>
+Some of the designed model files: see [here](https://drive.google.com/drive/folders/18YHWGquKeIevzrMH4-OUT-zKXMETTEUu?usp=share_link).
+
+RoboCamp took place in July 2025, Saint Petersburg, where 9 participants designed and built their own drones using the Flix project, and then modified the firmware to complete specific flight tasks.
+
+See the detailed video about the event:
+
+<a href="https://youtu.be/Wd3yaorjTx0"><img width=500 src="https://img.youtube.com/vi/Wd3yaorjTx0/sddefault.jpg"></a>
+
+Built drones:
+
+<img src="img/user/robocamp/1.jpg" width=500>
+
+---
+
 Author: chkroko.<br>
 Description: the first Flix drone built with **brushless motors** (DShot interface).<br>
 Features: SpeedyBee BLS 35A Mini V2 ESC, ESP32-S3 board, EMAX ECO 2 2207 1700kv motors, ICM20948V2 IMU, INA226 power monitor and Bluetooth gamepad for control.<br>

docs/version0.md

@@ -14,7 +14,7 @@ Flix version 0 (obsolete):
 |Motor|8520 3.7V brushed motor (**shaft 0.8mm!**)|<img src="img/motor.jpeg" width=100>|4|
 |Propeller|Hubsan 55 mm|<img src="img/prop.jpg" width=100>|4|
 |Motor ESC|2.7A 1S Dual Way Micro Brush ESC|<img src="img/esc.jpg" width=100>|4|
-|RC transmitter|KINGKONG TINY X8|<img src="img/tx.jpg" width=100>|1|
+|RC transmitter|KINGKONG TINY X8|<img src="img/kingkong.jpg" width=100>|1|
 |RC receiver|DF500 (SBUS)|<img src="img/rx.jpg" width=100>|1|
 |~~SBUS inverter~~*||<img src="img/inv.jpg" width=100>|~~1~~|
 |Battery|3.7 Li-Po 850 MaH 60C|||

flix/cli.ino

@@ -6,61 +6,78 @@
 #include "pid.h"
 #include "vector.h"
 #include "util.h"
+#include "filter.h"
 
 extern const int MOTOR_REAR_LEFT, MOTOR_REAR_RIGHT, MOTOR_FRONT_RIGHT, MOTOR_FRONT_LEFT;
-extern float loopRate, dt;
+extern const int RAW, ACRO, STAB, AUTO;
-extern double t;
+extern const int W_AP, W_STA, W_ESPNOW;
+extern float t, dt, loopRate;
 extern uint16_t channels[16];
-extern float controlRoll, controlPitch, controlThrottle, controlYaw, controlArmed, controlMode;
+extern float controlTime;
+extern int mode;
+extern bool armed;
+extern LowPassFilter<Vector> gyroBiasFilter;
+extern float voltage;
 
 const char* motd =
-"\nWelcome to\n"
 " _______  __       __  ___   ___\n"
 "|   ____||  |     |  | \\  \\ /  /\n"
 "|  |__   |  |     |  |  \\  V  /\n"
 "|   __|  |  |     |  |   >   <\n"
 "|  |     |  `----.|  |  /  .  \\\n"
 "|__|     |_______||__| /__/ \\__\\\n\n"
+"(C) Oleg Kalachev\n"
+"https://github.com/okalachev/flix\n\n"
 "Commands:\n\n"
 "help - show help\n"
 "p - show all parameters\n"
-"p <name> - show parameter\n"
+"p <str> - show parameters starting with str\n"
 "p <name> <value> - set parameter\n"
 "preset - reset parameters\n"
 "time - show time info\n"
-"ps - show pitch/roll/yaw\n"
-"psq - show attitude quaternion\n"
 "imu - show IMU data\n"
-"rc - show RC data\n"
-"mot - show motor output\n"
-"log - dump in-RAM log\n"
-"cr - calibrate RC\n"
 "ca - calibrate accel\n"
-"mfr, mfl, mrr, mrl - test motor (remove props)\n"
+"st - show state estimation\n"
+"arm - arm the drone\n"
+"disarm - disarm the drone\n"
+"raw/stab/acro/auto - set mode\n"
+"rc - show RC data\n"
+"cr - calibrate RC\n"
+"pw - show power info\n"
+"wifi - show Wi-Fi info\n"
+"wifi ap/sta/espnow/off - set Wi-Fi mode\n"
+"ap <ssid> <password> - configure Wi-Fi access point\n"
+"sta <ssid> <password> - configure Wi-Fi client mode\n"
+"espnow <mac> [<key>] - configure ESP-NOW peer\n"
+"mot - show motor output\n"
+"mfr/mfl/mrr/mrl [<thrust>] - test motor (remove props)\n"
+"log [dump] - print log header [and data]\n"
+"log - show log info\n"
+"log header - show log header\n"
+"log reset - reset log\n"
+"log <name> <rate> - setup log topic rate\n"
+"l <str> - show log values starting with str\n"
+"l expose <name> - expose log value to telemetry\n"
 "sys - show system info\n"
 "reset - reset drone's state\n"
 "reboot - reboot the drone\n";
 
 void print(const char* format, ...) {
-	char buf[1000];
+	char buf[3000];
 	va_list args;
 	va_start(args, format);
 	vsnprintf(buf, sizeof(buf), format, args);
 	va_end(args);
 	Serial.print(buf);
-#if WIFI_ENABLED
 	mavlinkPrint(buf);
-#endif
 }
 
 void pause(float duration) {
-	double start = t;
+	float start = t;
 	while (t - start < duration) {
 		step();
 		handleInput();
-#if WIFI_ENABLED
 		processMavlink();
-#endif
 		delay(50);
 	}
 }
@@ -69,9 +86,10 @@ void doCommand(String str, bool echo = false) {
 	// parse command
 	String command, arg0, arg1;
 	splitString(str, command, arg0, arg1);
+	if (command.isEmpty()) return;
 
 	// echo command
-	if (echo && !command.isEmpty()) {
+	if (echo) {
 		print("> %s\n", str.c_str());
 	}
 
@@ -80,16 +98,14 @@ void doCommand(String str, bool echo = false) {
 	// execute command
 	if (command == "help" || command == "motd") {
 		print("%s\n", motd);
-	} else if (command == "p" && arg0 == "") {
+	} else if (command == "p" && arg1 == "") {
-		printParameters();
+		printParameters(arg0.c_str());
-	} else if (command == "p" && arg0 != "" && arg1 == "") {
-		print("%s = %g\n", arg0.c_str(), getParameter(arg0.c_str()));
 	} else if (command == "p") {
 		bool success = setParameter(arg0.c_str(), arg1.toFloat());
 		if (success) {
-			print("%s = %g\n", arg0.c_str(), arg1.toFloat());
+			print("%s = %g\n", arg0.c_str(), getParameter(arg0.c_str()));
 		} else {
-			print("Parameter not found: %s\n", arg0.c_str());
+			print("Cannot set parameter: %s\n", arg0.c_str());
 		}
 	} else if (command == "preset") {
 		resetParameters();
@@ -97,50 +113,90 @@ void doCommand(String str, bool echo = false) {
 		print("Time: %f\n", t);
 		print("Loop rate: %.0f\n", loopRate);
 		print("dt: %f\n", dt);
-	} else if (command == "ps") {
-		Vector a = attitude.toEuler();
-		print("roll: %f pitch: %f yaw: %f\n", degrees(a.x), degrees(a.y), degrees(a.z));
-	} else if (command == "psq") {
-		print("qx: %f qy: %f qz: %f qw: %f\n", attitude.x, attitude.y, attitude.z, attitude.w);
 	} else if (command == "imu") {
 		printIMUInfo();
-		print("gyro: %f %f %f\n", rates.x, rates.y, rates.z);
-		print("acc: %f %f %f\n", acc.x, acc.y, acc.z);
 		printIMUCalibration();
-		print("rate: %.0f\n", loopRate);
 		print("landed: %d\n", landed);
+	} else if (command == "st") {
+		print("rates: %g %g %g\n", rates.x, rates.y, rates.z);
+		print("attitude: %g %g %g %g\n", attitude.w, attitude.x, attitude.y, attitude.z);
+		print("roll: %g° pitch: %g° yaw: %g°\n", degrees(attitude.getRoll()), degrees(attitude.getPitch()), degrees(attitude.getYaw()));
+		print("landed: %d\n", landed);
+	} else if (command == "arm") {
+		armed = true;
+	} else if (command == "disarm") {
+		armed = false;
+	} else if (command == "raw") {
+		mode = RAW;
+	} else if (command == "stab") {
+		mode = STAB;
+	} else if (command == "acro") {
+		mode = ACRO;
+	} else if (command == "auto") {
+		mode = AUTO;
 	} else if (command == "rc") {
 		print("channels: ");
 		for (int i = 0; i < 16; i++) {
 			print("%u ", channels[i]);
 		}
-		print("\nroll: %g pitch: %g yaw: %g throttle: %g armed: %g mode: %g\n",
+		print("\nroll: %g pitch: %g yaw: %g throttle: %g mode: %g\n",
-			controlRoll, controlPitch, controlYaw, controlThrottle, controlArmed, controlMode);
+			controlRoll, controlPitch, controlYaw, controlThrottle, controlMode);
+		print("time: %.1f\n", controlTime);
 		print("mode: %s\n", getModeName());
+		print("armed: %d\n", armed);
+	} else if (command == "pw") {
+		print("Voltage: %.1f V\n", voltage);
+	} else if (command == "wifi" && arg0 == "") {
+		printWiFiInfo();
+	} else if (command == "wifi") {
+		setWiFiMode(arg0);
+	} else if (command == "ap") {
+		configWiFi(W_AP, arg0.c_str(), arg1.c_str());
+	} else if (command == "sta") {
+		configWiFi(W_STA, arg0.c_str(), arg1.c_str());
+	} else if (command == "espnow") {
+		configWiFi(W_ESPNOW, arg0.c_str(), arg1.c_str());
 	} else if (command == "mot") {
 		print("front-right %g front-left %g rear-right %g rear-left %g\n",
 			motors[MOTOR_FRONT_RIGHT], motors[MOTOR_FRONT_LEFT], motors[MOTOR_REAR_RIGHT], motors[MOTOR_REAR_LEFT]);
-	} else if (command == "log") {
+	} else if (command == "log" && arg0 == "") {
-		dumpLog();
+		printLogInfo();
+	} else if (command == "log" && arg1 != "") {
+		configLogThrottle(arg0.c_str(), arg1.toFloat());
+	} else if (command == "log" && arg0 == "header") {
+		printLogHeader();
+	} else if (command == "log" && arg0 == "reset") {
+		resetLog();
+	} else if (command == "l" && arg0 == "expose" && arg1 != "") {
+		exposeLogValue(arg1.c_str());
+	} else if (command == "l") {
+		printLogValues(arg0.c_str());
 	} else if (command == "cr") {
 		calibrateRC();
 	} else if (command == "ca") {
 		calibrateAccel();
 	} else if (command == "mfr") {
-		testMotor(MOTOR_FRONT_RIGHT);
+		testMotor(MOTOR_FRONT_RIGHT, arg0.isEmpty() ? 0.2 : arg0.toFloat());
 	} else if (command == "mfl") {
-		testMotor(MOTOR_FRONT_LEFT);
+		testMotor(MOTOR_FRONT_LEFT, arg0.isEmpty() ? 0.2 : arg0.toFloat());
 	} else if (command == "mrr") {
-		testMotor(MOTOR_REAR_RIGHT);
+		testMotor(MOTOR_REAR_RIGHT, arg0.isEmpty() ? 0.2 : arg0.toFloat());
 	} else if (command == "mrl") {
-		testMotor(MOTOR_REAR_LEFT);
+		testMotor(MOTOR_REAR_LEFT, arg0.isEmpty() ? 0.2 : arg0.toFloat());
 	} else if (command == "sys") {
 #ifdef ESP32
 		print("Chip: %s\n", ESP.getChipModel());
 		print("Temperature: %.1f °C\n", temperatureRead());
-		print("Free heap: %d\n", ESP.getFreeHeap());
+		print("Total RAM: %d KB\n", ESP.getHeapSize() / 1024);
+		print("Free heap: %d KB\n", ESP.getFreeHeap() / 1024);
+		print("PSRAM: %d KB\n", ESP.getPsramSize() / 1024);
+		print("Free PSRAM: %d KB\n", ESP.getFreePsram() / 1024);
+#ifdef VERSION
+		print("Version: %s\n", STRINGIFY(VERSION));
+#endif
+		print("Build date: " __DATE__ " " __TIME__ "\n");
 		// Print tasks table
-		print("Num  Task                Stack  Prio  Core  CPU%%\n");
+		print("Num  Task                MinSt  Prio  Core  CPU%%\n");
 		int taskCount = uxTaskGetNumberOfTasks();
 		TaskStatus_t *systemState = new TaskStatus_t[taskCount];
 		uint32_t totalRunTime;
@@ -149,16 +205,15 @@ void doCommand(String str, bool echo = false) {
 			String core = systemState[i].xCoreID == tskNO_AFFINITY ? "*" : String(systemState[i].xCoreID);
 			int cpuPercentage = systemState[i].ulRunTimeCounter / (totalRunTime / 100);
 			print("%-5d%-20s%-7d%-6d%-6s%d\n",systemState[i].xTaskNumber, systemState[i].pcTaskName,
-				systemState[i].usStackHighWaterMark, systemState[i].uxCurrentPriority, core, cpuPercentage);
+				systemState[i].usStackHighWaterMark, systemState[i].uxCurrentPriority, core.c_str(), cpuPercentage);
 		}
 		delete[] systemState;
 #endif
 	} else if (command == "reset") {
 		attitude = Quaternion();
+		gyroBiasFilter.reset();
 	} else if (command == "reboot") {
 		ESP.restart();
-	} else if (command == "") {
-		// do nothing
 	} else {
 		print("Invalid command: %s\n", command.c_str());
 	}
@@ -175,7 +230,7 @@ void handleInput() {
 
 	while (Serial.available()) {
 		char c = Serial.read();
-		if (c == '\n') {
+		if (c == '\n' || c == '\r') {
 			doCommand(input);
 			input.clear();
 		} else {

flix/config.h

@@ -0,0 +1,27 @@
+// Copyright (c) 2026 Oleg Kalachev <okalachev@gmail.com>
+// Repository: https://github.com/okalachev/flix
+
+// Parameter defaults
+
+#pragma once
+
+void setDefaults() {
+	// Set defaults here
+
+	#if defined(CONFIG_IDF_TARGET_ESP32S3) || defined(CONFIG_IDF_TARGET_ESP32C3)
+		pwmFrequency = 38000;
+	#endif
+
+	#ifdef FLIX2
+		imuModel = 4; // ICM-40609-D
+		imuIntPin = 10;
+		imuCsPin = 14;
+
+		motorPins[MOTOR_REAR_LEFT] = 41;
+		motorPins[MOTOR_REAR_RIGHT] = 7;
+		motorPins[MOTOR_FRONT_RIGHT] = 18;
+		motorPins[MOTOR_FRONT_LEFT] = 38;
+
+		voltagePin = 3;
+	#endif
+}

flix/control.ino

@@ -6,118 +6,77 @@
 #include "vector.h"
 #include "quaternion.h"
 #include "pid.h"
-#include "lpf.h"
+#include "filter.h"
 #include "util.h"
 
-#define PITCHRATE_P 0.05
+const int RAW = 0, ACRO = 1, STAB = 2, AUTO = 3; // flight modes
-#define PITCHRATE_I 0.2
+int mode = STAB;
-#define PITCHRATE_D 0.001
-#define PITCHRATE_I_LIM 0.3
-#define ROLLRATE_P PITCHRATE_P
-#define ROLLRATE_I PITCHRATE_I
-#define ROLLRATE_D PITCHRATE_D
-#define ROLLRATE_I_LIM PITCHRATE_I_LIM
-#define YAWRATE_P 0.3
-#define YAWRATE_I 0.0
-#define YAWRATE_D 0.0
-#define YAWRATE_I_LIM 0.3
-#define ROLL_P 6
-#define ROLL_I 0
-#define ROLL_D 0
-#define PITCH_P ROLL_P
-#define PITCH_I ROLL_I
-#define PITCH_D ROLL_D
-#define YAW_P 3
-#define PITCHRATE_MAX radians(360)
-#define ROLLRATE_MAX radians(360)
-#define YAWRATE_MAX radians(300)
-#define TILT_MAX radians(30)
-#define RATES_D_LPF_ALPHA 0.2 // cutoff frequency ~ 40 Hz
-
-enum { MANUAL, ACRO, STAB, USER } mode = STAB;
-enum { YAW, YAW_RATE } yawMode = YAW;
 bool armed = false;
 
-PID rollRatePID(ROLLRATE_P, ROLLRATE_I, ROLLRATE_D, ROLLRATE_I_LIM, RATES_D_LPF_ALPHA);
-PID pitchRatePID(PITCHRATE_P, PITCHRATE_I, PITCHRATE_D, PITCHRATE_I_LIM, RATES_D_LPF_ALPHA);
-PID yawRatePID(YAWRATE_P, YAWRATE_I, YAWRATE_D);
-PID rollPID(ROLL_P, ROLL_I, ROLL_D);
-PID pitchPID(PITCH_P, PITCH_I, PITCH_D);
-PID yawPID(YAW_P, 0, 0);
-Vector maxRate(ROLLRATE_MAX, PITCHRATE_MAX, YAWRATE_MAX);
-float tiltMax = TILT_MAX;
-
 Quaternion attitudeTarget;
 Vector ratesTarget;
-Vector torqueTarget;
+Vector ratesExtra; // feedforward rates
+Vector torqueTarget; // 0 - no torque, 1 - maximum torque
 float thrustTarget;
 
+PID rollRatePID(0.05, 0.2, 0.001, 0.3, 0.2);
+PID pitchRatePID(0.05, 0.2, 0.001, 0.3, 0.2);
+PID yawRatePID(0.3, 0, 0, 0.3);
+PID rollPID(6);
+PID pitchPID(6);
+PID yawPID(3);
+Vector maxRate(radians(360), radians(360), radians(360));
+float tiltMax = radians(30);
+int flightModes[] = {STAB, STAB, STAB}; // map for rc mode switch
+
 extern const int MOTOR_REAR_LEFT, MOTOR_REAR_RIGHT, MOTOR_FRONT_RIGHT, MOTOR_FRONT_LEFT;
-extern float controlRoll, controlPitch, controlThrottle, controlYaw, controlArmed, controlMode;
+extern float controlRoll, controlPitch, controlThrottle, controlYaw, controlMode;
 
 void control() {
-	interpretRC();
+	interpretControls();
 	failsafe();
-	if (mode == STAB) {
+	controlAttitude();
-		controlAttitude();
+	controlRates();
-		controlRate();
+	controlTorque();
-		controlTorque();
-	} else if (mode == ACRO) {
-		controlRate();
-		controlTorque();
-	} else if (mode == MANUAL) {
-		controlTorque();
-	}
 }
 
-void interpretRC() {
+void interpretControls() {
-	armed = controlThrottle >= 0.05 && controlArmed >= 0.5;
+	if (controlMode < 0.25) mode = flightModes[0];
+	else if (controlMode <= 0.75) mode = flightModes[1];
+	else if (controlMode > 0.75) mode = flightModes[2];
 
-	// NOTE: put ACRO or MANUAL modes there if you want to use them
+	if (mode == AUTO) return; // pilot is not effective in AUTO mode
-	if (controlMode < 0.25) {
+
-		mode = STAB;
+	if (controlThrottle < 0.05 && controlYaw > 0.95) armed = true; // arm gesture
-	} else if (controlMode < 0.75) {
+	if (controlThrottle < 0.05 && controlYaw < -0.95) armed = false; // disarm gesture
-		mode = STAB;
+
-	} else {
+	if (abs(controlYaw) < 0.1) controlYaw = 0; // yaw dead zone
-		mode = STAB;
-	}
 
 	thrustTarget = controlThrottle;
 
-	if (mode == ACRO) {
+	if (mode == STAB) {
-		yawMode = YAW_RATE;
+		float yawTarget = attitudeTarget.getYaw();
-		ratesTarget.x = controlRoll * maxRate.x;
+		if (!armed || invalid(yawTarget) || controlYaw != 0) yawTarget = attitude.getYaw(); // reset yaw target
-		ratesTarget.y = controlPitch* maxRate.y;
+		attitudeTarget = Quaternion::fromEuler(Vector(controlRoll * tiltMax, controlPitch * tiltMax, yawTarget));
-		ratesTarget.z = -controlYaw * maxRate.z; // positive yaw stick means clockwise rotation in FLU
+		ratesExtra = Vector(0, 0, -controlYaw * maxRate.z); // positive yaw stick means clockwise rotation in FLU
-
-	} else if (mode == STAB) {
-		yawMode = controlYaw == 0 ? YAW : YAW_RATE;
-
-		attitudeTarget = Quaternion::fromEuler(Vector(
-			controlRoll * tiltMax,
-			controlPitch * tiltMax,
-			attitudeTarget.getYaw()));
-		ratesTarget.z = -controlYaw * maxRate.z; // positive yaw stick means clockwise rotation in FLU
-
-	} else if (mode == MANUAL) {
-		// passthrough mode
-		yawMode = YAW_RATE;
-		torqueTarget = Vector(controlRoll, controlPitch, -controlYaw) * 0.01;
 	}
 
-	if (yawMode == YAW_RATE || !motorsActive()) {
+	if (mode == ACRO) {
-		// update yaw target as we don't have control over the yaw
+		attitudeTarget.invalidate(); // skip attitude control
-		attitudeTarget.setYaw(attitude.getYaw());
+		ratesTarget.x = controlRoll * maxRate.x;
+		ratesTarget.y = controlPitch * maxRate.y;
+		ratesTarget.z = -controlYaw * maxRate.z; // positive yaw stick means clockwise rotation in FLU
+	}
+
+	if (mode == RAW) { // direct torque control
+		attitudeTarget.invalidate(); // skip attitude control
+		ratesTarget.invalidate(); // skip rate control
+		torqueTarget = Vector(controlRoll, controlPitch, -controlYaw) * 0.1;
 	}
 }
 
 void controlAttitude() {
-	if (!armed) {
+	if (!armed || attitudeTarget.invalid() || thrustTarget < 0.1) return; // skip attitude control
-		rollPID.reset();
-		pitchPID.reset();
-		yawPID.reset();
-		return;
-	}
 
 	const Vector up(0, 0, 1);
 	Vector upActual = Quaternion::rotateVector(up, attitude);
@@ -125,34 +84,38 @@ void controlAttitude() {
 
 	Vector error = Vector::rotationVectorBetween(upTarget, upActual);
 
-	ratesTarget.x = rollPID.update(error.x, dt);
+	ratesTarget.x = rollPID.update(error.x) + ratesExtra.x;
-	ratesTarget.y = pitchPID.update(error.y, dt);
+	ratesTarget.y = pitchPID.update(error.y) + ratesExtra.y;
 
-	if (yawMode == YAW) {
+	float yawError = wrapAngle(attitudeTarget.getYaw() - attitude.getYaw());
-		float yawError = wrapAngle(attitudeTarget.getYaw() - attitude.getYaw());
+	ratesTarget.z = yawPID.update(yawError) + ratesExtra.z;
-		ratesTarget.z = yawPID.update(yawError, dt);
-	}
 }
 
-void controlRate() {
+
-	if (!armed) {
+void controlRates() {
-		rollRatePID.reset();
+	if (!armed || ratesTarget.invalid() || thrustTarget < 0.1) return; // skip rates control
-		pitchRatePID.reset();
-		yawRatePID.reset();
-		return;
-	}
 
 	Vector error = ratesTarget - rates;
 
 	// Calculate desired torque, where 0 - no torque, 1 - maximum possible torque
-	torqueTarget.x = rollRatePID.update(error.x, dt);
+	torqueTarget.x = rollRatePID.update(error.x);
-	torqueTarget.y = pitchRatePID.update(error.y, dt);
+	torqueTarget.y = pitchRatePID.update(error.y);
-	torqueTarget.z = yawRatePID.update(error.z, dt);
+	torqueTarget.z = yawRatePID.update(error.z);
 }
 
 void controlTorque() {
+	if (!torqueTarget.valid()) return; // skip torque control
+
 	if (!armed) {
-		memset(motors, 0, sizeof(motors));
+		memset(motors, 0, sizeof(motors)); // stop motors if disarmed
+		return;
+	}
+
+	if (thrustTarget < 0.1) {
+		motors[0] = 0.1; // idle thrust
+		motors[1] = 0.1;
+		motors[2] = 0.1;
+		motors[3] = 0.1;
 		return;
 	}
 
@@ -161,18 +124,32 @@ void controlTorque() {
 	motors[MOTOR_REAR_LEFT] = thrustTarget + torqueTarget.x + torqueTarget.y - torqueTarget.z;
 	motors[MOTOR_REAR_RIGHT] = thrustTarget - torqueTarget.x + torqueTarget.y + torqueTarget.z;
 
+	// Prioritize angle control over thrust control
+	desaturate(motors[MOTOR_FRONT_LEFT], motors[MOTOR_FRONT_RIGHT], motors[MOTOR_REAR_LEFT], motors[MOTOR_REAR_RIGHT]);
+
 	motors[0] = constrain(motors[0], 0, 1);
 	motors[1] = constrain(motors[1], 0, 1);
 	motors[2] = constrain(motors[2], 0, 1);
 	motors[3] = constrain(motors[3], 0, 1);
 }
 
+void desaturate(float& a, float& b, float& c, float& d) {
+	float maxThrust = max(max(a, b), max(c, d));
+	if (maxThrust > 1) {
+		float diff = maxThrust - 1;
+		a -= diff;
+		b -= diff;
+		c -= diff;
+		d -= diff;
+	}
+}
+
 const char* getModeName() {
 	switch (mode) {
-		case MANUAL: return "MANUAL";
+		case RAW: return "RAW";
 		case ACRO: return "ACRO";
 		case STAB: return "STAB";
-		case USER: return "USER";
+		case AUTO: return "AUTO";
 		default: return "UNKNOWN";
 	}
 }

flix/estimate.ino

@@ -1,26 +1,37 @@
 // Copyright (c) 2023 Oleg Kalachev <okalachev@gmail.com>
 // Repository: https://github.com/okalachev/flix
 
-// Attitude estimation from gyro and accelerometer
+// Attitude estimation using gyro and accelerometer
 
 #include "quaternion.h"
 #include "vector.h"
-#include "lpf.h"
+#include "filter.h"
 #include "util.h"
 
-#define WEIGHT_ACC 0.003
+Vector rates; // estimated angular rates, rad/s
-#define RATES_LFP_ALPHA 0.2 // cutoff frequency ~ 40 Hz
+Quaternion attitude; // estimated attitude
+bool landed;
 
-LowPassFilter<Vector> ratesFilter(RATES_LFP_ALPHA);
+float accWeight = 0.003;
+float levelWeight = 0.0002;
+LowPassFilter<Vector> ratesFilter(0.2); // cutoff frequency ~ 40 Hz
+NotchFilter<Vector> ratesNotch(382, 40);
+
+void setupEstimate() {
+	print("Setup estimation\n");
+	ratesNotch.reset();
+}
 
 void estimate() {
 	applyGyro();
 	applyAcc();
+	applyLevel();
 }
 
 void applyGyro() {
 	// filter gyro to get angular rates
 	rates = ratesFilter.update(gyro);
+	rates = ratesNotch.update(rates);
 
 	// apply rates to attitude
 	attitude = Quaternion::rotate(attitude, Quaternion::fromRotationVector(rates * dt));
@@ -28,15 +39,24 @@ void applyGyro() {
 
 void applyAcc() {
 	// test should we apply accelerometer gravity correction
-	float accNorm = acc.norm();
+	landed = !motorsActive() && abs(acc.norm() - ONE_G) < ONE_G * 0.1f;
-	landed = !motorsActive() && abs(accNorm - ONE_G) < ONE_G * 0.1f;
 
 	if (!landed) return;
 
 	// calculate accelerometer correction
 	Vector up = Quaternion::rotateVector(Vector(0, 0, 1), attitude);
-	Vector correction = Vector::rotationVectorBetween(acc, up) * WEIGHT_ACC;
+	Vector correction = Vector::rotationVectorBetween(acc, up) * accWeight;
 
 	// apply correction
 	attitude = Quaternion::rotate(attitude, Quaternion::fromRotationVector(correction));
 }
+
+void applyLevel() {
+	if (landed) return;
+	if (thrustTarget < 0.1) return; // skip at idle thrust
+
+	// assume the pilot keeps the drone more or less level in flight
+	Vector up = Quaternion::rotateVector(Vector(0, 0, 1), attitude);
+	Vector correction = Vector::rotationVectorBetween(Vector(0, 0, 1), up) * levelWeight;
+	attitude = Quaternion::rotate(attitude, Quaternion::fromRotationVector(correction));
+}

flix/failsafe.ino

@@ -1,41 +0,0 @@
-// Copyright (c) 2024 Oleg Kalachev <okalachev@gmail.com>
-// Repository: https://github.com/okalachev/flix
-
-// Fail-safe functions
-
-#define RC_LOSS_TIMEOUT 0.2
-#define DESCEND_TIME 3.0 // time to descend from full throttle to zero
-
-extern double controlTime;
-extern float controlRoll, controlPitch, controlThrottle, controlYaw;
-
-void failsafe() {
-	armingFailsafe();
-	rcLossFailsafe();
-}
-
-// Prevent arming without zero throttle input
-void armingFailsafe() {
-	static double zeroThrottleTime;
-	static double armingTime;
-	if (!armed) armingTime = t; // stores the last time when the drone was disarmed, therefore contains arming time
-	if (controlTime > 0 && controlThrottle < 0.05) zeroThrottleTime = controlTime;
-	if (armingTime - zeroThrottleTime > 0.1) armed = false; // prevent arming if there was no zero throttle for 0.1 sec
-}
-
-// RC loss failsafe
-void rcLossFailsafe() {
-	if (t - controlTime > RC_LOSS_TIMEOUT) {
-		descend();
-	}
-}
-
-// Smooth descend on RC lost
-void descend() {
-	mode = STAB;
-	controlRoll = 0;
-	controlPitch = 0;
-	controlYaw = 0;
-	controlThrottle -= dt / DESCEND_TIME;
-	if (controlThrottle < 0) controlThrottle = 0;
-}

flix/filter.h

@@ -0,0 +1,98 @@
+// Copyright (c) 2023 Oleg Kalachev <okalachev@gmail.com>
+// Repository: https://github.com/okalachev/flix
+
+// Low pass and notch filters
+
+#pragma once
+
+template <typename T> // Using template to make the filter usable for scalar and vector values
+class LowPassFilter {
+public:
+	float alpha; // smoothing constant, 1 means filter disabled
+	T output;
+
+	LowPassFilter(float alpha): alpha(alpha) {};
+
+	T update(const T input) {
+		if (!init) {
+			init = true;
+			return output = input;
+		}
+		return output += alpha * (input - output);
+	}
+
+	void setCutOffFrequency(float cutOffFreq, float dt) {
+		alpha = 1 - exp(-2 * PI * cutOffFreq * dt);
+	}
+
+	void reset() {
+		init = false;
+	}
+
+private:
+	bool init = false;
+};
+
+template <typename T>
+class NotchFilter {
+public:
+	float frequency;
+	float bandwidth;
+	T output;
+
+	NotchFilter(float frequency, float bandwidth): frequency(frequency), bandwidth(bandwidth) {
+		reset();
+	};
+
+	T update(const T input) {
+		if (frequency <= 0 || bandwidth <= 0) return input;
+
+		if (!init) {
+			init = true;
+			x1 = x2 = input;
+			y1 = y2 = input;
+			return output = input;
+		}
+
+		output = b0 * input + b1 * x1 + b2 * x2 - a1 * y1 - a2 * y2;
+
+		x2 = x1;
+		x1 = input;
+		y2 = y1;
+		y1 = output;
+
+		return output;
+	}
+
+	void reset() {
+		const float dt = 0.001f;
+		float f = frequency;
+		float bw = bandwidth;
+		if (f < 0) f = 0;
+		if (bw < 1e-6f) bw = 1e-6f;
+
+		float q = f / bw;
+		if (q < 1e-3f) q = 1e-3f;
+
+		const float w0 = 2.0f * PI * f * dt;
+		const float c = cos(w0);
+		const float s = sin(w0);
+		const float alpha = s / (2.0f * q);
+
+		const float a0 = 1.0f + alpha;
+		const float invA0 = 1.0f / a0;
+
+		b0 = 1.0f * invA0;
+		b1 = -2.0f * c * invA0;
+		b2 = 1.0f * invA0;
+		a1 = -2.0f * c * invA0;
+		a2 = (1.0f - alpha) * invA0;
+
+		init = false;
+	}
+
+private:
+	float b0, b1, b2, a1, a2;
+	T x1, x2, y1, y2;
+	bool init = false;
+};

flix/flix.ino

@@ -7,32 +7,27 @@
 #include "quaternion.h"
 #include "util.h"
 
-#define SERIAL_BAUDRATE 115200
+extern float t, dt;
-#define WIFI_ENABLED 1
+extern float controlRoll, controlPitch, controlYaw, controlThrottle, controlMode;
-
+extern Vector gyro, acc;
-double t = NAN; // current step time, s
+extern Vector rates;
-float dt; // time delta from previous step, s
+extern Quaternion attitude;
-float controlRoll, controlPitch, controlYaw, controlThrottle, controlArmed, controlMode; // pilot's inputs, range [-1, 1]
+extern bool landed;
-Vector gyro; // gyroscope data
+extern float motors[4];
-Vector acc; // accelerometer data, m/s/s
-Vector rates; // filtered angular rates, rad/s
-Quaternion attitude; // estimated attitude
-bool landed; // are we landed and stationary
-float motors[4]; // normalized motors thrust in range [0..1]
 
 void setup() {
-	Serial.begin(SERIAL_BAUDRATE);
+	Serial.begin(115200);
-	print("Initializing flix\n");
+	print("Initializing Flix\n");
-	disableBrownOut();
 	setupParameters();
+	setupPower();
 	setupLED();
-	setupMotors();
 	setLED(true);
-#if WIFI_ENABLED
+	setupMotors();
 	setupWiFi();
-#endif
 	setupIMU();
 	setupRC();
+	setupEstimate();
+	setupLog();
 	setLED(false);
 	print("Initializing complete\n");
 }
@@ -45,9 +40,8 @@ void loop() {
 	control();
 	sendMotors();
 	handleInput();
-#if WIFI_ENABLED
 	processMavlink();
-#endif
+	readVoltage();
-	logData();
+	loopLog();
 	syncParameters();
 }

flix/imu.ino

@@ -4,62 +4,81 @@
 // Work with the IMU sensor
 
 #include <SPI.h>
-#include <MPU9250.h>
+#include <Wire.h>
-#include "lpf.h"
+#include <FlixPeriph.h>
+#include "vector.h"
+#include "filter.h"
 #include "util.h"
 
-MPU9250 IMU(SPI);
+IMU *imu;
+int imuModel = -1; // 1 - MPU9250, 2 - ICM20948, 3 - MPU6050, 4 - ICM40609D
+int imuBus = 0; // 0 - SPI, 1 - I2C
+int imuSckPin = SCK, imuMisoPin = MISO, imuMosiPin = MOSI, imuCsPin = SS, imuIntPin = -1;
+int imuSdaPin = SDA, imuSclPin = SCL;
+Vector imuRotation(0, 0, PI / 2); // imu orientation as Euler angles
 
+Vector gyro; // gyroscope output, rad/s
+Vector gyroBias;
+
+Vector acc; // accelerometer output, m/s/s
 Vector accBias;
 Vector accScale(1, 1, 1);
-Vector gyroBias;
+
+LowPassFilter<Vector> gyroBiasFilter(0.001);
 
 void setupIMU() {
 	print("Setup IMU\n");
-	IMU.begin();
+	free(imu);
+	if (imuModel == 3) imuBus = 1; // MPU6050 is I2C only
+
+	if (imuBus == 0) {
+		// SPI connection
+		SPI.begin(imuSckPin, imuMisoPin, imuMosiPin);
+		imu = IMU::create(imuModel, SPI, imuCsPin, imuIntPin);
+	} else {
+		// I2C connection
+		Wire.setPins(imuSdaPin, imuSclPin);
+		imu = IMU::create(imuModel, Wire, imuIntPin);
+	}
+
+	imu->begin();
 	configureIMU();
 }
 
 void configureIMU() {
-	IMU.setAccelRange(IMU.ACCEL_RANGE_4G);
+	imu->setAccelRange(IMU::ACCEL_RANGE_4G);
-	IMU.setGyroRange(IMU.GYRO_RANGE_2000DPS);
+	imu->setGyroRange(IMU::GYRO_RANGE_2000DPS);
-	IMU.setDLPF(IMU.DLPF_MAX);
+	imu->setDLPF(IMU::DLPF_MAX);
-	IMU.setRate(IMU.RATE_1KHZ_APPROX);
+	imu->setRate(IMU::RATE_1KHZ_APPROX);
-	IMU.setupInterrupt();
+	imu->setupInterrupt();
 }
 
 void readIMU() {
-	IMU.waitForData();
+	imu->waitForData();
-	IMU.getGyro(gyro.x, gyro.y, gyro.z);
+	imu->getGyro(gyro.x, gyro.y, gyro.z);
-	IMU.getAccel(acc.x, acc.y, acc.z);
+	imu->getAccel(acc.x, acc.y, acc.z);
 	calibrateGyroOnce();
-	// apply scale and bias
+
+	// Apply scale and bias
 	acc = (acc - accBias) / accScale;
 	gyro = gyro - gyroBias;
-	// rotate
-	rotateIMU(acc);
-	rotateIMU(gyro);
-}
 
-void rotateIMU(Vector& data) {
+	// Rotate to body frame
-	// Rotate from LFD to FLU
+	Quaternion rotation = Quaternion::fromEuler(imuRotation);
-	// NOTE: In case of using other IMU orientation, change this line:
+	acc = Quaternion::rotateVector(acc, rotation.inversed());
-	data = Vector(data.y, data.x, -data.z);
+	gyro = Quaternion::rotateVector(gyro, rotation.inversed());
-	// Axes orientation for various boards: https://github.com/okalachev/flixperiph#imu-axes-orientation
 }
 
 void calibrateGyroOnce() {
-	static float landedTime = 0;
+	static Delay landedDelay(2);
-	landedTime = landed ? landedTime + dt : 0;
+	if (!landedDelay.update(landed)) return; // calibrate only if definitely stationary
-	if (landedTime < 2) return; // calibrate only if definitely stationary
 
-	static LowPassFilter<Vector> gyroCalibrationFilter(0.001);
+	gyroBias = gyroBiasFilter.update(gyro);
-	gyroBias = gyroCalibrationFilter.update(gyro);
 }
 
 void calibrateAccel() {
 	print("Calibrating accelerometer\n");
-	IMU.setAccelRange(IMU.ACCEL_RANGE_2G); // the most sensitive mode
+	imu->setAccelRange(IMU::ACCEL_RANGE_2G); // the most sensitive mode
 
 	print("1/6 Place level [8 sec]\n");
 	pause(8);
@@ -93,9 +112,9 @@ void calibrateAccelOnce() {
 	// Compute the average of the accelerometer readings
 	acc = Vector(0, 0, 0);
 	for (int i = 0; i < samples; i++) {
-		IMU.waitForData();
+		imu->waitForData();
 		Vector sample;
-		IMU.getAccel(sample.x, sample.y, sample.z);
+		imu->getAccel(sample.x, sample.y, sample.z);
 		acc = acc + sample;
 	}
 	acc = acc / samples;
@@ -107,6 +126,7 @@ void calibrateAccelOnce() {
 	if (acc.x < accMin.x) accMin.x = acc.x;
 	if (acc.y < accMin.y) accMin.y = acc.y;
 	if (acc.z < accMin.z) accMin.z = acc.z;
+
 	// Compute scale and bias
 	accScale = (accMax - accMin) / 2 / ONE_G;
 	accBias = (accMax + accMin) / 2;
@@ -119,7 +139,18 @@ void printIMUCalibration() {
 }
 
 void printIMUInfo() {
-	IMU.status() ? print("status: ERROR %d\n", IMU.status()) : print("status: OK\n");
+	imu->status() ? print("status: ERROR %d\n", imu->status()) : print("status: OK\n");
-	print("model: %s\n", IMU.getModel());
+	print("model: %s\n", imu->getModel());
-	print("who am I: 0x%02X\n", IMU.whoAmI());
+	print("who am I: 0x%02X\n", imu->whoAmI());
+	print("rate: %.0f\n", loopRate);
+	print("interrupt mode: %s\n", imuIntPin != -1 ? "pin" : "timer");
+	print("temperature: %.1f °C\n", imu->getTemp());
+	print("gyro: %f %f %f\n", gyro.x, gyro.y, gyro.z);
+	print("acc: %f %f %f\n", acc.x, acc.y, acc.z);
+	imu->waitForData();
+	Vector rawGyro, rawAcc;
+	imu->getGyro(rawGyro.x, rawGyro.y, rawGyro.z);
+	imu->getAccel(rawAcc.x, rawAcc.y, rawAcc.z);
+	print("raw gyro: %f %f %f\n", rawGyro.x, rawGyro.y, rawGyro.z);
+	print("raw acc: %f %f %f\n", rawAcc.x, rawAcc.y, rawAcc.z);
 }

flix/log.ino

@@ -1,79 +1,272 @@
 // Copyright (c) 2023 Oleg Kalachev <okalachev@gmail.com>
 // Repository: https://github.com/okalachev/flix
 
-// In-RAM logging
+// Logging subsystem
 
 #include "vector.h"
+#include "util.h"
 
-#define LOG_RATE 100
+int logMemory = 0; // 0 - RAM, 1 - PSRAM, -1 - disabled
-#define LOG_DURATION 10
+float logUsage = 0.5; // fraction of free memory to use for log
-#define LOG_PERIOD 1.0 / LOG_RATE
-#define LOG_SIZE LOG_DURATION * LOG_RATE
 
-float tFloat;
+struct LogValue {
-Vector attitudeEuler;
-Vector attitudeTargetEuler;
-
-struct LogEntry {
 	const char *name;
-	float *value;
+	Value value;
+	float lastValue = NAN;
+	bool logged = true; // if false, use only for triggering log update
+	LogValue() : name(nullptr), value() {}; // empty value constructor
+	template <typename T>
+	LogValue(const char *name, T value, bool logged = true) : name(name), value(value), logged(logged) {};
 };
 
-LogEntry logEntries[] = {
+struct LogTopic {
-	{"t", &tFloat},
+	LogValue values[10];
-	{"rates.x", &rates.x},
+	int length = 0; // number of logged values
-	{"rates.y", &rates.y},
+	float throttle; // max update rate, Hz
-	{"rates.z", &rates.z},
+	float lastUpdate = -INFINITY;
-	{"ratesTarget.x", &ratesTarget.x},
+
-	{"ratesTarget.y", &ratesTarget.y},
+	LogTopic(float throttle, LogValue v0, LogValue v1 = {}, LogValue v2 = {}, LogValue v3 = {}, LogValue v4 = {}, LogValue v5 = {}, LogValue v6 = {}, LogValue v7 = {}, LogValue v8 = {}, LogValue v9 = {}) :
-	{"ratesTarget.z", &ratesTarget.z},
+		throttle(throttle), values{v0, v1, v2, v3, v4, v5, v6, v7, v8, v9} {
-	{"attitude.x", &attitudeEuler.x},
+			// Count logged values
-	{"attitude.y", &attitudeEuler.y},
+			for (auto& v : values) {
-	{"attitude.z", &attitudeEuler.z},
+				if (v.name == nullptr) break;
-	{"attitudeTarget.x", &attitudeTargetEuler.x},
+				if (v.logged) length++;
-	{"attitudeTarget.y", &attitudeTargetEuler.y},
+			}
-	{"attitudeTarget.z", &attitudeTargetEuler.z},
+		};
-	{"thrustTarget", &thrustTarget}
+
+	LogTopic(LogValue v0, LogValue v1 = {}, LogValue v2 = {}, LogValue v3 = {}, LogValue v4 = {}, LogValue v5 = {}, LogValue v6 = {}, LogValue v7 = {}, LogValue v8 = {}, LogValue v9 = {}) :
+		LogTopic(INFINITY, v0, v1, v2, v3, v4, v5, v6, v7, v8, v9) {};
 };
 
-const int logColumns = sizeof(logEntries) / sizeof(logEntries[0]);
+LogTopic logTopics[] = {
-float logBuffer[LOG_SIZE][logColumns];
+	// time
+	LogTopic({"t", &t}), // must be the first topic
+	LogTopic(1, {"loopRate", &loopRate}),
 
-void prepareLogData() {
+	// imu
-	tFloat = t;
+	LogTopic(
-	attitudeEuler = attitude.toEuler();
+		{"gyro.x", &gyro.x},
-	attitudeTargetEuler = attitudeTarget.toEuler();
+		{"gyro.y", &gyro.y},
-}
+		{"gyro.z", &gyro.z}),
 
-void logData() {
+	LogTopic(50,
-	if (!armed) return;
+		{"acc.x", &acc.x},
-	static int logPointer = 0;
+		{"acc.y", &acc.y},
-	static double logTime = 0;
+		{"acc.z", &acc.z}),
-	if (t - logTime < LOG_PERIOD) return;
-	logTime = t;
 
-	prepareLogData();
+	LogTopic(10,
+		{"gyroBias.x", &gyroBias.x},
+		{"gyroBias.y", &gyroBias.y},
+		{"gyroBias.z", &gyroBias.z}),
 
-	for (int i = 0; i < logColumns; i++) {
+	// estimation
-		logBuffer[logPointer][i] = *logEntries[i].value;
+	LogTopic(50,
-	}
+		{"rates.x", &rates.x},
+		{"rates.y", &rates.y},
+		{"rates.z", &rates.z},
+		{"attitude.roll", []() { return attitude.getRoll(); }},
+		{"attitude.pitch", []() { return attitude.getPitch(); }},
+		{"attitude.yaw", []() { return attitude.getYaw(); }}),
 
-	logPointer++;
+	// rc
-	if (logPointer >= LOG_SIZE) {
+	LogTopic(10,
-		logPointer = 0;
+		{"controlTime", &controlTime, false}, // trigger value
+		{"controlRoll", &controlRoll},
+		{"controlPitch", &controlPitch},
+		{"controlYaw", &controlYaw},
+		{"controlThrottle", &controlThrottle}),
+
+	// control
+	LogTopic({"armed", &armed}),
+	LogTopic({"mode", &mode}),
+
+	LogTopic(10,
+		{"ratesTarget.x", &ratesTarget.x},
+		{"ratesTarget.y", &ratesTarget.y},
+		{"ratesTarget.z", &ratesTarget.z},
+		{"attitudeTarget.roll", []() { return attitudeTarget.getRoll(); }},
+		{"attitudeTarget.pitch", []() { return attitudeTarget.getPitch(); }},
+		{"attitudeTarget.yaw", []() { return attitudeTarget.getYaw(); }},
+		{"thrustTarget", &thrustTarget}),
+
+	// motors
+	LogTopic(
+		{"motors[0]", &motors[0]},
+		{"motors[1]", &motors[1]},
+		{"motors[2]", &motors[2]},
+		{"motors[3]", &motors[3]}),
+
+	// misc
+	LogTopic(5,
+		{"voltage", &voltage},
+		{"temp", &temperatureRead},
+		{"imuTemp", []() { return imu->getTemp(); }}),
+};
+
+void *logBuffer; // buffer for log data
+size_t logCapacity;
+size_t logCursor = 0;
+size_t logLength = 0;
+LogValue *logExposed = nullptr; // log values exposed to telemetry
+
+void setupLog() {
+	print("Setup log\n");
+
+	free(logBuffer); // when reconfiguring
+	logBuffer = nullptr;
+	logCursor = 0;
+	logLength = 0;
+
+	if (logMemory == 0) {
+		logCapacity = ESP.getFreeHeap() * logUsage;
+		logBuffer = (uint8_t *)calloc(logCapacity, 1);
+	} else if (logMemory == 1) {
+		logCapacity = ESP.getFreePsram() * logUsage;
+		logBuffer = (uint8_t *)heap_caps_calloc(logCapacity, 1, MALLOC_CAP_SPIRAM | MALLOC_CAP_8BIT);
 	}
 }
 
-void dumpLog() {
+void loopLog() {
-	// Print header
+	if (logBuffer == nullptr || !armed) return;
-	for (int i = 0; i < logColumns; i++) {
+
-		print("%s%s", logEntries[i].name, i < logColumns - 1 ? "," : "\n");
+	if (!logLength) resetLog(); // reset state on first log write
+
+	static Rate sync(2);
+	if (sync) {
+		const uint8_t marker[] = {0x1A, 0x91, 0x4F, 0xF6, 0x7F};
+		writeLog(&marker, sizeof(marker)); // write sync marker
 	}
-	// Print data
+
-	for (int i = 0; i < LOG_SIZE; i++) {
+	for (uint8_t i = 0; i < sizeof(logTopics) / sizeof(logTopics[0]); i++) {
-		if (logBuffer[i][0] == 0) continue; // skip empty records
+		LogTopic& topic = logTopics[i];
-		for (int j = 0; j < logColumns; j++) {
+		if (t - topic.lastUpdate < 1 / topic.throttle) continue; // throttle topic
-			print("%g%s", logBuffer[i][j], j < logColumns - 1 ? "," : "\n");
+		if (!isTopicUpdated(i)) continue; // skip if topic was't updated
+
+		topic.lastUpdate = t;
+		writeLog(&i, sizeof(i)); // write topic index
+
+		for (auto& value : topic.values) {
+			if (value.name == nullptr) break;
+			if (!value.logged) continue;
+			value.lastValue = value.value.get();
+			writeLog(&value.lastValue, sizeof(float)); // write value
 		}
 	}
 }
+
+void resetLog() {
+	for (auto& topic : logTopics) {
+		topic.lastUpdate = -INFINITY;
+		for (auto& value : topic.values) {
+			value.lastValue = NAN;
+		}
+	}
+	logCursor = 0;
+	logLength = 0;
+}
+
+void writeLog(const void *data, size_t size) {
+	size_t first = min(size, logCapacity - logCursor);
+	size_t second = size - first;
+	memcpy(logBuffer + logCursor, data, first);
+	logCursor = (logCursor + first) % logCapacity;
+	if (second > 0) {
+		memcpy(logBuffer + logCursor, data + first, second);
+		logCursor = (logCursor + second) % logCapacity;
+	}
+	logLength = min(logLength + size, logCapacity);
+}
+
+void readLog(void *data, size_t position, size_t size) {
+	if (logLength == logCapacity) {
+		position = (logCursor + position) % logCapacity;
+	}
+	size_t first = min(size, logCapacity - position);
+	size_t second = size - first;
+	memcpy(data, logBuffer + position, first);
+	if (second > 0) {
+		memcpy(data + first, logBuffer, second);
+	}
+}
+
+bool isTopicUpdated(const uint8_t topic) {
+	LogTopic& logTopic = logTopics[topic];
+	bool updated = false;
+
+	for (auto& value : logTopic.values) {
+		if (value.name == nullptr) break;
+		float v = value.value.get();
+		if (!floatEquals(value.lastValue, v)) {
+			value.lastValue = v;
+			updated = true;
+		}
+	}
+	return updated;
+}
+
+void printLogInfo() {
+	if (logMemory == -1) return print("Log: disabled\n");
+
+	print("Memory: %s\n", logMemory == 0 ? "RAM" : "PSRAM");
+	print("Usage: %.f%%\n", logUsage * 100);
+	print("Capacity: %u bytes\n", (unsigned)logCapacity);
+	print("Used: %u bytes\n", (unsigned)logLength);
+	print("Estimated duration: %d seconds\n", estimateLogDuration());
+}
+
+int estimateLogDuration() {
+	float bandwidth = 0;
+	for (LogTopic& topic : logTopics) {
+		float rate = isinf(topic.throttle) ? loopRate : topic.throttle;
+		bandwidth += rate * topic.length * sizeof(float);
+	}
+	return logCapacity / bandwidth;
+}
+
+void printLogHeader() {
+	int i = 0;
+	for (auto& topic : logTopics) {
+		print("Topic #%d (%g Hz):\n", i++, topic.throttle);
+		for (auto& value : topic.values) {
+			if (value.name == nullptr) break;
+			print("  %s%s\n", value.name, value.logged ?"" : " (not logged)");
+		}
+	}
+}
+
+void printLogValues(const char *filter) {
+	for (LogTopic& topic : logTopics) {
+		for (LogValue& value : topic.values) {
+			if (value.name == nullptr) break;
+			if (strncasecmp(value.name, filter, strlen(filter))) continue;
+			print("%s = %g\n", value.name, value.value.get());
+		}
+	}
+}
+
+void configLogThrottle(const char *name, float throttle) {
+	for (LogTopic& topic : logTopics) {
+		for (LogValue& value : topic.values) {
+			if (value.name == nullptr) break;
+			if (strcasecmp(value.name, name) != 0) continue;
+			topic.throttle = throttle;
+			print("Log throttle for %s set to %.1f Hz\n", name, throttle);
+			return;
+		}
+	}
+	print("Log value not found: %s\n", name);
+}
+
+void exposeLogValue(const char *name) {
+	for (int i = 0; i < sizeof(logTopics) / sizeof(logTopics[0]); i++) {
+		LogTopic& topic = logTopics[i];
+		for (LogValue& value : topic.values) {
+			if (value.name == nullptr) break;
+			if (strcasecmp(value.name, name) != 0) continue;
+			logExposed = &value;
+			print("Log value %s exposed\n", name);
+			return;
+		}
+	}
+	print("Log value not found: %s\n", name);
+}