nRF5 SDK v13.0.0
Data Structures | Typedefs | Enumerations | Functions

Events and functions for advertisement timing. More...

Data Structures

struct  es_adv_timing_evt_t
 Eddystone advertisement timing event. More...
 
struct  es_adv_timing_resolver_adv_timing_t
 Timing parameters for a single slot. More...
 
struct  es_adv_timing_resolver_result_t
 Results of calculating advertisement delays. More...
 
struct  es_adv_timing_resolver_input_t
 Input to the timing resolver. More...
 

Typedefs

typedef void(* es_adv_timing_callback_t )(const es_adv_timing_evt_t *p_evt)
 Eddystone advertisement timing event callback. More...
 

Enumerations

enum  es_adv_timing_evt_id_t {
  ES_ADV_TIMING_EVT_ADV_SLOT,
  ES_ADV_TIMING_EVT_ADV_ETLM
}
 Eddystone advertisement timing event types. More...
 

Functions

void es_adv_timing_start (uint16_t adv_interval)
 Function for starting Eddystone advertisement timing event generation.
 
void es_adv_timing_stop (void)
 Function for stopping Eddystone advertisement timing event generation.
 
void es_adv_timing_timers_init (void)
 Function for initializing the Eddystone advertisement timers.
 
void es_adv_timing_init (es_adv_timing_callback_t handler)
 Function for initializing the Eddystone advertisement timing module. More...
 
ret_code_t es_adv_timing_resolve (es_adv_timing_resolver_input_t *p_input)
 Function for getting the input for advertisement interval calculation. More...
 

Detailed Description

Events and functions for advertisement timing.

Typedef Documentation

typedef void(* es_adv_timing_callback_t)(const es_adv_timing_evt_t *p_evt)

Eddystone advertisement timing event callback.

Parameters
[in]p_evtPointer to the Eddystone advertisement timing event.

Enumeration Type Documentation

Eddystone advertisement timing event types.

Enumerator
ES_ADV_TIMING_EVT_ADV_SLOT 

Advertising non-eTLM slot.

ES_ADV_TIMING_EVT_ADV_ETLM 

Advertising eTLM slot.

Function Documentation

void es_adv_timing_init ( es_adv_timing_callback_t  handler)

Function for initializing the Eddystone advertisement timing module.

Parameters
[in]handlerEddystone advertisement timing event handler to register.
ret_code_t es_adv_timing_resolve ( es_adv_timing_resolver_input_t p_input)

Function for getting the input for advertisement interval calculation.

Parameters
[in,out]p_inputInput to advertisement interval calculation (see es_adv_timing_resolver_input_t).
Return values
NRF_SUCCESSIf the operation was successful. Otherwise, an error code is returned.

Documentation feedback | Developer Zone | Subscribe | Updated