Skip to content

Commit 4d56a44

Browse files
Be-ingjessebraham
andauthored
Flasher: document baud rate requirement (#845)
* Flasher: document baud rate requirement * Fix formatting --------- Co-authored-by: Jesse Braham <jesse@beta7.io>
1 parent eaef938 commit 4d56a44

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

espflash/src/flasher/mod.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -659,6 +659,9 @@ pub struct Flasher {
659659

660660
#[cfg(feature = "serialport")]
661661
impl Flasher {
662+
/// The serial port's baud rate should be 115_200 to connect. After
663+
/// connecting, Flasher will change the baud rate to the `speed`
664+
/// parameter.
662665
#[allow(clippy::too_many_arguments)]
663666
pub fn connect(
664667
serial: Port,

0 commit comments

Comments
 (0)