cosmos 4.0.3-java

data/data/config/table_manager.yaml

@@ -0,0 +1,76 @@
+---
+TABLEFILE:
+  summary: Specify another file to open and process for table definitions
+  parameters:
+    - name: File Name
+      required: true
+      description: Name of the file. The file will be looked for in the directory
+        of the current definition file.
+      values: '.+\.txt'
+TABLE:
+  modifiers:
+    PARAMETER:
+      modifiers:
+        <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(8) %>
+        <%= MetaConfigParser.load('table_parameter_modifiers.yaml').to_meta_config_yaml(8) %>
+      summary: Defines a parameter in the current table
+      parameters:
+        - name: Name
+          required: true
+          description: Name of the parameter. Must be unique within the table.
+          values: '\D\S*'
+        - name: Bit Offset
+          required: true
+          description: Bit offset into the table of the Most Significant Bit of this parameter.
+            May be negative to indicate on offset from the end of the table.
+            Always use a bit offset of 0 for derived parameters.
+          values: '[-]?\d+'
+        <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(8) %>
+    APPEND_PARAMETER:
+      modifiers:
+        <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(8) %>
+        <%= MetaConfigParser.load('table_parameter_modifiers.yaml').to_meta_config_yaml(8) %>
+      summary: Defines a parameter in the current table
+      parameters:
+        - name: Name
+          required: true
+          description: Name of the parameter. Must be unique within the table.
+          values: .+
+        <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(8) %>
+  summary: Start a new table definition
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the table in quotes. The name will appear on the GUI tab.
+      values: "['\"].*['\"]"
+    - name: Endianness
+      required: true
+      description: Indicates if the data in this table is in Big Endian or Little Endian format
+      values: ['BIG_ENDIAN', 'LITTLE_ENDIAN']
+    - name: Display
+      requires: true
+      description: Indicates the table is a ONE_DIMENSIONAL table which is a two
+        column table consisting of unique rows, or a TWO_DIMENSIONAL table with
+        multiple columns and identical rows with unique values
+      values:
+        ONE_DIMENSIONAL:
+          summary: Declare a key value two column table with unique rows
+          parameters:
+            - name: Description
+              requires: true
+              description: Description of the table in quotes. The description is
+                used in mouseover popups and status line information.
+              values: "['\"].*['\"]"
+        TWO_DIMENSIONAL:
+          summary: Declare a table with multiple columns and identical rows with
+            unique values
+          parameters:
+            - name: Rows
+              requires: true
+              description: The number of rows in the table
+              values: \d+
+            - name: Description
+              requires: true
+              description: Description of the table in quotes. The description is
+                used in mouseover popups and status line information.
+              values: "['\"].*['\"]"

data/data/config/table_parameter_modifiers.yaml

@@ -0,0 +1,9 @@
+---
+HIDDEN:
+  summary: Indicates that the parameter should not be shown to the user in the Table Manager GUI
+  description: Hidden parameters still exist and will be saved to the resulting
+    binary. This is useful for padding and other essential but non-user editable fields.
+UNEDITABLE:
+  summary: Indicates that the parameter should be shown to the user but not editable.
+  description: Uneditable parameters are useful for control fields which the user
+    may be interested in but should not be able to edit.

data/data/config/target.yaml

@@ -0,0 +1,80 @@
+---
+REQUIRE:
+  summary: Requires a Ruby file
+  description: Ruby files must be required to be available to call in other code.
+    Files are first required from the target's lib folder. If no file is found the
+    Ruby system path is checked which includes the base COSMOS/lib folder.
+  example: REQUIRE limits_response.rb
+  parameters:
+    - name: Filename
+      required: true
+      description: Filename to require. For files in the target's lib directory
+        simply supply the filename, e.g. "REQUIRE my_file". Files in the base COSMOS
+        lib directory also should just list the filename. If a file is in a folder
+        under the lib directory then you must specify the folder name, e.g. "REQUIRE
+        folder/my_file". The filename can also be an absolute path but this is not
+        common. Note the ".rb" extension is optional when specifying the filename.
+      values: .+
+IGNORE_PARAMETER:
+  summary: Ignore the given command parameter
+  description: Hint to other COSMOS tools to hide or ignore this command parameter
+    when processing the command. For example, Command Sender and Command Sequence
+    will not display the parameter (by default) when showing the command and Script
+    Runner code completion will not display the parameter.
+  example: IGNORE_PARAMETER CCSDS_VERSION
+  parameters:
+    - name: Parameter Name
+      required: true
+      description: The name of a command parameter. Note that this parameter will
+        be ignored in ALL the commands it appears in.
+      values: .+
+IGNORE_ITEM:
+  summary: Ignore the given telemetry item
+  description: Hint to other COSMOS tools to hide or ignore this telemetry item
+    when processing the telemetry. For example, Packet Viewer will not display the
+    item (by default) when showing the packet.
+  example: IGNORE_ITEM CCSDS_VERSION
+  parameters:
+    - name: Item name
+      required: true
+      description: The name of a telemetry item. Note that this item will be ignored
+        in ALL the telemetry it appears in.
+      values: .+
+COMMANDS:
+  summary: Process the given command definition file
+  description: This keyword is used to explicitly add the command definition file
+    to the list of command and telemetry files to process.
+  warning: Usage of this keyword overrides automatic command and telemetry file
+    discovery. If this keyword is used, you must also use the TELEMETRY keyword
+    to specify the telemetry files to process.
+  example: |
+    COMMANDS inst_cmds_v2.txt
+    TELEMETRY inst_tlm_v2.txt
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of a command definition file in the target's cmd_tlm directory, e.g. "cmd.txt".
+      values: '.*\.txt'
+TELEMETRY:
+  summary: Process the given telemetry definition file
+  description: This keyword is used to explicitly add the telemetry definition
+    file to the list of command and telemetry files to process.
+  warning: Usage of this keyword overrides automatic command and telemetry file
+    discovery. If this keyword is used, you must also use the COMMAND keyword to
+    specify the command files to process.
+  example: |
+    COMMANDS inst_cmds_v2.txt
+    TELEMETRY inst_tlm_v2.txt
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of a telemetry definition file in the target's cmd_tlm
+        directory, e.g. "tlm.txt".
+      values: '.*\.txt'
+AUTO_SCREEN_SUBSTITUTE:
+  summary: Automatically substitute the target's name in screen definitions
+  description: Targets can be renamed when they are declared which would break
+    any screen definitions using the explicit target name. This keyword automatically
+    replaces the target name in the screen definitions with the actual target name.
+  warning: Replaces ALL target names in a screen definition file, so this is not
+    suitable for screens with multiple targets.

data/data/config/telemetry.yaml

@@ -0,0 +1,80 @@
+---
+TELEMETRY:
+  modifiers:
+    <%= MetaConfigParser.load('telemetry_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a new telemetry packet
+  example: TELEMETRY SYSTEM LIMITS_CHANGE BIG_ENDIAN "COSMOS limits change"
+  parameters:
+    - name: Target
+      required: true
+      description: Name of the target this telemetry packet is associated with
+      values: <%= System.targets.keys %>
+    - name: Command
+      required: true
+      description: Name of this telemetry packet. Also referred to as its mnemonic.
+        Must be unique to telemetry packets in this target. Ideally will be as short and clear as possible.
+      values: \D\S*
+    - name: Endianness
+      required: true
+      description: Indicates if the data in this packet is in Big Endian or Little Endian format
+      values: ['BIG_ENDIAN', 'LITTLE_ENDIAN']
+    - name: Description
+      required: false
+      description: Description of this telemetry packet which must be enclosed with quotes
+      values: "['\"].*['\"]"
+SELECT_TELEMETRY:
+  modifiers:
+    <%= MetaConfigParser.load('telemetry_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Selects an existing telemetry packet for editing
+  description: Typically used in a separate configuration file from where the original
+    telemetry is defined to override or add to the existing telemetry definition
+  example: SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the target this telemetry packet is associated with
+      values: <%= System.targets.keys %>
+    - name: Command Name
+      required: true
+      description: Name of the telemetry packet to select
+      values: .+
+LIMITS_GROUP:
+  summary: Defines a group of related limits Items
+  description: Limits groups contain telemetry items that can be enabled and disabled together.
+    It can be used to group related limits as a subsystem that can be enabled or disabled
+    as that particular subsystem is powered (for example). To enable a group call the
+    enable_limits_group("NAME") method in Script Runner. To disable a group call the
+    disable_limits_group("NAME") in Script Runner. Items can belong to multiple groups
+    but the last enabled or disabled group "wins". For example, if an item belongs to
+    GROUP1 and GROUP2 and you first enable GROUP1 and then disable GROUP2 the item will
+    be disabled. If you then enable GROUP1 again it will be enabled.
+  parameters:
+    - name: Group Name
+      required: true
+      description: Name of the limits group
+      values: .+
+LIMITS_GROUP_ITEM:
+  summary: Adds the specified telemetry item to the last defined LIMITS_GROUP
+  description: Limits group information is typically kept in a separate configuration
+    file in the config/TARGET/cmd_tlm folder named limits_groups.txt. If you want to
+    configure multiple target items in a particular group you should put this information
+    in the config/SYSTEM/cmd_tlm/limits_groups.txt file. The SYSTEM target is processed
+    last and contains information that crosses target boundaries.
+  example: |
+    LIMITS_GROUP SUBSYSTEM
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP1
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP2
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP3
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the target
+      values: <%= System.targets.keys %>
+    - name: Packet Name
+      required: true
+      description: Name of the packet
+      values: .+
+    - name: Item Name
+      required: true
+      description: Name of the telemetry item to add to the group
+      values: .+

data/data/config/telemetry_modifiers.yaml

@@ -0,0 +1,142 @@
+---
+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
+  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 packedt 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: .+
+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,118 @@
+---
+<%= MetaConfigParser.load('script_runner.yaml').to_meta_config_yaml(0) %>
+LOAD_UTILITY:
+  summary: Specify a test procedure to run
+  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. This keyword is used to load the script and execute it line
+    by line by showing the current execution point. Sometimes you want to load
+    utility code that is NOT executed line by line but is executed in the background.
+    For example, a CRC routine or other long running calculation. The Ruby keyword
+    'load' can be used for this purpose, e.g. 'load utility.rb'. This code will
+    be loaded but not shown when executing.
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the test file in quotes
+      values: '.+\.rb'
+REQUIRE_UTILITY:
+  summary: DEPRECATED in favor of LOAD_UTILITY
+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