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