Update keyboards/planck/keymaps/vifon #4084

vifon · 2018-10-05T21:07:53Z

Update my personal keymap. It contains a referential usage of the dynamic macros, and a few custom features, for example KM_HOLD similar to the built-in KC_LOCK but a bit more powerful (it's possible to easily hold many keys).

Swapping the array indices should increase the locality of the memory access.

Useful for the macro recording because the "tap" modifiers always act as modifiers there.

When the limit is reached, the backlight blinks with each keypress.

- support for a second macro (saved using the end of the macro buffer) - improved reliability

Previously the auxiliary layers were numbered 30 and 31 which resulted in all 32 array elements being allocated regardless of the actually used layers in the user code.

…into personal

It's not as disruptive as LGUI and it makes the LW/RS order kind of more consistent (LW on the left, RS on the right).

It was confusing to have the modifiers completely swapped. Just moving them is much more natural.

…sonal

vifon · 2018-10-05T21:18:04Z

Hm, I don't remember rebasing this branch. Is the messy commit history a problem?

noroadsleft

Additional general feedback:

qmk_firmware/keyboards/planck/keymaps/vifon/keymap.c

Lines 1 to 8 in 29155cb

    
           #pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example" 
        
           #include "planck.h" 
        
           #ifdef BACKLIGHT_ENABLE 
        
           #  include "backlight.h" 
        
           #endif 
        
           #include "timer.h" 
        
           #include <bootloader.h>

This whole code block can be replaced by #include QMK_KEYBOARD_H.

qmk_firmware/keyboards/planck/keymaps/vifon/keymap.c

Lines 41 to 42 in 29155cb

    
           #define _______ KC_TRNS 
        
           #define XXXXXXX KC_NO

qmk_firmware/keyboards/planck/keymaps/vifon/keymap.c

Lines 101 to 102 in 29155cb

    
           #undef _______ 
        
           #undef XXXXXXX

Both these sets of lines are unnecessary. QMK defines these automatically for every keymap.

qmk_firmware/quantum/quantum_keycodes.h

Lines 29 to 31 in 27e216f

    
           // Fillers to make layering more clear 
        
           #define _______ KC_TRNS 
        
           #define XXXXXXX KC_NO

noroadsleft · 2018-10-05T21:38:23Z

keyboards/planck/keymaps/vifon/keymap.c

@@ -55,14 +57,14 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 [_PP] = { /* Pure Pro */


All your layers should be formatted to use an appropriate LAYOUT macro, as seen here:

qmk_firmware/keyboards/planck/keymaps/default/keymap.c

Lines 58 to 63 in 27e216f

[_QWERTY] = LAYOUT_planck_grid(

KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,

KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,

KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,

BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT

),

noroadsleft · 2018-10-05T21:44:13Z

Regarding the messy commit history, a clean history is easier to review, but for something like this I typically use the Files Changed tab, which shows all the changes contained in the PR.

It is best to keep a clean history if you're going to be submitting a PR, though.

drashna · 2018-10-05T21:54:47Z

keyboards/planck/keymaps/vifon/keymap.c


 const uint16_t PROGMEM fn_actions[] = {
    ACTION_MODS_TAP_KEY(MOD_RSFT, KC_ENT),
+    ACTION_MODS_TAP_KEY(MOD_RSFT, KC_DOT),


These all could be replaced with MT(mod, kc).
https://docs.qmk.fm/#/feature_advanced_keycodes?id=mod-tap

No need to use the fn_actions block here, especially as it's depreciated.

Oh, great! I had the first action for over two years when MT() wasn't available I believe, only SFT_T() which only had the left shift modifier. And now I just added two analogous actions. I'm going to upgrade it in a few minutes.

Well, SFT_T is an alias for MT, actually.

And there is RSFT_T and RCTL_T, too.

And yeah, all of the "functions" have an alias now, so, it's much better now. :)

keyboards/planck/keymaps/vifon/keymap.c

drashna · 2018-10-05T21:59:10Z

Also, we squash keymap commits like this, so in the main QMK repo, it will only be a single commit. So no worries.

vifon · 2018-10-06T00:46:35Z

Thanks for all the suggestions. I wasn't tracking the recent qmk development and indeed I was missing on some newish quality-of-life features. Fixed!

drashna · 2018-10-06T14:48:53Z

Awesome, thanks!

* 'master' of git://github.com/qmk/qmk_firmware: Keymap: Adds TheVan RoadKit Gamepad Layout (qmk#4090) Update and clarify Unicode documentation (qmk#4065) Update Contrib doc (qmk#4068) Add non-US Hash and Backslash to AutoShift handling Keymap: Update keyboards/planck/keymaps/vifon (qmk#4084)

* Implement macro recording * Remove off-by-one from the macro recorder * Holding both modifiers enables the third layer * Exit the 3rd layer into one of the secondary ones * Regular Enter and Escape on the secondary layers Useful for the macro recording because the "tap" modifiers always act as modifiers there. * Remove the buffer overflow from the macro recorder When the limit is reached, the backlight blinks with each keypress. * More robust macro recording implementation * Macro record refactoring and improvement - support for a second macro (saved using the end of the macro buffer) - improved reliability * Add comments to my macros * Macro recording: remove a redundant code * Separate the raise+lower layer from the special layer * Add back/forward keys * Bind mouse movement * More readable KC_TRNS * Improve the mouse bindings * Use a convenience macro instead of the low-level ACTION macro * Add mouse to the Dual layer; make most of the layer transparent * New "mouse" layer; clean up the "special" layer * CapsLock, NumLock and ScrollLock on the Special layer * Enable my fix for the stuck modifiers and adjust the dual layer to it * Fix the macro recording after enabling the stuck mods fix * Click with Lower/Raise+Space * Reduce the memory used by the macro recording Previously the auxiliary layers were numbered 30 and 31 which resulted in all 32 array elements being allocated regardless of the actually used layers in the user code. * Optimize source_layers_cache for the cache memory Swapping the array indices should increase the locality of the memory access. * Remove the mouse layer * Use update_tri_layer to simplify the code * Add some custom per-keymap build options * Add ShiftLock * Secure the reset button * Add numeric layer * Remove explicit layer keys on LW and RS layers * Replace Alt+left/right with Back/Forward keys * Sleep/delay key (for macro recording) * App/menu key * Fix stuff after merging to master * Local per-keymap config.h; minor cleanup * Remove the old macro_record.h Replaced with dynamic_macro.h * Adjust my keymap to the current API * Pure Pro Gaming layer Accessible by double tapping the Pure Pro layer. It features switched Lower and Raise layers, for one-handed access to numbers. * Pure Pro Gaming layer: no Mod4, persistent number layer under RShift * Pure Pro Gaming layer activated with long press, not double press * Reduce the size of the vifon keymap See: issue qmk#930 * Increase the dynamic macro buffer The default was actually decreased. The actual used value didn't change. * Add the context menu key * No more strange ideas in the gaming layer * Reduce the firmware size by disabling API_SYSEX_ENABLE * Make slash available on the PP layer (replaces the RESET key) * Add a generic "hold this key" macro * Add a missing undef * Turn LGUI in the gaming layer into LW instead of disabling it It's not as disruptive as LGUI and it makes the LW/RS order kind of more consistent (LW on the left, RS on the right). * Refactor the Pure Pro Gaming layer * Try out the 1st party qmk KC_LOCK (vs my own KM_HOLD) * Alternative way to switch keyboard layouts with the left hand * Add dot & slash to the Pure Pro layer (but not to the Gaming layer) * Now that there is a second KM_LW, we can simplify the layout a bit It was confusing to have the modifiers completely swapped. Just moving them is much more natural. * Disable the console now that qmk got bigger * Update the keymap for the modern qmk standards

vifon added 30 commits May 3, 2016 22:34

Optimize source_layers_cache for the cache memory

9241c76

Swapping the array indices should increase the locality of the memory access.

Implement macro recording

0fa65b9

Remove off-by-one from the macro recorder

147c283

Holding both modifiers enables the third layer

da8b5b0

Exit the 3rd layer into one of the secondary ones

eeb282f

Regular Enter and Escape on the secondary layers

468ddf6

Useful for the macro recording because the "tap" modifiers always act as modifiers there.

Remove the buffer overflow from the macro recorder

2e77cfc

When the limit is reached, the backlight blinks with each keypress.

More robust macro recording implementation

7eb9a9d

Macro record refactoring and improvement

116e5cd

- support for a second macro (saved using the end of the macro buffer) - improved reliability

Add comments to my macros

a32f973

Macro recording: remove a redundant code

ba6c1e0

Separate the raise+lower layer from the special layer

2b9420a

Add back/forward keys

571c5b5

Bind mouse movement

3eedc30

More readable KC_TRNS

03dc41a

Improve the mouse bindings

942a1f2

Use a convenience macro instead of the low-level ACTION macro

8ee14f1

Add mouse to the Dual layer; make most of the layer transparent

be413b8

New "mouse" layer; clean up the "special" layer

36c9171

CapsLock, NumLock and ScrollLock on the Special layer

504c1b0

Enable my fix for the stuck modifiers and adjust the dual layer to it

f20fb01

Fix the macro recording after enabling the stuck mods fix

1da9014

Click with Lower/Raise+Space

bfcf02f

Reduce the memory used by the macro recording

3f56caa

Previously the auxiliary layers were numbered 30 and 31 which resulted in all 32 array elements being allocated regardless of the actually used layers in the user code.

Remove the mouse layer

0867cfd

Use update_tri_layer to simplify the code

13976e9

Add some custom per-keymap build options

1a9905f

Add ShiftLock

12a7736

Secure the reset button

1ad2097

Add numeric layer

d7a21b8

vifon added 11 commits July 9, 2017 01:09

Add a generic "hold this key" macro

7f80c9d

Add a missing undef

c0fc74f

Merge branch 'master' of https://github.com/jackhumbert/qmk_firmware …

55473bf

…into personal

Turn LGUI in the gaming layer into LW instead of disabling it

b650a5d

It's not as disruptive as LGUI and it makes the LW/RS order kind of more consistent (LW on the left, RS on the right).

Refactor the Pure Pro Gaming layer

73f331c

Try out the 1st party qmk KC_LOCK (vs my own KM_HOLD)

708063b

Alternative way to switch keyboard layouts with the left hand

8373a31

Add dot & slash to the Pure Pro layer (but not to the Gaming layer)

71a67b3

Now that there is a second KM_LW, we can simplify the layout a bit

65e866f

It was confusing to have the modifiers completely swapped. Just moving them is much more natural.

Disable the console now that qmk got bigger

b65703f

Merge branch 'master' of https://github.com/qmk/qmk_firmware into per…

29155cb

…sonal

noroadsleft requested changes Oct 5, 2018

View reviewed changes

drashna reviewed Oct 5, 2018

View reviewed changes

Update the keymap for the modern qmk standards

72cb23b

noroadsleft approved these changes Oct 6, 2018

View reviewed changes

drashna added the keymap label Oct 6, 2018

drashna merged commit 60f5ce8 into qmk:master Oct 6, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update keyboards/planck/keymaps/vifon #4084

Update keyboards/planck/keymaps/vifon #4084

vifon commented Oct 5, 2018

vifon commented Oct 5, 2018 •

edited

Loading

noroadsleft left a comment

noroadsleft Oct 5, 2018

noroadsleft commented Oct 5, 2018 •

edited

Loading

drashna Oct 5, 2018

vifon Oct 6, 2018

drashna Oct 6, 2018

drashna commented Oct 5, 2018

vifon commented Oct 6, 2018

drashna commented Oct 6, 2018


	#pragma message "You may need to add LAYOUT_planck_grid to your keymap layers - see default for an example"
	#include "planck.h"
	#ifdef BACKLIGHT_ENABLE
	# include "backlight.h"
	#endif
	#include "timer.h"
	#include <bootloader.h>

	// Fillers to make layering more clear
	#define _______ KC_TRNS
	#define XXXXXXX KC_NO

		@@ -55,14 +57,14 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
		[_PP] = { /* Pure Pro */

	[_QWERTY] = LAYOUT_planck_grid(
	KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
	KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
	KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_ENT ,
	BACKLIT, KC_LCTL, KC_LALT, KC_LGUI, LOWER, KC_SPC, KC_SPC, RAISE, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT
	),

Update keyboards/planck/keymaps/vifon #4084

Update keyboards/planck/keymaps/vifon #4084

Conversation

vifon commented Oct 5, 2018

vifon commented Oct 5, 2018 • edited Loading

noroadsleft left a comment

Choose a reason for hiding this comment

noroadsleft Oct 5, 2018

Choose a reason for hiding this comment

noroadsleft commented Oct 5, 2018 • edited Loading

drashna Oct 5, 2018

Choose a reason for hiding this comment

vifon Oct 6, 2018

Choose a reason for hiding this comment

drashna Oct 6, 2018

Choose a reason for hiding this comment

drashna commented Oct 5, 2018

vifon commented Oct 6, 2018

drashna commented Oct 6, 2018

vifon commented Oct 5, 2018 •

edited

Loading

noroadsleft commented Oct 5, 2018 •

edited

Loading