diff options
Diffstat (limited to 'docs/library')
| -rw-r--r-- | docs/library/bluetooth.rst | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/library/bluetooth.rst b/docs/library/bluetooth.rst index cfec804ea..7663199e9 100644 --- a/docs/library/bluetooth.rst +++ b/docs/library/bluetooth.rst @@ -365,7 +365,12 @@ A central device can connect to peripherals that it has discovered using the obs See :meth:`gap_scan <BLE.gap_scan>` for details about address types. - On success, the ``_IRQ_PERIPHERAL_CONNECT`` event will be raised. + To cancel an outstanding connection attempt early, call + ``gap_connect(None)``. + + On success, the ``_IRQ_PERIPHERAL_CONNECT`` event will be raised. If + cancelling a connection attempt, the ``_IRQ_PERIPHERAL_DISCONNECT`` event + will be raised. The device will wait up to *scan_duration_ms* to receive an advertising payload from the device. |