Skip to main content
Version: latest

Alarms via E-mail

Ultinous AI Suite allows you to send alarms via e-mail. The service can be set up to be used by either human beings or automated systems.

The following section walks you through the steps needed to have a working setup.

Sender Configuration

  1. In Ultinous AI Suite, navigate to the System section of the Control Panel, then click the E-mail box.

  2. Sender e-mail address: Type the e-mail address you would like to send the alarms from.

  3. URL of the UI: This is the URL of the Ultinous AI Suite platform that you are using at the moment of configuration. It is filled in for you by default.

    If the recipient(s) accesses Ultinous AI Suite from a different address than the sender (Note: this is and advanced, optional step - proceed only if you are confident), you may enter the URL of the Ultinous AI Suite the recipient is using.

  4. Encryption (optional): Some e-mail providers require encryption. Two types can be set here: STARTTLS and SSL_TLS.

  5. Server name: The name of the smtp server to send the alarms from. E.g. smtp.gmail.com.

  6. Port name: Enter the port of the smtp server used to send the alarms from.

  7. User name and Password (optional): If your e-mail server requires user credentials to send e-mail, you can optionally set them here. If you have a Gmail account, read below on how to set up its password.

  8. Click the Save button.

NOTE: Custom CA certificates can be uploaded in the Trusted Certificates setting.

2-factor Authentication with Gmail

Starting from May 2022, Google will discontinue the support for logging in so-called "less secure apps": this effectively means any non-Google apps previously using the password itself will have to use an OAuth2 token instead.

To support e-mail sending with Ultinous AI Suite, you should create such a token - that Google calls an Application Specific Password or App Password.

You must have 2-Factor Authentication (2FA) enabled to create an App Password.

If you do, you can create App Password here.

Select "Mail" as application, "Other" as device. You'll be asked to name this device; enter "Ultinous AI Suite" (or something similar). You will receive a 16 character password, which is shown only once, so make sure to save it somewhere.

Then continue by setting up your e-mail settings in Ultinous AI Suite as follows:

  • Sender e-mail address: your gmail address

  • Encryption: SSL_TLS

  • Server name: smtp.gmail.com

  • Server port: 465

  • Username: your gmail address

  • Password: the 16 character App Password you received, without spaces

Test email

Once you are finished with the configuration, you can test it here. Type in the list of recipients, separated by comma, then click the Send button. If configured properly, the recipients should receive a test alarm shortly.

Recipient configuration

Each alarm can be set up to have different sets of recipients. Therefore the configuration of recipients is done individually, on an alarm-by-alarm basis.

  1. Open the Solutions panel of Ultinous AI Suite.

  2. Click the alarm you would like to setup with recipients and scroll down to the bottom of the page.

  3. Tick the SMTP or Central Station Monitoring software button. By default, Email is selected as the integration option.

  4. Fill in the Recipient of email field with the list of desired recipients, separated by comma.

  • Enable snapshot attach (for supported solutions): Off by default. If enabled, it fills in the snapshot field of the http message [schema] in base64 encoded format.

  • Enable video attach (for supported solutions): Tick this button to attach video, in .mp4 format: it begins 2 seconds before the corresponding incident, and stops 4 seconds after the incident's end timestamp. In the current version, the attached video file size does not exceed 18 megabytes.

    NOTE: If video sending is enabled and incidents are received very frequently and for an extended period of time, it may overload the system to a point where some video attachments could get delayed or not even included in their respective email.

  1. Click the Save button.

E-mail format

The e-mail provides information about the alarm in three ways: in the subject, in the e-mail body, and as attachment. This output.json can be used by automated systems - the schema is the same as described in Custom integration.

The email contains the following, with snapshot and video attachments enabled:

  • Email Subject:

    [Ultinous AI Suite notification] AlarmName [2022-08-02T16:44:07.817+02:00]

    • [Ultinous AI Suite notification] is a constant String.
    • AlarmName is the name of the alarm set by the user in Ultinous AI Suite, e.g. Missing PPE.
    • [2022-08-02T16:44:07.817+02:00] is the timestamp of the incident.
  • Message body:

    Add a new Camera
    • Alert name: The name of the registered PPE solution.
    • Time stamp: The timestamp of the incident.
    • More info: Clicking the link opens the corresponding event on the Events page of Ultinous AI Suite.
  • Snapshot: A snapshot of the incident, in .jpg format.

  • Video: A video of the event in .mp4 format. It begins 2 seconds before the incident occurred, and stops 4 seconds after the incident's end timestamp. In the current version, the attached video file size does not exceed 18 megabytes.

  • output.json file: Contains the technical details of the event.