aboutsummaryrefslogtreecommitdiff
path: root/docs/modules/ROOT/pages/getting_started.adoc
diff options
context:
space:
mode:
authorUlf Lilleengen <[email protected]>2021-12-10 12:04:12 +0100
committerUlf Lilleengen <[email protected]>2021-12-10 12:04:12 +0100
commitb48fcd9229b40800cc96ff3157d8b36057dc2047 (patch)
treedae3fc53363eaf4ce871abd3d6601205b32b05c7 /docs/modules/ROOT/pages/getting_started.adoc
parent7568d0bb68b5d37adf6229ac57c0c961a2a9e803 (diff)
Add more content
Diffstat (limited to 'docs/modules/ROOT/pages/getting_started.adoc')
-rw-r--r--docs/modules/ROOT/pages/getting_started.adoc59
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/modules/ROOT/pages/getting_started.adoc b/docs/modules/ROOT/pages/getting_started.adoc
new file mode 100644
index 000000000..760fe8601
--- /dev/null
+++ b/docs/modules/ROOT/pages/getting_started.adoc
@@ -0,0 +1,59 @@
1= Getting started
2
3So you want to try Embassy, great! To get started, there are a few tools you need to install:
4
5* link:https://rustup.rs/[rustup] - the Rust toolchain is needed to compile Rust code.
6* link:https://crates.io/crates/probe-run[probe-run] - to flash the firmware on your device. If you already have other tools like `OpenOCD` setup, you can use that as well.
7
8If you don't have any supported board, don't worry: you can also run embassy on your PC using the `std` examples.
9
10== Getting a board with examples
11
12Embassy supports many microcontroller families, but the easiest ways to get started is if you have one of the more common development kits.
13
14=== nRF kits
15
16* link:https://www.nordicsemi.com/Products/Development-hardware/nrf52-dk[nRF52 DK]
17* link:https://www.nordicsemi.com/Products/Development-hardware/nRF9160-DK[nRF9160 DK]
18
19=== STM32 kits
20
21* link:https://www.st.com/en/evaluation-tools/nucleo-h743zi.html[STM32 Nucleo-144 development board with STM32H743ZI MCU]
22* link:https://www.st.com/en/evaluation-tools/nucleo-f429zi.html[STM32 Nucleo-144 development board with STM32F429ZI MCU]
23* link:https://www.st.com/en/evaluation-tools/b-l4s5i-iot01a.html[STM32L4+ Discovery kit IoT node, low-power wireless, BLE, NFC, WiFi]
24* link:https://www.st.com/en/evaluation-tools/b-l072z-lrwan1.html[STM32L0 Discovery kit LoRa, Sigfox, low-power wireless]
25* link:https://www.st.com/en/evaluation-tools/nucleo-wl55jc.html[STM32 Nucleo-64 development board with STM32WL55JCI MCU]
26* link:https://www.st.com/en/evaluation-tools/b-u585i-iot02a.html[Discovery kit for IoT node with STM32U5 series]
27
28
29=== RP2040 kits
30
31* link:https://www.raspberrypi.com/products/raspberry-pi-pico/[Raspberry Pi Pico]
32
33== Running an example
34
35First you need to clone the [github repository];
36
37[source, bash]
38----
39git clone https://github.com/embassy-rs/embassy.git
40cd embassy
41----
42
43You can run an example by opening a terminal and entering the following commands:
44
45[source, bash]
46----
47cd examples/nrf
48DEFMT_LOG=info cargo run --bin blinky --release
49----
50
51IMPORTANT: The DEFMT_LOG environment variable controls the example log verbosity. If you do not specify it, you will not see anything logged to the console.
52
53== Whats next?
54
55Congratulations, you have your first Embassy application running! Here are some alternatives on where to go from here:
56
57* Read more about the xref:runtime.adoc[runtime].
58* Read more about the xref:hal.adoc[HAL].
59* Start xref:basic_application.adoc[writing your application].