Skip to content

Commit 3541ade

Browse files
authored
Add toml changes to migration guides (#4296)
1 parent 60d3199 commit 3541ade

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

esp-hal/MIGRATING-1.0.0-rc.0.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ The `rmt::Channel::transmit_continuously` and
179179

180180
The RMT driver didn't use to properly tie together lifetimes of its types and
181181
therefore didn't statically prevent all kinds of concurrent and conflicting
182-
channel re-use.
182+
channel re-use.
183183
`rmt::Channel` and `rmt::ChannelCreator` now carry a lifetime and can be reborrowed:
184184

185185
```diff
@@ -339,6 +339,13 @@ interrupt::enable_direct(
339339
340340
The `esp-hal-embassy` has been discontinued. Embassy is continued to be supported as part of `esp-rtos`.
341341

342+
To import `esp_rtos` for `embassy` support, add this to your `Cargo.toml`:
343+
344+
```toml
345+
[dependencies]
346+
esp-rtos = { version = "0.1.0", features = ["your_chip", "embassy"] }
347+
```
348+
342349
### Configuration
343350

344351
`esp-hal-embassy` configuration options have not been ported to `esp-rtos`. `esp-rtos` by default works with a single integrated timer queue.
@@ -414,4 +421,3 @@ esp_rtos::start_second_core(
414421
### Interrupt executor changes
415422

416423
Interrupt executors are provided as `esp_rtos::embassy::InterruptExecutor` with no additional changes.
417-

esp-radio/MIGRATING-0.15.0.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@
55
The `builtin-scheduler` feature has been removed. The functionality has been moved to `esp_rtos`.
66
`esp_rtos` needs to be initialized before calling `esp_radio::init`. Failure to do so will result in an error.
77

8+
To import `esp_rtos` for `esp_radio`, add this to your `Cargo.toml`:
9+
10+
```toml
11+
[dependencies]
12+
esp-rtos = { version = "0.1.0", features = ["your_chip", "esp-radio", "esp-alloc"] } # esp-alloc is optional, but recommended
13+
```
14+
815
Depending on your chosen OS, you may need to use other `esp_rtos` implementations.
916

1017
Furthermore, `esp_radio::init` no longer requires `RNG` or a timer.

0 commit comments

Comments
 (0)