快速对接设备告警
关注公众号
原创
HTTP协议

功能概述

本文档详细说明如何配置边缘计算盒子的数据推送功能并将其产生的告警图片、视频等数据，通过HTTP或HTTPS协议自动、实时地推送到用户指定的接收服务器（平台或应用）。 协议支持：HTTP / HTTPS（注意：不支持自定义SSL证书）。

1.在告警接收端创建告警接收服务

示例代码以及配置token请参考（点击此处跳转）

  • 接口功能描述：目标平台接收告警；
  • 接口路径：[POST] http(https)://IP:PORT/alert，（IP是告警接收设备的IP地址，PORT是告警接收端的端口）；
  • 响应参数说明；
参数名称 数据类型 说明
alert_time Float

告警时间戳
device Object

设备信息，包含id, name, desc
source Object

数据源信息，包含id, ipv4, desc
alg Object

算法信息，包含name, display_name, tpye
hazard_level String

危险等级
image String

图像数据base64编码
reserved_data Object

保留数据，包含矩形框、颜色、算法、置信度
  • 响应示例；
项目 详情
报文格式

JSON
报文内容 
{
    "id": "xxxxxx", //告警id
    "alert_time": 1706519903.634085, //告警时间戳
    "device": {
        "id": "设备ID",
        "name": "设备名称",
        "desc": null
     },
     "source": {
     "id": "数据源ID",
     "desc": "数据源描述",
     "ipv4": "数据源IP地址"  
     },
     "alg": {
         "name": "算法名称",
         "display_name": "算法显示名称",
         "type": "general"
     },
     "hazard_level": "", //危险等级
     "image": "img1_base64", //base64编码的图片数据
     "reserved_data": {
         "bbox": {
             "rectangles": [{
                 "xyxy": [680, 198, 1178, 696], //左上角、右下角坐标
                 "color": [0, 0, 255], //BGR颜色
                 "label": "未佩戴安全帽", //算法
                 "confidence": 0.92     //置信度
            }]
        }
    }
}

2.在设备页面上配置告警接收端的信息

  • 在设备界面左侧依次点击【数据推送】-【告警】-【HTTP】页签进入页面；

image.png

点击此处展开：启动demo并查看源码获取告警推送地址

启动服务.png

接口.png

  • （可选）点击【网络检测】可以检查url是否存在；
  • 选择告警图片是否画框，若启用表示告警图片上标记了告警的目标；若停用表示告警图片上无标记。

3.在告警视频接收端创建告警视频接收服务

该功能暂不适配KS968-M1&M2的32路版本，使用前务必确认产品型号。

示例代码以及配置token请参考（点击此处跳转）

  • 接口功能描述：目标平台接收告警视频；
  • 接口路径：[POST] http(https)://IP:PORT/alert/video，（IP是告警接收设备的IP地址，PORT是告警接收端的端口）；
  • 请求参数说明；
参数名称 数据类型 是否必须 说明
data Json 是 上报数据
  • data数据说明；
参数名称 数据类型 说明
alert_time Float

告警时间戳
device Object

设备信息，包含id, name , desc
source Object

数据源信息，包含id, ipv4, desc
alg Object

算法信息，包含name,display_name
video file

告警视频二进制数据
hazard_level String

危险等级
  • 请求示例；
项目 详情
报文格式

JSON
报文内容 
{
    "id": "xxxxxx", //告警id
    "alert_time": 1706519903.634085, //告警时间戳
        "device": {
            "id": "设备ID",
            "name": "设备名称"
            "desc": null
        },
    "source": {
        "id": "数据源ID",
        "ipv4": "数据源IP地址 ",
        "desc": "数据源描述"
    },
    "alg": {
        "name": "算法名称",
        "display_name": "算法显示名称"
        "type": "general"
    },
    "video": "file", //视频二进制数据
    "hazard_level": "" //危险等级
}
  • 响应参数说明；
参数名称 数据类型 是否必须 说明
error_code Int 是

返回响应码
0: 成功
-1: 客户端错误
-2: 服务端错误
message String 是

返回响应信息
data Json 是

返回数据
  • 响应示例。
项目 详情
报文格式

JSON
报文内容 
{
    "error_code": 0,
    "message": "告警视频推送成功",
    "data": null
}

4.在设备页面上配置告警接收端的信息

  • 在设备界面左侧依次点击【数据推送】-【告警】-【HTTP】页签进入页面；

image.png

  • 如需打开推送，请点击【启停开关】；
  • 输入告警推送地址，即http(https)://IP:PORT/alert/video；
  • （可选）点击【网络检测】可以检查url是否存在。

5.示例JSON

示例JSON

6.自定义域名推送

如果您的域名是自定义域名，并且需要本地配置 hosts 文件（极少数需求）

  • 点击【设备升级】，连续点击7次红色框内的设备版本，打开开发者模式。 image.png

点击【高级设置】-【终端管理】，在设备终端点击【连接】。

image.png

进入终端后执行sudo vi /etc/hosts编辑 hosts 文件，添加 ip 以及对应的域名。后续步骤参考【教程 - 设备二开 - 设备快速集成 - 快速集成】

真诚点赞 诚不我欺

HTTP协议