|
|
|
|
@ -23,81 +23,219 @@ |
|
|
|
|
#include "uibuttons.h" |
|
|
|
|
#include <circle/logger.h> |
|
|
|
|
#include <assert.h> |
|
|
|
|
#include <circle/timer.h> |
|
|
|
|
#include <string.h> |
|
|
|
|
|
|
|
|
|
LOGMODULE ("uibuttons"); |
|
|
|
|
|
|
|
|
|
CUIButton::CUIButton (unsigned nPin) |
|
|
|
|
: m_nPin (nPin), |
|
|
|
|
m_pPin (0), |
|
|
|
|
m_nLastValue (0) |
|
|
|
|
{ |
|
|
|
|
CUIButton::CUIButton (void) |
|
|
|
|
: m_pinNumber (0), |
|
|
|
|
m_pin (0), |
|
|
|
|
m_lastValue (1), |
|
|
|
|
m_timer (LONG_PRESS_TIME), |
|
|
|
|
m_debounceTimer (DEBOUNCE_TIME), |
|
|
|
|
m_numClicks (0), |
|
|
|
|
m_clickEvent(BtnEventNone), |
|
|
|
|
m_doubleClickEvent(BtnEventNone), |
|
|
|
|
m_longPressEvent(BtnEventNone) { |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
CUIButton::~CUIButton (void) |
|
|
|
|
{ |
|
|
|
|
if (m_pPin) |
|
|
|
|
if (m_pin) |
|
|
|
|
{ |
|
|
|
|
delete m_pPin; |
|
|
|
|
delete m_pin; |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
boolean CUIButton::Initialize (void) |
|
|
|
|
void CUIButton::reset (void) |
|
|
|
|
{ |
|
|
|
|
assert (!m_pPin); |
|
|
|
|
m_timer = LONG_PRESS_TIME; |
|
|
|
|
m_numClicks = 0; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
boolean CUIButton::Initialize (unsigned pinNumber) |
|
|
|
|
{ |
|
|
|
|
assert (!m_pin); |
|
|
|
|
|
|
|
|
|
m_pinNumber = pinNumber; |
|
|
|
|
|
|
|
|
|
if (m_nPin != 0) |
|
|
|
|
if (m_pinNumber != 0) |
|
|
|
|
{ |
|
|
|
|
m_pPin = new CGPIOPin (m_nPin, GPIOModeInputPullUp); |
|
|
|
|
m_pin = new CGPIOPin (m_pinNumber, GPIOModeInputPullUp); |
|
|
|
|
} |
|
|
|
|
return TRUE; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
#define DEBOUNCER 50 |
|
|
|
|
void CUIButton::setClickEvent(BtnEvent clickEvent) |
|
|
|
|
{ |
|
|
|
|
m_clickEvent = clickEvent; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
void CUIButton::setDoubleClickEvent(BtnEvent doubleClickEvent) |
|
|
|
|
{ |
|
|
|
|
m_doubleClickEvent = doubleClickEvent; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
void CUIButton::setLongPressEvent(BtnEvent longPressEvent) |
|
|
|
|
{ |
|
|
|
|
m_longPressEvent = longPressEvent; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
boolean CUIButton::Read (void) |
|
|
|
|
unsigned CUIButton::getPinNumber(void) |
|
|
|
|
{ |
|
|
|
|
if (!m_pPin) |
|
|
|
|
return m_pinNumber; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
CUIButton::BtnTrigger CUIButton::ReadTrigger (void) |
|
|
|
|
{ |
|
|
|
|
if (!m_pin) |
|
|
|
|
{ |
|
|
|
|
// Always return "not pressed" if not configured
|
|
|
|
|
return FALSE; |
|
|
|
|
return BtnTriggerNone; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
unsigned nValue = m_pPin->Read(); |
|
|
|
|
unsigned value = m_pin->Read(); |
|
|
|
|
|
|
|
|
|
// TODO: handle long press
|
|
|
|
|
if (m_timer < LONG_PRESS_TIME) { |
|
|
|
|
m_timer++; |
|
|
|
|
|
|
|
|
|
if (m_timer == DOUBLE_CLICK_TIME && m_lastValue == 1 && m_numClicks == 1) { |
|
|
|
|
// The user has clicked and released the button once within the
|
|
|
|
|
// timeout - this must be a single click
|
|
|
|
|
reset(); |
|
|
|
|
LOGDBG ("Click"); |
|
|
|
|
return BtnTriggerClick; |
|
|
|
|
} |
|
|
|
|
if (m_timer == LONG_PRESS_TIME) { |
|
|
|
|
if (m_lastValue == 0 && m_numClicks == 1) { |
|
|
|
|
// Single long press
|
|
|
|
|
reset(); |
|
|
|
|
LOGDBG ("Long Press"); |
|
|
|
|
return BtnTriggerLongPress; |
|
|
|
|
} |
|
|
|
|
else { |
|
|
|
|
// Just reset it - we've run out of possible interactions
|
|
|
|
|
reset(); |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Debounce here - we don't need to do anything if the debounce timer is active
|
|
|
|
|
if (m_debounceTimer < DEBOUNCE_TIME) { |
|
|
|
|
m_debounceTimer++; |
|
|
|
|
return BtnTriggerNone; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Buttons in PULL UP mode are "active low"
|
|
|
|
|
if (nValue == 0) |
|
|
|
|
if (value == 0) |
|
|
|
|
{ |
|
|
|
|
// Some simple debouncing...
|
|
|
|
|
if (m_nLastValue < DEBOUNCER) |
|
|
|
|
{ |
|
|
|
|
m_nLastValue++; |
|
|
|
|
if (m_lastValue == 0) { |
|
|
|
|
// 0 -> 0 : Button is pressed, was already pressed
|
|
|
|
|
} |
|
|
|
|
else if (m_nLastValue == DEBOUNCER) |
|
|
|
|
{ |
|
|
|
|
m_nLastValue++; |
|
|
|
|
return TRUE; |
|
|
|
|
} |
|
|
|
|
else |
|
|
|
|
{ |
|
|
|
|
// Do nothing until reset/cleared
|
|
|
|
|
else { |
|
|
|
|
// 1 -> 0 : Button was not pressed but is now pressed
|
|
|
|
|
m_lastValue = 0; |
|
|
|
|
m_debounceTimer = 0; |
|
|
|
|
LOGDBG ("Down"); |
|
|
|
|
|
|
|
|
|
if (m_numClicks == 0) { |
|
|
|
|
// No clicks recorded - start a new timer
|
|
|
|
|
m_timer = 0; |
|
|
|
|
} |
|
|
|
|
if (m_numClicks < 2) { |
|
|
|
|
m_numClicks++; |
|
|
|
|
} |
|
|
|
|
if (m_numClicks == 2) { |
|
|
|
|
reset(); |
|
|
|
|
LOGDBG ("Double Click"); |
|
|
|
|
return BtnTriggerDoubleClick; |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
else |
|
|
|
|
{ |
|
|
|
|
m_nLastValue = 0; |
|
|
|
|
if (m_lastValue == 1) { |
|
|
|
|
// 1 -> 1 : Button is not pressed, was already not pressed
|
|
|
|
|
} |
|
|
|
|
else { |
|
|
|
|
// 0 -> 1 : Button was pressed but is now not pressed
|
|
|
|
|
m_lastValue = 1; |
|
|
|
|
m_debounceTimer = 0; |
|
|
|
|
LOGDBG ("Up"); |
|
|
|
|
|
|
|
|
|
if (m_timer >= DOUBLE_CLICK_TIME && m_timer < LONG_PRESS_TIME && m_numClicks == 1) { |
|
|
|
|
// The user released the button after the double click
|
|
|
|
|
// timeout, but before the long press timeout
|
|
|
|
|
reset(); |
|
|
|
|
LOGDBG ("Click"); |
|
|
|
|
return BtnTriggerClick; |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
return FALSE; |
|
|
|
|
return BtnTriggerNone; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
CUIButton::BtnEvent CUIButton::Read (void) { |
|
|
|
|
BtnTrigger trigger = ReadTrigger(); |
|
|
|
|
|
|
|
|
|
if (trigger == BtnTriggerClick) { |
|
|
|
|
return m_clickEvent; |
|
|
|
|
} |
|
|
|
|
else if (trigger == BtnTriggerDoubleClick) { |
|
|
|
|
return m_doubleClickEvent; |
|
|
|
|
} |
|
|
|
|
else if (trigger == BtnTriggerLongPress) { |
|
|
|
|
return m_longPressEvent; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
assert (trigger == BtnTriggerNone); |
|
|
|
|
|
|
|
|
|
return BtnEventNone; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
CUIButtons::CUIButtons (unsigned nPrevPin, unsigned nNextPin, unsigned nBackPin, unsigned nSelectPin, unsigned nHomePin) |
|
|
|
|
: m_PrevButton (nPrevPin), |
|
|
|
|
m_NextButton (nNextPin), |
|
|
|
|
m_BackButton (nBackPin), |
|
|
|
|
m_SelectButton (nSelectPin), |
|
|
|
|
m_HomeButton (nHomePin), |
|
|
|
|
m_pEventHandler (0) |
|
|
|
|
CUIButton::BtnTrigger CUIButton::triggerTypeFromString(const char* triggerString) |
|
|
|
|
{ |
|
|
|
|
if (strcmp(triggerString, "") == 0 || strcmp(triggerString, "none") == 0) { |
|
|
|
|
return BtnTriggerNone; |
|
|
|
|
} |
|
|
|
|
else if (strcmp(triggerString, "click") == 0) { |
|
|
|
|
return BtnTriggerClick; |
|
|
|
|
}
|
|
|
|
|
else if (strcmp(triggerString, "doubleclick") == 0) { |
|
|
|
|
return BtnTriggerDoubleClick; |
|
|
|
|
}
|
|
|
|
|
else if (strcmp(triggerString, "longpress") == 0) { |
|
|
|
|
return BtnTriggerLongPress; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
LOGERR("Invalid action: %s", triggerString); |
|
|
|
|
|
|
|
|
|
return BtnTriggerNone; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CUIButtons::CUIButtons ( |
|
|
|
|
unsigned prevPin, const char *prevAction, |
|
|
|
|
unsigned nextPin, const char *nextAction, |
|
|
|
|
unsigned backPin, const char *backAction, |
|
|
|
|
unsigned selectPin, const char *selectAction, |
|
|
|
|
unsigned homePin, const char *homeAction |
|
|
|
|
) |
|
|
|
|
: m_prevPin(prevPin), |
|
|
|
|
m_prevAction(CUIButton::triggerTypeFromString(prevAction)), |
|
|
|
|
m_nextPin(nextPin), |
|
|
|
|
m_nextAction(CUIButton::triggerTypeFromString(nextAction)), |
|
|
|
|
m_backPin(backPin), |
|
|
|
|
m_backAction(CUIButton::triggerTypeFromString(backAction)), |
|
|
|
|
m_selectPin(selectPin), |
|
|
|
|
m_selectAction(CUIButton::triggerTypeFromString(selectAction)), |
|
|
|
|
m_homePin(homePin), |
|
|
|
|
m_homeAction(CUIButton::triggerTypeFromString(homeAction)), |
|
|
|
|
m_eventHandler (0), |
|
|
|
|
m_lastTick (0) |
|
|
|
|
{ |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
@ -107,51 +245,116 @@ CUIButtons::~CUIButtons (void) |
|
|
|
|
|
|
|
|
|
boolean CUIButtons::Initialize (void) |
|
|
|
|
{ |
|
|
|
|
m_PrevButton.Initialize (); |
|
|
|
|
m_NextButton.Initialize (); |
|
|
|
|
m_BackButton.Initialize (); |
|
|
|
|
m_SelectButton.Initialize (); |
|
|
|
|
m_HomeButton.Initialize (); |
|
|
|
|
// Each button can be assigned up to 3 actions: click, doubleclick and
|
|
|
|
|
// longpress. We may not initialise all of the buttons
|
|
|
|
|
unsigned pins[MAX_BUTTONS] = { |
|
|
|
|
m_prevPin, m_nextPin, m_backPin, m_selectPin, m_homePin |
|
|
|
|
}; |
|
|
|
|
CUIButton::BtnTrigger triggers[MAX_BUTTONS] = { |
|
|
|
|
m_prevAction, m_nextAction, m_backAction, m_selectAction, m_homeAction |
|
|
|
|
// CUIButton::BtnTriggerNone,
|
|
|
|
|
// CUIButton::BtnTriggerNone,
|
|
|
|
|
// CUIButton::BtnTriggerDoubleClick,
|
|
|
|
|
// CUIButton::BtnTriggerClick,
|
|
|
|
|
// CUIButton::BtnTriggerLongPress
|
|
|
|
|
}; |
|
|
|
|
CUIButton::BtnEvent events[MAX_BUTTONS] = { |
|
|
|
|
CUIButton::BtnEventPrev, |
|
|
|
|
CUIButton::BtnEventNext, |
|
|
|
|
CUIButton::BtnEventBack, |
|
|
|
|
CUIButton::BtnEventSelect, |
|
|
|
|
CUIButton::BtnEventHome |
|
|
|
|
}; |
|
|
|
|
|
|
|
|
|
for (unsigned i=0; i<MAX_BUTTONS; i++) { |
|
|
|
|
// if this pin is 0 it means it's disabled - so continue
|
|
|
|
|
if (pins[i] == 0) { |
|
|
|
|
continue; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// Search through buttons and see if there is already a button with this
|
|
|
|
|
// pin number. If we find a 0 then the button is not initialised and is
|
|
|
|
|
// ready for this pin
|
|
|
|
|
for (unsigned j=0; j<MAX_BUTTONS; j++) { |
|
|
|
|
if (m_buttons[j].getPinNumber() == pins[i]) { |
|
|
|
|
// This pin is already assigned
|
|
|
|
|
break; |
|
|
|
|
} |
|
|
|
|
else if (m_buttons[j].getPinNumber() == 0) { |
|
|
|
|
// This is un-initialised so can be assigned
|
|
|
|
|
m_buttons[j].Initialize(pins[i]); |
|
|
|
|
break; |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
// All of the buttons are now initialised, they just need to have their
|
|
|
|
|
// events assigned to them
|
|
|
|
|
|
|
|
|
|
for (unsigned i=0; i<MAX_BUTTONS; i++) { |
|
|
|
|
bindButton(pins[i], triggers[i], events[i]); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
return TRUE; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
void CUIButtons::RegisterEventHandler (TBtnEventHandler *pHandler, void *pParam) |
|
|
|
|
void CUIButtons::bindButton(unsigned pinNumber, CUIButton::BtnTrigger trigger, CUIButton::BtnEvent event) |
|
|
|
|
{ |
|
|
|
|
// First find the button
|
|
|
|
|
bool found = false; |
|
|
|
|
for (unsigned i=0; i<MAX_BUTTONS; i++) { |
|
|
|
|
if (m_buttons[i].getPinNumber() == pinNumber) { |
|
|
|
|
// This is the one!
|
|
|
|
|
found = true; |
|
|
|
|
|
|
|
|
|
if (trigger == CUIButton::BtnTriggerClick) { |
|
|
|
|
m_buttons[i].setClickEvent(event); |
|
|
|
|
} |
|
|
|
|
else if (trigger == CUIButton::BtnTriggerDoubleClick) { |
|
|
|
|
m_buttons[i].setDoubleClickEvent(event); |
|
|
|
|
} |
|
|
|
|
else if (trigger == CUIButton::BtnTriggerLongPress) { |
|
|
|
|
m_buttons[i].setLongPressEvent(event); |
|
|
|
|
} |
|
|
|
|
else { |
|
|
|
|
assert (trigger == CUIButton::BtnTriggerNone); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
break; |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
assert(found); |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
void CUIButtons::RegisterEventHandler (BtnEventHandler *handler, void *param) |
|
|
|
|
{ |
|
|
|
|
assert (!m_pEventHandler); |
|
|
|
|
m_pEventHandler = pHandler; |
|
|
|
|
assert (m_pEventHandler); |
|
|
|
|
m_pEventParam = pParam; |
|
|
|
|
assert (!m_eventHandler); |
|
|
|
|
m_eventHandler = handler; |
|
|
|
|
assert (m_eventHandler); |
|
|
|
|
m_eventParam = param; |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
void CUIButtons::Update (void) |
|
|
|
|
{ |
|
|
|
|
assert (m_pEventHandler); |
|
|
|
|
assert (m_eventHandler); |
|
|
|
|
|
|
|
|
|
if (m_PrevButton.Read ()) |
|
|
|
|
{ |
|
|
|
|
LOGDBG ("Prev"); |
|
|
|
|
(*m_pEventHandler) (BtnEventPrev, m_pEventParam); |
|
|
|
|
} |
|
|
|
|
if (m_NextButton.Read ()) |
|
|
|
|
{ |
|
|
|
|
LOGDBG ("Next"); |
|
|
|
|
(*m_pEventHandler) (BtnEventNext, m_pEventParam); |
|
|
|
|
// Don't update unless enough time has elapsed.
|
|
|
|
|
// Get the current time in microseconds
|
|
|
|
|
unsigned currentTick = CTimer::GetClockTicks(); |
|
|
|
|
if (currentTick - m_lastTick < BUTTONS_UPDATE_NUM_TICKS) { |
|
|
|
|
// Not enough time has passed, just return
|
|
|
|
|
return; |
|
|
|
|
} |
|
|
|
|
if (m_BackButton.Read ()) |
|
|
|
|
{ |
|
|
|
|
LOGDBG ("Back"); |
|
|
|
|
(*m_pEventHandler) (BtnEventBack, m_pEventParam); |
|
|
|
|
} |
|
|
|
|
if (m_SelectButton.Read ()) |
|
|
|
|
{ |
|
|
|
|
LOGDBG ("Select"); |
|
|
|
|
(*m_pEventHandler) (BtnEventSelect, m_pEventParam); |
|
|
|
|
} |
|
|
|
|
if (m_HomeButton.Read ()) |
|
|
|
|
{ |
|
|
|
|
LOGDBG ("Home"); |
|
|
|
|
(*m_pEventHandler) (BtnEventHome, m_pEventParam); |
|
|
|
|
|
|
|
|
|
m_lastTick = currentTick; |
|
|
|
|
|
|
|
|
|
for (unsigned i=0; i<MAX_BUTTONS; i++) { |
|
|
|
|
CUIButton::BtnEvent event = m_buttons[i].Read(); |
|
|
|
|
if (event != CUIButton::BtnEventNone) { |
|
|
|
|
LOGDBG("Event: %u", event); |
|
|
|
|
(*m_eventHandler) (event, m_eventParam); |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
} |
|
|
|
|
|
|
|
|
|
|
Stephen Brown
3 years ago