tgrosinger/zmk
1
0
Fork 0
Code Actions Packages

fix(docs): detail overriding the led_strip chain-length property

Browse Source 
Quite a few people have struggled with setting the correct
`chain-length` for their `led_strip`. For some, this is their first time
needing to change a pre-defined devicetree property, and so they aren't
familiar with the technique. I commonly see folks adding a duplicate of
the entire `*.overlay` file with only the `chain-length` value changed.
Having clear documentation for this specific application of the property
override technique could help forestall these problems, and give those
of us helping out in Discord something to easily reference.
This commit is contained in:
Seth Milliken 2023-08-08 15:12:46 -07:00 committed by Cem Aksoylar
parent d17c473d45
commit c957348e61
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/features/underglow.md
View File

@ -39,6 +39,20 @@ use Kconfig.
If your board or shield does not have RGB underglow configured, refer to [Adding RGB Underglow to a Board](#adding-rgb-underglow-to-a-board).
### Modifying the number of LEDs
A common issue when enabling underglow is that some of the installed LEDs do not illuminate. This can happen when a board's default underglow configuration accounts only for either the downward facing LEDs or the upward facing LEDs under each key. On a split keyboard, a good sign that this may be the problem is that the unilluminated LEDs on each half are symmetrical.
The number of underglow LEDs is controlled by the `chain-length` property in the `led_strip` node. You can [change the value of this property](../config/index.md#changing-devicetree-properties) in the `<keyboard>.keymap` file by adding a stanza like this one outside of any other node (i.e. above or below the `/` node):
```
&led_strip {
chain-length = <21>;
};
```
where the value is the total count of LEDs (per half, for split keyboards).
## Configuring RGB Underglow
See [RGB underglow configuration](/docs/config/underglow).