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
141
142
143
144
145
146
147
148
149
150
151
152
153

use autd3_cpu_wire::params::{
    FPGA_STATE_BIT_MOD_BANK, FPGA_STATE_BIT_MOD_STOPPED, FPGA_STATE_BIT_PATTERN_BANK,
    FPGA_STATE_BIT_PATTERN_MODE, FPGA_STATE_BIT_PATTERN_STOPPED, FPGA_STATE_BIT_READS_ENABLED,
    FPGA_STATE_BIT_THERMAL_ASSERT, FPGA_STATE_BIT_TRANSITION_PENDING,
};
use autd3_rs_core::value::{ModulationBank, PatternBank};

#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub struct FpgaState(pub u8);

impl FpgaState {
    #[must_use]
    pub const fn raw(self) -> u8 {
        self.0
    }

    #[must_use]
    pub const fn is_thermal_asserted(self) -> bool {
        self.0 & (1 << FPGA_STATE_BIT_THERMAL_ASSERT) != 0
    }

    #[must_use]
    pub const fn current_mod_bank(self) -> ModulationBank {
        if self.0 & (1 << FPGA_STATE_BIT_MOD_BANK) != 0 {
            ModulationBank::B1
        } else {
            ModulationBank::B0
        }
    }

    #[must_use]
    pub const fn current_pattern_bank(self) -> PatternBank {
        if self.0 & (1 << FPGA_STATE_BIT_PATTERN_BANK) != 0 {
            PatternBank::B1
        } else {
            PatternBank::B0
        }
    }

    #[must_use]
    pub const fn is_pattern_mode(self) -> bool {
        self.0 & (1 << FPGA_STATE_BIT_PATTERN_MODE) != 0
    }

    #[must_use]
    pub const fn is_stm_mode(self) -> bool {
        !self.is_pattern_mode()
    }

    #[must_use]
    pub const fn is_pattern_stopped(self) -> bool {
        self.0 & (1 << FPGA_STATE_BIT_PATTERN_STOPPED) != 0
    }

    #[must_use]
    pub const fn is_mod_stopped(self) -> bool {
        self.0 & (1 << FPGA_STATE_BIT_MOD_STOPPED) != 0
    }

    #[must_use]
    pub const fn is_transition_pending(self) -> bool {
        self.0 & (1 << FPGA_STATE_BIT_TRANSITION_PENDING) != 0
    }

    #[must_use]
    pub const fn reads_enabled(self) -> bool {
        self.0 & (1 << FPGA_STATE_BIT_READS_ENABLED) != 0
    }
}

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

    #[test]
    fn is_thermal_asserted() {
        assert!(!FpgaState(0b0000_0000).is_thermal_asserted());
        assert!(FpgaState(0b0000_0001).is_thermal_asserted());
    }

    #[test]
    fn current_mod_bank() {
        assert_eq!(
            ModulationBank::B0,
            FpgaState(0b0000_0000).current_mod_bank()
        );
        assert_eq!(
            ModulationBank::B1,
            FpgaState(0b0000_0010).current_mod_bank()
        );
    }

    #[test]
    fn current_pattern_bank() {
        assert_eq!(
            PatternBank::B0,
            FpgaState(0b0000_0000).current_pattern_bank()
        );
        assert_eq!(
            PatternBank::B1,
            FpgaState(0b0000_0100).current_pattern_bank()
        );
    }

    #[test]
    fn pattern_stm_mode() {
        assert!(!FpgaState(0b0000_0000).is_pattern_mode());
        assert!(FpgaState(0b0000_0000).is_stm_mode());
        assert!(FpgaState(0b0000_1000).is_pattern_mode());
        assert!(!FpgaState(0b0000_1000).is_stm_mode());
    }

    #[test]
    fn is_pattern_stopped() {
        assert!(!FpgaState(0b0000_0000).is_pattern_stopped());
        assert!(FpgaState(0b0001_0000).is_pattern_stopped());
    }

    #[test]
    fn is_mod_stopped() {
        assert!(!FpgaState(0b0000_0000).is_mod_stopped());
        assert!(FpgaState(0b0010_0000).is_mod_stopped());
    }

    #[test]
    fn is_transition_pending() {
        assert!(!FpgaState(0b0000_0000).is_transition_pending());
        assert!(FpgaState(0b0100_0000).is_transition_pending());
    }

    #[test]
    fn reads_enabled() {
        assert!(!FpgaState(0b0000_0000).reads_enabled());
        assert!(FpgaState(0b1000_0000).reads_enabled());
    }

    #[test]
    fn raw_roundtrip() {
        assert_eq!(0b1010_1101, FpgaState(0b1010_1101).raw());
    }

    #[test]
    fn decodes_each_bit_independently() {
        let state = FpgaState(0b0101_1110);
        assert!(!state.is_thermal_asserted());
        assert_eq!(ModulationBank::B1, state.current_mod_bank());
        assert_eq!(PatternBank::B1, state.current_pattern_bank());
        assert!(state.is_pattern_mode());
        assert!(state.is_pattern_stopped());
        assert!(!state.is_mod_stopped());
        assert!(state.is_transition_pending());
    }
}