openc3 5.5.0 → 5.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of openc3 might be problematic. Click here for more details.

checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0a21cdfc706de17b576884e2d65593ed329ce736d12384ce0ab1880b3d5d7986
4
- data.tar.gz: a1927adc509a3087157cfc5b35737f01796c7fe54a711dd7e750a56de14d7b17
3
+ metadata.gz: a2b1524aa1d06a8149e80ffb2843b3a9304d73cf432ecd641396292bf5209439
4
+ data.tar.gz: f35947a803088cb83705c3748fb860751cf40228a5c4720d151c867a001157ce
5
5
  SHA512:
6
- metadata.gz: 0dc0c6851d30a29b647ae243b7cb6bfcf641c8cea7a86b41277c677a02f60ce9558f5bb1d37255eb358e99d4670c67e5fa9fecbe422055b061df10ee167591fb
7
- data.tar.gz: ed5c29f6c49930381ed2985e22736ec5ee2037774c60ec50d27e25afddd6ab90224d1012ff57ffa109402abe489abeafa78faf63e9111e65fa7689ec65222b3f
6
+ metadata.gz: 245f9f7fe39f5ac4f82bab653de55f413432b3ad9f73b586f2d82f2a14e50bcd6d77a5bc11e1b4a9a2f95c4b11c2aef55dcc325ab330da076ecdb7f0245fb374
7
+ data.tar.gz: 2f142eea4029f7b1efd3564578413e09d23acd6b9136799d123db48e733577d28a50c3e90640143e20e8f092874ec08c277df6ca721cf2a33bc4c1ffeabf42ba
@@ -0,0 +1,41 @@
1
+ VALUE_EQ:
2
+ summary: Map a value to a color
3
+ parameters:
4
+ - name: Value
5
+ required: true
6
+ description: State or value
7
+ values: .+
8
+ - name: Color
9
+ required: true
10
+ description: Color of the line
11
+ values: .+
12
+ # TODO: At one point for CANVASIMAGEVALUE, CANVASLABELVALUE, and CANVASLINEVALUE
13
+ # supported VALUE_GT, VALUE_GTEQ, VALUE_LT, VALUE_LTEQ
14
+ # which are identical to VALUE_EQ except greater than, less than.
15
+ # They also supported TLM_AND and TLM_OR defined as:
16
+ ### TLM_AND
17
+ # The TLM_AND setting allows added another comparison that is anded with the original comparison for a canvas value widget to determine 'ON' state
18
+ # | Parameter | Description | Required |
19
+ # | --------------- | ---------------------------------------------------------------------------- | -------- |
20
+ # | Target Name | The target name portion of the telemetry mnemonic | Yes |
21
+ # | Packet Name | The packet name portion of the telemetry mnemonic | Yes |
22
+ # | Item Name | The item name portion of the telemetry mnemonic | Yes |
23
+ # | Comparison Type | The comparison type: VALUE_EQ, VALUE_GT, VALUE_GTEQ, VALUE_LT, or VALUE_LTEQ | Yes |
24
+ # | Value | The value to compare against | Yes |
25
+ # Example Usage:
26
+ # CANVASIMAGEVALUE INST HEALTH_STATUS TEMP1 "ground" 400 100
27
+ # SETTING VALUE_LTEQ 10.0
28
+ # SETTING TLM_AND INST HEALTH_STATUS TEMP2 VALUE_GT 20.0
29
+ ### TLM_OR
30
+ #The TLM_OR setting allows added another comparison that is ored with the original comparison for a canvas value widget to determine 'ON' state
31
+ # | Parameter | Description | Required |
32
+ # | --------------- | ---------------------------------------------------------------------------- | -------- |
33
+ # | Target Name | The target name portion of the telemetry mnemonic | Yes |
34
+ # | Packet Name | The packet name portion of the telemetry mnemonic | Yes |
35
+ # | Item Name | The item name portion of the telemetry mnemonic | Yes |
36
+ # | Comparison Type | The comparison type: VALUE_EQ, VALUE_GT, VALUE_GTEQ, VALUE_LT, or VALUE_LTEQ | Yes |
37
+ # | Value | The value to compare against | Yes |
38
+ # Example Usage:
39
+ # CANVASIMAGEVALUE INST HEALTH_STATUS TEMP1 "ground" 400 100
40
+ # SETTING VALUE_LTEQ 10.0
41
+ # SETTING TLM_OR INST HEALTH_STATUS TEMP2 VALUE_GT 20.0
@@ -0,0 +1,25 @@
1
+ ---
2
+ - name: Target name
3
+ required: true
4
+ description: The target name
5
+ values: .+
6
+ - name: Packet name
7
+ required: true
8
+ description: The packet name
9
+ values: .+
10
+ - name: Item name
11
+ required: true
12
+ description: The item name
13
+ values: .+
14
+ - name: Value type
15
+ required: false
16
+ description: The type of the value to display. Default is CONVERTED.
17
+ values: <%= %w(RAW CONVERTED) %>
18
+ - name: Reduced
19
+ required: false
20
+ description: Whether to display reduced data. Default is DECOM.
21
+ values: <%= %w(DECOM REDUCED_MINUTE REDUCED_HOUR REDUCED_DAY) %>
22
+ - name: Reduced Type
23
+ required: false
24
+ description: The type of reduce data to display. Only applies if Reduced is not DECOM.
25
+ values: <%= %w(MIN MAX AVG STDDEV) %>
@@ -0,0 +1,52 @@
1
+ ---
2
+ ITEM:
3
+ summary: Add a telemetry item to the graph
4
+ parameters:
5
+ # Inject the graph parameters
6
+ <%= MetaConfigParser.load('_graph_params.yaml').to_meta_config_yaml(4) %>
7
+ STARTTIME:
8
+ summary: Start the graph history at the designated Time
9
+ parameters:
10
+ - name: Start Time
11
+ required: true
12
+ description: Start time as formatted 'YYYY/MM/DD HH:MM:SS'
13
+ values: .+
14
+ HISTORY:
15
+ summary: Display an initial history of data
16
+ parameters:
17
+ - name: Value
18
+ required: true
19
+ description: Value{d,h,m,s}. For example 1d, 2h, 30m, 15s
20
+ values: .+
21
+ SECONDSGRAPHED:
22
+ summary: Display the specified number of seconds in the graph
23
+ parameters:
24
+ - name: Time
25
+ required: true
26
+ description: Number of seconds to display
27
+ values: .+
28
+ POINTSSAVED:
29
+ summary: Save the number of seconds in graph memory
30
+ parameters:
31
+ - name: Time
32
+ required: true
33
+ description: Number of seconds to save
34
+ values: .+
35
+ POINTSGRAPHED:
36
+ summary: Number of points to display on the graph
37
+ parameters:
38
+ - name: Time
39
+ required: true
40
+ description: Number of points to graph
41
+ values: .+
42
+ SIZE:
43
+ summary: Size of the graph
44
+ parameters:
45
+ - name: Width
46
+ required: true
47
+ description: Width in pixels
48
+ values: .+
49
+ - name: Height
50
+ required: true
51
+ description: Height in pixels
52
+ values: .+
@@ -111,3 +111,7 @@ SECRET:
111
111
  required: false
112
112
  description: Interface option to pass the secret value
113
113
  values: .*
114
+ - name: Secret Store Name
115
+ required: false
116
+ description: Name of the secret store for stores with multipart keys
117
+ values: .*
@@ -102,10 +102,14 @@ MICROSERVICE:
102
102
  required: true
103
103
  description: The name of the secret to retrieve
104
104
  values: .*
105
- - name: Environment Variable of File Path
105
+ - name: Environment Variable or File Path
106
106
  required: true
107
107
  description: Environment variable name or file path to store secret
108
108
  values: .*
109
+ - name: Secret Store Name
110
+ required: false
111
+ description: Name of the secret store for stores with multipart keys
112
+ values: .*
109
113
  ROUTE_PREFIX:
110
114
  summary: Prefix of route
111
115
  description: Prefix of route to the microservice to expose externally with Traefik
@@ -1,6 +1,8 @@
1
1
  ---
2
2
  SCREEN:
3
3
  summary: Define a telemetry viewer screen
4
+ description: The SCREEN keyword is the first keyword in any telemetry screen definition.
5
+ It defines the name of the screen and parameters that affect the screen overall.
4
6
  parameters:
5
7
  - name: Width
6
8
  required: true
@@ -16,6 +18,8 @@ SCREEN:
16
18
  required: true
17
19
  description: Number of seconds between screen updates
18
20
  values: '[0-9]*\.?[0-9]+'
21
+ example: |
22
+ SCREEN AUTO AUTO 1.0 FIXED
19
23
  END:
20
24
  summary: Indicates the close of a layout widget
21
25
  description: All layout widgets must be closed to properly identify where they
@@ -29,6 +33,8 @@ STALE_TIME:
29
33
  description: Items from packets with RECEIVED_TIMESECONDS greater than this value in the past will be marked stale.
30
34
  The default is 30s. Recommend a minimum of 2s to avoid false positives due to race conditions.
31
35
  values: \d+
36
+ example: |
37
+ STALE_TIME 5 # Number of seconds to wait before marking data stale
32
38
  GLOBAL_SETTING:
33
39
  summary: Applies a widget setting to all widgets of a certain type
34
40
  parameters:
@@ -39,19 +45,14 @@ GLOBAL_SETTING:
39
45
  values: .+
40
46
  - name: Setting Name
41
47
  required: true
42
- description: Widget specific setting name. OpenC3 defines several settings
43
- which apply across many different widget types. However, you can also use
44
- the 'RAW' setting which allows any stylesheet values.
45
- values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
48
+ description: See SETTING for details.
49
+ values: .+
46
50
  - name: Setting Value(s)
47
51
  required: false
48
- description: >
49
- The setting value which varies by setting. Note that color
50
- settings can be given as a common string, e.g. 'red', or by RGB values,
51
- e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
52
- If the setting is RAW the value should be the raw stylesheet
53
- key and value, e.g. font-size 10px
52
+ description: See SETTING for details.
54
53
  values: .*
54
+ example: |
55
+ GLOBAL_SETTING LABELVALUELIMITSBAR COLORBLIND TRUE
55
56
  GLOBAL_SUBSETTING:
56
57
  summary: Applies a widget subsetting to all widgets of a certain type
57
58
  description: Subsettings are only valid for widgets that are
@@ -68,42 +69,33 @@ GLOBAL_SUBSETTING:
68
69
  values: .+
69
70
  - name: Subwidget Index
70
71
  required: true
71
- description: Index to the desired subwidget or 'ALL' to apply the setting
72
- to all the subwidgets of this composite widget.
72
+ description: Index to the desired subwidget
73
73
  values: .+
74
74
  - name: Setting Name
75
75
  required: true
76
- description: Widget specific setting name. OpenC3 defines several settings
77
- which apply across many different widget types. However, you can also use
78
- the 'RAW' setting which allows any stylesheet values.
79
- values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
76
+ description: See SETTING for details.
77
+ values: .+
80
78
  - name: Setting Value(s)
81
79
  required: false
82
- description: >
83
- The setting value which varies by setting. Note that color
84
- settings can be given as a common string, e.g. 'red', or by RGB values,
85
- e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
86
- If the setting is RAW the value should be the raw stylesheet
87
- key and value, e.g. font-size 10px
80
+ description: See SETTING for details.
88
81
  values: .*
82
+ example: |
83
+ GLOBAL_SUBSETTING LABELVALUELIMITSBAR 1 COLORBLIND TRUE
84
+ # Set all text color to white for labelvaluelimitsbars
85
+ GLOBAL_SUBSETTING LABELVALUELIMITSBAR 0:0 TEXTCOLOR white
89
86
  SETTING:
90
87
  summary: Applies a widget setting to the previously defined widget
91
- parameters:
92
- - name: Setting Name
93
- required: true
94
- description: Widget specific setting name. OpenC3 defines several settings
95
- which apply across many different widget types. However, you can also use
96
- the 'RAW' setting which allows any stylesheet values.
97
- values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
98
- - name: Setting Value(s)
99
- required: false
100
- description: >
101
- The setting value which varies by setting. Note that color
102
- settings can be given as a common string, e.g. 'red', or by RGB values,
103
- e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
104
- If the setting is RAW the value should be the raw stylesheet
105
- key and value, e.g. font-size 10px
106
- values: .*
88
+ description: |
89
+ Settings allow for additional tweaks and options to be applied to widgets
90
+ that are not available in their parameters. These settings are all configured
91
+ through the SETTING, SUBSETTING, GLOBAL_SETTING and GLOBAL_SUBSETTING keywords.
92
+ SETTING and SUBSETTING applies only to the widget defined immediately before it.
93
+ GLOBAL_SETTING and GLOBAL_SUBSETTING applies to all widgets.
94
+
95
+ Common wiget settings are defined here. Some widgets define their own
96
+ unqiue settings which are documented under that specific widget.
97
+ collection:
98
+ <%= MetaConfigParser.load('settings.yaml').to_meta_config_yaml(4) %>
107
99
  SUBSETTING:
108
100
  summary: Applies a widget subsetting to the previously defined widget
109
101
  description: Subsettings are only valid for widgets that are
@@ -120,19 +112,19 @@ SUBSETTING:
120
112
  values: .+
121
113
  - name: Setting Name
122
114
  required: true
123
- description: Widget specific setting name. OpenC3 defines several settings
124
- which apply across many different widget types. However, you can also use
125
- the 'RAW' setting which allows any stylesheet.
126
- values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
115
+ description: See SETTING for details.
116
+ values: .+
127
117
  - name: Setting Value(s)
128
118
  required: false
129
- description: >
130
- The setting value which varies by setting. Note that color
131
- settings can be given as a common string, e.g. 'red', or by RGB values,
132
- e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
133
- If the setting is RAW the value should be the raw stylesheet
134
- key and value, e.g. font-size 10px
119
+ description: See SETTING for details.
135
120
  values: .*
121
+ example: |
122
+ VERTICALBOX
123
+ LABELVALUE INST HEALTH_STATUS TEMP1
124
+ SUBSETTING 0 TEXTCOLOR blue # Change the label's text to blue
125
+ LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1
126
+ SUBSETTING 0:0 TEXTCOLOR green # Change the label's text to green
127
+ END
136
128
  NAMED_WIDGET:
137
129
  summary: Name a widget to allow access to it via the getNamedWidget method
138
130
  description: To programatically access parts of a telemetry screen you need
@@ -154,6 +146,8 @@ NAMED_WIDGET:
154
146
  required: true
155
147
  description: The unique parameters for the given widget type
156
148
  values: .+
157
- # Even though these are technically SCREEN modifiers we load them at the top_frame
158
- # level so they appear as available keywords
149
+ example: |
150
+ NAMED_WIDGET DURATION TEXTFIELD
151
+ BUTTON "Push" "screen.getNamedWidget('DURATION').text()"
152
+
159
153
  <%= MetaConfigParser.load('widgets.yaml').to_meta_config_yaml(0) %>
@@ -0,0 +1,144 @@
1
+ WIDTH:
2
+ summary: Sets the widget width
3
+ description: WIDTH supports [css units](https://www.w3schools.com/cssref/css_units.php) with the default (no units) of px (pixels)
4
+ parameters:
5
+ - name: Width
6
+ required: true
7
+ description: Width in pixels or explicitly declared with units
8
+ values: .+
9
+ example: |
10
+ LABEL "THIS IS A TEST"
11
+ SETTING WIDTH 50
12
+ LABEL "THIS IS A TEST"
13
+ SETTING WIDTH 20em
14
+ HEIGHT:
15
+ summary: Sets the widget height
16
+ description: HEIGHT supports [css units](https://www.w3schools.com/cssref/css_units.php) with the default (no units) of px (pixels)
17
+ parameters:
18
+ - name: Height
19
+ required: true
20
+ description: Height in pixels or explicitly declared with units
21
+ values: .+
22
+ example: |
23
+ LABEL "THIS IS A TEST"
24
+ SETTING BACKCOLOR BLUE
25
+ SETTING HEIGHT 50
26
+ LABEL "THIS IS A TEST"
27
+ SETTING BACKCOLOR GREY
28
+ SETTING HEIGHT 2em
29
+ MARGIN:
30
+ summary: Sets the widget margin
31
+ description: MARGIN supports [css units](https://www.w3schools.com/cssref/css_units.php) with the default (no units) of px (pixels)
32
+ parameters:
33
+ - name: Size
34
+ required: true
35
+ description: Size in pixels or explicitly declared with units
36
+ values: .+
37
+ example: |
38
+ LABEL "THIS IS A TEST"
39
+ SETTING BACKCOLOR BLUE
40
+ LABEL "THIS IS A TEST"
41
+ SETTING BACKCOLOR GREY
42
+ SETTING MARGIN 10
43
+ LABEL "THIS IS A TEST"
44
+ SETTING BACKCOLOR GREEN
45
+ PADDING:
46
+ summary: Sets the widget padding
47
+ description: PADDING supports [css units](https://www.w3schools.com/cssref/css_units.php) with the default (no units) of px (pixels)
48
+ parameters:
49
+ - name: Size
50
+ required: true
51
+ description: Size in pixels or explicitly declared with units
52
+ values: .+
53
+ example: |
54
+ LABEL "THIS IS A TEST"
55
+ SETTING BACKCOLOR BLUE
56
+ LABEL "THIS IS A TEST"
57
+ SETTING BACKCOLOR GREY
58
+ SETTING PADDING 10
59
+ LABEL "THIS IS A TEST"
60
+ SETTING BACKCOLOR GREEN
61
+ BACKCOLOR:
62
+ summary: The BACKCOLOR setting sets the background color for a widget
63
+ parameters:
64
+ - name: Color name or Red value
65
+ required: true
66
+ description: Common name for the color, e.g. 'black', 'red', etc.
67
+ Alternatively if two more parameters are passed this is the
68
+ Red value of the RGB value
69
+ values: .+
70
+ - name: Green value
71
+ required: false
72
+ description: Green value of the RGB value
73
+ values: .+
74
+ - name: Blue value
75
+ required: false
76
+ description: Blue value of the RGB value
77
+ values: .+
78
+ example: |
79
+ LABEL "THIS IS A TEST"
80
+ SETTING BACKCOLOR red
81
+ LABEL "THIS IS A TEST"
82
+ SETTING BACKCOLOR 155 50 155
83
+ TEXTCOLOR:
84
+ summary: The TEXTCOLOR setting sets the text color for a widget
85
+ parameters:
86
+ - name: Color name or Red value
87
+ required: true
88
+ description: Common name for the color, e.g. 'black', 'red', etc.
89
+ Alternatively if two more parameters are passed this is the
90
+ Red value of the RGB value
91
+ values: .+
92
+ - name: Green value
93
+ required: false
94
+ description: Green value of the RGB value
95
+ values: .+
96
+ - name: Blue value
97
+ required: false
98
+ description: Blue value of the RGB value
99
+ values: .+
100
+ example: |
101
+ LABEL "THIS IS A TEST"
102
+ SETTING TEXTCOLOR red
103
+ LABEL "THIS IS A TEST"
104
+ SETTING TEXTCOLOR 155 50 155
105
+ BORDERCOLOR:
106
+ summary: The BORDERCOLOR setting sets the border color for a layout widget
107
+ parameters:
108
+ - name: Color name or Red value
109
+ required: true
110
+ description: Common name for the color, e.g. 'black', 'red', etc.
111
+ Alternatively if two more parameters are passed this is the
112
+ Red value of the RGB value
113
+ values: .+
114
+ - name: Green value
115
+ required: false
116
+ description: Green value of the RGB value
117
+ values: .+
118
+ - name: Blue value
119
+ required: false
120
+ description: Blue value of the RGB value
121
+ values: .+
122
+ example: |
123
+ HORIZONTAL
124
+ LABEL "Label 1"
125
+ END
126
+ SETTING BORDERCOLOR red
127
+ VERTICAL
128
+ LABEL "Label 2"
129
+ END
130
+ SETTING BORDERCOLOR 155 50 155
131
+ RAW:
132
+ summary: Apply a raw CSS stylesheet key and value
133
+ parameters:
134
+ - name: Key
135
+ required: true
136
+ description: CSS key like font-size, max-width, etc
137
+ values: .+
138
+ - name: Value
139
+ required: true
140
+ description: CSS Value
141
+ values: .+
142
+ example: |
143
+ LABEL "Label 1"
144
+ SETTING RAW font-size 30px