cosmos 4.0.3-java

data/data/config/protocols.yaml

@@ -0,0 +1,273 @@
+---
+BURST:
+  description: The Burst Stream Protocol simply reads as much data as it can from
+    the stream before returning the data as a COSMOS Packet. This Protocol relies
+    on regular bursts of data delimited by time and thus is not very robust.
+    However it can utilize a sync pattern which does allow it to re-sync from the
+    stream if necessary.
+  parameters:
+    - name: Discard Leading Bytes
+      required: false
+      description: The number of bytes to discard from the binary data after reading
+        from the stream. Note that this applies to bytes starting with the sync
+        pattern if the sync pattern is being used. Default is 0 (don't discard bytes).
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned. Default is 'nil'
+        (no sync pattern).
+      values: .+
+    - name: Fill Sync Pattern
+      required: false
+      description: Whether or not to fill in the sync pattern on outgoing packets
+        Default is false.
+      values: ['true', 'false']
+FIXED:
+  description: The Fixed Stream Protocol reads a preset minimum amount of data
+    from the stream which is necessary to properly identify all the defined packets
+    using the interface. It then identifies the packet and proceeds to read as much
+    data from the stream as necessary to create the packet which it then returns.
+    This stream relies on all the packets on the interface being fixed in length.
+    For example, all the packets using the interface are a fixed size and contain
+    a simple header with a 32 bit sync pattern followed by a 16 bit ID. The Fixed
+    Stream Protocol would elegantly handle this case with a minimum read size of
+    6 bytes.
+  parameters:
+    - name: Minimum ID Size
+      required: true
+      description: The minimum amount of bytes needed to identify a packet.
+        All the packet definitions must declare their ID_ITEM(s) within this given
+        amount of bytes.
+      values: \d+
+    - name: Discard Leading Bytes
+      required: false
+      description: The number of bytes to discard from the binary data after reading
+        from the stream. Note that this applies to bytes starting with the sync
+        pattern if the sync pattern is being used. Default is 0 (do not discard bytes).
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned. Default is 'nil'
+        (no sync pattern).
+      values: .+
+    - name: Telemetry Stream
+      required: false
+      description: Whether the stream is returning telemetry. Default is true.
+      values: ['true','false']
+    - name: Fill Sync Pattern
+      required: false
+      description: Whether or not to fill in the sync pattern on outgoing packets.
+        Default is false.
+      values: ['false','true']
+LENGTH:
+  description: The Length Stream Protocol depends on a length field at a fixed
+    location in the defined packets using the interface. It then reads enough data
+    to grab the length field, decodes it, and reads the remaining length of the
+    packet. For example, all the packets using the interface contain a CCSDS
+    header with a length field. The Length Stream Protocol can be set up to handle
+    the length field and even the "length - 1" offset the CCSDS header uses.
+  parameters:
+    - name: Length Bit Offset
+      required: false
+      description: The bit offset of the length field. Every packet using this
+        interface must have the same structure such that the length field is the
+        same size at the same location. Be sure to account for the length of the
+        Sync Pattern in this value (if present). Default is 0.
+      values: \d+
+    - name: Length Bit Size
+      required: false
+      description: The size in bits of the length field. Default is 16.
+      values: \d+
+    - name: Length Value Offset
+      required: false
+      description: The offset to apply to the length field value. For example if
+        the length field indicates packet length minus one, this value should be
+        one. Be sure to account for the length of the Sync Pattern in this value
+        (if present). Default is 0.
+      values: \d+
+    - name: Bytes per Count
+      required: false
+      description: The number of bytes per each length field 'count'. This is used
+        if the units of the length field is something other than bytes,
+        for example if the length field count is in words. Default is 1.
+      values: \d+
+    - name: Length Endianness
+      required: false
+      description: The endianness of the length field.
+      values: ['BIG_ENDIAN','LITTLE_ENDIAN']
+    - name: Discard Leading Bytes
+      required: false
+      description: The number of bytes to discard from the binary data after
+        reading from the stream. Note that this applies to bytes including the
+        sync pattern if the sync pattern is being used. Discarding is one of the
+        very last steps so any size and offsets above need to account for all the
+        data before discarding. Default is 0 (do not discard bytes).
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned.
+        Default is nil (no sync pattern)
+      values: .+
+    - name: Max Length
+      required: false
+      description: The maximum allowed value in the length field.
+        Default is nil (no maximum length)
+      values: .+
+    - name: Fill Length and Sync Pattern
+      required: false
+      description: Setting this flag to true causes the length field and sync
+        pattern (if present) to be filled automatically on outgoing packets.
+        Default is false
+      values: ['false','true']
+TERMINATED:
+  description: The Terminated Stream Protocol delineates packets using termination
+    characters found at the end of every packet. It continuously reads data from
+    the stream until the termination characters are found at which point it returns
+    the packet data. For example, all the packets using the interface are followed
+    by 0xABCD. This data can either be a part of each packet that is kept or
+    something which is known only by the Terminated Stream Protocol and simply
+    thrown away.
+  parameters:
+    - name: Write Termination Characters
+      required: true
+      description: The data to write to the stream after writing a command packet.
+        Given as a hex string such as 0xABCD.
+      values: .+
+    - name: Read Termination Characters
+      required: true
+      description: The characters at the end of the stream which delineate the end
+        of a telemetry packet. Given as a hex string such as 0xABCD.
+      values: .+
+    - name: Strip Read Termination
+      required: false
+      description: Whether to remove the read termination characters from the
+        stream before returning the telemetry packet. Default is true.
+      values: ['true','false']
+    - name: Discard Leading Bytes
+      required: false
+      description: The number of bytes to discard from the binary data after
+        reading from the stream. Note that this applies to bytes including the
+        sync pattern if the sync pattern is being used.
+        Default is 0 (do not discard bytes)
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned.
+        Default is nil (no sync pattern)
+      values: .+
+    - name: Fill Sync Pattern
+      required: false
+      description: Whether or not to fill in the sync pattern on outgoing packets
+        Default is false
+      values: ['false','true']
+PREIDENTIFIED:
+  description: The Preidentified Stream Protocol is used internally by the COSMOS
+    Command and Telemetry Server only and delineates packets using a custom COSMOS
+    header. This stream Protocol is configured by default on port 7779 and is
+    created by the Command and Telemetry Server to allow tools to connect and
+    receive the entire packet stream. The Telemetry Grapher uses this port to
+    receive all the packets following through the Command and Telemetry Server
+    in case any need to be graphed.
+  parameters:
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found AFTER the sync pattern will be returned. The sync pattern itself
+        is discarded. Default is nil (no sync pattern)
+      values: .+
+    - name: Max Length
+      required: false
+      description: The maximum allowed value in the length field.
+        Default is nil (no maximum length)
+      values: .+
+TEMPLATE:
+  description: The Template Stream Protocol works much like the Terminated Stream
+    Protocol except it designed for text-based command and response type interfaces
+    such as SCPI (Standard Commands for Programmable Instruments). It delineates
+    packets in the same way as the terminated stream protocol except each packet
+    is referred to as a line (because each usually contains a line of text).
+    For outgoing packets a CMD_TEMPLATE field is expected to exist in the packet.
+    This field contains a template string with items to be filled in deliniated
+    within HTML tag style brackets “". The Template Stream Protocol will read the
+    named items from within the packet fill in the CMD_TEMPLATE. This filled in
+    string is then sent out rather than the originally passed in packet.
+    Correspondingly, if a response is expected the outgoing packet should include
+    a RSP_TEMPLATE and RSP_PACKET field. The RSP_TEMPLATE is used to extract data
+    from the response string and build a corresponding RSP_PACKET. See the TEMPLATE
+    target within the COSMOS Demo configuration for an example of usage.
+  parameters:
+    - name: Write Termination Characters
+      required: true
+      description: The data to write to the stream after writing a command packet.
+        Given as a hex string such as 0xABCD.
+      values: .+
+    - name: Read Termination Characters
+      required: true
+      description: The characters at the end of the stream which delineate the end
+        of a telemetry packet. Given as a hex string such as 0xABCD.
+      values: .+
+    - name: Ignore Lines
+      required: false
+      description: Number of response lines to ignore (completely drop).
+        Default is 0.
+      values: \d+
+    - name: Initial Read Delay
+      required: false
+      description: An initial delay after connecting after which the stream will
+        be read till empty and data dropped. Useful for discarding connect headers
+        and initial prompts. Default is nil (no initial read).
+      values: .+
+    - name: Response Lines
+      required: false
+      description: The number of lines that make up expected responses.
+        Default is 1.
+      values: \d+
+    - name: Strip Read Termination
+      required: false
+      description: Whether to remove the read termination characters from the
+        stream before returning the telemetry packet. Default is true.
+      values: ['true','false']
+    - name: Discard Leading Bytes
+      required: false
+      description: The number of bytes to discard from the binary data after
+        reading from the stream. Note that this applies to bytes including the
+        sync pattern if the sync pattern is being used.
+        Default is 0 (do not discard bytes).
+      values: \d+
+    - name: Sync Pattern
+      required: false
+      description: Hex string representing a byte pattern that will be searched
+        for in the raw stream. This pattern represents a packet delimiter and all
+        data found including the sync pattern will be returned.
+        Default is nil (no sync pattern).
+      values: .+
+    - name: Fill Sync Pattern
+      required: false
+      description: Whether or not to fill in the sync pattern on outgoing packets.
+        Default is false.
+      values: ['false','true']
+    - name: Response Timeout
+      required: false
+      description: Number of seconds to wait before timing out when waiting for a response.
+        Default is 5 seconds.
+      values: .+
+    - name: Response Polling Period
+      required: false
+      description: Number of seconds to wait between polling for a response.
+        Default is 0.02 seconds.
+      values: .+
+    - name: Error Action
+      required: false
+      description: How to handle errors in the protocol like unexpected responses
+        or response timeouts. 'DISCONNECT' to disconnect after errors. The default
+        is 'LOG' to log an error and continue.
+      values: ['LOG','DISCONNECT']

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,247 @@
+---
+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.
+  example: DECLARE_TARGET INST INST2 inst.txt
+  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.
+DECLARE_GEM_TARGET:
+  summary: Declare a COSMOS target which resides in a Ruby gem
+  description: COSMOS targets can be distributed in gem form in which case they
+    must be named 'cosmos-<gem-name>' where <gem-name> is the descriptive name of
+    the gem. See the COSMOS documentation at cosmosrb.com for for information on
+    creating a COSMOS gem target.
+  parameters:
+    - name: Gem Name
+      required: true
+      description: The COSMOS gem name which must be cosmos-<gem-name> where <gem-name>
+        is the descriptive gem name. In the above example, the target will be named
+        'GEM-NAME' (note the cosmos- prefix is stripped off).
+      values: .+
+    - 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 gem name as described 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.
+  example: |
+    PORT CTS_API 7777 # Default
+    PORT TLMVIEWER_API 7778 # Default
+    PORT CTS_PREIDENTIFIED 7779 # Default
+  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 as it also accepts commands.
+        CTS_CMD_ROUTER - This port provides access to a stream of all command packets
+        that have been accepted by COSMOS.
+      values: <%= %w(CTS_API TLMVIEWER_API CTS_PREIDENTIFIED CTS_CMD_ROUTER) %>
+    - name: Port Value
+      required: true
+      description: Port number to use for the specified port name
+      values: '\d{2,}'
+LISTEN_HOST:
+  summary: IP addresses or host names to bind API ports to
+  since: 4.0.0
+  parameters:
+    - name: Host 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 as it also accepts commands.
+        CTS_CMD_ROUTER - This port provides access to a stream of all command packets
+        that have been accepted by COSMOS.
+      values: <%= %w(CTS_API TLMVIEWER_API CTS_PREIDENTIFIED CTS_CMD_ROUTER) %>
+    - name: Host Value
+      required: true
+      description: The IP address or host name to bind the Host Port Name to. By default,
+        the CTS_API and TLMVIEWER_API are bound to localhost meaning that only tools
+        on the same machine can connect. By default, CTS_PREIDENTIFIED and CTS_CMD_ROUTER
+        are bound to '0.0.0.0' to allow for tools on any machines to connect. This
+        allows for chaining two or more Servers out of the box.
+      values: .+
+CONNECT_HOST:
+  summary: IP addresses or host names to connect tools to
+  since: 4.0.0
+  parameters:
+    - name: Host 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 as it also accepts commands.
+        CTS_CMD_ROUTER - This port provides access to a stream of all command packets
+        that have been accepted by COSMOS.
+      values: <%= %w(CTS_API TLMVIEWER_API CTS_PREIDENTIFIED CTS_CMD_ROUTER) %>
+    - name: Host Value
+      required: true
+      description: The IP address or host name to connect tools to. By default all
+        ports are bound to localhost so all tools connect to the local machine.
+      values: .+
+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.
+  example: |
+    PATH LOGS './logs' # Default location of system and tool log files
+    PATH TMP './tmp' # Default location of temporary marshal files
+    PATH SAVED_CONFIG './saved_config' # Default location of saved configurations (see note)
+    PATH TABLES './tables' # Default location of table files
+    PATH PROCEDURES './procedures' # Default location of Script procedure files
+    PATH HANDBOOKS './handbooks' # Default location to place handbook files
+  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!
+  example: DEFAULT_PACKET_LOG_WRITER packet_log_writer.rb # Default
+  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!
+  example: DEFAULT_PACKET_LOG_READER packet_log_reader.rb # Default
+  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..
+  example: STALENESS_SECONDS 30 # Default
+  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
+  example: ALLOW_ACCESS ALL # Default
+  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: .+
+META_INIT:
+  summary: Specify a file to initialize the SYSTEM META packet
+  description: Filename should be a text file with key value pairs where the keyword
+    matches an item in the SYSTEM META packet. Note you do not have to specify ALL
+    the items in the SYSTEM META packet.
+  since: 4.0.0
+  parameters:
+    - name: Filename
+      required: true
+      description: Filename, either fully qualified, or relative to Cosmos::USERPATH
+      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
+  example: ADD_MD5_FILE lib/user_version.rb
+  parameters:
+    - name: Filename
+      required: true
+      description: Filename, either fully qualified, or relative to Cosmos::USERPATH
+      values: '.+\.rb'