bgnWiFi

来自于：布谷鸟模块工作室立即使用

addNetwork connect disconnect getPassword getWifiInfo isConnected isWifiEnabled removeNetwork setWifiEnabled startScan

概述

bgnWiFi是布谷鸟工作室发布的免费的wifi操作模块，该模块提供了丰富的wifi操作接口。

使用此模块之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：

  • 配置示例:
  1.  <feature name="bgnWiFi"/>

模块接口

addNetwork

添加一个WiFi网络

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

params

ssid：

  • 类型：字符串
  • 描述：（必填项）网络SSID值。

password：

  • 类型：字符串
  • 描述：（可选项）密码。

type：

  • 类型：字符串
  • 描述：（可选项）网络类型值。选项范围【WEP、PSK、EAP】

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.addNetwork({
  3.    ssid:"my-wifi",
  4.    password:"12345678",
  5.    type:"PSK"
  6. },function(ret, err) {
  7.         alert(JSON.stringify(ret));
  8. });

可用性

Android系统

可提供的1.0.0及更高版本

connect

连接一个WiFi网络

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

params

ssid：

  • 类型：字符串
  • 描述：（必填项）网络SSID值。

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.connect({
  3.    ssid:"my-wifi"
  4. },function(ret, err) {
  5.         alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

disconnect

断开当前WiFi网络连接

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

params

无

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.disconnect(function(ret, err) {
  3.         alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

getPassword

返回当前保存的所有wifi网络的密码，该功需要具有root权限

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

params

无

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否成功
  3.     results:[{ssid:"网络SSID",password:"密码"}]
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.getPassword(function(ret, err) {
  3.         alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

getWifiInfo

获取当前连接wifi网络的信息

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

params

无

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否成功
  3.     info:{
  4.         HiddenSSID",
  5.         describeContents",
  6.         BSSID", 
  7.         IpAddress", 
  8.         LinkSpeed", 
  9.         MacAddress",
  10.         NetworkId", 
  11.         Rssi",
  12.         SSID",
  13.         SupplicantState"
  14.     }
  15. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.getWifiInfo(function(ret, err) {
  3.         alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

isConnected

判断当前wifi是否连接成功的

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

params

无

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否操作成功
  3.     connected:      //布尔型；true||false，是否连接
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.isConnected(function(ret, err) {
  3.         alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

isWifiEnabled

获取WiFi打开状态

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

params

无

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否操作成功
  3.     enabled:      //布尔型；true||false，是否打开
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.isWifiEnabled(function(ret, err) {
  3.         alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

removeNetwork

删除指定wifi网络

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

params

ssid：

  • 类型：字符串
  • 描述：（必填项）网络SSID值。

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否操作成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.removeNetwork({
  3.     ssid:"my-wifi"
  4. },function(ret, err) {
  5.         alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

setWifiEnabled

设置WiFi状态 enabled为true表示打开WiFi,false表示关闭WiFi

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

params

enabled：

  • 类型：布尔型
  • 描述：（必填项）true||false。

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否操作成功
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.setWifiEnabled({
  3.     enabled:true
  4. },function(ret, err) {
  5.         alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

startScan

开始扫描附近WiFi热点

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

params

无

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status: true      //布尔型；true||false，是否操作成功
  3.     results:[{
  4.         BSSID,
  5.     capabilities,
  6.     frequency,
  7.     level,
  8.     SSID,
  9.     timestamp,
  10.     describeContents
  11.     }]          //JSON搜索到的wifi热点信息
  12. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     code: 0     //数字类型；
  3.     msg:    //错误消息
  4. }

示例代码

  1. var wifi= api.require('bgnWiFi');
  2. wifi.startScan(function(ret, err) {
  3.         alert(JSON.stringify(ret));
  4. });

可用性

Android系统

可提供的1.0.0及更高版本