openc3 6.8.1 → 6.9.0

data/lib/openc3/interfaces/interface.rb

@@ -51,6 +51,14 @@ module OpenC3
     # @return [Array<String>] Array of tlm target names associated with this interface
     attr_accessor :tlm_target_names
 
+    # @return [Hash<String, Boolean>] Hash of enabled state for each cmd_target
+    # Disabled cmd targets will ignore all commands sent to the interface microservice for that target
+    attr_accessor :cmd_target_enabled
+
+    # @return [Hash<String, Boolean>] Array of tlm target names associated with this interface
+    # Disabled tlm targets will not output telemetry from the interface microservice for that target
+    attr_accessor :tlm_target_enabled
+
     # @return [Boolean] Flag indicating if the interface should be connected
     #   to on startup
     attr_accessor :connect_on_startup
@@ -66,23 +74,13 @@ module OpenC3
     #   this interface
     attr_accessor :disable_disconnect
 
-    # @return [Array] Array of packet logger classes for this interface
-    attr_accessor :packet_log_writer_pairs
-
-    # @return [Array] Array of stored packet log writers
-    attr_accessor :stored_packet_log_writer_pairs
-
     # @return [StreamLogPair] StreamLogPair instance or nil
     attr_accessor :stream_log_pair
 
     # @return [Array<Routers>] Array of routers that receive packets
-    #   read from the interface
+    #   read from the interface (used by Bridge)
     attr_accessor :routers
 
-    # @return [Array<Routers>] Array of cmd routers that mirror packets
-    #   sent from the interface
-    attr_accessor :cmd_routers
-
     # @return [Integer] The number of packets read from this interface
     attr_accessor :read_count
 
@@ -119,6 +117,9 @@ module OpenC3
     # @return [Array<[Protocol Class, Protocol Args, Protocol kind (:READ, :WRITE, :READ_WRITE)>] Info to recreate protocols
     attr_accessor :protocol_info
 
+    # @return [Boolean] Whether to save raw data in the interface and protocols
+    attr_accessor :save_raw_data
+
     # @return [String] Most recently read raw data
     attr_accessor :read_raw_data
 
@@ -151,14 +152,14 @@ module OpenC3
       @target_names = []
       @cmd_target_names = []
       @tlm_target_names = []
+      @cmd_target_enabled = {}
+      @tlm_target_enabled = {}
       @connect_on_startup = true
       @auto_reconnect = true
       @reconnect_delay = 5.0
       @disable_disconnect = false
-      @packet_log_writer_pairs = []
-      @stored_packet_log_writer_pairs = []
+      @stream_log_pair = nil
       @routers = []
-      @cmd_routers = []
       @read_count = 0
       @write_count = 0
       @bytes_read = 0
@@ -174,6 +175,7 @@ module OpenC3
       @read_protocols = []
       @write_protocols = []
       @protocol_info = []
+      @save_raw_data = true
       @read_raw_data = ''
       @written_raw_data = ''
       @read_raw_data_time = nil
@@ -276,6 +278,7 @@ module OpenC3
         # Otherwise we can hold off outputting other packets where all the data has already
         # been received
         extra = nil
+        blank_test = false
         if !first or @read_protocols.length <= 0
           # Read data for a packet
           data, extra = read_interface()
@@ -286,20 +289,28 @@ module OpenC3
         else
           data = ''
           first = false
+          blank_test = true
         end
 
         @read_protocols.each do |protocol|
           # Extra check is for backwards compatibility
+          protocol.read_protocol_input_base(data, extra) unless blank_test
           if extra
             data, extra = protocol.read_data(data, extra)
           else
             data, extra = protocol.read_data(data)
           end
+          protocol.read_protocol_output_base(data, extra) unless blank_test
           if data == :DISCONNECT
             Logger.info("#{@name}: Protocol #{protocol.class} read_data requested disconnect")
             return nil
           end
           break if data == :STOP
+          if blank_test
+            # This means the blank test returned something so we can log
+            protocol.read_protocol_input_base('', nil)
+            protocol.read_protocol_output_base(data, extra)
+          end
         end
         next if data == :STOP
 
@@ -357,11 +368,13 @@ module OpenC3
         # Potentially modify packet data
         @write_protocols.each do |protocol|
           # Extra check is for backwards compatibility
+          protocol.write_protocol_input_base(data, extra)
           if extra
             data, extra = protocol.write_data(data, extra)
           else
             data, extra = protocol.write_data(data)
           end
+          protocol.write_protocol_output_base(data, extra)
           if data == :DISCONNECT
             Logger.info("#{@name}: Protocol #{protocol.class} write_data requested disconnect")
             disconnect()
@@ -482,13 +495,13 @@ module OpenC3
       other_interface.target_names = self.target_names.clone
       other_interface.cmd_target_names = self.cmd_target_names.clone
       other_interface.tlm_target_names = self.tlm_target_names.clone
+      other_interface.cmd_target_enabled = self.cmd_target_enabled.clone
+      other_interface.tlm_target_enabled = self.tlm_target_enabled.clone
       other_interface.connect_on_startup = self.connect_on_startup
       other_interface.auto_reconnect = self.auto_reconnect
       other_interface.reconnect_delay = self.reconnect_delay
       other_interface.disable_disconnect = self.disable_disconnect
-      other_interface.packet_log_writer_pairs = self.packet_log_writer_pairs.clone
       other_interface.routers = self.routers.clone
-      other_interface.cmd_routers = self.cmd_routers.clone
       other_interface.read_count = self.read_count
       other_interface.write_count = self.write_count
       other_interface.bytes_read = self.bytes_read
@@ -498,7 +511,14 @@ module OpenC3
       # read_queue_size is the number of packets in the queue so don't copy
       # write_queue_size is the number of packets in the queue so don't copy
       self.options.each do |option_name, option_values|
-        other_interface.set_option(option_name, option_values)
+        if option_values and Array === option_values[0]
+          # Properly Handle option that supports multiple instances
+          option_values.each do |ovs|
+            other_interface.set_option(option_name, ovs)
+          end
+        else
+          other_interface.set_option(option_name, option_values)
+        end
       end
       other_interface.protocol_info = []
       self.protocol_info.each do |protocol_class, protocol_args, read_write|
@@ -552,8 +572,10 @@ module OpenC3
     #
     # @return [String] Raw packet data
     def read_interface_base(data, _extra = nil)
-      @read_raw_data_time = Time.now
-      @read_raw_data = data.clone
+      if @save_raw_data
+        @read_raw_data_time = Time.now
+        @read_raw_data = data.clone
+      end
       @bytes_read += data.length
       @stream_log_pair.read_log.write(data) if @stream_log_pair
     end
@@ -565,8 +587,10 @@ module OpenC3
     # @param data [String] Raw packet data
     # @return [String] The exact data written
     def write_interface_base(data, _extra = nil)
-      @written_raw_data_time = Time.now
-      @written_raw_data = data.clone
+      if @save_raw_data
+        @written_raw_data_time = Time.now
+        @written_raw_data = data.clone
+      end
       @bytes_written += data.length
       @stream_log_pair.write_log.write(data) if @stream_log_pair
     end
@@ -646,5 +670,50 @@ module OpenC3
       end
       return handled
     end
+
+    def details
+      result = as_json()
+      result['cmd_target_names'] = @cmd_target_names
+      result['tlm_target_names'] = @tlm_target_names
+      result['cmd_target_enabled'] = @cmd_target_enabled
+      result['tlm_target_enabled'] = @tlm_target_enabled
+      result['connect_on_startup'] = @connect_on_startup
+      result['auto_reconnect'] = @auto_reconnect
+      result['reconnect_delay'] = @reconnect_delay
+      result['disable_disconnect'] = @disable_disconnect
+      result['read_allowed'] = @read_allowed
+      result['write_allowed'] = @write_allowed
+      result['write_raw_allowed'] = @write_raw_allowed
+      result['read_raw_data'] = @read_raw_data
+      result['written_raw_data'] = @written_raw_data
+      if @read_raw_data_time
+        result['read_raw_data_time'] = @read_raw_data_time.iso8601
+      else
+        result['read_raw_data_time'] = nil
+      end
+      if @written_raw_data_time
+        result['written_raw_data_time'] = @written_raw_data_time.iso8601
+      else
+        result['written_raw_data_time'] = nil
+      end
+
+      if @stream_log_pair and (@stream_log_pair.write_log.logging_enabled or @stream_log_pair.read_log.logging_enabled)
+        result['stream_log'] = true
+      else
+        result['stream_log'] = false
+      end
+
+      result['options'] = @options
+      result['read_protocols'] = []
+      @read_protocols.each do |read_protocol|
+        result['read_protocols'] << read_protocol.read_details
+      end
+      result['write_protocols'] = []
+      @write_protocols.each do |write_protocol|
+        result['write_protocols'] << write_protocol.write_details
+      end
+
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/mqtt_interface.rb

@@ -260,5 +260,24 @@ module OpenC3
         @ca_file.close
       end
     end
+
+    def details
+      result = super()
+      result['hostname'] = @hostname
+      result['port'] = @port
+      result['ssl'] = @ssl
+      result['ack_timeout'] = @ack_timeout
+      result['username'] = @username
+      result['password'] = 'Set' if @password
+      result['cert'] = 'Set' if @cert
+      result['key'] = 'Set' if @key
+      result['ca_file'] = 'Set' if @ca_file
+      result['options'].delete('PASSWORD')
+      result['options'].delete('CERT')
+      result['options'].delete('KEY')
+      result['options'].delete('CA_FILE')
+      result['read_packets_by_topic'] = @read_packets_by_topic
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/mqtt_stream_interface.rb

@@ -96,5 +96,25 @@ module OpenC3
         @ca_file.close
       end
     end
+
+    def details
+      result = super()
+      result['hostname'] = @hostname
+      result['port'] = @port
+      result['ssl'] = @ssl
+      result['write_topic'] = @write_topic
+      result['read_topic'] = @read_topic
+      result['ack_timeout'] = @ack_timeout
+      result['username'] = @username
+      result['password'] = 'Set' if @password
+      result['cert'] = 'Set' if @cert
+      result['key'] = 'Set' if @key
+      result['ca_file'] = 'Set' if @ca_file
+      result['options'].delete('PASSWORD')
+      result['options'].delete('CERT')
+      result['options'].delete('KEY')
+      result['options'].delete('CA_FILE')
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/protocols/burst_protocol.rb

@@ -209,5 +209,21 @@ module OpenC3
                              @data.length >= 6 ? @data.getbyte(5) : 0))
       end
     end
+
+    def write_details
+      result = super()
+      result['discard_leading_bytes'] = @discard_leading_bytes
+      result['sync_pattern'] = @sync_pattern.inspect
+      result['fill_fields'] = @fill_fields
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['discard_leading_bytes'] = @discard_leading_bytes
+      result['sync_pattern'] = @sync_pattern.inspect
+      result['fill_fields'] = @fill_fields
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/protocols/cmd_response_protocol.rb

@@ -112,5 +112,23 @@ module OpenC3
       Logger.error(msg)
       raise msg if @raise_exceptions
     end
+
+    def write_details
+      result = super()
+      result['response_timeout'] = @response_timeout
+      result['response_polling_period'] = @response_polling_period
+      result['raise_exceptions'] = @raise_exceptions
+      result['response_packet'] = @response_packet
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['response_timeout'] = @response_timeout
+      result['response_polling_period'] = @response_polling_period
+      result['raise_exceptions'] = @raise_exceptions
+      result['response_packet'] = @response_packet
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/protocols/crc_protocol.rb

@@ -199,5 +199,24 @@ module OpenC3
       end
       return data, extra
     end
+
+    def write_details
+      result = super()
+      result['write_item_name'] = @write_item_name
+      result['endianness'] = @endianness
+      result['bit_offset'] = @bit_offset
+      result['bit_size'] = @bit_size
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['strip_crc'] = @strip_crc
+      result['bad_strategy'] = @bad_strategy
+      result['endianness'] = @endianness
+      result['bit_offset'] = @bit_offset
+      result['bit_size'] = @bit_size
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/protocols/fixed_protocol.rb

@@ -65,7 +65,7 @@ module OpenC3
       return packet
     end
 
-    protected
+    # protected
 
     # Identifies an unknown buffer of data as a Packet. The raw data is
     # returned but the packet that matched is recorded so it can be set in the
@@ -168,5 +168,21 @@ module OpenC3
 
       identify_and_finish_packet()
     end
+
+    def write_details
+      result = super()
+      result['min_id_size'] = @min_id_size
+      result['telemetry'] = @telemetry
+      result['unknown_raise'] = @unknown_raise
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['min_id_size'] = @min_id_size
+      result['telemetry'] = @telemetry
+      result['unknown_raise'] = @unknown_raise
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/protocols/ignore_packet_protocol.rb

@@ -55,5 +55,19 @@ module OpenC3
 
       return super(packet)
     end
+
+    def write_details
+      result = super()
+      result['target_name'] = @target_name
+      result['packet_name'] = @packet_name
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['target_name'] = @target_name
+      result['packet_name'] = @packet_name
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/protocols/length_protocol.rb

@@ -125,7 +125,31 @@ module OpenC3
       return data, extra
     end
 
-    protected
+    def write_details
+      result = super()
+      result['length_bit_offset'] = @length_bit_offset
+      result['length_bit_size'] = @length_bit_size
+      result['length_value_offset'] = @length_value_offset
+      result['length_bytes_per_count'] = @length_bytes_per_count
+      result['length_endianness'] = @length_endianness
+      result['length_bytes_needed'] = @length_bytes_needed
+      result['max_length'] = @max_length
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['length_bit_offset'] = @length_bit_offset
+      result['length_bit_size'] = @length_bit_size
+      result['length_value_offset'] = @length_value_offset
+      result['length_bytes_per_count'] = @length_bytes_per_count
+      result['length_endianness'] = @length_endianness
+      result['length_bytes_needed'] = @length_bytes_needed
+      result['max_length'] = @max_length
+      return result
+    end
+
+    # protected
 
     def calculate_length(buffer_length)
       length = (buffer_length / @length_bytes_per_count) - @length_value_offset

data/lib/openc3/interfaces/protocols/preidentified_protocol.rb

@@ -70,7 +70,7 @@ module OpenC3
       @write_extra = nil
       if packet.extra
         @write_flags |= COSMOS4_EXTRA_FLAG_MASK
-        @write_extra = packet.extra.as_json(:allow_nan => true).to_json(:allow_nan => true)
+        @write_extra = packet.extra.as_json().to_json(allow_nan: true)
       end
       return packet
     end
@@ -95,7 +95,7 @@ module OpenC3
       return data_to_send, extra
     end
 
-    protected
+    # protected
 
     def read_length_field_followed_by_string(length_num_bytes)
       # Read bytes for string length
@@ -161,7 +161,7 @@ module OpenC3
         @read_extra = read_length_field_followed_by_string(4)
         return :STOP if @read_extra == :STOP
 
-        @read_extra = JSON.parse(@read_extra, :allow_nan => true, :create_additions => true)
+        @read_extra = JSON.parse(@read_extra, allow_nan: true, create_additions: true)
         @reduction_state = :FLAGS_REMOVED
       end
 
@@ -203,5 +203,18 @@ module OpenC3
 
       raise "Error should never reach end of method #{@reduction_state}"
     end
+
+    def write_details
+      result = super()
+      result['max_length'] = @max_length
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['max_length'] = @max_length
+      result['reduction_state'] = @reduction_state
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/protocols/protocol.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -52,6 +52,50 @@ module OpenC3
       reset()
     end
 
+    # Called to provide insight into the protocol read_data for the input data
+    def read_protocol_input_base(data, _extra = nil)
+      if @interface
+        if @interface.save_raw_data
+          @read_data_input_time = Time.now
+          @read_data_input = data.clone
+        end
+        # Todo: @interface.stream_log_pair.read_log.write(data) if @interface.stream_log_pair
+      end
+    end
+
+    # Called to provide insight into the protocol read_data for the output data
+    def read_protocol_output_base(data, _extra = nil)
+      if @interface
+        if @interface.save_raw_data
+          @read_data_output_time = Time.now
+          @read_data_output = data.clone
+        end
+        # Todo: @interface.stream_log_pair.read_log.write(data) if @interface.stream_log_pair
+      end
+    end
+
+    # Called to provide insight into the protocol write_data for the input data
+    def write_protocol_input_base(data, _extra = nil)
+      if @interface
+        if @interface.save_raw_data
+          @write_data_input_time = Time.now
+          @write_data_input = data.clone
+        end
+        # Todo: @interface.stream_log_pair.write_log.write(data) if @interface.stream_log_pair
+      end
+    end
+
+    # Called to provide insight into the protocol write_data for the output data
+    def write_protocol_output_base(data, _extra = nil)
+      if @interface
+        if @interface.save_raw_data
+          @write_data_output_time = Time.now
+          @write_data_output = data.clone
+        end
+        # Todo: @interface.stream_log_pair.write_log.write(data) if @interface.stream_log_pair
+      end
+    end
+
     # Ensure we have some data in case this is the only protocol
     def read_data(data, extra = nil)
       if data.length <= 0
@@ -88,5 +132,39 @@ module OpenC3
       # Default do nothing - Implemented by subclasses
       return false
     end
+
+    def write_details
+      result = {'name' => self.class.name.to_s.split("::")[-1]}
+      if @write_data_input_time
+        result['write_data_input_time'] = @write_data_input_time.iso8601
+      else
+        result['write_data_input_time'] = nil
+      end
+      result['write_data_input'] = @write_data_input
+      if @write_data_output_time
+        result['write_data_output_time'] = @write_data_output_time.iso8601
+      else
+        result['write_data_output_time'] = nil
+      end
+      result['write_data_output'] = @write_data_output
+      return result
+    end
+
+    def read_details
+      result = {'name' => self.class.name.to_s.split("::")[-1]}
+      if @read_data_input_time
+        result['read_data_input_time'] = @read_data_input_time.iso8601
+      else
+        result['read_data_input_time'] = nil
+      end
+      result['read_data_input'] = @read_data_input
+      if @read_data_output_time
+        result['read_data_output_time'] = @read_data_output_time.iso8601
+      else
+        result['read_data_output_time'] = nil
+      end
+      result['read_data_output'] = @read_data_output
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/protocols/slip_protocol.rb

@@ -145,6 +145,29 @@ module OpenC3
         return :STOP
       end
     end
+
+    def write_details
+      result = super()
+      result['start_char'] = @start_char.inspect
+      result['end_char'] = @end_char.inspect
+      result['esc_char'] = @esc_char.inspect
+      result['esc_end_char'] = @esc_end_char.inspect
+      result['esc_esc_char'] = @esc_esc_char.inspect
+      result['write_enable_escaping'] = @write_enable_escaping
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['start_char'] = @start_char.inspect
+      result['end_char'] = @end_char.inspect
+      result['esc_char'] = @esc_char.inspect
+      result['esc_end_char'] = @esc_end_char.inspect
+      result['esc_esc_char'] = @esc_esc_char.inspect
+      result['read_strip_characters'] = @read_strip_characters
+      result['read_enable_escaping'] = @read_enable_escaping
+      return result
+    end
   end
 
 end

data/lib/openc3/interfaces/protocols/template_protocol.rb

@@ -259,5 +259,43 @@ module OpenC3
       Logger.error(msg)
       raise msg if @raise_exceptions
     end
+
+    def write_details
+      result = super()
+      result['response_template'] = @response_template
+      result['response_packet'] = @response_packet
+      result['response_target_name'] = @response_target_name
+      result['ignore_lines'] = @ignore_lines
+      result['response_lines'] = @response_lines
+      result['initial_read_delay'] = @initial_read_delay
+      result['response_timeout'] = @response_timeout
+      result['response_polling_period'] = @response_polling_period
+      if @connect_complete_time
+        result['connect_complete_time'] = @connect_complete_time.iso8601
+      else
+        result['connect_complete_time'] = nil
+      end
+      result['raise_exceptions'] = @raise_exceptions
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['response_template'] = @response_template
+      result['response_packet'] = @response_packet
+      result['response_target_name'] = @response_target_name
+      result['ignore_lines'] = @ignore_lines
+      result['response_lines'] = @response_lines
+      result['initial_read_delay'] = @initial_read_delay
+      result['response_timeout'] = @response_timeout
+      result['response_polling_period'] = @response_polling_period
+      if @connect_complete_time
+        result['connect_complete_time'] = @connect_complete_time.iso8601
+      else
+        result['connect_complete_time'] = nil
+      end
+      result['raise_exceptions'] = @raise_exceptions
+      return result
+    end
   end
 end

data/lib/openc3/interfaces/protocols/terminated_protocol.rb

@@ -67,7 +67,20 @@ module OpenC3
       return data, extra
     end
 
-    protected
+    def write_details
+      result = super()
+      result['write_termination_characters'] = @write_termination_characters.inspect
+      return result
+    end
+
+    def read_details
+      result = super()
+      result['read_termination_characters'] = @read_termination_characters.inspect
+      result['strip_read_termination'] = @strip_read_termination
+      return result
+    end
+
+    # protected
 
     def reduce_to_single_packet
       index = @data.index(@read_termination_characters)