keyboards/handwired/dactyl_manuform/5x6/readme.md

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