keyboards/ckeys/handwire_101/readme.md

   1 # cKeys Handwire 101 Workshop
   2
   3 ![](https://ckeys.org/images/proton-c-handwire-1.jpg)
   4
   5 ## Slides
   6
   7 Slides can be found at: https://ckeys.org/slides/handwire/
   8
   9 ## Case Design
  10
  11 The laser cutting file is ideal for Ponoko's P1 board size.
  12
  13 ## Firmware
  14
  15 If you want to reflash the pre-installed firmware, use the `.bin` file for Proton C and the `.hex` file for Pro Micro builds. Flash with the QMK Toolbox or via the command line.
  16
  17 Building for Proton C: `make ckeys/handwire_101:default CTPC=yes`
  18 Building for Pro Micro: `make ckeys/handwire_101:default`
  19
  20 Pre-built firmware files (and laser cutting case files) can be found here: https://github.com/c-keys/handwire
  21
  22 ## Default Layout
  23
  24 You can find the default layout in `qmk-handwire/keymaps/default/keymap.c`
  25
  26 ### Layers
  27
  28 When you plug in your keyboard, it will function as a numpad. You will remain in the `Base` numpad layer unless you hold down the top right corner key and select one of the keys in the left most column. In QMK, this is called a momentary switch and looks like `MO(LAYERS)` in the default `keymap.c`. You can read more about layer switching in the [QMK Documentation](https://beta.docs.qmk.fm/features/feature_advanced_keycodes#switching-and-toggling-layers).
  29
  30 #### Base
  31 ```
  32     /* BASE (numpad)
  33    * ,-----------------------.
  34    * |  7  |  8  |  9  |  /  | <-- Hold for LAYERS
  35    * |-----+-----+-----+-----|
  36    * |  4  |  5  |  6  |  *  |
  37    * |-----+-----+-----+-----|
  38    * |  1  |  2  |  3  |  -  |
  39    * |-----+-----+-----+-----|
  40    * |  0  |  .  |  =  |  +  |
  41    * `---------------------- '
  42    */
  43 ```
  44
  45 #### Layers
  46
  47 ```
  48     /* LAYERS
  49    * ,---------------------------.
  50    * |  MUSIC  |     |     |  X  |
  51    * |---------+-----+-----+-----|
  52    * |  MOUSE  |     |     |     |
  53    * |---------+-----+-----+-----|
  54    * |TERMINAL |     |     |     |
  55    * |---------+-----+-----+-----|
  56    * |  ADMIN  |     |     |     |
  57    * `---------------------------'
  58    */
  59 ```
  60
  61 This is the layers layer. This is how you toggle other layers on and off. If you toggle on a layer, it is important that you re-toggle that layer offbefore switching to a new layer.
  62
  63 #### Music
  64
  65 ```
  66     /* MUSIC
  67    * ,-----------------------.
  68    * |  X  |     |     |  X  |
  69    * |-----+-----+-----+-----|
  70    * |     |     |     |4EVER|
  71    * |-----+-----+-----+-----|
  72    * | OFF |     |     |     |
  73    * |-----+-----+-----+-----|
  74    * |  ON |     |     |MODES|
  75    * `---------------------- '
  76    */
  77 ```
  78
  79 You can toggle the music mode on and off. You can also change the mode of music modes. Lastly, you can switch to the Music 4 Life mode but tapping the key marked `4EVER` above (see below). For more information on music mode, see the [QMK Documentation](https://beta.docs.qmk.fm/features/feature_audio).
  80
  81 _NOTE: This layer will only make sounds if you install a speaker. At the time of this writing, you can get the Proton C specific piezo speaker for [$2.61 with free overnight shipping](https://www.arrow.com/en/products/ast1109mltrq/mallory-sonalert-products). You can solder it on by desoldering the row wires where they contact the cathode end of the diodes. Then flip over the Proton C and solder the piezo speaker in. Then re-solder the row wires and you should hear beeps and boops the next time you plug in your keyboard._
  82
  83 #### Music 4 Life
  84
  85 ```
  86     /* MUSIC_4_LIFE
  87    * ,-----------------------.
  88    * |  ♫  |  ♫  |  ♫  |  ♫  |
  89    * |-----+-----+-----+-----|
  90    * |  ♫  |  ♫  |  ♫  |  ♫  |
  91    * |-----+-----+-----+-----|
  92    * |  ♫  |  ♫  |  ♫  |  ♫  |
  93    * |-----+-----+-----+-----|
  94    * |  ♫  |  ♫  |  ♫  |  ♫  |
  95    * `---------------------- '
  96    */
  97 ```
  98
  99 Music mode on every single key. However, you will need to unplug your keyboard in order to get out of this mode. The benefit of this is that you can use every single key as opposed to the few left over in the Music Mode layer. Try changing the chromatic mode before switching to this mode.
 100
 101 #### Mouse
 102
 103 ```
 104     /* MOUSE
 105    * ,-------------------------------------------------.
 106    * |  BUTTON 5 |           | SCROLL UP  |     X      |
 107    * |-----------+-----------+------------+------------|
 108    * |     X     |LEFT CLICK |     UP     |RIGHT CLICK |
 109    * |-----------+-----------+------------+------------|
 110    * |  BUTTON 4 |   LEFT    |    DOWN    |   RIGHT    |
 111    * |-----------+-----------+------------+------=-----|
 112    * |  BUTTON 3 |SCROLL LEFT|SCROLL DOWN |SCROLL RIGHT|
 113    * `-------------------------------------------------'
 114    */
 115 ```
 116
 117 Switch to this mode, force yourself through the steep transitionary period, and then you can ditch mice and trackpads forever!
 118
 119 #### Terminal
 120
 121 ```
 122     /* TERMINAL
 123    * ,---------------------------------------.
 124    * |            |ABOUT|          |    X    |
 125    * |------------+-----+----------+---------|
 126    * |TERMINAL OFF|PRINT|          |         |
 127    * |------------+-----+----------+---------|
 128    * |     X      |FLUSH|          |         |
 129    * |------------+-----+----------+---------|
 130    * |TERMINAL ON |HELP |          |         |
 131    * `--------=======------------------------'
 132    */
 133 ```
 134
 135 This layer is not currently working but has been left as an example of how to write macros.
 136
 137 #### Admin
 138
 139 ```
 140     /* ADMIN
 141    * ,-----------------------------------------.
 142    * |   RESET    |     |           |    X     |
 143    * |------------+-----+-----------+----------|
 144    * |ABOUT CKEYS |     |           |          |
 145    * |------------+-----+-----------+----------|
 146    * |            |     |CLICKY UP  |CLICKY OFF|
 147    * |------------+-----+-----------+----------|
 148    * |     X      |     |CLICKY DOWN|CLICKY ON |
 149    * `-----------------------------------------'
 150    */
 151 ```
 152
 153 The most important key in this layer is the `RESET` switch. Use it to flash new firmware. It does the same thing as the hardware button on the Proton C. But since you soldered the Proton C with the reset button facing towards the keys, the only way to reach it is to de-solder wires. The reset switch solves this. Program a reset switch into all of your future keyboards.
 154
 155 The `ABOUT CKEYS` is another example of using a macro. It will type out a few sentences about cKeys.
 156
 157 The clicky buttons will only make a difference if you install a piezo speaker. If you install a speaker, then you can make your keyboard extra clicky sounding even if you did not install clicky switches.
 158
 159 ![](https://ckeys.org/images/proton-c-handwire-2.jpg)
 160 ![](https://ckeys.org/images/proton-c-handwire-3.jpg)
 161 ![](https://ckeys.org/images/handwire-1.jpg)
 162 ![](https://ckeys.org/images/handwire-2.jpg)
 163 ![](https://ckeys.org/images/handwire-3.jpg)