機(jī)智云協(xié)議gagent產(chǎn)品規(guī)格書

1、產(chǎn)品規(guī)格機(jī)智- 1審核批準(zhǔn)產(chǎn)品名產(chǎn)品規(guī)格機(jī)智- 1審核批準(zhǔn)產(chǎn)品名產(chǎn)品型文版- 2修改時修改內(nèi)版修改備2014-11-創(chuàng)未發(fā)2014-11-團(tuán)后修未發(fā)- 2修改時修改內(nèi)版修改備2014-11-創(chuàng)未發(fā)2014-11-團(tuán)后修未發(fā)2014-12-與廣州團(tuán)后修訂，細(xì)節(jié)省發(fā)2014-12-參考Johnson 建議修發(fā)2014-12-增加softap的SDK 獲取描述 增加 2 小時連接服務(wù)器失敗，重啟模組增加 MQTT 錯誤字描述及處理增加錯誤字處理發(fā)2015-01-7.7Reset清空機(jī)制7.8 ProductKey 更改機(jī)制增加8.4 6）云端支持云連接信息7.1 1）細(xì)化發(fā)現(xiàn)機(jī)制修改2.2.1 增加

2、對接模組廠商的硬件版本號1.4 支持的協(xié)議信發(fā)產(chǎn)品簡產(chǎn)品名產(chǎn)品功系統(tǒng)結(jié)構(gòu)支產(chǎn)品簡產(chǎn)品名產(chǎn)品功系統(tǒng)結(jié)構(gòu)支持協(xié)模式定生產(chǎn)模配置模工作模產(chǎn)品基礎(chǔ)信產(chǎn)品形標(biāo)準(zhǔn)版本形二次開發(fā)版本形源碼形產(chǎn)品版本硬件版本版本Firmware 版本號(發(fā)布日期發(fā)布名硬件規(guī)模組狀態(tài)規(guī)指示W(wǎng)IFI 工作狀WIFI 信號強(qiáng)WIFI 信號上報原生產(chǎn)模配置模概工作模式（小循環(huán)發(fā)獲取SDK（APP）登- 1控制與狀模組和SDK心模組和MCU心控制與狀模組和SDK心模組和MCU心RESET 清空機(jī)PRODUCTKEY 更改機(jī)工作模式（大循環(huán)名字解模. 模組注模組. 模組登模組訂數(shù)據(jù)轉(zhuǎn)與M2M服務(wù)器心MQTT錯誤字處安全原故障恢日- 2中

3、文名：機(jī)智中文名：機(jī)智云WIFI通訊模塊無關(guān)，目前適用于WiFi 通訊模塊，部分功為各種智能硬件提供連接機(jī)智云的能力以及與硬件進(jìn)行可靠數(shù)據(jù)通訊的能力1.3. 系統(tǒng)結(jié)構(gòu)- 11.4. 標(biāo)準(zhǔn)接入?yún)f(xié)議之設(shè)備與云1.4. 標(biāo)準(zhǔn)接入?yún)f(xié)議之設(shè)備與云端通訊標(biāo)準(zhǔn)接入?yún)f(xié)議之MCU 與WiFi 模組通訊生產(chǎn)模用于產(chǎn)品大規(guī)模生產(chǎn)時的檢測場景，參考下文的生產(chǎn)模式詳1.5.2.配置模用戶第一次使用或者更改網(wǎng)絡(luò)配置的場景1.5.3.工作模產(chǎn)品正常工作時的場景標(biāo)準(zhǔn)版本形由機(jī)智云開發(fā)的模塊程序，二進(jìn)制文件形式提供，客戶可以直接進(jìn)行模塊生產(chǎn)和開發(fā)均由機(jī)智云完成，最穩(wěn)定的版本形態(tài)2.1.2.二次開發(fā)版本2.1.3.源碼形A見規(guī)說

4、明產(chǎn)品版本硬件版本硬件版本號用于區(qū)分硬管理，8 字節(jié)字符串描述，前兩個字節(jié)表示廠商信息，由機(jī)智分配6 個字節(jié)在此分廠版本，由各廠分配，每個字節(jié)可使用的字符為：0-9、a-z、A- 2版本版本號使用大中小版本格式，為XX：大版本，與協(xié)議V3 協(xié)議大版03版本版本號使用大中小版本格式，為XX：大版本，與協(xié)議V3 協(xié)議大版03，V4 協(xié)議大版本號04； YY：中版本lib 等相關(guān)00 遞增；ZZZZ：小版本，與各種兼容性需求相2.2.3.Firmware本號(發(fā)布日期Firmware 版本號用于描述發(fā)布的時間，共 8 字節(jié)的用日期和時間來描述格式為：年（2 位）月（2 位）日（2 位）時（2 24

5、小時格式比如：141125212014 GAgent Firmware 版本號時（第一次燒寫bin，數(shù)據(jù)區(qū)Flash 中無此數(shù)據(jù)，GAgent 默認(rèn)使用“000000002.2.4.云端OTA當(dāng)上傳一個升級固件時，云端完全匹配硬件版本號版本號去查D標(biāo)記為D 加1；Firmware 版本號對于云端判斷升級與否沒有作用，僅用于增強(qiáng)可讀性Firmware 版本號在Site OTA 字段信息是“發(fā)布日期2.3. 發(fā)布文件（或文件夾）n、硬件版本名稱、標(biāo)準(zhǔn)版本，發(fā)布bin 文件，比如3162 版本的某一個版本名稱為： 二次開發(fā)版本，發(fā)布工程文件夾，比如文件夾名稱 327009%電源要求：參考各模塊廠商規(guī)

6、格，通常為 工作電流：3.3V 電壓，平均工作電流小于 要求 GAgent的各種形態(tài)均使用相同的硬件規(guī)格；- 3指示說明：為了降低功耗，連接云端正常 10 分鐘，兩燈熄滅4.2WiFi如下工作狀態(tài)，并可將工作狀態(tài)同步到設(shè)備（MCU，指示說明：為了降低功耗，連接云端正常 10 分鐘，兩燈熄滅4.2WiFi如下工作狀態(tài)，并可將工作狀態(tài)同步到設(shè)備（MCU，要能上報的狀態(tài)如下SoftAP 模式；是否開啟 s ion 模式;WiFi 模組是否成功連接云端;WiFi 模塊連接的路由器信號強(qiáng)度發(fā)生變化，參見下文WiFi 信號強(qiáng)度是否有APP（客戶端）連接到模組 通訊v4.x.x.pdf4.3WiFi標(biāo)準(zhǔn)接入

7、協(xié)議之MCU 與WiFi WiFi 等級分7 個等0，最大80，7 個級別采用分段式，如下：當(dāng)GAgent 檢測到的WiFi 信號的變化范圍大10 以后，再去進(jìn)行信號強(qiáng)度的分類和上當(dāng)前值為 50，如果檢測出來 51，信號波動為 1，如果檢測到信號 59，信號波動為 9，都不會引起信別的重新計算，直到檢測出 60 或者 40，波動范圍大于等于 10 以后，再將新的信號強(qiáng)度計算級別，并上- 4序紅綠含1快閃（100 毫秒熄模組處于SoftAP 模2熄快模組處于AirLink 模3快閃（100 毫秒快閃（100 毫秒MCU 握手失4熄常模組獲和PASS，未連接到路由5常模組未獲和6常常模組成功接入

8、AP 但是還沒連接入7模組紅綠燈交叉閃爍，模組成功接入云4.4WiFi 信號上報原iFiiFi10WiFi 連接到路由器后，每3 分鐘掃描一次WiFi 熱點(diǎn)，獲取當(dāng)4.4WiFi 信號上報原iFiiFi10WiFi 連接到路由器后，每3 分鐘掃描一次WiFi 熱點(diǎn)，獲取當(dāng)前連接的路由器的信號質(zhì)量，按照原則進(jìn)行上5當(dāng)產(chǎn)品大規(guī)模生產(chǎn)時，需要解決快速檢產(chǎn)模做法如生產(chǎn)車間配備兩個檢測用路由器，路由器按照如下信息配置路由器一路由器二：GIZWITS_TEST_1；PASS: ：GIZWITS_TEST_2；PASS: ：上電時，由 MCU 主動發(fā)出產(chǎn)測命令，讓模組打開產(chǎn)測模式，打開產(chǎn)測模式時，模組每 1

9、0 秒搜索； 搜索出含有“GIZWITS_TEST_，判斷為生SionofP rinkbodngbidn；3 分鐘內(nèi)，搜不出含有GIZWITS_TEST_產(chǎn)測模當(dāng)前的工作狀態(tài)；使用2 APP 設(shè)備，分別連接兩個路由器進(jìn)行產(chǎn)測，自動搜索并發(fā)送測試指令；ofP 模SionirLnbodngbndi；車間配備兩臺檢測路由的原因是路由器需要定期重啟來清除已有連接信息，保證檢測正概WiFi 模塊支持四種配置方式，分別是 SoftAP、WebConfig、AirLink、測試要求配置成功率不低于 在配置重啟并且成功連接路由器后（不是上電重啟，WiFi 模塊在上電 30 秒內(nèi)發(fā)送配置成功包，每一秒一個包30

10、 次；SDK 收到此包后，認(rèn)為配置成功；熱點(diǎn)名稱：XPG-XX mac 地址后四位且大IP地址UDP 配置端打開SoftAP 模式的方用戶按某觸發(fā)鍵后，MCU 發(fā)送進(jìn)入指令WiFi 模塊中無保存的要信息，默認(rèn)打開SoftAP 模式- 5a) WiFi模塊收到了配置信息后關(guān)閉SoftAPb) 10分鐘未收到配置信息和webconfig （無網(wǎng)a) WiFi模塊收到了配置信息后關(guān)閉SoftAPb) 10分鐘未收到配置信息和webconfig （無網(wǎng)模串口事件路由器搜索功能SoftAP 模式下15 秒搜索一次當(dāng)前的路由器信息，包含：在SDK 獲取的時候立即返回；獲取i 不做字符轉(zhuǎn)義，保存到lah進(jìn)入

11、時設(shè)置當(dāng)前WiFi 模塊的狀態(tài)為打開SoftAP，并向MCU 同步WiFi 狀態(tài)退出時設(shè)置當(dāng)前WiFi 模塊的狀態(tài)為關(guān)閉SoftAP，并向MCU 同步WiFi 狀態(tài)；正確性檢查 登陸WiFi 或者PC 可以連接到WiFi 模塊，此時，使用瀏覽器、PASS、IP同SoftAP規(guī)格瀏覽器服務(wù)端口a、-、0（_（輸和PASS 最長32 字節(jié)收到配置信息后檢查（長度字符，不合法提示錯誤信息，合法后提示配置打開WebConfig 和退出WebConfig 的方法同SoftAP 規(guī)格指示燈和WiFiSoftAP時，按照SoftAP規(guī)格執(zhí)行；將配置信息保存到flash 后重啟模塊；不同的模塊提供的AirLi

12、nk 細(xì)節(jié)不同，WiFi 模塊調(diào)用廠商提供的系統(tǒng)接AirLink 模式； AirLink 包含SmartLink、EasyLink 等模塊廠商提供的快速配置方法；進(jìn)入方式用戶觸發(fā)某按鍵，按照協(xié)議發(fā)送進(jìn)入 AirLink 當(dāng)前狀態(tài)s ion，且成功連接路由器，不進(jìn)入AirLink；WiFi 模塊收到了配置信息后關(guān)閉AirLink 模式60 秒未收到配置信息后，關(guān)閉 AirLink 模式，嘗試恢復(fù)配置前的狀進(jìn)入時，設(shè)置當(dāng)前的WiFi 狀態(tài)為開啟onboarding，并向 MCU 同步WiFi 狀態(tài)；退出時，設(shè)置當(dāng)前的WiFi 狀態(tài)為關(guān)閉onboarding，并向 MCU 同步WiFi 狀態(tài)；Air

13、Kiss的快速配置標(biāo)準(zhǔn)需要廠商同時支持AirLink 和AirKiss；- 6工作模式（小循環(huán)發(fā) 現(xiàn)包，但是要相應(yīng)其他協(xié)議的（比如京東）發(fā)工作模式（小循環(huán)發(fā) 現(xiàn)包，但是要相應(yīng)其他協(xié)議的（比如京東）發(fā)現(xiàn)包，此 30 秒內(nèi)，模組可以不相應(yīng)機(jī)智云上包采取廣播，廣播地址：55，端收到SDK 發(fā)送的搜索包后，立即回復(fù)搜索相應(yīng)包；搜索的響應(yīng)，使用UDP 單播；包和搜索相應(yīng)包按照協(xié)議規(guī)定嚴(yán)格執(zhí)7.2模塊初始化后，自身隨機(jī)產(chǎn)生 Passcode，用于Passcode 10-32 個字節(jié)的隨機(jī)字符和APP 綁定的安全鑒令（進(jìn)入AirLink和SoftAP 等按照MCU 在握手過程中發(fā)送模組的bindable t

14、ime 開啟bind 功能；若模組當(dāng)前未處于bindable 狀態(tài)，獲取Passcode 的時候返回空的 7.3. SDK（APP）模塊本地使用TCP長連接與SDK建立通訊；模塊是服務(wù)端，SDK 是客戶端，模塊TCP端口是SDK 與模塊建立連接后，需要發(fā)Passcode，模塊Passcode 是否匹配，匹配后允許SDK 登陸和控制，否則只允許獲取Passcode，不接收心跳包等命令；7.4. 控制與狀模組采用透傳的策略將控制數(shù)據(jù)進(jìn)行轉(zhuǎn)發(fā)收到SDK 的控制命令時Hi 包頭替換成Hd 包頭后將數(shù)據(jù)發(fā)收到云端的控制命令時，將He Hi 包頭替Hd 包頭后將數(shù)據(jù)收到MCU 的主動狀態(tài)上報時，先回復(fù)AC

15、KHd 包頭Hi 發(fā)送給本地SDK，再添加包頭發(fā)送給當(dāng)收到 MCU 對某一個查詢命令的返回時，模塊僅將數(shù)據(jù)單獨(dú)回復(fù)給查詢命令發(fā)起者后將MCU 上報的狀態(tài)進(jìn)行廣播，包括服務(wù)器；7.5SDK 在連續(xù)4 秒未收到模組數(shù)據(jù)時，SDK 模塊發(fā)送心跳數(shù)據(jù)，模塊收到后返回心跳確認(rèn)SDK 連續(xù)12 秒收不到來自于模塊的數(shù)據(jù)（包含心跳和其他數(shù)據(jù)認(rèn)為與模塊連接失效，SDK 主動模塊連續(xù) 12 秒收不到來自于 SDK 的數(shù)據(jù)（包含心跳和其他數(shù)據(jù)認(rèn)為與 SDK 連接失效，模動斷開與模塊的連接；（漢楓的描述符個數(shù)限制，導(dǎo)試；短時間內(nèi)也無法使用，需要具體- 77.6MCU 心在連續(xù)55 秒沒有收到MCU 數(shù)據(jù)后，模MCU

16、 發(fā)送心跳數(shù)據(jù)，MCU 收到后返7.6MCU 心在連續(xù)55 秒沒有收到MCU 數(shù)據(jù)后，模MCU 發(fā)送心跳數(shù)據(jù)，MCU 收到后返回心跳確認(rèn)模組連續(xù) 180 秒收不到來自于 MCU 的數(shù)據(jù)（包含心跳和其他數(shù)據(jù)認(rèn)為串口通訊異常，模組自己MCU 連續(xù) 180 秒收不到來自于模組的數(shù)據(jù)（包含心跳和其他數(shù)據(jù)認(rèn)為串口通訊異常，將啟7.7Reset清空機(jī)需要清空保存的IP（如京東）的設(shè)備信息路由、路由器說明：不清空7.8.ProductKey 更改機(jī)需要清空FirmWare ；第（如京東）的設(shè)備信息工作模式（大循環(huán)DID：機(jī)智云給每一個設(shè)備分配的ID，字符串；22 字節(jié)； ProductKey：產(chǎn)品型號ID，

17、字符串；32 字節(jié)；Passcode：模組隨機(jī)生8.2模組需要在云議后，才能夠正常協(xié)議使用HTTP API 接口，參見模組與服務(wù)器當(dāng)模組無DID 時，按照協(xié)議向云端發(fā)時，需要給云端提ProductKey 和 除非reset，否則DID；失敗，模組獲取不到DID，不進(jìn)行剩余的云端交互8.3. 當(dāng)模組收到設(shè)備的 reset 指令后，需要將模組已有的DID 進(jìn)行注- 88.4模組獲取D 后，可向云端獲取2M獲取后到地址和端口后，可以進(jìn)行2M模組無默認(rèn)M2M 服務(wù)器地址和端口，無法獲8.4模組獲取D 后，可向云端獲取2M獲取后到地址和端口后，可以進(jìn)行2M模組無默認(rèn)M2M 服務(wù)器地址和端口，無法獲取時，

18、不進(jìn)行剩余云端操模組每次啟動都會進(jìn)行操作模組收到HTTP Server 9016 錯誤后，不注DID（passcode 錯誤，注銷會失敗、重新以下過程、登陸、訂閱；收到其他錯誤字后重新嘗試 過程模組從云端獲取此 ProductKey 是否需要連接云，以及云的關(guān)鍵字，模組根據(jù)關(guān)云適配（比如打開京東的發(fā)現(xiàn)、獲取 UUID 等功能8.5. 當(dāng)獲取到要登陸的M2M 服務(wù)器地址和端口后，模組發(fā)起向服務(wù)器的TCP 長連接，本過程無Timer模組按照協(xié)議向云端發(fā)起訂閱，訂閱全部完成后，模組的狀態(tài)設(shè)置成連接云端成功模組處理來自M2M 服務(wù)器的數(shù)據(jù)時，需要按照MQTT 協(xié)議去除He 包頭，此時數(shù)據(jù)與來自于本地A

19、PP 的數(shù)據(jù)完全相同，按照Hi+P0 數(shù)據(jù)格式處理；模組收到來自MCU 的程序后，如果需要發(fā)送給服務(wù)器，需按MQTT 協(xié)議增加He 包頭，發(fā)送給 M2M 服務(wù)器；轉(zhuǎn)發(fā)規(guī)則具體參見協(xié)議8.8M2M 模組登陸 M2M 服務(wù)器成功后，在連續(xù) 55 秒未收到服務(wù)器數(shù)據(jù)時，向服務(wù)器發(fā)送心跳，服務(wù)器收到模組連續(xù) 120 秒沒有收到服務(wù)器的數(shù)據(jù)時，認(rèn)為與 M2M 服務(wù)器的連接異常，斷開服務(wù)器連接，繼續(xù)使用M2M 服務(wù)器地址和端口進(jìn)行重連；模組與 M2M 服務(wù)器的連接異常斷開后，重連服務(wù)器時采取遞增策略，即斷開后立即重連服務(wù)器，仍失敗后，等待 10 秒，再次連接，若仍失敗，等待 10*2 秒后嘗試，依此類推，

20、每次重連失敗后都延長10 秒后再重連；嘗試10次仍然失敗時，重Provi 嘗試連接2 小時仍然失敗時，為防失效等異常，模組重啟如客戶端重啟后，按照正常流程從 0 秒延遲開始連接服務(wù)器8.9MQTT 錯誤字處錯誤字處理：正常運(yùn)行錯誤字含義：MQTT 協(xié)議版本號不對，目前支持MQTT 3.1；一般不會有這個問題，除非使用了- 9版本的MQTTC ntb) 處理：不重新錯誤字0 x02a) 含義、按照重連服務(wù)器機(jī)制進(jìn)行C ntIdentifier長度不對，允許的長度范圍應(yīng)是123B C nt Identifier 已被使用。一般這種情況只版本的MQTTC ntb) 處理：不重新錯誤字0 x02a) 含義、按照重連服務(wù)器機(jī)制進(jìn)行C ntIdentifier長度不對，允許的長度范圍應(yīng)是123B C nt Identifier 已被使用。一般這種情況只會出現(xiàn)在連接的情況。如是設(shè)備使用的C nt Identifier 連接，會踢前一個ses下線而不會報這個錯誤（設(shè)備是使用DID作為C nt Ifentifier 的值。b) 處理：不重新錯誤字0 x03含義：服務(wù)不可用，機(jī)智云 M2M 服務(wù)器不會向客戶端報這個錯誤錯誤字0 x04、按照重連服務(wù)器機(jī)制進(jìn)行a) （或DID/Passcode）不正確。對設(shè)備來說，也有可能