nRF5 SDK v17.1.0
Modules | Functions
BSP: ANT Button Module

Module for controlling ANT behavior through button actions. More...

Modules

 Button Control for ANT configuration
 

Functions

ret_code_t bsp_btn_ant_init (uint8_t channel, uint8_t channel_type)
 Function for initializing the ANT Button Module. More...
 
ret_code_t bsp_btn_ant_sleep_mode_prepare (void)
 Function for setting up wakeup buttons before going into sleep mode. More...
 

Detailed Description

Module for controlling ANT behavior through button actions.

The application must propagate ANT events to the ANT Button Module. Based on these events, the ANT Button Module configures the Board Support Package to generate BSP events for certain button actions. These BSP events should then be handled by the application's BSP event handler.

Function Documentation

ret_code_t bsp_btn_ant_init ( uint8_t  channel,
uint8_t  channel_type 
)

Function for initializing the ANT Button Module.

Before calling this function, the BSP module must be initialized with buttons.

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 initialization was successful. Otherwise, a propagated error code is returned.
ret_code_t bsp_btn_ant_sleep_mode_prepare ( void  )

Function for setting up wakeup buttons before going into sleep mode.

Return values
NRF_SUCCESSIf the buttons were prepared successfully. Otherwise, a propagated error code is returned.

Documentation feedback | Developer Zone | Subscribe | Updated