适用于搭载小安盒子的共享电单车、智能电动车控制与数据通信
\nagent： 每一个使用PaaS平台的个人和团体
agentId： agent的标识
xc-access-token： 访问接口的唯一凭证
测试agentId：87
**测试xc-access-token:**525511E04347F12AE6C5D74D705DD84A
接口调用时出现suc=false的业务错误
\n与设备进行通信的接口，在调用成功suc=true后会返回这次通信结果的code。
100110：网关服务器异常情况返回 : 设备异常情况返回
110
1000~ : 业务异常情况返回
接口全部使用HTTPS协议。\n每一个请求的header都必须有xc-access-token字段。
各个接口所列字段的透出与否(不涉及字段变更)和接入设备型号有关，调用方可根据接口实际返回字段确认。
实时接口访问频率阈值：30k/5分钟千台车(在线)
\n获取所有设备列表
\nimei:设备的15位唯一标识
\n{\n succcess:true,\n data:{\n total:146,\n devices:[{\n imei:868183030457282\n }]\n }\n}\n\n{\n succcess:false,\n error:{\n errormessage:\"\",\n promot:\"request params missing!\"\n }\n}\n服务端缓存最近一次上报的设备信息，用于查询加速。
\n设备有三种机制进行数据同步，即心跳包上报，GPS包上报，接受查询或设置命令时。
\n同步机制 | 同步周期 | 相关数据
--- | ---
心跳包 | 150s | 电压、信号强度
GPS包 | 5s/运动状态下，10min/静止状态下 | 经纬度，外设锁状态，设备状态
命令 | 立刻 | 命令涉及的数据
对于设备在线状态，由于设备与网关服务器的保活机制，设备登录网关服务器时立即判定为设备上线，而在设备与网关服务器失去连接5分钟后判定为离线。
\n{\n succcess:true,\n data:{\n imei: \"868183030457282\",\n isOnline: 1, \n gsmSignal: 23, \n defend: 1,\n acc: 0,\n lat: 30.51040856769523,\n lng: 114.43096840580687,\n batteryLock: 1,\n backWheelLock: 1,\n objectType: 41,\n voltage: 49240,\n version: 131088,\n isMoving: 0,\n imsi: \"880041107000000\"\n }\n}\n\n各个字段的含义：
imei：设备号
isOnline: 车辆在线状态，1：在线，0：离线
gsmSignal：信号强度
defend：车辆设防状态，1：已设防，0：已撤防
acc：电门状态，1：电门开，0：电门关
lat：纬度，gcj02格式
lng：经度，gcj02格式
batteryLock：电池锁，1：上锁状态，0：解锁状态
backWheelLock：后轮锁，1：上锁状态，0：解锁状态
objectType：设备型号
voltage：平滑后的车辆电池电压，单位：mV
version：设备固件版本号
isMoving：是否在移动，1：移动，0：静止
imsi: 卡imsi
lastGPSTimestamp: 最后一次定位时间 时间戳
\nlastLoginTimestamp：最近一次登录时间 时间戳
\n{\n succcess:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n\n与设备通信获取设备当前信息，接口响应时间较长，用于准确获取设备实时数据和状态的场景，如判断开车锁车状态，电池仓锁状态等。
\nimei:设备的15位唯一标识
\n{\n success: true,\n data: {\n code: 0,\n result: {\n autolock: {\n sw: 1,\n period: 5\n },\n battery: {\n percent: 0,\n type: 48,\n voltage: 240\n },\n voltageMv: 45663,\n GSMSignal: 23,\n gsm: 31,\n acc: 0,\n defend: 1,\n isBeep: 0,\n audioType: 7,\n pkeType: 1,\n gps: {\n timestamp: 1527930367,\n lat: 30.512766,\n lng: 114.425682,\n speed: 1,\n course: 87\n },\n wheelLock: 1,\n seatLock: 0,\n mode: 0,\n isWheelSpan: 0,\n powerState: 1,\n }\n }\n}\n各个字段的含义(字段是否存在与设备类型相关)：
code：查询信息的结果，详情参考错误码
autolock：自动设防状态，其中sw：1自动设防开启，sw：0自动设防关闭，period：自动设防时间
battery：电池信息，其中percent：剩余电量百分比，type：电池类型，voltage：电压值，单位：mv
voltageMv: 电压值，单位：mV
GSMSignal：信号强度
gsm: 信号强度
defend：设备设防状态，1：已设防，0：已撤防
acc：电门状态，1：电门开，0：电门关
isBeep：勿扰模式状态，1：开启，0：关闭
wheelLock： 后轮锁状态，1：已上锁，0：未上锁
seatLock: 后座锁状态，1：已上锁，0：未上锁
isWheelSpan: 后轮转动状态，1：转动中，0：静止
mode:设备工作模式
powerState: 电池连接状态，1：连接，0：未连接
audioType：当前语音类型
pkeType：PKE状态，1：开启，0：关闭
gps：gps定位信息,wgs84格式。若模块无法通过GPS定位，则不透出该字段，取而代之透出lbs或cell字段。timestamp(时间戳，单位：秒)，lat（纬度），lng（经度），speed（km/h），course（度°。其中正北为0，顺时针计算）。
cell:基站信息，若 GPS 已定位，该字段省略。mcc(mobile country code), mnc(mobile network code), lac(local area code), ci(cell id)。
lbs:通过基站定位得出的经纬度定位信息。wgs84格式。
{\n success:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n获取设备一段时间内的gps点，坐标为wgs84格式
\nstartTime 和endTime 均为时间戳。单位：秒
\n{\n \"success\": true,\n \"data\": [\n {\n \"lat\": 30.5114,\n \"lon\": 114.425667,\n \"timestamp\": 1528968201,\n \"speed\": 0,\n \"course\": 11\n },\n {\n \"lat\": 30.511604,\n \"lon\": 114.425522,\n \"timestamp\": 1528968201,\n \"speed\": 0,\n \"course\": 11\n }]\n各个字段的含义：
lat：纬度
lon：经度
timestamp: GPS 时间戳，单位：秒
speed: 速度，km/h
course: 方位角，单位：°度。正北方为0，顺时针方向
{\n success:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n开车/锁车
\nimei:设备的15位唯一标识
locked: 1为锁车，0为开车。注意参数值为数字类型
idx:关联播放的铃声位。不填表示播放默认关联铃声
volume: 关联播放的铃声音量大小。0-100，整数。不填则按默认音量播放
isTBeacon： 是否使用道钉控制 1为使用 0为不使用（默认值）
{\n success: true,\n data: {\n code: 0\n }\n}\ncode为0表示操作成功，code的具体含义参考错误码说明
\n{\n success:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n电门控制
可用于车辆驶出服务区的断电操作等场景
acc：0，关闭电门。 1，开启电门(同时撤防，效果同开车)。注意为数字类型。
idx:关联播放的铃声位。不填表示播放默认关联铃声
volume: 关联播放的铃声音量大小。0-100，整数。不填则按默认音量播放
isTBeacon： 是否使用道钉控制 1为使用 0为不使用（默认值）
{\n success: true,\n data: {\n code: 0\n }\n}\ncode为0表示操作成功，code其他含义参考错误码说明
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n可用于车辆设防状态的设置和解除
\ndefend：0，撤防。 1，设防。注意为数字类型。
idx:关联播放的铃声位。不填表示播放默认关联铃声
volume: 关联播放的铃声音量大小。0-100，整数。不填则按默认音量播放
isTBeacon： 是否使用道钉控制 1为使用 0为不使用（默认值）
{\n success: true,\n data: {\n code: 0\n }\n}\ncode为0表示操作成功，code其他含义参考错误码说明
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n后轮锁控制
参数含义：
locked：0，开锁。1，上锁。注意为数字类型。
idx:关联播放的铃声位。不填表示播放默认关联铃声
volume: 关联播放的铃声音量大小。0-100，整数。不填则按默认音量播放
{\n success: true,\n data: {\n code: 0\n }\n}\ncode为0表示操作成功，code其他含义参考错误码说明
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n电池仓锁(鞍座锁)控制
\nimei:设备的15位唯一标识\nlocked: 1为电池仓上锁，0为电池仓解锁。注意参数值为数字类型
idx:关联播放的铃声位。不填表示播放默认关联铃声
volume: 关联播放的铃声音量大小。0-100，整数。不填则按默认音量播放
{\n success: true,\n data: {\n code: 0\n }\n}\ncode为0表示操作成功，code其他含义参考错误码说明
\n{\n success:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\nimei:设备的15位唯一标识
index:关联播放的铃声位。不填表示播放默认关联铃声
volume: 关联播放的铃声音量大小。0-100，整数。不填则按默认音量播放
{\n success: true,\n data: {\n code: 0\n }\n}\ncode为0表示操作成功，code的其他含义参考错误码说明
\n{\n success:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n注册事件回调链接。同一事件支持注册多个链接，可以根据使用需要注册生产环境或测试环境回调链接。
\nurl：用于接收事件的接口url。必须为 POST 接口
event：注册事件类型，定义如下：
{\n \"success\": true,\n \"data\": 1//成功注册的url 数量\n}\n\ndata表示增加的回调地址的数量,data为0表示该url已存在或者添加失败
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n\n返回数据字段是否存在与设备类型有关，定义如下：
\n{ \n \"success\": true,\n \"data\":{\n \"imei\":\"865067022403441\",\n \"event\":1,\n \"data\":{\n \"gsm\": 20, //GPS 信号强度\n \"voltage\": 0 //电压值，单位：V \n }\n }\n}\n\n返回数据字段是否存在与设备类型有关，定义如下：
\n{ \n \"success\": true,\n \"data\":{\n \"imei\":\"865067022403441\",\n \"event\":2,\n \"data\":{\n \"gsm\": 22,//GSM 信号强度\n \"voltage\": 45835,//电压值，mV\n \"timestamp\": 1528968201,//GPS 时间戳，单位：秒\n \"longitude\": 114.4253158569336,//wgs84格式，经度\n \"latitude\": 30.511945724487305,//wgs84格式，纬度\n \"speed\": 0,//速度，km/h\n \"course\": 11,//方位角，单位：°度。正北方为0，顺时针方向。\n \"hdop\": 1.8600000143051147,//水平精度因子\n \"satellite\": 7 //GPS 定位卫星数量,\n \"sw\":86,//Bit 位开关\n }\n }\n}\n\n返回通知事件定义如下：
\n{\n \"success\": true,\n \"data\":{\n \"imei\":\"865067022403441\",\n \"event\":3,\n \"data\":1,//notify类型\n }\n}\n\n事件支持情况与设备类型有关。
\n返回数据字段是否存在与设备类型有关，定义如下：
\n{ \n \"success\": true,\n \"data\":{\n \"imei\":\"865067022403441\",\n \"event\":4,\n \"data\":{\n \"sn\": \"ZTZL1909012307\",// BMS串号 如无, 默认0x0000\n \"hardVersion\": 0,// BMS硬件版本 如无, 默认0x0000\n \"softVersion\": 120,//BMS软件版本 如无, 默认0x0000\n \"MOSTemp\": 27,// MOS温度 单位: 0.1摄氏度\n \"MOSState\": 0,// BMS MOS状态: 0x00: 无此功能 0x01: 充电状态 0x02: 放电状态 0x03: 存储状态\n \"maxVoltage\": 179,// 单体电池最大电压 单位: 0.1V 如无, 默认0x00\n \"minVoltage\": 105,// 单体电池最小电压 单位: 0.1V 如无, 默认0x00\n \"healthState\": 100,// 电池健康状态百分比 电池健康状态百分比\n \"fault\": 0, // 故障位开关:详述见下面\n \"capacity\":18000,// 电池绝对满充容量 mAH,\n \"remainCapacity\": 0,// 电池相对剩余容量 单位: mAH\n \"soc\": 0,// 电池相对剩余容量 单位: mAH\n \"cycle\": 70,// 电池循环次数\n \"voltage\": 4982,// 总实时电压 单位: mV\n \"current\": 0,// 总实时电流 单位: 0.1A (+:放电电流 -:充电电流)\n \"timestamp\": 1591798432,// 数据时间戳 单位:秒\n }\n }\n}\n\n返回数据定义如下：
\n{\n \"success\": true,\n \"data\":{\n \"imei\":\"865067022403441\",\n \"event\":5,\n \"data\":\"MTIzNDU2QUJDREVGR0g=\",//Base64Encode(Buffer)\n \"tm\":1547538878\n }\n}\n\nevent:回调事件类型，具体说明请参《考注事件回调链接》事件说明
\n{\n \"success\": true,\n \"data\": [\n \"http://pre.xiaoantech.com\"\n ]\n}\ndata为注册的该事件的所有回调地址的数组
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\nevent:回调事件类型，具体说明请参《考注事件回调链接》事件说明
url：需要注销的回调链接
{\n \"success\": true,\n \"data\": 1\n}\ndata表示注销的回调地址数量，data为0表示该回调地址已被注销或者本次注销失败
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n配置蓝牙参数。接口返回成功后，等60s待设备重启，生效配置。
\ntoken：蓝牙通信的token（u32），可单独配置,若不配置,可以忽略, 0 到 4,294,967,295(2^32-1) 之间的无符号整数
name：蓝牙名称 {0:15} 可单独配置,若不配置,可以忽略
agentId：代理商id\nimei：设备编号
{\n success: true,\n data: {\n code: 0,\n tm: 1531279433\n }\n}\ncode为0表示操作成功，code其他含义参考错误码说明
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n重启设备
\nimei:设备的15位唯一标识
\n","urlObject":{"protocol":"https","path":["ebike","v1","reboot"],"host":["api","xiaoantech","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1fd0d3b5-1ff2-4581-b2b2-edbb8e03efef"},{"name":"电池放电开关控制[实时]","event":[{"listen":"test","script":{"id":"9ace71a4-0c05-41da-b45c-5baa183fb9f7","exec":["pm.test(\"Body matches string\", function () {"," pm.expect(pm.response.text()).to.include('\"success\":true');","});"],"type":"text/javascript"}}],"id":"2ab0d0b0-2011-40c2-9588-f624e7d40767","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"xc-access-token","value":"525511E04347F12AE6C5D74D705DD84A"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"imei\":868183030457282,\n\t\"sw\":1,\n\t\"agentId\":87\n}"},"url":"https://api.xiaoantech.com/ebike/v1/batteryPowerSwitch","description":"参数含义：
sw：0，关闭放电开关。 1，打开放电开关。注意为数字类型。
{\n success: true,\n data: {\n code: 0\n }\n}\ncode为0表示操作成功，code其他含义参考错误码说明
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\nimei:设备的15位唯一标识
speed: 车速百分比。单位：%。数字整数类型
{\n success: true,\n data: {\n code: 0\n }\n}\ncode为0表示操作成功，code的具体含义参考错误码说明
\n{\n success:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n与设备通信获取车辆电池BMS信息。
\nimei:设备的15位唯一标识
\n{\n \"success\": true,\n \"data\": {\n \"voltage\": 49427,\n \"current\": 65317,\n \"temperature\": 257,\n \"SOC\": 45,\n \"remain\": 11005\n }\n}\n各个字段的含义：
voltage:电压。单位:mV
current:电流
temperature:温度
SOC:剩余电量百分比。单位：%
{\n success:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n获取设备最后定位点信息
\nimei：设备编号
\n{\n success: true,\n data: {\n timestamp: 1541683308,\n address: \"嘉鱼县新街镇新村路32号北\",\n originInfo: {}\n }\n}\n若有其他地址信息需求，可从originInfo中解析相应字段。经纬度坐标系：gcj02
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n参数含义：
cell: GSM/UMTS，兼容两种格式的数据: MCC,MNC,LAC,CI,RXL 或 MCC,MNC,LAC,CI,dBm 。dBm=RXL-113
{ \n \"agentId\": 87,\n \"cell\": {\n \"mcc\": 460,\n \"mnc\": 0,\n \"cells\": [\n {\n \"lac\": 28734,\n \"ci\": 44603,\n \"dBm\": -57\n },\n {\n \"lac\": 28734,\n \"ci\": 54186,\n \"dBm\": -73\n },\n {\n \"lac\": 28734,\n \"ci\": 44601,\n \"dBm\": -74\n },\n {\n \"lac\": 28734,\n \"ci\": 54602,\n \"dBm\": -77\n },\n {\n \"lac\": 28712,\n \"ci\": 232,\n \"dBm\": -81\n }\n ]\n }\n}\n{ \n \"agentId\": 87,\n \"cell\": {\n \"mcc\": 460,\n \"mnc\": 0,\n \"cells\": [\n {\n \"lac\": 28734,\n \"ci\": 44603,\n \"rxl\": 56\n },\n {\n \"lac\": 28734,\n \"ci\": 54186,\n \"rxl\": 40\n },\n {\n \"lac\": 28734,\n \"ci\": 44601,\n \"rxl\": 39\n },\n {\n \"lac\": 28734,\n \"ci\": 54602,\n \"rxl\": 36\n },\n {\n \"lac\": 28712,\n \"ci\": 232,\n \"rxl\": 22\n }\n ]\n }\n}\n{\n \"success\": true,\n \"data\": {\n \"count\": 5,\n \"result\": [\n {\n \"id\": \"460-000-0000028734-00000000000000044603\",\n \"lat\": \"30.50451142\",\n \"lng\": \"114.43048877\",\n \"radius\": \"764\",\n \"address\": \"湖北省武汉市洪山区关东街道瑞成佳苑关东康居园\",\n \"roads\": \"文园路东约36米\",\n \"lats\": \"30.502173\",\n \"lngs\": \"114.435982\",\n \"rid\": \"420111\",\n \"rids\": \"420111080000\"\n },\n {\n \"id\": \"460-000-0000028734-00000000000000054186\",\n \"lat\": \"30.50234387\",\n \"lng\": \"114.42816352\",\n \"radius\": \"834\",\n \"address\": \"湖北省武汉市洪山区关东街道光谷创业街52号中国武汉留学生创业园(光谷创业街)\",\n \"roads\": \"百合路西南约38米\",\n \"lats\": \"30.500011\",\n \"lngs\": \"114.433667\",\n \"rid\": \"420111\",\n \"rids\": \"420111080000\"\n },\n {\n \"id\": \"460-000-0000028734-00000000000000044601\",\n \"lat\": \"30.50260513\",\n \"lng\": \"114.43124154\",\n \"radius\": \"732\",\n \"address\": \"湖北省武汉市洪山区关东街道光谷创业街关山村上下毕还建房\",\n \"roads\": \"光谷创业街西北约4米\",\n \"lats\": \"30.500267\",\n \"lngs\": \"114.436734\",\n \"rid\": \"420111\",\n \"rids\": \"420111080000\"\n },\n {\n \"id\": \"460-000-0000028734-00000000000000054602\",\n \"lat\": \"30.50333362\",\n \"lng\": \"114.43244187\",\n \"radius\": \"762\",\n \"address\": \"湖北省武汉市洪山区关山街道光谷创业街加油加气站(光谷创业街)(装修中)\",\n \"roads\": \"光谷创业街南约0米\",\n \"lats\": \"30.500996\",\n \"lngs\": \"114.437935\",\n \"rid\": \"420111\",\n \"rids\": \"420111002000\"\n },\n {\n \"id\": \"460-000-0000028712-00000000000000000232\",\n \"lat\": \"30.50548567\",\n \"lng\": \"114.42741022\",\n \"radius\": \"754\",\n \"address\": \"湖北省武汉市洪山区关东街道百合路关东科技工业园电子港\",\n \"roads\": \"百合路西约27米\",\n \"lats\": \"30.503152\",\n \"lngs\": \"114.432913\",\n \"rid\": \"420111\",\n \"rids\": \"420111080000\"\n }\n ],\n \"latitude\": 30.5036521024309,\n \"longitude\": 114.429900338729\n }\n}\ncode为0表示操作成功，code其他含义参考错误码说明
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n对于设备在线状态，由于设备与网关服务器的保活机制，设备登录网关服务器时立即判定为设备上线，而在设备与网关服务器失去连接5分钟后判定为离线。
\n{\n succcess:true,\n data:{\n imei: \"868183030457282\",\n isOnline: 1, \n version: 67328, \n capacity: 30000,\n cycle: 23,\n SN: 6756886678668800,\n remaining: 16000,\n temperature: 54,\n isUndervoltage: 1,\n isOvervoltage: 0,\n isOverload: 1,\n isHighTemperature: 0,\n isDischargeShortcircuit: 0,\n isChargeShortcircuit: 1,\n isDischargeOvercurrent: 0,\n isChargeOvercurrent: 1\n }\n}\n各个字段的含义：
imei：设备号
isOnline: 设备在线状态，1：在线，0：离线
version：BMS版本号
capacity：电池总容量，单位:mAH
cycle：电池循环次数
SN：电池串号，16位,末尾补0
remaining：电池剩余容量，单位:mAH
temperature：电池温度，单位:摄氏度
isUndervoltage：是否欠压，1/0
isOvervoltage：是否过压，1/0
isOverload：是否过载，1/0
isHighTemperature：是否高温，1/0
isDischargeShortcircuit：是否放电短路，1/0
isChargeShortcircuit: 是否充电短路，1/0
isDischargeOvercurrent: 是否放电过流，1/0
isChargeOvercurrent: 是否充电过流，1/0
{\n succcess:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n获取车辆电池BMS信息。
\nimei:设备的15位唯一标识
\n{\n \"success\": true,\n \"data\": {\n \"SN\": \"57402AIAJAAW2373\",\n \"capacity\": 26880,\n \"cycle\": 0\n }\n}\n各个字段的含义(字段是否存在与设备类型相关)：
SN：电池BMS SN号
capacity：电压。单位：mV
cycle：循环次数
{\n success:true,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\nimei:设备号
agentId:客户id
cmd:车辆设备的短信控制命令，详细定义参见《中控设备SMS通信协议》
{\n \"imei\": \"868183033267985\",\n \"cmd\": {\n \"c\": 404,\n \"p\": {\n \"param\":\"server.host.com:port\"\n }\n },\n \"agentId\": 1\n}\n{\n \"success\": true,\n \"data\": {\n \"msg\": \"提交成功\",\n \"data\": {\n \"rows\": [\n {\n \"msisdn\": \"1440457359015\",\n \"sms_id\": 17318552\n }\n ],\n \"failed\": []\n },\n \"code\": 0\n }\n}\ncode为0表示操作成功，code其他含义参考本文档-术语解释-code含义对照表
\n{\n success:false,\n error:{\n errormessage:\"\",\n promot:\"\"\n }\n}\n