From 1a400d8644a1f0763c68626863b897cb83c6c939 Mon Sep 17 00:00:00 2001
From: Joel Challis <git@zvecr.com>
Date: Tue, 21 Jun 2022 04:15:06 +0100
Subject: Allow encoder config from info.json (#17295)

---
 docs/reference_info_json.md | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

(limited to 'docs/reference_info_json.md')

diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index 90b28689d0..d2e9346ee3 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -187,3 +187,39 @@ Example:
 ```
 
 The device version is a BCD (binary coded decimal) value, in the format `MMmr`, so the below value would look like `0x0100` in the generated code. This also means the maximum valid values for each part are `99.9.9`, despite it being a hexadecimal value under the hood.
+
+### Encoders
+
+This section controls the basic [rotary encoder](feature_encoders.md) support.
+
+The following items can be set. Not every value is required.
+
+* `pin_a`
+  * __Required__. A pad definition
+* `pin_b`
+  * __Required__. B pad definition
+* `resolution`
+  * How many pulses the encoder registers between each detent
+
+Examples:
+
+```json
+{
+    "encoder": {
+        "rotary": [
+            { "pin_a": "B5", "pin_b": "A2" }
+        ]
+    }
+}
+```
+
+```json
+{
+    "encoder": {
+        "rotary": [
+            { "pin_a": "B5", "pin_b": "A2", "resolution": 4 }
+            { "pin_a": "B6", "pin_b": "A3", "resolution": 2 }
+        ]
+    }
+}
+```
-- 
cgit v1.2.3