csi-webclient 0.2.1

Desktop egui client for csi-webserver REST/WebSocket control and CSI stream monitoring
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
use crate::profile::ClientProfile;
use crate::state::{
    CollectionMode, CsiDeliveryMode, CsiForm, DeviceAction, DeviceState, Ht40Mode, OutputMode,
    PHY_RATES, WiFiMode, WifiProtocol,
};

/// Render the configuration view for one device.
///
/// Pushes per-device actions into `actions`; the caller addresses them to the
/// selected device id after rendering. `all_ids` is the full attached-device
/// list, used by the "Copy from" picker. `profile` supplies any extra
/// protocol options and CSI-preset buttons.
pub fn render(
    ui: &mut egui::Ui,
    device: &mut DeviceState,
    all_ids: &[String],
    actions: &mut Vec<DeviceAction>,
    profile: &dyn ClientProfile,
) {
    ui.add(
        egui::Label::new(format!("Configuration — {}", device.id))
            .wrap(),
    );
    ui.add_space(8.0);
    render_body(ui, device, actions, profile);
    render_persistence(ui, device, all_ids, actions);
}

fn render_body(
    ui: &mut egui::Ui,
    device: &mut DeviceState,
    actions: &mut Vec<DeviceAction>,
    profile: &dyn ClientProfile,
) {
    let device_id = device.id.clone();
    let supports_v07 = device.supports_v07_modes();
    let supports_unsolicited = device.supports_unsolicited();
    let forms = &mut device.forms;
    let field_width = text_field_width(ui, 140.0);

    section_header(ui, "Wi-Fi", |ui| {
        form_row(ui, "Mode", |ui| {
            wifi_mode_picker(ui, &device_id, supports_v07, &mut forms.wifi.mode);
        });

        if forms.wifi.mode.requires_v07() && !supports_v07 {
            ui.colored_label(
                egui::Color32::YELLOW,
                "Selected mode requires esp-csi-cli-rs ≥ 0.7.0 on this device.",
            );
        }

        if matches!(forms.wifi.mode, WiFiMode::Station) {
            form_row(ui, "STA SSID", |ui| {
                ui.add(
                    egui::TextEdit::singleline(&mut forms.wifi.sta_ssid).desired_width(field_width),
                );
            });

            form_row(ui, "STA Password", |ui| {
                ui.add(
                    egui::TextEdit::singleline(&mut forms.wifi.sta_password)
                        .password(true)
                        .desired_width(field_width),
                );
            });
        }

        if matches!(forms.wifi.mode, WiFiMode::WifiAp) {
            form_row(ui, "AP SSID", |ui| {
                ui.add(
                    egui::TextEdit::singleline(&mut forms.wifi.ap_ssid).desired_width(field_width),
                );
            });

            form_row(ui, "AP Password", |ui| {
                ui.add(
                    egui::TextEdit::singleline(&mut forms.wifi.ap_password)
                        .password(true)
                        .desired_width(field_width),
                );
            });

            ui.checkbox(&mut forms.wifi.ap_dhcp, "AP DHCP (built-in server)");

            form_row(ui, "AP leases", |ui| {
                ui.add(egui::DragValue::new(&mut forms.wifi.ap_leases).range(1..=8))
                    .on_hover_text(
                        "DHCP lease pool size (1-8). With more than one lease the \
                         ICMP flood targets every associated station; 1 restores \
                         the legacy single-target flood.",
                    );
            });

            ui.checkbox(&mut forms.wifi.ap_burst, "Sync burst flood")
                .on_hover_text(
                    "Every flood tick sends one frame back-to-back to every \
                     associated station (time-aligned multi-receiver CSI). \
                     Each station then sees the full traffic rate, so total \
                     airtime = frequency × leases — lower the traffic rate if \
                     the channel saturates. Off = round-robin one station per \
                     tick.",
                );
        }

        form_row(ui, "Channel", |ui| {
            ui.add(egui::TextEdit::singleline(&mut forms.wifi.channel).desired_width(80.0));
        });
        if forms.wifi.mode.channel_is_hint() {
            ui.add(
                egui::Label::new(
                    "Optional pre-association band-selection hint (e.g. 6 on 2.4 GHz, or a \
                     5 GHz channel on the C5). Leave blank to inherit the channel from the \
                     associated AP.",
                )
                .wrap(),
            );
            ui.add_space(6.0);
        }

        if forms.wifi.mode.is_esp_now() {
            form_row(ui, "Peer MAC", |ui| {
                ui.add(
                    egui::TextEdit::singleline(&mut forms.wifi.peer_mac)
                        .hint_text("auto")
                        .desired_width(field_width),
                );
            });

            form_row(ui, "HT40 secondary", |ui| {
                ht40_picker(ui, &mut forms.wifi.ht40);
            });

            ui.add_space(4.0);
            ui.add(
                egui::Label::new(
                    "Peer MAC / HT40 apply to all ESP-NOW modes; empty MAC = auto.",
                )
                .wrap(),
            );
        }

        ui.add_space(8.0);
        if ui.button("Apply Wi-Fi Config").clicked() {
            actions.push(DeviceAction::SetWifi(forms.wifi.clone()));
        }

        ui.add_space(12.0);
        let extra_protocols = profile.extra_protocols();
        form_row(ui, "PHY Protocol", |ui| {
            protocol_picker(ui, &mut forms.protocol, extra_protocols);
            if ui.button("Apply Protocol").clicked() {
                actions.push(DeviceAction::SetProtocol(forms.protocol));
            }
        });
        ui.add(
            egui::Label::new(
                "Applied at the start of each run. Default lr (Long-Range) is proprietary; \
                 use n to associate with a standard AP in station mode.",
            )
            .wrap(),
        );
    });

    section_header(ui, "Traffic", |ui| {
        form_row(ui, "Frequency (Hz)", |ui| {
            ui.add(
                egui::TextEdit::singleline(&mut forms.traffic.frequency_hz).desired_width(120.0),
            );
            if ui.button("Apply Traffic Config").clicked() {
                actions.push(DeviceAction::SetTraffic(forms.traffic.clone()));
            }
        });
        ui.add(
            egui::Label::new(
                "For AP + station lab pairs: AP floods at 1000 Hz, station stays \
                 receive-only (frequency 0).",
            )
            .wrap(),
        );

        // The flood-kind toggle only exists for the WiFi infra modes: ESP-NOW
        // modes transmit their own frames and sniffers generate no traffic.
        if matches!(forms.wifi.mode, WiFiMode::WifiAp | WiFiMode::Station) {
            let traffic_on = forms
                .traffic
                .frequency_hz
                .trim()
                .parse::<u64>()
                .is_ok_and(|hz| hz > 0);
            ui.add_space(4.0);
            // Moot while traffic generation is off (frequency 0/blank), and
            // unsupported (whole set-traffic command rejected!) below 0.7.0.
            ui.add_enabled_ui(traffic_on && supports_unsolicited, |ui| {
                ui.checkbox(
                    &mut forms.traffic.unsolicited,
                    "Unsolicited echo-reply flood (one-directional)",
                );
            });
            if !supports_unsolicited {
                ui.colored_label(
                    egui::Color32::YELLOW,
                    "Unsolicited flood requires esp-csi-cli-rs ≥ 0.7.0 on this device — \
                     reflash to use it (the flag is not sent to older firmware).",
                );
            }
            ui.add(
                egui::Label::new(
                    "Floods unsolicited echo replies the peer silently ignores: no reply \
                     contention, stable offered rate — but this device captures no CSI \
                     back from the peer; collect on the peer instead.",
                )
                .wrap(),
            );
            if traffic_on
                && forms.traffic.unsolicited
                && matches!(forms.collection_mode, CollectionMode::Collector)
            {
                ui.colored_label(
                    egui::Color32::YELLOW,
                    "Unsolicited flood + Collector: this node will capture ~no CSI. \
                     Set Collector on the peer, or disable the unsolicited flood.",
                );
            }
        }
    });

    section_header(ui, "CSI Flags", |ui| {
        render_csi_flags(ui, &mut forms.csi);

        ui.add_space(8.0);
        form_row(ui, "val_scale_cfg (u32)", |ui| {
            ui.add(
                egui::TextEdit::singleline(&mut forms.csi.val_scale_cfg).desired_width(80.0),
            );
        });

        ui.add_space(8.0);
        if ui.button("Apply CSI Config").clicked() {
            actions.push(DeviceAction::SetCsi(forms.csi.clone()));
        }
        // Profile-supplied CSI-preset buttons (none in the standard build).
        profile.extra_preset_buttons(ui, actions);
    });

    section_header(ui, "PHY Rate", |ui| {
        form_row(ui, "Rate", |ui| {
            phy_rate_picker(ui, &mut forms.phy_rate.rate);
            if ui.button("Apply Rate").clicked() {
                actions.push(DeviceAction::SetPhyRate(forms.phy_rate.clone()));
            }
        });
        ui.add(
            egui::Label::new(
                "Honored by all ESP-NOW modes (incl. fast simplex) and wifi-ap/sniffer; \
                 ignored by station.",
            )
            .wrap(),
        );
    });

    section_header(ui, "IO Tasks", |ui| {
        ui.checkbox(&mut forms.io_tasks.tx, "TX (traffic generation)");
        ui.add_space(4.0);
        ui.checkbox(&mut forms.io_tasks.rx, "RX (CSI capture)");
        ui.add_space(8.0);
        if ui.button("Apply IO Tasks").clicked() {
            actions.push(DeviceAction::SetIoTasks(forms.io_tasks.clone()));
        }
    });

    section_header(ui, "CSI Delivery", |ui| {
        form_row(ui, "Mode", |ui| {
            csi_delivery_picker(ui, &mut forms.csi_delivery.mode);
        });
        ui.checkbox(&mut forms.csi_delivery.logging, "inline UART logging");
        ui.add_space(8.0);
        if ui.button("Apply CSI Delivery").clicked() {
            actions.push(DeviceAction::SetCsiDelivery(forms.csi_delivery.clone()));
        }
    });

    section_header(ui, "Collection & Output", |ui| {
        form_row(ui, "Collection Mode", |ui| {
            collection_mode_picker(ui, &mut forms.collection_mode);
            if ui.button("Apply").clicked() {
                actions.push(DeviceAction::SetCollectionMode(forms.collection_mode));
            }
        });

        form_row(ui, "Output Mode", |ui| {
            output_mode_picker(ui, &mut forms.output_mode);
            if ui.button("Apply").clicked() {
                actions.push(DeviceAction::SetOutputMode(forms.output_mode));
            }
        });
    });

    ui.add_space(12.0);
    ui.horizontal_wrapped(|ui| {
        if ui.button("Reset Config Defaults").clicked() {
            actions.push(DeviceAction::ResetConfig);
        }
        if ui.button("Refresh Config").clicked() {
            actions.push(DeviceAction::FetchConfig);
        }
    });
}

/// Save/load config snapshots and copy configuration between devices.
fn render_persistence(
    ui: &mut egui::Ui,
    device: &mut DeviceState,
    all_ids: &[String],
    actions: &mut Vec<DeviceAction>,
) {
    let device_id = device.id.clone();
    let field_width = text_field_width(ui, 140.0);

    section_header(ui, "Save / Load / Copy", |ui| {
        form_row(ui, "Config file", |ui| {
            ui.add(
                egui::TextEdit::singleline(&mut device.config_path)
                    .hint_text("auto-named in export dir")
                    .desired_width(field_width),
            );
        });
        ui.horizontal_wrapped(|ui| {
            if ui.button("Save to File").clicked() {
                actions.push(DeviceAction::SaveConfigFile {
                    path: device.config_path.clone(),
                });
            }
            if ui.button("Load & Apply").clicked() {
                actions.push(DeviceAction::LoadConfigFile {
                    path: device.config_path.clone(),
                });
            }
            if ui.button("Apply All to Device").clicked() {
                actions.push(DeviceAction::ApplyFullConfig);
            }
        });
        ui.add_space(4.0);
        ui.add(
            egui::Label::new(
                "Save writes the form values above as JSON (including Wi-Fi passwords, in \
                 plain text). Load fills the form and pushes every section to the device; \
                 Apply All re-pushes the current form after manual edits.",
            )
            .wrap(),
        );

        let others: Vec<&String> = all_ids.iter().filter(|id| **id != device_id).collect();
        if !others.is_empty() {
            ui.add_space(8.0);
            form_row(ui, "Copy from", |ui| {
                if !others.iter().any(|id| **id == device.copy_source) {
                    device.copy_source = (*others[0]).clone();
                }
                egui::ComboBox::from_id_salt(format!("copy_source_combo_{device_id}"))
                    .selected_text(device.copy_source.clone())
                    .show_ui(ui, |ui| {
                        for id in &others {
                            ui.selectable_value(&mut device.copy_source, (*id).clone(), *id);
                        }
                    });
                if ui.button("Copy & Apply").clicked() {
                    actions.push(DeviceAction::CopyConfigFrom {
                        source_id: device.copy_source.clone(),
                    });
                }
            });
            ui.add(
                egui::Label::new(
                    "Copies the source device's form values onto this device and applies \
                     them, including the ESP-NOW peer MAC — clear it afterwards if the \
                     pair should differ.",
                )
                .wrap(),
            );
        }
    });
}

/// Collapsing section, open by default, with spacing below.
fn section_header(ui: &mut egui::Ui, title: &str, body: impl FnOnce(&mut egui::Ui)) {
    egui::CollapsingHeader::new(title)
        .default_open(true)
        .show(ui, |ui| {
            ui.add_space(6.0);
            body(ui);
        });
    ui.add_space(12.0);
}

/// One labeled form row; wraps when the panel is narrower than label + controls.
fn form_row(ui: &mut egui::Ui, label: &str, widgets: impl FnOnce(&mut egui::Ui)) {
    ui.horizontal_wrapped(|ui| {
        ui.label(label);
        ui.add_space(8.0);
        widgets(ui);
    });
    ui.add_space(6.0);
}

/// Width for text inputs: fill remaining panel space without forcing overflow.
fn text_field_width(ui: &egui::Ui, label_reserve: f32) -> f32 {
    (ui.available_width() - label_reserve - 16.0)
        .clamp(80.0, 480.0)
}

/// CSI disable flags — explicit columns sized to the panel (Grid overflows here).
fn render_csi_flags(ui: &mut egui::Ui, csi: &mut CsiForm) {
    let panel_w = ui.available_width();
    let two_cols = panel_w >= 360.0;

    if two_cols {
        let col_w = ((panel_w - 12.0) / 2.0).max(120.0);
        ui.horizontal_top(|ui| {
            ui.vertical(|ui| {
                ui.set_max_width(col_w);
                csi_flag_column_a(ui, csi);
            });
            ui.add_space(12.0);
            ui.vertical(|ui| {
                ui.set_max_width(col_w);
                csi_flag_column_b(ui, csi);
            });
        });
    } else {
        ui.vertical(|ui| {
            ui.set_max_width(panel_w);
            csi_flag_column_a(ui, csi);
            csi_flag_column_b(ui, csi);
        });
    }
}

fn csi_flag_column_a(ui: &mut egui::Ui, csi: &mut CsiForm) {
    ui.checkbox(&mut csi.lltf, "lltf");
    ui.checkbox(&mut csi.htltf, "htltf");
    ui.checkbox(&mut csi.stbc_htltf, "stbc_htltf");
    ui.checkbox(&mut csi.ltf_merge, "ltf_merge");
    ui.checkbox(&mut csi.csi, "csi");
    ui.checkbox(&mut csi.csi_legacy, "csi_legacy");
}

fn csi_flag_column_b(ui: &mut egui::Ui, csi: &mut CsiForm) {
    ui.checkbox(&mut csi.csi_ht20, "csi_ht20");
    ui.checkbox(&mut csi.csi_ht40, "csi_ht40");
    ui.checkbox(&mut csi.dump_ack, "dump_ack");
    ui.checkbox(&mut csi.csi_force_lltf, "csi_force_lltf (C5)");
    ui.checkbox(&mut csi.csi_vht, "csi_vht (C5)");
}

fn wifi_mode_picker(ui: &mut egui::Ui, device_id: &str, supports_v07: bool, mode: &mut WiFiMode) {
    egui::ComboBox::from_id_salt(format!("wifi_mode_combo_{device_id}"))
        .selected_text(mode.as_api_value())
        .show_ui(ui, |ui| {
            ui.selectable_value(mode, WiFiMode::Station, "station");
            ui.selectable_value(mode, WiFiMode::Sniffer, "sniffer");
            ui.add_enabled_ui(supports_v07, |ui| {
                ui.selectable_value(mode, WiFiMode::WifiAp, "wifi-ap (≥ 0.7.0)");
            });
            ui.selectable_value(mode, WiFiMode::EspNowCentral, "esp-now-central");
            ui.selectable_value(mode, WiFiMode::EspNowPeripheral, "esp-now-peripheral");
            ui.add_enabled_ui(supports_v07, |ui| {
                ui.selectable_value(
                    mode,
                    WiFiMode::EspNowFastCollector,
                    "esp-now-fast-collector (≥ 0.7.0)",
                );
                ui.selectable_value(
                    mode,
                    WiFiMode::EspNowFastSource,
                    "esp-now-fast-source (≥ 0.7.0)",
                );
            });
        });
}

fn collection_mode_picker(ui: &mut egui::Ui, mode: &mut CollectionMode) {
    egui::ComboBox::from_id_salt("collection_mode_combo")
        .selected_text(mode.as_api_value())
        .show_ui(ui, |ui| {
            ui.selectable_value(mode, CollectionMode::Collector, "collector");
            ui.selectable_value(mode, CollectionMode::Listener, "listener");
        });
}

fn ht40_picker(ui: &mut egui::Ui, mode: &mut Ht40Mode) {
    egui::ComboBox::from_id_salt("ht40_combo")
        .selected_text(mode.as_api_value())
        .show_ui(ui, |ui| {
            ui.selectable_value(mode, Ht40Mode::None, "none");
            ui.selectable_value(mode, Ht40Mode::Above, "above");
            ui.selectable_value(mode, Ht40Mode::Below, "below");
        });
}

fn output_mode_picker(ui: &mut egui::Ui, mode: &mut OutputMode) {
    egui::ComboBox::from_id_salt("output_mode_combo")
        .selected_text(mode.as_api_value())
        .show_ui(ui, |ui| {
            ui.selectable_value(mode, OutputMode::Stream, "stream");
            ui.selectable_value(mode, OutputMode::Dump, "dump");
            ui.selectable_value(mode, OutputMode::Both, "both");
        });
}

fn csi_delivery_picker(ui: &mut egui::Ui, mode: &mut CsiDeliveryMode) {
    egui::ComboBox::from_id_salt("csi_delivery_combo")
        .selected_text(mode.as_api_value())
        .show_ui(ui, |ui| {
            ui.selectable_value(mode, CsiDeliveryMode::Off, "off");
            ui.selectable_value(mode, CsiDeliveryMode::Callback, "callback");
            ui.selectable_value(mode, CsiDeliveryMode::Async, "async");
            ui.selectable_value(mode, CsiDeliveryMode::Raw, "raw");
        });
}

fn protocol_picker(
    ui: &mut egui::Ui,
    protocol: &mut WifiProtocol,
    extra_protocols: &[&'static str],
) {
    egui::ComboBox::from_id_salt("protocol_combo")
        .selected_text(protocol.as_api_value())
        .show_ui(ui, |ui| {
            ui.selectable_value(protocol, WifiProtocol::B, "b");
            ui.selectable_value(protocol, WifiProtocol::G, "g");
            ui.selectable_value(protocol, WifiProtocol::N, "n");
            ui.selectable_value(protocol, WifiProtocol::Lr, "lr");
            ui.selectable_value(protocol, WifiProtocol::A, "a");
            ui.selectable_value(protocol, WifiProtocol::Ac, "ac");
            for extra in extra_protocols {
                ui.selectable_value(protocol, WifiProtocol::Ext(extra), *extra);
            }
        });
}

fn phy_rate_picker(ui: &mut egui::Ui, rate: &mut String) {
    egui::ComboBox::from_id_salt("phy_rate_combo")
        .selected_text(rate.as_str())
        .show_ui(ui, |ui| {
            for option in PHY_RATES {
                ui.selectable_value(rate, (*option).to_owned(), *option);
            }
        });
}