SerialX Documentation

Welcome to the official documentation for SerialX-a completely free, zero-install, web-based serial monitor tailored for embedded developers, engineering students, and hobbyists.

No installation required: SerialX runs entirely in your browser. Ensure you are using Google Chrome or Microsoft Edge

Auto Baudrate Detection

No more guessing configurations. Connect your device and let SerialX handle matching the speeds instantly.

Smart Logs Saving

Export your terminal feed to clean text logs locally using rapid hotkeys whenever you need them.

Visual Telemetry

Instantly maps stream metrics directly onto timelines dynamically without third-party wifi-based visualizers.

Quick Start Guide

Get up and running with SerialX in under 30 seconds by following these simple deployment steps:

  1. Connect your microcontroller (STM32, MSP430, ESP32, Raspberry Pi Pico, Arduino, etc.) to your computer via USB or USB-to-TTL Converter.
  2. Open serialx.app in a supported browser.
  3. Click the Connect button on the top panel.
  4. Select your device from the browser popup prompt and confirm. Select Baudrate or choose "AUTO DETECT", SerialX will leverage its Auto Baudrate selection feature to match speeds effortlessly!

Tutorials

These guided videos show how to use SerialX features in the browser with step-by-step examples.

Auto Baudrate

Auto baudrate automatically selects the most suitable baudrate for readable serial data. Enter a search word of at least 6 letters that appears in your firmware output during initialization. SerialX will test from the highest baudrate down to lowest and choose the best match.

Graph Plotting

Your firmware should print values in the plotting format such as TEMP0: 0, TEMP1= 10, TEMP7: 90, or TEMP9=30. Both : and = work, and graph plotting requires no Wi-Fi integration. SerialX supports time range scaling from 10 seconds up to 24 hours.

Theme Toggle

SerialX includes multiple themes so you can choose the look that best suits your workflow. Use the theme toggle button to switch instantly between modes and find the style you like most.

Keyboard Shortcuts

Control your data feed efficiently without lifting your hands off the keyboard using our built-in command mappings:

ActionShortcut MappingDescription
Save Session LogsCtrl + SInstantly downloads the active console buffer buffer into a .txt log file.
Clear MonitorCtrl + LWipes the terminal display buffer instantly clean to start fresh.
Zoom In UICtrl + +Increases the monitor display font scaling for optimal workspace visibility.
Zoom Out UICtrl + -Decreases the monitor display font scaling to view more lines concurrently.

Graph Plotting Variables

SerialX features powerful multi-channel visual mapping. To plot data values onto the real-time scope graph interface, format your microcontroller serial print outputs using designated target tokens ranging strictly from TEMP0 through TEMP9.

Data Output Protocol

Print the variable tag immediately followed by its value separated cleanly by a colon (:) or an equals sign (=) inside your loop structure:

// Example Code Snippet
while(1) {
  float currentTemp = readSensor();
  
  // Output format recognized by SerialX plotting engine
  Serial.print("TEMP0:");
  printf("TEMP0: %f\n", currentTemp);
  // OR
  printf("TEMP1= %d\n", currentTemp);

  delay(100); 
}

You can plot up to 10 variables simultaneously onto the graph window matching keys up to TEMP9.

Time Range Controls

Analyze telemetry fluctuations over brief immediate intervals or track stability variations long-term across critical timelines. The built-in graph canvas supports historical inspection viewport ranges across multiple scale modes:

  • Short Horizon Diagnostics: Drop window scaling down to 10 seconds to capture high-frequency transient spikes or micro-oscillations instantly.
  • Extended Stability Checks: Scale parameters anywhere out up to a maximum tracking capacity of 24 hours continuous to perform thorough thermal drift tests or runtime soak investigations over full days smoothly.

SerialX vs Legacy Monitors

See how SerialX optimizes your embedded system debugging environment by eliminating setup overhead and manual data tracking compared to local applications like the Arduino Serial Monitor, PuTTY, or Tera Term:

Friction
Traditional Setup
Requires heavy software installations or searching for local platform-specific executables (.exe) before starting any hardware interaction.
Instant Deployment
Zero Installation
Fully browser-native. Open serialx.app on any Chrome or Edge device (Windows, macOS, Linux) and establish an immediate link.
Restricted
Admin Prerequisites
Local client tools often demand system administrator permissions, policy agreements, or installation rights on institute, school and enterprise computers.
Frictionless
No Permissions Needed
Runs entirely client-side. Respects your total privacy, device streams never hit our servers.
Manual
Copy-Paste Logs
Exporting output feeds means freezing screens, selecting text buffers manually, or capturing rough desktop screenshots for records.
Hotkeys Enabled
Rapid File Backup
Press Ctrl + S to instantly convert the current live monitoring terminal log buffer directly into a local desktop text document.
Single Window
Clunky Window Tabs
Running simultaneous monitoring checks forces you to spawn multiple heavy windows or struggle through restricted local platform layouts.
Scalable Workspace
Native Browser Tabs
Manage separate streams concurrently by utilizing browser tab mechanics alongside responsive formatting and theme choices.

Privacy Policy

All SerialX functionality runs entirely in your browser on your device; no serial data, settings, or files are sent to our servers. We do not save, collect, or retrieve any personal or session data from you.