Control Surface main
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 | Static Private Attributes | List of all members
VULEDs< NumLEDs > Class Template Reference

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

Detailed Description

template<uint8_t NumLEDs>
class MCU::VULEDs< NumLEDs >

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

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

Definition at line 43 of file VULEDs.hpp.

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

Data access

uint8_t getValue () override
 Get the most recent VU position that was received. More...
 
bool getOverload () override
 Get the status of the overload indicator. More...
 

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 = VU
 
using Matcher = typename Parent::Matcher
 
using MessageType = typename MIDIInputElement< Type >::MessageType
 

Public Member Functions

 VULEDs (const PinList< NumLEDs > &leds, uint8_t track, MIDIChannelCable channelCN, unsigned int decayTime=VUDecay::Default)
 
 VULEDs (const PinList< NumLEDs > &leds, uint8_t track, unsigned int decayTime=VUDecay::Default)
 
void begin () override
 Initialize the input element. More...
 
void reset () override
 Reset the input element to its initial state. More...
 
void update () override
 Update the value of the input element. Used for decaying VU meters etc. More...
 
bool updateWith (MessageType midimsg) override
 Receive a new MIDI message and update the internal state. More...
 
virtual float getFloatValue ()
 Get the VU meter value as a floating point number. More...
 
uint8_t getMax () const
 Get the maximum value that this VU meter can return. More...
 
void displayVU (uint16_t value)
 
void display (uint16_t value) const
 Display the given number of LEDs on the LED bar. More...
 
void display (float value) const
 Display the given fraction of the LED bar. More...
 
DotBarMode getMode () const
 Get the dot/bar mode. More...
 
void setMode (DotBarMode mode)
 Set the mode to either dot or bar mode. More...
 
void dotMode ()
 Set the mode to dot mode. More...
 
void barMode ()
 Set the mode to bar mode. More...
 
void toggleMode ()
 Toggle the dot/bar mode. More...
 
void begin () const
 Initialize (set LED pins as outputs). More...
 
void displayRange (uint16_t startOn, uint16_t startOff) const
 Turn on a range of the LEDs. More...
 
void set (uint16_t index) const
 Turn on the given LED. More...
 
void clear (uint16_t index) const
 Turn off the given LED. More...
 
void clear () const
 Turn off all LEDs. More...
 
void displayDot (uint16_t led) const
 Turn on a single LED, and turn off all others. 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 updateDisplay ()
 
bool handleUpdateImpl (typename Matcher::Result match)
 
void handleUpdate (typename Matcher::Result match) override
 
bool decay ()
 

Protected Attributes

VUMatcher matcher
 
MIDIInputElement< Type > * next
 
MIDIInputElement< Type > * previous
 
uint8_t max
 
bool alwaysDirty
 
bool dirty = true
 

Static Protected Attributes

static DoublyLinkedList< MIDIInputElement< Type > > updatables
 

Private Attributes

VUState state = {}
 
AH::Timer< millis > decayTimer
 
DotBarMode mode
 
const PinList< N > ledPins
 

Static Private Attributes

static constexpr uint8_t FLOOR_CORRECTION = 5
 

Member Typedef Documentation

◆ Parent

using Parent = VU

Definition at line 45 of file VULEDs.hpp.

◆ Matcher

using Matcher = typename Parent::Matcher

Definition at line 46 of file VULEDs.hpp.

◆ MessageType

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

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ VULEDs() [1/2]

VULEDs ( const PinList< NumLEDs > &  leds,
uint8_t  track,
MIDIChannelCable  channelCN,
unsigned int  decayTime = VUDecay::Default 
)
inline
Parameters
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 64 of file VULEDs.hpp.

◆ VULEDs() [2/2]

VULEDs ( const PinList< NumLEDs > &  leds,
uint8_t  track,
unsigned int  decayTime = VUDecay::Default 
)
inline
Parameters
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 82 of file VULEDs.hpp.

Member Function Documentation

◆ handleUpdate() [1/2]

void handleUpdate ( typename Matcher::Result  match)
inlineoverrideprotectedvirtual

◆ updateDisplay()

void updateDisplay ( )
inlineprotected

Definition at line 94 of file VULEDs.hpp.

◆ begin() [1/2]

void begin ( )
inlineoverridevirtual

Initialize the input element.

Reimplemented from MIDIInputElement< Type >.

Definition at line 97 of file VULEDs.hpp.

◆ reset()

void reset ( )
inlineoverridevirtual

Reset the input element to its initial state.

Reimplemented from MIDIInputElement< Type >.

Definition at line 103 of file VULEDs.hpp.

◆ update()

void update ( )
inlineoverridevirtual

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

Reimplemented from MIDIInputElement< Type >.

Definition at line 108 of file VULEDs.hpp.

◆ handleUpdateImpl()

bool handleUpdateImpl ( typename Matcher::Result  match)
inlineprotectedinherited

Definition at line 237 of file VU.hpp.

◆ handleUpdate() [2/2]

void handleUpdate ( typename Matcher::Result  match)
inlineoverrideprotectedinherited

Definition at line 245 of file VU.hpp.

◆ decay()

bool decay ( )
inlineprotectedinherited

Definition at line 249 of file VU.hpp.

◆ getValue()

uint8_t getValue ( )
inlineoverridevirtualinherited

Get the most recent VU position that was received.

Implements IVU.

Definition at line 269 of file VU.hpp.

◆ getOverload()

bool getOverload ( )
inlineoverridevirtualinherited

Get the status of the overload indicator.

Implements IVU.

Definition at line 271 of file VU.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.

◆ 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 97 of file InterfaceMIDIInputElements.hpp.

◆ clearDirty()

void clearDirty ( )
inlineinherited

Clear the dirty flag.

Definition at line 99 of file InterfaceMIDIInputElements.hpp.

◆ getFloatValue()

virtual float getFloatValue ( )
inlinevirtualinherited

Get the VU meter value as a floating point number.

Reimplemented in AudioVU, and VU< BankSize >.

Definition at line 108 of file InterfaceMIDIInputElements.hpp.

◆ getMax()

uint8_t getMax ( ) const
inlineinherited

Get the maximum value that this VU meter can return.

Definition at line 110 of file InterfaceMIDIInputElements.hpp.

◆ displayVU()

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 40 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 55 of file DotBarDisplayLEDs.hpp.

◆ getMode()

DotBarMode getMode ( ) const
inlineinherited

Get the dot/bar mode.

Definition at line 58 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 66 of file DotBarDisplayLEDs.hpp.

◆ dotMode()

void dotMode ( )
inlineinherited

Set the mode to dot mode.

Definition at line 69 of file DotBarDisplayLEDs.hpp.

◆ barMode()

void barMode ( )
inlineinherited

Set the mode to bar mode.

Definition at line 72 of file DotBarDisplayLEDs.hpp.

◆ toggleMode()

void toggleMode ( )
inlineinherited

Toggle the dot/bar mode.

Definition at line 75 of file DotBarDisplayLEDs.hpp.

◆ begin() [2/2]

void begin ( ) const
inlineinherited

Initialize (set LED pins as outputs).

Definition at line 34 of file LEDs.hpp.

◆ displayRange()

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 48 of file LEDs.hpp.

◆ set()

void set ( uint16_t  index) const
inlineinherited

Turn on the given LED.

Definition at line 58 of file LEDs.hpp.

◆ clear() [1/2]

void clear ( uint16_t  index) const
inlineinherited

Turn off the given LED.

Definition at line 64 of file LEDs.hpp.

◆ clear() [2/2]

void clear ( ) const
inlineinherited

Turn off all LEDs.

Definition at line 80 of file LEDs.hpp.

◆ displayDot()

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 75 of file LEDs.hpp.

Member Data Documentation

◆ state

VUState state = {}
privateinherited

Definition at line 276 of file VU.hpp.

◆ decayTimer

AH::Timer<millis> decayTimer
privateinherited

Definition at line 277 of file VU.hpp.

◆ matcher

VUMatcher 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

MIDIInputElement< Type > * next
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

MIDIInputElement< Type > * previous
protectedinherited

Definition at line 325 of file LinkedList.hpp.

◆ max

uint8_t max
protectedinherited

Definition at line 113 of file InterfaceMIDIInputElements.hpp.

◆ alwaysDirty

bool alwaysDirty
protectedinherited

Definition at line 114 of file InterfaceMIDIInputElements.hpp.

◆ dirty

bool dirty = true
protectedinherited

Definition at line 115 of file InterfaceMIDIInputElements.hpp.

◆ FLOOR_CORRECTION

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 78 of file DotBarDisplayLEDs.hpp.

◆ ledPins

const PinList<N> ledPins
privateinherited

Definition at line 86 of file LEDs.hpp.


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