#include <MD_UISwitch.h>

Inheritance diagram for MD_UISwitch_Matrix:

Collaboration diagram for MD_UISwitch_Matrix:

Public Member Functions
Class constructor and destructor.
	MD_UISwitch_Matrix (uint8_t rows, uint8_t cols, uint8_t rowPin, uint8_t colPin, char *kt)

	~MD_UISwitch_Matrix ()

Methods for core object control.
virtual void	begin (void)

virtual keyResult_t	read (void)

Public Member Functions inherited from MD_UISwitch
	MD_UISwitch (void)

	~MD_UISwitch ()

virtual uint8_t	getKey (void)

void	setPressTime (uint16_t t)

void	setDoublePressTime (uint16_t t)

void	setLongPressTime (uint16_t t)

void	setRepeatTime (uint16_t t)

void	enableDoublePress (boolean f)

void	enableLongPress (boolean f)

void	enableRepeat (boolean f)

void	enableRepeatResult (boolean f)

Protected Attributes
uint8_t	_rows
	number of rows in the key matrix

uint8_t	_cols
	number of columns in the key matrix

uint8_t *	_rowPin
	array of pins connected to the rows

uint8_t *	_colPin
	array of pins connected to the columns

char *	_kt
	analog key values in a char string

Protected Attributes inherited from MD_UISwitch
state_fsm	_state
	the FSM current state

keyResult_t	_kPush
	storage for pushed key in FSM

uint32_t	_timeActive
	the millis() time switch was last activated

uint8_t	_enableFlags
	functions enabled/disabled

uint8_t	_RC = 0
	RC integrator value.

bool	_prevStatus
	previous 'active' status for edge detection

state_db	_RCstate
	current RC debouning state

uint16_t	_timePress
	press time in milliseconds

uint16_t	_timeDoublePress
	double press detection time in milliseconds

uint16_t	_timeLongPress
	long press time in milliseconds

uint16_t	_timeRepeat
	repeat time delay in milliseconds

uint8_t	_lastKey
	persists the last key value until a new one is detected

int16_t	_lastKeyIdx
	internal index of the last key read

Additional Inherited Members
Public Types inherited from MD_UISwitch
enum	keyResult_t { KEY_NULL , KEY_DOWN , KEY_UP , KEY_PRESS , KEY_DPRESS , KEY_LONGPRESS , KEY_RPTPRESS }

Protected Types inherited from MD_UISwitch
enum	state_fsm { S_IDLE , S_PRESS , S_PRESS2A , S_PRESS2B , S_PRESSL , S_REPEAT , S_WAIT }

enum	state_db { S_WAIT_START , S_DEBOUNCE , S_WAIT_RELEASE }

Protected Member Functions inherited from MD_UISwitch
keyResult_t	processFSM (bool swState, bool reset=false)

bool	debounce (bool curStatus, bool reset=false)

Static Protected Attributes inherited from MD_UISwitch
static const uint16_t	KEY_PRESS_TIME = 150
	Default key press time in milliseconds.

static const uint16_t	KEY_DPRESS_TIME = 250
	Default double press time between presses in milliseconds.

static const uint16_t	KEY_LONGPRESS_TIME = 600
	Default long press detection time in milliseconds.

static const uint16_t	KEY_REPEAT_TIME = 300
	Default time between repeats in in milliseconds.

static const uint8_t	KEY_ACTIVE_STATE = LOW
	Default key is active low - transition high to low detection.

static const uint8_t	REPEAT_RESULT_ENABLE = 3
	Internal status bit to return KS_REPEAT instead of KS_PRESS.

static const uint8_t	DPRESS_ENABLE = 2
	Internal status bit to enable double press.

static const uint8_t	LONGPRESS_ENABLE = 1
	Internal status bit to enable long press.

static const uint8_t	REPEAT_ENABLE = 0
	Internal status bit to enable repeat key.

Detailed Description

Extension class MD_UISwitch_Matrix.

Implements keyboard matrix switches that need to be scanned to detect a keypress.

The class will scan a key matrix that typically have circuits and connections similar to that shown below. Each row and column is separately connected to a digital pin, and arrays of pin numbers are passed to the class constructor to allow the code to scan the matrix to determine which key has been pressed. Pins should be directly connected to the matrix without pull-up or pull-down resistors. The library does not make a copy of the pin arrays so they should remain in scope for the life of the object.

The class will only return a valid key press if only one key is pressed. If more than one key is pressed simultaneously, all the keys are ignored until just a single key is again detected.

Constructor & Destructor Documentation

◆ MD_UISwitch_Matrix()

MD_UISwitch_Matrix::MD_UISwitch_Matrix	(	uint8_t	rows,
		uint8_t	cols,
		uint8_t *	rowPin,
		uint8_t *	colPin,
		char *	kt
	)

Class Constructor.

Instantiate a new instance of the class. The parameters passed are used to the hardware interface to the switch.

The class will only return a valid key if just one key is pressed. If more than one key is pressed simultaneously, all the keys are ignored until just a single key is again detected.

The class does not make copies of the pin array so they should remain in scope for the life of the object.

Parameters

rows	the number of rows in the key matrix.
cols	the number of columns in the key matrix.
rowPin	array of rows elements of ordered row pins to which the switches are connected.
colPin	array of cols elements of ordered column pins to which the switches are connected.
kt	the key table. An array of characters arranged in by column then row.

◆ ~MD_UISwitch_Matrix()

MD_UISwitch_Matrix::~MD_UISwitch_Matrix ( )

Class Destructor.

Release allocated memory and does the necessary to clean up once the queue is no longer required.

Member Function Documentation

◆ begin()

void MD_UISwitch_Matrix::begin ( void )

virtual

Initialize the object.

Initialize the object data. This needs to be called during setup() to initialize new data for the class that cannot be done during the object creation.

Implements MD_UISwitch.

◆ read()

MD_UISwitch::keyResult_t MD_UISwitch_Matrix::read ( void )

virtual

Return the key pressed of the switch matrix

Return one of the keypress types depending on what has been detected. The timing for each keypress starts when the first transition of the switch from inactive to active state and is recognized by a finite state machine whose operation is directed by the timer and option values specified.

Returns: one of the keyResult_t enumerated values

Implements MD_UISwitch.

The documentation for this class was generated from the following files:

src/MD_UISwitch.h
src/MD_UISwitch.cpp

Public Member Functions

Protected Attributes