2023年9月12日火曜日

DIYレトロゲーム機「Nibble」の開発環境構築 その2


「Nibble-Launcher」のビルド

クラウドファンディングサイト「Makuake」でオーダーした、DIYレトロゲーム機「Nibble(ニブル)」。

Nibble


執筆時点では、まだコチラで購入できますよ~。

これを使って色々なゲームをプログラミングしたいのだけれど、プログラムを書き込んだ後に元に戻せなかったらどうしよう!?

…というわけで、工場出荷時の状態に戻す方法を探っています。

工場出荷状態で書き込まれているプログラムは、この「Nibble」の開発メーカーであるCircuitMess社のGitHubから入手できるようです。

どうやら、そのプログラムは「Nibble-Launcher」というもののようです。

つまり、コイツをダウンロード、ビルドして「Nibble」に転送すれば工場出荷時の状態に戻せるのでは?

早速やってみましょう!

CircuitMess社のGitHubのURLは以下の通り。


https://github.com/CircuitMess


このページから、その「Nibble-Launcher」を探していきましょう。

ページを下の方に移動してもらって…。

GitHub - 1


以下のように「View all repositories」の部分をクリックして、全てのリポジトリを展開しましょう。

GitHub - 2


「Nibble-Launcher」どこかなぁ~?

GitHub - 3


あった!

これだね!!

GitHub - 4


さて、この「Nibble-Launcher」は、そのルートディレクトリに「.ino」という拡張子のファイルがあることから、開発環境は「Arduino IDE」を使う必要があるみたいです。

まずは「Nibble-Launcher」をどこにダウンロードしましょうか?

ここでは、前回の作業で「Arduino IDE」のインストール時に自動的に作成された以下のディレクトリ以下にダウンロードすることにしましょう。


C:\Users\<ユーザー名>\Documents\Arduino


「Nibble-Launcher」のダウンロードは、GitHubのサイトからZIPファイルをダウンロードをして、それを展開して上記のディレクトリにコピーしても良いのですが、ここではナウい方法として「git clone」コマンドを使いましょう。

その場合は「Cygwin」を使うと良いでしょう。

「Cygwin」のインストール方法は、こちらのページを参考にしてください。

「Cygwin」のインストールが終了しターミナルを開いたら、以下のコマンドで上記のディレクトリまで移動します。


$ cd /cygdrive/c/Users/<ユーザー名>/Documents/Arduino

Cygwinターミナル - 1


そうしたら、ここのディレクトリに以下のコマンドで「Nibble-Launcher」をダウンロードしましょう。


$ git clone https://github.com/CircuitMess/Nibble-Launcher.git

Cygwinターミナル - 2


「Arduino IDE」のインストール時に自動的に作成されたディレクトリを確認してください。

以下のように「Nibble-Launcher」というディレクトリが作成されていますか?

「Arduino IDE」のインストール時に自動的に作成されたディレクトリ


では「Arduino IDE」を起動させましょう。

画面左上の「File」メニューから「Open...」の項目をクリックします。

Arduino IDE - 1


「開く」ダイアログが表示されますので、ダウンロードした「Nibble-Launcher」直下にある「Nibble-Launcher.ino」というファイルを選択し、「開く」ボタンをクリックです。

「開く」ダイアログ


新たに「Nibble-Launcher」用の画面が開きましたね。

元の画面はもう閉じちゃって構いません。

試しにこの状態でビルドしてみましょう。

「Arduino IDE」の画面左上の「V」マークをクリック!

Arduino IDE - 2


ビルド通るかなぁ~?

う~ん、エラーが出てしまいました。

エラーメッセージを見てみると、ターゲットのボードが有効ではない…とかなんとか。

あーそうか!

この「Nibble-Launcher」のプロジェクトを開いてから、ターゲットの設定をしてないや!

Arduino IDE - 3


というわけで、ターゲットの設定をします、

「Arduino IDE」画面上部の「Tools」メニューから「Board」→「CircuitMess ESP6266 Boards」→「Nibble」と各項目を順にクリックしていきます。

Arduino IDE - 4


これで再度ビルド!

しかし、またダメ~!!

Arduino IDE - 5


うーむ、どうやらビルドに必要なソースコードが足りないみたいですね。

その場所というのが以下のディレクトリです。


C:\Users\<ユーザー名>\Documents\Arduino\Nibble-Launcher\src\Games

ソースコードを追加しないといけないディレクトリ


この中のディレクトリは「Nibble」の工場出荷時にインストールされている各ゲームの名前です。

まあ「Invaderz」というゲームは記憶にありませんが…。

そして、各ディレクトの中は案の定、空っぽです!

ということは、各ゲームのソースコードは「Nibble-Launcher」とは分離されていて、各々のソースコードをGitHubからダウンロードしないといけないのでしょうね。


さて、長くなっちゃうので一旦ここで区切りましょう。

次回は、各ゲームのソースコードをダウンロードしてビルドを通し「Nibble」へ転送して動作確認を行っていきます。

この一連の作業をもって、開発環境を学んでいきましょう。


<続く>

2023年9月1日金曜日

TOPPERS/ASP - PIC32MX版 その6

前回からの続きです。

このテーマを最初からご覧になる場合はこちらからどうぞ。


雛形プロジェクトの作成

まずは「MPLAB X IDE」を起動して下さい。

前回から続いて作業している場合は、すでに起動していますかね。

画面上部の「File」、「New Project...」メニューを順にクリックしていきます。

「MPLAB X IDE」 - 1


以下のような「New Project」ダイアログが表示されます。

ここから「Categories」リストから「Microchip Embedded」を、「Projects」のリストから「32-bit MPLAB Harmony Project」をそれぞれ選択して、ダイアログ下方の「Next >」ボタンをクリックしてください。

「New Project 」ダイアログ - 1


すると、以下のような表示に切り替わります。

ここでは「Harmony Path:」のテキストボックスの右側のディレクトリボタンをクリックしましょう。

「New Project 」ダイアログ - 2


ディレクトリの選択ダイアログが表示されたはずです。

ここでは、先程インストールした「MPLAB Harmony」の場所を選択しましょう。

特に変わった操作をしていなければ、その場所は以下のパスになります。

このパスを指定したあとは「開く」ボタンをクリックです。


C:\microchip\harmony\v2_06

ディレクトリの選択ダイアログ


元の「New Project」ダイアログに戻ります。

ここで思い出してください。

現在は、TOPPERS/ASPのプロジェクトを作成するのではなく、そのために必要な「MPLAB Harmony」のソースコードを出力させるための雛形プロジェクトを作成する作業をしています。

したがって、今回作成するプロジェクト名、すなわち「Project Name:」のテキストボックスには「Hinagata」とでも入力しておきましょう。

「New Project 」ダイアログ - 3


続いて「Target Board」のコンボボックスでは、今回使用する評価ボードの「PIC32MX1/2/5 Starter Kit」を選択します。

「New Project 」ダイアログ - 4


以下のように正しく設定できたら、ダイアログ下方の「Finish」ボタンをクリック!

「New Project 」ダイアログ - 5


なにか「MPLAB X IDE」でワチャワチャ始まりました!

「MPLAB X IDE」 - 2


画面下方の「Output」エリアでは、次々とメッセージが表示されていますね。

「仕事してます」感バリバリ。

「MPLAB X IDE」 - 3


この処理の終盤に、以下のようなダイアログが表示されたら「Save」ボタンをクリックしましょう。

「Save Configuration」ダイアログ - 1


さて、処理が終了すると、メインの画面は以下のような表示になっていると思います。

ここで「Harmony Framework Configurarion」の項目をクリックしてください。

「MPLAB X IDE」 - 4


「Harmony Framework Configurarion」の項目が展開されて、更に色々な項目が出てきましたね。

その中で「Drivers」という項目があるので、これをクリックして展開します。

「MPLAB X IDE」 - 5


TOPPERS/ASPは、外部のハードウェアとしてOSタイマーである「Timer」と、デバッグシリアルに使用する「USART」の2つが必要です。

(正確には、「割り込み」もそうですが、ここでは特に意識する必要はありません。)

では、まずOSタイマーに使用する「Timer」の設定からいきましょう。

展開された「Drivers」という項目の中に「Timer」という項目がありますので、これをクリックして展開します。

「MPLAB X IDE」 - 6


すると、なにやら細々した項目が展開されましたね?

これを以下の通りに設定してください。

間違えると、後々面倒になりますのでここは慎重に!

「Timer」の設定


次にデバッグシリアルに使用する「USART」の設定にいきましょう。

展開された「Drivers」という項目の中に「USART」という項目がありますので、これをクリックして展開します。

「MPLAB X IDE」 - 7


またまた細々した項目が展開されました。

これを以下の通りに設定してください。

こちらも間違えないよう慎重にお願いします!

「USART」の設定


まだまだ、作業は続きます。

次は、PIC32MXマイコンのピンの設定です。

メインの画面のタブを現在の「Options」から「Pin Disgram」に切り替えてください。

「MPLAB X IDE」 - 8


すると以下のようにマイコンの絵が出てきましたね。

この中で74番ピン「RC14」と73番ピン「RC13」に注目してください。

これらのピンは、現在のデフォルト状態では何も機能が割り振られていない(GPIO入力?)ので、これらをUSART、いわゆるシリアル通信のためのRX(受信)とTX(送信)として使えるように設定します。

ピンの設定 - 1


まずは、74番ピン「RC14」をUSARTのRX(受信)に設定します。

ピンの部分をクリックすると、ドロップダウンリストが表示されます。

ここでは、このピンに割り当て可能な機能が列挙されます。

今回はUSARTのRX(受信)、すなわち「U1RX」を選択します。

ピンの設定 - 2


次は、73番ピン「RC13」をUSARTのTX(送信)に設定します。

同じ要領でUSARTのTX(送信)、すなわち「U1TX」を選択します。

ピンの設定 - 3


以下のように、74番ピンに「U1RX」、73番ピンに「U1TX」と、それぞれ表示が変わったでしょうか?

ここはミスるとシリアル通信ができなくなるなど、後々非常に厄介なので必ずご確認を!

ピンの設定 - 4


さて、以上で全ての設定が終了です。

メインの画面の左上のフロッピーディスクのマークをクリックして設定を保存しましょう。

「MPLAB X IDE」 - 9


以下のようなダイアログが表示されたら「Save」ボタンをクリックして、この雛形プロジェクトを保存しましょう。

「Save Configuration」ダイアログ - 2


もしこの先、無事に「TOPPERS/ASP」の起動に成功して、イザ何かを作ろう!となった場合、今回追加した「MPLAB Harmony」ライブラリだけでは絶対に足らなくなることでしょう。

評価ボードにセンサーを繋げて、そのセンサーとSPIで通信するとか、AD変換を使いたいだとか…。

その際には、再び今回の手順で必要になった「MPLAB Harmony」ライブラリを追加して、ソースコードを吐き出させて、更にそれを「TOPPERS/ASP」のソースツリーにコピーしなければなりません。

そういう意味では、この雛形プロジェクト、結構使用頻度が高くなるかもしれませんよ?

大切に取っておきましょう!


ではいよいよ、この雛形プロジェクトからソースコードを吐き出させてみましょう。

先程のフロッピーディスクのマークの右側、「歯車→Code」というアイコンのボタンをクリックします。

「MPLAB X IDE」 - 10


以下のような「Generate Project」ダイアログが表示されるので「Generate」ボタンをクリック!

「Generate Project」ダイアログ - 1


以下のように雛形プロジェクトからソースコードが生成されていきます。

「Generate Project」ダイアログ - 2


ソースコードの生成が終わると「Generate Project」ダイアログは自動的に消えます。

これで雛形プロジェクトから必要なソースコードを抽出できました。

雛形プロジェクトのソースコードは、以下のディレクトリに出力されています。


C:\microchip\harmony\v2_06\apps\Hinagata


どんなものが出力されているのか?

ちょっと見てみるのも良いでしょう。


さて次回は、この雛形プロジェクトから必要なソースコードを「TOPPERS/ASP PIC32MX版」のソースツリーにコピーし、コマンドのラインでOSのビルドを透すところまでやっていきましょう!

ここまで出来てしまえば、面倒くさいのはもう少しで終わりです。

最後までお付き合いいただけると嬉しいです。


<続く>

2023年8月25日金曜日

DIYレトロゲーム機「Nibble」の開発環境構築 その1

「Nibble(ニブル)」の開発環境

クラウドファンディングサイト「Makuake」でオーダーした、DIYレトロゲーム機「Nibble(ニブル)」。

Nibble


以前このブログで、キットの内容組立てて電源を入れるまでを紹介させていただきました。

執筆時点では、まだコチラで購入できますよ~。

最初から入っているゲームは一通り遊んでみたので、次は自分でプログラミングです!

とりあえず、簡単なサンプルプログラムをビルド、転送して、その後、工場出荷状態に戻すまでを確認してみようと思いました。

工場出荷状態に戻せないと、せっかく最初から入っていたゲームが遊べなくなってしまうので、この確認は重要です。

この「Nibble」は、知育玩具という扱いなので、子供向けには「CircuitBlocks」(ブロックを組み合わせるビジュアル言語)という開発環境を使用することが推奨されています。

この「CircuitBlocks」については付属のドキュメント - コーディング最初のステップ - Nibble_JP coding-first steps.pdf - を参照してください。

ここでは、C++での開発環境構築に挑戦します!

その場合の開発環境としては「Arduino IDE」と「VisualStudio Code」の2種類が使えるようです。

両方とも見ていきましょう。


Arduino IDEでの開発

付属のドキュメント - セットアップガイド - Nibble_JP Setup Guide.pdf - の通りに開発環境を構築してみました。

特に問題は無さそうですが、このドキュメント、サンプルのソースコードが文字欠け、文字化けしてますね!

正しくは、以下の通りです(だと思います)。

  1. #include <Nibble.h>
  2. Display* display;
  3. Sprite* sprite;
  4. void setup() {
  5.   // put your setup code here, to run once:
  6.   Nibble.begin();
  7.   display = Nibble.getDisplay();
  8.   sprite = display->getBaseSprite();
  9.   sprite->clear(TFT_BLACK);
  10.   sprite->setTextColor(TFT_WHITE);
  11.   sprite->setTextFont(2);
  12.   sprite->setCursor(0, 0);
  13.   sprite->print("Hello World!");
  14.   display->commit();
  15. }
  16. void loop() {
  17.   // put your main code here, to run repeatedly:
  18.   delay(1000);
  19. }


このスケッチは、そのままビルドが通りました!

こんな感じ。

Arduino IDE - 1


ドキュメントと異なるのは、今回はまだパソコンと「Nibble」を接続して、このスケッチを転送していないことです。

今の段階では工場出荷状態に戻す方法が分からないので、このプログラムを「Nibble」に書き込んでしまったら、元に戻せなくなってしまうからです!

なので今回は、ビルド&転送の「→」ではなく、ビルドの「V」をクリックするだけ!

Arduino IDE - 2


VisualStudio Codeでの開発

付属のドキュメント - プログラミングガイド - Nibble_JP Programming Guide.pdf - の通りに開発環境を構築してみました。


が…。


これが難題!

「VisualStudio Code」と、その拡張「PlatformIO」をインストールするまでは良かったんです。

これらの作業が終わって「VisualStudio Code」を再起動します。

そして、画面左側の「アリの顔面」マークをクリックします。

VisualStudio Code - 1


コイツね。

アリの顔面


次は、切り替わった画面左側の階層構造のリストから「QUICK ACCESS」→「PIO Home」→「Open」をクリックです。

VisualStudio Code - 2


以下のような表示に切り替わりますので「New Project」をクリック。

VisualStudio Code - 3


続けて、ドキュメント通りにプロジェクトを作成していきます。

必要な項目を埋めて「Finish」ボタンをクリック!

VisualStudio Code - 4


途中の以下のような表示も「Yes, I trust the authers」ボタンをクリックします。

VisualStudio Code - 5


さて、ここでドキュメントに不穏な表記が!

「簡単なプログラムの作成」の章です。

それによると…


ここで、必要なライブラリや設定ファイルをGitHubのリポジトリからダウンロードし、プロジェクトディレクトリに配置する必要があります。


…???

なんのこっちゃ!?

じゃあ、その必要なライブラリとか設定ファイルとか、GitHubのリポジトリの場所は?

リンクも何の表記もありません!


なんでソコの説明を端折っちゃうかな~?


まあいいや、と作成されたプロジェクトの「main.cpp」を開いて…

VisualStudio Code - 6


ここに「Arduino IDE」で書いたスケッチと同じソースをコピペしてビルドすれば動くやろ!

ビルドコマンドのボタンは、画面下部にある小さなチェックマークです。

VisualStudio Code - 7


これをクリック!

VisualStudio Code - 8


結果…


エラー発生でビルド通らず!

撃沈!!

VisualStudio Code - 9


…うん。

まあ。

人生そんなもんだよ。


...しかし、諦めずにそれから色々調べました!

その甲斐あって、以下の手順を踏めばビルドが通るようにはなりました。


まず、先程のビルドのエラーメッセージから、何らかのファイルが不足していると推察。

今の時点で、この「Hello World」プロジェクトは以下のディレクトリに生成されているハズです。


C:\Users\<ユーザー名>\Documents\PlatformIO\Projects\Hello World


このディレクトリの中の「lib」というディレクトリにご注目を。

「Hello World」プロジェクトのディレクトリ


この「lib」ディレクトリの中には「README」ファイル以外は何も入っていません。

「lib」ディレクトリ - 1


ここに不足しているファイルを配置すれば良いのでは?

足りないファイル(ていうかライブラリ)は「Arduino IDE」で使っているものを持ってきましょう!

その場所は、普通にインストール作業を進めて頂いた場合は、以下のディレクトリに入っています。


C:\Users\<ユーザー名>\AppData\Local\Arduino15\packages\cm\hardware\esp8266\1.2.1\libraries


…トライ&エラーを繰り返しながら、少なくともこの中にある以下の3つのディレクトリを「Hello World」プロジェクトの「lib」ディレクトリにコピーすればよいことが分かりました。


・TFT_eSPI

・CircuitOS

・Nibble

「lib」ディレクトリ - 2


その後「Hello World」プロジェクトのディレクトリ直下にある「platformio.ini」というファイル…。

VisualStudio Code - 10


これを以下のように編集します。

  1. ; PlatformIO Project Configuration File
  2. ;
  3. ; Build options: build flags, source filter
  4. ; Upload options: custom upload port, speed and extra flags
  5. ; Library options: dependencies, extra library storages
  6. ; Advanced options: extra scripting
  7. ;
  8. ; Please visit documentation for the other options and examples
  9. ; https://docs.platformio.org/page/projectconf.html
  10. [env:esp12e]
  11. platform = espressif8266
  12. board = esp12e
  13. framework = arduino
  14. ; 以下追記!
  15. build_flags =   -Os
  16.                 -g
  17.                 -DCIRCUITOS_LITTLEFS
  18.                 -DCIRCUITOS_TONE
  19.                 -DCIRCUITOS_LOWRAM
  20.                 -DST7735_DRIVER
  21.                 -DTFT_WIDTH=128
  22.                 -DTFT_HEIGHT=128
  23.                 -DST7735_GREENTAB128
  24.                 -DTFT_RGB_ORDER=TFT_BGR
  25.                 -DTFT_MOSI=13
  26.                 -DTFT_SCLK=14
  27.                 -DTFT_MISO=-1
  28.                 -DTFT_CS=-1
  29.                 -DTFT_DC=2
  30.                 -DTFT_RST=-1
  31.                 -DSPI_FREQUENCY=27000000
  32.                 -DLOAD_GFXFF
  33. build_unflags = -Werror=return-type


この状態で、再ビルドです!


うぉし!

ビルドが通りました~!!

VisualStudio Code - 11


この「VisualStudio Code」でビルドして生成された「Hello World」プログラムのバイナリと、冒頭の「Arduino IDE」で生成したスケッチのバイナリは、全く同じではないにしろ、似たようなファイルサイズです。

なので、このまま転送して「Nibble」で動作させれば同様の動きをするものと思われます。

多分「Nibble」の画面に黒をバックに白地で「Hello World!」と表示されるのかな?


さて、思いのほか情報が少なくて「VisualStudio Code」の方は、いきなりドツボにハマってしまいました。

以降は、そのソースコードの入手法も含め、工場出荷状態に戻す方法を探っていきたいと思います。

そうしないと、オリジナルのプログラムを動かすこともできませんからねぇ...。

頑張ります!


<続く>

BSD 2-Clause License

OSSライセンスのメインページは こちら からどうぞ。 ライセンスの目次は こちら です。 名称:「二条項BSDライセンス」(BSD-2-clause) タイプ: ・コピーレフト…× ・ライセンス文の掲示…〇 ・コピーライト(著作権)の掲示…〇 ・その他… × 原文: Cop...