Global

Members

NO_RESCHEDULE

Description:

  • Do not reschedule the alert if it is already scheduled or active.

Source:

Do not reschedule the alert if it is already scheduled or active.

RESCHEDULE

Description:

  • Reschedule the alert.

Source:

Reschedule the alert.

RESCHEDULE_IF_DELAY_CHANGED

Description:

  • Reschedule the alert only if the delay has changed.

Source:

Reschedule the alert only if the delay has changed.

Type Definitions

Item

Source:
Type:
  • module:openhab/types/items/items~Item

MlscRestClientConfig

Description:

  • configuration for MlscRestClient

Source:
Properties:
Name Type Attributes Default Description
effectItemName string

name of the effect Item: Do NOT set state description metadata on that Item, this will be done for you.
url string

full URL for mlsc, e.g. http://127.0.0.1:8080
deviceId string

ID of device inside mlsc, use HTTP GET /api/system/devices to get a list of available devices
colorItemName string <optional>

name of the color Item
dimmerItemName string <optional>

name of the dimmer Item
defaultEffect string <optional>
 'effect_gradient'

default effect for the Dimmer Item
refreshInterval number <optional>
 15000

refresh interval in milliseconds
switchOnDelay number <optional>

switch-on delay in milliseconds, e.g. useful if power multiple power supplies with different power-on times are used

configuration for MlscRestClient

Type:
  • Object

MuteAlertFunction(contactItemName, duration)

Description:

  • Function to mute an alert for a specific contact Item for a certain time.

Source:
Parameters:
Name Type Description
contactItemName string

the name of the contact Item to mute
duration number

the duration in minutes to mute the alert for

QuantityClass

Source:
Type:
  • module:openhab/types/items/items~Item

RainAlarmConfig

Description:

  • configuration for rain alarm

Source:
Properties:
Name Type Attributes Default Description
sendAlertCallback SendAlertCallback

callback to send an alert
revokeAlertCallback RevokeAlertCallback

callback to revoke an alert
rainalarmItemName string

name of the Item to monitor for rain
rainalarmActiveState string <optional>
 OPEN

state of the Item that indicates rain
contactGroupName string

name of the contact group to monitor
ignoreItems Array:.<string:> <optional>

list of Item names to ignore
messagePattern string

message pattern to use for alerts, use placeholder %LABEL for Item label
windspeedItemName string <optional>

name of the wind speed Item
contactLevelToWindspeed Array:.<{contactLevel:: number:, treshold:: QuantityClass:}> <optional>

wind speed threshold as Quantity for individual contact levels
contactLevelToMessagePattern Array:.<{contactLevel:: number:, messagePattern:: string:}> <optional>

message pattern overrides for individual contact levels, use placeholder %LABEL for Item label

configuration for rain alarm

Type:
  • Object

RevalidateAlertCallback() → {boolean}

Description:

  • Callback for revalidating an alert.

Source:
Returns:

true if the alert should be sent, false otherwise

Type
boolean

RevokeAlertCallback(id)

Description:

  • Callback for revoking an alert.

Source:
Parameters:
Name Type Description
id string

the unique identifier of the alert to be revoked

RevokeAlertCallback(id)

Description:

  • Callback for revoking an alert.

Source:
Parameters:
Name Type Description
id string

the unique identifier of the alert to be revoked

SendAlertCallback(id, message)

Description:

  • Callback for sending an alert.

Source:
Parameters:
Name Type Description
id string

the unique identifier for the alert
message string

the message to be displayed in the alert

SendAlertCallback(id, message)

Description:

  • Callback for sending an alert.

Source:
Parameters:
Name Type Description
id string

the unique identifier for the alert
message string

the message to be displayed in the alert

TemperatureAlarmConfig

Description:

  • configuration for heat and frost alarms

Source:
Properties:
Name Type Attributes Default Description
name string

the name of the alarm, e.g. "Heat Alarm"
sendAlertCallback SendAlertCallback

callback to send an alert
revokeAlertCallback RevokeAlertCallback

callback to revoke an alert
repeat boolean <optional>
 false

whether to repeat the alert after the delay
temperatureItemName string

name of the Item that to monitor the temperature
contactGroupName string

name of the contact group to monitor
ignoreItems Array:.<string:> <optional>

list of Item names to ignore
alarmConditionCallback TemperatureConditionCallback

callback to decide whether the alarm is active depending on the temperature
delayCallback TemperatureDelayCallback

callback to get the delay in minutes for alerting depending on the temperature
messagePatternCallback TemperatureMessagePatternCallback

callback to get the message pattern depending on the temperature
perItemConditionCallback TemperaturePerItemConditionCallback <optional>

optional callback to evaluate conditions per Item

configuration for heat and frost alarms

Type:
  • Object

TemperatureConditionCallback(temperature) → {boolean}

Description:

  • Callback for evaluating a temperature condition.

Source:
Parameters:
Name Type Description
temperature QuantityClass

the current temperature
Returns:

true if the temperature is in alarm range, false otherwise

Type
boolean

TemperatureDelayCallback(temperature, contactLevel) → {number}

Description:

  • Callback for getting the alerting delay depending on the temperature and the contact level.

Source:
Parameters:
Name Type Description
temperature QuantityClass

the current temperature
contactLevel number

the contact level of the Item
Returns:

delay in minutes

Type
number

TemperatureMessagePatternCallback(temperature, contactLevel) → {string}

Description:

  • Callback for getting the alert message pattern depending on the temperature and the contact level. Use %LABEL as placeholder for the Item label.

Source:
Parameters:
Name Type Description
temperature QuantityClass

the current temperature
contactLevel number

the contact level of the Item
Returns:

message pattern

Type
string

TemperaturePerItemConditionCallback(temperature, item) → {boolean}

Description:

  • Callback for evaluating conditions per Item for the temperature alarm.

Source:
Parameters:
Name Type Description
temperature QuantityClass

the current temperature
item Item

the Item to evaluate conditions for
Returns:

true if the conditions are met for the Item, false otherwise

Type
boolean