#include <MIDI_Outputs/Bankable/Abstract/SmartMIDIFilteredAnalog.hpp>

Detailed Description

template<uint8_t NumBanks, class BankAddress, class Sender>
class Bankable::SmartMIDIFilteredAnalog< NumBanks, BankAddress, Sender >

A class for potentiometers and faders that send MIDI events.

When changing banks, it disables the potentiometer until you move it to the position where it was last time the current bank was active. This prevents the values changing when changing banks.

The analog input is filtered and hysteresis is applied.

See also: FilteredAnalog

Definition at line 26 of file SmartMIDIFilteredAnalog.hpp.

Inheritance diagram for SmartMIDIFilteredAnalog< NumBanks, BankAddress, Sender >:

Collaboration diagram for SmartMIDIFilteredAnalog< NumBanks, BankAddress, Sender >:

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.

template<class U , size_t N>
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.

template<class U , size_t N>
static void	disable (U(&array)[N])
	Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Main initialization and updating methods
static void	beginAll ()
	Begin all enabled instances of this class.

static void	updateAll ()
	Update all enabled instances of this class.

Public Types
enum	State { Active , Lower , Higher }
	State of the smart potentiometer. More...

Public Member Functions
void	begin () override
	Initialize this updatable.

void	update () override
	Update this updatable.

State	getState () const
	Get the state of the smart potentiometer, to know whether the position has to be lower or higher in order to activate it.

void	activate ()
	Activate the potentiometer in the current bank, regardless of its current and previous position.

void	map (MappingFunction fn)
	Specify a mapping function that is applied to the raw analog value before sending.

void	invert ()
	Invert the analog value.

analog_t	getRawValue () const
	Get the raw value of the analog input (this is the value without applying the filter or the mapping function first).

analog_t	getValue () const
	Get the value of the analog input (this is the value after first applying the mapping function).

analog_t	getPreviousValue (setting_t bank) const
	Get the previous value of the analog input of the given bank.

analog_t	getPreviousValue () const
	Get the previous value of the analog input of the active bank.

Static Public Member Functions
static constexpr analog_t	getMaxRawValue ()
	Get the maximum value that can be returned from getRawValue.

Public Attributes
Sender	sender

Protected Types
using	FilteredAnalog = AH::FilteredAnalog<Sender::precision()>

Protected Member Functions
	SmartMIDIFilteredAnalog (BankAddress bankAddress, pin_t analogPin, const Sender &sender)
	Construct a new SmartMIDIFilteredAnalog.

Protected Attributes
BankAddress	address

FilteredAnalog	filteredAnalog

AH::Array< analog_t, NumBanks >	previousValues = {{}}

State	state = Active

setting_t	previousBank = 0

Derived *	next

Derived *	previous

Static Protected Attributes
static constexpr analog_t	initial = 1u << 14

static DoublyLinkedList< Derived >	updatables

Member Typedef Documentation

◆ FilteredAnalog

template<uint8_t NumBanks, class BankAddress , class Sender >

using FilteredAnalog = AH::FilteredAnalog<Sender::precision()>

protected

Definition at line 157 of file SmartMIDIFilteredAnalog.hpp.

Member Enumeration Documentation

◆ State

template<uint8_t NumBanks, class BankAddress , class Sender >

enum State

State of the smart potentiometer.

Enumerator

Active

The potentiometer is active, the position changes will be sent over MIDI.

Lower

The value of the potentiometer is lower than the previously recorded value for the current bank.

In order to activate the potentiometer, you have to move it up.

Higher

The value of the potentiometer is higher than the previously recorded value for the current bank.

In order to activate the potentiometer, you have to move it down.

Definition at line 45 of file SmartMIDIFilteredAnalog.hpp.

Constructor & Destructor Documentation

◆ SmartMIDIFilteredAnalog()

template<uint8_t NumBanks, class BankAddress , class Sender >

SmartMIDIFilteredAnalog	(	BankAddress	bankAddress,
		pin_t	analogPin,
		const Sender &	sender )

inlineprotected

Construct a new SmartMIDIFilteredAnalog.

Parameters

bankAddress	The bankable MIDI address to send to.
analogPin	The analog input pin with the wiper of the potentiometer connected.
sender	The MIDI sender to use.

Definition at line 39 of file SmartMIDIFilteredAnalog.hpp.

Member Function Documentation

◆ begin()

template<uint8_t NumBanks, class BankAddress , class Sender >

void begin ( )

inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 59 of file SmartMIDIFilteredAnalog.hpp.

◆ update()

template<uint8_t NumBanks, class BankAddress , class Sender >

void update ( )

inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 66 of file SmartMIDIFilteredAnalog.hpp.

◆ getState()

template<uint8_t NumBanks, class BankAddress , class Sender >

State getState ( ) const

inline

Get the state of the smart potentiometer, to know whether the position has to be lower or higher in order to activate it.

Definition at line 97 of file SmartMIDIFilteredAnalog.hpp.

◆ activate()

template<uint8_t NumBanks, class BankAddress , class Sender >

void activate ( )

inline

Activate the potentiometer in the current bank, regardless of its current and previous position.

Definition at line 103 of file SmartMIDIFilteredAnalog.hpp.

◆ map()

template<uint8_t NumBanks, class BankAddress , class Sender >

void map ( MappingFunction fn )

inline

Specify a mapping function that is applied to the raw analog value before sending.

Parameters

fn	A function pointer to the mapping function. This function should take the filtered analog value of \( 16 - \mathrm{ANALOG\_FILTER\_SHIFT\_FACTOR} \) bits as a parameter, and should return a value in the same range.

See also: FilteredAnalog::map

Definition at line 117 of file SmartMIDIFilteredAnalog.hpp.

◆ invert()

template<uint8_t NumBanks, class BankAddress , class Sender >

void invert ( )

inline

Invert the analog value.

Definition at line 120 of file SmartMIDIFilteredAnalog.hpp.

◆ getRawValue()

template<uint8_t NumBanks, class BankAddress , class Sender >

analog_t getRawValue ( ) const

inline

Get the raw value of the analog input (this is the value without applying the filter or the mapping function first).

Definition at line 126 of file SmartMIDIFilteredAnalog.hpp.

◆ getMaxRawValue()

template<uint8_t NumBanks, class BankAddress , class Sender >

static constexpr analog_t getMaxRawValue ( )

inlinestaticconstexpr

Get the maximum value that can be returned from getRawValue.

Definition at line 131 of file SmartMIDIFilteredAnalog.hpp.

◆ getValue()

template<uint8_t NumBanks, class BankAddress , class Sender >

analog_t getValue ( ) const

inline

Get the value of the analog input (this is the value after first applying the mapping function).

Definition at line 139 of file SmartMIDIFilteredAnalog.hpp.

◆ getPreviousValue() [1/2]

template<uint8_t NumBanks, class BankAddress , class Sender >

analog_t getPreviousValue ( setting_t bank ) const

inline

Get the previous value of the analog input of the given bank.

Definition at line 144 of file SmartMIDIFilteredAnalog.hpp.

◆ getPreviousValue() [2/2]

template<uint8_t NumBanks, class BankAddress , class Sender >

analog_t getPreviousValue ( ) const

inline

Get the previous value of the analog input of the active bank.

Definition at line 151 of file SmartMIDIFilteredAnalog.hpp.

◆ beginAll()

template<class T = NormalUpdatable>

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 182 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >

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]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > * 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]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > & 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]

template<class Derived >

template<class U , size_t N>

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]

template<class Derived >

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]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > * 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]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > & 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]

template<class Derived >

template<class U , size_t N>

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

template<class Derived >

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

template<class Derived >

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ address

template<uint8_t NumBanks, class BankAddress , class Sender >

BankAddress address

protected

Definition at line 156 of file SmartMIDIFilteredAnalog.hpp.

◆ filteredAnalog

template<uint8_t NumBanks, class BankAddress , class Sender >

FilteredAnalog filteredAnalog

protected

Definition at line 158 of file SmartMIDIFilteredAnalog.hpp.

◆ initial

template<uint8_t NumBanks, class BankAddress , class Sender >

constexpr analog_t initial = 1u << 14

staticconstexprprotected

Definition at line 163 of file SmartMIDIFilteredAnalog.hpp.

◆ previousValues

template<uint8_t NumBanks, class BankAddress , class Sender >

AH::Array<analog_t, NumBanks> previousValues = {{}}

protected

Definition at line 164 of file SmartMIDIFilteredAnalog.hpp.

◆ state

template<uint8_t NumBanks, class BankAddress , class Sender >

State state = Active

protected

Definition at line 165 of file SmartMIDIFilteredAnalog.hpp.

◆ previousBank

template<uint8_t NumBanks, class BankAddress , class Sender >

setting_t previousBank = 0

protected

Definition at line 166 of file SmartMIDIFilteredAnalog.hpp.

◆ sender

template<uint8_t NumBanks, class BankAddress , class Sender >

Sender sender

Definition at line 169 of file SmartMIDIFilteredAnalog.hpp.

◆ updatables

template<class Derived >

DoublyLinkedList< Derived > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

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

SmartMIDIFilteredAnalog.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

◆ FilteredAnalog

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ SmartMIDIFilteredAnalog()

Member Function Documentation

◆ begin()

◆ update()

◆ getState()

◆ activate()

◆ map()

◆ invert()

◆ getRawValue()

◆ getMaxRawValue()

◆ getValue()

◆ getPreviousValue() [1/2]

◆ getPreviousValue() [2/2]

◆ beginAll()

◆ updateAll()

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

Member Data Documentation

◆ address

◆ filteredAnalog

◆ initial

◆ previousValues

◆ state

◆ previousBank

◆ sender

◆ updatables

◆ next

◆ previous