autd3-rs 0.4.0

Core async client library for the AUTD3 phased-array kit.
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

use core::fmt;

use autd3_cpu_wire::params::FUNC_EMULATOR_BIT;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct Version {
    pub major: u8,
    pub minor: u8,
    pub patch: u8,
}

impl Version {
    pub const UNKNOWN: Self = Self {
        major: 0,
        minor: 0,
        patch: 0,
    };

    #[must_use]
    pub const fn is_unknown(self) -> bool {
        self.major == 0 && self.minor == 0 && self.patch == 0
    }
}

impl fmt::Display for Version {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}.{}.{}", self.major, self.minor, self.patch)
    }
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct FirmwareVersion {
    pub cpu: Version,
    pub fpga: Version,
    pub(crate) function_bits: u8,
}

impl FirmwareVersion {
    #[must_use]
    pub const fn is_emulator(&self) -> bool {
        self.function_bits & (1 << FUNC_EMULATOR_BIT) != 0
    }
}

impl fmt::Display for FirmwareVersion {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "CPU: {}, FPGA: ", self.cpu)?;
        if self.fpga.is_unknown() {
            f.write_str("unknown")?;
        } else {
            write!(f, "{}", self.fpga)?;
        }
        if self.is_emulator() {
            f.write_str(" [Emulator]")?;
        }
        Ok(())
    }
}

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

    const V: Version = Version {
        major: 4,
        minor: 5,
        patch: 6,
    };

    #[test]
    fn is_emulator() {
        assert!(
            FirmwareVersion {
                cpu: V,
                fpga: V,
                function_bits: 1 << 7,
            }
            .is_emulator()
        );
        assert!(
            !FirmwareVersion {
                cpu: V,
                fpga: V,
                function_bits: 0x7F,
            }
            .is_emulator()
        );
    }

    #[test]
    fn display_appends_emulator_suffix() {
        assert_eq!(
            FirmwareVersion {
                cpu: Version {
                    major: 1,
                    minor: 2,
                    patch: 3,
                },
                fpga: V,
                function_bits: 1 << 7,
            }
            .to_string(),
            "CPU: 1.2.3, FPGA: 4.5.6 [Emulator]"
        );
    }

    #[test]
    fn display_without_emulator_bit_has_no_suffix() {
        assert_eq!(
            FirmwareVersion {
                cpu: Version {
                    major: 1,
                    minor: 2,
                    patch: 3,
                },
                fpga: V,
                function_bits: 0,
            }
            .to_string(),
            "CPU: 1.2.3, FPGA: 4.5.6"
        );
    }

    #[test]
    fn display_unknown_fpga_with_emulator_bit() {
        assert_eq!(
            FirmwareVersion {
                cpu: Version {
                    major: 1,
                    minor: 2,
                    patch: 3,
                },
                fpga: Version::UNKNOWN,
                function_bits: 1 << 7,
            }
            .to_string(),
            "CPU: 1.2.3, FPGA: unknown [Emulator]"
        );
    }
}