公版App接入指南(JS SDK)
更新时间:2019-04-19
JSSDK是用来方便企业开发者用户 HTML5 页面接入超级 APP。主要实现的功能有:封装现有的公开的接 口,使用户能更方便调用平台开放的公开的接口,并且可以通过平台提供的本地调试服务器包,进行本地的数据接口调试,同 时预留调用手机传感器接口,能还用手机传感器做出更丰富的动画效果。
使用指南
1、下载 JSSDK
2、在 index.html 的 head 中导入 JSSDK。
3.在需要使用sdk的代码中,直接使用实例对象ITASDK
API简介
1、数据类接口名称
获取设备信息 | 发送控制命令 | 自定义报文 |
---|---|---|
getDeviceInfo | controlDevice | specialTagMethod |
ITASDK.dataSocket(key, body, { success: function(data){}, error: function(err){} });
参数:
参数名称 | 参数类型 | 参数值 |
---|---|---|
key | string | 需要使用的接口列表名 |
body | object | getDeviceInfo -> [“key”, “key”, ……] controlDevice -> {"key”: “value”, ……} specialTagMethod -> {"tag": "0000", "data":{"key":”value”, ……} |
回调函数中的 res 结果说明:
{ success: function(data) { //result:{key:value, key:value ……} }, error: function(err) { //result:{errorMsg: 错误信息} } }
2、与 APP 交互类接口
从h5 推出,返回app设备列表界面 | 进入h5设置状态栏颜色 | 显示app原生的滚轮插件 |
---|---|---|
popView | setStatusBarColor | showPickView |
ITASDK. apiModel (key, body, { success: function(data){}, error: function(err){} });
注意:(a)popView 接口无 body 和回调参数。(b)setStatusBarColor 接口无回调参数
参数名称 | 参数类型 | 参数值 |
---|---|---|
key | string | 需要使用的接口列表名 |
body | object | setStatusBarColor -> {background_color: "000000", color:
"white"} background_color 为状态栏背景颜色。color 为状态栏文字颜色,只有“white”和“black”这两种值。 注意:请杜绝使用浅色背景加白色文字或者深色背景加黑色文字,会有不好的用户体验 showPickView -> {roll: [[1, 2, 3], ……]} 采用数组嵌套数组的形式,内部的数组数量代表可选数值数量,最多支持一个 pickview 控件上同时存在三个可选数值 |
回调函数中的 res 结果说明(仅 showPickView 有返回):
{ success: function(data) { //result: {roll:[“1”, …]} }, error: function(err) { //result:{errorMsg: 错误信息} } }
3、蓝牙监听函数
ITABLE. Receive({ success: function(data){ }, error: function(err){ } });
返回的数据:
{ success: function(data) { //result: {key:value,key:value,……} }, error: function(err) { //result:“字符串型的错误信息 } }
4、移除蓝牙监听函数
调用方法:ITABLE.remove_Receive();
5、APP 端断开与设备的蓝牙连接
调用方法:ITABLE.close();
6、清空请求体数据
调用方法:ITABLE.clean();
7、将数据添加到请求体中
调用方法:ITABLE.append(key, length, value);
参数名称 | 参数类型 | 参数值 |
---|---|---|
key | string | 字符串型的 key 值 |
length | number | 整型的 v 的字节长度 |
value | String/number | Value 的值 |
8、通过蓝牙发送控制数据
ITABLE.send({ success: function(data){}, error: function(err){} });
返回的数据:
{ success: function(data) { //result: 以平台返回为准 }, error: function(err) { //result:“字符串型的错误信息 } }
9、通过蓝牙发送查询接口
ITABLE.getData(body, { success: function(data){}, error: function(err){} });
参数名称 | 参数类型 | 参数值 |
---|---|---|
body | array | [“key1”, “key2”, …] |
返回的数据:
{ success: function(data) { //result: {key1:value,key2:value, …} }, error: function(err) { //result:“字符串型的错误信息 } }