cosmos 3.9.2 → 4.0.0

data/lib/cosmos/packets/commands.rb

@@ -135,7 +135,7 @@ module Cosmos
       command = packet(target_upcase, packet_upcase).clone
 
       # Set time, parameters, and restore defaults
-      command.received_time = Time.now
+      command.received_time = Time.now.sys
       command.given_values = params
       command.restore_defaults(command.buffer(false), params.keys)
       command.raw = raw
@@ -148,41 +148,65 @@ module Cosmos
 
     # Formatted version of a command
     def format(packet, ignored_parameters = [])
-      first = true
       if packet.raw
         items = packet.read_all(:RAW)
-        string = "cmd_raw('#{packet.target_name} #{packet.packet_name}"
+        raw = true
       else
         items = packet.read_all(:FORMATTED)
-        string = "cmd('#{packet.target_name} #{packet.packet_name}"
+        raw = false
       end
-      items.each do |item_name, item_value|
-        unless ignored_parameters.include?(item_name)
-          if first
-            string << ' with '.freeze
-            first = false
-          else
-            string << ', '.freeze
+      items.delete_if {|item_name, item_value| ignored_parameters.include?(item_name)}
+      return build_cmd_output_string(packet.target_name, packet.packet_name, items, raw)
+    end
+
+    def build_cmd_output_string(target_name, cmd_name, cmd_params, raw = false)
+      if raw
+        output_string = 'cmd_raw("'
+      else
+        output_string = 'cmd("'
+      end
+      output_string << target_name + ' ' + cmd_name
+      if cmd_params.nil? or cmd_params.empty?
+        output_string << '")'
+      else
+        begin
+          command_items = packet(target_name, cmd_name).items
+        rescue
+        end
+
+        params = []
+        cmd_params.each do |key, value|
+
+          begin
+            item_type = command_items[key].data_type
+          rescue
+            item_type = nil
           end
 
-          item = packet.get_item(item_name)
-          if item.data_type ==:STRING or item.data_type == :BLOCK
-            item_value = item_value.inspect
-            if item_value.length > 256
-              item_value = item_value[0..255] + '..."'.freeze
-            end
-            string << "#{item_name} #{item_value}"
-          else
-            if (Array === item_value) && (!packet.raw)
-              string << "#{item_name} [#{item_value.join(", ")}]"
+          if value.is_a?(String)
+            value = value.dup
+            if item_type == :BLOCK or item_type == :STRING
+              if !value.is_printable?
+                value = "0x" + value.simple_formatted
+              else
+                value = value.inspect
+              end
             else
-              string << "#{item_name} #{item_value}"
+              value = value.convert_to_value.to_s
+            end
+            if value.length > 256
+              value = value[0..255] + "...'"
             end
+            value.tr!('"',"'")
+          elsif value.is_a?(Array)
+            value = "[#{value.join(", ")}]"
           end
+          params << "#{key} #{value}"
         end
+        params = params.join(", ")
+        output_string << ' with ' + params + '")'
       end
-      string << "')".freeze
-      string
+      return output_string
     end
 
     # Returns whether the given command is hazardous. Commands are hazardous

data/lib/cosmos/packets/packet.rb

@@ -10,7 +10,7 @@
 
 require 'cosmos/packets/structure'
 require 'cosmos/packets/packet_item'
-require 'cosmos/ext/packet'
+require 'cosmos/ext/packet' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
 
 module Cosmos
 
@@ -43,7 +43,7 @@ module Cosmos
     # @return [String] Description of why the packet is hazardous
     attr_reader :hazardous_description
 
-    # Containst the values given by the user for a command (distinguished from defaults)
+    # Contains the values given by the user for a command (distinguished from defaults)
     # These values should be used within command conversions if present because the order
     # that values are written into the actual packet can vary
     # @return [Hash<Item Name, Value>] Given values when constructing the packet
@@ -70,16 +70,144 @@ module Cosmos
     # Valid format types
     VALUE_TYPES = [:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS]
 
-    # Creates a new packet by initalizing the attributes.
-    #
-    # @param target_name [String] Name of the target this packet is associated with
-    # @param packet_name [String] Name of the packet
-    # @param default_endianness [Symbol] One of {BinaryAccessor::ENDIANNESS}
-    # @param description [String] Description of the packet
-    # @param buffer [String] String buffer to hold the packet data
-    # @param item_class [Class] Class used to instantiate items (Must be a
-    #   subclass of PacketItem)
-    # def initialize(target_name, packet_name, default_endianness = :BIG_ENDIAN, description = nil, buffer = '', item_class = PacketItem)
+    if RUBY_ENGINE != 'ruby' or ENV['COSMOS_NO_EXT']
+      # Creates a new packet by initalizing the attributes.
+      #
+      # @param target_name [String] Name of the target this packet is associated with
+      # @param packet_name [String] Name of the packet
+      # @param default_endianness [Symbol] One of {BinaryAccessor::ENDIANNESS}
+      # @param description [String] Description of the packet
+      # @param buffer [String] String buffer to hold the packet data
+      # @param item_class [Class] Class used to instantiate items (Must be a
+      #   subclass of PacketItem)
+      def initialize(target_name, packet_name, default_endianness = :BIG_ENDIAN, description = nil, buffer = '', item_class = PacketItem)
+        super(default_endianness, buffer, item_class)
+        self.target_name = target_name
+        self.packet_name = packet_name
+        self.description = description
+        @received_time = nil
+        @received_count = 0
+        @id_items = nil
+        @hazardous = false
+        @hazardous_description = nil
+        @given_values = nil
+        @limits_items = nil
+        @processors = nil
+        @stale = true
+        @limits_change_callback = nil
+        @read_conversion_cache = nil
+        @raw = nil
+        @messages_disabled = false
+        @meta = nil
+        @hidden = false
+        @disabled = false
+      end
+
+      # Sets the target name this packet is associated with. Unidentified packets
+      # will have target name set to nil.
+      #
+      # @param target_name [String] Name of the target this packet is associated with
+      def target_name=(target_name)
+        if target_name
+          if !(String === target_name)
+            raise(ArgumentError, "target_name must be a String but is a #{target_name.class}")
+          end
+          @target_name = target_name.upcase.freeze
+        else
+          @target_name = nil
+        end
+        @target_name
+      end
+
+      # Sets the packet name. Unidentified packets will have packet name set to
+      # nil.
+      #
+      # @param packet_name [String] Name of the packet
+      def packet_name=(packet_name)
+        if packet_name
+          if !(String === packet_name)
+            raise(ArgumentError, "packet_name must be a String but is a #{packet_name.class}")
+          end
+          @packet_name = packet_name.upcase.freeze
+        else
+          @packet_name = nil
+        end
+        @packet_name
+      end
+
+      # Sets the description of the packet
+      #
+      # @param description [String] Description of the packet
+      def description=(description)
+        if description
+          if !(String === description)
+            raise(ArgumentError, "description must be a String but is a #{description.class}")
+          end
+          @description = description.clone.freeze
+        else
+          @description = nil
+        end
+        @description
+      end
+
+      # Sets the received time of the packet
+      #
+      # @param received_time [Time] Time this packet was received
+      def received_time=(received_time)
+        if received_time
+          if !(Time === received_time)
+            raise(ArgumentError, "received_time must be a Time but is a #{received_time.class}")
+          end
+          @received_time = received_time.clone.freeze
+        else
+          @received_time = nil
+        end
+        @read_conversion_cache.clear if @read_conversion_cache
+        @received_time
+      end
+
+      # Sets the received count of the packet
+      #
+      # @param received_count [Integer] Number of times this packet has been
+      #   received
+      def received_count=(received_count)
+        if !(Integer === received_count)
+          raise(ArgumentError, "received_count must be an Integer but is a #{received_count.class}")
+        end
+        @received_count = received_count
+        @read_conversion_cache.clear if @read_conversion_cache
+        @received_count
+      end
+
+      # Tries to identify if a buffer represents the currently defined packet. It
+      # does this by iterating over all the packet items that were created with
+      # an ID value and checking whether that ID value is present at the correct
+      # location in the buffer.
+      #
+      # Incorrectly sized buffers will still positively identify if there is
+      # enough data to match the ID values. This is to allow incorrectly sized
+      # packets to still be processed as well as possible given the incorrectly
+      # sized data.
+      #
+      # @param buffer [String] Raw buffer of binary data
+      # @return [Boolean] Whether or not the buffer of data is this packet
+      def identify?(buffer)
+        return false unless buffer
+        return true unless @id_items
+
+        @id_items.each do |item|
+          begin
+            value = read_item(item, :RAW, buffer)
+          rescue Exception
+            value = nil
+          end
+          return false if item.id_value != value
+        end
+
+        true
+      end
+
+    end
 
     # (see Structure#buffer=)
     def buffer=(buffer)
@@ -94,28 +222,6 @@ module Cosmos
       end
     end
 
-    # Sets the target name this packet is associated with. Unidentified packets
-    # will have target name set to nil.
-    #
-    # @param target_name [String] Name of the target this packet is associated with
-    # def target_name=(target_name)
-
-    # Sets the packet name. Unidentified packets will have packet name set to
-    # nil.
-    #
-    # @param packet_name [String] Name of the packet
-    # def packet_name=(packet_name)
-
-    # Sets the description of the packet
-    #
-    # @param description [String] Description of the packet
-    # def description=(description)
-
-    # Sets the received time of the packet
-    #
-    # @param received_time [Time] Time this packet was received
-    # def received_time=(received_time)
-
     # Sets the received time of the packet (without cloning)
     #
     # @param received_time [Time] Time this packet was received
@@ -129,12 +235,6 @@ module Cosmos
       end
     end
 
-    # Sets the received count of the packet
-    #
-    # @param received_count [Integer] Number of times this packet has been
-    #   received
-    # def received_count=(received_count)
-
     # Sets the hazardous description of the packet
     #
     # @param hazardous_description [String] Hazardous description of the packet
@@ -539,20 +639,6 @@ module Cosmos
       return super(value_type, indent, buffer)
     end
 
-    # Tries to identify if a buffer represents the currently defined packet. It
-    # does this by iterating over all the packet items that were created with
-    # an ID value and checking whether that ID value is present at the correct
-    # location in the buffer.
-    #
-    # Incorrectly sized buffers will still positively identify if there is
-    # enough data to match the ID values. This is to allow incorrectly sized
-    # packets to still be processed as well as possible given the incorrectly
-    # sized data.
-    #
-    # @param buffer [String] Raw buffer of binary data
-    # @return [Boolean] Whether or not the buffer of data is this packet
-    # def identify?(buffer)
-
     # Restore all items in the packet to their default value
     #
     # @param buffer [String] Raw buffer of binary data

data/lib/cosmos/packets/packet_config.rb

@@ -73,10 +73,8 @@ module Cosmos
       @warnings = []
 
       # Create unknown packets
-      @commands['UNKNOWN']
       @commands['UNKNOWN'] = {}
       @commands['UNKNOWN']['UNKNOWN'] = Packet.new('UNKNOWN', 'UNKNOWN', :BIG_ENDIAN)
-      @telemetry['UNKNOWN']
       @telemetry['UNKNOWN'] = {}
       @telemetry['UNKNOWN']['UNKNOWN'] = Packet.new('UNKNOWN', 'UNKNOWN', :BIG_ENDIAN)
 

data/lib/cosmos/packets/parsers/packet_item_parser.rb

@@ -131,8 +131,16 @@ module Cosmos
 
       index = append? ? 3 : 4
       data_type = get_data_type()
-      if data_type == :STRING or data_type == :BLOCK
-        return @parser.parameters[index]
+      if data_type == :STRING or data_type == :BLOCK        
+        # If the default value is 0x<data> (no quotes), it is treated as
+        # binary data.  Otherwise, the default value is considered to be a string.
+        if (@parser.parameters[index].upcase.start_with?("0X")         and
+            !@parser.line.include?("\"#{@parser.parameters[index]}\"") and
+            !@parser.line.include?("\'#{@parser.parameters[index]}\'"))
+          return @parser.parameters[index].hex_to_byte_string
+        else
+          return @parser.parameters[index]
+        end
       else
         return ConfigParser.handle_defined_constants(
           @parser.parameters[index+2].convert_to_value, get_data_type(), get_bit_size())

data/lib/cosmos/packets/structure.rb

@@ -10,7 +10,7 @@
 
 require 'cosmos/packets/binary_accessor'
 require 'cosmos/packets/structure_item'
-require 'cosmos/ext/packet'
+require 'cosmos/ext/packet' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
 
 module Cosmos
 
@@ -44,21 +44,87 @@ module Cosmos
     #   required data size is allowed.
     attr_accessor :short_buffer_allowed
 
-    # String providing a single 0 byte
-    # ZERO_STRING = "\000"
-    # ZERO_STRING.freeze
+    if RUBY_ENGINE != 'ruby' or ENV['COSMOS_NO_EXT']
+      # Used to force encoding
+      ASCII_8BIT_STRING = "ASCII-8BIT".freeze
+
+      # String providing a single 0 byte
+      ZERO_STRING = "\000".freeze
+
+      # Structure constructor
+      #
+      # @param default_endianness [Symbol] Must be one of
+      #   {BinaryAccessor::ENDIANNESS}. By default it uses
+      #   BinaryAccessor::HOST_ENDIANNESS to determine the endianness of the host platform.
+      # @param buffer [String] Buffer used to store the structure
+      # @param item_class [Class] Class used to instantiate new structure items.
+      #   Must be StructureItem or one of its subclasses.
+      def initialize(default_endianness = BinaryAccessor::HOST_ENDIANNESS, buffer = '', item_class = StructureItem)
+        if (default_endianness == :BIG_ENDIAN) || (default_endianness == :LITTLE_ENDIAN)
+          @default_endianness = default_endianness
+          if buffer
+            raise TypeError, "wrong argument type #{buffer.class} (expected String)" unless String === buffer
+            @buffer = buffer.force_encoding(ASCII_8BIT_STRING)
+          else
+            @buffer = nil
+          end
+          @item_class = item_class
+          @items = {}
+          @sorted_items = []
+          @defined_length = 0
+          @defined_length_bits = 0
+          @pos_bit_size = 0
+          @neg_bit_size = 0
+          @fixed_size = true
+          @short_buffer_allowed = false
+          @mutex = nil
+        else
+          raise(ArgumentError, "Unrecognized endianness: #{default_endianness} - Must be :BIG_ENDIAN or :LITTLE_ENDIAN")
+        end
+      end
 
-    # Structure constructor
-    #
-    # @param default_endianness [Symbol] Must be one of
-    #   {BinaryAccessor::ENDIANNESS}. By default it uses
-    #   BinaryAccessor::HOST_ENDIANNESS to determine the endianness of the host platform.
-    # @param buffer [String] Buffer used to store the structure
-    # @param item_class [Class] Class used to instantiate new structure items.
-    #   Must be StructureItem or one of its subclasses.
-    # def initialize(default_endianness = BinaryAccessor::HOST_ENDIANNESS,
-    #               buffer = '',
-    #               item_class = StructureItem)
+      # Read an item in the structure
+      #
+      # @param item [StructureItem] Instance of StructureItem or one of its subclasses
+      # @param value_type [Symbol] Not used. Subclasses should overload this
+      #   parameter to check whether to perform conversions on the item.
+      # @param buffer [String] The binary buffer to read the item from
+      # @return Value based on the item definition. This could be a string, integer,
+      #   float, or array of values.
+      def read_item(item, value_type = :RAW, buffer = @buffer)
+        return nil if item.data_type == :DERIVED
+
+        if buffer
+          if item.array_size
+            return BinaryAccessor.read_array(item.bit_offset, item.bit_size, item.data_type, item.array_size, buffer, item.endianness)
+          else
+            return BinaryAccessor.read(item.bit_offset, item.bit_size, item.data_type, buffer, item.endianness)
+          end
+        else
+          raise "No buffer given to read_item"
+        end
+      end
+
+      # Get the length of the buffer used by the structure
+      #
+      # @return [Integer] Size of the buffer in bytes
+      def length
+        return @buffer.length if @buffer
+        return 0
+      end
+
+      # Resize the buffer at least the defined length of the structure
+      def resize_buffer
+        if @buffer
+          # Extend data size
+          if @buffer.length < @defined_length
+            @buffer << (ZERO_STRING * (@defined_length - @buffer.length))
+          end
+        end
+
+        return self
+      end
+    end
 
     # Indicates if any items have been defined for this structure
     # @return [TrueClass or FalseClass]
@@ -229,16 +295,6 @@ module Cosmos
       end
     end
 
-    # Read an item in the structure
-    #
-    # @param item [StructureItem] Instance of StructureItem or one of its subclasses
-    # @param value_type [Symbol] Not used. Subclasses should overload this
-    #   parameter to check whether to perform conversions on the item.
-    # @param buffer [String] The binary buffer to read the item from
-    # @return Value based on the item definition. This could be a string, integer,
-    #   float, or array of values.
-    # def read_item(item, value_type = :RAW, buffer = @buffer)
-
     # Write a value to the buffer based on the item definition
     #
     # @param item [StructureItem] Instance of StructureItem or one of its subclasses
@@ -330,11 +386,6 @@ module Cosmos
       return string
     end
 
-    # Get the length of the buffer used by the structure
-    #
-    # @return [Integer] Size of the buffer in bytes
-    # def length
-
     # Get the buffer used by the structure. The current buffer is copied and
     # thus modifications to the returned buffer will have no effect on the
     # structure items.
@@ -438,9 +489,6 @@ module Cosmos
       end
     end
 
-    # Resize the buffer at least the defined length of the structure
-    # def resize_buffer
-
     def internal_buffer_equals(buffer)
       raise ArgumentError, "Buffer class is #{buffer.class} but must be String" unless String === buffer
       @buffer = buffer.dup