openc3 5.5.0.pre.beta0 → 5.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47eef747a6f82da0e4cdf93863f00357e07be1002d58762c4345c611e53da9a5
-  data.tar.gz: 6b6b804cac37eab03765a619aedd6ec4e6d4e8a9dfe5048507d23bd9c0987542
+  metadata.gz: a2b1524aa1d06a8149e80ffb2843b3a9304d73cf432ecd641396292bf5209439
+  data.tar.gz: f35947a803088cb83705c3748fb860751cf40228a5c4720d151c867a001157ce
 SHA512:
-  metadata.gz: 9f862cfdc31ded71fe8eaa59f8771ccb88d45b0363fa17636c6ed8a0c1cfcb30343f4850b57fba89dc9fd221e9a70cb7af7524081bb4d7f24e8d263c816b3879
-  data.tar.gz: 3604545c30b970d8ed6e6c0bf69c8d6ba0eeffefd3cb0c043d65ea140dfb15936bcd3d9ffb94bdb21493d40c05213838bdf7df215ee12597e41275cc903d16ee
+  metadata.gz: 245f9f7fe39f5ac4f82bab653de55f413432b3ad9f73b586f2d82f2a14e50bcd6d77a5bc11e1b4a9a2f95c4b11c2aef55dcc325ab330da076ecdb7f0245fb374
+  data.tar.gz: 2f142eea4029f7b1efd3564578413e09d23acd6b9136799d123db48e733577d28a50c3e90640143e20e8f092874ec08c277df6ca721cf2a33bc4c1ffeabf42ba

data/bin/openc3cli

@@ -26,6 +26,7 @@
 require 'openc3'
 require 'openc3/utilities/local_mode'
 require 'openc3/utilities/bucket'
+require 'openc3/utilities/cli_generator'
 require 'openc3/models/scope_model'
 require 'openc3/models/plugin_model'
 require 'openc3/models/gem_model'
@@ -42,20 +43,17 @@ require 'json'
 require 'redis'
 require 'erb'
 require 'pp'
-# require 'psych' # Psych code is commented out
 require "irb"
 require "irb/completion"
 
 $redis_url = "redis://#{ENV['OPENC3_REDIS_HOSTNAME']}:#{ENV['OPENC3_REDIS_PORT']}"
-# Initialize the connection to the bucket library
-OpenC3::Bucket.getClient()
 
 # Build the OpenStruct and OptionParser here as constants so we can use in methods
 MIGRATE_OPTIONS = OpenStruct.new
 MIGRATE_OPTIONS.all = false
 MIGRATE_PARSER = OptionParser.new do |op|
-  op.banner = "cli migrate PLUGIN [TGT1...] # Create a OpenC3 plugin from existing COSMOS 4 targets"
-  op.on("-a", "--all", "    Move all COSMOS 4 targets into a single OpenC3 plugin") do
+  op.banner = "cli migrate PLUGIN [TGT1...]      # Create a OpenC3 plugin from existing COSMOS 4 targets"
+  op.on("-a", "--all", " Move all COSMOS 4 targets into a single OpenC3 plugin") do
     MIGRATE_OPTIONS.all = true
   end
 end
@@ -69,9 +67,10 @@ def print_usage
   puts "  cli irb                           # Runs irb in the local directory"
   puts "  cli validate /PATH/FILENAME.gem SCOPE variables.txt # Validate a COSMOS plugin gem file"
   puts "  cli load /PATH/FILENAME.gem SCOPE variables.txt     # Loads a COSMOS plugin gem file"
-  puts "  cli generate plugin PLUGIN_NAME   # Generate a COSMOS plugin"
+  puts "  cli generate TYPE OPTIONS         # Generate various COSMOS entities"
   puts "  #{MIGRATE_PARSER}"
   puts "  cli bridge CONFIG_FILENAME        # Run COSMOS host bridge"
+  puts "  cli bridgegem gem_name variable1=value1 variable2=value2 # Runs bridge using gem bridge.txt"
   puts "  cli bridgesetup CONFIG_FILENAME   # Create a default config file"
   puts "  cli geminstall GEMFILENAME SCOPE  # Install loaded gem to /gems"
   puts "  cli rubysloc                      # Counts Ruby SLOC recursively. Run with --help for more info."
@@ -80,55 +79,6 @@ def print_usage
   puts ""
 end
 
-def generate(args)
-  case args[0]
-  when 'plugin'
-    if args.length != 2
-      abort("Usage: cli generate plugin <NAME>")
-    end
-    if args[1] =~ /\s/
-      abort("Plugin names can not have spaces!")
-    end
-
-    plugin = args[1].downcase.gsub(/_+|-+/, '-')
-    plugin_name = "openc3-cosmos-#{plugin}"
-    if File.exist?(plugin_name)
-      abort("Plugin #{plugin_name} already exists!")
-    end
-    FileUtils.mkdir(plugin_name)
-    Dir.chdir(plugin_name) # Change to the plugin path to make copying easier
-
-    # Grab the plugin template
-    template_dir = "#{File.dirname(__FILE__)}/../templates/plugin-template"
-    target_name = plugin.upcase.gsub('-', '_')
-    target_lib_filename = "#{target_name.downcase}.rb"
-    target_class = target_lib_filename.filename_to_class_name
-    target_object = target_name.downcase
-    b = binding
-
-    Dir.glob("#{template_dir}/**/*").each do |file|
-      base_name = file.sub("#{template_dir}/", '')
-      # Rename the template TARGET to our actual target named after the plugin
-      base_name.sub!("targets/TARGET", "targets/#{target_name}")
-      if File.directory?(file)
-        FileUtils.mkdir(base_name)
-        next
-      end
-      base_name.sub!("target.rb", target_lib_filename)
-      base_name.sub!("plugin.gemspec", "#{plugin_name}.gemspec")
-      output = ERB.new(File.read(file), trim_mode: "-").result(b)
-      File.open(base_name, 'w') do |file|
-        file.write output
-      end
-    end
-
-    puts "Plugin #{plugin_name} successfully generated!\n"
-    return target_name # This makes the migrate method easier
-  else # Unknown generator
-    abort("Unknown generator #{args[0]}")
-  end
-end
-
 def migrate(args)
   MIGRATE_PARSER.parse!(args)
   abort(MIGRATE_PARSER.to_s) if args.length == 0
@@ -151,7 +101,7 @@ def migrate(args)
   # NOTE: generate does a chdir to be inside the plugin directory
   ###############################################################
   plugin = args.shift
-  target_name = generate(['plugin', plugin])
+  target_name = OpenC3::CliGenerator.generate(['plugin', plugin])
   # Delete target contents from the plugin framework (but keep directory)
   FileUtils.rm_rf Dir.glob("targets/#{target_name}/*")
 
@@ -263,10 +213,6 @@ def xtce_converter(args)
       puts e.backtrace
       result = ERROR_CODE
     ensure
-      # Uninstall not necessary because this is run against a temporary container
-      # name = Psych.safe_load(`gem spec #{options[:plugin]} name`).to_s
-      # version = Psych.safe_load(`gem spec #{options[:plugin]} version`, permitted_classes: [Gem::Version]).to_s
-      # Gem::Uninstaller.new(name, {:version => version, :force => true}).uninstall
       exit(result)
     end
   else
@@ -318,10 +264,6 @@ rescue => e
   puts "Error: #{e.message}"
   result = ERROR_CODE
 ensure
-  # Uninstall not necessary because this is run against a temporary container
-  # name = Psych.safe_load(`gem spec #{plugin_file_path} name`).to_s
-  # version = Psych.safe_load(`gem spec #{plugin_file_path} version`, permitted_classes: [Gem::Version]).to_s
-  # Gem::Uninstaller.new(name, {:version => version, :force => true}).uninstall
   exit(result)
 end
 
@@ -524,6 +466,26 @@ def run_migrations(folder)
   end
 end
 
+def run_bridge(filename, params)
+  variables = {}
+  params.each do |param|
+    name, value = param.split('=')
+    if name and value
+      variables[name] = value
+    else
+      raise "Invalid variable passed to bridgegem (syntax name=value): #{param}"
+    end
+  end
+  bridge = OpenC3::Bridge.new(filename, variables)
+  begin
+    while true
+      sleep(1)
+    end
+  rescue Interrupt
+    exit(0)
+  end
+end
+
 if not ARGV[0].nil? # argument(s) given
 
   # Handle each task
@@ -551,7 +513,7 @@ if not ARGV[0].nil? # argument(s) given
     gem_install(ARGV[1], scope: ARGV[2])
 
   when 'generate'
-    generate(ARGV[1..-1])
+    OpenC3::CliGenerator.generate(ARGV[1..-1])
 
   when 'migrate'
     migrate(ARGV[1..-1])
@@ -569,14 +531,34 @@ if not ARGV[0].nil? # argument(s) given
     ENV['OPENC3_NO_STORE'] = '1'
     filename = ARGV[1]
     filename = 'bridge.txt' unless filename
-    bridge = OpenC3::Bridge.new(filename)
-    begin
-      while true
-        sleep(1)
+    params = ARGV[2..-1]
+    params = [] unless params
+    run_bridge(filename, params)
+
+  when 'bridgegem'
+    ENV['OPENC3_NO_STORE'] = '1'
+    filename = nil
+    gem_name = ARGV[1]
+    Gem::Specification.each do |s|
+      # This appears to return the newest version of each gem first,
+      # so its ok that we stop on the first time it is found
+      if s.name == gem_name
+        if Array === Gem.path
+          Gem.path.each do |gem_path|
+            filename = File.join(gem_path, 'gems', "#{s.name}-#{s.version}", 'bridge.txt')
+            puts "Trying #{filename}"
+            break if File.exist?(filename)
+          end
+        else
+          filename = File.join(Gem.path, 'gems', "#{s.name}-#{s.version}", 'bridge.txt')
+        end
+        raise "#{filename} not found" unless File.exist?(filename)
       end
-    rescue Interrupt
-      exit(0)
     end
+    raise "gem #{gem_name} not found" unless filename
+    params = ARGV[2..-1]
+    params = [] unless params
+    run_bridge(filename, params)
 
   when 'bridgesetup'
     ENV['OPENC3_NO_STORE'] = '1'
@@ -637,9 +619,11 @@ if not ARGV[0].nil? # argument(s) given
 
   when 'initbuckets'
     client = OpenC3::Bucket.getClient()
-    client.create(ENV['OPENC3_CONFIG_BUCKET'])
-    client.create(ENV['OPENC3_LOGS_BUCKET'])
-    client.create(ENV['OPENC3_TOOLS_BUCKET'])
+    ENV.map do |key, value|
+      if key.match(/^OPENC3_(.+)_BUCKET$/) && !value.empty?
+        client.create(value)
+      end
+    end
     client.ensure_public(ENV['OPENC3_TOOLS_BUCKET'])
 
   when 'runmigrations'

data/data/config/_canvas_values.yaml

@@ -0,0 +1,41 @@
+VALUE_EQ:
+  summary: Map a value to a color
+  parameters:
+    - name: Value
+      required: true
+      description: State or value
+      values: .+
+    - name: Color
+      required: true
+      description: Color of the line
+      values: .+
+# TODO: At one point for CANVASIMAGEVALUE, CANVASLABELVALUE, and CANVASLINEVALUE
+# supported VALUE_GT, VALUE_GTEQ, VALUE_LT, VALUE_LTEQ
+# which are identical to VALUE_EQ except greater than, less than.
+# They also supported TLM_AND and TLM_OR defined as:
+### TLM_AND
+# The TLM_AND setting allows added another comparison that is anded with the original comparison for a canvas value widget to determine 'ON' state
+# | Parameter       | Description                                                                  | Required |
+# | --------------- | ---------------------------------------------------------------------------- | -------- |
+# | Target Name     | The target name portion of the telemetry mnemonic                            | Yes      |
+# | Packet Name     | The packet name portion of the telemetry mnemonic                            | Yes      |
+# | Item Name       | The item name portion of the telemetry mnemonic                              | Yes      |
+# | Comparison Type | The comparison type: VALUE_EQ, VALUE_GT, VALUE_GTEQ, VALUE_LT, or VALUE_LTEQ | Yes      |
+# | Value           | The value to compare against                                                 | Yes      |
+# Example Usage:
+# CANVASIMAGEVALUE INST HEALTH_STATUS TEMP1 "ground" 400 100
+# SETTING VALUE_LTEQ 10.0
+# SETTING TLM_AND INST HEALTH_STATUS TEMP2 VALUE_GT 20.0
+### TLM_OR
+#The TLM_OR setting allows added another comparison that is ored with the original comparison for a canvas value widget to determine 'ON' state
+# | Parameter       | Description                                                                  | Required |
+# | --------------- | ---------------------------------------------------------------------------- | -------- |
+# | Target Name     | The target name portion of the telemetry mnemonic                            | Yes      |
+# | Packet Name     | The packet name portion of the telemetry mnemonic                            | Yes      |
+# | Item Name       | The item name portion of the telemetry mnemonic                              | Yes      |
+# | Comparison Type | The comparison type: VALUE_EQ, VALUE_GT, VALUE_GTEQ, VALUE_LT, or VALUE_LTEQ | Yes      |
+# | Value           | The value to compare against                                                 | Yes      |
+# Example Usage:
+# CANVASIMAGEVALUE INST HEALTH_STATUS TEMP1 "ground" 400 100
+# SETTING VALUE_LTEQ 10.0
+# SETTING TLM_OR INST HEALTH_STATUS TEMP2 VALUE_GT 20.0

data/data/config/_graph_params.yaml

@@ -0,0 +1,25 @@
+---
+- name: Target name
+  required: true
+  description: The target name
+  values: .+
+- name: Packet name
+  required: true
+  description: The packet name
+  values: .+
+- name: Item name
+  required: true
+  description: The item name
+  values: .+
+- name: Value type
+  required: false
+  description: The type of the value to display. Default is CONVERTED.
+  values: <%= %w(RAW CONVERTED) %>
+- name: Reduced
+  required: false
+  description: Whether to display reduced data. Default is DECOM.
+  values: <%= %w(DECOM REDUCED_MINUTE REDUCED_HOUR REDUCED_DAY) %>
+- name: Reduced Type
+  required: false
+  description: The type of reduce data to display. Only applies if Reduced is not DECOM.
+  values: <%= %w(MIN MAX AVG STDDEV) %>

data/data/config/graph_settings.yaml

@@ -0,0 +1,52 @@
+---
+ITEM:
+  summary: Add a telemetry item to the graph
+  parameters:
+    # Inject the graph parameters
+    <%= MetaConfigParser.load('_graph_params.yaml').to_meta_config_yaml(4) %>
+STARTTIME:
+  summary: Start the graph history at the designated Time
+  parameters:
+    - name: Start Time
+      required: true
+      description: Start time as formatted 'YYYY/MM/DD HH:MM:SS'
+      values: .+
+HISTORY:
+  summary: Display an initial history of data
+  parameters:
+    - name: Value
+      required: true
+      description: Value{d,h,m,s}. For example 1d, 2h, 30m, 15s
+      values: .+
+SECONDSGRAPHED:
+  summary: Display the specified number of seconds in the graph
+  parameters:
+    - name: Time
+      required: true
+      description: Number of seconds to display
+      values: .+
+POINTSSAVED:
+  summary: Save the number of seconds in graph memory
+  parameters:
+    - name: Time
+      required: true
+      description: Number of seconds to save
+      values: .+
+POINTSGRAPHED:
+  summary: Number of points to display on the graph
+  parameters:
+    - name: Time
+      required: true
+      description: Number of points to graph
+      values: .+
+SIZE:
+  summary: Size of the graph
+  parameters:
+    - name: Width
+      required: true
+      description: Width in pixels
+      values: .+
+    - name: Height
+      required: true
+      description: Height in pixels
+      values: .+

data/data/config/interface_modifiers.yaml

@@ -111,3 +111,7 @@ SECRET:
       required: false
       description: Interface option to pass the secret value
       values: .*
+    - name: Secret Store Name
+      required: false
+      description: Name of the secret store for stores with multipart keys
+      values: .*

data/data/config/item_modifiers.yaml

@@ -52,7 +52,7 @@ READ_CONVERSION:
           @multiplier = multiplier.to_f
         end
         def call(value, packet, buffer)
-          return value * multiplier
+          return value * @multiplier
         end
       end
     end

data/data/config/microservice.yaml

@@ -102,10 +102,14 @@ MICROSERVICE:
           required: true
           description: The name of the secret to retrieve
           values: .*
-        - name: Environment Variable of File Path
+        - name: Environment Variable or File Path
           required: true
           description: Environment variable name or file path to store secret
           values: .*
+        - name: Secret Store Name
+          required: false
+          description: Name of the secret store for stores with multipart keys
+          values: .*
     ROUTE_PREFIX:
       summary: Prefix of route
       description: Prefix of route to the microservice to expose externally with Traefik

data/data/config/plugins.yaml

@@ -13,6 +13,11 @@ VARIABLE:
       required: true
       description: Default value of the variable
       values: .+
+NEEDS_DEPENDENCIES:
+  summary: Indicates the plugin needs dependencies and sets the GEM_HOME environment variable
+  description: If the plugin has a top level lib folder or lists runtime dependencies in the gemspec,
+    NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise Edition, having
+    NEEDS_DEPENDENCIES adds the NFS volume mount to the Kuberentes pod.
 INTERFACE:
   modifiers:
     <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>

data/data/config/screen.yaml

@@ -1,6 +1,8 @@
 ---
 SCREEN:
   summary: Define a telemetry viewer screen
+  description: The SCREEN keyword is the first keyword in any telemetry screen definition.
+    It defines the name of the screen and parameters that affect the screen overall.
   parameters:
     - name: Width
       required: true
@@ -16,6 +18,8 @@ SCREEN:
       required: true
       description: Number of seconds between screen updates
       values: '[0-9]*\.?[0-9]+'
+  example: |
+    SCREEN AUTO AUTO 1.0 FIXED
 END:
   summary: Indicates the close of a layout widget
   description: All layout widgets must be closed to properly identify where they
@@ -29,6 +33,8 @@ STALE_TIME:
       description: Items from packets with RECEIVED_TIMESECONDS greater than this value in the past will be marked stale.
         The default is 30s. Recommend a minimum of 2s to avoid false positives due to race conditions.
       values: \d+
+  example: |
+    STALE_TIME 5 # Number of seconds to wait before marking data stale
 GLOBAL_SETTING:
   summary: Applies a widget setting to all widgets of a certain type
   parameters:
@@ -39,19 +45,14 @@ GLOBAL_SETTING:
       values: .+
     - name: Setting Name
       required: true
-      description: Widget specific setting name. OpenC3 defines several settings
-        which apply across many different widget types. However, you can also use
-        the 'RAW' setting which allows any stylesheet values.
-      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+      description: See SETTING for details.
+      values: .+
     - name: Setting Value(s)
       required: false
-      description: >
-        The setting value which varies by setting. Note that color
-        settings can be given as a common string, e.g. 'red', or by RGB values,
-        e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
-        If the setting is RAW the value should be the raw stylesheet
-        key and value, e.g. font-size 10px
+      description: See SETTING for details.
       values: .*
+  example: |
+    GLOBAL_SETTING LABELVALUELIMITSBAR COLORBLIND TRUE
 GLOBAL_SUBSETTING:
   summary: Applies a widget subsetting to all widgets of a certain type
   description: Subsettings are only valid for widgets that are
@@ -68,42 +69,33 @@ GLOBAL_SUBSETTING:
       values: .+
     - name: Subwidget Index
       required: true
-      description: Index to the desired subwidget or 'ALL' to apply the setting
-        to all the subwidgets of this composite widget.
+      description: Index to the desired subwidget
       values: .+
     - name: Setting Name
       required: true
-      description: Widget specific setting name. OpenC3 defines several settings
-        which apply across many different widget types. However, you can also use
-        the 'RAW' setting which allows any stylesheet values.
-      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+      description: See SETTING for details.
+      values: .+
     - name: Setting Value(s)
       required: false
-      description: >
-        The setting value which varies by setting. Note that color
-        settings can be given as a common string, e.g. 'red', or by RGB values,
-        e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
-        If the setting is RAW the value should be the raw stylesheet
-        key and value, e.g. font-size 10px
+      description: See SETTING for details.
       values: .*
+  example: |
+    GLOBAL_SUBSETTING LABELVALUELIMITSBAR 1 COLORBLIND TRUE
+    # Set all text color to white for labelvaluelimitsbars
+    GLOBAL_SUBSETTING LABELVALUELIMITSBAR 0:0 TEXTCOLOR white
 SETTING:
   summary: Applies a widget setting to the previously defined widget
-  parameters:
-    - name: Setting Name
-      required: true
-      description: Widget specific setting name. OpenC3 defines several settings
-        which apply across many different widget types. However, you can also use
-        the 'RAW' setting which allows any stylesheet values.
-      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
-    - name: Setting Value(s)
-      required: false
-      description: >
-        The setting value which varies by setting. Note that color
-        settings can be given as a common string, e.g. 'red', or by RGB values,
-        e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
-        If the setting is RAW the value should be the raw stylesheet
-        key and value, e.g. font-size 10px
-      values: .*
+  description: |
+    Settings allow for additional tweaks and options to be applied to widgets
+    that are not available in their parameters. These settings are all configured
+    through the SETTING, SUBSETTING, GLOBAL_SETTING and GLOBAL_SUBSETTING keywords.
+    SETTING and SUBSETTING applies only to the widget defined immediately before it.
+    GLOBAL_SETTING and GLOBAL_SUBSETTING applies to all widgets.
+
+    Common wiget settings are defined here. Some widgets define their own
+    unqiue settings which are documented under that specific widget.
+  collection:
+    <%= MetaConfigParser.load('settings.yaml').to_meta_config_yaml(4) %>
 SUBSETTING:
   summary: Applies a widget subsetting to the previously defined widget
   description: Subsettings are only valid for widgets that are
@@ -120,19 +112,19 @@ SUBSETTING:
       values: .+
     - name: Setting Name
       required: true
-      description: Widget specific setting name. OpenC3 defines several settings
-        which apply across many different widget types. However, you can also use
-        the 'RAW' setting which allows any stylesheet.
-      values: <%= %w(TEXTALIGN PADDING MARGIN BACKCOLOR TEXTCOLOR BORDERCOLOR WIDTH HEIGHT RAW) %>
+      description: See SETTING for details.
+      values: .+
     - name: Setting Value(s)
       required: false
-      description: >
-        The setting value which varies by setting. Note that color
-        settings can be given as a common string, e.g. 'red', or by RGB values,
-        e.g. 255 0 0. If the setting is a length the units are required, e.g. 200px.
-        If the setting is RAW the value should be the raw stylesheet
-        key and value, e.g. font-size 10px
+      description: See SETTING for details.
       values: .*
+  example: |
+    VERTICALBOX
+      LABELVALUE INST HEALTH_STATUS TEMP1
+      SUBSETTING 0 TEXTCOLOR blue # Change the label's text to blue
+      LABELVALUELIMITSBAR INST HEALTH_STATUS TEMP1
+      SUBSETTING 0:0 TEXTCOLOR green # Change the label's text to green
+    END
 NAMED_WIDGET:
   summary: Name a widget to allow access to it via the getNamedWidget method
   description: To programatically access parts of a telemetry screen you need
@@ -154,6 +146,8 @@ NAMED_WIDGET:
       required: true
       description: The unique parameters for the given widget type
       values: .+
-# Even though these are technically SCREEN modifiers we load them at the top_frame
-# level so they appear as available keywords
+  example: |
+    NAMED_WIDGET DURATION TEXTFIELD
+    BUTTON "Push" "screen.getNamedWidget('DURATION').text()"
+
 <%= MetaConfigParser.load('widgets.yaml').to_meta_config_yaml(0) %>