as5600 0.8.0

Platform-independent Rust driver for AS5600 digital magnetic potentiometer
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use num_derive::FromPrimitive;
#[cfg(test)]
use proptest_derive::Arbitrary;

mod conversion;
/// Errors
pub mod error;
#[cfg(test)]
mod test;

/// Power mode.
#[derive(Debug, PartialEq, Eq, Copy, Clone, FromPrimitive)]
#[cfg_attr(test, derive(Arbitrary))]
#[repr(u8)]
pub enum PowerMode {
    /// Normal power.
    Nom = 0b00,
    /// Low Power Mode 1.
    Lpm1 = 0b01,
    /// Low Power Mode 2.
    Lpm2 = 0b10,
    /// Low Power Mode 3.
    Lpm3 = 0b11,
}

/// Hysteresis mode.
#[derive(Debug, PartialEq, Eq, Copy, Clone, FromPrimitive)]
#[cfg_attr(test, derive(Arbitrary))]
#[repr(u8)]
pub enum Hysteresis {
    /// No hysteresis.
    Off = 0b00,
    /// 1 least significant bit hysteresis.
    Lsb1 = 0b01,
    /// 2 least significant bit hysteresis.
    Lsb2 = 0b10,
    /// 3 least significant bit hysteresis.
    Lsb3 = 0b11,
}

/// Output stage mode.
/// Apart from digital i2c output, analog modes or PWM could be generated by the module.
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
#[cfg_attr(test, derive(Arbitrary))]
#[repr(u8)]
pub enum OutputStage {
    /// Full-range analog output (0..VDD).
    Analog = 0b00,
    /// Reduced-range analog output (10% VDD..90% VDD).
    ReducedAnalog = 0b01,
    /// PWM output at frequency given by [`PwmFreq`].
    DigitalPwm = 0b10,
}

/// PWM frequency.
#[derive(Debug, PartialEq, Eq, Copy, Clone, FromPrimitive)]
#[cfg_attr(test, derive(Arbitrary))]
#[repr(u8)]
pub enum PwmFreq {
    /// Frequency 1: 116Hz.
    PwmF1 = 0b00,
    /// Frequency 2: 230Hz.
    PwmF2 = 0b01,
    /// Frequency 3: 460.
    PwmF3 = 0b10,
    /// Frequency 4: 920Hz.
    PwmF4 = 0b11,
}

impl PwmFreq {
    /// Get the frequency for this [`PwmFreq`] setting in Hz.
    pub const fn to_hz(&self) -> usize {
        match self {
            Self::PwmF1 => 115,
            Self::PwmF2 => 230,
            Self::PwmF3 => 460,
            Self::PwmF4 => 920,
        }
    }
}

/// Slow filter mode.
#[derive(Debug, PartialEq, Eq, Copy, Clone, FromPrimitive)]
#[cfg_attr(test, derive(Arbitrary))]
#[repr(u8)]
pub enum SlowFilterMode {
    /// 16x filter.
    X16 = 0b00,
    /// 8x filter.
    X8 = 0b01,
    /// 4x filter.
    X4 = 0b10,
    /// 2x filter.
    X2 = 0b11,
}

/// Fast filter threshold.
#[derive(Debug, PartialEq, Eq, Copy, Clone, FromPrimitive)]
#[cfg_attr(test, derive(Arbitrary))]
#[repr(u8)]
pub enum FastFilterThreshold {
    /// No fast filter.
    SlowFilterOnly = 0b000,
    /// Fast filter at 6 LSB.
    Lsb6 = 0b001,
    /// Fast filter at 7 LSB.
    Lsb7 = 0b010,
    /// Fast filter at 9 LSB.
    Lsb9 = 0b011,
    /// Fast filter at 18 LSB.
    Lsb18 = 0b100,
    /// Fast filter at 21 LSB.
    Lsb21 = 0b101,
    /// Fast filter at 24 LSB.
    Lsb24 = 0b110,
    /// Fast filter at 10 LSB.
    Lsb10 = 0b111,
}

/// Watchdog state.
#[derive(Debug, PartialEq, Eq, Copy, Clone, FromPrimitive)]
#[cfg_attr(test, derive(Arbitrary))]
#[repr(u8)]
pub enum WatchdogState {
    /// Watchdog off.
    Off = 0,
    /// Watchdog on.
    On = 1,
}

/// As5600 configuration.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
#[cfg_attr(test, derive(Arbitrary))]
pub struct Configuration {
    /// Power mode.
    pub power_mode: PowerMode,
    /// Hysteresis.
    pub hysteresis: Hysteresis,
    /// Output stage.
    pub output_stage: OutputStage,
    /// PWM frequency.
    pub pwm_frequency: PwmFreq,
    /// Slow filter mode.
    pub slow_filter: SlowFilterMode,
    /// Fast filter threshold.
    pub fast_filter_threshold: FastFilterThreshold,
    /// Watchdog state.
    pub watchdog_state: WatchdogState,
}