Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
MIDIButtonMatrix< Sender, NumRows, NumCols > Class Template Reference

#include <MIDI_Outputs/Abstract/MIDIButtonMatrix.hpp>

Detailed Description

template<class Sender, uint8_t NumRows, uint8_t NumCols>
class MIDIButtonMatrix< Sender, NumRows, NumCols >

MIDIButtonMatrix.

See also
AH::ButtonMatrix

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

+ Inheritance diagram for MIDIButtonMatrix< Sender, NumRows, NumCols >:
+ Collaboration diagram for MIDIButtonMatrix< Sender, 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

void begin () final override
 Initialize this updatable.
 
void update () final override
 Update this updatable.
 
MIDIAddress getAddress (uint8_t row, uint8_t col) const
 Get the MIDI address of the button at the given row and column.
 
void setAddressUnsafe (uint8_t row, uint8_t col, uint8_t address)
 Set the MIDI address of button at the given row and column.
 
MIDIChannelCable getChannelCable () const
 Get the MIDI channel and cable number.
 
void setChannelCableUnsafe (MIDIChannelCable bccn)
 Set the MIDI channel and cable number of all buttons.
 
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

Sender sender
 

Protected Member Functions

 MIDIButtonMatrix (const PinList< NumRows > &rowPins, const PinList< NumCols > &colPins, const AddressMatrix< NumRows, NumCols > &addresses, MIDIChannelCable channelCN, const Sender &sender)
 Construct a new MIDIButtonMatrix.
 

Protected Attributes

Derived * next
 
Derived * previous
 

Static Protected Attributes

static DoublyLinkedList< Derived > 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

template<class Sender , uint8_t NumRows, uint8_t NumCols>
using ButtonMatrix = AH::ButtonMatrix<MIDIButtonMatrix, NumRows, NumCols>
private

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

Constructor & Destructor Documentation

◆ MIDIButtonMatrix()

template<class Sender , uint8_t NumRows, uint8_t NumCols>
MIDIButtonMatrix ( const PinList< NumRows > & rowPins,
const PinList< NumCols > & colPins,
const AddressMatrix< NumRows, NumCols > & addresses,
MIDIChannelCable channelCN,
const Sender & sender )
inlineprotected

Construct a new MIDIButtonMatrix.

Parameters
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.
addressesA matrix containing the address corresponding to each button.
channelCNThe MIDI channel and optional cable number for all buttons.
senderThe MIDI sender to use.

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

Member Function Documentation

◆ begin()

template<class Sender , uint8_t NumRows, uint8_t NumCols>
void begin ( )
inlinefinaloverridevirtual

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

template<class Sender , uint8_t NumRows, uint8_t NumCols>
void update ( )
inlinefinaloverridevirtual

Update this updatable.

Implements Updatable< T >.

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

◆ getAddress()

template<class Sender , uint8_t NumRows, uint8_t NumCols>
MIDIAddress getAddress ( uint8_t row,
uint8_t col ) const
inline

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

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

◆ setAddressUnsafe()

template<class Sender , uint8_t NumRows, uint8_t NumCols>
void setAddressUnsafe ( uint8_t row,
uint8_t col,
uint8_t address )
inline

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

template<class Sender , uint8_t NumRows, uint8_t NumCols>
MIDIChannelCable getChannelCable ( ) const
inline

Get the MIDI channel and cable number.

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

◆ setChannelCableUnsafe()

template<class Sender , uint8_t NumRows, uint8_t NumCols>
void setChannelCableUnsafe ( MIDIChannelCable bccn)
inline

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

template<class Sender , uint8_t NumRows, uint8_t NumCols>
void onButtonChanged ( uint8_t row,
uint8_t col,
bool state )
inlineprivate

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

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

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

unsigned long getDebounceTime ( ) const
inlineinherited

Get the debounce time.

Definition at line 62 of file ButtonMatrix.hpp.

◆ positionToBits()

static uint8_t positionToBits ( uint8_t col,
uint8_t row )
inlinestaticprivateinherited

◆ bitsToIndex()

static uint8_t bitsToIndex ( uint8_t bits)
inlinestaticprivateinherited

◆ bitsToBitmask()

static uint8_t bitsToBitmask ( uint8_t bits)
inlinestaticprivateinherited

◆ setPrevState()

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

Member Data Documentation

◆ addresses

template<class Sender , uint8_t NumRows, uint8_t NumCols>
AddressMatrix<NumRows, NumCols> addresses
private

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

◆ baseChannelCN

template<class Sender , uint8_t NumRows, uint8_t NumCols>
MIDIChannelCable baseChannelCN
private

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

◆ sender

template<class Sender , uint8_t NumRows, uint8_t NumCols>
Sender sender

Definition at line 86 of file 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

unsigned long debounceTime
privateinherited

Definition at line 84 of file ButtonMatrix.hpp.

◆ prevRefresh

unsigned long prevRefresh
privateinherited

Definition at line 85 of file ButtonMatrix.hpp.

◆ prevStates

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

Definition at line 86 of file ButtonMatrix.hpp.

◆ rowPins

const PinList<NumRows> rowPins
privateinherited

Definition at line 88 of file ButtonMatrix.hpp.

◆ colPins

const PinList<NumCols> colPins
privateinherited

Definition at line 89 of file ButtonMatrix.hpp.


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