rtic/rtic-monotonics/README.md
Dan Whitman 0935051d8b
ATSAMD RTC monotonic referral in documentation (#1014)
* rtic-monotonics: Adds a section to the module documentation about ATSAMD chip monotonics provided in the `atsamd-hal` crate

* rtic-monotonics: Adds a section to README listing the supported microcontroller platforms.

* rtic-sync: Fix clippy complaints

error: the following explicit lifetimes could be elided: 'a
   --> rtic-sync/src/signal.rs:113:6
    |
113 | impl<'a, T: Copy> SignalReader<'a, T> {
    |      ^^                        ^^
    |
    = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#needless_lifetimes
    = note: `-D clippy::needless-lifetimes` implied by `-D warnings`
    = help: to override `-D warnings` add `#[allow(clippy::needless_lifetimes)]`
help: elide the lifetimes
    |
113 - impl<'a, T: Copy> SignalReader<'a, T> {
113 + impl<T: Copy> SignalReader<'_, T> {

* xtask: Clippy fix warning

warning: elided lifetime has a name
   --> xtask/src/cargo_command.rs:427:14
    |
420 |     fn build_args<'i, T: Iterator<Item = &'i str>>(
    |                   -- lifetime `'i` declared here
...
427 |     ) -> Vec<&str> {
    |              ^ this elided lifetime gets resolved as `'i`
    |
    = note: `#[warn(elided_named_lifetimes)]` on by default

---------

Co-authored-by: Dan Whitman <daniel.whitman.2@us.af.mil>
Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2025-01-24 20:08:52 +00:00

43 lines
1.4 KiB
Markdown

[![crates.io](https://img.shields.io/crates/v/rtic-monotonics.svg)](https://crates.io/crates/rtic-monotonics)
[![crates.io](https://img.shields.io/crates/d/rtic-monotonics.svg)](https://crates.io/crates/rtic-monotonics)
# `rtic-monotonics`
> Core abstractions of the Real-Time Interrupt-driven Concurrency (RTIC) Monotonics timers
`rtic-monotonics` is for RTIC v2.
For RTIC v1 see [`rtic-monotonic`](https://github.com/rtic-rs/rtic-monotonic)
## [Documentation](https://docs.rs/rtic-monotonics)
[RTIC book: chapter on monotonics](https://rtic.rs/2/book/en/by-example/delay.html)
### [Changelog `rtic-monotonics`](https://github.com/rtic-rs/rtic/blob/master/rtic-monotonics/CHANGELOG.md)
## Supported Platforms
The following microcontroller families feature efficient monotonics using peripherals.
Refer to the [crate documentation](https://docs.rs/rtic-monotonics) for more details.
- RP2040
- i.MX RT
- nRF
- ATSAMD
## License
Licensed under either of
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.