Register and test your Sidewalk endpoint

Step 3: Register and test your Sidewalk endpoint

After you’ve provisioned the Sidewalk endpoint, the endpoint must be registered so that it can communicate over the Sidewalk network. In this tutorial, you’ll learn about registering the endpoint.

Sidewalk registration methods

To register your Sidewalk endpoint, use automatic touchless registration with Sidewalk Frustration Free Networking (FFN). The following table describes the attributes of automatic touchless registration.

FFN registration

Criteria	Automatic registration (using Sidewalk FFN)
User and endpoint association	This registration method doesn’t require any association between the Sidewalk endpoint and a user. The endpoint can join the Sidewalk network without being associated with any user.
LWA (Login with Amazon)	LWA is not required.

Automatic touchless registration using Sidewalk FFN

Automatic touchless registration using Sidewalk frustration-free networking (FFN) is a registration process that automatically registers your Sidewalk endpoint over BLE. The registration process starts automatically when your Sidewalk gateway and your unregistered endpoint are in close range of each other. Your endpoint sends BLE beacons that are received by the Sidewalk gateway when the devices are in close proximity.

Set up to view FFN logs
To view the logs for the FFN registration process, follow these steps. For more information, see Set up for testing your Sidewalk device.

Connect the hardware development kit (HDK) to your computer using USB.
Power cycle the hardware by toggling the USB switch, and then power it on.
Connect to your hardware by following the instructions in the vendor documentation.

How FFN works
To perform registration using Sidewalk FFN:

Your Sidewalk gateway and endpoint must be powered on.
Your gateway must be opted into Sidewalk, and in close range to your endpoint. We recommend that you keep the devices within 10 meters of each other.

The registration process will start automatically, and a successful registration is indicated with Registration Status of zero, as seen in this log output. The Time Sync Status of zero indicates a successful time sync.

≪info> app: Registration Status = 0, Time Sync Status = 0 and Link Status = 0

If you don’t see this output, try either of the following steps:

Confirm that your Sidewalk endpoint is powered on. If needed, reboot your Sidewalk endpoint.
Confirm that your Sidewalk gateway is powered on, has internet connection, and is registered to a user with Sidewalk consent enabled. If needed, reboot your Sidewalk gateway and wait for 10 minutes for the gateway to be ready to retry the registration process.

De-register your Sidewalk endpoint
In certain cases, you might want to de-register your Sidewalk endpoint. For example, when testing the registration process multiple times, you must de-register your Sidewalk endpoint before attempting to re-register it.

De-registering your Sidewalk endpoint requires a two-way message exchange between the endpoint, gateway, and the cloud. To avoid any out-of-sync issues between your endpoint and the cloud, your Sidewalk gateway must be powered on, and in range of the registered endpoint.

You use the AWS API to de-register the endpoint. To de-register, run the following curl command. Replace:

AWS_ACCESS_KEY and AWS_SECRET_KEY with the credentials you obtained when setting up your account and configuring the AWS CLI.
WIRELESS_DEVICE_ID with the ID of your Sidewalk device.

curl -X PATCH "https://api.iotwireless.us-east-1.amazonaws.com/wireless-devices/WIRELESS_DEVICE_ID/deregister?WirelessDeviceType=Sidewalk" 
     --user <AWS_ACCESS_KEY>:<AWS_SECRET_KEY> 
     --aws-sigv4 "aws:amz:us-east-1:iotwireless"

A successful de-registration is indicated by a status of 200 or 202, and will have the following log output:

<info> app: Registration Status = 1, Time Sync Status = 1 and Link Status = 1

Set up for testing your Sidewalk device

To view the logs for testing your Sidewalk device, perform the following steps to connect to your HDK, and to connect your Sidewalk device.

Connect the HDK to your computer using a USB cable.
Power cycle the hardware by toggling the switch that’s situtated beside the USB port on the HDK, and then set it to the ON position.
Connect to your hardware by following the instructions in the documentation for your HDK. One way to connect to the device and view log messages is using telnet.
- For Nordic Semiconductor’s HDK, see the Nordic Semiconductor documentation.
- For Silicon Laboratories’ HDK, see the Silicon Laboratories documentation.
- For Texas Instruments’ HDK, see the Texas Instruments documentation.
To connect your device to the AWS Cloud and view messages that are exhanged between your device and the cloud, you must create a Sidewalk destination. A destination describes the AWS IoT rules that process and route messages between your devices and other AWS services and other applications.

For more information about adding a destination, see Add a destination to AWS IoT Core for Amazon Sidewalk in the AWS IoT Core Developer Guide.