摄像头开放能力说明

更新时间:2023-06-15 05:28:28

本文介绍摄像头开放能力接入的相关说明。

摄像头功能点说明

详细情况,请参考 公区设备功能点

功能点 code 说明
tyabinmc7h 人脸识别
ttimer 云定时
tyabi58fr9 主动消息推送能力
ttyabixe55s 录像
ttyabiucxtc 手动抓图
ttyabiysvtf 视频预览
ttyabiah99c 语音对讲
ttyabi3jvv3 云台操作
ttyabi74ysm 手动录像
ttyabisy77h 自动抓图
ttyabiarwq7 高空抛物
ttyabiac8f4 热成像
ttyabin9x78 以图搜图
ttyabitkn9q 测温
ttyabiat3jc 3D 放大
ttyabienscp 巡航路径
ttyabi44pu7 人脸检测
ttyabir4vuc 人形检测
ttyabiagvay 消防占道
ttyabi8e9qs 人脸追踪
ttyabi5wy4n 区域入侵
ttyabir5jhu 人员聚集
ttyabi5vthj 人员滞留
ttyabi7pw33 电瓶车检测
ttyabin3xgx 设备绑定模式
ttyabi38qux 离线提醒
ttyabiduk8x 快速移动
ttyabijtupe 剧烈运动
ttyabiyks3g 跌倒报警
ttyabifapjm 物品遗留
ttyabiwymed 垃圾满溢
ttyabipkttr 越界侦测
ttyabipuarx 进入区域
ttyabikdy83 离开区域
ttyabigsrnr 徘徊检测
ttyabitytts 离岗报警
ttyabi5w4ut 客流量检测

API 说明

抓拍图片

API 名称 接口地址
抓拍图片 POST: /v1.0/cameras/{device_id}/actions/capture

摄像头人脸管理

API 名称 接口地址
新增人脸 POST: /v1.0/cameras/{device_id}/configs/face/{face_id}
删除人脸 DELETE: /v1.0/cameras/{device_id}/configs/face/{face_id}
修改人脸 PUT: /v1.0/cameras/{device_id}/configs/face/{face_id}

云台控制

API 名称 接口地址
云台控制 POST: /v1.0/cameras/{device_id}/configs/ptz

摄像头事件格式

云开发项目 开启消息订阅 后,可以收到设备端上报的事件消息。

消息队列接入流程,请参考 消息队列

通用告警事件上报

功能描述

摄像头自带通用报警事件,摄像头识别到报警事件后,通过消息的方式通知开发者。事件 Code:alarm_info_report

参数字段说明参考 设备消息事件上报

数据示例

{
    "dataId": "AAXRV4BrtW9BRB9A2JY****",
    "devId": "6cfe10aeb76a63b725****",
    "productKey": "m0h21teryo2g****",
    "status": [
        {
            "3": "{\"subScene\":\"webcam_face_capture\",\"rawData\":\"{\\\"alarmType\\\":200,\\\"alarmCont\\\":\\\"人脸抓拍报警\\\",\\\"happenTime\\\":1663062188955,\\\"tuyaAlarmType\\\":\\\"ALARM_PERSON_DETECTION\\\",\\\"alarmImageId\\\":\\\"209dde23b3fe89e914f1178951012479\\\"}\"}",
            "code": "alarm_info_report",
            "t": 1637548630455,
            "value": "{\"subScene\":\"webcam_face_capture\",\"rawData\":\"{\\\"alarmType\\\":200,\\\"alarmCont\\\":\\\"人脸抓拍报警\\\",\\\"happenTime\\\":1663062188955,\\\"tuyaAlarmType\\\":\\\"ALARM_PERSON_DETECTION\\\",\\\"alarmImageId\\\":\\\"209dde23b3fe89e914f1178951012479\\\"}\"}"
        }
    ]
}

目前,已有如下摄像头告警事件类型:

场景类型 subScene 说明
fire_occupyroad 消防占道报警。
webcam_parabolic 高空抛物报警。
webcam_face_recognition 人脸识别报警。
webcam_car_plate_recognition 车牌识别报警。
webcam_capture_image 相机抓拍。
webcam_vca 行为分析。
webcam_person_flow_rate 客流量报警。
webcam_temperature 温度上报。

消防占道报警 rawData 参数说明

参数名 类型 说明 必填
alarmId String 告警 ID。
sourceProvider String 来源方。
happenTime Long 发生时间。
subjectType String 目标物体类型。
alarmMode Integer 告警模式。
areaId Integer 区域 ID。
alarmImageId String 告警图片 ID。
alarmImageUrl String 告警图片 URL。
message String 告警消息。
localPicUrl String 本地图片 URL。

高空抛物报警 rawData 参数说明

参数名 类型 说明 必填
alarmId String 告警 ID。
sourceProvider String 来源方。
happenTime Long 发生时间。
alarmCode Integer 告警编码。
alarmType Integer 告警类型。
alarmImageFileId String 告警图片 ID。
alarmImageFileUrl String 告警图片 URL。
alarmVideoFileId String 告警视频 ID。
alarmVideoFileUrl String 告警视频 URL。
localVideoUrl String 本地视频 URL。
localPicUrl String 本地图片 URL。

人脸识别报警 rawData 参数说明

参数名 类型 说明 必填
alarmId String 告警 ID。
sourceProvider String 来源方。
happenTime Long 发生时间。
alarmType Integer 告警类型。
alarmLevel String 告警等级。
alarmImageId String 告警图片 ID。
alarmImageUrl String 告警图片 URL。
userName String 用户名。
faceId String 人脸 ID。
faceImageId String 人脸图片 ID。
faceImageUrl String 人脸图片 URL。
similarity Float 相似度。
sex String 性别。
localPicUrl String 本地图片 URL。
localFacePicUrl String 本地人脸图片 URL。

车牌识别报警 rawData 参数说明

参数名 类型 说明 必填
alarmId String 告警 ID。
sourceProvider String 来源方。
happenTime Long 发生时间。
plateNo String 车牌号。
alarmImageId String 告警图片 ID。
alarmImageUrl String 告警图片 URL。
localPicUrl String 本地图片 URL。

相机抓拍 rawData 参数说明

参数名 类型 说明 必填
alarmId String 告警 ID。
sourceProvider String 来源方。
happenTime Long 发生时间。
sn String SN 号。
alarmImageId String 告警图片 ID。
alarmImageUrl String 告警图片 URL。
localPicUrl String 本地图片 URL。

行为分析 rawData 参数说明

参数名 类型 说明 必填
alarmId String 告警 ID。
sourceProvider String 来源方。
happenTime Long 发生时间。
alarmType Integer 告警类型。
tuyaAlarmType String 涂鸦告警类型。
alarmCont String 告警内容。
alarmImageId String 告警图片 ID。
alarmImageUrl String 告警图片 URL。
localPicUrl String 本地图片 URL。

客流量报警 rawData 参数说明

参数名 类型 说明 必填
alarmId String 告警 ID。
sourceProvider String 来源方。
happenTime Long 发生时间。
alarmCont String 告警内容。
realTimeInfo RealTimeFlowRateInfo 实时客流信息。
periodInfo PeriodFlowRateInfo 周期客流信息。
RealTimeFlowRateInfo 参数说明
startTime Long 清零起始时间。
inNum Integer 入客流人数。
outNum Integer 出客流人数。
passNum Integer 经过客流人数。
childInNum Integer 小孩入客流。
childOutNum Integer 小孩出客流。
attentNum Integer 关注客流人数。
duplicateNum Integer 重复客流人数。
PeriodFlowRateInfo 参数说明
endTime Long 统计结束时间。

温度上报 rawData 参数说明

参数名 类型 说明 必填
alarmId String 告警 ID。
sourceProvider String 来源方。
happenTime Long 发生时间。
alarmType Integer 告警类型。
alarmLevel String 告警等级。
tuyaAlarmType String 涂鸦告警类型。
alarmCont String 告警内容。
alarmImageId String 告警图片 ID。
alarmImageUrl String 告警图片 URL。
fTemp Float 温度,单位摄氏度。
thermoImageId String 热成像图片 ID。
localThermoImageUrl String 热成像本地图片 URL。
localPicUrl String 本地图片 URL。

摄像头事件 1.0 格式

设备事件消息兼容 1.0 版本格式。如需开通 1.0 版本格式,请联系涂鸦工作人员。接入流程参考 行业三方设备事件 1.0 版本格式

摄像头通用报警事件

功能描述

摄像头自带通用报警事件,摄像头识别到报警事件后,通过消息的方式通知开发者。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
eventType String 事件类型,默认 edge_device_alarm
mode String 事件 mode,默认 monitor-alarm
deviceId String 涂鸦设备 ID。
subScene String 报警场景,默认 webcam_alarm
alarmId String 报警事件 ID。
alarmCont String 告警内容。
alarmType Integer 报警类型。
happenTime Long 报警发生时间,13 位时间戳。

报警类型说明

报警类型 描述
0 未知报警。
1 信号丢失。
2 移动侦测。
3 遮挡。
4 信号异常。
5 录像异常。
6 分辨率不匹配。
7 申请解码资源失败。
8 获取声音资源丢失。
9 相机视角异常。
10 虚焦检测异常。
11 场景变更报警。

数据示例

{
  "eventType": "edge_device_alarm",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "mode": "monitor-alarm",
  "data": {
    "deviceId": "6c280fdff93c18e45be***",
    "rawData": {
      "subScene": "webcam_alarm",
      "alarmId": "1122567",
      "alarmCont": "人员聚集",
      "alarmType": 105,
      "happenTime": 1613616817285
    }
  }
}

消防占道报警事件

功能描述

设备发现消防占道事件后,通过消息的方式通知开发者。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
eventType String 事件类型,默认 edge_device_alarm
mode String 事件 mode,默认 monitor-alarm
deviceId String 涂鸦设备 ID。
subScene String 报警场景,默认 fire_occupyroad
subjectType String 目标物体类型 code,目前只支持车 vehicle
areaId String 区域 ID。
picUrl String 抓取的占道照片 URL。临时 URL,开发者需要根据 URL 下载照⽚并存储。
localPicUrl String 本地图片 URL,只针对图片在底层平台本地有存储的情况。
happenTime Long 报警发生时间,13 位时间戳。

数据示例

{
  "eventType": "edge_device_alarm",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "mode": "monitor-alarm",
  "data": {
    "deviceId": "6c280fdff93c18e45be***",
    "rawData": {
      "subScene": "fire_occupyroad",
      "picUrl": "http://www.xxx.com/pic.jpg",
      "areaId": "1112222",
      "subjectType": "vehicle",
      "happenTime": 1613616817285
    }
  }
}

高空抛物报警事件

功能描述

设备发现高空抛物事件后,通过消息的方式通知开发者。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
eventType String 事件类型,默认 edge_device_alarm
mode String 事件 mode,默认 monitor-alarm
deviceId String 涂鸦设备 ID。
subScene String 报警场景,默认 webcam_parabolic
alarmId String 报警事件 ID。
alarmCode Integer 报警 code。
0:高空抛物。
1:烟火识别。
alarmType Integer 事件类型。
1:报警事件上报。
2:报警图片上报。
3:报警视频上报。
picUrl String 抓取图片临时 URL。开发者需要根据 URL 下载照⽚并存储。
localPicUrl String 本地图片 URL,只针对图片在底层平台本地有存储的情况。
videoUrl String 抓取视频临时 URL。开发者需要根据 URL 下载视频并存储。
localVideoUrl String 本地视频 URL,只针对视频在底层平台本地有存储的情况。
happenTime Long 报警发生时间,13 位时间戳。

数据示例

{
  "eventType": "edge_device_alarm",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "mode": "monitor-alarm",
  "data": {
    "deviceId": "6c280fdff93c18e45be***",
    "rawData": {
      "subScene": "webcam_parabolic",
      "picUrl": "http://www.xxx.com/pic.jpg",
      "alarmId": "1112178",
      "alarmCode": 0,
      "alarmType": 1,
      "happenTime": 1613616817285
    }
  }
}

人脸识别报警事件

功能描述

人员及人脸照片下发到设备,设备识别到已经下发的人脸信息后,会发出报警事件,通过消息的方式通知开发者。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
eventType String 事件类型,默认 edge_device_alarm
mode String 事件 mode,默认 monitor-alarm
deviceId String 涂鸦设备 ID。
subScene String 报警场景,默认 webcam_face_recognition
userName String 用户名。
faceId String 人脸 ID,新增人脸时的 faceId
facePicUrl String 人脸库中的人脸图片临时 URL。开发者需要根据 URL 下载照⽚并存储。图片格式 jpg。
localFacePicUrl String 本地人脸图片 URL,只针对图片在底层平台本地有存储的情况。
picUrl String 抓取人脸照片临时 URL。开发者需要根据 URL 下载照⽚并存储。图片格式 jpg。
localPicUrl String 本地图片 URL,只针对图片在底层平台本地有存储的情况。
alarmType Integer 告警类型。
alarmLevel String 告警等级。
similarity Float 相似度,取值范围 0100
sex String 性别。
1:男性。
2:女性。
UNKNOWN:未知。
happenTime Long 报警发生时间,13 位时间戳。

数据示例

{
  "eventType": "edge_device_alarm",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "mode": "monitor-alarm",
  "data": {
    "deviceId": "6c280fdff93c18e45be***",
    "rawData": {
      "subScene": "webcam_face_recognition",
      "facePicUrl": "http://www.xxx.com/face.jpg",
      "picUrl": "http://www.xxx.com/pic.jpg",
      "userName": "张三",
      "faceId": "123",
      "alarmType": 1,
      "alarmLevel": "high",
      "similarity": 80.1,
      "sex": "1",
      "happenTime": 1613616817285
    }
  }
}

车牌识别报警事件

功能描述

设备识别到车牌信息后,会发出报警事件,通过消息的方式通知开发者。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
eventType String 事件类型,默认 edge_device_alarm
mode String 事件 mode,默认 monitor-alarm
deviceId String 涂鸦设备 ID。
subScene String 报警场景,默认 webcam_car_plate_recognition
plateNo String 车牌号。
picUrl String 抓取车牌临时 URL。 开发者需要根据 URL 下载照⽚并存储。图片格式 jpg。
localPicUrl String 本地图片 URL,只针对图片在底层平台本地有存储的情况。
happenTime Long 报警发生时间,13 位时间戳。

数据示例

{
  "eventType": "edge_device_alarm",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "mode": "monitor-alarm",
  "data": {
    "deviceId": "6c280fdff93c18e45be***",
    "rawData": {
      "subScene": "webcam_car_plate_recognition",
      "picUrl": "http://www.xxx.com/pic.jpg",
      "plateNo": "鲁A13345",
      "happenTime": 1613616817285
    }
  }
}

相机抓拍事件

功能描述

控制相机抓拍后,通过消息的方式把抓拍的图片发送给开发者。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
mode String 事件 mode,默认 monitor-alarm
eventType String 事件类型,默认 edge_device_alarm
deviceId String 涂鸦设备 ID。
subScene String 场景,默认 webcam_capture_image
picUrl String 图片临时 URL。开发者需要根据 URL 下载照⽚并存储。图片格式 jpg。
happenTime Long 报警发生时间,13 位时间戳。

数据示例

{
  "eventType": "edge_device_alarm",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "mode": "monitor-alarm",
  "data": {
    "deviceId": "6cfc6009cddda0bb9fv***",
    "rawData": {
      "subScene": "webcam_capture_image",
      "picUrl": "https://aaa.jpg",
      "happenTime": 1627358395883
    }
  }
}

行为分析事件

功能描述

摄像机行为分析事件。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
mode String 事件 mode,默认 monitor-alarm
eventType String 事件类型,默认 edge_device_alarm
deviceId String 涂鸦设备 ID。
subScene String 场景,默认 webcam_vca
alarmId String 告警 ID。
alarmType Integer 告警类型。
alarmCont String 告警内容。
picUrl String 图片临时 URL。开发者需要根据 URL 下载照⽚并存储。图片格式 jpg。
localPicUrl String 本地图片 URL,只针对图片在底层平台本地有存储的情况。
happenTime Long 报警发生时间,13 位时间戳。

报警类型说明

报警类型 描述
100 区域入侵报警
101 越界侦测报警
102 进入区域报警
103 离开区域报警
104 徘徊检测报警
105 人员聚集报警
106 快速移动报警
107 剧烈运动报警
108 跌倒报警
109 离岗报警
110 滞留报警
111 人数异常
112 物品遗留
113 物品拿取
114 电动车入梯
119 垃圾满溢

数据示例

{
  "eventType": "edge_device_alarm",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "mode": "monitor-alarm",
  "data": {
    "deviceId": "6cfc6009cddda0bb9fv***",
    "rawData": {
      "subScene": "webcam_vca",
      "alarmId": "11111",
      "alarmType": 114,
      "alarmCont": "电瓶车入梯",
      "picUrl": "https://a.jpg",
      "happenTime": 11122233
    }
  }
}

客流量报警事件

功能描述

设备统计客流量,通过消息的方式通知开发者。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
mode String 事件 mode,默认 monitor-alarm
eventType String 事件类型,默认 edge_device_alarm
deviceId String 涂鸦设备 ID。
subScene String 场景,默认 webcam_person_flow_rate
alarmId String 告警 ID。
alarmCont String 告警内容。
realTimeInfo JSON 对象 实时客流信息,JSON 形式 。
periodInfo JSON 对象 周期客流信息,JSON 形式。
happenTime Long 报警发生时间,13 位时间戳。

数据示例

{
  "eventType": "edge_device_alarm",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "mode": "monitor-alarm",
  "data": {
    "deviceId": "6cfc6009cddda0bb9fv***",
    "rawData": {
      "subScene": "webcam_person_flow_rate",
      "alarmId": "11111",
      "alarmCont": "告警内容",
      "realTimeInfo": {
          "startTime": 11, // long 清零起始时间
          "inNum": 10, // int 入客流人数
          "outNum": 20, // int 出客流人数
          "passNum": 30, // int 经过客流人数
          "childInNum": 40, // int 小孩入客流
          "childOutNum": 50, // int 小孩出客流
          "attentNum": 60, // int 关注客流人数
          "duplicateNum": 70 // int 重复客流人数
        },
      "periodInfo": {
        "startTime": 11, // long 清零起始时间
        "endTime": 22, // long 统计结束时间
        "inNum": 10, // int 入客流人数
        "outNum": 20, // int 出客流人数
        "passNum": 30, // int 经过客流人数
        "childInNum": 40, // int 小孩入客流
        "childOutNum": 50, // int 小孩出客流
        "attentNum": 60, // int 关注客流人数
        "duplicateNum": 70 // int 重复客流人数
      },
      "happenTime": 11122233
    }
  }
}

温度上报事件

功能描述

上报相机测温数据。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
mode String 事件 mode,默认 monitor-report
eventType String 事件类型,默认 edge_report_data
deviceId String 涂鸦设备 ID。
subScene String 场景,默认 webcam_temperature
alarmId String 告警 ID。
alarmType Integer 告警类型。
alarmCont String 告警内容。
picUrl String 原始图片临时 URL。开发者需要根据 URL 下载照⽚并存储。图片格式 jpg。
localPicUrl String 本地图片 URL,只针对图片在底层平台本地有存储的情况。
thermoImageUrl String 热成像图片临时 URL。开发者需要根据 URL 下载照⽚并存储。图片格式 jpg。注:部分设备商不支持此字段,非必填。
localThermoImageUrl String 本地热成像图片 URL,只针对图片在底层平台本地有存储的情况。
fTemp Float 温度,单位摄氏度。
happenTime Long 报警发生时间,13 位时间戳。

数据示例

{
  "eventType": "edge_report_data",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "mode": "monitor-report",
  "data": {
    "deviceId": "6cfc6009cddda0bb9fv***",
    "rawData": {
      "subScene": "webcam_temperature",
      "alarmId": "1111",
      "alarmType": 0,
      "alarmLevel": "1",
      "alarmCont": "温度35℃",
      "picUrl": "https://aa.jpg",
      "thermoPicUrl": "https://bb.jpg",
      "fTemp": 35.0,
      "happenTime": 111222333
    }
  }
}

异步搜图结果上报

功能描述

使用边缘网关搜图时,搜图结果通过 Pulsar 消息推送给开发者。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
eventType String 事件类型,默认 cmd_issue_result
deviceId String 涂鸦设备 ID。底层是平台时,为平台的 ID。
data String JSON 数据。
sn String 指令记录 ID。
processStatus Integer 指令执行状态。
1:发送中。
2:已发送。
3:发送成功。
4:发送失败。
message String 指令执行描述。如果指令执行失败,则返回失败原因。
happenTime Long 指令执行时间,13 位时间戳。
subScene String 子场景,face_retrieval。可根据该值区分返回数据类型。
facePicUrl String 临时人脸图片 URL。
localFacePicUrl String 本地人脸图片 URL,只针对图片在底层平台本地有存储的情况。
bgPicUrl String 临时背景图。
localBgPicUrl String 本地背景图 URL,只针对图片在底层平台本地有存储的情况。
deviceId String 抓拍照片所对应的相机 ID。
captureTime Long 抓拍时间,13 位时间戳。
score Float 相似分数,取值范围 01

数据示例

{
  "eventType": "cmd_issue_result",
  "bizCode": "edge_device",
  "data": "消息数据"
}

其中,消息数据为 JSON。

{
  "sn": "1212581947449081***",
  "subScene": "face_retrieval",
  "deviceId": "002dj00118fe34d9**** ",
  "processStatus": 3,
  "message": "指令已发送",
  "happenTime": 1591693362843,
  "bizData": [
    {
      "facePicUrl": "http://aa.jpg",
      "bgPicUrl": "http://bb.jpg",
      "projectId": "12345",
      "deviceId": "aaabbb",
      "reportTime": 2233344,
      "score": 0.86
    }
  ]
}