Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #121 - Add help text popover for command arguments #234

Merged
merged 1 commit into from
Aug 5, 2022

Conversation

bkseto
Copy link
Contributor

@bkseto bkseto commented Aug 3, 2022

This PR adds the ability for users to view command argument information by clicking on the info icon.

ait_gui_cmd_arg_popover2

Examples:

  • SEND_STR_ARG
- !Command
  name:      SEND_STR_ARG
  opcode:    0x0005
  subsystem: CMD
  title: Send string argument value
  desc:      |
    This command tests sending a single string argument.

  arguments:
    - !Argument
      name: str_arg
      desc: String Argument
      units: none
      type: S16
      bytes: [0,15]

Screen Shot 2022-08-03 at 10 47 33 AM

  • SEQ_ENABLE_DISABLE
- !Command
  name:      SEQ_ENABLE_DISABLE
  opcode:    0x0003
  subsystem: CMD
  title: Enable/Disable Sequence
  desc:      |
    This command enables or disabled the specified sequence.  If a
    sequence to be disabled is currently executing, it will be
    interrupted.

  arguments:
    - !Argument
      name:  sequence_id
      desc:  Sequence ID
      units: none
      type:  MSB_U16
      bytes: [0,1]

    - !Argument
      name:  enable
      desc:  Enable
      units: none
      type:  U8
      bytes: 2
      enum:
        0: DISABLED
        1: ENABLED

Screen Shot 2022-08-03 at 10 41 39 AM
Screen Shot 2022-08-03 at 10 41 46 AM

  • CORE_SET_OP_MODE
- !Command
  name:      CORE_SET_OP_MODE
  opcode:    0x0006
  subsystem: CORE
  desc:      |
    This command sets the operational mode.

  arguments:
  - !Argument
    name:  mode
    desc:  Mode
    units: none
    type:  U8
    bytes: 0
    enum:
      0: SAFE
      1: IDLE
      2: SCANNING
      3: SCIENCE

Screen Shot 2022-08-03 at 10 42 04 AM

Note: Most of the popover implementation was borrowed from here.

Closes #121.

@bkseto bkseto requested review from a team as code owners August 3, 2022 17:50
@nttoole nttoole merged commit 3132363 into NASA-AMMOS:master Aug 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Help text display on command arguments
2 participants