-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathsta.rs
712 lines (612 loc) · 22.1 KB
/
sta.rs
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
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
use core::{alloc::AllocError, ptr::addr_of, sync::atomic::Ordering};
use crate::{
board::{
initialized::Context,
wifi::{sta_net_task, StackWrapper},
},
task_control::{TaskControlToken, TaskController},
Shared,
};
use alloc::{boxed::Box, rc::Rc, vec::Vec};
use config_site::data::network::WifiNetwork;
use embassy_executor::Spawner;
use embassy_futures::{
join::join,
select::{select, Either},
};
use embassy_net::{dns::DnsSocket, Config};
use embassy_sync::{
blocking_mutex::raw::NoopRawMutex,
channel::Channel,
mutex::{Mutex, MutexGuard},
signal::Signal,
};
use embassy_time::{with_timeout, Duration};
use enumset::EnumSet;
use esp_hal::{peripherals::WIFI, rng::Rng};
use esp_wifi::{
wifi::{
AccessPointInfo, ClientConfiguration, Configuration, WifiController, WifiDevice, WifiEvent,
WifiStaDevice,
},
EspWifiInitialization,
};
use gui::widgets::wifi_client::WifiClientState;
use macros as cardio;
use reqwless::client::{HttpClient, TlsConfig, TlsVerify};
pub(super) const SCAN_RESULTS: usize = 20;
pub(super) struct StaConnectionState {
signal: Signal<NoopRawMutex, ()>,
value: AtomicInternalConnectionState,
}
impl StaConnectionState {
pub fn new() -> StaConnectionState {
Self {
signal: Signal::new(),
value: AtomicInternalConnectionState::new(InternalConnectionState::NotConnected),
}
}
async fn wait(&self) -> InternalConnectionState {
self.signal.wait().await;
self.read()
}
fn read(&self) -> InternalConnectionState {
self.value.load(Ordering::Acquire)
}
fn update(&self, value: InternalConnectionState) {
debug!("Updating connection state: {:?}", value);
self.value.store(value, Ordering::Release);
self.signal.signal(());
}
}
#[derive(PartialEq, Clone, Copy)]
pub enum NetworkPreference {
Preferred,
Deprioritized,
}
/// A network SSID and password, with an object used to deprioritize unstable networks.
pub type KnownNetwork = (WifiNetwork, NetworkPreference);
type Command = (StaCommand, Rc<Signal<NoopRawMutex, ()>>);
pub type CommandQueue = Channel<NoopRawMutex, Command, 1>;
#[derive(PartialEq, Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
#[portable_atomic_enum::atomic_enum]
pub(super) enum InternalConnectionState {
NotConnected,
Connecting,
WaitingForIp,
Connected,
Disconnected,
}
impl From<InternalConnectionState> for WifiClientState {
fn from(value: InternalConnectionState) -> Self {
match value {
InternalConnectionState::NotConnected | InternalConnectionState::Disconnected => {
WifiClientState::NotConnected
}
InternalConnectionState::Connecting | InternalConnectionState::WaitingForIp => {
WifiClientState::Connecting
}
InternalConnectionState::Connected => WifiClientState::Connected,
}
}
}
#[derive(Clone)]
pub struct Sta {
pub(super) sta_stack: Rc<StackWrapper<WifiStaDevice>>,
pub(super) networks: Shared<heapless::Vec<AccessPointInfo, SCAN_RESULTS>>,
pub(super) known_networks: Shared<Vec<KnownNetwork>>,
pub(super) state: Rc<StaConnectionState>,
pub(super) command_queue: Rc<CommandQueue>,
pub(super) rng: Rng,
}
impl Sta {
pub fn connection_state(&self) -> WifiClientState {
self.state.read().into()
}
pub async fn visible_networks(
&self,
) -> MutexGuard<'_, NoopRawMutex, heapless::Vec<AccessPointInfo, SCAN_RESULTS>> {
self.networks.lock().await
}
pub async fn update_known_networks(&self, networks: &[WifiNetwork]) {
let mut known = self.known_networks.lock().await;
known.clear();
for network in networks {
if !known.iter().any(|(kn, _)| kn == network) {
known.push((network.clone(), NetworkPreference::Preferred));
}
}
}
pub async fn wait_for_state_change(&self) -> WifiClientState {
self.state.wait().await.into()
}
pub async fn wait_for_connection(&self, context: &mut Context) -> bool {
if self.connection_state() != WifiClientState::Connected {
debug!("Waiting for network connection");
let _ = select(
async {
loop {
let result =
with_timeout(Duration::from_secs(10), self.wait_for_state_change())
.await;
match result {
Ok(WifiClientState::Connected) => break,
Ok(_state) => {}
_ => {
debug!("State change timeout");
break;
}
}
}
},
async {
loop {
// A message is displayed for at least 300ms so we don't need to wait here.
context.display_message("Connecting...").await;
}
},
)
.await;
}
if self.connection_state() == WifiClientState::Connected {
true
} else {
debug!("No network connection");
false
}
}
/// Allocates resources for an HTTPS capable [`HttpClient`].
pub fn https_client_resources(&self) -> Result<HttpsClientResources<'_>, AllocError> {
// The client state must be heap allocated, because we take a reference to it.
let resources = Box::try_new(TlsClientState::EMPTY)?;
let client_state = unsafe { unwrap!(addr_of!(resources.tcp_state).as_ref()) };
Ok(HttpsClientResources {
resources,
tcp_client: TcpClient::new(&self.sta_stack, client_state),
dns_client: DnsSocket::new(&self.sta_stack),
rng: self.rng,
})
}
pub async fn send_command(&self, command: StaCommand) -> bool {
let processed = Rc::new(Signal::new());
if !self
.command_queue
.try_send((command, processed.clone()))
.is_ok()
{
return false;
}
processed.wait().await;
true
}
}
const SOCKET_COUNT: usize = 1;
const SOCKET_TX_BUFFER: usize = 8 * 1024;
const SOCKET_RX_BUFFER: usize = 16 * 1024;
const TLS_READ_BUFFER: usize = 16 * 1024 + 256;
const TLS_WRITE_BUFFER: usize = 4096;
type TcpClientState =
embassy_net::tcp::client::TcpClientState<SOCKET_COUNT, SOCKET_TX_BUFFER, SOCKET_RX_BUFFER>;
type TcpClient<'a> = embassy_net::tcp::client::TcpClient<
'a,
WifiDevice<'static, WifiStaDevice>,
SOCKET_COUNT,
SOCKET_TX_BUFFER,
SOCKET_RX_BUFFER,
>;
struct TlsClientState {
tcp_state: TcpClientState,
tls_read_buffer: [u8; TLS_READ_BUFFER], // must be 16K
tls_write_buffer: [u8; TLS_WRITE_BUFFER],
}
impl TlsClientState {
pub const EMPTY: Self = Self {
tcp_state: TcpClientState::new(),
tls_read_buffer: [0; TLS_READ_BUFFER],
tls_write_buffer: [0; TLS_WRITE_BUFFER],
};
}
pub struct HttpsClientResources<'a> {
resources: Box<TlsClientState>,
tcp_client: TcpClient<'a>,
dns_client: DnsSocket<'a, WifiDevice<'static, WifiStaDevice>>,
rng: Rng,
}
impl<'a> HttpsClientResources<'a> {
pub fn client(
&mut self,
) -> HttpClient<'_, TcpClient<'a>, DnsSocket<'a, WifiDevice<'static, WifiStaDevice>>> {
let upper = self.rng.random() as u64;
let lower = self.rng.random() as u64;
let seed = (upper << 32) | lower;
HttpClient::new_with_tls(
&self.tcp_client,
&self.dns_client,
TlsConfig::new(
seed,
&mut self.resources.tls_read_buffer,
&mut self.resources.tls_write_buffer,
TlsVerify::None,
),
)
}
}
pub(super) struct StaState {
init: EspWifiInitialization,
connection_task_control: TaskController<(), StaTaskResources>,
net_task_control: TaskController<!>,
handle: Sta,
}
impl StaState {
pub(super) fn init(
init: EspWifiInitialization,
config: Config,
wifi: &'static mut WIFI,
rng: Rng,
spawner: Spawner,
) -> Self {
info!("Configuring STA");
let (sta_device, controller) =
unwrap!(esp_wifi::wifi::new_with_mode(&init, wifi, WifiStaDevice));
info!("Starting STA");
let sta_stack = StackWrapper::new(sta_device, config, rng);
let networks = Rc::new(Mutex::new(heapless::Vec::new()));
let known_networks = Rc::new(Mutex::new(Vec::new()));
let state = Rc::new(StaConnectionState::new());
let net_task_control = TaskController::new();
let command_queue = Rc::new(CommandQueue::new());
let connection_task_control =
TaskController::from_resources(StaTaskResources { controller });
info!("Starting STA task");
spawner.must_spawn(sta_task(
StaController::new(
state.clone(),
networks.clone(),
known_networks.clone(),
sta_stack.clone(),
command_queue.clone(),
InitialStaControllerState::ScanAndConnect,
),
connection_task_control.token(),
));
info!("Starting NET task");
spawner.must_spawn(sta_net_task(sta_stack.clone(), net_task_control.token()));
Self {
init,
net_task_control,
connection_task_control,
handle: Sta {
sta_stack,
networks,
known_networks,
state,
command_queue,
rng,
},
}
}
pub(super) async fn stop(mut self) -> EspWifiInitialization {
info!("Stopping STA");
let _ = join(
self.connection_task_control.stop(),
self.net_task_control.stop(),
)
.await;
let controller = &mut self.connection_task_control.resources_mut().controller;
if matches!(controller.is_started(), Ok(true)) {
unwrap!(controller.stop().await);
}
info!("Stopped STA");
self.init
}
pub(crate) fn handle(&self) -> &Sta {
&self.handle
}
}
struct StaTaskResources {
controller: WifiController<'static>,
}
pub(super) enum InitialStaControllerState {
Idle,
ScanAndConnect,
}
impl From<InitialStaControllerState> for StaControllerState {
fn from(value: InitialStaControllerState) -> Self {
match value {
InitialStaControllerState::Idle => Self::Idle,
InitialStaControllerState::ScanAndConnect => Self::ScanAndConnect,
}
}
}
enum StaControllerState {
Idle,
ScanAndConnect,
Connect(u8), // select network, start connection
AutoConnecting, // waiting for IP
AutoConnected, // wait for disconnection
}
const NO_TIMEOUT: Duration = Duration::MAX;
const SCAN_PERIOD: Duration = Duration::from_secs(5);
const CONTINUE: Duration = Duration::from_millis(0);
const CONNECT_RETRY_PERIOD: Duration = Duration::from_millis(100);
const CONNECT_RETRY_COUNT: u8 = 5;
pub enum StaCommand {
ScanOnce,
}
struct ConnectError;
struct NetworkConfigureError;
pub(super) struct StaController {
state: Rc<StaConnectionState>,
controller_state: StaControllerState,
networks: Shared<heapless::Vec<AccessPointInfo, SCAN_RESULTS>>,
known_networks: Shared<Vec<KnownNetwork>>,
stack: Rc<StackWrapper<WifiStaDevice>>,
command_queue: Rc<CommandQueue>,
}
impl StaController {
pub fn new(
state: Rc<StaConnectionState>,
networks: Shared<heapless::Vec<AccessPointInfo, SCAN_RESULTS>>,
known_networks: Shared<Vec<KnownNetwork>>,
stack: Rc<StackWrapper<WifiStaDevice>>,
command_queue: Rc<CommandQueue>,
initial_state: InitialStaControllerState,
) -> Self {
Self {
state,
networks,
known_networks,
stack,
command_queue,
controller_state: initial_state.into(),
}
}
async fn do_scan(&mut self, controller: &mut WifiController<'_>) {
info!("Scanning...");
let mut scan_results = Box::new(controller.scan_n::<SCAN_RESULTS>().await);
match scan_results.as_mut() {
Ok((ref mut visible_networks, network_count)) => {
info!("Found {} access points", network_count);
// Sort by signal strength, descending
visible_networks.sort_by(|a, b| b.signal_strength.cmp(&a.signal_strength));
self.networks.lock().await.clone_from(visible_networks);
}
Err(err) => warn!("Scan failed: {:?}", err),
}
}
async fn select_network(&self) -> Option<WifiNetwork> {
fn select_visible_known_network<'a>(
known_networks: &'a [KnownNetwork],
visible_networks: &[AccessPointInfo],
preference: NetworkPreference,
) -> Option<&'a WifiNetwork> {
for network in visible_networks {
if let Some((known_network, _)) = known_networks
.iter()
.find(|(kn, pref)| kn.ssid == network.ssid && *pref == preference)
{
return Some(known_network);
}
}
None
}
let visible_networks = self.networks.lock().await;
let mut known_networks = self.known_networks.lock().await;
// Try to find a preferred network.
if let Some(connect_to) = select_visible_known_network(
&known_networks,
visible_networks.as_slice(),
NetworkPreference::Preferred,
) {
return Some(connect_to.clone());
}
// No preferred networks in range. Try the naughty list.
if let Some(connect_to) = select_visible_known_network(
&known_networks,
visible_networks.as_slice(),
NetworkPreference::Deprioritized,
) {
return Some(connect_to.clone());
}
// No visible known networks. Reset deprioritized networks.
for (_, preference) in known_networks.iter_mut() {
*preference = NetworkPreference::Preferred;
}
None
}
async fn configure_for_visible_network(
&mut self,
controller: &mut WifiController<'_>,
) -> Result<(), NetworkConfigureError> {
// Select known visible network
let Some(connect_to) = self.select_network().await else {
return Err(NetworkConfigureError);
};
// Set up configuration
info!("Connecting to {}...", connect_to.ssid);
self.state.update(InternalConnectionState::Connecting);
unwrap!(
controller.set_configuration(&Configuration::Client(ClientConfiguration {
ssid: connect_to.ssid.clone(),
password: connect_to.pass,
..Default::default()
}))
);
Ok(())
}
async fn do_connect(
&mut self,
controller: &mut WifiController<'_>,
) -> Result<(), ConnectError> {
self.state.update(InternalConnectionState::Connecting);
match with_timeout(Duration::from_secs(30), controller.connect()).await {
Ok(Ok(_)) => {
self.state.update(InternalConnectionState::WaitingForIp);
Ok(())
}
Ok(Err(e)) => {
warn!("Failed to connect to wifi: {:?}", e);
Err(ConnectError)
}
Err(_) => {
warn!("Connection timeout");
Err(ConnectError)
}
}
}
async fn deprioritize_current(&self, controller: &mut WifiController<'_>) {
match controller.get_configuration() {
Ok(config) => match &config {
Configuration::Client(config) | Configuration::Mixed(config, _) => {
let mut known_networks = self.known_networks.lock().await;
if let Some((_, preference)) =
known_networks.iter_mut().find(|(kn, preference)| {
kn.ssid == config.ssid && *preference == NetworkPreference::Preferred
})
{
*preference = NetworkPreference::Deprioritized;
}
}
Configuration::EapClient(_)
| Configuration::AccessPoint(_)
| Configuration::None => unreachable!(),
},
Err(_) => unreachable!(),
}
}
pub fn events(&self) -> EnumSet<WifiEvent> {
match self.controller_state {
StaControllerState::AutoConnecting | StaControllerState::AutoConnected => {
enumset::enum_set! { WifiEvent::StaStop | WifiEvent::StaDisconnected }
}
StaControllerState::Idle
| StaControllerState::ScanAndConnect
| StaControllerState::Connect(_) => {
enumset::enum_set! { WifiEvent::StaStop }
}
}
}
pub fn handle_events(&mut self, events: EnumSet<WifiEvent>) -> bool {
if events.contains(WifiEvent::StaStop) {
return false;
}
match self.controller_state {
StaControllerState::AutoConnecting | StaControllerState::AutoConnected => {
if events.contains(WifiEvent::StaDisconnected) {
self.state.update(InternalConnectionState::Disconnected);
self.controller_state = StaControllerState::ScanAndConnect;
}
}
StaControllerState::Idle
| StaControllerState::ScanAndConnect
| StaControllerState::Connect(_) => {}
}
true
}
pub async fn handle_command(&mut self, command: Command, controller: &mut WifiController<'_>) {
let (command, signal) = command;
match command {
StaCommand::ScanOnce => self.do_scan(controller).await,
}
signal.signal(());
}
pub async fn update(&mut self, controller: &mut WifiController<'_>) -> Duration {
match self.controller_state {
StaControllerState::Idle => NO_TIMEOUT,
StaControllerState::ScanAndConnect => {
self.do_scan(controller).await;
self.controller_state = StaControllerState::Connect(CONNECT_RETRY_COUNT);
CONTINUE
}
StaControllerState::Connect(retry) => {
if retry == CONNECT_RETRY_COUNT {
match self.configure_for_visible_network(controller).await {
Ok(()) => {}
Err(NetworkConfigureError) => {
self.controller_state = StaControllerState::ScanAndConnect;
self.state.update(InternalConnectionState::NotConnected);
return SCAN_PERIOD;
}
}
}
match self.do_connect(controller).await {
Ok(_) => {
info!("Waiting to get IP address...");
self.controller_state = StaControllerState::AutoConnecting;
CONTINUE
}
Err(ConnectError) => {
if retry != 0 {
info!("Retrying...");
self.controller_state = StaControllerState::Connect(retry - 1);
return CONNECT_RETRY_PERIOD;
}
self.controller_state = StaControllerState::ScanAndConnect;
self.deprioritize_current(controller).await;
SCAN_PERIOD
}
}
}
StaControllerState::AutoConnecting => {
let Some(config) = self.stack.config_v4() else {
return Duration::from_millis(500);
};
info!("Got IP: {}", config.address);
self.state.update(InternalConnectionState::Connected);
self.controller_state = StaControllerState::AutoConnected;
CONTINUE
}
StaControllerState::AutoConnected => NO_TIMEOUT,
}
}
pub(super) async fn wait_for_command(&self) -> Command {
self.command_queue.receive().await
}
}
#[cardio::task]
async fn sta_task(
mut sta_controller: StaController,
mut task_control: TaskControlToken<(), StaTaskResources>,
) {
task_control
.run_cancellable(|resources| async {
info!("Starting wifi");
unwrap!(resources.controller.start().await);
info!("Wifi started!");
loop {
let events = sta_controller.events();
let timeout = sta_controller.update(&mut resources.controller).await;
let event_or_command = select(
async {
if timeout == NO_TIMEOUT {
Some(resources.controller.wait_for_events(events, false).await)
} else {
with_timeout(
timeout,
resources.controller.wait_for_events(events, false),
)
.await
.ok()
}
},
sta_controller.wait_for_command(),
)
.await;
match event_or_command {
Either::First(Some(events)) => {
if !sta_controller.handle_events(events) {
return;
}
}
Either::Second(command) => {
sta_controller
.handle_command(command, &mut resources.controller)
.await;
}
_ => {}
}
}
})
.await;
}