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

Connection parameters used in R_BLE_GAP_CreateConn(). More...

Data Fields

uint8_t init_filter_policy
 This field specifies whether the White List is used or not, when connecting with a remote device. More...
 
uint8_t remote_bd_addr [BLE_BD_ADDR_LEN]
 Address of the device to be connected. More...
 
uint8_t remote_bd_addr_type
 Address type of the device to be connected. More...
 
uint8_t own_addr_type
 Address type which local device uses in creating a link with the remote device. More...
 
st_ble_gap_conn_phy_param_tp_conn_param_1M
 Connection parameters for 1M PHY. More...
 
st_ble_gap_conn_phy_param_tp_conn_param_2M
 Connection parameters for 2M PHY. More...
 
st_ble_gap_conn_phy_param_tp_conn_param_coded
 Connection parameters for Coded PHY. More...
 

Detailed Description

Connection parameters used in R_BLE_GAP_CreateConn().

Field Documentation

◆ init_filter_policy

uint8_t st_ble_gap_create_conn_param_t::init_filter_policy

This field specifies whether the White List is used or not, when connecting with a remote device.

macro description
BLE_GAP_INIT_FILT_USE_ADDR(0x00) White List is not used.
The remote device to be connected is specified by the remote_bd_addr field and
the remote_bd_addr_type field is used.
BLE_GAP_INIT_FILT_USE_WLST(0x01) White List is used.
The remote device registered in White List is connected with local device.
The remote_bd_addr field and the remote_bd_addr_type field are ignored.

◆ remote_bd_addr

uint8_t st_ble_gap_create_conn_param_t::remote_bd_addr[BLE_BD_ADDR_LEN]

Address of the device to be connected.

Note
The BD address setting format is little endian.
If the address is "AA:BB:CC:DD:EE:FF", set the byte array in the order {0xFF, 0xEE, 0xDD, 0xCC, 0xBB, 0xAA}.

◆ remote_bd_addr_type

uint8_t st_ble_gap_create_conn_param_t::remote_bd_addr_type

Address type of the device to be connected.

macro description
BLE_GAP_ADDR_PUBLIC(0x00) Public Address or Public Identity Address
BLE_GAP_ADDR_RAND(0x01) Random Address or Random (Static) Identity Address

◆ own_addr_type

uint8_t st_ble_gap_create_conn_param_t::own_addr_type

Address type which local device uses in creating a link with the remote device.

macro description
BLE_GAP_ADDR_PUBLIC(0x00) Public Address
BLE_GAP_ADDR_RAND(0x01) Random Address
BLE_GAP_ADDR_RPA_ID_PUBLIC(0x02) Resolvable Private Address.
If the IRK of local device has not been registered in Resolving List, public address is used.
BLE_GAP_ADDR_RPA_ID_RANDOM (0x03) Resolvable Private Address.
If the IRK of local device has not been registered in Resolving List, the random address set by R_BLE_GAP_SetRandAddr().

◆ p_conn_param_1M

st_ble_gap_conn_phy_param_t* st_ble_gap_create_conn_param_t::p_conn_param_1M

Connection parameters for 1M PHY.

If this field is set to NULL, 1M PHY is not used in connecting.

◆ p_conn_param_2M

st_ble_gap_conn_phy_param_t* st_ble_gap_create_conn_param_t::p_conn_param_2M

Connection parameters for 2M PHY.

If this field is set to NULL, 2M PHY is not used in connecting.

Note
If the "Balance" library is used, this field is ignored.

◆ p_conn_param_coded

st_ble_gap_conn_phy_param_t* st_ble_gap_create_conn_param_t::p_conn_param_coded

Connection parameters for Coded PHY.

If this field is set to NULL, Coded PHY is not used in connecting.

Note
If the "Balance" library is used, this field is ignored.