Control Surface master
MIDI Control Surface library for Arduino
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Private Attributes | List of all members
NoteCCKPLED< Type > Class Template Referenceabstract

#include <MIDI_Inputs/LEDs/NoteCCKPLED.hpp>

Detailed Description

template<MIDIMessageType Type>
class NoteCCKPLED< Type >

Generic base class for classes that listen for MIDI Note, Control Change and Key Pressure events on a single address and turns on an LED when the value is higher than a threshold.

Template Parameters
TypeThe type of MIDI messages to listen for:
Examples
1.Note-LED.ino, 2.First-Input.ino, 6.MAX7219-NoteLED.ino, AppleMIDI.ino, Debug-MIDI-Interface.ino, Dual-MIDI-Interface.ino, and Serial-Interface.ino.

Definition at line 20 of file NoteCCKPLED.hpp.

+ Inheritance diagram for NoteCCKPLED< Type >:
+ Collaboration diagram for NoteCCKPLED< Type >:

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

Public Types

using Matcher = TwoByteMIDIMatcher
 
using Parent = MatchingMIDIInputElement< Type, Matcher >
 
using MessageType = typename MIDIInputElement< Type >::MessageType
 

Public Member Functions

 NoteCCKPLED (pin_t ledPin, MIDIAddress address)
 
void begin () override
 Set the pinmode of the LED to OUTPUT. More...
 
void reset () override
 Turn off the LED. More...
 
uint8_t getThreshold () const
 Get the LED threshold. More...
 
void setThreshold (uint8_t threshold)
 Set the LED threshold. LED will be on if getValue() >= getThreshold(). More...
 
bool updateWith (MessageType midimsg) override
 Receive a new MIDI message and update the internal state. More...
 
virtual void handleUpdate (typename Matcher::Result match)=0
 
virtual void update ()
 Update the value of the input element. Used for decaying VU meters etc. More...
 

Static Public Member Functions

static bool updateAllWith (MessageType midimsg)
 Update all. More...
 
static void updateAll ()
 Update all. More...
 
static void beginAll ()
 Begin all. More...
 
static void resetAll ()
 Reset all. More...
 

Protected Attributes

TwoByteMIDIMatcher matcher
 
Node * next = nullptr
 
Node * previous = nullptr
 

Static Protected Attributes

static DoublyLinkedList< MIDIInputElement< Type > > updatables
 

Private Member Functions

void handleUpdate (typename Matcher::Result match) override
 

Private Attributes

pin_t ledPin
 
uint8_t threshold = 0x01
 

Member Typedef Documentation

◆ Matcher

Definition at line 22 of file NoteCCKPLED.hpp.

◆ Parent

Definition at line 23 of file NoteCCKPLED.hpp.

◆ MessageType

using MessageType = typename MIDIInputElement<Type>::MessageType
inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ NoteCCKPLED()

NoteCCKPLED ( pin_t  ledPin,
MIDIAddress  address 
)
inline
Parameters
ledPinThe output pin with the LED connected.
addressThe address to listen to.

Definition at line 29 of file NoteCCKPLED.hpp.

Member Function Documentation

◆ handleUpdate() [1/2]

void handleUpdate ( typename Matcher::Result  match)
inlineoverrideprivate

Definition at line 33 of file NoteCCKPLED.hpp.

◆ begin()

void begin ( )
inlineoverridevirtual

Set the pinmode of the LED to OUTPUT.

Reimplemented from MIDIInputElement< Type >.

Definition at line 40 of file NoteCCKPLED.hpp.

◆ reset()

void reset ( )
inlineoverridevirtual

Turn off the LED.

Reimplemented from MIDIInputElement< Type >.

Definition at line 46 of file NoteCCKPLED.hpp.

◆ getThreshold()

uint8_t getThreshold ( ) const
inline

Get the LED threshold.

Definition at line 49 of file NoteCCKPLED.hpp.

◆ setThreshold()

void setThreshold ( uint8_t  threshold)
inline

Set the LED threshold. LED will be on if getValue() >= getThreshold().

Definition at line 51 of file NoteCCKPLED.hpp.

◆ updateWith()

bool updateWith ( MessageType  midimsg)
inlineoverridevirtualinherited

Receive a new MIDI message and update the internal state.

Implements MIDIInputElement< Type >.

Definition at line 95 of file MIDIInputElement.hpp.

◆ handleUpdate() [2/2]

virtual void handleUpdate ( typename Matcher::Result  match)
pure virtualinherited

◆ update()

virtual void update ( )
inlinevirtualinherited

Update the value of the input element. Used for decaying VU meters etc.

Reimplemented in VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, VU, and VU< BankSize >.

Definition at line 40 of file MIDIInputElement.hpp.

◆ updateAllWith()

static bool updateAllWith ( MessageType  midimsg)
inlinestaticinherited

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ updateAll()

static void updateAll ( )
inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ beginAll()

static void beginAll ( )
inlinestaticinherited

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ resetAll()

static void resetAll ( )
inlinestaticinherited

Reset all.

Definition at line 67 of file MIDIInputElement.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< MIDIInputElement< Type > > *  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< MIDIInputElement< Type > > &  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< MIDIInputElement< Type > > *  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< MIDIInputElement< Type > > &  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

◆ ledPin

pin_t ledPin
private

Definition at line 54 of file NoteCCKPLED.hpp.

◆ threshold

uint8_t threshold = 0x01
private

Definition at line 55 of file NoteCCKPLED.hpp.

◆ matcher

TwoByteMIDIMatcher matcher
protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.

◆ updatables

DoublyLinkedList< MIDIInputElement< Type > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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