Enum SampleMetadata 

pub enum SampleMetadata {
    UnknownAccuracy,
    NoMeasurementError,
    SymmetricalError {
        deviation: u8,
        bias: i8,
        scaling: i8,
    },
    ChannelTemporarilyUnavailable,
    ChannelDisabled,
}

Available on crate feature sensors only.

Metadata associated with a Sample.

Includes the measurement accuracy if available.

Variants

UnknownAccuracy

Unknown accuracy.

NoMeasurementError

No observational/measurement error (e.g., boolean values from a push button).

SymmetricalError

Measurement error symmetrical around the bias.

The unit of measurement is provided by the ReadingChannel associated with the Sample. The scaling value is used for both deviation and bias. The accuracy error is thus given by the following formulas:

$$+(\mathtt{bias}+\mathtt{deviation})·{10}^{\mathtt{scaling}}/-(\mathtt{bias}-\mathtt{deviation})·{10}^{\mathtt{scaling}}$$

Examples

The DS18B20 temperature sensor accuracy error is +0.05/-0.45 at 20 °C (see Figure 1 of its datasheet). SampleMetadata would thus be the following:

SampleMetadata::SymmetricalError {
    deviation: 25,
    bias: -20,
    scaling: -2,
}

Fields

deviation: u8

Deviation around the bias value.

bias: i8

Bias (mean accuracy error).

scaling: i8

Scaling of deviation and bias.

ChannelTemporarilyUnavailable

Indicates that the channel is temporarily unavailable. This may happen when parts of a sensor are not ready yet, but data is already available for other channels.

ChannelDisabled

The channel is disabled by configuration.

Trait Implementations

impl Clone for SampleMetadata

fn clone(&self) -> SampleMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SampleMetadata

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

Formats the value using the given formatter.

impl Format for SampleMetadata

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl PartialEq for SampleMetadata

fn eq(&self, other: &SampleMetadata) -> 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 Copy for SampleMetadata

impl StructuralPartialEq for SampleMetadata