Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): Update backlight docs #1894

Merged
merged 9 commits into from
Dec 4, 2023
Merged

fix(docs): Update backlight docs #1894

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a35b6ec
fix(docs): Update backlight docs
ReFil Aug 8, 2023
1e092ff
Apply suggestions from code review
ReFil Aug 15, 2023
ca80494
Improve port/pin docs, fix punctuation
ReFil Aug 15, 2023
3baddc3
Fix(docs): corrections
ReFil Aug 23, 2023
a164685
Apply suggestions from code review
ReFil Sep 2, 2023
b89bf69
Update backlight.md
ReFil Oct 3, 2023
0f565ac
Remove non-pinctrl configuration options
ReFil Nov 20, 2023
93cbdc4
Apply suggestions from code review
ReFil Dec 3, 2023
99417b0
Apply suggestions from code review
ReFil Dec 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com>
  • Loading branch information
@ReFil @lesshonor
ReFil and lesshonor authored Dec 3, 2023
commit 99417b0e5ca2b420ef489db7204770740b58077f
2 changes: 1 addition & 1 deletion docs/docs/features/backlight.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ config LED_PWM
endif # ZMK_BACKLIGHT
```

When using the pinctrl API you should create a pinctrl.dtsi file if it's not created already, and include it at the beginning of the `board.dts` file. You also need to add `CONFIG_PINCTRL=y` to board_defconfig if it's not already enabled. To use some of the definitions for the PWM node you need to include `#include <dt-bindings/led/led.h>` at the beginning of the `board.dts` file.
Create a `<board>-pinctrl.dtsi` file if it does not already exist, and include it at the beginning of the `<board>.dts` file. `CONFIG_PINCTRL=y` must be added to to `<board>_defconfig` if it isn't already enabled.

The pinctrl file has a `&pinctrl` node that encompasses all pinctrl settings, including I2C or SPI peripherals (e.g. WS2812 LEDs, Battery fuel gauges):

Expand Down