cc_talk_core 0.0.4

A no-std implementation of the CCtalk protocol.
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

use crate::cc_talk::{Category, ChecksumType};

/// Represents a ccTalk Device
/// This can be used to remove some boilerplate when sending packets
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct Device {
    address: u8,
    category: Category,
    checksum_type: ChecksumType,
    encrypted: bool,
}

impl Device {
    /// Creates a new device, this has no impact on the wire.
    ///
    /// # Note
    ///
    /// Encryption is not implemented yet, so its set to false by default.
    #[must_use]
    pub const fn new(address: u8, category: Category, checksum_type: ChecksumType) -> Self {
        Self {
            address,
            category,
            checksum_type,
            encrypted: false,
        }
    }

    #[must_use]
    pub const fn address(&self) -> u8 {
        self.address
    }

    #[must_use]
    pub const fn category(&self) -> &Category {
        &self.category
    }

    #[must_use]
    pub const fn checksum_type(&self) -> &ChecksumType {
        &self.checksum_type
    }

    #[must_use]
    pub const fn encrypted(&self) -> bool {
        self.encrypted
    }
}

/// Represents the device serial number.
#[derive(Clone, PartialEq, Eq)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub struct SerialCode(u8, u8, u8);
impl SerialCode {
    /// Creates a new serial code.
    #[must_use]
    pub const fn new(a: u8, b: u8, c: u8) -> Self {
        Self(a, b, c)
    }

    /// Returns the first byte of the serial code.
    #[must_use]
    pub const fn major(&self) -> u8 {
        self.0
    }

    /// Returns the second byte of the serial code.
    #[must_use]
    pub const fn minor(&self) -> u8 {
        self.1
    }

    /// Returns the third byte of the serial code.
    #[must_use]
    pub const fn fix(&self) -> u8 {
        self.2
    }

    // Verifies if the device version is at least the specified version.
    #[must_use]
    pub const fn is_at_least(&self, major: u8, minor: u8, fix: u8) -> bool {
        (self.0 > major)
            || (self.0 == major && self.1 > minor)
            || (self.0 == major && self.1 == minor && self.2 >= fix)
    }

    /// Returns the serial number in decimal as specified by the ccTalk protocol.
    #[must_use]
    pub const fn as_number(&self) -> u32 {
        self.fix() as u32 + (256 * (self.minor() as u32)) + (65536 * (self.major() as u32))
    }
}

impl core::fmt::Display for SerialCode {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}.{}.{}", self.0, self.1, self.2)
    }
}

impl core::fmt::Debug for SerialCode {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(f, "{}.{}.{}", self.0, self.1, self.2)
    }
}

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

    #[test]
    fn serial_code_display() {
        let code = SerialCode::new(1, 2, 3);
        assert_eq!(std::format!("{code}"), "1.2.3");
    }

    #[test]
    fn as_decimal() {
        let code = SerialCode::new(255, 255, 255);
        // Should be 255 + 256 * 255 + 65536 * 255 which is 24 bits set to 1
        assert_eq!(code.as_number(), 0x00FF_FFFF);
    }
}