Add unison v04 keyboard (#11982)

* Update: JonesのMIDIキーマップをベースに初期作成。AudioとMIDIの同時使用はファームウェアサイズ的に厳しい。

* Update: Unison用のIDへ変更

* Update: Audioはデフォとせず、OLEDをデフォとした。

* Update: v03基板から実際に動くものとなったため、v01からv03に変更。基本的な設定を完了。

* Update: 基本的なキーマップを作成

* Update: キーマップ、ロータリーエンコーダの感度を調整。

* TEST: BOOTMAGIC = lite　でどうなるのかテスト

* Update: Jones ---> Unison

* TEST: BOOTMAGIC = lite で、TABキーでBootloaerに入る設定

* Update: インデント

* Update: QMKの一般的な表記に合わせ、 k(col)(row) から k(row)(col) へ変更。

* Update: 自前のカスタムマトリクスを使用せず、COL2ROW方式で総当たりマトリクスを動作させるテストを開始。

特に問題なく動作している。

* TEST: BOOTMAGICテスト用コード追加

* Update: 主に中央部分のキーマップ変更

* TEST: COL2ROWで、COLのピンの順番を変えてキーを読むテスト

* Update: QMKの仕様上、MacではKC_PSCRがFキーとして判定されるため、スクリーンショット用マクロを用意した。

* TEST: COL2ROWで、ROWとCOLのピン定義をずらした状態で、BOOTMAGIC = lite の（0,0)キーに引っかからない。

* Update: ロータリーエンコーダにマウスホイールを割り当て

* Update: 自明のコメントを削除

* Update: NKRO指定時は、NKRO動作を強制。

* Update: MIDIなしのとき、AUDIOのフル機能がファームウェアサイズ内に収まることをチェック。

* Update: Bootmagicテスト完了のため、無効化。

* TEST: LED動作チェック。

* Update: キーマップを、LOWER, RAISEを中心に大幅変更。

数字を左手レイヤーキーではなく、右手レイヤーキーにしたことで、CMD+Qによる誤爆アプリ終了を避ける狙いもある。

* Update: 未使用のNumレイヤとTapDanceを削除。

* Update: MIDI関連の設定を多数追加。

* New: Add Sequencer keymap

* enumの開始を明記

* TAP_DANCEを無効化

* シーケンサーで、トラック単位の有効・無効の切り替えを追加。※動作せず

* デバッグ用設定をテスト

* Change custom keycode name for classification.

* Add LED update on sequencer step.

* change LED adjusting value.

* TEST: SQ_T related things.

* DEBUG

* Increase track 6 ---> 8. Add track indicator.

* Add sequencer step viewer.

* Move Bootmagic lite position to keyboard's config.

* Revert matrix as phisically connected.

* Change default RGB lighting animation.

* Remove MIDI options from keyboard's config.

* change version

* Remove unused.

* Delete unused. Round-Robin matrix woks with COL2ROW.

* Delete unused. Round-Robin matrix woks with COL2ROW.

* Formatting.

* Formatting.

* Remove unused.

* No enum.

* LED setting for Sequencer layer.

* Add TODO flag

* Remove unused.

* change LCTL

* Update Rotary Encoder setting.

* revert to default

* Add TODO flag.

* Update to latest information.

* Update to latest information.

* Add v04

* Move keymaps directory to just under keyboard directory.

* Add music layout.

* Update to Unison layout.

* Add default keymap.

* Update readme description.

* Commenting.

* Exclude non-PR files.

* Change keymap name more general.

* Remove unused

* Commenting.

* Remove unused.

* Commenting.

* Change Macro name for consistency.

* Add tempo definition.

* Change transparent to noop for better musical play.

* Add Rotary Encoder push functions for Sequencer.

* FIX printscreen to work _WIN layer.

* Fix style name.

* Change keymap style from PC to Music.

* Adjust LED number and index to v04 PCB.

* Commenting.

* Add #ifdef block to LED config related.

* Change Sequencer display function from Rotary Encoder right-3 to right-4.

* Change default animations.

* Set LED effect range. Add LED reset on layer change.

* Remove unused.

* Commenting.

* Commenting.

* Use function to change Sequencer track indicator.

* Use function to change Sequencer track indicator.

* Remove unused

* Add PC-style keymap.

* Adjust keymap.

* Add micro volume control for Mac.

* Adjust keymap.

* Adjust cursor block.

* Adjust grave and tild in layer.

* Change magic-key position to Left-Bottom where both Music-style and Terminal-style have a key.

* Change LED settings for front-side 9 LEDs.

* Change keymap name.

* Update supported functions.

* Adjust indicator dimmer.

* Remove unused.

* Add underglow support.

* Add rotary encoder keymap at Adjust layer for test hardware function.

* Disable rotary encoders.

* Change description.

* Add support for underglow.

Disable knight animation to prevent unnatural feeling when underglow not installed.

* Commenting.

* Formatting.

* Turn on default layer indicator.

* remove duplication

* Change VID for via.

* Initial commit for VIA.

* Add layout option.

* restore AUDIO enabled.

* Removed a JSON file for VIA app, not for QMK.

* Remove non-related files for PR.

* Add keymap for music layout.

* Add photo links.

* Commenting.

* Apply PR checklist.

* Change unused function to "no".

* Add keymap image and change keymap as image shows.

* Change bootloader entering key to widely known "Left-Top".

* Turn off ENCODER by default.

* Add VIA keymap.

* Change VID unique.

#11982 (comment)

* Add config option to prepare future release, #11820.

#11820

* Remove old defines for Audio.

Co-authored-by: Takeshi Nishio <kkeennnn@gmail.com>

keyboards/unison/keymaps/default/keymap.c

@@ -0,0 +1,26 @@
+/* Copyright 2021 Takeshi Nishio
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT_all(
+        KC_NLCK,KC_PSLS,KC_PAST,KC_PMNS,KC_ESC, KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_6,   KC_7,   KC_8,   KC_9,   KC_0,   KC_MINS,KC_EQL,
+        KC_P7,  KC_P8,  KC_P9,  KC_PPLS,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_P4,  KC_P5,  KC_P6,  KC_PPLS,KC_LCTL,   KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,     KC_ENT,
+        KC_P1,  KC_P2,  KC_P3,  KC_PENT,KC_LSFT,KC_LSFT,KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM,KC_DOT, KC_SLSH,KC_UP,
+        KC_P0,  KC_P0,  KC_PDOT,KC_PENT,KC_GRV, KC_BSLS,KC_LALT,KC_LGUI,KC_SPC, KC_SPC, KC_SPC, KC_SPC, KC_SPC, KC_RGUI,KC_LEFT,KC_DOWN,KC_RGHT
+    )
+};

keyboards/unison/keymaps/default/readme.md

@@ -0,0 +1,6 @@
+![Unison, Terminal style Layout Image](https://raw.githubusercontent.com/jpskenn/Unison/main/assets/readme/layout_terminal_style_variant.png)
+
+# Defalut keymap for Unison Terminal style Layout.
+
+This is the default layout for Unison Terminal Layout.  
+5 rows layout for PC operation.

keyboards/unison/keymaps/default_music/keymap.c

@@ -0,0 +1,26 @@
+/* Copyright 2021 Takeshi Nishio
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT_music(
+                        KC_MUTE,        KC_F1,  KC_F2,  KC_F3,  KC_F4,          KC_MUTE,        KC_MUTE,        KC_MUTE,        KC_MUTE,
+        KC_P7,  KC_P8,  KC_P9,  KC_PPLS,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_P4,  KC_P5,  KC_P6,  KC_PAST,KC_LCTL,   KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_H,   KC_J,   KC_K,   KC_L,   KC_SCLN,     KC_ENT,
+        KC_P1,  KC_P2,  KC_P3,  KC_PMNS,KC_LSFT,KC_LSFT,KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_N,   KC_M,   KC_COMM,KC_DOT, KC_UP,  KC_SLSH,
+        KC_P0,  KC_PDOT,KC_PENT,KC_PPLS,KC_GRV, KC_BSLS,KC_LALT,KC_LGUI,KC_SPC, KC_SPC, KC_SPC, KC_SPC, KC_SPC, KC_RGUI,KC_LEFT,KC_DOWN,KC_RGHT
+    )
+};

keyboards/unison/keymaps/default_music/readme.md

@@ -0,0 +1,6 @@
+![Unison, Music style Layout Image](https://raw.githubusercontent.com/jpskenn/Unison/main/assets/readme/layout_music_style.png)
+
+# Defalut keymap for Unison Music Layout.
+
+This is the default layout for Unison Music Layout.  
+Inspired by "Teenage Engineering: OP-1".

keyboards/unison/keymaps/via/config.h

@@ -0,0 +1,25 @@
+/* Copyright 2021 Takeshi Nishio
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#ifdef RGB_DI_PIN
+    #undef RGBLED_NUM
+    #define RGBLED_NUM 17 // Layer Indicator(2) + Rotary Encoder(5) + Optional(2) + Under(8)
+
+    #undef RGBLIGHT_LED_MAP
+    #define RGBLIGHT_LED_MAP {2, 0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16} // Left to Right to Under
+#endif

keyboards/unison/keymaps/via/keymap.c

@@ -0,0 +1,139 @@
+/* Copyright 2021 Takeshi Nishio
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_number {
+    _BASE = 0,
+    _LOW,
+    _RAI,
+    _ADJ,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [_BASE] = LAYOUT_all(
+        KC_ESC, KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   KC_NLCK,KC_PSLS,KC_PAST,KC_PMNS,KC_6,   KC_7,   KC_8,   KC_9,   KC_0,   KC_MINS,KC_EQL,
+        KC_TAB,     KC_Q,   KC_W,   KC_E,   KC_R,   KC_T,   KC_P7,  KC_P8,  KC_P9,  KC_PPLS,KC_Y,   KC_U,   KC_I,   KC_O,   KC_P,       KC_BSPC,
+        KC_LCTL,    KC_A,   KC_S,   KC_D,   KC_F,   KC_G,   KC_P4,  KC_P5,  KC_P6,  KC_PPLS,KC_H,   KC_J,   KC_K,   KC_L,   KC_MINS,    KC_ENT,
+        KC_LSFT,KC_LSFT,KC_Z,   KC_X,   KC_C,   KC_V,   KC_B,   KC_P1,  KC_P2,  KC_P3,  KC_PENT,KC_N,   KC_M,   KC_COMM,KC_DOT, KC_SLSH,KC_UP,
+        KC_GRV, KC_BSLS,KC_LGUI,KC_LALT,KC_SPC, KC_SPC,MO(_LOW),KC_P0,  KC_P0,  KC_PDOT,MO(_RAI),KC_SPC,KC_APP, KC_ROPT,KC_LEFT,KC_DOWN,KC_RGHT
+    ),
+    [_LOW] = LAYOUT_all(
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,
+        KC_TILD,    KC_EXLM,KC_AT,  KC_HASH,KC_DLR, KC_PERC,_______,_______,_______,_______,KC_CIRC,KC_AMPR,KC_ASTR,KC_LPRN,KC_RPRN,    KC_DEL,
+        _______,    KC_PSCR,KC_SLCK,KC_PAUS,_______,_______,_______,_______,_______,_______,KC_GRV, KC_MINS,KC_EQL, KC_LBRC,KC_RBRC,    KC_BSLS,
+        _______,_______,KC_MUTE,KC_VOLD,KC_VOLU,_______,_______,_______,_______,_______,_______,KC_TILD,KC_UNDS,KC_PLUS,KC_LCBR,KC_RCBR,KC_PIPE,
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,KC_HOME,KC_PGDN,KC_PGUP,KC_END
+    ),
+    [_RAI] = LAYOUT_all(
+        _______,KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,_______,_______,_______,_______,KC_F6,  KC_F7,  KC_F8,  KC_F9,  KC_F10,   KC_F11, KC_F12,
+        KC_GRV,     KC_1,   KC_2,   KC_3,   KC_4,   KC_5,   _______,_______,_______,_______,KC_6,   KC_7,   KC_8,   KC_9,   KC_0,       KC_DEL,
+        _______,    KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  _______,_______,_______,_______,KC_LEFT,KC_DOWN,KC_UP,  KC_RGHT,KC_SCLN,    KC_QUOT,
+        _______,_______,KC_F6,  KC_F7,  KC_F8,  KC_F9,  KC_F10, _______,_______,_______,_______,KC_HOME,KC_PGDN,KC_PGUP,KC_END, KC_COLN,KC_DQUO,
+        _______,_______,KC_F11, _______,KC_F12,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______
+    ),
+    [_ADJ] = LAYOUT_all(
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,    _______,_______,_______,RESET,  _______,_______,_______,_______,_______,RGB_HUI,RGB_SAI,RGB_VAI,_______,RGB_RMOD,   _______,
+        _______,    AU_TOG, CK_TOGG,MU_TOG, MU_MOD, _______,_______,_______,_______,_______,RGB_HUD,RGB_SAD,RGB_VAD,RGB_TOG,RGB_MOD,    _______,
+        KC_CAPS,_______,CK_RST, CK_DOWN,CK_UP,  _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,
+        _______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______,_______
+    )
+};
+
+
+/* ------------------------------------------------------------------------------
+   RGB Lighting
+------------------------------------------------------------------------------ */
+#ifdef RGBLIGHT_LAYERS
+
+// Indicator LED settings
+#define INDICATOR_INDEX 0         // Where to start indicator, default:1
+#define INDICATOR_COUNT 1         // How many LEDs for indicator, default:2
+#define INDICATOR_CHANGE_COUNT 1  // How meny LEDs to change for temporally layer default:1
+#define DIMMER_LEVEL 150          // LED brightness dimmer level, 0(brightest) - 255(perfect dark), default:150
+
+// for Default layer (= Base layer)
+const rgblight_segment_t PROGMEM my_base_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {INDICATOR_INDEX , INDICATOR_COUNT, HSV_BLACK}
+);
+
+// for Temporal layer
+const rgblight_segment_t PROGMEM my_lower_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {INDICATOR_INDEX , INDICATOR_CHANGE_COUNT, HSV_GREEN - DIMMER_LEVEL}
+);
+
+const rgblight_segment_t PROGMEM my_raise_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {INDICATOR_INDEX , INDICATOR_CHANGE_COUNT, HSV_CYAN - DIMMER_LEVEL}
+);
+
+const rgblight_segment_t PROGMEM my_adjust_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {INDICATOR_INDEX , INDICATOR_CHANGE_COUNT, HSV_RED - DIMMER_LEVEL}
+);
+
+// for Lock indicator
+const rgblight_segment_t PROGMEM my_caps_layer[] = RGBLIGHT_LAYER_SEGMENTS(
+    {INDICATOR_INDEX , INDICATOR_CHANGE_COUNT, HSV_MAGENTA - DIMMER_LEVEL}
+);
+
+// Define the array of layers. Later layers take precedence
+const rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST(
+    my_base_layer,
+    my_caps_layer,
+    my_lower_layer,
+    my_raise_layer,
+    my_adjust_layer
+);
+
+// Enabling and disabling lighting layers for default layer
+layer_state_t default_layer_state_set_user(layer_state_t state) {
+    rgblight_set_layer_state(0, layer_state_cmp(state, _BASE));
+
+    return state;
+}
+
+// Enabling and disabling lighting layers for lock key
+bool led_update_user(led_t led_state) {
+    rgblight_set_layer_state(1, led_state.caps_lock);
+    return true;
+}
+
+// Enabling and disabling lighting layers for momentary layer
+layer_state_t layer_state_set_user(layer_state_t state) {
+    state = update_tri_layer_state(state, _LOW, _RAI, _ADJ);
+
+    rgblight_set_layer_state(2, layer_state_cmp(state, _LOW));
+    rgblight_set_layer_state(3, layer_state_cmp(state, _RAI));
+    rgblight_set_layer_state(4, layer_state_cmp(state, _ADJ));
+
+    return state;
+}
+#endif
+
+
+/* ------------------------------------------------------------------------------
+   Post Initialize
+------------------------------------------------------------------------------ */
+void keyboard_post_init_user(void) {
+    #ifdef RGB_DI_PIN
+    // RGB Lighting: Set effect range from just after indicator.
+    rgblight_set_effect_range(1, 16);
+    #endif
+    #ifdef RGBLIGHT_LAYERS
+    // RGB Lighting Layers: Setup LED layers
+    rgblight_layers = my_rgb_layers;
+    #endif
+}

keyboards/unison/keymaps/via/readme.md

@@ -0,0 +1,36 @@
+![Unison, VIA Layout Image](https://raw.githubusercontent.com/jpskenn/Unison/main/assets/readme/layout_via.png)
+
+# Keymap for Unison Terminal style with VIA support
+
+Five rows layout for PC operation.  
+VIA remapping is supported.
+
+## Layers
+
+### Base layer
+- Base
+
+### Momentarily layers
+- Lower
+- Raise
+- Adjust
+
+## LED lighting
+
+17 LEDs.
+One for Lighting Layer.
+The rest for Lighting Effects.
+
+- Indicator: 2
+- Rotary Encoder side: 5
+- Optional: 2
+- Under: 8
+
+## Audio
+
+Supports simultaneous audio.
+
+## Bootmagic
+
+The "lite" mode is enabled.  
+Hold "Left-Top" key to enter bootloader.

keyboards/unison/keymaps/via/rules.mk

@@ -0,0 +1,5 @@
+MOUSEKEY_ENABLE = yes
+AUDIO_ENABLE = yes
+
+BOOTMAGIC_ENABLE = lite
+VIA_ENABLE = yes

keyboards/unison/readme.md

@@ -0,0 +1,26 @@
+# Unison
+
+![Unison, Music style](https://raw.githubusercontent.com/jpskenn/Unison/main/assets/readme/IMG_2669.jpeg)
+
+![Unison, Terminal style](https://raw.githubusercontent.com/jpskenn/Unison/main/assets/readme/IMG_2626.jpeg)
+
+![Unison, PCB](https://raw.githubusercontent.com/jpskenn/Unison/main/assets/BuildGuide_v04/IMG_2472.jpeg)
+
+A narrow pitch keyboard with irregular Row-staggered, compatible with GH60 case.  
+It has two layout style, for music and for computers.
+
+* Keyboard Maintainer: [jpskenn](https://github.com/jpskenn)
+* Hardware Supported: PCB
+* Hardware Availability: [GitHub](https://github.com/jpskenn/Unison), [BOOTH](https://jpskenn.booth.pm)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make unison:default
+
+Flashing example for this keyboard ([using the command line](https://docs.qmk.fm/#/newbs_flashing?id=flash-your-keyboard-from-the-command-line)):
+
+    make unison:default:flash
+
+To reset the keyboard into bootloader mode, press the reset switch on the underside.
+
+See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

keyboards/unison/rules.mk

@@ -0,0 +1 @@
+DEFAULT_FOLDER = unison/v04