djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs/library/ubluetooth.rst: Add gap_pair() docs.

Browse Source 
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
This commit is contained in:
Jim Mussared 2020-11-25 00:10:17 +11:00 committed by Damien George
parent 801e8ffacf
commit fff634e031
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/library/ubluetooth.rst
View File

@ -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
-----------