openc3 5.5.0 → 5.5.2.pre.beta0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a21cdfc706de17b576884e2d65593ed329ce736d12384ce0ab1880b3d5d7986
-  data.tar.gz: a1927adc509a3087157cfc5b35737f01796c7fe54a711dd7e750a56de14d7b17
+  metadata.gz: 9afdd0579f3b0663d3cd0d378483b372c2f3c34faa5856d1c5ef5b4a1e582af3
+  data.tar.gz: 9224b37cda9d56d8e867a0ead73d815b3140979355a85d408824377e628fec10
 SHA512:
-  metadata.gz: 0dc0c6851d30a29b647ae243b7cb6bfcf641c8cea7a86b41277c677a02f60ce9558f5bb1d37255eb358e99d4670c67e5fa9fecbe422055b061df10ee167591fb
-  data.tar.gz: ed5c29f6c49930381ed2985e22736ec5ee2037774c60ec50d27e25afddd6ab90224d1012ff57ffa109402abe489abeafa78faf63e9111e65fa7689ec65222b3f
+  metadata.gz: 2c3e6009efea9ee0b7669634ba9dd0c45dd81fa9f47405ddd44ec375993e7d85b8f4b51547cb943c3229e2bfd7e5aa5ddfc5ad1de8963a6d05e8220c029e3baf
+  data.tar.gz: 4cbe48f762771ad19429e19102f5fe427607814b1eb2149a06ed713a972d807481b767b023031fe21c21465a67108e39ceb0fef003d0ffea533b3db223960764

data/data/config/_canvas_values.yaml

@@ -0,0 +1,42 @@
+VALUE_EQ:
+  summary: Map a value to a color
+  since: 5.5.1
+  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/command.yaml

@@ -5,7 +5,6 @@ COMMAND:
   modifiers:
     <%= MetaConfigParser.load('command_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a new command packet
-  example: COMMAND INST COLLECT BIG_ENDIAN "Start collect"
   parameters:
     - name: Target
       required: true
@@ -24,6 +23,7 @@ COMMAND:
       required: false
       description: Description of this command which must be enclosed with quotes
       values: '[''"].*[''"]'
+  example: COMMAND INST COLLECT BIG_ENDIAN "Start collect"
 SELECT_COMMAND:
   # prettier-ignore
   modifiers:
@@ -31,8 +31,8 @@ SELECT_COMMAND:
   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
-  example: SELECT_COMMAND INST COLLECT
+    command is defined to override or add to the existing command definition.
+    Must be used in conjunction with SELECT_PARAMETER to change an individual parameter.
   parameters:
     - name: Target Name
       required: true
@@ -42,3 +42,8 @@ SELECT_COMMAND:
       required: true
       description: Name of the command to select
       values: .*
+  example: |
+    SELECT_COMMAND INST COLLECT
+      SELECT_PARAMETER DURATION
+        # Add units
+        UNITS Seconds S

data/data/config/command_modifiers.yaml

@@ -3,12 +3,6 @@ PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a command parameter in the current command packet
-  example: |
-    PARAMETER SYNC 0 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
-    PARAMETER DATA 32 32 INT MIN MAX 0 "Data value"
-    PARAMETER VALUE 64 32 FLOAT 0 10.5 2.5
-    PARAMETER LABEL 96 96 STRING "OPENC3" "The label to apply"
-    PARAMETER BLOCK 192 0 BLOCK 0x0 "Block of binary data"
   parameters:
     - name: Name
       required: true
@@ -21,20 +15,26 @@ PARAMETER:
         Always use a bit offset of 0 for derived parameters.
       values: '[-]?\d+'
     <%= MetaConfigParser.load('_params.yaml').to_meta_config_yaml(4) %>
+  example: |
+    PARAMETER SYNC 0 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
+    PARAMETER DATA 32 32 INT MIN MAX 0 "Data value"
+    PARAMETER VALUE 64 32 FLOAT 0 10.5 2.5
+    PARAMETER LABEL 96 96 STRING "OPENC3" "The label to apply"
+    PARAMETER BLOCK 192 0 BLOCK 0x0 "Block of binary data"
 APPEND_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a command parameter in the current command packet
-  example: |
-    APPEND_PARAMETER SYNC 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
-    APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5
-    APPEND_PARAMETER LABEL 0 STRING "OPENC3" "The label to apply"
   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) %>
+  example: |
+    APPEND_PARAMETER SYNC 32 UINT 0xDEADBEEF 0xDEADBEEF 0xDEADBEEF "Sync pattern"
+    APPEND_PARAMETER VALUE 32 FLOAT 0 10.5 2.5
+    APPEND_PARAMETER LABEL 0 STRING "OPENC3" "The label to apply"
 ID_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
@@ -42,7 +42,6 @@ ID_PARAMETER:
   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.
-  example: ID_PARAMETER OPCODE 32 32 UINT 2 2 2 "Opcode identifier"
   parameters:
     - name: Name
       required: true
@@ -55,6 +54,7 @@ ID_PARAMETER:
         Always use a bit offset of 0 for derived parameters.
       values: '[-]?\d+'
     <%= MetaConfigParser.load('_id_params.yaml').to_meta_config_yaml(4) %>
+  example: ID_PARAMETER OPCODE 32 32 UINT 2 2 2 "Opcode identifier"
 APPEND_ID_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
@@ -62,18 +62,17 @@ APPEND_ID_PARAMETER:
   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.
-  example: APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "Opcode identifier"
   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) %>
+  example: APPEND_ID_PARAMETER OPCODE 32 UINT 2 2 2 "Opcode identifier"
 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
-  example: ARRAY_PARAMETER ARRAY 64 64 FLOAT 640 "Array of 10 64bit floats"
   parameters:
     - name: Name
       required: true
@@ -86,44 +85,50 @@ ARRAY_PARAMETER:
         Always use a bit offset of 0 for derived parameters.
       values: '[-]?\d+'
     <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+  example: ARRAY_PARAMETER ARRAY 64 64 FLOAT 640 "Array of 10 64bit floats"
 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
-  example: APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"
   parameters:
     - name: Name
       required: true
       description: Name of the parameter. Must be unique within the command.
       values: .*
     <%= MetaConfigParser.load('_array_params.yaml').to_meta_config_yaml(4) %>
+  example: APPEND_ARRAY_PARAMETER ARRAY 64 FLOAT 640 "Array of 10 64bit floats"
 SELECT_PARAMETER:
   modifiers:
     <%= MetaConfigParser.load('parameter_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Selects an existing command parameter for editing
-  example: |
-    SELECT_COMMAND INST COLLECT
-      SELECT_PARAMETER DURATION
+  description: Must be used in conjunction with SELECT_COMMAND to first select
+    the packet. Typically used to override generated values or make specific changes
+    to commands that only affect a particular instance of a target used multiple times.
   parameters:
     - name: Parameter
       required: true
       description: Name of the parameter to select for modification
       values: .+
+  example: |
+    SELECT_COMMAND INST COLLECT
+      SELECT_PARAMETER DURATION
+        # Add units
+        UNITS Seconds S
 DELETE_PARAMETER:
   summary: Deletes an existing command parameter from the packet definition
   description: Deleting a parameter from the command definition does not remove the
     defined space for that parameter. Thus unless you redefine a new parameter, there
     will be a "hole" in the packet where the data is not accessible. You can
     use SELECT_COMMAND and then PARAMETER to define a new parameter.
-  example: |
-    SELECT_COMMAND INST COLLECT
-      DELETE_PARAMETER DURATION
   since: 4.4.1
   parameters:
     - name: Parameter
       required: true
       description: Name of the parameter to delete
       values: .+
+  example: |
+    SELECT_COMMAND INST COLLECT
+      DELETE_PARAMETER DURATION
 HIDDEN:
   summary: Hides this command from all OpenC3 tools such as Command Sender and Handbook Creator
   description: Hidden commands do not appear in the Script Runner popup helper when writing scripts.
@@ -139,7 +144,6 @@ META:
   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.
-  example: META FSW_TYPE "struct command"
   parameters:
     - name: Meta Name
       required: true
@@ -149,6 +153,7 @@ META:
       required: false
       description: One or more values to be stored for this Meta Name
       values: .*
+  example: META FSW_TYPE "struct command"
 HAZARDOUS:
   summary: Designates the current command as hazardous
   description: Sending a hazardous command causes a dialog asking for confirmation

data/data/config/graph_settings.yaml

@@ -0,0 +1,54 @@
+---
+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
+  since: 5.5.1
+  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
+  since: 5.5.1
+  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

@@ -8,6 +8,7 @@ MAP_TARGET:
       values: .+
 MAP_CMD_TARGET:
   summary: Maps a target name to an interface for commands only
+  since: 5.2.0
   parameters:
     - name: Target Name
       required: true
@@ -15,6 +16,7 @@ MAP_CMD_TARGET:
       values: .+
 MAP_TLM_TARGET:
   summary: Maps a target name to an interface for telemetry only
+  since: 5.2.0
   parameters:
     - name: Target Name
       required: true
@@ -82,8 +84,7 @@ OPTION:
         interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS
         and DATA_BITS which changes the data bits of the serial interface.
         The TcpipServerInterface defines LISTEN_ADDRESS which is the IP address to accept
-        connections on (default 0.0.0.0) and AUTO_SYSTEM_META which will automatically send
-        SYSTEM META when the interface connects (default false).
+        connections on (default 0.0.0.0).
       values: .*
     - name: Parameters
       required: false
@@ -92,6 +93,7 @@ OPTION:
 SECRET:
   summary: Define a secret needed by this interface
   description: Defines a secret for this interface and optionally assigns its value to an option
+  since: 5.3.0
   parameters:
     - name: Type
       required: true
@@ -111,3 +113,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/item_modifiers.yaml

@@ -224,10 +224,10 @@ LIMITS_RESPONSE:
 KEY:
   summary: Defines the key used to access this raw value in the packet.
   description: Keys are often JsonPath or XPath strings
-  example: KEY $.book.title
+  since: 5.0.10
   parameters:
     - name: Key string
       required: true
       description: The key to access this item
       values: .+
-  since: 5.0.10
+  example: KEY $.book.title

data/data/config/microservice.yaml

@@ -35,6 +35,7 @@ MICROSERVICE:
     PORT:
       summary: Open port for the microservice
       description: Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support
+      since: 5.0.10
       parameters:
         - name: Number
           required: true
@@ -91,6 +92,7 @@ MICROSERVICE:
     SECRET:
       summary: Define a secret needed by this microservice
       description: Defines a secret for this microservice
+      since: 5.3.0
       parameters:
         - name: Type
           required: true
@@ -102,13 +104,18 @@ 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
+      since: 5.5.0
       parameters:
         - name: Route Prefix
           required: true

data/data/config/plugins.yaml

@@ -18,6 +18,7 @@ NEEDS_DEPENDENCIES:
   description: If the plugin has a top level lib folder or lists runtime dependencies in the gemspec,
     NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise Edition, having
     NEEDS_DEPENDENCIES adds the NFS volume mount to the Kuberentes pod.
+  since: 5.5.0
 INTERFACE:
   modifiers:
     <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>

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
@@ -23,12 +27,15 @@ END:
     to indicate where the VERTICALBOX ends.
 STALE_TIME:
   summary: Values are marked stale if the packet time is more than Stale Time seconds in the past
+  since: 5.1.0
   parameters:
     - name: value
       required: true
       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 +46,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 +70,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 +113,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 +147,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) %>