NAV
javascript

准备工作

  1. mqttws31.js

  2. usrCloud.js

接口说明

> USR_Init(初始化)

DEMO:

var usrCloud = new UsrCloud();
/*定义回调函数*/
var callback = {
/*注:':'号左侧为库中定义的名称,不可修改,右侧为自己定义的回调函数,可修改,与函数名称对应*/
USR_onConnAck: USR_onConnAck,
USR_onConnLost: USR_onConnLost,
USR_onSubAck: USR_onSubAck,
USR_onUnSubAck: USR_onUnSubAck,
USR_onPubAck: USR_onPubAck,
USR_onRcv: USR_onRcv
};
var code = usrCloud.Usr_Init(host, port, version, callback));

函数原型:
USR_Init(host, port, version, callback);

参数 描述
host 服务器地址[cloudapp.usr.cn]
port 端口[8080]
version 指定你想使用的版本号,必须 <= 函数USR_GetVer查询到的最高版本号,目前只能填 1。
callback 回调函数(USR_onConnAck: 连接回调,
USR_onConnLost: 连接断开回调,
USR_onSubAck: 订阅响应回调,
USR_onUnSubAck:取消订阅响应回调,
USR_onPubAck:发布成功回调,
USR_onRcv:接收数据回调)
返回值 描述
0 执行成功
1 参数错误
2 版本错误

> USR_GetVer(获取SDK版本)

DEMO:

var version = usrCloud.USR_GetVer();

函数原型:

USR_GetVer();

返回值 描述
number SDK版本号

> USR_Connect(建立连接)

DEMO:

var code=usrCloud.USR_Connect(username, password);

函数原型:

USR_Connect(username, password)

参数 描述
username 用户名
password 密码
返回值 描述
0 连接成功
1 用户名为空
2 密码为空
3 连接失败

> USR_DisConnect(断开连接)

DEMO:

usrCloud.USR_DisConnect();

函数原型:
USR_DisConnect()

> USR_Subscribe(订阅消息)

DEMO:

var code = usrCloud.USR_Subscribe(devId);

函数原型:
USR_Subscribe(devId)

参数 描述
devId 设备ID。指定要订阅哪个设备发来的消息。如果要订阅多个,请用逗号隔开;如果要订阅帐号下所有的设备的消息,请传入空。
返回值 描述
0 订阅成功
1 尚未建立连接
2 参数格式错误
3 已经订阅该设备

> USR_UnSubscribe(取消订阅)

DEMO:

var code = usrCloud.USR_UnSubscribe(devId);

函数原型:
USR_UnSubscribe(devId)

参数 描述
devId 设备ID。指定要订阅哪个设备发来的消息。如果要订阅多个,请用逗号隔开;如果要订阅帐号下所有的设备的消息,请传入空。
返回值 描述
0 取消订阅成功
1 尚未建立连接
2 参数格式错误
3 未订阅该设备

函数原型:
USR_Publish(devId, dataByte)

DEMO:

var code = usrCloud.USR_Publish(devId, dataByte);
参数 描述
devId 设备ID(只能填一个)
dataByte 发送数据(字节数组)
返回值 描述
0 发送成功
1 尚未建立连接
2 数据过长

定义具体的回调函数,声明位置见初始化

> USR_OnConnAck(连接回调)

DEMO:

var USR_onConnAck=function(event) {
/*连接成功*/
if (event.code===0) {
alert('连接成功');
} else {
/*连接失败*/
alert('连接失败');
}
}

触发条件:
执行USR_Connect后服务器返回连接成功标识时

返回值 描述
event code:返回码(0:连接成功,1:连接失败)
message:code为0时值为空,code为1时值为错误描述

> USR_onConnLost(连接断开回调)

DEMO:

var USR_onConnLost = function(event) {
alert('连接断开');
}

触发条件:
执行USR_DisConnect或异常断开时

返回值 描述
event message:断开信息

> USR_onSubAck(订阅响应回调)

DEMO:

var USR_onSubAck = function(event) {
/*订阅成功*/
if (event.code===0) {
alert('主题'+event.topic+'订阅成功');
} else {
/*订阅失败*/
alert("订阅失败:" + event.message);
}
}

触发条件:
订阅主题后服务器返回标识时

返回值 描述
event code返回码(0:订阅成功,1:订阅失败)
topic:主题
message:错误消息

> USR_onUnSubAck(取消订阅响应回调)

DEMO:

var USR_onUnSubAck = function(event) {
/*取消订阅成功*/
if (event.code===0) {
alert('主题'+event.topic+'取消订阅成功');
} else {
/*取消订阅失败*/
alert("取消订阅失败:" + event.message);
}
}

触发条件:
取消订阅主题后服务器返回标识时

返回值 描述
event code:返回码(0:取消订阅成功,1:取消订阅失败)
topic:主题
message:错误消息

> USR_onPubAck(发送成功回调函数)

DEMO:

var USR_onPubAck = function(event) {
alert('topic:'+event.topic +'payload' + UTF8ToString(event.payload ,0,event.payload.length) + '</li>');
}

触发条件:
发送成功数据后

返回值 描述
event topic:主题
payload:发送内容(字节数组)

> USR_onRcv(接收数据回调)

DEMO:

var USR_onRcv = function(event) {
var content = "";
content = UTF8ToString(event.payload, 0, event.payload.length);
alert('消息内容:'+content);
}
}

触发条件:
接收到服务器发送过来的消息时

返回值 描述
event topic:主题
payload:消息内容(字节数组)

更新历史

版本 日期 更新内容 更新人
1.0 2017-07-21 初版 林振男
asdf