Console UI Overview

Navigate the Synnax Console UI.

The Synnax Console provides a flexible environment to display and interact with data stored and streamed through a Synnax Core. It’s interface is designed around two main UI elements: the central layout mosaic and side toolbars.

The central mosaic displays visualizations such as line plots and schematics, while the toolbars exists to provide access to resources, data ranges, tasks, and visualization controls.

Toolbars

To kick things off, we’ll walk you through each of the toolbars and their functionality.

Channels

The Channels Toolbar allows you to create, view, and access the channels you’re interested in visualizing.

Ranges

The Ranges Toolbar allows you to create, view, and access ranges that you have favorited in the Console.

Workspaces

The Workspaces Toolbar allows you to create and view workspaces that have been made by users in your Synnax deployment.

Devices

The Devices Toolbar allows you to view and track the health of the devices you’re interested in visualizing.

Tasks

The Tasks Toolbar allows you to view, pause, and resume the current tasks running on a Driver.

Users

The Users Toolbar allows you to view and change permissions for users in your Synnax deployment.

Visualization

The Visualization Toolbar allows you to edit the properties of line plots, logs, schematics, and tables.

Selectors

Workspace

The Workspace Selector allows you to create and view workspaces that you have favorited in the Console.

Core

The Core Selector allows you to switch the current Core that you are connected to and add new Cores.

Mosaic

Synnax can be easily manipulated to help choose the exact display you want.

You can easily open and close toolbars on Synnax:

You can close toolbars either by touching their respective icon or resizing it to the edge:

You can also have multiple visualizations displayed at the same time:

Getting Help

The Synnax documentation website can be opened from within the Console by clicking the icon.

Search and Command Palette

The Search and Command Palette at the top can be used to search for resources or to activate commands. Searching for resources can be done by searching or pressing +P (Windows) / +P (macOS). As an example of searching for resources, you could search for a test range and then automatically add it as the active range:

The Search and Command Palette can run commands by entering a > into the toolbar or by pressing ++P (Windows) / + +P (macOS). This allows you to run commands such as toggling the color theme, creating a visualization, adding a range, or opening the documentation: