pcdshub / pcdshub/lightpath

ENH: add `state_summary` to LightpathState, for showing select device signal information

Open
#158 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4
Forks
9
Avg merge
7d 14h
Merged PRs (30d)
1

Description

Expected Behavior

From discussions on #157

I wonder if there is any metadata we could slide into the LightpathState dataclass to use in this space in an efficient way instead of the ad hoc "grab a few signals and make widgets".

Possible Solution

Just as an idea for a follow-up for what to do with the space, what if we extend like:

@dataclass
class LightpathState:
inserted: bool
removed: bool
transmission: float
output_branch: str
state_summary: str = ""
And then devices can provide text to lightpath to include in a label. Just a small idea, there are probably better ways to do this.

Context

#157

The commands widget was removed, and along with it the visibility of hinted signals. it might be nice to see these return, if performance issues can be solved. Implementing this should come with careful consideration of which components are being "woken up" and the ensuing performance impacts

Your Environment

pcds-5.4.2+lightpath pr's

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the discussion in #157 and locating the LightpathState dataclass and the removed commands widget. Determine whether a state_summary design can restore hinted signal visibility without waking too many components; done requires an agreed implementation and acceptable performance impact.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.