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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

//! Snap zone implementations for value snapping and dead zones.
//!
//! Operates on normalized values (0.0-1.0) in the processing pipeline.

/// Snap zone behavior types
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum SnapZoneType {
    /// Snap to target value when within threshold
    Snap,

    /// Dead zone - ignore input changes within threshold
    Dead,
}

/// Snap zone configuration.
/// Defines a target value and threshold range around it.
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct SnapZone<T> {
    pub target: T,
    pub threshold: T,
    pub zone_type: SnapZoneType,
}

impl<T> SnapZone<T>
where
    T: Copy + PartialOrd + core::ops::Sub<Output = T> + core::ops::Add<Output = T>,
{
    /// Create a new snap zone
    pub const fn new(target: T, threshold: T, zone_type: SnapZoneType) -> Self {
        Self {
            target,
            threshold,
            zone_type,
        }
    }

    /// Check if value falls within this zone's range (target ± threshold)
    pub fn contains(&self, value: T) -> bool {
        let min = self.target - self.threshold;
        let max = self.target + self.threshold;
        value >= min && value <= max
    }

    /// Apply this zone's behavior to the input value.
    /// Assumes value is within the zone (call contains() first).
    pub fn apply(&self, _value: T, last_output: T) -> T {
        match self.zone_type {
            SnapZoneType::Snap => self.target,
            SnapZoneType::Dead => last_output,
        }
    }

    /// Check if this zone overlaps with another zone.
    /// Two zones overlap if their ranges (target ± threshold) intersect.
    pub fn overlaps(&self, other: &SnapZone<T>) -> bool {
        let self_min = self.target - self.threshold;
        let self_max = self.target + self.threshold;
        let other_min = other.target - other.threshold;
        let other_max = other.target + other.threshold;

        !(self_max < other_min || other_max < self_min)
    }
}

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

    #[test]
    fn test_snap_zone_contains() {
        let zone = SnapZone::new(0.5, 0.1, SnapZoneType::Snap);

        assert!(zone.contains(0.4)); // min boundary
        assert!(zone.contains(0.5)); // target
        assert!(zone.contains(0.6)); // max boundary
        assert!(!zone.contains(0.39)); // below
        assert!(!zone.contains(0.61)); // above
    }

    #[test]
    fn test_snap_zone_apply() {
        let zone = SnapZone::new(0.5, 0.1, SnapZoneType::Snap);

        // Snap mode always returns target
        assert_eq!(zone.apply(0.45, 0.0), 0.5);
        assert_eq!(zone.apply(0.55, 0.0), 0.5);
    }

    #[test]
    fn test_dead_zone_apply() {
        let zone = SnapZone::new(0.5, 0.1, SnapZoneType::Dead);

        // Dead zone returns last output
        assert_eq!(zone.apply(0.45, 0.3), 0.3);
        assert_eq!(zone.apply(0.55, 0.7), 0.7);
    }

    #[test]
    fn test_snap_zone_overlaps() {
        let zone1 = SnapZone::new(0.0, 0.05, SnapZoneType::Snap); // range: -0.05 to 0.05
        let zone2 = SnapZone::new(0.5, 0.05, SnapZoneType::Snap); // range: 0.45 to 0.55
        let zone3 = SnapZone::new(0.03, 0.03, SnapZoneType::Snap); // range: 0.0 to 0.06

        assert!(!zone1.overlaps(&zone2)); // No overlap
        assert!(!zone2.overlaps(&zone3)); // No overlap
        assert!(zone1.overlaps(&zone3)); // Overlaps
        assert!(zone3.overlaps(&zone1)); // Symmetric
    }

    #[test]
    fn test_snap_zone_edge_cases() {
        let zone = SnapZone::new(0.0, 0.02, SnapZoneType::Snap);

        // Test negative range (wraps below 0.0)
        assert!(zone.contains(0.0));
        assert!(zone.contains(0.02));
    }
}