Utilisez la configuration guidée par l'utilisateur pour intégrer et faire fonctionner les appareils

Configurez vos appareils pour qu'ils soient intégrés à votre hub d'intégrations gérées en créant un objet géré et en le connectant à votre hub. Cette section décrit les étapes à suivre pour terminer le processus d'intégration de l'appareil à l'aide de la configuration guidée par l'utilisateur.

Prérequis

Effectuez les étapes suivantes avant de tenter d'intégrer un appareil :

• Intégrez un appareil central au hub d'intégrations gérées.

• Installez la dernière version de AWS CLI depuis le manuel Managed Integrations AWS CLI Command Reference

• Abonnez-vous aux notifications d'événements DEVICE_DISCOVERY-STATUS.

Prérequis : activer le mode de jumelage sur votre appareil Z Wave

Activez le mode de couplage sur l'appareil Z-wave. Le mode de couplage peut varier pour chaque appareil Z-Wave. Reportez-vous donc aux instructions de l'appareil pour configurer correctement le mode de couplage. Il s'agit généralement d'un bouton sur lequel l'utilisateur doit appuyer.

Étape 1 : démarrer la découverte des appareils

Lancez la découverte des appareils pour votre hub afin d'obtenir un identifiant de tâche de découverte qui sera utilisé pour intégrer votre appareil.

Pour démarrer la découverte des appareils

• Utilisez la start-device-discoverycommande pour obtenir l'ID de la tâche de découverte.

  Exemple 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 \

  Réponse :

  {
        "Id": DISCOVERY_JOB_ID,
        "StartedAt": "2025-06-03T14:43:12.726000-07:00"
    }

  Note

  Il existe des commandes distinctes pour les appareils Z-wave et Zigbee.

  Pour plus d'informations, consultez l'start-device-discoveryAPI dans le manuel de référence des AWS CLI commandes d'intégrations gérées.

Étape 2 : demander l'ID de la tâche de découverte

Utilisez la list-discovered-devices commande pour obtenir le matériel d'authentification de votre appareil.

Pour demander votre identifiant de tâche de découverte

• Utilisez l'ID de la tâche de découverte avec la list-discovered-devices commande pour obtenir le matériel d'authentification de votre appareil.

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

Réponse :

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

Étape 3 : créer un objet géré pour votre appareil

Utilisez la create-managed-thing commande pour créer un objet géré pour votre appareil. Chaque appareil a besoin de son propre appareil géré.

Pour créer un objet géré

• Utilisez la create-managed-thing commande pour créer un objet géré pour votre appareil.

  Exemple create-managed-thing

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

  Réponse :

  {    
      "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"
    }

  Pour plus d'informations, consultez la create-managed-thingcommande dans le manuel de référence des AWS CLI commandes des intégrations gérées.

Étape 4 : Interrogez l'objet géré

Vous pouvez vérifier si un objet géré est activé à l'aide de la get-managed-thing commande.

Pour interroger un objet géré

• Utilisez la get-managed-thing commande pour vérifier si le statut de provisionnement de l'objet géré est défini sur. ACTIVATED

  Exemple get-managed-thing

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

  Réponse :

  {
        "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": {}
    }

  Pour plus d'informations, consultez la get-managed-thingcommande dans le manuel de référence des AWS CLI commandes des intégrations gérées.

Étape 5 : Bénéficiez de fonctionnalités de gestion des objets

Vous pouvez consulter la liste des actions disponibles pour un objet géré en utilisant leget-managed-thing-capabiltiies.

Pour obtenir les fonctionnalités d'un appareil

• Utilisez la get-managed-thing-capabilities commande pour obtenir l'ID du point de terminaison. Notez également la liste des actions possibles.

  Exemple get-managed-thing-capabilities

  aws iotmi get-managed-thing-capabilities \
    --identifier "DEVICE_MANAGED_THING_ID"

  Réponse :

  {
        "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"
                            ],
                            ...
    }

  Pour plus d'informations, consultez la get-managed-thing-capabilitiescommande dans le manuel de référence des AWS CLI commandes des intégrations gérées.

Étape 6 : Envoyer une commande à l'objet géré

Vous pouvez utiliser cette send-managed-thing-command commande pour envoyer une commande d'action à l'objet que vous gérez.

Envoyez une commande à l'objet géré à l'aide d'une action de bascule.

• Utilisez la send-managed-thing-command commande pour envoyer une commande d'action à bascule.

  Exemple 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
              

  Note

  Cet exemple utilise jq cli to, mais vous pouvez également transmettre la chaîne entière endpointId

  Réponse :

  {    
    "TraceId": TRACE_ID
    }

  Pour plus d'informations, consultez la send-managed-thing-commandcommande dans le manuel de référence des AWS CLI commandes des intégrations gérées.

Étape 7 : vérifier l'état de l'objet géré

Vérifiez l'état de l'objet géré pour valider la réussite de l'action de bascule.

Pour vérifier l'état de l'appareil d'un objet géré

• Utilisez la get-managed-thing-state commande pour valider la réussite de l'action de bascule.

  Exemple get-managed-thing-state

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

  Réponse :

  {
        "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"
                                }
                            }
                        ]
                    }
                ]
            }
        ]
    }

  Pour plus d'informations, consultez la get-managed-thing-statecommande dans le manuel de référence des AWS CLI commandes des intégrations gérées.

Étape 8 : Supprimer l'objet géré de votre hub

Nettoyez votre hub en supprimant l'élément géré.

Pour supprimer un objet géré

• Utilisez la delete-managed-thingcommande pour supprimer un objet géré.

  Exemple delete-managed-thing

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

  Pour plus d'informations, consultez la delete-managed-thingcommande dans le manuel de référence des AWS CLI commandes des intégrations gérées.

  Note

  Si l'appareil est bloqué dans un DELETE_IN_PROGRESS état, ajoutez l'--forceindicateur à la delete-managed-thing commande.

  Note

  Pour les appareils Z-wave, vous devez mettre l'appareil en mode couplage après avoir exécuté la commande.