openc3 5.4.3.pre.beta0 → 5.5.0

data/lib/openc3/bridge/bridge_config.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/utilities/logger'
@@ -30,28 +30,55 @@ module OpenC3
     # @return [Hash<String, Interface>] Routers hash
     attr_accessor :routers
 
-    def initialize(filename)
+    def initialize(filename, existing_variables = {})
       @interfaces = {}
       @routers = {}
-      process_file(filename)
+      process_file(filename, existing_variables)
     end
 
     def self.generate_default(filename)
       default_config = <<~EOF
-                # Example Host Bridge Configuration for a Serial Port
-                #
-                # INTERFACE <Interface Name> <Interface File> <Interface Params...>
-                # INTERFACE <Interface Name> serial_interface.rb <Write Port> <Read Port> <Baud Rate> <Parity ODD/EVEN/NONE> <Stop Bits> <Write Timeout> <Read Timeout> <Protocol Name> <Protocol Params>
-                # INTERFACE <Interface Name> serial_interface.rb <Write Port> <Read Port> <Baud Rate> <Parity ODD/EVEN/NONE> <Stop Bits> <Write Timeout> <Read Timeout> BURST <Discard Leading Bytes> <Sync Pattern> <Add Sync On Write>
-                # INTERFACE SERIAL_INT serial_interface.rb /dev/ttyS1 /dev/ttyS1 38400 ODD 1 10.0 nil BURST 4 0xDEADBEEF
-                INTERFACE SERIAL_INT serial_interface.rb COM1 COM1 9600 NONE 1 10.0 nil BURST
+        # Write serial port name
+        VARIABLE write_port_name COM1
         #{'        '}
-                # ROUTER <Router Name> <Interface File> <Interface Params...>
-                # ROUTER SERIAL_ROUTER tcpip_server_interface.rb <Write Port> <Read Port> <Write Timeout> <Read Timeout> <Protocol Name> <Protocol Params>
-                # ROUTER SERIAL_ROUTER tcpip_server_interface.rb <Write Port> <Read Port> <Write Timeout> <Read Timeout> BURST <Discard Leading Bytes> <Sync Pattern> <Add Sync On Write>
-                ROUTER SERIAL_ROUTER tcpip_server_interface.rb 2950 2950 10.0 nil BURST
-                  # ROUTE <Interface Name>
-                  ROUTE SERIAL_INT
+        # Read serial port name
+        VARIABLE read_port_name COM1
+        #{'        '}
+        # Baud Rate
+        VARIABLE baud_rate 115200
+        #{'        '}
+        # Parity - NONE, ODD, or EVEN
+        VARIABLE parity NONE
+        #{'        '}
+        # Stop bits - 0, 1, or 2
+        VARIABLE stop_bits 1
+        #{'        '}
+        # Write Timeout
+        VARIABLE write_timeout 10.0
+        #{'        '}
+        # Read Timeout
+        VARIABLE read_timeout nil
+        #{'        '}
+        # Flow Control - NONE, or RTSCTS
+        VARIABLE flow_control NONE
+        #{'        '}
+        # Data bits per word - Typically 8
+        VARIABLE data_bits 8
+        #{'        '}
+        # Port to listen for connections from COSMOS - Plugin must match
+        VARIABLE router_port 2950
+        #{'        '}
+        # Port to listen on for connections from COSMOS. Defaults to localhost for security. Will need to be opened
+        # if COSMOS is on another machine.
+        VARIABLE router_listen_address 127.0.0.1
+        #{'        '}
+        INTERFACE SERIAL_INT serial_interface.rb <%= write_port_name %> <%= read_port_name %> <%= baud_rate %> <%= parity %> <%= stop_bits %> <%= write_timeout %> <%= read_timeout %>
+          OPTION FLOW_CONTROL <%= flow_control %>
+          OPTION DATA_BITS <%= data_bits %>
+        #{'        '}
+        ROUTER SERIAL_ROUTER tcpip_server_interface.rb <%= router_port %> <%= router_port %> 10.0 nil BURST
+          ROUTE SERIAL_INT
+          OPTION LISTEN_ADDRESS <%= router_listen_address %>
         #{'        '}
       EOF
 
@@ -66,18 +93,39 @@ module OpenC3
     # Processes a file and adds in the configuration defined in the file
     #
     # @param filename [String] The name of the configuration file to parse
-    # @param recursive [Boolean] Whether process_file is being called
-    #   recursively
-    def process_file(filename, recursive = false)
+    def process_file(filename, existing_variables = {})
       current_interface_or_router = nil
       current_type = nil
       current_interface_log_added = false
 
       Logger.info "Processing Bridge configuration in file: #{File.expand_path(filename)}"
 
+      variables = {}
       parser = ConfigParser.new
-      parser.parse_file(filename) do |keyword, params|
+      parser.parse_file(filename,
+                        false,
+                        true,
+                        false) do |keyword, params|
         case keyword
+        when 'VARIABLE'
+          usage = "#{keyword} <Variable Name> <Default Value>"
+          parser.verify_num_parameters(2, nil, usage)
+          variable_name = params[0]
+          value = params[1..-1].join(" ")
+          variables[variable_name] = value
+          if existing_variables && existing_variables.key?(variable_name)
+            variables[variable_name] = existing_variables[variable_name]
+          end
+          # Ignore everything else during phase 1
+        end
+      end
+
+      parser = ConfigParser.new
+      parser.parse_file(filename, false, true, true, variables) do |keyword, params|
+        case keyword
+
+        when 'VARIABLE'
+          # Ignore during this pass
 
         when 'INTERFACE'
           usage = "INTERFACE <Name> <Filename> <Specific Parameters>"

data/lib/openc3/interfaces/interface.rb

@@ -25,6 +25,11 @@ require 'openc3/io/raw_logger_pair'
 require 'openc3/utilities/secrets'
 
 module OpenC3
+  # Define a class to allow interfaces and protocols to reject commands without
+  # disconnecting the interface
+  class WriteRejectError < StandardError
+  end
+
   # Defines all the attributes and methods common to all interface classes
   # used by OpenC3.
   class Interface
@@ -330,6 +335,9 @@ 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
       Logger.error("#{@name}: Error writing to interface")
       disconnect()

data/lib/openc3/microservices/decom_microservice.rb

@@ -95,7 +95,6 @@ module OpenC3
     # @param log_change [Boolean] Whether to log this limits change event
     def limits_change_callback(packet, item, old_limits_state, value, log_change)
       return if @cancel_thread
-      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       packet_time = packet.packet_time
       message = "#{packet.target_name} #{packet.packet_name} #{item.name} = #{value} is #{item.limits.state}"
       message << " (#{packet.packet_time.sys.formatted})" if packet_time
@@ -136,8 +135,6 @@ module OpenC3
           @logger.error e.formatted
         end
       end
-
-      diff = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start # seconds as a float
     end
   end
 end

data/lib/openc3/microservices/interface_microservice.rb

@@ -202,6 +202,8 @@ module OpenC3
               else
                 next "Interface not connected: #{@interface.name}"
               end
+            rescue WriteRejectError => e
+              next e.message
             rescue => e
               @logger.error "#{@interface.name}: #{e.formatted}"
               next e.message

data/lib/openc3/microservices/reaction_microservice.rb

@@ -264,7 +264,6 @@ module OpenC3
           when 'trigger'
             process_enabled_trigger(data: data)
           end
-          current_time = Time.now.to_i
         rescue StandardError => e
           @logger.error "ReactionWorker-#{@ident} failed to evaluate kind: #{kind} data: #{data}\n#{e.formatted}"
         end

data/lib/openc3/models/cvt_model.rb

@@ -240,11 +240,10 @@ module OpenC3
     # return an ordered array of hash with keys
     def self._parse_item(lookups, overrides, item, scope:)
       target_name, packet_name, item_name, value_type = item.split('__')
-      raise ArgumentError, "items must be formatted as TGT__PKT__ITEM__TYPE" if target_name.nil? || packet_name.nil? || item_name.nil? || value_type.nil?
 
       # We build lookup keys by including all the less formatted types to gracefully degrade lookups
       # This allows the user to specify WITH_UNITS and if there is no conversions it will simply return the RAW value
-      case value_type.upcase
+      case value_type
       when 'RAW'
         keys = [item_name]
       when 'CONVERTED'

data/lib/openc3/models/metadata_model.rb

@@ -69,7 +69,7 @@ module OpenC3
       if @color.nil?
         @color = '#%06x' % (rand * 0xffffff)
       end
-      unless @color =~ /(#*)([0-9,a-f,A-F]{6})/
+      unless @color =~ /(#*)([0-9a-fA-F]{6})/
         raise SortedInputError.new "invalid color, must be in hex format, e.g. #FF0000"
       end
       @color = "##{@color}" unless @color.start_with?('#')

data/lib/openc3/models/microservice_model.rb

@@ -163,7 +163,7 @@ module OpenC3
         parser.verify_num_parameters(1, 2, usage)
         begin
           @ports << [Integer(parameters[0])]
-        rescue => err # In case Integer fails
+        rescue # In case Integer fails
           raise ConfigParser::Error.new(parser, "Port must be an integer: #{parameters[0]}", usage)
         end
         protocol = ConfigParser.handle_nil(parameters[1])

data/lib/openc3/models/note_model.rb

@@ -78,7 +78,7 @@ module OpenC3
       if @color.nil?
         @color = '#%06x' % (rand * 0xffffff)
       end
-      unless @color =~ /(#*)([0-9,a-f,A-F]{6})/
+      unless @color =~ /(#*)([0-9a-fA-F]{6})/
         raise SortedInputError.new "invalid color, must be in hex format, e.g. #FF0000"
       end
       @color = "##{@color}" unless @color.start_with?('#')

data/lib/openc3/models/plugin_model.rb

@@ -72,7 +72,7 @@ module OpenC3
       temp_dir = Dir.mktmpdir
       tf = nil
       begin
-        if File.exists?(gem_file_path)
+        if File.exist?(gem_file_path)
           # Load gem to internal gem server
           OpenC3::GemModel.put(gem_file_path, gem_install: false, scope: scope) unless validate_only
         else
@@ -122,7 +122,6 @@ module OpenC3
             if existing_variables && existing_variables.key?(variable_name)
               variables[variable_name] = existing_variables[variable_name]
             end
-            # Ignore everything else during phase 1
           end
         end
 
@@ -162,14 +161,21 @@ module OpenC3
         gem_path = File.join(temp_dir, "gem")
         FileUtils.mkdir_p(gem_path)
         pkg = Gem::Package.new(gem_file_path)
-        needs_dependencies = pkg.spec.runtime_dependencies.length > 0
         pkg.extract_files(gem_path)
         Dir[File.join(gem_path, '**/screens/*.txt')].each do |filename|
           if File.basename(filename) != File.basename(filename).downcase
-            raise "Invalid screen name: #{filename}. Screen names must be lowercase."
+            raise "Invalid screen filename: #{filename}. Screen filenames must be lowercase."
           end
         end
+        needs_dependencies = pkg.spec.runtime_dependencies.length > 0
         needs_dependencies = true if Dir.exist?(File.join(gem_path, 'lib'))
+        # If needs_dependencies hasn't already been set we need to scan the plugin.txt
+        # to see if they've explicitly set the NEEDS_DEPENDENCIES keyword
+        unless needs_dependencies
+          if plugin_hash['plugin_txt_lines'].join("\n").include?('NEEDS_DEPENDENCIES')
+            needs_dependencies = true
+          end
+        end
         if needs_dependencies
           plugin_model.needs_dependencies = true
           plugin_model.update unless validate_only
@@ -198,7 +204,7 @@ module OpenC3
             current_model = nil
             parser.parse_file(plugin_txt_path, false, true, true, variables) do |keyword, params|
               case keyword
-              when 'VARIABLE'
+              when 'VARIABLE', 'NEEDS_DEPENDENCIES'
                 # Ignore during phase 2
               when 'TARGET', 'INTERFACE', 'ROUTER', 'MICROSERVICE', 'TOOL', 'WIDGET'
                 if current_model
@@ -206,12 +212,13 @@ module OpenC3
                   current_model.deploy(gem_path, variables, validate_only: validate_only)
                   current_model = nil
                 end
-                current_model = OpenC3.const_get((keyword.capitalize + 'Model').intern).handle_config(parser, keyword, params, plugin: plugin_model.name, needs_dependencies: needs_dependencies, scope: scope)
+                current_model = OpenC3.const_get((keyword.capitalize + 'Model').intern).handle_config(parser,
+                  keyword, params, plugin: plugin_model.name, needs_dependencies: needs_dependencies, scope: scope)
               else
                 if current_model
                   current_model.handle_config(parser, keyword, params)
                 else
-                  raise "Invalid keyword #{keyword} in plugin.txt"
+                  raise "Invalid keyword '#{keyword}' in plugin.txt"
                 end
               end
             end

data/lib/openc3/models/timeline_model.rb

@@ -91,7 +91,7 @@ module OpenC3
       if color.nil?
         color = '#%06x' % (rand * 0xffffff)
       end
-      valid_color = color =~ /[0-9,a-f,A-F]{6}/
+      valid_color = color =~ /[0-9a-fA-F]{6}/
       if valid_color.nil?
         raise RuntimeError.new "invalid color but in hex format. #FF0000"
       end

data/lib/openc3/models/trigger_group_model.rb

@@ -92,7 +92,7 @@ module OpenC3
       if color.nil?
         color = '#%06x' % (rand * 0xffffff)
       end
-      valid_color = color =~ /[0-9,a-f,A-F]{6}/
+      valid_color = color =~ /[0-9a-fA-F]{6}/
       if valid_color.nil?
         raise TriggerGroupInputError.new "invalid color must be in hex format. #FF0000"
       end

data/lib/openc3/packets/packet_item.rb

@@ -80,7 +80,7 @@ module OpenC3
 
     # @return [Hash] Whether or not messages should be printed for this state.
     #   Given as STATE_NAME => true / false.
-    attr_accessor :messages_disabled
+    attr_reader :messages_disabled
 
     # Colors associated with states
     # @return [Hash] State colors given as STATE_NAME => COLOR

data/lib/openc3/script/script.rb

@@ -31,6 +31,7 @@ require 'openc3/script/limits'
 require 'openc3/script/exceptions'
 require 'openc3/script/script_runner'
 require 'openc3/script/storage'
+require 'openc3/script/web_socket_api'
 require 'openc3/utilities/authentication'
 
 $api_server = nil
@@ -99,6 +100,15 @@ module OpenC3
       # NOOP
     end
 
+    def openc3_script_sleep(sleep_time = nil)
+      if sleep_time
+        sleep(sleep_time)
+      else
+        prompt("Press any key to continue...")
+      end
+      return false
+    end
+
     def ask_string(question, blank_or_default = false, password = false)
       answer = ''
       default = ''

data/lib/openc3/script/storage.rb

@@ -77,7 +77,7 @@ module OpenC3
           else
             request.body_stream = io_or_string
           end
-          response = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+          Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
             http.request(request) do |response|
               response.value() # Raises an HTTP error if the response is not 2xx (success)
               return response
@@ -157,17 +157,17 @@ module OpenC3
       if $openc3_in_cluster
         case ENV['OPENC3_CLOUD']
         when 'local'
-          uri = URI.parse("http://openc3-minio:9000" + url)
+          URI.parse("http://openc3-minio:9000" + url)
         when 'aws'
-          uri = URI.parse("https://s3.#{ENV['AWS_REGION']}.amazonaws.com" + url)
+          URI.parse("https://s3.#{ENV['AWS_REGION']}.amazonaws.com" + url)
         when 'gcp'
-          uri = URI.parse("https://storage.googleapis.com" + url)
+          URI.parse("https://storage.googleapis.com" + url)
         # when 'azure'
         else
           raise "Unknown cloud #{ENV['OPENC3_CLOUD']}"
         end
       else
-        uri = URI.parse($api_server.generate_url + url)
+        URI.parse($api_server.generate_url + url)
       end
     end