Command dictionary view

[joswig]

When editing a sequence, provide a view that shows all commands in the dictionary specified in the sequence's parcel. For each command definition show argument names, types, ranges, and any other values set in dictionary.

Out of scope, but consider that we may want to show parameter dictionary and channel dictionary soon. We also are actively evaluating switching from AMPCS dictionary format to XTCE, or maybe support both.

Branch /feat/dict_view is a rough idea of what I had in mind, but we should take it through our normal design process

[dandelany]

Met today with @lklyne @shaheerk94 and @joswig to hash out some requirements for this:

• This is basically a catalog of all commands/arguments in the current parcel for the sequence, ie. don't need to select/include multiple parcels
• Should fit in the same page as Phoenix sequence editor, probably bottom left pane
  • could make changes to the metadata in top left to make room for it, squeeze it down to less area
• User should be able to search by command stem and see a list of all partially-matching commands
  • future version: would like to search by argument name or enum type
• In the search results, should probably allow user to click on a command to select it & see more details, otherwise may be too hard to squeeze all information in the list of results
• Could have a breadcrumb-style nav at the top - showing which parcel/dictionary/command you're looking at
• Each command should show the following information:
  • Command stem, opcode & description
  • all arguments for the command - possible argument types include:
  • Numeric args, which may have an allowed range (min/max)
  • String args, which may have a max length
  • Enums - show all possible enum values,
    • but there could be >1000 possible values, need search or pagination
  • Repeat args - an argument that can be an array of M tuples containing N values each
    • M can have a min and max range - ie. how many times the tuples can be repeated
    • each of the N values in the tuples has a (primitive) type ie. number, string or enum - but can't contain other repeat args

An example command dictionary can be found here, but it does not currently contain any Repeat args - @joswig will add some:

https://github.com/NASA-AMMOS/aerie-ui/blob/develop/e2e-tests/data/command-dictionary.xml

@lklyne is working on design ideas in this Figma doc:

https://www.figma.com/board/aeLOMZduURvJbyKs9AtesW/Sequencing-initial-design-work?node-id=0-1&node-type=canvas&t=PmdcQAbSWzToPMAv-0

[lklyne]

Explorations on selected command vs activity dictionary.

open questions around visual treatment, and what info should be in selected command vs command dictionary

https://www.figma.com/design/T4MZq59UrKCI0AqHqdqvE9/Aerie---Command-dictionary-view-%231493?node-id=0-1&t=4s0lv6GNUch133SQ-1

[lklyne]

Dev direction: https://www.figma.com/design/T4MZq59UrKCI0AqHqdqvE9/Aerie---Command-dictionary-view-%231493?node-id=63-17948&t=UO5E8ewtx8Iljf8B-4

Features

Tab for command dictionary

• Add tab for command dictionary
• Add link in empty state to command dictionary

Command dictionary tab > List

• On command dictionary tab, show collapsable list of commands grouped by dictionary name
• Ability to search by
  • Command stem
  • subsystem
  • argument name

Command dictionary tab > Single command

• Show header with breadcrumbs, ability to copy command, close
• Show command description
• List arguments in collapsable hierarchy
• Show chips for unit, type, and range when available. (ideally make these responsive so text is truncated when there's not enough horizontal space. push to a new line when expanded)
• List enum options

Selected Command

• Mirror layout with activity instance details panel
  • Add header with command name and link to command in dictionary
  • Show description below
  • Show unit in input when present. (keep static for now. we'll explore making this a variable swap in the future)
  • When enough horizontal space is present, show argument name and input stacked horizontally, otherwise stack vertically
• For tuples + sets, show range and sets next to top-level arg