Add level calibration

Parameters: CTL_FLT_MODE_0, CTL_FLT_MODE_1, CTL_FLT_MODE_2.
Also fix a bug with incorrect choosing the mode from controlMode.

docs/usage.md

@@ -134,6 +134,20 @@ 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).
+
+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).
+2. Decrease the PWM frequency using the `MOT_PWM_FREQ` parameter (400 is typical).
+
+Reboot the drone to apply the changes.
+
+> [!CAUTION]
+> **Remove the props when configuring the motors!** If improperly configured, you may not be able to stop them.
+
 ### Check everything works
 
 1. Check the IMU is working: perform `imu` command and check its output:

docs/user.md

@@ -4,6 +4,17 @@ This page contains user-built drones based on the Flix project. Publish your pro
 
 ---
 
+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>

flix/cli.ino

@@ -46,6 +46,7 @@ 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"
@@ -94,7 +95,7 @@ void doCommand(String str, bool echo = false) {
 	} 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());
 		}
@@ -151,6 +152,8 @@ 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/control.ino

@@ -52,6 +52,7 @@ 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;
+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, controlMode;
@@ -65,9 +66,9 @@ void control() {
 }
 
 void interpretControls() {
-	if (controlMode < 0.25) mode = STAB;
+	if (controlMode < 0.25) mode = flightModes[0];
-	if (controlMode < 0.75) mode = STAB;
+	else if (controlMode < 0.75) mode = flightModes[1];
-	if (controlMode > 0.75) mode = STAB;
+	else if (controlMode > 0.75) mode = flightModes[2];
 
 	if (mode == AUTO) return; // pilot is not effective in AUTO mode
 

flix/imu.ino

@@ -110,6 +110,14 @@ 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/motors.ino

@@ -1,24 +1,19 @@
 // Copyright (c) 2023 Oleg Kalachev <okalachev@gmail.com>
 // Repository: https://github.com/okalachev/flix
 
-// Motors output control using MOSFETs
+// PWM control for motors
-// In case of using ESCs, change PWM_STOP, PWM_MIN and PWM_MAX to appropriate values in μs, decrease PWM_FREQUENCY (to 400)
 
 #include "util.h"
 
-#define MOTOR_0_PIN 12 // rear left
-#define MOTOR_1_PIN 13 // rear right
-#define MOTOR_2_PIN 14 // front right
-#define MOTOR_3_PIN 15 // front left
-
-#define PWM_FREQUENCY 78000
-#define PWM_RESOLUTION 10
-#define PWM_STOP 0
-#define PWM_MIN 0
-#define PWM_MAX 1000000 / PWM_FREQUENCY
-
 float motors[4]; // normalized motor thrusts in range [0..1]
 
+int motorPins[4] = {12, 13, 14, 15}; // default pin numbers
+int pwmFrequency = 78000;
+int pwmResolution = 10;
+int pwmStop = 0;
+int pwmMin = 0;
+int pwmMax = -1; // -1 means duty cycle mode
+
 const int MOTOR_REAR_LEFT = 0;
 const int MOTOR_REAR_RIGHT = 1;
 const int MOTOR_FRONT_RIGHT = 2;
@@ -26,30 +21,30 @@ const int MOTOR_FRONT_LEFT = 3;
 
 void setupMotors() {
 	print("Setup Motors\n");
-
 	// configure pins
-	ledcAttach(MOTOR_0_PIN, PWM_FREQUENCY, PWM_RESOLUTION);
+	for (int i = 0; i < 4; i++) {
-	ledcAttach(MOTOR_1_PIN, PWM_FREQUENCY, PWM_RESOLUTION);
+		ledcAttach(motorPins[i], pwmFrequency, pwmResolution);
-	ledcAttach(MOTOR_2_PIN, PWM_FREQUENCY, PWM_RESOLUTION);
+	}
-	ledcAttach(MOTOR_3_PIN, PWM_FREQUENCY, PWM_RESOLUTION);
-
 	sendMotors();
 	print("Motors initialized\n");
 }
 
-int getDutyCycle(float value) {
+void sendMotors() {
-	value = constrain(value, 0, 1);
+	for (int i = 0; i < 4; i++) {
-	float pwm = mapf(value, 0, 1, PWM_MIN, PWM_MAX);
+		ledcWrite(motorPins[i], getDutyCycle(motors[i]));
-	if (value == 0) pwm = PWM_STOP;
+	}
-	float duty = mapf(pwm, 0, 1000000 / PWM_FREQUENCY, 0, (1 << PWM_RESOLUTION) - 1);
-	return round(duty);
 }
 
-void sendMotors() {
+int getDutyCycle(float value) {
-	ledcWrite(MOTOR_0_PIN, getDutyCycle(motors[0]));
+	value = constrain(value, 0, 1);
-	ledcWrite(MOTOR_1_PIN, getDutyCycle(motors[1]));
+	if (pwmMax >= 0) { // pwm mode
-	ledcWrite(MOTOR_2_PIN, getDutyCycle(motors[2]));
+		float pwm = mapf(value, 0, 1, pwmMin, pwmMax);
-	ledcWrite(MOTOR_3_PIN, getDutyCycle(motors[3]));
+		if (value == 0) pwm = pwmStop;
+		float duty = mapf(pwm, 0, 1000000 / pwmFrequency, 0, (1 << pwmResolution) - 1);
+		return round(duty);
+	} else { // duty cycle mode
+		return round(value * ((1 << pwmResolution) - 1));
+	}
 }
 
 bool motorsActive() {

flix/parameters.ino

@@ -49,6 +49,9 @@ Parameter parameters[] = {
 	{"CTL_R_RATE_MAX", &maxRate.x},
 	{"CTL_Y_RATE_MAX", &maxRate.z},
 	{"CTL_TILT_MAX", &tiltMax},
+	{"CTL_FLT_MODE_0", &flightModes[0]},
+	{"CTL_FLT_MODE_1", &flightModes[1]},
+	{"CTL_FLT_MODE_2", &flightModes[2]},
 	// imu
 	{"IMU_ROT_ROLL", &imuRotation.x},
 	{"IMU_ROT_PITCH", &imuRotation.y},
@@ -63,6 +66,16 @@ Parameter parameters[] = {
 	// estimate
 	{"EST_ACC_WEIGHT", &accWeight},
 	{"EST_RATES_LPF_A", &ratesFilter.alpha},
+	// motors
+	{"MOT_PIN_FL", &motorPins[MOTOR_FRONT_LEFT]},
+	{"MOT_PIN_FR", &motorPins[MOTOR_FRONT_RIGHT]},
+	{"MOT_PIN_RL", &motorPins[MOTOR_REAR_LEFT]},
+	{"MOT_PIN_RR", &motorPins[MOTOR_REAR_RIGHT]},
+	{"MOT_PWM_FREQ", &pwmFrequency},
+	{"MOT_PWM_RES", &pwmResolution},
+	{"MOT_PWM_STOP", &pwmStop},
+	{"MOT_PWM_MIN", &pwmMin},
+	{"MOT_PWM_MAX", &pwmMax},
 	// rc
 	{"RC_ZERO_0", &channelZero[0]},
 	{"RC_ZERO_1", &channelZero[1]},

gazebo/flix.h

@@ -9,6 +9,7 @@
 #include "quaternion.h"
 #include "Arduino.h"
 #include "wifi.h"
+#include "lpf.h"
 
 extern float t, dt;
 extern float controlRoll, controlPitch, controlYaw, controlThrottle, controlMode;
@@ -19,6 +20,7 @@ extern float motors[4];
 
 Vector gyro, acc, imuRotation;
 Vector accBias, gyroBias, accScale(1, 1, 1);
+LowPassFilter<Vector> gyroBiasFilter(0);
 
 // declarations
 void step();
@@ -32,6 +34,7 @@ void controlRates();
 void controlTorque();
 const char* getModeName();
 void sendMotors();
+int getDutyCycle(float value);
 bool motorsActive();
 void testMotor(int n);
 void print(const char* format, ...);
@@ -68,6 +71,7 @@ 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() {};

gazebo/wifi.h

@@ -11,9 +11,10 @@
 #include <sys/poll.h>
 #include <gazebo/gazebo.hh>
 
-#define WIFI_UDP_PORT 14580
+int wifiMode = 1; // mock
-#define WIFI_UDP_REMOTE_PORT 14550
+int udpLocalPort = 14580;
-#define WIFI_UDP_REMOTE_ADDR "255.255.255.255"
+int udpRemotePort = 14550;
+const char *udpRemoteIP = "255.255.255.255";
 
 int wifiSocket;
 
@@ -22,22 +23,22 @@ void setupWiFi() {
 	sockaddr_in addr; // local address
 	addr.sin_family = AF_INET;
 	addr.sin_addr.s_addr = INADDR_ANY;
-	addr.sin_port = htons(WIFI_UDP_PORT);
+	addr.sin_port = htons(udpLocalPort);
 	if (bind(wifiSocket, (sockaddr *)&addr, sizeof(addr))) {
-		gzerr << "Failed to bind WiFi UDP socket on port " << WIFI_UDP_PORT << std::endl;
+		gzerr << "Failed to bind WiFi UDP socket on port " << udpLocalPort << std::endl;
 		return;
 	}
 	int broadcast = 1;
 	setsockopt(wifiSocket, SOL_SOCKET, SO_BROADCAST, &broadcast, sizeof(broadcast)); // enable broadcast
-	gzmsg << "WiFi UDP socket initialized on port " << WIFI_UDP_PORT << " (remote port " << WIFI_UDP_REMOTE_PORT << ")" << std::endl;
+	gzmsg << "WiFi UDP socket initialized on port " << udpLocalPort << " (remote port " << udpRemotePort << ")" << std::endl;
 }
 
 void sendWiFi(const uint8_t *buf, int len) {
 	if (wifiSocket == 0) setupWiFi();
 	sockaddr_in addr; // remote address
 	addr.sin_family = AF_INET;
-	addr.sin_addr.s_addr = inet_addr(WIFI_UDP_REMOTE_ADDR);
+	addr.sin_addr.s_addr = inet_addr(udpRemoteIP);
-	addr.sin_port = htons(WIFI_UDP_REMOTE_PORT);
+	addr.sin_port = htons(udpRemotePort);
 	sendto(wifiSocket, buf, len, 0, (sockaddr *)&addr, sizeof(addr));
 }