网关业务

本文介绍了网关业务相关的接口。

API 列表

函数名称	功能描述
user_svc_init	网关初始化
oem_set	设置 OEM 模式（需要固件支持）
gen_gw_attr	设置网关属性
iot_sdk_pre_init	网关预初始化
iot_wired_wf_sdk_init	有线和无线 IoT SDK 初始化
iot_wf_sdk_init	无线配网初始化
iot_sdk_reg_net_stat_cb	设置网络状态监听
user_svc_start	启动网关业务
gw_supprot_wired_wifi	获取 SDK 是否支持有线+无线配网模式
iot_sdk_init	IoT SDK 初始化
gw_dev_report_dp_stat_sync_extend	上传 DP 信息
iot_get_gw_id	获取网关 ID
native_upgradeDownload	开始升级
gw_user_token_bindnd	设置 Token 绑定
gwResetCallBack	网关重置回调
gwRebootCallBack	网关重启回调
onUpgradeInfo	sdk 接收到后端的升级推送的时候，会触发此接口附带升级信息
onUpgradeDownloadStart	升级文件开始下载
onUpgradeDownloadUpdate	升级文件下载进度
upgradeFileDownloadFinished	SDK 下载升级文件下载完成触发此接口
gwActiveUrlCallBack	网关配网回调
gwActiveStatusCallBack	网关激活状态回调
onGetIP	返回当前网卡的 IP
isOffline	返回是否网关离线
getNwkStatCallBack	有线网络状态回调
getWifiNwkStatCallBack	无线网络状态回调

API 说明

user_svc_init

函数原型

fun user_svc_init(gwListener: GwListener.GwInfraListener): Int

功能说明

网关初始化

参数说明

参数名称	说明
gwListener	网关操作回调

返回值

返回值	说明
0	成功
非 0	失败

oem_set

函数原型

external fun oem_set()

功能说明

设置 OEM 模式（需要固件支持）。

gen_gw_attr

函数原型

fun gen_gw_attr(userModelList: List<UserModel>)

功能说明

设置网关属性。

参数说明

参数名称	说明
userModelList	usermodel 数组

iot_sdk_pre_init

函数原型

external fun iot_sdk_pre_init(): Int

功能说明

网关预初始化。

返回值

返回值	说明
0	成功
非 0	失败

iot_wired_wf_sdk_init

函数原型

fun iot_wired_wf_sdk_init(
        net_mode: DataEnum.IOT_GW_NET_TYPE_T,
        cfg: DataEnum.GW_WF_CFG_MTHD_SEL,
        start_mode: DataEnum.GW_WF_START_MODE,
        pid: String,
        version: String
    ): Int

功能说明

有线和无线 IoT SDK 初始化。

参数说明

参数名称	说明
net_mode	DataEnum.IOT_GW_NET_TYPE_T 类型
cfg	DataEnum.GW_WF_CFG_MTHD_SEL
start_mode	DataEnum.GW_WF_START_MODE
pid	productkey
version	版本号

返回值

返回值	说明
0	成功
非 0	失败

iot_wf_sdk_init

函数原型

fun iot_wf_sdk_init(
        cfg: DataEnum.GW_WF_CFG_MTHD_SEL, start_mode: DataEnum.GW_WF_START_MODE,
        pid: String, version: String
    ): Int

功能说明

无线配网初始化。

参数说明

参数名称	说明
cfg	DataEnum.GW_WF_CFG_MTHD_SEL
start_mode	DataEnum.GW_WF_START_MODE
pid	productkey
version	版本号

返回值

返回值	说明
0	成功
非 0	失败

iot_sdk_reg_net_stat_cb

函数原型

fun iot_sdk_reg_net_stat_cb(gwNwkStatusLsitener: GwListener.GwNwkStatusLsitener): Int

功能说明

设置网络状态监听

返回值

返回值	说明
0	成功
非 0	失败

user_svc_start

函数原型

external fun user_svc_start(): Int

功能说明

启动网关业务

返回值

返回值	说明
0	成功
非 0	失败

gw_supprot_wired_wifi

函数原型

external fun gw_supprot_wired_wifi(): Int

功能说明

获取 SDK 是否支持有线和无线配网模式。

返回值

返回值	说明
1	支持
0	不支持

iot_sdk_init

函数原型

external fun iot_sdk_init(pid: String, version: String): Int

功能说明

IoT SDK 初始化。

参数说明

参数名称	说明
pid	productkey
version	版本号

返回值

返回值	说明
0	成功
非 0	失败

gw_dev_report_dp_stat_sync_extend

函数原型

gw_dev_report_dp_stat_sync_extend

功能说明

上传 DP 信息。

参数说明

参数名称	说明
devId	设备 ID
dataPoint	DP 的集合
timeout	超时时间

返回值

返回值	说明
true	播放打开
false	播放关闭

iot_get_gw_id

函数原型

external fun iot_get_gw_id(): String

功能说明

获取deviceId

返回值

返回值	说明
deviceId	设备 ID

native_upgradeDownload

函数原型

external fun native_upgradeDownload(path: String)

功能说明

开始升级

参数说明

参数名称	说明
path	升级包下载路径

gw_user_token_bindnd

函数原型

fun gw_user_token_bindnd(token:String)

功能说明

设置 Token 绑定。

参数说明

参数名称	说明
token	token

返回值

返回值	说明
0	成功
非 0	失败

gwResetCallBack

函数原型

fun gwResetCallBack(type: DataEnum.GW_RESET_TYPE_E)

功能说明

网关重置回调。

参数说明

参数名称	说明
type	GW_RESET_TYPE_E

gwRebootCallBack

函数原型

fun gwRebootCallBack()

功能说明

网关重启回调。

onUpgradeInfo

函数原型

fun onUpgradeInfo(version: String)

功能说明

SDK 接收到后端的升级推送的时候，会触发此接口。

参数说明

参数名称	说明
version	版本号

onUpgradeDownloadStart

函数原型

fun onUpgradeDownloadStart()

功能说明

开始下载升级文件。

onUpgradeDownloadUpdate

函数原型

fun onUpgradeDownloadUpdate(progress: Int)

功能说明

升级文件下载进度。

参数说明

参数名称	说明
progress	进度（0~100）

upgradeFileDownloadFinished

函数原型

fun upgradeFileDownloadFinished(success: Boolean)

功能说明

SDK 下载升级文件下载完成时，会触发此接口。

参数说明

参数名称	说明
success	true：下载成功 false：下载失败

gwActiveUrlCallBack

函数原型

fun gwActiveUrlCallBack(url: String)

功能说明

网关配网回调

参数说明

参数名称	说明
url	二维码 URL

gwActiveStatusCallBack

函数原型

fun gwActiveStatusCallBack(status: DataEnum.GW_STATUS_E)

功能说明

网关激活状态回调。

参数说明

参数名称	说明
status	GW_STATUS_E

onGetIP

函数原型

fun onGetIP():String

功能说明

返回当前网卡的 IP。

返回值

返回值	说明
string	返回当前网卡的 IP

isOffline

函数原型

fun isOffline(): Boolean

功能说明

返回是否网关离线

返回值

返回值	说明
Boolean	true：离线 false：在线

getNwkStatCallBack

函数原型

fun getNwkStatCallBack(status: Int)

功能说明

有线网络状态回调

参数说明

参数名称	说明
status	0：离线 1：在线

getWifiNwkStatCallBack

函数原型

fun getWifiNwkStatCallBack(status: Int)

功能说明

无线网络状态回调

参数说明

参数名称	说明
status	0：离线 1：在线