openc3 5.14.1 → 5.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 459b654a51a4d3b984681eb1b25165039e95d0a22c68e08973fc3539beee1b5c
-  data.tar.gz: cf6975c07ab38342228401d84a01f1ee672f4a74b7c2a697f2dc893aecfb4b3e
+  metadata.gz: 0eaf09072832c752cd1c0ae08160f9a5ef5bb24e585f10ee8be31d22c54ce2e7
+  data.tar.gz: 17fbccdaf92dd9c6e7fae704ca4bacadef88b026c5023d7dbb69583a19f6fe3e
 SHA512:
-  metadata.gz: 8368bda2e80639021df632271a972a5a716a8db380eb23dd4375d3334d10ca3001a5a33d9017caeeff684804338d4ba36a2adc180d1656f843d20440560d47ab
-  data.tar.gz: 195a9f6a3e4dbbadb1ed219765f627e1dd3cf96f9fd14a21e7891ea24e5cef6847eefb644ae8cfcbd15a894a32f0c23fc10bf405b9b2c3011553411f14f58b42
+  metadata.gz: 92e1bfa1bbd283c4e94d49627ea8bfe6be9423ff88bc1a5453af778fb10dc3cefd78b2cef6b553fa6d1aa6f21559e70413e5343ec546b93841c62c124a3840a1
+  data.tar.gz: ac243f0b29ee7cccd5c809c5625a084cb54a3920b283402ddc7da8ce4178816d9ce75d44cb8af8154438a846ff116dec41b27cd5623ef5ded506c0c2d320e590

data/bin/openc3cli

@@ -50,9 +50,9 @@ $redis_url = "redis://#{ENV['OPENC3_REDIS_HOSTNAME']}:#{ENV['OPENC3_REDIS_PORT']
 # 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
+MIGRATE_PARSER = OptionParser.new do |opts|
+  opts.banner = "cli migrate PLUGIN [TGT1...]      # Create a OpenC3 plugin from existing COSMOS 4 targets"
+  opts.on("-a", "--all", " Move all COSMOS 4 targets into a single OpenC3 plugin") do
     MIGRATE_OPTIONS.all = true
   end
 end
@@ -67,7 +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 "    OPTIONS: --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"
@@ -208,31 +208,31 @@ end
 
 def xtce_converter(args)
   options = {}
-  option_parser = OptionParser.new do |option_parser|
-    option_parser.banner = "Usage: xtce_converter [options] --import input_xtce_filename --output output_dir\n"+
+  option_parser = OptionParser.new do |opts|
+    opts.banner = "Usage: xtce_converter [options] --import input_xtce_filename --output output_dir\n"+
       "       xtce_converter [options] --plugin /PATH/FILENAME.gem --output output_dir --variables variables.txt"
-    option_parser.separator("")
-    option_parser.on("-h", "--help", "Show this message") do
-      puts option_parser
+    opts.separator("")
+    opts.on("-h", "--help", "Show this message") do
+      puts opts
       exit
     end
-    option_parser.on("-i VALUE", "--import VALUE", "Import the specified .xtce file") do |arg|
+    opts.on("-i VALUE", "--import VALUE", "Import the specified .xtce file") do |arg|
       options[:import] = arg
     end
-    option_parser.on("-o", "--output DIRECTORY", "Create files in the directory") do |arg|
+    opts.on("-o", "--output DIRECTORY", "Create files in the directory") do |arg|
       options[:output] = arg
     end
-    option_parser.on("-p", "--plugin PLUGIN", "Export .xtce file(s) from the plugin") do |arg|
+    opts.on("-p", "--plugin PLUGIN", "Export .xtce file(s) from the plugin") do |arg|
       options[:plugin] = arg
     end
-    option_parser.on("-v", "--variables", "Optional variables file to pass to the plugin") do |arg|
+    opts.on("-v", "--variables", "Optional variables file to pass to the plugin") do |arg|
       options[:variables] = arg
     end
   end
 
   begin
     option_parser.parse!(args)
-  rescue => e
+  rescue
     abort(option_parser.to_s)
   end
 
@@ -641,7 +641,11 @@ if not ARGV[0].nil? # argument(s) given
     IRB.start
 
   when 'rake'
-    puts `rake #{ARGV[1..-1].join(' ')}`
+    if File.exist?('Rakefile')
+      puts `rake #{ARGV[1..-1].join(' ')}`
+    else
+      puts "No Rakefile found! Only run 'rake' in the presense of a Rakefile which is typically at the root of your COSMOS project."
+    end
 
   when 'validate'
     validate_plugin(ARGV[1], scope: ARGV[2], variables_file: ARGV[3])

data/bin/pipinstall

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+pip install "$@"
+if [ $? -eq 0 ]; then
+    echo "Command succeeded"
+else
+    echo "Command failed - retrying with --no-index"
+    pip install --no-index "$@"
+fi

data/data/config/target_config.yaml

@@ -13,7 +13,8 @@ LANGUAGE:
   since: 5.11.1
 REQUIRE:
   summary: Requires a Ruby file
-  description: Ruby files optionally be required to explicitly declare dependencies.
+  description: List the Ruby files required to explicitly declare dependencies.
+    This is now completely optional.
   example: REQUIRE limits_response.rb
   parameters:
     - name: Filename

data/lib/openc3/config/config_parser.rb

@@ -14,7 +14,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
@@ -143,7 +143,7 @@ module OpenC3
     end
 
     # @param url [String] The url to link to in error messages
-    def initialize(url = "https:/openc3.com/docs/v5")
+    def initialize(url = "https://docs.openc3.com/docs")
       @url = url
     end
 
@@ -199,7 +199,7 @@ module OpenC3
                    remove_quotes = true,
                    run_erb = true,
                    variables = {},
-                   &block)
+                   &)
       raise Error.new(self, "Configuration file #{filename} does not exist.") unless filename && File.exist?(filename)
 
       @filename = filename
@@ -219,7 +219,7 @@ module OpenC3
                    remove_quotes,
                    size,
                    PARSING_REGEX,
-                   &block)
+                   &)
       ensure
         file.close unless file.closed?
       end
@@ -267,7 +267,7 @@ module OpenC3
       end
     end
 
-    # Converts a String containing '', 'NIL' or 'NULL' to nil Ruby primitive.
+    # Converts a String containing '', 'NIL', 'NULL', or 'NONE' to nil Ruby primitive.
     # All other arguments are simply returned.
     #
     # @param value [Object]
@@ -275,7 +275,7 @@ module OpenC3
     def self.handle_nil(value)
       if String === value
         case value.upcase
-        when '', 'NIL', 'NULL'
+        when '', 'NIL', 'NULL', 'NONE'
           return nil
         end
       end
@@ -421,12 +421,12 @@ module OpenC3
         if type == 'MIN'
           value = -2**(bit_size - 1)
         else # 'MAX'
-          value = 2**(bit_size - 1) - 1
+          value = (2**(bit_size - 1)) - 1
         end
       when :UINT
         # Default is 0 for 'MIN'
         if type == 'MAX'
-          value = 2**bit_size - 1
+          value = (2**bit_size) - 1
         end
       when :FLOAT
         case bit_size
@@ -536,8 +536,8 @@ module OpenC3
             if yield_non_keyword_lines
               begin
                 yield(@keyword, @parameters)
-              rescue => error
-                errors << error
+              rescue => e
+                errors << e
               end
             end
             @line = ''
@@ -569,8 +569,8 @@ module OpenC3
 
           begin
             yield(@keyword, @parameters)
-          rescue => error
-            errors << error
+          rescue => e
+            errors << e
           end
           @line = ''
         end

data/lib/openc3/conversions/conversion.rb

@@ -14,10 +14,10 @@
 # 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 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 module OpenC3
@@ -46,7 +46,7 @@ module OpenC3
     #   conversion.
     # @param buffer [String] The packet buffer
     # @return The converted value
-    def call(value, packet, buffer)
+    def call(_value, _packet, _buffer)
       raise "call method must be defined by subclass"
     end
 
@@ -61,7 +61,7 @@ module OpenC3
       "    #{read_or_write}_CONVERSION #{self.class.name.class_name_to_filename}\n"
     end
 
-    def as_json(*a)
+    def as_json(*_a)
       result = {}
       result['class'] = self.class.name.to_s
       result['converted_type'] = @converted_type if @converted_type

data/lib/openc3/interfaces/interface.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2023, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -205,8 +205,8 @@ module OpenC3
                   else
                     cmd(cmd_string)
                   end
-                rescue Exception => err
-                  Logger.error("Error sending periodic cmd(#{cmd_string}):\n#{err.formatted}")
+                rescue Exception => e
+                  Logger.error("Error sending periodic cmd(#{cmd_string}):\n#{e.formatted}")
                 end
               end
             end
@@ -238,7 +238,7 @@ module OpenC3
       raise "read_interface not defined by Interface"
     end
 
-    def write_interface(data, extra = nil)
+    def write_interface(_data, _extra = nil)
       raise "write_interface not defined by Interface"
     end
 
@@ -305,10 +305,10 @@ module OpenC3
         Logger.warn("#{@name}: Interface unexpectedly requested disconnect") unless packet
         return packet
       end
-    rescue Exception => err
+    rescue Exception => e
       Logger.error("#{@name}: Error reading from interface")
       disconnect()
-      raise err
+      raise e
     end
 
     # Method to send a packet on the interface.
@@ -395,16 +395,16 @@ module OpenC3
       else
         @write_mutex.synchronize { yield }
       end
-    rescue WriteRejectError => err
-      Logger.error("#{@name}: Write rejected by interface: #{err.message}")
-      raise err
-    rescue Exception => err
+    rescue WriteRejectError => e
+      Logger.error("#{@name}: Write rejected by interface: #{e.message}")
+      raise e
+    rescue Exception => e
       Logger.error("#{@name}: Error writing to interface")
       disconnect()
-      raise err
+      raise e
     end
 
-    def as_json(*a)
+    def as_json(*_a)
       config = {}
       config['name'] = @name
       config['state'] = @state
@@ -528,7 +528,7 @@ module OpenC3
     # method is called. Subclasses must implement this method.
     #
     # @return [String] Raw packet data
-    def read_interface_base(data, extra = nil)
+    def read_interface_base(data, _extra = nil)
       @read_raw_data_time = Time.now
       @read_raw_data = data.clone
       @bytes_read += data.length
@@ -541,7 +541,7 @@ module OpenC3
     #
     # @param data [String] Raw packet data
     # @return [String] The exact data written
-    def write_interface_base(data, extra = nil)
+    def write_interface_base(data, _extra = nil)
       @written_raw_data_time = Time.now
       @written_raw_data = data.clone
       @bytes_written += data.length
@@ -567,9 +567,16 @@ module OpenC3
       return protocol
     end
 
-    def interface_cmd(cmd_name, *cmd_args)
-      # Default do nothing - Implemented by subclasses
-      return false
+    def interface_cmd(cmd_name, *_cmd_args)
+      case cmd_name
+      when 'clear_counters'
+        @write_queue_size = 0
+        @read_queue_size = 0
+        @bytes_written = 0
+        @bytes_read = 0
+        @write_count = 0
+        @read_count = 0
+      end
     end
 
     def protocol_cmd(cmd_name, *cmd_args, read_write: :READ_WRITE, index: -1)
@@ -584,7 +591,7 @@ module OpenC3
         write_protocols = @write_protocols.reverse
         read_index = 0
         write_index = 0
-        @protocol_info.each do |protocol_class, protocol_args, protocol_read_write|
+        @protocol_info.each do |_protocol_class, _protocol_args, protocol_read_write|
           case protocol_read_write
           when :READ
             protocols << read_protocols[read_index]

data/lib/openc3/microservices/interface_microservice.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2023, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -52,9 +52,9 @@ module OpenC3
     def start
       @thread = Thread.new do
         run()
-      rescue Exception => err
-        @logger.error "#{@interface.name}: Command handler thread died: #{err.formatted}"
-        raise err
+      rescue Exception => e
+        @logger.error "#{@interface.name}: Command handler thread died: #{e.formatted}"
+        raise e
       end
     end
 
@@ -67,7 +67,7 @@ module OpenC3
     end
 
     def run
-      InterfaceTopic.receive_commands(@interface, scope: @scope) do |topic, msg_id, msg_hash, redis|
+      InterfaceTopic.receive_commands(@interface, scope: @scope) do |topic, msg_id, msg_hash, _redis|
         OpenC3.with_context(msg_hash) do
           msgid_seconds_from_epoch = msg_id.split('-')[0].to_i / 1000.0
           delta = Time.now.to_f - msgid_seconds_from_epoch
@@ -126,6 +126,7 @@ module OpenC3
               begin
                 @logger.info "#{@interface.name}: interface_cmd: #{params['cmd_name']} #{params['cmd_params'].join(' ')}"
                 @interface.interface_cmd(params['cmd_name'], *params['cmd_params'])
+                InterfaceStatusModel.set(@interface.as_json(:allow_nan => true), scope: @scope)
               rescue => e
                 @logger.error "#{@interface.name}: interface_cmd: #{e.formatted}"
                 next e.message
@@ -137,6 +138,7 @@ module OpenC3
               begin
                 @logger.info "#{@interface.name}: protocol_cmd: #{params['cmd_name']} #{params['cmd_params'].join(' ')} read_write: #{params['read_write']} index: #{params['index']}"
                 @interface.protocol_cmd(params['cmd_name'], *params['cmd_params'], read_write: params['read_write'], index: params['index'])
+                InterfaceStatusModel.set(@interface.as_json(:allow_nan => true), scope: @scope)
               rescue => e
                 @logger.error "#{@interface.name}: protocol_cmd: #{e.formatted}"
                 next e.message
@@ -241,9 +243,9 @@ module OpenC3
     def start
       @thread = Thread.new do
         run()
-      rescue Exception => err
-        @logger.error "#{@router.name}: Telemetry handler thread died: #{err.formatted}"
-        raise err
+      rescue Exception => e
+        @logger.error "#{@router.name}: Telemetry handler thread died: #{e.formatted}"
+        raise e
       end
     end
 
@@ -256,7 +258,7 @@ module OpenC3
     end
 
     def run
-      RouterTopic.receive_telemetry(@router, scope: @scope) do |topic, msg_id, msg_hash, redis|
+      RouterTopic.receive_telemetry(@router, scope: @scope) do |topic, msg_id, msg_hash, _redis|
         msgid_seconds_from_epoch = msg_id.split('-')[0].to_i / 1000.0
         delta = Time.now.to_f - msgid_seconds_from_epoch
         @metric.set(name: 'router_topic_delta_seconds', value: delta, type: 'gauge', unit: 'seconds', help: 'Delta time between data written to stream and router tlm start') if @metric
@@ -296,6 +298,7 @@ module OpenC3
             begin
               @logger.info "#{@router.name}: router_cmd: #{params['cmd_name']} #{params['cmd_params'].join(' ')}"
               @router.interface_cmd(params['cmd_name'], *params['cmd_params'])
+              RouterStatusModel.set(@router.as_json(:allow_nan => true), scope: @scope)
             rescue => e
               @logger.error "#{@router.name}: router_cmd: #{e.formatted}"
               next e.message
@@ -307,6 +310,7 @@ module OpenC3
             begin
               @logger.info "#{@router.name}: protocol_cmd: #{params['cmd_name']} #{params['cmd_params'].join(' ')} read_write: #{params['read_write']} index: #{params['index']}"
               @router.protocol_cmd(params['cmd_name'], *params['cmd_params'], read_write: params['read_write'], index: params['index'])
+              RouterStatusModel.set(@router.as_json(:allow_nan => true), scope: @scope)
             rescue => e
               @logger.error "#{@router.name}: protoco_cmd: #{e.formatted}"
               next e.message
@@ -434,9 +438,9 @@ module OpenC3
       end
       @interface # Return the interface/router since we may have recreated it
     # Need to rescue Exception so we cover LoadError
-    rescue Exception => error
-      @logger.error("Attempting connection failed with params #{params} due to #{error.message}")
-      if SignalException === error
+    rescue Exception => e
+      @logger.error("Attempting connection failed with params #{params} due to #{e.message}")
+      if SignalException === e
         @logger.info "#{@interface.name}: Closing from signal"
         @cancel_thread = true
       end
@@ -463,8 +467,8 @@ module OpenC3
                 # We need to make sure connect is not called after stop() has been called
                 connect() unless @cancel_thread
               end
-            rescue Exception => connect_error
-              handle_connection_failed(connect_error)
+            rescue Exception => e
+              handle_connection_failed(e)
               break if @cancel_thread
             end
           when 'CONNECTED'
@@ -484,8 +488,8 @@ module OpenC3
                   handle_connection_lost()
                   break if @cancel_thread
                 end
-              rescue Exception => err
-                handle_connection_lost(err)
+              rescue Exception => e
+                handle_connection_lost(e)
                 break if @cancel_thread
               end
             else
@@ -494,10 +498,10 @@ module OpenC3
             end
           end
         end
-      rescue Exception => error
-        unless SystemExit === error or SignalException === error
-          @logger.error "#{@interface.name}: Packet reading thread died: #{error.formatted}"
-          OpenC3.handle_fatal_exception(error)
+      rescue Exception => e
+        unless SystemExit === e or SignalException === e
+          @logger.error "#{@interface.name}: Packet reading thread died: #{e.formatted}"
+          OpenC3.handle_fatal_exception(e)
         end
         # Try to do clean disconnect because we're going down
         disconnect(false)
@@ -615,13 +619,13 @@ module OpenC3
       @logger.info "#{@interface.name}: Connecting ..."
       begin
         @interface.connect
-      rescue Exception => error
+      rescue Exception => e
         begin
           @interface.disconnect # Ensure disconnect is called at least once on a partial connect
         rescue Exception
           # We want to report any connect errors, not disconnect in this case
         end
-        raise error
+        raise e
       end
       @interface.state = 'CONNECTED'
       if @interface_or_router == 'INTERFACE'
@@ -685,7 +689,7 @@ module OpenC3
       end
     end
 
-    def shutdown(sig = nil)
+    def shutdown(_sig = nil)
       @logger.info "#{@interface ? @interface.name : @name}: shutdown requested"
       stop()
       super()

data/lib/openc3/models/plugin_model.rb

@@ -183,13 +183,17 @@ module OpenC3
         if File.exist?(File.join(gem_path, 'requirements.txt'))
           begin
             pypi_url = get_setting('pypi_url', scope: scope)
-          rescue
-            # If Redis isn't running try the ENV, then simply pypi.org/simple
-            pypi_url = ENV['PYPI_URL']
-            pypi_url ||= 'https://pypi.org/simple'
+          rescue => e
+            Logger.error("Failed to retrieve pypi_url: #{e.formatted}")
+          ensure
+            if pypi_url.nil?
+              # If Redis isn't running try the ENV, then simply pypi.org/simple
+              pypi_url = ENV['PYPI_URL']
+              pypi_url ||= 'https://pypi.org/simple'
+            end
           end
-          Logger.info "Installing python packages from requirements.txt"
-          puts `pip install --user -i #{pypi_url} -r #{File.join(gem_path, 'requirements.txt')}`
+          Logger.info "Installing python packages from requirements.txt with pypi_url=#{pypi_url}"
+          puts `/openc3/bin/pipinstall --user -i #{pypi_url} -r #{File.join(gem_path, 'requirements.txt')}`
           needs_dependencies = true
         end
 

data/lib/openc3/packets/limits_response.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 # This file implements a class to handle responses to limits state changes.