Skip to content

docs(studuino-mode): Studuino モードの設計(モード・ポート設定・保存・Ruby・構文木と C++ の表・Lambda・書きこみ)を docs に書く #2208

Closed

Description

@smalruby3-editor-bot

なにをするか

EPIC #2163 で決まった Studuino モードの設計を docs に書く。コードは変えない(このあとの sub-issue が docs を正として実装する)。PR 先は topic ブランチ topic/studuino-2163(まだ無ければ develop から作る)。

決まったこと(#2163 の「決まったこと(Studuino モードの設計・2026-11-19)」が正)

M1〜M8・S1〜S14 の答えと、S7 のライブラリのライセンスの確認、Studuino ライブラリの API の要約は #2163 の本文にある。ここに写さず、docs にまとめる。

変える場所

  • 新しく docs/studuino-mode/README.md(🆕 Smalruby 独自。冒頭の区分・ランタイム対応・デフォルト表示)。docs/extension-smalrubot-s1/(epic(studuino): スモウルボットS1 の拡張機能を Studuino としてリニューアルし、練習用の基板を入れる #2162 で Studuino の docs になる)からリンクする。
  • 書くこと:
    • モードの入り方(M5・S4)と、モード切替の条件・確認のダイアログ(M6・S11)
    • 第 1 弾のブロックの一覧(S1)と、本家との対応(設計ページの対応表から、本家の文言・画像は写さず一般名詞で。S14)。第 2 弾(リスト・「ブロックを作る」)
    • ポートの設定(S2): ポートごとに選べる部品(D 系=サーボ、M1/M2=DC モーター、A0〜A3=光・音・赤外線フォトリフレクタ・温度・タッチ・LED・ブザー・ボタン、A4/A5=ボタン以外、A6/A7=光・音・赤外線フォトリフレクタ・温度)、ブロックのドロップダウンの表示(例「光センサー (A6)」)、外したとき(S5)、補正値
    • 保存の形(S10: extensionStorage のキーと JSON の形・Studuino モードかどうか)
    • Ruby(S3): class Studuino の宣言とプログラムの書き方。宣言のシンボルの決め方(S2 で「名前はドロップダウンで選ぶ機器の名前」になったので、light_sensor :light_sensor_a6, port: :A6 のように部品とポートから作るか、別の形か)をここで決める
    • 構文木(Studuino IR)のスキーマ(S6: 数値と真偽だけ)と、op ごとの C++ の書き出しの表(Studuino ライブラリの関数への対応。epic(studuino): Studuino モード(プログラムを hex にして Studuino 単体で動かす) #2163 の API の要約を使う)
    • Lambda の API(リクエスト・レスポンス・エラー・上限 S12)
    • 書きこみの流れ(S13・M4・M7): 緑の旗=書きこみ、停止=書きこみの中断、終わったあとの案内、ファームウェアに戻す
    • ライブラリのライセンスと、hex を返すときのソースの入手方法(epic(studuino): Studuino モード(プログラムを hex にして Studuino 単体で動かす) #2163 の S7 の確認。アーテック社の回答が来たら更新)
  • .prettierignore のホワイトリストに新しい docs が要るなら足す。

テスト

docs のみ。npm run lint(prettier の対象なら format)。

DoD

  • 上の内容が docs にあり、🧱 infra の sub-issue と GUI の sub-issue がこの docs を参照できる。
  • 本家のスクショ・ロゴ・文言をそのまま載せない(S14)。ライブラリのファイル・リファレンスの本文を載せない(要約だけ)。

親 EPIC: #2163 。設計のページ: https://claude.ai/artifact/8oX8q5A9FuJYX1xUWnYwJt

Activity

  1. smalruby3-editor-bot commented on Nov 18, 2026

    @smalruby3-editor-bot
    Author

    PR #2223 を topic/studuino-2163 にマージしました。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions