diff options
Diffstat (limited to 'keyboards/minidox/readme.md')
| -rw-r--r-- | keyboards/minidox/readme.md | 64 |
1 files changed, 62 insertions, 2 deletions
diff --git a/keyboards/minidox/readme.md b/keyboards/minidox/readme.md index f6227386d..da8971486 100644 --- a/keyboards/minidox/readme.md +++ b/keyboards/minidox/readme.md | |||
| @@ -1,5 +1,5 @@ | |||
| 1 | ECO | 1 | MiniDox |
| 2 | === | 2 | ===== |
| 3 | 3 | ||
| 4 |  | 4 |  |
| 5 | 5 | ||
| @@ -13,3 +13,63 @@ Make example for this keyboard (after setting up your build environment): | |||
| 13 | make minidox-rev1-default | 13 | make minidox-rev1-default |
| 14 | 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. | 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 | ## Build Guide | ||
| 18 | |||
| 19 | A build guide for putting together the MiniDox v1 can be found here: [MiniDox Build Log / Guide](http://imgur.com/a/vImo6) | ||
| 20 | |||
| 21 | Flashing | ||
| 22 | ------- | ||
| 23 | Note: Most of this is copied from the Let's Split readme, because it is awesome | ||
| 24 | |||
| 25 | From the keymap directory run `make SUBPROJECT-KEYMAP-avrdude` for automatic serial port resolution and flashing. | ||
| 26 | Example: `make rev1-default-avrdude` | ||
| 27 | |||
| 28 | Choosing which board to plug the USB cable into (choosing Master) | ||
| 29 | -------- | ||
| 30 | Because the two boards are identical, the firmware has logic to differentiate the left and right board. | ||
| 31 | |||
| 32 | 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. | ||
| 33 | |||
| 34 | The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side. | ||
| 35 | |||
| 36 | 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. | ||
| 37 | |||
| 38 | ### Setting the left hand as master | ||
| 39 | 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. | ||
| 40 | |||
| 41 | ### Setting the right hand as master | ||
| 42 | If you always plug the usb cable into the right board, add an extra flag to your `config.h` | ||
| 43 | ``` | ||
| 44 | #define MASTER_RIGHT | ||
| 45 | ``` | ||
| 46 | |||
| 47 | ### Setting EE_hands to use either hands as master | ||
| 48 | If you define `EE_HANDS` in your `config.h`, you will need to set the | ||
| 49 | EEPROM for the left and right halves. | ||
| 50 | |||
| 51 | The EEPROM is used to store whether the | ||
| 52 | half is left handed or right handed. This makes it so that the same firmware | ||
| 53 | file will run on both hands instead of having to flash left and right handed | ||
| 54 | versions of the firmware to each half. To flash the EEPROM file for the left | ||
| 55 | half run: | ||
| 56 | ``` | ||
| 57 | avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep | ||
| 58 | // or the equivalent in dfu-programmer | ||
| 59 | |||
| 60 | ``` | ||
| 61 | and similarly for right half | ||
| 62 | ``` | ||
| 63 | avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep | ||
| 64 | // or the equivalent in dfu-programmer | ||
| 65 | ``` | ||
| 66 | |||
| 67 | NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`) | ||
| 68 | |||
| 69 | After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash. | ||
| 70 | |||
| 71 | Note that you need to program both halves, but you have the option of using | ||
| 72 | different keymaps for each half. You could program the left half with a QWERTY | ||
| 73 | layout and the right half with a Colemak layout using bootmagic's default layout option. | ||
| 74 | Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the | ||
| 75 | right half is connected. | ||
