README.org

   1 * Atreus Keyboard
   2
   3 The Atreus is a mechanical keyboard designed primarily to match the
   4 shape of human hands and to be as portable as possible. The case
   5 measures 26x12cm and lacks even a number row, relying heavily upon the
   6 =fn= key. There is a circuit board for this design, but it's also
   7 possible to [[http://wiki.geekhack.org/index.php?title=Hard-Wiring_How-To][manually wire the matrix]].
   8
   9 I've seen a number of existing DIY 40% keyboard designs, but most of
  10 them stagger the rows, which I find very annoying now that I've gotten
  11 used to the columnar layout of the [[http://ergodox.org][Ergodox]]. In addition, many of the
  12 designs I've seen waste a lot of room on the space bar, failing to
  13 take into account the fact that the thumb is the strongest and most
  14 versatile of the fingers. This design avoids both these problems while
  15 taking a more couch-friendly single-piece approach.
  16
  17 [[./atreus.jpg]]
  18
  19 See [[./changelog.md][the changelog]] for the various revisions made to the design since
  20 its initial release.
  21
  22 ** Kits
  23
  24 You can buy [[http://atreus.technomancy.us][Atreus kits]] that have all the parts you need along with
  25 detailed assembly instructions from http://atreus.technomancy.us. If
  26 you'd rather round up all the parts yourself, that's possible too
  27 since the design is completely open source; see the bill of materials
  28 below.
  29
  30 ** Layout
  31
  32 Only a handful of punctuation marks (and no digits) are available
  33 unshifted, and all the modifiers are on the bottom row:
  34
  35  :    q     w     e     r     t       ||       y     u     i     o    p
  36  :    a     s     d     f     g       ||       h     j     k     l    ;
  37  :    z     x     c     v     b       ||       n     m     ,     .    /
  38  :   esc   tab  super shift bksp ctrl || alt space  fn     -     '  enter
  39
  40 The numbers and most of the punctuation are on the fn layer with a
  41 numpad-style arrangement under the right hand:
  42
  43  :    !     @     {     }     |       ||     pgup    7     8     9    *
  44  :    #     $     (     )     `       ||     pgdn    4     5     6    +
  45  :    %     ^     [     ]     ~       ||       \     1     2     3    ?
  46  :   L2  insert super shift bksp ctrl || alt space   fn    .     0    =
  47
  48 The =L2= key switches it to the function layer, and tapping =L0= here
  49 brings it back to the first layer.
  50
  51  :  insert home    ↑    end  pgup     ||       ↑     F7    F8    F9   F10
  52  :    del   ←      ↓     →   pgdn     ||       ↓     F4    F5    F6   F11
  53  :                                    ||             F1    F2    F3   F12
  54  :              super shift bksp ctrl || alt space   L0             reset
  55
  56 The [[https://github.com/technomancy/atreus-firmware][firmware project]] includes a number of other options, including
  57 colemak, dvorak, and "software dvorak" which sends keycodes assuming
  58 the OS will perform the translation into dvorak. Adding new layouts or
  59 changing existing ones is easy.
  60
  61 ** Parts
  62
  63 *** Switches
  64
  65 This layout has five modifiers and 37 non-modifiers.
  66
  67 I strongly prefer the feel and sound of tactile [[http://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=651][Cherry MX blue]]
  68 switches for typing. However, I like having linear [[http://mechanicalkeyboards.com/shop/index.php?l=product_detail&p=103][Cherry MX black
  69 switches]] switches on the modifier keys (ctrl, alt, super, shift, and
  70 fn) because the tactile effect has no benefit for keys that are held
  71 down, and giving a different response helps you learn the layout more
  72 quickly.
  73
  74 For users that need to operate in sound-sensitive environments like
  75 open offices or libraries, [[http://deskthority.net/wiki/Cherry_MX_Clear][Cherry MX Clear]] switches are a popular
  76 choice since they still offer tactility without the noise.
  77
  78 *** Diodes
  79
  80 In order to avoid ghosting, each switch needs a diode. The [[https://www.radioshack.com/product/index.jsp?productId=2062587][1N4148]] is a
  81 readily-available choice, but nearly any signal diode would work.
  82
  83 *** Microcontroller
  84
  85 The circuit board design uses a [[http://www.pololu.com/product/3101][Pololu A-star micro]]. Hand-wired boards
  86 can also use a [[http://www.pjrc.com/teensy/index.html][Teensy 2]] or [[http://arduino.cc/en/Main/ArduinoBoardMicro][Arduino Pro Micro]].
  87
  88 Be sure to get a microcontroller without headers so it will fit in
  89 between the bottom layer and the plate. USB micro is preferred over
  90 USB mini for this reason as well.
  91
  92 *** Keycaps
  93
  94 This [[http://keyshop.pimpmykeyboard.com/products/full-keysets/dsa-blank-sets-1][DSA-shaped base set]] (spherical indentations on the key, same
  95 profile for each row) from Signature Plastics has 52 1x keys plus a
  96 few extras we won't use. There are two "deep dish" keys in that set
  97 which you can place under your index fingers on the home row to help
  98 guide your hands to the right spot without looking. However, you only
  99 get a single 1.5x keycap, and the middle two thumb keys both use them,
 100 so you might want to pick up an extra.
 101
 102 Many keycap sets (not the one linked above) are "sculpted", meaning
 103 that keys that go in different rows have a different shape. While you
 104 can use these for an Atreus, it's unlikely you'll find a set with the
 105 correct number for each row, so it's more wasteful.
 106
 107 ** Circuit Board
 108
 109 The =atreus.rkt= program calculates switch and diode positions based
 110 on row/column counts, spacing, and rotation factors, and emits a
 111 =atreus.kicad_pcb= file. The board outline and traces are done by hand
 112 and are stored in the =header.rktd= and =traces.rktd= files
 113 respectively. The =atreus.kicad_pcb= file can be imported into [[http://kicad.org][Kicad]]
 114 which can export Gerber files suitable for fabrication. A copy of the
 115 Kicad PCB file is included in the repository if you don't want to
 116 recompile it using Racket. Recompiling is only required if you want to
 117 make changes to the procedurally-generated portions of the board.
 118
 119 Unfortunately most PCB fabricators require a minimum order of 10 or
 120 so, making this impractical for one-offs. The PCB is not required, so
 121 for one-off boards it's usually more sensible to stick with a [[http://atreus.technomancy.us/assembly-hand-wired.pdf][hand-wired build]] instead.
 122
 123 ** Case
 124
 125 Layered laser-cut wood or acrylic. The [[http://geekhack.org/index.php?topic%3D54759.msg1304117#msg1304117][mark II case]] (EPS files in the
 126 =case/= directory) features 8 screw holes and a kind of "stair step"
 127 design around the top and bottom of the key clusters; mark I is
 128 pictured below.
 129
 130 The =3mm.eps= file contains the top plate, bottom plate, and switch
 131 plate. These can all be cut on 3mm acrylic or wood. The =spacer.eps=
 132 file should be cut on something thicker; between 4.5mm and 6mm is
 133 recommended. The spacer needs to be at least as thick as the connector
 134 of the USB cable you're using.
 135
 136 There is also a programmatically-implemented version of the case
 137 written in OpenSCAD; it is more flexible (you can tweak the number of
 138 rows/cols, etc and recompile) but it doesn't match the canonical case
 139 exactly; in particular the screw holes are placed differently.
 140
 141 The original case (=case-mk-i.svg=) design is also included; it is
 142 slightly less wide and has a minor asymmetry with the screws on the
 143 bottom side.
 144
 145 On a 100W Epilog laser, the 3mm layers cut in about a minute and a
 146 half. I did a run with 6mm acrylic of the other layers which took
 147 nearly 6 minutes.
 148
 149 Wood cases should be finished with sandpaper and finishing oil/wax.
 150
 151 ** Firmware
 152
 153 The [[https://github.com/technomancy/atreus-firmware/][custom Atreus firmware]] is a small C project which
 154 implements matrix scanning and debouncing with user-customizeable
 155 layers and macro functions. Another option is the much more complex
 156 TMK firmware. My [[https://github.com/technomancy/tmk_keyboard/tree/atreus][fork of the tmk firmware]] has support for the Atreus
 157 layout. You should be able to change into the =keyboard/atreus=
 158 directory and run =make KEYMAP=atreus= (or whichever variant you want)
 159 to produce a qwerty =atreus.hex= file. You will probably want to
 160 create your own layout once you've gotten a chance to try it and see
 161 what works for you.
 162
 163 In either case you would use the =.hex= file you just produced with
 164 =avrdude= or the [[http://www.pjrc.com/teensy/loader.html][teensy loader]] to upload to the microcontroller. =make
 165 upload= should do what you need.
 166
 167 Once the firmware is loaded and the keyboard is assembled, activating
 168 the hardware reset to upload new versions of the firmware is pretty
 169 cumbersome; instead use the "reset" button on the layout, which has
 170 the same effect.
 171
 172 ** Bill of Materials
 173
 174 - 50 MX Blue switches: $29.00 (mechanicalkeyboards.com)
 175 - 50 diodes: $3.45 (radio shack, should be able to buy in-person)
 176 - Base blank DSA keycap set: $23.00 (signatureplastics.com)
 177 - Teensy 2: $16, $3 shipping (pjrc.com)
 178 - Case materials: ~$16, varies by source
 179 - Case laser cutting: 7.5 minutes on a 100W Epilog laser; varies by source
 180 - USB micro cable: $5, various sources
 181
 182 Recommended but optional:
 183
 184 - 5 MX Red or MX Black switches: $8.50 - $10.00
 185 - additional 1.5x DSA keycap: $1 plus $8 shipping
 186
 187 The base keycap set only has one 1.5x key, which is used for the inner
 188 thumb keys. You can use a 1x key for one of them, but it looks kind of
 189 tacky, so I recommend getting a second 1.5x keycap separately.
 190
 191 *** Other Tools
 192
 193 You'll need a soldering iron, solder, and a wire cutter. A multimeter
 194 can come in handy for testing the connections but is optional. You'll
 195 also need eight M3 machine screws with nuts; the length of the screws
 196 depends on the thickness of the acrylic you use. You can add rubber
 197 feet to the bottom to prevent the board from sliding around when
 198 placed on a desk. You'll also need sandpaper and finishing oil for the
 199 wooden cases unless you have bought a kit.
 200
 201 If you are building a hand-wired board you will also need a glue gun,
 202 hookup wire, and wire strippers.
 203
 204 ** Assembly
 205
 206 See the [[http://atreus.technomancy.us/assembly.pdf][assembly instructions]] PDF.
 207
 208 Hand-wired boards will want the [[http://atreus.technomancy.us/assembly-hand-wired.pdf][previous edition of the assembly instructions]].
 209
 210 The LaTeX source to the assembly instructions is in the =assembly= directory.
 211
 212 ** Inspiration
 213
 214 These fine projects all provided inspiration for various aspects of
 215 the Atreus, as well as the folks on the =#geekhack= freenode channel.
 216
 217 - [[http://ergodox.org][Ergodox]]
 218 - [[http://deskthority.net/workshop-f7/onehand-20-keyboard-t6617.html][OneHand]]
 219 - [[http://blog.fsck.com/2013/12/better-and-better-keyboards.html][keyboard.io]]
 220 - [[http://geekhack.org/index.php?topic=48718][ErgoT]]
 221
 222 ** Builds
 223
 224 If you've built an Atreus, please add your name to [[https://github.com/technomancy/atreus/wiki/BuildLogs][the build logs wiki]].
 225
 226 There's also a [[http://atreus.technomancy.us/list][mailing list]] for people who have built or ordered an
 227 Atreus or are interested in doing so. To join, simply email
 228 =atreus@librelist.com= with a subject of "join" and reply to the
 229 confirmation.
 230
 231 ** Orestes
 232
 233 A new [[https://www.flickr.com/photos/technomancy/14654421878][experimental build]] uses the [[http://pjrc.com/store/teensy31.html][Teensy 3]] microcontroller and
 234 ARM [[https://github.com/technomancy/orestes/tree/teensy3][Forth-based]] firmware, but this is not yet suitable for general-purpose use.
 235
 236 ** License
 237
 238 Copyright © 2014-2015 Phil Hagelberg and contributors
 239
 240 Released under the [[https://www.gnu.org/licenses/gpl.html][GNU GPL version 3]]