~ruther/qmk_firmware

9f1608a6a2c7137c0c6ff0f40ddce67ad018aa80 — Takeshi Nishio 4 years ago 0a056cf
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.

https://github.com/qmk/qmk_firmware/pull/11982#discussion_r582276979

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

https://github.com/qmk/qmk_firmware/pull/11820

* Remove old defines for Audio.

Co-authored-by: Takeshi Nishio <kkeennnn@gmail.com>
A keyboards/unison/keymaps/default/keymap.c => keyboards/unison/keymaps/default/keymap.c +26 -0
@@ 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
    )
};

A keyboards/unison/keymaps/default/readme.md => keyboards/unison/keymaps/default/readme.md +6 -0
@@ 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.

A keyboards/unison/keymaps/default_music/keymap.c => keyboards/unison/keymaps/default_music/keymap.c +26 -0
@@ 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
    )
};

A keyboards/unison/keymaps/default_music/readme.md => keyboards/unison/keymaps/default_music/readme.md +6 -0
@@ 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".

A keyboards/unison/keymaps/via/config.h => keyboards/unison/keymaps/via/config.h +25 -0
@@ 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

A keyboards/unison/keymaps/via/keymap.c => keyboards/unison/keymaps/via/keymap.c +139 -0
@@ 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
}

A keyboards/unison/keymaps/via/readme.md => keyboards/unison/keymaps/via/readme.md +36 -0
@@ 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.

A keyboards/unison/keymaps/via/rules.mk => keyboards/unison/keymaps/via/rules.mk +5 -0
@@ 0,0 1,5 @@
MOUSEKEY_ENABLE = yes
AUDIO_ENABLE = yes

BOOTMAGIC_ENABLE = lite
VIA_ENABLE = yes

A keyboards/unison/readme.md => keyboards/unison/readme.md +26 -0
@@ 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).

A keyboards/unison/rules.mk => keyboards/unison/rules.mk +1 -0
@@ 0,0 1,1 @@
DEFAULT_FOLDER = unison/v04

A keyboards/unison/v04/config.h => keyboards/unison/v04/config.h +125 -0
@@ 0,0 1,125 @@
/*
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

#include "config_common.h"

/* USB Device descriptor parameter */
#define VENDOR_ID 0xB9DD
#define PRODUCT_ID 0x176A
#define DEVICE_VER 0x0040
#define MANUFACTURER jpskenn
#define PRODUCT Unison

/* key matrix size */
/* NOTE: With Round-Robin matrix, set same size for both. */
#define MATRIX_ROWS 10
#define MATRIX_COLS 10

/* key matrix pins */
/* NOTE: With Round-Robin matrix, set same pins for both. */
#define MATRIX_ROW_PINS { B3, E6, F1, F5, F7, B2, F0, F4, F6, C7 }
#define MATRIX_COL_PINS { B3, E6, F1, F5, F7, B2, F0, F4, F6, C7 }
#define UNUSED_PINS

#define DIODE_DIRECTION COL2ROW

/* Rotary Encoder */
#ifdef ENCODER_ENABLE
  #define ENCODERS_PAD_A { B0, D2, D5, D6, B4 }
  #define ENCODERS_PAD_B { B1, D3, D4, D7, B5 }
  #define ENCODER_RESOLUTION 4  //the default & suggested is 4
#endif

/* Audio */
#ifdef AUDIO_ENABLE
  #define AUDIO_PIN C6
  #define AUDIO_PIN_ALT B6
  #define AUDIO_CLICKY
  #define MUSIC_MAP
#endif

/* RGB Lighting */
#define RGB_DI_PIN B7
#ifdef RGB_DI_PIN
  #define RGBLED_NUM 7 // Layer Indicator(2) + Rotary Encoder(5)
  #define RGBLIGHT_LED_MAP {1, 2, 0, 3, 4, 5, 6} // align LEDs from Left to Right
  #define RGBLIGHT_HUE_STEP 4
  #define RGBLIGHT_SAT_STEP 8
  #define RGBLIGHT_VAL_STEP 8
  #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
  // #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
  /*== Lighting Layers ==*/
  #define RGBLIGHT_LAYERS
  // #define RGBLIGHT_MAX_LAYERS 2
  #define RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF // Overriding RGB Lighting on/off status
  /*== all animations enable ==*/
  // #define RGBLIGHT_ANIMATIONS
  /*== or choose animations ==*/
  #define RGBLIGHT_EFFECT_BREATHING
  #define RGBLIGHT_EFFECT_RAINBOW_MOOD
  #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
  // #define RGBLIGHT_EFFECT_SNAKE
  // #define RGBLIGHT_EFFECT_KNIGHT
  // #define RGBLIGHT_EFFECT_CHRISTMAS
  // #define RGBLIGHT_EFFECT_STATIC_GRADIENT
  // #define RGBLIGHT_EFFECT_RGB_TEST
  // #define RGBLIGHT_EFFECT_ALTERNATING
  #define RGBLIGHT_EFFECT_TWINKLE
  // /*== customize breathing effect ==*/
  // /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
  // #define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
  // /*==== use exp() and sin() ====*/
  // #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
  // #define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
#endif

/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 5

/*
 * BOOTMAGIC Lite
 * Hold Left-Top key to enter bootloader.
 *
 * NOTE:
 * With Round-Robin matrix, diagonal position is always High.
 * So, the default (0,0) is always judged as hold and keyboard enters bootloader.
 * To prevent this, set specific position for it.
 */
#define BOOTMAGIC_LITE_ROW 5
#define BOOTMAGIC_LITE_COLUMN 0

/*
 * Feature disable options
 *  These options are also useful to firmware size reduction.
 */

/* disable debug print */
//#define NO_DEBUG

/* disable print */
//#define NO_PRINT

/* disable action features */
//#define NO_ACTION_LAYER
//#define NO_ACTION_TAPPING
//#define NO_ACTION_ONESHOT

/* disable these deprecated features by default */
#define NO_ACTION_MACRO
#define NO_ACTION_FUNCTION

A keyboards/unison/v04/info.json => keyboards/unison/v04/info.json +27 -0
@@ 0,0 1,27 @@
{
    "keyboard_name": "Unison",
    "url": "https://github.com/jpskenn/Unison",
    "maintainer": "jpskenn",
    "width": 17,
    "height": 5.5,
    "layouts": {
        "LAYOUT_all": {
            "layout": [
                {"x":0, "y":0.5}, {"label":"/", "x":1, "y":0.5}, {"label":"*", "x":2, "y":0.5}, {"label":"-", "x":3, "y":0.5}, {"label":"Esc", "x":4, "y":0.5}, {"label":"1", "x":5, "y":0.5}, {"label":"2", "x":6, "y":0.5}, {"label":"3", "x":7, "y":0.5}, {"label":"4", "x":8, "y":0.5}, {"label":"5", "x":9, "y":0.5}, {"label":"6", "x":10, "y":0.5}, {"label":"7", "x":11, "y":0.5}, {"label":"8", "x":12, "y":0.5}, {"label":"9", "x":13, "y":0.5}, {"label":"0", "x":14, "y":0.5}, {"label":"-", "x":15, "y":0.5}, {"label":"=", "x":16, "y":0.5},
                {"label":"7", "x":0, "y":1.5}, {"label":"8", "x":1, "y":1.5}, {"label":"9", "x":2, "y":1.5}, {"label":"+", "x":3, "y":1.5}, {"label":"Tab", "x":4, "y":1.5, "w":1.5}, {"label":"Q", "x":5.5, "y":1.5}, {"label":"W", "x":6.5, "y":1.5}, {"label":"E", "x":7.5, "y":1.5}, {"label":"R", "x":8.5, "y":1.5}, {"label":"T", "x":9.5, "y":1.5}, {"label":"Y", "x":10.5, "y":1.5}, {"label":"U", "x":11.5, "y":1.5}, {"label":"I", "x":12.5, "y":1.5}, {"label":"O", "x":13.5, "y":1.5}, {"label":"P", "x":14.5, "y":1.5}, {"label":"Backspace", "x":15.5, "y":1.5, "w":1.5},
                {"label":"4", "x":0, "y":2.5}, {"label":"5", "x":1, "y":2.5}, {"label":"6", "x":2, "y":2.5}, {"label":"+", "x":3, "y":2.5}, {"label":"Ctrl", "x":4, "y":2.5, "w":1.5}, {"label":"A", "x":5.5, "y":2.5}, {"label":"S", "x":6.5, "y":2.5}, {"label":"D", "x":7.5, "y":2.5}, {"label":"F", "x":8.5, "y":2.5}, {"label":"G", "x":9.5, "y":2.5}, {"label":"H", "x":10.5, "y":2.5}, {"label":"J", "x":11.5, "y":2.5}, {"label":"K", "x":12.5, "y":2.5}, {"label":"L", "x":13.5, "y":2.5}, {"label":";", "x":14.5, "y":2.5}, {"label":"Enter", "x":15.5, "y":2.5, "w":1.5},
                {"label":"1", "x":0, "y":3.5}, {"label":"2", "x":1, "y":3.5}, {"label":"3", "x":2, "y":3.5}, {"label":"Enter", "x":3, "y":3.5}, {"label":"Sfhift", "x":4, "y":3.5}, {"label":"Shift", "x":5, "y":3.5}, {"label":"Z", "x":6, "y":3.5}, {"label":"X", "x":7, "y":3.5}, {"label":"C", "x":8, "y":3.5}, {"label":"V", "x":9, "y":3.5}, {"label":"B", "x":10, "y":3.5}, {"label":"N", "x":11, "y":3.5}, {"label":"M", "x":12, "y":3.5}, {"label":"<", "x":13, "y":3.5}, {"label":">", "x":14, "y":3.5}, {"label":"Up", "x":15, "y":3.5}, {"label":"?", "x":16, "y":3.5},
                {"label":"0", "x":0, "y":4.5}, {"label":"00", "x":1, "y":4.5}, {"label":".", "x":2, "y":4.5}, {"label":"Enter", "x":3, "y":4.5}, {"x":4, "y":4.5}, {"x":5, "y":4.5}, {"label":"Opt", "x":6, "y":4.5}, {"label":"Cmd", "x":7, "y":4.5}, {"label":"Lower", "x":8, "y":4.5}, {"label":"Lower", "x":9, "y":4.5}, {"x":10, "y":4.5}, {"label":"Raise", "x":11, "y":4.5}, {"label":"Raise", "x":12, "y":4.5}, {"label":"Cmd", "x":13, "y":4.5}, {"label":"Left", "x":14, "y":4.5}, {"label":"Down", "x":15, "y":4.5}, {"label":"Right", "x":16, "y":4.5}
            ]
        },
        "LAYOUT_music": {
            "layout": [
                {"label":"R.E.1", "x":2, "y":0.25}, {"label":"F1", "x":4, "y":0.25}, {"label":"F2", "x":5, "y":0.25}, {"label":"F3", "x":6, "y":0.25}, {"label":"F4", "x":7, "y":0.25}, {"label":"R.E.2", "x":9, "y":0.25}, {"label":"R.E.3", "x":11, "y":0.25}, {"label":"R.E.4", "x":13, "y":0.25}, {"label":"R.E.5", "x":15, "y":0.25},
                {"label":"7", "x":0, "y":1.5}, {"label":"8", "x":1, "y":1.5}, {"label":"9", "x":2, "y":1.5}, {"label":"/", "x":3, "y":1.5}, {"label":"Tab", "x":4, "y":1.5, "w":1.5}, {"label":"Q", "x":5.5, "y":1.5}, {"label":"W", "x":6.5, "y":1.5}, {"label":"E", "x":7.5, "y":1.5}, {"label":"R", "x":8.5, "y":1.5}, {"label":"T", "x":9.5, "y":1.5}, {"label":"Y", "x":10.5, "y":1.5}, {"label":"U", "x":11.5, "y":1.5}, {"label":"I", "x":12.5, "y":1.5}, {"label":"O", "x":13.5, "y":1.5}, {"label":"P", "x":14.5, "y":1.5}, {"label":"Backspace", "x":15.5, "y":1.5, "w":1.5},
                {"label":"4", "x":0, "y":2.5}, {"label":"5", "x":1, "y":2.5}, {"label":"6", "x":2, "y":2.5}, {"label":"*", "x":3, "y":2.5}, {"label":"Ctrl", "x":4, "y":2.5, "w":1.5}, {"label":"A", "x":5.5, "y":2.5}, {"label":"S", "x":6.5, "y":2.5}, {"label":"D", "x":7.5, "y":2.5}, {"label":"F", "x":8.5, "y":2.5}, {"label":"G", "x":9.5, "y":2.5}, {"label":"H", "x":10.5, "y":2.5}, {"label":"J", "x":11.5, "y":2.5}, {"label":"K", "x":12.5, "y":2.5}, {"label":"L", "x":13.5, "y":2.5}, {"label":";", "x":14.5, "y":2.5}, {"label":"Enter", "x":15.5, "y":2.5, "w":1.5},
                {"label":"1", "x":0, "y":3.5}, {"label":"2", "x":1, "y":3.5}, {"label":"3", "x":2, "y":3.5}, {"label":"-", "x":3, "y":3.5}, {"label":"Sfhift", "x":4, "y":3.5}, {"label":"Shift", "x":5, "y":3.5}, {"label":"Z", "x":6, "y":3.5}, {"label":"X", "x":7, "y":3.5}, {"label":"C", "x":8, "y":3.5}, {"label":"V", "x":9, "y":3.5}, {"label":"B", "x":10, "y":3.5}, {"label":"N", "x":11, "y":3.5}, {"label":"M", "x":12, "y":3.5}, {"label":"<", "x":13, "y":3.5}, {"label":">", "x":14, "y":3.5}, {"label":"Up", "x":15, "y":3.5}, {"label":"?", "x":16, "y":3.5},
                {"label":"0", "x":0, "y":4.5}, {"label":".", "x":1, "y":4.5}, {"label":"Enter", "x":2, "y":4.5}, {"label":"+", "x":3, "y":4.5}, {"x":4, "y":4.5}, {"x":5, "y":4.5}, {"label":"Opt", "x":6, "y":4.5}, {"label":"Cmd", "x":7, "y":4.5}, {"label":"Lower", "x":8, "y":4.5}, {"label":"Lower", "x":9, "y":4.5}, {"x":10, "y":4.5}, {"label":"Raise", "x":11, "y":4.5}, {"label":"Raise", "x":12, "y":4.5}, {"label":"Cmd", "x":13, "y":4.5}, {"label":"Left", "x":14, "y":4.5}, {"label":"Down", "x":15, "y":4.5}, {"label":"Right", "x":16, "y":4.5}
            ]
        }
    }
}

A keyboards/unison/v04/readme.md => keyboards/unison/v04/readme.md +26 -0
@@ 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).

A keyboards/unison/v04/rules.mk => keyboards/unison/v04/rules.mk +25 -0
@@ 0,0 1,25 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration
MOUSEKEY_ENABLE = no        # Mouse keys
EXTRAKEY_ENABLE = yes       # Audio control and System control
CONSOLE_ENABLE = no         # Console for debug
COMMAND_ENABLE = no         # Commands for debug and configuration
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
NKRO_ENABLE = no            # USB Nkey Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
AUDIO_ENABLE = no           # Audio output
ENCODER_ENABLE = no         # Rotary Encoder

LTO_ENABLE = yes

A keyboards/unison/v04/v04.c => keyboards/unison/v04/v04.c +27 -0
@@ 0,0 1,27 @@
/* 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 "v04.h"

#if defined(AUDIO_ENABLE) && defined(MUSIC_MAP)
const uint8_t music_map[MATRIX_ROWS][MATRIX_COLS] = LAYOUT_all(
    0,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,
    0,  32,33,34,35,36,37,38,39,40,41,42,43,44,45, 46,
    0,  17,18,19,20,21,22,23,24,25,26,27,28,29,30, 31,
    0, 1, 2, 3, 4, 5, 6, 7, 8, 9,10,11,12,13,14,15,16,
    0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
);
#endif

A keyboards/unison/v04/v04.h => keyboards/unison/v04/v04.h +80 -0
@@ 0,0 1,80 @@
/* 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

#include "quantum.h"

/*
FULL 10x10 ROUND-ROBIN MATRIX for Reference
{ KC_NO, k12,   k13,   k14,   k15,   k16,   k17,   k18,   k19,   k1a,   }, \
{ k21,   KC_NO, k23,   k24,   k25,   k26,   k27,   k28,   k29,   k2a,   }, \
{ k31,   k32,   KC_NO, k34,   k35,   k36,   k37,   k38,   k39,   k3a,   }, \
{ k41,   k42,   k43,   KC_NO, k45,   k46,   k47,   k48,   k49,   k4a,   }, \
{ k51,   k52,   k53,   k54,   KC_NO, k56,   k57,   k58,   k59,   k5a,   }, \
{ k61,   k62,   k63,   k64,   k65,   KC_NO, k67,   k68,   k69,   k6a,   }, \
{ k71,   k72,   k73,   k74,   k75,   k76,   KC_NO, k78,   k79,   k7a,   }, \
{ k81,   k82,   k83,   k84,   k85,   k86,   k87,   KC_NO, k89,   k8a,   }, \
{ k91,   k92,   k93,   k94,   k95,   k96,   k97,   k98,   KC_NO, k9a,   }, \
{ ka1,   ka2,   ka3,   ka4,   ka5,   ka6,   ka7,   ka8,   ka9,   KC_NO, }  \
*/

/* This is a shortcut to help you visually see your layout.
 *
 * The first section contains all of the arguments representing the physical
 * layout of the board and position of the keys.
 *
 * The second converts the arguments into a two-dimensional array which
 * represents the switch matrix.
 */
#define LAYOUT_all( \
    k61,k12,k62,k13,k63,k14,k64,k15,k65,k16,k67,k17,k68,k18,k69,k19,k6a, \
    k71,  k21,k72,k23,k73,k24,k74,k25,k75,k26,k76,k27,k78,k28,k79,  k7a, \
    k81,  k31,k82,k32,k83,k34,k84,k35,k85,k36,k86,k37,k87,k38,k89,  k8a, \
    k91,k41,k92,k42,k93,k43,k94,k45,k95,k46,k96,k47,k97,k48,k98,k49,k9a, \
    ka1,k51,ka2,k52,ka3,k53,ka4,k54,ka5,k56,ka6,k57,ka7,k58,ka8,k59,ka9  \
) \
{ \
    { KC_NO, k12,   k13,   k14,   k15,   k16,   k17,   k18,   k19,   KC_NO, }, \
    { k21,   KC_NO, k23,   k24,   k25,   k26,   k27,   k28,   KC_NO, KC_NO, }, \
    { k31,   k32,   KC_NO, k34,   k35,   k36,   k37,   k38,   KC_NO, KC_NO, }, \
    { k41,   k42,   k43,   KC_NO, k45,   k46,   k47,   k48,   k49,   KC_NO, }, \
    { k51,   k52,   k53,   k54,   KC_NO, k56,   k57,   k58,   k59,   KC_NO, }, \
    { k61,   k62,   k63,   k64,   k65,   KC_NO, k67,   k68,   k69,   k6a,   }, \
    { k71,   k72,   k73,   k74,   k75,   k76,   KC_NO, k78,   k79,   k7a,   }, \
    { k81,   k82,   k83,   k84,   k85,   k86,   k87,   KC_NO, k89,   k8a,   }, \
    { k91,   k92,   k93,   k94,   k95,   k96,   k97,   k98,   KC_NO, k9a,   }, \
    { ka1,   ka2,   ka3,   ka4,   ka5,   ka6,   ka7,   ka8,   ka9,   KC_NO, }  \
}
#define LAYOUT_music( \
            k62,    k63,k14,k64,k15,    k16,    k17,    k18,    k19,     \
    k71,k21,k72,k23,k73,  k24,k74,k25,k75,k26,k76,k27,k78,k28,k79,  k7a, \
    k81,k31,k82,k32,k83,  k34,k84,k35,k85,k36,k86,k37,k87,k38,k89,  k8a, \
    k91,k41,k92,k42,k93,k43,k94,k45,k95,k46,k96,k47,k97,k48,k98,k49,k9a, \
    ka1,k51,ka2,k52,ka3,k53,ka4,k54,ka5,k56,ka6,k57,ka7,k58,ka8,k59,ka9  \
) \
{ \
    { KC_NO, KC_NO, KC_NO, k14,   k15,   k16,   k17,   k18,   k19,   KC_NO, }, \
    { k21,   KC_NO, k23,   k24,   k25,   k26,   k27,   k28,   KC_NO, KC_NO, }, \
    { k31,   k32,   KC_NO, k34,   k35,   k36,   k37,   k38,   KC_NO, KC_NO, }, \
    { k41,   k42,   k43,   KC_NO, k45,   k46,   k47,   k48,   k49,   KC_NO, }, \
    { k51,   k52,   k53,   k54,   KC_NO, k56,   k57,   k58,   k59,   KC_NO, }, \
    { KC_NO, k62,   k63,   k64,   KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, }, \
    { k71,   k72,   k73,   k74,   k75,   k76,   KC_NO, k78,   k79,   k7a,   }, \
    { k81,   k82,   k83,   k84,   k85,   k86,   k87,   KC_NO, k89,   k8a,   }, \
    { k91,   k92,   k93,   k94,   k95,   k96,   k97,   k98,   KC_NO, k9a,   }, \
    { ka1,   ka2,   ka3,   ka4,   ka5,   ka6,   ka7,   ka8,   ka9,   KC_NO, }  \
}