MadgwickAHRS.c

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