laser-dac 0.12.3

Unified laser DAC abstraction supporting multiple protocols
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

//! Source-labeled LaserCube network connection profiles.

use std::time::Duration;

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum ConnectionType {
    EthernetServer,
    WifiServer,
    EthernetClient,
    WifiClient,
    Unknown(u8),
}

impl ConnectionType {
    pub fn from_status_byte(raw: u8) -> Self {
        match raw {
            0 => Self::EthernetServer,
            1 => Self::WifiServer,
            2 => Self::EthernetClient,
            3 => Self::WifiClient,
            other => Self::Unknown(other),
        }
    }
}

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum ProfileSource {
    DesktopNetworkDefault,
    UnknownConservative,
}

#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct ConnectionProfile {
    pub source: ProfileSource,
    pub connection_type: ConnectionType,
    pub remote_buffer_cutoff: usize,
    pub wait_buffer_sleep: Duration,
    pub max_udp_samples_per_packet: usize,
    pub buffer_total: usize,
}

impl ConnectionProfile {
    pub fn for_connection(connection_type: ConnectionType, buffer_total: usize) -> Self {
        match connection_type {
            ConnectionType::WifiServer => {
                Self::desktop(connection_type, 2000, 4, 140, buffer_total)
            }
            ConnectionType::EthernetServer
            | ConnectionType::EthernetClient
            | ConnectionType::WifiClient => {
                Self::desktop(connection_type, 1800, 6, 80, buffer_total)
            }
            ConnectionType::Unknown(_) => Self::unknown_conservative(buffer_total),
        }
    }

    pub fn unknown_conservative(buffer_total: usize) -> Self {
        Self {
            source: ProfileSource::UnknownConservative,
            connection_type: ConnectionType::Unknown(0),
            remote_buffer_cutoff: 1800.min(buffer_total),
            wait_buffer_sleep: Duration::from_millis(6),
            max_udp_samples_per_packet: 80,
            buffer_total,
        }
    }

    fn desktop(
        connection_type: ConnectionType,
        remote_buffer_cutoff: usize,
        wait_buffer_sleep_ms: u64,
        max_udp_samples_per_packet: usize,
        buffer_total: usize,
    ) -> Self {
        Self {
            source: ProfileSource::DesktopNetworkDefault,
            connection_type,
            remote_buffer_cutoff: remote_buffer_cutoff.min(buffer_total),
            wait_buffer_sleep: Duration::from_millis(wait_buffer_sleep_ms),
            max_udp_samples_per_packet,
            buffer_total,
        }
    }
}

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

    #[test]
    fn selects_desktop_network_profiles() {
        assert_eq!(
            ConnectionProfile::for_connection(ConnectionType::EthernetServer, 6000)
                .max_udp_samples_per_packet,
            80
        );
        assert_eq!(
            ConnectionProfile::for_connection(ConnectionType::WifiServer, 6000)
                .max_udp_samples_per_packet,
            140
        );
        assert_eq!(
            ConnectionProfile::for_connection(ConnectionType::WifiClient, 6000)
                .max_udp_samples_per_packet,
            80
        );
    }

    #[test]
    fn unknown_uses_conservative_80_sample_packets() {
        let profile = ConnectionProfile::for_connection(ConnectionType::Unknown(99), 6000);
        assert_eq!(profile.source, ProfileSource::UnknownConservative);
        assert_eq!(profile.max_udp_samples_per_packet, 80);
    }

    #[test]
    fn full_info_connection_type_is_zero_based() {
        assert_eq!(
            ConnectionType::from_status_byte(0),
            ConnectionType::EthernetServer
        );
        assert_eq!(
            ConnectionType::from_status_byte(1),
            ConnectionType::WifiServer
        );
        assert_eq!(
            ConnectionType::from_status_byte(2),
            ConnectionType::EthernetClient
        );
        assert_eq!(
            ConnectionType::from_status_byte(3),
            ConnectionType::WifiClient
        );
        assert_eq!(
            ConnectionType::from_status_byte(4),
            ConnectionType::Unknown(4)
        );
    }
}