依存関係とライブラリ
エージェント、embedr CLI、platformio.iniでPlatformIOライブラリを追加、固定、削除します。
センサー、ディスプレイ、通信プロトコル向けのファームウェアライブラリは、プロジェクト自身のファイルで宣言するPlatformIOパッケージです。Embedrには専用のライブラリマネージャーのウィンドウはありません。ライブラリは、エージェントに依頼するか、Terminalで embedr lib コマンドを使うか、platformio.ini を自分で編集して追加します。
一覧の場所
| プロジェクト | 宣言する場所 |
|---|---|
現在のEmbedrで作成したプロジェクト(embedr.yaml に manifest_version: 1 があり、platformio.ini がある) |
platformio.ini の有効な環境のセクションにある lib_deps |
manifest_version: 1 のない古いプロジェクト |
embedr.yaml の build: 以下の lib_deps。Embedrはそこから platformio.ini を再生成します |
一般的な platformio.ini:
[env:esp32dev]
platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
adafruit/Adafruit NeoPixel@^1.12.0
bblanchon/ArduinoJson@^7.0.4
宣言したライブラリは、次のビルドでPlatformIOがプロジェクト内の .pio/libdeps/ にダウンロードします。.pio/ はビルドの出力なので、編集もコミットもしないでください。
エージェントに依頼する
エージェントはPlatformIOレジストリを検索し、ライブラリをインストールできます。チャットでは、これらのステップが Search libraries と Install library として表示されます。
Add a maintained library for the DHT22 sensor, pin it to a version, update
src/main.cppwith a minimal read loop on GPIO 4, compile, and tell me which library you chose and why.
この依頼で、選定、宣言、編集、ビルド、説明までの一連の流れがすべて含まれます。ライブラリのインストールはプロジェクトのファイルを変更するため、プランモードでは実行できません。
CLIを使う
Terminalタブでは、embedr コマンドがパスに入っています。プロジェクトフォルダで実行するか、--path を指定します。
# Search the PlatformIO registry
embedr lib search "neopixel"
embedr lib search dht --limit 5
# Install and declare a library
embedr lib install "Adafruit NeoPixel"
embedr lib install "DHT sensor library" --version 1.4.4
# What the project declares and what is installed
embedr lib list
# Remove a library from the project
embedr lib uninstall "Adafruit NeoPixel"
# Update every library to its latest allowed version
embedr lib update
embedr lib install はパッケージをインストールしてプロジェクトの宣言一覧に追加し、保存先(platformio.ini または embedr.yaml)を表示します。ライブラリがすでに宣言されている場合はその旨を表示し、何も変更しません。すべてのオプションはCLIリファレンスにあります。
GitとURLのソース
レジストリにないライブラリ、フォーク、特定のタグは、lib_deps にURLで宣言できます。
lib_deps =
https://github.com/adafruit/Adafruit_NeoPixel.git#1.12.0
https://github.com/your-org/sensor-driver.git#v2.1.0
https://example.com/vendor-library.zip
# の後ろはタグ、ブランチ、コミットのいずれかです。タグかコミットを使いましょう。ブランチは知らないうちに変わることがあります。リポジトリのURLとタグをエージェントに伝えて、依存関係の追加を依頼することもできます。
lib/ のプロジェクトコード
このプロジェクト専用だがライブラリのように振る舞うコード(たとえば、このロボットのために書いたドライバ)は、lib/<Name>/ に置きます。
lib/
└── MotorDriver/
├── MotorDriver.h
└── MotorDriver.cpp
PlatformIOはこれをプロジェクトと一緒にビルドし、src/ から #include "MotorDriver.h" が使えます。複数のプロジェクトで共有するコードであれば、公開するか、GitのURLで参照してください。
ライブラリが見つからないエラー
src/main.cpp:3:10: fatal error: DHT.h: No such file or directory
コンパイラがヘッダーを見つけられませんでした。原因はたいてい次のいずれかです。
- ライブラリが
lib_depsに宣言されていない - 名前の似た別のライブラリがインストールされた
- ヘッダー名がライブラリ名と異なる(ライブラリのサンプルを確認してください)
- ライブラリが選択中のフレームワークやチップに対応していない
Output タブでエラーを選択して Add to Chat をクリックし、エージェントに修正を依頼するか、Fix with Agent をクリックします。ビルド、書き込み、シリアルを参照してください。
ライブラリの選び方
すべてのArduinoライブラリがすべてのボードで動くわけではありません。AVR向けに書かれたライブラリはESP32やRP2040でビルドできないことがあり、ArduinoのライブラリはESP-IDFではビルドできません。
- ライブラリが自分のフレームワークとプラットフォームに対応しているか確認します。
- ライブラリを追加したら、それを使うコードを書く前にすぐビルドします。
- 授業の教材や製品など、他の人がビルドするプロジェクトではバージョンを固定します(
@1.4.4または@^1.4.4)。 - 共同作業者が同じ一覧を使えるよう、
platformio.ini(とembedr.yaml)をコミットします。
ファームウェアのライブラリではなく、物理的な部品(センサー、コネクタ、IC)についてはコンポーネントライブラリを参照してください。
