autd3-rs 0.9.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

use super::Command;
use crate::commands::operation::{ConfigPattern, WritePatternBuffer, WritePatternFused};
use crate::datagram::DatagramBuilder;
use crate::value::{Emission, LoopBehavior, PatternBank, SamplingConfig, TransitionMode};
use core::num::NonZeroU16;

#[derive(Clone, Copy, Debug)]
pub struct Pattern<'a> {
    pub bank: PatternBank,
    pub emissions: &'a [Vec<Emission>],
    pub transition_mode: TransitionMode,
}

impl<'a> Pattern<'a> {
    #[must_use]
    pub fn new(emissions: &'a [Vec<Emission>]) -> Self {
        Self::with_bank(PatternBank::B0, emissions)
    }

    #[must_use]
    pub fn with_bank(bank: PatternBank, emissions: &'a [Vec<Emission>]) -> Self {
        Self {
            bank,
            emissions,
            transition_mode: TransitionMode::Immediate,
        }
    }
}

impl<'a> Command<'a> for Pattern<'a> {
    fn expand(self, builder: &mut DatagramBuilder<'a>) {
        if self.transition_mode.is_later() {
            builder
                .push(WritePatternBuffer {
                    bank: self.bank,
                    index: 0,
                    emissions: self.emissions,
                })
                .push(ConfigPattern {
                    bank: self.bank,
                    config: SamplingConfig::new(NonZeroU16::MAX),
                    size: 1,
                    loop_behavior: LoopBehavior::Infinite,
                });
            return;
        }
        builder.push(WritePatternFused {
            bank: self.bank,
            emissions: self.emissions,
            config: SamplingConfig::new(NonZeroU16::MAX),
            loop_behavior: LoopBehavior::Infinite,
            transition_mode: self.transition_mode,
        });
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::geometry::Autd3;
    use crate::mirror::FREQ_DIV_NO_LIMIT;
    use crate::protocol::Cmd;
    use crate::test_utils::test_geometry_arc;

    #[test]
    fn pattern_expands_to_a_single_fused_frame() {
        let patterns = vec![vec![Emission::default(); Autd3::NUM_TRANSDUCERS]; 2];
        let mut b = DatagramBuilder::new(test_geometry_arc(2));
        b.push(Pattern::new(&patterns));
        let datagrams = b.build().unwrap();

        assert_eq!(datagrams.len(), 1, "write+config+change fused into 1 frame");

        let f = datagrams.frame(0).unwrap();
        let payload = &f.datagrams()[0].payload;
        assert_eq!(f.datagrams()[0].cmd, Cmd::WritePatternFused);
        assert_eq!(payload[0], 0, "bank B0");
        assert_eq!(&payload[2..4], &FREQ_DIV_NO_LIMIT.to_le_bytes());
        assert_eq!(&payload[4..8], &1u32.to_le_bytes(), "size = 1 index");
        assert_eq!(payload[9], 0xFF, "IMMEDIATE");
        assert_eq!(&payload[12..14], &0xFFFFu16.to_le_bytes(), "infinite rep");
    }

    #[test]
    fn later_writes_the_bank_without_changing_it() {
        let patterns = vec![vec![Emission::default(); Autd3::NUM_TRANSDUCERS]; 2];
        let mut b = DatagramBuilder::new(test_geometry_arc(2));
        b.push(Pattern {
            transition_mode: TransitionMode::Later,
            ..Pattern::with_bank(PatternBank::B1, &patterns)
        });
        let datagrams = b.build().unwrap();

        assert_eq!(
            datagrams.len(),
            2,
            "write + config, no fusion and no change"
        );
        assert_eq!(
            datagrams.frame(0).unwrap().datagrams()[0].cmd,
            Cmd::WritePatternBuffer
        );
        let cfg = datagrams.frame(1).unwrap();
        assert_eq!(cfg.datagrams()[0].cmd, Cmd::ConfigPattern);
        let payload = &cfg.datagrams()[0].payload;
        assert_eq!(payload[0], 1, "bank B1");
        assert_eq!(&payload[2..4], &FREQ_DIV_NO_LIMIT.to_le_bytes());
        assert_eq!(&payload[4..8], &1u32.to_le_bytes(), "size = 1 index");
        assert_eq!(&payload[12..14], &0xFFFFu16.to_le_bytes(), "infinite rep");
    }

    #[test]
    fn a_non_immediate_transition_reaches_the_fused_frame() {
        let patterns = vec![vec![Emission::default(); Autd3::NUM_TRANSDUCERS]; 2];
        let mut b = DatagramBuilder::new(test_geometry_arc(2));
        b.push(Pattern {
            transition_mode: TransitionMode::Ext,
            ..Pattern::new(&patterns)
        });
        let datagrams = b.build().unwrap();

        assert_eq!(datagrams.len(), 1);
        let f = datagrams.frame(0).unwrap();
        assert_eq!(f.datagrams()[0].cmd, Cmd::WritePatternFused);
        assert_eq!(f.datagrams()[0].payload[9], 0xF0, "EXT");
    }
}