From fff634e03134b8f1724759f477da61b698c9cdf4 Mon Sep 17 00:00:00 2001 From: Jim Mussared Date: Wed, 25 Nov 2020 00:10:17 +1100 Subject: [PATCH] docs/library/ubluetooth.rst: Add gap_pair() docs. Signed-off-by: Jim Mussared --- docs/library/ubluetooth.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/library/ubluetooth.rst b/docs/library/ubluetooth.rst index 29d3044ebf..594d73c878 100644 --- a/docs/library/ubluetooth.rst +++ b/docs/library/ubluetooth.rst @@ -368,6 +368,15 @@ Central & Peripheral Roles Returns ``False`` if the connection handle wasn't connected, and ``True`` otherwise. +.. method:: BLE.gap_pair(conn_handle, /) + + Initiate pairing with the remote device. + + Before calling this, ensure that the ``io``, ``mitm``, ``le_secure``, and + ``bond`` configuration options are set (via :meth:`config`). + + On successful pairing, the ``_IRQ_ENCRYPTION_UPDATED`` event will be raised. + GATT Server -----------