From 6133b08e73813c19bca8934a44c41c7c2d297a71 Mon Sep 17 00:00:00 2001 From: Joel Challis Date: Thu, 8 Dec 2022 20:41:38 +0000 Subject: [PATCH] Rework input_pressed_state docs (#19267) * Revert changes to porting * Update reference_info_json.md --- docs/porting_your_keyboard_to_qmk.md | 12 ------------ docs/reference_info_json.md | 16 +++++++++++++++- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/porting_your_keyboard_to_qmk.md b/docs/porting_your_keyboard_to_qmk.md index 05054e25c71..484d079ea61 100644 --- a/docs/porting_your_keyboard_to_qmk.md +++ b/docs/porting_your_keyboard_to_qmk.md @@ -94,18 +94,6 @@ The next section of the `info` file deals with your keyboard's matrix. The first The size of the `matrix_pins.cols` and `matrix_pins.rows` arrays infer the size of the matrix (previously `MATRIX_ROWS` and `MATRIX_COLS`). -## Configuration Options - -To invert the keypress logic, configure `input_pressed_state`: - -```json - "matrix_pins": { - "input_pressed_state": 1, -}, -``` - -This configures state of the GPIO pins when the key is pressed - `1` for high, `0` for low. Default value is `0`. - Finally, you can specify the direction your diodes point. This can be `COL2ROW` or `ROW2COL`. ```json diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index 2da67668c0b..354863f5075 100644 --- a/docs/reference_info_json.md +++ b/docs/reference_info_json.md @@ -113,6 +113,20 @@ Example: } ``` +### Additional Options + +* `input_pressed_state` + * This configures state of the GPIO pins when the key is pressed - `1` for high, `0` for low + * Default: `0` + +Example: + +```json + "matrix_pins": { + "input_pressed_state": 1, +}, +``` + ## Non-RGB LED Lighting This section controls basic 2-pin LEDs, which typically pass through keyswitches and are soldered into the PCB, or are placed in PCB sockets. @@ -353,4 +367,4 @@ Example: "matrix": [0, 0] }, } -``` \ No newline at end of file +```