Scan/BudKeypad/matrix.h

   1 /* Copyright (C) 2011,2015 by Jacob Alexander
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to deal
   5  * in the Software without restriction, including without limitation the rights
   6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   7  * copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19  * THE SOFTWARE.
  20  */
  21
  22 #pragma once
  23
  24 // ----- Includes -----
  25
  26 // Compiler Includes
  27 #include <stdint.h>
  28
  29
  30
  31 // ----- Scan Mode Setting (See matrix_scan.h for more details) -----
  32 #define scanMode scanCol
  33
  34
  35
  36 // ----- Key Settings -----
  37
  38 #define KEYBOARD_KEYS 16 // # of keys
  39 #define MAX_ROW_SIZE  16 // # of keys in the largest row
  40 #define MAX_COL_SIZE   1 // # of keys in the largest column
  41
  42
  43
  44 // ----- Matrix Configuration -----
  45 static const uint8_t matrix_pinout[][MAX_ROW_SIZE + 1] = {
  46
  47
  48
  49 // Just layout the matrix by rows and columns
  50 // Usually you'll want to set the scanMode above to scanDual or scanCol_powrRow/scanRow_powrCol
  51 // The mode allows for optimization in the kind of scanning algorithms that are done
  52 //
  53 // The key numbers are used to translate into the keymap table (array) (and always start from 1, not 0).
  54 // Thus if a row doesn't use all the key positions, you can denote it as 0, which will be ignored/skipped on each scan
  55 // See the keymap.h file for the various preconfigured arrays.
  56
  57 // Scan Mode | Col 1 | Col 2 | Col 3 | Col 4 | Col 5 | ...
  58 // -------------------------------------------------------
  59 //     Row 1 | Key 1   Key 7   Key32    ...
  60 //     Row 2 | Key 3   Key92    ...
  61 //     Row 3 | Key23    ...
  62 //     Row 4 |  ...
  63 //     Row 5 |
  64 //      ...  |
  65
  66 // See Scan/matrix/matrix_template.h for more details
  67
  68
  69   { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2, pinF6, pinF7, pinB2, pinD0, pinB0, pinB6, pinB1, pinB3 },
  70   { pinNULL,  1,     2,     3,     4,     5,     6,     7,     8,     9,     10,    11,    12,    13,    14,    15,    16    },
  71
  72
  73
  74 };
  75