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

#include <MIDI_Inputs/LEDs/NoteCCKPLED.hpp>

Detailed Description

template<MIDIMessageType Type, uint8_t BankSize>
class Bankable::NoteCCKPLED< Type, BankSize >

Generic base class for classes that listen for MIDI Note, Control Change and Key Pressure events on a single address and save their value.

This version listens accross multiple banks.

Template Parameters
TypeThe type of MIDI messages to listen for:
BankSizeThe number of banks.
Examples
Bank-Button-Matrix.ino.

Definition at line 92 of file NoteCCKPLED.hpp.

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

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

Detecting changes

bool getDirty () const
 Check if the value was updated since the last time the dirty flag was cleared. More...
 
void clearDirty ()
 Clear the dirty flag. More...
 

Public Types

using Parent = NoteCCKPValue< Type, BankSize >
 
using Matcher = typename Parent::Matcher
 
using MessageType = typename MIDIInputElement< Type >::MessageType
 

Public Member Functions

 NoteCCKPLED (BankConfig< BankSize > config, pin_t ledPin, MIDIAddress address)
 
void begin () override
 Set the pinmode of the LED to OUTPUT. More...
 
void reset () override
 Reset all values to zero and 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...
 
uint8_t getValue () const override
 Get the most recent MIDI value that was received for the active bank. More...
 
uint8_t getValue (uint8_t bank) const
 Get the most recent MIDI value that was received for the given bank. More...
 
bool updateWith (MessageType midimsg) override
 Receive a new MIDI message and update the internal state. More...
 
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 Member Functions

void handleUpdate (typename Matcher::Result match) override
 
void display ()
 
void onBankSettingChange () override
 A function to be executed each time the bank setting changes. More...
 
bool handleUpdateImpl (typename Matcher::Result match)
 
void handleUpdate (typename Matcher::Result match) override
 
uint8_t getActiveBank () const
 

Protected Attributes

Matcher matcher
 
Node * next = nullptr
 
BankSettingChangeCallbacknext
 
Node * previous = nullptr
 
BankSettingChangeCallbackprevious
 
bool dirty = true
 

Static Protected Attributes

static DoublyLinkedList< MIDIInputElement< Type > > updatables
 

Private Attributes

pin_t ledPin
 
uint8_t threshold = 0x01
 
AH::Array< uint8_t, BankSize > values = {{}}
 

Member Typedef Documentation

◆ Parent

using Parent = NoteCCKPValue<Type, BankSize>

Definition at line 94 of file NoteCCKPLED.hpp.

◆ Matcher

using Matcher = typename Parent::Matcher

Definition at line 95 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 ( BankConfig< BankSize >  config,
pin_t  ledPin,
MIDIAddress  address 
)
inline
Parameters
configThe bank configuration to use.
ledPinThe output pin with the LED connected.
addressThe base address to listen to.

Definition at line 103 of file NoteCCKPLED.hpp.

Member Function Documentation

◆ handleUpdate() [1/2]

void handleUpdate ( typename Matcher::Result  match)
inlineoverrideprotectedvirtual

Implements MatchingMIDIInputElement< Type, Matcher >.

Definition at line 107 of file NoteCCKPLED.hpp.

◆ display()

void display ( )
inlineprotected

Definition at line 114 of file NoteCCKPLED.hpp.

◆ begin()

void begin ( )
inlineoverridevirtual

Set the pinmode of the LED to OUTPUT.

Reimplemented from MIDIInputElement< Type >.

Definition at line 121 of file NoteCCKPLED.hpp.

◆ reset()

void reset ( )
inlineoverridevirtual

Reset all values to zero and turn off the LED.

Reimplemented from MIDIInputElement< Type >.

Definition at line 127 of file NoteCCKPLED.hpp.

◆ getThreshold()

uint8_t getThreshold ( ) const
inline

Get the LED threshold.

Definition at line 135 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 137 of file NoteCCKPLED.hpp.

◆ onBankSettingChange()

void onBankSettingChange ( )
inlineoverrideprotectedvirtual

A function to be executed each time the bank setting changes.

Think of an LED that indicates whether a track is muted or not. If this LED is bankable, let's say with 4 tracks per bank, 2 banks, and a base address of 3, then this LED object keeps the state of tracks 3 and 7. When the bank setting is 0, the LED displays the state of track 3, when the bank setting is 1, the LED displays the state of track 7. To know when to update the LED, this callback is used.

Reimplemented from BankSettingChangeCallback.

Definition at line 140 of file NoteCCKPLED.hpp.

◆ getValue() [1/2]

uint8_t getValue ( ) const
inlineoverridevirtual

Get the most recent MIDI value that was received for the active bank.

Reimplemented from NoteCCKPValue< Type, BankSize >.

Definition at line 121 of file NoteCCKPValue.hpp.

◆ getValue() [2/2]

uint8_t getValue ( uint8_t  bank) const
inline

Get the most recent MIDI value that was received for the given bank.

Definition at line 123 of file NoteCCKPValue.hpp.

◆ handleUpdateImpl()

bool handleUpdateImpl ( typename Matcher::Result  match)
inlineprotectedinherited

Definition at line 104 of file NoteCCKPValue.hpp.

◆ handleUpdate() [2/2]

void handleUpdate ( typename Matcher::Result  match)
inlineoverrideprotectedinherited

Definition at line 112 of file NoteCCKPValue.hpp.

◆ getActiveBank()

uint8_t getActiveBank ( ) const
inlineprotectedinherited

Definition at line 126 of file MIDIInputElement.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.

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

◆ getDirty()

bool getDirty ( ) const
inlineinherited

Check if the value was updated since the last time the dirty flag was cleared.

Definition at line 22 of file InterfaceMIDIInputElements.hpp.

◆ clearDirty()

void clearDirty ( )
inlineinherited

Clear the dirty flag.

Definition at line 24 of file InterfaceMIDIInputElements.hpp.

Member Data Documentation

◆ ledPin

pin_t ledPin
private

Definition at line 146 of file NoteCCKPLED.hpp.

◆ threshold

uint8_t threshold = 0x01
private

Definition at line 147 of file NoteCCKPLED.hpp.

◆ values

AH::Array<uint8_t, BankSize> values = {{}}
privateinherited

Definition at line 137 of file NoteCCKPValue.hpp.

◆ matcher

Matcher 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 [1/2]

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ next [2/2]

BankSettingChangeCallback * next
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous [1/2]

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.

◆ previous [2/2]

BankSettingChangeCallback * previous
protectedinherited

Definition at line 325 of file LinkedList.hpp.

◆ dirty

bool dirty = true
protectedinherited

Definition at line 31 of file InterfaceMIDIInputElements.hpp.


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