diff options
| author | Kevin <chenkevinh11@gmail.com> | 2020-09-02 21:12:22 -0700 |
|---|---|---|
| committer | Kevin <chenkevinh11@gmail.com> | 2020-09-02 21:12:22 -0700 |
| commit | e904a098b3ad2af28485e0f79287ac3b04947d1c (patch) | |
| tree | 9f1836ee85d1f831b57f9f4264ea63ab8067bf7f | |
| parent | 5eb50d7b181d2c61099b49f74b1b54c996370914 (diff) | |
Added keymap update to encoder docs
| -rw-r--r-- | docs/docs/dev-guide-new-shield.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/docs/dev-guide-new-shield.md b/docs/docs/dev-guide-new-shield.md index 7825d8b..bc5175b 100644 --- a/docs/docs/dev-guide-new-shield.md +++ b/docs/docs/dev-guide-new-shield.md @@ -203,7 +203,7 @@ Further documentation on behaviors and bindings is forthcoming, but a summary of ### Encoders -EC11 encoder support can be added to your board or shield by adding the appropriate lines to your board/shield's configuration (.conf), device tree (.dtsi), and overlay (.overlay) files. +EC11 encoder support can be added to your board or shield by adding the appropriate lines to your board/shield's configuration (.conf), device tree (.dtsi), overlay (.overlay), and keymap (.keymap) files. <Tabs defaultValue="conf" @@ -211,6 +211,7 @@ values={[ {label: '.conf', value: 'conf'}, {label: '.dtsi', value: 'dtsi'}, {label: '.overlay', value: 'overlay'}, +{label: '.keymap', value: 'keymap'}, ]}> <TabItem value="conf"> @@ -272,6 +273,15 @@ For split keyboards, make sure to add left hand encoders to the left .overlay fi ::: </TabItem> +<TabItem value = "keymap"> +Add the following line to your keymap file to add default encoder behavior bindings: + +``` +sensor-bindings = <&inc_dec_cp M_VOLU M_VOLD>; +``` +Add additional bindings as necessary to match the default number of encoders on your board. See the [Encoders](/docs/feature/encoders) and [Keymap](/docs/feature/keymaps) feature documentation for more details. + +</TabItem> </Tabs> ## Testing |