openc3 5.10.1 → 5.11.0

data/lib/openc3/interfaces/interface.rb

@@ -23,6 +23,7 @@
 require 'openc3/api/api'
 require 'openc3/logs/stream_log_pair'
 require 'openc3/utilities/secrets'
+require 'rufus-scheduler'
 
 module OpenC3
   # Define a class to allow interfaces and protocols to reject commands without
@@ -140,6 +141,9 @@ module OpenC3
     # @return [Secrets] Interface secrets manager class
     attr_accessor :secrets
 
+    # @return [Scheduler] Scheduler used for periodic commanding
+    attr_accessor :scheduler
+
     # Initialize default attribute values
     def initialize
       @name = self.class.to_s.split("::")[-1] # Remove namespacing if present
@@ -177,12 +181,38 @@ module OpenC3
       @config_params = []
       @interfaces = []
       @secrets = Secrets.getClient
+      @scheduler = nil
     end
 
     # Connects the interface to its target(s). Must be implemented by a
     # subclass.
     def connect
       (@read_protocols | @write_protocols).each { |protocol| protocol.connect_reset }
+
+      periodic_cmds = @options['PERIODIC_CMD']
+      if periodic_cmds
+        if not @scheduler
+          @scheduler = Rufus::Scheduler.new
+
+          periodic_cmds.each do |log_dont_log, period, cmd_string|
+            log_dont_log.upcase!
+            period = "#{period.to_f}s"
+            @scheduler.every period do
+              begin
+                if log_dont_log == 'DONT_LOG'
+                  cmd(cmd_string, log_message: false)
+                else
+                  cmd(cmd_string)
+                end
+              rescue Exception => err
+                Logger.error("Error sending periodic cmd(#{cmd_string}):\n#{err.formatted}")
+              end
+            end
+          end
+        else
+          @scheduler.resume
+        end
+      end
     end
 
     # Indicates if the interface is connected to its target(s) or not. Must be
@@ -194,6 +224,11 @@ module OpenC3
     # Disconnects the interface from its target(s). Must be implemented by a
     # subclass.
     def disconnect
+      periodic_cmds = @options['PERIODIC_CMD']
+      if periodic_cmds and @scheduler
+        @scheduler.pause
+      end
+
       (@read_protocols | @write_protocols).each { |protocol| protocol.disconnect_reset }
     end
 
@@ -201,7 +236,7 @@ module OpenC3
       raise "read_interface not defined by Interface"
     end
 
-    def write_interface
+    def write_interface(data, extra = nil)
       raise "write_interface not defined by Interface"
     end
 
@@ -217,9 +252,10 @@ module OpenC3
         # Protocols may have cached data for a packet, so initially just inject a blank string
         # Otherwise we can hold off outputing other packets where all the data has already
         # been received
+        extra = nil
         if !first or @read_protocols.length <= 0
           # Read data for a packet
-          data = read_interface()
+          data, extra = read_interface()
           unless data
             Logger.info("#{@name}: read_interface requested disconnect")
             return nil
@@ -230,7 +266,12 @@ module OpenC3
         end
 
         @read_protocols.each do |protocol|
-          data = protocol.read_data(data)
+          # Extra check is for backwards compatibility
+          if extra
+            data, extra = protocol.read_data(data, extra)
+          else
+            data, extra = protocol.read_data(data)
+          end
           if data == :DISCONNECT
             Logger.info("#{@name}: Protocol #{protocol.class} read_data requested disconnect")
             return nil
@@ -239,7 +280,12 @@ module OpenC3
         end
         next if data == :STOP
 
-        packet = convert_data_to_packet(data)
+        # Extra check is for backwards compatibility
+        if extra
+          packet = convert_data_to_packet(data, extra)
+        else
+          packet = convert_data_to_packet(data)
+        end
 
         # Potentially modify packet
         @read_protocols.each do |protocol|
@@ -283,11 +329,16 @@ module OpenC3
           return if packet == :STOP
         end
 
-        data = convert_packet_to_data(packet)
+        data, extra = convert_packet_to_data(packet)
 
         # Potentially modify packet data
         @write_protocols.each do |protocol|
-          data = protocol.write_data(data)
+          # Extra check is for backwards compatibility
+          if extra
+            data, extra = protocol.write_data(data, extra)
+          else
+            data, extra = protocol.write_data(data)
+          end
           if data == :DISCONNECT
             Logger.info("#{@name}: Protocol #{protocol.class} write_data requested disconnect")
             disconnect()
@@ -297,11 +348,20 @@ module OpenC3
         end
 
         # Actually write out data if not handled by protocol
-        write_interface(data)
+        # Extra check is for backwards compatibility
+        if extra
+          write_interface(data, extra)
+        else
+          write_interface(data)
+        end
 
         # Potentially block and wait for response
         @write_protocols.each do |protocol|
-          packet, data = protocol.post_write_interface(packet, data)
+          if extra
+            packet, data, extra = protocol.post_write_interface(packet, data, extra)
+          else
+            packet, data, extra = protocol.post_write_interface(packet, data)
+          end
           if packet == :DISCONNECT
             Logger.info("#{@name}: Protocol #{protocol.class} post_write_packet requested disconnect")
             disconnect()
@@ -317,12 +377,12 @@ module OpenC3
     # Writes preformatted data onto the interface. Malformed data may cause
     # problems.
     # @param data [String] The raw data to send out the interface
-    def write_raw(data)
+    def write_raw(data, extra = nil)
       raise "Interface not connected for write_raw: #{@name}" unless connected?
       raise "Interface not write-rawable: #{@name}" unless write_raw_allowed?
 
       _write do
-        write_interface(data)
+        write_interface(data, extra)
       end
     end
 
@@ -429,15 +489,25 @@ module OpenC3
     # @param option_name name of the option
     # @param option_values array of option values
     def set_option(option_name, option_values)
-      @options[option_name.upcase] = option_values.clone
+      option_name_upcase = option_name.upcase
+
+      if option_name_upcase == 'PERIODIC_CMD'
+        # OPTION PERIODIC_CMD LOG/DONT_LOG 1.0 "INST COLLECT with TYPE NORMAL"
+        @options[option_name_upcase] ||= []
+        @options[option_name_upcase] << option_values.clone
+      else
+        @options[option_name_upcase] = option_values.clone
+      end
     end
 
     # Called to convert the read data into a OpenC3 Packet object
     #
     # @param data [String] Raw packet data
     # @return [Packet] OpenC3 Packet with buffer filled with data
-    def convert_data_to_packet(data)
-      Packet.new(nil, nil, :BIG_ENDIAN, nil, data)
+    def convert_data_to_packet(data, extra = nil)
+      packet = Packet.new(nil, nil, :BIG_ENDIAN, nil, data)
+      packet.extra = extra
+      return packet
     end
 
     # Called to convert a packet into the data to send
@@ -445,7 +515,7 @@ module OpenC3
     # @param packet [Packet] Packet to extract data from
     # @return data
     def convert_packet_to_data(packet)
-      packet.buffer(true) # Copy buffer so logged command isn't modified
+      return packet.buffer(true), packet.extra # Copy buffer so logged command isn't modified
     end
 
     # Called to read data and manipulate it until enough data is
@@ -456,7 +526,7 @@ module OpenC3
     # method is called. Subclasses must implement this method.
     #
     # @return [String] Raw packet data
-    def read_interface_base(data)
+    def read_interface_base(data, extra = nil)
       @read_raw_data_time = Time.now
       @read_raw_data = data.clone
       @bytes_read += data.length
@@ -469,7 +539,7 @@ module OpenC3
     #
     # @param data [String] Raw packet data
     # @return [String] The exact data written
-    def write_interface_base(data)
+    def write_interface_base(data, extra = nil)
       @written_raw_data_time = Time.now
       @written_raw_data = data.clone
       @bytes_written += data.length

data/lib/openc3/interfaces/mqtt_interface.rb

@@ -196,19 +196,20 @@ module OpenC3
         return nil
       end
       @read_topics << topic
-      read_interface_base(data)
-      return data
+      extra = nil
+      read_interface_base(data, extra)
+      return data, extra
     rescue IOError # Disconnected
       return nil
     end
 
     # Writes to the socket
     # @param data [String] Raw packet data
-    def write_interface(data)
-      write_interface_base(data)
+    def write_interface(data, extra = nil)
+      write_interface_base(data, extra)
       topic = @write_topics.shift
       @client.publish(topic, data)
-      data
+      return data, extra
     end
 
     # Supported Options

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

@@ -61,15 +61,16 @@ module OpenC3
     # protocols giving them the same opportunity.
     #
     # @return [String|nil] Data for a packet consisting of the bytes read
-    def read_data(data)
+    def read_data(data, extra = nil)
       @data << data
+      @extra = extra
 
       while true
         control = handle_sync_pattern()
         return control if control and data.length > 0 # Only return here if not blank string test
 
         # Reduce the data to a single packet
-        packet_data = reduce_to_single_packet()
+        packet_data, extra = reduce_to_single_packet()
         if packet_data == :RESYNC
           @sync_state = :SEARCHING
           next if data.length > 0 # Only immediately resync if not blank string test
@@ -81,9 +82,9 @@ module OpenC3
             # 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
-            return super(data)
+            return super(data, extra)
           else
-            return packet_data # Return any control code if not on blank string test
+            return packet_data, extra # Return any control code if not on blank string test
           end
         end
 
@@ -91,7 +92,7 @@ module OpenC3
 
         # Discard leading bytes if necessary
         packet_data.replace(packet_data[@discard_leading_bytes..-1]) if @discard_leading_bytes > 0
-        return packet_data
+        return packet_data, extra
       end
     end
 
@@ -115,7 +116,7 @@ module OpenC3
     #
     # @param data [String] Raw packet data
     # @return [String] Potentially modified packet data
-    def write_data(data)
+    def write_data(data, extra = nil)
       # If we're filling the sync pattern and discarding the leading bytes
       # during a read then we need to put them back during a write.
       # If we're discarding the bytes then by definition they can't be part
@@ -127,7 +128,7 @@ module OpenC3
                                data, :BIG_ENDIAN, :ERROR)
         end
       end
-      super(data)
+      return super(data, extra)
     end
 
     # @return [Boolean] control code (nil, :STOP)
@@ -156,8 +157,7 @@ module OpenC3
 
             if found
               if sync_index != 0
-                discard_length = @data[0..(sync_index - 1)].length
-                log_discard(discard_length, true)
+                log_discard(sync_index, true)
                 # Delete Data Before Sync Pattern
                 @data.replace(@data[sync_index..-1])
               end
@@ -165,7 +165,7 @@ module OpenC3
               return nil
 
             else # not found
-              log_discard(@data[0..sync_index].length, false)
+              log_discard(sync_index + 1, false)
               # Delete Data Before and including first character of suspected sync Pattern
               @data.replace(@data[(sync_index + 1)..-1])
               next
@@ -203,7 +203,7 @@ module OpenC3
       # Reduce to packet data and clear data for next packet
       packet_data = @data.clone
       @data.replace('')
-      packet_data
+      return packet_data, @extra
     end
   end
 end

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

@@ -53,9 +53,9 @@ module OpenC3
       )
     end
 
-    def read_data(data)
-      data = super(data)
-      return data if data.length <= 0 or Symbol === data
+    def read_data(data, extra = nil)
+      data, extra = super(data, extra)
+      return data, extra if data.length <= 0 or Symbol === data
 
       result_data = ''
       while data.length > 1
@@ -75,10 +75,10 @@ module OpenC3
         end
       end
 
-      return result_data
+      return result_data, extra
     end
 
-    def write_data(data)
+    def write_data(data, extra = nil)
       # Intentionally not calling super()
 
       need_insert = false
@@ -90,7 +90,7 @@ module OpenC3
           result_data << data[0..253]
           data = data[254..-1]
           need_insert = false
-        else # index <= 254 or (index.nil? and data.length < 254)
+        else # index <= 253 or (index.nil? and data.length < 254)
           if index
             result_data << [index + 1].pack('C')
             if index >= 1
@@ -113,7 +113,7 @@ module OpenC3
       # Terminate message with 0x00
       result_data << "\x00"
 
-      return result_data
+      return result_data, extra
     end
   end
 

data/lib/openc3/interfaces/protocols/crc_protocol.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/config/config_parser'
@@ -147,8 +147,8 @@ module OpenC3
       end
     end
 
-    def read_data(data)
-      return super(data) if data.length <= 0
+    def read_data(data, extra = nil)
+      return super(data, extra) if data.length <= 0
 
       crc = BinaryAccessor.read(@bit_offset, @bit_size, :UINT, data, @endianness)
       calculated_crc = @crc.calc(data[0...(@bit_offset / 8)])
@@ -163,9 +163,9 @@ module OpenC3
         new_data = new_data[0...(@bit_offset / 8)]
         end_range = (@bit_offset + @bit_size) / 8
         new_data << data[end_range..-1] if end_range != 0
-        return new_data
+        return new_data, extra
       end
-      return data
+      return data, extra
     end
 
     def write_packet(packet)
@@ -177,7 +177,7 @@ module OpenC3
       packet
     end
 
-    def write_data(data)
+    def write_data(data, extra = nil)
       unless @write_item_name
         if @bit_size == 64
           crc = @crc.calc(data)
@@ -190,7 +190,7 @@ module OpenC3
           BinaryAccessor.write(crc, -@bit_size, @bit_size, :UINT, data, @endianness, :ERROR)
         end
       end
-      data
+      return data, extra
     end
   end
 end

data/lib/openc3/interfaces/protocols/length_protocol.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'
@@ -96,7 +96,7 @@ module OpenC3
         # If the start of the length field is past what we discard, then the
         # length field is inside the packet
         if @length_bit_offset >= (@discard_leading_bytes * 8)
-          length = calculate_length(packet.buffer.length + @discard_leading_bytes)
+          length = calculate_length(packet.buffer(false).length + @discard_leading_bytes)
           # Subtract off the discarded bytes since they haven't been added yet
           # Adding bytes happens in the write_data method
           offset = @length_bit_offset - (@discard_leading_bytes * 8)
@@ -112,8 +112,8 @@ module OpenC3
     #
     # @param data [String] Raw packet data
     # @return [String] Potentially modified packet data
-    def write_data(data)
-      data = super(data)
+    def write_data(data, extra = nil)
+      data, extra = super(data, extra)
       if @fill_fields
         # If the start of the length field is before what we discard, then the
         # length field is outside the packet
@@ -122,7 +122,7 @@ module OpenC3
                                data, @length_endianness, :ERROR)
         end
       end
-      return data
+      return data, extra
     end
 
     protected
@@ -162,7 +162,7 @@ module OpenC3
       packet_data = @data[0..(packet_length - 1)]
       @data.replace(@data[packet_length..-1])
 
-      return packet_data
+      return packet_data, @extra
     end
   end
 end

data/lib/openc3/interfaces/protocols/preidentified_protocol.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/interfaces/protocols/burst_protocol'
@@ -49,7 +49,11 @@ module OpenC3
       packet.packet_name = @read_packet_name
       if @mode == 4 # COSMOS4.3+ Protocol
         packet.stored = @read_stored
-        packet.extra = @read_extra
+        if packet.extra and @read_extra
+          packet.extra.merge(@read_extra)
+        else
+          packet.extra = @read_extra
+        end
       end
       return packet
     end
@@ -75,7 +79,7 @@ module OpenC3
       return packet
     end
 
-    def write_data(data)
+    def write_data(data, extra = nil)
       data_length = [data.length].pack('N') # UINT32
       data_to_send = ''
       data_to_send << @sync_pattern if @sync_pattern
@@ -94,7 +98,7 @@ module OpenC3
       data_to_send << @write_packet_name
       data_to_send << data_length
       data_to_send << data
-      return data_to_send
+      return data_to_send, extra
     end
 
     protected
@@ -200,7 +204,7 @@ module OpenC3
         return :STOP if packet_data == :STOP
 
         @reduction_state = :START
-        return packet_data
+        return packet_data, @extra
       end
 
       raise "Error should never reach end of method #{@reduction_state}"

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

@@ -29,6 +29,7 @@ module OpenC3
   class Protocol
     attr_accessor :interface
     attr_accessor :allow_empty_data
+    attr_accessor :extra
 
     # @param allow_empty_data [true/false/nil] Whether or not this protocol will allow an empty string
     # to be passed down to later Protocols (instead of returning :STOP). Can be true, false, or nil, where
@@ -40,6 +41,7 @@ module OpenC3
     end
 
     def reset
+      @extra = nil
     end
 
     def connect_reset
@@ -51,7 +53,7 @@ module OpenC3
     end
 
     # Ensure we have some data in case this is the only protocol
-    def read_data(data)
+    def read_data(data, extra = nil)
       if data.length <= 0
         if @allow_empty_data.nil?
           if @interface and @interface.read_protocols[-1] == self
@@ -63,7 +65,7 @@ module OpenC3
           return :STOP
         end
       end
-      data
+      return data, extra
     end
 
     def read_packet(packet)
@@ -74,12 +76,12 @@ module OpenC3
       return packet
     end
 
-    def write_data(data)
-      return data
+    def write_data(data, extra = nil)
+      return data, extra
     end
 
-    def post_write_interface(packet, data)
-      return packet, data
+    def post_write_interface(packet, data, extra = nil)
+      return packet, data, extra
     end
 
     def protocol_cmd(cmd_name, *cmd_args)

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

@@ -55,7 +55,7 @@ module OpenC3
       allow_empty_data = nil)
 
       @start_char = ConfigParser.handle_nil(start_char)
-      @start_char = [Integer(end_char)].pack('C') if @start_char
+      @start_char = [Integer(start_char)].pack('C') if @start_char
       @end_char = [Integer(end_char)].pack('C')
       @esc_char = [Integer(esc_char)].pack('C')
       @esc_end_char = [Integer(esc_end_char)].pack('C')
@@ -89,9 +89,9 @@ module OpenC3
       )
     end
 
-    def read_data(data)
-      data = super(data)
-      return data if data.length <= 0 or Symbol === data
+    def read_data(data, extra = nil)
+      data, extra = super(data, extra)
+      return data, extra if data.length <= 0 or Symbol === data
 
       if @read_strip_characters
         if @start_char
@@ -104,10 +104,10 @@ module OpenC3
         data = data.gsub(@replace_end, @end_char).gsub(@replace_esc, @esc_char)
       end
 
-      return data
+      return data, extra
     end
 
-    def write_data(data)
+    def write_data(data, extra = nil)
       # Intentionally not calling super()
 
       if @write_enable_escaping
@@ -120,7 +120,7 @@ module OpenC3
 
       data << @end_char
 
-      return data
+      return data, extra
     end
 
     def reduce_to_single_packet
@@ -140,7 +140,7 @@ module OpenC3
           packet_data = @data[0..(@read_termination_characters.length - 1)]
         end
         @data.replace(@data[(index + @read_termination_characters.length)..-1])
-        return packet_data
+        return packet_data, @extra
       else
         return :STOP
       end

data/lib/openc3/interfaces/protocols/template_protocol.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/config/config_parser'
@@ -108,8 +108,8 @@ module OpenC3
       @write_block_queue << nil # Unblock the write block queue
     end
 
-    def read_data(data)
-      return super(data) if data.length <= 0
+    def read_data(data, extra = nil)
+      return super(data, extra) if data.length <= 0
 
       # Drop all data until the initial_read_delay is complete.
       # This gets rid of unused welcome messages,
@@ -119,7 +119,7 @@ module OpenC3
 
         @initial_read_delay_needed = false
       end
-      super(data)
+      return super(data, extra)
     end
 
     def read_packet(packet)
@@ -165,7 +165,6 @@ module OpenC3
             result_packet.write(response_item_names[i], value)
           rescue => error
             handle_error("#{@interface ? @interface.name : ""}: Could not write value #{value} due to #{error.message}")
-            break
           end
         end
 
@@ -230,7 +229,7 @@ module OpenC3
       return raw_packet
     end
 
-    def post_write_interface(packet, data)
+    def post_write_interface(packet, data, extra = nil)
       if @response_template && @response_packet
         if @response_timeout
           response_timeout_time = Time.now + @response_timeout
@@ -253,7 +252,7 @@ module OpenC3
         @response_target_name = nil
         @response_packets.clear
       end
-      return super(packet, data)
+      return super(packet, data, extra)
     end
 
     def handle_error(msg)