Menu

Timer Provider

The Timer Provider is triggered by an event and sets an output for the specified timer interval time.

Configuration

  • Input Value
    Select an input provider which value is evaluated by the trigger condition and check-value.
    If this condition is true, the timer starts and the output is set to 1. After the interval time has elapsed, the timer stops and the output changes to 0.

  • Output
    Select a provider which input is triggered by the timer, e.g. a REST or MQTT provider.

  • Trigger Condition
    The condition by which the input value is tested:

    Condition Condition Value Description

    On Update

    Innored

    Trigger on every update of the input provider

    Change

    Ignored

    Trigger if input != actual
    This condition checks text strings as well

    Incremented

    step

    Trigger if input >= actual + step

    Decremented

    step

    Trigger if input ⇐ actual - step

    In Interval

    interval

    Trigger if input / interval != (actual / interval)

    Is Equal

    check

    Trigger if input == check && input != actual
    This condition checks text strings as well

    Is Equal or Greater

    check

    Trigger if input >= check && input != actual

    Is Equal or Smaller

    check

    Trigger if input ⇐ check && input != actual

    Is Greater

    check

    Trigger if input > check && input != actual

    Is Smaller

    check

    Trigger if input < check && input != actual

  • Condition Value
    The check, step or interval value used by the condition above.
    This may by a text string as well, when the condition is Change or Is Equal.

  • Timer Interval
    The interval time how long the timer is active, like 30s or 1m.

Query

  • Elapsed Time
    Returns the elapsed time since the timer has been started in the given duration format:

    Text Numeric

    Duration in the format specified by Param 1

    Duration value in Units specified by Param 1

    • Param 1
      Repeating a token sets the leading zeros, e.g. ss gives 04 for 4 seconds.
      Available Pattern Tokens:

      Token Duration element

      S

      Milliseconds

      s

      Seconds

      m

      Minutes

      H

      Hours

      d

      Days

      w

      Weeks

      'text'

      Text content

      E.g. use "HH:mm:ss" for an hour countdown with a second resolution.

      For numeric output:

      Param 1 Output

      S

      Milliseconds

      s

      Seconds

      m

      Minutes

      H

      Hours

      d

      Days

      w

      Weeks

  • Starttime
    The wall clock time of the last start event.

    Text Numeric

    Time in the format specified by Param 1

    Milliseconds since 1970-01-01 00:00:00 UTC + Timezone

    • Param 1
      The time format of the text representation. See Time Format for details.
      If empty, the default ISO format yyyy-MM-dd’T’HH:mm:ss.SSSxxx is used.

  • Is Running
    Returns 1 if the timer is running, 0 if it is stopped.

  • Status
    Returns the status of the timer.

    Text Numeric Description

    N/A

    0

    Timer was not start yet

    Excellent

    1

    Timer is running

    Good

    2

    Timer is stopped

Action

  • Set: (Re)Start
    Query to start or restart the timer by another provider or facelet.
    E.g. can be used by the Button facelet to start the timer.

  • Set: Stop
    Query to stop the timer by another provider or facelet.