pot-head 0.2.1

A no_std Rust library for processing raw potmeter inputs in embedded systems
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

/// Exponential Moving Average filter state
#[derive(Debug, Clone, Copy)]
pub struct EmaFilter {
    previous: f32,
    initialized: bool,
}

impl EmaFilter {
    /// Create new EMA filter with uninitialized state
    pub const fn new() -> Self {
        Self {
            previous: 0.0,
            initialized: false,
        }
    }

    /// Apply EMA filter: output = alpha * input + (1 - alpha) * previous
    ///
    /// First call initializes the filter to the input value.
    pub fn apply(&mut self, input: f32, alpha: f32) -> f32 {
        debug_assert!(
            alpha > 0.0 && alpha <= 1.0,
            "EMA alpha must be in range (0.0, 1.0], got {}",
            alpha
        );

        if !self.initialized {
            self.previous = input;
            self.initialized = true;
            return input;
        }

        let output = alpha * input + (1.0 - alpha) * self.previous;
        self.previous = output;
        output
    }

    /// Reset filter state, seeding it to a known value.
    ///
    /// The next `apply()` call will start from `value` rather than cold-starting at 0.
    pub fn reset(&mut self, value: f32) {
        self.previous = value;
        self.initialized = true;
    }
}

impl Default for EmaFilter {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn first_call_returns_input() {
        let mut filter = EmaFilter::new();
        assert_eq!(filter.apply(0.5, 0.3), 0.5);
    }

    #[test]
    fn applies_smoothing() {
        let mut filter = EmaFilter::new();
        filter.apply(0.0, 0.3);

        // Step input from 0.0 to 1.0
        let output = filter.apply(1.0, 0.3);
        // output = 0.3 * 1.0 + 0.7 * 0.0 = 0.3
        assert!((output - 0.3).abs() < 1e-6);
    }

    #[test]
    fn lower_alpha_more_smoothing() {
        let mut filter_low = EmaFilter::new();
        let mut filter_high = EmaFilter::new();

        filter_low.apply(0.0, 0.1);
        filter_high.apply(0.0, 0.9);

        let out_low = filter_low.apply(1.0, 0.1);
        let out_high = filter_high.apply(1.0, 0.9);

        // Higher alpha should respond more to new input
        assert!(out_high > out_low);
    }

    #[test]
    fn reset_seeds_to_value() {
        let mut filter = EmaFilter::new();
        filter.apply(0.5, 0.3);
        filter.apply(0.7, 0.3);

        filter.reset(0.8);

        // After reset, first call starts from seeded value (0.3 * 1.0 + 0.7 * 0.8)
        let expected = 0.3 * 1.0 + 0.7 * 0.8;
        assert!((filter.apply(1.0, 0.3) - expected).abs() < 1e-6);
    }
}