Document embassy::time

This commit is contained in:
Dario Nieuwenhuis
2021-08-24 22:46:07 +02:00
parent 09ffdf63f1
commit 503be49417
7 changed files with 150 additions and 23 deletions

View File

@ -9,7 +9,15 @@ resolver = "2"
default = []
std = ["futures/std", "embassy-traits/std"]
# Enable `embassy::time` module.
# NOTE: This feature is only intended to be enabled by crates providing the time driver implementation.
# Enabling it directly without supplying a time driver will fail to link.
time = []
# Set the `embassy::time` tick rate.
# NOTE: This feature is only intended to be enabled by crates providing the time driver implementation.
# If you're not writing your own driver, check the driver documentation to customize the tick rate.
# If you're writing a driver and your tick rate is not listed here, please add it and send a PR!
time-tick-32768hz = ["time"]
time-tick-1000hz = ["time"]
time-tick-1mhz = ["time"]