From 1dc2f80eb6cb6ac6d1eaede4169d8cabc51c5e7c Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 22 Apr 2023 17:37:15 +0200 Subject: Begin migration guide --- book/en/src/migration/migration_v2/monotonics.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 book/en/src/migration/migration_v2/monotonics.md (limited to 'book/en/src/migration/migration_v2/monotonics.md') diff --git a/book/en/src/migration/migration_v2/monotonics.md b/book/en/src/migration/migration_v2/monotonics.md new file mode 100644 index 0000000..f794bec --- /dev/null +++ b/book/en/src/migration/migration_v2/monotonics.md @@ -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). \ No newline at end of file -- cgit v1.2.3