Matter デバイスをペア設定する

Matter 対応デバイスをペア設定します。これを行うには、ペア設定用の QR コードが必要です。Matter デバイスのプラットフォームによっては、この QR コードを自分で生成する必要があります。

QR コードを取得する

Bouffalo Lab

BL602

デバイスの起動時に、シリアル コンソールに QR コード文字列が出力されます。 シリアル コンソールを確認すると、次のようなメッセージが表示されます。

Booting BL602 Chip...
██████╗ ██╗      ██████╗  ██████╗ ██████╗
██╔══██╗██║     ██╔════╝ ██╔═████╗╚════██╗
██████╔╝██║     ███████╗ ██║██╔██║ █████╔╝
██╔══██╗██║     ██╔═══██╗████╔╝██║██╔═══╝
██████╔╝███████╗╚██████╔╝╚██████╔╝███████╗
╚═════╝ ╚══════╝ ╚═════╝  ╚═════╝ ╚══════╝
...
[INFO] ==================================================
[INFO] chip-bl602-lighting-example starting
[INFO] ==================================================
...
[INFO] [SVR] SetupQRCode: [MT:NOTAREALQRCODE01234]
[INFO] [SVR] Copy/paste the below URL in a browser to see the QR Code:
[INFO] [SVR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%NOTAREALQRCODE01234
...

ウェブブラウザでリンクを開き、QR コードを表示します。

BL702

デバイスの起動時に、QR コード文字列がシリアル コンソールに出力されます。シリアル コンソールを確認すると、次のようなメッセージが表示されます。

[         0][-][PROGR] ==================================================
[         0][-][PROGR] bouffalolab chip-lighting-example, built at Dec 14 2022 02:05:19
[         0][-][PROGR] ==================================================
...
[      1636][-][PROGR] Starting OpenThread task
[      1655][DL][PROGR] Device Configuration:
[      1703][DL][PROGR]   Serial Number: TEST_SN
[      1703][DL][PROGR]   Vendor Id: 65521 (0xFFF1)
[      1703][DL][PROGR]   Product Id: 32773 (0x8005)
[      1752][DL][PROGR]   Hardware Version: 0
[      1799][DL][PROGR]   Setup Pin Code (0 for UNKNOWN/ERROR): 20202021
[      1846][DL][PROGR]   Setup Discriminator (0xFFFF for UNKNOWN/ERROR): 3840 (0xF00)
[      1893][DL][PROGR]   Manufacturing Date: (not set)
[      1893][DL][PROGR]   Device Type: 65535 (0xFFFF)
[      1987][SVR][PROGR] SetupQRCode: [MT:NOTAREALQRCODE01234]
[      1987][SVR][PROGR] Copy/paste the below URL in a browser to see the QR Code:
[      1988][SVR][PROGR] https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%NOTAREALQRCODE01234

      

Espressif

Getting the QR code differs for each type of ESP32-based kit:

ESP32 DevkitC

  1. Connect the device to a host machine and use a serial terminal to connect to it and display its logs. For example, on a Linux host machine, you might use screen /dev/ttyUSB0 115200 to connect to the device and view logs if it is attached to the host at /dev/ttyUSB0.
  2. A URL is displayed in the logs when the device is first booted. Open the link in a web browser to display the QR code.

M5Stack ESP32

When first booted, the device will display a QR code menu option. Select it to see the QR code in the device's display.

ESP32 WROVER Kit

The device shows the QR code immediately after booting.

Nordic Semiconductor

nRF52840

Since the nRF52840 board doesn't have a display, the QR code string is printed in the serial console when it boots up. For example:

I: 1317 [SVR]SetupQRCode:  [MT:I347HHY00 0C9SS0]
I: 1321 [SVR]Copy/paste the below URL in a browser to see the QR Code:
I: 1327 [SVR]https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%3AI347HHY00%200C9SS0

ウェブブラウザでリンクを開き、QR コードを表示します。

NXP

K32W

デバイスの起動時に、シリアル コンソールに QR コード文字列が出力されます。 シリアル コンソールを確認すると、次のようなメッセージが表示されます。

[Info]Welcome to NXP Lighting Demo App
[Info]OpenThread started: OK
...
[Info]Server Listening...
[Info]SetupQRCode:  [MT:I34DVDY00 0C9SS0]
[Info]Copy/paste the below URL in a browser to see the QR Code:
[Info]https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%3AI34DVDY00%200C9SS0
...

ウェブブラウザでリンクを開き、QR コードを表示します。

Realtek

アメバ D

QR コードは URL にエンコードされます。これは、Ameba D ボードの起動時にシリアル コンソールに出力されます。

Setup PIN code: 20202021 (0x1344225)
Short Manual(decimal) setup code: 34970112332
Long Manual(decimal) setup code:  749701123309050652796
QR CODE Text: 'MT:NOTAREALQRCODE01234'
Copy/paste the below URL in a browser to see the QR CODE:

https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%3ANOTAREALQRCODE01234

ウェブブラウザでリンクを開き、QR コードを表示します。

シリコンラボ

EFR32MG12

ボードが起動すると、小さな LCD ディスプレイに QR コードが表示されます。

TLSR9518

デバイスの起動時に、シリアル コンソールに QR コード文字列が出力されます。シリアル コンソールを確認します。ブラウザでこの QR コードを開いたときに、URL が表示されます。

*** Booting Zephyr OS build v3.1.0-rc1-3593-gdac17979d626  ***
I: Init CHIP stack
I: Starting CHIP task
…
I: 812 [DL]BLEManagerImpl::ConfigureAdvertisingData
I: 823 [DL]Setting device name to : "TelinkMatter"
…
I: 1093 [SVR]SetupQRCode: [MT:NOTAREALQRCODE01234]
I: 1099 [SVR]Copy/paste the below URL in a browser to see the QR Code:
I: 1107 [SVR]https://project-chip.github.io/connectedhomeip/qrcode.html?data=MT%3ANOTAREALQRCODE01234

デバイスをペア設定する

デバイスをペア設定するには、次の 2 つの方法があります。

  1. Google Home app (GHA)
  2. Android 用の Google Home Mobile SDK と Thread Network SDK(サードパーティ製アプリで利用可能)

どちらのメソッドも、同じ MatterThread のネットワーク API を使用します。

Google Home アプリ

  1. GHA を開きます。
  2. 左上の [] をタップします。
  3. [デバイスのセットアップ] をタップします。
  4. [新しいデバイス] をタップします。
  5. 家を選択して [次へ] をタップします。
  6. GHA がデバイスをスキャンします。デバイスをセットアップするかどうかを確認するメッセージが表示されたら、[別のデバイスをセットアップ] をタップします。
  7. デバイスの種類にかかわらず、[Matter 台のデバイス] をタップします。
  8. デバイスの QR コード(またはウェブサイトで生成された QR コード)にカメラを向けます。
  9. GHA フローに示されているとおりに、ペア設定プロセスを続行します。

モバイル デバイスで GHA とのペア設定中に問題が発生した場合は、以下の手順に沿って対応してください。

  1. モバイル デバイスで [開発者向けオプション] が有効になっていることを確認します。
  2. ペア設定に失敗した直後に、バグレポートをキャプチャします。

Android SDK

Android SDK を実装して、Matter デバイスをペア設定し、アプリで Thread ネットワークを管理する

Play services では、サードパーティ製アプリでのテストとペア設定に使用できる Android SDK が提供されています。

最初に Google Home Sample App for Matter を使用することをおすすめします。ここでは、これらの SDK を使用して、Google Home エコシステム内で Matter 対応デバイスのコミッショニング、ペア設定、操作を行う方法について説明しています。

どちらの SDK のリファレンス ドキュメントも次のサイトで入手できます。

ペア設定の制限

Matter デバイスは、特定のベンダー ID とデバイスタイプのシナリオでのみ、Google Home エコシステムでペア設定できます。

  • テスト用 VID は、一般ユーザー向けデバイスでは使用できません。
  • 製品版 VID は Connectivity Standards Alliance (Alliance) から発行されたものである必要があります。Google Home Developer Console で VID を使用するには、その VID の所有者であることを Google が検証します。その後、その VID の統合を作成できます。
  • 開発やフィールド トライアルで使用する場合は、対応する VID と PID の組み合わせのプロジェクトと統合を Developer Console に作成する必要があります。デバイスのコミッショニングを行うユーザーは、プロジェクトのメンバーであるか、フィールド トライアル ユーザーのリストに含まれている必要があります。
  • 一般ユーザーが利用できるプロダクトは、Alliance によって認定されたものに限られます。
表: ベンダー ID(VID)とデバイスタイプのペア設定のシナリオ
どのようなユーザーがデバイスを Google Home エコシステムにコミッショニングできますか?
VID タイプ VID の認定とコンソールの統合ステータス 本番環境
(一般ユーザー)
開発
(デベロッパー、フィールド トライアル ユーザー)
テスト Developer Console に統合なし(認定不可)
テスト 統合が Developer Console に存在します(認定できません)
本番環境 認定なし。統合は Developer Console に存在しません。
本番環境 認定なし。統合は Developer Console に存在します。
本番環境 Alliance DCL で認定済み。Developer Console には統合機能がない。
本番環境 Alliance DCL で認定済みで、Developer Console に統合されている

デバイス情報

ペア設定したデバイスの技術情報は、GHA で確認できます。

  1. GHA でデバイスを選択します。
  2. 右上にある アイコンをタップします。
  3. [技術情報] をタップします。

[メーカー]、[モデル]、[ハードウェア バージョン] などの識別子は、Developer Console ではなく、デバイスの Matter ファームウェアから取得されます。たとえば、Matter SDK のデバイス設定に含まれる CHIP_DEVICE_CONFIG_DEVICE_VENDOR_NAMECHIP_DEVICE_CONFIG_DEVICE_PRODUCT_NAME の値などです。

これらの識別子は、テストのためにペア設定されているデバイスを検証する場合に役立ちます。特に、テストのベンダー ID とプロダクト ID(統合間で複製可能)を使用する場合に有効です。

ペア設定のトラブルシューティング

テスト用のベンダー ID(VID)とプロダクト ID(PID)でデバイスをペア設定していても、Developer Consoleテストスイートを使用してデバイスをテストしようとしても表示されない場合は、複数の統合で同じテスト VID と PID の組み合わせを使用している可能性があります。

トラブルシューティングするには、Developer Console からすべてのテストデバイスを削除し、もう一度テストするデバイスをペア設定します。

正しいデバイスとペア設定されていることを確認するには、デバイスのメーカーとモデルの情報(CHIP_DEVICE_CONFIG_DEVICE_* 値)をテスト ファームウェア内の一意の値に設定します。

詳しくは、デバイス情報をご覧ください。