Control Surface master
MIDI Control Surface library for Arduino
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SmartMIDIFilteredAnalog< NumBanks, BankAddress, Sender > Class Template Reference

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

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

Public Types

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

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...
 
analog_t getPreviousValue (setting_t bank) const
 Get the previous value of the analog input of the given bank. More...
 
analog_t getPreviousValue () const
 Get the previous value of the analog input of the active bank. More...
 

Public Attributes

Sender sender
 

Protected Member Functions

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

Protected Attributes

BankAddress address
 
AH::FilteredAnalog< Sender::precision()> filteredAnalog
 
AH::Array< analog_t, NumBanks > previousValues = {{}}
 
State state = Active
 
setting_t previousBank = 0
 
Node * next = nullptr
 
Node * previous = nullptr
 

Static Protected Attributes

constexpr static analog_t initial = 1u << 14
 
static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

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
bankAddressThe bankable MIDI address to send to.
analogPinThe analog input pin with the wiper of the potentiometer connected.
senderThe MIDI sender to use.

Definition at line 41 of file SmartMIDIFilteredAnalog.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtual

Initialize this updatable.

Implements Updatable< T >.

Definition at line 61 of file SmartMIDIFilteredAnalog.hpp.

◆ update()

void update ( )
inlineoverridevirtual

Update this updatable.

Implements Updatable< T >.

Definition at line 68 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
fnA 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.

◆ getPreviousValue() [1/2]

analog_t getPreviousValue ( setting_t  bank) const
inline

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

Definition at line 139 of file SmartMIDIFilteredAnalog.hpp.

◆ getPreviousValue() [2/2]

analog_t getPreviousValue ( ) const
inline

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

Definition at line 146 of file SmartMIDIFilteredAnalog.hpp.

◆ beginAll()

static void beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

Definition at line 190 of file Updatable.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< Updatable< NormalUpdatable > > *  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< Updatable< NormalUpdatable > > &  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< Updatable< NormalUpdatable > > *  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< Updatable< NormalUpdatable > > &  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.

Member Data Documentation

◆ address

BankAddress address
protected

Definition at line 151 of file SmartMIDIFilteredAnalog.hpp.

◆ filteredAnalog

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

Definition at line 152 of file SmartMIDIFilteredAnalog.hpp.

◆ initial

constexpr static analog_t initial = 1u << 14
staticconstexprprotected

Definition at line 157 of file SmartMIDIFilteredAnalog.hpp.

◆ previousValues

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

Definition at line 158 of file SmartMIDIFilteredAnalog.hpp.

◆ state

State state = Active
protected

Definition at line 159 of file SmartMIDIFilteredAnalog.hpp.

◆ previousBank

setting_t previousBank = 0
protected

Definition at line 160 of file SmartMIDIFilteredAnalog.hpp.

◆ sender

Sender sender

Definition at line 163 of file SmartMIDIFilteredAnalog.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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