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 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)
  10
  11 There is additional information there about flashing and adding RGB underglow.
  12
  13 ## First Time Setup
  14
  15 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:
  16
  17 ```
  18 $ make serial
  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 nyquist_rev1_serial.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 YOUR_KEYMAP_NAME
  32 ```
  33
  34 If everything worked correctly you will see a file:
  35
  36 ```
  37 nyquist_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](/readme.md##customizing-your-keymap) in the main readme.md.
  41
  42 Features
  43 --------
  44
  45 For the full Quantum Mechanical Keyboard feature list, see [the parent readme.md](/readme.md).
  46
  47 Some features supported by the firmware:
  48
  49 * Either half can connect to the computer via USB, or both halves can be used
  50   independently.
  51 * You only need 3 wires to connect the two halves. Two for VCC and GND and one
  52   for serial communication.
  53 * Optional support for I2C connection between the two halves if for some
  54   reason you require a faster connection between the two halves. Note this
  55   requires an extra wire between halves and pull-up resistors on the data lines.
  56
  57 ### 2u Support
  58 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.
  59
  60 Required Hardware
  61 -----------------
  62
  63 Apart from diodes and key switches for the keyboard matrix in each half, you
  64 will need:
  65
  66 * 2 Arduino Pro Micro's. You can find theses on aliexpress for ≈3.50USD each.
  67 * 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable
  68
  69 Alternatively, you can use any sort of cable and socket that has at least 3
  70 wires. If you want to use I2C to communicate between halves, you will need a
  71 cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
  72
  73 Optional Hardware
  74 -----------------
  75
  76 A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
  77
  78 Wiring
  79 ------
  80
  81 The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e.
  82 PD0 on the ATmega32u4) between the two Pro Micros.
  83
  84 Then wire your key matrix to any of the remaining 17 IO pins of the pro micro
  85 and modify the `matrix.c` accordingly.
  86
  87 The wiring for serial:
  88
  89 ![serial wiring](imgs/split-keyboard-serial-schematic.png)
  90
  91 The wiring for i2c:
  92
  93 ![i2c wiring](imgs/split-keyboard-i2c-schematic.png)
  94
  95 The pull-up resistors may be placed on either half. It is also possible
  96 to use 4 resistors and have the pull-ups in both halves, but this is
  97 unnecessary in simple use cases.
  98
  99 Flashing
 100 -------
 101 From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing.
 102 Example: `make rev1-serial-avrdude`
 103
 104
 105 Choosing which board to plug the USB cable into (choosing Master)
 106 --------
 107 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
 108
 109 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.
 110
 111 The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
 112
 113 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.
 114
 115 ### Setting the left hand as master
 116 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.
 117
 118 ### Setting the right hand as master
 119 If you always plug the usb cable into the right board, add an extra flag to your `config.h`
 120 ```
 121  #define MASTER_RIGHT
 122 ```
 123
 124 ### Setting EE_hands to use either hands as master
 125 If you define `EE_HANDS` in your `config.h`, you will need to set the
 126 EEPROM for the left and right halves.
 127
 128 The EEPROM is used to store whether the
 129 half is left handed or right handed. This makes it so that the same firmware
 130 file will run on both hands instead of having to flash left and right handed
 131 versions of the firmware to each half. To flash the EEPROM file for the left
 132 half run:
 133 ```
 134 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep
 135 // or the equivalent in dfu-programmer
 136
 137 ```
 138 and similarly for right half
 139 ```
 140 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep
 141 // or the equivalent in dfu-programmer
 142 ```
 143
 144 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
 145
 146 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
 147
 148 Note that you need to program both halves, but you have the option of using
 149 different keymaps for each half. You could program the left half with a QWERTY
 150 layout and the right half with a Colemak layout using bootmagic's default layout option.
 151 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
 152 right half is connected.
 153
 154
 155 Notes on Using Pro Micro 3.3V
 156 -----------------------------
 157
 158 Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
 159 the frequency on the 3.3V board.
 160
 161 Also, if the slave board is producing weird characters in certain columns,
 162 update the following line in `matrix.c` to the following:
 163
 164 ```
 165 // _delay_us(30);  // without this wait read unstable value.
 166 _delay_us(300);  // without this wait read unstable value.
 167 ```