adams-visiona 1.0.0

data/data/config/telemetry_modifiers.yaml

@@ -0,0 +1,159 @@
+---
+ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet
+  example: |
+    ITEM PKTID 112 16 UINT "Packet ID"
+    ITEM DATA 0 0 DERIVED "Derived data"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: '\D\S*'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the telemetry packet of the Most Significant Bit of this item.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived item.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_items.yaml').to_meta_config_yaml(4) %>
+APPEND_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet
+  example: APPEND_ITEM PKTID 16 UINT "Packet ID"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: \'
+    <%= MetaConfigParser.load('_items.yaml').to_meta_config_yaml(4) %>
+ID_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet.
+    Note, packets defined without one or more ID_ITEMs are "catch-all" packets which
+    will match all incoming data. Normally this is the job of the UNKNOWN packet.
+  example: ID_ITEM PKTID 112 16 UINT 1 "Packet ID which must be 1"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: '\D\S*'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the telemetry packet of the Most Significant Bit of this item.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived item.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_id_items.yaml').to_meta_config_yaml(4) %>
+APPEND_ID_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet
+  example: APPEND_ID_ITEM PKTID 16 UINT 1 "Packet ID which must be 1"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: \'
+    <%= MetaConfigParser.load('_id_items.yaml').to_meta_config_yaml(4) %>
+ARRAY_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet that is an array
+  example: ARRAY_ITEM ARRAY 64 32 FLOAT 320 "Array of 10 floats"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: '\D\S*'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the telemetry packet of the Most Significant Bit of this item.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived item.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+APPEND_ARRAY_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a telemetry item in the current telemetry packet that is an array
+  example: APPEND_ARRAY_ITEM ARRAY 32 FLOAT 320 "Array of 10 floats"
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the telemety item. Must be unique within the packet.
+      values: \'
+    <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+SELECT_ITEM:
+  modifiers:
+    <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Selects an existing telemetry item for editing
+  example: |
+    SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
+      SELECT_ITEM ITEM
+  parameters:
+    - name: Item
+      required: true
+      description: Name of the item to select for modification
+      values: .+
+DELETE_ITEM:
+  summary: Delete an existing telemetry item from the packet definition
+  description: Deleting an item from the packet definition does not remove the
+    defined space for that item. Thus unless you redefine a new item, there
+    will be a "hole" in the packet where the data is not accessible. You can
+    use SELECT_TELEMETRY and then ITEM to define a new item.
+  example: |
+    SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
+      DELETE_ITEM ITEM
+  since: 4.4.1
+  parameters:
+    - name: Item
+      required: true
+      description: Name of the item to delete
+      values: .+
+META:
+  summary: Stores metadata for the current telemetry packet
+  description: Meta data is user specific data that can be used by custom tools
+    for various purposes. One example is to store additional information needed
+    to generate source code header files.
+  example: META FSW_TYPE "struct tlm_packet"
+  parameters:
+    - name: Meta Name
+      required: true
+      description: Name of the metadata to store
+      values: .*
+    - name: Meta Values
+      required: false
+      description: One or more values to be stored for this Meta Name
+      values: .*
+PROCESSOR:
+  summary: Defines a processor class that executes code every time a packet is received
+  example: PROCESSOR TEMP1HIGH watermark_processor.rb TEMP1
+  parameters:
+    - name: Processor Name
+      required: true
+      description: The name of the processor
+      values: .+
+    - name: Processor Class Filename
+      required: true
+      description: Name of the Ruby file which implements the processor.
+        This file should be in the config/TARGET/lib directory so it can be found by COSMOS.
+      values: '.+\.rb'
+    - name: Processor Specific Options
+      required: false
+      description: Variable length number of options that will be passed to the class constructor.
+      values: .+
+ALLOW_SHORT:
+  summary: Process telemetry packets which are less than their defined length
+  description: Allows the telemetry packet to be received with a data portion that
+    is smaller than the defined size without warnings. Any extra space in the packet
+    will be filled in with zeros by COSMOS.
+HIDDEN:
+  summary: Hides this telemetry packet from all the COSMOS tools
+  description: This packet will not appear in Packet Viewer, Telemetry Grapher and Handbook Creator.
+    It also hides this telemetry from appearing in the Script Runner popup helper
+    when writing scripts. The telemetry still exists in the system and can received
+    and checked by scripts.

data/data/config/test_runner.yaml

@@ -0,0 +1,119 @@
+---
+<%= MetaConfigParser.load('script_runner.yaml').to_meta_config_yaml(0) %>
+LOAD_UTILITY:
+  summary: Specify a test procedure to load into Test Runner
+  description: Procedures will be found automatically in the procedures directory
+    or can be given by a path relative to the COSMOS install directory or by an
+    absolute path.
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the test file in quotes
+      values: '.+\.rb'
+RESULTS_WRITER:
+  summary: Specify a different Ruby file to interpret and print the Test Runner results
+  description: The specified Ruby file must define a class which implements the
+    Cosmos::ResultsWriter API
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the Ruby file which implements a result writer
+      values: '.+\.rb'
+    - name: Class Parameters
+      required: false
+      description: Parameters to pass to the constructor of the results writer
+      values: .*
+ALLOW_DEBUG:
+  summary: Whether to allow the user to enable the debug line where the user can enter arbitrary statements
+PAUSE_ON_ERROR:
+  summary: Set or clear the pause on error checkbox
+  description: If this is checked, Test Runner will pause if the test encounters
+    an error. Otherwise the error will be logged but the script will continue.
+  parameters:
+    - name: Enable
+      required: true
+      description: Whether to pause when the script encounters an error
+      values: ['TRUE', 'FALSE']
+CONTINUE_TEST_CASE_AFTER_ERROR:
+  summary: Set or clear the continue test case after error checkbox
+  description: If this is checked, Test Runner will continue executing the current
+    test case after encountering an error. Otherwise the test case will stop at
+    the error and the next test case will execute.
+  parameters:
+    - name: Enable
+      required: true
+      description: Whether to continue the test case when the script encounters an error
+      values: ['TRUE', 'FALSE']
+ABORT_TESTING_AFTER_ERROR:
+  summary: Set or clear the abort testing after error checkbox
+  description: If this is checked, Test Runner will stop executing after the current
+    test case completes (how it completes depends on CONTINUE_TEST_CASE_AFTER_ERROR).
+    Otherwise the next test case will execute.
+  parameters:
+    - name: Enable
+      required: true
+      description: Whether to continue to the next test case when the script encounters an error
+      values: ['TRUE', 'FALSE']
+MANUAL:
+  summary: Set the $manual global variable for all executing scripts
+  description: The $manual variable can be checked during tests to allow for fully
+    automated tests if it is not set, or for user input if it is set. This capability
+    is completely dependent on user specific code which checks the $manual variable.
+  parameters:
+    - name: Enable
+      required: true
+      description: Whether to set the $manual global to true
+      values: ['TRUE', 'FALSE']
+LOOP_TESTING:
+  summary: Set or clear the loop testing checkbox
+  description: If this is checked, Test Runner will continue to run whatever level
+    of tests that were initially started. If either "Abort Testing after Error"
+    or "Break Loop after Error" are checked, then the loop testing will stop if
+    an error is encountered. The difference is that the "Abort Testing after Error"
+    will stop testing immediately after the current test case completes.
+    "Break Loop after Error" continues the current loop by executing the remaining
+    suite or group before stopping. In the case of executing a single test case
+    the options effectively do the same thing.
+  parameters:
+    - name: Enable
+      required: true
+      description: Whether to loop the selected test level
+      values: ['TRUE', 'FALSE']
+BREAK_LOOP_AFTER_ERROR:
+  summary: Set or clear the break loop after error checkbox
+  description: If this is checked, Test Runner continues the current loop by
+    executing the remaining suite or group before stopping.
+  parameters:
+    - name: Enable
+      required: true
+      description: Whether to break the loop after encountering an error
+      values: ['TRUE', 'FALSE']
+IGNORE_TEST:
+  summary: Ignore the given test class name when parsing the tests
+  parameters:
+    - name: Test Class Name
+      required: true
+      description: The test class to ignore when building the list of available tests
+      values: .+
+IGNORE_TEST_SUITE:
+  summary: Ignores the given test suite name when parsing the tests
+  parameters:
+    - name: Test Suite Name
+      required: true
+      description: The test suite to ignore when building the list of available tests
+      values: .+
+CREATE_DATA_PACKAGE:
+  summary: Creates a data package of every file created during the test
+AUTO_CYCLE_LOGS:
+  summary: Automatically start a new server message log and cmd/tlm logs at the
+    beginning and end of each test. Typically used in combination with CREATE_DATA_PACKAGE.
+COLLECT_METADATA:
+  summary: Prompt for Meta Data before starting tests
+DISABLE_TEST_SUITE_START:
+  summary: Disable the Test Suite Start button to prevent all tests in the Suite from running.
+    This is a useful option if you're simply using Suites and Groups to organize test cases but
+    do not want a user to accidentally run them all.
+DISABLE_TEST_GROUP_START:
+  summary: Disable the Test Group Start button to prevent all tests in the Group from running.
+    This is a useful option if you're simply using Suites and Groups to organize test cases but
+    do not want a user to accidentally run them all.

data/data/config/tlm_extractor.yaml

@@ -0,0 +1,109 @@
+---
+DELIMITER:
+  summary: Specify an alternative column delimiter over the default tab character
+  parameters:
+    - name: Delimiter
+      required: true
+      description: Character or string to use as a delimiter. For example ','.
+      values: .+
+FILL_DOWN:
+  summary: Insert a value into every row of the output
+  description: Telemetry Grapher produces an output file with columns for each
+    item name. If you are graphing items from different packets, only the columns
+    with items from that packet are populated with values. Fill down causes a
+    particular item column to be populated with the previous value so every column
+    is 'filled'. This makes it easier to graph multiple values across packets in Excel.
+DOWNSAMPLE_SECONDS:
+  summary: Downsample data to only output a value every X seconds of time
+  parameters:
+    - name: Seconds
+      required: true
+      desription: Number of seconds to skip between values output
+      values: \d+
+MATLAB_HEADER:
+  summary: Prepend the Matlab comment symbol of '%' to the header lines in the output file
+UNIQUE_ONLY:
+  summary: Only output a row if one of the extracted values has changed
+  description: This keyword is useful to extract telemetry items over a large time
+    period by only outputting those values where items have changed
+UNIQUE_IGNORE:
+  summary: Used in conjunction with UNIQUE_ONLY to control which items should be checked
+    for changing values
+  description: This list of telemetry items (not target names or packet names)
+    always includes the COSMOS metadata items named RECEIVED_TIMEFORMATTED and RECEIVED_SECONDS.
+    This is because these items will always change from packet to packet which would
+    cause them to ALWAYS be printed if UNIQUE_ONLY was used. To avoid this,
+    but still include time stamps in the output, UNIQUE_IGNORE includes these items.
+    Use this keyword if you have a similar telemetry item that you want to display
+    in the output but not be used to determine uniqueness.
+  parameters:
+    - name: Item Name
+      required: true
+      description: Name of the item to exclude from the uniqueness criteria.
+        Note that all items with this name in all target packets are affected.
+      values: .+
+SHARE_COLUMNS:
+  summary: Export telemetry items with the same name into the same column
+  description: Normally items from different packets are put in their own column
+    in the output. If this keyword is used, items with the same name in different
+    packets will now share one column in the output. This applies to all telemetry
+    items with identical names. If you want to share columns for only specific items,
+    use the SHARE_COLUMN keyword instead.
+SHARE_COLUMN:
+  summary: Export telemetry items with the same name into the same column
+  description: Normally items from different packets are put in their own column
+    in the output. This keyword is used to specify specific items that are from different
+    packets but should share one column in the output. This applies to all telemetry
+    items with identical names. If you want to share columns for all duplicate item
+    names in different packets, use the SHARE_COLUMNS keyword instead.
+  since: 3.9.2
+  parameters:
+    - name: Item Name
+      required: true
+      description: Name of the telemtry item
+      values: .+
+    - name: Item Type
+      required: false
+      description: Type of the telemetry item
+      values: ['CONVERTED', 'RAW', 'FORMATTED', 'WITH_UNITS']
+FULL_COLUMN_NAMES:
+  summary: Use TARGET PACKET ITEM as the column header for each column
+  description: Normally just the item name is used as the column header but this
+    adds the target and packet name. Note that the TARGET and PACKET columns
+    are not generated when this mode is active since the items are fully qualified.
+DONT_OUTPUT_FILENAMES:
+  summary: Don't output the list of input filenames at the top of each output file
+TEXT:
+  summary: Insert arbitrary text in the Telemetry Extractor output
+  description: Text also allows you to dynamically create Excel formulas using a special syntax
+  parameters:
+    - name: Header
+      required: true
+      description: The column header text
+      values: .+
+    - name: Text
+      required: true
+      description: Text to put in the output file. The special character '%' will
+        be translated to the current row of the output file. This is useful for
+        Excel formulas which need a reference to a cell. Remember the first two
+        columns are typically the TARGET and PACKET and telemetry items start in
+        column 'C' in Excel.
+ITEM:
+  summary: Specify a telemetry item to extract
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the telemetry target
+      values: <%= System.targets.keys %>
+    - name: Packet Name
+      required: true
+      description: Name of the telemetry packet
+      values: .+
+    - name: Item Name
+      required: true
+      description: Name of the telemetry item
+      values: .+
+    - name: Item Type
+      required: false
+      description: Type of the telemetry item
+      values: ['CONVERTED', 'RAW', 'FORMATTED', 'WITH_UNITS']

data/data/config/tlm_grapher.yaml

@@ -0,0 +1,78 @@
+---
+# Require data_object to access the COLOR_LIST
+<% require 'cosmos/tools/tlm_grapher/data_objects/data_object' %>
+POINTS_SAVED:
+  summary: Number of points saved in the plot history
+  warning: The larger the number the more memory Telemetry Grapher will use.
+    Eventually you will run out of memory!
+  parameters:
+    - name: Points
+      required: true
+      description: Number of points saved
+      values: \d+
+SECONDS_PLOTTED:
+  summary: Number of seconds plotted on each graph
+  parameters:
+    - name: Seconds
+      required: true
+      description: Number of seconds plotted
+      values: \d+
+POINTS_PLOTTED:
+  summary: Number of points plotted on each graph
+  warning: The larger the number the more performace is affected
+  parameters:
+    - name: Points
+      required: true
+      description: Number of points plotted per graph
+      values: \d+
+REFRESH_RATE_HZ:
+  summary: Telemetry Grapher refresh rate
+  parameters:
+    - name: Rate
+      required: true
+      description: Refresh rate in Hertz
+      values: '[0-9]*\.?[0-9]+'
+CTS_TIMEOUT:
+  summary: Timeout when trying to connect to the Server
+  parameters:
+    - name: Seconds
+      required: true
+      description: Timeout in seconds
+      values: '[0-9]*\.?[0-9]+'
+TAB:
+  summary: Create a new tab in the Telemetry Grapher GUI
+  parameters:
+    - name: Tab Text
+      required: false
+      description: Text to display on the tab
+      values: .*
+  modifiers:
+    PLOT:
+      summary: Create a new plot
+      parameters:
+        - name: Plot Type
+          required: true
+          description: Type of plot to create
+          values: ['LINEGRAPH', 'SINGLEXY', 'XY']
+      modifiers:
+        <%= MetaConfigParser.load('linegraph_plot.yaml').to_meta_config_yaml(8) %>
+        <%= MetaConfigParser.load('xy_plot.yaml').to_meta_config_yaml(8) %>
+        DATA_OBJECT:
+          modifiers:
+            COLOR:
+              summary: Color of the Data object
+              parameters:
+                - name: Color
+                  required: true
+                  description: Line color to draw the Data Object
+                  values: <%= DataObject::COLOR_LIST %>
+            <%= MetaConfigParser.load('housekeeping_params.yaml').to_meta_config_yaml(12) %>
+            <%= MetaConfigParser.load('linegraph_params.yaml').to_meta_config_yaml(12) %>
+            <%= MetaConfigParser.load('xy_params.yaml').to_meta_config_yaml(12) %>
+          summary: Type of data object on the plot
+          parameters:
+            - name: Data Object Type
+              required: true
+              description: Describes how the telemetry item is stored.
+                Typically matches the Plot Type.
+              values: ['LINEGRAPH','HOUSEKEEPING','SINGLEXY','XY']

data/data/config/tlm_viewer.yaml

@@ -0,0 +1,112 @@
+---
+AUTO_TARGETS:
+  summary: Add all screens defined in the screens directory of each target folder
+  description: Automatically added screens are grouped by target name in the display.
+    For example, all the screens defined in config/targets/COSMOS/screens will be
+    added to a single drop down selection labeled COSMOS.
+AUTO_TARGET:
+  summary: Add all screens defined in the screens directory of the specified target folder
+  description: Screens are grouped by target name in the display. For example,
+    all the screens defined in config/targets/COSMOS/screens will be added to a
+    single drop down selection labeled COSMOS.
+  warning: If AUTO_TARGETS is used this keyword does nothing
+  parameters:
+    - name: Target
+      required: true
+      description: Name of the target
+      values: <%= System.targets.keys %>
+NEW_COLUMN:
+  summary: Creates a new column of drop down selections in Telemetry Viewer
+  description: All the AUTO_TARGET or SCREEN keywords after this keyword will be
+    added to a new column in the GUI.
+TARGET:
+  summary: Used in conjunction with the SCREEN keyword to define individual screens
+    within a target's screen directory.
+  parameters:
+    - name: Target
+      required: true
+      description: Name of the target
+      values: <%= System.targets.keys %>
+  modifiers:
+    SCREEN:
+      summary: Adds the specified screen from the specified target
+      parameters:
+        - name: File Name
+          required: true
+          description: Name of the file containing the telemetry screen definition.
+            The filename will be upcased and used in the GUI drop down selection.
+          values: .+
+        - name: X Position
+          required: false
+          description: Position in pixels to draw the left edge of the screen on
+            the display. If not supplied the screen will be centered. If supplied,
+            the Y position must also be supplied.
+          values: \d+
+        - name: Y position
+          required: false
+          description: Position in pixels to draw the top edge of the screen on
+            the display. If not supplied the screen will be centered. If supplied,
+            the X position must also be supplied.
+          values: \d+
+      modifiers:
+        SHOW_ON_STARTUP:
+          summary: Causes the previously defined SCREEN to be automatically displayed
+            when Telemetry Viewer starts
+ADD_SHOW_ON_STARTUP:
+  summary: Adds show on startup to any screen that has already been defined
+  description: Screens that are discoverd by AUTO_TARGETS or AUTO_TARGET aren't
+    explicitly defined. Thus this keyword is used to add show on startup.
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target Name of the screen
+      values: <%= System.targets.keys %>
+    - name: Screen Name
+      required: true
+      description: Name of the screen. This is equal to the screen's filename
+        without the .txt extension.
+      values: .+
+    - name: X Position
+      required: false
+      description: Position in pixels to draw the left edge of the screen on
+        the display. If not supplied the screen will be centered. If supplied,
+        the Y position must also be supplied.
+      values: \d+
+    - name: Y position
+      required: false
+      description: Position in pixels to draw the top edge of the screen on
+        the display. If not supplied the screen will be centered. If supplied,
+        the X position must also be supplied.
+      values: \d+
+GROUP:
+  summary: Create a new drop down group of screens in the GUI
+  parameters:
+    - name: Group Name
+      required: true
+      description: The text to display in front of the drop down list of screens
+      values: .+
+  modifiers:
+    GROUP_SCREEN:
+      summary: Define a screen in the given group drop down
+      parameters:
+        - name: Target Name
+          required: true
+          description: Target Name of the screen
+          values: <%= System.targets.keys %>
+        - name: Screen Name
+          required: true
+          description: Name of the screen. This is equal to the screen's filename
+            without the .txt extension.
+          values: .+
+        - name: X Position
+          required: false
+          description: Position in pixels to draw the left edge of the screen on
+            the display. If not supplied the screen will be centered. If supplied,
+            the Y position must also be supplied.
+          values: \d+
+        - name: Y position
+          required: false
+          description: Position in pixels to draw the top edge of the screen on
+            the display. If not supplied the screen will be centered. If supplied,
+            the X position must also be supplied.
+          values: \d+

data/data/config/unknown.yaml

@@ -0,0 +1,3 @@
+---
+UNKNOWN:
+  summary: Unknown keyword selected