mruby/c mrb file writer.

What is this?

コンパイル後のmrbファイルを、シリアル通信を使ってターゲットに転送する。

How to compile

クロスプラットフォームのために、Qt5 (https://www.qt.io/jp) を使用している。まずQt5をインストール (https://download.qt.io/official_releases/qt/) してから、下記コマンドにてコンパイルする。

qmake
make  # or gmake, nmake

動作確認済の、Qtバージョン

• Windows Qt5.12.12
• Mac Qt5.12.12

Deploy

for Windows

mkdir ¥PATH¥TO¥DEPLOY¥mrbwrite
copy mrbwrite.exe ¥PATH¥TO¥DEPLOY¥mrbwrite
cd ¥PATH¥TO¥DEPLOY¥mrbwrite
windeployqt mrbwrite.exe

for Mac

cp ~/Qt/*/clang_64/lib/QtCore.framework/Versions/5/QtCore .
cp ~/Qt/*/clang_64/lib/QtSerialPort.framework/Versions/5/QtSerialPort .
install_name_tool -change "@rpath/QtCore.framework/Versions/5/QtCore" "@executable_path/QtCore" mrbwrite
install_name_tool -change "@rpath/QtSerialPort.framework/Versions/5/QtSerialPort" "@executable_path/QtSerialPort" mrbwrite

How to use

./mrbwrite --showline   # show all lines
./mrbwrite -l cu.USBSERIAL -s 57600 PROG1.mrb PROG2.mrb ...

通信プロトコル

概要

• POP3プロトコルを模倣している。
• テキストで１行コマンドを送信すると、それに対するレスポンスが返る。
• 改行コードは、CRLF。

レスポンスは、

• +で始まる場合は正常終了
• -で始まる場合はエラー

となる。

例

mrbwrite:                  :TARGET
   |                          |
   |  "version"               |
   +------------------------->|
   |                          |
   |  "+OK mruby/c v1.00"     |
   |<-------------------------+
   |                          |
   |  "BADCOMMAND"            |
   +------------------------->|
   |                          |
   |  "-ERR Illegal command." |
   |<-------------------------+
   |                          |

コマンド

version

バージョン表示

clear

書き込み済みバイトコードの消去

write (size)

mrubyバイトコード書き込み

execute

mrubyプログラム実行

reset

ソフトウェアリセット

help

コマンド一覧表示（人間用）

showprog

書き込み済みプログラムサイズ表示（人間用）

接続の開始

mrbwrite側からターゲットへ空行（CRLFのみ）を送信することで開始される。
ターゲットでは、通常は起動後に書き込み済みのプログラムを実行するため、この参照実装では、起動直後の数秒間にCRLFを受信するか、ボード上のSW1が押されるとコマンド受け付けモードに入る。

典型的なmrbファイル書き込み例

以下の例は、mrbファイルのサイズが250バイトの場合であり、トランザクション中に250という数値がでてくる。

mrbwrite:                :TARGET
   |                        |
   |  CRLF,CRLF,...         |    返信があるまで、Syncコードとして何度かCRLFを送信する
   +----------------------->|
   |                        |
   |  "+OK mruby/c"         |
   |<-----------------------+
   |                        |
   |  "clear"               |
   +----------------------->|
   |                        |
   |  "+OK"                 |
   |<-----------------------+
   |                        |
   |  "write 250"           |
   +----------------------->|
   |                        |
   |  "+OK Write bytecode"  |
   |<-----------------------+
   |                        |
   | (mrb file 250 bytes)   |
   +----------------------->|
   |                        |
   |  "+DONE"               |
   |<-----------------------+
   |                        |
   |  "execute"             |
   +----------------------->|
   |                        |
   |  "+OK"                 |
   |<-----------------------+
   |                        |

バージョンチェック

version コマンドを送信することによって、ターゲットのバージョンを得ることができる。 そのフォーマットは、1つのスペースキャラクタ区切りによる以下のフォーマットが期待される。

(例）

+OK mruby/c v3.3 RITE0300 MRBW1.2

カラム

1. +OK　　　POP3互換ステータス文字列
2. mruby/c　歴史的経緯
3. v3.3　 　mruby/c VM のバージョン
4. RITE0300　実行できるバイトコードRITEバージョン
5. MRBW1.2　この通信プロトコルバージョン