ビルド、書き込み、シリアル

ファームウェアのコンパイル、書き込み、出力タブ、シリアルモニター。デスクトップとブラウザの両方。

Compile と Flash は下部ツールバーの右側にあります。ビルドの出力は Output タブに表示され、ボードが動き出したら Serial Monitor タブでボードに接続します。

ビルドの前に

ツールバー左側の3つの選択肢を確認します。

選択肢 選ぶもの
Target ビルド対象のボード(例: ESP32 DevKit)。
Device ボードが接続されているシリアルポート。Flashのときだけ必要です。
Environment(レイヤーのアイコン) 使うビルド環境(platformio.ini の [env:...] セクション)。アンバーの点は、既定の環境ではないことを示します。

ターゲット、環境、デバイスの設定方法はターゲットと環境を参照してください。

コンパイル

Compile をクリックすると、Embedrは次のことを行います。

  1. 開いているファイルをすべて保存します。
  2. Output タブを開きます。
  3. 選択したターゲットと環境をビルドし、ビルドログを逐次表示します。
  4. Outputタブのステータスバーに Build Succeeded または Build Failed を表示して終わります。

ビルドに失敗すると、エラーのある行がコードエディタでマークされます。

ボードの接続が必要なのは書き込むときだけです。ハードウェアがなくてもビルドできます。

Compile がグレー表示の場合は、カーソルを合わせると理由が表示されます。

ツールチップ 対処
Select a target to compile ツールバーでターゲットを選びます。
Add capabilities.firmware.actions.build to embedr.yaml to enable compiling プロジェクトが独自のファームウェアツールを使っており、ビルドアクションがありません。プロジェクトマニフェストを参照してください。
Open a project to compile 先にプロジェクトを開きます。

最初のビルドは時間がかかる

環境の最初のビルドでは、ボードのプラットフォーム、コンパイラ、フレームワークをダウンロードします。ESP32では数百MBになるため、最初のビルドには数分かかることがあります。以降のビルドはダウンロード済みのものを再利用するので、ずっと速くなります。

最初のビルドは最大20分、以降のビルドは最大10分まで実行できます。ビルドがこの制限に達すると、Outputタブに Build timed out after … と表示され、ログの最後の部分が表示されます。もう一度実行してください。完了したダウンロードは残ります。

ダウンロードが中断されて不完全なパッケージが残った場合、次のビルドでそのパッケージを削除して再インストールします。

Apple SiliconでのArduinoビルド

一部のボード(Arduino UnoのようなAVRボードなど)のコンパイラはIntel向けのビルドです。Apple Silicon搭載のMacではRosetta 2が必要です。ない場合はビルドに失敗し、EmbedrはRosettaが必要であることを説明して、インストール用のコマンドを示します。

softwareupdate --install-rosetta --agree-to-license

ターミナル(またはEmbedrの Terminal タブ)で実行してから、もう一度ビルドしてください。

Outputタブ

Outputタブには、最後のCompileまたはFlashのログが表示されます。下部のバーには、左側に状態、右側に次の操作があります。

操作 内容
Fix with Agent ビルド失敗後に表示されます。ビルド出力をエージェントに送り、原因を見つけて直すよう依頼します。
Migrate Project プロジェクトを embedr.yaml に移行する必要があることが失敗の原因である場合、Fix with Agent の代わりに表示されます。
ファームウェアファイルのボタン ブラウザで、ビルドしたファームウェアファイルをダウンロードします。
Auto-scroll 最新の出力を表示し続けます。読んでいる間はクリックしてオフにします。
Copy ログ全体をコピーします。
Clear ログを空にします。

ログの一部を選択すると Add to Chat ボタンが表示され、必要な行だけをエージェントに見せられます。

失敗したビルドを自分で読むときは、最後の行ではなく最初の error: の行を探してください。そこにファイル名と行番号が書かれています。fatal error: DHT.h: No such file or directory のようにヘッダーが見つからない場合は、たいていライブラリが不足しています。依存関係とライブラリを参照してください。

書き込み

Flash をクリックすると、ビルドと書き込みを1ステップで行います。Embedrはファイルを保存し、コンパイルしてから、選択したデバイスに書き込みます。Outputタブのログに各段階が表示されます。

Build & Upload: main.cpp
════════════════════════════════════════

▸ Compiling...
  ✓ Compilation successful

▸ Uploading to cu.usbserial-0001...
────────────────────────────────────────
✓ Upload Successful

コンパイルに失敗した場合は、何も書き込まれません。

Flashは、ターゲットとデバイスの両方を選ぶまで無効です。選択したポートがBluetoothのポートのように見える場合、書き込みの前にログで警告されます。

独自のファームウェアツールを使うプロジェクトでは、代わりにプロジェクトのflashアクションで書き込み、選択したデバイスのポートをそれに渡します。プロジェクトマニフェストを参照してください。

書き込みに失敗したとき

ビルドは成功したのに書き込みに失敗した場合は、まずハードウェアを確認します。

  • 間違ったポートを選んでいる
  • USBケーブルが充電専用で、データ線がない
  • USBシリアルドライバがインストールされていない
  • Serial Monitorを含む別のプログラムがポートを開いている
  • 書き込み開始時にボードのBOOTボタンを押し続ける必要がある(ESP32ボードでよくあります)
  • 選択したターゲットが接続したボードと合っていない

デバイスメニューの Connected Devices にポートが一覧表示されます。ボードを接続した後は、更新ボタン(Scan for USB devices)または Rescan を使い、選択を解除するには Deselect Device を使います。

シリアルモニター

タブ列の + メニューから Serial Monitor を開きます。ツールバーで選択したデバイスを使います。

  1. ツールバーでデバイスを選びます。
  2. Baud Rate を選びます(300〜115200)。初期値はアクティブな環境の monitor_speed、設定がなければ9600です。
  3. Connect をクリックします。
  4. Send data... に入力し、Enter を押すか Send をクリックします。各メッセージは末尾に改行を付けて送信されます。
  5. 終わったら Disconnect をクリックします。書き込みの前には必ず切断してください。

ボーレートはファームウェアと一致している必要があります。スケッチで Serial.begin(115200) を呼んでいるなら115200を選びます。一致しないと文字化けします。

出力の上のツールバーには Auto-scroll(Manual に切り替えると新しい行を追いかけなくなります)、Copy、Clear があります。行を選択するとチャットに追加できます。

わかりやすいログを出すと、あなたにとってもエージェントにとってもデバッグが速くなります。

boot
sensor init ok
raw=512 voltage=1.65V
threshold crossed

エージェントにビルド、書き込み、監視を任せる

エージェントは自分でコンパイル、書き込み、Serial Monitorへの接続ができます。次のように依頼すると、一連の流れをすべて任せられます。

選択中のターゲット向けにファームウェアをビルドし、エラーがあれば直して、接続したボードに書き込んでください。その後シリアル出力を10秒間読み、センサーが初期化できたか教えてください。

プランモードでは書き込みとシリアルへのアクセスはブロックされます。Embedrエージェントとプランモードを参照してください。

ブラウザでは

ブラウザ版Embedrは、ファームウェアをクラウドでビルドし、Web Serialでボードと通信します。

  • Compile はクラウドで実行されます。成功すると、Outputタブでファームウェアファイルをダウンロードできます。
  • Web SerialにはChromium系のブラウザ(ChromeやEdgeなど)とHTTPSのページが必要です。他のブラウザではシリアルデバイスにアクセスできません。
  • デバイスメニューを開いて Pair Browser Serial... を選ぶと、ページにポートへのアクセスを許可できます。一覧に表示されるのはペアリング済みのポートだけです。No paired devices は、まだどのポートも許可されていないことを意味します。
  • ブラウザでの Flash は、ESP32 Dev ModuleとESP32-S3 DevKitC-1のターゲットに対応しています。Embedrは書き込みの前に、接続されたチップがビルドと一致しているか確認します。その他のターゲットでは、ファームウェアをダウンロードしてデスクトップアプリで書き込んでください。
  • Serial Monitor は、ペアリングしたポートを使ってデスクトップと同じように動作します。

クリーンビルド

直したはずなのにビルドが失敗し続ける場合や、フレームワークやターゲットのファミリーを切り替えた後は、ビルド出力を消去してから再度ビルドします。ターミナルから:

embedr clean
embedr compile

または embedr compile --clean で、1ステップでクリーンビルドします。CLIリファレンスを参照してください。