192 |
open
193 |
194 |
195 |
196 |
197 |
198 | The Keyboard
199 |
200 |
201 | Ergodox is a keyboard project designed with ergonomics in mind, available either as a DIY kit or an assembled, commercial version. It uses 76-80 Cherry MX style mechanical switches (such as Cherry or Gateron) laid out in a columnar stagger (rather than the more conventional row stagger) layout with components that can easily be sourced. The keyboard is completely programmable and can be flashed with several different firmware options.
202 |
203 | The entire project (including this website) is open source, allowing you the freedom to modify and tweak the project as you see fit.
204 |
205 | Assembling this project will require some patience, soldering ability, and access to a computer to flash the firmware onto the keyboard.
206 |
207 | 
208 |
209 |
210 |
211 |
212 |
213 |
214 |
215 |
216 | Who built this?
217 |
218 |
219 | The ErgoDox keyboard is a DIY keyboard project originally developed by “Dox” (Dominic Beauchamp) inspired by the Key64 Keyboard.
220 |
221 | The printed circuit board was designed by “bpiphany” (Fredrik Atmer).
222 |
223 | The original 3D printable case was designed by Dox but a far more popular and less expensive option was a layered acrylic design by litster.
224 |
225 | The original firmware was designed by Ben Blazak.
226 |
227 | The ErgoDox EZ was commercialized and manufactured by Erez Zukerman, Dmitry Slepov, and Yaara Lancet.
228 |
229 | QMK Firmware which runs on the ErgoDox EZ was created by Jack Humbert, based on TMK.
230 |
231 | This website was built by robotmaxtron with some help from the community as a way to centralize the documentation after ErgoDox.org went defunct.
232 | If you want to contribute to the project, pull requests, bugs (via Github issues) can be filed at our Github
233 |
234 | Both the keyboard design and hardware files are licensed under the GNU Public License 3
235 |
236 | GeekHack Thread
237 |
238 |
239 |
240 |
241 |
242 |
243 |
244 | Guide
245 |
246 |
247 | A few things will need to be decided in advance before choosing parts or cases. The ErgoDox supports either the standard 76 key or 80 key layout.
248 |
249 | This project will require some tools such as a soldering iron, flush cutters, wire strippers, solder, and possibly a screwdriver.
250 |
251 | The build guide also assumes that you already know how to solder, if you do not know how to solder or want a refresher there are several guides available on YouTube and other places on the internet.
252 |
253 |
254 |
255 |
256 |
257 |
258 |
259 |
260 | Parts Needed
261 |
262 |
263 | To build an ErgoDox, some readily available components will need to be procured.
264 |
265 |
266 | - Some notes on the electronics before purchasing:
267 |
268 | - The Cherry MX style switches can be either pcb or plate mounted.
269 | - Either through hole or surface mount diodes can be used as the pcb supports both including in-switch through hole diodes.
270 | - If the typical 3mm red leds are not used, be sure to replace the 220 Ω resistors with ones that match the leds chosen.
271 | - PJRC sells a Teensy 2.0 both with and without header pins pre-installed. If you use a Teensy without the header pins pre-installed, you will need to obtain and install them.
272 | - The pcb only supports currently three in switch LEDs on the inner colum of the right hand labeled LEDa, LEDb, and LEDc.
273 | - Many if not all of the small components can be easily found online at vendors such as Mouser or Digikey.
274 |
275 |
276 |
277 |
278 |
279 |
280 |
281 |
282 |
283 |
284 |
285 | Printed Circuit Boards
286 |
287 |
288 | The pcb files are available in a separate repo available here should you wish to modify and/or produce them.
289 |
290 |
291 | - The latest revision of the pcbs can be purchased from the following vendors
292 |
295 |
296 | - Several vendors are available who generally stock some of the older revisions of the pcbs.
297 |
301 |
302 |
303 |
304 | You could also buy the updated pcb from a vendor of choice by providing them the KiCad or Gerber files in the repo listed above or purchase a batch from OSH Park
305 |
306 | Keep an eye out on the ErgoDox repo revision changelogs for updates and differences between pcb versions.
307 |
308 |
309 |
310 |
311 |
312 |
313 |
314 | Small Electronics
315 |
316 |
317 |
318 | - Full Parts list:
319 |
320 | - 1x Pair of pcbs (one for each hand)
321 | - 1x Teensy USB Board, Version 2.0
322 | - 24x Teensy header pins, male (unless pre-installed)
323 | - 1x MCP23018-E/SP I/O expander
324 | - 76-80x Cherry MX switches, (depending on your layout)
325 | - 76-80x 1N4148 diodes, SOD-123 package (Surface mount) or DO-35,(0.3” pitch) (through hole) (again, the amount needed will depend on your layout)
326 | - 2x 2.2k Ω resistors (red, red, red)
327 | - 3x 3mm T1 LEDs
328 | - 3x 220 Ω resistors, or match to LED. (red, red, brown)
329 | - 5x Short jumpers (You can also use the clipped off legs from your resistors)
330 | - 1x 0.1 µF ceramic capacitor (marked “104” for 10*104 picofarad). Not strictly necessary but suggested
331 | - 1x USB mini B connector WM17115
332 | - 1x USB mini B plug with short cable (such as H2955)
333 | - 1x USB cable male A to male mini B
334 | - 2x 3.5 mm TRRS sockets, CP-43514. FC68129 will also work if its extra pins are snipped off
335 | - 1x Cable with two 3.5 mm TRRS plugs
336 | - 1x Ergodox Keyboard case
337 | - 76-80x MX Keycaps
338 |
339 |
340 |
341 |
342 |
343 |
344 |
345 |
346 |
347 |
348 |
349 | Case & Keycaps
350 |
351 |
352 | While there are many options of materials available (such as cases carved out of wood) generally ErgoDox cases are either 3D printed or layered acrylic sheets.
353 |
354 | The 3D printable case options are available in our repo and have been uploaded to Shapeways
355 |
356 | The most popular and less expensive option is the layered acrylic design.
357 | Github Repo assembled with m3 bolts.
358 |
359 | There is also a 3D printable tenting stand in the repo organization. This will prop up the ErgoDox using Litster’s case at a very natural and comfortable angle.
360 |
361 |
362 | - Like any mechanical keyboard, keycaps will need to be obtained. In a normal 76 key configuration the following keycaps will be needed:
363 |
364 | - 12x 1.5u
365 | - 4x 2u
366 | - 60x 1u
367 |
368 |
369 |
370 |
371 | The 1.5u outer column keys can optionally be mounted closer in and 1u keycaps can be used.
372 |
373 | Note: This layout is only supported on the newer (post 2012) revisions of the pcb and will require a modified plate design to support the new placement.
374 |
377 | - If the 80 key layout is used, a slightly different keycap configuration will be needed replacing the 2u keys with two 1u keys each:
378 |
379 | - 12x 1.5u
380 | - 68x 1u
381 |
382 |
383 |
384 |
385 |
386 |
387 |
388 |
389 |
390 |
391 |
392 | Assembly Guide
393 |
394 |
395 | Now the section where the soldering and real assembly happens, in the next subsection there will be a couple external links to other build guides including both a photo and video build log.
396 |
397 |
398 | - Arrange the pcbs face down and solder in the diodes to this side.
399 |
400 | - 1a. If surface mount diodes are chosen, place them on the small square copper pads but be sure to orient the diodes so that the line on the diode faces the square hole. The line on the diode indicates the cathode/negative side. Solder the diodes and repeat for each switch on both hands.
401 | 
- 1b. If through hole diodes are chosen, place them through the two hole immediately to the left and right of copper pads under the square that the switch will take up. Be sure to check the orientation to be sure that the cathode/negative side of the diode is closest to the square hole. Solder and repeat for each switch on both hands.
403 | 
404 | Note: The additional holes in this second image are for through switch LEDs. Only one diode per switch is needed.
405 |
408 |
409 | -
410 |
Flip both of the pcbs over, this face up side (without the diodes) will be the side that the remaining components will be placed.
411 |
412 | - Insert both the 2.2k ohm resistors and 220 ohm (or whatever resistors chosen appropriate for the leds selected) onto the right hand where labled on the pcb and solder into place.
413 |
Note: Keep the legs clipped off the resistors, they can be used in a later step when the TRRS connections are installed.
414 |
416 | - On the left hand pcb, insert the I/O expander around the MCP23018 rectangle. The I/O expander is directional and the notch on the I/O expander should match up with the silkscreen. The notch on the expander will be facing ErgoDox printing on the circuit board. See the image in the next step for an example.
417 |
Note: There are three holes without copper pads and do not need to be soldered.
418 |
420 | - (Optional but suggested step) On the left hand pcb, insert the ceramic capacitor into the first and third holes of the top row and solder in place.
421 |
422 | - 5a. Bridge with solder the two copper pads immediately to the left of the ceramic capacitor.
423 | 
425 |
426 | - Insert either jumper wire or the legs clipped from the resistors bent into a U, into both of the the white pairs of holes on either side of where the 3.5mm connections will go and solder in place.
427 |
428 | - 6a. Place 3.5mm connection, solder the 4 connection points.
429 | - 6b. Repeat both the jumper and 3.5mm connectors on the other hand.
430 | 
432 |
433 | - Install the male jumper pins to the underside of the Teensy with the button face up and solder the pins to the top side of the Teensy.
434 |
Note: If the Teensy already has jumpers already installed, skip this step.
435 |
437 | - Insert the Teensy jumper legs from the Teensy assembly onto the right hand pcb with the usb facing the direction of the resistors and solder in place.
438 |
439 | 
441 |
442 | - Cut one of the mini usb cables about 1.5” from the connector.
443 |
444 | - 9a. Strip off all of the sheathing from the cable, exposing the 4 wires.
445 | - 9b. Place the following wires into their respective holes:
446 |
White: D-
447 | Red: 5v
448 | Green: D+
449 | Black: GND
450 |
452 | - 9c. Solder wires to the pcb.
453 | 
455 |
456 | - On the right hand, insert the mini usb connector into the holes marked on the pcb and solder into place.
457 |
458 | 
460 |
461 | - Prepare the chosen case.
462 |
463 | - 11a. If the layered acrylic case design is being used, peel off the protective film off the acrylic pieces.
464 |
465 | - Place the pcb under the 3rd acrylic layer and insert the switches into the acylic plate making sure that both pins from the switch are extending out through the pcb.
466 |
467 |
468 | - 11b. If the 3D printed case is being used
469 |
470 | - Place the pcb under the top section and push the switches into the case making sure that both pins from the switch are extending out through the pcb.
471 |
472 |
473 | - 11c. Solder switches in place.
474 |
Note: Make note of the location for the three switches on the right hand that will support the LEDs
475 |
477 |
478 |
479 | - On the right hand, insert the three leds through the housing of the three switches and solder into place.
480 |
Note: LEDs have polarity so be sure that the negative leg (which is the shorter of the two legs) of the LEDs goes into the (face up) square hole.
481 |
483 | - Finish assembling the case, plug in the TRRS cable between the two halves and proceed to building and flashing the selected firmware.
484 |
485 |
486 |
487 |
488 |
489 |
490 |
491 |
492 |
493 | Other Assembly Guides
494 |
495 |
496 | External links to some popular guides to building the ErgoDox Keyboard
497 |
498 | More the video type? YouTube has several other good guides, this one I think does an excellent job of balancing information and length.
499 |
500 | Imgur Build Log: user robotmaxtron shares his build log (including mistakes).
501 |
502 |
503 |
504 |
505 |
506 |
507 |
508 |
509 | Firmware Guide
510 |
511 |
512 | There are a number of options for the firmware powering the ErgoDox keyboard, each with their own sets of features and options. Please consult the README guides for each firmware for specific instructions on how to use and compile it.
513 |
514 |
515 |
516 |
517 |
518 |
519 |
520 |
521 | QMK
522 |
523 |
524 | A build guide for compiling and customizing your firmware is best found in the repo’s readme
525 |
526 | Note: There are many users who have committed their keymaps that can be built on and easily adapted to suit your needs.
527 |
The ErgoDox-EZ Configurator tool can also be used to generate keymappings and their .hex files with QMK.
530 |
531 | Homepage
532 |
533 |
534 |
535 |
536 |
537 |
538 |
539 |
540 | ErgoDox-EZ Configurator
541 |
542 |
543 | This is a powerful graphical configurator that lets you define layers, dual-function keys, LED control, and more without having to code.
544 |
545 | The configurator is based on QMK and outputs QMK source code which can be used as a starting point for your own configuration/editing.
546 |
547 | Homepage
548 |
549 |
550 |
551 |
552 |
553 |
554 |
555 |
556 | TMK
557 |
558 |
559 | The popular TMK firmware has also been ported to the ErgoDox.
560 |
561 | Github Repo
562 |
563 | Evan from TheVanKeyboards.com has built a TMK powered graphical configuration tool that supports the ErgoDox that can be used to create .hex files for flashing.
564 |
565 | ErgoDox TMK Configurator
566 |
567 |
568 |
569 |
570 |
571 |
572 |
573 | Original Ergodox Firmware
574 |
575 |
576 | The originally designed firmware is also available, though somewhat fallen out of favor due to QMK and TMK’s improved functionalty and larger community support. The project has not had much movement since late 2015.
577 |
578 | GitHub
579 |
580 |
581 |
582 |
583 |
584 |
585 |
586 |
587 | Online Massdrop Configurator
588 |
589 |
590 | Massdrop has developed an online tool for generating ErgoDox keymaps without the need to compile your own firmware, suggested for users who might not be comfortable compiling their own firmware.
591 |
592 | The underlying firmware behind the graphical tool is based on the original firmware by Ben Blazak.
593 |
594 | Homepage
595 |
596 |
597 |
598 |
599 |
600 |
601 |
602 |
603 | Flashing your Ergodox
604 |
605 |
606 | Once the firmware has been compiled down into a .hex file, it will need to be uploaded to the keyboard typically called flashing.
607 |
608 |
609 | - Flashing your Ergodox is typically done with the Teensy Loader, and will be needed for the following guide.
610 |
611 | - Locate your .hex file generated by your firmware of choice
612 | - Start the Teensy Loader program
613 | - Load the .hex file into it.
614 | - Press the Reset button by pressing the reset button onboard the Teensy, you may need to insert something such as a paperclip or small screwdriver gently into the reset hole in the top right corner of your case.
615 |
Note: Some firmware (such as QMK and TMK) allow for the resetting of your atmel chip to be programmed as a keycode.
616 |
618 | - Click the button in the Teensy app to upload the firmware to your keyboard.
619 |
620 |
621 |
622 |
623 |
624 |
625 |
626 |
627 |
628 |
629 |
630 | Variants
631 |
632 |
633 | The open source nature of the ErgoDox has lead to several variants of the original design. The following list is not a comprehensive list, but does list many of the more popular designs.
634 |
635 |
636 |
637 |
638 |
639 |
640 |
641 |
642 | Dactyl
643 |
644 |
645 | Created by Matthew Adereth, the Dactyl Keyboard is a parameterized, split-hand, concave, columnar, ergonomic keyboard is an outstanding variation on the ErgoDox design.
646 |
647 | 
648 |
649 | Build Guide for the brave (will be improved over time)
650 |
651 | The case is uploaded to the things directory of the Dactyl repo and has been uploaded to Shapeways
652 |
653 | Clojure/conj Talk on 3D Printing Keyboards: Adereth gave a very interesting talk on the history of keyboards and the creation of the very interesting shape of the Dactyl Keyboard.
654 |
655 |
656 | - Differences between the ErgoDox and the Dactyl:
657 |
658 | - 70 key layout, removes the inner column of keys.
659 | - 1u outer column keys rather than the standard 1.5u
660 | - Handwired or flexible pcb
661 | - Concave shaped switch mounting
662 | - No official firmware but several options available.
663 |
664 |
665 |
666 |
667 | GitHub Project Homepage
668 |
669 |
670 |
671 |
672 |
673 |
674 |
675 |
676 | ErgoDox EZ
677 |
678 |
679 | Another fork of the ErgoDox is a pre-built version with a case that supports legs that will allow you to ‘tent’ or angle the ErgoDox-EZ.
680 |
681 |
682 | - Firmware:
683 |
688 |
689 | - Differences between the original ErgoDox and the ErgoDox-EZ:
690 |
691 | - Preassembled
692 | - Custom-tooled case made from ABS plastic
693 | - Two-year warranty
694 | - Custom-built tilt/tent kit with metal legs that allow you to control the angle of the keyboard on your desk
695 | - Custom-made wrist rest (wing) available
696 | - Available with RGB LED case underglow
697 | - As of January 2018, the ErgoDox-EZ now ships with hot swappable switches called CIY (Change It Yourself).
698 |
699 |
700 |
701 |
702 | Homepage
703 |
704 |
705 |
706 |
707 |
708 |
709 |
710 |
711 | Infinity
712 |
713 |
714 | Another variant of the ErgoDox is the ErgoDox Infinity developed by Input.club. This variant has added an LCD screen built into each half as well as a few other updates to the original design.
715 |
716 |
717 | - Firmware options:
718 |
723 |
724 | - Cases:
725 |
729 |
730 | - Printed Circuit Board:
731 |
734 |
735 | - Guides:
736 |
746 |
747 | - Differences between the original ErgoDox and the Infinity:
748 |
749 | - Full In-switch backlighting
750 | - USB-C replaces TRRS between the two halves
751 | - Each half can be used independently
752 | - Pre-soldered smd components, only switches and LEDs will need to be soldered
753 | - LCD screens on each keyboard half
754 | - Proper costar stabilizer support
755 | - ALPS switch support
756 |
757 |
758 |
759 |
760 | Homepage
761 |
762 |
763 |
764 |
765 |
766 |
767 |
768 |
769 | Gamepad
770 |
771 |
772 | User Profet23 of profetkeyboards.com has made some pcb updates that have been merged into the main pcb repo to allow for left hand only ErgoDox support. This is ideal as a gamepad or other single left-handed usage.
773 |
774 | 
775 |
776 | An example of the a finished build
777 |
778 | 
779 |
780 | The PCB has now has pads that support the installation of an optional reset switch. The Teensy 2.0 is actually installed upside down, the built in reset switch is not accessible. There is also an extra hole for the Teensy to solder a header pin for the reset switch.
781 |
782 | 
783 |
784 | The new “top” of PCB. Teensy is installed upside down. 2.2k resistors, jumpers, and USB port installed on top. In this revision of the PCB, the jumpers dictate which side the USB port can be installed on as well as the TRRS port (which isn’t used in gamepad configuration).
785 | Note: that the USB connection wires are installed (from left to right) empty, black, green, red, white. This is different from the silk screen layout as the usb port is now on "backwards".
786 |
788 |
789 | The new “bottom” of the PCB. The reset switch has been soldered to the bottom. LED resistors have also been soldered to bottom.
790 |
791 |
792 |
793 |
794 |
795 |
796 |
7 |