Split HHKB to ANSI and JP layouts and Add VIA support for each #8582

diegomsong · 2020-03-27T19:34:41Z

Description

Split keyboards/hhkb into two separate folders keyboards/hhkb/ansi and keyboards/hhkb/jp for implementation of separate JSON files in VIA. Reasoning is that the HHKB ANSI and HHKB JP have completely different matrices (see ansi/ansi.h (KLE) and jp/jp.h (KLE)) and should be treated as two separate, different keyboards.

Sorted keymaps into the appropriate folders for ANSI and JP. Compiled all .hex files successfully after the changes with the exception of brett and cinaeco which had user errors pertaining not to the source files but their keymap files.

Relevant files that were edited were:

ansi.c and ansi.h; jp.c and jp.h to have appropriate #include statements
config.h in each subfolder
info.json in each subfolder
relevant VIA files

All other files were not tampered with. Hopefully this is not a breaking change for other people's forks.

Add VIA support for the HHKB Professional 2 ANSI and HHKB Professional JP, both of which have the Hasu TMK Controller available for reprogrammability.

Flashed VIA hex to HHKB Pro 2 with Hasu USB/BT Controller and tested successfully. Was able to test VIA hex on @bakingpy's HHKB Pro JP with Hasu Controller.

PR of VIA json files to the-via/keyboards repo.

Types of Changes

Checklist

My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

…ODUCT_ID and set dynamic layers to 3 to fit EEPROM

…ion successful

zvecr · 2020-04-07T03:33:13Z

https://docs.qmk.fm/#/breaking_changes_instructions

Also, this has some conflicts.

diegomsong · 2020-04-07T04:06:38Z

https://docs.qmk.fm/#/breaking_changes_instructions

Also, this has some conflicts.

How do I resolve conflicts pertaining to moved/removed files? (namely, all of the four files listed above in those particular paths)

Aside, the keymaps under hhkb/ansi/keymaps/brett and hhkb/ansi/keymaps/cinaeco fail to compile to hex with errors that I am unsure how to fix.

Would appreciate any help to resolve issues and continue with this change.

…mjt/

diegomsong · 2020-04-14T02:17:47Z

Resolved conflicts and at this point only the brett and cinaeco keymaps in hhkb/ansi fail to make, but those are user keymaps I won't troubleshoot.

noroadsleft

Looking this over, there's a lot of duplicated code that should be shared between the ANSI and JP versions:

The rn42 code should be just within keyboards/hhkb/ instead of each version having its own rn42 directory – the code for both versions is 100% identical.
I don't see any reason to not remove the HHKB_JP definition – the ANSI version doesn't need the code it includes, and the JP version doesn't need it because it's obvious with these changes that we're dealing with the JP version in those code branches.

diegomsong · 2020-05-05T01:24:12Z

Looking this over, there's a lot of duplicated code that should be shared between the ANSI and JP versions:

The rn42 code should be just within keyboards/hhkb/ instead of each version having its own rn42 directory – the code for both versions is 100% identical.

I don't see any reason to not remove the HHKB_JP definition – the ANSI version doesn't need the code it includes, and the JP version doesn't need it because it's obvious with these changes that we're dealing with the JP version in those code branches.

@noroadsleft Just pushed an update resolving these two things. Thanks for the feedback.

keyboards/hhkb/jp/config.h

keyboards/hhkb/ansi/ansi.h

keyboards/hhkb/ansi/hhkb_avr.h

keyboards/hhkb/jp/jp.h

keyboards/hhkb/jp/keymaps/via/keymap.c

keyboards/hhkb/jp/readme.md

Co-authored-by: Danny <[email protected]>

…firmware into feature/hhkb_via

keyboards/hhkb/ansi/config.h

Co-authored-by: Danny <[email protected]>

Co-authored-by: James Young <[email protected]>

…firmware into feature/hhkb_via Fetch, rebase, update, and push new branch onto future branch

diegomsong · 2020-05-11T20:21:36Z

One last thing:

Can you run git fetch against QMK's future branch, then rebase feature/hhkb_via on QMK's future branch? Your PR moves a couple of keymaps that are actually edited on the future branch, so I can't actually merge your PR yet.

Uh oh, did I do this right?

I ran

git fetch upstream future
and
git rebase upstream/future feature/hhkb_via

and then I git pushed. It complained and asked me to git pull, so I did and retried the push.

noroadsleft · 2020-05-11T20:38:22Z

Uh oh, did I do this right?

I ran

git fetch upstream future
and
git rebase upstream/future feature/hhkb_via

and then I git pushed. It complained and asked me to git pull, so I did and retried the push.

I actually probably screwed you up a bit when I changed the target branch to future, but no matter – we're good now! Thanks!

* VIA Support created for HHKB Hasu Controller config.h keymap.c rules.mk * Add VIA support for HHKB JP with Hasu controller - define distinct PRODUCT_ID and set dynamic layers to 3 to fit EEPROM * Split HHKB into ANSI and JP. Tested VIA for ANSI and JP. Hex compilation successful * Resolve jp.h erroneous diff from git merge from master * Resolve ansi.h diff merge * Define rules.mk for dynamic macro to rid of warning for ansi/keymaps/mjt/ * Moved rn42 directory up, got rid of #define HHKB_JP lines * Update keyboards/hhkb/jp/readme.md * Update keyboards/hhkb/jp/keymaps/via/keymap.c * Replace with #pragma once and remove ending #endif * Remove old style guards #define... for #pragma once * Update keyboards/hhkb/jp/keymaps/via/rules.mk * Update keyboards/hhkb/ansi/rules.mk * Update keyboards/hhkb/jp/rules.mk * Updated hhkb/ansi/readme.md compiling instructions * VIA Support created for HHKB Hasu Controller config.h keymap.c rules.mk * Add VIA support for HHKB JP with Hasu controller - define distinct PRODUCT_ID and set dynamic layers to 3 to fit EEPROM * Split HHKB into ANSI and JP. Tested VIA for ANSI and JP. Hex compilation successful * Resolve ansi.h diff merge * Define rules.mk for dynamic macro to rid of warning for ansi/keymaps/mjt/ * Moved rn42 directory up, got rid of #define HHKB_JP lines * Update keyboards/hhkb/jp/readme.md * Update keyboards/hhkb/jp/keymaps/via/keymap.c * Replace with #pragma once and remove ending #endif * Remove old style guards #define... for #pragma once * Update keyboards/hhkb/jp/keymaps/via/rules.mk * Update keyboards/hhkb/ansi/rules.mk * Update keyboards/hhkb/jp/rules.mk * Updated hhkb/ansi/readme.md compiling instructions

) * VIA Support created for HHKB Hasu Controller config.h keymap.c rules.mk * Add VIA support for HHKB JP with Hasu controller - define distinct PRODUCT_ID and set dynamic layers to 3 to fit EEPROM * Split HHKB into ANSI and JP. Tested VIA for ANSI and JP. Hex compilation successful * Resolve jp.h erroneous diff from git merge from master * Resolve ansi.h diff merge * Define rules.mk for dynamic macro to rid of warning for ansi/keymaps/mjt/ * Moved rn42 directory up, got rid of #define HHKB_JP lines * Update keyboards/hhkb/jp/readme.md * Update keyboards/hhkb/jp/keymaps/via/keymap.c * Replace with #pragma once and remove ending #endif * Remove old style guards #define... for #pragma once * Update keyboards/hhkb/jp/keymaps/via/rules.mk * Update keyboards/hhkb/ansi/rules.mk * Update keyboards/hhkb/jp/rules.mk * Updated hhkb/ansi/readme.md compiling instructions * VIA Support created for HHKB Hasu Controller config.h keymap.c rules.mk * Add VIA support for HHKB JP with Hasu controller - define distinct PRODUCT_ID and set dynamic layers to 3 to fit EEPROM * Split HHKB into ANSI and JP. Tested VIA for ANSI and JP. Hex compilation successful * Resolve ansi.h diff merge * Define rules.mk for dynamic macro to rid of warning for ansi/keymaps/mjt/ * Moved rn42 directory up, got rid of #define HHKB_JP lines * Update keyboards/hhkb/jp/readme.md * Update keyboards/hhkb/jp/keymaps/via/keymap.c * Replace with #pragma once and remove ending #endif * Remove old style guards #define... for #pragma once * Update keyboards/hhkb/jp/keymaps/via/rules.mk * Update keyboards/hhkb/ansi/rules.mk * Update keyboards/hhkb/jp/rules.mk * Updated hhkb/ansi/readme.md compiling instructions

* Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968) * Convert V-USB usbdrv to a submodule (#8321) * Unify Tap Hold functions and documentation (#8348) * Changing board names to prevent confusion (#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (#8499) * Move spaceman keyboards (#8830) * Migrate miscellaneous `fn_actions` entries (#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (#8537) * Refactor Lily58 to use split_common (#6260) * Refactor zinc to use split_common (#7114) * Add a message if bin/qmk doesn't work (#9000) * Fix conflicting types for 'tfp_printf' (#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480) * Refactor and updates to TKC1800 code (#8472) * Switch to qmk forks for everything (#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484) * Audio enable corrections (2/3) (#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582) * Audio enable corrections (Part 4) (#8974) * Fix typo from PR7114 (#9171) * Augment future branch Changelogs (#8978) * Revert "Branch point for 2020 May 30 Breaking Change"

* Branch point for 2020 May 30 Breaking Change * Migrate `ACTION_LAYER_TOGGLE` to `TG()` (qmk#8954) * Migrate `ACTION_MODS_ONESHOT` to `OSM()` (qmk#8957) * Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (qmk#8958) * Migrate `ACTION_LAYER_MODS` to `LM()` (qmk#8959) * Migrate `ACTION_MODS_TAP_KEY` to `MT()` (qmk#8968) * Convert V-USB usbdrv to a submodule (qmk#8321) * Unify Tap Hold functions and documentation (qmk#8348) * Changing board names to prevent confusion (qmk#8412) * Move the Keyboardio Model01 to a keyboardio/ subdir (qmk#8499) * Move spaceman keyboards (qmk#8830) * Migrate miscellaneous `fn_actions` entries (qmk#8977) * Migrate `ACTION_MODS_KEY` to chained mod keycodes (qmk#8979) * Organizing my keyboards (plaid, tartan, ergoinu) (qmk#8537) * Refactor Lily58 to use split_common (qmk#6260) * Refactor zinc to use split_common (qmk#7114) * Add a message if bin/qmk doesn't work (qmk#9000) * Fix conflicting types for 'tfp_printf' (qmk#8269) * Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (qmk#6480) * Refactor and updates to TKC1800 code (qmk#8472) * Switch to qmk forks for everything (qmk#9019) * audio refactor: replace deprecated PLAY_NOTE_ARRAY (qmk#8484) * Audio enable corrections (2/3) (qmk#8903) * Split HHKB to ANSI and JP layouts and Add VIA support for each (qmk#8582) * Audio enable corrections (Part 4) (qmk#8974) * Fix typo from PR7114 (qmk#9171) * Augment future branch Changelogs (qmk#8978) * Revert "Branch point for 2020 May 30 Breaking Change"

diegomsong added 3 commits March 24, 2020 14:14

VIA Support created for HHKB Hasu Controller config.h keymap.c rules.mk

2714311

Add VIA support for HHKB JP with Hasu controller - define distinct PR…

8aa1f21

…ODUCT_ID and set dynamic layers to 3 to fit EEPROM

Split HHKB into ANSI and JP. Tested VIA for ANSI and JP. Hex compilat…

5dd0264

…ion successful

diegomsong changed the title ~~Split HHKB to ANSI and JP layouts and VIA support for each~~ Split HHKB to ANSI and JP layouts and Add VIA support for each Mar 27, 2020

diegomsong mentioned this pull request Mar 27, 2020

Add VIA support for HHKB ANSI and JP. Requires separate subdirectories. the-via/keyboards#71

Merged

7 tasks

zvecr added keyboard breaking_change Changes that need to wait for a version increment labels Apr 7, 2020

diegomsong added 4 commits April 13, 2020 20:27

Keeping branch up to date with master

bda175a

Resolve jp.h erroneous diff from git merge from master

43c115d

Resolve ansi.h diff merge

6da25b7

Define rules.mk for dynamic macro to rid of warning for ansi/keymaps/…

e1323f9

…mjt/

drashna requested a review from a team April 28, 2020 08:41

noroadsleft requested changes May 4, 2020

View reviewed changes

noroadsleft requested a review from a team May 4, 2020 20:42

Moved rn42 directory up, got rid of #define HHKB_JP lines

b97dcd9