m5unified 0.3.0

Safe Rust wrapper for M5Unified.
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

use core::ffi::c_int;

/// FAT VFS mount path used by the native SD SPI helper.
pub const SD_MOUNT_PATH: &str = "/sdcard";

/// Mount an SD card using the board SD SPI pins reported by M5Unified.
pub fn sd_begin() -> bool {
    unsafe { m5unified_sys::m5u_sd_begin() }
}

/// Mount an SD card using explicit SPI pins and mount options.
pub fn sd_begin_with_config(config: &SdSpiConfig) -> bool {
    let raw = config.to_raw();
    unsafe { m5unified_sys::m5u_sd_begin_spi(&raw) }
}

/// Return whether this shim has an SD card mounted at [`SD_MOUNT_PATH`].
pub fn sd_is_mounted() -> bool {
    unsafe { m5unified_sys::m5u_sd_is_mounted() }
}

/// Unmount the SD card mounted by [`sd_begin`] or [`sd_begin_with_config`].
pub fn sd_end() {
    unsafe { m5unified_sys::m5u_sd_end() }
}

/// SPI configuration for mounting an SD card through ESP-IDF's SDSPI driver.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct SdSpiConfig {
    /// SPI clock pin.
    pub pin_sclk: i32,
    /// SPI MOSI/COPI pin.
    pub pin_mosi: i32,
    /// SPI MISO/CIPO pin.
    pub pin_miso: i32,
    /// SD card chip-select pin.
    pub pin_cs: i32,
    /// ESP-IDF SPI host id. Use `-1` for `SDSPI_HOST_DEFAULT`.
    pub host_id: i32,
    /// SD SPI frequency in kHz. Use `0` for ESP-IDF's default.
    pub frequency_khz: u32,
    /// Maximum concurrently open files.
    pub max_files: i32,
    /// Format the FAT filesystem if mounting fails.
    pub format_if_mount_failed: bool,
}

impl SdSpiConfig {
    fn to_raw(self) -> m5unified_sys::m5u_sd_spi_config_t {
        m5unified_sys::m5u_sd_spi_config_t {
            pin_sclk: self.pin_sclk as c_int,
            pin_mosi: self.pin_mosi as c_int,
            pin_miso: self.pin_miso as c_int,
            pin_cs: self.pin_cs as c_int,
            host_id: self.host_id as c_int,
            frequency_khz: self.frequency_khz,
            max_files: self.max_files as c_int,
            format_if_mount_failed: u8::from(self.format_if_mount_failed),
        }
    }
}

impl Default for SdSpiConfig {
    fn default() -> Self {
        let raw = m5unified_sys::m5u_sd_spi_config_t::default();
        Self {
            pin_sclk: raw.pin_sclk,
            pin_mosi: raw.pin_mosi,
            pin_miso: raw.pin_miso,
            pin_cs: raw.pin_cs,
            host_id: raw.host_id,
            frequency_khz: raw.frequency_khz,
            max_files: raw.max_files,
            format_if_mount_failed: raw.format_if_mount_failed != 0,
        }
    }
}