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

Detailed Description

template<uint8_t BankSize>
class MCU::Bankable::VPotRingLEDs< BankSize >

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

This version can be banked.

Template Parameters

BankSize The number of banks.

Definition at line 84 of file VPotRingLEDs.hpp.

Inheritance diagram for VPotRingLEDs< BankSize >:

Collaboration diagram for VPotRingLEDs< BankSize >:

Data access
VPotState	getState (uint8_t bank) const
	Get the full state of the VPot ring. (For the given bank.) More...

VPotState	getState () const
	Get the full state of the VPot ring. (For the active bank.) More...

uint8_t	getPosition (uint8_t bank) const
	Return the position of the V-Pot ring. [0, 11]. More...

uint8_t	getPosition () const
	Return the position of the V-Pot ring. [0, 11]. More...

bool	getCenterLed (uint8_t bank) const
	Return the status of the center LED of the V-Pot ring. More...

bool	getCenterLed () const override
	Return the status of the center LED of the V-Pot ring. More...

VPotState::Mode	getMode (uint8_t bank) const
	Return the mode of the V-Pot ring. More...

VPotState::Mode	getMode () const
	Return the mode of the V-Pot ring. More...

uint8_t	getStartOn (uint8_t bank) const
	Get the first segment that should be on. More...

uint8_t	getStartOn () const override
	Get the first segment that should be on. More...

uint8_t	getStartOff (uint8_t bank) const
	Get the first segment that should be off. More...

uint8_t	getStartOff () const override
	Get the first segment that should be off. 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 = VPotRing< BankSize >

using	Matcher = typename Parent::Matcher

using	MessageType = typename MIDIInputElement< Type >::MessageType

Public Member Functions
	VPotRingLEDs (BankConfig< BankSize > config, const PinList< 11 > &leds, uint8_t track, MIDIChannelCable channelCN=CHANNEL_1)
	Constructor. More...

void	begin () override
	Initialize the input element. More...

void	reset () override
	Reset the input element to its initial state. 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...

void	displayVPot (VPotState v)

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

Public Attributes
bool	ignoreReset = true
	Don't reset the state when calling the `reset` method. More...

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

bool	handleUpdateImpl (typename Matcher::Result match)

void	handleUpdate (typename Matcher::Result match) override

uint8_t	getActiveBank () const

Protected Attributes
BankableVPotMatcher< BankSize >	matcher

MIDIInputElement< Type > *	next

BankSettingChangeCallback *	next

MIDIInputElement< Type > *	previous

BankSettingChangeCallback *	previous

bool	dirty = true

Static Protected Attributes
static DoublyLinkedList< MIDIInputElement< Type > >	updatables

Private Attributes
AH::Array< VPotState, BankSize >	states = {{}}

const PinList< N >	ledPins

Member Typedef Documentation

◆ Parent

using Parent = VPotRing<BankSize>

Definition at line 86 of file VPotRingLEDs.hpp.

◆ Matcher

using Matcher = typename Parent::Matcher

Definition at line 87 of file VPotRingLEDs.hpp.

◆ MessageType

using MessageType = typename MIDIInputElement<Type>::MessageType

inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ VPotRingLEDs()

VPotRingLEDs	(	BankConfig< BankSize >	config,
		const PinList< 11 > &	leds,
		uint8_t	track,
		MIDIChannelCable	channelCN = `CHANNEL_1`
	)

inline

Constructor.

Parameters

config	The bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
leds	The pins with LEDs connected.
track	The track of the VPot. [1, 8]
channelCN	The MIDI channel [CHANNEL_1, CHANNEL_16] and Cable Number [CABLE_1, CABLE_16].

Definition at line 103 of file VPotRingLEDs.hpp.

Member Function Documentation

◆ handleUpdate() [1/2]

void handleUpdate ( typename Matcher::Result match )

inlineoverrideprotectedvirtual

Implements MatchingMIDIInputElement< Type, BankableVPotMatcher< BankSize > >.

Definition at line 109 of file VPotRingLEDs.hpp.

◆ updateDisplay()

void updateDisplay ( )

inlineprotected

Definition at line 116 of file VPotRingLEDs.hpp.

◆ begin() [1/2]

void begin ( )

inlineoverridevirtual

Initialize the input element.

Reimplemented from MIDIInputElement< Type >.

Definition at line 121 of file VPotRingLEDs.hpp.

◆ reset()

void reset ( )

inlineoverridevirtual

Reset the input element to its initial state.

Reimplemented from MIDIInputElement< Type >.

Definition at line 127 of file VPotRingLEDs.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 133 of file VPotRingLEDs.hpp.

◆ handleUpdateImpl()

bool handleUpdateImpl ( typename Matcher::Result match )

inlineprotectedinherited

Definition at line 263 of file VPotRing.hpp.

◆ handleUpdate() [2/2]

void handleUpdate ( typename Matcher::Result match )

inlineoverrideprotectedinherited

Definition at line 269 of file VPotRing.hpp.

◆ getState() [1/2]

VPotState getState ( uint8_t bank ) const

inlineinherited

Get the full state of the VPot ring. (For the given bank.)

Definition at line 278 of file VPotRing.hpp.

◆ getState() [2/2]

VPotState getState ( ) const

inlineinherited

Get the full state of the VPot ring. (For the active bank.)

Definition at line 308 of file VPotRing.hpp.

◆ getPosition() [1/2]

uint8_t getPosition ( uint8_t bank ) const

inlineinherited

Return the position of the V-Pot ring. [0, 11].

(For the given bank.)

Definition at line 282 of file VPotRing.hpp.

◆ getPosition() [2/2]

uint8_t getPosition ( ) const

inlineinherited

Return the position of the V-Pot ring. [0, 11].

(For the active bank.)

Definition at line 312 of file VPotRing.hpp.

◆ getCenterLed() [1/2]

bool getCenterLed ( uint8_t bank ) const

inlineinherited

Return the status of the center LED of the V-Pot ring.

(For the given bank.)

Definition at line 287 of file VPotRing.hpp.

◆ getCenterLed() [2/2]

bool getCenterLed ( ) const

inlineoverridevirtualinherited

Return the status of the center LED of the V-Pot ring.

(For the active bank.)

Implements IVPot.

Definition at line 315 of file VPotRing.hpp.

◆ getMode() [1/2]

VPotState::Mode getMode ( uint8_t bank ) const

inlineinherited

Return the mode of the V-Pot ring.

(For the given bank.)

Definition at line 292 of file VPotRing.hpp.

◆ getMode() [2/2]

VPotState::Mode getMode ( ) const

inlineinherited

Return the mode of the V-Pot ring.

(For the active bank.)

Definition at line 320 of file VPotRing.hpp.

◆ getStartOn() [1/2]

uint8_t getStartOn ( uint8_t bank ) const

inlineinherited

Get the first segment that should be on.

(For the given bank.)

Definition at line 298 of file VPotRing.hpp.

◆ getStartOn() [2/2]

uint8_t getStartOn ( ) const

inlineoverridevirtualinherited

Get the first segment that should be on.

(For the active bank.)

Implements IVPot.

Definition at line 324 of file VPotRing.hpp.

◆ getStartOff() [1/2]

uint8_t getStartOff ( uint8_t bank ) const

inlineinherited

Get the first segment that should be off.

(For the given bank.)

Definition at line 303 of file VPotRing.hpp.

◆ getStartOff() [2/2]

uint8_t getStartOff ( ) const

inlineoverridevirtualinherited

Get the first segment that should be off.

(For the active bank.)

Implements IVPot.

Definition at line 329 of file VPotRing.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 64 of file InterfaceMIDIInputElements.hpp.

◆ clearDirty()

void clearDirty ( )

inlineinherited

Clear the dirty flag.

Definition at line 66 of file InterfaceMIDIInputElements.hpp.

◆ displayVPot()

void displayVPot ( VPotState v )

inlineinherited

Definition at line 14 of file VPotRingLEDs.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

startOn	The first LED of the range to turn on (the LEDs before this one are turned off).
startOff	The 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

led	The LED to turn on.

Definition at line 75 of file LEDs.hpp.

Member Data Documentation

◆ states

AH::Array<VPotState, BankSize> states = {{}}

privateinherited

Definition at line 347 of file VPotRing.hpp.

◆ ignoreReset

bool ignoreReset = true

inherited

Don't reset the state when calling the reset method.

This is the default, because in the original MCU, VPots don't get reset when a Reset All Controllers message is received.

Definition at line 353 of file VPotRing.hpp.

◆ matcher

BankableVPotMatcher< BankSize > 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]

MIDIInputElement< Type > * next

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]

MIDIInputElement< Type > * previous

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 75 of file InterfaceMIDIInputElements.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:

VPotRingLEDs.hpp

Detailed Description

Data access

Enabling and disabling updatables

Detecting changes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Member Typedef Documentation

◆ Parent

◆ Matcher

◆ MessageType

Constructor & Destructor Documentation

◆ VPotRingLEDs()

Member Function Documentation

◆ handleUpdate() [1/2]

◆ updateDisplay()

◆ begin() [1/2]

◆ reset()

◆ onBankSettingChange()

◆ handleUpdateImpl()

◆ handleUpdate() [2/2]

◆ getState() [1/2]

◆ getState() [2/2]

◆ getPosition() [1/2]

◆ getPosition() [2/2]

◆ getCenterLed() [1/2]

◆ getCenterLed() [2/2]

◆ getMode() [1/2]

◆ getMode() [2/2]

◆ getStartOn() [1/2]

◆ getStartOn() [2/2]

◆ getStartOff() [1/2]

◆ getStartOff() [2/2]

◆ getActiveBank()

◆ updateWith()

◆ update()

◆ updateAllWith()

◆ updateAll()

◆ beginAll()

◆ resetAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

◆ getDirty()

◆ clearDirty()

◆ displayVPot()

◆ begin() [2/2]

◆ displayRange()

◆ set()

◆ clear() [1/2]

◆ clear() [2/2]

◆ displayDot()

Member Data Documentation

◆ states

◆ ignoreReset

◆ matcher

◆ updatables

◆ next [1/2]

◆ next [2/2]

◆ previous [1/2]

◆ previous [2/2]

◆ dirty

◆ ledPins