qmk_firmware/keyboards/unison/readme.md
Takeshi Nishio 9f1608a6a2
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>
2021-03-25 23:38:31 +11:00

27 lines
1.3 KiB
Markdown

# 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).