summaryrefslogtreecommitdiff
path: root/docs/FAQ-Keymap.md
diff options
context:
space:
mode:
authorskullY <skullydazed@gmail.com>2017-06-09 11:47:38 -0700
committerskullY <skullydazed@gmail.com>2017-06-09 11:47:53 -0700
commit767bcac23c6ea990881ed4dad8818a51e399b081 (patch)
tree2a2b3f2762ba9597e2cbd9f8227fe7c00da8ad85 /docs/FAQ-Keymap.md
parentd2aec1625d17b77e989aa33c4270a102947642dd (diff)
Clean up and improve the macro documentation
Diffstat (limited to 'docs/FAQ-Keymap.md')
-rw-r--r--docs/FAQ-Keymap.md21
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/FAQ-Keymap.md b/docs/FAQ-Keymap.md
index 7c73f571fe..623726ab2e 100644
--- a/docs/FAQ-Keymap.md
+++ b/docs/FAQ-Keymap.md
@@ -111,7 +111,6 @@ https://github.com/tekezo/Karabiner/issues/403
## Esc and `~ on a key
-
You can define FC660 and Poker style ESC with `ACTION_LAYER_MODS`.
https://github.com/tmk/tmk_core/blob/master/doc/keymap.md#35-momentary-switching-with-modifiers
@@ -245,4 +244,22 @@ without weak mods,
here real_mods lost state for 'physical left shift'.
weak_mods is ORed with real_mods when keyboard report is sent.
-https://github.com/tmk/tmk_core/blob/master/common/action_util.c#L57 \ No newline at end of file
+https://github.com/tmk/tmk_core/blob/master/common/action_util.c#L57
+
+## Timer functionality
+
+It's possible to start timers and read values for time-specific events - here's an example:
+
+```c
+static uint16_t key_timer;
+key_timer = timer_read();
+
+if (timer_elapsed(key_timer) < 100) {
+ // do something if less than 100ms have passed
+} else {
+ // do something if 100ms or more have passed
+}
+```
+
+It's best to declare the `static uint16_t key_timer;` at the top of the file, outside of any code blocks you're using it in.
+