pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

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

Browse source
This commit is contained in:
Pete Johanson 2020-10-31 00:30:19 -04:00
parent 7e0924107c
commit 1766b090ee
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
docs/docs/dev-guide-usb-logging.md
View file

@ -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