cosmos 3.9.2 → 4.0.0

data/data/config/launcher.yaml

@@ -0,0 +1,117 @@
+---
+TITLE:
+  summary: Sets the title of the COSMOS Launcher
+  parameters:
+    - name: Title
+      required: true
+      description: Launcher title. Default is "COSMOS Launcher".
+      values: .+
+TOOL_FONT:
+  summary: Sets the font used for tool buttons
+  warning: Only set the TOOL_FONT once as the last encountered setting will apply
+    to all button labels
+  parameters:
+    - name: Font Family
+      required: true
+      description: The font family to use
+      values: ["Arial", "Calibri", "Cambria", "Candara", "Castellar", "Centaur", "Century", "Chiller", "Consolas", "Constantia", "Courier", "Courier New", "Dotum", "Elephant", "Euphemia", "Fixedsys", "Georgia", "Impact", "Lucida", "Papyrus", "Rockwell", "Rod", "System", "Tahoma", "Terminal", "Times New Roman", "Verdana", "Wide Latin"]
+    - name: Font Size
+      required: true
+      description: The size of the font in standard points
+      values: \d+
+LABEL_FONT:
+  summary: Sets the font used for labels
+  warning: Only set the LABEL_FONT once as the last encountered setting will apply
+    to all text labels
+  parameters:
+    - name: Font Family
+      required: true
+      description: The font family to use
+      values: ["Arial", "Calibri", "Cambria", "Candara", "Castellar", "Centaur", "Century", "Chiller", "Consolas", "Constantia", "Courier", "Courier New", "Dotum", "Elephant", "Euphemia", "Fixedsys", "Georgia", "Impact", "Lucida", "Papyrus", "Rockwell", "Rod", "System", "Tahoma", "Terminal", "Times New Roman", "Verdana", "Wide Latin"]
+    - name: Font Size
+      required: true
+      description: The size of the font in standard points
+      values: \d+
+LABEL:
+  summary: Creates a label of text in the current font style
+  parameters:
+    - name: Text
+      required: true
+      description: The text of the label
+      values: .+
+DIVIDER:
+  summary: Creates a horizontal line between tools
+NUM_COLUMNS:
+  summary: Specifies how many launcher buttons should be created per row
+  parameters:
+    - name: Columns
+      required: true
+      description: The number of launcher buttons per row before Launcher automatically
+        creates a new row of buttons.	Default is 4.
+      values: \d+
+TOOL:
+  summary: Create a new tool launcher button
+  parameters:
+    - name: Button Text
+      required: true
+      description: Label that is put on the button that launches the tool
+      values: .+
+    - name: Shell Command
+      required: true
+      description: Command that is executed to launch the tool. (The same thing you
+        would type at a command terminal). Note that you can include tool parameters
+        here which will be applied when the tool starts.
+      values: .+
+    - name: Icon Filename
+      required: false
+      description: Filename of a an icon located in the data directory. Passing 'nil'
+        or an empty string '' will result in Launcher using the default COSMOS icon.
+      values: .*
+    - name: Tool Parameters
+      required: false
+      description: Tool parameters as you would type on the command line.
+        Specifying parameters here rather than in the 'Shell Command' parameter
+        will cause a dialog box to appear which allows the user to edit parameters
+        if desired. Expected to be in parameter name/parameter value pairs,
+        e.g. --config filename.txt.
+      values: .*
+      warning: The full configuration option name must be used rather than the short
+        name. These parameters will override any parameters specified in the Shell
+        Command.
+  modifiers:
+    DONT_CAPTURE_IO:
+      summary: Don't capture IO when running the command
+MULTITOOL_START:
+  summary: Creates a button which launches multiple tools
+  parameters:
+    - name: Button Text
+      required: true
+      description: Label that is put on the button that launches the tools
+      values: .+
+    - name: Icon Filename
+      required: false
+      description: Filename of a an icon located in the data directory. Passing 'nil'
+        or an empty string '' will result in Launcher using the default COSMOS icon.
+      values: .*
+  modifiers:
+    TOOL:
+      summary: Create a new tool launcher button
+      parameters:
+        - name: Shell Command
+          required: true
+          description: Command that is executed to launch the tool. (The same thing you
+            would type at a command terminal). Note that you can include tool parameters
+            here which will be applied when the tool starts.
+          values: .+
+      modifiers:
+        DONT_CAPTURE_IO:
+          summary: Don't capture IO when running the command
+    DELAY:
+      summary: Inserts a delay between launching multiple tools
+      parameters:
+        - name: Delay
+          required: true
+          description: Delay time in seconds
+          values: \d+
+MULTITOOL_END:
+  summary: Ends the creation of a multi-tool button

data/data/config/limits_monitor.yaml

@@ -0,0 +1,53 @@
+---
+IGNORE_ITEM:
+  summary: Ignore a particular telemetry item
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the telemetry target
+      values: <%= System.targets.keys %>
+    - name: Packet Name
+      required: true
+      description: Name of the telemetry packet
+      values: .+
+    - name: Item Name
+      required: true
+      description: Name of the telemetry item
+      values: .+
+IGNORE_PACKET:
+  summary: Ignore all telemetry items for a specified packet
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the telemetry target
+      values: <%= System.targets.keys %>
+    - name: Packet Name
+      required: true
+      description: Name of the telemetry packet
+      values: .+
+IGNORE_STALE:
+  summary: Ignore the staleness of a specified packet
+  description: Note that only the packet staleness is ignored. If the packet is
+    received and an item is out-of-limits, that will still count against the overall
+    system limits state unless the item or packet is separately ignored with the
+    IGNORE_ITEM or IGNORE_PACKET keyword.
+  since: 4.0.0
+  parameters:
+    - name: Target Name
+      required: true
+      description: Name of the telemetry target
+      values: <%= System.targets.keys %>
+    - name: Packet Name
+      required: true
+      description: Name of the telemetry packet
+      values: .+
+COLOR_BLIND:
+  summary: Use a color-blind accessibility mode
+  description: Color blind mode causes the value for out-of-limits items to have
+    a code appended to indicate the limits status. The code is r = red low,
+    y = yellow low, g = green low, B = blue, G = green or green high,
+    Y = yellow high, R = red high.
+IGNORE_OPERATIONAL_LIMITS:
+  summary: Ignore GREEN_HIGH or GREEN_LOW limits states
+  description: Items with operational limits will only show up in limits monitor
+    if they go yellow or red

data/data/config/linegraph_params.yaml

@@ -0,0 +1,30 @@
+---
+# Require data_object to access the COLOR_LIST
+<% require 'cosmos/tools/tlm_grapher/data_objects/data_object' %>
+HORIZONTAL_LINE:
+  summary: Create a horizontal line on the plot
+  parameters:
+    - name: Y Intercept
+      required: true
+      description: Y Intercept of the horizontal line
+      values: '[0-9]*\.?[0-9]+'
+    - name: Color
+      required: true
+      description: Line color
+      values: <%= DataObject::COLOR_LIST %>
+Y_OFFSET:
+  summary: Offset all graph values by this amount when drawing
+  parameters:
+    - name: Value
+      required: true
+      description: Offset value
+      values: '[0-9]*\.?[0-9]+'
+Y_AXIS:
+  summary: Which axis to associate the graph with
+  description: Graphs can be associated with either the left or right Y axis and
+    the scale will be adjusted accordingly
+  parameters:
+    - name: Axis
+      required: true
+      description: Which axis to associcate the graph with
+      values: ['LEFT', 'RIGHT']

data/data/config/linegraph_plot.yaml

@@ -0,0 +1,106 @@
+---
+TITLE:
+  summary: Set the plot title
+  parameters:
+    - name: Title
+      required: true
+      description: Title text to display at the top of the plot
+      values: .+
+X_AXIS_TITLE:
+  summary: Set the title for the X axis
+  parameters:
+    - name: Title
+      required: true
+      description: Text to display under the X axis
+      values: .+
+Y_AXIS_TITLE:
+  summary: Set the title for the Y axis
+  parameters:
+    - name: Title
+      required: true
+      description: Text to display vertically along the Y axis
+      values: .+
+    - name: Axis
+      required: false
+      description: Which axis to associate the title with
+      values: ['LEFT','RIGHT']
+SHOW_ABS_X_GRID_LABELS:
+  summary: Show absolute X grid labels
+  parameters:
+    - name: Show
+      required: true
+      description: Show absolute X grid labels
+      values: ['TRUE','FALSE']
+SHOW_X_GRID_LINES:
+  summary: Show X grid lines
+  parameters:
+    - name: Show
+      required: true
+      description: Show X grid lines
+      values: ['TRUE','FALSE']
+SHOW_Y_GRID_LINES:
+  summary: Show Y grid lines
+  parameters:
+    - name: Show
+      required: true
+      description: Show Y grid lines
+      values: ['TRUE','FALSE']
+POINT_SIZE:
+  summary: Point size of all graph points
+  parameters:
+    - name: Size
+      required: true
+      description: Point size
+      values: \d+
+SHOW_LINES:
+  summary: Whether to draw lines connecting graph points
+  parameters:
+    - name: Show
+      required: true
+      description: Show lines connecting graph points
+      values: ['TRUE','FALSE']
+SHOW_LEGEND:
+  summary: Whether to draw the graph legend
+  parameters:
+    - name: Show
+      required: true
+      description: Show graph legend
+      values: ['TRUE','FALSE']
+MANUAL_Y_AXIS_SCALE:
+  summary: Manually scale the Y axis
+  parameters:
+    - name: Minimum
+      required: true
+      description: Y axis minimum value
+      values: '[0-9]*\.?[0-9]+'
+    - name: Maximum
+      required: true
+      description: Y axis maximum value
+      values: '[0-9]*\.?[0-9]+'
+    - name: Axis
+      required: false
+      description: Which Y axis to Scale. Default is Left.
+      values: ['LEFT','RIGHT']
+MANUAL_X_GRID_LINE_SCALE:
+  summary: Manually scale the X axis grid lines
+  parameters:
+    - name: Scale
+      required: true
+      description: X axis grid line scale
+      values: '[0-9]*\.?[0-9]+'
+MANUAL_Y_GRID_LINE_SCALE:
+  summary: Manually scale the Y axis grid lines
+  parameters:
+    - name: Scale
+      required: true
+      description: Y axis grid line scale
+      values: '[0-9]*\.?[0-9]+'
+UNIX_EPOCH_X_VALUES:
+  summary: Whether to use UNIX epoch X values
+  parameters:
+    - name: UNIX Epoch
+      required: true
+      description: UNIX epoch X values
+      values: ['TRUE','FALSE']
+UTC_TIME:
+  summary: Whether to use UTC time on the X axis

data/data/config/page_modifiers.yaml

@@ -0,0 +1,128 @@
+---
+NO_PDF:
+  summary: Indicates this page should not be generated when building the PDF
+  description: Handbook Creator can create webpages and export them to PDFs. Use
+    this keyword when you have an index webpage or another page for which you do not
+    want a PDF created.
+PDF_COVER:
+  summary: Defines an HTML ERB template which is used to create the PDF cover page
+  description: The template is simply HTML tags which can reference 'title'
+    set by this keyword from ERB context
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the HTML ERB template file which is found in the
+        config/tools/handbook_creator/templates directory.
+      values: .+
+    - name: Title Text
+      required: true
+      description: Title text which is accessable in the template
+      values: .+
+PDF_TOC:
+  summary: Insert the PDF table of contents
+  description: The table of contents is generated from the XSL templated found
+    in config/tools/handbook_creator/default_toc.xsl
+PDF_HEADER:
+  summary: Defines an HTML ERB template which is used to create the header on each PDF page
+  description: The template is simply HTML tags which can reference 'title'
+    set by this keyword from ERB context
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the HTML ERB template file which is found in the
+        config/tools/handbook_creator/templates directory.
+      values: .+
+    - name: Title Text
+      required: true
+      description: Title text which is accessable in the template
+      values: .+
+PDF_FOOTER:
+  summary: Defines an HTML ERB template which is used to create the footer on each PDF page
+  description: The template is simply HTML tags which can reference 'title'
+    set by this keyword from ERB context
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the HTML ERB template file which is found in the
+        config/tools/handbook_creator/templates directory.
+      values: .+
+    - name: Title Text
+      required: true
+      description: Title text which is accessable in the template
+      values: .+
+PDF_TOP_MARGIN:
+  summary: The margin from the top of the PDF page before the header
+  parameters:
+    - name: Margin
+      required: true
+      description: The margin in pixels
+      values: \d+
+PDF_BOTTOM_MARGIN:
+  summary: The margin below the footer to the bottom of the PDF page
+  parameters:
+    - name: Margin
+      required: true
+      description: The margin in pixels
+      values: \d+
+PDF_SIDE_MARGIN:
+  summary: The margin on both sides on the PDF page
+  parameters:
+    - name: Margin
+      required: true
+      description: The margin in pixels
+      values: \d+
+TARGET:
+  summary: Specify a target which this page is generated for
+  parameters:
+    - name: Target
+      required: true
+      description: The target name
+      values: <%= System.targets.keys %>
+SECTION:
+  summary: Define a page SECTION
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the HTML ERB template file which is found in the
+        config/tools/handbook_creator/templates directory.
+      values: .+
+    - name: Output
+      required: true
+      description: What output formats should contain this section
+      values: ['ALl', 'HTML', 'PDF']
+    - name: Title Text
+      required: false
+      description: Title text which is accessable in the template
+      values: .+
+CMD_SECTION:
+  summary: Define a page SECTION which is generated for all command packets
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the HTML ERB template file which is found in the
+        config/tools/handbook_creator/templates directory.
+      values: .+
+    - name: Output
+      required: true
+      description: What output formats should contain this section
+      values: ['ALl', 'HTML', 'PDF']
+    - name: Title Text
+      required: false
+      description: Title text which is accessable in the template
+      values: .+
+TLM_SECTION:
+  summary: Define a page SECTION which is generated for all telemetry packets
+  parameters:
+    - name: Filename
+      required: true
+      description: Name of the HTML ERB template file which is found in the
+        config/tools/handbook_creator/templates directory.
+      values: .+
+    - name: Output
+      required: true
+      description: What output formats should contain this section
+      values: ['ALl', 'HTML', 'PDF']
+    - name: Title Text
+      required: false
+      description: Title text which is accessable in the template
+      values: .+

data/data/config/param_item_modifiers.yaml

@@ -0,0 +1,41 @@
+---
+FORMAT_STRING:
+  summary: Adds printf style formatting
+  parameters:
+    - name: Format
+      required: true
+      description: How to format using printf syntax.
+        For example, '0x%0X' will display the value in hex.
+      values: .*
+UNITS:
+  summary: Add displayed units
+  parameters:
+    - name: Full Name
+      required: true
+      description: Full name of the units type, e.g. Celcius
+      values: .*
+    - name: Abbreviated
+      required: true
+      description: Abbreviation for the units, e.g. C
+      values: .*
+DESCRIPTION:
+  summary: Override the defined description
+  parameters:
+    - name: Value
+      required: true
+      description: The new description
+      values: .*
+META:
+  summary: Stores custom user metadata
+  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: .*