Control Surface  1.1.1
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
NoteButton Class Reference
MIDI Output Elements

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

#include <MIDI_Outputs/NoteButton.hpp>

Inheritance diagram for NoteButton:
Collaboration diagram for NoteButton:

Public Member Functions

 NoteButton (pin_t pin, const MIDICNChannelAddress &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
 
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

AH::Button button
 
const MIDICNChannelAddress address
 

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

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

Definition at line 19 of file NoteButton.hpp.

Constructor & Destructor Documentation

◆ NoteButton()

NoteButton ( pin_t  pin,
const MIDICNChannelAddress &  address,
uint8_t  velocity = 0x7F 
)
inline

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

Parameters
pinThe digital input pin to read from.
The internal pull-up resistor will be enabled.
addressThe MIDI address containing the note number [0, 127], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15].
velocityThe 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 44 of file NoteButton.hpp.

◆ getVelocity()

uint8_t getVelocity ( ) const
inline

Get the velocity of the MIDI Note events.

Definition at line 46 of file NoteButton.hpp.

◆ begin()

void begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

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

◆ invert()

void invert ( )
inlineinherited

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

◆ getButtonState()

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

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

◆ button

AH::Button button
privateinherited

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

◆ address

const MIDICNChannelAddress address
privateinherited

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

◆ sender

DigitalNoteSender sender
inherited

Definition at line 55 of file Abstract/MIDIButton.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:
Generated by   doxygen 1.8.16