Struct VOCAlgorithm Tuning Parameters &nbsp; Copy item path

impl VOCAlgorithmTuningParameters

pub fn write_index_offset(&mut self, value: i16)

Packs and updates the value of the index_offset field in this packed representation.

VOC index representing typical (average) conditions. Allowed values are in range 1-250. The default value is 100.

Default: 100

Bits: [0..=15]

pub fn with_index_offset(self, value: i16) -> Self

Packs and updates the value of the index_offset field in this packed representation.

Chainable version of Self::write_index_offset.

VOC index representing typical (average) conditions. Allowed values are in range 1-250. The default value is 100.

Default: 100

Bits: [0..=15]

pub fn read_index_offset(&self) -> i16

Unpacks only the index_offset field from this packed representation.

VOC index representing typical (average) conditions. Allowed values are in range 1-250. The default value is 100.

Default: 100

Bits: [0..=15]

pub fn write_learning_time_offset_hours(&mut self, value: i16)

Packs and updates the value of the learning_time_offset_hours field in this packed representation.

Time constant to estimate the VOC algorithm offset from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1-1000. The default value is 12 hours.

Default: 12

Bits: [16..=31]

pub fn with_learning_time_offset_hours(self, value: i16) -> Self

Packs and updates the value of the learning_time_offset_hours field in this packed representation.

Chainable version of Self::write_learning_time_offset_hours.

Time constant to estimate the VOC algorithm offset from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1-1000. The default value is 12 hours.

Default: 12

Bits: [16..=31]

pub fn read_learning_time_offset_hours(&self) -> i16

Unpacks only the learning_time_offset_hours field from this packed representation.

Time constant to estimate the VOC algorithm offset from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1-1000. The default value is 12 hours.

Default: 12

Bits: [16..=31]

pub fn write_learning_time_gain_hours(&mut self, value: i16)

Packs and updates the value of the learning_time_gain_hours field in this packed representation.

Time constant to estimate the VOC algorithm gain from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1-1000. The default value is 12 hours.

Default: 12

Bits: [32..=47]

pub fn with_learning_time_gain_hours(self, value: i16) -> Self

Packs and updates the value of the learning_time_gain_hours field in this packed representation.

Chainable version of Self::write_learning_time_gain_hours.

Time constant to estimate the VOC algorithm gain from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1-1000. The default value is 12 hours.

Default: 12

Bits: [32..=47]

pub fn read_learning_time_gain_hours(&self) -> i16

Unpacks only the learning_time_gain_hours field from this packed representation.

Time constant to estimate the VOC algorithm gain from the history in hours. Past events will be forgotten after about twice the learning time. Allowed values are in range 1-1000. The default value is 12 hours.

Default: 12

Bits: [32..=47]

pub fn write_gating_max_duration_minutes(&mut self, value: i16)

Packs and updates the value of the gating_max_duration_minutes field in this packed representation.

Maximum duration of gating in minutes (freeze of estimator during high VOC index signal). Set to zero to disable the gating. Allowed values are in range 0-3000. The default value is 180 minutes.

Default: 180

Bits: [48..=63]

pub fn with_gating_max_duration_minutes(self, value: i16) -> Self

Packs and updates the value of the gating_max_duration_minutes field in this packed representation.

Chainable version of Self::write_gating_max_duration_minutes.

Maximum duration of gating in minutes (freeze of estimator during high VOC index signal). Set to zero to disable the gating. Allowed values are in range 0-3000. The default value is 180 minutes.

Default: 180

Bits: [48..=63]

pub fn read_gating_max_duration_minutes(&self) -> i16

Unpacks only the gating_max_duration_minutes field from this packed representation.

Maximum duration of gating in minutes (freeze of estimator during high VOC index signal). Set to zero to disable the gating. Allowed values are in range 0-3000. The default value is 180 minutes.

Default: 180

Bits: [48..=63]

pub fn write_std_initial(&mut self, value: i16)

Packs and updates the value of the std_initial field in this packed representation.

Initial estimate for standard deviation. Lower value boosts events during initial learning period but may result in larger device-to-device variations. Allowed values are in range 10-5000. The default value is 50.

Default: 50

Bits: [64..=79]

pub fn with_std_initial(self, value: i16) -> Self

Packs and updates the value of the std_initial field in this packed representation.

Chainable version of Self::write_std_initial.

Initial estimate for standard deviation. Lower value boosts events during initial learning period but may result in larger device-to-device variations. Allowed values are in range 10-5000. The default value is 50.

Default: 50

Bits: [64..=79]

pub fn read_std_initial(&self) -> i16

Unpacks only the std_initial field from this packed representation.

Initial estimate for standard deviation. Lower value boosts events during initial learning period but may result in larger device-to-device variations. Allowed values are in range 10-5000. The default value is 50.

Default: 50

Bits: [64..=79]

pub fn write_gain_factor(&mut self, value: i16)

Packs and updates the value of the gain_factor field in this packed representation.

Gain factor to amplify or to attenuate the VOC index output. Allowed values are in range 1-1000. The default value is 230.

Default: 230

Bits: [80..=95]

pub fn with_gain_factor(self, value: i16) -> Self

Packs and updates the value of the gain_factor field in this packed representation.

Chainable version of Self::write_gain_factor.

Gain factor to amplify or to attenuate the VOC index output. Allowed values are in range 1-1000. The default value is 230.

Default: 230

Bits: [80..=95]

pub fn read_gain_factor(&self) -> i16

Unpacks only the gain_factor field from this packed representation.

Gain factor to amplify or to attenuate the VOC index output. Allowed values are in range 1-1000. The default value is 230.

Default: 230

Bits: [80..=95]

impl VOCAlgorithmTuningParameters

pub fn unpack(&self) -> VOCAlgorithmTuningParametersUnpacked

Unpack all fields into a VOCAlgorithmTuningParametersUnpacked. If you don’t need all fields, this is more expensive than just using the appropriate read_* functions directly.

Trait Implementations§

impl AsRef<VOCAlgorithmTuningParameters> for VOCAlgorithmTuningParameters

fn as_ref(&self) -> &VOCAlgorithmTuningParameters

Converts this type into a shared reference of the (usually inferred) input type.

impl BitdumpFormattable for VOCAlgorithmTuningParameters

fn bitdump(&self) -> BitdumpFormatter

Returns an object that implements Display for pretty-printing the contents and layout of this bit-packed struct

impl Clone for VOCAlgorithmTuningParameters

fn clone(&self) -> VOCAlgorithmTuningParameters

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Default for VOCAlgorithmTuningParameters

fn default() -> Self

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

impl From<&VOCAlgorithmTuningParameters> for VOCAlgorithmTuningParametersUnpacked

fn from(value: &VOCAlgorithmTuningParameters) -> Self

Converts to this type from the input type.

impl From<&VOCAlgorithmTuningParametersUnpacked> for VOCAlgorithmTuningParameters

fn from(value: &VOCAlgorithmTuningParametersUnpacked) -> Self

Converts to this type from the input type.

impl From<VOCAlgorithmTuningParameters> for VOCAlgorithmTuningParametersUnpacked

fn from(value: VOCAlgorithmTuningParameters) -> Self

Converts to this type from the input type.

impl From<VOCAlgorithmTuningParametersUnpacked> for VOCAlgorithmTuningParameters

fn from(value: VOCAlgorithmTuningParametersUnpacked) -> Self

Converts to this type from the input type.

impl PartialEq for VOCAlgorithmTuningParameters

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

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

1.0.0 · 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.

impl StructuralPartialEq for VOCAlgorithmTuningParameters

Auto Trait Implementations§

impl Freeze for VOCAlgorithmTuningParameters

impl RefUnwindSafe for VOCAlgorithmTuningParameters

impl Send for VOCAlgorithmTuningParameters

impl Sync for VOCAlgorithmTuningParameters

impl Unpin for VOCAlgorithmTuningParameters

impl UnwindSafe for VOCAlgorithmTuningParameters

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.

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

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

impl<T> Conv for T

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more

impl<T> FmtForward for T

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tap for T

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more

fn tap_borrow(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut of a value. Read more

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.

fn tap_borrow_dbg(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryConv for T

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> AnyBitPattern for T
where T: Pod,

impl<T> MaybeBitdumpFormattable for T
where T: BitdumpFormattable,