cosmos 4.2.4 → 4.5.0

data/lib/cosmos/tools/tlm_grapher/tlm_grapher.rb

@@ -16,15 +16,12 @@ end
 
 module Cosmos
 
-  # TlmGrapher class
-  #
-  # This class implements the TlmGrapher Application.  This application displays multiple line graphs
-  # that perform various analysis on housekeeping telemetry.
-  #
+  # Telemetry Grapher displays multiple line graphs that perform various
+  # analysis on housekeeping telemetry.
   class TlmGrapher < TabbedPlotsTool
 
     # Runs the application
-    def self.run (opts = nil, options = nil)
+    def self.run(opts = nil, options = nil)
       Cosmos.catch_fatal_exception do
         unless options
           opts, options = create_default_options()
@@ -32,8 +29,6 @@ module Cosmos
           options.width = 1000
           options.height = 800
           options.title = "Telemetry Grapher"
-          options.config_dir = 'tlm_grapher'
-          options.config_file = 'tlm_grapher.txt'
           options.tool_short_name = 'tlmgrapher'
           options.tabbed_plots_type = 'overview'
           options.data_object_types = ['HOUSEKEEPING', 'XY','SINGLEXY']
@@ -43,12 +38,10 @@ module Cosmos
           options.adder_orientation = Qt::Horizontal
           options.items = []
           options.start = false
+          options.replay = false
           options.about_string = "TlmGrapher provides realtime and log file graphing abilities to the COSMOS system."
 
           opts.separator "Telemetry Grapher Specific Options:"
-          opts.on("-c", "--config FILE", "Use the specified configuration file") do |arg|
-            options.config_file = arg
-          end
           opts.on("-s", "--start", "Start graphing immediately") do |arg|
             options.start = true
           end
@@ -60,6 +53,9 @@ module Cosmos
             end
             options.items << split
           end
+          opts.on("--replay", "Start Telemetry Grapher in Replay mode") do
+            options.replay = true
+          end
         end
 
         super(opts, options)
@@ -77,17 +73,24 @@ module Cosmos
         target_name.upcase!
         packet_name.upcase!
         item_name.upcase!
-        # Check to see if the item name is followed by an array index,
-        # notated by square brackets around an integer; i.e. ARRAY_ITEM[1]
-        if (item_name =~ /\[\d+\]$/)
-          # We found an array index.
-          # The $` special variable is the string before the regex match, i.e. ARRAY_ITEM
-          item_name = $`
-          # The $& special variable is the string matched by the regex, i.e. [1].
-          # Strip off the brackets and then convert the array index to an integer.
-          item_array_index = $&.gsub(/[\[\]]/, "").to_i
-        else
-          item_array_index = nil
+
+        item_array_index = nil
+        begin
+          # See if we can access the item
+          _, item = System.telemetry.packet_and_item(target_name, packet_name, item_name)
+        rescue => error
+          # Check to see if the item name is followed by an array index,
+          # notated by square brackets around an integer; i.e. ARRAY_ITEM[1]
+          if (item_name =~ /\[\d+\]$/)
+            # The $` special variable is the string before the regex match, i.e. ARRAY_ITEM
+            item_name = $`
+            # The $& special variable is the string matched by the regex, i.e. [1].
+            # Strip off the brackets and then convert the array index to an integer.
+            item_array_index = $&.gsub(/[\[\]]/, "").to_i
+          else
+            # If we couldn't access the item and it's not bracket notation then it's an error
+            raise error
+          end
         end
         # Default configuration has one plot so don't add plot for first item
         data_object = HousekeepingDataObject.new
@@ -97,7 +100,5 @@ module Cosmos
         plot_index += 1
       end
     end
-
-  end # class TlmGrapher
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/tools/tlm_viewer/screen.rb

@@ -11,8 +11,10 @@
 require 'cosmos'
 require 'cosmos/gui/qt'
 require 'cosmos/gui/qt_tool'
+require 'cosmos/gui/utilities/classification_banner'
 require 'cosmos/script'
 require 'cosmos/tools/tlm_viewer/widgets'
+require 'tempfile'
 
 module Cosmos
 
@@ -21,7 +23,9 @@ module Cosmos
     # close_all_screens is called
     @@open_screens = []
 
-    attr_accessor :full_name, :width, :height, :window, :replay_flag
+    attr_accessor :full_name, :width, :height, :window, :replay_flag, :original_target_name
+
+    include ClassificationBanner
 
     class Widgets
       # Flag to indicate all screens should close
@@ -33,10 +37,12 @@ module Cosmos
         @@closing_all = value
       end
 
-      def initialize(screen, mode)
+      def initialize(screen, mode, local_binding = nil)
         @screen = screen
         # The telemetry viewer mode. Must be :REALTIME or basically anything else?
         @mode = mode
+        # Local binding to evaluate LOCAL target
+        @local_binding = local_binding
         # Hash of only the named widgets identifed by the NAMED_WIDGET keyword
         @named = {}
         # Array of all widgets which take a value
@@ -84,7 +90,7 @@ module Cosmos
 
       def add_widget(klass, parameters, widget, widget_name, substitute, original_target_name, force_substitute)
         # Add to item or non_item widgets
-        if klass.takes_value?
+        if klass.takes_value? and substitute != 'LOCAL' and parameters[0] != 'LOCAL'
           if substitute and (original_target_name == parameters[0].upcase or force_substitute)
             @items << [substitute, parameters[1], parameters[2]]
           else
@@ -113,7 +119,7 @@ module Cosmos
         @value_thread = Thread.new do
           begin
             while(true)
-              break if @@closing_all
+              break if @@closing_all or !@alive
               time = Time.now.sys
 
               if !@item.empty?
@@ -137,7 +143,7 @@ module Cosmos
                     @limits_set = limits_set
                   end
                 rescue DRb::DRbConnError
-                  break if @@closing_all
+                  break if @@closing_all or !@alive
                   break if @value_sleeper.sleep(1)
                   next
                 end
@@ -145,7 +151,7 @@ module Cosmos
 
               Qt.execute_in_main_thread {update_gui()} if @alive and (@mode == :REALTIME)
               delta = Time.now.sys - time
-              break if @@closing_all
+              break if @@closing_all or !@alive
               if @polling_period - delta > 0
                 break if @value_sleeper.sleep(@polling_period - delta)
               else
@@ -178,7 +184,27 @@ module Cosmos
 
             # Update non_item widgets
             @non_item.each do |widget|
-              widget.update_widget
+              if widget.class.takes_value?
+                # LOCAL value
+                eval_binding = @local_binding
+                begin
+                  eval_binding = ScriptRunnerFrame.instance.script_binding
+                  @local_binding = eval_binding
+                rescue Exception
+                  # Fall back on @local_binding
+                end
+
+                begin
+                  widget.limits_state = nil
+                  widget.value = eval_binding.eval(widget.item_name)
+                rescue Exception
+                  # Bad local variable or binding no longer valid
+                  widget.limits_state = :STALE
+                  widget.value = widget.value
+                end
+              else
+                widget.update_widget
+              end
             end
           end
         rescue Exception => error
@@ -190,7 +216,7 @@ module Cosmos
 
       def shutdown
         @alive = false
-        Cosmos.kill_thread(self, @value_thread)
+        Cosmos.kill_thread(self, @value_thread, 2, 0.1, 2)
 
         # Shutdown All Widgets
         widgets().each do |widget|
@@ -203,7 +229,7 @@ module Cosmos
       end
     end
 
-    def initialize(full_name, filename, notify_on_close = nil, mode = :REALTIME, x_pos = nil, y_pos = nil, original_target_name = nil, substitute = nil, force_substitute = false, single_screen = false)
+    def initialize(full_name, filename_or_screen_def, notify_on_close = nil, mode = :REALTIME, x_pos = nil, y_pos = nil, original_target_name = nil, substitute = nil, force_substitute = false, single_screen = false, local_binding = nil)
       super(nil)
       # The full name of the widget which goes in the title
       @full_name = full_name
@@ -224,15 +250,20 @@ module Cosmos
       # displayed as a stand alone screen and not launched as a part of the
       # regular TlmViewer application
       @single_screen = single_screen
+      # Binding for use with LOCAL LOCAL
+      @local_binding = local_binding
 
       # Read the application wide stylesheet if it exists
       app_style = File.join(Cosmos::USERPATH, 'config', 'tools', 'application.css')
       setStyleSheet(File.read(app_style)) if File.exist? app_style
 
       @replay_flag = nil
-      @widgets = Widgets.new(self, mode)
-      @window = process(filename)
+      @widgets = Widgets.new(self, mode, @local_binding)
+      @window = process(filename_or_screen_def)
       @@open_screens << self if @window
+
+      # Add a banner based on system configuration
+      add_classification_banner
     end
 
     def widgets
@@ -247,7 +278,7 @@ module Cosmos
       @widgets.mode
     end
 
-    def process(filename)
+    def process(filename_or_screen_def)
       layout_stack = []
       layout_stack[0] = nil
 
@@ -256,6 +287,16 @@ module Cosmos
       global_settings = {}
       global_subsettings = {}
 
+      if File.exist?(filename_or_screen_def) or !filename_or_screen_def.to_s.index("SCREEN")
+        tempfile = false
+        filename = filename_or_screen_def
+      else
+        tempfile = Tempfile.new('screen')
+        tempfile.write(filename_or_screen_def)
+        tempfile.close
+        filename = tempfile.path
+      end
+
       begin
         parser = ConfigParser.new("http://cosmosrb.com/docs/screens/")
         parser.instance_variable_set(:@original_target_name, @original_target_name)
@@ -299,6 +340,7 @@ module Cosmos
               # to the stack and that class doesn't have a complete method.
               current_widget.complete() if current_widget.respond_to? :complete
             when 'SETTING'
+              next unless current_widget
               parser.verify_num_parameters(1, nil, "#{keyword} <Setting Name> <Setting Values... (optional)>")
               if parameters.length > 1
                 current_widget.set_setting(parameters[0], parameters[1..-1])
@@ -306,6 +348,7 @@ module Cosmos
                 current_widget.set_setting(parameters[0], [])
               end
             when 'SUBSETTING'
+              next unless current_widget
               parser.verify_num_parameters(2, nil, "#{keyword} <Widget Index (0..?)> <Setting Name> <Setting Values... (optional)>")
               if parameters.length > 2
                 current_widget.set_subsetting(parameters[0], parameters[1], parameters[2..-1])
@@ -322,6 +365,8 @@ module Cosmos
               klass = Cosmos.require_class(parameters[0].to_s.downcase + '_widget')
               global_subsettings[klass] ||= []
               global_subsettings[klass] << [parameters[1]].concat(parameters[2..-1])
+            when 'STAY_ON_TOP'
+              setWindowFlags(windowFlags() | Qt::WindowStaysOnTopHint)
             else
               current_widget = process_widget(parser, keyword, parameters, layout_stack, global_settings, global_subsettings)
             end # case keyword
@@ -336,6 +381,8 @@ module Cosmos
         end
         shutdown()
         return nil
+      ensure
+        tempfile.unlink if tempfile
       end
 
       unless @widgets.invalid.empty?
@@ -387,10 +434,14 @@ module Cosmos
         parser.verify_num_parameters(3, nil, "#{keyword} <Target Name> <Packet Name> <Item Name> <Widget Settings... (optional)>")
         begin
           if @substitute and (@original_target_name == parameters[0].upcase or @force_substitute)
-            System.telemetry.packet_and_item(@substitute, parameters[1], parameters[2])
+            if @substitute != 'LOCAL' or parameters[1] != 'LOCAL'
+              System.telemetry.packet_and_item(@substitute, parameters[1], parameters[2])
+            end
             widget = klass.new(layout_stack[-1], @substitute, *parameters[1..(parameters.length - 1)])
           else
-            System.telemetry.packet_and_item(*parameters[0..2])
+            if parameters[0] != 'LOCAL' or parameters[1] != 'LOCAL'
+              System.telemetry.packet_and_item(*parameters[0..2])
+            end
             widget = klass.new(layout_stack[-1], *parameters)
           end
         rescue => err
@@ -470,6 +521,8 @@ module Cosmos
       end
 
       self.dispose
+
+      @window = nil
     end
 
     def get_named_widget(widget_name)
@@ -488,6 +541,15 @@ module Cosmos
       @widgets.graceful_kill
     end
 
+    def close
+      Qt.execute_in_main_thread(true) do
+        if @window
+          super()
+          @window = nil
+        end
+      end
+    end
+
     def self.open_screens
       @@open_screens
     end

data/lib/cosmos/tools/tlm_viewer/tlm_viewer.rb

@@ -10,14 +10,14 @@
 
 require 'cosmos'
 Cosmos.catch_fatal_exception do
-  require 'cosmos/script'
-  require 'cosmos/tools/tlm_viewer/screen'
   require 'cosmos/gui/qt_tool'
   require 'cosmos/gui/dialogs/splash'
   require 'cosmos/gui/dialogs/progress_dialog'
   require 'cosmos/gui/dialogs/select_dialog'
   require 'cosmos/gui/widgets/full_text_search_line_edit'
   require 'cosmos/tools/tlm_viewer/tlm_viewer_config'
+  require 'cosmos/tools/tlm_viewer/screen'
+  require 'cosmos/script'
   require 'find'
   require 'fileutils'
 end
@@ -53,13 +53,19 @@ module Cosmos
     @@instance = nil
 
     def self.instance
+      unless @@instance
+        _, options = create_default_options()
+        options.listen = false
+        options.show_main = false
+        TlmViewer.new(options)
+      end
       @@instance
     end
 
     def self.load_config(filename)
       raise "Configuration file #{filename} does not exist." unless filename && File.exist?(filename)
 
-      # Find all screen files so we can calculate MD5
+      # Find all screen files so we can calculate hashing sum
       tlmviewer_files = [filename, System.initial_filename]
       additional_data = ''
       System.targets.each do |target_name, target|
@@ -79,9 +85,13 @@ module Cosmos
           end
         end
       end
-      # Calculate MD5 and attempt to load marshal file
-      md5 = Cosmos.md5_files(tlmviewer_files, additional_data)
-      marshal_filename = File.join(System.paths['TMP'], "tlmviewer_#{md5.hexdigest}.bin")
+      # Calculate the hashing sum and attempt to load marshal file
+      hashing_result = Cosmos.hash_files(tlmviewer_files, additional_data, System.hashing_algorithm)
+      # Only use at most, 32 characters of the hex
+      hash_string = hashing_result.hexdigest
+      hash_string = hash_string[-32..-1] if hash_string.length >= 32
+
+      marshal_filename = File.join(System.paths['TMP'], "tlmviewer_#{hash_string}.bin")
       config = Cosmos.marshal_load(marshal_filename)
       unless config
         # Marshal file load failed - Manually load configuration
@@ -114,12 +124,14 @@ module Cosmos
 
       Splash.execute(self) do |splash|
         ConfigParser.splash = splash
-        splash.message = "Displaying requested screens"
+        if options.show_main
+          splash.message = "Displaying requested screens"
 
-        # Startup desired screens once we're running
-        @tlm_viewer_config.screen_infos.each do |screen_full_name, screen_info|
-          if screen_info.show_on_startup
-            display(screen_full_name, screen_info.x_pos, screen_info.y_pos)
+          # Startup desired screens once we're running
+          @tlm_viewer_config.screen_infos.each do |screen_full_name, screen_info|
+            if screen_info.show_on_startup
+              display(screen_full_name, screen_info.x_pos, screen_info.y_pos)
+            end
           end
         end
 
@@ -134,7 +146,7 @@ module Cosmos
             'clear_all']
           @json_drb.method_whitelist = whitelist
           begin
-            @json_drb.start_service System.listen_hosts['TLMVIEWER_API'], port, self
+            @json_drb.start_service System.listen_hosts['TLMVIEWER_API'], port, self, 1000, System
           rescue Exception
             raise FatalError.new("Error starting JsonDRb on port #{port}.\nPerhaps a Telemetry Viewer is already running?")
           end
@@ -145,6 +157,7 @@ module Cosmos
         @all_telemetry = System.telemetry.all_item_strings(false, splash)
 
         Qt.execute_in_main_thread(true) do
+          toggle_replay_mode() if options.replay
           @search_box.completion_list = @tlm_viewer_config.completion_list
           @search_box.callback = lambda do |tlm|
             mapping = @tlm_viewer_config.tlm_to_screen_mapping[tlm]
@@ -158,38 +171,40 @@ module Cosmos
 
         ConfigParser.splash = nil
       end
+
+      hide() unless options.show_main
     end
 
     def initialize_actions
       super()
 
       # File actions
-      @file_save = Qt::Action.new(Cosmos.get_icon('save.png'), tr('&Save Configuration'), self)
-      @file_save_keyseq = Qt::KeySequence.new(tr('Ctrl+S'))
+      @file_save = Qt::Action.new(Cosmos.get_icon('save.png'), '&Save Configuration', self)
+      @file_save_keyseq = Qt::KeySequence.new('Ctrl+S')
       @file_save.shortcut = @file_save_keyseq
-      @file_save.statusTip = tr('Save all screen positions')
+      @file_save.statusTip = 'Save all screen positions'
       @file_save.connect(SIGNAL('triggered()')) { file_save() }
 
-      @file_generate = Qt::Action.new(tr('&Generate Screens'), self)
-      @file_generate_keyseq = Qt::KeySequence.new(tr('Ctrl+G'))
+      @file_generate = Qt::Action.new('&Generate Screens', self)
+      @file_generate_keyseq = Qt::KeySequence.new('Ctrl+G')
       @file_generate.shortcut = @file_generate_keyseq
-      @file_generate.statusTip = tr('Generate screen definition files')
+      @file_generate.statusTip = 'Generate screen definition files'
       @file_generate.connect(SIGNAL('triggered()')) { file_generate() }
 
-      @file_audit = Qt::Action.new(tr('Audi&t Screens vs Tlm'), self)
-      @file_audit_keyseq = Qt::KeySequence.new(tr('Ctrl+T'))
+      @file_audit = Qt::Action.new('Audi&t Screens vs Tlm', self)
+      @file_audit_keyseq = Qt::KeySequence.new('Ctrl+T')
       @file_audit.shortcut = @file_audit_keyseq
-      @file_audit.statusTip = tr('Create a report listing which telemetry points are not on screens')
+      @file_audit.statusTip = 'Create a report listing which telemetry points are not on screens'
       @file_audit.connect(SIGNAL('triggered()')) { file_audit() }
 
-      @replay_action = Qt::Action.new(tr('Toggle Replay Mode'), self)
-      @replay_action.statusTip = tr('Toggle Replay Mode')
+      @replay_action = Qt::Action.new('Toggle Replay Mode', self)
+      @replay_action.statusTip = 'Toggle Replay Mode'
       @replay_action.connect(SIGNAL('triggered()')) { toggle_replay_mode() }
     end
 
     def initialize_menus(options)
       # File Menu
-      @file_menu = menuBar.addMenu(tr('&File'))
+      @file_menu = menuBar.addMenu('&File')
       @file_menu.addAction(@file_save)
       @file_menu.addAction(@file_generate)
       @file_menu.addAction(@file_audit)
@@ -546,36 +561,36 @@ module Cosmos
           options.title = 'Telemetry Viewer'
           options.screen = nil
           options.listen = true
-          options.config_file = nil
+          options.show_main = true
           options.restore_size = false
           options.production = false
+          options.replay = false
+          options.config_file = true # config_file is required
 
           option_parser.separator "Telemetry Viewer Specific Options:"
-          option_parser.on("-c", "--config FILE", "Use the specified config file") { |arg| options.config_file = arg }
-          option_parser.on("-s", "--screen FILE", "Start up the specified screen") { |arg| options.screen = arg }
+          option_parser.on("-s", "--screen SCREEN_NAME", "Start up the specified screen") { |arg| options.screen = arg }
           option_parser.on("-n", "--nolisten", "Don't listen for requests") do
             options.listen = false
             options.title << ' : Not Listening'
           end
-          option_parser.on("-p", "--production", "Run TlmServer in production mode which disables the edit buttons.") do |arg|
+          option_parser.on("-p", "--production", "Run Telemetry Viewer in production mode which disables the edit buttons.") do |arg|
             options.production = true
           end
+          option_parser.on("--replay", "Run Telemetry Viewer in Replay mode") do
+            options.replay = true
+          end
           option_parser.parse!(ARGV)
         end
 
         if options.screen
+          normalize_config_options(options)
           application = nil
           begin
             QtTool.redirect_io
             System.telemetry
             application = Qt::Application.new(ARGV)
             application.addLibraryPath(Qt::PLUGIN_PATH) if Kernel.is_windows?
-            if options.config_file
-              filename = File.join(::Cosmos::USERPATH, 'config', 'tools', 'tlm_viewer', options.config_file)
-            else
-              filename = File.join(::Cosmos::USERPATH, 'config', 'tools', 'tlm_viewer', 'tlm_viewer.txt')
-            end
-            tlm_viewer_config = load_config(filename)
+            tlm_viewer_config = load_config(options.config_file)
             screen_info = tlm_viewer_config.screen_infos[options.screen.upcase]
             raise "Unknown screen: #{options.screen.upcase}" unless screen_info
             if not options.auto_position
@@ -583,6 +598,8 @@ module Cosmos
             else
               screen_info.screen = Screen.new(screen_info.full_name, screen_info.filename, nil, :REALTIME, screen_info.x_pos, screen_info.y_pos, screen_info.original_target_name, screen_info.substitute, screen_info.force_substitute, true)
             end
+            set_replay_mode(true) if options.replay
+            Screen.update_replay_mode
             application.exec
           rescue Exception => error
             unless error.class == SystemExit or error.class == Interrupt