ESP8266 按键检测处理程序介绍

前言

ESP8266的SDK已经为我们写好了有关按键检测的程序，这样大大节省了软件的开发时间。有关按键的程序在SDK根目录下的driver_lib文件夹中的key.c和key.h。

相关API介绍

一、相关结构体介绍

结构体名称	功能介绍
single_key_param	存储按键相关配置数据

成员名称	数据类型	功能简介
key_level	uint8	按键处理流程标号
gpio_id	uint8	GPIO引脚号（0-15）
gpio_func	uint8	GPIO 功能(详见ESP8266 管脚清单.xlsx)
gpio_name	uint32	GPIO MUX寄存器（参见gpio.h）
key_5s	os_timer_t	定时器相关数据结构(详见SDK开发文档)
key_50ms	os_timer_t	定时器相关数据结构(详见SDK开发文档)
short_press	key_function	按键短按处理程序
long_press	key_function	按键长按处理程序

结构体原型

/** 按键处理函数 数据类型 */
typedef void (* key_function)(void);

struct single_key_param 
{
    uint8 key_level;
    uint8 gpio_id;
    uint8 gpio_func;
    uint32 gpio_name;
    os_timer_t key_5s;
    os_timer_t key_50ms;
    key_function short_press;
    key_function long_press;
};

---

结构体名称	功能介绍
keys_param	存储按键参数

成员名称	数据类型	功能简介
key_num	uint8	按键的数量
single_key	single_key_param **	按键的相关信息

结构体原型

struct keys_param 
{
    uint8 key_num;
    struct single_key_param **single_key;
};

二、按键相关参数初始化函数

功能介绍	初始化按键的相关参数	-
函数原型	struct single_key_param *ICACHE_FLASH_ATTR key_init_single(uint8 gpio_id, uint32 gpio_name, uint8 gpio_func, key_function long_press, key_function short_press)	-
参数介绍	gpio_id	GPIO的引脚号（0-15）
-	gpio_name	GPIO MUX寄存器(详见eagle_soc.h)
-	gpio_func	GPIO 功能(详见ESP8266 管脚清单.xlsx)
-	long_press	按键长按处理程序
-	short_press	按键短按处理程序
返回值介绍	返回一个由程序分配的存储着按键数据的指针	-

相关代码

struct single_key_param *ICACHE_FLASH_ATTR key_init_single(uint8 gpio_id, uint32 gpio_name, uint8 gpio_func, key_function long_press, key_function short_press)
{
    struct single_key_param *single_key = (struct single_key_param *)os_zalloc(sizeof(struct single_key_param));

    single_key->gpio_id = gpio_id;
    single_key->gpio_name = gpio_name;
    single_key->gpio_func = gpio_func;
    single_key->long_press = long_press;
    single_key->short_press = short_press;

    return single_key;
}

三 、按键初始化函数

功能介绍	初始化按键	-
函数原型	void ICACHE_FLASH_ATTR key_init(struct keys_param *keys)	-
参数介绍	*keys	按键信息

相关代码

void ICACHE_FLASH_ATTR key_init(struct keys_param *keys)
{
    uint8 i;

    /** 配置GPIO中断的中断服务函数 */
    ETS_GPIO_INTR_ATTACH(key_intr_handler, keys);

    /** 关闭GPIO中断 */
    ETS_GPIO_INTR_DISABLE();

    for (i = 0; i < keys->key_num; i++) 
    {
        keys->single_key[i]->key_level = 1;

        /** 配置引脚模式为GPIO模式 */
        PIN_FUNC_SELECT(keys->single_key[i]->gpio_name, keys->single_key[i]->gpio_func);

        /** 配置GPIO模式为输入模式 */
        gpio_output_set(0, 0, 0, GPIO_ID_PIN(keys->single_key[i]->gpio_id));

        /** 初始化GPIO中断配置 */
        gpio_register_set(GPIO_PIN_ADDR(keys->single_key[i]->gpio_id), GPIO_PIN_INT_TYPE_SET(GPIO_PIN_INTR_DISABLE)
                          | GPIO_PIN_PAD_DRIVER_SET(GPIO_PAD_DRIVER_DISABLE)
                          | GPIO_PIN_SOURCE_SET(GPIO_AS_PIN_SOURCE));

        /** 清除GPIO中断标志 */
        GPIO_REG_WRITE(GPIO_STATUS_W1TC_ADDRESS, BIT(keys->single_key[i]->gpio_id));

        /** 配置GPIO中断触发类型为下降沿触发 */
        gpio_pin_intr_state_set(GPIO_ID_PIN(keys->single_key[i]->gpio_id), GPIO_PIN_INTR_NEGEDGE);
    }

    /** 开启GPIO中断 */
    ETS_GPIO_INTR_ENABLE();
}

按键检测处理程序介绍

一、按键检测处理流程图

二、按键长按检测函数

static void ICACHE_FLASH_ATTR key_5s_cb(struct single_key_param *single_key)
{
    /** 关闭按键长按检测定时器 */
    os_timer_disarm(&single_key->key_5s);

    /** 按键处于按下状态 */
    if (0 == GPIO_INPUT_GET(GPIO_ID_PIN(single_key->gpio_id))) 
    {
        /** 执行按键长按处理函数 */
        if (single_key->long_press) 
        {
            single_key->long_press();
        }
    }
}

三、按键短按检测函数

static void ICACHE_FLASH_ATTR key_50ms_cb(struct single_key_param *single_key)
{
    /** 关闭按键短按检测定时器 */
    os_timer_disarm(&single_key->key_50ms);

    /** 按键处于松开状态 */
    if (1 == GPIO_INPUT_GET(GPIO_ID_PIN(single_key->gpio_id)))
    {
        /** 停止按键长按状态检测 */
        os_timer_disarm(&single_key->key_5s);

        single_key->key_level = 1;

        /** 设置该按键中断触发方式为下降沿触发(等待按键再次按下) */
        gpio_pin_intr_state_set(GPIO_ID_PIN(single_key->gpio_id), GPIO_PIN_INTR_NEGEDGE);

        /** 运行按键短按处理程序 */
        if (single_key->short_press) 
        {
            single_key->short_press();
        }
    } 
    else 
    {
        /** 设置该按键中断触发方式为上升沿触发(等待按键松开) */
        gpio_pin_intr_state_set(GPIO_ID_PIN(single_key->gpio_id), GPIO_PIN_INTR_POSEDGE);
    }
}

四、GPIO中断处理函数

static void key_intr_handler(struct keys_param *keys)
{
    uint8 i;
    uint32 gpio_status = GPIO_REG_READ(GPIO_STATUS_ADDRESS);

    for (i = 0; i < keys->key_num; i++) 
    {
        if (gpio_status & BIT(keys->single_key[i]->gpio_id)) 
        {
            /** 关闭该按键的中断 */
            gpio_pin_intr_state_set(GPIO_ID_PIN(keys->single_key[i]->gpio_id), GPIO_PIN_INTR_DISABLE);

            /** 清除该按键的中断标志 */
            GPIO_REG_WRITE(GPIO_STATUS_W1TC_ADDRESS, gpio_status & BIT(keys->single_key[i]->gpio_id));

            /** 按键处理流程一 */
            if (keys->single_key[i]->key_level == 1)
            {
                /** 启动按键长按检测定时器 */
                os_timer_disarm(&keys->single_key[i]->key_5s);
                os_timer_setfn(&keys->single_key[i]->key_5s, (os_timer_func_t *)key_5s_cb, keys->single_key[i]);
                os_timer_arm(&keys->single_key[i]->key_5s, 5000, 0);

                keys->single_key[i]->key_level = 0;

                /** 设置该按键中断触发方式为上升沿触发(等待按键松开) */
                gpio_pin_intr_state_set(GPIO_ID_PIN(keys->single_key[i]->gpio_id), GPIO_PIN_INTR_POSEDGE);
            } 
            /** 按键处理流程二 */
            else
            {
                /** 启动按键短按检测定时器 */
                os_timer_disarm(&keys->single_key[i]->key_50ms);
                os_timer_setfn(&keys->single_key[i]->key_50ms, (os_timer_func_t *)key_50ms_cb, keys->single_key[i]);
                os_timer_arm(&keys->single_key[i]->key_50ms, 50, 0);
            }
        }
    }
}

例程

#include "ets_sys.h"
#include "osapi.h"
#include "os_type.h"
#include "user_interface.h"
#include "eagle_soc.h"
#include "gpio.h"
#include "key.h"

/**
 *******************************************************************************
 * @brief      开关输入引脚配置
 *******************************************************************************
 */
#define SWITCH_Pin_NUM         5
#define SWITCH_Pin_FUNC        FUNC_GPIO5
#define SWITCH_Pin_MUX         PERIPHS_IO_MUX_GPIO5_U

#define SWITCH_Pin_Rd_Init()   GPIO_DIS_OUTPUT(SWITCH_Pin_NUM)
#define SWITCH_Pin_Wr_Init()   GPIO_OUTPUT_SET(SWITCH_Pin_NUM,0)
#define SWITCH_Pin_Set_High()  GPIO_OUTPUT_SET(SWITCH_Pin_NUM,1)
#define SWITCH_Pin_Set_Low()   GPIO_OUTPUT_SET(SWITCH_Pin_NUM,0)
#define SWITCH_Pin_State       ( GPIO_INPUT_GET(SWITCH_Pin_NUM) != 0 )

    /**
 *******************************************************************************
 * @brief     按键相关变量
 *******************************************************************************
 */
static struct keys_param switch_param;
static struct single_key_param *switch_signle;
static bool status = true;

/**
 *******************************************************************************
 * @brief       开关短按状态处理函数
 * @param       [in/out]  void
 * @return      void
 * @note        None
 *******************************************************************************
 */
static void Switch_ShortPress_Handler( void )
{
    if( status == true )
    {
        status = false;
    }
    else
    {
        status = true;
    }
}

/**
*******************************************************************************
 * @brief       输入初始化函数
 * @param       [in/out]  void
 * @return      void
 * @note        None
*******************************************************************************
 */
void drv_Switch_Init( void )
{
    switch_signle = key_init_single( SWITCH_Pin_NUM, SWITCH_Pin_MUX,
                                     SWITCH_Pin_FUNC,
                                     NULL,
                                     &Switch_ShortPress_Handler );
    switch_param.key_num = 1;
    switch_param.single_key = &switch_signle;

    key_init( &switch_param );
}