Sidewalk

Main entry point to the Sidewalk Mobile SDK.

Provides access to Sidewalk device and Sidewalk cloud for registration, secure connection, deregistration, and clear account cache.

Nested Declarations

Static Properties

Initialization

Public Functions

  • Starts scanning for Sidewalk devices via Bluetooth.

    Scan for devices advertising AMA characteristics conforming to the Sidewalk protocol. Only one scan can be in operation at a time. Additional calls will restart scanning and return the same SidewalkCancellable instance.

    Note

    This object automatically calls cancel() when deinitialized.

  • Securely connects to a given Sidewalk device.

    Connects to the given Sidewalk device via BLE, and exchanges encryption keys to create a secure connection.

    You can establish a secure connection by a given SidewalkDevice received from scan; or provide a SidewalkDeviceDescriptor, containing device nameFilter and / or endpointIdFilter. Sidewalk Mobile SDK would scan peripherals with the given descriptor and connect to the device if one found.

    Note

    This object automatically calls cancel() when deinitialized.

  • Registers a Sidewalk device with Sidewalk cloud. If a SidewalkConnection has been established with the device prior to registration, use register(connection:completion:) instead

    Connects to the Sidewalk device over Bluetooth Low-Energy (BLE). Attempts to register it for use on the Sidewalk network. Only one registration call can be in operation at a time.

    You can register a device by a given SidewalkDevice received from scan; or provide a SidewalkDeviceDescriptor, containing device nameFilter and / or endpointIdFilter. Sidewalk Mobile SDK would scan peripherals with the given descriptor and register the device if found one.

    Note

    This object automatically calls cancel() when deinitialized.

  • Registers a Sidewalk device with Sidewalk cloud through the BLE secure connection.

    Attempts to register the connected SidewalkDevice for use on the Sidewalk network. The Sidewalk device will disconnect after registration regardless of result. Call secureConnect() to acquire a new SidewalkConnection if connection features are still required. Only one registration call can be in operation at a time.

    Note

    This object automatically calls cancel() when deinitialized.

  • Authenticate existing devices already in the field onto Sidewalk network.

    This is part of the Sidewalk remote certificate provisioning process.

    Note

    This object automatically calls cancel() when deinitialized.

  • Deregisters a Sidewalk device from Sidewalk network.

    Note

    This object automatically calls cancel() when deinitialized.

  • Clear user related data.

    You should call clearAccountCache explicitly when the account credential is no longer available, e.g. user logged out.