From 666b62c784cc513ffa4efc9698f4bb2f4a90d46d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Arnim=20L=C3=A4uger?= Date: Mon, 27 Mar 2017 10:31:25 +0200 Subject: [PATCH] Note about timer resolution --- docs/en/modules/tmr.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/en/modules/tmr.md b/docs/en/modules/tmr.md index d6539a87..b4db0689 100644 --- a/docs/en/modules/tmr.md +++ b/docs/en/modules/tmr.md @@ -7,6 +7,10 @@ The tmr module allows access to simple timers. It is aimed at setting up regular What the tmr module is *not* however, is a time keeping module. While all timeouts are expressed in milliseconds, the accuracy is limited and compounding errors would lead to rather inaccurate time keeping. Consider using the [rtctime](rtctime.md) module for "wall clock" time. +!!! note + + The resolution of the timers is determined by FreeRTOS' tick rate. The default rate of 100 kHz (resulting in 10 ms resolution) can be changed with `make menuconfig` at item `Component config ---> FreeRTOS ---> Tick rate (Hz)`. + ## tmr.create() Creates a dynamic timer object.