keyboards/arrow_pad/readme.md

   1 arrow_pad keyboard firmware
   2 ======================
   3
   4 ## Keyboard Info
   5
   6 The ArrowPad is a wired conversion that can be made to any stand-alone keypad. It uses two main layers - a standard numpad, and a more advanced arrow cluster navigator.
   7
   8 The first 24-key ArrowPad was handwired, but the PCB was wired as listed below.
   9
  10 ```
  11 <Chip Ref Des> pin <Pin #>
  12 <Keycap Name> (Silkscreen Name if different) - <Switch Pin #>
  13
  14
  15 Note:
  16 U2 pin 2 is the Num Lock LED and is  active low.
  17
  18 U2 pin 1
  19 Clear (Num Lock) - 1
  20 Enter - 2
  21 Esc (ESC) - 2
  22
  23
  24 U2 pin 3
  25 - - 1
  26
  27 U2 pin 4
  28 7 - 2
  29 8 - 2
  30 9 - 2
  31
  32 U2 pin 5
  33 * - 2
  34 Delete (BACK SPACE) -  2
  35
  36 U2 pin 6
  37 1 - 2
  38 0 - 2
  39 . - 2
  40 , - 2
  41
  42 U2 pin 7
  43 4 - 2
  44 5 - 2
  45 6 - 2
  46
  47 U2 pin 8
  48 Tab - 2
  49 = (/) - 2
  50
  51 U2 pin 13
  52 Delete (BACK SPACE) -  1
  53 9 - 1
  54 6 - 1
  55 3 - 1
  56 . - 1
  57
  58 U2 pin 14
  59 Tab - 1
  60 8 - 1
  61 5 - 1
  62 2 - 1
  63 0 - 1
  64
  65 U2 pin 15
  66 Esc (ESC) - 1
  67 = (/) - 1
  68 / (*) - 1
  69 7 - 1
  70 4 - 1
  71 1 - 1
  72 + - 1
  73
  74 U2 pin 16
  75 Enter - 1
  76 * (<--) - 1
  77 , - 1
  78
  79 U2 pin 17
  80 Fn (#NAME?) - 1
  81 - - 2
  82 Clear (Num Lock) - 2
  83
  84 U2 pin 18
  85 Fn (#NAME?) - 2
  86 * (<--) - 2
  87 + - 2
  88 3 - 2
  89 2 - 2
  90 ```
  91
  92 More info can be found on [GeekHack](https://geekhack.org/index.php?topic=73632.msg1802497#msg1802497)
  93
  94 The second ArrowPad was a conversion from a 21-key Genovation keypad. It used a 2 row x 11 column matrix.
  95
  96 ```
  97 #define KEYMAP( \
  98     KM_ESC, KM_TAB, KM_BSL, KM_ARR, \
  99     KM_NUM, KM_FSL, KM_AST, KM_MIN, \
 100     KM___7, KM___8, KM___9, ___PLS, \
 101     KM___4, KM___5, KM___6, KM_PLS, \
 102     KM___1, KM___2, KM___3, ___ENT, \
 103     KM___0, _____0, KM_DOT, KM_ENT  \
 104 ) { \
 105     { KM_ESC, KM_TAB, KM_BSL, KM_ARR, KM___7, KM___8, KM___9, KM_PLS, KM___1, KM___2, KM___3, }, \
 106     { KM_NUM, KM_FSL, KM_AST, KM_MIN, KM___4, KM___5, KM___6, KM_ENT, KC_NO,  KM___0, KM_DOT, }, \
 107 }
 108 ```
 109
 110
 111 ## Quantum MK Firmware
 112
 113 For the full Quantum feature list, see [the parent readme.md](/readme.md).
 114
 115 ## Building
 116
 117 Download or clone the whole firmware and navigate to the keyboards/arrow_pad folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file.
 118
 119 Depending on which keymap you would like to use, you will have to compile slightly differently.
 120
 121 ### Default
 122 To build with the default keymap, simply run `make default`.
 123
 124 ### Other Keymaps
 125 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top readme.md) and existent keymap files.
 126
 127 To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
 128
 129 ```
 130 $ make [default|pad_21|pad_24|<name>]
 131 ```
 132
 133 Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.