Skip to main content

rodecaster_protocol/names/
network.rs

1//! [`NetworkParam`]: the singleton `NETWORK`-node parameter family.
2
3// The fifty-six properties a real Pro II / Duo fullSync carries on the single
4// NETWORK node (confirmed from capture, firmware 1.7.3): Bluetooth pairing +
5// scan slots, cellular link, wired networking, WiFi PSK / SSID / scan slots.
6// The `bt*Scan1..10` and `wifiScan1..10` slots are the discovery-results
7// buffers the device fills as it scans; `btPairedNumber1..5` remembers the
8// last five paired devices.
9wire_param_enum! {
10    /// A device-wide networking parameter: one of the flat properties the
11    /// device carries on the singleton `NETWORK` node. Covers Bluetooth
12    /// (visibility, scan trigger, pairing, connection state, ten scan
13    /// result slots, five paired-device memory slots), cellular data
14    /// (APN, IP config, USB modem presence), wired IP (gateway, DNS,
15    /// static-IP toggle), WiFi (SSID, PSK, IP config, ten scan result
16    /// slots, DHCP), and the wired-Ethernet connected flag. Un-typed
17    /// properties fall back to `NetworkParam::Other` for forward-compat.
18    NetworkParam {
19    // Bluetooth visibility + scan trigger.
20    BtVisible => "btVisible",
21    BtDoScan => "btDoScan",
22    // Bluetooth pairing / connection lifecycle.
23    BtDoPair => "btDoPair",
24    BtDoUnPair => "btDoUnPair",
25    BtDoConnect => "btDoConnect",
26    BtDoDisconnect => "btDoDisconnect",
27    BtPairCode => "btPairCode",
28    BtConnectedAddress => "btConnectedAddress",
29    BtConnectedType => "btConnectedType",
30    // Bluetooth paired-device memory (last five).
31    BtPairedNumber1 => "btPairedNumber1",
32    BtPairedNumber2 => "btPairedNumber2",
33    BtPairedNumber3 => "btPairedNumber3",
34    BtPairedNumber4 => "btPairedNumber4",
35    BtPairedNumber5 => "btPairedNumber5",
36    // Bluetooth scan-result slots (ten).
37    BtScan1 => "btScan1",
38    BtScan2 => "btScan2",
39    BtScan3 => "btScan3",
40    BtScan4 => "btScan4",
41    BtScan5 => "btScan5",
42    BtScan6 => "btScan6",
43    BtScan7 => "btScan7",
44    BtScan8 => "btScan8",
45    BtScan9 => "btScan9",
46    BtScan10 => "btScan10",
47    // Cellular data link.
48    CellApn => "cellAPN",
49    CellEnabled => "cellEnabled",
50    CellGateway => "cellGateway",
51    CellIpAddress => "cellIpAddress",
52    CellSubnetMask => "cellSubnetMask",
53    CellUsbFound => "cellUSBFound",
54    // Wired IP configuration.
55    Gateway => "gateway",
56    IpAddress => "ipAddress",
57    PrimaryDns => "primaryDns",
58    SecondaryDns => "secondaryDns",
59    StaticIpSet => "staticIpSet",
60    SubnetMask => "subnetMask",
61    // Wired Ethernet link state.
62    WiredConnected => "wiredConnected",
63    // WiFi state + credentials.
64    Wifi => "wifi",
65    WifiDhcp => "wifiDHCP",
66    WifiGateway => "wifiGateway",
67    WifiIncorrectPsk => "wifiIncorrectPSK",
68    WifiIpAddress => "wifiIpAddress",
69    WifiPsk => "wifiPSK",
70    WifiSsid => "wifiSSID",
71    WifiSubnetMask => "wifiSubnetMask",
72    // WiFi scan trigger.
73    WifiScan => "wifiScan",
74    // WiFi scan-result slots (ten).
75    WifiScan1 => "wifiScan1",
76    WifiScan2 => "wifiScan2",
77    WifiScan3 => "wifiScan3",
78    WifiScan4 => "wifiScan4",
79    WifiScan5 => "wifiScan5",
80    WifiScan6 => "wifiScan6",
81    WifiScan7 => "wifiScan7",
82    WifiScan8 => "wifiScan8",
83    WifiScan9 => "wifiScan9",
84    WifiScan10 => "wifiScan10",
85    }
86}
87
88#[cfg(test)]
89mod tests {
90    use super::*;
91
92    #[test]
93    fn network_param_name_round_trips_all() {
94        let params = [
95            NetworkParam::BtVisible,
96            NetworkParam::BtDoScan,
97            NetworkParam::BtConnectedAddress,
98            NetworkParam::CellApn,
99            NetworkParam::Gateway,
100            NetworkParam::Wifi,
101            NetworkParam::WifiScan1,
102            NetworkParam::WiredConnected,
103        ];
104        for p in params {
105            assert_eq!(NetworkParam::from_name(p.as_str()), p);
106            assert!(p.is_known());
107        }
108    }
109
110    #[test]
111    fn network_param_preserves_firmware_casing() {
112        // The wire names carry firmware casing quirks (APN, DHCP, PSK, USB, SSID).
113        assert_eq!(NetworkParam::CellApn.as_str(), "cellAPN");
114        assert_eq!(NetworkParam::WifiDhcp.as_str(), "wifiDHCP");
115        assert_eq!(NetworkParam::WifiPsk.as_str(), "wifiPSK");
116        assert_eq!(NetworkParam::WifiIncorrectPsk.as_str(), "wifiIncorrectPSK");
117        assert_eq!(NetworkParam::WifiSsid.as_str(), "wifiSSID");
118        assert_eq!(NetworkParam::CellUsbFound.as_str(), "cellUSBFound");
119    }
120
121    #[test]
122    fn network_param_unknown_falls_back_to_other() {
123        let p = NetworkParam::from_name("wifiSomethingElse");
124        assert_eq!(p, NetworkParam::Other("wifiSomethingElse".to_string()));
125        assert!(!p.is_known());
126    }
127}