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.

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

Applications: nrf_desktop: Add subscriber event #13451

Merged
merged 3 commits into from
Dec 28, 2023

Conversation

KAGA164
Copy link
Contributor

@KAGA164 KAGA164 commented Dec 15, 2023

This PR adds new HID subscriber events which allows to connect different transports for HIDs report data.

@github-actions github-actions bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Dec 15, 2023
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Dec 15, 2023

Test specification

CI/Jenkins/NRF

  • Integration Platforms

CI/Jenkins/integration

Test Module File based changes Manually selected West overwrite
desktop52_verification X

Detailed information of selected test modules

Note: This message is automatically posted and updated by the CI

@KAGA164 KAGA164 removed doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Dec 15, 2023
Copy link
Contributor

@MarekPieta MarekPieta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add release note for application, please (changelog)

applications/nrf_desktop/src/modules/hid_state.c Outdated Show resolved Hide resolved
applications/nrf_desktop/src/modules/hid_state.c Outdated Show resolved Hide resolved
applications/nrf_desktop/src/modules/usb_state.c Outdated Show resolved Hide resolved
applications/nrf_desktop/src/modules/hids.c Outdated Show resolved Hide resolved
applications/nrf_desktop/src/modules/hids.c Outdated Show resolved Hide resolved
@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Dec 15, 2023
@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

applications/nrf_desktop/src/events/hid_event.c Outdated Show resolved Hide resolved
applications/nrf_desktop/src/events/hid_event.h Outdated Show resolved Hide resolved
applications/nrf_desktop/src/modules/hid_state.c Outdated Show resolved Hide resolved
applications/nrf_desktop/src/modules/hid_state.c Outdated Show resolved Hide resolved
@@ -823,7 +823,9 @@ nRF Desktop event propagation
+-----------------------------------------------+-----------------------------------+ | | |
| :ref:`nrf_desktop_motion` | ``motion_event`` | | | |
+-----------------------------------------------+-----------------------------------+ | | |
| :ref:`nrf_desktop_usb_state` | ``usb_hid_event`` | | | |
| :ref:`nrf_desktop_hids` | ``hid_report_subscriber_event`` | | | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please align with the updated arrays that were generated by me locally using a script (to keep consistency): https://github.com/MarekPieta/fw-nrfconnect-nrf/tree/kaga_new_arrays

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you updated the arrays ?

applications/nrf_desktop/src/modules/Kconfig.hids Outdated Show resolved Hide resolved
applications/nrf_desktop/src/modules/hids.c Outdated Show resolved Hide resolved
@KAGA164 KAGA164 force-pushed the nrf_desktop_subscriber_event branch 2 times, most recently from 10ed9a5 to 0d33db3 Compare December 19, 2023 13:50
applications/nrf_desktop/src/modules/hid_state.c Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/hid_state.rst Outdated Show resolved Hide resolved
uint8_t report_max; /**< Maximum number of reports with different ID, which can be
* processed.
*/
} params; /**< Subscriber parameters. Only needed when a subscriber is connecting.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it wouldn't be better to fill the parameter in both cases or zero them (to avoid submitting event with garbage data)

applications/nrf_desktop/src/modules/hids.c Outdated Show resolved Hide resolved
@@ -823,7 +823,9 @@ nRF Desktop event propagation
+-----------------------------------------------+-----------------------------------+ | | |
| :ref:`nrf_desktop_motion` | ``motion_event`` | | | |
+-----------------------------------------------+-----------------------------------+ | | |
| :ref:`nrf_desktop_usb_state` | ``usb_hid_event`` | | | |
| :ref:`nrf_desktop_hids` | ``hid_report_subscriber_event`` | | | |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you updated the arrays ?

This adds HIDs subscriber event which allows
different transports with configurable prority
and pipeline size subscibe to the HIDs reports.

Jira: NCSDK-25088

Signed-off-by: Kamil Gawor <[email protected]>
applications/nrf_desktop/doc/hid_state.rst Outdated Show resolved Hide resolved
Update information about events generated or
processed by the given nrf_desktop modules.
This updates also the application documentation.

Jira: NCSDK-24644

Signed-off-by: Kamil Gawor <[email protected]>
Update changelog with new HID subscriber event in
nRF Desktop application.

Jira: NCSDK-24644

Signed-off-by: Kamil Gawor <[email protected]>
@cvinayak cvinayak merged commit abc7316 into nrfconnect:main Dec 28, 2023
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants