Line data    Source code

       1             : #pragma once
       2             : 
       3             : #include <MIDI_Outputs/Abstract/MIDIButtonMatrix.hpp>
       4             : #include <MIDI_Senders/DigitalCCSender.hpp>
       5             : 
       6             : BEGIN_CS_NAMESPACE
       7             : 
       8             : /**
       9             :  * @brief   A class of MIDIOutputElement%s that read the input from a **matrix
      10             :  *          of momentary push buttons or switches**, and send out MIDI **Control
      11             :  *          Change** events.
      12             :  * 
      13             :  * A value of 0x7F is sent when a button is pressed, and a value of 0x00 is sent
      14             :  * when a button is released.  
      15             :  * Crude software debouncing is implemented by limiting the refresh rate.  
      16             :  * This version cannot be banked.
      17             :  *
      18             :  * @tparam  NumRows
      19             :  *          The number of rows of the matrix.
      20             :  * @tparam  NumCols
      21             :  *          The number of columns of the matrix.
      22             :  *
      23             :  * @ingroup MIDIOutputElements
      24             :  */
      25             : template <uint8_t NumRows, uint8_t NumCols>
      26             : class CCButtonMatrix
      27             :     : public MIDIButtonMatrix<DigitalCCSender, NumRows, NumCols> {
      28             :   public:
      29             :     /**
      30             :      * @brief   Create a new CCButtonMatrix object with the given pins,
      31             :      *          controller numbers and channel.
      32             :      *
      33             :      * @param   rowPins
      34             :      *          A list of pin numbers connected to the rows of the button
      35             :      *          matrix.  
      36             :      *          **⚠** These pins will be driven LOW as outputs (Lo-Z).
      37             :      * @param   colPins
      38             :      *          A list of pin numbers connected to the columns of the button
      39             :      *          matrix.  
      40             :      *          These pins will be used as inputs (Hi-Z), and the
      41             :      *          internal pull-up resistor will be enabled.
      42             :      * @param   controllers
      43             :      *          A 2-dimensional array of the same dimensions as the button
      44             :      *          matrix that contains the MIDI Controller number of each button.
      45             :      *          [0, 119]
      46             :      * @param   channelCN
      47             :      *          The MIDI channel [Channel_1, Channel_16] and Cable Number 
      48             :      *          [Cable_1, Cable_16].
      49             :      * @param   sender
      50             :      *          The MIDI sender to use.
      51             :      */
      52           1 :     CCButtonMatrix(const PinList<NumRows> &rowPins,
      53             :                    const PinList<NumCols> &colPins,
      54             :                    const AddressMatrix<NumRows, NumCols> &controllers,
      55             :                    MIDIChannelCable channelCN,
      56             :                    const DigitalCCSender &sender = {})
      57             :         : MIDIButtonMatrix<DigitalCCSender, NumRows, NumCols>(
      58           1 :               rowPins, colPins, controllers, channelCN, sender) {}
      59             : };
      60             : 
      61             : END_CS_NAMESPACE