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 withut 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 TODO: describe
 110
 111 ** Case
 112
 113 bottom side. The [[http://geekhack.org/index.php?topic%3D54759.msg1304117#msg1304117][mark II case]] (in the `case/dxf` directory) is
 114 available as a DFX file that you can convert to SVG or EPS for a laser
 115 cutter using Inkscape. Mark II features 8 screw holes and a kind of "stair
 116 step" design around the top and bottom of the key clusters; mark I is
 117 pictured below.
 118
 119 TODO: the logo is missing from some of the case files and needs to be added back in.
 120
 121 There is also a programmatically-implemented version of the case
 122 written in OpenSCAD; it is more flexible (you can tweak the number of
 123 rows/cols, etc and recompile) but it doesn't match the canonical case
 124 exactly; in particular the screw holes are placed differently.
 125
 126 [[./layers.jpg]]
 127
 128 The first two shapes in the case file are the top and bottom covers;
 129 these should be cut on 3mm acrylic (black in the photo). The third is
 130 the spacer that goes under the fourth, which is the plate on which the
 131 switches are mounted. These should be cut in 6mm, especially the
 132 spacer, which needs to be at least as thick as the mini USB cable you
 133 connect to the microcontroller. I recommend using a mini USB cable
 134 with as thin a connector as you can find or sanding the connector
 135 down to the required thickness. The switch plate could be thinner, but
 136 not under 3mm.
 137
 138 On a 100W Epilog laser, the 3mm layers cut in about a minute and a
 139 half. I did a run with 6mm acrylic of the other layers which took
 140 nearly 6 minutes.
 141
 142 Wood cases should be finished with sandpaper and finishding oil/wax.
 143
 144 ** Firmware
 145
 146 The [[https://github.com/technomancy/atreus-firmware/][custom Atreus firmware]] is a small C project which
 147 implements matrix scanning and debouncing with user-customizeable
 148 layers and macro functions. Another option is the much more complex
 149 TMK firmware. My [[https://github.com/technomancy/tmk_keyboard/tree/atreus][fork of the tmk firmware]] has support for the Atreus
 150 layout. You should be able to change into the =keyboard/atreus=
 151 directory and run =make KEYMAP=atreus= (or whichever variant you want)
 152 to produce a qwerty =atreus.hex= file. You will probably want to
 153 create your own layout once you've gotten a chance to try it and see
 154 what works for you.
 155
 156 In either case you would use the =.hex= file you just produced with
 157 =avrdude= or the [[http://www.pjrc.com/teensy/loader.html][teensy loader]] to upload to the microcontroller. =make
 158 upload= should do what you need.
 159
 160 Once the firmware is loaded and the keyboard is assembled, activating
 161 the hardware reset to upload new versions of the firmware is pretty
 162 cumbersome; instead use the "reset" button on the layout, which has
 163 the same effect.
 164
 165 ** Bill of Materials
 166
 167 - 50 MX Blue switches: $29.00 (mechanicalkeyboards.com)
 168 - 50 diodes: $3.45 (radio shack, should be able to buy in-person)
 169 - Base blank DSA keycap set: $23.00 (signatureplastics.com)
 170 - Teensy 2: $16, $3 shipping (pjrc.com)
 171 - Case materials: ~$16, varies by source
 172 - Case laser cutting: 7.5 minutes on a 100W Epilog laser; varies by source
 173 - USB micro cable: $5, various sources
 174
 175 Recommended but optional:
 176
 177 - 5 MX Red or MX Black switches: $8.50 - $10.00
 178 - additional 1.5x DSA keycap: $1 plus $8 shipping
 179
 180 The base keycap set only has one 1.5x key, which is used for the inner
 181 thumb keys. You can use a 1x key for one of them, but it looks kind of
 182 tacky, so I recommend getting a second 1.5x keycap separately.
 183
 184 *** Other Tools
 185
 186 You'll need a soldering iron, solder, and a wire cutter. A multimeter
 187 can come in handy for testing the connections but is optional. You'll
 188 also need eight M3 machine screws with nuts; the length of the screws
 189 depends on the thickness of the acrylic you use. You can add rubber
 190 feet to the bottom to prevent the board from sliding around when
 191 placed on a desk. You'll also need sandpaper and finishing oil for the
 192 wooden cases unless you have bought a kit.
 193
 194 If you are building a hand-wired board you will also need a glue gun,
 195 hookup wire, and wire strippers.
 196
 197 ** Assembly
 198
 199 See the [[http://atreus.technomancy.us/assembly.pdf][assembly instructions]] PDF.
 200
 201 Hand-wired boards will want the [[http://atreus.technomancy.us/assembly-hand-wired.pdf][previous edition of the assembly instructions]].
 202
 203 ** Inspiration
 204
 205 These fine projects all provided inspiration for various aspects of
 206 the Atreus, as well as the folks on the =#geekhack= freenode channel.
 207
 208 - [[http://ergodox.org][Ergodox]]
 209 - [[http://deskthority.net/workshop-f7/onehand-20-keyboard-t6617.html][OneHand]]
 210 - [[http://blog.fsck.com/2013/12/better-and-better-keyboards.html][keyboard.io]]
 211 - [[http://geekhack.org/index.php?topic=48718][ErgoT]]
 212
 213 ** Builds
 214
 215 If you've built an Atreus, please add your name to [[https://github.com/technomancy/atreus/wiki/BuildLogs][the build logs wiki]].
 216
 217 There's also a [[http://librelist.com/browser/atreus/][mailing list]] for people who have built or ordered an
 218 Atreus or are interested in doing so. To join, simply email
 219 =atreus@librelist.com= with a subject of "join" and reply to the
 220 confirmation.
 221
 222 ** Orestes
 223
 224 A new [[https://www.flickr.com/photos/technomancy/14654421878][experimental build]] uses the [[http://pjrc.com/store/teensy31.html][Teensy 3]] microcontroller and
 225 ARM [[https://github.com/technomancy/orestes/tree/teensy3][Forth-based]] firmware, but this is not yet suitable for general-purpose use.
 226
 227 ** License
 228
 229 Copyright © 2014 Phil Hagelberg and contributors
 230
 231 Released under the [[https://www.gnu.org/licenses/gpl.html][GNU GPL version 3]]