Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ smalruby3-editor の機能ドキュメントは **ユーザーストーリー単
| [`extension-boost/`](extension-boost/) (`defaultHidden: true`) | ⬆️ そのまま | ✅ |
| [`extension-wedo2/`](extension-wedo2/) (`defaultHidden: true`) | ⬆️ そのまま | ✅ |
| [`extension-mesh-v2/`](extension-mesh-v2/) | 🆕 独自 | ✅ |
| [`extension-smalrubot-s1/`](extension-smalrubot-s1/)(Studuino/旧 スモウルボットS1) | 🆕 独自 | ✅ |
| [`extension-smalrubot-s1/`](extension-smalrubot-s1/)(アーテックロボ・Studuino 基板/旧 スモウルボットS1) | 🆕 独自 | ✅ |
| [`extension-koshien/`](extension-koshien/) | 🆕 独自 | ✅ |
| [`extension-smalruby-ruby/`](extension-smalruby-ruby/) | 🆕 独自 | ✅ |
| [`extension-tm2scratch/`](extension-tm2scratch/) | 🆕 独自 | ✅ |
Expand Down
50 changes: 34 additions & 16 deletions docs/extension-smalrubot-s1/README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
# 拡張機能: Studuino(スタディーノ)/旧 スモウルボットS1
# 拡張機能: アーテックロボ(ArtecRobo)/旧 スモウルボットS1

> **🆕 Smalruby 独自** — upstream に存在しない、Smalruby のために新規追加された拡張機能

- **Smalruby ランタイム対応**: ❌(smalruby3 gem は未対応。WebSerial API 経由でハードウェアと通信するためブラウザ専用)
- **デフォルト表示**: ✅(拡張機能ライブラリにデフォルトで表示される)

> **いまの状態とこれから**: この拡張機能は、**同じ拡張機能のまま「Studuino(スタディーノ)」の名前に変えた**(前の名前は「スモウルボットS1」)。
> **いまの状態とこれから**: この拡張機能は、**同じ拡張機能のまま「アーテックロボ(ArtecRobo)」の名前に変えた**(前の名前は「スモウルボットS1」)。
> ブロックの表示は一般的な名前にし、実機が無くても動かせる **練習用の基板**(VM の中のしくみと、ステージの横のパネル)を入れた。
> このページは、いまの挙動と、リニューアルで決まった方針の両方を書く。
> 見分けがつくように、まだ実装していないことには **🚧 これから** と付ける(印の無いことは、いまの挙動)。

## 概要

株式会社アーテックの、ロボット製作に特化した Arduino 互換基板 **Studuino®(スタディーノ)** を Smalruby から制御する拡張機能(前の名前は、この基板を使ったロボット「スモウルボットS1」から取った「スモウルボットS1」)。Web Serial API を使ってブラウザから USB 経由で基板と通信し、DC モーター・サーボモーター・LED・センサーを操作する。
株式会社アーテックのロボットキット **アーテックロボ(ArtecRobo)** の制御基板 **Studuino®(スタディーノ)** を Smalruby から制御する拡張機能(前の名前は、この基板を使ったロボット「スモウルボットS1」から取った「スモウルボットS1」)。Web Serial API を使ってブラウザから USB 経由で基板と通信し、DC モーター・サーボモーター・LED・センサーを操作する。

ファームウェアの書き込みも内蔵(**WebSerial STK500v1 実装**、`smalrubot-firmware-flasher.js`)しており、初回利用時にブラウザから基板へファームウェアを転送できる(macOS は PL2303 Serial Driver が別途必要)。

### リニューアルのねらい

- 中学校技術・家庭科の「計測・制御」の授業で、**Studuino で授業ができる** と先生に伝わるようにする(スモウルボットは名前が知られていない)。
- 中学校技術・家庭科の「計測・制御」の授業で、**アーテックロボ(Studuino)で授業ができる** と先生に伝わるようにする(スモウルボットは名前が知られていない)。
- 教科書は「光センサー」「仕事を行う部分」のような一般的な言葉で書かれているので、ブロックの表示も一般的な名前にする(いまは「左のセンサー」のようなロボットの部品の名前)。
- 実機がつながっていないと、センサーの値は 0 のままで、LED・モーター・サーボの命令は何もしない。そのため、2 人で 1 台・自宅・欠席の補習では進められず、レッスンの「できた」の判定もできない。これを **練習用の基板** で解決する。

## ユーザーストーリー

- **Studuino(スモウルボットS1)を持っている小学生・中学生**として、Smalruby のブロックでロボットを動かしたい
- **アーテックロボ(スモウルボットS1)を持っている小学生・中学生**として、Smalruby のブロックでロボットを動かしたい
- **「計測・制御」を教える先生**として、教科書と同じ言葉(光センサー、DC モーターなど)で Studuino を扱わせたい
- **基板が足りない教室・自宅で学ぶ生徒**として、実機が無くても練習用の基板でプログラムを動かして確かめたい(センサーの値はパネルのスライダーとボタンで変える)
- **教師**として、複数台のロボットを生徒それぞれに渡して、教室全体でロボットプログラミングをさせたい
Expand All @@ -33,24 +33,38 @@

## 名前の変更と互換の方針

**同じ拡張機能のまま、表示の名前だけを「Studuino(スタディーノ)」にした**。前の作品(sb3・Ruby)はそのまま開けて、そのまま動く。
**同じ拡張機能のまま、表示の名前だけを「アーテックロボ(ArtecRobo)」にした**。前の作品(sb3・Ruby)はそのまま開けて、そのまま動く。

### キットと基板の呼び分け

中学校の教員用テキスト「計測と制御キットB」に合わせて、**キット全体を「アーテックロボ(ArtecRobo)」、制御基板を「Studuino(スタディーノ)」** と呼び分ける。

| 呼び名 | 使うところ |
|---|---|
| **アーテックロボ**(英語は ArtecRobo) | 拡張機能の名前(ライブラリのカード・ブロックのカテゴリ・メニューバー・接続モーダルの見出し)、Ruby タブのふりがな、紹介ページの見出し |
| **Studuino**(スタディーノ) | 基板のこと: 接続の手順の文・ファームウェアのモーダル・練習用の基板のパネル・カードの説明文(「アーテックロボの Studuino 基板」) |

Ruby の書き方は `studuino.` のまま(下の「Ruby の書き方」)。スモウルビーのふりがなは読みではなく意味を書くので、`studuino` の上には「アーテックロボ」と出る。

### 変えたもの

| 対象 | 前 | いま |
|---|---|---|
| 拡張機能の名前(ライブラリ・カテゴリ・メニューバー・接続モーダル・ファームウェアのモーダル) | スモウルボットS1 | **Studuino(スタディーノ)**(ひらがなの表示では「Studuino (スタディーノ)」、文の中は「スタディーノ」) |
| 拡張機能の名前(ライブラリ・カテゴリ・メニューバー・接続モーダルの見出し) | スモウルボットS1 | **アーテックロボ(ArtecRobo)**(カテゴリとメニューバーは「アーテックロボ」、英語は「ArtecRobo」) |
| 基板を指す文(接続モーダルの文・ファームウェアのモーダル・練習用の基板のパネル) | スモウルボットS1 | **Studuino**(ひらがなの表示の文の中は「スタディーノ」) |
| ライブラリの絵(カード・接続モーダル・カテゴリの絵) | スモウルボットS1 のロボットの写真 | **自分たちで用意した基板の絵**(アーテック社の写真・ロゴは使わない。下の「ライブラリの絵と商標の表記」) |
| ライブラリのカードの説明 | スモウルボットS1を制御する。 | アーテック社の表記に合わせた紹介と、登録商標の一文(下の「ライブラリの絵と商標の表記」) |
| Ruby タブのふりがな(`studuino` / `smalrubot_s1` の上に出る名前) | スモウルボットS1 | スタディーノ |
| Ruby タブのふりがな(`studuino` / `smalrubot_s1` の上に出る名前) | スモウルボットS1 | アーテックロボ |
| Ruby の書き出し | `smalrubot_s1.` | **`studuino.`**(読みこみは `smalrubot_s1.` も受けつける。下の「Ruby の書き方」) |
| ブロック・選択肢の表示 | ロボットの部品の名前(「左のセンサー」など) | 一般的な名前(下の「ブロックと選択肢」)。センサーの選択肢を足し、ロボットのブロックを「ロボットカー」の見出しの下にまとめた |

### ライブラリの絵と商標の表記

- **絵**: 人間が Gemini で描いた、青い基板を斜めから見たイラストを **もとにして** 作った。アーテック社の製品の写真やロゴは使っていない。基板の上の文字(「STUDY」「EDU」「Servo」「Sensor」「POWER」「ANALOG IN」「Reset」)は、アーテック社の製品やロゴに見えないように消した。
- カード(600×372)は背景ごと切り出して縮小した。接続モーダルの絵(95×95)とカテゴリ・カードの小さい絵(40×40)は、基板だけを切り抜いて背景を透明にした。カテゴリの絵(VM の `blockIconURI`)は 40×40 と同じ絵。
- **商標の表記**: アーテック社の表記「ロボット製作に特化した Arduino 互換基板 Studuino®(スタディーノ)」に合わせる。アーテック社の製品だとわかるように、ライブラリのカードの説明に「**Studuino® は株式会社アーテックの登録商標です。**」を入れた(カードには前から「協力: Artec Co., Ltd.」も出る)。紹介ページ(`pages/about.html`)の Studuino の紹介にも同じ一文を入れた。
- **商標の表記**: カードの説明は「アーテックロボ(ArtecRobo)の Studuino®(スタディーノ)基板を動かす。**アーテックロボは株式会社アーテックの製品で、Studuino® は同社の登録商標です。**」。Studuino® は登録商標なので ® を付ける。アーテックロボ(ArtecRobo)は商標の扱いを確かめていないので、「登録商標」と言い切らず「株式会社アーテックの製品」と書く。カードには「協力: Artec Co., Ltd.」も出る(実際に協力いただき、基板も提供いただいている)。紹介ページ(`pages/about.html`)の紹介にも同じ一文を入れ、写真はこの基板の絵にした。

![紹介ページの計測と制御のカード](screenshots/0701-about-page-1280x800.png)

### 変えないもの

Expand Down Expand Up @@ -162,7 +176,7 @@ smalrubot_s1.sensor_value("ir_a4")
studuino.sensor_value("ir_a4")
```

- 変換器は、同じ表(メソッドと引数のチェック)を `studuino` と `smalrubot_s1` の 2 つのレシーバーで登録している。Ruby タブのふりがな(「スタディーノ」)と補完も両方のレシーバーで同じ。補完は `studuino.` を入れ、`smalrubot` と打っても見つかる。
- 変換器は、同じ表(メソッドと引数のチェック)を `studuino` と `smalrubot_s1` の 2 つのレシーバーで登録している。Ruby タブのふりがな(「アーテックロボ」)と補完も両方のレシーバーで同じ。補完は `studuino.` を入れ、`smalrubot` と打っても見つかる。
- `studuino` は、ほかの拡張機能のレシーバー(`mesh` / `koshien` など)やスプライトのメソッドと名前がぶつからない。同じ名前のローカル変数を作ると、Ruby のふつうの決まりどおりそちらが先になる(`smalrubot_s1` のときと同じ)。
- Studuino モード(`docs/studuino-mode/`)も、同じ `studuino.` の書き方を使う前提(ポートの設定の書き方はそちらで決める)。

Expand Down Expand Up @@ -224,7 +238,7 @@ GUI は、イベントを聞いて表示し、センサーの値はこのメソ

### パネル

Studuino の拡張機能を読みこむと、**コードエリアの右上(ステージの列のすぐ左)** に練習用の基板のパネルが出る。たためる。
アーテックロボの拡張機能を読みこむと、**コードエリアの右上(ステージの列のすぐ左)** に練習用の基板のパネルが出る。たためる。
実装は `packages/scratch-gui/src/containers/studuino-practice-board.jsx`(状態を読む・センサーの値を変える)と
`packages/scratch-gui/src/components/studuino-practice-board/`(表示)。

Expand Down Expand Up @@ -321,11 +335,11 @@ Studuino の拡張機能を読みこむと、**コードエリアの右上(ス

## UI / 操作フロー

![拡張機能ライブラリの Studuino のカード](screenshots/0401-library-card-1280x800.png)
![拡張機能ライブラリのアーテックロボのカード](screenshots/0401-library-card-1280x800.png)

### 接続

1. ブロックパレットの「拡張機能を追加」から **Studuino(スタディーノ)** を選ぶ
1. ブロックパレットの「拡張機能を追加」から **アーテックロボ(ArtecRobo)** を選ぶ
2. 接続モーダルが専用フローで開く(`smalrubot-s1-*-step.jsx` 系)。**生徒用 (接続) / 先生用 (ファームウェア書き込み)** のいずれかを選択

![Studuino 初期ステップ](screenshots/0101-initial-step-1280x800.png)
Expand All @@ -336,7 +350,7 @@ Studuino の拡張機能を読みこむと、**コードエリアの右上(ス

### ファームウェアフラッシュ

1. 接続モーダルの「ファームウェアを書き込む(先生用)」 もしくはメニューバーの「Studuino」メニューから起動
1. 接続モーダルの「ファームウェアを書き込む(先生用)」 もしくはメニューバーの「アーテックロボ」メニューから起動
2. ファームウェアフラッシュモーダル (`smalrubot-firmware-modal`) が開く。**macOS では PL2303 Serial Driver アプリのインストール案内** が先に表示される

![ファームウェアモーダル (macOS)](screenshots/0201-firmware-modal-macos-1280x800.png)
Expand All @@ -346,9 +360,13 @@ Studuino の拡張機能を読みこむと、**コードエリアの右上(ス

### ブロックパレット

接続後はブロックパレットの **Studuino** カテゴリに専用ブロックが表示される(ブロックの一覧は上の「ブロックと選択肢」):
接続後はブロックパレットの **アーテックロボ** カテゴリに専用ブロックが表示される(ブロックの一覧は上の「ブロックと選択肢」):

![アーテックロボのブロックパレット](screenshots/0301-block-palette-1280x800.png)

Ruby タブのふりがなでは、`studuino` の上に「アーテックロボ」と出る:

![Studuino ブロックパレット](screenshots/0301-block-palette-1280x800.png)
![Ruby タブのふりがな](screenshots/0601-furigana-1280x800.png)

## 主要ファイル

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading