diff options
| author | Jim Mussared <jim.mussared@gmail.com> | 2020-11-24 23:59:06 +1100 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2020-12-02 14:41:21 +1100 |
| commit | f822557cbb79decb6947e1e35b8cddce18f4c06f (patch) | |
| tree | 4ecae0394659a600e122cf2365a3b629396039f0 | |
| parent | a1fcf301217b34ae74fbb937a9488be5bc6e61a5 (diff) | |
docs/library/ubluetooth.rst: Add pairing/bonding config docs.
Signed-off-by: Jim Mussared <jim.mussared@gmail.com>
| -rw-r--r-- | docs/library/ubluetooth.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/library/ubluetooth.rst b/docs/library/ubluetooth.rst index d402c6a9e..29d3044eb 100644 --- a/docs/library/ubluetooth.rst +++ b/docs/library/ubluetooth.rst @@ -80,6 +80,24 @@ Configuration :meth:`gattc_exchange_mtu<BLE.gattc_exchange_mtu>`. Use the ``_IRQ_MTU_EXCHANGED`` event to discover the MTU for a given connection. + - ``'bond'``: Sets whether bonding will be enabled during pairing. When + enabled, pairing requests will set the "bond" flag and the keys will be stored + by both devices. + + - ``'mitm'``: Sets whether MITM-protection is required for pairing. + + - ``'io'``: Sets the I/O capabilities of this device. + + Available options are:: + + _IO_CAPABILITY_DISPLAY_ONLY = const(0) + _IO_CAPABILITY_DISPLAY_YESNO = const(1) + _IO_CAPABILITY_KEYBOARD_ONLY = const(2) + _IO_CAPABILITY_NO_INPUT_OUTPUT = const(3) + _IO_CAPABILITY_KEYBOARD_DISPLAY = const(4) + + - ``'le_secure'``: Sets whether "LE Secure" pairing is required. Default is "Legacy Pairing". + Event Handling -------------- |