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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
use embedded_hal::delay::DelayNs;

use crate::{
    interface::{ReadData, WriteData},
    register_address::{CtrlReg1A, CtrlReg4A},
    AccelMode, AccelOutputDataRate, AccelScale, Error, Lsm303agr,
};

impl<DI, CommE, MODE> Lsm303agr<DI, MODE>
where
    DI: ReadData<Error = Error<CommE>> + WriteData<Error = Error<CommE>>,
{
    /// Set accelerometer power/resolution mode and output data rate.
    ///
    /// Returns `Error::InvalidInputData` if the mode is incompatible with
    /// the given output data rate.
    ///
    #[doc = include_str!("delay.md")]
    pub fn set_accel_mode_and_odr<D: DelayNs>(
        &mut self,
        delay: &mut D,
        mode: AccelMode,
        odr: impl Into<Option<AccelOutputDataRate>>,
    ) -> Result<(), Error<CommE>> {
        let odr = odr.into();

        check_accel_odr_is_compatible_with_mode(odr, mode)?;

        let old_mode = self.get_accel_mode();

        let mut reg1 = self.ctrl_reg1_a.difference(CtrlReg1A::ODR);

        if let Some(odr) = odr {
            reg1 = reg1.with_odr(odr);
        }

        let reg1 = if mode == AccelMode::LowPower {
            reg1.union(CtrlReg1A::LPEN)
        } else {
            reg1.difference(CtrlReg1A::LPEN)
        };

        let reg4 = self.ctrl_reg4_a.difference(CtrlReg4A::HR);

        if mode != AccelMode::HighResolution {
            self.iface.write_accel_register(reg4)?;
            self.ctrl_reg4_a = reg4;
        }

        self.iface.write_accel_register(reg1)?;
        self.ctrl_reg1_a = reg1;
        self.accel_odr = odr;

        if mode == AccelMode::HighResolution {
            let reg4 = reg4.union(CtrlReg4A::HR);
            self.iface.write_accel_register(reg4)?;
            self.ctrl_reg4_a = reg4;
        }

        if let Some(odr) = self.accel_odr {
            let change_time = old_mode.change_time_us(mode, odr);
            delay.delay_us(change_time);
        }

        Ok(())
    }

    /// Get the accelerometer mode
    pub fn get_accel_mode(&mut self) -> AccelMode {
        let power_down = self.ctrl_reg1_a.intersection(CtrlReg1A::ODR).is_empty();
        let lp_enabled = self.ctrl_reg1_a.contains(CtrlReg1A::LPEN);
        let hr_enabled = self.ctrl_reg4_a.contains(CtrlReg4A::HR);

        if power_down {
            AccelMode::PowerDown
        } else if hr_enabled {
            AccelMode::HighResolution
        } else if lp_enabled {
            AccelMode::LowPower
        } else {
            AccelMode::Normal
        }
    }

    /// Set accelerometer scaling factor
    ///
    /// This changes the scale at which the acceleration is read.
    /// `AccelScale::G2` for example can return values between -2g and +2g
    /// where g is the gravity of the earth (~9.82 m/s²).
    pub fn set_accel_scale(&mut self, scale: AccelScale) -> Result<(), Error<CommE>> {
        let reg4 = self.ctrl_reg4_a.with_scale(scale);
        self.iface.write_accel_register(reg4)?;
        self.ctrl_reg4_a = reg4;
        Ok(())
    }

    /// Get accelerometer scaling factor
    pub fn get_accel_scale(&self) -> AccelScale {
        self.ctrl_reg4_a.scale()
    }
}

fn check_accel_odr_is_compatible_with_mode<CommE>(
    odr: Option<AccelOutputDataRate>,
    mode: AccelMode,
) -> Result<(), Error<CommE>> {
    match (odr, mode) {
        (None, AccelMode::PowerDown) => Ok(()),
        (None, _) => Err(Error::InvalidInputData),
        (Some(odr), mode) => match (odr, mode) {
            (AccelOutputDataRate::Khz1_344, AccelMode::LowPower)
            | (
                AccelOutputDataRate::Khz1_620LowPower | AccelOutputDataRate::Khz5_376LowPower,
                AccelMode::Normal | AccelMode::HighResolution,
            ) => Err(Error::InvalidInputData),
            _ => Ok(()),
        },
    }
}

#[cfg(test)]
mod accel_odr_mode_tests {
    use super::check_accel_odr_is_compatible_with_mode;
    use super::AccelMode;
    use crate::AccelOutputDataRate as ODR;

    macro_rules! compatible {
        ($odr:ident, $power:ident) => {
            check_accel_odr_is_compatible_with_mode::<()>(Some(ODR::$odr), AccelMode::$power)
                .unwrap();
        };
    }

    macro_rules! not_compatible {
        ($odr:ident, $power:ident) => {
            check_accel_odr_is_compatible_with_mode::<()>(Some(ODR::$odr), AccelMode::$power)
                .expect_err("Should have returned error");
        };
    }

    macro_rules! none_odr_compatible {
        ($power:ident) => {
            check_accel_odr_is_compatible_with_mode::<()>(None, AccelMode::$power).unwrap();
        };
    }

    macro_rules! not_none_odr_compatible {
        ($power:ident) => {
            check_accel_odr_is_compatible_with_mode::<()>(None, AccelMode::$power)
                .expect_err("Shout not be compatible");
        };
    }

    #[test]
    fn all_modes_are_compatible_with_powerdown() {
        compatible!(Hz1, PowerDown);
        compatible!(Hz10, PowerDown);
        compatible!(Hz25, PowerDown);
        compatible!(Hz50, PowerDown);
        compatible!(Hz100, PowerDown);
        compatible!(Hz200, PowerDown);
        compatible!(Hz400, PowerDown);
        compatible!(Khz1_620LowPower, PowerDown);
        compatible!(Khz5_376LowPower, PowerDown);
        compatible!(Khz1_344, PowerDown);
    }

    #[test]
    fn normal_mode_compatibility() {
        compatible!(Hz1, Normal);
        compatible!(Hz10, Normal);
        compatible!(Hz25, Normal);
        compatible!(Hz50, Normal);
        compatible!(Hz100, Normal);
        compatible!(Hz200, Normal);
        compatible!(Hz400, Normal);
        not_compatible!(Khz1_620LowPower, Normal);
        not_compatible!(Khz5_376LowPower, Normal);
        compatible!(Khz1_344, Normal);
    }

    #[test]
    fn high_resolution_mode_compatibility() {
        compatible!(Hz1, HighResolution);
        compatible!(Hz10, HighResolution);
        compatible!(Hz25, HighResolution);
        compatible!(Hz50, HighResolution);
        compatible!(Hz100, HighResolution);
        compatible!(Hz200, HighResolution);
        compatible!(Hz400, HighResolution);
        not_compatible!(Khz1_620LowPower, HighResolution);
        not_compatible!(Khz5_376LowPower, HighResolution);
        compatible!(Khz1_344, HighResolution);
    }

    #[test]
    fn low_power_mode_compatibility() {
        compatible!(Hz1, LowPower);
        compatible!(Hz10, LowPower);
        compatible!(Hz25, LowPower);
        compatible!(Hz50, LowPower);
        compatible!(Hz100, LowPower);
        compatible!(Hz200, LowPower);
        compatible!(Hz400, LowPower);
        compatible!(Khz1_620LowPower, LowPower);
        compatible!(Khz5_376LowPower, LowPower);
        not_compatible!(Khz1_344, LowPower);
    }

    #[test]
    fn none_odr_compatibility() {
        not_none_odr_compatible!(LowPower);
        not_none_odr_compatible!(Normal);
        not_none_odr_compatible!(HighResolution);
        none_odr_compatible!(PowerDown);
    }
}