Control Surface  1.1.1
MIDI Control Surface library for Arduino
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Attributes | Static Private Attributes | List of all members
CCAbsoluteEncoder Class Reference

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

#include <MIDI_Outputs/CCAbsoluteEncoder.hpp>

Inheritance diagram for CCAbsoluteEncoder:
Collaboration diagram for CCAbsoluteEncoder:

Public Member Functions

 CCAbsoluteEncoder (const EncoderPinList &pins, const MIDICNChannelAddress &address, int16_t multiplier=1, uint8_t pulsesPerStep=4, const ContinuousCCSender &sender={})
 Construct a new CCAbsoluteEncoder object with the given pins, address, channel, speed factor, and number of pulses per step. More...
 
void begin () override
 Initialize this updatable. More...
 
void update () override
 Update this updatable. More...
 
analog_t getValue ()
 
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

Encoder encoder
 
const MIDICNChannelAddress address
 
const int16_t multiplier
 
const uint8_t pulsesPerStep
 
long previousPosition
 

Static Private Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

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.

Note
To use this class, include the PJRC Encoder library before the Control-Surface library.
Examples
AbsoluteRotaryEncoder.ino.

Definition at line 21 of file CCAbsoluteEncoder.hpp.

Constructor & Destructor Documentation

◆ CCAbsoluteEncoder()

CCAbsoluteEncoder ( const EncoderPinList pins,
const MIDICNChannelAddress address,
int16_t  multiplier = 1,
uint8_t  pulsesPerStep = 4,
const ContinuousCCSender sender = {} 
)
inline

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

Parameters
pinsA list of the two pins connected to the A and B outputs of the encoder.
The internal pull-up resistors will be enabled by the Encoder library.
addressThe MIDI address containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15].
multiplierA constant factor to increase the speed of the rotary encoder. The position will just be multiplied by this factor.
pulsesPerStepThe 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.
senderThe MIDI sender to use.

Definition at line 50 of file CCAbsoluteEncoder.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable<>.

Definition at line 31 of file MIDIAbsoluteEncoder.hpp.

◆ update()

void update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable<>.

Definition at line 32 of file MIDIAbsoluteEncoder.hpp.

◆ getValue()

analog_t getValue ( )
inlineinherited

Definition at line 40 of file MIDIAbsoluteEncoder.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

◆ encoder

Encoder encoder
privateinherited

Definition at line 53 of file MIDIAbsoluteEncoder.hpp.

◆ address

const MIDICNChannelAddress address
privateinherited

Definition at line 54 of file MIDIAbsoluteEncoder.hpp.

◆ multiplier

const int16_t multiplier
privateinherited

Definition at line 55 of file MIDIAbsoluteEncoder.hpp.

◆ pulsesPerStep

const uint8_t pulsesPerStep
privateinherited

Definition at line 56 of file MIDIAbsoluteEncoder.hpp.

◆ previousPosition

long previousPosition
privateinherited

Definition at line 57 of file MIDIAbsoluteEncoder.hpp.

◆ sender

ContinuousCCSender sender
inherited

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