Details
-
Type:
RFC
-
Status: Implemented
-
Resolution: Done
-
Component/s: T&S
-
Labels:None
-
Location:This ticket
Description
SAL topics for indexed components have a field named {Name}ID (e.g. MTHexapodID or ScriptID). I propose to rename this to salIndex (was private_index; changed after 2022-05-03 CAP meeting) to simplify usage and make topics more uniform. It is a nuisance to have to compute the name of the field.
I think this only affects Python code (and ts_sal internally). I don't know of any indexed non-Python CSCs. The Java Camera CSCs, ATMCS, etc are not indexed.
Also note that most code that deals with a specific index of a SAL component never sees this field. ts_salobj or ts_sal does the right thing when you specify an index.
Code that will need updating includes:
- Chronograf dashboards that filter on a specified SAL index.
- Some LOVE code, such as the ScriptQueue display.
- ts_scriptqueue, which uses this field to command a specific script.
- Possibly some Jupyter notebooks.
I have converted both ts_salobj and ts_scriptqueue and it was trivial. I expect the Chronograf dashboards to also be easy and am offering to do the work.
Attachments
Issue Links
- is triggering
-
DM-34642 Update LOVE to use field salIndex instead of {name}ID (RFC-849)
- To Do
-
DM-34639 Update Python code to change the {name}ID field to salIndex (RFC-849)
- Done
-
DM-34641 Update Chronograf dashboards to use the new salIndex field instead of {name}ID (RFC-849)
- Done
-
DM-34771 Rename existing salindex fields in ts_xml and update unit tests to prohibit salIndex as a field name
- Done
-
CAP-890 Update ts_sal to change the {name}ID field to salIndex (RFC-849)
-
- Done
-
This was provisionally accepted by CAP 2022-05-3. The big question is whether INRIA is willing to make this change for LOVE.