openc3 5.0.8 → 5.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a1e753382bf9c7d98b63dad72fed1aa08e3a234ce140327d0bbf07ed2a913dd
-  data.tar.gz: 4b61da453f0fc1c75b7ec5df06516970b1a0d3325425e15f550322a505e90883
+  metadata.gz: e37b2aa61abbfe13cc757b9b154bcb2147c1743cbade962b0d6cbea83ae9eed3
+  data.tar.gz: 123104220cc22dc2d48a492a0986228bd01789e15b7e52e6fea9a880b31fc89b
 SHA512:
-  metadata.gz: 3cfaad4b9103a68a6608d48513f1e1161df68325bfb0684d9dac6aebcc47af0e4c2a3225692dff08b7d28aa96ce33a3b7812928e0191620bffb08686fbe511d6
-  data.tar.gz: a385b3d5ac4524c8919adf9cc1050793c1ce5e30fb62c679a711b79f7523d3908301de23cfd97d426ec0c58ce1815d16047807802afb8530cbb1faf91392a444
+  metadata.gz: fa546888f0e71f7cd4aca771d41012e3ce34cd5c5c5a801d0d0344b199073bbeb6e8b9622243d4d2a82cf67ddcfb6a869f189964a493106915ebefd32e3daa1c
+  data.tar.gz: 5632e8f84d341f00af0d49bbc048102cd66a53b50f5760d98783557ec462443705a0541f4a53eac59b2d5ee1db9c3e1e1a3ce9d6bc96fc0fcec829f05fc5567b

data/bin/openc3cli

@@ -21,9 +21,11 @@
 # This file will handle OpenC3 tasks such as instantiating a new project
 
 require 'openc3'
+require 'openc3/utilities/local_mode'
 require 'openc3/utilities/s3'
 require 'openc3/models/scope_model'
 require 'openc3/models/plugin_model'
+require 'openc3/models/gem_model'
 require 'openc3/packets/packet_config'
 require 'openc3/bridge/bridge'
 require 'ostruct'
@@ -35,6 +37,7 @@ require 'json'
 require 'redis'
 require 'psych'
 require 'erb'
+require 'pp'
 
 $redis_url = "redis://#{ENV['OPENC3_REDIS_HOSTNAME']}:#{ENV['OPENC3_REDIS_PORT']}"
 
@@ -313,18 +316,30 @@ ensure
   exit(result)
 end
 
-def update_plugin(plugin_file_path, plugin_name, variables: nil, plugin_txt_lines: nil, scope:)
+def update_plugin(plugin_file_path, plugin_name, variables: nil, plugin_txt_lines: nil, scope:, existing_plugin_name:)
   new_gem = File.basename(plugin_file_path)
-  old_gem = plugin_name.split("__")[0]
-  puts "Updating existing plugin: #{plugin_name} with #{File.basename(plugin_file_path)}"
-  plugin_model = OpenC3::PluginModel.get_model(name: plugin_name, scope: scope)
+  old_gem = existing_plugin_name.split("__")[0]
+  puts "Updating existing plugin: #{existing_plugin_name} with #{File.basename(plugin_file_path)}"
+  plugin_model = OpenC3::PluginModel.get_model(name: existing_plugin_name, scope: scope)
   begin
     # Only update if something has changed
-    if (new_gem != old_gem) or (variables != plugin_model.variables) or (plugin_txt_lines != plugin_model.plugin_txt_lines)
+    if (new_gem != old_gem) or (variables and variables != plugin_model.variables) or (plugin_txt_lines and plugin_txt_lines != plugin_model.plugin_txt_lines)
+      puts "Gem version change detected - New: #{new_gem}, Old: #{old_gem}" if new_gem != old_gem
+      if variables and variables != plugin_model.variables
+        pp_variables = ""
+        PP.pp(variables, pp_variables)
+        pp_plugin_model_variables = ""
+        PP.pp(plugin_model.variables, pp_plugin_model_variables)
+        puts "Variables change detected\nNew:\n#{pp_variables}\nOld:\n#{pp_plugin_model_variables}"
+      end
+      puts "plugin.txt change detected\nNew:\n#{plugin_txt_lines.join("\n")}\n\nOld:\n#{plugin_model.plugin_txt_lines.join("\n")}\n" if plugin_txt_lines and plugin_txt_lines != plugin_model.plugin_txt_lines
       variables = plugin_model.variables unless variables
       plugin_model.destroy
+
       plugin_hash = OpenC3::PluginModel.install_phase1(plugin_file_path, existing_variables: variables, existing_plugin_txt_lines: plugin_txt_lines, process_existing: true, scope: scope)
-      OpenC3::PluginModel.install_phase2(plugin_hash, scope: scope)
+      puts "Updating plugin: #{plugin_file_path}\n#{plugin_hash}"
+      plugin_hash = OpenC3::PluginModel.install_phase2(plugin_hash, scope: scope)
+      OpenC3::LocalMode.update_local_plugin(plugin_file_path, plugin_hash, old_plugin_name: plugin_name, scope: scope)
     else
       puts "No changes detected - Exiting without change"
     end
@@ -354,6 +369,7 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil)
   # Only create the scope if it doesn't already exist
   unless OpenC3::ScopeModel.names.include?(scope)
     begin
+      puts "Creating scope: #{scope}"
       scope_model = OpenC3::ScopeModel.new(name: scope, scope: scope)
       scope_model.create
       scope_model.deploy(".", {})
@@ -381,7 +397,9 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil)
           found = true
           # Upgrade if version changed else do nothing
           if file_full_name != full_name
-            update_plugin(plugin_file_path, plugin_name, scope: scope)
+            update_plugin(plugin_file_path, plugin_name, scope: scope, existing_plugin_name: plugin_name)
+          else
+            puts "No version change detected for: #{plugin_name}"
           end
         end
       end
@@ -394,16 +412,24 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil)
     existing_plugin_hash = OpenC3::PluginModel.get(name: plugin_hash['name'], scope: scope)
 
     # Existing plugin hash will be present if plugin is being edited or upgraded
-    # If editing, gem name will match existing hash name
-    # If upgrading, gem name will not match the existing hash name
+    # However, a missing existing could also be that a plugin was updated in local mode directly from across installations
+    # changing the plugin name without really meaning to create a new instance of the plugin
+    # ie.
+    # User on machine 1 checks in a changed plugin_instance.json with a different name - There is still only one plugin desired and committed
+    # User on machine 2 starts up with the new configuration, OpenC3::PluginModel.get will return nil because the exact name is different
+    # In this case, the plugin should be updated without installing a second instance. analyze_local_mode figures this out.
+    unless existing_plugin_hash
+      existing_plugin_hash = OpenC3::LocalMode.analyze_local_mode(plugin_name: plugin_hash['name'], scope: scope)
+    end
 
     if existing_plugin_hash
       # Upgrade or Edit
-      update_plugin(plugin_file_path, plugin_hash['name'], variables: plugin_hash['variables'], plugin_txt_lines: plugin_hash['plugin_txt_lines'], scope: scope)
+      update_plugin(plugin_file_path, plugin_hash['name'], variables: plugin_hash['variables'], plugin_txt_lines: plugin_hash['plugin_txt_lines'], scope: scope, existing_plugin_name: existing_plugin_hash['name'])
     else
       # New Install
       puts "Loading new plugin: #{plugin_file_path}\n#{plugin_hash}"
-      OpenC3::PluginModel.install_phase2(plugin_hash, scope: scope)
+      plugin_hash = OpenC3::PluginModel.install_phase2(plugin_hash, scope: scope)
+      OpenC3::LocalMode.update_local_plugin(plugin_file_path, plugin_hash, scope: scope)
     end
   rescue => err
     abort("Error installing plugin: #{scope}: #{plugin_file_path}: #{err.formatted}")
@@ -414,6 +440,7 @@ def unload_plugin(plugin_name, scope:)
   scope ||= 'DEFAULT'
   begin
     OpenC3::PluginModel.new(name: plugin_name, scope: scope).destroy
+    OpenC3::LocalMode.remove_local_plugin(plugin_name, scope: scope)
     OpenC3::Logger.info("PluginModel destroyed: #{plugin_name}", scope: scope)
   rescue => err
     abort("Error uninstalling plugin: #{scope}: #{plugin_name}: #{err.formatted}")
@@ -450,113 +477,119 @@ def get_redis_keys
   puts "Packets Defs: #{keys.select { |item| item[/^tlm__/] }}"
 end
 
-if not ARGV[0].nil? # argument(s) given
+if __FILE__ == $0
+  if not ARGV[0].nil? # argument(s) given
 
-  # Handle each task
-  case ARGV[0].downcase
+    # Handle each task
+    case ARGV[0].downcase
 
-  when 'rake'
-    puts `rake #{ARGV[1..-1].join(' ')}`
+    when 'rake'
+      puts `rake #{ARGV[1..-1].join(' ')}`
 
-  when 'validate'
-    validate_plugin(ARGV[1], scope: ARGV[2], variables_file: ARGV[3])
+    when 'validate'
+      validate_plugin(ARGV[1], scope: ARGV[2], variables_file: ARGV[3])
 
-  when 'load'
-    load_plugin(ARGV[1], scope: ARGV[2], plugin_hash_file: ARGV[3])
+    when 'load'
+      load_plugin(ARGV[1], scope: ARGV[2], plugin_hash_file: ARGV[3])
 
-  when 'unload'
-    unload_plugin(ARGV[1], scope: ARGV[2])
+    when 'unload'
+      unload_plugin(ARGV[1], scope: ARGV[2])
 
-  when 'geminstall'
-    gem_install(ARGV[1])
+    when 'geminstall'
+      gem_install(ARGV[1])
 
-  when 'generate'
-    generate(ARGV[1..-1])
+    when 'generate'
+      generate(ARGV[1..-1])
 
-  when 'migrate'
-    migrate(ARGV[1..-1])
+    when 'migrate'
+      migrate(ARGV[1..-1])
 
-  when 'rubysloc'
-    puts `ruby /openc3/bin/rubysloc #{ARGV[1..-1].join(' ')}`
+    when 'rubysloc'
+      puts `ruby /openc3/bin/rubysloc #{ARGV[1..-1].join(' ')}`
 
-  when 'cstol_converter'
-    puts `ruby /openc3/bin/cstol_converter #{ARGV[1..-1].join(' ')}`
+    when 'cstol_converter'
+      puts `ruby /openc3/bin/cstol_converter #{ARGV[1..-1].join(' ')}`
 
-  when 'xtce_converter'
-    xtce_converter(ARGV[1..-1])
+    when 'xtce_converter'
+      xtce_converter(ARGV[1..-1])
 
-  when 'bridge'
-    ENV['OPENC3_NO_STORE'] = '1'
-    filename = ARGV[1]
-    filename = 'bridge.txt' unless filename
-    bridge = OpenC3::Bridge.new(filename)
-    begin
-      while true
-        sleep(1)
+    when 'bridge'
+      ENV['OPENC3_NO_STORE'] = '1'
+      filename = ARGV[1]
+      filename = 'bridge.txt' unless filename
+      bridge = OpenC3::Bridge.new(filename)
+      begin
+        while true
+          sleep(1)
+        end
+      rescue Interrupt
+        exit(0)
       end
-    rescue Interrupt
-      exit(0)
-    end
 
-  when 'bridgesetup'
-    ENV['OPENC3_NO_STORE'] = '1'
-    filename = ARGV[1]
-    filename = 'bridge.txt' unless filename
-    unless File.exist?(filename)
-      OpenC3::BridgeConfig.generate_default(filename)
-    end
-
-  when 'help'
-    print_usage()
+    when 'bridgesetup'
+      ENV['OPENC3_NO_STORE'] = '1'
+      filename = ARGV[1]
+      filename = 'bridge.txt' unless filename
+      unless File.exist?(filename)
+        OpenC3::BridgeConfig.generate_default(filename)
+      end
 
-  when 'redis'
-    case (ARGV[1])
-    when 'keys'
-      get_redis_keys()
-    when 'hget'
-      redis = Redis.new(url: $redis_url, username: ENV['OPENC3_REDIS_USERNAME'], password: ENV['OPENC3_REDIS_PASSWORD'])
-      puts JSON.parse(redis.hget(ARGV[2], ARGV[3]), :allow_nan => true, :create_additions => true)
-    else
-      puts "Unknown redis task: #{ARGV[1]}\n"
-      puts "Valid redis tasks: keys, hget"
-    end
+    when 'help'
+      print_usage()
+
+    when 'redis'
+      case (ARGV[1])
+      when 'keys'
+        get_redis_keys()
+      when 'hget'
+        redis = Redis.new(url: $redis_url, username: ENV['OPENC3_REDIS_USERNAME'], password: ENV['OPENC3_REDIS_PASSWORD'])
+        puts JSON.parse(redis.hget(ARGV[2], ARGV[3]), :allow_nan => true, :create_additions => true)
+      else
+        puts "Unknown redis task: #{ARGV[1]}\n"
+        puts "Valid redis tasks: keys, hget"
+      end
 
-  when 'removebase'
-    # Used to remove tool base to better support enterprise upgrade
-    scopes = OpenC3::ScopeModel.all
-    scopes.each do |scope_name, scope|
-      plugins = OpenC3::PluginModel.all(scope: scope_name)
-      plugins.each do |plugin_name, plugin|
-        if plugin["name"] =~ /tool-base/ and plugin["name"] !~ /enterprise/
-          unload_plugin(plugin_name, scope: scope_name)
-        end
-        if plugin["name"] =~ /tool-admin/ and plugin["name"] !~ /enterprise/
-          unload_plugin(plugin_name, scope: scope_name)
+    when 'removebase'
+      # Used to remove tool base to better support enterprise upgrade
+      scopes = OpenC3::ScopeModel.all
+      scopes.each do |scope_name, scope|
+        plugins = OpenC3::PluginModel.all(scope: scope_name)
+        plugins.each do |plugin_name, plugin|
+          if plugin["name"] =~ /tool-base/ and plugin["name"] !~ /enterprise/
+            unload_plugin(plugin_name, scope: scope_name)
+          end
+          if plugin["name"] =~ /tool-admin/ and plugin["name"] !~ /enterprise/
+            unload_plugin(plugin_name, scope: scope_name)
+          end
         end
       end
-    end
 
-  when 'removeenterprise'
-    # Used to remove enterprise plugins to better support downgrade
-    scopes = OpenC3::ScopeModel.all
-    scopes.each do |scope_name, scope|
-      plugins = OpenC3::PluginModel.all(scope: scope_name)
-      plugins.each do |plugin_name, plugin|
-        if plugin["name"] =~ /enterprise/
-          unload_plugin(plugin_name, scope: scope_name)
+    when 'removeenterprise'
+      # Used to remove enterprise plugins to better support downgrade
+      scopes = OpenC3::ScopeModel.all
+      scopes.each do |scope_name, scope|
+        plugins = OpenC3::PluginModel.all(scope: scope_name)
+        plugins.each do |plugin_name, plugin|
+          if plugin["name"] =~ /enterprise/
+            unload_plugin(plugin_name, scope: scope_name)
+          end
         end
       end
-    end
 
-  when 'destroyscope'
-    scope = OpenC3::ScopeModel.get_model(name: ARGV[1])
-    scope.destroy
+    when 'destroyscope'
+      scope = OpenC3::ScopeModel.get_model(name: ARGV[1])
+      scope.destroy
+
+    when 'localinit'
+      OpenC3::LocalMode.local_init()
 
-  else # Unknown task
+    else # Unknown task
+      print_usage()
+      abort("Unknown task: #{ARGV[0]}")
+    end
+
+  else # No arguments given
     print_usage()
-    abort("Unknown task: #{ARGV[0]}")
   end
 
-else # No arguments given
-  print_usage()
-end
+end

data/data/config/_id_items.yaml

@@ -20,5 +20,6 @@
   values: "['\"].*['\"]"
 - name: Endianness
   required: false
-  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format
+  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format.
+    See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
   values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>

data/data/config/_id_params.yaml

@@ -31,7 +31,8 @@
           values: "['\"].*['\"]"
         - name: Endianness
           required: false
-          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format
+          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format.
+            See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
           values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>
     UINT:
       parameters: *params

data/data/config/_items.yaml

@@ -16,5 +16,6 @@
   values: "['\"].*['\"]"
 - name: Endianness
   required: false
-  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format
+  description: Indicates if the item is to be interpreted in Big Endian or Little Endian format.
+    See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
   values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>

data/data/config/_params.yaml

@@ -32,7 +32,8 @@
           values: '[''"].*[''"]'
         - name: Endianness
           required: false
-          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format
+          description: Indicates if the data in this command is to be sent in Big Endian or Little Endian format.
+            See guide on <a href="https://openc3.com/docs/v5/little-endian-bitfields">Little Endian Bitfields</a>.
           values: <%= %w(BIG_ENDIAN LITTLE_ENDIAN) %>
     UINT:
       parameters: *params

data/data/config/command_modifiers.yaml

@@ -158,3 +158,33 @@ HAZARDOUS:
       required: false
       description: Description for why the command is hazardous which must be enclosed with quotes
       values: "['\"].*['\"]"
+ACCESSOR:
+  summary: Defines the class used to read and write raw values from the packet
+  description: Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor.
+    Provided accessors also include JsonAccessor, CborAccessor, HtmlAccessor, and XmlAccessor.
+  parameters:
+    - name: Accessor Class Name
+      required: true
+      description: The name of the accessor class
+      values: .+
+  since: 5.0.10
+TEMPLATE:
+  summary: Defines a template string used to initialize the command before default values are filled in
+  description: Generally the template string is formatted in JSON or HTML and then values are filled in with
+    command parameters. Must be UTF-8 encoded.
+  parameters:
+    - name: Template
+      required: true
+      description: The template string which should be enclosed in quotes
+      values: "['\"].*['\"]"
+  since: 5.0.10
+TEMPLATE_FILE:
+  summary: Defines a template file used to initialize the command before default values are filled in
+  description: Generally the template file is formatted in JSON or HTML and then values are filled in with
+    command parameters. Can be binary or UTF-8.
+  parameters:
+    - name: Template File Path
+      required: true
+      description: The relative path to the template file. Filename should generally start with an underscore.
+      values: .+
+  since: 5.0.10

data/data/config/item_modifiers.yaml

@@ -219,3 +219,13 @@ LIMITS_RESPONSE:
       description: Variable length number of options that will be passed to the
         class constructor
       values: .+
+KEY:
+  summary: Defines the key used to access this raw value in the packet.
+  description: Keys are often JsonPath or XPath strings
+  example: KEY $.book.title
+  parameters:
+    - name: Key string
+      required: true
+      description: The key to access this item
+      values: .+
+  since: 5.0.10

data/data/config/microservice.yaml

@@ -32,6 +32,18 @@ MICROSERVICE:
           required: true
           description: Working directory to run the microservice CMD in. Can be a path relative to the microservice folder in the plugin, or an absolute path in the container the microservice runs in.
           values: .+
+    PORT:
+      summary: Open port for the microservice
+      description: Kubernetes needs a Service to be applied to open a port so this is required for Kubernetes support
+      parameters:
+        - name: Number
+          required: true
+          description: Port number
+          values: \d+
+        - name: Protocol
+          required: false
+          description: Port protocol. Default is TCP.
+          values: .+
     TOPIC:
       summary: Associate a Redis topic
       description: Redis topic to associate with this microservice. Standard OpenC3 microservices such as decom_microservice use this information to know what packet streams to subscribe to. The TOPIC keyword can be used as many times as necessary to associate all needed topics.

data/data/config/param_item_modifiers.yaml

@@ -50,3 +50,13 @@ OVERLAP:
     If an item's bit offset overlaps another item, OpenC3 issues a warning. This keyword explicitly
     allows an item to overlap another and supresses the warning message.
   since: 4.4.1
+KEY:
+  summary: Defines the key used to access this raw value in the packet.
+  description: Keys are often JsonPath or XPath strings
+  example: KEY $.book.title
+  parameters:
+    - name: Key string
+      required: true
+      description: The key to access this item
+      values: .+
+  since: 5.0.10

data/data/config/plugins.yaml

@@ -38,15 +38,6 @@ INTERFACE:
         documentation for more details.
 ROUTER:
   modifiers:
-    ROUTE:
-      summary: Map an interface to a router
-      description: Once an interface has been mapped to a router, all its received telemetry
-        will be sent out through the router.
-      parameters:
-        - name: Interface
-          required: true
-          description: Name of the interface
-          values: .+
     <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>
   summary: Create router to receive commands and output telemetry packets from one or more interfaces
   description: Creates an router which receives command packets from

data/data/config/telemetry_modifiers.yaml

@@ -157,3 +157,13 @@ HIDDEN:
     It also hides this telemetry from appearing in the Script Runner popup helper
     when writing scripts. The telemetry still exists in the system and can received
     and checked by scripts.
+ACCESSOR:
+  summary: Defines the class used to read and write raw values from the packet
+  description: Defines the class that is used too read raw values from the packet. Defaults to BinaryAccessor.
+    Provided accessors also include JsonAccessor, CborAccessor, HtmlAccessor, and XmlAccessor.
+  parameters:
+    - name: Accessor Class Name
+      required: true
+      description: The name of the accessor class
+      values: .+
+  since: 5.0.10