bmi160 1.1.0

Platform-agnostic Rust driver for the BMI160 inertial measurement unit (IMU).
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

//! This is a platform agnostic Rust driver for the BMI160
//! inertial measurement unit using the [`embedded-hal`] traits.
//!
//! [`embedded-hal`]: https://github.com/rust-embedded/embedded-hal
//!
//! This driver allows you to:
//! - Get the latest sensor data. See: [`data()`].
//! - Set the accelerometer, gyroscope and magnetometer power mode. See: [`set_accel_power_mode()`].
//! - Get the sensor status. See: [`status()`].
//! - Get power mode. See: [`power_mode()`].
//! - Get chip ID. See: [`chip_id()`].
//!
//! [`data()`]: struct.Bmi160.html#method.data
//! [`set_accel_power_mode()`]: struct.Bmi160.html#method.set_accel_power_mode
//! [`status()`]: struct.Bmi160.html#method.status
//! [`power_mode()`]: struct.Bmi160.html#method.power_mode
//! [`chip_id()`]: struct.Bmi160.html#method.chip_id
//!
//! <!-- TODO
//! [Introductory blog post](TODO)
//! -->
//!
//! ## The devices
//!
//! The BMI160 is an inertial measurement unit (IMU) consisting of a
//! state-of-the-art 3-axis, low-g accelerometer and a low power 3-axis
//! gyroscope. It has been designed for low power, high precision 6-axis and
//! 9-axis applications in mobile phones, tablets, wearable devices, remote
//! controls, game controllers, head-mounted devices and toys.
//!
//! The BMI160 is available in a compact 14-pin 2.5 × 3.0 × 0.83 mm3 LGA
//! package. When accelerometer and gyroscope are in full operation mode, power
//! consumption is typically 925 μA, enabling always-on applications in
//! battery driven devices.
//!
//! Further Bosch Sensortec sensors, e.g. geomagnetic (BMM150) can be connected
//! as slave via a secondary I2C interface. In this configuration, the BMI160
//! controls the data acquisition of the external sensor and the synchronized
//! data of all sensors is stored the register data and can be additionally
//! stored in the built-in FIFO.
//!
//! Besides the flexible primary interface (I2C or SPI) that is used to connect
//! to the host, BMI160 provides an additional secondary interface. This
//! secondary interface can be used in SPI mode for OIS (optical image
//! stabilization) applications in conjunction with camera modules, or in
//! advanced gaming use cases.
//!
//! [Datasheet](https://www.bosch-sensortec.com/media/boschsensortec/downloads/datasheets/bst-bmi160-ds000.pdf)
//!
//! ## Usage examples (see also examples folder)
//!
//! To use this driver, import this crate and an `embedded_hal` implementation,
//! then create an instance of the driver either in I2C or SPI mode.
//!
//! Please find additional examples using hardware in this repository: [driver-examples]
//!
//! [driver-examples]: https://github.com/eldruin/driver-examples
//!
//! ### Create an instance of the driver in I2C mode and print the chip id
//!
//! ```no_run
//! extern crate linux_embedded_hal as hal;
//! use bmi160::{Bmi160, SlaveAddr};
//!
//! # fn main() {
//! let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
//! let address = SlaveAddr::default();
//! let mut imu = Bmi160::new_with_i2c(dev, address);
//! let id = imu.chip_id().unwrap_or(0);
//! println!("Chip ID: {}", id);
//! # }
//! ```
//!
//! ### Create an instance of the driver in SPI mode and print the chip id
//!
//! ```no_run
//! extern crate linux_embedded_hal as hal;
//! use bmi160::Bmi160;
//!
//! # fn main() {
//! let spi = hal::SpidevDevice::open("/dev/spidev0.0").unwrap();
//! let mut imu = Bmi160::new_with_spi(spi);
//! let id = imu.chip_id().unwrap_or(0);
//! println!("Chip ID: {}", id);
//! # }
//! ```
//!
//! ### Enable accelerometer and gyroscope and read data
//!
//! ```no_run
//! extern crate linux_embedded_hal as hal;
//! use bmi160::{
//!     Bmi160, AccelerometerPowerMode, GyroscopePowerMode, SlaveAddr,
//!     SensorSelector
//! };
//!
//! # fn main() {
//! let dev = hal::I2cdev::new("/dev/i2c-1").unwrap();
//! let address = SlaveAddr::default();
//! let mut imu = Bmi160::new_with_i2c(dev, address);
//! imu.set_accel_power_mode(AccelerometerPowerMode::Normal).unwrap();
//! imu.set_gyro_power_mode(GyroscopePowerMode::Normal).unwrap();
//! loop {
//!     let data = imu.data(SensorSelector::new().accel().gyro()).unwrap();
//!     let accel = data.accel.unwrap();
//!     let gyro = data.gyro.unwrap();
//!     println!(
//!         "Accelerometer: x {:5} y {:5} z {:5}, \
//!          Gyroscope: x {:5} y {:5} z {:5}",
//!         accel.x, accel.y, accel.z, gyro.x, gyro.y, gyro.z);
//! }
//! # }
//! ```

#![deny(unsafe_code, missing_docs)]
#![no_std]

mod device_impl;
pub mod interface;
mod types;
pub use crate::interface::SlaveAddr;
pub use crate::types::{
    AccelerometerPowerMode, AccelerometerRange, Data, DataScaled, Error, GyroscopePowerMode,
    GyroscopeRange, MagnetometerData, MagnetometerPowerMode, Sensor3DData, Sensor3DDataScaled,
    SensorPowerMode, SensorSelector, Status,
};
mod register_address;
use crate::register_address::{BitFlags, Register};
mod read_sensor_data;

/// BMI160 device driver
#[derive(Debug)]
pub struct Bmi160<DI> {
    /// Digital interface: I2C or SPI
    iface: DI,
    accel_range: AccelerometerRange,
    gyro_range: GyroscopeRange,
}

mod private {
    use super::interface;
    pub trait Sealed {}

    impl<SPI> Sealed for interface::SpiInterface<SPI> {}
    impl<I2C> Sealed for interface::I2cInterface<I2C> {}
}