Minor doc fixes

As it makes the subsystems code easier to understand.
Declare the most used variables in main sketch file as forward declarations.
Make all control input zero by default (except controlMode).
Minor changes.

docs/book/firmware.md

@@ -35,7 +35,7 @@
 
 ### Подсистема управления
 
-Состояние органов управления обрабатывается в функции `interpretControls()` и преобразуется в *команду управления*, которая включает следующее:
+Состояние органов управления обрабатывается в функции `interpretControls()` и преобразуется в **команду управления**, которая включает следующее:
 
 * `attitudeTarget` *(Quaternion)* — целевая ориентация дрона.
 * `ratesTarget` *(Vector)* — целевые угловые скорости, *рад/с*.

docs/firmware.md

@@ -38,13 +38,13 @@ Utility files:
 
 ### Control subsystem
 
-Pilot inputs are interpreted in `interpretControls()`, and then converted to the *control command*, which consists of the following:
+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 thrust target, range [0, 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`.
 
@@ -62,6 +62,11 @@ 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.
+
 ## Building the firmware
 
 See build instructions in [usage.md](usage.md).

docs/troubleshooting.md

@@ -4,7 +4,7 @@
 
 Do the following:
 
-* **Check ESP32 core is installed**. Check if the version matches the one used in the [tutorial](usage.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 the chosen board**. The correct board to choose in Arduino IDE for ESP32 Mini is *WEMOS D1 MINI ESP32*.
 
@@ -25,7 +25,7 @@ Do the following:
   * The `accel` and `gyro` fields should change as you move the drone.
 * **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 IMU orientation is set correctly**. If the attitude estimation is rotated, make sure `rotateIMU` function is defined correctly in `imu.ino` file.
+* **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).
 * **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).

docs/usage.md

@@ -80,7 +80,7 @@ QGroundControl is a ground control station software that can be used to monitor
 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
+4. Launch QGroundControl app. It should connect and begin showing the drone's telemetry automatically.
 
 ### Access console
 
@@ -108,11 +108,13 @@ The drone is configured using parameters. To access and modify them, go to the Q
 
 <img src="img/parameters.png" width="400">
 
+You can also work with parameters using `p` command in the console.
+
 ### Define IMU orientation
 
 Use parameters, to define the IMU board axes orientation relative to the drone's axes: `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 pins side and *Z* axis pointing up from the side with the components:
+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 pins side and *Z* axis pointing up from the component side:
 
 <img src="img/imu-axes.png" width="200">
 
@@ -120,10 +122,10 @@ Use the following table to set the parameters for common IMU orientations:
 
 |Orientation|Parameters|Orientation|Parameters|
 |:-:|-|-|-|
-|<img src="img/imu-rot-1.png" width="200">|`IMU_ROT_ROLL` = 0<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 0    |<img src="img/imu-rot-5.png" width="200">|`IMU_ROT_ROLL` = 3.142<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 0|
-|<img src="img/imu-rot-2.png" width="200">|`IMU_ROT_ROLL` = 0<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 1.571|<img src="img/imu-rot-6.png" width="200">|`IMU_ROT_ROLL` = 3.142<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = -1.571|
-|<img src="img/imu-rot-3.png" width="200">|`IMU_ROT_ROLL` = 0<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 3.142|<img src="img/imu-rot-7.png" width="200">|`IMU_ROT_ROLL` = 3.142<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 3.142|
-|<img src="img/imu-rot-4.png" width="200"><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="200">|`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` = 0    |<img src="img/imu-rot-5.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-3.png" width="180">|`IMU_ROT_ROLL` = 0<br>`IMU_ROT_PITCH` = 0<br>`IMU_ROT_YAW` = 3.142|<img src="img/imu-rot-7.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
 
@@ -152,6 +154,10 @@ Before flight you need to calibrate the accelerometer:
    * `mrl` — should rotate rear left motor (counter-clockwise).
    * `mrr` — should rotate rear right motor (clockwise).
 
+   Rotation 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.
 
@@ -159,7 +165,7 @@ Before flight you need to calibrate the accelerometer:
 
 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).
 
-### Control with smartphone
+### Control with a 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.
@@ -171,7 +177,7 @@ There are several ways to control the drone's flight: using **smartphone** (Wi-F
 > [!TIP]
 > Decrease `CTL_TILT_MAX` parameter when flying using the smartphone to make the controls less sensitive.
 
-### Control with remote control
+### Control with a remote control
 
 Before using remote SBUS-connected remote control, you need to calibrate it:
 
@@ -179,7 +185,7 @@ Before using remote SBUS-connected remote control, you need to calibrate it:
 2. Type `cr` command and follow the instructions.
 3. Use the remote control to fly the drone!
 
-### Control with USB remote control
+### 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.
 
@@ -237,8 +243,6 @@ In this mode, the pilot inputs are ignored (except the mode switch, if configure
 
 If the pilot moves the control sticks, the drone will switch back to *STAB* mode.
 
-<img src="img/parameters.png" width="400">
-
 ## Flight log
 
 After the flight, you can download the flight log for analysis wirelessly. Use the following for that:

docs/user.md

@@ -16,7 +16,7 @@ Author: [goldarte](https://t.me/goldarte).<br>
 
 ## School 548 course
 
-Special quadcopter design and engineering course took place in october-november 2025 in School 548, Moscow. Course included UAV control theory, electronics, and practical drone assembly and setup using the Flix project.
+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">
 
@@ -25,7 +25,7 @@ STL files and other materials: see [here](https://drive.google.com/drive/folders
 ### Selected works
 
 Author: [KiraFlux](https://t.me/@kiraflux_0XC0000005).<br>
-Description: **custom ESPNOW remote control** is implemented, firmware modified to support ESPNOW protocol.<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>

flix/cli.ino

@@ -11,7 +11,7 @@ extern const int MOTOR_REAR_LEFT, MOTOR_REAR_RIGHT, MOTOR_FRONT_RIGHT, MOTOR_FRO
 extern const int RAW, ACRO, STAB, AUTO;
 extern float t, dt, loopRate;
 extern uint16_t channels[16];
-extern float controlRoll, controlPitch, controlThrottle, controlYaw, controlMode;
+extern float controlTime;
 extern int mode;
 extern bool armed;
 
@@ -42,7 +42,6 @@ const char* motd =
 "log [dump] - print log header [and data]\n"
 "cr - calibrate RC\n"
 "ca - calibrate accel\n"
-"cl - calibrate level\n"
 "mfr, mfl, mrr, mrl - test motor (remove props)\n"
 "sys - show system info\n"
 "reset - reset drone's state\n"
@@ -133,6 +132,7 @@ void doCommand(String str, bool echo = false) {
 		}
 		print("\nroll: %g pitch: %g yaw: %g throttle: %g mode: %g\n",
 			controlRoll, controlPitch, controlYaw, controlThrottle, controlMode);
+		print("time: %.1f\n", controlTime);
 		print("mode: %s\n", getModeName());
 		print("armed: %d\n", armed);
 	} else if (command == "wifi") {
@@ -149,8 +149,6 @@ void doCommand(String str, bool echo = false) {
 		calibrateRC();
 	} else if (command == "ca") {
 		calibrateAccel();
-	} else if (command == "cl") {
-		calibrateLevel();
 	} else if (command == "mfr") {
 		testMotor(MOTOR_FRONT_RIGHT);
 	} else if (command == "mfl") {

flix/estimate.ino

@@ -8,6 +8,10 @@
 #include "lpf.h"
 #include "util.h"
 
+Vector rates; // estimated angular rates, rad/s
+Quaternion attitude; // estimated attitude
+bool landed;
+
 float accWeight = 0.003;
 LowPassFilter<Vector> ratesFilter(0.2); // cutoff frequency ~ 40 Hz
 

flix/flix.ino

@@ -9,16 +9,13 @@
 
 #define WIFI_ENABLED 1
 
-float t = NAN; // current step time, s
-float dt; // time delta from previous step, s
-float controlRoll, controlPitch, controlYaw, controlThrottle; // pilot's inputs, range [-1, 1]
-float controlMode = NAN;
-Vector gyro; // gyroscope data
-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]
+extern float t, dt;
+extern float controlRoll, controlPitch, controlYaw, controlThrottle, controlMode;
+extern Vector gyro, acc;
+extern Vector rates;
+extern Quaternion attitude;
+extern bool landed;
+extern float motors[4];
 
 void setup() {
 	Serial.begin(115200);

flix/imu.ino

@@ -12,9 +12,12 @@
 MPU9250 imu(SPI);
 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;
 
 void setupIMU() {
 	print("Setup IMU\n");
@@ -107,14 +110,6 @@ void calibrateAccelOnce() {
 	accBias = (accMax + accMin) / 2;
 }
 
-void calibrateLevel() {
-	print("Place perfectly level [1 sec]\n");
-	pause(1);
-	Quaternion correction = Quaternion::fromBetweenVectors(Quaternion::rotateVector(Vector(0, 0, 1), attitude), Vector(0, 0, 1));
-	imuRotation = Quaternion::rotate(correction, Quaternion::fromEuler(imuRotation)).toEuler();
-	print("✓ Done: %.3f %.3f %.3f\n", degrees(imuRotation.x), degrees(imuRotation.y), degrees(imuRotation.z));
-}
-
 void printIMUCalibration() {
 	print("gyro bias: %f %f %f\n", gyroBias.x, gyroBias.y, gyroBias.z);
 	print("accel bias: %f %f %f\n", accBias.x, accBias.y, accBias.z);

flix/mavlink.ino

@@ -12,12 +12,11 @@
 #define MAVLINK_RATE_SLOW 1
 #define MAVLINK_RATE_FAST 10
 
+extern float controlTime;
+
 bool mavlinkConnected = false;
 String mavlinkPrintBuffer;
 
-extern float controlTime;
-extern float controlRoll, controlPitch, controlThrottle, controlYaw, controlMode;
-
 void processMavlink() {
 	sendMavlink();
 	receiveMavlink();

flix/motors.ino

@@ -17,7 +17,8 @@
 #define PWM_MIN 0
 #define PWM_MAX 1000000 / PWM_FREQUENCY
 
-// Motors array indexes:
+float motors[4]; // normalized motor thrusts in range [0..1]
+
 const int MOTOR_REAR_LEFT = 0;
 const int MOTOR_REAR_RIGHT = 1;
 const int MOTOR_FRONT_RIGHT = 2;

flix/rc.ino

@@ -6,13 +6,16 @@
 #include <SBUS.h>
 #include "util.h"
 
-SBUS rc(Serial2); // NOTE: Use RC(Serial2, 16, 17) if you use the old UART2 pins
+SBUS rc(Serial2);
 
 uint16_t channels[16]; // raw rc channels
-float controlTime; // time of the last controls update
 float channelZero[16]; // calibration zero values
 float channelMax[16]; // calibration max values
 
+float controlRoll, controlPitch, controlYaw, controlThrottle; // pilot's inputs, range [-1, 1]
+float controlMode = NAN; //
+float controlTime; // time of the last controls update (0 when no RC)
+
 // Channels mapping (using float to store in parameters):
 float rollChannel = NAN, pitchChannel = NAN, throttleChannel = NAN, yawChannel = NAN, modeChannel = NAN;
 
@@ -38,11 +41,11 @@ void normalizeRC() {
 		controls[i] = mapf(channels[i], channelZero[i], channelMax[i], 0, 1);
 	}
 	// Update control values
-	controlRoll = rollChannel >= 0 ? controls[(int)rollChannel] : NAN;
-	controlPitch = pitchChannel >= 0 ? controls[(int)pitchChannel] : NAN;
-	controlYaw = yawChannel >= 0 ? controls[(int)yawChannel] : NAN;
-	controlThrottle = throttleChannel >= 0 ? controls[(int)throttleChannel] : NAN;
-	controlMode = modeChannel >= 0 ? controls[(int)modeChannel] : NAN;
+	controlRoll = rollChannel >= 0 ? controls[(int)rollChannel] : 0;
+	controlPitch = pitchChannel >= 0 ? controls[(int)pitchChannel] : 0;
+	controlYaw = yawChannel >= 0 ? controls[(int)yawChannel] : 0;
+	controlThrottle = throttleChannel >= 0 ? controls[(int)throttleChannel] : 0;
+	controlMode = modeChannel >= 0 ? controls[(int)modeChannel] : NAN; // mode switch should not have affect if not set
 }
 
 void calibrateRC() {

flix/time.ino

@@ -3,6 +3,8 @@
 
 // Time related functions
 
+float t = NAN; // current time, s
+float dt; // time delta with the previous step, s
 float loopRate; // Hz
 
 void step() {

flix/vector.h

@@ -35,7 +35,6 @@ public:
 		z = NAN;
 	}
 
-
 	float norm() const {
 		return sqrt(x * x + y * y + z * z);
 	}

gazebo/flix.h

@@ -12,17 +12,15 @@
 
 #define WIFI_ENABLED 1
 
-float t = NAN;
-float dt;
-float motors[4];
-float controlRoll, controlPitch, controlYaw, controlThrottle = NAN;
-float controlMode = NAN;
-Vector acc;
-Vector gyro;
-Vector rates;
-Quaternion attitude;
-bool landed;
-Vector imuRotation;
+extern float t, dt;
+extern float controlRoll, controlPitch, controlYaw, controlThrottle, controlMode;
+extern Vector rates;
+extern Quaternion attitude;
+extern bool landed;
+extern float motors[4];
+
+Vector gyro, acc, imuRotation;
+Vector accBias, gyroBias, accScale(1, 1, 1);
 
 // declarations
 void step();
@@ -72,8 +70,6 @@ void resetParameters();
 void setLED(bool on) {};
 void calibrateGyro() { print("Skip gyro calibrating\n"); };
 void calibrateAccel() { print("Skip accel calibrating\n"); };
-void calibrateLevel() { print("Skip level calibrating\n"); };
 void printIMUCalibration() { print("cal: N/A\n"); };
 void printIMUInfo() {};
 void printWiFiInfo() {};
-Vector accBias, gyroBias, accScale(1, 1, 1);

tools/pyflix/README.md

@@ -95,7 +95,7 @@ Full list of events:
 |`armed`|Armed state update|Armed state (*bool*)|
 |`mode`|Flight mode update|Flight mode (*str*)|
 |`landed`|Landed state update|Landed state (*bool*)|
-|`print`|The drone sends text to the console|Text|
+|`print`|The drone prints text to the console|Text|
 |`attitude`|Attitude update|Attitude quaternion (*list*)|
 |`attitude_euler`|Attitude update|Euler angles (*list*)|
 |`rates`|Angular rates update|Angular rates (*list*)|
@@ -112,7 +112,7 @@ Full list of events:
 > [!NOTE]
 > Update events trigger on every new piece of data from the drone, and do not mean the value has changed.
 
-### Common methods
+### Basic methods
 
 Get and set firmware parameters using `get_param` and `set_param` methods: