Overview

The node sends an Immix Alarm using SMTP based on events generated by previous nodes, or a custom trigger condition. It can also send a link to live stream, attach a snapshot as well as any Clips saved Locally using Save Clip Node.

The event_source property controls how this node is triggered:

built_in (Events from previous nodes): Sends an Immix Alarm when other nodes in the pipeline (such as annotate_line_counter, event, etc.) generate events. The triggering event names are available to the immix_extra_text template via the events variable.
custom (Custom Event): Sends an Immix Alarm when the trigger condition evaluates to true.

Inputs & Outputs

Inputs : 1, Media Format : Raw Video
Outputs : 1, Media Format: Raw Video
Output Metadata : None

Properties

Property	Value
`event_source`	Generate Immix Alarms from events generated by other nodes (`built_in`) or a Custom defined event (`custom`).
`trigger`	Send the Email once this trigger condition is met. Required when event_source is `custom`. The trigger expression must be a valid Dot-notation expression that operates on Pipeline Metadata and evaluates to `True` or `False`. See details here. ex. `nodes.annotate_line_counter1.lines.line1.total_objects_crossed_delta > 0`
`enabled`	If false, this node will be disabled and will not send any alarms. Ex. `false`
`immix_server`	Immix IP Address or Hostname
`immix_port`	Immix Port
`immix_use_tls`	Use TLS. If true, a TLS socket will be used for the Immix SMTP session. Your Immix server must support the STARTTLS SMTP extension to use this.
`immix_to_email`	Immix To Email address. Ex. `[email protected]`
`immix_alarm_number`	Immix alarm number for the <Input1> element.
`immix_event_type`	Immix Alarm Type. Options: AccessDenied AccessGranted CounterChanged DeviceArm DeviceDisarm DoorForced Duress FireAlarm InputAlarm IntruderDetected LineCounter LogicalEvent MotionDetected ObjectAbandoned ObjectAppeared ObjectColour ObjectDetected ObjectDirection ObjectDisappeared ObjectDwell ObjectEntered ObjectExited ObjectRemoved ObjectSpeed ObjectStopped PanicAlarm PersonDetected SensorAlarm SystemEvent Tailgating TamperAlarm TestAlarm UnknownAlarm VehicleDetected VideoLoss
`immix_extra_text`	Extra Text sent in Immix Alarm. You may use template variables in this field. See below for template variables available. Ex. `Event triggered on {{ source_name }}`
`immix_location`	A description of location where the alarm occurred, e.g. latitude & longitude. Ex. `51.62001435507171,-3.9325847625732`
`include_snapshot`	Attach a snapshot from the time the trigger happened with the email.
`media_node`	Includes the most recent clip from the named Save Clip Node with the alarm. The node must be configured to store clips locally.
`enable_embedded_media`	If true, enables `livestream_node` capabilities.
`livestream_node`	Enables including the Live stream URL from the named WebRTC node with the email using `livestream_url` template variable. Ex. `stream_webrtc_out1`
`lumeo_api_key`	API Key for this Lumeo application. Required if `livestream_node` is specified.Find it here: API
`interval`	Min time (seconds) between consecutive Email notifications. Ex. `10`
`max_media_wait_time`	Maximum time to wait after a trigger until a media clip is available from the Save Clip Node. Ex. `10`

Template Syntax

The following Template variables are available to use in Email Subject and Body. The templates can be built using Jinja2 Template Syntax.

Variables available to the template:

Variable	Description
`events`	List of event names from previous nodes that triggered this alarm (when `event_source` is `built_in`).
`meta`	Frame metadata. Contains keys like `nodes`, `objects`, and other custom metadata inserted by Custom function node.
`application_id`	The application ID of the deployment that produced this metadata.
`application_name`	The application name of the deployment that produced this metadata.
`deployment_id`	The deployment ID of the deployment that produced this metadata.
`deployment_name`	The deployment name of the deployment that produced this metadata.
`source_name`	The name of the source that produced this metadata.
`livestream_url`	The URL of the livestream.

Example templates

Static text content:

Text content

Reference specific metadata:

Person detected on {{ source_name }}. View live stream at {{ livestream_url }}

Metadata reinserted as is:

{{ meta | tojson }}

Metadata

Metadata Property	Description
None	None