diff options
| author | Jim Mussared <jim.mussared@gmail.com> | 2020-11-25 00:10:17 +1100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2020-12-02 14:41:36 +1100 |
| commit | fff634e03134b8f1724759f477da61b698c9cdf4 (patch) | |
| tree | 7af3a5fef2f0794beee6233cf5510008b4a95111 | |
| parent | 801e8ffacff0d2ed15e82136db2a8a45afbfab7b (diff) | |
docs/library/ubluetooth.rst: Add gap_pair() docs.
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
| -rw-r--r-- | docs/library/ubluetooth.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/library/ubluetooth.rst b/docs/library/ubluetooth.rst index 29d3044eb..594d73c87 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<BLE.config>`). + + On successful pairing, the ``_IRQ_ENCRYPTION_UPDATED`` event will be raised. + GATT Server ----------- |