openc3 5.0.6

data/lib/openc3/bridge/bridge_interface_thread.rb

@@ -0,0 +1,42 @@
+# 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
+
+require 'openc3/tools/cmd_tlm_server/interface_thread'
+
+module OpenC3
+  class BridgeInterfaceThread < InterfaceThread
+    protected
+
+    def handle_packet(packet)
+      @interface.routers.each do |router|
+        if router.connected?
+          if router.write_allowed?
+            begin
+              router.write(packet)
+            rescue Exception => err
+              Logger.error "Error routing telemetry from #{@interface.name} to router #{router.name}\n#{err.formatted}"
+            end
+          end
+        else
+          Logger.error "Attempted to route telemetry from #{@interface.name} to disconnected router #{router.name}"
+        end
+      end
+    end
+  end # class BridgeInterfaceThread
+end

data/lib/openc3/bridge/bridge_router_thread.rb

@@ -0,0 +1,42 @@
+# 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
+
+require 'openc3/tools/cmd_tlm_server/interface_thread'
+
+module OpenC3
+  class BridgeRouterThread < InterfaceThread
+    protected
+
+    def handle_packet(packet)
+      @interface.interfaces.each do |interface|
+        if interface.connected?
+          if interface.write_allowed?
+            begin
+              interface.write(packet)
+            rescue Exception => err
+              Logger.error "Error routing command from #{@interface.name} to interface #{interface.name}\n#{err.formatted}"
+            end
+          end
+        else
+          Logger.error "Attempted to route command from #{@interface.name} to disconnected interface #{interface.name}"
+        end
+      end
+    end
+  end # class BridgeRouterThread
+end

data/lib/openc3/ccsds/ccsds_packet.rb

@@ -0,0 +1,68 @@
+# 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
+
+require 'openc3/packets/packet'
+
+module OpenC3
+  # Packet which defines the required CCSDS items which include Version, Type,
+  # Secondary Header Flag, APID, Sequence Flags, Sequence Count and Length. It
+  # will optionally include a data item which will contain the rest of the
+  # CCSDS packet data. This is optional to make it easier to subclass this
+  # packet and add secondary header fields.
+  class CcsdsPacket < Packet
+    # CCSDS telemetry type
+    TELEMETRY = 0
+    # CCSDS telecommand type
+    COMMAND = 1
+
+    # CCSDS sequence flag indicating continuation packet
+    MIDDLE = 0
+    # CCSDS sequence flag indicating continuation packet
+    CONTINUATION = 0
+    # CCSDS sequence flag indicating the first packet
+    FIRST = 1
+    # CCSDS sequence flag indicating the last packet
+    LAST = 2
+    # CCSDS sequence flag indicating a stand alone packet
+    STANDALONE = 3
+
+    # Length Field Offset to number of bytes in entire packet
+    LENGTH_FIELD_OFFSET = 7
+
+    # Creates a CCSDS packet by setting the target and packet name and then
+    # defining all the fields in a CCSDS packet with a primary header. If a
+    # secondary header is desired, define a secondary header field and then
+    # override the CcsdsData field to start after bit offset 48.
+    #
+    # @param target_name [String] The target name
+    # @param packet_name [String] The packet name
+    def initialize(target_name = nil, packet_name = nil, include_ccsds_data = true)
+      super(target_name, packet_name, :BIG_ENDIAN)
+      define_item('CcsdsVersion', 0, 3, :UINT)
+      define_item('CcsdsType', 3, 1, :UINT)
+      define_item('CcsdsShf', 4, 1, :UINT)
+      define_item('CcsdsApid', 5, 11, :UINT)
+      define_item('CcsdsSeqflags', 16, 2, :UINT)
+      item = define_item('CcsdsSeqcnt', 18, 14, :UINT)
+      item.overflow = :TRUNCATE
+      define_item('CcsdsLength', 32, 16, :UINT)
+      define_item('CcsdsData', 48, 0, :BLOCK) if include_ccsds_data
+    end
+  end
+end

data/lib/openc3/ccsds/ccsds_parser.rb

@@ -0,0 +1,148 @@
+# 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
+
+require 'openc3'
+require 'openc3/ccsds/ccsds_packet'
+
+module OpenC3
+  # Unsegments CCSDS packets and perform other CCSDS processing tasks.
+  class CcsdsParser
+    # @return [Symbol] Indicates if the parser is :READY to start a new series
+    #   of packets or is :IN_PROGRESS
+    attr_reader :state
+
+    # @return [String] Binary data that has been collected so far towards the
+    #   completely unsegmented packet. Note: This value is cleared once the
+    #   entire packet is formed and also cleared due to errors.
+    attr_reader :in_progress_data
+
+    # @return [String] The most recent successfully unsegmented packet's data
+    attr_reader :unsegmented_data
+
+    # @return [Integer] Sequence count of the previously received packet
+    attr_reader :sequence_count
+
+    # Create a new {CcsdsPacket} and set the state to :READY
+    def initialize
+      @ccsds_packet = CcsdsPacket.new
+      @unsegmented_data = nil
+      @sequence_count = nil
+      reset()
+    end
+
+    # Resets internal state to :READY and clears the in_progress_data
+    def reset
+      @state = :READY
+      @in_progress_data = ''
+    end
+
+    # Given a segment of a larger CCSDS packet, stores the data until a complete
+    # unsegmented packet can be created.  Returns the unsegmented packet data
+    # once it is complete, or nil if still in progress. Raises
+    # CcsdsParser::CcsdsSegmentationError if a problem is encountered while
+    # unsegmenting.
+    #
+    # @param packet [Packet] A CCSDS packet
+    # @return [String|nil] The reconstituted CCSDS packet buffer or nil if the
+    #   packet has not yet been fully assembled
+    def unsegment_packet(packet)
+      @ccsds_packet.buffer = packet.buffer
+
+      previous_sequence_count = @sequence_count
+      @sequence_count = @ccsds_packet.read('CcsdsSeqcnt')
+
+      # Handle each segment
+      case @ccsds_packet.read('CcsdsSeqflags')
+      when CcsdsPacket::CONTINUATION
+        #####################################################
+        # Continuation packet - only process if in progress
+        #####################################################
+
+        if @state == :IN_PROGRESS
+          if @sequence_count == ((previous_sequence_count + 1) % 16384)
+            @in_progress_data << @ccsds_packet.read('CcsdsData')
+            return nil
+          else
+            reset()
+            raise CcsdsSegmentationError, "Missing packet(s) before continuation packet detected. Current Sequence Count #{@sequence_count}, Previous Sequence Count #{previous_sequence_count}"
+          end
+        else
+          reset()
+          raise CcsdsSegmentationError, "Unexpected continuation packet"
+        end
+
+      when CcsdsPacket::FIRST
+        #######################################################
+        # First packet - always process
+        #######################################################
+
+        if @state == :IN_PROGRESS
+          reset()
+          @state = :IN_PROGRESS
+          @in_progress_data << @ccsds_packet.buffer
+          raise CcsdsSegmentationError, "Unexpected first packet"
+        else
+          @state = :IN_PROGRESS
+          @in_progress_data << @ccsds_packet.buffer
+          return nil
+        end
+
+      when CcsdsPacket::LAST
+        ######################################################################
+        # Last packet - only process if in progress
+        ######################################################################
+
+        if @state == :IN_PROGRESS
+          if @sequence_count == ((previous_sequence_count + 1) % 16384)
+            @in_progress_data << @ccsds_packet.read('CcsdsData')
+            @unsegmented_data = @in_progress_data
+            reset()
+            return @unsegmented_data
+          else
+            reset()
+            raise CcsdsSegmentationError, "Missing packet(s) before last packet detected. Current Sequence Count #{@sequence_count}, Previous Sequence Count #{previous_sequence_count}"
+          end
+        else
+          reset()
+          raise CcsdsSegmentationError, "Unexpected last packet"
+        end
+
+      when CcsdsPacket::STANDALONE
+        ############################################################
+        # Standalone packet - save and return its data
+        ############################################################
+
+        # Update most recent unsegmented data
+        @unsegmented_data = @ccsds_packet.buffer
+
+        if @state == :IN_PROGRESS
+          reset()
+          raise CcsdsSegmentationError, "Unexpected standalone packet"
+        else
+          reset()
+          return @unsegmented_data
+        end
+
+      end # case raw_sequence_flags
+    end
+
+    # Class to indicate errors that occur during the unsegmenting process
+    class CcsdsSegmentationError < StandardError; end
+  end # end class CcsdsParser
+end