初心者向けM5Stackの始め方(M5Burner/LovyanLauncher編)

 らびやん氏(@lovyan03)がオープンソースで公開しているLovyan Launcherなのですが、非常に便利で、スケッチをコンパイルしなくても、M5Stack用のバイナリファイルを用意すれば起動できることが可能になります。したがって、コンパイルって何?という方でもM5Stackが使えるようになりました。また、開発時にも非常に便利な機能が満載なので使ってない方は是非一度使ってみてください。

 この記事では、M5Burnerのインストール手順とLovyanLauncherの簡単な使い方を紹介します。

 もくじ(Index)

この記事を書いたときに使用しているバージョン

  • M5Stack LovyanLauncher v0.1.8

用意するもの

ハードウェア

①PC

 Windows、MacかLinuxのUSB-Aポートが付いたPCが必要です。

★2019/7/29現在配布されているM5BunnerはWindows版のみなので、MacOS及びLinuxの方はArduinoIDEでLovyanLauncherのスケッチをコンパイルして書き込む作業が必要です。
★2019/8/8にM5Stack公式のM5Burnerに再度登録されました!

②M5Stack

 M5Stackと付属しているUSBケーブルを用意してください。

③microSDHCカード(16GB以下)

 M5Stack SD-Updaterで起動できるバイナリを収納するmicroSDHCカードを用意します。16GB以下のmicroSDHCカードに対応しているようです。私はSandisk Ultra 16GBを使いました。

 microSDカードはFAT32でフォーマットしておきます。

※2019/3/19追記
 説明書に従って16GB以下としていますが、32GB以下というという情報があります。確認できたら修正します

※2019/4/2追記
 32GBだと不安定な場合があるようなので16GB以下を推奨します。

ソフトウェア

 以下のものを用意します。

①CP210X DriverとM5Burner

  https://m5stack.com/pages/download から、M5BurnerとCP2102X Driverをダウンロードします。

②M5Burner【旧バージョン】(現在は不要)

★2019/8/8にM5Stack公式のM5Burnerに対応したのでこちらは不要になりましたが、念のため古いバージョンの記述も残しておきます。

M5Burner.zipを下記のリンクからダウンロードします。

https://github.com/lovyan03/M5Stack_LovyanLauncher/releases

★M5Burner.zipをダウンロードします。ダウンロード時にChromeだと「破棄」ボタンが出るかもしれませんが、「^」を押して継続をクリックするとダウンロードできます。

③SD-Apps-Folder.zip

 必須ではないのですが、アプリの動作を確認するために使用します。 チェスやミニオセロなどアプリが沢山入っています。

https://github.com/tobozo/M5Stack-SD-Updater/releasesからSD-Apps-Folder.zipをダウンロードします。こちらもバージョンは日々変わっていくので新しいものでいいでしょう。

インストール手順

 準備ができたら、以下の順番で作業していきます。Windows環境で操作を説明していきます。

microSDカードの準備

 まずはアプリを使うために母艦PC上でmicroSDカードの準備を行います。

①microSDカードをフォーマット

 FAT32でフォーマットしましょう。

②SD-Apps-Folder.zipを解凍し、SDカードへコピーする。

 フォルダーも全部コピーします。

デバイスドライバ(CP210X Driver)のインストール

 まず、デバイスドライバをインストールし、M5StackをPCに接続します。

①ダウンロードしたファイルを解凍

 「CP210x_VCP_Windows.zip」というファイルを解凍します。

②インストーラーの実行

 解凍後自分のOSにあったx64(64bit)かx86(32bit)のものを実行してインストールします。実行は画面の指示に従ってください。

  • 64bitOSの場合:CP210xVCPInstaller_x64_v6.7.0.0.exe
  • 32bitOSの場合:CP210xVCPInstaller_x86_v6.7.0.0.exe

 ※途中で「このデバイスソフトウェアをインストールしますか?」というWindowsセキュリティのダイアログが出たら「インストール」を押してください。

③M5StackをPCに接続する。

 M5StackをPCに接続します。
「スタートボタン」の上で右クリック→「デバイスマネージャー」を開いて、ポート名を確認します。下記の画像だと、COM6というのがポート名になるので覚えておきます。

M5 Burnerで書き込みを行う。【新バージョン】

 2019/8/8にM5Stack公式のM5Burnerに再びLovyanLauncherが登録されましたので新バージョンで書き込む手順はこちらを見てください。

①M5Burner.zipを解凍し、M5Burner.exeを起動する。

 ダウンロードしたM5Burner.zipを解凍し、解凍後のフォルダにあるM5Burner.exeを実行します。

②ファームウェアをダウンロードする。

 左のリストにある「LovyanLauncher-vX.X.X」(X.X.Xはバージョン番号)にカーソルを合わせて、「↓」を押します。

③パラメータを選択

 左側のリストの「LovyanLauncher-vX.X.X」が白くなったらダウンロード完了ですのでクリックして選択します。

 右側のパラメータを設定します。

  • COM:デバイスマネージャで確認したCOM?を選択
  • Baud:921600
  • Series:Flashメモリが4MBか16MBで違います。後述します。
Seriesの選択方法

 M5StackのCoreはモデルによって搭載しているFlashメモリの大きさが異なります。

①4MBモデル M5Stack Basic 及び Gray、Facesの旧モデル(2019/2以前の出荷分)

通常は「Stack-4MB」を選択します。
「Stack-4MB_minSPIFFS」というのは大きめのバイナリファイルを使いたい場合に選択します。(分からない場合はまずStack-4MBでいいでしょう。)

②16MBモデル M5Stack Gray、Facesの新モデル、Fire、Goなど

 Flashメモリは16MBなので「Stack-16MB」を選択します。

④書き込みを行う。

 「Burn」をクリックし書き込みを行います。

⑤リセットボタンを押す。

 リセットボタンを押すと、下記の動画のように表示されApp0領域からApp1とmicroSDカードへのコピー処理が実行されます。
 コピーが完了するとLovyanLauncherのメニューが表示されます。

⑥確認

 LovyanLauncherが正しく書き込まれていればM5Stackに下記の画面が表示されます。

M5 Burnerで書き込みを行う。【旧バージョン】

 GitHubからダウンロードした古いバージョンのM5Burnerを起動して、M5StackにLovyanLauncherを書き込む手順です。

①M5Burner.zipを解凍し、M5Burner.exeを起動する。

 ダウンロードしたM5Burner.zipを解凍し、解凍後のフォルダにあるM5Burner.exeを実行します。

②パラメータを設定する。

 下記のように設定します。FirmwareはM5StackCore(Gray,Basic)とM5StackFire版の二種類あるので気を付けましょう。

  • COM:デバイスマネージャで確認したCOM?を選択
  • Baud:921600
  • Firmware:Flashメモリが4MBか16MBで違います。後述します。

★v0.1.Xというのはバージョンです。

Firmwareの選択方法

 M5StackのCoreはモデルによって搭載しているFlashメモリの大きさが異なります。

①4MBモデル M5Stack Basic 及び Grayの旧モデル(2019/2以前の出荷分)

通常は「LovyanLauncher-v0.1.X for 4MB(default)」を選択します。
「LovyanLauncher-v0.1.X(min_spiffs)」というのは大きめのバイナリファイルを使いたい場合に選択します。(分からない場合はまずdefaultでいいでしょう。)

②16MBモデル M5Stack Grayの新モデル、Fire、Faces、Goなど

 Flashメモリは16MBなので「LovyanLauncher-v0.1.X for 16MB(default)」を選択します。

③microSDカードをセットする。

  M5Burnerで書き込み後、microSDカードへ書き込む処理が実行されるので必ず書き込む前にmicroSDカードをセットしてください。

③書き込みを行う。

 ファームウェアの選択をした後に、「Burn」というボタンをクリックして、書き込みを行います。

下の黒いウィンドウに書き込みのログが表示されます。

 Leaving…
 Hard resetting via RTS pin…

というメッセージが出たら、書き込み完了です。

④動作確認

 LovyanLauncherが正しく書き込まれていればM5Stackに下記の画面が表示されます。

Lovyan Launcherの基本操作

 M5Stackの3つのボタンは下記のような機能が割り当てられます。

  • ボタンA: 「戻る」「メニューを閉じる」 長押しで「前へ」
  • ボタンB: 「選択」「OK」「メニューの展開」
  • ボタンC: 「次へ」

言葉だとわかりづらいので実際に操作して慣れましょう。

アプリを起動してみる。

 次は実際にアプリを起動してみましょう。

①microSDカードをセットする。

 M5StackにmicroSDカードをセットします。

②SD Updaterを起動

 メニューからボタンCを押してSD Updaterを選択し、ボタンB(OK)を押します。

 するとmicroSDカードのルートにある*.binファイルが読み込まれ一覧で表示されます。

③アプリを起動

 試しにArduinomegachessをボタンB(OK)を押して起動してみましょう。

「LOADING」→「タイトル」→「ゲーム画面」の順に表示されればOKです。

④メニューに戻る。

 Lovyan Launcherに戻る場合は、ボタンAを押しながら「RESET/POWER」ボタンを押すとLovyan Launcherに戻ることができます。

 コツは再起動後の画面が出るまでボタンAは離さないことです。

詳しい使い方

 長くなるので別記事にしました。使い方は下記を参照してください。

M5Stack LovyanLauncherの使い方

LovyanLauncher対応アプリの作り方

 自作のアプリをLovyanLauncherで呼び出せるSD-Updater対応を行うと、開発途中でもLovyanLauncherに戻ることが可能になり便利です。
 また、バイナリを配布するとコンパイル作業なしで使うこともできるためGitHubに公開して色々な人に利用してもらいたい場合も便利です。SD-Updater対応は簡単なので是非対応してみてください。

 対応方法は下記の記事を参照してください。

M5Stack LovyanLauncher対応アプリの作り方

トラブルシューティング

 トラブルシューティングの最新情報はM5Stackの困ったときの対処や注意することで紹介していますので解決しない場合こちらも見てください。

スケッチが書き込めない

 ネットで見かけた情報ですが、スケッチが書き込めない場合は下記の順番で試してみてください。

①ドライバのバージョンを変える。

 ドライバのバージョンを変えると上手くいくケースがあります。まずは新しいバージョンを入れてみて、それでもだめだったら、ドライバを削除してからM5Stack公式の古いバージョンへ戻してみましょう。

●最新ドライバ(バージョン10.1.7)

 CP210x USB – UART ブリッジ VCP ドライバ

●古いドライバ(バージョン6.7)

 M5Stack公式

②USBポートを変えてみる。

 PCへ接続するポートによって挙動が変わるようです。USBポートを変えてみたり、HUBを経由するなど接続するUSBポートを変えてみましょう。

 USB3.0ポートで書き込めなかったがUSB2.0ポートに変えたところ書き込めたという事例もあります。

③コンデンサを付ける。

 RST-GND間に2.2μF以上のコンデンサを付けてみましょう。(電解コンデンサの場合は極性に注意です。)

おわりに

 これで、M5BurnerによるLovyan Launcherの設定は完了です。配布されているコンパイルされた*.binファイルをmicroSDカードにコピーすれば、SD Updaterのメニューに表示されるので、自分で好きなアプリを利用しましょう。

 自分で作成したスケッチも少し変更しArduinoIDEで「コンパイルしたバイナリを出力」でbin形式のファイルを作成し、microSDカードのルートに置くとLovyan Launcherから呼び出せるようになります。詳しくは下記の記事で解説しています。

M5Stack LovyanLauncher対応アプリの作り方

 これで以前よりも簡単にM5Stackを始められるようになりました。難しくて諦めた方もどんどん使ってみましょう。

コメントを残す

メールアドレスが公開されることはありません。