openc3 5.18.0 → 5.19.0

data/lib/openc3/packets/telemetry.rb

@@ -31,7 +31,7 @@ module OpenC3
   #
   # This should not be confused with the Api module which implements the JSON
   # API that is used by tools when accessing the Server. The Api module always
-  # provides Ruby primatives where the Telemetry class can return actual
+  # provides Ruby primitives where the Telemetry class can return actual
   # Packet or PacketItem objects. While there are some overlapping methods between
   # the two, these are separate interfaces into the system.
   class Telemetry
@@ -295,7 +295,7 @@ module OpenC3
         target = System.targets[target_name]
         if target and target.tlm_unique_id_mode
           # Iterate through the packets and see if any represent the buffer
-          target_packets.each do |packet_name, packet|
+          target_packets.each do |_packet_name, packet|
             return packet if packet.identify?(packet_data)
           end
         else
@@ -365,43 +365,22 @@ module OpenC3
     #
     # @param limits_change_callback
     def limits_change_callback=(limits_change_callback)
-      @config.telemetry.each do |target_name, packets|
-        packets.each do |packet_name, packet|
+      @config.telemetry.each do |_target_name, packets|
+        packets.each do |_packet_name, packet|
           packet.limits_change_callback = limits_change_callback
         end
       end
     end
 
-    # Clears the received_count value on every packet in every target
-    def clear_counters
-      @config.telemetry.each do |target_name, target_packets|
-        target_packets.each do |packet_name, packet|
-          packet.received_count = 0
-        end
-      end
-    end
-
     # Resets metadata on every packet in every target
     def reset
-      @config.telemetry.each do |target_name, target_packets|
-        target_packets.each do |packet_name, packet|
+      @config.telemetry.each do |_target_name, target_packets|
+        target_packets.each do |_packet_name, packet|
           packet.reset
         end
       end
     end
 
-    # Returns the first non-hidden packet
-    def first_non_hidden
-      @config.telemetry.each do |target_name, target_packets|
-        next if target_name == 'UNKNOWN'
-
-        target_packets.each do |packet_name, packet|
-          return packet unless packet.hidden
-        end
-      end
-      nil
-    end
-
     # Returns an array with a "TARGET_NAME PACKET_NAME ITEM_NAME" string for every item in the system
     def all_item_strings(include_hidden = false, splash = nil)
       strings = []

data/lib/openc3/script/api_shared.rb

@@ -14,13 +14,14 @@
 # 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
 # if purchased from OpenC3, Inc.
 
 require 'openc3/script/extract'
+require 'openc3/script/exceptions'
 
 module OpenC3
   module ApiShared
@@ -460,8 +461,9 @@ module OpenC3
     end
 
     def set_line_delay(delay)
-      if defined? RunningScript
-        RunningScript.line_delay = delay if delay >= 0.0
+      if defined? RunningScript and delay >= 0.0
+        RunningScript.line_delay = delay
+        puts "set_line_delay(#{delay})"
       end
     end
 
@@ -529,7 +531,7 @@ module OpenC3
     ###########################################################################
 
     # This must be here for custom microservices that might block.
-    # Overriden by running_script.rb for script sleep
+    # Overridden by running_script.rb for script sleep
     def openc3_script_sleep(sleep_time = nil)
       if sleep_time
         sleep(sleep_time)
@@ -544,7 +546,7 @@ module OpenC3
       "#{target_name.upcase} #{packet_name.upcase} #{item_name.upcase}"
     end
 
-    # Implementaton of the various check commands. It yields back to the
+    # Implementation of the various check commands. It yields back to the
     # caller to allow the return of the value through various telemetry calls.
     # This method should not be called directly by application code.
     def _check(*args, scope: $openc3_scope, token: $openc3_token)

data/lib/openc3/script/calendar.rb

@@ -86,8 +86,8 @@ module OpenC3
       return _handle_response(response, 'Failed to get timeline activity')
     end
 
-    def delete_timeline_activity(name, start, scope: $openc3_scope, token: $openc3_token)
-      response = $api_server.request('delete', "/openc3-api/timeline/#{name}/activity/#{start}", scope: scope)
+    def delete_timeline_activity(name, start, uuid, scope: $openc3_scope, token: $openc3_token)
+      response = $api_server.request('delete', "/openc3-api/timeline/#{name}/activity/#{start}/#{uuid}", scope: scope)
       return _handle_response(response, 'Failed to delete timeline activity')
     end
 

data/lib/openc3/script/commands.rb

@@ -106,9 +106,11 @@ module OpenC3
     end
 
     # Send the command and log the results
-    # This method signature has to include the keyword params present in cmd_api.rb cmd_implementation()
+    # This method signature has to include the keyword params present in cmd_api.rb _cmd_implementation()
+    # except for range_check, hazardous_check, and raw as they are part of the cmd name
+    # manual is always false since this is called from script and that is the default
     # NOTE: This is a helper method and should not be called directly
-    def _cmd(cmd, cmd_no_hazardous, *args, timeout: nil, log_message: nil, scope: $openc3_scope, token: $openc3_token, **kwargs)
+    def _cmd(cmd, cmd_no_hazardous, *args, timeout: nil, log_message: nil, validate: true, scope: $openc3_scope, token: $openc3_token, **kwargs)
       extract_string_kwargs_to_args(args, kwargs)
       raw = cmd.include?('raw')
       no_range = cmd.include?('no_range') || cmd.include?('no_checks')
@@ -118,7 +120,7 @@ module OpenC3
         _cmd_disconnect(cmd, raw, no_range, no_hazardous, *args, scope: scope)
       else
         begin
-          target_name, cmd_name, cmd_params = $api_server.method_missing(cmd, *args, timeout: timeout, log_message: log_message, scope: scope, token: token)
+          target_name, cmd_name, cmd_params = $api_server.method_missing(cmd, *args, timeout: timeout, log_message: log_message, validate: validate, scope: scope, token: token)
           if log_message.nil? or log_message
             _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous)
           end
@@ -126,7 +128,7 @@ module OpenC3
           # This opens a prompt at which point they can cancel and stop the script
           # or say Yes and send the command. Thus we don't care about the return value.
           prompt_for_hazardous(e.target_name, e.cmd_name, e.hazardous_description)
-          target_name, cmd_name, cmd_params = $api_server.method_missing(cmd_no_hazardous, *args, timeout: timeout, log_message: log_message, scope: scope, token: token)
+          target_name, cmd_name, cmd_params = $api_server.method_missing(cmd_no_hazardous, *args, timeout: timeout, log_message: log_message, validate: validate, scope: scope, token: token)
           if log_message.nil? or log_message
             _log_cmd(target_name, cmd_name, cmd_params, raw, no_range, no_hazardous)
           end

data/lib/openc3/script/metadata.rb

@@ -34,7 +34,7 @@ module OpenC3
     # @return The result of the method call.
     def metadata_all(limit: 100, scope: $openc3_scope)
       response = $api_server.request('get', "/openc3-api/metadata", query: { limit: limit }, scope: scope)
-      # Non-existant just returns nil
+      # Non-existent just returns nil
       return nil if response.nil? || response.status != 200
       return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
     end
@@ -49,7 +49,7 @@ module OpenC3
       else
         response = $api_server.request('get', "/openc3-api/metadata/latest", scope: scope)
       end
-      # Non-existant just returns nil
+      # Non-existent just returns nil
       return nil if response.nil? || response.status != 200
       return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
     end

data/lib/openc3/script/suite.rb

@@ -42,7 +42,7 @@ module OpenC3
     # START PUBLIC API
     ###########################################################################
 
-    # Explictly avoid creating an initialize method which forces end users to call super()
+    # Explicitly avoid creating an initialize method which forces end users to call super()
 
     # Add a group to the suite
     def add_group(group_class)
@@ -84,8 +84,8 @@ module OpenC3
     # END PUBLIC API
     ###########################################################################
 
-    def <=>(other_suite)
-      self.name <=> other_suite.name
+    def <=>(other)
+      self.name <=> other.name
     end
 
     # Name of the suite
@@ -100,7 +100,7 @@ module OpenC3
     # Returns the number of scripts in the suite including setup and teardown methods
     def get_num_scripts
       num_scripts = 0
-      @plans.each do |type, group_class, script|
+      @plans.each do |type, group_class, _script|
         case type
         when :GROUP
           num_scripts += group_class.get_num_scripts
@@ -114,7 +114,7 @@ module OpenC3
     end
 
     # Run all the scripts
-    def run(&block)
+    def run(&)
       ScriptResult.suite = name()
       ScriptStatus.instance.total = get_num_scripts()
       results = []
@@ -131,7 +131,7 @@ module OpenC3
       @plans.each do |type, group_class, script|
         case type
         when :GROUP
-          results.concat(run_group(group_class, true, &block))
+          results.concat(run_group(group_class, true, &))
         when :SCRIPT
           result = run_script(group_class, script, true)
           results << result
@@ -167,7 +167,7 @@ module OpenC3
     end
 
     # Run a specific group
-    def run_group(group_class, internal = false, &block)
+    def run_group(group_class, internal = false, &)
       ScriptResult.suite = name() unless internal
 
       # Determine if this group_class is in the plan and the number of scripts associated with this group_class
@@ -186,7 +186,7 @@ module OpenC3
 
       if in_plan
         ScriptStatus.instance.total = group_class.get_num_scripts() unless internal
-        results = @scripts[group_class].run(&block)
+        results = @scripts[group_class].run(&)
       else
         results = []
         ScriptStatus.instance.total = num_scripts unless internal
@@ -278,7 +278,7 @@ module OpenC3
     @@abort_on_exception = false
     @@current_result = nil
 
-    # Explictly avoid creating an initialize method which forces end users to call super()
+    # Explicitly avoid creating an initialize method which forces end users to call super()
 
     def self.abort_on_exception
       @@abort_on_exception
@@ -374,26 +374,26 @@ module OpenC3
             result.result     = :FAIL
             RunningScript.instance.exceptions = nil
           end
-        rescue StandardError, SyntaxError => error
+        rescue StandardError, SyntaxError => e
           # Check that the error belongs to the StopScript inheritance chain
-          if error.class <= StopScript
+          if e.class <= StopScript
             result.stopped = true
             result.result  = :STOP
           end
           # Check that the error belongs to the SkipScript inheritance chain
-          if error.class <= SkipScript
+          if e.class <= SkipScript
             result.result  = :SKIP
             result.message ||= ''
-            result.message << error.message + "\n"
+            result.message << (e.message + "\n")
           else
-            if error.class != StopScript and
+            if e.class != StopScript and
                (not RunningScript.instance or
                  not RunningScript.instance.exceptions or
-                 not RunningScript.instance.exceptions.include? error)
+                 not RunningScript.instance.exceptions.include? e)
               result.exceptions ||= []
-              result.exceptions << error
+              result.exceptions << e
               puts "*** Exception in Control Statement:"
-              error.formatted.each_line do |line|
+              e.formatted.each_line do |line|
                 puts '  ' + line
               end
             end

data/lib/openc3/streams/serial_stream.rb

@@ -20,7 +20,6 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
-require 'thread' # For Mutex
 require 'openc3/streams/stream'
 require 'openc3/config/config_parser'
 require 'openc3/io/serial_driver'
@@ -40,11 +39,11 @@ module OpenC3
     # @param parity [Symbol] Must be :NONE, :EVEN, or :ODD
     # @param stop_bits [Integer] Stop bits. Must be 1 or 2.
     # @param write_timeout [Integer] Seconds to wait for the write to complete.
-    #   The {SerialDriver} will continously try to send the data until
+    #   The {SerialDriver} will continuously try to send the data until
     #   it has been sent or an error occurs.
     # @param read_timeout [Integer] Seconds to wait for the read to complete.
     #   Pass nil to block until the read is complete. The {SerialDriver} will
-    #   continously try to read data until it has received data or an error occurs.
+    #   continuously try to read data until it has received data or an error occurs.
     # @param flow_control [Symbol] Currently supported :NONE and :RTSCTS (default :NONE)
     # @param data_bits [Integer] Number of data bits (default 8)
     def initialize(write_port_name,

data/lib/openc3/streams/stream.rb

@@ -17,11 +17,11 @@
 # 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.
 
 module OpenC3
-  # Class that implments the following methods: read, write(data),
+  # Class that implements the following methods: read, write(data),
   # connect, connected? and disconnect. Streams are simply data sources which
   # {Protocol} classes read and write to. This separation of concerns
   # allows Streams to simply focus on getting and sending raw data while the

data/lib/openc3/tools/cmd_tlm_server/interface_thread.rb

@@ -22,7 +22,7 @@
 
 module OpenC3
   # Encapsulates an {Interface} in a Ruby thread. When the thread is started by
-  # the {#start} method, it loops trying to connect. It then continously reads
+  # the {#start} method, it loops trying to connect. It then continuously reads
   # from the interface while handling the packets it receives.
   class InterfaceThread
     # The number of bytes to print when an UNKNOWN packet is received
@@ -82,8 +82,8 @@ module OpenC3
                   connect() unless @cancel_thread
                 end
                 break if @cancel_thread
-              rescue Exception => connect_error
-                handle_connection_failed(connect_error)
+              rescue Exception => e
+                handle_connection_failed(e)
                 if @cancel_thread
                   break
                 else
@@ -105,8 +105,8 @@ module OpenC3
                   end
                 end
                 packet.received_time = Time.now.sys unless packet.received_time
-              rescue Exception => err
-                handle_connection_lost(err)
+              rescue Exception => e
+                handle_connection_lost(e)
                 if @cancel_thread
                   break
                 else
@@ -120,12 +120,12 @@ module OpenC3
               handle_connection_lost(nil) if !@interface.connected?
             end
           end # loop
-        rescue Exception => error
+        rescue Exception => e
           if @fatal_exception_callback
-            @fatal_exception_callback.call(error)
+            @fatal_exception_callback.call(e)
           else
             Logger.error "Packet reading thread unexpectedly died for #{@interface.name}"
-            OpenC3.handle_fatal_exception(error)
+            OpenC3.handle_fatal_exception(e)
           end
         end
         Logger.info "Stopped packet reading for #{@interface.name}"
@@ -207,8 +207,8 @@ module OpenC3
       # Write to routers
       @interface.routers.each do |router|
         router.write(packet) if router.write_allowed? and router.connected?
-      rescue => err
-        Logger.error "Problem writing to router #{router.name} - #{err.class}:#{err.message}"
+      rescue => e
+        Logger.error "Problem writing to router #{router.name} - #{e.class}:#{e.message}"
       end
 
       # Write to packet log writers

data/lib/openc3/tools/table_manager/table_manager_core.rb

@@ -50,8 +50,8 @@ module OpenC3
       config = TableConfig.process_file(definition_filename)
       begin
         load_binary(config, binary)
-      rescue CoreError => err
-        report.puts "Error: #{err.message}\n"
+      rescue CoreError => e
+        report.puts "Error: #{e.message}\n"
       end
 
       config.tables.each do |table_name, table|
@@ -83,7 +83,7 @@ module OpenC3
           report.write "#{rowtext}, "
           (0...table.num_columns).each do |c|
             if table.type == :ROW_COLUMN
-              table_item = items[c + r * table.num_columns]
+              table_item = items[c + (r * table.num_columns)]
             else
               table_item = items[r]
             end
@@ -104,7 +104,7 @@ module OpenC3
     def self.generate(definition_filename)
       config = TableConfig.process_file(definition_filename)
       binary = ''
-      config.tables.each do |table_name, table|
+      config.tables.each do |_table_name, table|
         table.restore_defaults
         binary += table.buffer
       end
@@ -125,7 +125,7 @@ module OpenC3
         end
       end
       binary = ''
-      config.tables.each { |table_name, table| binary += table.buffer }
+      config.tables.each { |_table_name, table| binary += table.buffer }
       binary
     end
 
@@ -137,8 +137,8 @@ module OpenC3
       json = { tables: tables }
       begin
         load_binary(config, binary)
-      rescue CoreError => err
-        json['errors'] = err.message
+      rescue CoreError => e
+        json['errors'] = e.message
       end
       config.tables.each do |table_name, table|
         tables << {
@@ -150,7 +150,7 @@ module OpenC3
         }
         col = 0
         row = 0
-        table.sorted_items.each_with_index do |item, index|
+        table.sorted_items.each_with_index do |item, _index|
           next if item.hidden
           if table.num_columns == 1
             if row == 0
@@ -197,10 +197,10 @@ module OpenC3
     def self.load_binary(config, data)
       binary_data_index = 0
       total_table_length = 0
-      config.tables.each do |table_name, table|
+      config.tables.each do |_table_name, table|
         total_table_length += table.length
       end
-      config.tables.each do |table_name, table|
+      config.tables.each do |_table_name, table|
         if binary_data_index + table.length > data.length
           table.buffer = data[binary_data_index..-1]
           raise MismatchError,
@@ -213,7 +213,7 @@ module OpenC3
       if binary_data_index < data.length
         raise MismatchError,
           "Binary size of #{data.length} larger than table definition of length #{total_table_length}. "+
-          "Discarding the remaing #{data.length - binary_data_index} bytes."
+          "Discarding the remaining #{data.length - binary_data_index} bytes."
       end
     end
 

data/lib/openc3/tools/table_manager/table_parser.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.
 
 require 'openc3/packets/parsers/packet_parser'
@@ -29,7 +29,7 @@ module OpenC3
     # @param parser [ConfigParser] Configuration parser
     # @param tables [Hash] Hash of the currently defined tables
     # @param warnings [Array<String>] Any warning strings generated while
-    #   parsing this command will be appened to this array
+    #   parsing this command will be appended to this array
     def self.parse_table(parser, tables, warnings)
       parser = TableParser.new(parser)
       parser.verify_parameters
@@ -76,7 +76,6 @@ module OpenC3
       TableParser.finish_create_table(table, tables, warnings)
     end
 
-    protected
 
     def self.check_for_duplicate(tables, table)
       msg = nil

data/lib/openc3/topics/command_decom_topic.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
@@ -39,6 +39,7 @@ module OpenC3
         json_hash[item.name + "__F"] = packet.read_item(item, :FORMATTED) if item.format_string
         json_hash[item.name + "__U"] = packet.read_item(item, :WITH_UNITS) if item.units
       end
+      json_hash['extra'] = JSON.generate(packet.extra.as_json(:allow_nan => true))
       msg_hash['json_data'] = JSON.generate(json_hash.as_json(:allow_nan => true))
       EphemeralStoreQueued.write_topic(topic, msg_hash)
     end

data/lib/openc3/topics/command_topic.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
@@ -26,7 +26,7 @@ require 'openc3/utilities/open_telemetry'
 
 module OpenC3
   class CommandTopic < Topic
-    COMMAND_ACK_TIMEOUT_S = 5
+    COMMAND_ACK_TIMEOUT_S = 30
 
     def self.write_packet(packet, scope:)
       topic = "#{scope}__COMMAND__{#{packet.target_name}}__#{packet.packet_name}"
@@ -52,7 +52,7 @@ module OpenC3
       cmd_id = Topic.write_topic("{#{scope}__CMD}TARGET__#{command['target_name']}", command, '*', 100)
       time = Time.now
       while (Time.now - time) < timeout
-        Topic.read_topics([ack_topic]) do |topic, msg_id, msg_hash, redis|
+        Topic.read_topics([ack_topic]) do |_topic, _msg_id, msg_hash, _redis|
           if msg_hash["id"] == cmd_id
             if msg_hash["result"] == "SUCCESS"
               return [command['target_name'], command['cmd_name'], cmd_params]

data/lib/openc3/topics/decom_interface_topic.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2023 OpenC3, Inc.
+# Copyright 2024 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -37,7 +37,7 @@ module OpenC3
       timeout = 5 # Arbitrary 5s timeout
       time = Time.now
       while (Time.now - time) < timeout
-        Topic.read_topics([ack_topic]) do |topic, msg_id, msg_hash, redis|
+        Topic.read_topics([ack_topic]) do |_topic, _msg_id, msg_hash, _redis|
           if msg_hash["id"] == decom_id
             if msg_hash["result"] == "SUCCESS"
               return msg_hash

data/lib/openc3/topics/telemetry_decom_topic.rb

@@ -32,7 +32,7 @@ module OpenC3
         # everything base name is RAW (including DERIVED)
         # Request for WITH_UNITS, etc will look down until it finds something
         # If nothing - item does not exist - nil
-        # __ as seperators ITEM1, ITEM1__C, ITEM1__F, ITEM1__U
+        # __ as separators ITEM1, ITEM1__C, ITEM1__F, ITEM1__U
 
         json_hash = CvtModel.build_json_from_packet(packet)
         # Write to stream

data/lib/openc3/utilities/authorization.rb

@@ -43,9 +43,10 @@ rescue LoadError
         if $openc3_authorize
           raise AuthError.new("Token is required") unless token
           unless OpenC3::AuthModel.verify(token)
-            raise AuthError.new("Password is invalid for '#{permission}' permission")
+            raise AuthError.new("Password is invalid")
           end
         end
+        return "anonymous"
       end
 
       def user_info(_token)

data/lib/openc3/utilities/cli_generator.rb

@@ -41,10 +41,17 @@ module OpenC3
         abort("No gemspec file detected. #{args[0].to_s.downcase} generator should be run within an existing plugin.")
       end
 
-      if args[-1] == '--python'
+      gen_lang = ENV['OPENC3_LANGUAGE']
+      if (args[-1] == '--python' || args[-1] == '--ruby')
+        gen_lang = args[-1][2, 6]
+      end
+      case gen_lang
+      when 'python'
         @@language = 'py'
-      else
+      when 'ruby'
         @@language = 'rb'
+      else
+        abort("One of --python or --ruby is required unless OPENC3_LANGUAGE is set.")
       end
     end
 
@@ -72,8 +79,8 @@ module OpenC3
     end
 
     def self.generate_plugin(args)
-      if args.length != 2
-        abort("Usage: cli generate #{args[0]} <NAME>")
+      if args.length < 2 or args.length > 3
+        abort("Usage: cli generate #{args[0]} <NAME> (--ruby or --python)")
       end
 
       # Create the local variables
@@ -196,8 +203,8 @@ module OpenC3
     end
 
     def self.generate_widget(args)
-      if args.length != 2
-        abort("Usage: cli generate #{args[0]} <SuperdataWidget>")
+      if args.length < 2 or args.length > 3
+        abort("Usage: cli generate #{args[0]} <SuperdataWidget> (--ruby or --python)")
       end
       # Per https://stackoverflow.com/a/47591707/453280
       if args[1] !~ /.*Widget$/ or args[1][0...-6] != args[1][0...-6].capitalize
@@ -242,8 +249,8 @@ module OpenC3
     end
 
     def self.generate_tool(args)
-      if args.length != 2
-        abort("Usage: cli generate #{args[0]} 'Tool Name'")
+      if args.length < 2 or args.length > 3
+        abort("Usage: cli generate #{args[0]} 'Tool Name' (--ruby or --python)")
       end
 
       # Create the local variables