Line data    Source code

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