feature: LED indicators #999

bortoz · 2021-10-23T20:52:53Z

This PR adds support for LED indicators, such as Caps Lock LED and Num Lock LED.

joelspadin · 2021-10-30T20:40:25Z

FYI, this seems to have some overlap with #904. It would be nice to make sure we don't end up with competing PWM LED systems.

bortoz · 2021-10-30T20:56:12Z

FYI, this seems to have some overlap with #904. It would be nice to make sure we don't end up with competing PWM LED systems.

LED indicators do not require PWM LEDs, you can use any LED driver supported by Zephyr. I added the PWM LED driver because the one in Zephyr 2.5 is not working properly but it is only a temporary solution until Zephyr is upgraded.

ci-bus · 2021-10-31T01:20:09Z

I think it would be better to do two prs, a pr to read the report and another for the implementations

bortoz · 2021-10-31T08:53:33Z

I think it would be better to do two prs, a pr to read the report and another for the implementations

Is there a particular reason for doing this?

ci-bus · 2021-11-04T15:02:13Z

I think it would be better to do two prs, a pr to read the report and another for the implementations

Is there a particular reason for doing this?

For two reasons, first so that this is faster and easier to do the code review and second because of what has been working in backlight, the implementation may change, in my design the caplock led is the last led of the underglow, is it possible configure it with your implementation?

bortoz · 2021-11-04T20:58:31Z

For two reasons, first so that this is faster and easier to do the code review and second because of what has been working in backlight, the implementation may change, in my design the caplock led is the last led of the underglow, is it possible configure it with your implementation?

This PR and backlight PR are independent of each other, you can use only one of them or both together without any problem. As I said earlier this PR does not depend on PWM LEDs, any LED driver can be used.

Regarding your behavior, I don't think it's achievable as the underglow API doesn't allow changing individual LEDs (and modifying those API is beyond the intentions of this PR). However the current implementation of LED indicators allows you to implement a custom behavior, you can find more details in the documentation.

petejohanson

A few initial thoughts. If you don't want to do this as two PRs, please at least split the code additions into two parts:

The generic state management and ties into USB and GATT HID systems.
The LED display handling of the new state.

That will make this way easier to review.

Thanks!

app/include/zmk/events/led_indicator_changed.h

app/src/hog.c

app/src/host.c

ReFil · 2022-02-22T21:10:41Z

Been testing this over the past little while, usb behaviour is flawless after i added a subscriber to update when it's connected to handle state changes whislt disconnected, although i'm having significant trouble getting it to work over BLE, tried windows mac and linux and i cannot make it work, have you got any suggestions?

bortoz · 2022-02-23T10:36:18Z

Been testing this over the past little while, usb behaviour is flawless after i added a subscriber to update when it's connected to handle state changes whislt disconnected, although i'm having significant trouble getting it to work over BLE, tried windows mac and linux and i cannot make it work, have you got any suggestions?

I'm not sure why it doesn't work, but I haven't had a lot of time in the past months to test it properly

ReFil · 2022-02-23T18:05:56Z

i've found the problem, it's that the source is not being set properly in your indexing function in led_indicators.c. i'd reccomend replacing the source index setup with what i've done here: ReFil@4733078 which i've been testing across multiple bluetooth profiles as well as usb

bortoz · 2022-02-23T20:44:12Z

i've found the problem, it's that the source is not being set properly in your indexing function in led_indicators.c. i'd reccomend replacing the source index setup with what i've done here: ReFil@4733078 which i've been testing across multiple bluetooth profiles as well as usb

Thanks! I will look into that

bortoz · 2022-02-24T14:19:12Z

@ReFil I made a lot of improvements, can you test the latest version?

ReFil · 2022-03-15T14:46:40Z

Spotted another bug, currently consumer reports dont write. the fix entailed changing

zmk/app/src/hog.c

Line 261 in 025bfd9

.attr = &hog_svc.attrs[10],

the size from 10 to 12

bortoz · 2022-03-15T15:30:52Z

Spotted another bug, currently consumer reports dont write. the fix entailed changing

Thank you! Fixed

petejohanson

A few questions.

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

app/dts/bindings/zmk,led-indicators.yaml

app/src/usb.c

petejohanson

@bortoz Thank you for your patience on this! One or two minor comments on the coding conventions, but otherwise this looks great. I'll get the HID tweaks in a PR right away to get that in, while you work on the couple other comments here.

petejohanson · 2023-11-08T21:42:11Z

app/include/zmk/hid_indicators_types.h

+
+#pragma once
+
+typedef uint8_t zmk_hid_indicators;


We usually follow the convention of using a _t suffix for types like these:

Suggested change

typedef uint8_t zmk_hid_indicators;

typedef uint8_t zmk_hid_indicators_t;

petejohanson · 2023-11-08T21:43:19Z

app/src/hid_indicators.c

+}
+
+zmk_hid_indicators zmk_hid_indicators_get_profile(struct zmk_endpoint_instance endpoint) {
+    int profile = zmk_endpoint_instance_to_index(endpoint);


Suggested change

int profile = zmk_endpoint_instance_to_index(endpoint);

const int profile = zmk_endpoint_instance_to_index(endpoint);

petejohanson · 2023-11-08T21:43:35Z

app/src/hid_indicators.c

+}
+
+static void raise_led_changed_event(struct k_work *_work) {
+    zmk_hid_indicators indicators = zmk_hid_indicators_get_current_profile();


Suggested change

zmk_hid_indicators indicators = zmk_hid_indicators_get_current_profile();

const zmk_hid_indicators indicators = zmk_hid_indicators_get_current_profile();

petejohanson · 2023-11-08T21:45:46Z

app/src/hid_indicators.c

+    uint8_t indicators = report->leds;
+    zmk_hid_indicators_set_profile(indicators, endpoint);


Suggested change

uint8_t indicators = report->leds;

zmk_hid_indicators_set_profile(indicators, endpoint);

zmk_hid_indicators_t indicators = (zmk_hid_indicators_t)report->leds;

zmk_hid_indicators_set_profile(indicators, endpoint);

petejohanson · 2023-11-08T21:53:30Z

app/include/zmk/hid.h

+#define HID_REPORT_ID_KEYBOARD 0x01
+#define HID_REPORT_ID_LEDS 0x01
+#define HID_REPORT_ID_CONSUMER 0x02


I missed you had added these here. I had rolled a similar tweak into #1991 with different naming conventions. Let me pull that out into a small refactor PR (where it should be anyways, and we can then build on it for this and that PR as well.

petejohanson · 2023-11-08T22:20:54Z

@bortoz See #1993 for the small hid.h refactor.

petejohanson · 2023-11-10T04:54:28Z

app/src/split/bluetooth/central.c

+        int err = bt_gatt_write_without_response(peripherals[i].conn,
+                                                 peripherals[i].update_hid_indicators, &indicators,
+                                                 sizeof(indicators), true);


See chrisandreae@bc824de from the MoErgo folks for a small safety check that would be good here, if this gets called mid-attribute discovery.

bryanforbes · 2023-11-17T16:44:27Z

app/CMakeLists.txt

@@ -37,6 +37,8 @@ target_sources(app PRIVATE src/behaviors/behavior_reset.c)
 target_sources_ifdef(CONFIG_ZMK_EXT_POWER app PRIVATE src/behaviors/behavior_ext_power.c)
 if ((NOT CONFIG_ZMK_SPLIT) OR CONFIG_ZMK_SPLIT_ROLE_CENTRAL)
  target_sources(app PRIVATE src/hid.c)
+  target_sources_ifdef(CONFIG_ZMK_USB app PRIVATE src/usb_hid.c)


This is no longer needed after #2006 was merged since CONFIG_ZMK_USB now depends on the if condition

petejohanson · 2023-11-28T00:05:19Z

@bortoz Thank you so much for the work on this! I've merged #2041 just now that includes all your core work with the minor changes/additions as noted there. I am truly sad this has taken so long, and I appreciate your persistence in sticking with this. I'm hoping we can build out various status/display bits on top of this now that the core has been merged.

❤️

bortoz force-pushed the led-indicators branch from 4b320f5 to 67cc21d Compare October 24, 2021 08:58

bortoz mentioned this pull request Oct 24, 2021

Feature/usb report leds #899

Closed

bortoz force-pushed the led-indicators branch from 67cc21d to dc29c52 Compare January 8, 2022 22:20

petejohanson requested changes Jan 31, 2022

View reviewed changes

app/include/zmk/events/led_indicator_changed.h Outdated Show resolved Hide resolved

app/src/hog.c Outdated Show resolved Hide resolved

app/src/host.c Outdated Show resolved Hide resolved

app/src/host.c Outdated Show resolved Hide resolved

bortoz force-pushed the led-indicators branch 5 times, most recently from 1e33ee7 to bd722f5 Compare February 24, 2022 13:56

bortoz force-pushed the led-indicators branch from bd722f5 to 025bfd9 Compare February 24, 2022 15:17

bortoz force-pushed the led-indicators branch from 025bfd9 to a143149 Compare March 15, 2022 15:29

bortoz requested a review from petejohanson March 15, 2022 15:33

bortoz force-pushed the led-indicators branch from a143149 to dcf1f1a Compare April 3, 2022 09:48

petejohanson reviewed Apr 5, 2022

View reviewed changes

app/include/dt-bindings/zmk/led_indicators.h Outdated Show resolved Hide resolved

app/dts/bindings/zmk,led-indicators.yaml Outdated Show resolved Hide resolved

bortoz force-pushed the led-indicators branch from dcf1f1a to 9fa31f6 Compare April 5, 2022 08:34

petejohanson reviewed Apr 5, 2022

View reviewed changes

app/src/usb.c Outdated Show resolved Hide resolved

bortoz force-pushed the led-indicators branch from 9fa31f6 to e4cc077 Compare April 7, 2022 09:32

bortoz force-pushed the led-indicators branch 9 times, most recently from ffb70a5 to ef49dff Compare April 16, 2023 16:57

bortoz force-pushed the led-indicators branch 3 times, most recently from 1065491 to d27698f Compare May 16, 2023 06:49

chrisandreae added a commit to moergo-sc/zmk that referenced this pull request Jun 27, 2023

Patch for zmkfirmware#999: remove stray whitespace in CMakeLists

7f541c2

bortoz force-pushed the led-indicators branch from d27698f to 433a402 Compare July 6, 2023 21:43

bortoz requested a review from a team as a code owner July 6, 2023 21:43

bryanforbes pushed a commit to bryanforbes/zmk that referenced this pull request Aug 9, 2023

Patch for zmkfirmware#999: remove stray whitespace in CMakeLists

1c08801

bortoz added 2 commits October 31, 2023 14:57

feat: handle LED indicators report

d7f6ca2

feat: LED indicators on peripheral side

1a03479

bortoz force-pushed the led-indicators branch from 433a402 to 1a03479 Compare October 31, 2023 15:27

petejohanson self-assigned this Nov 8, 2023

petejohanson added enhancement New feature or request core Core functionality/behavior of ZMK labels Nov 8, 2023

petejohanson requested changes Nov 8, 2023

View reviewed changes

petejohanson reviewed Nov 10, 2023

View reviewed changes

bryanforbes reviewed Nov 17, 2023

View reviewed changes

petejohanson mentioned this pull request Nov 27, 2023

LED Indicators (bortoz work with minor fixes) #2041

Merged

petejohanson closed this Nov 28, 2023

nVitius mentioned this pull request Jul 1, 2024

feat(underglow): support command for displaying board statuses #2353

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: LED indicators #999

feature: LED indicators #999

bortoz commented Oct 23, 2021

joelspadin commented Oct 30, 2021

bortoz commented Oct 30, 2021

ci-bus commented Oct 31, 2021

bortoz commented Oct 31, 2021

ci-bus commented Nov 4, 2021

bortoz commented Nov 4, 2021 •

edited

Loading

petejohanson left a comment

ReFil commented Feb 22, 2022

bortoz commented Feb 23, 2022

ReFil commented Feb 23, 2022

bortoz commented Feb 23, 2022

bortoz commented Feb 24, 2022

ReFil commented Mar 15, 2022

bortoz commented Mar 15, 2022

petejohanson left a comment

petejohanson left a comment

petejohanson Nov 8, 2023

petejohanson Nov 8, 2023

petejohanson Nov 8, 2023

petejohanson Nov 8, 2023

petejohanson Nov 8, 2023

petejohanson commented Nov 8, 2023

petejohanson Nov 10, 2023

bryanforbes Nov 17, 2023

petejohanson commented Nov 28, 2023

	typedef uint8_t zmk_hid_indicators;
	typedef uint8_t zmk_hid_indicators_t;

	int profile = zmk_endpoint_instance_to_index(endpoint);
	const int profile = zmk_endpoint_instance_to_index(endpoint);

	zmk_hid_indicators indicators = zmk_hid_indicators_get_current_profile();
	const zmk_hid_indicators indicators = zmk_hid_indicators_get_current_profile();

		uint8_t indicators = report->leds;
		zmk_hid_indicators_set_profile(indicators, endpoint);

feature: LED indicators #999

feature: LED indicators #999

Conversation

bortoz commented Oct 23, 2021

joelspadin commented Oct 30, 2021

bortoz commented Oct 30, 2021

ci-bus commented Oct 31, 2021

bortoz commented Oct 31, 2021

ci-bus commented Nov 4, 2021

bortoz commented Nov 4, 2021 • edited Loading

petejohanson left a comment

Choose a reason for hiding this comment

ReFil commented Feb 22, 2022

bortoz commented Feb 23, 2022

ReFil commented Feb 23, 2022

bortoz commented Feb 23, 2022

bortoz commented Feb 24, 2022

ReFil commented Mar 15, 2022

bortoz commented Mar 15, 2022

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson Nov 8, 2023

Choose a reason for hiding this comment

petejohanson Nov 8, 2023

Choose a reason for hiding this comment

petejohanson Nov 8, 2023

Choose a reason for hiding this comment

petejohanson Nov 8, 2023

Choose a reason for hiding this comment

petejohanson Nov 8, 2023

Choose a reason for hiding this comment

petejohanson commented Nov 8, 2023

petejohanson Nov 10, 2023

Choose a reason for hiding this comment

bryanforbes Nov 17, 2023

Choose a reason for hiding this comment

petejohanson commented Nov 28, 2023

bortoz commented Nov 4, 2021 •

edited

Loading