diff options
Diffstat (limited to 'docs/reference_info_json.md')
| -rw-r--r-- | docs/reference_info_json.md | 36 | 
1 files changed, 36 insertions, 0 deletions
| diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md index aa59711592..52f16b4401 100644 --- a/docs/reference_info_json.md +++ b/docs/reference_info_json.md @@ -239,6 +239,42 @@ 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 } +        ] +    } +} +``` +  ### Secure  The following options can be configured: | 
