openc3 5.5.0 → 5.5.1

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