fern/qmk-firmware
1
0
Fork 0
mirror of https://github.com/firewalkwithm3/qmk_firmware.git synced 2024-11-22 19:40:29 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Add LED backlight/indicator info to reference_info_json.md (#17010)

Browse source 
Co-authored-by: Joel Challis <git@zvecr.com>
This commit is contained in:
Josh Hinnebusch 2022-07-02 07:27:34 -04:00 committed by GitHub
parent 6fce400ef5
commit 096db8c8ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 53 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
docs/reference_info_json.md
View file

@ -108,7 +108,58 @@ Example:
}
```
### RGB Lighting
## 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.
### Backlight
* `breathing`
* Enable backlight breathing, if supported
* `breathing_period`
* The length of one backlight “breath” in seconds
* `levels`
* The number of brightness levels (maximum 31, excluding off)
* `pin`
* The pin that controls the backlight LED(s)
Example:
```json
{
"backlight": {
"breathing": true,
"breathing_period": 5,
"levels": 15,
"pin": "B7"
}
}
```
### LED Indicators
Used for indicating Num Lock, Caps Lock, and Scroll Lock. May be soldered in-switch or in a dedicated area.
* `num_lock`
* The pin that controls the `Num Lock` LED
* `caps_lock`
* The pin that controls the `Caps Lock` LED
* `scroll_lock`
* The pin that controls the `Scroll Lock` LED
Example:
```json
{
"indicators": {
"num_lock": "B6",
"caps_lock": "D2",
"scroll_lock": "A3"
}
}
```
## RGB Lighting
This section controls the legacy WS2812 support in QMK. This should not be confused with the RGB Matrix feature, which can be used to control both WS2812 and ISSI RGB LEDs.
@ -152,7 +203,7 @@ Example:
}
```
#### RGBLight Animations
### RGBLight Animations
The following animations can be enabled: