コンテンツにスキップ

制約事項

セキュリティ

本体には、接続してくる相手を制限する仕組みがありません。 ネットワーク機能は 家庭内で使う趣味の機器を想定して作っており、届く範囲にいる人は誰でも使ってよい、という 前提で動いています。

遠隔画面 認証がありません。同じネットワークにいれば誰でもアドレスを開いて、画面を見て、キーボードとマウスの操作を送れます。つまり本体をそのまま操作できます
遠隔画面と並んでいるファイル・アプリのエンドポイント こちらも認証がなく、公開しているファームウェアにも入っています。遠隔画面に届く相手は、ファイルの一覧・読み・書き・削除と、アプリの起動・停止もできます
BLE のコンソールとデバッグ機能 Retro と Modern (Tab5・NARYA v4) では既定で起動時に立ち上がります。止めるには BLE Auto Start の設定 (ble_auto_start) を off にします。画面の無い AtomS3R と StickS3 は設定モードのときだけ動かします。動いている間はペアリングも暗号化も行いません (Windows の Web Bluetooth がペアリングで動かなくなるため、意図的に無効にしています)。電波の届く範囲にいれば誰でも接続して、動いているアプリとその変数を見たり、アプリを起動・停止したり、ログを読んだり、普通のファイルを読み書きしたりできます。再起動しないと止められません
TCP の遠隔デバッガ 認証がありません。すべての接続元を受け付けます
WiFi の接続情報 端末上の /home/wifi.toml (WiFi のページが書くもの) か /etc/wifi.toml に平文で保存されます。3.0.0 のリモートのファイルサービスは HTTP では出しません。開発版では出します。/home を WiFi で退避・書き戻しできるように、ファイルのエンドポイントが鍵やパスワードを含むすべてのパスを扱うためです。BLE では、本体で BLE設定受付を開いている間だけ読めます
サービスの鍵 読み上げサービスの API キーは /home/secrets.toml に平文で入り、WiFi のパスワードと同じ扱いです。開発版では、/home のほかのファイルと同じく、ファイルのエンドポイントが HTTP でも出します
アプリ 持ってきたアプリも、他のアプリと同じ権限で動きます。アプリどうしやファイルとの間に隔離はありません

信頼できる環境でのみ、自己責任でご利用ください。インターネット側から届くように ルータで転送するのはやめてください。WiFi は Config の wifi_auto_start で、BLE は ble_auto_start (BLE Auto Start) で、それぞれ起動時に立ち上げないようにできます。BLE は いったん動き出すと、再起動しないと止められません。

R2P2との違い

Family mrubyは、PicoRubyのコアの部分のみをベースとしており、PicoRuby本家のR2P2で利用されているgemを独自に書き換えている部分があります。 そのため利用できるクラスやメソッドの挙動に違いがある場合があります。

PicoRuby と CRuby の違い

PicoRubyはmrubyをベースとしており、CRubyで標準的に使えるメソッドが使えないことがあります。

ヒープのサイズ

Family mruby の各アプリは独立した Ruby VM として動作し、それぞれが PSRAM 上に 独自のヒープとスタック を持ちます。

項目 Retro・StickS3・AtomS3R Modern Linux のシミュレータ・Linux 版 Studio
標準アプリのヒープ 500 KB 1024 KB 1536 KB 1536 KB
large_memory = 1 指定時のヒープ 1024 KB 2048 KB 3072 KB 3072 KB
同時に動くユーザアプリ 3 5 5 5
同時に動く large_memory のアプリ 2 1 1 1

ユーザアプリの数は system_conf.toml の max_apps で減らせます。 プールは伸びません。求めた大きさの連続した空きが 1 つも無ければ、合計に余裕があっても メモリ不足になります。Linux の 2 つは 64 ビットで、同じスクリプトにおよそ 1.5 倍の場所が 要るので、Modern とほぼ同じ厳しさです。Studio はどの実機よりも緩いので、大きなアプリは 実機でも確認してください。

ヒープの使用状況はモニターアプリで確認できます。

言語ごとの対応状況

言語 状況
Ruby (PicoRuby) 中心となる言語。この文書に書かれているものが全部使えます
MicroPython 使えますが制限があります。Python アプリは同時に 1 本、ファイルは丸ごとの読み書きだけ (FmrbFile)、文字列はバイト列、標準ライブラリは狭い。描画・スプライト・音は使えます。MicroPython と BASIC を参照
BASIC 2.0 で機能実装完了。Family BASIC (V3) との既知の差は全件が整理されています。MicroPython と BASIC を参照
Lua コンセプト実装。本格的なアプリを書くのには適していません
C・TinyGo・Rust・Zig WebAssembly のアプリ として、開発版で試験的に動きます。ESP32-S3 の基板 (Retro・StickS3・AtomS3R) では動きません。SDK の名前や形はこれから変わることがあります

アプリの中で待つとき

Machine.delay_ms を使ってください。中身は FreeRTOS の vTaskDelay です。

Machine.delay_ms(500)

さらに良いのは、そもそも止めないことです。on_update の戻り値で「次に呼んでほしいまでの ミリ秒」を返し、待つのはメッセージ処理に任せます。止まっている間、そのアプリはイベントを 処理できません。

2.0 より前はもっと厳しい制約でした

1.0 では、PicoRuby のタスク切り替えに使う tick を止めていました。VM の外から呼ぶと VM のスタックが壊れたためです。これは修正済みです。tick は信号源が数えておき、 スケジューラの 1 か所でまとめて適用する形になり、Task 機能も動きます。上の Machine.delay_ms の話は「止めないこと」についてであって、この壊れ方の話ではありません。

(EditorやShellではTask機能を利用してます)

ファイルシステムの制限

項目 内容
1 ファイルの最大サイズ LittleFS の制限内(数 MB 程度推奨)
パスの最大長 FmrbConst::MAX_PATH_LEN
ファイル名 ASCII 推奨。日本語や記号は避ける
Dir#seek / Dir#tell 未対応(ENOSYS)。rewind してから数え直す

アプリ間メッセージのサイズ制限

Pub/Sub の publish / send_message のペイロードは MessagePack 後で 176 バイト までです。それを超える場合はファイル経由にする、複数メッセージに分けるなどの工夫が必要です。

機種ごとの制約

ほとんどの制約は両機種に共通ですが、以下は違います。

Modern (M5Stack Tab5)

microSD P4 の SDMMC ホストで読み書きでき、/mnt/sd (/sd でも可) に見えます。カード検出の線が無いので、カードは入っているものとして扱います
映像出力 出力は内蔵の液晶だけです。コンポジット出力はありません
GROVE 2 つではなく 1 つです
電池で動く時計 あります (RX8130)。ネットワークにつながると timesync サービス が合わせます。手で合わせるなら Set Clock です
マウスのホイール USB マウスのホイールは /etc/hid_devices.toml に書いた機器でだけ動きます。つなぐと、書き足す行がログに出ます

Retro (narya-board)

WiFi と BLE 無線が 1 系統で、同時には使えません。BLE のコンソールを動かすと WiFi は起動せず、逆も同じです
タッチ タッチ画面はありません。ポインタは USB マウスです
遠隔画面 ありません
ファームウェア 書き込むチップが 2 つあり、両方を同じ版に揃えないと起動しません
常駐サービス Retro のファームウェアには入っていません。時計・ネットワーク・読み上げは Modern だけです
WAV の再生 play_wav は false を返します。音は直列線の先にあり、鳴らす前に毎回そこへ送るのは遅すぎて割に合いません
マウスのホイール Modern と同じく、機器ごとの指定が要ります

画面の小さいヘッドレス機 (M5Stack StickS3・AtomS3R)

デスクトップ ありません。startup_app に書いた 1 つのアプリ (出荷時は Welcome) を小さな画面 (StickS3 は 240 x 135、AtomS3R は 128 x 128) で動かします
WiFi の設定 Family mruby コンソール から BLE で書き込みます。ボタンを押したまま電源を入れるとセットアップモードになります。WiFi の設定が何も無ければ、自動でセットアップモードで起動します。BLE はセットアップモードの間だけ動きます
同時に動くアプリ Retro と同じく 3 つ (ヒープのサイズ を参照)

Studio (ブラウザ版)

ネットワーク FmrbNet.request はブラウザを通して取ってくるので、別のサイトからの取得を許していないサーバは読めません。ソケット (Net::HTTP、WebSocket) はありません
ファイル /home と /app/usr、それに設定がブラウザの中にだけ残ります。その外は読み込み直すたびに作り直されます。残したいものはまとめて取り出してください
ブラウザ パソコンの Chrome と Firefox。Safari は未確認、スマートフォンとタブレットは対象外です (キーボードが要るため)
タブは 1 枚 同じページを 2 枚開くと、保存するのは最初のタブだけです

Family mruby スタジオ を参照してください。