公版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:“字符串型的錯誤信息 } }