Skip to content

Commit

Permalink
doc about new keycodes (all others)
Browse files Browse the repository at this point in the history
  • Loading branch information
koron committed Sep 16, 2023
1 parent 5f51387 commit fb8a720
Show file tree
Hide file tree
Showing 12 changed files with 743 additions and 705 deletions.
14 changes: 1 addition & 13 deletions keyball39/doc/rev1/buildguide_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -575,23 +575,11 @@ The latest firmware for Keyball39 is available at [Github repository](https://gi
- The USB cable can be plugged in either left or right. However, since the keymap is written to the ProMicro on the side where the USB cable is plugged in, please review the keymap when replacing the cable for the first time.
- There are Special keys for Keyball users as below list. It is located on Layer 3. These key codes can be used for switching Cursor action to Scroll or Changing CPI and Speed of Scroll.

| Keycode | Value on Remap | Description |
|:-|:-|:-|
| `KBC_RST` | `0x5DA5` | Reset Keyball configuration |
| `KBC_SAVE` | `0x5DA6` | Persist Keyball configuration to EEPROM |
| `CPI_I100` | `0x5DA7` | Increase 100 CPI (max 12000) |
| `CPI_D100` | `0x5DA8` | Decrease 100 CPI (min 100) |
| `CPI_I1K` | `0x5DA9` | Increase 1000 CPI (max 12000) |
| `CPI_D1K` | `0x5DAA` | Decrease 1000 CPI (min 100) |
| `SCRL_TO` | `0x5DAB` | Toggle scroll mode |
| `SCRL_MO` | `0x5DAC` | Enable scroll mode when pressing |
| `SCRL_DVI` | `0x5DAD` | Increase scroll divider (max D7 = 1/128) <- Most Scroll slow |
| `SCRL_DVD` | `0x5DAE` | Decrease scroll divider (min 0 = 1/1) <- Most Scroll fast |
See [Special Keycode](./keycodes.md#english) also.



This concludes the Keyball39 build guide.
If you have any questions or problems with Keyball39, please post them to the Github repository [Yowkees/keyball Discussions](https://github.com/Yowkees/keyball/discussions). We'll get back to you as soon as possible.

Thank you very much. @Yowkees 2022

14 changes: 2 additions & 12 deletions keyball39/doc/rev1/buildguide_jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -590,18 +590,8 @@ Keyball39の最新ファームウェアは[Githubのリポジトリ](https://git
- USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
- Keyballシリーズ用に特別に用意されたキーコードがレイヤー3に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。

| キーコード | Remap上での表記 | 説明 |
|:-|:-|:-|
| `KBC_RST` | `0x5DA5` | Keyball設定のリセット |
| `KBC_SAVE` | `0x5DA6` | 現在のKeyball設定をEEPROMに保存します |
| `CPI_I100` | `0x5DA7` | CPIを100増加させます(最大:12000) |
| `CPI_D100` | `0x5DA8` | CPIを100減少させます(最小:100) |
| `CPI_I1K` | `0x5DA9` | CPIを1000増加させます(最大:12000) |
| `CPI_D1K` | `0x5DAA` | CPIを1000減少させます(最小:100) |
| `SCRL_TO` | `0x5DAB` | タップごとにスクロールモードのON/OFFを切り替えます |
| `SCRL_MO` | `0x5DAC` | キーを押している間、スクロールモードになります |
| `SCRL_DVI` | `0x5DAD` | スクロール除数を1つ上げます(max D7 = 1/128)←最もスクロール遅い |
| `SCRL_DVD` | `0x5DAE` | スクロール除数を1つ下げます(min D0 = 1/1)←最もスクロール速い |
詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。



以上でKeyball39のビルドガイドは終了です。
Expand Down
14 changes: 2 additions & 12 deletions keyball39/doc/rev1/buildguide_jp_conth.md
Original file line number Diff line number Diff line change
Expand Up @@ -590,18 +590,8 @@ Keyball39の最新ファームウェアは[Githubのリポジトリ](https://git
- USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
- Keyballシリーズ用に特別に用意されたキーコードがレイヤー3に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。

| キーコード | Remap上での表記 | 説明 |
|:-|:-|:-|
| `KBC_RST` | `0x5DA5` | Keyball設定のリセット |
| `KBC_SAVE` | `0x5DA6` | 現在のKeyball設定をEEPROMに保存します |
| `CPI_I100` | `0x5DA7` | CPIを100増加させます(最大:12000) |
| `CPI_D100` | `0x5DA8` | CPIを100減少させます(最小:100) |
| `CPI_I1K` | `0x5DA9` | CPIを1000増加させます(最大:12000) |
| `CPI_D1K` | `0x5DAA` | CPIを1000減少させます(最小:100) |
| `SCRL_TO` | `0x5DAB` | タップごとにスクロールモードのON/OFFを切り替えます |
| `SCRL_MO` | `0x5DAC` | キーを押している間、スクロールモードになります |
| `SCRL_DVI` | `0x5DAD` | スクロール除数を1つ上げます(max D7 = 1/128)←最もスクロール遅い |
| `SCRL_DVD` | `0x5DAE` | スクロール除数を1つ下げます(min D0 = 1/1)←最もスクロール速い |
詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。



以上でKeyball39のビルドガイドは終了です。
Expand Down
36 changes: 36 additions & 0 deletions keyball39/doc/rev1/keycodes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Keyball: Special Keycodes

* [English/英語](#english)
* [日本語/Japanese](#japanese)

<a id="english"></a>
## Special Keycodes

| Keycode | Value on Remap | Value | Description |
|:-----------|:----------------|:---------|:------------------------------------------------------------------|
| `KBC_RST` | `Kb 0` | `0x7e00` | Reset Keyball configuration |
| `KBC_SAVE` | `Kb 1` | `0x7e01` | Persist Keyball configuration to EEPROM |
| `CPI_I100` | `Kb 2` | `0x7e02` | Increase 100 CPI (max 12000) |
| `CPI_D100` | `Kb 3` | `0x7e03` | Decrease 100 CPI (min 100) |
| `CPI_I1K` | `Kb 4` | `0x7e04` | Increase 1000 CPI (max 12000) |
| `CPI_D1K` | `Kb 5` | `0x7e05` | Decrease 1000 CPI (min 100) |
| `SCRL_TO` | `Kb 6` | `0x7e06` | Toggle scroll mode |
| `SCRL_MO` | `Kb 7` | `0x7e07` | Enable scroll mode when pressing |
| `SCRL_DVI` | `Kb 8` | `0x7e08` | Increase scroll divider (max D7 = 1/128) <- Most Scroll slow |
| `SCRL_DVD` | `Kb 9` | `0x7e09` | Decrease scroll divider (min 0 = 1/1) <- Most Scroll fast |

<a id="japanese"></a>
## 特殊キーコード

| キーコード | Remap上での表記 || 説明 |
|:-----------|:----------------|:---------|:------------------------------------------------------------------|
| `KBC_RST` | `Kb 0` | `0x7e00` | Keyball設定のリセット |
| `KBC_SAVE` | `Kb 1` | `0x7e01` | 現在のKeyball設定をEEPROMに保存します |
| `CPI_I100` | `Kb 2` | `0x7e02` | CPIを100増加させます(最大:12000) |
| `CPI_D100` | `Kb 3` | `0x7e03` | CPIを100減少させます(最小:100) |
| `CPI_I1K` | `Kb 4` | `0x7e04` | CPIを1000増加させます(最大:12000) |
| `CPI_D1K` | `Kb 5` | `0x7e05` | CPIを1000減少させます(最小:100) |
| `SCRL_TO` | `Kb 6` | `0x7e06` | タップごとにスクロールモードのON/OFFを切り替えます |
| `SCRL_MO` | `Kb 7` | `0x7e07` | キーを押している間、スクロールモードになります |
| `SCRL_DVI` | `Kb 8` | `0x7e08` | スクロール除数を1つ上げます(max D7 = 1/128)←最もスクロール遅い |
| `SCRL_DVD` | `Kb 9` | `0x7e09` | スクロール除数を1つ下げます(min D0 = 1/1)←最もスクロール速い |
14 changes: 2 additions & 12 deletions keyball44/doc/rev1/buildguide_jp.md
Original file line number Diff line number Diff line change
Expand Up @@ -631,18 +631,8 @@ Keyball44の最新ファームウェアは[Githubのリポジトリ](https://git
- USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
- Keyballシリーズ用に特別に用意されたキーコードがレイヤー3に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。

| キーコード | Remap上での表記 | 説明 |
|:-|:-|:-|
| `KBC_RST` | `0x5DA5` | Keyball設定のリセット |
| `KBC_SAVE` | `0x5DA6` | 現在のKeyball設定をEEPROMに保存します |
| `CPI_I100` | `0x5DA7` | CPIを100増加させます(最大:12000) |
| `CPI_D100` | `0x5DA8` | CPIを100減少させます(最小:100) |
| `CPI_I1K` | `0x5DA9` | CPIを1000増加させます(最大:12000) |
| `CPI_D1K` | `0x5DAA` | CPIを1000減少させます(最小:100) |
| `SCRL_TO` | `0x5DAB` | タップごとにスクロールモードのON/OFFを切り替えます |
| `SCRL_MO` | `0x5DAC` | キーを押している間、スクロールモードになります |
| `SCRL_DVI` | `0x5DAD` | スクロール除数を1つ上げます(max D7 = 1/128)←最もスクロール遅い |
| `SCRL_DVD` | `0x5DAE` | スクロール除数を1つ下げます(min D0 = 1/1)←最もスクロール速い |
詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。



以上でKeyball44のビルドガイドは終了です。
Expand Down
14 changes: 2 additions & 12 deletions keyball44/doc/rev1/buildguide_jp_conth.md
Original file line number Diff line number Diff line change
Expand Up @@ -625,18 +625,8 @@ Keyball44の最新ファームウェアは[Githubのリポジトリ](https://git
- USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
- Keyballシリーズ用に特別に用意されたキーコードがレイヤー3に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。

| キーコード | Remap上での表記 | 説明 |
|:-|:-|:-|
| `KBC_RST` | `0x5DA5` | Keyball設定のリセット |
| `KBC_SAVE` | `0x5DA6` | 現在のKeyball設定をEEPROMに保存します |
| `CPI_I100` | `0x5DA7` | CPIを100増加させます(最大:12000) |
| `CPI_D100` | `0x5DA8` | CPIを100減少させます(最小:100) |
| `CPI_I1K` | `0x5DA9` | CPIを1000増加させます(最大:12000) |
| `CPI_D1K` | `0x5DAA` | CPIを1000減少させます(最小:100) |
| `SCRL_TO` | `0x5DAB` | タップごとにスクロールモードのON/OFFを切り替えます |
| `SCRL_MO` | `0x5DAC` | キーを押している間、スクロールモードになります |
| `SCRL_DVI` | `0x5DAD` | スクロール除数を1つ上げます(max D7 = 1/128)←最もスクロール遅い |
| `SCRL_DVD` | `0x5DAE` | スクロール除数を1つ下げます(min D0 = 1/1)←最もスクロール速い |
詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。



以上でKeyball44のビルドガイドは終了です。
Expand Down
14 changes: 2 additions & 12 deletions keyball44/doc/rev1/buildguide_jp_sub.md
Original file line number Diff line number Diff line change
Expand Up @@ -630,18 +630,8 @@ Keyball44の最新ファームウェアは[Githubのリポジトリ](https://git
- USBケーブルは左右どちらに差しても使用できます。ただしキーマップはUSBケーブルを差した側のProMicroへ書き込まれるため、初めて差し替えた場合にはキーマップを見直してください
- Keyballシリーズ用に特別に用意されたキーコードがレイヤー3に配置されています。トラックボールをスクロールに変化させたり、カーソル速度やスクロール速度変更に使用できます。

| キーコード | Remap上での表記 | 説明 |
|:-|:-|:-|
| `KBC_RST` | `0x5DA5` | Keyball設定のリセット |
| `KBC_SAVE` | `0x5DA6` | 現在のKeyball設定をEEPROMに保存します |
| `CPI_I100` | `0x5DA7` | CPIを100増加させます(最大:12000) |
| `CPI_D100` | `0x5DA8` | CPIを100減少させます(最小:100) |
| `CPI_I1K` | `0x5DA9` | CPIを1000増加させます(最大:12000) |
| `CPI_D1K` | `0x5DAA` | CPIを1000減少させます(最小:100) |
| `SCRL_TO` | `0x5DAB` | タップごとにスクロールモードのON/OFFを切り替えます |
| `SCRL_MO` | `0x5DAC` | キーを押している間、スクロールモードになります |
| `SCRL_DVI` | `0x5DAD` | スクロール除数を1つ上げます(max D7 = 1/128)←最もスクロール遅い |
| `SCRL_DVD` | `0x5DAE` | スクロール除数を1つ下げます(min D0 = 1/1)←最もスクロール速い |
詳しくは [キーコード一覧](./keycodes.md#japanese) を参照してください。



以上でKeyball44のビルドガイドは終了です。
Expand Down
36 changes: 36 additions & 0 deletions keyball44/doc/rev1/keycodes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Keyball: Special Keycodes

* [English/英語](#english)
* [日本語/Japanese](#japanese)

<a id="english"></a>
## Special Keycodes

| Keycode | Value on Remap | Value | Description |
|:-----------|:----------------|:---------|:------------------------------------------------------------------|
| `KBC_RST` | `Kb 0` | `0x7e00` | Reset Keyball configuration |
| `KBC_SAVE` | `Kb 1` | `0x7e01` | Persist Keyball configuration to EEPROM |
| `CPI_I100` | `Kb 2` | `0x7e02` | Increase 100 CPI (max 12000) |
| `CPI_D100` | `Kb 3` | `0x7e03` | Decrease 100 CPI (min 100) |
| `CPI_I1K` | `Kb 4` | `0x7e04` | Increase 1000 CPI (max 12000) |
| `CPI_D1K` | `Kb 5` | `0x7e05` | Decrease 1000 CPI (min 100) |
| `SCRL_TO` | `Kb 6` | `0x7e06` | Toggle scroll mode |
| `SCRL_MO` | `Kb 7` | `0x7e07` | Enable scroll mode when pressing |
| `SCRL_DVI` | `Kb 8` | `0x7e08` | Increase scroll divider (max D7 = 1/128) <- Most Scroll slow |
| `SCRL_DVD` | `Kb 9` | `0x7e09` | Decrease scroll divider (min 0 = 1/1) <- Most Scroll fast |

<a id="japanese"></a>
## 特殊キーコード

| キーコード | Remap上での表記 || 説明 |
|:-----------|:----------------|:---------|:------------------------------------------------------------------|
| `KBC_RST` | `Kb 0` | `0x7e00` | Keyball設定のリセット |
| `KBC_SAVE` | `Kb 1` | `0x7e01` | 現在のKeyball設定をEEPROMに保存します |
| `CPI_I100` | `Kb 2` | `0x7e02` | CPIを100増加させます(最大:12000) |
| `CPI_D100` | `Kb 3` | `0x7e03` | CPIを100減少させます(最小:100) |
| `CPI_I1K` | `Kb 4` | `0x7e04` | CPIを1000増加させます(最大:12000) |
| `CPI_D1K` | `Kb 5` | `0x7e05` | CPIを1000減少させます(最小:100) |
| `SCRL_TO` | `Kb 6` | `0x7e06` | タップごとにスクロールモードのON/OFFを切り替えます |
| `SCRL_MO` | `Kb 7` | `0x7e07` | キーを押している間、スクロールモードになります |
| `SCRL_DVI` | `Kb 8` | `0x7e08` | スクロール除数を1つ上げます(max D7 = 1/128)←最もスクロール遅い |
| `SCRL_DVD` | `Kb 9` | `0x7e09` | スクロール除数を1つ下げます(min D0 = 1/1)←最もスクロール速い |
Loading

0 comments on commit fb8a720

Please sign in to comment.