Control Surface main
MIDI Control Surface library for Arduino
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Attributes | Static Private Attributes | List of all members
VULEDs< BankSize, NumLEDs > Class Template Reference

#include <MIDI_Inputs/LEDs/MCU/VULEDs.hpp>

Detailed Description

template<uint8_t BankSize, uint8_t NumLEDs>
class MCU::Bankable::VULEDs< BankSize, NumLEDs >

A MIDI input element that represents a Mackie Control Universal VU meter and displays its value using LEDs.

This version can be banked.

Template Parameters
BankSizeThe number of banks.
NumLEDsThe number of LEDs for the VU meter display. Recommended value is 12, because this is the range that's sent over MIDI.

Definition at line 134 of file VULEDs.hpp.

+ Inheritance diagram for VULEDs< BankSize, NumLEDs >:
+ Collaboration diagram for VULEDs< BankSize, NumLEDs >:

Data access

uint8_t getValue (uint8_t bank) const
 Get the most recent VU position that was received for the given bank.
 
uint8_t getValue () override
 Get the most recent VU position that was received for the active bank.
 
bool getOverload (uint8_t bank) const
 Get the status of the overload indicator for the given bank.
 
bool getOverload () override
 Get the status of the overload indicator for the active bank.
 
float getFloatValue (uint8_t bank) const
 Get the most recent VU position for the given bank as a value between 0 and 1.
 
float getFloatValue () override
 Get the most recent VU position for the active bank as a value between 0 and 1.
 

Enabling and disabling updatables

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.
 

Detecting changes

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

Public Types

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

Public Member Functions

 VULEDs (BankConfig< BankSize > config, const PinList< NumLEDs > &leds, uint8_t track, MIDIChannelCable channelCN, unsigned int decayTime=VUDecay::Default)
 
 VULEDs (BankConfig< BankSize > config, const PinList< NumLEDs > &leds, uint8_t track, unsigned int decayTime=VUDecay::Default)
 
void begin () override
 Initialize the input element.
 
void reset () override
 Reset all values to zero.
 
void update () override
 Decay the VU meter.
 
bool updateWith (MessageType midimsg) override
 Receive a new MIDI message and update the internal state.
 
uint8_t getMax () const
 Get the maximum value that this VU meter can return.
 
void displayVU (uint16_t value)
 
void display (uint16_t value) const
 Display the given number of LEDs on the LED bar.
 
void display (float value) const
 Display the given fraction of the LED bar.
 
DotBarMode getMode () const
 Get the dot/bar mode.
 
void setMode (DotBarMode mode)
 Set the mode to either dot or bar mode.
 
void dotMode ()
 Set the mode to dot mode.
 
void barMode ()
 Set the mode to bar mode.
 
void toggleMode ()
 Toggle the dot/bar mode.
 
void begin () const
 Initialize (set LED pins as outputs).
 
void displayRange (uint16_t startOn, uint16_t startOff) const
 Turn on a range of the LEDs.
 
void set (uint16_t index) const
 Turn on the given LED.
 
void clear (uint16_t index) const
 Turn off the given LED.
 
void clear () const
 Turn off all LEDs.
 
void displayDot (uint16_t led) const
 Turn on a single LED, and turn off all others.
 

Static Public Member Functions

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

Protected Member Functions

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

Protected Attributes

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

Static Protected Attributes

static DoublyLinkedList< MIDIInputElement< Type > > updatables
 

Private Attributes

AH::Array< VUState, BankSize > states = {{}}
 
AH::Timer< millis > decayTimer
 
DotBarMode mode
 
const PinList< N > ledPins
 

Static Private Attributes

static constexpr uint8_t FLOOR_CORRECTION = 5
 

Member Typedef Documentation

◆ Parent

template<uint8_t BankSize, uint8_t NumLEDs>
using Parent = VU<BankSize>

Definition at line 136 of file VULEDs.hpp.

◆ Matcher

template<uint8_t BankSize, uint8_t NumLEDs>
using Matcher = typename Parent::Matcher

Definition at line 137 of file VULEDs.hpp.

◆ MessageType

template<MIDIMessageType Type, class Matcher >
using MessageType = typename MIDIInputElement<Type>::MessageType
inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ VULEDs() [1/2]

template<uint8_t BankSize, uint8_t NumLEDs>
VULEDs ( BankConfig< BankSize > config,
const PinList< NumLEDs > & leds,
uint8_t track,
MIDIChannelCable channelCN,
unsigned int decayTime = VUDecay::Default )
inline
Parameters
configThe bank configuration to use.
ledsThe pins with the LEDs connected.
trackThe track of the VU meter. [1, 8]
channelCNThe MIDI channel [Channel_1, Channel_16] and Cable Number [Cable_1, Cable_16].
decayTimeThe time in milliseconds it takes for the value to decay one step.
The MCU protocol uses 300 ms per division, and two steps per division, so the default is 150 ms per step.
Some software doesn't work if the VU meter decays automatically, in that case, you can set the decay time to zero to disable the decay.
See also
MCU::VUDecay

Definition at line 157 of file VULEDs.hpp.

◆ VULEDs() [2/2]

template<uint8_t BankSize, uint8_t NumLEDs>
VULEDs ( BankConfig< BankSize > config,
const PinList< NumLEDs > & leds,
uint8_t track,
unsigned int decayTime = VUDecay::Default )
inline
Parameters
configThe bank configuration to use.
ledsThe pins with the LEDs connected.
trackThe track of the VU meter. [1, 8]
decayTimeThe time in milliseconds it takes for the value to decay one step.
The MCU protocol uses 300 ms per division, and two steps per division, so the default is 150 ms per step.
Some software doesn't work if the VU meter decays automatically, in that case, you can set the decay time to zero to disable the decay.
See also
MCU::VUDecay

Definition at line 178 of file VULEDs.hpp.

Member Function Documentation

◆ handleUpdate() [1/2]

template<uint8_t BankSize, uint8_t NumLEDs>
void handleUpdate ( typename Matcher::Result match)
inlineoverrideprotectedvirtual

Implements MatchingMIDIInputElement< Type, Matcher >.

Definition at line 183 of file VULEDs.hpp.

◆ updateDisplay()

template<uint8_t BankSize, uint8_t NumLEDs>
void updateDisplay ( )
inlineprotected

Definition at line 190 of file VULEDs.hpp.

◆ begin() [1/2]

template<uint8_t BankSize, uint8_t NumLEDs>
void begin ( )
inlineoverridevirtual

Initialize the input element.

Reimplemented from MIDIInputElement< Type >.

Definition at line 193 of file VULEDs.hpp.

◆ reset()

template<uint8_t BankSize, uint8_t NumLEDs>
void reset ( )
inlineoverridevirtual

Reset all values to zero.

Reimplemented from VU< BankSize >.

Definition at line 199 of file VULEDs.hpp.

◆ update()

template<uint8_t BankSize, uint8_t NumLEDs>
void update ( )
inlineoverridevirtual

Decay the VU meter.

Reimplemented from VU< BankSize >.

Definition at line 204 of file VULEDs.hpp.

◆ onBankSettingChange()

template<uint8_t BankSize, uint8_t NumLEDs>
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 VU< BankSize >.

Definition at line 212 of file VULEDs.hpp.

◆ handleUpdateImpl()

template<uint8_t BankSize>
bool handleUpdateImpl ( typename Matcher::Result match)
inlineprotectedinherited

Definition at line 347 of file VU.hpp.

◆ handleUpdate() [2/2]

template<uint8_t BankSize>
void handleUpdate ( typename Matcher::Result match)
inlineoverrideprotectedinherited

Definition at line 359 of file VU.hpp.

◆ decay()

template<uint8_t BankSize>
bool decay ( )
inlineprotectedinherited

Definition at line 363 of file VU.hpp.

◆ getValue() [1/2]

template<uint8_t BankSize>
uint8_t getValue ( uint8_t bank) const
inlineinherited

Get the most recent VU position that was received for the given bank.

Definition at line 390 of file VU.hpp.

◆ getValue() [2/2]

template<uint8_t BankSize>
uint8_t getValue ( )
inlineoverridevirtualinherited

Get the most recent VU position that was received for the active bank.

Implements IVU.

Definition at line 398 of file VU.hpp.

◆ getOverload() [1/2]

template<uint8_t BankSize>
bool getOverload ( uint8_t bank) const
inlineinherited

Get the status of the overload indicator for the given bank.

Definition at line 392 of file VU.hpp.

◆ getOverload() [2/2]

template<uint8_t BankSize>
bool getOverload ( )
inlineoverridevirtualinherited

Get the status of the overload indicator for the active bank.

Implements IVU.

Definition at line 400 of file VU.hpp.

◆ getFloatValue() [1/2]

template<uint8_t BankSize>
float getFloatValue ( uint8_t bank) const
inlineinherited

Get the most recent VU position for the given bank as a value between 0 and 1.

Definition at line 395 of file VU.hpp.

◆ getFloatValue() [2/2]

template<uint8_t BankSize>
float getFloatValue ( )
inlineoverridevirtualinherited

Get the most recent VU position for the active bank as a value between 0 and 1.

Reimplemented from IVU.

Definition at line 403 of file VU.hpp.

◆ getActiveBank()

uint8_t getActiveBank ( ) const
inlineprotectedinherited

Definition at line 126 of file MIDIInputElement.hpp.

◆ updateWith()

template<MIDIMessageType Type, class Matcher >
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.

◆ updateAllWith()

template<MIDIMessageType Type>
static bool updateAllWith ( MessageType midimsg)
inlinestaticinherited

Update all.

Definition at line 46 of file MIDIInputElement.hpp.

◆ updateAll()

template<MIDIMessageType Type>
static void updateAll ( )
inlinestaticinherited

Update all.

Definition at line 57 of file MIDIInputElement.hpp.

◆ beginAll()

template<MIDIMessageType Type>
static void beginAll ( )
inlinestaticinherited

Begin all.

Definition at line 62 of file MIDIInputElement.hpp.

◆ resetAll()

template<MIDIMessageType Type>
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 96 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 125 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 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]

void disable ( )
inlineinherited

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]

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 136 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 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()

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 120 of file Updatable.hpp.

◆ moveDown()

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 147 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 94 of file InterfaceMIDIInputElements.hpp.

◆ clearDirty()

void clearDirty ( )
inlineinherited

Clear the dirty flag.

Definition at line 96 of file InterfaceMIDIInputElements.hpp.

◆ getMax()

uint8_t getMax ( ) const
inlineinherited

Get the maximum value that this VU meter can return.

Definition at line 107 of file InterfaceMIDIInputElements.hpp.

◆ displayVU()

template<uint16_t NumLEDs>
void displayVU ( uint16_t value)
inlineinherited
Parameters
value[0, 12]

Definition at line 20 of file VULEDs.hpp.

◆ display() [1/2]

void display ( uint16_t value) const
inlineinherited

Display the given number of LEDs on the LED bar.

Parameters
valueThe number of the LED to activate.

Definition at line 37 of file DotBarDisplayLEDs.hpp.

◆ display() [2/2]

void display ( float value) const
inlineinherited

Display the given fraction of the LED bar.

Parameters
valueThe fraction of the LED bar to display.

Definition at line 52 of file DotBarDisplayLEDs.hpp.

◆ getMode()

DotBarMode getMode ( ) const
inlineinherited

Get the dot/bar mode.

Definition at line 55 of file DotBarDisplayLEDs.hpp.

◆ setMode()

void setMode ( DotBarMode mode)
inlineinherited

Set the mode to either dot or bar mode.

Parameters
modeThe mode.

Definition at line 63 of file DotBarDisplayLEDs.hpp.

◆ dotMode()

void dotMode ( )
inlineinherited

Set the mode to dot mode.

Definition at line 66 of file DotBarDisplayLEDs.hpp.

◆ barMode()

void barMode ( )
inlineinherited

Set the mode to bar mode.

Definition at line 69 of file DotBarDisplayLEDs.hpp.

◆ toggleMode()

void toggleMode ( )
inlineinherited

Toggle the dot/bar mode.

Definition at line 72 of file DotBarDisplayLEDs.hpp.

◆ begin() [2/2]

template<uint16_t N>
void begin ( ) const
inlineinherited

Initialize (set LED pins as outputs).

Definition at line 31 of file LEDs.hpp.

◆ displayRange()

template<uint16_t N>
void displayRange ( uint16_t startOn,
uint16_t startOff ) const
inlineinherited

Turn on a range of the LEDs.

Parameters
startOnThe first LED of the range to turn on (the LEDs before this one are turned off).
startOffThe first LED after the range to turn off.

Definition at line 45 of file LEDs.hpp.

◆ set()

template<uint16_t N>
void set ( uint16_t index) const
inlineinherited

Turn on the given LED.

Definition at line 55 of file LEDs.hpp.

◆ clear() [1/2]

template<uint16_t N>
void clear ( uint16_t index) const
inlineinherited

Turn off the given LED.

Definition at line 61 of file LEDs.hpp.

◆ clear() [2/2]

template<uint16_t N>
void clear ( ) const
inlineinherited

Turn off all LEDs.

Definition at line 77 of file LEDs.hpp.

◆ displayDot()

template<uint16_t N>
void displayDot ( uint16_t led) const
inlineinherited

Turn on a single LED, and turn off all others.

Parameters
ledThe LED to turn on.

Definition at line 72 of file LEDs.hpp.

Member Data Documentation

◆ states

template<uint8_t BankSize>
AH::Array<VUState, BankSize> states = {{}}
privateinherited

Definition at line 408 of file VU.hpp.

◆ decayTimer

template<uint8_t BankSize>
AH::Timer<millis> decayTimer
privateinherited

Definition at line 409 of file VU.hpp.

◆ matcher

template<MIDIMessageType Type, class Matcher >
Matcher matcher
protectedinherited

Definition at line 105 of file MIDIInputElement.hpp.

◆ updatables

DoublyLinkedList< MIDIInputElement< Type > > updatables
staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next [1/2]

template<class Node >
Node* next = nullptr
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ next [2/2]

BankSettingChangeCallback * next
protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous [1/2]

template<class Node >
Node* previous = nullptr
protectedinherited

Definition at line 321 of file LinkedList.hpp.

◆ previous [2/2]

BankSettingChangeCallback * previous
protectedinherited

Definition at line 321 of file LinkedList.hpp.

◆ max

uint8_t max
protectedinherited

Definition at line 110 of file InterfaceMIDIInputElements.hpp.

◆ alwaysDirty

bool alwaysDirty
protectedinherited

Definition at line 111 of file InterfaceMIDIInputElements.hpp.

◆ dirty

bool dirty = true
protectedinherited

Definition at line 112 of file InterfaceMIDIInputElements.hpp.

◆ FLOOR_CORRECTION

template<uint16_t NumLEDs>
constexpr uint8_t FLOOR_CORRECTION = 5
staticconstexprprivateinherited
See also
doc/VU-LED-mapping.ods

Definition at line 27 of file VULEDs.hpp.

◆ mode

DotBarMode mode
privateinherited

Definition at line 75 of file DotBarDisplayLEDs.hpp.

◆ ledPins

template<uint16_t N>
const PinList<N> ledPins
privateinherited

Definition at line 83 of file LEDs.hpp.


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