implement features-based board configuration

Author: br0kenpixel

Cargo.toml

@@ -39,4 +39,9 @@ heapless = "0.8.0"
 embuild = "0.33.0"
 
 [patch.crates-io]
-embedded-svc = { git = "ssh://git@github.com/PixelWeatherProject/embedded-svc.git", rev = "29afd95" }
+embedded-svc = { git = "ssh://git@github.com/PixelWeatherProject/embedded-svc.git", rev = "29afd95" }
+
+[features]
+lilygo-t7s3 = []
+xiao-s3 = []
+arduino-nano-esp32 = []

README.md

@@ -109,12 +109,12 @@ The default battery voltage measurement configuration has a measured inaccuracy
 
 If you just want to build the image, use the following command (for example):
 ```sh
-cargo espflash save-image -T partitions.csv --frozen --locked --release --chip esp32s3 --merge image.bin 
+cargo espflash save-image --features $BOARD -T partitions.csv --frozen --locked --release --chip esp32s3 --merge image.bin 
 ```
 
 To directly flash the firmware, use the command below. **Remember to change the serial port for your machine.**
 ```sh
-cargo espflash flash -T partitions.csv --frozen --locked --release -c esp32s3 --noverify --erase-data-parts otadata -B 921600 -p /dev/ttyXXXX
+cargo espflash flash --features $BOARD -T partitions.csv --frozen --locked --release -c esp32s3 --noverify --erase-data-parts otadata -B 921600 -p /dev/ttyXXXX
 ```
 
 If you notice weird/buggy bevaiour, you can erase the entire flash like so:
@@ -131,6 +131,7 @@ cargo espflash erase-flash -c esp32s3 -p /dev/ttyACM0 -B 921600
 Depending on which ESP32S3 development board you're using, you may need to add additional arguments to the two example commands above (especially `flash`).
 - `-c esp32s3`
 - `-s 16mb` / `-s 8mb` - For 16MB and 8MB of flash respectively.
+- `--features` - Check section below.
 
 To build a debug image (or flash it) remove the `--release` flag from the above commands.
 
@@ -146,7 +147,7 @@ To build a debug image (or flash it) remove the `--release` flag from the above
   No changes are needed.
 
   ### GPIO Pins
-  The default pin configuration of PWOS is designed for this board. No changes are needed.
+  The default pin configuration of PWOS is designed for this board. No changes are needed. You may also leave out the `--features` flag for `espflash`.
 
   - On-board LED: `GPIO_17`
   - I2C SDA: `GPIO_5`
@@ -155,9 +156,9 @@ To build a debug image (or flash it) remove the `--release` flag from the above
 
   ### `espflash` commands
   - For saving as image:
-    - `cargo espflash save-image --frozen --locked --release -T partitions.csv -s 16mb --chip esp32s3 image.bin`
+    - `cargo espflash save-image --features lilygo-t7s3 --frozen --locked --release -T partitions.csv -s 16mb --chip esp32s3 image.bin`
   - For flashing:
-    - `cargo espflash flash --frozen --locked --release -T partitions.csv -s 16mb -c esp32s3 -B 921600 -p /dev/ttyXXXX -M --no-verify --erase-data-parts ota`
+    - `cargo espflash flash --features lilygo-t7s3 --frozen --locked --release -T partitions.csv -s 16mb -c esp32s3 -B 921600 -p /dev/ttyXXXX -M --no-verify --erase-data-parts ota`
 </details>
 
 <details>
@@ -170,17 +171,17 @@ To build a debug image (or flash it) remove the `--release` flag from the above
   ```
 
   ### GPIO Pins
-  The on-board LED is on a different pin. You'll need to set `LED_BUILTIN` in your sysconfig ([src/config/sys.rs](src/config/sys.rs)).
+  The on-board LED is on a different pin.
   - On-board LED: `GPIO_48`
   - I2C SDA: `GPIO_5`
   - I2C SCL: `GPIO_8`
   - Battery measurement: `GPIO_2`
 
   ### `espflash` commands
   - For saving as image:
-    - `cargo espflash save-image --frozen --locked --release -T partitions.csv -s 16mb --chip esp32s3 image.bin`
+    - `cargo espflash save-image --features arduino-nano-esp32 --frozen --locked --release -T partitions.csv -s 16mb --chip esp32s3 image.bin`
   - For flashing:
-    - `cargo espflash flash --frozen --locked --release -T partitions.csv -s 16mb -c esp32s3 -B 921600 -p /dev/ttyXXXX -M --no-verify --erase-data-parts ota`
+    - `cargo espflash flash --features arduino-nano-esp32 --frozen --locked --release -T partitions.csv -s 16mb -c esp32s3 -B 921600 -p /dev/ttyXXXX -M --no-verify --erase-data-parts ota`
 </details>
 
 <details>
@@ -194,7 +195,7 @@ To build a debug image (or flash it) remove the `--release` flag from the above
   No changes are needed.
 
   ### GPIO Pins
-  The on-board LED is on a different pin. You'll need to set `LED_BUILTIN` in your sysconfig ([src/config/sys.rs](src/config/sys.rs)). Additionally, you'll also need to set `LED_BUILTIN_INVERT` to `true`, because the LED's negative terminal is connected to the GPIO pin.
+  The on-board LED is on a different pin, and its negative terminal is connected to the GPIO pin, meaning it works with inverted logic.
 
   - On-board LED: `GPIO_21`
   - I2C SDA: `GPIO_5`
@@ -203,9 +204,9 @@ To build a debug image (or flash it) remove the `--release` flag from the above
 
   ### `espflash` commands
   - For saving as image:
-    - `cargo espflash save-image --frozen --locked --release -T partitions.csv -s 8mb --chip esp32s3 image.bin`
+    - `cargo espflash save-image --features xiao-s3 --frozen --locked --release -T partitions.csv -s 8mb --chip esp32s3 image.bin`
   - For flashing:
-    - `cargo espflash flash --frozen --locked --release -T partitions.csv -s 8mb -c esp32s3 -B 921600 -p /dev/ttyXXXX -M --no-verify --erase-data-parts ota`
+    - `cargo espflash flash --features xiao-s3 --frozen --locked --release -T partitions.csv -s 8mb -c esp32s3 -B 921600 -p /dev/ttyXXXX -M --no-verify --erase-data-parts ota`
 </details>
 
 ## Build variants

src/config/sys.rs.example

@@ -26,8 +26,4 @@ pub const WIFI_TIMEOUT: Duration = Duration::from_secs(10);
 pub const WIFI_COUNTRY_CODE: &str = "SK";
 
 /// PWMP server configuration
-pub const PWMP_SERVER: &str = "123.456.789.000:55300";
-
-/// Built-in LED pin number
-pub const LED_BUILTIN: u8 = 17;
-pub const LED_BUILTIN_INVERT: bool = true;
+pub const PWMP_SERVER: &str = "123.456.789.000:55300";

src/main.rs

@@ -2,22 +2,18 @@
 #![feature(panic_payload_as_str)]
 
 use crate::config::AppConfig;
-use config::LED_BUILTIN;
-use esp_idf_svc::{
-    eventloop::EspSystemEventLoop,
-    hal::{
-        i2c::{config::Config, I2cDriver},
-        peripherals::Peripherals,
-        units::FromValueType,
-    },
+use esp_idf_svc::hal::{
+    gpio::IOPin,
+    i2c::{config::Config, I2cDriver},
+    units::FromValueType,
 };
 use std::{panic::PanicHookInfo, time::Instant};
 use sysc::{
     battery::Battery,
-    gpio,
     ledctl::BoardLed,
     logging::OsLogger,
     ota::Ota,
+    periph::SystemPeripherals,
     power::{deep_sleep, fake_sleep},
     usbctl, OsError,
 };
@@ -65,15 +61,13 @@ fn main() {
         sysc::brownout::disable_brownout_detector();
     }
 
-    os_debug!("Initializing peripherals");
-    let mut peripherals = Peripherals::take().expect("Failed to initialize peripherals");
-
-    os_debug!("Initializing System Event Loop");
-    let sys_loop = EspSystemEventLoop::take().expect("SEL init error");
+    os_debug!("Initializing system peripherals");
+    let peripherals = SystemPeripherals::take();
 
     os_debug!("Initializing system LED");
     let led = BoardLed::new(
-        gpio::number_to_io_pin(LED_BUILTIN, &mut peripherals).expect("Invalid LED pin"),
+        peripherals.onboard_led.pin.downgrade(),
+        peripherals.onboard_led.invert,
     )
     .expect("Failed to set up onboard LED");
 
@@ -102,14 +96,14 @@ fn main() {
     );
 
     os_debug!("Initializing system Battery");
-    let battery = Battery::new(peripherals.adc1, peripherals.pins.gpio2)
+    let battery = Battery::new(peripherals.battery.adc, peripherals.battery.pin)
         .expect("Failed to initialize battery ADC");
 
     os_debug!("Initializing I2C bus");
     let i2c = I2cDriver::new(
-        peripherals.i2c1,
-        peripherals.pins.gpio5,
-        peripherals.pins.gpio8,
+        peripherals.i2c.i2c,
+        peripherals.i2c.sda,
+        peripherals.i2c.scl,
         &Config::default().baudrate(400u32.kHz().into()),
     )
     .expect("Failed to initialize I2C");
@@ -123,8 +117,8 @@ fn main() {
     let fw_exit = firmware::fw_main(
         battery,
         i2c,
-        peripherals.modem,
-        sys_loop,
+        peripherals.wifi.modem,
+        peripherals.wifi.sys_loop,
         led,
         &mut ota,
         &mut appcfg,

src/sysc/gpio.rs

@@ -1,14 +1,13 @@
 use super::OsResult;
-use crate::config::LED_BUILTIN_INVERT;
 use esp_idf_svc::hal::gpio::{AnyIOPin, Output, PinDriver};
 
 type LedDriver = PinDriver<'static, AnyIOPin, Output>;
 
-pub struct BoardLed(LedDriver);
+pub struct BoardLed(LedDriver, bool);
 
 impl BoardLed {
-    pub fn new(pin: AnyIOPin) -> OsResult<Self> {
-        let mut i = Self(PinDriver::output(pin)?);
+    pub fn new(pin: AnyIOPin, invert: bool) -> OsResult<Self> {
+        let mut i = Self(PinDriver::output(pin)?, invert);
         i.on();
 
         Ok(i)
@@ -18,10 +17,10 @@ impl BoardLed {
     // They can be safely ignored. This also reduces the size of the firmware.
 
     pub fn on(&mut self) {
-        let _ = self.0.set_level((!LED_BUILTIN_INVERT).into());
+        let _ = self.0.set_level((!self.1).into());
     }
 
     pub fn off(&mut self) {
-        let _ = self.0.set_level(LED_BUILTIN_INVERT.into());
+        let _ = self.0.set_level(self.1.into());
     }
 }

src/sysc/ledctl.rs

@@ -3,22 +3,23 @@ pub mod battery;
 pub mod brownout;
 mod error;
 pub mod ext_drivers;
-pub mod gpio;
 pub mod ledctl;
 pub mod logging;
 mod macros;
 pub mod net;
 pub mod ota;
+pub mod periph;
 pub mod power;
 pub mod usbctl;
 
-use std::{borrow::Cow, ffi::CStr, ptr::NonNull};
-
 pub use error::{OsError, ReportableError};
 pub type OsResult<T> = ::std::result::Result<T, OsError>;
 
+#[cfg(debug_assertions)]
 /// Try and get the ESP-IDF version.
-pub fn get_idf_version() -> Option<Cow<'static, str>> {
+pub fn get_idf_version() -> Option<std::borrow::Cow<'static, str>> {
+    use std::{ffi::CStr, ptr::NonNull};
+
     let version_str_ptr =
         NonNull::new(unsafe { esp_idf_svc::sys::esp_get_idf_version().cast_mut() })?;
     let version_str = unsafe { CStr::from_ptr(version_str_ptr.as_ptr().cast_const()) };