openc3 5.5.0 → 5.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a21cdfc706de17b576884e2d65593ed329ce736d12384ce0ab1880b3d5d7986
-  data.tar.gz: a1927adc509a3087157cfc5b35737f01796c7fe54a711dd7e750a56de14d7b17
+  metadata.gz: a2b1524aa1d06a8149e80ffb2843b3a9304d73cf432ecd641396292bf5209439
+  data.tar.gz: f35947a803088cb83705c3748fb860751cf40228a5c4720d151c867a001157ce
 SHA512:
-  metadata.gz: 0dc0c6851d30a29b647ae243b7cb6bfcf641c8cea7a86b41277c677a02f60ce9558f5bb1d37255eb358e99d4670c67e5fa9fecbe422055b061df10ee167591fb
-  data.tar.gz: ed5c29f6c49930381ed2985e22736ec5ee2037774c60ec50d27e25afddd6ab90224d1012ff57ffa109402abe489abeafa78faf63e9111e65fa7689ec65222b3f
+  metadata.gz: 245f9f7fe39f5ac4f82bab653de55f413432b3ad9f73b586f2d82f2a14e50bcd6d77a5bc11e1b4a9a2f95c4b11c2aef55dcc325ab330da076ecdb7f0245fb374
+  data.tar.gz: 2f142eea4029f7b1efd3564578413e09d23acd6b9136799d123db48e733577d28a50c3e90640143e20e8f092874ec08c277df6ca721cf2a33bc4c1ffeabf42ba

data/data/config/_canvas_values.yaml

@@ -0,0 +1,41 @@
+VALUE_EQ:
+  summary: Map a value to a color
+  parameters:
+    - name: Value
+      required: true
+      description: State or value
+      values: .+
+    - name: Color
+      required: true
+      description: Color of the line
+      values: .+
+# TODO: At one point for CANVASIMAGEVALUE, CANVASLABELVALUE, and CANVASLINEVALUE
+# supported VALUE_GT, VALUE_GTEQ, VALUE_LT, VALUE_LTEQ
+# which are identical to VALUE_EQ except greater than, less than.
+# They also supported TLM_AND and TLM_OR defined as:
+### TLM_AND
+# The TLM_AND setting allows added another comparison that is anded with the original comparison for a canvas value widget to determine 'ON' state
+# | Parameter       | Description                                                                  | Required |
+# | --------------- | ---------------------------------------------------------------------------- | -------- |
+# | Target Name     | The target name portion of the telemetry mnemonic                            | Yes      |
+# | Packet Name     | The packet name portion of the telemetry mnemonic                            | Yes      |
+# | Item Name       | The item name portion of the telemetry mnemonic                              | Yes      |
+# | Comparison Type | The comparison type: VALUE_EQ, VALUE_GT, VALUE_GTEQ, VALUE_LT, or VALUE_LTEQ | Yes      |
+# | Value           | The value to compare against                                                 | Yes      |
+# Example Usage:
+# CANVASIMAGEVALUE INST HEALTH_STATUS TEMP1 "ground" 400 100
+# SETTING VALUE_LTEQ 10.0
+# SETTING TLM_AND INST HEALTH_STATUS TEMP2 VALUE_GT 20.0
+### TLM_OR
+#The TLM_OR setting allows added another comparison that is ored with the original comparison for a canvas value widget to determine 'ON' state
+# | Parameter       | Description                                                                  | Required |
+# | --------------- | ---------------------------------------------------------------------------- | -------- |
+# | Target Name     | The target name portion of the telemetry mnemonic                            | Yes      |
+# | Packet Name     | The packet name portion of the telemetry mnemonic                            | Yes      |
+# | Item Name       | The item name portion of the telemetry mnemonic                              | Yes      |
+# | Comparison Type | The comparison type: VALUE_EQ, VALUE_GT, VALUE_GTEQ, VALUE_LT, or VALUE_LTEQ | Yes      |
+# | Value           | The value to compare against                                                 | Yes      |
+# Example Usage:
+# CANVASIMAGEVALUE INST HEALTH_STATUS TEMP1 "ground" 400 100
+# SETTING VALUE_LTEQ 10.0
+# SETTING TLM_OR INST HEALTH_STATUS TEMP2 VALUE_GT 20.0

data/data/config/_graph_params.yaml

@@ -0,0 +1,25 @@
+---
+- name: Target name
+  required: true
+  description: The target name
+  values: .+
+- name: Packet name
+  required: true
+  description: The packet name
+  values: .+
+- name: Item name
+  required: true
+  description: The item name
+  values: .+
+- name: Value type
+  required: false
+  description: The type of the value to display. Default is CONVERTED.
+  values: <%= %w(RAW CONVERTED) %>
+- name: Reduced
+  required: false
+  description: Whether to display reduced data. Default is DECOM.
+  values: <%= %w(DECOM REDUCED_MINUTE REDUCED_HOUR REDUCED_DAY) %>
+- name: Reduced Type
+  required: false
+  description: The type of reduce data to display. Only applies if Reduced is not DECOM.
+  values: <%= %w(MIN MAX AVG STDDEV) %>

data/data/config/graph_settings.yaml

@@ -0,0 +1,52 @@
+---
+ITEM:
+  summary: Add a telemetry item to the graph
+  parameters:
+    # Inject the graph parameters
+    <%= MetaConfigParser.load('_graph_params.yaml').to_meta_config_yaml(4) %>
+STARTTIME:
+  summary: Start the graph history at the designated Time
+  parameters:
+    - name: Start Time
+      required: true
+      description: Start time as formatted 'YYYY/MM/DD HH:MM:SS'
+      values: .+
+HISTORY:
+  summary: Display an initial history of data
+  parameters:
+    - name: Value
+      required: true
+      description: Value{d,h,m,s}. For example 1d, 2h, 30m, 15s
+      values: .+
+SECONDSGRAPHED:
+  summary: Display the specified number of seconds in the graph
+  parameters:
+    - name: Time
+      required: true
+      description: Number of seconds to display
+      values: .+
+POINTSSAVED:
+  summary: Save the number of seconds in graph memory
+  parameters:
+    - name: Time
+      required: true
+      description: Number of seconds to save
+      values: .+
+POINTSGRAPHED:
+  summary: Number of points to display on the graph
+  parameters:
+    - name: Time
+      required: true
+      description: Number of points to graph
+      values: .+
+SIZE:
+  summary: Size of the graph
+  parameters:
+    - name: Width
+      required: true
+      description: Width in pixels
+      values: .+
+    - name: Height
+      required: true
+      description: Height in pixels
+      values: .+

data/data/config/interface_modifiers.yaml

@@ -111,3 +111,7 @@ SECRET:
       required: false
       description: Interface option to pass the secret value
       values: .*
+    - name: Secret Store Name
+      required: false
+      description: Name of the secret store for stores with multipart keys
+      values: .*

data/data/config/microservice.yaml

@@ -102,10 +102,14 @@ MICROSERVICE:
           required: true
           description: The name of the secret to retrieve
           values: .*
-        - name: Environment Variable of File Path
+        - name: Environment Variable or File Path
           required: true
           description: Environment variable name or file path to store secret
           values: .*
+        - name: Secret Store Name
+          required: false
+          description: Name of the secret store for stores with multipart keys
+          values: .*
     ROUTE_PREFIX:
       summary: Prefix of route
       description: Prefix of route to the microservice to expose externally with Traefik

data/data/config/screen.yaml

@@ -1,6 +1,8 @@
 ---
 SCREEN:
   summary: Define a telemetry viewer screen
+  description: The SCREEN keyword is the first keyword in any telemetry screen definition.
+    It defines the name of the screen and parameters that affect the screen overall.
   parameters:
     - name: Width
       required: true
@@ -16,6 +18,8 @@ SCREEN:
       required: true
       description: Number of seconds between screen updates
       values: '[0-9]*\.?[0-9]+'
+  example: |
+    SCREEN AUTO AUTO 1.0 FIXED
 END:
   summary: Indicates the close of a layout widget
   description: All layout widgets must be closed to properly identify where they
@@ -29,6 +33,8 @@ STALE_TIME:
       description: Items from packets with RECEIVED_TIMESECONDS greater than this value in the past will be marked stale.
         The default is 30s. Recommend a minimum of 2s to avoid false positives due to race conditions.
       values: \d+
+  example: |
+    STALE_TIME 5 # Number of seconds to wait before marking data stale
 GLOBAL_SETTING:
   summary: Applies a widget setting to all widgets of a certain type
   parameters:
@@ -39,19 +45,14 @@ GLOBAL_SETTING:
       values: .+
     - name: Setting Name
       required: true
-      description: Widget specific setting name. OpenC3 defines several settings
-        which apply across many different widget types. However, you can also use
-        the 'RAW' setting which allows any stylesheet values.
-      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+      description: See SETTING for details.
+      values: .+
     - 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 a length the units are required, e.g. 200px.
-        If the setting is RAW the value should be the raw stylesheet
-        key and value, e.g. font-size 10px
+      description: See SETTING for details.
       values: .*
+  example: |
+    GLOBAL_SETTING LABELVALUELIMITSBAR COLORBLIND TRUE
 GLOBAL_SUBSETTING:
   summary: Applies a widget subsetting to all widgets of a certain type
   description: Subsettings are only valid for widgets that are
@@ -68,42 +69,33 @@ GLOBAL_SUBSETTING:
       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.
+      description: Index to the desired subwidget
       values: .+
     - name: Setting Name
       required: true
-      description: Widget specific setting name. OpenC3 defines several settings
-        which apply across many different widget types. However, you can also use
-        the 'RAW' setting which allows any stylesheet values.
-      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+      description: See SETTING for details.
+      values: .+
     - 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 a length the units are required, e.g. 200px.
-        If the setting is RAW the value should be the raw stylesheet
-        key and value, e.g. font-size 10px
+      description: See SETTING for details.
       values: .*
+  example: |
+    GLOBAL_SUBSETTING LABELVALUELIMITSBAR 1 COLORBLIND TRUE
+    # Set all text color to white for labelvaluelimitsbars
+    GLOBAL_SUBSETTING LABELVALUELIMITSBAR 0:0 TEXTCOLOR white
 SETTING:
   summary: Applies a widget setting to the previously defined widget
-  parameters:
-    - name: Setting Name
-      required: true
-      description: Widget specific setting name. OpenC3 defines several settings
-        which apply across many different widget types. However, you can also use
-        the 'RAW' setting which allows any stylesheet values.
-      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 a length the units are required, e.g. 200px.
-        If the setting is RAW the value should be the raw stylesheet
-        key and value, e.g. font-size 10px
-      values: .*
+  description: |
+    Settings allow for additional tweaks and options to be applied to widgets
+    that are not available in their parameters. These settings are all configured
+    through the SETTING, SUBSETTING, GLOBAL_SETTING and GLOBAL_SUBSETTING keywords.
+    SETTING and SUBSETTING applies only to the widget defined immediately before it.
+    GLOBAL_SETTING and GLOBAL_SUBSETTING applies to all widgets.
+
+    Common wiget settings are defined here. Some widgets define their own
+    unqiue settings which are documented under that specific widget.
+  collection:
+    <%= MetaConfigParser.load('settings.yaml').to_meta_config_yaml(4) %>
 SUBSETTING:
   summary: Applies a widget subsetting to the previously defined widget
   description: Subsettings are only valid for widgets that are
@@ -120,19 +112,19 @@ SUBSETTING:
       values: .+
     - name: Setting Name
       required: true
-      description: Widget specific setting name. OpenC3 defines several settings
-        which apply across many different widget types. However, you can also use
-        the 'RAW' setting which allows any stylesheet.
-      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+      description: See SETTING for details.
+      values: .+
     - 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 a length the units are required, e.g. 200px.
-        If the setting is RAW the value should be the raw stylesheet
-        key and value, e.g. font-size 10px
+      description: See SETTING for details.
       values: .*
+  example: |
+    VERTICALBOX
+      LABELVALUE INST HEALTH_STATUS TEMP1
+      SUBSETTING 0 TEXTCOLOR blue # Change the label's text to blue
+      LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1
+      SUBSETTING 0:0 TEXTCOLOR green # Change the label's text to green
+    END
 NAMED_WIDGET:
   summary: Name a widget to allow access to it via the getNamedWidget method
   description: To programatically access parts of a telemetry screen you need
@@ -154,6 +146,8 @@ NAMED_WIDGET:
       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
+  example: |
+    NAMED_WIDGET DURATION TEXTFIELD
+    BUTTON "Push" "screen.getNamedWidget('DURATION').text()"
+
 <%= MetaConfigParser.load('widgets.yaml').to_meta_config_yaml(0) %>

data/data/config/settings.yaml

@@ -0,0 +1,144 @@
+WIDTH:
+  summary: Sets the widget width
+  description: WIDTH supports [css units](https://www.w3schools.com/cssref/css_units.php) with the default (no units) of px (pixels)
+  parameters:
+    - name: Width
+      required: true
+      description: Width in pixels or explicitly declared with units
+      values: .+
+  example: |
+    LABEL "THIS IS A TEST"
+      SETTING WIDTH 50
+    LABEL "THIS IS A TEST"
+      SETTING WIDTH 20em
+HEIGHT:
+  summary: Sets the widget height
+  description: HEIGHT supports [css units](https://www.w3schools.com/cssref/css_units.php) with the default (no units) of px (pixels)
+  parameters:
+    - name: Height
+      required: true
+      description: Height in pixels or explicitly declared with units
+      values: .+
+  example: |
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR BLUE
+      SETTING HEIGHT 50
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR GREY
+      SETTING HEIGHT 2em
+MARGIN:
+  summary: Sets the widget margin
+  description: MARGIN supports [css units](https://www.w3schools.com/cssref/css_units.php) with the default (no units) of px (pixels)
+  parameters:
+    - name: Size
+      required: true
+      description: Size in pixels or explicitly declared with units
+      values: .+
+  example: |
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR BLUE
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR GREY
+      SETTING MARGIN 10
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR GREEN
+PADDING:
+  summary: Sets the widget padding
+  description: PADDING supports [css units](https://www.w3schools.com/cssref/css_units.php) with the default (no units) of px (pixels)
+  parameters:
+    - name: Size
+      required: true
+      description: Size in pixels or explicitly declared with units
+      values: .+
+  example: |
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR BLUE
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR GREY
+      SETTING PADDING 10
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR GREEN
+BACKCOLOR:
+  summary: The BACKCOLOR setting sets the background color for a widget
+  parameters:
+    - name: Color name or Red value
+      required: true
+      description: Common name for the color, e.g. 'black', 'red', etc.
+        Alternatively if two more parameters are passed this is the
+        Red value of the RGB value
+      values: .+
+    - name: Green value
+      required: false
+      description: Green value of the RGB value
+      values: .+
+    - name: Blue value
+      required: false
+      description: Blue value of the RGB value
+      values: .+
+  example: |
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR red
+    LABEL "THIS IS A TEST"
+      SETTING BACKCOLOR 155 50 155
+TEXTCOLOR:
+  summary: The TEXTCOLOR setting sets the text color for a widget
+  parameters:
+    - name: Color name or Red value
+      required: true
+      description: Common name for the color, e.g. 'black', 'red', etc.
+        Alternatively if two more parameters are passed this is the
+        Red value of the RGB value
+      values: .+
+    - name: Green value
+      required: false
+      description: Green value of the RGB value
+      values: .+
+    - name: Blue value
+      required: false
+      description: Blue value of the RGB value
+      values: .+
+  example: |
+    LABEL "THIS IS A TEST"
+      SETTING TEXTCOLOR red
+    LABEL "THIS IS A TEST"
+      SETTING TEXTCOLOR 155 50 155
+BORDERCOLOR:
+  summary: The BORDERCOLOR setting sets the border color for a layout widget
+  parameters:
+    - name: Color name or Red value
+      required: true
+      description: Common name for the color, e.g. 'black', 'red', etc.
+        Alternatively if two more parameters are passed this is the
+        Red value of the RGB value
+      values: .+
+    - name: Green value
+      required: false
+      description: Green value of the RGB value
+      values: .+
+    - name: Blue value
+      required: false
+      description: Blue value of the RGB value
+      values: .+
+  example: |
+    HORIZONTAL
+      LABEL "Label 1"
+    END
+    SETTING BORDERCOLOR red
+    VERTICAL
+      LABEL "Label 2"
+    END
+    SETTING BORDERCOLOR 155 50 155
+RAW:
+  summary: Apply a raw CSS stylesheet key and value
+  parameters:
+    - name: Key
+      required: true
+      description: CSS key like font-size, max-width, etc
+      values: .+
+    - name: Value
+      required: true
+      description: CSS Value
+      values: .+
+  example: |
+    LABEL "Label 1"
+      SETTING RAW font-size 30px