keychron_qmk_firmware/keyboards/minidox
Dusty Pomerleau 15297bcfce [Keymap] Add Minidox keymap by dustypomerleau (#5101)
* add dusty keymap

* change keymap folder to match my github username

* initial keymap completed in comments only

* layout without NAV completed in comments only

* disable Command to prevent interference with Space Cadet keys

* switch _ and \ in the symbol layer

* Layers complete through _NAV

* add thumb keys to _NAV

* complete _NUM

* all layouts complete; still needs `process_user_record()`

* completed first draft of keymap; still needs config.h to match

* corrected keycodes for Mac macro-volume keys

* fix Mac mute keycode

* add missing Mac keycodes for previous and next track

* placeholder for qwerty layout, not yet completed;

remove unnecessary breaks;

add todos

* eliminate Preonic branch before switching to Minidox branch:

• delete dustypomerleau Preonic keymap folder

• complete keymap.c (QWERTY layer, vanilla numbers layer)

TODO:
• add preferences to config.h
• complete the README

* edit commented keymap diagrams for clarity in dual function keys

* define initial config.h and add rules.mk for mouse key support

* fix redundant line after implementation of tap_code()

* fixed key_timer declaration, added README and rules

* formatting of keymap

* add CTPC to config

* cycle thumb keys to favor center position

* modify config.h for temporary Pro Micro compatibility

* remove superfluous call to use serial; homebrewed mod tap keys are still broken with OSL

* merge _SYS and _MEDIA on new Z_SYS key

* ALT_OP example of new MT macro complete

* initial narze-inspired MT fixes in PRU

* add (currently superfluous) custom keycode for the _SYS layer

* rudimentary `OSL` symbol macros that immediately register the mod and fail to reset the oneshot layer, but do output the proper keys—fix both of these things

* remove permissive hold to improve tapping performance

* remove calls to `clear_oneshot_layer_state()`, as they have no effect inside `process_record_user()`. Tapdance appears to be the way forward.

* final commit before tapdance code; correct layout in comments

* initial tapdance code for shifted mod taps

* add numeric and ergo NUM layers and pinky shifts for keycuts

* add TD() wrappers to tapdance codes and clean up commented layout guides

* add faux return to cur_dance to allow compilation - TODO: research what the default clause should be in cur_dance

* update commented schematics for better readability

* add backspace and delete to lockable layers, Z_SYS -> SYS_Z for consistency, fix schematic errors

* add `DOUBLE_SINGLE_TAP` to tapdance cases to allow doubling of the single tap character without waiting tapping term

* remove reduced oneshot tapping toggles

* update README

* newline tweak :)

* Update keyboards/minidox/keymaps/dustypomerleau/keymap.c

Co-Authored-By: dustypomerleau <dustypomerleau@users.noreply.github.com>

* Update keyboards/minidox/keymaps/dustypomerleau/config.h

Co-Authored-By: dustypomerleau <dustypomerleau@users.noreply.github.com>

* Update keyboards/minidox/keymaps/dustypomerleau/config.h

Co-Authored-By: dustypomerleau <dustypomerleau@users.noreply.github.com>

* Update keyboards/minidox/keymaps/dustypomerleau/config.h

Co-Authored-By: dustypomerleau <dustypomerleau@users.noreply.github.com>

* Update keyboards/minidox/keymaps/dustypomerleau/config.h

Co-Authored-By: dustypomerleau <dustypomerleau@users.noreply.github.com>

* remove `PREVENT_STUCK_MODIFIERS`, as this is default behavior
2019-02-12 16:46:40 -08:00
..
keymaps [Keymap] Add Minidox keymap by dustypomerleau (#5101) 2019-02-12 16:46:40 -08:00
rev1
config.h Adds a default value for IS_COMMAND for COMMAND feature (#4301) 2019-01-26 15:49:45 -08:00
eeprom-lefthand.eep
eeprom-righthand.eep
i2c.c
i2c.h
matrix.c
minidox.c
minidox.h
pro_micro.h
readme.md Modified URLs to point to new locations 2019-01-13 09:11:18 -08:00
rules.mk
serial.c
serial.h
split_util.c
split_util.h

MiniDox

MiniDox

A compact version of the ErgoDox

Keyboard Maintainer: That-Canadian
Hardware Supported: MiniDox PCB rev1 Pro Micro

Make example for this keyboard (after setting up your build environment):

make minidox/rev1:default

See build environment setup then the make instructions for more information.

Build Guide

A build guide for putting together the MiniDox v1 can be found here: MiniDox Build Log / Guide

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 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:"./quantum/split_common/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:"./quantum/split_common/eeprom-righthand.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.