#include <MIDI_Inputs/LEDs/NoteCCKPLEDPWM.hpp>
template<
MIDIMessageType Type, uint8_t BankSize>
class Bankable::NoteCCKPLEDPWM< Type, BankSize >
Generic base class for classes that listen for MIDI Note, Control Change and Key Pressure events on a single address and turn on an LED with a brightness/duty cycle proportional to the MIDI value.
- Template Parameters
-
Type | The type of MIDI messages to listen for:
|
BankSize | The number of banks. |
Definition at line 85 of file NoteCCKPLEDPWM.hpp.
|
void | enable () |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
void | disable () |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
bool | isEnabled () const |
| Check if this updatable is enabled.
|
|
void | moveDown () |
| Move down this element in the list.
|
|
static void | enable (UpdatableCRTP *element) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
static void | enable (UpdatableCRTP &element) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
static void | enable (U(&array)[N]) |
| Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
|
|
static void | disable (UpdatableCRTP *element) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
static void | disable (UpdatableCRTP &element) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
static void | disable (U(&array)[N]) |
| Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
|
|
|
bool | getDirty () const |
| Check if the value was updated since the last time the dirty flag was cleared.
|
|
void | clearDirty () |
| Clear the dirty flag.
|
|
|
| NoteCCKPLEDPWM (BankConfig< BankSize > config, pin_t ledPin, MIDIAddress address) |
| Constructor.
|
|
void | begin () override |
| Set the pinmode of the LED to OUTPUT.
|
|
void | reset () override |
| Reset all values to zero and turn off the LED.
|
|
uint8_t | getValue () const override |
| Get the most recent MIDI value that was received for the active bank.
|
|
uint8_t | getValue (uint8_t bank) const |
| Get the most recent MIDI value that was received for the given bank.
|
|
bool | updateWith (MessageType midimsg) override |
| Receive a new MIDI message and update the internal state.
|
|
virtual void | update () |
| Update the value of the input element. Used for decaying VU meters etc.
|
|
◆ Parent
◆ Matcher
◆ MessageType
◆ NoteCCKPLEDPWM()
Constructor.
- Parameters
-
config | The bank configuration to use. |
ledPin | The PWM pin with the LED connected. |
address | The base address to listen to. |
Definition at line 98 of file NoteCCKPLEDPWM.hpp.
◆ handleUpdate() [1/2]
void handleUpdate |
( |
typename Matcher::Result | match | ) |
|
|
inlineoverrideprotectedvirtual |
◆ display()
◆ begin()
◆ reset()
◆ 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 131 of file NoteCCKPLEDPWM.hpp.
◆ getValue() [1/2]
uint8_t getValue |
( |
| ) |
const |
|
inlineoverridevirtual |
Get the most recent MIDI value that was received for the active bank.
Implements IValue.
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()
◆ handleUpdate() [2/2]
|
inlineoverrideprotectedinherited |
◆ getActiveBank()
uint8_t getActiveBank |
( |
| ) |
const |
|
inlineprotectedinherited |
◆ updateWith()
|
inlineoverridevirtualinherited |
◆ update()
◆ updateAllWith()
◆ updateAll()
static void updateAll |
( |
| ) |
|
|
inlinestaticinherited |
◆ beginAll()
◆ resetAll()
◆ enable() [1/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 96 of file Updatable.hpp.
◆ enable() [2/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 125 of file Updatable.hpp.
◆ enable() [3/4]
Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.
Definition at line 127 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 130 of file Updatable.hpp.
◆ disable() [1/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 106 of file Updatable.hpp.
◆ disable() [2/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 136 of file Updatable.hpp.
◆ disable() [3/4]
Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.
Definition at line 138 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 141 of file Updatable.hpp.
◆ isEnabled()
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 120 of file Updatable.hpp.
◆ moveDown()
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
◆ getDirty()
◆ clearDirty()
◆ ledPin
◆ values
◆ matcher
◆ updatables
◆ next [1/2]
◆ next [2/2]
◆ previous [1/2]
◆ previous [2/2]
◆ dirty
The documentation for this class was generated from the following file: