From d13e31acbeb7332c23f0d81221d98238cec5a336 Mon Sep 17 00:00:00 2001 From: GreenAirplane Date: Thu, 14 Jul 2022 01:37:07 -0400 Subject: [PATCH] feat(docs): Added behavior queue limit section to macros page --- docs/docs/behaviors/macros.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/docs/behaviors/macros.md b/docs/docs/behaviors/macros.md index aca9eb7a..416163a6 100644 --- a/docs/docs/behaviors/macros.md +++ b/docs/docs/behaviors/macros.md @@ -134,6 +134,12 @@ bindings ; ``` +### Behavior Queue Limit + +The default queue limit is 64. However, some actions require multiple events (e.g. `&kp` requires `key press` and `key release` events). As a result, the effective number of actions can be less than 64. + +You can change the limit by adding `CONFIG_ZMK_BEHAVIORS_QUEUE_SIZE=n` to your `.conf` file. For example, you can add `CONFIG_ZMK_BEHAVIORS_QUEUE_SIZE=512` if your macro outputs more than 200 characters. + ## Common Patterns Below are some examples of how the macro behavior can be used for various useful functionality.