Zenn
👾

M5Burner v2の使いかた

2022/06/18に公開
M5Stack
uiflow
M5Burner
tech

M5Burner画面

1. 概要

M5Burner は M5Stack 製品にファームウェアを書き込むためのツールです。2022 年 6 月 25 日現在の最新版は 2.5.1 です。

私は M5Burner を Windows 11 環境で使用しています。

2. 対応機種

M5Burner で対応している機種は以下のとおりです。

3. 事前準備

M5Stack BASIC/M5GO/Fire v2.6 や M5Stack Touch/M5Stamp PICO （シリアル変換 IC に CH9102F を使っている機種）を使う場合は，M5Stack のダウンロードページから使用する OS 用の CH9102F ドライバ（CH9102_VCP_SER_Windows.exe，CH9102_VCP_SER_MacOS v1.7.zip）をインストールしてください。

M5Stack BASIC/GRAY/M5GO/FIRE を使う場合は，M5Stack のダウンロードページから使用する OS 用の CP201X ドライバ（CP201x_VCP_Windows.zip，CP201x_VCP_MacOS.zip，CP201x_VCP_Linux.zip）をインストールしてください。

M5Stack Core2 を使う場合は，機体によって搭載されているチップが CP201X の場合と CH9102F の場合があります。両方のドライバをインストールしておくと良いそうです（M5Stack Core2 ESP32 IoT Development Kitの「USB Driver」より）。

CH9102F か CP201X かどちらのドライバを入れたら良いかわからないときは，両方インストールしても問題ありません。

M5StickC/M5StickC Plus や ATOM Matrix/Lite/Echo の場合は USB ドライバをインストールする必要はありません。

M5StickV/UnitV の場合，もしくは M5StickC や ATOM Matrix/Lite/Echo でうまく動かない場合は，使用する OS 用のFTDI ドライバをインストールすると動くようになります（環境によってはドライバを 2 回インストールしないと有効にならない場合があります）。

4. 入手方法

2022 年 6 月 18 日現在，M5Stack のページからダウンロードできなくなっているので，以下から直接ダウンロードしてください。ダウンロードされるバージョンは v2.5.0 です。

5. インストール

5.1 Windows 版

ダウンロードしたM5Burner.zipを展開し，適当なフォルダ（C:\ProgramData\M5Burnerなど）に移動します。

6. M5Burner の起動

6.1 Windows 版

インストールしたフォルダ（C:\ProgramData\M5Burner）にあるM5Burner.exeをダブリクリックして実行します。

7. M5Burner の更新

M5Burner更新通知

M5Burner を起動したときに，右上の設定アイコン（歯車のアイコン）に赤いマークが付いていることがあります。これは M5Burner の新しいバージョンが公開されていることを表します。

M5Burner設定メニュー

歯車アイコンを押すと，左側に設定（Preference）メニューが現れます。バージョン（Version）を見ると，現在（Current）インストールされているバージョンが 2.2.9 で，最新（Latest）が 2.3.0 であることがわかります。すぐ横にある「Update」を押すと，最新版に更新することができます。

M5Burner更新確認

「Yes」ボタンを押すと更新が始まります。

M5Burner更新中

100%になるのを待ちます。

M5Burner更新完了

アップデートが完了すると更新を有効にするために再起動するか聞かれます。「Yes」ボタンを押すと，M5Burner が終了し，新しいバージョンの M5Burner が起動します。

8. ファームウェアの書き込み

ここでは，M5Stack BASIC にUiFlowのファームウェアを書き込む方法を説明します。

8.1 機種の選択

M5Burner製品メニュー

画面左側に M5Stack 製品の機種を選ぶメニューがあります。ここでは BASIC が含まれる「CORE」をクリックします。CORE に対応するファームウェアの一覧が表示されるので，UiFlow の BASIC 用ファームウェアである一番左の「UIFLOW（CORE）」に注目します。

8.2 ファームウェアのダウンロード

UiFlowファームウェアメニュー

右にあるプルダウンメニューで書き込むファームウェアのバージョンを指定できます。ここでは v1.9.8-en を選び，「Download」ボタンを押すとダウンロードが始まります。

緑で「official」と書かれているのは，M5Stack 社が提供しているものを表します。official がついていないものは一般ユーザが提供しているものです。左下の作者（Author）に作者名が表示されています（official の場合は M5Stack）。

右下の雲のマークと「42.1k」と書かれているのは，ダウンロードされた回数を表します。この場合は約 42,100 回（k は 1,000 を表すキロから来ている。42.1 \times 1,000 = 42,100）ダウンロードされていることを示しています。

UiFlowファームウェアダウンロード完了

ダウンロードが完了すると，「Remove」（ダウンロードしたファームウェアの削除），「Burn」（ダウンロードしたファームウェアを焼く＝書き込む）ボタンが表示されます。

ダウンロードしたファームウェアによっては他のボタンが追加されることもあります。UiFlow のファームウェアの場合は「Configuration」（設定）ボタンも追加されます。

8.3 シリアルポートの設定

UiFlowシリアル設定

M5Stack BASIC が接続されている COM ポート番号（Windows の場合）と転送速度（baudrate：ボーレート）を設定します。転送速度は 1500000（1.5Mbps，bps はビット毎秒（bit per second））で問題ありませんが，書き込みに失敗する場合は速度を落とします。

8.4 ファームウェアの書き込み

UiFlowファームウェア書き込み

「Burn」（書き込む）ボタンを押すと，WiFi の設定を聞かれます。

UiFlowファームウェアWiFi設定

接続する SSID とパスワードを入力して「Start」（開始）ボタンを押します。

UiFlowファームウェア書き込み開始

書き込んでいる様子が表示されます。

UiFlowファームウェア書き込み完了

Burn Successfullyと表示されていたら書き込みが成功しています。右下の「Close」（閉じる）ボタンを押してください。

書き込みが失敗する場合は，転送速度を落として再度書き込んでみてください。それでも失敗する場合は，ファームウェアを一度消去してから書き込むとうまくいくことがあります。「9. M5Stack に書き込まれたファームウェアの消去」を参照してください。

8.5 設定の書き込み

書き込むファームウェアによっては，「Configuration」（設定）ボタンという設定を書き込むためのボタンがあります。例えば，UiFlow 用のファームウェアには，起動モードやブートメニューを表示するかなどの設定を書き込むために「Configuration」（設定）ボタンがあります。ここでは UiFlow の「Configuration」（設定）について説明します。

UiFlowファームウェア設定ボタン

まず「Configuration」（設定）ボタンを押します。このとき，指定した実機が接続されている必要があります。

UiFlowファームウェア設定画面

項目は以下のとおりです。

  • ApiKey

    M5Stack 実機と UiFlow を接続するために使う識別子

  • Start Mode

    起動時のモード。以下から選択します。

    • Internet Mode

      ブラウザから UiFlow（https://flow.m5stack.com）を使うときのモード

    • USB Mode

      UiFlow Desktop（既に更新停止）で使うモード

    • App Mode

      実機にダウンロードしたプログラムを実行するモード。ダウンロードしていない場合は MicroPython の REPL（Read Evaluate Print Loop の略で，対話的にプログラムを実行できるモードのこと） プロンプトが表示されます。

  • Server

    UiFlow のサーバを選択

    • flow.m5stack.com

      中国本土以外から接続する場合。日本からの場合もこちらを選択する。

    • sg.flow.m5stack.com

      中国本土から接続する場合

  • Wifi

    接続する WiFi の SSID とパスワードを設定

  • COM.X

    COM シリーズのベースモジュール（COM.LTEなど）を使ってネットワーク接続をするかどうか。WiFi 接続する場合はFalseで良い。

  • APN

    上の COM.X をTrueにした場合に APN（Access Point Name の略で接続先のこと）を指定する

設定を変更して「Save」（保存）ボタンを押します。

UiFlow設定書き込み完了

「Success」（成功）と表示されれば設定がうまく書き込めています。「OK」ボタンを押して設定の書き込みを終了します。

9. M5Stack に書き込まれたファームウェアの消去

M5Stack の電源を入れても反応がなかったり，ファームウェアを書き込もうとしてもエラーになる場合は，一度 M5Stack 製品に書かれているファームウェアを消去して，再度書き込むとうまくいくことがあります。

ファームウェアの消去

ファームウェアを消去するには，右上にある「Erase」（消去）ボタンを押すと，指定した COM ポート番号（Windows の場合）に接続された M5Stack 製品のファームウェアを消去します。

ファームウェアの消去完了

Erase Successfullyと表示されていたら消去が成功しています。右下の「Close」（閉じる）ボタンを押してください。

10. シリアルモニタの起動

シリアルモニタの起動

右上の「COM Monitor」ボタンを押すと，指定した COM ポート番号（Windows の場合）に接続された M5Stack 製品のシリアル出力を見ることができます。

シリアルモニタの出力

下のボックスに文字を入力して「Send」（送信）ボタンを押すことで，シリアルに書き込むことができます。

終了するときは右下の「Close」（閉じる）ボタンを押します。

Discussion