ezWifiConfig

setApiUrl

setAccessToken

requestConfigToken

startWifiConfigWithWifiSsid

stopWifiConfig

startAPWifiConfigWithWifiName

stopAPWifiConfig

startNewApConfigWithToken

getAccessDeviceInfo

getAccessDeviceWifiList

getVersion

概述

萤石云简介

萤石云是一个视频云平台,萤石业务涵盖萤石云视频APP、萤石云视频服务平台、系列互联网产品（摄像机、硬盘录像机、视频盒子、报警盒子、云存储）等。

萤石云特色功能

  • 一站式VPaaS提供商：智能相机、萤石IOT云、高性能分发网络、全平台SDK、ALL in One。

  • 丰富的功能开放：包含实时视频、录像回放、双向语音、远程控制、消息推送、智能分析。

  • 极简应用集成：使用简单但强大的开发组件，即可轻松在您的应用中集成视频功能。

插件

本插件封装了萤石云的配网 SDK

配置包名

在 iOS 平台上使用本功能，需要在 生成包名（bundle id） 的时候，勾选 Access WiFi Information 功能。如下图：

注意：若配置已经在使用中的包名，需重新生成描述文件，打包证书不用动。

配置 entitlement 文件

iOS 上使用本插件前，需要先配置一个 entitlement 文件。配置方法参考论坛帖子 iOS修改entitlements文件

配送参数如下：

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

setApiUrl

设置apiUrl

setApiUrl(params,callback(ret))

params

apiUrl:

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
var params = {
  apiUrl:''
};
ezWifiConfig.setApiUrl(params);

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

​

setAccessToken

设置开放平台accessToken，用于设备配网状态

setAccessToken(params)

params

accessToken:

  • 类型：字符串类型
  • 描述：accessToken

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
var params = {
  accessToken:''
};
ezWifiConfig.setAccessToken(params);

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

requestConfigToken

获取配网token

requestConfigToken(params,callback(ret,err))

params

accessToken:

  • 类型：字符串类型
  • 描述：accessToken

callback(ret,err)

ret:

  • 类型：JSON对象
  • 描述：扫描结果；
  • 内部字段：
{
  status:true, //布尔类型；是否成功
    tokenInfo:{  //json对象；
      userId:'',  //字符串类型；userId
      token:'',  //字符串类型；token
      lbsDomain:'',  //字符串类型；lbsDomain
    },
    msgInfo:{}.   //json对象；msgInfo
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code: 0,         //数字类型；错误码
    msg: ''          //字符串类型；错误信息说明
}

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
var params = {
  accessToken:''
};
ezWifiConfig.requestConfigToken(params,function(ret,err) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

startWifiConfigWithWifiSsid

WiFi配网接口。请确保手机与设备处在同一网络环境下，声波配网时将音量调到最大，用以提高配网成功率

startWifiConfigWithWifiSsid(params,callback(ret,err))

params

wifiSsid:

  • 类型：字符串类型
  • 描述：WiFi的名称

wifiPwd:

  • 类型：字符串类型
  • 描述：WiFi的密码

deviceSerial:

  • 类型：字符串类型
  • 描述：设备序列号，序列号为空则为批量配网

mode:

  • 类型：数字类型
  • 描述：（可选项）配网模式，0：smart config，1：sonic config
  • 默认：0

callback(ret,err)

ret:

  • 类型：JSON对象
  • 描述：扫描结果；
  • 内部字段：
{

  ret:true, //布尔类型；开启配网是否成功
  status:true, //布尔类型；配网是否成功
  configStatus:0,//数字类型;配网设备状态
                       //取值如下：
                       //0：设备正在连接WiFi
                       //2：设备注册平台成功
                       //3：设备配网失败
  deviceSerial:'',//字符串类型;设备序列号
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code: 0,         //数字类型；错误码
    msg: ''          //字符串类型；错误信息说明
}

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
var params = {
  wifiSsid:'',
  wifiPwd:'',
  deviceSerial:''
};
ezWifiConfig.startWifiConfigWithWifiSsid(params,function(ret,err) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

stopWifiConfig

停止配网，配网结束后需调用

stopWifiConfig()

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
ezWifiConfig.stopWifiConfig();

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

startAPWifiConfigWithWifiName

AP配网接口，请确保已连接至设备热点

startAPWifiConfigWithWifiName(params,callback(ret,err))

params

wifiSsid:

  • 类型：字符串类型
  • 描述：WiFi的名称

wifiPwd:

  • 类型：字符串类型
  • 描述：WiFi的密码

deviceSerial:

  • 类型：字符串类型
  • 描述：设备序列号

verifyCode:

  • 类型：字符串类型
  • 描述：设备验证码

callback(ret,err)

ret:

  • 类型：JSON对象
  • 描述：扫描结果；
  • 内部字段：
{

  ret:true, //布尔类型；开启配网是否成功
  status:true, //布尔类型；配网是否成功
  configStatus:0,//数字类型;配网设备状态
                       //取值如下：
                       //0：设备正在连接WiFi
                       //2：设备注册平台成功
                       //3：设备配网失败
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code: 0,         //数字类型；错误码
    msg: ''          //字符串类型；错误信息说明
}

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
var params = {
  wifiSsid:'',
  wifiPwd:'',
  deviceSerial:'',
  verifyCode:''
};
ezWifiConfig.startAPWifiConfigWithWifiName(params,function(ret,err) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

stopAPWifiConfig

停止AP配网，配网结束后需调用

stopAPWifiConfig()

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
ezWifiConfig.stopAPWifiConfig();

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

startNewApConfigWithToken

开始NewAP配网（需连接设备热点）

startNewApConfigWithToken(params,callback(ret,err))

params

token:

  • 类型：字符串类型
  • 描述：配网token

ssid:

  • 类型：字符串类型
  • 描述：WiFi ssid

password:

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

lbsDomain:

  • 类型：字符串类型
  • 描述：lbs 域名

callback(ret,err)

ret:

  • 类型：JSON对象
  • 描述：扫描结果；
  • 内部字段：
{

  ret:true, //布尔类型；开启配网是否成功
  status:true, //布尔类型；配网是否成功
  configStatus:0,//数字类型;配网设备状态
                       //取值如下：
                       //104：连接成功
                       //105：未知错误
                       //106：密码错误
                       //201：未找到wifi热点
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code: 0,         //数字类型；错误码
    msg: ''          //字符串类型；错误信息说明
}

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
var params = {
  token:'',
  ssid:'',
  password:'',
  lbsDomain:''
};
ezWifiConfig.startNewApConfigWithToken(params,function(ret,err) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统

可提供的1.0.0及更高版本

getAccessDeviceInfo

获取设备状态（需连接设备热点）

getAccessDeviceInfo(callback(ret,err))

callback(ret,err)

ret:

  • 类型：JSON对象
  • 描述：扫描结果；
  • 内部字段：
{
  status:true, //布尔类型；是否成功
  devInfo:{  //json对象；
      apVersion:'',  //字符串类型；版本，当前ap版本1.0
      devSubserial:'',  //字符串类型；设备序列号，最大64
      devType:'',  //字符串类型；设备型号，最大64
      devFirmwareversion:'',  //字符串类型；设备固件版本号，最大64
      macAddr:'',  //字符串类型；设备mac地址
    },
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code: 0,         //数字类型；错误码
    msg: ''          //字符串类型；错误信息说明
}

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
ezWifiConfig.getAccessDeviceInfo(function(ret,err) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

getAccessDeviceWifiList

获取设备当前周边WiFi列表，上限20个（需连接设备热点）

getAccessDeviceWifiList(callback(ret,err))

callback(ret,err)

ret:

  • 类型：JSON对象
  • 描述：扫描结果；
  • 内部字段：
{
  status:true, //布尔类型；是否成功
  wifis:[{  //json数组；
      ssid:'',  //字符串类型；SSID
      signalStrength:0,  //数字类型；信号强度
      securityMode:'',  //字符串类型；安全模式: "open,WEP,WPA-personal,WPA2-personal,WPA-WPA2-personal,WPA2-enterprise"
    }]
}

err：

  • 类型：JSON 对象
  • 内部字段：
{
    code: 0,         //数字类型；错误码
    msg: ''          //字符串类型；错误信息说明
}

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
ezWifiConfig.getAccessDeviceWifiList(function(ret,err) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统，android系统

可提供的1.0.0及更高版本

getVersion

获取sdk版本信息

getVersion(callback(ret))

callback(ret)

ret:

  • 类型：JSON对象
  • 描述：扫描结果；
  • 内部字段：
{
   version:'',  //字符串类型；版本信息
}

示例代码

var ezWifiConfig = api.require('ezWifiConfig');
ezWifiConfig.getVersion(function(ret) {
    api.alert({ msg:JSON.stringify(ret)});
});

可用性

iOS系统

可提供的1.0.0及更高版本

是否仍需要帮助？ 请保持联络！
最后更新于 2024/04/24