X-Link API DocumentDevice upgrade
Device upgrade management supports offline send and batch send. Immediate send only supports online device. After the task is execute, call [Get Upgrade Status API] (#./api1) to get the detailed upgrade status. It is recommended to call it once more than 10 seconds
Request parameter
| filed | type | required | desc |
|---|---|---|---|
| vehicleNos | array(string) | Yes | Plat No. list |
| immediate | bool | No | Immediate send to device,only support online device |
| upgradeType | integer | Yes | Upgrade type,1:XL:Self protocol,2:XL HTTP URL(not support),3:XL HTTP File name(not support) |
| xlSelfInfo | object | No | XL Upgrade request info ,upgrade type is 1 valid,refer table1 |
| httpUpgradeInfo | string | No | Http upgrade info, upgrade type is 2,3 valid |
| upgradeCondition | object | No | Upgrade condition,Only when the conditions are met can the upgrade be triggered,immediate:false valid,refer table 2 |
Table 1: XL Upgrade request info
| filed | type | required | desc |
|---|---|---|---|
| fileName | string | Yes | File name,need suffix |
| serverIP | string | Yes | Upgrade server IP |
| serverPort | integer | Yes | Upgrade server Port |
Table 2: Upgrade condition
| filed | type | required | desc |
|---|---|---|---|
| netSignal | integer | No | Net Signal Type,0:All,1:Good or above,2:Best or above |
| speed | integer | No | What is the current speed greater than before starting the upgrade,0:No limit,unit: KM/H |
| accStatus | integer | No | ACC Status,0:All,1:ACC ON,2:ACC OFF |
Response Data (Type:array(string))
Fail plate no. list
Example
Request example
json
http://localhost:8080/web_api/v1/dev_manage/dev_upgrade
{
"vehicleNos": ["1300000001","1300000002"],
"upgradeType":1,
"immediate":false,
"xlSelfInfo":{
"serverPort": 30000,
"serverIP":"127.0.0.1",
"fileName":"S51_V1.0.0.img"
},
"upgradeCondition":{
"netSignal":0,
"speed":0,
"accStatus":0
}
}http://localhost:8080/web_api/v1/dev_manage/dev_upgrade
{
"vehicleNos": ["1300000001","1300000002"],
"upgradeType":1,
"immediate":false,
"xlSelfInfo":{
"serverPort": 30000,
"serverIP":"127.0.0.1",
"fileName":"S51_V1.0.0.img"
},
"upgradeCondition":{
"netSignal":0,
"speed":0,
"accStatus":0
}
}Response example
json
{
"hdr":{
"code":200,
"message":"success"
},
"data":["1300000001"] // Response fail Plate No. list
}{
"hdr":{
"code":200,
"message":"success"
},
"data":["1300000001"] // Response fail Plate No. list
}Get Upgrade Status API
Regularly call this interface to obtain upgrade status. It is recommended to call it every 10 seconds or more
API info
Url: /web_api/v1/dev_manage/get_dev_upgrade_progress
Method: POST
Content-Type:application/json
Request parameter
| field | type | required | desc |
|---|---|---|---|
| vehicleNos | array(string) | Yes | Plate No. list |
Response Data (type:array(object))
| field | type | desc |
|---|---|---|
| createTime | integer | Create time |
| startTime | integer | Start time |
| endTime | integer | End time |
| upgradeStatus | integer | Upgrade status,1:wait start;2:downloading;3:upgrading;4:upgrade success;10:upgrade fail;11:download file fail;12:connect upgrade server fail;13:upgrade file error;14:device not support;15:upgrade timeout |
| progress | integer | Progress,0-100 |
| UpgradeBaseInfo | object | Upgrade base info, refer table 3 |
Table 3: Upgrade base info
| field | type | desc |
|---|---|---|
| vehicleGuid | integer | Vehicle ID |
| deviceNo | string | Device number |
| vehicleNo | string | Plat No. |
| upgradeType | integer | Upgrade type,1:XL:Self protocol,2:XL HTTP URL(not support),3:XL HTTP File name(not support) |
| xlSelfInfo | object | XL upgrade request info ,upgrade type is 1 valid,refer table1 |
| httpUpgradeInfo | string | Http upgrade info, upgrade type is 2,3 valid |
| upgradeCondition | object | Upgrade condition,Only when the conditions are met can the upgrade be triggered,immediate:false valid,refer table 2 |
Example
Request example
json
http://localhost:8080/web_api/v1/dev_manage/get_dev_upgrade_progress
{
"vehicleNos": ["1300000001","1300000002"]
}http://localhost:8080/web_api/v1/dev_manage/get_dev_upgrade_progress
{
"vehicleNos": ["1300000001","1300000002"]
}Response example
json
{
"hdr":{
"code":200,
"message":"success"
},
"data":[{
"createTime":1703676981,
"startTime":1703676981,
"endTime":1703677000,
"upgradeStatus":3,
"progress":50,
"UpgradeBaseInfo":{
"vehicleGuid":1,
"deviceNo":"1300000001",
"vehicleNo":"1300000001",
"upgradeType":1,
"xlSelfInfo":{
"serverPort": 30000,
"serverIP":"127.0.0.1",
"fileName":"S51_V1.0.0.img"
},
"httpUpgradeInfo":"",
"upgradeCondition":{
"netSignal":0,
"speed":0,
"accStatus":0
}
}
},{
"createTime":1703676981,
"startTime":1703676981,
"endTime":1703677000,
"upgradeStatus":3,
"progress":50,
"UpgradeBaseInfo":{
"vehicleGuid":1,
"deviceNo":"1300000002",
"vehicleNo":"1300000002",
"upgradeType":1,
"xlSelfInfo":{
"serverPort": 30000,
"serverIP":"127.0.0.1",
"fileName":"S51_V1.0.0.img"
},
"httpUpgradeInfo":"",
"upgradeCondition":{
"netSignal":0,
"speed":0,
"accStatus":0
}
}
}]
}{
"hdr":{
"code":200,
"message":"success"
},
"data":[{
"createTime":1703676981,
"startTime":1703676981,
"endTime":1703677000,
"upgradeStatus":3,
"progress":50,
"UpgradeBaseInfo":{
"vehicleGuid":1,
"deviceNo":"1300000001",
"vehicleNo":"1300000001",
"upgradeType":1,
"xlSelfInfo":{
"serverPort": 30000,
"serverIP":"127.0.0.1",
"fileName":"S51_V1.0.0.img"
},
"httpUpgradeInfo":"",
"upgradeCondition":{
"netSignal":0,
"speed":0,
"accStatus":0
}
}
},{
"createTime":1703676981,
"startTime":1703676981,
"endTime":1703677000,
"upgradeStatus":3,
"progress":50,
"UpgradeBaseInfo":{
"vehicleGuid":1,
"deviceNo":"1300000002",
"vehicleNo":"1300000002",
"upgradeType":1,
"xlSelfInfo":{
"serverPort": 30000,
"serverIP":"127.0.0.1",
"fileName":"S51_V1.0.0.img"
},
"httpUpgradeInfo":"",
"upgradeCondition":{
"netSignal":0,
"speed":0,
"accStatus":0
}
}
}]
}