#include <MIDI_Inputs/LEDs/NoteCCKPLEDBar.hpp>

Detailed Description

template<MIDIMessageType Type, uint8_t BankSize, uint8_t NumLEDs>
class Bankable::NoteCCKPLEDBar< Type, BankSize, NumLEDs >

Class that turns on a different number of LEDs depending on the received MIDI velocity, key pressure or Control Change value.

Similar to a digital LED VU meter. Can be configured in either bar or dot mode. This version can be banked.

Definition at line 100 of file NoteCCKPLEDBar.hpp.

Inheritance diagram for NoteCCKPLEDBar< Type, BankSize, NumLEDs >:

Collaboration diagram for NoteCCKPLEDBar< Type, BankSize, NumLEDs >:

Data access
uint8_t	getValue () const override
	Get the most recent MIDI value that was received for the active bank. More...

uint8_t	getValue (uint8_t bank) const
	Get the most recent MIDI value that was received for the given bank. 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 = NoteCCKPValue< Type, BankSize >

using	Matcher = typename Parent::Matcher

using	MessageType = typename MIDIInputElement< Type >::MessageType

Public Member Functions
	NoteCCKPLEDBar (BankConfig< BankSize > config, const AH::PinList< NumLEDs > &leds, MIDIAddress address)

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

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
BankableTwoByteMIDIMatcher< 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< uint8_t, BankSize >	values = {{}}

DotBarMode	mode

const PinList< N >	ledPins

Member Typedef Documentation

◆ Parent

using Parent = NoteCCKPValue<Type, BankSize>

Definition at line 103 of file NoteCCKPLEDBar.hpp.

◆ Matcher

using Matcher = typename Parent::Matcher

Definition at line 104 of file NoteCCKPLEDBar.hpp.

◆ MessageType

using MessageType = typename MIDIInputElement<Type>::MessageType

inherited

Definition at line 93 of file MIDIInputElement.hpp.

Constructor & Destructor Documentation

◆ NoteCCKPLEDBar()

NoteCCKPLEDBar	(	BankConfig< BankSize >	config,
		const AH::PinList< NumLEDs > &	leds,
		MIDIAddress	address
	)

inline

Parameters

config	The bank configuration to use.
leds	A list of LED pins.
address	The MIDI address to listen to.

Definition at line 112 of file NoteCCKPLEDBar.hpp.

Member Function Documentation

◆ handleUpdate() [1/2]

void handleUpdate ( typename Matcher::Result match )

inlineoverrideprotectedvirtual

Implements MatchingMIDIInputElement< Type, BankableTwoByteMIDIMatcher< BankSize > >.

Definition at line 117 of file NoteCCKPLEDBar.hpp.

◆ updateDisplay()

void updateDisplay ( )

inlineprotected

Definition at line 124 of file NoteCCKPLEDBar.hpp.

◆ begin() [1/2]

void begin ( )

inlineoverridevirtual

Initialize the input element.

Reimplemented from MIDIInputElement< Type >.

Definition at line 127 of file NoteCCKPLEDBar.hpp.

◆ reset()

void reset ( )

inlineoverridevirtual

Reset the input element to its initial state.

Reimplemented from MIDIInputElement< Type >.

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

◆ handleUpdateImpl()

bool handleUpdateImpl ( typename Matcher::Result match )

inlineprotectedinherited

Definition at line 104 of file NoteCCKPValue.hpp.

◆ handleUpdate() [2/2]

void handleUpdate ( typename Matcher::Result match )

inlineoverrideprotectedinherited

Definition at line 112 of file NoteCCKPValue.hpp.

◆ getValue() [1/2]

uint8_t getValue ( ) const

inlineoverridevirtualinherited

Get the most recent MIDI value that was received for the active bank.

Implements IValue.

Reimplemented in NoteCCKPLED< Type, BankSize >, and NoteCCKPLEDPWM< Type, BankSize >.

Definition at line 121 of file NoteCCKPValue.hpp.

◆ getValue() [2/2]

uint8_t getValue ( uint8_t bank ) const

inlineinherited

Get the most recent MIDI value that was received for the given bank.

Definition at line 123 of file NoteCCKPValue.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 22 of file InterfaceMIDIInputElements.hpp.

◆ clearDirty()

void clearDirty ( )

inlineinherited

Clear the dirty flag.

Definition at line 24 of file InterfaceMIDIInputElements.hpp.

◆ displayBar()

void displayBar ( uint8_t value )

inlineinherited

Definition at line 20 of file NoteCCKPLEDBar.hpp.

◆ display() [1/2]

void display ( uint16_t value ) const

inlineinherited

Display the given number of LEDs on the LED bar.

Parameters

value The 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

value The 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

mode The 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

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

◆ values

AH::Array<uint8_t, BankSize> values = {{}}

privateinherited

Definition at line 137 of file NoteCCKPValue.hpp.

◆ matcher

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

NoteCCKPLEDBar.hpp

Detailed Description

Data access

Enabling and disabling updatables

Detecting changes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Member Typedef Documentation

◆ Parent

◆ Matcher

◆ MessageType

Constructor & Destructor Documentation

◆ NoteCCKPLEDBar()

Member Function Documentation

◆ handleUpdate() [1/2]

◆ updateDisplay()

◆ begin() [1/2]

◆ reset()

◆ onBankSettingChange()

◆ handleUpdateImpl()

◆ handleUpdate() [2/2]

◆ getValue() [1/2]

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

◆ displayBar()

◆ display() [1/2]

◆ display() [2/2]

◆ getMode()

◆ setMode()

◆ dotMode()

◆ barMode()

◆ toggleMode()

◆ begin() [2/2]

◆ displayRange()

◆ set()

◆ clear() [1/2]

◆ clear() [2/2]

◆ displayDot()

Member Data Documentation

◆ values

◆ matcher

◆ updatables

◆ next [1/2]

◆ next [2/2]

◆ previous [1/2]

◆ previous [2/2]

◆ dirty

◆ mode

◆ ledPins