feat(docs): Warn of battery life impact of logging

4 years ago · 1766b090ee
1 changed files with 7 additions and 0 deletions
--- 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
				@@ -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