Eddystone library

nRF5 SDK v12.2.0
Modules | Typedefs | Enumerations | Functions

Library for Eddystone beacons. This library is used in the Experimental: Eddystone Beacon Application . More...

Modules

Frame types and data formats
Definitions specific to Eddystone frame types and data formats.
Eddystone advertising module
Types and functions for handling advertising in Eddystone beacons.
Flash access
Types and functions to access the flash of the Eddystone beacon.
GATTS
Functions for handling GATTS write and read requests.
Security
Types and functions for dealing with security of Eddystone beacons.
Slots
Types and functions for handling Eddystone slots.
Application configuration
Configuration settings for the application.

Typedefs

typedef void(* nrf_ble_es_evt_handler_t )( nrf_ble_es_evt_t evt)
Eddystone event handler type.

Enumerations

enum nrf_ble_es_evt_t {
NRF_BLE_ES_EVT_ADVERTISEMENT_SENT ,
NRF_BLE_ES_EVT_CONNECTABLE_ADV_STARTED
}
Eddystone event types. More...

Functions

void nrf_ble_es_on_ble_evt ( ble_evt_t *p_ble_evt)
Function for handling the application's BLE stack events. More...
void nrf_ble_es_on_start_connectable_advertising (void)
Function for putting the beacon in connectable mode. More...
void nrf_ble_es_init ( nrf_ble_es_evt_handler_t evt_handler)
Function for initializing the Eddystone library. More...

Detailed Description

Library for Eddystone beacons. This library is used in the Experimental: Eddystone Beacon Application .

Note
The API documentation is provided for reference only. You should not modify this library, and you should not use any functions except for the main level functions defined in nrf_ble_es.h in different contexts.

Enumeration Type Documentation

enum nrf_ble_es_evt_t

Eddystone event types.

Enumerator
NRF_BLE_ES_EVT_ADVERTISEMENT_SENT

A non-connectable Eddystone frame advertisement was sent.

NRF_BLE_ES_EVT_CONNECTABLE_ADV_STARTED

Advertising in connectable mode was started.

Function Documentation

void nrf_ble_es_init ( nrf_ble_es_evt_handler_t evt_handler )

Function for initializing the Eddystone library.

Parameters
[in] evt_handler Event handler to be called for handling BLE events.
void nrf_ble_es_on_ble_evt ( ble_evt_t * p_ble_evt )

Function for handling the application's BLE stack events.

This function handles all events from the BLE stack that are of interest to the Eddystone library. It must be called from the SoftDevice Event Handler callback for all BLE events that are received from the SoftDevice.

Parameters
[in] p_ble_evt Event received from the BLE stack.
void nrf_ble_es_on_start_connectable_advertising ( void )

Function for putting the beacon in connectable mode.

This function makes the beacon advertise connectable advertisements. If the beacon is in a connected state, the request is ignored.