Skip to content

Commit 071873b

Browse files
MarekPietarlubos
authored andcommitted
applications: nrf_desktop: Align HID articles
Change aligns the used HID articles. Jira: NCSDK-22789 Signed-off-by: Marek Pieta <[email protected]>
1 parent 00859bb commit 071873b

File tree

6 files changed

+6
-6
lines changed

6 files changed

+6
-6
lines changed

applications/nrf_desktop/doc/ble_conn_params.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Configuration
2929
The module requires the basic Bluetooth configuration, as described in :ref:`nrf_desktop_bluetooth_guide`.
3030
Make sure that both :ref:`CONFIG_DESKTOP_ROLE_HID_DONGLE <config_desktop_app_options>` and :ref:`CONFIG_DESKTOP_BT_CENTRAL <config_desktop_app_options>` options are enabled.
3131
The |ble_conn_params| is enabled by the :ref:`CONFIG_DESKTOP_BLE_CONN_PARAMS_ENABLE <config_desktop_app_options>` option.
32-
The option is implied by :ref:`CONFIG_DESKTOP_BT_CENTRAL <config_desktop_app_options>` together with other features used by an HID dongle that forwards the HID reports received over Bluetooth LE.
32+
The option is implied by :ref:`CONFIG_DESKTOP_BT_CENTRAL <config_desktop_app_options>` together with other features used by a HID dongle that forwards the HID reports received over Bluetooth LE.
3333

3434
Enable :ref:`CONFIG_DESKTOP_BLE_USB_MANAGED_CI <config_desktop_app_options>` to manage Bluetooth connections' parameters reacting on the USB state change.
3535
The connection intervals for all of the Bluetooth connected peripherals are set to :ref:`CONFIG_DESKTOP_BLE_USB_MANAGED_CI_VALUE <config_desktop_app_options>` (100 ms by default) while USB is suspended.

applications/nrf_desktop/doc/ble_latency.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Configuration
3030
The module requires the basic Bluetooth configuration, as described in :ref:`nrf_desktop_bluetooth_guide`.
3131
Make sure that both :ref:`CONFIG_DESKTOP_ROLE_HID_PERIPHERAL <config_desktop_app_options>` and :ref:`CONFIG_DESKTOP_BT_PERIPHERAL <config_desktop_app_options>` options are enabled.
3232
The Bluetooth LE latency application module is enabled by the :ref:`CONFIG_DESKTOP_BLE_LATENCY_ENABLE <config_desktop_app_options>` option.
33-
The option is implied by :ref:`CONFIG_DESKTOP_BT_PERIPHERAL <config_desktop_app_options>` together with other features used by an HID peripheral device.
33+
The option is implied by :ref:`CONFIG_DESKTOP_BT_PERIPHERAL <config_desktop_app_options>` together with other features used by a HID peripheral device.
3434

3535
You can use the option :ref:`CONFIG_DESKTOP_BLE_SECURITY_FAIL_TIMEOUT_S <config_desktop_app_options>` to define the maximum allowed time for establishing the connection security.
3636
If the connection is not secured during this period of time, the peripheral device disconnects.

applications/nrf_desktop/doc/config_channel.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,7 @@ Depending on the connection method:
381381
From the script user perspective, the device can be identified using type, board name or Hardware ID.
382382

383383
.. note::
384-
If the Low Latency Packet Mode (LLPM) connection interval is in use, the Bluetooth Peripheral can provide either an HID input report or a GATT write response during a single connection event.
384+
If the Low Latency Packet Mode (LLPM) connection interval is in use, the Bluetooth Peripheral can provide either a HID input report or a GATT write response during a single connection event.
385385

386386
To prevent HID input report rate drop while forwarding config channel report set operation, nRF Desktop Dongle can forward the data using GATT write without response.
387387
In that case, the peripheral does not have to provide the GATT write response instead of sending the HID input report.

applications/nrf_desktop/doc/hid_state.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ The :c:struct:`report_data` structure is passed as an argument to this function.
267267
Handling HID keyboard LED state
268268
===============================
269269

270-
When the |hid_state| receives a :c:struct:`hid_report_event` that contains an HID output report, it updates the remembered information about the state of the HID output report of the appropriate subscriber.
270+
When the |hid_state| receives a :c:struct:`hid_report_event` that contains a HID output report, it updates the remembered information about the state of the HID output report of the appropriate subscriber.
271271

272272
By default, nRF Desktop supports only HID keyboard LED output report.
273273
The nRF Desktop peripheral displays the state of the keyboard LEDs that was specified by the HID subscriber that subscribed for keyboard key HID input report.

applications/nrf_desktop/doc/hids.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ The HID Service application module sends the report over Bluetooth LE and submit
7070
HID keyboard LED output report
7171
==============================
7272

73-
The module can receive an HID output report setting state of the keyboard LEDs, for example, state of the Caps Lock.
73+
The module can receive a HID output report setting state of the keyboard LEDs, for example, state of the Caps Lock.
7474
The report is received from the Bluetooth connected host.
7575
The module forwards the report using ``hid_report_event`` that is handled by |hid_state|.
7676

applications/nrf_desktop/doc/usb_state.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,5 +151,5 @@ Upon data delivery, :c:struct:`hid_report_sent_event` is submitted by the module
151151

152152
The |usb_state| is a transport for :ref:`nrf_desktop_config_channel` when the channel is enabled.
153153

154-
The module also handles an HID keyboard LED output report received through USB from the connected host.
154+
The module also handles a HID keyboard LED output report received through USB from the connected host.
155155
The module sends the report using :c:struct:`hid_report_event`, that is handled either by :ref:`nrf_desktop_hid_state` (for peripheral) or by the :ref:`nrf_desktop_hid_forward` (for dongle).

0 commit comments

Comments
 (0)