Struct Hdc1080 

pub struct Hdc1080<I2C, D> { /* private fields */ }

An HDC1080 on an I2C bus, measuring temperature and humidity on demand.

init checks the manufacturer and device id registers and writes the configuration: the mode that measures temperature and humidity in one sequence, at the chosen resolutions. measure follows the datasheet’s transaction: a pointer write to the temperature register triggers the acquisition, the conversion time for both resolutions passes, and one four-byte read returns temperature then humidity. The part does not acknowledge a read before the results are ready, which surfaces as a bus error rather than a stale value. As a [Sensor] its reading is the Measurement; one channel is selected with [Sensor::map].

Examples

A humidor’s climate, read from an HDC1080 that is not plugged in yet: the simulated part holds 21.5 °C and 45 % relative humidity, and the driver waits out both conversions before it reads them.

use pamoja_core::Sensor;
use pamoja_hal::script::{block_on, DelayLog};
use pamoja_sensors::hdc1080::{sim, Hdc1080};

let mut sensor = Hdc1080::new(sim::reporting(21.5, 45.0), DelayLog::new());
let climate = block_on(sensor.read())?;
assert!((climate.milli_celsius() - 21_500).abs() < 10);
assert!((climate.relative_humidity() - 45.0).abs() < 0.1);

Implementations

impl<I2C, D> Hdc1080<I2C, D>

pub fn new(bus: I2C, delay: D) -> Self

Wraps an I2C bus; the part has one address.

Arguments

• bus - the I2C bus the part is on.
• delay - the timer that paces the acquisitions.

Returns

The driver, measuring both channels at 14 bits.

pub fn with_resolutions( self, temperature: TemperatureResolution, humidity: HumidityResolution, ) -> Self

Sets the resolution of each channel, which sets the conversion time.

Arguments

• temperature - 11 or 14 bits.
• humidity - 8, 11, or 14 bits.

Returns

The driver.

pub fn configuration(&self) -> Configuration

Returns the configuration the driver writes.

pub fn release(self) -> (I2C, D)

Gives back the bus and the delay.

Returns

The bus and delay the driver was built from.

impl<I2C: I2c, D: DelayNs> Hdc1080<I2C, D>

pub fn init(&mut self) -> Result<(), DriverError<I2C::Error>>

Checks the part’s identity and writes the configuration.

Errors

Returns DriverError::Bus if the bus fails, and DriverError::Sensor with SensorError::Identity if either id register is not an HDC1080’s.

pub fn measure(&mut self) -> Result<Measurement, DriverError<I2C::Error>>

Triggers one acquisition of both channels and reads the results.

Initializes the part first if init has not run.

Returns

The temperature and humidity registers as a Measurement.

Errors

Returns DriverError::Bus if the bus fails, which includes the part not acknowledging a read before its results are ready, or any error of init.

pub fn heater(&mut self, on: bool) -> Result<(), DriverError<I2C::Error>>

Switches the heater, which runs only during acquisitions, on or off.

Arguments

• on - whether the heater runs.

Errors

Returns DriverError::Bus if the bus fails.

Trait Implementations

impl<I2C: Debug, D: Debug> Debug for Hdc1080<I2C, D>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<I2C, D> Sensor for Hdc1080<I2C, D>

where I2C: I2c + Send, I2C::Error: Debug, D: DelayNs + Send,

type Reading = Measurement

The value produced by a single read, for example a temperature or a fix.

async fn read(&mut self) -> Result<Measurement>

Takes a single reading from the sensor.

fn map<F, T>(self, select: F) -> Map<Self, F>

where Self: Sized, F: FnMut(Self::Reading) -> T,

Wraps this sensor so every reading passes through select first.