device-docking/爱牵挂/爱牵挂M1对外API/细节描述(必看).txt
2023-12-20 11:07:38 +08:00

168 lines
12 KiB
Plaintext
Executable File
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

数据对接思路:
1、爱牵挂作为提供连接硬件的通道负责将设备产生的数据实时分发给贵司同时提供指令和修改API让贵司对设备进行下行处理对接不涉及任何用户体系兼容仅作为上下行通路。。
2、数据分发部分请贵司参照pushdata.md文件开发数据接收API(HTTP),交给爱牵挂技术支持人员进行配置。
3、应对接收API的鉴权建议使用IP白名单的方式爱牵挂提供发送服务器的IP列表贵司进行匹配也可以使用登陆鉴权或其他类似令牌的方案需要额外开发工期会产生开发费用及后续维护成本。
4、数据接收API的请求参数可以采用POST 表单提交 以及 POST JSON 数据发送两种类型默认为POST表单提交如果需采用JSON数据发送请联系安牵挂技术人员进行配置。
5、下行的请求处理需要对接口进行鉴权(auth.md 中的 login方法),相关权限账号由爱牵挂技术人员进行授权提供。
6、常用的下行处理主要为配置项的变更以及指令操作(device.md),如修改亲情号码,发起实时定位等。
7、非常不推荐使用轮询的方式获取数据。爱牵挂服务对同一IP每秒请求次数为10次弹性考虑到并发以及负载尽量将QPS给予修改和下行的指令。
数据产生分发逻辑
M1必须设置紧急联系人才能按SOS进行报警
1.位置定位有两种,(1).一种是主动定位实时定位这种不需要打开轨迹开关。只需要调实时定位的接口这个接口在device文档下是个指令性接口给硬件下发一个定位指令设备开始定位。前提是设备必须在线不在线则不能调这个接口
(2).一种是轨迹定位,需要打开开关,设备根据设定的频率自动定位 默认测量间隔是1小时如果需要更改可以在出厂时告知对接人员按需求初始化配置。建议不要低于16分钟
2.心率;一种是手动测量心率,这种不需要打开开关,测量数据就会推送,手动测量就是手动操作设备
一种是自动测量心率这种需要打开开关根据设定的频率自动测量测量完毕之后推送数据硬件要求最低频率不得低于5分钟
3.计步需要打开开关默认是半小时可以更改频率但是不建议更改来决定上传的步数没有打开开关就不能产生步数数据每晚的0点计步数据清0
4.开关机:默认是一个小时推送一次。
5.跌倒:打开开关,设备产生数据然后推送数据,没有打开开关就不产生跌倒数据
6.血压:测一次血压,推送一次数据,自动测量是跟心率一起测量。 贵司自己开发血压阈值,我司只发血压数据,贵司自行判断是否异常,自行报警
血氧:心率,血压,血氧测量是一起测量的,自动测量也是一起测量的。
7.智能省电模式 (该模式打开以后,定时测量全部关闭)跌倒等开关修改(心率、跌倒、轨迹、计步、血氧、血压,都会忽略)
8.打开设备开关和修改设备自动上传频率需要调我们的接口先登录API里有登录接口在auth文档获取cookie在response header获取cookie然后调device文档的修改接口 + object文档的device参数。 这个接口只需要修改开关和上传的频率才用,
设置亲情号码设置语音提醒设置电子围栏远程操作等相关的接口都在device文档下。
远程操作接口的原理:前提:设备必须在线。 接口是指令性接口
调接口给硬件下发指令硬件开始进行相关的操作。然后硬件得到的数据上传我们的服务器然后同步发送到你们相对应的URL下
9.查看设备在不在线调device文档里面的指定设备这个接口查看返回参数中的online这个参数如果为true为在线反之不在线。如果查看全部机构内的设备在不在线查看community文档下的接口和device文档下批量获取设备在离线状态这个接口一般使用的是这个
后台M1设备的状态变化是16分钟。例如在线变成离线是16分钟才会改变。 离线变在线是,设备联网立马就改变。
10.紧急呼叫发送短信是开关控制的默认是关闭只有打开SOS报警的时候才会发短信给紧急号码反之则不会发送
11.语音答复开关默认是打开的所以设置语音提醒的时候必然会有语音答复数据如果不想要语音答复数据只想简单的语音提醒就需要调接口把语音答复开关关闭修改的参数是alertreply_enable
带文件的特殊提醒amr文件Content-Type :(用 multipart/form-data其他用application/x-www-form-urlencoded
12.如果接口打开了省电开关,那所有调功能开关的接口都不能成功,返回错误数据是“缺少参数”。必须关闭省电开关才可以正常调功能开关的接口。
13.M1没有广播功能
14.我们发过去的数据是表单的格式 默认是Content-Type: application/x-www-form-urlencoded如果是from-data需要单独进行一下设置解析
15.设备采用的是4G流量消耗不可预控。
16.调电子围栏的接口传坐标是传5个坐标最后一个坐标是第一个坐标形成一个回环。
轨迹关闭,电子围栏打开,在电子围栏生效的时间段内,设备也会根据轨迹频率定位的。然后判断设备是否在围栏内从而是否报警
轨迹和电子围栏打开不受电子围栏时间段的限制是属于全天定位的。行走没到300步功基站位置没变是不会有新的定位的加了一个定位的省电机制
只有围栏和轨迹同时关闭,设备才不会自动定位。
17.电子围栏是配合轨迹定位一起使用的,自动定位的时候,会判断他在不在围栏内,不在就不报警。必须是自动定位才可以。
18.在pushdata文档下is_reply是响应也就是主动定位
is_track是轨迹也就是自动定位。 只有is_track为true的时候必须为自动定位电子围栏才起作用。
19.设备必须在贵司的机构下才拥有修改的权限如果调接口显示无操作权限就是设备不在机构下在我们机构web端平台上进行添加或者让爱牵挂人员进行添加。
20.我们只传硬件数据,与设备的绑定关系需要贵司自行定义
21.只需要这四个文档就可以authdeviceobjectpushdata
22.我司发的是高德坐标,如果你们使用的是百度坐标,需要你们自己转换,我们是火星坐标系
23.是否佩戴这个状态调我司device文档下指定设备这个接口查看wear_flag这个参数判断是否佩戴
佩戴状态是有变化在改变,没有变化不会改变的,自动测量的时候一直能测到心率,那状态就是现实已佩戴状态,有个心率没有测到,佩戴状态就会变成未佩戴。这个时候佩戴的更新时间才会改变。
24.一个服务器调我们的接口1秒钟不能超过10次
25.调我司的接口返回的数据中时间戳需要进行转换转换后需要减8小时。
26.在community文档里面的community id获取方法调登录接口的时候返回的body中有community对应的就是community id
27.如果是post请求把参数带到body里面禁止写到URL后面。URL后面带参数的全是get请求。 我们的测试服虽然get和post请求都可以使用但是要是用规范改post请求的时候必须post请求并且把参数放到body下不要放到URL后面。我们的正式服因为换过架构所以会更加规范修改接口必须是post且放到body下进行请求
28.语音提醒调我们接口语音提醒接口upfile参数要导入文件流把整个文件发送给我们。查看语音文件的地址格式为url + '/media/alerts/' + imei + '/' + alertid + '.amr'。 例http://api.aiqiangua.com:8888/media/alerts/868219000099988/1.amr
答复开关是在修改配置参数alertreply_enable默认是打开的
语音播报是按任何键会结束提醒,上传答复数据是已处理
语音播报超过3分钟没有按任何按键上传的答复数据是未处理。
29.url 测试服:http://120.24.56.48:8889
正式服:http://api.aiqiangua.com:8888
30.硬件的管理后台http://manager.aiqiangua.com/organS2/loginAction!login.do
账号密码是当时注册APP作为超管的账号密码
如果输入的账号正确但是还是出现账号不存在那就是密码错了需要在APP上重置一下密码在登录
31.把设备导入到贵司的机构账号下:两种方式
1让我司的技术人员进行导入
2登录我司的机构web端平台http://manager.aiqiangua.com/organS2/loginAction!login.do
使用批量添加,下载模板:
1、在表格中输入设备号deviceid只需要输入设备IMEI号就可以了后面的那些可不输入。
2、选中所有要录入的设备
3、在工具栏上选择数据
4、点击分列
5、点击下一步下一步
6、选择列数据类型为文本
7、点击完成
前提:设备必须是以前没有加入到机构的设备
尽量使用批量导入不要使用单个添加因为单个添加有限制必须是连过网并且从来没有绑定过我司APP的设备才可以添加成功
32.我们配置URL只能配置一个。如果你们以后必须要设置两个URL的话
有两种方案1.我们这边创建两个机构设备属于哪个机构的就划分到哪个机构下设备数据只能传到对应机构URL下。缺点需要加强和爱牵挂这边的沟通设备更换机构从A机构拉到B机构需要爱牵挂这边进行操作。调我们的接口的时候需要对应不同的账号。
2.只创建一个机构配置一个URL所有的设备加入到这个机构下数据到你们那你们那边保存到数据库至于怎么转发你们那边就可以根据自己的需求进行转发。优点节省了两边的操作维护性更高。调我们的接口只需要一个账号就可以了。 缺点:增加了开发的时间
33.贵司收不到数据,从以下几点排查:
(1.设备在不在线.设备不在线肯定上传不了数据。
(2.设备在线相关功能开关有没有打开有没有设置好频率默认频率是60分钟没有打开就不能产生数据也就没有数据上传更不可能分发。
(3.设备上传数据到我们服务器,发送给贵司的时候,请求贵司的接口出现问题,请求接口失败,这种需要贵司自行排查接口
(4.设备不在贵司的机构下。需要联系爱牵挂支持人员,将设备添加到贵司的机构账号下。
均可在我司的平台上查看相关数据是否上传或者以前绑定了我司的APP就可以查看数据。、
http://manager.aiqiangua.com/organS2/loginAction!login.do
34.前期测试阶段,修改设备参数,从以下三点:
1.如果绑定了我司的APP可以使用我司的APP进行修改
2.可以登录我司的机构web端平台找到对应的设备进行修改 3.调接口进行修改
35.数据分发请求接口规则:
我司规则是请求接口超过3次3次都没有响应或超时(5s),就会把这个接口暂时过滤掉,半小时之后才能通,重新调这个接口。
我司调接口是5秒这个5秒是一个事务的时间请求/返回。
36.我司的对接规则是首先贵司按照对接文档提供信息我司按照信息在我司硬件服务器给贵司创建一个机构然后把贵司采购的设备IMEI号加入到这个机构下然后贵司提供接收数据的URL设备产生数据就发送到你们的这个接口下贵司自行保存数据不在这个机构下的设备产生就不能发送到这个接口下。修改设备参数需要调我司的接口先登录用你们创建机构的时候提供的管理员账号登录这个是你们机构的超管拥有修改贵司机构下所有设备参数的权限如果调接口提示无权限就是设备不在贵司机构下需要添加进去
37.出现APP绑定没有激活的情况
1.设备没有激活(从来没有联网过),如果是机构用户,可能是设备没有导入到机构账号下。
2.检查输入的IMEI号或者包装盒上面的二维码是否与设备播报的IMEI号一致
3.下载我司的APP正式服和测试服有没有跟设备对应设备也有正式服和测试服。
38.我司的APP家庭圈内的非管理员报警异常中低电心率体温答复提醒是收不到异常的。
39.我司的APP如果设备在机构下在我司的APP里是不能解绑的。以下方面解决
1.在我司提供的机构web端平台上上面有解绑按钮
2.在我们公众号下询问里面的客服进行解绑也可在对接的微信群里提供解绑APP
40.172148的卡在联网后电话那条报文会上传一串0000000. 正常的SIM不会有这些问题只有公司使用的物联网卡才会有这些问题
41.当计步开关开启,设备关机重启,重新联网的时候,设备会报上来计步数据,有时候会这样
42.上不了网、检查这几方面:
1.检查卡的资费,流量,
2.检查设备是否有电量 。
3.设备是否有语音播报,“设备联网成功”
4.在设备菜单——设备信息——查看设备的IMEI号与包装盒上面的IMEI号是否一致
43.测量心率血压出现失败:
1.请确认看看设备是否低电最好电量在30%以上。
2.设备关机重启一下,重新联网试试 3.查看设备测量的时候是否紧贴皮肤。
4.换一个人测一下。
44. 项目 标准(良好网络的情况下)
定位时间(秒) 60秒以内
1、室外理论定位精度10-30米左右
定位偏差(米) 2、室内有稳定良好WIFI信号理论精度是20-50米精度
3、室内无GPS无稳定WIFI情况下定位精度在200-2000米。
45.备注:定位精度说明:
1、在室外场景下设备可获取到卫星信号设备通过接收卫星发射的带有时间和位置信息的无线电信号计算出佩戴者所在位置的具体经纬度根据设备所处区域能够接收到的卫星信号数量和强度理论定位精度在10-30米左右。如果室外受到大楼、天桥、树木等遮挡或者天气原因、云层较厚等导致信号较弱时会影响定位时间和定位精度。
?
2、而在室内情况下由于大多房屋都采用钢架结构那么卫星受到一定程度的屏蔽影响导致无法获取那么此时会自动切换成室内定位模式即LBS基站定位+WIFIWIFI定位LBS是指移动运营商的基站信号根据您使用设在所在区域周围基站覆盖的密度而定基站数量越多则越准基站数量少则出现较大误差定位精度在200-2000米此时APP定位页面显示网络定位。除此之外设备还会搜索您家里或周围的WIFI热点辅助定位这需要周边有信号比较好且在高德地图资源库有地址备案的WIFI来辅助设备进行室内定位。如果设备获取到稳定且高德地图资源库有地址备案的WIFI理论精度是20-50米精度。如果周边无WIFI信号、WIFI信号较弱或WIFI没有在高德地图资源库有地址备案、或者该WIFI信号是特殊、大型的WIFI等原因会自动切换成LBS基站定位和影响定位精度。
46.M1做了一个机制在同一个地方行走没到300步功基站位置没变是不会有新的定位的加了一个定位的省电机制获取的所有基站是一模一样的就不上传定位数据了所以会看到的就产生了一个定位数据 。只有基站产生了变化,定位才会上传。该功能是为了延长续航,如果贵司更需要按时发送的定位数据,可以联系爱牵挂支持人员,在设备出厂时将该功能关闭。