#include <MIDI_Outputs/ManyAddresses/NoteButtonMatrix.hpp>

Detailed Description

template<setting_t NumBanks, uint8_t NumRows, uint8_t NumCols>
class Bankable::ManyAddresses::NoteButtonMatrix< NumBanks, 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 can be banked using an arbitrary list of alternative addresses.

Template Parameters

NumBanks	The number of variants/alternative addresses the element has.
NumRows	The number of rows of the matrix.
NumCols	The number of columns of the matrix.

Definition at line 33 of file ManyAddresses/NoteButtonMatrix.hpp.

Inheritance diagram for NoteButtonMatrix< NumBanks, NumRows, NumCols >:

Collaboration diagram for NoteButtonMatrix< NumBanks, NumRows, NumCols >:

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

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

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

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

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

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

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

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

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

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

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

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

Public Member Functions
	NoteButtonMatrix (const Bank< NumBanks > &bank, const PinList< NumRows > &rowPins, const PinList< NumCols > &colPins, const Array< AddressMatrix< NumRows, NumCols >, NumBanks > &notes, const Array< MIDIChannelCable, NumBanks > &channelCNs, uint8_t velocity=0x7F)
	Create a new Bankable NoteButtonMatrix object with the given pins, controller numbers and channel.

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

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

void	begin () override
	Initialize this updatable.

void	update () override
	Update this updatable.

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

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

unsigned long	getDebounceTime () const
	Get the debounce time.

Public Attributes
DigitalNoteSender	sender

Protected Attributes
ManyMatrixAddresses< NumBanks, NumRows, NumCols >	address

uint16_t	activeButtons

Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Private Types
using	ButtonMatrix

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
unsigned long	debounceTime = BUTTON_DEBOUNCE_TIME

unsigned long	prevRefresh = 0

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

const PinList< NumRows >	rowPins

const PinList< NumCols >	colPins

Member Typedef Documentation

◆ ButtonMatrix

using ButtonMatrix

privateinherited

Definition at line 34 of file Bankable/Abstract/MIDIButtonMatrix.hpp.

Constructor & Destructor Documentation

◆ NoteButtonMatrix()

template<setting_t NumBanks, uint8_t NumRows, uint8_t NumCols>

NoteButtonMatrix	(	const Bank< NumBanks > &	bank,
		const PinList< NumRows > &	rowPins,
		const PinList< NumCols > &	colPins,
		const Array< AddressMatrix< NumRows, NumCols >, NumBanks > &	notes,
		const Array< MIDIChannelCable, NumBanks > &	channelCNs,
		uint8_t	velocity = 0x7F )

inline

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

Parameters

bank	The bank to add this element to.
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 list of 2-dimensional arrays of the same dimensions as the button matrix that contains the MIDI Note number of each button. [0, 127]
channelCNs	The a list containing the MIDI channels [Channel_1, Channel_16] and Cable Numbers [Cable_1, Cable_16].
velocity	The velocity of the MIDI Note events.

Definition at line 62 of file ManyAddresses/NoteButtonMatrix.hpp.

Member Function Documentation

◆ setVelocity()

template<setting_t NumBanks, uint8_t NumRows, uint8_t NumCols>

void setVelocity ( uint8_t velocity )

inline

Set the velocity of the MIDI Note events.

Definition at line 77 of file ManyAddresses/NoteButtonMatrix.hpp.

◆ getVelocity()

template<setting_t NumBanks, uint8_t NumRows, uint8_t NumCols>

uint8_t getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

Definition at line 79 of file ManyAddresses/NoteButtonMatrix.hpp.

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 63 of file Bankable/Abstract/MIDIButtonMatrix.hpp.

◆ onButtonChanged()

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

inlineprivateinherited

Definition at line 66 of file Bankable/Abstract/MIDIButtonMatrix.hpp.

◆ beginAll()

template<class T = NormalUpdatable>

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 182 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >

void enable ( )

inlineinherited

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

Definition at line 96 of file Updatable.hpp.

◆ enable() [2/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

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

Definition at line 125 of file Updatable.hpp.

◆ enable() [3/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

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

Definition at line 127 of file Updatable.hpp.

◆ enable() [4/4]

template<class Derived >

template<class U , size_t N>

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 130 of file Updatable.hpp.

◆ disable() [1/4]

template<class Derived >

void disable ( )

inlineinherited

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

Definition at line 106 of file Updatable.hpp.

◆ disable() [2/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > * element )

inlinestaticinherited

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

Definition at line 136 of file Updatable.hpp.

◆ disable() [3/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > & element )

inlinestaticinherited

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

Definition at line 138 of file Updatable.hpp.

◆ disable() [4/4]

template<class Derived >

template<class U , size_t N>

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 141 of file Updatable.hpp.

◆ isEnabled()

template<class Derived >

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 120 of file Updatable.hpp.

◆ moveDown()

template<class Derived >

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

◆ getPrevState()

template<class Derived , uint8_t NumRows, uint8_t NumCols>

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.

◆ setDebounceTime()

template<class Derived , uint8_t NumRows, uint8_t NumCols>

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 58 of file ButtonMatrix.hpp.

◆ getDebounceTime()

template<class Derived , uint8_t NumRows, uint8_t NumCols>

unsigned long getDebounceTime ( ) const

inlineinherited

Get the debounce time.

Definition at line 62 of file ButtonMatrix.hpp.

◆ positionToBits()

template<class Derived , uint8_t NumRows, uint8_t NumCols>

static uint8_t positionToBits	(	uint8_t	col,
		uint8_t	row )

inlinestaticprivateinherited

◆ bitsToIndex()

template<class Derived , uint8_t NumRows, uint8_t NumCols>

static uint8_t bitsToIndex ( uint8_t bits )

inlinestaticprivateinherited

◆ bitsToBitmask()

template<class Derived , uint8_t NumRows, uint8_t NumCols>

static uint8_t bitsToBitmask ( uint8_t bits )

inlinestaticprivateinherited

◆ setPrevState()

template<class Derived , uint8_t NumRows, uint8_t NumCols>

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

privateinherited

Member Data Documentation

◆ address

ManyMatrixAddresses< NumBanks, NumRows, NumCols > address

protectedinherited

Definition at line 81 of file Bankable/Abstract/MIDIButtonMatrix.hpp.

◆ activeButtons

uint16_t activeButtons

protectedinherited

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

◆ sender

DigitalNoteSender sender

inherited

Definition at line 85 of file Bankable/Abstract/MIDIButtonMatrix.hpp.

◆ updatables

template<class Derived >

DoublyLinkedList< Derived > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

◆ debounceTime

template<class Derived , uint8_t NumRows, uint8_t NumCols>

unsigned long debounceTime = BUTTON_DEBOUNCE_TIME

privateinherited

Definition at line 84 of file ButtonMatrix.hpp.

◆ prevRefresh

template<class Derived , uint8_t NumRows, uint8_t NumCols>

unsigned long prevRefresh = 0

privateinherited

Definition at line 85 of file ButtonMatrix.hpp.

◆ prevStates

template<class Derived , uint8_t NumRows, uint8_t NumCols>

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

privateinherited

Definition at line 86 of file ButtonMatrix.hpp.

◆ rowPins

template<class Derived , uint8_t NumRows, uint8_t NumCols>

const PinList<NumRows> rowPins

privateinherited

Definition at line 88 of file ButtonMatrix.hpp.

◆ colPins

template<class Derived , uint8_t NumRows, uint8_t NumCols>

const PinList<NumCols> colPins

privateinherited

Definition at line 89 of file ButtonMatrix.hpp.

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

ManyAddresses/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()

◆ 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

◆ address

◆ activeButtons

◆ sender

◆ updatables

◆ next

◆ previous

◆ debounceTime

◆ prevRefresh

◆ prevStates

◆ rowPins

◆ colPins