網關相關接口對接指南

通通鎖智能門鎖本身不聯網,只能通過藍牙連接與外界通迅,網關是一個可以聯網的小設備,使遠程管理智能鎖成為可能。

網關添加好後會自動搜索其附近的鎖,如果搜索到的鎖和網關屬於同一個管理員帳號,網關服務器會保存網關和鎖之間的連接關系,鎖和網關是多對多的關系,允許一個網關連接多個鎖,鎖也可以連接多個網關,沒有數量限制,後續用戶想遠程操作鎖,系統會自動選擇藍牙連接信號強度最好的網關下發操作指令。

1、網關的初始化

開發者可以先使用通通鎖APP添加網關,G2網關請參考說明文檔:G2網關添加說明

也可以自己開發APP集成我們的APP SDK來實現網關的初始化,具體參考APP SDK網關接口示例,初始化網關時需要傳用戶主鍵ID和密碼以標識網關歸屬的用戶,其中的用戶主鍵ID在獲取訪問令牌時會返回,也可以通過雲端獲取用戶主鍵ID接口獲取。

(1)APP SDK完成網關的初始化配置,如果配置的網路正確,網關會自動連接網關服務器,完成在雲端的初始化。

(2)調用雲端查詢某網關是否初始化成功接口確認網關已經成功在雲端完成初始化,初始化成功會返回gatewayId

(3)調用雲端上傳網關信息接口上傳網關的固件版本信息和網路名稱,方便後續網關固件升級和維護。

網關添加成功後,可以通過獲取名下網關列表接口查詢到。

2、網關與鎖的連接

不需要用戶去手動關聯。

網關初始化完成即會自動搜索附近的鎖,如果搜索到的鎖和網關屬於同一個管理員帳號,就會自動關聯上,所以請確保鎖和網關是用同一個帳號添加的。

可以通過獲取網關管理的鎖列表獲取鎖連接的網關列表兩個接口查詢鎖和網關之間的關聯關系和信號強度。

當向鎖發起遠程操作時,系統會選擇信號強度最好的網關下發操作指令。

3、連接網關後支持哪些遠程操作?

鎖連接上網關後,很多鎖管理工作就不需要再到鎖邊上通過藍牙連接來執行了,可以通過網關遠程下發指令給鎖,如開鎖、閉鎖,查詢鎖的開關狀態,管理(增、刪除、改)密碼,管理IC卡,管理指紋,查詢鎖電量、查詢和校準鎖時間等。

鎖連接上網關後,不再需要到鎖邊上去讀取操作記錄,開鎖記錄也會自動通過網關準實時(一般幾秒鐘內)的上傳到雲端,在通通鎖APP上的鎖管理員會收到開鎖的推送消息,開放平台也支持將記錄實時推送給開發者,參考文檔:鎖記錄回調通知

4、遠程操作耗時過長和失敗的原因

通過網關執行遠程操作,網關需要和鎖之間建立藍牙連接通訊,這個過程一般需要幾秒鐘時間,網關和鎖之間的藍牙連接信號強度越弱,耗時會越長,甚至有失敗的可能性。通訊過程中藍牙連接被打斷(如觸碰到面板等)也會導致耗時增加甚至操作失敗。

網關遠程操作請求時間可能會很長,雲端設置的超時時間是30秒,建議開發者調用遠程指令下發相關接口的請求也設置30秒的超時時間。有些開發者設置10秒超時,會有可能收不到請求反饋判定請求失敗,但指令已經下發成功。

網關和鎖同一時間都只能建立一個藍牙連接,網關只能串行執行遠程操作指令,如果網關當前正在執行遠程操作,再用該網關發起遠程操作則會直接返回失敗。