cosmos-ccsds_transfer_frames 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaef988e57d7a960bd1be54b29f8620da10c2f7a
-  data.tar.gz: 0bf246c91d89effc965ed138a52cda49e94e6052
+  metadata.gz: 89006d10884c558d15f95aa5f4ac33f318c30445
+  data.tar.gz: 8ed81aa7a0264e5756eeadf6af8582c018f74c87
 SHA512:
-  metadata.gz: be53b3764587795f609c571ac739c16ef5c69f15232d12ce70ab2632a40a1a6d2b750417c8c62e4ab5012aced6e1a228ca5572b1fa0b4031cea7a4baf1798866
-  data.tar.gz: 465382e1278488844f1120b270ab1eab82aa2cacfea98c016b662df98be5f755fbbf9d0d9f8cfdaaa93c5d9cbdbe5a38a3b6e203b0ebff36f796b45a0ef9ba37
+  metadata.gz: 0ec01cbd0780df0f5b7166fdc5d233efeec9e20be86ebf9344d7808a92ce1f8d0e99406d44b0e9fc729051535177830fd4879c29b26ac261ccf4e883dfaa69a7
+  data.tar.gz: a691e88527df7288fefbf9ce714d0d02fe62775a1f30b250a0461a652ccfe4836d7a0eca5f628e8736fde410dbf14f2864379b5d07ca7d5d3f4cd3efab2a0565

data/README.md

@@ -1,12 +1,14 @@
 # Cosmos::CcsdsTransferFrames
 
-This gem contains a CCSDS transfer frame protocol for use with the Ball Aerospace COSMOS application.
+This gem contains a [CCSDS](https://public.ccsds.org/default.aspx) transfer frame protocol for use with the [Ball Aerospace COSMOS application](http://cosmosrb.com).
 
 The protocol extracts CCSDS space packets from CCSDS transfer frames, optionally prefixing each packet with the transfer frame headers of the frame where it started.
 
+See [CCSDS 132.0-B-2 - TM Space Data Link Protocol. Blue Book.](https://public.ccsds.org/Pubs/132x0b2.pdf) and [CCSDS 133.0-B-1 - Space Packet Protocol. Blue Book.](https://public.ccsds.org/Pubs/133x0b1c2.pdf) for detailed information.
+
 ## Installation
 
-This gem is intended to be installed as a 'gem based target/tool' (see http://cosmosrb.com/docs/gemtargets/) in COSMOS and made available for use as a normal protocol in a target command and telemetry server configuration. Note that the protocol provided in this gem is neither a target nor a tool in the COSMOS sense.
+This gem is intended to be installed as a [gem based target/tool](http://cosmosrb.com/docs/gemtargets/) in COSMOS and made available for use as a normal protocol in a target command and telemetry server configuration. Note that the protocol provided in this gem is neither a target nor a tool in the COSMOS sense.
 
 In order to make this protocol available for use in your COSMOS targets, add this line to the Gemfile of your COSMOS project:
 
@@ -45,7 +47,7 @@ This would set up the protocol to expect transfer frames with:
 * No prefixing of packets (default).
 * Discarding of idle packets (default).
 
-For detailed information about the available configuration parameters for the protocol, please consult the yard inline source code documentation in `lib/cosmos/ccsds_transfer_frames/ccsds_transfer_frame_protocol.rb`
+For detailed information about the available configuration parameters for the protocol, please consult the yard inline source code documentation in [ccsds_transfer_frame_protocol.rb](lib/cosmos/ccsds_transfer_frames/ccsds_transfer_frame_protocol.rb) or the generated documentation for the currently published gem at https://www.rubydoc.info/gems/cosmos-ccsds_transfer_frames/Cosmos/CcsdsTransferFrames/CcsdsTransferFrameProtocol
 
 ## Development
 

data/lib/cosmos/ccsds_transfer_frames/ccsds_transfer_frame_protocol.rb

@@ -132,7 +132,7 @@ module Cosmos
       #
       # @return [String] Packet data, if the queues contained at least one
       #   complete packet.
-      # @return [Symbol] :STOP, if the queues does not contain any complete
+      # @return [Symbol] :STOP, if the queues do not contain any complete
       #   packets.
       def get_packet
         @virtual_channels.each do |vc|
@@ -182,35 +182,58 @@ module Cosmos
 
         frame_data_field = frame[@frame_headers_length, @frame_data_field_length]
 
-        status = handle_packet_continuation(virtual_channel, frame_data_field, first_header_pointer)
-        return if (Symbol === status && status == :STOP)
+        handle_packet_continuation(virtual_channel, frame_data_field, first_header_pointer)
 
-        if (frame_data_field.length == @frame_data_field_length)
-          # No continuation packet was completed, and a packet starts in this
-          # frame. Utilise the first header pointer to re-sync to a packet start.
-          frame_data_field.replace(frame_data_field[first_header_pointer..-1])
-        end
+        return if (first_header_pointer == NO_PACKET_START_FIRST_HEADER_POINTER)
 
-        frame_headers = frame[0, @frame_headers_length].clone
+        frame_headers = frame[0, @frame_headers_length]
         store_packets(virtual_channel, frame_headers, frame_data_field)
       end
 
       # Handle packet continuation when processing a transfer frame.
       #
-      # Ensures that any incomplete packet first has enough data for the packet
-      # header to determine its length and then ensures that it has enough data
-      # to be complete based on its length.
+      # First ensures that any incomplete packet has enough data for the packet
+      # header to determine its length and then tries to complete it.
+      #
+      # If the first header pointer indicates that a packet starts in this
+      # frame, the frame_data_field parameter will be modified by removing
+      # everything before the first header pointer.
       #
       # @param virtual_channel [Int] Transfer frame virtual channel.
       # @param frame_data_field [String] Transfer frame data field.
       # @param first_header_pointer [Int] First header pointer value.
       def handle_packet_continuation(virtual_channel, frame_data_field, first_header_pointer)
         vc = @virtual_channels[virtual_channel]
-        if (vc.packet_queue.length > 0 &&
-            vc.packet_queue[-1].length < @packet_prefix_length + SPACE_PACKET_HEADER_LENGTH)
-          # pending incomplete packet does not have header yet
-          rest_of_packet_header_length = @packet_prefix_length + SPACE_PACKET_HEADER_LENGTH - vc.packet_queue[-1].length
-          vc.packet_queue[-1] << frame_data_field.slice!(0, rest_of_packet_header_length)
+
+        if (vc.packet_queue.length == 0 ||
+            vc.pending_incomplete_packet_bytes_left == 0)
+          # no packet in queue to be continued
+
+          return if (first_header_pointer == NO_PACKET_START_FIRST_HEADER_POINTER)
+
+          frame_data_field.replace(frame_data_field[first_header_pointer..-1])
+          return
+        end
+
+        packet_continuation = nil
+        if (first_header_pointer == NO_PACKET_START_FIRST_HEADER_POINTER)
+          packet_continuation = frame_data_field
+        else
+          packet_continuation = frame_data_field.slice!(0, first_header_pointer)
+        end
+
+        if (vc.packet_queue[-1].length < @packet_prefix_length + SPACE_PACKET_HEADER_LENGTH)
+          # Pending incomplete packet does not yet heave header, try to
+          # complete header and get length before processing further.
+          rest_of_packet_header_length = vc.pending_incomplete_packet_bytes_left
+          if (rest_of_packet_header_length > packet_continuation.length)
+            # Not enough continuation to complete packet header, first header
+            # pointer takes precedence and packet is cut short.
+            vc.packet_queue[-1] << packet_continuation
+            vc.pending_incomplete_packet_bytes_left = 0
+            return
+          end
+          vc.packet_queue[-1] << packet_continuation.slice!(0, rest_of_packet_header_length)
 
           space_packet_length = get_space_packet_length(vc.packet_queue[-1][@packet_prefix_length..-1])
           throw "failed to get space packet length" if Symbol === space_packet_length && space_packet_length == :STOP
@@ -218,25 +241,46 @@ module Cosmos
           vc.pending_incomplete_packet_bytes_left = space_packet_length - SPACE_PACKET_HEADER_LENGTH
         end
 
-        if (vc.pending_incomplete_packet_bytes_left >= frame_data_field.length)
-          # continuation of a packet
-          vc.packet_queue[-1] << frame_data_field
+        if (first_header_pointer == NO_PACKET_START_FIRST_HEADER_POINTER)
+          # packet continues past this frame or ends exactly at end of this
+          # frame according to first header pointer
+
+          if (vc.pending_incomplete_packet_bytes_left < packet_continuation.length)
+            # Packet length is inconsistent with first header pointer, since it
+            # indicates that the packet ends before the end of this frame.
+            #
+            # Complete the packet based on the packet length and ignore the
+            # rest of the data in the frame (will use first header pointer to
+            # re-sync with start of next packet in a later frame).
+            vc.packet_queue[-1] << packet_continuation[0, vc.pending_incomplete_packet_bytes_left]
+            vc.pending_incomplete_packet_bytes_left = 0
+            return
+          end
+
+          # First header pointer and packet length are consistent, append whole frame.
+          vc.packet_queue[-1] << packet_continuation
           vc.pending_incomplete_packet_bytes_left -= frame_data_field.length
-          return :STOP
+          return
         end
 
-        if (first_header_pointer == NO_PACKET_START_FIRST_HEADER_POINTER)
-          # This was not a continuation of a packet (or it was a continuation of
-          # an ignored idle packet), wait for another frame to find a packet
-          # start.
-          return :STOP
-        end
+        # packet ends before the end of this frame according to first header
+        # pointer
 
-        if (vc.pending_incomplete_packet_bytes_left > 0)
-          rest_of_packet = frame_data_field.slice!(0, vc.pending_incomplete_packet_bytes_left)
-          vc.packet_queue[-1] << rest_of_packet
-          vc.pending_incomplete_packet_bytes_left = 0
+        if (vc.pending_incomplete_packet_bytes_left < packet_continuation.length)
+          # Packet length is inconsistent with first header pointer, since it
+          # indicates that the packet ends before the first header pointer.
+          #
+          # Complete the packet based on the packet length and ignore the data
+          # between the packet end and the first header pointer.
+          packet_continuation.replace(packet_continuation[0, vc.pending_incomplete_packet_bytes_left])
         end
+
+        # If the packet length is too long compared to the first header
+        # pointer, the first header pointer takes precedence and the packet is
+        # cut short.
+
+        vc.packet_queue[-1] << packet_continuation
+        vc.pending_incomplete_packet_bytes_left = 0
       end
 
       # Extract all packets from the remaining frame data field, and store them

data/lib/cosmos/ccsds_transfer_frames/version.rb

@@ -1,5 +1,5 @@
 module Cosmos
   module CcsdsTransferFrames
-    VERSION = "0.1.2"
+    VERSION = "0.1.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cosmos-ccsds_transfer_frames
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Martin Erik Werner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-08 00:00:00.000000000 Z
+date: 2018-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cosmos