Skip to content

Latest commit

 

History

54 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Grafana Yamcs JAOPS logo

CI Benchmark Grafana catalog version Downloads License

Grafana Plugin for the Yamcs Mission Control Software

A comprehensive Grafana plugin to connect to Yamcs servers for real-time telemetry visualization and commanding capabilities. Designed for mission control centers, aerospace applications and beyond.

Grafana Catalog · Setup Instructions · Testing Guide · Benchmarking · Yamcs Quickstart

Overview

Grafana Yamcs JAOPS connects Grafana directly to the Yamcs server to display telemetry, send commands, inspect command history, monitor alarms, control Yamcs links, and synchronize dashboards with Yamcs processor time.

This plugin is engineered for high reliability to be used in Mission Control Centers and anywhere Yamcs is used.

The current version has already been tested in real-world deployments but active development continues and community feedback and contributions are very welcome.

Development is led by JAOPS: providing Mission Control software, tools and training for spacecraft in orbit and rovers on the Moon!

Install and Try

There are two common ways to use the plugin:

  • One-click catalog install: install the signed release from the Grafana Catalog when you want the latest published version.
  • Local development install: follow the setup instructions when you want to test unreleased changes, contribute, or run the local demo environment.

For a quick Yamcs demo, use the JAOPS Yamcs Quickstart. The plugin also includes in-app tutorials for each panel, available from the main navigation menu in Grafana.

Grafana Catalog jaops-yamcs-app
Latest catalog version Latest catalog version
Status Catalog status
Signature Signature type Signed by
Grafana dependency Grafana dependency
Catalog downloads Catalog downloads
Catalog updated Catalog updated

Plugin Parts

Icon Plugin Part Capability
Datasource icon Yamcs Datasource Connects Grafana to Yamcs endpoints, queries telemetry, streams realtime values, exposes backend resources, and reports endpoint health.
Commanding icon Commanding Panel Issues commands via a Grafana panel with fully customizable buttons, supporting arguments, comments, and endpoint targeting.
Command history icon Command History Panel Keeps track of commands sent, arguments, acknowledgements, and command execution state.
Telemetric image icon Telemetric Image Panel Visualizes realtime image data from Yamcs telemetry.
Static image icon Static Image Panel Overlays telemetry data on static images such as spacecraft layouts, maps, or operator schematics.
Variables icon Variable Setting Panel Provides operator-friendly dashboard variable controls for commanding and filtering workflows.
Alarms icon Alarms Panel Displays active Yamcs alarms and supports alarm-focused operations from Grafana.
Links icon Links Panel Displays Yamcs data links and lets operators enable or disable them from Grafana.
Time sync icon Yamcs Time Sync Visualizes replays and future simulations through synchronization between Grafana and the Yamcs clock.

Features

  • Multiplexed Endpoint Support - Designed to handle complex setups with multiple Yamcs endpoints through a robust multiplexer system. Supports scaling to many Grafana clients efficiently by multiplexing the connections to Yamcs: the same data is only requested once.

  • Modular and Scalable Architecture - Clean separation of concerns and a solid backend structure built for reliability and flexibility.

  • Telemetry & Static Image Panel - Visualize real-time telemetry data or overlay data on static images, such as spacecraft layouts and maps.

  • Commanding Panel - Issue commands via a Grafana panel with fully customizable buttons, supporting arguments, comments, and endpoint targeting.

  • Intuitive UI/UX - Clean and simple user interface designed to be easy to use, even for non-experts.

  • Live Status Feedback - Displays endpoint availability and WebSocket status in real-time, ensuring quick diagnostics.

  • Fully Configurable - Every aspect of the plugin, from endpoint configuration to command structure and visual layout, is configurable through Grafana's settings.

  • Replay/Simulation support - Visualize replays and future simulations through synchronization between Grafana and Yamcs clock.

Plugin model document

Example Grafana Dashboard Connected to Yamcs

Demo Dashboards are provisioned in provisioning/dashboards, they showcase the main capabilities of the plugin. They are made to use data from the Yamcs Quickstart.

After cloning the Yamcs Quickstart, run in separate terminals:

./mvn yamcs:run
python3 simulator.py
python3 simulator/images/generate_images.py

Grafana dashboard connected to Yamcs

Try Out the Plugin for Yourself

Follow the setup instructions to get started in just a few minutes.

For deeper development and validation workflows:

Guide Purpose
Testing Guide Local unit, integration, and end-to-end testing workflows.
Benchmarking Benchmark setup, metrics, plots, and CI behavior.
Plugin Signing Signing and release preparation notes.
GitHub Secrets Setup CI secret configuration.

Contributions

Contributions are welcome!

If you find a bug, have a feature request, or want to improve the project, feel free to open an issue or submit a pull request.

Please follow the existing code style and include tests if applicable. For major changes, it's recommended to open a discussion first. Read the contributing guidelines for further indications on how to contribute.

Acknowledgements

Since October 2024, the plugin has been tested and improved with feedback from the Space Robotics Lab of Tohoku University in Sendai, Japan.

License

This project is licensed under the MIT License. You are free to use, modify, and distribute this software with proper attribution.

About

A comprehensive Grafana plugin to connect to Yamcs servers for real-time telemetry visualization and commanding capabilities. Designed for mission control centers, aerospace applications and beyond.

Topics

Resources

Contributing

Stars

9 stars

Watchers

3 watching

Forks

Releases

Used by

Contributors

Languages