Struct VocTuning 

pub struct VocTuning(/* private fields */);

Configuration for the VOC Index algorithm.

Implementations

impl VocTuning

pub fn new( index_offset: i16, learning_time_offset: i16, learning_time_gain: i16, gating_max_durations: i16, initial_standard_deviation: i16, gain_factor: i16, ) -> Result<Self, DataError>

Creates a new VocTuning Index configuration:

• index_offset: VOC Index representing typical conditions. Range: 1 - 250, Default: 100.
• learning_time_offset: Time constant to estimate the offset from the history in hours. After twice the learning time events are forgotten. Range: 1 - 1,000h, Default: 12h
• learning_time_gain: Time constant to estimate the gain from the history in hours. After twice the learning time events are forgotten. Range 1 - 1,000h, Default: 12h
• gating_max_durations: Maximum duration the estimator freezes on a high VOC index signal. Zero disables the gating. Range 0 - 3,000min, Default 180min.
• initial_standard_deviation: Initial estimate for the standard deviation. Range 10 - 5,000, Default: 50.
• gain_factor: Factor to amplify/attunate the VOC index output. Range 1 - 1,000, Default: 230.

Errors

• ValueOutOfRange`: If the values with scaling are not in range.

Trait Implementations

impl Debug for VocTuning

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

Formats the value using the given formatter.

impl Default for VocTuning

fn default() -> Self

Creates a default VocTuning with:

• index_offset: 100
• learning_time_offset: 12h
• learning_time_gain: 12h
• gating_max_durations: 180min
• initial_standard_deviation: 50
• gain_factor: 230

impl From<VocTuning> for [u16; 6]

fn from(value: VocTuning) -> Self

Converts to this type from the input type.

impl PartialEq for VocTuning

fn eq(&self, other: &VocTuning) -> 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 TryFrom<&[u8]> for VocTuning

fn try_from(data: &[u8]) -> Result<Self, Self::Error>

Parse the VOC tuning parameters from the received data.

Errors

• CrcFailed: If the received data CRC indicates corruption.
• ReceivedBufferWrongSize: If the received data buffer is not the expected size.

type Error = DataError

The type returned in the event of a conversion error.

impl StructuralPartialEq for VocTuning