diff options
| author | datdenkikniet <jcdra1@gmail.com> | 2023-04-13 18:10:29 +0200 |
|---|---|---|
| committer | datdenkikniet <jcdra1@gmail.com> | 2023-04-15 19:19:49 +0200 |
| commit | 401c636215f02e750939e550bc02622ea7834f3c (patch) | |
| tree | 8e527dc21a2e6c55d8a297cccdaa726172e66f79 /rtic-monotonics/src/systick.rs | |
| parent | ef8046b060a375fd5e6b23d62c3a9a303bbd6e11 (diff) | |
rtic-monotonics: Add some docs
Diffstat (limited to 'rtic-monotonics/src/systick.rs')
| -rw-r--r-- | rtic-monotonics/src/systick.rs | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/rtic-monotonics/src/systick.rs b/rtic-monotonics/src/systick.rs index cba9aa2..0f215a7 100644 --- a/rtic-monotonics/src/systick.rs +++ b/rtic-monotonics/src/systick.rs @@ -1,6 +1,14 @@ -//! A monotonics based on Cortex-M SysTick. Note that this implementation is inefficient as it -//! ticks, and generates interrupts, at a constant rate. +//! [`Monotonic`] based on Cortex-M SysTick. Note: this implementation is inefficient as it +//! ticks and generates interrupts at a constant rate. //! +//! Currently, the following tick rates are supported: +//! +//! | Feature | Tick rate | Precision | +//! |:----------------:|----------:|----------:| +//! | (none / default) | 1 Hz | 1 ms | +//! | systick-100hz | 100 Hz | 10 ms | +//! | systick-10khz | 10 KHz | 0.1 ms | + //! # Example //! //! ``` |