device_status_list 设备状态列表
POST /api/v1/gnss/device_status_list
描述
获取设备状态列表接口,用于获取设备状态列表信息。信息包括:被选择的卫星接收机,定位信息, 连接卫星数量。 用于首页和卫星设置页面,显示卫星接收机的状态,需要获取卫星接收机的状态信息。
访问权限
具备以下权限:
gnss:device_status_list
JSON参数
请求参数如下 :
{"id"?: number}
id表示卫星接收机的编号,0表示第一个卫星接收机,1表示第二个卫星接收机,一般情况下最多两个卫星接收机。如果不传递id参数,表示获取全部的卫星接收机的状态信息。
请求示例:
{"id": 0}
响应结果
请求返回的HTTP状态码为200
返回结果为JSON格式的数据,您可以通过解析JSON数据来获取API调用的结果信息。结构如下:
{
"success": true|false,
"data": [
{
"id": number,
"status": "working"|"standby"|"offline",
"position": {
"latitude": string,
"longitude": string,
"altitude": number,
"hdop": number,
"vdop": number,
"pdop": number,
},
"utcDate": "yyyy-mm-dd",
"utcTime": "hh:mm:ss.sss",
"gpsLeapSecond": number,
"bdsLeapSecond": number,
"antStatus": "unknown"|"uninitialized"|"normal"|"open"|"short-circuited"|"not-support"|,
"ppsValid": "valid"|"invalid",
"signal": [
{
"type": "gps"|"glonass"|"bds"|"galileo",
"active": number,
"count": number,
},
{
"type": "gps"|"glonass"|"bds"|"galileo",
"active": number,
"count": number,
},
...
]
},
{
"id": number,
"status": "working"|"standby"|"offline",
"position": {
"latitude": string,
"longitude": string,
"altitude": number,
"hdop": number,
"vdop": number,
"pdop": number,
},
"utcDate": "yyyy-mm-dd",
"utcTime": "hh:mm:ss.sss",
"gpsLeapSecond": number,
"bdsLeapSecond": number,
"antStatus": "unknown"|"uninitialized"|"normal"|"open"|"short-circuited"|"not-support",
"indicatorValid": "valid"|"invalid",
"signal": [
{
"type": "gps"|"glonass"|"bds"|"galileo",
"active": number,
"count": number,
},
{
"type": "gps"|"glonass"|"bds"|"galileo",
"active": number,
"count": number,
},
...
]
},
],
"errorCode": "option string",
"errorMessage": "option string",
"showType": 0|1|2|4|9,
"traceId": "option string"
}
- id表示卫星接收机的编号,status表示卫星接收机的状态,取值为working表示工作中,standby表示待机中,offline表示离线。
- position表示卫星接收机的位置信息,latitude表示纬度,longitude表示经度,altitude表示海拔高度。hdop表示水平精度因子,vdop表示垂直精度因子,pdop表示位置精度因子。
- utcDate表示卫星接收机的UTC日期,utcTime表示卫星接收机的UTC时间。
- signal表示卫星接收机的卫星信号信息. type表示卫星类型,active表示是否激活,count表示卫星数量。
- gpsLeapSecond表示卫星报文中的GPS的闰秒,bdsLeapSecond表示卫星报文中的北斗的闰秒。
- antStatus表示天线状态,取值为unknown表示天线状态未知,uninitialized表示天线未初始化,normal表示天线正常,open表示天线开路,short-circuited表示天线短路,not-support表示不支持或未开启检测。
- ppsValid表示报文中pps有效标志位的值是否是有效,取值为valid表示有效,invalid表示无效。移远使用pps_valid,UBLOX使用A/V标志。
提示
如果没有卫星接收机时候,会因为权限不足,返回错误信息。错误码为40003,错误信息为gnss.no.device。当前用户信息是没有卫星接收机的权限的,可以预先利用权限进行判断。
正确结果示例:
{
"success": true,
"data": [
{
"id": 0,
"status": "working",
"position": {
"latitude": "31.2363'N",
"longitude": "121.4737'E",
"altitude": 0,
"hdop": 1.0,
"vdop": 1.0,
"pdop": 1.0,
},
"utcDate": "101024 042508.000",
"utcTime": "101024 042508.000",
"gpsLeapSecond": 18,
"bdsLeapSecond": 4,
"antStatus": "open",
"indicatorValid": "valid",
"signal": [
{
"type": "gps",
"active": 1,
"count": 10,
},
{
"type": "glonass",
"active": 1,
"count": 10,
}
]
},
{
"id": 1,
"status": "standby",
"position": {
"latitude": "31.2363'N",
"longitude": "121.4737'E",
"altitude": 0,
},
"signal": [
{
"type": "gps",
"active": 1,
"count": 10,
},
{
"type": "glonass",
"active": 1,
"count": 10,
}
]
}
]
}
错误结果示例:
{
"success": false,
"errorCode": "40000",
"errorMessage": "no.blank.params",
"showType": 4
}