Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
NoteButtonMatrix< NumRows, NumCols > Class Template Reference

#include <MIDI_Outputs/Bankable/NoteButtonMatrix.hpp>

Detailed Description

template<uint8_t NumRows, uint8_t NumCols>
class Bankable::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 can be banked.

Template Parameters
NumRowsThe number of rows of the matrix.
NumColsThe number of columns of the matrix.
Examples
Bank-Button-Matrix.ino.

Definition at line 29 of file Bankable/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 (OutputBankConfig<> config, 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 Bankable 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 () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. 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

MatrixAddress< NumRows, NumCols > address
 
uint16_t activeButtons
 
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

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 34 of file Bankable/Abstract/MIDIButtonMatrix.hpp.

Constructor & Destructor Documentation

◆ NoteButtonMatrix()

NoteButtonMatrix ( OutputBankConfig<>  config,
const PinList< NumRows > &  rowPins,
const PinList< NumCols > &  colPins,
const AddressMatrix< NumRows, NumCols > &  notes,
MIDIChannelCable  channelCN = {CHANNEL_1CABLE_1},
uint8_t  velocity = 0x7F 
)
inline

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

Parameters
configThe bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
rowPinsA list of pin numbers connected to the rows of the button matrix.
These pins will be driven LOW as outputs (Lo-Z).
colPinsA 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.
notesA 2-dimensional array of the same dimensions as the button matrix that contains the note number of each button. [0, 127]
channelCNThe MIDI channel [CHANNEL_1, CHANNEL_16] and Cable Number [CABLE_1, CABLE_16].
velocityThe velocity of the MIDI Note events.

Definition at line 58 of file Bankable/NoteButtonMatrix.hpp.

Member Function Documentation

◆ setVelocity()

void setVelocity ( uint8_t  velocity)
inline

Set the velocity of the MIDI Note events.

Definition at line 72 of file Bankable/NoteButtonMatrix.hpp.

◆ getVelocity()

uint8_t getVelocity ( ) const
inline

Get the velocity of the MIDI Note events.

Definition at line 74 of file Bankable/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()

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

◆ address

MatrixAddress< 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

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: