周界开放能力说明

本文介绍周界开放能力的接入流程。

概述

周界功能点

关于功能点相关接口，请参考 修改设备功能点。

功能点 Code	说明
tyabix5h84	旁路和恢复
tyabi33xhy	布防和撤防
tyabi8wxut	群组消音

API 说明

周界主机布防撤防管理

API 名称	接口地址
主机布/撤防	POST: /v1.0/intrusion/{device_id}/actions/chan-action

周界旁路或恢复管理

API 名称	接口地址
旁路/恢复	POST: /v1.0/intrusion/{device_id}/actions/by-pass

周界主机群组消音管理

API 名称	接口地址
主机群组消音	POST: /v1.0/intrusion/{device_id}/actions/group-silence

周界事件格式

云开发项目 开启消息订阅 后，可以收到周界设备端上报的事件消息。消息队列接入流程的详细介绍，请参考 消息队列。

周界设备告警上报

功能描述

出入防区时，触发周界设备上报告警。

value 参数说明

参数名	类型	说明	必填
alarmType	Integer	报警类型。 1：告警 2：恢复	是
content	Integer	报警内容。	是

数据示例

{
    "dataId":"assist_ogFzb****",
    "devId":"6c98fbf2ce1bd****",
    "productKey":"h83ee7rlx****",
    "status":[
        {
            "code":"",
            "4":"{\"alarmType\":1,\"content\":\"告警\"}",
            "t":1654163382790,
            "value":"{\"alarmType\":1,\"content\":\"告警\"}"
        }
    ]
}

周界设备旁路和恢复上报

功能描述

周界设备进行旁路/恢复操作后，将上报操作结果。

• 旁路是在整体操作的情况下，针对某一或某几个特定的防区设备进行的单独操作，将某些防区设备进行旁路后，这些防区设备将不报警。
• 恢复是指将防区设备从旁路状态恢复到正常状态。

value 参数说明

参数名	类型	说明	必填
value	Boolean	旁路或恢复状态。 true：旁路 false：恢复	是

数据示例

{
    "dataId":"assist_U34****",
    "devId":"6c98fbf2ce1b****",
    "productKey":"h83ee7rlx****",
    "status":[
        {
            "code":"",
            "t":1654163570561,
            "5":"{\"value\":true}",
            "value":"{\"value\":true}"
        }
    ]
}

周界主机布防和撤防

功能描述

周界主机设备进行布防/撤防操作后，将上报操作结果。

• 布防使报警系统处于正常报警模式，报警设备和防区均正常工作，用户能实时接收到报警情况。
• 撤防使报警系统处于非报警模式，此时报警设备和防区即使能产生报警，也不将报警信息上传给报警系统，用户不能接收到报警情况。

value 参数说明

参数名	类型	说明	必填
areaId	Long	分区 ID。	是
armed	Boolean	设备处于布防或撤防状态。 true：布防 false：撤防	是

数据示例

{
    "dataId":"assist_Ac****",
    "devId":"6c98fbf2ce1bd****",
    "productKey":"h83ee7rl****",
    "status":[
        {
            "code":"",
            "t":1654163729548,
            "9":"{\"areaId\":1524295988****,\"armed\":true}",
            "value":"{\"areaId\":1524295988****,\"armed\":true}"
        }
    ]
}

周界主机群组消音

功能描述

周界设备报警后，周界主机设备进行群组消音操作后，将上报操作结果。

value 参数说明

参数名	类型	说明	必填
areaId	Long	分区 ID。	是

数据示例

{
    "dataId":"assist_wznI****",
    "devId":"6c98fbf2ce1bd****",
    "productKey":"h83ee7rlx****",
    "status":[
        {
            "code":"",
            "t":1654163916979,
            "value":"{\"areaId\":1524295988****}",
            "10":"{\"areaId\":1524295988****}"
        }
    ]
}

周界事件 1.0 格式

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

周界设备告警上报

功能描述

出入防区时，触发周界设备上报告警给开发者。

参数说明

参数名	类型	说明	必填
bizCode	String	事件业务 code，默认 edge_device。	是
eventType	String	事件类型，默认 edge_report_data。	是
mode	String	事件模式，intrusion-device-alarm。	是
deviceId	String	涂鸦设备 ID。	是
alarmType	Integer	告警类型。 1：告警 2：恢复	是
content	String	告警内容。	是

数据示例

{
    "data": "{\"mode\":\"intrusion-device-alarm\",\"data\":\"{\\\"alarmType\\\":1,\\\"content\\\":\\\"告警\\\",\\\"deviceId\\\":\\\"6ce881191dc89*****\\\"}\"}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

周界设备旁路/恢复上报

功能描述

周界设备进行旁路/恢复操作后，将操作结果上报给开发者。

• 旁路是在整体操作的情况下，针对某一个或某几个特定的防区设备进行的单独操作，将某些防区设备进行旁路后，这些防区设备将不报警。
• 恢复是指将防区设备从旁路状态恢复到正常状态。

参数说明

参数名	类型	说明	必填
bizCode	String	事件业务 code，默认 edge_device。	是
eventType	String	事件类型，默认 edge_report_data。	是
mode	String	事件模式，intrusion-by-pass。	是
deviceId	String	涂鸦设备 ID。	是
value	Boolean	旁路恢复状态。 true：旁路 false：恢复	是

数据示例

{
    "data": "{\"mode\":\"intrusion-by-pass\",\"data\":\"{\\\"deviceId\\\":\\\"6ce881191dc8*****\\\",\\\"value\\\":false}\"}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

周界主机布防/撤防

功能描述

周界主机设备进行布防/撤防操作后，将操作结果上报给开发者。

• 布防使报警系统处于正常报警模式，报警设备和防区均正常工作，用户能实时接收到报警情况。
• 撤防使报警系统处于非报警模式。此时，报警设备和防区即使能产生报警，也不将报警信息上传给报警系统，用户不能接收到报警情况。

参数说明

参数名	类型	说明	必填
bizCode	String	事件业务 code，默认 edge_device。	是
eventType	String	事件类型，默认 edge_report_data。	是
mode	String	事件模式，intrusion-host-chan-action。	是
deviceId	String	涂鸦设备 ID。	是
areaId	Long	分区 ID。	是
armed	Boolean	布/撤防状态。 true：布防 false：撤防	是

数据示例

{
    "data": "{\"mode\":\"intrusion-host-chan-action\",\"data\":\"{\\\"areaId\\\":15242959887*****,\\\"armed\\\":true,\\\"deviceId\\\":\\\"6cf7eb0a3a55d*****\\\"}\"}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

周界主机群组消音

功能描述

周界设备报警后，周界主机设备进行群组消音操作后，将操作结果上报给开发者。

参数说明

参数名	类型	说明	必填
bizCode	String	事件业务 code，默认 edge_device。	是
eventType	String	事件类型，默认 edge_report_data。	是
mode	String	事件模式，默认 intrusion-host-chan-action。	是
deviceId	String	涂鸦设备 ID。	是
areaId	Long	分区 ID。	是

数据示例

{
    "data": "{\"mode\":\"intrusion-host-group-silence\",\"data\":\"{\\\"areaId\\\":15242959887*****,\\\"deviceId\\\":\\\"6cf7eb0a3a55db*****\\\"}\"}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}