#include <MIDI_Outputs/NoteButtonMatrix.hpp>

Detailed Description

template<uint8_t NumRows, uint8_t NumCols>
class NoteButtonMatrix< NumRows, NumCols >

A class of MIDIOutputElements that read the input from a matrix of momentary push buttons or switches, and send out MIDI Note events.

A Note On event is sent when a button is pressed, and a Note Off event is sent when a button is released.
Crude software debouncing is implemented by limiting the refresh rate.
This version cannot be banked.

Template Parameters

NumRows	The number of rows of the matrix.
NumCols	The number of columns of the matrix.

Examples: NoteButtonMatrix.ino.

Definition at line 26 of file NoteButtonMatrix.hpp.

Inheritance diagram for NoteButtonMatrix< NumRows, NumCols >:

Collaboration diagram for NoteButtonMatrix< NumRows, NumCols >:

Enabling and disabling updatables
void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable ()
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

bool	isEnabled () const
	Check if this updatable is enabled. More...

void	moveDown ()
	Move down this element in the list. More...

static void	enable (UpdatableCRTP *element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (UpdatableCRTP &element)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	enable (U(&array)[N])
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

static void	disable (UpdatableCRTP *element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (UpdatableCRTP &element)
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically. More...

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class. More...

static void	updateAll ()
	Update all enabled instances of this class. More...

Public Member Functions
	NoteButtonMatrix (const PinList< NumRows > &rowPins, const PinList< NumCols > &colPins, const AddressMatrix< NumRows, NumCols > &notes, MIDIChannelCable channelCN={CHANNEL_1, CABLE_1}, uint8_t velocity=0x7F)
	Create a new NoteButtonMatrix object with the given pins, note numbers and channel. More...

void	setVelocity (uint8_t velocity)
	Set the velocity of the MIDI Note events. More...

uint8_t	getVelocity () const
	Get the velocity of the MIDI Note events. More...

void	begin () final override
	Initialize this updatable. More...

void	update () final override
	Update this updatable. More...

MIDIAddress	getAddress (uint8_t row, uint8_t col) const
	Get the MIDI address of the button at the given row and column. More...

void	setAddressUnsafe (uint8_t row, uint8_t col, uint8_t address)
	Set the MIDI address of button at the given row and column. More...

MIDIChannelCable	getChannelCable () const
	Get the MIDI channel and cable number. More...

void	setChannelCableUnsafe (MIDIChannelCable bccn)
	Set the MIDI channel and cable number of all buttons. More...

bool	getPrevState (uint8_t col, uint8_t row)
	Get the state of the button in the given column and row. More...

void	setDebounceTime (unsigned long debounceTime)
	Configure the debounce time interval. More...

unsigned long	getDebounceTime () const
	Get the debounce time. More...

Public Attributes
DigitalNoteSender	sender

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable > >	updatables

Private Types
using	ButtonMatrix = AH::ButtonMatrix< MIDIButtonMatrix, NumRows, NumCols >

Private Member Functions
void	onButtonChanged (uint8_t row, uint8_t col, bool state)

void	setPrevState (uint8_t col, uint8_t row, bool state)

Static Private Member Functions
static uint8_t	positionToBits (uint8_t col, uint8_t row)

static uint8_t	bitsToIndex (uint8_t bits)

static uint8_t	bitsToBitmask (uint8_t bits)

Private Attributes
AddressMatrix< NumRows, NumCols >	addresses

MIDIChannelCable	baseChannelCN

unsigned long	debounceTime

unsigned long	prevRefresh

uint8_t	prevStates [(NumCols *NumRows+7)/8]

const PinList< NumRows >	rowPins

const PinList< NumCols >	colPins

Member Typedef Documentation

◆ ButtonMatrix

using ButtonMatrix = AH::ButtonMatrix<MIDIButtonMatrix, NumRows, NumCols>

privateinherited

Definition at line 19 of file Abstract/MIDIButtonMatrix.hpp.

Constructor & Destructor Documentation

◆ NoteButtonMatrix()

NoteButtonMatrix	(	const PinList< NumRows > &	rowPins,
		const PinList< NumCols > &	colPins,
		const AddressMatrix< NumRows, NumCols > &	notes,
		MIDIChannelCable	channelCN = `{CHANNEL_1, CABLE_1}`,
		uint8_t	velocity = `0x7F`
	)

inline

Create a new NoteButtonMatrix object with the given pins, note numbers and channel.

Parameters

rowPins	A list of pin numbers connected to the rows of the button matrix. ⚠ These pins will be driven LOW as outputs (Lo-Z).
colPins	A list of pin numbers connected to the columns of the button matrix. These pins will be used as inputs (Hi-Z), and the internal pull-up resistor will be enabled.
notes	A 2-dimensional array of the same dimensions as the button matrix that contains the note number of each button. [0, 127]
channelCN	The MIDI channel [1, 16] and Cable Number [CABLE_1, CABLE_16].
velocity	The velocity of the MIDI Note events.

Definition at line 50 of file NoteButtonMatrix.hpp.

Member Function Documentation

◆ setVelocity()

void setVelocity ( uint8_t velocity )

inline

Set the velocity of the MIDI Note events.

Definition at line 60 of file NoteButtonMatrix.hpp.

◆ getVelocity()

uint8_t getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

Definition at line 62 of file NoteButtonMatrix.hpp.

◆ begin()

void begin ( )

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 50 of file Abstract/MIDIButtonMatrix.hpp.

◆ update()

void update ( )

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 52 of file Abstract/MIDIButtonMatrix.hpp.

◆ getAddress()

MIDIAddress getAddress	(	uint8_t	row,
		uint8_t	col
	)		const

inlineinherited

Get the MIDI address of the button at the given row and column.

Definition at line 55 of file Abstract/MIDIButtonMatrix.hpp.

◆ setAddressUnsafe()

void setAddressUnsafe	(	uint8_t	row,
		uint8_t	col,
		uint8_t	address
	)

inlineinherited

Set the MIDI address of button at the given row and column.

Has unexpected consequences if used while the push button is pressed. Use banks if you need to support that.

Definition at line 61 of file Abstract/MIDIButtonMatrix.hpp.

◆ getChannelCable()

MIDIChannelCable getChannelCable ( ) const

inlineinherited

Get the MIDI channel and cable number.

Definition at line 65 of file Abstract/MIDIButtonMatrix.hpp.

◆ setChannelCableUnsafe()

void setChannelCableUnsafe ( MIDIChannelCable bccn )

inlineinherited

Set the MIDI channel and cable number of all buttons.

Has unexpected consequences if used while the push button is pressed. Use banks if you need to support that.

Definition at line 69 of file Abstract/MIDIButtonMatrix.hpp.

◆ onButtonChanged()

void onButtonChanged	(	uint8_t	row,
		uint8_t	col,
		bool	state
	)

inlineprivateinherited

Definition at line 74 of file Abstract/MIDIButtonMatrix.hpp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 190 of file Updatable.hpp.

◆ enable() [1/4]

void enable ( )

inlineinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 100 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > * element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 129 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > & element )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 131 of file Updatable.hpp.

◆ enable() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 134 of file Updatable.hpp.

◆ disable() [1/4]

void disable ( )

inlineinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 110 of file Updatable.hpp.

◆ disable() [2/4]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable > > * element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 140 of file Updatable.hpp.

◆ disable() [3/4]

static void disable ( UpdatableCRTP< Updatable< NormalUpdatable > > & element )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 142 of file Updatable.hpp.

◆ disable() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 145 of file Updatable.hpp.

◆ isEnabled()

bool isEnabled ( ) const

inlineinherited

Check if this updatable is enabled.

Note: Assumes that the updatable is not added to a different linked list by the user.

Definition at line 124 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

◆ getPrevState()

bool getPrevState	(	uint8_t	col,
		uint8_t	row
	)

inherited

Get the state of the button in the given column and row.

Note: No bounds checking is performed.

Definition at line 57 of file ButtonMatrix.ipp.

◆ setDebounceTime()

void setDebounceTime ( unsigned long debounceTime )

inlineinherited

Configure the debounce time interval.

Only one button can change in each debounce interval. Time in milliseconds.

Definition at line 61 of file ButtonMatrix.hpp.

◆ getDebounceTime()

unsigned long getDebounceTime ( ) const

inlineinherited

Get the debounce time.

Definition at line 65 of file ButtonMatrix.hpp.

◆ positionToBits()

uint8_t positionToBits	(	uint8_t	col,
		uint8_t	row
	)

inlinestaticprivateinherited

Definition at line 82 of file ButtonMatrix.ipp.

◆ bitsToIndex()

uint8_t bitsToIndex ( uint8_t bits )

inlinestaticprivateinherited

Definition at line 83 of file ButtonMatrix.ipp.

◆ bitsToBitmask()

uint8_t bitsToBitmask ( uint8_t bits )

inlinestaticprivateinherited

Definition at line 84 of file ButtonMatrix.ipp.

◆ setPrevState()

void setPrevState	(	uint8_t	col,
		uint8_t	row,
		bool	state
	)

privateinherited

Definition at line 85 of file ButtonMatrix.ipp.

Member Data Documentation

◆ addresses

AddressMatrix<NumRows, NumCols> addresses

privateinherited

Definition at line 82 of file Abstract/MIDIButtonMatrix.hpp.

◆ baseChannelCN

MIDIChannelCable baseChannelCN

privateinherited

Definition at line 83 of file Abstract/MIDIButtonMatrix.hpp.

◆ sender

DigitalNoteSender sender

inherited

Definition at line 86 of file Abstract/MIDIButtonMatrix.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 325 of file LinkedList.hpp.

◆ debounceTime

unsigned long debounceTime

privateinherited

Definition at line 87 of file ButtonMatrix.hpp.

◆ prevRefresh

unsigned long prevRefresh

privateinherited

Definition at line 88 of file ButtonMatrix.hpp.

◆ prevStates

uint8_t prevStates[(NumCols *NumRows+7)/8]

privateinherited

Definition at line 89 of file ButtonMatrix.hpp.

◆ rowPins

const PinList<NumRows> rowPins

privateinherited

Definition at line 91 of file ButtonMatrix.hpp.

◆ colPins

const PinList<NumCols> colPins

privateinherited

Definition at line 92 of file ButtonMatrix.hpp.

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

NoteButtonMatrix.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Member Typedef Documentation

◆ ButtonMatrix

Constructor & Destructor Documentation

◆ NoteButtonMatrix()

Member Function Documentation

◆ setVelocity()

◆ getVelocity()

◆ begin()

◆ update()

◆ getAddress()

◆ setAddressUnsafe()

◆ getChannelCable()

◆ setChannelCableUnsafe()

◆ onButtonChanged()

◆ beginAll()

◆ updateAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

◆ getPrevState()

◆ setDebounceTime()

◆ getDebounceTime()

◆ positionToBits()

◆ bitsToIndex()

◆ bitsToBitmask()

◆ setPrevState()

Member Data Documentation

◆ addresses

◆ baseChannelCN

◆ sender

◆ updatables

◆ next

◆ previous

◆ debounceTime

◆ prevRefresh

◆ prevStates

◆ rowPins

◆ colPins