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

Advertising parameters. More...

Data Fields

uint8_t adv_hdl
 Advertising handle identifying the advertising set to be set the advertising parameters. More...
 
uint16_t adv_prop_type
 Advertising packet type. More...
 
uint32_t adv_intv_min
 Minimum advertising interval. More...
 
uint32_t adv_intv_max
 Maximum Advertising interval. More...
 
uint8_t adv_ch_map
 The adv_ch_map is channels used in advertising with primary advertising channels. More...
 
uint8_t o_addr_type
 Own BD Address Type. More...
 
uint8_t o_addr [BLE_BD_ADDR_LEN]
 Random address set to the advertising set, when the o_addr_type field is BLE_GAP_ADDR_RAND. More...
 
uint8_t p_addr_type
 Peer address type. More...
 
uint8_t p_addr [BLE_BD_ADDR_LEN]
 Peer address. More...
 
uint8_t filter_policy
 Advertising Filter Policy. More...
 
uint8_t adv_phy
 Primary ADV PHY. More...
 
uint8_t sec_adv_max_skip
 Secondary ADV Max Skip. More...
 
uint8_t sec_adv_phy
 Secondary ADV Phy. More...
 
uint8_t scan_req_ntf_flag
 Scan Request Notifications Flag. More...
 

Detailed Description

Advertising parameters.

Field Documentation

◆ adv_hdl

uint8_t st_ble_gap_ext_adv_param_t::adv_hdl

Advertising handle identifying the advertising set to be set the advertising parameters.

Valid range is 0x00 - 0x03.
In the first advertising parameters setting, the advertising set specified by adv_hdl is generated.
The Advertising Set ID(Advertising SID) of the advertising set is same as adv_hdl.

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

◆ adv_prop_type

uint16_t st_ble_gap_ext_adv_param_t::adv_prop_type

Advertising packet type.

Legacy advertising PDU type, or bitwise or of Extended advertising PDU type and Extended advertising option.

category macro description
Legacy Advertising PDU type BLE_GAP_LEGACY_PROP_ADV_IND Connectable and scannable undirected Legacy Advertising Packet.
BLE_GAP_LEGACY_PROP_ADV_DIRECT_IND Connectable directed (low duty cycle) Legacy Advertising Packet.
BLE_GAP_LEGACY_PROP_ADV_HDC_DIRECT_IND Connectable directed (high duty cycle) Legacy Advertising Packet.
BLE_GAP_LEGACY_PROP_ADV_SCAN_IND Scannable undirected Legacy Advertising Packet.
BLE_GAP_LEGACY_PROP_ADV_NONCONN_IND Non-connectable and non-scannable undirected Legacy Advertising Packet.
Extended Advertising PDU type BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_UNDIRECT Connectable and non-scannable undirected Extended Advertising Packet.
BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_DIRECT Connectable and non-scannable directed (low duty cycle) Extended Advertising Packet.
BLE_GAP_EXT_PROP_ADV_CONN_NOSCAN_HDC_DIRECT Connectable and non-scannable directed (high duty cycle) Extended Advertising Packet.
BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_UNDIRECT Non-connectable and scannable undirected Extended Advertising Packet.
BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_DIRECT Non-connectable and scannable directed (low duty cycle) Extended Advertising Packet.
BLE_GAP_EXT_PROP_ADV_NOCONN_SCAN_HDC_DIRECT Non-connectable and scannable directed (high duty cycle) Extended Advertising Packet.
BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_UNDIRECT Non-connectable and non-scannable undirected Extended Advertising Packet.
BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_DIRECT Non-connectable and non-scannable directed (low duty cycle) Extended Advertising Packet.
BLE_GAP_EXT_PROP_ADV_NOCONN_NOSCAN_HDC_DIRECT Non-connectable and non-scannable directed (high duty cycle) Extended Advertising Packet.
Extended Advertising Option BLE_GAP_EXT_PROP_ADV_ANONYMOUS Omit the advertiser address from Extended Advertising Packet.
BLE_GAP_EXT_PROP_ADV_INCLUDE_TX_POWER Indicate that the advertising data includes TX Power.


Note
If the "Balance" or "Compact" library is used, Extended Advertising PDU type and Extended Advertising Option are not allowed.

◆ adv_intv_min

uint32_t st_ble_gap_ext_adv_param_t::adv_intv_min

Minimum advertising interval.

Time(ms) = adv_intv_min * 0.625.

Note
Valid range changes depending on the BLE Protocol Stack library type.
All Features : 0x00000020 - 0x00FFFFFF
Balance and Compact : 0x00000020 - 0x00004000

◆ adv_intv_max

uint32_t st_ble_gap_ext_adv_param_t::adv_intv_max

Maximum Advertising interval.

Time(ms) = adv_intv_max * 0.625.

Note
Valid range changes depending on the BLE Protocol Stack library type.
All Features : 0x00000020 - 0x00FFFFFF
Balance and Compact : 0x00000020 - 0x00004000

◆ adv_ch_map

uint8_t st_ble_gap_ext_adv_param_t::adv_ch_map

The adv_ch_map is channels used in advertising with primary advertising channels.

It is a bitwise OR of the following values.

macro description
BLE_GAP_ADV_CH_37(0x01) Use 37 CH.
BLE_GAP_ADV_CH_38(0x02) Use 38 CH.
BLE_GAP_ADV_CH_39(0x04) Use 39 CH.
BLE_GAP_ADV_CH_ALL(0x07) Use 37 - 39 CH.

◆ o_addr_type

uint8_t st_ble_gap_ext_adv_param_t::o_addr_type

Own BD Address Type.

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 specified by the o_addr field is used.

◆ o_addr

uint8_t st_ble_gap_ext_adv_param_t::o_addr[BLE_BD_ADDR_LEN]

Random address set to the advertising set, when the o_addr_type field is BLE_GAP_ADDR_RAND.

When the o_addr_type field is other than BLE_GAP_ADDR_RAND, this field is ignored.

Note
If the "Balance" or "Compact" library is used, this field is ignored.
Instead, set the random address (static address or non-resolvable private address) by R_BLE_GAP_SetRandAddr() or R_BLE_VS_SetBdAddr().
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}.

◆ p_addr_type

uint8_t st_ble_gap_ext_adv_param_t::p_addr_type

Peer address type.

When the Advertising PDU type is other than directed or the o_addr_type is BLE_GAP_ADDR_PUBLIC or BLE_GAP_ADDR_RAND,this field is ignored.

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

◆ p_addr

uint8_t st_ble_gap_ext_adv_param_t::p_addr[BLE_BD_ADDR_LEN]

Peer address.

When the Advertising PDU type is other than directed or the o_addr_type is BLE_GAP_ADDR_PUBLIC or BLE_GAP_ADDR_RAND,this field is ignored.

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}.

◆ filter_policy

uint8_t st_ble_gap_ext_adv_param_t::filter_policy

Advertising Filter Policy.

macro description
BLE_GAP_ADV_ALLOW_SCAN_ANY_CONN_ANY(0x00) Process scan and connection requests from all devices.
BLE_GAP_ADV_ALLOW_SCAN_WLST_CONN_ANY(0x01) Process connection requests from all devices and scan requests from only devices that are in the White List.
BLE_GAP_ADV_ALLOW_SCAN_ANY_CONN_WLST(0x02) Process scan requests from all devices and connection requests from only devices that are in the White List.
BLE_GAP_ADV_ALLOW_SCAN_WLST_CONN_WLST(0x03) Process scan and connection requests from only devices in the White List.

◆ adv_phy

uint8_t st_ble_gap_ext_adv_param_t::adv_phy

Primary ADV PHY.

In this parameter, only 1M PHY and Coded PHY can be specified, and 2M PHY cannot be specified.

macro description
BLE_GAP_ADV_PHY_1M(0x01) Use 1M PHY as Primary Advertising PHY.
When the adv_prop_type field is Legacy Advertising PDU type,
this field shall be set to BLE_GAP_ADV_PHY_1M.
BLE_GAP_ADV_PHY_CD(0x03) Use Coded PHY(S=8) as Primary Advertising PHY. Coding scheme is configured by R_BLE_VS_SetCodingScheme().


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

◆ sec_adv_max_skip

uint8_t st_ble_gap_ext_adv_param_t::sec_adv_max_skip

Secondary ADV Max Skip.

Valid range is 0x00 - 0xFF.
When this field is 0x00, AUX_ADV_IND is sent before the next advertising event.
When the adv_prop_type field is Legacy Advertising PDU, this field is ignored.

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

◆ sec_adv_phy

uint8_t st_ble_gap_ext_adv_param_t::sec_adv_phy

Secondary ADV Phy.

When the adv_prop_type is Legacy Advertising PDU, this field is ignored.

macro description
BLE_GAP_ADV_PHY_1M(0x01) Use 1M PHY as Secondary Advertising PHY.
BLE_GAP_ADV_PHY_2M(0x02) Use 2M PHY as Secondary Advertising PHY.
BLE_GAP_ADV_PHY_CD(0x03) Use Coded PHY(S=8) as Secondary Advertising PHY.
Coding scheme is configured by R_BLE_VS_SetCodingScheme().


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

◆ scan_req_ntf_flag

uint8_t st_ble_gap_ext_adv_param_t::scan_req_ntf_flag

Scan Request Notifications Flag.

When the adv_prop_type field is non-scannable Advertising PDU, this field is ignored.

macro description
BLE_GAP_SCAN_REQ_NTF_DISABLE(0x00) Disable Scan Request Notification.
BLE_GAP_SCAN_REQ_NTF_ENABLE(0x01) Enable Scan Request Notification.
When a Scan Request Packet from Scanner has been received, the BLE_GAP_EVENT_SCAN_REQ_RECV event is notified.


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