Skip to content

Commit b7d7da3

Browse files
author
te9no
committed
update
1 parent aa1abe0 commit b7d7da3

File tree

2 files changed

+59
-18
lines changed

2 files changed

+59
-18
lines changed

docs/src/content/docs/guides/05.firmware.md

Lines changed: 59 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ title: MeKaBuファームウェア取り扱いガイド
4444
4545
├─.github
4646
│ └─workflows
47-
│ build-nix.yml・・・nix版build.yml
47+
│ build-nix.yml・・・nix版build.yml→⚠️Outdated
4848
│ build.yml・・・通常のbuild.yml
4949
│ draw-keymap.yml・・・キーマップ画像ファイル生成用
5050
@@ -73,8 +73,6 @@ title: MeKaBuファームウェア取り扱いガイド
7373
│ MKB_L_TPD.conf・・・トラックパッドモジュールconfig
7474
│ MKB_L_TPD.overlay・・・トラックパッドモジュールdevice tree
7575
│ MKB_pinctrl_L.dtsi・・・OLED用ピン配置設定
76-
│ MKB_L_JOY.conf・・・アナログスティック&エンコーダモジュールconfig
77-
│ MKB_L_JOY.overlay・・・アナログスティック&エンコーダモジュールdevice tree
7876

7977
~以下右手~
8078
│ MKB_pinctrl_R.dtsi
@@ -84,17 +82,28 @@ title: MeKaBuファームウェア取り扱いガイド
8482
│ MKB_R_ENC.overlay
8583
│ MKB_R_JOY.conf
8684
│ MKB_R_JOY.overlay
85+
│ MKB_R_KEY.conf
86+
│ MKB_R_KEY.overlay
8787
│ MKB_R_RZT.conf
8888
│ MKB_R_RZT.overlay
8989
│ MKB_R_TB.conf
90-
│ MKB_R_TB.overlay
90+
│ MKB_R_TB.overlay
91+
│ MKB_R_TBv3.conf ・・・(旧開発版)トラックボールモジュールconfig
92+
│ MKB_R_TBv3.overlay ・・・(旧開発版)トラックボールモジュールdevice tree
93+
│ MKB_R_TPD.conf
94+
│ MKB_R_TPD.overlay
9195
9296
├─config
9397
│ kle.json・・・kle用json
9498
│ MKB.json・・・keymap drawer用json
9599
**│ MKB.keymap・・・キーマップ**
96100
│ west.yml・・・module定義
97101
102+
├─snippets ・・・snippet(overlayの一種)
103+
│ └─Default ・・・snippet名
104+
│ Default.overlay ・・・左手input-listener用overlay
105+
│ snippet.yml ・・・左手input-listener用overlay用snippet定義
106+
98107
├─firmware・・・ファームウェア置き場
99108
│ ├─main・・・ブランチ名
100109
│ │ └─firmware
@@ -105,7 +114,8 @@ title: MeKaBuファームウェア取り扱いガイド
105114
│ │ MKB_R_MODULE_ENC.uf2
106115
│ │ MKB_R_MODULE_JOY.uf2
107116
│ │ MKB_R_MODULE_RZT.uf2
108-
│ │ MKB_R_MODULE_TB.uf2
117+
│ │ MKB_R_MODULE_TBv3.uf2 ・・・(旧開発版)右手トラックボールモジュール用⚠️通常は使用しません
118+
│ │ MKB_R_MODULE_TBv4.uf2
109119
│ │ settings_reset-seeeduino_xiao_ble-zmk.uf2
110120
│ │・・・
111121
@@ -115,15 +125,25 @@ title: MeKaBuファームウェア取り扱いガイド
115125
│ MKB.yaml
116126
117127
└─zephyr・・・だいじなやつ
118-
module.yml
128+
module.yml
119129

120130
# ファームウェアの書き込み方法
121131

122132
[https://zmk.dev/docs/user-setup#flashing-uf2-files](https://zmk.dev/docs/user-setup#flashing-uf2-files)
123133

134+
例:標準構成(左手エンコーダ、右手トラックボール)の場合
135+
→左手側に「MKB_L_MODULE_ENC.uf2」、右手側に「MKB_R_MODULE_TBv4.uf2」(⚠️MKB_R_MODULE_TBv3.uf2ではありません)を書き込む。
136+
137+
例:左手アナログスティック、右手トラックボールの場合
138+
→左手側に「MKB_L_MODULE_JOY.uf2」、右手側に「MKB_R_MODULE_TBv4.uf2」を書き込む。
139+
140+
例:左手トラックボール、右手トラックボールの場合
141+
→左手側に「MKB_L_MODULE_TB.uf2」、右手側に「MKB_R_MODULE_TBv4.uf2」を書き込む。
142+
124143
# キーマップの更新方法
125144

126145
リポジトリをフォークして編集するか、[Keymap Editor](https://nickcoutsos.github.io/keymap-editor/)を使用してください。
146+
[ZMK Studio](https://zmk.studio//)[DYA Studio](https://studio.dya.cormoran.works/)にも対応しています。
127147

128148
# モジュールとファームウェアの交換方法
129149

@@ -134,18 +154,39 @@ module.yml
134154
- ボトムケースを取り付ける
135155
- PCと接続して、新しいモジュールに対応するファームウェアを書き込む
136156

137-
# Nixビルドの無効化&標準ビルドの有効化
138-
139-
/zmk-config-MKB/.github/workflows/build.ymlを編集
140-
141-
![image.png](firmware/image.png)
142-
143-
![image.png](firmware/image .png)
144-
145-
不要であれば/zmk-config-MKB/.github/workflows/build-nix.ymlを削除
146-
147157
# FAQ
148158

149-
Q.AMLをOFFにする方法を教えていただけないでしょうか
159+
Q.AMLをONにする方法を教えていただけないでしょうか
160+
DYA StudioでTemporary Layerを指定
161+
![alt text](./firmware/AML.png)
162+
163+
Q.トラックパッドモジュールの上下を反転したい
164+
https://github.com/te9no/zmk-config-MKB2/blob/main/snippets/Default/Default.overlay#L67-L72
165+
```dsti
166+
input-processors = <&zip_xy_transform (INPUT_TRANSFORM_XY_SWAP)>,
167+
<&zip_xy_transform INPUT_TRANSFORM_Y_INVERT>,
168+
<&scroll_runtime_input_processor>;
169+
170+
scroller {
171+
layers = <5>;
172+
input-processors = <&zip_xy_transform (INPUT_TRANSFORM_XY_SWAP)>,
173+
<&zip_xy_transform INPUT_TRANSFORM_Y_INVERT>,
174+
<&zip_xy_to_scroll_mapper>,
175+
<&scroll_runtime_input_processor>;
176+
};
177+
```
150178

151-
MKB_L_Base.overlayの zip_temp_layerをOFF(コメントアウトか消去)にする
179+
左右も反転したいなら
180+
```dsti
181+
input-processors = <&zip_xy_transform (INPUT_TRANSFORM_XY_SWAP)>,
182+
<&zip_xy_transform (INPUT_TRANSFORM_X_INVERT | INPUT_TRANSFORM_Y_INVERT)>,
183+
<&scroll_runtime_input_processor>;
184+
185+
scroller {
186+
layers = <5>;
187+
input-processors = <&zip_xy_transform (INPUT_TRANSFORM_XY_SWAP)>,
188+
<&zip_xy_transform (INPUT_TRANSFORM_X_INVERT | INPUT_TRANSFORM_Y_INVERT)>,
189+
<&zip_xy_to_scroll_mapper>,
190+
<&scroll_runtime_input_processor>;
191+
};
192+
```
103 KB
Loading

0 commit comments

Comments
 (0)