Introduction to onboarding your Sidewalk devices

Create a device profile

Create a device profile that contains the shared configurations for your Sidewalk devices. When creating the profile, specify a name for the profile as an alphanumeric string. To create a profile, either go to the Sidewalk tab of the Profiles hub in the Amazon IoT console and choose Create profile, or use the CreateDeviceProfile API operation or the create-device-profile CLI command as shown in this example.

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

Create your Sidewalk end device

Create your Sidewalk end device with Amazon IoT Core for Amazon Sidewalk. Specify a destination name and the ID of the device profile obtained from the previous step. To add a device, either go to the Sidewalk tab of the Devices hub in the Amazon IoT console and choose Provision device, or use the CreateWirelessDevice API operation or the create-wireless-device CLI command as shown in this example.

// 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"

Get device profile and wireless device information

Get the device profile and wireless device information as a JSON. The JSON will contain information about the device details, device certificates, private keys, DeviceTypeId, and the Sidewalk manufacturing serial number (SMSN).

Create IAM role

Create an IAM role that grants Amazon IoT Core for Amazon Sidewalk permission to send data to the Amazon IoT rule. To create the role, use the CreateRole API operation or create-role CLI command. You can name the role as SidewalkRole.

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

Create a rule for the destination

Create an Amazon IoT rule that will process the device's data and specify the topic to which messages are published. You'll observe messages on this topic after connecting to the hardware platform. Use the Amazon IoT Core API operation, CreateTopicRule, or the Amazon CLI command, create-topic-rule, to create a rule for the destination.

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

Create a destination

Create a destination that associates your Sidewalk device with the IoT rule that processes it for use with other Amazon Web Services. You can add a destination using the Destinations hub of the Amazon IoT console, or the CreateDestination API operation or the create-destination CLI command.

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

Connect your Sidewalk end device

Connect the HDK to your computer and follow the instructions provided by the vendor documentation to connect to your HDK. For more information, see Provisioning and registering your end device in the Amazon Sidewalk documentation.

View and exchange messages

Use the MQTT client to subscribe to the topic specified in the rule and view the message received. You can also use the SendDataToWirelessDevice API operation or the send-data-to-wireless-device CLI command to send a downlink message to your device and verify the connectivity status.

(Optional) You can enable the message delivery status event to check whether the downlink message was successfully received.

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