Skip to content

Commit 8f224d6

Browse files
committed
Merge branch 'change/opt_hid_device_connect_description' into 'master'
docs(bt/bluedroid): Updated HID Device connect API description Closes IDFGH-15363 See merge request espressif/esp-idf!39434
2 parents fed2fb0 + 31c8dac commit 8f224d6

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

components/bt/host/bluedroid/api/include/api/esp_hidd_api.h

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -345,6 +345,11 @@ esp_err_t esp_bt_hid_device_unregister_app(void);
345345
* called after esp_bt_hid_device_init(). When the operation is complete, the callback function will
346346
* be called with ESP_HIDD_OPEN_EVT.
347347
*
348+
* @note The connection between the HID Host and the HID Device is established as a virtual cable by default.
349+
* A new HID Host connection request will only be accepted after the previous HID Host has been
350+
* explicitly unplugged. For details on disconnection and virtual cable unplugging, please refer to API
351+
* `esp_bt_hid_device_disconnect` and `esp_bt_hid_device_virtual_cable_unplug`.
352+
*
348353
* @param[in] bd_addr: Remote host bluetooth device address.
349354
*
350355
* @return

0 commit comments

Comments
 (0)