wifi-caddy 0.1.0

Platform-agnostic config storage traits, HTTP config portal, and form generation for WiFi configuration managers
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

#![doc = include_str!("../README.md")]
#![no_std]
#![warn(missing_docs)]
#![allow(async_fn_in_trait)]
#![cfg_attr(feature = "nightly", feature(impl_trait_in_assoc_type))]

extern crate alloc;

mod fmt;

pub mod config_storage;

#[cfg(feature = "portal")]
pub mod portal;
#[cfg(feature = "portal")]
mod run_http;

#[cfg(all(feature = "portal", feature = "debug-server"))]
pub use run_http::run_http_debug_loop;
#[cfg(feature = "portal")]
pub use run_http::{ConfigUiOptions, run_http_config_loop};

/// Parameters for config storage mount/format. Only the values are configurable;
/// key IDs are fixed to match wifi-caddy-proc.
#[doc(hidden)]
#[derive(Clone, Copy, Debug)]
pub struct ConfigStorageParams {
    /// Magic value stored at the magic key (format identifier).
    pub magic: u32,
    /// Format version stored at the format version key.
    pub format_version: u32,
}

/// Handle returned by the platform-specific init macro (e.g. `esp_wifi_caddy::wifi_init!`).
/// Use [`.config()`](ConfigHandle::config) to get the shared config mutex to pass into
/// application tasks.
pub struct ConfigHandle<C: 'static> {
    config: &'static embassy_sync::mutex::Mutex<
        embassy_sync::blocking_mutex::raw::CriticalSectionRawMutex,
        C,
    >,
}

impl<C: 'static> ConfigHandle<C> {
    /// Create a new `ConfigHandle` wrapping the given config mutex.
    pub fn new(
        config: &'static embassy_sync::mutex::Mutex<
            embassy_sync::blocking_mutex::raw::CriticalSectionRawMutex,
            C,
        >,
    ) -> Self {
        Self { config }
    }

    /// Returns the shared config mutex (`'static`), for use in tasks or elsewhere.
    pub fn config(
        &self,
    ) -> &'static embassy_sync::mutex::Mutex<
        embassy_sync::blocking_mutex::raw::CriticalSectionRawMutex,
        C,
    > {
        self.config
    }
}