Getting started with Amazon Sidewalk SDK APIs

Amazon Sidewalk Mobile iOS SDK provides a one-stop solution for everything related to Amazon Sidewalk on iOS mobiles. The initial release contains APIs including:

  • scan(), secureConnectDevice(), registerDevice(), deregisterDevice(), and clearAccountCache() in Sidewalk to interact with end devices.
  • subscribe(), write(), startCoverageTest(), isAvailable(), and disconnect() in SidewalkConnection to perform operations in a connection with an Amazon Sidewalk device.
  • getToken() in SidewalkAuthProviding to provide LWA token to Amazon Sidewalk Mobile SDK for communication with the Sidewalk cloud.
  • log() in SidewalkLogging to receive logs from Amazon Sidewalk Mobile SDK.

Start with the Sidewalk class to onboard to the public APIs supporting Amazon Sidewalk functionalities.

Setting up your app with Amazon Sidewalk Mobile iOS SDK

See https://docs.sidewalk.amazon/mobile-sdk/developer-guide/getting-started-sidewalk-mobile-ios-sdk/ to get started with Amazon Sidewalk Mobile iOS SDK. The document walks you through how to integrate Amazon Sidewalk Mobile iOS SDK into your iOS apps.

Testing with the Sidewalk Sample App

  1. Clone iOS sample app from GitHub https://github.com/amzn/amazon-sidewalk-ios-samples to a directory on your hard drive.
  2. Follow the steps in README https://github.com/amzn/amazon-sidewalk-ios-samples/blob/main/README.md to set up and run the sample app.