summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-09-29 15:02:27 +0000
committerQMK Bot <hello@qmk.fm>2022-09-29 15:02:27 +0000
commit3a10514e4f46895202db2988c262a8e58861a4fc (patch)
tree3be37fc483a84ba5def6dabe14ceb0d41cc6046b /docs
parentee588049a9917b644cbbb1818d293629bd130bd1 (diff)
parent961de3c20524ded55aa3778b15bedfa3f192905a (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/reference_info_json.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index 52f16b4401..34c536b329 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -91,6 +91,8 @@ Direct pins are when you connect one side of the switch to GND and the other sid
When specifying direct pins you need to arrange them in nested arrays. The outer array consists of rows, while the inner array uses text strings to identify the pins used in each row. You can use `null` to indicate an empty spot in the matrix.
+Notice that when using direct pins, `diode_direction` is left undefined.
+
Example:
```json
@@ -113,6 +115,14 @@ Example:
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
+Enable by setting
+
+```json
+ "features": {
+ "backlight": true
+ }
+```
+
* `breathing`
* Enable backlight breathing, if supported
* `breathing_period`
@@ -177,8 +187,9 @@ The following items can be set. Not every value is required.
* Set to `true` to enable synchronization functionality between split halves
* `split_count`
* For split keyboards, the number of LEDs on each side
+ * Example `[ 10 , 10 ]`
* `max_brightness`
- * (0-255) What the maxmimum brightness (value) level is
+ * What the maximum brightness (value) level is (0-255)
* `hue_steps`
* How many steps of adjustment to have for hue
* `saturation_steps`
@@ -243,6 +254,14 @@ The device version is a BCD (binary coded decimal) value, in the format `MMmr`,
This section controls the basic [rotary encoder](feature_encoders.md) support.
+Enable by setting
+
+```json
+ "features": {
+ "encoder": true
+ }
+```
+
The following items can be set. Not every value is required.
* `pin_a`