Overview

Set a trigger based on current time. This node is useful to get downstream nodes to take action (or not) depending on the day of week or time of day.

Example use cases:

• Don't send alarms or alerts during work hours when a person enters an area. Occupancy Monitor -> Time Trigger -> Trigger Email Alert Node (with trigger set of Time Trigger and Occupancy Monitor Trigger)
• Don't process the rest of the pipeline outside a set range of hours. Video Source Node -> Time Trigger -> Filter Stream Node (with trigger set to Time trigger metadata) -> rest of pipeline.

Remember : To use the output of the Time Trigger Node, you must use a Trigger Condition of type nodes.time_trigger1.triggered in a downstream node.

Inputs & Outputs

• Inputs : 1, Media Format : Raw Video
• Outputs : 1, Media Format: Raw Video
• Output Metadata : Time trigger state

Properties

Time Range Format

The time_ranges property supports multiple time ranges, comma separated. Each range must be of the following format, although you can mix and match types in a single node:

Behavior

This node will set a trigger when current time meets the 3 criteria specified : day_of_week and period and time_ranges.

• Setting a period along with day_of_week and/or time_ranges lets you trigger it periodically within those time ranges
• Setting day_of_week values along with time_rangeswill limit the trigger to the overlap of both.

Output Metadata

The fields below are declared by this node's metadata schema; the JSON values are representative examples.

JSON example

{
  "nodes": {
    "time_trigger1": {
      "triggered": true,
      "triggered_delta": false,
      "type": "time_trigger"
    }
  }
}