Getting Started¶
Get your first visualization running quickly.
Initial Setup¶
Authentication¶
On first launch, choose your authentication method:
OAuth Providers¶
- Click your provider - GitHub, Google, or Microsoft
- Authorize in browser - Review permissions and approve
- Return to app - Authentication completes automatically
The browser shows "Success! You may close this tab" when complete.
Device Code¶
- Click "Log in with code"
- Copy the 8-character code (e.g.,
T9WKVR2P
) - Visit
https://console.zeloscloud.io/verify
on any device - Enter code and verify
Organization Access
You're automatically added to your organization based on your email domain.
After authentication, Zelos will:
- Create a default workspace - Your starting point for visualization
- Check for updates - Ensure you have the latest features
- Initialize local storage - Set up configuration and cache
- Start the local agent - Enable data reception on port 2300
Basic Workflow¶
Step 1: Connect to Data¶
You have two options for getting data into Zelos:
Option A: Live Connection¶
Connect to a running system streaming real-time data:
- Click "Connect Live" in the welcome screen
- The app connects to
localhost:2300
by default - Your signal tree populates with available data
To connect to a remote agent, click the connection status in the sidebar and enter the agent's address (e.g., grpc://example-hostname:2300
).
Option B: Open a Trace File¶
Load previously recorded data:
- Click "Open a Trace" in the welcome screen
- Navigate to your
.trz
file - The timeline adjusts to the trace's time range
.trz Files
You can also double-click a .trz
file, which will automatically launch the app with the loaded data.
Step 2: Visualize Data¶
Once connected, create your first visualization by adding a plot panel and signals:
Adding Your First Panel¶
- Click "+ Add Panel" at the bottom of the screen
- Select "Plot" for time-series data
- Your empty panel appears in the workspace
Adding Signals to Your Plot¶
The signal tree in the sidebar shows all available data. There are several ways to add signals:
Drag and Drop¶
- Expand sources/events to see individual fields
- Drag a field onto an empty area or directly onto a panel
Dragging
You can drag at any layer of the tree to add the signals to a given panel type.
Double-Click¶
- Double-click any signal in the tree to automatically add it to a new panel
And that's it! You've connected and visualized your first signal!
Essential Concepts¶
Understanding these concepts will accelerate your Zelos mastery:
Workspaces, Tabs, and Panels¶
- Workspace: Your entire Zelos session, auto-saved continuously
- Tabs: Different views within a workspace (like browser tabs)
- Panels: Individual visualizations within a tab
Workspace
├── Tab 1: "System Overview"
│ ├── Plot Panel: CPU & Memory
│ ├── Table Panel: Current Values
│ └── Log Panel: System Events
└── Tab 2: "Detailed Analysis"
├── Plot Panel: All Sensors
└── Plot Panel: Derived Metrics
Live Mode vs Trace Mode¶
Aspect | Live Mode | Trace Mode |
---|---|---|
Data Source | Real-time stream | Recorded file |
Time Range | Moving window | Fixed range |
Playback | Play/pause current data | Navigate entire recording |
Use Case | Active debugging | Post-mortem analysis |
Signal Organization¶
Signals follow a hierarchical structure:
Example: robot/motors.left_rpm
- Source:
robot
- Event:
motors
- Field:
left_rpm
Account Management¶
Check Your Status¶
Click the account icon in the bottom-left corner to:
- View your display name
- See organization membership
- Access sign out option
Once you are signed in, you'll be able to:
- Layout Sharing - Save layouts to the cloud for your team
- Organization Features - Access team layouts and settings
- Cloud Backup - Sync preferences across devices
Sign Out¶
- Click the account icon (bottom-left)
- Click "Log Out"
- Confirm when prompted
Local Work Preserved
Signing out doesn't delete local workspaces or layouts. Your work remains on your computer.