Begin migration guide

This commit is contained in:
datdenkikniet 2023-04-22 17:37:15 +02:00
parent 16f8ea9ba7
commit 1dc2f80eb6
7 changed files with 344 additions and 1 deletions

View file

@ -0,0 +1,11 @@
# Migrating to `rtic-monotonics`
In previous versions of `rtic`, monotonics were an integral, tightly coupled part of the `#[rtic::app]`. In this new version, `rtic-monotonics` provides them in a more decoupled way.
The `#[monotonic]` attribute is no longer used. Instead, you use a `create_X_token` from `rtic-monotonics`. An invocation of this macro returns an interrupt registration token, which can be used to construct an instance of your desired monotonic.
`spawn_after` and `spawn_at` are no longer available. Instead, you use the async functions `Monotonic::delay` and `Monotonics::delay_until`. The `Monotonic` trait is provided by `rtic-time`.
Check out the [code example](./complete_example.md) for an overview of the required changes.
For more information on current monotonic implementations, see [the `rtic-monotonics` documentation](https://docs.rs/rtic-monotonics).