Skip to content

fix(deploy): esptool v5 non-deprecated argv spellings #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zackees merged 1 commit into from
Apr 18, 2026
Merged

fix(deploy): esptool v5 non-deprecated argv spellings #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions crates/fbuild-build/src/esp32/configs/esp32.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@
"default_flash_freq": "80m",
"default_flash_size": "4MB",
"default_baud": 460800,
"before_reset": "default_reset",
"after_reset": "hard_reset"
"before_reset": "default-reset",
"after_reset": "hard-reset"
},

"defines": [
Expand Down
4 changes: 2 additions & 2 deletions crates/fbuild-build/src/esp32/configs/esp32c2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@
"default_flash_freq": "60m",
"default_flash_size": "4MB",
"default_baud": 460800,
"before_reset": "default_reset",
"after_reset": "hard_reset"
"before_reset": "default-reset",
"after_reset": "hard-reset"
},

"defines": [
Expand Down
4 changes: 2 additions & 2 deletions crates/fbuild-build/src/esp32/configs/esp32c3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@
"default_flash_freq": "80m",
"default_flash_size": "4MB",
"default_baud": 460800,
"before_reset": "default_reset",
"after_reset": "hard_reset"
"before_reset": "default-reset",
"after_reset": "hard-reset"
},

"defines": [
Expand Down
4 changes: 2 additions & 2 deletions crates/fbuild-build/src/esp32/configs/esp32c5.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,8 @@
"default_flash_freq": "80m",
"default_flash_size": "4MB",
"default_baud": 460800,
"before_reset": "default_reset",
"after_reset": "hard_reset"
"before_reset": "default-reset",
"after_reset": "hard-reset"
},

"defines": [
Expand Down
4 changes: 2 additions & 2 deletions crates/fbuild-build/src/esp32/configs/esp32c6.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,8 @@
"default_flash_freq": "80m",
"default_flash_size": "4MB",
"default_baud": 460800,
"before_reset": "default_reset",
"after_reset": "hard_reset"
"before_reset": "default-reset",
"after_reset": "hard-reset"
},

"defines": [
Expand Down
4 changes: 2 additions & 2 deletions crates/fbuild-build/src/esp32/configs/esp32h2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@
"default_flash_freq": "48m",
"default_flash_size": "4MB",
"default_baud": 460800,
"before_reset": "default_reset",
"after_reset": "hard_reset"
"before_reset": "default-reset",
"after_reset": "hard-reset"
},

"defines": [
Expand Down
4 changes: 2 additions & 2 deletions crates/fbuild-build/src/esp32/configs/esp32p4.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@
"default_flash_freq": "80m",
"default_flash_size": "4MB",
"default_baud": 460800,
"before_reset": "default_reset",
"after_reset": "hard_reset"
"before_reset": "default-reset",
"after_reset": "hard-reset"
},

"defines": [
Expand Down
4 changes: 2 additions & 2 deletions crates/fbuild-build/src/esp32/configs/esp32s2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,8 @@
"default_flash_freq": "80m",
"default_flash_size": "4MB",
"default_baud": 460800,
"before_reset": "default_reset",
"after_reset": "hard_reset"
"before_reset": "default-reset",
"after_reset": "hard-reset"
},

"defines": [
Expand Down
4 changes: 2 additions & 2 deletions crates/fbuild-build/src/esp32/configs/esp32s3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,8 @@
"default_flash_freq": "80m",
"default_flash_size": "4MB",
"default_baud": 921600,
"before_reset": "default_reset",
"after_reset": "hard_reset"
"before_reset": "default-reset",
"after_reset": "hard-reset"
},

"defines": [
Expand Down
8 changes: 4 additions & 4 deletions crates/fbuild-build/src/esp32/mcu_config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ pub struct EsptoolConfig {
pub default_flash_size: String,
/// Default baud rate for flashing.
pub default_baud: u32,
/// Reset mode before flashing (e.g. "default_reset").
/// Reset mode before flashing (e.g. "default-reset").
pub before_reset: String,
/// Reset mode after flashing (e.g. "hard_reset").
/// Reset mode after flashing (e.g. "hard-reset").
pub after_reset: String,
}

Expand Down Expand Up @@ -153,12 +153,12 @@ impl Esp32McuConfig {
self.esptool.default_baud
}

/// Reset mode before flashing (e.g. "default_reset").
/// Reset mode before flashing (e.g. "default-reset").
pub fn before_reset(&self) -> &str {
&self.esptool.before_reset
}

/// Reset mode after flashing (e.g. "hard_reset").
/// Reset mode after flashing (e.g. "hard-reset").
pub fn after_reset(&self) -> &str {
&self.esptool.after_reset
}
Expand Down
22 changes: 11 additions & 11 deletions crates/fbuild-deploy/src/esp32.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ impl Esp32Deployer {
/// only when esptool itself failed to run (port not found, stub
/// upload failed, etc.).
///
/// On success the chip is hard-reset by esptool's `--after hard_reset`,
/// On success the chip is hard-reset by esptool's `--after hard-reset`,
/// matching the post-flash behavior — so callers can treat a `true`
/// return as "device is now running the requested firmware" without
/// any extra reset.
Expand Down Expand Up @@ -255,7 +255,7 @@ pub struct RegionVerifyResult {
pub enum VerifyOutcome {
/// All flashed regions match the candidate image; flashing would be
/// a no-op. The device has been hard-reset by esptool's
/// `--after hard_reset` so it's already running the requested image.
/// `--after hard-reset` so it's already running the requested image.
Match { stdout: String, stderr: String },
/// At least one region differs from the local files. `regions` carries
/// the parsed per-region verdict when stdout was understood; empty
Expand Down Expand Up @@ -804,7 +804,7 @@ impl Esp32Deployer {
self.before_reset.clone(),
"--after".to_string(),
self.after_reset.clone(),
"write_flash".to_string(),
"write-flash".to_string(),
"-z".to_string(),
"--flash-mode".to_string(),
self.flash_mode.clone(),
Expand Down Expand Up @@ -983,8 +983,8 @@ mod tests {
flash_mode: "dio".to_string(),
flash_freq: "80m".to_string(),
default_baud: "460800".to_string(),
before_reset: "default_reset".to_string(),
after_reset: "hard_reset".to_string(),
before_reset: "default-reset".to_string(),
after_reset: "hard-reset".to_string(),
}
}

Expand All @@ -999,7 +999,7 @@ mod tests {
assert_eq!(deployer.bootloader_offset, "0x0");
assert_eq!(deployer.firmware_offset, "0x10000");
assert_eq!(deployer.flash_mode, "dio");
assert_eq!(deployer.before_reset, "default_reset");
assert_eq!(deployer.before_reset, "default-reset");
}

#[test]
Expand Down Expand Up @@ -1381,7 +1381,7 @@ Verification successful (digest matched).\n";
);
}

/// The selective write-flash argv must include the write_flash
/// The selective write-flash argv must include the write-flash
/// subcommand and only the requested region's offset/file pair.
/// Skipping bootloader + partitions is the ~1s save targeted by #67.
#[test]
Expand All @@ -1398,7 +1398,7 @@ Verification successful (digest matched).\n";

let args = deployer.build_write_flash_args(&fw, "COM13", Some(&[FlashRegion::Firmware]));

assert!(args.contains(&"write_flash".to_string()));
assert!(args.contains(&"write-flash".to_string()));
assert!(!args.iter().any(|a| a.ends_with("bootloader.bin")));
assert!(!args.iter().any(|a| a.ends_with("partitions.bin")));
assert!(args.contains(&"0x10000".to_string()));
Expand Down Expand Up @@ -1427,7 +1427,7 @@ Verification successful (digest matched).\n";
}

/// If a caller requests a region whose file is missing on disk, fail
/// with a clear error rather than silently emitting a write_flash
/// with a clear error rather than silently emitting a write-flash
/// call with no offset/file pair (which would produce an opaque
/// esptool usage error). Addresses CodeRabbit review on PR #71.
#[test]
Expand Down Expand Up @@ -1553,8 +1553,8 @@ Verification successful (digest matched).\n";
flash_mode: "dio".to_string(),
flash_freq: "80m".to_string(),
default_baud: "921600".to_string(),
before_reset: "default_reset".to_string(),
after_reset: "hard_reset".to_string(),
before_reset: "default-reset".to_string(),
after_reset: "hard-reset".to_string(),
};
let deployer = Esp32Deployer::new(
chip,
Expand Down
Loading