nordic-dev.net/embassy
2
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2024-11-21 22:32:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
ae8caf3f55
embassy/embassy-time-driver
History
Dario Nieuwenhuis d193c9ef44 time-driver: clarify docs for set_alarm.
2024-09-11 01:36:11 +02:00
..
src time-driver: clarify docs for set_alarm. 2024-09-11 01:36:11 +02:00
build.rs time: split driver into a separate embassy-time-driver crate. 2024-01-11 16:56:08 +01:00
Cargo.toml Complete cargo.tomls more. 2024-01-12 00:32:47 +01:00
gen_tick.py time: split driver into a separate embassy-time-driver crate. 2024-01-11 16:56:08 +01:00
README.md time: docs improvements, add ci. 2024-01-11 17:17:58 +01:00

README.md

embassy-time-driver

This crate contains the driver trait necessary for adding embassy-time support for a new hardware platform.

If you want to use embassy-time with already made drivers, you should depend on the main embassy-time crate, not on this crate.

If you are writing a driver, you should depend only on this crate, not on the main embassy-time crate. This will allow your driver to continue working for newer embassy-time major versions, without needing an update, if the driver trait has not had breaking changes.

How it works

embassy-time is backed by a global "time driver" specified at build time. Only one driver can be active in a program.

All methods and structs transparently call into the active driver. This makes it possible for libraries to use embassy-time in a driver-agnostic way without requiring generic parameters.