Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
NoteButtons< NumButtons > Class Template Reference

#include <MIDI_Outputs/NoteButtons.hpp>

Detailed Description

template<uint8_t NumButtons>
class NoteButtons< NumButtons >

A class of MIDIOutputElements that read the input of a collection 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.
The buttons are debounced in software.
This version cannot be banked.

Template Parameters
NumButtonsThe number of buttons in the collection.

Definition at line 24 of file NoteButtons.hpp.

+ Inheritance diagram for NoteButtons< NumButtons >:
+ Collaboration diagram for NoteButtons< NumButtons >:

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

 NoteButtons (const Array< AH::Button, NumButtons > &buttons, MIDIAddress baseAddress, RelativeMIDIAddress incrementAddress, uint8_t velocity=0x7F)
 Create a new NoteButtons object with the given pins, the given controller number 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 () final override
 Initialize this updatable. More...
 
void update () final override
 Update this updatable. More...
 
AH::Button::State getButtonState (size_t index) const
 
MIDIAddress getBaseAddress () const
 Get the MIDI base address. More...
 
void setBaseAddressUnsafe (MIDIAddress address)
 Set the MIDI base address. More...
 
RelativeMIDIAddress getIncrementAddress () const
 Get the MIDI increment address. More...
 
void setIncrementAddressUnsafe (RelativeMIDIAddress address)
 Set the MIDI increment address. More...
 
void invert ()
 

Public Attributes

DigitalNoteSender sender
 

Protected Attributes

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

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Private Attributes

Array< AH::Button, NumButtons > buttons
 
const MIDIAddress baseAddress
 
const RelativeMIDIAddress incrementAddress
 

Constructor & Destructor Documentation

◆ NoteButtons()

NoteButtons ( const Array< AH::Button, NumButtons > &  buttons,
MIDIAddress  baseAddress,
RelativeMIDIAddress  incrementAddress,
uint8_t  velocity = 0x7F 
)
inline

Create a new NoteButtons object with the given pins, the given controller number and channel.

Parameters
buttonsA list of digital input pins with the buttons connected.
The internal pull-up resistors will be enabled.
baseAddressThe MIDI address of the first button, containing the note number [0, 127], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16].
incrementAddressThe number of addresses to increment for each next button.
E.g. if baseAddress is 8, and incrementAddress is 2, then the first button will send on address 8, the second button will send on address 10, button three on address 12, etc.
velocityThe velocity of the MIDI Note events.

Definition at line 45 of file NoteButtons.hpp.

Member Function Documentation

◆ setVelocity()

void setVelocity ( uint8_t  velocity)
inline

Set the velocity of the MIDI Note events.

Definition at line 56 of file NoteButtons.hpp.

◆ getVelocity()

uint8_t getVelocity ( ) const
inline

Get the velocity of the MIDI Note events.

Definition at line 58 of file NoteButtons.hpp.

◆ begin()

void begin ( )
inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 31 of file Abstract/MIDIButtons.hpp.

◆ update()

void update ( )
inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 35 of file Abstract/MIDIButtons.hpp.

◆ getButtonState()

AH::Button::State getButtonState ( size_t  index) const
inlineinherited

Definition at line 48 of file Abstract/MIDIButtons.hpp.

◆ getBaseAddress()

MIDIAddress getBaseAddress ( ) const
inlineinherited

Get the MIDI base address.

Definition at line 53 of file Abstract/MIDIButtons.hpp.

◆ setBaseAddressUnsafe()

void setBaseAddressUnsafe ( MIDIAddress  address)
inlineinherited

Set the MIDI base address.

Has unexpected consequences if used while a push button is pressed. Use banks if you need to support that.

Definition at line 57 of file Abstract/MIDIButtons.hpp.

◆ getIncrementAddress()

RelativeMIDIAddress getIncrementAddress ( ) const
inlineinherited

Get the MIDI increment address.

Definition at line 61 of file Abstract/MIDIButtons.hpp.

◆ setIncrementAddressUnsafe()

void setIncrementAddressUnsafe ( RelativeMIDIAddress  address)
inlineinherited

Set the MIDI increment address.

Has unexpected consequences if used while a push button is pressed. Use banks if you need to support that.

Definition at line 67 of file Abstract/MIDIButtons.hpp.

◆ invert()

void invert ( )
inlineinherited
See also
AH::Button::invert()

Definition at line 72 of file Abstract/MIDIButtons.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.

Member Data Documentation

◆ buttons

Array<AH::Button, NumButtons> buttons
privateinherited

Definition at line 78 of file Abstract/MIDIButtons.hpp.

◆ baseAddress

const MIDIAddress baseAddress
privateinherited

Definition at line 79 of file Abstract/MIDIButtons.hpp.

◆ incrementAddress

const RelativeMIDIAddress incrementAddress
privateinherited

Definition at line 80 of file Abstract/MIDIButtons.hpp.

◆ sender

DigitalNoteSender sender
inherited

Definition at line 83 of file Abstract/MIDIButtons.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.


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