#include <MIDI_Outputs/Bankable/NoteButtonMatrix.hpp>
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.
NumRows | The number of rows of the matrix. |
NumCols | The number of columns of the matrix. |
Definition at line 29 of file Bankable/NoteButtonMatrix.hpp.
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 (OutputBankConfig<> config, const PinList< NumRows > &rowPins, const PinList< NumCols > &colPins, const AddressMatrix< NumRows, NumCols > ¬es, MIDIChannelCable channelCN={Channel_1, Cable_1}, uint8_t velocity=0x7F) | |
Create a new Bankable NoteButtonMatrix object with the given pins, note 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 | |
MatrixAddress< 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 |
|
privateinherited |
Definition at line 34 of file Bankable/Abstract/MIDIButtonMatrix.hpp.
|
inline |
Create a new Bankable NoteButtonMatrix object with the given pins, note numbers and channel.
config | The bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number. |
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 [Channel_1, Channel_16] and Cable Number [Cable_1, Cable_16]. |
velocity | The velocity of the MIDI Note events. |
Definition at line 58 of file Bankable/NoteButtonMatrix.hpp.
|
inline |
Set the velocity of the MIDI Note events.
Definition at line 72 of file Bankable/NoteButtonMatrix.hpp.
|
inline |
Get the velocity of the MIDI Note events.
Definition at line 74 of file Bankable/NoteButtonMatrix.hpp.
|
inlineoverridevirtualinherited |
Initialize this updatable.
Implements Updatable< T >.
Definition at line 61 of file Bankable/Abstract/MIDIButtonMatrix.hpp.
|
inlineoverridevirtualinherited |
Update this updatable.
Implements Updatable< T >.
Definition at line 63 of file Bankable/Abstract/MIDIButtonMatrix.hpp.
|
inlineprivateinherited |
Definition at line 66 of file Bankable/Abstract/MIDIButtonMatrix.hpp.
|
inlinestaticinherited |
Begin all enabled instances of this class.
Definition at line 182 of file Updatable.hpp.
|
inlinestaticinherited |
Update all enabled instances of this class.
Definition at line 186 of file Updatable.hpp.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 120 of file Updatable.hpp.
|
inlineinherited |
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
|
inherited |
Get the state of the button in the given column and row.
|
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.
|
inlineinherited |
Get the debounce time.
Definition at line 62 of file ButtonMatrix.hpp.
|
inlinestaticprivateinherited |
|
inlinestaticprivateinherited |
|
inlinestaticprivateinherited |
|
privateinherited |
|
protectedinherited |
Definition at line 81 of file Bankable/Abstract/MIDIButtonMatrix.hpp.
|
protectedinherited |
Definition at line 82 of file Bankable/Abstract/MIDIButtonMatrix.hpp.
|
inherited |
Definition at line 85 of file Bankable/Abstract/MIDIButtonMatrix.hpp.
|
staticprotectedinherited |
Definition at line 152 of file Updatable.hpp.
|
protectedinherited |
Definition at line 320 of file LinkedList.hpp.
|
protectedinherited |
Definition at line 321 of file LinkedList.hpp.
|
privateinherited |
Definition at line 84 of file ButtonMatrix.hpp.
|
privateinherited |
Definition at line 85 of file ButtonMatrix.hpp.
|
privateinherited |
Definition at line 86 of file ButtonMatrix.hpp.
|
privateinherited |
Definition at line 88 of file ButtonMatrix.hpp.
|
privateinherited |
Definition at line 89 of file ButtonMatrix.hpp.