Serial-Studio/examples at master · Serial-Studio/Serial-Studio · GitHub
Skip to content

Latest commit

 

History

History

examples

Folders and files

README.md

Serial Studio examples

Example projects for Serial Studio. Each folder has source code, a project file (*.ssproj), a README with setup instructions, and screenshots where applicable.

You can also browse and download examples directly from Serial Studio via the Examples button in the toolbar.

Examples

Example Description Difficulty Pro
ANSI Color Test ANSI color and VT-100 terminal emulation test suite Beginner
API Test Python API client with interactive REPL and test suite Intermediate Yes
BLE Battery BLE Battery Service level monitor Beginner
Camera Telemetry Live camera video plus image analytics over UDP Intermediate Yes
CAN Bus Example ECU simulator with DBC file import (needs the widget-extension example installed) Intermediate Yes
csv2wav Convert Audio I/O recordings to WAV files Intermediate Yes
Dual Drone Telemetry Multi-source two-drone simulator with synthetic camera feeds Advanced Yes
EM Wave Simulator Propagating electromagnetic plane wave visualizer Advanced Yes
EtherNet-IP Example Allen-Bradley Logix tag polling over EtherNet/IP (no simulator; real hardware or emulator) Advanced Yes
Graphical Ping Live network latency plot driven by the system ping command Beginner
HexadecimalADC Binary ADC data with CRC-16 and FFT analysis Intermediate
Hydrogen Hydrogen 1s orbital Monte Carlo 3D visualization Advanced Yes
IEC 104 Example IEC 60870-5-104 substation simulator with interrogation-driven point discovery Intermediate Yes
IMU Simulator Batched multi-frame IMU data parsing demo Intermediate
ISS Tracker Real-time International Space Station position tracker Beginner
LorenzAttractor Lorenz attractor chaotic system simulation Advanced Yes
LTE modem LTE modem signal quality via serial, MQTT, or UDP Intermediate
MCP Client Model Context Protocol client for AI integration Advanced
Modbus PLC Simulator Hydraulic test stand Modbus TCP simulator Intermediate Yes
MPU6050 MPU6050 accelerometer and gyroscope visualization Beginner
MQTT Subscriber Example Live Helsinki transit vehicle tracking over public MQTT Intermediate Yes
NI DAQmx NI DAQ device data acquisition bridge Intermediate
OBD-II OBD-II vehicle telemetry via ELM327 adapter Intermediate
OPC UA PLC Simulator Bottling-line OPC UA server (asyncua) with typed tags, arrays, and bad-status handling Intermediate Yes
Project Tutorial Companion of the Project File tutorial: delimiters, the Built-In parser, a data grid and an accelerometer Beginner
Protobuf Example Protocol Buffers schema import with binary auto-detect parsing Intermediate
PulseSensor Heart rate PPG sensor with signal filtering Beginner
RC Plane Simulator RC plane flight telemetry simulator Intermediate
S7 PLC Example Siemens S7comm PLC simulator over ISO-on-TCP with absolute addressing Intermediate Yes
Sparkplug Example Sparkplug edge node with birth certificates, aliases, and rebirth handling Intermediate Yes
System Monitor Live CPU, memory, disk, and network dashboard Intermediate Yes
Testo T549i BLE pressure probe with Control Loop handshake and Lua unit transforms Intermediate
TinyGPS GPS location tracker with map widget Beginner
UDP Function Generator Multi-waveform signal generator over UDP Beginner
Vibration Test Rig Motor RPM sweep driving a Campbell-mode waterfall and two scripted Canvas widgets Intermediate Yes
widget-extension Level Bar widget extension template (info.json + QML) for a custom dataset widget Intermediate

Suggested learning order

Beginner

  1. Project Tutorial: delimiters, the Built-In parser, a Data Grid and an Accelerometer group.
  2. UDP Function Generator: Quick Plot over a UDP source.
  3. PulseSensor: Quick Plot from an Arduino and CSV export.
  4. MPU6050: Accelerometer and Gyroscope groups.
  5. TinyGPS: a GPS Map group.
  6. Graphical Ping: a Control Loop that launches a helper script.
  7. BLE Battery: a Bluetooth Low Energy source and a gauge.
  8. ISS Tracker: a Control Loop that polls a web API, with a map and a web view.
  9. ANSI Color Test: Console rendering of ANSI and VT-100 sequences.

Intermediate

  1. HexadecimalADC: binary frames, CRC-16 and timed polling actions.
  2. IMU Simulator: multi-frame parsing of batched packets.
  3. RC Plane Simulator: several widget types from one UDP stream.
  4. Protobuf Example: schema import with a generated Lua parser.
  5. OBD-II: request and response polling with computed datasets.
  6. Testo T549i: a BLE Control Loop handshake and Lua transforms.
  7. LTE modem: the same data over a virtual serial port, MQTT or UDP.
  8. NI DAQmx: a Python bridge for DAQ hardware.
  9. widget-extension: a custom widget package.
  10. API Test: remote control through the API server.
  11. csv2wav: checking the pipeline through the Audio driver.
  12. System Monitor: the Process I/O driver.
  13. Camera Telemetry: JPEG image streaming.
  14. Vibration Test Rig: a Waterfall widget and Canvas widgets.
  15. MQTT Subscriber Example: an MQTT source on a public feed.
  16. Modbus PLC Simulator: a Modbus TCP source.
  17. CAN Bus Example: CAN Bus with DBC import.
  18. OPC UA PLC Simulator: an OPC UA client source.
  19. S7 PLC Example: an S7comm source.
  20. IEC 104 Example: an IEC 60870-5-104 source.
  21. Sparkplug Example: Sparkplug B over MQTT.

Advanced

  1. LorenzAttractor: a Control Loop that generates all data, with Plot 3D.
  2. Hydrogen: a Plot 3D point cloud over UDP.
  3. EM Wave Simulator: Plot 3D and MultiPlot for a wave packet.
  4. Dual Drone Telemetry: two sources at once, with images, maps and output controls.
  5. EtherNet-IP Example: Logix tag polling against real hardware or an emulator.
  6. MCP Client: AI assistant control through the Model Context Protocol.

Getting started

  1. Open the example's folder and read the README for hardware and software requirements.
  2. Upload the firmware (if applicable) or run the companion script.
  3. Open Serial Studio, load the .ssproj project file (if provided), and connect.

Several examples (e.g. RC Plane Simulator, Modbus PLC Simulator, CAN Bus Example) auto-launch their companion Python script from the project's Control Loop as soon as the connection opens, so step 2 is a no-op for those — make sure Python 3 and any extra libraries are installed first. If a required package (e.g. pymodbus for Modbus PLC Simulator, opencv-python for Camera Telemetry) is missing, the auto-launched script can fail silently in the background with no dashboard data and no obvious error in Serial Studio itself; check the example's README for its exact dependencies if nothing shows up after connecting.

Requirements

  • Serial Studio. Download from serial-studio.com.
  • Arduino IDE for examples that use Arduino sketches.
  • Python 3 for examples that use Python scripts.
  • Check each example's README for extra libraries or hardware.