cosmos 4.3.0 → 4.4.0

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

@@ -67,6 +67,15 @@ module Cosmos
       @analyze_log.connect(SIGNAL('triggered()')) { analyze_log_files() }
 
       # Mode Menu Actions
+      @csv_output = Qt::Action.new('&CSV Output', self)
+      @csv_output.statusTip = 'Output as CSV based on Packet Time'
+      @csv_output.setCheckable(true)
+      @csv_output.connect(SIGNAL('triggered()')) { change_callback(:INPUT_FILES) }
+
+      @skip_ignored = Qt::Action.new('&Skip Ignored Items', self)
+      @skip_ignored.statusTip = "Skip ignored items in the command when building output"
+      @skip_ignored.setCheckable(true)
+
       @include_raw = Qt::Action.new('Include &Raw Data', self)
       @include_raw_keyseq = Qt::KeySequence.new('Ctrl+R')
       @include_raw.shortcut = @include_raw_keyseq
@@ -81,6 +90,8 @@ module Cosmos
       @file_menu.addSeparator()
       @file_menu.addAction(@exit_action)
       @mode_menu = menuBar.addMenu('&Mode')
+      @mode_menu.addAction(@csv_output)
+      @mode_menu.addAction(@skip_ignored)
       @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()
@@ -144,6 +155,14 @@ module Cosmos
       @open_button.connect(SIGNAL('clicked()')) { open_button() }
       @open_button.setEnabled(false)
       @button_layout.addWidget(@open_button)
+
+      if Kernel.is_windows?
+        @open_excel_button = Qt::PushButton.new('&Open in Excel')
+        @open_excel_button.connect(SIGNAL('clicked()')) { open_excel_button() }
+        @open_excel_button.setEnabled(false)
+        @button_layout.addWidget(@open_excel_button)
+      end
+
       @top_layout.addLayout(@button_layout)
     end
 
@@ -182,8 +201,10 @@ module Cosmos
       @meta_filters = @dart_meta_frame.meta_filters
 
       return unless pre_process_tests()
-
+      csv_output = @csv_output.isChecked
+      skip_ignored = @skip_ignored.isChecked
       include_raw = @include_raw.isChecked
+
       if @log_file_radio.isChecked
         begin
           ProgressDialog.execute(self, # parent
@@ -196,13 +217,14 @@ module Cosmos
             begin
               Cosmos.set_working_dir do
                 File.open(@output_filename, 'w') do |output_file|
-                  process_files(output_file, include_raw, progress_dialog)
+                  process_files(output_file, progress_dialog, csv_output, skip_ignored, include_raw)
                 end
               end
             ensure
               progress_dialog.complete
               Qt.execute_in_main_thread(true) do
                 @open_button.setEnabled(true)
+                @open_excel_button.setEnabled(true) if Kernel.is_windows?
               end
             end
           end
@@ -246,6 +268,8 @@ module Cosmos
                   @interface.write(request_packet)
                   progress_dialog.append_text("Receiving Packets...")
 
+                  write_output_file_DART_header(output_file, request, csv_output)
+
                   first = true
                   while true
                     break if @cancel
@@ -271,17 +295,7 @@ module Cosmos
                     defined_packet = System.commands.packet(packet.target_name, packet.packet_name)
                     defined_packet.buffer = packet.buffer
                     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?
-                      output_file.puts "  RAW PACKET DATA (#{defined_packet.length} bytes):"
-                      output_file.puts defined_packet.buffer.formatted(1, 16, ' ', 4)
-                    end
-                    output_file.puts
-
+                    write_output_file_packet(output_file, defined_packet, csv_output, skip_ignored, include_raw)
                     progress = ((@time_delta - (@time_end - defined_packet.packet_time)).to_f / @time_delta.to_f)
                     progress_dialog.set_overall_progress(progress) if !@cancel
                   end
@@ -294,6 +308,7 @@ module Cosmos
               progress_dialog.complete
               Qt.execute_in_main_thread(true) do
                 @open_button.setEnabled(true)
+                @open_excel_button.setEnabled(true) if Kernel.is_windows?
               end
             end
           end
@@ -309,11 +324,15 @@ module Cosmos
       Cosmos.open_in_text_editor(@output_filename)
     end
 
+    def open_excel_button
+      system("start Excel.exe \"#{@output_filename}\"")
+    end
+
     ###############################################################################
     # Helper Methods
     ###############################################################################
 
-    def process_files(output_file, include_raw, progress_dialog)
+    def process_files(output_file, progress_dialog, csv_output, skip_ignored, include_raw)
       log_file_count = 1
       @input_filenames.each do |log_file|
         break if @cancel
@@ -322,10 +341,7 @@ module Cosmos
           file_size = File.size(log_file).to_f
           progress_dialog.append_text("Processing File #{log_file_count}/#{@input_filenames.length}: #{log_file}")
           progress_dialog.set_step_progress(0.0)
-          output_file.puts '-' * (log_file.length * 1.4).to_i
-          output_file.puts log_file
-          output_file.puts '-' * (log_file.length * 1.4).to_i
-          output_file.puts
+          write_output_file_header(output_file, log_file, csv_output)
           @packet_log_reader.each(
             log_file, # log filename
             true,     # identify and define packet
@@ -334,17 +350,7 @@ 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_TIMEFORMATTED: #{packet.packet_time.formatted}"
-              output_file.puts "  RECEIVED_TIMEFORMATTED: #{packet.received_time.formatted}"
-            end
-            output_file.puts packet.formatted(:WITH_UNITS, 2)
-            if include_raw or !packet.identified? or !packet.defined?
-              output_file.puts "  RAW PACKET DATA (#{packet.length} bytes):"
-              output_file.puts packet.buffer.formatted(1, 16, ' ', 4)
-            end
-            output_file.puts
+            write_output_file_packet(output_file, packet, csv_output, skip_ignored, include_raw)
           end
           progress_dialog.set_step_progress(1.0) if !@cancel
           progress_dialog.set_overall_progress(log_file_count.to_f / @input_filenames.length.to_f) if !@cancel
@@ -359,6 +365,57 @@ module Cosmos
     # Helper Methods
     ###############################################################################
 
+    def write_output_file_header(output_file, log_file, csv_output)
+      if csv_output
+        output_file.puts "Filename,#{log_file}"
+        output_file.puts "PACKET_TIMEFORMATTED,Target,Packet,Parameters"
+      else
+        output_file.puts '-' * (log_file.length * 1.4).to_i
+        output_file.puts log_file
+        output_file.puts '-' * (log_file.length * 1.4).to_i
+        output_file.puts
+      end
+    end
+
+    def write_output_file_DART_header(output_file, request, csv_output)
+      if csv_output
+        output_file.puts "DART Request"
+        output_file.puts "start secs,#{request['start_time_sec']},start usec,#{request['start_time_usec']}"
+        output_file.puts "end secs,#{request['end_time_sec']},end usec,#{request['end_time_usec']}"
+        output_file.puts "meta_filter,#{request['meta_filters']}" unless @meta_filters.empty?
+      else
+        output_file.puts "DART Request"
+        output_file.puts "start secs:#{request['start_time_sec']} start usec:#{request['start_time_usec']}"
+        output_file.puts "end secs:#{request['end_time_sec']} end usec:#{request['end_time_usec']}"
+        output_file.puts "meta_filter:#{request['meta_filters']}" unless @meta_filters.empty?
+      end
+    end
+
+    def write_output_file_packet(output_file, packet, csv_output, skip_ignored, include_raw)
+      if csv_output
+        items_string = ""
+        packet.read_all.each do |name, value|
+          next if skip_ignored && System.targets[packet.target_name].ignored_items.include?(name)
+          items_string << "#{name},#{value},"
+        end
+        output_file.puts "#{packet.packet_time.formatted},#{packet.target_name},#{packet.packet_name},#{items_string}"
+        output_file.puts "#{packet.buffer.formatted}" if include_raw
+      else
+        output_file.puts "#{packet.target_name} #{packet.packet_name}"
+        if packet.received_time
+          output_file.puts "  PACKET_TIMEFORMATTED: #{packet.packet_time.formatted}"
+          output_file.puts "  RECEIVED_TIMEFORMATTED: #{packet.received_time.formatted}"
+        end
+        ignored = skip_ignored ? System.targets[packet.target_name].ignored_items : nil
+        output_file.puts packet.formatted(:WITH_UNITS, 2, packet.buffer, ignored)
+        if include_raw or !packet.identified? or !packet.defined?
+          output_file.puts "  RAW PACKET DATA (#{packet.length} bytes):"
+          output_file.puts packet.buffer.formatted(1, 16, ' ', 4)
+        end
+        output_file.puts
+      end
+    end
+
     def pre_process_tests
       if @log_file_radio.isChecked
         unless @input_filenames and @input_filenames[0]
@@ -372,7 +429,7 @@ module Cosmos
           Qt::MessageBox.critical(self, 'Error', 'No Output File Selected')
           return false
         else
-          @packet_log_frame.output_filename = File.join(System.paths['LOGS'], File.build_timestamped_filename(['cmd_extractor', 'dart']))
+          @packet_log_frame.output_filename = File.join(System.paths['LOGS'], File.build_timestamped_filename(['cmd_extractor', 'dart'], get_output_file_extension()))
           @output_filename = @packet_log_frame.output_filename
         end
       end
@@ -385,6 +442,10 @@ module Cosmos
       true
     end
 
+    def get_output_file_extension
+      @csv_output.isChecked ? '.csv' : '.txt'
+    end
+
     ###############################################################################
     # Additional Callbacks
     ###############################################################################
@@ -400,12 +461,10 @@ module Cosmos
         if filename
           extension = File.extname(filename)
           filename_no_extension = filename[0..-(extension.length + 1)]
-          filename = filename_no_extension << '.txt'
-          @packet_log_frame.output_filename = filename
+          @packet_log_frame.output_filename = "#{filename_no_extension}#{get_output_file_extension}"
         end
       end
     end
 
-  end # class CmdExtractor
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/tools/cmd_sender/cmd_sender.rb

@@ -690,6 +690,9 @@ module Cosmos
                 end
                 if !value_text.is_printable?
                   value_text = "0x" + value_text.simple_formatted
+                # Add quotes around STRING or BLOCK defaults so CmdSender interprets them correctly
+                elsif (packet_item.data_type == :STRING or packet_item.data_type == :BLOCK)
+                  value_text = "'#{packet_item.default}'"
                 end
               end
               value_item = Qt::TableWidgetItem.new(value_text)

data/lib/cosmos/tools/cmd_sequence/sequence_item.rb

@@ -435,7 +435,7 @@ module Cosmos
       @cmd_name.text = command_string
       hazardous, _ = System.commands.cmd_hazardous?(@command.target_name, @command.packet_name, command_params())
       if hazardous
-        @cmd_info.text = "(Hazarous)"
+        @cmd_info.text = "(Hazardous)"
       else
         @cmd_info.text = ""
       end

data/lib/cosmos/tools/cmd_tlm_server/background_tasks.rb

@@ -43,6 +43,8 @@ module Cosmos
         rescue Exception => err
           Logger.error "Background Task '#{@config.background_tasks[index].name}' unexpectedly died"
           Cosmos.handle_fatal_exception(err)
+        ensure
+          @threads[index] = nil # Remove thread reference
         end
       end
     end

data/lib/cosmos/tools/cmd_tlm_server/cmd_tlm_server.rb

@@ -20,7 +20,6 @@ require 'cosmos/tools/cmd_tlm_server/routers'
 require 'cosmos/tools/cmd_tlm_server/replay_backend'
 
 module Cosmos
-
   # Provides the interface for all applications to get the latest telemetry and
   # to send commands.
   class CmdTlmServer
@@ -126,6 +125,9 @@ module Cosmos
     #   receive data. This is useful for testing scripts when actual hardware
     #   is not available.
     # @param mode [Symbol] :CMD_TLM_SERVER or :REPLAY - Defines overall mode
+    # @param replay_routers [Boolean] Whether to keep existing routers when starting
+    #   the server in REPLAY mode. Default is false which means to clear all
+    #   existing routers and simply create the preidentified routers.
     def initialize(
       config_file = DEFAULT_CONFIG_FILE,
       production = false,
@@ -218,16 +220,40 @@ module Cosmos
           @routers.add_preidentified('PREIDENTIFIED_ROUTER', System.ports['CTS_PREIDENTIFIED'])
           @routers.add_cmd_preidentified('PREIDENTIFIED_CMD_ROUTER', System.ports['CTS_CMD_ROUTER'])
         else
+          # Create dummy interface for Replay so we can attach the preidentified routers to it.
+          # This is needed because interfaces are not mapped to targets when loading a saved_config.
+          # Since interfaces are used to access the routers, nothing is send out the preidentified
+          # interface port and TlmGrapher (most notably) does not work.
+          @replay_interface = Interface.new
+          @replay_interface.name = "REPLAY"
           @routers.all.clear unless replay_routers
-          @routers.add_preidentified('PREIDENTIFIED_ROUTER', System.ports['REPLAY_PREIDENTIFIED'])
-          @routers.add_cmd_preidentified('PREIDENTIFIED_CMD_ROUTER', System.ports['REPLAY_CMD_ROUTER'])
+          @replay_interface.routers << @routers.add_preidentified('PREIDENTIFIED_ROUTER', System.ports['REPLAY_PREIDENTIFIED'])
+          @replay_interface.cmd_routers << @routers.add_cmd_preidentified('PREIDENTIFIED_CMD_ROUTER', System.ports['REPLAY_CMD_ROUTER'])
         end
         System.telemetry.limits_change_callback = method(:limits_change_callback)
         @routers.start
 
         start(production)
       end
-    end # end def initialize
+    end
+
+    # Map any targets without interfaces to the dummy replay interface.
+    # Targets will only have an interface already mapped if the replay_routers
+    # flag was passed to the server.
+    def replay_map_targets_to_interfaces
+      # Try to map existing interfaces to targets
+      if @interfaces
+        @interfaces.all.each do |name, interface|
+          interface.target_names.each do |target|
+            System.targets[target].interface = interface
+          end
+        end
+      end
+      # If any remaing targets don't have an interface map to the @replay_interface
+      System.targets.each do |name, target|
+        target.interface = @replay_interface unless target.interface
+      end
+    end
 
     # Properly shuts down the command and telemetry server by stoping the
     # JSON-RPC server, background tasks, routers, and interfaces. Also kills

data/lib/cosmos/tools/cmd_tlm_server/cmd_tlm_server_config.rb

@@ -216,6 +216,7 @@ module Cosmos
             when 'LOG_RAW', 'ROUTER_LOG_RAW'
               parser.verify_num_parameters(0, nil, "#{keyword} <Raw Logger Class File (optional)> <Raw Logger Parameters (optional)>")
               current_interface_or_router.raw_logger_pair = RawLoggerPair.new(current_interface_or_router.name, params)
+              current_interface_or_router.start_raw_logging
 
             when 'OPTION'
               parser.verify_num_parameters(2, nil, "#{keyword} <Option Name> <Option Value 1> <Option Value 2 (optional)> <etc>")

data/lib/cosmos/tools/cmd_tlm_server/cmd_tlm_server_gui.rb

@@ -56,9 +56,6 @@ else
         option_parser.on("--system FILE", "Use an alternative system.txt file") do |arg|
           System.instance(File.join(USERPATH, 'config', 'system', arg))
         end
-        option_parser.on("-c", "--config FILE", "Use the specified configuration file") do |arg|
-          options.config_file = arg
-        end
       end
 
       return parser, options
@@ -75,7 +72,6 @@ else
 end
 
 module Cosmos
-
   # Implements the GUI functions of the Command and Telemetry Server. All the
   # QT calls are implemented here. The non-GUI functionality is contained in
   # the CmdTlmServer class.
@@ -262,7 +258,7 @@ module Cosmos
       end
       @targets_tab = TargetsTab.new(@tab_widget)
       @commands_tab = PacketsTab.new(self, PacketsTab::COMMANDS, @tab_widget)
-      @telemetry_tab = PacketsTab.new(self, PacketsTab::TELEMETRY, @tab_widget)
+      @telemetry_tab = PacketsTab.new(self, PacketsTab::TELEMETRY, @tab_widget, (@mode == :REPLAY))
       @routers_tab = InterfacesTab.new(self, InterfacesTab::ROUTERS, @tab_widget)
       if @mode == :CMD_TLM_SERVER
         @logging_tab = LoggingTab.new(@production, @tab_widget)
@@ -271,6 +267,7 @@ module Cosmos
     end
 
     def config_change_callback
+      CmdTlmServer.instance.replay_map_targets_to_interfaces
       start(nil)
     end
 
@@ -546,6 +543,8 @@ module Cosmos
     def self.post_options_parsed_hook(options)
       @options = options
       if options.no_gui
+        normalize_config_options(options)
+        
         ["TERM", "INT"].each {|sig| Signal.trap(sig) {exit}}
 
         begin
@@ -613,16 +612,15 @@ module Cosmos
           # Set the default title which can be overridden in the config file
           options.title = TOOL_NAME
           options.auto_size = false
-          options.config_file = CmdTlmServer::DEFAULT_CONFIG_FILE
           options.production = false
           options.no_prompt = false
           options.no_gui = false
           options.replay_routers = false
+          options.config_file = true # config_file is required
+          # Set config_dir because by default it would be config/tools/cmd_tlm_server_gui
+          options.config_dir = File.join(Cosmos::USERPATH, 'config', 'tools', 'cmd_tlm_server')
 
           option_parser.separator "CTS Specific Options:"
-          option_parser.on("-c", "--config FILE", "Use the specified configuration file") do |arg|
-            options.config_file = arg
-          end
           option_parser.on("-p", "--production", "Run the server in production mode which disables the ability to stop logging.") do |arg|
             options.production = true
           end
@@ -647,6 +645,5 @@ module Cosmos
         super(option_parser, options)
       end
     end
-
-  end # class CmdTlmServerGui
-end # module Cosmos
+  end
+end

data/lib/cosmos/tools/cmd_tlm_server/gui/packets_tab.rb

@@ -18,9 +18,10 @@ module Cosmos
     COMMANDS = "Commands"
     TELEMETRY = "Telemetry"
 
-    def initialize(server_gui, name, tab_widget)
+    def initialize(server_gui, name, tab_widget, replay = false)
       @server_gui = server_gui
       @name = name
+      @replay = replay
       @widget = nil
       reset()
       @scroll = Qt::ScrollArea.new
@@ -147,7 +148,9 @@ module Cosmos
         view_pv = Qt::PushButton.new("View in #{tool_name}")
         view_pv.connect(SIGNAL('clicked()')) do
           tool_name = tool_name.split.join.gsub("Command","Cmd") # remove space and convert name
-          Cosmos.run_cosmos_tool(tool_name, "-p \"#{target_name} #{packet_name}\" --system #{File.basename(System.initial_filename)}")
+          options = "-p \"#{target_name} #{packet_name}\" --system #{File.basename(System.initial_filename)}"
+          options += " --replay" if @replay && @name == TELEMETRY
+          Cosmos.run_cosmos_tool(tool_name, options)
         end
         table.setCellWidget(row, 4, view_pv)
       else

data/lib/cosmos/tools/cmd_tlm_server/routers.rb

@@ -49,6 +49,7 @@ module Cosmos
         router.interfaces << interface
         interface.routers << router
       end
+      router
     end
 
     # Adds a Preidentified command router to the system with given name and port.
@@ -72,6 +73,7 @@ module Cosmos
       @config.interfaces.each do |interface_name, interface|
         interface.cmd_routers << cmd_router
       end
+      cmd_router
     end
 
     # Recreate a router with new initialization parameters