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

#include <MIDI_Outputs/NoteButtons.hpp>

Inheritance diagram for NoteButtons< NUMBER_OF_BUTTONS >:

Collaboration diagram for NoteButtons< NUMBER_OF_BUTTONS >:

Public Member Functions
	NoteButtons (const Array< AH::Button, NUMBER_OF_BUTTONS > &buttons, const MIDICNChannelAddress &baseAddress, const RelativeMIDICNChannelAddress &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

void	invert ()

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

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 Attributes
Array< AH::Button, NUMBER_OF_BUTTONS >	buttons

const MIDICNChannelAddress	baseAddress

const RelativeMIDICNChannelAddress	incrementAddress

Static Private Attributes
static DoublyLinkedList< Updatable< NormalUpdatable > >	updatables

Detailed Description

template<uint8_t NUMBER_OF_BUTTONS>
class NoteButtons< NUMBER_OF_BUTTONS >

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

NUMBER_OF_BUTTONS The number of buttons in the collection.

Definition at line 24 of file NoteButtons.hpp.

Constructor & Destructor Documentation

◆ NoteButtons()

NoteButtons	(	const Array< AH::Button, NUMBER_OF_BUTTONS > &	buttons,
		const MIDICNChannelAddress &	baseAddress,
		const RelativeMIDICNChannelAddress &	incrementAddress,
		uint8_t	velocity = `0x7F`
	)

inline

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

Parameters

buttons	An 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 [0, 15].
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 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 57 of file NoteButtons.hpp.

◆ getVelocity()

uint8_t getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

Definition at line 59 of file NoteButtons.hpp.

◆ begin()

void begin ( )

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update ( )

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable<>.

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

◆ getButtonState()

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

inlineinherited

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

◆ invert()

void invert ( )

inlineinherited

Definition at line 54 of file Abstract/MIDIButtons.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 45 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( Updatable<> * element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( Updatable<> & element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

◆ enable() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

Definition at line 90 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 55 of file Updatable.hpp.

◆ disable() [2/4]

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

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ disable() [3/4]

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

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

◆ disable() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

◆ isEnabled()

bool 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 69 of file Updatable.hpp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 73 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

◆ buttons

Array<AH::Button, NUMBER_OF_BUTTONS> buttons

privateinherited

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

◆ baseAddress

const MIDICNChannelAddress baseAddress

privateinherited

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

◆ incrementAddress

const RelativeMIDICNChannelAddress incrementAddress

privateinherited

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

◆ sender

DigitalNoteSender sender

inherited

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

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

NoteButtons.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

template<uint8_t NUMBER_OF_BUTTONS> class NoteButtons< NUMBER_OF_BUTTONS >

Constructor & Destructor Documentation

◆ NoteButtons()

Member Function Documentation

◆ setVelocity()

◆ getVelocity()

◆ begin()

◆ update()

◆ getButtonState()

◆ invert()

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

◆ beginAll()

◆ updateAll()

Member Data Documentation

◆ buttons

◆ baseAddress

◆ incrementAddress

◆ sender

◆ updatables

◆ next

◆ previous

template<uint8_t NUMBER_OF_BUTTONS>
class NoteButtons< NUMBER_OF_BUTTONS >