kmk_firmware/docs/debugging.md

12 lines
652 B
Markdown
Raw Normal View History

# Debugging
2018-10-12 04:06:10 +02:00
Debug will output most of the useful state to the console. This can be enable in your firmware
by setting this in your keymap. NOTE that it will be slower, so only enable this when you
2018-10-12 04:06:10 +02:00
need debugging.
```python
keyboard.debug_enabled = True
2018-10-12 04:06:10 +02:00
```
The output can be viewed by connecting to the serial port of the keybord. Please refer to [THIS](https://learn.adafruit.com/welcome-to-circuitpython/kattni-connecting-to-the-serial-console) for
more information when connecting to serial console. For Linux users, we recommend [picocom](https://github.com/npat-efault/picocom) or
[screen](https://www.gnu.org/software/screen/manual/screen.html)