First attempt at button user interface to replace rotary encoder. Very, very draft.

src/config.cpp

@@ -81,6 +81,13 @@ void CConfig::Load (void)
 	m_nLCDPinData7 = m_Properties.GetNumber ("LCDPinData7", 25);
 	m_nLCDI2CAddress = m_Properties.GetNumber ("LCDI2CAddress", 0);
 
+	m_bBTNEnabled = m_Properties.GetNumber ("BTNEnabled", 0) != 0;
+	m_nBTNPinLeft = m_Properties.GetNumber ("BTNPinLeft", 5);
+	m_nBTNPinRight = m_Properties.GetNumber ("BTNPinRight", 6);
+	m_nBTNPinUp = m_Properties.GetNumber ("BTNPinUp", 10);
+	m_nBTNPinDown = m_Properties.GetNumber ("BTNPinDown", 9);
+	m_nBTNPinSelect = m_Properties.GetNumber ("BTNPinSelect", 11);
+
 	m_bEncoderEnabled = m_Properties.GetNumber ("EncoderEnabled", 0) != 0;
 	m_nEncoderPinClock = m_Properties.GetNumber ("EncoderPinClock", 10);
 	m_nEncoderPinData = m_Properties.GetNumber ("EncoderPinData", 9);
@@ -180,6 +187,36 @@ unsigned CConfig::GetLCDI2CAddress (void) const
 	return m_nLCDI2CAddress;
 }
 
+bool CConfig::GetBTNEnabled (void) const
+{
+	return m_bBTNEnabled;
+}
+
+unsigned CConfig::GetBTNPinLeft (void) const
+{
+	return m_nBTNPinLeft;
+}
+
+unsigned CConfig::GetBTNPinRight (void) const
+{
+	return m_nBTNPinRight;
+}
+
+unsigned CConfig::GetBTNPinUp (void) const
+{
+	return m_nBTNPinUp;
+}
+
+unsigned CConfig::GetBTNPinDown (void) const
+{
+	return m_nBTNPinDown;
+}
+
+unsigned CConfig::GetBTNPinSelect (void) const
+{
+	return m_nBTNPinSelect;
+}
+
 bool CConfig::GetEncoderEnabled (void) const
 {
 	return m_bEncoderEnabled;

src/config.h

@@ -87,6 +87,15 @@ public:
 	unsigned GetLCDPinData6 (void) const;
 	unsigned GetLCDPinData7 (void) const;
 	unsigned GetLCDI2CAddress (void) const;
+	
+	// GPIO Button Navigation
+	// GPIO pin numbers are chip numbers, not header positions
+	bool GetBTNEnabled (void) const;
+	unsigned GetBTNPinLeft (void) const;
+	unsigned GetBTNPinRight (void) const;
+	unsigned GetBTNPinUp (void) const;
+	unsigned GetBTNPinDown (void) const;
+	unsigned GetBTNPinSelect (void) const;
 
 	// KY-040 Rotary Encoder
 	// GPIO pin numbers are chip numbers, not header positions
@@ -122,6 +131,13 @@ private:
 	unsigned m_nLCDPinData6;
 	unsigned m_nLCDPinData7;
 	unsigned m_nLCDI2CAddress;
+	
+	bool m_bBTNEnabled;
+	unsigned m_nBTNPinLeft;
+	unsigned m_nBTNPinRight;
+	unsigned m_nBTNPinUp;
+	unsigned m_nBTNPinDown;
+	unsigned m_nBTNPinSelect;
 
 	bool m_bEncoderEnabled;
 	unsigned m_nEncoderPinClock;

src/minidexed.ini

@@ -27,8 +27,16 @@ LCDPinData6=24
 LCDPinData7=25
 LCDI2CAddress=0x00
 
+# GPIO Button Navigation
+BTNEnabled=1
+BTNPinLeft=5
+BTNPinRight=6
+BTNPinUp=16
+BTNPinDown=20
+BTNPinSelect=12
+
 # KY-040 Rotary Encoder
-EncoderEnabled=1
+EncoderEnabled=0
 EncoderPinClock=10
 EncoderPinData=9
 EncoderPinSwitch=11

src/uibuttons.cpp

@@ -0,0 +1,132 @@
+//
+// uibuttons.cpp
+//
+// MiniDexed - Dexed FM synthesizer for bare metal Raspberry Pi
+// Copyright (C) 2022  The MiniDexed Team
+//
+// Original author of this class:
+//	R. Stange <rsta2@o2online.de>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+#include "uibuttons.h"
+#include <circle/logger.h>
+#include <assert.h>
+
+LOGMODULE ("uibuttons");
+
+CUIButton::CUIButton (unsigned nPin)
+:	m_Pin (nPin, GPIOModeInputPullUp),
+	m_nLastValue (0)
+{
+}
+
+CUIButton::~CUIButton (void)
+{
+}
+
+boolean CUIButton::Initialize (void)
+{
+	return TRUE;
+}
+
+#define DEBOUNCER 50
+
+boolean CUIButton::Read (void)
+{
+	unsigned nValue = m_Pin.Read();
+	
+	if (nValue != 0)
+	{
+		// Some simple debouncing...
+		if (m_nLastValue < DEBOUNCER)
+		{
+			m_nLastValue++;
+		}
+		else if (m_nLastValue == DEBOUNCER)
+		{
+			m_nLastValue++;
+			return TRUE;
+		}
+		else
+		{
+			// Do nothing until reset/cleared
+		}
+	}
+	else
+	{
+		m_nLastValue = 0;
+	}
+
+	return FALSE;
+}
+
+
+CUIButtons::CUIButtons (unsigned nLeftPin, unsigned nRightPin, unsigned nUpPin, unsigned nDownPin, unsigned nSelectPin)
+:	m_LeftButton (nLeftPin),
+	m_RightButton (nRightPin),
+	m_UpButton (nUpPin),
+	m_DownButton (nDownPin),
+	m_SelectButton (nSelectPin)
+{
+}
+
+CUIButtons::~CUIButtons (void)
+{
+}
+
+boolean CUIButtons::Initialize (void)
+{
+	return TRUE;
+}
+
+void CUIButtons::RegisterEventHandler (TBtnEventHandler *pHandler, void *pParam)
+{
+	assert (!m_pEventHandler);
+	m_pEventHandler = pHandler;
+	assert (m_pEventHandler);
+	m_pEventParam = pParam;
+}
+
+void CUIButtons::Update (void)
+{
+	assert (m_pEventHandler);
+
+	if (m_LeftButton.Read ())
+	{
+		LOGNOTE ("Left");
+		(*m_pEventHandler) (BtnEventLeft, m_pEventParam);
+	}
+	if (m_RightButton.Read ())
+	{
+		LOGNOTE ("Right");
+		(*m_pEventHandler) (BtnEventRight, m_pEventParam);
+	}
+	if (m_UpButton.Read ())
+	{
+		LOGNOTE ("Up");
+		(*m_pEventHandler) (BtnEventUp, m_pEventParam);
+	}
+	if (m_DownButton.Read ())
+	{
+		LOGNOTE ("Down");
+		(*m_pEventHandler) (BtnEventDown, m_pEventParam);
+	}
+	if (m_SelectButton.Read ())
+	{
+		LOGNOTE ("Select");
+		(*m_pEventHandler) (BtnEventSelect, m_pEventParam);
+	}
+}
+

src/uibuttons.h

@@ -0,0 +1,82 @@
+//
+// uibuttons.h
+//
+// MiniDexed - Dexed FM synthesizer for bare metal Raspberry Pi
+// Copyright (C) 2022  The MiniDexed Team
+//
+// Original author of this class:
+//	R. Stange <rsta2@o2online.de>
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+#ifndef _uibuttons_h
+#define _uibuttons_h
+
+#include <circle/gpiopin.h>
+#include <circle/types.h>
+#include "config.h"
+
+class CUIButton
+{
+public:
+	CUIButton (unsigned nPin);
+	~CUIButton (void);
+	
+	boolean Initialize (void);
+	
+	boolean Read (void);
+
+private:
+	CGPIOPin m_Pin;
+	unsigned m_nLastValue;
+};
+
+
+class CUIButtons
+{
+public:
+	enum TBtnEvent
+	{
+		BtnEventLeft,
+		BtnEventRight,
+		BtnEventUp,
+		BtnEventDown,
+		BtnEventSelect,
+		BtnEventUnknown
+	};
+	
+	typedef void TBtnEventHandler (TBtnEvent Event, void *pParam);
+
+public:
+	CUIButtons (unsigned nLeftPin, unsigned nRightPin, unsigned nUpPin, unsigned nDownPin, unsigned nSelectPin);
+	~CUIButtons (void);
+	
+	boolean Initialize (void);
+	
+	void RegisterEventHandler (TBtnEventHandler *pHandler, void *pParam = 0);
+	
+	void Update (void);
+	
+private:
+	CUIButton m_LeftButton;
+	CUIButton m_RightButton;
+	CUIButton m_UpButton;
+	CUIButton m_DownButton;
+	CUIButton m_SelectButton;
+
+	TBtnEventHandler *m_pEventHandler;
+	void *m_pEventParam;
+};
+
+#endif

src/userinterface.cpp

@@ -34,6 +34,7 @@ CUserInterface::CUserInterface (CMiniDexed *pMiniDexed, CGPIOManager *pGPIOManag
 	m_pConfig (pConfig),
 	m_pLCD (0),
 	m_pLCDBuffered (0),
+	m_pUIButtons (0),
 	m_pRotaryEncoder (0),
 	m_bSwitchPressed (false),
 	m_Menu (this, pMiniDexed)
@@ -43,6 +44,7 @@ CUserInterface::CUserInterface (CMiniDexed *pMiniDexed, CGPIOManager *pGPIOManag
 CUserInterface::~CUserInterface (void)
 {
 	delete m_pRotaryEncoder;
+	delete m_pUIButtons;
 	delete m_pLCDBuffered;
 	delete m_pLCD;
 }
@@ -85,6 +87,25 @@ bool CUserInterface::Initialize (void)
 		LOGDBG ("LCD initialized");
 	}
 
+	if (m_pConfig->GetBTNEnabled ())
+	{
+		m_pUIButtons = new CUIButtons (m_pConfig->GetBTNPinLeft (),
+					    	m_pConfig->GetBTNPinRight (),
+					       	m_pConfig->GetBTNPinUp (),
+							m_pConfig->GetBTNPinDown (),
+							m_pConfig->GetBTNPinSelect ());
+		assert (m_pUIButtons);
+
+		if (!m_pUIButtons->Initialize ())
+		{
+			return false;
+		}
+
+		m_pUIButtons->RegisterEventHandler (UIButtonsEventStub, this);
+
+		LOGDBG ("Button User Interface initialized");
+	}
+
 	if (m_pConfig->GetEncoderEnabled ())
 	{
 		m_pRotaryEncoder = new CKY040 (m_pConfig->GetEncoderPinClock (),
@@ -114,6 +135,10 @@ void CUserInterface::Process (void)
 	{
 		m_pLCDBuffered->Update ();
 	}
+	if (m_pUIButtons)
+	{
+		m_pUIButtons->Update();
+	}
 }
 
 void CUserInterface::ParameterChanged (void)
@@ -239,3 +264,40 @@ void CUserInterface::EncoderEventStub (CKY040::TEvent Event, void *pParam)
 
 	pThis->EncoderEventHandler (Event);
 }
+
+void CUserInterface::UIButtonsEventHandler (CUIButtons::TBtnEvent Event)
+{
+	switch (Event)
+	{
+	case CUIButtons::BtnEventUp:
+		m_Menu.EventHandler (CUIMenu::MenuEventStepUp);
+		break;
+
+	case CUIButtons::BtnEventDown:
+		m_Menu.EventHandler (CUIMenu::MenuEventStepDown);
+		break;
+
+	case CUIButtons::BtnEventLeft:
+		m_Menu.EventHandler (CUIMenu::MenuEventBack);
+		break;
+
+	case CUIButtons::BtnEventRight:
+		m_Menu.EventHandler (CUIMenu::MenuEventSelect);
+		break;
+
+	case CUIButtons::BtnEventSelect:
+		m_Menu.EventHandler (CUIMenu::MenuEventHome);
+		break;
+
+	default:
+		break;
+	}
+}
+
+void CUserInterface::UIButtonsEventStub (CUIButtons::TBtnEvent Event, void *pParam)
+{
+	CUserInterface *pThis = static_cast<CUserInterface *> (pParam);
+	assert (pThis != 0);
+
+	pThis->UIButtonsEventHandler (Event);
+}

src/userinterface.h

@@ -22,6 +22,7 @@
 
 #include "config.h"
 #include "uimenu.h"
+#include "uibuttons.h"
 #include <sensor/ky040.h>
 #include <display/hd44780device.h>
 #include <circle/gpiomanager.h>
@@ -55,6 +56,8 @@ private:
 
 	void EncoderEventHandler (CKY040::TEvent Event);
 	static void EncoderEventStub (CKY040::TEvent Event, void *pParam);
+	void UIButtonsEventHandler (CUIButtons::TBtnEvent Event);
+	static void UIButtonsEventStub (CUIButtons::TBtnEvent Event, void *pParam);
 
 private:
 	CMiniDexed *m_pMiniDexed;
@@ -64,6 +67,8 @@ private:
 
 	CHD44780Device *m_pLCD;
 	CWriteBufferDevice *m_pLCDBuffered;
+	
+	CUIButtons *m_pUIButtons;
 
 	CKY040 *m_pRotaryEncoder;
 	bool m_bSwitchPressed;