A class for potentiometers and faders that send MIDI events. More...

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

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

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

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

using	Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

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

void	update () override
	Update this updatable. More...

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

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

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

void	invert ()
	Invert the analog value. More...

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

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

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
Sender	sender

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

Protected Attributes
Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable, false > >	updatables

static Mutex	mutex

Private Attributes
BankAddress	address

AH::FilteredAnalog< Sender::precision()>	filteredAnalog

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

State	state = Active

setting_t	previousBank = 0

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

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

Enabling and disabling updatables
void	enable (const LockGuard &lock)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer 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 LockGuard &) const
	Check if this updatable is enabled. More...

bool	isEnabled ()
	Check if this updatable is enabled. More...

void	moveDown (const LockGuard &)
	Move down this element in the list. 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...

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

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

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 28 of file SmartMIDIFilteredAnalog.hpp.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Member Enumeration Documentation

◆ State

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 47 of file SmartMIDIFilteredAnalog.hpp.

Constructor & Destructor Documentation

◆ SmartMIDIFilteredAnalog()

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 41 of file SmartMIDIFilteredAnalog.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtual

Initialize this updatable.

Implements Updatable<>.

Definition at line 61 of file SmartMIDIFilteredAnalog.hpp.

◆ update()

void update ( )

inlineoverridevirtual

Update this updatable.

Implements Updatable<>.

Definition at line 66 of file SmartMIDIFilteredAnalog.hpp.

◆ getState()

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 99 of file SmartMIDIFilteredAnalog.hpp.

◆ activate()

void activate ( )

inline

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

Definition at line 105 of file SmartMIDIFilteredAnalog.hpp.

◆ map()

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 119 of file SmartMIDIFilteredAnalog.hpp.

◆ invert()

void invert ( )

inline

Invert the analog value.

Definition at line 122 of file SmartMIDIFilteredAnalog.hpp.

◆ getRawValue()

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 128 of file SmartMIDIFilteredAnalog.hpp.

◆ getValue()

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 134 of file SmartMIDIFilteredAnalog.hpp.

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex ( )

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.