diff options
| author | Barnaby Walters <[email protected]> | 2024-02-28 15:11:30 +0100 |
|---|---|---|
| committer | Barnaby Walters <[email protected]> | 2024-02-28 15:11:30 +0100 |
| commit | 990b44566ce1393a4a553a65d5a6c412cb656805 (patch) | |
| tree | d18ffdf50e5046d81830e1cfa2f182d1afc2d7b5 /docs/modules/ROOT | |
| parent | 5ced938184e141471e921d235975e95725d6be53 (diff) | |
[docs] Added some failure modes to watch out for
* Linked to probe.rs website rather than the crates.io page
* Fixed some formatting errors (>:( grrr asciidoc)
* Added cargo add probe-rs failure mode
* Added pico-w vs pico blinky failure mode
Diffstat (limited to 'docs/modules/ROOT')
| -rw-r--r-- | docs/modules/ROOT/pages/getting_started.adoc | 28 |
1 files changed, 21 insertions, 7 deletions
diff --git a/docs/modules/ROOT/pages/getting_started.adoc b/docs/modules/ROOT/pages/getting_started.adoc index 24bde1c1f..be2b868eb 100644 --- a/docs/modules/ROOT/pages/getting_started.adoc +++ b/docs/modules/ROOT/pages/getting_started.adoc | |||
| @@ -3,7 +3,7 @@ | |||
| 3 | So you want to try Embassy, great! To get started, there are a few tools you need to install: | 3 | So you want to try Embassy, great! To get started, there are a few tools you need to install: |
| 4 | 4 | ||
| 5 | * link:https://rustup.rs/[rustup] - the Rust toolchain is needed to compile Rust code. | 5 | * link:https://rustup.rs/[rustup] - the Rust toolchain is needed to compile Rust code. |
| 6 | * link:https://crates.io/crates/probe-rs[probe-rs] - to flash the firmware on your device. If you already have other tools like `OpenOCD` setup, you can use that as well. | 6 | * link:https://probe.rs/[probe-rs] - to flash the firmware on your device. If you already have other tools like `OpenOCD` setup, you can use that as well. |
| 7 | 7 | ||
| 8 | If you don't have any supported board, don't worry: you can also run embassy on your PC using the `std` examples. | 8 | If you don't have any supported board, don't worry: you can also run embassy on your PC using the `std` examples. |
| 9 | 9 | ||
| @@ -82,19 +82,19 @@ If everything worked correctly, you should see a blinking LED on your board, and | |||
| 82 | └─ blinky::__embassy_main::task::{generator#0} @ src/bin/blinky.rs:27 | 82 | └─ blinky::__embassy_main::task::{generator#0} @ src/bin/blinky.rs:27 |
| 83 | ---- | 83 | ---- |
| 84 | 84 | ||
| 85 | NOTE: How does the `cargo run` command know how to connect to our board and program it? In each `examples` folder, there’s a `.cargo/config.toml` file which tells cargo to use link:https://probe.rs/[probe-rs] as the runner for ARM binaries in that folder. probe-rs handles communication with the debug probe and MCU. In order for this to work, probe-rs needs to know which chip it’s programming, so you’ll have to edit this file if you want to run examples on other chips. | 85 | NOTE: How does the `+cargo run+` command know how to connect to our board and program it? In each `examples` folder, there’s a `.cargo/config.toml` file which tells cargo to use link:https://probe.rs/[probe-rs] as the runner for ARM binaries in that folder. probe-rs handles communication with the debug probe and MCU. In order for this to work, probe-rs needs to know which chip it’s programming, so you’ll have to edit this file if you want to run examples on other chips. |
| 86 | 86 | ||
| 87 | === It didn’t work! | 87 | === It didn’t work! |
| 88 | 88 | ||
| 89 | If you hare having issues when running `cargo run --release`, please check the following: | 89 | If you hare having issues when running `+cargo run --release+`, please check the following: |
| 90 | 90 | ||
| 91 | * You are specifying the correct `--chip` on the command line, OR | 91 | * You are specifying the correct `+--chip+` on the command line, OR |
| 92 | * You have set `.cargo/config.toml`'s run line to the correct chip, AND | 92 | * You have set `+.cargo/config.toml+`’s run line to the correct chip, AND |
| 93 | * You have changed `examples/Cargo.toml`'s HAL (e.g. embassy-stm32) dependency's feature to use the correct chip (replace the existing stm32xxxx feature) | 93 | * You have changed `+examples/Cargo.toml+`’s HAL (e.g. embassy-stm32) dependency's feature to use the correct chip (replace the existing stm32xxxx feature) |
| 94 | 94 | ||
| 95 | At this point the project should run. If you do not see a blinky LED for blinky, for example, be sure to check the code is toggling your board's LED pin. | 95 | At this point the project should run. If you do not see a blinky LED for blinky, for example, be sure to check the code is toggling your board's LED pin. |
| 96 | 96 | ||
| 97 | If you are trying to run an example with `cargo run --release` and you see the following output: | 97 | If you are trying to run an example with `+cargo run --release+` and you see the following output: |
| 98 | [source] | 98 | [source] |
| 99 | ---- | 99 | ---- |
| 100 | 0.000000 INFO Hello World! | 100 | 0.000000 INFO Hello World! |
| @@ -115,6 +115,20 @@ To get rid of the frame-index error add the following to your `Cargo.toml`: | |||
| 115 | debug = 2 | 115 | debug = 2 |
| 116 | ---- | 116 | ---- |
| 117 | 117 | ||
| 118 | If you’re get an extremely long error message containing something like the following: | ||
| 119 | |||
| 120 | [source] | ||
| 121 | ---- | ||
| 122 | error[E0463]: can't find crate for `std` | ||
| 123 | | | ||
| 124 | = note: the `thumbv6m-none-eabi` target may not support the standard library | ||
| 125 | = note: `std` is required by `stable_deref_trait` because it does not declare `#![no_std]` | ||
| 126 | ---- | ||
| 127 | |||
| 128 | Make sure that you didn’t accidentally run `+cargo add probe-rs+` (which adds it as a dependency) instead of link:https://probe.rs/docs/getting-started/installation/[correctly installing probe-rs]. | ||
| 129 | |||
| 130 | If you’re using a raspberry pi pico-w, make sure you’re running `+cargo run --bin wifi_blinky --release+` rather than the regular blinky. The pico-w’s on-board LED is connected to the WiFi chip, which needs to be initialized before the LED can be blinked. | ||
| 131 | |||
| 118 | If you’re still having problems, check the link:https://embassy.dev/book/dev/faq.html[FAQ], or ask for help in the link:https://matrix.to/#/#embassy-rs:matrix.org[Embassy Chat Room]. | 132 | If you’re still having problems, check the link:https://embassy.dev/book/dev/faq.html[FAQ], or ask for help in the link:https://matrix.to/#/#embassy-rs:matrix.org[Embassy Chat Room]. |
| 119 | 133 | ||
| 120 | == What's next? | 134 | == What's next? |
