拓展功能

事件管理

您可通过定义事件来获取设备的运行情况,出现事件时您将收到事件通知;事件分为设备事件和属性事件;

  • 设备事件:设备运行时产生的事件,需要开发者在设备端进行开发,并在平台进行事件定义;
  • 属性事件(暂未开放):通过分析设备上报的属性数据产生的事件,无需在设备端开发,需要开发者在云端进行事件定义;
添加“事件管理”

在“产品详情”点击“添加更多服务”,打开“事件管理”

添加事件管理

设备事件

通过产品仪表盘点击“事件管理”,可进入事件管理页面,事件管理页面默认展示设备事件;

点击事件管理

设备事件列表

设备事件列表展示您已添加的设备事件,您可点击“编辑”对事件参数进行编辑操作。或者点击“添加事件”在该产品下添加新的设备事件。产品最多可添加30个事件(包含设备事件和属性事件)。

设备事件列表

添加设备事件

点击“添加事件”,弹出事件编辑面板,首先您需要选择要添加的事件类型(设备事件、属性事件)

设备事件面板

  • 事件名称:产品内事件名称需唯一,且不可与功能名称重复;
  • 标识符:产品内事件名称需唯一,且不可与功能标识重复;
  • 分类:您可为设备事件选择分类,目前支持的分类有1.告警、2.故障、3.消息。告警和故障事件是设备在运行过程中主动上报的异常事件,消息事件是设备上报的一般性信息;事件分类将用于接口通知和数据展示。
  • 上报参数:事件上报时您可以定义上报同时携带的参数信息,参数可以选择之前定义好的产品属性,最多可携带5组上报参数;
属性事件

目前暂未开放

callback设置

当您需要获取设备变更产生的通知并进行相应处理时,您可以在产品的“callback设置”里完成设置。

添加“callback设置”

在“产品详情”点击“添加更多服务”,打开“callback设置”

添加callback设置

设置通知URL

进入callback设置页面,您需要设置callback的通知url并设置您要订阅的通知类型。

callback设置页面

点击回调url地址“设置”,在输入框中输入您的callback回调url。

输入url

订阅通知类型

订阅通知类型

目前平台提供了如下通知类型

  • 添加新设备:产品添加新设备后通知;
  • 设备数据变化:设备属性数据发生变化后通知;
  • 删除设备:产品删除设备后通知;
  • 设备事件:设备产生事件并上报后通知;
  • 设备激活:产品有设备激活后通知;
  • 设备上线:产品有设备上线后通知;
  • 设备下线:产品有设备下线后通知;
  • 设备消息转发:设备绑定后设备上报消息转发事件时通知;

订阅通知开关 您可以选择要订阅的通知类型并打开订阅开关,开启后设备发生相应通知事件后会推送至您设置的回调URL。

您也可以将已开启的订阅开关关闭,关闭后您将不会收到此类通知。

callback消息协议

当您收到Callback消息时,应该根据如下协议,对消息进行解析。通常,需要根据通用协议,获取到指定的通知类型标识,再根据通知类型标识,解析payload部分,获取到关注的数据。

通用协议
{
    "pKey":"产品key",
    "dName":"设备名称",
    "transaction":"业务标识",
    "timestamp":1534353132000
    "payload": {

    }
}

参数说明

参数名 类型 说明
pKey string 产品key
dName string 设备名称
transaction string 业务标识
timestamp long 时间戳,毫秒级
payload json 透传消息

FeedBack消息协议

设备上线

{
    "pKey":"产品key",
    "dName":"设备名称",
    "transaction":"deviceOnline",
    "timestamp":1534353132000
}

参数说明

参数名 类型 说明
pKey string 产品key
dName string 设备名称
transaction string 业务标识
timestamp long 时间戳,毫秒级

设备下线

{
    "pKey":"产品key",
    "dName":"设备名称",
    "transaction":"deviceOffline",
    "timestamp":1534353132000
}

参数说明

参数名 类型 说明
pKey string 产品key
dName string 设备名称
transaction string 业务标识
timestamp long 时间戳,毫秒级

添加新设备

{
    "pKey":"产品key",
    "dName":"设备名称",
    "transaction":"addDevice",
    "timestamp":1534353132000
}

参数说明

参数名 类型 说明
pKey string 产品key
dName string 设备名称
transaction string 业务标识
timestamp long 时间戳,毫秒级

删除设备

{
    "pKey":"产品key",
    "dName":"设备名称",
    "transaction":"deleteDevice",
    "timestamp":1534353132000
}

参数说明

参数名 类型 说明
pKey string 产品key
dName string 设备名称
transaction string 业务标识
timestamp long 时间戳,毫秒级

设备激活

{
    "pKey":"产品key",
    "dName":"设备名称",
    "transaction":"activateDevice",
    "timestamp":1534353132000
}

参数说明

参数名 类型 说明
pKey string 产品key
dName string 设备名称
transaction string 业务标识
timestamp long 时间戳,毫秒级

设备数据变化

{
    "pKey":"产品key",
    "dName":"设备名称",
    "transaction":"deviceDataChanged",
    "timestamp":1534353132000,
    "payload":{
        "mid":"123",
        "version":"1.0",
        "data":{
            "params":{
                "prop1":"xxx",
                "prop2":"xxx"
            }
        }
    }
}

参数说明

参数名 类型 说明
pKey string 产品key
dName string 设备名称
transaction string 业务标识
timestamp long 时间戳,毫秒级
payload object 数据体
mid string 消息id
version string 协议版本号
data object 明细数据
params object 属性字段对象

设备事件

{
    "pKey":"产品key",
    "dName":"设备名称",
    "transaction":"deviceEvent",
    "timestamp":1534353132000,
    "payload":{
        "mid":"123",
        "version":"1.0",
        "data":{
            "event":"事件唯一标识",
            "params":{
                "prop1":"xxx",
                "prop2":"xxx"
            }
        }
    }
}

参数说明

参数名 类型 说明
pKey string 产品key
dName string 设备名称
transaction string 业务标识
timestamp long 时间戳,毫秒级
payload object 数据体
mid string 消息id
version string 协议版本号
data object 明细数据
event string 事件唯一标识
params object 属性字段对象

设备间消息路由

{
    "pKey":"产品key",
    "dName":"设备名称",
    "transaction":"deviceMessageForward",
    "timestamp":1534353132000,
    "payload":{
        "mid":"123",
        "version":"1.0",
        "data":{
            "identifer":"system.msg.transform.notice",
            "params":{
                "fromPKey":"源产品key",
                "fromDName":"源设备名称"
            }
        }
    }
}

参数说明

参数名 类型 说明
pKey string 产品key
dName string 设备名称
transaction string 业务标识
timestamp long 时间戳,毫秒级
payload object 数据体
mid string 消息id
version string 协议版本号
data object 明细数据
identifer string 服务标识
params object 属性字段对象
fromPKey string 源产品key
fromDName string 源设备名称

results matching ""

    No results matching ""