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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
/// All possible errors in this crate #[derive(Debug)] pub enum Error<E> { /// I²C bus error I2C(E), /// Invalid setting for the current configuration InvalidSetting, /// Error occured during self-test SelfTestError, } /// Measurement resolution #[derive(Debug, Clone, Copy, PartialEq)] pub enum Resolution { /// 8-bit resolution. Low, /// 12-bit/14-bit resolution. High, } /// KXCJ9-1008 G scale (up to +/-8g) #[derive(Debug, Clone, Copy, PartialEq)] pub enum GScale8 { /// Range: +/-2g G2, /// Range: +/-4g G4, /// Range: +/-8g G8, /// Range: +/-8g Full Power (selects 14-bit resolution) G8FP, } /// KXCJ9-1018 G scale (up to +/-16g) #[derive(Debug, Clone, Copy, PartialEq)] pub enum GScale16 { /// Range: +/-4g G4, /// Range: +/-8g G8, /// Range: +/-16g G16, /// Range: +/-16g Full Power (selects 14-bit resolution) G16FP, } /// Output data rate #[derive(Debug, Clone, Copy, PartialEq)] pub enum OutputDataRate { /// 0.781 Hz Hz0_781, /// 1.563 Hz Hz1_563, /// 3.125 Hz Hz3_125, /// 6.25 Hz Hz6_25, /// 12.5 Hz Hz12_5, /// 25 Hz Hz25, /// 50 Hz (default) Hz50, /// 100 Hz Hz100, /// 200 Hz Hz200, /// 400 Hz (Forces device into full power mode) Hz400, /// 800 Hz (Forces device into full power mode) Hz800, /// 1600 Hz (Forces device into full power mode) Hz1600, } /// Acceleration measurement scaled to configured G range #[derive(Debug, Default, Clone)] pub struct Measurement { /// X-axis acceleration. pub x: f32, /// Y-axis acceleration. pub y: f32, /// Z-axis acceleration. pub z: f32, } /// Unscaled acceleration measurement #[derive(Debug, Default, Clone, PartialEq)] pub struct UnscaledMeasurement { /// X-axis acceleration. pub x: i16, /// Y-axis acceleration. pub y: i16, /// Z-axis acceleration. pub z: i16, } /// Interrupt source information #[derive(Debug, Default, Clone, PartialEq)] pub struct InterruptInfo { /// New acceleration data is available pub data_ready: bool, /// Wake-up motion detected pub wake_up: bool, /// Wake-up X-axis negative direction motion detected pub wake_up_x_negative: bool, /// Wake-up X-axis positive direction motion detected pub wake_up_x_positive: bool, /// Wake-up Y-axis negative direction motion detected pub wake_up_y_negative: bool, /// Wake-up Y-axis positive direction motion detected pub wake_up_y_positive: bool, /// Wake-up Z-axis negative direction motion detected pub wake_up_z_negative: bool, /// Wake-up Z-axis positive direction motion detected pub wake_up_z_positive: bool, } /// Wake-up interrupt configuration #[derive(Debug, Clone, Copy)] pub struct WakeUpInterruptConfig { /// Motion that triggers the wake-up interrupt. pub trigger_motion: WakeUpTriggerMotion, /// Data rate used for checking on the wake-up motion. pub data_rate: WakeUpOutputDataRate, /// Number of faults necessary to trigger a wake-up interrupt. /// /// Each count accounts for a delay of `1/data_rate`. /// The minimum value is 1. Configuring with `fault_count = 0` /// will return an `Error::InvalidSetting`. pub fault_count: u8, /// Wake-up acceleration change threshold in G. /// /// This will be scaled internally and has a maximum of 8g for /// the KXCJ9-1008 and KCXJB devices and 16g for the KXCJ9-1018 device. /// This value must be positive and the comparison is done /// for each axis separately (including negative axes) pub threshold: f32, } impl Default for WakeUpInterruptConfig { fn default() -> Self { WakeUpInterruptConfig { trigger_motion: WakeUpTriggerMotion::default(), data_rate: WakeUpOutputDataRate::default(), fault_count: 1, threshold: 0.5, } } } /// Wake-up interrupt trigger motion #[derive(Debug, Clone, Copy)] pub struct WakeUpTriggerMotion { /// Enable wake-up interrupt on X-axis negative direction motion detected pub x_negative: bool, /// Enable wake-up interrupt on X-axis positive direction motion detected pub x_positive: bool, /// Enable wake-up interrupt on Y-axis negative direction motion detected pub y_negative: bool, /// Enable wake-up interrupt on Y-axis positive direction motion detected pub y_positive: bool, /// Enable wake-up interrupt on Z-axis negative direction motion detected pub z_negative: bool, /// Enable wake-up interrupt on Z-axis positive direction motion detected pub z_positive: bool, } impl Default for WakeUpTriggerMotion { fn default() -> Self { WakeUpTriggerMotion { x_negative: true, x_positive: true, y_negative: true, y_positive: true, z_negative: true, z_positive: true, } } } /// Output data rate for wake-up motion detection #[derive(Debug, Clone, Copy, PartialEq)] pub enum WakeUpOutputDataRate { /// 0.781 Hz (default) Hz0_781, /// 1.563 Hz Hz1_563, /// 3.125 Hz Hz3_125, /// 6.25 Hz Hz6_25, /// 12.5 Hz Hz12_5, /// 25 Hz Hz25, /// 50 Hz Hz50, /// 100 Hz Hz100, } impl Default for WakeUpOutputDataRate { fn default() -> Self { WakeUpOutputDataRate::Hz0_781 } } /// Physical interrupt pin polarity #[derive(Debug, Clone, Copy, PartialEq)] pub enum InterruptPinPolarity { /// Low state when active ActiveLow, /// High state when active (default) ActiveHigh, } /// Physical interrupt pin latching behavior #[derive(Debug, Clone, Copy, PartialEq)] pub enum InterruptPinLatching { /// Interrupt pin will transmit a single pulse with a period /// of `0.03ms - 0.05ms` when triggered. NonLatching, /// Interrupt pin stays active until cleared with `clear_interrupts()`. (default) Latching, } /// Possible slave addresses #[derive(Debug, Clone, Copy)] pub enum SlaveAddr { /// Default slave address Default, /// Alternative slave address providing bit value for A0 Alternative(bool), } impl Default for SlaveAddr { /// Default slave address fn default() -> Self { SlaveAddr::Default } } impl SlaveAddr { pub(crate) fn addr(self, default: u8) -> u8 { match self { SlaveAddr::Default => default, SlaveAddr::Alternative(a0) => default | a0 as u8, } } } #[cfg(test)] mod tests { use super::*; use DEVICE_BASE_ADDRESS as BASE_ADDR; #[test] fn can_get_default_address() { let addr = SlaveAddr::default(); assert_eq!(BASE_ADDR, addr.addr(BASE_ADDR)); } #[test] fn can_generate_alternative_addresses() { assert_eq!(0b000_1110, SlaveAddr::Alternative(false).addr(BASE_ADDR)); assert_eq!(0b000_1111, SlaveAddr::Alternative(true).addr(BASE_ADDR)); } }