Struct shtcx::ShtCx

pub struct ShtCx<S: ShtSensor, I2C> { /* fields omitted */ }

Driver for the SHTCx sensor.

To create an instance of this, use a factory function like shtc1 or shtc3 depending on your sensor.

Implementations

impl<S, I2C, E> ShtCx<S, I2C> where
    S: ShtSensor,
    I2C: Read<Error = E> + Write<Error = E>, 

General functions.

pub fn destroy(self) -> I2C

Destroy driver instance, return I²C bus instance.

pub fn raw_id_register(&mut self) -> Result<u16, Error<E>>

Return the raw ID register.

pub fn device_identifier(&mut self) -> Result<u8, Error<E>>

Return the 7-bit device identifier.

Should be 0x47 (71) for the SHTC3 and 0x07 (7) for the SHTC1.

pub fn reset(&mut self, delay: &mut impl DelayUs<u16>) -> Result<(), Error<E>>

Trigger a soft reset.

The SHTC3 provides a soft reset mechanism that forces the system into a well-defined state without removing the power supply. If the system is in its idle state (i.e. if no measurement is in progress) the soft reset command can be sent. This triggers the sensor to reset all internal state machines and reload calibration data from the memory.

impl<S, I2C, E> ShtCx<S, I2C> where
    S: ShtSensor,
    I2C: Read<Error = E> + Write<Error = E>, 

Asynchronous functions for starting / reading measurements.

pub fn start_measurement(&mut self, mode: PowerMode) -> Result<(), Error<E>>

Start a temperature / humidity measurement.

pub fn get_measurement_result(&mut self) -> Result<Measurement, Error<E>>

Read the result of a temperature / humidity measurement.

pub fn start_temperature_measurement(
    &mut self,
    mode: PowerMode
) -> Result<(), Error<E>>

Start a temperature measurement.

pub fn get_temperature_measurement_result(
    &mut self
) -> Result<Temperature, Error<E>>

Read the result of a temperature measurement.

pub fn start_humidity_measurement(
    &mut self,
    mode: PowerMode
) -> Result<(), Error<E>>

Start a humidity measurement.

pub fn get_humidity_measurement_result(&mut self) -> Result<Humidity, Error<E>>

Read the result of a humidity measurement.

impl<S, I2C, E> ShtCx<S, I2C> where
    S: ShtSensor + MeasurementDuration,
    I2C: Read<Error = E> + Write<Error = E>, 

Blocking functions for doing measurements.

pub fn wait_for_measurement(
    &mut self,
    mode: PowerMode,
    delay: &mut impl DelayUs<u16>
)

Wait the maximum time needed for the given measurement mode

pub fn measure(
    &mut self,
    mode: PowerMode,
    delay: &mut impl DelayUs<u16>
) -> Result<Measurement, Error<E>>

Run a temperature/humidity measurement and return the combined result.

This is a blocking function call.

pub fn measure_temperature(
    &mut self,
    mode: PowerMode,
    delay: &mut impl DelayUs<u16>
) -> Result<Temperature, Error<E>>

Run a temperature measurement and return the result.

This is a blocking function call.

Internally, it will request a measurement in "temperature first" mode and only read the first half of the measurement response.

pub fn measure_humidity(
    &mut self,
    mode: PowerMode,
    delay: &mut impl DelayUs<u16>
) -> Result<Humidity, Error<E>>

Run a humidity measurement and return the result.

This is a blocking function call.

Internally, it will request a measurement in "humidity first" mode and only read the first half of the measurement response.

Trait Implementations

impl<S: Debug + ShtSensor, I2C: Debug> Debug for ShtCx<S, I2C>

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

Formats the value using the given formatter.

impl<S: Default + ShtSensor, I2C: Default> Default for ShtCx<S, I2C>

fn default() -> ShtCx<S, I2C>

Returns the "default value" for a type.

impl<I2C, E> LowPower<E> for ShtCx<Sht2Gen, I2C> where
    I2C: Read<Error = E> + Write<Error = E>, 

const WAKEUP_TIME_US: u16

Time the sensor needs until it is ready after a wakeup call.

fn sleep(&mut self) -> Result<(), Error<E>>

Set sensor to sleep mode.

fn start_wakeup(&mut self) -> Result<(), Error<E>>

Wake up sensor from sleep mode.

fn wakeup(&mut self, delay: &mut impl DelayUs<u16>) -> Result<(), Error<E>>

Wake up sensor from sleep mode and wait until it is ready.

impl<I2C, E> LowPower<E> for ShtCx<ShtGeneric, I2C> where
    I2C: Read<Error = E> + Write<Error = E>, 

const WAKEUP_TIME_US: u16

Time the sensor needs until it is ready after a wakeup call.

fn sleep(&mut self) -> Result<(), Error<E>>

Set sensor to sleep mode.

fn start_wakeup(&mut self) -> Result<(), Error<E>>

Wake up sensor from sleep mode.

fn wakeup(&mut self, delay: &mut impl DelayUs<u16>) -> Result<(), Error<E>>

Wake up sensor from sleep mode and wait until it is ready.