ph-veml7700-als 0.1.0-incubating.1

Async no_std VEML7700 ambient-light driver with explicit one-shot and threshold-monitor semantics
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

//! Device-identity decoding.

/// Driver-supported identity selected from `S-43`.
pub(crate) const EXPECTED_DEVICE_ID: u16 = 0xC481;

/// Decoded VEML7700 ID register.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct DeviceId {
    raw: u16,
}

impl DeviceId {
    /// Decode an observed raw ID word.
    pub const fn from_raw(raw: u16) -> Self {
        Self { raw }
    }

    /// Return the complete raw ID word.
    pub const fn raw(self) -> u16 {
        self.raw
    }

    /// Return the fixed low-byte device code.
    pub const fn device_code(self) -> u8 {
        self.raw as u8
    }

    /// Return the address-option code from the high byte.
    pub const fn address_option_code(self) -> u8 {
        (self.raw >> 8) as u8
    }

    /// Return whether this ID matches the supported fixed-address VEML7700.
    pub const fn is_supported(self) -> bool {
        self.raw == EXPECTED_DEVICE_ID
    }
}

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

    #[test]
    fn expected_identity_components_and_support_match() {
        let id = DeviceId::from_raw(0xC481);
        assert_eq!(id.raw(), 0xC481);
        assert_eq!(id.device_code(), 0x81);
        assert_eq!(id.address_option_code(), 0xC4);
        assert!(id.is_supported());
        assert!(!DeviceId::from_raw(0x0081).is_supported());
    }
}