diff options
author | mtdjr <mtdjr@users.noreply.github.com> | 2018-05-31 11:30:05 -0400 |
---|---|---|
committer | Drashna Jaelre <drashna@live.com> | 2018-05-31 08:30:05 -0700 |
commit | ee9a7aba396160929604aca54a23ad5534d59940 (patch) | |
tree | f4fbbde03ed548a68fd56bec5c6baf8cf217f180 /keyboards/handwired/not_so_minidox/readme.md | |
parent | 21ad968ac14b177a7c97d34106c4d6201912627f (diff) |
add not-so-minidox handwire keyboard (#3061)
* add not-so-minidox handwire keyboard
* corrected keymap
* multiple adjustments to not_so_minidox keyboard
* remove I2C master left define
* update default layer set function
* move solenoid code into userspace
* minor adjustments to config.h
* update keymaps to utilize userspace
* move features and config to userspace, correct build issue
* correct solenoid pin
* adjust defaults for solenoid pin and enable
* default solenoid to on for not_so_minidox
* disable RGBLIGHT_SLEEP for xd75
* tweaking solenoid enable/disable in userspace and keymaps
Diffstat (limited to 'keyboards/handwired/not_so_minidox/readme.md')
-rw-r--r-- | keyboards/handwired/not_so_minidox/readme.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/keyboards/handwired/not_so_minidox/readme.md b/keyboards/handwired/not_so_minidox/readme.md new file mode 100644 index 0000000000..fbfa7b7be0 --- /dev/null +++ b/keyboards/handwired/not_so_minidox/readme.md @@ -0,0 +1,71 @@ +not_so_minidox +===== + +![not_so_minidox]() + +A slightly larger version of the MiniDox + +Keyboard Maintainer: mtdjr +Hardware Supported: None yet/ProMicro + +Make example for this keyboard (after setting up your build environment): + + make not_so_minidox/rev1:default + +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. + +Flashing +------- +Note: Most of this is copied from the Let's Split readme, because it is awesome + +From the root directory run `make PROJECT:KEYMAP:avrdude` for automatic serial port resolution and flashing. +Example: `make not_so_minidox/rev1:default:avrdude` + +Choosing which board to plug the USB cable into (choosing Master) +-------- +Because the two boards are identical, the firmware has logic to differentiate the left and right board. + +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. + +The EEPROM approach requires additional setup (flashing the eeeprom) but allows you to swap the usb cable to either side. + +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. + +### Setting the left hand as master +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. + +### Setting the right hand as master +If you always plug the usb cable into the right board, add an extra flag to your `config.h` +``` + #define MASTER_RIGHT +``` + +### Setting EE_hands to use either hands as master +If you define `EE_HANDS` in your `config.h`, you will need to set the +EEPROM for the left and right halves. + +The EEPROM is used to store whether the +half is left handed or right handed. This makes it so that the same firmware +file will run on both hands instead of having to flash left and right handed +versions of the firmware to each half. To flash the EEPROM file for the left +half run: +``` +avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep +// or the equivalent in dfu-programmer + +``` +and similarly for right half +``` +avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep +// or the equivalent in dfu-programmer +``` + +NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`) + +After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash. + +Note that you need to program both halves, but you have the option of using +different keymaps for each half. You could program the left half with a QWERTY +layout and the right half with a Colemak layout using bootmagic's default layout option. +Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the +right half is connected. |