Skip to content

Commit

Permalink
Update probe-rs content (#144)
Browse files Browse the repository at this point in the history
* docs: Remove rtt

* docs: Remove esp-hal bootloader section
  • Loading branch information
SergioGasquez authored Mar 8, 2024
1 parent fa06b86 commit 562ba85
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 35 deletions.
25 changes: 0 additions & 25 deletions src/tooling/debugging/probe-rs.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,6 @@ There is a `probe-rs` extension in VS Code, see `probe-rs` [VS Code documentatio
{
"coreIndex": 0,
"programBinary": "target/riscv32imc-unknown-none-elf/debug/${workspaceFolderBasename}", //!MODIFY
"rttEnabled": true,
"rttChannelFormats": [
{
"channelNumber": 0,
"dataFormat": "String",
"showTimestamp": true,
}
]
}
]
},
Expand All @@ -89,34 +81,17 @@ There is a `probe-rs` extension in VS Code, see `probe-rs` [VS Code documentatio
{
"coreIndex": 0,
"programBinary": "target/riscv32imc-unknown-none-elf/debug/${workspaceFolderBasename}", //!MODIFY
"rttEnabled": true,
"rttChannelFormats": [
{
"channelNumber": 0,
"dataFormat": "String",
"showTimestamp": true,
}
]
}
]
}
]
}
```

> ⚠️ **Note**: The example `launch.json` uses `rtt`, which may require enabling such feature in some crates, like [`esp-println`][esp-println] and [`esp-backtrace`][esp-backtrace]
> Eg: ESP32-C3 `no_std` project that uses `esp-println` and `esp-backtrace`:
> ```toml
> esp-backtrace = { version = "0.9.0", features = ["esp32c3", "panic-handler", "exception-handler", "print-rtt"] }
> esp-println = { version = "0.7.0", features = ["esp32c3", "rtt"], default-features = flase }
> ```
The `Launch` configuration will flash the device and start debugging process while `Attach` will start the debugging in the already running application of the device. See VS Code documentation on [differences between launch and attach][vscode-configs] for more details.


[probe-rs-vscode]: https://probe.rs/docs/tools/debugger/
[esp-println]: https://github.com/esp-rs/esp-println
[esp-backtrace]: https://github.com/esp-rs/esp-backtrace?tab=readme-ov-file#features
[vscode-configs]: https://code.visualstudio.com/docs/editor/debugging#_launch-versus-attach-configurations

## `cargo-flash` and `cargo-embed`
Expand Down
10 changes: 0 additions & 10 deletions src/troubleshooting/espflash.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,3 @@ one.

If you want to use `espflash`, you need to specify an appropriate bootloader image using
`--bootloader`. You can find the bootloader in `target/<your MCU's target folder>/<debug or release depending on your build>/build/esp-idf-sys-*/build/bootloader/bootloader.bin`

### If you are building an `esp-hal` based project

Make sure your HAL ([ESP32](https://docs.rs/esp32-hal/latest/esp32_hal/), [ESP32-C2](https://docs.rs/esp32c2-hal/latest/esp32c2_hal/))
is configured to the correct crystal frequency. To do this, you must disable the default features
and enable `xtal-26mhz` (besides the other default features).

When flashing, you need to specify an appropriate bootloader image using `--bootloader`. Currently,
you will need to build this bootloader using an `esp-idf` based project (Rust or C based should work
equally, we recommend a project set up with [esp-idf-template](https://github.com/esp-rs/esp-idf-template)).

0 comments on commit 562ba85

Please sign in to comment.