mirror of
https://github.com/embassy-rs/embassy.git
synced 2024-11-25 08:12:30 +00:00
Document #[embassy::main(config = ...)]
Add an example documenting the config param based on help I got in the matrix chat. Because the example is very short and incompatible with the other example code I just included it inline.
This commit is contained in:
parent
37bd796fb3
commit
e15d3750ea
@ -48,6 +48,18 @@ The `Spawner` is the way the main application spawns other tasks. The `Periphera
|
||||
include::example$basic/src/main.rs[lines="28..-1"]
|
||||
----
|
||||
|
||||
`#[embassy::main]` takes an optional `config` paramter specifying a function that returns an instance of HAL's `Config` struct. For example:
|
||||
|
||||
```rust
|
||||
fn embassy_config() -> embassy_nrf::config::Config {
|
||||
embassy_nrf::config::Config::default()
|
||||
}
|
||||
|
||||
#[embassy::main(config = "embassy_config()")]
|
||||
async fn main(_spawner: embassy::executor::Spawner, p: embassy_nrf::Peripherals) {
|
||||
// ...
|
||||
}
|
||||
```
|
||||
|
||||
What happens when the `blinker` task have 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::main]` macro. The macro does the following:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user