examples/all-clusters-minimal-app/esp32/main/include/Button.h

/*
 *
 *    Copyright (c) 2022 Project CHIP Authors
 *    All rights reserved.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */

/**
 * @file Button.h
 *
 * Describes a Button tied to a GPIO that provides debouncing
 *
 **/

#pragma once

#include "driver/gpio.h"
#include "esp_log.h"
#include "esp_system.h"
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/timers.h"

#define APP_BUTTON_PRESSED 0
#define APP_BUTTON_RELEASED 1
#define BUTTON_NUMBER 3
class Button
{
public:
    /**
     * @brief
     *  construct a button
     */
    Button();
    /**
     * @brief
     *  construct a button with given GPIO number
     */
    Button(gpio_num_t gpioNum);
    /**
     * @brief
     *  Initialize a button
     * @return esp_err_t
     */
    esp_err_t Init();
    /**
     * @brief
     *  Initialize a button with given GPIO number
     * @param gpioNum           The GPIO pin this button should keep track of
     * @return esp_err_t
     */
    esp_err_t Init(gpio_num_t gpioNum);
    /**
     * @brief
     *  Get the pin number assosiate to a button
     * @return gpio_num_t
     */
    inline gpio_num_t GetGPIONum();
    /**
     * @brief
     *  Global Button debouncing Timer Callback function
     */
    static void TimerCallback(TimerHandle_t xTimer);
    /**
     * @brief
     *  Button gpio isr
     */
    friend void IRAM_ATTR button_isr_handler(void * arg);

private:
    gpio_num_t mGPIONum;
    TimerHandle_t mbuttonTimer; // FreeRTOS timers used for debouncing buttons
};

inline gpio_num_t Button::GetGPIONum()
{
    return mGPIONum;
}