addCustomAlarm - 新增或修改自定义的告警规则。

SmartAlarmAbility.addCustomAlarm(options: AddCustomAlarmOptions)

版本要求:

@ray-js/panel-sdk≥1.8.0

描述

新增或编辑自定义的告警规则

参数

参数	类型	必填	说明
		是	告警规则配置

返回值

类型：Promise<AddCustomAlarmResult>

元组 [新增/更新的规则, 更新后的完整规则列表]

引用对象

typeAddCustomAlarmResult

[AddCustomAlarmBindResult, CustomAlarmList]

typeDpId

type DpId = number;

typeAddCustomAlarmBindResult

属性	类型	描述
`associativeEntityValue`	string	关联实体值，用于区分告警类型
`associativeEntityId`	string	关联实体 ID，通常为功能点 ID
`bindId`	number	绑定 ID
`bizDomain`	string	业务域，告警固定为 miniAppPanelSDKAlarm
`enable`	boolean	是否启用
`sourceEntityId`	string	设备 ID

typeCustomAlarmList

export type CustomAlarmList = CustomAlarmRule[];

typeCustomAlarmRule

属性	类型	描述
`triggerRuleId`	string	告警执行的规则 id
		触发告警规则的详细信息，详见 AlarmTriggerRuleVO 定义
`bizDomain`	string	业务域标识，在告警 SDK 下固定为 miniAppPanelSDKAlarm
`associativeEntityValue`	string	当 associativeEntityId 不足以区分情况下使用，比如使用的是同一个功能点时又要区分告警类型的情况下，可以使用 DpValue，一般情况下用不到
`sourceEntityId`	string	和当前告警相关联的设备 ID
`name`	string	名称或备注
`icon`	string	图标
`bindId`	number	绑定 ID
`associativeEntityId`	string	和当前告警相关联的功能点 DP ID
`enable`	boolean	是否启用

typeAlarmTriggerRuleVO

属性	类型	描述
`ownerId`	string	家庭 id
`enabled`	boolean	告警规则是否启用
`id`	string	执行规则 id
`name`	string	告警名称或备注
		执行动作的前置条件，详见 AlarmPreCondition 定义
		执行动作的条件，详见 CustomAlarmCondition 定义
		执行的动作，详见 CustomAlarmSceneAction 定义

typeAlarmPreCondition

属性	类型	描述
		条件表达式
`condType`	"timeCheck"	条件类型，告警 SDK 固定为 timeCheck
`id`	string	条件 ID

typeCustomAlarmCondition

属性	类型	描述
`id`	string	条件 ID
`ruleId`	string	规则 ID
`entityId`	string	数据 ID
`entitySubIds`	string	抽象子数据 ID
`expr`	string	条件的表达式

typeCustomAlarmSceneAction

属性	类型	描述
`id`	string	条件 id
`ruleId`	string	场景 id
`actionExecutor`	string	动作类型，在告警 SDK 下固定为 appPushTrigger

typeCustomAlarmPreConditionExpr

属性	类型	描述
`timeZoneId`	string	时区 id，如 Asia/Shanghai
`start`	string	开始时间，格式为 HH:mm，如 00:00
`timeInterval`	string	时间间隔，固定为 'custom'
`loops`	string	循环日期，'1111111' 说明为一周七天均开启，其中起始时间为周日
`end`	string	结束时间，格式为 HH:mm，如 23:59

合法值

`AddCustomAlarmOptions.condition`

值	说明	最低版本
`==`	-	-
`<`	-	-
`>`	-	-
`<=`	-	-
`>=`	-	-

示例代码

示例

const [newRule, allRules] = await sdm.alarm.addCustomAlarm({
  name: '高温告警',
  condition: [['temp_current', '>', 40]],
  preCondition: {
    startTime: '08:00',
    endTime: '22:00',
    loops: '1111111',
  },
});
console.log('新增规则:', newRule.bindId);