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

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

pub mod error;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(test, derive(Arbitrary))]
#[repr(u8)]
pub enum Register {
    /// This register holds the number of persistent burns to angle and config registers.
    Zmco = 0x00,
    /// This register holds the value of the programmed zero-position.
    Zpos = 0x01,
    /// This register holds the value of the programmed maximum position.
    Mpos = 0x03,
    /// This register holds the value of the programmed maximum angle.
    Mang = 0x05,
    /// This register holds R/W/P bitfields of the current configuration.
    Conf = 0x07,
    /// This register holds the unfiltered unprocessed value of the measured angle.
    RawAngle = 0x0C,
    /// This register holds the filtered value of the measured angle.
    Angle = 0x0E,
    /// This register indicates whether a magnet is detected, or too low, or too high.
    Status = 0x0B,
    /// This register holds the current automatic gain control value.
    Agc = 0x1A,
    /// This value holds the measured magnitude of the applied magnetic field.
    Magnitude = 0x1B,
    Burn = 0xFF,
}

impl From<Register> for u8 {
    fn from(reg: Register) -> Self {
        reg as Self
    }
}

impl TryFrom<u8> for Register {
    type Error = error::Error;
    fn try_from(byte: u8) -> Result<Self, Self::Error> {
        match byte {
            0x00 => Ok(Self::Zmco),
            0x01 => Ok(Self::Zpos),
            0x03 => Ok(Self::Mpos),
            0x05 => Ok(Self::Mang),
            0x07 => Ok(Self::Conf),
            0x0C => Ok(Self::RawAngle),
            0x0E => Ok(Self::Angle),
            0x0B => Ok(Self::Status),
            0x1A => Ok(Self::Agc),
            0x1B => Ok(Self::Magnitude),
            0xFF => Ok(Self::Burn),
            _ => Err(error::Error::Register(byte)),
        }
    }
}

#[cfg(test)]
mod test {
    use proptest::prelude::*;

    use crate::register::Register;

    proptest! {
        #[test]
        fn register_to_byte_roundtrip(register in any::<Register>()) {
            let byte = u8::from(register);
            let back = Register::try_from(byte).unwrap();
            assert_eq!(register, back);
        }

        #[test]
        fn byte_to_register_roundtrip(byte in any::<u8>()) {
            if let Ok(register) = Register::try_from(byte) {
                let back = u8::from(register);
                assert_eq!(byte, back);
            }
        }
    }
}