Struct omnisensor::sensor::SensorIOCtx

pub struct SensorIOCtx {
    io: SensorIO,
    bridge_gpio: Option<BridgeGPIO>,
    i2cdev: Option<Arc<I2CDevice>>,
    next_update: Box<dyn FnMut(&Sensor) -> BoxFuture<'static, ()> + Send + Sync>,
}

A SensorIO plus some surrounding context.

Fields

io: SensorIO

The sensor I/O mechanism.

bridge_gpio: Option<BridgeGPIO>

A GPIO that must be asserted before reading the sensor.

i2cdev: Option<Arc<I2CDevice>>

A reference to an I2C device associated with the sensor.

next_update: Box<dyn FnMut(&Sensor) -> BoxFuture<'static, ()> + Send + Sync>

Function returning a future to await before performing an update of the sensor’s value.

Implementations

impl SensorIOCtx

pub fn new(io: SensorIO) -> Self

Create a new sensor I/O context from a given I/O mechanism.

pub fn with_bridge_gpio(self, bridge_gpio: Option<BridgeGPIO>) -> Self

Add a BridgeGPIO to a sensor I/O context.

pub fn with_i2cdev(self, i2cdev: Option<Arc<I2CDevice>>) -> Self

Add an I2CDevice to a sensor I/O context.

pub fn with_next_update(
    self,
    next: Box<dyn FnMut(&Sensor) -> BoxFuture<'static, ()> + Send + Sync>
) -> Self

Replace the default (periodic polling) next_update function of a sensor I/O context.

pub async fn read(&mut self) -> Result<f64, Box<dyn Error>>

Take a sample from the sensor, asserting its bridge GPIO if required.