A class of MIDIOutputElements that read the analog input from a potentiometer or fader, and send out 14-bit MIDI Pitch Bend events. More...

#include <MIDI_Outputs/PBPotentiometer.hpp>

Inheritance diagram for PBPotentiometer:

Collaboration diagram for PBPotentiometer:

Public Member Functions
	PBPotentiometer (pin_t analogPin, const MIDICNChannel &address=CHANNEL_1, const PitchBendSender< 10 > &sender={})
	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	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...

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 ()
	Check if this updatable is enabled. More...

Static Public Member Functions
static void	enable (Updatable *element)

static void	enable (Updatable &element)

static void	enable (U(&array)[N])

static void	disable (Updatable< NormalUpdatable > *element)

static void	disable (Updatable< NormalUpdatable > &element)

static void	disable (U(&array)[N])

static void	beginAll ()
	Begin all enabled instances of this class. More...

static void	updateAll ()
	Update all enabled instances of this class. More...

Public Attributes
PitchBendSender< 10 >	sender

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Private Attributes
AH::FilteredAnalog< PitchBendSender< 10 > ::precision()>	filteredAnalog

const MIDICNChannelAddress	address

Static Private Attributes
static DoublyLinkedList< Updatable< NormalUpdatable > >	updatables

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" 8 bits, because the built-in ADC is pretty noisy.
This version cannot be banked.

Examples: Pitch-Bend-Potentiometer.ino.

Definition at line 24 of file PBPotentiometer.hpp.

Constructor & Destructor Documentation

◆ PBPotentiometer()

PBPotentiometer	(	pin_t	analogPin,
		const MIDICNChannel &	address = `CHANNEL_1`,
		const PitchBendSender< 10 > &	sender = `{}`
	)

inline

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

Parameters

analogPin	The analog input pin to read from.
address	The MIDI channel [CHANNEL_1, CHANNEL_16] and optional Cable Number [0, 15].
sender	The MIDI sender to use.

Definition at line 38 of file PBPotentiometer.hpp.

Member Function Documentation

◆ begin()

void begin ( )

inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update ( )

inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 109 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

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

◆ invert()

void invert ( )

inlineinherited

Invert the analog value.

Definition at line 129 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 135 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 141 of file Abstract/MIDIFilteredAnalog.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 45 of file Updatable.hpp.

◆ enable() [2/4]

static void enable ( Updatable<> * element )

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( Updatable<> & element )

inlinestaticinherited

Definition at line 87 of file Updatable.hpp.

◆ enable() [4/4]

static void enable ( U(&) array[N] )

inlinestaticinherited

Definition at line 90 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 55 of file Updatable.hpp.

◆ disable() [2/4]

static void disable ( Updatable< NormalUpdatable<> > * element )

inlinestaticinherited

Definition at line 95 of file Updatable.hpp.

◆ disable() [3/4]

static void disable ( Updatable< NormalUpdatable<> > & element )

inlinestaticinherited

Definition at line 97 of file Updatable.hpp.

◆ disable() [4/4]

static void disable ( U(&) array[N] )

inlinestaticinherited

Definition at line 100 of file Updatable.hpp.

◆ isEnabled()

bool isEnabled ( )

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

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 73 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 80 of file Updatable.hpp.

Member Data Documentation

◆ filteredAnalog

AH::FilteredAnalog<PitchBendSender< 10 > ::precision()> filteredAnalog

privateinherited

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

◆ address

const MIDICNChannelAddress address

privateinherited

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

◆ sender

PitchBendSender< 10 > sender

inherited

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables

staticprivateinherited

Definition at line 106 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next

protectedinherited

Definition at line 305 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous

protectedinherited

Definition at line 306 of file LinkedList.hpp.

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

PBPotentiometer.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PBPotentiometer()

Member Function Documentation

◆ begin()

◆ update()

◆ map()

◆ invert()

◆ getRawValue()

◆ getValue()

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

◆ beginAll()

◆ updateAll()

Member Data Documentation

◆ filteredAnalog

◆ address

◆ sender

◆ updatables

◆ next

◆ previous