add --monitor option to write-bin (#783)

* changelog entry

* rebase

* fix

* update hil test

* increase timeout

increase timeout even more

* Fix CHANGELOG.md

Co-authored-by: Sergio Gasquez Arcos <[email protected]>

* play around timer....

increase timer

---------

Co-authored-by: Sergio Gasquez Arcos <[email protected]>

Author: playfulFence

.github/workflows/hil.yml

@@ -113,8 +113,7 @@ jobs:
 
       - name: save-image/write-bin test
         run: |
-          timeout 60 bash espflash/tests/scripts/save-image_write-bin.sh ${{ matrix.board.mcu }}
-          timeout 10 bash espflash/tests/scripts/monitor.sh
+          timeout 90 bash espflash/tests/scripts/save-image_write-bin.sh ${{ matrix.board.mcu }}
 
       - name: erase-region test
         run: timeout 10 bash espflash/tests/scripts/erase-region.sh

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add an environment variable to set monitoring baudrate (`MONITOR_BAUD`) (#737)
 - Add list-ports command to list available serial ports. (#761)
 - [cargo-espflash]: Add `write-bin` subcommand (#789)
+- Add `--monitor` option to `write-bin`. (#783)
 
 ### Changed
 

espflash/src/cli/mod.rs

@@ -326,6 +326,12 @@ pub struct WriteBinArgs {
     /// Connection configuration
     #[clap(flatten)]
     connect_args: ConnectArgs,
+    /// Open a serial monitor after writing
+    #[arg(short = 'M', long)]
+    pub monitor: bool,
+    /// Serial monitor configuration
+    #[clap(flatten)]
+    pub monitor_args: MonitorConfigArgs,
 }
 
 /// Parses an integer, in base-10 or hexadecimal format, into a [u32]
@@ -996,6 +1002,10 @@ pub fn write_bin(args: WriteBinArgs, config: &Config) -> Result<()> {
     let mut flasher = connect(&args.connect_args, config, false, false)?;
     print_board_info(&mut flasher)?;
 
+    let chip = flasher.chip();
+    let target = chip.into_target();
+    let target_xtal_freq = target.crystal_freq(flasher.connection())?;
+
     let mut f = File::open(&args.file).into_diagnostic()?;
 
     // If the file size is not divisible by 4, we need to pad `FF` bytes to the end
@@ -1014,6 +1024,21 @@ pub fn write_bin(args: WriteBinArgs, config: &Config) -> Result<()> {
         Some(&mut EspflashProgress::default()),
     )?;
 
+    if args.monitor {
+        let pid = flasher.usb_pid();
+        let mut monitor_args = args.monitor_args;
+
+        if chip == Chip::Esp32c2
+            && target_xtal_freq == XtalFrequency::_26Mhz
+            && monitor_args.monitor_baud == 115_200
+        {
+            // 115_200 * 26 MHz / 40 MHz = 74_880
+            monitor_args.monitor_baud = 74_880;
+        }
+
+        monitor(flasher.into_serial(), None, pid, monitor_args)?;
+    }
+
     Ok(())
 }
 

espflash/tests/scripts/save-image_write-bin.sh

@@ -12,8 +12,12 @@ if [[ ! $result =~ "Image successfully saved!" ]]; then
     exit 1
 fi
 echo "Writing binary"
-result=$(espflash write-bin 0x0 app.bin 2>&1)
+result=$(timeout 45 espflash write-bin --monitor 0x0 app.bin --non-interactive 2>&1)
 echo "$result"
 if [[ ! $result =~ "Binary successfully written to flash!" ]]; then
     exit 1
 fi
+
+if ! echo "$result" | grep -q "Hello world!"; then
+    exit 1
+fi