NoteButtonLatched.hpp

Go to the documentation of this file.

/* ✔ */
 
#pragma once
 
#include <MIDI_Outputs/Abstract/MIDIButtonLatched.hpp>
#include <MIDI_Senders/DigitalNoteSender.hpp>
 
BEGIN_CS_NAMESPACE
 
/**
 * @brief   A class of MIDIOutputElement%s that read the input of a **momentary
 *          push button or toggle switch**, and send out MIDI **Note** events.
 * 
 * It latches the input, so press once to enable, press again to disable
 * (toggle).
 * 
 * The switch is debounced in software.  
 * This version cannot be banked.  
 *
 * @ingroup MIDIOutputElements
 */
class NoteButtonLatched : public MIDIButtonLatched<DigitalNoteSender> {
  public:
    /**
     * @brief   Create a new NoteButtonLatched object on the given pin and with 
     *          address.
     * 
     * @param   pin
     *          The digital input pin to read from.  
     *          The internal pull-up resistor will be enabled.
     * @param   address
     *          The MIDI address containing the note number [0, 127], 
     *          channel [CHANNEL_1, CHANNEL_16], and optional cable number 
     *          [0, 15].
     * @param   velocity
     *          The velocity of the MIDI Note events.
     */
    NoteButtonLatched(pin_t pin, const MIDICNChannelAddress &address,
                      uint8_t velocity = 0x7F)
        : MIDIButtonLatched{
              pin,
              address,
              {velocity},
          } {}
 
    /// Set the velocity of the MIDI Note events.
    void setVelocity(uint8_t velocity) { this->sender.setVelocity(velocity); }
    /// Get the velocity of the MIDI Note events.
    uint8_t getVelocity() const { return this->sender.getVelocity(); }
};
 
END_CS_NAMESPACE