blob: 833e120e7882a1c3efe65be9fc82b62d20580529 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
/* Copyright (c) 2014 Nordic Semiconductor. All Rights Reserved.
*
* The information contained herein is property of Nordic Semiconductor ASA.
* Terms and conditions of usage are described in detail in NORDIC
* SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT.
*
* Licensees are granted free, non-transferable use of the information. NO
* WARRANTY of ANY KIND is provided. This heading must NOT be removed from
* the file.
*
*/
/**@file
*
* @defgroup bsp_btn_ble Board Support Package: BLE Button Module
* @{
* @ingroup app_common
*
* @brief Module for controlling BLE behavior through button actions.
*
* @details The application must propagate BLE events to the BLE Button Module.
* Based on these events, the BLE 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.
*
*/
#ifndef BSP_BTN_BLE_H__
#define BSP_BTN_BLE_H__
#include <stdint.h>
#include <sdk/softdevice/s130/headers/ble.h>
#include "bsp.h"
/**@brief BLE Button Module error handler type. */
typedef void (*bsp_btn_ble_error_handler_t) (uint32_t nrf_error);
/**@brief Function for initializing the BLE Button Module.
*
* Before calling this function, the BSP module must be initialized with buttons.
*
* @param[out] error_handler Error handler to call in case of internal errors in BLE Button
* Module.
* @param[out] p_startup_bsp_evt If not a NULL pointer, the value is filled with an event
* (or BSP_EVENT_NOTHING) derived from the buttons pressed on
* startup. For example, if the bond delete wakeup button was pressed
* to wake up the device, *p_startup_bsp_evt is set to
* @ref BSP_EVENT_CLEAR_BONDING_DATA.
*
* @retval NRF_SUCCESS If initialization was successful. Otherwise, a propagated error code is
* returned.
*/
uint32_t bsp_btn_ble_init(bsp_btn_ble_error_handler_t error_handler, bsp_event_t * p_startup_bsp_evt);
/**@brief Function for setting up wakeup buttons before going into sleep mode.
*
* @retval NRF_SUCCESS If the buttons were prepared successfully. Otherwise, a propagated error
* code is returned.
*/
uint32_t bsp_btn_ble_sleep_mode_prepare(void);
/**@brief Function for handling the application's BLE stack events.
*
* @details This function handles all events from the BLE stack that are of interest to this module.
*
* @param[in] p_ble_evt BLE stack event.
*/
void bsp_btn_ble_on_ble_evt(ble_evt_t * p_ble_evt);
#endif /* BSP_BTN_BLE_H__ */
/** @} */
|
