Add log-format argument (#493)

* feat: Add defmt flag

* feat: Add log-format argument

* feat: Update default value of log-format

* feat: Pin defmt deps

* Fix typo

Co-authored-by: Dániel Buga <[email protected]>

---------

Co-authored-by: Dániel Buga <[email protected]>

Author: SergioGasquez

Cargo.lock

@@ -41,6 +41,3 @@ cargo = { version = "0.73.1", features = ["vendored-openssl"] }
 
 [target.'cfg(windows)'.dependencies]
 cargo = "0.73.1"
-
-[features]
-defmt = ["espflash/defmt"]

cargo-espflash/Cargo.toml

@@ -6,13 +6,13 @@ use std::{
 
 use cargo_metadata::Message;
 use clap::{Args, CommandFactory, Parser, Subcommand};
-use espflash::cli::{erase_flash, erase_region, EraseFlashArgs, EraseRegionArgs};
 use espflash::{
     cli::{
-        self, board_info, completions, config::Config, connect, erase_partitions, flash_elf_image,
-        monitor::monitor, parse_partition_table, partition_table, print_board_info,
-        save_elf_as_image, serial_monitor, CompletionsArgs, ConnectArgs, EspflashProgress,
-        FlashConfigArgs, MonitorArgs, PartitionTableArgs,
+        self, board_info, completions, config::Config, connect, erase_flash, erase_partitions,
+        erase_region, flash_elf_image, monitor::monitor_with, parse_partition_table,
+        partition_table, print_board_info, save_elf_as_image, serial_monitor, CompletionsArgs,
+        ConnectArgs, EraseFlashArgs, EraseRegionArgs, EspflashProgress, FlashConfigArgs,
+        MonitorArgs, PartitionTableArgs,
     },
     error::Error as EspflashError,
     image_format::ImageFormatKind,
@@ -341,11 +341,12 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
                 115_200
             };
 
-        monitor(
+        monitor_with(
             flasher.into_interface(),
             Some(&elf_data),
             pid,
             args.flash_args.monitor_baud.unwrap_or(default_baud),
+            args.flash_args.log_format,
         )
         .into_diagnostic()?;
     }

cargo-espflash/src/main.rs

@@ -40,7 +40,8 @@ clap_complete = { version = "4.4.3", optional = true }
 comfy-table = { version = "7.0.1", optional = true }
 crossterm = { version = "0.25.0", optional = true } # 0.26.x causes issues on Windows
 ctrlc = { version = "3.4.0", optional = true }
-defmt-decoder = { version = "=0.3.8", features = ["unstable"], optional = true }
+# defmt dependencies are pinned since defmt does not guarantee MSRV even for patch releases
+defmt-decoder = { version = "=0.3.9", features = ["unstable"], optional = true }
 defmt-parser = { version = "=0.3.3", features = ["unstable"], optional = true }
 dialoguer = { version = "0.10.4", optional = true }
 directories = { version = "5.0.1", optional = true }
@@ -74,6 +75,8 @@ cli = [
     "dep:comfy-table",
     "dep:crossterm",
     "dep:ctrlc",
+    "dep:defmt-decoder",
+    "dep:defmt-parser",
     "dep:dialoguer",
     "dep:directories",
     "dep:env_logger",
@@ -84,8 +87,5 @@ cli = [
     "dep:regex",
     "dep:update-informer",
 ]
-defmt = [
-    "dep:defmt-decoder",
-    "dep:defmt-parser",
-]
+
 raspberry = ["dep:rppal"]

espflash/Cargo.toml

@@ -8,7 +8,7 @@ use clap::{Args, CommandFactory, Parser, Subcommand};
 use espflash::{
     cli::{
         self, board_info, completions, config::Config, connect, erase_flash, erase_partitions,
-        erase_region, flash_elf_image, monitor::monitor, parse_partition_table, parse_uint32,
+        erase_region, flash_elf_image, monitor::monitor_with, parse_partition_table, parse_uint32,
         partition_table, print_board_info, save_elf_as_image, serial_monitor, CompletionsArgs,
         ConnectArgs, EraseFlashArgs, EraseRegionArgs, EspflashProgress, FlashConfigArgs,
         MonitorArgs, PartitionTableArgs,
@@ -263,11 +263,12 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
                 115_200
             };
 
-        monitor(
+        monitor_with(
             flasher.into_interface(),
             Some(&elf_data),
             pid,
             args.flash_args.monitor_baud.unwrap_or(default_baud),
+            args.flash_args.log_format,
         )
         .into_diagnostic()?;
     }

espflash/src/bin/espflash.rs

@@ -24,7 +24,11 @@ use log::{debug, info};
 use miette::{IntoDiagnostic, Result, WrapErr};
 use serialport::{SerialPortType, UsbPortInfo};
 
-use self::{config::Config, monitor::monitor, serial::get_serial_port_info};
+use self::{
+    config::Config,
+    monitor::{monitor_with, LogFormat},
+    serial::get_serial_port_info,
+};
 use crate::{
     elf::ElfFirmwareImage,
     error::{Error, MissingPartition, MissingPartitionTable},
@@ -134,6 +138,9 @@ pub struct FlashArgs {
     /// Load the application to RAM instead of Flash
     #[arg(long)]
     pub ram: bool,
+    /// Logging format.
+    #[arg(long, short = 'f', default_value = "serial", requires = "monitor")]
+    pub log_format: LogFormat,
 }
 
 /// Operations for partitions tables
@@ -185,6 +192,9 @@ pub struct MonitorArgs {
     /// Connection configuration
     #[clap(flatten)]
     connect_args: ConnectArgs,
+    /// Logging format.
+    #[arg(long, short = 'f', default_value = "serial")]
+    pub log_format: LogFormat,
 }
 
 /// Select a serial port and establish a connection with a target device
@@ -291,11 +301,12 @@ pub fn serial_monitor(args: MonitorArgs, config: &Config) -> Result<()> {
         115_200
     };
 
-    monitor(
+    monitor_with(
         flasher.into_interface(),
         elf.as_deref(),
         pid,
         args.connect_args.baud.unwrap_or(default_baud),
+        args.log_format,
     )
     .into_diagnostic()?;
 

espflash/src/cli/mod.rs

@@ -21,6 +21,7 @@ use crossterm::{
 };
 use log::error;
 use miette::{IntoDiagnostic, Result};
+use strum::{Display, EnumIter, EnumString, EnumVariantNames};
 
 use crate::{
     cli::monitor::parser::{InputParser, ResolvingPrinter},
@@ -33,6 +34,17 @@ pub mod parser;
 mod line_endings;
 mod symbols;
 
+#[cfg_attr(feature = "cli", derive(clap::ValueEnum))]
+#[derive(Debug, Clone, Copy, PartialEq, Eq, Display, EnumIter, EnumString, EnumVariantNames)]
+#[non_exhaustive]
+#[strum(serialize_all = "lowercase")]
+pub enum LogFormat {
+    /// defmt
+    Defmt,
+    /// serial
+    Serial,
+}
+
 /// Type that ensures that raw mode is disabled when dropped.
 struct RawModeGuard;
 
@@ -58,22 +70,16 @@ pub fn monitor(
     pid: u16,
     baud: u32,
 ) -> serialport::Result<()> {
-    #[cfg(feature = "defmt")]
-    let parser = parser::esp_defmt::EspDefmt::new(elf);
-
-    #[cfg(not(feature = "defmt"))]
-    let parser = parser::serial::Serial;
-
-    monitor_with(serial, elf, pid, baud, parser)
+    monitor_with(serial, elf, pid, baud, LogFormat::Serial)
 }
 
 /// Open a serial monitor on the given interface, using the given input parser.
-pub fn monitor_with<L: InputParser>(
+pub fn monitor_with(
     mut serial: Interface,
     elf: Option<&[u8]>,
     pid: u16,
     baud: u32,
-    mut parser: L,
+    log_format: LogFormat,
 ) -> serialport::Result<()> {
     println!("Commands:");
     println!("    CTRL+R    Reset chip");
@@ -102,7 +108,16 @@ pub fn monitor_with<L: InputParser>(
             err => err,
         }?;
 
-        parser.feed(&buff[0..read_count], &mut stdout);
+        match log_format {
+            LogFormat::Defmt => {
+                let mut parser = parser::esp_defmt::EspDefmt::new(elf);
+                parser.feed(&buff[0..read_count], &mut stdout);
+            }
+            LogFormat::Serial => {
+                let mut parser = parser::serial::Serial;
+                parser.feed(&buff[0..read_count], &mut stdout);
+            }
+        }
 
         // Don't forget to flush the writer!
         stdout.flush().ok();

espflash/src/cli/monitor/mod.rs

@@ -1,4 +1,3 @@
-#[cfg(feature = "defmt")]
 pub mod esp_defmt;
 pub mod serial;