openc3 5.5.0 → 5.5.2.pre.beta0

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

data/data/config/target.yaml

@@ -16,6 +16,7 @@ TARGET:
   modifiers:
     CMD_BUFFER_DEPTH:
       summary: Number of commands to buffer to ensure logged in order
+      since: 5.2.0
       parameters:
         - name: Buffer Depth
           required: true
@@ -65,6 +66,7 @@ TARGET:
           values: \d+
     TLM_BUFFER_DEPTH:
       summary: Number of telemetry packets to buffer to ensure logged in order
+      since: 5.2.0
       parameters:
         - name: Buffer Depth
           required: true
@@ -160,6 +162,7 @@ TARGET:
         Can be used to give more resources to processing that is falling behind.
         If defined multiple times for the same type, will create multiple processes.
         Each process can be given specific packets to process with the PACKET keyword.
+      since: 5.2.0
       parameters:
         - name: Type
           required: true
@@ -168,6 +171,7 @@ TARGET:
           values: .*
     PACKET:
       summary: Packet Name to allocate to the current TARGET_MICROSERVICE.
+      since: 5.2.0
       parameters:
         - name: Packet Name
           required: true

data/data/config/telemetry.yaml

@@ -5,7 +5,6 @@ TELEMETRY:
   modifiers:
     <%= MetaConfigParser.load('telemetry_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Defines a new telemetry packet
-  example: TELEMETRY SYSTEM LIMITS_CHANGE BIG_ENDIAN "OpenC3 limits change"
   parameters:
     - name: Target
       required: true
@@ -25,6 +24,7 @@ TELEMETRY:
       required: false
       description: Description of this telemetry packet which must be enclosed with quotes
       values: '[''"].*[''"]'
+  example: TELEMETRY INST HEALTH_STATUS BIG_ENDIAN "Instrument health and status"
 SELECT_TELEMETRY:
   # prettier-ignore
   modifiers:
@@ -32,17 +32,22 @@ SELECT_TELEMETRY:
   summary: Selects an existing telemetry packet for editing
   description:
     Typically used in a separate configuration file from where the original
-    telemetry is defined to override or add to the existing telemetry definition
-  example: SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
+    telemetry is defined to override or add to the existing telemetry definition.
+    Must be used in conjunction with SELECT_ITEM to change an individual item.
   parameters:
     - name: Target Name
       required: true
       description: Name of the target this telemetry packet is associated with
       values: .+
-    - name: Command Name
+    - name: Packet Name
       required: true
       description: Name of the telemetry packet to select
       values: .+
+  example: |
+    SELECT_TELEMETRY INST HEALTH_STATUS
+      SELECT_ITEM TEMP1
+        # Define limits for this item, overrides or replaces any existing
+        LIMITS DEFAULT 3 ENABLED -90.0 -80.0 80.0 90.0 -20.0 20.0
 LIMITS_GROUP:
   summary: Defines a group of related limits Items
   description:
@@ -63,15 +68,7 @@ LIMITS_GROUP_ITEM:
   summary: Adds the specified telemetry item to the last defined LIMITS_GROUP
   description:
     Limits group information is typically kept in a separate configuration
-    file in the config/TARGET/cmd_tlm folder named limits_groups.txt. If you want to
-    configure multiple target items in a particular group you should put this information
-    in the config/SYSTEM/cmd_tlm/limits_groups.txt file. The SYSTEM target is processed
-    last and contains information that crosses target boundaries.
-  example: |
-    LIMITS_GROUP SUBSYSTEM
-      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP1
-      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP2
-      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP3
+    file in the config/TARGET/cmd_tlm folder named limits_groups.txt.
   parameters:
     - name: Target Name
       required: true
@@ -85,3 +82,8 @@ LIMITS_GROUP_ITEM:
       required: true
       description: Name of the telemetry item to add to the group
       values: .+
+  example: |
+    LIMITS_GROUP SUBSYSTEM
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP1
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP2
+      LIMITS_GROUP_ITEM INST HEALTH_STATUS TEMP3

data/data/config/telemetry_modifiers.yaml

@@ -91,9 +91,14 @@ SELECT_ITEM:
   modifiers:
     <%= MetaConfigParser.load('item_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Selects an existing telemetry item for editing
+  description: Must be used in conjunction with SELECT_TELEMETRY to first select
+    the packet. Typically used to override generated values or make specific changes
+    to telemetry that only affect a particular instance of a target used multiple times.
   example: |
-    SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
-      SELECT_ITEM ITEM
+    SELECT_TELEMETRY INST HEALTH_STATUS
+      SELECT_ITEM TEMP1
+        # Define limits for this item, overrides or replaces any existing
+        LIMITS DEFAULT 3 ENABLED -90.0 -80.0 80.0 90.0 -20.0 20.0
   parameters:
     - name: Item
       required: true
@@ -106,8 +111,8 @@ DELETE_ITEM:
     will be a "hole" in the packet where the data is not accessible. You can
     use SELECT_TELEMETRY and then ITEM to define a new item.
   example: |
-    SELECT_TELEMETRY SYSTEM LIMITS_CHANGE
-      DELETE_ITEM ITEM
+    SELECT_TELEMETRY INST HEALTH_STATUS
+      DELETE_ITEM TEMP4
   since: 4.4.1
   parameters:
     - name: Item

data/data/config/tool.yaml

@@ -64,6 +64,7 @@ TOOL:
     POSITION:
       summary: Position of the tool in the nav bar
       description: Position of the tool as an integer starting at 1. Tools without a position are appended to the end as they are installed.
+      since: 5.0.8
       parameters:
         - name: Position
           required: true