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://deskthority.net/workshop-f7/brownfox-step-by-step-t6050.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  :  shift  esc   tab   fn   bksp ctrl || alt space enter pgup  pgdn super
  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 - shift: red
  71 - super: red
  72 - tab: blue
  73 - bksp: green
  74 - ctrl: black
  75 - fn: black
  76 - space: green
  77 - alt: black
  78 - enter: blue
  79 - esc: blue
  80 - page up: blue
  81 - page down: blue
  82
  83 If you don't bother with the spring replacement step mentioned above,
  84 use blues instead of greens and blacks instead of reds. Or just use
  85 whatever switches you want; it's your board!
  86
  87 *** Diodes
  88
  89 In order to avoid ghosting, each switch needs a [[http://www.digikey.com/product-detail/en/1N4148TR/1N4148FSTR-ND/458811][diode]].
  90
  91 *** Microcontroller
  92
  93 I'll be using a Teensy 3 since I have one on hand, but an [[https://www.adafruit.com/products/1315][Arduino
  94 Micro]] or [[http://www.pjrc.com/teensy/index.html][Teensy 2]] would work too.
  95
  96 *** Keycaps
  97
  98 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.
  99
 100 ** Case
 101
 102 Layered laser-cut acrylic; see [[file:case.svg][case.svg]].
 103
 104 [[layers.jpg][layers.jpg]]
 105
 106 The first two shapes in the case file are the top and bottom covers;
 107 these should be cut on 3mm acrylic (black in the photo). The third is
 108 the spacer that goes under the fourth, which is the plate on which the
 109 switches are mounted. These should be cut in 4.5mm.
 110
 111 ** Firmware
 112
 113 TODO: Uhhh...
 114
 115 ** BOM
 116
 117 - 37 MX Blues @ $1.00
 118 - 5 MX Blacks @ 0.80
 119 - 42 diodes @ $0.052
 120 - Base keycap set: $18.00
 121 - Teensy 2: $16
 122 - Acrylic materials: $11 (cheaper if transparent acrylic is used)
 123 - Acrylic laser cutting: $18 at $3/min
 124
 125 =(+ 37 (* 5 0.8) (* 42 0.052) 18 16 11 18)= -> 106.18 plus shipping and cutting
 126
 127 - Digikey (switches and diodes) shipping: $5.32 in the US
 128 - Signature Plastics (keycaps) shipping: ??
 129
 130 ** License
 131
 132 Copyright © 2014 Phil Hagelberg
 133
 134 Released under the [[https://www.gnu.org/licenses/gpl.html][GNU GPL version 3]]