-
Notifications
You must be signed in to change notification settings - Fork 979
Getting Started
You can download and install the latest version of Serial Studio for your platform from the releases page. Below are specific instructions for each platform:
- Download the installer file.
- Double-click the installer to begin the installation.
Windows may show a warning about an "unknown developer" since the installer is not digitally signed. You can safely ignore this warning:
- Click More Info on the warning dialog.
- Then click Run Anyway to proceed with the installation.
On a fresh Windows installation, Serial Studio may fail to run and display an error message similar to the one below:
To resolve this issue, you will need to install the Microsoft Visual C++ Redistributable (64-bit) from the following link: https://aka.ms/vs/17/release/vc_redist.x64.exe.
For more information about this dependency, you can refer to the official documentation here.
- Download the DMG file.
- Open the DMG and drag Serial Studio into the "Applications" folder.
For GNU/Linux users, there are multiple ways to install and run the application:
Download the AppImage file and ensure it has the correct executable permissions before running:
chmod +x SerialStudio-3.0.5-Linux-x86_64.AppImage
./SerialStudio-3.0.5-Linux-x86_64.AppImageNote: You may need to install libfuse2 for the AppImage to work. On Debian/Ubuntu-based systems, you can install it using:
sudo apt update
sudo apt install libfuse2You can integrate the Serial Studio AppImage into your system more easily using AppImageLauncher..
You can also install Serial Studio using DEB or RPM packages, which are currently in an experimental stage. Please report any issues you encounter.
For Debian-based distributions (e.g., Debian, Ubuntu, Linux Mint, etc):
sudo dpkg -i SerialStudio-3.0.5-Linux-x86_64.debFor RPM-based distributions (e.g., Fedora, RHEL, OpenSUSE, etc):
sudo rpm -i SerialStudio-3.0.5-Linux-x86_64.rpmsudo usermod -a -G <your-username> dialoutIn this section, I'll guide you through connecting your device to Serial Studio using Quick Plot Mode. We'll use an Arduino as an example to send analog readings from its ADC ports to Serial Studio for real-time plotting.
To send analog readings to Serial Studio, we’ll upload a simple Arduino sketch that reads the analog input values and transmits them over the serial port.
Here's a basic sketch:
void setup() {
// Initialize serial communication at 115200 baud
Serial.begin(115200);
// Initialize analog pins
pinMode(A0, INPUT);
pinMode(A1, INPUT);
pinMode(A2, INPUT);
pinMode(A3, INPUT);
pinMode(A4, INPUT);
pinMode(A5, INPUT);
}
void loop() {
// Read analog values from all ADC ports (A0 to A5 on most Arduinos)
int adc0 = analogRead(A0);
int adc1 = analogRead(A1);
int adc2 = analogRead(A2);
int adc3 = analogRead(A3);
int adc4 = analogRead(A4);
int adc5 = analogRead(A5);
// Send the values as a comma-separated string
Serial.print(adc0);
Serial.print(",");
Serial.print(adc1);
Serial.print(",");
Serial.print(adc2);
Serial.print(",");
Serial.print(adc3);
Serial.print(",");
Serial.print(adc4);
Serial.print(",");
Serial.print(adc5);
Serial.print("\n");
// Small delay between readings
delay(20);
}- Upload the code to your Arduino board using the Arduino IDE.
- Once the code is uploaded, your Arduino will start sending readings over the serial port.
- Open Serial Studio after installation.
- On the Setup panel (visible on the right side), select Serial as the data source from the dropdown menu, and ensure that the operation mode is set to Quick Plot.
- The Serial Options panel will appear, where you can configure the following:
- Port: Select the serial port where your Arduino is connected.
-
Baud Rate: Set the baud rate to
115200(to match the speed in the Arduino sketch above).
- Click the Connect button in the toolbar at the top. Once connected, the console panel will show incoming data, and when data is correctly parsed, Serial Studio will automatically switch to the Dashboard View, where the data will be visualized.
- After connecting Serial Studio to the serial port, the data stream from your Arduino will appear in the Console Panel. The values will be automatically parsed by Serial Studio in Quick Plot Mode, which switches to the Dashboard View automatically once the data is parsed.
- In the Dashboard View, you will see real-time plots of your data. By default, each analog input (A0–A5) will be represented as a separate plot on the dashboard.
- On the Widgets Setup sidebar (left side of the screen), you can toggle the visibility of individual plots & widgets.
Port not showing in dropdown?
- Windows: Check Device Manager for your device. You may need to install drivers (CH340, FTDI, or CP210x)
-
Linux: Add your user to the
dialoutgroup:sudo usermod -a -G dialout $USERthen log out and back in - macOS: Try a different USB port or check System Preferences → Security & Privacy
No data appearing in console?
- Verify the baud rate matches your device (115200 in this example)
- Check that your Arduino code is actually sending data (re-upload if needed)
- Try disconnecting and reconnecting
- Close Arduino IDE Serial Monitor if it's open
Dashboard not switching automatically?
- Ensure data format is comma-separated values with newline delimiter
- Check the Console panel to see if data is being received
- Try manually selecting a dataset to trigger dashboard view
Need more help? Check the Troubleshooting Guide for detailed solutions.
Congratulations on connecting your first device! Now that you've visualized data with Quick Plot mode, here are the recommended next steps:
- Operation Modes - Understand Quick Plot, Project Files, and Device-Defined modes to choose the best approach for your project
- Data Sources - Learn about other connection types: Network (TCP/UDP), Bluetooth LE, and advanced protocols
- Communication Protocols - Compare all supported protocols and choose the right one
- Project Editor - Create custom dashboards with specific widgets (gauges, bars, GPS maps, etc.)
- Widget Reference - Explore all 15+ widget types and choose the best visualization for your data
- Data Flow Explained - Understand how Serial Studio processes data
- Data Flow - Learn about frame parsing and data conversion
- JavaScript API Reference - Write custom parsers for binary or complex data formats
- CSV Import & Export - Save your sessions and replay them later for analysis
- Protocol Setup Guides (Pro) - Set up MQTT, Modbus, CAN Bus, or Audio input
- Pro vs Free Features - Learn about advanced features available in Serial Studio Pro
- Examples Repository - Browse real-world projects including GPS trackers, IMU visualizers, and more
- Troubleshooting Guide - Common issues and solutions
- GitHub Discussions - Ask the community
- DeepWiki - AI-powered documentation search
Happy visualizing! 📊
If you find Serial Studio helpful, please consider supporting the project:
Your support helps keep the project growing, maintained, and continuously improved.