Home Elements Boards Recipes

Reference Element

The ReferenceElement allows creating actions by comparing an incoming value with a reference value.

The output of comparing the 2 values can be used to switch a device on or off. This can be used e.g. to control heating or light based on the actual temperature or light brightness.

Element Configuration

value - The input value for the comparison typically coming from a sensor.

reference - The reference input value for the comparison typically coming from a value element.

invert - The output value can be logically inverted by setting this property to true. Default is false.

onReference -These actions are emitted when the value goes across the reference value.

onHigh - These actions are send when the value is above the reference value. The value given in the actions is 1.

onLow - These actions are send when the value is below the reference value. The value given in the actions is 0.

Configuration Example

This example shows how to configure this element:

{
  "reference": {
    "temp": {
      "title": "Heater Control",
      "onreference": "digitalout/heater?value=$v",
      "invert": "true",
      "value": "1"
    }
...
  }
}

Element State

The following properties are available with the current values at runtime

active - Is set to true when the element is active.

value - Current output value of the element.

{
  "reference/temp":{
    "active":"true",
    "value":"0",
    "reference":"22.00"
  }
}

See also

Tags

Element