itsscb/embassy
1
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2025-12-29 21:00:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5123 from potatotech/fix-book-basic-app-refs

Browse Source 
doc: Fix code blocks in book - basic application
This commit is contained in:
xoviat 2025-12-27 23:06:59 +00:00 committed by GitHub
commit ca4fbafa52
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/pages/basic_application.adoc
View File

@ -23,7 +23,7 @@ Then, what follows are some declarations on how to deal with panics and faults.
[source,rust]
----
include::../examples/basic/src/main.rs[lines="8"]
include::../examples/basic/src/main.rs[lines="9"]
----
=== Task declaration
@ -32,7 +32,7 @@ After a bit of import declaration, the tasks run by the application should be de
[source,rust]
----
include::../examples/basic/src/main.rs[lines="10..18"]
include::../examples/basic/src/main.rs[lines="12..23"]
----
An embassy task must be declared `async`, and may NOT take generic arguments. In this case, we are handed the LED that should be blinked and the interval of the blinking.
@ -47,7 +47,7 @@ We then initialize the HAL with a default config, which gives us a `Peripherals`
[source,rust]
----
include::../examples/basic/src/main.rs[lines="20..-1"]
include::../examples/basic/src/main.rs[lines="26..-1"]
----
What happens when the `blinker` task has been spawned and main returns? Well, the main entry point is actually just like any other task, except that you can only have one and it takes some specific type arguments. The magic lies within the `#[embassy_executor::main]` macro. The macro does the following:
@ -64,7 +64,7 @@ The project definition needs to contain the embassy dependencies:
[source,toml]
----
include::../examples/basic/Cargo.toml[lines="9..11"]
include::../examples/basic/Cargo.toml[lines="10..12"]
----
Depending on your microcontroller, you may need to replace `embassy-nrf` with something else (`embassy-stm32` for STM32. Remember to update feature flags as well).