R1 code for micro:bit based train controller code, requires second micro:bit running rx code to operate - see https://meanderingpi.wordpress.com/ for more information

Fork of nrf51-sdk by Lancaster University

Embed: (wiki syntax)

« Back to documentation index

Types definitions for ANT support in SoftDevice handler.

Types definitions for ANT support in SoftDevice handler.
[SoftDevice Event Handler]

This file contains the declarations of types required for ANT stack support. More...

Data Structures

struct  ant_evt_t
 ANT stack event type. More...

Typedefs

typedef void(* ant_evt_handler_t )(ant_evt_t *p_ant_evt)
 Application ANT stack event handler type.

Functions

uint32_t softdevice_ant_evt_handler_set (ant_evt_handler_t ant_evt_handler)
 Function for registering for ANT events.

Detailed Description

This file contains the declarations of types required for ANT stack support.

These types will be defined when the preprocessor define ANT_STACK_SUPPORT_REQD is defined.


Typedef Documentation

typedef void(* ant_evt_handler_t)(ant_evt_t *p_ant_evt)

Application ANT stack event handler type.

Definition at line 61 of file ant_stack_handler_types.h.


Function Documentation

uint32_t softdevice_ant_evt_handler_set ( ant_evt_handler_t  ant_evt_handler )

Function for registering for ANT events.

The application should use this function to register for receiving ANT events from the SoftDevice. If the application does not call this function, then any ANT event that may be generated by the SoftDevice will NOT be fetched. Once the application has registered for the events, it is not possible to possible to cancel the registration. However, it is possible to register a different function for handling the events at any point of time.

Parameters:
[in]ant_evt_handlerFunction to be called for each received ANT event.
Return values:
NRF_SUCCESSSuccessful registration.
NRF_ERROR_NULLNull pointer provided as input.

Definition at line 304 of file softdevice_handler.c.