src/main/flight/imu.h

   1 /*
   2  * This file is part of Cleanflight and Betaflight.
   3  *
   4  * Cleanflight and Betaflight are free software. You can redistribute
   5  * this software and/or modify this software under the terms of the
   6  * GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * Cleanflight and Betaflight are distributed in the hope that they
  11  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  12  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13  * See the 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 software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #pragma once
  22
  23 #include "common/axis.h"
  24 #include "common/time.h"
  25 #include "common/maths.h"
  26 #include "common/vector.h"
  27
  28 #include "pg/pg.h"
  29
  30 // Exported symbols
  31 extern bool canUseGPSHeading;
  32
  33 typedef union {
  34     float v[4];
  35     struct {
  36         float w, x, y, z;
  37     };
  38 } quaternion_t;
  39 #define QUATERNION_INITIALIZE  {.w=1, .x=0, .y=0,.z=0}
  40
  41 typedef struct {
  42     float ww,wx,wy,wz,xx,xy,xz,yy,yz,zz;
  43 } quaternionProducts;
  44 #define QUATERNION_PRODUCTS_INITIALIZE  {.ww=1, .wx=0, .wy=0, .wz=0, .xx=0, .xy=0, .xz=0, .yy=0, .yz=0, .zz=0}
  45
  46 typedef union {
  47     int16_t raw[XYZ_AXIS_COUNT];
  48     struct {
  49         // absolute angle inclination in multiple of 0.1 degree  eg attitude.values.yaw 180 deg = 1800
  50         int16_t roll;
  51         int16_t pitch;
  52         int16_t yaw;
  53     } values;
  54 } attitudeEulerAngles_t;
  55 #define EULER_INITIALIZE  { { 0, 0, 0 } }
  56
  57 extern attitudeEulerAngles_t attitude;
  58 extern matrix33_t rMat;
  59 extern quaternion_t imuAttitudeQuaternion; //attitude quaternion to use in blackbox
  60
  61 typedef struct imuConfig_s {
  62     uint16_t imu_dcm_kp;          // DCM filter proportional gain ( x 10000)
  63     uint16_t imu_dcm_ki;          // DCM filter integral gain ( x 10000)
  64     uint8_t small_angle;
  65     uint8_t imu_process_denom;
  66     uint16_t mag_declination;     // Magnetic declination in degrees * 10
  67 } imuConfig_t;
  68
  69 PG_DECLARE(imuConfig_t, imuConfig);
  70
  71 typedef struct imuRuntimeConfig_s {
  72     float imuDcmKi;
  73     float imuDcmKp;
  74 } imuRuntimeConfig_t;
  75
  76 void imuConfigure(uint16_t throttle_correction_angle, uint8_t throttle_correction_value);
  77
  78 float getSinPitchAngle(void);
  79 float getCosTiltAngle(void);
  80 void getQuaternion(quaternion_t * q);
  81 void imuUpdateAttitude(timeUs_t currentTimeUs);
  82
  83 void imuInit(void);
  84
  85 #ifdef SIMULATOR_BUILD
  86 void imuSetAttitudeRPY(float roll, float pitch, float yaw);  // in deg
  87 void imuSetAttitudeQuat(float w, float x, float y, float z);
  88 #if defined(SIMULATOR_IMU_SYNC)
  89 void imuSetHasNewData(uint32_t dt);
  90 #endif
  91 #endif
  92
  93 bool imuQuaternionHeadfreeOffsetSet(void);
  94 void imuQuaternionHeadfreeTransformVectorEarthToBody(vector3_t *v);
  95 bool shouldInitializeGPSHeading(void);
  96 bool isUpright(void);