Control Surface master
MIDI Control Surface library for Arduino
Public Member Functions | Public Attributes | Protected Attributes | Static Protected Attributes | List of all members
CCButtons< NumButtons > Class Template Reference

#include <MIDI_Outputs/Bankable/CCButtons.hpp>

Detailed Description

template<uint8_t NumButtons>
class Bankable::CCButtons< NumButtons >

A class of MIDIOutputElements that read the input of a collection of momentary push buttons or switches, and send out MIDI Control Change events.

A value of 0x7F is sent when a button is pressed, and a value of 0x00 is sent when a button is released.
The buttons are debounced in software.
This version can be banked.

Template Parameters
NumButtonsThe number of buttons in the collection.

Definition at line 27 of file Bankable/CCButtons.hpp.

+ Inheritance diagram for CCButtons< NumButtons >:
+ Collaboration diagram for CCButtons< NumButtons >:

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

 CCButtons (OutputBankConfig<> config, const Array< AH::Button, NumButtons > &buttons, MIDIAddress baseAddress, RelativeMIDIAddress incrementAddress, const DigitalCCSender &sender={})
 Create a new Bankable CCButtons object with the given pins, the given controller number and channel. More...
 
void begin () final override
 Initialize this updatable. More...
 
void update () final override
 Update this updatable. More...
 
void invert ()
 
AH::Button::State getButtonState (size_t index) const
 

Public Attributes

DigitalCCSender sender
 

Protected Attributes

SingleAddress address
 
Array< AH::Button, NumButtons > buttons
 
RelativeMIDIAddress incrementAddress
 
uint8_t activeButtons
 
Node * next = nullptr
 
Node * previous = nullptr
 

Static Protected Attributes

static DoublyLinkedList< Updatable< NormalUpdatable > > updatables
 

Constructor & Destructor Documentation

◆ CCButtons()

CCButtons ( OutputBankConfig<>  config,
const Array< AH::Button, NumButtons > &  buttons,
MIDIAddress  baseAddress,
RelativeMIDIAddress  incrementAddress,
const DigitalCCSender sender = {} 
)
inline

Create a new Bankable CCButtons object with the given pins, the given controller number and channel.

Parameters
configThe bank configuration to use: the bank to add this element to, and whether to change the address, channel or cable number.
buttonsA list of digital input pins with the buttons connected.
The internal pull-up resistors will be enabled.
baseAddressThe MIDI address of the first button, containing the controller number [0, 119], channel [CHANNEL_1, CHANNEL_16], and optional cable number [CABLE_1, CABLE_16].
incrementAddressThe number of addresses to increment for each next button.
E.g. if baseAddress is 8, and incrementAddress is 2, then the first button will send on address 8, the second button will send on address 10, button three on address 12, etc.
senderThe MIDI sender to use.

Definition at line 52 of file Bankable/CCButtons.hpp.

Member Function Documentation

◆ begin()

void begin ( )
inlinefinaloverridevirtualinherited

Initialize this updatable.

Implements Updatable< T >.

Definition at line 37 of file Bankable/Abstract/MIDIButtons.hpp.

◆ update()

void update ( )
inlinefinaloverridevirtualinherited

Update this updatable.

Implements Updatable< T >.

Definition at line 41 of file Bankable/Abstract/MIDIButtons.hpp.

◆ invert()

void invert ( )
inlineinherited
See also
AH::Button::invert()

Definition at line 63 of file Bankable/Abstract/MIDIButtons.hpp.

◆ getButtonState()

AH::Button::State getButtonState ( size_t  index) const
inlineinherited

Definition at line 68 of file Bankable/Abstract/MIDIButtons.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

◆ address

SingleAddress address
protectedinherited

Definition at line 73 of file Bankable/Abstract/MIDIButtons.hpp.

◆ buttons

Array<AH::Button, NumButtons> buttons
protectedinherited

Definition at line 74 of file Bankable/Abstract/MIDIButtons.hpp.

◆ incrementAddress

RelativeMIDIAddress incrementAddress
protectedinherited

Definition at line 75 of file Bankable/Abstract/MIDIButtons.hpp.

◆ activeButtons

uint8_t activeButtons
protectedinherited

Definition at line 76 of file Bankable/Abstract/MIDIButtons.hpp.

◆ sender

DigitalCCSender sender
inherited

Definition at line 79 of file Bankable/Abstract/MIDIButtons.hpp.

◆ updatables

DoublyLinkedList< Updatable< NormalUpdatable > > updatables
staticprotectedinherited

Definition at line 156 of file Updatable.hpp.

◆ next

Node* next = nullptr
protectedinherited

Definition at line 324 of file LinkedList.hpp.

◆ previous

Node* previous = nullptr
protectedinherited

Definition at line 325 of file LinkedList.hpp.


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