#include <MIDI_Outputs/CCAbsoluteEncoder.hpp>

Detailed Description

A class of MIDIOutputElements that read the input of a quadrature (rotary) encoder and send out absolute MIDI Control Change events.

This version cannot be banked.

Examples: AbsoluteRotaryEncoder.ino.

Definition at line 17 of file CCAbsoluteEncoder.hpp.

Inheritance diagram for CCAbsoluteEncoder:

Collaboration diagram for CCAbsoluteEncoder:

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
	CCAbsoluteEncoder (AHEncoder &&encoder, MIDIAddress address, int16_t multiplier=1, uint8_t pulsesPerStep=4)
	Construct a new CCAbsoluteEncoder object with the given pins, address, channel, speed factor, and number of pulses per step.

void	begin () override
	Initialize this updatable.

void	update () override
	Update this updatable.

void	forcedUpdate ()
	Send the current value over MIDI, even if the position of the encoder didn't change.

uint16_t	getValue () const
	Get the absolute value of the encoder.

void	setValue (uint16_t value)
	Set the absolute value of the encoder.

void	setSpeedMultiply (int16_t speedMultiply)

int16_t	getSpeedMultiply () const

MIDIAddress	getAddress () const
	Get the MIDI address.

void	setAddress (MIDIAddress address)
	Set the MIDI address.

int16_t	resetPositionOffset ()

Static Public Member Functions
static int16_t	getMaxValue ()
	Get the maximum possible value that can be returned by getValue.

Public Attributes
Sender	sender

Protected Attributes
Derived *	next

Derived *	previous

Static Protected Attributes
static DoublyLinkedList< Derived >	updatables

Private Attributes
Enc	encoder

MIDIAddress	address

int16_t	value = 0

EncoderState< decltype(encoder.read())>	encstate

Static Private Attributes
static constexpr int16_t	maxValue = uint16_t(1u << Sender::precision()) - 1

Constructor & Destructor Documentation

◆ CCAbsoluteEncoder()

CCAbsoluteEncoder	(	AHEncoder &&	encoder,
		MIDIAddress	address,
		int16_t	multiplier = 1,
		uint8_t	pulsesPerStep = 4 )

inline

Construct a new CCAbsoluteEncoder object with the given pins, address, channel, speed factor, and number of pulses per step.

Parameters

encoder	The Encoder object to use. Usually passed as a list of the two pins connected to the A and B outputs of the encoder, e.g. `{2, 3}`. The internal pull-up resistors will be enabled by the Encoder library.
address	The MIDI address containing the controller number [0, 119], channel [Channel_1, Channel_16], and optional cable number [Cable_1, Cable_16].
multiplier	A constant factor to increase the speed of the rotary encoder. The position will just be multiplied by this factor.
pulsesPerStep	The number of pulses per physical click of the encoder. For a normal encoder, this is 4. If you want to increase the resolution, for the use of Jog wheels, for example, you can go as 1. Whereas a greater speedMultiplier factor will increase the speed, increasing the number of pulsesPerStep will result in a lower speed.

Definition at line 45 of file CCAbsoluteEncoder.hpp.

Member Function Documentation

◆ begin()

template<class Enc , class Sender >

void begin ( )

inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 31 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ update()

template<class Enc , class Sender >

void update ( )

inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 33 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ forcedUpdate()

template<class Enc , class Sender >

void forcedUpdate ( )

inlineinherited

Send the current value over MIDI, even if the position of the encoder didn't change.

Definition at line 48 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ getValue()

template<class Enc , class Sender >

uint16_t getValue ( ) const

inlineinherited

Get the absolute value of the encoder.

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

◆ setValue()

template<class Enc , class Sender >

void setValue ( uint16_t value )

inlineinherited

Set the absolute value of the encoder.

Definition at line 58 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ getMaxValue()

template<class Enc , class Sender >

static int16_t getMaxValue ( )

inlinestaticinherited

Get the maximum possible value that can be returned by getValue.

Definition at line 61 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ setSpeedMultiply()

template<class Enc , class Sender >

void setSpeedMultiply ( int16_t speedMultiply )

inlineinherited

Definition at line 63 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ getSpeedMultiply()

template<class Enc , class Sender >

int16_t getSpeedMultiply ( ) const

inlineinherited

Definition at line 66 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ getAddress()

template<class Enc , class Sender >

MIDIAddress getAddress ( ) const

inlineinherited

Get the MIDI address.

Definition at line 69 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ setAddress()

template<class Enc , class Sender >

void setAddress ( MIDIAddress address )

inlineinherited

Set the MIDI address.

Definition at line 71 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ resetPositionOffset()

template<class Enc , class Sender >

int16_t resetPositionOffset ( )

inlineinherited

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

◆ encoder

template<class Enc , class Sender >

Enc encoder

privateinherited

Definition at line 79 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ address

template<class Enc , class Sender >

MIDIAddress address

privateinherited

Definition at line 80 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ value

template<class Enc , class Sender >

int16_t value = 0

privateinherited

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

◆ encstate

template<class Enc , class Sender >

EncoderState<decltype(encoder.read())> encstate

privateinherited

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

◆ maxValue

template<class Enc , class Sender >

constexpr int16_t maxValue = uint16_t(1u << Sender::precision()) - 1

staticconstexprprivateinherited

Definition at line 84 of file Abstract/MIDIAbsoluteEncoder.hpp.

◆ sender

template<class Enc , class Sender >

Sender sender

inherited

Definition at line 87 of file Abstract/MIDIAbsoluteEncoder.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:

CCAbsoluteEncoder.hpp

Detailed Description

Enabling and disabling updatables

Main initialization and updating methods

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

◆ CCAbsoluteEncoder()

Member Function Documentation

◆ begin()

◆ update()

◆ forcedUpdate()

◆ getValue()

◆ setValue()

◆ getMaxValue()

◆ setSpeedMultiply()

◆ getSpeedMultiply()

◆ getAddress()

◆ setAddress()

◆ resetPositionOffset()

◆ 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

◆ encoder

◆ address

◆ value

◆ encstate

◆ maxValue

◆ sender

◆ updatables

◆ next

◆ previous