Control Surface master MIDI Control Surface library for Arduino
PBSmartPotentiometer< NumBanks > Class Template Reference

#include <MIDI_Outputs/Bankable/PBSmartPotentiometer.hpp>

## Detailed Description

template<uint8_t NumBanks>
class Bankable::PBSmartPotentiometer< NumBanks >

The analog input is filtered and hysteresis is applied for maximum stability.
The actual precision is "only" 10 bits, because this is the resolution of the built-in ADC, and this is the default resolution used by the Mackie Control Universal protocol.

This version can be banked, and 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.

Template Parameters
 NumBanks The number of banks.

Definition at line 35 of file PBSmartPotentiometer.hpp.

Inheritance diagram for PBSmartPotentiometer< NumBanks >:
Collaboration diagram for PBSmartPotentiometer< NumBanks >:

## 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
State of the smart potentiometer. More...

## Public Member Functions

PBSmartPotentiometer (BankConfig< NumBanks > config, pin_t analogPin, MIDIChannelCable address)
Create a new Bankable PBSmartPotentiometer object with the given analog pin and channel. More...

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

PitchBendSender< 10 > sender

## Protected Attributes

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

AH::Array< analog_t, NumBanks > previousValues

State state

setting_t previousBank

Node * next = nullptr

Node * previous = nullptr

## Static Protected Attributes

constexpr static analog_t initial

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables

## ◆ State

 enum State
inherited

State of the smart potentiometer.

Definition at line 47 of file SmartMIDIFilteredAnalog.hpp.

## ◆ PBSmartPotentiometer()

 PBSmartPotentiometer ( BankConfig< NumBanks > config, pin_t analogPin, MIDIChannelCable address )
inline

Create a new Bankable PBSmartPotentiometer object with the given analog pin and channel.

Parameters
 config The bank configuration to use: the bank to add this element to, and whether to the channel or cable number. analogPin The analog input pin to read from. address The MIDI address containing the channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16].

Definition at line 52 of file PBSmartPotentiometer.hpp.

## ◆ begin()

 void begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 61 of file SmartMIDIFilteredAnalog.hpp.

## ◆ update()

 void update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 68 of file SmartMIDIFilteredAnalog.hpp.

## ◆ getState()

 State getState ( ) const
inlineinherited

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

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

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.
FilteredAnalog::map

Definition at line 119 of file SmartMIDIFilteredAnalog.hpp.

## ◆ invert()

 void invert ( )
inlineinherited

Invert the analog value.

Definition at line 122 of file SmartMIDIFilteredAnalog.hpp.

## ◆ getRawValue()

 analog_t getRawValue ( ) const
inlineinherited

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
inlineinherited

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
inlineinherited

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
inlineinherited

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.

begin()

Definition at line 186 of file Updatable.hpp.

## ◆ updateAll()

 static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

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

protectedinherited

Definition at line 151 of file SmartMIDIFilteredAnalog.hpp.

## ◆ filteredAnalog

 AH::FilteredAnalog filteredAnalog
protectedinherited

Definition at line 152 of file SmartMIDIFilteredAnalog.hpp.

## ◆ initial

 constexpr static analog_t initial
staticconstexprprotectedinherited

Definition at line 157 of file SmartMIDIFilteredAnalog.hpp.

## ◆ previousValues

 AH::Array previousValues
protectedinherited

Definition at line 158 of file SmartMIDIFilteredAnalog.hpp.

## ◆ state

 State state
protectedinherited

Definition at line 159 of file SmartMIDIFilteredAnalog.hpp.

## ◆ previousBank

 setting_t previousBank
protectedinherited

Definition at line 160 of file SmartMIDIFilteredAnalog.hpp.

## ◆ sender

 PitchBendSender< 10 > sender
inherited

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: