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

#include <NoteButton.hpp>

Inheritance diagram for Bankable::NoteButton:

Collaboration diagram for Bankable::NoteButton:

Public Member Functions
	NoteButton (const OutputBankConfig &config, pin_t pin, const MIDICNChannelAddress &address, uint8_t velocity=0x7F)
	Create a new Bankable NoteButton object with the given pin, note 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 () override
	Initialize this updatable. More...

void	update () override
	Update this updatable. More...

AH::Button::State	getButtonState () const

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
SingleAddress	address

AH::Button	button

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

Detailed Description

A class of MIDIOutputElements that read the input of a momentary push button or switch, and send out MIDI Note events.

A Note On event is sent when the button is pressed, and a Note Off event is sent when the button is released.
The button is debounced in software.
This version can be banked.

Examples: Transposer.ino.

Definition at line 22 of file Bankable/NoteButton.hpp.

Constructor & Destructor Documentation

◆ NoteButton()

Bankable::NoteButton::NoteButton	(	const OutputBankConfig &	config,
		pin_t	pin,
		const MIDICNChannelAddress &	address,
		uint8_t	velocity = `0x7F`
	)

inline

Create a new Bankable NoteButton object with the given pin, note 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.
pin	The digital input pin to read from. The internal pull-up resistor will be enabled.
address	The MIDI address containing the note number [0, 127], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15].
velocity	The velocity of the MIDI Note events.

Definition at line 41 of file Bankable/NoteButton.hpp.

Member Function Documentation

◆ setVelocity()

void Bankable::NoteButton::setVelocity ( uint8_t velocity )

inline

Set the velocity of the MIDI Note events.

Definition at line 50 of file Bankable/NoteButton.hpp.

◆ getVelocity()

uint8_t Bankable::NoteButton::getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

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

◆ begin()

void Bankable::MIDIButton< SingleAddress , DigitalNoteSender >::begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements AH::Updatable<>.

Definition at line 36 of file Bankable/Abstract/MIDIButton.hpp.

◆ update()

void Bankable::MIDIButton< SingleAddress , DigitalNoteSender >::update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements AH::Updatable<>.

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

◆ getButtonState()

AH::Button::State Bankable::MIDIButton< SingleAddress , DigitalNoteSender >::getButtonState ( ) const

inlineinherited

Definition at line 52 of file Bankable/Abstract/MIDIButton.hpp.

◆ enable() [1/4]

void AH::Updatable< NormalUpdatable >::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 AH::Updatable< NormalUpdatable >::enable ( Updatable<> * element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ enable() [3/4]

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

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

◆ enable() [4/4]

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

inlinestaticinherited

Definition at line 90 of file Updatable.hpp.

◆ disable() [1/4]

void AH::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 55 of file Updatable.hpp.

◆ disable() [2/4]

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

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ disable() [3/4]

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

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

◆ disable() [4/4]

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

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

◆ isEnabled()

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

◆ beginAll()

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

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 73 of file Updatable.hpp.

◆ updateAll()

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

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

◆ address

SingleAddress Bankable::MIDIButton< SingleAddress , DigitalNoteSender >::address

privateinherited

Definition at line 55 of file Bankable/Abstract/MIDIButton.hpp.

◆ button

AH::Button Bankable::MIDIButton< SingleAddress , DigitalNoteSender >::button

privateinherited

Definition at line 56 of file Bankable/Abstract/MIDIButton.hpp.

◆ sender

DigitalNoteSender Bankable::MIDIButton< SingleAddress , DigitalNoteSender >::sender

inherited

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > AH::Updatable< NormalUpdatable >::updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

◆ next

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

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous

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

protectedinherited

Definition at line 306 of file LinkedList.hpp.

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

Bankable/NoteButton.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NoteButton()

Member Function Documentation

◆ setVelocity()

◆ getVelocity()

◆ begin()

◆ update()

◆ getButtonState()

◆ 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

◆ address

◆ button

◆ sender

◆ updatables

◆ next

◆ previous