cosmos 4.0.0-universal-java-1.8

data/data/config/screen.yaml

@@ -0,0 +1,151 @@
+---
+SCREEN:
+  summary: Define a telemetry viewer screen
+  parameters:
+    - name: Width
+      required: true
+      description: Width in pixels or AUTO to let Telemetry Viewer automatically
+        layout the screen
+      values: \d+
+    - name: Height
+      required: true
+      description: Height in pixels or AUTO to let Telemetry Viewer automatically
+        layout the screen
+      values: \d+
+    - name: Polling Period
+      required: true
+      description: Number of seconds between screen updates
+      values: '[0-9]*\.?[0-9]+'
+END:
+  summary: Indicates the close of a layout widget
+  description: All layout widgets must be closed to properly identify where they
+    stop. For example, a VERTICALBOX keyword must be matched with an END keyword
+    to indicate where the VERTICALBOX ends.
+GLOBAL_SETTING:
+  summary: Applies a widget setting to all widgets of a certain type
+  parameters:
+    - name: Widget Class Name
+      required: true
+      description: The name of the class of widgets that this setting will be
+        applied to. For example, LABEL or BUTTON.
+      values: .+
+    - name: Setting Name
+      required: true
+      description: Widget specific setting name. COSMOS defines several settings
+        which apply across many different widget types. However, you can also use
+        the 'RAW' setting which allows any stylesheet values that QT supports.
+        See the QT Stylesheet documentation for more information.
+      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+    - name: Setting Value(s)
+      required: false
+      description: >
+        The setting value which varies by setting. Note that color
+        settings can be given as a common string, e.g. 'red', or by RGB values,
+        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
+        string, e.g. "font-size: 10px"
+      values: .*
+GLOBAL_SUBSETTING:
+  summary: Applies a widget subsetting to all widgets of a certain type
+  description: Subsettings are only valid for widgets that are
+    made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL
+    at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing
+    settings to specific subwidgets. Some widgets are made up of multiple subwidgets,
+    e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget
+    Index to first index the LABELVALUE and then the LABEL.
+  parameters:
+    - name: Widget Class Name
+      required: true
+      description: The name of the class of widgets that this setting will be
+        applied to. For example, LABELVALUE.
+      values: .+
+    - name: Subwidget Index
+      required: true
+      description: Index to the desired subwidget or 'ALL' to apply the setting
+        to all the subwidgets of this composite widget.
+      values: .+
+    - name: Setting Name
+      required: true
+      description: Widget specific setting name. COSMOS defines several settings
+        which apply across many different widget types. However, you can also use
+        the 'RAW' setting which allows any stylesheet values that QT supports.
+        See the QT Stylesheet documentation for more information.
+      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+    - name: Setting Value(s)
+      required: false
+      description: >
+        The setting value which varies by setting. Note that color
+        settings can be given as a common string, e.g. 'red', or by RGB values,
+        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
+        string, e.g. "font-size: 10px"
+      values: .*
+SETTING:
+  summary: Applies a widget setting to the previously defined widget
+  parameters:
+    - name: Setting Name
+      required: true
+      description: Widget specific setting name. COSMOS defines several settings
+        which apply across many different widget types. However, you can also use
+        the 'RAW' setting which allows any stylesheet values that QT supports.
+        See the QT Stylesheet documentation for more information.
+      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+    - name: Setting Value(s)
+      required: false
+      description: >
+        The setting value which varies by setting. Note that color
+        settings can be given as a common string, e.g. 'red', or by RGB values,
+        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
+        string, e.g. "font-size: 10px"
+      values: .*
+SUBSETTING:
+  summary: Applies a widget subsetting to the previously defined widget
+  description: Subsettings are only valid for widgets that are
+    made up of more than one subwidget. For example, LABELVALUE is made up of a LABEL
+    at subwidget index 0 and a VALUE at subwidget index 1. This allows for passing
+    settings to specific subwidgets. Some widgets are made up of multiple subwidgets,
+    e.g. LABELVALUELIMITSBAR. To set the label text color, pass '0:0' as the Subwidget
+    Index to first index the LABELVALUE and then the LABEL.
+  parameters:
+    - name: Subwidget Index
+      required: true
+      description: Index to the desired subwidget or 'ALL' to apply the setting
+        to all the subwidgets of this composite widget.
+      values: .+
+    - name: Setting Name
+      required: true
+      description: Widget specific setting name. COSMOS defines several settings
+        which apply across many different widget types. However, you can also use
+        the 'RAW' setting which allows any stylesheet values that QT supports.
+        See the QT Stylesheet documentation for more information.
+      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+    - name: Setting Value(s)
+      required: false
+      description: >
+        The setting value which varies by setting. Note that color
+        settings can be given as a common string, e.g. 'red', or by RGB values,
+        e.g. 255 0 0. If the setting is RAW the value should be the raw stylesheet
+        string, e.g. "font-size: 10px"
+      values: .*
+NAMED_WIDGET:
+  summary: Name a widget to allow access to it via the get_named_widget method
+  description: To programatically accesss parts of a telemetry screen you need
+    to name the widget. This is useful when creating screens with buttons that
+    read values from other widgets.
+  warning: get_named_widget returns the widget itself and thus must be operated
+    on using methods native to that widget
+  parameters:
+    - name: Widget Name
+      required: true
+      description: The unique name applied to the following widget instance.
+        Names must be unique per screen.
+      values: .+
+    - name: Widget Type
+      required: true
+      description: One of the widget types listed in Widget Descriptions
+      values: .+
+    - name: Widget Parameters
+      required: true
+      description: The unique parameters for the given widget type
+      values: .+
+# Even though these are technically SCREEN modifiers we load them at the top_frame
+# level so they appear as available keywords
+<%= MetaConfigParser.load('widgets.yaml').to_meta_config_yaml(0) %>

data/data/config/script_runner.yaml

@@ -0,0 +1,15 @@
+---
+LINE_DELAY:
+  summary: Sets the amount of time in seconds before the next line of a script will be executed
+  parameters:
+    - name: Delay
+      required: true
+      description: Delay in seconds before the next line is executed. A value of
+        0 means to execute the scripts as fast as possible.
+      values: '[0-9]*\.?[0-9]+'
+MONITOR_LIMITS:
+  summary: Log limits events to the Script Runner log file while a script is running
+  description: Limits events are always logged by the Command and Telemetry Server
+    but are not put in the Script Runner log without this keyword.
+PAUSE_ON_RED:
+  summary: Pause a running script if a red limit occurs

data/data/config/system.yaml

@@ -0,0 +1,153 @@
+---
+AUTO_DECLARE_TARGETS:
+  summary: Automatically load all the target folders under config/targets into the system
+  description: When automatically discovering target folders the COSMOS naming convention
+    must be followed. Target folders must be uppercase and be named according to how
+    COSMOS will access them. For example, if you create a config/targets/INST directory,
+    COSMOS will create a target named 'INST' which is how it will be referenced.
+    This keyword is REQUIRED unless you individually declare your targets using the
+    DECLARE_TARGET keyword.
+DECLARE_TARGET:
+  summary: Declare a COSMOS target and name it
+  description: Declare target is used in place of AUTO_DECLARE_TARGETS to give more
+    fine grained control over how the target folder is loaded and named within COSMOS.
+    This is required if AUTO_DECLARE_TARGET is not present.
+  parameters:
+    - name: Target Name
+      required: true
+      description: The directory name which contains the target information.
+        This must match a directory under config/targets.
+      values: <%= System.targets.keys %>
+    - name: Substitute Target Name
+      required: false
+      description: The target name in the COSMOS system. This is how the target
+        will be referred to in scripts. If this is not given (or given as nil)
+        the target name will be the directory name given above.
+    - name: Target Filename
+      required: false
+      description: The name of the file in the target directory which contains the
+        configuration information for the target. By default this is 'target.txt'
+        but if you want to rename this you need to set this parameter.
+PORT:
+  summary: Set a Server Port
+  description: Port is used to set the default ports used by the Command and Telemetry Server.
+    It is not necessary to set this option unless you wish to override the defaults
+    (given in the example usage). Overriding ports is necessary if you want to run
+    two Command and Telemetry Servers on the same computer simultaneously.
+  parameters:
+    - name: Port Name
+      required: true
+      description: CTS_API - This port is what tools connect to to communicate with the COSMOS Scripting API.
+        TLMVIEWER_API - This port is used to remotely open and close telemetry screens in Telemetry Viewer.
+        CTS_PREIDENTIFIED - This port provides access to a preidentified stream of all telemetry packets
+        in the system. This is currently used by Telemetry Grapher and can be used to chain Command
+        and Telemetry Servers together.
+      values: <%= %w(CTS_API TLMVIEWER_API CTS_PREIDENTIFIED) %>
+    - name: Port Value
+      required: true
+      description: Port number to use for the specified port name
+      values: '\d{2,}'
+PATH:
+  summary: Set a Server Path
+  description: Path is used to set the default paths used by the Command and Telemetry Server
+    to access or create files. It is not necessary to set this option unless you wish to
+    override the defaults (given in the example usage).
+  warning: The PROCEDURES path must be set for Script Runner and Test Runner to locate your
+    procedure files. You can add multiple 'PATH PROCEDURES' lines to your configuration file
+    to set multiple locations.
+  parameters:
+    - name: Path Name
+      required: true
+      description: Path name to set.
+      values: <%= %w(LOGS TMP SAVED_CONFIG TABLES PROCEDURES HANDBOOK) %>
+    - name: Path Value
+      required: true
+      description: File system path to use for the specified path name
+      values: .+
+DEFAULT_PACKET_LOG_WRITER:
+  summary: Set the class used when creating binary packet log files
+  warning: Overriding the default log writer can break the ability to write log
+    files that COSMOS can interpret. Proceed with caution!
+  parameters:
+    - name: Filename
+      required: true
+      description: Ruby file to use when instantiating a new log writer
+      values: '.+\.rb'
+    - name: parameter
+      required: false
+      description: Parameters which are passed to the log read upon initialization
+      values: .*
+      since: 4.0.0
+DEFAULT_PACKET_LOG_READER:
+  summary: Set the class used when reading binary packet log file
+  warning: Overriding the default log read can break the ability to read log
+    files. Proceed with caution!
+  parameters:
+    - name: Filename
+      required: true
+      description: Ruby file to use when instantiating a new log writer
+      values: '.+\.rb'
+    - name: parameter
+      required: false
+      description: Parameters which are passed to the log read upon initialization
+      values: .*
+      since: 4.0.0
+STALENESS_SECONDS:
+  summary: Number of seconds before marking the packet stale
+  description: A stale packet is identified in telemetry screens by all the telemetry
+    items in the stale packet being colored purple..
+  parameters:
+    - name: Seconds
+      required: true
+      description: Integer number of seconds before packets are marked stale
+      values: '\d+'
+ENABLE_DNS:
+  summary: Enable reverse DNS lookups for tools
+  description: Enables reverse DNS lookups when tools connect to the Command and
+    Telemetry Server's pre-identified socket or to any target using the TCPIP Server
+    Interface. As of COSMOS 3.5.0 the default is to not use DNS.
+  since: 3.5.0
+DISABLE_DNS:
+  summary: Disable reverse DNS lookups for tools
+  description: Disable reverse DNS lookups when tools connect to the Command and
+    Telemetry Server's pre-identified socket or to any target using the TCPIP Server
+    Interface. This is useful when you are in an environment where DNS is not available.
+    As of COSMOS 3.5.0 the default is to not use DNS
+ENABLE_SOUND:
+  summary: Enable audible sounds when popups occur
+  description: Enable sound makes any prompts that occur in ScriptRunner/TestRunner
+    make an audible sound when they popup to alert the operator of needed input.
+  since: 3.5.0
+ALLOW_ACCESS:
+  summary: White list machines that are allowed to connect to the Server
+  parameters:
+    - name: Name or IP Address
+      required: true
+      description: Machine name to allow access or you can specify 'ALL' to allow
+        all machines access
+      values: .+
+TIME_ZONE_UTC:
+  summary: Report all times as UTC
+  description: COSMOS will report all times as UTC time. If this keyword is not used,
+    COSMOS will report all times as local times, where the local time zone is determined
+    automatically by Ruby based upon the operating system time settings. This setting
+    affects packet receive times, timestamped log filenames, message logs,
+    Cmd/Tlm extractor time ranges, etc.
+  since: 3.10.0
+ADD_MD5_FILE:
+  summary: Add a file to the MD5 sum calculation
+  description: Adds a file to the set of files used in marshal file MD5 sum calculation.
+    Upon startup, COSMOS calculates an MD5 sum over the command/telemetry definition files
+    for all targets. After the definitions have been processed, COSMOS saves the resulting
+    objects as marshal files in a folder with the MD5 sum as part of the name.
+    The next time COSMOS runs, if the MD5 checksum of the cmd/tlm definition files
+    has not changed, COSMOS can load the marshal files instead of re-processing the definitions.
+    If a file is specified with the ADD_MD5_FILE keyword, COSMOS will include it in the
+    MD5 sum calculation. This means that a change in the file will cause COSMOS to
+    re-process the cmd/tlm defintions and create a new set of marshal files.
+  since: 4.0.0
+  parameters:
+    - name: Filename
+      required: true
+      description: Filename, either fully qualified, or relative to Cosmos::USERPATH
+      values: '.+\.rb'

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,71 @@
+---
+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.
+  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.
+  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.
+  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.
+  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.
+  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.