esptouchPlus

模块使用攻略

  1. 在 iOS 平台上使用本功能,需要在 生成包名(bundle id) 的时候,勾选 Access WiFi Information 功能。

  2. iOS 上使用本插件前,需要先配置一个 entitlement 文件。

配置参数如下:

<key>com.apple.developer.networking.wifi-info</key>
<true/>

模块接口

userLocationAuth

定位权限判断

userLocationAuth(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    message: '' //Android 有值
}

示例代码

var demo = api.require('esptouchPlus');
demo.userLocationAuth(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

registerWifiChange

注册WIFI变化监听

registerWifiChange(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

示例代码

var demo = api.require('esptouchPlus');
demo.registerWifiChange(function(ret, err){

});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

unregisterWifiChange

注销WIFI变化监听

unregisterWifiChange(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

示例代码

var demo = api.require('esptouchPlus');
demo.unregisterWifiChange(function(ret, err){

});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

fetchNetInfo

获取WIFI网络信息

fetchNetInfo(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    ssid: '',
    ssidHex: '', //Android 有值
    bssid: '',
    address: '',
    is5G: '' //Android 有值
}

示例代码

var demo = api.require('esptouchPlus');
demo.fetchNetInfo(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

startSmartV1

开始配网V1

startSmartV1({params},callback(ret, err))

params

ssid

  • 类型:字符串型
  • 描述:(可选项)apSsid。

bssid

  • 类型:字符串型
  • 描述:(可选项)apBssid。

pwd

  • 类型:字符串型
  • 描述:(可选项)apPassword。

broadcast

  • 类型:字符串型
  • 描述:(可选项)broadcast。

taskCount

  • 类型:数字型
  • 描述:(可选项)taskCount。
  • 默认值:0

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    isCancelled: '',
    isSuc: '',
    bssid: '',
    address: '',
    data: [{//taskCount >0 时返回数据
        isCancelled: '',
        isSuc: '',
        bssid: '',
        address: '',
    }]
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var demo = api.require('esptouchPlus');
demo.startSmartV1(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stopSmartV1

停止配网V1

stopSmartV1(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

示例代码

var obj = api.require('esptouchPlus');
obj.stopSmartV1(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

startSyncV2

开始同步(V2)

startSyncV2(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType: '',    //onStart onStop onError
    errorMsg: ''
}

示例代码

var obj = api.require('esptouchPlus');
obj.startSyncV2(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

isSyncing

是否同步中(V2)

isSyncing()

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

示例代码

var demo = api.require('esptouchPlus');
var ret = demo.isSyncing();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stopSyncV2

停止同步(V2)

stopSyncV2(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

示例代码

var obj = api.require('esptouchPlus');
obj.stopSyncV2(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

startProvisioning

开始配网V2

startProvisioning({params}, callback(ret, err))

params

ssid

  • 类型:字符串型
  • 描述:(可选项)apSsid(iOS有效)。

ssidHex

  • 类型:字符串型
  • 描述:(可选项)apSsid的hex值(Android有效)。

bssid

  • 类型:字符串型
  • 描述:(可选项)apBssid。

pwd

  • 类型:字符串型
  • 描述:(可选项)apPassword。

aesKey

  • 类型:字符串型
  • 描述:(可选项)aesKey。

custom

  • 类型:字符串型
  • 描述:(可选项)custom。

count

  • 类型:字符串型
  • 描述:(可选项)count。
  • 默认值:0

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    evenType: '',    //onStart onStop onError onResponse
    errorMsg: '',
    address: '',
    bssid: '',
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: "",
}

示例代码

var obj = api.require('esptouchPlus');
obj.startProvisioning(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

isProvisioning

是否配网中

isProvisioning()

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

示例代码

var demo = api.require('esptouchPlus');
var ret = demo.isProvisioning();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stopProvisioning

停止配网

stopProvisioning(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
}

示例代码

var obj = api.require('esptouchPlus');
obj.stopProvisioning(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/05/31