Scan/matrix/matrix_template.h

   1 /* Copyright (C) 2011,2014-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 scanDual
  33
  34
  35
  36 // ----- Key Settings -----
  37
  38 // -- Example for scanCol --
  39 /*
  40 #define KEYBOARD_KEYS 16 // # of keys
  41 #define MAX_ROW_SIZE  16 // # of keys in the largest row
  42 #define MAX_COL_SIZE   1 // # of keys in the largest column
  43 */
  44
  45
  46 // -- Example for scanRow --
  47 /*
  48 #define KEYBOARD_KEYS 16 // # of keys
  49 #define MAX_ROW_SIZE   1 // # of keys in the largest row
  50 #define MAX_COL_SIZE  16 // # of keys in the largest column
  51 */
  52
  53
  54 // -- Example for scanRow_powrCol, scanCol_powrRow, and scanDual --
  55 /*
  56 #define KEYBOARD_KEYS 69 // # of keys
  57 #define MAX_ROW_SIZE   8 // # of keys in the largest row
  58 #define MAX_COL_SIZE   9 // # of keys in the largest column
  59 */
  60
  61
  62
  63 // ----- Matrix Configuration -----
  64 static const uint8_t matrix_pinout[][MAX_ROW_SIZE + 1] = {
  65
  66
  67
  68 // Just layout the matrix by rows and columns
  69 // Usually you'll want to set the scanMode above to scanDual or scanCol_powrRow/scanRow_powrCol
  70 // The mode allows for optimization in the kind of scanning algorithms that are done
  71 //
  72 // The key numbers are used to translate into the keymap table (array) (and always start from 1, not 0).
  73 // 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
  74 // See the keymap.h file for the various preconfigured arrays.
  75
  76 // Scan Mode | Col 1 | Col 2 | Col 3 | Col 4 | Col 5 | ...
  77 // -------------------------------------------------------
  78 //     Row 1 | Key 1   Key 7   Key32    ...
  79 //     Row 2 | Key 3   Key92    ...
  80 //     Row 3 | Key23    ...
  81 //     Row 4 |  ...
  82 //     Row 5 |
  83 //      ...  |
  84
  85
  86 // -- scanCol Example --
  87 /*
  88   { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2, pinF6, pinF7, pinB2, pinD0, pinB0, pinB6, pinB1, pinB3 },
  89   { pinNULL,  1,     2,     3,     4,     5,     6,     7,     8,     9,     10,    11,    12,    13,    14,    15,    16    },
  90 */
  91
  92
  93 // -- scanRow Example --
  94 /*
  95   { scanMode, pinNULL },
  96   { pinF0,    1       },
  97   { pinF4,    2       },
  98   { pinB7,    3       },
  99   { pinD3,    4       },
 100   { pinF5,    5       },
 101   { pinF1,    6       },
 102   { pinD1,    7       },
 103   { pinD2,    8       },
 104   { pinF6,    9       },
 105   { pinF7,    10      },
 106   { pinB2,    11      },
 107   { pinD0,    12      },
 108   { pinB0,    13      },
 109   { pinB6,    14      },
 110   { pinB1,    15      },
 111   { pinB3,    16      },
 112 */
 113
 114
 115 // -- scanRow_powrCol Example and scanCol_powrRow Example --
 116 // The example is the same, as the difference is whether the row or col is powered, and the other is used to detect the signal
 117 /*
 118   { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2 },
 119   { pinF6,    1,     2,     3,     4,     5,     6,     7,     8     },
 120   { pinF7,    9,     10,    11,    12,    13,    14,    15,    16    },
 121   { pinB2,    17,    20,    30,    40,    50,    60,    59,    38    },
 122   { pinD0,    18,    21,    31,    41,    51,    61,    67,    39    },
 123   { pinB0,    19,    22,    32,    42,    52,    62,    68,    47    },
 124   { pinB6,    27,    23,    33,    43,    53,    63,    69,    48    },
 125   { pinB1,    28,    24,    34,    44,    54,    64,    0,     49    }, // 0 signifies no key at that location
 126   { pinB3,    29,    25,    35,    45,    55,    65,    0,     57    },
 127   { pinA0,    37,    26,    36,    46,    56,    66,    0,     58    },
 128 */
 129
 130
 131 // -- scanDual Example --
 132 // The example is the same as the previous one, but uses both columns and rows to power and detect, needed for non-NKRO matrices.
 133 /*
 134   { scanMode, pinF0, pinF4, pinB7, pinD3, pinF5, pinF1, pinD1, pinD2 },
 135   { pinF6,    1,     2,     3,     4,     5,     6,     7,     8     },
 136   { pinF7,    9,     10,    11,    12,    13,    14,    15,    16    },
 137   { pinB2,    17,    20,    30,    40,    50,    60,    59,    38    },
 138   { pinD0,    18,    21,    31,    41,    51,    61,    67,    39    },
 139   { pinB0,    19,    22,    32,    42,    52,    62,    68,    47    },
 140   { pinB6,    27,    23,    33,    43,    53,    63,    69,    48    },
 141   { pinB1,    28,    24,    34,    44,    54,    64,    0,     49    }, // 0 signifies no key at that location
 142   { pinB3,    29,    25,    35,    45,    55,    65,    0,     57    },
 143   { pinA0,    37,    26,    36,    46,    56,    66,    0,     58    },
 144 */
 145
 146
 147 };
 148