nasa/fprime

GDS does not show units when telemetry formatted as struct is expanded

Open

#2827 opened on Aug 6, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (9,718 stars) (1,249 forks)batch import
F´ GDSbughelp wanted

Description
F´ Version 3.4.3
Affected Component fprime-gds

Feature Description

Format strings can be specified within an FPP structure:

        struct compTlm_t {
            B1TestOvr: bool
            B1ArrV: U16 format "{} mV"
            B1ArrI: U16 format "{} mA"
            B1MpptV: U16 format "{} mV"
            B1BattI: U16 format "{} mA"

The channels view shows that format string when it is collapsed:

image

But those same units are not shown when it is expanded:

image

The units provided by a user should be shown in both views.

Rationale

Units are important no matter what view a user chooses to inspect telemetry in. Some telemetry structures can be large, and they must be expanded for quick and easy readability.

Contributor guide

Tech stack
None
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue is about displaying format strings (units) in the expanded view of telemetry structs in the GDS channels view. Investigate the frontend code responsible for rendering telemetry table, specifically the components that toggle between collapsed and expanded views. Look for where format strings are retrieved and displayed in collapsed state, and extend the same logic to the expanded state. The GDS frontend is likely built with React, so the relevant files would be in the telemetry panel components.