Skip to content

Quickstart

Get started with Bubbaloop in minutes.

Prerequisites

  • Linux (Ubuntu 22.04+, Jetson, Raspberry Pi)
  • Node.js 20+ (for TUI)
  • Modern browser (Chrome 94+, Edge 94+, Safari 16.4+) for dashboard

Installation

Step 1: Install Backend

curl -sSL https://github.com/kornia/bubbaloop/releases/latest/download/install.sh | bash

This installs Zenoh router, WebSocket bridge, and the bubbaloop daemon as systemd services.

Step 2: Install TUI

npm install -g @kornia-ai/bubbaloop

Step 3: Run

bubbaloop

See Installation for detailed requirements.

Using the TUI

The TUI is the main interface for managing Bubbaloop:

Key Action
n Nodes — View and manage nodes
t Topics — Browse Zenoh topics
l Logs — View service logs
s Settings — Configure options
q Quit

Managing Nodes

From the Nodes panel:

  1. Select a node (e.g., rtsp-camera)
  2. Press s to start the service
  3. Press l to view logs
  4. Press x to stop the service

Configuration

Camera Configuration

Create ~/.bubbaloop/configs/cameras.yaml:

cameras:
  - name: "entrance"
    url: "rtsp://user:password@192.168.1.100:554/stream1"
    latency: 200

  - name: "backyard"
    url: "rtsp://user:password@192.168.1.101:554/stream1"
    latency: 200

Weather Service

Create ~/.bubbaloop/configs/config.yaml:

weather:
  latitude: 37.7749
  longitude: -122.4194
  interval_secs: 300

Service Management

Services are managed via systemd:

# View status
systemctl --user status zenohd
systemctl --user status bubbaloop-daemon

# Restart
systemctl --user restart bubbaloop-daemon

# View logs
journalctl --user -u bubbaloop-daemon -f

Dashboard

The web dashboard provides real-time visualization.

Starting the Dashboard

With development install:

pixi run dashboard

Access at: http://localhost:5173

Dashboard Features

Panel Description
Cameras Live H264 video streams
Nodes Service management
Weather Current conditions and forecasts
Raw Data Browse any Zenoh topic

Development Workflow

For contributors building from source:

git clone https://github.com/kornia/bubbaloop.git
cd bubbaloop
pixi install

# Start everything with process-compose
pixi run up

# Or run services individually:
pixi run daemon      # Bubbaloop daemon
pixi run bubbaloop   # Terminal UI
pixi run dashboard   # Web dashboard

Browser Requirements

Browser Minimum Version Status
Chrome 94+ Recommended
Edge 94+ Supported
Safari 16.4+ Supported
Firefox - Not supported

Firefox not supported

Firefox does not support the WebCodecs API required for H264 decoding.

Next Steps