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

#include <MIDI_Outputs/PBAbsoluteEncoder.hpp>

Detailed Description

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

This version cannot be banked.

Definition at line 19 of file PBAbsoluteEncoder.hpp.

+ Inheritance diagram for PBAbsoluteEncoder:
+ Collaboration diagram for PBAbsoluteEncoder:

Enabling and disabling updatables

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

Public Member Functions

 PBAbsoluteEncoder (AHEncoder &&encoder, MIDIChannelCable address, int16_t multiplier=1, uint8_t pulsesPerStep=4)
 Construct a new PBAbsoluteEncoder 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...
 
void forcedUpdate ()
 Send the current value over MIDI, even if the position of the encoder didn't change. More...
 
uint16_t getValue () const
 Get the absolute value of the encoder. More...
 
void setValue (uint16_t value)
 Set the absolute value of the encoder. More...
 
void setSpeedMultiply (int16_t speedMultiply)
 
int16_t getSpeedMultiply () const
 
MIDIAddress getAddress () const
 Get the MIDI address. More...
 
void setAddress (MIDIAddress address)
 Set the MIDI address. More...
 

Static Public Member Functions

static int16_t getMaxValue ()
 Get the maximum possible value that can be returned by getValue. More...
 

Public Attributes

Sender sender
 

Protected Attributes

Updatable< NormalUpdatable > * next
 
Updatable< NormalUpdatable > * previous
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > 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

◆ PBAbsoluteEncoder()

PBAbsoluteEncoder ( AHEncoder &&  encoder,
MIDIChannelCable  address,
int16_t  multiplier = 1,
uint8_t  pulsesPerStep = 4 
)
inline

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

Parameters
encoderThe 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.
addressThe MIDI channel [CHANNEL_1, CHANNEL_16] and optional Cable Number [CABLE_1, CABLE_16].
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.

Definition at line 46 of file PBAbsoluteEncoder.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlineoverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

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

◆ update()

void update ( )
inlineoverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

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

◆ forcedUpdate()

void forcedUpdate ( )
inlineinherited

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

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

◆ getValue()

uint16_t getValue ( ) const
inlineinherited

Get the absolute value of the encoder.

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

◆ setValue()

void setValue ( uint16_t  value)
inlineinherited

Set the absolute value of the encoder.

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

◆ getMaxValue()

static int16_t getMaxValue ( )
inlinestaticinherited

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

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

◆ setSpeedMultiply()

void setSpeedMultiply ( int16_t  speedMultiply)
inlineinherited

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

◆ getSpeedMultiply()

int16_t getSpeedMultiply ( ) const
inlineinherited

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

◆ getAddress()

MIDIAddress getAddress ( ) const
inlineinherited

Get the MIDI address.

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

◆ setAddress()

void setAddress ( MIDIAddress  address)
inlineinherited

Set the MIDI address.

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

◆ beginAll()

static void beginAll ( )
inlinestaticinherited

Begin all enabled instances of this class.

See also
begin()

Definition at line 186 of file Updatable.hpp.

◆ updateAll()

static void updateAll ( )
inlinestaticinherited

Update all enabled instances of this class.

See also
update()

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

◆ enable() [2/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > *  element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 129 of file Updatable.hpp.

◆ enable() [3/4]

static void enable ( UpdatableCRTP< Updatable< NormalUpdatable > > &  element)
inlinestaticinherited

Enable this updatable: insert it into the linked list of instances, so it gets updated automatically.

Definition at line 131 of file Updatable.hpp.

◆ enable() [4/4]

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

◆ disable() [2/4]

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

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 140 of file Updatable.hpp.

◆ disable() [3/4]

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

Disable this updatable: remove it from the linked list of instances, so it no longer gets updated automatically.

Definition at line 142 of file Updatable.hpp.

◆ disable() [4/4]

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

◆ isEnabled()

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

◆ moveDown()

void moveDown ( )
inlineinherited

Move down this element in the list.

Definition at line 151 of file Updatable.hpp.

Member Data Documentation

◆ encoder

Enc encoder
privateinherited

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

◆ address

MIDIAddress address
privateinherited

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

◆ value

int16_t value = 0
privateinherited

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

◆ encstate

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

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

◆ maxValue

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

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

◆ sender

Sender sender
inherited

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

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Updatable< NormalUpdatable > * next
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Updatable< NormalUpdatable > * previous
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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