#include <MIDI_Outputs/NoteButton.hpp>

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 cannot be banked.

Examples: AppleMIDI.ino, Debug-MIDI-Interface.ino, NoteButton.ino, and Serial-Interface.ino.

Definition at line 19 of file NoteButton.hpp.

Inheritance diagram for NoteButton:

Collaboration diagram for NoteButton:

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
	NoteButton (pin_t pin, MIDIAddress address, uint8_t velocity=0x7F)
	Create a new 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...

void	invert ()

AH::Button::State	getButtonState () const

MIDIAddress	getAddress () const
	Get the MIDI address. More...

void	setAddressUnsafe (MIDIAddress address)
	Set the MIDI address. More...

Public Attributes
DigitalNoteSender	sender

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

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

Private Attributes
AH::Button	button

const MIDIAddress	address

Constructor & Destructor Documentation

◆ NoteButton()

NoteButton	(	pin_t	pin,
		MIDIAddress	address,
		uint8_t	velocity = `0x7F`
	)

inline

Create a new NoteButton object with the given pin, note number and channel.

Parameters

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 [CABLE_1, CABLE_16].
velocity	The velocity of the MIDI Note events.

Definition at line 35 of file NoteButton.hpp.

Member Function Documentation

◆ setVelocity()

void setVelocity ( uint8_t velocity )

inline

Set the velocity of the MIDI Note events.

Definition at line 43 of file NoteButton.hpp.

◆ getVelocity()

uint8_t getVelocity ( ) const

inline

Get the velocity of the MIDI Note events.

Definition at line 45 of file NoteButton.hpp.

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 33 of file Abstract/MIDIButton.hpp.

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 34 of file Abstract/MIDIButton.hpp.

◆ invert()

void invert ( )

inlineinherited

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

Definition at line 44 of file Abstract/MIDIButton.hpp.

◆ getButtonState()

AH::Button::State getButtonState ( ) const

inlineinherited

Definition at line 46 of file Abstract/MIDIButton.hpp.

◆ getAddress()

MIDIAddress getAddress ( ) const

inlineinherited

Get the MIDI address.

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

◆ setAddressUnsafe()

void setAddressUnsafe ( MIDIAddress address )

inlineinherited

Set the MIDI address.

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

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

◆ button

AH::Button button

privateinherited

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

◆ address

const MIDIAddress address

privateinherited

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

◆ sender

DigitalNoteSender sender

inherited

Definition at line 59 of file Abstract/MIDIButton.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:

NoteButton.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Private Attributes

Constructor & Destructor Documentation

◆ NoteButton()

Member Function Documentation

◆ setVelocity()

◆ getVelocity()

◆ begin()

◆ update()

◆ invert()

◆ getButtonState()

◆ getAddress()

◆ setAddressUnsafe()

◆ 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

◆ button

◆ address

◆ sender

◆ updatables

◆ next

◆ previous