diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_github_download.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_github_download.png new file mode 100644 index 00000000..e5b7fb75 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_github_download.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_install.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_install.png new file mode 100644 index 00000000..4d8a7ace Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_install.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_lib_include.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_lib_include.png new file mode 100644 index 00000000..2ea2cced Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_lib_include.png differ diff --git a/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_sketch_open.png b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_sketch_open.png new file mode 100644 index 00000000..0ca725d5 Binary files /dev/null and b/docs/assets/img/getting_started_pics/m5bala/bala_quick_start_sketch_open.png differ diff --git a/docs/ja/quick_start/bala/bala_quick_start.md b/docs/ja/quick_start/bala/bala_quick_start.md index 1c560c7b..1612d5ba 100644 --- a/docs/ja/quick_start/bala/bala_quick_start.md +++ b/docs/ja/quick_start/bala/bala_quick_start.md @@ -113,30 +113,24 @@ while True: 7. M5Stackがパソコンに接続されていることを確認してから、`ツール -> シリアルポート`から適切なシリアルポートを選択します。 8. 同様にボードも`M5Stack-Core-ESP32`または`M5Stack-Fire`を選択します。 -9. [M5Bala](https://github.com/m5stack/M5Bala.git)のソースをダウンロードします。Gitが使えない方は、[こちら](https://git-scm.com/download/win)からインストールしてください。 +9. [こちら](https://github.com/m5stack/M5Bala/archive/master.zip)からソースコードをダウンロードします。以下のGitコマンドでもソースコードを取得可能です。 ```shell git clone --recursive https://github.com/m5stack/M5Bala.git ``` -10. Arduino IDE上で新規ファイルを作成し、`M5Bala/src/Default_firmware.ino`の中身をコピーして貼り付けます。 +10. Arduino IDE上で、`スケッチ`->`ライブラリをインクルード`->`ZIP形式のライブラリをインストール...`と選択し、先ほどダウンロードしたZipファイルを選択します。
- + +
+
+
-11. `Default_firmware.ino`の89行目の`M5.setPowerBoostKeepOn(false);`をコメントアウトします。 +11. `ファイル`->`スケッチ例`->`M5Bala`->`Default_firmware`と選択します。
- +
-12. 新規タブを作成し、同様に`M5Bala/src/M5Bala.cpp`の中身をコピーして貼り付けます。 -
- -
-
- -
- -13. 新規タブを作成し、同様に`M5Bala/src/M5Bala.h`の中身をコピーして貼り付けます。 -14. 最後に書込みを実行します。 +12. 開いたファイルのコンパイル・書込みを実行します。
diff --git a/docs/ja/related_documents/how_to_burn_firmware.md b/docs/ja/related_documents/how_to_burn_firmware.md index 0dac999b..e0a22ce6 100644 --- a/docs/ja/related_documents/how_to_burn_firmware.md +++ b/docs/ja/related_documents/how_to_burn_firmware.md @@ -1,68 +1,9 @@ # ファームウェアの更新方法 - +**[Windows](#Windows)**      **[MacOS](#MacOS)**      **[Linux](#Linux)** **このページではM5Stackのファームウェアの更新方法を説明します。** -## MacOS - -ターミナルを開き、以下のコマンドをコピペして実行していきます。 - -1. 初めに**pip**をインストールします。（２回目以降はこの作業は不要です） - -```shell -sudo easy_install pip -``` - -2. 次に**esptool**をインストールします。（２回目以降はこの作業は不要です） - -```shell -pip install esptool -``` - -3. 次にファームウェアをダウンロードし、解凍します。 - - - UiFlow以外 -```shell -mkdir m5burner && \ -cd m5burner && \ -curl -O http://res.m5stack.com/M5Burner/M5Burner.zip && \ -unzip M5Burner.zip -``` - - - UiFlowのみ -```shell -mkdir m5burner && \ -cd m5burner && \ -curl -O http://flow.m5stack.com/download/M5Burner-flow-only.zip && \ -unzip M5Burner-flow-only.zip -``` - -1. 解凍が終わったら、リストを表示します。 - -```shell -ls firmwares/ -``` - -
- firmware_list -
- -5. そして書き込みたいファームウェアを選び、ディレクトリを移動します。 - -```shell - cd path/to/firmware/version/ - ls -``` - -6. flash.sh という名前のファイルがあるところまで移動したら、M5Stackとパソコンの接続を確認し、以下のコマンドを入力します。 - -```shell - sh flash.sh -``` - -7. 書き込みが完了したら、M5Stackのリセットボタンを押して、ファームウェアの更新の完了です。 - ## Windows ### 1. M5Burnerツールのダウンロード @@ -123,4 +64,89 @@ M5Stackの公式サイトへアクセスし、**M5Burner**をダウンロード ?> **Tip** もしM5Burner `Burn`ビジー状態になる場合は、少し時間をおいてください。 ファームウェアの書き込みが終了すると正常に戻ります。 -?> **Tip** もし途中で書き込みが中断された場合、書き込みをやり直してください。(`M5Burner has been closed suddenly...` などと表示された場合) \ No newline at end of file +?> **Tip** もし途中で書き込みが中断された場合、書き込みをやり直してください。(`M5Burner has been closed suddenly...` などと表示された場合) + +## MacOS + +ターミナルを開き、以下のコマンドをコピペして実行していきます。 + +1. 初めに**pip**をインストールします。（２回目以降はこの作業は不要です） + +```shell +sudo easy_install pip +``` + +2. 次に**esptool**をインストールします。（２回目以降はこの作業は不要です） + +```shell +pip install esptool +``` + +3. 次にファームウェアをダウンロードし、解凍します。 + + - UiFlow以外 +```shell +mkdir m5burner && \ +cd m5burner && \ +curl -O http://res.m5stack.com/M5Burner/M5Burner.zip && \ +unzip M5Burner.zip +``` + + - UiFlowのみ +```shell +mkdir m5burner && \ +cd m5burner && \ +curl -O http://flow.m5stack.com/download/M5Burner-flow-only.zip && \ +unzip M5Burner-flow-only.zip +``` + +1. 解凍が終わったら、リストを表示します。 + +```shell +ls firmwares/ +``` + +
+ firmware_list +
+ +5. そして書き込みたいファームウェアを選び、ディレクトリを移動します。 + +```shell + cd path/to/firmware/version/ + ls +``` + +6. flash.sh という名前のファイルがあるところまで移動したら、M5Stackとパソコンの接続を確認し、以下のコマンドを入力します。 + +```shell + sh flash.sh +``` + +7. 書き込みが完了したら、M5Stackのリセットボタンを押して、ファームウェアの更新の完了です。 + +## Linux + +### 1. esptoolのインストール + +ターミナルを開き、 `sudo pip install esptool`と入力するとesptoolがインストールされます。 + + + +### 2. 最新のM5Burnerをダウンロード + +[UIFlow](http://www.m5stack.com)へアクセスし、MacOS版のM5Burnerをダウンロードし、解凍します。 + + + +### 3. 書き込み + +`M5Burner_MacOS/M5Burner_MacOS.app/Contents/Resources/firmware/M5Flow/` ディレクトリを任意の場所にコピーします。 + +もし v1.1.1 のファームウェアを書き込みたい場合は、`cd ~/path/to/M5Flow/v1.1.1-en`へ移動します。 + + + +そして、M5Coreをパソコンに接続した状態で`sudo ./flash.sh`を実行します。 + + \ No newline at end of file