keyboards/nyquist/readme.md

   1 The Nyquist Keyboard
   2 ====================
   3
   4 The Nyquist is a 60% split ortholinear board by [Keebio](https://keeb.io). It has been designed in a similar manner to the Let's Split v2 by /u/wootpatoot. Each half of the keyboard is arranged in a 5x6 grid. There is an option to use a 2u key with PCB mounted MX stablizers, in place of the two innermost 1u keys on the bottom row.
   5
   6
   7 ## Build Guide
   8
   9 A build log of the Nyquist can be found here: [Nyquist Build Log](http://imgur.com/a/dD4sX).
  10
  11 Since the design is very similar to the Let's Split v2, the build guide for that can be used while the build guide for the Nyquist is being fully developed. A build guide for putting together the Let's Split v2 can be found here: [An Overly Verbose Guide to Building a Let's Split Keyboard](https://github.com/nicinabox/lets-split-guide)
  12
  13 There is additional information there about flashing and adding RGB underglow.
  14
  15 ## First Time Setup
  16
  17 Download or clone the whole firmware and navigate to the keyboards/nyquist directory. Once your development environment is setup, you'll be able to generate the default .hex using:
  18
  19 ```
  20 $ make serial
  21 ```
  22
  23 You will see a lot of output and if everything worked correctly you will see the built hex file:
  24
  25 ```
  26 nyquist_rev1_serial.hex
  27 ```
  28
  29 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:
  30
  31
  32 ```
  33 $ make YOUR_KEYMAP_NAME
  34 ```
  35
  36 If everything worked correctly you will see a file:
  37
  38 ```
  39 nyquist_rev1_YOUR_KEYMAP_NAME.hex
  40 ```
  41
  42 For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md.
  43
  44 Features
  45 --------
  46
  47 For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md).
  48
  49 Some features supported by the firmware:
  50
  51 * Either half can connect to the computer via USB, or both halves can be used
  52   independently.
  53 * You only need 3 wires to connect the two halves. Two for VCC and GND and one
  54   for serial communication.
  55 * Optional support for I2C connection between the two halves if for some
  56   reason you require a faster connection between the two halves. Note this
  57   requires an extra wire between halves and pull-up resistors on the data lines.
  58
  59 ### 2u Support
  60 In place of the two innermost 1u keys on the bottom row, a single 2u key can be used. If you choose to use this option, then in your keymap, set the innermost key on the bottom row to what you want the 2u key to be. For example, if using the 2u key on the left half of the board, set the keycode for the lower right key.
  61
  62 Required Hardware
  63 -----------------
  64
  65 Apart from diodes and key switches for the keyboard matrix in each half, you
  66 will need:
  67
  68 * 2 Arduino Pro Micro's. You can find theses on aliexpress for ≈3.50USD each.
  69 * 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable
  70
  71 Alternatively, you can use any sort of cable and socket that has at least 3
  72 wires. If you want to use I2C to communicate between halves, you will need a
  73 cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
  74
  75 Optional Hardware
  76 -----------------
  77
  78 A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
  79
  80 Wiring
  81 ------
  82
  83 The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e.
  84 PD0 on the ATmega32u4) between the two Pro Micros.
  85
  86 Then wire your key matrix to any of the remaining 17 IO pins of the pro micro
  87 and modify the `matrix.c` accordingly.
  88
  89 The wiring for serial:
  90
  91 ![serial wiring](http://imgur.com/BnCGU1Y)
  92
  93 The wiring for i2c:
  94
  95 ![i2c wiring](http://imgur.com/5eiArDA)
  96
  97 The pull-up resistors may be placed on either half. It is also possible
  98 to use 4 resistors and have the pull-ups in both halves, but this is
  99 unnecessary in simple use cases.
 100
 101 Flashing
 102 -------
 103 From the `nyquist` directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
 104 Example: `make rev1-serial-avrdude`
 105
 106
 107 Choosing which board to plug the USB cable into (choosing Master)
 108 --------
 109 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
 110
 111 It uses two strategies to figure things out: look at the EEPROM (memory on the chip) or looks if the current board has the usb cable.
 112
 113 The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
 114
 115 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.
 116
 117 ### Setting the left hand as master
 118 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.
 119
 120 ### Setting the right hand as master
 121 If you always plug the usb cable into the right board, add an extra flag to your `config.h`
 122 ```
 123  #define MASTER_RIGHT
 124 ```
 125
 126 ### Setting EE_hands to use either hands as master
 127 If you define `EE_HANDS` in your `config.h`, you will need to set the
 128 EEPROM for the left and right halves.
 129
 130 The EEPROM is used to store whether the
 131 half is left handed or right handed. This makes it so that the same firmware
 132 file will run on both hands instead of having to flash left and right handed
 133 versions of the firmware to each half. To flash the EEPROM file for the left
 134 half run:
 135 ```
 136 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
 137 // or the equivalent in dfu-programmer
 138
 139 ```
 140 and similarly for right half
 141 ```
 142 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
 143 // or the equivalent in dfu-programmer
 144 ```
 145
 146 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
 147
 148 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
 149
 150 Note that you need to program both halves, but you have the option of using
 151 different keymaps for each half. You could program the left half with a QWERTY
 152 layout and the right half with a Colemak layout using bootmagic's default layout option.
 153 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
 154 right half is connected.
 155
 156
 157 Notes on Using Pro Micro 3.3V
 158 -----------------------------
 159
 160 Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
 161 the frequency on the 3.3V board.
 162
 163 Also, if the slave board is producing weird characters in certain columns,
 164 update the following line in `matrix.c` to the following:
 165
 166 ```
 167 // _delay_us(30);  // without this wait read unstable value.
 168 _delay_us(300);  // without this wait read unstable value.
 169 ```