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 be 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. It also allows for quicker iteration on
  17 design changes since alterations only require cutting a new case.
  18
  19 I've seen a number of existing DIY 40% keyboard designs, but most of
  20 them stagger the rows, which I find very annoying now that I've gotten
  21 used to the columnar layout of the Ergodox. In addition, many of the
  22 designs I've seen waste a lot of room on the space bar, failing to
  23 take into account the fact that the thumb is the strongest and most
  24 versatile of the fingers. This design avoids both these problems.
  25
  26 [[atreus.jpg]]
  27
  28 ** Layout
  29
  30 Only a handful of punctuation marks (and no digits) 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    fn  shift bksp ctrl || alt space enter super 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  :                                    ||       `     _     \
  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://www.digikey.com/product-detail/en/MX1A-E1NW/CH197-ND/20180][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://www.wasdkeyboards.com/index.php/products/keyboard-parts/cherry-mx-red-keyswitch-mx1a-l1nn-linear.html][Cherry MX red
  58 switches]] are nice and light but are expensive and difficult to
  59 find. [[http://www.digikey.com/product-detail/en/MX1A-11NW/CH160-ND/91134][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.
  68
  69 **** Recommended switch types for bottom row
  70
  71 - red: shift, super
  72 - black: fn, ctrl, alt
  73 - green: space, backspace, enter?
  74
  75 If you don't bother with the spring replacement step mentioned above,
  76 use blues instead of greens and blacks instead of reds. Or just use
  77 whatever switches you want; it's your board!
  78
  79 *** Diodes
  80
  81 In order to avoid ghosting, each switch needs a [[http://www.digikey.com/product-detail/en/1N4148TR/1N4148FSTR-ND/458811][diode]].
  82
  83 *** Microcontroller
  84
  85 An [[https://www.adafruit.com/products/1315][Arduino Micro]] or [[http://www.pjrc.com/teensy/index.html][Teensy 2]] is recommended.
  86
  87 *** Keycaps
  88
  89 This [[http://keyshop.pimpmykeyboard.com/product/dsa-pbt-blank-sets][DSA-shaped base set]] has 52 1x keys plus a few extras we won't use.
  90
  91 *** Screws
  92
  93 Seven M3 machine screws hold the whole thing together. The length of
  94 the screws depends on the thickness of the materials you use for the
  95 case.
  96
  97 ** Case
  98
  99 Layered laser-cut acrylic; see [[file:case.svg][case.svg]].
 100
 101 [[layers.jpg][layers.jpg]]
 102
 103 The first two shapes in the case file are the top and bottom covers;
 104 these should be cut on 3mm acrylic (black in the photo). The third is
 105 the spacer that goes under the fourth, which is the plate on which the
 106 switches are mounted. These should be cut in 4.5mm.
 107
 108 On a 100W Epilog laser, the 3mm layers cut in about a minute and a
 109 half. I did a run with 6mm acrylic of the other layers which took
 110 nearly 6 minutes, but with the recommended 4.5mm thickness it should
 111 be closer to four or five.
 112
 113 ** Firmware
 114
 115 My [[https://github.com/technomancy/tmk_keyboard/tree/atreus][fork of the tmk firmware]] has support for the Atreus
 116 layout. Currently only supports software-dvorak--the default layer is
 117 all qwerty, but the punctuation keys send keycodes assuming that the
 118 qwerty->dvorak transformation will be applied to them, so they don't
 119 make sense otherwise.
 120
 121 ** Recommended Bill of Materials
 122
 123 - 37 MX Blues @ $1.00
 124 - 5 MX Blacks @ 0.80
 125 - 42 diodes @ $0.052
 126 - Base keycap set: $18.00
 127 - Teensy 2: $16
 128 - Acrylic materials: $11
 129 - Acrylic laser cutting: 6 at $3/min (varies by thickness of acrylic)
 130
 131 =(+ 37 (* 5 0.8) (* 42 0.052) 18 16 11 (* 3 6))= -> 106.18 plus tax/shipping
 132
 133 - Digikey (switches and diodes) US shipping: $5.32
 134 - Signature Plastics (keycaps) shipping: $8.00
 135 - PJRC (teensy) shipping: $3.03
 136
 137 ** Cost-saving Options
 138
 139 There are a few ways to get the cost under $100. Using all black
 140 switches brings the total to $98, but I strongly recommend against
 141 this unless you're already familiar with the feel of the various
 142 Cherry switches. Using wood for the case will reduce both the
 143 materials cost as well as the amount of time needed to cut the
 144 case. Replacing the colored acrylic with transparent might also save a
 145 few dollars.
 146
 147 ** License
 148
 149 Copyright © 2014 Phil Hagelberg
 150
 151 Released under the [[https://www.gnu.org/licenses/gpl.html][GNU GPL version 3]]