From 071873bcf93864b575c36cbf286abf341aea81b7 Mon Sep 17 00:00:00 2001 From: Marek Pieta Date: Tue, 1 Aug 2023 07:17:24 +0200 Subject: [PATCH] applications: nrf_desktop: Align HID articles Change aligns the used HID articles. Jira: NCSDK-22789 Signed-off-by: Marek Pieta --- applications/nrf_desktop/doc/ble_conn_params.rst | 2 +- applications/nrf_desktop/doc/ble_latency.rst | 2 +- applications/nrf_desktop/doc/config_channel.rst | 2 +- applications/nrf_desktop/doc/hid_state.rst | 2 +- applications/nrf_desktop/doc/hids.rst | 2 +- applications/nrf_desktop/doc/usb_state.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/applications/nrf_desktop/doc/ble_conn_params.rst b/applications/nrf_desktop/doc/ble_conn_params.rst index 3af3c7a98ed..7d03ac5e4c3 100644 --- a/applications/nrf_desktop/doc/ble_conn_params.rst +++ b/applications/nrf_desktop/doc/ble_conn_params.rst @@ -29,7 +29,7 @@ Configuration The module requires the basic Bluetooth configuration, as described in :ref:`nrf_desktop_bluetooth_guide`. Make sure that both :ref:`CONFIG_DESKTOP_ROLE_HID_DONGLE ` and :ref:`CONFIG_DESKTOP_BT_CENTRAL ` options are enabled. The |ble_conn_params| is enabled by the :ref:`CONFIG_DESKTOP_BLE_CONN_PARAMS_ENABLE ` option. -The option is implied by :ref:`CONFIG_DESKTOP_BT_CENTRAL ` together with other features used by an HID dongle that forwards the HID reports received over Bluetooth LE. +The option is implied by :ref:`CONFIG_DESKTOP_BT_CENTRAL ` together with other features used by a HID dongle that forwards the HID reports received over Bluetooth LE. Enable :ref:`CONFIG_DESKTOP_BLE_USB_MANAGED_CI ` to manage Bluetooth connections' parameters reacting on the USB state change. The connection intervals for all of the Bluetooth connected peripherals are set to :ref:`CONFIG_DESKTOP_BLE_USB_MANAGED_CI_VALUE ` (100 ms by default) while USB is suspended. diff --git a/applications/nrf_desktop/doc/ble_latency.rst b/applications/nrf_desktop/doc/ble_latency.rst index 18b8f552ea1..125ea056471 100644 --- a/applications/nrf_desktop/doc/ble_latency.rst +++ b/applications/nrf_desktop/doc/ble_latency.rst @@ -30,7 +30,7 @@ Configuration The module requires the basic Bluetooth configuration, as described in :ref:`nrf_desktop_bluetooth_guide`. Make sure that both :ref:`CONFIG_DESKTOP_ROLE_HID_PERIPHERAL ` and :ref:`CONFIG_DESKTOP_BT_PERIPHERAL ` options are enabled. The Bluetooth LE latency application module is enabled by the :ref:`CONFIG_DESKTOP_BLE_LATENCY_ENABLE ` option. -The option is implied by :ref:`CONFIG_DESKTOP_BT_PERIPHERAL ` together with other features used by an HID peripheral device. +The option is implied by :ref:`CONFIG_DESKTOP_BT_PERIPHERAL ` together with other features used by a HID peripheral device. You can use the option :ref:`CONFIG_DESKTOP_BLE_SECURITY_FAIL_TIMEOUT_S ` to define the maximum allowed time for establishing the connection security. If the connection is not secured during this period of time, the peripheral device disconnects. diff --git a/applications/nrf_desktop/doc/config_channel.rst b/applications/nrf_desktop/doc/config_channel.rst index 3ad49645a97..952d0f3fe5a 100644 --- a/applications/nrf_desktop/doc/config_channel.rst +++ b/applications/nrf_desktop/doc/config_channel.rst @@ -381,7 +381,7 @@ Depending on the connection method: From the script user perspective, the device can be identified using type, board name or Hardware ID. .. note:: - 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. + 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. 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. In that case, the peripheral does not have to provide the GATT write response instead of sending the HID input report. diff --git a/applications/nrf_desktop/doc/hid_state.rst b/applications/nrf_desktop/doc/hid_state.rst index 90766e88b7a..6f22e8e7fda 100644 --- a/applications/nrf_desktop/doc/hid_state.rst +++ b/applications/nrf_desktop/doc/hid_state.rst @@ -267,7 +267,7 @@ The :c:struct:`report_data` structure is passed as an argument to this function. Handling HID keyboard LED state =============================== -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. +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. By default, nRF Desktop supports only HID keyboard LED output report. 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. diff --git a/applications/nrf_desktop/doc/hids.rst b/applications/nrf_desktop/doc/hids.rst index abf00a71939..7645e74984a 100644 --- a/applications/nrf_desktop/doc/hids.rst +++ b/applications/nrf_desktop/doc/hids.rst @@ -70,7 +70,7 @@ The HID Service application module sends the report over Bluetooth LE and submit HID keyboard LED output report ============================== -The module can receive an HID output report setting state of the keyboard LEDs, for example, state of the Caps Lock. +The module can receive a HID output report setting state of the keyboard LEDs, for example, state of the Caps Lock. The report is received from the Bluetooth connected host. The module forwards the report using ``hid_report_event`` that is handled by |hid_state|. diff --git a/applications/nrf_desktop/doc/usb_state.rst b/applications/nrf_desktop/doc/usb_state.rst index 7d99cdd1668..9182d69df08 100644 --- a/applications/nrf_desktop/doc/usb_state.rst +++ b/applications/nrf_desktop/doc/usb_state.rst @@ -151,5 +151,5 @@ Upon data delivery, :c:struct:`hid_report_sent_event` is submitted by the module The |usb_state| is a transport for :ref:`nrf_desktop_config_channel` when the channel is enabled. -The module also handles an HID keyboard LED output report received through USB from the connected host. +The module also handles a HID keyboard LED output report received through USB from the connected host. 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).