Skip to content

Quick Start

This guide helps you begin using LabStream:

  1. Install and start the LabStream backend
  2. Log in through the web interface
  3. Add a virtual device
  4. Configure experiment charts and controllers
  5. Start and monitor an experiment

Total time: approximately 5–10 minutes.

1. Install & Start LabStream Backend

LabStream includes a backend service and a browser-based interface.

Install

Download and install the LabStream backend for your operating system.
(Download link placeholder — update later)

Start the Backend

Click the LabStream launcher or open a terminal and run:

When the backend starts successfully, you should see
LabStream started...
Leave this terminal running while the system is in use.

2. Open the Web Interface & Log In

Open your browser and go to the LabStream homepage.
(URL placeholder — update later)

Click Log In, enter your credentials, and sign in.

If creating a new account, you may need to complete email verification first.

3. Add a Virtual Device

Once logged in, you will arrive at your Workspace.

  1. Click Device in the navigation menu.
  2. Click Add Device.
  3. Select Virtual Device.
  4. Enter device name and optional comments.
  5. Confirm to add.

The virtual device will appear in the device list and begin simulated data streaming.

4. Configure Experiment Workspace

Your workspace can include:

  • Charts for visualizing real-time device data
  • Controllers for adjusting device parameters

Add a Chart

Screenshot Placeholder: Experiment Workspace Overview

  1. Open the Experiment Workspace.
  2. Click Add Chart.

Screenshot Placeholder: Add Chart Dialog

  1. Add channels to chart.
  2. Modify the parameters of each specific channel.

A chart displaying live data will appear.

Screenshot Placeholder: Chart Display Example

Add Device Controls (Optional)

  1. Click Add Controller.

Screenshot Placeholder: Add Controller Dialog

  1. Select a channel and set control target and parameters (optional).

Screenshot Placeholder: Control Widget on Workspace

Charts and controls can be rearranged freely.

5. Start the Experiment

Screenshot Placeholder: Start Experiment Button

  1. Click Start Experiment.
  2. Set the experiment duration.

Screenshot Placeholder: Experiment Duration Dialog

  1. Confirm to begin.

During the Experiment

Screenshot Placeholder: Running Experiment Overview

  • Charts update live and continuously
  • Controls remain interactive, allowing real-time adjustments

Experiment Monitoring & Control

Action Description
Adjust Controls Modify device parameters during the experiment
Observe Charts Monitor real-time data
Abort Experiment Stop the experiment immediately

To stop early, click Abort Experiment.

Screenshot Placeholder: Abort Experiment Button

Data Storage & Retrieval

All experiment data is automatically saved.

You can:

  • View live data during the experiment
  • Review completed experiment data later
  • Export results for external analysis (instructions provided later)

Screenshot Placeholder: Experiment History / Data Review Page

No data is lost when stopping or aborting an experiment.

Quick Start Complete

You have now:

  • Started the LabStream backend
  • Logged in through the browser
  • Added a virtual device
  • Configured your experiment workspace
  • Started and monitored an experiment
  • Saved experiment data successfully

Next Step

Connecting Real Laboratory Devices