Struct Measurement 

pub struct Measurement {
    pub temperature_raw: u16,
    pub humidity_raw: u16,
}

One temperature and humidity data pair, as the part returns it.

The part sends the temperature word, its CRC, the humidity word, and its CRC, in that order, after a single-shot command or command::FETCH_DATA. parse checks both CRCs before exposing either word.

Examples

use pamoja_sensors::sht3x::{
    humidity_raw_from_milli_percent, temperature_raw_from_milli_celsius, Measurement,
};

// What a part at 25.0 °C and 60.0 %RH puts on the bus after a single-shot command.
let bytes = Measurement {
    temperature_raw: temperature_raw_from_milli_celsius(25_000),
    humidity_raw: humidity_raw_from_milli_percent(60_000),
}
.to_bytes();
assert_eq!(bytes, [0x66, 0x66, 0x93, 0x99, 0x99, 0xBE]);

let measurement = Measurement::parse(&bytes)?;
assert_eq!(measurement.temperature_milli_celsius(), 25_000);
assert_eq!(measurement.humidity_milli_percent(), 60_000);

Fields

temperature_raw: u16

The 16-bit temperature word, S_T in the datasheet.

humidity_raw: u16

The 16-bit humidity word, S_RH in the datasheet.

Implementations

impl Measurement

pub fn parse(bytes: &[u8; 6]) -> Result<Measurement, SensorError>

Parses and CRC-checks a six-byte measurement frame.

Arguments

• bytes - the six bytes in the order the part sends them: temperature MSB, LSB, CRC, then humidity MSB, LSB, CRC.

Returns

The two raw words.

Errors

Returns SensorError::Crc if either CRC byte does not match its two data bytes, so the read was corrupted and must be repeated.

pub fn to_bytes(&self) -> [u8; 6]

Returns the six bytes a part holding this pair puts on the bus.

The inverse of parse, with both CRCs filled in so the result parses.

Returns

Temperature MSB, LSB, CRC, then humidity MSB, LSB, CRC.

pub fn temperature_milli_celsius(&self) -> i32

Returns the temperature in millidegrees Celsius.

Returns

The temperature, rounded to the nearest millidegree.

pub fn temperature_celsius(&self) -> f32

Returns the temperature in degrees Celsius.

Returns

The temperature in degrees Celsius.

pub fn temperature_milli_fahrenheit(&self) -> i32

Returns the temperature in millidegrees Fahrenheit.

Returns

The temperature, rounded to the nearest millidegree.

pub fn temperature_fahrenheit(&self) -> f32

Returns the temperature in degrees Fahrenheit.

Returns

The temperature in degrees Fahrenheit.

pub fn humidity_milli_percent(&self) -> u32

Returns the relative humidity in thousandths of a percent.

Returns

The relative humidity, rounded to the nearest thousandth of a percent.

pub fn relative_humidity(&self) -> f32

Returns the relative humidity in percent.

Returns

The relative humidity in percent.

Trait Implementations

impl Clone for Measurement

fn clone(&self) -> Measurement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Measurement

impl Debug for Measurement

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

Formats the value using the given formatter.

impl Eq for Measurement

impl PartialEq for Measurement

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Measurement