Universal Bridge

Lumeo Universal Bridge is a set of connectors that make it easy to push video clips to Lumeo for processing.

The Universal Bridge is a cloud service that allows you to add a wide range of cloud-based, AI-powered analytics to existing IP Cameras and NVRs without requiring any additional hardware on-site.

Clips uploaded via the Universal bridge are associated with a camera in Lumeo. Using the Lumeo console, you can then specify a default pipeline, to be applied to each uploaded clip for that camera, thereby automating the processing of clips with video analytics.

📘

Prerequisites

Ensure that you have a Gateway setup in your account.

Getting Started

To start using the Universal Bridge to process clips, create a Virtual Camera in Deploy -> Cameras section in the Console, and ensure that a unique External Source Identifier is specified.

Ingest MethodExternal Source Identifier RequiredExternal Source Identifier Format
SMTPYesEmail address (can be non functional)
ex: [email protected]
FTPYesAny string without spaces and without a forward shash / .
ex: office-front-camera
APIOptional.
If not specified, you will need to save the Virtual Camera's ID from Lumeo Console and specify it when using the API Connector.
Any string without spaces
ex. office-front-camera, ab12-adef-1233

Add a Virtual Camera and set it's External Source Identifier

Add a Virtual Camera and set it's External Source Identifier

In Camera Settings, set a pipeline to run when new clips are uploaded for this camera.

In Camera Settings, set a pipeline to run when new clips are uploaded for this camera.


Ingest

In the next step, start ingesting video clips using one of the connectors below.

SMTP Connector

The SMTP Connector allows 3rd party clients & devices (Cameras, NVRs, VMS', other services) to send video clips to Lumeo using SMTP. When the Universal Bridge receives video clips, it saves them to the Lumeo Cloud and runs the configured Lumeo pipeline on it in the cloud.

The SMTP Connector only works with devices and clients that allow specifying a SMTP server to be used to send emails. It will not accept emails relayed from other mail servers.

Configuration

SettingValueNotes
SMTP Serversmtpgateway.lumeo.com
SMTP Port8025 (PlainText Or STARTTLS support)
8587 (SSL)
PlainText Port : Clients connecting over plaintext that support the SMTP STARTTLS extension can issue the STARTTLS command before attempting to authenticate.

SSL Port : Clients connecting over this port do not need to use STARTTLS to enable authentication, as this connection is secure by default.
SMTP UsernameWorkspace Application ID
or
Base 64 encoded Workspace Application ID
or
Email address with Workspace ID as the prefix
See SMTP Authentication Section below.
SMTP PasswordUniversal Bridge TokenSee SMTP Authentication Section below.
Email Sender (From)Any unique email address (does not have to be functional)._ This address will be used to identify this camera within Lumeo. Set/view in Camera detail -> Settings -> Universal Bridge -> External Source Identifier.

_ Is prefixed to the resulting deployment’s name and incoming video clips uploaded to Lumeo cloud.

* If the Pipeline has an Trigger Immix Alarm Node node, this From email will be set as the Immix Alarm’s destination address.
Email Recipient (To)Same as From.
SubjectAnyUnused by Lumeo

SMTP Authentication

Uses Universal bridge credentials found in Settings -> Universal Bridge in console.

Username: Workspace ID (found in Settings tab, left nav)
Password: Universal Bridge Token (generated and revokable in Settings tab -> Universal Bridge section)

📘

Watch out for Camera limits on Username and Password

Some cameras may limit the length of the username and password fields and truncate values you enter.

For workspace id / username, Lumeo supports the following to fit in with Camera SMTP username limitations:

  • Workspace ID (exd4119234-c5cc-4723-861b-b7095ed33e73)
  • Remove dashes from Workspace ID. (ex d4119234c5cc4723861bb7095ed33e73)
  • Base64 encoded bytes of Workspace ID (ex. zMCQYfjnRd2AH185-QOudA)
  • Email address with Workspace ID as a prefix and Camera External ID as suffix (ex. [email protected])

Email Sender

Email "From" address is used to correlate the clip with Cameras in Lumeo. To associate with an existing camera, navigate to the Camera details page and set the External Identifier to the desired email under Universal Bridge settings.
If a Camera with the From address is not found, the Universal Bridge will create a new Virtual Camera in your workspace and assign the From address as it's External Identifier. In this case, the files will be uploaded but not processed till a Default pipeline is set.

Email Recipient

Email Recipient corresponds to the email’s To MIME header. It should be set to the same value as the Email Sender.

FTP Connector

Coming soon.

API Connector

Uses Workspace ID and API Key credentials found at API, not the Universal bridge password.

Uses the Lumeo API to emulate the Universal bridge capabilities for clip processing, letting you set a per-camera configuration easily using the Console.

See here : https://github.com/lumeohq/scripts/tree/main/universal-bridge-uploader

The API Connector can be used to upload clips using an External source identifier, or using the Virtual Camera's ID.

Processing

When the Universal Bridge receives a video clip, it does the following:

  1. save it to Lumeo Cloud
  2. associate it with a camera that matches the it's External Identifier, creating a new virtual camera if there was no match
  3. and if a Universal bridge default pipeline is configured in camera settings, queue the clip up to be processed.

A newly created Virtual camera will not process any clips, just save them to the Cloud. In order to start processing new clips, you need to set a default Universal Bridge Pipeline in the Camera settings. .

See a list of uploaded clips from the camera -> Universal Bridge tab.

See a list of uploaded clips from the camera -> Universal Bridge tab.

Reference Deployments

The first time a clip is processed by the Universal Bridge for a camera that has a default pipeline, a "Reference Deployment" is created. This is listed in Camera detail -> Settings -> Universal Bridge section.

For future clips, Universal Bridge creates a new deployment of given pipeline, reusing the configuration of the Reference Deployment of that pipeline, while overriding inputs and metadata specific to the Universal Bridge.

This lets you create a master “Video Verification” pipeline that you can keep up to date (such as by adding a new alert mechanism) — and generates a per-Camera “reference” deployment when the first inbound clip is received. This “reference” deployment can be updated with per-Camera settings such as ROI adjustments, for future clips.

Deleting a Reference Deployment will cause a new one to be created with the next Clip.

Set default pipeline for the Camera, and edit reference deployment under camera settings.

Set default pipeline for the Camera, and edit reference deployment under camera settings.

To set a per-camera configuration for the pipeline, Edit & redeploy the Reference Deployment :

  1. Click on the Reference Deployment listed in Camera Settings
  2. Edit the deployment settings by clicking the pencil icon on the Configuration tab.
  3. Update the deployment and (Optionally) start it after editing the settings to see the updated settings in action.
Update the reference deployment by clicking the pencil icon on the configuration tab of the deployment.

Update the reference deployment by clicking the pencil icon on the configuration tab of the deployment.

Deployments

Lumeo will schedule new deployments for received clips to be processed on any of the gateways available in the workspace in a load-balanced fashion. Once scheduled, these deployments will appear in the Camera -> Deployments tab.

1163

Camera detail -> Deployments tab shows all the deployments created by the Universal Bridge for that Camera.

3139

Events page shows all the events pertaining to a specific incoming video clip.

Limitations

  • Queueing : If all gateways in the workspace have reached their configured max number of the deployments running, the clips are queued at the workspace level to be deployed when a gateway deployment slot is available. During Beta, the status of the queue is not available through Console but available through the Lumeo API.

Troubleshooting

  • Unable to be authenticate or see anything happening on Lumeo Console:
    • First verify SMTP communication is working by using the test function available on many cameras like AXIS, and check the Events page for events generated by the Universal Bridge.
    • Verify that application ID and application token are correct
    • When using the Immix node, the sender e-mail can override the ‘Immix To Email’ to send alarm if the “Enable Universal Bridge Override” option is enabled. Additionally at this time there is side effect that if the save clips and sent clips are same length, Immix node may not sent out the e-mail. The solution is to have size of the Immix node clips to be shorter than the original sent clip.