nRF5 SDK v17.1.0
Modules | Functions
ANT channel state indicator

ANT channel state indicator module. More...

Modules

 ANT state indicator using BSP configuration
 

Functions

ret_code_t ant_state_indicator_init (uint8_t channel, uint8_t channel_type)
 Function for initializing the ANT channel state indicator. More...
 
ret_code_t ant_state_indicator_channel_opened (void)
 Function for indicating the channel opening. More...
 

Detailed Description

ANT channel state indicator module.

This module provides functionality for indicating the ANT channel state.

Function Documentation

ret_code_t ant_state_indicator_channel_opened ( void  )

Function for indicating the channel opening.

This function should be called after the opening of the channel.

Return values
NRF_SUCCESSIf the state was successfully indicated.
NRF_ERROR_NO_MEMIf the internal timer operations queue was full.
NRF_ERROR_INVALID_STATEIf the application timer module has not been initialized or the internal timer has not been created.
NRF_SUCCESSIf the state was indicated successfully. Otherwise, a propagated error code is returned.
ret_code_t ant_state_indicator_init ( uint8_t  channel,
uint8_t  channel_type 
)

Function for initializing the ANT channel state indicator.

This function links the signaling procedure with a specific ANT channel.

Before calling this function, you must initiate the Board Support Package (BSP) to be able to use the LEDs.

Parameters
[in]channelANT channel number.
[in]channel_typeANT channel type (see Assign Channel Parameters in ant_parameters.h: ANT Stack Parameters).
Return values
NRF_SUCCESSIf the module was initialized successfully. Otherwise, a propagated error code is returned.

Documentation feedback | Developer Zone | Subscribe | Updated