Get Wi-Fi Networks

Overview

For combo devices running TuyaOS v3.10.0 or later, the SDK enables devices to proactively scan for nearby Wi-Fi networks. This feature offers the following advantages:

• Overcome permission restrictions: Address the limitation of being unable to get nearby Wi-Fi networks due to mobile app permission restrictions.
• Ensure compatibility: The Wi-Fi networks retrieved by the device are all connectable.
• Improve success rate: Prevent users from selecting incompatible Wi-Fi networks, significantly enhancing pairing success.

Feature implementation

Search for devices

Example

ThingActivatorCoreKit.getScanDeviceManager().startBlueToothDeviceSearch(
    60 * 1000,
    arrayListOf(ScanType.SINGLE),
    object: ThingActivatorScanCallback {
        override fun deviceFound(scanBean: ThingActivatorScanDeviceBean) {
            // After the device is discovered, check if the feature to get the list of Wi-Fi networks is supported
            if (scanBean.isSupportObtainWifiListBeforeActive()) {
                // Supported
            }
        }

        override fun deviceRepeat(scanBean: ThingActivatorScanDeviceBean) {
        }

        override fun deviceUpdate(scanBean: ThingActivatorScanDeviceBean) {
        }

        override fun scanFailure(failureBean: ThingActivatorScanFailureBean) {
        }

        override fun scanFinish() {
        }
    }
)

Parameters

Get Wi-Fi networks

Request parameters

data class WifiInfoRequestBean(  
    var size: Int = 10,                    // The expected number of Wi-Fi networks to be returned
    var timeout: Long = 5000L,             // The device scanning timeout, in milliseconds
    var uuid: String = "",                 // The UUID of the specified Bluetooth device
    var spaceId: Long = -1,               // The home ID
    var modeEnum: ThingDeviceActiveModeEnum = ThingDeviceActiveModeEnum.BLE_WIFI,  
    var scanDeviceBean: ThingActivatorScanDeviceBean? = null  // The device object passed during pre-pairing queries
)

Example

val wifiReqBean = WifiInfoRequestBean().apply {
    uuid = thingActivatorScanDeviceBean.uniqueId
    size = 10
    timeout = 5000L
    modeEnum = ThingDeviceActiveModeEnum.BLE_WIFI
    scanDeviceBean = thingActivatorScanDeviceBean
}

ThingActivatorCoreKit.getActiveManager().newThingActiveManager().requestWifiList(
    wifiReqBean,
    object : IResultResponse<List<ThingActiveWifiInfoBean>> {
        override fun onError(errorCode: String?, errorMessage: String?) {
            //Failed to get the list of Wi-Fi networks
        }

        override fun onSuccess(result: List<ThingActiveWifiInfoBean>) {
            // Got the list of Wi-Fi networks successfully
        }
    }
)

Start pairing

After obtaining the list of Wi-Fi networks, users can choose a desired network and proceed with pairing.

val activeManager = ThingActivatorCoreKit.getActiveManager().newThingActiveManager()
activeManager.startActive(ThingDeviceActiveBuilder().apply {
    activeModel = ThingDeviceActiveModeEnum.BLE_WIFI
    ssid = "WiFi SSID"
    password = "WiFi Password"
    timeOut = 120
    relationId = homeId
    listener = object : IThingDeviceActiveListener {
        override fun onActiveSuccess(deviceBean: DeviceBean) {
            // Pairing was successful
        }

        override fun onActiveError(errorBean: ThingDeviceActiveErrorBean) {
            // Pairing failed
        }

        override fun onActiveLimited(limitBean: ThingDeviceActiveLimitBean) {
        }

        override fun onBind(devId: String) {
        }

        override fun onFind(devId: String) {
        }
    }
})

Things to note

• This feature is exclusive to combo devices running TuyaOS v3.10.0 or later.
• Before use, check whether the device supports this feature via isSupportObtainWifiListBeforeActive().
• When getting the list of Wi-Fi networks, set a proper timeout such as 5,000 ms.

Error codes