keyboards/handwired/dactyl_manuform/readme.md

   1 Dactyl Manuform
   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 ```
  12 $ make dactyl_manuform:dvorak
  13 ```
  14
  15 You will see a lot of output and if everything worked correctly you will see the built hex file:
  16
  17 ```
  18 dactyl_manuform_dvorak.hex
  19 ```
  20
  21 If you would like to use one of the alternative keymaps, or create your own, copy one of the existing [keymaps](keymaps/) and run make like so:
  22
  23 ```
  24 $ make dactyl_manuform:YOUR_KEYMAP_NAME
  25 ```
  26
  27 If everything worked correctly you will see a file:
  28
  29 ```
  30 dactyl_manuform_YOUR_KEYMAP_NAME.hex
  31 ```
  32
  33 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.
  34
  35 ## Keymaps
  36 Currently there are only two keymaps: Qwerty and Dvorak, feel free to make changes and contribute your keymap.
  37 ### Qwerty and Dvorak
  38 Qwerty base layer:
  39 ![Imgur](https://i.imgur.com/Yb5e7dS.png)
  40 Dvorak base layer:
  41 ![Imgur](https://i.imgur.com/CpuZptB.png)
  42 Both keymaps have the same Raise and Lower layers:
  43 Raise Layer
  44 ![Imgur](https://i.imgur.com/nOqePK5.png)
  45 Lower Layer
  46 ![Imgur](https://i.imgur.com/WSshkYc.png)
  47
  48 Required Hardware
  49 -----------------
  50
  51 Apart from diodes and key switches for the keyboard matrix in each half, you
  52 will need:
  53
  54 * 2 Arduino Pro Micros. You can find these on AliExpress for ≈3.50USD each.
  55 * 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable
  56
  57 Alternatively, you can use any sort of cable and socket that has at least 3
  58 wires. If you want to use I2C to communicate between halves, you will need a
  59 cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
  60
  61 Optional Hardware
  62 -----------------
  63 A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
  64
  65 Wiring
  66 ------
  67
  68 The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e.
  69 PD0 on the ATmega32u4) between the two Pro Micros.
  70
  71 Next, wire your key matrix to any of the remaining 17 IO pins of the pro micro
  72 and modify the `matrix.c` accordingly.
  73
  74 The wiring for serial:
  75
  76 ![serial wiring](https://i.imgur.com/C3D1GAQ.png)
  77
  78 The wiring for i2c:
  79
  80 ![i2c wiring](https://i.imgur.com/Hbzhc6E.png)
  81
  82 The pull-up resistors may be placed on either half. It is also possible
  83 to use 4 resistors and have the pull-ups in both halves, but this is
  84 unnecessary in simple use cases.
  85
  86 You can change your configuration between serial and i2c by modifying your `config.h` file.
  87
  88 Notes on Software Configuration
  89 -------------------------------
  90
  91 the keymaps in here are for the 4x5 layout of the keyboard only.
  92
  93 Flashing
  94 -------
  95 From the top level `qmk_firmware` directory run `make KEYBOARD:KEYMAP:avrdude` for automatic serial port resolution and flashing.
  96 Example: `make lets_split/rev2:default:avrdude`
  97
  98
  99 Choosing which board to plug the USB cable into (choosing Master)
 100 --------
 101 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
 102
 103 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.
 104
 105 The EEPROM approach requires additional setup (flashing the eeprom) but allows you to swap the usb cable to either side.
 106
 107 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.
 108
 109 ### Setting the left hand as master
 110 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.
 111
 112 ### Setting the right hand as master
 113 If you always plug the usb cable into the right board, add an extra flag to your `config.h`
 114 ```
 115  #define MASTER_RIGHT
 116 ```
 117
 118 ### Setting EE_hands to use either hands as master
 119 If you define `EE_HANDS` in your `config.h`, you will need to set the
 120 EEPROM for the left and right halves.
 121
 122 The EEPROM is used to store whether the
 123 half is left handed or right handed. This makes it so that the same firmware
 124 file will run on both hands instead of having to flash left and right handed
 125 versions of the firmware to each half. To flash the EEPROM file for the left
 126 half run:
 127 ```
 128 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
 129 // or the equivalent in dfu-programmer
 130
 131 ```
 132 and similarly for right half
 133 ```
 134 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
 135 // or the equivalent in dfu-programmer
 136 ```
 137
 138 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
 139
 140 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
 141
 142 Note that you need to program both halves, but you have the option of using
 143 different keymaps for each half. You could program the left half with a QWERTY
 144 layout and the right half with a Colemak layout using bootmagic's default layout option.
 145 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
 146 right half is connected.
 147
 148
 149 Notes on Using Pro Micro 3.3V
 150 -----------------------------
 151
 152 Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
 153 the frequency on the 3.3V board.
 154
 155 Also, if the slave board is producing weird characters in certain columns,
 156 update the following line in `matrix.c` to the following:
 157
 158 ```
 159 // _delay_us(30);  // without this wait read unstable value.
 160 _delay_us(300);  // without this wait read unstable value.
 161 ```