Getting started with Sidewalk SDK APIs
Sidewalk Mobile iOS SDK provides a one-stop solution for everything related to Sidewalk on iOS mobiles. The initial release contains APIs including:
scan()
,secureConnect()
,register()
,deregister()
, andclearAccountCache()
inSidewalk
to interact with end devices.subscribe()
,write()
,startCoverageTest()
,isAvailable()
, anddisconnect()
inSidewalkConnection
to perform operations in a connection with a Sidewalk device.getToken()
inSidewalkAuthProviding
to provide LWA token to Sidewalk Mobile SDK for communication with the Sidewalk cloud.log()
inSidewalkLogging
to receive logs from Sidewalk Mobile SDK.
Start with the Sidewalk
class to onboard to the public APIs supporting Sidewalk functionalities.
Setting up your app with Sidewalk Mobile iOS SDK
See https://docs.sidewalk.amazon/mobile-sdk/developer-guide/getting-started-sidewalk-mobile-ios-sdk/ to get started with Sidewalk Mobile iOS SDK. The document walks you through how to integrate Sidewalk Mobile iOS SDK into your iOS apps.
Testing with the Sidewalk Sample App
- Clone iOS sample app from GitHub https://github.com/amzn/amazon-sidewalk-ios-samples to a directory on your hard drive.
- 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.