register
Deprecated
Please use registerDevice(smsn) instead for simpler Amazon Sidewalk device management with consistent SMSN value.
Replace with
registerDevice(sidewalkDevice.truncatedSmsn)Note: This method is being deprecated in the near future, please use registerDevice(smsn) instead for simpler Amazon Sidewalk device management with consistent SMSN value.
Register a device with the Amazon Sidewalk network. If a SidewalkConnection has been established with the device before registration, use register(SidewalkConnection) instead.
You can register a device by given SidewalkDevice received from scan;
val device = sidewalk.scan()
.filter { it is SidewalkResult.Success }
.map { (it as SidewalkResult.Success).value }
.first()
sidewalk.register(device)or provide a SidewalkDeviceDescriptor, containing device name, or endpointId. Amazon Sidewalk Mobile SDK would scan peripherals with given descriptor, and register the device if one found.
sidewalk.register(
SidewalkDeviceDescriptor.create(
nameFilter = "MyDevice"
)
)Deregister with factory reset and re-registration will be performed if the device is already registered to your account.
The Amazon Sidewalk device will disconnect after registration regardless of result. Call secureConnectDevice to acquire a new SidewalkConnection if connection features are still required.
Connects to the Amazon Sidewalk device over Bluetooth Low-Energy (BLE). Attempts to register it for use on the Amazon Sidewalk network. Only one registration call can be in operation at a time.
Return
The result when registration complete, it returns RegisterResult.Success when succeeds, otherwise RegisterResult.Failure.
Parameters
Device to attempt registration.
Deprecated
Please use registerDevice(sidewalkConnection) instead for simpler Amazon Sidewalk device management with consistent SMSN value.
Replace with
registerDevice(sidewalkConnection)Note: This method is being deprecated in the near future, please use registerDevice(sidewalkConnection) instead for simpler Amazon Sidewalk device management with consistent SMSN value.
Register a device with the Amazon Sidewalk network through the BLE secure connection.
val device = sidewalk.scan()
.filter { it is SidewalkResult.Success }
.map { (it as SidewalkResult.Success).value }
.first()
val connection = sidewalk.secureConnect(device)
sidewalk.register(connection)Deregister with factory reset and re-registration will be performed if the device is already registered to your account.
The Amazon Sidewalk device will disconnect after registration regardless of result. Call secureConnectDevice to acquire a new SidewalkConnection if connection features are still required.
Attempts to register the connected Amazon Sidewalk device for use on the Amazon Sidewalk network. Only one registration call can be in operation at a time.
Return
The result when registration complete, it returns RegisterResult.Success when succeeds, otherwise RegisterResult.Failure.
Parameters
A secure BLE connection with the Amazon Sidewalk device