#include <MIDI_Inputs/MCU/VPotRing.hpp>

Detailed Description

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

A MIDI input element that represents a Mackie Control Universal VPot ring.

This version can be banked.

Template Parameters

BankSize The number of banks.

Examples: MCU-OLED-SSD1306-x2.ino, and MCU-OLED-SSD1306.ino.

Definition at line 236 of file VPotRing.hpp.

Inheritance diagram for VPotRing< BankSize >:

Collaboration diagram for VPotRing< BankSize >:

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

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

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

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

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

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

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

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

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

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

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

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

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	Matcher = BankableVPotMatcher<BankSize>

using	Parent

using	MessageType = typename MIDIInputElement<Type>::MessageType

Public Member Functions
	VPotRing (BankConfig< BankSize > config, uint8_t track, MIDIChannelCable channelCN=Channel_1)
	Constructor.

void	reset () override
	Reset all states to zero.

bool	updateWith (MessageType midimsg) override
	Receive a new MIDI message and update the internal state.

virtual void	handleUpdate (typename Matcher::Result match)=0

virtual void	begin ()
	Initialize the input element.

virtual void	update ()
	Update the value of the input element. Used for decaying VU meters etc.

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.

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

Protected Member Functions
bool	handleUpdateImpl (typename Matcher::Result match)

void	handleUpdate (typename Matcher::Result match) override

void	onBankSettingChange () override
	A function to be executed each time the bank setting changes.

uint8_t	getActiveBank () const

Protected Attributes
Matcher	matcher

Node *	next = nullptr

BankSettingChangeCallback *	next

Node *	previous = nullptr

BankSettingChangeCallback *	previous

bool	dirty = true

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

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

Member Typedef Documentation

◆ Matcher

template<uint8_t BankSize>

using Matcher = BankableVPotMatcher<BankSize>

Definition at line 241 of file VPotRing.hpp.

◆ Parent

template<uint8_t BankSize>

using Parent

Initial value:

 
        BankableMatchingMIDIInputElement<MIDIMessageType::ControlChange,
                                         Matcher>

Definition at line 242 of file VPotRing.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

◆ VPotRing()

template<uint8_t BankSize>

VPotRing	(	BankConfig< BankSize >	config,
		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.
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 257 of file VPotRing.hpp.

Member Function Documentation

◆ handleUpdateImpl()

template<uint8_t BankSize>

bool handleUpdateImpl ( typename Matcher::Result match )

inlineprotected

Definition at line 262 of file VPotRing.hpp.

◆ handleUpdate() [1/2]

template<uint8_t BankSize>

void handleUpdate ( typename Matcher::Result match )

inlineoverrideprotected

Definition at line 268 of file VPotRing.hpp.

◆ getState() [1/2]

template<uint8_t BankSize>

VPotState getState ( uint8_t bank ) const

inline

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

Definition at line 277 of file VPotRing.hpp.

◆ getPosition() [1/2]

template<uint8_t BankSize>

uint8_t getPosition ( uint8_t bank ) const

inline

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

(For the given bank.)

Definition at line 281 of file VPotRing.hpp.

◆ getCenterLed() [1/2]

template<uint8_t BankSize>

bool getCenterLed ( uint8_t bank ) const

inline

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

(For the given bank.)

Definition at line 286 of file VPotRing.hpp.

◆ getMode() [1/2]

template<uint8_t BankSize>

VPotState::Mode getMode ( uint8_t bank ) const

inline

Return the mode of the V-Pot ring.

(For the given bank.)

Definition at line 291 of file VPotRing.hpp.

◆ getStartOn() [1/2]

template<uint8_t BankSize>

uint8_t getStartOn ( uint8_t bank ) const

inline

Get the first segment that should be on.

(For the given bank.)

Definition at line 297 of file VPotRing.hpp.

◆ getStartOff() [1/2]

template<uint8_t BankSize>

uint8_t getStartOff ( uint8_t bank ) const

inline

Get the first segment that should be off.

(For the given bank.)

Definition at line 302 of file VPotRing.hpp.

◆ getState() [2/2]

template<uint8_t BankSize>

VPotState getState ( ) const

inline

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

Definition at line 307 of file VPotRing.hpp.

◆ getPosition() [2/2]

template<uint8_t BankSize>

uint8_t getPosition ( ) const

inline

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

(For the active bank.)

Definition at line 311 of file VPotRing.hpp.

◆ getCenterLed() [2/2]

template<uint8_t BankSize>

bool getCenterLed ( ) const

inlineoverridevirtual

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

(For the active bank.)

Implements IVPot.

Definition at line 314 of file VPotRing.hpp.

◆ getMode() [2/2]

template<uint8_t BankSize>

VPotState::Mode getMode ( ) const

inline

Return the mode of the V-Pot ring.

(For the active bank.)

Definition at line 319 of file VPotRing.hpp.

◆ getStartOn() [2/2]

template<uint8_t BankSize>

uint8_t getStartOn ( ) const

inlineoverridevirtual

Get the first segment that should be on.

(For the active bank.)

Implements IVPot.

Definition at line 323 of file VPotRing.hpp.

◆ getStartOff() [2/2]

template<uint8_t BankSize>

uint8_t getStartOff ( ) const

inlineoverridevirtual

Get the first segment that should be off.

(For the active bank.)

Implements IVPot.

Definition at line 328 of file VPotRing.hpp.

◆ reset()

template<uint8_t BankSize>

void reset ( )

inlineoverridevirtual

Reset all states to zero.

Reimplemented from MIDIInputElement< Type >.

Reimplemented in VPotRingLEDs< BankSize >.

Definition at line 335 of file VPotRing.hpp.

◆ onBankSettingChange()

template<uint8_t BankSize>

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.

Reimplemented in VPotRingLEDs< BankSize >.

Definition at line 343 of file VPotRing.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.

◆ handleUpdate() [2/2]

template<MIDIMessageType Type, class Matcher >

virtual void handleUpdate ( typename Matcher::Result match )

pure virtualinherited

Implemented in VPotRingLEDs< BankSize >, VULEDs< NumLEDs >, VULEDs< BankSize, NumLEDs >, NoteCCKPLED< Type, BankSize >, NoteCCKPLEDBar< Type, BankSize, NumLEDs >, NoteCCKPLEDPWM< Type, BankSize >, NoteCCKPRangeFastLED< Type, BankSize, RangeLen, ColorMapper >, and NoteCCKPRangeLEDs< Type, BankSize, RangeLen >.

Examples: Custom-MIDI-Input-Element.ino, Custom-Note-LED-Input-Element-Callback-FastLED.ino, and Custom-Note-LED-Input-Element-Callback.ino.

◆ begin()

template<MIDIMessageType Type>

virtual void begin ( )

inlinevirtualinherited

◆ update()

template<MIDIMessageType Type>

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

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

◆ clearDirty()

void clearDirty ( )

inlineinherited

Clear the dirty flag.

Definition at line 63 of file InterfaceMIDIInputElements.hpp.

Member Data Documentation

◆ states

template<uint8_t BankSize>

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

private

Definition at line 346 of file VPotRing.hpp.

◆ ignoreReset

template<uint8_t BankSize>

bool ignoreReset = true

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 352 of file VPotRing.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.

◆ dirty

bool dirty = true

protectedinherited

Definition at line 72 of file InterfaceMIDIInputElements.hpp.

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

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

◆ Matcher

◆ Parent

◆ MessageType

Constructor & Destructor Documentation

◆ VPotRing()

Member Function Documentation

◆ handleUpdateImpl()

◆ handleUpdate() [1/2]

◆ getState() [1/2]

◆ getPosition() [1/2]

◆ getCenterLed() [1/2]

◆ getMode() [1/2]

◆ getStartOn() [1/2]

◆ getStartOff() [1/2]

◆ getState() [2/2]

◆ getPosition() [2/2]

◆ getCenterLed() [2/2]

◆ getMode() [2/2]

◆ getStartOn() [2/2]

◆ getStartOff() [2/2]

◆ reset()

◆ onBankSettingChange()

◆ getActiveBank()

◆ updateWith()

◆ handleUpdate() [2/2]

◆ begin()

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

Member Data Documentation

◆ states

◆ ignoreReset

◆ matcher

◆ updatables

◆ next [1/2]

◆ next [2/2]

◆ previous [1/2]

◆ previous [2/2]

◆ dirty