cosmos 4.2.4-java → 4.3.0-java

data/lib/cosmos/packets/packet.rb

@@ -19,7 +19,8 @@ module Cosmos
   # 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]
+    RESERVED_ITEM_NAMES = ['PACKET_TIMESECONDS'.freeze, 'PACKET_TIMEFORMATTED'.freeze, 'RECEIVED_TIMESECONDS'.freeze, 'RECEIVED_TIMEFORMATTED'.freeze, 'RECEIVED_COUNT'.freeze]
+    CATCH_ALL_STATE = 'ANY'
 
     # @return [String] Name of the target this packet is associated with
     attr_reader :target_name
@@ -66,6 +67,12 @@ module Cosmos
     # @return [Boolean] Whether or not this is a 'abstract' packet
     attr_accessor :abstract
 
+    # @return [Boolean] Whether or not this was a stored packet
+    attr_accessor :stored
+
+    # @return [Hash] Extra data to be logged/transferred with packet
+    attr_accessor :extra
+
     # Valid format types
     VALUE_TYPES = [:RAW, :CONVERTED, :FORMATTED, :WITH_UNITS]
 
@@ -100,6 +107,8 @@ module Cosmos
         @meta = nil
         @hidden = false
         @disabled = false
+        @stored = false
+        @extra = nil
       end
 
       # Sets the target name this packet is associated with. Unidentified packets
@@ -207,6 +216,17 @@ module Cosmos
       end
     end # if RUBY_ENGINE != 'ruby' or ENV['COSMOS_NO_EXT']
 
+    # Returns @received_time unless a packet item called PACKET_TIME exists that returns
+    # a Ruby Time object that represents a different timestamp for the packet
+    def packet_time
+      item = @items['PACKET_TIME'.freeze]
+      if item
+        return read_item(item, :CONVERTED, @buffer)
+      else
+        return @received_time
+      end
+    end
+
     # 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
     def config_name
@@ -529,6 +549,8 @@ module Cosmos
             value = value.map do |val, index|
               if item.states.key(val)
                 item.states.key(val)
+              elsif item.states.values.include?(CATCH_ALL_STATE)
+                item.states.key(CATCH_ALL_STATE)
               else
                 apply_format_string_and_units(item, val, value_type)
               end
@@ -537,6 +559,8 @@ module Cosmos
             state_value = item.states.key(value)
             if state_value
               value = state_value
+            elsif item.states.values.include?(CATCH_ALL_STATE)
+              value = item.states.key(CATCH_ALL_STATE)
             else
               value = apply_format_string_and_units(item, value, value_type)
             end
@@ -670,6 +694,12 @@ module Cosmos
 
     # Define the reserved items on the current telemetry packet
     def define_reserved_items
+      item = define_item('PACKET_TIMESECONDS', 0, 0, :DERIVED, nil, @default_endianness,
+                         :ERROR, '%0.6f', PacketTimeSecondsConversion.new)
+      item.description = 'COSMOS Packet Time (UTC, Floating point, Unix epoch)'
+      item = define_item('PACKET_TIMEFORMATTED', 0, 0, :DERIVED, nil, @default_endianness,
+                         :ERROR, nil, PacketTimeFormattedConversion.new)
+      item.description = 'COSMOS Packet Time (Local time zone, Formatted string)'
       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)'
@@ -750,7 +780,8 @@ module Cosmos
     def check_limits(limits_set = :DEFAULT, ignore_persistence = false)
       # If check_limits is being called, then a new packet has arrived and
       # this packet is no longer stale
-      if @stale
+      # Stored telemetry doesn't affect the current value table and such doesn't affect stale
+      if @stale and !@stored
         @stale = false
         set_all_limits_states(nil)
       end
@@ -786,6 +817,8 @@ module Cosmos
 
       @received_time = nil
       @received_count = 0
+      @stored = false
+      @extra = nil
       if @read_conversion_cache
         synchronize() do
           @read_conversion_cache.clear
@@ -811,6 +844,7 @@ module Cosmos
         end
       end
       packet.instance_variable_set("@read_conversion_cache".freeze, nil)
+      packet.extra = JSON.parse(packet.extra.to_json) if packet.extra # Deep copy using JSON
       packet
     end
     alias dup clone

data/lib/cosmos/packets/packet_config.rb

@@ -472,7 +472,6 @@ module Cosmos
 
       # Define the units of the current telemetry item
       when 'UNITS'
-        raise parser.error("Items with STATE can't define UNITS") if @current_item.states
         usage = "UNITS <FULL UNITS NAME> <ABBREVIATED UNITS NAME>"
         parser.verify_num_parameters(2, 2, usage)
         @current_item.units_full = params[0]

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

@@ -14,7 +14,6 @@ module Cosmos
     # @param parser [ConfigParser] Configuration parser
     # @param item [Packet] The current item
     def self.parse(parser, item)
-      raise parser.error("Items with STATE can't define FORMAT_STRING") if item.states
       @parser = FormatStringParser.new(parser)
       @parser.verify_parameters()
       @parser.create_format_string(item)

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

@@ -650,7 +650,7 @@ module Cosmos
         if base_packet
           count = 0
           base_packet.sorted_items.each do |item|
-            unless ['RECEIVED_TIMESECONDS', 'RECEIVED_TIMEFORMATTED', 'RECEIVED_COUNT'].include?(item.name)
+            unless ['PACKET_TIMESECONDS', 'PACKET_TIMEFORMATTED', 'RECEIVED_TIMESECONDS', 'RECEIVED_TIMEFORMATTED', 'RECEIVED_COUNT'].include?(item.name)
               begin
                 @current_packet.get_item(item.name)
               rescue

data/lib/cosmos/packets/telemetry.rb

@@ -290,6 +290,8 @@ module Cosmos
         identified_packet = identified_packet.clone
         identified_packet.buffer = packet.buffer
         identified_packet.received_time = packet.received_time
+        identified_packet.stored = packet.stored
+        identified_packet.extra = packet.extra
         return identified_packet
       end
 
@@ -302,6 +304,8 @@ module Cosmos
         identified_packet = identified_packet.clone
         identified_packet.buffer = packet.buffer
         identified_packet.received_time = packet.received_time
+        identified_packet.stored = packet.stored
+        identified_packet.extra = packet.extra
         return identified_packet
       end
 

data/lib/cosmos/script/api_shared.rb

@@ -789,6 +789,8 @@ module Cosmos
     def cosmos_script_sleep(sleep_time = nil)
       return false if $disconnected_targets
       if defined? ScriptRunnerFrame and ScriptRunnerFrame.instance
+        ScriptRunnerFrame.instance.active_script_highlight('green')
+
         sleep_time = 30000000 unless sleep_time # Handle infinite wait
         if sleep_time > 0.0
           end_time = Time.now.sys + sleep_time

data/lib/cosmos/script/limits.rb

@@ -98,6 +98,10 @@ module Cosmos
         if result[0] == :LIMITS_CHANGE
           result[1][3] = result[1][3].to_s.intern if result[1][3]
           result[1][4] = result[1][4].to_s.intern if result[1][4]
+          if result[1][5] and result[1][6]
+            result[1][5] = Time.at(result[1][5], result[1][6]).sys
+            result[1].delete_at(6)
+          end
         elsif result[0] == :LIMITS_SETTINGS
           result[1][3] = result[1][3].to_s.intern if result[1][3]
         elsif result[0] == :STALE_PACKET

data/lib/cosmos/script/script.rb

@@ -21,6 +21,7 @@ require 'cosmos/script/tools'
 
 $cmd_tlm_server = nil
 $disconnected_targets = nil
+$disconnect_all_targets = false
 $cmd_tlm_replay_mode = false
 
 module Cosmos
@@ -58,16 +59,6 @@ module Cosmos
     # us to proxy the methods to either the disconnected CmdTlmServer object
     # or to the real server through the JsonDRbObject.
     def method_missing(method_name, *method_params)
-      if $disconnected_targets && method_params[0].is_a?(String)
-        if method_params.length == 1
-          target = method_params[0].split(" ")[0]
-        else
-          target = method_params[0]
-        end
-        if $disconnected_targets.include?(target)
-          return @disconnected.send(method_name, *method_params)
-        end
-      end
       # Must call shutdown and disconnect on the JsonDrbObject itself
       # to avoid it being sent to the CmdTlmServer
       case method_name
@@ -77,6 +68,28 @@ module Cosmos
       when :disconnect
         @cmd_tlm_server.disconnect
       else
+        if $disconnect_all_targets
+          return @disconnected.send(method_name, *method_params)
+        elsif $disconnected_targets
+          name_string = nil
+          if method_params[0].is_a?(String)
+            name_string = method_params[0]
+          elsif method_params[0].is_a?(Array)
+            if method_params[0][0].is_a?(Array)
+              if method_params[0][0][0].is_a?(String)
+                name_string = method_params[0][0][0]
+              end
+            elsif method_params[0][0].is_a?(String)
+              name_string = method_params[0][0]
+            end
+          end
+          if name_string
+            target = name_string.split(" ")[0]
+            if $disconnected_targets.include?(target)
+              return @disconnected.send(method_name, *method_params)
+            end
+          end
+        end
         @cmd_tlm_server.method_missing(method_name, *method_params)
       end
     end
@@ -95,6 +108,7 @@ module Cosmos
     # Called when this module is mixed in using "include Cosmos::Script"
     def self.included(base)
       $disconnected_targets = nil
+      $disconnect_all_targets = false
       $cmd_tlm_replay_mode = false
       $cmd_tlm_server = nil
       initialize_script_module()
@@ -109,8 +123,9 @@ module Cosmos
       $cmd_tlm_server.shutdown if $cmd_tlm_server
     end
 
-    def set_disconnected_targets(targets, config_file = CmdTlmServer::DEFAULT_CONFIG_FILE)
+    def set_disconnected_targets(targets, all = false, config_file = CmdTlmServer::DEFAULT_CONFIG_FILE)
       $disconnected_targets = targets
+      $disconnect_all_targets = all
       initialize_script_module(config_file)
     end
 
@@ -120,6 +135,7 @@ module Cosmos
 
     def clear_disconnected_targets
       $disconnected_targets = nil
+      $disconnect_all_targets = false
     end
 
     def script_disconnect

data/lib/cosmos/script/telemetry.rb

@@ -203,12 +203,14 @@ module Cosmos
       packet = nil
       # The get_packet_data above returns a Ruby time after the packet_name.
       # This is different from the API.s
-      buffer, target_name, packet_name, time, rx_count = get_packet_data(id, non_block)
+      buffer, target_name, packet_name, time, rx_count, stored, extra = get_packet_data(id, non_block)
       if buffer
         packet = System.telemetry.packet(target_name, packet_name).clone
         packet.buffer = buffer
         packet.received_time = time
         packet.received_count = rx_count
+        packet.stored = stored
+        packet.extra = extra
       end
       packet
     end

data/lib/cosmos/script/tools.rb

@@ -67,20 +67,20 @@ module Cosmos
     # Methods for debugging
     #######################################
 
-    def insert_return(*params)
-      _ensure_script_runner_frame do
-        ScriptRunnerFrame.instance.inline_return = true
-        ScriptRunnerFrame.instance.inline_return_params = params
-      end
-    end
-
     def step_mode
       if defined? ScriptRunnerFrame
+        # Ensure the Frame has toggled to debug so the user can see the Step button
+        _ensure_script_runner_frame do
+          Qt.execute_in_main_thread do
+            ScriptRunnerFrame.instance.toggle_debug(true)
+          end
+        end
         ScriptRunnerFrame.step_mode = true
       end
     end
 
     def run_mode
+      # Run mode simply disables step mode. Debug frame may or may not be displayed.
       if defined? ScriptRunnerFrame
         ScriptRunnerFrame.step_mode = false
       end
@@ -104,7 +104,17 @@ module Cosmos
     # Get a specific screen definition
     def get_screen_definition(screen_full_name, config_filename = nil, force_refresh = false)
       $cmd_tlm_server.get_screen_definition(screen_full_name, config_filename, force_refresh)
-    end  
+    end
+
+    # Show a local telemetry screen
+    def local_screen(title = 'Local Screen', screen_def = nil, x_pos = nil, y_pos = nil, &block)
+      # See script_module_gui.rb
+    end
+
+    # Close all local telemetry screens
+    def close_local_screens
+      # See script_module_gui.rb
+    end
 
   end # module Script
 

data/lib/cosmos/system/system.rb

@@ -71,6 +71,8 @@ module Cosmos
     #   calculation in addition to the cmd/tlm definition files that are
     #   automatically included
     instance_attr_reader :additional_md5_files
+    # @return [Hash<String,String>] Hash of the text/color to use for the classificaiton banner
+    instance_attr_reader :classificiation_banner
 
     # Known COSMOS ports
     KNOWN_PORTS = ['CTS_API', 'TLMVIEWER_API', 'CTS_PREIDENTIFIED', 'CTS_CMD_ROUTER', 'REPLAY_API', 'REPLAY_PREIDENTIFIED', 'REPLAY_CMD_ROUTER', 'DART_STREAM', 'DART_DECOM']
@@ -337,6 +339,25 @@ module Cosmos
               raise "Missing expected file: #{parameters[0]}"
             end
 
+          when 'CLASSIFICATION'
+            parser.verify_num_parameters(2, 4, "#{keyword} <Display_Text> <Color Name|Red> <Green> <Blue>")
+            # Determine if the COSMOS color already exists, otherwise create a new one
+            if Cosmos.constants.include? parameters[1].upcase.to_sym
+              # We were given a named color that already exists in COSMOS
+              color = eval("Cosmos::#{parameters[1].upcase}")
+            else
+              if parameters.length < 4
+                # We were given a named color, but it didn't exist in COSMOS already
+                color = Cosmos::getColor(parameters[1].upcase)
+              else
+                # We were given RGB values
+                color = Cosmos::getColor(parameters[1], parameters[2], parameters[3])
+              end
+            end
+
+            @classificiation_banner = {'display_text' => parameters[0],
+                                       'color'        => color}
+
           else
             # blank lines will have a nil keyword and should not raise an exception
             raise parser.error("Unknown keyword '#{keyword}'") if keyword

data/lib/cosmos/tools/cmd_extractor/cmd_extractor.rb

@@ -62,25 +62,25 @@ module Cosmos
       super()
 
       # File Menu Actions
-      @analyze_log = Qt::Action.new(tr('&Analyze Logs'), self)
-      @analyze_log.statusTip = tr('Analyze log file packet counts')
+      @analyze_log = Qt::Action.new('&Analyze Logs', self)
+      @analyze_log.statusTip = 'Analyze log file packet counts'
       @analyze_log.connect(SIGNAL('triggered()')) { analyze_log_files() }
 
       # Mode Menu Actions
-      @include_raw = Qt::Action.new(tr('Include &Raw Data'), self)
-      @include_raw_keyseq = Qt::KeySequence.new(tr('Ctrl+R'))
+      @include_raw = Qt::Action.new('Include &Raw Data', self)
+      @include_raw_keyseq = Qt::KeySequence.new('Ctrl+R')
       @include_raw.shortcut = @include_raw_keyseq
-      @include_raw.statusTip = tr('Include raw packet data in the text output')
+      @include_raw.statusTip = 'Include raw packet data in the text output'
       @include_raw.setCheckable(true)
     end
 
     # Create the File and Mode menus and initialize the Help menu
     def initialize_menus
-      @file_menu = menuBar.addMenu(tr('&File'))
+      @file_menu = menuBar.addMenu('&File')
       @file_menu.addAction(@analyze_log)
       @file_menu.addSeparator()
       @file_menu.addAction(@exit_action)
-      @mode_menu = menuBar.addMenu(tr('&Mode'))
+      @mode_menu = menuBar.addMenu('&Mode')
       @mode_menu.addAction(@include_raw)
       @about_string = "Command Extractor extracts commands from a binary command log file into a human readable text file."
       initialize_help_menu()
@@ -102,20 +102,20 @@ module Cosmos
       @data_source_layout.addWidget(label)
       @log_file_radio = Qt::RadioButton.new("Log File", self)
       @log_file_radio.setChecked(true)
-      @log_file_radio.connect(SIGNAL('clicked()')) do 
+      @log_file_radio.connect(SIGNAL('clicked()')) do
         @packet_log_frame.show_log_fields(true)
         @packet_log_frame.output_filename = ""
-        @dart_meta_frame.hide        
+        @dart_meta_frame.hide
         @resize_timer.start(100)
       end
       @data_source_layout.addWidget(@log_file_radio)
       @dart_radio = Qt::RadioButton.new("DART Database", self)
-      @dart_radio.connect(SIGNAL('clicked()')) do 
+      @dart_radio.connect(SIGNAL('clicked()')) do
         @packet_log_frame.show_log_fields(false)
         @packet_log_frame.output_filename = ""
         @dart_meta_frame.show
         @resize_timer.start(100)
-      end      
+      end
       @data_source_layout.addWidget(@dart_radio)
       @data_source_layout.addStretch()
       @top_layout.addLayout(@data_source_layout)
@@ -176,14 +176,14 @@ module Cosmos
       @time_start = @packet_log_frame.time_start
       @time_end = @packet_log_frame.time_end
       @packet_log_reader = @packet_log_frame.packet_log_reader
-      @input_filenames = @packet_log_frame.filenames.sort      
+      @input_filenames = @packet_log_frame.filenames.sort
       @output_filename = @packet_log_frame.output_filename
       @output_filename = nil if @output_filename.strip.empty?
       @meta_filters = @dart_meta_frame.meta_filters
 
       return unless pre_process_tests()
 
-      include_raw = @include_raw.isChecked      
+      include_raw = @include_raw.isChecked
       if @log_file_radio.isChecked
         begin
           ProgressDialog.execute(self, # parent
@@ -214,8 +214,8 @@ module Cosmos
           ProgressDialog.execute(self, # parent
                                 'Log File Progress', # title
                                 600, # width, height
-                                300, 
-                                true, # Overall progress, no step progress 
+                                300,
+                                true, # Overall progress, no step progress
                                 false) do |progress_dialog|
             progress_dialog.cancel_callback = method(:cancel_callback)
             progress_dialog.enable_cancel_button
@@ -227,7 +227,7 @@ module Cosmos
                   @interface.disconnect
                   request_packet = Cosmos::Packet.new('DART', 'DART')
                   request_packet.define_item('REQUEST', 0, 0, :BLOCK)
-                  
+
                   @time_start ||= Time.utc(1970, 1, 1)
                   @time_end ||= Time.now
                   @time_delta = @time_end - @time_start
@@ -239,7 +239,7 @@ module Cosmos
                   request['cmd_tlm'] = 'CMD'
                   request['meta_filters'] = @meta_filters unless @meta_filters.empty?
                   request_packet.write('REQUEST', JSON.dump(request))
-                
+
                   progress_dialog.append_text("Connecting to DART Database...")
                   @interface.connect
                   progress_dialog.append_text("Sending DART Database Query...")
@@ -260,11 +260,11 @@ module Cosmos
                     # Switch to correct configuration from SYSTEM META when needed
                     if packet.target_name == 'SYSTEM'.freeze and packet.packet_name == 'META'.freeze
                       meta_packet = System.commands.packet('SYSTEM', 'META')
-                      meta_packet.buffer = packet.buffer                                  
+                      meta_packet.buffer = packet.buffer
                       Cosmos::System.load_configuration(meta_packet.read('CONFIG'))
                     elsif first
                       first = false
-                      @time_start = packet.received_time
+                      @time_start = packet.packet_time
                       @time_delta = @time_end - @time_start
                     end
 
@@ -273,6 +273,7 @@ module Cosmos
                     defined_packet.received_time = packet.received_time
 
                     output_file.puts "#{defined_packet.target_name} #{defined_packet.packet_name}"
+                    output_file.puts "  PACKET_TIMEFORMATTED: #{defined_packet.packet_time.formatted}"
                     output_file.puts "  RECEIVED_TIMEFORMATTED: #{defined_packet.received_time.formatted}"
                     output_file.puts defined_packet.formatted(:WITH_UNITS, 2)
                     if include_raw or !defined_packet.identified? or !defined_packet.defined?
@@ -281,10 +282,10 @@ module Cosmos
                     end
                     output_file.puts
 
-                    progress = ((@time_delta - (@time_end - defined_packet.received_time)).to_f / @time_delta.to_f)
+                    progress = ((@time_delta - (@time_end - defined_packet.packet_time)).to_f / @time_delta.to_f)
                     progress_dialog.set_overall_progress(progress) if !@cancel
                   end
-            
+
                 end
               end
 
@@ -295,12 +296,12 @@ module Cosmos
                 @open_button.setEnabled(true)
               end
             end
-          end            
+          end
         rescue => error
           Qt::MessageBox.critical(self, 'Error!', "Error Querying DART Database\n#{error.formatted}")
         ensure
           @interface.disconnect
-        end          
+        end
       end
     end # def process_data
 
@@ -333,8 +334,9 @@ module Cosmos
 
             break if @cancel
             progress_dialog.set_step_progress(@packet_log_reader.bytes_read / file_size)
+            output_file.puts "#{packet.target_name} #{packet.packet_name}"
             if packet.received_time
-              output_file.puts "#{packet.target_name} #{packet.packet_name}"
+              output_file.puts "  PACKET_TIMEFORMATTED: #{packet.packet_time.formatted}"
               output_file.puts "  RECEIVED_TIMEFORMATTED: #{packet.received_time.formatted}"
             end
             output_file.puts packet.formatted(:WITH_UNITS, 2)