esp_bt_hid_device_virtual_cable_unplug() function

Remove the virtually cabled device. This function should be called after esp_bluedroid_init()/esp_bluedroid_init_with_cfg() and esp_bluedroid_enable() success, and should be called after esp_bt_hid_device_init(). When the operation is complete, the callback function will be called with ESP_HIDD_VC_UNPLUG_EVT.

Syntax

Show:

Summary

Declaration

from esp_hidd_api.h:407

esp_err_t esp_bt_hid_device_virtual_cable_unplug(void);

Return value

- ESP_OK: success - other: failed

Notes

If the connection exists, then HID Device will send a `VIRTUAL_CABLE_UNPLUG` control command to the peer HID Host, and the connection will be destroyed. If the connection does not exist, then HID Device will only unplug on it's single side. Once the unplug operation is success, the related pairing and bonding information will be removed, then the HID Device can accept connection request from the different HID Host,

Examples

References

from examples

esp_bt_hid_device_virtual_cable_unplug() function

Syntax

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle