| nRF5 SDK v12.0.0 |

Choose documentation: | nRF5 SDK | S130 SoftDevice API | S132 SoftDevice API | S212 SoftDevice API | S332 SoftDevice API

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions
BSP: ANT Button Module
Board Support Package

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

## Functions
uint32_t | bsp_btn_ant_init (void)
| Function for initializing the ANT Button Module. More...
uint32_t | bsp_btn_ant_sleep_mode_prepare (void)
| Function for setting up wakeup buttons before going into sleep mode. More...
void | bsp_btn_ant_on_ant_evt (ant_evt_t *p_ant_evt)
| Function for handling the application's ANT stack events. 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

uint32_t bsp_btn_ant_init | ( | void |  | ) |

Function for initializing the ANT Button Module.

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

Return values

  NRF_SUCCESS | If initialization was successful. Otherwise, a propagated error code is returned.

void bsp_btn_ant_on_ant_evt | ( | ant_evt_t * | p_ant_evt | ) |

Function for handling the application's ANT stack events.

This function handles all events from the ANT stack that are of interest to this module.

Parameters

  [in] | p_ant_evt | ANT stack event.

uint32_t bsp_btn_ant_sleep_mode_prepare | ( | void |  | ) |

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

Return values

  NRF_SUCCESS | If the buttons were prepared successfully. Otherwise, a propagated error code is returned.