imuboard/MadgwickAHRS.c

   1 /*
   2  * Copyright (c) 2014, Olivier MATZ <zer0@droids-corp.org>
   3  * Copyright (c) 2011-2012, SOH Madgwick
   4  *
   5  *  This program is free software: you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation, either version 3 of the License, or
   8  *  (at your option) any later version.
   9  *
  10  *  This program is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 //============================================================================
  21 // MadgwickAHRS.c
  22 //============================================================================
  23 //
  24 // Implementation of Madgwick's IMU and AHRS algorithms.
  25 // See: http://www.x-io.co.uk/node/8#open_source_ahrs_and_imu_algorithms
  26 //
  27 // Date                 Author          Notes
  28 // 29/09/2011   SOH Madgwick    Initial release
  29 // 02/10/2011   SOH Madgwick    Optimised for reduced CPU load
  30 // 19/02/2012   SOH Madgwick    Magnetometer measurement is normalised
  31 //
  32 //============================================================================
  33
  34 #include "MadgwickAHRS.h"
  35 #include <math.h>
  36
  37 /* in Hz, must be synchronized with imu.c callback */
  38 #define sampleFreq      50.0f
  39 #define betaDef         0.1f            // 2 * proportional gain
  40
  41 static float invSqrt(float x)
  42 {
  43         return 1.0f / sqrtf(x);
  44 }
  45
  46 /* AHRS algorithm update */
  47 void MadgwickAHRSupdate(const struct imu_info *imu, struct quaternion *quat)
  48 {
  49         float recipNorm;
  50         float s0, s1, s2, s3;
  51         float qDot1, qDot2, qDot3, qDot4;
  52         float hx, hy;
  53         float _2q0mx, _2q0my, _2q0mz, _2q1mx, _2bx, _2bz, _4bx, _4bz;
  54         float _2q0, _2q1, _2q2, _2q3, _2q0q2, _2q2q3, q0q0, q0q1, q0q2, q0q3;
  55         float q1q1, q1q2, q1q3, q2q2, q2q3, q3q3;
  56         float mx, my, mz, ax, ay, az, gx, gy, gz;
  57         float q0, q1, q2, q3;
  58
  59         /* Use IMU algorithm if magnetometer measurement invalid (avoids NaN in
  60          * magnetometer normalisation) */
  61         if ((imu->mx == 0.0f) && (imu->my == 0.0f) && (imu->mz == 0.0f)) {
  62                 MadgwickAHRSupdateIMU(imu, quat);
  63                 return;
  64         }
  65
  66         /* use local variables, it's more readable */
  67         q0 = quat->q0; q1 = quat->q1; q2 = quat->q2; q3 = quat->q3;
  68         gx = imu->gx; gy = imu->gy; gz = imu->gz;
  69         ax = imu->ax; ay = imu->ay; az = imu->az;
  70         mx = imu->mx; my = imu->my; mz = imu->mz;
  71
  72         /* Rate of change of quaternion from gyroscope */
  73         qDot1 = 0.5f * (-q1 * gx - q2 * gy - q3 * gz);
  74         qDot2 = 0.5f * (q0 * gx + q2 * gz - q3 * gy);
  75         qDot3 = 0.5f * (q0 * gy - q1 * gz + q3 * gx);
  76         qDot4 = 0.5f * (q0 * gz + q1 * gy - q2 * gx);
  77
  78         /* Compute feedback only if accelerometer measurement valid (avoids NaN
  79          * in accelerometer normalisation) */
  80         if (!((ax == 0.0f) && (ay == 0.0f) && (az == 0.0f))) {
  81
  82                 /* Normalise accelerometer measurement */
  83                 recipNorm = invSqrt(ax * ax + ay * ay +
  84                         az * az);
  85                 ax *= recipNorm;
  86                 ay *= recipNorm;
  87                 az *= recipNorm;
  88
  89                 /* Normalise magnetometer measurement */
  90                 recipNorm = invSqrt(mx * mx + my * my +
  91                         mz * mz);
  92                 mx *= recipNorm;
  93                 my *= recipNorm;
  94                 mz *= recipNorm;
  95
  96                 /* Auxiliary variables to avoid repeated arithmetic */
  97                 _2q0mx = 2.0f * q0 * mx;
  98                 _2q0my = 2.0f * q0 * my;
  99                 _2q0mz = 2.0f * q0 * mz;
 100                 _2q1mx = 2.0f * q1 * mx;
 101                 _2q0 = 2.0f * q0;
 102                 _2q1 = 2.0f * q1;
 103                 _2q2 = 2.0f * q2;
 104                 _2q3 = 2.0f * q3;
 105                 _2q0q2 = 2.0f * q0 * q2;
 106                 _2q2q3 = 2.0f * q2 * q3;
 107                 q0q0 = q0 * q0;
 108                 q0q1 = q0 * q1;
 109                 q0q2 = q0 * q2;
 110                 q0q3 = q0 * q3;
 111                 q1q1 = q1 * q1;
 112                 q1q2 = q1 * q2;
 113                 q1q3 = q1 * q3;
 114                 q2q2 = q2 * q2;
 115                 q2q3 = q2 * q3;
 116                 q3q3 = q3 * q3;
 117
 118                 /* Reference direction of Earth's magnetic field */
 119                 hx = mx * q0q0 - _2q0my * q3 + _2q0mz * q2 + mx * q1q1 + _2q1 * my * q2 + _2q1 * mz * q3 - mx * q2q2 - mx * q3q3;
 120                 hy = _2q0mx * q3 + my * q0q0 - _2q0mz * q1 + _2q1mx * q2 - my * q1q1 + my * q2q2 + _2q2 * mz * q3 - my * q3q3;
 121                 _2bx = sqrt(hx * hx + hy * hy);
 122                 _2bz = -_2q0mx * q2 + _2q0my * q1 + mz * q0q0 + _2q1mx * q3 - mz * q1q1 + _2q2 * my * q3 - mz * q2q2 + mz * q3q3;
 123                 _4bx = 2.0f * _2bx;
 124                 _4bz = 2.0f * _2bz;
 125
 126                 /* Gradient decent algorithm corrective step */
 127                 s0 = -_2q2 * (2.0f * q1q3 - _2q0q2 - ax) + _2q1 * (2.0f * q0q1 + _2q2q3 - ay) - _2bz * q2 * (_2bx * (0.5f - q2q2 - q3q3) + _2bz * (q1q3 - q0q2) - mx) + (-_2bx * q3 + _2bz * q1) * (_2bx * (q1q2 - q0q3) + _2bz * (q0q1 + q2q3) - my) + _2bx * q2 * (_2bx * (q0q2 + q1q3) + _2bz * (0.5f - q1q1 - q2q2) - mz);
 128                 s1 = _2q3 * (2.0f * q1q3 - _2q0q2 - ax) + _2q0 * (2.0f * q0q1 + _2q2q3 - ay) - 4.0f * q1 * (1 - 2.0f * q1q1 - 2.0f * q2q2 - az) + _2bz * q3 * (_2bx * (0.5f - q2q2 - q3q3) + _2bz * (q1q3 - q0q2) - mx) + (_2bx * q2 + _2bz * q0) * (_2bx * (q1q2 - q0q3) + _2bz * (q0q1 + q2q3) - my) + (_2bx * q3 - _4bz * q1) * (_2bx * (q0q2 + q1q3) + _2bz * (0.5f - q1q1 - q2q2) - mz);
 129                 s2 = -_2q0 * (2.0f * q1q3 - _2q0q2 - ax) + _2q3 * (2.0f * q0q1 + _2q2q3 - ay) - 4.0f * q2 * (1 - 2.0f * q1q1 - 2.0f * q2q2 - az) + (-_4bx * q2 - _2bz * q0) * (_2bx * (0.5f - q2q2 - q3q3) + _2bz * (q1q3 - q0q2) - mx) + (_2bx * q1 + _2bz * q3) * (_2bx * (q1q2 - q0q3) + _2bz * (q0q1 + q2q3) - my) + (_2bx * q0 - _4bz * q2) * (_2bx * (q0q2 + q1q3) + _2bz * (0.5f - q1q1 - q2q2) - mz);
 130                 s3 = _2q1 * (2.0f * q1q3 - _2q0q2 - ax) + _2q2 * (2.0f * q0q1 + _2q2q3 - ay) + (-_4bx * q3 + _2bz * q1) * (_2bx * (0.5f - q2q2 - q3q3) + _2bz * (q1q3 - q0q2) - mx) + (-_2bx * q0 + _2bz * q2) * (_2bx * (q1q2 - q0q3) + _2bz * (q0q1 + q2q3) - my) + _2bx * q1 * (_2bx * (q0q2 + q1q3) + _2bz * (0.5f - q1q1 - q2q2) - mz);
 131
 132                 /* normalize step magnitude */
 133                 recipNorm = invSqrt(s0 * s0 + s1 * s1 + s2 * s2 + s3 * s3);
 134                 s0 *= recipNorm;
 135                 s1 *= recipNorm;
 136                 s2 *= recipNorm;
 137                 s3 *= recipNorm;
 138
 139                 /* Apply feedback step */
 140                 qDot1 -= betaDef * s0;
 141                 qDot2 -= betaDef * s1;
 142                 qDot3 -= betaDef * s2;
 143                 qDot4 -= betaDef * s3;
 144         }
 145
 146         /* Integrate rate of change of quaternion to yield quaternion */
 147         q0 += qDot1 * (1.0f / sampleFreq);
 148         q1 += qDot2 * (1.0f / sampleFreq);
 149         q2 += qDot3 * (1.0f / sampleFreq);
 150         q3 += qDot4 * (1.0f / sampleFreq);
 151
 152         /* Normalise quaternion */
 153         recipNorm = invSqrt(q0 * q0 + q1 * q1 + q2 * q2 + q3 * q3);
 154         q0 *= recipNorm;
 155         q1 *= recipNorm;
 156         q2 *= recipNorm;
 157         q3 *= recipNorm;
 158
 159         /* update quaternion in structure */
 160         quat->q0 = q0;
 161         quat->q1 = q1;
 162         quat->q2 = q2;
 163         quat->q3 = q3;
 164 }
 165
 166 /* IMU algorithm update (does not take magneto in account) */
 167 void MadgwickAHRSupdateIMU(const struct imu_info *imu, struct quaternion *quat)
 168 {
 169         float recipNorm;
 170         float s0, s1, s2, s3;
 171         float qDot1, qDot2, qDot3, qDot4;
 172         float _2q0, _2q1, _2q2, _2q3, _4q0, _4q1, _4q2 ,_8q1, _8q2, q0q0, q1q1, q2q2, q3q3;
 173         float ax, ay, az, gx, gy, gz;
 174         float q0, q1, q2, q3;
 175
 176         /* use local variables, it's more readable */
 177         q0 = quat->q0; q1 = quat->q1; q2 = quat->q2; q3 = quat->q3;
 178         gx = imu->gx; gy = imu->gy; gz = imu->gz;
 179         ax = imu->ax; ay = imu->ay; az = imu->az;
 180
 181         /* Rate of change of quaternion from gyroscope */
 182         qDot1 = 0.5f * (-q1 * gx - q2 * gy - q3 * gz);
 183         qDot2 = 0.5f * (q0 * gx + q2 * gz - q3 * gy);
 184         qDot3 = 0.5f * (q0 * gy - q1 * gz + q3 * gx);
 185         qDot4 = 0.5f * (q0 * gz + q1 * gy - q2 * gx);
 186
 187
 188         /* Compute feedback only if accelerometer measurement valid (avoids NaN in accelerometer normalisation) */
 189         if(!((ax == 0.0f) && (ay == 0.0f) && (az == 0.0f))) {
 190
 191                 /* Normalise accelerometer measurement */
 192                 recipNorm = invSqrt(ax * ax + ay * ay + az * az);
 193                 ax *= recipNorm;
 194                 ay *= recipNorm;
 195                 az *= recipNorm;
 196
 197                 /* Auxiliary variables to avoid repeated arithmetic */
 198                 _2q0 = 2.0f * q0;
 199                 _2q1 = 2.0f * q1;
 200                 _2q2 = 2.0f * q2;
 201                 _2q3 = 2.0f * q3;
 202                 _4q0 = 4.0f * q0;
 203                 _4q1 = 4.0f * q1;
 204                 _4q2 = 4.0f * q2;
 205                 _8q1 = 8.0f * q1;
 206                 _8q2 = 8.0f * q2;
 207                 q0q0 = q0 * q0;
 208                 q1q1 = q1 * q1;
 209                 q2q2 = q2 * q2;
 210                 q3q3 = q3 * q3;
 211
 212                 /* Gradient decent algorithm corrective step */
 213                 s0 = _4q0 * q2q2 + _2q2 * ax + _4q0 * q1q1 - _2q1 * ay;
 214                 s1 = _4q1 * q3q3 - _2q3 * ax + 4.0f * q0q0 * q1 - _2q0 * ay - _4q1 + _8q1 * q1q1 + _8q1 * q2q2 + _4q1 * az;
 215                 s2 = 4.0f * q0q0 * q2 + _2q0 * ax + _4q2 * q3q3 - _2q3 * ay - _4q2 + _8q2 * q1q1 + _8q2 * q2q2 + _4q2 * az;
 216                 s3 = 4.0f * q1q1 * q3 - _2q1 * ax + 4.0f * q2q2 * q3 - _2q2 * ay;
 217                 recipNorm = invSqrt(s0 * s0 + s1 * s1 + s2 * s2 + s3 * s3); /* normalise step magnitude */
 218
 219                 s0 *= recipNorm;
 220                 s1 *= recipNorm;
 221                 s2 *= recipNorm;
 222                 s3 *= recipNorm;
 223
 224                 /* Apply feedback step */
 225                 qDot1 -= betaDef * s0;
 226                 qDot2 -= betaDef * s1;
 227                 qDot3 -= betaDef * s2;
 228                 qDot4 -= betaDef * s3;
 229         }
 230
 231         /* Integrate rate of change of quaternion to yield quaternion */
 232         q0 += qDot1 * (1.0f / sampleFreq);
 233         q1 += qDot2 * (1.0f / sampleFreq);
 234         q2 += qDot3 * (1.0f / sampleFreq);
 235         q3 += qDot4 * (1.0f / sampleFreq);
 236
 237         /* Normalise quaternion */
 238         recipNorm = invSqrt(q0 * q0 + q1 * q1 +
 239                 q2 * q2 + q3 * q3);
 240         q0 *= recipNorm;
 241         q1 *= recipNorm;
 242         q2 *= recipNorm;
 243         q3 *= recipNorm;
 244
 245         /* update quaternion in structure */
 246         quat->q0 = q0;
 247         quat->q1 = q1;
 248         quat->q2 = q2;
 249         quat->q3 = q3;
 250 }
 251