PotConditioner

Struct PotConditioner 

Source
pub struct PotConditioner { /* private fields */ }
Expand description

Processor struct containing variables and states.

Implementations§

Source§

impl PotConditioner

Source

pub fn new( sampling_rate: i32, input_range: (i32, i32), output_range: (i32, i32), ) -> Self

Create a new instance.

  • sampling_rate: sampling rate in Hz.
  • input_range: tuple of (lowest/highest) input value.
  • input_range: tuple of (lowest/highest) output value.
Source

pub fn set_movement_threshold(&mut self, threshold: i32)

Sets a new movement threshold. Recommended range is 10-255.

Source

pub fn update(&mut self, value: i32, tick: u64) -> i32

Update value with new input and return processed value.

Source

pub fn value(&self) -> i32

Return current value.

Source

pub fn delta(&self) -> i32

Return delta.

Source

pub fn velocity(&self) -> i32

Return velocity.

Source

pub fn moved(&self) -> bool

Return if the pot has been moved faster than the given threshold.

Source

pub fn last_movement(&self) -> Option<u64>

Return tick number of last detected movement.

Source

pub fn set_output_range(&mut self, out_min: i32, out_max: i32)

Sets a new output range.

Source

pub fn output_range(&self) -> (i32, i32)

Returns the current output range.

Trait Implementations§

Source§

impl Debug for PotConditioner

Source§

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

Formats the value using the given formatter. Read more

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