qmk_firmware

commit 096db8c8ca04322d8f33843e5a82292741b1c1c9
parent 6fce400ef52ddc0ffe3f0f2a4aa16949d94658bb
Author: Josh Hinnebusch <joshhinnebusch@gmail.com>
Date:   Sat,  2 Jul 2022 07:27:34 -0400

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

Co-authored-by: Joel Challis <git@zvecr.com>
Diffstat:
M
docs/reference_info_json.md
 | 
55
+++++++++++++++++++++++++++++++++++++++++++++++++++++--

1 file changed, 53 insertions(+), 2 deletions(-)
diff --git 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: