adafruit_nxp/sensor.rs
1//! This is a module used to represent a sensor.
2
3#[derive(Debug)]
4/// Structure used to represent a sensor.
5pub struct Sensor<'a> {
6 /// Sensor name.
7 pub name: &'a str,
8 /// Version of the hardware + driver.
9 pub version: i32,
10 /// Unique sensor identifier.
11 pub sensor_id: i32,
12 /// Sensor type.
13 pub sensor_type: SensorType,
14 /// Maximum value of this sensor's value in SI units.
15 pub max_value: f32,
16 /// Minimum value of this sensor's value in SI units.
17 pub min_value: f32,
18 /// Smallest difference between two values reported by this sensor.
19 pub resolution: f32,
20 /// Min delay in microseconds between events. zero = not a constant rate.
21 pub min_delay: i32,
22}
23
24#[derive(Debug)]
25/// Enumeration used to represent a sensor's type.
26pub enum SensorType {
27 /// Accelerometer sensor.
28 Accelerometer = 1,
29 /// Gyroscope sensor.
30 MagneticField = 2,
31 /// Gyroscope sensor.
32 Gyroscope = 3,
33}