Skip to content

Commit

Permalink
Added note about Remap supported firmware and QMK Toolbox.
Browse files Browse the repository at this point in the history
  • Loading branch information
ka2hiro committed Jul 23, 2023
1 parent 6e35346 commit 6295d42
Show file tree
Hide file tree
Showing 3 changed files with 141 additions and 20 deletions.
77 changes: 68 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,21 +172,80 @@ USBデバイスとして認識されない場合は、全ての部品が正し
3. _キースイッチのピンは曲がりやすいので、まっすぐになっていることを確認してから取り付けてください。また、 SW7とSW8は向きが他とは反対になっているので、注意してください。_

## ファームウェアを書き込む
__はんだ済みキットでは、デフォルトキーマップが既に書き込まれています。__

ファームウェアはQMKを利用します。以下のリポジトリをクローンしてください。
__はんだ済みキットでは、デフォルトキーマップが既に書き込まれていますので、このステップは必要ありません。__

[qmk_firmware](https://github.com/qmk/qmk_firmware)
ファームウェアの書き込みは、以下の2通りの方法があります。キーマップの書き換え以外にファームウェアのカスタマイズが必要なければ、QMK Toolboxを利用する方法が簡単でおすすめです。

クローンしたら、ローカルリポジトリのディレクトリへ移動し、以下のコマンドを実行すると、ファームウェアを書き込むために待機状態になりますので、キーボードを接続してください。すでにキーボードが接続されている場合は、そのまま書き込みが始まります。
### QMK Toolboxを利用してファームウェアを書き込む

~~~
$ make miniaxe:default:dfu
~~~
1. [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases)の最新版をダウンロード、インストールします。
Windows版は、アプリケーションのみのqmk_toolsbox.exeか、インストーラ込みのqmk_toolbox_install.exeのどちらかをダウンロードします。
Mac版は、アプリケーションのみのQMK.Toolbox.app.zipか、インストーラ込みのQMK.Toolbox.pkgのどちらかをダウンロードします。
2. 以下のリンクからMiniAxeのファームウェアをダウンロードします。
[miniaxe_via.hex](https://github.com/kagizaraya/miniaxe_build_guide/releases/download/remap/miniaxe_via.hex)
3. QMK Toolboxを起動し、ファームウェアを"Local file"へドラッグ&ドロップするか、"Open"をクリックしてファームウェアのファイルを指定します。
![qmk_toolsbox_open.png](images/qmk_toolbox_open.png)
4. MiniAxeにUSBケーブルを接続し、リセットスイッチを押してブートローダモードにすると、QMK Toolboxに以下のように表示されます。
```
Atmel DFU device connected (libusb0): Atmel Corp. ATmega32U4 (03EB:2FF4:0000)
```
5. QMK Toolboxの"Flash"ボタンをクリックすると、書き込みが始まります。
```
Attempting to flash, please don't remove device
> dfu-programmer.exe atmega32u4 erase --force
> Erasing flash... Success
> Checking memory from 0x0 to 0x6FFF... Empty.
> dfu-programmer.exe atmega32u4 flash --force "C:\Temp\miniaxe_via.hex"
> 0% 100% Programming 0x4D00 bytes...
> [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
> 0% 100% Reading 0x7000 bytes...
> [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
> Validating... Success
> 0x4D00 bytes written into 0x7000 bytes memory (68.75%).
> dfu-programmer.exe atmega32u4 reset
```
6. 書き込みが完了すると、以下のように表示されます。
```
Flash complete
Atmel DFU device disconnected (libusb0): Atmel Corp. ATmega32U4 (03EB:2FF4:0000)
```
7. もう片方のMiniAxeにUSBケーブルを接続し、同様にファームウェアを書き込んでください。

初めてファームウェアを書き込む場合は、リセットスイッチを押す必要はありません。

ファームウェアをビルドする環境の構築は、[こちらのドキュメント](https://docs.qmk.fm/#/getting_started_build_tools)を参考にしてください。
### QMK Firmwareをビルドしてファームウェアを書き込む

1. QMKのリポジトリをクローンします。

[qmk_firmware](https://github.com/qmk/qmk_firmware)

Remap用のファームウェアを利用したい場合は、以下のリポジトリをクローンしてください。
[Kagizaraya's qmk_firmware](https://github.com/kagizaraya/qmk_remap)

1. クローンしたら、ローカルリポジトリのディレクトリへ移動し、以下のコマンドを実行すると、ファームウェアを書き込むために待機状態になりますので、キーボードを接続してください。すでにキーボードが接続されている場合は、そのまま書き込みが始まります。

~~~
$ make miniaxe:default:dfu
~~~

Remap用のファームウェアをビルドする場合は、以下のコマンドを実行します。

~~~
$ make miniaxe:via:dfu
~~~

初めてファームウェアを書き込む場合は、リセットスイッチを押す必要はありません。

ファームウェアをビルドする環境の構築は、[こちらのドキュメント](https://docs.qmk.fm/#/ja/newbs_getting_started)を参考にしてください。

## Remapでキーマップを書き換える

Remap対応のファームウェアを使用している場合は、[Remap](https://remap-keys.app/)を使ってキーマップを書き換えることができます。

Remapの使い方は、以下の記事で大変分かりやすく解説されていますので、ぜひご参照ください。

[(初心者編)Remapを使ってキーマップを書き換えよう](https://salicylic-acid3.hatenablog.com/entry/remap-manual)


## 完成!
これで完成です。おつかれさまでした。
Expand Down
84 changes: 73 additions & 11 deletions README_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,23 +175,85 @@ If it is not recognized as a USB device, please double check the schematic to se
2. Join the two halves with the male-male microUSB cable. Connect the microUSB port J2 on one side to J2 on the other side.

## Write firmware
__For the soldered kit, the default keymap firmware is already written.__

The firmware uses QMK. Please clone the following repository.
__For the pre-soldered kit, this step is not necessary since the default keymap has firmware has already been written.__

[qmk_firmware](https://github.com/qmk/qmk_firmware)
There are two ways to write firmware If you do not need to customize the firmware other than rewriting the keymap, the method using QMK Toolbox is easy and recommended.

After cloning, move to the directory of the local repository and execute the following command.
### Writing firmware using the QMK Toolbox

~~~
$ make miniaxe:default:dfu
~~~
1. Download and install the latest version of [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases).
For Windows version, download either qmk_toolsbox.exe (application only) or qmk_toolbox_install.exe (installer included).
For Mac, download either QMK.Toolbox.app.zip (application only) or QMK.Toolbox.pkg (installer included).

After building, the program will enter a standby state. When that happens, please connect the keyboard. If the keyboard is already connected, writing will begin.
It is not necessary to press the reset switch to write the firmware for the first time.
Repeat for the other side of the keyboard.
1. Download the MiniAxe firmware from the following link
[miniaxe_via.hex](https://github.com/kagizaraya/miniaxe_build_guide/releases/download/remap/miniaxe_via.hex)

1. Start QMK Toolbox and drag & drop the firmware to "Local file" or click "Open" to specify the firmware file. Click "Open" to specify the firmware file.
![qmk_toolbox_open.png](images/qmk_toolbox_open.png)

1. Connect the USB cable to the MiniAxe, press the reset switch to enter bootloader mode, and the QMK Toolbox will display the following.
```
Atmel DFU device connected (libusb0): Atmel Corp. ATmega32U4 (03EB:2FF4:0000)
```

1. Click the "Flash" button in the QMK Toolbox to start writing.
```
Attempting to flash, please don't remove device
> dfu-programmer.exe atmega32u4 erase --force
> Erasing flash... Success
> Checking memory from 0x0 to 0x6FFF... Empty.
> dfu-programmer.exe atmega32u4 flash --force "C:\Temp\miniaxe_via.hex"
> 0% 100% Programming 0x4D00 bytes...
> [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
> 0% 100% Reading 0x7000 bytes...
> [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>] Success
> Validating... Success
> 0x4D00 bytes written into 0x7000 bytes memory (68.75%).
> dfu-programmer.exe atmega32u4 reset
```

1. When the write completes, you will see the following:
```
Flash complete
Atmel DFU device disconnected (libusb0): Atmel Corp.
```

1. Connect the USB cable to the other MiniAxe and write the firmware in the same way.

### Build QMK Firmware and write firmware

1. Clone the QMK repository.

[qmk_firmware](https://github.com/qmk/qmk_firmware)

If you want to use firmware for Remap, clone the following repository.
[Kagizaraya's qmk_firmware](https://github.com/kagizaraya/qmk_remap)

1. After cloning, go to the directory of the local repository and execute the following command, then connect a keyboard as it will be waiting for the firmware to be written. If the keyboard is already connected, the writing will start directly.

~~~
$ make miniaxe:default:dfu
~~~

To build firmware for Remap, execute the following command.

~~~
$ make miniaxe:via:dfu
~~~

If you are writing firmware for the first time, you do not need to press the reset switch.

Please refer to [this document](https://docs.qmk.fm/#/ja/newbs_getting_started) to build the environment to build the firmware.

## Rewrite keymap with Remap

If you are using firmware that supports Remap, you can rewrite the keymap using [Remap](https://remap-keys.app/).

Please refer to the following article for a very clear explanation of how to use Remap.

[Let's rewrite keymap using Remap (Beginner's Edition)](https://salicylic-acid3.hatenablog.com/entry/remap-manual)

Please refer to [this document](https://docs.qmk.fm/#/getting_started_build_tools) for building the environment for building firmware.

## Completed!
Congratulations!
Expand Down
Binary file added images/qmk_toolbox_open.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6295d42

Please sign in to comment.