HMS Management
Overview
The cloud API offers the HMS functionality to display device alerts at the command center, enhancing users' risk awareness and management to ensure operational safety.
Note: HMS reports complete alert information. If an alert from the previous HMS report is missing in the current one, it indicates the alert has been resolved.
Alert Message Query
Users need to construct an Alert Key
using the field information provided in the reporting protocol. The Alert Key
is then used to query the corresponding alert message in the alert_message_query.json
file. The construction rules vary depending on the device type.
- Alert message query JSON file: hms.json
- Construction rules and examples:
{code}
represents the alert code, which can be obtained from the protocol fields. The protocol fields and their descriptions can be found in the API Introduction > HMS Management.- For dock devices, prepend
dock_tip_
to{code}
.
Example for error code0x1001
:dock_tip_0x1001
- For drone alerts, prepend
fpv_tip_
to{code}
.
Example for error codefpv_tip_0x0108
- For remote controller alerts, prepend
rc_tip_
to{code}
.rc_tip_{code}
Example for error code0x00010001
:rc_tip_0x00010001
Interaction Sequence
Devices upload alert information from drone and dock systems to the cloud through the Health Alert
protocol (Topic: thing/product/{gateway_sn}
/events Method: hms). The cloud then constructs the alert key, queries the JSON file, renders the message, and displays it on the web interface.
Detailed Interface Implementation
- Health Alerts