nasa/fprime

Add OpenMCT Telemetry Viewer to F-Prime GDS

Open

#2161 opened on Jul 26, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)C++ (9,718 stars) (1,249 forks)batch import
help wanted

Description
F´ Version 3.2.1
Affected Component

Feature Description

An OpenMCT Telemetry viewer in F-Prime GDS would involve creating a plugin that would:

  1. Take in the TopologyAppDictionary.xml and generate OpenMCT JSON Definitions
  2. Poll the F-Prime GDS API for telemetry and publish the data to an OpenMCT server

Ideally, the user would just run the command fprime-gds and an OpenMCT server would start as a separate tab, along with the standard F-Prime GDS server. The user would get access to all the F-Prime telemetry channels in the OpenMCT server, which would display the channels in real time.

Rationale

Currently, the way to view telemetry in F-Prime GDS is via the charts tab and the channels tab. The current telemetry views allow for raw timestamp viewing and individual plots of telemetry. OpenMCT allows for additional customizability with telemetry viewing. Users can create layouts with multiple telemetry channels, and visualize telemetry in a much more refined manner(stacked/overlay plots, gauges, tables).

Contributor guide

Tech stack
pythonjavascript
Domain
full stack
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonJavaScriptOpenMCTF Prime GDS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Start by examining the existing F Prime GDS codebase to understand the API endpoints for telemetry data (likely in Python). Then explore OpenMCT's plugin architecture to create a custom telemetry adapter that reads from TopologyAppDictionary.xml to generate object definitions. The plugin should poll the GDS API and push data to an OpenMCT server instance. Look at the F Prime GDS launch scripts to see how to integrate the OpenMCT server as a separate tab. Review comments in the issue for any additional guidance or pointers to existing work.