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/CCPotentiometer.hpp>

Inheritance diagram for CCPotentiometer:

Collaboration diagram for CCPotentiometer:

Public Types
using	Mutex = typename std::conditional< ThreadSafe, DefaultMutEx, EmptyMutex >::type

using	LockGuard = typename std::conditional< ThreadSafe, DefaultLockGuard< Mutex >, EmptyLockGuard< Mutex > >::type

Public Member Functions
	CCPotentiometer (pin_t analogPin, const MIDIAddress &address)
	Create a new 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...

Static Public Member Functions
static Mutex &	getMutex ()

Public Attributes
ContinuousCCSender	sender

Protected Attributes
Updatable< NormalUpdatable, false > *	next

Updatable< NormalUpdatable, false > *	previous

Static Protected Attributes
static DoublyLinkedList< Updatable< NormalUpdatable, false > >	updatables

static Mutex	mutex

Private Attributes
AH::FilteredAnalog< Sender::precision()>	filteredAnalog

const MIDIAddress	address

Main initialization and updating methods
static void	applyToAll (const LockGuard &, void(Derived::*method)(Args &&...), Args &&... args)

static void	applyToAll (void(Derived::*method)(Args &&...), Args &&... args)

Enabling and disabling updatables
void	enable (const LockGuard &lock)
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	enable ()
	Enable this updatable: insert it into the linked list of instances, so it gets updated automatically. More...

void	disable (const LockGuard &lock)
	Disable this updatable: remove it from the linked list of instances, so it no longer 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 LockGuard &) const
	Check if this updatable is enabled. More...

bool	isEnabled ()
	Check if this updatable is enabled. More...

void	moveDown (const LockGuard &)
	Move down this element in the list. 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...

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

Examples: 1.First-Output.ino, CCPotentiometer-Map.ino, Control-Change-Potentiometer.ino, Dual-MIDI-Interface.ino, MIDI-Controller-Finished-Example.ino, and Multiple-Control-Change-Potentiometers.ino.

Definition at line 19 of file CCPotentiometer.hpp.

Member Typedef Documentation

◆ Mutex

using Mutex = typename std::conditional<ThreadSafe, DefaultMutEx, EmptyMutex>::type

inherited

Definition at line 36 of file Updatable.hpp.

◆ LockGuard

using LockGuard = typename std::conditional<ThreadSafe, DefaultLockGuard<Mutex>, EmptyLockGuard<Mutex> >::type

inherited

Definition at line 38 of file Updatable.hpp.

Constructor & Destructor Documentation

◆ CCPotentiometer()

CCPotentiometer	(	pin_t	analogPin,
		const MIDIAddress &	address
	)

inline

Create a new CCPotentiometer object with the given analog pin, controller number and channel.

Parameters

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 [CABLE_1, CABLE_16].

Definition at line 33 of file CCPotentiometer.hpp.

Member Function Documentation

◆ begin()

void begin

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

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

◆ update()

void update

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

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

Examples: CCPotentiometer-Map.ino.

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

◆ invert()

void invert

inlineinherited

Invert the analog value.

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

◆ getRawValue()

analog_t getRawValue

inlineinherited

Get the raw value of the analog input (this is the value without applying the filter or the mapping function first).

Examples: CCPotentiometer-Map.ino.

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

◆ getValue()

analog_t getValue

inlineinherited

Get the value of the analog input (this is the value after first applying the mapping function).

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

◆ beginAll()

static void beginAll ( )

inlinestaticinherited

Begin all enabled instances of this class.

See also: begin()

Definition at line 208 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )

inlinestaticinherited

Update all enabled instances of this class.

See also: update()

Definition at line 212 of file Updatable.hpp.

◆ getMutex()

static Mutex& getMutex ( )

inlinestaticinherited

Definition at line 79 of file Updatable.hpp.

◆ applyToAll() [1/2]

static void applyToAll	(	const LockGuard &	,
		void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 85 of file Updatable.hpp.

◆ applyToAll() [2/2]

static void applyToAll	(	void(Derived::*)(Args &&...)	method,
		Args &&...	args
	)

inlinestaticinherited

Definition at line 93 of file Updatable.hpp.