keyboards/handwired/dactyl_manuform/readme.md

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