esp-generate 1.3.0

Template generation tool to create no_std applications targeting Espressif's chips
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

use esp_metadata_generated::{MemoryRegion, PinInfo};
use serde::{Deserialize, Serialize};

use crate::modules::Module;

pub mod cargo;
pub mod config;
pub mod modules;
pub mod template;

#[derive(
    Debug,
    Clone,
    Copy,
    PartialEq,
    Eq,
    Serialize,
    Deserialize,
    clap::ValueEnum,
    strum::EnumIter,
    strum::Display,
)]
#[serde(rename_all = "kebab-case")]
#[strum(serialize_all = "kebab-case")]
pub enum Chip {
    Esp32,
    Esp32c2,
    Esp32c3,
    Esp32c5,
    Esp32c6,
    Esp32c61,
    Esp32h2,
    Esp32s2,
    Esp32s3,
}
impl Chip {
    pub fn metadata(self) -> esp_metadata_generated::Chip {
        match self {
            Chip::Esp32 => esp_metadata_generated::Chip::Esp32,
            Chip::Esp32c2 => esp_metadata_generated::Chip::Esp32c2,
            Chip::Esp32c3 => esp_metadata_generated::Chip::Esp32c3,
            Chip::Esp32c5 => esp_metadata_generated::Chip::Esp32c5,
            Chip::Esp32c6 => esp_metadata_generated::Chip::Esp32c6,
            Chip::Esp32c61 => esp_metadata_generated::Chip::Esp32c61,
            Chip::Esp32h2 => esp_metadata_generated::Chip::Esp32h2,
            Chip::Esp32s2 => esp_metadata_generated::Chip::Esp32s2,
            Chip::Esp32s3 => esp_metadata_generated::Chip::Esp32s3,
        }
    }

    pub fn wokwi(self) -> &'static str {
        match self {
            Chip::Esp32 => "board-esp32-devkit-c-v4",
            Chip::Esp32c2 => "",
            Chip::Esp32c3 => "board-esp32-c3-devkitm-1",
            Chip::Esp32c5 => "",
            Chip::Esp32c6 => "board-esp32-c6-devkitc-1",
            Chip::Esp32c61 => "",
            Chip::Esp32h2 => "board-esp32-h2-devkitm-1",
            Chip::Esp32s2 => "board-esp32-s2-devkitm-1",
            Chip::Esp32s3 => "board-esp32-s3-devkitc-1",
        }
    }

    pub fn dram2_region(self) -> &'static MemoryRegion {
        self.metadata()
            .memory_layout()
            .region("dram2_uninit")
            .expect("All chips should have a dram2_uninit region")
    }

    pub fn pins(self) -> &'static [PinInfo] {
        self.metadata().pins()
    }

    pub fn modules(self) -> &'static [Module] {
        match self {
            Chip::Esp32 => crate::modules::ESP32_MODULES,
            Chip::Esp32c2 => crate::modules::ESP32C2_MODULES,
            Chip::Esp32c3 => crate::modules::ESP32C3_MODULES,
            Chip::Esp32c5 => crate::modules::ESP32C5_MODULES,
            Chip::Esp32c6 => crate::modules::ESP32C6_MODULES,
            Chip::Esp32c61 => crate::modules::ESP32C61_MODULES,
            Chip::Esp32h2 => crate::modules::ESP32H2_MODULES,
            Chip::Esp32s2 => crate::modules::ESP32S2_MODULES,
            Chip::Esp32s3 => crate::modules::ESP32S3_MODULES,
        }
    }

    pub fn module_by_name(&self, module_name: &str) -> Option<&'static Module> {
        self.modules()
            .iter()
            .find(|module| module.name == module_name)
    }
}

/// This turns a list of strings into a sentence, and appends it to the base string.
///
/// # Example
///
/// ```rust
/// # use esp_generate::append_list_as_sentence;
/// let list = &["foo", "bar", "baz"];
/// let sentence = append_list_as_sentence("Here is a sentence.", "My elements are", list);
/// assert_eq!(sentence, "Here is a sentence. My elements are `foo`, `bar` and `baz`.");
///
/// let list = &["foo", "bar", "baz"];
/// let sentence = append_list_as_sentence("The following list is problematic:", "", list);
/// assert_eq!(sentence, "The following list is problematic: `foo`, `bar` and `baz`.");
/// ```
pub fn append_list_as_sentence<S: AsRef<str>>(base: &str, word: &str, els: &[S]) -> String {
    if !els.is_empty() {
        let mut requires = String::new();

        if !base.is_empty() {
            requires.push_str(base);
            requires.push(' ');
        }

        for (i, r) in els.iter().enumerate() {
            if i == 0 {
                if !word.is_empty() {
                    requires.push_str(word);
                    requires.push(' ');
                }
            } else if i == els.len() - 1 {
                requires.push_str(" and ");
            } else {
                requires.push_str(", ");
            };

            requires.push('`');
            requires.push_str(r.as_ref());
            requires.push('`');
        }
        requires.push('.');

        requires
    } else {
        base.to_string()
    }
}