autd3-cpu-wire 0.9.0

Shared wire-protocol contract (command opcodes, error codes, frame layout) for the AUTD3 CPU firmware and its clients.
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

crate::wire_enum! {
    pub enum Cmd {
        Reset = 0x00,
        Synchronize = 0x01,
        SetMode = 0x02,
        Clear = 0x03,
        Nop = 0x04,
        WritePatternBuffer = 0x10,
        ConfigPattern = 0x11,
        ChangePatternBank = 0x12,
        WritePatternCompressed = 0x13,
        WritePatternFused = 0x14,
        WriteModulationBuffer = 0x20,
        ConfigModulation = 0x21,
        ChangeModulationBank = 0x22,
        WriteModulationFused = 0x23,
        SetSilencer = 0x30,
        SetPhaseCorrection = 0x40,
        SetOutputMask = 0x41,
        SetPulseWidthTable = 0x42,
        EmulateGpioIn = 0x50,
        SetGpioOut = 0x52,
        ForceFan = 0x60,
        UpdateBegin = 0x70,
        UpdateChunk = 0x71,
        UpdateCommit = 0x72,
        UpdateActivate = 0x73,
        UpdateConfirm = 0x74,
        FpgaUpdateBegin = 0x75,
        FpgaUpdateChunk = 0x76,
        FpgaUpdateCommit = 0x77,
        FpgaUpdateActivate = 0x78,
        ReadErrorDetail = 0xE0,
        ReadCpuFwVersionMajor = 0xE1,
        ReadCpuFwVersionMinor = 0xE2,
        ReadCpuFwVersionPatch = 0xE3,
        ReadFpgaFwVersionMajor = 0xE4,
        ReadFpgaFwVersionMinor = 0xE5,
        ReadFpgaFwVersionPatch = 0xE6,
        ReadFpgaState = 0xE7,
        ReadTelemetry = 0xE8,
        ReadFpgaFunctions = 0xE9,
        ReadFpgaBootImage = 0xEA,
    }
}

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

    #[test]
    fn cmd_round_trips() {
        for raw in 0u8..=0xFF {
            if let Some(c) = Cmd::from_u8(raw) {
                assert_eq!(c.as_u8(), raw);
                assert_eq!(Cmd::try_from(raw), Ok(c));
            } else {
                assert_eq!(Cmd::try_from(raw), Err(raw));
            }
        }
    }
}