openc3 5.12.0 → 5.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 056635373017dd511a8d049e778f59c7548c62dbae9b905effb03d447a0775ae
-  data.tar.gz: bfe11cbba1792a9741d06f0c3ea9365757d5a3fac0f873cb2a86597796521a11
+  metadata.gz: 2b009f636dd8566127001ad9ee48972d584fb03baaf88389646048e7231dc54b
+  data.tar.gz: 0ce2ff7aad089eba4794f4f15075bcf5e3087632f776eb76127c80af5256bda6
 SHA512:
-  metadata.gz: d113e832989cef2126d880d5bfb5281185bcf4d393066c8a58797c9178d49165be1c5179609baf665b4bc51d698c1dbd9ed038c580f20c66ac9bdd532eb03d15
-  data.tar.gz: 6c6010c3310998627247edb81bd3958206e1756d87973a0c601183bc3f50ad8fddd1a2d22fd85d2368c9094a59f7e27f1031b80606f4bce0839d373a71213cf5
+  metadata.gz: 1d87b341b985cca628485419b0406b449289364497e4061024d0407551920fc8f62529fb35897761a1ae471c838cf2ce38d706fcf84eea4960abdd24a7608af5
+  data.tar.gz: '0758dfda18babfc4c47f870efe074e5a6bbd371aee1ba2a362f3d851791f20c2f5955e7f144972198a461a314b0a2a334c02d8191c7387503c30a11d8bd53c50'

data/Gemfile

@@ -7,11 +7,11 @@ gem 'ruby-termios', '>= 0.9' if RbConfig::CONFIG['target_os'] !~ /mswin|mingw|cy
 gemspec :name => 'openc3'
 
 # Include the rails gems for the convenience of custom microservice plugins
-gem 'rails', '~> 7.1.0'
 gem 'bootsnap', '>= 1.9.3', require: false
+gem 'mock_redis', '0.41'
 gem 'rack-cors', '~> 2.0'
-gem 'tzinfo-data'
+gem 'rails', '~> 7.1.0'
 gem 'rspec-rails', '~> 6.0'
 gem 'simplecov', '~> 0.20'
 gem 'simplecov-cobertura', '~> 2.1'
-gem 'mock_redis', '0.39'
+gem 'tzinfo-data'

data/bin/openc3cli

@@ -15,7 +15,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -42,9 +42,8 @@ require 'find'
 require 'json'
 require 'redis'
 require 'erb'
-require 'pp'
-require "irb"
-require "irb/completion"
+require 'irb'
+require 'irb/completion'
 
 $redis_url = "redis://#{ENV['OPENC3_REDIS_HOSTNAME']}:#{ENV['OPENC3_REDIS_PORT']}"
 
@@ -68,6 +67,7 @@ def print_usage
   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 TYPE OPTIONS         # Generate various COSMOS entities"
+  puts "    OPTIONS includes either --ruby or --python to specify the language in the generated code"
   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"
@@ -232,7 +232,7 @@ def xtce_converter(args)
 
   begin
     option_parser.parse!(args)
-  rescue => err
+  rescue => e
     abort(option_parser.to_s)
   end
 
@@ -348,10 +348,13 @@ def update_plugin(plugin_file_path, plugin_name, variables: nil, plugin_txt_line
     else
       puts "No changes detected - Exiting without change"
     end
-  rescue => error
-    puts error.formatted
-    plugin_model.restore if plugin_model.destroyed?
-    raise error
+  rescue => e
+    puts e.formatted
+    if plugin_model.destroyed?
+      plugin_model.restore
+      # Local mode files should still be good because restore will now reuse the old name
+    end
+    raise e
   end
 end
 
@@ -408,8 +411,8 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil, force: false)
         scope_model = OpenC3::ScopeModel.new(name: scope, scope: scope)
         scope_model.create
         scope_model.deploy(".", {})
-      rescue => err
-        abort("Error creating scope: #{scope}: #{err.formatted}")
+      rescue => e
+        abort("Error creating scope: #{scope}: #{e.formatted}")
       end
     end
 
@@ -467,8 +470,8 @@ def load_plugin(plugin_file_path, scope:, plugin_hash_file: nil, force: false)
         plugin_hash = OpenC3::PluginModel.install_phase2(plugin_hash, scope: scope)
         OpenC3::LocalMode.update_local_plugin(plugin_file_path, plugin_hash, scope: scope)
       end
-    rescue => error
-      abort("Error installing plugin: #{scope}: #{plugin_file_path}\n#{error.message}")
+    rescue => e
+      abort("Error installing plugin: #{scope}: #{plugin_file_path}\n#{e.message}")
     end
   else
     # Outside Cluster
@@ -496,8 +499,8 @@ def unload_plugin(plugin_name, scope:)
       plugin_model.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}")
+    rescue => e
+      abort("Error uninstalling plugin: #{scope}: #{plugin_name}: #{e.formatted}")
     end
   else
     # Outside Cluster
@@ -618,7 +621,7 @@ def run_bridge(filename, params)
       raise "Invalid variable passed to bridgegem (syntax name=value): #{param}"
     end
   end
-  bridge = OpenC3::Bridge.new(filename, variables)
+  OpenC3::Bridge.new(filename, variables)
   begin
     while true
       sleep(1)
@@ -731,7 +734,7 @@ if not ARGV[0].nil? # argument(s) given
   when 'removebase'
     # Used to remove tool base to better support enterprise upgrade
     scopes = OpenC3::ScopeModel.all
-    scopes.each do |scope_name, scope|
+    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/
@@ -746,7 +749,7 @@ if not ARGV[0].nil? # argument(s) given
   when 'removeenterprise'
     # Used to remove enterprise plugins to better support downgrade
     scopes = OpenC3::ScopeModel.all
-    scopes.each do |scope_name, scope|
+    scopes.each do |scope_name, _scope|
       plugins = OpenC3::PluginModel.all(scope: scope_name)
       plugins.each do |plugin_name, plugin|
         if plugin["name"] =~ /enterprise/

data/data/config/command_modifiers.yaml

@@ -192,4 +192,56 @@ TEMPLATE_FILE:
       required: true
       description: The relative path to the template file. Filename should generally start with an underscore.
       values: .+
-  since: 5.0.10
+  since: 5.0.10
+RESPONSE:
+  summary: Indicates the expected telemetry packet response to this command
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target Name of telemetry response packet
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of telemetry response packet
+      values: .+
+  since: 5.14.0
+ERROR_RESPONSE:
+  summary: Indicates the expected telemetry packet error response to this command
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target Name of telemetry error response packet
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of telemetry error response packet
+      values: .+
+  since: 5.14.0
+RELATED_ITEM:
+  summary: Defines a related telemetry item to this command
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target Name of related telemetry item
+      values: .+
+    - name: Packet Name
+      required: true
+      description: Packet Name of related telemetry item
+      values: .+
+    - name: Item Name
+      required: true
+      description: Item Name of related telemetry item
+      values: .+
+  since: 5.14.0
+SCREEN:
+  summary: Defines a related telemetry screen to this command
+  parameters:
+    - name: Target Name
+      required: true
+      description: Target Name of related telemetry screen
+      values: .+
+    - name: Screen Name
+      required: true
+      description: Screen Name of related telemetry screen
+      values: .+
+  since: 5.14.0

data/data/config/graph_settings.yaml

@@ -18,7 +18,7 @@ HISTORY:
   parameters:
     - name: Value
       required: true
-      description: Value{d,h,m,s}. For example 1d, 2h, 30m, 15s
+      description: Value(d,h,m,s). For example 1d, 2h, 30m, 15s
       values: .+
 SECONDSGRAPHED:
   summary: Display the specified number of seconds in the graph

data/data/config/item_modifiers.yaml

@@ -32,8 +32,7 @@ STATE:
 READ_CONVERSION:
   summary: Applies a conversion to the current telemetry item
   description: Conversions are implemented in a custom Ruby file which should be
-    located in the target's lib folder and required by the target's target.txt
-    file (see REQUIRE). The class must require 'openc3/conversions/conversion'
+    located in the target's lib folder. The class must require 'openc3/conversions/conversion'
     and inherit from Conversion. It must implement the initialize method if it
     takes extra parameters and must always implement the call method. The conversion
     factor is applied to the raw value in the telemetry packet before it is displayed

data/data/config/parameter_modifiers.yaml

@@ -63,23 +63,22 @@ STATE:
       values: "['\"].*['\"]"
 WRITE_CONVERSION:
   summary: Applies a conversion when writing the current command parameter
-  description: Conversions are implemented in a custom Ruby file which should be
-    located in the target's lib folder and required by the target's target.txt
-    file (see REQUIRE). The class must require 'openc3/conversions/conversion'
+  description: |
+    Conversions are implemented in a custom Ruby file which should be
+    located in the target's lib folder. The class must require 'openc3/conversions/conversion'
     and inherit from Conversion. It must implement the initialize method if it
     takes extra parameters and must always implement the call method. The conversion
     factor is applied to the value entered by the user before it is written into
     the binary command packet and sent.
 
-    <div class="note info">
-    <h5>Multiple write conversions on command parameters</h5>
-    <p>When a command is built, each item gets written (and write conversions are run)
+    :::info Multiple write conversions on command parameters
+    When a command is built, each item gets written (and write conversions are run)
     to set the default value. Then items are written (again write conversions are run)
     with user provided values. Thus write conversions can be run twice. Also there are
     no guarantees which parameters have already been written. The packet itself has a
     given_values() method which can be used to retrieve a hash of the user provided
-    values to the command. That can be used to check parameter values passed in.</p>
-    </div>
+    values to the command. That can be used to check parameter values passed in.
+    :::
   example: |
     WRITE_CONVERSION the_great_conversion.rb 1000
 
@@ -154,7 +153,8 @@ SEG_POLY_WRITE_CONVERSION:
       values: .*
 GENERIC_WRITE_CONVERSION_START:
   summary: Start a generic write conversion
-  description: Adds a generic conversion function to the current command parameter.
+  description: |
+    Adds a generic conversion function to the current command parameter.
     This conversion factor is applied to the value entered by the user before it
     is written into the binary command packet and sent. The conversion is specified
     as ruby code that receives two implied parameters. 'value' which is the raw
@@ -164,15 +164,14 @@ GENERIC_WRITE_CONVERSION_START:
     value. The GENERIC_WRITE_CONVERSION_END keyword specifies that all lines of
     ruby code for the conversion have been given.
 
-    <div class="note info">
-    <h5>Multiple write conversions on command parameters</h5>
-    <p>When a command is built, each item gets written (and write conversions are run)
+    :::info Multiple write conversions on command parameters
+    When a command is built, each item gets written (and write conversions are run)
     to set the default value. Then items are written (again write conversions are run)
     with user provided values. Thus write conversions can be run twice. Also there are
     no guarantees which parameters have already been written. The packet itself has a
     given_values() method which can be used to retrieve a hash of the user provided
-    values to the command. That can be used to check parameter values passed in.</p>
-    </div>
+    values to the command. That can be used to check parameter values passed in.
+    :::
   warning: Generic conversions are not a good long term solution. Consider creating
     a conversion class and using WRITE_CONVERSION instead. WRITE_CONVERSION is easier
     to debug and higher performance.

data/data/config/screen.yaml

@@ -53,7 +53,7 @@ GLOBAL_SETTING:
       description: See SETTING for details.
       values: .*
   example: |
-    GLOBAL_SETTING LABELVALUELIMITSBAR COLORBLIND TRUE
+    GLOBAL_SETTING LABELVALUELIMITSBAR TEXTCOLOR BLACK
 GLOBAL_SUBSETTING:
   summary: Applies a widget subsetting to all widgets of a certain type
   description: Subsettings are only valid for widgets that are
@@ -81,7 +81,6 @@ GLOBAL_SUBSETTING:
       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:

data/data/config/target_config.yaml

@@ -13,10 +13,7 @@ LANGUAGE:
   since: 5.11.1
 REQUIRE:
   summary: Requires a Ruby file
-  description:
-    Ruby files must be required to be available to call in other code.
-    Files are first required from the target's lib folder. If no file is found the
-    Ruby system path is checked which includes the base openc3/lib folder.
+  description: Ruby files optionally be required to explicitly declare dependencies.
   example: REQUIRE limits_response.rb
   parameters:
     - name: Filename
@@ -25,8 +22,7 @@ REQUIRE:
         simply supply the filename, e.g. "REQUIRE my_file". Files in the base OpenC3
         lib directory also should just list the filename. If a file is in a folder
         under the lib directory then you must specify the folder name, e.g. "REQUIRE
-        folder/my_file". The filename can also be an absolute path but this is not
-        common. Note the ".rb" extension is optional when specifying the filename.
+        folder/my_file". Note the ".rb" extension is optional when specifying the filename.
       values: .+
 IGNORE_PARAMETER:
   summary: Ignore the given command parameter

data/lib/openc3/accessors/accessor.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2022 OpenC3, Inc.
+# Copyright 2023 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -16,6 +16,8 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
+require 'json'
+
 module OpenC3
   class Accessor
     attr_accessor :packet
@@ -52,27 +54,37 @@ module OpenC3
       return @args
     end
 
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return 'ASCII-8BIT'.freeze
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return true
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return false
     end
 
-    def enforce_derived_write_conversion(item)
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
       return true
     end
 
-    def self.read_item(item, buffer)
+    def self.read_item(_item, _buffer)
       raise "Must be defined by subclass"
     end
 
-    def self.write_item(item, value, buffer)
+    def self.write_item(_item, _value, _buffer)
       raise "Must be defined by subclass"
     end
 
@@ -92,33 +104,34 @@ module OpenC3
     end
 
     def self.convert_to_type(value, item)
-      data_type = item.data_type
-      if (data_type == :STRING) || (data_type == :BLOCK)
-        #######################################
-        # Handle :STRING and :BLOCK data types
-        #######################################
-        value = value.to_s
-
-      elsif (data_type == :INT) || (data_type == :UINT)
-        ###################################
-        # Handle :INT data type
-        ###################################
-        value = Integer(value)
-
-      elsif data_type == :FLOAT
-        ##########################
-        # Handle :FLOAT data type
-        ##########################
-        value = Float(value)
-
+      case item.data_type
+      when :OBJECT
+        # Do nothing for complex object types
+      when :STRING, :BLOCK
+        if item.array_size
+          value = JSON.parse(value) if value.is_a? String
+          value =  value.map { |v| v.to_s }
+        else
+          value = value.to_s
+        end
+      when :UINT, :INT
+        if item.array_size
+          value = JSON.parse(value) if value.is_a? String
+          value = value.map { |v| Integer(v) }
+        else
+          value = Integer(value)
+        end
+      when :FLOAT
+        if item.array_size
+          value = JSON.parse(value) if value.is_a? String
+          value = value.map { |v| Float(v) }
+        else
+          value = Float(value)
+        end
       else
-        ############################
-        # Handle Unknown data types
-        ############################
-
-        raise(ArgumentError, "data_type #{data_type} is not recognized")
+        raise(ArgumentError, "data_type #{item.data_type} is not recognized")
       end
       return value
     end
   end
-end
+end

data/lib/openc3/accessors/binary_accessor.rb

@@ -1229,19 +1229,29 @@ module OpenC3
       values
     end
 
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return 'ASCII-8BIT'.freeze
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return true
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return false
     end
 
-    def enforce_derived_write_conversion(item)
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
       return true
     end
   end # class BinaryAccessor

data/lib/openc3/accessors/form_accessor.rb

@@ -59,19 +59,29 @@ module OpenC3
       return value
     end
 
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return nil
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return false
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return true
     end
 
-    def enforce_derived_write_conversion(item)
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
       return true
     end
   end

data/lib/openc3/accessors/http_accessor.rb

@@ -121,18 +121,56 @@ module OpenC3
       return value
     end
 
+    def read_items(items, buffer)
+      result = {}
+      body_items = []
+      items.each do |item|
+        if item.name[0..4] == 'HTTP_'
+          result[item.name] = read_item(item, buffer)
+        else
+          body_items << item
+        end
+      end
+      body_result = @body_accessor.read_items(body_items, buffer)
+      result.merge!(body_result) # Merge Body accessor read items with HTTP_ items
+      return result
+    end
+
+    def write_items(items, values, buffer)
+      body_items = []
+      items.each_with_index do |item, index|
+        if item.name[0..4] == 'HTTP_'
+          write_item(item, values[index], buffer)
+        else
+          body_items << item
+        end
+      end
+      @body_accessor.write_items(body_items, values, buffer)
+      return values
+    end
+
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return @body_accessor.enforce_encoding
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return @body_accessor.enforce_length
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return @body_accessor.enforce_short_buffer_allowed
     end
 
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
     def enforce_derived_write_conversion(item)
       case item.name
       when 'HTTP_STATUS', 'HTTP_PATH', 'HTTP_METHOD', 'HTTP_PACKET', 'HTTP_ERROR_PACKET', /^HTTP_QUERY_/, /^HTTP_HEADER_/

data/lib/openc3/accessors/json_accessor.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2022 OpenC3, Inc.
+# Copyright 2023 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -24,7 +24,8 @@ module OpenC3
   class JsonAccessor < Accessor
     def self.read_item(item, buffer)
       return nil if item.data_type == :DERIVED
-      return JsonPath.on(buffer, item.key).first
+      value = JsonPath.on(buffer, item.key).first
+      return convert_to_type(value, item)
     end
 
     def self.write_item(item, value, buffer)
@@ -123,6 +124,7 @@ module OpenC3
           raise "Unsupported key/token: #{item.key} - #{token}"
         end
       end
+      value = convert_to_type(value, item)
       if parent_node
         parent_node[parent_key] = value
       else
@@ -131,19 +133,29 @@ module OpenC3
       return decoded
     end
 
+    # If this is set it will enforce that buffer data is encoded
+    # in a specific encoding
     def enforce_encoding
       return nil
     end
 
+    # This affects whether the Packet class enforces the buffer
+    # length at all.  Set to false to remove any correlation between
+    # buffer length and defined sizes of items in COSMOS
     def enforce_length
       return false
     end
 
+    # This sets the short_buffer_allowed flag in the Packet class
+    # which allows packets that have a buffer shorter than the defined size.
+    # Note that the buffer is still resized to the defined length
     def enforce_short_buffer_allowed
       return true
     end
 
-    def enforce_derived_write_conversion(item)
+    # If this is true it will enfore that COSMOS DERIVED items must have a
+    # write_conversion to be written
+    def enforce_derived_write_conversion(_item)
       return true
     end
   end