test

Fork of nrf51-sdk by Lancaster University

Embed: (wiki syntax)

« Back to documentation index

ble_gap_adv_params_t Struct Reference

ble_gap_adv_params_t Struct Reference
[Structures]

GAP advertising parameters. More...

#include <ble_gap.h>

Data Fields

uint8_t type
 See GAP Advertising types.
ble_gap_addr_tp_peer_addr
 For BLE_GAP_ADV_TYPE_ADV_DIRECT_IND mode only, known peer address.
uint8_t fp
 Filter Policy, see GAP Advertising filter policies.
ble_gap_whitelist_tp_whitelist
 Pointer to whitelist, NULL if no whitelist or the current active whitelist is to be used.
uint16_t interval
 Advertising interval between 0x0020 and 0x4000 in 0.625 ms units (20ms to 10.24s), see GAP Advertising interval max and min.
uint16_t timeout
 Advertising timeout between 0x0001 and 0x3FFF in seconds, 0x0000 disables timeout.
ble_gap_adv_ch_mask_t channel_mask
 Advertising channel mask.

Detailed Description

GAP advertising parameters.

Definition at line 472 of file ble_gap.h.


Field Documentation

Advertising channel mask.

See also:
ble_gap_channel_mask_t for documentation.

Definition at line 482 of file ble_gap.h.

uint8_t fp

Filter Policy, see GAP Advertising filter policies.

Definition at line 476 of file ble_gap.h.

uint16_t interval

Advertising interval between 0x0020 and 0x4000 in 0.625 ms units (20ms to 10.24s), see GAP Advertising interval max and min.

  • If type equals BLE_GAP_ADV_TYPE_ADV_DIRECT_IND, this parameter must be set to 0 for high duty cycle directed advertising.
  • If type equals BLE_GAP_ADV_TYPE_ADV_DIRECT_IND, set BLE_GAP_ADV_INTERVAL_MIN <= interval <= BLE_GAP_ADV_INTERVAL_MAX for low duty cycle advertising.

Definition at line 478 of file ble_gap.h.

For BLE_GAP_ADV_TYPE_ADV_DIRECT_IND mode only, known peer address.

Definition at line 475 of file ble_gap.h.

Pointer to whitelist, NULL if no whitelist or the current active whitelist is to be used.

Definition at line 477 of file ble_gap.h.

uint16_t timeout

Advertising timeout between 0x0001 and 0x3FFF in seconds, 0x0000 disables timeout.

See also GAP Advertising timeout values. If type equals BLE_GAP_ADV_TYPE_ADV_DIRECT_IND, this parameter must be set to 0 for High duty cycle directed advertising.

Definition at line 481 of file ble_gap.h.

uint8_t type

See GAP Advertising types.

Definition at line 474 of file ble_gap.h.