Wi-Fi 列表获取

功能概述

对于使用 TuyaOS v3.10.0 或更新版本的双模设备，提供了设备主动获取周围 Wi-Fi 列表的功能。该功能具有以下优势：

• 解决权限限制：解决因手机 App 权限的限制导致无法获取完整 Wi-Fi 列表的问题。
• 保证兼容性：设备返回的 Wi-Fi 列表均为其能够成功连接的网络。
• 提升成功率：避免用户选择设备无法连接的 Wi-Fi，有效提高配网成功率。

功能实现

搜索设备

代码示例

ThingActivatorCoreKit.getScanDeviceManager().startBlueToothDeviceSearch(
    60 * 1000,
    arrayListOf(ScanType.SINGLE),
    object : ThingActivatorScanCallback {
        override fun deviceFound(scanBean: ThingActivatorScanDeviceBean) {
            // 搜索到设备后，检查是否支持获取 Wi-Fi 列表功能
            if (scanBean.isSupportObtainWifiListBeforeActive()) {
                // 设备支持获取 Wi-Fi 列表
            }
        }

        override fun deviceRepeat(scanBean: ThingActivatorScanDeviceBean) {
        }

        override fun deviceUpdate(scanBean: ThingActivatorScanDeviceBean) {
        }

        override fun scanFailure(failureBean: ThingActivatorScanFailureBean) {
        }

        override fun scanFinish() {
        }
    }
)

参数说明

获取 Wi-Fi 列表

请求参数说明

data class WifiInfoRequestBean(  
    var size: Int = 10,                    // 期望返回的 Wi-Fi 列表数量
    var timeout: Long = 5000L,             // 设备扫描超时时间（单位：毫秒/ms）
    var uuid: String = "",                 // 蓝牙设备的 UUID
    var spaceId: Long = -1,               // 家庭 ID
    var modeEnum: ThingDeviceActiveModeEnum = ThingDeviceActiveModeEnum.BLE_WIFI,  
    var scanDeviceBean: ThingActivatorScanDeviceBean? = null  // 配网前查询时传入的设备对象
)

代码示例

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?) {
            // Wi-Fi 列表获取失败
        }

        override fun onSuccess(result: List<ThingActiveWifiInfoBean>) {
            // Wi-Fi 列表获取成功
        }
    }
)

开始配网

获取到 Wi-Fi 列表后，用户可以从设备扫描到的列表中选择网络，然后进行配网：

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) {
            // 配网成功
        }

        override fun onActiveError(errorBean: ThingDeviceActiveErrorBean) {
            // 配网失败
        }

        override fun onActiveLimited(limitBean: ThingDeviceActiveLimitBean) {
        }

        override fun onBind(devId: String) {
        }

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

注意事项

• 该功能仅支持 TuyaOS v3.10.0 及以上版本的双模设备。
• 使用前必须通过 isSupportObtainWifiListBeforeActive() 检查设备是否支持该功能。
• 获取 Wi-Fi 列表时需要考虑超时时间的设置，建议在 5000 ms 左右。

错误码