aboutsummaryrefslogtreecommitdiff
path: root/docs/modules/ROOT/pages/getting_started.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/modules/ROOT/pages/getting_started.adoc')
-rw-r--r--docs/modules/ROOT/pages/getting_started.adoc73
1 files changed, 69 insertions, 4 deletions
diff --git a/docs/modules/ROOT/pages/getting_started.adoc b/docs/modules/ROOT/pages/getting_started.adoc
index 2c6f4b1ee..ab819ac2a 100644
--- a/docs/modules/ROOT/pages/getting_started.adoc
+++ b/docs/modules/ROOT/pages/getting_started.adoc
@@ -9,7 +9,9 @@ If you don't have any supported board, don't worry: you can also run embassy on
9 9
10== Getting a board with examples 10== Getting a board with examples
11 11
12Embassy supports many microcontroller families, but the easiest ways to get started is if you have one of the more common development kits. 12Embassy supports many microcontroller families, but the quickest way to get started is by using a board which Embassy has existing example code for.
13
14This list is non-exhaustive. If your board isn’t included here, check the link:https://github.com/embassy-rs/embassy/tree/main/examples[examples folder] to see if example code has been written for it.
13 15
14=== nRF kits 16=== nRF kits
15 17
@@ -36,7 +38,7 @@ Embassy supports many microcontroller families, but the easiest ways to get star
36 38
37== Running an example 39== Running an example
38 40
39First you need to clone the [github repository]; 41First you need to clone the link:https://github.com/embassy-rs/embassy[github repository];
40 42
41[source, bash] 43[source, bash]
42---- 44----
@@ -44,17 +46,80 @@ git clone https://github.com/embassy-rs/embassy.git
44cd embassy 46cd embassy
45---- 47----
46 48
47You can run an example by opening a terminal and entering the following commands: 49Once you have a copy of the repository, find examples folder for your board and, and build an example program. `blinky` is a good choice as all it does is blink an LED – the embedded world’s equivalent of “Hello World”.
48 50
49[source, bash] 51[source, bash]
50---- 52----
51cd examples/nrf52840 53cd examples/nrf52840
54cargo build --bin blinky --release
55----
56
57Once you’ve confirmed you can build the example, connect your computer to your board with a debug probe and run it on hardware:
58
59[source, bash]
60----
52cargo run --bin blinky --release 61cargo run --bin blinky --release
53---- 62----
54 63
64If everything worked correctly, you should see a blinking LED on your board, and debug output similar to this on your computer:
65
66[source]
67----
68 Finished dev [unoptimized + debuginfo] target(s) in 1m 56s
69 Running `probe-run --chip STM32F407VGTx target/thumbv7em-none-eabi/debug/blinky`
70(HOST) INFO flashing program (71.36 KiB)
71(HOST) INFO success!
72────────────────────────────────────────────────────────────────────────────────
730 INFO Hello World!
74└─ blinky::__embassy_main::task::{generator#0} @ src/bin/blinky.rs:18
751 INFO high
76└─ blinky::__embassy_main::task::{generator#0} @ src/bin/blinky.rs:23
772 INFO low
78└─ blinky::__embassy_main::task::{generator#0} @ src/bin/blinky.rs:27
793 INFO high
80└─ blinky::__embassy_main::task::{generator#0} @ src/bin/blinky.rs:23
814 INFO low
82└─ blinky::__embassy_main::task::{generator#0} @ src/bin/blinky.rs:27
83----
84
85NOTE: 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
87=== It didn’t work!
88
89If you hare having issues when running `cargo run --release`, please check the following:
90
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
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
95At 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
97If you are trying to run an example with `cargo run --release` and you see the following output:
98[source]
99----
1000.000000 INFO Hello World!
101└─ <invalid location: defmt frame-index: 14>
1020.000000 DEBUG rcc: Clocks { sys: Hertz(80000000), apb1: Hertz(80000000), apb1_tim: Hertz(80000000), apb2: Hertz(80000000), apb2_tim: Hertz(80000000), ahb1: Hertz(80000000), ahb2: Hertz(80000000), ahb3: Hertz(80000000) }
103└─ <invalid location: defmt frame-index: 124>
1040.000061 TRACE allocating type=Interrupt mps=8 interval_ms=255, dir=In
105└─ <invalid location: defmt frame-index: 68>
1060.000091 TRACE index=1
107└─ <invalid location: defmt frame-index: 72>
108----
109
110To get rid of the frame-index error add the following to your `Cargo.toml`:
111
112[source,toml]
113----
114[profile.release]
115debug = 2
116----
117
118If 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
55== What's next? 120== What's next?
56 121
57Congratulations, you have your first Embassy application running! Here are some alternatives on where to go from here: 122Congratulations, you have your first Embassy application running! Here are some suggestions for where to go from here:
58 123
59* Read more about the xref:runtime.adoc[executor]. 124* Read more about the xref:runtime.adoc[executor].
60* Read more about the xref:hal.adoc[HAL]. 125* Read more about the xref:hal.adoc[HAL].