Skip to main content

XIAO ESP32シリーズでのMatter開発

tip

この記事は、Seeed Studio XIAO ESP32開発Matterシリーズの第3回チュートリアルです。前回のチュートリアルをまだ読んでいない場合は、デバイスが要求通りに設定されていることを確認するために、まず前回のチュートリアルを読むことをお勧めします。

急速に進化するモノのインターネット（IoT）の世界において、スマートホームデバイス同士の通信と相互作用の方法を革命的に変える新しいプレイヤーが登場しました。Matterをご紹介します。これは、さまざまなスマートホームエコシステム間のギャップを埋め、世界中のユーザーにシームレスで相互運用可能な体験を提供することを約束する統一プロトコルです。

では、Matterとは一体何で、なぜIoTコミュニティでこれほど多くの興奮を生み出しているのでしょうか？Matterは、異なるメーカーのスマートホームデバイスが努力なく連携できるようにするオープンソースの標準化されたプロトコルです。通信のための共通言語とフレームワークを提供することで、IoTデバイスの開発と展開を簡素化することを目的としています。

  • スマートホームデバイス用の通信プロトコル。
  • 2022年10月4日に1.0バージョンがリリース（2回延期された後）。
  • 標準化されたコマンドセットにより、異なるメーカーのデバイス同士が通信可能。
  • Thread、Wi-Fi、またはEthernetを使用してIPネットワーク上で動作。
  • Security by DesignとZero-Trustを使用。
  • ローカルで動作 – 通常はMatterハブを介してクラウドに接続。
  • Zigbee、Z-Wave、433MHzなどの他のスマートホーム標準と共存。
  • バッテリー寿命と範囲は無線ネットワーク技術に依存。
  • Matterハブによって調整される。

Matterの価値提案は明確です：より接続された、ユーザーフレンドリーで安全なスマートホーム体験への道を提供します。Matterを採用することで、デバイスメーカーは自社製品がAmazon Alexa、Google Home、Apple HomeKitなどの幅広いスマートホームプラットフォームやアシスタントと互換性があることを保証できます。この相互運用性は消費者に利益をもたらすだけでなく、IoT分野の開発者や企業にとって新しい機会も開きます。

開発者としてMatterを採用することは、デバイスとサービスの広大なエコシステムを活用することを意味し、既存のスマートホームセットアップとシームレスに統合できる革新的なソリューションを作成できます。Matterの力を活用することで、デバイス通信と互換性の複雑さを心配することなく、魅力的なユーザー体験と機能の構築に集中できます。

Matter開発の旅を始めるには、適切なツールと環境が必要です。このチュートリアルでは、IoTアプリケーション専用に設計されたコンパクトで強力なボードであるSeeed Studio XIAO ESP32C6を使用してMatter開発環境をセットアップするプロセスをガイドします。ESP32-C6マイクロコントローラーと豊富な周辺インターフェースを備えたXIAO ESP32C6は、Matter互換デバイスの開発に理想的な選択肢です。

以下のセクションでは、必要なソフトウェアのインストール、Seeed Studio XIAO ESP32C6ボードのセットアップ、最初のMatterサンプルプログラムの実行など、Matter開発環境を設定する手順を説明します。このチュートリアルの終わりまでに、独自のMatterデバイスの構築を開始し、相互運用可能なスマートホームソリューションの成長するエコシステムに貢献するための堅実な基盤を持つことになります。

それでは、Seeed Studio XIAO ESP32C6でMatter開発の可能性を解き放ちましょう！

ソフトウェアの準備​

以下に、この記事で使用するシステムバージョン、ESP-IDFバージョン、およびESP-Matterバージョンを参考として一覧表示します。これは正常に動作することがテストされた安定版です。

ハードウェアの準備​

このセクションでは、Ubuntu環境でESP-IDFの使用を設定し、ESP-IDFが提供する照明例を実行する方法を詳しく説明します。そのため、この記事では以下のXIAO ESP32シリーズのいずれかを準備するだけで十分です。

XIAO ESP32C3XIAO ESP32S3XIAO ESP32C6
Get One Now 🖱️
Get One Now 🖱️
Get One Now 🖱️

XIAOに加えて、WS281xモデルのライトバーまたはライトビーズも必要です。現在Espressifが提供しているライトの例は単一のビーズのみをサポートしているため、ストリップまたはビーズのどちらを使用しても、1つのライトのみが点灯します。配線を簡単にするために、Grove Base for XIAOの購入もお勧めします。

Grove Base for XIAOGrove - RGB LED Ring (20 - WS2813 Mini)
Get One Now 🖱️
Get One Now 🖱️

インターフェースを統一するため、この例では D9 ピンを使用します。LEDストリップまたはビーズをXIAOの D9 ピンに接続してください。

ビデオチュートリアル​

ESP-Matter のステップバイステップインストール​

tip

Matter の環境インストールを開始する前に、ESP-IDFプログラミング環境がインストールされ、アクセス可能であることを確認してください。

ステップ1. 依存関係のインストール​

まず、apt-get を使用して必要なパッケージをインストールする必要があります。ターミナルを開いて、以下のコマンドを実行してください：

sudo apt-get install git gcc g++ pkg-config libssl-dev libdbus-1-dev \
     libglib2.0-dev libavahi-client-dev ninja-build python3-venv python3-dev \
     python3-pip unzip libgirepository1.0-dev libcairo2-dev libreadline-dev

このコマンドは、Matter SDKのビルドと実行に必要なgit、コンパイラ（gcc、g++）、ライブラリなどの様々なパッケージをインストールします。

ステップ2. ESP-Matterリポジトリのクローン​

git cloneコマンドを使用して、GitHubからesp-matterリポジトリをクローンします。depth 1を指定して最新のスナップショットのみを取得します：

cd ~/esp
git clone --depth 1 https://github.com/espressif/esp-matter.git

esp-matter ディレクトリに移動し、必要な Git サブモジュールを初期化します：

cd esp-matter
git submodule update --init --depth 1

connectedhomeip ディレクトリに移動し、特定のプラットフォーム用のサブモジュールを管理するPythonスクリプトを実行します：

cd ./connectedhomeip/connectedhomeip
./scripts/checkout_submodules.py --platform esp32 linux --shallow

このスクリプトは、ESP32とLinuxの両プラットフォームのサブモジュールを浅い方法（最新のコミットのみ）で更新します。

ステップ3. ESP-Matterをインストール​

esp-matterのルートディレクトリに戻り、インストールスクリプトを実行します：

cd ../..
./install.sh

このスクリプトは、ESP-Matter SDK固有の追加の依存関係をインストールします。

ステップ 4. 環境変数の設定​

export.sh スクリプトをソースして、開発に必要な環境変数を設定します：

source ./export.sh

このコマンドは、必要な環境パスと変数でシェルを設定します。

ステップ 5（オプション）。ESP-Matter 開発環境への迅速なアクセス​

提供されたエイリアスと環境変数設定を .bashrc ファイルに追加するには、以下の手順に従ってください。これにより、IDF と Matter 開発セットアップ間の簡単な切り替えが可能になり、より高速なビルドのために ccache が有効になります。

ターミナルを開き、テキストエディタを使用してホームディレクトリにある .bashrc ファイルを開きます。nano または任意のエディタを使用できます。例えば：

nano ~/.bashrc

.bashrc ファイルの最下部までスクロールし、以下の行を追加してください：

# Alias for setting up the ESP-Matter environment
alias get_matter='. ~/esp/esp-matter/export.sh'

# Enable ccache to speed up compilation
alias set_cache='export IDF_CCACHE_ENABLE=1'

行を追加した後、ファイルを保存してテキストエディタを終了します。nanoを使用している場合は、Ctrl+Oを押して保存し、Enterを押して確認してから、Ctrl+Xで終了できます。

変更を有効にするには、.bashrcファイルを再読み込みする必要があります。.bashrcファイルをソースするか、ターミナルを閉じて再度開くことで実行できます。.bashrcファイルをソースするには、以下のコマンドを使用します：

source ~/.bashrc

Now you can run get_matter and set_cache to set up or refresh the esp-matter environment in any terminal session.

get_matter
set_cache

lightサンプルの実行​

Matter環境が設定されたら、サンプルアプリケーションlightをコンパイルしてアップロードし、動作を確認できます。

ステップ1. プロジェクトのパラメータを設定する​

examples/lightディレクトリに移動します。

cd examples/light                # Navigate to the light example directory

以前のビルドファイルを削除するためのクリーン操作を実行します。

rm -rf build/                     # Clean previous build files

Set the target to ESP32-C6.

idf.py set-target esp32c6        # Set the build target to ESP32-C6

設定メニューに入り、必要な設定を行います。

idf.py menuconfig                # Enter the configuration menu

menuconfig内で、Channel for console oputputオプションを見つけて有効にする必要があります。通常、このオプションはComponent config -> ESP System Settingsの下にあります。

  1. 矢印キーを使用してオプションに移動します。
  2. SpaceまたはEnterを押してオプションを選択します：USB Serial/JTAG Controller。

異なるXIAOの場合、GPIOピン番号も更新する必要があります。このオプションはComponent config -> Board Support Package (generic) -> LEDsの下にあります。

  • XIAO ESP32C3の場合、D9のGPIOは9です。
  • XIAO ESP32S3の場合、D9のGPIOは8です。
  • XIAO ESP32C6の場合、D9のGPIOは20です。
  1. 矢印キーを使用してオプションに移動します。
  2. SpaceまたはEnterを押してGPIO番号を入力します。
  3. 必要なオプションを有効にした後、qを押してmenuconfigを終了し、yを押します。

ステップ2. サンプルアプリケーションのコンパイルとアップロード​

ビルドとフラッシュプロセスを続行します：

idf.py build                      # Build the project

コンパイルが正常に完了すると、以下の結果が表示されます。

その後、プログラムをアップロードできます。

idf.py -p /dev/ttyACM0 flash monitor  # Flash the firmware and monitor the output

/dev/ttyACM0を、実際のXIAO ESP32に対応するUSBデバイスファイルに置き換えてください（異なる場合）。

すべての指示に注意深く従い、次のステップに進む前に各ステップが正常に完了することを確認してください。エラーが発生した場合は、続行する前にそれらを解決する必要があります。

tip

Matterのファームウェアをフラッシュする過程で、権限がない状況に遭遇する可能性があります。この場合、以下のコマンドを使用してデバイスのポートに権限を与え、プログラムを再度アップロードしてください。デバイスが接続されたり再起動されたりすると、権限を再度与える必要がある場合があります。

sudo chmod 666 /dev/ttyACM0       # Grant permissions to the USB device file

/dev/ttyACM0 を、実際のXIAO ESP32に対応するUSBデバイスファイルに置き換えてください（異なる場合）。

おめでとうございます。ファームウェアの書き込みが成功した場合、モニターでターミナルにデバッグログの出力が表示されます。

次に、matterコマンドとchip-toolを使用してMatterデバイスを設定し、Matterデバイスのデバッグと確認を完了する方法を学習します。

ホスト制御とデバイスコミッショニング​

menuconfigでconsole oputput to USB SerialのChannelを設定しました。これは、USBインターフェースを使用してXIAOを制御し、ネットワークへの参加設定やその他のデバッグを行うためです。このステップは重要で、シリアルツールを使用してデバイスにコマンドを発行できるかどうかを決定します。

これらは、ケーブル経由で接続してデバイスを直接制御するコマンドで、通常matterで始まります。

一般的なコマンド​

  • BLEコマンド：BLEアドバタイズメントの開始と停止：
matter ble [start|stop|state]
  • Wi-Fiコマンド：Wi-Fiモードの設定と取得：
matter wifi mode [disable|ap|sta]
  • デバイス設定：デバイスの静的設定をダンプ：
matter config
  • ファクトリーリセット：
matter device factoryreset
  • オンボーディングコード：オンボーディングペアリングコードペイロードをダンプ：
matter onboardingcodes
  • 属性取得：（IDは16進数）：
matter esp attribute get <endpoint_id> <cluster_id> <attribute_id>
  • 例：on_off::on_off：
matter esp attribute get 0x1 0x6 0x0
  • 属性設定：（IDは16進数）：
matter esp attribute set <endpoint_id> <cluster_id> <attribute_id> <attribute value>
  • 例：on_off::on_off：
matter esp attribute set 0x1 0x6 0x0 1
  • 診断：
matter esp diagnostics mem-dump
  • Wi-Fi
matter esp wifi connect <ssid> <password>

使用方法​

ステップ1. Minicomのインストール​

Minicomは、Unix系オペレーティングシステム用のテキストベースのモデム制御およびターミナルエミュレーションプログラムです。Minicomをインストールすることで、XIAOにMatter制御コマンドを簡単に送信できます。UbuntuにMinicomをインストールするには、ターミナルを開いて以下のコマンドを入力します：

sudo apt update
sudo apt install minicom

このコマンドはパッケージリストを更新し、Minicomをインストールします。

ステップ2. ユーザー権限の設定​

ttyACM0などのシリアルポートに非rootユーザーがアクセスできるようにするには、ユーザーをdialoutグループに追加する必要があります。以下のコマンドで実行できます：

sudo usermod -a -G dialout $USER

$USER をあなたのユーザー名に置き換えるか、現在ログインしているユーザーに適用する場合は省略してください。このコマンドを実行した後、グループの変更を有効にするためにログアウトして再度ログインする必要があります。

ステップ 3. Minicom のセットアップ​

次に、ttyACM0 ポートを使用するように Minicom を設定する必要があります。以下のコマンドでセットアップモードで Minicom を実行してください：

sudo minicom -s

セットアップメニューで、以下の手順に従ってください：

  1. Serial port setupを選択します。
  2. 'A'を押してSerial Deviceを/dev/ttyACM0に変更します。
  3. 必要に応じて他の設定を調整します。デフォルト設定は通常9600 8N1（9600ボー、パリティなし、8データビット、1ストップビット）です。ボーレートを115200に変更するだけで済みます。
  4. 'Enter'を押してこの画面を終了します。

Step 4. 設定の保存​

シリアルポートの設定後：

  1. Save setup as dflを選択して、これをデフォルト設定にします。
  2. Exit from Minicomを選択してMinicomeセットアップを終了します。

Step 5: Minicomの実行​

デフォルト設定でMinicomを開始するには、次のように入力するだけです：

minicom

If you need to run it with sudo privileges (e.g., if you encounter permission issues), you can use:

sudo minicom

Minicomを終了するには、Ctrl-Aを押してからZを押してヘルプメニューを表示し、その後Xを押してプログラムを終了します。

ステップ6. XIAOの配信ネットワークの設定​

以下のコマンドを使用してXIAOをネットワークに接続します。ネットワークを選択する際は、XIAOは2.4Gネットワークのみをサポートし、5Gネットワークはサポートしていないことに注意してください。

matter esp wifi connect <ssid> <password>

正常にペアリングが完了した後、以下のコマンドを使用してMatterデバイスの非常に重要な情報を照会できます：VendorID、ProductId、Discriminator、およびPinCode。この情報は、Chip-toolツールでデバッグする際にデバイスをペアリングするのに役立ちます。

matter config

最後に、以下のコマンドを使用してオンボーディングペアリングコードペイロードをダンプします。

matter onboardingcodes onnetwork

ここで最後に表示されるのは、デバイスのペアリングQRコードへのリンクです。QRコードを使用して、Getting Startedの手順と同様に、携帯電話でコードをスキャンしてMatterデバイスをバインドできます。

Chip-toolを使用したMatterデバイスのリモートデバッグ​

Matterデバイスはスマートホームの重要な部分であり、デバッグとセットアップのために常にデータケーブルを使用するのは実用的ではありません。Matterデバッグツールの中で最も一般的に使用されるのはChip-toolで、デバイスが接続されているときにリモートでデバッグするのに役立ちます。

Chip-toolコマンドは通常Chip-toolスクリプトを必要とするため、通常はchip-toolで始まります。

IPを介したデバイスのペアリング​

以下のコマンドはデバイスを発見し、提供されたセットアップコードを使用して最初に発見されたデバイスとのペアリングを試行します：

chip-tool pairing onnetwork ${NODE_ID_TO_ASSIGN} 20202021

以下のコマンドは、長い識別子3840を持つデバイスを発見し、提供されたセットアップコードを使用して発見した最初のデバイスとのペアリングを試行します：

chip-tool pairing onnetwork-long ${NODE_ID_TO_ASSIGN} 20202021 3840

以下のコマンドは、指定されたQRコード（デバイスが起動時にログ出力するもの）に基づいてデバイスを検出し、最初に発見されたデバイスとのペアリングを試行します。

chip-tool pairing code ${NODE_ID_TO_ASSIGN} MT:#######

これらすべてのケースにおいて、デバイスには node id ${NODE_ID_TO_ASSIGN} が割り当てられます（これは10進数または0xプレフィックス付きの16進数である必要があります）。

現在コミッションされているデバイスを忘れる​

chip-tool pairing unpair

クライアントを使用してMatterコマンドを送信する​

クライアントを使用してMatterコマンドを送信するには、ビルドされた実行ファイルを実行し、ターゲットクラスター名、ターゲットコマンド名、およびエンドポイントIDを渡します。

エンドポイントIDは1から240の間である必要があります。

chip-tool onoff on 1

クライアントは単一のコマンドパケットを送信してから終了します。

使用方法​

Chip-toolでデバッグする準備ができたら、XIAOをコンピューターから切断し、電源に接続できます。

最初のステップとして、デバイスをペアリングする必要があります。これは上記のIPでデバイスをペアリングセクションのいずれかの方法を使用して行うことができます。

例えば、私は以下のコマンドを使用します。

chip-tool pairing onnetwork-long 0x12 20202021 3840

この場合、デバイスにはノードID 0x12（10進数または0xプレフィックス付きの16進数である必要があります）が割り当てられます。20202021はPinCodeで、3840はDiscriminatorです。

最後に、以下のコマンドでライトのオン/オフを制御できることを確認します。

ライトをオンにする：

chip-tool onoff on 0x12 0x1

ライトを消す：

chip-tool onoff off 0x12 0x1

0x12は、マッチング時にデバイスに割り当てられるノードIDです。

皆さん、おめでとうございます。ここで実行したチュートリアルの手順により、ESP-Matterの開発フレームワークの一般的な手順とデバッグツールの使用について、初歩的な理解を得られたと思います。まだ理解できない部分や慣れていない部分がある場合は、今後のチュートリアルで引き続き使用方法をガイドしていきますので、ご期待ください！

トラブルシューティング​

Q1: 環境のインストール中にさまざまなエラーが発生するのはなぜですか？​

ESP-Matterの環境は少し要求が厳しく、開発によく使用されるUbuntuホストを使用している場合、一部のPython依存関係のバージョンの違いによりエラーが発生する可能性があります。Matterフレームワークは Seeed によって開発されたものではないため、この部分の問題については私たちにできることはおそらくありません。そのため、インストールで問題が発生した場合は、公式の ESP-Matterリポジトリ にissueを提出してヘルプを求めることをお勧めします。

Q2: Matterの環境をアンインストールするにはどうすればよいですか？​

./install.sh スクリプトを実行してPython環境の設定ステップで止まってしまう場合は、あなたのMatterのバージョンがconnectedhomeipのバージョンと一致しているかを確認する必要があるかもしれません。

リセットする簡単な方法は、以下のコマンドを実行することです。

rm -r connectedhomeip/connectedhomeip/.environment

Then re-pull the appropriate version of the connectedhomeip branch again.

git submodule update --init --depth 1

それでも動作しない場合は、esp-matter フォルダ全体を削除し、Wiki の内容に従って再度実行してください。

リソース​

技術サポートと製品ディスカッション​

弊社製品をお選びいただき、ありがとうございます！弊社では、お客様の製品体験が可能な限りスムーズになるよう、さまざまなサポートを提供しています。異なる好みやニーズに対応するため、複数のコミュニケーションチャネルを用意しています。

Loading Comments...