DiamondLightSource / DiamondLightSource/fastcs-odin

Generating PV/attribute names from parameter URI

Open
#10 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

Attempted to address here in this branch:
https://github.com/jsouter/odin-fastcs/tree/names
For each controller, the parameter names are shortened by iterating over the URIs from the last part, the name for each attribute is composed from the fewest URI parts needed to make it unique.
e.g. status/hdf/rank and config/hdf/process/rank become hdf_rank and process_rank. It's possible that shortening the names could lead to ambiguity as to the meaning of the parameter, though hopefully the grouping of PVs on the screen makes this clearer.
We could also change the logic to only shorten parameter names that would exceed the EPICS character limit, though that logic would probably be better implemented in the EPICS handling part of FastCS itself

Contributor guide

Open the contributing guide

Research direction

Review the linked `names` branch and the controller parameter URI iteration described in the issue. Compare the `status/hdf/rank` and `config/hdf/process/rank` examples, then confirm the intended shortening rule, including whether it applies to all names or only those exceeding the EPICS character limit. Done means generated attribute names remain unique and the chosen rule is unambiguous.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.