openc3 5.15.2 → 5.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a39dab08bb9810376520e75a7bf3a6c63d30ad54b93566b82a849d780693a366
-  data.tar.gz: 65d282829dba0706cbe0e32603e51ad8ab3dfc0fdaf37d9bd400787bb7a1cb03
+  metadata.gz: af3e74fa7b78038906c1b2120e62aa7a9b3d835effe03dbd96e500d737a443cb
+  data.tar.gz: 8bba305bdd1ac061300aa8676564c0966cf01d68df8da86adfc5bf05d873165f
 SHA512:
-  metadata.gz: 12bffefe104e90e159c16bcc54ab53745e86a97bfb762c7e0e25141d6bd3c91ad6bb8827017d915dfb459b2fc69ea7365c97e7fa22236abb16ff0d73d8d485d7
-  data.tar.gz: b2efa2780f97e2aa3392cc483534d949be4fb27032dbc3e52015ebfa89da08d234e5777c50dbfa09e477357d3b5ca67aba847f8f5d723676d2331da84e880f7f
+  metadata.gz: '09554021246cc00fca2b1f32e627274eca5ff5ea6fa5851175e2b86cba6b9ff07ef5a05e4cc13a40ee6239793d74557d956384b8fb25acf267721b21208c2fa1'
+  data.tar.gz: 6db1a30df9c512df371b69240649947fd40ec78409d94bf7ff466096180c4ebf39958d2247b15e8b50e5a84b4fa066e461e38bad5fa8cc0bc1f7d4b8982112ab

data/Gemfile

@@ -8,7 +8,7 @@ gemspec :name => 'openc3'
 
 # Include the rails gems for the convenience of custom microservice plugins
 gem 'bootsnap', '>= 1.9.3', require: false
-gem 'mock_redis', '0.41'
+gem 'mock_redis', '0.44'
 gem 'rack-cors', '~> 2.0'
 gem 'rails', '~> 7.1.0'
 gem 'rspec-rails', '~> 6.0'

data/Rakefile

@@ -53,6 +53,7 @@ task :build => [:devkit] do
     shared_extension = 'bundle' if /darwin/.match?(platform)
 
     extensions = [
+      'burst_protocol',
       'crc',
       'polynomial_conversion',
       'config_parser',

data/bin/openc3cli

@@ -66,6 +66,7 @@ def print_usage
   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 list <SCOPE>                  # Lists installed plugins, SCOPE is DEFAULT if not given"
   puts "  cli generate TYPE OPTIONS         # Generate various COSMOS entities"
   puts "    OPTIONS: --ruby or --python to specify the language in the generated code"
   puts "  #{MIGRATE_PARSER}"
@@ -381,6 +382,22 @@ def wait_process_complete(process_name)
   end
 end
 
+# Outputs list of installed plugins
+def list_plugins(scope:)
+  scope ||= 'DEFAULT'
+  check_environment()
+  names = []
+  if $openc3_in_cluster
+    names = OpenC3::PluginModel.names(scope: scope)
+  else
+    require 'openc3/script'
+    names = plugin_list(scope: scope)
+  end
+  names.each do |name|
+    puts name
+  end
+end
+
 # Loads a plugin into the OpenC3 system
 # This code is used from the command line and is the same code that gets called if you
 # edit/upgrade or install a new plugin from the Admin interface
@@ -655,6 +672,9 @@ if not ARGV[0].nil? # argument(s) given
     # See plugins_controller.rb install for usage
     load_plugin(ARGV[1], scope: ARGV[2], plugin_hash_file: ARGV[3], force: ARGV[4] == 'force')
 
+  when 'list'
+    list_plugins(scope: ARGV[1])
+
   when 'unload'
     unload_plugin(ARGV[1], scope: ARGV[2])
 

data/bin/pipinstall

@@ -6,4 +6,7 @@ if [ $? -eq 0 ]; then
 else
     echo "Command failed - retrying with --no-index"
     pip install --no-index "$@"
+    if [ $? -eq 0 ]; then
+        echo "ERROR: pip install failed"
+    fi
 fi

data/data/config/interface_modifiers.yaml

@@ -127,7 +127,7 @@ OPTION:
         The option to set. OpenC3 defines several options on the core provided
         interfaces. The SerialInterface defines FLOW_CONTROL which can be NONE (default) or RTSCTS
         and DATA_BITS which changes the data bits of the serial interface.
-        The TcpipServerInterface defines LISTEN_ADDRESS which is the IP address to accept
+        The TcpipServerInterface and HttpServerInterface define LISTEN_ADDRESS which is the IP address to accept
         connections on (default 0.0.0.0).
       values: .*
     - name: Parameters
@@ -138,6 +138,9 @@ OPTION:
     INTERFACE SERIAL_INT serial_interface.rb COM1 COM1 115200 NONE 1 10.0 nil
       OPTION FLOW_CONTROL RTSCTS
       OPTION DATA_BITS 8
+    ROUTER SERIAL_ROUTER tcpip_server_interface.rb 2950 2950 10.0 nil BURST
+      ROUTE SERIAL_INT
+      OPTION LISTEN_ADDRESS 127.0.0.1
 SECRET:
   summary: Define a secret needed by this interface
   description: Defines a secret for this interface and optionally assigns its value to an option

data/data/config/telemetry_modifiers.yaml

@@ -170,4 +170,9 @@ ACCESSOR:
       required: true
       description: The name of the accessor class
       values: .+
-  since: 5.0.10
+  since: 5.0.10
+IGNORE_OVERLAP:
+  summary: Ignores any packet items which overlap
+  description: Packet items which overlap normally generate a warning unless each individual item has the OVERLAP keyword.
+    This ignores overlaps across the entire packet.
+  since: 5.15.3

data/ext/openc3/ext/burst_protocol/burst_protocol.c

@@ -0,0 +1,317 @@
+/*
+# Copyright 2024 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.
+*/
+
+#include "ruby.h"
+#include "stdio.h"
+
+static VALUE mOpenC3 = Qnil;
+static VALUE cProtocol = Qnil;
+static VALUE cBurstProtocol = Qnil;
+
+static ID id_method_handle_sync_pattern = 0;
+static ID id_method_reduce_to_single_packet = 0;
+static ID id_method_replace = 0;
+static ID id_method_clone = 0;
+static ID id_method_log_discard = 0;
+
+static ID id_ivar_data = 0;
+static ID id_ivar_extra = 0;
+static ID id_ivar_sync_pattern = 0;
+static ID id_ivar_sync_state = 0;
+static ID id_ivar_discard_leading_bytes = 0;
+
+static VALUE symbol_RESYNC = Qnil;
+static VALUE symbol_SEARCHING = Qnil;
+static VALUE symbol_DISCONNECT = Qnil;
+static VALUE symbol_STOP = Qnil;
+static VALUE symbol_FOUND = Qnil;
+
+/* Reads from the interface. It can look for a sync pattern before
+ * creating a Packet. It can discard a set number of bytes at the beginning
+ * before creating the Packet.
+ *
+ * Note: On the first call to this from any interface read(), data will contain a blank
+ * string. Blank string is an opportunity for protocols to return any queued up packets.
+ * If they have no queued up packets, they should pass the blank string down to chained
+ * protocols giving them the same opportunity.
+ *
+ * @return [String|nil] Data for a packet consisting of the bytes read */
+static VALUE burst_protocol_read_data(int argc, VALUE *argv, VALUE self)
+{
+  /* Arguments */
+  volatile VALUE data = Qnil;
+  volatile VALUE extra = Qnil;
+
+  /* Internal variables */
+  volatile VALUE result = Qnil;
+  volatile VALUE control = Qnil;
+  volatile VALUE packet_data = Qnil;
+  volatile VALUE super_args[3] = {Qnil, Qnil, Qnil};
+
+  long discard_leading_bytes = 0;
+
+  switch (argc)
+  {
+  case 1:
+    data = argv[0];
+    break;
+  case 2:
+    data = argv[0];
+    extra = argv[1];
+    break;
+  default:
+    /* Invalid number of arguments given */
+    rb_raise(rb_eArgError, "wrong number of arguments (%d for 1..2)", argc);
+    break;
+  };
+
+  rb_str_concat(rb_ivar_get(self, id_ivar_data), data);
+  rb_ivar_set(self, id_ivar_extra, extra);
+
+  while (1)
+  {
+    control = rb_funcall(self, id_method_handle_sync_pattern, 0);
+    /* Only return here if not blank string test */
+    if (RTEST(control) && (RSTRING_LEN(data) > 0))
+    {
+      return control;
+    }
+
+    /* Reduce the data to a single packet  */
+    result = rb_funcall(self, id_method_reduce_to_single_packet, 0);
+    if (RB_TYPE_P(result, T_ARRAY))
+    {
+      if (RARRAY_LEN(result) > 0)
+      {
+        packet_data = rb_ary_entry(result, 0);
+        if (RARRAY_LEN(result) > 1)
+        {
+          extra = rb_ary_entry(result, 1);
+        }
+        else
+        {
+          extra = Qnil;
+        }
+      }
+      else
+      {
+        packet_data = Qnil;
+        extra = Qnil;
+      }
+    }
+    else
+    {
+      packet_data = result;
+      extra = Qnil;
+    }
+    if (packet_data == symbol_RESYNC)
+    {
+      rb_ivar_set(self, id_ivar_sync_state, symbol_SEARCHING);
+
+      /* Only immediately resync if not blank string test */
+      if (RSTRING_LEN(data) > 0)
+      {
+        continue;
+      }
+    }
+
+    /* Potentially allow blank string to be sent to other protocols if no packet is ready in this one */
+    if (SYMBOL_P(packet_data))
+    {
+      if ((RSTRING_LEN(data) <= 0) && (packet_data != symbol_DISCONNECT))
+      {
+        /* On blank string test, return blank string (unless we had a packet or need disconnect)
+         * The base class handles the special case of returning STOP if on the last protocol in the
+         * chain */
+        super_args[0] = data;
+        super_args[1] = extra;
+        return rb_call_super(2, (VALUE *)super_args);
+      }
+      else
+      {
+        /* Return any control code if not on blank string test */
+        result = rb_ary_new();
+        rb_ary_push(result, packet_data);
+        rb_ary_push(result, extra);
+        return result;
+      }
+    }
+
+    rb_ivar_set(self, id_ivar_sync_state, symbol_SEARCHING);
+
+    /* Discard leading bytes if necessary */
+    if (FIX2INT(rb_ivar_get(self, id_ivar_discard_leading_bytes)) > 0)
+    {
+      discard_leading_bytes = FIX2INT(rb_ivar_get(self, id_ivar_discard_leading_bytes));
+      rb_str_replace(packet_data, rb_str_substr(packet_data, discard_leading_bytes, RSTRING_LEN(packet_data) - discard_leading_bytes));
+    }
+
+    result = rb_ary_new();
+    rb_ary_push(result, packet_data);
+    rb_ary_push(result, extra);
+    return result;
+  }
+}
+
+/* @return [Boolean] control code (nil, :STOP) */
+static VALUE burst_protocol_handle_sync_pattern(VALUE self)
+{
+  volatile VALUE sync_pattern = rb_ivar_get(self, id_ivar_sync_pattern);
+  volatile VALUE data = Qnil;
+  long sync_index = -1;
+  char *char_data = NULL;
+  char *char_sync_pattern = NULL;
+  long data_length = 0;
+  long sync_pattern_length = 0;
+  long i = 0;
+  long index = 0;
+  int found = 0;
+
+  if (RTEST(sync_pattern) && (rb_ivar_get(self, id_ivar_sync_state) == symbol_SEARCHING))
+  {
+    data = rb_ivar_get(self, id_ivar_data);
+    char_sync_pattern = RSTRING_PTR(sync_pattern);
+
+    while (1)
+    {
+      data_length = RSTRING_LEN(data);
+      sync_pattern_length = RSTRING_LEN(sync_pattern);
+
+      /* Make sure we have some data to look for a sync word in */
+      if (data_length < sync_pattern_length)
+      {
+        return symbol_STOP;
+      }
+
+      /* Find the beginning of the sync pattern */
+      sync_index = -1;
+      char_data = RSTRING_PTR(data);
+      for (i = 0; i < data_length; i++)
+      {
+        if (char_data[i] == char_sync_pattern[0])
+        {
+          sync_index = i;
+          break;
+        }
+      }
+
+      if (sync_index != -1)
+      {
+        /* Make sure we have enough data for the whole sync pattern past this index */
+        if (data_length < (sync_index + sync_pattern_length))
+        {
+          return symbol_STOP;
+        }
+
+        /* Check for the rest of the sync pattern */
+        found = 1;
+        index = sync_index;
+        for (i = 0; i < sync_pattern_length; i++)
+        {
+          if (char_data[index] != char_sync_pattern[i])
+          {
+            found = 0;
+            break;
+          }
+          index += 1;
+        }
+
+        if (found)
+        {
+          if (sync_index != 0)
+          {
+            rb_funcall(self, id_method_log_discard, 2, INT2FIX(sync_index), Qtrue);
+            /* Delete Data Before Sync Pattern */
+            rb_str_replace(data, rb_str_substr(data, sync_index, RSTRING_LEN(data) - sync_index));
+          }
+          rb_ivar_set(self, id_ivar_sync_state, symbol_FOUND);
+          return Qnil;
+        }
+        else
+        {
+          rb_funcall(self, id_method_log_discard, 2, INT2FIX(sync_index + 1), Qfalse);
+          /* Delete Data Before and including first character of suspected sync Pattern */
+          rb_str_replace(data, rb_str_substr(data, sync_index + 1, RSTRING_LEN(data) - sync_index - 1));
+          continue;
+        } /* if found */
+      }
+      else
+      {
+        rb_funcall(self, id_method_log_discard, 2, INT2FIX(data_length), Qfalse);
+        rb_str_replace(data, rb_str_new2(""));
+        return symbol_STOP;
+      }
+    } /* end loop */
+  }   /* if @sync_pattern */
+
+  return Qnil;
+}
+
+static VALUE burst_protocol_reduce_to_single_packet(VALUE self)
+{
+  volatile VALUE result = Qnil;
+  volatile VALUE packet_data = Qnil;
+  volatile VALUE data = rb_ivar_get(self, id_ivar_data);
+
+  if (RSTRING_LEN(data) <= 0)
+  {
+    /* Need some data */
+    return symbol_STOP;
+  }
+
+  /* Reduce to packet data and clear data for next packet */
+  packet_data = rb_funcall(data, id_method_clone, 0);
+  rb_str_replace(data, rb_str_new2(""));
+
+  result = rb_ary_new();
+  rb_ary_push(result, packet_data);
+  rb_ary_push(result, rb_ivar_get(self, id_ivar_extra));
+  return result;
+}
+
+/*
+ * Initialize all BurstProtocol methods
+ */
+void Init_burst_protocol(void)
+{
+  mOpenC3 = rb_define_module("OpenC3");
+
+  symbol_RESYNC = ID2SYM(rb_intern("RESYNC"));
+  symbol_SEARCHING = ID2SYM(rb_intern("SEARCHING"));
+  symbol_DISCONNECT = ID2SYM(rb_intern("DISCONNECT"));
+  symbol_STOP = ID2SYM(rb_intern("STOP"));
+  symbol_FOUND = ID2SYM(rb_intern("FOUND"));
+
+  id_method_handle_sync_pattern = rb_intern("handle_sync_pattern");
+  id_method_reduce_to_single_packet = rb_intern("reduce_to_single_packet");
+  id_method_replace = rb_intern("replace");
+  id_method_clone = rb_intern("clone");
+  id_method_log_discard = rb_intern("log_discard");
+
+  id_ivar_data = rb_intern("@data");
+  id_ivar_extra = rb_intern("@extra");
+  id_ivar_sync_pattern = rb_intern("@sync_pattern");
+  id_ivar_sync_state = rb_intern("@sync_state");
+  id_ivar_discard_leading_bytes = rb_intern("@discard_leading_bytes");
+
+  cProtocol = rb_define_class_under(mOpenC3, "Protocol", rb_cObject);
+  cBurstProtocol = rb_define_class_under(mOpenC3, "BurstProtocol", cProtocol);
+  rb_define_method(cBurstProtocol, "read_data", burst_protocol_read_data, -1);
+  rb_define_method(cBurstProtocol, "reduce_to_single_packet", burst_protocol_reduce_to_single_packet, 0);
+  rb_define_method(cBurstProtocol, "handle_sync_pattern", burst_protocol_handle_sync_pattern, 0);
+}

data/ext/openc3/ext/burst_protocol/extconf.rb

@@ -0,0 +1,13 @@
+require 'mkmf'
+
+unless $CFLAGS.gsub!(/ -O[\dsz]?/, ' -O3')
+  $CFLAGS << ' -O3'
+end
+if /gcc/.match?(CONFIG['CC'])
+  $CFLAGS << ' -Wall'
+  if $DEBUG && !$CFLAGS.gsub!(/ -O[\dsz]?/, ' -O0 -ggdb')
+    $CFLAGS << ' -O0 -ggdb'
+  end
+end
+
+create_makefile 'openc3/ext/burst_protocol'

data/lib/openc3/accessors/accessor.rb

@@ -105,7 +105,7 @@ module OpenC3
 
     def self.convert_to_type(value, item)
       case item.data_type
-      when :OBJECT
+      when :OBJECT, :ARRAY
         # Do nothing for complex object types
       when :STRING, :BLOCK
         if item.array_size

data/lib/openc3/api/tlm_api.rb

@@ -458,7 +458,7 @@ module OpenC3
         raise "ERROR: Invalid number of arguments (#{args.length}) passed to #{method_name}()"
       end
       if target_name.nil? or packet_name.nil? or item_name.nil?
-        raise "ERROR: Target name, packet name, and item name are required. Usage: #{method_name}(\"TGT PKT ITEM\") or #{method_name}(\"TGT\", \"PKT\", \"ITEM\")"
+        raise "ERROR: Target name, packet name and item name are required. Usage: #{method_name}(\"TGT PKT ITEM\") or #{method_name}(\"TGT\", \"PKT\", \"ITEM\")"
       end
       return [target_name, packet_name, item_name]
     end

data/lib/openc3/interfaces/http_client_interface.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
@@ -34,10 +34,10 @@ module OpenC3
       @hostname = hostname
       @port = Integer(port)
       @protocol = protocol
-      if (port == 80 and protocol == 'http') or (port == 443 and protocol == 'https')
-        @url = "#{protocol}://#{hostname}"
+      if (@port == 80 and @protocol == 'http') or (@port == 443 and @protocol == 'https')
+        @url = "#{@protocol}://#{@hostname}"
       else
-        @url = "#{protocol}://#{hostname}:#{port}"
+        @url = "#{@protocol}://#{@hostname}:#{@port}"
       end
       @write_timeout = ConfigParser.handle_nil(write_timeout)
       @write_timeout = Float(@write_timeout) if @write_timeout
@@ -50,6 +50,10 @@ module OpenC3
       @response_queue = Queue.new
     end
 
+    def connection_string
+      return @url
+    end
+
     # Connects the interface to its target(s)
     def connect
       # Per https://github.com/lostisland/faraday/blob/main/lib/faraday/options/env.rb

data/lib/openc3/interfaces/http_server_interface.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
@@ -26,14 +26,30 @@ module OpenC3
     # @param port [Integer] HTTP port
     def initialize(port = 80)
       super()
+      @listen_address = '0.0.0.0' # Default to ANY
       @port = Integer(port)
       @server = nil
       @request_queue = Queue.new
     end
 
+    # Supported Options
+    # LISTEN_ADDRESS - Ip address of the interface to accept connections on
+    # (see Interface#set_option)
+    def set_option(option_name, option_values)
+      super(option_name, option_values)
+      case option_name.upcase
+      when 'LISTEN_ADDRESS'
+        @listen_address = option_values[0]
+      end
+    end
+
+    def connection_string
+      return "listening on #{@listen_address}:#{@port}"
+    end
+
     # Connects the interface to its target(s)
     def connect
-      @server = WEBrick::HTTPServer.new :Port => @port
+      @server = WEBrick::HTTPServer.new(:BindAddress => @listen_address, :Port => @port)
       @request_queue = Queue.new
 
       # Create a response hook for every command packet
@@ -43,9 +59,9 @@ module OpenC3
           path = nil
           begin
             path = packet.read('HTTP_PATH')
-          rescue => err
+          rescue => e
             # No HTTP_PATH is an error
-            Logger.error("HttpServerInterface Packet #{target_name} #{packet_name} unable to read HTTP_PATH\n#{err.formatted}")
+            Logger.error("HttpServerInterface Packet #{target_name} #{packet_name} unable to read HTTP_PATH\n#{e.formatted}")
           end
           if path
             @server.mount_proc path do |req, res|
@@ -145,7 +161,7 @@ module OpenC3
 
     # Writes to the socket
     # @param data [Hash] For the HTTP Interface, data is a hash with the needed request info
-    def write_interface(data, extra = nil)
+    def write_interface(_data, _extra = nil)
       raise "Commands cannot be sent to HttpServerInterface"
     end
 
@@ -176,7 +192,7 @@ module OpenC3
     #
     # @param packet [Packet] Packet to extract data from
     # @return data
-    def convert_packet_to_data(packet)
+    def convert_packet_to_data(_packet)
       raise "Commands cannot be sent to HttpServerInterface"
     end
   end

data/lib/openc3/interfaces/interface.rb

@@ -184,6 +184,12 @@ module OpenC3
       @scheduler = nil
     end
 
+    # Should be implemented by subclass to return human readable connection string
+    # which will be placed in log messages when connecting and during connection failures
+    def connection_string
+      return @name
+    end
+
     # Connects the interface to its target(s). Must be implemented by a
     # subclass.
     def connect

data/lib/openc3/interfaces/linc_interface.rb

@@ -17,13 +17,15 @@
 # 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/interfaces/tcpip_client_interface'
 require 'uuidtools'
 
 module OpenC3
+  # TODO: Deprecated ... Will remove in next major version of COSMOS (COSMOS 6)
+
   # Interface for connecting to Ball Aerospace LINC Labview targets
   class LincInterface < TcpipClientInterface
     # The maximum number of asynchronous commands we can wait for at a time.
@@ -241,7 +243,7 @@ module OpenC3
       end
 
       process_handshake_results(handshake_cmd)
-    rescue Exception => err
+    rescue Exception => e
       # If anything goes wrong after successfully writing the packet to the LINC target
       # ensure that the packet gets updated in the CVT and logged to the packet log writer.
       # OpenC3 normally only does this if write returns successfully
@@ -256,7 +258,7 @@ module OpenC3
         packet_log_writer_pair.cmd_log_writer.write(packet)
       end
 
-      raise err
+      raise e
     end
 
     def process_handshake_results(handshake_cmd)

data/lib/openc3/interfaces/mqtt_interface.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2022 OpenC3, Inc.
+# Copyright 2024 OpenC3, Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -108,8 +108,8 @@ module OpenC3
 
       # Build list of packets by topic
       @read_packets_by_topic = {}
-      System.telemetry.all.each do |target_name, target_packets|
-        target_packets.each do |packet_name, packet|
+      System.telemetry.all.each do |_target_name, target_packets|
+        target_packets.each do |_packet_name, packet|
           topics = packet.meta['TOPIC']
           topics = packet.meta['TOPICS'] unless topics
           if topics
@@ -121,6 +121,10 @@ module OpenC3
       end
     end
 
+    def connection_string
+      return "#{@hostname}:#{@port} (ssl: #{@ssl})"
+    end
+
     # Connects the interface to its target(s)
     def connect
       @write_topics = []

data/lib/openc3/interfaces/mqtt_stream_interface.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
@@ -38,6 +38,13 @@ module OpenC3
       @ca_file = nil
     end
 
+    def connection_string
+      result = "#{@hostname}:#{@port} (ssl: #{@ssl})"
+      result += " write topic: #{@write_topic}" if @write_topic
+      result += " read topic: #{@read_topic}" if @read_topic
+      return result
+    end
+
     # Creates a new {SerialStream} using the parameters passed in the constructor
     def connect
       @stream = MqttStream.new(@hostname, @port, @ssl, @write_topic, @read_topic)