翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

AWS.DiscoverDevices オペレーションを実装する

デバイス検出は、エンドユーザーが所有する物理デバイスのリストを、 Managed Integrations for で管理されているエンドユーザーデバイスのデジタル表現に合わせます AWS IoT Device Management。これは、エンドユーザーが所有するデバイスで AWS 顧客が実行します。OAuth 2.0 の場合、これはアカウントのリンクが完了した後に発生します。一般認可の場合、これはアカウントの関連付けの作成後に発生する可能性があります。

デバイス検出は、 の AWS IoT Device Management Managed Integrations がコネクタを呼び出してデバイス検出リクエストを開始する非同期プロセスです。C2C コネクタは、Managed Integrations によって生成された参照識別子 ( と呼ばれるdeviceDiscoveryId) を使用して、検出されたエンドユーザーデバイスのリストを非同期的に返します AWS IoT Device Management。

AWS.DiscoverDevices のワークフロー

次の図は、エンドユーザーと マネージド統合間のデバイス検出ワークフローを示しています AWS IoT Device Management。

ワークフローのステップ

Device Discovery の C2C コネクタ要件

次のリストは、デバイス検出を成功させるための C2C コネクタの要件の概要を示しています。

デバイス検出プロセス

ステップ 1: マネージドインテグレーションがデバイス検出をトリガーする

認可タイプに応じて、次のいずれかの JSON ペイロードDiscoverDevicesを使用して POST リクエストを に送信します。

OAuth 2.0 リクエスト:

/DiscoverDevices
{
   "header": {
        "auth": {                 
            "token": "ashriu32yr97feqy7afsaf",  
            "type": "OAuth2.0"
        }
   },
   "payload": {
        "operationName": "AWS.DiscoverDevices",
        "operationVersion": "1.0",
        "connectorId": "Your-Connector-Id",
        "deviceDiscoveryId": "12345678",
        "connectorDeviceIdList": []
   }
}

一般的な認可リクエスト:

/DiscoverDevices
{
   "header": {
        "auth": {
            "secretsManager": {
                "arn": "string",
                "versionId": "string"
            },
            "type": "GeneralAuthorization"
        }
   },
   "payload": {
        "operationName": "AWS.DiscoverDevices",
        "operationVersion": "1.0",
        "connectorId": "Your-Connector-Id",
        "deviceDiscoveryId": "12345678",
        "connectorDeviceIdList": []
   }
}

一般的な認可リクエスト:

/DiscoverDevices
{
   "header": {
        "auth": {
            "secretsManager": {
                "arn": "string",
                "versionId": "string"
            },
            "type": "GeneralAuthorization"
        }
   },
   "payload": {
        "operationName": "AWS.DiscoverDevices",
        "operationVersion": "1.0",
        "connectorId": "Your-Connector-Id",
        "deviceDiscoveryId": "12345678",
        "connectorDeviceIdList": []
   }
}

ステップ 2: コネクタが検出を承認する

コネクタは、次の JSON レスポンスで確認を送信します。

{
     "header": {
          "responseCode":200
     },
     "payload": {
          "responseMessage": "Discovering devices for discovery-job-id '12345678' with connector-id `Your-Connector-Id`"
     }
}

ステップ 3: コネクタがデバイス検出イベントを送信する

次の JSON ペイロード/connector-event/{your_connector_id}を使用して POST リクエストを に送信します。

AWS API - /SendConnectorEvent
URI – POST /connector-event/{your_connector_id}
{
   "UserId": "6109342",
   "Operation": "DEVICE_DISCOVERY",
   "OperationVersion": "1.0",
   "StatusCode": 200,
   "DeviceDiscoveryId": "12345678",
   "ConnectorId": "Your_connector_Id",
   "Message": "Device discovery for discovery-job-id '12345678' successful",
   "Devices": [
        {
            "ConnectorDeviceId": "Your_Device_Id_1",
            "ConnectorDeviceName": "Your-Device-Name",
            "CapabilityReport": {
 	      		"nodeId":"1",
 			"version":"1.0.0",
  			"endpoints":[{
 				"id":"1",
 				"deviceTypes":["Camera"],
 				"clusters":[{
 					"id":"0x0006",
 					"revision":1,
 					"attributes":[{
 						"id":"0x0000",
 					}],
 					"commands":["0x00","0x01"],
 					"events":["0x00"]
 				}]
 			}]
 		}
        }
    ]
}

検出されたデバイスのブランドとモデルを入力する

C2C コネクタは、オプションでDEVICE_DISCOVERYイベント内の各デバイスのDeviceMetadataオブジェクトを含めて、デバイスのブランドとモデルをレポートできます。これらの値は、ListDiscoveredDevices レスポンスと ListManagedThings レスポンスで返されます。

各デバイスエントリとマップにDeviceMetadataオブジェクトを含めます。

次の例は、 DeviceMetadataを含むデバイスエントリを示しています。

{
    "ConnectorDeviceId": "Your_Device_Id_1",
    "ConnectorDeviceName": "Your-Device-Name",
    "CapabilityReport": { ... },
    "DeviceMetadata": {
        "Brand": "ExampleBrand",
        "Model": "ExampleModel-X1"
    }
}

どちらのキーも大文字と小文字を区別する文字列です。を省略するかDeviceMetadata、個々のキーを省略するか、文字列以外の値を指定すると、デバイスの取得時に対応するフィールドは使用できません。

DISCOVER_DEVICES イベントの CapabilityReport を作成する

上記のイベント構造に示すように、 DISCOVER_DEVICES イベントで報告されたすべてのデバイスは、AWS.DiscoverDevicesオペレーションへの応答として機能し、対応するデバイスの機能を記述するために CapbilityReport が必要です。CapabilityReport」は、AWS IoT Device Management デバイス機能のマネージド統合を Matter 準拠の形式で指示します。

CapabilityReport の必須フィールド

サポートされている機能の現在のリストと AWS Matter Data Model の対応する実装については、Data Model ドキュメントの最新リリースを参照してください。