Line data    Source code

       1             : #pragma once
       2             : 
       3             : #include <MIDI_Outputs/Abstract/MIDIButton.hpp>
       4             : #include <MIDI_Senders/DigitalNoteSender.hpp>
       5             : 
       6             : BEGIN_CS_NAMESPACE
       7             : 
       8             : /**
       9             :  * @brief   A class of MIDIOutputElement%s that read the input of a **momentary
      10             :  *          push button or switch**, and send out MIDI **Note** events.
      11             :  * 
      12             :  * A Note On event is sent when the button is pressed, and a Note Off
      13             :  * event is sent when the button is released.  
      14             :  * The button is debounced in software.  
      15             :  * This version cannot be banked.  
      16             :  *
      17             :  * @ingroup MIDIOutputElements
      18             :  */
      19             : class NoteButton : public MIDIButton<DigitalNoteSender> {
      20             :   public:
      21             :     /**
      22             :      * @brief   Create a new NoteButton object with the given pin, note number
      23             :      *          and channel.
      24             :      * 
      25             :      * @param   pin
      26             :      *          The digital input pin to read from.  
      27             :      *          The internal pull-up resistor will be enabled.
      28             :      * @param   address
      29             :      *          The MIDI address containing the note number [0, 127], 
      30             :      *          channel [Channel_1, Channel_16], and optional cable number 
      31             :      *          [Cable_1, Cable_16].
      32             :      * @param   velocity
      33             :      *          The velocity of the MIDI Note events.
      34             :      */
      35           2 :     NoteButton(pin_t pin, MIDIAddress address, uint8_t velocity = 0x7F)
      36           2 :         : MIDIButton {
      37             :               pin,
      38             :               address,
      39             :               {velocity},
      40           2 :           } {}
      41             : 
      42             :     /// Set the velocity of the MIDI Note events.
      43             :     void setVelocity(uint8_t velocity) { this->sender.setVelocity(velocity); }
      44             :     /// Get the velocity of the MIDI Note events.
      45             :     uint8_t getVelocity() const { return this->sender.getVelocity(); }
      46             : };
      47             : 
      48             : END_CS_NAMESPACE