Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Add a Stream

Learn how to configure a stream that you can use to run a Workflow.

To run a Workflow on your edge device managed by Deployment Manager, you need to add a Stream. A Stream accepts a camera feed as an input and runs the data from the camera on a chosen Workflow.

To add a Stream, you will need:

  • A device set up with Deployment Manager.

  • A camera available to the device

  • A Workflow that you want to deploy on your device.

Streams can read:

  • An RTSP stream

  • A webcam plugged directly into your edge device via USB

  • A Basler camera connected via GigE (Ethernet) or USB 3.0

  • A Lucid camera connected via GigE (Ethernet)

For Basler or Lucid line scan cameras, choose "Basler Line Scan" or "Lucid Line Scan" and configure line rate, framing, and exposure.

Basler and Lucid industrial cameras are available on Enterprise plans. To enable them, contact the sales team.

Adding a Stream has three steps:

  1. Add camera information

  2. Choose a workflow.

  3. Review configuration.

Add Camera Information

To add a Stream, click on a Device you have registered with Deployment Manager from your dashboard, then click "Add Stream":

Add Stream button in the Streams tab

A window will then appear in which you can configure your Stream:

Create Stream dialog with camera source and Workflow settings

In this window, fill out:

  1. The "Name" for your Stream. Use letters, numbers, hyphens, and underscores. Spaces become hyphens, and each name must be unique on the device.

  2. The Workflow to run on the Stream.

  3. The "Mode": "Continuous" (default) runs inference continuously, while "Triggered" only runs the Workflow when explicitly triggered. See Trigger a Stream for the triggering options.

  4. The "Stream Type" (ex: "RTSP Stream", "RTSP Simulator", "USB Camera", "Basler Camera", "Lucid Camera").

  5. The video source for that stream type:

    • "RTSP Stream": the "RTSP URL" of the camera.

    • "RTSP Simulator": a video to stream from the device's RTSP Simulator, for testing without a camera. Upload the video in the form. If the device has no simulator yet, saving adds one.

    • "USB Camera": the "USB Camera Index" of the camera plugged into your device. If you have only one camera plugged in, this is likely 0. Adding a USB camera turns on privileged mode for the inference container, which gives it more hardware access.

    • "Basler Camera": the "Serial Number" of the camera. See Basler Cameras below.

    • "Lucid Camera": the "IP Address" of the camera, prefilled from camera discovery. The Stream connects to the camera at that address, and Roboflow keeps that address assigned to the camera. Leave the field empty to fill in "Camera Index" instead, which connects to whichever Lucid camera holds that position.

    • "Basler Line Scan": the camera's "IP Address (optional if serial is set)" or "Serial number (optional)".

    • "Lucid Line Scan": no address field. The Stream starts with default line scan settings.

To prefill the source from a discovered camera, click "Add Stream" on its row in the "Cameras" table instead. See Find Cameras.

A Stream you add through Update Config without a workflow_id runs a built-in RF-DETR object detection Workflow.

Once you have filled out this information, click "Create Stream" to proceed to set up a Workflow with your Stream. Initial set up of a new stream can take several minutes as the device downloads the workflow and any associated model weights. Eventually, the Stream will appear in your list of Streams:

Running Streams with inference FPS, camera FPS, and sharpness

When you first add the Stream, the status will show that your Stream is "Provisioning". Once your Workflow is downloaded to your device and is running, the status of your Stream will update to "Running".

When the stream status is "Running", this means:

  1. Your Workflow is running on your device.

  2. You can view frames and logs from your Stream.

To adjust resolution, brightness, or frame rate after setup, configure the camera settings.

Find Cameras

The "Cameras" table below the Streams list shows the cameras the device can see. Click "Scan for Cameras" to search again. The device looks for USB cameras, Basler cameras on GigE or USB, Lucid GigE cameras, and ONVIF network cameras. A scan stops after about 15 seconds and lists the cameras found by then, so run it again if a camera is missing. While the device is offline or not ready, the button reads "Request Scan".

Each row offers the next step for that camera: "Add Stream" opens a prefilled Stream form, "Open Stream" opens the Stream that already uses the camera, and "Add RTSP URL" appears for an ONVIF camera that did not report a video stream URL.

Shared Cameras

To run multiple Workflows on one camera, read the device configuration and define or reuse one camera under config.video_sources with its type and data. Update Config so each Stream's video_reference.$ref points to that source (ex: #/config/video_sources/line_camera); give each Stream its own workflow_id and mode, and keep shared camera settings in the source's data.settings. Shared capture requires a supporting inference version with "Multiprocessing" enabled in the device's Configuration.

Basler Cameras

Enter the serial number only. Edge works out whether the camera is GigE or USB, and for GigE it finds the port and sets a compatible IP when the stream starts. Older streams set up with an IP address keep working until you enter a serial.

In the discovered cameras table, a "Network mismatch" badge means Edge will readdress the camera itself. "Network review" means the port is shared or carries the default route, so set the IP yourself. If the row's button reads "Set Up Camera Port", the camera needs a dedicated camera port first.

The table also lists cameras your Streams use, including ones the device cannot find ("Never seen"). Click a camera row to open its "Diagnostics", a list of checks on the camera connection and network. A check that does not pass can show a button to fix it (ex: "Set Static IP"), and "Copy Report" copies the results to share.

Workflow Compatibility

When you choose a Workflow, Roboflow checks it against the inference version running on the device. A red X next to the Workflow field means the device cannot run that Workflow. Hover over the icon to see which block is not supported and why. To fix it, update the inference service version on the device Configuration page.

The check uses what the device reports about itself. Devices that have not reported their supported blocks yet show no icon.

RTSP Credentials

If your camera needs a username and password, enter them in the "Username" and "Password" fields instead of adding them to the RTSP URL.

On devices that support encrypted credentials, Roboflow always stores the username and password encrypted on the device, not in the stream URL. Older devices store them in the URL.

Saved credentials are not shown again. The fields read "Saved (enter to change)", and you need to enter both to replace them.

RTSPS Certificates

An RTSP URL that starts with rtsps:// connects over TLS, and the device checks the camera's certificate. If your camera presents a self-signed certificate, check "Allow self-signed TLS certificate". The checkbox only appears for rtsps:// URLs, and it clears if you change the URL back to rtsp://.

This setting applies to the whole device. Turning it on for one stream skips certificate checks for every RTSPS stream on that device. When you can, add the issuing certificate under "CA Certificates" in the device's "Networking" tab instead.

Last updated

Was this helpful?