Automatic Touchless Registration using Sidewalk FFN

Touchless registration using Sidewalk FFN is a silent, automatic process that occurs between an unregistered Sidewalk Endpoint and a Sidewalk Gateway over Bluetooth LE. The endpoint sends Bluetooth LE beacons that are received by the Sidewalk Gateway when the endpoint and gateway are in close proximity.

Ensure your Sidewalk Gateway is opted into Sidewalk, powered on and in close range to your Sidewalk Endpoint. Successful registration is indicated by the following Device Is registered log message:

*** Booting Zephyr OS build v3.0.99-ncs1-4913-gf7b06162027d  ***
----------------------------------------------------------------
sidewalk             v1.13.0-6-g2e0691d-dirty
nrf                  v2.0.0-734-g3904875f6
zephyr               v3.0.99-ncs1-4913-gf7b0616202-dirty
----------------------------------------------------------------
sidewalk_fork_point = 92dcbff2da68dc6853412de792c06cc6966b8b79
build time          = 2022-11-17 10:52:50.833532+00:00
----------------------------------------------------------------

[00:00:00.006,225] <inf> sid_template: Sidewalk example started!
[00:00:00.061,584] <inf> sid_thread: Initializing sidewalk - Build with Link mask LoRa
[00:00:00.061,614] <inf> sid_thread: Start Sidewalk link_mask:1
[00:00:00.438,751] <inf> sdc_hci_driver: SoftDevice Controller build revision:
                                         b6 5a b4 2c 4d fa 65 96  62 bc a6 bf 2e f3 36 5c |.Z.,M.e. b.....6\
                                         c6 ab 31 a6                                      |..1.
[00:00:00.477,325] <inf> sid_thread: status changed: not ready
[00:00:00.477,355] <inf> sid_thread: Device Unregistered, Time Sync Fail, Link status Down
[00:00:00.477,355] <inf> sid_thread: Starting Sidewalk thread ...
[00:00:11.135,070] <inf> sid_thread: status changed: not ready
[00:00:11.135,131] <inf> sid_thread: Device Unregistered, Time Sync Fail, Link status Down
[00:00:31.045,440] <inf> sid_thread: status changed: not ready
[00:00:31.045,471] <inf> sid_thread: Device Is registered, Time Sync Fail, Link status Up
[00:00:31.526,733] <inf> sid_thread: status changed: not ready

De-registering your Sidewalk Endpoint

Under certain situations, you may wish to de-register your endpoint. For example, if you want to test the registration process multiple times, you will need to de-register your endpoint before attempting to re-register it.

  1. Find <AWS_ACCESS_KEY> and <AWS_SECRET_KEY> with your AWS credentials. You should have made note of these credentials when setting up your AWS account.

    1. In case you need to obtain new keys, navigate to IAM, and select Users.

    2. Under your user account, go to Security Credentials tab, and click Create access key button.

    ../_images/AWSDeregisterSecurityCredentials.png

  2. Replace <YOUR WIRELESS DEVICE ID> variable with your own wireless device ID. You can find it under AWS IoT → Manage → LPWAN devices → Devices. It is listed as Device ID.

    ../_images/AWSDeregisterWirelessId.png

  3. Run the following command on your console:

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

    API response code should be 200 or 202.