iroh搭載スマートファン
An iroh powered smart fan (iroh.computer)
要約
この記事では、irohネットワークライブラリとESP32マイクロコントローラーを使用して、クラウドコンポーネントなしで動作するスマートファンを構築する方法を紹介しています。ESP32は温度センサーを読み取り、ファンを制御し、WebAssemblyで動作する小さなウェブサイトを通じて世界中どこからでもアクセス可能です。PSRAM搭載のESP32-WROVER開発キットをベースに、ローカルネットワークとリレー接続を利用して、デバイスがグローバルに到達可能になるプロセスを解説しています。
全文翻訳
irohで動くスマートファン
もしあなたが(ヨーロッパ北半球)に住んでいるなら、今頃は熱波に苦しんでいることでしょう。irohを使って、涼しさをもたらす何かをしましょう。
以前のESP32の例では、エコープロトコルをデモンストレーションしました。しかし、ESP32は単なるデータのエコー以上の用途に使われることが一般的です。センサーを読み取ったり、アクチュエーターを駆動したりするために、ESP32を安価な手段として使用します。
そこで今回は、ESP32を使って温度を測定し、ファンを制御する非常にシンプルなエンドツーエンドの例を作成します。ほとんどのIoTデバイスとは異なり、クラウドコンポーネントは一切ありません。WebAssemblyをサポートするどのブラウザからでも、どこからでも使用できる小さなウェブサイトだけです。
ベースとして、ESP32-WROVER devkitに4MiBのPSRAMを搭載したものを使用します。これにより、リレー接続を含むirohの全てのネットワーク機能が利用可能になり、世界中のどこからでもリモートで制御できるようになります。M5StickC-Plus2も使用できますが、GPIOピンの調整が必要になります。
PSRAMを搭載したESP32-S3のような別のdevkitをお持ちの場合でも、小さな設定変更で例を実行できるはずです。
PSRAMを搭載していないESP32しかない場合でも、irohは使用できます。ただし、リレー接続を無効にし、メモリ不足にならないようにQUICバッファを調整する必要があります。iroh-esp32-examplesから適切な例をベースに使用してください。
基本的なセットアップ
最初のステップとして、iroh-esp32-examplesからエコーサーバーの例をコピーします。ESP32バイナリにはserver-esp32-psramを使用します。
クライアント側には、最も基本的なclientを使用します。これはデスクトップPC上で動作します。
これはスマートファンの例なので、server-esp32-psramをserver-smart-fanに、clientをsmart-fan-cliにリネームします。
異なるツールチェーンが必要であり、ESP32バリアント用にirohのパッチを使用するオプションを維持したいので、2つのディレクトリは完全に独立したRustプロジェクトです。ワークスペースは使用しません。
初回フラッシュ
変更を加える前に、一度試してみましょう。サーバープロジェクトでcargo runを実行すると、USB経由で接続されたESP32を検索してフラッシュします。ESP32をUSB-Cケーブルで接続するだけです。
最初のリリースビルドには時間がかかります。irohだけでなく、オペレーティングシステムもxtensaアーキテクチャにコンパイルするためです。その後のビルドは、コンパイル結果が.embuildディレクトリにキャッシュされるため、より速くなります。
フラッシュ自体は、チップへのデータレートが非常に限られているため、決して速くはなりません。ESPF LASH_BAUD環境変数を設定することで、少し速くすることができます。私のチップは230400ボーに対応していますが、環境によって異なる場合があります。うまくいかない場合は、環境変数を設定せずに実行してください。その場合は安全なデフォルト値が使用されます。
ESP32にWLANへの接続方法を指示する必要があります。例では、別の環境変数WIFI_CONFIG=SSID:PASSWORDを使用します。これをローカルWLANに設定してください。
export WIFI_CONFIG=SSID:PASSWORDのように一度だけエクスポートすれば、毎回渡す必要はありません。
フラッシュ出力からわかるように、フラッシュサイズの限界にかなり近づいています。
追加されたコードの1行ごとに限界を超えるのではないかと思うかもしれませんが、そうではありません。[irpc](https://docs.rs/irpc/latest/irpc/)のような追加の純粋なRust依存関係は、サイズをほとんど増やしません。
試してみる
これで、ESP32上で動作するシンプルなエコーサーバーができたはずです。
エンドポイントID
まず、エンドポイントIDをどのように割り当てるのでしょうか?エンドポイントIDを割り当てる機能は欲しいですが、たとえ割り当てなくても、再起動後にエンドポイントIDが安定することを望みます。そのため、ESP32は起動ごとにランダムなIDを生成すべきではありません。
代わりに、初回起動時に不揮発性メモリに秘密鍵を生成して保存し、以降の起動で再利用します。不揮発性メモリはフラッシュしても上書きされないため、不揮発性メモリを明示的に削除しない限り、同じデバイスに対して同じエンドポイントIDが得られます。
起動
起動時に、デバイスは指定された認証情報を使用してWiFiに接続しようとします。それがうまくいかない場合、デバイスはハングします。これは、irohエンドポイントの設定が行われる前に行われます。
実際の製品では、2つの代替WiFi設定と何らかのリカバリオプションが必要になるでしょうが、例ではこれを省略します。
ESP32上のエンドポイントが起動すると、非常によく見慣れた出力が得られます。
デバイスはルーターのDHCPによってローカルIPアドレス192.168.0.186:51831を割り当てられています。長短両方のチケットが出力されますが、現時点ではIPアドレスを含む長いチケットを使用してローカルでのみ到達可能です。
次に、QADを使用して、世界での位置を特定しようとします。
インターネットに接続されていると仮定すると、しばらくすると、最も近いリレーを特定し、それをホームリレーとして設定します。
この時点で、エンドポイントIDのみを含む短いチケットを使用して、世界中のどこからでも到達可能になります。
接続
それでは、クライアントバイナリを使用して試してみましょう。
ローカルでは長いチケットを使用してリレーをバイパスできますが、エンドポイントがホームリレーを公開するとすぐに、グローバルに到達可能になります。
クライアントにはリレーを無効にするオプションがあります。これを無効にすると、長いチケットしか使用できなくなります。
mDNS用のオプションもありますが、このプロジェクトではmDNSは使用しません。
シャットダウン
cargo run --releaseを停止するとバイナリが停止すると考えるかもしれませんが、そうではありません。それは単にデバイスへの接続を停止するだけです。エンドポイントは、電源がある限り喜んで実行を続けます。
接続を解除して別のUSB-C電源に接続しても、同じエンドポイントIDで再度起動します。これがポイントです。ESP32は完全に自己完結型の組み込みコンピューターです。電源さえあれば動作します。
本当にシャットダウンしたい場合は、電源を抜くか、espflash erase-flashを使用してフラッシュを消去してください。
センサーの追加
これで例が動作することを確認できたので、実際に何かをさせる作業を開始できます。
スマートファンを構築したいので、まず必要なのは温度センサーです。DHT22温度・湿度センサーを使用します。
[画像: DHT22温度・湿度センサー]
A DHT22 temperature and humidity sensor. Photo by L293D, CC BY-SA 4.0, via Wikimedia Commons.
センサーの配線は非常に簡単です。3本のワイヤーがあり、2本は+3.3V (5Vは使用しないでください!) とGND、1本はデータ用です。
ESP32 dev kitに拡張ボードとブレッドボードを使用する場合、USBポートからブレッドボードのレールに+3.3Vと+5Vを供給します。外部電源なしでは約100mAしか引き出せませんが、DHT22には十分です。DHT22は測定中にわずか1.5mA、アイドル時にはさらに少ない電流しか消費しません。
中央のワイヤーをESP32の多数のGPIOポートのいずれかに接続する必要があります。GPIO 26を選択しますが、ほとんどのGPIOを使用できます。一部のGPIOは起動中に特別な機能を持っていますが、GPIO26はそうではありません。
センサーをテストするためだけに、トレースを使用してセンサーの読み取り値を出力します。
実行
トラブルシューティング:
+3.3VとGNDの配線が正しいことを確認してください。間違っていると、センサーが熱くなり、煙が出る前に数秒間しか対応できないことに気づくでしょう。
DHT22は、信号線をGPIO 26に直接接続しても動作するはずです。しかし、頻繁にタイムアウトが発生する場合は、GPIOを+3.3Vレールに接続する3.3kΩのプルアップ抵抗を追加してみてください。
+5Vレールには接続しないでください!
間違いを恐れないでください。DHT22もESP32も、迅速に修正すれば配線ミスに対して非常に頑丈で寛容です!
プロトコルの追加
この時点で、エコープロトコルとローカルセンサー読み取りをサポートするirohエンドポイントができました。当然、センサーをリモートで読み取りたいとも思います。
そのためにirpcを使用します。もし単一のセンサーを読み取るだけなら、これは過剰でしょう。しかし、irpcを使用することで、将来的にプロトコルを拡張するのが容易になります。
プロトコルクレート
クライアントとESP32の両方で使用するため、プロトコルは別のクレートsmart-fan-protoで定義します。
最初のRPC呼び出しは、現在のセンサー値の読み取りだけになります。今のところ、これは温度と湿度だけですが、将来的にはもっと増える可能性があります。そのため、センサー状態構造体を使用します。
以下が完全なプロトコル定義です。
サーバーサイド
サーバーサイドでは、ミューテックスに現在のセンサー状態を保持する構造体があります。
クライアントサイド
将来的にさらに追加しますが、今のところクライアントサイドは単一の読み取りを行います。
シンプルなものはまだ可能か?
エンドポイントが稼働していることを確認する簡単な方法がまだ欲しいかもしれません。もちろん、irpcプロトコルにダミーのエンドポイントを追加することもできますが、エコープロトコルを引き続きサポートすることもできます。
ルーターを使用すると、好きなだけ多くのプロトコルを組み合わせることができます!
本格的なGUI
CLIツールはデバッグには便利ですが、本当に欲しいのは温度を表示し、最終的にはファンを制御するためのGUIです。dioxusを使用してネイティブGUIを作成し、すべての主要プラットフォームで動作させることもできます。しかし、これのためにアプリをインストールしたい人がいるでしょうか?そこで、ブラウザで動作するWASM GUIを作成しましょう。
私はJavaScript開発者ではないので、WASM GUIは感覚で作りました。軽くチェックしただけです。
この最初のバージョンは単なるリモート温度計です。デバイスからチケットを貼り付けると、リレー経由で温度と湿度をライブで確認できます。
GUIを実行するには、smart-fan-wasmに移動し、npm run build; npm run serveを実行して、http://localhost:8080でGUIを開きます。しかし、そうする必要はありません!このブログ記事のGUIはライブなので、チケットを貼り付けるだけで試すことができます。
アクチュエーターの追加
この時点で、リモートでアクセス可能な温度・湿度計ができました。しかし、スマートファンが欲しいのです。そこで、出力を追加しましょう。5Vのデスクトップコンピューターファン、例えばNoctua NF-A14-5Vのようなものを使用します。これは+5VとGNDレールに接続され、ファンをオン/オフまたはスロットルするための単一のPWM制御ワイヤーを備えています。
そのようなファンがない場合でも、約330Ωの抵抗を持つLEDを配線したり、家庭用ファンを制御するためにリレーを配線したりすることもできます。ただし、実際のファンの方が楽しいです!
アクチュエーターは、単純なロジックで制御されます。温度がある値を超えたら、ファンをオンにします。ファンがオンオフを繰り返さないように、わずかな粘り強さを追加します。
次に、実際のピンを設定します。
ここまでは順調です。
この時点で、主要なコンポーネントが揃い、コミット履歴をきれいに保つのはやめました。
プロトコルの進化
開発中は、プロトコルを自由に、そしてクライアントとサーバーの両方が最新の状態であることを確認しながら変更できます。
新しい本番デプロイメントでは、これが新しいプロトコルであることを明確にするためにALPNを変更するだけです。
しかし、古いリモート温度計GUIを引き続き動作させたい場合はどうでしょうか?その場合、RPCプロトコルに新しいメソッドを追加するだけで、既存のメソッドはenumの同じ場所に同じ構造体で残すように注意する必要があります。irpcはpostcardを使用しており、JSONやProtobufとは異なり、postcardは自己記述的であるための試みを一切行いません。書き込まれたものとは異なる構造体を読み込もうとすると、失敗するか、奇妙な結果になるだけです。
ALPNを変更せずにプロトコルを進化させるには、プロトコルenumの末尾に新しいRPCメソッドを追加します。そうすれば、ALPNを維持でき、古いGUIバージョンは引き続き動作します。
より原則的なスキーマ進化のアプローチとしてirpc-schemaがありますが、それは別のブログ記事の主題となるでしょう。
そこで、新しい互換性のあるスキーマenumは次のようになります。
読み取り専用GUIはGetStatusのみを使用します。温度、湿度、ファンの動作状況を表示しますが、何も変更できないため、公開しても安全です。これは上記の温度計と同じページですが、新しいプロトコルと通信しています。
ファンの閾値制御
これで、ファンが動作し始める閾値を設定する機能が必要になりました。しかし、スマートファンのGUIを公開ウェブサイトでホストする能力も維持したいと考えています。エンドポイントIDが秘密であることを頼ることもできますが、それは良い考えではありません。ディスカバリを使用する場合、データはdns.iroh.link上のエンドポイントIDに対して公開されます。また、ファンの状態の読み取り専用ビューを共有する能力を保持したい場合もあります。
そこで、RPCプロトコルに閾値を設定する呼び出しを追加しますが、認証を追加します。コードに組み込まれたシンプルな秘密鍵を使用し、それを新しいRPC呼び出しでのみ使用します。
追加されたRPCメソッド
GUIの追加
新しいGUIでは、現在の閾値を表示し、それを変更するために使用できるスライダーを追加するだけです。
これは、WebAssemblyとしてブラウザでライブ実行されています。デバイスからのチケットを貼り付けて接続し、オプションでそのFAN_API_SECRETを入力して閾値スライダーをロック解除します。
実用化
これまでは、ESP32、LEDまたはファン、DHT22センサーが配線されたブレッドボードを用意しました。多くの場合、このようなプロジェクトはここで終わります。動作を確認し、数日間デスクに置いておき、次の楽しいプロジェクトのために部品が必要になったり、片付けたいので分解したりします。
今回は、部品を実用的なウィジェットに組み立てたいと思いました。そこで、ファンとブレッドボードを収容するエンクロージャーを設計しました。
[画像: Bambu Studioでプリンターベッドにロードされたエンクロージャーモデル]
The enclosure in Bambu Studio. Download the STL.
はんだ付けされたプロトタイプボードやカスタムPCBの使用は気にしませんでした。以下が最終結果です。
[画像: 完成したスマートファン:3Dプリントされたハウジングに入ったNoctua NF-A14 5V PWMファン、センサー用の通気口があり、木製の床の上に立っている]
The finished fan: a Noctua NF-A14 in the printed housing, with an opening for the DHT22.
[画像: 3Dプリントされたエンクロージャーのベースに取り付けられたブレッドボード上のESP32 devkit、DHT22センサーと外部アンテナに配線されている]
The electronics — ESP32 on a breadboard, DHT22 sensor and fan connected — glued into the base.
予備があったのでESP32-S3を使用し、配線を簡素化するためにGPIOピンも変更しました。ESP32-S3では、ブレッドボードの片側しかアクセスできません。
外側には読み取り専用Web UIを開くQRコードを、内側には温度閾値制御用の秘密鍵を開くWeb UIを開くQRコードを配置しました。
QRコードはぼかされていますが、デコンボリューションアルゴリズムで元の画像を復元できれば、エンドポイントIDを変更するまで私のファンを制御できます。
試してみる
この記事の完全なコードはiroh-smart-fanで見つけることができます。3Dプリント可能なエンクロージャーはcase.stlとして利用可能です。
他に何ができるか
ESP32でそのまま動作する、さまざまな入力および出力デバイスがあります。入力としては、単純な温度・光センサーから、高精度のCO2・VOCセンサー、加速度計、GPS、マイク、さらには各種カメラまで、あらゆるものがあります。ESP32はGPIOをアナログ-デジタルコンバーターとして設定できるため、ポテンショメーター、フォトレジスター、スイッチのような単純なアナログセンサーを簡単に使用できます。
ESP32には強力な組み込みセンサーセットも搭載されています。WiFi信号に関する多くの詳細情報を取得できるためです。外部センサーなしで、WiFiスキャナーや完全な姿勢推定さえも実行できます。
出力としては、LEDからディスプレイまで、あらゆるものがあります。便利なトリックの1つは、通常のRCサーボを+5VバスとGPIO(PWM出力として設定)から直接駆動することです。より大きな負荷を駆動したい場合は、GPIO出力信号を増幅するためにトランジスタまたはMOSFETを使用するか、PWM互換のソリッドステートリレーを使用して家庭用電化製品を駆動できます(自己責任で!)。
私は電子機器の専門家ではありませんでしたが、ESP32に配線するのはレゴのようなもので、非常に簡単です。また、ESP32は小さな配線ミスに対しても非常に寛容です。
これはローカルファーストか?
長いチケットとローカルLANを使用する場合、はい。既存のリレーを使用する場合、クラウドに小さなコンポーネントが存在します。しかし、それは完全にアプリケーションに依存しない、オープンソースの汎用コンポーネントです。公開リレーを使用して試すことも、本番デプロイメント用にホストされたリレーを使用することも、あるいは複数の地域でリレーを運用する複雑さを気にせず、深夜の電話に怯えないのであれば、セルフホストすることもできます。
商用プロジェクトで特別な要件がある場合は、私たちに相談してください。
Irohは、デバイス間通信を容易にするネットワークライブラリです。既製のプロトコルのエコシステムから必要な機能を選択して構成することも、クリーンな抽象化の上に完全にカスタムなものを作成することもできます。Irohはオープンソースであり、すでに何十万ものデバイスで本番稼働しています。
開始するには、ドキュメントをご覧ください。コードに直接飛び込むか、Discordチャンネルで私たちとチャットしてください。