You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The documentation simplifies using custom HID providers. Change also
adds a link to the newly introduced section from the HID configuration
documentation.
Jira: NCSDK-35005
Signed-off-by: Marek Pieta <[email protected]>
Signed-off-by: Pekka Niskanen <[email protected]>
Copy file name to clipboardExpand all lines: applications/nrf_desktop/doc/hid_state.rst
+32Lines changed: 32 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -175,6 +175,38 @@ The following application modules are used as default implementations of HID rep
175
175
The respective HID report provider is automatically enabled if support for a given HID input report is enabled in the :ref:`nrf_desktop_hid_configuration`.
176
176
See the documentation page of a HID report provider for detailed information about the provider.
177
177
178
+
Custom HID providers
179
+
--------------------
180
+
181
+
You can implement your own HID report provider as part of the application.
182
+
The HID report provider can perform one of the following two actions:
183
+
184
+
* Handle a HID input report that is already supported by the application instead of a default HID report provider (substitute the default HID report provider).
185
+
Make sure to disable the default HID report provider while implementing the custom provider.
186
+
* Support a new HID input report.
187
+
188
+
HID report map update
189
+
~~~~~~~~~~~~~~~~~~~~~
190
+
191
+
If your HID report provider implementation uses a different HID input report format or you add a new HID input report, you need to align the HID report configuration (including the HID report map).
192
+
If the default HID report descriptor is used (:ref:`CONFIG_DESKTOP_USE_DEFAULT_REPORT_DESCR <config_desktop_app_options>`), the configuration is defined by the following files:
193
+
194
+
* :file:`configuration/common/hid_report_desc.h`
195
+
* :file:`configuration/common/hid_report_desc.c`
196
+
197
+
.. note::
198
+
nRF Desktop dongles share a common HID report format with the nRF Desktop peripherals.
199
+
The aligned HID report configuration is required for the dongle to forward HID input reports from the peripherals.
200
+
201
+
HID transport update
202
+
~~~~~~~~~~~~~~~~~~~~
203
+
204
+
If you add a new HID input report, you might also need to update the modules that act as HID transports (for example :ref:`nrf_desktop_hids` or :ref:`nrf_desktop_usb_state`).
205
+
This is needed to fulfill the following requirements:
206
+
207
+
* Proper configuration of the module and libraries used by the module.
0 commit comments