bgnWiFi

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

addNetwork connect disconnect getPassword getWifiInfo isConnected isWifiEnabled removeNetwork setWifiEnabled startScan

概述

模块概述

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

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

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

模块接口

addNetwork

添加一个WiFi网络

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

params

ssid:

  • 类型:字符串
  • 描述:(必填项)网络SSID值。

password:

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

type:

  • 类型:字符串
  • 描述:(可选项)网络类型值。选项范围【WEP、PSK、EAP】

callback(ret, err)

ret:

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

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

var wifi= api.require('bgnWiFi');
wifi.addNetwork({
   ssid:"my-wifi",
   password:"12345678",
   type:"PSK"
},function(ret, err) {
        alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.0及更高版本

connect

连接一个WiFi网络

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

params

ssid:

  • 类型:字符串
  • 描述:(必填项)网络SSID值。

callback(ret, err)

ret:

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

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

disconnect

断开当前WiFi网络连接

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

params

ret:

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

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

getPassword

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

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

params

callback(ret, err)

ret:

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

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

getWifiInfo

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

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

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否成功
    info:{
        HiddenSSID",
        describeContents",
        BSSID", 
        IpAddress", 
        LinkSpeed", 
        MacAddress",
        NetworkId", 
        Rssi",
        SSID",
        SupplicantState"
    }
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

isConnected

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

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

params

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否操作成功
    connected:      //布尔型;true||false,是否连接
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

isWifiEnabled

获取WiFi打开状态

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

params

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否操作成功
    enabled:      //布尔型;true||false,是否打开
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

removeNetwork

删除指定wifi网络

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

params

ssid:

  • 类型:字符串
  • 描述:(必填项)网络SSID值。

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否操作成功
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

setWifiEnabled

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

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

params

enabled:

  • 类型:布尔型
  • 描述:(必填项)true||false。

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否操作成功
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本

startScan

开始扫描附近WiFi热点

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

params

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否操作成功
    results:[{
        BSSID,
    capabilities,
    frequency,
    level,
    SSID,
    timestamp,
    describeContents
    }]          //JSON搜索到的wifi热点信息
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
    msg:    //错误消息
}

示例代码

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

可用性

Android系统

可提供的1.0.0及更高版本