Reduce angle drift adding level correction to the estimator

Utilize a-priori knowledge that the overall average attitude of the flying drone is level.

README.md

@@ -77,7 +77,7 @@ Additional articles:
 |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|55 mm (alternatively 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|
-|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|
 |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|
@@ -154,10 +154,12 @@ You can see a user-contributed [variant of complete circuit diagram](https://mir
   |VIN|VCC (or 3.3V depending on the receiver)|
   |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.*
+  *¹ — 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 ESP32S3).
 
+  ESP32 and ESP32S3 [can measure](https://docs.espressif.com/projects/arduino-esp32/en/latest/api/adc.html#analogsetattenuation) up to 3.1 V and ESP32S3/ESP32C3 can measure up to 2.5 V, so choose the voltage divider resistors accordingly.
+
 ## Resources
 
 * Telegram channel on developing the drone and the flight controller (in Russian): https://t.me/opensourcequadcopter.

docs/usage.md

@@ -112,7 +112,7 @@ You can also work with parameters using `p` command in the console. Parameter na
 
 ### 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 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 pins side and *Z* axis pointing up from the component side:
 
@@ -138,6 +138,8 @@ Before flight you need to calibrate the accelerometer:
 
 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).
 
+Certain ESP32 models (such as ESP32-S3) support a lower maximum PWM frequency; on these boards the parameter `MOT_PWM_FREQ` should be set to 40000 Hz.
+
 If using brushless motors and 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).
@@ -245,7 +247,7 @@ When finished flying, **disarm** the drone, moving the left stick to the bottom
 
 ### 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*.
+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
 
@@ -266,7 +268,7 @@ In this mode, the pilot controls the angular rates. This control method is diffi
 
 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, the drone will switch back to *STAB* mode.
+If the pilot moves the control sticks and mode switch is not configured, the drone will switch back to *STAB* mode.
 
 ## Wi-Fi configuration
 

flix/cli.ino

@@ -178,7 +178,7 @@ 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

flix/control.ino

@@ -67,7 +67,7 @@ void control() {
 
 void interpretControls() {
 	if (controlMode < 0.25) mode = flightModes[0];
-	else if (controlMode < 0.75) mode = flightModes[1];
+	else if (controlMode <= 0.75) mode = flightModes[1];
 	else if (controlMode > 0.75) mode = flightModes[2];
 
 	if (mode == AUTO) return; // pilot is not effective in AUTO mode
@@ -149,12 +149,25 @@ void controlTorque() {
 	motors[MOTOR_REAR_LEFT] = thrustTarget + torqueTarget.x + torqueTarget.y - torqueTarget.z;
 	motors[MOTOR_REAR_RIGHT] = thrustTarget - torqueTarget.x + torqueTarget.y + torqueTarget.z;
 
+	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 RAW: return "RAW";

flix/estimate.ino

@@ -13,11 +13,13 @@ Quaternion attitude; // estimated attitude
 bool landed;
 
 float accWeight = 0.003;
+float levelWeight = 0.0002;
 LowPassFilter<Vector> ratesFilter(0.2); // cutoff frequency ~ 40 Hz
 
 void estimate() {
 	applyGyro();
 	applyAcc();
+	applyLevel();
 }
 
 void applyGyro() {
@@ -42,3 +44,12 @@ void applyAcc() {
 	// apply correction
 	attitude = Quaternion::rotate(attitude, Quaternion::fromRotationVector(correction));
 }
+
+void applyLevel() {
+	if (landed) return;
+
+	// 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/flix.ino

@@ -18,8 +18,8 @@ extern float motors[4];
 void setup() {
 	Serial.begin(115200);
 	print("Initializing flix\n");
-	disableBrownOut();
 	setupParameters();
+	setupPower();
 	setupLED();
 	setLED(true);
 	setupMotors();

flix/imu.ino

@@ -121,7 +121,7 @@ void printIMUInfo() {
 	print("model: %s\n", imu.getModel());
 	print("who am I: 0x%02X\n", imu.whoAmI());
 	print("rate: %.0f\n", loopRate);
-	print("gyro: %f %f %f\n", rates.x, rates.y, rates.z);
+	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;

flix/mavlink.ino

@@ -65,7 +65,7 @@ void sendMavlink() {
 		sendMessage(&msg);
 
 		mavlink_msg_scaled_imu_pack(mavlinkSysId, MAV_COMP_ID_AUTOPILOT1, &msg, time,
-			acc.x * 1000, -acc.y * 1000, -acc.z * 1000, // convert to frd
+			acc.x / ONE_G * 1000, -acc.y / ONE_G * 1000, -acc.z / ONE_G * 1000, // convert to frd
 			gyro.x * 1000, -gyro.y * 1000, -gyro.z * 1000,
 			0, 0, 0, 0);
 		sendMessage(&msg);

flix/parameters.ino

@@ -36,13 +36,16 @@ Parameter parameters[] = {
 	{"CTL_R_RATE_I", &rollRatePID.i},
 	{"CTL_R_RATE_D", &rollRatePID.d},
 	{"CTL_R_RATE_WU", &rollRatePID.windup},
+	{"CTL_R_RATE_D_A", &rollRatePID.lpf.alpha},
 	{"CTL_P_RATE_P", &pitchRatePID.p},
 	{"CTL_P_RATE_I", &pitchRatePID.i},
 	{"CTL_P_RATE_D", &pitchRatePID.d},
 	{"CTL_P_RATE_WU", &pitchRatePID.windup},
+	{"CTL_P_RATE_D_A", &pitchRatePID.lpf.alpha},
 	{"CTL_Y_RATE_P", &yawRatePID.p},
 	{"CTL_Y_RATE_I", &yawRatePID.i},
 	{"CTL_Y_RATE_D", &yawRatePID.d},
+	{"CTL_Y_RATE_D_A", &yawRatePID.lpf.alpha},
 	{"CTL_R_P", &rollPID.p},
 	{"CTL_R_I", &rollPID.i},
 	{"CTL_R_D", &rollPID.d},
@@ -70,6 +73,7 @@ Parameter parameters[] = {
 	{"IMU_GYRO_BIAS_A", &gyroBiasFilter.alpha},
 	// estimate
 	{"EST_ACC_WEIGHT", &accWeight},
+	{"EST_LVL_WEIGHT", &levelWeight},
 	{"EST_RATES_LPF_A", &ratesFilter.alpha},
 	// motors
 	{"MOT_PIN_FL", &motorPins[MOTOR_FRONT_LEFT], setupMotors},

flix/power.ino

@@ -3,6 +3,8 @@
 
 // Power management
 
+#include <soc/soc.h>
+#include <soc/rtc_cntl_reg.h>
 #include "lpf.h"
 #include "util.h"
 
@@ -11,6 +13,11 @@ LowPassFilter<float> voltageFilter(0.2);
 int voltagePin = -1;
 float voltageScale = 2;
 
+void setupPower() {
+	// Disable reset on low voltage
+	REG_CLR_BIT(RTC_CNTL_BROWN_OUT_REG, RTC_CNTL_BROWN_OUT_ENA);
+}
+
 void readVoltage() {
 	if (voltagePin < 0) return;
 	static Rate rate(10);

flix/safety.ino

@@ -37,8 +37,8 @@ void descend() {
 void autoFailsafe() {
 	static float roll, pitch, yaw, throttle;
 	if (roll != controlRoll || pitch != controlPitch || yaw != controlYaw || abs(throttle - controlThrottle) > 0.05) {
-		// controls changed
-		if (mode == AUTO) mode = STAB; // regain control by the pilot
+		// controls changed and mode switch is not configured
+		if (mode == AUTO && invalid(controlMode)) mode = STAB; // regain control by the pilot
 	}
 	roll = controlRoll;
 	pitch = controlPitch;

flix/util.h

@@ -6,8 +6,6 @@
 #pragma once
 
 #include <math.h>
-#include <soc/soc.h>
-#include <soc/rtc_cntl_reg.h>
 
 const float ONE_G = 9.80665;
 extern float t;
@@ -35,11 +33,6 @@ float wrapAngle(float angle) {
 	return angle;
 }
 
-// Disable reset on low voltage
-void disableBrownOut() {
-	REG_CLR_BIT(RTC_CNTL_BROWN_OUT_REG, RTC_CNTL_BROWN_OUT_ENA);
-}
-
 // Trim and split string by spaces
 void splitString(String& str, String& token0, String& token1, String& token2) {
 	str.trim();

flix/vector.h

@@ -105,10 +105,23 @@ public:
 	}
 
 	static Vector rotationVectorBetween(const Vector& a, const Vector& b) {
+		float an = a.norm();
+		float bn = b.norm();
+		if (an < 1e-6 || bn < 1e-6) {
+			return Vector(0, 0, 0);
+		}
 		Vector direction = cross(a, b);
-		if (direction.zero()) {
-			// vectors are opposite, return any perpendicular vector
-			return cross(a, Vector(1, 0, 0));
+		if (direction.norm() < 1e-6) { // vectors are parallel
+			if (dot(a, b) > 0) { // same direction
+				return Vector(0, 0, 0);
+			}
+			// opposite direction
+			Vector perp = cross(a, Vector(1, 0, 0));
+			if (perp.norm() < 1e-6) {
+				perp = cross(a, Vector(0, 1, 0));
+			}
+			perp.normalize();
+			return perp * PI;
 		}
 		direction.normalize();
 		float angle = angleBetween(a, b);

flix/wifi.ino

@@ -25,6 +25,7 @@ void setupWiFi() {
 	} else if (wifiMode == W_STA) {
 		WiFi.begin(storage.getString("WIFI_STA_SSID", "").c_str(), storage.getString("WIFI_STA_PASS", "").c_str());
 	}
+	WiFi.setSleep(false); // disable power save
 	udp.begin(udpLocalPort);
 }
 

gazebo/Arduino.h

@@ -21,6 +21,8 @@
 #define degrees(rad) ((rad)*RAD_TO_DEG)
 
 #define constrain(amt,low,high) ((amt)<(low)?(low):((amt)>(high)?(high):(amt)))
+template<typename T> T max(T a, T b) { return a > b ? a : b; }
+template<typename T> T min(T a, T b) { return a < b ? a : b; }
 
 long map(long x, long in_min, long in_max, long out_min, long out_max) {
 	const long run = in_max - in_min;

gazebo/flix.h

@@ -27,11 +27,13 @@ void step();
 void computeLoopRate();
 void applyGyro();
 void applyAcc();
+void applyLevel();
 void control();
 void interpretControls();
 void controlAttitude();
 void controlRates();
 void controlTorque();
+void desaturate(float& a, float& b, float& c, float& d);
 const char* getModeName();
 void sendMotors();
 int getDutyCycle(float value);

gazebo/soc/soc.h

@@ -1,4 +1,3 @@
 // Dummy file to make it possible to compile simulator with Flix' util.h
 
-#define WRITE_PERI_REG(addr, val) {}
 #define REG_CLR_BIT(_r, _b) {}

tools/pyflix/README.md

@@ -24,13 +24,13 @@ pip install pyflix
 The API is accessed through the `Flix` class:
 
 ```python
-from flix import Flix
+from pyflix import Flix
 flix = Flix()  # create a Flix object and wait for connection
 ```
 
 ### Telemetry
 
-Basic telemetry is available through object properties. The property names generally match the corresponding variables in the firmware itself:
+Basic telemetry is available through object properties. The property names generally match the corresponding variables in the firmware code:
 
 ```python
 print(flix.connected)       # True if connected to the drone

tools/pyflix/flix.py

@@ -186,7 +186,8 @@ class Flix:
             self._trigger('motors', self.motors)
 
         if isinstance(msg, mavlink.MAVLink_scaled_imu_message):
-            self.acc = self._mavlink_to_flu([msg.xacc / 1000, msg.yacc / 1000, msg.zacc / 1000])
+            ONE_G = 9.80665
+            self.acc = self._mavlink_to_flu([msg.xacc * ONE_G / 1000, msg.yacc * ONE_G / 1000, msg.zacc * ONE_G / 1000])
             self.gyro = self._mavlink_to_flu([msg.xgyro / 1000, msg.ygyro / 1000, msg.zgyro / 1000])
             self._trigger('acc', self.acc)
             self._trigger('gyro', self.gyro)

tools/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pyflix"
-version = "0.11"
+version = "0.14"
 description = "Python API for Flix drone"
 authors = [{ name="Oleg Kalachev", email="okalachev@gmail.com" }]
 license = "MIT"