Einführung in das Onboarding Ihrer Sidewalk-Geräte

In diesem Abschnitt erfahren Sie, wie Sie Sidewalk-Endgeräte in AWS IoT Core für Amazon Sidewalk einbinden. Um Geräte zu integrieren, fügen Sie zunächst das Sidewalk-Gerät hinzu, stellen dann das Gerät bereit und registrieren es; verbinden Sie dann die Hardware mit der Cloud-Anwendung. Bevor Sie dieses Tutorial ausführen, lesen Sie es durch und schließen Sie Installieren von Python und der AWS CLI ab.

Die folgenden Schritte zeigen, wie Sie Sidewalk-Endgeräte einbinden und mit AWS IoT Core für Amazon Sidewalk verbinden. Wenn Sie Geräte mit AWS CLI einbinden möchten, können Sie sich an den Beispielbefehlen in diesem Abschnitt orientieren. Informationen zum Onboarding von Geräten über die AWS IoT Konsole finden Sie unter Herstellen einer Verbindung mit AWS IoT Core für Amazon Sidewalk.

Wichtig

Um den gesamten Onboarding-Workflow durchzuführen, müssen Sie das Endgerät bereitstellen und registrieren und das Hardware Development Kit (HDK) anschließen. Weitere Informationen finden Sie unter Bereitstellung und Registrierung des Endgeräts in der Amazon Sidewalk-Dokumentation.

Schritt 1: Hinzufügen Ihres Geräts zu AWS IoT Core für Amazon Sidewalk

Im Folgenden finden Sie eine Übersicht über die Schritte, die Sie ausführen, um das Sidewalk-Endgerät zu AWS IoT Core für Amazon Sidewalk hinzuzufügen. Speichern Sie die Informationen, die Sie über das Geräteprofil und das von Ihnen erstellte drahtlose Gerät erhalten. Sie verwenden diese Informationen, um das Endgerät bereitzustellen und zu registrieren. Weitere Informationen zu diesen Zuständen finden Sie unter Hinzufügen Ihres Geräts zu AWS IoT Core für Amazon Sidewalk.

1. Erstellen eines Geräteprofils

   Erstellen Sie ein Geräteprofil, das die gemeinsam genutzten Konfigurationen für die Sidewalk-Geräte enthält. Geben Sie bei der Erstellung des Profils a name für das Profil als alphanumerische Zeichenfolge an. Um ein Profil zu erstellen, gehen Sie entweder in der AWS IoT Konsole zur Registerkarte Sidewalk der Profile-Hubs und wählen Profil erstellen aus, oder verwenden Sie den CreateDeviceProfile API-Vorgang oder create-device-profile CLI-Befehl, wie in diesem Beispiel gezeigt.

   // Add your device profile using a name and the sidewalk object.
   aws iotwireless create-device-profile --name sidewalk_profile --sidewalk {}

2. Erstellen Ihres Sidewalk-Endgeräts

   Erstellen Ihres Sidewalk-Endgeräts mit AWS IoT Core für Amazon Sidewalk. Geben Sie einen Zielnamen und die ID des Geräteprofils an, das Sie im vorherigen Schritt erhalten haben. Um ein Gerät hinzuzufügen, gehen Sie entweder in der AWS IoT Konsole zur Registerkarte Sidewalk des Geräte-Hubs und wählen Gerät bereitstellen aus, oder verwenden Sie den CreateWirelessDevice API-Vorgang oder den create-wireless-device CLI-Befehl, wie in diesem Beispiel gezeigt.

   Anmerkung

   Geben Sie einen Namen für Ihr Ziel an, der für Ihr AWS-Konto und AWS-Region einzigartig ist. Sie verwenden diesen Zielnamen, wenn Sie das Ziel zu AWS IoT Core für Amazon Sidewalk hinzufügen.

   // Add your Sidewalk device by using the device profile ID. 
   aws iotwireless create-wireless-device --type "Sidewalk" --name sidewalk_device \ 
       --destination-name SidewalkDestination \
       --sidewalk DeviceProfileId="12345678-234a-45bc-67de-e8901234f0a1"

3. Rufen Sie Informationen zum Geräteprofil und zum drahtlosen Gerät ab

   Rufen Sie das Geräteprofil und die Informationen zum drahtlosen Gerät als JSON ab. Das JSON enthält Informationen zu den Gerätedetails, Gerätezertifikaten, privaten Schlüsseln, DeviceTypeId und der Sidewalk Manufacturing Serial Number (SMSN).

   • Wenn Sie die AWS IoT-Konsole verwenden, können Sie die Registerkarte Sidewalk im Geräte-Hub verwenden, um eine kombinierte JSON-Datei für das Sidewalk-Endgerät herunterzuladen.

   • Wenn Sie die API-Operationen verwenden, speichern Sie die Antworten, die Sie aus den API-Vorgängen erhalten haben, GetDeviceProfileund GetWirelessDeviceals separate JSON-Dateien, z. B. device_profile.jsonund. wireless_device.json

     // Store device profile information as a JSON file.
     aws iotwireless get-device-profile \ 
         --id "12345678-a1b2-3c45-67d8-e90fa1b2c34d" > device_profile.json
     
     // Store wireless device information as a JSON file.
     aws iotwireless get-wireless-device --identifier-type WirelessDeviceId \ 
         --identifier "23456789-abcd-0123-bcde-fabc012345678" > wireless_device.json

Schritt 2: Erstellen eines Ziels für das Sidewalk-Endgerät

Im Folgenden finden Sie eine Übersicht über die Schritte, die Sie ausführen, um das Ziel zu AWS IoT Core für Amazon Sidewalk hinzuzufügen. Mithilfe von AWS Management Console oder AWS IoT Wireless-API-Operationen oder AWS CLI, führen Sie die folgenden Schritte aus, um eine AWS IoT-Regel und ein Ziel zu erstellen. Anschließend können Sie eine Verbindung zur Hardwareplattform herstellen und Nachrichten anzeigen und austauschen. Ein Beispiel für eine IAM-Rolle und AWS IoT-Regel, die für die AWS CLI-Beispiele in diesem Abschnitt verwendet wurden, finden Sie unter Erstellen einer IAM-Rolle und einer IoT-Regel für Ihr Ziel.

1. Erstellen einer IAM-Rolle

   Erstellen Sie eine IAM-Rolle, die AWS IoT Core für Amazon Sidewalk die Berechtigung zum Senden von Daten an die AWS IoT-Regel erteilt. Verwenden Sie die CreateRole-API-Operation oder den create-role-CLI-Befehl, um die Rolle zu erstellen. Sie können die Rolle als SidewalkRole benennen.

   aws iam create-role --role-name lambda-ex \ 
       --assume-role-policy-document file://lambda-trust-policy.json

2. Erstellen einer Regel für Ihr Ziel

   Erstellen Sie eine AWS IoT-Regel, die die Gerätedaten verarbeitet, und geben Sie das Thema an, zu dem Meldungen veröffentlicht werden. Sie werden Nachrichten zu diesem Thema sehen, nachdem Sie eine Verbindung zur Hardwareplattform hergestellt haben. Verwenden Sie den AWS IoT Core API-Vorgang, CreateTopicRule, oder den AWS CLI-Befehl, create-topic-rule, um eine Regel für das Ziel zu erstellen.

   aws iot create-topic-rule --rule-name Sidewalkrule \ 
       --topic-rule-payload file://myrule.json

3. Erstellen eines Ziels

   Erstellen Sie ein Ziel, das das Sidewalk-Gerät mit der IoT-Regel verknüpft, die es für die Verwendung mit anderen AWS-Services verarbeitet. Sie können ein Ziel mithilfe des Destinations-Hubs der AWS IoT Konsole, der CreateDestinationAPI-Operation oder des create-destinationCLI-Befehls hinzufügen.

   aws iotwireless create-destination --name SidewalkDestination \
       --expression-type RuleName --expression SidewalkRule \
       --role-arn arn:aws:iam::123456789012:role/SidewalkRole

Schritt 3: Bereitstellung und Registrierung des Endgeräts

Mithilfe von Python-Befehlen können Sie Ihr Endgerät bereitstellen und registrieren. Das Bereitstellungsskript verwendet die JSON-Daten des Geräts, die Sie erhalten haben, um ein fertigungsbezogenes Binärbild zu generieren, das dann auf der Hardwareplatine gespeichert wird. Anschließend registrieren Sie Ihr Endgerät für die Verbindung mit der Hardwareplattform. Weitere Informationen finden Sie unter Bereitstellung und Registrierung des Endgeräts in der Amazon Sidewalk-Dokumentation.

Anmerkung

Bei der Registrierung des Sidewalk-Endgeräts muss das Gateway bei Amazon Sidewalk angemeldet sein, und das Gateway und das Gerät müssen sich in Reichweite zueinander befinden.

Schritt 4: Connect zu einem Sidewalk-Endgerät und Tauschen von Nachrichten

Nachdem Sie Ihr Endgerät registriert haben, können Sie Ihr Endgerät verbinden und mit dem Austausch von Nachrichten und Gerätedaten beginnen.

1. Dein Sidewalk-Endgerät verbinden

   Verbinden Sie das HDK an Ihren Computer, und folgen Sie den Anweisungen in der Herstellerdokumentation, um eine Verbindung zu Ihrem HDK herzustellen. Weitere Informationen finden Sie unter Bereitstellung und Registrierung des Endgeräts in der Amazon Sidewalk-Dokumentation.

2. Nachrichten anzeigen und austauschen

   Verwenden Sie den MQTT-Client, um das in der Regel angegebene Thema zu abonnieren und die empfangene Nachricht anzusehen. Sie können auch den SendDataToWirelessDeviceAPI-Vorgang oder den send-data-to-wireless-deviceCLI-Befehl verwenden, um eine Downlink-Nachricht an das Gerät zu senden und den Verbindungsstatus zu überprüfen.

   (Optional) Sie können das Ereignis zum Status der Nachrichtenzustellung aktivieren, um zu überprüfen, ob die Downlink-Nachricht erfolgreich empfangen wurde.

   aws iotwireless send-data-to-wireless-device \
       --id "<Wireless_Device_ID>" \
       --payload-data "SGVsbG8gVG8gRGV2c2lt" \
       --wireless-metadata Sidewalk={Seq=1,AckModeRetryDurationSecs=10}