A class of MIDIOutputElements that read the input of a quadrature (rotary) encoder and send out relative MIDI Control Change events.
More...
#include <MIDI_Outputs/CCRotaryEncoder.hpp>
|
| | CCRotaryEncoder (const EncoderPinList &pins, const MIDICNChannelAddress &address, int8_t speedMultiply=1, uint8_t pulsesPerStep=4, const RelativeCCSender &sender={}) |
| | Construct a new CCRotaryEncoder object with the given pins, address, channel, speed factor, and number of pulses per step. More...
|
| |
| void | begin () final override |
| | Initialize this updatable. More...
|
| |
| void | update () final override |
| | Update this updatable. 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...
|
| |
A class of MIDIOutputElements that read the input of a quadrature (rotary) encoder and send out relative 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
- MIDI-Controller-Finished-Example.ino, and RotaryEncoder.ino.
Definition at line 21 of file CCRotaryEncoder.hpp.
◆ CCRotaryEncoder()
Construct a new CCRotaryEncoder object with the given pins, address, channel, speed factor, and number of pulses per step.
- Parameters
-
| pins | A 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. |
| address | The MIDI address containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [0, 15]. |
| speedMultiply | A constant factor to increase the speed of the rotary encoder. The difference in 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. |
| sender | The MIDI sender to use. |
Definition at line 51 of file CCRotaryEncoder.hpp.
◆ begin()
|
|
inlinefinaloverridevirtualinherited |
◆ update()
|
|
inlinefinaloverridevirtualinherited |
◆ enable() [1/4]
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]
◆ enable() [3/4]
◆ enable() [4/4]
| static void enable |
( |
U(&) |
array[N] | ) |
|
|
inlinestaticinherited |
◆ disable() [1/4]
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]
◆ disable() [3/4]
◆ disable() [4/4]
| static void disable |
( |
U(&) |
array[N] | ) |
|
|
inlinestaticinherited |
◆ isEnabled()
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()
◆ updateAll()
| static void updateAll |
( |
| ) |
|
|
inlinestaticinherited |
◆ encoder
◆ address
◆ speedMultiply
| const int8_t speedMultiply |
|
privateinherited |
◆ pulsesPerStep
| const uint8_t pulsesPerStep |
|
privateinherited |
◆ previousPosition
◆ sender
◆ updatables
◆ next
◆ previous
The documentation for this class was generated from the following file:
