Skip to content

Commit

Permalink
Rework input_pressed_state docs (#19267)
Browse files Browse the repository at this point in the history
* Revert changes to porting

* Update reference_info_json.md
  • Loading branch information
zvecr authored Dec 8, 2022
1 parent 6ae0f83 commit 6133b08
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 13 deletions.
12 changes: 0 additions & 12 deletions docs/porting_your_keyboard_to_qmk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 15 additions & 1 deletion docs/reference_info_json.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -353,4 +367,4 @@ Example:
"matrix": [0, 0]
},
}
```
```

0 comments on commit 6133b08

Please sign in to comment.