Skip to content

README.md

Latest commit

 

History

History
104 lines (76 loc) · 4.87 KB

README.md

File metadata and controls

104 lines (76 loc) · 4.87 KB

Serial Studio Extensions

Extensions for Serial Studio. Themes, plugins, frame parsers, and project templates that extend the application without modifying its core.

Available Extensions

Themes

Extension Style Description
Solarized Dark Dark Ethan Schoonover's iconic palette with calibrated contrast
Solarized Light Light Warm cream variant of Solarized for bright environments
Aether Dark Dark GitHub-inspired deep space dark with cool blue accents
Aether Light Light Clean GitHub light mode with bold blue accents
Classic Dark The original Serial Studio look with teal and mint green
Gunmetal Dark Industrial charcoal with warm gold accents
Iron Light Polished white surface with gold highlights
Midday Light Slate-blue toolbars with amber accents
Midnight Dark Ultra-dark with muted indigo for late-night sessions
Rust Dark Warm earthy browns with gold accents

Plugins

Extension Category Description
Live Data Table Visualization Sortable table with sparklines, search, freeze/resume
Data Statistics Logger Analysis Running stats (min/max/mean/stdev) with HTML export
Threshold Alerts Monitoring Per-field alert thresholds with event log
Protocol Analyzer Debugging Frame capture with hex dumps and timing analysis
Digital Indicator Visualization Seven-segment displays with hold, tare, peak tracking
Custom Gauge Visualization Multi-needle analog gauges with auto-ranging

Frame Parsers

Extension Description
Binary TLV Parser Decodes Type-Length-Value binary protocol frames
NMEA GPS Parser Parses standard NMEA 0183 GGA/RMC sentences

Project Templates

Extension Description
6-DOF IMU Dashboard Ready-to-use project for 6-axis IMU sensors
PID Controller Monitor Dashboard for PID control loop tuning

Installation

  1. Open Serial Studio and click Extensions in the toolbar
  2. Browse the catalog. Extensions are grouped by type
  3. Click a card to see details, then click Install

Installed extensions auto-update when a newer version is detected in the repository.

Plugin Features

All plugins in this repository share a common set of capabilities:

  • Auto-reconnect to the Serial Studio API server
  • State persistence: plugin windows and settings are saved to the project file
  • Auto-launch: plugins that were running are relaunched on next startup
  • Start Menu integration: launch plugins from the dashboard Start Menu
  • Cross-platform: separate entry points for macOS, Linux, and Windows

Contributing

Development Setup

  1. Clone this repository
  2. In Serial Studio, open Extensions > Repos > Browse and select the cloned folder
  3. Extensions appear immediately, so you can install and test right away
  4. Make changes, reload, and iterate

Creating Extensions

See the doc/ folder for detailed guides:

  1. Getting Started: extension types, info.json structure, local testing
  2. Creating Themes: color palettes, code editor XML, design tips
  3. Creating Plugins: API connection, frame data, tkinter patterns
  4. Plugin State Persistence: save/restore plugin state in project files
  5. Platform Support: platform keys, shell wrappers, native binaries

Repository Structure

manifest.json                    Extension index (references all info.json paths)
theme/<id>/                      Color themes (palette JSON + code editor XML)
plugin/<id>/                     External plugins (Python + shell wrappers)
frame-parser/<id>/               JavaScript protocol decoders
project-template/<id>/           Pre-configured .ssproj project files
doc/                             Development guides

Conventions

  • Extension IDs use lowercase-hyphenated format
  • Each extension is self-contained in its own directory
  • info.json carries all metadata; manifest.json only references paths
  • File paths in info.json are relative to the info.json location

License

This repository is licensed under the MIT License. Copyright (c) 2025 Alex Spataru.