aboutsummaryrefslogtreecommitdiff
path: root/book/en/src/migration/migration_v2/monotonics.md
diff options
context:
space:
mode:
authordatdenkikniet <jcdra1@gmail.com>2023-04-22 17:37:15 +0200
committerdatdenkikniet <jcdra1@gmail.com>2023-05-11 19:20:58 +0200
commit1dc2f80eb6cb6ac6d1eaede4169d8cabc51c5e7c (patch)
tree0c86b2a70ec77e9e12b3bf0d764110f235efc804 /book/en/src/migration/migration_v2/monotonics.md
parent16f8ea9ba7d0fed1c9f1622b2e9cbcdbbdd807f5 (diff)
Begin migration guide
Diffstat (limited to 'book/en/src/migration/migration_v2/monotonics.md')
-rw-r--r--book/en/src/migration/migration_v2/monotonics.md11
1 files changed, 11 insertions, 0 deletions
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