allow specifying image format in the projects Cargo.toml

Author: icewind1991

cargo-espflash/src/main.rs

@@ -237,8 +237,8 @@ fn flash(
     let image_format = matches
         .value_of("format")
         .map(ImageFormatId::from_str)
-        .transpose()
-        .into_diagnostic()?;
+        .transpose()?
+        .or(metadata.format);
 
     // Read the ELF data from the build path and load it to the target.
     let elf_data = fs::read(path).into_diagnostic()?;
@@ -368,7 +368,7 @@ fn build(
 fn save_image(
     matches: &ArgMatches,
     _config: Config,
-    _metadata: CargoEspFlashMeta,
+    metadata: CargoEspFlashMeta,
     cargo_config: CargoConfig,
 ) -> Result<()> {
     let target = cargo_config
@@ -385,8 +385,8 @@ fn save_image(
     let image_format = matches
         .value_of("format")
         .map(ImageFormatId::from_str)
-        .transpose()
-        .into_diagnostic()?;
+        .transpose()?
+        .or(metadata.format);
 
     let flash_image = chip.get_flash_image(&image, None, None, image_format)?;
     let parts: Vec<_> = flash_image.ota_segments().collect();

cargo-espflash/src/package_metadata.rs

@@ -1,5 +1,6 @@
 use crate::error::{Error, TomlError};
 use cargo_toml::Manifest;
+use espflash::ImageFormatId;
 use miette::{IntoDiagnostic, Result, WrapErr};
 use serde::Deserialize;
 use std::fs::read_to_string;
@@ -9,6 +10,7 @@ use std::path::Path;
 pub struct CargoEspFlashMeta {
     pub partition_table: Option<String>,
     pub bootloader: Option<String>,
+    pub format: Option<ImageFormatId>,
 }
 
 #[derive(Clone, Debug, Default, Deserialize)]

espflash/src/image_format/mod.rs

@@ -9,6 +9,7 @@ pub use esp32directboot::*;
 pub use esp8266::*;
 
 use crate::error::Error;
+use serde::Deserialize;
 use std::str::FromStr;
 use strum_macros::{AsStaticStr, Display, EnumVariantNames};
 
@@ -46,8 +47,11 @@ pub trait ImageFormat<'a> {
         'a: 'b;
 }
 
-#[derive(Debug, Copy, Clone, Eq, PartialEq, Display, AsStaticStr, EnumVariantNames)]
+#[derive(
+    Debug, Copy, Clone, Eq, PartialEq, Display, AsStaticStr, EnumVariantNames, Deserialize,
+)]
 #[strum(serialize_all = "kebab-case")]
+#[serde(rename_all = "kebab-case")]
 pub enum ImageFormatId {
     Bootloader,
     DirectBoot,