Skip to content

Commit 167402b

Browse files
Document update for v0.2.0
1 parent 697efc5 commit 167402b

File tree

1 file changed

+24
-19
lines changed

1 file changed

+24
-19
lines changed

AboutDefaultFirmware/doc/getting_start.md

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,44 @@
11
# Getting start
22

3+
BLE Micro Proはブートローダとアプリケーションファームウェアがセットになって動作します。
4+
アップデートする場合ブートローダとアプリケーションのメジャーバージョン・マイナバージョンを一致させるようにしてください。バージョン番号の表記は下記のとおりです。
5+
```
6+
version number: <major>.<minor>.<revision>
7+
```
38

4-
## ブートローダのアップデート
5-
6-
 nRF SDK依存のコードは全てブートローダ内部に移行しました。以前のバージョンを使用している場合はアップデートしてください。
9+
[ブートローダ](https://github.com/sekigon-gonnoc/BLE-Micro-Pro/releases)[コンパイル済みアプリケーションファームウェア](https://github.com/sekigon-gonnoc/qmk_firmware/releases)はReleaseページから入手できます。
10+
コンパイル済みアプリケーションにはQMKのビルドオプションとしてTAPPING_TERM_PER_KEY, PERMISSIVE_HOLD などが設定してあります。
11+
最新版のファームウェアを使いたい場合、自分の好きなオプションを設定したい場合やカスタムキーコードを設定したい場合は[自分でビルドする](build_bmp_qmk_firmware.md)必要があります。
12+
13+
## uf2を使ったアップデート (対応ブートローダのみ)
14+
- キーボードのリセットボタンを押しながらUSB接続、または[CLI](cli.md)からdfuコマンドを送信するとブートローダが起動します。
15+
- BLE Micro Proがマスストレージデバイスとして認識され、中に`INFO_UF2.TXT`があることを確認してください。
16+
- アップデートしたいuf2ファイルをコピーするとアップデートが始まります。アップデート中はケーブルを外さないでください。
17+
- アップデート完了後、自動的に再起動します。`VERSION.TXT`などを確認してアップデートが完了していることを確認してください。
718

19+
## nrfutilを使ったアップデート
820
### nrfutilの準備
921
事前に[nrfutil](https://github.com/NordicSemiconductor/pc-nrfutil)を用意してください。
1022

1123
- Windowsの場合
12-
nrfutil.exeを[ダウンロード](https://github.com/NordicSemiconductor/pc-nrfutil/releases)する
24+
nrfutil.exeを[ダウンロード](https://github.com/NordicSemiconductor/pc-nrfutil/releases)してください
1325

1426
- Linux, Macの場合
15-
pip2でnrfutilをインストールする
27+
pip2でnrfutilをインストールしてください
1628
```
1729
pip2 install --user nrfutil
1830
```
1931
2032
### アップデート方法
21-
- キーボードのリセットボタンを押しながらUSB接続、またはターミナルソフトからdfuコマンドを送信してから以下を実行
33+
- キーボードのリセットボタンを押しながらUSB接続、またはターミナルソフトからdfuコマンドを送信してから以下を実行します。パッケージ名、ポート名は状況に応じて書き換えてください
2234
```
23-
nrfutil dfu usb-serial -pkg ble_micro_pro_bootloader.zip -p <ポート名>
35+
nrfutil dfu usb-serial -pkg <パッケージ名>.zip -p <ポート名>
2436
```
2537
26-
## ファームウェアのアップデート
27-
28-
標準ファームウェアとして[コンパイル済みのファームウェア](https://github.com/sekigon-gonnoc/qmk_firmware/releases/tag/bmp-0.0.1)を定期的にリリースします。
29-
ビルドオプションとしてTAPPINT_TERM_PER_KEY, PERMISSIVE_HOLD などが設定してあります。
30-
最新版のファームウェアを使いたい場合、自分の好きなオプションを設定したい場合やカスタムキーコードを設定したい場合は[自分でビルドする](build_bmp_qmk_firmware.md)必要があります。
31-
```
32-
nrfutil dfu usb-serial -pkg <firmware>.zip -p <ポート名>
33-
```
34-
3538
## 設定ファイルの書き込み
36-
- BLE Micro Pro をPC等にUSBで接続するとマスストレージデバイスとして認識されます
37-
- 使いたいキーボードのconfig.jsonとkeymap.jsonをコピーしてから電源を再投入してください
39+
- BLE Micro Pro をPC等にUSBで接続するとマスストレージデバイスとして認識されます
40+
アプリケーションが起動している場合は`KEYMAP.JSN`や`CONFIG.JSN`といったファイルが確認できます。
41+
- 使いたいキーボードのconfig.jsonとkeymap.jsonをコピーしてから電源を再投入してください。
3842
- keymap.json, tapping_term.jsonは即時反映されるので再起動は必要ありません。
3943
4044
### keymap.jsonの設定
@@ -71,7 +75,8 @@
7175
|peripheral||マスター、一体型の場合: PC等との接続に使われる設定<br>スレーブの場合: マスターとの接続に使われる設定|
7276
|cetral||マスターの場合のみ: スレーブとの接続に使われる設定|
7377
74-
無線接続時に遅延を感じる場合は peripheral, central の max_interval, min_interval を小さくしてください
78+
無線接続時に遅延を感じる場合は peripheral, central の max_interval, min_interval を小さくしてください
79+
また、OSのBLEに関する省電力設定も確認してみてください
7580
7681
### [開発者向け情報](define_new_keyboard.md)
7782

0 commit comments

Comments
 (0)