Skip to content

Commit f5e7dbc

Browse files
committedMar 21, 2024·
docs: Update 26mhz troubleshoot section
1 parent 562ba85 commit f5e7dbc

File tree

3 files changed

+20
-23
lines changed

3 files changed

+20
-23
lines changed
 

‎book.toml

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ additional-js = ["assets/mermaid.min.js", "assets/mermaid-init.js"]
1717
"/debugging/vscode-debugging.html" = "https://esp-rs.github.io/book/debugging/vscode.html"
1818
"/writing-your-own-application/no-std-applications/understanding-esp-template.html" = "https://esp-rs.github.io/book/writing-your-own-application/generate-project/esp-template.html"
1919
"installation/installation.html" = "https://esp-rs.github.io/book/installation/index.html"
20+
"troubleshooting/espflash.html" = "https://esp-rs.github.io/book/troubleshooting/index.html"
2021

2122
[preprocessor.mermaid]
2223
command = "mdbook-mermaid"

‎src/troubleshooting/espflash.md

-22
This file was deleted.

‎src/troubleshooting/std.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,22 @@
1-
# `esp-idf-hal` based projects
1+
# `esp-idf-sys` based projects
2+
3+
## Wrong Xtal Frequency
4+
5+
Using a 26 Mhz crystal instead of a 40 MHz requires modifying the [`sdkconfig`][sdkconfig]. Add the following configuration option to your `sdkconfig` file:
6+
7+
```
8+
CONFIG_XTAL_FREQ_26=y
9+
```
10+
11+
After making this adjustment, execute `cargo clean` to ensure that the changes are properly incorporated into your project. See [`sdkconfig` section](#sdkconfigdefaults-file-is-updated-but-it-doesnt-appear-to-have-had-any-effect).
12+
13+
When using an `esp-idf-sys` based project, you should also prefer using `cargo-espflash` instead of `espflash`. `cargo-espflash` integrates with your
14+
project and it will flash the bootloader and partition table that is built for your project instead of the default one, see the corresponding [`cargo-espflash` readme section][cargo-espflash-bootloader].
15+
16+
If you want to use `espflash`, you can specify an appropriate bootloader and partition table using `--bootloader` and `--partition-table`. You can find the bootloader in `target/<your MCU's target folder>/<debug or release depending on your build>/bootloader.bin` and partition table in `target/<your MCU's target folder>/<debug or release depending on your build>/partition-table.bin`
17+
18+
[sdkconfig]: ttps://github.com/esp-rs/esp-idf-sys/blob/master/BUILD-OPTIONS.md#sdkconfig
19+
[cargo-espflash-bootloader]: https://github.com/esp-rs/espflash/tree/main/cargo-espflash#bootloader-and-partition-table
220

321
## Environment Variable `LIBCLANG_PATH` Not Set
422

0 commit comments

Comments
 (0)
Please sign in to comment.