keyboards/handwired/xealous/readme.md

   1 XeaL60
   2 ======
   3
   4 Split keyboard firmware for Arduino Pro Micro or other ATmega32u4
   5 based boards.
   6
   7
   8 ## Build Guide
   9
  10 A build guide for putting together the Xealous can be found here: https://github.com/alex-ong/Split60
  11
  12
  13 ## First Time Setup
  14
  15 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:
  16
  17 ```
  18 $ make handwired/xeal60/rev1:default
  19 ```
  20
  21 You will see a lot of output and if everything worked correctly you will see the built hex file:
  22
  23 ```
  24 handwired_xeal60_rev1_default.hex
  25 ```
  26
  27 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:
  28
  29
  30 ```
  31 $ make handwired/xeal60/rev1:YOUR_KEYMAP_NAME
  32 ```
  33
  34 If everything worked correctly you will see a file:
  35
  36 ```
  37 handwired_xeal60_rev1_YOUR_KEYMAP_NAME.hex
  38 ```
  39
  40 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.
  41
  42
  43 Features
  44 --------
  45
  46 For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md).
  47
  48 Some features supported by the firmware:
  49
  50 * Either half can connect to the computer via USB, or both halves can be used
  51   independently.
  52 * I2C connection between the two halves if for some
  53   reason you require a faster connection between the two halves. Note this
  54   requires an extra wire between halves and pull-up resistors on the data lines.
  55
  56 Required Hardware
  57 -----------------
  58
  59 Apart from diodes and key switches for the keyboard matrix in each half, you
  60 will need:
  61
  62 * 2 Arduino Pro Micros. You can find these on AliExpress for ≈3.50USD each.
  63 * 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable
  64
  65 Alternatively, you can use any sort of cable and socket that has at least 4
  66 wires. You will need a cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
  67
  68 Optional Hardware
  69 -----------------
  70
  71 A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
  72
  73 Wiring
  74 ------
  75
  76 The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e.
  77 PD0 on the ATmega32u4) between the two Pro Micros.
  78
  79 Next, wire your key matrix to any of the remaining 17 IO pins of the pro micro
  80 and modify the `matrix.c` accordingly.
  81
  82 The wiring for serial:
  83
  84 ![serial wiring](https://i.imgur.com/C3D1GAQ.png)
  85
  86
  87 Notes on Software Configuration
  88 -------------------------------
  89
  90 Configuring the firmware is similar to any other QMK project. One thing
  91 to note is that `MATRIX_ROWS` in `config.h` is the total number of rows between
  92 the two halves, i.e. if your split keyboard has 5 rows in each half, then use
  93 `MATRIX_ROWS=10`.
  94
  95 Also, the current implementation assumes a maximum of 8 columns, but it would
  96 not be very difficult to adapt it to support more if required.
  97
  98 Flashing
  99 -------
 100 From the top level `qmk_firmware` directory run `make KEYBOARD:KEYMAP:avrdude` for automatic serial port resolution and flashing.
 101 Example: `make handwired/xeal60/rev1:default:avrdude`
 102
 103
 104 Choosing which board to plug the USB cable into (choosing Master)
 105 --------
 106 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
 107
 108 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.
 109
 110 The EEPROM approach requires additional setup (flashing the eeprom) but allows you to swap the usb cable to either side.
 111
 112 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.
 113
 114 ### Setting the left hand as master
 115 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.
 116
 117 ### Setting the right hand as master
 118 If you always plug the usb cable into the right board, add an extra flag to your `config.h`
 119 ```
 120  #define MASTER_RIGHT
 121 ```
 122
 123 ### Setting EE_hands to use either hands as master
 124 If you define `EE_HANDS` in your `config.h`, you will need to set the
 125 EEPROM for the left and right halves.
 126
 127 The EEPROM is used to store whether the
 128 half is left handed or right handed. This makes it so that the same firmware
 129 file will run on both hands instead of having to flash left and right handed
 130 versions of the firmware to each half. To flash the EEPROM file for the left
 131 half run:
 132 ```
 133 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-lefthand.eep"
 134 // or the equivalent in dfu-programmer
 135
 136 ```
 137 and similarly for right half
 138 ```
 139 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-righthand.eep"
 140 // or the equivalent in dfu-programmer
 141 ```
 142
 143 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
 144
 145 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
 146
 147 Note that you need to program both halves, but you have the option of using
 148 different keymaps for each half. You could program the left half with a QWERTY
 149 layout and the right half with a Colemak layout using bootmagic's default layout option.
 150 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
 151 right half is connected.
 152
 153
 154 Notes on Using Pro Micro 3.3V
 155 -----------------------------
 156
 157 Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
 158 the frequency on the 3.3V board.
 159
 160 Also, if the slave board is producing weird characters in certain columns,
 161 update the following line in `matrix.c` to the following:
 162
 163 ```
 164 // _delay_us(30);  // without this wait read unstable value.
 165 _delay_us(300);  // without this wait read unstable value.
 166 ```