MD_UISwitch_Analog Class Reference

#include <MD_UISwitch.h>

Inheritance diagram for MD_UISwitch_Analog:

Collaboration diagram for MD_UISwitch_Analog:

Classes
struct	uiAnalogKeys_t

Public Member Functions
Class constructor and destructor.
	MD_UISwitch_Analog (uint8_t pin, uiAnalogKeys_t *kt, uint8_t ktSize)
	~MD_UISwitch_Analog ()
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	_pin
	pin number
uiAnalogKeys_t *	_kt
	analog key values table
uint8_t	_ktSize
	number of elements in analog keys table
int16_t	_lastKeyIdx
	index of the last key read
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_Analog.

Implements resistor ladder switches on analog input. This type of switch are typically found on 1602 LCD module shields.

image{inline} html lcd_shield.jpg "LCD Shield"

All the switches are wired to one analog input, generally with resistor values as shown in the circuit below. The switch pressed is determined from the analog value read from the port. This may vary depending on the implementation of the resistor, so a translation table is implemented to allow the remapping of the analog value to a key number.

The translation table must be determined separately and passed as a parameter to the class constructor - the utility application Test_Analog_Keys in the examples folder can be used for this purpose. The class does not copy this table to its own memory, so it must remain in scope for the life of the object.

Constructor & Destructor Documentation

MD_UISwitch_Analog()

MD_UISwitch_Analog::MD_UISwitch_Analog	(	uint8_t	pin,
		uiAnalogKeys_t *	kt,
		uint8_t	ktSize
	)

Class Constructor.

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

The key definitions table is not copied by the class, so user code must ensure that the table remains in scope for the life of the object created.

Parameters

pin	the analog pin to which the switches are connected.
kt	pointer to a table of analog value key definitions
ktSize	number of elements in the kt table

~MD_UISwitch_Analog()

MD_UISwitch_Analog::~MD_UISwitch_Analog

(

)

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_Analog::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_Analog::read ( void  )

virtual

Return the state of the switch

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