keyboards/handwired/not_so_minidox/readme.md

   1 not_so_minidox
   2 =====
   3
   4 ![not_so_minidox]()
   5
   6 A slightly larger version of the MiniDox
   7
   8 Keyboard Maintainer: mtdjr
   9 Hardware Supported: None yet/ProMicro
  10
  11 Make example for this keyboard (after setting up your build environment):
  12
  13     make not_so_minidox/rev1:default
  14
  15 See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
  16
  17 Flashing
  18 -------
  19 Note: Most of this is copied from the Let's Split readme, because it is awesome
  20
  21 From the root directory run `make PROJECT:KEYMAP:avrdude` for automatic serial port resolution and flashing.
  22 Example: `make not_so_minidox/rev1:default:avrdude`
  23
  24 Choosing which board to plug the USB cable into (choosing Master)
  25 --------
  26 Because the two boards are identical, the firmware has logic to differentiate the left and right board.
  27
  28 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.
  29
  30 The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side.
  31
  32 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.
  33
  34 ### Setting the left hand as master
  35 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.
  36
  37 ### Setting the right hand as master
  38 If you always plug the usb cable into the right board, add an extra flag to your `config.h`
  39 ```
  40  #define MASTER_RIGHT
  41 ```
  42
  43 ### Setting EE_hands to use either hands as master
  44 If you define `EE_HANDS` in your `config.h`, you will need to set the
  45 EEPROM for the left and right halves.
  46
  47 The EEPROM is used to store whether the
  48 half is left handed or right handed. This makes it so that the same firmware
  49 file will run on both hands instead of having to flash left and right handed
  50 versions of the firmware to each half. To flash the EEPROM file for the left
  51 half run:
  52 ```
  53 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-lefthand.eep"
  54 // or the equivalent in dfu-programmer
  55
  56 ```
  57 and similarly for right half
  58 ```
  59 avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-righthand.eep"
  60 // or the equivalent in dfu-programmer
  61 ```
  62
  63 NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`)
  64
  65 After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
  66
  67 Note that you need to program both halves, but you have the option of using
  68 different keymaps for each half. You could program the left half with a QWERTY
  69 layout and the right half with a Colemak layout using bootmagic's default layout option.
  70 Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
  71 right half is connected.