docs/newbs_testing_debugging.md

   1 # Testing and Debugging
   2
   3 Once you've flashed your keyboard with a custom firmware you're ready to test it out. With a little bit of luck everything will work perfectly, but if not this document will help you figure out what's wrong.
   4
   5 ## Testing
   6
   7 Testing your keyboard is usually pretty straightforward. Press every single key and make sure it sends the keys you expect. You can use [QMK Configurator](https://config.qmk.fm/#/test/)'s test mode to check your keyboard, even if it doesn't run QMK.
   8
   9 ## Debugging :id=debugging
  10
  11 Your keyboard will output debug information if you have `CONSOLE_ENABLE = yes` in your `rules.mk`. By default the output is very limited, but you can turn on debug mode to increase the amount of debug output. Use the `DEBUG` keycode in your keymap, use the [Command](feature_command.md) feature to enable debug mode, or add the following code to your keymap.
  12
  13 ```c
  14 void keyboard_post_init_user(void) {
  15   // Customise these values to desired behaviour
  16   debug_enable=true;
  17   debug_matrix=true;
  18   //debug_keyboard=true;
  19   //debug_mouse=true;
  20 }
  21 ```
  22
  23 ## Debugging Tools
  24
  25 There are two different tools you can use to debug your keyboard.
  26
  27 ### Debugging With QMK Toolbox
  28
  29 For compatible platforms, [QMK Toolbox](https://github.com/qmk/qmk_toolbox) can be used to display debug messages from your keyboard.
  30
  31 ### Debugging With hid_listen
  32
  33 Prefer a terminal based solution? [hid_listen](https://www.pjrc.com/teensy/hid_listen.html), provided by PJRC, can also be used to display debug messages. Prebuilt binaries for Windows,Linux,and MacOS are available.
  34
  35 ## Sending Your Own Debug Messages
  36
  37 Sometimes it's useful to print debug messages from within your [custom code](custom_quantum_functions.md). Doing so is pretty simple. Start by including `print.h` at the top of your file:
  38
  39     #include <print.h>
  40
  41 After that you can use a few different print functions:
  42
  43 * `print("string")`: Print a simple string.
  44 * `uprintf("%s string", var)`: Print a formatted string
  45 * `dprint("string")` Print a simple string, but only when debug mode is enabled
  46 * `dprintf("%s string", var)`: Print a formatted string, but only when debug mode is enabled
  47
  48 ## Debug Examples
  49
  50 Below is a collection of real world debugging examples. For additional information, refer to [Debugging/Troubleshooting QMK](faq_debug.md).
  51
  52 ### Which matrix position is this keypress?
  53
  54 When porting, or when attempting to diagnose pcb issues, it can be useful to know if a keypress is scanned correctly. To enable logging for this scenario, add the following code to your keymaps `keymap.c`
  55
  56 ```c
  57 bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  58   // If console is enabled, it will print the matrix position and status of each key pressed
  59 #ifdef CONSOLE_ENABLE
  60     uprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed);
  61 #endif
  62   return true;
  63 }
  64 ```
  65
  66 Example output
  67 ```text
  68 Waiting for device:.......
  69 Listening:
  70 KL: kc: 169, col: 0, row: 0, pressed: 1
  71 KL: kc: 169, col: 0, row: 0, pressed: 0
  72 KL: kc: 174, col: 1, row: 0, pressed: 1
  73 KL: kc: 174, col: 1, row: 0, pressed: 0
  74 KL: kc: 172, col: 2, row: 0, pressed: 1
  75 KL: kc: 172, col: 2, row: 0, pressed: 0
  76 ```
  77
  78 ### How long did it take to scan for a keypress?
  79
  80 When testing performance issues, it can be useful to know the frequency at which the switch matrix is being scanned. To enable logging for this scenario, add the following code to your keymaps `config.h`
  81
  82 ```c
  83 #define DEBUG_MATRIX_SCAN_RATE
  84 ```
  85
  86 Example output
  87 ```text
  88   > matrix scan frequency: 315
  89   > matrix scan frequency: 313
  90   > matrix scan frequency: 316
  91   > matrix scan frequency: 316
  92   > matrix scan frequency: 316
  93   > matrix scan frequency: 316
  94 ```