Types and functions for handling advertising in Eddystone beacons.
More...
|
| | Timing |
| | Events and functions for advertisement timing.
|
| |
| | TLM |
| | Functions for the Eddystone telemetry (TLM) manager.
|
| |
|
| enum | es_adv_evt_t {
ES_ADV_EVT_NON_CONN_ADV,
ES_ADV_EVT_CONNECTABLE_ADV_STARTED
} |
| | Eddystone Advertiser events.
|
| |
Types and functions for handling advertising in Eddystone beacons.
| void es_adv_frame_fill_connectable_adv_data |
( |
ble_advdata_t * |
p_scrsp_data | ) |
|
Function for setting up connectable advertisement data using ble_advdata_set.
- Parameters
-
| [in] | p_scrsp_data | Pointer to the scan response data. |
| void es_adv_frame_fill_non_connectable_adv_data |
( |
uint8_t |
slot_no, |
|
|
bool |
etlm |
|
) |
| |
Function for setting up non-connectable advertisement data using ble_advdata_set.
- Parameters
-
| [in] | slot_no | Slot to fill in data for. |
| [in] | etlm | Flag that specifies if Eddystone-TLM is required. |
| void es_adv_init |
( |
uint8_t |
ecs_uuid_type, |
|
|
es_adv_evt_handler_t |
adv_event_handler, |
|
|
nrf_ble_escs_adv_interval_t |
adv_interval, |
|
|
bool |
remain_connectable |
|
) |
| |
Function for initializing the module.
- Parameters
-
| [in] | ecs_uuid_type | ECS UUID type used for advertising the Eddystone Configuration Service UUID. |
| [in] | adv_event_handler | Eddystone advertiser event handler. |
| [in] | adv_interval | Advertisement interval to use. |
| [in] | remain_connectable | Flag that specifies if advertisements should remain connectable. |
| nrf_ble_escs_adv_interval_t es_adv_interval_get |
( |
void |
| ) |
|
Function for getting a pointer to the current advertisement interval.
- Return values
-
| Pointer | to the current advertisement interval. |
| void es_adv_interval_set |
( |
nrf_ble_escs_adv_interval_t |
interval | ) |
|
Function for setting the base advertisement interval for non-connectable advertisements.
The minimum allowed advertisement interval is calculated based on the configured minimum advertisement frame spacings and the number of configured slots. If eTLM slots are configured a separate minimum advertisement frame spacing is used for those. If interval is outside of range, the closest valid value is set.
- Parameters
-
| interval | The new advertisement interval. |
| void es_adv_on_ble_evt |
( |
ble_evt_t * |
p_ble_evt | ) |
|
Function for passing BLE events to this module.
- Parameters
-
| [in] | p_ble_evt | Pointer to the BLE evt. |
| bool es_adv_remain_connectable_get |
( |
void |
| ) |
|
Function for getting the value of the 'remain_connectable' field.
- Return values
-
| Value | of 'remain_connectable'. |
| void es_adv_remain_connectable_set |
( |
bool |
remain_connectable | ) |
|
Function for specifying if the beacon should remain connectable.
- Parameters
-
| [in] | remain_connectable | Value to be set. |