#include <MIDI_Outputs/Bankable/NoteButtons.hpp>

Detailed Description

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

Template Parameters

NumButtons The number of buttons in the collection.

Definition at line 27 of file Bankable/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.

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
	NoteButtons (OutputBankConfig<> config, const Array< AH::Button, NumButtons > &buttons, MIDIAddress baseAddress, RelativeMIDIAddress incrementAddress, uint8_t velocity=0x7F)
	Create a new Bankable NoteButtons object with the given pins, the given controller number 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 () final override
	Initialize this updatable.

void	update () final override
	Update this updatable.

void	invert ()

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

Public Attributes
DigitalNoteSender	sender

Protected Attributes
SingleAddress	address

Array< AH::Button, NumButtons >	buttons

RelativeMIDIAddress	incrementAddress

uint8_t	activeButtons

Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Constructor & Destructor Documentation

◆ NoteButtons()

template<uint8_t NumButtons>

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

inline

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

Parameters

config	The bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
buttons	A list of digital input pins with the buttons connected. The internal pull-up resistors will be enabled.
baseAddress	The 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].
incrementAddress	The 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.
velocity	The velocity of the MIDI Note events.

Definition at line 52 of file Bankable/NoteButtons.hpp.

Member Function Documentation

◆ setVelocity()

template<uint8_t NumButtons>

void setVelocity ( uint8_t velocity )

inline

Set the velocity of the MIDI Note events.

Definition at line 64 of file Bankable/NoteButtons.hpp.

◆ getVelocity()

template<uint8_t NumButtons>

uint8_t getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

Definition at line 66 of file Bankable/NoteButtons.hpp.

◆ begin()

void begin ( )

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 37 of file Bankable/Abstract/MIDIButtons.hpp.

◆ update()

void update ( )

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 41 of file Bankable/Abstract/MIDIButtons.hpp.

◆ invert()

void invert ( )

inlineinherited

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

Definition at line 63 of file Bankable/Abstract/MIDIButtons.hpp.

◆ getButtonState()

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

inlineinherited

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

Member Data Documentation

◆ address

SingleAddress address

protectedinherited

Definition at line 73 of file Bankable/Abstract/MIDIButtons.hpp.

◆ buttons

Array<AH::Button, NumButtons> buttons

protectedinherited

Definition at line 74 of file Bankable/Abstract/MIDIButtons.hpp.

◆ incrementAddress

RelativeMIDIAddress incrementAddress

protectedinherited

Definition at line 75 of file Bankable/Abstract/MIDIButtons.hpp.

◆ activeButtons

uint8_t activeButtons

protectedinherited

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

◆ sender

DigitalNoteSender sender

inherited

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

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

Bankable/NoteButtons.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

◆ NoteButtons()

Member Function Documentation

◆ setVelocity()

◆ getVelocity()

◆ begin()

◆ update()

◆ invert()

◆ getButtonState()

◆ beginAll()

◆ updateAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ address

◆ buttons

◆ incrementAddress

◆ activeButtons

◆ sender

◆ updatables

◆ next

◆ previous