keyboards/handwired/dactyl_manuform/readme.md

   1 Dactyl Manuform (4x5, 5x6, 6x6)
   2 ======
   3 the [Dactyl-Manuform](https://github.com/tshort/dactyl-keyboard) is a split curved keyboard based on the design of [adereth dactyl](https://github.com/adereth/dactyl-keyboard) and thumb cluster design of the [manuform](https://geekhack.org/index.php?topic=46015.0) keyboard, the hardware is similar to the let's split keyboard. all information needed for making one is in the first link.
   4 ![Imgur](https://i.imgur.com/7y0Vbyd.jpg)
   5
   6
   7 ## First Time Setup
   8 -----------------
   9 Download or clone the `qmk_firmware` repo and navigate to its top level directory. Once your build environment is setup, you'll be able to generate the default .hex using:
  10
  11 Depending on your Layout chose one of the follwing commands:
  12
  13 ```
  14 $ make handwired/dactyl_manuform/YOUR_LAYOUT:YOUR_KEYMAP_NAME
  15 ```
  16
  17 example:
  18 ```
  19 $ make handwired/dactyl_manuform/4x5:default
  20 ```
  21
  22 If everything worked correctly you will see a file:
  23
  24 ```
  25 dactyl_manuform_YOUR_LAYOUT_YOUR_KEYMAP_NAME.hex
  26 ```
  27
  28 For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/docs/faq_keymap.md) in the main readme.md.
  29
  30
  31 ## Keymaps
  32 -----------------
  33 ### [Keymaps 4x5](/keyboards/handwired/dactyl_manuform/4x5/keymaps/)
  34
  35 #### Default
  36 Simple QWERTY layout with 3 Layers.
  37 #### Dvorak
  38
  39 ### [Keymaps 5x6](/keyboards/handwired/dactyl_manuform/5x6/keymaps/)
  40
  41 #### Default
  42 Just a copy of the Impstyle keymap. Feel free to adjust it.
  43
  44 #### Impstyle
  45 A simple QWERTY keymap with 3 Layers. Both sides are connected via serial and the Left ist the master.
  46
  47 ### [Keymaps 6x6](/keyboards/handwired/dactyl_manuform/6x6/keymaps/)
  48
  49 #### Default
  50 Simple QWERTY layout with 3 Layers.
  51
  52 ##Required Hardware
  53 -----------------
  54
  55 Apart from diodes and key switches for the keyboard matrix in each half, you
  56 will need:
  57
  58 * 2 Arduino Pro Micros. You can find these on AliExpress for ≈3.50USD each.
  59 * 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable
  60
  61 Alternatively, you can use any sort of cable and socket that has at least 3
  62 wires. If you want to use I2C to communicate between halves, you will need a
  63 cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
  64
  65 ##Optional Hardware
  66 -----------------
  67 A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
  68
  69 ##Wiring
  70 ------
  71
  72 The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e.
  73 PD0 on the ATmega32u4) between the two Pro Micros.
  74
  75 Next, wire your key matrix to any of the remaining 17 IO pins of the pro micro
  76 and modify the `matrix.c` accordingly.
  77
  78 The wiring for serial:
  79
  80 ![serial wiring](https://i.imgur.com/C3D1GAQ.png)
  81
  82 The wiring for i2c:
  83
  84 ![i2c wiring](https://i.imgur.com/Hbzhc6E.png)
  85
  86 The pull-up resistors may be placed on either half. It is also possible
  87 to use 4 resistors and have the pull-ups in both halves, but this is
  88 unnecessary in simple use cases.
  89
  90 You can change your configuration between serial and i2c by modifying your `config.h` file.
  91
  92 ##Notes on Software Configuration
  93 -------------------------------
  94
  95 the keymaps in here are for the 4x5 layout of the keyboard only.
  96
  97 ##Flashing
  98 -------
  99
 100 To flash your firmware take a look at: [Flashing Instructions and Bootloader Information](https://docs.qmk.fm/#/flashing)
 101
 102
 103 ##Choosing which board to plug the USB cable into (choosing Master)
 104 --------
 105 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
 106
 107 It uses two strategies to figure things out: looking at the EEPROM (memory on the chip) or looking if the current board has the usb cable.
 108
 109 The EEPROM approach requires additional setup (flashing the eeprom) but allows you to swap the usb cable to either side.
 110
 111 The USB cable approach is easier to setup and if you just want the usb cable on the left board, you do not need to do anything extra.
 112
 113 ### Setting the left hand as master
 114 If you always plug the usb cable into the left board, nothing extra is needed as this is the default. Comment out `EE_HANDS` and comment out `I2C_MASTER_RIGHT` or `MASTER_RIGHT` if for some reason it was set.
 115
 116 ### Setting the right hand as master
 117 If you always plug the usb cable into the right board, add an extra flag to your `config.h`
 118 ```
 119  #define MASTER_RIGHT
 120 ```
 121
 122 ### Setting EE_hands to use either hands as master
 123 If you define `EE_HANDS` in your `config.h`, you will need to set the
 124 EEPROM for the left and right halves.
 125
 126 The EEPROM is used to store whether the
 127 half is left handed or right handed. This makes it so that the same firmware
 128 file will run on both hands instead of having to flash left and right handed
 129 versions of the firmware to each half. To flash the EEPROM file for the left
 130 half run:
 131 ```
 132 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
 133 // or the equivalent in dfu-programmer
 134
 135 ```
 136 and similarly for right half
 137 ```
 138 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
 139 // or the equivalent in dfu-programmer
 140 ```
 141
 142 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
 143
 144 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
 145
 146 Note that you need to program both halves, but you have the option of using
 147 different keymaps for each half. You could program the left half with a QWERTY
 148 layout and the right half with a Colemak layout using bootmagic's default layout option.
 149 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
 150 right half is connected.
 151
 152
 153 Notes on Using Pro Micro 3.3V
 154 -----------------------------
 155
 156 Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
 157 the frequency on the 3.3V board.
 158
 159 Also, if the slave board is producing weird characters in certain columns,
 160 update the following line in `matrix.c` to the following:
 161
 162 ```
 163 // _delay_us(30);  // without this wait read unstable value.
 164 _delay_us(300);  // without this wait read unstable value.
 165 ```