diff options
| author | Dominik Boehi <[email protected]> | 2023-01-09 22:29:58 +0100 |
|---|---|---|
| committer | Dominik Boehi <[email protected]> | 2023-01-09 22:30:02 +0100 |
| commit | 0a27b6cedb52453123190671f294bbd34918e09a (patch) | |
| tree | 3888e0b352388ace235517ec97c4d3a88fd7fcfa /README.md | |
| parent | 401185b1d95a2519ee94e5d5654cc9325fe85eec (diff) | |
Rename examples/nrf to examples/nrf52840
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 4 insertions, 3 deletions
| @@ -19,7 +19,7 @@ Rust's <a href="https://rust-lang.github.io/async-book/">async/await</a> allows | |||
| 19 | No more messing with hardware timers. <a href="https://docs.embassy.dev/embassy-time">embassy_time</a> provides Instant, Duration and Timer types that are globally available and never overflow. | 19 | No more messing with hardware timers. <a href="https://docs.embassy.dev/embassy-time">embassy_time</a> provides Instant, Duration and Timer types that are globally available and never overflow. |
| 20 | 20 | ||
| 21 | - **Real-time ready** - | 21 | - **Real-time ready** - |
| 22 | Tasks on the same async executor run cooperatively, but you can create multiple executors with different priorities, so that higher priority tasks preempt lower priority ones. See the <a href="https://github.com/embassy-rs/embassy/blob/master/examples/nrf/src/bin/multiprio.rs">example</a>. | 22 | Tasks on the same async executor run cooperatively, but you can create multiple executors with different priorities, so that higher priority tasks preempt lower priority ones. See the <a href="https://github.com/embassy-rs/embassy/blob/master/examples/nrf52840/src/bin/multiprio.rs">example</a>. |
| 23 | 23 | ||
| 24 | - **Low-power ready** - | 24 | - **Low-power ready** - |
| 25 | Easily build devices with years of battery life. The async executor automatically puts the core to sleep when there's no work to do. Tasks are woken by interrupts, there is no busy-loop polling while waiting. | 25 | Easily build devices with years of battery life. The async executor automatically puts the core to sleep when there's no work to do. Tasks are woken by interrupts, there is no busy-loop polling while waiting. |
| @@ -87,7 +87,8 @@ async fn main(spawner: Spawner) { | |||
| 87 | 87 | ||
| 88 | Examples are found in the `examples/` folder seperated by the chip manufacturer they are designed to run on. For example: | 88 | Examples are found in the `examples/` folder seperated by the chip manufacturer they are designed to run on. For example: |
| 89 | 89 | ||
| 90 | * `examples/nrf` run on the `nrf52840-dk` board (PCA10056) but should be easily adaptable to other nRF52 chips and boards. | 90 | * `examples/nrf52840` run on the `nrf52840-dk` board (PCA10056) but should be easily adaptable to other nRF52 chips and boards. |
| 91 | * `examples/nrf5340` run on the `nrf5340-dk` board (PCA10095). | ||
| 91 | * `examples/stm32xx` for the various STM32 families. | 92 | * `examples/stm32xx` for the various STM32 families. |
| 92 | * `examples/rp` are for the RP2040 chip. | 93 | * `examples/rp` are for the RP2040 chip. |
| 93 | * `examples/std` are designed to run locally on your PC. | 94 | * `examples/std` are designed to run locally on your PC. |
| @@ -110,7 +111,7 @@ cargo install probe-run | |||
| 110 | - Change directory to the sample's base directory. For example: | 111 | - Change directory to the sample's base directory. For example: |
| 111 | 112 | ||
| 112 | ```bash | 113 | ```bash |
| 113 | cd examples/nrf | 114 | cd examples/nrf52840 |
| 114 | ``` | 115 | ``` |
| 115 | 116 | ||
| 116 | - Run the example | 117 | - Run the example |