smartConfigCheyw

来自于：开发者立即使用

getSsid startConfirm sendCommand

模块概述

smartConfigCheyw是一个WIFI智能配网模块，通过smartconfig轻松给智能设备wifi模块配置网络（包含ios和安卓）。iOS端使用说明：在iOS12（含）以后的版本必须按如下步骤配置，否则无法获取wifi信息。1、配置包名：在iOS平台上使用本功能，需要在 生成包名（bundle id）的时候，勾选 Access WiFi Information 功能。注意：若配置已经在使用中的包名，需重新生成描述文件，打包证书不用动。2、配置 entitlement 文件：iOS 上使用本模块前，需要先配置一个 entitlement 文件。配置方法参考论坛帖子 https://community.apicloud.com/bbs/forum.php?mod=viewthread&tid=47691。配送参数如下：

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

模块接口

getSsid

得到Ssid、Bssid的值

getSsid(callback(ret))

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
   ssid: '',           //字符串类型；Ssid的值
   Bssid: ''           //字符串类型；Bssid的值
}

示例代码

var smartConfigCheyw = api.require('smartConfigCheyw');
smartConfigCheyw.getSsid(function(ret,err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

startConfirm

开始配置网络

startConfirm({params}, callback(ret))

params

ssid：

• 类型：字符串
• 描述：ssid的值

password:

• 类型：字符串
• 描述：wifi密码

Bssid:

• 类型：字符串
• 描述：Bssid的值

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
   isSuc: '',         //bool类型；是否配置成功,true:配置成功  false:配置失败
   bssid: '',         //字符串类型；成功返回
   inetAddress: ''    //字符串类型；成功返回
}

示例代码

var smartConfigCheyw = api.require('smartConfigCheyw');
smartConfigCheyw.startConfirm({
    ssid: 'wifi_name',
    password: '123456789',
    Bssid: 'b8:3a:8:ae:a0:21'
}, function(ret) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

sendCommand

配置成功之后发送指令

sendCommand({params}, callback(ret))

params

ip：

• 类型：字符串
• 描述：（可选项）ip地址

port:

• 类型：字符串
• 描述：（可选项）端口

sendStr:

• 类型：字符串
• 描述：根据硬件要求传参数,发送的命令。

callback(ret)

ret：

• 类型：JSON 对象
• 内部字段：

{
   isSuc: '',     //bool类型；是否发送指令成功,true:成功  false:失败
   result: ''     //字符串类型；成功返回结果(例如：cmd=pong&host_ip=xxxx&device_id=xxx)
}

示例代码

var smartConfigCheyw = api.require('smartConfigCheyw');
smartConfigCheyw.sendCommand({
    sendStr: 'cmd=ping\r\n'
}, function(ret) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本