sensor-fusion 0.1.1

Sensor Fusion Filters for Attitude and Heading Reference Systems (AHRS)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

//#![allow(unused)]

use vqm::{Quaternion, Quaternionf32, Vector3d, Vector3df32};

/// Common interface for the sensor fusion filters (Madgwick, Mahony, complementary).
/// ```
/// use vqm::{Vector3df32,Quaternionf32};
/// use sensor_fusion::{MadgwickFilterf32,SensorFusion};
///
/// let mut madgwick_filter = MadgwickFilterf32::default();
///
/// let delta_t: f32 = 0.0;
/// let acc = Vector3df32::default();
/// let gyro_rps = Vector3df32::default();
///
/// let orientation = madgwick_filter.fuse_acc_gyro(acc, gyro_rps, delta_t);
/// assert_eq!(orientation, Quaternionf32 { w: 1.0, x: 0.0, y: 0.0, z: 0.0 });
/// ```
pub trait SensorFusion<T> {
    fn set_gains(&mut self, gain0: T, gain1: T);
    fn requires_initialization() -> bool;

    fn fuse_acc_gyro(&mut self, acc: Vector3d<T>, gyro_rps: Vector3d<T>, delta_t: T) -> Quaternion<T>;
    fn fuse_acc_gyro_mag(&mut self, acc: Vector3d<T>, gyro: Vector3d<T>, mag: Vector3d<T>, delta_t: T)
    -> Quaternion<T>;
}

#[allow(unused)]
pub trait SensorFusionf32 {
    fn set_gains(&mut self, gain0: f32, gain1: f32);
    fn requires_initialization() -> bool;

    fn fuse_acc_gyro(&mut self, acc: Vector3df32, gyro_rps: Vector3df32, delta_t: f32) -> Quaternionf32;
    fn fuse_acc_gyro_mag(
        &mut self,
        acc: Vector3df32,
        gyro: Vector3df32,
        mag: Vector3df32,
        delta_t: f32,
    ) -> Quaternionf32;
}

#[allow(clippy::doc_paragraphs_missing_punctuation)]
/// Trait to allow sensor fusion filters to be used with method-call syntax, ie:<br>
/// `let orientation = (acc, gyro_rps).fuse_acc_gyro_using(&mut madgwick, dt);`
/// ```
/// use vqm::{Vector3df32,Quaternionf32};
/// use sensor_fusion::{MadgwickFilterf32,SensorFusion,FuseAccGyro};
///
/// let mut madgwick_filter = MadgwickFilterf32::default();
///
/// let delta_t: f32 = 0.0;
/// let acc = Vector3df32::default();
/// let gyro_rps = Vector3df32::default();
///
/// let orientation = (acc, gyro_rps).fuse_acc_gyro_using(&mut madgwick_filter, delta_t);
/// assert_eq!(orientation, Quaternionf32 { w: 1.0, x: 0.0, y: 0.0, z: 0.0 });
/// ```
pub trait FuseAccGyro<T> {
    fn fuse_acc_gyro_using<F: SensorFusion<T>>(self, filter: &mut F, delta_t: T) -> Quaternion<T>;
}

impl<T> FuseAccGyro<T> for (Vector3d<T>, Vector3d<T>) {
    fn fuse_acc_gyro_using<F: SensorFusion<T>>(self, filter: &mut F, delta_t: T) -> Quaternion<T> {
        let (acc, gyro) = self;
        filter.fuse_acc_gyro(acc, gyro, delta_t)
    }
}

#[allow(clippy::doc_paragraphs_missing_punctuation)]
/// Trait to allow sensor fusion filters to be used with method-call syntax, ie:<br>
/// `let orientation = (acc, gyro_rps).fuse_acc_gyro_using(&mut madgwick, dt);`
/// ```
/// use vqm::{Vector3df32,Quaternionf32};
/// use sensor_fusion::{MadgwickFilterf32,SensorFusion,FuseAccGyroMag};
///
/// let mut madgwick_filter = MadgwickFilterf32::default();
///
/// let delta_t: f32 = 0.0;
/// let acc = Vector3df32::default();
/// let gyro_rps = Vector3df32::default();
/// let mag = Vector3df32::default();
///
/// let orientation = (acc, gyro_rps, mag).fuse_acc_gyro_mag_using(&mut madgwick_filter, delta_t);
/// assert_eq!(orientation, Quaternionf32 { w: 1.0, x: 0.0, y: 0.0, z: 0.0 });
/// ```
pub trait FuseAccGyroMag<T> {
    fn fuse_acc_gyro_mag_using<F: SensorFusion<T>>(self, sensor_fusion_filter: &mut F, delta_t: T) -> Quaternion<T>;
}

impl<T> FuseAccGyroMag<T> for (Vector3d<T>, Vector3d<T>, Vector3d<T>) {
    fn fuse_acc_gyro_mag_using<F: SensorFusion<T>>(self, sensor_fusion_filter: &mut F, delta_t: T) -> Quaternion<T> {
        let (acc, gyro, mag) = self;
        sensor_fusion_filter.fuse_acc_gyro_mag(acc, gyro, mag, delta_t)
    }
}

/*
/// Calculate quaternion derivative (dq/dt aka q_dot) from angular rate <https://ahrs.readthedocs.io/en/latest/filters/angular.html#quaternion-derivative>
pub fn q_dot<T>(q: Quaternion<T>, gyro_rps: Vector3d<T>) -> Quaternion<T>
where
    T: Copy + One + Neg<Output = T> + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Div<Output = T>,
{
    let half = T::one() / (T::one() + T::one());
    Quaternion {
        w: (-q.x * gyro_rps.x - q.y * gyro_rps.y - q.z * gyro_rps.z) * half,
        x: (q.w * gyro_rps.x + q.y * gyro_rps.z - q.z * gyro_rps.y) * half,
        y: (q.w * gyro_rps.y - q.x * gyro_rps.z + q.z * gyro_rps.x) * half,
        z: (q.w * gyro_rps.z + q.x * gyro_rps.y - q.y * gyro_rps.x) * half,
    }
}*/

#[cfg(any(debug_assertions, test))]
mod tests {
    #![allow(clippy::wildcard_imports)]
    use super::*;
    use vqm::Vector3df32;

    #[allow(dead_code)]
    pub struct TestStruct;
    impl SensorFusion<f32> for TestStruct {
        fn set_gains(&mut self, _gain0: f32, _gain1: f32) {}
        fn requires_initialization() -> bool {
            true
        }
        fn fuse_acc_gyro(&mut self, _acc: Vector3df32, _gyro_rps: Vector3df32, _delta_t: f32) -> Quaternionf32 {
            Quaternionf32::default()
        }
        fn fuse_acc_gyro_mag(
            &mut self,
            acc: Vector3df32,
            gyro_rps: Vector3df32,
            _mag: Vector3df32,
            delta_t: f32,
        ) -> Quaternionf32 {
            self.fuse_acc_gyro(acc, gyro_rps, delta_t)
        }
    }

    //#[allow(dead_code)]
    #[test]
    fn sensor_fusion() {
        let mut test_struct: TestStruct = TestStruct {};
        _ = TestStruct::requires_initialization();
        //assert_eq!(TestStruct::requires_initialization(), true);

        test_struct.set_gains(0.0, 0.0);

        let delta_t: f32 = 0.0;
        let acc = Vector3df32::default();
        let gyro_rps = Vector3df32::default();

        let orientation = test_struct.fuse_acc_gyro(acc, gyro_rps, delta_t);
        assert_eq!(orientation, Quaternion::default());
    }

    #[test]
    fn fuse_using() {
        use crate::MadgwickFilterf32;

        let mut madgwick_filter = MadgwickFilterf32::default();
        let requires_initialization = MadgwickFilterf32::requires_initialization();
        assert!(requires_initialization);

        madgwick_filter.set_beta(1.0);

        let delta_t: f32 = 0.0;
        let acc = Vector3df32::default();
        let gyro_rps = Vector3df32::default();

        //let orientation = madgwick_filter.fuse_acc_gyro(acc, gyro_rps, delta_t);
        let orientation = (acc, gyro_rps).fuse_acc_gyro_using(&mut madgwick_filter, delta_t);
        assert_eq!(orientation, Quaternion { w: 1.0, x: 0.0, y: 0.0, z: 0.0 });
    }
}