Control Surface main
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | Private Attributes | List of all members
PBPotentiometer Class Reference

#include <MIDI_Outputs/PBPotentiometer.hpp>

Detailed Description

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 cannot be banked.

Examples
Pitch-Bend-Potentiometer.ino.

Definition at line 25 of file PBPotentiometer.hpp.

+ Inheritance diagram for PBPotentiometer:
+ Collaboration diagram for PBPotentiometer:

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 Member Functions

 PBPotentiometer (pin_t analogPin, MIDIChannelCable address=CHANNEL_1)
 Create a new PBPotentiometer object with the given analog pin and channel. More...
 
void begin () final override
 Initialize this updatable. More...
 
void update () final override
 Update this updatable. More...
 
void forcedUpdate ()
 Send the value of the analog input over MIDI, even if the value didn't change. 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...
 
MIDIAddress getAddress () const
 Get the MIDI address. More...
 
void setAddress (MIDIAddress address)
 Set the MIDI address. More...
 

Public Attributes

PitchBendSender< 10 > sender
 

Protected Attributes

Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Private Attributes

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

Constructor & Destructor Documentation

◆ PBPotentiometer()

PBPotentiometer ( pin_t  analogPin,
MIDIChannelCable  address = CHANNEL_1 
)
inline

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

Parameters
analogPinThe analog input pin to read from.
addressThe MIDI channel [CHANNEL_1, CHANNEL_16] and optional Cable Number [CABLE_1, CABLE_16].

Definition at line 37 of file PBPotentiometer.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 35 of file Abstract/MIDIFilteredAnalog.hpp.

◆ update()

void update ( )
inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 37 of file Abstract/MIDIFilteredAnalog.hpp.

◆ forcedUpdate()

void forcedUpdate ( )
inlineinherited

Send the value of the analog input over MIDI, even if the value didn't change.

Definition at line 44 of file Abstract/MIDIFilteredAnalog.hpp.

◆ map()

void map ( MappingFunction  fn)
inlineinherited

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 58 of file Abstract/MIDIFilteredAnalog.hpp.

◆ invert()

void invert ( )
inlineinherited

Invert the analog value.

Definition at line 61 of file Abstract/MIDIFilteredAnalog.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 67 of file Abstract/MIDIFilteredAnalog.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 73 of file Abstract/MIDIFilteredAnalog.hpp.

◆ getAddress()

MIDIAddress getAddress ( ) const
inlineinherited

Get the MIDI address.

Definition at line 76 of file Abstract/MIDIFilteredAnalog.hpp.

◆ setAddress()

void setAddress ( MIDIAddress  address)
inlineinherited

Set the MIDI address.

Definition at line 78 of file Abstract/MIDIFilteredAnalog.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

◆ filteredAnalog

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

Definition at line 81 of file Abstract/MIDIFilteredAnalog.hpp.

◆ address

MIDIAddress address
privateinherited

Definition at line 82 of file Abstract/MIDIFilteredAnalog.hpp.

◆ sender

PitchBendSender< 10 > sender
inherited

Definition at line 85 of file Abstract/MIDIFilteredAnalog.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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