檢測設備升級任務
請求方式:
GET
URL:http://ota.heclouds.com/ota/south/check
設備處於“待升級”,“下載中”,“升級中”狀態時,使用此API可以返回任務信息。
我只想看示例!!!
http頭部
參數名稱 |
格式 |
是否必須 |
說明 |
Content-Type |
string |
是 |
必須為application/json |
Authorization |
string |
是 |
安全鑒權信息 |
http 請求參數
參數名稱 |
格式 |
是否必須 |
說明 |
dev_id |
long |
是 |
設備Id |
manuf |
string |
是 |
廠商名稱,見附表 |
model |
string |
是 |
模組型號,見附表 |
type |
int |
是 |
任務類型,1代表FOTA任務,2代表SOTA 任務 |
version |
string |
是 |
版本信息 |
cdn |
boolean |
是 |
設備支援功能變數名稱解析請選擇true,若設備不支援功能變數名稱解析請選擇false |
返回參數
參數名稱 |
格式 |
說明 |
errno |
int |
調用錯誤碼,詳見錯誤碼說明 |
error |
string |
錯誤描述,為"succ"表示調用成功 |
data |
json |
介面調用成功之後返回的設備相關信息,見data描述表 |
data描述表
參數名稱 |
格式 |
說明 |
target |
string |
升級任務的目標版本 |
token |
string |
文件地址ip:port/ota/download/{token} |
size |
int |
文件大小 |
signal |
int |
任務在大於該信號下進行 |
power |
int |
任務在大於該電量下進行 |
retry |
int |
重試次數 |
interval |
int |
重試間隔 |
md5 |
string |
升級檔的md5碼 |
ipPort |
string |
拉取升級包的ip地址 |
type |
int |
1:完整包,2:差分包 |
SOTA的廠商、模組對照表
晶片平台 |
晶片型號: |
廠商編號 |
晶編號 |
樂鑫 |
ESP32 |
101 |
10101 |
nordic |
nrf52832 |
102 |
10201 |
兆易 |
GD32 |
103 |
10301 |
其他 |
其他 |
100 |
10001 |
FOTA的廠商、模組對照表
廠商名稱 |
模組型號 |
廠商編號 |
模組編號 |
中國移動 |
M5330-A |
001 |
00101 |
中國移動 |
M5330 |
001 |
00102 |
中國移動 |
M5312 |
001 |
00103 |
中國移動 |
M5313 |
001 |
00104 |
中國移動 |
S5601 |
001 |
00105 |
中國移動 |
M5310-A |
001 |
00106 |
中國移動 |
M5310 |
001 |
00107 |
中國移動 |
M5311 |
001 |
00108 |
中國移動 |
M5330-GNSS |
001 |
00109 |
中國移動 |
M5330-STD |
001 |
00110 |
零零智能 |
N256 |
002 |
00201 |
利爾達 |
NB86-G |
003 |
00301 |
利爾達 |
NB08-01 |
003 |
00302 |
u-blox |
SARA-N200 |
004 |
00401 |
銳捷網路 |
RG-NB6118 |
005 |
00501 |
銳捷網路 |
RG-NB6210 |
005 |
00502 |
上海穩恒 |
WH-NB71 |
006 |
00601 |
上海穩恒 |
WH-NB73 |
006 |
00602 |
信位通訊 |
SN12_B8 |
007 |
00701 |
中興通訊 |
ZM8300 |
008 |
00801 |
中興通訊 |
ZM8301 |
008 |
00802 |
有方科技 |
N20 |
009 |
00901 |
普創天信 |
T1 |
010 |
01001 |
普創天信 |
T101 |
010 |
01002 |
普創天信 |
T106 |
010 |
01003 |
桑銳電子 |
NH01A |
011 |
01101 |
芯訊通 |
SIM7000C |
012 |
01201 |
芯訊通 |
SIM7000C-N |
012 |
01202 |
芯訊通 |
SIM7020C |
012 |
01203 |
芯訊通 |
SIM7030 |
012 |
01204 |
移柯通信 |
L620 |
013 |
01301 |
移遠通信 |
BC28 |
014 |
01401 |
移遠通信 |
BC68 |
014 |
01402 |
廠商名稱 |
模組型號 |
廠商編號 |
模組編號 |
移遠通信 |
BC35-G |
014 |
01403 |
移遠通信 |
BC95-G |
014 |
01404 |
移遠通信 |
BC26 |
014 |
01405 |
移遠通信 |
BC95-B8 |
014 |
01406 |
雲程科技 |
CFB-608-B8 |
015 |
01501 |
雲程科技 |
CFB-609 |
015 |
01502 |
騏俊物聯 |
ML5530 |
016 |
01601 |
廣和通 |
N700-CN |
017 |
01701 |
東信和平 |
NBM20 |
018 |
01801 |
吳通集團 |
WT208 |
019 |
01901 |
高新興物聯 |
ME3616 |
020 |
02001 |
新華三 |
IM2209 |
021 |
02101 |
中科聯合 |
CT-M201 |
022 |
02201 |
中科聯合 |
CT-M202 |
022 |
02202 |
四川愛聯 |
AI-NB15 |
023 |
02301 |
九聯科技 |
UNB100-G |
024 |
02401 |
朝歌科技 |
S-ModNB00A |
025 |
02501 |
小瑞科技 |
N100 |
026 |
02601 |
中怡數寬 |
TPB23 |
027 |
02701 |
中怡數寬 |
TPB40-8 |
027 |
02702 |
中怡數寬 |
TPB41 |
027 |
02703 |
光寶科技 |
WNB301H |
028 |
02801 |
歐智通 |
3115F-R |
029 |
02901 |
龍尚科技 |
A9600-R2 |
030 |
03001 |
靈慧科技 |
LT150 |
031 |
03101 |
其他 |
其他 |
000 |
00001 |
錯誤碼說明
錯誤碼 |
說明 |
0 |
設備存在升級任務,token值為檔映射路徑(設置有效期,詳情見設計文檔),token有效期2天。 |
1 |
鑒權失敗(當設備不存在時)。 |
2 |
請求參數錯誤。 |
7 |
OneNET內部錯誤。 |
8 |
檢測失敗,設備存在升級任務,但是因為manuf或者model不一致,會將任務進入失敗狀態。 |
9 |
檢測失敗,設備存在升級任務,但是因為version不一致導致任務進入失敗狀態(差分包升級才有此流程)。 |
11 |
沒有檢測到升級任務,設備不存type(fota/sota)對應的升級任務。 |
27 |
版本號格式錯誤(版本號只能包括:[a-zA-Z0-9_\\-.],長度為[1,20])。 |
32 |
存在升級任務,但是沒有找到對應的差分包(在設備沒有上報版本號,頁面新建任務時使用初始版本:“無版本號”時可能出現該情況)。 |
說明
1、檢查任務時如果可以檢測到設備狀態(待升級,升級中)的任務,返回token等回應參數。
2、如果設備沒有升級的任務,會判斷是否存在自動添加策略,如果滿足自動添加策略,會給設備新增一個任務並返回任務信息。
3、請求參數version為設備當前版本號,這裡無論是否檢測到升級任務都會將version的值更新為設備在OneNET平台對應(fota/sota)的版本號。
請求參數示例
{
"dev_id": 6523,
"manuf": "中國移動",
"model": "M5310",
"type": 1,
"version":"1.2" ,
"signals": 10,
"powers":30,
"cdn": true
}
返回示例
{
"errno": 0,
"error": "succ",
"data": {
"target":"1.2",
"token":"ota_5hc95SFeo5xJEnaNrste",
"size":123,
"signal":12,
"power":90,
"retry":10,
"interval":90,
"md5":"dfkdajkfd",
"ipPort":"172.19.3.3",
"type":1
}
}