data/config/widgets.yaml in cosmos-4.5.2-java vs data/config/widgets.yaml in cosmos-5.0.2.pre.beta2
- old
+ new
@@ -66,12 +66,70 @@
- name: Vertical spacing
required: false
description: Vertical spacing between matrix items in pixels (default = 0)
values: .*
SCROLLWINDOW:
- summary: Places the widgets inside of it into a scrollable
- area. The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained.
+ summary: Places the widgets inside of it into a scrollable area.
+ The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained.
+ parameters:
+ - name: Height
+ required: false
+ description: Maximum height of the scroll window in pixels (default = 180)
+ values: .*
+SPACER:
+ summary: Places a fixed size spacer in between widgets.
+ parameters:
+ - name: Width
+ required: false
+ description: Width of the widget
+ values: .*
+ - name: Height
+ required: false
+ description: Height of the widget
+ values: .*
+IFRAME:
+ summary: Open external tools in an Iframe within COSMOS.
+ parameters:
+ - name: URL
+ required: true
+ description: The path to the page to display in the iframe
+ values: .*
+ - name: Width
+ required: false
+ description: Width of the widget
+ values: .*
+ - name: Height
+ required: false
+ description: Height of the widget
+ values: .*
+IMAGEVIEWER:
+ summary: Display a base64 image from a TLM packet
+ parameters:
+ - 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: Format
+ required: true
+ description: The image format of the base64 data (e.g. jpg, png, etc)
+ values: .+
+ - name: Width
+ required: false
+ description: Width of the widget
+ values: .*
+ - name: Height
+ required: false
+ description: Height of the widget
+ values: .*
TABBOOK:
summary: Creates a tabbed area in which to place TABITEM widgets
to form a tabbed layout.
TABITEM:
summary: Creates a tab into which to place widgets. The tab
@@ -87,12 +145,12 @@
parameters:
- name: Text
required: true
description: Text to display on the label
values: .*
-HORIZONTALLINE:
- summary: Displays a horizontal line on the screen that can be used as a separator
+# HORIZONTALLINE:
+# summary: Displays a horizontal line on the screen that can be used as a separator
SECTIONHEADER:
summary: Displays a label that is underlined with a
horizontal line. Generally, SECTIONHEADER widgets are the first widget placed
inside of a VERTICALBOX widget.
parameters:
@@ -105,38 +163,38 @@
parameters:
- name: Text
required: true
description: Text to display above the horizontal line
values: .*
-SPACER:
- summary: Inserts a spacer into a layout. This can be used to
- separate or align other widgets.
- parameters:
- - name: Width
- required: true
- description: The width of the spacer in pixels.
- values: .*
- - name: Height
- required: true
- description: The height of the spacer in pixels.
- values: .*
- - name: Horizontal Policy
- required: false
- description: The horizontal size policy of the spacer. Default is MINIMUM.
- values: <%= %w(FIXED MINIMUM MAXIMUM PREFERRED EXPANDING MINIMUMEXPANDING IGNORED) %>
- - name: Vertical Policy
- required: false
- description: The vertical size policy of the spacer. Default is MINIMUM.
- values: <%= %w(FIXED MINIMUM MAXIMUM PREFERRED EXPANDING MINIMUMEXPANDING IGNORED) %>
+# SPACER:
+# summary: Inserts a spacer into a layout. This can be used to
+# separate or align other widgets.
+# parameters:
+# - name: Width
+# required: true
+# description: The width of the spacer in pixels.
+# values: .*
+# - name: Height
+# required: true
+# description: The height of the spacer in pixels.
+# values: .*
+# - name: Horizontal Policy
+# required: false
+# description: The horizontal size policy of the spacer. Default is MINIMUM.
+# values: <%= %w(FIXED MINIMUM MAXIMUM PREFERRED EXPANDING MINIMUMEXPANDING IGNORED) %>
+# - name: Vertical Policy
+# required: false
+# description: The vertical size policy of the spacer. Default is MINIMUM.
+# values: <%= %w(FIXED MINIMUM MAXIMUM PREFERRED EXPANDING MINIMUMEXPANDING IGNORED) %>
ARRAY:
summary: Displays data from an array telemetry item.
Data is organized into rows and by default space separated.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -168,11 +226,11 @@
Data is organized into rows and space separated.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -206,50 +264,50 @@
values: .*
- name: Value type
required: false
description: The type of the value to display. Default is CONVERTED.
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
-FORMATFONTVALUE:
- summary: Displays a box with a value printed inside
- that is formatted by the specified string rather than by a format string given
- in the telemetry definition files. Additionally, this widget can use a specified
- font. The white portion of the box darkens to gray while the value remains
- stagnant, then brightens to white each time the value changes. Additionally
- the value is colored based on the items limits state (Red for example if it is out of limits).
- parameters:
- - name: Target name
- required: true
- description: The target name
- values: <%= System.targets.keys %>
- - name: Packet name
- required: true
- description: The packet name
- values: .+
- - name: Item name
- required: true
- description: The item name
- values: .+
- - name: Format string
- required: false
- description: Printf style format string to apply to the telemetry item
- values: .*
- - name: Value type
- required: false
- description: The type of the value to display. Default is CONVERTED.
- values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
- - name: Number of characters
- required: false
- description: The number of characters wide to make the value box (default = 12)
- values: .*
- - name: Font name
- required: false
- description: The font to use. (default = arial)
- values: .*
- - name: Font size
- required: false
- description: The font size. (default = 100)
- values: .*
+# FORMATFONTVALUE:
+# summary: Displays a box with a value printed inside
+# that is formatted by the specified string rather than by a format string given
+# in the telemetry definition files. Additionally, this widget can use a specified
+# font. The white portion of the box darkens to gray while the value remains
+# stagnant, then brightens to white each time the value changes. Additionally
+# the value is colored based on the items limits state (Red for example if it is out of limits).
+# parameters:
+# - 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: Format string
+# required: false
+# description: Printf style format string to apply to the telemetry item
+# values: .*
+# - name: Value type
+# required: false
+# description: The type of the value to display. Default is CONVERTED.
+# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
+# - name: Number of characters
+# required: false
+# description: The number of characters wide to make the value box (default = 12)
+# values: .*
+# - name: Font name
+# required: false
+# description: The font to use. (default = arial)
+# values: .*
+# - name: Font size
+# required: false
+# description: The font size. (default = 100)
+# values: .*
FORMATVALUE:
summary: Displays a box with a value printed inside that
is formatted by the specified string rather than by a format string given in
the telemetry definition files. The white portion of the box darkens to gray
while the value remains stagnant, then brightens to white each time the value
@@ -257,11 +315,11 @@
(Red for example if it is out of limits).
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -279,17 +337,18 @@
- name: Number of characters
required: false
description: The number of characters wide to make the value box (default = 12)
values: .*
LABELLED:
- summary: Displays a Label widget followed by a LED which changes color based on telemetry values.
+ summary:
+ Displays a Label widget followed by a LED which changes color based on telemetry values.
See the LED widget documentation for more information.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -313,19 +372,19 @@
description: How to justify the label and LED together. The default of
'SPLIT' aligns the label to the left and the LED to the right with any
additional space going between them. 'CENTER' pushes the label and LED
together with any additional space to the left and right. 'LEFT' or 'RIGHT'
pushes them to the respective side with the space going on the opposite.
- values: ['SPLIT','CENTER','LEFT','RIGHT']
+ values: ["SPLIT", "CENTER", "LEFT", "RIGHT"]
LABELPROGRESSBAR:
summary: Displays a LABEL widget showing the items
name followed by a PROGRESSBAR widget to show the items value.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -343,56 +402,18 @@
values: .*
- name: Value type
required: false
description: The type of the value to display. Default is CONVERTED.
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
-LABELTRENDLIMITSBAR:
- summary: Displays a LABEL widget to show the
- item's name, a VALUE widget to show the telemetry items current value,
- a VALUE widget to display the value of the item X seconds ago, and a TRENDBAR
- widget to display the items value within its limits ranges and its trend.
- parameters:
- - name: Target name
- required: true
- description: The target name
- values: <%= System.targets.keys %>
- - 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 FORMATTED WITH_UNITS) %>
- - name: Trend seconds
- required: false
- description: The number of seconds in the past to display the trend value (default = 60)
- values: .*
- - name: Characters
- required: false
- description: The number of characters to display the telemetry value (default = 12)
- values: .*
- - name: Width
- required: false
- description: Width of the limits bar (default = 160)
- values: .*
- - name: Height
- required: false
- description: Height of the limits bar (default = 25)
- values: .*
LABELVALUE:
summary: Displays a LABEL widget to show the telemetry
items name followed by a VALUE widget to display the items value.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -412,76 +433,77 @@
description: How to justify the label and value together. The default of
'SPLIT' aligns the label to the left and the value to the right with any
additional space going between them. 'CENTER' pushes the label and value
together with any additional space to the left and right. 'LEFT' or 'RIGHT'
pushes them to the respective side with the space going on the opposite.
- values: ['SPLIT','CENTER','LEFT','RIGHT']
+ values: ["SPLIT", "CENTER", "LEFT", "RIGHT"]
LABELVALUEDESC:
summary: Displays a LABEL widget to show the telemetry
items description followed by a VALUE widget to display the items value.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
required: true
description: The item name
values: .+
- name: Description
required: false
- description: The description to display in the label (default is to display
+ description:
+ The description to display in the label (default is to display
the description text associated with the telemetry item)
values: .*
- name: Value type
required: false
description: The type of the value to display. Default is CONVERTED.
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
- name: Number of characters
required: false
description: The number of characters wide to make the value box (default = 12)
values: .*
-LABELFORMATVALUE:
- summary: Displays a LABEL widget to show the telemetry
- items name followed by a formatted VALUE widget to display the items value.
- parameters:
- - name: Target name
- required: true
- description: The target name
- values: <%= System.targets.keys %>
- - name: Packet name
- required: true
- description: The packet name
- values: .+
- - name: Item name
- required: true
- description: The item name
- values: .+
- - name: Format String
- required: true
- description: Printf style format string, for example %0.6f
- values: .*
- - name: Value type
- required: false
- description: The type of the value to display. Default is CONVERTED.
- values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
- - name: Number of characters
- required: false
- description: The number of characters wide to make the value box (default = 12)
- values: .*
+# LABELFORMATVALUE:
+# summary: Displays a LABEL widget to show the telemetry
+# items name followed by a formatted VALUE widget to display the items value.
+# parameters:
+# - 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: Format String
+# required: true
+# description: Printf style format string, for example %0.6f
+# values: .*
+# - name: Value type
+# required: false
+# description: The type of the value to display. Default is CONVERTED.
+# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
+# - name: Number of characters
+# required: false
+# description: The number of characters wide to make the value box (default = 12)
+# values: .*
LABELVALUELIMITSBAR:
summary: Displays a LABEL widget to show the telemetry item's name,
followed by a VALUE widget to display the item's value, followed by a LIMITSBAR widget.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -502,11 +524,11 @@
value, followed by a LIMITSCOLUMN widget.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -526,53 +548,11 @@
followed by a VALUE widget to display the item's value, followed by a RANGEBAR widget.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
- - name: Packet name
- required: true
- description: The packet name
values: .+
- - name: Item name
- required: true
- description: The item name
- values: .+
- - name: Low Value
- required: true
- description: Minimum value to display on the range bar. If the telemetry
- item goes below this value the bar is “pegged” on the low end.
- values: .+
- - name: High Value
- required: true
- description: Maximum value to display on the range bar. If the telemetry
- item goes above this value the bar is “pegged” on the high end.
- values: .+
- - name: Value type
- required: false
- description: The type of the value to display. Default is CONVERTED.
- values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
- - name: Number of characters
- required: false
- description: The number of characters wide to make the value box (default = 12)
- values: .*
- - name: Width
- required: false
- description: Width of the range bar (default = 160)
- values: .*
- - name: Height
- required: false
- description: Height of the range bar (default = 25)
- values: .*
-LABELVALUERANGECOLUMN:
- summary: Displays a LABEL widget to show the telemetry item's name,
- followed by a VALUE widget to display the item's value, followed by a RANGECOLUMN widget.
- parameters:
- - name: Target name
- required: true
- description: The target name
- values: <%= System.targets.keys %>
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -603,21 +583,63 @@
values: .*
- name: Height
required: false
description: Height of the range bar (default = 25)
values: .*
+# LABELVALUERANGECOLUMN:
+# summary: Displays a LABEL widget to show the telemetry item's name,
+# followed by a VALUE widget to display the item's value, followed by a RANGECOLUMN widget.
+# parameters:
+# - 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: Low Value
+# required: true
+# description: Minimum value to display on the range bar. If the telemetry
+# item goes below this value the bar is “pegged” on the low end.
+# values: .+
+# - name: High Value
+# required: true
+# description: Maximum value to display on the range bar. If the telemetry
+# item goes above this value the bar is “pegged” on the high end.
+# values: .+
+# - name: Value type
+# required: false
+# description: The type of the value to display. Default is CONVERTED.
+# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
+# - name: Number of characters
+# required: false
+# description: The number of characters wide to make the value box (default = 12)
+# values: .*
+# - name: Width
+# required: false
+# description: Width of the range bar (default = 160)
+# values: .*
+# - name: Height
+# required: false
+# description: Height of the range bar (default = 25)
+# values: .*
LED:
summary: Displays a LED which changes color based on telemetry values.
By default TRUE is green and FALSE is red and all other values are black.
Additional values can be added by using the LED_COLOR setting. For example
LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN,
SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -641,11 +663,11 @@
item's value falls withing its limits ranges horizontally.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -669,11 +691,11 @@
item's value falls withing its limits ranges vertically.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -697,11 +719,11 @@
limits color of an item
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -726,11 +748,11 @@
a VALUE widget.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -751,11 +773,11 @@
VALUE widget.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -775,53 +797,11 @@
item's value falls within a range horizontally and its value in a VALUE widget.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
- - name: Packet name
- required: true
- description: The packet name
values: .+
- - name: Item name
- required: true
- description: The item name
- values: .+
- - name: Low Value
- required: true
- description: Minimum value to display on the range bar. If the telemetry
- item goes below this value the bar is “pegged” on the low end.
- values: .+
- - name: High Value
- required: true
- description: Maximum value to display on the range bar. If the telemetry
- item goes above this value the bar is “pegged” on the high end.
- values: .+
- - name: Value type
- required: false
- description: The type of the value to display. Default is CONVERTED.
- values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
- - name: Number of characters
- required: false
- description: The number of characters wide to make the value box (default = 12)
- values: .*
- - name: Width
- required: false
- description: Width of the range bar (default = 160)
- values: .*
- - name: Height
- required: false
- description: Height of the range bar (default = 25)
- values: .*
-VALUERANGECOLUMN:
- summary: Displays a graphical representation of where
- an item's value falls within a range vertically and its value in a VALUE widget.
- parameters:
- - name: Target name
- required: true
- description: The target name
- values: <%= System.targets.keys %>
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -852,49 +832,92 @@
values: .*
- name: Height
required: false
description: Height of the range bar (default = 25)
values: .*
+# VALUERANGECOLUMN:
+# summary: Displays a graphical representation of where
+# an item's value falls within a range vertically and its value in a VALUE widget.
+# parameters:
+# - 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: Low Value
+# required: true
+# description: Minimum value to display on the range bar. If the telemetry
+# item goes below this value the bar is “pegged” on the low end.
+# values: .+
+# - name: High Value
+# required: true
+# description: Maximum value to display on the range bar. If the telemetry
+# item goes above this value the bar is “pegged” on the high end.
+# values: .+
+# - name: Value type
+# required: false
+# description: The type of the value to display. Default is CONVERTED.
+# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
+# - name: Number of characters
+# required: false
+# description: The number of characters wide to make the value box (default = 12)
+# values: .*
+# - name: Width
+# required: false
+# description: Width of the range bar (default = 160)
+# values: .*
+# - name: Height
+# required: false
+# description: Height of the range bar (default = 25)
+# values: .*
LINEGRAPH:
summary: Displays a line graph of a telemetry items value
verses sample number
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
required: true
description: The item name
values: .+
- - name: Num Samples
- required: false
- description: Number of samples to display on the graph (default = 100)
- values: .*
- - name: Width
- required: false
- description: Width of the graph (default = 300)
- values: .*
- - name: Height
- required: false
- description: Height of the graph (default = 200)
- values: .*
- - name: Value type
- required: false
- description: The type of the value to display. Default is CONVERTED.
- values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
+ # TODO: This is how the old one worked ... current doesn't match
+ # - name: Num Samples
+ # required: false
+ # description: Number of samples to display on the graph (default = 100)
+ # values: .*
+ # - name: Width
+ # required: false
+ # description: Width of the graph (default = 300)
+ # values: .*
+ # - name: Height
+ # required: false
+ # description: Height of the graph (default = 200)
+ # values: .*
+ # - name: Value type
+ # required: false
+ # description: The type of the value to display. Default is CONVERTED.
+ # values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
PROGRESSBAR:
summary: Displays a progress bar that is useful for displaying percentages
parmeters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -919,11 +942,11 @@
item's value falls withing a range horizontally.
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -950,55 +973,55 @@
values: .*
- name: Height
required: false
description: Height of the range bar (default = 25)
values: .*
-RANGECOLUMN:
- summary: Displays a graphical representation of where
- an item's value falls withing a range vertically
- parameters:
- - name: Target name
- required: true
- description: The target name
- values: <%= System.targets.keys %>
- - name: Packet name
- required: true
- description: The packet name
- values: .+
- - name: Item name
- required: true
- description: The item name
- values: .+
- - name: Low Value
- required: true
- description: Minimum value to display on the range bar. If the telemetry
- item goes below this value the bar is “pegged” on the low end.
- values: .+
- - name: High Value
- required: true
- description: Maximum value to display on the range bar. If the telemetry
- item goes above this value the bar is “pegged” on the high end.
- values: .+
- - name: Value type
- required: false
- description: The type of the value to display. Default is CONVERTED.
- values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
- - name: Width
- required: false
- description: Width of the range bar (default = 30)
- values: .*
- - name: Height
- required: false
- description: Height of the range bar (default = 100)
- values: .*
+# RANGECOLUMN:
+# summary: Displays a graphical representation of where
+# an item's value falls withing a range vertically
+# parameters:
+# - 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: Low Value
+# required: true
+# description: Minimum value to display on the range bar. If the telemetry
+# item goes below this value the bar is “pegged” on the low end.
+# values: .+
+# - name: High Value
+# required: true
+# description: Maximum value to display on the range bar. If the telemetry
+# item goes above this value the bar is “pegged” on the high end.
+# values: .+
+# - name: Value type
+# required: false
+# description: The type of the value to display. Default is CONVERTED.
+# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
+# - name: Width
+# required: false
+# description: Width of the range bar (default = 30)
+# values: .*
+# - name: Height
+# required: false
+# description: Height of the range bar (default = 100)
+# values: .*
TEXTBOX:
summary: Provides a large box for multiline text
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -1011,129 +1034,130 @@
values: .*
- name: Height
required: false
description: Height of the range bar (default = 100)
values: .*
-TIMEGRAPH:
- summary: Displays a line graph of a telemetry items value verses time
- parameters:
- - name: Target name
- required: true
- description: The target name
- values: <%= System.targets.keys %>
- - name: Packet name
- required: true
- description: The packet name
- values: .+
- - name: Item name
- required: true
- description: The item name
- values: .+
- - name: Num Samples
- required: false
- description: Number of samples to display on graph (default = 100)
- values: .*
- - name: Width
- required: false
- description: Width of the graph (default = 300)
- values: .*
- - name: Height
- required: false
- description: Height of the graph (default = 200)
- values: .*
- - name: Show Points
- required: false
- description: Whether to show points or just draw lines between points (default = true)
- values: ['TRUE','FALSE']
- - name: Time item name
- required: false
- description: The telemetry item to use as the time on the X axis (default = TIMESECONDS)
- value: .*
- - name: Value type
- required: false
- description: The type of the value to display. Default is CONVERTED.
- values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
-TRENDBAR:
- summary: Provides the same functionality as the LIMITSBAR
- widget except that it also keeps a history of the telemetry item and
- graphically shows where the value was X seconds ago.
- parameters:
- - name: Target name
- required: true
- description: The target name
- values: <%= System.targets.keys %>
- - 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 FORMATTED WITH_UNITS) %>
- - name: Trend Seconds
- required: false
- description: The number of seconds in the past to display the trend value (default = 60)
- values: .*
- - name: Width
- required: false
- description: Width of the limits bar (default = 160)
- values: .*
- - name: Height
- required: false
- description: Height of the limits bar (default = 25)
- values: .*
-TRENDLIMITSBAR:
- summary: Displays a VALUE widget to show the telemetry items current value,
- a VALUE widget to display the value of the item X seconds ago, and a TRENDBAR
- widget to display the items value within its limits ranges and its trend.
- parameters:
- - name: Target name
- required: true
- description: The target name
- values: <%= System.targets.keys %>
- - 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 FORMATTED WITH_UNITS) %>
- - name: Trend Seconds
- required: false
- description: The number of seconds in the past to display the trend value (default = 60)
- values: .*
- - name: Characters
- required: false
- description: The number of characters to display the telemetry value (default = 12)
- values: .*
- - name: Width
- required: false
- description: Width of the limits bar (default = 160)
- values: .*
- - name: Height
- required: false
- description: Height of the limits bar (default = 25)
- values: .*
+# TIMEGRAPH:
+# summary: Displays a line graph of a telemetry items value verses time
+# parameters:
+# - 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: Num Samples
+# required: false
+# description: Number of samples to display on graph (default = 100)
+# values: .*
+# - name: Width
+# required: false
+# description: Width of the graph (default = 300)
+# values: .*
+# - name: Height
+# required: false
+# description: Height of the graph (default = 200)
+# values: .*
+# - name: Show Points
+# required: false
+# description: Whether to show points or just draw lines between points (default = true)
+# values: ["TRUE", "FALSE"]
+# - name: Time item name
+# required: false
+# description: The telemetry item to use as the time on the X axis (default = TIMESECONDS)
+# values: .*
+# - name: Value type
+# required: false
+# description: The type of the value to display. Default is CONVERTED.
+# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
+# TRENDBAR:
+# summary: Provides the same functionality as the LIMITSBAR
+# widget except that it also keeps a history of the telemetry item and
+# graphically shows where the value was X seconds ago.
+# parameters:
+# - 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 FORMATTED WITH_UNITS) %>
+# - name: Trend Seconds
+# required: false
+# description: The number of seconds in the past to display the trend value (default = 60)
+# values: .*
+# - name: Width
+# required: false
+# description: Width of the limits bar (default = 160)
+# values: .*
+# - name: Height
+# required: false
+# description: Height of the limits bar (default = 25)
+# values: .*
+# TRENDLIMITSBAR:
+# summary: Displays a VALUE widget to show the telemetry items current value,
+# a VALUE widget to display the value of the item X seconds ago, and a TRENDBAR
+# widget to display the items value within its limits ranges and its trend.
+# parameters:
+# - 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 FORMATTED WITH_UNITS) %>
+# - name: Trend Seconds
+# required: false
+# description: The number of seconds in the past to display the trend value (default = 60)
+# values: .*
+# - name: Characters
+# required: false
+# description: The number of characters to display the telemetry value (default = 12)
+# values: .*
+# - name: Width
+# required: false
+# description: Width of the limits bar (default = 160)
+# values: .*
+# - name: Height
+# required: false
+# description: Height of the limits bar (default = 25)
+# values: .*
VALUE:
- summary: The VALUE widget displays a box with a value printed inside. The white
+ summary:
+ The VALUE widget displays a box with a value printed inside. The white
portion of the box darkens to gray while the value remains stagnant, then
brightens to white each time the value changes. Additionally the value is
colored based on the items limits state (Red for example if it is out of limits).
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -1148,15 +1172,17 @@
required: false
description: The number of characters wide to make the value box (default = 12)
values: .*
BUTTON:
summary: Displays a rectangular clickable button
- description: Upon clicking, the button executes the Ruby code assigned. Buttons
+ description:
+ Upon clicking, the button executes the Ruby code assigned. Buttons
can be used to send commands and perform other tasks. If you want your button
to use values from other widgets, define them as named widgets and read their
values using the get_named_widget("WIDGET_NAME").text method.
- warning: If your button logic gets complex it's recommended to require a separate
+ warning:
+ If your button logic gets complex it's recommended to require a separate
script and pass the screen to the script using self,
e.g. require utility.rb; utility_method(self).
parameters:
- name: Button Text
required: true
@@ -1164,29 +1190,10 @@
values: .+
- name: Button Code
required: true
description: Ruby code to execute when the button is pressed
values: .+
-BACKGROUNDBUTTON:
- summary: Displays a rectangular clickable button
- description: Upon clicking, the button executes the Ruby code assigned in a new thread
- so the code executes in the background (not in the GUI thread). Buttons
- can be used to send commands and perform other tasks. If you want your button
- to use values from other widgets, define them as named widgets and read their
- values using the get_named_widget("WIDGET_NAME").text method.
- warning: If your button logic gets complex it's recommended to require a separate
- script and pass the screen to the script using self,
- e.g. require utility.rb; utility_method(self).
- parameters:
- - name: Button Text
- required: true
- description: Text displayed on the button
- values: .+
- - name: Button Code
- required: true
- description: Ruby code to execute when the button is pressed
- values: .+
CHECKBUTTON:
summary: Displays a check box
description: Note this is of limited use by itself and is primarily used in
conjunction with NAMED_WIDGET.
parameters:
@@ -1200,15 +1207,24 @@
conjunction with NAMED_WIDGET.
parameters:
- name: Option Text
required: true
description: Text to display in the selection drop down
- value: .+
+ values: .+
+RADIOGROUP:
+ summary: Creates a group of RADIOBUTTONs
+ description: RADIOBUTTONs must be part of a group to enable selection logic
+ parameters:
+ - name: Initial selected button
+ required: false
+ description: Selects a radio button at initialization (0-based)
+ values: \d+
RADIOBUTTON:
summary: Displays a radio button and text
description: Note this is of limited use by itself and is primarily used in
- conjunction with NAMED_WIDGET.
+ conjunction with NAMED_WIDGET. It must be contained by a RADIOGROUP to enable
+ typical selection of a single RADIOBUTTON.
parameters:
- name: Text
required: true
description: Text to display next to the radio button
values: .+
@@ -1221,23 +1237,10 @@
values: .*
- name: Text
required: false
description: Default text to put in the text field (default is blank)
values: .*
-SCREENSHOTBUTTON:
- summary: Creates a button which takes a screenshot of the screen it is on
- description: The screenshot automatically gets placed in the outputs/logs directory
- with the current date / time and the name of the window.
- parameters:
- - name: Button Text
- required: false
- description: The text on the button, default is 'Screenshot'.
- values: .*
- - name: Screenshot Directory
- required: false
- description: The directory to put the screenshot. Default is output/logs.
- values: .*
CANVAS:
summary: Layout widget for the other canvas widgets
description: All canvas widgets must be enclosed within a CANVAS widget.
warning: The canvas coordinate frame places (0,0) in the upper-left corner of the canvas.
parameters:
@@ -1276,11 +1279,11 @@
summary: Draws the text value of a telemetry item onto the canvas in an optional frame
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -1304,11 +1307,11 @@
description: Color of the text
values: .+
- name: Frame
required: false
description: Whether to draw a frame around the value
- values: ['FALSE', 'TRUE']
+ values: ["FALSE", "TRUE"]
- name: Frame Width
required: false
description: Frame width in pixels
values: .*
- name: Value type
@@ -1335,11 +1338,11 @@
summary: Displays a GIF image on the canvas that changes with a telemetry value
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -1391,19 +1394,19 @@
values: \d+
- name: Connector
required: false
description: Indicates whether or not to draw a circle at the endpoint of
the line
- values: ['NO_CONNECTOR','CONNECTOR']
+ values: ["NO_CONNECTOR", "CONNECTOR"]
CANVASLINEVALUE:
summary: Draws a line onto the canvas in one of two colors based on the value
of the associated telemetry item
parameters:
- name: Target name
required: true
description: The target name
- values: <%= System.targets.keys %>
+ values: .+
- name: Packet name
required: true
description: The packet name
values: .+
- name: Item name
@@ -1442,11 +1445,11 @@
values: \d+
- name: Connector
required: false
description: Indicates whether or not to draw a circle at the endpoint of
the line
- values: ['NO_CONNECTOR','CONNECTOR']
+ values: ["NO_CONNECTOR", "CONNECTOR"]
- name: Value type
required: false
description: The type of the value to display. Default is RAW
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
CANVASDOT:
@@ -1467,36 +1470,36 @@
values: .+
- name: Width
required: false
description: Width of the dot in pixels (default = 3)
values: \d+
-CANVASELLIPSE:
- summary: The CANVASELLIPSE widget draws an ellipse onto the canvas
- parameters:
- - name: X Center
- required: true
- description: X position of the center of the ellipse
- values: \d+
- - name: Y Center
- required: true
- description: Y position of the center of the ellipse
- values: \d+
- - name: Width
- required: true
- description: Width of the ellipse in pixels
- values: \d+
- - name: Height
- required: true
- description: Height of the ellipse in pixels
- values: \d+
- - name: Color
- required: false
- description: Color of the ellipse. Default is black.
- values: .+
- - name: Line Width
- required: false
- description: Width of the line. Default is 1
- values: \d+
- - name: Fill
- required: false
- description: Whether to fill the ellipse. Default is false.
- values: .+
+# CANVASELLIPSE:
+# summary: The CANVASELLIPSE widget draws an ellipse onto the canvas
+# parameters:
+# - name: X Center
+# required: true
+# description: X position of the center of the ellipse
+# values: \d+
+# - name: Y Center
+# required: true
+# description: Y position of the center of the ellipse
+# values: \d+
+# - name: Width
+# required: true
+# description: Width of the ellipse in pixels
+# values: \d+
+# - name: Height
+# required: true
+# description: Height of the ellipse in pixels
+# values: \d+
+# - name: Color
+# required: false
+# description: Color of the ellipse. Default is black.
+# values: .+
+# - name: Line Width
+# required: false
+# description: Width of the line. Default is 1
+# values: \d+
+# - name: Fill
+# required: false
+# description: Whether to fill the ellipse. Default is false.
+# values: .+