Skip to main content

Configuration

Struct Configuration 

Source
pub struct Configuration {
    pub software_reset: bool,
    pub heater: bool,
    pub mode: AcquisitionMode,
    pub battery_low: bool,
    pub temperature_resolution: TemperatureResolution,
    pub humidity_resolution: HumidityResolution,
}
Expand description

The configuration register (0x02), field by field.

Configuration::default is the power-on state, CONFIGURATION_RESET.

Fields§

§software_reset: bool

RST, bit 15: write true to reset the part; the bit clears itself.

§heater: bool

HEAT, bit 13: run the on-die heater during measurements.

§mode: AcquisitionMode

MODE, bit 12: what one trigger acquires.

§battery_low: bool

BTST, bit 11, read only: true when the supply is below 2.8 V, refreshed after power-on and after every measurement request.

§temperature_resolution: TemperatureResolution

TRES, bit 10.

§humidity_resolution: HumidityResolution

HRES, bits 9:8.

Implementations§

Source§

impl Configuration

Source

pub fn from_register(raw: u16) -> Result<Configuration, SensorError>

Decodes the configuration register.

Reserved bits (14 and 7:0) are ignored; the part reads them as zero.

§Arguments
  • raw - the 16-bit configuration register.
§Returns

The decoded configuration.

§Errors

SensorError::Invalid if HRES holds 11, the one code the datasheet leaves undefined.

Source

pub fn to_register(&self) -> u16

Encodes the configuration register.

§Returns

The 16-bit register value, reserved bits clear.

Source

pub fn conversion_time_micros(&self) -> u32

Returns how long to wait after a trigger before the result is readable.

§Returns

In AcquisitionMode::TemperatureThenHumidity, the temperature and humidity conversion times added together. In AcquisitionMode::Single, the longer of the two, which covers whichever pointer the caller triggered.

Trait Implementations§

Source§

impl Clone for Configuration

Source§

fn clone(&self) -> Configuration

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for Configuration

Source§

impl Debug for Configuration

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Configuration

Source§

fn default() -> Configuration

Returns the “default value” for a type. Read more
Source§

impl Eq for Configuration

Source§

impl PartialEq for Configuration

Source§

fn eq(&self, other: &Configuration) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Configuration

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.