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

#include <MIDI_Outputs/Bankable/CCPotentiometer.hpp>

Inheritance diagram for CCPotentiometer:

Collaboration diagram for CCPotentiometer:

Public Member Functions
	CCPotentiometer (const OutputBankConfig &config, pin_t analogPin, const MIDICNChannelAddress &address, const ContinuousCCSender &sender={})
	Create a new Bankable CCPotentiometer object with the given analog pin, controller number and channel. More...

void	begin () override
	Initialize this updatable. More...

void	update () 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
ContinuousCCSender	sender

Protected Attributes
Updatable< NormalUpdatable > *	next

Updatable< NormalUpdatable > *	previous

Private Attributes
SingleAddress	address

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

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 7-bit MIDI Control Change events.

The analog input is filtered and hysteresis is applied for maximum stability.
This version can be banked.

Examples: Encoder-Selector-Bank.ino, MIDI-Controller-Finished-Example.ino, and MIDI_controller-97.ino.

Definition at line 22 of file Bankable/CCPotentiometer.hpp.

Constructor & Destructor Documentation

◆ CCPotentiometer()

CCPotentiometer	(	const OutputBankConfig &	config,
		pin_t	analogPin,
		const MIDICNChannelAddress &	address,
		const ContinuousCCSender &	sender = `{}`
	)

inline

Create a new Bankable CCPotentiometer object with the given analog pin, controller number 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 address containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15].
sender	The MIDI sender to use.

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

Member Function Documentation

◆ begin()

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

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

◆ invert()

void invert ( )

inlineinherited

Invert the analog value.

Definition at line 60 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 66 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 72 of file Bankable/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

◆ address

SingleAddress address

privateinherited

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

◆ filteredAnalog

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

privateinherited

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

◆ sender

ContinuousCCSender sender

inherited

Definition at line 79 of file Bankable/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:

Bankable/CCPotentiometer.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CCPotentiometer()

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

◆ address

◆ filteredAnalog

◆ sender

◆ updatables

◆ next

◆ previous