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

# デバイスをオンボードして運用するためのユーザーガイドのセットアップ
<a name="managedintegrations-sdk-v2-cookbook-ugs"></a>

デバイスをハブに接続するマネージド型モノを作成して、マネージド型統合ハブにオンボードするようにデバイスをセットアップします。このセクションでは、ユーザーガイドの設定を使用してデバイスのオンボーディングプロセスを完了する手順について説明します。

## 前提条件
<a name="managedintegrations-sdk-v2-cookbook-ugs-prereq"></a>

デバイスのオンボードを試みる前に、以下の手順を実行します。
+ ハブデバイスをマネージド統合ハブにオンボードします。
+ Managed Integrations コマンドリファレンス AWS CLI から最新バージョンの をインストールする [AWS CLI](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/)
+ [DEVICE\$1DISCOVERY-STATUS](managedintegrations-notifications.md#managedintegrations-notification-setup) イベント通知をサブスクライブします。

**Topics**
+ [前提条件](#managedintegrations-sdk-v2-cookbook-ugs-prereq)
+ [前提条件: Z Wave デバイスでペアリングモードを有効にする](#managedintegrations-sdk-v2-cookbook-pairing-mode)
+ [ステップ 1: デバイス検出を開始する](#managedintegrations-sdk-v2-cookbook-device-discovery)
+ [ステップ 2: 検出ジョブ ID をクエリする](#managedintegrations-sdk-v2-cookbook-query-discovery)
+ [ステップ 3: デバイスのマネージドモノを作成する](#managedintegrations-sdk-v2-cookbook-ugs-managed-thing)
+ [ステップ 4: マネージドモノをクエリする](#managedintegrations-sdk-v2-cookbook-query-managed-thing)
+ [ステップ 5: マネージド型のモノの機能を取得する](#managedintegrations-sdk-v2-cookbook-check-device-capabilties)
+ [ステップ 6: マネージドモノにコマンドを送信する](#managedintegrations-sdk-v2-cookbook-ugs-control-device)
+ [ステップ 7: マネージドモノの状態を確認する](#managedintegrations-sdk-v2-cookbook-ugs-device-state)
+ [ステップ 8: ハブからマネージド型モノを削除する](#managedintegrations-sdk-v2-cookbook-ugs-clean-up)

## 前提条件: Z Wave デバイスでペアリングモードを有効にする
<a name="managedintegrations-sdk-v2-cookbook-pairing-mode"></a>

Z 波デバイスでペアリングモードを有効にします。ペアリングモードは Z-Wave デバイスごとに異なる可能性があるため、デバイスの手順を参照してペアリングモードを適切に設定してください。これは通常、ユーザーが押さなければならないボタンです。

## ステップ 1: デバイス検出を開始する
<a name="managedintegrations-sdk-v2-cookbook-device-discovery"></a>

ハブのデバイス検出を開始して、デバイスのオンボードに使用される検出ジョブ ID を取得します。

**デバイス検出を開始するには**
+ [start-device-discovery](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/start-device-discovery.html) コマンドを使用して、検出ジョブ ID を取得します。

  **start-device-discovery 例**

  ```
  #For Zigbee
    aws iot-managed-integrations start-device-discovery --discovery-type ZIGBEE \
    --controller-identifier HUB_MANAGED_THING_ID
    
    #For Zwave
    aws iot-managed-integrations start-device-discovery --discovery-type ZWAVE \
    --controller-identifier HUB_MANAGED_THING \
    --authentication-material-type ZWAVE_INSTALL_CODE \
    --authentication-material 13333
    
    #For Cloud
    aws iot-managed-integrations start-device-discovery --discovery-type CLOUD \
    --account-association-id C2C_ASSOCIATION_ID \
    
    #For Custom
    aws iot-managed-thing start-device-discovery --discovery-type CUSTOM \
    --controller-identifier HUB_MANAGED_THING_ID \
    --custom-protocol-detail NAME : NON_EMPTY_STRING \
  ```

  **レスポンス**:

  ```
  {
        "Id": DISCOVERY_JOB_ID,
        "StartedAt": "2025-06-03T14:43:12.726000-07:00"
    }
  ```
**注記**  
Z ウェーブデバイスと Zigbee デバイスには個別のコマンドがあります。

  詳細については、「 マネージド AWS CLI *integrationsCommand リファレンス*」の[start-device-discovery](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/start-device-discovery.html) API」を参照してください。

## ステップ 2: 検出ジョブ ID をクエリする
<a name="managedintegrations-sdk-v2-cookbook-query-discovery"></a>

`list-discovered-devices` コマンドを使用して、デバイスの認証マテリアルを取得します。

**検出ジョブ ID をクエリするには**
+ list-discovered-devices コマンドで検出ジョブ ID を使用して、デバイスの認証マテリアルを取得します。

  ```
  aws iot-managed-integrations list-discovered-devices --identifier DISCOVERY_JOB_ID
  ```

**レスポンス**:

```
"Items": [
    {
        "DeviceTypes": [],
        "DiscoveredAt": "2025-06-03T14:43:37.619000-07:00",
        "AuthenticationMaterial": AUTHENTICATION_MATERIAL
    }
]
```

## ステップ 3: デバイスのマネージドモノを作成する
<a name="managedintegrations-sdk-v2-cookbook-ugs-managed-thing"></a>

`create-managed-thing` コマンドを使用して、デバイスのマネージド型モノを作成します。各デバイスには、独自のマネージド型モノが必要です。

**マネージド型モノを作成するには**
+ `create-managed-thing` コマンドを使用して、デバイスのマネージド型モノを作成します。

  **create-managed-thing 例**

  ```
  aws iot-managed-integrations create-managed-thing \
    --role  DEVICE --authentication-material-type DISCOVERED_DEVICE \
    --authentication-material "AUTHENTICATION_MATERIAL"
  ```

  **レスポンス**:

  ```
  {    
      "Id": "DEVICE_MANAGED_THING_ID"
      "Arn": "arn:aws:iotmanagedintegrations:AWS_REGION:AWS_ACCOUNT_ID:managed-thing/DEVICE_MANAGED_THING_ID"
      "CreatedAt": "2025-06-09T13:58:52.977000+08:00"
    }
  ```

  詳細については、[create-managed-thing](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/create-managed-thing.html) *コマンド* AWS CLI 」を参照してください。

## ステップ 4: マネージドモノをクエリする
<a name="managedintegrations-sdk-v2-cookbook-query-managed-thing"></a>

コマンドを使用して、マネージド型モノがアクティブ化されているかどうかを確認できます`get-managed-thing`。

**マネージドモノをクエリするには**
+ `get-managed-thing` コマンドを使用して、マネージドモノのプロビジョニングステータスが に設定されているかどうかを確認します`ACTIVATED`。プロビジョニングステータスの詳細については、[「デバイスプロビジョニング](https://docs.aws.amazon.com/iot-mi/latest/devguide/device-provisioning.html)」を参照してください。

  **get-managed-thing 例**

  ```
  aws iot-managed-integrations get-managed-thing \
    --identifier "DEVICE_MANAGED_THING_ID"
  ```

  **レスポンス**:

  ```
  {
        "Id": "DEVICE_MANAGED_THING_ID",
        "Arn": "arn:aws:iotmanagedintegrations:AWS_REGION:AWS_ACCOUNT_ID:managed-thing/DEVICE_MANAGED_THING_ID,
        "Role": "DEVICE",
        "ProvisioningStatus": "ACTIVATED",
        "MacAddress": "MAC_ADDRESS",
        "ParentControllerId": "PARENT_CONTROLLER_ID",
        "CreatedAt": "2025-06-03T14:46:35.149000-07:00",
        "UpdatedAt": "2025-06-03T14:46:37.500000-07:00",
        "Tags": {}
    }
  ```

  詳細については、[get-managed-thing](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/get-managed-thing.html) *コマンド* AWS CLI 」を参照してください。

## ステップ 5: マネージド型のモノの機能を取得する
<a name="managedintegrations-sdk-v2-cookbook-check-device-capabilties"></a>

を使用して、マネージドモノの使用可能なアクションのリストを表示できます`get-managed-thing-capabiltiies`。

**デバイスの機能を取得するには**
+ `get-managed-thing-capabilities` コマンドを使用してエンドポイント ID を取得します。また、可能なアクションのリストも書き留めます。

  **get-managed-thing-capabilities 例**

  ```
  aws iot-managed-integrations get-managed-thing-capabilities \
    --identifier "DEVICE_MANAGED_THING_ID"
  ```

  **レスポンス**:

  ```
  {
        "ManagedThingId": "DEVICE_MANAGED_THING_ID",
        "CapabilityReport": {
            "version": "1.0.0",
            "nodeId": "zb.539D+4A1D",
            "endpoints": [
                {
                    "id": "1",
                    "deviceTypes": [
                        "Unknown Device"
                    ],
                    "capabilities": [
                        {
                            "id": "matter.OnOff@1.4",
                            "name": "On/Off",
                            "version": "6",
                            "properties": [
                                "OnOff",
                                "OnOff",
                                "OnTime",
                                "OffWaitTime"
                            ],
                            "actions": [
                                "Off",
                                "On",
                                "Toggle",
                                "OffWithEffect",
                                "OnWithRecallGlobalScene",
                                "OnWithTimedOff"
                            ],
                            ...
    }
  ```

  詳細については、「 [get-managed-thing-capabilities](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/get-managed-thing-capabilities.html) AWS CLI**」コマンドを参照してください。

## ステップ 6: マネージドモノにコマンドを送信する
<a name="managedintegrations-sdk-v2-cookbook-ugs-control-device"></a>

send-managed-thing-command コマンドを使用して、トグルアクションコマンドをマネージドモノに送信できます。

**トグルアクションを使用して、マネージドモノにコマンドを送信します。**
+ `send-managed-thing-command` コマンドを使用して、トグルアクションコマンドを送信します。

  **send-managed-thing-command 例**

  ```
  json=$(jq -cr '.|@json') <<EOF
    [
      {
        "endpointId": "1",
        "capabilities": [
          {
            "id": "matter.OnOff@1.4",
            "name": "On/Off",
            "version": "1",
            "actions": [
              {
                "name": "Toggle",
                "parameters": {}
              }
            ]
          }
        ]
      }
    ]
    EOF
    aws iot-managed-integrations send-managed-thing-command \
    --managed-thing-id ${device_managed_thing_id} --endpoints ENDPOINT_ID
  ```
**注記**  
この例では、jq cli を に使用しますが、`endpointId`文字列全体を渡すこともできます。

  **レスポンス**:

  ```
  {    
    "TraceId": TRACE_ID
    }
  ```

  詳細については、「 マネージド統合コマンドリファレンス」の[send-managed-thing-command](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/send-managed-thing-command.html) AWS CLI 」コマンドを参照してください。 **

## ステップ 7: マネージドモノの状態を確認する
<a name="managedintegrations-sdk-v2-cookbook-ugs-device-state"></a>

マネージドモノの状態をチェックして、トグルアクションが成功したことを確認します。

**マネージドモノのデバイスの状態を確認するには**
+ `get-managed-thing-state` コマンドを使用して、成功したトグルアクションを検証します。

  **get-managed-thing-state 例**

  ```
    aws iot-managed-integrations get-managed-thing-state --managed-thing-id DEVICE_MANAGED_THING_ID
  ```

  **レスポンス**:

  ```
  {
        "Endpoints": [
            {
                "endpointId": "1",
                "capabilities": [
                    {
                        "id": "matter.OnOff@1.4",
                        "name": "On/Off",
                        "version": "1.4",
                        "properties": [
                            {
                                "name": "OnOff",
                                "value": {
                                    "propertyValue": true,
                                    "lastChangedAt": "2025-06-03T21:50:39.886Z"
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    }
  ```

  詳細については、「 マネージド統合コマンドリファレンス」の[get-managed-thing-state](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/get-managed-thing-state.html)」コマンドを参照してください。 AWS CLI* *

## ステップ 8: ハブからマネージド型モノを削除する
<a name="managedintegrations-sdk-v2-cookbook-ugs-clean-up"></a>

マネージドモノを削除してハブをクリーンアップします。

**マネージドモノを削除するには**
+ delete[delete-managed-thing](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/delete-managed-thing.html) コマンドを使用して、マネージド型モノを削除します。

  **delete-managed-thing 例**

  ```
  aws iot-managed-integrations delete-managed-thing \
    --identifier MANAGED_THING_ID
  ```

  詳細については、「 マネージド統合コマンドリファレンス」の[delete-managed-thing](https://docs.aws.amazon.com/cli/latest/reference/iot-managed-integrations/delete-managed-thing.html) コマンド AWS CLI 」を参照してください。 **
**注記**  
デバイスが `DELETE_IN_PROGRESS`状態でスタックしている場合は、 `delete-managed-thing` コマンドに `--force`フラグを追加します。
**注記**  
Z 波デバイスの場合は、 コマンドの実行後にデバイスをペアリングモードにする必要があります。