Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]
st_ble_gap_pairing_param_t Struct Reference

Pairing parameters used in R_BLE_GAP_SetPairingParams(). More...

Data Fields

uint8_t iocap
 IO capabilities of local device. More...
 
uint8_t mitm
 MITM protection policy. More...
 
uint8_t bonding
 Bonding policy. More...
 
uint8_t max_key_size
 Maximum LTK size(in bytes). More...
 
uint8_t min_key_size
 Minimum LTK size(in bytes). More...
 
uint8_t loc_key_dist
 Type of keys to be distributed from local device. More...
 
uint8_t rem_key_dist
 Type of keys which local device requests a remote device to distribute. More...
 
uint8_t key_notf
 Support for Key Press Notification in Passkey Entry. More...
 
uint8_t sec_conn_only
 Determine whether to accept only Secure Connections or not. More...
 

Detailed Description

Pairing parameters used in R_BLE_GAP_SetPairingParams().

Field Documentation

◆ iocap

uint8_t st_ble_gap_pairing_param_t::iocap

IO capabilities of local device.

Select one of the following.

macro description
BLE_GAP_IOCAP_DISPLAY_ONLY(0x00) Output function : Local device has the ability to display a 6 digit decimal number.
Input function : None
BLE_GAP_IOCAP_DISPLAY_YESNO(0x01) Output function : Output function : Local device has the ability to display a 6 digit decimal number.
Input function : Local device has the ability to indicate 'yes' or 'no'
BLE_GAP_IOCAP_KEYBOARD_ONLY(0x02) Output function : None
Input function : Local device has the ability to input the number '0' - '9'.
BLE_GAP_IOCAP_NOINPUT_NOOUTPUT(0x03) Output function : None
Input function : None
BLE_GAP_IOCAP_KEYBOARD_DISPLAY(0x04) Output function : Output function : Local device has the ability to display a 6 digit decimal number.
Input function : Local device has the ability to input the number '0' - '9'.

◆ mitm

uint8_t st_ble_gap_pairing_param_t::mitm

MITM protection policy.

Select one of the following.

macro description
BLE_GAP_SEC_MITM_BEST_EFFORT(0x00) MITM Protection not required.
BLE_GAP_SEC_MITM_STRICT (0x01) MITM Protection required.

◆ bonding

uint8_t st_ble_gap_pairing_param_t::bonding

Bonding policy.

macro description
BLE_GAP_BONDING_NONE(0x00) Local device doesn't stores Bonding information.
BLE_GAP_BONDING (0x01) Local device stores Bonding information.

◆ max_key_size

uint8_t st_ble_gap_pairing_param_t::max_key_size

Maximum LTK size(in bytes).

Valid range is 7 - 16.
This field shall be set to a value not less than the min_key_size field.

◆ min_key_size

uint8_t st_ble_gap_pairing_param_t::min_key_size

Minimum LTK size(in bytes).

Valid range is 7 - 16.
This field shall be set to a value not more than the max_key_size field.

◆ loc_key_dist

uint8_t st_ble_gap_pairing_param_t::loc_key_dist

Type of keys to be distributed from local device.

The loc_key_dist field is set to a bitwise OR of the following values.

macro description
BLE_GAP_KEY_DIST_ENCKEY(0x01) LTK
BLE_GAP_KEY_DIST_IDKEY(0x02) IRK and Identity Address.
BLE_GAP_KEY_DIST_SIGNKEY(0x04) CSRK

◆ rem_key_dist

uint8_t st_ble_gap_pairing_param_t::rem_key_dist

Type of keys which local device requests a remote device to distribute.

The rem_key_dist field is set to a bitwise OR of the following values.

macro description
BLE_GAP_KEY_DIST_ENCKEY(0x01) LTK. In case of Secure Connections, LTK is notified even if this bit is not set.
BLE_GAP_KEY_DIST_IDKEY(0x02) IRK and Identity Address.
BLE_GAP_KEY_DIST_SIGNKEY(0x04) CSRK

◆ key_notf

uint8_t st_ble_gap_pairing_param_t::key_notf

Support for Key Press Notification in Passkey Entry.

macro description
BLE_GAP_SC_KEY_PRESS_NTF_NOT_SPRT(0x00) Not support for Key Press Notification.
BLE_GAP_SC_KEY_PRESS_NTF_SPRT(0x01) Support for Key Press Notification.

◆ sec_conn_only

uint8_t st_ble_gap_pairing_param_t::sec_conn_only

Determine whether to accept only Secure Connections or not.

macro description
BLE_GAP_SC_BEST_EFFORT(0x00) Accept Legacy pairing and Secure Connections.
BLE_GAP_SC_STRICT(0x01) Accept only Secure Connections.