first commit
This commit is contained in:
wenbo13579
550
ebtn/ebtn.c
Normal file
550
ebtn/ebtn.c
Normal file
@@ -0,0 +1,550 @@
|
||||
#include <string.h>
|
||||
#include "ebtn.h"
|
||||
|
||||
#define EBTN_FLAG_ONPRESS_SENT ((uint16_t)0x0001) /*!< Flag indicates that on-press event has been sent */
|
||||
#define EBTN_FLAG_IN_PROCESS ((uint16_t)0x0002) /*!< Flag indicates that button in process */
|
||||
|
||||
/* Default button group instance */
|
||||
static ebtn_t ebtn_default;
|
||||
|
||||
/**
|
||||
* \brief Process the button information and state
|
||||
*
|
||||
* \param[in] btn: Button instance to process
|
||||
* \param[in] old_state: old state
|
||||
* \param[in] new_state: new state
|
||||
* \param[in] mstime: Current milliseconds system time
|
||||
*/
|
||||
static void prv_process_btn(ebtn_btn_t *btn, uint8_t old_state, uint8_t new_state, ebtn_time_t mstime)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
|
||||
/* Check params set or not. */
|
||||
if (btn->param == NULL)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
/* Button state has just changed */
|
||||
if (new_state != old_state)
|
||||
{
|
||||
btn->time_state_change = mstime;
|
||||
|
||||
if (new_state)
|
||||
{
|
||||
btn->flags |= EBTN_FLAG_IN_PROCESS;
|
||||
}
|
||||
}
|
||||
/* Button is still pressed */
|
||||
if (new_state)
|
||||
{
|
||||
/*
|
||||
* Handle debounce and send on-press event
|
||||
*
|
||||
* This is when we detect valid press
|
||||
*/
|
||||
if (!(btn->flags & EBTN_FLAG_ONPRESS_SENT))
|
||||
{
|
||||
/*
|
||||
* Run if statement when:
|
||||
*
|
||||
* - Runtime mode is enabled -> user sets its own config for debounce
|
||||
* - Config debounce time for press is more than `0`
|
||||
*/
|
||||
if (ebtn_timer_sub(mstime, btn->time_state_change) >= btn->param->time_debounce)
|
||||
{
|
||||
/*
|
||||
* Check mutlti click limit reach or not.
|
||||
*/
|
||||
if ((btn->click_cnt > 0) && (ebtn_timer_sub(mstime, btn->click_last_time) >= btn->param->time_click_multi_max))
|
||||
{
|
||||
ebtobj->evt_fn(btn, EBTN_EVT_ONCLICK);
|
||||
btn->click_cnt = 0;
|
||||
}
|
||||
|
||||
/* Start with new on-press */
|
||||
btn->flags |= EBTN_FLAG_ONPRESS_SENT;
|
||||
ebtobj->evt_fn(btn, EBTN_EVT_ONPRESS);
|
||||
|
||||
/* Set keep alive time */
|
||||
btn->keepalive_last_time = mstime;
|
||||
btn->keepalive_cnt = 0;
|
||||
|
||||
btn->time_change = mstime; /* Button state has now changed */
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* Handle keep alive, but only if on-press event has been sent
|
||||
*
|
||||
* Keep alive is sent when valid press is being detected
|
||||
*/
|
||||
else
|
||||
{
|
||||
while ((btn->param->time_keepalive_period > 0) && (ebtn_timer_sub(mstime, btn->keepalive_last_time) >= btn->param->time_keepalive_period))
|
||||
{
|
||||
btn->keepalive_last_time += btn->param->time_keepalive_period;
|
||||
++btn->keepalive_cnt;
|
||||
ebtobj->evt_fn(btn, EBTN_EVT_KEEPALIVE);
|
||||
}
|
||||
|
||||
// Scene1: multi click end with a long press, need send onclick event.
|
||||
if ((btn->click_cnt > 0) && (ebtn_timer_sub(mstime, btn->time_change) > btn->param->time_click_pressed_max))
|
||||
{
|
||||
ebtobj->evt_fn(btn, EBTN_EVT_ONCLICK);
|
||||
|
||||
btn->click_cnt = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
/* Button is still released */
|
||||
else
|
||||
{
|
||||
/*
|
||||
* We only need to react if on-press event has even been started.
|
||||
*
|
||||
* Do nothing if that was not the case
|
||||
*/
|
||||
if (btn->flags & EBTN_FLAG_ONPRESS_SENT)
|
||||
{
|
||||
/*
|
||||
* Run if statement when:
|
||||
*
|
||||
* - Runtime mode is enabled -> user sets its own config for debounce
|
||||
* - Config debounce time for release is more than `0`
|
||||
*/
|
||||
if (ebtn_timer_sub(mstime, btn->time_state_change) >= btn->param->time_debounce_release)
|
||||
{
|
||||
/* Handle on-release event */
|
||||
btn->flags &= ~EBTN_FLAG_ONPRESS_SENT;
|
||||
ebtobj->evt_fn(btn, EBTN_EVT_ONRELEASE);
|
||||
|
||||
/* Check time validity for click event */
|
||||
if (ebtn_timer_sub(mstime, btn->time_change) >= btn->param->time_click_pressed_min &&
|
||||
ebtn_timer_sub(mstime, btn->time_change) <= btn->param->time_click_pressed_max)
|
||||
{
|
||||
++btn->click_cnt;
|
||||
|
||||
btn->click_last_time = mstime;
|
||||
}
|
||||
else
|
||||
{
|
||||
// Scene2: If last press was too short, and previous sequence of clicks was
|
||||
// positive, send event to user.
|
||||
if ((btn->click_cnt > 0) && (ebtn_timer_sub(mstime, btn->time_change) < btn->param->time_click_pressed_min))
|
||||
{
|
||||
ebtobj->evt_fn(btn, EBTN_EVT_ONCLICK);
|
||||
}
|
||||
/*
|
||||
* There was an on-release event, but timing
|
||||
* for click event detection is outside allowed window.
|
||||
*
|
||||
* Reset clicks counter -> not valid sequence for click event.
|
||||
*/
|
||||
btn->click_cnt = 0;
|
||||
}
|
||||
|
||||
// Scene3: this part will send on-click event immediately after release event, if
|
||||
// maximum number of consecutive clicks has been reached.
|
||||
if ((btn->click_cnt > 0) && (btn->click_cnt == btn->param->max_consecutive))
|
||||
{
|
||||
ebtobj->evt_fn(btn, EBTN_EVT_ONCLICK);
|
||||
btn->click_cnt = 0;
|
||||
}
|
||||
|
||||
btn->time_change = mstime; /* Button state has now changed */
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
/*
|
||||
* Based on te configuration, this part of the code
|
||||
* will send on-click event after certain timeout.
|
||||
*
|
||||
* This feature is useful if users prefers multi-click feature
|
||||
* that is reported only after last click event happened,
|
||||
* including number of clicks made by user
|
||||
*/
|
||||
if (btn->click_cnt > 0)
|
||||
{
|
||||
if (ebtn_timer_sub(mstime, btn->click_last_time) >= btn->param->time_click_multi_max)
|
||||
{
|
||||
ebtobj->evt_fn(btn, EBTN_EVT_ONCLICK);
|
||||
btn->click_cnt = 0;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// check button in process
|
||||
if (btn->flags & EBTN_FLAG_IN_PROCESS)
|
||||
{
|
||||
btn->flags &= ~EBTN_FLAG_IN_PROCESS;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
int ebtn_init(ebtn_btn_t *btns, uint16_t btns_cnt, ebtn_btn_combo_t *btns_combo, uint16_t btns_combo_cnt, ebtn_get_state_fn get_state_fn, ebtn_evt_fn evt_fn)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
|
||||
if (evt_fn == NULL || get_state_fn == NULL /* Parameter is a must only in callback-only mode */
|
||||
)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
memset(ebtobj, 0x00, sizeof(*ebtobj));
|
||||
ebtobj->btns = btns;
|
||||
ebtobj->btns_cnt = btns_cnt;
|
||||
ebtobj->btns_combo = btns_combo;
|
||||
ebtobj->btns_combo_cnt = btns_combo_cnt;
|
||||
ebtobj->evt_fn = evt_fn;
|
||||
ebtobj->get_state_fn = get_state_fn;
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* \brief Get all button state with get_state_fn.
|
||||
*
|
||||
* \param[out] state_array: store the button state
|
||||
*/
|
||||
static void ebtn_get_current_state(bit_array_t *state_array)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
ebtn_btn_dyn_t *target;
|
||||
int i;
|
||||
|
||||
/* Process all buttons */
|
||||
for (i = 0; i < ebtobj->btns_cnt; ++i)
|
||||
{
|
||||
/* Get button state */
|
||||
uint8_t new_state = ebtobj->get_state_fn(&ebtobj->btns[i]);
|
||||
// save state
|
||||
bit_array_assign(state_array, i, new_state);
|
||||
}
|
||||
|
||||
for (target = ebtobj->btn_dyn_head, i = ebtobj->btns_cnt; target; target = target->next, i++)
|
||||
{
|
||||
/* Get button state */
|
||||
uint8_t new_state = ebtobj->get_state_fn(&target->btn);
|
||||
|
||||
// save state
|
||||
bit_array_assign(state_array, i, new_state);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* \brief Process the button state
|
||||
*
|
||||
* \param[in] btn: Button instance to process
|
||||
* \param[in] old_state: all button old state
|
||||
* \param[in] curr_state: all button current state
|
||||
* \param[in] idx: Button internal key_idx
|
||||
* \param[in] mstime: Current milliseconds system time
|
||||
*/
|
||||
static void ebtn_process_btn(ebtn_btn_t *btn, bit_array_t *old_state, bit_array_t *curr_state, int idx, ebtn_time_t mstime)
|
||||
{
|
||||
prv_process_btn(btn, bit_array_get(old_state, idx), bit_array_get(curr_state, idx), mstime);
|
||||
}
|
||||
|
||||
/**
|
||||
* \brief Process the combo-button state
|
||||
*
|
||||
* \param[in] btn: Button instance to process
|
||||
* \param[in] old_state: all button old state
|
||||
* \param[in] curr_state: all button current state
|
||||
* \param[in] comb_key: Combo key
|
||||
* \param[in] mstime: Current milliseconds system time
|
||||
*/
|
||||
static void ebtn_process_btn_combo(ebtn_btn_t *btn, bit_array_t *old_state, bit_array_t *curr_state, bit_array_t *comb_key, ebtn_time_t mstime)
|
||||
{
|
||||
BIT_ARRAY_DEFINE(tmp_data, EBTN_MAX_KEYNUM) = {0};
|
||||
|
||||
if (bit_array_num_bits_set(comb_key, EBTN_MAX_KEYNUM) == 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
bit_array_and(tmp_data, curr_state, comb_key, EBTN_MAX_KEYNUM);
|
||||
uint8_t curr = bit_array_cmp(tmp_data, comb_key, EBTN_MAX_KEYNUM) == 0;
|
||||
|
||||
bit_array_and(tmp_data, old_state, comb_key, EBTN_MAX_KEYNUM);
|
||||
uint8_t old = bit_array_cmp(tmp_data, comb_key, EBTN_MAX_KEYNUM) == 0;
|
||||
|
||||
prv_process_btn(btn, old, curr, mstime);
|
||||
}
|
||||
|
||||
void ebtn_process_with_curr_state(bit_array_t *curr_state, ebtn_time_t mstime)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
ebtn_btn_dyn_t *target;
|
||||
ebtn_btn_combo_dyn_t *target_combo;
|
||||
int i;
|
||||
|
||||
/* Process all buttons */
|
||||
for (i = 0; i < ebtobj->btns_cnt; ++i)
|
||||
{
|
||||
ebtn_process_btn(&ebtobj->btns[i], ebtobj->old_state, curr_state, i, mstime);
|
||||
}
|
||||
|
||||
for (target = ebtobj->btn_dyn_head, i = ebtobj->btns_cnt; target; target = target->next, i++)
|
||||
{
|
||||
ebtn_process_btn(&target->btn, ebtobj->old_state, curr_state, i, mstime);
|
||||
}
|
||||
|
||||
/* Process all comb buttons */
|
||||
for (i = 0; i < ebtobj->btns_combo_cnt; ++i)
|
||||
{
|
||||
ebtn_process_btn_combo(&ebtobj->btns_combo[i].btn, ebtobj->old_state, curr_state, ebtobj->btns_combo[i].comb_key, mstime);
|
||||
}
|
||||
|
||||
for (target_combo = ebtobj->btn_combo_dyn_head; target_combo; target_combo = target_combo->next)
|
||||
{
|
||||
ebtn_process_btn_combo(&target_combo->btn.btn, ebtobj->old_state, curr_state, target_combo->btn.comb_key, mstime);
|
||||
}
|
||||
|
||||
bit_array_copy_all(ebtobj->old_state, curr_state, EBTN_MAX_KEYNUM);
|
||||
}
|
||||
|
||||
void ebtn_process(ebtn_time_t mstime)
|
||||
{
|
||||
BIT_ARRAY_DEFINE(curr_state, EBTN_MAX_KEYNUM) = {0};
|
||||
|
||||
// Get Current State
|
||||
ebtn_get_current_state(curr_state);
|
||||
|
||||
ebtn_process_with_curr_state(curr_state, mstime);
|
||||
}
|
||||
|
||||
int ebtn_get_total_btn_cnt(void)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
int total_cnt = 0;
|
||||
ebtn_btn_dyn_t *curr = ebtobj->btn_dyn_head;
|
||||
|
||||
total_cnt += ebtobj->btns_cnt;
|
||||
|
||||
while (curr)
|
||||
{
|
||||
total_cnt++;
|
||||
curr = curr->next;
|
||||
}
|
||||
return total_cnt;
|
||||
}
|
||||
|
||||
int ebtn_get_btn_index_by_key_id(uint16_t key_id)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
int i = 0;
|
||||
ebtn_btn_dyn_t *target;
|
||||
|
||||
for (i = 0; i < ebtobj->btns_cnt; ++i)
|
||||
{
|
||||
if (ebtobj->btns[i].key_id == key_id)
|
||||
{
|
||||
return i;
|
||||
}
|
||||
}
|
||||
|
||||
for (target = ebtobj->btn_dyn_head, i = ebtobj->btns_cnt; target; target = target->next, i++)
|
||||
{
|
||||
if (target->btn.key_id == key_id)
|
||||
{
|
||||
return i;
|
||||
}
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
ebtn_btn_t *ebtn_get_btn_by_key_id(uint16_t key_id)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
int i = 0;
|
||||
ebtn_btn_dyn_t *target;
|
||||
|
||||
for (i = 0; i < ebtobj->btns_cnt; ++i)
|
||||
{
|
||||
if (ebtobj->btns[i].key_id == key_id)
|
||||
{
|
||||
return &ebtobj->btns[i];
|
||||
}
|
||||
}
|
||||
|
||||
for (target = ebtobj->btn_dyn_head, i = ebtobj->btns_cnt; target; target = target->next, i++)
|
||||
{
|
||||
if (target->btn.key_id == key_id)
|
||||
{
|
||||
return &target->btn;
|
||||
}
|
||||
}
|
||||
|
||||
return NULL;
|
||||
}
|
||||
|
||||
int ebtn_get_btn_index_by_btn(ebtn_btn_t *btn)
|
||||
{
|
||||
return ebtn_get_btn_index_by_key_id(btn->key_id);
|
||||
}
|
||||
|
||||
int ebtn_get_btn_index_by_btn_dyn(ebtn_btn_dyn_t *btn)
|
||||
{
|
||||
return ebtn_get_btn_index_by_key_id(btn->btn.key_id);
|
||||
}
|
||||
|
||||
void ebtn_combo_btn_add_btn_by_idx(ebtn_btn_combo_t *btn, int idx)
|
||||
{
|
||||
bit_array_set(btn->comb_key, idx);
|
||||
}
|
||||
|
||||
void ebtn_combo_btn_remove_btn_by_idx(ebtn_btn_combo_t *btn, int idx)
|
||||
{
|
||||
bit_array_clear(btn->comb_key, idx);
|
||||
}
|
||||
|
||||
void ebtn_combo_btn_add_btn(ebtn_btn_combo_t *btn, uint16_t key_id)
|
||||
{
|
||||
int idx = ebtn_get_btn_index_by_key_id(key_id);
|
||||
if (idx < 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
ebtn_combo_btn_add_btn_by_idx(btn, idx);
|
||||
}
|
||||
|
||||
void ebtn_combo_btn_remove_btn(ebtn_btn_combo_t *btn, uint16_t key_id)
|
||||
{
|
||||
int idx = ebtn_get_btn_index_by_key_id(key_id);
|
||||
if (idx < 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
ebtn_combo_btn_remove_btn_by_idx(btn, idx);
|
||||
}
|
||||
|
||||
int ebtn_is_btn_active(const ebtn_btn_t *btn)
|
||||
{
|
||||
return btn != NULL && (btn->flags & EBTN_FLAG_ONPRESS_SENT);
|
||||
}
|
||||
|
||||
int ebtn_is_btn_in_process(const ebtn_btn_t *btn)
|
||||
{
|
||||
return btn != NULL && (btn->flags & EBTN_FLAG_IN_PROCESS);
|
||||
}
|
||||
|
||||
int ebtn_is_in_process(void)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
ebtn_btn_dyn_t *target;
|
||||
ebtn_btn_combo_dyn_t *target_combo;
|
||||
int i;
|
||||
|
||||
/* Process all buttons */
|
||||
for (i = 0; i < ebtobj->btns_cnt; ++i)
|
||||
{
|
||||
if (ebtn_is_btn_in_process(&ebtobj->btns[i]))
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
for (target = ebtobj->btn_dyn_head, i = ebtobj->btns_cnt; target; target = target->next, i++)
|
||||
{
|
||||
if (ebtn_is_btn_in_process(&target->btn))
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
/* Process all comb buttons */
|
||||
for (i = 0; i < ebtobj->btns_combo_cnt; ++i)
|
||||
{
|
||||
if (ebtn_is_btn_in_process(&ebtobj->btns_combo[i].btn))
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
for (target_combo = ebtobj->btn_combo_dyn_head; target_combo; target_combo = target_combo->next)
|
||||
{
|
||||
if (ebtn_is_btn_in_process(&target_combo->btn.btn))
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
int ebtn_register(ebtn_btn_dyn_t *button)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
|
||||
ebtn_btn_dyn_t *curr = ebtobj->btn_dyn_head;
|
||||
ebtn_btn_dyn_t *last = NULL;
|
||||
|
||||
if (!button)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (ebtn_get_total_btn_cnt() >= EBTN_MAX_KEYNUM)
|
||||
{
|
||||
return 0; /* reach max cnt. */
|
||||
}
|
||||
|
||||
if (curr == NULL)
|
||||
{
|
||||
ebtobj->btn_dyn_head = button;
|
||||
return 1;
|
||||
}
|
||||
|
||||
while (curr)
|
||||
{
|
||||
if (curr == button)
|
||||
{
|
||||
return 0; /* already exist. */
|
||||
}
|
||||
last = curr;
|
||||
curr = curr->next;
|
||||
}
|
||||
|
||||
last->next = button;
|
||||
|
||||
return 1;
|
||||
}
|
||||
|
||||
int ebtn_combo_register(ebtn_btn_combo_dyn_t *button)
|
||||
{
|
||||
ebtn_t *ebtobj = &ebtn_default;
|
||||
|
||||
ebtn_btn_combo_dyn_t *curr = ebtobj->btn_combo_dyn_head;
|
||||
ebtn_btn_combo_dyn_t *last = NULL;
|
||||
|
||||
if (!button)
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
|
||||
if (curr == NULL)
|
||||
{
|
||||
ebtobj->btn_combo_dyn_head = button;
|
||||
return 1;
|
||||
}
|
||||
|
||||
while (curr)
|
||||
{
|
||||
if (curr == button)
|
||||
{
|
||||
return 0; /* already exist. */
|
||||
}
|
||||
last = curr;
|
||||
curr = curr->next;
|
||||
}
|
||||
|
||||
last->next = button;
|
||||
|
||||
return 1;
|
||||
}
|
||||
Reference in New Issue
Block a user