alerting

rulesx. Namespace

alerting

Description:

  • Alerting namespace

    This namespace provides alerting rules, e.g. for open windows on rain.

Source:

Classes

HeatFrostalarm
Rainalarm

Methods

(static) createFrostAlarmRule(config)

Description:

  • Create the frostalarm rule.

Source:
Parameters:
Name Type Description
config heatOrFrostAlarmConfig

alarm configuration

(static) createHeatAlarmRule(config)

Description:

  • Create the heat alarm rule.

Source:
Parameters:
Name Type Description
config heatOrFrostAlarmConfig

alarm configuration

(static) createRainAlarmRule(config)

Description:

  • Creates the rain alarm rule.

Source:
Parameters:
Name Type Description
config rainAlarmConfig

rainalarm configuration

Type Definitions

heatOrFrostAlarmConfig

Description:

  • configuration for rainalarm

Source:
Properties:
Name Type Description
type string

alarm type, either heat or frost
alarmLevelItem string

name of Item that holds the alarm level
outsideTemperatureItem string

name of outside temperature Item
roomTemperatureItemSuffix string

suffix to add to the room's name to get the temperature Item's name
contactGroupName string

name of the contact group to monitor
ignoreList Array.<string>

list of contact Item names to ignore
roofwindowTag string

tag that all roofwindow contacts have for identification
tempTreshold number

Temperature treshold, for difference between inside temp to outside. Example: -2 means at least 2 degrees lower temp on the outside.
notification Object

notification to send

Properties
Name Type Description
alarm Object

alarm notification

Properties
Name Type Description
title string
message string
warning Object

warning notification

Properties
Name Type Description
title string
message string
time Object

Times until an alarm is sent.

Properties
Name Type Description
open number
halfOpen number

window is tilted or roofwindow is on "große Lüftung"
klLueftung number

roofwindow is on "kleine Lüftung"
addForWarning number

Time to add when it's only a warning.

configuration for rainalarm

Type:
  • Object

rainAlarmConfig

Description:

  • configuration for rain alarm

Source:
Properties:
Name Type Attributes Default Description
rainalarmItemName string

name of the rain alarm Item
rainalarmActiveState string <optional>
 OPEN

state of the Item for an active alarm, all other states (including UNDEF, NULL) are considered as alarm inactive
windspeedItemName string

name of the wind speed Item
contactGroupName string

name of the contact group to monitor
ignoreList Array.<string>

list of contact Item names to ignore
roofwindowTag string

tag that all roofwindow contacts have for identification
windspeedKlLueftung number

wind speed threshold for an alarm on "kleine Lüftung"
windspeedGrLueftung number

wind speed threshold for an alarm on "große Lüftung"

configuration for rain alarm

Type:
  • Object