openc3 5.4.2 → 5.4.3.pre.beta0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08e9c285070449047388f035c8c56522154ed54cd9e075dc3b52e87f17a7ff0e'
-  data.tar.gz: d52d4c20ffd7f7ea1593d19df3be807d7dc4cc787e30390d11f8c1b90103c186
+  metadata.gz: 859879129f5646a4e8fd10a916e1e88859a7b5ed178fe2983f42df4e7e8c1a52
+  data.tar.gz: 745a188c5e9277e0bb793207f383f85d6ec6d571d41d6115530f6f78bd671817
 SHA512:
-  metadata.gz: 5e242af794c1263642f951c46867ce5fa543ccef505c60c0d6a4015c91503acf8d62b3b7b8dd40b91ec4c252013b4a40eec21d0bb3055bc5f6ae11e370c48fbe
-  data.tar.gz: 06b2ad289fcd4bfbfa23a896469b1d9d4b55b017e4535eb060a101147b4b757535f071dd622121f78923a2d0e1923795e109b94d3c6917933e0ce74e11c586cd
+  metadata.gz: '0582ba269983955ae39c8d0c941666d2fcc65811416e3c1ae7026811fa00d9699ecffc09e195909f30cac3c8571f6b83889349fed9c96ec89c95091aff088a61'
+  data.tar.gz: a9c9c554d6595cd7718dc58b1e2e07e0ff9a440cd6545674b47250a3542164a41d27bad1bf237c8c121f170dd04380eeaa125769abc9423c0de2e610578f9799

data/Gemfile

@@ -6,13 +6,8 @@ gem 'ruby-termios', '>= 0.9' if RbConfig::CONFIG['target_os'] !~ /mswin|mingw|cy
 
 gemspec :name => 'openc3'
 
-# unless ENV['JENKINS_HOME']
-#   # Example of how to use a local branch (doesn't work on Jenkins)
-#   #   You also need to set "bundle config local.mock_redis <LOCAL PATH TO CHECKED OUT GEM>"
-#   #   For example: bundle config local.mock_redis C:/_Programs/oss/mock_redis
-#   #   Make sure the local copy is checked out to the specified branch
-#   #   Delete the config: bundle config --delete local.mock_redis
-#   group :development do
-#     gem 'mock_redis', github: 'jasonatball/mock_redis', branch: 'master'
-#   end
-# end
+# Include the rails gems for the convenience of custom microservice plugins
+gem 'rails', '~> 7.0.0'
+gem 'bootsnap', '>= 1.9.3', require: false
+gem 'rack-cors', '~> 1.1'
+gem 'tzinfo-data'

data/bin/openc3cli

@@ -43,6 +43,8 @@ require 'redis'
 require 'erb'
 require 'pp'
 # require 'psych' # Psych code is commented out
+require "irb"
+require "irb/completion"
 
 $redis_url = "redis://#{ENV['OPENC3_REDIS_HOSTNAME']}:#{ENV['OPENC3_REDIS_PORT']}"
 # Initialize the connection to the bucket library
@@ -64,13 +66,14 @@ def print_usage
   puts "Usage:"
   puts "  cli help                          # Displays this information"
   puts "  cli rake                          # Runs rake in the local directory"
+  puts "  cli irb                           # Runs irb in the local directory"
   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 plugin PLUGIN_NAME   # Generate a COSMOS plugin"
   puts "  #{MIGRATE_PARSER}"
   puts "  cli bridge CONFIG_FILENAME        # Run COSMOS host bridge"
   puts "  cli bridgesetup CONFIG_FILENAME   # Create a default config file"
-  puts "  cli geminstall GEMFILENAME SCOPE        # Install loaded gem to /gems"
+  puts "  cli geminstall GEMFILENAME SCOPE  # Install loaded gem to /gems"
   puts "  cli rubysloc                      # Counts Ruby SLOC recursively. Run with --help for more info."
   puts "  cli xtce_converter                # Convert to and from the XTCE format. Run with --help for more info."
   puts "  cli cstol_converter               # Converts CSTOL files (.prc) to COSMOS. Run with --help for more info."
@@ -526,6 +529,10 @@ if not ARGV[0].nil? # argument(s) given
   # Handle each task
   case ARGV[0].downcase
 
+  when 'irb'
+    ARGV.clear
+    IRB.start
+
   when 'rake'
     puts `rake #{ARGV[1..-1].join(' ')}`
 

data/data/config/_interfaces.yaml

@@ -27,7 +27,8 @@ tcpip_client_interface.rb:
     - name: Protocol Type
       required: true
       description: Protocol to apply on the interface data
-      values: 
+      # prettier-ignore
+      values:
         <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
 tcpip_server_interface.rb:
   parameters:
@@ -52,7 +53,8 @@ tcpip_server_interface.rb:
     - name: Protocol Type
       required: true
       description: Protocol to apply on the interface data
-      values: 
+      # prettier-ignore
+      values:
         <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
 udp_interface.rb:
   description: The UDP interface uses UDP packets to send and receive telemetry
@@ -142,73 +144,6 @@ serial_interface.rb:
     - name: Protocol Type
       required: true
       description: Protocol to apply on the interface data
-      values: 
+      # prettier-ignore
+      values:
         <%= MetaConfigParser.load('protocols.yaml').to_meta_config_yaml(8) %>
-cmd_tlm_server_interface.rb:
-  description: Provides a connection to the OpenC3 Command and Telemetry Server.
-    This allows scripts and other OpenC3 tools to send commands to the CmdTlmServer
-    to enable and disable logging. It also allows scripts and other tools to
-    receive a OpenC3 version information packet and a limits change packet which
-    is sent when any telemetry items change limits states. The CmdTlmServer
-    interface can be used by any OpenC3 configuration.
-linc_interface.rb:
-  description: The LINC interface uses a single TCPIP socket to talk to a Ball
-    Aerospace LINC Labview target.
-  parameters:
-    - name: Host
-      required: true
-      description: Machine name to connect to. Can be either a named
-        machine (DNS entry) or IP address.
-      values: .+
-    - name: Port
-      required: true
-      description: Port to write commands to and read telemetry from
-      values: \d{2,5}
-    - name: Handshake Enabled
-      required: false
-      description: Enable command handshaking where commands block until the
-        corresponding handshake message is received. Default is true.
-      values: ["true", "false"]
-    - name: Response Timeout
-      required: false
-      description: Number of seconds to wait for a handshaking response.
-        Default is 5 seconds
-      values: \d+
-    - name: Read Timeout
-      required: true
-      description: Number of seconds to wait before aborting the read.
-        Pass 'nil' to block on read. Default is nil.
-      values: .+
-    - name: Write Timeout
-      required: true
-      description: Number of seconds to wait before aborting the write.
-        Pass 'nil' to block on write. Default is 5 seconds.
-      values: .+
-    - name: Length Bit Offset
-      required: false
-      description: The bit offset of the length field. Every packet using this
-        interface must have the same structure such that the length field is the
-        same size at the same location. Default is 0.
-      values: \d+
-    - name: Length Bit Size
-      required: false
-      description: The size in bits of the length field. Default is 16 bits.
-      values: \d+
-    - name: Length Value Offset
-      required: false
-      description: The offset to apply to the length field value. For example if
-        the length field indicates packet length minus one, this value should be one.
-        Default is 4.
-      values: \d+
-    - name: GUID Fieldname
-      required: false
-      description: Fieldname of the GUID field. Default is 'HDR_GUID'.
-      values: .+
-    - name: Length Endianness
-      required: false
-      description: The endianness of the length field. Default is BIG_ENDIAN.
-      values: ["BIG_ENDIAN", "LITTLE_ENDIAN"]
-    - name: Length Fieldname
-      required: false
-      description: Fieldname of the length field. Defaults is 'HDR_LENGTH'.
-      values: .+

data/data/config/interface_modifiers.yaml

@@ -41,29 +41,6 @@ DISABLE_DISCONNECT:
     Use this keyword to prevent the user from disconnecting from the interface.
     This is typically used in a 'production' environment where you would not want
     the user to inadvertantly disconnect from a target.
-LOG:
-  summary: Enable logging on the interface by the specified log writer
-  description:
-    LOG is only required if you want a log writer other than the default
-    to log commands and telemetry on this interface
-  warning: Choosing a custom log writer can prevent OpenC3 from reading back your log files
-  parameters:
-    - name: Name
-      required: true
-      description: Log writer name as defined by PACKET_LOG_WRITER
-      values: \D\S*
-LOG_STORED:
-  summary: Enable logging of stored telemetry on the interface by the specified log writer
-  description:
-    LOG_STORED allows you to specify a different log writer for stored telemetry
-    (telemetry which has the 'stored' flag set in the packet). By default the stored telemetry
-    is intermingled in the normal log file.
-  warning: Choosing a custom log writer can prevent OpenC3 from reading back your log files
-  parameters:
-    - name: Name
-      required: true
-      description: Log writer name as defined by PACKET_LOG_WRITER
-      values: \D\S*
 DONT_LOG:
   summary: Disable logging commands and telemetry on this interface
 LOG_RAW:

data/data/config/microservice.yaml

@@ -106,3 +106,11 @@ MICROSERVICE:
           required: true
           description: Environment variable name or file path to store secret
           values: .*
+    ROUTE_PREFIX:
+      summary: Prefix of route
+      description: Prefix of route to the microservice to expose externally with Traefik
+      parameters:
+        - name: Route Prefix
+          required: true
+          description: Route prefix. Must be unique across all scopes. Something like /myprefix
+          values: .*

data/data/config/target.yaml

@@ -156,6 +156,7 @@ TARGET:
           values: \d+
     TARGET_MICROSERVICE:
       summary: Breaks a target microservice out into its own process.
+      description:
         Can be used to give more resources to processing that is falling behind.
         If defined multiple times for the same type, will create multiple processes.
         Each process can be given specific packets to process with the PACKET keyword.

data/data/config/widgets.yaml

@@ -162,26 +162,6 @@ TITLE:
       required: true
       description: Text to display above the horizontal line
       values: .*
-# SPACER:
-#   summary: Inserts a spacer into a layout. This can be used to
-#     separate or align other widgets.
-#   parameters:
-#     - name: Width
-#       required: true
-#       description: The width of the spacer in pixels.
-#       values: .*
-#     - name: Height
-#       required: true
-#       description: The height of the spacer in pixels.
-#       values: .*
-#     - name: Horizontal Policy
-#       required: false
-#       description: The horizontal size policy of the spacer. Default is MINIMUM.
-#       values: <%= %w(FIXED MINIMUM MAXIMUM PREFERRED EXPANDING MINIMUMEXPANDING IGNORED) %>
-#     - name: Vertical Policy
-#       required: false
-#       description: The vertical size policy of the spacer. Default is MINIMUM.
-#       values: <%= %w(FIXED MINIMUM MAXIMUM PREFERRED EXPANDING MINIMUMEXPANDING IGNORED) %>
 ARRAY:
   summary: Displays ARRAY data organized into rows and space separated
   parameters:
@@ -303,7 +283,8 @@ BLOCK:
 #       values: .*
 FORMATVALUE:
   summary: Displays a box with a formatted value
-  description: Data is formatted by the specified string rather than by a format string given in
+  description:
+    Data is formatted by the specified string rather than by a format string given in
     the telemetry definition files. The white portion of the box darkens to gray
     while the value remains stagnant, then brightens to white each time the value
     changes. Additionally the value is colored based on the items limits state
@@ -615,7 +596,8 @@ LABELVALUERANGEBAR:
 #       values: .*
 LED:
   summary: Displays a LED which changes color based on telemetry values
-  description: By default TRUE is green and FALSE is red and all other values are black.
+  description:
+    By default TRUE is green and FALSE is red and all other values are black.
     Additional values can be added by using the LED_COLOR setting. For example
     LED INST PARAMS VALUE3 RAW can be followed by SETTING LED_COLOR 0 GREEN,
     SETTING LED_COLOR 1 RED, and SETTING LED_COLOR ANY ORANGE.
@@ -1153,7 +1135,8 @@ TEXTBOX:
 #       values: .*
 VALUE:
   summary: Displays a box with a telemetry item value
-  description: The white portion of the box darkens to gray while the value remains stagnant, then
+  description:
+    The white portion of the box darkens to gray while the value remains stagnant, then
     brightens to white each time the value changes. Additionally the value is
     colored based on the items limits state (Red for example if it is out of limits).
   parameters:

data/lib/openc3/core_ext/string.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/binary_accessor'
@@ -28,7 +28,7 @@ class String
   # The printable range of ASCII characters
   PRINTABLE_RANGE = 32..126
   # Regular expression to identify a character that is not in the printable range
-  NON_PRINTABLE_REGEX = /[^\s -~]/
+  NON_PRINTABLE_REGEX = /[^\s!-~]/
   # Regular expression to identify a String as a floating point number
   FLOAT_CHECK_REGEX = /\A\s*[-+]?\d*\.\d+\s*\z/
   # Regular expression to identify a String as a floating point number in

data/lib/openc3/io/json_rpc.rb

@@ -56,11 +56,15 @@ end
 
 class String
   NON_ASCII_PRINTABLE = /[^\x21-\x7e\s]/
-
+  NON_UTF8_PRINTABLE = /[\x00-\x08\x0E-\x1F\x7F]/
   def as_json(options = nil)
     as_utf8 = self.dup.force_encoding('UTF-8')
     if as_utf8.valid_encoding?
-      return as_utf8
+      if as_utf8 =~ NON_UTF8_PRINTABLE
+        return self.to_json_raw_object
+      else
+        return as_utf8
+      end
     else
       return self.to_json_raw_object
     end

data/lib/openc3/microservices/plugin_microservice.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/microservices/microservice'
@@ -31,6 +31,15 @@ module OpenC3
 
     def run
       Dir.chdir @work_dir
+      begin
+        if @config["cmd"][0] != 'ruby'
+          # Try to make sure the cmd is executable
+          FileUtils.chmod 0777, @config["cmd"][0]
+        end
+      rescue Exception
+        # Its ok if this fails
+      end
+
       # Fortify: Process Control
       # This is dangerous! However, plugins need to be able to run whatever they want.
       # Only admins can install plugins and they need to be vetted for content.

data/lib/openc3/models/cvt_model.rb

@@ -42,22 +42,24 @@ module OpenC3
 
     # Set an item in the current value table
     def self.set_item(target_name, packet_name, item_name, value, type:, scope: $openc3_scope)
+      hash = JSON.parse(Store.hget("#{scope}__tlm__#{target_name}", packet_name), :allow_nan => true, :create_additions => true)
       case type
       when :WITH_UNITS
-        field = "#{item_name}__U"
-        value = value.to_s # WITH_UNITS should always be a string
+        hash["#{item_name}__U"] = value.to_s # WITH_UNITS should always be a string
       when :FORMATTED
-        field = "#{item_name}__F"
-        value = value.to_s # FORMATTED should always be a string
+        hash["#{item_name}__F"] = value.to_s # FORMATTED should always be a string
       when :CONVERTED
-        field = "#{item_name}__C"
+        hash["#{item_name}__C"] = value
       when :RAW
-        field = item_name
+        hash[item_name] = value
+      when :ALL
+        hash["#{item_name}__U"] = value.to_s # WITH_UNITS should always be a string
+        hash["#{item_name}__F"] = value.to_s # FORMATTED should always be a string
+        hash["#{item_name}__C"] = value
+        hash[item_name] = value
       else
         raise "Unknown type '#{type}' for #{target_name} #{packet_name} #{item_name}"
       end
-      hash = JSON.parse(Store.hget("#{scope}__tlm__#{target_name}", packet_name), :allow_nan => true, :create_additions => true)
-      hash[field] = value
       Store.hset("#{scope}__tlm__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
     end
 

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-9,a-f,A-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

@@ -23,6 +23,7 @@
 require 'openc3/top_level'
 require 'openc3/models/model'
 require 'openc3/models/metric_model'
+require 'openc3/models/traefik_model'
 require 'openc3/utilities/bucket'
 
 module OpenC3
@@ -41,6 +42,7 @@ module OpenC3
     attr_accessor :ports
     attr_accessor :parent
     attr_accessor :secrets
+    attr_accessor :prefix
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -99,6 +101,7 @@ module OpenC3
       plugin: nil,
       needs_dependencies: false,
       secrets: [],
+      prefix: nil,
       scope:
     )
       parts = name.split("__")
@@ -122,6 +125,7 @@ module OpenC3
       @container = container
       @needs_dependencies = needs_dependencies
       @secrets = secrets
+      @prefix = prefix
       @bucket = Bucket.getClient()
     end
 
@@ -141,7 +145,8 @@ module OpenC3
         'updated_at' => @updated_at,
         'plugin' => @plugin,
         'needs_dependencies' => @needs_dependencies,
-        'secrets' => @secrets.as_json(*a)
+        'secrets' => @secrets.as_json(*a),
+        'prefix' => @prefix
       }
     end
 
@@ -190,6 +195,9 @@ module OpenC3
       when 'SECRET'
         parser.verify_num_parameters(3, 3, "#{keyword} <Secret Type: ENV or FILE> <Secret Name> <Environment Variable Name or File Path>")
         @secrets << parameters.dup
+      when 'ROUTE_PREFIX'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Route Prefix>")
+        @prefix = parameters[0]
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Microservice: #{keyword} #{parameters.join(" ")}")
       end
@@ -214,9 +222,12 @@ module OpenC3
         end
         unless validate_only
           @bucket.put_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: key, body: data)
-          ConfigTopic.write({ kind: 'created', type: 'microservice', name: @name, plugin: @plugin }, scope: @scope)
         end
       end
+      unless validate_only
+        TraefikModel.register_route(microservice_name: @name, port: @ports[0][0], prefix: @prefix) if @ports[0] and ports[0][0] and @prefix
+        ConfigTopic.write({ kind: 'created', type: 'microservice', name: @name, plugin: @plugin }, scope: @scope)
+      end
     end
 
     def undeploy
@@ -224,6 +235,7 @@ module OpenC3
       @bucket.list_objects(bucket: ENV['OPENC3_CONFIG_BUCKET'], prefix: prefix).each do |object|
         @bucket.delete_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: object.key)
       end
+      TraefikModel.unregister_route(microservice_name: @name, port: @ports[0][0], prefix: @prefix) if @ports[0] and ports[0][0] and @prefix
       ConfigTopic.write({ kind: 'deleted', type: 'microservice', name: @name, plugin: @plugin }, scope: @scope)
     rescue Exception => error
       Logger.error("Error undeploying microservice model #{@name} in scope #{@scope} due to #{error}")

data/lib/openc3/models/model.rb

@@ -63,20 +63,12 @@ module OpenC3
     # END NOTE
 
     # Loops over all items and returns objects that match a key value pair
-    def self.filter(key, value, scope:, use_regex: false)
+    def self.filter(key, value, scope:, substr: false)
       filtered = {}
       results = all(scope: scope)
-      regex = nil
-      regex = Regexp.new(value) if use_regex
       results.each do |name, result|
-        if regex
-          if result[key] =~ regex
-            filtered[name] = result
-          end
-        else
-          if result[key] == value
-            filtered[name] = result
-          end
+        if result[key] == value || (substr && result[key].include?(value))
+          filtered[name] = result
         end
       end
       return filtered

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-9,a-f,A-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/timeline_model.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/models/model'
@@ -91,11 +91,10 @@ module OpenC3
       if color.nil?
         color = '#%06x' % (rand * 0xffffff)
       end
-      valid_color = color =~ /(#*)([0-9,a-f,A-f]{6})/
+      valid_color = color =~ /[0-9,a-f,A-F]{6}/
       if valid_color.nil?
         raise RuntimeError.new "invalid color but in hex format. #FF0000"
       end
-
       unless color.start_with?('#')
         color = "##{color}"
       end

data/lib/openc3/models/traefik_model.rb

@@ -0,0 +1,47 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/utilities/store'
+
+module OpenC3
+  class TraefikModel
+    def self.register_route(microservice_name:, port:, prefix:, priority: 20)
+      prefix = '/' + prefix unless prefix[0] == '/'
+      if ENV['KUBERNETES_SERVICE_HOST']
+        url = "http://#{microservice_name.gsub('__', '-')}:#{port}"
+      else
+        url = "http://openc3-operator:#{port}"
+      end
+      service_name = microservice_name
+      router_name = microservice_name
+      Store.set("traefik/http/services/#{service_name}/loadbalancer/servers/0/url", url)
+      Store.set("traefik/http/routers/#{router_name}/service", service_name)
+      Store.set("traefik/http/routers/#{router_name}/priority", priority)
+      Store.set("traefik/http/routers/#{router_name}/rule", "PathPrefix(`#{prefix}`)")
+    end
+
+    def self.unregister_route(microservice_name:)
+      service_name = microservice_name
+      router_name = microservice_name
+      Store.del("traefik/http/routers/#{router_name}/rule")
+      Store.del("traefik/http/routers/#{router_name}/priority")
+      Store.del("traefik/http/routers/#{router_name}/service")
+      Store.del("traefik/http/services/#{service_name}/loadbalancer/servers/0/url")
+    end
+  end
+end

data/lib/openc3/models/trigger_group_model.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/models/model'
@@ -92,11 +92,10 @@ module OpenC3
       if color.nil?
         color = '#%06x' % (rand * 0xffffff)
       end
-      valid_color = color =~ /(#*)([0-9,a-f,A-f]{6})/
+      valid_color = color =~ /[0-9,a-f,A-F]{6}/
       if valid_color.nil?
         raise TriggerGroupInputError.new "invalid color must be in hex format. #FF0000"
       end
-
       unless color.start_with?('#')
         color = "##{color}"
       end

data/lib/openc3/script/storage.rb

@@ -65,7 +65,7 @@ module OpenC3
 
       endpoint = "/openc3-api/storage/upload/#{upload_path}"
       result = _get_presigned_request(endpoint, scope: scope)
-      OpenC3::Logger.info "Writing #{upload_path} at #{result['url']}"
+      OpenC3::Logger.info "Writing #{upload_path}"
 
       # Try to put the file
       begin
@@ -104,11 +104,12 @@ module OpenC3
           if part == "targets_modified" and ENV['OPENC3_LOCAL_MODE']
             local_file = OpenC3::LocalMode.open_local_file(path, scope: scope)
             if local_file
+              OpenC3::Logger.info "Reading local #{scope}/#{path}"
               file = Tempfile.new('target', binmode: true)
               file.write(local_file.read)
               local_file.close
               file.rewind
-              return file if local_file
+              return file
             end
           end
 
@@ -133,7 +134,7 @@ module OpenC3
 
       endpoint = "/openc3-api/storage/download/#{scope}/#{path}"
       result = _get_presigned_request(endpoint, scope: scope)
-      OpenC3::Logger.info "Reading #{scope}/#{path} at #{result['url']}"
+      OpenC3::Logger.info "Reading #{scope}/#{path}"
 
       # Try to get the file
       uri = _get_uri(result['url'])

data/lib/openc3/top_level.rb

@@ -461,22 +461,7 @@ module OpenC3
 
   # @param filename [String] Name of the file to open in the web browser
   def self.open_in_web_browser(filename)
-    if filename
-      if Kernel.is_windows?
-        self.run_process("cmd /c \"start \"\" \"#{filename.gsub('/', '\\')}\"\"")
-      elsif Kernel.is_mac?
-        self.run_process("open -a Safari \"#{filename}\"")
-      else
-        which_firefox = `which firefox`.chomp
-        if which_firefox =~ /Command not found/i or which_firefox =~ /no .* in/i
-          raise "Firefox not found"
-        else
-          system_call = "#{which_firefox} \"#{filename}\""
-        end
-
-        self.run_process(system_call)
-      end
-    end
+    puts "open_in_web_browser is DEPRECATED"
   end
 
   # Temporarily set the working directory during a block

data/lib/openc3/utilities/authorization.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/models/auth_model'
@@ -42,7 +42,9 @@ rescue LoadError
 
         if $openc3_authorize
           raise AuthError.new("Token is required") unless token
-          raise AuthError.new("Token is invalid for '#{permission}' permission") unless OpenC3::AuthModel.verify(token, permission: permission)
+          unless OpenC3::AuthModel.verify(token, permission: permission)
+            raise AuthError.new("Current role is invalid for '#{permission}' permission")
+          end
         end
       end
 

data/lib/openc3/utilities/aws_bucket.rb

@@ -119,6 +119,8 @@ module OpenC3
       end
       # Array of objects with key and size methods
       result
+    rescue Aws::S3::Errors::NoSuchBucket => error
+      raise NotFound, "Bucket '#{bucket}' does not exist."
     end
 
     # Lists the files under a specified path
@@ -164,6 +166,8 @@ module OpenC3
         token = resp.next_continuation_token
       end
       result
+    rescue Aws::S3::Errors::NoSuchBucket => error
+      raise NotFound, "Bucket '#{bucket}' does not exist."
     end
 
     # put_object fires off the request to store but does not confirm

data/lib/openc3/utilities/bucket.rb

@@ -21,6 +21,10 @@ ENV['OPENC3_CLOUD'] ||= 'local'
 # Interface class implemented by each cloud provider: AWS, GCS, Azure
 module OpenC3
   class Bucket
+    # Raised when the underlying bucket does not exist
+    class NotFound < RuntimeError
+    end
+
     def self.getClient
       raise 'OPENC3_CLOUD environment variable is required' unless ENV['OPENC3_CLOUD']
       # Base is AwsBucket which works with MINIO, Enterprise implements additional

data/lib/openc3/utilities/process_manager.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/operators/operator'
@@ -52,7 +52,7 @@ module OpenC3
 
   # Spawns short lived processes and ensures they complete
   class ProcessManager
-    MONITOR_CYCLE_SECONDS = 10
+    MONITOR_CYCLE_SECONDS = 5
     CLEANUP_CYCLE_SECONDS = 600
 
     @@instance = nil
@@ -68,6 +68,7 @@ module OpenC3
         begin
           monitor()
         rescue => err
+          Logger.error("ProcessManager unexpectedly died\n#{err.formatted}", scope: 'DEFAULT')
           raise "ProcessManager unexpectedly died\n#{err.formatted}"
         end
       end
@@ -111,10 +112,10 @@ module OpenC3
         end
         processes_to_delete.each do |process|
           if process.status.state == "Complete"
-            Logger.info "Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}"
+            Logger.info("Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}", scope: process.scope)
           else
-            Logger.error "Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}"
-            Logger.error "Process Output:\n#{process.status.output}"
+            Logger.error("Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}", scope: process.scope)
+            Logger.error("Process Output:\n#{process.status.output}", scope: process.scope)
           end
 
           @processes.delete(process)

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.4.2'
+OPENC3_VERSION = '5.4.3-beta0'
 module OpenC3
   module Version
     MAJOR = '5'
     MINOR = '4'
-    PATCH = '2'
-    OTHER = ''
-    BUILD = '6a7f2b4ff8e1255aa4d9768b539211b175cb9ec7'
+    PATCH = '3'
+    OTHER = 'pre.beta0'
+    BUILD = '3eeed1efa129ce27f14bffc2b6bab4428a20c500'
   end
-  VERSION = '5.4.2'
-  GEM_VERSION = '5.4.2'
+  VERSION = '5.4.3-beta0'
+  GEM_VERSION = '5.4.3.pre.beta0'
 end

data/lib/openc3.rb

@@ -22,6 +22,9 @@
 
 # This file sets up using the OpenC3 framework
 
+# Improve DNS (especially on Alpine)
+require 'resolv-replace'
+
 # Set default encodings
 saved_verbose = $VERBOSE; $VERBOSE = nil
 Encoding.default_external = Encoding::ASCII_8BIT

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.4.2
+  version: 5.4.3.pre.beta0
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-04 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -669,7 +669,6 @@ files:
 - data/config/_interfaces.yaml
 - data/config/_items.yaml
 - data/config/_params.yaml
-- data/config/cmd_tlm_server.yaml
 - data/config/command.yaml
 - data/config/command_modifiers.yaml
 - data/config/command_telemetry.yaml
@@ -872,6 +871,7 @@ files:
 - lib/openc3/models/timeline_model.rb
 - lib/openc3/models/tool_config_model.rb
 - lib/openc3/models/tool_model.rb
+- lib/openc3/models/traefik_model.rb
 - lib/openc3/models/trigger_group_model.rb
 - lib/openc3/models/trigger_model.rb
 - lib/openc3/models/widget_model.rb
@@ -925,7 +925,6 @@ files:
 - lib/openc3/system/system_config.rb
 - lib/openc3/system/target.rb
 - lib/openc3/tools/cmd_tlm_server/api.rb
-- lib/openc3/tools/cmd_tlm_server/cmd_tlm_server_config.rb
 - lib/openc3/tools/cmd_tlm_server/interface_thread.rb
 - lib/openc3/tools/table_manager/table.rb
 - lib/openc3/tools/table_manager/table_config.rb
@@ -1012,9 +1011,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.3.14
 signing_key:

data/data/config/cmd_tlm_server.yaml

@@ -1,136 +0,0 @@
----
-TITLE:
-  summary: Sets the Command and Telemetry Server window title
-  parameters:
-  - name: Text
-    required: true
-    description: Text to put in the title of the Command and Telemetry Server window
-    values: .+
-PACKET_LOG_WRITER:
-  summary: Declare a packet log writer
-  description: Packet log writer is used to declare a packet log writer class and
-    give it a name which can be referenced by an interface. This is required if you
-    want interfaces to have their own dedicated log writers or want to combine
-    various interfaces into a single log file. By default, OpenC3 logs all data
-    on all interfaces into a single command log and a single telemetry log.
-    This keyword can also be used if you want to declare a different log file class
-    to create log files.
-  warning: You should NOT override the default without consulting a OpenC3 expert
-    as this may break the ability to successfully read and write log files.
-  example: |
-    PACKET_LOG_WRITER DEFAULT packet_log_writer.rb # Default
-    # The default logger filename will be <DATE>_openc3tlm.bin and will create a new log every 1MB
-    PACKET_LOG_WRITER DEFAULT packet_log_writer.rb openc3 true nil 1000000
-    # Create a logger named OPENC3_LOG which creates a new log every 5 min (600s)
-    PACKET_LOG_WRITER OPENC3_LOG packet_log_writer.rb openc3 true 600
-  parameters:
-    - name: Log Writer Name
-      required: true
-      description: The name of the log writer as reference by other cmd_tlm_server keywords.
-        This name also appears in the Logging tab on the Command and Telemetry Server.
-      values: .+
-    - name: Filename
-      required: true
-      description: Ruby file to use when instantiating a new log writer
-      values: '.+\.rb'
-    - name: Parameters
-      required: false
-      description: Optional parameters to pass to the log writer class when instantiating it.
-AUTO_INTERFACE_TARGETS:
-  summary: Automatically use each target's cmd_tlm_server.txt file to define the interface
-  description: Look for a cmd_tlm_server.txt file at the top level
-    of each target directory and use this file to configure the interface for that target.
-    This is a good way of keeping the knowledge of how to interface to a target
-    within that target. However, if you use substitute target names (by using DECLARE_TARGET)
-    or use different IP addresses then this will not work and you'll have to use the
-    INTERFACE_TARGET or INTERFACE keyword.
-INTERFACE_TARGET:
-  summary: Load the specified target's cmd_tlm_server.txt configuration file
-  example: |
-    INTERFACE_TARGET OPENC3 # Look in the OPENC3 target directory for cmd_tlm_server.txt
-    INTERFACE_TARGET OPENC3 config.txt # Look in the OPENC3 target directory for config.txt
-  parameters:
-    - name: Target Name
-      required: true
-      description: Name of the target
-      values: .+
-    - name: Configuration File
-      required: false
-      description: Configuration filename which contains the interface configuration.
-        Defaults to 'cmd_tlm_server.txt'.
-      values: .+
-INTERFACE:
-  modifiers:
-    <%= MetaConfigParser.load('interface_modifiers.yaml').to_meta_config_yaml(4) %>
-  summary: Defines a connection to a physical target
-  description: Interfaces are what OpenC3 uses to talk to a particular piece
-    of hardware. Interfaces require a Ruby file which implements all the interface
-    methods necessary to talk to the hardware. OpenC3 defines many built in interfaces
-    or you can define your own as long as it implements the interface protocol.
-  parameters:
-    - name: Interface Name
-      required: true
-      description: Name of the interface. This name will appear in the
-        Interfaces tab of the Server and is also referenced by other keywords.
-        The OpenC3 convention is to name interfaces after their targets with
-        '_INT' appended to the name, e.g. INST_INT for the INST target.
-      values: \D\S*
-    - name: Filename
-      required: true
-      description: Ruby file to use when instantiating the interface.
-      values:
-        <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
-      documentation: Additional parameters are required. Please see the [Interfaces](/docs/v5/interfaces)
-        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 an interface which reverses cmd/tlm data
-  description: Router creates an interface which receives command packets from
-    their remote targets and send them out their interfaces. They receive telemetry
-    packets from their interfaces and send them to their remote targets. This allows
-    routers to be intermediaries between an external client and an actual device.
-  parameters:
-    - name: Name
-      required: true
-      description: Name of the router
-      values: .+
-    - name: Filename
-      required: true
-      description: Ruby file to use when instantiating the interface.
-      values:
-        <%= MetaConfigParser.load('_interfaces.yaml').to_meta_config_yaml(8) %>
-      documentation: Additional parameters are required. Please see the [Interfaces](/docs/v5/interfaces)
-        documentation for more details.
-COLLECT_METADATA:
-  summary: Prompts the user for meta data when starting the Command and Telemetry Server
-BACKGROUND_TASK:
-  modifiers:
-    STOPPED:
-      summary: Indicate the background task should not be automatically started
-  summary: Create a background task in the Command and Telemetry Server
-  description: The Server instantiates the class which must inherit from BackgroundTask
-    and then calls the call() method which the class must implement. The call() method
-    is only called once so if your background task is supposed to live on while the
-    Server is running, you must implement your code in a loop with a sleep to not
-    use all the CPU.
-  example: BACKGROUND_TASK example_background_task.rb
-  parameters:
-    - name: Filename
-      required: true
-      description: Ruby file which contains the background task implementation.
-        Must inherit from BackgroundTask and implement the call method.
-      values: '.+\.rb'
-    - name: Optional Arguments
-      required: false
-      description: Optional arguments to the background task constructor
-      values: .+

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

@@ -1,323 +0,0 @@
-# encoding: ascii-8bit
-
-# Copyright 2022 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU Affero General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Affero General Public License for more details.
-
-# Modified by OpenC3, Inc.
-# All changes Copyright 2022, 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/config/config_parser'
-
-module OpenC3
-  # Reads an ascii file that defines the configuration settings used to
-  # configure the Command/Telemetry Server.
-  class CmdTlmServerConfig
-    # @return [Hash<String, Interface>] Interfaces hash
-    attr_accessor :interfaces
-    # @return [Hash<String, Interface>] Routers hash
-    attr_accessor :routers
-    # @return [Hash<String, PacketLogWriterPair>] Packet log writer hash. Each
-    #   pair encapsulates a command and telemetry log writer.
-    attr_accessor :packet_log_writer_pairs
-    # @return [Array<BackgroundTask>] Array of background tasks
-    attr_accessor :background_tasks
-    # @return [String] Command and Telemetry Server title
-    attr_accessor :title
-    # @return [Boolean] Flag indicating if meta data should be collected
-    attr_accessor :metadata
-
-    # Create a default pair of packet log writers and parses the
-    # configuration file.
-    #
-    # @param filename [String] The name of the configuration file to parse
-    def initialize(filename, system_config)
-      @system_config = system_config
-      @interfaces = {}
-      @routers = {}
-      @packet_log_writer_pairs = {}
-      # cmd_log_writer = System.default_packet_log_writer.new(:CMD, *System.default_packet_log_writer_params)
-      # tlm_log_writer = System.default_packet_log_writer.new(:TLM, *System.default_packet_log_writer_params)
-      # @packet_log_writer_pairs['DEFAULT'] = PacketLogWriterPair.new(cmd_log_writer, tlm_log_writer)
-      @background_tasks = []
-      @title = nil
-      @metadata = false
-      process_file(filename)
-    end
-
-    protected
-
-    def get_target_interface_name(target_name)
-      @interfaces.each do |interface_name, interface|
-        return interface_name if interface.target_names.include?(target_name)
-      end
-      nil
-    end
-
-    def setup_interface_or_router
-      current_interface_or_router = OpenStruct.new
-      current_interface_or_router.interfaces = []
-      current_interface_or_router.routers = []
-      current_interface_or_router.target_names = []
-      current_interface_or_router
-    end
-
-    # 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)
-      current_interface_or_router = nil
-      current_type = nil
-      current_interface_log_added = false
-
-      Logger.info "Processing CmdTlmServer configuration in file: #{File.expand_path(filename)}"
-
-      parser = ConfigParser.new("https://openc3.com/docs/v5")
-      parser.parse_file(filename) do |keyword, params|
-        case keyword
-        when 'TITLE'
-          raise parser.error("#{keyword} not allowed in target #{filename}") if recursive
-
-          parser.verify_num_parameters(1, 1, "#{keyword} <Title Text>")
-          @title = params[0]
-
-        when 'PACKET_LOG_WRITER'
-          # usage = "PACKET_LOG_WRITER <Name> <Filename> <Specific Parameters>"
-          # parser.verify_num_parameters(2, nil, usage)
-          # packet_log_writer_name = params[0].upcase
-          # packet_log_writer_class = OpenC3.require_class(params[1])
-
-          # # Verify not overridding a packet log writer that is already associated with an interface
-          # packet_log_writer_pair = @packet_log_writer_pairs[packet_log_writer_name]
-          # if packet_log_writer_pair
-          #   @interfaces.each do |interface_name, interface|
-          #     if interface.packet_log_writer_pairs.include?(packet_log_writer_pair)
-          #       raise parser.error("Redefining Packet Log Writer #{packet_log_writer_name} not allowed after it is associated with an interface")
-          #     end
-          #   end
-          # end
-
-          # if params[2]
-          #   cmd_log_writer = packet_log_writer_class.new(:CMD, *params[2..-1])
-          #   tlm_log_writer = packet_log_writer_class.new(:TLM, *params[2..-1])
-          #   @packet_log_writer_pairs[packet_log_writer_name] = PacketLogWriterPair.new(cmd_log_writer, tlm_log_writer)
-          # else
-          #   cmd_log_writer = packet_log_writer_class.new(:CMD)
-          #   tlm_log_writer = packet_log_writer_class.new(:TLM)
-          #   @packet_log_writer_pairs[packet_log_writer_name] = PacketLogWriterPair.new(cmd_log_writer, tlm_log_writer)
-          # end
-
-        when 'AUTO_INTERFACE_TARGETS'
-          raise parser.error("#{keyword} not allowed in target #{filename}") if recursive
-
-          usage = "#{keyword}"
-          parser.verify_num_parameters(0, 0, usage)
-          @system_config.targets.each do |target_name, target|
-            target_filename = File.join(target.dir, 'cmd_tlm_server.txt')
-            if File.exist?(target_filename)
-              # Skip this target if it's already been assigned an interface
-              next if get_target_interface_name(target.name)
-              raise parser.error("Cannot use #{keyword} with target name substitutions: #{target.name} != #{target.original_name}") if target.name != target.original_name
-
-              process_file(target_filename, true)
-            end
-          end
-
-        when 'INTERFACE_TARGET'
-          raise parser.error("#{keyword} not allowed in target #{filename}") if recursive
-
-          usage = "#{keyword} <Target Name> <Config File (defaults to cmd_tlm_server.txt)>"
-          parser.verify_num_parameters(1, 2, usage)
-          target = @system_config.targets[params[0].upcase]
-          raise parser.error("Unknown target: #{params[0].upcase}") unless target
-
-          interface_name = get_target_interface_name(target.name)
-          raise parser.error("Target #{target.name} already mapped to interface #{interface_name}") if interface_name
-
-          target_filename = params[1]
-          target_filename = 'cmd_tlm_server.txt' unless target_filename
-          target_filename = File.join(target.dir, target_filename)
-          if File.exist?(target_filename)
-            process_file(target_filename, true)
-          else
-            raise parser.error("#{target_filename} does not exist")
-          end
-
-        when 'INTERFACE'
-          usage = "INTERFACE <Name> <Filename> <Specific Parameters>"
-          parser.verify_num_parameters(2, nil, usage)
-          interface_name = params[0].upcase
-          raise parser.error("Interface '#{interface_name}' defined twice") if @interfaces[interface_name]
-
-          # interface_class = OpenC3.require_class(params[1])
-          # if params[2]
-          #   current_interface_or_router = interface_class.new(*params[2..-1])
-          # else
-          #   current_interface_or_router = interface_class.new
-          # end
-          current_interface_or_router = setup_interface_or_router()
-          current_type = :INTERFACE
-          current_interface_log_added = false
-          # current_interface_or_router.packet_log_writer_pairs << @packet_log_writer_pairs['DEFAULT']
-          current_interface_or_router.name = interface_name
-          current_interface_or_router.config_params = params[1..-1]
-          @interfaces[interface_name] = current_interface_or_router
-
-        when 'LOG', 'LOG_STORED', 'DONT_LOG', 'TARGET'
-          raise parser.error("No current interface for #{keyword}") unless current_interface_or_router and current_type == :INTERFACE
-
-          case keyword
-
-          when 'LOG'
-            parser.verify_num_parameters(1, 1, "#{keyword} <Packet Log Writer Name>")
-            # packet_log_writer_pair = @packet_log_writer_pairs[params[0].upcase]
-            # raise parser.error("Unknown packet log writer: #{params[0].upcase}") unless packet_log_writer_pair
-            # current_interface_or_router.packet_log_writer_pairs.delete(@packet_log_writer_pairs['DEFAULT']) unless current_interface_log_added
-            current_interface_log_added = true
-            # current_interface_or_router.packet_log_writer_pairs << packet_log_writer_pair unless current_interface_or_router.packet_log_writer_pairs.include?(packet_log_writer_pair)
-
-          when 'LOG_STORED'
-            parser.verify_num_parameters(1, 1, "#{keyword} <Packet Log Writer Name>")
-            # packet_log_writer_pair = @packet_log_writer_pairs[params[0].upcase]
-            # raise parser.error("Unknown packet log writer: #{params[0].upcase}") unless packet_log_writer_pair
-            # current_interface_or_router.stored_packet_log_writer_pairs << packet_log_writer_pair unless current_interface_or_router.stored_packet_log_writer_pairs.include?(packet_log_writer_pair)
-
-          when 'DONT_LOG'
-            parser.verify_num_parameters(0, 0, "#{keyword}")
-            # current_interface_or_router.packet_log_writer_pairs = []
-
-          when 'TARGET'
-            parser.verify_num_parameters(1, 1, "#{keyword} <Target Name>")
-            target_name = params[0].upcase
-            target = @system_config.targets[target_name]
-            if target
-              interface_name = get_target_interface_name(target.name)
-              raise parser.error("Target #{target.name} already mapped to interface #{interface_name}") if interface_name
-
-              target.interface = current_interface_or_router
-              current_interface_or_router.target_names << target_name
-            else
-              raise parser.error("Unknown target #{target_name} mapped to interface #{current_interface_or_router.name}")
-            end
-
-          end # end case keyword for all keywords that require a current interface
-
-        when 'DONT_CONNECT', 'DONT_RECONNECT', 'RECONNECT_DELAY', 'DISABLE_DISCONNECT', 'LOG_RAW', 'OPTION', 'PROTOCOL'
-          raise parser.error("No current interface or router for #{keyword}") unless current_interface_or_router
-
-          case keyword
-
-          when 'DONT_CONNECT'
-            parser.verify_num_parameters(0, 0, "#{keyword}")
-            current_interface_or_router.connect_on_startup = false
-
-          when 'DONT_RECONNECT'
-            parser.verify_num_parameters(0, 0, "#{keyword}")
-            current_interface_or_router.auto_reconnect = false
-
-          when 'RECONNECT_DELAY'
-            parser.verify_num_parameters(1, 1, "#{keyword} <Delay in Seconds>")
-            current_interface_or_router.reconnect_delay = Float(params[0])
-
-          when 'DISABLE_DISCONNECT'
-            parser.verify_num_parameters(0, 0, "#{keyword}")
-            current_interface_or_router.disable_disconnect = true
-
-          when 'LOG_RAW',
-            parser.verify_num_parameters(0, nil, "#{keyword} <Raw Logger Class File (optional)> <Raw Logger Parameters (optional)>")
-            # current_interface_or_router.raw_logger_pair = RawLoggerPair.new(current_interface_or_router.name, params)
-            # current_interface_or_router.start_raw_logging
-
-          when 'OPTION'
-            parser.verify_num_parameters(2, nil, "#{keyword} <Option Name> <Option Value 1> <Option Value 2 (optional)> <etc>")
-            # current_interface_or_router.set_option(params[0], params[1..-1])
-
-          when 'PROTOCOL'
-            usage = "#{keyword} <READ WRITE READ_WRITE> <protocol filename or classname> <Protocol specific parameters>"
-            parser.verify_num_parameters(2, nil, usage)
-            unless %w(READ WRITE READ_WRITE).include? params[0].upcase
-              raise parser.error("Invalid protocol type: #{params[0]}", usage)
-            end
-
-            begin
-              # klass = OpenC3.require_class(params[1])
-              # current_interface_or_router.add_protocol(klass, params[2..-1], params[0].upcase.intern)
-            rescue LoadError, StandardError => error
-              raise parser.error(error.message, usage)
-            end
-
-          end # end case keyword for all keywords that require a current interface or router
-
-        when 'ROUTER'
-          usage = "ROUTER <Name> <Filename> <Specific Parameters>"
-          parser.verify_num_parameters(2, nil, usage)
-          router_name = params[0].upcase
-          raise parser.error("Router '#{router_name}' defined twice") if @routers[router_name]
-
-          # router_class = OpenC3.require_class(params[1])
-          # if params[2]
-          #  current_interface_or_router = router_class.new(*params[2..-1])
-          # else
-          #  current_interface_or_router = router_class.new
-          # end
-          current_interface_or_router = setup_interface_or_router()
-          current_type = :ROUTER
-          current_interface_or_router.name = router_name
-          @routers[router_name] = current_interface_or_router
-
-        when 'ROUTE'
-          raise parser.error("No current router for #{keyword}") unless current_interface_or_router and current_type == :ROUTER
-
-          usage = "ROUTE <Interface Name>"
-          parser.verify_num_parameters(1, 1, usage)
-          interface_name = params[0].upcase
-          interface = @interfaces[interface_name]
-          raise parser.error("Unknown interface #{interface_name} mapped to router #{current_interface_or_router.name}") unless interface
-
-          unless current_interface_or_router.interfaces.include? interface
-            current_interface_or_router.interfaces << interface
-            interface.routers << current_interface_or_router
-          end
-
-        when 'BACKGROUND_TASK'
-          usage = "#{keyword} <Filename> <Specific Parameters>"
-          parser.verify_num_parameters(1, nil, usage)
-          # background_task = OpenC3.require_class(params[0])
-          if params[1]
-            @background_tasks << params
-          else
-            @background_tasks << params
-          end
-
-        when 'STOPPED'
-          parser.verify_num_parameters(0, 0, "#{keyword}")
-          raise parser.error("No BACKGROUND_TASK defined") if @background_tasks.empty?
-          # @background_tasks[-1].stopped = true
-
-        when 'COLLECT_METADATA'
-          parser.verify_num_parameters(0, 0, "#{keyword}")
-          @metadata = true
-
-        else
-          # blank lines will have a nil keyword and should not raise an exception
-          raise parser.error("Unknown keyword: #{keyword}") unless keyword.nil?
-        end # case
-      end  # loop
-    end
-  end
-end