まず読む
Embedrとは何か、エージェントビューとIDEビュー、基本用語、最初の依頼から実機で動かすまでの流れ。
Embedrは、ハードウェアプロジェクトのためのエージェント型ワークスペースです。1つのプロジェクトに回路、基板、ファームウェア、筐体、製造ファイルをまとめ、Embedrエージェントがそのすべてを読み、変更できます。チャットでやりたいことを伝えると、エージェントが作業を計画し、ファイルを編集し、ファームウェアをビルドし、基板をチェックして結果を報告します。その作業は同じウィンドウで確認でき、いつでも介入できます。
Embedrは、macOS、Windows、Linux向けのデスクトップアプリと、studio.embedr.appのWebアプリとして動作します。どちらも同じアカウントと同じプロジェクト形式を使います。違いはブラウザ版Embedrを参照してください。
ホーム画面
サインイン後のホーム画面には次のものがあります。
| 領域 | 役割 |
|---|---|
| 入力欄(Describe what you want to build) | 作りたいものを普通の言葉で書いて送信します。Embedrがプロジェクトを作成し、その依頼でエージェントを起動します。 |
| 構成の切り替え(Electronics / + Firmware) | Electronics only: 回路基板のプロジェクト。Electronics + firmware: 基板と、その上で動くコード。 |
| モデル選択 | 新しいプロジェクトでエージェントが使うモデル。モデルを参照してください。 |
| Target選択 | + Firmwareのときに表示されます。ファームウェアをコンパイルする対象のボードです。 |
| プロジェクトのアイデアカード | 依頼の例です。クリックすると入力欄に入ります。 |
| Create Blank Project | 依頼なしで空のプロジェクトを作成します。 |
| Import KiCad | 既存のKiCad回路図やプロジェクトをEmbedrプロジェクトに変換します。 |
| Open Folder(デスクトップ) / Import Folder(Web) | 既存のフォルダをEmbedrに取り込みます。 |
| Clone Repository(デスクトップ) | Gitリポジトリをクローンして開きます。 |
| Recent Projects | 自分のプロジェクト一覧。絞り込み欄と、Last opened / Recently createdの並べ替えがあります。行にカーソルを合わせると名前の変更や削除ができます。 |
エージェントビューとIDEビュー
プロジェクト内では、タイトルバーの切り替えでレイアウトを選びます。
| ビュー | 中央 | サイドパネル |
|---|---|---|
| Agent(既定) | Embedrエージェントとのチャット | 左にチャット履歴、右にエディタとワークスペース |
| IDE | コードエディタとワークスペースのタブ | 左にファイルエクスプローラー、右にエージェントのチャット |
どちらのビューも同じプロジェクトと同じチャットを表示します。タイトルバーのボタンでサイドパネルを切り替え(左はToggle Chat HistoryまたはToggle File Explorer、右はToggle Editor PanelまたはToggle Chat with Agent)、Keyboard shortcutsとSettingsを開けます。
ウィンドウ下部のツールバーはどちらのビューでも同じです。
- ファームウェア用のTarget、Device、Environmentの選択(エレクトロニクスのみのプロジェクトでは非表示)。
- Share、バージョン管理用のブランチボタン、Compile、Flash、Search Codebase。
ワークスペースとツール
タブバーの+(Add tab)ボタンからワークスペースを開きます。
| グループ | タブ |
|---|---|
| ワークスペース | Schematics、Board、Mechanical |
| ツール | Terminal、Serial Monitor、Output、BOM、Manufacturing |
| (区切り線の下) | Review Changes、Settings |
- Schematicsは、プロジェクトの
.zenソースから回路を描画します。回路図とPCBを参照してください。 - Boardは、KiCadのレイアウトを2Dと3Dで表示し、デザインルールチェックを行います。ボードとKiCadと配置と配線を参照してください。
- Manufacturingは、基板をチェックし、注文用のファイルを準備します。製造と注文を参照してください。
- Mechanicalは、筐体などの部品をビルドし、レビューします。機構設計を参照してください。
- Output、Serial Monitor、Terminalは、ファームウェアのビルドと実機の動作確認に使います。ビルド、書き込み、シリアルとターミナルとセットアップを参照してください。
基本用語
| 用語 | 意味 | 例 |
|---|---|---|
| プロジェクト | embedr.yamlマニフェストを含むフォルダ。ファームウェア、ハードウェアのソース、仕様書、ドキュメントを保持します。 |
~/EmbedrProjects/plant-monitor/ |
| ターゲット | ファームウェアのコンパイル対象となるボード設定。PlatformIOのプラットフォーム、ボードID、フレームワークの組み合わせです。 | esp32(ESP32 DevKit、Arduino) |
| 環境 | 名前付きのビルドプロファイル。platformio.iniの[env:...]セクション1つに当たります。 |
env:esp32 |
| デバイス | コンピューターに接続したボードのシリアルポート。書き込みとモニターに使います。 | /dev/cu.usbserial-0001、COM5 |
| 回路図 | 回路そのもの。pcb/以下の.zenソースとして書かれ、Schematicsタブに描画されます。 |
pcb/main.zen |
| ボード | 物理的なレイアウト。回路図から生成されるKiCadの.kicad_pcbファイルです。 |
pcb/layout/layout.kicad_pcb |
| 機構設計 | mechanical/以下にあるパラメトリックまたは取り込んだ3Dモデル。 |
mechanical/enclosure.cad.json |
| スレッド | エージェントとの1つの会話。1つのプロジェクトに複数持てます。 | 「土壌水分センサーを追加して」 |
| 仕様書 | プランモードで書かれる、specs/以下のMarkdownの計画。 |
specs/plant-monitor.md |
ターゲットは「何向けにコンパイルするか」、デバイスは「いまボードがどこに接続されているか」に答えます。ボードを接続していなくてもコンパイルできます。デバイスが必要なのは、書き込みとシリアルモニターを開くときだけです。ターゲットと環境を参照してください。
各用語の背後にあるファイルは、プロジェクトの構造とプロジェクトマニフェストで説明しています。
エージェントとの作業の進め方
- 依頼を送る。 デバイスに何をさせたいか、手元にある部品、重視すること(サイズ、コスト、電池寿命、基板メーカー)を伝えます。
- 大きな作業はまず計画する。 入力欄でShift+Tabを押すとプランモードに切り替わります。エージェントが質問し、
specs/以下に仕様書を書きます。Implement this specをクリックすると構築が始まります。プランモードを参照してください。 - 質問に答える。 判断が必要なとき、エージェントはチャットで選択肢付きの質問をします。「You decide」を選ぶとエージェントが決め、その前提を記録します。
- リスクのある操作を承認する。 承認が必要なコマンドや操作は、チャットでAllow once、Decline、該当する場合はAlways allowとともに待機します。
- 作業中に指示する。 実行中に送ったメッセージはキューで待機します。そのメッセージのSteerをクリックすると、デスクトップでは実行を止めずに次のステップで反映されます(「Joins next step」)。
- 作業を任せる。 大きな作業では、エージェントがレビュー担当などのヘルパーを起動できます。ヘルパーは自分のスレッドで作業し、結果を報告します。ヘルパーを参照してください。
- コンテキストを添付する。 ファイル、画像、データシートのPDF、貼り付けたログを入力欄にドロップするか、
@でファイルを指定します。データシートを参照してください。
詳しくはEmbedrエージェントを参照してください。
最初のセッション
この手順では、小さなESP32プロジェクトを作り、ボード上で動かします。
ホーム画面で+ Firmwareを選び、TargetをESP32 DevKitなどのESP32ボードに設定します。
依頼を入力して送信します。
A desk plant monitor: an ESP32 reads a capacitive soil moisture sensor and a BME280 over I2C, and prints readings over serial every 5 seconds. Powered from USB. I want a 2-layer board I can order from PCBWay.Create New Projectで、提案された名前をそのまま使うか独自の名前を入力し、Create Projectをクリックします。Embedrは
~/EmbedrProjects/にプロジェクトを作成してエージェントビューで開き、最初のチャットはプランモードで始まります。チャットでエージェントの質問に答えると、
specs/以下に仕様書が書かれます。通知の案内(Know when it’s done)が表示されたら、Turn onを選ぶとエージェントの完了時に知らせを受け取れます。仕様書が正しければImplement this specをクリックします。エージェントがプロジェクトを構築します。ツール呼び出しは「Read 3 files, ran 2 commands」のような要約付きの折りたたまれたグループとして表示され、展開すると詳細を確認できます。実行が終わったら、エージェントの要約を読みます。+メニューからSchematicsとBoardを開いて回路とレイアウトを確認し、
src/main.cppを開いてファームウェアを読みます。下部ツールバーのCompileをクリックします。出力はOutputタブに流れ、最後にBuild SucceededまたはBuild Failedと表示されます。失敗した場合はFix with Agentをクリックします。
データ通信に対応したUSBケーブルでボードを接続します。Device選択を開き、そのポートを選びます(見つからない場合は再スキャンボタンをクリックします)。
Flashをクリックします。
+メニューからSerial Monitorを開き、Baud Rateをファームウェアが使う値(既定は115200)に設定して、Connectをクリックします。
変更したいときは、同じスレッドで依頼します。
The moisture reading jumps around. Average 10 samples and print the percentage with one decimal place.
新しいターゲットでの最初のコンパイルでは、ボードのツールチェーンをダウンロードするため数分かかることがあります。以降のビルドではそれを再利用します。
ファームウェアやハードウェアのないプロジェクト
- Electronics onlyのプロジェクトには、ターゲット、デバイス、環境の選択がありません。
pcb/ワークスペースと、後から追加したものを保持します。 - 取り込んだKiCadプロジェクトは、エレクトロニクスのプロジェクトとして始まります。準備ができたらエージェントにファームウェアの追加を依頼してください。
embedr.yamlのない開いたフォルダでは、チャットにAgent needs to exploreと表示されます。モデルを選んでInitialise Agentをクリックすると、エージェントがリポジトリを調べ、ソースを置き換えずにembedr.yamlを書きます。
次に読むもの
- インストールとアカウント: インストーラー、サインイン、プラン、アップデート。
- プロジェクトの構造: プロジェクト内の各ファイルとフォルダの役割。
- Embedrエージェント: エージェントとの作業の詳細。
- キーボードショートカットとトラブルシューティング。
