#include <MIDI_Outputs/Bankable/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 can be banked.

Definition at line 25 of file Bankable/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.

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 Member Functions
	PBPotentiometer (OutputBankConfig< BankType::ChangeChannel > config, pin_t analogPin, MIDIChannelCable address)
	Create a new Bankable PBPotentiometer object with the given analog pin and channel.

void	begin () final override
	Initialize this updatable.

void	update () final override
	Update this updatable.

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

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

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

Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Member Typedef Documentation

◆ FilteredAnalog

using FilteredAnalog

protectedinherited

Definition at line 90 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

Constructor & Destructor Documentation

◆ PBPotentiometer()

PBPotentiometer	(	OutputBankConfig< BankType::ChangeChannel >	config,
		pin_t	analogPin,
		MIDIChannelCable	address )

inline

Create a new Bankable PBPotentiometer 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 change the address, channel or cable number.
analogPin	The analog input pin to read from.
address	The MIDI channel [Channel_1, Channel_16] and optional Cable Number [Cable_1, Cable_16].

Definition at line 41 of file Bankable/PBPotentiometer.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 39 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ update()

void update ( )

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

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

See also: FilteredAnalog::map

Definition at line 64 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ invert()

void invert ( )

inlineinherited

Invert the analog value.

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

◆ getMaxRawValue()

static constexpr analog_t getMaxRawValue ( )

inlinestaticconstexprinherited

Get the maximum value that can be returned from getRawValue.

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

◆ beginAll()

template<class T = NormalUpdatable>

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 182 of file Updatable.hpp.

◆ updateAll()

template<class T = NormalUpdatable>

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 186 of file Updatable.hpp.

◆ enable() [1/4]

template<class Derived >

void enable ( )

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.

◆ enable() [2/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > * element )

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.

◆ enable() [3/4]

template<class Derived >

static void enable ( UpdatableCRTP< Derived > & element )

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.

◆ enable() [4/4]

template<class Derived >

template<class U , size_t N>

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 130 of file Updatable.hpp.

◆ disable() [1/4]

template<class Derived >

void disable ( )

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.

◆ disable() [2/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > * element )

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.

◆ disable() [3/4]

template<class Derived >

static void disable ( UpdatableCRTP< Derived > & element )

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.

◆ disable() [4/4]

template<class Derived >

template<class U , size_t N>

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 141 of file Updatable.hpp.

◆ isEnabled()

template<class Derived >

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 120 of file Updatable.hpp.

◆ moveDown()

template<class Derived >

void moveDown ( )

inlineinherited

Move down this element in the list.

Definition at line 147 of file Updatable.hpp.

Member Data Documentation

◆ address

SingleAddress address

protectedinherited

Definition at line 89 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ filteredAnalog

FilteredAnalog filteredAnalog

protectedinherited

Definition at line 91 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ sender

PitchBendSender< 10 > sender

inherited

Definition at line 94 of file Bankable/Abstract/MIDIFilteredAnalog.hpp.

◆ updatables

template<class Derived >

DoublyLinkedList< Derived > updatables

staticprotectedinherited

Definition at line 152 of file Updatable.hpp.

◆ next

Derived * next

protectedinherited

Definition at line 320 of file LinkedList.hpp.

◆ previous

Derived * previous

protectedinherited

Definition at line 321 of file LinkedList.hpp.

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

Bankable/PBPotentiometer.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Attributes

Static Protected Attributes

Member Typedef Documentation

◆ FilteredAnalog

Constructor & Destructor Documentation

◆ PBPotentiometer()

Member Function Documentation

◆ begin()

◆ update()

◆ forcedUpdate()

◆ map()

◆ invert()

◆ getRawValue()

◆ getMaxRawValue()

◆ getValue()

◆ beginAll()

◆ updateAll()

◆ enable() [1/4]

◆ enable() [2/4]

◆ enable() [3/4]

◆ enable() [4/4]

◆ disable() [1/4]

◆ disable() [2/4]

◆ disable() [3/4]

◆ disable() [4/4]

◆ isEnabled()

◆ moveDown()

Member Data Documentation

◆ address

◆ filteredAnalog

◆ sender

◆ updatables

◆ next

◆ previous