adams-visiona 1.0.0

data/data/config/item_modifiers.yaml

@@ -0,0 +1,221 @@
+---
+<%= 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.
+  example: |
+    APPEND_ITEM ENABLE 32 UINT "Enable setting"
+      STATE FALSE 0
+      STATE TRUE 1
+    APPEND_ITEM STRING 1024 STRING "String"
+      STATE "NOOP" "NOOP" GREEN
+      STATE "ARM LASER" "ARM LASER" YELLOW
+      STATE "FIRE LASER" "FIRE LASER" RED
+  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.
+  example: |
+    READ_CONVERSION the_great_conversion.rb 1000
+
+    Defined in the_great_conversion.rb:
+
+    require 'cosmos/conversions/conversion'
+    module Cosmos
+      class TheGreatConversion < Conversion
+        def initialize(multiplier)
+          super()
+          @multiplier = multiplier.to_f
+        end
+        def call(value, packet, buffer)
+          return value * multiplier
+        end
+      end
+    end
+  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.
+  example: POLY_READ_CONVERSION 10 0.5 0.25
+  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.
+  example: |
+    SEG_POLY_READ_CONVERSION 0 10 0.5 0.25 # Apply the conversion to all values < 50
+    SEG_POLY_READ_CONVERSION 50 11 0.5 0.275 # Apply the conversion to all values >= 50 and < 100
+    SEG_POLY_READ_CONVERSION 100 12 0.5 0.3 # Apply the conversion to all values >= 100
+  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 read 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 read 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.
+  example: |
+    APPEND_ITEM ITEM1 32 UINT
+      GENERIC_READ_CONVERSION_START
+        value * 1.5  # Convert the value by a scale factor
+      GENERIC_READ_CONVERSION_END
+  parameters:
+    - name: Converted Type
+      required: false
+      description: Type of the converted value
+      values: <%= %w(INT UINT FLOAT STRING BLOCK) %>
+    - name: Converted Bit Size
+      required: false
+      description: Bit size of converted value
+      values: \d+
+GENERIC_READ_CONVERSION_END:
+  summary: Complete a generic read 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.
+  example: |
+    LIMITS DEFAULT 3 ENABLED -80.0 -70.0 60.0 80.0 -20.0 20.0
+    LIMITS TVAC 3 ENABLED -80.0 -30.0 30.0 80.0
+  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.
+        Note if you have multiple LIMITS items they should all have the same initial state.
+      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
+  example: LIMITS_RESPONSE example_limits_response.rb 10
+  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: .+

data/data/config/launcher.yaml

@@ -0,0 +1,127 @@
+---
+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. COSMOS defines three helper
+        keywords to execute tools - LAUNCH, LAUNCH_TERMINAL, and LAUNCH_GEM. LAUNCH
+        starts a GUI Ruby tool without a terminal. LAUNCH_TERMINAL starts a Ruby tool
+        with a terminal window. LAUNCH_GEM launches a Ruby tool distributed with a gem.
+      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. COSMOS defines three helper
+            keywords to execute tools - LAUNCH, LAUNCH_TERMINAL, and LAUNCH_GEM. LAUNCH
+            starts a GUI Ruby tool without a terminal. LAUNCH_TERMINAL starts a Ruby tool
+            with a terminal window. LAUNCH_GEM launches a Ruby tool distributed with a gem.
+          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
+AUTO_GEM_TOOLS:
+  summary: Automatically installs COSMOS tool gems
+  description: Traverses the installed rubygems looking for COSMOS gems named cosmos-xxxx.gem.
+    If the gem has a tools directory, the tool launcher will be added as a TOOL in the Launcher.

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: .+