From 1766b090ee12dab95b4c4c5587a4d43468a48270 Mon Sep 17 00:00:00 2001 From: Pete Johanson Date: Sat, 31 Oct 2020 00:30:19 -0400 Subject: [PATCH] feat(docs): Warn of battery life impact of logging --- docs/docs/dev-guide-usb-logging.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/docs/dev-guide-usb-logging.md b/docs/docs/dev-guide-usb-logging.md index d0274d18..7f1fad72 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