README.org

   1 * Atreus Keyboard
   2
   3 The [[http://ergodox.org][Ergodox]] keyboard is an absolutely fantastic design; I use it every
   4 day at my office. However, I like to work away from the office
   5 frequently, and I thought I might try my hand at designing something a
   6 little more portable. The great thing about assembling my Ergodox is
   7 that it taught me there's really nothing magical about it; it's just a
   8 piece of circuitry with a bunch of switches read by a microcontroller
   9 that speaks the USB HID interface.
  10
  11 The Atreus is meant to be complementary to the Ergodox as something
  12 smaller, cheaper, and more travel-friendly. The case measures 25x11cm
  13 and lacks even a number row, relying heavily upon the fn key. There is
  14 no PCB in this design, requiring [[http://wiki.geekhack.org/index.php?title=Hard-Wiring_How-To.html][a manual matrix wiring approach]].
  15 However, given that there are only 4 rows and 11 columns, this isn't
  16 as daunting as it could be.
  17
  18 I've seen a number of existing DIY 40% keyboard designs, but most of
  19 them stagger the rows, which I find very annoying now that I've gotten
  20 used to the columnar layout of the Ergodox. In addition, many of the
  21 designs I've seen waste a lot of room on the space bar, failing to
  22 take into account the fact that the thumb is the strongest and most
  23 versatile of the fingers. This design avoids both these problems while
  24 taking a more couch-friendly single-piece approach.
  25
  26 [[atreus.jpg]]
  27
  28 ** Layout
  29
  30 Only a handful of punctuation marks (and no digits) are available
  31 unshifted, and all the modifiers are on the bottom row.
  32
  33  :    q     w     e     r     t       ||       y     u     i     o    p
  34  :    a     s     d     f     g       ||       h     j     k     l    ;
  35  :    z     x     c     v     b       ||       n     m     ,     .    /
  36  :   esc   tab  super shift bksp ctrl || alt space  fn   enter pgup  pgdn
  37
  38 The numbers and most punctuation are on the fn layer:
  39
  40  :    1     2     3     4    5        ||       6     7     8     9    0
  41  :    -     +     (     )    =        ||       /     [     ]     {    }
  42  :    !     @     #     $    %        ||       ^     &     *     ~    ?
  43  :  reset                    `        ||                   _     |    \
  44
  45 I type in Dvorak but prefer to do the remapping in software rather than
  46 hardware so I don't have to change layouts when I switch to my
  47 laptop's internal keyboard.
  48
  49 ** Parts
  50
  51 *** Switches
  52
  53 This layout has five modifiers and 37 non-modifiers.
  54
  55 I strongly prefer the feel and sound of tactile [[http://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=651][Cherry MX blue]]
  56 switches for typing. However, I like having linear switches on the
  57 modifier keys (ctrl, alt, super, shift, and fn). [[http://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=102][Cherry MX red
  58 switches]] are nice and light but are expensive and difficult to
  59 find. [[http://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=103][Cherry MX black switches]] are cheaper and easier to source, but
  60 may be too heavy, especially for keys under pinky fingers.
  61
  62 One trick is take the springs from some of your blue switches and
  63 trade them with the springs from your black switches. The blacks then
  64 become the equivalent of reds, and the blues become MX green switches,
  65 which are a heavier variant of blues. These are typically used for
  66 space bars on boards that otherwise use blues. They could be suitable
  67 for non-modifier thumb keys like backspace, space, and enter.
  68
  69 *** Diodes
  70
  71 In order to avoid ghosting, each switch needs a [[https://www.radioshack.com/product/index.jsp?productId=2062587][1N4148 diode]].
  72
  73 *** Microcontroller
  74
  75 An [[http://www.digikey.com/product-search/en/programmers-development-systems/evaluation-boards-embedded-mcu-dsp/2621773?k=arduino%20micro][Arduino Micro]] or [[http://www.pjrc.com/teensy/index.html][Teensy 2]] is recommended. Be sure to get one
  76 without headers so it will fit in between the bottom layer and the plate.
  77
  78 *** Keycaps
  79
  80 This [[http://keyshop.pimpmykeyboard.com/product/dsa-pbt-blank-sets][DSA-shaped base set]] (spherical indentations on the key, same
  81 profile for each row) from Signature Plastics has 52 1x keys plus a
  82 few extras we won't use. It claims on that page to contain only one
  83 deep key, but my shipment contained two, which I put under the index
  84 finger keys to help guide your hands without looking. However, it only
  85 contained a single 1.5x keycap, and the middle two thumb keys both use
  86 them, so you might want to pick up an extra.
  87
  88 ** Case
  89
  90 Layered laser-cut acrylic; see [[file:case.svg][case.svg]].
  91
  92 [[layers.jpg][layers.jpg]]
  93
  94 The first two shapes in the case file are the top and bottom covers;
  95 these should be cut on 3mm acrylic (black in the photo). The third is
  96 the spacer that goes under the fourth, which is the plate on which the
  97 switches are mounted. These should be cut in 6mm, especially the
  98 spacer, which needs to be at least as thick as the micro USB cable you
  99 connect to the microcontroller. The switch plate could be thinner,
 100 but not under 3mm.
 101
 102 On a 100W Epilog laser, the 3mm layers cut in about a minute and a
 103 half. I did a run with 6mm acrylic of the other layers which took
 104 nearly 6 minutes.
 105
 106 ** Firmware
 107
 108 My [[https://github.com/technomancy/tmk_keyboard/tree/atreus][fork of the tmk firmware]] has support for the Atreus
 109 layout. Currently only supports software-dvorak--the default layer is
 110 all qwerty, but the punctuation keys send keycodes assuming that the
 111 qwerty->dvorak transformation will be applied to them, so they don't
 112 make sense otherwise.
 113
 114 You should be able to cd into the =keyboard/atreus= directory and run
 115 =make KEYMAP\=atreus= (or whichever variant you want) to produce a
 116 =atreus.hex= file. Use this with the [[http://www.pjrc.com/teensy/loader.html][teensy loader]] or Arduino tools to
 117 upload to the microcontroller.
 118
 119 Once the firmware is loaded and the keyboard is assembled, pressing
 120 the onboard reset button to update new versions of the firmware is
 121 pretty cumbersome; instead use the "reset" button on the lower left
 122 of the layout which has the same effect.
 123
 124 ** Recommended Bill of Materials
 125
 126 - 50 MX Blue switches: $29.00 (mechanicalkeyboards.com)
 127 - 50 diodes: $3.45 (radio shack, should be able to buy in-person)
 128 - Base DSA keycap set: $18.00 (signatureplastics.com)
 129 - Teensy 2: $16 (pjrc.com or mechanicalkeyboards.com)
 130 - Acrylic materials: $11
 131 - Acrylic laser cutting: 7.5 at $3/min (varies by thickness of acrylic)
 132
 133 - 5 MX Black switches: $8.50 (optional)
 134 - 5 MX Red switches: $10.00 (optional)
 135 - additional 1.5x DSA keycap: $1 (optional)
 136
 137 =(+ 29 3.45 18 16 11 (* 3 7.5))= $99.95 plus tax/shipping
 138
 139 - mechanicalkeyboards.com: free shipping in the US
 140 - Signature Plastics (keycaps) US shipping: $8.00
 141 - PJRC (teensy) shipping: $3.03
 142
 143 ** Other Tools
 144
 145 You'll need a soldering iron, solder, a glue gun, a multimeter, wire,
 146 wire strippers, and a USB micro cable. You'll also need seven M3
 147 machine screws with nuts; the length of the screws depends on the
 148 thickness of the acrylic you use.
 149
 150 ** Assembly
 151
 152 Once you have all the parts, the first thing to do is glue the
 153 switches to the switch plate since there's no PCB to hold them in
 154 place. Be aware that the screw holes unfortunately are not
 155 symmetrical, so before inserting the switches it's important to ensure
 156 that the plate is right-side-up. Use a drop of hot glue on the top and
 157 bottom of each switch to affix it in place.
 158
 159 [[wires.jpg]]
 160
 161 Once the switches are in place, the matrix must be created. I
 162 recommend getting red wire for the rows and black for the columns. The
 163 rows need eight strands of wire with the insulation exposed at
 164 intervals matching the spacing of the switches; see the above photo for
 165 details. You could also just use many short stripped segments of wire
 166 instead of a contiguous piece. Most of the row wires will need four
 167 segments of insulation, but you'll need two with five for the rows
 168 with the inner thumb keys. Physically the inner thumb keys look like
 169 two additional columns, but logically they are treated as if they're
 170 in the same column with the left one in row 3 and the right one in
 171 row 4.
 172
 173 [[matrix.jpg]]
 174
 175 The exposed sections of row wire should be connected to the higher of
 176 the pins on the switch using a diode. Be aware that diodes are
 177 directional! The band around the diode should point to the top of the
 178 board. Take care with the upper row that you don't let the wire go too
 179 high; avoid getting in the way of the spacer layer. Once the
 180 rows are wired, the remaining (negative) pin of each switch should be
 181 wired into the negative pin of the switch above and below it. Use
 182 black wire. This should be slightly easier since no diode is
 183 necessary. The photo above shows the completed matrix for one side. Test
 184 each row and column as you go with a multimeter. You should be able to
 185 get continuity from row to column when the corresponding switch is
 186 activated.
 187
 188 After the matrix has been wired on both sides, the next step is to
 189 connect the microcontroller. The TMK firmware has the rows in pins D0,
 190 D1, D2, and D3 of the microcontroller. You'll need to connect the rows
 191 from both the left and right sides into the proper pin. There are more
 192 columns than rows, so I used ribbon cable to bring the column
 193 connections back to the microcontroller from the outside in. The
 194 columns go to pins F0, F1, E6, C7, C6, B6, D4, B1, B0, B5, and
 195 B4. It's important to realize that when you flip over the board
 196 in order to solder it, you have to flip over the schematic in your
 197 mind too. If you count your columns from the left, you'll get them
 198 backwards. (Which I actually did for the first half.)
 199
 200 [[controller.jpg]]
 201
 202 Once you've wired one side of the microcontroller in, it would be a
 203 good time to test it. You'll need to compile and upload as per the
 204 "Firmware" section above. At this point you should be reading real
 205 keycodes from the half of the keyboard that you've wired. Once you've
 206 confirmed that's working, continue with the other half. Then screw the
 207 other layers in place and you're all set!
 208
 209 ** Cost-saving Options
 210
 211 There are a few ways to lower the cost further.  Using [[http://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=482][Matias]] key
 212 switches could save you a fair bit if you go in on a 90-pack with
 213 someone else, but they're a little harder to find keycaps for; the MX
 214 caps won't work on them. Using wood for the case will reduce both the
 215 materials cost as well as the amount of time needed to cut the case.
 216
 217 Replacing the colored acrylic with transparent might also save a few
 218 dollars. You could also use thinner acrylic for the switch plate too;
 219 I cut mine in 4.5mm. A thinner spacer is inadvisable; even with 6mm
 220 it's pretty tight.
 221
 222 Another common trick is scavenging keycaps and switches from used
 223 keyboards; something with Cherry or Alps switches should work. This
 224 can be time-consuming though.
 225
 226 ** License
 227
 228 Copyright © 2014 Phil Hagelberg
 229
 230 Released under the [[https://www.gnu.org/licenses/gpl.html][GNU GPL version 3]]