aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--.travis.yml2
-rw-r--r--Dockerfile3
-rw-r--r--Makefile40
-rw-r--r--doc/BUILD_GUIDE.md4
-rwxr-xr-xdoc/CYGWIN_GUIDE.md2
-rw-r--r--doc/HAND_WIRE.md6
-rw-r--r--doc/PCB_GUIDE.md6
-rw-r--r--keyboards/atreus/readme.md2
-rw-r--r--keyboards/ergodox/keymaps/ab/readme.md2
-rw-r--r--keyboards/ergodox/keymaps/albert/Makefile5
-rw-r--r--keyboards/ergodox/keymaps/albert/config.h12
-rw-r--r--keyboards/ergodox/keymaps/albert/keymap.c661
-rw-r--r--keyboards/ergodox/keymaps/albert/readme.md188
-rw-r--r--keyboards/ergodox/keymaps/algernon/readme.md4
-rw-r--r--keyboards/ergodox/keymaps/deadcyclo/Makefile1
-rw-r--r--keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-base-layout.pngbin79741 -> 79488 bytes
-rw-r--r--keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-1-symbols.pngbin55349 -> 79904 bytes
-rw-r--r--keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-2-media-and-mouse.pngbin50926 -> 62258 bytes
-rw-r--r--keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-3-navigation.pngbin43551 -> 58886 bytes
-rw-r--r--keyboards/ergodox/keymaps/deadcyclo/keymap.c426
-rw-r--r--keyboards/ergodox/keymaps/deadcyclo/readme.md60
-rw-r--r--keyboards/ergodox/keymaps/german-kinergo/readme.md2
-rw-r--r--keyboards/ergodox/keymaps/mclennon_osx/README.md2
-rw-r--r--keyboards/ergodox/keymaps/pvinis/Readme.md2
-rw-r--r--keyboards/ergodox/keymaps/software_neo2/keymap.c64
-rw-r--r--keyboards/ergodox/keymaps/supercoder/readme.md2
-rw-r--r--keyboards/ergodox/keymaps/win10_writers-block/readme.md2
-rw-r--r--keyboards/ergodox/readme.md2
-rw-r--r--keyboards/hhkb/readme.md2
-rw-r--r--keyboards/infinity60/infinity60.c15
-rw-r--r--keyboards/infinity60/keymaps/default/keymap.c9
-rwxr-xr-xkeyboards/infinity60/keymaps/depariel/keymap.c9
-rw-r--r--keyboards/infinity60/keymaps/hasu/keymap.c10
-rw-r--r--keyboards/infinity60/matrix.c3
-rw-r--r--keyboards/planck/keymaps/default/keymap.c17
-rw-r--r--keyboards/preonic/keymaps/default/keymap.c15
-rw-r--r--keyboards/preonic/keymaps/smt/Makefile3
-rw-r--r--keyboards/preonic/keymaps/smt/keymap.c247
-rw-r--r--keyboards/preonic/keymaps/smt/readme.md85
-rw-r--r--keyboards/s60-x/readme.md2
-rw-r--r--quantum/keymap_extras/keymap_br_abnt2.h16
-rw-r--r--quantum/process_keycode/process_tap_dance.c7
-rw-r--r--quantum/process_keycode/process_tap_dance.h1
-rw-r--r--quantum/visualizer/visualizer.c58
-rw-r--r--quantum/visualizer/visualizer.h9
-rw-r--r--readme.md6
-rw-r--r--tmk_core/common/keyboard.c2
-rw-r--r--util/travis_compiled_push.sh63
48 files changed, 1865 insertions, 214 deletions
diff --git a/.travis.yml b/.travis.yml
index b206d1451..1a0a7bf15 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -19,7 +19,7 @@ install:
19before_script: 19before_script:
20 - avr-gcc --version 20 - avr-gcc --version
21script: 21script:
22- make $TARGET AUTOGEN=$AUTOGEN 22- 'if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip build]"* ]] ; then make $TARGET AUTOGEN=$AUTOGEN; fi'
23addons: 23addons:
24 apt: 24 apt:
25 packages: 25 packages:
diff --git a/Dockerfile b/Dockerfile
index c42bbeb32..744ded857 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -25,4 +25,5 @@ ENV subproject=ez
25ENV keymap=default 25ENV keymap=default
26 26
27VOLUME /qmk 27VOLUME /qmk
28WORKDIR /qmk \ No newline at end of file 28WORKDIR /qmk
29CMD make clean ; make keyboard=${keyboard} subproject=${subproject} keymap=${keymap}
diff --git a/Makefile b/Makefile
index 9cc77c55c..9d9c9629d 100644
--- a/Makefile
+++ b/Makefile
@@ -16,10 +16,10 @@ ifdef SILENT
16endif 16endif
17 17
18# We need to make sure that silent is always turned off at the top level 18# We need to make sure that silent is always turned off at the top level
19# Otherwise the [OK], [ERROR] and [WARN] messags won't be displayed correctly 19# Otherwise the [OK], [ERROR] and [WARN] messages won't be displayed correctly
20override SILENT := false 20override SILENT := false
21 21
22ON_ERROR := error_occured=1 22ON_ERROR := error_occurred=1
23 23
24STARTING_MAKEFILE := $(firstword $(MAKEFILE_LIST)) 24STARTING_MAKEFILE := $(firstword $(MAKEFILE_LIST))
25ROOT_MAKEFILE := $(lastword $(MAKEFILE_LIST)) 25ROOT_MAKEFILE := $(lastword $(MAKEFILE_LIST))
@@ -34,13 +34,13 @@ ABS_ROOT_DIR := $(dir $(ABS_ROOT_MAKEFILE))
34STARTING_DIR := $(subst $(ABS_ROOT_DIR),,$(ABS_STARTING_DIR)) 34STARTING_DIR := $(subst $(ABS_ROOT_DIR),,$(ABS_STARTING_DIR))
35BUILD_DIR := $(ROOT_DIR)/.build 35BUILD_DIR := $(ROOT_DIR)/.build
36TEST_DIR := $(BUILD_DIR)/test 36TEST_DIR := $(BUILD_DIR)/test
37ERROR_FILE := $(BUILD_DIR)/error_occured 37ERROR_FILE := $(BUILD_DIR)/error_occurred
38 38
39MAKEFILE_INCLUDED=yes 39MAKEFILE_INCLUDED=yes
40 40
41# Helper function to process the newt element of a space separated path 41# Helper function to process the newt element of a space separated path
42# It works a bit like the traditional functional head tail 42# It works a bit like the traditional functional head tail
43# so the CURRENT_PATH_ELEMENT will beome the new head 43# so the CURRENT_PATH_ELEMENT will become the new head
44# and the PATH_ELEMENTS are the rest that are still unprocessed 44# and the PATH_ELEMENTS are the rest that are still unprocessed
45define NEXT_PATH_ELEMENT 45define NEXT_PATH_ELEMENT
46 $$(eval CURRENT_PATH_ELEMENT := $$(firstword $$(PATH_ELEMENTS))) 46 $$(eval CURRENT_PATH_ELEMENT := $$(firstword $$(PATH_ELEMENTS)))
@@ -84,7 +84,7 @@ endif
84# Only consider folders with makefiles, to prevent errors in case there are extra folders 84# Only consider folders with makefiles, to prevent errors in case there are extra folders
85KEYBOARDS := $(notdir $(patsubst %/Makefile,%,$(wildcard $(ROOT_DIR)/keyboards/*/Makefile))) 85KEYBOARDS := $(notdir $(patsubst %/Makefile,%,$(wildcard $(ROOT_DIR)/keyboards/*/Makefile)))
86 86
87#Compability with the old make variables, anything you specify directly on the command line 87#Compatibility with the old make variables, anything you specify directly on the command line
88# always overrides the detected folders 88# always overrides the detected folders
89ifdef keyboard 89ifdef keyboard
90 KEYBOARD := $(keyboard) 90 KEYBOARD := $(keyboard)
@@ -106,7 +106,7 @@ endif
106#$(info Keyboards: $(KEYBOARDS)) 106#$(info Keyboards: $(KEYBOARDS))
107 107
108 108
109# Set the default goal depening on where we are running make from 109# Set the default goal depending on where we are running make from
110# this handles the case where you run make without any arguments 110# this handles the case where you run make without any arguments
111.DEFAULT_GOAL := all 111.DEFAULT_GOAL := all
112ifneq ($(KEYMAP),) 112ifneq ($(KEYMAP),)
@@ -170,7 +170,7 @@ define TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
170endef 170endef
171 171
172# A recursive helper function for finding the longest match 172# A recursive helper function for finding the longest match
173# $1 The list to be checed 173# $1 The list to be checked
174# It works by always removing the currently matched item from the list 174# It works by always removing the currently matched item from the list
175# and call itself recursively, until a match is found 175# and call itself recursively, until a match is found
176define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2 176define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
@@ -180,7 +180,7 @@ define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
180 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$1)) 180 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$1))
181 # If a match is found in the current list, otherwise just return what we had before 181 # If a match is found in the current list, otherwise just return what we had before
182 ifeq ($$(RULE_FOUND),true) 182 ifeq ($$(RULE_FOUND),true)
183 # Save the best match so far and call itself recursivel 183 # Save the best match so far and call itself recursively
184 BEST_MATCH := $$(MATCHED_ITEM) 184 BEST_MATCH := $$(MATCHED_ITEM)
185 BEST_MATCH_RULE := $$(RULE) 185 BEST_MATCH_RULE := $$(RULE)
186 RULE_FOUND := false 186 RULE_FOUND := false
@@ -337,7 +337,7 @@ define PARSE_SUBPROJECT
337 $$(eval $$(call PARSE_ALL_KEYMAPS)) 337 $$(eval $$(call PARSE_ALL_KEYMAPS))
338 endif 338 endif
339 else 339 else
340 # As earlier mentione,d when allsb is specified, we call our self recursively 340 # As earlier mentioned when allsb is specified, we call our self recursively
341 # for all of the subprojects 341 # for all of the subprojects
342 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$(SUBPROJECTS))) 342 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$(SUBPROJECTS)))
343 endif 343 endif
@@ -403,11 +403,11 @@ define BUILD
403 printf "$$(MAKE_MSG)\n\n"; \ 403 printf "$$(MAKE_MSG)\n\n"; \
404 $$(MAKE_CMD) $$(MAKE_VARS) SILENT=false; \ 404 $$(MAKE_CMD) $$(MAKE_VARS) SILENT=false; \
405 if [ $$$$? -gt 0 ]; \ 405 if [ $$$$? -gt 0 ]; \
406 then error_occured=1; \ 406 then error_occurred=1; \
407 fi; 407 fi;
408endef 408endef
409 409
410# Just parse all the keymaps for a specifc keyboard 410# Just parse all the keymaps for a specific keyboard
411define PARSE_ALL_KEYMAPS 411define PARSE_ALL_KEYMAPS
412 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYMAP,$$(KEYMAPS))) 412 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYMAP,$$(KEYMAPS)))
413endef 413endef
@@ -428,7 +428,7 @@ define BUILD_TEST
428 printf "$$(TEST_MSG)\n"; \ 428 printf "$$(TEST_MSG)\n"; \
429 $$(TEST_EXECUTABLE); \ 429 $$(TEST_EXECUTABLE); \
430 if [ $$$$? -gt 0 ]; \ 430 if [ $$$$? -gt 0 ]; \
431 then error_occured=1; \ 431 then error_occurred=1; \
432 fi; \ 432 fi; \
433 printf "\n"; 433 printf "\n";
434 endif 434 endif
@@ -448,7 +448,7 @@ endef
448 448
449 449
450# Set the silent mode depending on if we are trying to compile multiple keyboards or not 450# Set the silent mode depending on if we are trying to compile multiple keyboards or not
451# By default it's on in that case, but it can be overriden by specifying silent=false 451# By default it's on in that case, but it can be overridden by specifying silent=false
452# from the command line 452# from the command line
453define SET_SILENT_MODE 453define SET_SILENT_MODE
454 ifdef SUB_IS_SILENT 454 ifdef SUB_IS_SILENT
@@ -465,16 +465,16 @@ include $(ROOT_DIR)/message.mk
465# The empty line is important here, as it will force a new shell to be created for each command 465# The empty line is important here, as it will force a new shell to be created for each command
466# Otherwise the command line will become too long with a lot of keyboards and keymaps 466# Otherwise the command line will become too long with a lot of keyboards and keymaps
467define RUN_COMMAND 467define RUN_COMMAND
468+error_occured=0;\ 468+error_occurred=0;\
469$(COMMAND_$(SILENT_MODE)_$(COMMAND))\ 469$(COMMAND_$(SILENT_MODE)_$(COMMAND))\
470if [ $$error_occured -gt 0 ]; then echo $$error_occured > $(ERROR_FILE); fi; 470if [ $$error_occurred -gt 0 ]; then echo $$error_occurred > $(ERROR_FILE); fi;
471 471
472 472
473endef 473endef
474define RUN_TEST 474define RUN_TEST
475+error_occured=0;\ 475+error_occurred=0;\
476$($(TEST)_COMMAND)\ 476$($(TEST)_COMMAND)\
477if [ $$error_occured -gt 0 ]; then echo $$error_occured > $(ERROR_FILE); fi; 477if [ $$error_occurred -gt 0 ]; then echo $$error_occurred > $(ERROR_FILE); fi;
478 478
479endef 479endef
480 480
@@ -487,7 +487,7 @@ $(SUBPROJECTS): %: %-allkm
487.PHONY: % 487.PHONY: %
488%: 488%:
489 # Check if we have the CMP tool installed 489 # Check if we have the CMP tool installed
490 cmp --version >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi; 490 cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
491 # Check if the submodules are dirty, and display a warning if they are 491 # Check if the submodules are dirty, and display a warning if they are
492ifndef SKIP_GIT 492ifndef SKIP_GIT
493 git submodule status --recursive 2>/dev/null | \ 493 git submodule status --recursive 2>/dev/null | \
@@ -514,7 +514,7 @@ endif
514.PHONY: all 514.PHONY: all
515all: all-keyboards test-all 515all: all-keyboards test-all
516 516
517# Define some shortcuts, mostly for compability with the old syntax 517# Define some shortcuts, mostly for compatibility with the old syntax
518.PHONY: all-keyboards 518.PHONY: all-keyboards
519all-keyboards: allkb-allsp-allkm 519all-keyboards: allkb-allsp-allkm
520 520
@@ -537,4 +537,4 @@ BUILD_DATE := $(shell date +"%Y-%m-%d-%H:%M:%S")
537$(shell echo '#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR)/quantum/version.h) 537$(shell echo '#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR)/quantum/version.h)
538$(shell echo '#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR)/quantum/version.h) 538$(shell echo '#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR)/quantum/version.h)
539 539
540include $(ROOT_DIR)/testlist.mk \ No newline at end of file 540include $(ROOT_DIR)/testlist.mk
diff --git a/doc/BUILD_GUIDE.md b/doc/BUILD_GUIDE.md
index 70a4e10fa..175019183 100644
--- a/doc/BUILD_GUIDE.md
+++ b/doc/BUILD_GUIDE.md
@@ -6,7 +6,7 @@
61. If you have ever installed WinAVR, uninstall it. 61. If you have ever installed WinAVR, uninstall it.
72. Install [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**. 72. Install [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**.
83. Install [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). During installation, uncheck the option to install a graphical user interface. **DO NOT change the default installation folder.** The scripts depend on the default location. 83. Install [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). During installation, uncheck the option to install a graphical user interface. **DO NOT change the default installation folder.** The scripts depend on the default location.
94. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/jackhumbert/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer. 94. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/qmk/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer.
105. Double-click on the 1-setup-path-win batch script to run it. You'll need to accept a User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up. 105. Double-click on the 1-setup-path-win batch script to run it. You'll need to accept a User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up.
116. Right-click on the 2-setup-environment-win batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete! 116. Right-click on the 2-setup-environment-win batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete!
127. Future build commands should be run from the standard Windows command prompt, which you can find by searching for "command prompt" from the start menu or start screen. Ignore the "MHV AVR Shell". 127. Future build commands should be run from the standard Windows command prompt, which you can find by searching for "command prompt" from the start menu or start screen. Ignore the "MHV AVR Shell".
@@ -38,7 +38,7 @@ Debian/Ubuntu example:
38If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [VAGRANT_GUIDE file](VAGRANT_GUIDE.md). 38If you have any problems building the firmware, you can try using a tool called Vagrant. It will set up a virtual computer with a known configuration that's ready-to-go for firmware building. OLKB does NOT host the files for this virtual computer. Details on how to set up Vagrant are in the [VAGRANT_GUIDE file](VAGRANT_GUIDE.md).
39 39
40## Verify Your Installation 40## Verify Your Installation
411. If you haven't already, obtain this repository ([https://github.com/jackhumbert/qmk_firmware](https://github.com/jackhumbert/qmk_firmware)). You can either download it as a zip file and extract it, or clone it using the command line tool git or the Github Desktop application. 411. If you haven't already, obtain this repository ([https://github.com/qmk/qmk_firmware](https://github.com/qmk/qmk_firmware)). You can either download it as a zip file and extract it, or clone it using the command line tool git or the Github Desktop application.
422. Open up a terminal or command prompt and navigate to the `qmk_firmware` folder using the `cd` command. The command prompt will typically open to your home directory. If, for example, you cloned the repository to your Documents folder, then you would type `cd Documents/qmk_firmware`. If you extracted the file from a zip, then it may be named `qmk_firmware-master` instead. 422. Open up a terminal or command prompt and navigate to the `qmk_firmware` folder using the `cd` command. The command prompt will typically open to your home directory. If, for example, you cloned the repository to your Documents folder, then you would type `cd Documents/qmk_firmware`. If you extracted the file from a zip, then it may be named `qmk_firmware-master` instead.
433. To confirm that you're in the correct location, you can display the contents of your current folder using the `dir` command on Windows, or the `ls` command on Linux or Mac. You should see several files, including `readme.md` and a `quantum` folder. From here, you need to navigate to the appropriate folder under `keyboards/`. For example, if you're building for a Planck, run `cd keyboards/planck`. 433. To confirm that you're in the correct location, you can display the contents of your current folder using the `dir` command on Windows, or the `ls` command on Linux or Mac. You should see several files, including `readme.md` and a `quantum` folder. From here, you need to navigate to the appropriate folder under `keyboards/`. For example, if you're building for a Planck, run `cd keyboards/planck`.
444. Once you're in the correct keyboard-specific folder, run the `make` command. This should output a lot of information about the build process. More information about the `make` command can be found below. 444. Once you're in the correct keyboard-specific folder, run the `make` command. This should output a lot of information about the build process. More information about the `make` command can be found below.
diff --git a/doc/CYGWIN_GUIDE.md b/doc/CYGWIN_GUIDE.md
index 05e7a55f7..05d71961a 100755
--- a/doc/CYGWIN_GUIDE.md
+++ b/doc/CYGWIN_GUIDE.md
@@ -234,7 +234,7 @@ If you did everything else right. This part should be a snap! Grab the latest so
234###Build Planck and Load the Firmware 234###Build Planck and Load the Firmware
235``` 235```
236$ cd ~/src 236$ cd ~/src
237$ git clone https://github.com/jackhumbert/qmk_firmware.git 237$ git clone https://github.com/qmk/qmk_firmware.git
238$ cd qmk_firmware/keyboards/planck 238$ cd qmk_firmware/keyboards/planck
239$ make 239$ make
240``` 240```
diff --git a/doc/HAND_WIRE.md b/doc/HAND_WIRE.md
index 18cb7011f..17ef3116f 100644
--- a/doc/HAND_WIRE.md
+++ b/doc/HAND_WIRE.md
@@ -183,7 +183,7 @@ As you move along, be sure that the Teensy is staying in place - recutting and s
183 183
184From here, you should have a working keyboard with the correct firmware. Before we attach the Teensy permanently to the keyboard, let's quickly get some firmware loaded onto the Teensy so we can test each keyswitch. 184From here, you should have a working keyboard with the correct firmware. Before we attach the Teensy permanently to the keyboard, let's quickly get some firmware loaded onto the Teensy so we can test each keyswitch.
185 185
186To start out, download [the firmware](https://github.com/jackhumbert/qmk_firmware/) - we'll be using my (Jack's) fork of TMK called QMK/Quantum. We'll be doing a lot from the Terminal/command prompt, so get that open, along with a decent text editor like [Sublime Text](http://www.sublimetext.com/). 186To start out, download [the firmware](https://github.com/qmk/qmk_firmware/) - we'll be using my (Jack's) fork of TMK called QMK/Quantum. We'll be doing a lot from the Terminal/command prompt, so get that open, along with a decent text editor like [Sublime Text](http://www.sublimetext.com/).
187 187
188The first thing we're going to do is create a new project using the script in the root directory of the firmware. In your terminal, run this command with `<project_name>` replaced by the name of your project - it'll need to be different from any other project in the `keyboards/` folder: 188The first thing we're going to do is create a new project using the script in the root directory of the firmware. In your terminal, run this command with `<project_name>` replaced by the name of your project - it'll need to be different from any other project in the `keyboards/` folder:
189 189
@@ -276,7 +276,7 @@ This can be accomplished by using the following `keymaps` definition:
276 ), 276 ),
277 }; 277 };
278 278
279Note that the layout of the keycodes is similar to the physical layout of our keyboard - this make it much easier to see what's going on. A lot of the keycodes should be fairly obvious, but for a full list of them, check out [tmk_code/doc/keycode.txt](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keycode.txt) - there are also a lot of aliases to condense your keymap file. 279Note that the layout of the keycodes is similar to the physical layout of our keyboard - this make it much easier to see what's going on. A lot of the keycodes should be fairly obvious, but for a full list of them, check out [tmk_code/doc/keycode.txt](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/doc/keycode.txt) - there are also a lot of aliases to condense your keymap file.
280 280
281It's also important to use the `KEYMAP` function we defined earlier - this is what allows the firmware to associate our intended readable keymap with the actual wiring. 281It's also important to use the `KEYMAP` function we defined earlier - this is what allows the firmware to associate our intended readable keymap with the actual wiring.
282 282
@@ -306,7 +306,7 @@ If you've done all of these things, keep in mind that sometimes you might have h
306 306
307Now that you have a working board, it's time to get things in their permanent positions. I've often used liberal amounts of hot glue to secure and insulate things, so if that's your style, start spreading that stuff like butter. Otherwise, double-sided tape is always an elegant solution, and electrical tape is a distant second. Due to the nature of these builds, a lot of this part is up to you and how you planned (or didn't plan) things out. 307Now that you have a working board, it's time to get things in their permanent positions. I've often used liberal amounts of hot glue to secure and insulate things, so if that's your style, start spreading that stuff like butter. Otherwise, double-sided tape is always an elegant solution, and electrical tape is a distant second. Due to the nature of these builds, a lot of this part is up to you and how you planned (or didn't plan) things out.
308 308
309There are a lot of possibilities inside the firmware - check out the [readme](https://github.com/jackhumbert/qmk_firmware/blob/master/readme.md) for a full feature list, and dive into the different project (Planck, Ergodox EZ, etc) to see how people use all of them. You can always stop by [the OLKB subreddit for help!](http://reddit.com/r/olkb) 309There are a lot of possibilities inside the firmware - check out the [readme](https://github.com/qmk/qmk_firmware/blob/master/readme.md) for a full feature list, and dive into the different project (Planck, Ergodox EZ, etc) to see how people use all of them. You can always stop by [the OLKB subreddit for help!](http://reddit.com/r/olkb)
310 310
311## Trouble-shooting compiling 311## Trouble-shooting compiling
312 312
diff --git a/doc/PCB_GUIDE.md b/doc/PCB_GUIDE.md
index 3fad41dfb..16de71114 100644
--- a/doc/PCB_GUIDE.md
+++ b/doc/PCB_GUIDE.md
@@ -5,7 +5,7 @@
5### Windows 5### Windows
61. Install [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**. 61. Install [MHV AVR Tools](https://infernoembedded.com/sites/default/files/project/MHV_AVR_Tools_20131101.exe). Disable smatch, but **be sure to leave the option to add the tools to the PATH checked**.
72. Install [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). During installation, uncheck the option to install a graphical user interface. **DO NOT change the default installation folder.** The scripts depend on the default location. 72. Install [MinGW](https://sourceforge.net/projects/mingw/files/Installer/mingw-get-setup.exe/download). During installation, uncheck the option to install a graphical user interface. **DO NOT change the default installation folder.** The scripts depend on the default location.
83. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/jackhumbert/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer. 83. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/qmk/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer.
94. Right-click on the 1-setup-path-win batch script, select "Run as administrator", and accept the User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up. 94. Right-click on the 1-setup-path-win batch script, select "Run as administrator", and accept the User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up.
105. Right-click on the 2-setup-environment-win batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete! 105. Right-click on the 2-setup-environment-win batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete!
11 11
@@ -32,7 +32,7 @@ Note that, since it will be directly accessing USB hardware, the
32`dfu-programmer` program needs to be run as root. 32`dfu-programmer` program needs to be run as root.
33 33
34## Verify Your Installation 34## Verify Your Installation
351. Clone the following repository: https://github.com/jackhumbert/qmk_firmware 351. Clone the following repository: https://github.com/qmk/qmk_firmware
362. Open a Terminal and `cd` into `qmk_firmware/keyboards/planck` 362. Open a Terminal and `cd` into `qmk_firmware/keyboards/planck`
373. Run `make`. This should output a lot of information about the build process. 373. Run `make`. This should output a lot of information about the build process.
38 38
@@ -80,7 +80,7 @@ when trying to 'make dfu' on Windows you need to copy the dfu-programmer.exe to
80 80
81### Keymap 81### Keymap
82 82
83Unlike the other keymaps, prefixing the keycodes with `KC_` is required. A full list of the keycodes is available [here](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keycode.txt). For the keycodes available only in the extended keymap, see this [header file](https://github.com/jackhumbert/qmk_firmware/blob/master/quantum/keymap_common.h). 83Unlike the other keymaps, prefixing the keycodes with `KC_` is required. A full list of the keycodes is available [here](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/doc/keycode.txt). For the keycodes available only in the extended keymap, see this [header file](https://github.com/qmk/qmk_firmware/blob/master/quantum/keymap_common.h).
84 84
85You can use modifiers with keycodes like this: 85You can use modifiers with keycodes like this:
86 86
diff --git a/keyboards/atreus/readme.md b/keyboards/atreus/readme.md
index 8baa581f0..476d1bce3 100644
--- a/keyboards/atreus/readme.md
+++ b/keyboards/atreus/readme.md
@@ -88,7 +88,7 @@ We've added shortcuts to make common modifier/tap (mod-tap) mappings more compac
88 88
89### Remember: These are just aliases 89### Remember: These are just aliases
90 90
91These functions work the same way that their `ACTION_*` functions do - they're just quick aliases. To dig into all of the tmk ACTION_* functions, please see the [TMK documentation](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keymap.md#2-action). 91These functions work the same way that their `ACTION_*` functions do - they're just quick aliases. To dig into all of the tmk ACTION_* functions, please see the [TMK documentation](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/doc/keymap.md#2-action).
92 92
93Instead of using `FNx` when defining `ACTION_*` functions, you can use `F(x)` - the benefit here is being able to use more than 32 function actions (up to 4096), if you happen to need them. 93Instead of using `FNx` when defining `ACTION_*` functions, you can use `F(x)` - the benefit here is being able to use more than 32 function actions (up to 4096), if you happen to need them.
94 94
diff --git a/keyboards/ergodox/keymaps/ab/readme.md b/keyboards/ergodox/keymaps/ab/readme.md
index 6b1ac2be3..62e08e162 100644
--- a/keyboards/ergodox/keymaps/ab/readme.md
+++ b/keyboards/ergodox/keymaps/ab/readme.md
@@ -8,7 +8,7 @@ Beginner's keymap emulates standard QWERTY keyboard for beginners. Once you get
8* Easy on beginners. It has everything you need for your day to day usage. 8* Easy on beginners. It has everything you need for your day to day usage.
9 9
10#### Cons 10#### Cons
11* Keys are not ergonomically placed to take full advantage of Ergodox-EZ. Take a look at this [Default Keymap](https://github.com/jackhumbert/qmk_firmware/blob/master/keyboards/ergodox_ez/keymaps/default/readme.md) 11* Keys are not ergonomically placed to take full advantage of Ergodox-EZ. Take a look at this [Default Keymap](https://github.com/qmk/qmk_firmware/blob/master/keyboards/ergodox_ez/keymaps/default/readme.md)
12* While multiple layers are possible, beginner's keymap only uses one additional layer for mouse, function and volume keys. 12* While multiple layers are possible, beginner's keymap only uses one additional layer for mouse, function and volume keys.
13 13
14#### Notes 14#### Notes
diff --git a/keyboards/ergodox/keymaps/albert/Makefile b/keyboards/ergodox/keymaps/albert/Makefile
new file mode 100644
index 000000000..eb8544afe
--- /dev/null
+++ b/keyboards/ergodox/keymaps/albert/Makefile
@@ -0,0 +1,5 @@
1COMMAND_ENABLE = no # Commands for debug and configuration
2
3ifndef QUANTUM_DIR
4 include ../../../../Makefile
5endif
diff --git a/keyboards/ergodox/keymaps/albert/config.h b/keyboards/ergodox/keymaps/albert/config.h
new file mode 100644
index 000000000..e6d363117
--- /dev/null
+++ b/keyboards/ergodox/keymaps/albert/config.h
@@ -0,0 +1,12 @@
1#ifndef CONFIG_USER_H
2#define CONFIG_USER_H
3
4#include "../../config.h"
5
6/* using UK layout for space-cadet-shift */
7#define LSPO_KEY KC_9
8#define RSPC_KEY KC_0
9
10#define LEADER_TIMEOUT 800 // leader key sequence timeout in millis
11
12#endif
diff --git a/keyboards/ergodox/keymaps/albert/keymap.c b/keyboards/ergodox/keymaps/albert/keymap.c
new file mode 100644
index 000000000..dfbb311bd
--- /dev/null
+++ b/keyboards/ergodox/keymaps/albert/keymap.c
@@ -0,0 +1,661 @@
1#include "ergodox.h"
2#include "debug.h"
3#include "action_layer.h"
4#include "version.h"
5
6#include <stdarg.h>
7
8/* use UK keymap */
9
10#define UK_HASH KC_NONUS_HASH
11#define UK_BSLS KC_NONUS_BSLASH
12#define UK_PIPE LSFT(UK_BSLS)
13
14#define BASE 0 // default layer
15#define SYMB 1 // symbols
16#define NUMB 2 // numbers and hex
17#define CRSR 3 // cursor keys
18#define MOUS 4 // mouse keys
19#define KEYW 5 // keyword macros
20#define EMAC 6 // emacs
21
22// my macros
23#define UM_ECET M(0) // { }
24#define UM_0x M(1)
25#define UM_PUB M(2)
26#define UM_PRO M(3)
27#define UM_PRV M(4)
28#define UM_CLS M(5)
29#define UM_STR M(6)
30#define UM_RET M(7)
31#define UM_INC M(8)
32#define UM_OBJ M(9)
33#define UM_GITLOG M(10)
34#define UM_GOODM M(11)
35#define UM_NAMESP M(12)
36#define UM_EMTR M(14) // emacs toggle read-only
37#define UM_EMWR M(15) // emacs write buffer (save)
38#define UM_EMUN M(16) // emacs undo
39#define UM_EMRE M(17) // emacs redo
40#define UM_EMPB M(18) // emacs previous buffer
41#define UM_EMNB M(19) // emacs next buffer
42#define UM_GOODN M(20)
43#define UM_ECETS M(22) // { };
44#define UM_TMPL M(23)
45#define UM_TYPN M(24)
46#define UM_CONT M(25)
47#define UM_BREAK M(26)
48#define UM_CONST M(27)
49#define UM_SMILY M(28)
50#define UM_SADF M(29)
51#define UM_SCARF M(30)
52#define UM_DECAF M(31)
53#define UM_OPER M(32)
54#define UM_NULP M(33)
55#define UM_EXTR M(34)
56#define UM_VIRT M(35)
57#define UM_EMFB M(36) // emacs font bigger
58#define UM_EMFS M(37) // emacs font smaller
59#define UM_VOLAT M(38)
60
61const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
62/* Keymap 0: Base layer
63 *
64 * ,--------------------------------------------------. ,--------------------------------------------------.
65 * | ESC | 1 | 2 | 3 | 4 | 5 | SfLt | | SfRt | 6 | 7 | 8 | 9 | 0 | BkSp |
66 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
67 * | Tab | Q | W | E | R | T | L1 | | L1 | Y | U | I | O | P | Del |
68 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
69 * | Caps/L2| A | S | D | F | G |------| |------| H | J | K | L | ; |Enter/L2|
70 * |--------+------+------+------+------+------| L6 | | L6 |------+------+------+------+------+--------|
71 * | LSft/( | Z | X | C | V/L3 | B/L4 | | | | N/L4 | M/L3 | , | . | / | RSft/) |
72 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
73 * |Ctrl/[| Alt/]| # | Left |Right | | Up | Down | - | Alt/[|Ctrl/]|
74 * `----------------------------------' `----------------------------------'
75 * ,-------------. ,-------------.
76 * | L2 | lead | | lead | Ins |
77 * ,------|------|------| |------+------+------.
78 * | Space| BkSp | Home | | PgUp | Enter|Space |
79 * | / | / |------| |------| / | / |
80 * | Ctrl | Alt |End/L5| |PDn/L5| Alt | Ctrl |
81 * `--------------------' `--------------------'
82 */
83[BASE] = KEYMAP( // layer 0 : default
84 // left hand
85 KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, LSFT(KC_LEFT),
86 KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, MO(SYMB),
87 LT(NUMB, KC_CAPS), KC_A, KC_S, KC_D, KC_F, KC_G,
88 KC_LSPO, KC_Z, KC_X, KC_C, LT(CRSR, KC_V), LT(MOUS, KC_B), MO(EMAC),
89 CTL_T(KC_LBRC), ALT_T(KC_RBRC), UK_HASH, KC_LEFT, KC_RGHT,
90 TG(NUMB), KC_LEAD,
91 KC_HOME,
92 CTL_T(KC_SPC), ALT_T(KC_BSPC), LT(KEYW, KC_END),
93 // right hand
94 LSFT(KC_RGHT), KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC,
95 MO(SYMB), KC_Y, KC_U, KC_I, KC_O, KC_P, KC_DELT,
96 KC_H, KC_J, KC_K, KC_L, KC_SCLN, LT(NUMB, KC_ENT),
97 MO(EMAC), LT(MOUS, KC_N), LT(CRSR, KC_M), KC_COMM, KC_DOT, KC_SLSH, KC_RSPC,
98 KC_UP, KC_DOWN, KC_MINS, ALT_T(KC_LBRC), CTL_T(KC_RBRC),
99 KC_LEAD, KC_INS,
100 KC_PGUP,
101 LT(KEYW, KC_PGDN), ALT_T(KC_ENT), CTL_T(KC_SPC)
102 ),
103/* Keymap 1: Symbol Layer with F keys
104 *
105 * ,--------------------------------------------------. ,--------------------------------------------------.
106 * | ## | F1 | F2 | F3 | F4 | F5 | ## | | ## | F6 | F7 | F8 | F9 | F10 | F11 |
107 * |--------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
108 * | ## | ! | " | £ | $ | % | ## | | ## | - | + | = | @ | ~ | F12 |
109 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
110 * | ## | ^ | & | * | _ | # |------| |------| { | } | ; | ' | # | ## |
111 * |--------+------+------+------+------+------| ## | | ## |------+------+------+------+------+--------|
112 * | ## | \ | | | ` | - | / | | | | [ | ] | < | > | ? | ## |
113 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
114 * | ## | ## | ## | ## | ## | | ## | ## | ## | ## | ## |
115 * `----------------------------------' `----------------------------------'
116 * ,-------------. ,-------------.
117 * | ## | ## | | ## | ## |
118 * ,------|------|------| |------+------+------.
119 * | | | ## | | ## | | |
120 * | ## | ## |------| |------| ## | ## |
121 * | | | ## | | ## | | |
122 * `--------------------' `--------------------'
123 */
124[SYMB] = KEYMAP(
125 // left hand
126 KC_TRNS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_TRNS,
127 KC_TRNS, KC_EXLM, LSFT(KC_2), LSFT(KC_3), LSFT(KC_4), LSFT(KC_5), KC_TRNS,
128 KC_TRNS, LSFT(KC_6), LSFT(KC_7), LSFT(KC_8), LSFT(KC_MINS), UK_HASH,
129 KC_TRNS, UK_BSLS, UK_PIPE, KC_GRV, KC_MINS, KC_SLSH, KC_TRNS,
130 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
131 KC_TRNS, KC_TRNS,
132 KC_TRNS,
133 KC_TRNS, KC_TRNS, KC_TRNS,
134 // right hand
135 KC_TRNS, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11,
136 KC_TRNS, KC_MINS, KC_PLUS, KC_EQL, LSFT(KC_QUOT), LSFT(UK_HASH), KC_F12,
137 KC_LCBR, KC_RCBR, KC_SCLN, KC_QUOT, UK_HASH, KC_TRNS,
138 KC_TRNS, KC_LBRC, KC_RBRC, LSFT(KC_COMM), LSFT(KC_DOT), LSFT(KC_SLSH), KC_TRNS,
139 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
140 KC_TRNS, KC_TRNS,
141 KC_TRNS,
142 KC_TRNS, KC_TRNS, KC_TRNS
143 ),
144/* Keymap 2: Numerics and hex
145 *
146 * ,---------------------------------------------------. ,--------------------------------------------------.
147 * | ## | A | B | C | D | E | F | | A | B | C | D | E | F | ## |
148 * |---------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
149 * | ## | * | 7 | 8 | 9 | * | 0x | | 0x | * | 7 | 8 | 9 | * | ## |
150 * |---------+------+------+------+------+------| | | |------+------+------+------+------+--------|
151 * | ## | / | 4 | 5 | 6 | / |------| |------| / | 4 | 5 | 6 | / | ## |
152 * |---------+------+------+------+------+------| ## | | ## |------+------+------+------+------+--------|
153 * | ## | - | 1 | 2 | 3 | - | | | | - | 1 | 2 | 3 | - | ## |
154 * `---------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
155 * | = | + | 0 | , | . | | 0 | , | . | + | = |
156 * `-----------------------------------' `----------------------------------'
157 * ,-------------. ,-------------.
158 * | ## | ## | | ## | ## |
159 * ,------|------|------| |------+------+------.
160 * | | | ## | | ## | | |
161 * | ## | ## |------| |------| ## | ## |
162 * | | | ## | | ## | | |
163 * `--------------------' `--------------------'
164 */
165[NUMB] = KEYMAP(
166 // left hand
167 KC_TRNS, KC_A, KC_B, KC_C, KC_D, KC_E, KC_F,
168 KC_TRNS, KC_ASTR, KC_7, KC_8, KC_9, KC_ASTR, UM_0x,
169 KC_TRNS, KC_SLSH, KC_4, KC_5, KC_6, KC_SLSH,
170 KC_TRNS, KC_MINS, KC_1, KC_2, KC_3, KC_MINS, KC_TRNS,
171 KC_EQL, KC_PLUS, KC_0, KC_COMM, KC_DOT,
172 KC_TRNS, KC_TRNS,
173 KC_TRNS,
174 KC_TRNS, KC_TRNS, KC_TRNS,
175 // right hand
176 KC_A, KC_B, KC_C, KC_D, KC_E, KC_F, KC_TRNS,
177 UM_0x, KC_ASTR, KC_7, KC_8, KC_9, KC_ASTR, KC_TRNS,
178 KC_SLSH, KC_4, KC_5, KC_6, KC_SLSH, KC_TRNS,
179 KC_TRNS, KC_MINS, KC_1, KC_2, KC_3, KC_MINS, KC_TRNS,
180 KC_0, KC_COMM, KC_DOT, KC_PLUS, KC_EQL,
181 KC_TRNS, KC_TRNS,
182 KC_TRNS,
183 KC_TRNS, KC_TRNS, KC_TRNS
184 ),
185/* Keymap 3: Cursor movement
186 *
187 * ,---------------------------------------------------. ,--------------------------------------------------.
188 * | | | | | | | | | | | | | | | |
189 * |---------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
190 * | | Home | | Up | | PgUp | | | | PgUp | | Up | | Home | |
191 * |---------+------+------+------+------+------| | | |------+------+------+------+------+--------|
192 * | | End | Left | Down | Right| PgDn |------| |------| PgDn | Left | Down | Right| End | |
193 * |---------+------+------+------+------+------| | | |------+------+------+------+------+--------|
194 * | ## | Up | | Down | ## | | | | | | ## | Down | | Up | ## |
195 * `---------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
196 * | Left | Down | Right| | | | | | Left | Down | Right|
197 * `-----------------------------------' `----------------------------------'
198 * ,-------------. ,-------------.
199 * | | | | | |
200 * ,------|------|------| |------+------+------.
201 * | | | | | | | |
202 * | ## | ## |------| |------| ## | ## |
203 * | | | | | | | |
204 * `--------------------' `--------------------'
205 */
206[CRSR] = KEYMAP(
207 // left hand
208 KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
209 KC_NO, KC_HOME, KC_NO, KC_UP, KC_NO, KC_PGUP, KC_NO,
210 KC_NO, KC_END, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN,
211 KC_TRNS, KC_UP, KC_NO, KC_DOWN, KC_TRNS, KC_NO, KC_NO,
212 KC_LEFT, KC_DOWN, KC_RGHT, KC_NO, KC_NO,
213 KC_NO, KC_NO,
214 KC_NO,
215 KC_TRNS, KC_TRNS, KC_NO,
216 // right hand
217 KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
218 KC_NO, KC_PGUP, KC_NO, KC_UP, KC_NO, KC_HOME, KC_NO,
219 KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_END, KC_NO,
220 KC_NO, KC_NO, KC_TRNS, KC_DOWN, KC_NO, KC_UP, KC_TRNS,
221 KC_NO, KC_NO, KC_LEFT, KC_DOWN, KC_RGHT,
222 KC_NO, KC_NO,
223 KC_NO,
224 KC_NO, KC_TRNS, KC_TRNS
225 ),
226/* Keymap 4: Media and mouse keys
227 *
228 * ,--------------------------------------------------. ,--------------------------------------------------.
229 * | | | | | | | | | | | | | | | |
230 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
231 * | | | Lclk | MsUp | Rclk | | | | | | Lclk | MsUp | Rclk | | |
232 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
233 * | | |MsLeft|MsDown|MsRght| |------| |------| |MsLeft|MsDown|MsRght| | |
234 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
235 * | Lclk | MsUp | Rclk |MsDown| | ## | | | | ## | |MsDown| Lclk | MsUp | Rclk |
236 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
237 * |MsLeft|MsDown|MsRight | | | | |MsLeft|MsDown|MsRght|
238 * `----------------------------------' `----------------------------------'
239 * ,-------------. ,-------------.
240 * | | | | | |
241 * ,------|------|------| |------+------+------.
242 * | | | | | | | |
243 * | | |------| |------| | |
244 * | | | | | | | |
245 * `--------------------' `--------------------'
246 */
247[MOUS] = KEYMAP(
248 // left hand
249 KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
250 KC_NO, KC_NO, KC_BTN1, KC_MS_U, KC_BTN2, KC_NO, KC_NO,
251 KC_NO, KC_NO, KC_MS_L, KC_MS_D, KC_MS_R, KC_NO,
252 KC_BTN1, KC_MS_U, KC_BTN2, KC_MS_D, KC_NO, KC_TRNS, KC_NO,
253 KC_MS_L, KC_MS_D, KC_MS_R, KC_NO, KC_NO,
254 KC_NO, KC_NO,
255 KC_NO,
256 KC_NO, KC_NO, KC_NO,
257 // right hand
258 KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
259 KC_NO, KC_NO, KC_BTN1, KC_MS_U, KC_BTN2, KC_NO, KC_NO,
260 KC_NO, KC_MS_L, KC_MS_D, KC_MS_R, KC_NO, KC_NO,
261 KC_NO, KC_TRNS, KC_NO, KC_MS_D, KC_BTN1, KC_MS_U, KC_BTN2,
262 KC_NO, KC_NO, KC_MS_L, KC_MS_D, KC_MS_R,
263 KC_NO, KC_NO,
264 KC_NO,
265 KC_NO, KC_NO, KC_NO
266 ),
267/* Keymap 5: Keywords
268 *
269 * ,---------------------------------------------------. ,--------------------------------------------------.
270 * | | | | scarf| sadf | smily| | | | decaf| | | | | |
271 * |---------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
272 * | | const| volat| oper | ret | tmpl | | | | typen| cont | prv | pro | pub | |
273 * |---------+------+------+------+------+------| | | |------+------+------+------+------+--------|
274 * | | | str | obj | | gitl |------| |------| | | | nulp | | |
275 * |---------+------+------+------+------+------| | | |------+------+------+------+------+--------|
276 * | | | extr | cls | virt | break| | | |namesp| goodm| goodn| | | |
277 * `---------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
278 * | | | inc | | | | | | | | |
279 * `-----------------------------------' `----------------------------------'
280 * ,-------------. ,-------------.
281 * | | | | ecet | ecets|
282 * ,------|------|------| |------+------+------.
283 * | | | | | | | |
284 * | | |------| |------| | |
285 * | | | ## | | ## | | |
286 * `--------------------' `--------------------'
287 */
288[KEYW] = KEYMAP(
289 // left hand
290 KC_NO, KC_NO, KC_NO, UM_SCARF, UM_SADF, UM_SMILY, KC_NO,
291 KC_NO, UM_CONST, UM_VOLAT, UM_OPER, UM_RET, UM_TMPL, KC_NO,
292 KC_NO, KC_NO, UM_STR, UM_OBJ, KC_NO, UM_GITLOG,
293 KC_NO, KC_NO, UM_EXTR, UM_CLS, UM_VIRT, UM_BREAK, KC_NO,
294 KC_NO, KC_NO, UM_INC, KC_NO, KC_NO,
295 KC_NO, KC_NO,
296 KC_NO,
297 KC_NO, KC_NO, KC_TRNS,
298 // right hand
299 KC_NO, UM_DECAF, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
300 KC_NO, UM_TYPN, UM_CONT, UM_PRV, UM_PRO, UM_PUB, KC_NO,
301 KC_NO, KC_NO, KC_NO, UM_NULP, KC_NO, KC_NO,
302 KC_NO, UM_NAMESP, UM_GOODM, UM_GOODN, KC_NO, KC_NO, KC_NO,
303 KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
304 UM_ECET, UM_ECETS,
305 KC_NO,
306 KC_TRNS, KC_NO, KC_NO
307 ),
308/* Keymap 6: emacs
309 *
310 * ,---------------------------------------------------. ,--------------------------------------------------.
311 * | | | | | | | empb | | emnb | emfs | emfb | | | | |
312 * |---------+------+------+------+------+------+------| |------+------+------+------+------+------+--------|
313 * | | emtr | | | | | | | | emun | emre | w-up | | | |
314 * |---------+------+------+------+------+------| | | |------+------+------+------+------+--------|
315 * | | | emwr | | | |------| |------| |w-left|w-down|w-rght| | |
316 * |---------+------+------+------+------+------| ## | | ## |------+------+------+------+------+--------|
317 * | | | | | | | | | | | |w-down| | | |
318 * `---------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
319 * | | | | | | | | | | | |
320 * `-----------------------------------' `----------------------------------'
321 * ,-------------. ,-------------.
322 * | | | | | |
323 * ,------|------|------| |------+------+------.
324 * | | | | | | | |
325 * | | |------| |------| | |
326 * | | | | | | | |
327 * `--------------------' `--------------------'
328 */
329[EMAC] = KEYMAP(
330 // left hand
331 KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, UM_EMPB,
332 KC_NO, UM_EMTR, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
333 KC_NO, KC_NO, UM_EMWR, KC_NO, KC_NO, KC_NO,
334 KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_TRNS,
335 KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
336 KC_NO, KC_NO,
337 KC_NO,
338 KC_NO, KC_NO, KC_NO,
339 // right hand
340 UM_EMNB, UM_EMFS, UM_EMFB, KC_NO, KC_NO, KC_NO, KC_NO,
341 KC_NO, UM_EMUN, UM_EMRE, LSFT(KC_UP), KC_NO, KC_NO, KC_NO,
342 KC_NO, LSFT(KC_LEFT), LSFT(KC_DOWN), LSFT(KC_RGHT), KC_NO, KC_NO,
343 KC_TRNS, KC_NO, KC_NO, LSFT(KC_DOWN), KC_NO, KC_NO, KC_NO,
344 KC_NO, KC_NO, KC_NO, KC_NO, KC_NO,
345 KC_NO, KC_NO,
346 KC_NO,
347 KC_NO, KC_NO, KC_NO
348 ),
349};
350
351enum next_key_down_up {
352 NK_DOWN_UP,
353 NK_DOWN,
354 NK_UP // a bit of a hack, this works as long as NK_UP < KC_A
355};
356
357void send_keystrokes(uint8_t key, ...)
358{
359 va_list vl;
360 va_start(vl, key);
361 enum next_key_down_up nkdu = NK_DOWN_UP;
362 while (key != KC_NO) {
363 if (key < KC_A) {
364 nkdu = key;
365 } else {
366 switch (nkdu) {
367 case NK_DOWN_UP:
368 register_code(key);
369 case NK_UP:
370 unregister_code(key);
371 break;
372 case NK_DOWN:
373 register_code(key);
374 }
375 nkdu = NK_DOWN_UP;
376 }
377 key = va_arg(vl, int);
378 }
379 va_end(vl);
380}
381
382const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt)
383{
384 // MACRODOWN only works in this function
385 switch(id) {
386 case 0: // { }
387 if (record->event.pressed) {
388 return MACRO(T(ENT), D(LSFT), T(LBRC), U(LSFT), T(ENT),
389 D(LSFT), T(RBRC), U(LSFT), T(UP),
390 T(TAB), END);
391 }
392 break;
393 case 1:
394 if (record->event.pressed) {
395 return MACRO(T(0), T(X), END);
396 }
397 break;
398 case 2:
399 if (record->event.pressed) {
400 SEND_STRING("public");
401 }
402 break;
403 case 3:
404 if (record->event.pressed) {
405 SEND_STRING("protected");
406 }
407 break;
408 case 4:
409 if (record->event.pressed) {
410 SEND_STRING("private");
411 }
412 break;
413 case 5: // class
414 if (record->event.pressed) {
415 return MACRO(T(C), T(L), T(A), T(S), T(S), T(ENT),
416 D(LSFT), T(LBRC), U(LSFT), T(ENT),
417 T(P), T(U), T(B), T(L), T(I), T(C),
418 D(LSFT), T(SCLN), U(LSFT), T(ENT), T(ENT),
419 T(P), T(R), T(I), T(V), T(A), T(T), T(E),
420 D(LSFT), T(SCLN), U(LSFT), T(ENT),
421 D(LSFT), T(RBRC), U(LSFT), T(SCLN), T(ENT),
422 T(UP), T(UP), T(UP), T(UP), T(UP), T(UP), T(UP),
423 T(END), T(SPC), END);
424 }
425 break;
426 case 6: // struct
427 if (record->event.pressed) {
428 return MACRO(T(S), T(T), T(R), T(U), T(C), T(T), T(ENT),
429 D(LSFT), T(LBRC), U(LSFT), T(ENT),
430 D(LSFT), T(RBRC), U(LSFT), T(SCLN), T(ENT),
431 T(UP), T(UP), T(UP), T(UP),
432 T(END), T(SPC), END);
433 }
434 break;
435 case 7:
436 if (record->event.pressed) {
437 SEND_STRING("return");
438 }
439 break;
440 case 8: // #include
441 if (record->event.pressed) {
442 return MACRO(T(NONUS_HASH), T(I), T(N), T(C), T(L), T(U), T(D), T(E), END);
443 }
444 break;
445 case 9:
446 if (record->event.pressed) {
447 SEND_STRING("objdump -CT -x -d");
448 }
449 break;
450 case 10:
451 if (record->event.pressed) {
452 SEND_STRING("git log --oneline --graph --decorate=short");
453 }
454 break;
455 case 11:
456 if (record->event.pressed) {
457 SEND_STRING("good morning");
458 }
459 break;
460 case 12:
461 if (record->event.pressed) {
462 SEND_STRING("namespace");
463 }
464 break;
465 case 14: // emacs toggle read-only
466 if (record->event.pressed) {
467 return MACRO(D(LCTL), T(X), T(Q), U(LCTL), END);
468 }
469 break;
470 case 15: // emacs write buffer
471 if (record->event.pressed) {
472 return MACRO(D(LCTL), T(X), T(S), U(LCTL), END);
473 }
474 break;
475 case 16: // emacs undo
476 if (record->event.pressed) {
477 return MACRO(D(LCTL), D(LSFT), T(MINS), U(LSFT), U(LCTL), END);
478 }
479 break;
480 case 17: // emacs redo
481 if (record->event.pressed) {
482 return MACRO(D(LALT), D(LSFT), T(MINS), U(LSFT), U(LALT), END);
483 }
484 break;
485 case 18: // emacs previous buffer
486 if (record->event.pressed) {
487 return MACRO(D(LCTL), T(X), U(LCTL), T(LEFT), END);
488 }
489 break;
490 case 19: // emacs next buffer
491 if (record->event.pressed) {
492 return MACRO(D(LCTL), T(X), U(LCTL), T(RGHT), END);
493 }
494 break;
495 case 20:
496 if (record->event.pressed) {
497 SEND_STRING("good night");
498 }
499 break;
500 case 22: // { };
501 if (record->event.pressed) {
502 return MACRO(T(ENT), D(LSFT), T(LBRC), U(LSFT), T(ENT),
503 D(LSFT), T(RBRC), U(LSFT), T(SCLN), T(UP),
504 T(TAB), END);
505 }
506 break;
507 case 23:
508 if (record->event.pressed) {
509 SEND_STRING("template");
510 }
511 break;
512 case 24:
513 if (record->event.pressed) {
514 SEND_STRING("typename");
515 }
516 break;
517 case 25:
518 if (record->event.pressed) {
519 SEND_STRING("continue");
520 return MACRO(T(SCLN), END);
521 }
522 break;
523 case 26:
524 if (record->event.pressed) {
525 SEND_STRING("break");
526 return MACRO(T(SCLN), END);
527 }
528 break;
529 case 27:
530 if (record->event.pressed) {
531 SEND_STRING("const");
532 }
533 break;
534 case 28:
535 if (record->event.pressed) {
536 SEND_STRING(":-)");
537 }
538 break;
539 case 29:
540 if (record->event.pressed) {
541 SEND_STRING(":-(");
542 }
543 break;
544 case 30: // dazed
545 if (record->event.pressed) {
546 send_keystrokes(NK_DOWN, KC_LSFT, KC_8, KC_MINS, KC_8, NK_UP, KC_LSFT, KC_NO);
547 }
548 break;
549 case 31: // decaf
550 if (record->event.pressed) {
551 send_keystrokes(NK_DOWN, KC_LSFT, KC_C, KC_9, KC_MINS, KC_0, NK_UP, KC_LSFT, KC_NO);
552 }
553 break;
554 case 32:
555 if (record->event.pressed) {
556 SEND_STRING("operator");
557 }
558 break;
559 case 33:
560 if (record->event.pressed) {
561 SEND_STRING("nullptr");
562 }
563 break;
564 case 34:
565 if (record->event.pressed) {
566 SEND_STRING("extern");
567 }
568 break;
569 case 35:
570 if (record->event.pressed) {
571 SEND_STRING("virtual");
572 }
573 break;
574 case 36: // emacs font smaller
575 if (record->event.pressed) {
576 return MACRO(D(LCTL), T(X), T(EQL), U(LCTL), END);
577 }
578 break;
579 case 37: // emacs font bigger
580 if (record->event.pressed) {
581 return MACRO(D(LCTL), T(X), T(MINS), U(LCTL), END);
582 }
583 break;
584 case 38:
585 if (record->event.pressed) {
586 SEND_STRING("volatile");
587 }
588 break;
589 }
590 return MACRO_NONE;
591}
592
593LEADER_EXTERNS();
594
595// Runs constantly in the background, in a loop.
596void matrix_scan_user(void) {
597
598 LEADER_DICTIONARY() {
599 leading = false;
600 leader_end();
601
602 SEQ_TWO_KEYS(KC_G, KC_A) {
603 SEND_STRING("git add .");
604 }
605 SEQ_TWO_KEYS(KC_G, KC_D) {
606 SEND_STRING("git diff");
607 }
608 SEQ_THREE_KEYS(KC_G, KC_D, KC_S) {
609 SEND_STRING("git diff --staged");
610 }
611 SEQ_TWO_KEYS(KC_G, KC_L) {
612 SEND_STRING("git log");
613 }
614 SEQ_THREE_KEYS(KC_G, KC_L, KC_O) {
615 SEND_STRING("git log --oneline");
616 }
617 SEQ_TWO_KEYS(KC_G, KC_F) {
618 SEND_STRING("git fetch");
619 }
620 SEQ_TWO_KEYS(KC_G, KC_O) {
621 SEND_STRING("git checkout");
622 }
623 SEQ_TWO_KEYS(KC_G, KC_P) {
624 SEND_STRING("git pull");
625 }
626 SEQ_TWO_KEYS(KC_G, KC_S) {
627 SEND_STRING("git status");
628 }
629 SEQ_TWO_KEYS(KC_G, KC_C) {
630 SEND_STRING("git commit -m ''");
631 send_keystrokes(KC_LEFT, KC_NO);
632 }
633 SEQ_THREE_KEYS(KC_G, KC_C, KC_A) {
634 SEND_STRING("git commit --amend");
635 }
636
637 SEQ_TWO_KEYS(KC_C, KC_C) {
638 SEND_STRING("const_cast<>");
639 send_keystrokes(KC_LEFT, KC_NO);
640 }
641 SEQ_TWO_KEYS(KC_C, KC_D) {
642 SEND_STRING("dynamic_cast<>");
643 send_keystrokes(KC_LEFT, KC_NO);
644 }
645 SEQ_TWO_KEYS(KC_C, KC_R) {
646 SEND_STRING("reinterpret_cast<>");
647 send_keystrokes(KC_LEFT, KC_NO);
648 }
649 SEQ_TWO_KEYS(KC_C, KC_S) {
650 SEND_STRING("static_cast<>");
651 send_keystrokes(KC_LEFT, KC_NO);
652 }
653
654 SEQ_ONE_KEY(KC_SLSH) {
655 send_keystrokes(KC_SLSH, NK_DOWN, KC_LSFT, KC_8, KC_8, NK_UP, KC_LSFT, KC_ENT,
656 NK_DOWN, KC_LSFT, KC_8, NK_UP, KC_LSFT, KC_ENT,
657 NK_DOWN, KC_LSFT, KC_8, NK_UP, KC_LSFT, KC_SLSH, KC_UP, KC_END, KC_SPC,
658 KC_NO);
659 }
660 }
661}
diff --git a/keyboards/ergodox/keymaps/albert/readme.md b/keyboards/ergodox/keymaps/albert/readme.md
new file mode 100644
index 000000000..e20e047ac
--- /dev/null
+++ b/keyboards/ergodox/keymaps/albert/readme.md
@@ -0,0 +1,188 @@
1# ErgoDox EZ Configuration for typing like a boss.
2
3This layout has 7 layers:
40. Base layers
51. Symbols and F-keys
62. Number pad (with hexadecimal)
73. Cursor keys
84. Mouse movement and clicks
95. Keyword macros
106. Emacs
11
12There are also some leader keys defined for frequently used commands (git etc).
13
14## The layers
15
16Double hashes (`##`) indicate transparent keys (`KC_TRNS`) and blanks indicate no key (`KC_NO`).
17
18### 0. Base layer
19
20```
21,--------------------------------------------------. ,--------------------------------------------------.
22| ESC | 1 | 2 | 3 | 4 | 5 | SfLt | | SfRt | 6 | 7 | 8 | 9 | 0 | BkSp |
23|--------|------|------|------|------|-------------| |------|------|------|------|------|------|--------|
24| Tab | Q | W | E | R | T | L1 | | L1 | Y | U | I | O | P | Del |
25|--------|------|------|------|------|------| | | |------|------|------|------|------|--------|
26| Caps/L2| A | S | D | F | G |------| |------| H | J | K | L | ; |Enter/L2|
27|--------|------|------|------|------|------| L6 | | L6 |------|------|------|------|------|--------|
28| LSft/( | Z | X | C | V/L3 | B/L4 | | | | N/L4 | M/L3 | , | . | / | RSft/) |
29`--------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
30 |Ctrl/[| Alt/]| # | Left |Right | | Up | Down | - | Alt/[|Ctrl/]|
31 `----------------------------------' `----------------------------------'
32 ,-------------. ,-------------.
33 | L2 | lead | | lead | Ins |
34 ,------|------|------| |------|------|------.
35 | Space| BkSp | Home | | PgUp | Enter|Space |
36 | / | / |------| |------| / | / |
37 | Ctrl | Alt |End/L5| |PDn/L5| Alt | Ctrl |
38 `--------------------' `--------------------'
39```
40
41Space Cadet shift is enabled. Ctrl and Alt doubles up as normal keys when tapped.
42SfLt and SfRt sends Shift + left and Shift + Right respectively - for use with emacs with `windmove-default-keybindings`.
43Caps and Enter may be held down to activate layer 2 (hexadecimal number pad).
44Please see `matrix_scan_user` function in `keymap.c` for list of commands available via `lead` key.
45
46### 1. Symbols and F-keys
47
48```
49,--------------------------------------------------. ,--------------------------------------------------.
50| ## | F1 | F2 | F3 | F4 | F5 | ## | | ## | F6 | F7 | F8 | F9 | F10 | F11 |
51|--------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
52| ## | ! | " | £ | $ | % | ## | | ## | - | + | = | @ | ~ | F12 |
53|--------|------|------|------|------|------| | | |------|------|------|------|------|--------|
54| ## | ^ | & | * | _ | # |------| |------| { | } | ; | ' | # | ## |
55|--------|------|------|------|------|------| ## | | ## |------|------|------|------|------|--------|
56| ## | \ | | | ` | - | / | | | | [ | ] | < | > | ? | ## |
57`--------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
58 | ## | ## | ## | ## | ## | | ## | ## | ## | ## | ## |
59 `----------------------------------' `----------------------------------'
60 ,-------------. ,-------------.
61 | ## | ## | | ## | ## |
62 ,------|------|------| |------|------|------.
63 | | | ## | | ## | | |
64 | ## | ## |------| |------| ## | ## |
65 | | | ## | | ## | | |
66 `--------------------' `--------------------'
67```
68
69### 2. Number pad (with hexadecimal)
70
71```
72,---------------------------------------------------. ,--------------------------------------------------.
73| ## | A | B | C | D | E | F | | A | B | C | D | E | F | ## |
74|---------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
75| ## | * | 7 | 8 | 9 | * | 0x | | 0x | * | 7 | 8 | 9 | * | ## |
76|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
77| ## | / | 4 | 5 | 6 | / |------| |------| / | 4 | 5 | 6 | / | ## |
78|---------|------|------|------|------|------| ## | | ## |------|------|------|------|------|--------|
79| ## | - | 1 | 2 | 3 | - | | | | - | 1 | 2 | 3 | - | ## |
80`---------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
81 | = | + | 0 | , | . | | 0 | , | . | + | = |
82 `-----------------------------------' `----------------------------------'
83 ,-------------. ,-------------.
84 | ## | ## | | ## | ## |
85 ,------|------|------| |------|------|------.
86 | | | ## | | ## | | |
87 | ## | ## |------| |------| ## | ## |
88 | | | ## | | ## | | |
89 `--------------------' `--------------------'
90```
91
92### 3. Cursor keys
93
94```
95,---------------------------------------------------. ,--------------------------------------------------.
96| | | | | | | | | | | | | | | |
97|---------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
98| | Home | | Up | | PgUp | | | | PgUp | | Up | | Home | |
99|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
100| | End | Left | Down | Right| PgDn |------| |------| PgDn | Left | Down | Right| End | |
101|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
102| ## | Up | | Down | ## | | | | | | ## | Down | | Up | ## |
103`---------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
104 | Left | Down | Right| | | | | | Left | Down | Right|
105 `-----------------------------------' `----------------------------------'
106 ,-------------. ,-------------.
107 | | | | | |
108 ,------|------|------| |------|------|------.
109 | | | | | | | |
110 | ## | ## |------| |------| ## | ## |
111 | | | | | | | |
112 `--------------------' `--------------------'
113```
114
115### 4. Mouse movement and clicks
116
117```
118,--------------------------------------------------. ,--------------------------------------------------.
119| | | | | | | | | | | | | | | |
120|--------|------|------|------|------|-------------| |------|------|------|------|------|------|--------|
121| | | Lclk | MsUp | Rclk | | | | | | Lclk | MsUp | Rclk | | |
122|--------|------|------|------|------|------| | | |------|------|------|------|------|--------|
123| | |MsLeft|MsDown|MsRght| |------| |------| |MsLeft|MsDown|MsRght| | |
124|--------|------|------|------|------|------| | | |------|------|------|------|------|--------|
125| Lclk | MsUp | Rclk |MsDown| | ## | | | | ## | |MsDown| Lclk | MsUp | Rclk |
126`--------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
127 |MsLeft|MsDown|MsRight | | | | |MsLeft|MsDown|MsRght|
128 `----------------------------------' `----------------------------------'
129 ,-------------. ,-------------.
130 | | | | | |
131 ,------|------|------| |------|------|------.
132 | | | | | | | |
133 | | |------| |------| | |
134 | | | | | | | |
135 `--------------------' `--------------------'
136```
137
138### 5. Keyword macros
139
140```
141,---------------------------------------------------. ,--------------------------------------------------.
142| | | | scarf| sadf | smily| | | | decaf| | | | | |
143|---------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
144| | const| volat| oper | ret | tmpl | | | | typen| cont | prv | pro | pub | |
145|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
146| | | str | obj | | gitl |------| |------| | | | nulp | | |
147|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
148| | | extr | cls | virt | break| | | |namesp| goodm| goodn| | | |
149`---------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
150 | | | inc | | | | | | | | |
151 `-----------------------------------' `----------------------------------'
152 ,-------------. ,-------------.
153 | | | | ecet | ecets|
154 ,------|------|------| |------|------|------.
155 | | | | | | | |
156 | | |------| |------| | |
157 | | | ## | | ## | | |
158 `--------------------' `--------------------'
159```
160Please see `keymap.c` for the keywords/commands.
161Some are const, volatile, operator, return, template, typename, continue, private,
162protected, public, struct, class, extern, virtual, break, namespace.
163Also a git log command I use a lot (`git log --oneline --graph --decorate=short` (I know git can be configured but that is boring)).
164
165### 6. Emacs
166
167```
168,---------------------------------------------------. ,--------------------------------------------------.
169| | | | | | | empb | | emnb | emfs | emfb | | | | |
170|---------|------|------|------|------|------|------| |------|------|------|------|------|------|--------|
171| | emtr | | | | | | | | emun | emre | w-up | | | |
172|---------|------|------|------|------|------| | | |------|------|------|------|------|--------|
173| | | emwr | | | |------| |------| |w-left|w-down|w-rght| | |
174|---------|------|------|------|------|------| ## | | ## |------|------|------|------|------|--------|
175| | | | | | | | | | | |w-down| | | |
176`---------|------|------|------|------|-------------' `-------------|------|------|------|------|--------'
177 | | | | | | | | | | | |
178 `-----------------------------------' `----------------------------------'
179 ,-------------. ,-------------.
180 | | | | | |
181 ,------|------|------| |------|------|------.
182 | | | | | | | |
183 | | |------| |------| | |
184 | | | | | | | |
185 `--------------------' `--------------------'
186```
187Some emacs shortcuts like toggle read/write mode (emtr), write file (emwr), previous-buffer (empb),
188next-buffer (emnb), smaller font(emfs), larger font (emfb), undo (emun), redo (emre) and switching between windows in a frame.
diff --git a/keyboards/ergodox/keymaps/algernon/readme.md b/keyboards/ergodox/keymaps/algernon/readme.md
index 015bd7cd3..3783eadf1 100644
--- a/keyboards/ergodox/keymaps/algernon/readme.md
+++ b/keyboards/ergodox/keymaps/algernon/readme.md
@@ -121,10 +121,10 @@ There is a very small tool in `tools/layer-notify`, that listens to the HID cons
121To make my workflow easier, this layout is maintained in [its own repository][algernon:ez-layout]. To build it, you will need the [QMK][qmk] firmware checked out, and this repo either checked out to something like `keyboards/ergodox_ez/algernon-master`. One way to achieve that is this: 121To make my workflow easier, this layout is maintained in [its own repository][algernon:ez-layout]. To build it, you will need the [QMK][qmk] firmware checked out, and this repo either checked out to something like `keyboards/ergodox_ez/algernon-master`. One way to achieve that is this:
122 122
123 [algernon:ez-layout]: https://github.com/algernon/ergodox-layout 123 [algernon:ez-layout]: https://github.com/algernon/ergodox-layout
124 [qmk]: https://github.com/jackhumbert/qmk_firmware 124 [qmk]: https://github.com/qmk/qmk_firmware
125 125
126``` 126```
127$ git clone https://github.com/jackhumbert/qmk_firmware.git 127$ git clone https://github.com/qmk/qmk_firmware.git
128$ cd qmk_firmware 128$ cd qmk_firmware
129$ git clone https://github.com/algernon/ergodox-layout.git \ 129$ git clone https://github.com/algernon/ergodox-layout.git \
130 keyboards/ergodox/keymaps/algernon-master 130 keyboards/ergodox/keymaps/algernon-master
diff --git a/keyboards/ergodox/keymaps/deadcyclo/Makefile b/keyboards/ergodox/keymaps/deadcyclo/Makefile
new file mode 100644
index 000000000..039f07c8e
--- /dev/null
+++ b/keyboards/ergodox/keymaps/deadcyclo/Makefile
@@ -0,0 +1 @@
UNICODE_ENABLE = yes
diff --git a/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-base-layout.png b/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-base-layout.png
index 4208c5189..2c03af581 100644
--- a/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-base-layout.png
+++ b/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-base-layout.png
Binary files differ
diff --git a/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-1-symbols.png b/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-1-symbols.png
index ccda70e39..5adb7ac77 100644
--- a/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-1-symbols.png
+++ b/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-1-symbols.png
Binary files differ
diff --git a/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-2-media-and-mouse.png b/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-2-media-and-mouse.png
index 481e63e32..a267ff23d 100644
--- a/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-2-media-and-mouse.png
+++ b/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-2-media-and-mouse.png
Binary files differ
diff --git a/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-3-navigation.png b/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-3-navigation.png
index 9ebba6734..c8c90cf5c 100644
--- a/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-3-navigation.png
+++ b/keyboards/ergodox/keymaps/deadcyclo/images/deadcyclo-layer-3-navigation.png
Binary files differ
diff --git a/keyboards/ergodox/keymaps/deadcyclo/keymap.c b/keyboards/ergodox/keymaps/deadcyclo/keymap.c
index d75c805bf..5774511cc 100644
--- a/keyboards/ergodox/keymaps/deadcyclo/keymap.c
+++ b/keyboards/ergodox/keymaps/deadcyclo/keymap.c
@@ -8,15 +8,86 @@
8#define MDIA 2 // media keys 8#define MDIA 2 // media keys
9#define NAVG 3 // navigation 9#define NAVG 3 // navigation
10 10
11enum custom_keycodes { 11enum macros {
12 PLACEHOLDER = SAFE_RANGE, // can always be here 12 RUN
13};
14
15enum function_ids {
16 EMOJI,
17 EMOJI2,
13 EPRM, 18 EPRM,
14 VRSN, 19 VRSN,
15 RGB_SLD 20 RGB_SLD,
21 GO_GROUP
16}; 22};
17 23
18// TODO: Get rid of of keys I don't want. Make others that I do. Set up lots of makros (Using hyper (and meh)) keys (where to put them?) 24/* opt can only be 0-15 */
25enum emojis {
26 SHRUG,
27 YAY,
28 HUG,
29 SMILE,
30 SMILE2,
31 HMM1,
32 HMM2,
33 BEAR1,
34 BEAR2,
35 FUU,
36 EGGY1,
37 EGGY2,
38 FACE1,
39 FACE2,
40 UHU,
41 SMRK1
42};
43
44enum emojis2 {
45 SMRK2,
46 LOVE
47};
48
49enum progmem_ids {
50 EMOJI_SHRUG,
51 EMOJI_YAY,
52 EMOJI_HUG,
53 EMOJI_SMILE,
54 EMOJI_SMILE2,
55 EMOJI_HMM1,
56 EMOJI_HMM2,
57 EMOJI_BEAR1,
58 EMOJI_BEAR2,
59 EMOJI_FUU,
60 EMOJI_EGGY1,
61 EMOJI_EGGY2,
62 EMOJI_FACE1,
63 EMOJI_FACE2,
64 EMOJI_UHU,
65 EMOJI_SMRK1,
66 EMOJI_SMRK2,
67 EMOJI_LOVE,
68 F_EPRM,
69 F_VRSN,
70 F_RGB_SLD,
71 I3_GO_GROUP_10,
72 I3_GO_GROUP_1,
73 I3_GO_GROUP_2,
74 I3_GO_GROUP_3,
75 I3_GO_GROUP_4,
76 I3_GO_GROUP_5,
77 I3_GO_GROUP_6,
78 I3_GO_GROUP_7,
79 I3_GO_GROUP_8,
80 I3_GO_GROUP_9,
81};
82
83// TODO: Finish the macros for i3 (Macros should potentially be own function instead to make things easier? some of them at least, f. ex. the ones that use 1-0 keys so we can have a single switch)
84
85// TODO: Do stuff with hyper and meh keys
86// TODO: Add macros for lots of stuff. (Lastpass cli, pushbullet cli, other push service cli, linode cli, more?)
87// TODO: Make macros for gnu screen and i3wm
19// TODO: Need to change hotkeys for lastpass, and potentially make my own keys for them on one of my layers 88// TODO: Need to change hotkeys for lastpass, and potentially make my own keys for them on one of my layers
89// TODO: Look into using tap dance
90// TODO: Use leader key for stuff. See https://github.com/qmk/qmk_firmware/wiki
20const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { 91const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
21/* Keymap 0: Basic layer 92/* Keymap 0: Basic layer
22 * 93 *
@@ -29,7 +100,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
29 * |--------+------+------+------+------+------| Hyper| | Meh |------+------+------+------+------+--------| 100 * |--------+------+------+------+------+------| Hyper| | Meh |------+------+------+------+------+--------|
30 * | LShift |Z/Ctrl| X | C | V | B | | | | N | M | , | . |//Ctrl| RShift | 101 * | LShift |Z/Ctrl| X | C | V | B | | | | N | M | , | . |//Ctrl| RShift |
31 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' 102 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
32 * |Grv/L1| '" |AltShf| Lalt | Ralt | | Lalt | Ralt | [ | ] | ~/L1 | 103 * |Grv/L1| UNI |AltShf| Lalt | Ralt | | Lalt | Ralt | LEAD | UNI | ~/L1 |
33 * `----------------------------------' `----------------------------------' 104 * `----------------------------------' `----------------------------------'
34 * ,-------------. ,-------------. 105 * ,-------------. ,-------------.
35 * | App | Home | | PgUp | Ins | 106 * | App | Home | | PgUp | Ins |
@@ -43,11 +114,11 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
43// Otherwise, it needs KC_* 114// Otherwise, it needs KC_*
44[BASE] = KEYMAP( // layer 0 : default 115[BASE] = KEYMAP( // layer 0 : default
45 // left hand 116 // left hand
46 LT(NAVG,KC_ESC), KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, 117 LT(NAVG,KC_ESC), KC_1, KC_2, KC_3, KC_4, KC_5, KC_6,
47 LT(SYMB,KC_TAB), KC_Q, KC_W, KC_E, KC_R, KC_T, TG(SYMB), 118 LT(SYMB,KC_TAB), KC_Q, KC_W, KC_E, KC_R, KC_T, TG(SYMB),
48 KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, 119 KC_LCTL, LT(MDIA, KC_A), KC_S, KC_D, KC_F, KC_G,
49 KC_LSFT, CTL_T(KC_Z), KC_X, KC_C, KC_V, KC_B, ALL_T(KC_NO), 120 KC_LSFT, CTL_T(KC_Z), KC_X, KC_C, KC_V, KC_B, ALL_T(KC_NO),
50 LT(SYMB,KC_GRV),KC_QUOT, LALT(KC_LSFT), KC_RALT,KC_LALT, 121 LT(SYMB,KC_GRV),LCTL(LSFT(KC_U)), LALT(KC_LSFT), KC_RALT,KC_LALT,
51 ALT_T(KC_APP), KC_HOME, 122 ALT_T(KC_APP), KC_HOME,
52 KC_END, 123 KC_END,
53 KC_SPC,KC_TAB,KC_LBRC, 124 KC_SPC,KC_TAB,KC_LBRC,
@@ -56,12 +127,12 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
56 TG(SYMB), KC_Y, KC_U, KC_I, KC_O, KC_P, LT(SYMB, KC_BSLS), 127 TG(SYMB), KC_Y, KC_U, KC_I, KC_O, KC_P, LT(SYMB, KC_BSLS),
57 KC_H, KC_J, KC_K, KC_L, LT(MDIA, KC_SCLN),CTL_T(KC_QUOT), 128 KC_H, KC_J, KC_K, KC_L, LT(MDIA, KC_SCLN),CTL_T(KC_QUOT),
58 MEH_T(KC_NO),KC_N, KC_M, KC_COMM,KC_DOT, CTL_T(KC_SLSH), KC_RSFT, 129 MEH_T(KC_NO),KC_N, KC_M, KC_COMM,KC_DOT, CTL_T(KC_SLSH), KC_RSFT,
59 KC_LALT, KC_RALT,KC_LBRC,KC_RBRC, LT(SYMB,KC_TILD), 130 KC_LALT, KC_RALT,KC_LEAD,LCTL(LSFT(KC_U)), LT(SYMB,KC_TILD),
60 KC_PGUP, KC_INS, 131 KC_PGUP, KC_INS,
61 KC_PGDN, 132 KC_PGDN,
62 KC_RBRC,KC_BSPC, KC_ENT 133 KC_RBRC,KC_BSPC, KC_ENT
63 ), 134 ),
64/* Keymap 1: Symbol Layer 135/* Keymap 1: Symbol Layer LCTL(LSFT(KC_U))
65 * 136 *
66 * ,--------------------------------------------------. ,--------------------------------------------------. 137 * ,--------------------------------------------------. ,--------------------------------------------------.
67 * | | F1 | F2 | F3 | F4 | F5 | F6 | | F6 | F7 | F8 | F9 | F10 | F11 | F12 | 138 * | | F1 | F2 | F3 | F4 | F5 | F6 | | F6 | F7 | F8 | F9 | F10 | F11 | F12 |
@@ -75,11 +146,11 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
75 * | | | | | | | | . | 0 | = | | 146 * | | | | | | | | . | 0 | = | |
76 * `----------------------------------' `----------------------------------' 147 * `----------------------------------' `----------------------------------'
77 * ,-------------. ,-------------. 148 * ,-------------. ,-------------.
78 * | | | | | | 149 * |Toggle|Animat| | Hue+ | Hue- |
79 * ,------|------|------| |------+------+------. 150 * ,------|------|------| |------+------+------.
80 * | | | | | | | | 151 * |Bright|Bright|Solid | | | | |
81 * | | |------| |------| DEL | | 152 * |ness- |ness+ |------| |------| DEL | |
82 * | | | | | | | | 153 * | | | | | EPRM | | |
83 * `--------------------' `--------------------' 154 * `--------------------' `--------------------'
84 */ 155 */
85// SYMBOLS 156// SYMBOLS
@@ -90,27 +161,27 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
90 KC_TRNS,KC_HASH,KC_DLR, KC_LPRN,KC_RPRN,KC_GRV, 161 KC_TRNS,KC_HASH,KC_DLR, KC_LPRN,KC_RPRN,KC_GRV,
91 KC_TRNS,KC_PERC,KC_CIRC,KC_LBRC,KC_RBRC,KC_TILD,KC_TRNS, 162 KC_TRNS,KC_PERC,KC_CIRC,KC_LBRC,KC_RBRC,KC_TILD,KC_TRNS,
92 KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS, 163 KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,KC_TRNS,
93 KC_TRNS,KC_TRNS, 164 RGB_TOG,RGB_MOD,
94 KC_TRNS, 165 F(F_RGB_SLD),
95 KC_TRNS,KC_TRNS,KC_TRNS, 166 RGB_VAD,RGB_VAI,KC_TRNS,
96 // right hand 167 // right hand
97 KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, 168 KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,
98 KC_TRNS, KC_UP, KC_7, KC_8, KC_9, KC_ASTR, KC_TRNS, 169 KC_TRNS, KC_UP, KC_7, KC_8, KC_9, KC_ASTR, KC_TRNS,
99 KC_DOWN, KC_4, KC_5, KC_6, KC_PLUS, KC_TRNS, 170 KC_DOWN, KC_4, KC_5, KC_6, KC_PLUS, KC_TRNS,
100 KC_TRNS, KC_AMPR, KC_1, KC_2, KC_3, KC_BSLS, KC_TRNS, 171 KC_TRNS, KC_AMPR, KC_1, KC_2, KC_3, KC_BSLS, KC_TRNS,
101 KC_TRNS,KC_DOT, KC_0, KC_EQL, KC_TRNS, 172 KC_TRNS,KC_DOT, KC_0, KC_EQL, KC_TRNS,
102 KC_TRNS, KC_TRNS, 173 RGB_HUD, RGB_HUI,
103 KC_TRNS, 174 KC_TRNS,
104 KC_TRNS, KC_DEL, KC_TRNS 175 F(F_EPRM), KC_DEL, KC_TRNS
105), 176),
106/* Keymap 2: Media and mouse keys 177/* Keymap 2: Media, mouse and navigation
107 * 178 *
108 * ,--------------------------------------------------. ,--------------------------------------------------. 179 * ,--------------------------------------------------. ,--------------------------------------------------.
109 * | | | | | | | | | | | | | | | | 180 * | | gg(1)| | | | | | | | | | | | | |
110 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| 181 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
111 * | | | | MsUp | | | | | | | | | | | | 182 * | | | | MsUp | RUN | | | | | | | Up | | | |
112 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| 183 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
113 * | | |MsLeft|MsDown|MsRght| |------| |------| | | | | | Play | 184 * | | |MsLeft|MsDown|MsRght| |------| |------| | Left | Down | Right| | Play |
114 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| 185 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
115 * | | | | | | | | | | | | Prev | Next | | | 186 * | | | | | | | | | | | | Prev | Next | | |
116 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' 187 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
@@ -124,10 +195,10 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
124 * | | | | | | | | 195 * | | | | | | | |
125 * `--------------------' `--------------------' 196 * `--------------------' `--------------------'
126 */ 197 */
127// MEDIA AND MOUSE 198// MEDIA , MOUSE and NAVIGATION
128[MDIA] = KEYMAP( 199[MDIA] = KEYMAP(
129 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 200 KC_TRNS, F(I3_GO_GROUP_1), F(I3_GO_GROUP_2), F(I3_GO_GROUP_3), F(I3_GO_GROUP_4), F(I3_GO_GROUP_5), F(I3_GO_GROUP_6),
130 KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, KC_TRNS, KC_TRNS, KC_TRNS, 201KC_TRNS, KC_TRNS, KC_TRNS, KC_MS_U, M(RUN), KC_TRNS, KC_TRNS,
131 KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS, 202 KC_TRNS, KC_TRNS, KC_MS_L, KC_MS_D, KC_MS_R, KC_TRNS,
132 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 203 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
133 KC_TRNS, KC_TRNS, KC_TRNS, KC_BTN1, KC_BTN2, 204 KC_TRNS, KC_TRNS, KC_TRNS, KC_BTN1, KC_BTN2,
@@ -135,116 +206,280 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
135 KC_TRNS, 206 KC_TRNS,
136 KC_TRNS, KC_TRNS, KC_TRNS, 207 KC_TRNS, KC_TRNS, KC_TRNS,
137 // right hand 208 // right hand
138 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 209 F(I3_GO_GROUP_6), F(I3_GO_GROUP_7), F(I3_GO_GROUP_8), F(I3_GO_GROUP_9), F(I3_GO_GROUP_10), KC_TRNS, KC_TRNS,
139 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 210 KC_TRNS, KC_TRNS, KC_TRNS, KC_UP, KC_TRNS, KC_TRNS, KC_TRNS,
140 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_MPLY, 211 KC_TRNS, KC_LEFT, KC_DOWN, KC_RIGHT, KC_TRNS, KC_MPLY,
141 KC_TRNS, KC_TRNS, KC_TRNS, KC_MPRV, KC_MNXT, KC_TRNS, KC_TRNS, 212 KC_TRNS, KC_TRNS, KC_TRNS, KC_MPRV, KC_MNXT, KC_TRNS, KC_TRNS,
142 KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS, 213 KC_VOLU, KC_VOLD, KC_MUTE, KC_TRNS, KC_TRNS,
143 KC_TRNS, KC_TRNS, 214 KC_TRNS, KC_TRNS,
144 KC_TRNS, 215 KC_TRNS,
145 KC_TRNS, KC_TRNS, KC_WBAK 216 KC_TRNS, KC_TRNS, KC_WBAK
146), 217),
147 218
148/* Keymap 3: Navigation TODO: Printscreen, pg up down, home, end, others? Insert for example 219/* Keymap 3: Unicode
149 * 220 *
150 * ,--------------------------------------------------. ,--------------------------------------------------. 221 * ,--------------------------------------------------. ,--------------------------------------------------.
151 * | | VER | | | | | | | | | | | | | | 222 * | | ┌ | ┐ | └ | ┘ | │ | ─ | | ╔ | ╗ | ╚ | ╝ | ║ | ═ | |
152 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| 223 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
153 * | | | | up | | | | | | | | | | | | 224 * | | shrug| yay | hug | smile|smile2| | | | ■ | λ | → | ➙ | ▻ | █ |
154 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| 225 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
155 * | | | left | down | right| |------| |------| | | | | | | 226 * | | hmm1 | hmm2 | bear1| bear2| fuu |------| |------| ☺ | ☻ | ☹ | ♡ | ♥ | ░ |
156 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| 227 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
157 * | | | | | | | | | | | | | | | | 228 * | | eggy1| eggy2| face1| face2| uhu | | | | ❤ | ☐ | ☑ | ☒ | ✓ | ▄ |
158 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' 229 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
159 * | | | | | | | | | | | | 230 * | | smrk1| smrk2| love | VER | | ✔ | ✗ | ✘ | ● | ▀ |
160 * `----------------------------------' `----------------------------------' 231 * `----------------------------------' `----------------------------------'
161 * ,-------------. ,-------------. 232 * ,-------------. ,-------------.
162 * | | | | | | 233 * | | | | ▒ | ▓ |
163 * ,------|------|------| |------+------+------. 234 * ,------|------|------| |------+------+------.
164 * | | | | | | | | 235 * | | | | | | | |
165 * | | |------| |------| | | 236 * | | |------| |------| | |
166 * | | | | | | | | 237 * | | | | | | | |
167 * `--------------------' `--------------------' 238 * `--------------------' `--------------------'
168 */ 239 */
169// NAVIGATION 240// Unicode
170[NAVG] = KEYMAP( 241[NAVG] = KEYMAP(
171 KC_TRNS, VRSN, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 242 KC_TRNS, UC(0x250c), UC(0x2510), UC(0x2514), UC(0x2518), UC(0x2502), UC(0x2500),
172 KC_TRNS, KC_TRNS, KC_TRNS, KC_UP, KC_TRNS, KC_TRNS, KC_TRNS, 243 KC_TRNS, F(EMOJI_SHRUG), F(EMOJI_YAY), F(EMOJI_HUG), F(EMOJI_SMILE), F(EMOJI_SMILE2), KC_TRNS,
173 KC_TRNS, KC_TRNS, KC_LEFT, KC_DOWN, KC_RGHT, KC_TRNS, 244 KC_TRNS, F(EMOJI_HMM1), F(EMOJI_HMM2), F(EMOJI_BEAR1), F(EMOJI_BEAR2), F(EMOJI_FUU),
174 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 245 KC_TRNS, F(EMOJI_EGGY1), F(EMOJI_EGGY2), F(EMOJI_FACE1), F(EMOJI_FACE2), F(EMOJI_UHU), KC_TRNS,
175 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 246 KC_TRNS, F(EMOJI_SMRK1), F(EMOJI_SMRK2), F(EMOJI_LOVE), F(F_VRSN),
176 KC_TRNS, KC_TRNS, 247 KC_TRNS, KC_TRNS,
177 KC_TRNS, 248 KC_TRNS,
178 KC_TRNS, KC_TRNS, KC_TRNS, 249 KC_TRNS, KC_TRNS, KC_TRNS,
179 // right hand 250 // right hand
180 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 251 UC(0x2554), UC(0x2557), UC(0x255a), UC(0x255d), UC(0x2551), UC(0x2550), KC_TRNS,
181 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 252 KC_TRNS, UC(0x25a0), UC(0x03bb), UC(0x2192), UC(0x2799), UC(0x25bb), UC(0x2588),
182 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 253 UC(0x263a), UC(0x263b), UC(0x2639), UC(0x2661), UC(0x2665), UC(0x2591),
183 KC_TRNS, KC_TRNS, KC_TRNS, KC_MPRV, KC_TRNS, KC_TRNS, KC_TRNS, 254 KC_TRNS, UC(0x2764), UC(0x2610), UC(0x2611), UC(0x2612), UC(0x2713), UC(0x2584),
184 KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, 255 UC(0x2714), UC(0x2717), UC(0x2718), UC(0x25cf), UC(0x2580),
185 KC_TRNS, KC_TRNS, 256 UC(0x2592), UC(0x2593),
186 KC_TRNS, 257 KC_TRNS,
187 KC_TRNS, KC_TRNS, KC_TRNS 258 KC_TRNS, KC_TRNS, KC_TRNS
188), 259),
189}; 260};
190 261
191const uint16_t PROGMEM fn_actions[] = { 262const uint16_t PROGMEM fn_actions[] = {
192 [1] = ACTION_LAYER_TAP_TOGGLE(SYMB) // FN1 - Momentary Layer 1 (Symbols) 263 [EMOJI_SHRUG] = ACTION_FUNCTION_OPT(EMOJI, SHRUG),
264 [EMOJI_YAY] = ACTION_FUNCTION_OPT(EMOJI, YAY),
265 [EMOJI_HUG] = ACTION_FUNCTION_OPT(EMOJI,HUG),
266 [EMOJI_SMILE] = ACTION_FUNCTION_OPT(EMOJI,SMILE),
267 [EMOJI_SMILE2] = ACTION_FUNCTION_OPT(EMOJI,SMILE2),
268 [EMOJI_HMM1] = ACTION_FUNCTION_OPT(EMOJI,HMM1),
269 [EMOJI_HMM2] = ACTION_FUNCTION_OPT(EMOJI,HMM2),
270 [EMOJI_BEAR1] = ACTION_FUNCTION_OPT(EMOJI,BEAR1),
271 [EMOJI_BEAR2] = ACTION_FUNCTION_OPT(EMOJI,BEAR2),
272 [EMOJI_FUU] = ACTION_FUNCTION_OPT(EMOJI,FUU),
273 [EMOJI_EGGY1] = ACTION_FUNCTION_OPT(EMOJI,EGGY1),
274 [EMOJI_EGGY2] = ACTION_FUNCTION_OPT(EMOJI,EGGY2),
275 [EMOJI_FACE1] = ACTION_FUNCTION_OPT(EMOJI,FACE1),
276 [EMOJI_FACE2] = ACTION_FUNCTION_OPT(EMOJI,FACE2),
277 [EMOJI_UHU] = ACTION_FUNCTION_OPT(EMOJI,UHU),
278 [EMOJI_SMRK1] = ACTION_FUNCTION_OPT(EMOJI,SMRK1),
279 [EMOJI_SMRK2] = ACTION_FUNCTION_OPT(EMOJI2,SMRK2),
280 [EMOJI_LOVE] = ACTION_FUNCTION_OPT(EMOJI2,LOVE),
281 [F_EPRM] = ACTION_FUNCTION(EPRM),
282 [F_VRSN] = ACTION_FUNCTION(VRSN),
283 [F_RGB_SLD] = ACTION_FUNCTION(RGB_SLD),
284 [I3_GO_GROUP_10]= ACTION_FUNCTION_OPT(GO_GROUP,0),
285 [I3_GO_GROUP_1] = ACTION_FUNCTION_OPT(GO_GROUP,1),
286 [I3_GO_GROUP_2] = ACTION_FUNCTION_OPT(GO_GROUP,2),
287 [I3_GO_GROUP_3] = ACTION_FUNCTION_OPT(GO_GROUP,3),
288 [I3_GO_GROUP_4] = ACTION_FUNCTION_OPT(GO_GROUP,4),
289 [I3_GO_GROUP_5] = ACTION_FUNCTION_OPT(GO_GROUP,5),
290 [I3_GO_GROUP_6] = ACTION_FUNCTION_OPT(GO_GROUP,6),
291 [I3_GO_GROUP_7] = ACTION_FUNCTION_OPT(GO_GROUP,7),
292 [I3_GO_GROUP_8] = ACTION_FUNCTION_OPT(GO_GROUP,8),
293 [I3_GO_GROUP_9] = ACTION_FUNCTION_OPT(GO_GROUP,9),
193}; 294};
194 295
195const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) 296#define TAP_ONCE(code) \
196{ 297 register_code (code); \
197 // MACRODOWN only works in this function 298 unregister_code (code)
198 switch(id) {
199 case 0:
200 if (record->event.pressed) {
201 SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
202 }
203 break;
204 case 1:
205 if (record->event.pressed) { // For resetting EEPROM
206 eeconfig_init();
207 }
208 break;
209 }
210 return MACRO_NONE;
211};
212 299
213bool process_record_user(uint16_t keycode, keyrecord_t *record) { 300void action_function(keyrecord_t *record, uint8_t id, uint8_t opt) {
214 switch (keycode) { 301 if (record->event.pressed) {
215 // dynamically generate these. 302 switch(id) {
216 case EPRM: 303 case EPRM:
217 if (record->event.pressed) { 304 eeconfig_init();
218 eeconfig_init();
219 }
220 return false;
221 break; 305 break;
222 case VRSN: 306 case VRSN:
223 if (record->event.pressed) { 307 SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
224 SEND_STRING (QMK_KEYBOARD "/" QMK_KEYMAP " @ " QMK_VERSION);
225 }
226 return false;
227 break; 308 break;
228 case RGB_SLD: 309 case RGB_SLD:
229 if (record->event.pressed) { 310#ifdef RGBLIGHT_ENABLE
230 #ifdef RGBLIGHT_ENABLE 311 rgblight_mode(1);
231 rgblight_mode(1); 312#endif
232 #endif 313 break;
314 case GO_GROUP:
315 register_code(KC_LCTL); TAP_ONCE(KC_I); unregister_code(KC_LCTL);
316 TAP_ONCE(KC_G);
317 if (opt == 0) {
318 TAP_ONCE(39);
319 } else {
320 TAP_ONCE(29+opt);
321 }
322 break;
323 case EMOJI:
324 switch(opt) {
325 case SHRUG:
326 unicode_input_start(); register_hex(0xaf); unicode_input_finish();
327 TAP_ONCE (KC_BSLS);
328 register_code (KC_RSFT); TAP_ONCE (KC_MINS); TAP_ONCE (KC_9); unregister_code (KC_RSFT);
329 unicode_input_start (); register_hex(0x30c4); unicode_input_finish();
330 register_code (KC_RSFT); TAP_ONCE (KC_0); TAP_ONCE (KC_MINS); unregister_code (KC_RSFT);
331 TAP_ONCE (KC_SLSH);
332 unicode_input_start (); register_hex(0xaf); unicode_input_finish();
333 break;
334 case YAY:
335 SEND_STRING ("\\o/");
336 break;
337 case HUG:
338 unicode_input_start(); register_hex(0x0f3c); unicode_input_finish();
339 TAP_ONCE (KC_SPC);
340 unicode_input_start(); register_hex(0x3064); unicode_input_finish();
341 TAP_ONCE (KC_SPC);
342 unicode_input_start(); register_hex(0x25d5); unicode_input_finish();
343 unicode_input_start(); register_hex(0x005f); unicode_input_finish();
344 unicode_input_start(); register_hex(0x25d5); unicode_input_finish();
345 TAP_ONCE (KC_SPC);
346 unicode_input_start(); register_hex(0x0f3d); unicode_input_finish();
347 unicode_input_start(); register_hex(0x3064); unicode_input_finish();
348 break;
349 case SMILE:
350 unicode_input_start(); register_hex(0x0298); unicode_input_finish();
351 unicode_input_start(); register_hex(0x203f); unicode_input_finish();
352 unicode_input_start(); register_hex(0x0298); unicode_input_finish();
353 break;
354 case SMILE2:
355 unicode_input_start(); register_hex(0x0028); unicode_input_finish();
356 unicode_input_start(); register_hex(0x0298); unicode_input_finish();
357 unicode_input_start(); register_hex(0x203f); unicode_input_finish();
358 unicode_input_start(); register_hex(0x0298); unicode_input_finish();
359 unicode_input_start(); register_hex(0x0029); unicode_input_finish();
360 break;
361 case HMM1:
362 unicode_input_start(); register_hex(0x0ca0); unicode_input_finish();
363 unicode_input_start(); register_hex(0x005f); unicode_input_finish();
364 unicode_input_start(); register_hex(0x0ca0); unicode_input_finish();
365 break;
366 case HMM2:
367 unicode_input_start(); register_hex(0x0028); unicode_input_finish();
368 unicode_input_start(); register_hex(0x0ca0); unicode_input_finish();
369 unicode_input_start(); register_hex(0x005f); unicode_input_finish();
370 unicode_input_start(); register_hex(0x0ca0); unicode_input_finish();
371 unicode_input_start(); register_hex(0x0029); unicode_input_finish();
372 break;
373 case BEAR1:
374 unicode_input_start(); register_hex(0x0295); unicode_input_finish();
375 unicode_input_start(); register_hex(0x2022); unicode_input_finish();
376 unicode_input_start(); register_hex(0x1d25); unicode_input_finish();
377 unicode_input_start(); register_hex(0x2022); unicode_input_finish();
378 unicode_input_start(); register_hex(0x0294); unicode_input_finish();
379 break;
380 case BEAR2:
381 unicode_input_start(); register_hex(0x0028); unicode_input_finish();
382 unicode_input_start(); register_hex(0x1d54); unicode_input_finish();
383 unicode_input_start(); register_hex(0x1d25); unicode_input_finish();
384 unicode_input_start(); register_hex(0x1d54); unicode_input_finish();
385 unicode_input_start(); register_hex(0x0029); unicode_input_finish();
386 break;
387 case FUU:
388 unicode_input_start(); register_hex(0x256d); unicode_input_finish();
389 unicode_input_start(); register_hex(0x2229); unicode_input_finish();
390 unicode_input_start(); register_hex(0x256e); unicode_input_finish();
391 unicode_input_start(); register_hex(0x0028); unicode_input_finish();
392 unicode_input_start(); register_hex(0x002d); unicode_input_finish();
393 unicode_input_start(); register_hex(0x005f); unicode_input_finish();
394 unicode_input_start(); register_hex(0x002d); unicode_input_finish();
395 unicode_input_start(); register_hex(0x0029); unicode_input_finish();
396 unicode_input_start(); register_hex(0x256d); unicode_input_finish();
397 unicode_input_start(); register_hex(0x2229); unicode_input_finish();
398 unicode_input_start(); register_hex(0x256e); unicode_input_finish();
399 break;
400 case EGGY1:
401 unicode_input_start(); register_hex(0x0028); unicode_input_finish();
402 unicode_input_start(); register_hex(0x256f); unicode_input_finish();
403 unicode_input_start(); register_hex(0x00b0); unicode_input_finish();
404 unicode_input_start(); register_hex(0x25a1); unicode_input_finish();
405 unicode_input_start(); register_hex(0x00b0); unicode_input_finish();
406 unicode_input_start(); register_hex(0xff09); unicode_input_finish();
407 unicode_input_start(); register_hex(0x256f); unicode_input_finish();
408 break;
409 case EGGY2:
410 unicode_input_start(); register_hex(0x30ce); unicode_input_finish();
411 unicode_input_start(); register_hex(0x0028); unicode_input_finish();
412 unicode_input_start(); register_hex(0x0020); unicode_input_finish();
413 unicode_input_start(); register_hex(0x309c); unicode_input_finish();
414 unicode_input_start(); register_hex(0x002d); unicode_input_finish();
415 unicode_input_start(); register_hex(0x309c); unicode_input_finish();
416 unicode_input_start(); register_hex(0x30ce); unicode_input_finish();
417 unicode_input_start(); register_hex(0x0029); unicode_input_finish();
418 break;
419 case FACE1:
420 unicode_input_start(); register_hex(0x0028); unicode_input_finish();
421 unicode_input_start(); register_hex(0x002d); unicode_input_finish();
422 unicode_input_start(); register_hex(0x005f); unicode_input_finish();
423 unicode_input_start(); register_hex(0x002d); unicode_input_finish();
424 unicode_input_start(); register_hex(0x0029); unicode_input_finish();
425 break;
426 case FACE2:
427 unicode_input_start(); register_hex(0x0028); unicode_input_finish();
428 unicode_input_start(); register_hex(0x2022); unicode_input_finish();
429 unicode_input_start(); register_hex(0x005f); unicode_input_finish();
430 unicode_input_start(); register_hex(0x2022); unicode_input_finish();
431 unicode_input_start(); register_hex(0x0029); unicode_input_finish();
432 break;
433 case UHU:
434 unicode_input_start(); register_hex(0x2299); unicode_input_finish();
435 unicode_input_start(); register_hex(0xfe4f); unicode_input_finish();
436 unicode_input_start(); register_hex(0x2299); unicode_input_finish();
437 break;
438 case SMRK1:
439 unicode_input_start(); register_hex(0x005e); unicode_input_finish();
440 unicode_input_start(); register_hex(0x032e); unicode_input_finish();
441 unicode_input_start(); register_hex(0x005e); unicode_input_finish();
442 break;
233 } 443 }
234 return false;
235 break; 444 break;
445 case EMOJI2:
446 switch(opt) {
447 case SMRK2:
448 unicode_input_start(); register_hex(0x0028); unicode_input_finish();
449 unicode_input_start(); register_hex(0x005e); unicode_input_finish();
450 unicode_input_start(); register_hex(0x032e); unicode_input_finish();
451 unicode_input_start(); register_hex(0x005e); unicode_input_finish();
452 unicode_input_start(); register_hex(0x0029); unicode_input_finish();
453 break;
454 case LOVE:
455 unicode_input_start(); register_hex(0x2665); unicode_input_finish();
456 unicode_input_start(); register_hex(0x203f); unicode_input_finish();
457 unicode_input_start(); register_hex(0x2665); unicode_input_finish();
458 break;
459 }
460 break;
461 }
236 } 462 }
237 return true;
238} 463}
239 464
465const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
466 if (record->event.pressed) {
467 switch(id) {
468 case RUN:
469 return MACRO( D(LCTL), T(I), U(LCTL), T(R), END );
470 break;
471 }
472 }
473 return MACRO_NONE;
474};
475
240// Runs just one time when the keyboard initializes. 476// Runs just one time when the keyboard initializes.
241void matrix_init_user(void) { 477void matrix_init_user(void) {
242 478 set_unicode_input_mode(UC_LNX);
243}; 479};
244 480
245// Runs constantly in the background, in a loop. 481// Runs constantly in the background, in a loop.
246void matrix_scan_user(void) { 482void matrix_scan_user(void) {
247
248 uint8_t layer = biton32(layer_state); 483 uint8_t layer = biton32(layer_state);
249 484
250 ergodox_board_led_off(); 485 ergodox_board_led_off();
@@ -254,12 +489,21 @@ void matrix_scan_user(void) {
254 switch (layer) { 489 switch (layer) {
255 case 1: 490 case 1:
256 ergodox_right_led_1_on(); 491 ergodox_right_led_1_on();
492 #ifdef RGBLIGHT_ENABLE
493 rgblight_setrgb(0xff,0x00,0x00);
494 #endif
257 break; 495 break;
258 case 2: 496 case 2:
259 ergodox_right_led_2_on(); 497 ergodox_right_led_2_on();
498 #ifdef RGBLIGHT_ENABLE
499 rgblight_setrgb(0x00,0xff,0x00);
500 #endif
260 break; 501 break;
261 case 3: 502 case 3:
262 ergodox_right_led_3_on(); 503 ergodox_right_led_3_on();
504 #ifdef RGBLIGHT_ENABLE
505 rgblight_setrgb(0x00,0x00,0xff);
506 #endif
263 break; 507 break;
264 case 4: 508 case 4:
265 ergodox_right_led_1_on(); // TODO: Make a fourth layer 509 ergodox_right_led_1_on(); // TODO: Make a fourth layer
diff --git a/keyboards/ergodox/keymaps/deadcyclo/readme.md b/keyboards/ergodox/keymaps/deadcyclo/readme.md
index 809dd6eb5..fa41f0ec1 100644
--- a/keyboards/ergodox/keymaps/deadcyclo/readme.md
+++ b/keyboards/ergodox/keymaps/deadcyclo/readme.md
@@ -1,9 +1,11 @@
1# ErgoDox EZ 1337 configuration 1# ErgoDox EZ 1337 configuration
2 2
3Custom layout based on the default layout. Intended for interational users of us intl-altgr layout. Note that 3Custom layout based on the default layout. Intended for interational
4some common keys might be missing, as this layout is intented to be used on *nix systems by users familiar 4users of us intl-altgr layout. Note that some common keys might be
5with their system. The layout is geared towards avoiding using the rat (mouse for those of you who are 5missing, as this layout is intented to be used on *nix systems by
6unfamiliar with tiling window managers) as much as possibly. 6users familiar with their system. The layout is geared towards
7avoiding using the rat (mouse for those of you who are unfamiliar with
8tiling window managers) as much as possibly.
7 9
8# Layouts 10# Layouts
9 11
@@ -13,24 +15,58 @@ All layer images created using [keyboard-layout-editor](http://www.keyboard-layo
13 15
14[![Base layer](images/deadcyclo-base-layout.png)](http://www.keyboard-layout-editor.com/#/gists/0321b18620180a3e46c498206eb65366) 16[![Base layer](images/deadcyclo-base-layout.png)](http://www.keyboard-layout-editor.com/#/gists/0321b18620180a3e46c498206eb65366)
15 17
16## Layer 1 - Symbols 18The base layer here is marked with the us international alt-gr layout,
19including characters bound to what on an iso keyboard would be alt-gr
20and on an ansi keyboard right alt.
17 21
18[![Layer 1 - Symbols](images/deadcyclo-layer-1-symbols.png)](http://www.keyboard-layout-editor.com/#/gists/96714e198054c9115bafb5267cc6bc73) 22Regular (and irregular) modifier keys are marked with a yellowish
23gray. Layer moderators are marked with blue, red and green, which are
24the same colors each layer displays on the LEDs when active.
19 25
20## Layer 2 - Media and Mouse 26All of the layer switch keys, except for the two center keys marked L1
27TOG, are dual purpose. Hence for example the top left key produces ESC
28if tapped, and temporarilly toggles L3 when hold down. The two center
29L1 TOG keys toggle L1 on and off for more permanent layer toggling.
21 30
22[![Layer 2 - Media and Mouse](images/deadcyclo-layer-2-media-and-mouse.png)](http://www.keyboard-layout-editor.com/#/gists/824759486e378bcec30784309a7e5731) 31The UNI keys enter the linux ibus unicode composer mode
32(ie. Ctrl+Shift+u). Use this to enter unicode characters. Hit the key,
33type in the unicode hex value, and hit enter.
23 34
24## Layer 3 - Navigation 35## Layer 1 - Symbols and RGB
25 36
26[![Layer 3 - Navigation](images/deadcyclo-layer-3-navigation.png)](http://www.keyboard-layout-editor.com/#/gists/67d9613dcd873c68693d11863d0fd289) 37[![Layer 1 - Symbols and RGB](images/deadcyclo-layer-1-symbols.png)](http://www.keyboard-layout-editor.com/#/gists/96714e198054c9115bafb5267cc6bc73)
38
39The Symbols and RGB layer contains function keys, commonly used
40symbols, a numpad and if you have the new Ergodox Ez shine keys for
41controlling various RGB-led functions. In addition, it provides an up
42and a down key for easy scrolling. RGB controller keys are yellow.
43
44## Layer 2 - Media, Mouse and Navigation
45
46[![Layer 2 - Media, Mouse and Navigation](images/deadcyclo-layer-2-media-and-mouse.png)](http://www.keyboard-layout-editor.com/#/gists/824759486e378bcec30784309a7e5731)
47
48The Media, Mouse and unicode layer contains special keys for moving
49the mouse and clicking on it with the keyboard. In addition it
50provides standard media control keys, and default arrow keys.
51
52## Layer 3 - Unicode
53
54[![Layer 3 - Unicode](images/deadcyclo-layer-3-navigation.png)](http://www.keyboard-layout-editor.com/#/gists/67d9613dcd873c68693d11863d0fd289)
55
56The unicode layer provides keys for directly typing unicode (utf-8)
27 57
28# Changelog 58# Changelog
29 59
30- 02.01.2017 Added delete key on second layer 60- 02.01.2017 Added delete key on second layer
31- 10.01.2017 Added layer images to readme 61- 10.01.2017 Added layer images to readme
62- 24.01.2017 Added support for Ergodox Shine. Added secondary L2 switch key on left hand
63- 24.01.2017 Added unicode keys. Added shrug hug and yay. Moved Navigation to layer 2
64- 25.01.2017 Added lots of new emojis and some unicode keys
65- 27.01.2017 Added new unicode keys and shortcut for ibus unicode composer key (CTRL+SHIFT+U)
32 66
33# TODO 67# TODO
34 68
35- Add unicode support (direct input and indirect? see algernon layout for examples) 69- Add macros for lots of stuff. (Lastpass cli, pushbullet cli, other push service cli, linode cli, more?)
36- Add descriptions below each layer image of any special functions/keys 70- Make macros for gnu screen and i3wm
71- Look into the app launch macros in algernon keymap
72
diff --git a/keyboards/ergodox/keymaps/german-kinergo/readme.md b/keyboards/ergodox/keymaps/german-kinergo/readme.md
index 557d85a8a..beb74cf75 100644
--- a/keyboards/ergodox/keymaps/german-kinergo/readme.md
+++ b/keyboards/ergodox/keymaps/german-kinergo/readme.md
@@ -2,7 +2,7 @@
2 2
3This layout is inspired by the "kinesis-qwerty-mod" from benblazak's 3This layout is inspired by the "kinesis-qwerty-mod" from benblazak's
4[ergodox-firmware](https://github.com/benblazak/ergodox-firmware), as well as by the "german" layout from the 4[ergodox-firmware](https://github.com/benblazak/ergodox-firmware), as well as by the "german" layout from the
5[qmk_firmware](https://github.com/jackhumbert/qmk_firmware). 5[qmk_firmware](https://github.com/qmk/qmk_firmware).
6The goal was to have a layout that is pretty close to an ordinary German 6The goal was to have a layout that is pretty close to an ordinary German
7keyboard, so I don't have to make adjustments on the operating system level 7keyboard, so I don't have to make adjustments on the operating system level
8and I keep some of the muscle memory to use a regular keyboard. 8and I keep some of the muscle memory to use a regular keyboard.
diff --git a/keyboards/ergodox/keymaps/mclennon_osx/README.md b/keyboards/ergodox/keymaps/mclennon_osx/README.md
index 60980d043..28cdb7c10 100644
--- a/keyboards/ergodox/keymaps/mclennon_osx/README.md
+++ b/keyboards/ergodox/keymaps/mclennon_osx/README.md
@@ -2,4 +2,4 @@
2 2
3This keymapping is designed to be reasonably familiar to an ordinary Mac keyboard while taking advantage of the Ergodox EZ's features. Caps lock instead enables a layer which allows a user to use HJKL as arrow keys and to control media. Shift and control have additional mappings on S and D to provide easier access while holding down caps lock. 3This keymapping is designed to be reasonably familiar to an ordinary Mac keyboard while taking advantage of the Ergodox EZ's features. Caps lock instead enables a layer which allows a user to use HJKL as arrow keys and to control media. Shift and control have additional mappings on S and D to provide easier access while holding down caps lock.
4 4
5If you choose to compile this yourself, be sure to compile with `#define PREVENT_STUCK_MODIFIERS` in your `config.h`. Firmware built using [qmk_firmware](https://github.com/jackhumbert/qmk_firmware/). 5If you choose to compile this yourself, be sure to compile with `#define PREVENT_STUCK_MODIFIERS` in your `config.h`. Firmware built using [qmk_firmware](https://github.com/qmk/qmk_firmware/).
diff --git a/keyboards/ergodox/keymaps/pvinis/Readme.md b/keyboards/ergodox/keymaps/pvinis/Readme.md
index 2a4a0c8f3..af2721054 100644
--- a/keyboards/ergodox/keymaps/pvinis/Readme.md
+++ b/keyboards/ergodox/keymaps/pvinis/Readme.md
@@ -59,7 +59,7 @@ I have two commented out layers that are just templates, so I can easily create
59# Building 59# Building
60 60
61``` 61```
62$ git clone https://github.com/jackhumbert/qmk_firmware.git 62$ git clone https://github.com/qmk/qmk_firmware.git
63$ cd qmk_firmware/keyboards/ergodox/keymaps/pvinis 63$ cd qmk_firmware/keyboards/ergodox/keymaps/pvinis
64$ make 64$ make
65``` 65```
diff --git a/keyboards/ergodox/keymaps/software_neo2/keymap.c b/keyboards/ergodox/keymaps/software_neo2/keymap.c
index 41ace403d..571ca062c 100644
--- a/keyboards/ergodox/keymaps/software_neo2/keymap.c
+++ b/keyboards/ergodox/keymaps/software_neo2/keymap.c
@@ -1,7 +1,8 @@
1#include "ergodox.h" 1#include "ergodox.h"
2#include "debug.h" 2#include "debug.h"
3#include "led.h"
3#include "action_layer.h" 4#include "action_layer.h"
4#include "keymap_neo2.h" 5#include "keymap_extras/keymap_neo2.h"
5 6
6// Layer names 7// Layer names
7#define BASE 0 // default layer 8#define BASE 0 // default layer
@@ -11,45 +12,45 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
11/* Keymap 0: Basic layer 12/* Keymap 0: Basic layer
12 * 13 *
13 * ,--------------------------------------------------. ,--------------------------------------------------. 14 * ,--------------------------------------------------. ,--------------------------------------------------.
14 * | ^ | 1 | 2 | 3 | 4 | 5 | Play | | Next | 6 | 7 | 8 | 9 | 0 |BackSpce| 15 * | Del | 1 | 2 | 3 | 4 | 5 | Play | | Next | 6 | 7 | 8 | 9 | 0 | ß |
15 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------| 16 * |--------+------+------+------+------+-------------| |------+------+------+------+------+------+--------|
16 * | Del | X | V | L | C | W | L1 | | L1 | K | H | G | F | Q | ß | 17 * | Tab | X | V | L | C | W | Esc | | Esc | K | H | G | F | Q | Y |
17 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------| 18 * |--------+------+------+------+------+------| | | |------+------+------+------+------+--------|
18 * | Caps | U | I | A | E | O |------| |------| S | N | R | T | D | Y | 19 * | NeoL1 | U | I | A | E | O |------| |------| S | N | R | T | D | NeoR1 |
19 * |--------+------+------+------+------+------| Hyper| | Meh |------+------+------+------+------+--------| 20 * |--------+------+------+------+------+------| L1 | | L1 |------+------+------+------+------+--------|
20 * | LShift |Ü/Ctrl| Ö/C-S| Ä/Alt| P | Z | | | | B | M | , | . | J | RShift | 21 * | LShift |Ü/Ctrl| Ö/Win| Ä/Alt| P | Z | | | | B | M | , | . | J | RShift |
21 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------' 22 * `--------+------+------+------+------+-------------' `-------------+------+------+------+------+--------'
22 * | L1 | Home | PgDn | PgUp | End | | Right| Down | Up | Left | Esc | 23 * |NeoL2 | Home | PgDn | PgUp | End | | Right| Down | Up | Left | NeoR2|
23 * `----------------------------------' `----------------------------------' 24 * `----------------------------------' `----------------------------------'
24 * ,-------------. ,-------------. 25 * ,-------------. ,---------------.
25 * | App | LGui | | Alt |Ctrl/Esc| 26 * | App | LGui | | Alt |Ctrl/Esc|
26 * ,------+------+------| |------+--------+------. 27 * ,------+------+------| |------+--------+------.
27 * | | |NeoL2 | |NeoL2 | | | 28 * | | | Enter| |Delete| | |
28 * | Tab |Backsp|------| |------| Space |Enter | 29 * | Space|Backsp|------| |------| Enter |Space |
29 * | |ace |NeoL1 | |NeoL1 | | | 30 * | |ace | Tab | | Esc | | |
30 * `--------------------' `----------------------' 31 * `--------------------' `----------------------'
31 */ 32 */
32// If it accepts an argument (i.e, is a function), it doesn't need KC_. 33// If it accepts an argument (i.e, is a function), it doesn't need KC_.
33// Otherwise, it needs KC_* 34// Otherwise, it needs KC_*
34[BASE] = KEYMAP( // layer 0 : default 35[BASE] = KEYMAP( // layer 0 : default
35 // left hand 36 // left hand
36 KC_CIRC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_MPLY, 37 KC_DELT, NEO_1, NEO_2, NEO_3, NEO_4, NEO_5, KC_MPLY,
37 KC_DELT, NEO_X, NEO_V, NEO_L, NEO_C, NEO_W, TG(1), 38 KC_TAB, NEO_X, NEO_V, NEO_L, NEO_C, NEO_W, KC_ESC,
38 KC_CAPS, NEO_U, NEO_I, NEO_A, NEO_E, NEO_O, 39 NEO_L1_L, NEO_U, NEO_I, NEO_A, NEO_E, NEO_O,
39 KC_LSFT, CTL_T(NEO_UE), C_S_T(NEO_OE), ALT_T(NEO_AE), NEO_P, NEO_Z, ALL_T(KC_NO), 40 KC_LSFT, CTL_T(NEO_UE), GUI_T(NEO_OE), ALT_T(NEO_AE), NEO_P, NEO_Z, TG(1),
40 DE_LESS, KC_HOME, KC_PGDN, KC_PGUP, KC_END, 41 NEO_L2_L, KC_HOME, KC_PGDN, KC_PGUP, KC_END,
41 ALT_T(KC_APP),KC_LGUI, 42 C_S_T(KC_ESC),KC_LGUI,
42 NEO_L2_L, 43 KC_ENT,
43 KC_TAB,KC_BSPC,NEO_L1_L, 44 KC_SPC,KC_BSPC,KC_TAB,
44 // right hand 45 // right hand
45 KC_MNXT, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, 46 KC_MNXT, NEO_6, NEO_7, NEO_8, NEO_9, NEO_0, NEO_SS,
46 TG(1), NEO_K, NEO_H, NEO_G, NEO_F, NEO_Q, NEO_SS, 47 KC_ESC, NEO_K, NEO_H, NEO_G, NEO_F, NEO_Q, NEO_Y,
47 NEO_S, NEO_N, NEO_R, NEO_T, NEO_D, NEO_Y, 48 NEO_S, NEO_N, NEO_R, NEO_T, NEO_D, NEO_L1_R,
48 MEH_T(KC_NO),NEO_B, NEO_M, KC_COMM, KC_DOT, NEO_J, KC_RSFT, 49 TG(1), NEO_B, NEO_M, NEO_COMM, NEO_DOT, NEO_J, KC_RSFT,
49 KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_ESC, 50 KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, NEO_L2_R,
50 KC_LALT,CTL_T(KC_ESC), 51 KC_LALT,KC_RGUI,
51 NEO_L2_R, 52 KC_DELT,
52 NEO_L1_R,KC_SPC, KC_ENT 53 KC_ESC,KC_ENT, KC_SPC
53 ), 54 ),
54/* Keymap 1: Media and mouse keys 55/* Keymap 1: Media and mouse keys
55 * 56 *
@@ -127,13 +128,16 @@ void matrix_scan_user(void) {
127 ergodox_right_led_1_off(); 128 ergodox_right_led_1_off();
128 ergodox_right_led_2_off(); 129 ergodox_right_led_2_off();
129 ergodox_right_led_3_off(); 130 ergodox_right_led_3_off();
131 ergodox_board_led_off();
132
133 if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) {
134 ergodox_right_led_3_on();
135 }
136
130 switch (layer) { 137 switch (layer) {
131 case MDIA: 138 case MDIA:
132 ergodox_right_led_2_on(); 139 ergodox_right_led_2_on();
133 break; 140 break;
134 default:
135 ergodox_board_led_off();
136 break;
137 } 141 }
138 142
139}; 143};
diff --git a/keyboards/ergodox/keymaps/supercoder/readme.md b/keyboards/ergodox/keymaps/supercoder/readme.md
index 8ef96eddf..df39ac7a9 100644
--- a/keyboards/ergodox/keymaps/supercoder/readme.md
+++ b/keyboards/ergodox/keymaps/supercoder/readme.md
@@ -22,7 +22,7 @@ your own:
22 [hex]: https://raw.githubusercontent.com/algernon/ergodox-supercoder/master/supercoder.hex 22 [hex]: https://raw.githubusercontent.com/algernon/ergodox-supercoder/master/supercoder.hex
23 23
24``` 24```
25$ git clone https://github.com/jackhumbert/qmk_firmware.git 25$ git clone https://github.com/qmk/qmk_firmware.git
26$ cd qmk_firmware/keyboards/ergodox 26$ cd qmk_firmware/keyboards/ergodox
27$ git clone https://github.com/algernon/ergodox-supercoder.git keymaps/supercoder 27$ git clone https://github.com/algernon/ergodox-supercoder.git keymaps/supercoder
28$ make KEYMAP=supercoder 28$ make KEYMAP=supercoder
diff --git a/keyboards/ergodox/keymaps/win10_writers-block/readme.md b/keyboards/ergodox/keymaps/win10_writers-block/readme.md
index e51e3c48f..83f91bce2 100644
--- a/keyboards/ergodox/keymaps/win10_writers-block/readme.md
+++ b/keyboards/ergodox/keymaps/win10_writers-block/readme.md
@@ -90,7 +90,7 @@ Your LEDs will change to indicate your layer. You'll know you are in the base la
90 90
91To build, you will need the [QMK][qmk] firmware checked out. from there, dive into `keyboards/ergodox/keymaps/win10_writers-block/` 91To build, you will need the [QMK][qmk] firmware checked out. from there, dive into `keyboards/ergodox/keymaps/win10_writers-block/`
92 92
93[qmk]: https://github.com/jackhumbert/qmk_firmware 93[qmk]: https://github.com/qmk/qmk_firmware
94 94
95``` 95```
96$ make keyboard=ergodox keymap=win10_writers-block 96$ make keyboard=ergodox keymap=win10_writers-block
diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md
index ca3eeba59..45b3354c1 100644
--- a/keyboards/ergodox/readme.md
+++ b/keyboards/ergodox/readme.md
@@ -25,7 +25,7 @@ If none of the existing keymaps suit you, you can create your own custom
25keymap. This will require some experience with coding. Follow these steps 25keymap. This will require some experience with coding. Follow these steps
26to customize a keymap: 26to customize a keymap:
27 27
28 - Read the [qmk firmware README](https://github.com/jackhumbert/qmk_firmware) from top to bottom. Then come back here. :) 28 - Read the [qmk firmware README](https://github.com/qmk/qmk_firmware) from top to bottom. Then come back here. :)
29 29
30 - Clone the qmk_firmware repository 30 - Clone the qmk_firmware repository
31 31
diff --git a/keyboards/hhkb/readme.md b/keyboards/hhkb/readme.md
index 367c0a08f..ee7d11121 100644
--- a/keyboards/hhkb/readme.md
+++ b/keyboards/hhkb/readme.md
@@ -82,7 +82,7 @@ We've added shortcuts to make common modifier/tap (mod-tap) mappings more compac
82 82
83### Remember: These are just aliases 83### Remember: These are just aliases
84 84
85These functions work the same way that their `ACTION_*` functions do - they're just quick aliases. To dig into all of the tmk ACTION_* functions, please see the [TMK documentation](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keymap.md#2-action). 85These functions work the same way that their `ACTION_*` functions do - they're just quick aliases. To dig into all of the tmk ACTION_* functions, please see the [TMK documentation](https://github.com/qmk/qmk_firmware/blob/master/tmk_core/doc/keymap.md#2-action).
86 86
87Instead of using `FNx` when defining `ACTION_*` functions, you can use `F(x)` - the benefit here is being able to use more than 32 function actions (up to 4096), if you happen to need them. 87Instead of using `FNx` when defining `ACTION_*` functions, you can use `F(x)` - the benefit here is being able to use more than 32 function actions (up to 4096), if you happen to need them.
88 88
diff --git a/keyboards/infinity60/infinity60.c b/keyboards/infinity60/infinity60.c
index e471250fe..fdeed5124 100644
--- a/keyboards/infinity60/infinity60.c
+++ b/keyboards/infinity60/infinity60.c
@@ -15,3 +15,18 @@ You should have received a copy of the GNU General Public License
15along with this program. If not, see <http://www.gnu.org/licenses/>. 15along with this program. If not, see <http://www.gnu.org/licenses/>.
16*/ 16*/
17#include "infinity60.h" 17#include "infinity60.h"
18
19void matrix_init_kb(void) {
20 // put your keyboard start-up code here
21 // runs once when the firmware starts up
22
23 matrix_init_user();
24}
25
26void matrix_scan_kb(void) {
27 // put your looping keyboard code here
28 // runs every cycle (a lot)
29
30 matrix_scan_user();
31}
32
diff --git a/keyboards/infinity60/keymaps/default/keymap.c b/keyboards/infinity60/keymaps/default/keymap.c
index 443412857..8347c94b4 100644
--- a/keyboards/infinity60/keymaps/default/keymap.c
+++ b/keyboards/infinity60/keymaps/default/keymap.c
@@ -46,3 +46,12 @@ const uint16_t fn_actions[] = {
46 46
47}; 47};
48 48
49// Runs just one time when the keyboard initializes.
50void matrix_init_user(void) {
51
52};
53
54// Runs constantly in the background, in a loop.
55void matrix_scan_user(void) {
56
57};
diff --git a/keyboards/infinity60/keymaps/depariel/keymap.c b/keyboards/infinity60/keymaps/depariel/keymap.c
index 7412b9b9d..57f9487f2 100755
--- a/keyboards/infinity60/keymaps/depariel/keymap.c
+++ b/keyboards/infinity60/keymaps/depariel/keymap.c
@@ -80,3 +80,12 @@ const uint16_t PROGMEM fn_actions[] = {
80 80
81}; 81};
82 82
83// Runs just one time when the keyboard initializes.
84void matrix_init_user(void) {
85
86};
87
88// Runs constantly in the background, in a loop.
89void matrix_scan_user(void) {
90
91};
diff --git a/keyboards/infinity60/keymaps/hasu/keymap.c b/keyboards/infinity60/keymaps/hasu/keymap.c
index d3728869a..9982078c1 100644
--- a/keyboards/infinity60/keymaps/hasu/keymap.c
+++ b/keyboards/infinity60/keymaps/hasu/keymap.c
@@ -111,3 +111,13 @@ const uint16_t keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
111const uint16_t fn_actions[] = { 111const uint16_t fn_actions[] = {
112 112
113}; 113};
114
115// Runs just one time when the keyboard initializes.
116void matrix_init_user(void) {
117
118};
119
120// Runs constantly in the background, in a loop.
121void matrix_scan_user(void) {
122
123};
diff --git a/keyboards/infinity60/matrix.c b/keyboards/infinity60/matrix.c
index d2f185288..b6ccf86c3 100644
--- a/keyboards/infinity60/matrix.c
+++ b/keyboards/infinity60/matrix.c
@@ -62,6 +62,8 @@ void matrix_init(void)
62#endif 62#endif
63 memset(matrix, 0, MATRIX_ROWS); 63 memset(matrix, 0, MATRIX_ROWS);
64 memset(matrix_debouncing, 0, MATRIX_ROWS); 64 memset(matrix_debouncing, 0, MATRIX_ROWS);
65
66 matrix_init_quantum();
65} 67}
66 68
67uint8_t matrix_scan(void) 69uint8_t matrix_scan(void)
@@ -146,6 +148,7 @@ uint8_t matrix_scan(void)
146 } 148 }
147 debouncing = false; 149 debouncing = false;
148 } 150 }
151 matrix_scan_quantum();
149 return 1; 152 return 1;
150} 153}
151 154
diff --git a/keyboards/planck/keymaps/default/keymap.c b/keyboards/planck/keymaps/default/keymap.c
index ddbe4d7b2..1b1b998b2 100644
--- a/keyboards/planck/keymaps/default/keymap.c
+++ b/keyboards/planck/keymaps/default/keymap.c
@@ -14,13 +14,16 @@ extern keymap_config_t keymap_config;
14// The underscores don't mean anything - you can have a layer called STUFF or any other name. 14// The underscores don't mean anything - you can have a layer called STUFF or any other name.
15// Layer names don't all need to be of the same length, obviously, and you can also skip them 15// Layer names don't all need to be of the same length, obviously, and you can also skip them
16// entirely and just use numbers. 16// entirely and just use numbers.
17#define _QWERTY 0 17
18#define _COLEMAK 1 18enum planck_layers {
19#define _DVORAK 2 19 _QWERTY,
20#define _LOWER 3 20 _COLEMAK,
21#define _RAISE 4 21 _DVORAK,
22#define _PLOVER 5 22 _LOWER,
23#define _ADJUST 16 23 _RAISE,
24 _PLOVER,
25 _ADJUST
26};
24 27
25enum planck_keycodes { 28enum planck_keycodes {
26 QWERTY = SAFE_RANGE, 29 QWERTY = SAFE_RANGE,
diff --git a/keyboards/preonic/keymaps/default/keymap.c b/keyboards/preonic/keymaps/default/keymap.c
index 78b4997a8..3313af945 100644
--- a/keyboards/preonic/keymaps/default/keymap.c
+++ b/keyboards/preonic/keymaps/default/keymap.c
@@ -9,12 +9,15 @@
9// The underscores don't mean anything - you can have a layer called STUFF or any other name. 9// The underscores don't mean anything - you can have a layer called STUFF or any other name.
10// Layer names don't all need to be of the same length, obviously, and you can also skip them 10// Layer names don't all need to be of the same length, obviously, and you can also skip them
11// entirely and just use numbers. 11// entirely and just use numbers.
12#define _QWERTY 0 12
13#define _COLEMAK 1 13enum preonic_layers {
14#define _DVORAK 2 14 _QWERTY,
15#define _LOWER 3 15 _COLEMAK,
16#define _RAISE 4 16 _DVORAK,
17#define _ADJUST 16 17 _LOWER,
18 _RAISE,
19 _ADJUST
20};
18 21
19enum preonic_keycodes { 22enum preonic_keycodes {
20 QWERTY = SAFE_RANGE, 23 QWERTY = SAFE_RANGE,
diff --git a/keyboards/preonic/keymaps/smt/Makefile b/keyboards/preonic/keymaps/smt/Makefile
new file mode 100644
index 000000000..3d4659ceb
--- /dev/null
+++ b/keyboards/preonic/keymaps/smt/Makefile
@@ -0,0 +1,3 @@
1ifndef QUANTUM_DIR
2 include ../../../../Makefile
3endif \ No newline at end of file
diff --git a/keyboards/preonic/keymaps/smt/keymap.c b/keyboards/preonic/keymaps/smt/keymap.c
new file mode 100644
index 000000000..5465d543a
--- /dev/null
+++ b/keyboards/preonic/keymaps/smt/keymap.c
@@ -0,0 +1,247 @@
1#include "preonic.h"
2#include "action_layer.h"
3#include "eeconfig.h"
4#ifdef AUDIO_ENABLE
5 #include "audio.h"
6#endif
7
8// Each layer gets a name for readability, which is then used in the keymap matrix below.
9// The underscores don't mean anything - you can have a layer called STUFF or any other name.
10// Layer names don't all need to be of the same length, obviously, and you can also skip them
11// entirely and just use numbers.
12#define _DVORAK 0
13#define _QWERTY 1
14#define _LOWER 2
15#define _RAISE 3
16#define _ADJUST 16
17
18enum preonic_keycodes {
19 DVORAK = SAFE_RANGE,
20 QWERTY,
21 LOWER,
22 RAISE,
23 BACKLIT
24};
25
26// Fillers to make layering more clear
27#define _______ KC_TRNS
28#define XXXXXXX KC_NO
29
30const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
31
32/* Dvorak
33 * ,-----------------------------------------------------------------------------------.
34 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
35 * |------+------+------+------+------+------+------+------+------+------+------+------|
36 * | Tab | " | , | . | P | Y | F | G | C | R | L | / |
37 * |------+------+------+------+------+-------------+------+------+------+------+------|
38 * | Esc | A | O | E | U | I | D | H | T | N | S | - |
39 * |------+------+------+------+------+------|------+------+------+------+------+------|
40 * | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
41 * |------+------+------+------+------+------+------+------+------+------+------+------|
42 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
43 * `-----------------------------------------------------------------------------------'
44 */
45[_DVORAK] = {
46 {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_BSPC},
47 {KC_TAB, KC_QUOT, KC_COMM, KC_DOT, KC_P, KC_Y, KC_F, KC_G, KC_C, KC_R, KC_L, KC_SLSH},
48 {KC_ESC, KC_A, KC_O, KC_E, KC_U, KC_I, KC_D, KC_H, KC_T, KC_N, KC_S, KC_MINS},
49 {KC_LSFT, KC_SCLN, KC_Q, KC_J, KC_K, KC_X, KC_B, KC_M, KC_W, KC_V, KC_Z, SFT_T(KC_ENT)},
50 {BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT}
51},
52
53/* Qwerty
54 * ,-----------------------------------------------------------------------------------.
55 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
56 * |------+------+------+------+------+------+------+------+------+------+------+------|
57 * | Tab | Q | W | E | R | T | Y | U | I | O | P | Del |
58 * |------+------+------+------+------+-------------+------+------+------+------+------|
59 * | Esc | A | S | D | F | G | H | J | K | L | ; | " |
60 * |------+------+------+------+------+------|------+------+------+------+------+------|
61 * | Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
62 * |------+------+------+------+------+------+------+------+------+------+------+------|
63 * | Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
64 * `-----------------------------------------------------------------------------------'
65 */
66[_QWERTY] = {
67 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______},
68 {_______, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_DEL},
69 {_______, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT},
70 {_______, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, _______},
71 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
72},
73
74/* Lower
75 * ,-----------------------------------------------------------------------------------.
76 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
77 * |------+------+------+------+------+------+------+------+------+------+------+------|
78 * | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
79 * |------+------+------+------+------+-------------+------+------+------+------+------|
80 * | | F1 | F2 | F3 | F4 | F5 | F6 | 4 | 5 | 6 | Home |PageUp|
81 * |------+------+------+------+------+------|------+------+------+------+------+------|
82 * | | F7 | F8 | F9 | F10 | F11 | F12 | 1 | 2 | 3 | End |PageDn|
83 * |------+------+------+------+------+------+------+------+------+------+------+------|
84 * | | | | | | | | Next | Vol- | Vol+ | Play |
85 * `-----------------------------------------------------------------------------------'
86 */
87[_LOWER] = {
88 {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL},
89 {KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL},
90 {_______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_4, KC_5, KC_6, KC_HOME, KC_PGUP},
91 {_______, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_1, KC_2, KC_3, KC_END, KC_PGDN},
92 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
93},
94
95/* Raise
96 * ,-----------------------------------------------------------------------------------.
97 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Del |
98 * |------+------+------+------+------+-------------+------+------+------+------+------|
99 * | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Del |
100 * |------+------+------+------+------+-------------+------+------+------+------+------|
101 * | | | | | | | | _ | + | { | } | | |
102 * |------+------+------+------+------+------|------+------+------+------+------+------|
103 * | | | | | | | | - | = | [ | ] | \ |
104 * |------+------+------+------+------+------+------+------+------+------+------+------|
105 * | | | | | | | | Next | Vol- | Vol+ | Play |
106 * `-----------------------------------------------------------------------------------'
107 */
108[_RAISE] = {
109 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL},
110 {KC_TILD, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_DEL},
111 {_______, _______, _______, _______, _______, _______, _______, KC_UNDS, KC_PLUS, KC_LCBR, KC_RCBR, KC_PIPE},
112 {_______, _______, _______, _______, _______, _______, _______, KC_MINS, KC_EQL, KC_LBRC, KC_RBRC, KC_BSLS},
113 {_______, _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY}
114},
115
116/* Adjust (Lower + Raise)
117 * ,-----------------------------------------------------------------------------------.
118 * | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 |
119 * |------+------+------+------+------+------+------+------+------+------+------+------|
120 * | | Reset| | | | | | | | | | Del |
121 * |------+------+------+------+------+-------------+------+------+------+------+------|
122 * | | | |Aud on|AudOff|AGnorm|AGswap|Dvorak|Qwerty| | | |
123 * |------+------+------+------+------+------|------+------+------+------+------+------|
124 * | |Voice-|Voice+|Mus on|MusOff|MidiOn|MidOff| | | | | |
125 * |------+------+------+------+------+------+------+------+------+------+------+------|
126 * | | | | | | | | | | | |
127 * `-----------------------------------------------------------------------------------'
128 */
129[_ADJUST] = {
130 {KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12},
131 {_______, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_DEL},
132 {_______, _______, _______, AU_ON, AU_OFF, AG_NORM, AG_SWAP, DVORAK, QWERTY, _______, _______, _______},
133 {_______, MUV_DE, MUV_IN, MU_ON, MU_OFF, MI_ON, MI_OFF, _______, _______, _______, _______, _______},
134 {_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______}
135}
136
137
138};
139
140#ifdef AUDIO_ENABLE
141float tone_startup[][2] = {
142 {NOTE_B5, 20},
143 {NOTE_B6, 8},
144 {NOTE_DS6, 20},
145 {NOTE_B6, 8}
146};
147
148float tone_dvorak[][2] = SONG(DVORAK_SOUND);
149float tone_qwerty[][2] = SONG(QWERTY_SOUND);
150
151float tone_goodbye[][2] = SONG(GOODBYE_SOUND);
152
153float music_scale[][2] = SONG(MUSIC_SCALE_SOUND);
154#endif
155
156void persistant_default_layer_set(uint16_t default_layer) {
157 eeconfig_update_default_layer(default_layer);
158 default_layer_set(default_layer);
159}
160
161bool process_record_user(uint16_t keycode, keyrecord_t *record) {
162 switch (keycode) {
163 case DVORAK:
164 if (record->event.pressed) {
165 #ifdef AUDIO_ENABLE
166 PLAY_NOTE_ARRAY(tone_dvorak, false, 0);
167 #endif
168 persistant_default_layer_set(1UL<<_DVORAK);
169 }
170 return false;
171 break;
172 case QWERTY:
173 if (record->event.pressed) {
174 #ifdef AUDIO_ENABLE
175 PLAY_NOTE_ARRAY(tone_qwerty, false, 0);
176 #endif
177 persistant_default_layer_set(1UL<<_QWERTY);
178 }
179 return false;
180 break;
181 case LOWER:
182 if (record->event.pressed) {
183 layer_on(_LOWER);
184 update_tri_layer(_LOWER, _RAISE, _ADJUST);
185 } else {
186 layer_off(_LOWER);
187 update_tri_layer(_LOWER, _RAISE, _ADJUST);
188 }
189 return false;
190 break;
191 case RAISE:
192 if (record->event.pressed) {
193 layer_on(_RAISE);
194 update_tri_layer(_LOWER, _RAISE, _ADJUST);
195 } else {
196 layer_off(_RAISE);
197 update_tri_layer(_LOWER, _RAISE, _ADJUST);
198 }
199 return false;
200 break;
201 case BACKLIT:
202 if (record->event.pressed) {
203 register_code(KC_RSFT);
204 #ifdef BACKLIGHT_ENABLE
205 backlight_step();
206 #endif
207 } else {
208 unregister_code(KC_RSFT);
209 }
210 return false;
211 break;
212 }
213 return true;
214};
215
216void matrix_init_user(void) {
217 #ifdef AUDIO_ENABLE
218 startup_user();
219 #endif
220}
221
222#ifdef AUDIO_ENABLE
223
224void startup_user()
225{
226 _delay_ms(20); // gets rid of tick
227 PLAY_NOTE_ARRAY(tone_startup, false, 0);
228}
229
230void shutdown_user()
231{
232 PLAY_NOTE_ARRAY(tone_goodbye, false, 0);
233 _delay_ms(150);
234 stop_all_notes();
235}
236
237void music_on_user(void)
238{
239 music_scale_user();
240}
241
242void music_scale_user(void)
243{
244 PLAY_NOTE_ARRAY(music_scale, false, 0);
245}
246
247#endif
diff --git a/keyboards/preonic/keymaps/smt/readme.md b/keyboards/preonic/keymaps/smt/readme.md
new file mode 100644
index 000000000..2dcc1927f
--- /dev/null
+++ b/keyboards/preonic/keymaps/smt/readme.md
@@ -0,0 +1,85 @@
1# smt's Preonic keymap
2
3This keymap is primarily based on the default Preonic keymap, which in turn is derived from Planck's default.
4
5Notable differences from the default are:
6
71. **Dvorak by default**
8
9 I happen to type in Dvorak, and prefer that layer to be the default on my keyboard. This is easy enough to switch around with Qwerty, Colemak, or whatever.
10
112. **Right Shift**
12
13 I use both the left and right shift keys when I type. When I want to modify a key with shift, I hold shift with the hand opposite the one typing the key. In the default keymap, Enter is where shift would be on a standard keyboard layout. Oh, muscle memory.
14
15 Thankfully, QMK supports [mod-tap](https://github.com/qmk/qmk_firmware/wiki#fun-with-modifier-keys) keys, and this allows me to set the Enter key to send a modifier (MOD_LSFT) when held, and KC_ENT when tapped. Awesome!
16
17## Dvorak (default)
18
19```
20,-----------------------------------------------------------------------------------.
21| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
22|------+------+------+------+------+------+------+------+------+------+------+------|
23| Tab | " | , | . | P | Y | F | G | C | R | L | / |
24|------+------+------+------+------+-------------+------+------+------+------+------|
25| Esc | A | O | E | U | I | D | H | T | N | S | - |
26|------+------+------+------+------+------|------+------+------+------+------+------|
27| Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
28|------+------+------+------+------+------+------+------+------+------+------+------|
29| Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
30`-----------------------------------------------------------------------------------'
31```
32
33## Qwerty (same as default)
34
35```
36,-----------------------------------------------------------------------------------.
37| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Bksp |
38|------+------+------+------+------+------+------+------+------+------+------+------|
39| Tab | Q | W | E | R | T | Y | U | I | O | P | Del |
40|------+------+------+------+------+-------------+------+------+------+------+------|
41| Esc | A | S | D | F | G | H | J | K | L | ; | " |
42|------+------+------+------+------+------|------+------+------+------+------+------|
43| Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
44|------+------+------+------+------+------+------+------+------+------+------+------|
45| Brite| Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
46`-----------------------------------------------------------------------------------'
47```
48
49## Lower
50
51This is where I put the number row, a numpad cluster, function keys, and some light navigation via Home/End/PageUp/PageDn. Like the "Raise" layer, the top row is redundant to help with Planck compatibility.
52
53```
54,-----------------------------------------------------------------------------------.
55| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
56|------+------+------+------+------+------+------+------+------+------+------+------|
57| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
58|------+------+------+------+------+-------------+------+------+------+------+------|
59| | F1 | F2 | F3 | F4 | F5 | F6 | 4 | 5 | 6 | Home |PageUp|
60|------+------+------+------+------+------|------+------+------+------+------+------|
61| | F7 | F8 | F9 | F10 | F11 | F12 | 1 | 2 | 3 | End |PageDn|
62|------+------+------+------+------+------+------+------+------+------+------+------|
63| | | | | | | | Next | Vol- | Vol+ | Play |
64`-----------------------------------------------------------------------------------'
65```
66
67## Raise
68
69As a developer, it makes the most sense for me to group all the commonly-used symbols that don't fit on the main layer. In particular, having the dual-column of parens-braces-brackets really helps a lot.
70
71I haven't completely filled this layer, which leaves room for future mappings and macros.
72
73```
74,-----------------------------------------------------------------------------------.
75| ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Del |
76|------+------+------+------+------+-------------+------+------+------+------+------|
77| ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Del |
78|------+------+------+------+------+-------------+------+------+------+------+------|
79| | | | | | | | _ | + | { | } | | |
80|------+------+------+------+------+------|------+------+------+------+------+------|
81| | | | | | | | - | = | [ | ] | \ |
82|------+------+------+------+------+------+------+------+------+------+------+------|
83| | | | | | | | Next | Vol- | Vol+ | Play |
84`-----------------------------------------------------------------------------------'
85```
diff --git a/keyboards/s60-x/readme.md b/keyboards/s60-x/readme.md
index 94ce82922..408ad13ac 100644
--- a/keyboards/s60-x/readme.md
+++ b/keyboards/s60-x/readme.md
@@ -13,7 +13,7 @@ You only need to flash them onto your keyboard, which is explained below, there'
13## Flashing your keyboard 13## Flashing your keyboard
14The recommended programs for flashing your keyboard are [Atmel FLIP](http://www.atmel.com/tools/FLIP.aspx) (Windows) and [dfu-programmer](http://dfu-programmer.sourceforge.net/) (Linux/Windows). 14The recommended programs for flashing your keyboard are [Atmel FLIP](http://www.atmel.com/tools/FLIP.aspx) (Windows) and [dfu-programmer](http://dfu-programmer.sourceforge.net/) (Linux/Windows).
15 15
16[QMK Firmware Flasher](https://github.com/jackhumbert/qmk_firmware_flasher/releases) may work, as the S60-X keyboard uses the ATMega32U4 microcontroller, but it is untested. Use at your own risk. 16[QMK Firmware Flasher](https://github.com/qmk/qmk_firmware_flasher/releases) may work, as the S60-X keyboard uses the ATMega32U4 microcontroller, but it is untested. Use at your own risk.
17 17
18[Easy AVR USB Keyboard Firmware](https://deskthority.net/wiki/Easy_AVR_USB_Keyboard_Firmware) also supports S60-X, but it is completely unrelated to TMK firmware. Use at your own risk. 18[Easy AVR USB Keyboard Firmware](https://deskthority.net/wiki/Easy_AVR_USB_Keyboard_Firmware) also supports S60-X, but it is completely unrelated to TMK firmware. Use at your own risk.
19 19
diff --git a/quantum/keymap_extras/keymap_br_abnt2.h b/quantum/keymap_extras/keymap_br_abnt2.h
index 0df177721..b001139dd 100644
--- a/quantum/keymap_extras/keymap_br_abnt2.h
+++ b/quantum/keymap_extras/keymap_br_abnt2.h
@@ -1,3 +1,19 @@
1/* Copyright 2017 Potiguar Faga
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
1#ifndef KEYMAP_BR_ABNT2_H 17#ifndef KEYMAP_BR_ABNT2_H
2#define KEYMAP_BR_ABNT2_H 18#define KEYMAP_BR_ABNT2_H
3 19
diff --git a/quantum/process_keycode/process_tap_dance.c b/quantum/process_keycode/process_tap_dance.c
index 6ae362c4c..403dca538 100644
--- a/quantum/process_keycode/process_tap_dance.c
+++ b/quantum/process_keycode/process_tap_dance.c
@@ -43,12 +43,16 @@ static inline void process_tap_dance_action_on_dance_finished (qk_tap_dance_acti
43 if (action->state.finished) 43 if (action->state.finished)
44 return; 44 return;
45 action->state.finished = true; 45 action->state.finished = true;
46 add_mods(action->state.oneshot_mods);
47 send_keyboard_report();
46 _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_dance_finished); 48 _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_dance_finished);
47} 49}
48 50
49static inline void process_tap_dance_action_on_reset (qk_tap_dance_action_t *action) 51static inline void process_tap_dance_action_on_reset (qk_tap_dance_action_t *action)
50{ 52{
51 _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_reset); 53 _process_tap_dance_action_fn (&action->state, action->user_data, action->fn.on_reset);
54 del_mods(action->state.oneshot_mods);
55 send_keyboard_report();
52} 56}
53 57
54bool process_tap_dance(uint16_t keycode, keyrecord_t *record) { 58bool process_tap_dance(uint16_t keycode, keyrecord_t *record) {
@@ -70,6 +74,7 @@ bool process_tap_dance(uint16_t keycode, keyrecord_t *record) {
70 action->state.keycode = keycode; 74 action->state.keycode = keycode;
71 action->state.count++; 75 action->state.count++;
72 action->state.timer = timer_read(); 76 action->state.timer = timer_read();
77 action->state.oneshot_mods = get_oneshot_mods();
73 process_tap_dance_action_on_each_tap (action); 78 process_tap_dance_action_on_each_tap (action);
74 79
75 if (last_td && last_td != keycode) { 80 if (last_td && last_td != keycode) {
@@ -109,7 +114,7 @@ void matrix_scan_tap_dance () {
109 if (highest_td == -1) 114 if (highest_td == -1)
110 return; 115 return;
111 116
112 for (int i = 0; i <= highest_td; i++) { 117for (int i = 0; i <= highest_td; i++) {
113 qk_tap_dance_action_t *action = &tap_dance_actions[i]; 118 qk_tap_dance_action_t *action = &tap_dance_actions[i];
114 119
115 if (action->state.count && timer_elapsed (action->state.timer) > TAPPING_TERM) { 120 if (action->state.count && timer_elapsed (action->state.timer) > TAPPING_TERM) {
diff --git a/quantum/process_keycode/process_tap_dance.h b/quantum/process_keycode/process_tap_dance.h
index f753cbba6..726752ecc 100644
--- a/quantum/process_keycode/process_tap_dance.h
+++ b/quantum/process_keycode/process_tap_dance.h
@@ -9,6 +9,7 @@
9typedef struct 9typedef struct
10{ 10{
11 uint8_t count; 11 uint8_t count;
12 uint8_t oneshot_mods;
12 uint16_t keycode; 13 uint16_t keycode;
13 uint16_t timer; 14 uint16_t timer;
14 bool interrupted; 15 bool interrupted;
diff --git a/quantum/visualizer/visualizer.c b/quantum/visualizer/visualizer.c
index 54f6faaa4..5826d909e 100644
--- a/quantum/visualizer/visualizer.c
+++ b/quantum/visualizer/visualizer.c
@@ -53,10 +53,13 @@ SOFTWARE.
53#define "Visualizer thread priority not defined" 53#define "Visualizer thread priority not defined"
54#endif 54#endif
55 55
56// mods status
57#include "action_util.h"
56 58
57static visualizer_keyboard_status_t current_status = { 59static visualizer_keyboard_status_t current_status = {
58 .layer = 0xFFFFFFFF, 60 .layer = 0xFFFFFFFF,
59 .default_layer = 0xFFFFFFFF, 61 .default_layer = 0xFFFFFFFF,
62 .mods = 0xFF,
60 .leds = 0xFFFFFFFF, 63 .leds = 0xFFFFFFFF,
61 .suspended = false, 64 .suspended = false,
62}; 65};
@@ -64,6 +67,7 @@ static visualizer_keyboard_status_t current_status = {
64static bool same_status(visualizer_keyboard_status_t* status1, visualizer_keyboard_status_t* status2) { 67static bool same_status(visualizer_keyboard_status_t* status1, visualizer_keyboard_status_t* status2) {
65 return status1->layer == status2->layer && 68 return status1->layer == status2->layer &&
66 status1->default_layer == status2->default_layer && 69 status1->default_layer == status2->default_layer &&
70 status1->mods == status2->mods &&
67 status1->leds == status2->leds && 71 status1->leds == status2->leds &&
68 status1->suspended == status2->suspended; 72 status1->suspended == status2->suspended;
69} 73}
@@ -307,6 +311,45 @@ bool keyframe_display_layer_bitmap(keyframe_animation_t* animation, visualizer_s
307 gdispFlush(); 311 gdispFlush();
308 return false; 312 return false;
309} 313}
314
315static void format_mods_bitmap_string(uint8_t mods, char* buffer) {
316 *buffer = ' ';
317 ++buffer;
318
319 for (int i = 0; i<8; i++)
320 {
321 uint32_t mask = (1u << i);
322 if (mods & mask) {
323 *buffer = '1';
324 } else {
325 *buffer = '0';
326 }
327 ++buffer;
328
329 if (i==3) {
330 *buffer = ' ';
331 ++buffer;
332 }
333 }
334 *buffer = 0;
335}
336
337bool keyframe_display_mods_bitmap(keyframe_animation_t* animation, visualizer_state_t* state) {
338 (void)animation;
339
340 const char* title = "Modifier states";
341 const char* mods_header = " CSAG CSAG ";
342 char status_buffer[12];
343
344 gdispClear(White);
345 gdispDrawString(0, 0, title, state->font_fixed5x8, Black);
346 gdispDrawString(0, 10, mods_header, state->font_fixed5x8, Black);
347 format_mods_bitmap_string(state->status.mods, status_buffer);
348 gdispDrawString(0, 20, status_buffer, state->font_fixed5x8, Black);
349
350 gdispFlush();
351 return false;
352}
310#endif // LCD_ENABLE 353#endif // LCD_ENABLE
311 354
312bool keyframe_disable_lcd_and_backlight(keyframe_animation_t* animation, visualizer_state_t* state) { 355bool keyframe_disable_lcd_and_backlight(keyframe_animation_t* animation, visualizer_state_t* state) {
@@ -350,6 +393,7 @@ static DECLARE_THREAD_FUNCTION(visualizerThread, arg) {
350 visualizer_keyboard_status_t initial_status = { 393 visualizer_keyboard_status_t initial_status = {
351 .default_layer = 0xFFFFFFFF, 394 .default_layer = 0xFFFFFFFF,
352 .layer = 0xFFFFFFFF, 395 .layer = 0xFFFFFFFF,
396 .mods = 0xFF,
353 .leds = 0xFFFFFFFF, 397 .leds = 0xFFFFFFFF,
354 .suspended = false, 398 .suspended = false,
355 }; 399 };
@@ -499,7 +543,18 @@ void update_status(bool changed) {
499#endif 543#endif
500} 544}
501 545
502void visualizer_update(uint32_t default_state, uint32_t state, uint32_t leds) { 546uint8_t visualizer_get_mods() {
547 uint8_t mods = get_mods();
548
549#ifndef NO_ACTION_ONESHOT
550 if (!has_oneshot_mods_timed_out()) {
551 mods |= get_oneshot_mods();
552 }
553#endif
554 return mods;
555}
556
557void visualizer_update(uint32_t default_state, uint32_t state, uint8_t mods, uint32_t leds) {
503 // Note that there's a small race condition here, the thread could read 558 // Note that there's a small race condition here, the thread could read
504 // a state where one of these are set but not the other. But this should 559 // a state where one of these are set but not the other. But this should
505 // not really matter as it will be fixed during the next loop step. 560 // not really matter as it will be fixed during the next loop step.
@@ -523,6 +578,7 @@ void visualizer_update(uint32_t default_state, uint32_t state, uint32_t leds) {
523 visualizer_keyboard_status_t new_status = { 578 visualizer_keyboard_status_t new_status = {
524 .layer = state, 579 .layer = state,
525 .default_layer = default_state, 580 .default_layer = default_state,
581 .mods = mods,
526 .leds = leds, 582 .leds = leds,
527 .suspended = current_status.suspended, 583 .suspended = current_status.suspended,
528 }; 584 };
diff --git a/quantum/visualizer/visualizer.h b/quantum/visualizer/visualizer.h
index 53e250725..315af5022 100644
--- a/quantum/visualizer/visualizer.h
+++ b/quantum/visualizer/visualizer.h
@@ -34,10 +34,14 @@ SOFTWARE.
34#include "lcd_backlight.h" 34#include "lcd_backlight.h"
35#endif 35#endif
36 36
37// use this function to merget both real_mods and oneshot_mods in a uint16_t
38uint8_t visualizer_get_mods(void);
39
37// This need to be called once at the start 40// This need to be called once at the start
38void visualizer_init(void); 41void visualizer_init(void);
39// This should be called at every matrix scan 42// This should be called at every matrix scan
40void visualizer_update(uint32_t default_state, uint32_t state, uint32_t leds); 43void visualizer_update(uint32_t default_state, uint32_t state, uint8_t mods, uint32_t leds);
44
41// This should be called when the keyboard goes to suspend state 45// This should be called when the keyboard goes to suspend state
42void visualizer_suspend(void); 46void visualizer_suspend(void);
43// This should be called when the keyboard wakes up from suspend state 47// This should be called when the keyboard wakes up from suspend state
@@ -61,6 +65,7 @@ struct keyframe_animation_t;
61typedef struct { 65typedef struct {
62 uint32_t layer; 66 uint32_t layer;
63 uint32_t default_layer; 67 uint32_t default_layer;
68 uint8_t mods;
64 uint32_t leds; // See led.h for available statuses 69 uint32_t leds; // See led.h for available statuses
65 bool suspended; 70 bool suspended;
66} visualizer_keyboard_status_t; 71} visualizer_keyboard_status_t;
@@ -129,6 +134,8 @@ bool keyframe_set_backlight_color(keyframe_animation_t* animation, visualizer_st
129bool keyframe_display_layer_text(keyframe_animation_t* animation, visualizer_state_t* state); 134bool keyframe_display_layer_text(keyframe_animation_t* animation, visualizer_state_t* state);
130// Displays a bitmap (0/1) of all the currently active layers 135// Displays a bitmap (0/1) of all the currently active layers
131bool keyframe_display_layer_bitmap(keyframe_animation_t* animation, visualizer_state_t* state); 136bool keyframe_display_layer_bitmap(keyframe_animation_t* animation, visualizer_state_t* state);
137// Displays a bitmap (0/1) of all the currently active mods
138bool keyframe_display_mods_bitmap(keyframe_animation_t* animation, visualizer_state_t* state);
132 139
133bool keyframe_disable_lcd_and_backlight(keyframe_animation_t* animation, visualizer_state_t* state); 140bool keyframe_disable_lcd_and_backlight(keyframe_animation_t* animation, visualizer_state_t* state);
134bool keyframe_enable_lcd_and_backlight(keyframe_animation_t* animation, visualizer_state_t* state); 141bool keyframe_enable_lcd_and_backlight(keyframe_animation_t* animation, visualizer_state_t* state);
diff --git a/readme.md b/readme.md
index d33c3ad01..71f756667 100644
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,6 @@
1# Quantum Mechanical Keyboard Firmware 1# Quantum Mechanical Keyboard Firmware
2 2
3[![Build Status](https://travis-ci.org/jackhumbert/qmk_firmware.svg?branch=master)](https://travis-ci.org/jackhumbert/qmk_firmware) 3[![Build Status](https://travis-ci.org/jackhumbert/qmk_firmware.svg?branch=master)](https://travis-ci.org/jackhumbert/qmk_firmware) [![Gitter](https://badges.gitter.im/qmk/qmk_firmware.svg)](https://gitter.im/qmk/qmk_firmware?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
4 4
5This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). 5This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/).
6 6
@@ -23,7 +23,7 @@ The project also includes community support for [lots of other keyboards](/keybo
23 23
24QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). This repo used to be a fork of [TMK](https://github.com/tmk/tmk_keyboard), and we are incredibly grateful for his founding contributions to the firmware. We've had to break the fork due to purely technical reasons - it simply became too different over time, and we've had to start refactoring some of the basic bits and pieces. We are huge fans of TMK and Hasu :) 24QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). This repo used to be a fork of [TMK](https://github.com/tmk/tmk_keyboard), and we are incredibly grateful for his founding contributions to the firmware. We've had to break the fork due to purely technical reasons - it simply became too different over time, and we've had to start refactoring some of the basic bits and pieces. We are huge fans of TMK and Hasu :)
25 25
26This documentation is edited and maintained by Erez Zukerman of ErgoDox EZ. If you spot any typos or inaccuracies, please [open an issue](https://github.com/jackhumbert/qmk_firmware/issues/new). 26This documentation is edited and maintained by Erez Zukerman of ErgoDox EZ. If you spot any typos or inaccuracies, please [open an issue](https://github.com/qmk/qmk_firmware/issues/new).
27 27
28The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [Erez Zukerman](https://github.com/ezuk), and the Clueboard by [Zach White](https://github.com/skullydazed). 28The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [Erez Zukerman](https://github.com/ezuk), and the Clueboard by [Zach White](https://github.com/skullydazed).
29 29
@@ -31,7 +31,7 @@ The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/j
31 31
32This is not a tiny project. While this is the main readme, there are many other files you might want to consult. Here are some points of interest: 32This is not a tiny project. While this is the main readme, there are many other files you might want to consult. Here are some points of interest:
33 33
34* [**The Wiki**](https://github.com/jackhumbert/qmk_firmware/wiki) - the entirety of the readme has been moved here 34* [**The Wiki**](https://github.com/qmk/qmk_firmware/wiki) - the entirety of the readme has been moved here
35* The readme for your own keyboard: This is found under `keyboards/<your keyboards's name>/`. So for the ErgoDox EZ, it's [here](keyboards/ergodox/ez/); for the Planck, it's [here](keyboards/planck/) and so on. 35* The readme for your own keyboard: This is found under `keyboards/<your keyboards's name>/`. So for the ErgoDox EZ, it's [here](keyboards/ergodox/ez/); for the Planck, it's [here](keyboards/planck/) and so on.
36* The list of possible keycodes you can use in your keymap is actually spread out in a few different places: 36* The list of possible keycodes you can use in your keymap is actually spread out in a few different places:
37 * [doc/keycode.txt](doc/keycode.txt) - an explanation of those same keycodes. 37 * [doc/keycode.txt](doc/keycode.txt) - an explanation of those same keycodes.
diff --git a/tmk_core/common/keyboard.c b/tmk_core/common/keyboard.c
index 371d93f3e..765350792 100644
--- a/tmk_core/common/keyboard.c
+++ b/tmk_core/common/keyboard.c
@@ -188,7 +188,7 @@ MATRIX_LOOP_END:
188#endif 188#endif
189 189
190#ifdef VISUALIZER_ENABLE 190#ifdef VISUALIZER_ENABLE
191 visualizer_update(default_layer_state, layer_state, host_keyboard_leds()); 191 visualizer_update(default_layer_state, layer_state, visualizer_get_mods(), host_keyboard_leds());
192#endif 192#endif
193 193
194 // update LED 194 // update LED
diff --git a/util/travis_compiled_push.sh b/util/travis_compiled_push.sh
index f432976d0..b70999c72 100644
--- a/util/travis_compiled_push.sh
+++ b/util/travis_compiled_push.sh
@@ -7,21 +7,48 @@ rev=$(git rev-parse --short HEAD)
7git config --global user.name "Travis CI" 7git config --global user.name "Travis CI"
8git config --global user.email "jack.humb+travis.ci@gmail.com" 8git config --global user.email "jack.humb+travis.ci@gmail.com"
9 9
10make ergodox-ez AUTOGEN=true 10if [[ "$TRAVIS_BRANCH" == "master" ]] ; then
11 11
12find . -name ".build" | xargs rm -rf 12increment_version ()
13cd .. 13{
14git clone https://$GH_TOKEN@github.com/jackhumbert/qmk.fm.git 14 declare -a part=( ${1//\./ } )
15cd qmk.fm 15 part[2]=$((part[2] + 1))
16git submodule update --init --recursive 16 new="${part[*]}"
17rm -rf keyboard 17 echo -e "${new// /.}"
18rm -rf keyboards 18}
19cp -r ../qmk_firmware/keyboards . 19
20mkdir keyboards/ergodox_ez/ 20NEFM=$(git diff --name-only -n 1 ${TRAVIS_COMMIT_RANGE} | grep -Ev '^(keyboards/)' | wc -l)
21cp ../qmk_firmware/util/ergodox_ez.html keyboards/ergodox_ez/index.html 21if [[ $NEFM -gt 0 ]] ; then
22cp ../qmk_firmware/readme.md qmk_readme.md 22 echo "Essential files modified."
23./generate.sh 23 lasttag=$(git tag | grep -Ev '\-' | head -1)
24 24 newtag=$(increment_version $lasttag)
25git add -A 25 git tag $newtag
26git commit -m "generated from qmk_firmware/$TRAVIS_BRANCH@${rev}" 26 git push --tags -q https://$GH_TOKEN@github.com/qmk/qmk_firmware
27git push 27else
28 echo "No essential files modified."
29fi
30
31if [[ "$TRAVIS_COMMIT_MESSAGE" != *"[skip build]"* ]] ; then
32
33 make ergodox-ez AUTOGEN=true
34
35 find . -name ".build" | xargs rm -rf
36 cd ..
37 git clone https://$GH_TOKEN@github.com/jackhumbert/qmk.fm.git
38 cd qmk.fm
39 git submodule update --init --recursive
40 rm -rf keyboard
41 rm -rf keyboards
42 cp -r ../qmk_firmware/keyboards .
43 mkdir keyboards/ergodox_ez/
44 cp ../qmk_firmware/util/ergodox_ez.html keyboards/ergodox_ez/index.html
45 cp ../qmk_firmware/readme.md qmk_readme.md
46 ./generate.sh
47
48 git add -A
49 git commit -m "generated from qmk/qmk_firmware@${rev}"
50 git push
51
52fi
53
54fi \ No newline at end of file
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-22 11:27:12 +0000