Home Elements Boards Recipes

Scene Element

The Scene Element sends a series of actions triggered by a single incoming action. They can be send out step by step using a defined delay or by actions.

In the configuration a list of steps is defined containing actions for other elements.

This list can be executed automatically using a defined delay and a start action or can be started individually by a next action.

In normal cases when only one or few actions should be triggered multiple actions can be listed inline in action configurations of elements.

Scene Element Eb UI

The scene element allows sending multiple actions beyond this limit or when different element need to send the same list of events but different values.

The scene element also can be used to configure presets of multiple element values at a single place by using multiple scene definitions.

A scene element can also be controlled over the network by using a simple links like:

http://homeding/api/state/scene/day?start=1
http://homeding/api/state/scene/night?start=1
http://homeding/api/state/scene/stations?next=1

Element Configuration

This element implements the following properties and actions:

steps[] - This is an array of actions are emitted when the value of the scene element is set to any value.

delay - This property can be set to enable automatic starting all steps one after one. This property specifies the delay duration like 2s. When set to 0 (no automatic next step) a next action is required to advance to the next step. Default is 100ms

start - This action is used to start at step[0] and advance automatically when a delay is configured.

next - This action will start sending the actions of the next step.

prev - This action will start sending the actions of the previous step

From the base element implementation the following properties are available for configuration:

title – Caption text for the element. Used by the element specific cards on the dash boards.

description – A line of text that gives a short description of the device used in the web UI.

room – The location of the device.

loglevel – This property holds the element specific log level. The default value is LOGGER_LEVEL_ERR == 1.

startup – This property can be used to start the element using a different initialization phase. Possible values are “sys”, “net”, “time”. See The Startup sequence.

Configuration Example

This example shows how to configure this element:

{
  "scene": {
    "day": {
      "steps": [
        "light/ceiling?brightness=$v",
        "light/wall?brightness=$v",
        "switch/steps?value=0"
      ],
      "delay": 1
    },

    "night": {
      "steps": [
        "light/ceiling?brightness=0",
        "light/wall?brightness=0",
        "switch/steps?value=1"
      ],
      "delay": 0
    },
    "off": {
      "steps": [
        "light/ceiling?brightness=0",
        "light/wall?brightness=0",
        "switch/steps?value=0"
      ],
      "delay": 0
    }
  }
}

State

Some internal values of the element can be observed in the state.

{
  "scene/night": {
    "active": "true"
  }
}

See also

Tags

Element