Time Trigger Node
Trigger actions based on current time
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)
Inputs & Outputs
- Inputs : 1, Media Format : Raw Video
- Outputs : 1, Media Format: Raw Video
- Output Metadata : Time trigger state
Properties
Property | Value |
---|---|
day_of_week | Trigger on this day of the week. Options: - null (all days)- sunday - monday - tuesday - wednesday - thursday - friday - saturday |
period | Trigger periodically Options: - null : Disabled- day : Every day at 00:00- hour : Every hour at 0 mins past the hour- 30min : Every 30 mins, starting at 0 mins past the hour- 15min : Every 15 mins, starting at 0 mins past the hour- seconds : Every X seconds from start of deployment |
interval | Trigger at a fixed interval, when period is seconds .Only required when period is seconds .Ex. 60 will trigger at every sixty seconds. |
time_ranges | Comma separated times or time ranges to trigger at. ex. 12pm to 4pm, 5pm, 8pm-9pm will set the trigger continuously between 12pm and 4pm, then once at 5pm, and then continuously between 8pm and 9pm. |
timezone | Timezone. Options: - us/pacific - us/central - us/mountain - us/eastern - other : Specify offset from GMT using timezone_offset |
timezone_offset | Timezone Offset in hours from GMT, when timezone is other Ex. 5.5 is GMT +5:30 |
Metadata
Metadata Property | Description |
---|---|
nodes.<node_id> | Format : as defined in the table below.<node_id> for is of the form time_triggerX (ex. time_trigger1 ) |
Example
"nodes": {
"time_trigger1": {
"type": "time_trigger",
"triggered": True
}
}
Format
Key | Type | Description |
---|---|---|
triggered | Boolean | True if current time matches the configuration, else False |
Updated 3 months ago