Back to Serial Studio

Toolbar & button reference

doc/help/Toolbar-Reference.md

4.0.145.1 KB
Original Source

Toolbar & button reference

This page is the complete map of Serial Studio's buttons: the main toolbar at the top of the window, the dashboard Start menu and taskbar, the Setup panel, the Project Editor toolbar, and the small toolbar that sits on top of each dashboard widget. Hover any button in the application to see the same tooltip text quoted here.

Buttons marked (Pro) require a Serial Studio Pro license (or an active trial). In the free GPL build they are hidden, not just disabled.

The main window at a glance

When Serial Studio is running, the window is built from a few fixed surfaces:

SurfaceWhereCovered in
Main toolbarAcross the topMain toolbar
Setup panelRight side, collapsibleSetup panel
Console / DashboardCenterConsole toolbar, Widget toolbars
TaskbarBottom of the dashboardDashboard taskbar
Start menuOpens from the taskbarDashboard Start menu

The center view starts on the Console and switches to the Dashboard automatically once the first valid frame is parsed. There is no manual Console/Dashboard toggle button; the view follows the data. See Operation Modes for how that transition is decided.

Main toolbar

The toolbar runs along the top of the window, left to right, grouped into sections that collapse into overflow menus when the window is narrow. The exact set of buttons depends on the build (Pro vs free) and on whether the app is running as a normal install or as an operator deployment (operator runtime mode hides the authoring buttons).

Project section

ButtonIconWhat it doesNotes
Project EditorOpens the Project Editor to create or modify your JSON layout.Authoring mode only.
Open ProjectOpens an existing .ssproj / .json project and switches to Project File mode.Authoring mode only.
Open CSVPlays a recorded CSV file back as if it were live sensor data.Disabled while a device is connected or while the CSV player is already open. See CSV Export & Playback.
Open MDF4 (Pro)Plays an MDF4 file back as if it were live data.Disabled while a device is connected or while the MDF4 player is already open. See MDF4.

Assistant / Extensions section

ButtonIconWhat it doesNotes
Assistant (Pro)Opens the AI Assistant to build and edit a project by chatting.In the free build this button is Extensions instead, opening the extension manager.
Deploy (Pro)Opens the shortcut generator to build a standalone operator app for the current project.
Sessions (Pro)Opens the Session Database explorer to browse, replay, and export recorded sessions.
Extensions (Pro)Browse and install extensions.In the free build, the section's first button is Extensions; in Pro it lives here alongside the AI tools.

Preferences and driver selection

ButtonIconWhat it doesNotes
PreferencesOpens application settings and preferences.Authoring mode only.
UARTSelects the Serial port (UART) driver.
Audio (Pro)Selects the audio input driver.
USB (Pro)Selects the raw USB driver.
NetworkSelects the TCP / UDP network driver.
Modbus (Pro)Selects the Modbus driver.
HID (Pro)Selects the HID driver.
BluetoothSelects the Bluetooth LE driver.
CAN Bus (Pro)Selects the CAN Bus driver.
Process (Pro)Selects the Process I/O driver.

The driver buttons are a single-choice group: the active driver's label is shown in bold. They are disabled while a connection is live, while a file player is open, and for multi-source projects (where the source list is fixed by the project). See Data Sources.

Help and about

ButtonIconWhat it doesNotes
AboutShows application info and license details.Authoring mode only.
ExamplesBrowses the bundled example projects.Authoring mode only.
Help CenterOpens this documentation, the FAQ, and the wiki.Available to operators too.
AI Wiki & ChatOpens the DeepWiki documentation site in your browser, where you can ask questions about Serial Studio.Authoring mode only.

Connection (right-pinned)

ButtonIconWhat it doesNotes
Activate (Pro)Opens license management to activate Serial Studio Pro.Shown only when a Pro trial has expired and no license is active.
Connect / DisconnectOpens or closes the connection to the configured device. This is a toggle: when connected the icon and label change to Disconnect.Disabled until the connection is fully configured, and while a CSV / MDF4 / session player is open.

Setup panel

The Setup panel docks on the right edge of the window and is where you choose how data is parsed and which I/O driver to use. Drag its left edge to resize it and give the Dashboard more space.

Frame parsing

Three radio buttons pick the operation mode:

OptionWhat it does
Console Only (No Parsing)Raw bytes go straight to the terminal. No widgets, no parsing.
Quick Plot (Comma Separated Values)Auto-builds a dashboard from comma-separated numbers.
Parse via Project FileUses a .ssproj project to parse frames and build a custom dashboard. Disabled while connected or while a file player is open.

Device setup

  • I/O Interface selector: chooses the active driver (the same set as the toolbar driver buttons). Each choice swaps in a driver-specific settings panel below it (port and baud rate for UART, host and port for Network, and so on). See Communication Protocols and the per-driver pages under Drivers.
  • An API Server status indicator appears in the panel header when the TCP API is enabled, showing whether clients are connected.

Data export

Switches that arm recording for the session. Each writes to a separate file or store and can be toggled independently. CSV Spreadsheet, Session Recording, and MDF4 Recording are disabled in Console Only mode; the Console Log switch stays available:

SwitchWhat it recordsReference
CSV SpreadsheetA .csv of every parsed frame.CSV Export & Playback
Session Recording (Pro)A SQLite session in the database.Session Database
MDF4 RecordingAn ASAM MDF4 measurement file.MDF4
Console LogA transcript of the raw console stream.

For a project with two or more data sources, the panel replaces the single-driver controls with an Open Project Editor button, because the source list is defined in the project. See Data Sources.

Dashboard Start menu

The Start menu opens from the leftmost taskbar button. It is the dashboard's main menu: workspaces, actions, plugins, tools, and the session controls.

EntryIconWhat it doesNotes
WorkspacesPicks the active workspace, creates a new one, shows hidden ones, or edits and deletes user workspaces.Submenu.
ActionsLists the project's actions; picking one runs it.Hidden when the project defines no actions.
PluginsLists installed plugins, plus Manage Plugins....Hidden when no plugins are installed.
Auto LayoutToggles automatic tiling of dashboard windows.Toggle.
Full ScreenToggles the main window between full-screen and windowed.Toggle.
Add External WindowOpens a second dashboard window (for a multi-monitor layout).
ExportSubmenu of recording toggles: CSV File, MDF4 File, Console Transcript, and Session Database (Pro).Mirrors the Setup panel's export switches.
ToolsSubmenu: Console, Notifications (Pro), Clock, Stopwatch, Preferences, Sessions (Pro), File Transmission (Pro), AI Assistant (Pro).Toggles the utility widgets and opens the tool windows.
Help CenterOpens this documentation.
Pause / ResumePauses or resumes data reception for the whole session.Toggle.
ResetClears the dashboard's plotted history and rotates every active recorder (CSV, MDF4, console, database) so the next frame starts a fresh file or session.
Disconnect / QuitDisconnects the device. In an operator deployment this entry is Quit and closes the app instead.

Dashboard taskbar

The taskbar runs along the bottom of the dashboard.

ControlIconWhat it doesNotes
MenuOpens the Start menu.Always the leftmost button.
SearchFilters open widgets and Start menu entries; results appear in a dropdown.Shown when taskbar search is enabled in settings.
Pinned shortcutsvariesA configurable strip of quick-toggles: Settings, Console, Notifications, Clock, Stopwatch, File Transmission, AI Assistant, Pause / Resume.The set and order are user-configurable; Pro-only tools are hidden in the free build. Stateful shortcuts light up when active.
Window buttonsper-widgetOne button per open dashboard widget; click to show, focus, or restore that widget. The center strip scrolls with the < / > arrows when it overflows.Mirrors the widgets currently on the canvas.
Workspace switcher(dropdown)Selects the active workspace; the current one is bold.
Auto LayoutToggles automatic window tiling (same as the Start menu entry).Lights up when enabled.
Edit workspaceRenames or edits the active workspace.Enabled only for user-created workspaces.
New workspaceCreates a new workspace.Hidden in operator runtime mode.
MQTT status (Pro)Shows the MQTT publisher connection state; click for a status popup with broker, mode, and message count.Shown only when the MQTT publisher is enabled.

A note on workspaces

A workspace is a saved arrangement of dashboard windows. Each project includes a default workspace; you can add your own to keep different views of the same data (an overview screen, a diagnostics screen) and switch between them from the taskbar or the Start menu. User workspaces have IDs at or above 1000 and only those can be renamed or deleted.

Project Editor toolbar

The Project Editor has its own toolbar for building the project tree: file actions on the left, then a series of "add" buttons grouped by what they create. The large buttons add the common item of each group; the small buttons next to them add the specific variants.

File

ButtonIconWhat it doesNotes
NewStarts a new, empty project.
OpenOpens an existing project.
SaveSaves the project to disk.Enabled only when there are unsaved changes and saving is allowed.
Save AsSaves under a new name.

Import and restore

ButtonIconWhat it doesNotes
ProtobufGenerates a project from a Protocol Buffers .proto schema.See Auto-Generating Projects.
RestoreRestores a recent automatic snapshot of the project.See Backups & Recovery.
LockSets a password and locks the editor.See Project Lock.
Add Device (Pro)Adds another data source to the project.

Add output controls

ButtonIconAdds
OutputAn output control panel.
ActionAn action.
SliderAn output slider.
ToggleAn output toggle.
KnobAn output knob.
Text FieldAn output text field.
ButtonAn output button.

Add datasets

ButtonIconAdds a dataset shown as
DatasetA plain dataset (no widget).
PlotA time-series plot.
FFT PlotAn FFT spectrum.
GaugeA gauge.
Level IndicatorA bar.
CompassA compass.
LED IndicatorAn LED.

Add groups

ButtonIconAdds a group shown as
GroupA generic dataset group.
ImageAn Image View (Pro).
Web ViewA web viewer.
PainterA Painter widget (Pro).
TableA Data Grid.
Multi-PlotA MultiPlot.
3D PlotA 3D Plot (Pro).
AccelerometerAn accelerometer group.
GyroscopeA gyroscope group.
GPS MapA GPS map.

Assistant and help

ButtonIconWhat it doesNotes
Assistant (Pro)Opens the AI Assistant.
Help CenterOpens the Project Editor documentation.

The full set of dataset and widget configuration fields is described in the Widget Reference and Project Editor pages.

Dashboard widget toolbars

Most visualization widgets carry a small toolbar of icon buttons along their top edge. The toolbar only appears when the widget is large enough to fit it; shrink a widget and the toolbar hides to leave room for the data. All toggle settings are saved per-widget in the project file, so each tile remembers its own state.

A few conventions are shared across widgets:

  • Pause / Resume freezes drawing without stopping data collection; the icon swaps between a pause and a play glyph.
  • Show Crosshair overlays a tracking crosshair that follows the cursor.
  • Reset View returns pan and zoom to the default; it is disabled until you have zoomed or panned.
  • Axis Range Settings (gear icon) opens a dialog to pin fixed minimum and maximum axis values.

Plot

ButtonIconWhat it does
InterpolationCycles line smoothing: none (raw points), linear, stepped (ZOH), or stem.
Show Area Under PlotFills the region beneath the curve. Available only with line interpolation.
Show X Axis LabelShows or hides the X-axis label.
Show Y Axis LabelShows or hides the Y-axis label.
Show CrosshairTracking crosshair that follows the cursor.
Pause / ResumeFreezes drawing without stopping data collection.
Sweep / Trigger Mode (Pro)Turns oscilloscope-style Sweep / Trigger mode on or off. Time-axis plots only.
Trigger Settings (Pro)Opens the Trigger Settings dialog (mode, level, slope, holdoff, timebase). Enabled only while Sweep is on.
Reset ViewReturns pan and zoom to the default; disabled until you have zoomed or panned.
Axis Range SettingsPins fixed minimum and maximum axis values.

MultiPlot

The MultiPlot toolbar matches the Plot toolbar, minus Show Area Under Plot (which does not apply to overlaid curves). A per-curve legend with show / hide switches sits beside the chart.

ButtonIconWhat it does
InterpolationCycles line smoothing: none (raw points), linear, stepped (ZOH), or stem.
Show X Axis LabelShows or hides the X-axis label.
Show Y Axis LabelShows or hides the Y-axis label.
Show CrosshairTracking crosshair that follows the cursor.
Pause / ResumeFreezes drawing without stopping data collection.
Sweep / Trigger Mode (Pro)Turns oscilloscope-style Sweep / Trigger mode on or off. The Source setting picks which curve the trigger watches. Time-axis plots only.
Trigger Settings (Pro)Opens the Trigger Settings dialog (mode, source, level, slope, holdoff, timebase). Enabled only while Sweep is on.
Reset ViewReturns pan and zoom to the default; disabled until you have zoomed or panned.
Axis Range SettingsPins fixed minimum and maximum axis values.

These buttons and Sweep / Trigger mode are documented in full on the Plots page.

FFT Plot

ButtonIconWhat it does
InterpolationCycles the spectrum line between raw points and interpolated curves.
Show Area Under PlotFills the area beneath the spectrum. Available only with line interpolation.
Show X Axis LabelShows or hides the frequency-axis label.
Show Y Axis LabelShows or hides the magnitude-axis label.
Show CrosshairTracking crosshair.
Pause / ResumeFreezes drawing.
Reset ViewResets pan and zoom.
Axis Range SettingsFixed axis ranges.

See the FFT Plot entry for window size and sampling-rate configuration.

Waterfall (Pro)

ControlIconWhat it does
Color map(dropdown)Picks the color map (Viridis, Inferno, Magma, Plasma, Turbo, Jet, Hot, Grayscale).
Dynamic range(dual slider)Sets the dB floor and ceiling mapped onto the color map (-120 to +20 dB).
Show ColorbarShows or hides the color scale.
Show Axes & GridShows or hides the axes and grid.
Show CrosshairFrequency / time readout under the cursor.
Pause / ResumeFreezes drawing.

See the Waterfall entry for details.

GPS Map

ButtonIconWhat it does
Auto CenterKeeps the map centered on the latest position.
Plot TrajectoryDraws the path traveled.
Zoom In / Zoom OutChanges the map zoom level.
Show WeatherOverlays a live weather layer.
NASA Weather OverlayOverlays the NASA GIBS imagery layer.
Base MapA dropdown that selects the map style (street, satellite, terrain, and so on).

3D Plot (Pro)

ButtonIconWhat it does
InterpolateSmooths the trajectory between points.
Orbit NavigationDrag rotates the camera around the data.
Pan NavigationDrag slides the camera (mutually exclusive with Orbit).
Orthogonal ViewSnaps the camera to an isometric angle.
Top / Left / Front ViewSnaps the camera to a standard orthographic view.
Auto CenterKeeps the cloud centered as new points arrive.
Anaglyph 3DRenders a red / cyan stereo image for 3D glasses.
Invert Eye PositionsSwaps the left / right eyes (enabled only with Anaglyph on).
Eye Separation(slider)Sets the stereo separation (enabled only with Anaglyph on).

Image View (Pro)

ButtonIconWhat it does
Export ImagesSaves each incoming frame to disk.
Open Export FolderReveals the export folder in the file manager.
Zoom In / Zoom OutMagnifies the image (1x to 5x), with drag to pan.
Show CrosshairCursor crosshair with pixel coordinates.
FilterA dropdown of display filters (Normal, Grayscale, High Contrast, Vivid, Night Vision, Infrared, Deep Blue, Amber).

Data Grid

ButtonIconWhat it does
Pause / ResumeFreezes the table without stopping data collection.

Accelerometer

ButtonIconWhat it does
SettingsOpens the configuration dialog (max-G range).

Widgets without a toolbar

These widgets have no toolbar; their interaction is direct:

  • Bar, Gauge, Meter, Compass, Clock are two-page swipe views. Swipe horizontally, or click the page-indicator dots at the bottom, to flip between the analog face and the large digital readout. The active page is saved per widget.
  • Gyroscope and LED Panel are display-only.
  • Stopwatch has its own Start / Stop, Lap, and Reset buttons and a lap table; see Widget Reference.
  • Output controls (button, slider, toggle, knob, text field) are interactive inputs that send values to the device; see Output Controls.
  • Painter (Pro) renders entirely from its user script and has no toolbar; see Painter Widget.

Console toolbar

The console terminal has a send row and an options row rather than an icon toolbar.

Send row: an Attach button for file transmission, an input box that sends on Enter or the Send button, a HEX toggle to send hexadecimal, and dropdowns for line ending and checksum. On a multi-device project a device selector picks the target.

Options row: Show Timestamp, Echo, Emulate VT-100, and ANSI Colors checkboxes, a Display mode dropdown, and a Clear button. Right-click the terminal for Copy, Select all, and Clear.

Notification log

The notification log has a Filter by channel field, an unread-count badge, and a Clear all notifications button.

See also