nRF51 SDK - S110 SoftDevice
|
Module for handling connectable BLE advertising. More...
Data Structures | |
struct | ble_adv_modes_config_t |
Options for the different advertisement modes. More... | |
struct | ble_adv_init_t |
Initialization parameters for the Advertising Module. More... | |
Typedefs | |
typedef void(* | ble_advertising_evt_handler_t )(ble_adv_evt_t const adv_evt) |
BLE advertising event handler type. | |
typedef void(* | ble_advertising_error_handler_t )(uint32_t nrf_error) |
BLE advertising error handler type. | |
Enumerations | |
enum | ble_adv_mode_t { BLE_ADV_MODE_IDLE, BLE_ADV_MODE_DIRECTED, BLE_ADV_MODE_FAST, BLE_ADV_MODE_SLOW } |
Advertising modes. More... | |
enum | ble_adv_evt_t { BLE_ADV_EVT_IDLE, BLE_ADV_EVT_DIRECTED, BLE_ADV_EVT_FAST, BLE_ADV_EVT_SLOW, BLE_ADV_EVT_FAST_WHITELIST, BLE_ADV_EVT_SLOW_WHITELIST, BLE_ADV_EVT_WHITELIST_REQUEST, BLE_ADV_EVT_PEER_ADDR_REQUEST } |
Advertising events. More... | |
Functions | |
void | ble_advertising_on_ble_evt (const ble_evt_t *const p_ble_evt) |
Function for handling BLE events. More... | |
void | ble_advertising_on_sys_evt (uint32_t sys_evt) |
Function for handling system events. More... | |
uint32_t | ble_advertising_init (ble_advdata_t const *p_advdata, ble_adv_modes_config_t const *p_config, ble_advertising_evt_handler_t const evt_handler, ble_advertising_error_handler_t const error_handler) |
Function for initializing the Advertising Module. More... | |
uint32_t | ble_advertising_start (ble_adv_mode_t advertising_mode) |
Function for starting advertising. More... | |
uint32_t | ble_advertising_peer_addr_reply (ble_gap_addr_t *p_peer_addr) |
Function for setting the peer address. More... | |
uint32_t | ble_advertising_whitelist_reply (ble_gap_whitelist_t *p_whitelist) |
Function for setting a whitelist. More... | |
uint32_t | ble_advertising_restart_without_whitelist (void) |
Function for disabling whitelist advertising. More... | |
Module for handling connectable BLE advertising.
The Advertising Module handles connectable advertising for your application. It can be configured with advertising modes to suit most typical use cases. Your main application can react to changes in advertising modes if an event handler is provided.
The application must propagate BLE stack events to this module by calling ble_advertising_on_ble_evt() and system events by calling ble_advertising_on_sys_evt().
enum ble_adv_evt_t |
Advertising events.
These events are propagated to the main application if a handler was provided during initialization of the Advertising Module. Events for modes that are not used can be ignored. Similarly, BLE_ADV_EVT_WHITELIST_REQUEST and BLE_ADV_EVT_PEER_ADDR_REQUEST can be ignored if whitelist and direct advertising is not used.
enum ble_adv_mode_t |
Advertising modes.
uint32_t ble_advertising_init | ( | ble_advdata_t const * | p_advdata, |
ble_adv_modes_config_t const * | p_config, | ||
ble_advertising_evt_handler_t const | evt_handler, | ||
ble_advertising_error_handler_t const | error_handler | ||
) |
Function for initializing the Advertising Module.
Encodes the required advertising data and passes it to the stack. Also builds a structure to be passed to the stack when starting advertising. The supplied advertising data is copied to a local structure and is manipulated depending on what advertising modes are started in ble_advertising_start.
[in] | p_advdata | Set advertising data, name, appearance, discovery flags, and more. |
[in] | p_config | Select which advertising modes and intervals will be utilized. |
[in] | evt_handler | Event handler that will be called upon advertising events. |
[in] | error_handler | Error handler that will propogate internal errors to the main applications. |
NRF_SUCCESS | If initialization was successful. Otherwise, an error code is returned. |
void ble_advertising_on_ble_evt | ( | const ble_evt_t *const | p_ble_evt | ) |
Function for handling BLE events.
This function must be called from the BLE stack event dispatcher for the module to handle BLE events that are relevant for the Advertising Module.
[in] | p_ble_evt | BLE stack event. |
void ble_advertising_on_sys_evt | ( | uint32_t | sys_evt | ) |
Function for handling system events.
This function must be called to handle system events that are relevant for the Advertising Module. Specifically, the advertising module can not use the softdevice as long as there are pending writes to the flash memory. This event handler is designed to delay advertising until there is no flash operation.
[in] | sys_evt | System event. |
uint32_t ble_advertising_peer_addr_reply | ( | ble_gap_addr_t * | p_peer_addr | ) |
Function for setting the peer address.
The peer address must be set by the application upon receiving a BLE_ADV_EVT_PEER_ADDR_REQUEST event. Without the peer address, the directed advertising mode will not be run.
[in] | p_peer_addr | Pointer to a peer address. |
@ref | NRF_SUCCESS Successfully stored the peer address pointer in the advertising module. |
@ref | NRF_ERROR_INVALID_STATE If a reply was not expected. |
uint32_t ble_advertising_restart_without_whitelist | ( | void | ) |
Function for disabling whitelist advertising.
This function temporarily disables whitelist advertising. Calling this function resets the current time-out countdown.
@ref | NRF_SUCCESS On success, else an error message propogated from the Softdevice. |
uint32_t ble_advertising_start | ( | ble_adv_mode_t | advertising_mode | ) |
Function for starting advertising.
You can start advertising in any of the advertising modes that you enabled during initialization.
[in] | advertising_mode | Advertising mode. |
@ref | NRF_SUCCESS On success, else an error code indicating reason for failure. |
@ref | NRF_ERROR_INVALID_STATE |
uint32_t ble_advertising_whitelist_reply | ( | ble_gap_whitelist_t * | p_whitelist | ) |
Function for setting a whitelist.
The whitelist must be set by the application upon receiving a BLE_ADV_EVT_WHITELIST_REQUEST event. Without the whitelist, the whitelist advertising for fast and slow modes will not be run.
[in] | p_whitelist | Pointer to a whitelist. |
@ref | NRF_SUCCESS Successfully stored pointers to the whitelist into the advertising module. |
@ref | NRF_ERROR_INVALID_STATE If a reply was not expected. |