Feature backlight #904

bortoz · 2021-08-09T17:20:32Z

This PR adds support for single color LED backlighting. The current implementation supports basic behaviors, such as increase/decrease brightness and toggle on/off.

I also added some useful configurations to increase power efficiency such as turning off the backlight when the USB is disconnected or when the board goes into idle state.

Finally I updated the documentation and the power profiler with the new changes.

Nicell

Nice job on this @bortoz, clean implementation of the feature. Here are some initial changes/thoughts on this 👍

app/Kconfig

docs/src/components/power-estimate.js

app/src/backlight.c

docs/docs/features/backlight.md

bortoz · 2021-08-10T09:53:02Z

@Nicell I have updated the code based on your comments.

Nicell

A few more things I noticed. Excited to get this added to ZMK. Thanks for the quick update on this.

docs/src/data/power.js

docs/src/pages/power-profiler.js

docs/src/data/power.js

docs/src/pages/power-profiler.js

app/src/backlight.c

docs/docs/features/backlight.md

htang014 · 2021-08-10T21:37:14Z

FWIW, I built your fork to my board, works like a charm

bortoz · 2021-08-11T06:28:47Z

Thanks for your feedback @htang014!

Nicell

Two small link changes (#911 related) and a merge conflict fix. Otherwise, this all looks good to me. I'd like to have one more set of eyes over it before a merge though.

docs/docs/features/backlight.md

docs/docs/intro.md

joelspadin

I think there may be some off by one errors in the brightness level configs and/or calculations.

Also, check that ZMK_BACKLIGHT_USB works. I might be missing something, but it looks like the current code won't compile with that option enabled.

app/Kconfig

app/include/dt-bindings/zmk/bl.h

app/src/backlight.c

app/src/behaviors/behavior_backlight.c

joelspadin · 2021-08-13T01:20:50Z

app/src/behaviors/behavior_backlight.c

+
+static int on_keymap_binding_released(struct zmk_behavior_binding *binding,
+ struct zmk_behavior_binding_event event) {
+ return ZMK_BEHAVIOR_OPAQUE;


Not something to change in this commit, but it seems a bit silly that we require a released callback for behaviors that only do something on press.

@petejohanson maybe we could change z_impl_behavior_keymap_binding_released so it returns ZMK_BEHAVIOR_OPAQUE instead of -ENOTSUP if no release callback is set?

I think perhaps returning that is still valid, but the keymap code could better handle that errno specifically.

docs/docs/behaviors/lighting.md

docs/docs/features/backlight.md

bortoz · 2022-01-06T22:36:51Z

@petejohanson I made a PR: zmkfirmware/zephyr#7

petejohanson

On a whole, this looks great!

A few minor comments.

app/src/backlight.c

petejohanson · 2022-01-08T04:36:15Z

app/src/behaviors/behavior_backlight.c

+
+static int on_keymap_binding_released(struct zmk_behavior_binding *binding,
+ struct zmk_behavior_binding_event event) {
+ return ZMK_BEHAVIOR_OPAQUE;


I think perhaps returning that is still valid, but the keymap code could better handle that errno specifically.

app/west.yml

docs/docs/features/backlight.md

petejohanson

A few minor follow up thoughts. Thanks again!

I'll have test hardware for this soon.

app/dts/behaviors/backlight.dtsi

petejohanson · 2022-01-20T04:53:09Z

docs/docs/features/backlight.md

+Backlight is always added to a board, not a shield.
+If you have a shield with backlight, you must add a `boards/` directory within your shield folder to define the backlight individually for each board that supports the shield.
+Inside the `boards/` folder, you define a `<board>.overlay` for each different board.


Thinking about this more, since we have the GPIO backed driver available that should be board agnostic, I wonder if we should be documenting and suggesting:

Add GPIO backlight nodes/compatibles to shields.

For tested boards used w/ the shield, add a shield/foo/boards/bar.overlay to override and add the board-specific PWM nodes.

Doing so will ensure a shield would have reasonable "fallback" backlight on some new board used w/ a given shield.

Thoughts?

I think it's a good idea

Added a note about that

ReFil · 2022-01-20T12:23:57Z

A few minor follow up thoughts. Thanks again!

I'll have test hardware for this soon.

Hi Pete, we can send you one of our boards equipped for this backlighting stuff if you want

petejohanson · 2022-01-20T13:02:07Z

A few minor follow up thoughts. Thanks again!

I'll have test hardware for this soon.

Hi Pete, we can send you one of our boards equipped for this backlighting stuff if you want

I actually snagged a revlp recently so that:

I have a non-split for testing non-wireless controllers like kb2040
Has backlighting!

I have the resistors en route right now so I can solder the final piece and test this.

Thanks though!

petejohanson

Few follow up thoughts, tested this and it works great!

docs/docs/features/backlight.md

bortoz · 2022-01-31T10:26:18Z

Rebased to resolve a conflict

petejohanson

Thanks so much for your work on this!

bortoz force-pushed the backlight branch from 2f05584 to 054e349 Compare August 9, 2021 18:35

Nicell reviewed Aug 9, 2021

View reviewed changes

bortoz force-pushed the backlight branch from 2be9af5 to 15ab1fe Compare August 10, 2021 10:00

bortoz requested a review from Nicell August 10, 2021 18:31

Nicell reviewed Aug 10, 2021

View reviewed changes

docs/src/data/power.js Show resolved Hide resolved

docs/src/pages/power-profiler.js Outdated Show resolved Hide resolved

docs/src/data/power.js Outdated Show resolved Hide resolved

docs/src/pages/power-profiler.js Outdated Show resolved Hide resolved

Nicell added core Core functionality/behavior of ZMK enhancement New feature or request lighting labels Aug 10, 2021

Nicell reviewed Aug 10, 2021

View reviewed changes

app/src/backlight.c Show resolved Hide resolved

Nicell reviewed Aug 10, 2021

View reviewed changes

docs/docs/features/backlight.md Show resolved Hide resolved

bortoz force-pushed the backlight branch 2 times, most recently from 35a0a93 to e5c4e3a Compare August 11, 2021 08:38

bortoz requested a review from Nicell August 11, 2021 09:43

bortoz force-pushed the backlight branch 2 times, most recently from 93d5fcb to 8de01ce Compare August 11, 2021 16:56

Nicell requested review from joelspadin and petejohanson August 12, 2021 03:52

bortoz force-pushed the backlight branch from 8de01ce to 9976f44 Compare August 12, 2021 18:34

Nicell reviewed Aug 13, 2021

View reviewed changes

docs/docs/features/backlight.md Outdated Show resolved Hide resolved

docs/docs/intro.md Outdated Show resolved Hide resolved

joelspadin requested changes Aug 13, 2021

View reviewed changes

bortoz force-pushed the backlight branch 7 times, most recently from 315b21a to b4f8773 Compare August 14, 2021 14:05

bortoz force-pushed the backlight branch 2 times, most recently from 24a22b0 to d83f220 Compare January 7, 2022 13:15

petejohanson requested changes Jan 8, 2022

View reviewed changes

bortoz force-pushed the backlight branch 3 times, most recently from 1fbe79e to 05013ec Compare January 10, 2022 08:41

bortoz requested a review from petejohanson January 10, 2022 21:50

petejohanson requested changes Jan 20, 2022

View reviewed changes

bortoz force-pushed the backlight branch 2 times, most recently from 3291ae9 to 06d6daa Compare January 22, 2022 10:58

petejohanson requested changes Jan 26, 2022

View reviewed changes

docs/docs/features/backlight.md Outdated Show resolved Hide resolved

docs/docs/features/backlight.md Outdated Show resolved Hide resolved

bortoz and others added 7 commits January 31, 2022 11:19

feat(lighting): add backlight behavior

5a06363

feat(docs): add backlight documentation

6bd29ae

feat(docs): add backlight to power profiler

f1ab1db

feat(backlight): initial split support

d50e887

refactor(backlight): code cleanup

83ce5c7

feat(backlight): add tests

70c07f5

feat(backlight): add command to cycle brightness

8e3cde4

bortoz force-pushed the backlight branch 2 times, most recently from a3fc437 to 7efbd98 Compare January 31, 2022 10:25

berfarah mentioned this pull request Feb 3, 2022

Feature: Add setting to only allow external power while on USB power #1113

Open

3 tasks

docs(backlight): improve documentation

7cdbb78

bortoz force-pushed the backlight branch from 7efbd98 to 7cdbb78 Compare February 4, 2022 17:09

petejohanson approved these changes Feb 6, 2022

View reviewed changes

petejohanson merged commit be94e04 into zmkfirmware:main Feb 6, 2022

bortoz deleted the backlight branch February 6, 2022 08:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature backlight #904

Feature backlight #904

bortoz commented Aug 9, 2021 •

edited

Loading

Nicell left a comment

bortoz commented Aug 10, 2021

Nicell left a comment

htang014 commented Aug 10, 2021

bortoz commented Aug 11, 2021

Nicell left a comment

joelspadin left a comment

joelspadin Aug 13, 2021

petejohanson Jan 8, 2022

bortoz commented Jan 6, 2022

petejohanson left a comment

petejohanson Jan 8, 2022

petejohanson left a comment

petejohanson Jan 20, 2022

bortoz Jan 21, 2022

bortoz Jan 21, 2022

ReFil commented Jan 20, 2022

petejohanson commented Jan 20, 2022

petejohanson left a comment

bortoz commented Jan 31, 2022

petejohanson left a comment

Feature backlight #904

Feature backlight #904

Conversation

bortoz commented Aug 9, 2021 • edited Loading

Nicell left a comment

Choose a reason for hiding this comment

bortoz commented Aug 10, 2021

Nicell left a comment

Choose a reason for hiding this comment

htang014 commented Aug 10, 2021

bortoz commented Aug 11, 2021

Nicell left a comment

Choose a reason for hiding this comment

joelspadin left a comment

Choose a reason for hiding this comment

joelspadin Aug 13, 2021

Choose a reason for hiding this comment

petejohanson Jan 8, 2022

Choose a reason for hiding this comment

bortoz commented Jan 6, 2022

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson Jan 8, 2022

Choose a reason for hiding this comment

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson Jan 20, 2022

Choose a reason for hiding this comment

bortoz Jan 21, 2022

Choose a reason for hiding this comment

bortoz Jan 21, 2022

Choose a reason for hiding this comment

ReFil commented Jan 20, 2022

petejohanson commented Jan 20, 2022

petejohanson left a comment

Choose a reason for hiding this comment

bortoz commented Jan 31, 2022

petejohanson left a comment

Choose a reason for hiding this comment

bortoz commented Aug 9, 2021 •

edited

Loading