feat: only send HID reports to one endpoint #269

joelspadin · 2020-10-11T22:11:22Z

Fixes #206.

By default reports are sent to USB if both USB and BLE are connected. This also adds a new endpoints behavior to switch between sending to USB or BLE in that case.

joelspadin · 2020-10-24T23:05:48Z

app/src/ble.c

@@ -163,9 +169,9 @@ int update_advertising() {
    struct bt_conn *conn;
    enum advertising_type desired_adv = ZMK_ADV_NONE;

-    if (active_profile_is_open() || !active_profile_is_connected()) {
+    if (active_profile_is_open() || !zmk_ble_active_profile_is_connected()) {


Was the !active_profile_is_connected() intended here. It looks like that makes the else if case below dead code.

Yeah, this was here due to me playing w/ the directed advertising. I think this can be removed and allow the below else if block handle the situation properly.

joelspadin · 2020-10-24T23:06:39Z

app/src/endpoints.c

+
+static int zmk_endpoints_init(struct device *_arg) {
+#if IS_ENABLED(CONFIG_SETTINGS)
+    settings_subsys_init();


This seems a bit redundant with the code in settings.c and ble.c. Is there a better way to do this?

This is redundant, but the method properly handles being called multiple times and exits early. We can leave for now, until we have a more nuanced settings load order handling

petejohanson

A few comments. Are the changes to docs/package-lock.json really required?

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

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

petejohanson · 2020-10-27T19:25:26Z

app/src/ble.c

@@ -163,9 +169,9 @@ int update_advertising() {
    struct bt_conn *conn;
    enum advertising_type desired_adv = ZMK_ADV_NONE;

-    if (active_profile_is_open() || !active_profile_is_connected()) {
+    if (active_profile_is_open() || !zmk_ble_active_profile_is_connected()) {


Yeah, this was here due to me playing w/ the directed advertising. I think this can be removed and allow the below else if block handle the situation properly.

joelspadin · 2020-10-28T23:07:31Z

A few comments. Are the changes to docs/package-lock.json really required?

Nope. I wasn't intending to change that and probably just accidentally included it.

Added some utility functions and an event for tracking the state of the USB connection. Updated endpoints.c to select a single endpoint to send HID reports to based on the status of the USB and BLE connections. Partially fixes zmkfirmware#206. Future commits will add a user setting to control which endpoint is used if both USB and BLE are ready.

This prevents stuck keys when switching endpoints by clearing everything in the HID report and sending one last report before switching to the new endpoint.

Added zmk_ble_active_profile_is_connected() to allow code outside ble.c to check the status of the active profile, and changed the ble_active_profile_changed event to also notify when the active profile connects or disconnects. Changed endpoint selection to to also update when the active profile changes, connects, or disconnects.

Added a new setting to remember the user's preferred endpoint. When both USB and BLE are connected, the preferred endpoint will be used. Added a new behavior to control this setting. It supports commands: &end END_USB - Prefer USB output &end END_BLE - Prefer BLE output &end END_TOG - Toggle between USB and BLE

"Outputs" is probably easier for most people to understand than "endpoints".

joelspadin · 2020-10-28T23:39:40Z

Tested using a nice!nano, and Windows (USB and BLE), and an Android phone (BLE only).

(I don't really see any good way to unit test this unless you have a way to simulate different endpoints.)

adamcstephens · 2020-10-29T20:47:31Z

This works as I'd expect. I'm able to send to USB and BLE separately as toggled while remaining plugged in.

petejohanson

Love it! Thanks

petejohanson · 2020-10-31T04:08:36Z

app/src/endpoints.c

+
+static int zmk_endpoints_init(struct device *_arg) {
+#if IS_ENABLED(CONFIG_SETTINGS)
+    settings_subsys_init();


This is redundant, but the method properly handles being called multiple times and exits early. We can leave for now, until we have a more nuanced settings load order handling

joelspadin · 2020-10-31T15:44:44Z

You're welcome!

Fixes zmkfirmware#269

Fixes #269

Fixes zmkfirmware#269

feat: only send HID reports to one endpoint

Fixes zmkfirmware#269

feat: only send HID reports to one endpoint

Fixes zmkfirmware#269

joelspadin force-pushed the endpoint-selection branch from 33569be to d4e2208 Compare October 11, 2020 22:20

innovaker added behaviors bluetooth Bluetooth related items core Core functionality/behavior of ZMK enhancement New feature or request hid usb labels Oct 11, 2020

joelspadin force-pushed the endpoint-selection branch 2 times, most recently from e8f77b4 to 3ec5837 Compare October 11, 2020 23:41

joelspadin force-pushed the endpoint-selection branch 2 times, most recently from d623f0e to 8839b56 Compare October 24, 2020 22:56

joelspadin marked this pull request as ready for review October 24, 2020 23:04

joelspadin commented Oct 24, 2020

View reviewed changes

petejohanson reviewed Oct 27, 2020

View reviewed changes

joelspadin added 7 commits October 28, 2020 18:15

feat(endpoints): clear HID report on endpoint change

8f666ce

This prevents stuck keys when switching endpoints by clearing everything in the HID report and sending one last report before switching to the new endpoint.

feat(endpoints): rename behavior to outputs

2fe1fbb

"Outputs" is probably easier for most people to understand than "endpoints".

feat(endpoints): simplify behavior constants

440d09f

feat(endpoints): remove redundant connection check

821f054

joelspadin force-pushed the endpoint-selection branch from f276815 to 821f054 Compare October 28, 2020 23:22

petejohanson added the hacktoberfest-accepted label Oct 30, 2020

petejohanson approved these changes Oct 31, 2020

View reviewed changes

petejohanson merged commit 2d31e1d into zmkfirmware:main Oct 31, 2020

innovaker added a commit to innovaker/zmk that referenced this pull request Oct 31, 2020

docs(outputs): run prettier on outputs.md

ceec450

Fixes zmkfirmware#269

innovaker mentioned this pull request Oct 31, 2020

docs(outputs): run prettier on outputs.md #317

Merged

petejohanson pushed a commit that referenced this pull request Oct 31, 2020

docs(outputs): run prettier on outputs.md (#317)

4672a0c

Fixes #269

innovaker mentioned this pull request Oct 31, 2020

feat: HID Usages + Keys Standardisation #236

Merged

innovaker added a commit to innovaker/zmk that referenced this pull request Nov 2, 2020

docs(outputs): run prettier on outputs.md (zmkfirmware#317)

405efc7

Fixes zmkfirmware#269

MangoIV pushed a commit to MangoIV/zmk that referenced this pull request Dec 18, 2020

Merge pull request zmkfirmware#269 from joelspadin/endpoint-selection

b9c197c

feat: only send HID reports to one endpoint

MangoIV pushed a commit to MangoIV/zmk that referenced this pull request Dec 18, 2020

docs(outputs): run prettier on outputs.md (zmkfirmware#317)

7ade783

Fixes zmkfirmware#269

snyk-bot mentioned this pull request Oct 5, 2022

[Snyk] Upgrade classnames from 2.3.1 to 2.3.2 terrorizer1980/zmk#5

Open

tyalie pushed a commit to tyalie/zmk that referenced this pull request Nov 15, 2022

Merge pull request zmkfirmware#269 from joelspadin/endpoint-selection

9a5c32a

feat: only send HID reports to one endpoint

tyalie pushed a commit to tyalie/zmk that referenced this pull request Nov 15, 2022

docs(outputs): run prettier on outputs.md (zmkfirmware#317)

64556d9

Fixes zmkfirmware#269

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: only send HID reports to one endpoint #269

feat: only send HID reports to one endpoint #269

joelspadin commented Oct 11, 2020 •

edited

joelspadin Oct 24, 2020

petejohanson Oct 27, 2020

joelspadin Oct 24, 2020

petejohanson Oct 31, 2020

petejohanson left a comment

petejohanson Oct 27, 2020

joelspadin commented Oct 28, 2020

joelspadin commented Oct 28, 2020

adamcstephens commented Oct 29, 2020

petejohanson left a comment

petejohanson Oct 31, 2020

joelspadin commented Oct 31, 2020

feat: only send HID reports to one endpoint #269

feat: only send HID reports to one endpoint #269

Conversation

joelspadin commented Oct 11, 2020 • edited

joelspadin Oct 24, 2020

Choose a reason for hiding this comment

petejohanson Oct 27, 2020

Choose a reason for hiding this comment

joelspadin Oct 24, 2020

Choose a reason for hiding this comment

petejohanson Oct 31, 2020

Choose a reason for hiding this comment

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson Oct 27, 2020

Choose a reason for hiding this comment

joelspadin commented Oct 28, 2020

joelspadin commented Oct 28, 2020

adamcstephens commented Oct 29, 2020

petejohanson left a comment

Choose a reason for hiding this comment

petejohanson Oct 31, 2020

Choose a reason for hiding this comment

joelspadin commented Oct 31, 2020

joelspadin commented Oct 11, 2020 •

edited