This is an old version of the documentation. View the latest version here.
Control Surface  1.0.0
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | List of all members
Bankable::NoteButtonMatrix< nb_rows, nb_cols > Class Template Reference

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

#include <NoteButtonMatrix.hpp>

Inheritance diagram for Bankable::NoteButtonMatrix< nb_rows, nb_cols >:
Collaboration diagram for Bankable::NoteButtonMatrix< nb_rows, nb_cols >:

Public Member Functions

 NoteButtonMatrix (const OutputBankConfig &config, const PinList< nb_rows > &rowPins, const PinList< nb_cols > &colPins, const AddressMatrix< nb_rows, nb_cols > &notes, MIDICNChannel channelCN={CHANNEL_1, 0}, 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...
 
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 ()
 Check if this updatable is enabled. More...
 
void refresh ()
 Scan the matrix, read all button states, and call the onButtonChanged callback. More...
 

Static Public Member Functions

static void enable (Updatable *element)
 
static void enable (Updatable &element)
 
static void enable (U(&array)[N])
 
static void disable (Updatable< NormalUpdatable > *element)
 
static void disable (Updatable< NormalUpdatable > &element)
 
static void disable (U(&array)[N])
 
static void beginAll ()
 Begin all enabled instances of this class. More...
 
static void updateAll ()
 Update all enabled instances of this class. More...
 

Public Attributes

DigitalNoteSender sender
 

Protected Attributes

Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Private Member Functions

void onButtonChanged (uint8_t row, uint8_t col, bool state) final override
 The callback function that is called whenever a button changes state. More...
 
bool getPrevState (uint8_t col, uint8_t row)
 
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

MatrixAddress< nb_rows, nb_cols > address
 
uint16_t activeButtons
 
unsigned long prevRefresh = 0
 
uint8_t prevStates [(nb_cols *nb_rows+7)/8]
 
const PinList< nb_rows > rowPins
 
const PinList< nb_cols > colPins
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Detailed Description

template<uint8_t nb_rows, uint8_t nb_cols>
class Bankable::NoteButtonMatrix< nb_rows, nb_cols >

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
nb_rowsThe number of rows of the matrix.
nb_colsThe number of columns of the matrix.
Examples
Bank-Button-Matrix.ino.

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

Constructor & Destructor Documentation

◆ NoteButtonMatrix()

template<uint8_t nb_rows, uint8_t nb_cols>
Bankable::NoteButtonMatrix< nb_rows, nb_cols >::NoteButtonMatrix ( const OutputBankConfig config,
const PinList< nb_rows > &  rowPins,
const PinList< nb_cols > &  colPins,
const AddressMatrix< nb_rows, nb_cols > &  notes,
MIDICNChannel  channelCN = {CHANNEL_1, 0},
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 [0, 15].
velocityThe velocity of the MIDI Note events.

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

Member Function Documentation

◆ setVelocity()

template<uint8_t nb_rows, uint8_t nb_cols>
void Bankable::NoteButtonMatrix< nb_rows, nb_cols >::setVelocity ( uint8_t  velocity)
inline

Set the velocity of the MIDI Note events.

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

◆ getVelocity()

template<uint8_t nb_rows, uint8_t nb_cols>
uint8_t Bankable::NoteButtonMatrix< nb_rows, nb_cols >::getVelocity ( ) const
inline

Get the velocity of the MIDI Note events.

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

◆ begin()

void Bankable::MIDIButtonMatrix< MatrixAddress< nb_rows, nb_cols > , DigitalNoteSender , nb_rows, nb_cols >::begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void Bankable::MIDIButtonMatrix< MatrixAddress< nb_rows, nb_cols > , DigitalNoteSender , nb_rows, nb_cols >::update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

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

◆ onButtonChanged()

void Bankable::MIDIButtonMatrix< MatrixAddress< nb_rows, nb_cols > , DigitalNoteSender , nb_rows, nb_cols >::onButtonChanged ( uint8_t  row,
uint8_t  col,
bool  state 
)
inlinefinaloverrideprivatevirtualinherited

The callback function that is called whenever a button changes state.

Parameters
rowThe row of the button that changed state.
colThe column of the button that changed state.
stateThe new state of the button.

Implements ButtonMatrix< nb_rows, nb_cols >.

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

◆ enable() [1/4]

void Updatable< NormalUpdatable >::enable ( )
inlineinherited

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

Definition at line 40 of file Updatable.hpp.

◆ enable() [2/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> *  element)
inlinestaticinherited

Definition at line 80 of file Updatable.hpp.

◆ enable() [3/4]

static void Updatable< NormalUpdatable >::enable ( Updatable<> &  element)
inlinestaticinherited

Definition at line 82 of file Updatable.hpp.

◆ enable() [4/4]

static void Updatable< NormalUpdatable >::enable ( U(&)  array[N])
inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ disable() [1/4]

void Updatable< NormalUpdatable >::disable ( )
inlineinherited

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

Definition at line 50 of file Updatable.hpp.

◆ disable() [2/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > *  element)
inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [3/4]

static void Updatable< NormalUpdatable >::disable ( Updatable< NormalUpdatable<> > &  element)
inlinestaticinherited

Definition at line 92 of file Updatable.hpp.

◆ disable() [4/4]

static void Updatable< NormalUpdatable >::disable ( U(&)  array[N])
inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ isEnabled()

bool Updatable< NormalUpdatable >::isEnabled ( )
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 64 of file Updatable.hpp.

◆ beginAll()

static void Updatable< NormalUpdatable >::beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 68 of file Updatable.hpp.

◆ updateAll()

static void Updatable< NormalUpdatable >::updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 75 of file Updatable.hpp.

◆ refresh()

template<uint8_t nb_rows, uint8_t nb_cols>
void ButtonMatrix< nb_rows, nb_cols >::refresh ( )
inherited

Scan the matrix, read all button states, and call the onButtonChanged callback.

Definition at line 17 of file ButtonMatrix.ipp.

◆ positionToBits()

template<uint8_t nb_rows, uint8_t nb_cols>
uint8_t ButtonMatrix< nb_rows, nb_cols >::positionToBits ( uint8_t  col,
uint8_t  row 
)
inlinestaticprivateinherited

Definition at line 52 of file ButtonMatrix.ipp.

◆ bitsToIndex()

template<uint8_t nb_rows, uint8_t nb_cols>
uint8_t ButtonMatrix< nb_rows, nb_cols >::bitsToIndex ( uint8_t  bits)
inlinestaticprivateinherited

Definition at line 59 of file ButtonMatrix.ipp.

◆ bitsToBitmask()

template<uint8_t nb_rows, uint8_t nb_cols>
uint8_t ButtonMatrix< nb_rows, nb_cols >::bitsToBitmask ( uint8_t  bits)
inlinestaticprivateinherited

Definition at line 64 of file ButtonMatrix.ipp.

◆ getPrevState()

template<uint8_t nb_rows, uint8_t nb_cols>
bool ButtonMatrix< nb_rows, nb_cols >::getPrevState ( uint8_t  col,
uint8_t  row 
)
privateinherited

Definition at line 69 of file ButtonMatrix.ipp.

◆ setPrevState()

template<uint8_t nb_rows, uint8_t nb_cols>
void ButtonMatrix< nb_rows, nb_cols >::setPrevState ( uint8_t  col,
uint8_t  row,
bool  state 
)
privateinherited

Definition at line 75 of file ButtonMatrix.ipp.

Member Data Documentation

◆ address

MatrixAddress< nb_rows, nb_cols > Bankable::MIDIButtonMatrix< MatrixAddress< nb_rows, nb_cols > , DigitalNoteSender , nb_rows, nb_cols >::address
privateinherited

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

◆ activeButtons

uint16_t Bankable::MIDIButtonMatrix< MatrixAddress< nb_rows, nb_cols > , DigitalNoteSender , nb_rows, nb_cols >::activeButtons
privateinherited

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

◆ sender

DigitalNoteSender Bankable::MIDIButtonMatrix< MatrixAddress< nb_rows, nb_cols > , DigitalNoteSender , nb_rows, nb_cols >::sender
inherited

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > Updatable< NormalUpdatable >::updatables
staticprivateinherited

Definition at line 101 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::next
protectedinherited

Definition at line 301 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * DoublyLinkable< Updatable< NormalUpdatable > >::previous
protectedinherited

Definition at line 302 of file LinkedList.hpp.

◆ prevRefresh

template<uint8_t nb_rows, uint8_t nb_cols>
unsigned long ButtonMatrix< nb_rows, nb_cols >::prevRefresh = 0
privateinherited

Definition at line 73 of file ButtonMatrix.hpp.

◆ prevStates

template<uint8_t nb_rows, uint8_t nb_cols>
uint8_t ButtonMatrix< nb_rows, nb_cols >::prevStates[(nb_cols *nb_rows+7)/8]
privateinherited

Definition at line 74 of file ButtonMatrix.hpp.

◆ rowPins

template<uint8_t nb_rows, uint8_t nb_cols>
const PinList<nb_rows> ButtonMatrix< nb_rows, nb_cols >::rowPins
privateinherited

Definition at line 76 of file ButtonMatrix.hpp.

◆ colPins

template<uint8_t nb_rows, uint8_t nb_cols>
const PinList<nb_cols> ButtonMatrix< nb_rows, nb_cols >::colPins
privateinherited

Definition at line 77 of file ButtonMatrix.hpp.


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