前言
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 );
}