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

mod change_mod_bank;
mod change_pattern_bank;
mod clear;
mod config_modulation;
mod config_pattern;
mod emulate_gpio_in;
mod force_fan;
mod nop;
mod set_gpio_out;
mod set_output_mask;
mod set_phase_correction;
mod set_pulse_width_table;
mod set_silencer;
mod synchronize;
mod write_foci_chunk;
mod write_modulation_chunk;
mod write_modulation_fused;
mod write_pattern_buffer;
mod write_pattern_compressed;
mod write_pattern_fused;

pub use change_mod_bank::ChangeModulationBank;
pub use change_pattern_bank::ChangePatternBank;
pub use clear::Clear;
pub use config_modulation::ConfigModulation;
pub use config_pattern::{ConfigFociStm, ConfigPattern};
pub use emulate_gpio_in::EmulateGpioIn;
pub use force_fan::ForceFan;
pub use nop::Nop;
pub use set_gpio_out::{GpioOut, SetGpioOut};
pub use set_output_mask::SetOutputMask;
pub use set_phase_correction::SetPhaseCorrection;
pub use set_pulse_width_table::{PWE_TABLE_SIZE, SetPulseWidthTable};
pub use set_silencer::{FixedCompletionTime, FixedUpdateRate, SetSilencer, SilencerConfig};
pub use synchronize::Synchronize;
pub(crate) use write_foci_chunk::WriteFociChunk;
pub(crate) use write_modulation_chunk::WriteModulationChunk;
pub(crate) use write_modulation_fused::WriteModulationFused;
pub use write_pattern_buffer::WritePatternBuffer;
pub(crate) use write_pattern_compressed::PATTERN_MAX_PER_FRAME;
pub use write_pattern_compressed::{PatternCompression, WritePatternCompressed};
pub(crate) use write_pattern_fused::{WriteFociStmFused, WritePatternFused};

pub(crate) use autd3_cpu_wire::layout::{MAX_FOCI_PER_FRAME, MOD_WRITE_MAX_DATA_LEN};

#[cfg(test)]
pub(crate) use write_modulation_fused::MOD_FUSED_MAX_DATA_LEN;
#[cfg(test)]
pub(crate) use write_pattern_fused::{
    PATTERN_FUSED_HEADER_BYTES, PATTERN_FUSED_MAX_FOCI_PER_FRAME,
};

use crate::error::{Error, PayloadError};
use crate::geometry::Device;
use crate::mirror::FirmwareState;
use crate::params::BUFFER_SIZE_MIN;
use crate::protocol::{Cmd, PAYLOAD_BYTES};
use crate::value::LoopBehavior;

pub(crate) fn check_index_advance(size: usize, loop_behavior: LoopBehavior) -> Result<(), Error> {
    if size < BUFFER_SIZE_MIN && !matches!(loop_behavior, LoopBehavior::Infinite) {
        return Err(PayloadError::FiniteLoopNeedsMultipleSamples { size }.into());
    }
    Ok(())
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Distribution {
    Broadcast,
    PerDevice,
}

pub trait Operation: crate::sealed::Sealed {
    fn distribution(&self) -> Distribution;

    fn encode(&self, device: &Device, out: &mut [u8; PAYLOAD_BYTES]) -> Result<Cmd, Error>;

    fn reflect(&self, device: usize, state: &mut FirmwareState) -> Result<(), Error> {
        let _ = (device, state);
        Ok(())
    }

    fn apply_dc_offset(&mut self, offset_ns: i64) {
        let _ = offset_ns;
    }
}