summaryrefslogtreecommitdiff
path: root/docs/reference_info_json.md
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-07-02 11:27:40 +0000
committerQMK Bot <hello@qmk.fm>2022-07-02 11:27:40 +0000
commit05074cbdf0eaaff2522bfcd5cc750b83e1d61a1c (patch)
treea847645c7b3028b18e1123c1f6e8f593f892ec83 /docs/reference_info_json.md
parenta949d32072e277150508590d048d5dfcba8083bd (diff)
parent096db8c8ca04322d8f33843e5a82292741b1c1c9 (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs/reference_info_json.md')
-rw-r--r--docs/reference_info_json.md55
1 files changed, 53 insertions, 2 deletions
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index d2e9346ee3..759345a28b 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -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: