141 lines
5.9 KiB
C
141 lines
5.9 KiB
C
/**
|
|
* Copyright (c) 2012 - 2019, Nordic Semiconductor ASA
|
|
*
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without modification,
|
|
* are permitted provided that the following conditions are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright notice, this
|
|
* list of conditions and the following disclaimer.
|
|
*
|
|
* 2. Redistributions in binary form, except as embedded into a Nordic
|
|
* Semiconductor ASA integrated circuit in a product or a software update for
|
|
* such product, must reproduce the above copyright notice, this list of
|
|
* conditions and the following disclaimer in the documentation and/or other
|
|
* materials provided with the distribution.
|
|
*
|
|
* 3. Neither the name of Nordic Semiconductor ASA nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* 4. This software, with or without modification, must only be used with a
|
|
* Nordic Semiconductor ASA integrated circuit.
|
|
*
|
|
* 5. Any software provided in binary form under this license must not be reverse
|
|
* engineered, decompiled, modified and/or disassembled.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
|
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
|
|
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
|
|
* GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
|
|
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*/
|
|
/** @file
|
|
*
|
|
* @defgroup app_button Button Handler
|
|
* @{
|
|
* @ingroup app_common
|
|
*
|
|
* @brief Buttons handling module.
|
|
*
|
|
* @details The button handler uses the @ref app_gpiote to detect that a button has been
|
|
* pushed. To handle debouncing, it will start a timer in the GPIOTE event handler.
|
|
* The button will only be reported as pushed if the corresponding pin is still active when
|
|
* the timer expires. If there is a new GPIOTE event while the timer is running, the timer
|
|
* is restarted.
|
|
*
|
|
* @note The app_button module uses the app_timer module. The user must ensure that the queue in
|
|
* app_timer is large enough to hold the app_timer_stop() / app_timer_start() operations
|
|
* which will be executed on each event from GPIOTE module (2 operations), as well as other
|
|
* app_timer operations queued simultaneously in the application.
|
|
*
|
|
* @note Even if the scheduler is not used, app_button.h will include app_scheduler.h, so when
|
|
* compiling, app_scheduler.h must be available in one of the compiler include paths.
|
|
*/
|
|
|
|
#ifndef APP_BUTTON_H__
|
|
#define APP_BUTTON_H__
|
|
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "nrf.h"
|
|
#include "app_error.h"
|
|
#include "nrf_gpio.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#define APP_BUTTON_PUSH 1 /**< Indicates that a button is pushed. */
|
|
#define APP_BUTTON_RELEASE 0 /**< Indicates that a button is released. */
|
|
#define APP_BUTTON_ACTIVE_HIGH 1 /**< Indicates that a button is active high. */
|
|
#define APP_BUTTON_ACTIVE_LOW 0 /**< Indicates that a button is active low. */
|
|
|
|
/**@brief Button event handler type. */
|
|
typedef void (*app_button_handler_t)(uint8_t pin_no, uint8_t button_action);
|
|
|
|
/**@brief Button configuration structure. */
|
|
typedef struct
|
|
{
|
|
uint8_t pin_no; /**< Pin to be used as a button. */
|
|
uint8_t active_state; /**< APP_BUTTON_ACTIVE_HIGH or APP_BUTTON_ACTIVE_LOW. */
|
|
#if defined(BUTTON_HIGH_ACCURACY_ENABLED) && (BUTTON_HIGH_ACCURACY_ENABLED == 1)
|
|
bool hi_accuracy; /**< True if GPIOTE high accuracy (IN_EVENT) is used. */
|
|
#endif
|
|
nrf_gpio_pin_pull_t pull_cfg; /**< Pull-up or -down configuration. */
|
|
app_button_handler_t button_handler; /**< Handler to be called when button is pushed. */
|
|
} app_button_cfg_t;
|
|
|
|
/**@brief Function for initializing the Buttons.
|
|
*
|
|
* @details This function will initialize the specified pins as buttons, and configure the Button
|
|
* Handler module as a GPIOTE user (but it will not enable button detection).
|
|
*
|
|
* @note app_button_enable() function must be called in order to enable the button detection.
|
|
*
|
|
* @param[in] p_buttons Array of buttons to be used (NOTE: Must be static!).
|
|
* @param[in] button_count Number of buttons.
|
|
* @param[in] detection_delay Delay from a GPIOTE event until a button is reported as pushed.
|
|
*
|
|
* @return NRF_SUCCESS on success, otherwise an error code.
|
|
*/
|
|
uint32_t app_button_init(app_button_cfg_t const * p_buttons,
|
|
uint8_t button_count,
|
|
uint32_t detection_delay);
|
|
|
|
/**@brief Function for enabling button detection.
|
|
*
|
|
* @retval NRF_SUCCESS Module successfully enabled.
|
|
*/
|
|
uint32_t app_button_enable(void);
|
|
|
|
/**@brief Function for disabling button detection.
|
|
*
|
|
* @retval NRF_SUCCESS Button detection successfully disabled. Error code otherwise.
|
|
*/
|
|
uint32_t app_button_disable(void);
|
|
|
|
/**@brief Function for checking if a button is currently being pushed.
|
|
*
|
|
* @param[in] button_id Button index (in the app_button_cfg_t array given to app_button_init) to be checked.
|
|
*
|
|
* @return Button state.
|
|
*/
|
|
bool app_button_is_pushed(uint8_t button_id);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // APP_BUTTON_H__
|
|
|
|
/** @} */
|