HMS 管理
功能概述
上云API 开放HMS功能是为了将设备的告警显示在指挥中心,提升用户对于风险的感知和处理能力,以保障作业安全。
说明: HMS 上报的是全量的告警信息。若上一次 HMS 上报中的告警,在本次 HMS 上报中消失了,则说明该告警解除了。
告警文案查询
用户需要通过上报的协议中的字段信息拼接文案Key。凭借文案Key在告警文案查询json文件中查询对应的告警文案。根据告警的设备的不同,拼接规则也有区别。
- 告警文案查询json文件:hms.json。
- 拼接规则及示例:
{code}为告警码,可通过协议中的字段获得。HMS功能的协议中的字段及其解释可参见API介绍 > HMS 管理。- 如果是机巢设备的告警,需要将
dock_tip_拼接在{code}前,机巢拼接逻辑:dock_tip_{code}
以错误码为0x1001为例,文案Key为:dock_tip_0x1001 - 如果是无人机的告警,需要将
fpv_tip_拼接在{code}前,无人机拼接逻辑:fpv_tip_{code}
以错误码为0x0108为例,文案Key为:fpv_tip_0x0108 - 如果是遥控器的告警,需要将
rc_tip_拼接在{code}前,遥控器拼接逻辑:rc_tip_{code}
以错误码为0x00010001为例,文案Key为:rc_tip_0x00010001 - 部分告警存在
_in_the_sky后缀的变体键(形如fpv_tip_{code}_in_the_sky),表示飞行状态下的文案。平台查表时需同时尝试带与不带该后缀的键。 - 文案Key 中的十六进制部分已统一为小写
0x前缀 + 大写十六进制数字(与设备上报的{code}格式0x%04X一致,例如0x080A)。平台查表时按此格式直接匹配。 - 文件末尾的
_meta项记录本文件的版本与最近更新时间(version/updated),不属告警文案,查表时应跳过。
交互时序
设备通过健康告警协议(Topic: thing/product/{gateway_sn}/events Method: hms)上传机巢设备与无人机的告警信息到云端,云端通过拼接Key、查询json文件、渲染文案等行为后获得正确且完整的告警文案并呈现在Web界面。
接口详细实现
- 健康告警