#include <MIDI_Outputs/Bankable/PBSmartPotentiometer.hpp>
A class of MIDIOutputElements that read the analog input from a potentiometer or fader, and send out 14-bit MIDI Pitch Bend events.
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.
NumBanks | The number of banks. |
Definition at line 33 of file PBSmartPotentiometer.hpp.
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 |
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. | |
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 | |
PitchBendSender< 10 > | sender |
Protected Types | |
using | FilteredAnalog |
Protected Attributes | |
SingleAddress | address |
FilteredAnalog | filteredAnalog |
AH::Array< analog_t, NumBanks > | previousValues |
State | state |
setting_t | previousBank |
Derived * | next |
Derived * | previous |
Static Protected Attributes | |
static constexpr analog_t | initial |
static DoublyLinkedList< Derived > | updatables |
|
protectedinherited |
Definition at line 157 of file SmartMIDIFilteredAnalog.hpp.
State of the smart potentiometer.
Definition at line 45 of file SmartMIDIFilteredAnalog.hpp.
|
inline |
Create a new Bankable PBSmartPotentiometer object with the given analog pin and channel.
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 50 of file PBSmartPotentiometer.hpp.
|
inlineoverridevirtualinherited |
Initialize this updatable.
Implements Updatable< T >.
Definition at line 59 of file SmartMIDIFilteredAnalog.hpp.
|
inlineoverridevirtualinherited |
Update this updatable.
Implements Updatable< T >.
Definition at line 66 of file SmartMIDIFilteredAnalog.hpp.
|
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 97 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Activate the potentiometer in the current bank, regardless of its current and previous position.
Definition at line 103 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Specify a mapping function that is applied to the raw analog value before sending.
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. |
Definition at line 117 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Invert the analog value.
Definition at line 120 of file SmartMIDIFilteredAnalog.hpp.
|
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 126 of file SmartMIDIFilteredAnalog.hpp.
Get the maximum value that can be returned from getRawValue.
Definition at line 131 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
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.
|
inlineinherited |
Get the previous value of the analog input of the given bank.
Definition at line 144 of file SmartMIDIFilteredAnalog.hpp.
|
inlineinherited |
Get the previous value of the analog input of the active bank.
Definition at line 151 of file SmartMIDIFilteredAnalog.hpp.
|
inlinestaticinherited |
Begin all enabled instances of this class.
Definition at line 182 of file Updatable.hpp.
|
inlinestaticinherited |
Update all enabled instances of this class.
Definition at line 186 of file Updatable.hpp.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
inlineinherited |
Check if this updatable is enabled.
Definition at line 120 of file Updatable.hpp.
|
inlineinherited |
Move down this element in the list.
Definition at line 147 of file Updatable.hpp.
|
protectedinherited |
Definition at line 156 of file SmartMIDIFilteredAnalog.hpp.
|
protectedinherited |
Definition at line 158 of file SmartMIDIFilteredAnalog.hpp.
|
staticconstexprprotectedinherited |
Definition at line 163 of file SmartMIDIFilteredAnalog.hpp.
|
protectedinherited |
Definition at line 164 of file SmartMIDIFilteredAnalog.hpp.
|
protectedinherited |
Definition at line 165 of file SmartMIDIFilteredAnalog.hpp.
|
protectedinherited |
Definition at line 166 of file SmartMIDIFilteredAnalog.hpp.
|
inherited |
Definition at line 169 of file SmartMIDIFilteredAnalog.hpp.
|
staticprotectedinherited |
Definition at line 152 of file Updatable.hpp.
|
protectedinherited |
Definition at line 320 of file LinkedList.hpp.
|
protectedinherited |
Definition at line 321 of file LinkedList.hpp.