openc3 5.5.0 → 5.5.2.pre.beta0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of openc3 might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/data/config/_canvas_values.yaml +42 -0
- data/data/config/_graph_params.yaml +25 -0
- data/data/config/command.yaml +8 -3
- data/data/config/command_modifiers.yaml +26 -21
- data/data/config/graph_settings.yaml +54 -0
- data/data/config/interface_modifiers.yaml +8 -2
- data/data/config/item_modifiers.yaml +2 -2
- data/data/config/microservice.yaml +8 -1
- data/data/config/plugins.yaml +1 -0
- data/data/config/screen.yaml +45 -50
- data/data/config/settings.yaml +144 -0
- data/data/config/target.yaml +4 -0
- data/data/config/telemetry.yaml +15 -13
- data/data/config/telemetry_modifiers.yaml +9 -4
- data/data/config/tool.yaml +1 -0
- data/data/config/widgets.yaml +1745 -1493
- data/lib/openc3/api/settings_api.rb +12 -18
- data/lib/openc3/models/interface_model.rb +5 -2
- data/lib/openc3/models/microservice_model.rb +6 -5
- data/lib/openc3/models/plugin_model.rb +3 -1
- data/lib/openc3/models/scope_model.rb +5 -3
- data/lib/openc3/models/{settings_model.rb → setting_model.rb} +1 -1
- data/lib/openc3/models/tool_config_model.rb +6 -2
- data/lib/openc3/operators/microservice_operator.rb +2 -2
- data/lib/openc3/script/api_shared.rb +4 -0
- data/lib/openc3/utilities/authentication.rb +1 -1
- data/lib/openc3/utilities/aws_bucket.rb +6 -6
- data/lib/openc3/utilities/bucket.rb +1 -1
- data/lib/openc3/utilities/local_mode.rb +62 -7
- data/lib/openc3/utilities/redis_secrets.rb +4 -4
- data/lib/openc3/utilities/secrets.rb +5 -5
- data/lib/openc3/version.rb +6 -6
- data/templates/target/targets/TARGET/lib/target.rb +1 -1
- data/templates/target/targets/TARGET/screens/status.txt +1 -2
- metadata +9 -6
- data/lib/openc3/models/traefik_model.rb +0 -47
data/data/config/widgets.yaml
CHANGED
@@ -1,1497 +1,1749 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
- name: Vertical Spacing
|
9
|
-
required: false
|
10
|
-
description: Vertical spacing between widgets in pixels (default = 1)
|
11
|
-
values: .*
|
12
|
-
- name: Vertical Packing
|
13
|
-
required: false
|
14
|
-
description: Pack all widgets vertically (default = true)
|
15
|
-
values: .*
|
16
|
-
VERTICALBOX:
|
17
|
-
summary: Places the widgets it encapsulates vertically inside a thin border
|
18
|
-
description: The VERTICALBOX widget sizes itself
|
19
|
-
to fit its contents vertically and to fit the screen horizontally
|
20
|
-
parameters:
|
21
|
-
- name: Title
|
22
|
-
required: false
|
23
|
-
description: Text to place within the border to label the box
|
24
|
-
values: .*
|
25
|
-
- name: Vertical spacing
|
26
|
-
required: false
|
27
|
-
description: Vertical spacing between widgets in pixels (default = 1)
|
28
|
-
values: .*
|
29
|
-
- name: Vertical packing
|
30
|
-
required: false
|
31
|
-
description: Pack all widgets vertically (default = true)
|
32
|
-
values: .*
|
33
|
-
HORIZONTAL:
|
34
|
-
summary: Places the widgets it encapsulates horizontally
|
35
|
-
description: The HORIZONTAL widget sizes itself to fit its contents
|
36
|
-
parameters:
|
37
|
-
- name: Horizontal spacing
|
38
|
-
required: false
|
39
|
-
description: Horizontal spacing between widgets in pixels (default = 1)
|
40
|
-
values: .*
|
41
|
-
HORIZONTALBOX:
|
42
|
-
summary: Places the widgets it encapsulates horizontally inside a thin border
|
43
|
-
description: The HORIZONTALBOX widget sizes itself to fit its contents
|
44
|
-
parameters:
|
45
|
-
- name: Title
|
46
|
-
required: false
|
47
|
-
description: Text to place within the border to label the box
|
48
|
-
values: .*
|
49
|
-
- name: Horizontal spacing
|
50
|
-
required: false
|
51
|
-
description: Horizontal spacing between widgets in pixels (default = 1)
|
52
|
-
values: .*
|
53
|
-
MATRIXBYCOLUMNS:
|
54
|
-
summary: Places the widgets into a table-like matrix
|
55
|
-
description: The MATRIXBYCOLUMNS widget sizes itself to fit its contents
|
56
|
-
parameters:
|
57
|
-
- name: Columns
|
58
|
-
required: true
|
59
|
-
description: The number of columns to create
|
60
|
-
values: .*
|
61
|
-
- name: Horizontal spacing
|
62
|
-
required: false
|
63
|
-
description: Horizontal spacing between matix items in pixels (default = 0)
|
64
|
-
values: .*
|
65
|
-
- name: Vertical spacing
|
66
|
-
required: false
|
67
|
-
description: Vertical spacing between matrix items in pixels (default = 0)
|
68
|
-
values: .*
|
69
|
-
SCROLLWINDOW:
|
70
|
-
summary: Places the widgets inside of it into a scrollable area
|
71
|
-
description: The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained
|
72
|
-
parameters:
|
73
|
-
- name: Height
|
74
|
-
required: false
|
75
|
-
description: Maximum height of the scroll window in pixels (default = 180)
|
76
|
-
values: .*
|
77
|
-
SPACER:
|
78
|
-
summary: Places a fixed size spacer in between widgets
|
79
|
-
parameters:
|
80
|
-
- name: Width
|
81
|
-
required: false
|
82
|
-
description: Width of the widget
|
83
|
-
values: .*
|
84
|
-
- name: Height
|
85
|
-
required: false
|
86
|
-
description: Height of the widget
|
87
|
-
values: .*
|
88
|
-
IFRAME:
|
89
|
-
summary: Open external tools in an Iframe within OpenC3
|
90
|
-
parameters:
|
91
|
-
- name: URL
|
92
|
-
required: true
|
93
|
-
description: The path to the page to display in the iframe
|
94
|
-
values: .*
|
95
|
-
- name: Width
|
96
|
-
required: false
|
97
|
-
description: Width of the widget
|
98
|
-
values: .*
|
99
|
-
- name: Height
|
100
|
-
required: false
|
101
|
-
description: Height of the widget
|
102
|
-
values: .*
|
103
|
-
IMAGEVIEWER:
|
104
|
-
summary: Display a base64 image from a TLM packet
|
105
|
-
parameters:
|
106
|
-
- name: Target name
|
107
|
-
required: true
|
108
|
-
description: The target name
|
109
|
-
values: .+
|
110
|
-
- name: Packet name
|
111
|
-
required: true
|
112
|
-
description: The packet name
|
113
|
-
values: .+
|
114
|
-
- name: Item name
|
115
|
-
required: true
|
116
|
-
description: The item name
|
117
|
-
values: .+
|
118
|
-
- name: Format
|
119
|
-
required: true
|
120
|
-
description: The image format of the base64 data (e.g. jpg, png, etc)
|
121
|
-
values: .+
|
122
|
-
- name: Width
|
123
|
-
required: false
|
124
|
-
description: Width of the widget
|
125
|
-
values: .*
|
126
|
-
- name: Height
|
127
|
-
required: false
|
128
|
-
description: Height of the widget
|
129
|
-
values: .*
|
130
|
-
TABBOOK:
|
131
|
-
summary: Creates a tabbed area in which to place TABITEM widgets
|
132
|
-
TABITEM:
|
133
|
-
summary: Creates a VERTICAL layout tab into which to place widgets
|
134
|
-
parameters:
|
135
|
-
- name: Tab text
|
136
|
-
required: true
|
137
|
-
description: Text to diplay in the tab
|
138
|
-
values: .*
|
139
|
-
LABEL:
|
140
|
-
summary: Displays text on the screen
|
141
|
-
description: Generally, label widgets contain a telemetry mnemonic and are placed next to the telemetry VALUE widget
|
142
|
-
parameters:
|
143
|
-
- name: Text
|
144
|
-
required: true
|
145
|
-
description: Text to display on the label
|
146
|
-
values: .*
|
147
|
-
# HORIZONTALLINE:
|
148
|
-
# summary: Displays a horizontal line on the screen that can be used as a separator
|
149
|
-
SECTIONHEADER:
|
150
|
-
summary: Displays a label that is underlined with a horizontal line
|
151
|
-
description: Generally, SECTIONHEADER widgets are the first widget placed
|
152
|
-
inside of a VERTICALBOX widget
|
153
|
-
parameters:
|
154
|
-
- name: Text
|
155
|
-
required: true
|
156
|
-
description: Text to display above the horizontal line
|
157
|
-
values: .*
|
158
|
-
TITLE:
|
159
|
-
summary: Displays a large centered title on the screen
|
160
|
-
parameters:
|
161
|
-
- name: Text
|
162
|
-
required: true
|
163
|
-
description: Text to display above the horizontal line
|
164
|
-
values: .*
|
165
|
-
ARRAY:
|
166
|
-
summary: Displays ARRAY data organized into rows and space separated
|
167
|
-
parameters:
|
168
|
-
- name: Target name
|
169
|
-
required: true
|
170
|
-
description: The target name
|
171
|
-
values: .+
|
172
|
-
- name: Packet name
|
173
|
-
required: true
|
174
|
-
description: The packet name
|
175
|
-
values: .+
|
176
|
-
- name: Item name
|
177
|
-
required: true
|
178
|
-
description: The item name
|
179
|
-
values: .+
|
180
|
-
- name: Width
|
181
|
-
required: false
|
182
|
-
description: Width of the widget (default = 200)
|
183
|
-
values: .*
|
184
|
-
- name: Height
|
185
|
-
required: false
|
186
|
-
description: Height of the widget (default = 100)
|
187
|
-
values: .*
|
188
|
-
- name: Format string
|
189
|
-
required: false
|
190
|
-
description: Format string applied to each array item (default = nil)
|
191
|
-
values: .*
|
192
|
-
- name: Items per row
|
193
|
-
required: false
|
194
|
-
description: Number of array items per row (default = 4)
|
195
|
-
values: .*
|
196
|
-
- name: Value type
|
197
|
-
required: false
|
198
|
-
description: The type of the value to display. Default is CONVERTED.
|
199
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
200
|
-
BLOCK:
|
201
|
-
summary: Displays BLOCK data organized into rows and space separated
|
202
|
-
parameters:
|
203
|
-
- name: Target name
|
204
|
-
required: true
|
205
|
-
description: The target name
|
206
|
-
values: .+
|
207
|
-
- name: Packet name
|
208
|
-
required: true
|
209
|
-
description: The packet name
|
210
|
-
values: .+
|
211
|
-
- name: Item name
|
212
|
-
required: true
|
213
|
-
description: The item name
|
214
|
-
values: .+
|
215
|
-
- name: Width
|
216
|
-
required: false
|
217
|
-
description: Width of the widget (default = 200)
|
218
|
-
values: .*
|
219
|
-
- name: Height
|
220
|
-
required: false
|
221
|
-
description: Height of the widget (default = 100)
|
222
|
-
values: .*
|
223
|
-
- name: Format string
|
224
|
-
required: false
|
225
|
-
description: Format string applied to each array item (default = nil)
|
226
|
-
values: .*
|
227
|
-
- name: Bytes per word
|
228
|
-
required: false
|
229
|
-
description: Number of bytes per word (default = 4)
|
230
|
-
values: .*
|
231
|
-
- name: Words per row
|
232
|
-
required: false
|
233
|
-
description: Number of words per row (default = 4
|
234
|
-
values: .*
|
235
|
-
- name: Address format
|
236
|
-
required: false
|
237
|
-
description: Format for the address printed at the beginning of each line
|
238
|
-
(default = nil which means do not print an address)
|
239
|
-
values: .*
|
240
|
-
- name: Value type
|
241
|
-
required: false
|
242
|
-
description: The type of the value to display. Default is CONVERTED.
|
243
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
244
|
-
# FORMATFONTVALUE:
|
245
|
-
# summary: Displays a box with a value printed inside
|
246
|
-
# that is formatted by the specified string rather than by a format string given
|
247
|
-
# in the telemetry definition files. Additionally, this widget can use a specified
|
248
|
-
# font. The white portion of the box darkens to gray while the value remains
|
249
|
-
# stagnant, then brightens to white each time the value changes. Additionally
|
250
|
-
# the value is colored based on the items limits state (Red for example if it is out of limits).
|
251
|
-
# parameters:
|
252
|
-
# - name: Target name
|
253
|
-
# required: true
|
254
|
-
# description: The target name
|
255
|
-
# values: .+
|
256
|
-
# - name: Packet name
|
257
|
-
# required: true
|
258
|
-
# description: The packet name
|
259
|
-
# values: .+
|
260
|
-
# - name: Item name
|
261
|
-
# required: true
|
262
|
-
# description: The item name
|
263
|
-
# values: .+
|
264
|
-
# - name: Format string
|
265
|
-
# required: false
|
266
|
-
# description: Printf style format string to apply to the telemetry item
|
267
|
-
# values: .*
|
268
|
-
# - name: Value type
|
269
|
-
# required: false
|
270
|
-
# description: The type of the value to display. Default is CONVERTED.
|
271
|
-
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
272
|
-
# - name: Number of characters
|
273
|
-
# required: false
|
274
|
-
# description: The number of characters wide to make the value box (default = 12)
|
275
|
-
# values: .*
|
276
|
-
# - name: Font name
|
277
|
-
# required: false
|
278
|
-
# description: The font to use. (default = arial)
|
279
|
-
# values: .*
|
280
|
-
# - name: Font size
|
281
|
-
# required: false
|
282
|
-
# description: The font size. (default = 100)
|
283
|
-
# values: .*
|
284
|
-
FORMATVALUE:
|
285
|
-
summary: Displays a box with a formatted value
|
286
|
-
description:
|
287
|
-
Data is formatted by the specified string rather than by a format string given in
|
288
|
-
the telemetry definition files. The white portion of the box darkens to gray
|
289
|
-
while the value remains stagnant, then brightens to white each time the value
|
290
|
-
changes. Additionally the value is colored based on the items limits state
|
291
|
-
(Red for example if it is out of limits).
|
292
|
-
parameters:
|
293
|
-
- name: Target name
|
294
|
-
required: true
|
295
|
-
description: The target name
|
296
|
-
values: .+
|
297
|
-
- name: Packet name
|
298
|
-
required: true
|
299
|
-
description: The packet name
|
300
|
-
values: .+
|
301
|
-
- name: Item name
|
302
|
-
required: true
|
303
|
-
description: The item name
|
304
|
-
values: .+
|
305
|
-
- name: Format string
|
306
|
-
required: false
|
307
|
-
description: Printf style format string to apply to the telemetry item
|
308
|
-
values: .*
|
309
|
-
- name: Value type
|
310
|
-
required: false
|
311
|
-
description: The type of the value to display. Default is CONVERTED.
|
312
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
313
|
-
- name: Number of characters
|
314
|
-
required: false
|
315
|
-
description: The number of characters wide to make the value box (default = 12)
|
316
|
-
values: .*
|
317
|
-
LABELLED:
|
318
|
-
summary: Displays a LABEL followed by a LED
|
319
|
-
parameters:
|
320
|
-
- name: Target name
|
321
|
-
required: true
|
322
|
-
description: The target name
|
323
|
-
values: .+
|
324
|
-
- name: Packet name
|
325
|
-
required: true
|
326
|
-
description: The packet name
|
327
|
-
values: .+
|
328
|
-
- name: Item name
|
329
|
-
required: true
|
330
|
-
description: The item name
|
331
|
-
values: .+
|
332
|
-
- name: Value type
|
333
|
-
required: false
|
334
|
-
description: The type of the value to display. Default is CONVERTED.
|
335
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
336
|
-
- name: Width
|
337
|
-
required: false
|
338
|
-
description: Width of the LED circle (default = 15)
|
339
|
-
values: .*
|
340
|
-
- name: Height
|
341
|
-
required: false
|
342
|
-
description: Height of the LED circle (default = 15)
|
343
|
-
values: .*
|
344
|
-
- name: Justification
|
345
|
-
required: false
|
346
|
-
description: How to justify the label and LED together. The default of
|
347
|
-
'SPLIT' aligns the label to the left and the LED to the right with any
|
348
|
-
additional space going between them. 'CENTER' pushes the label and LED
|
349
|
-
together with any additional space to the left and right. 'LEFT' or 'RIGHT'
|
350
|
-
pushes them to the respective side with the space going on the opposite.
|
351
|
-
values: ["SPLIT", "CENTER", "LEFT", "RIGHT"]
|
352
|
-
LABELPROGRESSBAR:
|
353
|
-
summary: Displays a LABEL with the item name followed by a PROGRESSBAR
|
354
|
-
parameters:
|
355
|
-
- name: Target name
|
356
|
-
required: true
|
357
|
-
description: The target name
|
358
|
-
values: .+
|
359
|
-
- name: Packet name
|
360
|
-
required: true
|
361
|
-
description: The packet name
|
362
|
-
values: .+
|
363
|
-
- name: Item name
|
364
|
-
required: true
|
365
|
-
description: The item name
|
366
|
-
values: .+
|
367
|
-
- name: Scale factor
|
368
|
-
required: false
|
369
|
-
description: Value to multiple the telemetry item by before displaying the
|
370
|
-
in the progress bar. Final value should be in the range of 0 to 100. Default is 1.0.
|
371
|
-
values: .*
|
372
|
-
- name: Width
|
373
|
-
required: false
|
374
|
-
description: Width of the progress bar (default = 80 pixels
|
375
|
-
values: .*
|
376
|
-
- name: Value type
|
377
|
-
required: false
|
378
|
-
description: The type of the value to display. Default is CONVERTED.
|
379
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
380
|
-
LABELVALUE:
|
381
|
-
summary: Displays a LABEL with the item name followed by a VALUE
|
382
|
-
parameters:
|
383
|
-
- name: Target name
|
384
|
-
required: true
|
385
|
-
description: The target name
|
386
|
-
values: .+
|
387
|
-
- name: Packet name
|
388
|
-
required: true
|
389
|
-
description: The packet name
|
390
|
-
values: .+
|
391
|
-
- name: Item name
|
392
|
-
required: true
|
393
|
-
description: The item name
|
394
|
-
values: .+
|
395
|
-
- name: Value type
|
396
|
-
required: false
|
397
|
-
description: The type of the value to display. Default is CONVERTED.
|
398
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
399
|
-
- name: Number of characters
|
400
|
-
required: false
|
401
|
-
description: The number of characters wide to make the value box (default = 12)
|
402
|
-
values: .*
|
403
|
-
- name: Justification
|
404
|
-
required: false
|
405
|
-
description: How to justify the label and value together. The default of
|
406
|
-
'SPLIT' aligns the label to the left and the value to the right with any
|
407
|
-
additional space going between them. 'CENTER' pushes the label and value
|
408
|
-
together with any additional space to the left and right. 'LEFT' or 'RIGHT'
|
409
|
-
pushes them to the respective side with the space going on the opposite.
|
410
|
-
values: ["SPLIT", "CENTER", "LEFT", "RIGHT"]
|
411
|
-
LABELVALUEDESC:
|
412
|
-
summary: Displays a LABEL with the items description followed by a VALUE
|
413
|
-
parameters:
|
414
|
-
- name: Target name
|
415
|
-
required: true
|
416
|
-
description: The target name
|
417
|
-
values: .+
|
418
|
-
- name: Packet name
|
419
|
-
required: true
|
420
|
-
description: The packet name
|
421
|
-
values: .+
|
422
|
-
- name: Item name
|
423
|
-
required: true
|
424
|
-
description: The item name
|
425
|
-
values: .+
|
426
|
-
- name: Description
|
427
|
-
required: false
|
2
|
+
Layout Widgets:
|
3
|
+
description: Layout widgets are used to position other widgets on the screen.
|
4
|
+
For example, the HORIZONTAL layout widget places the widgets it encapsulates horizontally on the screen.
|
5
|
+
collection:
|
6
|
+
VERTICAL:
|
7
|
+
summary: Places the widgets it encapsulates vertically
|
428
8
|
description:
|
429
|
-
The
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
|
448
|
-
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
473
|
-
|
474
|
-
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
|
491
|
-
|
492
|
-
|
493
|
-
|
494
|
-
|
495
|
-
|
496
|
-
|
497
|
-
|
498
|
-
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
|
518
|
-
|
519
|
-
|
520
|
-
|
521
|
-
|
522
|
-
|
523
|
-
|
524
|
-
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
|
532
|
-
|
533
|
-
|
534
|
-
|
535
|
-
|
536
|
-
|
537
|
-
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
|
547
|
-
|
548
|
-
|
549
|
-
|
550
|
-
|
551
|
-
|
552
|
-
|
553
|
-
|
554
|
-
|
555
|
-
|
556
|
-
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
|
561
|
-
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
568
|
-
|
569
|
-
|
570
|
-
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
|
575
|
-
# values: .+
|
576
|
-
# - name: High Value
|
577
|
-
# required: true
|
578
|
-
# description: Maximum value to display on the range bar. If the telemetry
|
579
|
-
# item goes above this value the bar is “pegged” on the high end.
|
580
|
-
# values: .+
|
581
|
-
# - name: Value type
|
582
|
-
# required: false
|
583
|
-
# description: The type of the value to display. Default is CONVERTED.
|
584
|
-
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
585
|
-
# - name: Number of characters
|
586
|
-
# required: false
|
587
|
-
# description: The number of characters wide to make the value box (default = 12)
|
588
|
-
# values: .*
|
589
|
-
# - name: Width
|
590
|
-
# required: false
|
591
|
-
# description: Width of the range bar (default = 160)
|
592
|
-
# values: .*
|
593
|
-
# - name: Height
|
594
|
-
# required: false
|
595
|
-
# description: Height of the range bar (default = 25)
|
596
|
-
# values: .*
|
597
|
-
LED:
|
598
|
-
summary: Displays a LED which changes color based on telemetry values
|
599
|
-
description:
|
600
|
-
By default TRUE is green and FALSE is red and all other values are black.
|
601
|
-
Additional values can be added by using the LED_COLOR setting. For example
|
602
|
-
LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN,
|
603
|
-
SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE.
|
604
|
-
parameters:
|
605
|
-
- name: Target name
|
606
|
-
required: true
|
607
|
-
description: The target name
|
608
|
-
values: .+
|
609
|
-
- name: Packet name
|
610
|
-
required: true
|
611
|
-
description: The packet name
|
612
|
-
values: .+
|
613
|
-
- name: Item name
|
614
|
-
required: true
|
615
|
-
description: The item name
|
616
|
-
values: .+
|
617
|
-
- name: Value type
|
618
|
-
required: false
|
619
|
-
description: The type of the value to display. Default is CONVERTED.
|
620
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
621
|
-
- name: Width
|
622
|
-
required: false
|
623
|
-
description: Width of the LED circle (default = 15)
|
624
|
-
values: .*
|
625
|
-
- name: Height
|
626
|
-
required: false
|
627
|
-
description: Height of the LED circle (default = 15)
|
628
|
-
values: .*
|
629
|
-
LIMITSBAR:
|
630
|
-
summary: Displays an item's current value within its colored limits horizontally
|
631
|
-
parameters:
|
632
|
-
- name: Target name
|
633
|
-
required: true
|
634
|
-
description: The target name
|
635
|
-
values: .+
|
636
|
-
- name: Packet name
|
637
|
-
required: true
|
638
|
-
description: The packet name
|
639
|
-
values: .+
|
640
|
-
- name: Item name
|
641
|
-
required: true
|
642
|
-
description: The item name
|
643
|
-
values: .+
|
644
|
-
- name: Value type
|
645
|
-
required: false
|
646
|
-
description: The type of the value to display. Default is CONVERTED.
|
647
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
648
|
-
- name: Width
|
649
|
-
required: false
|
650
|
-
description: Width of the range bar (default = 160)
|
651
|
-
values: .*
|
652
|
-
- name: Height
|
653
|
-
required: false
|
654
|
-
description: Height of the range bar (default = 25)
|
655
|
-
values: .*
|
656
|
-
LIMITSCOLUMN:
|
657
|
-
summary: Displays an item's current value within its colored limits vertically
|
658
|
-
parameters:
|
659
|
-
- name: Target name
|
660
|
-
required: true
|
661
|
-
description: The target name
|
662
|
-
values: .+
|
663
|
-
- name: Packet name
|
664
|
-
required: true
|
665
|
-
description: The packet name
|
666
|
-
values: .+
|
667
|
-
- name: Item name
|
668
|
-
required: true
|
669
|
-
description: The item name
|
670
|
-
values: .+
|
671
|
-
- name: Value type
|
672
|
-
required: false
|
673
|
-
description: The type of the value to display. Default is CONVERTED.
|
674
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
675
|
-
- name: Width
|
676
|
-
required: false
|
677
|
-
description: Width of the range bar (default = 160)
|
678
|
-
values: .*
|
679
|
-
- name: Height
|
680
|
-
required: false
|
681
|
-
description: Height of the range bar (default = 25)
|
682
|
-
values: .*
|
683
|
-
LIMITSCOLOR:
|
684
|
-
summary: Displays a circle depicting the limits color of an item
|
685
|
-
parameters:
|
686
|
-
- name: Target name
|
687
|
-
required: true
|
688
|
-
description: The target name
|
689
|
-
values: .+
|
690
|
-
- name: Packet name
|
691
|
-
required: true
|
692
|
-
description: The packet name
|
693
|
-
values: .+
|
694
|
-
- name: Item name
|
695
|
-
required: true
|
696
|
-
description: The item name
|
697
|
-
values: .+
|
698
|
-
- name: Value type
|
699
|
-
required: false
|
700
|
-
description: The type of the value to display. Default is CONVERTED.
|
701
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
702
|
-
- name: Radius
|
703
|
-
required: false
|
704
|
-
description: Radius of the circle (default is 10)
|
705
|
-
values: .*
|
706
|
-
- name: Full Item Name
|
707
|
-
required: false
|
708
|
-
description: Show the full item name (default is false)
|
709
|
-
values: .*
|
710
|
-
VALUELIMITSBAR:
|
711
|
-
summary: Displays an item VALUE followed by LIMITSBAR
|
712
|
-
parameters:
|
713
|
-
- name: Target name
|
714
|
-
required: true
|
715
|
-
description: The target name
|
716
|
-
values: .+
|
717
|
-
- name: Packet name
|
718
|
-
required: true
|
719
|
-
description: The packet name
|
720
|
-
values: .+
|
721
|
-
- name: Item name
|
722
|
-
required: true
|
723
|
-
description: The item name
|
724
|
-
values: .+
|
725
|
-
- name: Value type
|
726
|
-
required: false
|
727
|
-
description: The type of the value to display. Default is CONVERTED.
|
728
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
729
|
-
- name: Number of characters
|
730
|
-
required: false
|
731
|
-
description: The number of characters wide to make the value box (default = 12)
|
732
|
-
values: .*
|
733
|
-
VALUELIMITSCOLUMN:
|
734
|
-
summary: Displays an item VALUE followed by LIMITSCOLUMN
|
735
|
-
parameters:
|
736
|
-
- name: Target name
|
737
|
-
required: true
|
738
|
-
description: The target name
|
739
|
-
values: .+
|
740
|
-
- name: Packet name
|
741
|
-
required: true
|
742
|
-
description: The packet name
|
743
|
-
values: .+
|
744
|
-
- name: Item name
|
745
|
-
required: true
|
746
|
-
description: The item name
|
747
|
-
values: .+
|
748
|
-
- name: Value type
|
749
|
-
required: false
|
750
|
-
description: The type of the value to display. Default is CONVERTED.
|
751
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
752
|
-
- name: Number of characters
|
753
|
-
required: false
|
754
|
-
description: The number of characters wide to make the value box (default = 8)
|
755
|
-
values: .*
|
756
|
-
VALUERANGEBAR:
|
757
|
-
summary: Displays an item VALUE followed by RANGEBAR
|
758
|
-
parameters:
|
759
|
-
- name: Target name
|
760
|
-
required: true
|
761
|
-
description: The target name
|
762
|
-
values: .+
|
763
|
-
- name: Packet name
|
764
|
-
required: true
|
765
|
-
description: The packet name
|
766
|
-
values: .+
|
767
|
-
- name: Item name
|
768
|
-
required: true
|
769
|
-
description: The item name
|
770
|
-
values: .+
|
771
|
-
- name: Low Value
|
772
|
-
required: true
|
773
|
-
description: Minimum value to display on the range bar. If the telemetry
|
774
|
-
item goes below this value the bar is “pegged” on the low end.
|
775
|
-
values: .+
|
776
|
-
- name: High Value
|
777
|
-
required: true
|
778
|
-
description: Maximum value to display on the range bar. If the telemetry
|
779
|
-
item goes above this value the bar is “pegged” on the high end.
|
780
|
-
values: .+
|
781
|
-
- name: Value type
|
782
|
-
required: false
|
783
|
-
description: The type of the value to display. Default is CONVERTED.
|
784
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
785
|
-
- name: Number of characters
|
786
|
-
required: false
|
787
|
-
description: The number of characters wide to make the value box (default = 12)
|
788
|
-
values: .*
|
789
|
-
- name: Width
|
790
|
-
required: false
|
791
|
-
description: Width of the range bar (default = 160)
|
792
|
-
values: .*
|
793
|
-
- name: Height
|
794
|
-
required: false
|
795
|
-
description: Height of the range bar (default = 25)
|
796
|
-
values: .*
|
797
|
-
# VALUERANGECOLUMN:
|
798
|
-
# summary: Displays a graphical representation of where
|
799
|
-
# an item's value falls within a range vertically and its value in a VALUE widget.
|
800
|
-
# parameters:
|
801
|
-
# - name: Target name
|
802
|
-
# required: true
|
803
|
-
# description: The target name
|
804
|
-
# values: .+
|
805
|
-
# - name: Packet name
|
806
|
-
# required: true
|
807
|
-
# description: The packet name
|
808
|
-
# values: .+
|
809
|
-
# - name: Item name
|
810
|
-
# required: true
|
811
|
-
# description: The item name
|
812
|
-
# values: .+
|
813
|
-
# - name: Low Value
|
814
|
-
# required: true
|
815
|
-
# description: Minimum value to display on the range bar. If the telemetry
|
816
|
-
# item goes below this value the bar is “pegged” on the low end.
|
817
|
-
# values: .+
|
818
|
-
# - name: High Value
|
819
|
-
# required: true
|
820
|
-
# description: Maximum value to display on the range bar. If the telemetry
|
821
|
-
# item goes above this value the bar is “pegged” on the high end.
|
822
|
-
# values: .+
|
823
|
-
# - name: Value type
|
824
|
-
# required: false
|
825
|
-
# description: The type of the value to display. Default is CONVERTED.
|
826
|
-
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
827
|
-
# - name: Number of characters
|
828
|
-
# required: false
|
829
|
-
# description: The number of characters wide to make the value box (default = 12)
|
830
|
-
# values: .*
|
831
|
-
# - name: Width
|
832
|
-
# required: false
|
833
|
-
# description: Width of the range bar (default = 160)
|
834
|
-
# values: .*
|
835
|
-
# - name: Height
|
836
|
-
# required: false
|
837
|
-
# description: Height of the range bar (default = 25)
|
838
|
-
# values: .*
|
839
|
-
LINEGRAPH:
|
840
|
-
summary: Displays a line graph of a telemetry item
|
841
|
-
parameters:
|
842
|
-
- name: Target name
|
843
|
-
required: true
|
844
|
-
description: The target name
|
845
|
-
values: .+
|
846
|
-
- name: Packet name
|
847
|
-
required: true
|
848
|
-
description: The packet name
|
849
|
-
values: .+
|
850
|
-
- name: Item name
|
851
|
-
required: true
|
852
|
-
description: The item name
|
853
|
-
values: .+
|
854
|
-
# TODO: This is how the old one worked ... current doesn't match
|
855
|
-
# - name: Num Samples
|
856
|
-
# required: false
|
857
|
-
# description: Number of samples to display on the graph (default = 100)
|
858
|
-
# values: .*
|
859
|
-
# - name: Width
|
860
|
-
# required: false
|
861
|
-
# description: Width of the graph (default = 300)
|
862
|
-
# values: .*
|
863
|
-
# - name: Height
|
864
|
-
# required: false
|
865
|
-
# description: Height of the graph (default = 200)
|
866
|
-
# values: .*
|
867
|
-
# - name: Value type
|
868
|
-
# required: false
|
869
|
-
# description: The type of the value to display. Default is CONVERTED.
|
870
|
-
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
871
|
-
SPARKLINE:
|
872
|
-
summary: Displays a sparkline graph (no cursor, scale or legend) of a telemetry item
|
873
|
-
parameters:
|
874
|
-
- name: Target name
|
875
|
-
required: true
|
876
|
-
description: The target name
|
877
|
-
values: .+
|
878
|
-
- name: Packet name
|
879
|
-
required: true
|
880
|
-
description: The packet name
|
881
|
-
values: .+
|
882
|
-
- name: Item name
|
883
|
-
required: true
|
884
|
-
description: The item name
|
885
|
-
values: .+
|
886
|
-
LABELSPARKLINE:
|
887
|
-
summary: Displays a LABEL with the item name followed by a SPARKLINE
|
888
|
-
parameters:
|
889
|
-
- name: Target name
|
890
|
-
required: true
|
891
|
-
description: The target name
|
892
|
-
values: .+
|
893
|
-
- name: Packet name
|
894
|
-
required: true
|
895
|
-
description: The packet name
|
896
|
-
values: .+
|
897
|
-
- name: Item name
|
898
|
-
required: true
|
899
|
-
description: The item name
|
900
|
-
values: .+
|
901
|
-
PROGRESSBAR:
|
902
|
-
summary: Displays a progress bar that is useful for displaying percentages
|
903
|
-
parmeters:
|
904
|
-
- name: Target name
|
905
|
-
required: true
|
906
|
-
description: The target name
|
907
|
-
values: .+
|
908
|
-
- name: Packet name
|
909
|
-
required: true
|
910
|
-
description: The packet name
|
911
|
-
values: .+
|
912
|
-
- name: Item name
|
913
|
-
required: true
|
914
|
-
description: The item name
|
915
|
-
values: .+
|
916
|
-
- name: Scale factor
|
917
|
-
required: false
|
918
|
-
description: Value to multiple the telemetry item by before displaying the
|
919
|
-
in the progress bar. Final value should be in the range of 0 to 100. Default is 1.0.
|
920
|
-
values: .*
|
921
|
-
- name: Width
|
922
|
-
required: false
|
923
|
-
description: Width of the progress bar (default = 100 pixels)
|
924
|
-
values: .*
|
925
|
-
- name: Value type
|
926
|
-
required: false
|
927
|
-
description: The type of the value to display. Default is CONVERTED.
|
928
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
929
|
-
RANGEBAR:
|
930
|
-
summary: Displays a custom range bar displaying the item value
|
931
|
-
parameters:
|
932
|
-
- name: Target name
|
933
|
-
required: true
|
934
|
-
description: The target name
|
935
|
-
values: .+
|
936
|
-
- name: Packet name
|
937
|
-
required: true
|
938
|
-
description: The packet name
|
939
|
-
values: .+
|
940
|
-
- name: Item name
|
941
|
-
required: true
|
942
|
-
description: The item name
|
943
|
-
values: .+
|
944
|
-
- name: Low Value
|
945
|
-
required: true
|
946
|
-
description: Minimum value to display on the range bar. If the telemetry
|
947
|
-
item goes below this value the bar is “pegged” on the low end.
|
948
|
-
values: .+
|
949
|
-
- name: High Value
|
950
|
-
required: true
|
951
|
-
description: Maximum value to display on the range bar. If the telemetry
|
952
|
-
item goes above this value the bar is “pegged” on the high end.
|
953
|
-
values: .+
|
954
|
-
- name: Value type
|
955
|
-
required: false
|
956
|
-
description: The type of the value to display. Default is CONVERTED.
|
957
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
958
|
-
- name: Width
|
959
|
-
required: false
|
960
|
-
description: Width of the range bar (default = 100)
|
961
|
-
values: .*
|
962
|
-
- name: Height
|
963
|
-
required: false
|
964
|
-
description: Height of the range bar (default = 25)
|
965
|
-
values: .*
|
966
|
-
# RANGECOLUMN:
|
967
|
-
# summary: Displays a graphical representation of where
|
968
|
-
# an item's value falls withing a range vertically
|
969
|
-
# parameters:
|
970
|
-
# - name: Target name
|
971
|
-
# required: true
|
972
|
-
# description: The target name
|
973
|
-
# values: .+
|
974
|
-
# - name: Packet name
|
975
|
-
# required: true
|
976
|
-
# description: The packet name
|
977
|
-
# values: .+
|
978
|
-
# - name: Item name
|
979
|
-
# required: true
|
980
|
-
# description: The item name
|
981
|
-
# values: .+
|
982
|
-
# - name: Low Value
|
983
|
-
# required: true
|
984
|
-
# description: Minimum value to display on the range bar. If the telemetry
|
985
|
-
# item goes below this value the bar is “pegged” on the low end.
|
986
|
-
# values: .+
|
987
|
-
# - name: High Value
|
988
|
-
# required: true
|
989
|
-
# description: Maximum value to display on the range bar. If the telemetry
|
990
|
-
# item goes above this value the bar is “pegged” on the high end.
|
991
|
-
# values: .+
|
992
|
-
# - name: Value type
|
993
|
-
# required: false
|
994
|
-
# description: The type of the value to display. Default is CONVERTED.
|
995
|
-
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
996
|
-
# - name: Width
|
997
|
-
# required: false
|
998
|
-
# description: Width of the range bar (default = 30)
|
999
|
-
# values: .*
|
1000
|
-
# - name: Height
|
1001
|
-
# required: false
|
1002
|
-
# description: Height of the range bar (default = 100)
|
1003
|
-
# values: .*
|
1004
|
-
TEXTBOX:
|
1005
|
-
summary: Provides a large box for multiline text
|
1006
|
-
parameters:
|
1007
|
-
- name: Target name
|
1008
|
-
required: true
|
1009
|
-
description: The target name
|
1010
|
-
values: .+
|
1011
|
-
- name: Packet name
|
1012
|
-
required: true
|
1013
|
-
description: The packet name
|
1014
|
-
values: .+
|
1015
|
-
- name: Item name
|
1016
|
-
required: true
|
1017
|
-
description: The item name
|
1018
|
-
values: .+
|
1019
|
-
- name: Width
|
1020
|
-
required: false
|
1021
|
-
description: Width of the textbox in px (default = 200)
|
1022
|
-
values: .*
|
1023
|
-
- name: Height
|
1024
|
-
required: false
|
1025
|
-
description: Height of the textbox in px (default = 200)
|
1026
|
-
values: .*
|
1027
|
-
# TIMEGRAPH:
|
1028
|
-
# summary: Displays a line graph of a telemetry items value verses time
|
1029
|
-
# parameters:
|
1030
|
-
# - name: Target name
|
1031
|
-
# required: true
|
1032
|
-
# description: The target name
|
1033
|
-
# values: .+
|
1034
|
-
# - name: Packet name
|
1035
|
-
# required: true
|
1036
|
-
# description: The packet name
|
1037
|
-
# values: .+
|
1038
|
-
# - name: Item name
|
1039
|
-
# required: true
|
1040
|
-
# description: The item name
|
1041
|
-
# values: .+
|
1042
|
-
# - name: Num Samples
|
1043
|
-
# required: false
|
1044
|
-
# description: Number of samples to display on graph (default = 100)
|
1045
|
-
# values: .*
|
1046
|
-
# - name: Width
|
1047
|
-
# required: false
|
1048
|
-
# description: Width of the graph (default = 300)
|
1049
|
-
# values: .*
|
1050
|
-
# - name: Height
|
1051
|
-
# required: false
|
1052
|
-
# description: Height of the graph (default = 200)
|
1053
|
-
# values: .*
|
1054
|
-
# - name: Show Points
|
1055
|
-
# required: false
|
1056
|
-
# description: Whether to show points or just draw lines between points (default = true)
|
1057
|
-
# values: ["TRUE", "FALSE"]
|
1058
|
-
# - name: Time item name
|
1059
|
-
# required: false
|
1060
|
-
# description: The telemetry item to use as the time on the X axis (default = TIMESECONDS)
|
1061
|
-
# values: .*
|
1062
|
-
# - name: Value type
|
1063
|
-
# required: false
|
1064
|
-
# description: The type of the value to display. Default is CONVERTED.
|
1065
|
-
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1066
|
-
# TRENDBAR:
|
1067
|
-
# summary: Provides the same functionality as the LIMITSBAR
|
1068
|
-
# widget except that it also keeps a history of the telemetry item and
|
1069
|
-
# graphically shows where the value was X seconds ago.
|
1070
|
-
# parameters:
|
1071
|
-
# - name: Target name
|
1072
|
-
# required: true
|
1073
|
-
# description: The target name
|
1074
|
-
# values: .+
|
1075
|
-
# - name: Packet name
|
1076
|
-
# required: true
|
1077
|
-
# description: The packet name
|
1078
|
-
# values: .+
|
1079
|
-
# - name: Item name
|
1080
|
-
# required: true
|
1081
|
-
# description: The item name
|
1082
|
-
# values: .+
|
1083
|
-
# - name: Value type
|
1084
|
-
# required: false
|
1085
|
-
# description: The type of the value to display. Default is CONVERTED.
|
1086
|
-
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1087
|
-
# - name: Trend Seconds
|
1088
|
-
# required: false
|
1089
|
-
# description: The number of seconds in the past to display the trend value (default = 60)
|
1090
|
-
# values: .*
|
1091
|
-
# - name: Width
|
1092
|
-
# required: false
|
1093
|
-
# description: Width of the limits bar (default = 160)
|
1094
|
-
# values: .*
|
1095
|
-
# - name: Height
|
1096
|
-
# required: false
|
1097
|
-
# description: Height of the limits bar (default = 25)
|
1098
|
-
# values: .*
|
1099
|
-
# TRENDLIMITSBAR:
|
1100
|
-
# summary: Displays a VALUE widget to show the telemetry items current value,
|
1101
|
-
# a VALUE widget to display the value of the item X seconds ago, and a TRENDBAR
|
1102
|
-
# widget to display the items value within its limits ranges and its trend.
|
1103
|
-
# parameters:
|
1104
|
-
# - name: Target name
|
1105
|
-
# required: true
|
1106
|
-
# description: The target name
|
1107
|
-
# values: .+
|
1108
|
-
# - name: Packet name
|
1109
|
-
# required: true
|
1110
|
-
# description: The packet name
|
1111
|
-
# values: .+
|
1112
|
-
# - name: Item name
|
1113
|
-
# required: true
|
1114
|
-
# description: The item name
|
1115
|
-
# values: .+
|
1116
|
-
# - name: Value type
|
1117
|
-
# required: false
|
1118
|
-
# description: The type of the value to display. Default is CONVERTED.
|
1119
|
-
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1120
|
-
# - name: Trend Seconds
|
1121
|
-
# required: false
|
1122
|
-
# description: The number of seconds in the past to display the trend value (default = 60)
|
1123
|
-
# values: .*
|
1124
|
-
# - name: Characters
|
1125
|
-
# required: false
|
1126
|
-
# description: The number of characters to display the telemetry value (default = 12)
|
1127
|
-
# values: .*
|
1128
|
-
# - name: Width
|
1129
|
-
# required: false
|
1130
|
-
# description: Width of the limits bar (default = 160)
|
1131
|
-
# values: .*
|
1132
|
-
# - name: Height
|
1133
|
-
# required: false
|
1134
|
-
# description: Height of the limits bar (default = 25)
|
1135
|
-
# values: .*
|
1136
|
-
VALUE:
|
1137
|
-
summary: Displays a box with a telemetry item value
|
1138
|
-
description:
|
1139
|
-
The white portion of the box darkens to gray while the value remains stagnant, then
|
1140
|
-
brightens to white each time the value changes. Additionally the value is
|
1141
|
-
colored based on the items limits state (Red for example if it is out of limits).
|
1142
|
-
parameters:
|
1143
|
-
- name: Target name
|
1144
|
-
required: true
|
1145
|
-
description: The target name
|
1146
|
-
values: .+
|
1147
|
-
- name: Packet name
|
1148
|
-
required: true
|
1149
|
-
description: The packet name
|
1150
|
-
values: .+
|
1151
|
-
- name: Item name
|
1152
|
-
required: true
|
1153
|
-
description: The item name
|
1154
|
-
values: .+
|
1155
|
-
- name: Value type
|
1156
|
-
required: false
|
1157
|
-
description: The type of the value to display. Default is CONVERTED.
|
1158
|
-
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1159
|
-
- name: Number of characters
|
1160
|
-
required: false
|
1161
|
-
description: The number of characters wide to make the value box (default = 12)
|
1162
|
-
values: .*
|
1163
|
-
BUTTON:
|
1164
|
-
summary: Displays a rectangular clickable button
|
9
|
+
The screen defaults to a vertical layout, so if no layout widgets
|
10
|
+
are specified, all widgets will be automatically placed within a VERTICAL
|
11
|
+
layout widget. The VERTICAL widget sizes itself to fit its contents.
|
12
|
+
parameters:
|
13
|
+
- name: Margin
|
14
|
+
required: false
|
15
|
+
description: Margin between widgets (default = 1px)
|
16
|
+
values: .*
|
17
|
+
example: |
|
18
|
+
VERTICAL 5px
|
19
|
+
LABEL "TEST"
|
20
|
+
LABEL "SCREEN"
|
21
|
+
END
|
22
|
+
VERTICALBOX:
|
23
|
+
summary: Places the widgets it encapsulates vertically inside a thin border
|
24
|
+
description: The VERTICALBOX widget sizes itself
|
25
|
+
to fit its contents vertically and to fit the screen horizontally
|
26
|
+
parameters:
|
27
|
+
- name: Title
|
28
|
+
required: false
|
29
|
+
description: Text to place within the border to label the box
|
30
|
+
values: .*
|
31
|
+
- name: Margin
|
32
|
+
required: false
|
33
|
+
description: Margin between widgets (default = 1px)
|
34
|
+
values: .*
|
35
|
+
example: |
|
36
|
+
VERTICALBOX Info
|
37
|
+
LABEL "TEST"
|
38
|
+
LABEL "SCREEN"
|
39
|
+
END
|
40
|
+
HORIZONTAL:
|
41
|
+
summary: Places the widgets it encapsulates horizontally
|
42
|
+
description: The HORIZONTAL widget sizes itself to fit its contents
|
43
|
+
parameters:
|
44
|
+
- name: Margin
|
45
|
+
required: false
|
46
|
+
description: Margin between widgets (default = 1px)
|
47
|
+
values: .*
|
48
|
+
example: |
|
49
|
+
HORIZONTAL 100
|
50
|
+
LABEL "TEST"
|
51
|
+
LABEL "SCREEN"
|
52
|
+
END
|
53
|
+
HORIZONTALBOX:
|
54
|
+
summary: Places the widgets it encapsulates horizontally inside a thin border
|
55
|
+
description: The HORIZONTALBOX widget sizes itself to fit its contents
|
56
|
+
parameters:
|
57
|
+
- name: Title
|
58
|
+
required: false
|
59
|
+
description: Text to place within the border to label the box
|
60
|
+
values: .*
|
61
|
+
- name: Margin
|
62
|
+
required: false
|
63
|
+
description: Margin between widgets (default = 1px)
|
64
|
+
values: .*
|
65
|
+
example: |
|
66
|
+
HORIZONTALBOX Info 10
|
67
|
+
LABEL "TEST"
|
68
|
+
LABEL "SCREEN"
|
69
|
+
END
|
70
|
+
MATRIXBYCOLUMNS:
|
71
|
+
summary: Places the widgets into a table-like matrix
|
72
|
+
description: The MATRIXBYCOLUMNS widget sizes itself to fit its contents
|
73
|
+
parameters:
|
74
|
+
- name: Columns
|
75
|
+
required: true
|
76
|
+
description: The number of columns to create
|
77
|
+
values: .*
|
78
|
+
- name: Margin
|
79
|
+
required: false
|
80
|
+
description: Margin between widgets (default = 1px)
|
81
|
+
values: .*
|
82
|
+
example: |
|
83
|
+
MATRIXBYCOLUMNS 3 10
|
84
|
+
LABEL "COL 1"
|
85
|
+
LABEL "COL 2"
|
86
|
+
LABEL "COL 3"
|
87
|
+
LABEL "100"
|
88
|
+
LABEL "200"
|
89
|
+
LABEL "300"
|
90
|
+
END
|
91
|
+
SCROLLWINDOW:
|
92
|
+
summary: Places the widgets inside of it into a scrollable area
|
93
|
+
description: The SCROLLWINDOW widget sizes itself to fit the screen in which it is contained
|
94
|
+
parameters:
|
95
|
+
- name: Height
|
96
|
+
required: false
|
97
|
+
description: Maximum height of the scroll window in pixels (default = 200)
|
98
|
+
values: .*
|
99
|
+
- name: Margin
|
100
|
+
required: false
|
101
|
+
description: Margin between widgets (default = 1px)
|
102
|
+
values: .*
|
103
|
+
example: |
|
104
|
+
SCROLLWINDOW 100 10
|
105
|
+
VERTICAL
|
106
|
+
LABEL "100"
|
107
|
+
LABEL "200"
|
108
|
+
LABEL "300"
|
109
|
+
LABEL "400"
|
110
|
+
LABEL "500"
|
111
|
+
LABEL "600"
|
112
|
+
LABEL "700"
|
113
|
+
LABEL "800"
|
114
|
+
LABEL "900"
|
115
|
+
END
|
116
|
+
END
|
117
|
+
TABBOOK:
|
118
|
+
summary: Creates a tabbed area in which to place TABITEM widgets
|
119
|
+
TABITEM:
|
120
|
+
summary: Creates a VERTICAL layout tab into which to place widgets
|
121
|
+
parameters:
|
122
|
+
- name: Tab text
|
123
|
+
required: true
|
124
|
+
description: Text to diplay in the tab
|
125
|
+
values: .*
|
126
|
+
example: |
|
127
|
+
TABBOOK
|
128
|
+
TABITEM "Tab 1"
|
129
|
+
LABEL "100"
|
130
|
+
LABEL "200"
|
131
|
+
END
|
132
|
+
TABITEM "Tab 2"
|
133
|
+
LABEL "300"
|
134
|
+
LABEL "400"
|
135
|
+
END
|
136
|
+
END
|
137
|
+
IFRAME:
|
138
|
+
summary: Open external tools in an Iframe within OpenC3
|
139
|
+
parameters:
|
140
|
+
- name: URL
|
141
|
+
required: true
|
142
|
+
description: The path to the page to display in the iframe
|
143
|
+
values: .*
|
144
|
+
- name: Width
|
145
|
+
required: false
|
146
|
+
description: Width of the widget
|
147
|
+
values: .*
|
148
|
+
- name: Height
|
149
|
+
required: false
|
150
|
+
description: Height of the widget
|
151
|
+
values: .*
|
152
|
+
example: |
|
153
|
+
IFRAME https://openc3.com 900 450
|
154
|
+
Decoration Widgets:
|
1165
155
|
description:
|
1166
|
-
|
1167
|
-
|
1168
|
-
|
1169
|
-
|
1170
|
-
|
1171
|
-
|
1172
|
-
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
|
1177
|
-
|
1178
|
-
|
1179
|
-
|
1180
|
-
|
1181
|
-
|
1182
|
-
|
1183
|
-
|
1184
|
-
|
1185
|
-
|
1186
|
-
|
1187
|
-
|
1188
|
-
|
1189
|
-
|
1190
|
-
|
1191
|
-
|
1192
|
-
|
1193
|
-
|
1194
|
-
|
1195
|
-
|
1196
|
-
|
1197
|
-
|
1198
|
-
|
1199
|
-
|
1200
|
-
|
1201
|
-
|
1202
|
-
|
1203
|
-
|
1204
|
-
|
1205
|
-
|
1206
|
-
|
1207
|
-
|
1208
|
-
|
1209
|
-
|
1210
|
-
|
1211
|
-
|
1212
|
-
|
1213
|
-
|
1214
|
-
|
1215
|
-
|
1216
|
-
|
1217
|
-
|
1218
|
-
|
1219
|
-
|
1220
|
-
|
1221
|
-
|
1222
|
-
|
1223
|
-
|
1224
|
-
|
1225
|
-
|
1226
|
-
|
1227
|
-
|
1228
|
-
|
1229
|
-
|
1230
|
-
|
1231
|
-
|
1232
|
-
|
1233
|
-
|
1234
|
-
|
1235
|
-
|
1236
|
-
|
1237
|
-
|
1238
|
-
|
1239
|
-
|
1240
|
-
|
1241
|
-
|
1242
|
-
|
1243
|
-
|
1244
|
-
|
1245
|
-
|
1246
|
-
|
1247
|
-
|
1248
|
-
|
1249
|
-
|
1250
|
-
|
1251
|
-
|
1252
|
-
|
1253
|
-
|
1254
|
-
|
1255
|
-
|
1256
|
-
|
1257
|
-
|
1258
|
-
|
1259
|
-
|
1260
|
-
|
1261
|
-
|
1262
|
-
|
1263
|
-
|
1264
|
-
|
1265
|
-
|
1266
|
-
|
1267
|
-
|
1268
|
-
|
1269
|
-
|
1270
|
-
|
1271
|
-
|
1272
|
-
|
1273
|
-
|
1274
|
-
|
1275
|
-
|
1276
|
-
|
1277
|
-
|
1278
|
-
|
1279
|
-
|
1280
|
-
|
1281
|
-
|
1282
|
-
|
1283
|
-
|
1284
|
-
|
1285
|
-
|
1286
|
-
|
1287
|
-
|
1288
|
-
|
1289
|
-
|
1290
|
-
|
1291
|
-
|
1292
|
-
|
1293
|
-
|
1294
|
-
|
1295
|
-
|
1296
|
-
|
1297
|
-
|
1298
|
-
|
1299
|
-
|
1300
|
-
|
1301
|
-
|
1302
|
-
|
1303
|
-
|
1304
|
-
|
1305
|
-
|
1306
|
-
|
1307
|
-
|
1308
|
-
|
1309
|
-
|
1310
|
-
|
1311
|
-
|
1312
|
-
|
1313
|
-
|
1314
|
-
|
1315
|
-
|
1316
|
-
|
1317
|
-
|
1318
|
-
|
1319
|
-
|
1320
|
-
|
1321
|
-
|
1322
|
-
|
1323
|
-
|
1324
|
-
|
1325
|
-
|
156
|
+
Decoration widgets are used to enhance the appearance of the screen.
|
157
|
+
They do not respond to input, nor does the output vary with telemetry.
|
158
|
+
collection:
|
159
|
+
LABEL:
|
160
|
+
summary: Displays text on the screen
|
161
|
+
description: Generally, label widgets contain a telemetry mnemonic and are placed next to the telemetry VALUE widget.
|
162
|
+
parameters:
|
163
|
+
- name: Text
|
164
|
+
required: true
|
165
|
+
description: Text to display on the label
|
166
|
+
values: .*
|
167
|
+
example: |
|
168
|
+
LABEL "Note: This is only a warning"
|
169
|
+
HORIZONTALLINE:
|
170
|
+
summary: Displays a horizontal line on the screen that can be used as a separator
|
171
|
+
since: 5.5.1
|
172
|
+
example: |
|
173
|
+
LABEL Over
|
174
|
+
HORIZONTALLINE
|
175
|
+
LABEL Under
|
176
|
+
SECTIONHEADER:
|
177
|
+
summary: DEPRECATED - Displays a label that is underlined with a horizontal line
|
178
|
+
description: Use a VERTICALBOX or HORIZONTALBOX with title parameter instead of SECTIONHEADER
|
179
|
+
parameters:
|
180
|
+
- name: Text
|
181
|
+
required: true
|
182
|
+
description: Text to display
|
183
|
+
values: .*
|
184
|
+
TITLE:
|
185
|
+
summary: Displays a large centered title on the screen
|
186
|
+
parameters:
|
187
|
+
- name: Text
|
188
|
+
required: true
|
189
|
+
description: Text to display
|
190
|
+
values: .*
|
191
|
+
example: |
|
192
|
+
TITLE "Title"
|
193
|
+
HORIZONTALLINE
|
194
|
+
LABEL "Label"
|
195
|
+
SPACER:
|
196
|
+
summary: Places a fixed size spacer in between widgets
|
197
|
+
parameters:
|
198
|
+
- name: Width
|
199
|
+
required: true
|
200
|
+
description: Width of the spacer in pixels
|
201
|
+
values: .*
|
202
|
+
- name: Height
|
203
|
+
required: true
|
204
|
+
description: Height of the spacer in pixels
|
205
|
+
values: .*
|
206
|
+
example: |
|
207
|
+
VERTICAL 3
|
208
|
+
LABEL "Spacer below"
|
209
|
+
SPACER 0 100
|
210
|
+
LABEL "Spacer above"
|
211
|
+
END
|
212
|
+
Telemetry Widgets:
|
213
|
+
description: Telemetry widgets are used to display telemetry values.
|
214
|
+
The first parameters to each of these widgets is a telemetry mnemonic.
|
215
|
+
Depending on the type and purpose of the telemetry item, the screen designer
|
216
|
+
may select from a wide selection of widgets to display the value in the most useful format.
|
217
|
+
collection:
|
218
|
+
ARRAY:
|
219
|
+
summary: Displays ARRAY data organized into rows and space separated
|
220
|
+
parameters:
|
221
|
+
- name: Target name
|
222
|
+
required: true
|
223
|
+
description: The target name
|
224
|
+
values: .+
|
225
|
+
- name: Packet name
|
226
|
+
required: true
|
227
|
+
description: The packet name
|
228
|
+
values: .+
|
229
|
+
- name: Item name
|
230
|
+
required: true
|
231
|
+
description: The item name
|
232
|
+
values: .+
|
233
|
+
- name: Width
|
234
|
+
required: false
|
235
|
+
description: Width of the widget (default = 200)
|
236
|
+
values: .*
|
237
|
+
- name: Height
|
238
|
+
required: false
|
239
|
+
description: Height of the widget (default = 100)
|
240
|
+
values: .*
|
241
|
+
- name: Format string
|
242
|
+
required: false
|
243
|
+
description: Format string applied to each array item (default = nil)
|
244
|
+
values: .*
|
245
|
+
- name: Items per row
|
246
|
+
required: false
|
247
|
+
description: Number of array items per row (default = 4)
|
248
|
+
values: .*
|
249
|
+
- name: Value type
|
250
|
+
required: false
|
251
|
+
description: The type of the value to display. Default is CONVERTED.
|
252
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
253
|
+
example: |
|
254
|
+
ARRAY INST HEALTH_STATUS ARY 250 80 "0x%x" 6 FORMATTED
|
255
|
+
ARRAY INST HEALTH_STATUS ARY2 200 100 nil 4 WITH_UNITS
|
256
|
+
BLOCK:
|
257
|
+
summary: Displays BLOCK data organized into rows and space separated
|
258
|
+
parameters:
|
259
|
+
- name: Target name
|
260
|
+
required: true
|
261
|
+
description: The target name
|
262
|
+
values: .+
|
263
|
+
- name: Packet name
|
264
|
+
required: true
|
265
|
+
description: The packet name
|
266
|
+
values: .+
|
267
|
+
- name: Item name
|
268
|
+
required: true
|
269
|
+
description: The item name
|
270
|
+
values: .+
|
271
|
+
- name: Width
|
272
|
+
required: false
|
273
|
+
description: Width of the widget (default = 200)
|
274
|
+
values: .*
|
275
|
+
- name: Height
|
276
|
+
required: false
|
277
|
+
description: Height of the widget (default = 100)
|
278
|
+
values: .*
|
279
|
+
- name: Format string
|
280
|
+
required: false
|
281
|
+
description: Format string applied to each array item (default = nil)
|
282
|
+
values: .*
|
283
|
+
- name: Bytes per word
|
284
|
+
required: false
|
285
|
+
description: Number of bytes per word (default = 4)
|
286
|
+
values: .*
|
287
|
+
- name: Words per row
|
288
|
+
required: false
|
289
|
+
description: Number of words per row (default = 4
|
290
|
+
values: .*
|
291
|
+
- name: Address format
|
292
|
+
required: false
|
293
|
+
description:
|
294
|
+
Format for the address printed at the beginning of each line
|
295
|
+
(default = nil which means do not print an address)
|
296
|
+
values: .*
|
297
|
+
- name: Value type
|
298
|
+
required: false
|
299
|
+
description: The type of the value to display. Default is CONVERTED.
|
300
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
301
|
+
example: |
|
302
|
+
BLOCK INST IMAGE IMAGE 400 130 "%02X" 4 4 "0x%08X:"
|
303
|
+
# FORMATFONTVALUE:
|
304
|
+
# summary: Displays a box with a value printed inside
|
305
|
+
# that is formatted by the specified string rather than by a format string given
|
306
|
+
# in the telemetry definition files. Additionally, this widget can use a specified
|
307
|
+
# font. The white portion of the box darkens to gray while the value remains
|
308
|
+
# stagnant, then brightens to white each time the value changes. Additionally
|
309
|
+
# the value is colored based on the items limits state (Red for example if it is out of limits).
|
310
|
+
# parameters:
|
311
|
+
# - name: Target name
|
312
|
+
# required: true
|
313
|
+
# description: The target name
|
314
|
+
# values: .+
|
315
|
+
# - name: Packet name
|
316
|
+
# required: true
|
317
|
+
# description: The packet name
|
318
|
+
# values: .+
|
319
|
+
# - name: Item name
|
320
|
+
# required: true
|
321
|
+
# description: The item name
|
322
|
+
# values: .+
|
323
|
+
# - name: Format string
|
324
|
+
# required: false
|
325
|
+
# description: Printf style format string to apply to the telemetry item
|
326
|
+
# values: .*
|
327
|
+
# - name: Value type
|
328
|
+
# required: false
|
329
|
+
# description: The type of the value to display. Default is CONVERTED.
|
330
|
+
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
331
|
+
# - name: Number of characters
|
332
|
+
# required: false
|
333
|
+
# description: The number of characters wide to make the value box (default = 12)
|
334
|
+
# values: .*
|
335
|
+
# - name: Font name
|
336
|
+
# required: false
|
337
|
+
# description: The font to use. (default = arial)
|
338
|
+
# values: .*
|
339
|
+
# - name: Font size
|
340
|
+
# required: false
|
341
|
+
# description: The font size. (default = 100)
|
342
|
+
# values: .*
|
343
|
+
# example: |
|
344
|
+
# FORMATFONTVALUE INST LATEST TIMESEC %012u CONVERTED 12 arial 30
|
345
|
+
FORMATVALUE:
|
346
|
+
summary: Displays a box with a formatted value
|
347
|
+
description:
|
348
|
+
Data is formatted by the specified string rather than by a format string given in
|
349
|
+
the telemetry definition files. The white portion of the box darkens to gray
|
350
|
+
while the value remains stagnant, then brightens to white each time the value
|
351
|
+
changes. Additionally the value is colored based on the items limits state
|
352
|
+
(Red for example if it is out of limits).
|
353
|
+
parameters:
|
354
|
+
- name: Target name
|
355
|
+
required: true
|
356
|
+
description: The target name
|
357
|
+
values: .+
|
358
|
+
- name: Packet name
|
359
|
+
required: true
|
360
|
+
description: The packet name
|
361
|
+
values: .+
|
362
|
+
- name: Item name
|
363
|
+
required: true
|
364
|
+
description: The item name
|
365
|
+
values: .+
|
366
|
+
- name: Format string
|
367
|
+
required: false
|
368
|
+
description: Printf style format string to apply to the telemetry item
|
369
|
+
values: .*
|
370
|
+
- name: Value type
|
371
|
+
required: false
|
372
|
+
description: The type of the value to display. Default is CONVERTED.
|
373
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
374
|
+
- name: Number of characters
|
375
|
+
required: false
|
376
|
+
description: The number of characters wide to make the value box (default = 12)
|
377
|
+
values: .*
|
378
|
+
example: |
|
379
|
+
FORMATVALUE INST LATEST TIMESEC %012u CONVERTED 20
|
380
|
+
LABELLED:
|
381
|
+
summary: Displays a LABEL followed by a LED
|
382
|
+
parameters:
|
383
|
+
- name: Target name
|
384
|
+
required: true
|
385
|
+
description: The target name
|
386
|
+
values: .+
|
387
|
+
- name: Packet name
|
388
|
+
required: true
|
389
|
+
description: The packet name
|
390
|
+
values: .+
|
391
|
+
- name: Item name
|
392
|
+
required: true
|
393
|
+
description: The item name
|
394
|
+
values: .+
|
395
|
+
- name: Value type
|
396
|
+
required: false
|
397
|
+
description: The type of the value to display. Default is CONVERTED.
|
398
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
399
|
+
- name: Width
|
400
|
+
required: false
|
401
|
+
description: Width of the LED circle (default = 15)
|
402
|
+
values: .*
|
403
|
+
- name: Height
|
404
|
+
required: false
|
405
|
+
description: Height of the LED circle (default = 15)
|
406
|
+
values: .*
|
407
|
+
- name: Justification
|
408
|
+
required: false
|
409
|
+
description: How to justify the label and LED together. The default of
|
410
|
+
'SPLIT' aligns the label to the left and the LED to the right with any
|
411
|
+
additional space going between them. 'CENTER' pushes the label and LED
|
412
|
+
together with any additional space to the left and right. 'LEFT' or 'RIGHT'
|
413
|
+
pushes them to the respective side with the space going on the opposite.
|
414
|
+
values: ["SPLIT", "CENTER", "LEFT", "RIGHT"]
|
415
|
+
example: |
|
416
|
+
LABELLED INST PARAMS VALUE1
|
417
|
+
SETTING LED_COLOR GOOD GREEN
|
418
|
+
SETTING LED_COLOR BAD RED
|
419
|
+
settings:
|
420
|
+
LED_COLOR:
|
421
|
+
summary: Map a state or value to a color
|
422
|
+
parameters:
|
423
|
+
- name: Value
|
424
|
+
required: true
|
425
|
+
description: State or value. ANY used to match any value or state not declared.
|
426
|
+
values: .+
|
427
|
+
- name: LED color
|
428
|
+
required: true
|
429
|
+
description: Color of the LED
|
430
|
+
values: .+
|
431
|
+
LABELPROGRESSBAR:
|
432
|
+
summary: Displays a LABEL with the item name followed by a PROGRESSBAR
|
433
|
+
parameters:
|
434
|
+
- name: Target name
|
435
|
+
required: true
|
436
|
+
description: The target name
|
437
|
+
values: .+
|
438
|
+
- name: Packet name
|
439
|
+
required: true
|
440
|
+
description: The packet name
|
441
|
+
values: .+
|
442
|
+
- name: Item name
|
443
|
+
required: true
|
444
|
+
description: The item name
|
445
|
+
values: .+
|
446
|
+
- name: Scale factor
|
447
|
+
required: false
|
448
|
+
description: Value to multiply the telemetry item by before displaying
|
449
|
+
in the progress bar. Final value should be in the range of 0 to 100. Default is 1.0.
|
450
|
+
values: .*
|
451
|
+
- name: Width
|
452
|
+
required: false
|
453
|
+
description: Width of the progress bar (default = 80 pixels
|
454
|
+
values: .*
|
455
|
+
- name: Value type
|
456
|
+
required: false
|
457
|
+
description: The type of the value to display. Default is CONVERTED.
|
458
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
459
|
+
example: |
|
460
|
+
LABELPROGRESSBAR INST ADCS POSPROGRESS 2 200 RAW
|
461
|
+
LABELPROGRESSBAR INST ADCS POSPROGRESS
|
462
|
+
LABELVALUE:
|
463
|
+
summary: Displays a LABEL with the item name followed by a VALUE
|
464
|
+
parameters:
|
465
|
+
- name: Target name
|
466
|
+
required: true
|
467
|
+
description: The target name
|
468
|
+
values: .+
|
469
|
+
- name: Packet name
|
470
|
+
required: true
|
471
|
+
description: The packet name
|
472
|
+
values: .+
|
473
|
+
- name: Item name
|
474
|
+
required: true
|
475
|
+
description: The item name
|
476
|
+
values: .+
|
477
|
+
- name: Value type
|
478
|
+
required: false
|
479
|
+
description: The type of the value to display. Default is CONVERTED.
|
480
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
481
|
+
- name: Number of characters
|
482
|
+
required: false
|
483
|
+
description: The number of characters wide to make the value box (default = 12)
|
484
|
+
values: .*
|
485
|
+
example: |
|
486
|
+
LABELVALUE INST LATEST TIMESEC CONVERTED 18
|
487
|
+
LABELVALUE INST LATEST COLLECT_TYPE
|
488
|
+
LABELVALUEDESC:
|
489
|
+
summary: Displays a LABEL with the items description followed by a VALUE
|
490
|
+
parameters:
|
491
|
+
- name: Target name
|
492
|
+
required: true
|
493
|
+
description: The target name
|
494
|
+
values: .+
|
495
|
+
- name: Packet name
|
496
|
+
required: true
|
497
|
+
description: The packet name
|
498
|
+
values: .+
|
499
|
+
- name: Item name
|
500
|
+
required: true
|
501
|
+
description: The item name
|
502
|
+
values: .+
|
503
|
+
- name: Description
|
504
|
+
required: false
|
505
|
+
description:
|
506
|
+
The description to display in the label (default is to display
|
507
|
+
the description text associated with the telemetry item)
|
508
|
+
values: .*
|
509
|
+
- name: Value type
|
510
|
+
required: false
|
511
|
+
description: The type of the value to display. Default is CONVERTED.
|
512
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
513
|
+
- name: Number of characters
|
514
|
+
required: false
|
515
|
+
description: The number of characters wide to make the value box (default = 12)
|
516
|
+
values: .*
|
517
|
+
example: |
|
518
|
+
LABELVALUEDESC INST HEALTH_STATUS TEMP1 "Temperature number 1" RAW 18
|
519
|
+
LABELVALUEDESC INST HEALTH_STATUS COLLECT_TYPE
|
520
|
+
# LABELFORMATVALUE:
|
521
|
+
# summary: Displays a LABEL widget to show the telemetry
|
522
|
+
# items name followed by a formatted VALUE widget to display the items value.
|
523
|
+
# parameters:
|
524
|
+
# - name: Target name
|
525
|
+
# required: true
|
526
|
+
# description: The target name
|
527
|
+
# values: .+
|
528
|
+
# - name: Packet name
|
529
|
+
# required: true
|
530
|
+
# description: The packet name
|
531
|
+
# values: .+
|
532
|
+
# - name: Item name
|
533
|
+
# required: true
|
534
|
+
# description: The item name
|
535
|
+
# values: .+
|
536
|
+
# - name: Format String
|
537
|
+
# required: true
|
538
|
+
# description: Printf style format string, for example %0.6f
|
539
|
+
# values: .*
|
540
|
+
# - name: Value type
|
541
|
+
# required: false
|
542
|
+
# description: The type of the value to display. Default is CONVERTED.
|
543
|
+
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
544
|
+
# - name: Number of characters
|
545
|
+
# required: false
|
546
|
+
# description: The number of characters wide to make the value box (default = 12)
|
547
|
+
# values: .*
|
548
|
+
LABELVALUELIMITSBAR:
|
549
|
+
summary: Displays a LABEL with the item name followed by VALUE and LIMITSBAR widgets
|
550
|
+
parameters:
|
551
|
+
- name: Target name
|
552
|
+
required: true
|
553
|
+
description: The target name
|
554
|
+
values: .+
|
555
|
+
- name: Packet name
|
556
|
+
required: true
|
557
|
+
description: The packet name
|
558
|
+
values: .+
|
559
|
+
- name: Item name
|
560
|
+
required: true
|
561
|
+
description: The item name
|
562
|
+
values: .+
|
563
|
+
- name: Value type
|
564
|
+
required: false
|
565
|
+
description: The type of the value to display. Default is CONVERTED.
|
566
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
567
|
+
- name: Number of characters
|
568
|
+
required: false
|
569
|
+
description: The number of characters wide to make the value box (default = 12)
|
570
|
+
values: .*
|
571
|
+
examples: |
|
572
|
+
LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1 RAW 18
|
573
|
+
LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1
|
574
|
+
LABELVALUELIMITSCOLUMN:
|
575
|
+
summary: Displays a LABEL with the item name followed by VALUE and LIMITSCOLUMN widgets
|
576
|
+
parameters:
|
577
|
+
- name: Target name
|
578
|
+
required: true
|
579
|
+
description: The target name
|
580
|
+
values: .+
|
581
|
+
- name: Packet name
|
582
|
+
required: true
|
583
|
+
description: The packet name
|
584
|
+
values: .+
|
585
|
+
- name: Item name
|
586
|
+
required: true
|
587
|
+
description: The item name
|
588
|
+
values: .+
|
589
|
+
- name: Value type
|
590
|
+
required: false
|
591
|
+
description: The type of the value to display. Default is CONVERTED.
|
592
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
593
|
+
- name: Number of characters
|
594
|
+
required: false
|
595
|
+
description: The number of characters wide to make the value box (default = 12)
|
596
|
+
values: .*
|
597
|
+
example: |
|
598
|
+
LABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18
|
599
|
+
LABELVALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1
|
600
|
+
LABELVALUERANGEBAR:
|
601
|
+
summary: Displays a LABEL with the item name followed by VALUE and RANGEBAR widgets
|
602
|
+
parameters:
|
603
|
+
- name: Target name
|
604
|
+
required: true
|
605
|
+
description: The target name
|
606
|
+
values: .+
|
607
|
+
- name: Packet name
|
608
|
+
required: true
|
609
|
+
description: The packet name
|
610
|
+
values: .+
|
611
|
+
- name: Item name
|
612
|
+
required: true
|
613
|
+
description: The item name
|
614
|
+
values: .+
|
615
|
+
- name: Low Value
|
616
|
+
required: true
|
617
|
+
description:
|
618
|
+
Minimum value to display on the range bar. If the telemetry
|
619
|
+
item goes below this value the bar is “pegged” on the low end.
|
620
|
+
values: .+
|
621
|
+
- name: High Value
|
622
|
+
required: true
|
623
|
+
description:
|
624
|
+
Maximum value to display on the range bar. If the telemetry
|
625
|
+
item goes above this value the bar is “pegged” on the high end.
|
626
|
+
values: .+
|
627
|
+
- name: Value type
|
628
|
+
required: false
|
629
|
+
description: The type of the value to display. Default is CONVERTED.
|
630
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
631
|
+
- name: Number of characters
|
632
|
+
required: false
|
633
|
+
description: The number of characters wide to make the value box (default = 12)
|
634
|
+
values: .*
|
635
|
+
- name: Width
|
636
|
+
required: false
|
637
|
+
description: Width of the range bar (default = 160)
|
638
|
+
values: .*
|
639
|
+
- name: Height
|
640
|
+
required: false
|
641
|
+
description: Height of the range bar (default = 25)
|
642
|
+
values: .*
|
643
|
+
example: |
|
644
|
+
LABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40
|
645
|
+
LABELVALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120
|
646
|
+
# LABELVALUERANGECOLUMN:
|
647
|
+
# summary: Displays a LABEL widget to show the telemetry item's name,
|
648
|
+
# followed by a VALUE widget to display the item's value, followed by a RANGECOLUMN widget.
|
649
|
+
# parameters:
|
650
|
+
# - name: Target name
|
651
|
+
# required: true
|
652
|
+
# description: The target name
|
653
|
+
# values: .+
|
654
|
+
# - name: Packet name
|
655
|
+
# required: true
|
656
|
+
# description: The packet name
|
657
|
+
# values: .+
|
658
|
+
# - name: Item name
|
659
|
+
# required: true
|
660
|
+
# description: The item name
|
661
|
+
# values: .+
|
662
|
+
# - name: Low Value
|
663
|
+
# required: true
|
664
|
+
# description: Minimum value to display on the range bar. If the telemetry
|
665
|
+
# item goes below this value the bar is “pegged” on the low end.
|
666
|
+
# values: .+
|
667
|
+
# - name: High Value
|
668
|
+
# required: true
|
669
|
+
# description: Maximum value to display on the range bar. If the telemetry
|
670
|
+
# item goes above this value the bar is “pegged” on the high end.
|
671
|
+
# values: .+
|
672
|
+
# - name: Value type
|
673
|
+
# required: false
|
674
|
+
# description: The type of the value to display. Default is CONVERTED.
|
675
|
+
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
676
|
+
# - name: Number of characters
|
677
|
+
# required: false
|
678
|
+
# description: The number of characters wide to make the value box (default = 12)
|
679
|
+
# values: .*
|
680
|
+
# - name: Width
|
681
|
+
# required: false
|
682
|
+
# description: Width of the range bar (default = 160)
|
683
|
+
# values: .*
|
684
|
+
# - name: Height
|
685
|
+
# required: false
|
686
|
+
# description: Height of the range bar (default = 25)
|
687
|
+
# values: .*
|
688
|
+
# example: |
|
689
|
+
# LABELVALUERANGECOLUMN INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40
|
690
|
+
# LABELVALUERANGECOLUMN INST HEALTH_STATUS TEMP1 -120 120
|
691
|
+
LED:
|
692
|
+
summary: Displays a LED which changes color based on telemetry values
|
693
|
+
description:
|
694
|
+
By default TRUE is green and FALSE is red and all other values are black.
|
695
|
+
Additional values can be added by using the LED_COLOR setting. For example
|
696
|
+
LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN,
|
697
|
+
SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE.
|
698
|
+
parameters:
|
699
|
+
- name: Target name
|
700
|
+
required: true
|
701
|
+
description: The target name
|
702
|
+
values: .+
|
703
|
+
- name: Packet name
|
704
|
+
required: true
|
705
|
+
description: The packet name
|
706
|
+
values: .+
|
707
|
+
- name: Item name
|
708
|
+
required: true
|
709
|
+
description: The item name
|
710
|
+
values: .+
|
711
|
+
- name: Value type
|
712
|
+
required: false
|
713
|
+
description: The type of the value to display. Default is CONVERTED.
|
714
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
715
|
+
- name: Width
|
716
|
+
required: false
|
717
|
+
description: Width of the LED circle (default = 15)
|
718
|
+
values: .*
|
719
|
+
- name: Height
|
720
|
+
required: false
|
721
|
+
description: Height of the LED circle (default = 15)
|
722
|
+
values: .*
|
723
|
+
example: |
|
724
|
+
LED INST PARAMS VALUE5 RAW 25 20 # Ellipse
|
725
|
+
SETTING LED_COLOR 0 GREEN
|
726
|
+
SETTING LED_COLOR 1 RED
|
727
|
+
SETTING LED_COLOR ANY YELLOW
|
728
|
+
settings:
|
729
|
+
LED_COLOR:
|
730
|
+
summary: Map a state or value to a color
|
731
|
+
parameters:
|
732
|
+
- name: Value
|
733
|
+
required: true
|
734
|
+
description: State or value. ANY used to match any value or state not declared.
|
735
|
+
values: .+
|
736
|
+
- name: LED color
|
737
|
+
required: true
|
738
|
+
description: Color of the LED
|
739
|
+
values: .+
|
740
|
+
LIMITSBAR:
|
741
|
+
summary: Displays an item's current value within its colored limits horizontally
|
742
|
+
parameters:
|
743
|
+
- name: Target name
|
744
|
+
required: true
|
745
|
+
description: The target name
|
746
|
+
values: .+
|
747
|
+
- name: Packet name
|
748
|
+
required: true
|
749
|
+
description: The packet name
|
750
|
+
values: .+
|
751
|
+
- name: Item name
|
752
|
+
required: true
|
753
|
+
description: The item name
|
754
|
+
values: .+
|
755
|
+
- name: Value type
|
756
|
+
required: false
|
757
|
+
description: The type of the value to display. Default is CONVERTED.
|
758
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
759
|
+
- name: Width
|
760
|
+
required: false
|
761
|
+
description: Width of the range bar (default = 160)
|
762
|
+
values: .*
|
763
|
+
- name: Height
|
764
|
+
required: false
|
765
|
+
description: Height of the range bar (default = 25)
|
766
|
+
values: .*
|
767
|
+
example: |
|
768
|
+
LIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 200 50
|
769
|
+
LIMITSBAR INST HEALTH_STATUS TEMP1
|
770
|
+
LIMITSCOLUMN:
|
771
|
+
summary: Displays an item's current value within its colored limits vertically
|
772
|
+
parameters:
|
773
|
+
- name: Target name
|
774
|
+
required: true
|
775
|
+
description: The target name
|
776
|
+
values: .+
|
777
|
+
- name: Packet name
|
778
|
+
required: true
|
779
|
+
description: The packet name
|
780
|
+
values: .+
|
781
|
+
- name: Item name
|
782
|
+
required: true
|
783
|
+
description: The item name
|
784
|
+
values: .+
|
785
|
+
- name: Value type
|
786
|
+
required: false
|
787
|
+
description: The type of the value to display. Default is CONVERTED.
|
788
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
789
|
+
- name: Width
|
790
|
+
required: false
|
791
|
+
description: Width of the range bar (default = 160)
|
792
|
+
values: .*
|
793
|
+
- name: Height
|
794
|
+
required: false
|
795
|
+
description: Height of the range bar (default = 25)
|
796
|
+
values: .*
|
797
|
+
example: |
|
798
|
+
LIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 50 200
|
799
|
+
LIMITSCOLUMN INST HEALTH_STATUS TEMP1
|
800
|
+
LIMITSCOLOR:
|
801
|
+
summary: Displays a circle depicting the limits color of an item
|
802
|
+
parameters:
|
803
|
+
- name: Target name
|
804
|
+
required: true
|
805
|
+
description: The target name
|
806
|
+
values: .+
|
807
|
+
- name: Packet name
|
808
|
+
required: true
|
809
|
+
description: The packet name
|
810
|
+
values: .+
|
811
|
+
- name: Item name
|
812
|
+
required: true
|
813
|
+
description: The item name
|
814
|
+
values: .+
|
815
|
+
- name: Value type
|
816
|
+
required: false
|
817
|
+
description: The type of the value to display. Default is CONVERTED.
|
818
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
819
|
+
- name: Radius
|
820
|
+
required: false
|
821
|
+
description: Radius of the circle (default is 10)
|
822
|
+
values: .*
|
823
|
+
- name: Full Item Name
|
824
|
+
required: false
|
825
|
+
description: Show the full item name (default is false)
|
826
|
+
values: .*
|
827
|
+
example: |
|
828
|
+
LIMITSCOLOR INST HEALTH_STATUS TEMP1 CONVERTED 30 TRUE
|
829
|
+
LIMITSCOLOR INST HEALTH_STATUS TEMP1
|
830
|
+
VALUELIMITSBAR:
|
831
|
+
summary: Displays an item VALUE followed by LIMITSBAR
|
832
|
+
parameters:
|
833
|
+
- name: Target name
|
834
|
+
required: true
|
835
|
+
description: The target name
|
836
|
+
values: .+
|
837
|
+
- name: Packet name
|
838
|
+
required: true
|
839
|
+
description: The packet name
|
840
|
+
values: .+
|
841
|
+
- name: Item name
|
842
|
+
required: true
|
843
|
+
description: The item name
|
844
|
+
values: .+
|
845
|
+
- name: Value type
|
846
|
+
required: false
|
847
|
+
description: The type of the value to display. Default is CONVERTED.
|
848
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
849
|
+
- name: Number of characters
|
850
|
+
required: false
|
851
|
+
description: The number of characters wide to make the value box (default = 12)
|
852
|
+
values: .*
|
853
|
+
example: |
|
854
|
+
VALUELIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 18
|
855
|
+
VALUELIMITSBAR INST HEALTH_STATUS TEMP1
|
856
|
+
VALUELIMITSCOLUMN:
|
857
|
+
summary: Displays an item VALUE followed by LIMITSCOLUMN
|
858
|
+
parameters:
|
859
|
+
- name: Target name
|
860
|
+
required: true
|
861
|
+
description: The target name
|
862
|
+
values: .+
|
863
|
+
- name: Packet name
|
864
|
+
required: true
|
865
|
+
description: The packet name
|
866
|
+
values: .+
|
867
|
+
- name: Item name
|
868
|
+
required: true
|
869
|
+
description: The item name
|
870
|
+
values: .+
|
871
|
+
- name: Value type
|
872
|
+
required: false
|
873
|
+
description: The type of the value to display. Default is CONVERTED.
|
874
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
875
|
+
- name: Number of characters
|
876
|
+
required: false
|
877
|
+
description: The number of characters wide to make the value box (default = 8)
|
878
|
+
values: .*
|
879
|
+
example: |
|
880
|
+
VALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1 CONVERTED 18
|
881
|
+
VALUELIMITSCOLUMN INST HEALTH_STATUS TEMP1
|
882
|
+
VALUERANGEBAR:
|
883
|
+
summary: Displays an item VALUE followed by RANGEBAR
|
884
|
+
parameters:
|
885
|
+
- name: Target name
|
886
|
+
required: true
|
887
|
+
description: The target name
|
888
|
+
values: .+
|
889
|
+
- name: Packet name
|
890
|
+
required: true
|
891
|
+
description: The packet name
|
892
|
+
values: .+
|
893
|
+
- name: Item name
|
894
|
+
required: true
|
895
|
+
description: The item name
|
896
|
+
values: .+
|
897
|
+
- name: Low Value
|
898
|
+
required: true
|
899
|
+
description:
|
900
|
+
Minimum value to display on the range bar. If the telemetry
|
901
|
+
item goes below this value the bar is “pegged” on the low end.
|
902
|
+
values: .+
|
903
|
+
- name: High Value
|
904
|
+
required: true
|
905
|
+
description:
|
906
|
+
Maximum value to display on the range bar. If the telemetry
|
907
|
+
item goes above this value the bar is “pegged” on the high end.
|
908
|
+
values: .+
|
909
|
+
- name: Value type
|
910
|
+
required: false
|
911
|
+
description: The type of the value to display. Default is CONVERTED.
|
912
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
913
|
+
- name: Number of characters
|
914
|
+
required: false
|
915
|
+
description: The number of characters wide to make the value box (default = 12)
|
916
|
+
values: .*
|
917
|
+
- name: Width
|
918
|
+
required: false
|
919
|
+
description: Width of the range bar (default = 160)
|
920
|
+
values: .*
|
921
|
+
- name: Height
|
922
|
+
required: false
|
923
|
+
description: Height of the range bar (default = 25)
|
924
|
+
values: .*
|
925
|
+
example: |
|
926
|
+
VALUERANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40
|
927
|
+
VALUERANGEBAR INST HEALTH_STATUS TEMP1 -120 120
|
928
|
+
# VALUERANGECOLUMN:
|
929
|
+
# summary: Displays a graphical representation of where
|
930
|
+
# an item's value falls within a range vertically and its value in a VALUE widget.
|
931
|
+
# parameters:
|
932
|
+
# - name: Target name
|
933
|
+
# required: true
|
934
|
+
# description: The target name
|
935
|
+
# values: .+
|
936
|
+
# - name: Packet name
|
937
|
+
# required: true
|
938
|
+
# description: The packet name
|
939
|
+
# values: .+
|
940
|
+
# - name: Item name
|
941
|
+
# required: true
|
942
|
+
# description: The item name
|
943
|
+
# values: .+
|
944
|
+
# - name: Low Value
|
945
|
+
# required: true
|
946
|
+
# description: Minimum value to display on the range bar. If the telemetry
|
947
|
+
# item goes below this value the bar is “pegged” on the low end.
|
948
|
+
# values: .+
|
949
|
+
# - name: High Value
|
950
|
+
# required: true
|
951
|
+
# description: Maximum value to display on the range bar. If the telemetry
|
952
|
+
# item goes above this value the bar is “pegged” on the high end.
|
953
|
+
# values: .+
|
954
|
+
# - name: Value type
|
955
|
+
# required: false
|
956
|
+
# description: The type of the value to display. Default is CONVERTED.
|
957
|
+
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
958
|
+
# - name: Number of characters
|
959
|
+
# required: false
|
960
|
+
# description: The number of characters wide to make the value box (default = 12)
|
961
|
+
# values: .*
|
962
|
+
# - name: Width
|
963
|
+
# required: false
|
964
|
+
# description: Width of the range bar (default = 160)
|
965
|
+
# values: .*
|
966
|
+
# - name: Height
|
967
|
+
# required: false
|
968
|
+
# description: Height of the range bar (default = 25)
|
969
|
+
# values: .*
|
970
|
+
# example: |
|
971
|
+
# VALUERANGECOLUMN INST HEALTH_STATUS TEMP1 0 100000 RAW 18 200 40
|
972
|
+
# VALUERANGECOLUMN INST HEALTH_STATUS TEMP1 -120 120
|
973
|
+
LINEGRAPH:
|
974
|
+
summary: Displays a line graph of a telemetry item
|
975
|
+
parameters:
|
976
|
+
# Inject the graph parameters
|
977
|
+
<%= MetaConfigParser.load('_graph_params.yaml').to_meta_config_yaml(8) %>
|
978
|
+
example: |
|
979
|
+
LINEGRAPH INST HEALTH_STATUS TEMP1
|
980
|
+
SETTING ITEM INST ADCS Q1 # Add additional item to graph
|
981
|
+
LINEGRAPH INST HEALTH_STATUS TEMP2 RAW
|
982
|
+
LINEGRAPH INST HEALTH_STATUS TEMP3 CONVERTED REDUCED_MINUTE MIN
|
983
|
+
SETTING SIZE 600 500 # width height
|
984
|
+
SETTING HISTORY 1h # load 1 hour of data into graph
|
985
|
+
LINEGRAPH INST HEALTH_STATUS TEMP4
|
986
|
+
SETTING HISTORY 30m # load 30 minutes of data into graph
|
987
|
+
settings:
|
988
|
+
# Inject the graph settings
|
989
|
+
<%= MetaConfigParser.load('graph_settings.yaml').to_meta_config_yaml(8) %>
|
990
|
+
SPARKLINE:
|
991
|
+
summary: Displays a sparkline graph (no cursor, scale or legend) of a telemetry item
|
992
|
+
parameters:
|
993
|
+
# Inject the graph parameters
|
994
|
+
<%= MetaConfigParser.load('_graph_params.yaml').to_meta_config_yaml(8) %>
|
995
|
+
example: |
|
996
|
+
SPARKLINE INST HEALTH_STATUS TEMP1
|
997
|
+
SETTING SIZE 400 50
|
998
|
+
SETTING HISTORY 30s # Add 30 seconds of data into graph
|
999
|
+
settings:
|
1000
|
+
# Inject the graph settings
|
1001
|
+
<%= MetaConfigParser.load('graph_settings.yaml').to_meta_config_yaml(8) %>
|
1002
|
+
LABELSPARKLINE:
|
1003
|
+
summary: Displays a LABEL with the item name followed by a SPARKLINE
|
1004
|
+
parameters:
|
1005
|
+
# Inject the graph parameters
|
1006
|
+
<%= MetaConfigParser.load('_graph_params.yaml').to_meta_config_yaml(8) %>
|
1007
|
+
example: |
|
1008
|
+
LABELSPARKLINE INST HEALTH_STATUS TEMP1
|
1009
|
+
SETTING HISTORY 5m # Add 5 minutes of data into graph
|
1010
|
+
settings:
|
1011
|
+
# Inject the graph settings
|
1012
|
+
<%= MetaConfigParser.load('graph_settings.yaml').to_meta_config_yaml(8) %>
|
1013
|
+
IMAGEVIEWER:
|
1014
|
+
summary: Display a base64 image from a TLM packet
|
1015
|
+
parameters:
|
1016
|
+
- name: Target name
|
1017
|
+
required: true
|
1018
|
+
description: The target name
|
1019
|
+
values: .+
|
1020
|
+
- name: Packet name
|
1021
|
+
required: true
|
1022
|
+
description: The packet name
|
1023
|
+
values: .+
|
1024
|
+
- name: Item name
|
1025
|
+
required: true
|
1026
|
+
description: The item name
|
1027
|
+
values: .+
|
1028
|
+
- name: Format
|
1029
|
+
required: true
|
1030
|
+
description: The image format of the base64 data (e.g. jpg, png, etc)
|
1031
|
+
values: .+
|
1032
|
+
- name: Width
|
1033
|
+
required: false
|
1034
|
+
description: Width of the widget
|
1035
|
+
values: .*
|
1036
|
+
- name: Height
|
1037
|
+
required: false
|
1038
|
+
description: Height of the widget
|
1039
|
+
values: .*
|
1040
|
+
example: |
|
1041
|
+
IMAGEVIEWER INST IMAGE IMAGE jpg
|
1042
|
+
PROGRESSBAR:
|
1043
|
+
summary: Displays a progress bar that is useful for displaying percentages
|
1044
|
+
parmeters:
|
1045
|
+
- name: Target name
|
1046
|
+
required: true
|
1047
|
+
description: The target name
|
1048
|
+
values: .+
|
1049
|
+
- name: Packet name
|
1050
|
+
required: true
|
1051
|
+
description: The packet name
|
1052
|
+
values: .+
|
1053
|
+
- name: Item name
|
1054
|
+
required: true
|
1055
|
+
description: The item name
|
1056
|
+
values: .+
|
1057
|
+
- name: Scale factor
|
1058
|
+
required: false
|
1059
|
+
description:
|
1060
|
+
Value to multiple the telemetry item by before displaying the
|
1061
|
+
in the progress bar. Final value should be in the range of 0 to 100. Default is 1.0.
|
1062
|
+
values: .*
|
1063
|
+
- name: Width
|
1064
|
+
required: false
|
1065
|
+
description: Width of the progress bar (default = 100 pixels)
|
1066
|
+
values: .*
|
1067
|
+
- name: Value type
|
1068
|
+
required: false
|
1069
|
+
description: The type of the value to display. Default is CONVERTED.
|
1070
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1071
|
+
example: |
|
1072
|
+
PROGRESSBAR INST ADCS POSPROGRESS 0.5 200
|
1073
|
+
PROGRESSBAR INST ADCS POSPROGRESS
|
1074
|
+
RANGEBAR:
|
1075
|
+
summary: Displays a custom range bar displaying the item value
|
1076
|
+
parameters:
|
1077
|
+
- name: Target name
|
1078
|
+
required: true
|
1079
|
+
description: The target name
|
1080
|
+
values: .+
|
1081
|
+
- name: Packet name
|
1082
|
+
required: true
|
1083
|
+
description: The packet name
|
1084
|
+
values: .+
|
1085
|
+
- name: Item name
|
1086
|
+
required: true
|
1087
|
+
description: The item name
|
1088
|
+
values: .+
|
1089
|
+
- name: Low Value
|
1090
|
+
required: true
|
1091
|
+
description:
|
1092
|
+
Minimum value to display on the range bar. If the telemetry
|
1093
|
+
item goes below this value the bar is “pegged” on the low end.
|
1094
|
+
values: .+
|
1095
|
+
- name: High Value
|
1096
|
+
required: true
|
1097
|
+
description:
|
1098
|
+
Maximum value to display on the range bar. If the telemetry
|
1099
|
+
item goes above this value the bar is “pegged” on the high end.
|
1100
|
+
values: .+
|
1101
|
+
- name: Value type
|
1102
|
+
required: false
|
1103
|
+
description: The type of the value to display. Default is CONVERTED.
|
1104
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1105
|
+
- name: Width
|
1106
|
+
required: false
|
1107
|
+
description: Width of the range bar (default = 100)
|
1108
|
+
values: .*
|
1109
|
+
- name: Height
|
1110
|
+
required: false
|
1111
|
+
description: Height of the range bar (default = 25)
|
1112
|
+
values: .*
|
1113
|
+
example: |
|
1114
|
+
RANGEBAR INST HEALTH_STATUS TEMP1 0 100000 RAW 200 50
|
1115
|
+
RANGEBAR INST HEALTH_STATUS TEMP1 -100 100
|
1116
|
+
# RANGECOLUMN:
|
1117
|
+
# summary: Displays a graphical representation of where
|
1118
|
+
# an item's value falls withing a range vertically
|
1119
|
+
# parameters:
|
1120
|
+
# - name: Target name
|
1121
|
+
# required: true
|
1122
|
+
# description: The target name
|
1123
|
+
# values: .+
|
1124
|
+
# - name: Packet name
|
1125
|
+
# required: true
|
1126
|
+
# description: The packet name
|
1127
|
+
# values: .+
|
1128
|
+
# - name: Item name
|
1129
|
+
# required: true
|
1130
|
+
# description: The item name
|
1131
|
+
# values: .+
|
1132
|
+
# - name: Low Value
|
1133
|
+
# required: true
|
1134
|
+
# description: Minimum value to display on the range bar. If the telemetry
|
1135
|
+
# item goes below this value the bar is “pegged” on the low end.
|
1136
|
+
# values: .+
|
1137
|
+
# - name: High Value
|
1138
|
+
# required: true
|
1139
|
+
# description: Maximum value to display on the range bar. If the telemetry
|
1140
|
+
# item goes above this value the bar is “pegged” on the high end.
|
1141
|
+
# values: .+
|
1142
|
+
# - name: Value type
|
1143
|
+
# required: false
|
1144
|
+
# description: The type of the value to display. Default is CONVERTED.
|
1145
|
+
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1146
|
+
# - name: Width
|
1147
|
+
# required: false
|
1148
|
+
# description: Width of the range bar (default = 30)
|
1149
|
+
# values: .*
|
1150
|
+
# - name: Height
|
1151
|
+
# required: false
|
1152
|
+
# description: Height of the range bar (default = 100)
|
1153
|
+
# values: .*
|
1154
|
+
# example: |
|
1155
|
+
# RANGECOLUMN INST HEALTH_STATUS TEMP1 0 100000 RAW 200 50
|
1156
|
+
# RANGECOLUMN INST HEALTH_STATUS TEMP1 -100 100
|
1157
|
+
TEXTBOX:
|
1158
|
+
summary: Provides a large box for multiline text
|
1159
|
+
parameters:
|
1160
|
+
- name: Target name
|
1161
|
+
required: true
|
1162
|
+
description: The target name
|
1163
|
+
values: .+
|
1164
|
+
- name: Packet name
|
1165
|
+
required: true
|
1166
|
+
description: The packet name
|
1167
|
+
values: .+
|
1168
|
+
- name: Item name
|
1169
|
+
required: true
|
1170
|
+
description: The item name
|
1171
|
+
values: .+
|
1172
|
+
- name: Width
|
1173
|
+
required: false
|
1174
|
+
description: Width of the textbox in px (default = 200)
|
1175
|
+
values: .*
|
1176
|
+
- name: Height
|
1177
|
+
required: false
|
1178
|
+
description: Height of the textbox in px (default = 200)
|
1179
|
+
values: .*
|
1180
|
+
example: |
|
1181
|
+
TEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED 150 70
|
1182
|
+
TEXTBOX INST HEALTH_STATUS PACKET_TIMEFORMATTED
|
1183
|
+
# TRENDBAR:
|
1184
|
+
# summary: Provides the same functionality as the LIMITSBAR
|
1185
|
+
# widget except that it also keeps a history of the telemetry item and
|
1186
|
+
# graphically shows where the value was X seconds ago.
|
1187
|
+
# parameters:
|
1188
|
+
# - name: Target name
|
1189
|
+
# required: true
|
1190
|
+
# description: The target name
|
1191
|
+
# values: .+
|
1192
|
+
# - name: Packet name
|
1193
|
+
# required: true
|
1194
|
+
# description: The packet name
|
1195
|
+
# values: .+
|
1196
|
+
# - name: Item name
|
1197
|
+
# required: true
|
1198
|
+
# description: The item name
|
1199
|
+
# values: .+
|
1200
|
+
# - name: Value type
|
1201
|
+
# required: false
|
1202
|
+
# description: The type of the value to display. Default is CONVERTED.
|
1203
|
+
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1204
|
+
# - name: Trend Seconds
|
1205
|
+
# required: false
|
1206
|
+
# description: The number of seconds in the past to display the trend value (default = 60)
|
1207
|
+
# values: .*
|
1208
|
+
# - name: Width
|
1209
|
+
# required: false
|
1210
|
+
# description: Width of the limits bar (default = 160)
|
1211
|
+
# values: .*
|
1212
|
+
# - name: Height
|
1213
|
+
# required: false
|
1214
|
+
# description: Height of the limits bar (default = 25)
|
1215
|
+
# values: .*
|
1216
|
+
# example: |
|
1217
|
+
# TRENDBAR INST HEALTH_STATUS TEMP1 CONVERTED 20 200 50
|
1218
|
+
# TRENDBAR INST HEALTH_STATUS TEMP1
|
1219
|
+
# TRENDLIMITSBAR:
|
1220
|
+
# summary: Displays a VALUE widget to show the telemetry items current value,
|
1221
|
+
# a VALUE widget to display the value of the item X seconds ago, and a TRENDBAR
|
1222
|
+
# widget to display the items value within its limits ranges and its trend.
|
1223
|
+
# parameters:
|
1224
|
+
# - name: Target name
|
1225
|
+
# required: true
|
1226
|
+
# description: The target name
|
1227
|
+
# values: .+
|
1228
|
+
# - name: Packet name
|
1229
|
+
# required: true
|
1230
|
+
# description: The packet name
|
1231
|
+
# values: .+
|
1232
|
+
# - name: Item name
|
1233
|
+
# required: true
|
1234
|
+
# description: The item name
|
1235
|
+
# values: .+
|
1236
|
+
# - name: Value type
|
1237
|
+
# required: false
|
1238
|
+
# description: The type of the value to display. Default is CONVERTED.
|
1239
|
+
# values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1240
|
+
# - name: Trend Seconds
|
1241
|
+
# required: false
|
1242
|
+
# description: The number of seconds in the past to display the trend value (default = 60)
|
1243
|
+
# values: .*
|
1244
|
+
# - name: Characters
|
1245
|
+
# required: false
|
1246
|
+
# description: The number of characters to display the telemetry value (default = 12)
|
1247
|
+
# values: .*
|
1248
|
+
# - name: Width
|
1249
|
+
# required: false
|
1250
|
+
# description: Width of the limits bar (default = 160)
|
1251
|
+
# values: .*
|
1252
|
+
# - name: Height
|
1253
|
+
# required: false
|
1254
|
+
# description: Height of the limits bar (default = 25)
|
1255
|
+
# values: .*
|
1256
|
+
# example: |
|
1257
|
+
# TRENDLIMITSBAR INST HEALTH_STATUS TEMP1 CONVERTED 20 20 200 50
|
1258
|
+
# TRENDLIMITSBAR INST HEALTH_STATUS TEMP1
|
1259
|
+
VALUE:
|
1260
|
+
summary: Displays a box with a telemetry item value
|
1261
|
+
description:
|
1262
|
+
The white portion of the box darkens to gray while the value remains stagnant, then
|
1263
|
+
brightens to white each time the value changes. Additionally the value is
|
1264
|
+
colored based on the items limits state (Red for example if it is out of limits).
|
1265
|
+
parameters:
|
1266
|
+
- name: Target name
|
1267
|
+
required: true
|
1268
|
+
description: The target name
|
1269
|
+
values: .+
|
1270
|
+
- name: Packet name
|
1271
|
+
required: true
|
1272
|
+
description: The packet name
|
1273
|
+
values: .+
|
1274
|
+
- name: Item name
|
1275
|
+
required: true
|
1276
|
+
description: The item name
|
1277
|
+
values: .+
|
1278
|
+
- name: Value type
|
1279
|
+
required: false
|
1280
|
+
description: The type of the value to display. Default is CONVERTED.
|
1281
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1282
|
+
- name: Number of characters
|
1283
|
+
required: false
|
1284
|
+
description: The number of characters wide to make the value box (default = 12)
|
1285
|
+
values: .*
|
1286
|
+
example: |
|
1287
|
+
VALUE INST HEALTH_STATUS TEMP1 CONVERTED 18
|
1288
|
+
VALUE INST HEALTH_STATUS TEMP1
|
1289
|
+
Interactive Widgets:
|
1290
|
+
description: Interactive widgets are used to gather input from the user.
|
1291
|
+
Unlike all other widgets, which only output some graphical representation,
|
1292
|
+
interactive widgets permit input either from the keyboard or mouse.
|
1293
|
+
collection:
|
1294
|
+
BUTTON:
|
1295
|
+
summary: Displays a rectangular clickable button
|
1296
|
+
description: |
|
1297
|
+
Upon clicking, the button executes the Ruby code assigned. Buttons
|
1298
|
+
can be used to send commands and perform other tasks. If you want your button
|
1299
|
+
to use values from other widgets, define them as named widgets and read their
|
1300
|
+
values using the `screen.getNamedWidget("WIDGET_NAME").text()` method.
|
1301
|
+
See the example in CHECKBUTTON.
|
1302
|
+
|
1303
|
+
Button code can get rather complex so remember to use string concatenation
|
1304
|
+
to make things more readable. If you use `+` newlines are inserted automatically
|
1305
|
+
during string concatenation. If you use `\` you'll need to separate lines with a
|
1306
|
+
single semicolon `;`. COSMOS uses double semicolon `;;` to indicate lines should
|
1307
|
+
be evaluated separately. Note that all OpenC3 commands (using api.cmd) must be
|
1308
|
+
separated by `;;`.
|
1309
|
+
|
1310
|
+
You can send commands with buttons using api.cmd(). The cmd() syntax looks exactly
|
1311
|
+
like the standard COSMOS Ruby scripting syntax. You can also request and use
|
1312
|
+
telemetry in screens using Javascript Promises.
|
1313
|
+
|
1314
|
+
`api.tlm('INST PARAMS VALUE3', 'RAW').then(dur => api.cmd('INST COLLECT with TYPE NORMAL, DURATION '+dur))"`
|
1315
|
+
|
1316
|
+
The api.tlm() function returns a Promise which is resolved with then()
|
1317
|
+
at which point we send the command with the telemetry value we received.
|
1318
|
+
|
1319
|
+
Scripts can be launched from a BUTTON using the `runScript()` method.
|
1320
|
+
# warning:
|
1321
|
+
# If your button logic gets complex it's recommended to require a separate
|
1322
|
+
# script and pass the screen to the script using self,
|
1323
|
+
# e.g. require utility.rb; utility_method(self).
|
1324
|
+
parameters:
|
1325
|
+
- name: Button Text
|
1326
|
+
required: true
|
1327
|
+
description: Text displayed on the button
|
1328
|
+
values: .+
|
1329
|
+
- name: Button Code
|
1330
|
+
required: true
|
1331
|
+
description: Javascript code to execute when the button is pressed
|
1332
|
+
values: .+
|
1333
|
+
example: |
|
1334
|
+
BUTTON 'Start Collect' 'api.cmd("INST COLLECT with TYPE NORMAL, DURATION 5")'
|
1335
|
+
BUTTON 'Run Script' 'runScript("INST/procedures/script.rb")'
|
1336
|
+
CHECKBUTTON:
|
1337
|
+
summary: Displays a check box
|
1338
|
+
description:
|
1339
|
+
Note this is of limited use by itself and is primarily used in
|
1340
|
+
conjunction with NAMED_WIDGET.
|
1341
|
+
parameters:
|
1342
|
+
- name: Checkbox Text
|
1343
|
+
required: true
|
1344
|
+
description: Text displayed next to the checkbox
|
1345
|
+
values: .+
|
1346
|
+
example: |
|
1347
|
+
NAMED_WIDGET CHECK CHECKBUTTON 'Ignore Hazardous Checks'
|
1348
|
+
BUTTON 'Send' 'screen.getNamedWidget("CHECK").checked() ? ' \
|
1349
|
+
'api.cmd_no_hazardous_check("INST CLEAR") : api.cmd("INST CLEAR")'
|
1350
|
+
COMBOBOX:
|
1351
|
+
summary: Displays a drop down list of text items
|
1352
|
+
description:
|
1353
|
+
Note this is of limited use by itself and is primarily used in
|
1354
|
+
conjunction with NAMED_WIDGET.
|
1355
|
+
parameters:
|
1356
|
+
- name: Option Text 1
|
1357
|
+
required: true
|
1358
|
+
description: Text to display in the selection drop down
|
1359
|
+
values: .+
|
1360
|
+
- name: Option Text n
|
1361
|
+
required: false
|
1362
|
+
description: Text to display in the selection drop down
|
1363
|
+
values: .+
|
1364
|
+
example: |
|
1365
|
+
BUTTON 'Start Collect' 'var type = screen.getNamedWidget("COLLECT_TYPE").text();' +
|
1366
|
+
'api.cmd("INST COLLECT with TYPE "+type+", DURATION 10.0")'
|
1367
|
+
NAMED_WIDGET COLLECT_TYPE COMBOBOX NORMAL SPECIAL
|
1368
|
+
RADIOGROUP:
|
1369
|
+
summary: Creates a group of RADIOBUTTONs
|
1370
|
+
description: RADIOBUTTONs must be part of a group to enable selection logic
|
1371
|
+
parameters:
|
1372
|
+
- name: Initial selected button
|
1373
|
+
required: false
|
1374
|
+
description: Selects a radio button at initialization (0-based)
|
1375
|
+
values: \d+
|
1376
|
+
RADIOBUTTON:
|
1377
|
+
summary: Displays a radio button and text
|
1378
|
+
description:
|
1379
|
+
Note this is of limited use by itself and is primarily used in
|
1380
|
+
conjunction with NAMED_WIDGET. It must be contained by a RADIOGROUP to enable
|
1381
|
+
typical selection of a single RADIOBUTTON.
|
1382
|
+
parameters:
|
1383
|
+
- name: Text
|
1384
|
+
required: true
|
1385
|
+
description: Text to display next to the radio button
|
1386
|
+
values: .+
|
1387
|
+
example: |
|
1388
|
+
NAMED_WIDGET GROUP RADIOGROUP 1 # Select 'Clear' initially, 0-based index
|
1389
|
+
RADIOBUTTON 'Abort'
|
1390
|
+
RADIOBUTTON 'Clear'
|
1391
|
+
END
|
1392
|
+
BUTTON 'Send' "screen.getNamedWidget('GROUP').selected() === 0 ? " +
|
1393
|
+
"api.cmd('INST ABORT') : api.cmd('INST CLEAR')"
|
1394
|
+
TEXTFIELD:
|
1395
|
+
summary: Displays a rectangular box where the user can enter text
|
1396
|
+
parameters:
|
1397
|
+
- name: Characters
|
1398
|
+
required: false
|
1399
|
+
description: Width of the text field in characters (default = 12)
|
1400
|
+
values: .*
|
1401
|
+
- name: Text
|
1402
|
+
required: false
|
1403
|
+
description: Default text to put in the text field (default is blank)
|
1404
|
+
values: .*
|
1405
|
+
example: |
|
1406
|
+
NAMED_WIDGET DURATION TEXTFIELD 12 "10.0"
|
1407
|
+
BUTTON 'Start Collect' 'var dur = screen.getNamedWidget("DURATION").text();' +
|
1408
|
+
'api.cmd("INST COLLECT with TYPE NORMAL, DURATION "+dur+"")'
|
1409
|
+
Canvas Widgets:
|
1326
1410
|
description:
|
1327
|
-
|
1328
|
-
|
1329
|
-
|
1330
|
-
|
1331
|
-
|
1332
|
-
description:
|
1333
|
-
|
1334
|
-
|
1335
|
-
|
1336
|
-
|
1337
|
-
|
1338
|
-
|
1339
|
-
|
1340
|
-
|
1341
|
-
|
1342
|
-
|
1343
|
-
|
1344
|
-
|
1345
|
-
|
1346
|
-
|
1347
|
-
|
1348
|
-
|
1349
|
-
|
1350
|
-
|
1351
|
-
|
1352
|
-
|
1353
|
-
|
1354
|
-
|
1355
|
-
|
1356
|
-
|
1357
|
-
|
1358
|
-
|
1359
|
-
|
1360
|
-
|
1361
|
-
|
1362
|
-
|
1363
|
-
|
1364
|
-
|
1365
|
-
|
1366
|
-
|
1367
|
-
|
1368
|
-
|
1369
|
-
|
1370
|
-
|
1371
|
-
|
1372
|
-
|
1373
|
-
|
1374
|
-
|
1375
|
-
|
1376
|
-
|
1377
|
-
|
1378
|
-
|
1379
|
-
|
1380
|
-
|
1381
|
-
|
1382
|
-
|
1383
|
-
|
1384
|
-
|
1385
|
-
|
1386
|
-
|
1387
|
-
|
1388
|
-
|
1389
|
-
|
1390
|
-
|
1391
|
-
|
1392
|
-
|
1393
|
-
|
1394
|
-
|
1395
|
-
|
1396
|
-
|
1397
|
-
|
1398
|
-
|
1399
|
-
|
1400
|
-
|
1401
|
-
|
1402
|
-
|
1403
|
-
|
1404
|
-
|
1405
|
-
|
1406
|
-
|
1407
|
-
|
1408
|
-
|
1409
|
-
|
1410
|
-
|
1411
|
-
|
1412
|
-
|
1413
|
-
|
1414
|
-
|
1415
|
-
|
1416
|
-
|
1417
|
-
|
1418
|
-
|
1419
|
-
|
1420
|
-
|
1421
|
-
|
1422
|
-
|
1423
|
-
|
1424
|
-
|
1425
|
-
|
1426
|
-
|
1427
|
-
|
1428
|
-
|
1429
|
-
|
1430
|
-
|
1431
|
-
|
1432
|
-
|
1433
|
-
|
1434
|
-
|
1435
|
-
|
1436
|
-
|
1437
|
-
|
1438
|
-
|
1439
|
-
|
1440
|
-
|
1441
|
-
|
1442
|
-
|
1443
|
-
|
1444
|
-
|
1445
|
-
|
1446
|
-
|
1447
|
-
|
1448
|
-
|
1449
|
-
|
1450
|
-
|
1451
|
-
|
1452
|
-
|
1453
|
-
|
1454
|
-
|
1455
|
-
|
1456
|
-
|
1457
|
-
|
1458
|
-
|
1459
|
-
|
1460
|
-
|
1461
|
-
|
1462
|
-
|
1463
|
-
|
1464
|
-
|
1465
|
-
|
1466
|
-
|
1467
|
-
|
1468
|
-
|
1469
|
-
|
1470
|
-
|
1471
|
-
|
1472
|
-
|
1473
|
-
|
1474
|
-
|
1475
|
-
|
1476
|
-
|
1477
|
-
|
1478
|
-
|
1479
|
-
|
1480
|
-
|
1481
|
-
|
1482
|
-
|
1483
|
-
|
1484
|
-
|
1485
|
-
|
1486
|
-
|
1487
|
-
|
1488
|
-
|
1489
|
-
|
1490
|
-
|
1491
|
-
|
1492
|
-
|
1493
|
-
|
1494
|
-
|
1495
|
-
|
1496
|
-
|
1497
|
-
|
1411
|
+
Canvas Widgets are used to draw custom displays into telemetry screens.
|
1412
|
+
The canvas coordinate frame places (0,0) in the upper-left corner of the canvas.
|
1413
|
+
collection:
|
1414
|
+
CANVAS:
|
1415
|
+
summary: Layout widget for the other canvas widgets
|
1416
|
+
description: All canvas widgets must be enclosed within a CANVAS widget.
|
1417
|
+
warning: The canvas coordinate frame places (0,0) in the upper-left corner of the canvas.
|
1418
|
+
parameters:
|
1419
|
+
- name: Width
|
1420
|
+
required: true
|
1421
|
+
description: Width of the canvas
|
1422
|
+
values: .+
|
1423
|
+
- name: Height
|
1424
|
+
required: true
|
1425
|
+
description: Height of the canvas
|
1426
|
+
values: .+
|
1427
|
+
CANVASLABEL:
|
1428
|
+
summary: Draws text onto the canvas
|
1429
|
+
parameters:
|
1430
|
+
- name: X Position
|
1431
|
+
required: true
|
1432
|
+
description: X position of the upper-left corner of the text on the canvas
|
1433
|
+
values: \d+
|
1434
|
+
- name: Y Position
|
1435
|
+
required: true
|
1436
|
+
description: Y position of the upper-left corner of the text on the canvas
|
1437
|
+
values: \d+
|
1438
|
+
- name: Text
|
1439
|
+
required: true
|
1440
|
+
description: Text to draw onto the canvas
|
1441
|
+
values: .+
|
1442
|
+
- name: Font Size
|
1443
|
+
required: false
|
1444
|
+
description: Font size of the text (Default = 12)
|
1445
|
+
values: \d+
|
1446
|
+
- name: Color
|
1447
|
+
required: false
|
1448
|
+
description: Color of the text
|
1449
|
+
values: .+
|
1450
|
+
example: |
|
1451
|
+
CANVAS 100 100
|
1452
|
+
CANVASLABEL 5 34 "Label1" 24 red
|
1453
|
+
CANVASLABEL 5 70 "Label2" 18 blue
|
1454
|
+
END
|
1455
|
+
CANVASLABELVALUE:
|
1456
|
+
summary: Draws the text value of a telemetry item onto the canvas in an optional frame
|
1457
|
+
parameters:
|
1458
|
+
- name: Target name
|
1459
|
+
required: true
|
1460
|
+
description: The target name
|
1461
|
+
values: .+
|
1462
|
+
- name: Packet name
|
1463
|
+
required: true
|
1464
|
+
description: The packet name
|
1465
|
+
values: .+
|
1466
|
+
- name: Item name
|
1467
|
+
required: true
|
1468
|
+
description: The item name
|
1469
|
+
values: .+
|
1470
|
+
- name: X Position
|
1471
|
+
required: true
|
1472
|
+
description: X position of the upper-left corner of the text on the canvas
|
1473
|
+
values: \d+
|
1474
|
+
- name: Y Position
|
1475
|
+
required: true
|
1476
|
+
description: Y position of the upper-left corner of the text on the canvas
|
1477
|
+
values: \d+
|
1478
|
+
- name: Font Size
|
1479
|
+
required: false
|
1480
|
+
description: Font size of the text (Default = 12)
|
1481
|
+
values: \d+
|
1482
|
+
- name: Color
|
1483
|
+
required: false
|
1484
|
+
description: Color of the text
|
1485
|
+
values: .+
|
1486
|
+
- name: Value type
|
1487
|
+
required: false
|
1488
|
+
description: The type of the value to display. Default is CONVERTED.
|
1489
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1490
|
+
example: |
|
1491
|
+
CANVAS 200 100
|
1492
|
+
CANVASLABELVALUE INST HEALTH_STATUS TEMP1 5 34 12 red
|
1493
|
+
CANVASLABELVALUE INST HEALTH_STATUS TEMP2 5 70 10 blue WITH_UNITS
|
1494
|
+
END
|
1495
|
+
CANVASIMAGE:
|
1496
|
+
summary: Displays an image on the canvas
|
1497
|
+
parameters:
|
1498
|
+
- name: Image filename
|
1499
|
+
required: true
|
1500
|
+
description: Name of a image file. The file must be in the plugin's targets/TARGET/public directory.
|
1501
|
+
values: .+
|
1502
|
+
- name: X Position
|
1503
|
+
required: true
|
1504
|
+
description: X position of the upper-left corner of the image on the canvas
|
1505
|
+
values: \d+
|
1506
|
+
- name: Y Position
|
1507
|
+
required: true
|
1508
|
+
description: Y position of the upper-left corner of the image on the canvas
|
1509
|
+
values: \d+
|
1510
|
+
example: |
|
1511
|
+
CANVAS 250 430
|
1512
|
+
CANVASIMAGE "satellite.png" 10 10 200 200
|
1513
|
+
SETTING SCREEN INST HS
|
1514
|
+
CANVASIMAGE "https://images.pexels.com/photos/256152/pexels-photo-256152.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=640&w=426" 0 250 250 150
|
1515
|
+
END
|
1516
|
+
settings:
|
1517
|
+
SCREEN:
|
1518
|
+
summary: Open another screen when clicked
|
1519
|
+
parameters:
|
1520
|
+
- name: Target name
|
1521
|
+
required: true
|
1522
|
+
description: Name of the target
|
1523
|
+
values: .+
|
1524
|
+
- name: Screen name
|
1525
|
+
required: true
|
1526
|
+
description: Name of the screen
|
1527
|
+
values: .+
|
1528
|
+
CANVASIMAGEVALUE:
|
1529
|
+
summary: Displays an image on the canvas that changes with a telemetry value
|
1530
|
+
description:
|
1531
|
+
Use various SETTING values to indicate which images should be displayed based on telemetry.
|
1532
|
+
For example, SETTING IMAGE CONNECTED "ground_on.png" 400 100. See the DEMO for a complete example.
|
1533
|
+
parameters:
|
1534
|
+
- name: Target name
|
1535
|
+
required: true
|
1536
|
+
description: The target name
|
1537
|
+
values: .+
|
1538
|
+
- name: Packet name
|
1539
|
+
required: true
|
1540
|
+
description: The packet name
|
1541
|
+
values: .+
|
1542
|
+
- name: Item name
|
1543
|
+
required: true
|
1544
|
+
description: The item name
|
1545
|
+
values: .+
|
1546
|
+
- name: Value type
|
1547
|
+
required: true
|
1548
|
+
description: The type of the value to display
|
1549
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1550
|
+
- name: Default image filename
|
1551
|
+
required: true
|
1552
|
+
description: The default image to display. The file must be in the targets/TARGET/public directory.
|
1553
|
+
values: .+
|
1554
|
+
- name: X Position
|
1555
|
+
required: true
|
1556
|
+
description: X position of the upper-left corner of the image on the canvas
|
1557
|
+
values: \d+
|
1558
|
+
- name: Y Position
|
1559
|
+
required: true
|
1560
|
+
description: Y position of the upper-left corner of the image on the canvas
|
1561
|
+
values: \d+
|
1562
|
+
- name: Image width
|
1563
|
+
required: false
|
1564
|
+
description: Width of the image (default is 100%)
|
1565
|
+
values: \d+
|
1566
|
+
- name: Image height
|
1567
|
+
required: false
|
1568
|
+
description: Height of the image (default is 100%)
|
1569
|
+
values: \d+
|
1570
|
+
example: |
|
1571
|
+
CANVAS 230 230
|
1572
|
+
CANVASIMAGEVALUE INST HEALTH_STATUS GROUND1STATUS CONVERTED "ground_error.png" 10 10 180 180
|
1573
|
+
SETTING IMAGE CONNECTED "ground_on.png" 10 10
|
1574
|
+
SETTING IMAGE UNAVAILABLE "ground_off.png" 10 10
|
1575
|
+
SETTING SCREEN INST HS
|
1576
|
+
END
|
1577
|
+
settings:
|
1578
|
+
IMAGE:
|
1579
|
+
summary: Map an image to a state or value
|
1580
|
+
parameters:
|
1581
|
+
- name: Value
|
1582
|
+
required: true
|
1583
|
+
description: State or value
|
1584
|
+
values: .+
|
1585
|
+
- name: Image filename
|
1586
|
+
required: true
|
1587
|
+
description: Image to display. The file must be in the targets/TARGET/public directory.
|
1588
|
+
values: .+
|
1589
|
+
- name: X Position
|
1590
|
+
required: true
|
1591
|
+
description: X position of the upper-left corner of the image on the canvas
|
1592
|
+
values: \d+
|
1593
|
+
- name: Y Position
|
1594
|
+
required: true
|
1595
|
+
description: Y position of the upper-left corner of the image on the canvas
|
1596
|
+
values: \d+
|
1597
|
+
SCREEN:
|
1598
|
+
summary: Open another screen when clicked
|
1599
|
+
parameters:
|
1600
|
+
- name: Target name
|
1601
|
+
required: true
|
1602
|
+
description: Name of the target
|
1603
|
+
values: .+
|
1604
|
+
- name: Screen name
|
1605
|
+
required: true
|
1606
|
+
description: Name of the screen
|
1607
|
+
values: .+
|
1608
|
+
CANVASLINE:
|
1609
|
+
summary: Draws a line onto the canvas
|
1610
|
+
parameters:
|
1611
|
+
- name: Start X Position
|
1612
|
+
required: true
|
1613
|
+
description: X position of the start of the line on the canvas
|
1614
|
+
values: \d+
|
1615
|
+
- name: Start Y Position
|
1616
|
+
required: true
|
1617
|
+
description: Y position of the start of the line on the canvas
|
1618
|
+
values: \d+
|
1619
|
+
- name: End X Position
|
1620
|
+
required: true
|
1621
|
+
description: X position of the end of the line on the canvas
|
1622
|
+
values: \d+
|
1623
|
+
- name: End Y Position
|
1624
|
+
required: true
|
1625
|
+
description: Y position of the end of the line on the canvas
|
1626
|
+
values: \d+
|
1627
|
+
- name: Color
|
1628
|
+
required: false
|
1629
|
+
description: Color of the line
|
1630
|
+
values: .+
|
1631
|
+
- name: Width
|
1632
|
+
required: false
|
1633
|
+
description: Width of the line in pixels (default = 1)
|
1634
|
+
values: \d+
|
1635
|
+
example: |
|
1636
|
+
CANVAS 100 50
|
1637
|
+
CANVASLINE 5 5 95 5
|
1638
|
+
CANVASLINE 5 5 5 45 green 2
|
1639
|
+
CANVASLINE 95 5 95 45 blue 3
|
1640
|
+
END
|
1641
|
+
CANVASLINEVALUE:
|
1642
|
+
summary: Draws a color changing line onto the canvas
|
1643
|
+
description:
|
1644
|
+
The line is represented by one of two colors based on the value
|
1645
|
+
of the associated telemetry item
|
1646
|
+
parameters:
|
1647
|
+
- name: Target name
|
1648
|
+
required: true
|
1649
|
+
description: The target name
|
1650
|
+
values: .+
|
1651
|
+
- name: Packet name
|
1652
|
+
required: true
|
1653
|
+
description: The packet name
|
1654
|
+
values: .+
|
1655
|
+
- name: Item name
|
1656
|
+
required: true
|
1657
|
+
description: The item name
|
1658
|
+
values: .+
|
1659
|
+
- name: Start X Position
|
1660
|
+
required: true
|
1661
|
+
description: X position of the start of the line on the canvas
|
1662
|
+
values: \d+
|
1663
|
+
- name: Start Y Position
|
1664
|
+
required: true
|
1665
|
+
description: Y position of the start of the line on the canvas
|
1666
|
+
values: \d+
|
1667
|
+
- name: End X Position
|
1668
|
+
required: true
|
1669
|
+
description: X position of the end of the line on the canvas
|
1670
|
+
values: \d+
|
1671
|
+
- name: End Y Position
|
1672
|
+
required: true
|
1673
|
+
description: Y position of the end of the line on the canvas
|
1674
|
+
values: \d+
|
1675
|
+
- name: Width
|
1676
|
+
required: false
|
1677
|
+
description: Width of the line in pixels (default = 3)
|
1678
|
+
values: \d+
|
1679
|
+
- name: Value type
|
1680
|
+
required: false
|
1681
|
+
description: The type of the value to display. Default is CONVERTED
|
1682
|
+
values: <%= %w(RAW CONVERTED FORMATTED WITH_UNITS) %>
|
1683
|
+
example: |
|
1684
|
+
CANVAS 120 50
|
1685
|
+
CANVASLABELVALUE INST HEALTH_STATUS GROUND1STATUS 0 12 12 black
|
1686
|
+
CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 25 115 25 5 RAW
|
1687
|
+
SETTING VALUE_EQ 1 GREEN
|
1688
|
+
SETTING VALUE_EQ 0 RED
|
1689
|
+
CANVASLINEVALUE INST HEALTH_STATUS GROUND1STATUS 5 45 115 45
|
1690
|
+
SETTING VALUE_EQ CONNECTED GREEN
|
1691
|
+
SETTING VALUE_EQ UNAVAILABLE RED
|
1692
|
+
END
|
1693
|
+
settings:
|
1694
|
+
# Inject the canvas value settings
|
1695
|
+
<%= MetaConfigParser.load('_canvas_values.yaml').to_meta_config_yaml(8) %>
|
1696
|
+
CANVASDOT:
|
1697
|
+
summary: Draws a dot onto the canvas
|
1698
|
+
parameters:
|
1699
|
+
- name: X Position
|
1700
|
+
required: true
|
1701
|
+
description: X position of the dot
|
1702
|
+
values: .+
|
1703
|
+
- name: Y Position
|
1704
|
+
required: true
|
1705
|
+
description: Y position of the dot
|
1706
|
+
values: .+
|
1707
|
+
- name: Color
|
1708
|
+
required: true
|
1709
|
+
description: Color of the dot
|
1710
|
+
values: .+
|
1711
|
+
- name: Radius
|
1712
|
+
required: true
|
1713
|
+
description: Radius of the dot in pixels
|
1714
|
+
values: \d+
|
1715
|
+
example: |
|
1716
|
+
CANVAS 50 50
|
1717
|
+
CANVASDOT 10 15 BLUE 5
|
1718
|
+
END
|
1719
|
+
# CANVASELLIPSE:
|
1720
|
+
# summary: The CANVASELLIPSE widget draws an ellipse onto the canvas
|
1721
|
+
# parameters:
|
1722
|
+
# - name: X Center
|
1723
|
+
# required: true
|
1724
|
+
# description: X position of the center of the ellipse
|
1725
|
+
# values: \d+
|
1726
|
+
# - name: Y Center
|
1727
|
+
# required: true
|
1728
|
+
# description: Y position of the center of the ellipse
|
1729
|
+
# values: \d+
|
1730
|
+
# - name: Width
|
1731
|
+
# required: true
|
1732
|
+
# description: Width of the ellipse in pixels
|
1733
|
+
# values: \d+
|
1734
|
+
# - name: Height
|
1735
|
+
# required: true
|
1736
|
+
# description: Height of the ellipse in pixels
|
1737
|
+
# values: \d+
|
1738
|
+
# - name: Color
|
1739
|
+
# required: false
|
1740
|
+
# description: Color of the ellipse. Default is black.
|
1741
|
+
# values: .+
|
1742
|
+
# - name: Line Width
|
1743
|
+
# required: false
|
1744
|
+
# description: Width of the line. Default is 1
|
1745
|
+
# values: \d+
|
1746
|
+
# - name: Fill
|
1747
|
+
# required: false
|
1748
|
+
# description: Whether to fill the ellipse. Default is false.
|
1749
|
+
# values: .+
|