cosmos 4.1.1-java → 4.2.0-java

data/lib/cosmos/gui/widgets/packet_log_frame.rb

@@ -13,6 +13,19 @@ require 'cosmos/gui/qt'
 require 'cosmos/gui/dialogs/calendar_dialog'
 
 module Cosmos
+
+  class PacketLogFrameListWidget < Qt::ListWidget
+    attr_accessor :delete_callback
+
+    def keyPressEvent(event)
+      case event.key
+      when Qt::Key_Delete, Qt::Key_Backspace
+        @delete_callback.call if @delete_callback
+      end
+      super(event)
+    end
+  end
+
   # Widget which displays a button to browse for log files. Files are listed
   # and can be removed. Buttons exist to display start and stop time choosers
   # which apply to all files in the list. The widget can also show a button
@@ -88,8 +101,8 @@ module Cosmos
       row = 0
 
       # Chooser for Log Files
-      label = Qt::Label.new('Log Files:')
-      @layout.addWidget(label, row, 0, 1, 2)
+      @log_files_label = Qt::Label.new('Log Files:')
+      @layout.addWidget(@log_files_label, row, 0, 1, 2)
       @browse_button = Qt::PushButton.new('Browse...')
       @browse_button.connect(SIGNAL('clicked()')) { handle_browse_button() }
       @layout.addWidget(@browse_button, row, 2)
@@ -98,13 +111,10 @@ module Cosmos
       @layout.addWidget(@remove_button, row, 3)
       row += 1
 
-      @filenames = Qt::ListWidget.new(self)
+      @filenames = PacketLogFrameListWidget.new(self)
       @filenames.setSelectionMode(Qt::AbstractItemView::ExtendedSelection)
       @filenames.setSortingEnabled(true)
-      delete = Qt::Shortcut.new(Qt::KeySequence.new(Qt::Key_Delete), @filenames)
-      delete.connect(SIGNAL('activated()')) { handle_remove_button }
-      backspace = Qt::Shortcut.new(Qt::KeySequence.new(Qt::Key_Backspace), @filenames)
-      backspace.connect(SIGNAL('activated()')) { handle_remove_button }
+      @filenames.delete_callback = method(:handle_remove_button)
       initial_filenames.each {|filename| @filenames.addItem(filename)}
       @filenames.setMinimumHeight(90)
       @layout.addWidget(@filenames, row, 0, 3, 4)
@@ -152,15 +162,15 @@ module Cosmos
         @packet_log_reader = PacketLogReader.new unless @packet_log_reader
 
         # Chooser or label for log reader
-        label = Qt::Label.new('Packet Log Reader:')
-        @layout.addWidget(label, row, 0)
+        @packet_log_reader_label = Qt::Label.new('Packet Log Reader:')
+        @layout.addWidget(@packet_log_reader_label, row, 0)
         @packet_log_reader_field = Qt::LineEdit.new(@packet_log_reader.class.to_s)
         @packet_log_reader_field.setMinimumWidth(340)
         @packet_log_reader_field.setReadOnly(true)
         @layout.addWidget(@packet_log_reader_field, row, 1, 1, 2)
-        select_button = Qt::PushButton.new('Select')
-        select_button.connect(SIGNAL('clicked()')) { handle_log_reader_button() }
-        @layout.addWidget(select_button, row, 3)
+        @plr_select_button = Qt::PushButton.new('Select')
+        @plr_select_button.connect(SIGNAL('clicked()')) { handle_log_reader_button() }
+        @layout.addWidget(@plr_select_button, row, 3)
         row += 1
       end
 
@@ -216,6 +226,26 @@ module Cosmos
       end
     end
 
+    def show_log_fields(show_fields)
+      if show_fields
+        @filenames.show if @filenames
+        @log_files_label.show if @log_files_label
+        @browse_button.show if @browse_button
+        @remove_button.show if @remove_button
+        @packet_log_reader_field.show if @packet_log_reader_field
+        @packet_log_reader_label.show if @packet_log_reader_label
+        @plr_select_button.show if @plr_select_button
+      else
+        @filenames.hide if @filenames
+        @log_files_label.hide if @log_files_label
+        @browse_button.hide if @browse_button
+        @remove_button.hide if @remove_button
+        @packet_log_reader_field.hide if @packet_log_reader_field
+        @packet_log_reader_label.hide if @packet_log_reader_label
+        @plr_select_button.hide if @plr_select_button
+      end
+    end
+
     protected
 
     # Handles removing a selected filename

data/lib/cosmos/interfaces/interface.rb

@@ -394,9 +394,8 @@ module Cosmos
     # implement this method and call super to count the raw bytes and allow raw
     # logging.
     #
-    #
     # @param data [String] Raw packet data
-    # @return data [String] The exact data written
+    # @return [String] The exact data written
     def write_interface_base(data)
       @written_raw_data_time = Time.now
       @written_raw_data = data.clone

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

@@ -64,15 +64,32 @@ module Cosmos
         raise "Invalid endianness '#{endianness}'. Must be BIG_ENDIAN or LITTLE_ENDIAN."
       end
 
-      @bit_offset = Integer(bit_offset)
-      raise "Invalid bit offset of #{bit_offset}. Must be divisible by 8." if bit_offset % 8 != 0
-      @bit_size = Integer(bit_size)
-      poly = Integer(poly) if poly
-      seed = Integer(seed) if seed
-      xor = ConfigParser.handle_true_false(xor) if xor
+      begin
+        @bit_offset = Integer(bit_offset)
+      rescue
+        raise "Invalid bit offset of #{bit_offset}. Must be a number."
+      end
+      raise "Invalid bit offset of #{bit_offset}. Must be divisible by 8." if @bit_offset % 8 != 0
+
+      poly = ConfigParser.handle_nil(poly)
+      begin
+        poly = Integer(poly) if poly
+      rescue
+        raise "Invalid polynomial of #{poly}. Must be a number."
+      end
+
+      seed = ConfigParser.handle_nil(seed)
+      begin
+        seed = Integer(seed) if seed
+      rescue
+        raise "Invalid seed of #{seed}. Must be a number."
+      end
+
+      xor = ConfigParser.handle_true_false_nil(xor)
       raise "Invalid XOR value of '#{xor}'. Must be TRUE or FALSE." if xor && !!xor != xor
-      reflect = ConfigParser.handle_true_false(reflect) if reflect
+      reflect = ConfigParser.handle_true_false_nil(reflect) if reflect
       raise "Invalid reflect value of '#{reflect}'. Must be TRUE or FALSE." if reflect && !!reflect != reflect
+
       # Built the CRC arguments array. All subsequent arguments are dependent
       # on the previous ones so we build it up incrementally.
       args = []
@@ -89,7 +106,8 @@ module Cosmos
         end
       end
 
-      case bit_size
+      @bit_size = bit_size.to_i
+      case @bit_size
       when 16
         @pack = (@endianness == :BIG_ENDIAN) ? 'n' : 'v'
         if args.empty?

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

@@ -39,6 +39,9 @@ module Cosmos
       @min_id_size = Integer(min_id_size)
       @telemetry = telemetry
       @unknown_raise = ConfigParser::handle_true_false(unknown_raise)
+      @received_time = nil
+      @target_name = nil
+      @packet_name = nil
     end
 
     # Set the received_time, target_name and packet_name which we recorded when
@@ -77,7 +80,7 @@ module Cosmos
         end
 
         target_packets.each do |packet_name, packet|
-          if (packet.identify?(@data))
+          if packet.identify?(@data)
             identified_packet = packet
             if identified_packet.defined_length > @data.length
               # Check if need more data to finish packet
@@ -100,7 +103,10 @@ module Cosmos
 
       unless identified_packet
         raise "Unknown data received by FixedProtocol" if @unknown_raise
-        # Unknown packet?  Just return all the current data
+        # Unknown packet? Just return all the current data
+        @received_time = nil
+        @target_name = nil
+        @packet_name = nil
         packet_data = @data.clone
         @data.replace('')
       end

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

@@ -9,10 +9,11 @@
 # attribution addendums as found in the LICENSE.txt
 
 require 'cosmos/config/config_parser'
-require 'cosmos/interfaces/protocols/protocol'
 require 'thread'
 
 module Cosmos
+  # Base class for all COSMOS protocols which defines a framework which must be
+  # implemented by a subclass.
   class Protocol
     attr_accessor :interface
     attr_accessor :allow_empty_data

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

@@ -225,7 +225,7 @@ module Cosmos
 
         # Block the write until the response is received
         begin
-          result = @write_block_queue.pop(true)
+          @write_block_queue.pop(true)
         rescue
           sleep(@response_polling_period)
           retry if !response_timeout_time

data/lib/cosmos/interfaces/stream_interface.rb

@@ -17,6 +17,7 @@ module Cosmos
 
     def initialize(protocol_type = nil, protocol_args = [])
       super()
+      @stream = nil
       @protocol_type = ConfigParser::handle_nil(protocol_type)
       @protocol_args = protocol_args
       if @protocol_type

data/lib/cosmos/interfaces/tcpip_server_interface.rb

@@ -161,8 +161,7 @@ module Cosmos
     end
 
     # Shutdowns the listener threads for both the read and write ports as well
-    # as any client connections. As a part of shutting down client connections,
-    # the {Protocol#disconnect} method is called.
+    # as any client connections.
     def disconnect
       @cancel_threads = true
       @read_queue << nil if @read_queue
@@ -227,7 +226,7 @@ module Cosmos
     def write(packet)
       raise "Interface not connected for write: #{@name}" unless connected? && write_allowed?
       @write_count += 1
-      @write_queue << packet
+      @write_queue << packet.clone
       @write_condition_variable.broadcast
     end
 

data/lib/cosmos/io/json_drb_object.rb

@@ -38,7 +38,7 @@ module Cosmos
     def initialize(hostname, port, connect_timeout = 1.0)
       hostname = '127.0.0.1' if (hostname.to_s.upcase == 'LOCALHOST')
       begin
-        addr = Socket.pack_sockaddr_in(port, hostname)
+        Socket.pack_sockaddr_in(port, hostname)
       rescue => error
         if error.message =~ /getaddrinfo/
           raise "Invalid hostname: #{hostname}"

data/lib/cosmos/io/json_rpc.rb

@@ -9,6 +9,7 @@
 # attribution addendums as found in the LICENSE.txt
 
 require 'json'
+require 'date'
 
 class Object
   def as_json(options = nil) #:nodoc:
@@ -271,7 +272,7 @@ module Cosmos
       begin
         hash = JSON.parse(response_data, :allow_nan => true, :create_additions => true)
       rescue
-        raise msg
+        raise $!, msg, $!.backtrace
       end
 
       # Verify the jsonrpc version is correct and there is an ID

data/lib/cosmos/io/win32_serial_driver.rb

@@ -8,15 +8,12 @@
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
 
-require 'cosmos/io/serial_driver'
 require 'cosmos/win32/win32'
 require 'timeout' # For Timeout::Error
 
 module Cosmos
-
   # Serial driver for use on Windows serial ports
   class Win32SerialDriver
-
     # (see SerialDriver#initialize)
     def initialize(port_name = 'COM1',
                    baud_rate = 9600,
@@ -150,16 +147,12 @@ module Cosmos
     # (see SerialDriver#read_nonblock)
     def read_nonblock
       data = ''
-
       loop do
         buffer = Win32.read_file(@handle, @read_max_length - data.length)
         data << buffer
         break if buffer.length <= 0 or data.length >= @read_max_length
       end
-
       data
     end
-
-  end # class Win32SerialDriver
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/packet_logs/packet_log_writer.rb

@@ -138,7 +138,7 @@ module Cosmos
       new_label = label.to_s.strip
       if new_label.length == 0
         @label = nil
-      elsif new_label =~ /^[a-zA-Z0-9]*$/
+      elsif new_label =~ /^[a-zA-Z0-9_-]*$/
         @label = new_label
       else
         # Invalid label - Clear out existing

data/lib/cosmos/packets/packet.rb

@@ -14,13 +14,11 @@ require 'cosmos/packets/packet_item'
 require 'cosmos/ext/packet' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
 
 module Cosmos
-
   # Adds features common to all COSMOS packets of data to the Structure class.
   # This includes the additional attributes listed below. The primary behavior
   # Packet adds is the ability to apply formatting to PacketItem values as well
   # as managing PacketItem's limit states.
   class Packet < Structure
-
     RESERVED_ITEM_NAMES = ['RECEIVED_TIMESECONDS'.freeze, 'RECEIVED_TIMEFORMATTED'.freeze, 'RECEIVED_COUNT'.freeze]
 
     # @return [String] Name of the target this packet is associated with
@@ -207,8 +205,7 @@ module Cosmos
 
         true
       end
-
-    end
+    end # if RUBY_ENGINE != 'ruby' or ENV['COSMOS_NO_EXT']
 
     # Calculates a unique MD5Sum that changes if the parts of the packet configuration change that could affect
     # the "shape" of the packet.  This value is cached and that packet should not be changed if this method is being used
@@ -339,9 +336,7 @@ module Cosmos
       else
         next_offset = nil
         if item.bit_offset > 0
-          # Handle little-endian bit fields
-          byte_aligned = ((item.bit_offset % 8) == 0)
-          if item.endianness == :LITTLE_ENDIAN and (item.data_type == :INT or item.data_type == :UINT) and !(byte_aligned and (item.bit_size == 8 or item.bit_size == 16 or item.bit_size == 32 or item.bit_size == 64))
+          if item.little_endian_bit_field?
             # Bit offset always refers to the most significant bit of a bitfield
             bits_remaining_in_last_byte = 8 - (item.bit_offset % 8)
             if item.bit_size > bits_remaining_in_last_byte
@@ -673,6 +668,19 @@ module Cosmos
       end
     end
 
+    # Define the reserved items on the current telemetry packet
+    def define_reserved_items
+      item = define_item('RECEIVED_TIMESECONDS', 0, 0, :DERIVED, nil, @default_endianness,
+                         :ERROR, '%0.6f', ReceivedTimeSecondsConversion.new)
+      item.description = 'COSMOS Received Time (UTC, Floating point, Unix epoch)'
+      item = define_item('RECEIVED_TIMEFORMATTED', 0, 0, :DERIVED, nil, @default_endianness,
+                         :ERROR, nil, ReceivedTimeFormattedConversion.new)
+      item.description = 'COSMOS Received Time (Local time zone, Formatted string)'
+      item = define_item('RECEIVED_COUNT', 0, 0, :DERIVED, nil, @default_endianness,
+                         :ERROR, nil, ReceivedCountConversion.new)
+      item.description = 'COSMOS packet received count'
+    end
+
     # Enable limits on an item by name
     #
     # @param name [String] Name of the item to enable limits
@@ -773,6 +781,9 @@ module Cosmos
     # Reset temporary packet data
     # This includes packet received time, received count, and processor state
     def reset
+      # The SYSTEM META packet is a special case that does not get reset
+      return if @target_name == 'SYSTEM' && @packet_name == 'META'
+
       @received_time = nil
       @received_count = 0
       if @read_conversion_cache
@@ -860,7 +871,8 @@ module Cosmos
 
     protected
 
-    # Performs packet specific processing on the packet.  Intended to only be run once for each packet received
+    # Performs packet specific processing on the packet.
+    # Intended to only be run once for each packet received
     def process(buffer = @buffer)
       return unless @processors
       @processors.each do |processor_name, processor|
@@ -988,7 +1000,5 @@ module Cosmos
       end
       item
     end
-
-  end # class Packet
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/packets/packet_config.rb

@@ -109,6 +109,7 @@ module Cosmos
 
       process_target_name = process_target_name.upcase
       parser = ConfigParser.new("http://cosmosrb.com/docs/cmdtlm")
+      parser.instance_variable_set(:@target_name, process_target_name)
       parser.parse_file(filename) do |keyword, params|
 
         if @building_generic_conversion
@@ -532,7 +533,7 @@ module Cosmos
 
     def start_item(parser)
       finish_item()
-      @current_item = PacketItemParser.parse(parser, @current_packet, @current_cmd_or_tlm)
+      @current_item = PacketItemParser.parse(parser, @current_packet, @current_cmd_or_tlm, @warnings)
       MacroParser.new_item()
     end
 

data/lib/cosmos/packets/packet_item.rb

@@ -348,33 +348,11 @@ module Cosmos
       else # :COMMAND
         if self.array_size
           config << "  ARRAY_PARAMETER #{self.name.to_s.quote_if_necessary} #{self.bit_offset} #{self.bit_size} #{self.data_type} #{self.array_size} \"#{self.description.to_s.gsub("\"", "'")}\""
-        elsif self.id_value
-          if self.data_type == :BLOCK or self.data_type == :STRING
-            unless self.id_value.is_printable?
-              id_value = "0x" + self.id_value.simple_formatted
-            else
-              id_value = "\"#{self.id_value}\""
-            end
-            config << "  ID_PARAMETER #{self.name.to_s.quote_if_necessary} #{self.bit_offset} #{self.bit_size} #{self.data_type} #{id_value} \"#{self.description.to_s.gsub("\"", "'")}\""
-          else
-            first, last = calculate_range()
-            config << "  ID_PARAMETER #{self.name.to_s.quote_if_necessary} #{self.bit_offset} #{self.bit_size} #{self.data_type} #{first} #{last} #{self.id_value} \"#{self.description.to_s.gsub("\"", "'")}\""
-          end
         else
-          if self.data_type == :BLOCK or self.data_type == :STRING
-            unless self.default.is_printable?
-              default = "0x" + self.default.simple_formatted
-            else
-              default = "\"#{self.default}\""
-            end
-            config << "  PARAMETER #{self.name.to_s.quote_if_necessary} #{self.bit_offset} #{self.bit_size} #{self.data_type} #{default} \"#{self.description.to_s.gsub("\"", "'")}\""
-          else
-            first, last = calculate_range()
-            config << "  PARAMETER #{self.name.to_s.quote_if_necessary} #{self.bit_offset} #{self.bit_size} #{self.data_type} #{first} #{last} #{self.default} \"#{self.description.to_s.gsub("\"", "'")}\""
-          end
+          config << parameter_config()
         end
       end
-      config << " #{self.endianness}" if self.endianness != default_endianness
+      config << " #{self.endianness}" if (self.endianness != default_endianness && self.data_type != :STRING && self.data_type != :BLOCK)
       config << "\n"
 
       config << "    REQUIRED\n" if self.required
@@ -423,6 +401,30 @@ module Cosmos
 
     protected
 
+    def parameter_config
+      if @id_value
+        value = @id_value
+        config = "  ID_PARAMETER "
+      else
+        value = @default
+        config = "  PARAMETER "
+      end
+      config << "#{@name.to_s.quote_if_necessary} #{@bit_offset} #{@bit_size} #{@data_type} "
+
+      if @data_type == :BLOCK || @data_type == :STRING
+        unless value.is_printable?
+          val_string = "0x" + value.simple_formatted
+        else
+          val_string = "\"#{value}\""
+        end
+      else
+        first, last = calculate_range()
+        config << "#{first} #{last} "
+        val_string = value.to_s
+      end
+      config << "#{val_string} \"#{@description.to_s.gsub("\"", "'")}\""
+    end
+
     # Convert a value into the given data type
     def convert(value, data_type)
       case data_type