MAV'RIC
ahrs.h
1 /*******************************************************************************
2  * Copyright (c) 2009-2014, MAV'RIC Development Team
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice,
9  * this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors
16  * may be used to endorse or promote products derived from this software without
17  * specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  ******************************************************************************/
31 
32 /*******************************************************************************
33  * \file ahrs.h
34  *
35  * \author MAV'RIC Team
36  * \author Gregoire Heitz
37  *
38  * \brief This file implements data structure for attitude estimate
39  *
40  ******************************************************************************/
41 
42 
43 #ifndef AHRS_H_
44 #define AHRS_H_
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 #include <stdint.h>
51 #include <stdbool.h>
52 #include "quaternions.h"
53 
54 
58 typedef struct
59 {
61 
62  float angular_speed[3];
63  float linear_acc[3];
64 
65  float heading;
68 
69  uint32_t last_update;
70  float dt;
71 } ahrs_t;
72 
76 typedef struct
77 {
78  int32_t x;
79  int32_t y;
80  int32_t z;
82 
91 bool ahrs_init(ahrs_t* ahrs, ahrs_config_t* config);
92 
93 
94 #ifdef __cplusplus
95 }
96 #endif
97 
98 #endif /* AHRS_H_ */
Structure containing the Attitude and Heading Reference System.
Definition: ahrs.h:58
float heading
The heading of the platform.
Definition: ahrs.h:65
int32_t x
The mapping for the X axis.
Definition: ahrs.h:78
quat_t up_vec
The quaternion of the up vector.
Definition: ahrs.h:66
quat_t north_vec
The quaternion of the north vector.
Definition: ahrs.h:67
int32_t z
The mapping for the Z axis.
Definition: ahrs.h:80
int32_t y
The mapping for the Y axis.
Definition: ahrs.h:79
Unit quaternion.
Definition: quaternions.h:62
quat_t qe
quaternion defining the Attitude estimation of the platform
Definition: ahrs.h:60
uint32_t last_update
The time of the last IMU update in ms.
Definition: ahrs.h:69
float dt
The time interval between two IMU updates.
Definition: ahrs.h:70
Configuration for the AHRS structure.
Definition: ahrs.h:76