xenua
/
zmk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

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

xmkb
Pete Johanson 4 years ago
parent
7e0924107c
commit
1766b090ee
1 changed files with 7 additions and 0 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 7
      docs/docs/dev-guide-usb-logging.md

7
docs/docs/dev-guide-usb-logging.md
Unescape 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 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. 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 ## Kconfig
The following KConfig values need to be set, either by copy and pasting into the `app/prj.conf` file, or by running The following KConfig values need to be set, either by copy and pasting into the `app/prj.conf` file, or by running

Write Preview
Loading…
Cancel
Save