cosmos 3.9.2 → 4.0.0

data/data/config/parameter_modifiers.yaml

@@ -0,0 +1,144 @@
+---
+<%= MetaConfigParser.load('param_item_modifiers.yaml').to_meta_config_yaml(0) %>
+REQUIRED:
+  summary: Parameter is required to be populated in scripts
+  description: When sending the command via Script Runner a value must always be
+    given for the current command parameter. This prevents the user from relying
+    on a default value. Note that this does not affect Command Sender which will
+    still populate the field with the default value provided in the PARAMETER definition.
+MINIMUM_VALUE:
+  summary: Override the defined minimum value
+  parameters:
+    - name: Value
+      required: true
+      description: The new minimum value for the parameter
+      values: .*
+MAXIMUM_VALUE:
+  summary: Override the defined maximum value
+  parameters:
+    - name: Value
+      required: true
+      description: The new maximum value for the parameter
+      values: .*
+DEFAULT_VALUE:
+  summary: Override the defined default value
+  parameters:
+    - name: Value
+      required: true
+      description: The new default value for the parameter
+      values: .*
+STATE:
+  summary: Defines a key/value pair for the current command parameter
+  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 command parameter 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: Hazardous
+      required: false
+      description: Indicates the state is hazardous. This will cause a popup
+        to ask for user confirmation when sending this command.
+      values: ['HAZARDOUS']
+    - name: Hazardous Description
+      required: false
+      description: String describing why this state is hazardous
+      values: "['\"].*['\"]"
+WRITE_CONVERSION:
+  summary: Applies a conversion when writing the current command parameter
+  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 value entered by the user before it is written into
+    the binary command packet and sent.
+  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_WRITE_CONVERSION:
+  summary: Adds a polynomial conversion factor to the current command parameter
+  description: The conversion factor is applied to the value entered by the user
+    before it is written into the binary command packet and sent.
+  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_WRITE_CONVERSION:
+  summary: Adds a segmented polynomial conversion factor to the current command parameter
+  description: This conversion factor is applied to the value entered by the user
+    before it is written into the binary command packet and sent.
+  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_WRITE_CONVERSION_START:
+  summary: Start a generic write conversion
+  description: Adds a generic conversion function to the current command parameter.
+    This conversion factor is applied to the value entered by the user before it
+    is written into the binary command packet and sent. 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 command 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_WRITE_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 WRITE_CONVERSION instead. WRITE_CONVERSION is easier
+    to debug and higher performance.
+GENERIC_WRITE_CONVERSION_END:
+  summary: Complete a generic write conversion
+OVERFLOW:
+  summary: Set the behavior when writing a value overflows the type
+  description: By default COSMOS throws an error if you try to write a value
+    which overflows its specified type, e.g. writing 255 to a 8 bit signed value.
+    Setting the overflow behavior also allows for COSMOS to 'TRUNCATE'
+    the value by eliminating any high order bits. You can also set 'SATURATE' which
+    causes COSMOS to replace the value with the maximum or minimum allowable value
+    for that type. Finally you can specify 'ERROR_ALLOW_HEX' which will allow for
+    a maximum hex value to be writen, e.g. you can successfully write 255 to a 8
+    bit signed value.
+  parameters:
+    - name: Behavior
+      required: true
+      description: How COSMOS treats an overflow value. Only applies to signed and
+        unsigned integer data types.
+      values: <%= %w(ERROR ERROR_ALLOW_HEX TRUNCATE SATURATE) %>

data/data/config/protocols.yaml

@@ -0,0 +1,257 @@
+---
+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: \d+
+    - 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']

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) %>