diff options
| author | Pete Johanson <peter@peterjohanson.com> | 2020-10-31 00:30:19 -0400 |
|---|---|---|
| committer | Pete Johanson <peter@peterjohanson.com> | 2020-10-31 00:30:19 -0400 |
| commit | 1766b090ee12dab95b4c4c5587a4d43468a48270 (patch) | |
| tree | 2d4a352e3fcb655c91a18b40dfef47fac8e9993a /docs | |
| parent | 7e0924107cf64e90812ca6f99dffa526a5052c6f (diff) | |
feat(docs): Warn of battery life impact of logging
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/dev-guide-usb-logging.md | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/docs/dev-guide-usb-logging.md b/docs/docs/dev-guide-usb-logging.md index d0274d1..7f1fad7 100644 --- a/docs/docs/dev-guide-usb-logging.md +++ b/docs/docs/dev-guide-usb-logging.md @@ -12,6 +12,13 @@ If you are developing ZMK on a device that does not have a built in UART for deb Zephyr can be configured to create a USB CDC ACM device and the direct all `printk`, console output, and log messages to that device instead. +:::warning Battery Life Impact + +Enabling logging increases the power usage of your keyboard, and can have a non-trivial impact to your time on battery. +It is recommended to only enable logging when needed, and not leaving it on by default. + +::: + ## Kconfig The following KConfig values need to be set, either by copy and pasting into the `app/prj.conf` file, or by running |