cosmos 3.9.2 → 4.0.0

data/data/config/command.yaml

@@ -0,0 +1,38 @@
+---
+COMMAND:
+  modifiers:
+    <%= MetaConfigParser.load('command_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a new command packet
+  parameters:
+    - name: Target
+      required: true
+      description: Name of the target this command is associated with
+      values: <%= System.targets.keys %>
+    - name: Command
+      required: true
+      description: Name of this command. Also referred to as its mnemonic.
+        Must be unique to commands to 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 command is to be sent in Big Endian or Little Endian format
+      values: ['BIG_ENDIAN', 'LITTLE_ENDIAN']
+    - name: Description
+      required: false
+      description: Description of this command which must be enclosed with quotes
+      values: "['\"].*['\"]"
+SELECT_COMMAND:
+  modifiers:
+    <%= MetaConfigParser.load('command_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Selects an existing command packet for editing
+  description: Typically used in a separate configuration file from where the original
+    command is defined to override or add to the existing command definition
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the target this command is associated with
+      values: <%= System.targets.keys %>
+    - name: Command Name
+      required: true
+      description: Name of the command to select
+      values: .*

data/data/config/command_modifiers.yaml

@@ -0,0 +1,127 @@
+---
+PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a command parameter in the current command packet
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: '\D\S*'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the command packet of the Most Significant Bit of this parameter.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived parameters.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(4) %>
+APPEND_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a command parameter in the current command packet
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .+
+    <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(4) %>
+ID_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines an identification command parameter in the current command packet
+  description: ID parameters are used to identify the binary block of data as a
+    particular command. A command packet may have one or more ID_PARAMETERs and all
+    must match the binary data for the command to be identified.
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .+
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the command packet of the Most Significant Bit of this parameter.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived parameters.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_id_params.yaml').to_meta_config_yaml(4) %>
+APPEND_ID_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines an identification command parameter in the current command packet
+  description: ID parameters are used to identify the binary block of data as a
+    particular command. A command packet may have one or more ID_PARAMETERs and all
+    must match the binary data for the command to be identified.
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: .+
+    <%= MetaConfigParser.load('_id_params.yaml').to_meta_config_yaml(4) %>
+ARRAY_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a command parameter in the current command packet that is an array
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: \'
+    - name: Bit Offset
+      required: true
+      description: Bit offset into the command packet of the Most Significant Bit of this parameter.
+        May be negative to indicate on offset from the end of the packet.
+        Always use a bit offset of 0 for derived parameters.
+      values: '[-]?\d+'
+    <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+APPEND_ARRAY_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Defines a command parameter in the current command packet that is an array
+  parameters:
+    - name: Name
+      required: true
+      description: Name of the parameter. Must be unique within the command.
+      values: '\D\S*'
+    <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+SELECT_PARAMETER:
+  modifiers:
+    <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Selects an existing command parameter for editing
+  parameters:
+    - name: Parameter
+      required: true
+      description: Name of the parameter to select for modification
+      values: .+
+HIDDEN:
+  summary: Hides this command from all COSMOS tools such as Command Sender and Handbook Creator
+  description: Hidden commands do not appear in the Script Runner popup helper when writing scripts.
+    The command still exists in the system and can be sent by scripts.
+DISABLED:
+  summary: Disables this command from being sent
+  description: Hides the command and also disables it from being sent by scripts.
+    Attempts to send DISABLED commands result in an error message.
+DISABLE_MESSAGES:
+  summary: Disable the Server from printing cmd(...) messages. Commands are still logged.
+META:
+  summary: Stores metadata for the current command
+  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.
+  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: .*
+HAZARDOUS:
+  summary: Designates the current command as hazardous
+  description: Sending a hazardous command causes a dialog asking for confirmation
+    before sending the command
+  parameters:
+    - name: Description
+      required: false
+      description: Description for why the command is hazardous which must be enclosed with quotes
+      values: "['\"].*['\"]"

data/data/config/command_telemetry.yaml

@@ -0,0 +1,3 @@
+---
+<%= MetaConfigParser.load('command.yaml').to_meta_config_yaml(0) %>
+<%= MetaConfigParser.load('telemetry.yaml').to_meta_config_yaml(0) %>

data/data/config/data_viewer.yaml

@@ -0,0 +1,43 @@
+---
+AUTO_START:
+  summary: Automatically start Data Viewer and connect to the Server
+AUTO_TARGET_COMPONENTS:
+  summary: Automatically load all data_viewer.txt configuration files in each target
+TARGET_COMPONENT:
+  summary: Load a Data Viewer configuration file in the specified target
+  parameters:
+    - name: Target
+      required: true
+      description: Name of the target
+      values: <%= System.targets.keys %>
+    - name: Filename
+      required: false
+      description: The Data Viewer configuration file name. Defaults to data_viewer.txt.
+      values: '(.+\.txt)?'
+COMPONENT:
+  summary: Declare a Data Viewer component
+  parameters:
+    - name: Tab Name
+      required: true
+      description: Name of the component which shows up in the GUI tab
+      values: .+
+    - name: Filename
+      required: true
+      description: Name of the Ruby file which contains the component class
+      values: '.+\.rb'
+    - name: Options
+      required: false
+      description: Optional parameters that are sent to the component constructor
+      values: .*
+  modifiers:
+    PACKET:
+      summary: Declare a packet to process by the component
+      parameters:
+        - name: Target
+          required: true
+          description: Name of the target
+          values: <%= System.targets.keys %>
+        - name: Packet
+          required: true
+          description: Name of the packet
+          values: .+

data/data/config/handbook_creator.yaml

@@ -0,0 +1,23 @@
+---
+PAGE:
+  modifiers:
+    <%= MetaConfigParser.load('page_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Create a new top level webpage
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the HTML file
+      values: '.*\.html'
+TARGET_PAGES:
+  modifiers:
+    <%= MetaConfigParser.load('page_modifiers.yaml').to_meta_config_yaml(4) %>
+  summary: Create a new webpage for each of the defined TARGETS
+  description: The page will be generated for each target. A top level "Targets"
+    drop down will be created with links to all the generated target pages.
+  parameters:
+    - name: Filename Postfix
+      required: true
+      description: The postfix will be applied to each generated target file.
+        For example, a target named INST with a postfix of '_cmd_tlm.html' will
+        result in a file named 'inst_cmd_tlm.html'.
+      values: '.*\.html'

data/data/config/housekeeping_params.yaml

@@ -0,0 +1,71 @@
+---
+# Require housekeeping_data_object for the ANALYSIS_TYPES
+<% require 'cosmos/tools/tlm_grapher/data_objects/housekeeping_data_object.rb' %>
+ITEM:
+  summary: Graph the specified item
+  parameters:
+    - name: Target Name
+      description: The target name
+      required: true
+      values: <%= System.targets.keys %>
+    - name: Packet Name
+      description: The packet name
+      required: true
+      values: .+
+    - name: Item Name
+      description: The item name
+      required: true
+      values: .+
+ITEM_ARRAY_INDEX:
+  summary: If the ITEM is an ARRAY, this keyword specifies which array item to graph
+  parameters:
+    - name: Index
+      required: true
+      description: 0 based array Index
+      values: \d+
+TIME_ITEM:
+  summary: Specify the item in the packet representing the time value
+  parameters:
+    - name: Time Item Name
+      description: The time item is typically RECEIVED_TIMESECONDS
+      required: true
+      values: .+
+FORMATTED_TIME_ITEM:
+  summary: Specify the item in the packet representing the formatted time value
+  parameters:
+    - name: Time Item Name
+      description: The time item is typically RECEIVED_TIMEFORMATTED
+      required: true
+      values: .+
+VALUE_TYPE:
+  summary: How the value should be displayed
+  parameters:
+    - name: Item Value Type
+      description: Should the value be used raw or converted
+      required: true
+      values: ['RAW','CONVERTED']
+ANALYSIS:
+  summary: Apply an analysis to the given value
+  parameters:
+    - name: Analysis Type
+      description: The type of analysis to perform on the value before graphing
+      required: true
+      values: <%= HousekeepingDataObject::ANALYSIS_TYPES.collect {|type| type.to_s } %>
+ANALYSIS_SAMPLES:
+  summary: The number of samples to use when performing analysis. Only valid with the
+    ANALYSIS keyword.
+  parameters:
+    - name: Samples
+      description: Number of samples
+      required: true
+      values: \d+
+SHOW_LIMITS_LINES:
+  summary: Whether to show the limits line on the graph
+  description: The limits lines are horizontal lines which intercept the Y value at the
+    defined limits values. The red, yellow, and green limits are drawn with lines with the
+    respective colors.
+  parameters:
+    - name: Display
+      description: Whether to display the limits lines
+      required: true
+      values: ['TRUE','FALSE']

data/data/config/interface_modifiers.yaml

@@ -0,0 +1,44 @@
+---
+TARGET:
+  summary: Maps a target name to an interface
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target name to map to this interface
+      values: <%= System.targets.keys %>
+DONT_CONNECT:
+  summary: Server will not automatically try to connect to the interface at startup
+DONT_RECONNECT:
+  summary: Server will not try to reconnect to the interface if the connection is lost
+RECONNECT_DELAY:
+  summary: Reconnect delay in seconds
+  description: If DONT_RECONNECT is not present the Server will try to reconnect to an
+    interface if the connection is lost. Reconnect delay sets the interval in seconds
+    between reconnect tries.
+  parameters:
+    - name: Delay
+      required: true
+      description: Delay in seconds between reconnect attempts. The default is 15 seconds.
+      values: ([0-9]*[.])?[0-9]+
+DISABLE_DISCONNECT:
+  summary: Disable the Disconnect button on the Interfaces tab in the Server
+  description: Use this keyword to prevent the user from disconnecting from the interface.
+    This is typically used in a 'production' environment where you would not want
+    the user to inadvertantly disconnect from a target.
+LOG:
+  summary: Enable logging on the interface by the specified log writer
+  description: LOG is only required if you want a log writer other than the default
+    to log commands and telemetry on this interface
+  warning: Choosing a custom log writer can prevent COSMOS from reading back your log files
+  parameters:
+    - name: Name
+      required: true
+      description: Log writer name as defined by PACKET_LOG_WRITER
+      values: \D\S*
+DONT_LOG:
+  summary: Disable logging commands and telemetry on this interface
+LOG_RAW:
+  summary: Log all data on the interface exactly as it is sent and received
+  description: LOG_RAW does not add any COSMOS headers and thus can not be read by COSMOS tools.
+    It is primarily useful for low level debugging of an interface. You will have to
+    manually parse these logs yourself using a hex editor or other application.

data/data/config/item_modifiers.yaml

@@ -0,0 +1,172 @@
+---
+<%= MetaConfigParser.load('param_item_modifiers.yaml').to_meta_config_yaml(0) %>
+STATE:
+  summary: Defines a key/value pair for the current item
+  description: Key value pairs allow for user friendly strings. For example,
+    you might define states for ON = 1 and OFF = 0. This allows the word ON to be
+    used rather than the number 1 when sending the telemetry item and allows
+    for much greater clarity and less chance for user error.
+  parameters:
+    - name: Key
+      required: true
+      description: The string state name
+      values: .*
+    - name: Value
+      required: true
+      description: The numerical state value
+      values: .*
+    - name: Color
+      required: false
+      description: The color the state should be displayed as
+      values: ['GREEN', 'YELLOW', 'RED']
+READ_CONVERSION:
+  summary: Applies a conversion to the current telemetry item
+  description: Conversions are implemented in a custom Ruby file which should be
+    located in the target's lib folder and required by the target's target.txt
+    file (see REQUIRE). The class must require 'cosmos/conversions/conversion'
+    and inherit from Conversion. It must implement the initialize method if it
+    takes extra parameters and must always implement the call method. The conversion
+    factor is applied to the raw value in the telemetry packet before it is displayed
+    to the user. The user still has the ability to see the raw unconverted value
+    in a details dialog.
+  parameters:
+    - name: Class File Name
+      required: true
+      description: The file name which contains the Ruby class. The file name must
+        be named after the class such that the class is a CamelCase version of the
+        underscored file name. For example, 'the_great_conversion.rb' should contain
+        'class TheGreatConversion'.
+      values: .*\.rb
+    - name: Parameter
+      required: false
+      description: Additional parameter values for the conversion which are passed
+        to the class constructor.
+      values: .*
+POLY_READ_CONVERSION:
+  summary: Adds a polynomial conversion factor to the current telemetry item
+  description: The conversion factor is applied to raw value in the telemetry
+    packet before it is displayed to the user. The user still has the ability
+    to see the raw unconverted value in a details dialog.
+  parameters:
+    - name: C0
+      required: true
+      description: Coefficient
+      values: .*
+    - name: Cx
+      required: false
+      description: Additional coefficient values for the conversion. Any order
+        polynomial conversion may be used so the value of 'x' will vary with the
+        order of the polynomial. Note that larger order polynomials take longer
+        to process than shorter order polynomials, but are sometimes more accurate.
+      values: .*
+SEG_POLY_READ_CONVERSION:
+  summary: Adds a segmented polynomial conversion factor to the current telemetry item
+  description: This conversion factor is applied to the raw value in the telemetry packet
+    before it is displayed to the user. The user still has the ability to see the raw
+    unconverted value in a details dialog.
+  parameters:
+    - name: Lower Bound
+      required: true
+      description: Defines the lower bound of the range of values that this segmented
+        polynomial applies to. Is ignored for the segment with the smallest lower bound.
+      values: .*
+    - name: C0
+      required: true
+      description: Coefficient
+      values: .*
+    - name: Cx
+      required: false
+      description: Additional coefficient values for the conversion. Any order
+        polynomial conversion may be used so the value of 'x' will vary with the
+        order of the polynomial. Note that larger order polynomials take longer
+        to process than shorter order polynomials, but are sometimes more accurate.
+      values: .*
+GENERIC_READ_CONVERSION_START:
+  summary: Start a generic write conversion
+  description: Adds a generic conversion function to the current telemetry item.
+    This conversion factor is applied to the raw value in the telemetry packet
+    before it is displayed to the user. The user still has the ability to see the
+    raw unconverted value in a details dialog. The conversion is specified as
+    ruby code that receives two implied parameters. 'value' which is the raw
+    value being written and 'packet' which is a reference to the telemetry packet
+    class (Note, referencing the packet as 'myself' is still supported for backwards
+    compatibility). The last line of ruby code given should return the converted
+    value. The GENERIC_READ_CONVERSION_END keyword specifies that all lines of
+    ruby code for the conversion have been given.
+  warning: Generic conversions are not a good long term solution. Consider creating
+    a conversion class and using READ_CONVERSION instead. READ_CONVERSION is easier
+    to debug and higher performance.
+GENERIC_READ_CONVERSION_END:
+  summary: Complete a generic write conversion
+LIMITS:
+  summary: Defines a set of limits for a telemetry item
+  description: If limits are violated a message is printed in the Command and Telemetry Server
+    to indicate an item went out of limits. Other tools also use this information
+    to update displays with different colored telemetry items or other useful information.
+    The concept of "limits sets" is defined to allow for different limits values
+    in different environments. For example, you might want tighter or looser limits
+    on telemetry if your environment changes such as during thermal vacuum testing.
+  parameters:
+    - name: Limits Set
+      required: true
+      description: Name of the limits set. If you have no unique limits sets use
+        the keyword DEFAULT.
+      values: .+
+    - name: Persistence
+      required: true
+      description: Number of consecutive times the telemetry item must be within
+        a different limits range before changing limits state.
+      values: \d+
+    - name: Initial State
+      required: true
+      description: Whether limits monitoring for this telemetry item is initially enabled or disabled
+      values: ['ENABLED', 'DISABLED']
+    - name: Red Low Limit
+      required: true
+      description: If the telemetry value is less than or equal to this value a
+        Red Low condition will be detected
+      values: .+
+    - name: Yellow Low Limit
+      required: true
+      description: If the telemetry value is less than or equal to this value,
+        but greater than the Red Low Limit, a Yellow Low condition will be detected
+      values: .+
+    - name: Yellow High Limit
+      required: true
+      description: If the telemetry value is greater than or equal to this value,
+        but less than the Red High Limit, a Yellow High condition will be detected
+      values: .+
+    - name: Red High Limit
+      required: true
+      description: If the telemetry value is greater than or equal to this value
+        a Red High condition will be detected
+      values: .+
+    - name: Green Low Limit
+      required: false
+      description: Setting the Green Low and Green High limits defines an
+        "operational limit" which is colored blue by COSMOS. This allows for a
+        distinct desired operational range which is narrower than the green safety limit.
+        If the telemetry value is greater than or equal to this value, but less
+        than the Green High Limit, a Blue operational condition will be detected.
+      values: .+
+    - name: Green High Limit
+      required: false
+      description: Setting the Green Low and Green High limits defines an
+        "operational limit" which is colored blue by COSMOS. This allows for a
+        distinct desired operational range which is narrower than the green safety limit.
+        If the telemetry value is less than or equal to this value, but greater
+        than the Green Low Limit, a Blue operational condition will be detected.
+      values: .+
+LIMITS_RESPONSE:
+  summary: Defines a response class that is called when the limits state of the current item changes
+  parameters:
+    - name: Response Class Filename
+      required: true
+      description: Name of the Ruby file which implements the limits response.
+        This file should be in the config/TARGET/lib directory so it can be found by COSMOS.
+      values: .+
+    - name: Response Specific Options
+      required: false
+      description: Variable length number of options that will be passed to the
+        class constructor
+      values: .+